src/output/driver.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2007, 2009, 2010 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 #include <config.h>
  18
  19 #include "output/driver.h"
  20 #include "output/driver-provider.h"
  21
  22 #include <ctype.h>
  23 #include <errno.h>
  24 #include <limits.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27
  28 #include "data/file-name.h"
  29 #include "data/settings.h"
  30 #include "libpspp/array.h"
  31 #include "libpspp/assertion.h"
  32 #include "libpspp/message.h"
  33 #include "libpspp/llx.h"
  34 #include "libpspp/string-map.h"
  35 #include "libpspp/string-set.h"
  36 #include "libpspp/str.h"
  37 #include "output/output-item.h"
  38 #include "output/text-item.h"
  39
  40 #include "gl/error.h"
  41 #include "gl/xalloc.h"
  42 #include "gl/xmemdup0.h"
  43
  44 #include "gettext.h"
  45 #define _(msgid) gettext (msgid)
  46
  47 static const struct output_driver_factory *factories[];
  48
  49 /* Drivers currently registered with output_driver_register(). */
  50 static struct llx_list drivers = LLX_INITIALIZER (drivers);
  51
  52 static struct output_item *deferred_syntax;
  53 static bool in_command;
  54
  55 void
  56 output_close (void)
  57 {
  58   while (!llx_is_empty (&drivers))
  59     {
  60       struct output_driver *d = llx_pop_head (&drivers, &llx_malloc_mgr);
  61       output_driver_destroy (d);
  62     }
  63 }
  64
  65 void
  66 output_get_supported_formats (struct string_set *formats)
  67 {
  68   const struct output_driver_factory **fp;
  69
  70   for (fp = factories; *fp != NULL; fp++)
  71     string_set_insert (formats, (*fp)->extension);
  72 }
  73
  74 static void
  75 output_submit__ (struct output_item *item)
  76 {
  77   struct llx *llx, *next;
  78
  79   for (llx = llx_head (&drivers); llx != llx_null (&drivers); llx = next)
  80     {
  81       struct output_driver *d = llx_data (llx);
  82       enum settings_output_type type;
  83
  84       next = llx_next (llx);
  85
  86       if (is_text_item (item)
  87           && text_item_get_type (to_text_item (item)) == TEXT_ITEM_SYNTAX)
  88         type = SETTINGS_OUTPUT_SYNTAX;
  89       else
  90         type = SETTINGS_OUTPUT_RESULT;
  91
  92       if (settings_get_output_routing (type) & d->device_type)
  93         d->class->submit (d, item);
  94     }
  95
  96   output_item_unref (item);
  97 }
  98
  99 static void
 100 flush_deferred_syntax (void)
 101 {
 102   if (deferred_syntax != NULL)
 103     {
 104       output_submit__ (deferred_syntax);
 105       deferred_syntax = NULL;
 106     }
 107 }
 108
 109 /* Submits ITEM to the configured output drivers, and transfers ownership to
 110    the output subsystem. */
 111 void
 112 output_submit (struct output_item *item)
 113 {
 114   if (is_text_item (item))
 115     {
 116       struct text_item *text = to_text_item (item);
 117       switch (text_item_get_type (text))
 118         {
 119         case TEXT_ITEM_SYNTAX:
 120           if (!in_command)
 121             {
 122               flush_deferred_syntax ();
 123               deferred_syntax = item;
 124               return;
 125             }
 126           break;
 127
 128         case TEXT_ITEM_COMMAND_OPEN:
 129           output_submit__ (item);
 130           flush_deferred_syntax ();
 131           in_command = true;
 132           return;
 133
 134         case TEXT_ITEM_COMMAND_CLOSE:
 135           in_command = false;
 136           break;
 137
 138         default:
 139           break;
 140         }
 141     }
 142
 143   output_submit__ (item);
 144 }
 145
 146 /* Flushes output to screen devices, so that the user can see
 147    output that doesn't fill up an entire page. */
 148 void
 149 output_flush (void)
 150 {
 151   struct llx *llx;
 152
 153   for (llx = llx_head (&drivers); llx != llx_null (&drivers);
 154        llx = llx_next (llx))
 155     {
 156       struct output_driver *d = llx_data (llx);
 157       if (d->device_type & SETTINGS_DEVICE_TERMINAL && d->class->flush != NULL)
 158         d->class->flush (d);
 159     }
 160 }
 161 \f
 162 void
 163 output_driver_init (struct output_driver *driver,
 164                     const struct output_driver_class *class,
 165                     const char *name, enum settings_output_devices type)
 166 {
 167   driver->class = class;
 168   driver->name = xstrdup (name);
 169   driver->device_type = type;
 170 }
 171
 172 void
 173 output_driver_destroy (struct output_driver *driver)
 174 {
 175   if (driver != NULL)
 176     {
 177       char *name = driver->name;
 178       if (output_driver_is_registered (driver))
 179         output_driver_unregister (driver);
 180       if (driver->class->destroy)
 181         driver->class->destroy (driver);
 182       free (name);
 183     }
 184 }
 185
 186 const char *
 187 output_driver_get_name (const struct output_driver *driver)
 188 {
 189   return driver->name;
 190 }
 191 \f
 192 void
 193 output_driver_register (struct output_driver *driver)
 194 {
 195   assert (!output_driver_is_registered (driver));
 196   llx_push_tail (&drivers, driver, &llx_malloc_mgr);
 197 }
 198
 199 void
 200 output_driver_unregister (struct output_driver *driver)
 201 {
 202   llx_remove (llx_find (llx_head (&drivers), llx_null (&drivers), driver),
 203               &llx_malloc_mgr);
 204 }
 205
 206 bool
 207 output_driver_is_registered (const struct output_driver *driver)
 208 {
 209   return llx_find (llx_head (&drivers), llx_null (&drivers), driver) != NULL;
 210 }
 211 \f
 212 /* Useful functions for output driver implementation. */
 213
 214 void
 215 output_driver_track_current_command (const struct output_item *output_item,
 216                                      char **command_namep)
 217 {
 218   if (is_text_item (output_item))
 219     {
 220       const struct text_item *item = to_text_item (output_item);
 221       const char *text = text_item_get_text (item);
 222       enum text_item_type type = text_item_get_type (item);
 223
 224       if (type == TEXT_ITEM_COMMAND_OPEN)
 225         {
 226           free (*command_namep);
 227           *command_namep = xstrdup (text);
 228         }
 229       else if (type == TEXT_ITEM_COMMAND_CLOSE)
 230         {
 231           free (*command_namep);
 232           *command_namep = NULL;
 233         }
 234     }
 235 }
 236 \f
 237 extern const struct output_driver_factory txt_driver_factory;
 238 extern const struct output_driver_factory list_driver_factory;
 239 extern const struct output_driver_factory html_driver_factory;
 240 extern const struct output_driver_factory odt_driver_factory;
 241 extern const struct output_driver_factory csv_driver_factory;
 242 #ifdef HAVE_CAIRO
 243 extern const struct output_driver_factory pdf_driver_factory;
 244 extern const struct output_driver_factory ps_driver_factory;
 245 extern const struct output_driver_factory svg_driver_factory;
 246 #endif
 247
 248 static const struct output_driver_factory *factories[] =
 249   {
 250     &txt_driver_factory,
 251     &list_driver_factory,
 252     &html_driver_factory,
 253     &odt_driver_factory,
 254     &csv_driver_factory,
 255 #ifdef HAVE_CAIRO
 256     &pdf_driver_factory,
 257     &ps_driver_factory,
 258     &svg_driver_factory,
 259 #endif
 260     NULL
 261   };
 262
 263 static const struct output_driver_factory *
 264 find_factory (const char *format)
 265 {
 266   const struct output_driver_factory **fp;
 267
 268   for (fp = factories; *fp != NULL; fp++)
 269     {
 270       const struct output_driver_factory *f = *fp;
 271
 272       if (!strcmp (f->extension, format))
 273         return f;
 274     }
 275   return &txt_driver_factory;
 276 }
 277
 278 static enum settings_output_devices
 279 default_device_type (const char *file_name)
 280 {
 281   return (!strcmp (file_name, "-")
 282           ? SETTINGS_DEVICE_TERMINAL
 283           : SETTINGS_DEVICE_LISTING);
 284 }
 285
 286 struct output_driver *
 287 output_driver_create (struct string_map *options)
 288 {
 289   enum settings_output_devices device_type;
 290   const struct output_driver_factory *f;
 291   struct output_driver *driver;
 292   char *device_string;
 293   char *file_name;
 294   char *format;
 295
 296   file_name = string_map_find_and_delete (options, "output-file");
 297   if (file_name == NULL)
 298     file_name = xstrdup ("-");
 299
 300   format = string_map_find_and_delete (options, "format");
 301   if (format == NULL)
 302     {
 303       const char *extension = strrchr (file_name, '.');
 304       format = xstrdup (extension != NULL ? extension + 1 : "");
 305     }
 306
 307   /* XXX should use parse_enum(). */
 308   device_string = string_map_find_and_delete (options, "device");
 309   if (device_string == NULL || device_string[0] == '\0')
 310     device_type = default_device_type (file_name);
 311   else if (!strcmp (device_string, "terminal"))
 312     device_type = SETTINGS_DEVICE_TERMINAL;
 313   else if (!strcmp (device_string, "listing"))
 314     device_type = SETTINGS_DEVICE_LISTING;
 315   else
 316     {
 317       error (0, 0, _("%s is not a valid device type (the choices are "
 318                      "\"terminal\" and \"listing\")"), device_string);
 319       device_type = default_device_type (file_name);
 320     }
 321
 322   f = find_factory (format);
 323   driver = f->create (file_name, device_type, options);
 324   if (driver != NULL)
 325     {
 326       const struct string_map_node *node;
 327       const char *key;
 328
 329       STRING_MAP_FOR_EACH_KEY (key, node, options)
 330         error (0, 0, _("%s: unknown option \"%s\""), file_name, key);
 331     }
 332   string_map_clear (options);
 333
 334   free (file_name);
 335   free (format);
 336   free (device_string);
 337
 338   return driver;
 339 }