pintos-os.org Git - pspp/blob - src/output/driver.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2007, 2009, 2010, 2011, 2012, 2014 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/message-item.h"
  38 #include "output/output-item.h"
  39 #include "output/text-item.h"
  40
  41 #include "gl/xalloc.h"
  42 #include "gl/xmemdup0.h"
  43
  44 #include "gettext.h"
  45 #define _(msgid) gettext (msgid)
  46
  47 struct output_engine
  48   {
  49     struct llx_list drivers;       /* Contains "struct output_driver"s. */
  50     struct string deferred_syntax; /* TEXT_ITEM_SYNTAX being accumulated. */
  51   };
  52
  53 static const struct output_driver_factory *factories[];
  54
  55 /* A stack of output engines.. */
  56 static struct output_engine *engine_stack;
  57 static size_t n_stack, allocated_stack;
  58
  59 static struct output_engine *
  60 engine_stack_top (void)
  61 {
  62   assert (n_stack > 0);
  63   return &engine_stack[n_stack - 1];
  64 }
  65
  66 void
  67 output_engine_push (void)
  68 {
  69   struct output_engine *e;
  70
  71   if (n_stack >= allocated_stack)
  72     engine_stack = x2nrealloc (engine_stack, &allocated_stack,
  73                                sizeof *engine_stack);
  74
  75   e = &engine_stack[n_stack++];
  76   llx_init (&e->drivers);
  77   ds_init_empty (&e->deferred_syntax);
  78 }
  79
  80 void
  81 output_engine_pop (void)
  82 {
  83   struct output_engine *e;
  84
  85   assert (n_stack > 0);
  86   e = &engine_stack[--n_stack];
  87   while (!llx_is_empty (&e->drivers))
  88     {
  89       struct output_driver *d = llx_pop_head (&e->drivers, &llx_malloc_mgr);
  90       output_driver_destroy (d);
  91     }
  92   ds_destroy (&e->deferred_syntax);
  93 }
  94
  95 void
  96 output_get_supported_formats (struct string_set *formats)
  97 {
  98   const struct output_driver_factory **fp;
  99
 100   for (fp = factories; *fp != NULL; fp++)
 101     string_set_insert (formats, (*fp)->extension);
 102 }
 103
 104 static void
 105 output_submit__ (struct output_engine *e, struct output_item *item)
 106 {
 107   struct llx *llx, *next;
 108
 109   for (llx = llx_head (&e->drivers); llx != llx_null (&e->drivers); llx = next)
 110     {
 111       struct output_driver *d = llx_data (llx);
 112       enum settings_output_type type;
 113
 114       next = llx_next (llx);
 115
 116       if (is_message_item (item))
 117         {
 118           const struct msg *m = message_item_get_msg (to_message_item (item));
 119           if (m->severity == MSG_S_NOTE)
 120             type = SETTINGS_OUTPUT_NOTE;
 121           else
 122             type = SETTINGS_OUTPUT_ERROR;
 123         }
 124       else if (is_text_item (item)
 125                && text_item_get_type (to_text_item (item)) == TEXT_ITEM_SYNTAX)
 126         type = SETTINGS_OUTPUT_SYNTAX;
 127       else
 128         type = SETTINGS_OUTPUT_RESULT;
 129
 130       if (settings_get_output_routing (type) & d->device_type)
 131         d->class->submit (d, item);
 132     }
 133
 134   output_item_unref (item);
 135 }
 136
 137 static void
 138 flush_deferred_syntax (struct output_engine *e)
 139 {
 140   if (!ds_is_empty (&e->deferred_syntax))
 141     {
 142       char *syntax = ds_steal_cstr (&e->deferred_syntax);
 143       output_submit__ (e, text_item_super (
 144                          text_item_create_nocopy (TEXT_ITEM_SYNTAX, syntax)));
 145     }
 146 }
 147
 148 static bool
 149 is_syntax_item (const struct output_item *item)
 150 {
 151   return (is_text_item (item)
 152           && text_item_get_type (to_text_item (item)) == TEXT_ITEM_SYNTAX);
 153 }
 154
 155 /* Submits ITEM to the configured output drivers, and transfers ownership to
 156    the output subsystem. */
 157 void
 158 output_submit (struct output_item *item)
 159 {
 160   struct output_engine *e = engine_stack_top ();
 161
 162   if (is_syntax_item (item))
 163     {
 164       ds_put_cstr (&e->deferred_syntax, text_item_get_text (to_text_item (item)));
 165       output_item_unref (item);
 166       return;
 167     }
 168
 169   flush_deferred_syntax (e);
 170   output_submit__ (e, item);
 171 }
 172
 173 /* Flushes output to screen devices, so that the user can see
 174    output that doesn't fill up an entire page. */
 175 void
 176 output_flush (void)
 177 {
 178   struct output_engine *e = engine_stack_top ();
 179   struct llx *llx;
 180
 181   flush_deferred_syntax (e);
 182   for (llx = llx_head (&e->drivers); llx != llx_null (&e->drivers);
 183        llx = llx_next (llx))
 184     {
 185       struct output_driver *d = llx_data (llx);
 186       if (d->device_type & SETTINGS_DEVICE_TERMINAL && d->class->flush != NULL)
 187         d->class->flush (d);
 188     }
 189 }
 190 \f
 191 void
 192 output_driver_init (struct output_driver *driver,
 193                     const struct output_driver_class *class,
 194                     const char *name, enum settings_output_devices type)
 195 {
 196   driver->class = class;
 197   driver->name = xstrdup (name);
 198   driver->device_type = type;
 199 }
 200
 201 void
 202 output_driver_destroy (struct output_driver *driver)
 203 {
 204   if (driver != NULL)
 205     {
 206       char *name = driver->name;
 207       if (output_driver_is_registered (driver))
 208         output_driver_unregister (driver);
 209       if (driver->class->destroy)
 210         driver->class->destroy (driver);
 211       free (name);
 212     }
 213 }
 214
 215 const char *
 216 output_driver_get_name (const struct output_driver *driver)
 217 {
 218   return driver->name;
 219 }
 220 \f
 221 static struct output_engine *
 222 output_driver_get_engine (const struct output_driver *driver)
 223 {
 224   struct output_engine *e;
 225
 226   for (e = engine_stack; e < &engine_stack[n_stack]; e++)
 227     if (llx_find (llx_head (&e->drivers), llx_null (&e->drivers), driver))
 228       return e;
 229
 230   return NULL;
 231 }
 232
 233 void
 234 output_driver_register (struct output_driver *driver)
 235 {
 236   struct output_engine *e = engine_stack_top ();
 237
 238   assert (!output_driver_is_registered (driver));
 239   llx_push_tail (&e->drivers, driver, &llx_malloc_mgr);
 240 }
 241
 242 void
 243 output_driver_unregister (struct output_driver *driver)
 244 {
 245   struct output_engine *e = output_driver_get_engine (driver);
 246
 247   assert (e != NULL);
 248   llx_remove (llx_find (llx_head (&e->drivers), llx_null (&e->drivers), driver),
 249               &llx_malloc_mgr);
 250 }
 251
 252 bool
 253 output_driver_is_registered (const struct output_driver *driver)
 254 {
 255   return output_driver_get_engine (driver) != NULL;
 256 }
 257 \f
 258 /* Useful functions for output driver implementation. */
 259
 260 void
 261 output_driver_track_current_command (const struct output_item *output_item,
 262                                      char **command_namep)
 263 {
 264   if (is_text_item (output_item))
 265     {
 266       const struct text_item *item = to_text_item (output_item);
 267       const char *text = text_item_get_text (item);
 268       enum text_item_type type = text_item_get_type (item);
 269
 270       if (type == TEXT_ITEM_COMMAND_OPEN)
 271         {
 272           free (*command_namep);
 273           *command_namep = xstrdup (text);
 274         }
 275       else if (type == TEXT_ITEM_COMMAND_CLOSE)
 276         {
 277           free (*command_namep);
 278           *command_namep = NULL;
 279         }
 280     }
 281 }
 282 \f
 283 extern const struct output_driver_factory txt_driver_factory;
 284 extern const struct output_driver_factory list_driver_factory;
 285 extern const struct output_driver_factory html_driver_factory;
 286 extern const struct output_driver_factory csv_driver_factory;
 287 #ifdef ODF_WRITE_SUPPORT
 288 extern const struct output_driver_factory odt_driver_factory;
 289 #endif
 290 #ifdef HAVE_CAIRO
 291 extern const struct output_driver_factory pdf_driver_factory;
 292 extern const struct output_driver_factory ps_driver_factory;
 293 extern const struct output_driver_factory svg_driver_factory;
 294 #endif
 295
 296 static const struct output_driver_factory *factories[] =
 297   {
 298     &txt_driver_factory,
 299     &list_driver_factory,
 300     &html_driver_factory,
 301     &csv_driver_factory,
 302 #ifdef ODF_WRITE_SUPPORT
 303     &odt_driver_factory,
 304 #endif
 305 #ifdef HAVE_CAIRO
 306     &pdf_driver_factory,
 307     &ps_driver_factory,
 308     &svg_driver_factory,
 309 #endif
 310     NULL
 311   };
 312
 313 static const struct output_driver_factory *
 314 find_factory (const char *format)
 315 {
 316   const struct output_driver_factory **fp;
 317
 318   for (fp = factories; *fp != NULL; fp++)
 319     {
 320       const struct output_driver_factory *f = *fp;
 321
 322       if (!strcmp (f->extension, format))
 323         return f;
 324     }
 325   return &txt_driver_factory;
 326 }
 327
 328 static enum settings_output_devices
 329 default_device_type (const char *file_name)
 330 {
 331   return (!strcmp (file_name, "-")
 332           ? SETTINGS_DEVICE_TERMINAL
 333           : SETTINGS_DEVICE_LISTING);
 334 }
 335
 336 struct output_driver *
 337 output_driver_create (struct string_map *options)
 338 {
 339   enum settings_output_devices device_type;
 340   const struct output_driver_factory *f;
 341   struct output_driver *driver;
 342   char *device_string;
 343   char *file_name;
 344   char *format;
 345
 346   format = string_map_find_and_delete (options, "format");
 347   file_name = string_map_find_and_delete (options, "output-file");
 348
 349   if (format == NULL)
 350     {
 351       if (file_name != NULL)
 352         {
 353           const char *extension = strrchr (file_name, '.');
 354           format = xstrdup (extension != NULL ? extension + 1 : "");
 355         }
 356       else
 357         format = xstrdup ("txt");
 358     }
 359   f = find_factory (format);
 360
 361   if (file_name == NULL)
 362     file_name = xstrdup (f->default_file_name);
 363
 364   /* XXX should use parse_enum(). */
 365   device_string = string_map_find_and_delete (options, "device");
 366   if (device_string == NULL || device_string[0] == '\0')
 367     device_type = default_device_type (file_name);
 368   else if (!strcmp (device_string, "terminal"))
 369     device_type = SETTINGS_DEVICE_TERMINAL;
 370   else if (!strcmp (device_string, "listing"))
 371     device_type = SETTINGS_DEVICE_LISTING;
 372   else
 373     {
 374       msg (MW, _("%s is not a valid device type (the choices are `%s' and `%s')"),
 375                      device_string, "terminal", "listing");
 376       device_type = default_device_type (file_name);
 377     }
 378
 379   driver = f->create (file_name, device_type, options);
 380   if (driver != NULL)
 381     {
 382       const struct string_map_node *node;
 383       const char *key;
 384
 385       STRING_MAP_FOR_EACH_KEY (key, node, options)
 386         msg (MW, _("%s: unknown option `%s'"), file_name, key);
 387     }
 388   string_map_clear (options);
 389
 390   free (file_name);
 391   free (format);
 392   free (device_string);
 393
 394   return driver;
 395 }