X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=src%2Foutput%2Fdriver.c;h=f627e31248d69c1398739bd369307ec94dcd86fc;hb=39df27f80745cf9622ac5e916a098c17961c2585;hp=acc58cf999cdd7b77d533f54edc9ce17db954550;hpb=96a1f6df5b8d23e587e322b5d3fa96828004711d;p=pspp

diff --git a/src/output/driver.c b/src/output/driver.c
index acc58cf999..f627e31248 100644
--- a/src/output/driver.c
+++ b/src/output/driver.c
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 1997-9, 2000, 2007, 2009, 2010, 2011 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
@@ -22,47 +22,109 @@
 #include <ctype.h>
 #include <errno.h>
 #include <limits.h>
+#include <stdarg.h>
 #include <stdlib.h>
 #include <string.h>
+#include <time.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 "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/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"
+#include "gl/xvasprintf.h"
 
 #include "gettext.h"
 #define _(msgid) gettext (msgid)
 
-static const struct output_driver_factory *factories[];
+struct output_engine
+  {
+    struct ll ll;                  /* Node for this engine. */
+    struct llx_list drivers;       /* Contains "struct output_driver"s. */
+    struct output_item *deferred_text; /* Output text being accumulated. */
+    char *command_name;            /* Name of command being processed. */
+    char *title, *subtitle;        /* Components of page title. */
+
+    /* Output grouping stack. */
+    struct output_item **groups;
+    size_t n_groups;
+    size_t allocated_groups;
+
+    struct string_map heading_vars;
+  };
 
-/* Drivers currently registered with output_driver_register(). */
-static struct llx_list drivers = LLX_INITIALIZER (drivers);
+static struct ll_list engine_stack = LL_INITIALIZER (engine_stack);
 
-/* TEXT_ITEM_SYNTAX being accumulated until another kind of output arrives. */
-static struct string deferred_syntax = DS_EMPTY_INITIALIZER;
+static const struct output_driver_factory *factories[];
 
-void
-output_close (void)
+static struct output_engine *
+engine_stack_top (void)
 {
-  while (!llx_is_empty (&drivers))
+  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
+put_strftime (const char *key, const char *format,
+              const struct tm *tm, struct string_map *vars)
+{
+  if (!string_map_find (vars, key))
     {
-      struct output_driver *d = llx_pop_head (&drivers, &llx_malloc_mgr);
-      output_driver_destroy (d);
+      char value[128];
+      strftime (value, sizeof value, format, tm);
+      string_map_insert (vars, key, value);
     }
 }
 
+void
+output_engine_push (void)
+{
+  struct output_engine *e = XZALLOC (struct output_engine);
+
+  llx_init (&e->drivers);
+
+  string_map_init (&e->heading_vars);
+
+  time_t t = time (NULL);
+  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 ll *head = ll_pop_head (&engine_stack);
+  struct output_engine *e = ll_data (head, struct output_engine, ll);
+
+  struct output_driver *d;
+  llx_for_each_preremove (d, &e->drivers, &llx_malloc_mgr)
+    output_driver_destroy (d);
+  output_item_unref (e->deferred_text);
+  free (e->command_name);
+  free (e->title);
+  free (e->subtitle);
+  if (e->n_groups)
+    output_item_unref (e->groups[0]);
+  free (e->groups);
+  string_map_destroy (&e->heading_vars);
+  free (e);
+}
+
 void
 output_get_supported_formats (struct string_set *formats)
 {
@@ -72,55 +134,116 @@ output_get_supported_formats (struct string_set *formats)
     string_set_insert (formats, (*fp)->extension);
 }
 
-static void
-output_submit__ (struct output_item *item)
+static bool
+output_driver_should_show (const struct output_driver *d,
+                           const struct output_item *item)
 {
-  struct llx *llx, *next;
-
-  for (llx = llx_head (&drivers); llx != llx_null (&drivers); llx = next)
+  enum settings_output_type type = SETTINGS_OUTPUT_RESULT;
+  switch (item->type)
     {
-      struct output_driver *d = llx_data (llx);
-      enum settings_output_type 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;
+    }
 
-      next = llx_next (llx);
+  return (settings_get_output_routing (type) & d->device_type) != 0;
+}
 
-      if (is_message_item (item))
+/* 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)
         {
-          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;
+          struct output_item *group = group_item_clone_empty (in);
+          group_item_add_child (out, group);
+          out = group;
         }
-      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);
+      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);
+
+      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);
 }
 
 static void
-flush_deferred_syntax (void)
+flush_deferred_text (struct output_engine *e)
 {
-  if (!ds_is_empty (&deferred_syntax))
+  struct output_item *deferred_text = e->deferred_text;
+  if (deferred_text)
     {
-      char *syntax = ds_steal_cstr (&deferred_syntax);
-      output_submit__ (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
@@ -128,15 +251,78 @@ is_syntax_item (const struct output_item *item)
 void
 output_submit (struct output_item *item)
 {
-  if (is_syntax_item (item))
+  struct output_engine *e = engine_stack_top ();
+
+  if (e == NULL)
+    return;
+
+  if (item == NULL)
+    return;
+
+  if (defer_text (e, item))
+    return;
+  flush_deferred_text (e);
+
+  /* XXX heading_vars */
+
+  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)
+{
+  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]->command_name)
+      return e->groups[i]->command_name;
+
+  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;
+}
+
+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)
     {
-      ds_put_cstr (&deferred_syntax, text_item_get_text (to_text_item (item)));
-      output_item_unref (item);
-      return;
-    }
+      flush_deferred_text (e);
 
