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 <libxml/parser.h>
  25 #include <libxml/tree.h>
  26 #include <limits.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include <time.h>
  30
  31 #include "data/file-handle-def.h"
  32 #include "data/settings.h"
  33 #include "libpspp/array.h"
  34 #include "libpspp/assertion.h"
  35 #include "libpspp/message.h"
  36 #include "libpspp/llx.h"
  37 #include "libpspp/string-map.h"
  38 #include "libpspp/string-set.h"
  39 #include "libpspp/str.h"
  40 #include "output/group-item.h"
  41 #include "output/message-item.h"
  42 #include "output/output-item.h"
  43 #include "output/text-item.h"
  44
  45 #include "gl/error.h"
  46 #include "gl/xalloc.h"
  47 #include "gl/xmemdup0.h"
  48
  49 #include "gettext.h"
  50 #define _(msgid) gettext (msgid)
  51
  52 struct output_engine
  53   {
  54     struct llx_list drivers;       /* Contains "struct output_driver"s. */
  55     struct string deferred_text;   /* Output text being accumulated. */
  56     enum text_item_type deferred_type; /* Type of text being accumulated. */
  57     char *command_name;            /* Name of command being processed. */
  58     char *title, *subtitle;        /* Components of page title. */
  59
  60     /* Output grouping stack.
  61
  62        TEXT_ITEM_GROUP_OPEN pushes a group on the stack and
  63        TEXT_ITEM_GROUP_CLOSE pops one off. */
  64     char **groups;               /* Command names of nested sections. */
  65     size_t n_groups;
  66     size_t allocated_groups;
  67
  68     struct string_map heading_vars;
  69   };
  70
  71 static const struct output_driver_factory *factories[];
  72
  73 /* A stack of output engines.. */
  74 static struct output_engine *engine_stack;
  75 static size_t n_stack, allocated_stack;
  76
  77 static struct output_engine *
  78 engine_stack_top (void)
  79 {
  80   assert (n_stack > 0);
  81   return &engine_stack[n_stack - 1];
  82 }
  83
  84 static void
  85 put_strftime (const char *key, const char *format,
  86               const struct tm *tm, struct string_map *vars)
  87 {
  88   if (!string_map_find (vars, key))
  89     {
  90       char value[128];
  91       strftime (value, sizeof value, format, tm);
  92       string_map_insert (vars, key, value);
  93     }
  94 }
  95
  96 void
  97 output_engine_push (void)
  98 {
  99   struct output_engine *e;
 100
 101   if (n_stack >= allocated_stack)
 102     engine_stack = x2nrealloc (engine_stack, &allocated_stack,
 103                                sizeof *engine_stack);
 104
 105   e = &engine_stack[n_stack++];
 106   memset (e, 0, sizeof *e);
 107   llx_init (&e->drivers);
 108   ds_init_empty (&e->deferred_text);
 109
 110   string_map_init (&e->heading_vars);
 111
 112   time_t t = time (NULL);
 113   const struct tm *tm = localtime (&t);
 114   put_strftime ("Date", "%x", tm, &e->heading_vars);
 115   put_strftime ("Time", "%X", tm, &e->heading_vars);
 116 }
 117
 118 void
 119 output_engine_pop (void)
 120 {
 121   struct output_engine *e;
 122
 123   assert (n_stack > 0);
 124   e = &engine_stack[--n_stack];
 125   while (!llx_is_empty (&e->drivers))
 126     {
 127       struct output_driver *d = llx_pop_head (&e->drivers, &llx_malloc_mgr);
 128       output_driver_destroy (d);
 129     }
 130   ds_destroy (&e->deferred_text);
 131   free (e->command_name);
 132   free (e->title);
 133   free (e->subtitle);
 134   for (size_t i = 0; i < e->n_groups; i++)
 135     free (e->groups[i]);
 136   free (e->groups);
 137   string_map_destroy (&e->heading_vars);
 138 }
 139
 140 void
 141 output_get_supported_formats (struct string_set *formats)
 142 {
 143   const struct output_driver_factory **fp;
 144
 145   for (fp = factories; *fp != NULL; fp++)
 146     string_set_insert (formats, (*fp)->extension);
 147 }
 148
 149 static void
 150 output_submit__ (struct output_engine *e, struct output_item *item)
 151 {
 152   struct llx *llx, *next;
 153
 154   for (llx = llx_head (&e->drivers); llx != llx_null (&e->drivers); llx = next)
 155     {
 156       struct output_driver *d = llx_data (llx);
 157       enum settings_output_type type;
 158
 159       next = llx_next (llx);
 160
 161       if (is_message_item (item))
 162         {
 163           const struct msg *m = message_item_get_msg (to_message_item (item));
 164           if (m->severity == MSG_S_NOTE)
 165             type = SETTINGS_OUTPUT_NOTE;
 166           else
 167             type = SETTINGS_OUTPUT_ERROR;
 168         }
 169       else if (is_text_item (item)
 170                && text_item_get_type (to_text_item (item)) == TEXT_ITEM_SYNTAX)
 171         type = SETTINGS_OUTPUT_SYNTAX;
 172       else
 173         type = SETTINGS_OUTPUT_RESULT;
 174
 175       if (settings_get_output_routing (type) & d->device_type)
 176         d->class->submit (d, item);
 177     }
 178
 179   output_item_unref (item);
 180 }
 181
 182 static void
 183 flush_deferred_text (struct output_engine *e)
 184 {
 185   if (!ds_is_empty (&e->deferred_text))
 186     {
 187       char *text = ds_steal_cstr (&e->deferred_text);
 188       output_submit__ (e, text_item_super (text_item_create_nocopy (
 189                                              e->deferred_type, text)));
 190     }
 191 }
 192
 193 static bool
 194 defer_text (struct output_engine *e, struct output_item *item)
 195 {
 196   if (!is_text_item (item))
 197     return false;
 198
 199   enum text_item_type type = text_item_get_type (to_text_item (item));
 200   if (type != TEXT_ITEM_SYNTAX && type != TEXT_ITEM_LOG)
 201     return false;
 202
 203   if (!ds_is_empty (&e->deferred_text) && e->deferred_type != type)
 204     flush_deferred_text (e);
 205
 206   e->deferred_type = type;
 207
 208   if (!ds_is_empty (&e->deferred_text))
 209     ds_put_byte (&e->deferred_text, '\n');
 210
 211   const char *text = text_item_get_text (to_text_item (item));
 212   ds_put_cstr (&e->deferred_text, text);
 213   output_item_unref (item);
 214
 215   return true;
 216 }
 217
 218 /* Submits ITEM to the configured output drivers, and transfers ownership to
 219    the output subsystem. */
 220 void
 221 output_submit (struct output_item *item)
 222 {
 223   struct output_engine *e = engine_stack_top ();
 224
 225   if (item == NULL)
 226     return;
 227
 228   if (defer_text (e, item))
 229     return;
 230   flush_deferred_text (e);
 231
 232   if (is_group_open_item (item))
 233     {
 234       const struct group_open_item *group_open_item
 235         = to_group_open_item (item);
 236       if (e->n_groups >= e->allocated_groups)
 237         e->groups = x2nrealloc (e->groups, &e->allocated_groups,
 238                                 sizeof *e->groups);
 239       e->groups[e->n_groups] = (group_open_item->command_name
 240                                 ? xstrdup (group_open_item->command_name)
 241                                 : NULL);
 242       e->n_groups++;
 243     }
 244   else if (is_group_close_item (item))
 245     {
 246       assert (e->n_groups > 0);
 247
 248       size_t idx = --e->n_groups;
 249       free (e->groups[idx]);
 250       if (idx >= 1 && idx <= 4)
 251         {
 252           char *key = xasprintf ("Head%zu", idx);
 253           string_map_find_and_delete (&e->heading_vars, key);
 254           free (key);
 255         }
 256     }
 257   else if (is_text_item (item))
 258     {
 259       const struct text_item *text_item = to_text_item (item);
 260       enum text_item_type type = text_item_get_type (text_item);
 261       const char *text = text_item_get_text (text_item);
 262       if (type == TEXT_ITEM_TITLE
 263           && e->n_groups >= 1 && e->n_groups <= 4)
 264         {
 265           char *key = xasprintf ("Head%zu", e->n_groups);
 266           string_map_replace (&e->heading_vars, key, text);
 267           free (key);
 268         }
 269       else if (type == TEXT_ITEM_PAGE_TITLE)
 270         string_map_replace (&e->heading_vars, "PageTitle", text);
 271     }
 272
 273   output_submit__ (e, item);
 274 }
 275
 276 const char *
 277 output_get_command_name (void)
 278 {
 279   if (n_stack)
 280     {
 281       struct output_engine *e = engine_stack_top ();
 282       for (size_t i = e->n_groups; i-- > 0; )
 283         if (e->groups[i])
 284           return e->groups[i];
 285     }
 286
 287   return NULL;
 288 }
 289
 290 /* Flushes output to screen devices, so that the user can see
 291    output that doesn't fill up an entire page. */
 292 void
 293 output_flush (void)
 294 {
 295   struct output_engine *e = engine_stack_top ();
 296   struct llx *llx;
 297
 298   flush_deferred_text (e);
 299   for (llx = llx_head (&e->drivers); llx != llx_null (&e->drivers);
 300        llx = llx_next (llx))
 301     {
 302       struct output_driver *d = llx_data (llx);
 303       if (d->device_type & SETTINGS_DEVICE_TERMINAL && d->class->flush != NULL)
 304         d->class->flush (d);
 305     }
 306 }
 307
 308 static void
 309 output_set_title__ (struct output_engine *e, char **dst, const char *src)
 310 {
 311   free (*dst);
 312   *dst = src ? xstrdup (src) : NULL;
 313
 314   char *page_title
 315     = (e->title && e->subtitle ? xasprintf ("%s\n%s", e->title, e->subtitle)
 316        : e->title ? xstrdup (e->title)
 317        : e->subtitle ? xstrdup (e->subtitle)
 318        : xzalloc (1));
 319   text_item_submit (text_item_create_nocopy (TEXT_ITEM_PAGE_TITLE,
 320                                              page_title));
 321 }
 322
 323 void
 324 output_set_title (const char *title)
 325 {
 326   struct output_engine *e = engine_stack_top ();
 327
 328   output_set_title__ (e, &e->title, title);
 329 }
 330
 331 void
 332 output_set_subtitle (const char *subtitle)
 333 {
 334   struct output_engine *e = engine_stack_top ();
 335
 336   output_set_title__ (e, &e->subtitle, subtitle);
 337 }
 338
 339 void
 340 output_set_filename (const char *filename)
 341 {
 342   struct output_engine *e = engine_stack_top ();
 343
 344   string_map_replace (&e->heading_vars, "Filename", filename);
 345 }
 346
 347 size_t
 348 output_get_group_level (void)
 349 {
 350   struct output_engine *e = engine_stack_top ();
 351
 352   return e->n_groups;
 353 }
 354 \f
 355 void
 356 output_driver_init (struct output_driver *driver,
 357                     const struct output_driver_class *class,
 358                     const char *name, enum settings_output_devices type)
 359 {
 360   driver->class = class;
 361   driver->name = xstrdup (name);
 362   driver->device_type = type;
 363 }
 364
 365 void
 366 output_driver_destroy (struct output_driver *driver)
 367 {
 368   if (driver != NULL)
 369     {
 370       char *name = driver->name;
 371       if (output_driver_is_registered (driver))
 372         output_driver_unregister (driver);
 373       if (driver->class->destroy)
 374         driver->class->destroy (driver);
 375       free (name);
 376     }
 377 }
 378
 379 const char *
 380 output_driver_get_name (const struct output_driver *driver)
 381 {
 382   return driver->name;
 383 }
 384 \f
 385 static struct output_engine *
 386 output_driver_get_engine (const struct output_driver *driver)
 387 {
 388   struct output_engine *e;
 389
 390   for (e = engine_stack; e < &engine_stack[n_stack]; e++)
 391     if (llx_find (llx_head (&e->drivers), llx_null (&e->drivers), driver))
 392       return e;
 393
 394   return NULL;
 395 }
 396
 397 void
 398 output_driver_register (struct output_driver *driver)
 399 {
 400   struct output_engine *e = engine_stack_top ();
 401
 402   assert (!output_driver_is_registered (driver));
 403   llx_push_tail (&e->drivers, driver, &llx_malloc_mgr);
 404 }
 405
 406 void
 407 output_driver_unregister (struct output_driver *driver)
 408 {
 409   struct output_engine *e = output_driver_get_engine (driver);
 410
 411   assert (e != NULL);
 412   llx_remove (llx_find (llx_head (&e->drivers), llx_null (&e->drivers), driver),
 413               &llx_malloc_mgr);
 414 }
 415
 416 bool
 417 output_driver_is_registered (const struct output_driver *driver)
 418 {
 419   return output_driver_get_engine (driver) != NULL;
 420 }
 421 \f
 422 extern const struct output_driver_factory txt_driver_factory;
 423 extern const struct output_driver_factory list_driver_factory;
 424 extern const struct output_driver_factory html_driver_factory;
 425 extern const struct output_driver_factory csv_driver_factory;
 426 extern const struct output_driver_factory odt_driver_factory;
 427 #ifdef HAVE_CAIRO
 428 extern const struct output_driver_factory pdf_driver_factory;
 429 extern const struct output_driver_factory ps_driver_factory;
 430 extern const struct output_driver_factory svg_driver_factory;
 431 #endif
 432
 433 static const struct output_driver_factory *factories[] =
 434   {
 435     &txt_driver_factory,
 436     &list_driver_factory,
 437     &html_driver_factory,
 438     &csv_driver_factory,
 439     &odt_driver_factory,
 440 #ifdef HAVE_CAIRO
 441     &pdf_driver_factory,
 442     &ps_driver_factory,
 443     &svg_driver_factory,
 444 #endif
 445     NULL
 446   };
 447
 448 static const struct output_driver_factory *
 449 find_factory (const char *format)
 450 {
 451   const struct output_driver_factory **fp;
 452
 453   for (fp = factories; *fp != NULL; fp++)
 454     {
 455       const struct output_driver_factory *f = *fp;
 456
 457       if (!strcmp (f->extension, format))
 458         return f;
 459     }
 460   return &txt_driver_factory;
 461 }
 462
 463 static enum settings_output_devices
 464 default_device_type (const char *file_name)
 465 {
 466   return (!strcmp (file_name, "-")
 467           ? SETTINGS_DEVICE_TERMINAL
 468           : SETTINGS_DEVICE_LISTING);
 469 }
 470
 471 struct output_driver *
 472 output_driver_create (struct string_map *options)
 473 {
 474   enum settings_output_devices device_type;
 475   const struct output_driver_factory *f;
 476   struct output_driver *driver;
 477   char *device_string;
 478   char *file_name;
 479   char *format;
 480
 481   format = string_map_find_and_delete (options, "format");
 482   file_name = string_map_find_and_delete (options, "output-file");
 483
 484   if (format == NULL)
 485     {
 486       if (file_name != NULL)
 487         {
 488           const char *extension = strrchr (file_name, '.');
 489           format = xstrdup (extension != NULL ? extension + 1 : "");
 490         }
 491       else
 492         format = xstrdup ("txt");
 493     }
 494   f = find_factory (format);
 495
 496   if (file_name == NULL)
 497     file_name = xstrdup (f->default_file_name);
 498
 499   /* XXX should use parse_enum(). */
 500   device_string = string_map_find_and_delete (options, "device");
 501   if (device_string == NULL || device_string[0] == '\0')
 502     device_type = default_device_type (file_name);
 503   else if (!strcmp (device_string, "terminal"))
 504     device_type = SETTINGS_DEVICE_TERMINAL;
 505   else if (!strcmp (device_string, "listing"))
 506     device_type = SETTINGS_DEVICE_LISTING;
 507   else
 508     {
 509       msg (MW, _("%s is not a valid device type (the choices are `%s' and `%s')"),
 510                      device_string, "terminal", "listing");
 511       device_type = default_device_type (file_name);
 512     }
 513
 514   struct file_handle *fh = fh_create_file (NULL, file_name, NULL, fh_default_properties ());
 515
 516   driver = f->create (fh, device_type, options);
 517   if (driver != NULL)
 518     {
 519       const struct string_map_node *node;
 520       const char *key;
 521
 522       STRING_MAP_FOR_EACH_KEY (key, node, options)
 523         msg (MW, _("%s: unknown option `%s'"), file_name, key);
 524     }
 525   string_map_clear (options);
 526
 527   free (file_name);
 528   free (format);
 529   free (device_string);
 530
 531   return driver;
 532 }
 533
 534 void
 535 output_driver_parse_option (const char *option, struct string_map *options)
 536 {
 537   const char *equals = strchr (option, '=');
 538   if (equals == NULL)
 539     {
 540       error (0, 0, _("%s: output option missing `='"), option);
 541       return;
 542     }
 543
 544   char *key = xmemdup0 (option, equals - option);
 545   if (string_map_contains (options, key))
 546     {
 547       error (0, 0, _("%s: output option specified more than once"), key);
 548       free (key);
 549       return;
 550     }
 551
 552   char *value = xmemdup0 (equals + 1, strlen (equals + 1));
 553   string_map_insert_nocopy (options, key, value);
 554 }
 555 \f
 556 /* Extracts the actual text content from the given Pango MARKUP and returns it
 557    as as a malloc()'d string. */
 558 char *
 559 output_get_text_from_markup (const char *markup)
 560 {
 561   xmlParserCtxt *parser = xmlCreatePushParserCtxt (NULL, NULL, NULL, 0, NULL);
 562   if (!parser)
 563     return xstrdup (markup);
 564
 565   xmlParseChunk (parser, "<xml>", strlen ("<xml>"), false);
 566   xmlParseChunk (parser, markup, strlen (markup), false);
 567   xmlParseChunk (parser, "</xml>", strlen ("</xml>"), true);
 568
 569   char *content
 570     = (parser->wellFormed
 571        ? CHAR_CAST (char *,
 572                     xmlNodeGetContent (xmlDocGetRootElement (parser->myDoc)))
 573        : xstrdup (markup));
 574   xmlFreeDoc (parser->myDoc);
 575   xmlFreeParserCtxt (parser);
 576
 577   return content;
 578 }
 579
 580 char *
 581 output_driver_substitute_heading_vars (const char *src, int page_number)
 582 {
 583   struct output_engine *e = engine_stack_top ();
 584   struct string dst = DS_EMPTY_INITIALIZER;
 585   ds_extend (&dst, strlen (src));
 586   for (const char *p = src; *p; )
 587     {
 588       if (!strncmp (p, "&amp;[", 6))
 589         {
 590           if (page_number != INT_MIN)
 591             {
 592               const char *start = p + 6;
 593               const char *end = strchr (start, ']');
 594               if (end)
 595                 {
 596                   const char *value = string_map_find__ (&e->heading_vars,
 597                                                          start, end - start);
 598                   if (value)
 599                     ds_put_cstr (&dst, value);
 600                   else if (ss_equals (ss_buffer (start, end - start),
 601                                       ss_cstr ("Page")))
 602                     ds_put_format (&dst, "%d", page_number);
 603                   p = end + 1;
 604                   continue;
 605                 }
 606             }
 607           ds_put_cstr (&dst, "&amp;");
 608           p += 5;
 609         }
 610       else
 611         ds_put_byte (&dst, *p++);
 612     }
 613   return ds_steal_cstr (&dst);
 614 }