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