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"
21 #include "page-intro.h"
22 #include "page-sheet-spec.h"
23 #include "page-first-line.h"
24 #include "page-separators.h"
25 #include "page-formats.h"
29 #include <gtk-contrib/psppire-sheet.h>
35 #include "data/data-in.h"
36 #include "data/data-out.h"
37 #include "data/format-guesser.h"
38 #include "data/value-labels.h"
39 #include "language/data-io/data-parser.h"
40 #include "language/lexer/lexer.h"
41 #include "libpspp/assertion.h"
42 #include "libpspp/i18n.h"
43 #include "libpspp/line-reader.h"
44 #include "libpspp/message.h"
45 #include "ui/gui/checkbox-treeview.h"
46 #include "ui/gui/dialog-common.h"
47 #include "ui/gui/executor.h"
48 #include "ui/gui/helper.h"
49 #include "ui/gui/builder-wrapper.h"
50 #include "ui/gui/psppire-data-window.h"
51 #include "ui/gui/psppire-dialog.h"
52 #include "ui/gui/psppire-encoding-selector.h"
53 #include "ui/gui/psppire-empty-list-store.h"
54 #include "ui/gui/psppire-var-sheet.h"
55 #include "ui/gui/psppire-var-store.h"
56 #include "ui/gui/psppire-scanf.h"
57 #include "ui/syntax-gen.h"
60 #include "gl/intprops.h"
61 #include "gl/xalloc.h"
64 #define _(msgid) gettext (msgid)
65 #define N_(msgid) msgid
67 struct import_assistant;
69 static void apply_dict (const struct dictionary *, struct string *);
70 static char *generate_syntax (const struct import_assistant *);
72 static void add_line_number_column (const struct import_assistant *,
75 /* Pops up the Text Data Import assistant. */
77 text_data_import_assistant (PsppireDataWindow *dw)
79 GtkWindow *parent_window = GTK_WINDOW (dw);
80 struct import_assistant *ia = init_assistant (parent_window);
81 struct sheet_spec_page *ssp ;
83 if (!init_file (ia, parent_window))
93 ia->sheet_spec = sheet_spec_page_create (ia);
97 ia->intro = intro_page_create (ia);
98 ia->separators = separators_page_create (ia);
99 ia->first_line = first_line_page_create (ia);
101 printf ("%s:%d %p\n", __FILE__, __LINE__, ia->intro);
103 ia->formats = formats_page_create (ia);
105 gtk_widget_show_all (GTK_WIDGET (ia->asst.assistant));
107 ia->asst.main_loop = g_main_loop_new (NULL, false);
108 g_main_loop_run (ia->asst.main_loop);
109 g_main_loop_unref (ia->asst.main_loop);
111 switch (ia->asst.response)
113 case GTK_RESPONSE_APPLY:
114 free (execute_syntax_string (dw, generate_syntax (ia)));
116 case PSPPIRE_RESPONSE_PASTE:
117 free (paste_syntax_to_window (generate_syntax (ia)));
125 destroy_formats_page (ia);
126 destroy_separators_page (ia);
129 destroy_assistant (ia);
134 /* Emits PSPP syntax to S that applies the dictionary attributes
135 (such as missing values and value labels) of the variables in
138 apply_dict (const struct dictionary *dict, struct string *s)
140 size_t var_cnt = dict_get_var_cnt (dict);
143 for (i = 0; i < var_cnt; i++)
145 struct variable *var = dict_get_var (dict, i);
146 const char *name = var_get_name (var);
147 enum val_type type = var_get_type (var);
148 int width = var_get_width (var);
149 enum measure measure = var_get_measure (var);
150 enum alignment alignment = var_get_alignment (var);
151 const struct fmt_spec *format = var_get_print_format (var);
153 if (var_has_missing_values (var))
155 const struct missing_values *mv = var_get_missing_values (var);
158 syntax_gen_pspp (s, "MISSING VALUES %ss (", name);
159 for (j = 0; j < mv_n_values (mv); j++)
162 ds_put_cstr (s, ", ");
163 syntax_gen_value (s, mv_get_value (mv, j), width, format);
166 if (mv_has_range (mv))
169 if (mv_has_value (mv))
170 ds_put_cstr (s, ", ");
171 mv_get_range (mv, &low, &high);
172 syntax_gen_num_range (s, low, high, format);
174 ds_put_cstr (s, ").\n");
176 if (var_has_value_labels (var))
178 const struct val_labs *vls = var_get_value_labels (var);
179 const struct val_lab **labels = val_labs_sorted (vls);
180 size_t n_labels = val_labs_count (vls);
183 syntax_gen_pspp (s, "VALUE LABELS %ss", name);
184 for (i = 0; i < n_labels; i++)
186 const struct val_lab *vl = labels[i];
187 ds_put_cstr (s, "\n ");
188 syntax_gen_value (s, &vl->value, width, format);
189 ds_put_byte (s, ' ');
190 syntax_gen_string (s, ss_cstr (val_lab_get_escaped_label (vl)));
193 ds_put_cstr (s, ".\n");
195 if (var_has_label (var))
196 syntax_gen_pspp (s, "VARIABLE LABELS %ss %sq.\n",
197 name, var_get_label (var));
198 if (measure != var_default_measure (type))
199 syntax_gen_pspp (s, "VARIABLE LEVEL %ss (%ss).\n",
201 (measure == MEASURE_NOMINAL ? "NOMINAL"
202 : measure == MEASURE_ORDINAL ? "ORDINAL"
204 if (alignment != var_default_alignment (type))
205 syntax_gen_pspp (s, "VARIABLE ALIGNMENT %ss (%ss).\n",
207 (alignment == ALIGN_LEFT ? "LEFT"
208 : alignment == ALIGN_CENTRE ? "CENTER"
210 if (var_get_display_width (var) != var_default_display_width (width))
211 syntax_gen_pspp (s, "VARIABLE WIDTH %ss (%d).\n",
212 name, var_get_display_width (var));
216 /* Generates and returns PSPP syntax to execute the import
217 operation described by IA. The caller must free the syntax
220 generate_syntax (const struct import_assistant *ia)
222 struct string s = DS_EMPTY_INITIALIZER;
224 if (ia->spreadsheet == NULL)
231 if (ia->file.encoding && strcmp (ia->file.encoding, "Auto"))
232 syntax_gen_pspp (&s, " /ENCODING=%sq\n", ia->file.encoding);
235 intro_append_syntax (ia->intro, &s);
238 " /ARRANGEMENT=DELIMITED\n"
242 if (ia->first_line->skip_lines > 0)
243 ds_put_format (&s, " /FIRSTCASE=%d\n", ia->first_line->skip_lines + 1);
244 ds_put_cstr (&s, " /DELIMITERS=\"");
245 if (ds_find_byte (&ia->separators->separators, '\t') != SIZE_MAX)
246 ds_put_cstr (&s, "\\t");
247 if (ds_find_byte (&ia->separators->separators, '\\') != SIZE_MAX)
248 ds_put_cstr (&s, "\\\\");
249 for (i = 0; i < ds_length (&ia->separators->separators); i++)
251 char c = ds_at (&ia->separators->separators, i);
253 ds_put_cstr (&s, "\"\"");
254 else if (c != '\t' && c != '\\')
257 ds_put_cstr (&s, "\"\n");
258 if (!ds_is_empty (&ia->separators->quotes))
259 syntax_gen_pspp (&s, " /QUALIFIER=%sq\n", ds_cstr (&ia->separators->quotes));
260 if (!ds_is_empty (&ia->separators->quotes) && ia->separators->escape)
261 ds_put_cstr (&s, " /ESCAPE\n");
262 ds_put_cstr (&s, " /VARIABLES=\n");
264 var_cnt = dict_get_var_cnt (ia->formats->dict);
265 for (i = 0; i < var_cnt; i++)
267 struct variable *var = dict_get_var (ia->formats->dict, i);
268 char format_string[FMT_STRING_LEN_MAX + 1];
269 fmt_to_string (var_get_print_format (var), format_string);
270 ds_put_format (&s, " %s %s%s\n",
271 var_get_name (var), format_string,
272 i == var_cnt - 1 ? "." : "");
276 apply_dict (ia->formats->dict, &s);
281 return sheet_spec_gen_syntax (ia);
289 static void render_input_cell (GtkTreeViewColumn *tree_column,
290 GtkCellRenderer *cell,
291 GtkTreeModel *model, GtkTreeIter *iter,
294 static gboolean on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
295 gboolean keyboard_mode UNUSED,
297 struct import_assistant *);
301 /* Called to render one of the cells in the fields preview tree
304 render_input_cell (GtkTreeViewColumn *tree_column, GtkCellRenderer *cell,
305 GtkTreeModel *model, GtkTreeIter *iter,
308 struct import_assistant *ia = ia_;
309 struct substring field;
313 column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
315 row = empty_list_store_iter_to_row (iter) + ia->skip_lines;
316 field = ia->columns[column].contents[row];
317 if (field.string != NULL)
320 g_value_init (&text, G_TYPE_STRING);
321 g_value_take_string (&text, ss_xstrdup (field));
322 g_object_set_property (G_OBJECT (cell), "text", &text);
323 g_value_unset (&text);
324 g_object_set (cell, "background-set", FALSE, (void *) NULL);
330 "background-set", TRUE,
335 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
336 const struct import_assistant *ia,
337 size_t *row, size_t *column);
340 /* Called to render a tooltip on one of the cells in the fields
341 preview tree view. */
343 on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
344 gboolean keyboard_mode UNUSED,
345 GtkTooltip *tooltip, struct import_assistant *ia)
349 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
352 if (ia->columns[column].contents[row].string != NULL)
355 gtk_tooltip_set_text (tooltip,
356 _("This input line has too few separators "
357 "to fill in this field."));
362 /* Parses the contents of the field at (ROW,COLUMN) according to
363 its variable format. If OUTPUTP is non-null, then *OUTPUTP
364 receives the formatted output for that field (which must be
365 freed with free). If TOOLTIPP is non-null, then *TOOLTIPP
366 receives a message suitable for use in a tooltip, if one is
367 needed, or a null pointer otherwise. Returns true if a
368 tooltip message is needed, otherwise false. */
370 parse_field (struct import_assistant *ia,
371 size_t row, size_t column,
372 char **outputp, char **tooltipp)
374 const struct fmt_spec *in;
379 struct substring field = ia->columns[column].contents[row];
380 struct variable *var = dict_get_var (ia->dict, column);
383 value_init (&val, var_get_width (var));
384 in = var_get_print_format (var);
385 out = fmt_for_output_from_input (in);
387 if (field.string != NULL)
391 error = data_in (field, "UTF-8", in->type, &val, var_get_width (var),
392 dict_get_encoding (ia->dict));
395 tooltip = xasprintf (_("Cannot parse field content `%.*s' as "
397 (int) field.length, field.string,
398 fmt_name (in->type), error);
404 tooltip = xstrdup (_("This input line has too few separators "
405 "to fill in this field."));
406 value_set_missing (&val, var_get_width (var));
410 *outputp = data_out (&val, dict_get_encoding (ia->dict), &out);
412 value_destroy (&val, var_get_width (var));
414 ok = tooltip == NULL;
415 if (tooltipp != NULL)
422 /* Called to render one of the cells in the data preview tree
425 render_output_cell (GtkTreeViewColumn *tree_column,
426 GtkCellRenderer *cell,
431 struct import_assistant *ia = ia_;
433 GValue gvalue = { 0, };
436 ok = parse_field (ia,
437 (empty_list_store_iter_to_row (iter)
439 GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
443 g_value_init (&gvalue, G_TYPE_STRING);
444 g_value_take_string (&gvalue, output);
445 g_object_set_property (G_OBJECT (cell), "text", &gvalue);
446 g_value_unset (&gvalue);
449 g_object_set (cell, "background-set", FALSE, (void *) NULL);
453 "background-set", TRUE,
457 /* Called to render a tooltip for one of the cells in the data
458 preview tree view. */
460 on_query_output_tooltip (GtkWidget *widget, gint wx, gint wy,
461 gboolean keyboard_mode UNUSED,
462 GtkTooltip *tooltip, struct import_assistant *ia)
467 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
470 if (parse_field (ia, row, column, NULL, &text))
473 gtk_tooltip_set_text (tooltip, text);
478 /* Utility functions used by multiple pages of the assistant. */
481 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
482 const struct import_assistant *ia,
483 size_t *row, size_t *column)
485 GtkTreeView *tree_view = GTK_TREE_VIEW (widget);
489 GtkTreeViewColumn *tree_column;
490 GtkTreeModel *tree_model;
493 /* Check that WIDGET is really visible on the screen before we
494 do anything else. This is a bug fix for a sticky situation:
495 when text_data_import_assistant() returns, it frees the data
496 necessary to compose the tool tip message, but there may be
497 a tool tip under preparation at that point (even if there is
498 no visible tool tip) that will call back into us a little
499 bit later. Perhaps the correct solution to this problem is
500 to make the data related to the tool tips part of a GObject
501 that only gets destroyed when all references are released,
502 but this solution appears to be effective too. */
503 if (!gtk_widget_get_mapped (widget))
506 gtk_tree_view_convert_widget_to_bin_window_coords (tree_view,
508 if (!gtk_tree_view_get_path_at_pos (tree_view, bx, by,
509 &path, &tree_column, NULL, NULL))
512 *column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
515 tree_model = gtk_tree_view_get_model (tree_view);
516 ok = gtk_tree_model_get_iter (tree_model, &iter, path);
517 gtk_tree_path_free (path);
521 *row = empty_list_store_iter_to_row (&iter) + ia->skip_lines;
526 make_tree_view (const struct import_assistant *ia,
528 GtkTreeView **tree_view)
532 *tree_view = GTK_TREE_VIEW (gtk_tree_view_new ());
533 model = GTK_TREE_MODEL (psppire_empty_list_store_new (
534 ia->file.line_cnt - first_line));
535 g_object_set_data (G_OBJECT (model), "lines", ia->file.lines + first_line);
536 g_object_set_data (G_OBJECT (model), "first-line",
537 GINT_TO_POINTER (first_line));
538 gtk_tree_view_set_model (*tree_view, model);
539 g_object_unref (model);
541 add_line_number_column (ia, *tree_view);
545 render_line_number (GtkTreeViewColumn *tree_column,
546 GtkCellRenderer *cell,
547 GtkTreeModel *tree_model,
551 gint row = empty_list_store_iter_to_row (iter);
552 char s[INT_BUFSIZE_BOUND (int)];
555 first_line = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_model),
557 sprintf (s, "%d", first_line + row);
558 g_object_set (cell, "text", s, NULL);
562 add_line_number_column (const struct import_assistant *ia,
563 GtkTreeView *treeview)
565 GtkTreeViewColumn *column;
567 column = gtk_tree_view_column_new_with_attributes (
568 _("Line"), ia->asst.prop_renderer, (void *) NULL);
569 gtk_tree_view_column_set_sizing (column, GTK_TREE_VIEW_COLUMN_FIXED);
570 gtk_tree_view_column_set_fixed_width (
571 column, get_monospace_width (treeview, ia->asst.prop_renderer, 5));
572 gtk_tree_view_column_set_resizable (column, TRUE);
573 gtk_tree_view_column_set_cell_data_func (column, ia->asst.prop_renderer,
574 render_line_number, NULL, NULL);
575 gtk_tree_view_append_column (treeview, column);
579 get_monospace_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
586 ds_put_byte_multiple (&s, '0', char_cnt);
587 ds_put_byte (&s, ' ');
588 width = get_string_width (treeview, renderer, ds_cstr (&s));
595 get_string_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
599 g_object_set (G_OBJECT (renderer), "text", string, (void *) NULL);
600 gtk_cell_renderer_get_size (renderer, GTK_WIDGET (treeview),
601 NULL, NULL, NULL, &width, NULL);
606 make_data_column (struct import_assistant *ia, GtkTreeView *tree_view,
607 bool input, gint dict_idx)
609 struct variable *var = NULL;
610 struct column *column = NULL;
612 gint content_width, header_width;
613 GtkTreeViewColumn *tree_column;
617 column = &ia->columns[dict_idx];
619 var = dict_get_var (ia->dict, dict_idx);
621 name = escape_underscores (input ? column->name : var_get_name (var));
622 char_cnt = input ? column->width : var_get_print_format (var)->w;
623 content_width = get_monospace_width (tree_view, ia->asst.fixed_renderer,
625 header_width = get_string_width (tree_view, ia->asst.prop_renderer,
628 tree_column = gtk_tree_view_column_new ();
629 g_object_set_data (G_OBJECT (tree_column), "column-number",
630 GINT_TO_POINTER (dict_idx));
631 gtk_tree_view_column_set_title (tree_column, name);
632 gtk_tree_view_column_pack_start (tree_column, ia->asst.fixed_renderer,
634 gtk_tree_view_column_set_cell_data_func (
635 tree_column, ia->asst.fixed_renderer,
636 input ? render_input_cell : render_output_cell, ia, NULL);
637 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_FIXED);
638 gtk_tree_view_column_set_fixed_width (tree_column, MAX (content_width,
647 create_data_tree_view (bool input, GtkContainer *parent,
648 struct import_assistant *ia)
650 GtkTreeView *tree_view;
653 make_tree_view (ia, ia->skip_lines, &tree_view);
654 gtk_tree_selection_set_mode (gtk_tree_view_get_selection (tree_view),
657 for (i = 0; i < ia->column_cnt; i++)
658 gtk_tree_view_append_column (tree_view,
659 make_data_column (ia, tree_view, input, i));
661 g_object_set (G_OBJECT (tree_view), "has-tooltip", TRUE, (void *) NULL);
662 g_signal_connect (tree_view, "query-tooltip",
663 G_CALLBACK (input ? on_query_input_tooltip
664 : on_query_output_tooltip), ia);
665 gtk_tree_view_set_fixed_height_mode (tree_view, true);
667 gtk_container_add (parent, GTK_WIDGET (tree_view));
668 gtk_widget_show (GTK_WIDGET (tree_view));
673 /* Increments the "watch cursor" level, setting the cursor for
674 the assistant window to a watch face to indicate to the user
675 that the ongoing operation may take some time. */
677 push_watch_cursor (struct import_assistant *ia)
679 if (++ia->asst.watch_cursor == 1)
681 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
682 GdkDisplay *display = gtk_widget_get_display (widget);
683 GdkCursor *cursor = gdk_cursor_new_for_display (display, GDK_WATCH);
684 gdk_window_set_cursor (widget->window, cursor);
685 gdk_cursor_unref (cursor);
686 gdk_display_flush (display);
690 /* Decrements the "watch cursor" level. If the level reaches
691 zero, the cursor is reset to its default shape. */
693 pop_watch_cursor (struct import_assistant *ia)
695 if (--ia->asst.watch_cursor == 0)
697 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
698 gdk_window_set_cursor (widget->window, NULL);