formats page: Construction is initialisation
[pspp] / src / ui / gui / page-formats.c
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyright (C) 2008, 2009, 2010, 2011, 2012, 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 "ui/gui/text-data-import-dialog.h"
20
21 #include <errno.h>
22 #include <fcntl.h>
23 #include <gtk-contrib/psppire-sheet.h>
24 #include <gtk/gtk.h>
25 #include <limits.h>
26 #include <stdlib.h>
27 #include <sys/stat.h>
28
29 #include "data/data-in.h"
30 #include "data/data-out.h"
31 #include "data/format-guesser.h"
32 #include "data/value-labels.h"
33 #include "language/data-io/data-parser.h"
34 #include "language/lexer/lexer.h"
35 #include "libpspp/assertion.h"
36 #include "libpspp/i18n.h"
37 #include "libpspp/line-reader.h"
38 #include "libpspp/message.h"
39 #include "ui/gui/checkbox-treeview.h"
40 #include "ui/gui/dialog-common.h"
41 #include "ui/gui/executor.h"
42 #include "ui/gui/helper.h"
43 #include "ui/gui/builder-wrapper.h"
44 #include "ui/gui/psppire-data-window.h"
45 #include "ui/gui/psppire-dialog.h"
46 #include "ui/gui/psppire-encoding-selector.h"
47 #include "ui/gui/psppire-empty-list-store.h"
48 #include "ui/gui/psppire-var-sheet.h"
49 #include "ui/gui/psppire-var-store.h"
50 #include "ui/gui/psppire-scanf.h"
51 #include "ui/syntax-gen.h"
52
53 #include "gl/error.h"
54 #include "gl/intprops.h"
55 #include "gl/xalloc.h"
56
57 #include "gettext.h"
58 #define _(msgid) gettext (msgid)
59 #define N_(msgid) msgid
60
61 /* Page where the user verifies and adjusts input formats. */
62 struct formats_page
63   {
64     GtkWidget *page;
65     GtkTreeView *data_tree_view;
66     PsppireDict *psppire_dict;
67     struct variable **modified_vars;
68     size_t modified_var_cnt;
69   };
70
71 /* The "formats" page of the assistant. */
72
73 static void on_variable_change (PsppireDict *dict, int idx,
74                                 struct import_assistant *);
75 static void clear_modified_vars (struct import_assistant *);
76
77 /* Initializes IA's formats substructure. */
78
79 struct formats_page *
80 formats_page_create (struct import_assistant *ia)
81 {
82   GtkBuilder *builder = ia->asst.builder;
83   struct formats_page *p = xzalloc (sizeof *p);
84
85   p->page = add_page_to_assistant (ia, get_widget_assert (builder, "Formats"),
86                                    GTK_ASSISTANT_PAGE_CONFIRM);
87   p->data_tree_view = GTK_TREE_VIEW (get_widget_assert (builder, "data"));
88   p->modified_vars = NULL;
89   p->modified_var_cnt = 0;
90
91   return p;
92 }
93
94 /* Frees IA's formats substructure. */
95 void
96 destroy_formats_page (struct import_assistant *ia)
97 {
98   struct formats_page *p = ia->formats;
99
100   if (p->psppire_dict != NULL)
101     {
102       dict_destroy (p->psppire_dict->dict);
103       g_object_unref (p->psppire_dict);
104     }
105   clear_modified_vars (ia);
106 }
107
108 /* Called just before the formats page of the assistant is
109    displayed. */
110 void
111 prepare_formats_page (struct import_assistant *ia)
112 {
113   struct dictionary *dict;
114   PsppireDict *psppire_dict;
115   PsppireVarStore *var_store;
116   GtkBin *vars_scroller;
117   GtkWidget *old_var_sheet;
118   PsppireVarSheet *var_sheet;
119   struct separators_page *seps = ia->separators;
120   struct formats_page *p = ia->formats;
121   struct fmt_guesser *fg;
122   unsigned long int number = 0;
123   size_t column_idx;
124
125   push_watch_cursor (ia);
126
127   dict = dict_create (get_default_encoding ());
128   fg = fmt_guesser_create ();
129   for (column_idx = 0; column_idx < ia->column_cnt; column_idx++)
130     {
131       struct variable *modified_var;
132
133       modified_var = (column_idx < p->modified_var_cnt
134                       ? p->modified_vars[column_idx] : NULL);
135       if (modified_var == NULL)
136         {
137           struct column *column = &ia->columns[column_idx];
138           struct variable *var;
139           struct fmt_spec format;
140           char *name;
141           size_t row;
142
143           /* Choose variable name. */
144           name = dict_make_unique_var_name (dict, column->name, &number);
145
146           /* Choose variable format. */
147           fmt_guesser_clear (fg);
148           for (row = ia->skip_lines; row < ia->file.line_cnt; row++)
149             fmt_guesser_add (fg, column->contents[row]);
150           fmt_guesser_guess (fg, &format);
151           fmt_fix_input (&format);
152
153           /* Create variable. */
154           var = dict_create_var_assert (dict, name, fmt_var_width (&format));
155           var_set_both_formats (var, &format);
156
157           free (name);
158         }
159       else
160         {
161           char *name;
162
163           name = dict_make_unique_var_name (dict, var_get_name (modified_var),
164                                             &number);
165           dict_clone_var_as_assert (dict, modified_var, name);
166           free (name);
167         }
168     }
169   fmt_guesser_destroy (fg);
170
171   psppire_dict = psppire_dict_new_from_dict (dict);
172   g_signal_connect (psppire_dict, "variable_changed",
173                     G_CALLBACK (on_variable_change), ia);
174   ia->dict = dict;
175   ia->formats->psppire_dict = psppire_dict;
176
177   /* XXX: PsppireVarStore doesn't hold a reference to
178      psppire_dict for now, but it should.  After it does, we
179      should g_object_ref the psppire_dict here, since we also
180      hold a reference via ia->formats->dict. */
181   var_store = psppire_var_store_new (psppire_dict);
182   g_object_set (var_store,
183                 "format-type", PSPPIRE_VAR_STORE_INPUT_FORMATS,
184                 (void *) NULL);
185   var_sheet = PSPPIRE_VAR_SHEET (psppire_var_sheet_new ());
186   g_object_set (var_sheet,
187                 "model", var_store,
188                 "may-create-vars", FALSE,
189                 (void *) NULL);
190
191   vars_scroller = GTK_BIN (get_widget_assert (ia->asst.builder, "vars-scroller"));
192   old_var_sheet = gtk_bin_get_child (vars_scroller);
193   if (old_var_sheet != NULL)
194     gtk_widget_destroy (old_var_sheet);
195   gtk_container_add (GTK_CONTAINER (vars_scroller), GTK_WIDGET (var_sheet));
196   gtk_widget_show (GTK_WIDGET (var_sheet));
197
198   gtk_widget_destroy (GTK_WIDGET (ia->formats->data_tree_view));
199   ia->formats->data_tree_view = create_data_tree_view (
200     false,
201     GTK_CONTAINER (get_widget_assert (ia->asst.builder, "data-scroller")),
202     ia);
203
204   pop_watch_cursor (ia);
205 }
206
207 /* Clears the set of user-modified variables from IA's formats
208    substructure.  This discards user modifications to variable
209    formats, thereby causing formats to revert to their
210    defaults.  */
211 static void
212 clear_modified_vars (struct import_assistant *ia)
213 {
214   struct formats_page *p = ia->formats;
215   size_t i;
216
217   for (i = 0; i < p->modified_var_cnt; i++)
218     var_destroy (p->modified_vars[i]);
219   free (p->modified_vars);
220   p->modified_vars = NULL;
221   p->modified_var_cnt = 0;
222 }
223
224 /* Resets the formats page to its defaults, discarding user
225    modifications. */
226 void
227 reset_formats_page (struct import_assistant *ia)
228 {
229   clear_modified_vars (ia);
230   prepare_formats_page (ia);
231 }
232
233
234
235 /* Called when the user changes one of the variables in the
236    dictionary. */
237 static void
238 on_variable_change (PsppireDict *dict, int dict_idx,
239                     struct import_assistant *ia)
240 {
241   struct formats_page *p = ia->formats;
242   GtkTreeView *tv = ia->formats->data_tree_view;
243   gint column_idx = dict_idx + 1;
244
245   push_watch_cursor (ia);
246
247   /* Remove previous column and replace with new column. */
248   gtk_tree_view_remove_column (tv, gtk_tree_view_get_column (tv, column_idx));
249   gtk_tree_view_insert_column (tv, make_data_column (ia, tv, false, dict_idx),
250                                column_idx);
251
252   /* Save a copy of the modified variable in modified_vars, so
253      that its attributes will be preserved if we back up to the
254      previous page with the Prev button and then come back
255      here. */
256   if (dict_idx >= p->modified_var_cnt)
257     {
258       size_t i;
259       p->modified_vars = xnrealloc (p->modified_vars, dict_idx + 1,
260                                     sizeof *p->modified_vars);
261       for (i = 0; i <= dict_idx; i++)
262         p->modified_vars[i] = NULL;
263       p->modified_var_cnt = dict_idx + 1;
264     }
265   if (p->modified_vars[dict_idx])
266     var_destroy (p->modified_vars[dict_idx]);
267   p->modified_vars[dict_idx]
268     = var_clone (psppire_dict_get_variable (dict, dict_idx));
269
270   pop_watch_cursor (ia);
271 }
272
273