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"
23 #include <gtk-contrib/psppire-sheet.h>
29 #include "data/data-in.h"
30 #include "data/data-out.h"
31 #include "data/format-guesser.h"
32 #include "data/value-labels.h"
33 #include "language/data-io/data-parser.h"
34 #include "language/lexer/lexer.h"
35 #include "libpspp/assertion.h"
36 #include "libpspp/i18n.h"
37 #include "libpspp/line-reader.h"
38 #include "libpspp/message.h"
39 #include "ui/gui/checkbox-treeview.h"
40 #include "ui/gui/dialog-common.h"
41 #include "ui/gui/executor.h"
42 #include "ui/gui/helper.h"
43 #include "ui/gui/builder-wrapper.h"
44 #include "ui/gui/psppire-data-window.h"
45 #include "ui/gui/psppire-dialog.h"
46 #include "ui/gui/psppire-encoding-selector.h"
47 #include "ui/gui/psppire-empty-list-store.h"
48 #include "ui/gui/psppire-var-sheet.h"
49 #include "ui/gui/psppire-var-store.h"
50 #include "ui/gui/psppire-scanf.h"
51 #include "ui/syntax-gen.h"
54 #include "gl/intprops.h"
55 #include "gl/xalloc.h"
58 #define _(msgid) gettext (msgid)
59 #define N_(msgid) msgid
61 struct import_assistant;
63 static void apply_dict (const struct dictionary *, struct string *);
64 static char *generate_syntax (const struct import_assistant *);
66 static void add_line_number_column (const struct import_assistant *,
69 /* Pops up the Text Data Import assistant. */
71 text_data_import_assistant (PsppireDataWindow *dw)
73 GtkWindow *parent_window = GTK_WINDOW (dw);
74 struct import_assistant *ia = init_assistant (parent_window);
75 struct sheet_spec_page *ssp ;
77 if (!init_file (ia, parent_window))
85 if (ssp->spreadsheet == NULL)
88 init_first_line_page (ia);
89 init_separators_page (ia);
93 init_sheet_spec_page (ia);
96 init_formats_page (ia);
98 gtk_widget_show_all (GTK_WIDGET (ia->asst.assistant));
100 ia->asst.main_loop = g_main_loop_new (NULL, false);
101 g_main_loop_run (ia->asst.main_loop);
102 g_main_loop_unref (ia->asst.main_loop);
104 switch (ia->asst.response)
106 case GTK_RESPONSE_APPLY:
107 free (execute_syntax_string (dw, generate_syntax (ia)));
109 case PSPPIRE_RESPONSE_PASTE:
110 free (paste_syntax_to_window (generate_syntax (ia)));
116 if (ssp->spreadsheet == NULL)
118 destroy_formats_page (ia);
119 destroy_separators_page (ia);
122 destroy_assistant (ia);
127 /* Emits PSPP syntax to S that applies the dictionary attributes
128 (such as missing values and value labels) of the variables in
131 apply_dict (const struct dictionary *dict, struct string *s)
133 size_t var_cnt = dict_get_var_cnt (dict);
136 for (i = 0; i < var_cnt; i++)
138 struct variable *var = dict_get_var (dict, i);
139 const char *name = var_get_name (var);
140 enum val_type type = var_get_type (var);
141 int width = var_get_width (var);
142 enum measure measure = var_get_measure (var);
143 enum alignment alignment = var_get_alignment (var);
144 const struct fmt_spec *format = var_get_print_format (var);
146 if (var_has_missing_values (var))
148 const struct missing_values *mv = var_get_missing_values (var);
151 syntax_gen_pspp (s, "MISSING VALUES %ss (", name);
152 for (j = 0; j < mv_n_values (mv); j++)
155 ds_put_cstr (s, ", ");
156 syntax_gen_value (s, mv_get_value (mv, j), width, format);
159 if (mv_has_range (mv))
162 if (mv_has_value (mv))
163 ds_put_cstr (s, ", ");
164 mv_get_range (mv, &low, &high);
165 syntax_gen_num_range (s, low, high, format);
167 ds_put_cstr (s, ").\n");
169 if (var_has_value_labels (var))
171 const struct val_labs *vls = var_get_value_labels (var);
172 const struct val_lab **labels = val_labs_sorted (vls);
173 size_t n_labels = val_labs_count (vls);
176 syntax_gen_pspp (s, "VALUE LABELS %ss", name);
177 for (i = 0; i < n_labels; i++)
179 const struct val_lab *vl = labels[i];
180 ds_put_cstr (s, "\n ");
181 syntax_gen_value (s, &vl->value, width, format);
182 ds_put_byte (s, ' ');
183 syntax_gen_string (s, ss_cstr (val_lab_get_escaped_label (vl)));
186 ds_put_cstr (s, ".\n");
188 if (var_has_label (var))
189 syntax_gen_pspp (s, "VARIABLE LABELS %ss %sq.\n",
190 name, var_get_label (var));
191 if (measure != var_default_measure (type))
192 syntax_gen_pspp (s, "VARIABLE LEVEL %ss (%ss).\n",
194 (measure == MEASURE_NOMINAL ? "NOMINAL"
195 : measure == MEASURE_ORDINAL ? "ORDINAL"
197 if (alignment != var_default_alignment (type))
198 syntax_gen_pspp (s, "VARIABLE ALIGNMENT %ss (%ss).\n",
200 (alignment == ALIGN_LEFT ? "LEFT"
201 : alignment == ALIGN_CENTRE ? "CENTER"
203 if (var_get_display_width (var) != var_default_display_width (width))
204 syntax_gen_pspp (s, "VARIABLE WIDTH %ss (%d).\n",
205 name, var_get_display_width (var));
209 /* Generates and returns PSPP syntax to execute the import
210 operation described by IA. The caller must free the syntax
213 generate_syntax (const struct import_assistant *ia)
215 struct sheet_spec_page *ssp = ia->sheet_spec;
217 struct string s = DS_EMPTY_INITIALIZER;
219 if (ssp->spreadsheet == NULL)
228 if (ia->file.encoding && strcmp (ia->file.encoding, "Auto"))
229 syntax_gen_pspp (&s, " /ENCODING=%sq\n", ia->file.encoding);
230 if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (
231 ia->intro->n_cases_button)))
232 ds_put_format (&s, " /IMPORTCASES=FIRST %d\n",
233 gtk_spin_button_get_value_as_int (
234 GTK_SPIN_BUTTON (ia->intro->n_cases_spin)));
235 else if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (
236 ia->intro->percent_button)))
237 ds_put_format (&s, " /IMPORTCASES=PERCENT %d\n",
238 gtk_spin_button_get_value_as_int (
239 GTK_SPIN_BUTTON (ia->intro->percent_spin)));
241 ds_put_cstr (&s, " /IMPORTCASES=ALL\n");
243 " /ARRANGEMENT=DELIMITED\n"
245 if (ia->first_line->skip_lines > 0)
246 ds_put_format (&s, " /FIRSTCASE=%d\n", ia->first_line->skip_lines + 1);
247 ds_put_cstr (&s, " /DELIMITERS=\"");
248 if (ds_find_byte (&ia->separators->separators, '\t') != SIZE_MAX)
249 ds_put_cstr (&s, "\\t");
250 if (ds_find_byte (&ia->separators->separators, '\\') != SIZE_MAX)
251 ds_put_cstr (&s, "\\\\");
252 for (i = 0; i < ds_length (&ia->separators->separators); i++)
254 char c = ds_at (&ia->separators->separators, i);
256 ds_put_cstr (&s, "\"\"");
257 else if (c != '\t' && c != '\\')
260 ds_put_cstr (&s, "\"\n");
261 if (!ds_is_empty (&ia->separators->quotes))
262 syntax_gen_pspp (&s, " /QUALIFIER=%sq\n", ds_cstr (&ia->separators->quotes));
263 if (!ds_is_empty (&ia->separators->quotes) && ia->separators->escape)
264 ds_put_cstr (&s, " /ESCAPE\n");
265 ds_put_cstr (&s, " /VARIABLES=\n");
267 var_cnt = dict_get_var_cnt (ia->formats->dict);
268 for (i = 0; i < var_cnt; i++)
270 struct variable *var = dict_get_var (ia->formats->dict, i);
271 char format_string[FMT_STRING_LEN_MAX + 1];
272 fmt_to_string (var_get_print_format (var), format_string);
273 ds_put_format (&s, " %s %s%s\n",
274 var_get_name (var), format_string,
275 i == var_cnt - 1 ? "." : "");
278 apply_dict (ia->formats->dict, &s);
282 const struct sheet_spec_page *ssp = ia->sheet_spec;
284 printf ("%s:%d %p %d\n", __FILE__, __LINE__, ssp->spreadsheet, ssp->spreadsheet->type);
292 (ssp->spreadsheet->type == SPREADSHEET_GNUMERIC) ? "GNM" : "ODS",
294 ssp->opts.sheet_index,
295 ssp->sri.read_names ? "ON" : "OFF");
298 if ( ssp->opts.cell_range)
301 "\n /CELLRANGE=RANGE %sq",
302 ssp->opts.cell_range);
307 "\n /CELLRANGE=FULL");
311 syntax_gen_pspp (&s, ".");
319 static void render_input_cell (GtkTreeViewColumn *tree_column,
320 GtkCellRenderer *cell,
321 GtkTreeModel *model, GtkTreeIter *iter,
324 static gboolean on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
325 gboolean keyboard_mode UNUSED,
327 struct import_assistant *);
331 /* Called to render one of the cells in the fields preview tree
334 render_input_cell (GtkTreeViewColumn *tree_column, GtkCellRenderer *cell,
335 GtkTreeModel *model, GtkTreeIter *iter,
338 struct import_assistant *ia = ia_;
339 struct substring field;
343 column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
345 row = empty_list_store_iter_to_row (iter) + ia->first_line->skip_lines;
346 field = ia->separators->columns[column].contents[row];
347 if (field.string != NULL)
350 g_value_init (&text, G_TYPE_STRING);
351 g_value_take_string (&text, ss_xstrdup (field));
352 g_object_set_property (G_OBJECT (cell), "text", &text);
353 g_value_unset (&text);
354 g_object_set (cell, "background-set", FALSE, (void *) NULL);
360 "background-set", TRUE,
365 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
366 const struct import_assistant *ia,
367 size_t *row, size_t *column);
370 /* Called to render a tooltip on one of the cells in the fields
371 preview tree view. */
373 on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
374 gboolean keyboard_mode UNUSED,
375 GtkTooltip *tooltip, struct import_assistant *ia)
379 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
382 if (ia->separators->columns[column].contents[row].string != NULL)
385 gtk_tooltip_set_text (tooltip,
386 _("This input line has too few separators "
387 "to fill in this field."));
392 /* Parses the contents of the field at (ROW,COLUMN) according to
393 its variable format. If OUTPUTP is non-null, then *OUTPUTP
394 receives the formatted output for that field (which must be
395 freed with free). If TOOLTIPP is non-null, then *TOOLTIPP
396 receives a message suitable for use in a tooltip, if one is
397 needed, or a null pointer otherwise. Returns true if a
398 tooltip message is needed, otherwise false. */
400 parse_field (struct import_assistant *ia,
401 size_t row, size_t column,
402 char **outputp, char **tooltipp)
404 struct substring field;
406 struct variable *var;
407 const struct fmt_spec *in;
412 field = ia->separators->columns[column].contents[row];
413 var = dict_get_var (ia->formats->dict, column);
414 value_init (&val, var_get_width (var));
415 in = var_get_print_format (var);
416 out = fmt_for_output_from_input (in);
418 if (field.string != NULL)
422 error = data_in (field, "UTF-8", in->type, &val, var_get_width (var),
423 dict_get_encoding (ia->formats->dict));
426 tooltip = xasprintf (_("Cannot parse field content `%.*s' as "
428 (int) field.length, field.string,
429 fmt_name (in->type), error);
435 tooltip = xstrdup (_("This input line has too few separators "
436 "to fill in this field."));
437 value_set_missing (&val, var_get_width (var));
441 *outputp = data_out (&val, dict_get_encoding (ia->formats->dict), &out);
443 value_destroy (&val, var_get_width (var));
445 ok = tooltip == NULL;
446 if (tooltipp != NULL)
453 /* Called to render one of the cells in the data preview tree
456 render_output_cell (GtkTreeViewColumn *tree_column,
457 GtkCellRenderer *cell,
462 struct import_assistant *ia = ia_;
464 GValue gvalue = { 0, };
467 ok = parse_field (ia,
468 (empty_list_store_iter_to_row (iter)
469 + ia->first_line->skip_lines),
470 GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
474 g_value_init (&gvalue, G_TYPE_STRING);
475 g_value_take_string (&gvalue, output);
476 g_object_set_property (G_OBJECT (cell), "text", &gvalue);
477 g_value_unset (&gvalue);
480 g_object_set (cell, "background-set", FALSE, (void *) NULL);
484 "background-set", TRUE,
488 /* Called to render a tooltip for one of the cells in the data
489 preview tree view. */
491 on_query_output_tooltip (GtkWidget *widget, gint wx, gint wy,
492 gboolean keyboard_mode UNUSED,
493 GtkTooltip *tooltip, struct import_assistant *ia)
498 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
501 if (parse_field (ia, row, column, NULL, &text))
504 gtk_tooltip_set_text (tooltip, text);
509 /* Utility functions used by multiple pages of the assistant. */
512 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
513 const struct import_assistant *ia,
514 size_t *row, size_t *column)
516 GtkTreeView *tree_view = GTK_TREE_VIEW (widget);
520 GtkTreeViewColumn *tree_column;
521 GtkTreeModel *tree_model;
524 /* Check that WIDGET is really visible on the screen before we
525 do anything else. This is a bug fix for a sticky situation:
526 when text_data_import_assistant() returns, it frees the data
527 necessary to compose the tool tip message, but there may be
528 a tool tip under preparation at that point (even if there is
529 no visible tool tip) that will call back into us a little
530 bit later. Perhaps the correct solution to this problem is
531 to make the data related to the tool tips part of a GObject
532 that only gets destroyed when all references are released,
533 but this solution appears to be effective too. */
534 if (!gtk_widget_get_mapped (widget))
537 gtk_tree_view_convert_widget_to_bin_window_coords (tree_view,
539 if (!gtk_tree_view_get_path_at_pos (tree_view, bx, by,
540 &path, &tree_column, NULL, NULL))
543 *column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
546 tree_model = gtk_tree_view_get_model (tree_view);
547 ok = gtk_tree_model_get_iter (tree_model, &iter, path);
548 gtk_tree_path_free (path);
552 *row = empty_list_store_iter_to_row (&iter) + ia->first_line->skip_lines;
557 make_tree_view (const struct import_assistant *ia,
559 GtkTreeView **tree_view)
563 *tree_view = GTK_TREE_VIEW (gtk_tree_view_new ());
564 model = GTK_TREE_MODEL (psppire_empty_list_store_new (
565 ia->file.line_cnt - first_line));
566 g_object_set_data (G_OBJECT (model), "lines", ia->file.lines + first_line);
567 g_object_set_data (G_OBJECT (model), "first-line",
568 GINT_TO_POINTER (first_line));
569 gtk_tree_view_set_model (*tree_view, model);
570 g_object_unref (model);
572 add_line_number_column (ia, *tree_view);
576 render_line_number (GtkTreeViewColumn *tree_column,
577 GtkCellRenderer *cell,
578 GtkTreeModel *tree_model,
582 gint row = empty_list_store_iter_to_row (iter);
583 char s[INT_BUFSIZE_BOUND (int)];
586 first_line = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_model),
588 sprintf (s, "%d", first_line + row);
589 g_object_set (cell, "text", s, NULL);
593 add_line_number_column (const struct import_assistant *ia,
594 GtkTreeView *treeview)
596 GtkTreeViewColumn *column;
598 column = gtk_tree_view_column_new_with_attributes (
599 _("Line"), ia->asst.prop_renderer, (void *) NULL);
600 gtk_tree_view_column_set_sizing (column, GTK_TREE_VIEW_COLUMN_FIXED);
601 gtk_tree_view_column_set_fixed_width (
602 column, get_monospace_width (treeview, ia->asst.prop_renderer, 5));
603 gtk_tree_view_column_set_resizable (column, TRUE);
604 gtk_tree_view_column_set_cell_data_func (column, ia->asst.prop_renderer,
605 render_line_number, NULL, NULL);
606 gtk_tree_view_append_column (treeview, column);
610 get_monospace_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
617 ds_put_byte_multiple (&s, '0', char_cnt);
618 ds_put_byte (&s, ' ');
619 width = get_string_width (treeview, renderer, ds_cstr (&s));
626 get_string_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
630 g_object_set (G_OBJECT (renderer), "text", string, (void *) NULL);
631 gtk_cell_renderer_get_size (renderer, GTK_WIDGET (treeview),
632 NULL, NULL, NULL, &width, NULL);
637 make_data_column (struct import_assistant *ia, GtkTreeView *tree_view,
638 bool input, gint dict_idx)
640 struct variable *var = NULL;
641 struct column *column = NULL;
643 gint content_width, header_width;
644 GtkTreeViewColumn *tree_column;
648 column = &ia->separators->columns[dict_idx];
650 var = dict_get_var (ia->formats->dict, dict_idx);
652 name = escape_underscores (input ? column->name : var_get_name (var));
653 char_cnt = input ? column->width : var_get_print_format (var)->w;
654 content_width = get_monospace_width (tree_view, ia->asst.fixed_renderer,
656 header_width = get_string_width (tree_view, ia->asst.prop_renderer,
659 tree_column = gtk_tree_view_column_new ();
660 g_object_set_data (G_OBJECT (tree_column), "column-number",
661 GINT_TO_POINTER (dict_idx));
662 gtk_tree_view_column_set_title (tree_column, name);
663 gtk_tree_view_column_pack_start (tree_column, ia->asst.fixed_renderer,
665 gtk_tree_view_column_set_cell_data_func (
666 tree_column, ia->asst.fixed_renderer,
667 input ? render_input_cell : render_output_cell, ia, NULL);
668 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_FIXED);
669 gtk_tree_view_column_set_fixed_width (tree_column, MAX (content_width,
678 create_data_tree_view (bool input, GtkContainer *parent,
679 struct import_assistant *ia)
681 GtkTreeView *tree_view;
684 make_tree_view (ia, ia->first_line->skip_lines, &tree_view);
685 gtk_tree_selection_set_mode (gtk_tree_view_get_selection (tree_view),
688 for (i = 0; i < ia->separators->column_cnt; i++)
689 gtk_tree_view_append_column (tree_view,
690 make_data_column (ia, tree_view, input, i));
692 g_object_set (G_OBJECT (tree_view), "has-tooltip", TRUE, (void *) NULL);
693 g_signal_connect (tree_view, "query-tooltip",
694 G_CALLBACK (input ? on_query_input_tooltip
695 : on_query_output_tooltip), ia);
696 gtk_tree_view_set_fixed_height_mode (tree_view, true);
698 gtk_container_add (parent, GTK_WIDGET (tree_view));
699 gtk_widget_show (GTK_WIDGET (tree_view));
704 /* Increments the "watch cursor" level, setting the cursor for
705 the assistant window to a watch face to indicate to the user
706 that the ongoing operation may take some time. */
708 push_watch_cursor (struct import_assistant *ia)
710 if (++ia->asst.watch_cursor == 1)
712 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
713 GdkDisplay *display = gtk_widget_get_display (widget);
714 GdkCursor *cursor = gdk_cursor_new_for_display (display, GDK_WATCH);
715 gdk_window_set_cursor (widget->window, cursor);
716 gdk_cursor_unref (cursor);
717 gdk_display_flush (display);
721 /* Decrements the "watch cursor" level. If the level reaches
722 zero, the cursor is reset to its default shape. */
724 pop_watch_cursor (struct import_assistant *ia)
726 if (--ia->asst.watch_cursor == 0)
728 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
729 gdk_window_set_cursor (widget->window, NULL);