str: Add function xstrdup_if_nonnull() and introduce many users.
[pspp] / src / output / driver.c
index fb5444ec14cb2dc76fa64fbef7dfd97f31c75e76..824a1ee2112a0810fe72fc83199cf8ca52015ed2 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 1997-9, 2000, 2007, 2009, 2010, 2011, 2012, 2014 Free Software Foundation, Inc.
+   Copyright (C) 1997-9, 2000, 2007, 2009, 2010, 2011, 2012, 2014, 2019 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
@@ -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>
@@ -32,6 +30,7 @@
 #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"
@@ -51,8 +50,9 @@
 
 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 text_item *deferred_text;   /* Output text being accumulated. */
     char *command_name;            /* Name of command being processed. */
     char *title, *subtitle;        /* Components of page title. */
 
@@ -67,17 +67,17 @@ struct output_engine
     struct string_map heading_vars;
   };
 
-static const struct output_driver_factory *factories[];
+static struct ll_list engine_stack = LL_INITIALIZER (engine_stack);
 
-/* A stack of output engines.. */
-static struct output_engine *engine_stack;
-static size_t n_stack, allocated_stack;
+static const struct output_driver_factory *factories[];
 
 static struct output_engine *
 engine_stack_top (void)
 {
-  assert (n_stack > 0);
-  return &engine_stack[n_stack - 1];
+  struct ll *head = ll_head (&engine_stack);
+  if (ll_is_empty (&engine_stack))
+    return NULL;
+  return ll_data (head, struct output_engine, ll);
 }
 
 static void
@@ -95,16 +95,9 @@ put_strftime (const char *key, const char *format,
 void
 output_engine_push (void)
 {
-  struct output_engine *e;
+  struct output_engine *e = xzalloc (sizeof (*e));
 
-  if (n_stack >= allocated_stack)
-    engine_stack = x2nrealloc (engine_stack, &allocated_stack,
-                               sizeof *engine_stack);
-
-  e = &engine_stack[n_stack++];
-  memset (e, 0, sizeof *e);
   llx_init (&e->drivers);
-  ds_init_empty (&e->deferred_syntax);
 
   string_map_init (&e->heading_vars);
 
@@ -112,21 +105,22 @@ output_engine_push (void)
   const struct tm *tm = localtime (&t);
   put_strftime ("Date", "%x", tm, &e->heading_vars);
   put_strftime ("Time", "%X", tm, &e->heading_vars);
+
+  ll_push_head (&engine_stack, &e->ll);
 }
 
 void
 output_engine_pop (void)
 {
-  struct output_engine *e;
+  struct ll *head = ll_pop_head (&engine_stack);
+  struct output_engine *e =ll_data (head, struct output_engine, ll);
 
-  assert (n_stack > 0);
-  e = &engine_stack[--n_stack];
   while (!llx_is_empty (&e->drivers))
     {
       struct output_driver *d = llx_pop_head (&e->drivers, &llx_malloc_mgr);
       output_driver_destroy (d);
     }
-  ds_destroy (&e->deferred_syntax);
+  text_item_unref (e->deferred_text);
   free (e->command_name);
   free (e->title);
   free (e->subtitle);
@@ -134,6 +128,7 @@ output_engine_pop (void)
     free (e->groups[i]);
   free (e->groups);
   string_map_destroy (&e->heading_vars);
+  free (e);
 }
 
 void
@@ -179,25 +174,33 @@ 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 text_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, text_item_super (deferred_text));
     }
 }
 
 static bool
-is_syntax_item (const struct output_item *item)
+defer_text (struct output_engine *e, struct output_item *output_item)
 {
-  return (is_text_item (item)
-          && text_item_get_type (to_text_item (item)) == TEXT_ITEM_SYNTAX);
+  if (!is_text_item (output_item))
+    return false;
+
+  struct text_item *text = to_text_item (output_item);
+  if (!e->deferred_text)
+    e->deferred_text = text_item_unshare (text);
+  else if (text_item_append (e->deferred_text, text))
+    text_item_unref (text);
+  else
+    {
+      flush_deferred_text (e);
+      e->deferred_text = text_item_unshare (text);
+    }
+  return true;
 }
 
 /* Submits ITEM to the configured output drivers, and transfers ownership to
@@ -207,17 +210,15 @@ output_submit (struct output_item *item)
 {
   struct output_engine *e = engine_stack_top ();
 
-  if (item == NULL)
+  if (e == 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;
-    }
+  if (item == NULL)
+    return;
 
-  flush_deferred_syntax (e);
+  if (defer_text (e, item))
+    return;
+  flush_deferred_text (e);
 
   if (is_group_open_item (item))
     {
@@ -226,9 +227,8 @@ output_submit (struct output_item *item)
       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 (
+        group_open_item->command_name);
       e->n_groups++;
     }
   else if (is_group_close_item (item))
@@ -237,42 +237,40 @@ output_submit (struct output_item *item)
 
       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);
-        }
+
+      char *key = xasprintf ("Head%zu", idx);
+      free (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 = (type == TEXT_ITEM_TITLE ? xasprintf ("Head%zu", e->n_groups)
+                   : type == TEXT_ITEM_PAGE_TITLE ? xstrdup ("PageTitle")
+                   : NULL);
+      if (key)
+        string_map_replace_nocopy (&e->heading_vars, key,
+                                   text_item_get_plain_text (text_item));
     }
 
   output_submit__ (e, item);
 }
 
-const char *
+/* Returns the name of the command currently being parsed, in all uppercase.
+   The caller must free the returned value.
+
+   Returns NULL if no command is being parsed. */
+char *
 output_get_command_name (void)
 {
-  if (n_stack)
-    {
-      struct output_engine *e = engine_stack_top ();
-      for (size_t i = e->n_groups; i-- > 0; )
-        if (e->groups[i])
-          return e->groups[i];
-    }
+  struct output_engine *e = engine_stack_top ();
+  if (e == NULL)
+    return NULL;
+
+  for (size_t i = e->n_groups; i-- > 0;)
+    if (e->groups[i])
+      return utf8_to_upper (e->groups[i]);
 
   return NULL;
 }
@@ -285,7 +283,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,7 +297,7 @@ 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)
@@ -307,7 +305,7 @@ output_set_title__ (struct output_engine *e, char **dst, const char *src)
        : e->subtitle ? xstrdup (e->subtitle)
        : xzalloc (1));
   text_item_submit (text_item_create_nocopy (TEXT_ITEM_PAGE_TITLE,
-                                             page_title));
+                                             page_title, NULL));
 }
 
 void
@@ -377,9 +375,11 @@ output_driver_get_engine (const struct output_driver *driver)
 {
   struct output_engine *e;
 
-  for (e = engine_stack; e < &engine_stack[n_stack]; e++)
-    if (llx_find (llx_head (&e->drivers), llx_null (&e->drivers), driver))
-      return e;
+  ll_for_each (e, struct output_engine, ll, &engine_stack)
+    {
+      if (llx_find (llx_head (&e->drivers), llx_null (&e->drivers), driver))
+       return e;
+    }
 
   return NULL;
 }
@@ -409,16 +409,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[] =
   {
@@ -427,11 +428,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
   };
 
@@ -543,37 +545,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))
         {