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 "libpspp/assertion.h"
28 #include "libpspp/cast.h"
29 #include "libpspp/compiler.h"
30 #include "libpspp/message.h"
31 #include "libpspp/version.h"
32 #include "output/cairo.h"
33 #include "output/chart-item.h"
34 #include "output/driver-provider.h"
35 #include "output/message-item.h"
36 #include "output/options.h"
37 #include "output/output-item-provider.h"
38 #include "output/table-provider.h"
39 #include "output/table-item.h"
40 #include "output/text-item.h"
45 #define _(msgid) gettext (msgid)
49 struct output_driver driver;
55 char *chart_file_name;
65 static const struct output_driver_class html_driver_class;
67 static void html_output_table (struct html_driver *, const struct table_item *);
68 static void escape_string (FILE *file,
69 const char *text, size_t length,
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 (const char *file_name, 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, file_name,
99 html->css = parse_boolean (opt (d, o, "css", "true"));
100 html->borders = parse_boolean (opt (d, o, "borders", "true"));
102 html->file_name = xstrdup (file_name);
103 html->chart_file_name = parse_chart_file_name (opt (d, o, "charts",
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->file_name, "w");
112 if (html->file == NULL)
114 msg_error (errno, _("error opening output file `%s'"), html->file_name);
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, strlen (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->file_name, html->file);
221 free (html->chart_file_name);
222 free (html->file_name);
223 free (html->command_name);
228 html_submit (struct output_driver *driver,
229 const struct output_item *output_item)
231 struct html_driver *html = html_driver_cast (driver);
233 output_driver_track_current_command (output_item, &html->command_name);
235 if (is_table_item (output_item))
237 struct table_item *table_item = to_table_item (output_item);
238 html_output_table (html, table_item);
241 else if (is_chart_item (output_item) && html->chart_file_name != NULL)
243 struct chart_item *chart_item = to_chart_item (output_item);
246 file_name = xr_draw_png_chart (chart_item, html->chart_file_name,
251 if (file_name != NULL)
253 const char *title = chart_item_get_title (chart_item);
254 fprintf (html->file, "<IMG SRC=\"%s\" ALT=\"Chart: %s\">",
255 file_name, title ? title : _("No description"));
259 #endif /* HAVE_CAIRO */
260 else if (is_text_item (output_item))
262 struct text_item *text_item = to_text_item (output_item);
263 const char *s = text_item_get_text (text_item);
265 switch (text_item_get_type (text_item))
267 case TEXT_ITEM_TITLE:
268 print_title_tag (html->file, "H1", s);
271 case TEXT_ITEM_SUBTITLE:
272 print_title_tag (html->file, "H2", s);
275 case TEXT_ITEM_COMMAND_OPEN:
276 fprintf (html->file, "<DIV class=\"");
277 escape_string (html->file, s, strlen (s), "_", "<BR>");
278 fprintf (html->file, "\">");
279 print_title_tag (html->file, "H3", s);
282 case TEXT_ITEM_COMMAND_CLOSE:
283 fprintf (html->file, "</DIV>\n");
286 case TEXT_ITEM_SUBHEAD:
287 print_title_tag (html->file, "H4", s);
290 case TEXT_ITEM_SYNTAX:
291 fprintf (html->file, "<PRE class=\"syntax\">");
292 escape_string (html->file, s, strlen (s), " ", "<BR>");
293 fprintf (html->file, "</PRE>\n");
296 case TEXT_ITEM_PARAGRAPH:
297 print_title_tag (html->file, "P", s);
300 case TEXT_ITEM_MONOSPACE:
301 print_title_tag (html->file, "PRE", s); /* should be <P><TT> */
304 case TEXT_ITEM_BLANK_LINE:
305 fputs ("<BR>", html->file);
308 case TEXT_ITEM_EJECT_PAGE:
312 case TEXT_ITEM_COMMENT:
314 /* We print out syntax anyway, so nothing to do here either. */
318 else if (is_message_item (output_item))
320 const struct message_item *message_item = to_message_item (output_item);
321 const struct msg *msg = message_item_get_msg (message_item);
322 char *s = msg_to_string (msg, html->command_name);
323 print_title_tag (html->file, "P", s);
328 /* Write LENGTH characters in TEXT to file F, escaping characters as necessary
329 for HTML. Spaces are replaced by SPACE, which should be " " or " "
330 New-lines are replaced by NEWLINE, which might be "<BR>" or "\n" or
331 something else appropriate. */
333 escape_string (FILE *file,
334 const char *text, size_t length,
335 const char *space, const char *newline)
343 fputs (newline, file);
346 fputs ("&", file);
349 fputs ("<", file);
352 fputs (">", file);
358 fputs (""", file);
368 put_border (FILE *file, int n_borders, int style, const char *border_name)
370 fprintf (file, "%sborder-%s: %s",
371 n_borders == 0 ? " STYLE=\"" : "; ",
373 style == TAL_1 ? "thin solid" : "double");
377 put_tfoot (struct html_driver *html, const struct table *t, bool *tfoot)
381 fprintf (html->file, "<TFOOT><TR><TD COLSPAN=%d>", table_nc (t));
385 fputs ("\n<BR>", html->file);
389 html_output_table (struct html_driver *html, const struct table_item *item)
391 const struct table *t = table_item_get_table (item);
392 const char *title = table_item_get_title (item);
393 const char *caption = table_item_get_caption (item);
394 int footnote_idx = 0;
398 fputs ("<TABLE>", html->file);
402 put_tfoot (html, t, &tfoot);
403 escape_string (html->file, caption, strlen (caption), " ", "<BR>");
406 for (y = 0; y < table_nr (t); y++)
410 for (x = 0; x < table_nc (t); )
412 const struct cell_contents *c;
413 struct table_cell cell;
415 table_get_cell (t, x, y, &cell);
416 if (y != cell.d[TABLE_VERT][0])
419 for (c = cell.contents; c < &cell.contents[cell.n_contents]; c++)
423 for (i = 0; i < c->n_footnotes; i++)
427 put_tfoot (html, t, &tfoot);
428 str_format_26adic (++footnote_idx, false, marker, sizeof marker);
429 fprintf (html->file, "<SUP>%s</SUP> ", marker);
430 escape_string (html->file, c->footnotes[i],
431 strlen (c->footnotes[i]), " ", "<BR>");
434 x = cell.d[TABLE_HORZ][1];
435 table_cell_free (&cell);
439 fputs ("</TD></TR></TFOOT>\n", html->file);
442 fputs ("<TBODY VALIGN=\"TOP\">\n", html->file);
446 fputs (" <CAPTION>", html->file);
447 escape_string (html->file, title, strlen (title), " ", "<BR>");
448 fputs ("</CAPTION>\n", html->file);
451 for (y = 0; y < table_nr (t); y++)
455 fputs (" <TR>\n", html->file);
456 for (x = 0; x < table_nc (t); )
458 const struct cell_contents *c;
459 struct table_cell cell;
462 int alignment, colspan, rowspan;
463 int top, left, right, bottom, n_borders;
465 table_get_cell (t, x, y, &cell);
466 if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0])
469 /* Output <TD> or <TH> tag. */
470 is_header = (y < table_ht (t)
471 || y >= table_nr (t) - table_hb (t)
473 || x >= table_nc (t) - table_hr (t));
474 tag = is_header ? "TH" : "TD";
475 fprintf (html->file, " <%s", tag);
477 alignment = (cell.n_contents > 0
478 ? cell.contents[0].options & TAB_ALIGNMENT
480 if (alignment != TAB_LEFT)
481 fprintf (html->file, " ALIGN=\"%s\"",
482 alignment == TAB_RIGHT ? "RIGHT" : "CENTER");
484 colspan = table_cell_colspan (&cell);
486 fprintf (html->file, " COLSPAN=\"%d\"", colspan);
488 rowspan = table_cell_rowspan (&cell);
490 fprintf (html->file, " ROWSPAN=\"%d\"", rowspan);
497 top = table_get_rule (t, TABLE_VERT, x, y);
499 put_border (html->file, n_borders++, top, "top");
501 if (y + rowspan == table_nr (t))
503 bottom = table_get_rule (t, TABLE_VERT, x, y + rowspan);
504 if (bottom > TAL_GAP)
505 put_border (html->file, n_borders++, bottom, "bottom");
508 left = table_get_rule (t, TABLE_HORZ, x, y);
510 put_border (html->file, n_borders++, left, "left");
512 if (x + colspan == table_nc (t))
514 right = table_get_rule (t, TABLE_HORZ, x + colspan, y);
516 put_border (html->file, n_borders++, right, "right");
520 fputs ("\"", html->file);
523 putc ('>', html->file);
525 /* Output cell contents. */
526 for (c = cell.contents; c < &cell.contents[cell.n_contents]; c++)
530 const char *s = c->text;
533 if (c->options & TAB_EMPH)
534 fputs ("<EM>", html->file);
535 if (c->options & TAB_FIX)
537 fputs ("<TT>", html->file);
538 escape_string (html->file, s, strlen (s), " ", "<BR>");
539 fputs ("</TT>", html->file);
543 s += strspn (s, CC_SPACES);
544 escape_string (html->file, s, strlen (s), " ", "<BR>");
546 if (c->options & TAB_EMPH)
547 fputs ("</EM>", html->file);
549 if (c->n_footnotes > 0)
551 fputs ("<SUP>", html->file);
552 for (i = 0; i < c->n_footnotes; i++)
557 putc (',', html->file);
558 str_format_26adic (++footnote_idx, false,
559 marker, sizeof marker);
560 fputs (marker, html->file);
562 fputs ("</SUP>", html->file);
566 html_output_table (html, c->table);
569 /* Output </TH> or </TD>. */
570 fprintf (html->file, "</%s>\n", tag);
572 x = cell.d[TABLE_HORZ][1];
573 table_cell_free (&cell);
575 fputs (" </TR>\n", html->file);
578 fputs ("</TBODY></TABLE>\n\n", html->file);
581 struct output_driver_factory html_driver_factory =
582 { "html", "pspp.html", html_create };
584 static const struct output_driver_class html_driver_class =