output-item: Collapse the inheritance hierarchy into a single struct.
[pspp] / src / output / driver.c
index 44aa2558247394b3c81f6f5341ebead2ca501437..6f5d4633ce015e754deddb8c34480ae4af451bf3 100644 (file)
@@ -21,8 +21,6 @@
 
 #include <ctype.h>
 #include <errno.h>
-#include <libxml/parser.h>
-#include <libxml/tree.h>
 #include <limits.h>
 #include <stdlib.h>
 #include <string.h>
 #include "data/settings.h"
 #include "libpspp/array.h"
 #include "libpspp/assertion.h"
+#include "libpspp/i18n.h"
 #include "libpspp/message.h"
 #include "libpspp/llx.h"
 #include "libpspp/string-map.h"
 #include "libpspp/string-set.h"
 #include "libpspp/str.h"
-#include "output/group-item.h"
-#include "output/message-item.h"
 #include "output/output-item.h"
-#include "output/text-item.h"
 
 #include "gl/error.h"
 #include "gl/xalloc.h"
@@ -53,7 +49,7 @@ struct output_engine
   {
     struct ll ll;                  /* Node for this engine. */
     struct llx_list drivers;       /* Contains "struct output_driver"s. */
-    struct string deferred_syntax; /* TEXT_ITEM_SYNTAX being accumulated. */
+    struct output_item *deferred_text; /* Output text being accumulated. */
     char *command_name;            /* Name of command being processed. */
     char *title, *subtitle;        /* Components of page title. */
 
@@ -76,7 +72,7 @@ static struct output_engine *
 engine_stack_top (void)
 {
   struct ll *head = ll_head (&engine_stack);
-  if (ll_is_empty (head))
+  if (ll_is_empty (&engine_stack))
     return NULL;
   return ll_data (head, struct output_engine, ll);
 }
@@ -99,7 +95,6 @@ output_engine_push (void)
   struct output_engine *e = xzalloc (sizeof (*e));
 
   llx_init (&e->drivers);
-  ds_init_empty (&e->deferred_syntax);
 
   string_map_init (&e->heading_vars);
 
@@ -122,7 +117,7 @@ output_engine_pop (void)
       struct output_driver *d = llx_pop_head (&e->drivers, &llx_malloc_mgr);
       output_driver_destroy (d);
     }
-  ds_destroy (&e->deferred_syntax);
+  output_item_unref (e->deferred_text);
   free (e->command_name);
   free (e->title);
   free (e->subtitle);
@@ -150,23 +145,32 @@ output_submit__ (struct output_engine *e, struct output_item *item)
   for (llx = llx_head (&e->drivers); llx != llx_null (&e->drivers); llx = next)
     {
       struct output_driver *d = llx_data (llx);
-      enum settings_output_type type;
 
       next = llx_next (llx);
 
-      if (is_message_item (item))
+      enum settings_output_type type = SETTINGS_OUTPUT_RESULT;
+      switch (item->type)
         {
-          const struct msg *m = message_item_get_msg (to_message_item (item));
-          if (m->severity == MSG_S_NOTE)
-            type = SETTINGS_OUTPUT_NOTE;
-          else
-            type = SETTINGS_OUTPUT_ERROR;
+        case OUTPUT_ITEM_MESSAGE:
+          type = (item->message->severity == MSG_S_NOTE
+                  ? SETTINGS_OUTPUT_NOTE
+                  : SETTINGS_OUTPUT_ERROR);
+          break;
+
+        case OUTPUT_ITEM_TEXT:
+          if (item->text.subtype == TEXT_ITEM_SYNTAX)
+            type = SETTINGS_OUTPUT_SYNTAX;
+          break;
+
+        case OUTPUT_ITEM_CHART:
+        case OUTPUT_ITEM_GROUP_OPEN:
+        case OUTPUT_ITEM_GROUP_CLOSE:
+        case OUTPUT_ITEM_IMAGE:
+        case OUTPUT_ITEM_PAGE_BREAK:
+        case OUTPUT_ITEM_PAGE_SETUP:
+        case OUTPUT_ITEM_TABLE:
+          break;
         }
-      else if (is_text_item (item)
-               && text_item_get_type (to_text_item (item)) == TEXT_ITEM_SYNTAX)
-        type = SETTINGS_OUTPUT_SYNTAX;
-      else
-        type = SETTINGS_OUTPUT_RESULT;
 
       if (settings_get_output_routing (type) & d->device_type)
         d->class->submit (d, item);
@@ -176,25 +180,32 @@ output_submit__ (struct output_engine *e, struct output_item *item)
 }
 
 static void
