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

Last change on this file since 1303 was 1303, checked in by Sam Hocevar, 16 years ago
  • Don't use htonl() directly, use common.h's hton32() wrapper.
  • Property svn:keywords set to Id
File size: 16.5 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 1303 2006-11-08 13:05:42Z 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#   if defined(HAVE_ERRNO_H)
23#       include <errno.h>
24#   endif
25#   include <stdio.h>
26#   include <stdlib.h>
27#   include <string.h>
28#endif
29
30#include "cucul.h"
31#include "cucul_internals.h"
32
33static inline uint32_t sscanu32(void const *s)
34{
35    uint32_t x;
36    memcpy(&x, s, 4);
37    return hton32(x);
38}
39
40static inline uint16_t sscanu16(void const *s)
41{
42    uint16_t x;
43    memcpy(&x, s, 2);
44    return hton16(x);
45}
46
47/* ANSI Graphic Rendition Combination Mode */
48struct ansi_grcm
49{
50    uint8_t fg, bg;   /* ANSI-context fg/bg */
51    uint8_t efg, ebg; /* Effective (libcucul) fg/bg */
52    uint8_t bold, negative, concealed;
53};
54
55static long int import_caca(cucul_canvas_t *, void const *, unsigned int);
56static long int import_text(cucul_canvas_t *, void const *, unsigned int);
57static long int import_ansi(cucul_canvas_t *, void const *, unsigned int, int);
58
59static void ansi_parse_grcm(cucul_canvas_t *, struct ansi_grcm *,
60                            unsigned int, unsigned int const *);
61
62/** \brief Import a memory buffer into a canvas
63 *
64 *  Import a memory buffer into the given libcucul canvas's current
65 *  frame. The current frame is resized accordingly and its contents are
66 *  replaced with the imported data.
67 *
68 *  Valid values for \c format are:
69 *  - \c "": attempt to autodetect the file format.
70 *  - \c "text": import ASCII text files.
71 *  - \c "ansi": import ANSI files.
72 *  - \c "utf8": import UTF-8 files with ANSI colour codes.
73 *  - \c "caca": import native libcaca files.
74 *
75 *  If an error occurs, -1 is returned and \b errno is set accordingly:
76 *  - \c ENOMEM Not enough memory to allocate canvas.
77 *  - \c EINVAL Invalid format requested.
78 *
79 *  \param A libcucul canvas in which to import the file.
80 *  \param buffer A \e libcucul buffer containing the data to be loaded
81 *         into a canvas.
82 *  \param format A string describing the input format.
83 *  \return The number of bytes read, or -1 if an error occurred.
84 */
85long int cucul_import(cucul_canvas_t *cv, unsigned char const *buf,
86                      unsigned long int len, char const *format)
87{
88    if(!strcasecmp("caca", format))
89        return import_caca(cv, buf, len);
90    if(!strcasecmp("utf8", format))
91        return import_ansi(cv, buf, len, 1);
92    if(!strcasecmp("text", format))
93        return import_text(cv, buf, len);
94    if(!strcasecmp("ansi", format))
95        return import_ansi(cv, buf, len, 0);
96
97    /* Autodetection */
98    if(!strcasecmp("", format))
99    {
100        unsigned int i;
101
102        /* If 4 first bytes are 0xcaca + 'CV' */
103        if(len >= 4 && buf[0] == 0xca &&
104           buf[1] == 0xca && buf[2] == 'C' && buf[3] == 'V')
105            return import_caca(cv, buf, len);
106
107        /* If we find ESC[ argv, we guess it's an ANSI file */
108        for(i = 0; i + 1 < len; i++)
109            if((buf[i] == 0x1b) && (buf[i + 1] == '['))
110                return import_ansi(cv, buf, len, 0);
111
112        /* Otherwise, import it as text */
113        return import_text(cv, buf, len);
114    }
115
116#if defined(HAVE_ERRNO_H)
117    errno = EINVAL;
118#endif
119    return -1;
120}
121
122/** \brief Get available import formats
123 *
124 *  Return a list of available import formats. The list is a NULL-terminated
125 *  array of strings, interleaving a string containing the internal value for
126 *  the import format, to be used with cucul_import_canvas(), and a string
127 *  containing the natural language description for that import format.
128 *
129 *  This function never fails.
130 *
131 *  \return An array of strings.
132 */
133char const * const * cucul_get_import_list(void)
134{
135    static char const * const list[] =
136        {
137            "", "autodetect",
138            "text", "plain text",
139            "caca", "native libcaca format",
140            "ansi", "ANSI coloured text",
141            NULL, NULL
142        };
143
144    return list;
145}
146
147/*
148 * XXX: the following functions are local.
149 */
150
151static long int import_caca(cucul_canvas_t *cv,
152                            void const *data, unsigned int size)
153{
154    uint8_t const *buf = (uint8_t const *)data;
155    unsigned int control_size, data_size, full_size, frames, f, n;
156    uint16_t version, flags;
157
158    cucul_set_canvas_size(cv, 0, 0);
159
160    if(size < 20)
161        goto invalid_caca;
162
163    if(buf[0] != 0xca || buf[1] != 0xca || buf[2] != 'C' || buf[3] != 'V')
164        goto invalid_caca;
165
166    control_size = sscanu32(buf + 4);
167    data_size = sscanu32(buf + 8);
168    version = sscanu16(buf + 12);
169    frames = sscanu32(buf + 14);
170    flags = sscanu16(buf + 18);
171
172    if(size != 4 + control_size + data_size)
173        goto invalid_caca;
174
175    if(control_size < 16 + frames * 24)
176        goto invalid_caca;
177
178    for(full_size = 0, f = 0; f < frames; f++)
179    {
180        unsigned int width, height, duration;
181        uint32_t attr;
182        int x, y;
183
184        width = sscanu32(buf + 4 + 16 + f * 24);
185        height = sscanu32(buf + 4 + 16 + f * 24 + 4);
186        duration = sscanu32(buf + 4 + 16 + f * 24 + 8);
187        attr = sscanu32(buf + 4 + 16 + f * 24 + 12);
188        x = (int32_t)sscanu32(buf + 4 + 16 + f * 24 + 16);
189        y = (int32_t)sscanu32(buf + 4 + 16 + f * 24 + 20);
190
191        full_size += width * height * 8;
192    }
193
194    if(full_size != data_size)
195        goto invalid_caca;
196
197    /* FIXME: read all frames, not only the first one */
198    cucul_set_canvas_size(cv, sscanu32(buf + 4 + 16),
199                              sscanu32(buf + 4 + 16 + 4));
200
201    /* FIXME: check for return value */
202
203    for(n = sscanu32(buf + 4 + 16) * sscanu32(buf + 4 + 16 + 4); n--; )
204    {
205        cv->chars[n] = sscanu32(buf + 4 + control_size + 8 * n);
206        cv->attrs[n] = sscanu32(buf + 4 + control_size + 8 * n + 4);
207    }
208
209    cv->curattr = sscanu32(buf + 4 + 16 + 12);
210
211    return size;
212
213invalid_caca:
214#if defined(HAVE_ERRNO_H)
215    errno = EINVAL;
216#endif
217    return -1;
218}
219
220static long int import_text(cucul_canvas_t *cv,
221                            void const *data, unsigned int size)
222{
223    char const *text = (char const *)data;
224    unsigned int width = 0, height = 0, x = 0, y = 0, i;
225
226    cucul_set_canvas_size(cv, width, height);
227    cucul_set_color_ansi(cv, CUCUL_DEFAULT, CUCUL_TRANSPARENT);
228
229    for(i = 0; i < size; i++)
230    {
231        unsigned char ch = *text++;
232
233        if(ch == '\r')
234            continue;
235
236        if(ch == '\n')
237        {
238            x = 0;
239            y++;
240            continue;
241        }
242
243        if(x >= width || y >= height)
244        {
245            if(x >= width)
246                width = x + 1;
247
248            if(y >= height)
249                height = y + 1;
250
251            cucul_set_canvas_size(cv, width, height);
252        }
253
254        cucul_putchar(cv, x, y, ch);
255        x++;
256    }
257
258    if(y > height)
259        cucul_set_canvas_size(cv, width, height = y);
260
261    return size;
262}
263
264static long int import_ansi(cucul_canvas_t *cv,
265                            void const *data, unsigned int size, int utf8)
266{
267    struct ansi_grcm grcm;
268    unsigned char const *buffer = (unsigned char const*)data;
269    unsigned int i, j, skip, dummy = 0;
270    unsigned int width = 0, height = 0, wch = 1;
271    unsigned long int ch;
272    int x = 0, y = 0, save_x = 0, save_y = 0;
273
274    cucul_set_canvas_size(cv, width, height);
275    ansi_parse_grcm(cv, &grcm, 1, &dummy);
276
277    for(i = 0; i < size; i += skip)
278    {
279        skip = 1;
280
281        /* Wrap long lines */
282        if((unsigned int)x >= 80)
283        {
284            x = 0;
285            y++;
286        }
287
288        if(buffer[i] == '\x1a' && size - i >= 8
289           && !memcmp(buffer + i + 1, "SAUCE00", 7))
290            break; /* End before SAUCE data */
291
292        if(buffer[i] == '\r')
293            continue; /* DOS sucks */
294
295        if(buffer[i] == '\n')
296        {
297            x = 0;
298            y++;
299            continue;
300        }
301
302        /* Interpret escape commands, as per Standard ECMA-48 "Control
303         * Functions for Coded Character Sets", 5.4. Control sequences. */
304        if(buffer[i] == '\x1b' && buffer[i + 1] == '[')
305        {
306            unsigned int argc = 0, argv[101];
307            unsigned int param, inter, final;
308
309        /* Compute offsets to parameter bytes, intermediate bytes and
310         * to the final byte. Only the final byte is mandatory, there
311         * can be zero of the others.
312         * 0  param=2             inter                 final           final+1
313         * +-----+------------------+---------------------+-----------------+
314         * | CSI | parameter bytes  | intermediate bytes  |   final byte    |
315         * |     |   0x30 - 0x3f    |    0x20 - 0x2f      |   0x40 - 0x7e   |
316         * | ^[[ | 0123456789:;<=>? | SPC !"#$%&'()*+,-./ | azAZ@[\]^_`{|}~ |
317         * +-----+------------------+---------------------+-----------------+
318         */
319            param = 2;
320
321            for(inter = param; i + inter < size; inter++)
322                if(buffer[i + inter] < 0x30 || buffer[i + inter] > 0x3f)
323                    break;
324
325            for(final = inter; i + final < size; final++)
326                if(buffer[i + final] < 0x20 || buffer[i + final] > 0x2f)
327                    break;
328
329            if(buffer[i + final] < 0x40 || buffer[i + final] > 0x7e)
330                break; /* Invalid Final Byte */
331
332            skip += final;
333
334            /* Sanity checks */
335            if(param < inter && buffer[i + param] >= 0x3c)
336            {
337                fprintf(stderr, "private sequence \"^[[%.*s\"\n",
338                        final - param + 1, buffer + i + param);
339                continue; /* Private sequence, skip it entirely */
340            }
341
342            if(final - param > 100)
343                continue; /* Suspiciously long sequence, skip it */
344
345            /* Parse parameter bytes as per ECMA-48 5.4.2: Parameter string
346             * format */
347            if(param < inter)
348            {
349                argv[0] = 0;
350                for(j = param; j < inter; j++)
351                {
352                    if(buffer[i + j] == ';')
353                        argv[++argc] = 0;
354                    else if(buffer[i + j] >= '0' && buffer[i + j] <= '9')
355                        argv[argc] = 10 * argv[argc] + (buffer[i + j] - '0');
356                }
357                argc++;
358            }
359
360            /* Interpret final byte. The code representations are given in
361             * ECMA-48 5.4: Control sequences, and the code definitions are
362             * given in ECMA-48 8.3: Definition of control functions. */
363            switch(buffer[i + final])
364            {
365            case 'f': /* CUP - Cursor Position */
366            case 'H': /* HVP - Character And Line Position */
367                x = (argc > 1 && argv[1] > 0) ? argv[1] - 1 : 0;
368                y = (argc > 0 && argv[0] > 0) ? argv[0] - 1 : 0;
369                break;
370            case 'A': /* CUU - Cursor Up */
371                y -= argc ? argv[0] : 1;
372                if(y < 0)
373                    y = 0;
374                break;
375            case 'B': /* CUD - Cursor Down */
376                y += argc ? argv[0] : 1;
377                break;
378            case 'C': /* CUF - Cursor Right */
379                x += argc ? argv[0] : 1;
380                break;
381            case 'D': /* CUB - Cursor Left */
382                x -= argc ? argv[0] : 1;
383                if(x < 0)
384                    x = 0;
385                break;
386            case 's': /* Private (save cursor position) */
387                save_x = x;
388                save_y = y;
389                break;
390            case 'u': /* Private (reload cursor position) */
391                x = save_x;
392                y = save_y;
393                break;
394            case 'J': /* ED - Erase In Page */
395                if(argv[0] == 2)
396                    x = y = 0;
397                break;
398            case 'K': /* EL - Erase In Line */
399                if(width < 80)
400                    cucul_set_color_ansi(cv, CUCUL_DEFAULT, CUCUL_TRANSPARENT);
401                    cucul_set_canvas_size(cv, width = 80, height);
402                for(j = x; j < 80; j++)
403                    cucul_putchar(cv, j, y, ' ');
404                x = 80;
405                break;
406            case 'm': /* SGR - Select Graphic Rendition */
407                ansi_parse_grcm(cv, &grcm, argc, argv);
408                break;
409            default:
410                fprintf(stderr, "unknown command %c\n", buffer[i + final]);
411                break;
412            }
413
414            continue;
415        }
416
417        /* Get the character we’re going to paste */
418        if(utf8)
419        {
420            unsigned int bytes;
421
422            if(i + 6 < size)
423                ch = cucul_utf8_to_utf32((char const *)(buffer + i), &bytes);
424            else
425            {
426                /* Add a trailing zero to what we're going to read */
427                char tmp[7];
428                memcpy(tmp, buffer + i, size - i);
429                tmp[size - i] = '\0';
430                ch = cucul_utf8_to_utf32(tmp, &bytes);
431            }
432
433            if(!bytes)
434            {
435                /* If the Unicode is invalid, assume it was latin1. */
436                ch = buffer[i];
437                bytes = 1;
438            }
439            wch = cucul_utf32_is_fullwidth(ch) ? 2 : 1;
440            skip += bytes - 1;
441        }
442        else
443        {
444            ch = cucul_cp437_to_utf32(buffer[i]);
445        }
446
447        /* Make sure the canvas is big enough. */
448        if((unsigned int)x + wch > width)
449        {
450            cucul_set_color_ansi(cv, CUCUL_DEFAULT, CUCUL_TRANSPARENT);
451            cucul_set_canvas_size(cv, width = x + wch, height);
452        }
453
454        if((unsigned int)y >= height)
455        {
456            cucul_set_color_ansi(cv, CUCUL_DEFAULT, CUCUL_TRANSPARENT);
457            cucul_set_canvas_size(cv, width, height = y + 1);
458        }
459
460        /* Now paste our character */
461        cucul_set_color_ansi(cv, grcm.efg, grcm.ebg);
462        cucul_putchar(cv, x, y, ch);
463        x += wch;
464    }
465
466    if((unsigned int)y > height)
467    {
468        cucul_set_color_ansi(cv, CUCUL_DEFAULT, CUCUL_TRANSPARENT);
469        cucul_set_canvas_size(cv, width, height = y);
470    }
471
472    return size;
473}
474
475/* XXX : ANSI loader helper */
476
477static void ansi_parse_grcm(cucul_canvas_t *cv, struct ansi_grcm *g,
478                            unsigned int argc, unsigned int const *argv)
479{
480    static uint8_t const ansi2cucul[] =
481    {
482        CUCUL_BLACK, CUCUL_RED, CUCUL_GREEN, CUCUL_BROWN,
483        CUCUL_BLUE, CUCUL_MAGENTA, CUCUL_CYAN, CUCUL_LIGHTGRAY
484    };
485
486    unsigned int j;
487
488    for(j = 0; j < argc; j++)
489    {
490        /* Defined in ECMA-48 8.3.117: SGR - SELECT GRAPHIC RENDITION */
491        if(argv[j] >= 30 && argv[j] <= 37)
492            g->fg = ansi2cucul[argv[j] - 30];
493        else if(argv[j] >= 40 && argv[j] <= 47)
494            g->bg = ansi2cucul[argv[j] - 40];
495        else if(argv[j] >= 90 && argv[j] <= 97)
496            g->fg = ansi2cucul[argv[j] - 90] + 8;
497        else if(argv[j] >= 100 && argv[j] <= 107)
498            g->bg = ansi2cucul[argv[j] - 100] + 8;
499        else switch(argv[j])
500        {
501        case 0: /* default rendition */
502            g->fg = CUCUL_DEFAULT;
503            g->bg = CUCUL_TRANSPARENT;
504            g->bold = g->negative = g->concealed = 0;
505            break;
506        case 1: /* bold or increased intensity */
507            g->bold = 1;
508            break;
509        case 4: /* singly underlined */
510            break;
511        case 5: /* slowly blinking (less then 150 per minute) */
512            break;
513        case 7: /* negative image */
514            g->negative = 1;
515            break;
516        case 8: /* concealed characters */
517            g->concealed = 1;
518            break;
519        case 22: /* normal colour or normal intensity (neither bold nor faint) */
520            g->bold = 0;
521            break;
522        case 28: /* revealed characters */
523            g->concealed = 0;
524            break;
525        case 39: /* default display colour (implementation-defined) */
526            g->fg = CUCUL_DEFAULT;
527            break;
528        case 49: /* default background colour (implementation-defined) */
529            g->bg = CUCUL_TRANSPARENT;
530            break;
531        default:
532            fprintf(stderr, "unknown sgr %i\n", argv[j]);
533            break;
534        }
535    }
536
537    if(g->concealed)
538    {
539        g->efg = g->ebg = CUCUL_TRANSPARENT;
540    }
541    else
542    {
543        g->efg = g->negative ? g->bg : g->fg;
544        g->ebg = g->negative ? g->fg : g->bg;
545
546        if(g->bold)
547        {
548            if(g->efg < 8)
549                g->efg += 8;
550            else if(g->efg == CUCUL_DEFAULT)
551                g->efg = CUCUL_WHITE;
552        }
553    }
554}
555
Note: See TracBrowser for help on using the repository browser.