1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2009, 2010, 2011, 2012, 2013, 2014 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"
46 #define _(msgid) gettext (msgid)
50 struct output_driver driver;
55 struct file_handle *handle;
56 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,
70 const char *text, size_t length,
71 const char *space, const char *newline);
72 static void print_title_tag (FILE *file, const char *name,
75 static struct html_driver *
76 html_driver_cast (struct output_driver *driver)
78 assert (driver->class == &html_driver_class);
79 return UP_CAST (driver, struct html_driver, driver);
82 static struct driver_option *
83 opt (struct output_driver *d, struct string_map *options, const char *key,
84 const char *default_value)
86 return driver_option_get (d, options, key, default_value);
89 static struct output_driver *
90 html_create (struct file_handle *fh, enum settings_output_devices device_type,
93 struct output_driver *d;
94 struct html_driver *html;
96 html = xzalloc (sizeof *html);
98 output_driver_init (&html->driver, &html_driver_class, fh_get_file_name (fh),
100 html->css = parse_boolean (opt (d, o, "css", "true"));
101 html->borders = parse_boolean (opt (d, o, "borders", "true"));
104 html->chart_file_name = parse_chart_file_name (opt (d, o, "charts",
105 fh_get_file_name (fh)));
109 parse_color (d, o, "background-color", "#FFFFFFFFFFFF", &html->bg);
110 parse_color (d, o, "foreground-color", "#000000000000", &html->fg);
112 html->file = fn_open (html->handle, "w");
113 if (html->file == NULL)
115 msg_error (errno, _("error opening output file `%s'"), fh_get_file_name (html->handle));
119 fputs ("<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\"\n"
120 " \"http://www.w3.org/TR/html4/loose.dtd\">\n", html->file);
121 fputs ("<HTML>\n", html->file);
122 fputs ("<HEAD>\n", html->file);
123 print_title_tag (html->file, "TITLE", _("PSPP Output"));
124 fprintf (html->file, "<META NAME=\"generator\" CONTENT=\"%s\">\n", version);
125 fputs ("<META HTTP-EQUIV=\"Content-Type\" "
126 "CONTENT=\"text/html; charset=utf-8\">\n", html->file);
130 fputs ("<META http-equiv=\"Content-Style-Type\" content=\"text/css\">\n",
132 fputs ("<STYLE TYPE=\"text/css\">\n"
135 " background: white;\n"
137 " padding: 0em 12em 0em 3em;\n"
141 " margin: 0pt 0pt 0pt 0em\n"
144 " text-indent: 1.5em;\n"
147 " font-size: 150%;\n"
148 " margin-left: -1.33em\n"
151 " font-size: 125%;\n"
152 " font-weight: bold;\n"
153 " margin-left: -.8em\n"
156 " font-size: 100%;\n"
157 " font-weight: bold;\n"
158 " margin-left: -.5em }\n"
160 " font-size: 100%;\n"
161 " margin-left: 0em\n"
163 "h1, h2, h3, h4, h5, h6 {\n"
164 " font-family: sans-serif;\n"
171 " font-family: sans-serif\n"
174 " border-collapse: collapse;\n"
175 " margin-bottom: 1em\n"
177 "th { background: #dddddd; font-weight: normal; font-style: oblique }\n"
179 " text-align: left\n"
185 fputs ("</HEAD>\n", html->file);
186 fputs ("<BODY BGCOLOR=\"#ffffff\" TEXT=\"#000000\"\n", html->file);
187 fputs (" LINK=\"#1f00ff\" ALINK=\"#ff0000\" VLINK=\"#9900dd\">\n", html->file);
192 output_driver_destroy (d);
196 /* Emits <NAME>CONTENT</NAME> to the output, escaping CONTENT as
197 necessary for HTML. */
199 print_title_tag (FILE *file, const char *name, const char *content)
203 fprintf (file, "<%s>", name);
204 escape_string (file, content, strlen (content), " ", " - ");
205 fprintf (file, "</%s>\n", name);
210 html_destroy (struct output_driver *driver)
212 struct html_driver *html = html_driver_cast (driver);
214 if (html->file != NULL)
219 "<!-- end of file -->\n");
220 fn_close (html->handle, html->file);
222 free (html->chart_file_name);
223 fh_unref (html->handle);
224 free (html->command_name);
229 html_submit (struct output_driver *driver,
230 const struct output_item *output_item)
232 struct html_driver *html = html_driver_cast (driver);
234 output_driver_track_current_command (output_item, &html->command_name);
236 if (is_table_item (output_item))
238 struct table_item *table_item = to_table_item (output_item);
239 html_output_table (html, table_item);
242 else if (is_chart_item (output_item) && html->chart_file_name != NULL)
244 struct chart_item *chart_item = to_chart_item (output_item);
247 file_name = xr_draw_png_chart (chart_item, html->chart_file_name,
252 if (file_name != NULL)
254 const char *title = chart_item_get_title (chart_item);
255 fprintf (html->file, "<IMG SRC=\"%s\" ALT=\"Chart: %s\">",
256 file_name, title ? title : _("No description"));
260 #endif /* HAVE_CAIRO */
261 else if (is_text_item (output_item))
263 struct text_item *text_item = to_text_item (output_item);
264 const char *s = text_item_get_text (text_item);
266 switch (text_item_get_type (text_item))
268 case TEXT_ITEM_TITLE:
269 print_title_tag (html->file, "H1", s);
272 case TEXT_ITEM_SUBTITLE:
273 print_title_tag (html->file, "H2", s);
276 case TEXT_ITEM_COMMAND_OPEN:
277 fprintf (html->file, "<DIV class=\"");
278 escape_string (html->file, s, strlen (s), "_", "<BR>");
279 fprintf (html->file, "\">");
280 print_title_tag (html->file, "H3", s);
283 case TEXT_ITEM_COMMAND_CLOSE:
284 fprintf (html->file, "</DIV>\n");
287 case TEXT_ITEM_SUBHEAD:
288 print_title_tag (html->file, "H4", s);
291 case TEXT_ITEM_SYNTAX:
292 fprintf (html->file, "<PRE class=\"syntax\">");
293 escape_string (html->file, s, strlen (s), " ", "<BR>");
294 fprintf (html->file, "</PRE>\n");
297 case TEXT_ITEM_PARAGRAPH:
298 print_title_tag (html->file, "P", s);
301 case TEXT_ITEM_MONOSPACE:
302 print_title_tag (html->file, "PRE", s); /* should be <P><TT> */
305 case TEXT_ITEM_BLANK_LINE:
306 fputs ("<BR>", html->file);
309 case TEXT_ITEM_EJECT_PAGE:
313 case TEXT_ITEM_COMMENT:
315 /* We print out syntax anyway, so nothing to do here either. */
319 else if (is_message_item (output_item))
321 const struct message_item *message_item = to_message_item (output_item);
322 const struct msg *msg = message_item_get_msg (message_item);
323 char *s = msg_to_string (msg, html->command_name);
324 print_title_tag (html->file, "P", s);
329 /* Write LENGTH characters in TEXT to file F, escaping characters as necessary
330 for HTML. Spaces are replaced by SPACE, which should be " " or " "
331 New-lines are replaced by NEWLINE, which might be "<BR>" or "\n" or
332 something else appropriate. */
334 escape_string (FILE *file,
335 const char *text, size_t length,
336 const char *space, const char *newline)
344 fputs (newline, file);
347 fputs ("&", file);
350 fputs ("<", file);
353 fputs (">", file);
359 fputs (""", file);
369 put_border (FILE *file, int n_borders, int style, const char *border_name)
371 fprintf (file, "%sborder-%s: %s",
372 n_borders == 0 ? " STYLE=\"" : "; ",
374 style == TAL_1 ? "thin solid" : "double");
378 put_tfoot (struct html_driver *html, const struct table *t, bool *tfoot)
382 fprintf (html->file, "<TFOOT><TR><TD COLSPAN=%d>", table_nc (t));
386 fputs ("\n<BR>", html->file);
390 html_output_table (struct html_driver *html, const struct table_item *item)
392 const struct table *t = table_item_get_table (item);
393 const char *title = table_item_get_title (item);
394 const char *caption = table_item_get_caption (item);
395 int footnote_idx = 0;
399 fputs ("<TABLE>", html->file);
403 put_tfoot (html, t, &tfoot);
404 escape_string (html->file, caption, strlen (caption), " ", "<BR>");
407 for (y = 0; y < table_nr (t); y++)
411 for (x = 0; x < table_nc (t); )
413 const struct cell_contents *c;
414 struct table_cell cell;
416 table_get_cell (t, x, y, &cell);
417 if (y != cell.d[TABLE_VERT][0])
420 for (c = cell.contents; c < &cell.contents[cell.n_contents]; c++)
424 for (i = 0; i < c->n_footnotes; i++)
428 put_tfoot (html, t, &tfoot);
429 str_format_26adic (++footnote_idx, false, marker, sizeof marker);
430 fprintf (html->file, "<SUP>%s</SUP> ", marker);
431 escape_string (html->file, c->footnotes[i],
432 strlen (c->footnotes[i]), " ", "<BR>");
435 x = cell.d[TABLE_HORZ][1];
436 table_cell_free (&cell);
440 fputs ("</TD></TR></TFOOT>\n", html->file);
443 fputs ("<TBODY VALIGN=\"TOP\">\n", html->file);
447 fputs (" <CAPTION>", html->file);
448 escape_string (html->file, title, strlen (title), " ", "<BR>");
449 fputs ("</CAPTION>\n", html->file);
452 for (y = 0; y < table_nr (t); y++)
456 fputs (" <TR>\n", html->file);
457 for (x = 0; x < table_nc (t); )
459 const struct cell_contents *c;
460 struct table_cell cell;
463 int alignment, colspan, rowspan;
464 int top, left, right, bottom, n_borders;
466 table_get_cell (t, x, y, &cell);
467 if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0])
470 /* Output <TD> or <TH> tag. */
471 is_header = (y < table_ht (t)
472 || y >= table_nr (t) - table_hb (t)
474 || x >= table_nc (t) - table_hr (t));
475 tag = is_header ? "TH" : "TD";
476 fprintf (html->file, " <%s", tag);
478 alignment = (cell.n_contents > 0
479 ? cell.contents[0].options & TAB_ALIGNMENT
481 if (alignment != TAB_LEFT)
482 fprintf (html->file, " ALIGN=\"%s\"",
483 alignment == TAB_RIGHT ? "RIGHT" : "CENTER");
485 colspan = table_cell_colspan (&cell);
487 fprintf (html->file, " COLSPAN=\"%d\"", colspan);
489 rowspan = table_cell_rowspan (&cell);
491 fprintf (html->file, " ROWSPAN=\"%d\"", rowspan);
498 top = table_get_rule (t, TABLE_VERT, x, y);
500 put_border (html->file, n_borders++, top, "top");
502 if (y + rowspan == table_nr (t))
504 bottom = table_get_rule (t, TABLE_VERT, x, y + rowspan);
505 if (bottom > TAL_GAP)
506 put_border (html->file, n_borders++, bottom, "bottom");
509 left = table_get_rule (t, TABLE_HORZ, x, y);
511 put_border (html->file, n_borders++, left, "left");
513 if (x + colspan == table_nc (t))
515 right = table_get_rule (t, TABLE_HORZ, x + colspan, y);
517 put_border (html->file, n_borders++, right, "right");
521 fputs ("\"", html->file);
524 putc ('>', html->file);
526 /* Output cell contents. */
527 for (c = cell.contents; c < &cell.contents[cell.n_contents]; c++)
531 const char *s = c->text;
534 if (c->options & TAB_EMPH)
535 fputs ("<EM>", html->file);
536 if (c->options & TAB_FIX)
538 fputs ("<TT>", html->file);
539 escape_string (html->file, s, strlen (s), " ", "<BR>");
540 fputs ("</TT>", html->file);
544 s += strspn (s, CC_SPACES);
545 escape_string (html->file, s, strlen (s), " ", "<BR>");
547 if (c->options & TAB_EMPH)
548 fputs ("</EM>", html->file);
550 if (c->n_footnotes > 0)
552 fputs ("<SUP>", html->file);
553 for (i = 0; i < c->n_footnotes; i++)
558 putc (',', html->file);
559 str_format_26adic (++footnote_idx, false,
560 marker, sizeof marker);
561 fputs (marker, html->file);
563 fputs ("</SUP>", html->file);
567 html_output_table (html, c->table);
570 /* Output </TH> or </TD>. */
571 fprintf (html->file, "</%s>\n", tag);
573 x = cell.d[TABLE_HORZ][1];
574 table_cell_free (&cell);
576 fputs (" </TR>\n", html->file);
579 fputs ("</TBODY></TABLE>\n\n", html->file);
582 struct output_driver_factory html_driver_factory =
583 { "html", "pspp.html", html_create };
585 static const struct output_driver_class html_driver_class =