output: Add support for Pango markup of fonts and styles.
[pspp] / src / output / driver.c
index bb5aa3a8b9e2ec7cf0256dd44e96a7f3a40dee95..b9e4b785290d38f77cab652e26996b833a7217a7 100644 (file)
@@ -21,6 +21,8 @@
 
 #include <ctype.h>
 #include <errno.h>
+#include <libxml/parser.h>
+#include <libxml/tree.h>
 #include <limits.h>
 #include <stdlib.h>
 #include <string.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"
 #include "gl/xmemdup0.h"
 
@@ -48,6 +52,16 @@ struct output_engine
   {
     struct llx_list drivers;       /* Contains "struct output_driver"s. */
     struct string deferred_syntax; /* TEXT_ITEM_SYNTAX being accumulated. */
+    char *command_name;            /* Name of command being processed. */
+    char *title, *subtitle;        /* Components of page title. */
+
+    /* Output grouping stack.
+
+       TEXT_ITEM_GROUP_OPEN pushes a group on the stack and
+       TEXT_ITEM_GROUP_CLOSE pops one off. */
+    char **groups;               /* Command names of nested sections. */
+    size_t n_groups;
+    size_t allocated_groups;
   };
 
 static const struct output_driver_factory *factories[];
@@ -73,8 +87,11 @@ output_engine_push (void)
                                sizeof *engine_stack);
 
   e = &engine_stack[n_stack++];
+  memset (e, 0, sizeof *e);
   llx_init (&e->drivers);
   ds_init_empty (&e->deferred_syntax);
+  e->title = NULL;
+  e->subtitle = NULL;
 }
 
 void
@@ -90,6 +107,12 @@ output_engine_pop (void)
       output_driver_destroy (d);
     }
   ds_destroy (&e->deferred_syntax);
+  free (e->command_name);
+  free (e->title);
+  free (e->subtitle);
+  for (size_t i = 0; i < e->n_groups; i++)
+    free (e->groups[i]);
+  free (e->groups);
 }
 
 void
@@ -174,9 +197,43 @@ output_submit (struct output_item *item)
     }
 
   flush_deferred_syntax (e);
+
+  if (is_group_open_item (item))
+    {
+      const struct group_open_item *group_open_item
+        = to_group_open_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->n_groups++;
+    }
+  else if (is_group_close_item (item))
+    {
+      assert (e->n_groups > 0);
+
+      size_t idx = --e->n_groups;
+      free (e->groups[idx]);
+    }
   output_submit__ (e, item);
 }
 
+const 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];
+    }
+
+  return NULL;
+}
+
 /* Flushes output to screen devices, so that the user can see
    output that doesn't fill up an entire page. */
 void
@@ -194,6 +251,45 @@ output_flush (void)
         d->class->flush (d);
     }
 }
+
+static void
+output_set_title__ (struct output_engine *e, char **dst, const char *src)
+{
+  free (*dst);
+  *dst = src ? xstrdup (src) : NULL;
+
+  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));
+}
+
+void
+output_set_title (const char *title)
+{
+  struct output_engine *e = engine_stack_top ();
+
+  output_set_title__ (e, &e->title, title);
+}
+
+void
+output_set_subtitle (const char *subtitle)
+{
+  struct output_engine *e = engine_stack_top ();
+
+  output_set_title__ (e, &e->subtitle, subtitle);
+}
+
+size_t
+output_get_group_level (void)
+{
+  struct output_engine *e = engine_stack_top ();
+
+  return e->n_groups;
+}
 \f
 void
 output_driver_init (struct output_driver *driver,
@@ -262,31 +358,6 @@ output_driver_is_registered (const struct output_driver *driver)
   return output_driver_get_engine (driver) != NULL;
 }
 \f
-/* Useful functions for output driver implementation. */
-
-void
-output_driver_track_current_command (const struct output_item *output_item,
-                                     char **command_namep)
-{
-  if (is_text_item (output_item))
-    {
-      const struct text_item *item = to_text_item (output_item);
-      const char *text = text_item_get_text (item);
-      enum text_item_type type = text_item_get_type (item);
-
-      if (type == TEXT_ITEM_COMMAND_OPEN)
-        {
-          free (*command_namep);
-          *command_namep = xstrdup (text);
-        }
-      else if (type == TEXT_ITEM_COMMAND_CLOSE)
-        {
-          free (*command_namep);
-          *command_namep = 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;
@@ -398,3 +469,46 @@ output_driver_create (struct string_map *options)
 
   return driver;
 }
+
+void
+output_driver_parse_option (const char *option, struct string_map *options)
+{
+  const char *equals = strchr (option, '=');
+  if (equals == NULL)
+    {
+      error (0, 0, _("%s: output option missing `='"), option);
+      return;
+    }
+
+  char *key = xmemdup0 (option, equals - option);
+  if (string_map_contains (options, key))
+    {
+      error (0, 0, _("%s: output option specified more than once"), key);
+      free (key);
+      return;
+    }
+
+  char *value = xmemdup0 (equals + 1, strlen (equals + 1));
+  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)
+{
+  xmlDoc *doc = xmlReadMemory (markup, strlen (markup), "noname.xml", "UTF-8",
+                               (XML_PARSE_NOERROR | XML_PARSE_NOWARNING
+                                | XML_PARSE_NONET | XML_PARSE_NOCDATA));
+  if (!doc)
+    return xstrdup (markup);
+
+  char *content = CHAR_CAST (char *,
+                             xmlNodeGetContent (xmlDocGetRootElement (doc)));
+  if (!content)
+    content = xstrdup (markup);
+
+  xmlFreeDoc (doc);
+
+  return content;
+}