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

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