madtty/madtty.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 © 2004 Bruno T. C. de Oliveira
  19     Copyright © 2006 Pierre Habouzit
  20  */
  21
  22 #include <stdlib.h>
  23 #ifdef USE_PTY
  24 #include <pty.h>
  25 #endif
  26 #include <stdio.h>
  27 #include <string.h>
  28
  29 #include "madtty.h"
  30 #include "roteprivate.h"
  31
  32 #define ROTE_VT_UPDATE_ITERATIONS 5
  33
  34 RoteTerm *rote_vt_create(int rows, int cols)
  35 {
  36     RoteTerm *rt;
  37     int i, j;
  38
  39     if (rows <= 0 || cols <= 0) return NULL;
  40
  41     if (! (rt = (RoteTerm*) malloc(sizeof(RoteTerm))) ) return NULL;
  42     memset(rt, 0, sizeof(RoteTerm));
  43
  44     /* record dimensions */
  45     rt->rows = rows;
  46     rt->cols = cols;
  47
  48     /* default mode is replace */
  49     rt->insert = false;
  50
  51     /* create the cell matrix */
  52     rt->cells = (RoteCell**) malloc(sizeof(RoteCell*) * rt->rows);
  53     for (i = 0; i < rt->rows; i++) {
  54         /* create row */
  55         rt->cells[i] = (RoteCell*) malloc(sizeof(RoteCell) * rt->cols);
  56
  57         /* fill row with spaces */
  58         for (j = 0; j < rt->cols; j++) {
  59             rt->cells[i][j].ch = 0x20;    /* a space */
  60             rt->cells[i][j].attr = 0x70;  /* white text, black background */
  61         }
  62     }
  63
  64     /* allocate dirtiness array */
  65     rt->line_dirty = (bool*) malloc(sizeof(bool) * rt->rows);
  66
  67     /* initialization of other public fields */
  68     rt->crow = rt->ccol = 0;
  69     rt->curattr = 0x70;  /* white text over black background */
  70
  71     /* allocate private data */
  72     rt->pd = (RoteTermPrivate*) malloc(sizeof(RoteTermPrivate));
  73     memset(rt->pd, 0, sizeof(RoteTermPrivate));
  74
  75     rt->pd->pty = -1;  /* no pty for now */
  76
  77     /* initial scrolling area is the whole window */
  78     rt->pd->scrolltop = 0;
  79     rt->pd->scrollbottom = rt->rows - 1;
  80
  81 #ifdef DEBUG
  82     fprintf(stderr, "Created a %d x %d terminal.\n", rt->rows, rt->cols);
  83 #endif
  84
  85     return rt;
  86 }
  87
  88 void rote_vt_destroy(RoteTerm *rt)
  89 {
  90     int i;
  91     if (!rt) return;
  92
  93     free(rt->pd);
  94     free(rt->line_dirty);
  95     for (i = 0; i < rt->rows; i++) free(rt->cells[i]);
  96     free(rt->cells);
  97     free(rt);
  98 }
  99
 100 #ifdef USE_NCURSES
 101
 102 static void default_cur_set_attr(WINDOW *win, unsigned char attr)
 103 {
 104     int cp = ROTE_ATTR_BG(attr) * 8 + 7 - ROTE_ATTR_FG(attr);
 105     if (!cp) wattrset(win, A_NORMAL);
 106     else     wattrset(win, COLOR_PAIR(cp));
 107
 108     if (ROTE_ATTR_BOLD(attr))     wattron(win, A_BOLD);
 109     if (ROTE_ATTR_BLINK(attr))    wattron(win, A_BLINK);
 110 }
 111
 112 #endif
 113
 114 static inline unsigned char ensure_printable(unsigned char ch)
 115 { return ch >= 32 ? ch : 32; }
 116
 117 #ifdef USE_NCURSES
 118
 119 void rote_vt_draw(RoteTerm *rt, WINDOW *win, int srow, int scol,
 120                   void (*cur_set_attr)(WINDOW*,unsigned char)) {
 121
 122     int i, j;
 123     rote_vt_update(rt);
 124
 125     if (!cur_set_attr) cur_set_attr = default_cur_set_attr;
 126     for (i = 0; i < rt->rows; i++) {
 127         wmove(win, srow + i, scol);
 128         for (j = 0; j < rt->cols; j++) {
 129             (*cur_set_attr)(win, rt->cells[i][j].attr);
 130             waddch(win, ensure_printable(rt->cells[i][j].ch));
 131         }
 132     }
 133
 134     wmove(win, srow + rt->crow, scol + rt->ccol);
 135 }
 136
 137 #endif
 138
 139 #ifdef USE_PTY
 140
 141 pid_t rote_vt_forkpty(RoteTerm *rt, const char *command)
 142 {
 143     struct winsize ws;
 144     pid_t childpid;
 145
 146     ws.ws_row = rt->rows;
 147     ws.ws_col = rt->cols;
 148     ws.ws_xpixel = ws.ws_ypixel = 0;
 149
 150     childpid = forkpty(&rt->pd->pty, NULL, NULL, &ws);
 151     if (childpid < 0) return -1;
 152
 153     if (childpid == 0) {
 154         /* we are the child, running under the slave side of the pty. */
 155
 156         /* Cajole application into using linux-console-compatible escape
 157          * sequences (which is what we are prepared to interpret) */
 158         setenv("TERM", "linux", 1);
 159
 160         /* Now we will exec /bin/sh -c command. */
 161         execl("/bin/sh", "/bin/sh", "-c", command, NULL);
 162
 163         fprintf(stderr, "\nexecl() failed.\nCommand: '%s'\n", command);
 164         exit(127);  /* error exec'ing */
 165     }
 166
 167     /* if we got here we are the parent process */
 168     rt->childpid = childpid;
 169     return childpid;
 170 }
 171
 172 void rote_vt_forsake_child(RoteTerm *rt)
 173 {
 174     if (rt->pd->pty >= 0) close(rt->pd->pty);
 175     rt->pd->pty = -1;
 176     rt->childpid = 0;
 177 }
 178
 179 #endif
 180
 181 void rote_vt_update(RoteTerm *rt)
 182 {
 183     fd_set ifs;
 184     struct timeval tvzero;
 185     char buf[512];
 186     int bytesread;
 187     int n = ROTE_VT_UPDATE_ITERATIONS;
 188     if (rt->pd->pty < 0) return;  /* nothing to pump */
 189
 190     while (n--) { /* iterate at most ROVE_VT_UPDATE_ITERATIONS times.
 191                    * As Phil Endecott pointed out, if we don't restrict this,
 192                    * a program that floods the terminal with output
 193                    * could cause this loop to iterate forever, never
 194                    * being able to catch up. So we'll rely on the client
 195                    * calling rote_vt_update often, as the documentation
 196                    * recommends :-) */
 197
 198         /* check if pty has something to say */
 199         FD_ZERO(&ifs); FD_SET(rt->pd->pty, &ifs);
 200         tvzero.tv_sec = 0; tvzero.tv_usec = 0;
 201
 202         if (select(rt->pd->pty + 1, &ifs, NULL, NULL, &tvzero) <= 0)
 203             return; /* nothing to read, or select() failed */
 204
 205         /* read what we can. This is guaranteed not to block, since
 206          * select() told us there was something to read. */
 207         bytesread = read(rt->pd->pty, buf, 512);
 208         if (bytesread <= 0) return;
 209
 210         /* inject the data into the terminal */
 211         rote_vt_inject(rt, buf, bytesread);
 212     }
 213 }
 214
 215 void rote_vt_write(RoteTerm *rt, const char *data, int len)
 216 {
 217     if (rt->pd->pty < 0) {
 218         /* no pty, so just inject the data plain and simple */
 219         rote_vt_inject(rt, data, len);
 220         return;
 221     }
 222
 223     /* write data to pty. Keep calling write() until we have written
 224      * everything. */
 225     while (len > 0) {
 226         int byteswritten = write(rt->pd->pty, data, len);
 227         if (byteswritten < 0) {
 228             /* very ugly way to inform the error. Improvements welcome! */
 229             static char errormsg[] = "\n(ROTE: pty write() error)\n";
 230             rote_vt_inject(rt, errormsg, strlen(errormsg));
 231             return;
 232         }
 233
 234         data += byteswritten;
 235         len  -= byteswritten;
 236     }
 237 }
 238
 239 void rote_vt_install_handler(RoteTerm *rt, rote_es_handler_t handler)
 240 {
 241     rt->pd->handler = handler;
 242 }
 243
 244 void *rote_vt_take_snapshot(RoteTerm *rt)
 245 {
 246     int i;
 247     int bytes_per_row = sizeof(RoteCell) * rt->cols;
 248     void *buf = malloc(bytes_per_row * rt->rows);
 249     void *ptr = buf;
 250
 251     for (i = 0; i < rt->rows; i++, ptr += bytes_per_row)
 252         memcpy(ptr, rt->cells[i], bytes_per_row);
 253
 254     return buf;
 255 }
 256
 257 void rote_vt_restore_snapshot(RoteTerm *rt, void *snapbuf)
 258 {
 259     int i;
 260     int bytes_per_row = sizeof(RoteCell) * rt->cols;
 261
 262     for (i = 0; i < rt->rows; i++, snapbuf += bytes_per_row) {
 263         rt->line_dirty[i] = true;
 264         memcpy(rt->cells[i], snapbuf, bytes_per_row);
 265     }
 266 }
 267
 268 int rote_vt_get_pty_fd(RoteTerm *rt)
 269 {
 270     return rt->pd->pty;
 271 }
 272
 273 static const char *keytable[KEY_MAX+1];
 274 static int initialized = 0;
 275
 276 static void keytable_init();
 277
 278 void rote_vt_keypress(RoteTerm *rt, int keycode)
 279 {
 280     char c = (char) keycode;
 281
 282     if (!initialized) keytable_init();
 283
 284     if (keycode >= 0 && keycode < KEY_MAX && keytable[keycode])
 285         rote_vt_write(rt, keytable[keycode], strlen(keytable[keycode]));
 286     else
 287         rote_vt_write(rt, &c, 1); /* not special, just write it */
 288 }
 289
 290 static void keytable_init()
 291 {
 292     initialized = 1;
 293     memset(keytable, 0, KEY_MAX+1 * sizeof(const char*));
 294
 295     keytable['\n']          = "\r";
 296     keytable[KEY_UP]        = "\e[A";
 297     keytable[KEY_DOWN]      = "\e[B";
 298     keytable[KEY_RIGHT]     = "\e[C";
 299     keytable[KEY_LEFT]      = "\e[D";
 300     keytable[KEY_BACKSPACE] = "\b";
 301     keytable[KEY_HOME]      = "\e[1~";
 302     keytable[KEY_IC]        = "\e[2~";
 303     keytable[KEY_DC]        = "\e[3~";
 304     keytable[KEY_END]       = "\e[4~";
 305     keytable[KEY_PPAGE]     = "\e[5~";
 306     keytable[KEY_NPAGE]     = "\e[6~";
 307     keytable[KEY_SUSPEND]   = "\x1A";  /* Ctrl+Z gets mapped to this */
 308     keytable[KEY_F(1)]      = "\e[[A";
 309     keytable[KEY_F(2)]      = "\e[[B";
 310     keytable[KEY_F(3)]      = "\e[[C";
 311     keytable[KEY_F(4)]      = "\e[[D";
 312     keytable[KEY_F(5)]      = "\e[[E";
 313     keytable[KEY_F(6)]      = "\e[17~";
 314     keytable[KEY_F(7)]      = "\e[18~";
 315     keytable[KEY_F(8)]      = "\e[19~";
 316     keytable[KEY_F(9)]      = "\e[20~";
 317     keytable[KEY_F(10)]     = "\e[21~";
 318 }
 319
 320