driver: New function output_log_nocopy().
[pspp] / src / output / driver.c
index 7c0bff8bf58e708630adf742f49de875587aaa07..f627e31248d69c1398739bd369307ec94dcd86fc 100644 (file)
@@ -22,6 +22,7 @@
 #include <ctype.h>
 #include <errno.h>
 #include <limits.h>
+#include <stdarg.h>
 #include <stdlib.h>
 #include <string.h>
 #include <time.h>
@@ -41,6 +42,7 @@
 #include "gl/error.h"
 #include "gl/xalloc.h"
 #include "gl/xmemdup0.h"
+#include "gl/xvasprintf.h"
 
 #include "gettext.h"
 #define _(msgid) gettext (msgid)
@@ -53,11 +55,8 @@ struct output_engine
     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. */
+    /* Output grouping stack. */
+    struct output_item **groups;
     size_t n_groups;
     size_t allocated_groups;
 
@@ -92,7 +91,7 @@ put_strftime (const char *key, const char *format,
 void
 output_engine_push (void)
 {
-  struct output_engine *e = xzalloc (sizeof (*e));
+  struct output_engine *e = XZALLOC (struct output_engine);
 
   llx_init (&e->drivers);
 
@@ -119,8 +118,8 @@ output_engine_pop (void)
   free (e->command_name);
   free (e->title);
   free (e->subtitle);
-  for (size_t i = 0; i < e->n_groups; i++)
-    free (e->groups[i]);
+  if (e->n_groups)
+    output_item_unref (e->groups[0]);
   free (e->groups);
   string_map_destroy (&e->heading_vars);
   free (e);
@@ -135,40 +134,84 @@ output_get_supported_formats (struct string_set *formats)
     string_set_insert (formats, (*fp)->extension);
 }
 
+static bool
+output_driver_should_show (const struct output_driver *d,
+                           const struct output_item *item)
+{
+  enum settings_output_type type = SETTINGS_OUTPUT_RESULT;
+  switch (item->type)
+    {
+    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:
+    case OUTPUT_ITEM_IMAGE:
+    case OUTPUT_ITEM_PAGE_BREAK:
+    case OUTPUT_ITEM_TABLE:
+      break;
+    }
+
+  return (settings_get_output_routing (type) & d->device_type) != 0;
+}
+
+/* Adds to OUT the subset of IN that driver D should show, considering routing
+   and visibility of each item, and flattening groups for drivers that don't
+   handle them internally. */
+static void
+make_driver_output_subset (const struct output_item *in,
+                           const struct output_driver *d,
+                           struct output_item *out)
+{
+  if (in->type == OUTPUT_ITEM_GROUP)
+    {
+      /* If we should include the group itself, then clone IN inside OUT, and
+         add any children to the clone instead to OUT directly. */
+      if (output_driver_should_show (d, in) && d->class->handles_groups)
+        {
+          struct output_item *group = group_item_clone_empty (in);
+          group_item_add_child (out, group);
+          out = group;
+        }
+
+      for (size_t i = 0; i < in->group.n_children; i++)
+        make_driver_output_subset (in->group.children[i], d, out);
+    }
+  else
+    {
+      if (output_driver_should_show (d, in)
+          && (in->show || d->class->handles_show))
+        group_item_add_child (out, output_item_ref (in));
+    }
+}
+
 static void
 output_submit__ (struct output_engine *e, struct output_item *item)
 {
+  if (e->n_groups > 0)
+    {
+      group_item_add_child (e->groups[e->n_groups - 1], item);
+      return;
+    }
+
   struct llx *llx, *next;
   llx_for_each_safe (llx, next, &e->drivers)
     {
       struct output_driver *d = llx_data (llx);
 
-      enum settings_output_type type = SETTINGS_OUTPUT_RESULT;
-      switch (item->type)
-        {
-        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;
-        }
-
-      if (settings_get_output_routing (type) & d->device_type)
-        d->class->submit (d, item);
+      struct output_item *root = root_item_create ();
+      make_driver_output_subset (item, d, root);
+      for (size_t i = 0; i < root->group.n_children; i++)
+        d->class->submit (d, root->group.children[i]);
+      output_item_unref (root);
     }
 
   output_item_unref (item);
@@ -220,47 +263,7 @@ output_submit (struct output_item *item)
     return;
   flush_deferred_text (e);
 
-  switch (item->type)
-    {
-    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] = xstrdup_if_nonnull (item->command_name);
-      e->n_groups++;
-      break;
-
-    case OUTPUT_ITEM_GROUP_CLOSE:
-      assert (e->n_groups > 0);
-
-      size_t idx = --e->n_groups;
-      free (e->groups[idx]);
-
-      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;
-    }
+  /* XXX heading_vars */
 
   output_submit__ (e, item);
 }
