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))
85 gtk_widget_show_all (GTK_WIDGET (ia->asst.assistant));
87 ia->asst.main_loop = g_main_loop_new (NULL, false);
88 g_main_loop_run (ia->asst.main_loop);
89 g_main_loop_unref (ia->asst.main_loop);
91 switch (ia->asst.response)
93 case GTK_RESPONSE_APPLY:
94 free (execute_syntax_string (dw, generate_syntax (ia)));
96 case PSPPIRE_RESPONSE_PASTE:
97 free (paste_syntax_to_window (generate_syntax (ia)));
103 destroy_formats_page (ia);
104 destroy_separators_page (ia);
106 destroy_assistant (ia);
111 /* Emits PSPP syntax to S that applies the dictionary attributes
112 (such as missing values and value labels) of the variables in
115 apply_dict (const struct dictionary *dict, struct string *s)
117 size_t var_cnt = dict_get_var_cnt (dict);
120 for (i = 0; i < var_cnt; i++)
122 struct variable *var = dict_get_var (dict, i);
123 const char *name = var_get_name (var);
124 enum val_type type = var_get_type (var);
125 int width = var_get_width (var);
126 enum measure measure = var_get_measure (var);
127 enum alignment alignment = var_get_alignment (var);
128 const struct fmt_spec *format = var_get_print_format (var);
130 if (var_has_missing_values (var))
132 const struct missing_values *mv = var_get_missing_values (var);
135 syntax_gen_pspp (s, "MISSING VALUES %ss (", name);
136 for (j = 0; j < mv_n_values (mv); j++)
139 ds_put_cstr (s, ", ");
140 syntax_gen_value (s, mv_get_value (mv, j), width, format);
143 if (mv_has_range (mv))
146 if (mv_has_value (mv))
147 ds_put_cstr (s, ", ");
148 mv_get_range (mv, &low, &high);
149 syntax_gen_num_range (s, low, high, format);
151 ds_put_cstr (s, ").\n");
153 if (var_has_value_labels (var))
155 const struct val_labs *vls = var_get_value_labels (var);
156 const struct val_lab **labels = val_labs_sorted (vls);
157 size_t n_labels = val_labs_count (vls);
160 syntax_gen_pspp (s, "VALUE LABELS %ss", name);
161 for (i = 0; i < n_labels; i++)
163 const struct val_lab *vl = labels[i];
164 ds_put_cstr (s, "\n ");
165 syntax_gen_value (s, &vl->value, width, format);
166 ds_put_byte (s, ' ');
167 syntax_gen_string (s, ss_cstr (val_lab_get_escaped_label (vl)));
170 ds_put_cstr (s, ".\n");
172 if (var_has_label (var))
173 syntax_gen_pspp (s, "VARIABLE LABELS %ss %sq.\n",
174 name, var_get_label (var));
175 if (measure != var_default_measure (type))
176 syntax_gen_pspp (s, "VARIABLE LEVEL %ss (%ss).\n",
178 (measure == MEASURE_NOMINAL ? "NOMINAL"
179 : measure == MEASURE_ORDINAL ? "ORDINAL"
181 if (alignment != var_default_alignment (type))
182 syntax_gen_pspp (s, "VARIABLE ALIGNMENT %ss (%ss).\n",
184 (alignment == ALIGN_LEFT ? "LEFT"
185 : alignment == ALIGN_CENTRE ? "CENTER"
187 if (var_get_display_width (var) != var_default_display_width (width))
188 syntax_gen_pspp (s, "VARIABLE WIDTH %ss (%d).\n",
189 name, var_get_display_width (var));
193 /* Generates and returns PSPP syntax to execute the import
194 operation described by IA. The caller must free the syntax
197 generate_syntax (const struct import_assistant *ia)
199 struct string s = DS_EMPTY_INITIALIZER;
202 if (ssp->spreadsheet == NULL)
211 if (ia->file.encoding && strcmp (ia->file.encoding, "Auto"))
212 syntax_gen_pspp (&s, " /ENCODING=%sq\n", ia->file.encoding);
214 intro_append_syntax (ia->intro, &s);
217 " /ARRANGEMENT=DELIMITED\n"
219 if (ia->first_line->skip_lines > 0)
220 ds_put_format (&s, " /FIRSTCASE=%d\n", ia->first_line->skip_lines + 1);
221 ds_put_cstr (&s, " /DELIMITERS=\"");
222 if (ds_find_byte (&ia->separators->separators, '\t') != SIZE_MAX)
223 ds_put_cstr (&s, "\\t");
224 if (ds_find_byte (&ia->separators->separators, '\\') != SIZE_MAX)
225 ds_put_cstr (&s, "\\\\");
226 for (i = 0; i < ds_length (&ia->separators->separators); i++)
228 char c = ds_at (&ia->separators->separators, i);
230 ds_put_cstr (&s, "\"\"");
231 else if (c != '\t' && c != '\\')
234 ds_put_cstr (&s, "\"\n");
235 if (!ds_is_empty (&ia->separators->quotes))
236 syntax_gen_pspp (&s, " /QUALIFIER=%sq\n", ds_cstr (&ia->separators->quotes));
237 if (!ds_is_empty (&ia->separators->quotes) && ia->separators->escape)
238 ds_put_cstr (&s, " /ESCAPE\n");
239 ds_put_cstr (&s, " /VARIABLES=\n");
241 var_cnt = dict_get_var_cnt (ia->formats->dict);
242 for (i = 0; i < var_cnt; i++)
244 struct variable *var = dict_get_var (ia->formats->dict, i);
245 char format_string[FMT_STRING_LEN_MAX + 1];
246 fmt_to_string (var_get_print_format (var), format_string);
247 ds_put_format (&s, " %s %s%s\n",
248 var_get_name (var), format_string,
249 i == var_cnt - 1 ? "." : "");
252 apply_dict (ia->formats->dict, &s);
257 const struct sheet_spec_page *ssp = ia->sheet_spec;
265 (ssp->spreadsheet->type == SPREADSHEET_GNUMERIC) ? "GNM" : "ODS",
267 ssp->opts.sheet_index,
268 ssp->sri.read_names ? "ON" : "OFF");
271 if ( ssp->opts.cell_range)
274 "\n /CELLRANGE=RANGE %sq",
275 ssp->opts.cell_range);
280 "\n /CELLRANGE=FULL");
284 syntax_gen_pspp (&s, ".");
293 static void render_input_cell (GtkTreeViewColumn *tree_column,
294 GtkCellRenderer *cell,
295 GtkTreeModel *model, GtkTreeIter *iter,
298 static gboolean on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
299 gboolean keyboard_mode UNUSED,
301 struct import_assistant *);
305 /* Called to render one of the cells in the fields preview tree
308 render_input_cell (GtkTreeViewColumn *tree_column, GtkCellRenderer *cell,
309 GtkTreeModel *model, GtkTreeIter *iter,
312 struct import_assistant *ia = ia_;
313 struct substring field;
317 column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
319 row = empty_list_store_iter_to_row (iter) + ia->skip_lines;
320 field = ia->columns[column].contents[row];
321 if (field.string != NULL)
324 g_value_init (&text, G_TYPE_STRING);
325 g_value_take_string (&text, ss_xstrdup (field));
326 g_object_set_property (G_OBJECT (cell), "text", &text);
327 g_value_unset (&text);
328 g_object_set (cell, "background-set", FALSE, (void *) NULL);
334 "background-set", TRUE,
339 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
340 const struct import_assistant *ia,
341 size_t *row, size_t *column);
344 /* Called to render a tooltip on one of the cells in the fields
345 preview tree view. */
347 on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
348 gboolean keyboard_mode UNUSED,
349 GtkTooltip *tooltip, struct import_assistant *ia)
353 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
356 if (ia->columns[column].contents[row].string != NULL)
359 gtk_tooltip_set_text (tooltip,
360 _("This input line has too few separators "
361 "to fill in this field."));
366 /* Parses the contents of the field at (ROW,COLUMN) according to
367 its variable format. If OUTPUTP is non-null, then *OUTPUTP
368 receives the formatted output for that field (which must be
369 freed with free). If TOOLTIPP is non-null, then *TOOLTIPP
370 receives a message suitable for use in a tooltip, if one is
371 needed, or a null pointer otherwise. Returns true if a
372 tooltip message is needed, otherwise false. */
374 parse_field (struct import_assistant *ia,
375 size_t row, size_t column,
376 char **outputp, char **tooltipp)
378 const struct fmt_spec *in;
383 struct substring field = ia->columns[column].contents[row];
384 struct variable *var = dict_get_var (ia->dict, column);
387 value_init (&val, var_get_width (var));
388 in = var_get_print_format (var);
389 out = fmt_for_output_from_input (in);
391 if (field.string != NULL)
395 error = data_in (field, "UTF-8", in->type, &val, var_get_width (var),
396 dict_get_encoding (ia->dict));
399 tooltip = xasprintf (_("Cannot parse field content `%.*s' as "
401 (int) field.length, field.string,
402 fmt_name (in->type), error);
408 tooltip = xstrdup (_("This input line has too few separators "
409 "to fill in this field."));
410 value_set_missing (&val, var_get_width (var));
414 *outputp = data_out (&val, dict_get_encoding (ia->dict), &out);
416 value_destroy (&val, var_get_width (var));
418 ok = tooltip == NULL;
419 if (tooltipp != NULL)
426 /* Called to render one of the cells in the data preview tree
429 render_output_cell (GtkTreeViewColumn *tree_column,
430 GtkCellRenderer *cell,
435 struct import_assistant *ia = ia_;
437 GValue gvalue = { 0, };
440 ok = parse_field (ia,
441 (empty_list_store_iter_to_row (iter)
443 GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
447 g_value_init (&gvalue, G_TYPE_STRING);
448 g_value_take_string (&gvalue, output);
449 g_object_set_property (G_OBJECT (cell), "text", &gvalue);
450 g_value_unset (&gvalue);
453 g_object_set (cell, "background-set", FALSE, (void *) NULL);
457 "background-set", TRUE,
461 /* Called to render a tooltip for one of the cells in the data
462 preview tree view. */
464 on_query_output_tooltip (GtkWidget *widget, gint wx, gint wy,
465 gboolean keyboard_mode UNUSED,
466 GtkTooltip *tooltip, struct import_assistant *ia)
471 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
474 if (parse_field (ia, row, column, NULL, &text))
477 gtk_tooltip_set_text (tooltip, text);
482 /* Utility functions used by multiple pages of the assistant. */
485 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
486 const struct import_assistant *ia,
487 size_t *row, size_t *column)
489 GtkTreeView *tree_view = GTK_TREE_VIEW (widget);
493 GtkTreeViewColumn *tree_column;
494 GtkTreeModel *tree_model;
497 /* Check that WIDGET is really visible on the screen before we
498 do anything else. This is a bug fix for a sticky situation:
499 when text_data_import_assistant() returns, it frees the data
500 necessary to compose the tool tip message, but there may be
501 a tool tip under preparation at that point (even if there is
502 no visible tool tip) that will call back into us a little
503 bit later. Perhaps the correct solution to this problem is
504 to make the data related to the tool tips part of a GObject
505 that only gets destroyed when all references are released,
506 but this solution appears to be effective too. */
507 if (!gtk_widget_get_mapped (widget))
510 gtk_tree_view_convert_widget_to_bin_window_coords (tree_view,
512 if (!gtk_tree_view_get_path_at_pos (tree_view, bx, by,
513 &path, &tree_column, NULL, NULL))
516 *column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
519 tree_model = gtk_tree_view_get_model (tree_view);
520 ok = gtk_tree_model_get_iter (tree_model, &iter, path);
521 gtk_tree_path_free (path);
525 *row = empty_list_store_iter_to_row (&iter) + ia->skip_lines;
530 make_tree_view (const struct import_assistant *ia,
532 GtkTreeView **tree_view)
536 *tree_view = GTK_TREE_VIEW (gtk_tree_view_new ());
537 model = GTK_TREE_MODEL (psppire_empty_list_store_new (
538 ia->file.line_cnt - first_line));
539 g_object_set_data (G_OBJECT (model), "lines", ia->file.lines + first_line);
540 g_object_set_data (G_OBJECT (model), "first-line",
541 GINT_TO_POINTER (first_line));
542 gtk_tree_view_set_model (*tree_view, model);
543 g_object_unref (model);
545 add_line_number_column (ia, *tree_view);
549 render_line_number (GtkTreeViewColumn *tree_column,
550 GtkCellRenderer *cell,
551 GtkTreeModel *tree_model,
555 gint row = empty_list_store_iter_to_row (iter);
556 char s[INT_BUFSIZE_BOUND (int)];
559 first_line = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_model),
561 sprintf (s, "%d", first_line + row);
562 g_object_set (cell, "text", s, NULL);
566 add_line_number_column (const struct import_assistant *ia,
567 GtkTreeView *treeview)
569 GtkTreeViewColumn *column;
571 column = gtk_tree_view_column_new_with_attributes (
572 _("Line"), ia->asst.prop_renderer, (void *) NULL);
573 gtk_tree_view_column_set_sizing (column, GTK_TREE_VIEW_COLUMN_FIXED);
574 gtk_tree_view_column_set_fixed_width (
575 column, get_monospace_width (treeview, ia->asst.prop_renderer, 5));
576 gtk_tree_view_column_set_resizable (column, TRUE);
577 gtk_tree_view_column_set_cell_data_func (column, ia->asst.prop_renderer,
578 render_line_number, NULL, NULL);
579 gtk_tree_view_append_column (treeview, column);
583 get_monospace_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
590 ds_put_byte_multiple (&s, '0', char_cnt);
591 ds_put_byte (&s, ' ');
592 width = get_string_width (treeview, renderer, ds_cstr (&s));
599 get_string_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
603 g_object_set (G_OBJECT (renderer), "text", string, (void *) NULL);
604 gtk_cell_renderer_get_size (renderer, GTK_WIDGET (treeview),
605 NULL, NULL, NULL, &width, NULL);
610 make_data_column (struct import_assistant *ia, GtkTreeView *tree_view,
611 bool input, gint dict_idx)
613 struct variable *var = NULL;
614 struct column *column = NULL;
616 gint content_width, header_width;
617 GtkTreeViewColumn *tree_column;
621 column = &ia->columns[dict_idx];
623 var = dict_get_var (ia->dict, dict_idx);
625 name = escape_underscores (input ? column->name : var_get_name (var));
626 char_cnt = input ? column->width : var_get_print_format (var)->w;
627 content_width = get_monospace_width (tree_view, ia->asst.fixed_renderer,
629 header_width = get_string_width (tree_view, ia->asst.prop_renderer,
632 tree_column = gtk_tree_view_column_new ();
633 g_object_set_data (G_OBJECT (tree_column), "column-number",
634 GINT_TO_POINTER (dict_idx));
635 gtk_tree_view_column_set_title (tree_column, name);
636 gtk_tree_view_column_pack_start (tree_column, ia->asst.fixed_renderer,
638 gtk_tree_view_column_set_cell_data_func (
639 tree_column, ia->asst.fixed_renderer,
640 input ? render_input_cell : render_output_cell, ia, NULL);
641 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_FIXED);
642 gtk_tree_view_column_set_fixed_width (tree_column, MAX (content_width,
651 create_data_tree_view (bool input, GtkContainer *parent,
652 struct import_assistant *ia)
654 GtkTreeView *tree_view;
657 make_tree_view (ia, ia->skip_lines, &tree_view);
658 gtk_tree_selection_set_mode (gtk_tree_view_get_selection (tree_view),
661 for (i = 0; i < ia->column_cnt; i++)
662 gtk_tree_view_append_column (tree_view,
663 make_data_column (ia, tree_view, input, i));
665 g_object_set (G_OBJECT (tree_view), "has-tooltip", TRUE, (void *) NULL);
666 g_signal_connect (tree_view, "query-tooltip",
667 G_CALLBACK (input ? on_query_input_tooltip
668 : on_query_output_tooltip), ia);
669 gtk_tree_view_set_fixed_height_mode (tree_view, true);
671 gtk_container_add (parent, GTK_WIDGET (tree_view));
672 gtk_widget_show (GTK_WIDGET (tree_view));
677 /* Increments the "watch cursor" level, setting the cursor for
678 the assistant window to a watch face to indicate to the user
679 that the ongoing operation may take some time. */
681 push_watch_cursor (struct import_assistant *ia)
683 if (++ia->asst.watch_cursor == 1)
685 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
686 GdkDisplay *display = gtk_widget_get_display (widget);
687 GdkCursor *cursor = gdk_cursor_new_for_display (display, GDK_WATCH);
688 gdk_window_set_cursor (widget->window, cursor);
689 gdk_cursor_unref (cursor);
690 gdk_display_flush (display);
694 /* Decrements the "watch cursor" level. If the level reaches
695 zero, the cursor is reset to its default shape. */
697 pop_watch_cursor (struct import_assistant *ia)
699 if (--ia->asst.watch_cursor == 0)
701 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
702 gdk_window_set_cursor (widget->window, NULL);