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.
7 Please refer to the COPYING file for more information.
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.
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
18 Copyright © 2004 Bruno T. C. de Oliveira
19 Copyright © 2006 Pierre Habouzit
30 #include "roteprivate.h"
32 #define ROTE_VT_UPDATE_ITERATIONS 5
34 RoteTerm *rote_vt_create(int rows, int cols)
39 if (rows <= 0 || cols <= 0) return NULL;
41 if (! (rt = (RoteTerm*) malloc(sizeof(RoteTerm))) ) return NULL;
42 memset(rt, 0, sizeof(RoteTerm));
44 /* record dimensions */
48 /* default mode is replace */
51 /* create the cell matrix */
52 rt->cells = (RoteCell**) malloc(sizeof(RoteCell*) * rt->rows);
53 for (i = 0; i < rt->rows; i++) {
55 rt->cells[i] = (RoteCell*) malloc(sizeof(RoteCell) * rt->cols);
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 */
64 /* allocate dirtiness array */
65 rt->line_dirty = (bool*) malloc(sizeof(bool) * rt->rows);
67 /* initialization of other public fields */
68 rt->crow = rt->ccol = 0;
69 rt->curattr = 0x70; /* white text over black background */
71 /* allocate private data */
72 rt->pd = (RoteTermPrivate*) malloc(sizeof(RoteTermPrivate));
73 memset(rt->pd, 0, sizeof(RoteTermPrivate));
75 rt->pd->pty = -1; /* no pty for now */
77 /* initial scrolling area is the whole window */
78 rt->pd->scrolltop = 0;
79 rt->pd->scrollbottom = rt->rows - 1;
84 void rote_vt_destroy(RoteTerm *rt)
91 for (i = 0; i < rt->rows; i++) free(rt->cells[i]);
98 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));
104 if (ROTE_ATTR_BOLD(attr)) wattron(win, A_BOLD);
105 if (ROTE_ATTR_BLINK(attr)) wattron(win, A_BLINK);
108 static inline unsigned char ensure_printable(unsigned char ch)
110 return ch >= 32 ? ch : 32;
113 void rote_vt_draw(RoteTerm *rt, WINDOW *win, int srow, int scol,
114 void (*cur_set_attr)(WINDOW*,unsigned char)) {
119 if (!cur_set_attr) cur_set_attr = default_cur_set_attr;
120 for (i = 0; i < rt->rows; i++) {
121 wmove(win, srow + i, scol);
122 for (j = 0; j < rt->cols; j++) {
123 (*cur_set_attr)(win, rt->cells[i][j].attr);
124 waddch(win, ensure_printable(rt->cells[i][j].ch));
128 wmove(win, srow + rt->crow, scol + rt->ccol);
135 pid_t rote_vt_forkpty(RoteTerm *rt, const char *command)
140 ws.ws_row = rt->rows;
141 ws.ws_col = rt->cols;
142 ws.ws_xpixel = ws.ws_ypixel = 0;
144 childpid = forkpty(&rt->pd->pty, NULL, NULL, &ws);
145 if (childpid < 0) return -1;
148 /* we are the child, running under the slave side of the pty. */
150 /* Cajole application into using linux-console-compatible escape
151 * sequences (which is what we are prepared to interpret) */
152 setenv("TERM", "linux", 1);
154 /* Now we will exec /bin/sh -c command. */
155 execl("/bin/sh", "/bin/sh", "-c", command, NULL);
157 fprintf(stderr, "\nexecl() failed.\nCommand: '%s'\n", command);
158 exit(127); /* error exec'ing */
161 /* if we got here we are the parent process */
162 rt->childpid = childpid;
166 void rote_vt_forsake_child(RoteTerm *rt)
168 if (rt->pd->pty >= 0) close(rt->pd->pty);
175 void rote_vt_update(RoteTerm *rt)
178 struct timeval tvzero;
181 int n = ROTE_VT_UPDATE_ITERATIONS;
182 if (rt->pd->pty < 0) return; /* nothing to pump */
184 while (n--) { /* iterate at most ROVE_VT_UPDATE_ITERATIONS times.
185 * As Phil Endecott pointed out, if we don't restrict this,
186 * a program that floods the terminal with output
187 * could cause this loop to iterate forever, never
188 * being able to catch up. So we'll rely on the client
189 * calling rote_vt_update often, as the documentation
192 /* check if pty has something to say */
193 FD_ZERO(&ifs); FD_SET(rt->pd->pty, &ifs);
194 tvzero.tv_sec = 0; tvzero.tv_usec = 0;
196 if (select(rt->pd->pty + 1, &ifs, NULL, NULL, &tvzero) <= 0)
197 return; /* nothing to read, or select() failed */
199 /* read what we can. This is guaranteed not to block, since
200 * select() told us there was something to read. */
201 bytesread = read(rt->pd->pty, buf, 512);
202 if (bytesread <= 0) return;
204 /* inject the data into the terminal */
205 rote_vt_inject(rt, buf, bytesread);
209 void rote_vt_write(RoteTerm *rt, const char *data, int len)
211 if (rt->pd->pty < 0) {
212 /* no pty, so just inject the data plain and simple */
213 rote_vt_inject(rt, data, len);
217 /* write data to pty. Keep calling write() until we have written
220 int byteswritten = write(rt->pd->pty, data, len);
221 if (byteswritten < 0) {
222 /* very ugly way to inform the error. Improvements welcome! */
223 static char errormsg[] = "\n(ROTE: pty write() error)\n";
224 rote_vt_inject(rt, errormsg, strlen(errormsg));
228 data += byteswritten;
233 void rote_vt_install_handler(RoteTerm *rt, rote_es_handler_t handler)
235 rt->pd->handler = handler;
238 void *rote_vt_take_snapshot(RoteTerm *rt)
241 int bytes_per_row = sizeof(RoteCell) * rt->cols;
242 void *buf = malloc(bytes_per_row * rt->rows);
245 for (i = 0; i < rt->rows; i++, ptr += bytes_per_row)
246 memcpy(ptr, rt->cells[i], bytes_per_row);
251 void rote_vt_restore_snapshot(RoteTerm *rt, void *snapbuf)
254 int bytes_per_row = sizeof(RoteCell) * rt->cols;
256 for (i = 0; i < rt->rows; i++, snapbuf += bytes_per_row) {
257 rt->line_dirty[i] = true;
258 memcpy(rt->cells[i], snapbuf, bytes_per_row);
262 int rote_vt_get_pty_fd(RoteTerm *rt)
267 static const char *keytable[KEY_MAX+1];
268 static int initialized = 0;
270 static void keytable_init();
272 void rote_vt_keypress(RoteTerm *rt, int keycode)
274 char c = (char) keycode;
276 if (!initialized) keytable_init();
278 if (keycode >= 0 && keycode < KEY_MAX && keytable[keycode])
279 rote_vt_write(rt, keytable[keycode], strlen(keytable[keycode]));
281 rote_vt_write(rt, &c, 1); /* not special, just write it */
284 static void keytable_init()
287 memset(keytable, 0, KEY_MAX+1 * sizeof(const char*));
289 keytable['\n'] = "\r";
290 keytable[KEY_UP] = "\e[A";
291 keytable[KEY_DOWN] = "\e[B";
292 keytable[KEY_RIGHT] = "\e[C";
293 keytable[KEY_LEFT] = "\e[D";
294 keytable[KEY_BACKSPACE] = "\b";
295 keytable[KEY_HOME] = "\e[1~";
296 keytable[KEY_IC] = "\e[2~";
297 keytable[KEY_DC] = "\e[3~";
298 keytable[KEY_END] = "\e[4~";
299 keytable[KEY_PPAGE] = "\e[5~";
300 keytable[KEY_NPAGE] = "\e[6~";
301 keytable[KEY_SUSPEND] = "\x1A"; /* Ctrl+Z gets mapped to this */
302 keytable[KEY_F(1)] = "\e[[A";
303 keytable[KEY_F(2)] = "\e[[B";
304 keytable[KEY_F(3)] = "\e[[C";
305 keytable[KEY_F(4)] = "\e[[D";
306 keytable[KEY_F(5)] = "\e[[E";
307 keytable[KEY_F(6)] = "\e[17~";
308 keytable[KEY_F(7)] = "\e[18~";
309 keytable[KEY_F(8)] = "\e[19~";
310 keytable[KEY_F(9)] = "\e[20~";
311 keytable[KEY_F(10)] = "\e[21~";