output: Remove support for bottom and right side headers.
[pspp] / src / output / html.c
index ecaf729dd74e4377142dc7f40ec6669ce8df0379..99390f9ded51e5cebc0571f5ab4346d100c6aae0 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;
@@ -77,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,
@@ -90,11 +84,10 @@ html_driver_cast (struct output_driver *driver)
   return UP_CAST (driver, struct html_driver, driver);
 }
 
-static struct driver_option *
-opt (struct output_driver *d, struct string_map *options, const char *key,
-     const char *default_value)
+static struct driver_option
+opt (struct driver_options *options, const char *key, const char *default_value)
 {
-  return driver_option_get (d, options, key, default_value);
+  return driver_option_get (options, key, default_value);
 }
 
 static void
@@ -183,43 +176,39 @@ put_header (struct html_driver *html)
 
 static struct output_driver *
 html_create (struct file_handle *fh, enum settings_output_devices device_type,
-             struct string_map *o)
+             struct driver_options *o)
 {
-  struct output_driver *d;
-  struct html_driver *html;
-
-  html = xzalloc (sizeof *html);
-  d = &html->driver;
-  output_driver_init (&html->driver, &html_driver_class, fh_get_file_name (fh),
-                      device_type);
-  html->bare = parse_boolean (opt (d, o, "bare", "false"));
-  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;
-#ifdef HAVE_CAIRO
-  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)
+  FILE *file = fn_open (fh, "w");
+  if (!file)
     {
-      msg_error (errno, _("error opening output file `%s'"), fh_get_file_name (html->handle));
-      goto error;
+      msg_error (errno, _("error opening output file `%s'"),
+                 fh_get_file_name (fh));
+      return NULL;
     }
 
+  struct html_driver *html = xmalloc (sizeof *html);
+  *html = (struct html_driver) {
+    .driver = {
+      .class = &html_driver_class,
+      .name = xstrdup (fh_get_file_name (fh)),
+      .device_type = device_type
+    },
+    .bare = parse_boolean (opt (o, "bare", "false")),
+    .css = parse_boolean (opt (o, "css", "true")),
+    .borders = parse_boolean (opt (o, "borders", "true")),
+    .handle = fh,
+    .chart_file_name = parse_chart_file_name (opt (o, "charts",
+                                                   fh_get_file_name (fh))),
+    .file = file,
+    .n_charts = 1,
+    .bg = parse_color (opt (o, "background-color", "#FFFFFFFFFFFF")),
+    .fg = parse_color (opt (o, "foreground-color", "#000000000000")),
+  };
+
   if (!html->bare)
     put_header (html);
 
-  return d;
-
- error:
-  output_driver_destroy (d);
-  return NULL;
+  return &html->driver;
 }
 
 /* Emits <NAME>CONTENT</NAME> to the output, escaping CONTENT as
@@ -255,78 +244,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. */
@@ -436,7 +453,7 @@ format_color (const struct cell_color color,
               const struct cell_color default_color,
               char *buf, size_t bufsize)
 {
-  bool retval = !cell_color_equal (&color, &default_color);
+  bool retval = !cell_color_equal (color, default_color);
   if (retval)
     {
       if (color.alpha == 255)
@@ -454,16 +471,16 @@ put_border (const struct table *table, const struct table_cell *cell,
             enum table_axis axis, int h, int v,
             const char *border_name)
 {
-  struct cell_color color;
-  const char *css = border_to_css (
-    table_get_rule (table, axis, cell->d[H][h], cell->d[V][v], &color));
+  struct table_border_style border
+    = table_get_rule (table, axis, cell->d[H][h], cell->d[V][v]);
+  const char *css = border_to_css (border.stroke);
   if (css)
     {
       next_style (style);
       fprintf (style->file, "border-%s: %s", border_name, css);
 
       char buf[32];
-      if (format_color (color, (struct cell_color) CELL_COLOR_BLACK,
+      if (format_color (border.color, (struct cell_color) CELL_COLOR_BLACK,
                         buf, sizeof buf))
         fprintf (style->file, " %s", buf);
     }
@@ -498,7 +515,7 @@ html_put_table_cell (struct html_driver *html, const struct pivot_table *pt,
       break;
     }
 
-  if (cell->options & TAB_ROTATE)
+  if (cell->options & TABLE_CELL_ROTATE)
     put_style (&style, "writing-mode", "sideways-lr");
 
   if (cell->cell_style->valign != TABLE_VALIGN_TOP)
@@ -567,31 +584,35 @@ html_put_table_cell (struct html_driver *html, const struct pivot_table *pt,
   escape_string (html->file, s, " ", "<br>");
   ds_destroy (&body);
 
-  if (cell->value->n_subscripts)
+  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 < cell->value->n_subscripts; i++)
+      for (size_t i = 0; i < ex->n_subscripts; i++)
         {
           if (i)
             putc (',', html->file);
-          escape_string (html->file, cell->value->subscripts[i],
-                         "&nbsp;", "<br>");
+          escape_string (html->file, ex->subscripts[i], "&nbsp;", "<br>");
         }
       fputs ("</sub>", html->file);
     }
-  if (cell->value->n_footnotes > 0)
+  if (ex->n_footnotes > 0)
     {
       fputs ("<sup>", html->file);
-      for (size_t i = 0; i < cell->value->n_footnotes; i++)
+      size_t n_footnotes = 0;
+      for (size_t i = 0; i < ex->n_footnotes; i++)
         {
-          if (i > 0)
-            putc (',', html->file);
+          const struct pivot_footnote *f
+            = pt->footnotes[ex->footnote_indexes[i]];
+          if (f->show)
+            {
+              if (n_footnotes++ > 0)
+                putc (',', html->file);
 
-          size_t idx = cell->value->footnote_indexes[i];
-          const struct pivot_footnote *f = pt->footnotes[idx];
-          char *marker = pivot_value_to_string (f->marker, pt);
-          escape_string (html->file, marker, " ", "<br>");
-          free (marker);
+              char *marker = pivot_footnote_marker_string (f, pt);
+              escape_string (html->file, marker, " ", "<br>");
+              free (marker);
+            }
         }
       fputs ("</sup>", html->file);
     }
@@ -651,10 +672,10 @@ html_output_table_layer (struct html_driver *html, const struct pivot_table *pt,
           table_get_cell (body, x, y, &cell);
           if (x == cell.d[TABLE_HORZ][0] && y == cell.d[TABLE_VERT][0])
             {
-              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]);
+              bool is_header = (y < body->h[V]
+                                || y >= body->n[V]
+                                || x < body->h[H]
+                                || x >= body->n[H]);
               const char *tag = is_header ? "th" : "td";
               html_put_table_cell (html, pt, &cell, tag, body);
             }
@@ -706,11 +727,11 @@ html_output_table_layer (struct html_driver *html, const struct pivot_table *pt,
 }
 
 static void
-html_output_table (struct html_driver *html, const struct table_item *item)
+html_output_table (struct html_driver *html, const struct output_item *item)
 {
   size_t *layer_indexes;
-  PIVOT_OUTPUT_FOR_EACH_LAYER (layer_indexes, item->pt, true)
-    html_output_table_layer (html, item->pt, 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 =
@@ -718,8 +739,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,
   };