pintos-os.org Git - pspp/blob - src/ui/gui/text-data-import-dialog.h

   1 /* PSPPIRE - a graphical user interface for PSPP.
   2    Copyright (C) 2008, 2010, 2011, 2013  Free Software Foundation
   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 TEXT_DATA_IMPORT_DIALOG_H
  18 #define TEXT_DATA_IMPORT_DIALOG_H
  19
  20 #include <glib-object.h>
  21 #include "ui/gui/psppire-data-window.h"
  22 #include "data/spreadsheet-reader.h"
  23
  24 #include "libpspp/str.h"
  25
  26 enum file_type
  27   {
  28     FTYPE_TEXT,
  29     FTYPE_GNUMERIC,
  30     FTYPE_ODS
  31   };
  32
  33 /* The file to be imported. */
  34 struct file
  35   {
  36     char *file_name;        /* File name. */
  37
  38     enum file_type type;
  39
  40     /* Relevant only for text files */
  41
  42     gchar *encoding;        /* Encoding. */
  43     unsigned long int total_lines; /* Number of lines in file. */
  44     bool total_is_exact;    /* Is total_lines exact (or an estimate)? */
  45
  46     /* The first several lines of the file. */
  47     struct string *lines;
  48     size_t line_cnt;
  49   };
  50
  51 /* The main body of the GTK+ assistant and related data. */
  52 struct assistant
  53   {
  54     GtkBuilder *builder;
  55     GtkAssistant *assistant;
  56     GMainLoop *main_loop;
  57     GtkWidget *paste_button;
  58     GtkWidget *reset_button;
  59     int response;
  60     int watch_cursor;
  61
  62     GtkCellRenderer *prop_renderer;
  63     GtkCellRenderer *fixed_renderer;
  64   };
  65
  66
  67 /* The sheet_spec page of the assistant (only relevant for spreadsheet imports). */
  68 struct sheet_spec_page
  69   {
  70     GtkWidget *page;
  71     struct casereader *reader;
  72     struct dictionary *dict;
  73
  74     struct spreadsheet_read_info sri;
  75     struct spreadsheet_read_options opts;
  76   };
  77
  78
  79 /* The introduction page of the assistant. */
  80 struct intro_page
  81   {
  82     GtkWidget *page;
  83     GtkWidget *all_cases_button;
  84     GtkWidget *n_cases_button;
  85     GtkWidget *n_cases_spin;
  86     GtkWidget *percent_button;
  87     GtkWidget *percent_spin;
  88   };
  89
  90 /* Page where the user chooses the first line of data. */
  91 struct first_line_page
  92   {
  93     int skip_lines;    /* Number of initial lines to skip? */
  94     bool variable_names; /* Variable names above first line of data? */
  95
  96     GtkWidget *page;
  97     GtkTreeView *tree_view;
  98     GtkWidget *variable_names_cb;
  99   };
 100
 101
 102 /* Page where the user chooses field separators. */
 103 struct separators_page
 104   {
 105     /* How to break lines into columns. */
 106     struct string separators;   /* Field separators. */
 107     struct string quotes;       /* Quote characters. */
 108     bool escape;                /* Doubled quotes yield a quote mark? */
 109
 110     /* The columns produced thereby. */
 111     struct column *columns;     /* Information about each column. */
 112     size_t column_cnt;          /* Number of columns. */
 113
 114     GtkWidget *page;
 115     GtkWidget *custom_cb;
 116     GtkWidget *custom_entry;
 117     GtkWidget *quote_cb;
 118     GtkWidget *quote_combo;
 119     GtkEntry *quote_entry;
 120     GtkWidget *escape_cb;
 121     GtkTreeView *fields_tree_view;
 122   };
 123
 124 /* Page where the user verifies and adjusts input formats. */
 125 struct formats_page
 126   {
 127     struct dictionary *dict;
 128
 129     GtkWidget *page;
 130     GtkTreeView *data_tree_view;
 131     PsppireDict *psppire_dict;
 132     struct variable **modified_vars;
 133     size_t modified_var_cnt;
 134   };
 135
 136
 137 struct import_assistant
 138   {
 139     struct file file;
 140     struct assistant asst;
 141     struct intro_page intro;
 142     struct sheet_spec_page sheet_spec;
 143     struct first_line_page first_line;
 144     struct separators_page separators;
 145     struct formats_page formats;
 146   };
 147
 148
 149
 150
 151 struct column
 152   {
 153     /* Variable name for this column.  This is the variable name
 154        used on the separators page; it can be overridden by the
 155        user on the formats page. */
 156     char *name;
 157
 158     /* Maximum length of any row in this column. */
 159     size_t width;
 160
 161     /* Contents of this column: contents[row] is the contents for
 162        the given row.
 163
 164        A null substring indicates a missing column for that row
 165        (because the line contains an insufficient number of
 166        separators).
 167
 168        contents[] elements may be substrings of the lines[]
 169        strings that represent the whole lines of the file, to
 170        save memory.  Other elements are dynamically allocated
 171        with ss_alloc_substring. */
 172     struct substring *contents;
 173   };
 174
 175
 176 GtkWidget * add_page_to_assistant (struct import_assistant *ia,
 177                                    GtkWidget *page, GtkAssistantPageType type);
 178
 179 void text_data_import_assistant (PsppireDataWindow *);
 180
 181 /* FIXME: Should this be private to first line page ? */
 182 void make_tree_view (const struct import_assistant *ia,
 183                             size_t first_line,
 184                             GtkTreeView **tree_view);
 185
 186 gint get_monospace_width (GtkTreeView *, GtkCellRenderer *,
 187                                  size_t char_cnt);
 188 gint get_string_width (GtkTreeView *, GtkCellRenderer *,
 189                               const char *string);
 190
 191
 192
 193 void push_watch_cursor (struct import_assistant *);
 194 void pop_watch_cursor (struct import_assistant *);
 195
 196
 197 GtkTreeView *create_data_tree_view (bool input, GtkContainer *parent,
 198                                            struct import_assistant *);
 199
 200 GtkTreeViewColumn *make_data_column (struct import_assistant *,
 201                                             GtkTreeView *, bool input,
 202                                             gint column_idx);
 203
 204
 205 void  update_assistant (struct import_assistant *ia);
 206
 207
 208 bool init_file (struct import_assistant *ia, GtkWindow *parent_window);
 209 void destroy_file (struct import_assistant *ia);
 210
 211
 212 void init_intro_page (struct import_assistant *);
 213 void reset_intro_page (struct import_assistant *);
 214
 215 void init_sheet_spec_page (struct import_assistant *);
 216 void reset_sheet_spec_page (struct import_assistant *);
 217 void post_sheet_spec_page (struct import_assistant *ia);
 218
 219 void init_first_line_page (struct import_assistant *ia);
 220 void prepare_first_line_page (struct import_assistant *ia);
 221 void reset_first_line_page (struct import_assistant *);
 222
 223 void init_separators_page (struct import_assistant *ia);
 224 void prepare_separators_page (struct import_assistant *ia);
 225 void reset_separators_page (struct import_assistant *);
 226 void destroy_separators_page (struct import_assistant *ia);
 227
 228 void init_formats_page (struct import_assistant *ia);
 229 void prepare_formats_page (struct import_assistant *ia);
 230 void reset_formats_page (struct import_assistant *);
 231 void destroy_formats_page (struct import_assistant *ia);
 232
 233 void init_assistant (struct import_assistant *, GtkWindow *);
 234 void destroy_assistant (struct import_assistant *);
 235
 236
 237 #endif