1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2009, 2010, 2011, 2012, 2013, 2014, 2017 Free Software Foundation, Inc.
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
26 #include "data/file-name.h"
27 #include "data/file-handle-def.h"
28 #include "libpspp/assertion.h"
29 #include "libpspp/cast.h"
30 #include "libpspp/compiler.h"
31 #include "libpspp/message.h"
32 #include "libpspp/version.h"
33 #include "output/cairo.h"
34 #include "output/chart-item.h"
35 #include "output/driver-provider.h"
36 #include "output/message-item.h"
37 #include "output/options.h"
38 #include "output/output-item-provider.h"
39 #include "output/table-provider.h"
40 #include "output/table-item.h"
41 #include "output/text-item.h"
43 #include "gl/minmax.h"
44 #include "gl/xalloc.h"
47 #define _(msgid) gettext (msgid)
51 struct output_driver driver;
56 struct file_handle *handle;
57 char *chart_file_name;
66 static const struct output_driver_class html_driver_class;
68 static void html_output_table (struct html_driver *, const struct table_item *);
69 static void escape_string (FILE *file, const char *text,
70 const char *space, const char *newline);
71 static void print_title_tag (FILE *file, const char *name,
74 static struct html_driver *
75 html_driver_cast (struct output_driver *driver)
77 assert (driver->class == &html_driver_class);
78 return UP_CAST (driver, struct html_driver, driver);
81 static struct driver_option *
82 opt (struct output_driver *d, struct string_map *options, const char *key,
83 const char *default_value)
85 return driver_option_get (d, options, key, default_value);
88 static struct output_driver *
89 html_create (struct file_handle *fh, enum settings_output_devices device_type,
92 struct output_driver *d;
93 struct html_driver *html;
95 html = xzalloc (sizeof *html);
97 output_driver_init (&html->driver, &html_driver_class, fh_get_file_name (fh),
99 html->css = parse_boolean (opt (d, o, "css", "true"));
100 html->borders = parse_boolean (opt (d, o, "borders", "true"));
103 html->chart_file_name = parse_chart_file_name (opt (d, o, "charts",
104 fh_get_file_name (fh)));
108 parse_color (d, o, "background-color", "#FFFFFFFFFFFF", &html->bg);
109 parse_color (d, o, "foreground-color", "#000000000000", &html->fg);
111 html->file = fn_open (html->handle, "w");
112 if (html->file == NULL)
114 msg_error (errno, _("error opening output file `%s'"), fh_get_file_name (html->handle));
118 fputs ("<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\"\n"
119 " \"http://www.w3.org/TR/html4/loose.dtd\">\n", html->file);
120 fputs ("<HTML>\n", html->file);
121 fputs ("<HEAD>\n", html->file);
122 print_title_tag (html->file, "TITLE", _("PSPP Output"));
123 fprintf (html->file, "<META NAME=\"generator\" CONTENT=\"%s\">\n", version);
124 fputs ("<META HTTP-EQUIV=\"Content-Type\" "
125 "CONTENT=\"text/html; charset=utf-8\">\n", html->file);
129 fputs ("<META http-equiv=\"Content-Style-Type\" content=\"text/css\">\n",
131 fputs ("<STYLE TYPE=\"text/css\">\n"
134 " background: white;\n"
136 " padding: 0em 12em 0em 3em;\n"
140 " margin: 0pt 0pt 0pt 0em\n"
143 " text-indent: 1.5em;\n"
146 " font-size: 150%;\n"
147 " margin-left: -1.33em\n"
150 " font-size: 125%;\n"
151 " font-weight: bold;\n"
152 " margin-left: -.8em\n"
155 " font-size: 100%;\n"
156 " font-weight: bold;\n"
157 " margin-left: -.5em }\n"
159 " font-size: 100%;\n"
160 " margin-left: 0em\n"
162 "h1, h2, h3, h4, h5, h6 {\n"
163 " font-family: sans-serif;\n"
170 " font-family: sans-serif\n"
173 " border-collapse: collapse;\n"
174 " margin-bottom: 1em\n"
176 "th { background: #dddddd; font-weight: normal; font-style: oblique }\n"
178 " text-align: left\n"
184 fputs ("</HEAD>\n", html->file);
185 fputs ("<BODY BGCOLOR=\"#ffffff\" TEXT=\"#000000\"\n", html->file);
186 fputs (" LINK=\"#1f00ff\" ALINK=\"#ff0000\" VLINK=\"#9900dd\">\n", html->file);
191 output_driver_destroy (d);
195 /* Emits <NAME>CONTENT</NAME> to the output, escaping CONTENT as
196 necessary for HTML. */
198 print_title_tag (FILE *file, const char *name, const char *content)
202 fprintf (file, "<%s>", name);
203 escape_string (file, content, " ", " - ");
204 fprintf (file, "</%s>\n", name);
209 html_destroy (struct output_driver *driver)
211 struct html_driver *html = html_driver_cast (driver);
213 if (html->file != NULL)
218 "<!-- end of file -->\n");
219 fn_close (html->handle, html->file);
221 free (html->chart_file_name);
222 fh_unref (html->handle);
227 html_submit (struct output_driver *driver,
228 const struct output_item *output_item)
230 struct html_driver *html = html_driver_cast (driver);
232 if (is_table_item (output_item))
234 struct table_item *table_item = to_table_item (output_item);
235 html_output_table (html, table_item);
238 else if (is_chart_item (output_item) && html->chart_file_name != NULL)
240 struct chart_item *chart_item = to_chart_item (output_item);
243 file_name = xr_draw_png_chart (chart_item, html->chart_file_name,
248 if (file_name != NULL)
250 const char *title = chart_item_get_title (chart_item);
251 fprintf (html->file, "<IMG SRC=\"%s\" ALT=\"Chart: %s\">",
252 file_name, title ? title : _("No description"));
256 #endif /* HAVE_CAIRO */
257 else if (is_text_item (output_item))
259 struct text_item *text_item = to_text_item (output_item);
260 const char *s = text_item_get_text (text_item);
262 switch (text_item_get_type (text_item))
264 case TEXT_ITEM_PAGE_TITLE:
267 case TEXT_ITEM_TITLE:
269 int level = MIN (5, output_get_group_level ()) + 1;
270 char tag[3] = { 'H', level + '1', '\0' };
271 print_title_tag (html->file, tag, s);
275 case TEXT_ITEM_SYNTAX:
276 fprintf (html->file, "<PRE class=\"syntax\">");
277 escape_string (html->file, s, " ", "<BR>");
278 fprintf (html->file, "</PRE>\n");
282 print_title_tag (html->file, "PRE", s); /* should be <P><TT> */
285 case TEXT_ITEM_EJECT_PAGE:
290 else if (is_message_item (output_item))
292 const struct message_item *message_item = to_message_item (output_item);
293 char *s = msg_to_string (message_item_get_msg (message_item));
294 print_title_tag (html->file, "P", s);
299 /* Write TEXT to file F, escaping characters as necessary for HTML. Spaces are
300 replaced by SPACE, which should be " " or " " New-lines are replaced by
301 NEWLINE, which might be "<BR>" or "\n" or something else appropriate. */
303 escape_string (FILE *file, const char *text,
304 const char *space, const char *newline)
314 fputs (newline, file);
317 fputs ("&", file);
320 fputs ("<", file);
323 fputs (">", file);
329 fputs (""", file);
339 escape_tag (FILE *file, const char *tag,
340 const char *text, const char *space, const char *newline)
345 fprintf (file, "<%s>", tag);
346 escape_string (file, text, space, newline);
347 fprintf (file, "</%s>", tag);
351 border_to_css (int border)
355 case TABLE_STROKE_NONE:
358 case TABLE_STROKE_SOLID:
361 case TABLE_STROKE_DASHED:
364 case TABLE_STROKE_THICK:
365 return "thick solid";
367 case TABLE_STROKE_THIN:
370 case TABLE_STROKE_DOUBLE:
380 put_border (FILE *file, int *n_borders, int style, const char *border_name)
382 const char *css = border_to_css (style);
385 fprintf (file, "%sborder-%s: %s",
386 (*n_borders)++ == 0 ? " STYLE=\"" : "; ",
392 put_tfoot (struct html_driver *html, const struct table *t, bool *tfoot)
396 fprintf (html->file, "<TFOOT><TR><TD COLSPAN=%d>", table_nc (t));
400 fputs ("\n<BR>", html->file);
404 html_put_footnote_markers (struct html_driver *html,
405 const struct footnote **footnotes,
410 fputs ("<SUP>", html->file);
411 for (size_t i = 0; i < n_footnotes; i++)
413 const struct footnote *f = footnotes[i];
416 putc (',', html->file);
417 escape_string (html->file, f->marker, " ", "<BR>");
419 fputs ("</SUP>", html->file);
424 html_put_table_item_text (struct html_driver *html,
425 const struct table_item_text *text)
427 escape_string (html->file, text->content, " ", "<BR>");
428 html_put_footnote_markers (html, text->footnotes, text->n_footnotes);
432 html_put_table_item_layers (struct html_driver *html,
433 const struct table_item_layers *layers)
435 for (size_t i = 0; i < layers->n_layers; i++)
438 fputs ("<BR>\n", html->file);
440 const struct table_item_layer *layer = &layers->layers[i];
441 escape_string (html->file, layer->content, " ", "<BR>");
442 html_put_footnote_markers (html, layer->footnotes, layer->n_footnotes);
447 html_output_table (struct html_driver *html, const struct table_item *item)
449 const struct table *t = table_item_get_table (item);
453 fputs ("<TABLE>", html->file);
455 const struct table_item_text *caption = table_item_get_caption (item);
458 put_tfoot (html, t, &tfoot);
459 html_put_table_item_text (html, caption);
461 const struct footnote **f;
462 size_t n_footnotes = table_collect_footnotes (item, &f);
464 for (size_t i = 0; i < n_footnotes; i++)
466 put_tfoot (html, t, &tfoot);
467 escape_tag (html->file, "SUP", f[i]->marker, " ", "<BR>");
468 escape_string (html->file, f[i]->content, " ", "<BR>");
472 fputs ("</TD></TR></TFOOT>\n", html->file);
474 fputs ("<TBODY VALIGN=\"TOP\">\n", html->file);
476 const struct table_item_text *title = table_item_get_title (item);
477 const struct table_item_layers *layers = table_item_get_layers (item);
480 fputs (" <CAPTION>", html->file);
482 html_put_table_item_text (html, title);
484 fputs ("<BR>\n", html->file);
486 html_put_table_item_layers (html, layers);
487 fputs ("</CAPTION>\n", html->file);
490 for (y = 0; y < table_nr (t); y++)
494 fputs (" <TR>\n", html->file);
495 for (x = 0; x < table_nc (t);)
497 struct table_cell cell;
500 int colspan, rowspan;
501 int top, left, right, bottom;
503 table_get_cell (t, x, y, &cell);
504 if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0])
507 /* Output <TD> or <TH> tag. */
508 is_header = (y < table_ht (t)
509 || y >= table_nr (t) - table_hb (t)
511 || x >= table_nc (t) - table_hr (t));
512 tag = is_header ? "TH" : "TD";
513 fprintf (html->file, " <%s", tag);
515 enum table_halign halign = table_halign_interpret (
516 cell.style->cell_style.halign, cell.options & TAB_NUMERIC);
517 if (halign != TABLE_HALIGN_LEFT)
519 fprintf (html->file, " ALIGN=\"%s\"",
520 (halign == TABLE_HALIGN_RIGHT ? "RIGHT"
521 : halign == TABLE_HALIGN_CENTER ? "CENTER"
523 if (cell.style->cell_style.decimal_char)
524 fprintf (html->file, " CHAR=\"%c\"",
525 cell.style->cell_style.decimal_char);
528 if (cell.style->cell_style.valign != TABLE_VALIGN_TOP)
529 fprintf (html->file, " ALIGN=\"%s\"",
530 (cell.style->cell_style.valign == TABLE_VALIGN_BOTTOM
531 ? "BOTTOM" : "MIDDLE"));
533 colspan = table_cell_colspan (&cell);
535 fprintf (html->file, " COLSPAN=\"%d\"", colspan);
537 rowspan = table_cell_rowspan (&cell);
539 fprintf (html->file, " ROWSPAN=\"%d\"", rowspan);
546 struct cell_color color;
547 top = table_get_rule (t, TABLE_VERT, x, y, &color);
548 put_border (html->file, &n_borders, top, "top");
550 if (y + rowspan == table_nr (t))
552 bottom = table_get_rule (t, TABLE_VERT, x, y + rowspan,
554 put_border (html->file, &n_borders, bottom, "bottom");
557 left = table_get_rule (t, TABLE_HORZ, x, y, &color);
558 put_border (html->file, &n_borders, left, "left");
560 if (x + colspan == table_nc (t))
562 right = table_get_rule (t, TABLE_HORZ, x + colspan, y,
564 put_border (html->file, &n_borders, right, "right");
568 fputs ("\"", html->file);
571 putc ('>', html->file);
573 /* Output cell contents. */
574 const char *s = cell.text;
575 if (cell.options & TAB_FIX)
576 escape_tag (html->file, "TT", s, " ", "<BR>");
579 s += strspn (s, CC_SPACES);
580 escape_string (html->file, s, " ", "<BR>");
583 if (cell.n_subscripts)
585 fputs ("<SUB>", html->file);
586 for (size_t i = 0; i < cell.n_subscripts; i++)
589 putc (',', html->file);
590 escape_string (html->file, cell.subscripts[i],
593 fputs ("</SUB>", html->file);
595 if (cell.superscript)
596 escape_tag (html->file, "SUP", cell.superscript, " ", "<BR>");
597 html_put_footnote_markers (html, cell.footnotes, cell.n_footnotes);
599 /* Output </TH> or </TD>. */
600 fprintf (html->file, "</%s>\n", tag);
603 x = cell.d[TABLE_HORZ][1];
605 fputs (" </TR>\n", html->file);
608 fputs ("</TBODY></TABLE>\n\n", html->file);
611 struct output_driver_factory html_driver_factory =
612 { "html", "pspp.html", html_create };
614 static const struct output_driver_class html_driver_class =