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);
239 " /ARRANGEMENT=DELIMITED\n"
242 first_line_append_syntax (ia, &s);
243 separators_append_syntax (ia, &s);
244 formats_append_syntax (ia, &s);
245 apply_dict (ia->dict, &s);
249 return sheet_spec_gen_syntax (ia);
257 static void render_input_cell (GtkTreeViewColumn *tree_column,
258 GtkCellRenderer *cell,
259 GtkTreeModel *model, GtkTreeIter *iter,
262 static gboolean on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
263 gboolean keyboard_mode UNUSED,
265 struct import_assistant *);
269 /* Called to render one of the cells in the fields preview tree
272 render_input_cell (GtkTreeViewColumn *tree_column, GtkCellRenderer *cell,
273 GtkTreeModel *model, GtkTreeIter *iter,
276 struct import_assistant *ia = ia_;
277 struct substring field;
281 column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
283 row = empty_list_store_iter_to_row (iter) + ia->skip_lines;
284 field = ia->columns[column].contents[row];
285 if (field.string != NULL)
288 g_value_init (&text, G_TYPE_STRING);
289 g_value_take_string (&text, ss_xstrdup (field));
290 g_object_set_property (G_OBJECT (cell), "text", &text);
291 g_value_unset (&text);
292 g_object_set (cell, "background-set", FALSE, (void *) NULL);
298 "background-set", TRUE,
303 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
304 const struct import_assistant *ia,
305 size_t *row, size_t *column);
308 /* Called to render a tooltip on one of the cells in the fields
309 preview tree view. */
311 on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
312 gboolean keyboard_mode UNUSED,
313 GtkTooltip *tooltip, struct import_assistant *ia)
317 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
320 if (ia->columns[column].contents[row].string != NULL)
323 gtk_tooltip_set_text (tooltip,
324 _("This input line has too few separators "
325 "to fill in this field."));
330 /* Parses the contents of the field at (ROW,COLUMN) according to
331 its variable format. If OUTPUTP is non-null, then *OUTPUTP
332 receives the formatted output for that field (which must be
333 freed with free). If TOOLTIPP is non-null, then *TOOLTIPP
334 receives a message suitable for use in a tooltip, if one is
335 needed, or a null pointer otherwise. Returns true if a
336 tooltip message is needed, otherwise false. */
338 parse_field (struct import_assistant *ia,
339 size_t row, size_t column,
340 char **outputp, char **tooltipp)
342 const struct fmt_spec *in;
347 struct substring field = ia->columns[column].contents[row];
348 struct variable *var = dict_get_var (ia->dict, column);
351 value_init (&val, var_get_width (var));
352 in = var_get_print_format (var);
353 out = fmt_for_output_from_input (in);
355 if (field.string != NULL)
359 error = data_in (field, "UTF-8", in->type, &val, var_get_width (var),
360 dict_get_encoding (ia->dict));
363 tooltip = xasprintf (_("Cannot parse field content `%.*s' as "
365 (int) field.length, field.string,
366 fmt_name (in->type), error);
372 tooltip = xstrdup (_("This input line has too few separators "
373 "to fill in this field."));
374 value_set_missing (&val, var_get_width (var));
378 *outputp = data_out (&val, dict_get_encoding (ia->dict), &out);
380 value_destroy (&val, var_get_width (var));
382 ok = tooltip == NULL;
383 if (tooltipp != NULL)
390 /* Called to render one of the cells in the data preview tree
393 render_output_cell (GtkTreeViewColumn *tree_column,
394 GtkCellRenderer *cell,
399 struct import_assistant *ia = ia_;
401 GValue gvalue = { 0, };
404 ok = parse_field (ia,
405 (empty_list_store_iter_to_row (iter)
407 GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
411 g_value_init (&gvalue, G_TYPE_STRING);
412 g_value_take_string (&gvalue, output);
413 g_object_set_property (G_OBJECT (cell), "text", &gvalue);
414 g_value_unset (&gvalue);
417 g_object_set (cell, "background-set", FALSE, (void *) NULL);
421 "background-set", TRUE,
425 /* Called to render a tooltip for one of the cells in the data
426 preview tree view. */
428 on_query_output_tooltip (GtkWidget *widget, gint wx, gint wy,
429 gboolean keyboard_mode UNUSED,
430 GtkTooltip *tooltip, struct import_assistant *ia)
435 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
438 if (parse_field (ia, row, column, NULL, &text))
441 gtk_tooltip_set_text (tooltip, text);
446 /* Utility functions used by multiple pages of the assistant. */
449 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
450 const struct import_assistant *ia,
451 size_t *row, size_t *column)
453 GtkTreeView *tree_view = GTK_TREE_VIEW (widget);
457 GtkTreeViewColumn *tree_column;
458 GtkTreeModel *tree_model;
461 /* Check that WIDGET is really visible on the screen before we
462 do anything else. This is a bug fix for a sticky situation:
463 when text_data_import_assistant() returns, it frees the data
464 necessary to compose the tool tip message, but there may be
465 a tool tip under preparation at that point (even if there is
466 no visible tool tip) that will call back into us a little
467 bit later. Perhaps the correct solution to this problem is
468 to make the data related to the tool tips part of a GObject
469 that only gets destroyed when all references are released,
470 but this solution appears to be effective too. */
471 if (!gtk_widget_get_mapped (widget))
474 gtk_tree_view_convert_widget_to_bin_window_coords (tree_view,
476 if (!gtk_tree_view_get_path_at_pos (tree_view, bx, by,
477 &path, &tree_column, NULL, NULL))
480 *column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
483 tree_model = gtk_tree_view_get_model (tree_view);
484 ok = gtk_tree_model_get_iter (tree_model, &iter, path);
485 gtk_tree_path_free (path);
489 *row = empty_list_store_iter_to_row (&iter) + ia->skip_lines;
494 make_tree_view (const struct import_assistant *ia,
496 GtkTreeView **tree_view)
500 *tree_view = GTK_TREE_VIEW (gtk_tree_view_new ());
501 model = GTK_TREE_MODEL (psppire_empty_list_store_new (
502 ia->file.line_cnt - first_line));
503 g_object_set_data (G_OBJECT (model), "lines", ia->file.lines + first_line);
504 g_object_set_data (G_OBJECT (model), "first-line",
505 GINT_TO_POINTER (first_line));
506 gtk_tree_view_set_model (*tree_view, model);
507 g_object_unref (model);
509 add_line_number_column (ia, *tree_view);
513 render_line_number (GtkTreeViewColumn *tree_column,
514 GtkCellRenderer *cell,
515 GtkTreeModel *tree_model,
519 gint row = empty_list_store_iter_to_row (iter);
520 char s[INT_BUFSIZE_BOUND (int)];
523 first_line = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_model),
525 sprintf (s, "%d", first_line + row);
526 g_object_set (cell, "text", s, NULL);
530 add_line_number_column (const struct import_assistant *ia,
531 GtkTreeView *treeview)
533 GtkTreeViewColumn *column;
535 column = gtk_tree_view_column_new_with_attributes (
536 _("Line"), ia->asst.prop_renderer, (void *) NULL);
537 gtk_tree_view_column_set_sizing (column, GTK_TREE_VIEW_COLUMN_FIXED);
538 gtk_tree_view_column_set_fixed_width (
539 column, get_monospace_width (treeview, ia->asst.prop_renderer, 5));
540 gtk_tree_view_column_set_resizable (column, TRUE);
541 gtk_tree_view_column_set_cell_data_func (column, ia->asst.prop_renderer,
542 render_line_number, NULL, NULL);
543 gtk_tree_view_append_column (treeview, column);
547 get_monospace_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
554 ds_put_byte_multiple (&s, '0', char_cnt);
555 ds_put_byte (&s, ' ');
556 width = get_string_width (treeview, renderer, ds_cstr (&s));
563 get_string_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
567 g_object_set (G_OBJECT (renderer), "text", string, (void *) NULL);
568 gtk_cell_renderer_get_size (renderer, GTK_WIDGET (treeview),
569 NULL, NULL, NULL, &width, NULL);
574 make_data_column (struct import_assistant *ia, GtkTreeView *tree_view,
575 bool input, gint dict_idx)
577 struct variable *var = NULL;
578 struct column *column = NULL;
580 gint content_width, header_width;
581 GtkTreeViewColumn *tree_column;
585 column = &ia->columns[dict_idx];
587 var = dict_get_var (ia->dict, dict_idx);
589 name = escape_underscores (input ? column->name : var_get_name (var));
590 char_cnt = input ? column->width : var_get_print_format (var)->w;
591 content_width = get_monospace_width (tree_view, ia->asst.fixed_renderer,
593 header_width = get_string_width (tree_view, ia->asst.prop_renderer,
596 tree_column = gtk_tree_view_column_new ();
597 g_object_set_data (G_OBJECT (tree_column), "column-number",
598 GINT_TO_POINTER (dict_idx));
599 gtk_tree_view_column_set_title (tree_column, name);
600 gtk_tree_view_column_pack_start (tree_column, ia->asst.fixed_renderer,
602 gtk_tree_view_column_set_cell_data_func (
603 tree_column, ia->asst.fixed_renderer,
604 input ? render_input_cell : render_output_cell, ia, NULL);
605 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_FIXED);
606 gtk_tree_view_column_set_fixed_width (tree_column, MAX (content_width,
615 create_data_tree_view (bool input, GtkContainer *parent,
616 struct import_assistant *ia)
618 GtkTreeView *tree_view;
621 make_tree_view (ia, ia->skip_lines, &tree_view);
622 gtk_tree_selection_set_mode (gtk_tree_view_get_selection (tree_view),
625 for (i = 0; i < ia->column_cnt; i++)
626 gtk_tree_view_append_column (tree_view,
627 make_data_column (ia, tree_view, input, i));
629 g_object_set (G_OBJECT (tree_view), "has-tooltip", TRUE, (void *) NULL);
630 g_signal_connect (tree_view, "query-tooltip",
631 G_CALLBACK (input ? on_query_input_tooltip
632 : on_query_output_tooltip), ia);
633 gtk_tree_view_set_fixed_height_mode (tree_view, true);
635 gtk_container_add (parent, GTK_WIDGET (tree_view));
636 gtk_widget_show (GTK_WIDGET (tree_view));
641 /* Increments the "watch cursor" level, setting the cursor for
642 the assistant window to a watch face to indicate to the user
643 that the ongoing operation may take some time. */
645 push_watch_cursor (struct import_assistant *ia)
647 if (++ia->asst.watch_cursor == 1)
649 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
650 GdkDisplay *display = gtk_widget_get_display (widget);
651 GdkCursor *cursor = gdk_cursor_new_for_display (display, GDK_WATCH);
652 gdk_window_set_cursor (widget->window, cursor);
653 gdk_cursor_unref (cursor);
654 gdk_display_flush (display);
658 /* Decrements the "watch cursor" level. If the level reaches
659 zero, the cursor is reset to its default shape. */
661 pop_watch_cursor (struct import_assistant *ia)
663 if (--ia->asst.watch_cursor == 0)
665 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
666 gdk_window_set_cursor (widget->window, NULL);