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 = init_assistant (parent_window);
75 struct sheet_spec_page *ssp ;
77 if (!init_file (ia, parent_window))
84 init_first_line_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);
109 destroy_assistant (ia);
114 /* Emits PSPP syntax to S that applies the dictionary attributes
115 (such as missing values and value labels) of the variables in
118 apply_dict (const struct dictionary *dict, struct string *s)
120 size_t var_cnt = dict_get_var_cnt (dict);
123 for (i = 0; i < var_cnt; i++)
125 struct variable *var = dict_get_var (dict, i);
126 const char *name = var_get_name (var);
127 enum val_type type = var_get_type (var);
128 int width = var_get_width (var);
129 enum measure measure = var_get_measure (var);
130 enum alignment alignment = var_get_alignment (var);
131 const struct fmt_spec *format = var_get_print_format (var);
133 if (var_has_missing_values (var))
135 const struct missing_values *mv = var_get_missing_values (var);
138 syntax_gen_pspp (s, "MISSING VALUES %ss (", name);
139 for (j = 0; j < mv_n_values (mv); j++)
142 ds_put_cstr (s, ", ");
143 syntax_gen_value (s, mv_get_value (mv, j), width, format);
146 if (mv_has_range (mv))
149 if (mv_has_value (mv))
150 ds_put_cstr (s, ", ");
151 mv_get_range (mv, &low, &high);
152 syntax_gen_num_range (s, low, high, format);
154 ds_put_cstr (s, ").\n");
156 if (var_has_value_labels (var))
158 const struct val_labs *vls = var_get_value_labels (var);
159 const struct val_lab **labels = val_labs_sorted (vls);
160 size_t n_labels = val_labs_count (vls);
163 syntax_gen_pspp (s, "VALUE LABELS %ss", name);
164 for (i = 0; i < n_labels; i++)
166 const struct val_lab *vl = labels[i];
167 ds_put_cstr (s, "\n ");
168 syntax_gen_value (s, &vl->value, width, format);
169 ds_put_byte (s, ' ');
170 syntax_gen_string (s, ss_cstr (val_lab_get_escaped_label (vl)));
173 ds_put_cstr (s, ".\n");
175 if (var_has_label (var))
176 syntax_gen_pspp (s, "VARIABLE LABELS %ss %sq.\n",
177 name, var_get_label (var));
178 if (measure != var_default_measure (type))
179 syntax_gen_pspp (s, "VARIABLE LEVEL %ss (%ss).\n",
181 (measure == MEASURE_NOMINAL ? "NOMINAL"
182 : measure == MEASURE_ORDINAL ? "ORDINAL"
184 if (alignment != var_default_alignment (type))
185 syntax_gen_pspp (s, "VARIABLE ALIGNMENT %ss (%ss).\n",
187 (alignment == ALIGN_LEFT ? "LEFT"
188 : alignment == ALIGN_CENTRE ? "CENTER"
190 if (var_get_display_width (var) != var_default_display_width (width))
191 syntax_gen_pspp (s, "VARIABLE WIDTH %ss (%d).\n",
192 name, var_get_display_width (var));
196 /* Generates and returns PSPP syntax to execute the import
197 operation described by IA. The caller must free the syntax
200 generate_syntax (const struct import_assistant *ia)
202 struct string s = DS_EMPTY_INITIALIZER;
205 if (ssp->spreadsheet == NULL)
214 if (ia->file.encoding && strcmp (ia->file.encoding, "Auto"))
215 syntax_gen_pspp (&s, " /ENCODING=%sq\n", ia->file.encoding);
217 intro_append_syntax (ia->intro, &s);
220 " /ARRANGEMENT=DELIMITED\n"
222 if (ia->first_line->skip_lines > 0)
223 ds_put_format (&s, " /FIRSTCASE=%d\n", ia->first_line->skip_lines + 1);
224 ds_put_cstr (&s, " /DELIMITERS=\"");
225 if (ds_find_byte (&ia->separators->separators, '\t') != SIZE_MAX)
226 ds_put_cstr (&s, "\\t");
227 if (ds_find_byte (&ia->separators->separators, '\\') != SIZE_MAX)
228 ds_put_cstr (&s, "\\\\");
229 for (i = 0; i < ds_length (&ia->separators->separators); i++)
231 char c = ds_at (&ia->separators->separators, i);
233 ds_put_cstr (&s, "\"\"");
234 else if (c != '\t' && c != '\\')
237 ds_put_cstr (&s, "\"\n");
238 if (!ds_is_empty (&ia->separators->quotes))
239 syntax_gen_pspp (&s, " /QUALIFIER=%sq\n", ds_cstr (&ia->separators->quotes));
240 if (!ds_is_empty (&ia->separators->quotes) && ia->separators->escape)
241 ds_put_cstr (&s, " /ESCAPE\n");
242 ds_put_cstr (&s, " /VARIABLES=\n");
244 var_cnt = dict_get_var_cnt (ia->formats->dict);
245 for (i = 0; i < var_cnt; i++)
247 struct variable *var = dict_get_var (ia->formats->dict, i);
248 char format_string[FMT_STRING_LEN_MAX + 1];
249 fmt_to_string (var_get_print_format (var), format_string);
250 ds_put_format (&s, " %s %s%s\n",
251 var_get_name (var), format_string,
252 i == var_cnt - 1 ? "." : "");
255 apply_dict (ia->formats->dict, &s);
260 const struct sheet_spec_page *ssp = ia->sheet_spec;
268 (ssp->spreadsheet->type == SPREADSHEET_GNUMERIC) ? "GNM" : "ODS",
270 ssp->opts.sheet_index,
271 ssp->sri.read_names ? "ON" : "OFF");
274 if ( ssp->opts.cell_range)
277 "\n /CELLRANGE=RANGE %sq",
278 ssp->opts.cell_range);
283 "\n /CELLRANGE=FULL");
287 syntax_gen_pspp (&s, ".");
296 static void render_input_cell (GtkTreeViewColumn *tree_column,
297 GtkCellRenderer *cell,
298 GtkTreeModel *model, GtkTreeIter *iter,
301 static gboolean on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
302 gboolean keyboard_mode UNUSED,
304 struct import_assistant *);
308 /* Called to render one of the cells in the fields preview tree
311 render_input_cell (GtkTreeViewColumn *tree_column, GtkCellRenderer *cell,
312 GtkTreeModel *model, GtkTreeIter *iter,
315 struct import_assistant *ia = ia_;
316 struct substring field;
320 column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
322 row = empty_list_store_iter_to_row (iter) + ia->first_line->skip_lines;
323 field = ia->columns[column].contents[row];
324 if (field.string != NULL)
327 g_value_init (&text, G_TYPE_STRING);
328 g_value_take_string (&text, ss_xstrdup (field));
329 g_object_set_property (G_OBJECT (cell), "text", &text);
330 g_value_unset (&text);
331 g_object_set (cell, "background-set", FALSE, (void *) NULL);
337 "background-set", TRUE,
342 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
343 const struct import_assistant *ia,
344 size_t *row, size_t *column);
347 /* Called to render a tooltip on one of the cells in the fields
348 preview tree view. */
350 on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
351 gboolean keyboard_mode UNUSED,
352 GtkTooltip *tooltip, struct import_assistant *ia)
356 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
359 if (ia->columns[column].contents[row].string != NULL)
362 gtk_tooltip_set_text (tooltip,
363 _("This input line has too few separators "
364 "to fill in this field."));
369 /* Parses the contents of the field at (ROW,COLUMN) according to
370 its variable format. If OUTPUTP is non-null, then *OUTPUTP
371 receives the formatted output for that field (which must be
372 freed with free). If TOOLTIPP is non-null, then *TOOLTIPP
373 receives a message suitable for use in a tooltip, if one is
374 needed, or a null pointer otherwise. Returns true if a
375 tooltip message is needed, otherwise false. */
377 parse_field (struct import_assistant *ia,
378 size_t row, size_t column,
379 char **outputp, char **tooltipp)
381 struct substring field;
383 struct variable *var;
384 const struct fmt_spec *in;
389 field = ia->columns[column].contents[row];
390 var = dict_get_var (ia->formats->dict, column);
391 value_init (&val, var_get_width (var));
392 in = var_get_print_format (var);
393 out = fmt_for_output_from_input (in);
395 if (field.string != NULL)
399 error = data_in (field, "UTF-8", in->type, &val, var_get_width (var),
400 dict_get_encoding (ia->formats->dict));
403 tooltip = xasprintf (_("Cannot parse field content `%.*s' as "
405 (int) field.length, field.string,
406 fmt_name (in->type), error);
412 tooltip = xstrdup (_("This input line has too few separators "
413 "to fill in this field."));
414 value_set_missing (&val, var_get_width (var));
418 *outputp = data_out (&val, dict_get_encoding (ia->formats->dict), &out);
420 value_destroy (&val, var_get_width (var));
422 ok = tooltip == NULL;
423 if (tooltipp != NULL)
430 /* Called to render one of the cells in the data preview tree
433 render_output_cell (GtkTreeViewColumn *tree_column,
434 GtkCellRenderer *cell,
439 struct import_assistant *ia = ia_;
441 GValue gvalue = { 0, };
444 ok = parse_field (ia,
445 (empty_list_store_iter_to_row (iter)
446 + ia->first_line->skip_lines),
447 GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
451 g_value_init (&gvalue, G_TYPE_STRING);
452 g_value_take_string (&gvalue, output);
453 g_object_set_property (G_OBJECT (cell), "text", &gvalue);
454 g_value_unset (&gvalue);
457 g_object_set (cell, "background-set", FALSE, (void *) NULL);
461 "background-set", TRUE,
465 /* Called to render a tooltip for one of the cells in the data
466 preview tree view. */
468 on_query_output_tooltip (GtkWidget *widget, gint wx, gint wy,
469 gboolean keyboard_mode UNUSED,
470 GtkTooltip *tooltip, struct import_assistant *ia)
475 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
478 if (parse_field (ia, row, column, NULL, &text))
481 gtk_tooltip_set_text (tooltip, text);
486 /* Utility functions used by multiple pages of the assistant. */
489 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
490 const struct import_assistant *ia,
491 size_t *row, size_t *column)
493 GtkTreeView *tree_view = GTK_TREE_VIEW (widget);
497 GtkTreeViewColumn *tree_column;
498 GtkTreeModel *tree_model;
501 /* Check that WIDGET is really visible on the screen before we
502 do anything else. This is a bug fix for a sticky situation:
503 when text_data_import_assistant() returns, it frees the data
504 necessary to compose the tool tip message, but there may be
505 a tool tip under preparation at that point (even if there is
506 no visible tool tip) that will call back into us a little
507 bit later. Perhaps the correct solution to this problem is
508 to make the data related to the tool tips part of a GObject
509 that only gets destroyed when all references are released,
510 but this solution appears to be effective too. */
511 if (!gtk_widget_get_mapped (widget))
514 gtk_tree_view_convert_widget_to_bin_window_coords (tree_view,
516 if (!gtk_tree_view_get_path_at_pos (tree_view, bx, by,
517 &path, &tree_column, NULL, NULL))
520 *column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
523 tree_model = gtk_tree_view_get_model (tree_view);
524 ok = gtk_tree_model_get_iter (tree_model, &iter, path);
525 gtk_tree_path_free (path);
529 *row = empty_list_store_iter_to_row (&iter) + ia->first_line->skip_lines;
534 make_tree_view (const struct import_assistant *ia,
536 GtkTreeView **tree_view)
540 *tree_view = GTK_TREE_VIEW (gtk_tree_view_new ());
541 model = GTK_TREE_MODEL (psppire_empty_list_store_new (
542 ia->file.line_cnt - first_line));
543 g_object_set_data (G_OBJECT (model), "lines", ia->file.lines + first_line);
544 g_object_set_data (G_OBJECT (model), "first-line",
545 GINT_TO_POINTER (first_line));
546 gtk_tree_view_set_model (*tree_view, model);
547 g_object_unref (model);
549 add_line_number_column (ia, *tree_view);
553 render_line_number (GtkTreeViewColumn *tree_column,
554 GtkCellRenderer *cell,
555 GtkTreeModel *tree_model,
559 gint row = empty_list_store_iter_to_row (iter);
560 char s[INT_BUFSIZE_BOUND (int)];
563 first_line = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_model),
565 sprintf (s, "%d", first_line + row);
566 g_object_set (cell, "text", s, NULL);
570 add_line_number_column (const struct import_assistant *ia,
571 GtkTreeView *treeview)
573 GtkTreeViewColumn *column;
575 column = gtk_tree_view_column_new_with_attributes (
576 _("Line"), ia->asst.prop_renderer, (void *) NULL);
577 gtk_tree_view_column_set_sizing (column, GTK_TREE_VIEW_COLUMN_FIXED);
578 gtk_tree_view_column_set_fixed_width (
579 column, get_monospace_width (treeview, ia->asst.prop_renderer, 5));
580 gtk_tree_view_column_set_resizable (column, TRUE);
581 gtk_tree_view_column_set_cell_data_func (column, ia->asst.prop_renderer,
582 render_line_number, NULL, NULL);
583 gtk_tree_view_append_column (treeview, column);
587 get_monospace_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
594 ds_put_byte_multiple (&s, '0', char_cnt);
595 ds_put_byte (&s, ' ');
596 width = get_string_width (treeview, renderer, ds_cstr (&s));
603 get_string_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
607 g_object_set (G_OBJECT (renderer), "text", string, (void *) NULL);
608 gtk_cell_renderer_get_size (renderer, GTK_WIDGET (treeview),
609 NULL, NULL, NULL, &width, NULL);
614 make_data_column (struct import_assistant *ia, GtkTreeView *tree_view,
615 bool input, gint dict_idx)
617 struct variable *var = NULL;
618 struct column *column = NULL;
620 gint content_width, header_width;
621 GtkTreeViewColumn *tree_column;
625 column = &ia->columns[dict_idx];
627 var = dict_get_var (ia->formats->dict, dict_idx);
629 name = escape_underscores (input ? column->name : var_get_name (var));
630 char_cnt = input ? column->width : var_get_print_format (var)->w;
631 content_width = get_monospace_width (tree_view, ia->asst.fixed_renderer,
633 header_width = get_string_width (tree_view, ia->asst.prop_renderer,
636 tree_column = gtk_tree_view_column_new ();
637 g_object_set_data (G_OBJECT (tree_column), "column-number",
638 GINT_TO_POINTER (dict_idx));
639 gtk_tree_view_column_set_title (tree_column, name);
640 gtk_tree_view_column_pack_start (tree_column, ia->asst.fixed_renderer,
642 gtk_tree_view_column_set_cell_data_func (
643 tree_column, ia->asst.fixed_renderer,
644 input ? render_input_cell : render_output_cell, ia, NULL);
645 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_FIXED);
646 gtk_tree_view_column_set_fixed_width (tree_column, MAX (content_width,
655 create_data_tree_view (bool input, GtkContainer *parent,
656 struct import_assistant *ia)
658 GtkTreeView *tree_view;
661 make_tree_view (ia, ia->first_line->skip_lines, &tree_view);
662 gtk_tree_selection_set_mode (gtk_tree_view_get_selection (tree_view),
665 for (i = 0; i < ia->column_cnt; i++)
666 gtk_tree_view_append_column (tree_view,
667 make_data_column (ia, tree_view, input, i));
669 g_object_set (G_OBJECT (tree_view), "has-tooltip", TRUE, (void *) NULL);
670 g_signal_connect (tree_view, "query-tooltip",
671 G_CALLBACK (input ? on_query_input_tooltip
672 : on_query_output_tooltip), ia);
673 gtk_tree_view_set_fixed_height_mode (tree_view, true);
675 gtk_container_add (parent, GTK_WIDGET (tree_view));
676 gtk_widget_show (GTK_WIDGET (tree_view));
681 /* Increments the "watch cursor" level, setting the cursor for
682 the assistant window to a watch face to indicate to the user
683 that the ongoing operation may take some time. */
685 push_watch_cursor (struct import_assistant *ia)
687 if (++ia->asst.watch_cursor == 1)
689 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
690 GdkDisplay *display = gtk_widget_get_display (widget);
691 GdkCursor *cursor = gdk_cursor_new_for_display (display, GDK_WATCH);
692 gdk_window_set_cursor (widget->window, cursor);
693 gdk_cursor_unref (cursor);
694 gdk_display_flush (display);
698 /* Decrements the "watch cursor" level. If the level reaches
699 zero, the cursor is reset to its default shape. */
701 pop_watch_cursor (struct import_assistant *ia)
703 if (--ia->asst.watch_cursor == 0)
705 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
706 gdk_window_set_cursor (widget->window, NULL);