source: libcaca/trunk/cucul/import.c @ 891

Last change on this file since 891 was 891, checked in by Sam Hocevar, 15 years ago
  • More robust ANSI sequence argument parser. Detects private sequences and intermediate bytes.
  • Property svn:keywords set to Id
File size: 11.8 KB
Line 
1/*
2 *  libcucul      Canvas for ultrafast compositing of Unicode letters
3 *  Copyright (c) 2002-2006 Sam Hocevar <sam@zoy.org>
4 *                All Rights Reserved
5 *
6 *  $Id: import.c 891 2006-04-26 09:56:26Z sam $
7 *
8 *  This library is free software; you can redistribute it and/or
9 *  modify it under the terms of the Do What The Fuck You Want To
10 *  Public License, Version 2, as published by Sam Hocevar. See
11 *  http://sam.zoy.org/wtfpl/COPYING for more details.
12 */
13
14/*
15 *  This file contains various import functions.
16 */
17
18#include "config.h"
19#include "common.h"
20
21#if !defined(__KERNEL__)
22#   include <stdio.h>
23#   include <stdlib.h>
24#   include <string.h>
25#endif
26
27#include "cucul.h"
28#include "cucul_internals.h"
29
30static cucul_canvas_t *import_caca(void const *, unsigned int);
31static cucul_canvas_t *import_text(void const *, unsigned int);
32static cucul_canvas_t *import_ansi(void const *, unsigned int);
33
34/** \brief Import a buffer into a canvas
35 *
36 *  This function imports a memory area into an internal libcucul canvas.
37 *
38 *  Valid values for \c format are:
39 *
40 *  \li \c "": attempt to autodetect the file format.
41 *
42 *  \li \c "ansi": import ANSI files.
43 *
44 *  \li \c "caca": import native libcaca files.
45 *
46 *  \param data The memory area to be loaded into a canvas.
47 *  \param size The length of the memory area.
48 *  \param format A string describing the input format.
49 *  \return A libcucul canvas, or NULL in case of error.
50 */
51cucul_canvas_t * cucul_import_canvas(void const *data, unsigned int size,
52                                     char const *format)
53{
54    char const *buf = (char const*) data;
55
56    if(size==0 || data==NULL)
57        return NULL;
58
59    if(!strcasecmp("caca", format))
60        return import_caca(data, size);
61    if(!strcasecmp("text", format))
62        return import_text(data, size);
63    if(!strcasecmp("ansi", format))
64        return import_ansi(data, size);
65
66    /* Autodetection */
67    if(!strcasecmp("", format))
68    {
69        unsigned int i=0;
70        /* if 4 first letters are CACA */
71        if(size >= 4 &&
72            buf[0] == 'C' && buf[1] == 'A' && buf[2] == 'C' && buf[3] != 'A')
73            return import_caca(data, size);
74
75        /* If we find ESC[ argv, we guess it's an ANSI file */
76        while(i<size-1)
77        {
78            if((buf[i] == 0x1b) && (buf[i+1] == '['))
79                return import_ansi(data, size);
80            i++;
81        }
82
83        /* Otherwise, import it as text */
84        return import_text(data, size);
85    }
86    return NULL;
87}
88
89/** \brief Get available import formats
90 *
91 *  Return a list of available import formats. The list is a NULL-terminated
92 *  array of strings, interleaving a string containing the internal value for
93 *  the import format, to be used with cucul_import_canvas(), and a string
94 *  containing the natural language description for that import format.
95 *
96 *  \return An array of strings.
97 */
98char const * const * cucul_get_import_list(void)
99{
100    static char const * const list[] =
101    {
102        "", "autodetect",
103        "text", "plain text",
104        "caca", "native libcaca format",
105        "ansi", "ANSI coloured text",
106        NULL, NULL
107    };
108
109    return list;
110}
111
112/*
113 * XXX: the following functions are local.
114 */
115
116static cucul_canvas_t *import_caca(void const *data, unsigned int size)
117{
118    cucul_canvas_t *cv;
119    uint8_t const *buf = (uint8_t const *)data;
120    unsigned int width, height, n;
121
122    if(size < 16)
123        return NULL;
124
125    if(buf[0] != 'C' || buf[1] != 'A' || buf[2] != 'C' || buf[3] != 'A')
126        return NULL;
127
128    if(buf[4] != 'C' || buf[5] != 'A' || buf[6] != 'N' || buf[7] != 'V')
129        return NULL;
130
131    width = ((uint32_t)buf[8] << 24) | ((uint32_t)buf[9] << 16)
132           | ((uint32_t)buf[10] << 8) | (uint32_t)buf[11];
133    height = ((uint32_t)buf[12] << 24) | ((uint32_t)buf[13] << 16)
134            | ((uint32_t)buf[14] << 8) | (uint32_t)buf[15];
135
136    if(!width || !height)
137        return NULL;
138
139    if(size != 16 + width * height * 8)
140        return NULL;
141
142    cv = cucul_create_canvas(width, height);
143
144    if(!cv)
145        return NULL;
146
147    for(n = height * width; n--; )
148    {
149        cv->chars[n] = ((uint32_t)buf[16 + 0 + 8 * n] << 24)
150                     | ((uint32_t)buf[16 + 1 + 8 * n] << 16)
151                     | ((uint32_t)buf[16 + 2 + 8 * n] << 8)
152                     | (uint32_t)buf[16 + 3 + 8 * n];
153        cv->attr[n] = ((uint32_t)buf[16 + 4 + 8 * n] << 24)
154                    | ((uint32_t)buf[16 + 5 + 8 * n] << 16)
155                    | ((uint32_t)buf[16 + 6 + 8 * n] << 8)
156                    | (uint32_t)buf[16 + 7 + 8 * n];
157    }
158
159    return cv;
160}
161
162static cucul_canvas_t *import_text(void const *data, unsigned int size)
163{
164    cucul_canvas_t *cv;
165    char const *text = (char const *)data;
166    unsigned int width = 1, height = 1, x = 0, y = 0, i;
167
168    cv = cucul_create_canvas(width, height);
169    cucul_set_color(cv, CUCUL_COLOR_DEFAULT, CUCUL_COLOR_TRANSPARENT);
170
171    for(i = 0; i < size; i++)
172    {
173        unsigned char ch = *text++;
174
175        if(ch == '\r')
176            continue;
177
178        if(ch == '\n')
179        {
180            x = 0;
181            y++;
182            continue;
183        }
184
185        if(x >= width || y >= height)
186        {
187            if(x >= width)
188                width = x + 1;
189
190            if(y >= height)
191                height = y + 1;
192
193            cucul_set_canvas_size(cv, width, height);
194        }
195
196        cucul_putchar(cv, x, y, ch);
197        x++;
198    }
199
200    return cv;
201}
202
203static void manage_modifiers(int, uint8_t *, uint8_t *, uint8_t *,
204                             uint8_t *, uint8_t *, uint8_t *);
205
206static cucul_canvas_t *import_ansi(void const *data, unsigned int size)
207{
208    cucul_canvas_t *cv;
209    unsigned char const *buffer = (unsigned char const*)data;
210    unsigned int i, j;
211    int x = 0, y = 0;
212    unsigned int width = 80, height = 25;
213    int save_x = 0, save_y = 0;
214    unsigned int skip;
215    uint8_t fg, bg, save_fg, save_bg, bold, reverse;
216
217    fg = save_fg = CUCUL_COLOR_LIGHTGRAY;
218    bg = save_bg = CUCUL_COLOR_BLACK;
219    bold = reverse = 0;
220
221    cv = cucul_create_canvas(width, height);
222    cucul_set_color(cv, fg, bg);
223
224    for(i = 0; i < size; i += skip)
225    {
226        skip = 1;
227
228        if(buffer[i] == '\x1a' && size - i >= 8
229           && !memcmp(buffer + i + 1, "SAUCE00", 7))
230            break; /* End before SAUCE data */
231
232        if(buffer[i] == '\r')
233            continue; /* DOS sucks */
234
235        if(buffer[i] == '\n')
236        {
237            x = 0;
238            y++;
239            continue;
240        }
241
242        /* Interpret escape commands, as per Standard ECMA-48 "Control
243         * Functions for Coded Character Sets", 5.4. Control sequences. */
244        if(buffer[i] == '\x1b' && buffer[i + 1] == '[')
245        {
246            unsigned int argv[1024]; /* Should be enough. Will it be? */
247            unsigned int argc = 0;
248            unsigned int param, inter, final;
249
250            /* Offset to parameter bytes */
251            param = 2;
252
253            /* Offset to intermediate bytes: skip parameter bytes */
254            for(inter = param; i + inter < size; inter++)
255                if(buffer[i + inter] < 0x30 || buffer[i + inter] > 0x3f)
256                    break;
257
258            /* Offset to final byte: skip intermediate bytes */
259            for(final = inter; i + final < size; final++)
260                if(buffer[i + final] < 0x20 || buffer[i + final] > 0x2f)
261                    break;
262
263            if(buffer[i + final] < 0x40 || buffer[i + final] > 0x7e)
264                break; /* Invalid Final Byte */
265
266            skip += final;
267
268            if(param < inter && buffer[i + param] >= 0x3c)
269            {
270                //fprintf(stderr, "private sequence \"^[[%.*s\"\n",
271                //                final - param + 1, buffer + i + param);
272                continue; /* Private sequence, skip it entirely */
273            }
274
275            /* Parse parameter bytes, if any */
276            if(param < inter)
277            {
278                argv[0] = 0;
279                for(j = param; j < inter; j++)
280                {
281                    if(buffer[i + j] == ';')
282                        argv[++argc] = 0;
283                    else if(buffer[i + j] >= '0' && buffer[i + j] <= '9')
284                        argv[argc] = 10 * argv[argc] + (buffer[i + j] - '0');
285                }
286                argc++;
287            }
288
289            /* Interpret final byte */
290            switch(buffer[i + final])
291            {
292            case 'f':
293            case 'H':
294                x = (argc > 1) ? argv[1] - 1 : 0;
295                y = (argc > 0) ? argv[0] - 1 : 0;
296                break;
297            case 'A':
298                y -= argc ? argv[0] : 1;
299                if(y < 0)
300                    y = 0;
301                break;
302            case 'B':
303                y += argc ? argv[0] : 1;
304                break;
305            case 'C':
306                x += argc ? argv[0] : 1;
307                break;
308            case 'D':
309                x -= argc ? argv[0] : 1;
310                if(x < 0)
311                    x = 0;
312                break;
313            case 's':
314                save_x = x;
315                save_y = y;
316                break;
317            case 'u':
318                x = save_x;
319                y = save_y;
320                break;
321            case 'J':
322                if(argv[0] == 2)
323                    x = y = 0;
324                break;
325            case 'K':
326                // CLEAR END OF LINE
327                for(j = x; j < width; j++)
328                    _cucul_putchar32(cv, j, y, (uint32_t)' ');
329                x = width;
330                break;
331            case 'm':
332                for(j = 0; j < argc; j++)
333                    manage_modifiers(argv[j], &fg, &bg,
334                                     &save_fg, &save_bg, &bold, &reverse);
335                if(bold && fg < 8)
336                    fg += 8;
337                if(bold && bg < 8)
338                    bg += 8;
339                if(reverse)
340                    cucul_set_color(cv, bg, fg);
341                else
342                    cucul_set_color(cv, fg, bg);
343                break;
344            default:
345                break;
346            }
347
348            continue;
349        }
350
351        /* We're going to paste a character. First make sure the canvas
352         * is big enough. */
353        if((unsigned int)x >= width)
354        {
355            x = 0;
356            y++;
357        }
358
359        if((unsigned int)y >= height)
360        {
361            height = y + 1;
362            cucul_set_canvas_size(cv, width, height);
363        }
364
365        /* Now paste our character */
366        _cucul_putchar32(cv, x, y,_cucul_cp437_to_utf32(buffer[i]));
367        x++;
368    }
369
370    return cv;
371}
372
373/* XXX : ANSI loader helper */
374
375static void manage_modifiers(int i, uint8_t *fg, uint8_t *bg, uint8_t *save_fg,
376                             uint8_t *save_bg, uint8_t *bold, uint8_t *reverse)
377{
378    static uint8_t const ansi2cucul[] =
379    {
380        CUCUL_COLOR_BLACK,
381        CUCUL_COLOR_RED,
382        CUCUL_COLOR_GREEN,
383        CUCUL_COLOR_BROWN,
384        CUCUL_COLOR_BLUE,
385        CUCUL_COLOR_MAGENTA,
386        CUCUL_COLOR_CYAN,
387        CUCUL_COLOR_LIGHTGRAY
388    };
389
390    if(i >= 30 && i <= 37)
391        *fg = ansi2cucul[i - 30];
392    else if(i >= 40 && i <= 47)
393        *bg = ansi2cucul[i - 40];
394    else if(i >= 90 && i <= 97)
395        *fg = ansi2cucul[i - 90] + 8;
396    else if(i >= 100 && i <= 107)
397        *bg = ansi2cucul[i - 100] + 8;
398    else switch(i)
399    {
400    case 0:
401        *fg = CUCUL_COLOR_DEFAULT;
402        *bg = CUCUL_COLOR_DEFAULT;
403        *bold = 0;
404        *reverse = 0;
405        break;
406    case 1: /* BOLD */
407        *bold = 1;
408        break;
409    case 4: // Underline
410        break;
411    case 5: // blink
412        break;
413    case 7: // reverse
414        *reverse = 1;
415        break;
416    case 8: // invisible
417        *save_fg = *fg;
418        *save_bg = *bg;
419        *fg = CUCUL_COLOR_TRANSPARENT;
420        *bg = CUCUL_COLOR_TRANSPARENT;
421        break;
422    case 28: // not invisible
423        *fg = *save_fg;
424        *bg = *save_bg;
425        break;
426    case 39:
427        *fg = CUCUL_COLOR_DEFAULT;
428        break;
429    case 49:
430        *bg = CUCUL_COLOR_DEFAULT;
431        break;
432    default:
433        break;
434    }
435}
436
Note: See TracBrowser for help on using the repository browser.