Added a second lot of state data
[pspp] / src / data / gnumeric-reader.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2007, 2009, 2010, 2011, 2012, 2013  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 #include <config.h>
18
19 #include "libpspp/message.h"
20 #include "libpspp/misc.h"
21
22 #include "gl/minmax.h"
23 #include "gl/c-strtod.h"
24
25 #include "gettext.h"
26 #define _(msgid) gettext (msgid)
27 #define N_(msgid) (msgid)
28
29 #include "spreadsheet-reader.h"
30
31 #if !GNM_SUPPORT
32
33 struct casereader *
34 gnumeric_open_reader (const struct spreadsheet_read_options *opts, struct dictionary **dict)
35 {
36   msg (ME, _("Support for %s files was not compiled into this installation of PSPP"), "Gnumeric");
37
38   return NULL;
39 }
40
41 #else
42
43 #include "data/gnumeric-reader.h"
44
45 #include <assert.h>
46 #include <stdbool.h>
47 #include <errno.h>
48 #include <libxml/xmlreader.h>
49 #include <zlib.h>
50
51 #include "data/case.h"
52 #include "data/casereader-provider.h"
53 #include "data/dictionary.h"
54 #include "data/identifier.h"
55 #include "data/value.h"
56 #include "data/variable.h"
57 #include "libpspp/i18n.h"
58 #include "libpspp/str.h"
59
60 #include "gl/xalloc.h"
61
62 static void gnm_file_casereader_destroy (struct casereader *, void *);
63
64 static struct ccase *gnm_file_casereader_read (struct casereader *, void *);
65
66
67 static const struct casereader_class gnm_file_casereader_class =
68   {
69     gnm_file_casereader_read,
70     gnm_file_casereader_destroy,
71     NULL,
72     NULL,
73   };
74
75 enum reader_state
76   {
77     STATE_PRE_INIT = 0,        /* Initial state */
78     STATE_SHEET_COUNT,      /* Found the sheet index */
79     STATE_INIT ,           /* Other Initial state */
80     STATE_SHEET_START,     /* Found the start of a sheet */
81     STATE_SHEET_NAME,      /* Found the sheet name */
82     STATE_MAXROW,
83     STATE_MAXCOL,
84     STATE_SHEET_FOUND,     /* Found the sheet that we actually want */
85     STATE_CELLS_START,     /* Found the start of the cell array */
86     STATE_CELL             /* Found a cell */
87   };
88
89 struct sheet_detail
90 {
91   /* The name of the sheet (utf8 encoding) */
92   char *name;
93
94   int start_col;
95   int stop_col;
96   int start_row;
97   int stop_row;
98
99   int maxcol;
100   int maxrow;
101 };
102
103 struct state_data 
104 {
105   /* The libxml reader for this instance */
106   xmlTextReaderPtr xtr;
107
108   /* An internal state variable */
109   enum reader_state state;
110
111   int node_type;
112   int current_sheet;
113
114   int row;
115   int col;
116
117   int min_col;
118 };
119
120 struct gnumeric_reader
121 {
122   struct spreadsheet spreadsheet;
123   int ref_cnt;
124
125   struct state_data rsd;
126   struct state_data msd;
127
128   int start_col;
129   int stop_col;
130   int start_row;
131   int stop_row;
132   
133   struct sheet_detail *sheets;
134
135   const xmlChar *target_sheet;
136   int target_sheet_index;
137
138   struct caseproto *proto;
139   struct dictionary *dict;
140   struct ccase *first_case;
141   bool used_first_case;
142 };
143
144
145 void
146 gnumeric_destroy (struct spreadsheet *s)
147 {
148   struct gnumeric_reader *r = (struct gnumeric_reader *) s;
149
150 #if 0
151   if (0 == --r->ref_cnt)
152     {
153       int i;
154
155       for (i = 0; i < s->n_sheets; ++i)
156         {
157           xmlFree (r->sheets[i].name);
158         }
159     
160       free (r->sheets);
161
162       free (r);
163     }
164 #endif
165 }
166
167
168 const char *
169 gnumeric_get_sheet_name (struct spreadsheet *s, int n)
170 {
171   struct gnumeric_reader *gr = (struct gnumeric_reader *) s;
172   assert (n < s->n_sheets);
173
174   return gr->sheets[n].name; 
175 }
176
177
178 static void process_node (struct gnumeric_reader *r, struct state_data *sd);
179
180
181
182 char *
183 gnumeric_get_sheet_range (struct spreadsheet *s, int n)
184 {
185   int ret;
186   struct gnumeric_reader *gr = (struct gnumeric_reader *) s;
187   
188   assert (n < s->n_sheets);
189
190   while ( 
191          (gr->sheets[n].stop_col == -1)
192          && 
193          (1 == (ret = xmlTextReaderRead (gr->msd.xtr)))
194           )
195     {
196       process_node (gr, &gr->msd);
197     }
198
199   return create_cell_ref (
200                           gr->sheets[n].start_col,
201                           gr->sheets[n].start_row,
202                           gr->sheets[n].stop_col,
203                           gr->sheets[n].stop_row);
204 }
205
206
207 static void
208 gnm_file_casereader_destroy (struct casereader *reader UNUSED, void *r_)
209 {
210   struct gnumeric_reader *r = r_;
211
212   if ( r == NULL)
213         return ;
214
215 #if 0
216   if ( r->rsd.xtr)
217     xmlFreeTextReader (r->rsd.xtr);
218   r->rsd.xtr = NULL;
219
220   if ( ! r->used_first_case )
221     case_unref (r->first_case);
222
223   caseproto_unref (r->proto);
224
225   gnumeric_destroy (&r->spreadsheet);
226 #endif
227 }
228
229
230 static void
231 process_node (struct gnumeric_reader *r, struct state_data *sd)
232 {
233   xmlChar *name = xmlTextReaderName (sd->xtr);
234   if (name == NULL)
235     name = xmlStrdup (_xml ("--"));
236
237   sd->node_type = xmlTextReaderNodeType (sd->xtr);
238
239   switch (sd->state)
240     {
241     case STATE_PRE_INIT:
242       sd->current_sheet = -1;
243       if (0 == xmlStrcasecmp (name, _xml("gnm:SheetNameIndex")) &&
244           XML_READER_TYPE_ELEMENT  == sd->node_type)
245         {
246           sd->state = STATE_SHEET_COUNT;
247         }
248       break;
249
250     case STATE_SHEET_COUNT:
251       if (0 == xmlStrcasecmp (name, _xml("gnm:SheetName")) &&
252           XML_READER_TYPE_ELEMENT  == sd->node_type)
253         {
254           ++sd->current_sheet;
255           if (sd->current_sheet + 1 > r->spreadsheet.n_sheets)
256             {
257               struct sheet_detail *detail ;
258               r->sheets = xrealloc (r->sheets, (sd->current_sheet + 1) * sizeof *r->sheets);
259               detail = &r->sheets[sd->current_sheet];
260               detail->start_col = detail->stop_col = detail->start_row = detail->stop_row = -1;
261               r->spreadsheet.n_sheets = sd->current_sheet + 1;
262             }
263         }
264       else if (0 == xmlStrcasecmp (name, _xml("gnm:SheetNameIndex")) &&
265           XML_READER_TYPE_END_ELEMENT  == sd->node_type)
266         {
267           sd->state = STATE_INIT;
268           sd->current_sheet = -1;
269         }
270       else if (XML_READER_TYPE_TEXT == sd->node_type)
271         {
272           r->sheets [r->spreadsheet.n_sheets - 1].name = CHAR_CAST (char *, xmlTextReaderValue (sd->xtr));
273         }
274       break;
275
276     case STATE_INIT:
277       if (0 == xmlStrcasecmp (name, _xml("gnm:Sheet")) &&
278           XML_READER_TYPE_ELEMENT  == sd->node_type)
279         {
280           ++sd->current_sheet;
281           sd->state = STATE_SHEET_START;
282         }
283       break;
284     case STATE_SHEET_START:
285       if (0 == xmlStrcasecmp (name, _xml("gnm:Name"))  &&
286           XML_READER_TYPE_ELEMENT  == sd->node_type)
287         {
288           sd->state = STATE_SHEET_NAME;
289         }
290       break;
291     case STATE_SHEET_NAME:
292       if (0 == xmlStrcasecmp (name, _xml("gnm:Name"))  &&
293           XML_READER_TYPE_END_ELEMENT  == sd->node_type)
294         {
295           sd->state = STATE_INIT;
296         }
297       else if (0 == xmlStrcasecmp (name, _xml("gnm:Sheet"))  &&
298           XML_READER_TYPE_END_ELEMENT  == sd->node_type)
299         {
300           sd->state = STATE_INIT;
301         }
302       else if (XML_READER_TYPE_TEXT == sd->node_type)
303         {
304           if ( r->target_sheet != NULL)
305             {
306               xmlChar *value = xmlTextReaderValue (sd->xtr);
307               if ( 0 == xmlStrcmp (value, r->target_sheet))
308                 sd->state = STATE_SHEET_FOUND;
309               free (value);
310             }
311           else if (r->target_sheet_index == sd->current_sheet + 1)
312             {
313               sd->state = STATE_SHEET_FOUND;
314             }
315           else if (r->target_sheet_index == -1)
316             {
317               sd->state = STATE_SHEET_FOUND;
318             }
319         }
320       break;
321     case STATE_SHEET_FOUND:
322       if (0 == xmlStrcasecmp (name, _xml("gnm:Cells"))  &&
323           XML_READER_TYPE_ELEMENT  == sd->node_type)
324         {
325           sd->min_col = INT_MAX;
326           if (! xmlTextReaderIsEmptyElement (sd->xtr))
327             sd->state = STATE_CELLS_START;
328         }
329       else if (0 == xmlStrcasecmp (name, _xml("gnm:MaxRow"))  &&
330           XML_READER_TYPE_ELEMENT  == sd->node_type)
331         {
332           sd->state = STATE_MAXROW;
333         }
334       else if (0 == xmlStrcasecmp (name, _xml("gnm:MaxCol"))  &&
335           XML_READER_TYPE_ELEMENT  == sd->node_type)
336         {
337           sd->state = STATE_MAXCOL;
338         }
339       else if (0 == xmlStrcasecmp (name, _xml("gnm:Sheet"))  &&
340           XML_READER_TYPE_END_ELEMENT  == sd->node_type)
341         {
342           sd->state = STATE_INIT;
343         }
344       break;
345     case STATE_MAXROW:
346       if (0 == xmlStrcasecmp (name, _xml("gnm:MaxRow"))  &&
347           XML_READER_TYPE_END_ELEMENT  == sd->node_type)
348         {
349           sd->state = STATE_SHEET_FOUND;
350         }
351       else if (sd->node_type == XML_READER_TYPE_TEXT)
352         {
353           xmlChar *value = xmlTextReaderValue (sd->xtr);
354           r->sheets[sd->current_sheet].maxrow = _xmlchar_to_int (value);
355           xmlFree (value);
356         }
357       break;
358     case STATE_MAXCOL:
359       if (0 == xmlStrcasecmp (name, _xml("gnm:MaxCol"))  &&
360           XML_READER_TYPE_END_ELEMENT  == sd->node_type)
361         {
362           sd->state = STATE_SHEET_FOUND;
363         }
364       else if (sd->node_type == XML_READER_TYPE_TEXT)
365         {
366           xmlChar *value = xmlTextReaderValue (sd->xtr);
367           r->sheets[sd->current_sheet].maxcol = _xmlchar_to_int (value);
368           xmlFree (value);
369         }
370       break;
371     case STATE_CELLS_START:
372       if (0 == xmlStrcasecmp (name, _xml ("gnm:Cell"))  &&
373           XML_READER_TYPE_ELEMENT  == sd->node_type)
374         {
375           xmlChar *attr = NULL;
376
377           attr = xmlTextReaderGetAttribute (sd->xtr, _xml ("Col"));
378           sd->col =  _xmlchar_to_int (attr);
379           free (attr);
380
381           if (sd->col < sd->min_col)
382             sd->min_col = sd->col;
383
384           attr = xmlTextReaderGetAttribute (sd->xtr, _xml ("Row"));
385           sd->row = _xmlchar_to_int (attr);
386           free (attr);
387
388           if (r->sheets[sd->current_sheet].start_row == -1)
389             {
390               r->sheets[sd->current_sheet].start_row = sd->row;
391             }
392
393           if (r->sheets[sd->current_sheet].start_col == -1)
394             {
395               r->sheets[sd->current_sheet].start_col = sd->col;
396             }
397           if (! xmlTextReaderIsEmptyElement (sd->xtr))
398             sd->state = STATE_CELL;
399         }
400       else if ( (0 == xmlStrcasecmp (name, _xml("gnm:Cells")))  &&  (XML_READER_TYPE_END_ELEMENT  == sd->node_type) )
401         {
402           r->sheets[sd->current_sheet].stop_col = sd->col;
403           r->sheets[sd->current_sheet].stop_row = sd->row;
404           sd->state = STATE_SHEET_NAME;
405         }
406       break;
407     case STATE_CELL:
408       if (0 == xmlStrcasecmp (name, _xml("gnm:Cell"))  && XML_READER_TYPE_END_ELEMENT  == sd->node_type)
409         {
410           sd->state = STATE_CELLS_START;
411         }
412       break;
413     default:
414       break;
415     };
416
417   xmlFree (name);
418 }
419
420
421 /*
422    Sets the VAR of case C, to the value corresponding to the xml string XV
423  */
424 static void
425 convert_xml_string_to_value (struct ccase *c, const struct variable *var,
426                              const xmlChar *xv)
427 {
428   union value *v = case_data_rw (c, var);
429
430   if (xv == NULL)
431     value_set_missing (v, var_get_width (var));
432   else if ( var_is_alpha (var))
433     value_copy_str_rpad (v, var_get_width (var), xv, ' ');
434   else
435     {
436       const char *text = CHAR_CAST (const char *, xv);
437       char *endptr;
438
439       errno = 0;
440       v->f = c_strtod (text, &endptr);
441       if ( errno != 0 || endptr == text)
442         v->f = SYSMIS;
443     }
444 }
445
446 struct var_spec
447 {
448   char *name;
449   int width;
450   xmlChar *first_value;
451 };
452
453
454 static void
455 gnumeric_error_handler (void *ctx, const char *mesg,
456                         UNUSED xmlParserSeverities sev, xmlTextReaderLocatorPtr loc)
457 {
458   struct gnumeric_reader *r = ctx;
459        
460   msg (MW, _("There was a problem whilst reading the %s file `%s' (near line %d): `%s'"),
461        "Gnumeric",
462        r->spreadsheet.file_name,
463        xmlTextReaderLocatorLineNumber (loc),
464        mesg);
465 }
466
467 static struct gnumeric_reader *
468 gnumeric_reopen (struct gnumeric_reader *r, const char *filename, bool show_errors)
469 {  
470   int ret;
471   struct state_data *sd;//  = filename ? &r->msd : &r->rsd;
472
473   xmlTextReaderPtr xtr;
474   gzFile gz;
475
476   assert (r == NULL || filename == NULL);
477
478   if (filename)
479     {
480       gz = gzopen (filename, "r");
481     }
482   else
483     {
484       gz = gzopen (r->spreadsheet.file_name, "r");
485     }
486
487   if (NULL == gz)
488     return NULL;
489
490
491   xtr = xmlReaderForIO ((xmlInputReadCallback) gzread,
492                         (xmlInputCloseCallback) gzclose, gz,
493                         NULL, NULL,
494                         show_errors ? 0 : (XML_PARSE_NOERROR | XML_PARSE_NOWARNING) );
495
496   if (xtr == NULL)
497     {
498       gzclose (gz);
499       return NULL;
500     }
501
502   if (r == NULL)
503     {
504       r = xzalloc (sizeof *r);
505       r->spreadsheet.n_sheets = -1;
506       r->spreadsheet.file_name = filename;
507       sd = &r->msd;
508     }
509   else
510     {
511       sd = &r->rsd;
512     }
513   
514   if (show_errors) 
515     xmlTextReaderSetErrorHandler (xtr, gnumeric_error_handler, r);
516
517   r->target_sheet = NULL;
518   r->target_sheet_index = -1;
519
520   sd->row = sd->col = -1;
521   sd->state = STATE_PRE_INIT;
522   sd->xtr = xtr;
523   r->ref_cnt++;
524
525   /* Advance to the start of the workbook.
526      This gives us some confidence that we are actually dealing with a gnumeric
527      spreadsheet.
528    */
529   while ( (sd->state != STATE_INIT )
530           && 1 == (ret = xmlTextReaderRead (sd->xtr)))
531     {
532       process_node (r, sd);
533     }
534
535
536   if ( ret != 1)
537     {
538       /* Does not seem to be a gnumeric file */
539       xmlFreeTextReader (sd->xtr);
540       free (r);
541       return NULL;
542     }
543
544   r->spreadsheet.type = SPREADSHEET_GNUMERIC;
545
546   if (show_errors)
547     {
548       const xmlChar *enc = xmlTextReaderConstEncoding (sd->xtr);
549       xmlCharEncoding xce = xmlParseCharEncoding (CHAR_CAST (const char *, enc));
550
551       if ( XML_CHAR_ENCODING_UTF8 != xce)
552         {
553           /* I have been told that ALL gnumeric files are UTF8 encoded.  If that is correct, this 
554              can never happen. */
555           msg (MW, _("The gnumeric file `%s' is encoded as %s instead of the usual UTF-8 encoding. "
556                      "Any non-ascii characters will be incorrectly imported."),
557                r->spreadsheet.file_name,
558                enc);
559         }
560     }
561
562   return r;
563 }
564
565
566 struct spreadsheet *
567 gnumeric_probe (const char *filename, bool report_errors)
568 {
569   struct gnumeric_reader *r = gnumeric_reopen (NULL, filename, report_errors);
570
571   return &r->spreadsheet;
572 }
573
574
575 struct casereader *
576 gnumeric_make_reader (struct spreadsheet *spreadsheet,
577                       const struct spreadsheet_read_options *opts)
578 {
579   int x = 0;
580   struct gnumeric_reader *r = NULL;
581   unsigned long int vstart = 0;
582   int ret;
583   casenumber n_cases = CASENUMBER_MAX;
584   int i;
585   struct var_spec *var_spec = NULL;
586   int n_var_specs = 0;
587
588   r = (struct gnumeric_reader *) (spreadsheet);
589
590   if (r->rsd.row != -1)
591     r = gnumeric_reopen (r, NULL, true);
592
593
594
595   if ( opts->cell_range )
596     {
597       if ( ! convert_cell_ref (opts->cell_range,
598                                &r->start_col, &r->start_row,
599                                &r->stop_col, &r->stop_row))
600         {
601           msg (SE, _("Invalid cell range `%s'"),
602                opts->cell_range);
603           goto error;
604         }
605     }
606   else
607     {
608       r->start_col = -1;
609       r->start_row = 0;
610       r->stop_col = -1;
611       r->stop_row = -1;
612     }
613
614   r->target_sheet = BAD_CAST opts->sheet_name;
615   r->target_sheet_index = opts->sheet_index;
616   r->rsd.row = r->rsd.col = -1;
617   r->rsd.current_sheet = -1;
618
619   /* Advance to the start of the cells for the target sheet */
620   while ( (r->rsd.state != STATE_CELL || r->rsd.row < r->start_row )
621           && 1 == (ret = xmlTextReaderRead (r->rsd.xtr)))
622     {
623       xmlChar *value ;
624       process_node (r, &r->rsd);
625       value = xmlTextReaderValue (r->rsd.xtr);
626
627       if ( r->rsd.state == STATE_MAXROW  && r->rsd.node_type == XML_READER_TYPE_TEXT)
628         {
629           n_cases = 1 + _xmlchar_to_int (value) ;
630         }
631       free (value);
632     }
633
634   /* If a range has been given, then  use that to calculate the number
635      of cases */
636   if ( opts->cell_range)
637     {
638       n_cases = MIN (n_cases, r->stop_row - r->start_row + 1);
639     }
640
641   if ( opts->read_names )
642     {
643       r->start_row++;
644       n_cases --;
645     }
646
647   /* Read in the first row of cells,
648      including the headers if read_names was set */
649   while (
650          (( r->rsd.state == STATE_CELLS_START && r->rsd.row <= r->start_row) || r->rsd.state == STATE_CELL )
651          && (ret = xmlTextReaderRead (r->rsd.xtr))
652          )
653     {
654       int idx;
655       process_node (r, &r->rsd);
656
657       if ( r->rsd.row > r->start_row ) break;
658
659       if ( r->rsd.col < r->start_col ||
660            (r->stop_col != -1 && r->rsd.col > r->stop_col))
661         continue;
662
663       idx = r->rsd.col - r->start_col;
664
665       if ( idx  >= n_var_specs )
666         {
667           int i;
668           var_spec = xrealloc (var_spec, sizeof (*var_spec) * (idx + 1));
669           for (i = n_var_specs; i <= idx; ++i)
670           {
671             var_spec [i].name = NULL;
672             var_spec [i].width = -1;
673             var_spec [i].first_value = NULL;
674           }
675           n_var_specs =  idx + 1 ;
676         }
677
678       if ( r->rsd.node_type == XML_READER_TYPE_TEXT )
679         {
680           xmlChar *value = xmlTextReaderValue (r->rsd.xtr);
681           const char *text  = CHAR_CAST (const char *, value);
682
683           if ( r->rsd.row < r->start_row)
684             {
685               if ( opts->read_names )
686                 {
687                   var_spec [idx].name = xstrdup (text);
688                 }
689             }
690           else
691             {
692               var_spec [idx].first_value = xmlStrdup (value);
693
694               if (-1 ==  var_spec [idx].width )
695                 var_spec [idx].width = (opts->asw == -1) ?
696                   ROUND_UP (strlen(text), SPREADSHEET_DEFAULT_WIDTH) : opts->asw;
697             }
698
699           free (value);
700         }
701       else if ( r->rsd.node_type == XML_READER_TYPE_ELEMENT
702                 && r->rsd.state == STATE_CELL)
703         {
704           if ( r->rsd.row == r->start_row )
705             {
706               xmlChar *attr =
707                 xmlTextReaderGetAttribute (r->rsd.xtr, _xml ("ValueType"));
708
709               if ( NULL == attr || 60 !=  _xmlchar_to_int (attr))
710                 var_spec [idx].width = 0;
711
712               free (attr);
713             }
714         }
715     }
716
717   {
718     const xmlChar *enc = xmlTextReaderConstEncoding (r->rsd.xtr);
719     if ( enc == NULL)
720       goto error;
721     /* Create the dictionary and populate it */
722     spreadsheet->dict = r->dict = dict_create (CHAR_CAST (const char *, enc));
723   }
724
725   for (i = 0 ; i < n_var_specs ; ++i )
726     {
727       char *name;
728
729       if ( (var_spec[i].name == NULL) && (var_spec[i].first_value == NULL))
730         continue;
731
732       /* Probably no data exists for this variable, so allocate a
733          default width */
734       if ( var_spec[i].width == -1 )
735         var_spec[i].width = SPREADSHEET_DEFAULT_WIDTH;
736
737       name = dict_make_unique_var_name (r->dict, var_spec[i].name, &vstart);
738       dict_create_var (r->dict, name, var_spec[i].width);
739       free (name);
740     }
741
742   /* Create the first case, and cache it */
743   r->used_first_case = false;
744
745   if ( n_var_specs ==  0 )
746     {
747       msg (MW, _("Selected sheet or range of spreadsheet `%s' is empty."),
748            spreadsheet->file_name);
749       goto error;
750     }
751
752   r->proto = caseproto_ref (dict_get_proto (r->dict));
753   r->first_case = case_create (r->proto);
754   case_set_missing (r->first_case);
755
756
757   for ( i = 0 ; i < n_var_specs ; ++i )
758     {
759       const struct variable *var;
760
761       if ( (var_spec[i].name == NULL) && (var_spec[i].first_value == NULL))
762         continue;
763
764       var = dict_get_var (r->dict, x++);
765
766       convert_xml_string_to_value (r->first_case, var,
767                                    var_spec[i].first_value);
768     }
769
770   for ( i = 0 ; i < n_var_specs ; ++i )
771     {
772       free (var_spec[i].first_value);
773       free (var_spec[i].name);
774     }
775
776   free (var_spec);
777   
778
779   return casereader_create_sequential
780     (NULL,
781      r->proto,
782      n_cases,
783      &gnm_file_casereader_class, r);
784
785
786  error:
787   for ( i = 0 ; i < n_var_specs ; ++i )
788     {
789       free (var_spec[i].first_value);
790       free (var_spec[i].name);
791     }
792
793   free (var_spec);
794   dict_destroy (spreadsheet->dict);
795   spreadsheet->dict = NULL;
796
797   gnm_file_casereader_destroy (NULL, r);
798
799   return NULL;
800 };
801
802
803 /* Reads and returns one case from READER's file.  Returns a null
804    pointer on failure. */
805 static struct ccase *
806 gnm_file_casereader_read (struct casereader *reader UNUSED, void *r_)
807 {
808   struct ccase *c;
809   int ret = 0;
810
811   struct gnumeric_reader *r = r_;
812   int current_row = r->rsd.row;
813
814   if ( !r->used_first_case )
815     {
816       r->used_first_case = true;
817       return r->first_case;
818     }
819
820   c = case_create (r->proto);
821   case_set_missing (c);
822
823   if (r->start_col == -1)
824     r->start_col = r->rsd.min_col;
825
826   while ((r->rsd.state == STATE_CELL || r->rsd.state == STATE_CELLS_START )
827          && r->rsd.row == current_row && (ret = xmlTextReaderRead (r->rsd.xtr)))
828     {
829       process_node (r, &r->rsd);
830
831       if ( r->rsd.col < r->start_col || (r->stop_col != -1 &&
832                                      r->rsd.col > r->stop_col))
833         continue;
834
835       if ( r->rsd.col - r->start_col >= caseproto_get_n_widths (r->proto))
836         continue;
837
838       if ( r->stop_row != -1 && r->rsd.row > r->stop_row)
839         break;
840
841       if ( r->rsd.node_type == XML_READER_TYPE_TEXT )
842         {
843           xmlChar *value = xmlTextReaderValue (r->rsd.xtr);
844
845           const int idx = r->rsd.col - r->start_col;
846
847           const struct variable *var = dict_get_var (r->dict, idx);
848
849           convert_xml_string_to_value (c, var, value);
850
851           free (value);
852         }
853
854     }
855
856   if (ret == 1)
857     return c;
858   else
859     {
860       case_unref (c);
861       return NULL;
862     }
863 }
864
865
866 #endif /* GNM_SUPPORT */