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