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

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