source: libcaca/trunk/caca/driver_slang.c @ 2142

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