text-item: Merge "title" and "subtitle" items into a new "page title".
[pspp] / src / output / driver.c
index 203644584f162eade6f30663c26ffaa81625d58d..b07330633386aff1d5854a318a602d14839bfa7e 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 1997-9, 2000, 2007, 2009, 2010 Free Software Foundation, Inc.
+   Copyright (C) 1997-9, 2000, 2007, 2009, 2010, 2011, 2012, 2014 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
@@ -25,7 +25,7 @@
 #include <stdlib.h>
 #include <string.h>
 
-#include "data/file-name.h"
+#include "data/file-handle-def.h"
 #include "data/settings.h"
 #include "libpspp/array.h"
 #include "libpspp/assertion.h"
 #include "gettext.h"
 #define _(msgid) gettext (msgid)
 
+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. */
+  };
+
 static const struct output_driver_factory *factories[];
 
-/* Drivers currently registered with output_driver_register(). */
-static struct llx_list drivers = LLX_INITIALIZER (drivers);
+/* A stack of output engines.. */
+static struct output_engine *engine_stack;
+static size_t n_stack, allocated_stack;
 
-static struct output_item *deferred_syntax;
-static bool in_command;
+static struct output_engine *
+engine_stack_top (void)
+{
+  assert (n_stack > 0);
+  return &engine_stack[n_stack - 1];
+}
 
 void
-output_close (void)
+output_engine_push (void)
 {
-  while (!llx_is_empty (&drivers))
+  struct output_engine *e;
+
+  if (n_stack >= allocated_stack)
+    engine_stack = x2nrealloc (engine_stack, &allocated_stack,
+                               sizeof *engine_stack);
+
+  e = &engine_stack[n_stack++];
+  llx_init (&e->drivers);
+  ds_init_empty (&e->deferred_syntax);
+  e->command_name = NULL;
+  e->title = NULL;
+  e->subtitle = NULL;
+}
+
+void
+output_engine_pop (void)
+{
+  struct output_engine *e;
+
+  assert (n_stack > 0);
+  e = &engine_stack[--n_stack];
+  while (!llx_is_empty (&e->drivers))
     {
-      struct output_driver *d = llx_pop_head (&drivers, &llx_malloc_mgr);
+      struct output_driver *d = llx_pop_head (&e->drivers, &llx_malloc_mgr);
       output_driver_destroy (d);
     }
+  ds_destroy (&e->deferred_syntax);
+  free (e->command_name);
+  free (e->title);
+  free (e->subtitle);
 }
 
 void
@@ -73,11 +111,11 @@ output_get_supported_formats (struct string_set *formats)
 }
 
 static void
-output_submit__ (struct output_item *item)
+output_submit__ (struct output_engine *e, struct output_item *item)
 {
   struct llx *llx, *next;
 
-  for (llx = llx_head (&drivers); llx != llx_null (&drivers); llx = next)
+  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;
@@ -106,50 +144,73 @@ output_submit__ (struct output_item *item)
 }
 
 static void
-flush_deferred_syntax (void)
+flush_deferred_syntax (struct output_engine *e)
 {
-  if (deferred_syntax != NULL)
+  if (!ds_is_empty (&e->deferred_syntax))
     {
-      output_submit__ (deferred_syntax);
-      deferred_syntax = NULL;
+      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)));
+        }
     }
 }
 
