X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=src%2Foutput%2Fhtml.c;h=60ca95e28dba029683e895dad42e0a7aac91c2a1;hb=5ce9c6ba1502e623ec6723a8273da77e5858b8d4;hp=5aec959c740a16a69888d9f5da76ad2d56778528;hpb=a258e53c63a08b0ec48aea8f03808eb651729424;p=pspp diff --git a/src/output/html.c b/src/output/html.c index 5aec959c74..60ca95e28d 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, 2010 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 @@ -22,49 +23,57 @@ #include #include #include +#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" -#include "output/cairo.h" -#include "output/chart-item.h" +#include "output/cairo-chart.h" +#include "output/chart.h" #include "output/driver-provider.h" -#include "output/message-item.h" #include "output/options.h" -#include "output/output-item-provider.h" +#include "output/output-item.h" +#include "output/pivot-output.h" +#include "output/pivot-table.h" #include "output/table-provider.h" -#include "output/table-item.h" -#include "output/text-item.h" -#include "error.h" -#include "xalloc.h" +#include "gl/minmax.h" +#include "gl/xalloc.h" #include "gettext.h" #define _(msgid) gettext (msgid) +/* 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; - - char *file_name; + struct cell_color fg; + struct cell_color bg; + struct file_handle *handle; char *chart_file_name; - char *command_name; FILE *file; size_t chart_cnt; - bool in_syntax; + bool bare; + bool css; + bool borders; }; static const struct output_driver_class html_driver_class; -static void html_output_table (struct html_driver *, struct table_item *); -static void escape_string (FILE *file, - const char *text, size_t length, - const char *space); +static void html_output_table (struct html_driver *, + const struct output_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); @@ -82,8 +91,92 @@ opt (struct output_driver *d, struct string_map *options, const char *key, return driver_option_get (d, options, key, default_value); } +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); +} + static struct output_driver * -html_create (const char *file_name, enum settings_output_devices device_type, +html_create (struct file_handle *fh, enum settings_output_devices device_type, struct string_map *o) { struct output_driver *d; @@ -91,87 +184,28 @@ html_create (const char *file_name, enum settings_output_devices device_type, html = xzalloc (sizeof *html); d = &html->driver; - output_driver_init (&html->driver, &html_driver_class, file_name, + 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->file_name = xstrdup (file_name); + html->handle = fh; html->chart_file_name = parse_chart_file_name (opt (d, o, "charts", - file_name)); + fh_get_file_name (fh))); html->file = NULL; html->chart_cnt = 1; - - html->file = fn_open (html->file_name, "w"); + html->bg = parse_color (opt (d, o, "background-color", "#FFFFFFFFFFFF")); + html->fg = parse_color (opt (d, o, "foreground-color", "#000000000000")); + html->file = fn_open (html->handle, "w"); if (html->file == NULL) { - error (0, errno, _("error opening output file `%s'"), html->file_name); + msg_error (errno, _("error opening output file `%s'"), fh_get_file_name (html->handle)); goto error; } - fputs ("\n", html->file); - fputs ("\n", html->file); - fputs ("\n", html->file); - print_title_tag (html->file, "TITLE", _("PSPP Output")); - fprintf (html->file, "\n", version); - fputs ("\n", - html->file); - fputs ("\n", html->file); - fputs ("\n", - html->file); - fputs ("\n", html->file); - fputs ("file); - fputs (" LINK=\"#1f00ff\" ALINK=\"#ff0000\" VLINK=\"#9900dd\">\n", html->file); + if (!html->bare) + put_header (html); return d; @@ -187,8 +221,8 @@ 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, "\n", name); } } @@ -200,152 +234,136 @@ html_destroy (struct output_driver *driver) if (html->file != NULL) { - if (html->in_syntax) - { - fprintf (html->file, "\n"); - html->in_syntax = false; - } - fprintf (html->file, - "\n" - "\n" - "\n"); - fn_close (html->file_name, html->file); + if (!html->bare) + fprintf (html->file, + "\n" + "\n" + "\n"); + fn_close (html->handle, html->file); } free (html->chart_file_name); - free (html->file_name); - free (html->command_name); + fh_unref (html->handle); free (html); } -static bool -is_syntax_item (const struct output_item *item) -{ - return (is_text_item (item) - && text_item_get_type (to_text_item (item)) == TEXT_ITEM_SYNTAX); -} - static void -html_submit (struct output_driver *driver, - const struct output_item *output_item) +html_submit__ (struct output_driver *driver, const struct output_item *item, + int level) { struct html_driver *html = html_driver_cast (driver); - output_driver_track_current_command (output_item, &html->command_name); - - if (html->in_syntax && !is_syntax_item (output_item)) - { - fprintf (html->file, "\n"); - html->in_syntax = false; - } - - 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) + switch (item->type) { - 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++); - if (file_name != NULL) + case OUTPUT_ITEM_CHART: + if (html->chart_file_name) { - const char *title = chart_item_get_title (chart_item); - fprintf (html->file, "\"Chart:", - file_name, title ? title : _("No description")); - free (file_name); + char *file_name = xr_draw_png_chart (item->chart, + html->chart_file_name, + html->chart_cnt++, + &html->fg, &html->bg); + if (file_name != NULL) + { + const char *title = chart_get_title (item->chart); + fprintf (html->file, "\"chart:", + file_name, title ? title : _("No description")); + free (file_name); + } } - } -#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); + break; - switch (text_item_get_type (text_item)) - { - case TEXT_ITEM_TITLE: - print_title_tag (html->file, "H1", s); - break; + case OUTPUT_ITEM_GROUP: + for (size_t i = 0; i < item->group.n_children; i++) + html_submit__ (driver, item->group.children[i], level + 1); + break; - case TEXT_ITEM_SUBTITLE: - print_title_tag (html->file, "H2", s); - break; - - case TEXT_ITEM_COMMAND_OPEN: - fprintf (html->file, "
file, s, strlen (s), "_"); - fprintf (html->file, "\">"); - print_title_tag (html->file, "H3", s); - break; + case OUTPUT_ITEM_IMAGE: + if (html->chart_file_name) + { + char *file_name = xr_write_png_image ( + item->image, html->chart_file_name, ++html->chart_cnt); + if (file_name != NULL) + { + fprintf (html->file, "", file_name); + free (file_name); + } + } + break; - case TEXT_ITEM_COMMAND_CLOSE: - fprintf (html->file, "
\n"); - break; + case OUTPUT_ITEM_MESSAGE: + fprintf (html->file, "

"); - case TEXT_ITEM_SUBHEAD: - print_title_tag (html->file, "H4", s); - break; + char *s = msg_to_string (item->message); + escape_string (html->file, s, " ", "
"); + free (s); - case TEXT_ITEM_SYNTAX: - if (!html->in_syntax) - { - fprintf (html->file, "

");
-              html->in_syntax = true;
-            }
-          else
-            putc ('\n', html->file);
-          escape_string (html->file, s, strlen (s), " ");
-          break;
+      fprintf (html->file, "

\n"); + break; - case TEXT_ITEM_PARAGRAPH: - print_title_tag (html->file, "P", s); - break; + case OUTPUT_ITEM_PAGE_BREAK: + break; - case TEXT_ITEM_MONOSPACE: - print_title_tag (html->file, "PRE", s); /* should be

*/ - break; + case OUTPUT_ITEM_TABLE: + html_output_table (html, item); + break; - case TEXT_ITEM_BLANK_LINE: - fputs ("
", html->file); - break; + case OUTPUT_ITEM_TEXT: + { + char *s = text_item_get_plain_text (item); - case TEXT_ITEM_EJECT_PAGE: - /* Nothing to do. */ - break; + switch (item->text.subtype) + { + case TEXT_ITEM_PAGE_TITLE: + break; - case TEXT_ITEM_COMMENT: - case TEXT_ITEM_ECHO: - /* We print out syntax anyway, so nothing to do here either. */ - break; - } - } - else if (is_message_item (output_item)) - { - const struct message_item *message_item = to_message_item (output_item); - const struct msg *msg = message_item_get_msg (message_item); - char *s = msg_to_string (msg, html->command_name); - print_title_tag (html->file, "P", s); - free (s); + case TEXT_ITEM_TITLE: + { + char tag[3] = { 'H', MIN (5, level) + '0', '\0' }; + print_title_tag (html->file, tag, s); + } + break; + + case TEXT_ITEM_SYNTAX: + fprintf (html->file, "

");
+            escape_string (html->file, s, " ", "
"); + fprintf (html->file, "
\n"); + break; + + case TEXT_ITEM_LOG: + fprintf (html->file, "

"); + escape_string (html->file, s, " ", "
"); + fprintf (html->file, "

\n"); + break; + } + + free (s); + } + break; } } -/* Write LENGTH characters in TEXT to file F, escaping characters - as necessary for HTML. Spaces are replaced by SPACE, which - should be " " or " ". */ static void -escape_string (FILE *file, - const char *text, size_t length, - const char *space) +html_submit (struct output_driver *driver, const struct output_item *item) { - while (length-- > 0) + html_submit__ (driver, item, 1); +} + +/* 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 "
" or "\n" or something else appropriate. */ +static void +escape_string (FILE *file, const char *text, + const char *space, const char *newline) +{ + for (;;) { char c = *text++; switch (c) { + case 0: + return; + case '\n': + fputs (newline, file); + break; case '&': fputs ("&", file); break; @@ -368,134 +386,364 @@ escape_string (FILE *file, } } +static const char * +border_to_css (int border) +{ + switch (border) + { + 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 void +style_start (struct css_style *cs, FILE *file) +{ + *cs = (struct css_style) { + .file = file, + .n_styles = 0, + }; +} + +static void +style_end (struct css_style *cs) +{ + if (cs->n_styles > 0) + fputs ("'", cs->file); +} + +static void +next_style (struct css_style *st) +{ + bool first = !st->n_styles++; + fputs (first ? " style='" : "; ", st->file); +} + +static void +put_style (struct css_style *st, const char *name, const char *value) +{ + next_style (st); + fprintf (st->file, "%s: %s", name, value); +} + +static bool +format_color (const struct cell_color color, + const struct cell_color default_color, + char *buf, size_t bufsize) +{ + bool retval = !cell_color_equal (&color, &default_color); + if (retval) + { + if (color.alpha == 255) + snprintf (buf, bufsize, "#%02x%02x%02x", color.r, color.g, color.b); + else + snprintf (buf, bufsize, "rgba(%d, %d, %d, %.3f)", + color.r, color.g, color.b, color.alpha / 255.0); + } + return retval; +} + static void -put_border (FILE *file, int n_borders, int style, const char *border_name) +put_border (const struct table *table, const struct table_cell *cell, + struct css_style *style, + enum table_axis axis, int h, int v, + const char *border_name) { - fprintf (file, "%sborder-%s: %s", - n_borders == 0 ? " STYLE=\"" : "; ", - border_name, - style == TAL_1 ? "thin solid" : "double"); + struct cell_color color; + const char *css = border_to_css ( + table_get_rule (table, axis, cell->d[H][h], cell->d[V][v], &color)); + if (css) + { + next_style (style); + fprintf (style->file, "border-%s: %s", border_name, css); + + char buf[32]; + if (format_color (color, (struct cell_color) CELL_COLOR_BLACK, + buf, sizeof buf)) + fprintf (style->file, " %s", buf); + } } static void -html_output_table (struct html_driver *html, struct table_item *item) +html_put_table_cell (struct html_driver *html, const struct pivot_table *pt, + const struct table_cell *cell, + const char *tag, const struct table *t) { - const struct table *t = table_item_get_table (item); - const char *caption; - int x, y; + fprintf (html->file, "<%s", tag); + + struct css_style style; + style_start (&style, html->file); - fputs ("\n", html->file); + struct string body = DS_EMPTY_INITIALIZER; + bool numeric = pivot_value_format_body (cell->value, pt, &body); - caption = table_item_get_caption (item); - if (caption != NULL) + enum table_halign halign = table_halign_interpret (cell->cell_style->halign, + numeric); + + switch (halign) { - fputs (" \n", html->file); + 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; } - for (y = 0; y < table_nr (t); y++) + if (cell->options & TAB_ROTATE) + put_style (&style, "writing-mode", "sideways-lr"); + + if (cell->cell_style->valign != TABLE_VALIGN_TOP) { - fputs (" \n", html->file); - for (x = 0; x < table_nc (t); x++) + put_style (&style, "vertical-align", + (cell->cell_style->valign == TABLE_VALIGN_BOTTOM + ? "bottom" : "middle")); + } + + const struct font_style *fs = cell->font_style; + char bgcolor[32]; + if (format_color (fs->bg[cell->d[V][0] % 2], + (struct cell_color) CELL_COLOR_WHITE, + bgcolor, sizeof bgcolor)) + put_style (&style, "background", bgcolor); + + char fgcolor[32]; + if (format_color (fs->fg[cell->d[V][0] % 2], + (struct cell_color) CELL_COLOR_BLACK, + fgcolor, sizeof fgcolor)) + put_style (&style, "color", fgcolor); + + if (fs->typeface) + { + put_style (&style, "font-family", "\""); + escape_string (html->file, fs->typeface, " ", "\n"); + putc ('"', html->file); + } + if (fs->bold) + put_style (&style, "font-weight", "bold"); + if (fs->italic) + put_style (&style, "font-style", "italic"); + if (fs->underline) + put_style (&style, "text-decoration", "underline"); + if (fs->size) + { + char buf[32]; + snprintf (buf, sizeof buf, "%dpt", fs->size); + put_style (&style, "font-size", buf); + } + + if (t && html->borders) + { + put_border (t, cell, &style, V, 0, 0, "top"); + put_border (t, cell, &style, H, 0, 0, "left"); + + if (cell->d[V][1] == t->n[V]) + put_border (t, cell, &style, V, 0, 1, "bottom"); + if (cell->d[H][1] == t->n[H]) + put_border (t, cell, &style, H, 1, 0, "right"); + } + style_end (&style); + + int colspan = table_cell_colspan (cell); + if (colspan > 1) + fprintf (html->file, " colspan=\"%d\"", colspan); + + int rowspan = table_cell_rowspan (cell); + if (rowspan > 1) + fprintf (html->file, " rowspan=\"%d\"", rowspan); + + putc ('>', html->file); + + const char *s = ds_cstr (&body); + s += strspn (s, CC_SPACES); + escape_string (html->file, s, " ", "
"); + ds_destroy (&body); + + const struct pivot_value_ex *ex = pivot_value_ex (cell->value); + if (ex->n_subscripts) + { + fputs ("", html->file); + for (size_t i = 0; i < ex->n_subscripts; i++) { - struct table_cell cell; - const char *tag; - bool is_header; - int alignment, colspan, rowspan; - int top, left, right, bottom, n_borders; - const char *s; - - table_get_cell (t, x, y, &cell); - if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0]) - continue; - - /* Output or . */ + fprintf (html->file, "\n", tag); +} - if (x == table_nc (t) - 1) - { - right = table_get_rule (t, TABLE_HORZ, x + 1, y); - if (right > TAL_GAP) - put_border (html->file, n_borders++, right, "right"); - } +static void +html_output_table_layer (struct html_driver *html, const struct pivot_table *pt, + const size_t *layer_indexes) +{ + struct table *title, *layers, *body, *caption, *footnotes; + pivot_output (pt, layer_indexes, true, &title, &layers, &body, + &caption, &footnotes, NULL, NULL); - if (n_borders > 0) - fputs ("\"", html->file); + fputs ("file); + if (pt->notes) + { + fputs (" title=\"", html->file); + escape_string (html->file, pt->notes, " ", "\n"); + putc ('"', html->file); + } + fputs (">\n", html->file); - putc ('>', html->file); + if (title) + { + struct table_cell cell; + table_get_cell (title, 0, 0, &cell); + html_put_table_cell (html, pt, &cell, "caption", NULL); + } - /* Output cell contents. */ - s = cell.contents; - if (cell.options & TAB_EMPH) - fputs ("", html->file); - if (cell.options & TAB_FIX) - { - fputs ("", html->file); - escape_string (html->file, s, strlen (s), " "); - fputs ("", html->file); - } - else + if (layers) + { + fputs ("\n", html->file); + for (size_t y = 0; y < layers->n[V]; y++) + { + fputs ("\n", html->file); + + struct table_cell cell; + table_get_cell (layers, 0, y, &cell); + cell.d[H][1] = body->n[H]; + html_put_table_cell (html, pt, &cell, "td", NULL); + + fputs ("\n", html->file); + } + fputs ("\n", html->file); + } + + fputs ("\n", html->file); + for (int y = 0; y < body->n[V]; y++) + { + fputs ("\n", html->file); + for (int x = 0; x < body->n[H]; ) + { + struct table_cell cell; + table_get_cell (body, x, y, &cell); + if (x == cell.d[TABLE_HORZ][0] && y == cell.d[TABLE_VERT][0]) { - s += strspn (s, CC_SPACES); - escape_string (html->file, s, strlen (s), " "); + bool is_header = (y < body->h[V][0] + || y >= body->n[V] - body->h[V][1] + || x < body->h[H][0] + || x >= body->n[H] - body->h[H][1]); + const char *tag = is_header ? "th" : "td"; + html_put_table_cell (html, pt, &cell, tag, body); } - if (cell.options & TAB_EMPH) - fputs ("", html->file); - /* Output or . */ - fprintf (html->file, "\n", tag); + x = cell.d[TABLE_HORZ][1]; + } + fputs ("\n", html->file); + } + fputs ("\n", html->file); + + if (caption || footnotes) + { + fprintf (html->file, "\n"); + + if (caption) + { + fputs ("\n", html->file); + + struct table_cell cell; + table_get_cell (caption, 0, 0, &cell); + cell.d[H][1] = body->n[H]; + html_put_table_cell (html, pt, &cell, "td", NULL); - table_cell_free (&cell); + fputs ("\n", html->file); } - fputs (" \n", html->file); + + if (footnotes) + for (size_t y = 0; y < footnotes->n[V]; y++) + { + fputs ("\n", html->file); + + struct table_cell cell; + table_get_cell (footnotes, 0, y, &cell); + cell.d[H][1] = body->n[H]; + html_put_table_cell (html, pt, &cell, "td", NULL); + + fputs ("\n", html->file); + } + fputs ("\n", html->file); } - fputs ("
", html->file); - escape_string (html->file, caption, strlen (caption), " "); - fputs ("
or tag. */ - is_header = (y < table_ht (t) - || y >= table_nr (t) - table_hb (t) - || x < table_hl (t) - || x >= table_nc (t) - table_hr (t)); - tag = is_header ? "TH" : "TD"; - fprintf (html->file, " <%s", tag); - - alignment = cell.options & TAB_ALIGNMENT; - if (alignment != TAB_LEFT) - fprintf (html->file, " ALIGN=\"%s\"", - alignment == TAB_RIGHT ? "RIGHT" : "CENTER"); - - colspan = table_cell_colspan (&cell); - if (colspan > 1) - fprintf (html->file, " COLSPAN=\"%d\"", colspan); - - rowspan = table_cell_rowspan (&cell); - if (rowspan > 1) - fprintf (html->file, " ROWSPAN=\"%d\"", rowspan); - - /* Cell borders. */ - n_borders = 0; - - top = table_get_rule (t, TABLE_VERT, x, y); - if (top > TAL_GAP) - put_border (html->file, n_borders++, top, "top"); - - if (y == table_nr (t) - 1) + if (i) + putc (',', html->file); + escape_string (html->file, ex->subscripts[i], " ", "
"); + } + fputs ("", html->file); + } + if (ex->n_footnotes > 0) + { + fputs ("", html->file); + size_t n_footnotes = 0; + for (size_t i = 0; i < ex->n_footnotes; i++) + { + const struct pivot_footnote *f + = pt->footnotes[ex->footnote_indexes[i]]; + if (f->show) { - bottom = table_get_rule (t, TABLE_VERT, x, y + 1); - if (bottom > TAL_GAP) - put_border (html->file, n_borders++, bottom, "bottom"); + if (n_footnotes++ > 0) + putc (',', html->file); + + char *marker = pivot_footnote_marker_string (f, pt); + escape_string (html->file, marker, " ", "
"); + free (marker); } + } + fputs ("
", html->file); + } - left = table_get_rule (t, TABLE_HORZ, x, y); - if (left > TAL_GAP) - put_border (html->file, n_borders++, left, "left"); + /* output
\n\n", html->file); + fputs ("\n\n", html->file); + + table_unref (title); + table_unref (layers); + table_unref (body); + table_unref (caption); + table_unref (footnotes); +} + +static void +html_output_table (struct html_driver *html, const struct output_item *item) +{ + size_t *layer_indexes; + PIVOT_OUTPUT_FOR_EACH_LAYER (layer_indexes, item->table, true) + html_output_table_layer (html, item->table, layer_indexes); } -struct output_driver_factory html_driver_factory = { "html", html_create }; +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, + .name = "html", + .destroy = html_destroy, + .submit = html_submit, + .handles_groups = true, };