pintos-os.org Git - pspp/blob - src/data/spreadsheet-reader.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2007, 2010 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 #ifndef SPREADSHEET_READ_H
  18 #define SPREADSHEET_READ_H 1
  19
  20 #include <stdbool.h>
  21
  22 /* Default width of string variables. */
  23 #define SPREADSHEET_DEFAULT_WIDTH 8
  24
  25 /* These elements are read/write.
  26    They may be passed in NULL (for pointers) or negative for integers, in which
  27    case they will be filled in be the function.
  28 */
  29 struct spreadsheet_read_options
  30 {
  31   char *sheet_name ;       /* The name of the sheet to open (in UTF-8) */
  32   int sheet_index ;        /* The index of the sheet to open (only used if sheet_name is NULL) */
  33   char *cell_range ;       /* The cell range (in UTF-8) */
  34 };
  35
  36
  37 struct spreadsheet_read_info
  38 {
  39   bool read_names ;        /* True if the first row is to be used as the names of the variables */
  40   int asw ;                /* The width of string variables in the created dictionary */
  41 };
  42
  43 int ps26_to_int (const char *str);
  44 char * int_to_ps26 (int);
  45
  46 bool convert_cell_ref (const char *ref,
  47                        int *col0, int *row0,
  48                        int *coli, int *rowi);
  49
  50
  51 #define _xml(X) (CHAR_CAST (const xmlChar *, X))
  52
  53 #define _xmlchar_to_int(X) (atoi(CHAR_CAST (const char *, X)))
  54
  55 enum spreadsheet_type
  56   {
  57     SPREADSHEET_NONE,
  58     SPREADSHEET_GNUMERIC,
  59     SPREADSHEET_ODS
  60   };
  61
  62 struct spreadsheet
  63 {
  64   char *file_name;
  65
  66   enum spreadsheet_type type;
  67
  68   /* The total number of sheets in the "workbook" */
  69   int sheets;
  70
  71   /* The dictionary */
  72   struct dictionary *dict;
  73 };
  74
  75
  76 char *create_cell_ref (int col0, int row0, int coli, int rowi);
  77
  78 /*
  79    Attempt to open the file called FILENAME as a spreadsheet.
  80    It is not known a priori, what type of spreadsheet FILENAME is, or
  81    even if it is a spreadsheet at all.
  82    If it fails to open, then it will return NULL without any error or
  83    warning messages.
  84  */
  85 struct spreadsheet * spreadsheet_open (const char *filename);
  86 void spreadsheet_close (struct spreadsheet *);
  87
  88 struct casereeader;
  89 struct casereader * spreadsheet_make_reader (struct spreadsheet *s);
  90
  91
  92 #define SPREADSHEET_CAST(X) ((struct spreadsheet *)(X))
  93
  94 #endif