1 /* PSPPIRE - a graphical user interface for PSPP.
2 Copyright (C) 2008, 2009, 2010, 2011, 2012, 2013, 2014 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/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"
58 #include "gl/intprops.h"
59 #include "gl/xalloc.h"
62 #define _(msgid) gettext (msgid)
63 #define N_(msgid) msgid
65 struct import_assistant;
67 static void apply_dict (const struct dictionary *, struct string *);
68 static char *generate_syntax (const struct import_assistant *);
70 static void add_line_number_column (const struct import_assistant *,
73 /* Pops up the Text Data Import assistant. */
75 text_data_import_assistant (PsppireDataWindow *dw)
77 GtkWindow *parent_window = GTK_WINDOW (dw);
78 struct import_assistant *ia = init_assistant (parent_window);
79 struct sheet_spec_page *ssp ;
81 if (!init_file (ia, parent_window))
91 ia->sheet_spec = sheet_spec_page_create (ia);
95 ia->intro = intro_page_create (ia);
96 ia->first_line = first_line_page_create (ia);
97 ia->separators = separators_page_create (ia);
99 ia->formats = formats_page_create (ia);
101 gtk_widget_show_all (GTK_WIDGET (ia->asst.assistant));
103 ia->asst.main_loop = g_main_loop_new (NULL, false);
107 Instead of this block,
108 A simple g_main_loop_run (ia->asst.main_loop); should work here. But it seems to crash.
111 GMainContext *ctx = g_main_loop_get_context (ia->asst.main_loop);
112 ia->asst.loop_done = false;
113 while (! ia->asst.loop_done)
115 g_main_context_iteration (ctx, TRUE);
118 g_main_loop_unref (ia->asst.main_loop);
120 switch (ia->asst.response)
122 case GTK_RESPONSE_APPLY:
124 gchar *fn = g_path_get_basename (ia->file.file_name);
125 open_data_window (PSPPIRE_WINDOW (dw), fn, NULL, generate_syntax (ia));
129 case PSPPIRE_RESPONSE_PASTE:
130 free (paste_syntax_to_window (generate_syntax (ia)));
138 destroy_formats_page (ia);
139 destroy_separators_page (ia);
142 destroy_assistant (ia);
147 /* Emits PSPP syntax to S that applies the dictionary attributes
148 (such as missing values and value labels) of the variables in
151 apply_dict (const struct dictionary *dict, struct string *s)
153 size_t var_cnt = dict_get_var_cnt (dict);
156 for (i = 0; i < var_cnt; i++)
158 struct variable *var = dict_get_var (dict, i);
159 const char *name = var_get_name (var);
160 enum val_type type = var_get_type (var);
161 int width = var_get_width (var);
162 enum measure measure = var_get_measure (var);
163 enum var_role role = var_get_role (var);
164 enum alignment alignment = var_get_alignment (var);
165 const struct fmt_spec *format = var_get_print_format (var);
167 if (var_has_missing_values (var))
169 const struct missing_values *mv = var_get_missing_values (var);
172 syntax_gen_pspp (s, "MISSING VALUES %ss (", name);
173 for (j = 0; j < mv_n_values (mv); j++)
176 ds_put_cstr (s, ", ");
177 syntax_gen_value (s, mv_get_value (mv, j), width, format);
180 if (mv_has_range (mv))
183 if (mv_has_value (mv))
184 ds_put_cstr (s, ", ");
185 mv_get_range (mv, &low, &high);
186 syntax_gen_num_range (s, low, high, format);
188 ds_put_cstr (s, ").\n");
190 if (var_has_value_labels (var))
192 const struct val_labs *vls = var_get_value_labels (var);
193 const struct val_lab **labels = val_labs_sorted (vls);
194 size_t n_labels = val_labs_count (vls);
197 syntax_gen_pspp (s, "VALUE LABELS %ss", name);
198 for (i = 0; i < n_labels; i++)
200 const struct val_lab *vl = labels[i];
201 ds_put_cstr (s, "\n ");
202 syntax_gen_value (s, &vl->value, width, format);
203 ds_put_byte (s, ' ');
204 syntax_gen_string (s, ss_cstr (val_lab_get_escaped_label (vl)));
207 ds_put_cstr (s, ".\n");
209 if (var_has_label (var))
210 syntax_gen_pspp (s, "VARIABLE LABELS %ss %sq.\n",
211 name, var_get_label (var));
212 if (measure != var_default_measure (type))
213 syntax_gen_pspp (s, "VARIABLE LEVEL %ss (%ss).\n",
214 name, measure_to_syntax (measure));
215 if (role != ROLE_INPUT)
216 syntax_gen_pspp (s, "VARIABLE ROLE /%ss %ss.\n",
217 var_role_to_syntax (role), name);
218 if (alignment != var_default_alignment (type))
219 syntax_gen_pspp (s, "VARIABLE ALIGNMENT %ss (%ss).\n",
220 name, alignment_to_syntax (alignment));
221 if (var_get_display_width (var) != var_default_display_width (width))
222 syntax_gen_pspp (s, "VARIABLE WIDTH %ss (%d).\n",
223 name, var_get_display_width (var));
227 /* Generates and returns PSPP syntax to execute the import
228 operation described by IA. The caller must free the syntax
231 generate_syntax (const struct import_assistant *ia)
233 struct string s = DS_EMPTY_INITIALIZER;
235 if (ia->spreadsheet == NULL)
242 if (ia->file.encoding && strcmp (ia->file.encoding, "Auto"))
243 syntax_gen_pspp (&s, " /ENCODING=%sq\n", ia->file.encoding);
245 intro_append_syntax (ia->intro, &s);
249 " /ARRANGEMENT=DELIMITED\n"
252 first_line_append_syntax (ia, &s);
253 separators_append_syntax (ia, &s);
254 formats_append_syntax (ia, &s);
255 apply_dict (ia->dict, &s);
259 return sheet_spec_gen_syntax (ia);
267 static void render_input_cell (PsppSheetViewColumn *tree_column,
268 GtkCellRenderer *cell,
269 GtkTreeModel *model, GtkTreeIter *iter,
272 static gboolean on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
273 gboolean keyboard_mode UNUSED,
275 struct import_assistant *);
279 /* Called to render one of the cells in the fields preview tree
282 render_input_cell (PsppSheetViewColumn *tree_column, GtkCellRenderer *cell,
283 GtkTreeModel *model, GtkTreeIter *iter,
286 struct import_assistant *ia = ia_;
287 struct substring field;
291 column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
293 row = empty_list_store_iter_to_row (iter) + ia->skip_lines;
294 field = ia->columns[column].contents[row];
295 if (field.string != NULL)
298 g_value_init (&text, G_TYPE_STRING);
299 g_value_take_string (&text, ss_xstrdup (field));
300 g_object_set_property (G_OBJECT (cell), "text", &text);
301 g_value_unset (&text);
302 g_object_set (cell, "background-set", FALSE, (void *) NULL);
308 "background-set", TRUE,
313 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
314 const struct import_assistant *ia,
315 size_t *row, size_t *column);
318 /* Called to render a tooltip on one of the cells in the fields
319 preview tree view. */
321 on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
322 gboolean keyboard_mode UNUSED,
323 GtkTooltip *tooltip, struct import_assistant *ia)
327 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
330 if (ia->columns[column].contents[row].string != NULL)
333 gtk_tooltip_set_text (tooltip,
334 _("This input line has too few separators "
335 "to fill in this field."));
340 /* Parses the contents of the field at (ROW,COLUMN) according to
341 its variable format. If OUTPUTP is non-null, then *OUTPUTP
342 receives the formatted output for that field (which must be
343 freed with free). If TOOLTIPP is non-null, then *TOOLTIPP
344 receives a message suitable for use in a tooltip, if one is
345 needed, or a null pointer otherwise. Returns true if a
346 tooltip message is needed, otherwise false. */
348 parse_field (struct import_assistant *ia,
349 size_t row, size_t column,
350 char **outputp, char **tooltipp)
352 const struct fmt_spec *in;
357 struct substring field = ia->columns[column].contents[row];
358 struct variable *var = dict_get_var (ia->dict, column);
361 value_init (&val, var_get_width (var));
362 in = var_get_print_format (var);
363 out = fmt_for_output_from_input (in);
365 if (field.string != NULL)
369 error = data_in (field, "UTF-8", in->type, &val, var_get_width (var),
370 dict_get_encoding (ia->dict));
373 tooltip = xasprintf (_("Cannot parse field content `%.*s' as "
375 (int) field.length, field.string,
376 fmt_name (in->type), error);
382 tooltip = xstrdup (_("This input line has too few separators "
383 "to fill in this field."));
384 value_set_missing (&val, var_get_width (var));
388 *outputp = data_out (&val, dict_get_encoding (ia->dict), &out);
390 value_destroy (&val, var_get_width (var));
392 ok = tooltip == NULL;
393 if (tooltipp != NULL)
400 /* Called to render one of the cells in the data preview tree
403 render_output_cell (PsppSheetViewColumn *tree_column,
404 GtkCellRenderer *cell,
409 struct import_assistant *ia = ia_;
411 GValue gvalue = { 0, };
414 ok = parse_field (ia,
415 (empty_list_store_iter_to_row (iter)
417 GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
421 g_value_init (&gvalue, G_TYPE_STRING);
422 g_value_take_string (&gvalue, output);
423 g_object_set_property (G_OBJECT (cell), "text", &gvalue);
424 g_value_unset (&gvalue);
427 g_object_set (cell, "background-set", FALSE, (void *) NULL);
431 "background-set", TRUE,
435 /* Called to render a tooltip for one of the cells in the data
436 preview tree view. */
438 on_query_output_tooltip (GtkWidget *widget, gint wx, gint wy,
439 gboolean keyboard_mode UNUSED,
440 GtkTooltip *tooltip, struct import_assistant *ia)
445 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
448 if (parse_field (ia, row, column, NULL, &text))
451 gtk_tooltip_set_text (tooltip, text);
456 /* Utility functions used by multiple pages of the assistant. */
459 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
460 const struct import_assistant *ia,
461 size_t *row, size_t *column)
463 PsppSheetView *tree_view = PSPP_SHEET_VIEW (widget);
467 PsppSheetViewColumn *tree_column;
468 GtkTreeModel *tree_model;
471 /* Check that WIDGET is really visible on the screen before we
472 do anything else. This is a bug fix for a sticky situation:
473 when text_data_import_assistant() returns, it frees the data
474 necessary to compose the tool tip message, but there may be
475 a tool tip under preparation at that point (even if there is
476 no visible tool tip) that will call back into us a little
477 bit later. Perhaps the correct solution to this problem is
478 to make the data related to the tool tips part of a GObject
479 that only gets destroyed when all references are released,
480 but this solution appears to be effective too. */
481 if (!gtk_widget_get_mapped (widget))
484 pspp_sheet_view_convert_widget_to_bin_window_coords (tree_view,
486 if (!pspp_sheet_view_get_path_at_pos (tree_view, bx, by,
487 &path, &tree_column, NULL, NULL))
490 *column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
493 tree_model = pspp_sheet_view_get_model (tree_view);
494 ok = gtk_tree_model_get_iter (tree_model, &iter, path);
495 gtk_tree_path_free (path);
499 *row = empty_list_store_iter_to_row (&iter) + ia->skip_lines;
504 make_tree_view (const struct import_assistant *ia,
506 PsppSheetView **tree_view)
510 *tree_view = PSPP_SHEET_VIEW (pspp_sheet_view_new ());
511 pspp_sheet_view_set_grid_lines (*tree_view, PSPP_SHEET_VIEW_GRID_LINES_BOTH);
512 model = GTK_TREE_MODEL (psppire_empty_list_store_new (
513 ia->file.line_cnt - first_line));
514 g_object_set_data (G_OBJECT (model), "lines", ia->file.lines + first_line);
515 g_object_set_data (G_OBJECT (model), "first-line",
516 GINT_TO_POINTER (first_line));
517 pspp_sheet_view_set_model (*tree_view, model);
518 g_object_unref (model);
520 add_line_number_column (ia, *tree_view);
524 render_line_number (PsppSheetViewColumn *tree_column,
525 GtkCellRenderer *cell,
526 GtkTreeModel *tree_model,
530 gint row = empty_list_store_iter_to_row (iter);
531 char s[INT_BUFSIZE_BOUND (int)];
534 first_line = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_model),
536 sprintf (s, "%d", first_line + row);
537 g_object_set (cell, "text", s, NULL);
541 add_line_number_column (const struct import_assistant *ia,
542 PsppSheetView *treeview)
544 PsppSheetViewColumn *column;
546 column = pspp_sheet_view_column_new_with_attributes (
547 _("Line"), ia->asst.prop_renderer, (void *) NULL);
548 pspp_sheet_view_column_set_fixed_width (
549 column, get_monospace_width (treeview, ia->asst.prop_renderer, 5));
550 pspp_sheet_view_column_set_resizable (column, TRUE);
551 pspp_sheet_view_column_set_cell_data_func (column, ia->asst.prop_renderer,
552 render_line_number, NULL, NULL);
553 pspp_sheet_view_append_column (treeview, column);
557 get_monospace_width (PsppSheetView *treeview, GtkCellRenderer *renderer,
564 ds_put_byte_multiple (&s, '0', char_cnt);
565 ds_put_byte (&s, ' ');
566 width = get_string_width (treeview, renderer, ds_cstr (&s));
573 get_string_width (PsppSheetView *treeview, GtkCellRenderer *renderer,
577 g_object_set (G_OBJECT (renderer), "text", string, (void *) NULL);
578 gtk_cell_renderer_get_size (renderer, GTK_WIDGET (treeview),
579 NULL, NULL, NULL, &width, NULL);
583 PsppSheetViewColumn *
584 make_data_column (struct import_assistant *ia, PsppSheetView *tree_view,
585 bool input, gint dict_idx)
587 struct variable *var = NULL;
588 struct column *column = NULL;
590 gint content_width, header_width;
591 PsppSheetViewColumn *tree_column;
595 column = &ia->columns[dict_idx];
597 var = dict_get_var (ia->dict, dict_idx);
599 name = escape_underscores (input ? column->name : var_get_name (var));
600 char_cnt = input ? column->width : var_get_print_format (var)->w;
601 content_width = get_monospace_width (tree_view, ia->asst.fixed_renderer,
603 header_width = get_string_width (tree_view, ia->asst.prop_renderer,
606 tree_column = pspp_sheet_view_column_new ();
607 g_object_set_data (G_OBJECT (tree_column), "column-number",
608 GINT_TO_POINTER (dict_idx));
609 pspp_sheet_view_column_set_title (tree_column, name);
610 pspp_sheet_view_column_pack_start (tree_column, ia->asst.fixed_renderer,
612 pspp_sheet_view_column_set_cell_data_func (
613 tree_column, ia->asst.fixed_renderer,
614 input ? render_input_cell : render_output_cell, ia, NULL);
615 pspp_sheet_view_column_set_fixed_width (tree_column, MAX (content_width,
624 create_data_tree_view (bool input, GtkContainer *parent,
625 struct import_assistant *ia)
627 PsppSheetView *tree_view;
630 make_tree_view (ia, ia->skip_lines, &tree_view);
631 pspp_sheet_selection_set_mode (pspp_sheet_view_get_selection (tree_view),
632 PSPP_SHEET_SELECTION_NONE);
634 for (i = 0; i < ia->column_cnt; i++)
635 pspp_sheet_view_append_column (tree_view,
636 make_data_column (ia, tree_view, input, i));
638 g_object_set (G_OBJECT (tree_view), "has-tooltip", TRUE, (void *) NULL);
639 g_signal_connect (tree_view, "query-tooltip",
640 G_CALLBACK (input ? on_query_input_tooltip
641 : on_query_output_tooltip), ia);
644 gtk_container_add (parent, GTK_WIDGET (tree_view));
645 gtk_widget_show (GTK_WIDGET (tree_view));
650 /* Increments the "watch cursor" level, setting the cursor for
651 the assistant window to a watch face to indicate to the user
652 that the ongoing operation may take some time. */
654 push_watch_cursor (struct import_assistant *ia)
656 if (++ia->asst.watch_cursor == 1)
658 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
659 GdkDisplay *display = gtk_widget_get_display (widget);
660 GdkCursor *cursor = gdk_cursor_new_for_display (display, GDK_WATCH);
661 gdk_window_set_cursor (widget->window, cursor);
662 gdk_cursor_unref (cursor);
663 gdk_display_flush (display);
667 /* Decrements the "watch cursor" level. If the level reaches
668 zero, the cursor is reset to its default shape. */
670 pop_watch_cursor (struct import_assistant *ia)
672 if (--ia->asst.watch_cursor == 0)
674 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
675 gdk_window_set_cursor (widget->window, NULL);