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