source: libcaca/trunk/caca/driver_x11.c @ 724

Last change on this file since 724 was 724, checked in by Sam Hocevar, 15 years ago
  • Store colour information on 32 bits, for future 12-bit colour support.
  • Property svn:keywords set to Id
File size: 19.6 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 *  This library is free software; you can redistribute it and/or
7 *  modify it under the terms of the Do What The Fuck You Want To
8 *  Public License, Version 2, as published by Sam Hocevar. See
9 *  http://sam.zoy.org/wtfpl/COPYING for more details.
10 */
11
12/** \file driver_x11.c
13 *  \version \$Id: driver_x11.c 724 2006-04-06 13:41:56Z sam $
14 *  \author Sam Hocevar <sam@zoy.org>
15 *  \brief X11 driver
16 *
17 *  This file contains the libcaca X11 input and output driver
18 */
19
20#include "config.h"
21
22#if defined(USE_X11)
23
24#include <X11/Xlib.h>
25#include <X11/Xutil.h>
26#include <X11/keysym.h>
27#if defined(HAVE_X11_XKBLIB_H)
28#   include <X11/XKBlib.h>
29#endif
30
31#include <stdio.h> /* BUFSIZ */
32#include <stdlib.h>
33
34#include "caca.h"
35#include "caca_internals.h"
36#include "cucul.h"
37#include "cucul_internals.h"
38
39/*
40 * Local functions
41 */
42static int x11_error_handler(Display *, XErrorEvent *);
43
44struct driver_private
45{
46    Display *dpy;
47    Window window;
48    Pixmap pixmap;
49    GC gc;
50    long int event_mask;
51    int font_width, font_height;
52    int colors[16];
53    Font font;
54    XFontStruct *font_struct;
55    int font_offset;
56    Cursor pointer;
57#if defined(HAVE_X11_XKBLIB_H)
58    Bool autorepeat;
59#endif
60};
61
62static int x11_init_graphics(caca_t *kk)
63{
64    static int const x11_palette[] =
65    {
66        /* Standard curses colours */
67        0x0,    0x0,    0x0,
68        0x0,    0x0,    0x8000,
69        0x0,    0x8000, 0x0,
70        0x0,    0x8000, 0x8000,
71        0x8000, 0x0,    0x0,
72        0x8000, 0x0,    0x8000,
73        0x8000, 0x8000, 0x0,
74        0x8000, 0x8000, 0x8000,
75        /* Extra values for xterm-16color */
76        0x4000, 0x4000, 0x4000,
77        0x4000, 0x4000, 0xffff,
78        0x4000, 0xffff, 0x4000,
79        0x4000, 0xffff, 0xffff,
80        0xffff, 0x4000, 0x4000,
81        0xffff, 0x4000, 0xffff,
82        0xffff, 0xffff, 0x4000,
83        0xffff, 0xffff, 0xffff,
84    };
85
86    Colormap colormap;
87    XSetWindowAttributes x11_winattr;
88    int (*old_error_handler)(Display *, XErrorEvent *);
89    char const *fonts[] = { NULL, "8x13bold", "fixed" }, **parser;
90    char const *geometry;
91    unsigned int width = 0, height = 0;
92    int i;
93
94    kk->drv.p = malloc(sizeof(struct driver_private));
95
96#if defined(HAVE_GETENV)
97    geometry = getenv("CACA_GEOMETRY");
98    if(geometry && *geometry)
99        sscanf(geometry, "%ux%u", &width, &height);
100#endif
101
102    if(width && height)
103        _cucul_set_size(kk->qq, width, height);
104
105    kk->drv.p->dpy = XOpenDisplay(NULL);
106    if(kk->drv.p->dpy == NULL)
107        return -1;
108
109#if defined(HAVE_GETENV)
110    fonts[0] = getenv("CACA_FONT");
111    if(fonts[0] && *fonts[0])
112        parser = fonts;
113    else
114#endif
115        parser = fonts + 1;
116
117    /* Ignore font errors */
118    old_error_handler = XSetErrorHandler(x11_error_handler);
119
120    /* Parse our font list */
121    for( ; ; parser++)
122    {
123        if(!*parser)
124        {
125            XSetErrorHandler(old_error_handler);
126            XCloseDisplay(kk->drv.p->dpy);
127            return -1;
128        }
129
130        kk->drv.p->font = XLoadFont(kk->drv.p->dpy, *parser);
131        if(!kk->drv.p->font)
132            continue;
133
134        kk->drv.p->font_struct = XQueryFont(kk->drv.p->dpy, kk->drv.p->font);
135        if(!kk->drv.p->font_struct)
136        {
137            XUnloadFont(kk->drv.p->dpy, kk->drv.p->font);
138            continue;
139        }
140
141        break;
142    }
143
144    /* Reset the default X11 error handler */
145    XSetErrorHandler(old_error_handler);
146
147    kk->drv.p->font_width = kk->drv.p->font_struct->max_bounds.width;
148    kk->drv.p->font_height = kk->drv.p->font_struct->max_bounds.ascent
149                         + kk->drv.p->font_struct->max_bounds.descent;
150    kk->drv.p->font_offset = kk->drv.p->font_struct->max_bounds.descent;
151
152    colormap = DefaultColormap(kk->drv.p->dpy, DefaultScreen(kk->drv.p->dpy));
153    for(i = 0; i < 16; i++)
154    {
155        XColor color;
156        color.red = x11_palette[i * 3];
157        color.green = x11_palette[i * 3 + 1];
158        color.blue = x11_palette[i * 3 + 2];
159        XAllocColor(kk->drv.p->dpy, colormap, &color);
160        kk->drv.p->colors[i] = color.pixel;
161    }
162
163    x11_winattr.backing_store = Always;
164    x11_winattr.background_pixel = kk->drv.p->colors[0];
165    x11_winattr.event_mask = ExposureMask | StructureNotifyMask;
166
167    kk->drv.p->window =
168        XCreateWindow(kk->drv.p->dpy, DefaultRootWindow(kk->drv.p->dpy), 0, 0,
169                      kk->qq->width * kk->drv.p->font_width,
170                      kk->qq->height * kk->drv.p->font_height,
171                      0, 0, InputOutput, 0,
172                      CWBackingStore | CWBackPixel | CWEventMask,
173                      &x11_winattr);
174
175    XStoreName(kk->drv.p->dpy, kk->drv.p->window, "caca for X");
176
177    XSelectInput(kk->drv.p->dpy, kk->drv.p->window, StructureNotifyMask);
178    XMapWindow(kk->drv.p->dpy, kk->drv.p->window);
179
180    kk->drv.p->gc = XCreateGC(kk->drv.p->dpy, kk->drv.p->window, 0, NULL);
181    XSetForeground(kk->drv.p->dpy, kk->drv.p->gc, kk->drv.p->colors[15]);
182    XSetFont(kk->drv.p->dpy, kk->drv.p->gc, kk->drv.p->font);
183
184    for(;;)
185    {
186        XEvent xevent;
187        XNextEvent(kk->drv.p->dpy, &xevent);
188        if (xevent.type == MapNotify)
189            break;
190    }
191
192#if defined(HAVE_X11_XKBLIB_H)
193    /* Disable autorepeat */
194    XkbSetDetectableAutoRepeat(kk->drv.p->dpy, True, &kk->drv.p->autorepeat);
195    if(!kk->drv.p->autorepeat)
196        XAutoRepeatOff(kk->drv.p->dpy);
197#endif
198
199    kk->drv.p->event_mask = KeyPressMask | KeyReleaseMask | ButtonPressMask
200          | ButtonReleaseMask | PointerMotionMask | StructureNotifyMask
201          | ExposureMask;
202
203    XSelectInput(kk->drv.p->dpy, kk->drv.p->window, kk->drv.p->event_mask);
204
205    XSync(kk->drv.p->dpy, False);
206
207    kk->drv.p->pixmap = XCreatePixmap(kk->drv.p->dpy, kk->drv.p->window,
208                                   kk->qq->width * kk->drv.p->font_width,
209                                   kk->qq->height * kk->drv.p->font_height,
210                                   DefaultDepth(kk->drv.p->dpy,
211                                            DefaultScreen(kk->drv.p->dpy)));
212    kk->drv.p->pointer = None;
213
214    return 0;
215}
216
217static int x11_end_graphics(caca_t *kk)
218{
219    XSync(kk->drv.p->dpy, False);
220#if defined(HAVE_X11_XKBLIB_H)
221    if(!kk->drv.p->autorepeat)
222        XAutoRepeatOn(kk->drv.p->dpy);
223#endif
224    XFreePixmap(kk->drv.p->dpy, kk->drv.p->pixmap);
225    XFreeFont(kk->drv.p->dpy, kk->drv.p->font_struct);
226    XFreeGC(kk->drv.p->dpy, kk->drv.p->gc);
227    XUnmapWindow(kk->drv.p->dpy, kk->drv.p->window);
228    XDestroyWindow(kk->drv.p->dpy, kk->drv.p->window);
229    XCloseDisplay(kk->drv.p->dpy);
230
231    free(kk->drv.p);
232
233    return 0;
234}
235
236static int x11_set_window_title(caca_t *kk, char const *title)
237{
238    XStoreName(kk->drv.p->dpy, kk->drv.p->window, title);
239    return 0;
240}
241
242static unsigned int x11_get_window_width(caca_t *kk)
243{
244    return kk->qq->width * kk->drv.p->font_width;
245}
246
247static unsigned int x11_get_window_height(caca_t *kk)
248{
249    return kk->qq->height * kk->drv.p->font_height;
250}
251
252static void x11_display(caca_t *kk)
253{
254    unsigned int x, y, len;
255
256    /* First draw the background colours. Splitting the process in two
257     * loops like this is actually slightly faster. */
258    for(y = 0; y < kk->qq->height; y++)
259    {
260        for(x = 0; x < kk->qq->width; x += len)
261        {
262            uint32_t *attr = kk->qq->attr + x + y * kk->qq->width;
263            uint8_t bg = _cucul_rgba32_to_ansi4bg(*attr);
264
265            len = 1;
266            while(x + len < kk->qq->width
267                   && _cucul_rgba32_to_ansi4bg(attr[len]) == bg)
268                len++;
269
270            XSetForeground(kk->drv.p->dpy, kk->drv.p->gc,
271                           kk->drv.p->colors[_cucul_rgba32_to_ansi4bg(*attr)]);
272            XFillRectangle(kk->drv.p->dpy, kk->drv.p->pixmap, kk->drv.p->gc,
273                           x * kk->drv.p->font_width, y * kk->drv.p->font_height,
274                           len * kk->drv.p->font_width, kk->drv.p->font_height);
275        }
276    }
277
278    /* Then print the foreground characters */
279    for(y = 0; y < kk->qq->height; y++)
280    {
281        unsigned int yoff = (y + 1) * kk->drv.p->font_height
282                                    - kk->drv.p->font_offset;
283        uint32_t *chars = kk->qq->chars + y * kk->qq->width;
284
285        for(x = 0; x < kk->qq->width; x++, chars++)
286        {
287            uint32_t *attr = kk->qq->attr + x + y * kk->qq->width;
288
289            /* Skip spaces */
290            if(*chars == 0x00000020)
291                continue;
292
293            XSetForeground(kk->drv.p->dpy, kk->drv.p->gc,
294                           kk->drv.p->colors[_cucul_rgba32_to_ansi4fg(*attr)]);
295
296            /* Plain ASCII, no problem. */
297            if(*chars > 0x00000020 && *chars < 0x00000080)
298            {
299                char c = (uint8_t)*chars;
300                XDrawString(kk->drv.p->dpy, kk->drv.p->pixmap, kk->drv.p->gc,
301                            x * kk->drv.p->font_width, yoff, &c, 1);
302                continue;
303            }
304
305            /* We want to be able to print a few special Unicode characters
306             * such as the CP437 gradients and half blocks. For unknown
307             * characters, just print '?'. */
308            switch(*chars)
309            {
310                case 0x00002580: /* ▀ */
311                    XFillRectangle(kk->drv.p->dpy, kk->drv.p->pixmap,
312                                   kk->drv.p->gc,
313                                   x * kk->drv.p->font_width,
314                                   y * kk->drv.p->font_height,
315                                   kk->drv.p->font_width,
316                                   kk->drv.p->font_height / 2);
317                    break;
318                case 0x00002584: /* ▄ */
319                    XFillRectangle(kk->drv.p->dpy, kk->drv.p->pixmap,
320                                   kk->drv.p->gc,
321                                   x * kk->drv.p->font_width,
322                                   (y + 1) * kk->drv.p->font_height
323                                           - kk->drv.p->font_height / 2,
324                                   kk->drv.p->font_width,
325                                   kk->drv.p->font_height / 2);
326                    break;
327                case 0x00002588: /* █ */
328                    XFillRectangle(kk->drv.p->dpy, kk->drv.p->pixmap,
329                                   kk->drv.p->gc,
330                                   x * kk->drv.p->font_width,
331                                   y * kk->drv.p->font_height,
332                                   kk->drv.p->font_width,
333                                   kk->drv.p->font_height);
334                    break;
335                case 0x0000258c: /* ▌ */
336                    XFillRectangle(kk->drv.p->dpy, kk->drv.p->pixmap,
337                                   kk->drv.p->gc,
338                                   x * kk->drv.p->font_width,
339                                   y * kk->drv.p->font_height,
340                                   kk->drv.p->font_width / 2,
341                                   kk->drv.p->font_height);
342                    break;
343                case 0x00002590: /* ▐ */
344                    XFillRectangle(kk->drv.p->dpy, kk->drv.p->pixmap,
345                                   kk->drv.p->gc,
346                                   (x + 1) * kk->drv.p->font_width
347                                           - kk->drv.p->font_width / 2,
348                                   y * kk->drv.p->font_height,
349                                   kk->drv.p->font_width / 2,
350                                   kk->drv.p->font_height);
351                    break;
352                case 0x00002593: /* ▓ */
353                case 0x00002592: /* ▒ */
354                case 0x00002591: /* ░ */
355                {
356                    /* FIXME: this sucks utterly */
357                    int i, j, k = *chars - 0x00002591;
358                    for(j = kk->drv.p->font_height; j--; )
359                        for(i = kk->drv.p->font_width; i--; )
360                    {
361                        if(((i + 2 * (j & 1)) & 3) > k)
362                            continue;
363
364                        XDrawPoint(kk->drv.p->dpy, kk->drv.p->pixmap,
365                                   kk->drv.p->gc,
366                                   x * kk->drv.p->font_width + i,
367                                   y * kk->drv.p->font_height + j);
368                    }
369                    break;
370                }
371                default:
372                {
373                    char c;
374                    c = '?';
375                    XDrawString(kk->drv.p->dpy, kk->drv.p->pixmap,
376                                kk->drv.p->gc,
377                                x * kk->drv.p->font_width, yoff, &c, 1);
378                    break;
379                }
380            }
381        }
382    }
383
384    XCopyArea(kk->drv.p->dpy, kk->drv.p->pixmap, kk->drv.p->window,
385              kk->drv.p->gc, 0, 0,
386              kk->qq->width * kk->drv.p->font_width,
387              kk->qq->height * kk->drv.p->font_height,
388              0, 0);
389    XFlush(kk->drv.p->dpy);
390}
391
392static void x11_handle_resize(caca_t *kk)
393{
394    Pixmap new_pixmap;
395
396    new_pixmap = XCreatePixmap(kk->drv.p->dpy, kk->drv.p->window,
397                               kk->resize.w * kk->drv.p->font_width,
398                               kk->resize.h * kk->drv.p->font_height,
399                               DefaultDepth(kk->drv.p->dpy,
400                                            DefaultScreen(kk->drv.p->dpy)));
401    XCopyArea(kk->drv.p->dpy, kk->drv.p->pixmap, new_pixmap,
402              kk->drv.p->gc, 0, 0,
403              kk->resize.w * kk->drv.p->font_width,
404              kk->resize.h * kk->drv.p->font_height, 0, 0);
405    XFreePixmap(kk->drv.p->dpy, kk->drv.p->pixmap);
406    kk->drv.p->pixmap = new_pixmap;
407}
408
409static int x11_get_event(caca_t *kk, struct caca_event *ev)
410{
411    XEvent xevent;
412    char key;
413
414    while(XCheckWindowEvent(kk->drv.p->dpy, kk->drv.p->window,
415                            kk->drv.p->event_mask, &xevent) == True)
416    {
417        KeySym keysym;
418
419        /* Expose event */
420        if(xevent.type == Expose)
421        {
422            XCopyArea(kk->drv.p->dpy, kk->drv.p->pixmap,
423                      kk->drv.p->window, kk->drv.p->gc, 0, 0,
424                      kk->qq->width * kk->drv.p->font_width,
425                      kk->qq->height * kk->drv.p->font_height, 0, 0);
426            continue;
427        }
428
429        /* Resize event */
430        if(xevent.type == ConfigureNotify)
431        {
432            unsigned int w, h;
433
434            w = (xevent.xconfigure.width + kk->drv.p->font_width / 3)
435                  / kk->drv.p->font_width;
436            h = (xevent.xconfigure.height + kk->drv.p->font_height / 3)
437                  / kk->drv.p->font_height;
438
439            if(!w || !h || (w == kk->qq->width && h == kk->qq->height))
440                continue;
441
442            kk->resize.w = w;
443            kk->resize.h = h;
444            kk->resize.resized = 1;
445
446            continue;
447        }
448
449        /* Check for mouse motion events */
450        if(xevent.type == MotionNotify)
451        {
452            unsigned int newx = xevent.xmotion.x / kk->drv.p->font_width;
453            unsigned int newy = xevent.xmotion.y / kk->drv.p->font_height;
454
455            if(newx >= kk->qq->width)
456                newx = kk->qq->width - 1;
457            if(newy >= kk->qq->height)
458                newy = kk->qq->height - 1;
459
460            if(kk->mouse.x == newx && kk->mouse.y == newy)
461                continue;
462
463            kk->mouse.x = newx;
464            kk->mouse.y = newy;
465
466            ev->type = CACA_EVENT_MOUSE_MOTION;
467            ev->data.mouse.x = kk->mouse.x;
468            ev->data.mouse.y = kk->mouse.y;
469            return 1;
470        }
471
472        /* Check for mouse press and release events */
473        if(xevent.type == ButtonPress)
474        {
475            ev->type = CACA_EVENT_MOUSE_PRESS;
476            ev->data.mouse.button = ((XButtonEvent *)&xevent)->button;
477            return 1;
478        }
479
480        if(xevent.type == ButtonRelease)
481        {
482            ev->type = CACA_EVENT_MOUSE_RELEASE;
483            ev->data.mouse.button = ((XButtonEvent *)&xevent)->button;
484            return 1;
485        }
486
487        /* Check for key press and release events */
488        if(xevent.type == KeyPress)
489            ev->type = CACA_EVENT_KEY_PRESS;
490        else if(xevent.type == KeyRelease)
491            ev->type = CACA_EVENT_KEY_RELEASE;
492        else
493            continue;
494
495        if(XLookupString(&xevent.xkey, &key, 1, NULL, NULL))
496        {
497            ev->data.key.c = key;
498            ev->data.key.ucs4 = key;
499            ev->data.key.utf8[0] = key;
500            ev->data.key.utf8[1] = '\0';
501            return 1;
502        }
503
504        keysym = XKeycodeToKeysym(kk->drv.p->dpy, xevent.xkey.keycode, 0);
505        switch(keysym)
506        {
507            case XK_F1:    ev->data.key.c = CACA_KEY_F1;    break;
508            case XK_F2:    ev->data.key.c = CACA_KEY_F2;    break;
509            case XK_F3:    ev->data.key.c = CACA_KEY_F3;    break;
510            case XK_F4:    ev->data.key.c = CACA_KEY_F4;    break;
511            case XK_F5:    ev->data.key.c = CACA_KEY_F5;    break;
512            case XK_F6:    ev->data.key.c = CACA_KEY_F6;    break;
513            case XK_F7:    ev->data.key.c = CACA_KEY_F7;    break;
514            case XK_F8:    ev->data.key.c = CACA_KEY_F8;    break;
515            case XK_F9:    ev->data.key.c = CACA_KEY_F9;    break;
516            case XK_F10:   ev->data.key.c = CACA_KEY_F10;   break;
517            case XK_F11:   ev->data.key.c = CACA_KEY_F11;   break;
518            case XK_F12:   ev->data.key.c = CACA_KEY_F12;   break;
519            case XK_F13:   ev->data.key.c = CACA_KEY_F13;   break;
520            case XK_F14:   ev->data.key.c = CACA_KEY_F14;   break;
521            case XK_F15:   ev->data.key.c = CACA_KEY_F15;   break;
522            case XK_Left:  ev->data.key.c = CACA_KEY_LEFT;  break;
523            case XK_Right: ev->data.key.c = CACA_KEY_RIGHT; break;
524            case XK_Up:    ev->data.key.c = CACA_KEY_UP;    break;
525            case XK_Down:  ev->data.key.c = CACA_KEY_DOWN;  break;
526
527            default: ev->type = CACA_EVENT_NONE; return 0;
528        }
529
530        ev->data.key.ucs4 = 0;
531        ev->data.key.utf8[0] = '\0';
532        return 1;
533    }
534
535    ev->type = CACA_EVENT_NONE;
536    return 0;
537}
538
539static void x11_set_mouse(caca_t *kk, int flags)
540{
541    Cursor no_ptr;
542    Pixmap bm_no;
543    XColor black, dummy;
544    Colormap colormap;
545    static char const empty[] = { 0, 0, 0, 0, 0, 0, 0, 0 };
546
547    if(flags)
548    {
549        XDefineCursor(kk->drv.p->dpy,kk->drv.p->window, 0);
550        return;
551    }
552
553    colormap = DefaultColormap(kk->drv.p->dpy, DefaultScreen(kk->drv.p->dpy));
554    if(!XAllocNamedColor(kk->drv.p->dpy, colormap, "black", &black, &dummy))
555    {
556        return;
557    }
558    bm_no = XCreateBitmapFromData(kk->drv.p->dpy, kk->drv.p->window,
559                                  empty, 8, 8);
560    no_ptr = XCreatePixmapCursor(kk->drv.p->dpy, bm_no, bm_no,
561                                 &black, &black, 0, 0);
562    XDefineCursor(kk->drv.p->dpy, kk->drv.p->window, no_ptr);
563    XFreeCursor(kk->drv.p->dpy, no_ptr);
564    if(bm_no != None)
565        XFreePixmap(kk->drv.p->dpy, bm_no);
566    XFreeColors(kk->drv.p->dpy, colormap, &black.pixel, 1, 0);
567
568    XSync(kk->drv.p->dpy, False);
569}
570
571/*
572 * XXX: following functions are local
573 */
574
575static int x11_error_handler(Display *dpy, XErrorEvent *xevent)
576{
577    /* Ignore the error */
578    return 0;
579}
580
581/*
582 * Driver initialisation
583 */
584
585int x11_install(caca_t *kk)
586{
587#if defined(HAVE_GETENV)
588    if(!getenv("DISPLAY") || !*(getenv("DISPLAY")))
589        return -1;
590#endif
591
592    kk->drv.driver = CACA_DRIVER_X11;
593
594    kk->drv.init_graphics = x11_init_graphics;
595    kk->drv.end_graphics = x11_end_graphics;
596    kk->drv.set_window_title = x11_set_window_title;
597    kk->drv.get_window_width = x11_get_window_width;
598    kk->drv.get_window_height = x11_get_window_height;
599    kk->drv.display = x11_display;
600    kk->drv.handle_resize = x11_handle_resize;
601    kk->drv.get_event = x11_get_event;
602    kk->drv.set_mouse = x11_set_mouse;
603
604    return 0;
605}
606
607#endif /* USE_X11 */
608
Note: See TracBrowser for help on using the repository browser.