rote.c

   1 /*
   2 LICENSE INFORMATION:
   3 This program is free software; you can redistribute it and/or
   4 modify it under the terms of the GNU Lesser General Public
   5 License (LGPL) as published by the Free Software Foundation.
   6
   7 Please refer to the COPYING file for more information.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 General Public License for more details.
  13
  14 You should have received a copy of the GNU Lesser General Public
  15 License along with this program; if not, write to the Free Software
  16 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17
  18 Copyright (c) 2004 Bruno T. C. de Oliveira
  19 */
  20
  21
  22 #include "rote.h"
  23 #include "roteprivate.h"
  24 #include <stdlib.h>
  25 #ifdef USE_PTY
  26 #include <pty.h>
  27 #endif
  28 #include <stdio.h>
  29 #include <string.h>
  30
  31 #define ROTE_VT_UPDATE_ITERATIONS 5
  32
  33 RoteTerm *rote_vt_create(int rows, int cols) {
  34    RoteTerm *rt;
  35    int i, j;
  36
  37    if (rows <= 0 || cols <= 0) return NULL;
  38
  39    if (! (rt = (RoteTerm*) malloc(sizeof(RoteTerm))) ) return NULL;
  40    memset(rt, 0, sizeof(RoteTerm));
  41
  42    /* record dimensions */
  43    rt->rows = rows;
  44    rt->cols = cols;
  45
  46    /* default mode is replace */
  47    rt->insert = false;
  48
  49    /* create the cell matrix */
  50    rt->cells = (RoteCell**) malloc(sizeof(RoteCell*) * rt->rows);
  51    for (i = 0; i < rt->rows; i++) {
  52       /* create row */
  53       rt->cells[i] = (RoteCell*) malloc(sizeof(RoteCell) * rt->cols);
  54
  55       /* fill row with spaces */
  56       for (j = 0; j < rt->cols; j++) {
  57          rt->cells[i][j].ch = 0x20;    /* a space */
  58          rt->cells[i][j].attr = 0x70;  /* white text, black background */
  59       }
  60    }
  61
  62    /* allocate dirtiness array */
  63    rt->line_dirty = (bool*) malloc(sizeof(bool) * rt->rows);
  64
  65    /* initialization of other public fields */
  66    rt->crow = rt->ccol = 0;
  67    rt->curattr = 0x70;  /* white text over black background */
  68
  69    /* allocate private data */
  70    rt->pd = (RoteTermPrivate*) malloc(sizeof(RoteTermPrivate));
  71    memset(rt->pd, 0, sizeof(RoteTermPrivate));
  72
  73    rt->pd->pty = -1;  /* no pty for now */
  74
  75    /* initial scrolling area is the whole window */
  76    rt->pd->scrolltop = 0;
  77    rt->pd->scrollbottom = rt->rows - 1;
  78
  79    #ifdef DEBUG
  80    fprintf(stderr, "Created a %d x %d terminal.\n", rt->rows, rt->cols);
  81    #endif
  82
  83    return rt;
  84 }
  85
  86 void rote_vt_destroy(RoteTerm *rt) {
  87    int i;
  88    if (!rt) return;
  89
  90    free(rt->pd);
  91    free(rt->line_dirty);
  92    for (i = 0; i < rt->rows; i++) free(rt->cells[i]);
  93    free(rt->cells);
  94    free(rt);
  95 }
  96
  97 #ifdef USE_NCURSES
  98
  99 static void default_cur_set_attr(WINDOW *win, unsigned char attr) {
 100    int cp = ROTE_ATTR_BG(attr) * 8 + 7 - ROTE_ATTR_FG(attr);
 101    if (!cp) wattrset(win, A_NORMAL);
 102    else     wattrset(win, COLOR_PAIR(cp));
 103
 104    if (ROTE_ATTR_BOLD(attr))     wattron(win, A_BOLD);
 105    if (ROTE_ATTR_BLINK(attr))    wattron(win, A_BLINK);
 106 }
 107
 108 #endif
 109
 110 static inline unsigned char ensure_printable(unsigned char ch)
 111                                         { return ch >= 32 ? ch : 32; }
 112
 113 #ifdef USE_NCURSES
 114
 115 void rote_vt_draw(RoteTerm *rt, WINDOW *win, int srow, int scol,
 116                                 void (*cur_set_attr)(WINDOW*,unsigned char)) {
 117
 118    int i, j;
 119    rote_vt_update(rt);
 120
 121    if (!cur_set_attr) cur_set_attr = default_cur_set_attr;
 122    for (i = 0; i < rt->rows; i++) {
 123       wmove(win, srow + i, scol);
 124       for (j = 0; j < rt->cols; j++) {
 125          (*cur_set_attr)(win, rt->cells[i][j].attr);
 126          waddch(win, ensure_printable(rt->cells[i][j].ch));
 127       }
 128    }
 129
 130    wmove(win, srow + rt->crow, scol + rt->ccol);
 131 }
 132
 133 #endif
 134
 135 #ifdef USE_PTY
 136
 137 pid_t rote_vt_forkpty(RoteTerm *rt, const char *command) {
 138    struct winsize ws;
 139    pid_t childpid;
 140
 141    ws.ws_row = rt->rows;
 142    ws.ws_col = rt->cols;
 143    ws.ws_xpixel = ws.ws_ypixel = 0;
 144
 145    childpid = forkpty(&rt->pd->pty, NULL, NULL, &ws);
 146    if (childpid < 0) return -1;
 147
 148    if (childpid == 0) {
 149       /* we are the child, running under the slave side of the pty. */
 150
 151       /* Cajole application into using linux-console-compatible escape
 152        * sequences (which is what we are prepared to interpret) */
 153       setenv("TERM", "linux", 1);
 154
 155       /* Now we will exec /bin/sh -c command. */
 156       execl("/bin/sh", "/bin/sh", "-c", command, NULL);
 157
 158       fprintf(stderr, "\nexecl() failed.\nCommand: '%s'\n", command);
 159       exit(127);  /* error exec'ing */
 160    }
 161
 162    /* if we got here we are the parent process */
 163    rt->childpid = childpid;
 164    return childpid;
 165 }
 166
 167 void rote_vt_forsake_child(RoteTerm *rt) {
 168    if (rt->pd->pty >= 0) close(rt->pd->pty);
 169    rt->pd->pty = -1;
 170    rt->childpid = 0;
 171 }
 172
 173 #endif
 174
 175 void rote_vt_update(RoteTerm *rt) {
 176    fd_set ifs;
 177    struct timeval tvzero;
 178    char buf[512];
 179    int bytesread;
 180    int n = ROTE_VT_UPDATE_ITERATIONS;
 181    if (rt->pd->pty < 0) return;  /* nothing to pump */
 182
 183    while (n--) { /* iterate at most ROVE_VT_UPDATE_ITERATIONS times.
 184                   * As Phil Endecott pointed out, if we don't restrict this,
 185                   * a program that floods the terminal with output
 186                   * could cause this loop to iterate forever, never
 187                   * being able to catch up. So we'll rely on the client
 188                   * calling rote_vt_update often, as the documentation
 189                   * recommends :-) */
 190
 191       /* check if pty has something to say */
 192       FD_ZERO(&ifs); FD_SET(rt->pd->pty, &ifs);
 193       tvzero.tv_sec = 0; tvzero.tv_usec = 0;
 194
 195       if (select(rt->pd->pty + 1, &ifs, NULL, NULL, &tvzero) <= 0)
 196          return; /* nothing to read, or select() failed */
 197
 198       /* read what we can. This is guaranteed not to block, since
 199        * select() told us there was something to read. */
 200       bytesread = read(rt->pd->pty, buf, 512);
 201       if (bytesread <= 0) return;
 202
 203       /* inject the data into the terminal */
 204       rote_vt_inject(rt, buf, bytesread);
 205    }
 206 }
 207
 208 void rote_vt_write(RoteTerm *rt, const char *data, int len) {
 209    if (rt->pd->pty < 0) {
 210       /* no pty, so just inject the data plain and simple */
 211       rote_vt_inject(rt, data, len);
 212       return;
 213    }
 214
 215    /* write data to pty. Keep calling write() until we have written
 216     * everything. */
 217    while (len > 0) {
 218       int byteswritten = write(rt->pd->pty, data, len);
 219       if (byteswritten < 0) {
 220          /* very ugly way to inform the error. Improvements welcome! */
 221          static char errormsg[] = "\n(ROTE: pty write() error)\n";
 222          rote_vt_inject(rt, errormsg, strlen(errormsg));
 223          return;
 224       }
 225
 226       data += byteswritten;
 227       len  -= byteswritten;
 228    }
 229 }
 230
 231 void rote_vt_install_handler(RoteTerm *rt, rote_es_handler_t handler) {
 232    rt->pd->handler = handler;
 233 }
 234
 235 void *rote_vt_take_snapshot(RoteTerm *rt) {
 236    int i;
 237    int bytes_per_row = sizeof(RoteCell) * rt->cols;
 238    void *buf = malloc(bytes_per_row * rt->rows);
 239    void *ptr = buf;
 240
 241    for (i = 0; i < rt->rows; i++, ptr += bytes_per_row)
 242       memcpy(ptr, rt->cells[i], bytes_per_row);
 243
 244    return buf;
 245 }
 246
 247 void rote_vt_restore_snapshot(RoteTerm *rt, void *snapbuf) {
 248    int i;
 249    int bytes_per_row = sizeof(RoteCell) * rt->cols;
 250
 251    for (i = 0; i < rt->rows; i++, snapbuf += bytes_per_row) {
 252       rt->line_dirty[i] = true;
 253       memcpy(rt->cells[i], snapbuf, bytes_per_row);
 254    }
 255 }
 256
 257 int rote_vt_get_pty_fd(RoteTerm *rt) {
 258    return rt->pd->pty;
 259 }
 260