1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2009, 2010, 2011, 2012, 2013, 2014, 2017,
3 2020 Free Software Foundation, Inc.
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
28 #include "data/file-name.h"
29 #include "data/file-handle-def.h"
30 #include "libpspp/assertion.h"
31 #include "libpspp/cast.h"
32 #include "libpspp/compiler.h"
33 #include "libpspp/i18n.h"
34 #include "libpspp/message.h"
35 #include "libpspp/version.h"
36 #include "output/cairo-chart.h"
37 #include "output/chart-item.h"
38 #include "output/driver-provider.h"
39 #include "output/image-item.h"
40 #include "output/message-item.h"
41 #include "output/options.h"
42 #include "output/output-item-provider.h"
43 #include "output/pivot-output.h"
44 #include "output/pivot-table.h"
45 #include "output/table-provider.h"
46 #include "output/table-item.h"
47 #include "output/text-item.h"
49 #include "gl/minmax.h"
50 #include "gl/xalloc.h"
53 #define _(msgid) gettext (msgid)
55 /* This file uses TABLE_HORZ and TABLE_VERT enough to warrant abbreviating. */
61 struct output_driver driver;
64 struct file_handle *handle;
65 char *chart_file_name;
75 static const struct output_driver_class html_driver_class;
77 static void html_output_table (struct html_driver *, const struct table_item *);
78 static void escape_string (FILE *file, const char *text,
79 const char *space, const char *newline);
80 static void print_title_tag (FILE *file, const char *name,
83 static struct html_driver *
84 html_driver_cast (struct output_driver *driver)
86 assert (driver->class == &html_driver_class);
87 return UP_CAST (driver, struct html_driver, driver);
90 static struct driver_option *
91 opt (struct output_driver *d, struct string_map *options, const char *key,
92 const char *default_value)
94 return driver_option_get (d, options, key, default_value);
98 put_header (struct html_driver *html)
100 fputs ("<!doctype html>\n", html->file);
101 fprintf (html->file, "<html");
102 char *ln = get_language ();
104 fprintf (html->file, " lang=\"%s\"", ln);
106 fprintf (html->file, ">\n");
107 fputs ("<head>\n", html->file);
108 print_title_tag (html->file, "title", _("PSPP Output"));
109 fprintf (html->file, "<meta name=\"generator\" content=\"%s\">\n", version);
110 fputs ("<meta http-equiv=\"content-type\" "
111 "content=\"text/html; charset=utf-8\">\n", html->file);
118 " background: white;\n"
120 " padding: 0em 12em 0em 3em;\n"
124 " margin: 0pt 0pt 0pt 0em\n"
127 " text-indent: 1.5em;\n"
130 " font-size: 150%;\n"
131 " margin-left: -1.33em\n"
134 " font-size: 125%;\n"
135 " font-weight: bold;\n"
136 " margin-left: -.8em\n"
139 " font-size: 100%;\n"
140 " font-weight: bold;\n"
141 " margin-left: -.5em }\n"
143 " font-size: 100%;\n"
144 " margin-left: 0em\n"
146 "h1, h2, h3, h4, h5, h6 {\n"
147 " font-family: sans-serif;\n"
154 " font-family: sans-serif\n"
157 " border-collapse: collapse;\n"
158 " margin-bottom: 1em\n"
161 " text-align: left\n"
163 "th { font-weight: normal }\n"
177 fputs ("</head>\n", html->file);
178 fputs ("<body>\n", html->file);
181 static struct output_driver *
182 html_create (struct file_handle *fh, enum settings_output_devices device_type,
183 struct string_map *o)
185 struct output_driver *d;
186 struct html_driver *html;
188 html = xzalloc (sizeof *html);
190 output_driver_init (&html->driver, &html_driver_class, fh_get_file_name (fh),
192 html->bare = parse_boolean (opt (d, o, "bare", "false"));
193 html->css = parse_boolean (opt (d, o, "css", "true"));
194 html->borders = parse_boolean (opt (d, o, "borders", "true"));
197 html->chart_file_name = parse_chart_file_name (opt (d, o, "charts",
198 fh_get_file_name (fh)));
201 html->bg = parse_color (opt (d, o, "background-color", "#FFFFFFFFFFFF"));
202 html->fg = parse_color (opt (d, o, "foreground-color", "#000000000000"));
203 html->file = fn_open (html->handle, "w");
204 if (html->file == NULL)
206 msg_error (errno, _("error opening output file `%s'"), fh_get_file_name (html->handle));
216 output_driver_destroy (d);
220 /* Emits <NAME>CONTENT</NAME> to the output, escaping CONTENT as
221 necessary for HTML. */
223 print_title_tag (FILE *file, const char *name, const char *content)
227 fprintf (file, "<%s>", name);
228 escape_string (file, content, " ", " - ");
229 fprintf (file, "</%s>\n", name);
234 html_destroy (struct output_driver *driver)
236 struct html_driver *html = html_driver_cast (driver);
238 if (html->file != NULL)
244 "<!-- end of file -->\n");
245 fn_close (html->handle, html->file);
247 free (html->chart_file_name);
248 fh_unref (html->handle);
253 html_submit (struct output_driver *driver,
254 const struct output_item *output_item)
256 struct html_driver *html = html_driver_cast (driver);
258 if (is_table_item (output_item))
260 struct table_item *table_item = to_table_item (output_item);
261 html_output_table (html, table_item);
263 else if (is_image_item (output_item) && html->chart_file_name != NULL)
265 struct image_item *image_item = to_image_item (output_item);
266 char *file_name = xr_write_png_image (
267 image_item->image, html->chart_file_name, ++html->chart_cnt);
268 if (file_name != NULL)
270 fprintf (html->file, "<img src=\"%s\">", file_name);
274 else if (is_chart_item (output_item) && html->chart_file_name != NULL)
276 struct chart_item *chart_item = to_chart_item (output_item);
279 file_name = xr_draw_png_chart (chart_item, html->chart_file_name,
284 if (file_name != NULL)
286 const char *title = chart_item_get_title (chart_item);
287 fprintf (html->file, "<img src=\"%s\" alt=\"chart: %s\">",
288 file_name, title ? title : _("No description"));
292 else if (is_text_item (output_item))
294 struct text_item *text_item = to_text_item (output_item);
295 const char *s = text_item_get_text (text_item);
297 switch (text_item_get_type (text_item))
299 case TEXT_ITEM_PAGE_TITLE:
302 case TEXT_ITEM_TITLE:
304 int level = MIN (5, output_get_group_level ()) + 1;
305 char tag[3] = { 'H', level + '1', '\0' };
306 print_title_tag (html->file, tag, s);
310 case TEXT_ITEM_SYNTAX:
311 fprintf (html->file, "<pre class=\"syntax\">");
312 escape_string (html->file, s, " ", "<br>");
313 fprintf (html->file, "</pre>\n");
317 fprintf (html->file, "<p>");
318 escape_string (html->file, s, " ", "<br>");
319 fprintf (html->file, "</p>\n");
323 else if (is_message_item (output_item))
325 const struct message_item *message_item = to_message_item (output_item);
326 char *s = msg_to_string (message_item_get_msg (message_item));
327 fprintf (html->file, "<p>");
328 escape_string (html->file, s, " ", "<br>");
329 fprintf (html->file, "</p>\n");
334 /* Write TEXT to file F, escaping characters as necessary for HTML. Spaces are
335 replaced by SPACE, which should be " " or " " New-lines are replaced by
336 NEWLINE, which might be "<BR>" or "\n" or something else appropriate. */
338 escape_string (FILE *file, const char *text,
339 const char *space, const char *newline)
349 fputs (newline, file);
352 fputs ("&", file);
355 fputs ("<", file);
358 fputs (">", file);
364 fputs (""", file);
374 border_to_css (int border)
378 case TABLE_STROKE_NONE:
381 case TABLE_STROKE_SOLID:
384 case TABLE_STROKE_DASHED:
387 case TABLE_STROKE_THICK:
388 return "thick solid";
390 case TABLE_STROKE_THIN:
393 case TABLE_STROKE_DOUBLE:
409 style_start (struct css_style *cs, FILE *file)
411 *cs = (struct css_style) {
418 style_end (struct css_style *cs)
420 if (cs->n_styles > 0)
421 fputs ("'", cs->file);
425 next_style (struct css_style *st)
427 bool first = !st->n_styles++;
428 fputs (first ? " style='" : "; ", st->file);
432 put_style (struct css_style *st, const char *name, const char *value)
435 fprintf (st->file, "%s: %s", name, value);
439 format_color (const struct cell_color color,
440 const struct cell_color default_color,
441 char *buf, size_t bufsize)
443 bool retval = !cell_color_equal (&color, &default_color);
446 if (color.alpha == 255)
447 snprintf (buf, bufsize, "#%02x%02x%02x", color.r, color.g, color.b);
449 snprintf (buf, bufsize, "rgba(%d, %d, %d, %.3f)",
450 color.r, color.g, color.b, color.alpha / 255.0);
456 put_border (const struct table *table, const struct table_cell *cell,
457 struct css_style *style,
458 enum table_axis axis, int h, int v,
459 const char *border_name)
461 struct cell_color color;
462 const char *css = border_to_css (
463 table_get_rule (table, axis, cell->d[H][h], cell->d[V][v], &color));
467 fprintf (style->file, "border-%s: %s", border_name, css);
470 if (format_color (color, (struct cell_color) CELL_COLOR_BLACK,
472 fprintf (style->file, " %s", buf);
477 html_put_table_cell (struct html_driver *html, const struct pivot_table *pt,
478 const struct table_cell *cell,
479 const char *tag, const struct table *t)
481 fprintf (html->file, "<%s", tag);
483 struct css_style style;
484 style_start (&style, html->file);
486 struct string body = DS_EMPTY_INITIALIZER;
487 bool numeric = pivot_value_format_body (cell->value, pt, &body);
489 enum table_halign halign = table_halign_interpret (cell->cell_style->halign,
494 case TABLE_HALIGN_RIGHT:
495 put_style (&style, "text-align", "right");
497 case TABLE_HALIGN_CENTER:
498 put_style (&style, "text-align", "center");
505 if (cell->options & TAB_ROTATE)
506 put_style (&style, "writing-mode", "sideways-lr");
508 if (cell->cell_style->valign != TABLE_VALIGN_TOP)
510 put_style (&style, "vertical-align",
511 (cell->cell_style->valign == TABLE_VALIGN_BOTTOM
512 ? "bottom" : "middle"));
515 const struct font_style *fs = cell->font_style;
517 if (format_color (fs->bg[cell->d[V][0] % 2],
518 (struct cell_color) CELL_COLOR_WHITE,
519 bgcolor, sizeof bgcolor))
520 put_style (&style, "background", bgcolor);
523 if (format_color (fs->fg[cell->d[V][0] % 2],
524 (struct cell_color) CELL_COLOR_BLACK,
525 fgcolor, sizeof fgcolor))
526 put_style (&style, "color", fgcolor);
530 put_style (&style, "font-family", "\"");
531 escape_string (html->file, fs->typeface, " ", "\n");
532 putc ('"', html->file);
535 put_style (&style, "font-weight", "bold");
537 put_style (&style, "font-style", "italic");
539 put_style (&style, "text-decoration", "underline");
543 snprintf (buf, sizeof buf, "%dpt", fs->size);
544 put_style (&style, "font-size", buf);
547 if (t && html->borders)
549 put_border (t, cell, &style, V, 0, 0, "top");
550 put_border (t, cell, &style, H, 0, 0, "left");
552 if (cell->d[V][1] == t->n[V])
553 put_border (t, cell, &style, V, 0, 1, "bottom");
554 if (cell->d[H][1] == t->n[H])
555 put_border (t, cell, &style, H, 1, 0, "right");
559 int colspan = table_cell_colspan (cell);
561 fprintf (html->file, " colspan=\"%d\"", colspan);
563 int rowspan = table_cell_rowspan (cell);
565 fprintf (html->file, " rowspan=\"%d\"", rowspan);
567 putc ('>', html->file);
569 const char *s = ds_cstr (&body);
570 s += strspn (s, CC_SPACES);
571 escape_string (html->file, s, " ", "<br>");
574 if (cell->value->n_subscripts)
576 fputs ("<sub>", html->file);
577 for (size_t i = 0; i < cell->value->n_subscripts; i++)
580 putc (',', html->file);
581 escape_string (html->file, cell->value->subscripts[i],
584 fputs ("</sub>", html->file);
586 if (cell->value->n_footnotes > 0)
588 fputs ("<sup>", html->file);
589 size_t n_footnotes = 0;
590 for (size_t i = 0; i < cell->value->n_footnotes; i++)
592 const struct pivot_footnote *f
593 = pt->footnotes[cell->value->footnote_indexes[i]];
596 if (n_footnotes++ > 0)
597 putc (',', html->file);
599 char *marker = pivot_footnote_marker_string (f, pt);
600 escape_string (html->file, marker, " ", "<br>");
604 fputs ("</sup>", html->file);
607 /* output </th> or </td>. */
608 fprintf (html->file, "</%s>\n", tag);
612 html_output_table_layer (struct html_driver *html, const struct pivot_table *pt,
613 const size_t *layer_indexes)
615 struct table *title, *layers, *body, *caption, *footnotes;
616 pivot_output (pt, layer_indexes, true, &title, &layers, &body,
617 &caption, &footnotes, NULL, NULL);
619 fputs ("<table", html->file);
622 fputs (" title=\"", html->file);
623 escape_string (html->file, pt->notes, " ", "\n");
624 putc ('"', html->file);
626 fputs (">\n", html->file);
630 struct table_cell cell;
631 table_get_cell (title, 0, 0, &cell);
632 html_put_table_cell (html, pt, &cell, "caption", NULL);
637 fputs ("<thead>\n", html->file);
638 for (size_t y = 0; y < layers->n[V]; y++)
640 fputs ("<tr>\n", html->file);
642 struct table_cell cell;
643 table_get_cell (layers, 0, y, &cell);
644 cell.d[H][1] = body->n[H];
645 html_put_table_cell (html, pt, &cell, "td", NULL);
647 fputs ("</tr>\n", html->file);
649 fputs ("</thead>\n", html->file);
652 fputs ("<tbody>\n", html->file);
653 for (int y = 0; y < body->n[V]; y++)
655 fputs ("<tr>\n", html->file);
656 for (int x = 0; x < body->n[H]; )
658 struct table_cell cell;
659 table_get_cell (body, x, y, &cell);
660 if (x == cell.d[TABLE_HORZ][0] && y == cell.d[TABLE_VERT][0])
662 bool is_header = (y < body->h[V][0]
663 || y >= body->n[V] - body->h[V][1]
665 || x >= body->n[H] - body->h[H][1]);
666 const char *tag = is_header ? "th" : "td";
667 html_put_table_cell (html, pt, &cell, tag, body);
670 x = cell.d[TABLE_HORZ][1];
672 fputs ("</tr>\n", html->file);
674 fputs ("</tbody>\n", html->file);
676 if (caption || footnotes)
678 fprintf (html->file, "<tfoot>\n");
682 fputs ("<tr>\n", html->file);
684 struct table_cell cell;
685 table_get_cell (caption, 0, 0, &cell);
686 cell.d[H][1] = body->n[H];
687 html_put_table_cell (html, pt, &cell, "td", NULL);
689 fputs ("</tr>\n", html->file);
693 for (size_t y = 0; y < footnotes->n[V]; y++)
695 fputs ("<tr>\n", html->file);
697 struct table_cell cell;
698 table_get_cell (footnotes, 0, y, &cell);
699 cell.d[H][1] = body->n[H];
700 html_put_table_cell (html, pt, &cell, "td", NULL);
702 fputs ("</tr>\n", html->file);
704 fputs ("</tfoot>\n", html->file);
707 fputs ("</table>\n\n", html->file);
710 table_unref (layers);
712 table_unref (caption);
713 table_unref (footnotes);
717 html_output_table (struct html_driver *html, const struct table_item *item)
719 size_t *layer_indexes;
720 PIVOT_OUTPUT_FOR_EACH_LAYER (layer_indexes, item->pt, true)
721 html_output_table_layer (html, item->pt, layer_indexes);
724 struct output_driver_factory html_driver_factory =
725 { "html", "pspp.html", html_create };
727 static const struct output_driver_class html_driver_class =