src/output.c

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
   3    Written by Ben Pfaff <blp@gnu.org>.
   4
   5    This program is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    License, or (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful, but
  11    WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  18    02111-1307, USA. */
  19
  20 #include <config.h>
  21 #include "output.h"
  22 #include <assert.h>
  23 #include <stdlib.h>
  24 #include <stdio.h>
  25 #include <errno.h>
  26 #include <ctype.h>
  27 #include "alloc.h"
  28 #include "devind.h"
  29 #include "error.h"
  30 #include "filename.h"
  31 #include "htmlP.h"
  32 #include "lexer.h"
  33 #include "misc.h"
  34 #include "settings.h"
  35 #include "str.h"
  36
  37 /* FIXME? Should the output configuration format be changed to
  38    drivername:classname:devicetype:options, where devicetype is zero
  39    or more of screen, printer, listing? */
  40
  41 /* FIXME: Have the reentrancy problems been solved? */
  42
  43 /* Where the output driver name came from. */
  44 enum
  45   {
  46     OUTP_S_COMMAND_LINE,        /* Specified by the user. */
  47     OUTP_S_INIT_FILE            /* `default' or the init file. */
  48   };
  49
  50 /* Names the output drivers to be used. */
  51 struct outp_names
  52   {
  53     char *name;                 /* Name of the output driver. */
  54     int source;                 /* OUTP_S_* */
  55     struct outp_names *next, *prev;
  56   };
  57
  58 /* Defines an init file macro. */
  59 struct outp_defn
  60   {
  61     char *key;
  62     char *value;
  63     struct outp_defn *next, *prev;
  64   };
  65
  66 static struct outp_defn *outp_macros;
  67 static struct outp_names *outp_configure_vec;
  68
  69 struct outp_driver_class_list *outp_class_list;
  70 struct outp_driver *outp_driver_list;
  71
  72 char *outp_title;
  73 char *outp_subtitle;
  74
  75 /* A set of OUTP_DEV_* bits indicating the devices that are
  76    disabled. */
  77 static int disabled_devices;
  78
  79 static void destroy_driver (struct outp_driver *);
  80 static void configure_driver (char *);
  81
  82 #if GLOBAL_DEBUGGING
  83 /* This mechanism attempts to catch reentrant use of outp_driver_list. */
  84 static int iterating_driver_list;
  85
  86 #define reentrancy() msg (FE, _("Attempt to iterate driver list reentrantly."))
  87 #endif
  88
  89 /* Add a class to the class list. */
  90 static void
  91 add_class (struct outp_class *class)
  92 {
  93   struct outp_driver_class_list *new_list = xmalloc (sizeof *new_list);
  94
  95   new_list->class = class;
  96   new_list->ref_count = 0;
  97
  98   if (!outp_class_list)
  99     {
 100       outp_class_list = new_list;
 101       new_list->next = NULL;
 102     }
 103   else
 104     {
 105       new_list->next = outp_class_list;
 106       outp_class_list = new_list;
 107     }
 108 }
 109
 110 /* Finds the outp_names in outp_configure_vec with name between BP and
 111    EP exclusive. */
 112 static struct outp_names *
 113 search_names (char *bp, char *ep)
 114 {
 115   struct outp_names *n;
 116
 117   for (n = outp_configure_vec; n; n = n->next)
 118     if ((int) strlen (n->name) == ep - bp && !memcmp (n->name, bp, ep - bp))
 119       return n;
 120   return NULL;
 121 }
 122
 123 /* Deletes outp_names NAME from outp_configure_vec. */
 124 static void
 125 delete_name (struct outp_names * n)
 126 {
 127   free (n->name);
 128   if (n->prev)
 129     n->prev->next = n->next;
 130   if (n->next)
 131     n->next->prev = n->prev;
 132   if (n == outp_configure_vec)
 133     outp_configure_vec = n->next;
 134   free (n);
 135 }
 136
 137 /* Adds the name between BP and EP exclusive to list
 138    outp_configure_vec with source SOURCE. */
 139 static void
 140 add_name (char *bp, char *ep, int source)
 141 {
 142   struct outp_names *n = xmalloc (sizeof *n);
 143   n->name = xmalloc (ep - bp + 1);
 144   memcpy (n->name, bp, ep - bp);
 145   n->name[ep - bp] = 0;
 146   n->source = source;
 147   n->next = outp_configure_vec;
 148   n->prev = NULL;
 149   if (outp_configure_vec)
 150     outp_configure_vec->prev = n;
 151   outp_configure_vec = n;
 152 }
 153
 154 /* Checks that outp_configure_vec is empty, bitches & clears it if it
 155    isn't. */
 156 static void
 157 check_configure_vec (void)
 158 {
 159   struct outp_names *n;
 160
 161   for (n = outp_configure_vec; n; n = n->next)
 162     if (n->source == OUTP_S_COMMAND_LINE)
 163       msg (ME, _("Unknown output driver `%s'."), n->name);
 164     else
 165       msg (IE, _("Output driver `%s' referenced but never defined."), n->name);
 166   outp_configure_clear ();
 167 }
 168
 169 /* Searches outp_configure_vec for the name between BP and EP
 170    exclusive.  If found, it is deleted, then replaced by the names
 171    given in EP+1, if any. */
 172 static void
 173 expand_name (char *bp, char *ep)
 174 {
 175   struct outp_names *n = search_names (bp, ep);
 176   if (!n)
 177     return;
 178   delete_name (n);
 179
 180   bp = ep + 1;
 181   for (;;)
 182     {
 183       while (isspace ((unsigned char) *bp))
 184         bp++;
 185       ep = bp;
 186       while (*ep && !isspace ((unsigned char) *ep))
 187         ep++;
 188       if (bp == ep)
 189         return;
 190       if (!search_names (bp, ep))
 191         add_name (bp, ep, OUTP_S_INIT_FILE);
 192       bp = ep;
 193     }
 194 }
 195
 196 /* Looks for a macro with key KEY, and returns the corresponding value
 197    if found, or NULL if not. */
 198 static const char *
 199 find_defn_value (const char *key)
 200 {
 201   static char buf[INT_DIGITS + 1];
 202   struct outp_defn *d;
 203
 204   for (d = outp_macros; d; d = d->next)
 205     if (!strcmp (key, d->key))
 206       return d->value;
 207   if (!strcmp (key, "viewwidth"))
 208     {
 209       sprintf (buf, "%d", get_viewwidth());
 210       return buf;
 211     }
 212   else if (!strcmp (key, "viewlength"))
 213     {
 214       sprintf (buf, "%d", get_viewlength());
 215       return buf;
 216     }
 217   else
 218     return getenv (key);
 219 }
 220
 221 /* Initializes global variables. */
 222 int
 223 outp_init (void)
 224 {
 225   extern struct outp_class ascii_class;
 226 #if !NO_POSTSCRIPT
 227   extern struct outp_class postscript_class;
 228   extern struct outp_class epsf_class;
 229 #endif
 230   extern struct outp_class html_class;
 231   extern struct outp_class devind_class;
 232
 233   char def[] = "default";
 234
 235 #if !NO_HTML
 236   add_class (&html_class);
 237 #endif
 238 #if !NO_POSTSCRIPT
 239   add_class (&epsf_class);
 240   add_class (&postscript_class);
 241 #endif
 242   add_class (&devind_class);
 243   add_class (&ascii_class);
 244
 245   add_name (def, &def[strlen (def)], OUTP_S_INIT_FILE);
 246
 247   return 1;
 248 }
 249
 250 /* Deletes all the output macros. */
 251 static void
 252 delete_macros (void)
 253 {
 254   struct outp_defn *d, *next;
 255
 256   for (d = outp_macros; d; d = next)
 257     {
 258       next = d->next;
 259       free (d->key);
 260       free (d->value);
 261       free (d);
 262     }
 263 }
 264
 265 /* Reads the initialization file; initializes outp_driver_list. */
 266 int
 267 outp_read_devices (void)
 268 {
 269   int result = 0;
 270
 271   char *init_fn;
 272
 273   FILE *f = NULL;
 274   struct string line;
 275   struct file_locator where;
 276
 277 #if GLOBAL_DEBUGGING
 278   if (iterating_driver_list)
 279     reentrancy ();
 280 #endif
 281
 282   init_fn = fn_search_path (fn_getenv_default ("STAT_OUTPUT_INIT_FILE",
 283                                                "devices"),
 284                             fn_getenv_default ("STAT_OUTPUT_INIT_PATH",
 285                                                config_path),
 286                             NULL);
 287   where.filename = init_fn;
 288   where.line_number = 0;
 289   err_push_file_locator (&where);
 290
 291   ds_init (NULL, &line, 128);
 292
 293   if (init_fn == NULL)
 294     {
 295       msg (IE, _("Cannot find output initialization file.  Use `-vv' to view "
 296            "search path."));
 297       goto exit;
 298     }
 299
 300   msg (VM (1), _("%s: Opening device description file..."), init_fn);
 301   f = fopen (init_fn, "r");
 302   if (f == NULL)
 303     {
 304       msg (IE, _("Opening %s: %s."), init_fn, strerror (errno));
 305       goto exit;
 306     }
 307
 308   for (;;)
 309     {
 310       char *cp;
 311
 312       if (!ds_get_config_line (f, &line, &where))
 313         {
 314           if (ferror (f))
 315             msg (ME, _("Reading %s: %s."), init_fn, strerror (errno));
 316           break;
 317         }
 318       for (cp = ds_value (&line); isspace ((unsigned char) *cp); cp++);
 319       if (!strncmp ("define", cp, 6) && isspace ((unsigned char) cp[6]))
 320         outp_configure_macro (&cp[7]);
 321       else if (*cp)
 322         {
 323           char *ep;
 324           for (ep = cp; *ep && *ep != ':' && *ep != '='; ep++);
 325           if (*ep == '=')
 326             expand_name (cp, ep);
 327           else if (*ep == ':')
 328             {
 329               struct outp_names *n = search_names (cp, ep);
 330               if (n)
 331                 {
 332                   configure_driver (cp);
 333                   delete_name (n);
 334                 }
 335             }
 336           else
 337             msg (IS, _("Syntax error."));
 338         }
 339     }
 340   result = 1;
 341
 342   check_configure_vec ();
 343
 344 exit:
 345   err_pop_file_locator (&where);
 346   if (f && -1 == fclose (f))
 347     msg (MW, _("Closing %s: %s."), init_fn, strerror (errno));
 348   free (init_fn);
 349   ds_destroy (&line);
 350   delete_macros ();
 351   if (outp_driver_list == NULL)
 352     msg (MW, _("No output drivers are active."));
 353
 354   if (result)
 355     msg (VM (2), _("Device definition file read successfully."));
 356   else
 357     msg (VM (1), _("Error reading device definition file."));
 358   return result;
 359 }
 360
 361 /* Clear the list of drivers to configure. */
 362 void
 363 outp_configure_clear (void)
 364 {
 365   struct outp_names *n, *next;
 366
 367   for (n = outp_configure_vec; n; n = next)
 368     {
 369       next = n->next;
 370       free (n->name);
 371       free (n);
 372     }
 373   outp_configure_vec = NULL;
 374 }
 375
 376 /* Adds the name BP to the list of drivers to configure into
 377    outp_driver_list. */
 378 void
 379 outp_configure_add (char *bp)
 380 {
 381   char *ep = &bp[strlen (bp)];
 382   if (!search_names (bp, ep))
 383     add_name (bp, ep, OUTP_S_COMMAND_LINE);
 384 }
 385
 386 /* Defines one configuration macro based on the text in BP, which
 387    should be of the form `KEY=VALUE'. */
 388 void
 389 outp_configure_macro (char *bp)
 390 {
 391   struct outp_defn *d;
 392   char *ep;
 393
 394   while (isspace ((unsigned char) *bp))
 395     bp++;
 396   ep = bp;
 397   while (*ep && !isspace ((unsigned char) *ep) && *ep != '=')
 398     ep++;
 399
 400   d = xmalloc (sizeof *d);
 401   d->key = xmalloc (ep - bp + 1);
 402   memcpy (d->key, bp, ep - bp);
 403   d->key[ep - bp] = 0;
 404
 405   /* Earlier definitions for a particular KEY override later ones. */
 406   if (find_defn_value (d->key))
 407     {
 408       free (d->key);
 409       free (d);
 410       return;
 411     }
 412
 413   if (*ep == '=')
 414     ep++;
 415   while (isspace ((unsigned char) *ep))
 416     ep++;
 417   d->value = fn_interp_vars (ep, find_defn_value);
 418   d->next = outp_macros;
 419   d->prev = NULL;
 420   if (outp_macros)
 421     outp_macros->prev = d;
 422   outp_macros = d;
 423 }
 424
 425 /* Destroys all the drivers in driver list *DL and sets *DL to
 426    NULL. */
 427 static void
 428 destroy_list (struct outp_driver ** dl)
 429 {
 430   struct outp_driver *d, *next;
 431
 432   for (d = *dl; d; d = next)
 433     {
 434       destroy_driver (d);
 435       next = d->next;
 436       free (d);
 437     }
 438   *dl = NULL;
 439 }
 440
 441 /* Closes all the output drivers. */
 442 int
 443 outp_done (void)
 444 {
 445 #if GLOBAL_DEBUGGING
 446   if (iterating_driver_list)
 447     reentrancy ();
 448 #endif
 449   destroy_list (&outp_driver_list);
 450
 451   return 1;
 452 }
 453
 454 /* Display on stdout a list of all registered driver classes. */
 455 void
 456 outp_list_classes (void)
 457 {
 458   int width = get_viewwidth();
 459   struct outp_driver_class_list *c;
 460
 461   printf (_("Driver classes:\n\t"));
 462   width -= 8;
 463   for (c = outp_class_list; c; c = c->next)
 464     {
 465       if ((int) strlen (c->class->name) + 1 > width)
 466         {
 467           printf ("\n\t");
 468           width = get_viewwidth() - 8;
 469         }
 470       else
 471         putc (' ', stdout);
 472       fputs (c->class->name, stdout);
 473     }
 474   putc('\n', stdout);
 475 }
 476
 477 static int op_token;            /* `=', 'a', 0. */
 478 static struct string op_tokstr;
 479 static char *prog;
 480
 481 /* Parses a token from prog into op_token, op_tokstr.  Sets op_token
 482    to '=' on an equals sign, to 'a' on a string or identifier token,
 483    or to 0 at end of line.  Returns the new op_token. */
 484 static int
 485 tokener (void)
 486 {
 487   if (op_token == 0)
 488     {
 489       msg (IS, _("Syntax error."));
 490       return 0;
 491     }
 492
 493   while (isspace ((unsigned char) *prog))
 494     prog++;
 495   if (!*prog)
 496     {
 497       op_token = 0;
 498       return 0;
 499     }
 500
 501   if (*prog == '=')
 502     op_token = *prog++;
 503   else
 504     {
 505       ds_clear (&op_tokstr);
 506
 507       if (*prog == '\'' || *prog == '"')
 508         {
 509           int quote = *prog++;
 510
 511           while (*prog && *prog != quote)
 512             {
 513               if (*prog != '\\')
 514                 ds_putchar (&op_tokstr, *prog++);
 515               else
 516                 {
 517                   int c;
 518
 519                   prog++;
 520                   assert ((int) *prog); /* How could a line end in `\'? */
 521                   switch (*prog++)
 522                     {
 523                     case '\'':
 524                       c = '\'';
 525                       break;
 526                     case '"':
 527                       c = '"';
 528                       break;
 529                     case '?':
 530                       c = '?';
 531                       break;
 532                     case '\\':
 533                       c = '\\';
 534                       break;
 535                     case '}':
 536                       c = '}';
 537                       break;
 538                     case 'a':
 539                       c = '\a';
 540                       break;
 541                     case 'b':
 542                       c = '\b';
 543                       break;
 544                     case 'f':
 545                       c = '\f';
 546                       break;
 547                     case 'n':
 548                       c = '\n';
 549                       break;
 550                     case 'r':
 551                       c = '\r';
 552                       break;
 553                     case 't':
 554                       c = '\t';
 555                       break;
 556                     case 'v':
 557                       c = '\v';
 558                       break;
 559                     case '0':
 560                     case '1':
 561                     case '2':
 562                     case '3':
 563                     case '4':
 564                     case '5':
 565                     case '6':
 566                     case '7':
 567                       {
 568                         c = prog[-1] - '0';
 569                         while (*prog >= '0' && *prog <= '7')
 570                           c = c * 8 + *prog++ - '0';
 571                       }
 572                       break;
 573                     case 'x':
 574                     case 'X':
 575                       {
 576                         c = 0;
 577                         while (isxdigit ((unsigned char) *prog))
 578                           {
 579                             c *= 16;
 580                             if (isdigit ((unsigned char) *prog))
 581                               c += *prog - '0';
 582                             else
 583                               c += (tolower ((unsigned char) (*prog))
 584                                     - 'a' + 10);
 585                             prog++;
 586                           }
 587                       }
 588                       break;
 589                     default:
 590                       msg (IS, _("Syntax error in string constant."));
 591                       continue;
 592                     }
 593                   ds_putchar (&op_tokstr, (unsigned char) c);
 594                 }
 595             }
 596           prog++;
 597         }
 598       else
 599         while (*prog && !isspace ((unsigned char) *prog) && *prog != '=')
 600           ds_putchar (&op_tokstr, *prog++);
 601       op_token = 'a';
 602     }
 603
 604   return 1;
 605 }
 606
 607 /* Applies the user-specified options in string S to output driver D
 608    (at configuration time). */
 609 static void
 610 parse_options (char *s, struct outp_driver * d)
 611 {
 612   prog = s;
 613   op_token = -1;
 614
 615   ds_init (NULL, &op_tokstr, 64);
 616   while (tokener ())
 617     {
 618       char key[65];
 619
 620       if (op_token != 'a')
 621         {
 622           msg (IS, _("Syntax error in options."));
 623           break;
 624         }
 625
 626       ds_truncate (&op_tokstr, 64);
 627       strcpy (key, ds_value (&op_tokstr));
 628
 629       tokener ();
 630       if (op_token != '=')
 631         {
 632           msg (IS, _("Syntax error in options (`=' expected)."));
 633           break;
 634         }
 635
 636       tokener ();
 637       if (op_token != 'a')
 638         {
 639           msg (IS, _("Syntax error in options (value expected after `=')."));
 640           break;
 641         }
 642       d->class->option (d, key, &op_tokstr);
 643     }
 644   ds_destroy (&op_tokstr);
 645 }
 646
 647 /* Find the driver in outp_driver_list with name NAME. */
 648 static struct outp_driver *
 649 find_driver (char *name)
 650 {
 651   struct outp_driver *d;
 652
 653 #if GLOBAL_DEBUGGING
 654   if (iterating_driver_list)
 655     reentrancy ();
 656 #endif
 657   for (d = outp_driver_list; d; d = d->next)
 658     if (!strcmp (d->name, name))
 659       return d;
 660   return NULL;
 661 }
 662
 663 /* Tokenize string S into colon-separated fields, removing leading and
 664    trailing whitespace on tokens.  Returns a pointer to the
 665    null-terminated token, which is formed by setting a NUL character
 666    into the string.  After the first call, subsequent calls should set
 667    S to NULL.  CP should be consistent across calls.  Returns NULL
 668    after all fields have been used up.
 669
 670    FIXME: Should ignore colons inside double quotes. */
 671 static char *
 672 colon_tokenize (char *s, char **cp)
 673 {
 674   char *token;
 675
 676   if (!s)
 677     {
 678       s = *cp;
 679       if (*s == 0)
 680         return NULL;
 681     }
 682   token = s += strspn (s, " \t\v\r");
 683   *cp = strchr (s, ':');
 684   if (*cp == NULL)
 685     s = *cp = strchr (s, 0);
 686   else
 687     s = (*cp)++;
 688   while (s > token && strchr (" \t\v\r", s[-1]))
 689     s--;
 690   *s = 0;
 691   return token;
 692 }
 693
 694 /* String S is in format:
 695    DRIVERNAME:CLASSNAME:DEVICETYPE:OPTIONS
 696    Adds a driver to outp_driver_list pursuant to the specification
 697    provided.  */
 698 static void
 699 configure_driver (char *s)
 700 {
 701   char *token, *cp;
 702   struct outp_driver *d = NULL, *iter;
 703   struct outp_driver_class_list *c = NULL;
 704
 705   s = fn_interp_vars (s, find_defn_value);
 706
 707   /* Driver name. */
 708   token = colon_tokenize (s, &cp);
 709   if (!token)
 710     {
 711       msg (IS, _("Driver name expected."));
 712       goto error;
 713     }
 714
 715   d = xmalloc (sizeof *d);
 716
 717   d->class = NULL;
 718   d->name = xstrdup (token);
 719   d->driver_open = 0;
 720   d->page_open = 0;
 721
 722   d->next = d->prev = NULL;
 723
 724   d->device = OUTP_DEV_NONE;
 725
 726   d->ext = NULL;
 727
 728   /* Class name. */
 729   token = colon_tokenize (NULL, &cp);
 730   if (!token)
 731     {
 732       msg (IS, _("Class name expected."));
 733       goto error;
 734     }
 735
 736   for (c = outp_class_list; c; c = c->next)
 737     if (!strcmp (c->class->name, token))
 738       break;
 739   if (!c)
 740     {
 741       msg (IS, _("Unknown output driver class `%s'."), token);
 742       goto error;
 743     }
 744
 745   d->class = c->class;
 746   if (!c->ref_count && !d->class->open_global (d->class))
 747     {
 748       msg (IS, _("Can't initialize output driver class `%s'."),
 749            d->class->name);
 750       goto error;
 751     }
 752   c->ref_count++;
 753   if (!d->class->preopen_driver (d))
 754     {
 755       msg (IS, _("Can't initialize output driver `%s' of class `%s'."),
 756            d->name, d->class->name);
 757       goto error;
 758     }
 759
 760   /* Device types. */
 761   token = colon_tokenize (NULL, &cp);
 762   if (token)
 763     {
 764       char *sp, *type;
 765
 766       for (type = strtok_r (token, " \t\r\v", &sp); type;
 767            type = strtok_r (NULL, " \t\r\v", &sp))
 768         {
 769           if (!strcmp (type, "listing"))
 770             d->device |= OUTP_DEV_LISTING;
 771           else if (!strcmp (type, "screen"))
 772             d->device |= OUTP_DEV_SCREEN;
 773           else if (!strcmp (type, "printer"))
 774             d->device |= OUTP_DEV_PRINTER;
 775           else
 776             {
 777               msg (IS, _("Unknown device type `%s'."), type);
 778               goto error;
 779             }
 780         }
 781     }
 782
 783   /* Options. */
 784   token = colon_tokenize (NULL, &cp);
 785   if (token)
 786     parse_options (token, d);
 787   if (!d->class->postopen_driver (d))
 788     {
 789       msg (IS, _("Can't complete initialization of output driver `%s' of "
 790            "class `%s'."), d->name, d->class->name);
 791       goto error;
 792     }
 793
 794   /* Find like-named driver and delete. */
 795   iter = find_driver (d->name);
 796   if (iter)
 797     destroy_driver (iter);
 798
 799   /* Add to list. */
 800   d->next = outp_driver_list;
 801   d->prev = NULL;
 802   if (outp_driver_list)
 803     outp_driver_list->prev = d;
 804   outp_driver_list = d;
 805   goto exit;
 806
 807 error:
 808   if (d)
 809     destroy_driver (d);
 810 exit:
 811   free (s);
 812 }
 813
 814 /* Destroys output driver D. */
 815 static void
 816 destroy_driver (struct outp_driver *d)
 817 {
 818   if (d->page_open)
 819     d->class->close_page (d);
 820   if (d->class)
 821     {
 822       struct outp_driver_class_list *c;
 823
 824       if (d->driver_open)
 825         d->class->close_driver (d);
 826
 827       for (c = outp_class_list; c; c = c->next)
 828         if (c->class == d->class)
 829           break;
 830       assert (c != NULL);
 831
 832       c->ref_count--;
 833       if (c->ref_count == 0)
 834         {
 835           if (!d->class->close_global (d->class))
 836             msg (IS, _("Can't deinitialize output driver class `%s'."),
 837                  d->class->name);
 838         }
 839     }
 840   free (d->name);
 841
 842   /* Remove this driver from the global driver list. */
 843   if (d->prev)
 844     d->prev->next = d->next;
 845   if (d->next)
 846     d->next->prev = d->prev;
 847   if (d == outp_driver_list)
 848     outp_driver_list = d->next;
 849 }
 850
 851 static int
 852 option_cmp (const void *a, const void *b)
 853 {
 854   const struct outp_option *o1 = a;
 855   const struct outp_option *o2 = b;
 856   return strcmp (o1->keyword, o2->keyword);
 857 }
 858
 859 /* Tries to match S as one of the keywords in TAB, with corresponding
 860    information structure INFO.  Returns category code or 0 on failure;
 861    if category code is negative then stores subcategory in *SUBCAT. */
 862 int
 863 outp_match_keyword (const char *s, struct outp_option *tab,
 864                     struct outp_option_info *info, int *subcat)
 865 {
 866   char *cp;
 867   struct outp_option *oip;
 868
 869   /* Form hash table. */
 870   if (NULL == info->initial)
 871     {
 872       /* Count items. */
 873       int count, i;
 874       char s[256], *cp;
 875       struct outp_option *ptr[255], **oip;
 876
 877       for (count = 0; tab[count].keyword[0]; count++)
 878         ;
 879
 880       /* Sort items. */
 881       qsort (tab, count, sizeof *tab, option_cmp);
 882
 883       cp = s;
 884       oip = ptr;
 885       *cp = tab[0].keyword[0];
 886       *oip++ = &tab[0];
 887       for (i = 0; i < count; i++)
 888         if (tab[i].keyword[0] != *cp)
 889           {
 890             *++cp = tab[i].keyword[0];
 891             *oip++ = &tab[i];
 892           }
 893       *++cp = 0;
 894
 895       info->initial = xstrdup (s);
 896       info->options = xmalloc (sizeof *info->options * (cp - s));
 897       memcpy (info->options, ptr, sizeof *info->options * (cp - s));
 898     }
 899
 900   cp = info->initial;
 901   oip = *info->options;
 902
 903   if (s[0] == 0)
 904     return 0;
 905   cp = strchr (info->initial, s[0]);
 906   if (!cp)
 907     return 0;
 908 #if 0
 909   printf (_("Trying to find keyword `%s'...\n"), s);
 910 #endif
 911   oip = info->options[cp - info->initial];
 912   while (oip->keyword[0] == s[0])
 913     {
 914 #if 0
 915       printf ("- %s\n", oip->keyword);
 916 #endif
 917       if (!strcmp (s, oip->keyword))
 918         {
 919           if (oip->cat < 0)
 920             *subcat = oip->subcat;
 921           return oip->cat;
 922         }
 923       oip++;
 924     }
 925
 926   return 0;
 927 }
 928
 929 /* Encapsulate two characters in a single int. */
 930 #define TWO_CHARS(A, B)                         \
 931         ((A) + ((B)<<8))
 932
 933 /* Determines the size of a dimensional measurement and returns the
 934    size in units of 1/72000".  Units if not specified explicitly are
 935    inches for values under 50, millimeters otherwise.  Returns 0,
 936    stores NULL to *TAIL on error; otherwise returns dimension, stores
 937    address of next */
 938 int
 939 outp_evaluate_dimension (char *dimen, char **tail)
 940 {
 941   char *s = dimen;
 942   char *ptail;
 943   double value;
 944
 945   value = strtod (s, &ptail);
 946   if (ptail == s)
 947     goto lossage;
 948   if (*ptail == '-')
 949     {
 950       double b, c;
 951       s = &ptail[1];
 952       b = strtod (s, &ptail);
 953       if (b <= 0.0 || ptail == s)
 954         goto lossage;
 955       if (*ptail != '/')
 956         goto lossage;
 957       s = &ptail[1];
 958       c = strtod (s, &ptail);
 959       if (c <= 0.0 || ptail == s)
 960         goto lossage;
 961       s = ptail;
 962       if (c == 0.0)
 963         goto lossage;
 964       if (value > 0)
 965         value += b / c;
 966       else
 967         value -= b / c;
 968     }
 969   else if (*ptail == '/')
 970     {
 971       double b;
 972       s = &ptail[1];
 973       b = strtod (s, &ptail);
 974       if (b <= 0.0 || ptail == s)
 975         goto lossage;
 976       s = ptail;
 977       value /= b;
 978     }
 979   else
 980     s = ptail;
 981   if (*s == 0 || isspace ((unsigned char) *s))
 982     {
 983       if (value < 50.0)
 984         value *= 72000;
 985       else
 986         value *= 72000 / 25.4;
 987     }
 988   else
 989     {
 990       double factor;
 991
 992       /* Standard TeX units are supported. */
 993       if (*s == '"')
 994         factor = 72000, s++;
 995       else
 996         switch (TWO_CHARS (s[0], s[1]))
 997           {
 998           case TWO_CHARS ('p', 't'):
 999             factor = 72000 / 72.27;
1000             break;
1001           case TWO_CHARS ('p', 'c'):
1002             factor = 72000 / 72.27 * 12.0;
1003             break;
1004           case TWO_CHARS ('i', 'n'):
1005             factor = 72000;
1006             break;
1007           case TWO_CHARS ('b', 'p'):
1008             factor = 72000 / 72.0;
1009             break;
1010           case TWO_CHARS ('c', 'm'):
1011             factor = 72000 / 2.54;
1012             break;
1013           case TWO_CHARS ('m', 'm'):
1014             factor = 72000 / 25.4;
1015             break;
1016           case TWO_CHARS ('d', 'd'):
1017             factor = 72000 / 72.27 * 1.0700086;
1018             break;
1019           case TWO_CHARS ('c', 'c'):
1020             factor = 72000 / 72.27 * 12.840104;
1021             break;
1022           case TWO_CHARS ('s', 'p'):
1023             factor = 72000 / 72.27 / 65536.0;
1024             break;
1025           default:
1026             msg (SE, _("Unit \"%s\" is unknown in dimension \"%s\"."), s, dimen);
1027             *tail = NULL;
1028             return 0;
1029           }
1030       ptail += 2;
1031       value *= factor;
1032     }
1033   if (value <= 0.0)
1034     goto lossage;
1035   if (tail)
1036     *tail = ptail;
1037   return value + 0.5;
1038
1039 lossage:
1040   *tail = NULL;
1041   msg (SE, _("Bad dimension \"%s\"."), dimen);
1042   return 0;
1043 }
1044
1045 /* Stores the dimensions in 1/72000" units of paper identified by
1046    SIZE, which is of form `HORZ x VERT' or `HORZ by VERT' where each
1047    of HORZ and VERT are dimensions, into *H and *V.  Return nonzero on
1048    success. */
1049 static int
1050 internal_get_paper_size (char *size, int *h, int *v)
1051 {
1052   char *tail;
1053
1054   while (isspace ((unsigned char) *size))
1055     size++;
1056   *h = outp_evaluate_dimension (size, &tail);
1057   if (tail == NULL)
1058     return 0;
1059   while (isspace ((unsigned char) *tail))
1060     tail++;
1061   if (*tail == 'x')
1062     tail++;
1063   else if (*tail == 'b' && tail[1] == 'y')
1064     tail += 2;
1065   else
1066     {
1067       msg (SE, _("`x' expected in paper size `%s'."), size);
1068       return 0;
1069     }
1070   *v = outp_evaluate_dimension (tail, &tail);
1071   if (tail == NULL)
1072     return 0;
1073   while (isspace ((unsigned char) *tail))
1074     tail++;
1075   if (*tail)
1076     {
1077       msg (SE, _("Trailing garbage `%s' on paper size `%s'."), tail, size);
1078       return 0;
1079     }
1080
1081   return 1;
1082 }
1083
1084 /* Stores the dimensions, in 1/72000" units, of paper identified by
1085    SIZE into *H and *V.  SIZE may be a pair of dimensions of form `H x
1086    V', or it may be a case-insensitive paper identifier, which is
1087    looked up in the `papersize' configuration file.  Returns nonzero
1088    on success.  May modify SIZE. */
1089 /* Don't read further unless you've got a strong stomach. */
1090 int
1091 outp_get_paper_size (char *size, int *h, int *v)
1092 {
1093   struct paper_size
1094     {
1095       char *name;
1096       int use;
1097       int h, v;
1098     };
1099
1100   static struct paper_size cache[4];
1101   static int use;
1102
1103   FILE *f;
1104   char *pprsz_fn;
1105
1106   struct string line;
1107   struct file_locator where;
1108
1109   int free_it = 0;
1110   int result = 0;
1111   int min_value, min_index;
1112   char *ep;
1113   int i;
1114
1115   while (isspace ((unsigned char) *size))
1116     size++;
1117   if (isdigit ((unsigned char) *size))
1118     return internal_get_paper_size (size, h, v);
1119   ep = size;
1120   while (*ep)
1121     ep++;
1122   while (isspace ((unsigned char) *ep) && ep >= size)
1123     ep--;
1124   if (ep == size)
1125     {
1126       msg (SE, _("Paper size name must not be empty."));
1127       return 0;
1128     }
1129
1130   ep++;
1131   if (*ep)
1132     *ep = 0;
1133
1134   use++;
1135   for (i = 0; i < 4; i++)
1136     if (cache[i].name != NULL && !strcasecmp (cache[i].name, size))
1137       {
1138         *h = cache[i].h;
1139         *v = cache[i].v;
1140         cache[i].use = use;
1141         return 1;
1142       }
1143
1144   pprsz_fn = fn_search_path (fn_getenv_default ("STAT_OUTPUT_PAPERSIZE_FILE",
1145                                                 "papersize"),
1146                              fn_getenv_default ("STAT_OUTPUT_INIT_PATH",
1147                                                 config_path),
1148                              NULL);
1149
1150   where.filename = pprsz_fn;
1151   where.line_number = 0;
1152   err_push_file_locator (&where);
1153   ds_init (NULL, &line, 128);
1154
1155   if (pprsz_fn == NULL)
1156     {
1157       msg (IE, _("Cannot find `papersize' configuration file."));
1158       goto exit;
1159     }
1160
1161   msg (VM (1), _("%s: Opening paper size definition file..."), pprsz_fn);
1162   f = fopen (pprsz_fn, "r");
1163   if (!f)
1164     {
1165       msg (IE, _("Opening %s: %s."), pprsz_fn, strerror (errno));
1166       goto exit;
1167     }
1168
1169   for (;;)
1170     {
1171       char *cp, *bp, *ep;
1172
1173       if (!ds_get_config_line (f, &line, &where))
1174         {
1175           if (ferror (f))
1176             msg (ME, _("Reading %s: %s."), pprsz_fn, strerror (errno));
1177           break;
1178         }
1179       for (cp = ds_value (&line); isspace ((unsigned char) *cp); cp++);
1180       if (*cp == 0)
1181         continue;
1182       if (*cp != '"')
1183         goto lex_error;
1184       for (bp = ep = cp + 1; *ep && *ep != '"'; ep++);
1185       if (!*ep)
1186         goto lex_error;
1187       *ep = 0;
1188       if (0 != strcasecmp (bp, size))
1189         continue;
1190
1191       for (cp = ep + 1; isspace ((unsigned char) *cp); cp++);
1192       if (*cp == '=')
1193         {
1194           size = xmalloc (ep - bp + 1);
1195           strcpy (size, bp);
1196           free_it = 1;
1197           continue;
1198         }
1199       size = &ep[1];
1200       break;
1201
1202     lex_error:
1203       msg (IE, _("Syntax error in paper size definition."));
1204     }
1205
1206   /* We found the one we want! */
1207   result = internal_get_paper_size (size, h, v);
1208   if (result)
1209     {
1210       min_value = cache[0].use;
1211       min_index = 0;
1212       for (i = 1; i < 4; i++)
1213         if (cache[0].use < min_value)
1214           {
1215             min_value = cache[i].use;
1216             min_index = i;
1217           }
1218       free (cache[min_index].name);
1219       cache[min_index].name = xstrdup (size);
1220       cache[min_index].use = use;
1221       cache[min_index].h = *h;
1222       cache[min_index].v = *v;
1223     }
1224
1225 exit:
1226   err_pop_file_locator (&where);
1227   ds_destroy (&line);
1228   if (free_it)
1229     free (size);
1230
1231   if (result)
1232     msg (VM (2), _("Paper size definition file read successfully."));
1233   else
1234     msg (VM (1), _("Error reading paper size definition file."));
1235
1236   return result;
1237 }
1238
1239 /* If D is NULL, returns the first enabled driver if any, NULL if
1240    none.  Otherwise D must be the last driver returned by this
1241    function, in which case the next enabled driver is returned or NULL
1242    if that was the last. */
1243 struct outp_driver *
1244 outp_drivers (struct outp_driver *d)
1245 {
1246 #if GLOBAL_DEBUGGING
1247   struct outp_driver *orig_d = d;
1248 #endif
1249
1250   for (;;)
1251     {
1252       if (d == NULL)
1253         d = outp_driver_list;
1254       else
1255         d = d->next;
1256
1257       if (d == NULL
1258           || (d->driver_open
1259               && (d->device == 0
1260                   || (d->device & disabled_devices) != d->device)))
1261         break;
1262     }
1263
1264 #if GLOBAL_DEBUGGING
1265   if (d && !orig_d)
1266     {
1267       if (iterating_driver_list++)
1268         reentrancy ();
1269     }
1270   else if (orig_d && !d)
1271     {
1272       assert (iterating_driver_list == 1);
1273       iterating_driver_list = 0;
1274     }
1275 #endif
1276
1277   return d;
1278 }
1279
1280 /* Enables (if ENABLE is nonzero) or disables (if ENABLE is zero) the
1281    device(s) given in mask DEVICE. */
1282 void
1283 outp_enable_device (int enable, int device)
1284 {
1285   if (enable)
1286     disabled_devices &= ~device;
1287   else
1288     disabled_devices |= device;
1289 }
1290
1291 /* Ejects the paper on device D, if the page is not blank. */
1292 int
1293 outp_eject_page (struct outp_driver *d)
1294 {
1295   if (d->page_open == 0)
1296     return 1;
1297
1298   if (d->cp_y != 0)
1299     {
1300       d->cp_x = d->cp_y = 0;
1301
1302       if (d->class->close_page (d) == 0)
1303         msg (ME, _("Error closing page on %s device of %s class."),
1304              d->name, d->class->name);
1305       if (d->class->open_page (d) == 0)
1306         {
1307           msg (ME, _("Error opening page on %s device of %s class."),
1308                d->name, d->class->name);
1309           return 0;
1310         }
1311     }
1312   return 1;
1313 }
1314
1315 /* Returns the width of string S, in device units, when output on
1316    device D. */
1317 int
1318 outp_string_width (struct outp_driver *d, const char *s)
1319 {
1320   struct outp_text text;
1321
1322   text.options = OUTP_T_JUST_LEFT;
1323   ls_init (&text.s, (char *) s, strlen (s));
1324   d->class->text_metrics (d, &text);
1325
1326   return text.h;
1327 }