1 /* PSPPIRE - a graphical user interface for PSPP.
2 Copyright (C) 2008, 2009, 2010, 2011, 2012, 2013 Free Software Foundation
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.
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.
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/>. */
19 #include "ui/gui/text-data-import-dialog.h"
23 #include <gtk-contrib/psppire-sheet.h>
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"
54 #include "gl/intprops.h"
55 #include "gl/xalloc.h"
58 #define _(msgid) gettext (msgid)
59 #define N_(msgid) msgid
61 struct import_assistant;
63 static void apply_dict (const struct dictionary *, struct string *);
64 static char *generate_syntax (const struct import_assistant *);
66 static void add_line_number_column (const struct import_assistant *,
68 /* Pops up the Text Data Import assistant. */
70 text_data_import_assistant (PsppireDataWindow *dw)
72 GtkWindow *parent_window = GTK_WINDOW (dw);
73 struct import_assistant *ia;
75 ia = xzalloc (sizeof *ia);
76 if (!init_file (ia, parent_window))
82 init_assistant (ia, parent_window);
84 init_first_line_page (ia);
85 init_separators_page (ia);
86 init_formats_page (ia);
88 gtk_widget_show_all (GTK_WIDGET (ia->asst.assistant));
90 ia->asst.main_loop = g_main_loop_new (NULL, false);
91 g_main_loop_run (ia->asst.main_loop);
92 g_main_loop_unref (ia->asst.main_loop);
94 switch (ia->asst.response)
96 case GTK_RESPONSE_APPLY:
97 free (execute_syntax_string (dw, generate_syntax (ia)));
99 case PSPPIRE_RESPONSE_PASTE:
100 free (paste_syntax_to_window (generate_syntax (ia)));
106 destroy_formats_page (ia);
107 destroy_separators_page (ia);
108 destroy_assistant (ia);
113 /* Emits PSPP syntax to S that applies the dictionary attributes
114 (such as missing values and value labels) of the variables in
117 apply_dict (const struct dictionary *dict, struct string *s)
119 size_t var_cnt = dict_get_var_cnt (dict);
122 for (i = 0; i < var_cnt; i++)
124 struct variable *var = dict_get_var (dict, i);
125 const char *name = var_get_name (var);
126 enum val_type type = var_get_type (var);
127 int width = var_get_width (var);
128 enum measure measure = var_get_measure (var);
129 enum alignment alignment = var_get_alignment (var);
130 const struct fmt_spec *format = var_get_print_format (var);
132 if (var_has_missing_values (var))
134 const struct missing_values *mv = var_get_missing_values (var);
137 syntax_gen_pspp (s, "MISSING VALUES %ss (", name);
138 for (j = 0; j < mv_n_values (mv); j++)
141 ds_put_cstr (s, ", ");
142 syntax_gen_value (s, mv_get_value (mv, j), width, format);
145 if (mv_has_range (mv))
148 if (mv_has_value (mv))
149 ds_put_cstr (s, ", ");
150 mv_get_range (mv, &low, &high);
151 syntax_gen_num_range (s, low, high, format);
153 ds_put_cstr (s, ").\n");
155 if (var_has_value_labels (var))
157 const struct val_labs *vls = var_get_value_labels (var);
158 const struct val_lab **labels = val_labs_sorted (vls);
159 size_t n_labels = val_labs_count (vls);
162 syntax_gen_pspp (s, "VALUE LABELS %ss", name);
163 for (i = 0; i < n_labels; i++)
165 const struct val_lab *vl = labels[i];
166 ds_put_cstr (s, "\n ");
167 syntax_gen_value (s, &vl->value, width, format);
168 ds_put_byte (s, ' ');
169 syntax_gen_string (s, ss_cstr (val_lab_get_escaped_label (vl)));
172 ds_put_cstr (s, ".\n");
174 if (var_has_label (var))
175 syntax_gen_pspp (s, "VARIABLE LABELS %ss %sq.\n",
176 name, var_get_label (var));
177 if (measure != var_default_measure (type))
178 syntax_gen_pspp (s, "VARIABLE LEVEL %ss (%ss).\n",
180 (measure == MEASURE_NOMINAL ? "NOMINAL"
181 : measure == MEASURE_ORDINAL ? "ORDINAL"
183 if (alignment != var_default_alignment (type))
184 syntax_gen_pspp (s, "VARIABLE ALIGNMENT %ss (%ss).\n",
186 (alignment == ALIGN_LEFT ? "LEFT"
187 : alignment == ALIGN_CENTRE ? "CENTER"
189 if (var_get_display_width (var) != var_default_display_width (width))
190 syntax_gen_pspp (s, "VARIABLE WIDTH %ss (%d).\n",
191 name, var_get_display_width (var));
195 /* Generates and returns PSPP syntax to execute the import
196 operation described by IA. The caller must free the syntax
199 generate_syntax (const struct import_assistant *ia)
201 struct string s = DS_EMPTY_INITIALIZER;
210 if (ia->file.encoding && strcmp (ia->file.encoding, "Auto"))
211 syntax_gen_pspp (&s, " /ENCODING=%sq\n", ia->file.encoding);
212 if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (
213 ia->intro.n_cases_button)))
214 ds_put_format (&s, " /IMPORTCASES=FIRST %d\n",
215 gtk_spin_button_get_value_as_int (
216 GTK_SPIN_BUTTON (ia->intro.n_cases_spin)));
217 else if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (
218 ia->intro.percent_button)))
219 ds_put_format (&s, " /IMPORTCASES=PERCENT %d\n",
220 gtk_spin_button_get_value_as_int (
221 GTK_SPIN_BUTTON (ia->intro.percent_spin)));
223 ds_put_cstr (&s, " /IMPORTCASES=ALL\n");
225 " /ARRANGEMENT=DELIMITED\n"
227 if (ia->first_line.skip_lines > 0)
228 ds_put_format (&s, " /FIRSTCASE=%d\n", ia->first_line.skip_lines + 1);
229 ds_put_cstr (&s, " /DELIMITERS=\"");
230 if (ds_find_byte (&ia->separators.separators, '\t') != SIZE_MAX)
231 ds_put_cstr (&s, "\\t");
232 if (ds_find_byte (&ia->separators.separators, '\\') != SIZE_MAX)
233 ds_put_cstr (&s, "\\\\");
234 for (i = 0; i < ds_length (&ia->separators.separators); i++)
236 char c = ds_at (&ia->separators.separators, i);
238 ds_put_cstr (&s, "\"\"");
239 else if (c != '\t' && c != '\\')
242 ds_put_cstr (&s, "\"\n");
243 if (!ds_is_empty (&ia->separators.quotes))
244 syntax_gen_pspp (&s, " /QUALIFIER=%sq\n", ds_cstr (&ia->separators.quotes));
245 if (!ds_is_empty (&ia->separators.quotes) && ia->separators.escape)
246 ds_put_cstr (&s, " /ESCAPE\n");
247 ds_put_cstr (&s, " /VARIABLES=\n");
249 var_cnt = dict_get_var_cnt (ia->formats.dict);
250 for (i = 0; i < var_cnt; i++)
252 struct variable *var = dict_get_var (ia->formats.dict, i);
253 char format_string[FMT_STRING_LEN_MAX + 1];
254 fmt_to_string (var_get_print_format (var), format_string);
255 ds_put_format (&s, " %s %s%s\n",
256 var_get_name (var), format_string,
257 i == var_cnt - 1 ? "." : "");
260 apply_dict (ia->formats.dict, &s);
267 static void render_input_cell (GtkTreeViewColumn *tree_column,
268 GtkCellRenderer *cell,
269 GtkTreeModel *model, GtkTreeIter *iter,
272 static gboolean on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
273 gboolean keyboard_mode UNUSED,
275 struct import_assistant *);
279 /* Called to render one of the cells in the fields preview tree
282 render_input_cell (GtkTreeViewColumn *tree_column, GtkCellRenderer *cell,
283 GtkTreeModel *model, GtkTreeIter *iter,
286 struct import_assistant *ia = ia_;
287 struct substring field;
291 column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
293 row = empty_list_store_iter_to_row (iter) + ia->first_line.skip_lines;
294 field = ia->separators.columns[column].contents[row];
295 if (field.string != NULL)
298 g_value_init (&text, G_TYPE_STRING);
299 g_value_take_string (&text, ss_xstrdup (field));
300 g_object_set_property (G_OBJECT (cell), "text", &text);
301 g_value_unset (&text);
302 g_object_set (cell, "background-set", FALSE, (void *) NULL);
308 "background-set", TRUE,
313 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
314 const struct import_assistant *ia,
315 size_t *row, size_t *column);
318 /* Called to render a tooltip on one of the cells in the fields
319 preview tree view. */
321 on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
322 gboolean keyboard_mode UNUSED,
323 GtkTooltip *tooltip, struct import_assistant *ia)
327 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
330 if (ia->separators.columns[column].contents[row].string != NULL)
333 gtk_tooltip_set_text (tooltip,
334 _("This input line has too few separators "
335 "to fill in this field."));
340 /* Parses the contents of the field at (ROW,COLUMN) according to
341 its variable format. If OUTPUTP is non-null, then *OUTPUTP
342 receives the formatted output for that field (which must be
343 freed with free). If TOOLTIPP is non-null, then *TOOLTIPP
344 receives a message suitable for use in a tooltip, if one is
345 needed, or a null pointer otherwise. Returns true if a
346 tooltip message is needed, otherwise false. */
348 parse_field (struct import_assistant *ia,
349 size_t row, size_t column,
350 char **outputp, char **tooltipp)
352 struct substring field;
354 struct variable *var;
355 const struct fmt_spec *in;
360 field = ia->separators.columns[column].contents[row];
361 var = dict_get_var (ia->formats.dict, column);
362 value_init (&val, var_get_width (var));
363 in = var_get_print_format (var);
364 out = fmt_for_output_from_input (in);
366 if (field.string != NULL)
370 error = data_in (field, "UTF-8", in->type, &val, var_get_width (var),
371 dict_get_encoding (ia->formats.dict));
374 tooltip = xasprintf (_("Cannot parse field content `%.*s' as "
376 (int) field.length, field.string,
377 fmt_name (in->type), error);
383 tooltip = xstrdup (_("This input line has too few separators "
384 "to fill in this field."));
385 value_set_missing (&val, var_get_width (var));
389 *outputp = data_out (&val, dict_get_encoding (ia->formats.dict), &out);
391 value_destroy (&val, var_get_width (var));
393 ok = tooltip == NULL;
394 if (tooltipp != NULL)
401 /* Called to render one of the cells in the data preview tree
404 render_output_cell (GtkTreeViewColumn *tree_column,
405 GtkCellRenderer *cell,
410 struct import_assistant *ia = ia_;
412 GValue gvalue = { 0, };
415 ok = parse_field (ia,
416 (empty_list_store_iter_to_row (iter)
417 + ia->first_line.skip_lines),
418 GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
422 g_value_init (&gvalue, G_TYPE_STRING);
423 g_value_take_string (&gvalue, output);
424 g_object_set_property (G_OBJECT (cell), "text", &gvalue);
425 g_value_unset (&gvalue);
428 g_object_set (cell, "background-set", FALSE, (void *) NULL);
432 "background-set", TRUE,
436 /* Called to render a tooltip for one of the cells in the data
437 preview tree view. */
439 on_query_output_tooltip (GtkWidget *widget, gint wx, gint wy,
440 gboolean keyboard_mode UNUSED,
441 GtkTooltip *tooltip, struct import_assistant *ia)
446 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
449 if (parse_field (ia, row, column, NULL, &text))
452 gtk_tooltip_set_text (tooltip, text);
457 /* Utility functions used by multiple pages of the assistant. */
460 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
461 const struct import_assistant *ia,
462 size_t *row, size_t *column)
464 GtkTreeView *tree_view = GTK_TREE_VIEW (widget);
468 GtkTreeViewColumn *tree_column;
469 GtkTreeModel *tree_model;
472 /* Check that WIDGET is really visible on the screen before we
473 do anything else. This is a bug fix for a sticky situation:
474 when text_data_import_assistant() returns, it frees the data
475 necessary to compose the tool tip message, but there may be
476 a tool tip under preparation at that point (even if there is
477 no visible tool tip) that will call back into us a little
478 bit later. Perhaps the correct solution to this problem is
479 to make the data related to the tool tips part of a GObject
480 that only gets destroyed when all references are released,
481 but this solution appears to be effective too. */
482 if (!gtk_widget_get_mapped (widget))
485 gtk_tree_view_convert_widget_to_bin_window_coords (tree_view,
487 if (!gtk_tree_view_get_path_at_pos (tree_view, bx, by,
488 &path, &tree_column, NULL, NULL))
491 *column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
494 tree_model = gtk_tree_view_get_model (tree_view);
495 ok = gtk_tree_model_get_iter (tree_model, &iter, path);
496 gtk_tree_path_free (path);
500 *row = empty_list_store_iter_to_row (&iter) + ia->first_line.skip_lines;
505 make_tree_view (const struct import_assistant *ia,
507 GtkTreeView **tree_view)
511 *tree_view = GTK_TREE_VIEW (gtk_tree_view_new ());
512 model = GTK_TREE_MODEL (psppire_empty_list_store_new (
513 ia->file.line_cnt - first_line));
514 g_object_set_data (G_OBJECT (model), "lines", ia->file.lines + first_line);
515 g_object_set_data (G_OBJECT (model), "first-line",
516 GINT_TO_POINTER (first_line));
517 gtk_tree_view_set_model (*tree_view, model);
518 g_object_unref (model);
520 add_line_number_column (ia, *tree_view);
524 render_line_number (GtkTreeViewColumn *tree_column,
525 GtkCellRenderer *cell,
526 GtkTreeModel *tree_model,
530 gint row = empty_list_store_iter_to_row (iter);
531 char s[INT_BUFSIZE_BOUND (int)];
534 first_line = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_model),
536 sprintf (s, "%d", first_line + row);
537 g_object_set (cell, "text", s, NULL);
541 add_line_number_column (const struct import_assistant *ia,
542 GtkTreeView *treeview)
544 GtkTreeViewColumn *column;
546 column = gtk_tree_view_column_new_with_attributes (
547 _("Line"), ia->asst.prop_renderer, (void *) NULL);
548 gtk_tree_view_column_set_sizing (column, GTK_TREE_VIEW_COLUMN_FIXED);
549 gtk_tree_view_column_set_fixed_width (
550 column, get_monospace_width (treeview, ia->asst.prop_renderer, 5));
551 gtk_tree_view_column_set_resizable (column, TRUE);
552 gtk_tree_view_column_set_cell_data_func (column, ia->asst.prop_renderer,
553 render_line_number, NULL, NULL);
554 gtk_tree_view_append_column (treeview, column);
558 get_monospace_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
565 ds_put_byte_multiple (&s, '0', char_cnt);
566 ds_put_byte (&s, ' ');
567 width = get_string_width (treeview, renderer, ds_cstr (&s));
574 get_string_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
578 g_object_set (G_OBJECT (renderer), "text", string, (void *) NULL);
579 gtk_cell_renderer_get_size (renderer, GTK_WIDGET (treeview),
580 NULL, NULL, NULL, &width, NULL);
585 make_data_column (struct import_assistant *ia, GtkTreeView *tree_view,
586 bool input, gint dict_idx)
588 struct variable *var = NULL;
589 struct column *column = NULL;
591 gint content_width, header_width;
592 GtkTreeViewColumn *tree_column;
596 column = &ia->separators.columns[dict_idx];
598 var = dict_get_var (ia->formats.dict, dict_idx);
600 name = escape_underscores (input ? column->name : var_get_name (var));
601 char_cnt = input ? column->width : var_get_print_format (var)->w;
602 content_width = get_monospace_width (tree_view, ia->asst.fixed_renderer,
604 header_width = get_string_width (tree_view, ia->asst.prop_renderer,
607 tree_column = gtk_tree_view_column_new ();
608 g_object_set_data (G_OBJECT (tree_column), "column-number",
609 GINT_TO_POINTER (dict_idx));
610 gtk_tree_view_column_set_title (tree_column, name);
611 gtk_tree_view_column_pack_start (tree_column, ia->asst.fixed_renderer,
613 gtk_tree_view_column_set_cell_data_func (
614 tree_column, ia->asst.fixed_renderer,
615 input ? render_input_cell : render_output_cell, ia, NULL);
616 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_FIXED);
617 gtk_tree_view_column_set_fixed_width (tree_column, MAX (content_width,
626 create_data_tree_view (bool input, GtkContainer *parent,
627 struct import_assistant *ia)
629 GtkTreeView *tree_view;
632 make_tree_view (ia, ia->first_line.skip_lines, &tree_view);
633 gtk_tree_selection_set_mode (gtk_tree_view_get_selection (tree_view),
636 for (i = 0; i < ia->separators.column_cnt; i++)
637 gtk_tree_view_append_column (tree_view,
638 make_data_column (ia, tree_view, input, i));
640 g_object_set (G_OBJECT (tree_view), "has-tooltip", TRUE, (void *) NULL);
641 g_signal_connect (tree_view, "query-tooltip",
642 G_CALLBACK (input ? on_query_input_tooltip
643 : on_query_output_tooltip), ia);
644 gtk_tree_view_set_fixed_height_mode (tree_view, true);
646 gtk_container_add (parent, GTK_WIDGET (tree_view));
647 gtk_widget_show (GTK_WIDGET (tree_view));
652 /* Increments the "watch cursor" level, setting the cursor for
653 the assistant window to a watch face to indicate to the user
654 that the ongoing operation may take some time. */
656 push_watch_cursor (struct import_assistant *ia)
658 if (++ia->asst.watch_cursor == 1)
660 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
661 GdkDisplay *display = gtk_widget_get_display (widget);
662 GdkCursor *cursor = gdk_cursor_new_for_display (display, GDK_WATCH);
663 gdk_window_set_cursor (widget->window, cursor);
664 gdk_cursor_unref (cursor);
665 gdk_display_flush (display);
669 /* Decrements the "watch cursor" level. If the level reaches
670 zero, the cursor is reset to its default shape. */
672 pop_watch_cursor (struct import_assistant *ia)
674 if (--ia->asst.watch_cursor == 0)
676 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
677 gdk_window_set_cursor (widget->window, NULL);