-flush_deferred_syntax (struct output_engine *e)
+flush_deferred_text (struct output_engine *e)
 {
-  if (!ds_is_empty (&e->deferred_syntax))
+  struct output_item *deferred_text = e->deferred_text;
+  if (deferred_text)
     {
-      ds_trim (&e->deferred_syntax, ss_cstr ("\n"));
-      if (!ds_is_empty (&e->deferred_syntax))
-        {
-          char *syntax = ds_steal_cstr (&e->deferred_syntax);
-          output_submit__ (e, text_item_super (text_item_create_nocopy (
-                                                 TEXT_ITEM_SYNTAX, syntax)));
-        }
+      e->deferred_text = NULL;
+      output_submit__ (e, deferred_text);
     }
 }
 
 static bool
-is_syntax_item (const struct output_item *item)
+defer_text (struct output_engine *e, struct output_item *item)
 {
-  return (is_text_item (item)
-          && text_item_get_type (to_text_item (item)) == TEXT_ITEM_SYNTAX);
+  if (item->type != OUTPUT_ITEM_TEXT)
+    return false;
+
+  if (!e->deferred_text)
+    e->deferred_text = output_item_unshare (item);
+  else if (text_item_append (e->deferred_text, item))
+    output_item_unref (item);
+  else
+    {
+      flush_deferred_text (e);
+      e->deferred_text = output_item_unshare (item);
+    }
+  return true;
 }
 
 /* Submits ITEM to the configured output drivers, and transfers ownership to
@@ -210,59 +221,57 @@ output_submit (struct output_item *item)
   if (item == NULL)
     return;
 
-  if (is_syntax_item (item))
-    {
-      ds_put_cstr (&e->deferred_syntax, text_item_get_text (to_text_item (item)));
-      output_item_unref (item);
-      return;
-    }
-
-  flush_deferred_syntax (e);
+  if (defer_text (e, item))
+    return;
+  flush_deferred_text (e);
 
-  if (is_group_open_item (item))
+  switch (item->type)
     {
-      const struct group_open_item *group_open_item
-        = to_group_open_item (item);
+    case OUTPUT_ITEM_GROUP_OPEN:
       if (e->n_groups >= e->allocated_groups)
         e->groups = x2nrealloc (e->groups, &e->allocated_groups,
                                 sizeof *e->groups);
-      e->groups[e->n_groups] = (group_open_item->command_name
-                                ? xstrdup (group_open_item->command_name)
-                                : NULL);
+      e->groups[e->n_groups] = xstrdup_if_nonnull (item->command_name);
       e->n_groups++;
-    }
-  else if (is_group_close_item (item))
-    {
+      break;
+
+    case OUTPUT_ITEM_GROUP_CLOSE:
       assert (e->n_groups > 0);
 
       size_t idx = --e->n_groups;
       free (e->groups[idx]);
-      if (idx >= 1 && idx <= 4)
-        {
-          char *key = xasprintf ("Head%zu", idx);
-          string_map_find_and_delete (&e->heading_vars, key);
-          free (key);
-        }
-    }
-  else if (is_text_item (item))
-    {
-      const struct text_item *text_item = to_text_item (item);
-      enum text_item_type type = text_item_get_type (text_item);
-      const char *text = text_item_get_text (text_item);
-      if (type == TEXT_ITEM_TITLE
-          && e->n_groups >= 1 && e->n_groups <= 4)
-        {
-          char *key = xasprintf ("Head%zu", e->n_groups);
-          string_map_replace (&e->heading_vars, key, text);
-          free (key);
-        }
-      else if (type == TEXT_ITEM_PAGE_TITLE)
-        string_map_replace (&e->heading_vars, "PageTitle", text);
+
+      char *key = xasprintf ("Head%zu", idx);
+      free (string_map_find_and_delete (&e->heading_vars, key));
+      free (key);
+      break;
+
+    case OUTPUT_ITEM_TEXT:
+      {
+        enum text_item_subtype st = item->text.subtype;
+        char *key = (st == TEXT_ITEM_TITLE ? xasprintf ("Head%zu", e->n_groups)
+                     : st == TEXT_ITEM_PAGE_TITLE ? xstrdup ("PageTitle")
+                     : NULL);
+        if (key)
+          string_map_replace_nocopy (&e->heading_vars, key,
+                                     text_item_get_plain_text (item));
+      }
+      break;
+
+    case OUTPUT_ITEM_CHART:
+    case OUTPUT_ITEM_IMAGE:
+    case OUTPUT_ITEM_MESSAGE:
+    case OUTPUT_ITEM_PAGE_BREAK:
+    case OUTPUT_ITEM_PAGE_SETUP:
+    case OUTPUT_ITEM_TABLE:
+      break;
     }
 
   output_submit__ (e, item);
 }
 
+/* Returns the name of the command currently being parsed, or NULL if no
+   command is being parsed. */
 const char *
 output_get_command_name (void)
 {
@@ -270,13 +279,20 @@ output_get_command_name (void)
   if (e == NULL)
     return NULL;
 
-  for (size_t i = e->n_groups; i-- > 0; )
+  for (size_t i = e->n_groups; i-- > 0;)
     if (e->groups[i])
       return e->groups[i];
 
   return NULL;
 }
 
