source: libcaca/trunk/caca/driver/slang.c @ 3983

Last change on this file since 3983 was 3983, checked in by Jean-Yves Lamoureux, 10 years ago
  • Disable SLang's own SIGINT handler
  • Property svn:keywords set to Id
File size: 17.4 KB
Line 
1/*
2 *  libcaca       Colour ASCII-Art library
3 *  Copyright (c) 2002-2009 Sam Hocevar <sam@hocevar.net>
4 *                All Rights Reserved
5 *
6 *  $Id: slang.c 3983 2009-11-21 10:12:09Z jylam $
7 *
8 *  This library is free software. It comes without any warranty, to
9 *  the extent permitted by applicable law. You can redistribute it
10 *  and/or modify it under the terms of the Do What The Fuck You Want
11 *  To Public License, Version 2, as published by Sam Hocevar. See
12 *  http://sam.zoy.org/wtfpl/COPYING for more details.
13 */
14
15/*
16 *  This file contains the libcaca SLang input and output driver
17 */
18
19#include "config.h"
20
21#if defined(USE_SLANG)
22
23#if defined(HAVE_SLANG_SLANG_H)
24#   include <slang/slang.h>
25#else
26#   include <slang.h>
27#endif
28
29#include <stdlib.h>
30#include <string.h>
31
32#if defined(HAVE_SIGNAL_H)
33#   include <signal.h>
34#endif
35
36#include "caca.h"
37#include "caca_internals.h"
38
39/*
40 * Global variables
41 */
42
43/* Tables generated by tools/optipal.c */
44static int const slang_palette[2*16*16] =
45{
46     1,  0,   2,  0,   3,  0,   4,  0,   5,  0,   6,  0,   7,  0,   8,  0,
47     9,  0,  10,  0,  11,  0,  12,  0,  13,  0,  14,  0,  15,  0,   0,  8,
48     8,  7,   7,  8,  15,  7,   7, 15,  15,  9,   9, 15,   1,  9,   9,  1,
49     7,  9,   9,  7,   8,  1,   1,  8,   0,  1,  15, 10,  10, 15,   2, 10,
50    10,  2,   7, 10,  10,  7,   8,  2,   2,  8,   0,  2,  15, 11,  11, 15,
51     3, 11,  11,  3,   7, 11,  11,  7,   8,  3,   3,  8,   0,  3,  15, 12,
52    12, 15,   4, 12,  12,  4,   7, 12,  12,  7,   8,  4,   4,  8,   0,  4,
53    15, 13,  13, 15,   5, 13,  13,  5,   7, 13,  13,  7,   8,  5,   5,  8,
54     0,  5,  15, 14,  14, 15,   6, 14,  14,  6,   7, 14,  14,  7,   8,  6,
55     6,  8,   0,  6,   4,  6,   6,  4,  12, 14,  14, 12,   6,  2,   2,  6,
56    14, 10,  10, 14,   2,  3,   3,  2,  10, 11,  11, 10,   3,  1,   1,  3,
57    11,  9,   9, 11,   1,  5,   5,  1,   9, 13,  13,  9,   5,  4,   4,  5,
58    13, 12,  12, 13,   4, 14,   6, 12,  12,  6,  14,  4,   6, 10,   2, 14,
59    14,  2,  10,  6,   2, 11,   3, 10,  10,  3,  11,  2,   3,  9,   1, 11,
60    11,  1,   9,  3,   1, 13,   5,  9,   9,  5,  13,  1,   5, 12,   4, 13,
61    13,  4,  12,  5,   0,  7,   0, 15,  15,  8,   8, 15,  15,  1,   7,  1,
62     1,  6,   2,  5,   3,  4,   4,  3,   5,  2,   6,  1,   0,  0,   1,  1,
63     9,  6,  10,  5,  11,  4,  12,  3,  13,  2,  14,  1,   2,  2,   3,  3,
64     4,  4,   5,  5,   6,  6,   7,  7,  14,  9,   1, 15,   8,  9,   8,  8,
65     9,  9,   1,  7,   0,  9,   9,  8,   6,  9,  13, 10,   2, 15,   8, 10,
66     7,  2,  15,  2,   2,  7,   0, 10,  10,  8,   5, 10,  12, 11,   3, 15,
67     8, 11,   7,  3,  15,  3,   3,  7,   0, 11,  11,  8,   4, 11,  11, 12,
68     4, 15,   8, 12,   7,  4,  15,  4,   4,  7,   0, 12,  12,  8,   3, 12,
69    10, 13,   5, 15,   8, 13,   7,  5,  15,  5,   5,  7,   0, 13,  13,  8,
70     2, 13,   9, 14,   6, 15,   8, 14,   7,  6,  15,  6,   6,  7,   0, 14,
71    14,  8,   1, 14,   5,  6,   2,  4,  13, 14,  10, 12,   4,  2,   3,  6,
72    12, 10,  11, 14,   6,  3,   1,  2,  14, 11,   9, 10,   2,  1,   5,  3,
73    10,  9,  13, 11,   3,  5,   4,  1,  11, 13,  12,  9,   1,  4,   6,  5,
74     9, 12,  14, 13,   5, 14,   2, 12,  13,  6,  10,  4,   4, 10,   3, 14,
75    12,  2,  11,  6,   6, 11,   1, 10,  14,  3,   9,  2,   2,  9,   5, 11,
76    10,  1,  13,  3,   3, 13,   4,  9,  11,  5,  12,  1,   1, 12,   6, 13,
77     9,  4,  14,  5,  10, 10,  11, 11,  12, 12,  13, 13,  14, 14,  15, 15,
78};
79
80static int const slang_assoc[16*16] =
81{
82    134, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
83    28, 135, 214, 86, 219, 91, 133, 127, 26, 23, 240, 112, 245, 117, 141, 126,
84    37, 211, 142, 83, 206, 132, 78, 160, 35, 237, 32, 109, 232, 140, 104, 161,
85    46, 87, 82, 143, 131, 215, 210, 169, 44, 113, 108, 41, 139, 241, 236, 170,
86    55, 222, 203, 130, 144, 94, 75, 178, 53, 248, 229, 138, 50, 120, 101, 179,
87    64, 90, 129, 218, 95, 145, 223, 187, 62, 116, 137, 244, 121, 59, 249, 188,
88    73, 128, 79, 207, 74, 202, 146, 196, 71, 136, 105, 233, 100, 228, 68, 197,
89    122, 153, 162, 171, 180, 189, 198, 147, 16, 25, 34, 43, 52, 61, 70, 18,
90    15, 27, 36, 45, 54, 63, 72, 17, 151, 155, 164, 173, 182, 191, 200, 124,
91    154, 22, 238, 110, 243, 115, 156, 24, 150, 152, 216, 88, 221, 93, 148, 20,
92    163, 235, 31, 107, 230, 165, 102, 33, 159, 213, 250, 85, 208, 157, 80, 29,
93    172, 111, 106, 40, 174, 239, 234, 42, 168, 89, 84, 251, 166, 217, 212, 38,
94    181, 246, 227, 183, 49, 118, 99, 51, 177, 224, 205, 175, 252, 96, 77, 47,
95    190, 114, 192, 242, 119, 58, 247, 60, 186, 92, 184, 220, 97, 253, 225, 56,
96    199, 201, 103, 231, 98, 226, 67, 69, 195, 193, 81, 209, 76, 204, 254, 65,
97    123, 149, 158, 167, 176, 185, 194, 19, 125, 21, 30, 39, 48, 57, 66, 255,
98};
99
100/*
101 * Local functions
102 */
103static void slang_init_palette(void);
104static void slang_write_utf32(uint32_t);
105
106#if defined(HAVE_SIGNAL)
107static RETSIGTYPE sigwinch_handler(int);
108static caca_display_t *sigwinch_d; /* FIXME: we ought to get rid of this */
109#endif
110#if defined(HAVE_GETENV) && defined(HAVE_PUTENV)
111static void slang_install_terminal(caca_display_t *);
112static void slang_uninstall_terminal(caca_display_t *);
113#endif
114
115struct driver_private
116{
117    char *term;
118};
119
120static void default_sigint (int sig)
121{
122    /* Do nothing */
123    return;
124}
125
126static int slang_init_graphics(caca_display_t *dp)
127{
128    dp->drv.p = malloc(sizeof(struct driver_private));
129
130#if defined(HAVE_GETENV) && defined(HAVE_PUTENV)
131    slang_install_terminal(dp);
132#endif
133
134#if defined(HAVE_SIGNAL)
135    sigwinch_d = dp;
136    signal(SIGWINCH, sigwinch_handler);
137#endif
138
139    _caca_set_term_title("caca for S-Lang");
140
141    /* Initialise slang library */
142    SLsig_block_signals();
143    SLtt_get_terminfo();
144
145    if(SLkp_init() == -1)
146    {
147        SLsig_unblock_signals();
148        return -1;
149    }
150
151    SLang_init_tty(-1, 0, 1);
152
153    if(SLsmg_init_smg() == -1)
154    {
155        SLsig_unblock_signals();
156        return -1;
157    }
158
159    SLsig_unblock_signals();
160
161    SLsmg_cls();
162    SLtt_set_cursor_visibility(0);
163    SLkp_define_keysym("\e[M", 1001);
164    SLtt_set_mouse_mode(1, 0);
165    SLsmg_refresh();
166
167   
168    /* Disable SLang's own SIGINT on ctrl-c */
169    SLang_set_abort_signal (default_sigint);
170   
171    /* Disable scrolling so that hashmap scrolling optimization code
172     * does not cause ugly refreshes due to slow terminals */
173    SLtt_Term_Cannot_Scroll = 1;
174
175    slang_init_palette();
176
177#if defined(VMS) || defined(REAL_UNIX_SYSTEM)
178    /* Disable alt charset support so that we get a chance to have all
179     * 256 colour pairs */
180    SLtt_Has_Alt_Charset = 0;
181#endif
182
183#ifdef HAVE_SLSMG_UTF8_ENABLE
184    SLsmg_utf8_enable(1); /* 1 == force, 0 == disable, -1 == autodetect */
185    SLtt_utf8_enable(1);
186#endif
187
188    caca_add_dirty_rect(dp->cv, 0, 0, dp->cv->width, dp->cv->height);
189    dp->resize.allow = 1;
190    caca_set_canvas_size(dp->cv, SLtt_Screen_Cols, SLtt_Screen_Rows);
191    dp->resize.allow = 0;
192
193    return 0;
194}
195
196static int slang_end_graphics(caca_display_t *dp)
197{
198    _caca_set_term_title("");
199    SLtt_set_mouse_mode(0, 0);
200    SLtt_set_cursor_visibility(1);
201    SLang_reset_tty();
202    SLsmg_reset_smg();
203
204#if defined HAVE_GETENV && defined HAVE_PUTENV
205    slang_uninstall_terminal(dp);
206#endif
207
208    free(dp->drv.p);
209
210    return 0;
211}
212
213static int slang_set_display_title(caca_display_t *dp, char const *title)
214{
215    _caca_set_term_title(title);
216
217    return 0;
218}
219
220static int slang_get_display_width(caca_display_t const *dp)
221{
222    /* Fallback to a 6x10 font */
223    return caca_get_canvas_width(dp->cv) * 6;
224}
225
226static int slang_get_display_height(caca_display_t const *dp)
227{
228    /* Fallback to a 6x10 font */
229    return caca_get_canvas_height(dp->cv) * 10;
230}
231
232static void slang_display(caca_display_t *dp)
233{
234    int x, y, i;
235
236    for(i = 0; i < caca_get_dirty_rect_count(dp->cv); i++)
237    {
238        uint32_t const *cvchars, *cvattrs;
239        int dx, dy, dw, dh;
240
241        caca_get_dirty_rect(dp->cv, i, &dx, &dy, &dw, &dh);
242
243        cvchars = (uint32_t const *)caca_get_canvas_chars(dp->cv)
244                    + dx + dy * dp->cv->width;
245        cvattrs = (uint32_t const *)caca_get_canvas_attrs(dp->cv)
246                    + dx + dy * dp->cv->width;
247
248        for(y = dy; y < dy + dh; y++)
249        {
250            SLsmg_gotorc(y, dx);
251            for(x = dx; x < dx + dw; x++)
252            {
253                uint32_t ch = *cvchars++;
254
255#if defined(OPTIMISE_SLANG_PALETTE)
256                /* If foreground == background, just don't use this colour
257                 * pair, and print a space instead of the real character. */
258                /* XXX: disabled, because I can't remember what it was
259                 * here for, and in cases where SLang does not render
260                 * bright backgrounds, it's just fucked up. */
261#if 0
262                uint8_t fgcolor = caca_attr_to_ansi_fg(*cvattrs);
263                uint8_t bgcolor = caca_attr_to_ansi_bg(*cvattrs);
264
265                if(fgcolor >= 0x10)
266                    fgcolor = CACA_LIGHTGRAY;
267
268                if(bgcolor >= 0x10)
269                    bgcolor = CACA_BLACK; /* FIXME: handle transparency */
270
271                if(fgcolor == bgcolor)
272                {
273                    if(fgcolor == CACA_BLACK)
274                        fgcolor = CACA_WHITE;
275                    else if(fgcolor == CACA_WHITE
276                             || fgcolor <= CACA_LIGHTGRAY)
277                        fgcolor = CACA_BLACK;
278                    else
279                        fgcolor = CACA_WHITE;
280                    SLsmg_set_color(slang_assoc[fgcolor + 16 * bgcolor]);
281                    SLsmg_write_char(' ');
282                    cvattrs++;
283                }
284                else
285#endif
286                {
287                    SLsmg_set_color(slang_assoc[caca_attr_to_ansi(*cvattrs++)]);
288                    slang_write_utf32(ch);
289                }
290#else
291                SLsmg_set_color(caca_attr_to_ansi(*cvattrs++));
292                slang_write_utf32(ch);
293#endif
294            }
295
296            cvchars += dp->cv->width - dw;
297            cvattrs += dp->cv->width - dw;
298        }
299    }
300    SLsmg_gotorc(caca_wherey(dp->cv), caca_wherex(dp->cv));
301    SLsmg_refresh();
302}
303
304static void slang_handle_resize(caca_display_t *dp)
305{
306    SLtt_get_screen_size();
307    dp->resize.w = SLtt_Screen_Cols;
308    dp->resize.h = SLtt_Screen_Rows;
309
310    if(dp->resize.w != caca_get_canvas_width(dp->cv)
311        || dp->resize.h != caca_get_canvas_height(dp->cv))
312        SLsmg_reinit_smg();
313}
314
315static int slang_get_event(caca_display_t *dp, caca_privevent_t *ev)
316{
317    int intkey;
318
319    if(!SLang_input_pending(0))
320    {
321        ev->type = CACA_EVENT_NONE;
322        return 0;
323    }
324
325    /* We first use SLang_getkey() to see whether Esc was pressed
326     * alone, then (if it wasn't) we unget the key and use SLkp_getkey()
327     * instead, so that escape sequences are interpreted. */
328    intkey = SLang_getkey();
329
330    if(intkey != 0x1b /* Esc */ || SLang_input_pending(0))
331    {
332        SLang_ungetkey(intkey);
333        intkey = SLkp_getkey();
334    }
335
336    /* If the key was ASCII, return it immediately */
337    if(intkey < 0x7f)
338    {
339        ev->type = CACA_EVENT_KEY_PRESS;
340        ev->data.key.ch = intkey;
341        ev->data.key.utf32 = intkey;
342        ev->data.key.utf8[0] = intkey;
343        ev->data.key.utf8[1] = '\0';
344        return 1;
345    }
346
347    /* If the key was UTF-8, parse the whole sequence */
348    if(intkey >= 0x80 && intkey < 0x100)
349    {
350        int keys[7]; /* Necessary for ungetkey(); */
351        char utf8[7];
352        uint32_t utf32;
353        size_t i, bytes = 0;
354
355        keys[0] = intkey;
356        utf8[0] = intkey;
357
358        for(i = 1; i < 6; i++)
359        {
360            if(!SLang_input_pending(0))
361                break;
362            keys[i] = SLang_getkey();
363            utf8[i] = (unsigned char)keys[i];
364        }
365
366        utf8[i] = '\0';
367        utf32 = caca_utf8_to_utf32(utf8, &bytes);
368
369        while(i > bytes)
370            SLang_ungetkey(keys[--i]);
371
372        if(bytes)
373        {
374            ev->type = CACA_EVENT_KEY_PRESS;
375            ev->data.key.ch = 0;
376            ev->data.key.utf32 = utf32;
377            strcpy(ev->data.key.utf8, utf8);
378            return 1;
379        }
380    }
381
382    if(intkey == 0x3e9)
383    {
384        int button = (SLang_getkey() - ' ' + 1) & 0xf;
385        int x = SLang_getkey() - '!';
386        int y = SLang_getkey() - '!';
387
388        ev->data.mouse.button = button;
389        ev->type = CACA_EVENT_MOUSE_PRESS;
390        _push_event(dp, ev);
391        ev->type = CACA_EVENT_MOUSE_RELEASE;
392        _push_event(dp, ev);
393
394        if(dp->mouse.x == x && dp->mouse.y == y)
395            return _pop_event(dp, ev);
396
397        dp->mouse.x = x;
398        dp->mouse.y = y;
399
400        ev->type = CACA_EVENT_MOUSE_MOTION;
401        ev->data.mouse.x = dp->mouse.x;
402        ev->data.mouse.y = dp->mouse.y;
403        return 1;
404    }
405
406    switch(intkey)
407    {
408        case SL_KEY_UP: ev->data.key.ch = CACA_KEY_UP; break;
409        case SL_KEY_DOWN: ev->data.key.ch = CACA_KEY_DOWN; break;
410        case SL_KEY_LEFT: ev->data.key.ch = CACA_KEY_LEFT; break;
411        case SL_KEY_RIGHT: ev->data.key.ch = CACA_KEY_RIGHT; break;
412
413        case SL_KEY_IC: ev->data.key.ch = CACA_KEY_INSERT; break;
414        case SL_KEY_DELETE: ev->data.key.ch = CACA_KEY_DELETE; break;
415        case 0x7f:
416        case SL_KEY_BACKSPACE: ev->data.key.ch = CACA_KEY_BACKSPACE; break;
417        case SL_KEY_HOME: ev->data.key.ch = CACA_KEY_HOME; break;
418        case SL_KEY_END: ev->data.key.ch = CACA_KEY_END; break;
419        case SL_KEY_PPAGE: ev->data.key.ch = CACA_KEY_PAGEUP; break;
420        case SL_KEY_NPAGE: ev->data.key.ch = CACA_KEY_PAGEDOWN; break;
421
422        case SL_KEY_F(1): ev->data.key.ch = CACA_KEY_F1; break;
423        case SL_KEY_F(2): ev->data.key.ch = CACA_KEY_F2; break;
424        case SL_KEY_F(3): ev->data.key.ch = CACA_KEY_F3; break;
425        case SL_KEY_F(4): ev->data.key.ch = CACA_KEY_F4; break;
426        case SL_KEY_F(5): ev->data.key.ch = CACA_KEY_F5; break;
427        case SL_KEY_F(6): ev->data.key.ch = CACA_KEY_F6; break;
428        case SL_KEY_F(7): ev->data.key.ch = CACA_KEY_F7; break;
429        case SL_KEY_F(8): ev->data.key.ch = CACA_KEY_F8; break;
430        case SL_KEY_F(9): ev->data.key.ch = CACA_KEY_F9; break;
431        case SL_KEY_F(10): ev->data.key.ch = CACA_KEY_F10; break;
432        case SL_KEY_F(11): ev->data.key.ch = CACA_KEY_F11; break;
433        case SL_KEY_F(12): ev->data.key.ch = CACA_KEY_F12; break;
434
435        default:
436            /* Unknown key */
437            ev->type = CACA_EVENT_NONE; return 0;
438    }
439
440    ev->type = CACA_EVENT_KEY_PRESS;
441    ev->data.key.utf32 = 0;
442    ev->data.key.utf8[0] = '\0';
443    return 1;
444}
445
446static void slang_set_cursor(caca_display_t *dp, int flags)
447{
448    SLtt_set_cursor_visibility(flags ? 1 : 0);
449}
450
451/*
452 * XXX: following functions are local
453 */
454
455static void slang_init_palette(void)
456{
457    /* See SLang ref., 5.4.4. */
458    static char *slang_colors[16] =
459    {
460        /* Standard colours */
461        "black",
462        "blue",
463        "green",
464        "cyan",
465        "red",
466        "magenta",
467        "brown",
468        "lightgray",
469        /* Bright colours */
470        "gray",
471        "brightblue",
472        "brightgreen",
473        "brightcyan",
474        "brightred",
475        "brightmagenta",
476        "yellow",
477        "white",
478    };
479
480#if defined(OPTIMISE_SLANG_PALETTE)
481    int i;
482
483    for(i = 0; i < 16 * 16; i++)
484        SLtt_set_color(i, NULL, slang_colors[slang_palette[i * 2]],
485                                slang_colors[slang_palette[i * 2 + 1]]);
486#else
487    int fg, bg;
488
489    for(bg = 0; bg < 16; bg++)
490        for(fg = 0; fg < 16; fg++)
491        {
492            int i = fg + 16 * bg;
493            SLtt_set_color(i, NULL, slang_colors[fg], slang_colors[bg]);
494        }
495#endif
496}
497
498static void slang_write_utf32(uint32_t ch)
499{
500#ifdef HAVE_SLSMG_UTF8_ENABLE
501    char buf[10];
502    int bytes;
503#else
504    char ascii;
505#endif
506
507    if(ch == CACA_MAGIC_FULLWIDTH)
508        return;
509
510#ifdef HAVE_SLSMG_UTF8_ENABLE
511    bytes = caca_utf32_to_utf8(buf, ch);
512    buf[bytes] = '\0';
513    SLsmg_write_string(buf);
514#else
515    ascii = caca_utf32_to_ascii(ch);
516    SLsmg_write_char(ascii);
517    if(caca_utf32_is_fullwidth(ch))
518        SLsmg_write_char(ascii);
519#endif
520}
521
522#if defined(HAVE_SIGNAL)
523static RETSIGTYPE sigwinch_handler(int sig)
524{
525    sigwinch_d->resize.resized = 1;
526
527    signal(SIGWINCH, sigwinch_handler);
528}
529#endif
530
531#if defined(HAVE_GETENV) && defined(HAVE_PUTENV)
532static void slang_install_terminal(caca_display_t *dp)
533{
534    char *term, *colorterm;
535
536    dp->drv.p->term = NULL;
537
538    term = getenv("TERM");
539    colorterm = getenv("COLORTERM");
540
541    if(!term || strcmp(term, "xterm"))
542        return;
543
544    /* If we are using gnome-terminal, it's really a 16 colour terminal.
545     * Ditto if we are using xfce4-terminal, or Konsole. */
546    if((colorterm && (!strcmp(colorterm, "gnome-terminal")
547                       || !strcmp(colorterm, "Terminal")))
548         || getenv("KONSOLE_DCOP_SESSION"))
549    {
550        (void)putenv("TERM=xterm-16color");
551        dp->drv.p->term = strdup(term);
552        return;
553    }
554}
555
556static void slang_uninstall_terminal(caca_display_t *dp)
557{
558    /* Needs to be persistent because we use putenv() */
559    static char termenv[1024];
560
561    if(!dp->drv.p->term)
562        return;
563
564    snprintf(termenv, 1023, "TERM=%s", dp->drv.p->term);
565    free(dp->drv.p->term);
566    (void)putenv(termenv);
567}
568#endif
569
570/*
571 * Driver initialisation
572 */
573
574int slang_install(caca_display_t *dp)
575{
576    dp->drv.id = CACA_DRIVER_SLANG;
577    dp->drv.driver = "slang";
578
579    dp->drv.init_graphics = slang_init_graphics;
580    dp->drv.end_graphics = slang_end_graphics;
581    dp->drv.set_display_title = slang_set_display_title;
582    dp->drv.get_display_width = slang_get_display_width;
583    dp->drv.get_display_height = slang_get_display_height;
584    dp->drv.display = slang_display;
585    dp->drv.handle_resize = slang_handle_resize;
586    dp->drv.get_event = slang_get_event;
587    dp->drv.set_mouse = NULL;
588    dp->drv.set_cursor = slang_set_cursor;
589
590    return 0;
591}
592
593#endif /* USE_SLANG */
594
Note: See TracBrowser for help on using the repository browser.