kNCurses/NCursesPtyWindow.cpp

/**
 * @author Christian Burger (christian@krikkel.de)
 */

#include "NCursesPtyWindow.hpp"
#include "Debug.hpp"

#include <cstdio>
#include <unistd.h>
#include <sys/select.h>
#include <gsl/gsl>
#include <cctype>
#include <termios.h>

namespace krikkel::NCursesPtyWindow
{
    using gsl::narrow;

    NCursesPtyWindow::NCursesPtyWindow(int lines, int columns, int y, int x)
            : NCursesWindow(lines, columns, y, x)
    {
        // to get the original terminal we need to shutdown ncurses for a moment
        /// @todo maybe try `reset_prog_mode()` and `reset_shell_mode()` instead
        ::endwin();
        tcgetattr(STDIN_FILENO, &terminalParameters);
        ::refresh();

        winsize windowSize =
        {
            .ws_row = narrow<short unsigned int>(this->height())
          , .ws_col = narrow<short unsigned int>(this->width())
        };
        openpty(&fdPtyHost, &fdPtyClient, NULL, &terminalParameters, &windowSize);

        pseudoTerminal = vterm_new(windowSize.ws_row, windowSize.ws_col);
        vterm_set_utf8(pseudoTerminal, true);
        pseudoTerminalScreen = vterm_obtain_screen(pseudoTerminal);
        vterm_screen_reset(pseudoTerminalScreen, true);
        vterm_screen_set_callbacks(pseudoTerminalScreen, &screenCallbacks, this);

        // the terminal is doing most of the work
        //raw(); — cbreak might suffice
        //noecho(); — already set
        //nodelay(true); — @todo needs some reprogramming
        keypad(false);
        nonl();

        /// @todo block all signals, this thread does not handle any
        readPtyClientThread =
            std::thread(&NCursesPtyWindow::readFromPtyClientThreadMethod, this);
    }

    NCursesPtyWindow::~NCursesPtyWindow()
    {
        close(fdPtyHost);
        close(fdPtyClient);
        vterm_free(pseudoTerminal);
    }

    int NCursesPtyWindow::getFdPtyClient() const
    {
        return fdPtyClient;
    }

    /// @todo maybe implement a function with a string buffer
    void NCursesPtyWindow::writeToClient(char character)
    {
        write(fdPtyHost, &character, sizeof(character));
    }

    void NCursesPtyWindow::readFromPtyClientThreadMethod()
    {
        /// @todo in theory, there is no need for a timeout or select …
        ///       file descriptor is blocking
        while(1)
        {
            readFromPtyClient();
            struct timeval timeout = { .tv_sec = 0, .tv_usec = 200000 };
            fd_set readFds;

            FD_ZERO(&readFds);
            FD_SET(fdPtyHost, &readFds);
            if(select(fdPtyHost + 1, &readFds, NULL, NULL, &timeout) < 0)
                break;
        }
    }

    void NCursesPtyWindow::readFromPtyClient()
    {
        size_t bytesRead = read(fdPtyHost, ptyClientOutputBuffer, PTY_CLIENT_OUTPUT_BUFFER_SIZE);
        if(bytesRead != -1 && bytesRead != 0)
            vterm_input_write(pseudoTerminal, ptyClientOutputBuffer, bytesRead);
    }

    VTermScreenCallbacks NCursesPtyWindow::screenCallbacks =
    {
        .damage = staticHandlerDamage,
        .moverect = staticHandlerMoveRect,
        .movecursor = staticHandlerMoveCursor,
        .settermprop = staticHandlerSetTermProp,
        .bell = staticHandlerBell,
        .resize = staticHandlerResize,
        .sb_pushline = staticHandlerPushLine,
        .sb_popline = staticHandlerPopLine,
    };

    int NCursesPtyWindow::handlerDamage(VTermRect rect)
    {
        for(int x = rect.start_col; x < rect.end_col; ++x)
            for(int y = rect.start_row; y < rect.end_row; ++y)
                copyPtyCellToNCursesWindow(x, y);

        refresh();

        return 0;
    }

    int NCursesPtyWindow::handlerMoveRect(VTermRect dest, VTermRect src)
    {
        __debug_log("(unimplemented) move content in rectangle from ("
              + std::to_string(src.start_col) + ", "
              + std::to_string(src.start_row) + ", "
              + std::to_string(src.end_col) + ", "
              + std::to_string(src.end_row) + ") "
              + "size: " + std::to_string((src.start_col - src.end_col) * (src.start_row - src.end_row))
              + " to ("
              + std::to_string(dest.start_col) + ", "
              + std::to_string(dest.start_row) + ", "
              + std::to_string(dest.end_col) + ", "
              + std::to_string(dest.end_row) + ") "
              + "size: " + std::to_string((dest.start_col - dest.end_col) * (dest.start_row - dest.end_row)));
        return 0;
    }

    int NCursesPtyWindow::handlerMoveCursor(VTermPos pos, VTermPos oldpos, int visible)
    {
        /// @todo maybe use `mvcur()` instead?
        cursorX = pos.col;
        cursorY = pos.row;
        refresh();
        return 0;
    }

