Add support for reading and writing SPV files.
[pspp] / src / output / html.c
index 5aec959c740a16a69888d9f5da76ad2d56778528..307f6c223d83bb3fea6040da6e7f04d8d30ada13 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 1997-9, 2000, 2009, 2010 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
@@ -24,6 +24,7 @@
 #include <unistd.h>
 
 #include "data/file-name.h"
+#include "data/file-handle-def.h"
 #include "libpspp/assertion.h"
 #include "libpspp/cast.h"
 #include "libpspp/compiler.h"
@@ -39,8 +40,8 @@
 #include "output/table-item.h"
 #include "output/text-item.h"
 
-#include "error.h"
-#include "xalloc.h"
+#include "gl/minmax.h"
+#include "gl/xalloc.h"
 
 #include "gettext.h"
 #define _(msgid) gettext (msgid)
 struct html_driver
   {
     struct output_driver driver;
-
-    char *file_name;
+#ifdef HAVE_CAIRO
+    struct cell_color fg;
+    struct cell_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;
   };
 
 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);
 
@@ -83,7 +87,7 @@ opt (struct output_driver *d, struct string_map *options, const char *key,
 }
 
 static struct output_driver *
-html_create (const char *file_name, enum settings_output_devices device_type,
+html_create (struct file_handle *fh, enum settings_output_devices device_type,
              struct string_map *o)
 {
   struct output_driver *d;
@@ -91,19 +95,24 @@ html_create (const char *file_name, enum settings_output_devices device_type,
 
   html = xzalloc (sizeof *html);
   d = &html->driver;
-  output_driver_init (&html->driver, &html_driver_class, file_name,
+  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->file_name = xstrdup (file_name);
+  html->handle = fh;
   html->chart_file_name = parse_chart_file_name (opt (d, o, "charts",
-                                                      file_name));
+                                                      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, _("error opening output file `%s'"), html->file_name);
+      msg_error (errno, _("error opening output file `%s'"), fh_get_file_name (html->handle));
       goto error;
     }
 
@@ -113,62 +122,66 @@ html_create (const char *file_name, enum settings_output_devices device_type,
   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=utf-8\">\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);
+
+  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);
@@ -187,8 +200,8 @@ print_title_tag (FILE *file, const char *name, const char *content)
 {
   if (content != NULL)
     {
-      fprintf (file, "<%s>", name);
-      escape_string (file, content, strlen (content), " ");
+       fprintf (file, "<%s>", name);
+      escape_string (file, content, strlen (content), " ", " - ");
       fprintf (file, "</%s>\n", name);
     }
 }
@@ -200,44 +213,23 @@ html_destroy (struct output_driver *driver)
 
   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);
-  free (html->command_name);
+  fh_unref (html->handle);
   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);
 
