source: neercs/trunk/src/term.c @ 2479 Tweet

/*
 *  neercs        console-based window manager
 *  Copyright (c) 2006 Sam Hocevar <sam@zoy.org>
 *                All Rights Reserved
 *
 *  $Id: term.c 2479 2008-06-23 21:02:26Z pterjan $
 *
 *  This program is free software. It comes without any warranty, to
 *  the extent permitted by applicable law. You can redistribute it
 *  and/or modify it under the terms of the Do What The Fuck You Want
 *  To Public License, Version 2, as published by Sam Hocevar. See
 *  http://sam.zoy.org/wtfpl/COPYING for more details.
 */

#include "config.h"

#define _XOPEN_SOURCE
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#if defined HAVE_PTY_H
#   include <pty.h>  /* for openpty and forkpty */
#else
#   include <util.h> /* for OS X */
#endif
#include <unistd.h>
#include <fcntl.h>

#include <cucul.h>
#include <caca.h>

#include "neercs.h"

static void ansi_parse_grcm(struct screen *,
                            unsigned int, unsigned int const *);

long int import_term(struct screen_list *screen_list, struct screen *sc, void const *data, unsigned int size)
{
    unsigned char const *buffer = (unsigned char const*)data;
    unsigned int i, j, k,skip, dummy = 0;
    unsigned int width, height;
    uint32_t savedattr, scrolled = 0;
    int x = 0, y = 0, save_x = 0, save_y = 0;

    width = cucul_get_canvas_width(sc->cv);
    height = cucul_get_canvas_height(sc->cv);
    x = cucul_get_cursor_x(sc->cv);
    y = cucul_get_cursor_y(sc->cv);

    if(!sc->init)
    {
        sc->dfg = CUCUL_DEFAULT;
        sc->dbg = CUCUL_DEFAULT;

        cucul_set_color_ansi(sc->cv, sc->dfg, sc->dbg);
        sc->clearattr = cucul_get_attr(sc->cv, -1, -1);

        ansi_parse_grcm(sc, 1, &dummy);

        sc->init = 1;
    }

    for(i = 0; i < size; i += skip)
    {
        uint32_t ch = 0;
        int wch = 0;

        skip = 1;

        if(buffer[i] == '\r')
        {
            x = 0;
        }

        else if(buffer[i] == '\n')
        {
            x = 0;
            y++;
        }
        else if(buffer[i] == '\a')
        {
            screen_list->in_bell = 10;
            sc->bell = 10;
        }

        else if(buffer[i] == '\t')
        {
            x = (x + 7) & ~7;
        }

        else if(buffer[i] == '\x08')
        {
            if(x > 0)
                x--;
        }

        /* If there are not enough characters to parse the escape sequence,
         * wait until the next try. We require 3. */
        else if(buffer[i] == '\x1b' && i + 2 >= size)
            break;

        /* XXX: What the fuck is this shit? */
        else if(buffer[i] == '\x1b' && buffer[i + 1] == '('
                 && buffer[i + 2] == 'B')
        {
            skip += 2;
        }

        /* Interpret escape commands, as per Standard ECMA-48 "Control
         * Functions for Coded Character Sets", 5.4. Control sequences. */
        else if(buffer[i] == '\x1b' && buffer[i + 1] == '[')
        {
            unsigned int argc = 0, argv[101];
            unsigned int param, inter, final;


        /* Compute offsets to parameter bytes, intermediate bytes and
         * to the final byte. Only the final byte is mandatory, there
         * can be zero of the others.
         * 0  param=2             inter                 final           final+1
         * +-----+------------------+---------------------+-----------------+
         * | CSI | parameter bytes  | intermediate bytes  |   final byte    |
         * |     |   0x30 - 0x3f    |    0x20 - 0x2f      |   0x40 - 0x7e   |
         * | ^[[ | 0123456789:;<=>? | SPC !"#$%&'()*+,-./ | azAZ@[\]^_`{|}~ |
         * +-----+------------------+---------------------+-----------------+
         */
            param = 2;

            for(inter = param; i + inter < size; inter++)
                if(buffer[i + inter] < 0x30 || buffer[i + inter] > 0x3f)
                    break;

            for(final = inter; i + final < size; final++)
                if(buffer[i + final] < 0x20 || buffer[i + final] > 0x2f)
                    break;

            if(i + final >= size
                || buffer[i + final] < 0x40 || buffer[i + final] > 0x7e)
                break; /* Invalid Final Byte */

            skip += final;

            /* Sanity checks */
            if(param < inter && buffer[i + param] >= 0x3c)
            {
                /* Private sequence, only parse what we know */
                debug("ansi import: private sequence \"^[[%.*s\"",
                      final - param + 1, buffer + i + param);
                continue; /* Private sequence, skip it entirely */
            }

            if(final - param > 100)
                continue; /* Suspiciously long sequence, skip it */

            /* Parse parameter bytes as per ECMA-48 5.4.2: Parameter string
             * format */
            if(param < inter)
            {
                argv[0] = 0;
                for(j = param; j < inter; j++)
                {
                    if(buffer[i + j] == ';')
                        argv[++argc] = 0;
                    else if(buffer[i + j] >= '0' && buffer[i + j] <= '9')
                        argv[argc] = 10 * argv[argc] + (buffer[i + j] - '0');
                }
                argc++;
            }

            /* Interpret final byte. The code representations are given in
             * ECMA-48 5.4: Control sequences, and the code definitions are
             * given in ECMA-48 8.3: Definition of control functions. */
            debug("Got command '%c'\n", buffer[i + final]);
            switch(buffer[i + final])
            {
            case 'H': /* CUP (0x48) - Cursor Position */
                x = (argc > 1 && argv[1] > 0) ? argv[1] - 1 : 0;
                y = (argc > 0 && argv[0] > 0) ? argv[0] - 1 : 0;
                break;
            case 'A': /* CUU (0x41) - Cursor Up */
                y -= argc ? argv[0] : 1;
                if(y < 0)
                    y = 0;
                break;
            case 'B': /* CUD (0x42) - Cursor Down */
                y += argc ? argv[0] : 1;
                break;
            case 'C': /* CUF (0x43) - Cursor Right */
                x += argc ? argv[0] : 1;
                break;
            case 'D': /* CUB (0x44) - Cursor Left */
                x -= argc ? argv[0] : 1;
                if(x < 0)
                    x = 0;
                break;
            case 'G': /* CHA (0x47) - Cursor Character Absolute */
                x = (argc && argv[0] > 0) ? argv[0] - 1 : 0;
                break;
            case 'J': /* ED (0x4a) - Erase In Page */
                savedattr = cucul_get_attr(sc->cv, -1, -1);
                cucul_set_attr(sc->cv, sc->clearattr);
                if(!argc || argv[0] == 0)
                {
                    cucul_draw_line(sc->cv, x, y, width, y, ' ');
                    cucul_fill_box(sc->cv, 0, y + 1, width - 1, height - 1, ' ');
                }
                else if(argv[0] == 1)
                {
                    cucul_fill_box(sc->cv, 0, 0, width - 1, y - 1, ' ');
                    cucul_draw_line(sc->cv, 0, y, x, y, ' ');
                }
                else if(argv[0] == 2)
                {
                    //x = y = 0;
                    cucul_fill_box(sc->cv, 0, 0, width, height - 1, ' ');
                }
                cucul_set_attr(sc->cv, savedattr);
                break;
            case 'K': /* EL (0x4b) - Erase In Line */
                if(!argc || argv[0] == 0)
                    cucul_draw_line(sc->cv, x, y, width, y, ' ');
                else if(argv[0] == 1)
                    cucul_draw_line(sc->cv, 0, y, x, y, ' ');
                else if(argv[0] == 2)
                    if((unsigned int)x < width)
                        cucul_draw_line(sc->cv, x, y, width - 1, y, ' ');
                //x = width;
                break;
            case 'P': /* DCH (0x50) - Delete Character */
                if(!argc || argv[0] == 0)
                    argv[0] = 1; /* echo -ne 'foobar\r\e[0P\n' */
                for(j = 0; (unsigned int)(j + argv[0]) < width; j++)
                {
                    cucul_put_char(sc->cv, j, y,
                                   cucul_get_char(sc->cv, j + argv[0], y));
                    cucul_put_attr(sc->cv, j, y,
                                   cucul_get_attr(sc->cv, j + argv[0], y));
                }
#if 0
                savedattr = cucul_get_attr(sc->cv, -1, -1);
                cucul_set_attr(sc->cv, sc->clearattr);
                for( ; (unsigned int)j < width; j++)
                    cucul_put_char(sc->cv, j, y, ' ');
                cucul_set_attr(sc->cv, savedattr);
#endif
            case 'X': /* ECH (0x58) - Erase Character */
                if(argc && argv[0])
                {
                    savedattr = cucul_get_attr(sc->cv, -1, -1);
                    cucul_set_attr(sc->cv, sc->clearattr);
                    cucul_draw_line(sc->cv, x, y, x + argv[0] - 1, y, ' ');
                    cucul_set_attr(sc->cv, savedattr);
                }
            case 'd': /* VPA (0x64) - Line Position Absolute */
                y = (argc && argv[0] > 0) ? argv[0] - 1 : 0;
                break;
            case 'f': /* HVP (0x66) - Character And Line Position */
                x = (argc > 1 && argv[1] > 0) ? argv[1] - 1 : 0;
                y = (argc > 0 && argv[0] > 0) ? argv[0] - 1 : 0;
                break;
            case 'r': /* SS  (0x72) - Scroll Screen FIXME */
                if(scrolled) break;
                if((argv[0]==0 && argv[1]==0)  || scrolled) break;
                for(j = argv[0]-1; j < argv[1]-1; j++)
                {
                    for(k = 0; k < width; k++)
                    {
                        cucul_put_char(sc->cv, k, j, cucul_get_char(sc->cv, k, j+1));
                        cucul_put_attr(sc->cv, k, j, cucul_get_attr(sc->cv, k, j+1));
                    }
                }
                cucul_draw_line(sc->cv, 0, argv[1]-1, width, argv[1]-1, ' ');
                scrolled = 1;
                break;
            case 'h': /* SM (0x68) - FIXME */
                debug("ansi import: set mode %i", argc ? (int)argv[0] : -1);
                break;
            case 'l': /* RM (0x6c) - FIXME */
                debug("ansi import: reset mode %i", argc ? (int)argv[0] : -1);
                break;
            case 'm': /* SGR (0x6d) - Select Graphic Rendition */
                if(argc)
                    ansi_parse_grcm(sc, argc, argv);
                else
                    ansi_parse_grcm(sc, 1, &dummy);
                break;
            case 's': /* Private (save cursor position) */
                save_x = x;
                save_y = y;
                break;
            case 'u': /* Private (reload cursor position) */
                x = save_x;
                y = save_y;
                break;
            default:
                debug("ansi import: unknown command \"^[[%.*s\"",
                      final - param + 1, buffer + i + param);
                break;
            }
        }

        /* Parse OSC stuff. */
        else if(buffer[i] == '\x1b' && buffer[i + 1] == ']')
        {
            char *string;
            unsigned int command = 0;
            unsigned int mode = 2, semicolon, final;

            for(semicolon = mode; i + semicolon < size; semicolon++)
            {
                if(buffer[i + semicolon] < '0' || buffer[i + semicolon] > '9')
                    break;
                command = 10 * command + (buffer[i + semicolon] - '0');
            }

            if(i + semicolon >= size || buffer[i + semicolon] != ';')
                break; /* Invalid Mode */

            for(final = semicolon + 1; i + final < size; final++)
                if(buffer[i + final] < 0x20)
                    break;

            if(i + final >= size || buffer[i + final] != '\a')
                break; /* Not enough data or no bell found */
                /* FIXME: XTerm also reacts to <ESC><backslash> and <ST> */
                /* FIXME: differenciate between not enough data (try again)
                 *        and invalid data (print shit) */

            skip += final;

            string = malloc(final - (semicolon + 1) + 1);
            memcpy(string, buffer + i + (semicolon + 1), final - (semicolon + 1));
            string[final - (semicolon + 1)] = '\0';
            debug("ansi import: got OSC command %i string '%s'", command,
                  string);
            if(command == 0 || command == 2)
            {
                if(sc->title)
                    free(sc->title);
                sc->title = string;
            }
            else
                free(string);
        }

        /* Get the character we’re going to paste */
        else
        {
            unsigned int bytes;

            if(i + 6 < size)
                ch = cucul_utf8_to_utf32((char const *)(buffer + i), &bytes);
            else
            {
                /* Add a trailing zero to what we're going to read */
                char tmp[7];
                memcpy(tmp, buffer + i, size - i);
                tmp[size - i] = '\0';
                ch = cucul_utf8_to_utf32(tmp, &bytes);
            }

            if(!bytes)
            {
                /* If the Unicode is invalid, assume it was latin1. */
                ch = buffer[i];
                bytes = 1;
            }
            wch = cucul_utf32_is_fullwidth(ch) ? 2 : 1;
            skip += bytes - 1;
        }

        /* Wrap long lines or grow horizontally */
        while((unsigned int)x + wch > width)
        {
            x -= width;
            y++;
        }

        /* Scroll or grow vertically */
        if((unsigned int)y >= height)
        {
            int lines = (y - height) + 1;

            savedattr = cucul_get_attr(sc->cv, -1, -1);

            for(j = 0; j + lines < height; j++)
            {
                for(k = 0; k < width; k++)
                {
                    cucul_put_char(sc->cv, k, j, cucul_get_char(sc->cv, k, j + lines));
                    cucul_put_attr(sc->cv, k, j, cucul_get_attr(sc->cv, k, j + lines));
                }
            }
            cucul_set_attr(sc->cv, sc->clearattr);
            cucul_fill_box(sc->cv, 0, height - lines,
                                   width - 1, height - 1, ' ');
            y -= lines;
            cucul_set_attr(sc->cv, savedattr);
        }

        /* Now paste our character, if any */
        if(wch)
        {
            cucul_put_char(sc->cv, x, y, ch);
            x += wch;
        }
    }

    cucul_gotoxy(sc->cv, x, y);

    return i;
}

