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-first-line.h"
23 #include "page-separators.h"
24 #include "page-formats.h"
33 #include "data/data-in.h"
34 #include "data/data-out.h"
35 #include "data/format-guesser.h"
36 #include "data/value-labels.h"
37 #include "language/data-io/data-parser.h"
38 #include "language/lexer/lexer.h"
39 #include "libpspp/assertion.h"
40 #include "libpspp/i18n.h"
41 #include "libpspp/line-reader.h"
42 #include "libpspp/message.h"
43 #include "ui/gui/checkbox-treeview.h"
44 #include "ui/gui/dialog-common.h"
45 #include "ui/gui/executor.h"
46 #include "ui/gui/helper.h"
47 #include "ui/gui/builder-wrapper.h"
48 #include "ui/gui/pspp-sheet-selection.h"
49 #include "ui/gui/pspp-sheet-view.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-scanf.h"
56 #include "ui/syntax-gen.h"
59 #include "gl/intprops.h"
60 #include "gl/xalloc.h"
63 #define _(msgid) gettext (msgid)
64 #define N_(msgid) msgid
66 struct import_assistant;
68 static void apply_dict (const struct dictionary *, struct string *);
69 static char *generate_syntax (const struct import_assistant *);
71 static void add_line_number_column (const struct import_assistant *,
74 /* Pops up the Text Data Import assistant. */
76 text_data_import_assistant (PsppireDataWindow *dw)
78 GtkWindow *parent_window = GTK_WINDOW (dw);
79 struct import_assistant *ia = init_assistant (parent_window);
81 if (!init_file (ia, parent_window))
89 ia->intro = intro_page_create (ia);
90 ia->first_line = first_line_page_create (ia);
91 ia->separators = separators_page_create (ia);
93 ia->formats = formats_page_create (ia);
95 gtk_widget_show_all (GTK_WIDGET (ia->asst.assistant));
97 ia->asst.main_loop = g_main_loop_new (NULL, false);
101 Instead of this block,
102 A simple g_main_loop_run (ia->asst.main_loop); should work here. But it seems to crash.
105 GMainContext *ctx = g_main_loop_get_context (ia->asst.main_loop);
106 ia->asst.loop_done = false;
107 while (! ia->asst.loop_done)
109 g_main_context_iteration (ctx, TRUE);
112 g_main_loop_unref (ia->asst.main_loop);
114 switch (ia->asst.response)
116 case GTK_RESPONSE_APPLY:
117 free (execute_syntax_string (dw, generate_syntax (ia)));
119 case PSPPIRE_RESPONSE_PASTE:
120 free (paste_syntax_to_window (generate_syntax (ia)));
127 destroy_formats_page (ia);
128 destroy_separators_page (ia);
131 destroy_assistant (ia);
136 /* Emits PSPP syntax to S that applies the dictionary attributes
137 (such as missing values and value labels) of the variables in
140 apply_dict (const struct dictionary *dict, struct string *s)
142 size_t var_cnt = dict_get_var_cnt (dict);
145 for (i = 0; i < var_cnt; i++)
147 struct variable *var = dict_get_var (dict, i);
148 const char *name = var_get_name (var);
149 enum val_type type = var_get_type (var);
150 int width = var_get_width (var);
151 enum measure measure = var_get_measure (var);
152 enum alignment alignment = var_get_alignment (var);
153 const struct fmt_spec *format = var_get_print_format (var);
155 if (var_has_missing_values (var))
157 const struct missing_values *mv = var_get_missing_values (var);
160 syntax_gen_pspp (s, "MISSING VALUES %ss (", name);
161 for (j = 0; j < mv_n_values (mv); j++)
164 ds_put_cstr (s, ", ");
165 syntax_gen_value (s, mv_get_value (mv, j), width, format);
168 if (mv_has_range (mv))
171 if (mv_has_value (mv))
172 ds_put_cstr (s, ", ");
173 mv_get_range (mv, &low, &high);
174 syntax_gen_num_range (s, low, high, format);
176 ds_put_cstr (s, ").\n");
178 if (var_has_value_labels (var))
180 const struct val_labs *vls = var_get_value_labels (var);
181 const struct val_lab **labels = val_labs_sorted (vls);
182 size_t n_labels = val_labs_count (vls);
185 syntax_gen_pspp (s, "VALUE LABELS %ss", name);
186 for (i = 0; i < n_labels; i++)
188 const struct val_lab *vl = labels[i];
189 ds_put_cstr (s, "\n ");
190 syntax_gen_value (s, &vl->value, width, format);
191 ds_put_byte (s, ' ');
192 syntax_gen_string (s, ss_cstr (val_lab_get_escaped_label (vl)));
195 ds_put_cstr (s, ".\n");
197 if (var_has_label (var))
198 syntax_gen_pspp (s, "VARIABLE LABELS %ss %sq.\n",
199 name, var_get_label (var));
200 if (measure != var_default_measure (type))
201 syntax_gen_pspp (s, "VARIABLE LEVEL %ss (%ss).\n",
203 (measure == MEASURE_NOMINAL ? "NOMINAL"
204 : measure == MEASURE_ORDINAL ? "ORDINAL"
206 if (alignment != var_default_alignment (type))
207 syntax_gen_pspp (s, "VARIABLE ALIGNMENT %ss (%ss).\n",
209 (alignment == ALIGN_LEFT ? "LEFT"
210 : alignment == ALIGN_CENTRE ? "CENTER"
212 if (var_get_display_width (var) != var_default_display_width (width))
213 syntax_gen_pspp (s, "VARIABLE WIDTH %ss (%d).\n",
214 name, var_get_display_width (var));
218 /* Generates and returns PSPP syntax to execute the import
219 operation described by IA. The caller must free the syntax
222 generate_syntax (const struct import_assistant *ia)
224 struct string s = DS_EMPTY_INITIALIZER;
232 if (ia->file.encoding && strcmp (ia->file.encoding, "Auto"))
233 syntax_gen_pspp (&s, " /ENCODING=%sq\n", ia->file.encoding);
236 intro_append_syntax (ia->intro, &s);
240 " /ARRANGEMENT=DELIMITED\n"
243 first_line_append_syntax (ia, &s);
244 separators_append_syntax (ia, &s);
245 formats_append_syntax (ia, &s);
246 apply_dict (ia->dict, &s);
254 static void render_input_cell (PsppSheetViewColumn *tree_column,
255 GtkCellRenderer *cell,
256 GtkTreeModel *model, GtkTreeIter *iter,
259 static gboolean on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
260 gboolean keyboard_mode UNUSED,
262 struct import_assistant *);
266 /* Called to render one of the cells in the fields preview tree
269 render_input_cell (PsppSheetViewColumn *tree_column, GtkCellRenderer *cell,
270 GtkTreeModel *model, GtkTreeIter *iter,
273 struct import_assistant *ia = ia_;
274 struct substring field;
278 column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
280 row = empty_list_store_iter_to_row (iter) + ia->skip_lines;
281 field = ia->columns[column].contents[row];
282 if (field.string != NULL)
285 g_value_init (&text, G_TYPE_STRING);
286 g_value_take_string (&text, ss_xstrdup (field));
287 g_object_set_property (G_OBJECT (cell), "text", &text);
288 g_value_unset (&text);
289 g_object_set (cell, "background-set", FALSE, (void *) NULL);
295 "background-set", TRUE,
300 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
301 const struct import_assistant *ia,
302 size_t *row, size_t *column);
305 /* Called to render a tooltip on one of the cells in the fields
306 preview tree view. */
308 on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
309 gboolean keyboard_mode UNUSED,
310 GtkTooltip *tooltip, struct import_assistant *ia)
314 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
317 if (ia->columns[column].contents[row].string != NULL)
320 gtk_tooltip_set_text (tooltip,
321 _("This input line has too few separators "
322 "to fill in this field."));
327 /* Parses the contents of the field at (ROW,COLUMN) according to
328 its variable format. If OUTPUTP is non-null, then *OUTPUTP
329 receives the formatted output for that field (which must be
330 freed with free). If TOOLTIPP is non-null, then *TOOLTIPP
331 receives a message suitable for use in a tooltip, if one is
332 needed, or a null pointer otherwise. Returns true if a
333 tooltip message is needed, otherwise false. */
335 parse_field (struct import_assistant *ia,
336 size_t row, size_t column,
337 char **outputp, char **tooltipp)
339 const struct fmt_spec *in;
344 struct substring field = ia->columns[column].contents[row];
345 struct variable *var = dict_get_var (ia->dict, column);
348 value_init (&val, var_get_width (var));
349 in = var_get_print_format (var);
350 out = fmt_for_output_from_input (in);
352 if (field.string != NULL)
356 error = data_in (field, "UTF-8", in->type, &val, var_get_width (var),
357 dict_get_encoding (ia->dict));
360 tooltip = xasprintf (_("Cannot parse field content `%.*s' as "
362 (int) field.length, field.string,
363 fmt_name (in->type), error);
369 tooltip = xstrdup (_("This input line has too few separators "
370 "to fill in this field."));
371 value_set_missing (&val, var_get_width (var));
375 *outputp = data_out (&val, dict_get_encoding (ia->dict), &out);
377 value_destroy (&val, var_get_width (var));
379 ok = tooltip == NULL;
380 if (tooltipp != NULL)
387 /* Called to render one of the cells in the data preview tree
390 render_output_cell (PsppSheetViewColumn *tree_column,
391 GtkCellRenderer *cell,
396 struct import_assistant *ia = ia_;
398 GValue gvalue = { 0, };
401 ok = parse_field (ia,
402 (empty_list_store_iter_to_row (iter)
404 GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
408 g_value_init (&gvalue, G_TYPE_STRING);
409 g_value_take_string (&gvalue, output);
410 g_object_set_property (G_OBJECT (cell), "text", &gvalue);
411 g_value_unset (&gvalue);
414 g_object_set (cell, "background-set", FALSE, (void *) NULL);
418 "background-set", TRUE,
422 /* Called to render a tooltip for one of the cells in the data
423 preview tree view. */
425 on_query_output_tooltip (GtkWidget *widget, gint wx, gint wy,
426 gboolean keyboard_mode UNUSED,
427 GtkTooltip *tooltip, struct import_assistant *ia)
432 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
435 if (parse_field (ia, row, column, NULL, &text))
438 gtk_tooltip_set_text (tooltip, text);
443 /* Utility functions used by multiple pages of the assistant. */
446 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
447 const struct import_assistant *ia,
448 size_t *row, size_t *column)
450 PsppSheetView *tree_view = PSPP_SHEET_VIEW (widget);
454 PsppSheetViewColumn *tree_column;
455 GtkTreeModel *tree_model;
458 /* Check that WIDGET is really visible on the screen before we
459 do anything else. This is a bug fix for a sticky situation:
460 when text_data_import_assistant() returns, it frees the data
461 necessary to compose the tool tip message, but there may be
462 a tool tip under preparation at that point (even if there is
463 no visible tool tip) that will call back into us a little
464 bit later. Perhaps the correct solution to this problem is
465 to make the data related to the tool tips part of a GObject
466 that only gets destroyed when all references are released,
467 but this solution appears to be effective too. */
468 if (!gtk_widget_get_mapped (widget))
471 pspp_sheet_view_convert_widget_to_bin_window_coords (tree_view,
473 if (!pspp_sheet_view_get_path_at_pos (tree_view, bx, by,
474 &path, &tree_column, NULL, NULL))
477 *column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
480 tree_model = pspp_sheet_view_get_model (tree_view);
481 ok = gtk_tree_model_get_iter (tree_model, &iter, path);
482 gtk_tree_path_free (path);
486 *row = empty_list_store_iter_to_row (&iter) + ia->skip_lines;
491 make_tree_view (const struct import_assistant *ia,
493 PsppSheetView **tree_view)
497 *tree_view = PSPP_SHEET_VIEW (pspp_sheet_view_new ());
498 pspp_sheet_view_set_grid_lines (*tree_view, PSPP_SHEET_VIEW_GRID_LINES_BOTH);
499 model = GTK_TREE_MODEL (psppire_empty_list_store_new (
500 ia->file.line_cnt - first_line));
501 g_object_set_data (G_OBJECT (model), "lines", ia->file.lines + first_line);
502 g_object_set_data (G_OBJECT (model), "first-line",
503 GINT_TO_POINTER (first_line));
504 pspp_sheet_view_set_model (*tree_view, model);
505 g_object_unref (model);
507 add_line_number_column (ia, *tree_view);
511 render_line_number (PsppSheetViewColumn *tree_column,
512 GtkCellRenderer *cell,
513 GtkTreeModel *tree_model,
517 gint row = empty_list_store_iter_to_row (iter);
518 char s[INT_BUFSIZE_BOUND (int)];
521 first_line = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_model),
523 sprintf (s, "%d", first_line + row);
524 g_object_set (cell, "text", s, NULL);
528 add_line_number_column (const struct import_assistant *ia,
529 PsppSheetView *treeview)
531 PsppSheetViewColumn *column;
533 column = pspp_sheet_view_column_new_with_attributes (
534 _("Line"), ia->asst.prop_renderer, (void *) NULL);
535 pspp_sheet_view_column_set_fixed_width (
536 column, get_monospace_width (treeview, ia->asst.prop_renderer, 5));
537 pspp_sheet_view_column_set_resizable (column, TRUE);
538 pspp_sheet_view_column_set_cell_data_func (column, ia->asst.prop_renderer,
539 render_line_number, NULL, NULL);
540 pspp_sheet_view_append_column (treeview, column);
544 get_monospace_width (PsppSheetView *treeview, GtkCellRenderer *renderer,
551 ds_put_byte_multiple (&s, '0', char_cnt);
552 ds_put_byte (&s, ' ');
553 width = get_string_width (treeview, renderer, ds_cstr (&s));
560 get_string_width (PsppSheetView *treeview, GtkCellRenderer *renderer,
564 g_object_set (G_OBJECT (renderer), "text", string, (void *) NULL);
565 gtk_cell_renderer_get_size (renderer, GTK_WIDGET (treeview),
566 NULL, NULL, NULL, &width, NULL);
570 PsppSheetViewColumn *
571 make_data_column (struct import_assistant *ia, PsppSheetView *tree_view,
572 bool input, gint dict_idx)
574 struct variable *var = NULL;
575 struct column *column = NULL;
577 gint content_width, header_width;
578 PsppSheetViewColumn *tree_column;
582 column = &ia->columns[dict_idx];
584 var = dict_get_var (ia->dict, dict_idx);
586 name = escape_underscores (input ? column->name : var_get_name (var));
587 char_cnt = input ? column->width : var_get_print_format (var)->w;
588 content_width = get_monospace_width (tree_view, ia->asst.fixed_renderer,
590 header_width = get_string_width (tree_view, ia->asst.prop_renderer,
593 tree_column = pspp_sheet_view_column_new ();
594 g_object_set_data (G_OBJECT (tree_column), "column-number",
595 GINT_TO_POINTER (dict_idx));
596 pspp_sheet_view_column_set_title (tree_column, name);
597 pspp_sheet_view_column_pack_start (tree_column, ia->asst.fixed_renderer,
599 pspp_sheet_view_column_set_cell_data_func (
600 tree_column, ia->asst.fixed_renderer,
601 input ? render_input_cell : render_output_cell, ia, NULL);
602 pspp_sheet_view_column_set_fixed_width (tree_column, MAX (content_width,
611 create_data_tree_view (bool input, GtkContainer *parent,
612 struct import_assistant *ia)
614 PsppSheetView *tree_view;
617 make_tree_view (ia, ia->skip_lines, &tree_view);
618 pspp_sheet_selection_set_mode (pspp_sheet_view_get_selection (tree_view),
619 PSPP_SHEET_SELECTION_NONE);
621 for (i = 0; i < ia->column_cnt; i++)
622 pspp_sheet_view_append_column (tree_view,
623 make_data_column (ia, tree_view, input, i));
625 g_object_set (G_OBJECT (tree_view), "has-tooltip", TRUE, (void *) NULL);
626 g_signal_connect (tree_view, "query-tooltip",
627 G_CALLBACK (input ? on_query_input_tooltip
628 : on_query_output_tooltip), ia);
631 gtk_container_add (parent, GTK_WIDGET (tree_view));
632 gtk_widget_show (GTK_WIDGET (tree_view));
637 /* Increments the "watch cursor" level, setting the cursor for
638 the assistant window to a watch face to indicate to the user
639 that the ongoing operation may take some time. */
641 push_watch_cursor (struct import_assistant *ia)
643 if (++ia->asst.watch_cursor == 1)
645 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
646 GdkDisplay *display = gtk_widget_get_display (widget);
647 GdkCursor *cursor = gdk_cursor_new_for_display (display, GDK_WATCH);
648 gdk_window_set_cursor (widget->window, cursor);
649 gdk_cursor_unref (cursor);
650 gdk_display_flush (display);
654 /* Decrements the "watch cursor" level. If the level reaches
655 zero, the cursor is reset to its default shape. */
657 pop_watch_cursor (struct import_assistant *ia)
659 if (--ia->asst.watch_cursor == 0)
661 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
662 gdk_window_set_cursor (widget->window, NULL);