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"
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->first_line = first_line_page_create (ia);
99 ia->separators = separators_page_create (ia);
101 ia->formats = formats_page_create (ia);
103 gtk_widget_show_all (GTK_WIDGET (ia->asst.assistant));
105 ia->asst.main_loop = g_main_loop_new (NULL, false);
109 Instead of this block,
110 A simple g_main_loop_run (ia->asst.main_loop); should work here. But it seems to crash.
113 GMainContext *ctx = g_main_loop_get_context (ia->asst.main_loop);
114 ia->asst.loop_done = false;
115 while (! ia->asst.loop_done)
117 g_main_context_iteration (ctx, TRUE);
120 g_main_loop_unref (ia->asst.main_loop);
122 switch (ia->asst.response)
124 case GTK_RESPONSE_APPLY:
126 gchar *fn = g_path_get_basename (ia->file.file_name);
127 open_data_window (PSPPIRE_WINDOW (dw), fn, generate_syntax (ia));
131 case PSPPIRE_RESPONSE_PASTE:
132 free (paste_syntax_to_window (generate_syntax (ia)));
140 destroy_formats_page (ia);
141 destroy_separators_page (ia);
144 destroy_assistant (ia);
149 /* Emits PSPP syntax to S that applies the dictionary attributes
150 (such as missing values and value labels) of the variables in
153 apply_dict (const struct dictionary *dict, struct string *s)
155 size_t var_cnt = dict_get_var_cnt (dict);
158 for (i = 0; i < var_cnt; i++)
160 struct variable *var = dict_get_var (dict, i);
161 const char *name = var_get_name (var);
162 enum val_type type = var_get_type (var);
163 int width = var_get_width (var);
164 enum measure measure = var_get_measure (var);
165 enum var_role role = var_get_role (var);
166 enum alignment alignment = var_get_alignment (var);
167 const struct fmt_spec *format = var_get_print_format (var);
169 if (var_has_missing_values (var))
171 const struct missing_values *mv = var_get_missing_values (var);
174 syntax_gen_pspp (s, "MISSING VALUES %ss (", name);
175 for (j = 0; j < mv_n_values (mv); j++)
178 ds_put_cstr (s, ", ");
179 syntax_gen_value (s, mv_get_value (mv, j), width, format);
182 if (mv_has_range (mv))
185 if (mv_has_value (mv))
186 ds_put_cstr (s, ", ");
187 mv_get_range (mv, &low, &high);
188 syntax_gen_num_range (s, low, high, format);
190 ds_put_cstr (s, ").\n");
192 if (var_has_value_labels (var))
194 const struct val_labs *vls = var_get_value_labels (var);
195 const struct val_lab **labels = val_labs_sorted (vls);
196 size_t n_labels = val_labs_count (vls);
199 syntax_gen_pspp (s, "VALUE LABELS %ss", name);
200 for (i = 0; i < n_labels; i++)
202 const struct val_lab *vl = labels[i];
203 ds_put_cstr (s, "\n ");
204 syntax_gen_value (s, &vl->value, width, format);
205 ds_put_byte (s, ' ');
206 syntax_gen_string (s, ss_cstr (val_lab_get_escaped_label (vl)));
209 ds_put_cstr (s, ".\n");
211 if (var_has_label (var))
212 syntax_gen_pspp (s, "VARIABLE LABELS %ss %sq.\n",
213 name, var_get_label (var));
214 if (measure != var_default_measure (type))
215 syntax_gen_pspp (s, "VARIABLE LEVEL %ss (%ss).\n",
216 name, measure_to_syntax (measure));
217 if (role != ROLE_INPUT)
218 syntax_gen_pspp (s, "VARIABLE ROLE /%ss %ss.\n",
219 var_role_to_syntax (role), name);
220 if (alignment != var_default_alignment (type))
221 syntax_gen_pspp (s, "VARIABLE ALIGNMENT %ss (%ss).\n",
222 name, alignment_to_syntax (alignment));
223 if (var_get_display_width (var) != var_default_display_width (width))
224 syntax_gen_pspp (s, "VARIABLE WIDTH %ss (%d).\n",
225 name, var_get_display_width (var));
229 /* Generates and returns PSPP syntax to execute the import
230 operation described by IA. The caller must free the syntax
233 generate_syntax (const struct import_assistant *ia)
235 struct string s = DS_EMPTY_INITIALIZER;
237 if (ia->spreadsheet == NULL)
244 if (ia->file.encoding && strcmp (ia->file.encoding, "Auto"))
245 syntax_gen_pspp (&s, " /ENCODING=%sq\n", ia->file.encoding);
247 intro_append_syntax (ia->intro, &s);
251 " /ARRANGEMENT=DELIMITED\n"
254 first_line_append_syntax (ia, &s);
255 separators_append_syntax (ia, &s);
256 formats_append_syntax (ia, &s);
257 apply_dict (ia->dict, &s);
261 return sheet_spec_gen_syntax (ia);
269 static void render_input_cell (PsppSheetViewColumn *tree_column,
270 GtkCellRenderer *cell,
271 GtkTreeModel *model, GtkTreeIter *iter,
274 static gboolean on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
275 gboolean keyboard_mode UNUSED,
277 struct import_assistant *);
281 /* Called to render one of the cells in the fields preview tree
284 render_input_cell (PsppSheetViewColumn *tree_column, GtkCellRenderer *cell,
285 GtkTreeModel *model, GtkTreeIter *iter,
288 struct import_assistant *ia = ia_;
289 struct substring field;
293 column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
295 row = empty_list_store_iter_to_row (iter) + ia->skip_lines;
296 field = ia->columns[column].contents[row];
297 if (field.string != NULL)
300 g_value_init (&text, G_TYPE_STRING);
301 g_value_take_string (&text, ss_xstrdup (field));
302 g_object_set_property (G_OBJECT (cell), "text", &text);
303 g_value_unset (&text);
304 g_object_set (cell, "background-set", FALSE, (void *) NULL);
310 "background-set", TRUE,
315 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
316 const struct import_assistant *ia,
317 size_t *row, size_t *column);
320 /* Called to render a tooltip on one of the cells in the fields
321 preview tree view. */
323 on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
324 gboolean keyboard_mode UNUSED,
325 GtkTooltip *tooltip, struct import_assistant *ia)
329 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
332 if (ia->columns[column].contents[row].string != NULL)
335 gtk_tooltip_set_text (tooltip,
336 _("This input line has too few separators "
337 "to fill in this field."));
342 /* Parses the contents of the field at (ROW,COLUMN) according to
343 its variable format. If OUTPUTP is non-null, then *OUTPUTP
344 receives the formatted output for that field (which must be
345 freed with free). If TOOLTIPP is non-null, then *TOOLTIPP
346 receives a message suitable for use in a tooltip, if one is
347 needed, or a null pointer otherwise. Returns true if a
348 tooltip message is needed, otherwise false. */
350 parse_field (struct import_assistant *ia,
351 size_t row, size_t column,
352 char **outputp, char **tooltipp)
354 const struct fmt_spec *in;
359 struct substring field = ia->columns[column].contents[row];
360 struct variable *var = dict_get_var (ia->dict, column);
363 value_init (&val, var_get_width (var));
364 in = var_get_print_format (var);
365 out = fmt_for_output_from_input (in);
367 if (field.string != NULL)
371 error = data_in (field, "UTF-8", in->type, &val, var_get_width (var),
372 dict_get_encoding (ia->dict));
375 tooltip = xasprintf (_("Cannot parse field content `%.*s' as "
377 (int) field.length, field.string,
378 fmt_name (in->type), error);
384 tooltip = xstrdup (_("This input line has too few separators "
385 "to fill in this field."));
386 value_set_missing (&val, var_get_width (var));
390 *outputp = data_out (&val, dict_get_encoding (ia->dict), &out);
392 value_destroy (&val, var_get_width (var));
394 ok = tooltip == NULL;
395 if (tooltipp != NULL)
402 /* Called to render one of the cells in the data preview tree
405 render_output_cell (PsppSheetViewColumn *tree_column,
406 GtkCellRenderer *cell,
411 struct import_assistant *ia = ia_;
413 GValue gvalue = { 0, };
416 ok = parse_field (ia,
417 (empty_list_store_iter_to_row (iter)
419 GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
423 g_value_init (&gvalue, G_TYPE_STRING);
424 g_value_take_string (&gvalue, output);
425 g_object_set_property (G_OBJECT (cell), "text", &gvalue);
426 g_value_unset (&gvalue);
429 g_object_set (cell, "background-set", FALSE, (void *) NULL);
433 "background-set", TRUE,
437 /* Called to render a tooltip for one of the cells in the data
438 preview tree view. */
440 on_query_output_tooltip (GtkWidget *widget, gint wx, gint wy,
441 gboolean keyboard_mode UNUSED,
442 GtkTooltip *tooltip, struct import_assistant *ia)
447 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
450 if (parse_field (ia, row, column, NULL, &text))
453 gtk_tooltip_set_text (tooltip, text);
458 /* Utility functions used by multiple pages of the assistant. */
461 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
462 const struct import_assistant *ia,
463 size_t *row, size_t *column)
465 PsppSheetView *tree_view = PSPP_SHEET_VIEW (widget);
469 PsppSheetViewColumn *tree_column;
470 GtkTreeModel *tree_model;
473 /* Check that WIDGET is really visible on the screen before we
474 do anything else. This is a bug fix for a sticky situation:
475 when text_data_import_assistant() returns, it frees the data
476 necessary to compose the tool tip message, but there may be
477 a tool tip under preparation at that point (even if there is
478 no visible tool tip) that will call back into us a little
479 bit later. Perhaps the correct solution to this problem is
480 to make the data related to the tool tips part of a GObject
481 that only gets destroyed when all references are released,
482 but this solution appears to be effective too. */
483 if (!gtk_widget_get_mapped (widget))
486 pspp_sheet_view_convert_widget_to_bin_window_coords (tree_view,
488 if (!pspp_sheet_view_get_path_at_pos (tree_view, bx, by,
489 &path, &tree_column, NULL, NULL))
492 *column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
495 tree_model = pspp_sheet_view_get_model (tree_view);
496 ok = gtk_tree_model_get_iter (tree_model, &iter, path);
497 gtk_tree_path_free (path);
501 *row = empty_list_store_iter_to_row (&iter) + ia->skip_lines;
506 make_tree_view (const struct import_assistant *ia,
508 PsppSheetView **tree_view)
512 *tree_view = PSPP_SHEET_VIEW (pspp_sheet_view_new ());
513 pspp_sheet_view_set_grid_lines (*tree_view, PSPP_SHEET_VIEW_GRID_LINES_BOTH);
514 model = GTK_TREE_MODEL (psppire_empty_list_store_new (
515 ia->file.line_cnt - first_line));
516 g_object_set_data (G_OBJECT (model), "lines", ia->file.lines + first_line);
517 g_object_set_data (G_OBJECT (model), "first-line",
518 GINT_TO_POINTER (first_line));
519 pspp_sheet_view_set_model (*tree_view, model);
520 g_object_unref (model);
522 add_line_number_column (ia, *tree_view);
526 render_line_number (PsppSheetViewColumn *tree_column,
527 GtkCellRenderer *cell,
528 GtkTreeModel *tree_model,
532 gint row = empty_list_store_iter_to_row (iter);
533 char s[INT_BUFSIZE_BOUND (int)];
536 first_line = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_model),
538 sprintf (s, "%d", first_line + row);
539 g_object_set (cell, "text", s, NULL);
543 add_line_number_column (const struct import_assistant *ia,
544 PsppSheetView *treeview)
546 PsppSheetViewColumn *column;
548 column = pspp_sheet_view_column_new_with_attributes (
549 _("Line"), ia->asst.prop_renderer, (void *) NULL);
550 pspp_sheet_view_column_set_fixed_width (
551 column, get_monospace_width (treeview, ia->asst.prop_renderer, 5));
552 pspp_sheet_view_column_set_resizable (column, TRUE);
553 pspp_sheet_view_column_set_cell_data_func (column, ia->asst.prop_renderer,
554 render_line_number, NULL, NULL);
555 pspp_sheet_view_append_column (treeview, column);
559 get_monospace_width (PsppSheetView *treeview, GtkCellRenderer *renderer,
566 ds_put_byte_multiple (&s, '0', char_cnt);
567 ds_put_byte (&s, ' ');
568 width = get_string_width (treeview, renderer, ds_cstr (&s));
575 get_string_width (PsppSheetView *treeview, GtkCellRenderer *renderer,
579 g_object_set (G_OBJECT (renderer), "text", string, (void *) NULL);
580 gtk_cell_renderer_get_size (renderer, GTK_WIDGET (treeview),
581 NULL, NULL, NULL, &width, NULL);
585 PsppSheetViewColumn *
586 make_data_column (struct import_assistant *ia, PsppSheetView *tree_view,
587 bool input, gint dict_idx)
589 struct variable *var = NULL;
590 struct column *column = NULL;
592 gint content_width, header_width;
593 PsppSheetViewColumn *tree_column;
597 column = &ia->columns[dict_idx];
599 var = dict_get_var (ia->dict, dict_idx);
601 name = escape_underscores (input ? column->name : var_get_name (var));
602 char_cnt = input ? column->width : var_get_print_format (var)->w;
603 content_width = get_monospace_width (tree_view, ia->asst.fixed_renderer,
605 header_width = get_string_width (tree_view, ia->asst.prop_renderer,
608 tree_column = pspp_sheet_view_column_new ();
609 g_object_set_data (G_OBJECT (tree_column), "column-number",
610 GINT_TO_POINTER (dict_idx));
611 pspp_sheet_view_column_set_title (tree_column, name);
612 pspp_sheet_view_column_pack_start (tree_column, ia->asst.fixed_renderer,
614 pspp_sheet_view_column_set_cell_data_func (
615 tree_column, ia->asst.fixed_renderer,
616 input ? render_input_cell : render_output_cell, ia, NULL);
617 pspp_sheet_view_column_set_fixed_width (tree_column, MAX (content_width,
626 create_data_tree_view (bool input, GtkContainer *parent,
627 struct import_assistant *ia)
629 PsppSheetView *tree_view;
632 make_tree_view (ia, ia->skip_lines, &tree_view);
633 pspp_sheet_selection_set_mode (pspp_sheet_view_get_selection (tree_view),
634 PSPP_SHEET_SELECTION_NONE);
636 for (i = 0; i < ia->column_cnt; i++)
637 pspp_sheet_view_append_column (tree_view,
638 make_data_column (ia, tree_view, input, i));
640 g_object_set (G_OBJECT (tree_view), "has-tooltip", TRUE, (void *) NULL);
641 g_signal_connect (tree_view, "query-tooltip",
642 G_CALLBACK (input ? on_query_input_tooltip
643 : on_query_output_tooltip), ia);
646 gtk_container_add (parent, GTK_WIDGET (tree_view));
647 gtk_widget_show (GTK_WIDGET (tree_view));
652 /* Increments the "watch cursor" level, setting the cursor for
653 the assistant window to a watch face to indicate to the user
654 that the ongoing operation may take some time. */
656 push_watch_cursor (struct import_assistant *ia)
658 if (++ia->asst.watch_cursor == 1)
660 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
661 GdkDisplay *display = gtk_widget_get_display (widget);
662 GdkCursor *cursor = gdk_cursor_new_for_display (display, GDK_WATCH);
663 gdk_window_set_cursor (widget->window, cursor);
664 gdk_cursor_unref (cursor);
665 gdk_display_flush (display);
669 /* Decrements the "watch cursor" level. If the level reaches
670 zero, the cursor is reset to its default shape. */
672 pop_watch_cursor (struct import_assistant *ia)
674 if (--ia->asst.watch_cursor == 0)
676 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
677 gdk_window_set_cursor (widget->window, NULL);