-  output_driver_track_current_command (output_item, &html->command_name);
-
-  if (html->in_syntax && !is_syntax_item (output_item))
-    {
-      fprintf (html->file, "</PRE>\n");
-      html->in_syntax = false;
-    }
-
   if (is_table_item (output_item))
     {
       struct table_item *table_item = to_table_item (output_item);
@@ -250,7 +242,10 @@ html_submit (struct output_driver *driver,
       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)
         {
          const char *title = chart_item_get_title (chart_item);
@@ -267,85 +262,58 @@ html_submit (struct output_driver *driver,
 
       switch (text_item_get_type (text_item))
         {
-        case TEXT_ITEM_TITLE:
-          print_title_tag (html->file, "H1", s);
-          break;
-
-        case TEXT_ITEM_SUBTITLE:
-          print_title_tag (html->file, "H2", s);
-          break;
-
-        case TEXT_ITEM_COMMAND_OPEN:
-          fprintf (html->file, "<DIV class=\"");
-          escape_string (html->file, s, strlen (s), "_");
-          fprintf (html->file, "\">");
-          print_title_tag (html->file, "H3", s);
-          break;
-
-        case TEXT_ITEM_COMMAND_CLOSE:
-          fprintf (html->file, "</DIV>\n");
+        case TEXT_ITEM_PAGE_TITLE:
           break;
 
-        case TEXT_ITEM_SUBHEAD:
-          print_title_tag (html->file, "H4", s);
+        case TEXT_ITEM_TITLE:
+          {
+            int level = MIN (5, output_get_group_level ()) + 1;
+            char tag[3] = { 'H', level + '1', '\0' };
+            print_title_tag (html->file, tag, s);
+          }
           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), " ");
-          break;
-
-        case TEXT_ITEM_PARAGRAPH:
-          print_title_tag (html->file, "P", s);
+          fprintf (html->file, "<PRE class=\"syntax\">");
+          escape_string (html->file, s, strlen (s), " ", "<BR>");
+          fprintf (html->file, "</PRE>\n");
           break;
 
-        case TEXT_ITEM_MONOSPACE:
+        case TEXT_ITEM_LOG:
           print_title_tag (html->file, "PRE", s); /* should be <P><TT> */
           break;
 
-        case TEXT_ITEM_BLANK_LINE:
-          fputs ("<BR>", html->file);
-          break;
-
         case TEXT_ITEM_EJECT_PAGE:
           /* Nothing to do. */
           break;
-
-        case TEXT_ITEM_COMMENT:
-        case TEXT_ITEM_ECHO:
-          /* We print out syntax anyway, so nothing to do here either. */
-          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);
+      char *s = msg_to_string (message_item_get_msg (message_item));
       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 "&nbsp;". */
+/* Write LENGTH characters in TEXT to file F, escaping characters as necessary
+   for HTML.  Spaces are replaced by SPACE, which should be " " or "&nbsp;"
+   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 ("&amp;", file);
           break;
@@ -368,47 +336,169 @@ escape_string (FILE *file,
     }
 }
 
+static const char *
+border_to_css (int border)
+{
+  switch (border)
+    {
+    case TAL_NONE:
+      return NULL;
+
+    case TAL_SOLID:
+      return "solid";
+
+    case TAL_DASHED:
+      return "dashed";
+
+    case TAL_THICK:
+      return "thick solid";
+
+    case TAL_THIN:
+      return "thin solid";
+
+    case TAL_DOUBLE:
+      return "double";
+
+    default:
+      return NULL;
+    }
+
+}
+
+static void
+put_border (FILE *file, int *n_borders, int style, const char *border_name)
+{
+  const char *css = border_to_css (style);
+  if (css)
+    {
+      fprintf (file, "%sborder-%s: %s",
+               (*n_borders)++ == 0 ? " STYLE=\"" : "; ",
+               border_name, css);
+    }
+}
+
+static void
+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_put_footnote_markers (struct html_driver *html,
+                           const struct footnote **footnotes,
+                           size_t n_footnotes)
+{
+  if (n_footnotes > 0)
+    {
+      fputs ("<SUP>", html->file);
+      for (size_t i = 0; i < n_footnotes; i++)
+        {
+          const struct footnote *f = footnotes[i];
+
+          if (i > 0)
+            putc (',', html->file);
+          escape_string (html->file, f->marker,
+                         strlen (f->marker), " ", "<BR>");
+        }
+      fputs ("</SUP>", html->file);
+    }
+}
+
+static void
+html_put_table_item_text (struct html_driver *html,
+                          const struct table_item_text *text)
+{
+  escape_string (html->file, text->content, strlen (text->content),
+                 " ", "<BR>");
+  html_put_footnote_markers (html, text->footnotes, text->n_footnotes);
+}
+
 static void
-put_border (FILE *file, int n_borders, int style, const char *border_name)
+html_put_table_item_layers (struct html_driver *html,
+                            const struct table_item_layers *layers)
 {
-  fprintf (file, "%sborder-%s: %s",
-           n_borders == 0 ? " STYLE=\"" : "; ",
-           border_name,
-           style == TAL_1 ? "thin solid" : "double");
+  for (size_t i = 0; i < layers->n_layers; i++)
+    {
+      if (i)
+        fputs ("<BR>\n", html->file);
+
+      const struct table_item_layer *layer = &layers->layers[i];
+      escape_string (html->file, layer->content, strlen (layer->content),
+                     " ", "<BR>");
+      html_put_footnote_markers (html, layer->footnotes, layer->n_footnotes);
+    }
 }
 
 static void
-html_output_table (struct html_driver *html, struct table_item *item)
+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;
+  bool tfoot = false;
+  int y;
 
-  fputs ("<TABLE>\n", html->file);
+  fputs ("<TABLE>", html->file);
 
-  caption = table_item_get_caption (item);
-  if (caption != NULL)
+  const struct table_item_text *caption = table_item_get_caption (item);
+  if (caption)
+    {
+      put_tfoot (html, t, &tfoot);
+      html_put_table_item_text (html, caption);
+    }
+  const struct footnote **f;
+  size_t n_footnotes = table_collect_footnotes (item, &f);
+
+  for (size_t i = 0; i < n_footnotes; i++)
+    {
+      put_tfoot (html, t, &tfoot);
+      fputs ("<SUP>", html->file);
+      escape_string (html->file, f[i]->marker, strlen (f[i]->marker),
+                     " ", "<BR>");
+      fputs ("</SUP> ", html->file);
+      escape_string (html->file, f[i]->content, strlen (f[i]->content),
+                     " ", "<BR>");
+    }
+  free (f);
+  if (tfoot)
+    fputs ("</TD></TR></TFOOT>\n", html->file);
+
+  fputs ("<TBODY VALIGN=\"TOP\">\n", html->file);
+
+  const struct table_item_text *title = table_item_get_title (item);
+  const struct table_item_layers *layers = table_item_get_layers (item);
+  if (title || layers)
     {
       fputs ("  <CAPTION>", html->file);
-      escape_string (html->file, caption, strlen (caption), " ");
+      if (title)
+        html_put_table_item_text (html, title);
+      if (title && layers)
+        fputs ("<BR>\n", html->file);
+      if (layers)
+        html_put_table_item_layers (html, layers);
       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); )
         {
           struct table_cell cell;
           const char *tag;
           bool is_header;
-          int alignment, colspan, rowspan;
-          int top, left, right, bottom, n_borders;
-          const char *s;
+          int colspan, rowspan;
+          int top, left, right, bottom;
 
           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)
@@ -418,10 +508,23 @@ html_output_table (struct html_driver *html, struct table_item *item)
           tag = is_header ? "TH" : "TD";
           fprintf (html->file, "    <%s", tag);
 
-          alignment = cell.options & TAB_ALIGNMENT;
-          if (alignment != TAB_LEFT)
+          enum table_halign halign = table_halign_interpret (
+            cell.style->cell_style.halign, cell.options & TAB_NUMERIC);
+          if (halign != TABLE_HALIGN_LEFT)
+            {
+              fprintf (html->file, " ALIGN=\"%s\"",
+                       (halign == TABLE_HALIGN_RIGHT ? "RIGHT"
+                        : halign == TABLE_HALIGN_CENTER ? "CENTER"
+                        : "CHAR"));
+              if (cell.style->cell_style.decimal_char)
+                fprintf (html->file, " CHAR=\"%c\"",
+                         cell.style->cell_style.decimal_char);
+            }
+
+          if (cell.style->cell_style.valign != TABLE_VALIGN_TOP)
             fprintf (html->file, " ALIGN=\"%s\"",
-                     alignment == TAB_RIGHT ? "RIGHT" : "CENTER");
+                     (cell.style->cell_style.valign == TABLE_VALIGN_BOTTOM
+                      ? "BOTTOM" : "MIDDLE"));
 
           colspan = table_cell_colspan (&cell);
           if (colspan > 1)
@@ -431,66 +534,69 @@ html_output_table (struct html_driver *html, struct table_item *item)
           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 (html->borders)
+           {
+             /* Cell borders. */
+             int n_borders = 0;
 
-          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");
-            }
+              struct cell_color color;
+             top = table_get_rule (t, TABLE_VERT, x, y, &color);
+              put_border (html->file, &n_borders, top, "top");
 
