better tests
[pspp] / src / data / spreadsheet-reader.h
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2007, 2010, 2016 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 SPREADSHEET_READ_H
18 #define SPREADSHEET_READ_H 1
19
20 #include <stdbool.h>
21 #include <libpspp/compiler.h>
22
23 struct casereeader;
24
25 /* Default width of string variables. */
26 #define SPREADSHEET_DEFAULT_WIDTH 8
27
28 /* These elements are read/write.
29    They may be passed in NULL (for pointers) or negative for integers, in which
30    case they will be filled in be the function.
31 */
32 struct spreadsheet_read_options
33 {
34   char *sheet_name ;       /* The name of the sheet to open (in UTF-8) */
35   int sheet_index ;        /* The index of the sheet to open (only used if sheet_name is NULL).
36                               The first index is 1 NOT 0 */
37   char *cell_range ;       /* The cell range (in UTF-8) */
38   bool read_names ;        /* True if the first row is to be used as the names of the variables */
39   int asw ;                /* The width of string variables in the created dictionary */
40 };
41
42 int ps26_to_int (const char *str);
43 char * int_to_ps26 (int);
44
45 bool convert_cell_ref (const char *ref,
46                        int *col0, int *row0,
47                        int *coli, int *rowi);
48
49
50 #define _xml(X) (CHAR_CAST (const xmlChar *, (X)))
51
52 #define _xmlchar_to_int(X) ((X) ? atoi (CHAR_CAST (const char *, (X))) : -1)
53
54 struct sheet_detail
55 {
56   /* The name of the sheet (utf8 encoding) */
57   char *name;
58
59   /* The extents of the sheet.  */
60   int first_col;
61   int last_col;
62   int first_row;
63   int last_row;
64 };
65
66 struct spreadsheet
67 {
68   /** General spreadsheet object related things.  */
69   int ref_cnt;
70
71   /* A 3 letter string (null terminated) which identifies the type of
72      spreadsheet (eg: "ODS" for opendocument; "GNM" for gnumeric etc).  */
73   char type[4];
74
75   void (*destroy) (struct spreadsheet *);
76   struct casereader* (*make_reader) (struct spreadsheet *,
77                                     const struct spreadsheet_read_options *);
78   const char * (*get_sheet_name) (struct spreadsheet *, int);
79   char * (*get_sheet_range) (struct spreadsheet *, int);
80   int (*get_sheet_n_sheets) (struct spreadsheet *);
81   unsigned int (*get_sheet_n_rows) (struct spreadsheet *, int);
82   unsigned int (*get_sheet_n_columns) (struct spreadsheet *, int);
83   char * (*get_sheet_cell) (struct spreadsheet *, int , int , int);
84
85   char *file_name;
86
87   struct sheet_detail *sheets;
88
89
90   /** Things specific to casereaders.  */
91
92   /* The dictionary for client's reference.
93      Client must ref or clone it if it needs a permanent or modifiable copy. */
94   struct dictionary *dict;
95   struct caseproto *proto;
96   struct ccase *first_case;
97   bool used_first_case;
98
99   /* Where the reader should start and stop.  */
100   int start_row;
101   int start_col;
102   int stop_row;
103   int stop_col;
104 };
105
106
107 struct casereader * spreadsheet_make_reader (struct spreadsheet *, const struct spreadsheet_read_options *);
108
109 const char * spreadsheet_get_sheet_name (struct spreadsheet *s, int n) OPTIMIZE(2);
110 char * spreadsheet_get_sheet_range (struct spreadsheet *s, int n) OPTIMIZE(2);
111 int  spreadsheet_get_sheet_n_sheets (struct spreadsheet *s) OPTIMIZE(2);
112 unsigned int  spreadsheet_get_sheet_n_rows (struct spreadsheet *s, int n) OPTIMIZE(2);
113 unsigned int  spreadsheet_get_sheet_n_columns (struct spreadsheet *s, int n) OPTIMIZE(2);
114
115 char * spreadsheet_get_cell (struct spreadsheet *s, int n, int row, int column);
116
117 char * create_cell_ref (int col0, int row0);
118 char *create_cell_range (int col0, int row0, int coli, int rowi);
119
120 struct spreadsheet * spreadsheet_ref (struct spreadsheet *s) WARN_UNUSED_RESULT;
121 void spreadsheet_unref (struct spreadsheet *);
122
123
124 #define SPREADSHEET_CAST(X) ((struct spreadsheet *)(X))
125
126 #endif