    int NCursesPtyWindow::handlerSetTermProp(VTermProp prop, VTermValue *val)
    {

        __debug_log(std::string("(unimplemented) set terminal property: ")
                  + (prop == VTERM_PROP_CURSORVISIBLE
                    ? std::string("cursor visible = ")
                      + (val->boolean ? "true" : "false")
                    : "")
                  + (prop == VTERM_PROP_CURSORBLINK
                    ? std::string("cursor blink = ")
                      + (val->boolean ? "true" : "false")
                    : "")
                  + (prop == VTERM_PROP_ALTSCREEN
                    ? std::string("alt screen = ")
                      + (val->boolean ? "true" : "false")
                    : "")
                  + (prop == VTERM_PROP_TITLE
                    ? std::string("title = ")
                      + val->string
                    : "")
                  + (prop == VTERM_PROP_ICONNAME
                    ? std::string("icon name = ")
                      + val->string
                    : "")
                  + (prop == VTERM_PROP_REVERSE
                    ? std::string("alt screen = ")
                      + (val->boolean ? "true" : "false")
                    : "")
                  + (prop == VTERM_PROP_CURSORSHAPE
                    ? std::string("icon name = ")
                      + std::to_string(val->number)
                    : "")
                  + (prop == VTERM_PROP_MOUSE
                    ? std::string("mouse = ")
                      + std::to_string(val->number)
                    : "")
                  + (prop == VTERM_N_PROPS
                    ? "n props" : "")
                );
        return 0;
    }

    int NCursesPtyWindow::handlerBell()
    {
        beep();
        return 0;
    }

    int NCursesPtyWindow::handlerResize(int rows, int cols)
    {
        __debug_log("unimplemented handler called");
        return 0;
    }

    int NCursesPtyWindow::handlerPushLine(int cols, const VTermScreenCell *cells)
    {
        __debug_log("(unimplemented) push line with " + std::to_string(cols) + " columns");
        return 0;
    }

    int NCursesPtyWindow::handlerPopLine(int cols, VTermScreenCell *cells)
    {
        __debug_log("unimplemented handler called");
        return 0;
    }

    attr_t NCursesPtyWindow::extractAttributesFromVTermCell(VTermScreenCell vTermCell)
    {
        attr_t result = A_NORMAL;
        __debug_log("unimplemented method called");
        return result;
    }

    short NCursesPtyWindow::extractColorFromVTermCell(VTermScreenCell vTermCell)
    {
        __debug_log("unimplemented method called");
        return 0;
    }

    void NCursesPtyWindow::copyPtyCellToNCursesWindow(int x, int y)
    {
        VTermPos cellPosition = {y, x};
        VTermScreenCell vTermCell;
        cchar_t converted;
        attr_t formatting;
        short colorPair;
        wchar_t character;

        vterm_screen_get_cell(pseudoTerminalScreen, cellPosition, &vTermCell);
        formatting = extractAttributesFromVTermCell(vTermCell);
        colorPair = extractColorFromVTermCell(vTermCell);

        if(vTermCell.chars[0] == 0)
            character = ' ';
        else
            character = *vTermCell.chars;

        setcchar(&converted, &character, formatting, colorPair, NULL);
        move(cellPosition.row, cellPosition.col);
        chgat(1, formatting, colorPair, NULL);
        add_wch(&converted);
    }

    int NCursesPtyWindow::add_wch(cchar_t *character)
    {
        return ::wadd_wch(w, character);
    }

    int NCursesPtyWindow::refresh()
    {
        move(cursorY, cursorX);
        return NCursesWindow::refresh();
    }

    /// @todo potential racing condition where drawing into terminal while
    ///       resizing?
    int NCursesPtyWindow::wresize(int rows, int cols)
    {
        winsize windowSize =
        {
            .ws_row = narrow<unsigned short>(rows)
          , .ws_col = narrow<unsigned short>(cols)
        };
        ioctl(fdPtyHost, TIOCSWINSZ, &windowSize);
      	vterm_set_size(pseudoTerminal, rows, cols);

        return  NCursesWindow::wresize(rows, cols);
    }

    int NCursesPtyWindow::staticHandlerDamage(VTermRect rect, void *user)
    {
        NCursesPtyWindow *instance = static_cast<NCursesPtyWindow *>(user);
        return instance->handlerDamage(rect);
    }

    int NCursesPtyWindow::staticHandlerMoveRect(VTermRect dest, VTermRect src, void *user)
    {
        NCursesPtyWindow *instance = static_cast<NCursesPtyWindow *>(user);
        return instance->handlerMoveRect(dest, src);
    }

    int NCursesPtyWindow::staticHandlerMoveCursor(VTermPos pos, VTermPos oldpos, int visible, void *user)
    {
        NCursesPtyWindow *instance = static_cast<NCursesPtyWindow *>(user);
        return instance->handlerMoveCursor(pos, oldpos, visible);
    }

    int NCursesPtyWindow::staticHandlerSetTermProp(VTermProp prop, VTermValue *val, void *user)
    {
        NCursesPtyWindow *instance = static_cast<NCursesPtyWindow *>(user);
        return instance->handlerSetTermProp(prop, val);
    }

    int NCursesPtyWindow::staticHandlerBell(void *user)
    {
        NCursesPtyWindow *instance = static_cast<NCursesPtyWindow *>(user);
        return instance->handlerBell();
    }

    int NCursesPtyWindow::staticHandlerResize(int rows, int cols, void *user)
    {
        NCursesPtyWindow *instance = static_cast<NCursesPtyWindow *>(user);
        return instance->handlerResize(rows, cols);
    }

    int NCursesPtyWindow::staticHandlerPushLine(int cols, const VTermScreenCell *cells, void *user)
    {
        NCursesPtyWindow *instance = static_cast<NCursesPtyWindow *>(user);
        return instance->handlerPushLine(cols, cells);
    }

    int NCursesPtyWindow::staticHandlerPopLine(int cols, VTermScreenCell *cells, void *user)
    {
        NCursesPtyWindow *instance = static_cast<NCursesPtyWindow *>(user);
        return instance->handlerPopLine(cols, cells);
    }
}