html: Format new-lines as line breaks.
[pspp] / src / output / html.c
index 4452e40b678bd8feb6accf8fb26b75d750a839eb..3e85b3d968b69c76653775a7239f10c9e08869e3 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 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
@@ -39,7 +39,6 @@
 #include "output/table-item.h"
 #include "output/text-item.h"
 
-#include "error.h"
 #include "xalloc.h"
 
 #include "gettext.h"
 struct html_driver
   {
     struct output_driver driver;
-
+#ifdef HAVE_CAIRO
+    struct xr_color fg;
+    struct xr_color bg;
+#endif    
     char *file_name;
     char *chart_file_name;
 
@@ -56,15 +58,17 @@ struct html_driver
     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 *,
+                               const char *caption);
 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);
 
@@ -93,17 +97,22 @@ html_create (const char *file_name, enum settings_output_devices device_type,
   d = &html->driver;
   output_driver_init (&html->driver, &html_driver_class, file_name,
                       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->chart_file_name = parse_chart_file_name (opt (d, o, "charts",
                                                       file_name));
   html->file = NULL;
   html->chart_cnt = 1;
-
+#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->file_name, "w");
   if (html->file == NULL)
     {
-      error (0, errno, _("error opening output file `%s'"), html->file_name);
+      msg_error (errno, _("error opening output file `%s'"), html->file_name);
       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>\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);
@@ -188,7 +201,7 @@ print_title_tag (FILE *file, const char *name, const char *content)
   if (content != NULL)
     {
       fprintf (file, "<%s>", name);
-      escape_string (file, content, strlen (content), " ");
+      escape_string (file, content, strlen (content), " ", " - ");
       fprintf (file, "</%s>\n", name);
     }
 }
@@ -200,11 +213,6 @@ 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"
@@ -217,13 +225,6 @@ html_destroy (struct output_driver *driver)
   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)
@@ -232,16 +233,11 @@ html_submit (struct output_driver *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);
-      html_output_table (html, table_item);
+      html_output_table (html, table_item_get_table (table_item),
+                         table_item_get_caption (table_item));
     }
 #ifdef HAVE_CAIRO
   else if (is_chart_item (output_item) && html->chart_file_name != NULL)
@@ -250,10 +246,15 @@ 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)
         {
-          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);
         }
     }
@@ -275,7 +276,7 @@ html_submit (struct output_driver *driver,
 
         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;
@@ -289,14 +290,9 @@ html_submit (struct output_driver *driver,
           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:
@@ -331,19 +327,23 @@ html_submit (struct output_driver *driver,
     }
 }
 
-/* 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;
@@ -376,19 +376,17 @@ put_border (FILE *file, int n_borders, int style, const char *border_name)
 }
 
 static void
-html_output_table (struct html_driver *html, struct table_item *item)
+html_output_table (struct html_driver *html,
+                   const struct table *t, const char *caption)
 {
-  const struct table *t = table_item_get_table (item);
-  const char *caption;
   int x, y;
 
-  fputs ("<TABLE>\n", html->file);
+  fputs ("<TABLE><TBODY VALIGN=\"TOP\">\n", html->file);
 
-  caption = table_item_get_caption (item);
   if (caption != NULL)
     {
       fputs ("  <CAPTION>", html->file);
-      escape_string (html->file, caption, strlen (caption), " ");
+      escape_string (html->file, caption, strlen (caption), " ", "<BR>");
       fputs ("</CAPTION>\n", html->file);
     }
 
@@ -397,12 +395,12 @@ html_output_table (struct html_driver *html, struct table_item *item)
       fputs ("  <TR>\n", html->file);
       for (x = 0; x < table_nc (t); x++)
         {
+          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])
@@ -416,66 +414,80 @@ 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;
+          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);
+            fprintf (html->file, " ROWSPAN=\"%d\"", rowspan);
 
-          /* Cell borders. */
-          n_borders = 0;
+         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 == 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);
+             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)
-            {
-              fputs ("<TT>", html->file);
-              escape_string (html->file, s, strlen (s), "&nbsp;");
-              fputs ("</TT>", html->file);
-            }
-          else
+          for (c = cell.contents; c < &cell.contents[cell.n_contents]; c++)
             {
-              s += strspn (s, CC_SPACES);
-              escape_string (html->file, s, strlen (s), " ");
+              if (c->text)
+                {
+                  const char *s = c->text;
+
+                  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), "&nbsp;", "<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);
+                }
+              else
+                html_output_table (html, c->table, NULL);
             }
-          if (cell.options & TAB_EMPH)
-            fputs ("</EM>", html->file);
 
           /* Output </TH> or </TD>. */
           fprintf (html->file, "</%s>\n", tag);
@@ -485,10 +497,11 @@ html_output_table (struct html_driver *html, struct table_item *item)
       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 =
   {