/* XXX : ANSI loader helper */

static void ansi_parse_grcm(struct screen *sc,
                            unsigned int argc, unsigned int const *argv)
{
    static uint8_t const ansi2cucul[] =
    {
        CUCUL_BLACK, CUCUL_RED, CUCUL_GREEN, CUCUL_BROWN,
        CUCUL_BLUE, CUCUL_MAGENTA, CUCUL_CYAN, CUCUL_LIGHTGRAY
    };

    unsigned int j;
    uint8_t efg, ebg; /* Effective (libcucul) fg/bg */

    for(j = 0; j < argc; j++)
    {
        /* Defined in ECMA-48 8.3.117: SGR - SELECT GRAPHIC RENDITION */
        if(argv[j] >= 30 && argv[j] <= 37)
            sc->fg = ansi2cucul[argv[j] - 30];
        else if(argv[j] >= 40 && argv[j] <= 47)
            sc->bg = ansi2cucul[argv[j] - 40];
        else if(argv[j] >= 90 && argv[j] <= 97)
            sc->fg = ansi2cucul[argv[j] - 90] + 8;
        else if(argv[j] >= 100 && argv[j] <= 107)
            sc->bg = ansi2cucul[argv[j] - 100] + 8;
        else switch(argv[j])
        {
        case 0: /* default rendition */
            sc->fg = sc->dfg;
            sc->bg = sc->dbg;
            sc->bold = sc->blink = sc->italics = sc->negative
             = sc->concealed = sc->underline = sc->faint = sc->strike
             = sc->proportional = 0;
            break;
        case 1: /* bold or increased intensity */
            sc->bold = 1;
            break;
        case 2: /* faint, decreased intensity or second colour */
            sc->faint = 1;
            break;
        case 3: /* italicized */
            sc->italics = 1;
            break;
        case 4: /* singly underlined */
            sc->underline = 1;
            break;
        case 5: /* slowly blinking (less then 150 per minute) */
        case 6: /* rapidly blinking (150 per minute or more) */
            sc->blink = 1;
            break;
        case 7: /* negative image */
            sc->negative = 1;
            break;
        case 8: /* concealed characters */
            sc->concealed = 1;
            break;
        case 9: /* crossed-out (characters still legible but marked as to be
                 * deleted */
            sc->strike = 1;
            break;
        case 21: /* doubly underlined */
            sc->underline = 1;
            break;
        case 22: /* normal colour or normal intensity (neither bold nor
                  * faint) */
            sc->bold = sc->faint = 0;
            break;
        case 23: /* not italicized, not fraktur */
            sc->italics = 0;
            break;
        case 24: /* not underlined (neither singly nor doubly) */
            sc->underline = 0;
            break;
        case 25: /* steady (not blinking) */
            sc->blink = 0;
            break;
        case 26: /* (reserved for proportional spacing as specified in CCITT
                  * Recommendation T.61) */
            sc->proportional = 1;
            break;
        case 27: /* positive image */
            sc->negative = 0;
            break;
        case 28: /* revealed characters */
            sc->concealed = 0;
            break;
        case 29: /* not crossed out */
            sc->strike = 0;
            break;
        case 38: /* (reserved for future standardization, intended for setting
                  * character foreground colour as specified in ISO 8613-6
                  * [CCITT Recommendation T.416]) */
            break;
        case 39: /* default display colour (implementation-defined) */
            sc->fg = sc->dfg;
            break;
        case 48: /* (reserved for future standardization, intended for setting
                  * character background colour as specified in ISO 8613-6
                  * [CCITT Recommendation T.416]) */
            break;
        case 49: /* default background colour (implementation-defined) */
            sc->bg = sc->dbg;
            break;
        case 50: /* (reserved for cancelling the effect of the rendering
                  * aspect established by parameter value 26) */
            sc->proportional = 0;
            break;
        default:
            debug("ansi import: unknown sgr %i", argv[j]);
            break;
        }
    }

    if(sc->concealed)
    {
        efg = ebg = CUCUL_TRANSPARENT;
    }
    else
    {
        efg = sc->negative ? sc->bg : sc->fg;
        ebg = sc->negative ? sc->fg : sc->bg;

        if(sc->bold)
        {
            if(efg < 8)
                efg += 8;
            else if(efg == CUCUL_DEFAULT)
                efg = CUCUL_WHITE;
        }
    }

    cucul_set_color_ansi(sc->cv, efg, ebg);
}

