src/language/data-io/data-parser.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2007 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 <language/data-io/data-parser.h>
  20
  21 #include <stdint.h>
  22 #include <stdlib.h>
  23
  24 #include <data/casereader-provider.h>
  25 #include <data/data-in.h>
  26 #include <data/dictionary.h>
  27 #include <data/format.h>
  28 #include <data/file-handle-def.h>
  29 #include <data/procedure.h>
  30 #include <data/settings.h>
  31 #include <language/data-io/data-reader.h>
  32 #include <libpspp/message.h>
  33 #include <libpspp/str.h>
  34 #include <output/table.h>
  35
  36 #include "xalloc.h"
  37
  38 #include "gettext.h"
  39 #define _(msgid) gettext (msgid)
  40
  41 /* Data parser for textual data like that read by DATA LIST. */
  42 struct data_parser
  43   {
  44     enum data_parser_type type; /* Type of data to parse. */
  45     int skip_records;           /* Records to skip before first real data. */
  46     casenumber max_cases;       /* Max number of cases to read. */
  47     int percent_cases;          /* Approximate percent of cases to read. */
  48
  49     struct field *fields;       /* Fields to parse. */
  50     size_t field_cnt;           /* Number of fields. */
  51     size_t field_allocated;     /* Number of fields spaced allocated for. */
  52
  53     /* DP_DELIMITED parsers only. */
  54     bool span;                  /* May cases span multiple records? */
  55     bool empty_line_has_field;  /* Does an empty line have an (empty) field? */
  56     struct substring quotes;    /* Characters that can quote separators. */
  57     bool quote_escape;          /* Doubled quote acts as escape? */
  58     struct substring soft_seps; /* Two soft separators act like just one. */
  59     struct substring hard_seps; /* Two hard separators yield empty fields. */
  60     struct string any_sep;      /* Concatenation of soft_seps and hard_seps. */
  61
  62     /* DP_FIXED parsers only. */
  63     int records_per_case;       /* Number of records in each case. */
  64   };
  65
  66 /* How to parse one variable. */
  67 struct field
  68   {
  69     struct fmt_spec format;     /* Input format of this field. */
  70     int case_idx;               /* First value in case. */
  71     char *name;                 /* Var name for error messages and tables. */
  72
  73     /* DP_FIXED only. */
  74     int record;                 /* Record number (1-based). */
  75     int first_column;           /* First column in record (1-based). */
  76   };
  77
  78 static void set_any_sep (struct data_parser *parser);
  79
  80 /* Creates and returns a new data parser. */
  81 struct data_parser *
  82 data_parser_create (void)
  83 {
  84   struct data_parser *parser = xmalloc (sizeof *parser);
  85
  86   parser->type = DP_FIXED;
  87   parser->skip_records = 0;
  88   parser->max_cases = -1;
  89   parser->percent_cases = 100;
  90
  91   parser->fields = NULL;
  92   parser->field_cnt = 0;
  93   parser->field_allocated = 0;
  94
  95   parser->span = true;
  96   parser->empty_line_has_field = false;
  97   ss_alloc_substring (&parser->quotes, ss_cstr ("\"'"));
  98   parser->quote_escape = false;
  99   ss_alloc_substring (&parser->soft_seps, ss_cstr (CC_SPACES));
 100   ss_alloc_substring (&parser->hard_seps, ss_cstr (","));
 101   ds_init_empty (&parser->any_sep);
 102   set_any_sep (parser);
 103
 104   parser->records_per_case = 0;
 105
 106   return parser;
 107 }
 108
 109 /* Destroys PARSER. */
 110 void
 111 data_parser_destroy (struct data_parser *parser)
 112 {
 113   if (parser != NULL)
 114     {
 115       size_t i;
 116
 117       for (i = 0; i < parser->field_cnt; i++)
 118         free (parser->fields[i].name);
 119       free (parser->fields);
 120       ss_dealloc (&parser->quotes);
 121       ss_dealloc (&parser->soft_seps);
 122       ss_dealloc (&parser->hard_seps);
 123       ds_destroy (&parser->any_sep);
 124       free (parser);
 125     }
 126 }
 127
 128 /* Returns the type of PARSER (either DP_DELIMITED or DP_FIXED). */
 129 enum data_parser_type
 130 data_parser_get_type (const struct data_parser *parser)
 131 {
 132   return parser->type;
 133 }
 134
 135 /* Sets the type of PARSER to TYPE (either DP_DELIMITED or
 136    DP_FIXED). */
 137 void
 138 data_parser_set_type (struct data_parser *parser, enum data_parser_type type)
 139 {
 140   assert (parser->field_cnt == 0);
 141   assert (type == DP_FIXED || type == DP_DELIMITED);
 142   parser->type = type;
 143 }
 144
 145 /* Configures PARSER to skip the specified number of
 146    INITIAL_RECORDS_TO_SKIP before parsing any data.  By default,
 147    no records are skipped. */
 148 void
 149 data_parser_set_skip (struct data_parser *parser, int initial_records_to_skip)
 150 {
 151   assert (initial_records_to_skip >= 0);
 152   parser->skip_records = initial_records_to_skip;
 153 }
 154
 155 /* Sets the maximum number of cases parsed by PARSER to
 156    MAX_CASES.  The default is -1, meaning no limit. */
 157 void
 158 data_parser_set_case_limit (struct data_parser *parser, casenumber max_cases)
 159 {
 160   parser->max_cases = max_cases;
 161 }
 162
 163 /* Sets the percentage of cases that PARSER should read from the
 164    input file to PERCENT_CASES.  By default, all cases are
 165    read. */
 166 void
 167 data_parser_set_case_percent (struct data_parser *parser, int percent_cases)
 168 {
 169   assert (percent_cases >= 0 && percent_cases <= 100);
 170   parser->percent_cases = percent_cases;
 171 }
 172
 173 /* Returns true if PARSER is configured to allow cases to span
 174    multiple records. */
 175 bool
 176 data_parser_get_span (const struct data_parser *parser)
 177 {
 178   return parser->span;
 179 }
 180
 181 /* If MAY_CASES_SPAN_RECORDS is true, configures PARSER to allow
 182    a single case to span multiple records and multiple cases to
 183    occupy a single record.  If MAY_CASES_SPAN_RECORDS is false,
 184    configures PARSER to require each record to contain exactly
 185    one case.
 186
 187    This setting affects parsing of DP_DELIMITED files only. */
 188 void
 189 data_parser_set_span (struct data_parser *parser, bool may_cases_span_records)
 190 {
 191   parser->span = may_cases_span_records;
 192 }
 193
 194 /* If EMPTY_LINE_HAS_FIELD is true, configures PARSER to parse an
 195    empty line as an empty field and to treat a hard delimiter
 196    followed by end-of-line as an empty field.  If
 197    EMPTY_LINE_HAS_FIELD is false, PARSER will skip empty lines
 198    and hard delimiters at the end of lines without emitting empty
 199    fields.
 200
 201    This setting affects parsing of DP_DELIMITED files only. */
 202 void
 203 data_parser_set_empty_line_has_field (struct data_parser *parser,
 204                                       bool empty_line_has_field)
 205 {
 206   parser->empty_line_has_field = empty_line_has_field;
 207 }
 208
 209 /* Sets the characters that may be used for quoting field
 210    contents to QUOTES.  If QUOTES is empty, quoting will be
 211    disabled.
 212
 213    The caller retains ownership of QUOTES.
 214
 215    This setting affects parsing of DP_DELIMITED files only. */
 216 void
 217 data_parser_set_quotes (struct data_parser *parser, struct substring quotes)
 218 {
 219   ss_dealloc (&parser->quotes);
 220   ss_alloc_substring (&parser->quotes, quotes);
 221 }
 222
 223 /* If ESCAPE is false (the default setting), a character used for
 224    quoting cannot itself be embedded within a quoted field.  If
 225    ESCAPE is true, then a quote character can be embedded within
 226    a quoted field by doubling it.
 227
 228    This setting affects parsing of DP_DELIMITED files only, and
 229    only when at least one quote character has been set (with
 230    data_parser_set_quotes). */
 231 void
 232 data_parser_set_quote_escape (struct data_parser *parser, bool escape)
 233 {
 234   parser->quote_escape = escape;
 235 }
 236
 237 /* Sets PARSER's soft delimiters to DELIMITERS.  Soft delimiters
 238    separate fields, but consecutive soft delimiters do not yield
 239    empty fields.  (Ordinarily, only white space characters are
 240    appropriate soft delimiters.)
 241
 242    The caller retains ownership of DELIMITERS.
 243
 244    This setting affects parsing of DP_DELIMITED files only. */
 245 void
 246 data_parser_set_soft_delimiters (struct data_parser *parser,
 247                                  struct substring delimiters)
 248 {
 249   ss_dealloc (&parser->soft_seps);
 250   ss_alloc_substring (&parser->soft_seps, delimiters);
 251   set_any_sep (parser);
 252 }
 253
 254 /* Sets PARSER's hard delimiters to DELIMITERS.  Hard delimiters
 255    separate fields.  A consecutive pair of hard delimiters yield
 256    an empty field.
 257
 258    The caller retains ownership of DELIMITERS.
 259
 260    This setting affects parsing of DP_DELIMITED files only. */
 261 void
 262 data_parser_set_hard_delimiters (struct data_parser *parser,
 263                                  struct substring delimiters)
 264 {
 265   ss_dealloc (&parser->hard_seps);
 266   ss_alloc_substring (&parser->hard_seps, delimiters);
 267   set_any_sep (parser);
 268 }
 269
 270 /* Returns the number of records per case. */
 271 int
 272 data_parser_get_records (const struct data_parser *parser)
 273 {
 274   return parser->records_per_case;
 275 }
 276
 277 /* Sets the number of records per case to RECORDS_PER_CASE.
 278
 279    This setting affects parsing of DP_FIXED files only. */
 280 void
 281 data_parser_set_records (struct data_parser *parser, int records_per_case)
 282 {
 283   assert (records_per_case >= 0);
 284   assert (records_per_case >= parser->records_per_case);
 285   parser->records_per_case = records_per_case;
 286 }
 287
 288 static void
 289 add_field (struct data_parser *p, const struct fmt_spec *format, int case_idx,
 290            const char *name, int record, int first_column)
 291 {
 292   struct field *field;
 293
 294   if (p->field_cnt == p->field_allocated)
 295     p->fields = x2nrealloc (p->fields, &p->field_allocated, sizeof *p->fields);
 296   field = &p->fields[p->field_cnt++];
 297   field->format = *format;
 298   field->case_idx = case_idx;
 299   field->name = xstrdup (name);
 300   field->record = record;
 301   field->first_column = first_column;
 302 }
 303
 304 /* Adds a delimited field to the field parsed by PARSER, which
 305    must be configured as a DP_DELIMITED parser.  The field is
 306    parsed as input format FORMAT.  Its data will be stored into case
 307    index CASE_INDEX.  Errors in input data will be reported
 308    against variable NAME. */
 309 void
 310 data_parser_add_delimited_field (struct data_parser *parser,
 311                                  const struct fmt_spec *format, int case_idx,
 312                                  const char *name)
 313 {
 314   assert (parser->type == DP_DELIMITED);
 315   add_field (parser, format, case_idx, name, 0, 0);
 316 }
 317
 318 /* Adds a fixed field to the field parsed by PARSER, which
 319    must be configured as a DP_FIXED parser.  The field is
 320    parsed as input format FORMAT.  Its data will be stored into case
 321    index CASE_INDEX.  Errors in input data will be reported
 322    against variable NAME.  The field will be drawn from the
 323    FORMAT->w columns in 1-based RECORD starting at 1-based
 324    column FIRST_COLUMN.
 325
 326    RECORD must be at least as great as that of any field already
 327    added; that is, fields must be added in increasing order of
 328    record number.  If RECORD is greater than the current number
 329    of records per case, the number of records per case are
 330    increased as needed.  */
 331 void
 332 data_parser_add_fixed_field (struct data_parser *parser,
 333                              const struct fmt_spec *format, int case_idx,
 334                              const char *name,
 335                              int record, int first_column)
 336 {
 337   assert (parser->type == DP_FIXED);
 338   assert (parser->field_cnt == 0
 339           || record >= parser->fields[parser->field_cnt - 1].record);
 340   if (record > parser->records_per_case)
 341     parser->records_per_case = record;
 342   add_field (parser, format, case_idx, name, record, first_column);
 343 }
 344
 345 /* Returns true if any fields have been added to PARSER, false
 346    otherwise. */
 347 bool
 348 data_parser_any_fields (const struct data_parser *parser)
 349 {
 350   return parser->field_cnt > 0;
 351 }
 352
 353 static void
 354 set_any_sep (struct data_parser *parser)
 355 {
 356   ds_assign_substring (&parser->any_sep, parser->soft_seps);
 357   ds_put_substring (&parser->any_sep, parser->hard_seps);
 358 }
 359 \f
 360 static bool parse_delimited_span (const struct data_parser *,
 361                                   struct dfm_reader *, struct ccase *);
 362 static bool parse_delimited_no_span (const struct data_parser *,
 363                                      struct dfm_reader *, struct ccase *);
 364 static bool parse_fixed (const struct data_parser *,
 365                          struct dfm_reader *, struct ccase *);
 366
 367 /* Reads a case from DFM into C, parsing it with PARSER.
 368    Returns true if successful, false at end of file or on I/O error. */
 369 bool
 370 data_parser_parse (struct data_parser *parser, struct dfm_reader *reader,
 371                    struct ccase *c)
 372 {
 373   bool retval;
 374
 375   assert (data_parser_any_fields (parser));
 376
 377   /* Skip the requested number of records before reading the
 378      first case. */
 379   for (; parser->skip_records > 0; parser->skip_records--)
 380     {
 381       if (dfm_eof (reader))
 382         return false;
 383       dfm_forward_record (reader);
 384     }
 385
 386   /* Limit cases. */
 387   if (parser->max_cases != -1 && parser->max_cases-- == 0)
 388     return false;
 389   if (parser->percent_cases < 100
 390       && dfm_get_percent_read (reader) >= parser->percent_cases)
 391     return false;
 392
 393   dfm_push (reader);
 394   if (parser->type == DP_DELIMITED)
 395     {
 396       if (parser->span)
 397         retval = parse_delimited_span (parser, reader, c);
 398       else
 399         retval = parse_delimited_no_span (parser, reader, c);
 400     }
 401   else
 402     retval = parse_fixed (parser, reader, c);
 403   dfm_pop (reader);
 404
 405   return retval;
 406 }
 407
 408 /* Extracts a delimited field from the current position in the
 409    current record according to PARSER, reading data from READER.
 410
 411    *FIELD is set to the field content.  The caller must not or
 412    destroy this constant string.
 413
 414    After parsing the field, sets the current position in the
 415    record to just past the field and any trailing delimiter.
 416    Returns 0 on failure or a 1-based column number indicating the
 417    beginning of the field on success. */
 418 static bool
 419 cut_field (const struct data_parser *parser, struct dfm_reader *reader,
 420            int *first_column, int *last_column, struct string *tmp,
 421            struct substring *field)
 422 {
 423   struct substring line, p;
 424
 425   if (dfm_eof (reader))
 426     return false;
 427   if (ss_is_empty (parser->hard_seps))
 428     dfm_expand_tabs (reader);
 429   line = p = dfm_get_record (reader);
 430
 431   /* Skip leading soft separators. */
 432   ss_ltrim (&p, parser->soft_seps);
 433
 434   /* Handle empty or completely consumed lines. */
 435   if (ss_is_empty (p))
 436     {
 437       if (!parser->empty_line_has_field || dfm_columns_past_end (reader) > 0)
 438         return false;
 439       else
 440         {
 441           *field = p;
 442           *first_column = dfm_column_start (reader);
 443           *last_column = *first_column + 1;
 444           dfm_forward_columns (reader, 1);
 445           return true;
 446         }
 447     }
 448
 449   *first_column = dfm_column_start (reader);
 450   if (ss_find_char (parser->quotes, ss_first (p)) != SIZE_MAX)
 451     {
 452       /* Quoted field. */
 453       int quote = ss_get_char (&p);
 454       if (!ss_get_until (&p, quote, field))
 455         msg (SW, _("Quoted string extends beyond end of line."));
 456       if (parser->quote_escape && ss_first (p) == quote)
 457         {
 458           ds_assign_substring (tmp, *field);
 459           while (ss_match_char (&p, quote))
 460             {
 461               struct substring ss;
 462               ds_put_char (tmp, quote);
 463               if (!ss_get_until (&p, quote, &ss))
 464                 msg (SW, _("Quoted string extends beyond end of line."));
 465               ds_put_substring (tmp, ss);
 466             }
 467           *field = ds_ss (tmp);
 468         }
 469       *last_column = dfm_column_start (reader);
 470
 471       /* Skip trailing soft separator and a single hard separator
 472          if present. */
 473       ss_ltrim (&p, parser->soft_seps);
 474       if (!ss_is_empty (p)
 475           && ss_find_char (parser->hard_seps, ss_first (p)) != SIZE_MAX)
 476         ss_advance (&p, 1);
 477     }
 478   else
 479     {
 480       /* Regular field. */
 481       ss_get_chars (&p, ss_cspan (p, ds_ss (&parser->any_sep)), field);
 482       *last_column = dfm_column_start (reader);
 483       if (!ss_ltrim (&p, parser->soft_seps) || ss_is_empty (p))
 484         {
 485           /* Advance past a trailing hard separator,
 486              regardless of whether one actually existed.  If
 487              we "skip" a delimiter that was not actually
 488              there, then we will return end-of-line on our
 489              next call, which is what we want. */
 490           dfm_forward_columns (reader, 1);
 491         }
 492     }
 493   dfm_forward_columns (reader, ss_length (line) - ss_length (p));
 494
 495   return true;
 496 }
 497
 498 /* Reads a case from READER into C, parsing it according to
 499    fixed-format syntax rules in PARSER.
 500    Returns true if successful, false at end of file or on I/O error. */
 501 static bool
 502 parse_fixed (const struct data_parser *parser, struct dfm_reader *reader,
 503              struct ccase *c)
 504 {
 505   enum legacy_encoding encoding = dfm_reader_get_legacy_encoding (reader);
 506   struct field *f;
 507   int row;
 508
 509   if (dfm_eof (reader))
 510     return false;
 511
 512   f = parser->fields;
 513   for (row = 1; row <= parser->records_per_case; row++)
 514     {
 515       struct substring line;
 516
 517       if (dfm_eof (reader))
 518         {
 519           msg (SW, _("Partial case of %d of %d records discarded."),
 520                row - 1, parser->records_per_case);
 521           return false;
 522         }
 523       dfm_expand_tabs (reader);
 524       line = dfm_get_record (reader);
 525
 526       for (; f < &parser->fields[parser->field_cnt] && f->record == row; f++)
 527         data_in (ss_substr (line, f->first_column - 1,
 528                             f->format.w),
 529                  encoding, f->format.type, f->format.d,
 530                  f->first_column, f->first_column + f->format.w,
 531                  case_data_rw_idx (c, f->case_idx),
 532                  fmt_var_width (&f->format));
 533
 534       dfm_forward_record (reader);
 535     }
 536
 537   return true;
 538 }
 539
 540 /* Reads a case from READER into C, parsing it according to
 541    free-format syntax rules in PARSER.
 542    Returns true if successful, false at end of file or on I/O error. */
 543 static bool
 544 parse_delimited_span (const struct data_parser *parser,
 545                       struct dfm_reader *reader, struct ccase *c)
 546 {
 547   enum legacy_encoding encoding = dfm_reader_get_legacy_encoding (reader);
 548   struct string tmp = DS_EMPTY_INITIALIZER;
 549   struct field *f;
 550
 551   for (f = parser->fields; f < &parser->fields[parser->field_cnt]; f++)
 552     {
 553       struct substring s;
 554       int first_column, last_column;
 555
 556       /* Cut out a field and read in a new record if necessary. */
 557       while (!cut_field (parser, reader,
 558                          &first_column, &last_column, &tmp, &s))
 559         {
 560           if (!dfm_eof (reader))
 561             dfm_forward_record (reader);
 562           if (dfm_eof (reader))
 563             {
 564               if (f > parser->fields)
 565                 msg (SW, _("Partial case discarded.  The first variable "
 566                            "missing was %s."), f->name);
 567               ds_destroy (&tmp);
 568               return false;
 569             }
 570         }
 571
 572       data_in (s, encoding, f->format.type, 0,
 573                first_column, last_column,
 574                case_data_rw_idx (c, f->case_idx),
 575                fmt_var_width (&f->format));
 576     }
 577   ds_destroy (&tmp);
 578   return true;
 579 }
 580
 581 /* Reads a case from READER into C, parsing it according to
 582    delimited syntax rules with one case per record in PARSER.
 583    Returns true if successful, false at end of file or on I/O error. */
 584 static bool
 585 parse_delimited_no_span (const struct data_parser *parser,
 586                          struct dfm_reader *reader, struct ccase *c)
 587 {
 588   enum legacy_encoding encoding = dfm_reader_get_legacy_encoding (reader);
 589   struct string tmp = DS_EMPTY_INITIALIZER;
 590   struct substring s;
 591   struct field *f;
 592
 593   if (dfm_eof (reader))
 594     return false;
 595
 596   for (f = parser->fields; f < &parser->fields[parser->field_cnt]; f++)
 597     {
 598       int first_column, last_column;
 599       if (!cut_field (parser, reader, &first_column, &last_column, &tmp, &s))
 600         {
 601           if (settings_get_undefined ())
 602             msg (SW, _("Missing value(s) for all variables from %s onward.  "
 603                        "These will be filled with the system-missing value "
 604                        "or blanks, as appropriate."),
 605                  f->name);
 606           for (; f < &parser->fields[parser->field_cnt]; f++)
 607             value_set_missing (case_data_rw_idx (c, f->case_idx),
 608                                fmt_var_width (&f->format));
 609           goto exit;
 610         }
 611
 612       data_in (s, encoding, f->format.type, 0,
 613                first_column, last_column,
 614                case_data_rw_idx (c, f->case_idx),
 615                fmt_var_width (&f->format));
 616     }
 617
 618   s = dfm_get_record (reader);
 619   ss_ltrim (&s, parser->soft_seps);
 620   if (!ss_is_empty (s))
 621     msg (SW, _("Record ends in data not part of any field."));
 622
 623 exit:
 624   dfm_forward_record (reader);
 625   ds_destroy (&tmp);
 626   return true;
 627 }
 628 \f
 629 /* Displays a table giving information on fixed-format variable
 630    parsing on DATA LIST. */
 631 static void
 632 dump_fixed_table (const struct data_parser *parser,
 633                   const struct file_handle *fh)
 634 {
 635   struct tab_table *t;
 636   size_t i;
 637
 638   t = tab_create (4, parser->field_cnt + 1, 0);
 639   tab_columns (t, TAB_COL_DOWN, 1);
 640   tab_headers (t, 0, 0, 1, 0);
 641   tab_text (t, 0, 0, TAB_CENTER | TAT_TITLE, _("Variable"));
 642   tab_text (t, 1, 0, TAB_CENTER | TAT_TITLE, _("Record"));
 643   tab_text (t, 2, 0, TAB_CENTER | TAT_TITLE, _("Columns"));
 644   tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Format"));
 645   tab_box (t, TAL_1, TAL_1, TAL_0, TAL_1, 0, 0, 3, parser->field_cnt);
 646   tab_hline (t, TAL_2, 0, 3, 1);
 647   tab_dim (t, tab_natural_dimensions);
 648
 649   for (i = 0; i < parser->field_cnt; i++)
 650     {
 651       struct field *f = &parser->fields[i];
 652       char fmt_string[FMT_STRING_LEN_MAX + 1];
 653       int row = i + 1;
 654
 655       tab_text (t, 0, row, TAB_LEFT, f->name);
 656       tab_text (t, 1, row, TAT_PRINTF, "%d", f->record);
 657       tab_text (t, 2, row, TAT_PRINTF, "%3d-%3d",
 658                 f->first_column, f->first_column + f->format.w - 1);
 659       tab_text (t, 3, row, TAB_LEFT | TAB_FIX,
 660                 fmt_to_string (&f->format, fmt_string));
 661     }
 662
 663   tab_title (t, ngettext ("Reading %d record from %s.",
 664                           "Reading %d records from %s.",
 665                           parser->records_per_case),
 666              parser->records_per_case, fh_get_name (fh));
 667   tab_submit (t);
 668 }
 669
 670 /* Displays a table giving information on free-format variable parsing
 671    on DATA LIST. */
 672 static void
 673 dump_delimited_table (const struct data_parser *parser,
 674                       const struct file_handle *fh)
 675 {
 676   struct tab_table *t;
 677   size_t i;
 678
 679   t = tab_create (2, parser->field_cnt + 1, 0);
 680   tab_columns (t, TAB_COL_DOWN, 1);
 681   tab_headers (t, 0, 0, 1, 0);
 682   tab_text (t, 0, 0, TAB_CENTER | TAT_TITLE, _("Variable"));
 683   tab_text (t, 1, 0, TAB_CENTER | TAT_TITLE, _("Format"));
 684   tab_box (t, TAL_1, TAL_1, TAL_0, TAL_1, 0, 0, 1, parser->field_cnt);
 685   tab_hline (t, TAL_2, 0, 1, 1);
 686   tab_dim (t, tab_natural_dimensions);
 687
 688   for (i = 0; i < parser->field_cnt; i++)
 689     {
 690       struct field *f = &parser->fields[i];
 691       char str[FMT_STRING_LEN_MAX + 1];
 692       int row = i + 1;
 693
 694       tab_text (t, 0, row, TAB_LEFT, f->name);
 695       tab_text (t, 1, row, TAB_LEFT | TAB_FIX,
 696                 fmt_to_string (&f->format, str));
 697     }
 698
 699   tab_title (t, _("Reading free-form data from %s."), fh_get_name (fh));
 700
 701   tab_submit (t);
 702 }
 703
 704 /* Displays a table giving information on how PARSER will read
 705    data from FH. */
 706 void
 707 data_parser_output_description (struct data_parser *parser,
 708                                 const struct file_handle *fh)
 709 {
 710   if (parser->type == DP_FIXED)
 711     dump_fixed_table (parser, fh);
 712   else
 713     dump_delimited_table (parser, fh);
 714 }
 715 \f
 716 /* Data parser input program. */
 717 struct data_parser_casereader
 718   {
 719     struct data_parser *parser; /* Parser. */
 720     struct dfm_reader *reader;  /* Data file reader. */
 721     size_t value_cnt;           /* Number of `union value's in case. */
 722   };
 723
 724 static const struct casereader_class data_parser_casereader_class;
 725
 726 /* Replaces DS's active file by an input program that reads data
 727    from READER according to the rules in PARSER, using DICT as
 728    the underlying dictionary.  Ownership of PARSER and READER is
 729    transferred to the input program, and ownership of DICT is
 730    transferred to the dataset. */
 731 void
 732 data_parser_make_active_file (struct data_parser *parser, struct dataset *ds,
 733                               struct dfm_reader *reader,
 734                               struct dictionary *dict)
 735 {
 736   struct data_parser_casereader *r;
 737   struct casereader *casereader;
 738
 739   r = xmalloc (sizeof *r);
 740   r->parser = parser;
 741   r->reader = reader;
 742   r->value_cnt = dict_get_next_value_idx (dict);
 743   casereader = casereader_create_sequential (NULL, r->value_cnt,
 744                                              CASENUMBER_MAX,
 745                                              &data_parser_casereader_class, r);
 746   proc_set_active_file (ds, casereader, dict);
 747 }
 748
 749 static bool
 750 data_parser_casereader_read (struct casereader *reader UNUSED, void *r_,
 751                            struct ccase *c)
 752 {
 753   struct data_parser_casereader *r = r_;
 754   bool ok;
 755
 756   case_create (c, r->value_cnt);
 757   ok = data_parser_parse (r->parser, r->reader, c);
 758   if (!ok)
 759     case_destroy (c);
 760   return ok;
 761 }
 762
 763 static void
 764 data_parser_casereader_destroy (struct casereader *reader UNUSED, void *r_)
 765 {
 766   struct data_parser_casereader *r = r_;
 767   if (dfm_reader_error (r->reader))
 768     casereader_force_error (reader);
 769   data_parser_destroy (r->parser);
 770   dfm_close_reader (r->reader);
 771   free (r);
 772 }
 773
 774 static const struct casereader_class data_parser_casereader_class =
 775   {
 776     data_parser_casereader_read,
 777     data_parser_casereader_destroy,
 778     NULL,
 779     NULL,
 780   };