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 *,
69 /* Pops up the Text Data Import assistant. */
71 text_data_import_assistant (PsppireDataWindow *dw)
73 GtkWindow *parent_window = GTK_WINDOW (dw);
74 struct import_assistant *ia;
76 ia = xzalloc (sizeof *ia);
77 if (!init_file (ia, parent_window))
83 init_assistant (ia, parent_window);
84 if ( ia->file.type == FTYPE_TEXT)
87 init_first_line_page (ia);
88 init_separators_page (ia);
92 init_sheet_spec_page (ia);
95 init_formats_page (ia);
97 gtk_widget_show_all (GTK_WIDGET (ia->asst.assistant));
99 ia->asst.main_loop = g_main_loop_new (NULL, false);
100 g_main_loop_run (ia->asst.main_loop);
101 g_main_loop_unref (ia->asst.main_loop);
103 switch (ia->asst.response)
105 case GTK_RESPONSE_APPLY:
106 free (execute_syntax_string (dw, generate_syntax (ia)));
108 case PSPPIRE_RESPONSE_PASTE:
109 free (paste_syntax_to_window (generate_syntax (ia)));
115 if ( ia->file.type == FTYPE_TEXT)
117 destroy_formats_page (ia);
118 destroy_separators_page (ia);
121 destroy_assistant (ia);
126 /* Emits PSPP syntax to S that applies the dictionary attributes
127 (such as missing values and value labels) of the variables in
130 apply_dict (const struct dictionary *dict, struct string *s)
132 size_t var_cnt = dict_get_var_cnt (dict);
135 for (i = 0; i < var_cnt; i++)
137 struct variable *var = dict_get_var (dict, i);
138 const char *name = var_get_name (var);
139 enum val_type type = var_get_type (var);
140 int width = var_get_width (var);
141 enum measure measure = var_get_measure (var);
142 enum alignment alignment = var_get_alignment (var);
143 const struct fmt_spec *format = var_get_print_format (var);
145 if (var_has_missing_values (var))
147 const struct missing_values *mv = var_get_missing_values (var);
150 syntax_gen_pspp (s, "MISSING VALUES %ss (", name);
151 for (j = 0; j < mv_n_values (mv); j++)
154 ds_put_cstr (s, ", ");
155 syntax_gen_value (s, mv_get_value (mv, j), width, format);
158 if (mv_has_range (mv))
161 if (mv_has_value (mv))
162 ds_put_cstr (s, ", ");
163 mv_get_range (mv, &low, &high);
164 syntax_gen_num_range (s, low, high, format);
166 ds_put_cstr (s, ").\n");
168 if (var_has_value_labels (var))
170 const struct val_labs *vls = var_get_value_labels (var);
171 const struct val_lab **labels = val_labs_sorted (vls);
172 size_t n_labels = val_labs_count (vls);
175 syntax_gen_pspp (s, "VALUE LABELS %ss", name);
176 for (i = 0; i < n_labels; i++)
178 const struct val_lab *vl = labels[i];
179 ds_put_cstr (s, "\n ");
180 syntax_gen_value (s, &vl->value, width, format);
181 ds_put_byte (s, ' ');
182 syntax_gen_string (s, ss_cstr (val_lab_get_escaped_label (vl)));
185 ds_put_cstr (s, ".\n");
187 if (var_has_label (var))
188 syntax_gen_pspp (s, "VARIABLE LABELS %ss %sq.\n",
189 name, var_get_label (var));
190 if (measure != var_default_measure (type))
191 syntax_gen_pspp (s, "VARIABLE LEVEL %ss (%ss).\n",
193 (measure == MEASURE_NOMINAL ? "NOMINAL"
194 : measure == MEASURE_ORDINAL ? "ORDINAL"
196 if (alignment != var_default_alignment (type))
197 syntax_gen_pspp (s, "VARIABLE ALIGNMENT %ss (%ss).\n",
199 (alignment == ALIGN_LEFT ? "LEFT"
200 : alignment == ALIGN_CENTRE ? "CENTER"
202 if (var_get_display_width (var) != var_default_display_width (width))
203 syntax_gen_pspp (s, "VARIABLE WIDTH %ss (%d).\n",
204 name, var_get_display_width (var));
208 /* Generates and returns PSPP syntax to execute the import
209 operation described by IA. The caller must free the syntax
212 generate_syntax (const struct import_assistant *ia)
214 struct string s = DS_EMPTY_INITIALIZER;
216 switch (ia->file.type)
227 if (ia->file.encoding && strcmp (ia->file.encoding, "Auto"))
228 syntax_gen_pspp (&s, " /ENCODING=%sq\n", ia->file.encoding);
229 if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (
230 ia->intro.n_cases_button)))
231 ds_put_format (&s, " /IMPORTCASES=FIRST %d\n",
232 gtk_spin_button_get_value_as_int (
233 GTK_SPIN_BUTTON (ia->intro.n_cases_spin)));
234 else if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (
235 ia->intro.percent_button)))
236 ds_put_format (&s, " /IMPORTCASES=PERCENT %d\n",
237 gtk_spin_button_get_value_as_int (
238 GTK_SPIN_BUTTON (ia->intro.percent_spin)));
240 ds_put_cstr (&s, " /IMPORTCASES=ALL\n");
242 " /ARRANGEMENT=DELIMITED\n"
244 if (ia->first_line.skip_lines > 0)
245 ds_put_format (&s, " /FIRSTCASE=%d\n", ia->first_line.skip_lines + 1);
246 ds_put_cstr (&s, " /DELIMITERS=\"");
247 if (ds_find_byte (&ia->separators.separators, '\t') != SIZE_MAX)
248 ds_put_cstr (&s, "\\t");
249 if (ds_find_byte (&ia->separators.separators, '\\') != SIZE_MAX)
250 ds_put_cstr (&s, "\\\\");
251 for (i = 0; i < ds_length (&ia->separators.separators); i++)
253 char c = ds_at (&ia->separators.separators, i);
255 ds_put_cstr (&s, "\"\"");
256 else if (c != '\t' && c != '\\')
259 ds_put_cstr (&s, "\"\n");
260 if (!ds_is_empty (&ia->separators.quotes))
261 syntax_gen_pspp (&s, " /QUALIFIER=%sq\n", ds_cstr (&ia->separators.quotes));
262 if (!ds_is_empty (&ia->separators.quotes) && ia->separators.escape)
263 ds_put_cstr (&s, " /ESCAPE\n");
264 ds_put_cstr (&s, " /VARIABLES=\n");
266 var_cnt = dict_get_var_cnt (ia->formats.dict);
267 for (i = 0; i < var_cnt; i++)
269 struct variable *var = dict_get_var (ia->formats.dict, i);
270 char format_string[FMT_STRING_LEN_MAX + 1];
271 fmt_to_string (var_get_print_format (var), format_string);
272 ds_put_format (&s, " %s %s%s\n",
273 var_get_name (var), format_string,
274 i == var_cnt - 1 ? "." : "");
277 apply_dict (ia->formats.dict, &s);
283 const struct sheet_spec_page *ssp = &ia->sheet_spec;
291 (ia->file.type == FTYPE_GNUMERIC) ? "GNM" : "ODS",
293 ssp->opts.sheet_index,
294 ssp->sri.read_names ? "ON" : "OFF");
297 if ( ssp->opts.cell_range)
300 "\n /CELLRANGE=RANGE %sq",
301 ssp->opts.cell_range);
306 "\n /CELLRANGE=FULL");
310 syntax_gen_pspp (&s, ".");
316 g_assert_not_reached ();
325 static void render_input_cell (GtkTreeViewColumn *tree_column,
326 GtkCellRenderer *cell,
327 GtkTreeModel *model, GtkTreeIter *iter,
330 static gboolean on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
331 gboolean keyboard_mode UNUSED,
333 struct import_assistant *);
337 /* Called to render one of the cells in the fields preview tree
340 render_input_cell (GtkTreeViewColumn *tree_column, GtkCellRenderer *cell,
341 GtkTreeModel *model, GtkTreeIter *iter,
344 struct import_assistant *ia = ia_;
345 struct substring field;
349 column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
351 row = empty_list_store_iter_to_row (iter) + ia->first_line.skip_lines;
352 field = ia->separators.columns[column].contents[row];
353 if (field.string != NULL)
356 g_value_init (&text, G_TYPE_STRING);
357 g_value_take_string (&text, ss_xstrdup (field));
358 g_object_set_property (G_OBJECT (cell), "text", &text);
359 g_value_unset (&text);
360 g_object_set (cell, "background-set", FALSE, (void *) NULL);
366 "background-set", TRUE,
371 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
372 const struct import_assistant *ia,
373 size_t *row, size_t *column);
376 /* Called to render a tooltip on one of the cells in the fields
377 preview tree view. */
379 on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
380 gboolean keyboard_mode UNUSED,
381 GtkTooltip *tooltip, struct import_assistant *ia)
385 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
388 if (ia->separators.columns[column].contents[row].string != NULL)
391 gtk_tooltip_set_text (tooltip,
392 _("This input line has too few separators "
393 "to fill in this field."));
398 /* Parses the contents of the field at (ROW,COLUMN) according to
399 its variable format. If OUTPUTP is non-null, then *OUTPUTP
400 receives the formatted output for that field (which must be
401 freed with free). If TOOLTIPP is non-null, then *TOOLTIPP
402 receives a message suitable for use in a tooltip, if one is
403 needed, or a null pointer otherwise. Returns true if a
404 tooltip message is needed, otherwise false. */
406 parse_field (struct import_assistant *ia,
407 size_t row, size_t column,
408 char **outputp, char **tooltipp)
410 struct substring field;
412 struct variable *var;
413 const struct fmt_spec *in;
418 field = ia->separators.columns[column].contents[row];
419 var = dict_get_var (ia->formats.dict, column);
420 value_init (&val, var_get_width (var));
421 in = var_get_print_format (var);
422 out = fmt_for_output_from_input (in);
424 if (field.string != NULL)
428 error = data_in (field, "UTF-8", in->type, &val, var_get_width (var),
429 dict_get_encoding (ia->formats.dict));
432 tooltip = xasprintf (_("Cannot parse field content `%.*s' as "
434 (int) field.length, field.string,
435 fmt_name (in->type), error);
441 tooltip = xstrdup (_("This input line has too few separators "
442 "to fill in this field."));
443 value_set_missing (&val, var_get_width (var));
447 *outputp = data_out (&val, dict_get_encoding (ia->formats.dict), &out);
449 value_destroy (&val, var_get_width (var));
451 ok = tooltip == NULL;
452 if (tooltipp != NULL)
459 /* Called to render one of the cells in the data preview tree
462 render_output_cell (GtkTreeViewColumn *tree_column,
463 GtkCellRenderer *cell,
468 struct import_assistant *ia = ia_;
470 GValue gvalue = { 0, };
473 ok = parse_field (ia,
474 (empty_list_store_iter_to_row (iter)
475 + ia->first_line.skip_lines),
476 GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
480 g_value_init (&gvalue, G_TYPE_STRING);
481 g_value_take_string (&gvalue, output);
482 g_object_set_property (G_OBJECT (cell), "text", &gvalue);
483 g_value_unset (&gvalue);
486 g_object_set (cell, "background-set", FALSE, (void *) NULL);
490 "background-set", TRUE,
494 /* Called to render a tooltip for one of the cells in the data
495 preview tree view. */
497 on_query_output_tooltip (GtkWidget *widget, gint wx, gint wy,
498 gboolean keyboard_mode UNUSED,
499 GtkTooltip *tooltip, struct import_assistant *ia)
504 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
507 if (parse_field (ia, row, column, NULL, &text))
510 gtk_tooltip_set_text (tooltip, text);
515 /* Utility functions used by multiple pages of the assistant. */
518 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
519 const struct import_assistant *ia,
520 size_t *row, size_t *column)
522 GtkTreeView *tree_view = GTK_TREE_VIEW (widget);
526 GtkTreeViewColumn *tree_column;
527 GtkTreeModel *tree_model;
530 /* Check that WIDGET is really visible on the screen before we
531 do anything else. This is a bug fix for a sticky situation:
532 when text_data_import_assistant() returns, it frees the data
533 necessary to compose the tool tip message, but there may be
534 a tool tip under preparation at that point (even if there is
535 no visible tool tip) that will call back into us a little
536 bit later. Perhaps the correct solution to this problem is
537 to make the data related to the tool tips part of a GObject
538 that only gets destroyed when all references are released,
539 but this solution appears to be effective too. */
540 if (!gtk_widget_get_mapped (widget))
543 gtk_tree_view_convert_widget_to_bin_window_coords (tree_view,
545 if (!gtk_tree_view_get_path_at_pos (tree_view, bx, by,
546 &path, &tree_column, NULL, NULL))
549 *column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
552 tree_model = gtk_tree_view_get_model (tree_view);
553 ok = gtk_tree_model_get_iter (tree_model, &iter, path);
554 gtk_tree_path_free (path);
558 *row = empty_list_store_iter_to_row (&iter) + ia->first_line.skip_lines;
563 make_tree_view (const struct import_assistant *ia,
565 GtkTreeView **tree_view)
569 *tree_view = GTK_TREE_VIEW (gtk_tree_view_new ());
570 model = GTK_TREE_MODEL (psppire_empty_list_store_new (
571 ia->file.line_cnt - first_line));
572 g_object_set_data (G_OBJECT (model), "lines", ia->file.lines + first_line);
573 g_object_set_data (G_OBJECT (model), "first-line",
574 GINT_TO_POINTER (first_line));
575 gtk_tree_view_set_model (*tree_view, model);
576 g_object_unref (model);
578 add_line_number_column (ia, *tree_view);
582 render_line_number (GtkTreeViewColumn *tree_column,
583 GtkCellRenderer *cell,
584 GtkTreeModel *tree_model,
588 gint row = empty_list_store_iter_to_row (iter);
589 char s[INT_BUFSIZE_BOUND (int)];
592 first_line = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_model),
594 sprintf (s, "%d", first_line + row);
595 g_object_set (cell, "text", s, NULL);
599 add_line_number_column (const struct import_assistant *ia,
600 GtkTreeView *treeview)
602 GtkTreeViewColumn *column;
604 column = gtk_tree_view_column_new_with_attributes (
605 _("Line"), ia->asst.prop_renderer, (void *) NULL);
606 gtk_tree_view_column_set_sizing (column, GTK_TREE_VIEW_COLUMN_FIXED);
607 gtk_tree_view_column_set_fixed_width (
608 column, get_monospace_width (treeview, ia->asst.prop_renderer, 5));
609 gtk_tree_view_column_set_resizable (column, TRUE);
610 gtk_tree_view_column_set_cell_data_func (column, ia->asst.prop_renderer,
611 render_line_number, NULL, NULL);
612 gtk_tree_view_append_column (treeview, column);
616 get_monospace_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
623 ds_put_byte_multiple (&s, '0', char_cnt);
624 ds_put_byte (&s, ' ');
625 width = get_string_width (treeview, renderer, ds_cstr (&s));
632 get_string_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
636 g_object_set (G_OBJECT (renderer), "text", string, (void *) NULL);
637 gtk_cell_renderer_get_size (renderer, GTK_WIDGET (treeview),
638 NULL, NULL, NULL, &width, NULL);
643 make_data_column (struct import_assistant *ia, GtkTreeView *tree_view,
644 bool input, gint dict_idx)
646 struct variable *var = NULL;
647 struct column *column = NULL;
649 gint content_width, header_width;
650 GtkTreeViewColumn *tree_column;
654 column = &ia->separators.columns[dict_idx];
656 var = dict_get_var (ia->formats.dict, dict_idx);
658 name = escape_underscores (input ? column->name : var_get_name (var));
659 char_cnt = input ? column->width : var_get_print_format (var)->w;
660 content_width = get_monospace_width (tree_view, ia->asst.fixed_renderer,
662 header_width = get_string_width (tree_view, ia->asst.prop_renderer,
665 tree_column = gtk_tree_view_column_new ();
666 g_object_set_data (G_OBJECT (tree_column), "column-number",
667 GINT_TO_POINTER (dict_idx));
668 gtk_tree_view_column_set_title (tree_column, name);
669 gtk_tree_view_column_pack_start (tree_column, ia->asst.fixed_renderer,
671 gtk_tree_view_column_set_cell_data_func (
672 tree_column, ia->asst.fixed_renderer,
673 input ? render_input_cell : render_output_cell, ia, NULL);
674 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_FIXED);
675 gtk_tree_view_column_set_fixed_width (tree_column, MAX (content_width,
684 create_data_tree_view (bool input, GtkContainer *parent,
685 struct import_assistant *ia)
687 GtkTreeView *tree_view;
690 make_tree_view (ia, ia->first_line.skip_lines, &tree_view);
691 gtk_tree_selection_set_mode (gtk_tree_view_get_selection (tree_view),
694 for (i = 0; i < ia->separators.column_cnt; i++)
695 gtk_tree_view_append_column (tree_view,
696 make_data_column (ia, tree_view, input, i));
698 g_object_set (G_OBJECT (tree_view), "has-tooltip", TRUE, (void *) NULL);
699 g_signal_connect (tree_view, "query-tooltip",
700 G_CALLBACK (input ? on_query_input_tooltip
701 : on_query_output_tooltip), ia);
702 gtk_tree_view_set_fixed_height_mode (tree_view, true);
704 gtk_container_add (parent, GTK_WIDGET (tree_view));
705 gtk_widget_show (GTK_WIDGET (tree_view));
710 /* Increments the "watch cursor" level, setting the cursor for
711 the assistant window to a watch face to indicate to the user
712 that the ongoing operation may take some time. */
714 push_watch_cursor (struct import_assistant *ia)
716 if (++ia->asst.watch_cursor == 1)
718 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
719 GdkDisplay *display = gtk_widget_get_display (widget);
720 GdkCursor *cursor = gdk_cursor_new_for_display (display, GDK_WATCH);
721 gdk_window_set_cursor (widget->window, cursor);
722 gdk_cursor_unref (cursor);
723 gdk_display_flush (display);
727 /* Decrements the "watch cursor" level. If the level reaches
728 zero, the cursor is reset to its default shape. */
730 pop_watch_cursor (struct import_assistant *ia)
732 if (--ia->asst.watch_cursor == 0)
734 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
735 gdk_window_set_cursor (widget->window, NULL);