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"
34 #include "data/data-in.h"
35 #include "data/data-out.h"
36 #include "data/format-guesser.h"
37 #include "data/value-labels.h"
38 #include "language/data-io/data-parser.h"
39 #include "language/lexer/lexer.h"
40 #include "libpspp/assertion.h"
41 #include "libpspp/i18n.h"
42 #include "libpspp/line-reader.h"
43 #include "libpspp/message.h"
44 #include "ui/gui/checkbox-treeview.h"
45 #include "ui/gui/dialog-common.h"
46 #include "ui/gui/executor.h"
47 #include "ui/gui/helper.h"
48 #include "ui/gui/builder-wrapper.h"
49 #include "ui/gui/pspp-sheet-selection.h"
50 #include "ui/gui/pspp-sheet-view.h"
51 #include "ui/gui/psppire-data-window.h"
52 #include "ui/gui/psppire-dialog.h"
53 #include "ui/gui/psppire-encoding-selector.h"
54 #include "ui/gui/psppire-empty-list-store.h"
55 #include "ui/gui/psppire-var-sheet.h"
56 #include "ui/gui/psppire-scanf.h"
57 #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);
80 struct sheet_spec_page *ssp ;
82 if (!init_file (ia, parent_window))
92 ia->sheet_spec = sheet_spec_page_create (ia);
96 ia->intro = intro_page_create (ia);
97 ia->first_line = first_line_page_create (ia);
98 ia->separators = separators_page_create (ia);
100 ia->formats = formats_page_create (ia);
102 gtk_widget_show_all (GTK_WIDGET (ia->asst.assistant));
104 ia->asst.main_loop = g_main_loop_new (NULL, false);
108 Instead of this block,
109 A simple g_main_loop_run (ia->asst.main_loop); should work here. But it seems to crash.
112 GMainContext *ctx = g_main_loop_get_context (ia->asst.main_loop);
113 ia->asst.loop_done = false;
114 while (! ia->asst.loop_done)
116 g_main_context_iteration (ctx, TRUE);
119 g_main_loop_unref (ia->asst.main_loop);
121 switch (ia->asst.response)
123 case GTK_RESPONSE_APPLY:
125 gchar *fn = g_path_get_basename (ia->file.file_name);
126 open_data_window (PSPPIRE_WINDOW (dw), fn, generate_syntax (ia));
130 case PSPPIRE_RESPONSE_PASTE:
131 free (paste_syntax_to_window (generate_syntax (ia)));
139 destroy_formats_page (ia);
140 destroy_separators_page (ia);
143 destroy_assistant (ia);
148 /* Emits PSPP syntax to S that applies the dictionary attributes
149 (such as missing values and value labels) of the variables in
152 apply_dict (const struct dictionary *dict, struct string *s)
154 size_t var_cnt = dict_get_var_cnt (dict);
157 for (i = 0; i < var_cnt; i++)
159 struct variable *var = dict_get_var (dict, i);
160 const char *name = var_get_name (var);
161 enum val_type type = var_get_type (var);
162 int width = var_get_width (var);
163 enum measure measure = var_get_measure (var);
164 enum var_role role = var_get_role (var);
165 enum alignment alignment = var_get_alignment (var);
166 const struct fmt_spec *format = var_get_print_format (var);
168 if (var_has_missing_values (var))
170 const struct missing_values *mv = var_get_missing_values (var);
173 syntax_gen_pspp (s, "MISSING VALUES %ss (", name);
174 for (j = 0; j < mv_n_values (mv); j++)
177 ds_put_cstr (s, ", ");
178 syntax_gen_value (s, mv_get_value (mv, j), width, format);
181 if (mv_has_range (mv))
184 if (mv_has_value (mv))
185 ds_put_cstr (s, ", ");
186 mv_get_range (mv, &low, &high);
187 syntax_gen_num_range (s, low, high, format);
189 ds_put_cstr (s, ").\n");
191 if (var_has_value_labels (var))
193 const struct val_labs *vls = var_get_value_labels (var);
194 const struct val_lab **labels = val_labs_sorted (vls);
195 size_t n_labels = val_labs_count (vls);
198 syntax_gen_pspp (s, "VALUE LABELS %ss", name);
199 for (i = 0; i < n_labels; i++)
201 const struct val_lab *vl = labels[i];
202 ds_put_cstr (s, "\n ");
203 syntax_gen_value (s, &vl->value, width, format);
204 ds_put_byte (s, ' ');
205 syntax_gen_string (s, ss_cstr (val_lab_get_escaped_label (vl)));
208 ds_put_cstr (s, ".\n");
210 if (var_has_label (var))
211 syntax_gen_pspp (s, "VARIABLE LABELS %ss %sq.\n",
212 name, var_get_label (var));
213 if (measure != var_default_measure (type))
214 syntax_gen_pspp (s, "VARIABLE LEVEL %ss (%ss).\n",
215 name, measure_to_syntax (measure));
216 if (role != ROLE_INPUT)
217 syntax_gen_pspp (s, "VARIABLE ROLE /%ss %ss.\n",
218 var_role_to_syntax (role), name);
219 if (alignment != var_default_alignment (type))
220 syntax_gen_pspp (s, "VARIABLE ALIGNMENT %ss (%ss).\n",
221 name, alignment_to_syntax (alignment));
222 if (var_get_display_width (var) != var_default_display_width (width))
223 syntax_gen_pspp (s, "VARIABLE WIDTH %ss (%d).\n",
224 name, var_get_display_width (var));
228 /* Generates and returns PSPP syntax to execute the import
229 operation described by IA. The caller must free the syntax
232 generate_syntax (const struct import_assistant *ia)
234 struct string s = DS_EMPTY_INITIALIZER;
236 if (ia->spreadsheet == NULL)
243 if (ia->file.encoding && strcmp (ia->file.encoding, "Auto"))
244 syntax_gen_pspp (&s, " /ENCODING=%sq\n", ia->file.encoding);
246 intro_append_syntax (ia->intro, &s);
250 " /ARRANGEMENT=DELIMITED\n"
253 first_line_append_syntax (ia, &s);
254 separators_append_syntax (ia, &s);
255 formats_append_syntax (ia, &s);
256 apply_dict (ia->dict, &s);
260 return sheet_spec_gen_syntax (ia);
268 static void render_input_cell (PsppSheetViewColumn *tree_column,
269 GtkCellRenderer *cell,
270 GtkTreeModel *model, GtkTreeIter *iter,
273 static gboolean on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
274 gboolean keyboard_mode UNUSED,
276 struct import_assistant *);
280 /* Called to render one of the cells in the fields preview tree
283 render_input_cell (PsppSheetViewColumn *tree_column, GtkCellRenderer *cell,
284 GtkTreeModel *model, GtkTreeIter *iter,
287 struct import_assistant *ia = ia_;
288 struct substring field;
292 column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
294 row = empty_list_store_iter_to_row (iter) + ia->skip_lines;
295 field = ia->columns[column].contents[row];
296 if (field.string != NULL)
299 g_value_init (&text, G_TYPE_STRING);
300 g_value_take_string (&text, ss_xstrdup (field));
301 g_object_set_property (G_OBJECT (cell), "text", &text);
302 g_value_unset (&text);
303 g_object_set (cell, "background-set", FALSE, (void *) NULL);
309 "background-set", TRUE,
314 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
315 const struct import_assistant *ia,
316 size_t *row, size_t *column);
319 /* Called to render a tooltip on one of the cells in the fields
320 preview tree view. */
322 on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
323 gboolean keyboard_mode UNUSED,
324 GtkTooltip *tooltip, struct import_assistant *ia)
328 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
331 if (ia->columns[column].contents[row].string != NULL)
334 gtk_tooltip_set_text (tooltip,
335 _("This input line has too few separators "
336 "to fill in this field."));
341 /* Parses the contents of the field at (ROW,COLUMN) according to
342 its variable format. If OUTPUTP is non-null, then *OUTPUTP
343 receives the formatted output for that field (which must be
344 freed with free). If TOOLTIPP is non-null, then *TOOLTIPP
345 receives a message suitable for use in a tooltip, if one is
346 needed, or a null pointer otherwise. Returns true if a
347 tooltip message is needed, otherwise false. */
349 parse_field (struct import_assistant *ia,
350 size_t row, size_t column,
351 char **outputp, char **tooltipp)
353 const struct fmt_spec *in;
358 struct substring field = ia->columns[column].contents[row];
359 struct variable *var = dict_get_var (ia->dict, column);
362 value_init (&val, var_get_width (var));
363 in = var_get_print_format (var);
364 out = fmt_for_output_from_input (in);
366 if (field.string != NULL)
370 error = data_in (field, "UTF-8", in->type, &val, var_get_width (var),
371 dict_get_encoding (ia->dict));
374 tooltip = xasprintf (_("Cannot parse field content `%.*s' as "
376 (int) field.length, field.string,
377 fmt_name (in->type), error);
383 tooltip = xstrdup (_("This input line has too few separators "
384 "to fill in this field."));
385 value_set_missing (&val, var_get_width (var));
389 *outputp = data_out (&val, dict_get_encoding (ia->dict), &out);
391 value_destroy (&val, var_get_width (var));
393 ok = tooltip == NULL;
394 if (tooltipp != NULL)
401 /* Called to render one of the cells in the data preview tree
404 render_output_cell (PsppSheetViewColumn *tree_column,
405 GtkCellRenderer *cell,
410 struct import_assistant *ia = ia_;
412 GValue gvalue = { 0, };
415 ok = parse_field (ia,
416 (empty_list_store_iter_to_row (iter)
418 GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
422 g_value_init (&gvalue, G_TYPE_STRING);
423 g_value_take_string (&gvalue, output);
424 g_object_set_property (G_OBJECT (cell), "text", &gvalue);
425 g_value_unset (&gvalue);
428 g_object_set (cell, "background-set", FALSE, (void *) NULL);
432 "background-set", TRUE,
436 /* Called to render a tooltip for one of the cells in the data
437 preview tree view. */
439 on_query_output_tooltip (GtkWidget *widget, gint wx, gint wy,
440 gboolean keyboard_mode UNUSED,
441 GtkTooltip *tooltip, struct import_assistant *ia)
446 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
449 if (parse_field (ia, row, column, NULL, &text))
452 gtk_tooltip_set_text (tooltip, text);
457 /* Utility functions used by multiple pages of the assistant. */
460 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
461 const struct import_assistant *ia,
462 size_t *row, size_t *column)
464 PsppSheetView *tree_view = PSPP_SHEET_VIEW (widget);
468 PsppSheetViewColumn *tree_column;
469 GtkTreeModel *tree_model;
472 /* Check that WIDGET is really visible on the screen before we
473 do anything else. This is a bug fix for a sticky situation:
474 when text_data_import_assistant() returns, it frees the data
475 necessary to compose the tool tip message, but there may be
476 a tool tip under preparation at that point (even if there is
477 no visible tool tip) that will call back into us a little
478 bit later. Perhaps the correct solution to this problem is
479 to make the data related to the tool tips part of a GObject
480 that only gets destroyed when all references are released,
481 but this solution appears to be effective too. */
482 if (!gtk_widget_get_mapped (widget))
485 pspp_sheet_view_convert_widget_to_bin_window_coords (tree_view,
487 if (!pspp_sheet_view_get_path_at_pos (tree_view, bx, by,
488 &path, &tree_column, NULL, NULL))
491 *column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
494 tree_model = pspp_sheet_view_get_model (tree_view);
495 ok = gtk_tree_model_get_iter (tree_model, &iter, path);
496 gtk_tree_path_free (path);
500 *row = empty_list_store_iter_to_row (&iter) + ia->skip_lines;
505 make_tree_view (const struct import_assistant *ia,
507 PsppSheetView **tree_view)
511 *tree_view = PSPP_SHEET_VIEW (pspp_sheet_view_new ());
512 pspp_sheet_view_set_grid_lines (*tree_view, PSPP_SHEET_VIEW_GRID_LINES_BOTH);
513 model = GTK_TREE_MODEL (psppire_empty_list_store_new (
514 ia->file.line_cnt - first_line));
515 g_object_set_data (G_OBJECT (model), "lines", ia->file.lines + first_line);
516 g_object_set_data (G_OBJECT (model), "first-line",
517 GINT_TO_POINTER (first_line));
518 pspp_sheet_view_set_model (*tree_view, model);
519 g_object_unref (model);
521 add_line_number_column (ia, *tree_view);
525 render_line_number (PsppSheetViewColumn *tree_column,
526 GtkCellRenderer *cell,
527 GtkTreeModel *tree_model,
531 gint row = empty_list_store_iter_to_row (iter);
532 char s[INT_BUFSIZE_BOUND (int)];
535 first_line = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_model),
537 sprintf (s, "%d", first_line + row);
538 g_object_set (cell, "text", s, NULL);
542 add_line_number_column (const struct import_assistant *ia,
543 PsppSheetView *treeview)
545 PsppSheetViewColumn *column;
547 column = pspp_sheet_view_column_new_with_attributes (
548 _("Line"), ia->asst.prop_renderer, (void *) NULL);
549 pspp_sheet_view_column_set_fixed_width (
550 column, get_monospace_width (treeview, ia->asst.prop_renderer, 5));
551 pspp_sheet_view_column_set_resizable (column, TRUE);
552 pspp_sheet_view_column_set_cell_data_func (column, ia->asst.prop_renderer,
553 render_line_number, NULL, NULL);
554 pspp_sheet_view_append_column (treeview, column);
558 get_monospace_width (PsppSheetView *treeview, GtkCellRenderer *renderer,
565 ds_put_byte_multiple (&s, '0', char_cnt);
566 ds_put_byte (&s, ' ');
567 width = get_string_width (treeview, renderer, ds_cstr (&s));
574 get_string_width (PsppSheetView *treeview, GtkCellRenderer *renderer,
578 g_object_set (G_OBJECT (renderer), "text", string, (void *) NULL);
579 gtk_cell_renderer_get_size (renderer, GTK_WIDGET (treeview),
580 NULL, NULL, NULL, &width, NULL);
584 PsppSheetViewColumn *
585 make_data_column (struct import_assistant *ia, PsppSheetView *tree_view,
586 bool input, gint dict_idx)
588 struct variable *var = NULL;
589 struct column *column = NULL;
591 gint content_width, header_width;
592 PsppSheetViewColumn *tree_column;
596 column = &ia->columns[dict_idx];
598 var = dict_get_var (ia->dict, dict_idx);
600 name = escape_underscores (input ? column->name : var_get_name (var));
601 char_cnt = input ? column->width : var_get_print_format (var)->w;
602 content_width = get_monospace_width (tree_view, ia->asst.fixed_renderer,
604 header_width = get_string_width (tree_view, ia->asst.prop_renderer,
607 tree_column = pspp_sheet_view_column_new ();
608 g_object_set_data (G_OBJECT (tree_column), "column-number",
609 GINT_TO_POINTER (dict_idx));
610 pspp_sheet_view_column_set_title (tree_column, name);
611 pspp_sheet_view_column_pack_start (tree_column, ia->asst.fixed_renderer,
613 pspp_sheet_view_column_set_cell_data_func (
614 tree_column, ia->asst.fixed_renderer,
615 input ? render_input_cell : render_output_cell, ia, NULL);
616 pspp_sheet_view_column_set_fixed_width (tree_column, MAX (content_width,
625 create_data_tree_view (bool input, GtkContainer *parent,
626 struct import_assistant *ia)
628 PsppSheetView *tree_view;
631 make_tree_view (ia, ia->skip_lines, &tree_view);
632 pspp_sheet_selection_set_mode (pspp_sheet_view_get_selection (tree_view),
633 PSPP_SHEET_SELECTION_NONE);
635 for (i = 0; i < ia->column_cnt; i++)
636 pspp_sheet_view_append_column (tree_view,
637 make_data_column (ia, tree_view, input, i));
639 g_object_set (G_OBJECT (tree_view), "has-tooltip", TRUE, (void *) NULL);
640 g_signal_connect (tree_view, "query-tooltip",
641 G_CALLBACK (input ? on_query_input_tooltip
642 : on_query_output_tooltip), ia);
645 gtk_container_add (parent, GTK_WIDGET (tree_view));
646 gtk_widget_show (GTK_WIDGET (tree_view));
651 /* Increments the "watch cursor" level, setting the cursor for
652 the assistant window to a watch face to indicate to the user
653 that the ongoing operation may take some time. */
655 push_watch_cursor (struct import_assistant *ia)
657 if (++ia->asst.watch_cursor == 1)
659 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
660 GdkDisplay *display = gtk_widget_get_display (widget);
661 GdkCursor *cursor = gdk_cursor_new_for_display (display, GDK_WATCH);
662 gdk_window_set_cursor (widget->window, cursor);
663 gdk_cursor_unref (cursor);
664 gdk_display_flush (display);
668 /* Decrements the "watch cursor" level. If the level reaches
669 zero, the cursor is reset to its default shape. */
671 pop_watch_cursor (struct import_assistant *ia)
673 if (--ia->asst.watch_cursor == 0)
675 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
676 gdk_window_set_cursor (widget->window, NULL);