Use the msg function to report errors wherever possible.
[pspp] / src / ui / gui / page-sheet-spec.c
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyright (C) 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 #include <config.h>
18
19 #include "page-sheet-spec.h"
20
21 #include "ui/gui/text-data-import-dialog.h"
22
23 #include <errno.h>
24 #include <fcntl.h>
25 #include <gtk/gtk.h>
26 #include <limits.h>
27 #include <stdlib.h>
28 #include <sys/stat.h>
29
30 #include "data/data-in.h"
31 #include "data/data-out.h"
32 #include "data/format-guesser.h"
33 #include "data/value-labels.h"
34 #include "data/gnumeric-reader.h"
35 #include "data/ods-reader.h"
36 #include "data/spreadsheet-reader.h"
37 #include "language/data-io/data-parser.h"
38 #include "language/lexer/lexer.h"
39 #include "libpspp/assertion.h"
40 #include "libpspp/i18n.h"
41 #include "libpspp/line-reader.h"
42 #include "libpspp/message.h"
43 #include "ui/gui/checkbox-treeview.h"
44 #include "ui/gui/dialog-common.h"
45 #include "ui/gui/executor.h"
46 #include "ui/gui/helper.h"
47 #include "ui/gui/builder-wrapper.h"
48 #include "ui/gui/psppire-data-window.h"
49 #include "ui/gui/psppire-dialog.h"
50 #include "ui/gui/psppire-encoding-selector.h"
51 #include "ui/gui/psppire-empty-list-store.h"
52 #include "ui/gui/psppire-var-sheet.h"
53 #include "ui/gui/psppire-scanf.h"
54 #include "ui/syntax-gen.h"
55
56 #include "ui/gui/psppire-spreadsheet-model.h"
57
58 #include <data/casereader.h>
59
60 #include "gl/intprops.h"
61 #include "gl/xalloc.h"
62
63 #include "gettext.h"
64 #define _(msgid) gettext (msgid)
65 #define N_(msgid) msgid
66
67 struct import_assistant;
68
69 /* The "sheet-spec" page of the assistant. */
70
71 /* The sheet_spec page of the assistant (only relevant for spreadsheet imports). */
72 struct sheet_spec_page
73   {
74     GtkWidget *page;
75     struct casereader *reader;
76     struct dictionary *dict;
77     
78     struct spreadsheet_read_options opts;
79   };
80
81
82 char *
83 sheet_spec_gen_syntax (const struct import_assistant *ia)
84 {
85   const struct sheet_spec_page *ssp = ia->sheet_spec;
86   GtkBuilder *builder = ia->asst.builder;
87   GtkWidget *range_entry = get_widget_assert (builder, "cell-range-entry");
88   const gchar *range = gtk_entry_get_text (GTK_ENTRY (range_entry));
89
90   struct string s = DS_EMPTY_INITIALIZER;
91
92   syntax_gen_pspp (&s,
93                    "GET DATA"
94                    "\n  /TYPE=%ss"
95                    "\n  /FILE=%sq"
96                    "\n  /SHEET=index %d"
97                    "\n  /READNAMES=%ss",
98                    (ia->spreadsheet->type == SPREADSHEET_GNUMERIC) ? "GNM" : "ODS",
99                    ia->file.file_name,                   
100                    ssp->opts.sheet_index,
101                    ssp->opts.read_names ? "ON" : "OFF");
102
103
104   if (range && 0 != strcmp ("", range))
105     {
106       syntax_gen_pspp (&s,
107                        "\n  /CELLRANGE=RANGE %sq", range);
108     }
109   else
110     {
111       syntax_gen_pspp (&s,
112                        "\n  /CELLRANGE=FULL");
113     }
114
115
116   syntax_gen_pspp (&s, ".");
117
118   
119   return ds_cstr (&s);
120 }
121
122
123 static void 
124 on_sheet_combo_changed (GtkComboBox *cb, struct import_assistant *ia)
125 {
126   GtkTreeIter iter;
127   gchar *range = NULL;
128   GtkTreeModel *model = gtk_combo_box_get_model (cb);
129   GtkBuilder *builder = ia->asst.builder;
130   GtkWidget *range_entry = get_widget_assert (builder, "cell-range-entry");
131
132   gtk_combo_box_get_active_iter (cb, &iter);
133   gtk_tree_model_get (model, &iter, PSPPIRE_SPREADSHEET_MODEL_COL_RANGE, &range, -1);
134   gtk_entry_set_text (GTK_ENTRY (range_entry), range ?  range : "");
135   g_free (range);
136 }
137
138 /* Initializes IA's sheet_spec substructure. */
139 struct sheet_spec_page *
140 sheet_spec_page_create (struct import_assistant *ia)
141 {
142   GtkBuilder *builder = ia->asst.builder;
143   struct sheet_spec_page *p = xzalloc (sizeof (*p));
144
145   GtkWidget *combo_box = get_widget_assert (builder, "sheet-entry");
146   GtkCellRenderer *renderer = gtk_cell_renderer_text_new ();
147   gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (combo_box), renderer, TRUE);
148   gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (combo_box), renderer,
149                                   "text", 0,
150                                   NULL);
151
152   g_signal_connect (combo_box, "changed", G_CALLBACK (on_sheet_combo_changed), ia);
153
154   add_page_to_assistant (ia, get_widget_assert (builder, "Sheet"),
155                          GTK_ASSISTANT_PAGE_INTRO);
156
157   return p;
158 }
159
160 /* Prepares IA's sheet_spec page. */
161 void
162 prepare_sheet_spec_page (struct import_assistant *ia)
163 {
164   GtkBuilder *builder = ia->asst.builder;
165   GtkWidget *sheet_entry = get_widget_assert (builder, "sheet-entry");
166   GtkWidget *readnames_checkbox = get_widget_assert (builder, "readnames-checkbox");
167
168   gtk_combo_box_set_model (GTK_COMBO_BOX (sheet_entry), 
169                            psppire_spreadsheet_model_new (ia->spreadsheet));
170
171   gtk_combo_box_set_active (GTK_COMBO_BOX (sheet_entry), 0);
172
173   gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (readnames_checkbox), FALSE);
174 }
175
176
177 /* Resets IA's sheet_spec page to its initial state. */
178 void
179 reset_sheet_spec_page (struct import_assistant *ia)
180 {
181   GtkBuilder *builder = ia->asst.builder;
182   GtkWidget *sheet_entry = get_widget_assert (builder, "sheet-entry");
183   GtkWidget *readnames_checkbox = get_widget_assert (builder, "readnames-checkbox");
184
185   gtk_combo_box_set_active (GTK_COMBO_BOX (sheet_entry), 0);
186
187   gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (readnames_checkbox), FALSE);
188 }
189
190 /* Called when the Forward button is clicked, 
191    but before displaying the new page.
192 */
193 void
194 post_sheet_spec_page (struct import_assistant *ia)
195 {
196   int row_start = -1;
197   int row_stop = -1;
198   int col_start = -1;
199   int col_stop = -1;
200
201   GtkBuilder *builder = ia->asst.builder;
202
203   struct sheet_spec_page *ssp = ia->sheet_spec;
204   struct casereader *creader = NULL;
205   struct dictionary *dict = NULL;
206
207   GtkWidget *readnames_checkbox = get_widget_assert (builder, "readnames-checkbox");
208   GtkWidget *range_entry = get_widget_assert (builder, "cell-range-entry");
209   const gchar *range = gtk_entry_get_text (GTK_ENTRY (range_entry));
210   GtkWidget *combo_box = get_widget_assert (builder, "sheet-entry");
211
212   gint num = gtk_combo_box_get_active (GTK_COMBO_BOX (combo_box));
213   
214   ssp->opts.sheet_name = NULL;
215   ssp->opts.cell_range = NULL;
216   ssp->opts.sheet_index = num + 1;
217
218   if ( convert_cell_ref (range, &col_start, &row_start, &col_stop, &row_stop))
219     {
220       ssp->opts.cell_range = g_strdup (range);
221     }
222
223   ssp->opts.read_names = gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (readnames_checkbox));
224   ssp->opts.asw = -1;
225
226   switch (ia->spreadsheet->type)
227     {
228     case SPREADSHEET_ODS:
229     case SPREADSHEET_GNUMERIC:
230       {
231         creader = spreadsheet_make_reader (ia->spreadsheet, &ssp->opts);
232         dict = ia->spreadsheet->dict;
233       }
234       break;
235     default:
236       g_assert_not_reached ();
237       break;
238     }
239
240   ssp->dict = dict;
241   ssp->reader = creader;
242
243   if (creader && dict)
244     {
245       update_assistant (ia);
246     }
247   else
248     {
249       GtkWidget * dialog = gtk_message_dialog_new (NULL,
250                               GTK_DIALOG_MODAL,
251                               GTK_MESSAGE_ERROR,
252                               GTK_BUTTONS_CLOSE,
253                               _("An error occurred reading the spreadsheet file."));
254
255       gtk_dialog_run (GTK_DIALOG (dialog));
256       gtk_widget_destroy (dialog);
257     }
258 }
259
260
261 /*
262   Update IA according to the contents of DICT and CREADER.
263   CREADER will be destroyed by this function.
264 */
265 void 
266 update_assistant (struct import_assistant *ia)
267 {
268   struct sheet_spec_page *ssp = ia->sheet_spec;
269   int rows = 0;
270
271   if (ssp->dict)
272     {
273       struct ccase *c;
274       int col;
275
276       ia->column_cnt = dict_get_var_cnt (ssp->dict);
277       ia->columns = xcalloc (ia->column_cnt, sizeof (*ia->columns));
278       for (col = 0; col < ia->column_cnt ; ++col)
279         {
280           const struct variable *var = dict_get_var (ssp->dict, col);
281           ia->columns[col].name = xstrdup (var_get_name (var));
282           ia->columns[col].contents = NULL;
283         }
284
285       for (; (c = casereader_read (ssp->reader)) != NULL; case_unref (c))
286         {
287           rows++;
288           for (col = 0; col < ia->column_cnt ; ++col)
289             {
290               char *ss;
291               const struct variable *var = dict_get_var (ssp->dict, col);
292               
293               ia->columns[col].contents = xrealloc (ia->columns[col].contents,
294                                                     sizeof (struct substring) * rows);
295               
296               ss = data_out (case_data (c, var), dict_get_encoding (ssp->dict), 
297                              var_get_print_format (var));
298               
299               ia->columns[col].contents[rows - 1] = ss_cstr (ss);
300             }
301           
302           if (rows > MAX_PREVIEW_LINES)
303             {
304               case_unref (c);
305               break;
306             }
307         }
308     }
309   
310   ia->file.line_cnt = rows;
311 }