src/language/data-io/print.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2006 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 <stdlib.h>
  20
  21 #include <data/case.h>
  22 #include <data/data-out.h>
  23 #include <data/procedure.h>
  24 #include <data/transformations.h>
  25 #include <data/variable.h>
  26 #include <language/command.h>
  27 #include <language/data-io/data-writer.h>
  28 #include <language/data-io/file-handle.h>
  29 #include <language/data-io/placement-parser.h>
  30 #include <language/lexer/format-parser.h>
  31 #include <language/lexer/lexer.h>
  32 #include <language/lexer/variable-parser.h>
  33 #include <libpspp/assertion.h>
  34 #include <libpspp/compiler.h>
  35 #include <libpspp/ll.h>
  36 #include <libpspp/message.h>
  37 #include <libpspp/misc.h>
  38 #include <libpspp/pool.h>
  39 #include <output/manager.h>
  40 #include <output/table.h>
  41
  42 #include "xalloc.h"
  43
  44 #include "gettext.h"
  45 #define _(msgid) gettext (msgid)
  46
  47 /* Describes what to do when an output field is encountered. */
  48 enum field_type
  49   {
  50     PRT_LITERAL,                /* Literal string. */
  51     PRT_VAR                     /* Variable. */
  52   };
  53
  54 /* Describes how to output one field. */
  55 struct prt_out_spec
  56   {
  57     /* All fields. */
  58     struct ll ll;               /* In struct print_trns `specs' list. */
  59     enum field_type type;       /* What type of field this is. */
  60     int record;                 /* 1-based record number. */
  61     int first_column;           /* 0-based first column. */
  62
  63     /* PRT_VAR only. */
  64     const struct variable *var; /* Associated variable. */
  65     struct fmt_spec format;     /* Output spec. */
  66     bool add_space;             /* Add trailing space? */
  67     bool sysmis_as_spaces;      /* Output SYSMIS as spaces? */
  68
  69     /* PRT_LITERAL only. */
  70     struct string string;       /* String to output. */
  71   };
  72
  73 static inline struct prt_out_spec *
  74 ll_to_prt_out_spec (struct ll *ll)
  75 {
  76   return ll_data (ll, struct prt_out_spec, ll);
  77 }
  78
  79 /* PRINT, PRINT EJECT, WRITE private data structure. */
  80 struct print_trns
  81   {
  82     struct pool *pool;          /* Stores related data. */
  83     bool eject;                 /* Eject page before printing? */
  84     bool include_prefix;        /* Prefix lines with space? */
  85     struct dfm_writer *writer;  /* Output file, NULL=listing file. */
  86     struct ll_list specs;       /* List of struct prt_out_specs. */
  87     size_t record_cnt;          /* Number of records to write. */
  88     struct string line;         /* Output buffer. */
  89   };
  90
  91 enum which_formats
  92   {
  93     PRINT,
  94     WRITE
  95   };
  96
  97 static int internal_cmd_print (struct lexer *, struct dataset *ds,
  98                                enum which_formats, bool eject);
  99 static trns_proc_func print_trns_proc;
 100 static trns_free_func print_trns_free;
 101 static bool parse_specs (struct lexer *, struct pool *tmp_pool, struct print_trns *,
 102                          struct dictionary *dict, enum which_formats);
 103 static void dump_table (struct print_trns *, const struct file_handle *);
 104 \f
 105 /* Basic parsing. */
 106
 107 /* Parses PRINT command. */
 108 int
 109 cmd_print (struct lexer *lexer, struct dataset *ds)
 110 {
 111   return internal_cmd_print (lexer, ds, PRINT, false);
 112 }
 113
 114 /* Parses PRINT EJECT command. */
 115 int
 116 cmd_print_eject (struct lexer *lexer, struct dataset *ds)
 117 {
 118   return internal_cmd_print (lexer, ds, PRINT, true);
 119 }
 120
 121 /* Parses WRITE command. */
 122 int
 123 cmd_write (struct lexer *lexer, struct dataset *ds)
 124 {
 125   return internal_cmd_print (lexer, ds, WRITE, false);
 126 }
 127
 128 /* Parses the output commands. */
 129 static int
 130 internal_cmd_print (struct lexer *lexer, struct dataset *ds,
 131                     enum which_formats which_formats, bool eject)
 132 {
 133   bool print_table = 0;
 134   struct print_trns *trns;
 135   struct file_handle *fh = NULL;
 136   struct pool *tmp_pool;
 137
 138   /* Fill in prt to facilitate error-handling. */
 139   trns = pool_create_container (struct print_trns, pool);
 140   trns->eject = eject;
 141   trns->writer = NULL;
 142   trns->record_cnt = 0;
 143   ll_init (&trns->specs);
 144   ds_init_empty (&trns->line);
 145   ds_register_pool (&trns->line, trns->pool);
 146
 147   tmp_pool = pool_create_subpool (trns->pool);
 148
 149   /* Parse the command options. */
 150   while (lex_token (lexer) != '/' && lex_token (lexer) != '.')
 151     {
 152       if (lex_match_id (lexer, "OUTFILE"))
 153         {
 154           lex_match (lexer, '=');
 155
 156           fh = fh_parse (lexer, FH_REF_FILE);
 157           if (fh == NULL)
 158             goto error;
 159         }
 160       else if (lex_match_id (lexer, "RECORDS"))
 161         {
 162           lex_match (lexer, '=');
 163           lex_match (lexer, '(');
 164           if (!lex_force_int (lexer))
 165             goto error;
 166           trns->record_cnt = lex_integer (lexer);
 167           lex_get (lexer);
 168           lex_match (lexer, ')');
 169         }
 170       else if (lex_match_id (lexer, "TABLE"))
 171         print_table = true;
 172       else if (lex_match_id (lexer, "NOTABLE"))
 173         print_table = false;
 174       else
 175         {
 176           lex_error (lexer, _("expecting a valid subcommand"));
 177           goto error;
 178         }
 179     }
 180
 181   /* When PRINT or PRINT EJECT writes to an external file, we
 182      prefix each line with a space for compatibility. */
 183   trns->include_prefix = which_formats == PRINT && fh != NULL;
 184
 185   /* Parse variables and strings. */
 186   if (!parse_specs (lexer, tmp_pool, trns, dataset_dict (ds), which_formats))
 187     goto error;
 188
 189   if (lex_end_of_command (lexer) != CMD_SUCCESS)
 190     goto error;
 191
 192   if (fh != NULL)
 193     {
 194       trns->writer = dfm_open_writer (fh);
 195       if (trns->writer == NULL)
 196         goto error;
 197     }
 198
 199   /* Output the variable table if requested. */
 200   if (print_table)
 201     dump_table (trns, fh);
 202
 203   /* Put the transformation in the queue. */
 204   add_transformation (ds, print_trns_proc, print_trns_free, trns);
 205
 206   pool_destroy (tmp_pool);
 207   fh_unref (fh);
 208
 209   return CMD_SUCCESS;
 210
 211  error:
 212   print_trns_free (trns);
 213   fh_unref (fh);
 214   return CMD_FAILURE;
 215 }
 216 \f
 217 static bool parse_string_argument (struct lexer *, struct print_trns *,
 218                                    int record, int *column);
 219 static bool parse_variable_argument (struct lexer *, const struct dictionary *,
 220                                      struct print_trns *,
 221                                      struct pool *tmp_pool,
 222                                      int *record, int *column,
 223                                      enum which_formats);
 224
 225 /* Parses all the variable and string specifications on a single
 226    PRINT, PRINT EJECT, or WRITE command into the prt structure.
 227    Returns success. */
 228 static bool
 229 parse_specs (struct lexer *lexer, struct pool *tmp_pool, struct print_trns *trns,
 230              struct dictionary *dict,
 231              enum which_formats which_formats)
 232 {
 233   int record = 0;
 234   int column = 1;
 235
 236   if (lex_token (lexer) == '.')
 237     {
 238       trns->record_cnt = 1;
 239       return true;
 240     }
 241
 242   while (lex_token (lexer) != '.')
 243     {
 244       bool ok;
 245
 246       if (!parse_record_placement (lexer, &record, &column))
 247         return false;
 248
 249       if (lex_token (lexer) == T_STRING)
 250         ok = parse_string_argument (lexer, trns, record, &column);
 251       else
 252         ok = parse_variable_argument (lexer, dict, trns, tmp_pool, &record, &column,
 253                                       which_formats);
 254       if (!ok)
 255         return 0;
 256
 257       lex_match (lexer, ',');
 258     }
 259
 260   if (trns->record_cnt != 0 && trns->record_cnt != record)
 261     msg (SW, _("Output calls for %d records but %zu specified on RECORDS "
 262                "subcommand."),
 263          record, trns->record_cnt);
 264   trns->record_cnt = record;
 265
 266   return true;
 267 }
 268
 269 /* Parses a string argument to the PRINT commands.  Returns success. */
 270 static bool
 271 parse_string_argument (struct lexer *lexer, struct print_trns *trns, int record, int *column)
 272 {
 273   struct prt_out_spec *spec = pool_alloc (trns->pool, sizeof *spec);
 274   spec->type = PRT_LITERAL;
 275   spec->record = record;
 276   spec->first_column = *column;
 277   ds_init_string (&spec->string, lex_tokstr (lexer));
 278   ds_register_pool (&spec->string, trns->pool);
 279   lex_get (lexer);
 280
 281   /* Parse the included column range. */
 282   if (lex_is_number (lexer))
 283     {
 284       int first_column, last_column;
 285       bool range_specified;
 286
 287       if (!parse_column_range (lexer, &first_column, &last_column, &range_specified))
 288         return false;
 289
 290       spec->first_column = first_column;
 291       if (range_specified)
 292         ds_set_length (&spec->string, last_column - first_column + 1, ' ');
 293     }
 294   *column = spec->first_column + ds_length (&spec->string);
 295
 296   ll_push_tail (&trns->specs, &spec->ll);
 297   return true;
 298 }
 299
 300 /* Parses a variable argument to the PRINT commands by passing it off
 301    to fixed_parse_compatible() or fixed_parse_fortran() as appropriate.
 302    Returns success. */
 303 static bool
 304 parse_variable_argument (struct lexer *lexer, const struct dictionary *dict,
 305                          struct print_trns *trns, struct pool *tmp_pool,
 306                          int *record, int *column,
 307                          enum which_formats which_formats)
 308 {
 309   const struct variable **vars;
 310   size_t var_cnt, var_idx;
 311   struct fmt_spec *formats, *f;
 312   size_t format_cnt;
 313   bool add_space;
 314
 315   if (!parse_variables_const_pool (lexer, tmp_pool, dict,
 316                              &vars, &var_cnt, PV_DUPLICATE))
 317     return false;
 318
 319   if (lex_is_number (lexer) || lex_token (lexer) == '(')
 320     {
 321       if (!parse_var_placements (lexer, tmp_pool, var_cnt, false,
 322                                  &formats, &format_cnt))
 323         return false;
 324       add_space = false;
 325     }
 326   else
 327     {
 328       size_t i;
 329
 330       lex_match (lexer, '*');
 331
 332       formats = pool_nmalloc (tmp_pool, var_cnt, sizeof *formats);
 333       format_cnt = var_cnt;
 334       for (i = 0; i < var_cnt; i++)
 335         {
 336           const struct variable *v = vars[i];
 337           formats[i] = (which_formats == PRINT
 338                         ? *var_get_print_format (v)
 339                         : *var_get_write_format (v));
 340         }
 341       add_space = which_formats == PRINT;
 342     }
 343
 344   var_idx = 0;
 345   for (f = formats; f < &formats[format_cnt]; f++)
 346     if (!execute_placement_format (f, record, column))
 347       {
 348         const struct variable *var;
 349         struct prt_out_spec *spec;
 350
 351         var = vars[var_idx++];
 352         if (!fmt_check_width_compat (f, var_get_width (var)))
 353           return false;
 354
 355         spec = pool_alloc (trns->pool, sizeof *spec);
 356         spec->type = PRT_VAR;
 357         spec->record = *record;
 358         spec->first_column = *column;
 359         spec->var = var;
 360         spec->format = *f;
 361         spec->add_space = add_space;
 362
 363         /* This is a completely bizarre twist for compatibility:
 364            WRITE outputs the system-missing value as a field
 365            filled with spaces, instead of using the normal format
 366            that usually contains a period. */
 367         spec->sysmis_as_spaces = (which_formats == WRITE
 368                                   && var_is_numeric (var)
 369                                   && (fmt_get_category (spec->format.type)
 370                                       != FMT_CAT_BINARY));
 371
 372         ll_push_tail (&trns->specs, &spec->ll);
 373
 374         *column += f->w + add_space;
 375       }
 376   assert (var_idx == var_cnt);
 377
 378   return true;
 379 }
 380
 381 /* Prints the table produced by the TABLE subcommand to the listing
 382    file. */
 383 static void
 384 dump_table (struct print_trns *trns, const struct file_handle *fh)
 385 {
 386   struct prt_out_spec *spec;
 387   struct tab_table *t;
 388   int spec_cnt;
 389   int row;
 390
 391   spec_cnt = ll_count (&trns->specs);
 392   t = tab_create (4, spec_cnt + 1, 0);
 393   tab_columns (t, TAB_COL_DOWN, 1);
 394   tab_box (t, TAL_1, TAL_1, TAL_0, TAL_1, 0, 0, 3, spec_cnt);
 395   tab_hline (t, TAL_2, 0, 3, 1);
 396   tab_headers (t, 0, 0, 1, 0);
 397   tab_text (t, 0, 0, TAB_CENTER | TAT_TITLE, _("Variable"));
 398   tab_text (t, 1, 0, TAB_CENTER | TAT_TITLE, _("Record"));
 399   tab_text (t, 2, 0, TAB_CENTER | TAT_TITLE, _("Columns"));
 400   tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Format"));
 401   tab_dim (t, tab_natural_dimensions);
 402   row = 1;
 403   ll_for_each (spec, struct prt_out_spec, ll, &trns->specs)
 404     {
 405       char fmt_string[FMT_STRING_LEN_MAX + 1];
 406       int width;
 407       switch (spec->type)
 408         {
 409         case PRT_LITERAL:
 410           tab_text (t, 0, row, TAB_LEFT | TAB_FIX | TAT_PRINTF, "\"%.*s\"",
 411                     (int) ds_length (&spec->string), ds_data (&spec->string));
 412           width = ds_length (&spec->string);
 413           break;
 414         case PRT_VAR:
 415           tab_text (t, 0, row, TAB_LEFT, var_get_name (spec->var));
 416           tab_text (t, 3, row, TAB_LEFT | TAB_FIX,
 417                     fmt_to_string (&spec->format, fmt_string));
 418           width = spec->format.w;
 419           break;
 420         default:
 421           NOT_REACHED ();
 422         }
 423       tab_text (t, 1, row, TAT_PRINTF, "%d", spec->record);
 424       tab_text (t, 2, row, TAT_PRINTF, "%3d-%3d",
 425                 spec->first_column, spec->first_column + width - 1);
 426       row++;
 427     }
 428
 429   if (fh != NULL)
 430     tab_title (t, ngettext ("Writing %d record to %s.",
 431                             "Writing %d records to %s.", trns->record_cnt),
 432                trns->record_cnt, fh_get_name (fh));
 433   else
 434     tab_title (t, ngettext ("Writing %d record.",
 435                             "Writing %d records.", trns->record_cnt),
 436                trns->record_cnt);
 437   tab_submit (t);
 438 }
 439 \f
 440 /* Transformation. */
 441
 442 static void flush_records (struct print_trns *, int target_record,
 443                            bool *eject, int *record);
 444
 445 /* Performs the transformation inside print_trns T on case C. */
 446 static int
 447 print_trns_proc (void *trns_, struct ccase *c, casenumber case_num UNUSED)
 448 {
 449   struct print_trns *trns = trns_;
 450   bool eject = trns->eject;
 451   int record = 1;
 452   struct prt_out_spec *spec;
 453
 454   ds_clear (&trns->line);
 455   ds_put_char (&trns->line, ' ');
 456   ll_for_each (spec, struct prt_out_spec, ll, &trns->specs)
 457     {
 458       flush_records (trns, spec->record, &eject, &record);
 459
 460       ds_set_length (&trns->line, spec->first_column, ' ');
 461       if (spec->type == PRT_VAR)
 462         {
 463           const union value *input = case_data (c, spec->var);
 464           char *output = ds_put_uninit (&trns->line, spec->format.w);
 465           if (!spec->sysmis_as_spaces || input->f != SYSMIS)
 466             data_out (input, &spec->format, output);
 467           else
 468             memset (output, ' ', spec->format.w);
 469           if (spec->add_space)
 470             ds_put_char (&trns->line, ' ');
 471         }
 472       else
 473         ds_put_substring (&trns->line, ds_ss (&spec->string));
 474     }
 475   flush_records (trns, trns->record_cnt + 1, &eject, &record);
 476
 477   if (trns->writer != NULL && dfm_write_error (trns->writer))
 478     return TRNS_ERROR;
 479   return TRNS_CONTINUE;
 480 }
 481
 482 /* Advance from *RECORD to TARGET_RECORD, outputting records
 483    along the way.  If *EJECT is true, then the first record
 484    output is preceded by ejecting the page (and *EJECT is set
 485    false). */
 486 static void
 487 flush_records (struct print_trns *trns, int target_record,
 488                bool *eject, int *record)
 489 {
 490   for (; target_record > *record; (*record)++)
 491     {
 492       char *line = ds_cstr (&trns->line);
 493       size_t length = ds_length (&trns->line);
 494       char leader = ' ';
 495
 496       if (*eject)
 497         {
 498           *eject = false;
 499           if (trns->writer == NULL)
 500             som_eject_page ();
 501           else
 502             leader = '1';
 503         }
 504       line[0] = leader;
 505
 506       if (trns->writer == NULL)
 507         tab_output_text (TAB_FIX | TAT_NOWRAP, &line[1]);
 508       else
 509         {
 510           if (!trns->include_prefix)
 511             {
 512               line++;
 513               length--;
 514             }
 515           dfm_put_record (trns->writer, line, length);
 516         }
 517
 518       ds_truncate (&trns->line, 1);
 519     }
 520 }
 521
 522 /* Frees TRNS. */
 523 static bool
 524 print_trns_free (void *trns_)
 525 {
 526   struct print_trns *trns = trns_;
 527   bool ok = true;
 528
 529   if (trns->writer != NULL)
 530     ok = dfm_close_writer (trns->writer);
 531   pool_destroy (trns->pool);
 532
 533   return ok;
 534 }
 535