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

   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 #ifndef LANGUAGE_DATA_IO_DATA_PARSER_H
  18 #define LANGUAGE_DATA_IO_DATA_PARSER_H
  19
  20 /* Abstraction of a DATA LIST or GET DATA TYPE=TXT data parser. */
  21
  22 #include <stdbool.h>
  23 #include <data/case.h>
  24
  25 struct dataset;
  26 struct dfm_reader;
  27 struct dictionary;
  28 struct file_handle;
  29 struct fmt_spec;
  30 struct substring;
  31
  32 /* Type of data read by a data parser. */
  33 enum data_parser_type
  34   {
  35     DP_FIXED,                   /* Fields in fixed column positions. */
  36     DP_DELIMITED                /* Fields delimited by e.g. commas. */
  37   };
  38
  39 /* Creating and configuring any parser. */
  40 struct data_parser *data_parser_create (void);
  41 void data_parser_destroy (struct data_parser *);
  42
  43 enum data_parser_type data_parser_get_type (const struct data_parser *);
  44 void data_parser_set_type (struct data_parser *, enum data_parser_type);
  45
  46 void data_parser_set_skip (struct data_parser *, int initial_records_to_skip);
  47 void data_parser_set_case_limit (struct data_parser *, casenumber max_cases);
  48 void data_parser_set_case_percent (struct data_parser *, int case_percent);
  49
  50 /* For configuring delimited parsers only. */
  51 bool data_parser_get_span (const struct data_parser *);
  52 void data_parser_set_span (struct data_parser *, bool may_cases_span_records);
  53
  54 void data_parser_set_empty_line_has_field (struct data_parser *,
  55                                            bool empty_line_has_field);
  56 void data_parser_set_quotes (struct data_parser *, struct substring);
  57 void data_parser_set_quote_escape (struct data_parser *, bool escape);
  58 void data_parser_set_soft_delimiters (struct data_parser *, struct substring);
  59 void data_parser_set_hard_delimiters (struct data_parser *, struct substring);
  60
  61 /* For configuring fixed parsers only. */
  62 int data_parser_get_records (const struct data_parser *);
  63 void data_parser_set_records (struct data_parser *, int records_per_case);
  64
  65 /* Field setup and parsing. */
  66 void data_parser_add_delimited_field (struct data_parser *,
  67                                       const struct fmt_spec *, int fv,
  68                                       const char *name);
  69 void data_parser_add_fixed_field (struct data_parser *,
  70                                   const struct fmt_spec *, int fv,
  71                                   const char *name,
  72                                   int record, int first_column);
  73 bool data_parser_any_fields (const struct data_parser *);
  74 bool data_parser_parse (struct data_parser *,
  75                         struct dfm_reader *, struct ccase *);
  76
  77 /* Uses for a configured parser. */
  78 void data_parser_output_description (struct data_parser *,
  79                                      const struct file_handle *);
  80 void data_parser_make_active_file (struct data_parser *, struct dataset *,
  81                                    struct dfm_reader *, struct dictionary *);
  82
  83 #endif /* language/data-io/data-parser.h */