source: libcaca/trunk/caca/codec/export.c @ 3237

Last change on this file since 3237 was 3237, checked in by bsittler, 12 years ago

fix foreground-color and quoting bugs in the "html" exporter; also,
the output is now labelled as XHTML 1.0 Strict, since it does conform
to that DTD. also removed spurious cellpadding and cellspacing from
<div /> markup. also handle non-characters by conversion to
replacement character, and handle more control characters by
conversion to no-break space. finally, switch from &nbsp; to the
equivalent &#160; so that a non-validating XML parser (which is most
of them) can correctly parse this document.

  • Property svn:keywords set to Id
File size: 39.1 KB
Line 
1/*
2 *  libcaca       Colour ASCII-Art library
3 *  Copyright (c) 2002-2006 Sam Hocevar <sam@zoy.org>
4 *                2006 Jean-Yves Lamoureux <jylam@lnxscene.org>
5 *                All Rights Reserved
6 *
7 *  $Id: export.c 3237 2008-11-03 18:16:38Z bsittler $
8 *
9 *  This library is free software. It comes without any warranty, to
10 *  the extent permitted by applicable law. You can redistribute it
11 *  and/or modify it under the terms of the Do What The Fuck You Want
12 *  To Public License, Version 2, as published by Sam Hocevar. See
13 *  http://sam.zoy.org/wtfpl/COPYING for more details.
14 */
15
16/*
17 *  This file contains various export functions
18 */
19
20#include "config.h"
21
22#if !defined(__KERNEL__)
23#   include <stdlib.h>
24#   include <stdio.h>
25#   include <string.h>
26#endif
27
28#include "caca.h"
29#include "caca_internals.h"
30
31static inline int sprintu32(char *s, uint32_t x)
32{
33    s[0] = (uint8_t)(x >> 24);
34    s[1] = (uint8_t)(x >> 16) & 0xff;
35    s[2] = (uint8_t)(x >>  8) & 0xff;
36    s[3] = (uint8_t)(x      ) & 0xff;
37    return 4;
38}
39
40static inline int sprintu16(char *s, uint16_t x)
41{
42    s[0] = (uint8_t)(x >>  8) & 0xff;
43    s[1] = (uint8_t)(x      ) & 0xff;
44    return 2;
45}
46
47static void *export_caca(caca_canvas_t const *, size_t *);
48static void *export_ansi(caca_canvas_t const *, size_t *);
49static void *export_utf8(caca_canvas_t const *, size_t *, int);
50static void *export_html(caca_canvas_t const *, size_t *);
51static void *export_html3(caca_canvas_t const *, size_t *);
52static void *export_bbfr(caca_canvas_t const *, size_t *);
53static void *export_irc(caca_canvas_t const *, size_t *);
54static void *export_ps(caca_canvas_t const *, size_t *);
55static void *export_svg(caca_canvas_t const *, size_t *);
56static void *export_tga(caca_canvas_t const *, size_t *);
57
58/** \brief Export a canvas into a foreign format.
59 *
60 *  This function exports a libcaca canvas into various foreign formats such
61 *  as ANSI art, HTML, IRC colours, etc. The returned pointer should be passed
62 *  to free() to release the allocated storage when it is no longer needed.
63 *
64 *  Valid values for \c format are:
65 *  - \c "caca": export native libcaca files.
66 *  - \c "ansi": export ANSI art (CP437 charset with ANSI colour codes).
67 *  - \c "html": export an HTML page with CSS information.
68 *  - \c "html3": export an HTML table that should be compatible with
69 *    most navigators, including textmode ones.
70 *  - \c "irc": export UTF-8 text with mIRC colour codes.
71 *  - \c "ps": export a PostScript document.
72 *  - \c "svg": export an SVG vector image.
73 *  - \c "tga": export a TGA image.
74 *
75 *  If an error occurs, NULL is returned and \b errno is set accordingly:
76 *  - \c EINVAL Unsupported format requested.
77 *  - \c ENOMEM Not enough memory to allocate output buffer.
78 *
79 *  \param cv A libcaca canvas
80 *  \param format A string describing the requested output format.
81 *  \param bytes A pointer to a size_t where the number of allocated bytes
82 *         will be written.
83 *  \return A pointer to the exported memory area, or NULL in case of error.
84 */
85void *caca_export_memory(caca_canvas_t const *cv, char const *format,
86                          size_t *bytes)
87{
88    if(!strcasecmp("caca", format))
89        return export_caca(cv, bytes);
90
91    if(!strcasecmp("ansi", format))
92        return export_ansi(cv, bytes);
93
94    if(!strcasecmp("utf8", format))
95        return export_utf8(cv, bytes, 0);
96
97    if(!strcasecmp("utf8cr", format))
98        return export_utf8(cv, bytes, 1);
99
100    if(!strcasecmp("html", format))
101        return export_html(cv, bytes);
102
103    if(!strcasecmp("html3", format))
104        return export_html3(cv, bytes);
105
106    if(!strcasecmp("bbfr", format))
107        return export_bbfr(cv, bytes);
108
109    if(!strcasecmp("irc", format))
110        return export_irc(cv, bytes);
111
112    if(!strcasecmp("ps", format))
113        return export_ps(cv, bytes);
114
115    if(!strcasecmp("svg", format))
116        return export_svg(cv, bytes);
117
118    if(!strcasecmp("tga", format))
119        return export_tga(cv, bytes);
120
121    seterrno(EINVAL);
122    return NULL;
123}
124
125/** \brief Get available export formats
126 *
127 *  Return a list of available export formats. The list is a NULL-terminated
128 *  array of strings, interleaving a string containing the internal value for
129 *  the export format, to be used with caca_export_memory(), and a string
130 *  containing the natural language description for that export format.
131 *
132 *  This function never fails.
133 *
134 *  \return An array of strings.
135 */
136char const * const * caca_get_export_list(void)
137{
138    static char const * const list[] =
139    {
140        "caca", "native libcaca format",
141        "ansi", "ANSI",
142        "utf8", "UTF-8 with ANSI escape codes",
143        "utf8cr", "UTF-8 with ANSI escape codes and MS-DOS \\r",
144        "html", "HTML",
145        "html3", "backwards-compatible HTML",
146        "bbfr", "BBCode (French)",
147        "irc", "IRC with mIRC colours",
148        "ps", "PostScript document",
149        "svg", "SVG vector image",
150        "tga", "TGA image",
151        NULL, NULL
152    };
153
154    return list;
155}
156
157/*
158 * XXX: the following functions are local.
159 */
160
161/* Generate a native libcaca canvas file. */
162static void *export_caca(caca_canvas_t const *cv, size_t *bytes)
163{
164    char *data, *cur;
165    int f, n;
166
167    /* 52 bytes for the header:
168     *  - 4 bytes for "\xCA\xCA" + "CV"
169     *  - 16 bytes for the canvas header
170     *  - 32 bytes for the frame info
171     * 8 bytes for each character cell */
172    *bytes = 20 + (32 + 8 * cv->width * cv->height) * cv->framecount;
173    cur = data = malloc(*bytes);
174
175    /* magic */
176    cur += sprintf(cur, "%s", "\xCA\xCA" "CV");
177
178    /* canvas_header */
179    cur += sprintu32(cur, 16 + 32 * cv->framecount);
180    cur += sprintu32(cur, cv->width * cv->height * 8 * cv->framecount);
181    cur += sprintu16(cur, 0x0001);
182    cur += sprintu32(cur, cv->framecount);
183    cur += sprintu16(cur, 0x0000);
184
185    /* frame_info */
186    for(f = 0; f < cv->framecount; f++)
187    {
188        cur += sprintu32(cur, cv->width);
189        cur += sprintu32(cur, cv->height);
190        cur += sprintu32(cur, 0);
191        cur += sprintu32(cur, cv->curattr);
192        cur += sprintu32(cur, cv->frames[f].x);
193        cur += sprintu32(cur, cv->frames[f].y);
194        cur += sprintu32(cur, cv->frames[f].handlex);
195        cur += sprintu32(cur, cv->frames[f].handley);
196    }
197
198    /* canvas_data */
199    for(f = 0; f < cv->framecount; f++)
200    {
201        uint32_t *attrs = cv->frames[f].attrs;
202        uint32_t *chars = cv->frames[f].chars;
203
204        for(n = cv->height * cv->width; n--; )
205        {
206            cur += sprintu32(cur, *chars++);
207            cur += sprintu32(cur, *attrs++);
208        }
209    }
210
211    return data;
212}
213
214/* Generate UTF-8 representation of current canvas. */
215static void *export_utf8(caca_canvas_t const *cv, size_t *bytes,
216                         int cr)
217{
218    static uint8_t const palette[] =
219    {
220        0,  4,  2,  6, 1,  5,  3,  7,
221        8, 12, 10, 14, 9, 13, 11, 15
222    };
223
224    char *data, *cur;
225    int x, y;
226
227    /* 23 bytes assumed for max length per pixel ('\e[5;1;3x;4y;9x;10ym' plus
228     * 4 max bytes for a UTF-8 character).
229     * Add height*9 to that (zeroes color at the end and jump to next line) */
230    *bytes = (cv->height * 9) + (cv->width * cv->height * 23);
231    cur = data = malloc(*bytes);
232
233    for(y = 0; y < cv->height; y++)
234    {
235        uint32_t *lineattr = cv->attrs + y * cv->width;
236        uint32_t *linechar = cv->chars + y * cv->width;
237
238        uint8_t prevfg = 0x10;
239        uint8_t prevbg = 0x10;
240
241        for(x = 0; x < cv->width; x++)
242        {
243            uint32_t attr = lineattr[x];
244            uint32_t ch = linechar[x];
245            uint8_t ansifg, ansibg, fg, bg;
246
247            if(ch == CACA_MAGIC_FULLWIDTH)
248                continue;
249
250            ansifg = caca_attr_to_ansi_fg(attr);
251            ansibg = caca_attr_to_ansi_bg(attr);
252
253            fg = ansifg < 0x10 ? palette[ansifg] : 0x10;
254            bg = ansibg < 0x10 ? palette[ansibg] : 0x10;
255
256            /* TODO: the [0 could be omitted in some cases */
257            if(fg != prevfg || bg != prevbg)
258            {
259                cur += sprintf(cur, "\033[0");
260
261                if(fg < 8)
262                    cur += sprintf(cur, ";3%d", fg);
263                else if(fg < 16)
264                    cur += sprintf(cur, ";1;3%d;9%d", fg - 8, fg - 8);
265
266                if(bg < 8)
267                    cur += sprintf(cur, ";4%d", bg);
268                else if(bg < 16)
269                    cur += sprintf(cur, ";5;4%d;10%d", bg - 8, bg - 8);
270
271                cur += sprintf(cur, "m");
272            }
273
274            cur += caca_utf32_to_utf8(cur, ch);
275
276            prevfg = fg;
277            prevbg = bg;
278        }
279
280        if(prevfg != 0x10 || prevbg != 0x10)
281            cur += sprintf(cur, "\033[0m");
282
283        cur += sprintf(cur, cr ? "\r\n" : "\n");
284    }
285
286    /* Crop to really used size */
287    debug("utf8 export: alloc %lu bytes, realloc %lu",
288          (unsigned long int)*bytes, (unsigned long int)(cur - data));
289    *bytes = (uintptr_t)(cur - data);
290    data = realloc(data, *bytes);
291
292    return data;
293}
294
295/* Generate ANSI representation of current canvas. */
296static void *export_ansi(caca_canvas_t const *cv, size_t *bytes)
297{
298    static uint8_t const palette[] =
299    {
300        0,  4,  2,  6, 1,  5,  3,  7,
301        8, 12, 10, 14, 9, 13, 11, 15
302    };
303
304    char *data, *cur;
305    int x, y;
306
307    uint8_t prevfg = -1;
308    uint8_t prevbg = -1;
309
310    /* 16 bytes assumed for max length per pixel ('\e[5;1;3x;4ym' plus
311     * 1 byte for a CP437 character).
312     * Add height*9 to that (zeroes color at the end and jump to next line) */
313    *bytes = (cv->height * 9) + (cv->width * cv->height * 16);
314    cur = data = malloc(*bytes);
315
316    for(y = 0; y < cv->height; y++)
317    {
318        uint32_t *lineattr = cv->attrs + y * cv->width;
319        uint32_t *linechar = cv->chars + y * cv->width;
320
321        for(x = 0; x < cv->width; x++)
322        {
323            uint8_t ansifg = caca_attr_to_ansi_fg(lineattr[x]);
324            uint8_t ansibg = caca_attr_to_ansi_bg(lineattr[x]);
325            uint8_t fg = ansifg < 0x10 ? palette[ansifg] : CACA_LIGHTGRAY;
326            uint8_t bg = ansibg < 0x10 ? palette[ansibg] : CACA_BLACK;
327            uint32_t ch = linechar[x];
328
329            if(ch == CACA_MAGIC_FULLWIDTH)
330                ch = '?';
331
332            if(fg != prevfg || bg != prevbg)
333            {
334                cur += sprintf(cur, "\033[0;");
335
336                if(fg < 8)
337                    if(bg < 8)
338                        cur += sprintf(cur, "3%d;4%dm", fg, bg);
339                    else
340                        cur += sprintf(cur, "5;3%d;4%dm", fg, bg - 8);
341                else
342                    if(bg < 8)
343                        cur += sprintf(cur, "1;3%d;4%dm", fg - 8, bg);
344                    else
345                        cur += sprintf(cur, "5;1;3%d;4%dm", fg - 8, bg - 8);
346            }
347
348            *cur++ = caca_utf32_to_cp437(ch);
349
350            prevfg = fg;
351            prevbg = bg;
352        }
353
354        if(cv->width == 80)
355        {
356            cur += sprintf(cur, "\033[s\n\033[u");
357        }
358        else
359        {
360            cur += sprintf(cur, "\033[0m\r\n");
361            prevfg = -1;
362            prevbg = -1;
363        }
364    }
365
366    /* Crop to really used size */
367    debug("ansi export: alloc %lu bytes, realloc %lu",
368          (unsigned long int)*bytes, (unsigned long int)(cur - data));
369    *bytes = (uintptr_t)(cur - data);
370    data = realloc(data, *bytes);
371
372    return data;
373}
374
375/* Generate HTML representation of current canvas. */
376static void *export_html(caca_canvas_t const *cv, size_t *bytes)
377{
378    char *data, *cur;
379    int x, y, len;
380
381    /* The HTML header: less than 1000 bytes
382     * A line: 7 chars for "<br />\n"
383     * A glyph: 47 chars for "<span style="color:#xxx;background-color:#xxx">"
384     *          83 chars for ";font-weight..."
385     *          up to 10 chars for "&#xxxxxxx;", far less for pure ASCII
386     *          7 chars for "</span>" */
387    *bytes = 1000 + cv->height * (7 + cv->width * (47 + 83 + 10 + 7));
388    cur = data = malloc(*bytes);
389
390    /* HTML header */
391
392    cur += sprintf(cur, "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"\n");
393    cur += sprintf(cur, "   \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n");
394    cur += sprintf(cur, "<html xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"en\" xml:lang=\"en\">");
395    cur += sprintf(cur, "<head>\n");
396    cur += sprintf(cur, "<title>Generated by libcaca %s</title>\n",
397                        caca_get_version());
398    cur += sprintf(cur, "</head><body>\n");
399
400    cur += sprintf(cur, "<div style=\"%s\">\n",
401                        "font-family: monospace, fixed; font-weight: bold;");
402
403    for(y = 0; y < cv->height; y++)
404    {
405        uint32_t *lineattr = cv->attrs + y * cv->width;
406        uint32_t *linechar = cv->chars + y * cv->width;
407
408        for(x = 0; x < cv->width; x += len)
409        {
410            cur += sprintf(cur, "<span style=\"");
411            if(caca_attr_to_ansi_fg(lineattr[x]) != CACA_DEFAULT)
412                cur += sprintf(cur, ";color:#%.03x",
413                               caca_attr_to_rgb12_fg(lineattr[x]));
414            if(caca_attr_to_ansi_bg(lineattr[x]) < 0x10)
415                cur += sprintf(cur, ";background-color:#%.03x",
416                               caca_attr_to_rgb12_bg(lineattr[x]));
417            if(lineattr[x] & CACA_BOLD)
418                cur += sprintf(cur, ";font-weight:bold");
419            if(lineattr[x] & CACA_ITALICS)
420                cur += sprintf(cur, ";font-style:italic");
421            if(lineattr[x] & CACA_UNDERLINE)
422                cur += sprintf(cur, ";text-decoration:underline");
423            if(lineattr[x] & CACA_BLINK)
424                cur += sprintf(cur, ";text-decoration:blink");
425            cur += sprintf(cur, "\">");
426
427            for(len = 0;
428                x + len < cv->width && lineattr[x + len] == lineattr[x];
429                len++)
430            {
431                if(linechar[x + len] == CACA_MAGIC_FULLWIDTH)
432                    ;
433                else if((linechar[x + len] <= 0x00000020)
434                        ||
435                        ((linechar[x + len] >= 0x0000007f)
436                         &&
437                         (linechar[x + len] <= 0x000000a0)))
438                {
439                    /* Control characters and space converted to
440                     * U+00A0 NO-BREAK SPACE, a.k.a. "&nbsp;" in HTML,
441                     * but we use the equivalent numeric character
442                     * reference &#160; so this will work in plain
443                     * XHTML with no DTD too. */
444                    cur += sprintf(cur, "&#160;");
445                }
446                else if(linechar[x + len] == '&')
447                    cur += sprintf(cur, "&amp;");
448                else if(linechar[x + len] == '<')
449                    cur += sprintf(cur, "&lt;");
450                else if(linechar[x + len] == '>')
451                    cur += sprintf(cur, "&gt;");
452                else if(linechar[x + len] == '\"')
453                    cur += sprintf(cur, "&quot;");
454                else if(linechar[x + len] == '\'')
455                    cur += sprintf(cur, "&#39;");
456                else if(linechar[x + len] < 0x00000080)
457                    cur += sprintf(cur, "%c", (uint8_t)linechar[x + len]);
458                else if((linechar[x + len] <= 0x0010fffd)
459                        &&
460                        ((linechar[x + len] & 0x0000fffe) != 0x0000fffe)
461                        &&
462                        ((linechar[x + len] < 0x0000d800)
463                         ||
464                         (linechar[x + len] > 0x0000dfff)))
465                    cur += sprintf(cur, "&#%i;", (unsigned int)linechar[x + len]);
466                else
467                    /* non-character codepoints become U+FFFD
468                     * REPLACEMENT CHARACTER */
469                    cur += sprintf(cur, "&#%i;", (unsigned int)0x0000fffd);
470            }
471            cur += sprintf(cur, "</span>");
472        }
473        /* New line */
474        cur += sprintf(cur, "<br />\n");
475    }
476
477    cur += sprintf(cur, "</div></body></html>\n");
478
479    /* Crop to really used size */
480    debug("html export: alloc %lu bytes, realloc %lu",
481          (unsigned long int)*bytes, (unsigned long int)(cur - data));
482    *bytes = (uintptr_t)(cur - data);
483    data = realloc(data, *bytes);
484
485    return data;
486}
487
488/* Export an HTML3 document. This function is way bigger than export_html(),
489 * but permits viewing in old browsers (or limited ones such as links). It
490 * will not work under gecko (mozilla rendering engine) unless you set a
491 * correct header. */
492static void *export_html3(caca_canvas_t const *cv, size_t *bytes)
493{
494    char *data, *cur;
495    int x, y, len;
496    int has_multi_cell_row = 0;
497    unsigned char *cell_boundary_bitmap;
498
499    /* Table */
500    cell_boundary_bitmap = (unsigned char *) malloc((cv->width + 7) / 8);
501    if(cell_boundary_bitmap)
502        memset((void *) cell_boundary_bitmap, 0, (cv->width + 7) / 8);
503    for(y = 0; y < cv->height; y++)
504    {
505        uint32_t *lineattr = cv->attrs + y * cv->width;
506
507        for(x = 1; x < cv->width; x++)
508            if((! (cell_boundary_bitmap
509                   ?
510                   (cell_boundary_bitmap[x / 8] & (1 << (x % 8)))
511                   :
512                   has_multi_cell_row))
513               &&
514               ((caca_attr_to_ansi_bg(lineattr[x - 1])
515                 !=
516                 caca_attr_to_ansi_bg(lineattr[x]))
517                ||
518                ((caca_attr_to_ansi_bg(lineattr[x]) < 0x10)
519                 ?
520                 (_caca_attr_to_rgb24bg(lineattr[x - 1])
521                  !=
522                  _caca_attr_to_rgb24bg(lineattr[x]))
523                 :
524                 0)))
525            {
526                has_multi_cell_row = 1;
527                if(cell_boundary_bitmap)
528                    cell_boundary_bitmap[x / 8] |= 1 << (x % 8);
529            }
530    }
531   
532    /* The HTML table markup: less than 1000 bytes
533     * A line: 10 chars for "<tr></tr>\n"
534     * A glyph: up to 48 chars for "<td bgcolor=\"#xxxxxx\"><tt><font color=\"#xxxxxx\">"
535     *          up to 36 chars for "<b><i><u><blink></blink></u></i></b>"
536     *          up to 10 chars for "&#xxxxxxx;" (far less for pure ASCII)
537     *          17 chars for "</font></tt></td>" */
538    *bytes = 1000 + cv->height * (10 + cv->width * (48 + 36 + 10 + 17));
539    cur = data = malloc(*bytes);
540
541    cur += sprintf(cur, "<table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" summary=\"[libcaca canvas export]\">\n");
542
543    for(y = 0; y < cv->height; y++)
544    {
545        uint32_t *lineattr = cv->attrs + y * cv->width;
546        uint32_t *linechar = cv->chars + y * cv->width;
547
548        cur += sprintf(cur, "<tr>");
549
550        for(x = 0; x < cv->width; x += len)
551        {
552            int i, needfont = 0;
553            int nonblank = 0;
554
555            /* Use colspan option to factor cells with same attributes
556             * (see below) */
557            len = 1;
558            while((x + len < cv->width)
559                  &&
560                  (y
561                   ||
562                   (! (cell_boundary_bitmap
563                       ?
564                       (cell_boundary_bitmap[(x + len) / 8] & (1 << ((x + len) % 8)))
565                       :
566                       has_multi_cell_row))
567                   ||
568                   (linechar[x + len] == CACA_MAGIC_FULLWIDTH)
569                   ||
570                   (cv->height == 1))
571                  &&
572                  (caca_attr_to_ansi_bg(lineattr[x + len])
573                   ==
574                   caca_attr_to_ansi_bg(lineattr[x]))
575                  &&
576                  ((caca_attr_to_ansi_bg(lineattr[x]) < 0x10)
577                   ?
578                   (_caca_attr_to_rgb24bg(lineattr[x + len])
579                    ==
580                    _caca_attr_to_rgb24bg(lineattr[x]))
581                   :
582                   1))
583                len++;
584
585            for(i = 0; i < len; i++)
586                if(! ((linechar[x + i] <= 0x00000020)
587                      ||
588                      ((linechar[x + i] >= 0x0000007f)
589                       &&
590                       (linechar[x + i] <= 0x000000a0))))
591                    nonblank = 1;
592
593            cur += sprintf(cur, "<td");
594
595            if(caca_attr_to_ansi_bg(lineattr[x]) < 0x10)
596                cur += sprintf(cur, " bgcolor=\"#%.06lx\"", (unsigned long int)
597                               _caca_attr_to_rgb24bg(lineattr[x]));
598
599            if(has_multi_cell_row && (len > 1))
600            {
601                int colspan;
602
603                colspan = len;
604                if(cell_boundary_bitmap)
605                    for(i = 0; i < len; i ++)
606                        if(i
607                           &&
608                           ! (cell_boundary_bitmap[(x + i) / 8]
609                              &
610                              (1 << ((x + i) % 8))))
611                            colspan --;
612                if(colspan > 1)
613                    cur += sprintf(cur, " colspan=\"%d\"", colspan);
614            }
615
616            cur += sprintf(cur, ">");
617
618            cur += sprintf(cur, "<tt>");
619
620            for(i = 0; i < len; i++)
621            {
622                if(nonblank
623                   &&
624                   ((! i)
625                    ||
626                    (lineattr[x + i] != lineattr[x + i - 1])))
627                {
628                    needfont = (caca_attr_to_ansi_fg(lineattr[x + i])
629                                !=
630                                CACA_DEFAULT);
631
632                    if(needfont)
633                        cur += sprintf(cur, "<font color=\"#%.06lx\">",
634                                       (unsigned long int)
635                                       _caca_attr_to_rgb24fg(lineattr[x + i]));
636
637                    if(lineattr[x + i] & CACA_BOLD)
638                        cur += sprintf(cur, "<b>");
639                    if(lineattr[x + i] & CACA_ITALICS)
640                        cur += sprintf(cur, "<i>");
641                    if(lineattr[x + i] & CACA_UNDERLINE)
642                        cur += sprintf(cur, "<u>");
643                    if(lineattr[x + i] & CACA_BLINK)
644                        cur += sprintf(cur, "<blink>");
645                }
646
647                if(linechar[x + i] == CACA_MAGIC_FULLWIDTH)
648                    ;
649                else if((linechar[x + i] <= 0x00000020)
650                        ||
651                        ((linechar[x + i] >= 0x0000007f)
652                         &&
653                         (linechar[x + i] <= 0x000000a0)))
654                {
655                    /* Control characters and space converted to
656                     * U+00A0 NO-BREAK SPACE, a.k.a. "&nbsp;" in HTML,
657                     * but we use the equivalent numeric character
658                     * reference &#160; so this will work in plain
659                     * XHTML with no DTD too. */
660                    cur += sprintf(cur, "&#160;");
661                }
662                else if(linechar[x + i] == '&')
663                    cur += sprintf(cur, "&amp;");
664                else if(linechar[x + i] == '<')
665                    cur += sprintf(cur, "&lt;");
666                else if(linechar[x + i] == '>')
667                    cur += sprintf(cur, "&gt;");
668                else if(linechar[x + i] == '\"')
669                    cur += sprintf(cur, "&quot;");
670                else if(linechar[x + i] == '\'')
671                    cur += sprintf(cur, "&#39;");
672                else if(linechar[x + i] < 0x00000080)
673                    cur += sprintf(cur, "%c", (uint8_t)linechar[x + i]);
674                else if((linechar[x + i] <= 0x0010fffd)
675                        &&
676                        ((linechar[x + i] & 0x0000fffe) != 0x0000fffe)
677                        &&
678                        ((linechar[x + i] < 0x0000d800)
679                         ||
680                         (linechar[x + i] > 0x0000dfff)))
681                    cur += sprintf(cur, "&#%i;", (unsigned int)linechar[x + i]);
682                else
683                    /* non-character codepoints become U+FFFD
684                     * REPLACEMENT CHARACTER */
685                    cur += sprintf(cur, "&#%i;", (unsigned int)0x0000fffd);
686
687                if (nonblank
688                    &&
689                    (((i + 1) == len)
690                     ||
691                     (lineattr[x + i + 1] != lineattr[x + i])))
692                {
693                    if(lineattr[x + i] & CACA_BLINK)
694                        cur += sprintf(cur, "</blink>");
695                    if(lineattr[x + i] & CACA_UNDERLINE)
696                        cur += sprintf(cur, "</u>");
697                    if(lineattr[x + i] & CACA_ITALICS)
698                        cur += sprintf(cur, "</i>");
699                    if(lineattr[x + i] & CACA_BOLD)
700                        cur += sprintf(cur, "</b>");
701
702                    if(needfont)
703                        cur += sprintf(cur, "</font>");
704                }
705            }
706
707            cur += sprintf(cur, "</tt>");
708            cur += sprintf(cur, "</td>");
709        }
710        cur += sprintf(cur, "</tr>\n");
711    }
712
713    /* Footer */
714    cur += sprintf(cur, "</table>\n");
715
716    /* Free working memory */
717    if (cell_boundary_bitmap)
718        free((void *) cell_boundary_bitmap);
719
720    /* Crop to really used size */
721    debug("html3 export: alloc %lu bytes, realloc %lu",
722          (unsigned long int)*bytes, (unsigned long int)(cur - data));
723    *bytes = (uintptr_t)(cur - data);
724    data = realloc(data, *bytes);
725
726    return data;
727}
728
729static void *export_bbfr(caca_canvas_t const *cv, size_t *bytes)
730{
731    char *data, *cur;
732    int x, y, len;
733
734    /* The font markup: less than 100 bytes
735     * A line: 1 char for "\n"
736     * A glyph: 22 chars for "[f=#xxxxxx][c=#xxxxxx]"
737     *          up to 21 chars for "[g][i][s][/s][/i][/g]"
738     *          up to 6 chars for the UTF-8 glyph
739     *          8 chars for "[/c][/f]" */
740    *bytes = 100 + cv->height * (1 + cv->width * (22 + 21 + 6 + 8));
741    cur = data = malloc(*bytes);
742
743    /* Table */
744    cur += sprintf(cur, "[font=Courier New]");
745
746    for(y = 0; y < cv->height; y++)
747    {
748        uint32_t *lineattr = cv->attrs + y * cv->width;
749        uint32_t *linechar = cv->chars + y * cv->width;
750
751        for(x = 0; x < cv->width; x += len)
752        {
753            int i, needback, needfront;
754
755            /* Use colspan option to factor cells with same attributes
756             * (see below) */
757            len = 1;
758            if(linechar[x] == ' ')
759                while(x + len < cv->width && lineattr[x + len] == lineattr[x]
760                        && linechar[x] == ' ')
761                    len++;
762            else
763                while(x + len < cv->width && lineattr[x + len] == lineattr[x]
764                        && linechar[x] != ' ')
765                    len++;
766
767            needback = caca_attr_to_ansi_bg(lineattr[x]) < 0x10;
768            needfront = caca_attr_to_ansi_fg(lineattr[x]) < 0x10;
769
770            if(needback)
771                cur += sprintf(cur, "[f=#%.06lx]", (unsigned long int)
772                               _caca_attr_to_rgb24bg(lineattr[x]));
773
774            if(linechar[x] == ' ')
775                cur += sprintf(cur, "[c=#%.06lx]", (unsigned long int)
776                               _caca_attr_to_rgb24bg(lineattr[x]));
777            else if(needfront)
778                cur += sprintf(cur, "[c=#%.06lx]", (unsigned long int)
779                               _caca_attr_to_rgb24fg(lineattr[x]));
780
781            if(lineattr[x] & CACA_BOLD)
782                cur += sprintf(cur, "[g]");
783            if(lineattr[x] & CACA_ITALICS)
784                cur += sprintf(cur, "[i]");
785            if(lineattr[x] & CACA_UNDERLINE)
786                cur += sprintf(cur, "[s]");
787            if(lineattr[x] & CACA_BLINK)
788                ; /* FIXME */
789
790            for(i = 0; i < len; i++)
791            {
792                if(linechar[x + i] == CACA_MAGIC_FULLWIDTH)
793                    ;
794                else if(linechar[x + i] == ' ')
795                    *cur++ = '_';
796                else
797                    cur += caca_utf32_to_utf8(cur, linechar[x + i]);
798            }
799
800            if(lineattr[x] & CACA_BLINK)
801                ; /* FIXME */
802            if(lineattr[x] & CACA_UNDERLINE)
803                cur += sprintf(cur, "[/s]");
804            if(lineattr[x] & CACA_ITALICS)
805                cur += sprintf(cur, "[/i]");
806            if(lineattr[x] & CACA_BOLD)
807                cur += sprintf(cur, "[/g]");
808
809            if(linechar[x] == ' ' || needfront)
810                cur += sprintf(cur, "[/c]");
811            if(needback)
812                cur += sprintf(cur, "[/f]");
813        }
814        cur += sprintf(cur, "\n");
815    }
816
817    /* Footer */
818    cur += sprintf(cur, "[/font]\n");
819
820    /* Crop to really used size */
821    debug("bbfr export: alloc %lu bytes, realloc %lu",
822          (unsigned long int)*bytes, (unsigned long int)(cur - data));
823    *bytes = (uintptr_t)(cur - data);
824    data = realloc(data, *bytes);
825
826    return data;
827}
828
829/* Export a text file with IRC colours */
830static void *export_irc(caca_canvas_t const *cv, size_t *bytes)
831{
832    static uint8_t const palette[] =
833    {
834        1, 2, 3, 10, 5, 6, 7, 15, /* Dark */
835        14, 12, 9, 11, 4, 13, 8, 0, /* Light */
836    };
837
838    char *data, *cur;
839    int x, y;
840
841    /* 14 bytes assumed for max length per pixel. Worst case scenario:
842     * ^Cxx,yy   6 bytes
843     * ^B^B      2 bytes
844     * ch        6 bytes
845     * 3 bytes for max length per line. Worst case scenario:
846     * <spc>     1 byte (for empty lines)
847     * \r\n      2 bytes
848     * In real life, the average bytes per pixel value will be around 5.
849     */
850
851    *bytes = 2 + cv->height * (3 + cv->width * 14);
852    cur = data = malloc(*bytes);
853
854    for(y = 0; y < cv->height; y++)
855    {
856        uint32_t *lineattr = cv->attrs + y * cv->width;
857        uint32_t *linechar = cv->chars + y * cv->width;
858
859        uint8_t prevfg = 0x10;
860        uint8_t prevbg = 0x10;
861
862        for(x = 0; x < cv->width; x++)
863        {
864            uint32_t attr = lineattr[x];
865            uint32_t ch = linechar[x];
866            uint8_t ansifg, ansibg, fg, bg;
867
868            if(ch == CACA_MAGIC_FULLWIDTH)
869                continue;
870
871            ansifg = caca_attr_to_ansi_fg(attr);
872            ansibg = caca_attr_to_ansi_bg(attr);
873
874            fg = ansifg < 0x10 ? palette[ansifg] : 0x10;
875            bg = ansibg < 0x10 ? palette[ansibg] : 0x10;
876
877            /* TODO: optimise series of same fg / same bg
878             *       don't change fg value if ch == ' '
879             *       make sure the \x03,%d trick works everywhere */
880            if(bg != prevbg || fg != prevfg)
881            {
882                int need_escape = 0;
883
884                if(bg == 0x10)
885                {
886                    if(fg == 0x10)
887                        cur += sprintf(cur, "\x0f");
888                    else
889                    {
890                        if(prevbg == 0x10)
891                            cur += sprintf(cur, "\x03%d", fg);
892                        else
893                            cur += sprintf(cur, "\x0f\x03%d", fg);
894
895                        if(ch == (uint32_t)',')
896                            need_escape = 1;
897                    }
898                }
899                else
900                {
901                    if(fg == 0x10)
902                        cur += sprintf(cur, "\x0f\x03,%d", bg);
903                    else
904                        cur += sprintf(cur, "\x03%d,%d", fg, bg);
905                }
906
907                if(ch >= (uint32_t)'0' && ch <= (uint32_t)'9')
908                    need_escape = 1;
909
910                if(need_escape)
911                    cur += sprintf(cur, "\x02\x02");
912            }
913
914            cur += caca_utf32_to_utf8(cur, ch);
915            prevfg = fg;
916            prevbg = bg;
917        }
918
919        /* TODO: do the same the day we optimise whole lines above */
920        if(!cv->width)
921            *cur++ = ' ';
922
923        *cur++ = '\r';
924        *cur++ = '\n';
925    }
926
927    /* Crop to really used size */
928    debug("IRC export: alloc %lu bytes, realloc %lu",
929          (unsigned long int)*bytes, (unsigned long int)(cur - data));
930    *bytes = (uintptr_t)(cur - data);
931    data = realloc(data, *bytes);
932
933    return data;
934}
935
936/* Export a PostScript document. */
937static void *export_ps(caca_canvas_t const *cv, size_t *bytes)
938{
939    static char const *ps_header =
940        "%!\n"
941        "%% libcaca PDF export\n"
942        "%%LanguageLevel: 2\n"
943        "%%Pages: 1\n"
944        "%%DocumentData: Clean7Bit\n"
945        "/csquare {\n"
946        "  newpath\n"
947        "  0 0 moveto\n"
948        "  0 1 rlineto\n"
949        "  1 0 rlineto\n"
950        "  0 -1 rlineto\n"
951        "  closepath\n"
952        "  setrgbcolor\n"
953        "  fill\n"
954        "} def\n"
955        "/S {\n"
956        "  Show\n"
957        "} bind def\n"
958        "/Courier-Bold findfont\n"
959        "8 scalefont\n"
960        "setfont\n"
961        "gsave\n"
962        "6 10 scale\n";
963
964    char *data, *cur;
965    int x, y;
966
967    /* 200 is arbitrary but should be ok */
968    *bytes = strlen(ps_header) + 100 + cv->height * (32 + cv->width * 200);
969    cur = data = malloc(*bytes);
970
971    /* Header */
972    cur += sprintf(cur, "%s", ps_header);
973    cur += sprintf(cur, "0 %d translate\n", cv->height);
974
975    /* Background, drawn using csquare macro defined in header */
976    for(y = cv->height; y--; )
977    {
978        uint32_t *lineattr = cv->attrs + y * cv->width;
979
980        for(x = 0; x < cv->width; x++)
981        {
982            uint8_t argb[8];
983            caca_attr_to_argb64(*lineattr++, argb);
984            cur += sprintf(cur, "1 0 translate\n %f %f %f csquare\n",
985                           (float)argb[1] * (1.0 / 0xf),
986                           (float)argb[2] * (1.0 / 0xf),
987                           (float)argb[3] * (1.0 / 0xf));
988        }
989
990        /* Return to beginning of the line, and jump to the next one */
991        cur += sprintf(cur, "-%d 1 translate\n", cv->width);
992    }
993
994    cur += sprintf(cur, "grestore\n"); /* Restore transformation matrix */
995    cur += sprintf(cur, "0 %d translate\n", cv->height*10);
996
997    for(y = cv->height; y--; )
998    {
999        uint32_t *lineattr = cv->attrs + (cv->height - y - 1) * cv->width;
1000        uint32_t *linechar = cv->chars + (cv->height - y - 1) * cv->width;
1001
1002        for(x = 0; x < cv->width; x++)
1003        {
1004            uint8_t argb[8];
1005            uint32_t ch = *linechar++;
1006
1007            caca_attr_to_argb64(*lineattr++, argb);
1008
1009            cur += sprintf(cur, "newpath\n");
1010            cur += sprintf(cur, "%d %d moveto\n", (x + 1) * 6, y * 10 + 2);
1011            cur += sprintf(cur, "%f %f %f setrgbcolor\n",
1012                           (float)argb[5] * (1.0 / 0xf),
1013                           (float)argb[6] * (1.0 / 0xf),
1014                           (float)argb[7] * (1.0 / 0xf));
1015
1016            if(ch < 0x00000020)
1017                cur += sprintf(cur, "(?) show\n");
1018            else if(ch >= 0x00000080)
1019                cur += sprintf(cur, "(?) show\n");
1020            else switch((uint8_t)(ch & 0x7f))
1021            {
1022                case '\\':
1023                case '(':
1024                case ')':
1025                    cur += sprintf(cur, "(\\%c) show\n", (uint8_t)ch);
1026                    break;
1027                default:
1028                    cur += sprintf(cur, "(%c) show\n", (uint8_t)ch);
1029                    break;
1030            }
1031        }
1032    }
1033
1034    cur += sprintf(cur, "showpage\n");
1035
1036    /* Crop to really used size */
1037    debug("PS export: alloc %lu bytes, realloc %lu",
1038          (unsigned long int)*bytes, (unsigned long int)(cur - data));
1039    *bytes = (uintptr_t)(cur - data);
1040    data = realloc(data, *bytes);
1041
1042    return data;
1043}
1044
1045/* Export an SVG vector image */
1046static void *export_svg(caca_canvas_t const *cv, size_t *bytes)
1047{
1048    static char const svg_header[] =
1049        "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1050        "<svg width=\"%d\" height=\"%d\" viewBox=\"0 0 %d %d\""
1051        " xmlns=\"http://www.w3.org/2000/svg\""
1052        " xmlns:xlink=\"http://www.w3.org/1999/xlink\""
1053        " xml:space=\"preserve\" version=\"1.1\"  baseProfile=\"full\">\n";
1054
1055    char *data, *cur;
1056    int x, y;
1057
1058    /* 200 is arbitrary but should be ok */
1059    *bytes = strlen(svg_header) + 128 + cv->width * cv->height * 200;
1060    cur = data = malloc(*bytes);
1061
1062    /* Header */
1063    cur += sprintf(cur, svg_header, cv->width * 6, cv->height * 10,
1064                                    cv->width * 6, cv->height * 10);
1065
1066    cur += sprintf(cur, " <g id=\"mainlayer\" font-size=\"10\""
1067                        " style=\"font-family: monospace\">\n");
1068
1069    /* Background */
1070    for(y = 0; y < cv->height; y++)
1071    {
1072        uint32_t *lineattr = cv->attrs + y * cv->width;
1073
1074        for(x = 0; x < cv->width; x++)
1075        {
1076            cur += sprintf(cur, "<rect style=\"fill:#%.03x\" x=\"%d\" y=\"%d\""
1077                                " width=\"6\" height=\"10\"/>\n",
1078                                caca_attr_to_rgb12_bg(*lineattr++),
1079                                x * 6, y * 10);
1080        }
1081    }
1082
1083    /* Text */
1084    for(y = 0; y < cv->height; y++)
1085    {
1086        uint32_t *lineattr = cv->attrs + y * cv->width;
1087        uint32_t *linechar = cv->chars + y * cv->width;
1088
1089        for(x = 0; x < cv->width; x++)
1090        {
1091            uint32_t ch = *linechar++;
1092
1093            if(ch == ' ' || ch == CACA_MAGIC_FULLWIDTH)
1094            {
1095                lineattr++;
1096                continue;
1097            }
1098
1099            cur += sprintf(cur, "<text style=\"fill:#%.03x\" "
1100                                "x=\"%d\" y=\"%d\">",
1101                                caca_attr_to_rgb12_fg(*lineattr++),
1102                                x * 6, (y * 10) + 8);
1103
1104            if(ch < 0x00000020)
1105                *cur++ = '?';
1106            else if(ch > 0x0000007f)
1107                cur += caca_utf32_to_utf8(cur, ch);
1108            else switch((uint8_t)ch)
1109            {
1110                case '>': cur += sprintf(cur, "&gt;"); break;
1111                case '<': cur += sprintf(cur, "&lt;"); break;
1112                case '&': cur += sprintf(cur, "&amp;"); break;
1113                default: *cur++ = ch; break;
1114            }
1115            cur += sprintf(cur, "</text>\n");
1116        }
1117    }
1118
1119    cur += sprintf(cur, " </g>\n");
1120    cur += sprintf(cur, "</svg>\n");
1121
1122    /* Crop to really used size */
1123    debug("SVG export: alloc %lu bytes, realloc %lu",
1124          (unsigned long int)*bytes, (unsigned long int)(cur - data));
1125    *bytes = (uintptr_t)(cur - data);
1126    data = realloc(data, *bytes);
1127
1128    return data;
1129}
1130
1131/* Export a TGA image */
1132static void *export_tga(caca_canvas_t const *cv, size_t *bytes)
1133{
1134    char const * const *fontlist;
1135    char *data, *cur;
1136    caca_font_t *f;
1137    int i, w, h;
1138
1139    fontlist = caca_get_font_list();
1140    if(!fontlist[0])
1141    {
1142        seterrno(EINVAL);
1143        return NULL;
1144    }
1145
1146    f = caca_load_font(fontlist[0], 0);
1147
1148    w = caca_get_canvas_width(cv) * caca_get_font_width(f);
1149    h = caca_get_canvas_height(cv) * caca_get_font_height(f);
1150
1151    *bytes = w * h * 4 + 18; /* 32 bpp + 18 bytes for the header */
1152    cur = data = malloc(*bytes);
1153
1154    /* ID Length */
1155    cur += sprintf(cur, "%c", 0);
1156    /* Color Map Type: no colormap */
1157    cur += sprintf(cur, "%c", 0);
1158    /* Image Type: uncompressed truecolor */
1159    cur += sprintf(cur, "%c", 2);
1160    /* Color Map Specification: no color map */
1161    memset(cur, 0, 5); cur += 5;
1162
1163    /* Image Specification */
1164    cur += sprintf(cur, "%c%c", 0, 0); /* X Origin */
1165    cur += sprintf(cur, "%c%c", 0, 0); /* Y Origin */
1166    cur += sprintf(cur, "%c%c", w & 0xff, w >> 8); /* Width */
1167    cur += sprintf(cur, "%c%c", h & 0xff, h >> 8); /* Height */
1168    cur += sprintf(cur, "%c", 32); /* Pixel Depth */
1169    cur += sprintf(cur, "%c", 40); /* Image Descriptor */
1170
1171    /* Image ID: no ID */
1172    /* Color Map Data: no colormap */
1173
1174    /* Image Data */
1175    caca_render_canvas(cv, f, cur, w, h, 4 * w);
1176
1177    /* Swap bytes. What a waste of time. */
1178    for(i = 0; i < w * h * 4; i += 4)
1179    {
1180        char c;
1181        c = cur[i]; cur[i] = cur[i + 3]; cur[i + 3] = c;
1182        c = cur[i + 1]; cur[i + 1] = cur[i + 2]; cur[i + 2] = c;
1183    }
1184
1185    caca_free_font(f);
1186
1187    return data;
1188}
1189
1190/*
1191 * XXX: The following functions are aliases.
1192 */
1193
1194void *cucul_export_memory(cucul_canvas_t const *, char const *,
1195                          size_t *) CACA_ALIAS(caca_export_memory);
1196char const * const * cucul_get_export_list(void)
1197         CACA_ALIAS(caca_get_export_list);
1198
Note: See TracBrowser for help on using the repository browser.