+static bool
+is_syntax_item (const struct output_item *item)
+{
+  return (is_text_item (item)
+          && text_item_get_type (to_text_item (item)) == TEXT_ITEM_SYNTAX);
+}
+
 /* Submits ITEM to the configured output drivers, and transfers ownership to
    the output subsystem. */
 void
 output_submit (struct output_item *item)
 {
+  struct output_engine *e = engine_stack_top ();
+
+  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 (is_text_item (item))
     {
-      struct text_item *text = to_text_item (item);
-      switch (text_item_get_type (text))
+      const struct text_item *text_item = to_text_item (item);
+      const char *text = text_item_get_text (text_item);
+      enum text_item_type type = text_item_get_type (text_item);
+
+      if (type == TEXT_ITEM_COMMAND_OPEN)
+        {
+          free (e->command_name);
+          e->command_name = xstrdup (text);
+        }
+      else if (type == TEXT_ITEM_COMMAND_CLOSE)
         {
-        case TEXT_ITEM_SYNTAX:
-          if (!in_command)
-            {
-              flush_deferred_syntax ();
-              deferred_syntax = item;
-              return;
-            }
-          break;
-
-        case TEXT_ITEM_COMMAND_OPEN:
-          output_submit__ (item);
-          flush_deferred_syntax ();
-          in_command = true;
-          return;
-
-        case TEXT_ITEM_COMMAND_CLOSE:
-          in_command = false;
-          break;
-
-        default:
-          break;
+          free (e->command_name);
+          e->command_name = NULL;
         }
     }
+  else if (is_message_item (item))
+    {
+      struct message_item *message_item = to_message_item (item);
+      free (message_item->command_name);
+      message_item->command_name = (e->command_name
+                                    ? xstrdup (e->command_name)
+                                    : NULL);
+    }
 
-  output_submit__ (item);
+  output_submit__ (e, item);
 }
 
 /* Flushes output to screen devices, so that the user can see
@@ -157,9 +218,11 @@ output_submit (struct output_item *item)
 void
 output_flush (void)
 {
+  struct output_engine *e = engine_stack_top ();
   struct llx *llx;
 
-  for (llx = llx_head (&drivers); llx != llx_null (&drivers);
+  flush_deferred_syntax (e);
+  for (llx = llx_head (&e->drivers); llx != llx_null (&e->drivers);
        llx = llx_next (llx))
     {
       struct output_driver *d = llx_data (llx);
@@ -167,6 +230,37 @@ 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);
+}
 \f
 void
 output_driver_init (struct output_driver *driver,
@@ -198,56 +292,48 @@ output_driver_get_name (const struct output_driver *driver)
   return driver->name;
 }
 \f
+static struct output_engine *
+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;
+
+  return NULL;
+}
+
 void
 output_driver_register (struct output_driver *driver)
 {
+  struct output_engine *e = engine_stack_top ();
+
   assert (!output_driver_is_registered (driver));
-  llx_push_tail (&drivers, driver, &llx_malloc_mgr);
+  llx_push_tail (&e->drivers, driver, &llx_malloc_mgr);
 }
 
 void
 output_driver_unregister (struct output_driver *driver)
 {
-  llx_remove (llx_find (llx_head (&drivers), llx_null (&drivers), driver),
+  struct output_engine *e = output_driver_get_engine (driver);
+
+  assert (e != NULL);
+  llx_remove (llx_find (llx_head (&e->drivers), llx_null (&e->drivers), driver),
               &llx_malloc_mgr);
 }
 
 bool
 output_driver_is_registered (const struct output_driver *driver)
 {
-  return llx_find (llx_head (&drivers), llx_null (&drivers), 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;
-        }
-    }
+  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 odt_driver_factory;
 extern const struct output_driver_factory csv_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 ps_driver_factory;
@@ -259,8 +345,8 @@ static const struct output_driver_factory *factories[] =
     &txt_driver_factory,
     &list_driver_factory,
     &html_driver_factory,
-    &odt_driver_factory,
     &csv_driver_factory,
+    &odt_driver_factory,
 #ifdef HAVE_CAIRO
     &pdf_driver_factory,
     &ps_driver_factory,
@@ -302,16 +388,23 @@ output_driver_create (struct string_map *options)
   char *file_name;
   char *format;
 
+  format = string_map_find_and_delete (options, "format");
   file_name = string_map_find_and_delete (options, "output-file");
-  if (file_name == NULL)
-    file_name = xstrdup ("-");
 
-  format = string_map_find_and_delete (options, "format");
   if (format == NULL)
     {
-      const char *extension = strrchr (file_name, '.');
-      format = xstrdup (extension != NULL ? extension + 1 : "");
+      if (file_name != NULL)
+        {
+          const char *extension = strrchr (file_name, '.');
+          format = xstrdup (extension != NULL ? extension + 1 : "");
+        }
+      else
+        format = xstrdup ("txt");
     }
+  f = find_factory (format);
+
+  if (file_name == NULL)
+    file_name = xstrdup (f->default_file_name);
 
   /* XXX should use parse_enum(). */
   device_string = string_map_find_and_delete (options, "device");
@@ -323,20 +416,21 @@ output_driver_create (struct string_map *options)
     device_type = SETTINGS_DEVICE_LISTING;
   else
     {
-      error (0, 0, _("%s is not a valid device type (the choices are "
-                     "\"terminal\" and \"listing\")"), device_string);
+      msg (MW, _("%s is not a valid device type (the choices are `%s' and `%s')"),
+                     device_string, "terminal", "listing");
       device_type = default_device_type (file_name);
     }
 
-  f = find_factory (format);
-  driver = f->create (file_name, device_type, options);
+  struct file_handle *fh = fh_create_file (NULL, file_name, NULL, fh_default_properties ());
+
+  driver = f->create (fh, device_type, options);
   if (driver != NULL)
     {
       const struct string_map_node *node;
       const char *key;
 
       STRING_MAP_FOR_EACH_KEY (key, node, options)
-        error (0, 0, _("%s: unknown option \"%s\""), file_name, key);
+        msg (MW, _("%s: unknown option `%s'"), file_name, key);
     }
   string_map_clear (options);
 
@@ -346,3 +440,25 @@ 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);
+}