-          left = table_get_rule (t, TABLE_HORZ, x, y);
-          if (left > TAL_GAP)
-            put_border (html->file, n_borders++, left, "left");
+             if (y + rowspan == table_nr (t))
+               {
+                 bottom = table_get_rule (t, TABLE_VERT, x, y + rowspan,
+                                           &color);
+                  put_border (html->file, &n_borders, bottom, "bottom");
+               }
 
-          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");
-            }
+             left = table_get_rule (t, TABLE_HORZ, x, y, &color);
+              put_border (html->file, &n_borders, left, "left");
 
-          if (n_borders > 0)
-            fputs ("\"", html->file);
+             if (x + colspan == table_nc (t))
+               {
+                 right = table_get_rule (t, TABLE_HORZ, x + colspan, y,
+                                          &color);
+                  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);
+          const char *s = cell.text;
           if (cell.options & TAB_FIX)
             {
               fputs ("<TT>", html->file);
-              escape_string (html->file, s, strlen (s), "&nbsp;");
+              escape_string (html->file, s, strlen (s), "&nbsp;", "<BR>");
               fputs ("</TT>", html->file);
             }
           else
             {
               s += strspn (s, CC_SPACES);
-              escape_string (html->file, s, strlen (s), " ");
+              escape_string (html->file, s, strlen (s), " ", "<BR>");
             }
-          if (cell.options & TAB_EMPH)
-            fputs ("</EM>", html->file);
+
+          html_put_footnote_markers (html, cell.footnotes, cell.n_footnotes);
 
           /* 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);
 }
 
-struct output_driver_factory html_driver_factory = { "html", html_create };
+struct output_driver_factory html_driver_factory =
+  { "html", "pspp.html", html_create };
 
 static const struct output_driver_class html_driver_class =
   {