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))
84 if (ssp->spreadsheet == NULL)
86 init_first_line_page (ia);
87 init_separators_page (ia);
91 init_sheet_spec_page (ia);
94 init_formats_page (ia);
96 gtk_widget_show_all (GTK_WIDGET (ia->asst.assistant));
98 ia->asst.main_loop = g_main_loop_new (NULL, false);
99 g_main_loop_run (ia->asst.main_loop);
100 g_main_loop_unref (ia->asst.main_loop);
102 switch (ia->asst.response)
104 case GTK_RESPONSE_APPLY:
105 free (execute_syntax_string (dw, generate_syntax (ia)));
107 case PSPPIRE_RESPONSE_PASTE:
108 free (paste_syntax_to_window (generate_syntax (ia)));
114 if (ssp->spreadsheet == NULL)
116 destroy_formats_page (ia);
117 destroy_separators_page (ia);
120 destroy_assistant (ia);
125 /* Emits PSPP syntax to S that applies the dictionary attributes
126 (such as missing values and value labels) of the variables in
129 apply_dict (const struct dictionary *dict, struct string *s)
131 size_t var_cnt = dict_get_var_cnt (dict);
134 for (i = 0; i < var_cnt; i++)
136 struct variable *var = dict_get_var (dict, i);
137 const char *name = var_get_name (var);
138 enum val_type type = var_get_type (var);
139 int width = var_get_width (var);
140 enum measure measure = var_get_measure (var);
141 enum alignment alignment = var_get_alignment (var);
142 const struct fmt_spec *format = var_get_print_format (var);
144 if (var_has_missing_values (var))
146 const struct missing_values *mv = var_get_missing_values (var);
149 syntax_gen_pspp (s, "MISSING VALUES %ss (", name);
150 for (j = 0; j < mv_n_values (mv); j++)
153 ds_put_cstr (s, ", ");
154 syntax_gen_value (s, mv_get_value (mv, j), width, format);
157 if (mv_has_range (mv))
160 if (mv_has_value (mv))
161 ds_put_cstr (s, ", ");
162 mv_get_range (mv, &low, &high);
163 syntax_gen_num_range (s, low, high, format);
165 ds_put_cstr (s, ").\n");
167 if (var_has_value_labels (var))
169 const struct val_labs *vls = var_get_value_labels (var);
170 const struct val_lab **labels = val_labs_sorted (vls);
171 size_t n_labels = val_labs_count (vls);
174 syntax_gen_pspp (s, "VALUE LABELS %ss", name);
175 for (i = 0; i < n_labels; i++)
177 const struct val_lab *vl = labels[i];
178 ds_put_cstr (s, "\n ");
179 syntax_gen_value (s, &vl->value, width, format);
180 ds_put_byte (s, ' ');
181 syntax_gen_string (s, ss_cstr (val_lab_get_escaped_label (vl)));
184 ds_put_cstr (s, ".\n");
186 if (var_has_label (var))
187 syntax_gen_pspp (s, "VARIABLE LABELS %ss %sq.\n",
188 name, var_get_label (var));
189 if (measure != var_default_measure (type))
190 syntax_gen_pspp (s, "VARIABLE LEVEL %ss (%ss).\n",
192 (measure == MEASURE_NOMINAL ? "NOMINAL"
193 : measure == MEASURE_ORDINAL ? "ORDINAL"
195 if (alignment != var_default_alignment (type))
196 syntax_gen_pspp (s, "VARIABLE ALIGNMENT %ss (%ss).\n",
198 (alignment == ALIGN_LEFT ? "LEFT"
199 : alignment == ALIGN_CENTRE ? "CENTER"
201 if (var_get_display_width (var) != var_default_display_width (width))
202 syntax_gen_pspp (s, "VARIABLE WIDTH %ss (%d).\n",
203 name, var_get_display_width (var));
207 /* Generates and returns PSPP syntax to execute the import
208 operation described by IA. The caller must free the syntax
211 generate_syntax (const struct import_assistant *ia)
213 struct sheet_spec_page *ssp = ia->sheet_spec;
215 struct string s = DS_EMPTY_INITIALIZER;
217 if (ssp->spreadsheet == NULL)
226 if (ia->file.encoding && strcmp (ia->file.encoding, "Auto"))
227 syntax_gen_pspp (&s, " /ENCODING=%sq\n", ia->file.encoding);
228 if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (
229 ia->intro->n_cases_button)))
230 ds_put_format (&s, " /IMPORTCASES=FIRST %d\n",
231 gtk_spin_button_get_value_as_int (
232 GTK_SPIN_BUTTON (ia->intro->n_cases_spin)));
233 else if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (
234 ia->intro->percent_button)))
235 ds_put_format (&s, " /IMPORTCASES=PERCENT %d\n",
236 gtk_spin_button_get_value_as_int (
237 GTK_SPIN_BUTTON (ia->intro->percent_spin)));
239 ds_put_cstr (&s, " /IMPORTCASES=ALL\n");
241 " /ARRANGEMENT=DELIMITED\n"
243 if (ia->first_line->skip_lines > 0)
244 ds_put_format (&s, " /FIRSTCASE=%d\n", ia->first_line->skip_lines + 1);
245 ds_put_cstr (&s, " /DELIMITERS=\"");
246 if (ds_find_byte (&ia->separators->separators, '\t') != SIZE_MAX)
247 ds_put_cstr (&s, "\\t");
248 if (ds_find_byte (&ia->separators->separators, '\\') != SIZE_MAX)
249 ds_put_cstr (&s, "\\\\");
250 for (i = 0; i < ds_length (&ia->separators->separators); i++)
252 char c = ds_at (&ia->separators->separators, i);
254 ds_put_cstr (&s, "\"\"");
255 else if (c != '\t' && c != '\\')
258 ds_put_cstr (&s, "\"\n");
259 if (!ds_is_empty (&ia->separators->quotes))
260 syntax_gen_pspp (&s, " /QUALIFIER=%sq\n", ds_cstr (&ia->separators->quotes));
261 if (!ds_is_empty (&ia->separators->quotes) && ia->separators->escape)
262 ds_put_cstr (&s, " /ESCAPE\n");
263 ds_put_cstr (&s, " /VARIABLES=\n");
265 var_cnt = dict_get_var_cnt (ia->formats->dict);
266 for (i = 0; i < var_cnt; i++)
268 struct variable *var = dict_get_var (ia->formats->dict, i);
269 char format_string[FMT_STRING_LEN_MAX + 1];
270 fmt_to_string (var_get_print_format (var), format_string);
271 ds_put_format (&s, " %s %s%s\n",
272 var_get_name (var), format_string,
273 i == var_cnt - 1 ? "." : "");
276 apply_dict (ia->formats->dict, &s);
280 const struct sheet_spec_page *ssp = ia->sheet_spec;
282 printf ("%s:%d %p %d\n", __FILE__, __LINE__, ssp->spreadsheet, ssp->spreadsheet->type);
290 (ssp->spreadsheet->type == SPREADSHEET_GNUMERIC) ? "GNM" : "ODS",
292 ssp->opts.sheet_index,
293 ssp->sri.read_names ? "ON" : "OFF");
296 if ( ssp->opts.cell_range)
299 "\n /CELLRANGE=RANGE %sq",
300 ssp->opts.cell_range);
305 "\n /CELLRANGE=FULL");
309 syntax_gen_pspp (&s, ".");
317 static void render_input_cell (GtkTreeViewColumn *tree_column,
318 GtkCellRenderer *cell,
319 GtkTreeModel *model, GtkTreeIter *iter,
322 static gboolean on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
323 gboolean keyboard_mode UNUSED,
325 struct import_assistant *);
329 /* Called to render one of the cells in the fields preview tree
332 render_input_cell (GtkTreeViewColumn *tree_column, GtkCellRenderer *cell,
333 GtkTreeModel *model, GtkTreeIter *iter,
336 struct import_assistant *ia = ia_;
337 struct substring field;
341 column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
343 row = empty_list_store_iter_to_row (iter) + ia->first_line->skip_lines;
344 field = ia->separators->columns[column].contents[row];
345 if (field.string != NULL)
348 g_value_init (&text, G_TYPE_STRING);
349 g_value_take_string (&text, ss_xstrdup (field));
350 g_object_set_property (G_OBJECT (cell), "text", &text);
351 g_value_unset (&text);
352 g_object_set (cell, "background-set", FALSE, (void *) NULL);
358 "background-set", TRUE,
363 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
364 const struct import_assistant *ia,
365 size_t *row, size_t *column);
368 /* Called to render a tooltip on one of the cells in the fields
369 preview tree view. */
371 on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
372 gboolean keyboard_mode UNUSED,
373 GtkTooltip *tooltip, struct import_assistant *ia)
377 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
380 if (ia->separators->columns[column].contents[row].string != NULL)
383 gtk_tooltip_set_text (tooltip,
384 _("This input line has too few separators "
385 "to fill in this field."));
390 /* Parses the contents of the field at (ROW,COLUMN) according to
391 its variable format. If OUTPUTP is non-null, then *OUTPUTP
392 receives the formatted output for that field (which must be
393 freed with free). If TOOLTIPP is non-null, then *TOOLTIPP
394 receives a message suitable for use in a tooltip, if one is
395 needed, or a null pointer otherwise. Returns true if a
396 tooltip message is needed, otherwise false. */
398 parse_field (struct import_assistant *ia,
399 size_t row, size_t column,
400 char **outputp, char **tooltipp)
402 struct substring field;
404 struct variable *var;
405 const struct fmt_spec *in;
410 field = ia->separators->columns[column].contents[row];
411 var = dict_get_var (ia->formats->dict, column);
412 value_init (&val, var_get_width (var));
413 in = var_get_print_format (var);
414 out = fmt_for_output_from_input (in);
416 if (field.string != NULL)
420 error = data_in (field, "UTF-8", in->type, &val, var_get_width (var),
421 dict_get_encoding (ia->formats->dict));
424 tooltip = xasprintf (_("Cannot parse field content `%.*s' as "
426 (int) field.length, field.string,
427 fmt_name (in->type), error);
433 tooltip = xstrdup (_("This input line has too few separators "
434 "to fill in this field."));
435 value_set_missing (&val, var_get_width (var));
439 *outputp = data_out (&val, dict_get_encoding (ia->formats->dict), &out);
441 value_destroy (&val, var_get_width (var));
443 ok = tooltip == NULL;
444 if (tooltipp != NULL)
451 /* Called to render one of the cells in the data preview tree
454 render_output_cell (GtkTreeViewColumn *tree_column,
455 GtkCellRenderer *cell,
460 struct import_assistant *ia = ia_;
462 GValue gvalue = { 0, };
465 ok = parse_field (ia,
466 (empty_list_store_iter_to_row (iter)
467 + ia->first_line->skip_lines),
468 GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
472 g_value_init (&gvalue, G_TYPE_STRING);
473 g_value_take_string (&gvalue, output);
474 g_object_set_property (G_OBJECT (cell), "text", &gvalue);
475 g_value_unset (&gvalue);
478 g_object_set (cell, "background-set", FALSE, (void *) NULL);
482 "background-set", TRUE,
486 /* Called to render a tooltip for one of the cells in the data
487 preview tree view. */
489 on_query_output_tooltip (GtkWidget *widget, gint wx, gint wy,
490 gboolean keyboard_mode UNUSED,
491 GtkTooltip *tooltip, struct import_assistant *ia)
496 if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
499 if (parse_field (ia, row, column, NULL, &text))
502 gtk_tooltip_set_text (tooltip, text);
507 /* Utility functions used by multiple pages of the assistant. */
510 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
511 const struct import_assistant *ia,
512 size_t *row, size_t *column)
514 GtkTreeView *tree_view = GTK_TREE_VIEW (widget);
518 GtkTreeViewColumn *tree_column;
519 GtkTreeModel *tree_model;
522 /* Check that WIDGET is really visible on the screen before we
523 do anything else. This is a bug fix for a sticky situation:
524 when text_data_import_assistant() returns, it frees the data
525 necessary to compose the tool tip message, but there may be
526 a tool tip under preparation at that point (even if there is
527 no visible tool tip) that will call back into us a little
528 bit later. Perhaps the correct solution to this problem is
529 to make the data related to the tool tips part of a GObject
530 that only gets destroyed when all references are released,
531 but this solution appears to be effective too. */
532 if (!gtk_widget_get_mapped (widget))
535 gtk_tree_view_convert_widget_to_bin_window_coords (tree_view,
537 if (!gtk_tree_view_get_path_at_pos (tree_view, bx, by,
538 &path, &tree_column, NULL, NULL))
541 *column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
544 tree_model = gtk_tree_view_get_model (tree_view);
545 ok = gtk_tree_model_get_iter (tree_model, &iter, path);
546 gtk_tree_path_free (path);
550 *row = empty_list_store_iter_to_row (&iter) + ia->first_line->skip_lines;
555 make_tree_view (const struct import_assistant *ia,
557 GtkTreeView **tree_view)
561 *tree_view = GTK_TREE_VIEW (gtk_tree_view_new ());
562 model = GTK_TREE_MODEL (psppire_empty_list_store_new (
563 ia->file.line_cnt - first_line));
564 g_object_set_data (G_OBJECT (model), "lines", ia->file.lines + first_line);
565 g_object_set_data (G_OBJECT (model), "first-line",
566 GINT_TO_POINTER (first_line));
567 gtk_tree_view_set_model (*tree_view, model);
568 g_object_unref (model);
570 add_line_number_column (ia, *tree_view);
574 render_line_number (GtkTreeViewColumn *tree_column,
575 GtkCellRenderer *cell,
576 GtkTreeModel *tree_model,
580 gint row = empty_list_store_iter_to_row (iter);
581 char s[INT_BUFSIZE_BOUND (int)];
584 first_line = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_model),
586 sprintf (s, "%d", first_line + row);
587 g_object_set (cell, "text", s, NULL);
591 add_line_number_column (const struct import_assistant *ia,
592 GtkTreeView *treeview)
594 GtkTreeViewColumn *column;
596 column = gtk_tree_view_column_new_with_attributes (
597 _("Line"), ia->asst.prop_renderer, (void *) NULL);
598 gtk_tree_view_column_set_sizing (column, GTK_TREE_VIEW_COLUMN_FIXED);
599 gtk_tree_view_column_set_fixed_width (
600 column, get_monospace_width (treeview, ia->asst.prop_renderer, 5));
601 gtk_tree_view_column_set_resizable (column, TRUE);
602 gtk_tree_view_column_set_cell_data_func (column, ia->asst.prop_renderer,
603 render_line_number, NULL, NULL);
604 gtk_tree_view_append_column (treeview, column);
608 get_monospace_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
615 ds_put_byte_multiple (&s, '0', char_cnt);
616 ds_put_byte (&s, ' ');
617 width = get_string_width (treeview, renderer, ds_cstr (&s));
624 get_string_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
628 g_object_set (G_OBJECT (renderer), "text", string, (void *) NULL);
629 gtk_cell_renderer_get_size (renderer, GTK_WIDGET (treeview),
630 NULL, NULL, NULL, &width, NULL);
635 make_data_column (struct import_assistant *ia, GtkTreeView *tree_view,
636 bool input, gint dict_idx)
638 struct variable *var = NULL;
639 struct column *column = NULL;
641 gint content_width, header_width;
642 GtkTreeViewColumn *tree_column;
646 column = &ia->separators->columns[dict_idx];
648 var = dict_get_var (ia->formats->dict, dict_idx);
650 name = escape_underscores (input ? column->name : var_get_name (var));
651 char_cnt = input ? column->width : var_get_print_format (var)->w;
652 content_width = get_monospace_width (tree_view, ia->asst.fixed_renderer,
654 header_width = get_string_width (tree_view, ia->asst.prop_renderer,
657 tree_column = gtk_tree_view_column_new ();
658 g_object_set_data (G_OBJECT (tree_column), "column-number",
659 GINT_TO_POINTER (dict_idx));
660 gtk_tree_view_column_set_title (tree_column, name);
661 gtk_tree_view_column_pack_start (tree_column, ia->asst.fixed_renderer,
663 gtk_tree_view_column_set_cell_data_func (
664 tree_column, ia->asst.fixed_renderer,
665 input ? render_input_cell : render_output_cell, ia, NULL);
666 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_FIXED);
667 gtk_tree_view_column_set_fixed_width (tree_column, MAX (content_width,
676 create_data_tree_view (bool input, GtkContainer *parent,
677 struct import_assistant *ia)
679 GtkTreeView *tree_view;
682 make_tree_view (ia, ia->first_line->skip_lines, &tree_view);
683 gtk_tree_selection_set_mode (gtk_tree_view_get_selection (tree_view),
686 for (i = 0; i < ia->separators->column_cnt; i++)
687 gtk_tree_view_append_column (tree_view,
688 make_data_column (ia, tree_view, input, i));
690 g_object_set (G_OBJECT (tree_view), "has-tooltip", TRUE, (void *) NULL);
691 g_signal_connect (tree_view, "query-tooltip",
692 G_CALLBACK (input ? on_query_input_tooltip
693 : on_query_output_tooltip), ia);
694 gtk_tree_view_set_fixed_height_mode (tree_view, true);
696 gtk_container_add (parent, GTK_WIDGET (tree_view));
697 gtk_widget_show (GTK_WIDGET (tree_view));
702 /* Increments the "watch cursor" level, setting the cursor for
703 the assistant window to a watch face to indicate to the user
704 that the ongoing operation may take some time. */
706 push_watch_cursor (struct import_assistant *ia)
708 if (++ia->asst.watch_cursor == 1)
710 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
711 GdkDisplay *display = gtk_widget_get_display (widget);
712 GdkCursor *cursor = gdk_cursor_new_for_display (display, GDK_WATCH);
713 gdk_window_set_cursor (widget->window, cursor);
714 gdk_cursor_unref (cursor);
715 gdk_display_flush (display);
719 /* Decrements the "watch cursor" level. If the level reaches
720 zero, the cursor is reset to its default shape. */
722 pop_watch_cursor (struct import_assistant *ia)
724 if (--ia->asst.watch_cursor == 0)
726 GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
727 gdk_window_set_cursor (widget->window, NULL);