Merge commit 'origin/stable'
[pspp] / src / language / data-io / data-reader.h
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 1997-9, 2000 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 DFM_READ_H
18 #define DFM_READ_H
19
20 /* Data file manager (dfm).
21
22    This module is in charge of reading and writing data files (other
23    than system files).  dfm is an fhuser, so see file-handle.h for the
24    fhuser interface. */
25
26 #include <stdbool.h>
27 #include <stddef.h>
28 #include <libpspp/legacy-encoding.h>
29
30 struct file_handle;
31 struct string;
32 struct lexer;
33
34 /* Input. */
35 struct dfm_reader *dfm_open_reader (struct file_handle *, struct lexer *);
36 void dfm_close_reader (struct dfm_reader *);
37 bool dfm_reader_error (const struct dfm_reader *);
38 unsigned dfm_eof (struct dfm_reader *);
39 struct substring dfm_get_record (struct dfm_reader *);
40 void dfm_expand_tabs (struct dfm_reader *);
41 const char *dfm_reader_get_legacy_encoding (const struct dfm_reader *);
42 int dfm_get_percent_read (const struct dfm_reader *);
43
44 /* Line control. */
45 void dfm_forward_record (struct dfm_reader *);
46 void dfm_reread_record (struct dfm_reader *, size_t column);
47 void dfm_forward_columns (struct dfm_reader *, size_t columns);
48 size_t dfm_column_start (const struct dfm_reader *);
49 size_t dfm_columns_past_end (const struct dfm_reader *);
50 size_t dfm_get_column (const struct dfm_reader *, const char *);
51
52 /* File stack. */
53 void dfm_push (struct dfm_reader *);
54 void dfm_pop (struct dfm_reader *);
55
56 #endif /* data-reader.h */