Merge branch '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->separators = separators_page_create (ia);
99       ia->first_line = first_line_page_create (ia);
100
101       printf ("%s:%d %p\n", __FILE__, __LINE__, ia->intro);
102     }
103   ia->formats = formats_page_create (ia);
104
105   gtk_widget_show_all (GTK_WIDGET (ia->asst.assistant));
106
107   ia->asst.main_loop = g_main_loop_new (NULL, false);
108
109   {  
110   /*
111     Instead of this block,
112     A simple     g_main_loop_run (ia->asst.main_loop);  should work here.  But it seems to crash.
113     I have no idea why.
114   */
115     GMainContext *ctx = g_main_loop_get_context (ia->asst.main_loop);
116     ia->asst.loop_done = false;
117     while (! ia->asst.loop_done)
118       {
119         g_main_context_iteration (ctx, TRUE);
120       }
121   }
122   g_main_loop_unref (ia->asst.main_loop);
123
124   switch (ia->asst.response)
125     {
126     case GTK_RESPONSE_APPLY:
127       free (execute_syntax_string (dw, generate_syntax (ia)));
128       break;
129     case PSPPIRE_RESPONSE_PASTE:
130       free (paste_syntax_to_window (generate_syntax (ia)));
131       break;
132     default:
133       break;
134     }
135
136   if (ssp) 
137     {
138       destroy_formats_page (ia);
139       destroy_separators_page (ia);
140     }
141
142   destroy_assistant (ia);
143   destroy_file (ia);
144   free (ia);
145 }
146
147 /* Emits PSPP syntax to S that applies the dictionary attributes
148    (such as missing values and value labels) of the variables in
149    DICT.  */
150 static void
151 apply_dict (const struct dictionary *dict, struct string *s)
152 {
153   size_t var_cnt = dict_get_var_cnt (dict);
154   size_t i;
155
156   for (i = 0; i < var_cnt; i++)
157     {
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 alignment alignment = var_get_alignment (var);
164       const struct fmt_spec *format = var_get_print_format (var);
165
166       if (var_has_missing_values (var))
167         {
168           const struct missing_values *mv = var_get_missing_values (var);
169           size_t j;
170
171           syntax_gen_pspp (s, "MISSING VALUES %ss (", name);
172           for (j = 0; j < mv_n_values (mv); j++)
173             {
174               if (j)
175                 ds_put_cstr (s, ", ");
176               syntax_gen_value (s, mv_get_value (mv, j), width, format);
177             }
178
179           if (mv_has_range (mv))
180             {
181               double low, high;
182               if (mv_has_value (mv))
183                 ds_put_cstr (s, ", ");
184               mv_get_range (mv, &low, &high);
185               syntax_gen_num_range (s, low, high, format);
186             }
187           ds_put_cstr (s, ").\n");
188         }
189       if (var_has_value_labels (var))
190         {
191           const struct val_labs *vls = var_get_value_labels (var);
192           const struct val_lab **labels = val_labs_sorted (vls);
193           size_t n_labels = val_labs_count (vls);
194           size_t i;
195
196           syntax_gen_pspp (s, "VALUE LABELS %ss", name);
197           for (i = 0; i < n_labels; i++)
198             {
199               const struct val_lab *vl = labels[i];
200               ds_put_cstr (s, "\n  ");
201               syntax_gen_value (s, &vl->value, width, format);
202               ds_put_byte (s, ' ');
203               syntax_gen_string (s, ss_cstr (val_lab_get_escaped_label (vl)));
204             }
205           free (labels);
206           ds_put_cstr (s, ".\n");
207         }
208       if (var_has_label (var))
209         syntax_gen_pspp (s, "VARIABLE LABELS %ss %sq.\n",
210                          name, var_get_label (var));
211       if (measure != var_default_measure (type))
212         syntax_gen_pspp (s, "VARIABLE LEVEL %ss (%ss).\n",
213                          name,
214                          (measure == MEASURE_NOMINAL ? "NOMINAL"
215                           : measure == MEASURE_ORDINAL ? "ORDINAL"
216                           : "SCALE"));
217       if (alignment != var_default_alignment (type))
218         syntax_gen_pspp (s, "VARIABLE ALIGNMENT %ss (%ss).\n",
219                          name,
220                          (alignment == ALIGN_LEFT ? "LEFT"
221                           : alignment == ALIGN_CENTRE ? "CENTER"
222                           : "RIGHT"));
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));
226     }
227 }
228
229 /* Generates and returns PSPP syntax to execute the import
230    operation described by IA.  The caller must free the syntax
231    with free(). */
232 static char *
233 generate_syntax (const struct import_assistant *ia)
234 {
235   struct string s = DS_EMPTY_INITIALIZER;
236
237   if (ia->spreadsheet == NULL)
238     {
239       syntax_gen_pspp (&s,
240                        "GET DATA"
241                        "\n  /TYPE=TXT"
242                        "\n  /FILE=%sq\n",
243                        ia->file.file_name);
244       if (ia->file.encoding && strcmp (ia->file.encoding, "Auto"))
245         syntax_gen_pspp (&s, "  /ENCODING=%sq\n", ia->file.encoding);
246
247
248       intro_append_syntax (ia->intro, &s);
249
250
251       ds_put_cstr (&s,
252                    "  /ARRANGEMENT=DELIMITED\n"
253                    "  /DELCASE=LINE\n");
254
255       first_line_append_syntax (ia, &s);
256       separators_append_syntax (ia, &s);
257       formats_append_syntax (ia, &s);
258       apply_dict (ia->dict, &s);
259     }
260   else
261     {
262       return sheet_spec_gen_syntax (ia);
263     }
264
265   return ds_cstr (&s);
266 }
267
268
269
270 static void render_input_cell (GtkTreeViewColumn *tree_column,
271                                GtkCellRenderer *cell,
272                                GtkTreeModel *model, GtkTreeIter *iter,
273                                gpointer ia);
274
275 static gboolean on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
276                                         gboolean keyboard_mode UNUSED,
277                                         GtkTooltip *tooltip,
278                                         struct import_assistant *);
279
280
281
282 /* Called to render one of the cells in the fields preview tree
283    view. */
284 static void
285 render_input_cell (GtkTreeViewColumn *tree_column, GtkCellRenderer *cell,
286                    GtkTreeModel *model, GtkTreeIter *iter,
287                    gpointer ia_)
288 {
289   struct import_assistant *ia = ia_;
290   struct substring field;
291   size_t row;
292   gint column;
293
294   column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
295                                                "column-number"));
296   row = empty_list_store_iter_to_row (iter) + ia->skip_lines;
297   field = ia->columns[column].contents[row];
298   if (field.string != NULL)
299     {
300       GValue text = {0, };
301       g_value_init (&text, G_TYPE_STRING);
302       g_value_take_string (&text, ss_xstrdup (field));
303       g_object_set_property (G_OBJECT (cell), "text", &text);
304       g_value_unset (&text);
305       g_object_set (cell, "background-set", FALSE, (void *) NULL);
306     }
307   else
308     g_object_set (cell,
309                   "text", "",
310                   "background", "red",
311                   "background-set", TRUE,
312                   (void *) NULL);
313 }
314
315 static gboolean
316 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
317                       const struct import_assistant *ia,
318                       size_t *row, size_t *column);
319
320
321 /* Called to render a tooltip on one of the cells in the fields
322    preview tree view. */
323 static gboolean
324 on_query_input_tooltip (GtkWidget *widget, gint wx, gint wy,
325                         gboolean keyboard_mode UNUSED,
326                         GtkTooltip *tooltip, struct import_assistant *ia)
327 {
328   size_t row, column;
329
330   if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
331     return FALSE;
332
333   if (ia->columns[column].contents[row].string != NULL)
334     return FALSE;
335
336   gtk_tooltip_set_text (tooltip,
337                         _("This input line has too few separators "
338                           "to fill in this field."));
339   return TRUE;
340 }
341
342
343 /* Parses the contents of the field at (ROW,COLUMN) according to
344    its variable format.  If OUTPUTP is non-null, then *OUTPUTP
345    receives the formatted output for that field (which must be
346    freed with free).  If TOOLTIPP is non-null, then *TOOLTIPP
347    receives a message suitable for use in a tooltip, if one is
348    needed, or a null pointer otherwise.  Returns true if a
349    tooltip message is needed, otherwise false. */
350 static bool
351 parse_field (struct import_assistant *ia,
352              size_t row, size_t column,
353              char **outputp, char **tooltipp)
354 {
355   const struct fmt_spec *in;
356   struct fmt_spec out;
357   char *tooltip;
358   bool ok;
359
360   struct substring field = ia->columns[column].contents[row];
361   struct variable *var = dict_get_var (ia->dict, column);
362   union value val;
363
364   value_init (&val, var_get_width (var));
365   in = var_get_print_format (var);
366   out = fmt_for_output_from_input (in);
367   tooltip = NULL;
368   if (field.string != NULL)
369     {
370       char *error;
371
372       error = data_in (field, "UTF-8", in->type, &val, var_get_width (var),
373                        dict_get_encoding (ia->dict));
374       if (error != NULL)
375         {
376           tooltip = xasprintf (_("Cannot parse field content `%.*s' as "
377                                  "format %s: %s"),
378                                (int) field.length, field.string,
379                                fmt_name (in->type), error);
380           free (error);
381         }
382     }
383   else
384     {
385       tooltip = xstrdup (_("This input line has too few separators "
386                            "to fill in this field."));
387       value_set_missing (&val, var_get_width (var));
388     }
389   if (outputp != NULL)
390     {
391       *outputp = data_out (&val, dict_get_encoding (ia->dict),  &out);
392     }
393   value_destroy (&val, var_get_width (var));
394
395   ok = tooltip == NULL;
396   if (tooltipp != NULL)
397     *tooltipp = tooltip;
398   else
399     free (tooltip);
400   return ok;
401 }
402
403 /* Called to render one of the cells in the data preview tree
404    view. */
405 static void
406 render_output_cell (GtkTreeViewColumn *tree_column,
407                     GtkCellRenderer *cell,
408                     GtkTreeModel *model,
409                     GtkTreeIter *iter,
410                     gpointer ia_)
411 {
412   struct import_assistant *ia = ia_;
413   char *output;
414   GValue gvalue = { 0, };
415   bool ok;
416
417   ok = parse_field (ia,
418                     (empty_list_store_iter_to_row (iter)
419                      + ia->skip_lines),
420                     GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
421                                                         "column-number")),
422                     &output, NULL);
423
424   g_value_init (&gvalue, G_TYPE_STRING);
425   g_value_take_string (&gvalue, output);
426   g_object_set_property (G_OBJECT (cell), "text", &gvalue);
427   g_value_unset (&gvalue);
428
429   if (ok)
430     g_object_set (cell, "background-set", FALSE, (void *) NULL);
431   else
432     g_object_set (cell,
433                   "background", "red",
434                   "background-set", TRUE,
435                   (void *) NULL);
436 }
437
438 /* Called to render a tooltip for one of the cells in the data
439    preview tree view. */
440 static gboolean
441 on_query_output_tooltip (GtkWidget *widget, gint wx, gint wy,
442                          gboolean keyboard_mode UNUSED,
443                          GtkTooltip *tooltip, struct import_assistant *ia)
444 {
445   size_t row, column;
446   char *text;
447
448   if (!get_tooltip_location (widget, wx, wy, ia, &row, &column))
449     return FALSE;
450
451   if (parse_field (ia, row, column, NULL, &text))
452     return FALSE;
453
454   gtk_tooltip_set_text (tooltip, text);
455   free (text);
456   return TRUE;
457 }
458 \f
459 /* Utility functions used by multiple pages of the assistant. */
460
461 static gboolean
462 get_tooltip_location (GtkWidget *widget, gint wx, gint wy,
463                       const struct import_assistant *ia,
464                       size_t *row, size_t *column)
465 {
466   GtkTreeView *tree_view = GTK_TREE_VIEW (widget);
467   gint bx, by;
468   GtkTreePath *path;
469   GtkTreeIter iter;
470   GtkTreeViewColumn *tree_column;
471   GtkTreeModel *tree_model;
472   bool ok;
473
474   /* Check that WIDGET is really visible on the screen before we
475      do anything else.  This is a bug fix for a sticky situation:
476      when text_data_import_assistant() returns, it frees the data
477      necessary to compose the tool tip message, but there may be
478      a tool tip under preparation at that point (even if there is
479      no visible tool tip) that will call back into us a little
480      bit later.  Perhaps the correct solution to this problem is
481      to make the data related to the tool tips part of a GObject
482      that only gets destroyed when all references are released,
483      but this solution appears to be effective too. */
484   if (!gtk_widget_get_mapped (widget))
485     return FALSE;
486
487   gtk_tree_view_convert_widget_to_bin_window_coords (tree_view,
488                                                      wx, wy, &bx, &by);
489   if (!gtk_tree_view_get_path_at_pos (tree_view, bx, by,
490                                       &path, &tree_column, NULL, NULL))
491     return FALSE;
492
493   *column = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_column),
494                                                 "column-number"));
495
496   tree_model = gtk_tree_view_get_model (tree_view);
497   ok = gtk_tree_model_get_iter (tree_model, &iter, path);
498   gtk_tree_path_free (path);
499   if (!ok)
500     return FALSE;
501
502   *row = empty_list_store_iter_to_row (&iter) + ia->skip_lines;
503   return TRUE;
504 }
505
506 void
507 make_tree_view (const struct import_assistant *ia,
508                 size_t first_line,
509                 GtkTreeView **tree_view)
510 {
511   GtkTreeModel *model;
512
513   *tree_view = GTK_TREE_VIEW (gtk_tree_view_new ());
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   gtk_tree_view_set_model (*tree_view, model);
520   g_object_unref (model);
521
522   add_line_number_column (ia, *tree_view);
523 }
524
525 static void
526 render_line_number (GtkTreeViewColumn *tree_column,
527                     GtkCellRenderer *cell,
528                     GtkTreeModel *tree_model,
529                     GtkTreeIter *iter,
530                     gpointer data)
531 {
532   gint row = empty_list_store_iter_to_row (iter);
533   char s[INT_BUFSIZE_BOUND (int)];
534   int first_line;
535
536   first_line = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_model),
537                                                    "first-line"));
538   sprintf (s, "%d", first_line + row);
539   g_object_set (cell, "text", s, NULL);
540 }
541
542 static void
543 add_line_number_column (const struct import_assistant *ia,
544                         GtkTreeView *treeview)
545 {
546   GtkTreeViewColumn *column;
547
548   column = gtk_tree_view_column_new_with_attributes (
549                                                      _("Line"), ia->asst.prop_renderer, (void *) NULL);
550   gtk_tree_view_column_set_sizing (column, GTK_TREE_VIEW_COLUMN_FIXED);
551   gtk_tree_view_column_set_fixed_width (
552                                         column, get_monospace_width (treeview, ia->asst.prop_renderer, 5));
553   gtk_tree_view_column_set_resizable (column, TRUE);
554   gtk_tree_view_column_set_cell_data_func (column, ia->asst.prop_renderer,
555                                            render_line_number, NULL, NULL);
556   gtk_tree_view_append_column (treeview, column);
557 }
558
559 gint
560 get_monospace_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
561                      size_t char_cnt)
562 {
563   struct string s;
564   gint width;
565
566   ds_init_empty (&s);
567   ds_put_byte_multiple (&s, '0', char_cnt);
568   ds_put_byte (&s, ' ');
569   width = get_string_width (treeview, renderer, ds_cstr (&s));
570   ds_destroy (&s);
571
572   return width;
573 }
574
575 gint
576 get_string_width (GtkTreeView *treeview, GtkCellRenderer *renderer,
577                   const char *string)
578 {
579   gint width;
580   g_object_set (G_OBJECT (renderer), "text", string, (void *) NULL);
581   gtk_cell_renderer_get_size (renderer, GTK_WIDGET (treeview),
582                               NULL, NULL, NULL, &width, NULL);
583   return width;
584 }
585
586 GtkTreeViewColumn *
587 make_data_column (struct import_assistant *ia, GtkTreeView *tree_view,
588                   bool input, gint dict_idx)
589 {
590   struct variable *var = NULL;
591   struct column *column = NULL;
592   size_t char_cnt;
593   gint content_width, header_width;
594   GtkTreeViewColumn *tree_column;
595   char *name;
596
597   if (input)
598     column = &ia->columns[dict_idx];
599   else
600     var = dict_get_var (ia->dict, dict_idx);
601
602   name = escape_underscores (input ? column->name : var_get_name (var));
603   char_cnt = input ? column->width : var_get_print_format (var)->w;
604   content_width = get_monospace_width (tree_view, ia->asst.fixed_renderer,
605                                        char_cnt);
606   header_width = get_string_width (tree_view, ia->asst.prop_renderer,
607                                    name);
608
609   tree_column = gtk_tree_view_column_new ();
610   g_object_set_data (G_OBJECT (tree_column), "column-number",
611                      GINT_TO_POINTER (dict_idx));
612   gtk_tree_view_column_set_title (tree_column, name);
613   gtk_tree_view_column_pack_start (tree_column, ia->asst.fixed_renderer,
614                                    FALSE);
615   gtk_tree_view_column_set_cell_data_func (
616                                            tree_column, ia->asst.fixed_renderer,
617                                            input ? render_input_cell : render_output_cell, ia, NULL);
618   gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_FIXED);
619   gtk_tree_view_column_set_fixed_width (tree_column, MAX (content_width,
620                                                           header_width));
621
622   free (name);
623
624   return tree_column;
625 }
626
627 GtkTreeView *
628 create_data_tree_view (bool input, GtkContainer *parent,
629                        struct import_assistant *ia)
630 {
631   GtkTreeView *tree_view;
632   gint i;
633
634   make_tree_view (ia, ia->skip_lines, &tree_view);
635   gtk_tree_selection_set_mode (gtk_tree_view_get_selection (tree_view),
636                                GTK_SELECTION_NONE);
637
638   for (i = 0; i < ia->column_cnt; i++)
639     gtk_tree_view_append_column (tree_view,
640                                  make_data_column (ia, tree_view, input, i));
641
642   g_object_set (G_OBJECT (tree_view), "has-tooltip", TRUE, (void *) NULL);
643   g_signal_connect (tree_view, "query-tooltip",
644                     G_CALLBACK (input ? on_query_input_tooltip
645                                 : on_query_output_tooltip), ia);
646   gtk_tree_view_set_fixed_height_mode (tree_view, true);
647
648   gtk_container_add (parent, GTK_WIDGET (tree_view));
649   gtk_widget_show (GTK_WIDGET (tree_view));
650
651   return tree_view;
652 }
653
654 /* Increments the "watch cursor" level, setting the cursor for
655    the assistant window to a watch face to indicate to the user
656    that the ongoing operation may take some time. */
657 void
658 push_watch_cursor (struct import_assistant *ia)
659 {
660   if (++ia->asst.watch_cursor == 1)
661     {
662       GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
663       GdkDisplay *display = gtk_widget_get_display (widget);
664       GdkCursor *cursor = gdk_cursor_new_for_display (display, GDK_WATCH);
665       gdk_window_set_cursor (widget->window, cursor);
666       gdk_cursor_unref (cursor);
667       gdk_display_flush (display);
668     }
669 }
670
671 /* Decrements the "watch cursor" level.  If the level reaches
672    zero, the cursor is reset to its default shape. */
673 void
674 pop_watch_cursor (struct import_assistant *ia)
675 {
676   if (--ia->asst.watch_cursor == 0)
677     {
678       GtkWidget *widget = GTK_WIDGET (ia->asst.assistant);
679       gdk_window_set_cursor (widget->window, NULL);
680     }
681 }