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 printf ("%s:%d %s\n", __FILE__, __LINE__, ia->file.file_name);
85 init_assistant (ia, parent_window);
86 if ( ia->file.type == FTYPE_TEXT)
89 init_first_line_page (ia);
90 init_separators_page (ia);
94 init_sheet_spec_page (ia);
97 init_formats_page (ia);
99 gtk_widget_show_all (GTK_WIDGET (ia->asst.assistant));
101 ia->asst.main_loop = g_main_loop_new (NULL, false);
102 g_main_loop_run (ia->asst.main_loop);
103 g_main_loop_unref (ia->asst.main_loop);
105 switch (ia->asst.response)
107 case GTK_RESPONSE_APPLY:
108 free (execute_syntax_string (dw, generate_syntax (ia)));
110 case PSPPIRE_RESPONSE_PASTE:
111 free (paste_syntax_to_window (generate_syntax (ia)));
117 if ( ia->file.type == FTYPE_TEXT)
119 destroy_formats_page (ia);
120 destroy_separators_page (ia);
123 destroy_assistant (ia);
128 /* Emits PSPP syntax to S that applies the dictionary attributes
129 (such as missing values and value labels) of the variables in
132 apply_dict (const struct dictionary *dict, struct string *s)
134 size_t var_cnt = dict_get_var_cnt (dict);
137 for (i = 0; i < var_cnt; i++)
139 struct variable *var = dict_get_var (dict, i);
140 const char *name = var_get_name (var);
141 enum val_type type = var_get_type (var);
142 int width = var_get_width (var);
143 enum measure measure = var_get_measure (var);
144 enum alignment alignment = var_get_alignment (var);
145 const struct fmt_spec *format = var_get_print_format (var);
147 if (var_has_missing_values (var))
149 const struct missing_values *mv = var_get_missing_values (var);
152 syntax_gen_pspp (s, "MISSING VALUES %ss (", name);
153 for (j = 0; j < mv_n_values (mv); j++)
156 ds_put_cstr (s, ", ");
157 syntax_gen_value (s, mv_get_value (mv, j), width, format);
160 if (mv_has_range (mv))
163 if (mv_has_value (mv))
164 ds_put_cstr (s, ", ");
165 mv_get_range (mv, &low, &high);
166 syntax_gen_num_range (s, low, high, format);
168 ds_put_cstr (s, ").\n");
170 if (var_has_value_labels (var))
172 const struct val_labs *vls = var_get_value_labels (var);
173 const struct val_lab **labels = val_labs_sorted (vls);
174 size_t n_labels = val_labs_count (vls);
177 syntax_gen_pspp (s, "VALUE LABELS %ss", name);
178 for (i = 0; i < n_labels; i++)
180 const struct val_lab *vl = labels[i];
181 ds_put_cstr (s, "\n ");
182 syntax_gen_value (s, &vl->value, width, format);
183 ds_put_byte (s, ' ');
184 syntax_gen_string (s, ss_cstr (val_lab_get_escaped_label (vl)));
187 ds_put_cstr (s, ".\n");
189 if (var_has_label (var))
190 syntax_gen_pspp (s, "VARIABLE LABELS %ss %sq.\n",
191 name, var_get_label (var));
192 if (measure != var_default_measure (type))
193 syntax_gen_pspp (s, "VARIABLE LEVEL %ss (%ss).\n",
195 (measure == MEASURE_NOMINAL ? "NOMINAL"
196 : measure == MEASURE_ORDINAL ? "ORDINAL"
198 if (alignment != var_default_alignment (type))
199 syntax_gen_pspp (s, "VARIABLE ALIGNMENT %ss (%ss).\n",
201 (alignment == ALIGN_LEFT ? "LEFT"
202 : alignment == ALIGN_CENTRE ? "CENTER"
204 if (var_get_display_width (var) != var_default_display_width (width))
205 syntax_gen_pspp (s, "VARIABLE WIDTH %ss (%d).\n",
206 name, var_get_display_width (var));
210 /* Generates and returns PSPP syntax to execute the import
211 operation described by IA. The caller must free the syntax
214 generate_syntax (const struct import_assistant *ia)
216 struct string s = DS_EMPTY_INITIALIZER;
218 switch (ia->file.type)
229 if (ia->file.encoding && strcmp (ia->file.encoding, "Auto"))
230 syntax_gen_pspp (&s, " /ENCODING=%sq\n", ia->file.encoding);
231 if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (
232 ia->intro.n_cases_button)))
233 ds_put_format (&s, " /IMPORTCASES=FIRST %d\n",
234 gtk_spin_button_get_value_as_int (
235 GTK_SPIN_BUTTON (ia->intro.n_cases_spin)));
236 else if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (
237 ia->intro.percent_button)))
238 ds_put_format (&s, " /IMPORTCASES=PERCENT %d\n",
239 gtk_spin_button_get_value_as_int (
240 GTK_SPIN_BUTTON (ia->intro.percent_spin)));
242 ds_put_cstr (&s, " /IMPORTCASES=ALL\n");
244 " /ARRANGEMENT=DELIMITED\n"
246 if (ia->first_line.skip_lines > 0)
247 ds_put_format (&s, " /FIRSTCASE=%d\n", ia->first_line.skip_lines + 1);
248 ds_put_cstr (&s, " /DELIMITERS=\"");
249 if (ds_find_byte (&ia->separators.separators, '\t') != SIZE_MAX)
250 ds_put_cstr (&s, "\\t");
251 if (ds_find_byte (&ia->separators.separators, '\\') != SIZE_MAX)
252 ds_put_cstr (&s, "\\\\");
253 for (i = 0; i < ds_length (&ia->separators.separators); i++)
255 char c = ds_at (&ia->separators.separators, i);
257 ds_put_cstr (&s, "\"\"");
258 else if (c != '\t' && c != '\\')
261 ds_put_cstr (&s, "\"\n");
262 if (!ds_is_empty (&ia->separators.quotes))
263 syntax_gen_pspp (&s, " /QUALIFIER=%sq\n", ds_cstr (&ia->separators.quotes));
264 if (!ds_is_empty (&ia->separators.quotes) && ia->separators.escape)
265 ds_put_cstr (&s, " /ESCAPE\n");
266 ds_put_cstr (&s, " /VARIABLES=\n");
268 var_cnt = dict_get_var_cnt (ia->formats.dict);
269 for (i = 0; i < var_cnt; i++)
271 struct variable *var = dict_get_var (ia->formats.dict, i);
272 char format_string[FMT_STRING_LEN_MAX + 1];
273 fmt_to_string (var_get_print_format (var), format_string);
274 ds_put_format (&s, " %s %s%s\n",
275 var_get_name (var), format_string,
276 i == var_cnt - 1 ? "." : "");
279 apply_dict (ia->formats.dict, &s);
285 const struct sheet_spec_page *ssp = &ia->sheet_spec;
293 (ia->file.type == FTYPE_GNUMERIC) ? "GNM" : "ODS",
295 ssp->opts.sheet_index);
300 g_assert_not_reached ();
309 static void render_input_cell (GtkTreeViewColumn *tree_column,
310 GtkCellRenderer *cell,
311 GtkTreeModel *model, GtkTreeIter *iter,
314 static gboolean on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
315 gboolean keyboard_mode UNUSED,
317 struct import_assistant *);
321 /* Called to render one of the cells in the fields preview tree
324 render_input_cell (GtkTreeViewColumn *tree_column, GtkCellRenderer *cell,
325 GtkTreeModel *model, GtkTreeIter *iter,
328 struct import_assistant *ia = ia_;
329 struct substring field;
333 column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
335 row = empty_list_store_iter_to_row (iter) + ia->first_line.skip_lines;
336 field = ia->separators.columns[column].contents[row];
337 if (field.string != NULL)
340 g_value_init (&text, G_TYPE_STRING);
341 g_value_take_string (&text, ss_xstrdup (field));
342 g_object_set_property (G_OBJECT (cell), "text", &text);
343 g_value_unset (&text);
344 g_object_set (cell, "background-set", FALSE, (void *) NULL);
350 "background-set", TRUE,
355 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
356 const struct import_assistant *ia,
357 size_t *row, size_t *column);
360 /* Called to render a tooltip on one of the cells in the fields
361 preview tree view. */
363 on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
364 gboolean keyboard_mode UNUSED,
365 GtkTooltip *tooltip, struct import_assistant *ia)
369 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
372 if (ia->separators.columns[column].contents[row].string != NULL)
375 gtk_tooltip_set_text (tooltip,
376 _("This input line has too few separators "
377 "to fill in this field."));
382 /* Parses the contents of the field at (ROW,COLUMN) according to
383 its variable format. If OUTPUTP is non-null, then *OUTPUTP
384 receives the formatted output for that field (which must be
385 freed with free). If TOOLTIPP is non-null, then *TOOLTIPP
386 receives a message suitable for use in a tooltip, if one is
387 needed, or a null pointer otherwise. Returns true if a
388 tooltip message is needed, otherwise false. */
390 parse_field (struct import_assistant *ia,
391 size_t row, size_t column,
392 char **outputp, char **tooltipp)
394 struct substring field;
396 struct variable *var;
397 const struct fmt_spec *in;
402 field = ia->separators.columns[column].contents[row];
403 var = dict_get_var (ia->formats.dict, column);
404 value_init (&val, var_get_width (var));
405 in = var_get_print_format (var);
406 out = fmt_for_output_from_input (in);
408 if (field.string != NULL)
412 error = data_in (field, "UTF-8", in->type, &val, var_get_width (var),
413 dict_get_encoding (ia->formats.dict));
416 tooltip = xasprintf (_("Cannot parse field content `%.*s' as "
418 (int) field.length, field.string,
419 fmt_name (in->type), error);
425 tooltip = xstrdup (_("This input line has too few separators "
426 "to fill in this field."));
427 value_set_missing (&val, var_get_width (var));
431 *outputp = data_out (&val, dict_get_encoding (ia->formats.dict), &out);
433 value_destroy (&val, var_get_width (var));
435 ok = tooltip == NULL;
436 if (tooltipp != NULL)
443 /* Called to render one of the cells in the data preview tree
446 render_output_cell (GtkTreeViewColumn *tree_column,
447 GtkCellRenderer *cell,
452 struct import_assistant *ia = ia_;
454 GValue gvalue = { 0, };
457 ok = parse_field (ia,
458 (empty_list_store_iter_to_row (iter)
459 + ia->first_line.skip_lines),
460 GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
464 g_value_init (&gvalue, G_TYPE_STRING);
465 g_value_take_string (&gvalue, output);
466 g_object_set_property (G_OBJECT (cell), "text", &gvalue);
467 g_value_unset (&gvalue);
470 g_object_set (cell, "background-set", FALSE, (void *) NULL);
474 "background-set", TRUE,
478 /* Called to render a tooltip for one of the cells in the data
479 preview tree view. */
481 on_query_output_tooltip (GtkWidget *widget, gint wx, gint wy,
482 gboolean keyboard_mode UNUSED,
483 GtkTooltip *tooltip, struct import_assistant *ia)
488 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
491 if (parse_field (ia, row, column, NULL, &text))
494 gtk_tooltip_set_text (tooltip, text);
499 /* Utility functions used by multiple pages of the assistant. */
502 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
503 const struct import_assistant *ia,
504 size_t *row, size_t *column)
506 GtkTreeView *tree_view = GTK_TREE_VIEW (widget);
510 GtkTreeViewColumn *tree_column;
511 GtkTreeModel *tree_model;
514 /* Check that WIDGET is really visible on the screen before we
515 do anything else. This is a bug fix for a sticky situation:
516 when text_data_import_assistant() returns, it frees the data
517 necessary to compose the tool tip message, but there may be
518 a tool tip under preparation at that point (even if there is
519 no visible tool tip) that will call back into us a little
520 bit later. Perhaps the correct solution to this problem is
521 to make the data related to the tool tips part of a GObject
522 that only gets destroyed when all references are released,
523 but this solution appears to be effective too. */
524 if (!gtk_widget_get_mapped (widget))
527 gtk_tree_view_convert_widget_to_bin_window_coords (tree_view,
529 if (!gtk_tree_view_get_path_at_pos (tree_view, bx, by,
530 &path, &tree_column, NULL, NULL))
533 *column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
536 tree_model = gtk_tree_view_get_model (tree_view);
537 ok = gtk_tree_model_get_iter (tree_model, &iter, path);
538 gtk_tree_path_free (path);
542 *row = empty_list_store_iter_to_row (&iter) + ia->first_line.skip_lines;
547 make_tree_view (const struct import_assistant *ia,
549 GtkTreeView **tree_view)
553 *tree_view = GTK_TREE_VIEW (gtk_tree_view_new ());
554 model = GTK_TREE_MODEL (psppire_empty_list_store_new (
555 ia->file.line_cnt - first_line));
556 g_object_set_data (G_OBJECT (model), "lines", ia->file.lines + first_line);
557 g_object_set_data (G_OBJECT (model), "first-line",
558 GINT_TO_POINTER (first_line));
559 gtk_tree_view_set_model (*tree_view, model);
560 g_object_unref (model);
562 add_line_number_column (ia, *tree_view);
566 render_line_number (GtkTreeViewColumn *tree_column,
567 GtkCellRenderer *cell,
568 GtkTreeModel *tree_model,
572 gint row = empty_list_store_iter_to_row (iter);
573 char s[INT_BUFSIZE_BOUND (int)];
576 first_line = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_model),
578 sprintf (s, "%d", first_line + row);
579 g_object_set (cell, "text", s, NULL);
583 add_line_number_column (const struct import_assistant *ia,
584 GtkTreeView *treeview)
586 GtkTreeViewColumn *column;
588 column = gtk_tree_view_column_new_with_attributes (
589 _("Line"), ia->asst.prop_renderer, (void *) NULL);
590 gtk_tree_view_column_set_sizing (column, GTK_TREE_VIEW_COLUMN_FIXED);
591 gtk_tree_view_column_set_fixed_width (
592 column, get_monospace_width (treeview, ia->asst.prop_renderer, 5));
593 gtk_tree_view_column_set_resizable (column, TRUE);
594 gtk_tree_view_column_set_cell_data_func (column, ia->asst.prop_renderer,
595 render_line_number, NULL, NULL);
596 gtk_tree_view_append_column (treeview, column);
600 get_monospace_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
607 ds_put_byte_multiple (&s, '0', char_cnt);
608 ds_put_byte (&s, ' ');
609 width = get_string_width (treeview, renderer, ds_cstr (&s));
616 get_string_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
620 g_object_set (G_OBJECT (renderer), "text", string, (void *) NULL);
621 gtk_cell_renderer_get_size (renderer, GTK_WIDGET (treeview),
622 NULL, NULL, NULL, &width, NULL);
627 make_data_column (struct import_assistant *ia, GtkTreeView *tree_view,
628 bool input, gint dict_idx)
630 struct variable *var = NULL;
631 struct column *column = NULL;
633 gint content_width, header_width;
634 GtkTreeViewColumn *tree_column;
638 column = &ia->separators.columns[dict_idx];
640 var = dict_get_var (ia->formats.dict, dict_idx);
642 name = escape_underscores (input ? column->name : var_get_name (var));
643 char_cnt = input ? column->width : var_get_print_format (var)->w;
644 content_width = get_monospace_width (tree_view, ia->asst.fixed_renderer,
646 header_width = get_string_width (tree_view, ia->asst.prop_renderer,
649 tree_column = gtk_tree_view_column_new ();
650 g_object_set_data (G_OBJECT (tree_column), "column-number",
651 GINT_TO_POINTER (dict_idx));
652 gtk_tree_view_column_set_title (tree_column, name);
653 gtk_tree_view_column_pack_start (tree_column, ia->asst.fixed_renderer,
655 gtk_tree_view_column_set_cell_data_func (
656 tree_column, ia->asst.fixed_renderer,
657 input ? render_input_cell : render_output_cell, ia, NULL);
658 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_FIXED);
659 gtk_tree_view_column_set_fixed_width (tree_column, MAX (content_width,
668 create_data_tree_view (bool input, GtkContainer *parent,
669 struct import_assistant *ia)
671 GtkTreeView *tree_view;
674 make_tree_view (ia, ia->first_line.skip_lines, &tree_view);
675 gtk_tree_selection_set_mode (gtk_tree_view_get_selection (tree_view),
678 for (i = 0; i < ia->separators.column_cnt; i++)
679 gtk_tree_view_append_column (tree_view,
680 make_data_column (ia, tree_view, input, i));
682 g_object_set (G_OBJECT (tree_view), "has-tooltip", TRUE, (void *) NULL);
683 g_signal_connect (tree_view, "query-tooltip",
684 G_CALLBACK (input ? on_query_input_tooltip
685 : on_query_output_tooltip), ia);
686 gtk_tree_view_set_fixed_height_mode (tree_view, true);
688 gtk_container_add (parent, GTK_WIDGET (tree_view));
689 gtk_widget_show (GTK_WIDGET (tree_view));
694 /* Increments the "watch cursor" level, setting the cursor for
695 the assistant window to a watch face to indicate to the user
696 that the ongoing operation may take some time. */
698 push_watch_cursor (struct import_assistant *ia)
700 if (++ia->asst.watch_cursor == 1)
702 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
703 GdkDisplay *display = gtk_widget_get_display (widget);
704 GdkCursor *cursor = gdk_cursor_new_for_display (display, GDK_WATCH);
705 gdk_window_set_cursor (widget->window, cursor);
706 gdk_cursor_unref (cursor);
707 gdk_display_flush (display);
711 /* Decrements the "watch cursor" level. If the level reaches
712 zero, the cursor is reset to its default shape. */
714 pop_watch_cursor (struct import_assistant *ia)
716 if (--ia->asst.watch_cursor == 0)
718 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
719 gdk_window_set_cursor (widget->window, NULL);