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 GtkBuilder *builder = ia->asst.builder;
76 struct sheet_spec_page *ssp ;
78 if (!init_file (ia, parent_window))
88 ia->sheet_spec = sheet_spec_page_create (ia);
92 ia->intro = intro_page_create (ia);
93 ia->separators = separators_page_create (ia);
94 ia->first_line = first_line_page_create (ia);
96 ia->formats = formats_page_create (ia);
98 gtk_widget_show_all (GTK_WIDGET (ia->asst.assistant));
100 ia->asst.main_loop = g_main_loop_new (NULL, false);
101 g_main_loop_run (ia->asst.main_loop);
102 g_main_loop_unref (ia->asst.main_loop);
104 switch (ia->asst.response)
106 case GTK_RESPONSE_APPLY:
107 free (execute_syntax_string (dw, generate_syntax (ia)));
109 case PSPPIRE_RESPONSE_PASTE:
110 free (paste_syntax_to_window (generate_syntax (ia)));
118 destroy_formats_page (ia);
119 destroy_separators_page (ia);
122 destroy_assistant (ia);
127 /* Emits PSPP syntax to S that applies the dictionary attributes
128 (such as missing values and value labels) of the variables in
131 apply_dict (const struct dictionary *dict, struct string *s)
133 size_t var_cnt = dict_get_var_cnt (dict);
136 for (i = 0; i < var_cnt; i++)
138 struct variable *var = dict_get_var (dict, i);
139 const char *name = var_get_name (var);
140 enum val_type type = var_get_type (var);
141 int width = var_get_width (var);
142 enum measure measure = var_get_measure (var);
143 enum alignment alignment = var_get_alignment (var);
144 const struct fmt_spec *format = var_get_print_format (var);
146 if (var_has_missing_values (var))
148 const struct missing_values *mv = var_get_missing_values (var);
151 syntax_gen_pspp (s, "MISSING VALUES %ss (", name);
152 for (j = 0; j < mv_n_values (mv); j++)
155 ds_put_cstr (s, ", ");
156 syntax_gen_value (s, mv_get_value (mv, j), width, format);
159 if (mv_has_range (mv))
162 if (mv_has_value (mv))
163 ds_put_cstr (s, ", ");
164 mv_get_range (mv, &low, &high);
165 syntax_gen_num_range (s, low, high, format);
167 ds_put_cstr (s, ").\n");
169 if (var_has_value_labels (var))
171 const struct val_labs *vls = var_get_value_labels (var);
172 const struct val_lab **labels = val_labs_sorted (vls);
173 size_t n_labels = val_labs_count (vls);
176 syntax_gen_pspp (s, "VALUE LABELS %ss", name);
177 for (i = 0; i < n_labels; i++)
179 const struct val_lab *vl = labels[i];
180 ds_put_cstr (s, "\n ");
181 syntax_gen_value (s, &vl->value, width, format);
182 ds_put_byte (s, ' ');
183 syntax_gen_string (s, ss_cstr (val_lab_get_escaped_label (vl)));
186 ds_put_cstr (s, ".\n");
188 if (var_has_label (var))
189 syntax_gen_pspp (s, "VARIABLE LABELS %ss %sq.\n",
190 name, var_get_label (var));
191 if (measure != var_default_measure (type))
192 syntax_gen_pspp (s, "VARIABLE LEVEL %ss (%ss).\n",
194 (measure == MEASURE_NOMINAL ? "NOMINAL"
195 : measure == MEASURE_ORDINAL ? "ORDINAL"
197 if (alignment != var_default_alignment (type))
198 syntax_gen_pspp (s, "VARIABLE ALIGNMENT %ss (%ss).\n",
200 (alignment == ALIGN_LEFT ? "LEFT"
201 : alignment == ALIGN_CENTRE ? "CENTER"
203 if (var_get_display_width (var) != var_default_display_width (width))
204 syntax_gen_pspp (s, "VARIABLE WIDTH %ss (%d).\n",
205 name, var_get_display_width (var));
209 /* Generates and returns PSPP syntax to execute the import
210 operation described by IA. The caller must free the syntax
213 generate_syntax (const struct import_assistant *ia)
215 struct string s = DS_EMPTY_INITIALIZER;
217 if (ia->spreadsheet == NULL)
226 if (ia->file.encoding && strcmp (ia->file.encoding, "Auto"))
227 syntax_gen_pspp (&s, " /ENCODING=%sq\n", ia->file.encoding);
229 intro_append_syntax (ia->intro, &s);
232 " /ARRANGEMENT=DELIMITED\n"
236 if (ia->first_line->skip_lines > 0)
237 ds_put_format (&s, " /FIRSTCASE=%d\n", ia->first_line->skip_lines + 1);
238 ds_put_cstr (&s, " /DELIMITERS=\"");
239 if (ds_find_byte (&ia->separators->separators, '\t') != SIZE_MAX)
240 ds_put_cstr (&s, "\\t");
241 if (ds_find_byte (&ia->separators->separators, '\\') != SIZE_MAX)
242 ds_put_cstr (&s, "\\\\");
243 for (i = 0; i < ds_length (&ia->separators->separators); i++)
245 char c = ds_at (&ia->separators->separators, i);
247 ds_put_cstr (&s, "\"\"");
248 else if (c != '\t' && c != '\\')
251 ds_put_cstr (&s, "\"\n");
252 if (!ds_is_empty (&ia->separators->quotes))
253 syntax_gen_pspp (&s, " /QUALIFIER=%sq\n", ds_cstr (&ia->separators->quotes));
254 if (!ds_is_empty (&ia->separators->quotes) && ia->separators->escape)
255 ds_put_cstr (&s, " /ESCAPE\n");
256 ds_put_cstr (&s, " /VARIABLES=\n");
258 var_cnt = dict_get_var_cnt (ia->formats->dict);
259 for (i = 0; i < var_cnt; i++)
261 struct variable *var = dict_get_var (ia->formats->dict, i);
262 char format_string[FMT_STRING_LEN_MAX + 1];
263 fmt_to_string (var_get_print_format (var), format_string);
264 ds_put_format (&s, " %s %s%s\n",
265 var_get_name (var), format_string,
266 i == var_cnt - 1 ? "." : "");
270 apply_dict (ia->formats->dict, &s);
275 return sheet_spec_gen_syntax (ia);
283 static void render_input_cell (GtkTreeViewColumn *tree_column,
284 GtkCellRenderer *cell,
285 GtkTreeModel *model, GtkTreeIter *iter,
288 static gboolean on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
289 gboolean keyboard_mode UNUSED,
291 struct import_assistant *);
295 /* Called to render one of the cells in the fields preview tree
298 render_input_cell (GtkTreeViewColumn *tree_column, GtkCellRenderer *cell,
299 GtkTreeModel *model, GtkTreeIter *iter,
302 struct import_assistant *ia = ia_;
303 struct substring field;
307 column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
309 row = empty_list_store_iter_to_row (iter) + ia->skip_lines;
310 field = ia->columns[column].contents[row];
311 if (field.string != NULL)
314 g_value_init (&text, G_TYPE_STRING);
315 g_value_take_string (&text, ss_xstrdup (field));
316 g_object_set_property (G_OBJECT (cell), "text", &text);
317 g_value_unset (&text);
318 g_object_set (cell, "background-set", FALSE, (void *) NULL);
324 "background-set", TRUE,
329 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
330 const struct import_assistant *ia,
331 size_t *row, size_t *column);
334 /* Called to render a tooltip on one of the cells in the fields
335 preview tree view. */
337 on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
338 gboolean keyboard_mode UNUSED,
339 GtkTooltip *tooltip, struct import_assistant *ia)
343 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
346 if (ia->columns[column].contents[row].string != NULL)
349 gtk_tooltip_set_text (tooltip,
350 _("This input line has too few separators "
351 "to fill in this field."));
356 /* Parses the contents of the field at (ROW,COLUMN) according to
357 its variable format. If OUTPUTP is non-null, then *OUTPUTP
358 receives the formatted output for that field (which must be
359 freed with free). If TOOLTIPP is non-null, then *TOOLTIPP
360 receives a message suitable for use in a tooltip, if one is
361 needed, or a null pointer otherwise. Returns true if a
362 tooltip message is needed, otherwise false. */
364 parse_field (struct import_assistant *ia,
365 size_t row, size_t column,
366 char **outputp, char **tooltipp)
368 const struct fmt_spec *in;
373 struct substring field = ia->columns[column].contents[row];
374 struct variable *var = dict_get_var (ia->dict, column);
377 value_init (&val, var_get_width (var));
378 in = var_get_print_format (var);
379 out = fmt_for_output_from_input (in);
381 if (field.string != NULL)
385 error = data_in (field, "UTF-8", in->type, &val, var_get_width (var),
386 dict_get_encoding (ia->dict));
389 tooltip = xasprintf (_("Cannot parse field content `%.*s' as "
391 (int) field.length, field.string,
392 fmt_name (in->type), error);
398 tooltip = xstrdup (_("This input line has too few separators "
399 "to fill in this field."));
400 value_set_missing (&val, var_get_width (var));
404 *outputp = data_out (&val, dict_get_encoding (ia->dict), &out);
406 value_destroy (&val, var_get_width (var));
408 ok = tooltip == NULL;
409 if (tooltipp != NULL)
416 /* Called to render one of the cells in the data preview tree
419 render_output_cell (GtkTreeViewColumn *tree_column,
420 GtkCellRenderer *cell,
425 struct import_assistant *ia = ia_;
427 GValue gvalue = { 0, };
430 ok = parse_field (ia,
431 (empty_list_store_iter_to_row (iter)
433 GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
437 g_value_init (&gvalue, G_TYPE_STRING);
438 g_value_take_string (&gvalue, output);
439 g_object_set_property (G_OBJECT (cell), "text", &gvalue);
440 g_value_unset (&gvalue);
443 g_object_set (cell, "background-set", FALSE, (void *) NULL);
447 "background-set", TRUE,
451 /* Called to render a tooltip for one of the cells in the data
452 preview tree view. */
454 on_query_output_tooltip (GtkWidget *widget, gint wx, gint wy,
455 gboolean keyboard_mode UNUSED,
456 GtkTooltip *tooltip, struct import_assistant *ia)
461 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
464 if (parse_field (ia, row, column, NULL, &text))
467 gtk_tooltip_set_text (tooltip, text);
472 /* Utility functions used by multiple pages of the assistant. */
475 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
476 const struct import_assistant *ia,
477 size_t *row, size_t *column)
479 GtkTreeView *tree_view = GTK_TREE_VIEW (widget);
483 GtkTreeViewColumn *tree_column;
484 GtkTreeModel *tree_model;
487 /* Check that WIDGET is really visible on the screen before we
488 do anything else. This is a bug fix for a sticky situation:
489 when text_data_import_assistant() returns, it frees the data
490 necessary to compose the tool tip message, but there may be
491 a tool tip under preparation at that point (even if there is
492 no visible tool tip) that will call back into us a little
493 bit later. Perhaps the correct solution to this problem is
494 to make the data related to the tool tips part of a GObject
495 that only gets destroyed when all references are released,
496 but this solution appears to be effective too. */
497 if (!gtk_widget_get_mapped (widget))
500 gtk_tree_view_convert_widget_to_bin_window_coords (tree_view,
502 if (!gtk_tree_view_get_path_at_pos (tree_view, bx, by,
503 &path, &tree_column, NULL, NULL))
506 *column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
509 tree_model = gtk_tree_view_get_model (tree_view);
510 ok = gtk_tree_model_get_iter (tree_model, &iter, path);
511 gtk_tree_path_free (path);
515 *row = empty_list_store_iter_to_row (&iter) + ia->skip_lines;
520 make_tree_view (const struct import_assistant *ia,
522 GtkTreeView **tree_view)
526 *tree_view = GTK_TREE_VIEW (gtk_tree_view_new ());
527 model = GTK_TREE_MODEL (psppire_empty_list_store_new (
528 ia->file.line_cnt - first_line));
529 g_object_set_data (G_OBJECT (model), "lines", ia->file.lines + first_line);
530 g_object_set_data (G_OBJECT (model), "first-line",
531 GINT_TO_POINTER (first_line));
532 gtk_tree_view_set_model (*tree_view, model);
533 g_object_unref (model);
535 add_line_number_column (ia, *tree_view);
539 render_line_number (GtkTreeViewColumn *tree_column,
540 GtkCellRenderer *cell,
541 GtkTreeModel *tree_model,
545 gint row = empty_list_store_iter_to_row (iter);
546 char s[INT_BUFSIZE_BOUND (int)];
549 first_line = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_model),
551 sprintf (s, "%d", first_line + row);
552 g_object_set (cell, "text", s, NULL);
556 add_line_number_column (const struct import_assistant *ia,
557 GtkTreeView *treeview)
559 GtkTreeViewColumn *column;
561 column = gtk_tree_view_column_new_with_attributes (
562 _("Line"), ia->asst.prop_renderer, (void *) NULL);
563 gtk_tree_view_column_set_sizing (column, GTK_TREE_VIEW_COLUMN_FIXED);
564 gtk_tree_view_column_set_fixed_width (
565 column, get_monospace_width (treeview, ia->asst.prop_renderer, 5));
566 gtk_tree_view_column_set_resizable (column, TRUE);
567 gtk_tree_view_column_set_cell_data_func (column, ia->asst.prop_renderer,
568 render_line_number, NULL, NULL);
569 gtk_tree_view_append_column (treeview, column);
573 get_monospace_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
580 ds_put_byte_multiple (&s, '0', char_cnt);
581 ds_put_byte (&s, ' ');
582 width = get_string_width (treeview, renderer, ds_cstr (&s));
589 get_string_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
593 g_object_set (G_OBJECT (renderer), "text", string, (void *) NULL);
594 gtk_cell_renderer_get_size (renderer, GTK_WIDGET (treeview),
595 NULL, NULL, NULL, &width, NULL);
600 make_data_column (struct import_assistant *ia, GtkTreeView *tree_view,
601 bool input, gint dict_idx)
603 struct variable *var = NULL;
604 struct column *column = NULL;
606 gint content_width, header_width;
607 GtkTreeViewColumn *tree_column;
611 column = &ia->columns[dict_idx];
613 var = dict_get_var (ia->dict, dict_idx);
615 name = escape_underscores (input ? column->name : var_get_name (var));
616 char_cnt = input ? column->width : var_get_print_format (var)->w;
617 content_width = get_monospace_width (tree_view, ia->asst.fixed_renderer,
619 header_width = get_string_width (tree_view, ia->asst.prop_renderer,
622 tree_column = gtk_tree_view_column_new ();
623 g_object_set_data (G_OBJECT (tree_column), "column-number",
624 GINT_TO_POINTER (dict_idx));
625 gtk_tree_view_column_set_title (tree_column, name);
626 gtk_tree_view_column_pack_start (tree_column, ia->asst.fixed_renderer,
628 gtk_tree_view_column_set_cell_data_func (
629 tree_column, ia->asst.fixed_renderer,
630 input ? render_input_cell : render_output_cell, ia, NULL);
631 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_FIXED);
632 gtk_tree_view_column_set_fixed_width (tree_column, MAX (content_width,
641 create_data_tree_view (bool input, GtkContainer *parent,
642 struct import_assistant *ia)
644 GtkTreeView *tree_view;
647 make_tree_view (ia, ia->skip_lines, &tree_view);
648 gtk_tree_selection_set_mode (gtk_tree_view_get_selection (tree_view),
651 for (i = 0; i < ia->column_cnt; i++)
652 gtk_tree_view_append_column (tree_view,
653 make_data_column (ia, tree_view, input, i));
655 g_object_set (G_OBJECT (tree_view), "has-tooltip", TRUE, (void *) NULL);
656 g_signal_connect (tree_view, "query-tooltip",
657 G_CALLBACK (input ? on_query_input_tooltip
658 : on_query_output_tooltip), ia);
659 gtk_tree_view_set_fixed_height_mode (tree_view, true);
661 gtk_container_add (parent, GTK_WIDGET (tree_view));
662 gtk_widget_show (GTK_WIDGET (tree_view));
667 /* Increments the "watch cursor" level, setting the cursor for
668 the assistant window to a watch face to indicate to the user
669 that the ongoing operation may take some time. */
671 push_watch_cursor (struct import_assistant *ia)
673 if (++ia->asst.watch_cursor == 1)
675 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
676 GdkDisplay *display = gtk_widget_get_display (widget);
677 GdkCursor *cursor = gdk_cursor_new_for_display (display, GDK_WATCH);
678 gdk_window_set_cursor (widget->window, cursor);
679 gdk_cursor_unref (cursor);
680 gdk_display_flush (display);
684 /* Decrements the "watch cursor" level. If the level reaches
685 zero, the cursor is reset to its default shape. */
687 pop_watch_cursor (struct import_assistant *ia)
689 if (--ia->asst.watch_cursor == 0)
691 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
692 gdk_window_set_cursor (widget->window, NULL);