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