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