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