1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2007, 2010 Free Software Foundation, Inc.
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.
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.
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/>. */
17 #ifndef SPREADSHEET_READ_H
18 #define SPREADSHEET_READ_H 1
22 /* Default width of string variables. */
23 #define SPREADSHEET_DEFAULT_WIDTH 8
25 /* These elements are read/write.
26 They may be passed in NULL (for pointers) or negative for integers, in which
27 case they will be filled in be the function.
29 struct spreadsheet_read_options
31 char *sheet_name ; /* The name of the sheet to open (in UTF-8) */
32 int sheet_index ; /* The index of the sheet to open (only used if sheet_name is NULL) */
33 char *cell_range ; /* The cell range (in UTF-8) */
37 struct spreadsheet_read_info
39 char *file_name ; /* The name of the file to open (in filename encoding) */
40 bool read_names ; /* True if the first row is to be used as the names of the variables */
41 int asw ; /* The width of string variables in the created dictionary */
44 int pseudo_base26 (const char *str);
46 bool convert_cell_ref (const char *ref,
48 int *coli, int *rowi);
51 #define _xml(X) (CHAR_CAST (const xmlChar *, X))
53 #define _xmlchar_to_int(X) (atoi(CHAR_CAST (const char *, X)))
63 enum spreadsheet_type type;
65 struct casereader * (*make_reader) (struct spreadsheet *);
67 /* The total number of sheets in the "workbook" */
71 struct dictionary *dict;
75 Attempt to open the file called FILENAME as a spreadsheet.
76 It is not known a priori, what type of spreadsheet FILENAME is, or
77 even if it is a spreadsheet at all.
78 If it fails to open, then it will return NULL without any error or
81 struct spreadsheet * spreadsheet_open (const char *filename);
82 void spreadsheet_close (struct spreadsheet *);
85 struct casereader * spreadsheet_make_reader (struct spreadsheet *s);
88 #define SPREADSHEET_CAST(X) ((struct spreadsheet *)(X))