1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2007, 2009, 2010, 2011, 2012, 2013 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/>. */
19 #include "libpspp/message.h"
20 #include "libpspp/misc.h"
22 #include "gl/minmax.h"
23 #include "gl/c-strtod.h"
26 #define _(msgid) gettext (msgid)
27 #define N_(msgid) (msgid)
29 #include "spreadsheet-reader.h"
31 #include "c-xvasprintf.h"
36 gnumeric_open_reader (struct spreadsheet_read_info *gri, struct spreadsheet_read_options *opts, struct dictionary **dict)
38 msg (ME, _("Support for %s files was not compiled into this installation of PSPP"), "Gnumeric");
45 #include "data/gnumeric-reader.h"
50 #include <libxml/xmlreader.h>
53 #include "data/case.h"
54 #include "data/casereader-provider.h"
55 #include "data/dictionary.h"
56 #include "data/identifier.h"
57 #include "data/value.h"
58 #include "data/variable.h"
59 #include "libpspp/i18n.h"
60 #include "libpspp/str.h"
62 #include "gl/xalloc.h"
64 static void gnm_file_casereader_destroy (struct casereader *, void *);
66 static struct ccase *gnm_file_casereader_read (struct casereader *, void *);
68 static const struct casereader_class gnm_file_casereader_class =
70 gnm_file_casereader_read,
71 gnm_file_casereader_destroy,
78 STATE_PRE_INIT = 0, /* Initial state */
79 STATE_SHEET_COUNT, /* Found the sheet index */
80 STATE_INIT , /* Other Initial state */
81 STATE_SHEET_START, /* Found the start of a sheet */
82 STATE_SHEET_NAME, /* Found the sheet name */
85 STATE_SHEET_FOUND, /* Found the sheet that we actually want */
86 STATE_CELLS_START, /* Found the start of the cell array */
87 STATE_CELL /* Found a cell */
104 struct gnumeric_reader
106 struct spreadsheet spreadsheet;
108 /* The libxml reader for this instance */
109 xmlTextReaderPtr xtr;
111 /* An internal state variable */
112 enum reader_state state;
125 struct sheet_detail *sheets;
127 const xmlChar *target_sheet;
128 int target_sheet_index;
130 struct caseproto *proto;
131 struct dictionary *dict;
132 struct ccase *first_case;
133 bool used_first_case;
138 gnumeric_get_sheet_name (struct spreadsheet *s, int n)
140 struct gnumeric_reader *gr = (struct gnumeric_reader *) s;
141 assert (n < s->sheets);
143 return gr->sheets[n].name;
147 static void process_node (struct gnumeric_reader *r);
151 gnumeric_get_sheet_range (struct spreadsheet *s, int n)
154 struct gnumeric_reader *gr = (struct gnumeric_reader *) s;
156 assert (n < s->sheets);
159 (gr->sheets[n].stop_col == -1)
161 (1 == (ret = xmlTextReaderRead (gr->xtr)))
168 return create_cell_ref (
169 gr->sheets[n].start_col,
170 gr->sheets[n].start_row,
171 gr->sheets[n].stop_col,
172 gr->sheets[n].stop_row);
177 gnm_file_casereader_destroy (struct casereader *reader UNUSED, void *r_)
180 struct gnumeric_reader *r = r_;
185 xmlFreeTextReader (r->xtr);
187 if ( ! r->used_first_case )
188 case_unref (r->first_case);
190 caseproto_unref (r->proto);
192 for (i = 0; i < r->spreadsheet.sheets; ++i)
194 xmlFree (r->sheets[i].name);
203 process_node (struct gnumeric_reader *r)
205 xmlChar *name = xmlTextReaderName (r->xtr);
207 name = xmlStrdup (_xml ("--"));
210 r->node_type = xmlTextReaderNodeType (r->xtr);
216 if (0 == xmlStrcasecmp (name, _xml("gnm:SheetNameIndex")) &&
217 XML_READER_TYPE_ELEMENT == r->node_type)
219 r->state = STATE_SHEET_COUNT;
220 r->spreadsheet.sheets = 0;
224 case STATE_SHEET_COUNT:
225 if (0 == xmlStrcasecmp (name, _xml("gnm:SheetName")) &&
226 XML_READER_TYPE_ELEMENT == r->node_type)
228 struct sheet_detail *sd ;
229 r->spreadsheet.sheets++;
230 r->sheets = xrealloc (r->sheets, r->spreadsheet.sheets * sizeof *r->sheets);
231 sd = &r->sheets[r->spreadsheet.sheets - 1];
232 sd->start_col = sd->stop_col = sd->start_row = sd->stop_row = -1;
234 else if (0 == xmlStrcasecmp (name, _xml("gnm:SheetNameIndex")) &&
235 XML_READER_TYPE_END_ELEMENT == r->node_type)
237 r->state = STATE_INIT;
239 else if (XML_READER_TYPE_TEXT == r->node_type)
241 r->sheets [r->spreadsheet.sheets - 1].name = xmlTextReaderValue (r->xtr);
246 if (0 == xmlStrcasecmp (name, _xml("gnm:Sheet")) &&
247 XML_READER_TYPE_ELEMENT == r->node_type)
250 r->state = STATE_SHEET_START;
253 case STATE_SHEET_START:
254 if (0 == xmlStrcasecmp (name, _xml("gnm:Name")) &&
255 XML_READER_TYPE_ELEMENT == r->node_type)
257 r->state = STATE_SHEET_NAME;
260 case STATE_SHEET_NAME:
261 if (0 == xmlStrcasecmp (name, _xml("gnm:Name")) &&
262 XML_READER_TYPE_END_ELEMENT == r->node_type)
264 r->state = STATE_INIT;
266 else if (0 == xmlStrcasecmp (name, _xml("gnm:Sheet")) &&
267 XML_READER_TYPE_END_ELEMENT == r->node_type)
269 r->state = STATE_INIT;
271 else if (XML_READER_TYPE_TEXT == r->node_type)
273 if ( r->target_sheet != NULL)
275 xmlChar *value = xmlTextReaderValue (r->xtr);
276 if ( 0 == xmlStrcmp (value, r->target_sheet))
277 r->state = STATE_SHEET_FOUND;
280 else if (r->target_sheet_index == r->sheet_index + 1)
282 r->state = STATE_SHEET_FOUND;
284 else if (r->target_sheet_index == -1)
286 r->state = STATE_SHEET_FOUND;
290 case STATE_SHEET_FOUND:
291 if (0 == xmlStrcasecmp (name, _xml("gnm:Cells")) &&
292 XML_READER_TYPE_ELEMENT == r->node_type)
294 r->min_col = INT_MAX;
295 if (! xmlTextReaderIsEmptyElement (r->xtr))
296 r->state = STATE_CELLS_START;
298 else if (0 == xmlStrcasecmp (name, _xml("gnm:MaxRow")) &&
299 XML_READER_TYPE_ELEMENT == r->node_type)
301 r->state = STATE_MAXROW;
303 else if (0 == xmlStrcasecmp (name, _xml("gnm:MaxCol")) &&
304 XML_READER_TYPE_ELEMENT == r->node_type)
306 r->state = STATE_MAXCOL;
308 else if (0 == xmlStrcasecmp (name, _xml("gnm:Sheet")) &&
309 XML_READER_TYPE_END_ELEMENT == r->node_type)
311 r->state = STATE_INIT;
315 if (0 == xmlStrcasecmp (name, _xml("gnm:MaxRow")) &&
316 XML_READER_TYPE_END_ELEMENT == r->node_type)
318 r->state = STATE_SHEET_FOUND;
320 else if (r->node_type == XML_READER_TYPE_TEXT)
322 xmlChar *value = xmlTextReaderValue (r->xtr);
323 r->sheets[r->sheet_index].maxrow = _xmlchar_to_int (value);
328 if (0 == xmlStrcasecmp (name, _xml("gnm:MaxCol")) &&
329 XML_READER_TYPE_END_ELEMENT == r->node_type)
331 r->state = STATE_SHEET_FOUND;
333 else if (r->node_type == XML_READER_TYPE_TEXT)
335 xmlChar *value = xmlTextReaderValue (r->xtr);
336 r->sheets[r->sheet_index].maxcol = _xmlchar_to_int (value);
340 case STATE_CELLS_START:
341 if (0 == xmlStrcasecmp (name, _xml ("gnm:Cell")) &&
342 XML_READER_TYPE_ELEMENT == r->node_type)
344 xmlChar *attr = NULL;
345 r->state = STATE_CELL;
347 attr = xmlTextReaderGetAttribute (r->xtr, _xml ("Col"));
348 r->col = _xmlchar_to_int (attr);
351 if (r->col < r->min_col)
354 attr = xmlTextReaderGetAttribute (r->xtr, _xml ("Row"));
355 r->row = _xmlchar_to_int (attr);
357 if (r->sheets[r->sheet_index].start_row == -1)
359 r->sheets[r->sheet_index].start_row = r->row;
362 if (r->sheets[r->sheet_index].start_col == -1)
364 r->sheets[r->sheet_index].start_col = r->col;
367 else if (0 == xmlStrcasecmp (name, _xml("gnm:Cells")) &&
368 XML_READER_TYPE_END_ELEMENT == r->node_type)
370 r->sheets[r->sheet_index].stop_col = r->col;
371 r->sheets[r->sheet_index].stop_row = r->row;
372 r->state = STATE_SHEET_NAME;
376 if (0 == xmlStrcasecmp (name, _xml("gnm:Cell")) &&
377 XML_READER_TYPE_END_ELEMENT == r->node_type)
379 r->state = STATE_CELLS_START;
391 Sets the VAR of case C, to the value corresponding to the xml string XV
394 convert_xml_string_to_value (struct ccase *c, const struct variable *var,
397 union value *v = case_data_rw (c, var);
400 value_set_missing (v, var_get_width (var));
401 else if ( var_is_alpha (var))
402 value_copy_str_rpad (v, var_get_width (var), xv, ' ');
405 const char *text = CHAR_CAST (const char *, xv);
409 v->f = c_strtod (text, &endptr);
410 if ( errno != 0 || endptr == text)
419 xmlChar *first_value;
424 gnumeric_destroy (struct spreadsheet *s)
426 struct gnumeric_reader *r = (struct gnumeric *) s;
427 gnm_file_casereader_destroy (NULL, s);
431 static struct gnumeric_reader *
432 gnumeric_reopen (struct gnumeric_reader *r, const char *filename)
436 xmlTextReaderPtr xtr;
439 assert (r == NULL || filename == NULL);
442 xmlFreeTextReader (r->xtr);
445 gz = gzopen (filename, "r");
447 gz = gzopen ( r->spreadsheet.file_name, "r");
452 xtr = xmlReaderForIO ((xmlInputReadCallback) gzread,
453 (xmlInputCloseCallback) gzclose, gz,
463 r = xzalloc (sizeof *r);
466 r->spreadsheet.sheets = -1;
467 r->state = STATE_PRE_INIT;
469 r->target_sheet = NULL;
470 r->target_sheet_index = -1;
473 /* Advance to the start of the workbook.
474 This gives us some confidence that we are actually dealing with a gnumeric
477 while ( (r->state != STATE_INIT )
478 && 1 == (ret = xmlTextReaderRead (r->xtr)))
483 r->spreadsheet.type = SPREADSHEET_GNUMERIC;
486 r->spreadsheet.file_name = filename;
493 gnumeric_probe (const char *filename)
495 struct gnumeric_reader *r = NULL;
497 r = gnumeric_reopen (r, filename);
499 return &r->spreadsheet;
504 gnumeric_make_reader (struct spreadsheet *spreadsheet,
505 const struct spreadsheet_read_info *gri,
506 struct spreadsheet_read_options *opts)
508 struct gnumeric_reader *r = NULL;
509 unsigned long int vstart = 0;
511 casenumber n_cases = CASENUMBER_MAX;
513 struct var_spec *var_spec = NULL;
516 r = (struct gnumeric_reader *) (spreadsheet);
518 if ( opts->cell_range )
520 if ( ! convert_cell_ref (opts->cell_range,
521 &r->start_col, &r->start_row,
522 &r->stop_col, &r->stop_row))
524 msg (SE, _("Invalid cell range `%s'"),
537 r->target_sheet = BAD_CAST opts->sheet_name;
538 r->target_sheet_index = opts->sheet_index;
539 r->row = r->col = -1;
542 /* Advance to the start of the cells for the target sheet */
543 while ( (r->state != STATE_CELL || r->row < r->start_row )
544 && 1 == (ret = xmlTextReaderRead (r->xtr)))
548 value = xmlTextReaderValue (r->xtr);
550 if ( r->state == STATE_MAXROW && r->node_type == XML_READER_TYPE_TEXT)
552 n_cases = 1 + _xmlchar_to_int (value) ;
557 /* If a range has been given, then use that to calculate the number
559 if ( opts->cell_range)
561 n_cases = MIN (n_cases, r->stop_row - r->start_row + 1);
564 if ( gri->read_names )
570 /* Read in the first row of cells,
571 including the headers if read_names was set */
573 (( r->state == STATE_CELLS_START && r->row <= r->start_row) || r->state == STATE_CELL )
574 && (ret = xmlTextReaderRead (r->xtr))
580 if ( r->row > r->start_row ) break;
582 if ( r->col < r->start_col ||
583 (r->stop_col != -1 && r->col > r->stop_col))
586 idx = r->col - r->start_col;
588 if ( idx >= n_var_specs )
591 var_spec = xrealloc (var_spec, sizeof (*var_spec) * (idx + 1));
592 for (i = n_var_specs; i <= idx; ++i)
594 var_spec [i].name = NULL;
595 var_spec [i].width = -1;
596 var_spec [i].first_value = NULL;
598 n_var_specs = idx + 1 ;
601 if ( r->node_type == XML_READER_TYPE_TEXT )
603 xmlChar *value = xmlTextReaderValue (r->xtr);
604 const char *text = CHAR_CAST (const char *, value);
606 if ( r->row < r->start_row)
608 if ( gri->read_names )
610 var_spec [idx].name = xstrdup (text);
615 var_spec [idx].first_value = xmlStrdup (value);
617 if (-1 == var_spec [idx].width )
618 var_spec [idx].width = (gri->asw == -1) ?
619 ROUND_UP (strlen(text), SPREADSHEET_DEFAULT_WIDTH) : gri->asw;
624 else if ( r->node_type == XML_READER_TYPE_ELEMENT
625 && r->state == STATE_CELL)
627 if ( r->row == r->start_row )
630 xmlTextReaderGetAttribute (r->xtr, _xml ("ValueType"));
632 if ( NULL == attr || 60 != _xmlchar_to_int (attr))
633 var_spec [idx].width = 0;
641 const xmlChar *enc = xmlTextReaderConstEncoding (r->xtr);
644 /* Create the dictionary and populate it */
645 spreadsheet->dict = r->dict = dict_create (CHAR_CAST (const char *, enc));
648 for (i = 0 ; i < n_var_specs ; ++i )
652 if ( (var_spec[i].name == NULL) && (var_spec[i].first_value == NULL))
655 /* Probably no data exists for this variable, so allocate a
657 if ( var_spec[i].width == -1 )
658 var_spec[i].width = SPREADSHEET_DEFAULT_WIDTH;
660 name = dict_make_unique_var_name (r->dict, var_spec[i].name, &vstart);
661 dict_create_var (r->dict, name, var_spec[i].width);
665 /* Create the first case, and cache it */
666 r->used_first_case = false;
668 if ( n_var_specs == 0 )
670 msg (MW, _("Selected sheet or range of spreadsheet `%s' is empty."),
671 spreadsheet->file_name);
675 r->proto = caseproto_ref (dict_get_proto (r->dict));
676 r->first_case = case_create (r->proto);
677 case_set_missing (r->first_case);
680 for ( i = 0 ; i < n_var_specs ; ++i )
682 if ( (var_spec[i].name == NULL) && (var_spec[i].first_value == NULL))
685 const struct variable *var = dict_get_var (r->dict, x++);
687 convert_xml_string_to_value (r->first_case, var,
688 var_spec[i].first_value);
691 for ( i = 0 ; i < n_var_specs ; ++i )
693 free (var_spec[i].first_value);
694 free (var_spec[i].name);
700 if (opts->cell_range == NULL)
702 opts->cell_range = c_xasprintf ("%c%d:%c%ld",
705 r->stop_col + 'A' + caseproto_get_n_widths (r->proto),
706 r->start_row + n_cases);
709 return casereader_create_sequential
713 &gnm_file_casereader_class, r);
717 for ( i = 0 ; i < n_var_specs ; ++i )
719 free (var_spec[i].first_value);
720 free (var_spec[i].name);
724 dict_destroy (spreadsheet->dict);
725 spreadsheet->dict = NULL;
727 gnm_file_casereader_destroy (NULL, r);
733 /* Reads and returns one case from READER's file. Returns a null
734 pointer on failure. */
735 static struct ccase *
736 gnm_file_casereader_read (struct casereader *reader UNUSED, void *r_)
741 struct gnumeric_reader *r = r_;
742 int current_row = r->row;
744 if ( !r->used_first_case )
746 r->used_first_case = true;
747 return r->first_case;
750 c = case_create (r->proto);
751 case_set_missing (c);
753 if (r->start_col == -1)
754 r->start_col = r->min_col;
756 while ((r->state == STATE_CELL || r->state == STATE_CELLS_START )
757 && r->row == current_row && (ret = xmlTextReaderRead (r->xtr)))
761 if ( r->col < r->start_col || (r->stop_col != -1 &&
762 r->col > r->stop_col))
765 if ( r->col - r->start_col >= caseproto_get_n_widths (r->proto))
768 if ( r->stop_row != -1 && r->row > r->stop_row)
771 if ( r->node_type == XML_READER_TYPE_TEXT )
773 xmlChar *value = xmlTextReaderValue (r->xtr);
775 const int idx = r->col - r->start_col;
777 const struct variable *var = dict_get_var (r->dict, idx);
779 convert_xml_string_to_value (c, var, value);
796 #endif /* GNM_SUPPORT */