int create_pty(char *cmd, unsigned int w, unsigned int h, int *cpid)
{
    char **argv;
    int fd;
    pid_t pid;

    pid = forkpty(&fd, NULL, NULL, NULL);
    if(pid < 0)
    {
        fprintf(stderr, "forkpty() error\n");
        return -1;
    }
    else if(pid == 0)
    {
        set_tty_size(0, w, h);
        putenv("CACA_DRIVER=slang");
        putenv("TERM=xterm");
        argv = malloc(2 * sizeof(char *));
        if(!argv)
        {
            fprintf(stderr, "Can't allocate memory at %s:%d\n", __FUNCTION__, __LINE__);
            return -1;
        }
        argv[0] = cmd;
        argv[1] = NULL;
        execvp(cmd, argv);
        fprintf(stderr, "execvp() error\n");
        return -1;
    }

    *cpid = pid;

    fcntl(fd, F_SETFL, O_NDELAY);
    return fd;
}

int create_pty_grab(pid_t pid, unsigned int w, unsigned int h)
{
    int fdm, fds;

    int ret = openpty(&fdm, &fds, NULL, NULL, NULL);

    if(ret < 0)
    {
        fprintf(stderr, "open() error\n");
        return -1;
    }

    set_tty_size(0, w, h);
    grab_process(pid, ptsname(fdm), fds);

    fcntl(fdm, F_SETFL, O_NDELAY);
    return fdm;
}

int set_tty_size(int fd, unsigned int w, unsigned int h)
{
    struct winsize ws;

    memset(&ws, 0, sizeof(ws));
    ws.ws_row = h;
    ws.ws_col = w;
    ioctl(fd, TIOCSWINSZ, (char *)&ws);

    return 0;
}



int update_terms(struct screen_list* screen_list)
{
    int i, refresh = 0;
    for(i = 0; i < screen_list->count; i++)
    {
        if(screen_list->screen[i]->total && !screen_list->dont_update_coords)
        {
            unsigned long int bytes;

            bytes = import_term(screen_list,
                                screen_list->screen[i],
                                screen_list->screen[i]->buf,
                                screen_list->screen[i]->total);

            if(bytes > 0)
            {
                screen_list->screen[i]->total -= bytes;
                memmove(screen_list->screen[i]->buf,
                        screen_list->screen[i]->buf + bytes,
                        screen_list->screen[i]->total);
                refresh = 1;
            }
        }
    }
    return refresh;
}