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

Last change on this file since 3985 was 3985, checked in by Jean-Yves Lamoureux, 13 years ago
  • Remove trailing spaces (bouh!)
  • 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 3985 2009-11-21 10:26:31Z 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    /* Disable SLang's own SIGINT on ctrl-c */
144    SLang_set_abort_signal(default_sigint);
145
146    SLtt_get_terminfo();
147
148    if(SLkp_init() == -1)
149    {
150        SLsig_unblock_signals();
151        return -1;
152    }
153
154    SLang_init_tty(-1, 0, 1);
155
156    if(SLsmg_init_smg() == -1)
157    {
158        SLsig_unblock_signals();
159        return -1;
160    }
161
162    SLsmg_cls();
163    SLtt_set_cursor_visibility(0);
164    SLkp_define_keysym("\e[M", 1001);
165    SLtt_set_mouse_mode(1, 0);
166    SLsmg_refresh();
167
168    /* Disable scrolling so that hashmap scrolling optimization code
169     * does not cause ugly refreshes due to slow terminals */
170    SLtt_Term_Cannot_Scroll = 1;
171
172    slang_init_palette();
173
174#if defined(VMS) || defined(REAL_UNIX_SYSTEM)
175    /* Disable alt charset support so that we get a chance to have all
176     * 256 colour pairs */
177    SLtt_Has_Alt_Charset = 0;
178#endif
179
180#ifdef HAVE_SLSMG_UTF8_ENABLE
181    SLsmg_utf8_enable(1); /* 1 == force, 0 == disable, -1 == autodetect */
182    SLtt_utf8_enable(1);
183#endif
184
185    caca_add_dirty_rect(dp->cv, 0, 0, dp->cv->width, dp->cv->height);
186    dp->resize.allow = 1;
187    caca_set_canvas_size(dp->cv, SLtt_Screen_Cols, SLtt_Screen_Rows);
188    dp->resize.allow = 0;
189
190    return 0;
191}
192
193static int slang_end_graphics(caca_display_t *dp)
194{
195    _caca_set_term_title("");
196    SLtt_set_mouse_mode(0, 0);
197    SLtt_set_cursor_visibility(1);
198    SLang_reset_tty();
199    SLsmg_reset_smg();
200    SLsig_unblock_signals();
201
202#if defined HAVE_GETENV && defined HAVE_PUTENV
203    slang_uninstall_terminal(dp);
204#endif
205
206    free(dp->drv.p);
207
208    return 0;
209}
210
211static int slang_set_display_title(caca_display_t *dp, char const *title)
212{
213    _caca_set_term_title(title);
214
215    return 0;
216}
217
218static int slang_get_display_width(caca_display_t const *dp)
219{
220    /* Fallback to a 6x10 font */
221    return caca_get_canvas_width(dp->cv) * 6;
222}
223
224static int slang_get_display_height(caca_display_t const *dp)
225{
226    /* Fallback to a 6x10 font */
227    return caca_get_canvas_height(dp->cv) * 10;
228}
229
230static void slang_display(caca_display_t *dp)
231{
232    int x, y, i;
233
234    for(i = 0; i < caca_get_dirty_rect_count(dp->cv); i++)
235    {
236        uint32_t const *cvchars, *cvattrs;
237        int dx, dy, dw, dh;
238
239        caca_get_dirty_rect(dp->cv, i, &dx, &dy, &dw, &dh);
240
241        cvchars = (uint32_t const *)caca_get_canvas_chars(dp->cv)
242                    + dx + dy * dp->cv->width;
243        cvattrs = (uint32_t const *)caca_get_canvas_attrs(dp->cv)
244                    + dx + dy * dp->cv->width;
245
246        for(y = dy; y < dy + dh; y++)
247        {
248            SLsmg_gotorc(y, dx);
249            for(x = dx; x < dx + dw; x++)
250            {
251                uint32_t ch = *cvchars++;
252
253#if defined(OPTIMISE_SLANG_PALETTE)
254                /* If foreground == background, just don't use this colour
255                 * pair, and print a space instead of the real character. */
256                /* XXX: disabled, because I can't remember what it was
257                 * here for, and in cases where SLang does not render
258                 * bright backgrounds, it's just fucked up. */
259#if 0
260                uint8_t fgcolor = caca_attr_to_ansi_fg(*cvattrs);
261                uint8_t bgcolor = caca_attr_to_ansi_bg(*cvattrs);
262
263                if(fgcolor >= 0x10)
264                    fgcolor = CACA_LIGHTGRAY;
265
266                if(bgcolor >= 0x10)
267                    bgcolor = CACA_BLACK; /* FIXME: handle transparency */
268
269                if(fgcolor == bgcolor)
270                {
271                    if(fgcolor == CACA_BLACK)
272                        fgcolor = CACA_WHITE;
273                    else if(fgcolor == CACA_WHITE
274                             || fgcolor <= CACA_LIGHTGRAY)
275                        fgcolor = CACA_BLACK;
276                    else
277                        fgcolor = CACA_WHITE;
278                    SLsmg_set_color(slang_assoc[fgcolor + 16 * bgcolor]);
279                    SLsmg_write_char(' ');
280                    cvattrs++;
281                }
282                else
283#endif
284                {
285                    SLsmg_set_color(slang_assoc[caca_attr_to_ansi(*cvattrs++)]);
286                    slang_write_utf32(ch);
287                }
288#else
289                SLsmg_set_color(caca_attr_to_ansi(*cvattrs++));
290                slang_write_utf32(ch);
291#endif
292            }
293
294            cvchars += dp->cv->width - dw;
295            cvattrs += dp->cv->width - dw;
296        }
297    }
298    SLsmg_gotorc(caca_wherey(dp->cv), caca_wherex(dp->cv));
299    SLsmg_refresh();
300}
301
302static void slang_handle_resize(caca_display_t *dp)
303{
304    SLtt_get_screen_size();
305    dp->resize.w = SLtt_Screen_Cols;
306    dp->resize.h = SLtt_Screen_Rows;
307
308    if(dp->resize.w != caca_get_canvas_width(dp->cv)
309        || dp->resize.h != caca_get_canvas_height(dp->cv))
310        SLsmg_reinit_smg();
311}
312
313static int slang_get_event(caca_display_t *dp, caca_privevent_t *ev)
314{
315    int intkey;
316
317    if(!SLang_input_pending(0))
318    {
319        ev->type = CACA_EVENT_NONE;
320        return 0;
321    }
322
323    /* We first use SLang_getkey() to see whether Esc was pressed
324     * alone, then (if it wasn't) we unget the key and use SLkp_getkey()
325     * instead, so that escape sequences are interpreted. */
326    intkey = SLang_getkey();
327
328    if(intkey != 0x1b /* Esc */ || SLang_input_pending(0))
329    {
330        SLang_ungetkey(intkey);
331        intkey = SLkp_getkey();
332    }
333
334    /* If the key was ASCII, return it immediately */
335    if(intkey < 0x7f)
336    {
337        ev->type = CACA_EVENT_KEY_PRESS;
338        ev->data.key.ch = intkey;
339        ev->data.key.utf32 = intkey;
340        ev->data.key.utf8[0] = intkey;
341        ev->data.key.utf8[1] = '\0';
342        return 1;
343    }
344
345    /* If the key was UTF-8, parse the whole sequence */
346    if(intkey >= 0x80 && intkey < 0x100)
347    {
348        int keys[7]; /* Necessary for ungetkey(); */
349        char utf8[7];
350        uint32_t utf32;
351        size_t i, bytes = 0;
352
353        keys[0] = intkey;
354        utf8[0] = intkey;
355
356        for(i = 1; i < 6; i++)
357        {
358            if(!SLang_input_pending(0))
359                break;
360            keys[i] = SLang_getkey();
361            utf8[i] = (unsigned char)keys[i];
362        }
363
364        utf8[i] = '\0';
365        utf32 = caca_utf8_to_utf32(utf8, &bytes);
366
367        while(i > bytes)
368            SLang_ungetkey(keys[--i]);
369
370        if(bytes)
371        {
372            ev->type = CACA_EVENT_KEY_PRESS;
373            ev->data.key.ch = 0;
374            ev->data.key.utf32 = utf32;
375            strcpy(ev->data.key.utf8, utf8);
376            return 1;
377        }
378    }
379
380    if(intkey == 0x3e9)
381    {
382        int button = (SLang_getkey() - ' ' + 1) & 0xf;
383        int x = SLang_getkey() - '!';
384        int y = SLang_getkey() - '!';
385
386        ev->data.mouse.button = button;
387        ev->type = CACA_EVENT_MOUSE_PRESS;
388        _push_event(dp, ev);
389        ev->type = CACA_EVENT_MOUSE_RELEASE;
390        _push_event(dp, ev);
391
392        if(dp->mouse.x == x && dp->mouse.y == y)
393            return _pop_event(dp, ev);
394
395        dp->mouse.x = x;
396        dp->mouse.y = y;
397
398        ev->type = CACA_EVENT_MOUSE_MOTION;
399        ev->data.mouse.x = dp->mouse.x;
400        ev->data.mouse.y = dp->mouse.y;
401        return 1;
402    }
403
404    switch(intkey)
405    {
406        case SL_KEY_UP: ev->data.key.ch = CACA_KEY_UP; break;
407        case SL_KEY_DOWN: ev->data.key.ch = CACA_KEY_DOWN; break;
408        case SL_KEY_LEFT: ev->data.key.ch = CACA_KEY_LEFT; break;
409        case SL_KEY_RIGHT: ev->data.key.ch = CACA_KEY_RIGHT; break;
410
411        case SL_KEY_IC: ev->data.key.ch = CACA_KEY_INSERT; break;
412        case SL_KEY_DELETE: ev->data.key.ch = CACA_KEY_DELETE; break;
413        case 0x7f:
414        case SL_KEY_BACKSPACE: ev->data.key.ch = CACA_KEY_BACKSPACE; break;
415        case SL_KEY_HOME: ev->data.key.ch = CACA_KEY_HOME; break;
416        case SL_KEY_END: ev->data.key.ch = CACA_KEY_END; break;
417        case SL_KEY_PPAGE: ev->data.key.ch = CACA_KEY_PAGEUP; break;
418        case SL_KEY_NPAGE: ev->data.key.ch = CACA_KEY_PAGEDOWN; break;
419
420        case SL_KEY_F(1): ev->data.key.ch = CACA_KEY_F1; break;
421        case SL_KEY_F(2): ev->data.key.ch = CACA_KEY_F2; break;
422        case SL_KEY_F(3): ev->data.key.ch = CACA_KEY_F3; break;
423        case SL_KEY_F(4): ev->data.key.ch = CACA_KEY_F4; break;
424        case SL_KEY_F(5): ev->data.key.ch = CACA_KEY_F5; break;
425        case SL_KEY_F(6): ev->data.key.ch = CACA_KEY_F6; break;
426        case SL_KEY_F(7): ev->data.key.ch = CACA_KEY_F7; break;
427        case SL_KEY_F(8): ev->data.key.ch = CACA_KEY_F8; break;
428        case SL_KEY_F(9): ev->data.key.ch = CACA_KEY_F9; break;
429        case SL_KEY_F(10): ev->data.key.ch = CACA_KEY_F10; break;
430        case SL_KEY_F(11): ev->data.key.ch = CACA_KEY_F11; break;
431        case SL_KEY_F(12): ev->data.key.ch = CACA_KEY_F12; break;
432
433        default:
434            /* Unknown key */
435            ev->type = CACA_EVENT_NONE; return 0;
436    }
437
438    ev->type = CACA_EVENT_KEY_PRESS;
439    ev->data.key.utf32 = 0;
440    ev->data.key.utf8[0] = '\0';
441    return 1;
442}
443
444static void slang_set_cursor(caca_display_t *dp, int flags)
445{
446    SLtt_set_cursor_visibility(flags ? 1 : 0);
447}
448
449/*
450 * XXX: following functions are local
451 */
452
453static void slang_init_palette(void)
454{
455    /* See SLang ref., 5.4.4. */
456    static char *slang_colors[16] =
457    {
458        /* Standard colours */
459        "black",
460        "blue",
461        "green",
462        "cyan",
463        "red",
464        "magenta",
465        "brown",
466        "lightgray",
467        /* Bright colours */
468        "gray",
469        "brightblue",
470        "brightgreen",
471        "brightcyan",
472        "brightred",
473        "brightmagenta",
474        "yellow",
475        "white",
476    };
477
478#if defined(OPTIMISE_SLANG_PALETTE)
479    int i;
480
481    for(i = 0; i < 16 * 16; i++)
482        SLtt_set_color(i, NULL, slang_colors[slang_palette[i * 2]],
483                                slang_colors[slang_palette[i * 2 + 1]]);
484#else
485    int fg, bg;
486
487    for(bg = 0; bg < 16; bg++)
488        for(fg = 0; fg < 16; fg++)
489        {
490            int i = fg + 16 * bg;
491            SLtt_set_color(i, NULL, slang_colors[fg], slang_colors[bg]);
492        }
493#endif
494}
495
496static void slang_write_utf32(uint32_t ch)
497{
498#ifdef HAVE_SLSMG_UTF8_ENABLE
499    char buf[10];
500    int bytes;
501#else
502    char ascii;
503#endif
504
505    if(ch == CACA_MAGIC_FULLWIDTH)
506        return;
507
508#ifdef HAVE_SLSMG_UTF8_ENABLE
509    bytes = caca_utf32_to_utf8(buf, ch);
510    buf[bytes] = '\0';
511    SLsmg_write_string(buf);
512#else
513    ascii = caca_utf32_to_ascii(ch);
514    SLsmg_write_char(ascii);
515    if(caca_utf32_is_fullwidth(ch))
516        SLsmg_write_char(ascii);
517#endif
518}
519
520#if defined(HAVE_SIGNAL)
521static RETSIGTYPE sigwinch_handler(int sig)
522{
523    sigwinch_d->resize.resized = 1;
524
525    signal(SIGWINCH, sigwinch_handler);
526}
527#endif
528
529#if defined(HAVE_GETENV) && defined(HAVE_PUTENV)
530static void slang_install_terminal(caca_display_t *dp)
531{
532    char *term, *colorterm;
533
534    dp->drv.p->term = NULL;
535
536    term = getenv("TERM");
537    colorterm = getenv("COLORTERM");
538
539    if(!term || strcmp(term, "xterm"))
540        return;
541
542    /* If we are using gnome-terminal, it's really a 16 colour terminal.
543     * Ditto if we are using xfce4-terminal, or Konsole. */
544    if((colorterm && (!strcmp(colorterm, "gnome-terminal")
545                       || !strcmp(colorterm, "Terminal")))
546         || getenv("KONSOLE_DCOP_SESSION"))
547    {
548        (void)putenv("TERM=xterm-16color");
549        dp->drv.p->term = strdup(term);
550        return;
551    }
552}
553
554static void slang_uninstall_terminal(caca_display_t *dp)
555{
556    /* Needs to be persistent because we use putenv() */
557    static char termenv[1024];
558
559    if(!dp->drv.p->term)
560        return;
561
562    snprintf(termenv, 1023, "TERM=%s", dp->drv.p->term);
563    free(dp->drv.p->term);
564    (void)putenv(termenv);
565}
566#endif
567
568/*
569 * Driver initialisation
570 */
571
572int slang_install(caca_display_t *dp)
573{
574    dp->drv.id = CACA_DRIVER_SLANG;
575    dp->drv.driver = "slang";
576
577    dp->drv.init_graphics = slang_init_graphics;
578    dp->drv.end_graphics = slang_end_graphics;
579    dp->drv.set_display_title = slang_set_display_title;
580    dp->drv.get_display_width = slang_get_display_width;
581    dp->drv.get_display_height = slang_get_display_height;
582    dp->drv.display = slang_display;
583    dp->drv.handle_resize = slang_handle_resize;
584    dp->drv.get_event = slang_get_event;
585    dp->drv.set_mouse = NULL;
586    dp->drv.set_cursor = slang_set_cursor;
587
588    return 0;
589}
590
591#endif /* USE_SLANG */
592
Note: See TracBrowser for help on using the repository browser.