pintos-os.org Git - pspp/blob - src/language/data-io/data-parser.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2007, 2009, 2010 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/tab.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 = *first_column + (ss_length (line) - ss_length (p));
 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 = *first_column + ss_length (*field);
 488
 489       if (!ss_ltrim (&p, parser->soft_seps) || ss_is_empty (p)
 490           || ss_find_char (parser->hard_seps, p.string[0]) != SIZE_MAX)
 491         {
 492           /* Advance past a trailing hard separator,
 493              regardless of whether one actually existed.  If
 494              we "skip" a delimiter that was not actually
 495              there, then we will return end-of-line on our
 496              next call, which is what we want. */
 497           dfm_forward_columns (reader, 1);
 498         }
 499     }
 500   dfm_forward_columns (reader, ss_length (line) - ss_length (p));
 501
 502   return true;
 503 }
 504
 505 /* Reads a case from READER into C, parsing it according to
 506    fixed-format syntax rules in PARSER.
 507    Returns true if successful, false at end of file or on I/O error. */
 508 static bool
 509 parse_fixed (const struct data_parser *parser, struct dfm_reader *reader,
 510              struct ccase *c)
 511 {
 512   const char *encoding = dfm_reader_get_legacy_encoding (reader);
 513   struct field *f;
 514   int row;
 515
 516   if (dfm_eof (reader))
 517     return false;
 518
 519   f = parser->fields;
 520   for (row = 1; row <= parser->records_per_case; row++)
 521     {
 522       struct substring line;
 523
 524       if (dfm_eof (reader))
 525         {
 526           msg (SW, _("Partial case of %d of %d records discarded."),
 527                row - 1, parser->records_per_case);
 528           return false;
 529         }
 530       dfm_expand_tabs (reader);
 531       line = dfm_get_record (reader);
 532
 533       for (; f < &parser->fields[parser->field_cnt] && f->record == row; f++)
 534         {
 535           struct substring s = ss_substr (line, f->first_column - 1,
 536                                           f->format.w);
 537           union value *value = case_data_rw_idx (c, f->case_idx);
 538
 539           data_in (s, encoding, f->format.type,
 540                    f->first_column, f->first_column + f->format.w,
 541                    parser->dict, value, fmt_var_width (&f->format));
 542
 543           data_in_imply_decimals (s, encoding, f->format.type, f->format.d,
 544                                   value);
 545         }
 546
 547       dfm_forward_record (reader);
 548     }
 549
 550   return true;
 551 }
 552
 553 /* Reads a case from READER into C, parsing it according to
 554    free-format syntax rules in PARSER.
 555    Returns true if successful, false at end of file or on I/O error. */
 556 static bool
 557 parse_delimited_span (const struct data_parser *parser,
 558                       struct dfm_reader *reader, struct ccase *c)
 559 {
 560   const char *encoding = dfm_reader_get_legacy_encoding (reader);
 561   struct string tmp = DS_EMPTY_INITIALIZER;
 562   struct field *f;
 563
 564   for (f = parser->fields; f < &parser->fields[parser->field_cnt]; f++)
 565     {
 566       struct substring s;
 567       int first_column, last_column;
 568
 569       /* Cut out a field and read in a new record if necessary. */
 570       while (!cut_field (parser, reader,
 571                          &first_column, &last_column, &tmp, &s))
 572         {
 573           if (!dfm_eof (reader))
 574             dfm_forward_record (reader);
 575           if (dfm_eof (reader))
 576             {
 577               if (f > parser->fields)
 578                 msg (SW, _("Partial case discarded.  The first variable "
 579                            "missing was %s."), f->name);
 580               ds_destroy (&tmp);
 581               return false;
 582             }
 583         }
 584
 585       data_in (s, encoding, f->format.type, first_column, last_column,
 586                parser->dict,
 587                case_data_rw_idx (c, f->case_idx),
 588                fmt_var_width (&f->format));
 589     }
 590   ds_destroy (&tmp);
 591   return true;
 592 }
 593
 594 /* Reads a case from READER into C, parsing it according to
 595    delimited syntax rules with one case per record in PARSER.
 596    Returns true if successful, false at end of file or on I/O error. */
 597 static bool
 598 parse_delimited_no_span (const struct data_parser *parser,
 599                          struct dfm_reader *reader, struct ccase *c)
 600 {
 601   const char *encoding = dfm_reader_get_legacy_encoding (reader);
 602   struct string tmp = DS_EMPTY_INITIALIZER;
 603   struct substring s;
 604   struct field *f, *end;
 605
 606   if (dfm_eof (reader))
 607     return false;
 608
 609   end = &parser->fields[parser->field_cnt];
 610   for (f = parser->fields; f < end; f++)
 611     {
 612       int first_column, last_column;
 613       if (!cut_field (parser, reader, &first_column, &last_column, &tmp, &s))
 614         {
 615           if (f < end - 1 && settings_get_undefined ())
 616             msg (SW, _("Missing value(s) for all variables from %s onward.  "
 617                        "These will be filled with the system-missing value "
 618                        "or blanks, as appropriate."),
 619                  f->name);
 620           for (; f < end; f++)
 621             value_set_missing (case_data_rw_idx (c, f->case_idx),
 622                                fmt_var_width (&f->format));
 623           goto exit;
 624         }
 625
 626       data_in (s, encoding, f->format.type, first_column, last_column,
 627                parser->dict,
 628                case_data_rw_idx (c, f->case_idx),
 629                fmt_var_width (&f->format));
 630     }
 631
 632   s = dfm_get_record (reader);
 633   ss_ltrim (&s, parser->soft_seps);
 634   if (!ss_is_empty (s))
 635     msg (SW, _("Record ends in data not part of any field."));
 636
 637 exit:
 638   dfm_forward_record (reader);
 639   ds_destroy (&tmp);
 640   return true;
 641 }
 642 \f
 643 /* Displays a table giving information on fixed-format variable
 644    parsing on DATA LIST. */
 645 static void
 646 dump_fixed_table (const struct data_parser *parser,
 647                   const struct file_handle *fh)
 648 {
 649   struct tab_table *t;
 650   size_t i;
 651
 652   t = tab_create (4, parser->field_cnt + 1);
 653   tab_headers (t, 0, 0, 1, 0);
 654   tab_text (t, 0, 0, TAB_CENTER | TAT_TITLE, _("Variable"));
 655   tab_text (t, 1, 0, TAB_CENTER | TAT_TITLE, _("Record"));
 656   tab_text (t, 2, 0, TAB_CENTER | TAT_TITLE, _("Columns"));
 657   tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Format"));
 658   tab_box (t, TAL_1, TAL_1, TAL_0, TAL_1, 0, 0, 3, parser->field_cnt);
 659   tab_hline (t, TAL_2, 0, 3, 1);
 660
 661   for (i = 0; i < parser->field_cnt; i++)
 662     {
 663       struct field *f = &parser->fields[i];
 664       char fmt_string[FMT_STRING_LEN_MAX + 1];
 665       int row = i + 1;
 666
 667       tab_text (t, 0, row, TAB_LEFT, f->name);
 668       tab_text_format (t, 1, row, 0, "%d", f->record);
 669       tab_text_format (t, 2, row, 0, "%3d-%3d",
 670                        f->first_column, f->first_column + f->format.w - 1);
 671       tab_text (t, 3, row, TAB_LEFT | TAB_FIX,
 672                 fmt_to_string (&f->format, fmt_string));
 673     }
 674
 675   tab_title (t, ngettext ("Reading %d record from %s.",
 676                           "Reading %d records from %s.",
 677                           parser->records_per_case),
 678              parser->records_per_case, fh_get_name (fh));
 679   tab_submit (t);
 680 }
 681
 682 /* Displays a table giving information on free-format variable parsing
 683    on DATA LIST. */
 684 static void
 685 dump_delimited_table (const struct data_parser *parser,
 686                       const struct file_handle *fh)
 687 {
 688   struct tab_table *t;
 689   size_t i;
 690
 691   t = tab_create (2, parser->field_cnt + 1);
 692   tab_headers (t, 0, 0, 1, 0);
 693   tab_text (t, 0, 0, TAB_CENTER | TAT_TITLE, _("Variable"));
 694   tab_text (t, 1, 0, TAB_CENTER | TAT_TITLE, _("Format"));
 695   tab_box (t, TAL_1, TAL_1, TAL_0, TAL_1, 0, 0, 1, parser->field_cnt);
 696   tab_hline (t, TAL_2, 0, 1, 1);
 697
 698   for (i = 0; i < parser->field_cnt; i++)
 699     {
 700       struct field *f = &parser->fields[i];
 701       char str[FMT_STRING_LEN_MAX + 1];
 702       int row = i + 1;
 703
 704       tab_text (t, 0, row, TAB_LEFT, f->name);
 705       tab_text (t, 1, row, TAB_LEFT | TAB_FIX,
 706                 fmt_to_string (&f->format, str));
 707     }
 708
 709   tab_title (t, _("Reading free-form data from %s."), fh_get_name (fh));
 710
 711   tab_submit (t);
 712 }
 713
 714 /* Displays a table giving information on how PARSER will read
 715    data from FH. */
 716 void
 717 data_parser_output_description (struct data_parser *parser,
 718                                 const struct file_handle *fh)
 719 {
 720   if (parser->type == DP_FIXED)
 721     dump_fixed_table (parser, fh);
 722   else
 723     dump_delimited_table (parser, fh);
 724 }
 725 \f
 726 /* Data parser input program. */
 727 struct data_parser_casereader
 728   {
 729     struct data_parser *parser; /* Parser. */
 730     struct dfm_reader *reader;  /* Data file reader. */
 731     struct caseproto *proto;    /* Format of cases. */
 732   };
 733
 734 static const struct casereader_class data_parser_casereader_class;
 735
 736 /* Replaces DS's active file by an input program that reads data
 737    from READER according to the rules in PARSER, using DICT as
 738    the underlying dictionary.  Ownership of PARSER and READER is
 739    transferred to the input program, and ownership of DICT is
 740    transferred to the dataset. */
 741 void
 742 data_parser_make_active_file (struct data_parser *parser, struct dataset *ds,
 743                               struct dfm_reader *reader,
 744                               struct dictionary *dict)
 745 {
 746   struct data_parser_casereader *r;
 747   struct casereader *casereader;
 748
 749   r = xmalloc (sizeof *r);
 750   r->parser = parser;
 751   r->reader = reader;
 752   r->proto = caseproto_ref (dict_get_proto (dict));
 753   casereader = casereader_create_sequential (NULL, r->proto,
 754                                              CASENUMBER_MAX,
 755                                              &data_parser_casereader_class, r);
 756   proc_set_active_file (ds, casereader, dict);
 757 }
 758
 759 static struct ccase *
 760 data_parser_casereader_read (struct casereader *reader UNUSED, void *r_)
 761 {
 762   struct data_parser_casereader *r = r_;
 763   struct ccase *c = case_create (r->proto);
 764   if (data_parser_parse (r->parser, r->reader, c))
 765     return c;
 766   else
 767     {
 768       case_unref (c);
 769       return NULL;
 770     }
 771 }
 772
 773 static void
 774 data_parser_casereader_destroy (struct casereader *reader UNUSED, void *r_)
 775 {
 776   struct data_parser_casereader *r = r_;
 777   if (dfm_reader_error (r->reader))
 778     casereader_force_error (reader);
 779   data_parser_destroy (r->parser);
 780   dfm_close_reader (r->reader);
 781   caseproto_unref (r->proto);
 782   free (r);
 783 }
 784
 785 static const struct casereader_class data_parser_casereader_class =
 786   {
 787     data_parser_casereader_read,
 788     data_parser_casereader_destroy,
 789     NULL,
 790     NULL,
 791   };