Make the gnumeric reader behave the same as the odsreader
[pspp] / src / data / gnumeric-reader.c
index 1b8357fa9d91c170d4a41d0ad31ce0e23440fdbc..9193cfb061c4949be89b8467877174bcbf1a0264 100644 (file)
 
 #include "spreadsheet-reader.h"
 
-#include "c-xvasprintf.h"
-
 #if !GNM_SUPPORT
 
 struct casereader *
-gnumeric_open_reader (struct spreadsheet_read_info *gri, struct spreadsheet_read_options *opts, struct dictionary **dict)
+gnumeric_open_reader (const struct spreadsheet_read_options *opts, struct dictionary **dict)
 {
   msg (ME, _("Support for %s files was not compiled into this installation of PSPP"), "Gnumeric");
 
@@ -65,6 +63,7 @@ static void gnm_file_casereader_destroy (struct casereader *, void *);
 
 static struct ccase *gnm_file_casereader_read (struct casereader *, void *);
 
+
 static const struct casereader_class gnm_file_casereader_class =
   {
     gnm_file_casereader_read,
@@ -89,7 +88,8 @@ enum reader_state
 
 struct sheet_detail
 {
-  xmlChar *name;
+  /* The name of the sheet (utf8 encoding) */
+  char *name;
 
   int start_col;
   int stop_col;
@@ -104,6 +104,7 @@ struct sheet_detail
 struct gnumeric_reader
 {
   struct spreadsheet spreadsheet;
+  int ref_cnt;
 
   /* The libxml reader for this instance */
   xmlTextReaderPtr xtr;
@@ -115,7 +116,7 @@ struct gnumeric_reader
   int col;
   int min_col;
   int node_type;
-  int sheet_index;
+  int current_sheet;
 
   int start_col;
   int stop_col;
@@ -134,26 +135,51 @@ struct gnumeric_reader
 };
 
 
+void
+gnumeric_destroy (struct spreadsheet *s)
+{
+  struct gnumeric_reader *r = (struct gnumeric_reader *) s;
+
+
+#if 0
+  if (0 == --r->ref_cnt)
+    {
+      int i;
+
+      for (i = 0; i < s->n_sheets; ++i)
+       {
+         xmlFree (r->sheets[i].name);
+       }
+    
+      free (r->sheets);
+
+      free (r);
+    }
+#endif
+}
+
+
 const char *
 gnumeric_get_sheet_name (struct spreadsheet *s, int n)
 {
   struct gnumeric_reader *gr = (struct gnumeric_reader *) s;
-  assert (n < s->sheets);
+  assert (n < s->n_sheets);
 
-  return gr->sheets[n].name;
+  return gr->sheets[n].name; 
 }
 
 
 static void process_node (struct gnumeric_reader *r);
 
 
+
 char *
 gnumeric_get_sheet_range (struct spreadsheet *s, int n)
 {
   int ret;
   struct gnumeric_reader *gr = (struct gnumeric_reader *) s;
   
-  assert (n < s->sheets);
+  assert (n < s->n_sheets);
 
   while ( 
         (gr->sheets[n].stop_col == -1)
@@ -164,7 +190,6 @@ gnumeric_get_sheet_range (struct spreadsheet *s, int n)
       process_node (gr);
     }
 
-
   return create_cell_ref (
                          gr->sheets[n].start_col,
                          gr->sheets[n].start_row,
@@ -176,29 +201,26 @@ gnumeric_get_sheet_range (struct spreadsheet *s, int n)
 static void
 gnm_file_casereader_destroy (struct casereader *reader UNUSED, void *r_)
 {
-  int i;
   struct gnumeric_reader *r = r_;
+
   if ( r == NULL)
        return ;
 
+#if 0
   if ( r->xtr)
     xmlFreeTextReader (r->xtr);
+  r->xtr = NULL;
 
   if ( ! r->used_first_case )
     case_unref (r->first_case);
 
   caseproto_unref (r->proto);
 
-  for (i = 0; i < r->spreadsheet.sheets; ++i)
-    {
-      xmlFree (r->sheets[i].name);
-    }
-    
-  free (r->sheets);
-
-  free (r);
+  gnumeric_destroy (&r->spreadsheet);
+#endif
 }
 
+
 static void
 process_node (struct gnumeric_reader *r)
 {
@@ -206,18 +228,16 @@ process_node (struct gnumeric_reader *r)
   if (name == NULL)
     name = xmlStrdup (_xml ("--"));
 
-
   r->node_type = xmlTextReaderNodeType (r->xtr);
 
-  switch ( r->state)
+  switch (r->state)
     {
     case STATE_PRE_INIT:
-      r->sheet_index = -1;
+      r->current_sheet = -1;
       if (0 == xmlStrcasecmp (name, _xml("gnm:SheetNameIndex")) &&
          XML_READER_TYPE_ELEMENT  == r->node_type)
        {
          r->state = STATE_SHEET_COUNT;
-         r->spreadsheet.sheets = 0;
        }
       break;
 
@@ -225,20 +245,25 @@ process_node (struct gnumeric_reader *r)
       if (0 == xmlStrcasecmp (name, _xml("gnm:SheetName")) &&
          XML_READER_TYPE_ELEMENT  == r->node_type)
        {
-         struct sheet_detail *sd ;
-         r->spreadsheet.sheets++;
-         r->sheets = xrealloc (r->sheets, r->spreadsheet.sheets * sizeof *r->sheets);
-         sd = &r->sheets[r->spreadsheet.sheets - 1];
-         sd->start_col = sd->stop_col = sd->start_row = sd->stop_row = -1;
+         ++r->current_sheet;
+         if (r->current_sheet + 1 > r->spreadsheet.n_sheets)
+           {
+             struct sheet_detail *sd ;
+             r->sheets = xrealloc (r->sheets, (r->current_sheet + 1) * sizeof *r->sheets);
+             sd = &r->sheets[r->current_sheet];
+             sd->start_col = sd->stop_col = sd->start_row = sd->stop_row = -1;
+             r->spreadsheet.n_sheets = r->current_sheet + 1;
+           }
        }
       else if (0 == xmlStrcasecmp (name, _xml("gnm:SheetNameIndex")) &&
          XML_READER_TYPE_END_ELEMENT  == r->node_type)
        {
          r->state = STATE_INIT;
+         r->current_sheet = -1;
        }
       else if (XML_READER_TYPE_TEXT == r->node_type)
        {
-         r->sheets [r->spreadsheet.sheets - 1].name = xmlTextReaderValue (r->xtr);
+         r->sheets [r->spreadsheet.n_sheets - 1].name = CHAR_CAST (char *, xmlTextReaderValue (r->xtr));
        }
       break;
 
@@ -246,7 +271,7 @@ process_node (struct gnumeric_reader *r)
       if (0 == xmlStrcasecmp (name, _xml("gnm:Sheet")) &&
          XML_READER_TYPE_ELEMENT  == r->node_type)
        {
-         ++r->sheet_index;
+         ++r->current_sheet;
          r->state = STATE_SHEET_START;
        }
       break;
@@ -277,7 +302,7 @@ process_node (struct gnumeric_reader *r)
                r->state = STATE_SHEET_FOUND;
              free (value);
            }
-         else if (r->target_sheet_index == r->sheet_index + 1)
+         else if (r->target_sheet_index == r->current_sheet + 1)
            {
              r->state = STATE_SHEET_FOUND;
            }
@@ -320,7 +345,7 @@ process_node (struct gnumeric_reader *r)
       else if (r->node_type == XML_READER_TYPE_TEXT)
        {
          xmlChar *value = xmlTextReaderValue (r->xtr);
-         r->sheets[r->sheet_index].maxrow = _xmlchar_to_int (value);
+         r->sheets[r->current_sheet].maxrow = _xmlchar_to_int (value);
          xmlFree (value);
        }
       break;
@@ -333,7 +358,7 @@ process_node (struct gnumeric_reader *r)
       else if (r->node_type == XML_READER_TYPE_TEXT)
        {
          xmlChar *value = xmlTextReaderValue (r->xtr);
-         r->sheets[r->sheet_index].maxcol = _xmlchar_to_int (value);
+         r->sheets[r->current_sheet].maxcol = _xmlchar_to_int (value);
          xmlFree (value);
        }
       break;
@@ -342,7 +367,6 @@ process_node (struct gnumeric_reader *r)
          XML_READER_TYPE_ELEMENT  == r->node_type)
        {
          xmlChar *attr = NULL;
-         r->state = STATE_CELL;
 
          attr = xmlTextReaderGetAttribute (r->xtr, _xml ("Col"));
          r->col =  _xmlchar_to_int (attr);
@@ -354,27 +378,28 @@ process_node (struct gnumeric_reader *r)
          attr = xmlTextReaderGetAttribute (r->xtr, _xml ("Row"));
          r->row = _xmlchar_to_int (attr);
          free (attr);
-         if (r->sheets[r->sheet_index].start_row == -1)
+
+         if (r->sheets[r->current_sheet].start_row == -1)
            {
-             r->sheets[r->sheet_index].start_row = r->row;
+             r->sheets[r->current_sheet].start_row = r->row;
            }
 
-         if (r->sheets[r->sheet_index].start_col == -1)
+         if (r->sheets[r->current_sheet].start_col == -1)
            {
-             r->sheets[r->sheet_index].start_col = r->col;
+             r->sheets[r->current_sheet].start_col = r->col;
            }
+         if (! xmlTextReaderIsEmptyElement (r->xtr))
+           r->state = STATE_CELL;
        }
-      else if (0 == xmlStrcasecmp (name, _xml("gnm:Cells"))  &&
-              XML_READER_TYPE_END_ELEMENT  == r->node_type)
+      else if ( (0 == xmlStrcasecmp (name, _xml("gnm:Cells")))  &&  (XML_READER_TYPE_END_ELEMENT  == r->node_type) )
        {
-         r->sheets[r->sheet_index].stop_col = r->col;
-         r->sheets[r->sheet_index].stop_row = r->row;
+         r->sheets[r->current_sheet].stop_col = r->col;
+         r->sheets[r->current_sheet].stop_row = r->row;
          r->state = STATE_SHEET_NAME;
        }
       break;
     case STATE_CELL:
-      if (0 == xmlStrcasecmp (name, _xml("gnm:Cell"))  &&
-                             XML_READER_TYPE_END_ELEMENT  == r->node_type)
+      if (0 == xmlStrcasecmp (name, _xml("gnm:Cell"))  && XML_READER_TYPE_END_ELEMENT  == r->node_type)
        {
          r->state = STATE_CELLS_START;
        }
@@ -420,16 +445,21 @@ struct var_spec
 };
 
 
-void 
-gnumeric_destroy (struct spreadsheet *s)
+static void
+gnumeric_error_handler (void *ctx, const char *mesg,
+                       UNUSED xmlParserSeverities sev, xmlTextReaderLocatorPtr loc)
 {
-  struct gnumeric_reader *r = (struct gnumeric *) s;
-  gnm_file_casereader_destroy (NULL, s);
+  struct gnumeric_reader *r = ctx;
+       
+  msg (MW, _("There was a problem whilst reading the %s file `%s' (near line %d): `%s'"),
+       "Gnumeric",
+       r->spreadsheet.file_name,
+       xmlTextReaderLocatorLineNumber (loc),
+       mesg);
 }
 
-
 static struct gnumeric_reader *
-gnumeric_reopen (struct gnumeric_reader *r, const char *filename)
+gnumeric_reopen (struct gnumeric_reader *r, const char *filename, bool show_errors)
 {  
   int ret;
 
@@ -449,9 +479,11 @@ gnumeric_reopen (struct gnumeric_reader *r, const char *filename)
   if (NULL == gz)
     return NULL;
 
+
   xtr = xmlReaderForIO ((xmlInputReadCallback) gzread,
-                           (xmlInputCloseCallback) gzclose, gz,
-                          NULL, NULL, 0);
+                       (xmlInputCloseCallback) gzclose, gz,
+                       NULL, NULL,
+                       show_errors ? 0 : (XML_PARSE_NOERROR | XML_PARSE_NOWARNING) );
 
   if (xtr == NULL)
     {
@@ -460,15 +492,22 @@ gnumeric_reopen (struct gnumeric_reader *r, const char *filename)
     }
 
   if (r == NULL)
-    r = xzalloc (sizeof *r);
-
-  r->xtr = xtr;
-  r->spreadsheet.sheets = -1;
-  r->state = STATE_PRE_INIT;
+    {
+      r = xzalloc (sizeof *r);
+      r->spreadsheet.n_sheets = -1;
+      r->spreadsheet.file_name = filename;
+    }
+  
+  if (show_errors) 
+    xmlTextReaderSetErrorHandler (xtr, gnumeric_error_handler, r);
 
   r->target_sheet = NULL;
   r->target_sheet_index = -1;
 
+  r->row = r->col = -1;
+  r->state = STATE_PRE_INIT;
+  r->xtr = xtr;
+  r->ref_cnt++;
 
   /* Advance to the start of the workbook.
      This gives us some confidence that we are actually dealing with a gnumeric
@@ -480,31 +519,51 @@ gnumeric_reopen (struct gnumeric_reader *r, const char *filename)
       process_node (r);
     }
 
+
+  if ( ret != 1)
+    {
+      /* Does not seem to be a gnumeric file */
+      xmlFreeTextReader (r->xtr);
+      free (r);
+      return NULL;
+    }
+
   r->spreadsheet.type = SPREADSHEET_GNUMERIC;
 
-  if (filename)
-    r->spreadsheet.file_name = filename;
+  if (show_errors)
+    {
+      const xmlChar *enc = xmlTextReaderConstEncoding (r->xtr);
+      xmlCharEncoding xce = xmlParseCharEncoding (CHAR_CAST (const char *, enc));
+
+      if ( XML_CHAR_ENCODING_UTF8 != xce)
+       {
+         /* I have been told that ALL gnumeric files are UTF8 encoded.  If that is correct, this 
+            can never happen. */
+         msg (MW, _("The gnumeric file `%s' is encoded as %s instead of the usual UTF-8 encoding. "
+                    "Any non-ascii characters will be incorrectly imported."),
+              r->spreadsheet.file_name,
+              enc);
+       }
+    }
 
   return r;
 }
 
 
 struct spreadsheet *
-gnumeric_probe (const char *filename)
+gnumeric_probe (const char *filename, bool report_errors)
 {
-  struct gnumeric_reader *r = NULL;
-  
-  r = gnumeric_reopen (r, filename);
-  
+  struct gnumeric_reader *r = gnumeric_reopen (NULL, filename, report_errors);
+
   return &r->spreadsheet;
 }
 
 
 struct casereader *
 gnumeric_make_reader (struct spreadsheet *spreadsheet,
-                     const struct spreadsheet_read_info *gri, 
-                     struct spreadsheet_read_options *opts)
+                     const struct spreadsheet_read_options *opts)
 {
+  int x = 0;
   struct gnumeric_reader *r = NULL;
   unsigned long int vstart = 0;
   int ret;
@@ -515,6 +574,11 @@ gnumeric_make_reader (struct spreadsheet *spreadsheet,
 
   r = (struct gnumeric_reader *) (spreadsheet);
 
+  if (r->row != -1)
+    r = gnumeric_reopen (r, NULL, true);
+
+
+
   if ( opts->cell_range )
     {
       if ( ! convert_cell_ref (opts->cell_range,
@@ -537,7 +601,7 @@ gnumeric_make_reader (struct spreadsheet *spreadsheet,
   r->target_sheet = BAD_CAST opts->sheet_name;
   r->target_sheet_index = opts->sheet_index;
   r->row = r->col = -1;
-  r->sheet_index = -1;
+  r->current_sheet = -1;
 
   /* Advance to the start of the cells for the target sheet */
   while ( (r->state != STATE_CELL || r->row < r->start_row )
@@ -561,7 +625,7 @@ gnumeric_make_reader (struct spreadsheet *spreadsheet,
       n_cases = MIN (n_cases, r->stop_row - r->start_row + 1);
     }
 
-  if ( gri->read_names )
+  if ( opts->read_names )
     {
       r->start_row++;
       n_cases --;
@@ -605,7 +669,7 @@ gnumeric_make_reader (struct spreadsheet *spreadsheet,
 
          if ( r->row < r->start_row)
            {
-             if ( gri->read_names )
+             if ( opts->read_names )
                {
                  var_spec [idx].name = xstrdup (text);
                }
@@ -615,8 +679,8 @@ gnumeric_make_reader (struct spreadsheet *spreadsheet,
              var_spec [idx].first_value = xmlStrdup (value);
 
              if (-1 ==  var_spec [idx].width )
-               var_spec [idx].width = (gri->asw == -1) ?
-                 ROUND_UP (strlen(text), SPREADSHEET_DEFAULT_WIDTH) : gri->asw;
+               var_spec [idx].width = (opts->asw == -1) ?
+                 ROUND_UP (strlen(text), SPREADSHEET_DEFAULT_WIDTH) : opts->asw;
            }
 
          free (value);
@@ -676,13 +740,15 @@ gnumeric_make_reader (struct spreadsheet *spreadsheet,
   r->first_case = case_create (r->proto);
   case_set_missing (r->first_case);
 
-  int x = 0;
+
   for ( i = 0 ; i < n_var_specs ; ++i )
     {
+      const struct variable *var;
+
       if ( (var_spec[i].name == NULL) && (var_spec[i].first_value == NULL))
        continue;
 
-      const struct variable *var = dict_get_var (r->dict, x++);
+      var = dict_get_var (r->dict, x++);
 
       convert_xml_string_to_value (r->first_case, var,
                                   var_spec[i].first_value);
@@ -696,16 +762,7 @@ gnumeric_make_reader (struct spreadsheet *spreadsheet,
 
   free (var_spec);
   
-  
-  if (opts->cell_range == NULL)
-    {
-      opts->cell_range = c_xasprintf ("%c%d:%c%ld", 
-                                      r->start_col + 'A',
-                                      r->start_row,
-                                      r->stop_col + 'A' + caseproto_get_n_widths (r->proto),
-                                      r->start_row + n_cases);
-    }
-  
+
   return casereader_create_sequential
     (NULL,
      r->proto,