-  flush_deferred_syntax ();
-  output_submit__ (item);
+      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
@@ -144,17 +330,86 @@ output_submit (struct output_item *item)
 void
 output_flush (void)
 {
-  struct llx *llx;
+  struct output_engine *e = engine_stack_top ();
+
+  flush_deferred_text (e);
 
-  flush_deferred_syntax ();
-  for (llx = llx_head (&drivers); llx != llx_null (&drivers);
-       llx = llx_next (llx))
+  struct llx *llx;
+  llx_for_each (llx, &e->drivers)
     {
       struct output_driver *d = llx_data (llx);
       if (d->device_type & SETTINGS_DEVICE_TERMINAL && d->class->flush != NULL)
         d->class->flush (d);
     }
 }
+
+static void
+output_set_title__ (struct output_engine *e, char **dst, const char *src)
+{
+  free (*dst);
+  *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));
+  output_item_submit (text_item_create_nocopy (TEXT_ITEM_PAGE_TITLE,
+                                               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)
+{
+  struct output_engine *e = engine_stack_top ();
+
+  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)
+{
+  struct output_engine *e = engine_stack_top ();
+
+  output_set_title__ (e, &e->subtitle, subtitle);
+}
+
+void
+output_set_filename (const char *filename)
+{
+  struct output_engine *e = engine_stack_top ();
+
+  string_map_replace (&e->heading_vars, "Filename", filename);
+}
 
 void
 output_driver_init (struct output_driver *driver,
@@ -186,63 +441,70 @@ output_driver_get_name (const struct output_driver *driver)
   return driver->name;
 }
 
+static struct output_engine *
+output_driver_get_engine (const struct output_driver *driver)
+{
+  struct output_engine *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;
+}
+
 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;
+  return output_driver_get_engine (driver) != NULL;
 }
-
-/* Useful functions for output driver implementation. */
 
 void
-output_driver_track_current_command (const struct output_item *output_item,
-                                     char **command_namep)
+output_set_page_setup (const struct page_setup *ps)
 {
-  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);
+  struct output_engine *e = engine_stack_top ();
 
-      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;
-        }
+  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);
     }
 }
 
-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;
-#ifdef ODF_WRITE_SUPPORT
+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;
-#endif
-#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[] =
   {
@@ -250,14 +512,13 @@ static const struct output_driver_factory *factories[] =
     &list_driver_factory,
     &html_driver_factory,
     &csv_driver_factory,
-#ifdef ODF_WRITE_SUPPORT
     &odt_driver_factory,
-#endif
-#ifdef HAVE_CAIRO
+    &spv_driver_factory,
     &pdf_driver_factory,
     &ps_driver_factory,
     &svg_driver_factory,
-#endif
+    &png_driver_factory,
+    &tex_driver_factory,
     NULL
   };
 
@@ -294,16 +555,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");
@@ -315,20 +583,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 `%s' and `%s')"),
+      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);
 
@@ -338,3 +607,61 @@ 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);
+}
+
+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;)
+    {
+      if (!strncmp (p, "&amp;[", 6))
+        {
+          if (page_number != INT_MIN)
+            {
+              const char *start = p + 6;
+              const char *end = strchr (start, ']');
+              if (end)
+                {
+                  const char *value = string_map_find__ (&e->heading_vars,
+                                                         start, end - start);
+                  if (value)
+                    ds_put_cstr (&dst, value);
+                  else if (ss_equals (ss_buffer (start, end - start),
+                                      ss_cstr ("Page")))
+                    ds_put_format (&dst, "%d", page_number);
+                  p = end + 1;
+                  continue;
+                }
+            }
+          ds_put_cstr (&dst, "&amp;");
+          p += 5;
+        }
+      else
+        ds_put_byte (&dst, *p++);
+    }
+  return ds_steal_cstr (&dst);
+}