+char *
+output_get_uppercase_command_name (void)
+{
+  const char *command_name = output_get_command_name ();
+  return command_name ? utf8_to_upper (command_name) : NULL;
+}
+
 /* Flushes output to screen devices, so that the user can see
    output that doesn't fill up an entire page. */
 void
@@ -285,7 +301,7 @@ output_flush (void)
   struct output_engine *e = engine_stack_top ();
   struct llx *llx;
 
-  flush_deferred_syntax (e);
+  flush_deferred_text (e);
   for (llx = llx_head (&e->drivers); llx != llx_null (&e->drivers);
        llx = llx_next (llx))
     {
@@ -299,15 +315,15 @@ static void
 output_set_title__ (struct output_engine *e, char **dst, const char *src)
 {
   free (*dst);
-  *dst = src ? xstrdup (src) : NULL;
+  *dst = xstrdup_if_nonnull (src);
 
   char *page_title
     = (e->title && e->subtitle ? xasprintf ("%s\n%s", e->title, e->subtitle)
        : e->title ? xstrdup (e->title)
        : e->subtitle ? xstrdup (e->subtitle)
        : xzalloc (1));
-  text_item_submit (text_item_create_nocopy (TEXT_ITEM_PAGE_TITLE,
-                                             page_title));
+  output_item_submit (text_item_create_nocopy (TEXT_ITEM_PAGE_TITLE,
+                                               page_title, NULL));
 }
 
 void
@@ -411,16 +427,17 @@ output_driver_is_registered (const struct output_driver *driver)
   return output_driver_get_engine (driver) != NULL;
 }
 \f
-extern const struct output_driver_factory txt_driver_factory;
-extern const struct output_driver_factory list_driver_factory;
-extern const struct output_driver_factory html_driver_factory;
 extern const struct output_driver_factory csv_driver_factory;
+extern const struct output_driver_factory html_driver_factory;
+extern const struct output_driver_factory list_driver_factory;
 extern const struct output_driver_factory odt_driver_factory;
-#ifdef HAVE_CAIRO
 extern const struct output_driver_factory pdf_driver_factory;
+extern const struct output_driver_factory png_driver_factory;
 extern const struct output_driver_factory ps_driver_factory;
+extern const struct output_driver_factory spv_driver_factory;
 extern const struct output_driver_factory svg_driver_factory;
-#endif
+extern const struct output_driver_factory tex_driver_factory;
+extern const struct output_driver_factory txt_driver_factory;
 
 static const struct output_driver_factory *factories[] =
   {
@@ -429,11 +446,12 @@ static const struct output_driver_factory *factories[] =
     &html_driver_factory,
     &csv_driver_factory,
     &odt_driver_factory,
-#ifdef HAVE_CAIRO
+    &spv_driver_factory,
     &pdf_driver_factory,
     &ps_driver_factory,
     &svg_driver_factory,
-#endif
+    &png_driver_factory,
+    &tex_driver_factory,
     NULL
   };
 
@@ -545,37 +563,13 @@ output_driver_parse_option (const char *option, struct string_map *options)
   string_map_insert_nocopy (options, key, value);
 }
 \f
-/* Extracts the actual text content from the given Pango MARKUP and returns it
-   as as a malloc()'d string. */
-char *
-output_get_text_from_markup (const char *markup)
-{
-  xmlParserCtxt *parser = xmlCreatePushParserCtxt (NULL, NULL, NULL, 0, NULL);
-  if (!parser)
-    return xstrdup (markup);
-
-  xmlParseChunk (parser, "<xml>", strlen ("<xml>"), false);
-  xmlParseChunk (parser, markup, strlen (markup), false);
-  xmlParseChunk (parser, "</xml>", strlen ("</xml>"), true);
-
-  char *content
-    = (parser->wellFormed
-       ? CHAR_CAST (char *,
-                    xmlNodeGetContent (xmlDocGetRootElement (parser->myDoc)))
-       : xstrdup (markup));
-  xmlFreeDoc (parser->myDoc);
-  xmlFreeParserCtxt (parser);
-
-  return content;
-}
-
 char *
 output_driver_substitute_heading_vars (const char *src, int page_number)
 {
   struct output_engine *e = engine_stack_top ();
   struct string dst = DS_EMPTY_INITIALIZER;
   ds_extend (&dst, strlen (src));
-  for (const char *p = src; *p; )
+  for (const char *p = src; *p;)
     {
       if (!strncmp (p, "&amp;[", 6))
         {