X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=src%2Foutput%2Fhtml.c;h=186b1d3f5eefeee4a19edc134644ab18263995e8;hb=2fa892d953b99a7eb121081dc37a87343d2c1003;hp=dfa524a7cfd5f60cd6120023283d1106c635c35a;hpb=1fc57714adfb36009ad22e2a164263b90548bf11;p=pspp diff --git a/src/output/html.c b/src/output/html.c index dfa524a7cf..186b1d3f5e 100644 --- a/src/output/html.c +++ b/src/output/html.c @@ -1,5 +1,6 @@ /* PSPP - a program for statistical analysis. - Copyright (C) 1997-9, 2000, 2009 Free Software Foundation, Inc. + Copyright (C) 1997-9, 2000, 2009, 2010, 2011, 2012, 2013, 2014, 2017, + 2020 Free Software Foundation, Inc. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -15,90 +16,209 @@ along with this program. If not, see . */ #include -#include "chart.h" -#include "htmlP.h" + #include #include #include #include #include #include - -#include -#include -#include -#include -#include -#include -#include -#include - -#include "error.h" -#include "xalloc.h" +#include + +#include "data/file-name.h" +#include "data/file-handle-def.h" +#include "libpspp/assertion.h" +#include "libpspp/cast.h" +#include "libpspp/compiler.h" +#include "libpspp/i18n.h" +#include "libpspp/message.h" +#include "libpspp/version.h" +#ifdef HAVE_CAIRO +#include "output/cairo-chart.h" +#endif +#include "output/chart-item.h" +#include "output/driver-provider.h" +#include "output/message-item.h" +#include "output/options.h" +#include "output/output-item-provider.h" +#include "output/table-provider.h" +#include "output/table-item.h" +#include "output/text-item.h" + +#include "gl/minmax.h" +#include "gl/xalloc.h" #include "gettext.h" #define _(msgid) gettext (msgid) -/* HTML driver options: (defaults listed first) +/* This file uses TABLE_HORZ and TABLE_VERT enough to warrant abbreviating. */ +#define H TABLE_HORZ +#define V TABLE_VERT + +struct html_driver + { + struct output_driver driver; +#ifdef HAVE_CAIRO + struct cell_color fg; + struct cell_color bg; +#endif + struct file_handle *handle; + char *chart_file_name; + + FILE *file; + size_t chart_cnt; + + bool bare; + bool css; + bool borders; + }; - output-file="pspp.html" - chart-files="pspp-#.png" -*/ +static const struct output_driver_class html_driver_class; -static void escape_string (FILE *file, - const char *text, size_t length, - const char *space); -static bool handle_option (void *this, - const char *key, const struct string *val); +static void html_output_table (struct html_driver *, const struct table_item *); +static void escape_string (FILE *file, const char *text, + const char *space, const char *newline); static void print_title_tag (FILE *file, const char *name, const char *content); -static bool -html_open_driver (const char *name, int types, struct substring options) +static struct html_driver * +html_driver_cast (struct output_driver *driver) { - struct outp_driver *this; - struct html_driver_ext *x; + assert (driver->class == &html_driver_class); + return UP_CAST (driver, struct html_driver, driver); +} - this = outp_allocate_driver (&html_class, name, types); - this->ext = x = xmalloc (sizeof *x); - x->file_name = xstrdup ("pspp.html"); - x->chart_file_name = xstrdup ("pspp-#.png"); - x->file = NULL; - x->chart_cnt = 1; +static struct driver_option * +opt (struct output_driver *d, struct string_map *options, const char *key, + const char *default_value) +{ + return driver_option_get (d, options, key, default_value); +} - outp_parse_options (name, options, handle_option, this); +static void +put_header (struct html_driver *html) +{ + fputs ("\n", html->file); + fprintf (html->file, "file, " lang=\"%s\"", ln); + free (ln); + fprintf (html->file, ">\n"); + fputs ("\n", html->file); + print_title_tag (html->file, "title", _("PSPP Output")); + fprintf (html->file, "\n", version); + fputs ("\n", html->file); + + if (html->css) + { + fputs ("\n", + html->file); + } + fputs ("\n", html->file); + fputs ("\n", html->file); +} - x->file = fn_open (x->file_name, "w"); - if (x->file == NULL) +static struct output_driver * +html_create (struct file_handle *fh, enum settings_output_devices device_type, + struct string_map *o) +{ + struct output_driver *d; + struct html_driver *html; + + html = xzalloc (sizeof *html); + d = &html->driver; + output_driver_init (&html->driver, &html_driver_class, fh_get_file_name (fh), + device_type); + html->bare = parse_boolean (opt (d, o, "bare", "false")); + html->css = parse_boolean (opt (d, o, "css", "true")); + html->borders = parse_boolean (opt (d, o, "borders", "true")); + + html->handle = fh; + html->chart_file_name = parse_chart_file_name (opt (d, o, "charts", + fh_get_file_name (fh))); + html->file = NULL; + html->chart_cnt = 1; +#ifdef HAVE_CAIRO + html->bg = parse_color (opt (d, o, "background-color", "#FFFFFFFFFFFF")); + html->fg = parse_color (opt (d, o, "foreground-color", "#000000000000")); +#endif + html->file = fn_open (html->handle, "w"); + if (html->file == NULL) { - error (0, errno, _("opening HTML output file: %s"), x->file_name); + msg_error (errno, _("error opening output file `%s'"), fh_get_file_name (html->handle)); goto error; } - fputs ("\n", x->file); - fputs ("\n", x->file); - fputs ("\n", x->file); - /* The tag is required, so we use a default if the user - didn't provide one. */ - print_title_tag (x->file, - "TITLE", outp_title ? outp_title : _("PSPP Output")); - fprintf (x->file, "<META NAME=\"generator\" CONTENT=\"%s\">\n", version); - fputs ("<META HTTP-EQUIV=\"Content-Type\" " - "CONTENT=\"text/html; charset=ISO-8859-1\">\n", x->file); - fputs ("</HEAD>\n", x->file); - fputs ("<BODY BGCOLOR=\"#ffffff\" TEXT=\"#000000\"\n", x->file); - fputs (" LINK=\"#1f00ff\" ALINK=\"#ff0000\" VLINK=\"#9900dd\">\n", x->file); - print_title_tag (x->file, "H1", outp_title); - print_title_tag (x->file, "H2", outp_subtitle); - - outp_register_driver (this); - return true; + if (!html->bare) + put_header (html); + + return d; error: - this->class->close_driver (this); - outp_free_driver (this); - return false; + output_driver_destroy (d); + return NULL; } /* Emits <NAME>CONTENT</NAME> to the output, escaping CONTENT as @@ -108,135 +228,117 @@ print_title_tag (FILE *file, const char *name, const char *content) { if (content != NULL) { - fprintf (file, "<%s>", name); - escape_string (file, content, strlen (content), " "); + fprintf (file, "<%s>", name); + escape_string (file, content, " ", " - "); fprintf (file, "</%s>\n", name); } } -static bool -html_close_driver (struct outp_driver *this) +static void +html_destroy (struct output_driver *driver) { - struct html_driver_ext *x = this->ext; - bool ok; + struct html_driver *html = html_driver_cast (driver); - if (x->file != NULL) + if (html->file != NULL) { - fprintf (x->file, - "</BODY>\n" - "</HTML>\n" - "<!-- end of file -->\n"); - ok = fn_close (x->file_name, x->file) == 0; - x->file = NULL; + if (!html->bare) + fprintf (html->file, + "</body>\n" + "</html>\n" + "<!-- end of file -->\n"); + fn_close (html->handle, html->file); } - else - ok = true; - free (x->chart_file_name); - free (x->file_name); - free (x); - - return ok; + free (html->chart_file_name); + fh_unref (html->handle); + free (html); } -/* Generic option types. */ -enum - { - string_arg, - nonneg_int_arg - }; - -/* All the options that the HTML driver supports. */ -static const struct outp_option option_tab[] = - { - {"output-file", string_arg, 0}, - {"chart-files", string_arg, 1}, - {NULL, 0, 0}, - }; - -static bool -handle_option (void *this_, const char *key, const struct string *val) +static void +html_submit (struct output_driver *driver, + const struct output_item *output_item) { - struct outp_driver *this = this_; - struct html_driver_ext *x = this->ext; - int subcat; + struct html_driver *html = html_driver_cast (driver); - switch (outp_match_keyword (key, option_tab, &subcat)) + if (is_table_item (output_item)) + { + struct table_item *table_item = to_table_item (output_item); + html_output_table (html, table_item); + } +#ifdef HAVE_CAIRO + else if (is_chart_item (output_item) && html->chart_file_name != NULL) { - case -1: - error (0, 0, - _("unknown configuration parameter `%s' for HTML device driver"), - key); - break; - case string_arg: - switch (subcat) + struct chart_item *chart_item = to_chart_item (output_item); + char *file_name; + + file_name = xr_draw_png_chart (chart_item, html->chart_file_name, + html->chart_cnt++, + &html->fg, + &html->bg + ); + if (file_name != NULL) { - case 0: - free (x->file_name); - x->file_name = ds_xstrdup (val); - break; - case 1: - if (ds_find_char (val, '#') != SIZE_MAX) - { - free (x->chart_file_name); - x->chart_file_name = ds_xstrdup (val); - } - else - error (0, 0, _("`chart-files' value must contain `#'")); - break; - default: - NOT_REACHED (); + const char *title = chart_item_get_title (chart_item); + fprintf (html->file, "<img src=\"%s\" alt=\"chart: %s\">", + file_name, title ? title : _("No description")); + free (file_name); } - break; - default: - NOT_REACHED (); } +#endif /* HAVE_CAIRO */ + else if (is_text_item (output_item)) + { + struct text_item *text_item = to_text_item (output_item); + const char *s = text_item_get_text (text_item); - return true; -} - -static void output_tab_table (struct outp_driver *, struct tab_table *); - -static void -html_output_chart (struct outp_driver *this, const struct chart *chart) -{ - struct html_driver_ext *x = this->ext; - char *file_name; - - file_name = chart_draw_png (chart, x->chart_file_name, x->chart_cnt++); - fprintf (x->file, "<IMG SRC=\"%s\"/>", file_name); - free (file_name); -} + switch (text_item_get_type (text_item)) + { + case TEXT_ITEM_PAGE_TITLE: + break; -static void -html_submit (struct outp_driver *this, struct som_entity *s) -{ - extern struct som_table_class tab_table_class; + case TEXT_ITEM_TITLE: + { + int level = MIN (5, output_get_group_level ()) + 1; + char tag[3] = { 'H', level + '1', '\0' }; + print_title_tag (html->file, tag, s); + } + break; - assert (s->class == &tab_table_class ) ; + case TEXT_ITEM_SYNTAX: + fprintf (html->file, "<pre class=\"syntax\">"); + escape_string (html->file, s, " ", "<br>"); + fprintf (html->file, "</pre>\n"); + break; - switch (s->type) + case TEXT_ITEM_LOG: + print_title_tag (html->file, "pre", s); /* should be <P><TT> */ + break; + } + } + else if (is_message_item (output_item)) { - case SOM_TABLE: - output_tab_table ( this, (struct tab_table *) s->ext); - break; - default: - NOT_REACHED (); + const struct message_item *message_item = to_message_item (output_item); + char *s = msg_to_string (message_item_get_msg (message_item)); + print_title_tag (html->file, "p", s); + free (s); } } -/* Write LENGTH characters in TEXT to file F, escaping characters - as necessary for HTML. Spaces are replaced by SPACE, which - should be " " or " ". */ +/* Write TEXT to file F, escaping characters as necessary for HTML. Spaces are + replaced by SPACE, which should be " " or " " New-lines are replaced by + NEWLINE, which might be "<BR>" or "\n" or something else appropriate. */ static void -escape_string (FILE *file, - const char *text, size_t length, - const char *space) +escape_string (FILE *file, const char *text, + const char *space, const char *newline) { - while (length-- > 0) + for (;;) { char c = *text++; switch (c) { + case 0: + return; + case '\n': + fputs (newline, file); + break; case '&': fputs ("&", file); break; @@ -249,6 +351,9 @@ escape_string (FILE *file, case ' ': fputs (space, file); break; + case '"': + fputs (""", file); + break; default: putc (c, file); break; @@ -256,135 +361,332 @@ escape_string (FILE *file, } } -/* Outputs content for a cell with options OPTS and contents - TEXT. */ -void -html_put_cell_contents (struct outp_driver *this, - unsigned int opts, const struct substring text) +static void +escape_tag (FILE *file, const char *tag, + const char *text, const char *space, const char *newline) { - struct html_driver_ext *x = this->ext; + if (!text || !*text) + return; + + fprintf (file, "<%s>", tag); + escape_string (file, text, space, newline); + fprintf (file, "</%s>", tag); +} - if (!(opts & TAB_EMPTY)) +static const char * +border_to_css (int border) +{ + switch (border) { - if (opts & TAB_EMPH) - fputs ("<EM>", x->file); - if (opts & TAB_FIX) - { - fputs ("<TT>", x->file); - escape_string (x->file, ss_data (text), ss_length (text), " "); - fputs ("</TT>", x->file); - } - else + case TABLE_STROKE_NONE: + return NULL; + + case TABLE_STROKE_SOLID: + return "solid"; + + case TABLE_STROKE_DASHED: + return "dashed"; + + case TABLE_STROKE_THICK: + return "thick solid"; + + case TABLE_STROKE_THIN: + return "thin solid"; + + case TABLE_STROKE_DOUBLE: + return "double"; + + default: + return NULL; + } + +} + +struct css_style +{ + FILE *file; + int n_styles; +}; + +static struct css_style * +style_start (FILE *file) +{ + struct css_style *cs = XMALLOC (struct css_style); + cs->file = file; + cs->n_styles = 0; + fputs (" style=\"", file); + return cs; +} + +static void +style_end (struct css_style *cs) +{ + fputs ("\"", cs->file); + free (cs); +} + +static void +put_style (struct css_style *st, const char *name, const char *value) +{ + if (st->n_styles++ > 0) + fputs ("; ", st->file); + fprintf (st->file, "%s: %s", name, value); +} + +static void +put_border (struct css_style *st, int style, const char *border_name) +{ + const char *css = border_to_css (style); + if (css) + { + if (st->n_styles++ > 0) + fputs ("; ", st->file); + fprintf (st->file, "border-%s: %s", border_name, css); + } +} + +static void +put_tfoot (struct html_driver *html, const struct table *t, bool *tfoot) +{ + if (!*tfoot) + { + fputs ("<tfoot>\n", html->file); + fputs ("<tr>\n", html->file); + fprintf (html->file, "<td colspan=%d>\n", t->n[H]); + *tfoot = true; + } + else + fputs ("\n<br>", html->file); +} + +static void +html_put_footnote_markers (struct html_driver *html, + const struct footnote **footnotes, + size_t n_footnotes) +{ + if (n_footnotes > 0) + { + fputs ("<sup>", html->file); + for (size_t i = 0; i < n_footnotes; i++) { - size_t initial_spaces = ss_span (text, ss_cstr (CC_SPACES)); - escape_string (x->file, - ss_data (text) + initial_spaces, - ss_length (text) - initial_spaces, - " "); + const struct footnote *f = footnotes[i]; + + if (i > 0) + putc (',', html->file); + escape_string (html->file, f->marker, " ", "<br>"); } - if (opts & TAB_EMPH) - fputs ("</EM>", x->file); + fputs ("</sup>", html->file); } } -/* Write table T to THIS output driver. */ static void -output_tab_table (struct outp_driver *this, struct tab_table *t) +html_put_table_item_text (struct html_driver *html, + const struct table_item_text *text) { - struct html_driver_ext *x = this->ext; + escape_string (html->file, text->content, " ", "<br>"); + html_put_footnote_markers (html, text->footnotes, text->n_footnotes); +} - if (tab_nr (t) == 1 && tab_nc (t) == 1) +static void +html_put_table_item_layers (struct html_driver *html, + const struct table_item_layers *layers) +{ + for (size_t i = 0; i < layers->n_layers; i++) { - fputs ("<P>", x->file); - html_put_cell_contents (this, t->ct[0], *t->cc); - fputs ("</P>\n", x->file); + if (i) + fputs ("<br>\n", html->file); - return; + const struct table_item_layer *layer = &layers->layers[i]; + escape_string (html->file, layer->content, " ", "<br>"); + html_put_footnote_markers (html, layer->footnotes, layer->n_footnotes); } +} - fputs ("<TABLE BORDER=1>\n", x->file); +static void +html_output_table (struct html_driver *html, const struct table_item *item) +{ + const struct table *t = table_item_get_table (item); + bool tfoot = false; + int y; - if (t->title != NULL) + fputs ("<table", html->file); + if (item->notes) { - fprintf (x->file, " <CAPTION>"); - escape_string (x->file, t->title, strlen (t->title), " "); - fputs ("</CAPTION>\n", x->file); + fputs (" title=\"", html->file); + escape_string (html->file, item->notes, " ", "\n"); + putc ('"', html->file); } + fputs (">\n", html->file); - { - int r; - unsigned char *ct = t->ct; - - for (r = 0; r < tab_nr (t); r++) - { - int c; - - fputs (" <TR>\n", x->file); - for (c = 0; c < tab_nc (t); c++, ct++) - { - struct substring *cc; - const char *tag; - struct tab_joined_cell *j = NULL; - - cc = t->cc + c + r * tab_nc (t); - if (*ct & TAB_JOIN) - { - j = (struct tab_joined_cell *) ss_data (*cc); - cc = &j->contents; - if (j->x1 != c || j->y1 != r) - continue; - } - - /* Output <TD> or <TH> tag. */ - tag = (r < tab_t (t) || r >= tab_nr (t) - tab_b (t) - || c < tab_l (t) || c >= tab_nc (t) - tab_r (t)) ? "TH" : "TD"; - fprintf (x->file, " <%s ALIGN=%s", - tag, - (*ct & TAB_ALIGN_MASK) == TAB_LEFT ? "LEFT" - : (*ct & TAB_ALIGN_MASK) == TAB_RIGHT ? "RIGHT" - : "CENTER"); - if (*ct & TAB_JOIN) - { - if (j->x2 - j->x1 > 1) - fprintf (x->file, " COLSPAN=%d", j->x2 - j->x1); - if (j->y2 - j->y1 > 1) - fprintf (x->file, " ROWSPAN=%d", j->y2 - j->y1); - } - putc ('>', x->file); - - /* Output cell contents. */ - html_put_cell_contents (this, *ct, *cc); - - /* Output </TH> or </TD>. */ - fprintf (x->file, "</%s>\n", tag); - } - fputs (" </TR>\n", x->file); - } - } - - fputs ("</TABLE>\n\n", x->file); -} + const struct table_item_text *caption = table_item_get_caption (item); + if (caption) + { + put_tfoot (html, t, &tfoot); + html_put_table_item_text (html, caption); + } + const struct footnote **f; + size_t n_footnotes = table_collect_footnotes (item, &f); + for (size_t i = 0; i < n_footnotes; i++) + { + put_tfoot (html, t, &tfoot); + escape_tag (html->file, "sup", f[i]->marker, " ", "<br>"); + escape_string (html->file, f[i]->content, " ", "<br>"); + } + free (f); + if (tfoot) + { + fputs ("</td>\n", html->file); + fputs ("</tr>\n", html->file); + fputs ("</tfoot>\n", html->file); + } + const struct table_item_text *title = table_item_get_title (item); + const struct table_item_layers *layers = table_item_get_layers (item); + if (title || layers) + { + fputs ("<caption>", html->file); + if (title) + html_put_table_item_text (html, title); + if (title && layers) + fputs ("<br>\n", html->file); + if (layers) + html_put_table_item_layers (html, layers); + fputs ("</caption>\n", html->file); + } -/* HTML driver class. */ -const struct outp_class html_class = - { - "html", - 1, + fputs ("<tbody>\n", html->file); - html_open_driver, - html_close_driver, + for (y = 0; y < t->n[V]; y++) + { + int x; - NULL, - NULL, - NULL, + fputs ("<tr>\n", html->file); + for (x = 0; x < t->n[H];) + { + struct table_cell cell; + const char *tag; + + table_get_cell (t, x, y, &cell); + if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0]) + goto next_1; + + /* output <td> or <th> tag. */ + bool is_header = (y < t->h[V][0] + || y >= t->n[V] - t->h[V][1] + || x < t->h[H][0] + || x >= t->n[H] - t->h[H][1]); + tag = is_header ? "th" : "td"; + fprintf (html->file, "<%s", tag); + + struct css_style *style = style_start (html->file); + enum table_halign halign = table_halign_interpret ( + cell.style->cell_style.halign, cell.options & TAB_NUMERIC); + + switch (halign) + { + case TABLE_HALIGN_RIGHT: + put_style (style, "text-align", "right"); + break; + case TABLE_HALIGN_CENTER: + put_style (style, "text-align", "center"); + break; + default: + /* Do nothing */ + break; + } + + if (cell.style->cell_style.valign != TABLE_VALIGN_TOP) + { + put_style (style, "vertical-align", + (cell.style->cell_style.valign == TABLE_VALIGN_BOTTOM + ? "bottom" : "middle")); + } - html_output_chart, + int colspan = table_cell_colspan (&cell); + int rowspan = table_cell_rowspan (&cell); - html_submit, + if (html->borders) + { + /* Cell borders. */ + struct cell_color color; - NULL, - NULL, + int top = table_get_rule (t, TABLE_VERT, x, y, &color); + put_border (style, top, "top"); + + if (y + rowspan == t->n[V]) + { + int bottom = table_get_rule (t, TABLE_VERT, x, y + rowspan, + &color); + put_border (style, bottom, "bottom"); + } + + int left = table_get_rule (t, TABLE_HORZ, x, y, &color); + put_border (style, left, "left"); + + if (x + colspan == t->n[H]) + { + int right = table_get_rule (t, TABLE_HORZ, x + colspan, y, + &color); + put_border (style, right, "right"); + } + } + style_end (style); + + if (colspan > 1) + fprintf (html->file, " colspan=\"%d\"", colspan); + + if (rowspan > 1) + fprintf (html->file, " rowspan=\"%d\"", rowspan); + + putc ('>', html->file); + + /* Output cell contents. */ + const char *s = cell.text; + if (cell.options & TAB_FIX) + escape_tag (html->file, "tt", s, " ", "<br>"); + else + { + s += strspn (s, CC_SPACES); + escape_string (html->file, s, " ", "<br>"); + } + + if (cell.n_subscripts) + { + fputs ("<sub>", html->file); + for (size_t i = 0; i < cell.n_subscripts; i++) + { + if (i) + putc (',', html->file); + escape_string (html->file, cell.subscripts[i], + " ", "<br>"); + } + fputs ("</sub>", html->file); + } + if (cell.superscript) + escape_tag (html->file, "sup", cell.superscript, " ", "<br>"); + html_put_footnote_markers (html, cell.footnotes, cell.n_footnotes); + + /* output </th> or </td>. */ + fprintf (html->file, "</%s>\n", tag); + + next_1: + x = cell.d[TABLE_HORZ][1]; + } + fputs ("</tr>\n", html->file); + } + + fputs ("</tbody>\n", html->file); + fputs ("</table>\n\n", html->file); +} + +struct output_driver_factory html_driver_factory = + { "html", "pspp.html", html_create }; + +static const struct output_driver_class html_driver_class = + { + "html", + html_destroy, + html_submit, NULL, };