Merge remote branch 'origin/master' into import-gui
[pspp] / src / ui / gui / text-data-import-dialog.c
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyright (C) 2008, 2009, 2010, 2011, 2012, 2013  Free Software Foundation
3
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.
8
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.
13
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/>. */
16
17 #include <config.h>
18
19 #include "ui/gui/text-data-import-dialog.h"
20
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"
26
27 #include <errno.h>
28 #include <fcntl.h>
29 #include <gtk-contrib/psppire-sheet.h>
30 #include <gtk/gtk.h>
31 #include <limits.h>
32 #include <stdlib.h>
33 #include <sys/stat.h>
34
35 #include "data/data-in.h"
36 #include "data/data-out.h"
37 #include "data/format-guesser.h"
38 #include "data/value-labels.h"
39 #include "language/data-io/data-parser.h"
40 #include "language/lexer/lexer.h"
41 #include "libpspp/assertion.h"
42 #include "libpspp/i18n.h"
43 #include "libpspp/line-reader.h"
44 #include "libpspp/message.h"
45 #include "ui/gui/checkbox-treeview.h"
46 #include "ui/gui/dialog-common.h"
47 #include "ui/gui/executor.h"
48 #include "ui/gui/helper.h"
49 #include "ui/gui/builder-wrapper.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-var-store.h"
56 #include "ui/gui/psppire-scanf.h"
57 #include "ui/syntax-gen.h"
58
59 #include "gl/error.h"
60 #include "gl/intprops.h"
61 #include "gl/xalloc.h"
62
63 #include "gettext.h"
64 #define _(msgid) gettext (msgid)
65 #define N_(msgid) msgid
66
67 struct import_assistant;
68
69 static void apply_dict (const struct dictionary *, struct string *);
70 static char *generate_syntax (const struct import_assistant *);
71
72 static void add_line_number_column (const struct import_assistant *,
73                                     GtkTreeView *);
74
75 /* Pops up the Text Data Import assistant. */
76 void
77 text_data_import_assistant (PsppireDataWindow *dw)
78 {
79   GtkWindow *parent_window = GTK_WINDOW (dw);
80   struct import_assistant *ia = init_assistant (parent_window);
81   struct sheet_spec_page *ssp ;
82
83   if (!init_file (ia, parent_window))
84     {
85       free (ia);
86       return;
87     }
88
89   ssp = ia->sheet_spec;
90
91   if (ia->spreadsheet)
92     {
93       ia->sheet_spec = sheet_spec_page_create (ia);
94     }
95   else
96     {
97       ia->intro = intro_page_create (ia);
98       ia->first_line = first_line_page_create (ia);
99       ia->separators = separators_page_create (ia);
100     }
101   ia->formats = formats_page_create (ia);
102
103   gtk_widget_show_all (GTK_WIDGET (ia->asst.assistant));
104
105   ia->asst.main_loop = g_main_loop_new (NULL, false);
106
107   {  
108   /*
109     Instead of this block,
110     A simple     g_main_loop_run (ia->asst.main_loop);  should work here.  But it seems to crash.
111     I have no idea why.
112   */
113     GMainContext *ctx = g_main_loop_get_context (ia->asst.main_loop);
114     ia->asst.loop_done = false;
115     while (! ia->asst.loop_done)
116       {
117         g_main_context_iteration (ctx, TRUE);
118       }
119   }
120   g_main_loop_unref (ia->asst.main_loop);
121
122   switch (ia->asst.response)
123     {
124     case GTK_RESPONSE_APPLY:
125       free (execute_syntax_string (dw, generate_syntax (ia)));
126       break;
127     case PSPPIRE_RESPONSE_PASTE:
128       free (paste_syntax_to_window (generate_syntax (ia)));
129       break;
130     default:
131       break;
132     }
133
134   if (ssp) 
135     {
136       destroy_formats_page (ia);
137       destroy_separators_page (ia);
138     }
139
140   destroy_assistant (ia);
141   destroy_file (ia);
142   free (ia);
143 }
144
145 /* Emits PSPP syntax to S that applies the dictionary attributes
146    (such as missing values and value labels) of the variables in
147    DICT.  */
148 static void
149 apply_dict (const struct dictionary *dict, struct string *s)
150 {
151   size_t var_cnt = dict_get_var_cnt (dict);
152   size_t i;
153
154   for (i = 0; i < var_cnt; i++)
155     {
156       struct variable *var = dict_get_var (dict, i);
157       const char *name = var_get_name (var);
158       enum val_type type = var_get_type (var);
159       int width = var_get_width (var);
160       enum measure measure = var_get_measure (var);
161       enum alignment alignment = var_get_alignment (var);
162       const struct fmt_spec *format = var_get_print_format (var);
163
164       if (var_has_missing_values (var))
165         {
166           const struct missing_values *mv = var_get_missing_values (var);
167           size_t j;
168
169           syntax_gen_pspp (s, "MISSING VALUES %ss (", name);
170           for (j = 0; j < mv_n_values (mv); j++)
171             {
172               if (j)
173                 ds_put_cstr (s, ", ");
174               syntax_gen_value (s, mv_get_value (mv, j), width, format);
175             }
176
177           if (mv_has_range (mv))
178             {
179               double low, high;
180               if (mv_has_value (mv))
181                 ds_put_cstr (s, ", ");
182               mv_get_range (mv, &low, &high);
183               syntax_gen_num_range (s, low, high, format);
184             }
185           ds_put_cstr (s, ").\n");
186         }
187       if (var_has_value_labels (var))
188         {
189           const struct val_labs *vls = var_get_value_labels (var);
190           const struct val_lab **labels = val_labs_sorted (vls);
191           size_t n_labels = val_labs_count (vls);
192           size_t i;
193
194           syntax_gen_pspp (s, "VALUE LABELS %ss", name);
195           for (i = 0; i < n_labels; i++)
196             {
197               const struct val_lab *vl = labels[i];
198               ds_put_cstr (s, "\n  ");
199               syntax_gen_value (s, &vl->value, width, format);
200               ds_put_byte (s, ' ');
201               syntax_gen_string (s, ss_cstr (val_lab_get_escaped_label (vl)));
202             }
203           free (labels);
204           ds_put_cstr (s, ".\n");
205         }
206       if (var_has_label (var))
207         syntax_gen_pspp (s, "VARIABLE LABELS %ss %sq.\n",
208                          name, var_get_label (var));
209       if (measure != var_default_measure (type))
210         syntax_gen_pspp (s, "VARIABLE LEVEL %ss (%ss).\n",
211                          name,
212                          (measure == MEASURE_NOMINAL ? "NOMINAL"
213                           : measure == MEASURE_ORDINAL ? "ORDINAL"
214                           : "SCALE"));
215       if (alignment != var_default_alignment (type))
216         syntax_gen_pspp (s, "VARIABLE ALIGNMENT %ss (%ss).\n",
217                          name,
218                          (alignment == ALIGN_LEFT ? "LEFT"
219                           : alignment == ALIGN_CENTRE ? "CENTER"
220                           : "RIGHT"));
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));
224     }
225 }
226
227 /* Generates and returns PSPP syntax to execute the import
228    operation described by IA.  The caller must free the syntax
229    with free(). */
230 static char *
231 generate_syntax (const struct import_assistant *ia)
232 {
233   struct string s = DS_EMPTY_INITIALIZER;
234
235   if (ia->spreadsheet == NULL)
236     {
237       syntax_gen_pspp (&s,
238                        "GET DATA"
239                        "\n  /TYPE=TXT"
240                        "\n  /FILE=%sq\n",
241                        ia->file.file_name);
242       if (ia->file.encoding && strcmp (ia->file.encoding, "Auto"))
243         syntax_gen_pspp (&s, "  /ENCODING=%sq\n", ia->file.encoding);
244
245       intro_append_syntax (ia->intro, &s);
246
247
248       ds_put_cstr (&s,
249                    "  /ARRANGEMENT=DELIMITED\n"
250                    "  /DELCASE=LINE\n");
251
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);
256     }
257   else
258     {
259       return sheet_spec_gen_syntax (ia);
260     }
261   
262   return ds_cstr (&s);
263 }
264
265
266
267 static void render_input_cell (GtkTreeViewColumn *tree_column,
268                                GtkCellRenderer *cell,
269                                GtkTreeModel *model, GtkTreeIter *iter,
270                                gpointer ia);
271
272 static gboolean on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
273                                         gboolean keyboard_mode UNUSED,
274                                         GtkTooltip *tooltip,
275                                         struct import_assistant *);
276
277
278
279 /* Called to render one of the cells in the fields preview tree
280    view. */
281 static void
282 render_input_cell (GtkTreeViewColumn *tree_column, GtkCellRenderer *cell,
283                    GtkTreeModel *model, GtkTreeIter *iter,
284                    gpointer ia_)
285 {
286   struct import_assistant *ia = ia_;
287   struct substring field;
288   size_t row;
289   gint column;
290
291   column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
292                                                "column-number"));
293   row = empty_list_store_iter_to_row (iter) + ia->skip_lines;
294   field = ia->columns[column].contents[row];
295   if (field.string != NULL)
296     {
297       GValue text = {0, };
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);
303     }
304   else
305     g_object_set (cell,
306                   "text", "",
307                   "background", "red",
308                   "background-set", TRUE,
309                   (void *) NULL);
310 }
311
312 static gboolean
313 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
314                       const struct import_assistant *ia,
315                       size_t *row, size_t *column);
316
317
318 /* Called to render a tooltip on one of the cells in the fields
319    preview tree view. */
320 static gboolean
321 on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
322                         gboolean keyboard_mode UNUSED,
323                         GtkTooltip *tooltip, struct import_assistant *ia)
324 {
325   size_t row, column;
326
327   if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
328     return FALSE;
329
330   if (ia->columns[column].contents[row].string != NULL)
331     return FALSE;
332
333   gtk_tooltip_set_text (tooltip,
334                         _("This input line has too few separators "
335                           "to fill in this field."));
336   return TRUE;
337 }
338
339
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. */
347 static bool
348 parse_field (struct import_assistant *ia,
349              size_t row, size_t column,
350              char **outputp, char **tooltipp)
351 {
352   const struct fmt_spec *in;
353   struct fmt_spec out;
354   char *tooltip;
355   bool ok;
356
357   struct substring field = ia->columns[column].contents[row];
358   struct variable *var = dict_get_var (ia->dict, column);
359   union value val;
360
361   value_init (&val, var_get_width (var));
362   in = var_get_print_format (var);
363   out = fmt_for_output_from_input (in);
364   tooltip = NULL;
365   if (field.string != NULL)
366     {
367       char *error;
368
369       error = data_in (field, "UTF-8", in->type, &val, var_get_width (var),
370                        dict_get_encoding (ia->dict));
371       if (error != NULL)
372         {
373           tooltip = xasprintf (_("Cannot parse field content `%.*s' as "
374                                  "format %s: %s"),
375                                (int) field.length, field.string,
376                                fmt_name (in->type), error);
377           free (error);
378         }
379     }
380   else
381     {
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));
385     }
386   if (outputp != NULL)
387     {
388       *outputp = data_out (&val, dict_get_encoding (ia->dict),  &out);
389     }
390   value_destroy (&val, var_get_width (var));
391
392   ok = tooltip == NULL;
393   if (tooltipp != NULL)
394     *tooltipp = tooltip;
395   else
396     free (tooltip);
397   return ok;
398 }
399
400 /* Called to render one of the cells in the data preview tree
401    view. */
402 static void
403 render_output_cell (GtkTreeViewColumn *tree_column,
404                     GtkCellRenderer *cell,
405                     GtkTreeModel *model,
406                     GtkTreeIter *iter,
407                     gpointer ia_)
408 {
409   struct import_assistant *ia = ia_;
410   char *output;
411   GValue gvalue = { 0, };
412   bool ok;
413
414   ok = parse_field (ia,
415                     (empty_list_store_iter_to_row (iter)
416                      + ia->skip_lines),
417                     GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
418                                                         "column-number")),
419                     &output, NULL);
420
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);
425
426   if (ok)
427     g_object_set (cell, "background-set", FALSE, (void *) NULL);
428   else
429     g_object_set (cell,
430                   "background", "red",
431                   "background-set", TRUE,
432                   (void *) NULL);
433 }
434
435 /* Called to render a tooltip for one of the cells in the data
436    preview tree view. */
437 static gboolean
438 on_query_output_tooltip (GtkWidget *widget, gint wx, gint wy,
439                          gboolean keyboard_mode UNUSED,
440                          GtkTooltip *tooltip, struct import_assistant *ia)
441 {
442   size_t row, column;
443   char *text;
444
445   if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
446     return FALSE;
447
448   if (parse_field (ia, row, column, NULL, &text))
449     return FALSE;
450
451   gtk_tooltip_set_text (tooltip, text);
452   free (text);
453   return TRUE;
454 }
455 \f
456 /* Utility functions used by multiple pages of the assistant. */
457
458 static gboolean
459 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
460                       const struct import_assistant *ia,
461                       size_t *row, size_t *column)
462 {
463   GtkTreeView *tree_view = GTK_TREE_VIEW (widget);
464   gint bx, by;
465   GtkTreePath *path;
466   GtkTreeIter iter;
467   GtkTreeViewColumn *tree_column;
468   GtkTreeModel *tree_model;
469   bool ok;
470
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))
482     return FALSE;
483
484   gtk_tree_view_convert_widget_to_bin_window_coords (tree_view,
485                                                      wx, wy, &bx, &by);
486   if (!gtk_tree_view_get_path_at_pos (tree_view, bx, by,
487                                       &path, &tree_column, NULL, NULL))
488     return FALSE;
489
490   *column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
491                                                 "column-number"));
492
493   tree_model = gtk_tree_view_get_model (tree_view);
494   ok = gtk_tree_model_get_iter (tree_model, &iter, path);
495   gtk_tree_path_free (path);
496   if (!ok)
497     return FALSE;
498
499   *row = empty_list_store_iter_to_row (&iter) + ia->skip_lines;
500   return TRUE;
501 }
502
503 void
504 make_tree_view (const struct import_assistant *ia,
505                 size_t first_line,
506                 GtkTreeView **tree_view)
507 {
508   GtkTreeModel *model;
509
510   *tree_view = GTK_TREE_VIEW (gtk_tree_view_new ());
511   model = GTK_TREE_MODEL (psppire_empty_list_store_new (
512                                                         ia->file.line_cnt - first_line));
513   g_object_set_data (G_OBJECT (model), "lines", ia->file.lines + first_line);
514   g_object_set_data (G_OBJECT (model), "first-line",
515                      GINT_TO_POINTER (first_line));
516   gtk_tree_view_set_model (*tree_view, model);
517   g_object_unref (model);
518
519   add_line_number_column (ia, *tree_view);
520 }
521
522 static void
523 render_line_number (GtkTreeViewColumn *tree_column,
524                     GtkCellRenderer *cell,
525                     GtkTreeModel *tree_model,
526                     GtkTreeIter *iter,
527                     gpointer data)
528 {
529   gint row = empty_list_store_iter_to_row (iter);
530   char s[INT_BUFSIZE_BOUND (int)];
531   int first_line;
532
533   first_line = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_model),
534                                                    "first-line"));
535   sprintf (s, "%d", first_line + row);
536   g_object_set (cell, "text", s, NULL);
537 }
538
539 static void
540 add_line_number_column (const struct import_assistant *ia,
541                         GtkTreeView *treeview)
542 {
543   GtkTreeViewColumn *column;
544
545   column = gtk_tree_view_column_new_with_attributes (
546                                                      _("Line"), ia->asst.prop_renderer, (void *) NULL);
547   gtk_tree_view_column_set_sizing (column, GTK_TREE_VIEW_COLUMN_FIXED);
548   gtk_tree_view_column_set_fixed_width (
549                                         column, get_monospace_width (treeview, ia->asst.prop_renderer, 5));
550   gtk_tree_view_column_set_resizable (column, TRUE);
551   gtk_tree_view_column_set_cell_data_func (column, ia->asst.prop_renderer,
552                                            render_line_number, NULL, NULL);
553   gtk_tree_view_append_column (treeview, column);
554 }
555
556 gint
557 get_monospace_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
558                      size_t char_cnt)
559 {
560   struct string s;
561   gint width;
562
563   ds_init_empty (&s);
564   ds_put_byte_multiple (&s, '0', char_cnt);
565   ds_put_byte (&s, ' ');
566   width = get_string_width (treeview, renderer, ds_cstr (&s));
567   ds_destroy (&s);
568
569   return width;
570 }
571
572 gint
573 get_string_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
574                   const char *string)
575 {
576   gint width;
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);
580   return width;
581 }
582
583 GtkTreeViewColumn *
584 make_data_column (struct import_assistant *ia, GtkTreeView *tree_view,
585                   bool input, gint dict_idx)
586 {
587   struct variable *var = NULL;
588   struct column *column = NULL;
589   size_t char_cnt;
590   gint content_width, header_width;
591   GtkTreeViewColumn *tree_column;
592   char *name;
593
594   if (input)
595     column = &ia->columns[dict_idx];
596   else
597     var = dict_get_var (ia->dict, dict_idx);
598
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,
602                                        char_cnt);
603   header_width = get_string_width (tree_view, ia->asst.prop_renderer,
604                                    name);
605
606   tree_column = gtk_tree_view_column_new ();
607   g_object_set_data (G_OBJECT (tree_column), "column-number",
608                      GINT_TO_POINTER (dict_idx));
609   gtk_tree_view_column_set_title (tree_column, name);
610   gtk_tree_view_column_pack_start (tree_column, ia->asst.fixed_renderer,
611                                    FALSE);
612   gtk_tree_view_column_set_cell_data_func (
613                                            tree_column, ia->asst.fixed_renderer,
614                                            input ? render_input_cell : render_output_cell, ia, NULL);
615   gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_FIXED);
616   gtk_tree_view_column_set_fixed_width (tree_column, MAX (content_width,
617                                                           header_width));
618
619   free (name);
620
621   return tree_column;
622 }
623
624 GtkTreeView *
625 create_data_tree_view (bool input, GtkContainer *parent,
626                        struct import_assistant *ia)
627 {
628   GtkTreeView *tree_view;
629   gint i;
630
631   make_tree_view (ia, ia->skip_lines, &tree_view);
632   gtk_tree_selection_set_mode (gtk_tree_view_get_selection (tree_view),
633                                GTK_SELECTION_NONE);
634
635   for (i = 0; i < ia->column_cnt; i++)
636     gtk_tree_view_append_column (tree_view,
637                                  make_data_column (ia, tree_view, input, i));
638
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);
643   gtk_tree_view_set_fixed_height_mode (tree_view, true);
644
645   gtk_container_add (parent, GTK_WIDGET (tree_view));
646   gtk_widget_show (GTK_WIDGET (tree_view));
647
648   return tree_view;
649 }
650
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. */
654 void
655 push_watch_cursor (struct import_assistant *ia)
656 {
657   if (++ia->asst.watch_cursor == 1)
658     {
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);
665     }
666 }
667
668 /* Decrements the "watch cursor" level.  If the level reaches
669    zero, the cursor is reset to its default shape. */
670 void
671 pop_watch_cursor (struct import_assistant *ia)
672 {
673   if (--ia->asst.watch_cursor == 0)
674     {
675       GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
676       gdk_window_set_cursor (widget->window, NULL);
677     }
678 }