/* PSPP - a program for statistical analysis.
- Copyright (C) 1997-9, 2000, 2009 Free Software Foundation, Inc.
+ Copyright (C) 1997-9, 2000, 2009, 2010, 2011, 2012, 2013, 2014, 2017 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
#include <time.h>
#include <unistd.h>
-#include <data/file-name.h>
-#include <libpspp/assertion.h>
-#include <libpspp/cast.h>
-#include <libpspp/compiler.h>
-#include <libpspp/version.h>
-#include <output/cairo.h>
-#include <output/chart-item.h>
-#include <output/driver-provider.h>
-#include <output/options.h>
-#include <output/output-item-provider.h>
-#include <output/table-provider.h>
-#include <output/table-item.h>
-#include <output/text-item.h>
-
-#include "error.h"
+#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/message.h"
+#include "libpspp/version.h"
+#include "output/cairo.h"
+#include "output/chart-item.h"
+#include "output/driver-provider.h"
+#include "output/message-item.h"
+#include "output/options.h"
+#include "output/output-item-provider.h"
+#include "output/table-provider.h"
+#include "output/table-item.h"
+#include "output/text-item.h"
+
#include "xalloc.h"
#include "gettext.h"
struct html_driver
{
struct output_driver driver;
-
- char *file_name;
+#ifdef HAVE_CAIRO
+ struct xr_color fg;
+ struct xr_color bg;
+#endif
+ struct file_handle *handle;
char *chart_file_name;
+ char *command_name;
FILE *file;
size_t chart_cnt;
- bool in_syntax;
+ bool css;
+ bool borders;
};
-const struct output_driver_class html_class;
+static const struct output_driver_class html_driver_class;
-static void html_output_table (struct html_driver *, struct table_item *);
+static void html_output_table (struct html_driver *, const struct table_item *);
static void escape_string (FILE *file,
const char *text, size_t length,
- const char *space);
+ const char *space, const char *newline);
static void print_title_tag (FILE *file, const char *name,
const char *content);
static struct html_driver *
html_driver_cast (struct output_driver *driver)
{
- assert (driver->class == &html_class);
+ assert (driver->class == &html_driver_class);
return UP_CAST (driver, struct html_driver, driver);
}
}
static struct output_driver *
-html_create (const char *name, enum output_device_type device_type,
+html_create (struct file_handle *fh, enum settings_output_devices device_type,
struct string_map *o)
{
struct output_driver *d;
html = xzalloc (sizeof *html);
d = &html->driver;
- output_driver_init (&html->driver, &html_class, name, device_type);
- html->file_name = parse_string (opt (d, o, "output-file", "pspp.html"));
- html->chart_file_name = parse_chart_file_name (opt (d, o, "chart-files",
- "pspp-#.png"));
+ output_driver_init (&html->driver, &html_driver_class, fh_get_file_name (fh),
+ device_type);
+ html->css = parse_boolean (opt (d, o, "css", "true"));
+ html->borders = parse_boolean (opt (d, o, "borders", "true"));
+
+ html->handle = fh;
+ html->chart_file_name = parse_chart_file_name (opt (d, o, "charts",
+ fh_get_file_name (fh)));
html->file = NULL;
html->chart_cnt = 1;
-
- html->file = fn_open (html->file_name, "w");
+#ifdef HAVE_CAIRO
+ parse_color (d, o, "background-color", "#FFFFFFFFFFFF", &html->bg);
+ parse_color (d, o, "foreground-color", "#000000000000", &html->fg);
+#endif
+ html->file = fn_open (html->handle, "w");
if (html->file == NULL)
{
- error (0, errno, _("opening HTML output file: %s"), html->file_name);
+ msg_error (errno, _("error opening output file `%s'"), fh_get_file_name (html->handle));
goto error;
}
fputs ("<HEAD>\n", html->file);
print_title_tag (html->file, "TITLE", _("PSPP Output"));
fprintf (html->file, "<META NAME=\"generator\" CONTENT=\"%s\">\n", version);
- fputs ("<META http-equiv=\"Content-Style-Type\" content=\"text/css\">\n",
- html->file);
fputs ("<META HTTP-EQUIV=\"Content-Type\" "
- "CONTENT=\"text/html; charset=ISO-8859-1\">\n", html->file);
- fputs ("<STYLE>\n"
- "<!--\n"
- "body {\n"
- " background: white;\n"
- " color: black;\n"
- " padding: 0em 12em 0em 3em;\n"
- " margin: 0\n"
- "}\n"
- "body>p {\n"
- " margin: 0pt 0pt 0pt 0em\n"
- "}\n"
- "body>p + p {\n"
- " text-indent: 1.5em;\n"
- "}\n"
- "h1 {\n"
- " font-size: 150%;\n"
- " margin-left: -1.33em\n"
- "}\n"
- "h2 {\n"
- " font-size: 125%;\n"
- " font-weight: bold;\n"
- " margin-left: -.8em\n"
- "}\n"
- "h3 {\n"
- " font-size: 100%;\n"
- " font-weight: bold;\n"
- " margin-left: -.5em }\n"
- "h4 {\n"
- " font-size: 100%;\n"
- " margin-left: 0em\n"
- "}\n"
- "h1, h2, h3, h4, h5, h6 {\n"
- " font-family: sans-serif;\n"
- " color: blue\n"
- "}\n"
- "html {\n"
- " margin: 0\n"
- "}\n"
- "code {\n"
- " font-family: sans-serif\n"
- "}\n"
- "table {\n"
- " border-collapse: collapse;\n"
- " margin-bottom: 1em\n"
- "}\n"
- "th { background: #dddddd; font-weight: normal; font-style: oblique }\n"
- "caption {\n"
- " text-align: left\n"
- "}\n"
- "-->\n"
- "</STYLE>\n",
- html->file);
+ "CONTENT=\"text/html; charset=utf-8\">\n", html->file);
+
+ if ( html->css)
+ {
+ fputs ("<META http-equiv=\"Content-Style-Type\" content=\"text/css\">\n",
+ html->file);
+ fputs ("<STYLE TYPE=\"text/css\">\n"
+ "<!--\n"
+ "body {\n"
+ " background: white;\n"
+ " color: black;\n"
+ " padding: 0em 12em 0em 3em;\n"
+ " margin: 0\n"
+ "}\n"
+ "body>p {\n"
+ " margin: 0pt 0pt 0pt 0em\n"
+ "}\n"
+ "body>p + p {\n"
+ " text-indent: 1.5em;\n"
+ "}\n"
+ "h1 {\n"
+ " font-size: 150%;\n"
+ " margin-left: -1.33em\n"
+ "}\n"
+ "h2 {\n"
+ " font-size: 125%;\n"
+ " font-weight: bold;\n"
+ " margin-left: -.8em\n"
+ "}\n"
+ "h3 {\n"
+ " font-size: 100%;\n"
+ " font-weight: bold;\n"
+ " margin-left: -.5em }\n"
+ "h4 {\n"
+ " font-size: 100%;\n"
+ " margin-left: 0em\n"
+ "}\n"
+ "h1, h2, h3, h4, h5, h6 {\n"
+ " font-family: sans-serif;\n"
+ " color: blue\n"
+ "}\n"
+ "html {\n"
+ " margin: 0\n"
+ "}\n"
+ "code {\n"
+ " font-family: sans-serif\n"
+ "}\n"
+ "table {\n"
+ " border-collapse: collapse;\n"
+ " margin-bottom: 1em\n"
+ "}\n"
+ "th { background: #dddddd; font-weight: normal; font-style: oblique }\n"
+ "caption {\n"
+ " text-align: left\n"
+ "}\n"
+ "-->\n"
+ "</STYLE>\n",
+ html->file);
+ }
fputs ("</HEAD>\n", html->file);
fputs ("<BODY BGCOLOR=\"#ffffff\" TEXT=\"#000000\"\n", html->file);
fputs (" LINK=\"#1f00ff\" ALINK=\"#ff0000\" VLINK=\"#9900dd\">\n", html->file);
if (content != NULL)
{
fprintf (file, "<%s>", name);
- escape_string (file, content, strlen (content), " ");
+ escape_string (file, content, strlen (content), " ", " - ");
fprintf (file, "</%s>\n", name);
}
}
if (html->file != NULL)
{
- if (html->in_syntax)
- {
- fprintf (html->file, "</PRE>\n");
- html->in_syntax = false;
- }
fprintf (html->file,
"</BODY>\n"
"</HTML>\n"
"<!-- end of file -->\n");
- fn_close (html->file_name, html->file);
+ fn_close (html->handle, html->file);
}
free (html->chart_file_name);
- free (html->file_name);
+ fh_unref (html->handle);
+ free (html->command_name);
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)
{
struct html_driver *html = html_driver_cast (driver);
- if (html->in_syntax && !is_syntax_item (output_item))
- {
- fprintf (html->file, "</PRE>\n");
- html->in_syntax = false;
- }
+ output_driver_track_current_command (output_item, &html->command_name);
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)
{
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++);
+ html->chart_cnt++,
+ &html->fg,
+ &html->bg
+ );
if (file_name != NULL)
{
- fprintf (html->file, "<IMG SRC=\"%s\"/>", file_name);
+ const char *title = chart_item_get_title (chart_item);
+ fprintf (html->file, "<IMG SRC=\"%s\" ALT=\"Chart: %s\">",
+ 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);
case TEXT_ITEM_COMMAND_OPEN:
fprintf (html->file, "<DIV class=\"");
- escape_string (html->file, s, strlen (s), "_");
+ escape_string (html->file, s, strlen (s), "_", "<BR>");
fprintf (html->file, "\">");
print_title_tag (html->file, "H3", s);
break;
break;
case TEXT_ITEM_SYNTAX:
- if (!html->in_syntax)
- {
- fprintf (html->file, "<PRE class=\"syntax\">");
- html->in_syntax = true;
- }
- else
- putc ('\n', html->file);
- escape_string (html->file, s, strlen (s), " ");
+ fprintf (html->file, "<PRE class=\"syntax\">");
+ escape_string (html->file, s, strlen (s), " ", "<BR>");
+ fprintf (html->file, "</PRE>\n");
break;
case TEXT_ITEM_PARAGRAPH:
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);
+ }
}
-/* Write LENGTH characters in TEXT to file F, escaping characters
- as necessary for HTML. Spaces are replaced by SPACE, which
- should be " " or " ". */
+/* Write LENGTH characters in 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 "<BR>" or "\n" or
+ something else appropriate. */
static void
escape_string (FILE *file,
const char *text, size_t length,
- const char *space)
+ const char *space, const char *newline)
{
while (length-- > 0)
{
char c = *text++;
switch (c)
{
+ case '\n':
+ fputs (newline, file);
+ break;
case '&':
fputs ("&", file);
break;
}
static void
-html_output_table (struct html_driver *html, struct table_item *item)
+put_tfoot (struct html_driver *html, const struct table *t, bool *tfoot)
+{
+ if (!*tfoot)
+ {
+ fprintf (html->file, "<TFOOT><TR><TD COLSPAN=%d>", table_nc (t));
+ *tfoot = true;
+ }
+ else
+ fputs ("\n<BR>", html->file);
+}
+
+static void
+html_output_table (struct html_driver *html, const struct table_item *item)
{
const struct table *t = table_item_get_table (item);
- const char *caption;
- int x, y;
+ const char *title = table_item_get_title (item);
+ const char *caption = table_item_get_caption (item);
+ int footnote_idx = 0;
+ bool tfoot = false;
+ int y;
- fputs ("<TABLE>\n", html->file);
+ fputs ("<TABLE>", html->file);
- caption = table_item_get_caption (item);
- if (caption != NULL)
+ if (caption)
+ {
+ put_tfoot (html, t, &tfoot);
+ escape_string (html->file, caption, strlen (caption), " ", "<BR>");
+ }
+ footnote_idx = 0;
+ for (y = 0; y < table_nr (t); y++)
+ {
+ int x;
+ for (x = 0; x < table_nc (t); )
+ {
+ const struct cell_contents *c;
+ struct table_cell cell;
+
+ table_get_cell (t, x, y, &cell);
+ if (y != cell.d[TABLE_VERT][0])
+ goto next_0;
+
+ for (c = cell.contents; c < &cell.contents[cell.n_contents]; c++)
+ {
+ int i;
+
+ for (i = 0; i < c->n_footnotes; i++)
+ {
+ char marker[16];
+
+ put_tfoot (html, t, &tfoot);
+ str_format_26adic (++footnote_idx, false, marker, sizeof marker);
+ fprintf (html->file, "<SUP>%s</SUP> ", marker);
+ escape_string (html->file, c->footnotes[i],
+ strlen (c->footnotes[i]), " ", "<BR>");
+ }
+ }
+
+ next_0:
+ x = cell.d[TABLE_HORZ][1];
+ table_cell_free (&cell);
+ }
+ }
+ if (tfoot)
+ fputs ("</TD></TR></TFOOT>\n", html->file);
+ footnote_idx = 0;
+
+ fputs ("<TBODY VALIGN=\"TOP\">\n", html->file);
+
+ if (title != NULL)
{
fputs (" <CAPTION>", html->file);
- escape_string (html->file, caption, strlen (caption), " ");
+ escape_string (html->file, title, strlen (title), " ", "<BR>");
fputs ("</CAPTION>\n", html->file);
}
for (y = 0; y < table_nr (t); y++)
{
+ int x;
+
fputs (" <TR>\n", html->file);
- for (x = 0; x < table_nc (t); x++)
+ for (x = 0; x < table_nc (t); )
{
+ const struct cell_contents *c;
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;
+ goto next_1;
/* Output <TD> or <TH> tag. */
is_header = (y < table_ht (t)
tag = is_header ? "TH" : "TD";
fprintf (html->file, " <%s", tag);
- alignment = cell.options & TAB_ALIGNMENT;
+ alignment = (cell.n_contents > 0
+ ? cell.contents[0].options & TAB_ALIGNMENT
+ : TAB_LEFT);
if (alignment != TAB_LEFT)
- fprintf (html->file, " ALIGN=%s",
+ fprintf (html->file, " ALIGN=\"%s\"",
alignment == TAB_RIGHT ? "RIGHT" : "CENTER");
colspan = table_cell_colspan (&cell);
if (colspan > 1)
- fprintf (html->file, " COLSPAN=%d", colspan);
+ 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)
- {
- bottom = table_get_rule (t, TABLE_VERT, x, y + 1);
- if (bottom > TAL_GAP)
- put_border (html->file, n_borders++, bottom, "bottom");
- }
-
- left = table_get_rule (t, TABLE_HORZ, x, y);
- if (left > TAL_GAP)
- put_border (html->file, n_borders++, left, "left");
-
- 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");
- }
-
- if (n_borders > 0)
- fputs ("\"", html->file);
-
- if (top > TAL_GAP || bottom > TAL_GAP
- || left > TAL_GAP || right > TAL_GAP)
- {
- fputs (" STYLE=\"", html->file);
- if (top > TAL_GAP)
- fprintf (html->file, "border-top: %s",
- top == TAL_1 ? "thin solid" : "double");
-
- if (top > TAL_GAP && left > TAL_GAP)
- fputs ("; ", html->file);
-
- if (left > TAL_GAP)
- fprintf (html->file, "border-left: %s",
- left == TAL_1 ? "thin solid" : "double");
- fputs ("\"", html->file);
- }
+ fprintf (html->file, " ROWSPAN=\"%d\"", rowspan);
+
+ if (html->borders)
+ {
+ /* 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 + rowspan == table_nr (t))
+ {
+ bottom = table_get_rule (t, TABLE_VERT, x, y + rowspan);
+ if (bottom > TAL_GAP)
+ put_border (html->file, n_borders++, bottom, "bottom");
+ }
+
+ left = table_get_rule (t, TABLE_HORZ, x, y);
+ if (left > TAL_GAP)
+ put_border (html->file, n_borders++, left, "left");
+
+ if (x + colspan == table_nc (t))
+ {
+ right = table_get_rule (t, TABLE_HORZ, x + colspan, y);
+ if (right > TAL_GAP)
+ put_border (html->file, n_borders++, right, "right");
+ }
+
+ if (n_borders > 0)
+ fputs ("\"", html->file);
+ }
putc ('>', html->file);
/* Output cell contents. */
- s = cell.contents;
- if (cell.options & TAB_EMPH)
- fputs ("<EM>", html->file);
- if (cell.options & TAB_FIX)
+ for (c = cell.contents; c < &cell.contents[cell.n_contents]; c++)
{
- fputs ("<TT>", html->file);
- escape_string (html->file, s, strlen (s), " ");
- fputs ("</TT>", html->file);
+ if (c->text)
+ {
+ const char *s = c->text;
+ int i;
+
+ if (c->options & TAB_EMPH)
+ fputs ("<EM>", html->file);
+ if (c->options & TAB_FIX)
+ {
+ fputs ("<TT>", html->file);
+ escape_string (html->file, s, strlen (s), " ", "<BR>");
+ fputs ("</TT>", html->file);
+ }
+ else
+ {
+ s += strspn (s, CC_SPACES);
+ escape_string (html->file, s, strlen (s), " ", "<BR>");
+ }
+ if (c->options & TAB_EMPH)
+ fputs ("</EM>", html->file);
+
+ if (c->n_footnotes > 0)
+ {
+ fputs ("<SUP>", html->file);
+ for (i = 0; i < c->n_footnotes; i++)
+ {
+ char marker[16];
+
+ if (i > 0)
+ putc (',', html->file);
+ str_format_26adic (++footnote_idx, false,
+ marker, sizeof marker);
+ fputs (marker, html->file);
+ }
+ fputs ("</SUP>", html->file);
+ }
+ }
+ else
+ html_output_table (html, c->table);
}
- else
- {
- s += strspn (s, CC_SPACES);
- escape_string (html->file, s, strlen (s), " ");
- }
- if (cell.options & TAB_EMPH)
- fputs ("</EM>", html->file);
/* Output </TH> or </TD>. */
fprintf (html->file, "</%s>\n", tag);
+ next_1:
+ x = cell.d[TABLE_HORZ][1];
table_cell_free (&cell);
}
fputs (" </TR>\n", html->file);
}
- fputs ("</TABLE>\n\n", html->file);
+ fputs ("</TBODY></TABLE>\n\n", html->file);
}
-const struct output_driver_class html_class =
+struct output_driver_factory html_driver_factory =
+ { "html", "pspp.html", html_create };
+
+static const struct output_driver_class html_driver_class =
{
"html",
- html_create,
html_destroy,
html_submit,
NULL,