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