@@ -275,8 +278,8 @@ output_get_command_name (void)
     return NULL;
 
   for (size_t i = e->n_groups; i-- > 0;)
-    if (e->groups[i])
-      return e->groups[i];
+    if (e->groups[i]->command_name)
+      return e->groups[i]->command_name;
 
   return NULL;
 }
@@ -288,6 +291,40 @@ output_get_uppercase_command_name (void)
   return command_name ? utf8_to_upper (command_name) : NULL;
 }
 
+size_t
+output_open_group (struct output_item *item)
+{
+  struct output_engine *e = engine_stack_top ();
+  if (e == NULL)
+    return 0;
+
+  if (e->n_groups >= e->allocated_groups)
+    e->groups = x2nrealloc (e->groups, &e->allocated_groups,
+                            sizeof *e->groups);
+  e->groups[e->n_groups++] = item;
+  if (e->n_groups > 1)
+    group_item_add_child (e->groups[e->n_groups - 2], item);
+
+  return e->n_groups - 1;
+}
+
+void
+output_close_groups (size_t nesting_level)
+{
+  struct output_engine *e = engine_stack_top ();
+  if (e == NULL)
+    return;
+
+  while (e->n_groups > nesting_level)
+    {
+      flush_deferred_text (e);
+
+      struct output_item *group = e->groups[--e->n_groups];
+      if (e->n_groups == 0)
+        output_submit__ (e, group);
+    }
+}
+
 /* Flushes output to screen devices, so that the user can see
    output that doesn't fill up an entire page. */
 void
@@ -321,6 +358,29 @@ output_set_title__ (struct output_engine *e, char **dst, const char *src)
                                                page_title, NULL));
 }
 
+void PRINTF_FORMAT (1, 2)
+output_log (const char *format, ...)
+{
+  va_list args;
+  va_start (args, format);
+  char *s = xvasprintf (format, args);
+  va_end (args);
+
+  output_log_nocopy (s);
+}
+
+void
+output_log_nocopy (char *s)
+{
+  output_submit (text_item_create_nocopy (TEXT_ITEM_LOG, s, NULL));
+}
+
+const char *
+output_get_title (void)
+{
+  return engine_stack_top ()->title;
+}
+
 void
 output_set_title (const char *title)
 {
@@ -329,6 +389,12 @@ output_set_title (const char *title)
   output_set_title__ (e, &e->title, title);
 }
 
+const char *
+output_get_subtitle (void)
+{
+  return engine_stack_top ()->subtitle;
+}
+
 void
 output_set_subtitle (const char *subtitle)
 {
@@ -344,14 +410,6 @@ output_set_filename (const char *filename)
 
   string_map_replace (&e->heading_vars, "Filename", filename);
 }
-
-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,
@@ -421,6 +479,20 @@ output_driver_is_registered (const struct output_driver *driver)
 {
   return output_driver_get_engine (driver) != NULL;
 }
+
+void
+output_set_page_setup (const struct page_setup *ps)
+{
+  struct output_engine *e = engine_stack_top ();
+
+  struct llx *llx;
+  llx_for_each (llx, &e->drivers)
+    {
+      struct output_driver *d = llx_data (llx);
+      if (d->class->setup)
+        d->class->setup (d, ps);
+    }
+}
 \f
 extern const struct output_driver_factory csv_driver_factory;
 extern const struct output_driver_factory html_driver_factory;