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-handle-def.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 (item == NULL)
 163     return;
 164
 165   if (is_syntax_item (item))
 166     {
 167       ds_put_cstr (&e->deferred_syntax, text_item_get_text (to_text_item (item)));
 168       output_item_unref (item);
 169       return;
 170     }
 171
 172   flush_deferred_syntax (e);
 173   output_submit__ (e, item);
 174 }
 175
 176 /* Flushes output to screen devices, so that the user can see
 177    output that doesn't fill up an entire page. */
 178 void
 179 output_flush (void)
 180 {
 181   struct output_engine *e = engine_stack_top ();
 182   struct llx *llx;
 183
 184   flush_deferred_syntax (e);
 185   for (llx = llx_head (&e->drivers); llx != llx_null (&e->drivers);
 186        llx = llx_next (llx))
 187     {
 188       struct output_driver *d = llx_data (llx);
 189       if (d->device_type & SETTINGS_DEVICE_TERMINAL && d->class->flush != NULL)
 190         d->class->flush (d);
 191     }
 192 }
 193 \f
 194 void
 195 output_driver_init (struct output_driver *driver,
 196                     const struct output_driver_class *class,
 197                     const char *name, enum settings_output_devices type)
 198 {
 199   driver->class = class;
 200   driver->name = xstrdup (name);
 201   driver->device_type = type;
 202 }
 203
 204 void
 205 output_driver_destroy (struct output_driver *driver)
 206 {
 207   if (driver != NULL)
 208     {
 209       char *name = driver->name;
 210       if (output_driver_is_registered (driver))
 211         output_driver_unregister (driver);
 212       if (driver->class->destroy)
 213         driver->class->destroy (driver);
 214       free (name);
 215     }
 216 }
 217
 218 const char *
 219 output_driver_get_name (const struct output_driver *driver)
 220 {
 221   return driver->name;
 222 }
 223 \f
 224 static struct output_engine *
 225 output_driver_get_engine (const struct output_driver *driver)
 226 {
 227   struct output_engine *e;
 228
 229   for (e = engine_stack; e < &engine_stack[n_stack]; e++)
 230     if (llx_find (llx_head (&e->drivers), llx_null (&e->drivers), driver))
 231       return e;
 232
 233   return NULL;
 234 }
 235
 236 void
 237 output_driver_register (struct output_driver *driver)
 238 {
 239   struct output_engine *e = engine_stack_top ();
 240
 241   assert (!output_driver_is_registered (driver));
 242   llx_push_tail (&e->drivers, driver, &llx_malloc_mgr);
 243 }
 244
 245 void
 246 output_driver_unregister (struct output_driver *driver)
 247 {
 248   struct output_engine *e = output_driver_get_engine (driver);
 249
 250   assert (e != NULL);
 251   llx_remove (llx_find (llx_head (&e->drivers), llx_null (&e->drivers), driver),
 252               &llx_malloc_mgr);
 253 }
 254
 255 bool
 256 output_driver_is_registered (const struct output_driver *driver)
 257 {
 258   return output_driver_get_engine (driver) != NULL;
 259 }
 260 \f
 261 /* Useful functions for output driver implementation. */
 262
 263 void
 264 output_driver_track_current_command (const struct output_item *output_item,
 265                                      char **command_namep)
 266 {
 267   if (is_text_item (output_item))
 268     {
 269       const struct text_item *item = to_text_item (output_item);
 270       const char *text = text_item_get_text (item);
 271       enum text_item_type type = text_item_get_type (item);
 272
 273       if (type == TEXT_ITEM_COMMAND_OPEN)
 274         {
 275           free (*command_namep);
 276           *command_namep = xstrdup (text);
 277         }
 278       else if (type == TEXT_ITEM_COMMAND_CLOSE)
 279         {
 280           free (*command_namep);
 281           *command_namep = NULL;
 282         }
 283     }
 284 }
 285 \f
 286 extern const struct output_driver_factory txt_driver_factory;
 287 extern const struct output_driver_factory list_driver_factory;
 288 extern const struct output_driver_factory html_driver_factory;
 289 extern const struct output_driver_factory csv_driver_factory;
 290 extern const struct output_driver_factory odt_driver_factory;
 291 #ifdef HAVE_CAIRO
 292 extern const struct output_driver_factory pdf_driver_factory;
 293 extern const struct output_driver_factory ps_driver_factory;
 294 extern const struct output_driver_factory svg_driver_factory;
 295 #endif
 296
 297 static const struct output_driver_factory *factories[] =
 298   {
 299     &txt_driver_factory,
 300     &list_driver_factory,
 301     &html_driver_factory,
 302     &csv_driver_factory,
 303     &odt_driver_factory,
 304 #ifdef HAVE_CAIRO
 305     &pdf_driver_factory,
 306     &ps_driver_factory,
 307     &svg_driver_factory,
 308 #endif
 309     NULL
 310   };
 311
 312 static const struct output_driver_factory *
 313 find_factory (const char *format)
 314 {
 315   const struct output_driver_factory **fp;
 316
 317   for (fp = factories; *fp != NULL; fp++)
 318     {
 319       const struct output_driver_factory *f = *fp;
 320
 321       if (!strcmp (f->extension, format))
 322         return f;
 323     }
 324   return &txt_driver_factory;
 325 }
 326
 327 static enum settings_output_devices
 328 default_device_type (const char *file_name)
 329 {
 330   return (!strcmp (file_name, "-")
 331           ? SETTINGS_DEVICE_TERMINAL
 332           : SETTINGS_DEVICE_LISTING);
 333 }
 334
 335 struct output_driver *
 336 output_driver_create (struct string_map *options)
 337 {
 338   enum settings_output_devices device_type;
 339   const struct output_driver_factory *f;
 340   struct output_driver *driver;
 341   char *device_string;
 342   char *file_name;
 343   char *format;
 344
 345   format = string_map_find_and_delete (options, "format");
 346   file_name = string_map_find_and_delete (options, "output-file");
 347
 348   if (format == NULL)
 349     {
 350       if (file_name != NULL)
 351         {
 352           const char *extension = strrchr (file_name, '.');
 353           format = xstrdup (extension != NULL ? extension + 1 : "");
 354         }
 355       else
 356         format = xstrdup ("txt");
 357     }
 358   f = find_factory (format);
 359
 360   if (file_name == NULL)
 361     file_name = xstrdup (f->default_file_name);
 362
 363   /* XXX should use parse_enum(). */
 364   device_string = string_map_find_and_delete (options, "device");
 365   if (device_string == NULL || device_string[0] == '\0')
 366     device_type = default_device_type (file_name);
 367   else if (!strcmp (device_string, "terminal"))
 368     device_type = SETTINGS_DEVICE_TERMINAL;
 369   else if (!strcmp (device_string, "listing"))
 370     device_type = SETTINGS_DEVICE_LISTING;
 371   else
 372     {
 373       msg (MW, _("%s is not a valid device type (the choices are `%s' and `%s')"),
 374                      device_string, "terminal", "listing");
 375       device_type = default_device_type (file_name);
 376     }
 377
 378   struct file_handle *fh = fh_create_file (NULL, file_name, NULL, fh_default_properties ());
 379
 380   driver = f->create (fh, device_type, options);
 381   if (driver != NULL)
 382     {
 383       const struct string_map_node *node;
 384       const char *key;
 385
 386       STRING_MAP_FOR_EACH_KEY (key, node, options)
 387         msg (MW, _("%s: unknown option `%s'"), file_name, key);
 388     }
 389   string_map_clear (options);
 390
 391   free (file_name);
 392   free (format);
 393   free (device_string);
 394
 395   return driver;
 396 }