output: Add support for vertical alignment of cells.
[pspp] / src / output / html.c
index 715682a9ea02087a92f4857938a4106b9ead7da3..9cc9a5c2b8f594d16de8c617b977e5618343d2a1 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 1997-9, 2000, 2009, 2010, 2011, 2012, 2013, 2014 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"
@@ -50,11 +51,10 @@ struct html_driver
 #ifdef HAVE_CAIRO
     struct xr_color fg;
     struct xr_color bg;
-#endif    
-    char *file_name;
+#endif
+    struct file_handle *handle;
     char *chart_file_name;
 
-    char *command_name;
     FILE *file;
     size_t chart_cnt;
 
@@ -86,7 +86,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;
@@ -94,24 +94,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;
 #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");
+  html->file = fn_open (html->handle, "w");
   if (html->file == NULL)
     {
-      msg_error (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;
     }
 
@@ -216,11 +216,10 @@ html_destroy (struct output_driver *driver)
                "</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);
 }
 
@@ -230,8 +229,6 @@ html_submit (struct output_driver *driver,
 {
   struct html_driver *html = html_driver_cast (driver);
 
-  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);
@@ -319,7 +316,7 @@ html_submit (struct output_driver *driver,
     {
       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 (msg, message_item->command_name);
       print_title_tag (html->file, "P", s);
       free (s);
     }
@@ -374,64 +371,87 @@ put_border (FILE *file, int n_borders, int style, const char *border_name)
 }
 
 static void
-html_output_table (struct html_driver *html, const struct table_item *item)
+put_tfoot (struct html_driver *html, const struct table *t, bool *tfoot)
 {
-  const struct table *t = table_item_get_table (item);
-  const char *title = table_item_get_title (item);
-  int footnote_idx = 0;
-  int y;
-
-  fputs ("<TABLE>", html->file);
-
-  footnote_idx = 0;
-  for (y = 0; y < table_nr (t); y++)
+  if (!*tfoot)
     {
-      int x;
+      fprintf (html->file, "<TFOOT><TR><TD COLSPAN=%d>", table_nc (t));
+      *tfoot = true;
+    }
+  else
+    fputs ("\n<BR>", html->file);
+}
 
-      for (x = 0; x < table_nc (t); )
+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 cell_contents *c;
-          struct table_cell cell;
-
-          table_get_cell (t, x, y, &cell);
-          if (y != cell.d[TABLE_VERT][0])
-            continue;
-
-          for (c = cell.contents; c < &cell.contents[cell.n_contents]; c++)
-            {
-              int i;
+          const struct footnote *f = footnotes[i];
 
-              for (i = 0; i < c->n_footnotes; i++)
-                {
-                  char marker[16];
-
-                  if (!footnote_idx)
-                    fprintf (html->file, "<TFOOT><TR><TD COLSPAN=%d>",
-                             table_nc (t));
-                  else
-                    fputs ("\n<BR>", html->file);
-                  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>");
-                }
-            }
-          x = cell.d[TABLE_HORZ][1];
-          table_cell_free (&cell);
+          if (i > 0)
+            putc (',', html->file);
+          escape_string (html->file, f->marker,
+                         strlen (f->marker), " ", "<BR>");
         }
+      fputs ("</SUP>", html->file);
     }
-  if (footnote_idx)
+}
+
+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
+html_output_table (struct html_driver *html, const struct table_item *item)
+{
+  const struct table *t = table_item_get_table (item);
+  bool tfoot = false;
+  int y;
+
+  fputs ("<TABLE>", html->file);
+
+  const struct table_item_text *caption = table_item_get_caption (item);
+  if (caption)
     {
-      fputs ("</TD></TR></TFOOT>\n", html->file);
-      footnote_idx = 0;
+      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++)
+    if (f[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);
 
-  if (title != NULL)
+  const struct table_item_text *title = table_item_get_title (item);
+  if (title)
     {
       fputs ("  <CAPTION>", html->file);
-      escape_string (html->file, title, strlen (title), " ", "<BR>");
+      html_put_table_item_text (html, title);
       fputs ("</CAPTION>\n", html->file);
     }
 
@@ -446,12 +466,12 @@ html_output_table (struct html_driver *html, const struct table_item *item)
           struct table_cell cell;
           const char *tag;
           bool is_header;
-          int alignment, colspan, rowspan;
+          int colspan, rowspan;
           int top, left, right, bottom, n_borders;
 
           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)
@@ -461,12 +481,19 @@ html_output_table (struct html_driver *html, const struct table_item *item)
           tag = is_header ? "TH" : "TD";
           fprintf (html->file, "    <%s", tag);
 
-          alignment = (cell.n_contents > 0
-                       ? cell.contents[0].options & TAB_ALIGNMENT
-                       : TAB_LEFT);
-          if (alignment != TAB_LEFT)
+          int halign = (cell.n_contents > 0
+                        ? cell.contents[0].options & TAB_HALIGN
+                        : TAB_LEFT);
+          if (halign != TAB_LEFT)
+            fprintf (html->file, " ALIGN=\"%s\"",
+                     halign == TAB_RIGHT ? "RIGHT" : "CENTER");
+
+          int valign = (cell.n_contents > 0
+                        ? cell.contents[0].options & TAB_VALIGN
+                        : TAB_LEFT);
+          if (valign != TAB_TOP)
             fprintf (html->file, " ALIGN=\"%s\"",
-                     alignment == TAB_RIGHT ? "RIGHT" : "CENTER");
+                     valign == TAB_BOTTOM ? "BOTTOM" : "MIDDLE");
 
           colspan = table_cell_colspan (&cell);
           if (colspan > 1)
@@ -480,26 +507,26 @@ html_output_table (struct html_driver *html, const struct table_item *item)
            {
              /* Cell borders. */
              n_borders = 0;
-          
+
              top = table_get_rule (t, TABLE_VERT, x, y);
-             if (top > TAL_GAP)
+             if (top > TAL_0)
                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)
+                 if (bottom > TAL_0)
                    put_border (html->file, n_borders++, bottom, "bottom");
                }
 
              left = table_get_rule (t, TABLE_HORZ, x, y);
-             if (left > TAL_GAP)
+             if (left > TAL_0)
                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)
+                 if (right > TAL_0)
                    put_border (html->file, n_borders++, right, "right");
                }
 
@@ -512,50 +539,31 @@ html_output_table (struct html_driver *html, const struct table_item *item)
           /* Output cell contents. */
           for (c = cell.contents; c < &cell.contents[cell.n_contents]; c++)
             {
-              if (c->text)
+              const char *s = c->text;
+
+              if (c->options & TAB_EMPH)
+                fputs ("<EM>", html->file);
+              if (c->options & TAB_FIX)
                 {
-                  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), "&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);
-
-                  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);
-                    }
+                  fputs ("<TT>", html->file);
+                  escape_string (html->file, s, strlen (s), "&nbsp;", "<BR>");
+                  fputs ("</TT>", html->file);
                 }
               else
-                html_output_table (html, c->table);
+                {
+                  s += strspn (s, CC_SPACES);
+                  escape_string (html->file, s, strlen (s), " ", "<BR>");
+                }
+              if (c->options & TAB_EMPH)
+                fputs ("</EM>", html->file);
+
+              html_put_footnote_markers (html, c->footnotes, c->n_footnotes);
             }
 
           /* Output </TH> or </TD>. */
           fprintf (html->file, "</%s>\n", tag);
 
+       next_1:
           x = cell.d[TABLE_HORZ][1];
           table_cell_free (&cell);
         }