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);
85 init_separators_page (ia);
87 init_formats_page (ia);
89 gtk_widget_show_all (GTK_WIDGET (ia->asst.assistant));
91 ia->asst.main_loop = g_main_loop_new (NULL, false);
92 g_main_loop_run (ia->asst.main_loop);
93 g_main_loop_unref (ia->asst.main_loop);
95 switch (ia->asst.response)
97 case GTK_RESPONSE_APPLY:
98 free (execute_syntax_string (dw, generate_syntax (ia)));
100 case PSPPIRE_RESPONSE_PASTE:
101 free (paste_syntax_to_window (generate_syntax (ia)));
107 destroy_formats_page (ia);
108 destroy_separators_page (ia);
110 destroy_assistant (ia);
115 /* Emits PSPP syntax to S that applies the dictionary attributes
116 (such as missing values and value labels) of the variables in
119 apply_dict (const struct dictionary *dict, struct string *s)
121 size_t var_cnt = dict_get_var_cnt (dict);
124 for (i = 0; i < var_cnt; i++)
126 struct variable *var = dict_get_var (dict, i);
127 const char *name = var_get_name (var);
128 enum val_type type = var_get_type (var);
129 int width = var_get_width (var);
130 enum measure measure = var_get_measure (var);
131 enum alignment alignment = var_get_alignment (var);
132 const struct fmt_spec *format = var_get_print_format (var);
134 if (var_has_missing_values (var))
136 const struct missing_values *mv = var_get_missing_values (var);
139 syntax_gen_pspp (s, "MISSING VALUES %ss (", name);
140 for (j = 0; j < mv_n_values (mv); j++)
143 ds_put_cstr (s, ", ");
144 syntax_gen_value (s, mv_get_value (mv, j), width, format);
147 if (mv_has_range (mv))
150 if (mv_has_value (mv))
151 ds_put_cstr (s, ", ");
152 mv_get_range (mv, &low, &high);
153 syntax_gen_num_range (s, low, high, format);
155 ds_put_cstr (s, ").\n");
157 if (var_has_value_labels (var))
159 const struct val_labs *vls = var_get_value_labels (var);
160 const struct val_lab **labels = val_labs_sorted (vls);
161 size_t n_labels = val_labs_count (vls);
164 syntax_gen_pspp (s, "VALUE LABELS %ss", name);
165 for (i = 0; i < n_labels; i++)
167 const struct val_lab *vl = labels[i];
168 ds_put_cstr (s, "\n ");
169 syntax_gen_value (s, &vl->value, width, format);
170 ds_put_byte (s, ' ');
171 syntax_gen_string (s, ss_cstr (val_lab_get_escaped_label (vl)));
174 ds_put_cstr (s, ".\n");
176 if (var_has_label (var))
177 syntax_gen_pspp (s, "VARIABLE LABELS %ss %sq.\n",
178 name, var_get_label (var));
179 if (measure != var_default_measure (type))
180 syntax_gen_pspp (s, "VARIABLE LEVEL %ss (%ss).\n",
182 (measure == MEASURE_NOMINAL ? "NOMINAL"
183 : measure == MEASURE_ORDINAL ? "ORDINAL"
185 if (alignment != var_default_alignment (type))
186 syntax_gen_pspp (s, "VARIABLE ALIGNMENT %ss (%ss).\n",
188 (alignment == ALIGN_LEFT ? "LEFT"
189 : alignment == ALIGN_CENTRE ? "CENTER"
191 if (var_get_display_width (var) != var_default_display_width (width))
192 syntax_gen_pspp (s, "VARIABLE WIDTH %ss (%d).\n",
193 name, var_get_display_width (var));
197 /* Generates and returns PSPP syntax to execute the import
198 operation described by IA. The caller must free the syntax
201 generate_syntax (const struct import_assistant *ia)
203 struct string s = DS_EMPTY_INITIALIZER;
206 if (ssp->spreadsheet == NULL)
215 if (ia->file.encoding && strcmp (ia->file.encoding, "Auto"))
216 syntax_gen_pspp (&s, " /ENCODING=%sq\n", ia->file.encoding);
218 intro_append_syntax (ia->intro, &s);
221 " /ARRANGEMENT=DELIMITED\n"
223 if (ia->first_line->skip_lines > 0)
224 ds_put_format (&s, " /FIRSTCASE=%d\n", ia->first_line->skip_lines + 1);
225 ds_put_cstr (&s, " /DELIMITERS=\"");
226 if (ds_find_byte (&ia->separators->separators, '\t') != SIZE_MAX)
227 ds_put_cstr (&s, "\\t");
228 if (ds_find_byte (&ia->separators->separators, '\\') != SIZE_MAX)
229 ds_put_cstr (&s, "\\\\");
230 for (i = 0; i < ds_length (&ia->separators->separators); i++)
232 char c = ds_at (&ia->separators->separators, i);
234 ds_put_cstr (&s, "\"\"");
235 else if (c != '\t' && c != '\\')
238 ds_put_cstr (&s, "\"\n");
239 if (!ds_is_empty (&ia->separators->quotes))
240 syntax_gen_pspp (&s, " /QUALIFIER=%sq\n", ds_cstr (&ia->separators->quotes));
241 if (!ds_is_empty (&ia->separators->quotes) && ia->separators->escape)
242 ds_put_cstr (&s, " /ESCAPE\n");
243 ds_put_cstr (&s, " /VARIABLES=\n");
245 var_cnt = dict_get_var_cnt (ia->formats->dict);
246 for (i = 0; i < var_cnt; i++)
248 struct variable *var = dict_get_var (ia->formats->dict, i);
249 char format_string[FMT_STRING_LEN_MAX + 1];
250 fmt_to_string (var_get_print_format (var), format_string);
251 ds_put_format (&s, " %s %s%s\n",
252 var_get_name (var), format_string,
253 i == var_cnt - 1 ? "." : "");
256 apply_dict (ia->formats->dict, &s);
261 const struct sheet_spec_page *ssp = ia->sheet_spec;
269 (ssp->spreadsheet->type == SPREADSHEET_GNUMERIC) ? "GNM" : "ODS",
271 ssp->opts.sheet_index,
272 ssp->sri.read_names ? "ON" : "OFF");
275 if ( ssp->opts.cell_range)
278 "\n /CELLRANGE=RANGE %sq",
279 ssp->opts.cell_range);
284 "\n /CELLRANGE=FULL");
288 syntax_gen_pspp (&s, ".");
297 static void render_input_cell (GtkTreeViewColumn *tree_column,
298 GtkCellRenderer *cell,
299 GtkTreeModel *model, GtkTreeIter *iter,
302 static gboolean on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
303 gboolean keyboard_mode UNUSED,
305 struct import_assistant *);
309 /* Called to render one of the cells in the fields preview tree
312 render_input_cell (GtkTreeViewColumn *tree_column, GtkCellRenderer *cell,
313 GtkTreeModel *model, GtkTreeIter *iter,
316 struct import_assistant *ia = ia_;
317 struct substring field;
321 column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
323 row = empty_list_store_iter_to_row (iter) + ia->first_line->skip_lines;
324 field = ia->columns[column].contents[row];
325 if (field.string != NULL)
328 g_value_init (&text, G_TYPE_STRING);
329 g_value_take_string (&text, ss_xstrdup (field));
330 g_object_set_property (G_OBJECT (cell), "text", &text);
331 g_value_unset (&text);
332 g_object_set (cell, "background-set", FALSE, (void *) NULL);
338 "background-set", TRUE,
343 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
344 const struct import_assistant *ia,
345 size_t *row, size_t *column);
348 /* Called to render a tooltip on one of the cells in the fields
349 preview tree view. */
351 on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
352 gboolean keyboard_mode UNUSED,
353 GtkTooltip *tooltip, struct import_assistant *ia)
357 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
360 if (ia->columns[column].contents[row].string != NULL)
363 gtk_tooltip_set_text (tooltip,
364 _("This input line has too few separators "
365 "to fill in this field."));
370 /* Parses the contents of the field at (ROW,COLUMN) according to
371 its variable format. If OUTPUTP is non-null, then *OUTPUTP
372 receives the formatted output for that field (which must be
373 freed with free). If TOOLTIPP is non-null, then *TOOLTIPP
374 receives a message suitable for use in a tooltip, if one is
375 needed, or a null pointer otherwise. Returns true if a
376 tooltip message is needed, otherwise false. */
378 parse_field (struct import_assistant *ia,
379 size_t row, size_t column,
380 char **outputp, char **tooltipp)
382 struct substring field;
384 struct variable *var;
385 const struct fmt_spec *in;
390 field = ia->columns[column].contents[row];
391 var = dict_get_var (ia->formats->dict, column);
392 value_init (&val, var_get_width (var));
393 in = var_get_print_format (var);
394 out = fmt_for_output_from_input (in);
396 if (field.string != NULL)
400 error = data_in (field, "UTF-8", in->type, &val, var_get_width (var),
401 dict_get_encoding (ia->formats->dict));
404 tooltip = xasprintf (_("Cannot parse field content `%.*s' as "
406 (int) field.length, field.string,
407 fmt_name (in->type), error);
413 tooltip = xstrdup (_("This input line has too few separators "
414 "to fill in this field."));
415 value_set_missing (&val, var_get_width (var));
419 *outputp = data_out (&val, dict_get_encoding (ia->formats->dict), &out);
421 value_destroy (&val, var_get_width (var));
423 ok = tooltip == NULL;
424 if (tooltipp != NULL)
431 /* Called to render one of the cells in the data preview tree
434 render_output_cell (GtkTreeViewColumn *tree_column,
435 GtkCellRenderer *cell,
440 struct import_assistant *ia = ia_;
442 GValue gvalue = { 0, };
445 ok = parse_field (ia,
446 (empty_list_store_iter_to_row (iter)
447 + ia->first_line->skip_lines),
448 GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
452 g_value_init (&gvalue, G_TYPE_STRING);
453 g_value_take_string (&gvalue, output);
454 g_object_set_property (G_OBJECT (cell), "text", &gvalue);
455 g_value_unset (&gvalue);
458 g_object_set (cell, "background-set", FALSE, (void *) NULL);
462 "background-set", TRUE,
466 /* Called to render a tooltip for one of the cells in the data
467 preview tree view. */
469 on_query_output_tooltip (GtkWidget *widget, gint wx, gint wy,
470 gboolean keyboard_mode UNUSED,
471 GtkTooltip *tooltip, struct import_assistant *ia)
476 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
479 if (parse_field (ia, row, column, NULL, &text))
482 gtk_tooltip_set_text (tooltip, text);
487 /* Utility functions used by multiple pages of the assistant. */
490 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
491 const struct import_assistant *ia,
492 size_t *row, size_t *column)
494 GtkTreeView *tree_view = GTK_TREE_VIEW (widget);
498 GtkTreeViewColumn *tree_column;
499 GtkTreeModel *tree_model;
502 /* Check that WIDGET is really visible on the screen before we
503 do anything else. This is a bug fix for a sticky situation:
504 when text_data_import_assistant() returns, it frees the data
505 necessary to compose the tool tip message, but there may be
506 a tool tip under preparation at that point (even if there is
507 no visible tool tip) that will call back into us a little
508 bit later. Perhaps the correct solution to this problem is
509 to make the data related to the tool tips part of a GObject
510 that only gets destroyed when all references are released,
511 but this solution appears to be effective too. */
512 if (!gtk_widget_get_mapped (widget))
515 gtk_tree_view_convert_widget_to_bin_window_coords (tree_view,
517 if (!gtk_tree_view_get_path_at_pos (tree_view, bx, by,
518 &path, &tree_column, NULL, NULL))
521 *column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
524 tree_model = gtk_tree_view_get_model (tree_view);
525 ok = gtk_tree_model_get_iter (tree_model, &iter, path);
526 gtk_tree_path_free (path);
530 *row = empty_list_store_iter_to_row (&iter) + ia->first_line->skip_lines;
535 make_tree_view (const struct import_assistant *ia,
537 GtkTreeView **tree_view)
541 *tree_view = GTK_TREE_VIEW (gtk_tree_view_new ());
542 model = GTK_TREE_MODEL (psppire_empty_list_store_new (
543 ia->file.line_cnt - first_line));
544 g_object_set_data (G_OBJECT (model), "lines", ia->file.lines + first_line);
545 g_object_set_data (G_OBJECT (model), "first-line",
546 GINT_TO_POINTER (first_line));
547 gtk_tree_view_set_model (*tree_view, model);
548 g_object_unref (model);
550 add_line_number_column (ia, *tree_view);
554 render_line_number (GtkTreeViewColumn *tree_column,
555 GtkCellRenderer *cell,
556 GtkTreeModel *tree_model,
560 gint row = empty_list_store_iter_to_row (iter);
561 char s[INT_BUFSIZE_BOUND (int)];
564 first_line = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_model),
566 sprintf (s, "%d", first_line + row);
567 g_object_set (cell, "text", s, NULL);
571 add_line_number_column (const struct import_assistant *ia,
572 GtkTreeView *treeview)
574 GtkTreeViewColumn *column;
576 column = gtk_tree_view_column_new_with_attributes (
577 _("Line"), ia->asst.prop_renderer, (void *) NULL);
578 gtk_tree_view_column_set_sizing (column, GTK_TREE_VIEW_COLUMN_FIXED);
579 gtk_tree_view_column_set_fixed_width (
580 column, get_monospace_width (treeview, ia->asst.prop_renderer, 5));
581 gtk_tree_view_column_set_resizable (column, TRUE);
582 gtk_tree_view_column_set_cell_data_func (column, ia->asst.prop_renderer,
583 render_line_number, NULL, NULL);
584 gtk_tree_view_append_column (treeview, column);
588 get_monospace_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
595 ds_put_byte_multiple (&s, '0', char_cnt);
596 ds_put_byte (&s, ' ');
597 width = get_string_width (treeview, renderer, ds_cstr (&s));
604 get_string_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
608 g_object_set (G_OBJECT (renderer), "text", string, (void *) NULL);
609 gtk_cell_renderer_get_size (renderer, GTK_WIDGET (treeview),
610 NULL, NULL, NULL, &width, NULL);
615 make_data_column (struct import_assistant *ia, GtkTreeView *tree_view,
616 bool input, gint dict_idx)
618 struct variable *var = NULL;
619 struct column *column = NULL;
621 gint content_width, header_width;
622 GtkTreeViewColumn *tree_column;
626 column = &ia->columns[dict_idx];
628 var = dict_get_var (ia->formats->dict, dict_idx);
630 name = escape_underscores (input ? column->name : var_get_name (var));
631 char_cnt = input ? column->width : var_get_print_format (var)->w;
632 content_width = get_monospace_width (tree_view, ia->asst.fixed_renderer,
634 header_width = get_string_width (tree_view, ia->asst.prop_renderer,
637 tree_column = gtk_tree_view_column_new ();
638 g_object_set_data (G_OBJECT (tree_column), "column-number",
639 GINT_TO_POINTER (dict_idx));
640 gtk_tree_view_column_set_title (tree_column, name);
641 gtk_tree_view_column_pack_start (tree_column, ia->asst.fixed_renderer,
643 gtk_tree_view_column_set_cell_data_func (
644 tree_column, ia->asst.fixed_renderer,
645 input ? render_input_cell : render_output_cell, ia, NULL);
646 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_FIXED);
647 gtk_tree_view_column_set_fixed_width (tree_column, MAX (content_width,
656 create_data_tree_view (bool input, GtkContainer *parent,
657 struct import_assistant *ia)
659 GtkTreeView *tree_view;
662 make_tree_view (ia, ia->first_line->skip_lines, &tree_view);
663 gtk_tree_selection_set_mode (gtk_tree_view_get_selection (tree_view),
666 for (i = 0; i < ia->column_cnt; i++)
667 gtk_tree_view_append_column (tree_view,
668 make_data_column (ia, tree_view, input, i));
670 g_object_set (G_OBJECT (tree_view), "has-tooltip", TRUE, (void *) NULL);
671 g_signal_connect (tree_view, "query-tooltip",
672 G_CALLBACK (input ? on_query_input_tooltip
673 : on_query_output_tooltip), ia);
674 gtk_tree_view_set_fixed_height_mode (tree_view, true);
676 gtk_container_add (parent, GTK_WIDGET (tree_view));
677 gtk_widget_show (GTK_WIDGET (tree_view));
682 /* Increments the "watch cursor" level, setting the cursor for
683 the assistant window to a watch face to indicate to the user
684 that the ongoing operation may take some time. */
686 push_watch_cursor (struct import_assistant *ia)
688 if (++ia->asst.watch_cursor == 1)
690 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
691 GdkDisplay *display = gtk_widget_get_display (widget);
692 GdkCursor *cursor = gdk_cursor_new_for_display (display, GDK_WATCH);
693 gdk_window_set_cursor (widget->window, cursor);
694 gdk_cursor_unref (cursor);
695 gdk_display_flush (display);
699 /* Decrements the "watch cursor" level. If the level reaches
700 zero, the cursor is reset to its default shape. */
702 pop_watch_cursor (struct import_assistant *ia)
704 if (--ia->asst.watch_cursor == 0)
706 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
707 gdk_window_set_cursor (widget->window, NULL);