treewide: Replace <name>_cnt by n_<name>s and <name>_cap by allocated_<name>.
[pspp] / src / output / html.c
index f731686ce78711ab1dc0fdfaf7da6b7a2701127a..a2e63f943888169a1e30458f6b7d0b100bc6e102 100644 (file)
 #include "libpspp/i18n.h"
 #include "libpspp/message.h"
 #include "libpspp/version.h"
-#ifdef HAVE_CAIRO
 #include "output/cairo-chart.h"
-#endif
-#include "output/chart-item.h"
+#include "output/chart.h"
 #include "output/driver-provider.h"
-#include "output/message-item.h"
 #include "output/options.h"
-#include "output/output-item-provider.h"
+#include "output/output-item.h"
+#include "output/pivot-output.h"
+#include "output/pivot-table.h"
 #include "output/table-provider.h"
-#include "output/table-item.h"
-#include "output/text-item.h"
 
 #include "gl/minmax.h"
 #include "gl/xalloc.h"
 struct html_driver
   {
     struct output_driver driver;
-#ifdef HAVE_CAIRO
     struct cell_color fg;
     struct cell_color bg;
-#endif
     struct file_handle *handle;
     char *chart_file_name;
 
     FILE *file;
-    size_t chart_cnt;
+    size_t n_charts;
 
     bool bare;
     bool css;
@@ -75,7 +70,8 @@ struct html_driver
 
 static const struct output_driver_class html_driver_class;
 
-static void html_output_table (struct html_driver *, const struct table_item *);
+static void html_output_table (struct html_driver *,
+                               const struct output_item *);
 static void escape_string (FILE *file, const char *text,
                            const char *space, const char *newline);
 static void print_title_tag (FILE *file, const char *name,
@@ -184,9 +180,7 @@ html_create (struct file_handle *fh, enum settings_output_devices device_type,
              struct string_map *o)
 {
   struct output_driver *d;
-  struct html_driver *html;
-
-  html = xzalloc (sizeof *html);
+  struct html_driver *html = XZALLOC (struct html_driver);
   d = &html->driver;
   output_driver_init (&html->driver, &html_driver_class, fh_get_file_name (fh),
                       device_type);
@@ -198,11 +192,9 @@ html_create (struct file_handle *fh, enum settings_output_devices device_type,
   html->chart_file_name = parse_chart_file_name (opt (d, o, "charts",
                                                       fh_get_file_name (fh)));
   html->file = NULL;
-  html->chart_cnt = 1;
-#ifdef HAVE_CAIRO
+  html->n_charts = 1;
   html->bg = parse_color (opt (d, o, "background-color", "#FFFFFFFFFFFF"));
   html->fg = parse_color (opt (d, o, "foreground-color", "#000000000000"));
-#endif
   html->file = fn_open (html->handle, "w");
   if (html->file == NULL)
     {
@@ -253,78 +245,106 @@ html_destroy (struct output_driver *driver)
 }
 
 static void
-html_submit (struct output_driver *driver,
-             const struct output_item *output_item)
+html_submit__ (struct output_driver *driver, const struct output_item *item,
+               int level)
 {
   struct html_driver *html = html_driver_cast (driver);
 
-  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)
+  switch (item->type)
     {
-      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->fg,
-                                    &html->bg
-                               );
-      if (file_name != NULL)
+    case OUTPUT_ITEM_CHART:
+      if (html->chart_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);
+          char *file_name = xr_draw_png_chart (item->chart,
+                                               html->chart_file_name,
+                                               html->n_charts++,
+                                               &html->fg, &html->bg);
+          if (file_name != NULL)
+            {
+              const char *title = chart_get_title (item->chart);
+              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);
-      const char *s = text_item_get_text (text_item);
-
-      switch (text_item_get_type (text_item))
-        {
-        case TEXT_ITEM_PAGE_TITLE:
-          break;
-
-        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;
+      break;
 
-        case TEXT_ITEM_SYNTAX:
-          fprintf (html->file, "<pre class=\"syntax\">");
-          escape_string (html->file, s, " ", "<br>");
-          fprintf (html->file, "</pre>\n");
-          break;
+    case OUTPUT_ITEM_GROUP:
+      for (size_t i = 0; i < item->group.n_children; i++)
+        html_submit__ (driver, item->group.children[i], level + 1);
+      break;
 
-        case TEXT_ITEM_LOG:
-          fprintf (html->file, "<p>");
-          escape_string (html->file, s, " ", "<br>");
-          fprintf (html->file, "</p>\n");
-          break;
+    case OUTPUT_ITEM_IMAGE:
+      if (html->chart_file_name)
+        {
+          char *file_name = xr_write_png_image (
+            item->image, html->chart_file_name, ++html->n_charts);
+          if (file_name != NULL)
+            {
+              fprintf (html->file, "<img src=\"%s\">", file_name);
+              free (file_name);
+            }
         }
-    }
-  else if (is_message_item (output_item))
-    {
-      const struct message_item *message_item = to_message_item (output_item);
-      char *s = msg_to_string (message_item_get_msg (message_item));
+      break;
+
+    case OUTPUT_ITEM_MESSAGE:
       fprintf (html->file, "<p>");
+
+      char *s = msg_to_string (item->message);
       escape_string (html->file, s, " ", "<br>");
-      fprintf (html->file, "</p>\n");
       free (s);
+
+      fprintf (html->file, "</p>\n");
+      break;
+
+    case OUTPUT_ITEM_PAGE_BREAK:
+      break;
+
+    case OUTPUT_ITEM_TABLE:
+      html_output_table (html, item);
+      break;
+
+    case OUTPUT_ITEM_TEXT:
+      {
+        char *s = text_item_get_plain_text (item);
+
+        switch (item->text.subtype)
+          {
+          case TEXT_ITEM_PAGE_TITLE:
+            break;
+
+          case TEXT_ITEM_TITLE:
+            {
+              char tag[3] = { 'H', MIN (5, level) + '0', '\0' };
+              print_title_tag (html->file, tag, s);
+            }
+            break;
+
+          case TEXT_ITEM_SYNTAX:
+            fprintf (html->file, "<pre class=\"syntax\">");
+            escape_string (html->file, s, " ", "<br>");
+            fprintf (html->file, "</pre>\n");
+            break;
+
+          case TEXT_ITEM_LOG:
+            fprintf (html->file, "<p>");
+            escape_string (html->file, s, " ", "<br>");
+            fprintf (html->file, "</p>\n");
+            break;
+          }
+
+        free (s);
+      }
+      break;
     }
 }
 
+static void
+html_submit (struct output_driver *driver, const struct output_item *item)
+{
+  html_submit__ (driver, item, 1);
+}
+
 /* Write 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. */
@@ -364,18 +384,6 @@ escape_string (FILE *file, const char *text,
     }
 }
 
-static void
-escape_tag (FILE *file, const char *tag,
-            const char *text, const char *space, const char *newline)
-{
-  if (!text || !*text)
-    return;
-
-  fprintf (file, "<%s>", tag);
-  escape_string (file, text, space, newline);
-  fprintf (file, "</%s>", tag);
-}
-
 static const char *
 border_to_css (int border)
 {
@@ -480,88 +488,20 @@ put_border (const struct table *table, const struct table_cell *cell,
 }
 
 static void
-put_tfoot (struct html_driver *html, const struct table *t, bool *tfoot)
-{
-  if (!*tfoot)
-    {
-      fputs ("<tfoot>\n", html->file);
-      fputs ("<tr>\n", html->file);
-      fprintf (html->file, "<td colspan=%d>\n", t->n[H]);
-      *tfoot = true;
-    }
-  else
-    fputs ("\n<br>", html->file);
-}
-
-static void
-html_put_footnote_markers (struct html_driver *html,
-                           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, " ", "<br>");
-        }
-      fputs ("</sup>", html->file);
-    }
-}
-
-static void
-html_put_table_cell_text (struct html_driver *html,
-                          const struct table_cell *cell)
-{
-  const char *s = cell->text;
-  s += strspn (s, CC_SPACES);
-  escape_string (html->file, s, " ", "<br>");
-
-  if (cell->n_subscripts)
-    {
-      fputs ("<sub>", html->file);
-      for (size_t i = 0; i < cell->n_subscripts; i++)
-        {
-          if (i)
-            putc (',', html->file);
-          escape_string (html->file, cell->subscripts[i],
-                         "&nbsp;", "<br>");
-        }
-      fputs ("</sub>", html->file);
-    }
-  html_put_footnote_markers (html, cell->footnotes, cell->n_footnotes);
-}
-
-static void
-html_put_table_item_layers (struct html_driver *html,
-                            const struct table_item_layers *layers)
-{
-  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, " ", "<br>");
-      html_put_footnote_markers (html, layer->footnotes, layer->n_footnotes);
-    }
-}
-
-static void
-html_put_table_cell (struct html_driver *html, const struct table *t,
-                     const struct table_cell *cell, const char *tag,
-                     bool border)
+html_put_table_cell (struct html_driver *html, const struct pivot_table *pt,
+                     const struct table_cell *cell,
+                     const char *tag, const struct table *t)
 {
   fprintf (html->file, "<%s", tag);
 
   struct css_style style;
   style_start (&style, html->file);
-  enum table_halign halign = table_halign_interpret (
-    cell->style->cell_style.halign, cell->options & TAB_NUMERIC);
+
+  struct string body = DS_EMPTY_INITIALIZER;
+  bool numeric = pivot_value_format_body (cell->value, pt, &body);
+
+  enum table_halign halign = table_halign_interpret (cell->cell_style->halign,
+                                                     numeric);
 
   switch (halign)
     {
@@ -579,14 +519,14 @@ html_put_table_cell (struct html_driver *html, const struct table *t,
   if (cell->options & TAB_ROTATE)
     put_style (&style, "writing-mode", "sideways-lr");
 
-  if (cell->style->cell_style.valign != TABLE_VALIGN_TOP)
+  if (cell->cell_style->valign != TABLE_VALIGN_TOP)
     {
       put_style (&style, "vertical-align",
-                 (cell->style->cell_style.valign == TABLE_VALIGN_BOTTOM
+                 (cell->cell_style->valign == TABLE_VALIGN_BOTTOM
                   ? "bottom" : "middle"));
     }
 
-  const struct font_style *fs = &cell->style->font_style;
+  const struct font_style *fs = cell->font_style;
   char bgcolor[32];
   if (format_color (fs->bg[cell->d[V][0] % 2],
                     (struct cell_color) CELL_COLOR_WHITE,
@@ -618,7 +558,7 @@ html_put_table_cell (struct html_driver *html, const struct table *t,
       put_style (&style, "font-size", buf);
     }
 
-  if (border)
+  if (t && html->borders)
     {
       put_border (t, cell, &style, V, 0, 0, "top");
       put_border (t, cell, &style, H, 0, 0, "left");
@@ -640,90 +580,159 @@ html_put_table_cell (struct html_driver *html, const struct table *t,
 
   putc ('>', html->file);
 
-  html_put_table_cell_text (html, cell);
+  const char *s = ds_cstr (&body);
+  s += strspn (s, CC_SPACES);
+  escape_string (html->file, s, " ", "<br>");
+  ds_destroy (&body);
+
+  const struct pivot_value_ex *ex = pivot_value_ex (cell->value);
+  if (ex->n_subscripts)
+    {
+      fputs ("<sub>", html->file);
+      for (size_t i = 0; i < ex->n_subscripts; i++)
+        {
+          if (i)
+            putc (',', html->file);
+          escape_string (html->file, ex->subscripts[i], "&nbsp;", "<br>");
+        }
+      fputs ("</sub>", html->file);
+    }
+  if (ex->n_footnotes > 0)
+    {
+      fputs ("<sup>", html->file);
+      size_t n_footnotes = 0;
+      for (size_t i = 0; i < ex->n_footnotes; i++)
+        {
+          const struct pivot_footnote *f
+            = pt->footnotes[ex->footnote_indexes[i]];
+          if (f->show)
+            {
+              if (n_footnotes++ > 0)
+                putc (',', html->file);
+
+              char *marker = pivot_footnote_marker_string (f, pt);
+              escape_string (html->file, marker, " ", "<br>");
+              free (marker);
+            }
+        }
+      fputs ("</sup>", html->file);
+    }
 
   /* output </th> or </td>. */
   fprintf (html->file, "</%s>\n", tag);
 }
 
 static void
-html_output_table (struct html_driver *html, const struct table_item *item)
+html_output_table_layer (struct html_driver *html, const struct pivot_table *pt,
+                         const size_t *layer_indexes)
 {
-  const struct table *t = table_item_get_table (item);
-  bool tfoot = false;
+  struct table *title, *layers, *body, *caption, *footnotes;
+  pivot_output (pt, layer_indexes, true, &title, &layers, &body,
+                &caption, &footnotes, NULL, NULL);
 
   fputs ("<table", html->file);
-  if (item->notes)
+  if (pt->notes)
     {
       fputs (" title=\"", html->file);
-      escape_string (html->file, item->notes, " ", "\n");
+      escape_string (html->file, pt->notes, " ", "\n");
       putc ('"', html->file);
     }
   fputs (">\n", html->file);
 
-  const struct table_cell *caption = table_item_get_caption (item);
-  if (caption)
+  if (title)
     {
-      put_tfoot (html, t, &tfoot);
-      html_put_table_cell (html, t, caption, "span", false);
+      struct table_cell cell;
+      table_get_cell (title, 0, 0, &cell);
+      html_put_table_cell (html, pt, &cell, "caption", NULL);
     }
-  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);
-      escape_tag (html->file, "sup", f[i]->marker, " ", "<br>");
-      escape_string (html->file, f[i]->content, " ", "<br>");
-    }
-  free (f);
-  if (tfoot)
+  if (layers)
     {
-      fputs ("</td>\n", html->file);
-      fputs ("</tr>\n", html->file);
-      fputs ("</tfoot>\n", html->file);
-    }
+      fputs ("<thead>\n", html->file);
+      for (size_t y = 0; y < layers->n[V]; y++)
+        {
+          fputs ("<tr>\n", html->file);
 
-  const struct table_cell *title = table_item_get_title (item);
-  const struct table_item_layers *layers = table_item_get_layers (item);
-  if (title || layers)
-    {
-      fputs ("<caption>", html->file);
-      if (title)
-        html_put_table_cell (html, t, title, "span", false);
-      if (title && layers)
-        fputs ("<br>\n", html->file);
-      if (layers)
-        html_put_table_item_layers (html, layers);
-      fputs ("</caption>\n", html->file);
+          struct table_cell cell;
+          table_get_cell (layers, 0, y, &cell);
+          cell.d[H][1] = body->n[H];
+          html_put_table_cell (html, pt, &cell, "td", NULL);
+
+          fputs ("</tr>\n", html->file);
+        }
+      fputs ("</thead>\n", html->file);
     }
 
   fputs ("<tbody>\n", html->file);
-
-  for (int y = 0; y < t->n[V]; y++)
+  for (int y = 0; y < body->n[V]; y++)
     {
       fputs ("<tr>\n", html->file);
-      for (int x = 0; x < t->n[H]; )
+      for (int x = 0; x < body->n[H]; )
         {
           struct table_cell cell;
-          table_get_cell (t, x, y, &cell);
+          table_get_cell (body, x, y, &cell);
           if (x == cell.d[TABLE_HORZ][0] && y == cell.d[TABLE_VERT][0])
             {
-              bool is_header = (y < t->h[V][0]
-                                || y >= t->n[V] - t->h[V][1]
-                                || x < t->h[H][0]
-                                || x >= t->n[H] - t->h[H][1]);
+              bool is_header = (y < body->h[V][0]
+                                || y >= body->n[V] - body->h[V][1]
+                                || x < body->h[H][0]
+                                || x >= body->n[H] - body->h[H][1]);
               const char *tag = is_header ? "th" : "td";
-              html_put_table_cell (html, t, &cell, tag, html->borders);
+              html_put_table_cell (html, pt, &cell, tag, body);
             }
 
           x = cell.d[TABLE_HORZ][1];
         }
       fputs ("</tr>\n", html->file);
     }
-
   fputs ("</tbody>\n", html->file);
+
+  if (caption || footnotes)
+    {
+      fprintf (html->file, "<tfoot>\n");
+
+      if (caption)
+        {
+          fputs ("<tr>\n", html->file);
+
+          struct table_cell cell;
+          table_get_cell (caption, 0, 0, &cell);
+          cell.d[H][1] = body->n[H];
+          html_put_table_cell (html, pt, &cell, "td", NULL);
+
+          fputs ("</tr>\n", html->file);
+        }
+
+      if (footnotes)
+        for (size_t y = 0; y < footnotes->n[V]; y++)
+          {
+            fputs ("<tr>\n", html->file);
+
+            struct table_cell cell;
+            table_get_cell (footnotes, 0, y, &cell);
+            cell.d[H][1] = body->n[H];
+            html_put_table_cell (html, pt, &cell, "td", NULL);
+
+            fputs ("</tr>\n", html->file);
+          }
+      fputs ("</tfoot>\n", html->file);
+    }
+
   fputs ("</table>\n\n", html->file);
+
+  table_unref (title);
+  table_unref (layers);
+  table_unref (body);
+  table_unref (caption);
+  table_unref (footnotes);
+}
+
+static void
+html_output_table (struct html_driver *html, const struct output_item *item)
+{
+  size_t *layer_indexes;
+  PIVOT_OUTPUT_FOR_EACH_LAYER (layer_indexes, item->table, true)
+    html_output_table_layer (html, item->table, layer_indexes);
 }
 
 struct output_driver_factory html_driver_factory =
@@ -731,8 +740,8 @@ struct output_driver_factory html_driver_factory =
 
 static const struct output_driver_class html_driver_class =
   {
-    "html",
-    html_destroy,
-    html_submit,
-    NULL,
+    .name = "html",
+    .destroy = html_destroy,
+    .submit = html_submit,
+    .handles_groups = true,
   };