PsppireDataEditor: focus the datum entry widget when F2 is pressed
[pspp] / src / ui / gui / psppire-data-editor.c
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyright (C) 2008, 2009, 2010, 2011, 2012, 2016,
3    2017 Free Software Foundation, Inc.
4
5    This program is free software: you can redistribute it and/or modify
6    it under the terms of the GNU General Public License as published by
7    the Free Software Foundation, either version 3 of the License, or
8    (at your option) any later version.
9
10    This program is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13    GNU General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
17
18 #include <config.h>
19
20 #include "ui/gui/psppire-data-editor.h"
21
22 #include <gtk/gtk.h>
23
24 #include "data/datasheet.h"
25 #include "data/value-labels.h"
26 #include "libpspp/range-set.h"
27 #include "libpspp/str.h"
28
29 #include "ui/gui/helper.h"
30 #include "ui/gui/var-display.h"
31 #include "ui/gui/val-labs-dialog.h"
32 #include "ui/gui/missing-val-dialog.h"
33 #include "ui/gui/var-type-dialog.h"
34 #include "ui/gui/psppire-dict.h"
35 #include "ui/gui/psppire-data-store.h"
36 #include "ui/gui/psppire-data-window.h"
37 #include "ui/gui/psppire-value-entry.h"
38 #include "ui/gui/psppire-conf.h"
39 #include "ui/gui/psppire-variable-sheet.h"
40 #include "ui/gui/psppire-data-sheet.h"
41
42
43 #include <ssw-sheet.h>
44
45 #include <gettext.h>
46 #define _(msgid) gettext (msgid)
47
48 static void psppire_data_editor_class_init          (PsppireDataEditorClass *klass);
49 static void psppire_data_editor_init                (PsppireDataEditor      *de);
50
51 static void refresh_entry (PsppireDataEditor *);
52
53 GType
54 psppire_data_editor_get_type (void)
55 {
56   static GType de_type = 0;
57
58   if (!de_type)
59     {
60       static const GTypeInfo de_info =
61       {
62         sizeof (PsppireDataEditorClass),
63         NULL, /* base_init */
64         NULL, /* base_finalize */
65         (GClassInitFunc) psppire_data_editor_class_init,
66         NULL, /* class_finalize */
67         NULL, /* class_data */
68         sizeof (PsppireDataEditor),
69         0,
70         (GInstanceInitFunc) psppire_data_editor_init,
71       };
72
73       de_type = g_type_register_static (GTK_TYPE_NOTEBOOK, "PsppireDataEditor",
74                                         &de_info, 0);
75     }
76
77   return de_type;
78 }
79
80 static GObjectClass * parent_class = NULL;
81
82 static void
83 psppire_data_editor_dispose (GObject *obj)
84 {
85   PsppireDataEditor *de = (PsppireDataEditor *) obj;
86
87   if (de->data_store)
88     {
89       g_object_unref (de->data_store);
90       de->data_store = NULL;
91     }
92
93   if (de->dict)
94     {
95       g_object_unref (de->dict);
96       de->dict = NULL;
97     }
98
99   if (de->font != NULL)
100     {
101       pango_font_description_free (de->font);
102       de->font = NULL;
103     }
104
105   /* Chain up to the parent class */
106   G_OBJECT_CLASS (parent_class)->dispose (obj);
107 }
108
109 enum
110   {
111     PROP_0,
112     PROP_DATA_STORE,
113     PROP_DICTIONARY,
114     PROP_VALUE_LABELS,
115     PROP_SPLIT_WINDOW
116   };
117
118 static void
119 psppire_data_editor_refresh_model (PsppireDataEditor *de)
120 {
121 }
122
123
124 static void
125 psppire_data_editor_set_property (GObject         *object,
126                                   guint            prop_id,
127                                   const GValue    *value,
128                                   GParamSpec      *pspec)
129 {
130   PsppireDataEditor *de = PSPPIRE_DATA_EDITOR (object);
131
132   switch (prop_id)
133     {
134     case PROP_SPLIT_WINDOW:
135       de->split = g_value_get_boolean (value);
136       g_object_set (de->data_sheet, "split", de->split, NULL);
137       g_object_set (de->var_sheet, "split", de->split, NULL);
138       break;
139     case PROP_DATA_STORE:
140       if ( de->data_store)
141         {
142           g_signal_handlers_disconnect_by_func (de->data_store,
143                                                 G_CALLBACK (refresh_entry),
144                                                 de);
145           g_object_unref (de->data_store);
146         }
147
148       de->data_store = g_value_get_pointer (value);
149       g_object_ref (de->data_store);
150
151       g_object_set (de->data_sheet, "data-model", de->data_store, NULL);
152       psppire_data_editor_refresh_model (de);
153
154       g_signal_connect_swapped (de->data_sheet, "selection-changed",
155                                 G_CALLBACK (refresh_entry),
156                                 de);
157
158       g_signal_connect_swapped (de->data_store, "case-changed",
159                                 G_CALLBACK (refresh_entry), de);
160
161       break;
162     case PROP_DICTIONARY:
163       if (de->dict)
164         g_object_unref (de->dict);
165       de->dict = g_value_get_pointer (value);
166       g_object_ref (de->dict);
167
168       g_object_set (de->var_sheet, "data-model", de->dict, NULL);
169       break;
170
171     case PROP_VALUE_LABELS:
172       {
173         gboolean l = g_value_get_boolean (value);
174         g_object_set (de->data_sheet, "forward-conversion",
175                       l ?
176                       psppire_data_store_value_to_string_with_labels :
177                       psppire_data_store_value_to_string,
178                       NULL);
179       }
180       break;
181
182     default:
183       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
184       break;
185     };
186 }
187
188 static void
189 psppire_data_editor_get_property (GObject         *object,
190                                   guint            prop_id,
191                                   GValue          *value,
192                                   GParamSpec      *pspec)
193 {
194   PsppireDataEditor *de = PSPPIRE_DATA_EDITOR (object);
195
196   switch (prop_id)
197     {
198     case PROP_SPLIT_WINDOW:
199       g_value_set_boolean (value, de->split);
200       break;
201     case PROP_DATA_STORE:
202       g_value_set_pointer (value, de->data_store);
203       break;
204     case PROP_DICTIONARY:
205       g_value_set_pointer (value, de->dict);
206       break;
207     case PROP_VALUE_LABELS:
208       break;
209     default:
210       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
211       break;
212     }
213 }
214
215 static void
216 psppire_data_editor_switch_page (GtkNotebook     *notebook,
217                                  GtkWidget *w,
218                                  guint            page_num)
219 {
220   GTK_NOTEBOOK_CLASS (parent_class)->switch_page (notebook, w, page_num);
221 }
222
223 static void
224 psppire_data_editor_set_focus_child (GtkContainer *container,
225                                      GtkWidget    *widget)
226 {
227   GTK_CONTAINER_CLASS (parent_class)->set_focus_child (container, widget);
228 }
229
230
231 static gboolean
232 on_key_press (GtkWidget *w, GdkEventKey *e)
233 {
234   PsppireDataEditor *de = PSPPIRE_DATA_EDITOR (w);
235   if (e->keyval == GDK_KEY_F2 &&
236       PSPPIRE_DATA_EDITOR_DATA_VIEW == gtk_notebook_get_current_page (GTK_NOTEBOOK (de)))
237     {
238       gtk_widget_grab_focus (de->datum_entry);
239     }
240
241   return FALSE;
242 }
243
244 static void
245 psppire_data_editor_class_init (PsppireDataEditorClass *klass)
246 {
247   GParamSpec *data_store_spec ;
248   GParamSpec *dict_spec ;
249   GParamSpec *value_labels_spec;
250   GParamSpec *split_window_spec;
251
252   GObjectClass *object_class = G_OBJECT_CLASS (klass);
253   GtkContainerClass *container_class = GTK_CONTAINER_CLASS (klass);
254   GtkNotebookClass *notebook_class = GTK_NOTEBOOK_CLASS (klass);
255   GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
256
257   parent_class = g_type_class_peek_parent (klass);
258
259   object_class->dispose = psppire_data_editor_dispose;
260   object_class->set_property = psppire_data_editor_set_property;
261   object_class->get_property = psppire_data_editor_get_property;
262
263   container_class->set_focus_child = psppire_data_editor_set_focus_child;
264   notebook_class->switch_page = psppire_data_editor_switch_page;
265   widget_class->key_press_event = on_key_press;
266
267   data_store_spec =
268     g_param_spec_pointer ("data-store",
269                           "Data Store",
270                           "A pointer to the data store associated with this editor",
271                           G_PARAM_CONSTRUCT_ONLY | G_PARAM_WRITABLE | G_PARAM_READABLE );
272
273   g_object_class_install_property (object_class,
274                                    PROP_DATA_STORE,
275                                    data_store_spec);
276
277   dict_spec =
278     g_param_spec_pointer ("dictionary",
279                           "Dictionary",
280                           "A pointer to the dictionary associated with this editor",
281                           G_PARAM_CONSTRUCT_ONLY | G_PARAM_WRITABLE | G_PARAM_READABLE );
282
283   g_object_class_install_property (object_class,
284                                    PROP_DICTIONARY,
285                                    dict_spec);
286
287   value_labels_spec =
288     g_param_spec_boolean ("value-labels",
289                          "Value Labels",
290                          "Whether or not the data sheet should display labels instead of values",
291                           FALSE,
292                          G_PARAM_WRITABLE | G_PARAM_READABLE);
293
294   g_object_class_install_property (object_class,
295                                    PROP_VALUE_LABELS,
296                                    value_labels_spec);
297
298
299   split_window_spec =
300     g_param_spec_boolean ("split",
301                           "Split Window",
302                           "True iff the data sheet is split",
303                           FALSE,
304                           G_PARAM_READABLE | G_PARAM_WRITABLE);
305
306   g_object_class_install_property (object_class,
307                                    PROP_SPLIT_WINDOW,
308                                    split_window_spec);
309 }
310
311
312 static void
313 on_var_sheet_var_double_clicked (void *var_sheet, gint dict_index,
314                                  PsppireDataEditor *de)
315 {
316   gtk_notebook_set_current_page (GTK_NOTEBOOK (de),
317                                  PSPPIRE_DATA_EDITOR_DATA_VIEW);
318
319   ssw_sheet_scroll_to (SSW_SHEET (de->data_sheet), dict_index, -1);
320 }
321
322
323 static void
324 on_data_sheet_var_double_clicked (SswSheet *data_sheet, gint dict_index,
325                                  PsppireDataEditor *de)
326 {
327
328   gtk_notebook_set_current_page (GTK_NOTEBOOK (de),
329                                  PSPPIRE_DATA_EDITOR_VARIABLE_VIEW);
330
331   ssw_sheet_scroll_to (SSW_SHEET (de->var_sheet), -1, dict_index);
332 }
333
334
335
336 /* Refreshes 'de->cell_ref_label' and 'de->datum_entry' from the currently
337    active cell or cells. */
338 static void
339 refresh_entry (PsppireDataEditor *de)
340 {
341   gint row, col;
342   if (ssw_sheet_get_active_cell (SSW_SHEET (de->data_sheet), &col, &row))
343     {
344       union value val;
345       const struct variable *var = psppire_dict_get_variable (de->dict, col);
346       if (var == NULL)
347         return;
348
349       psppire_value_entry_set_variable (PSPPIRE_VALUE_ENTRY (de->datum_entry), var);
350
351       int width = var_get_width (var);
352       if (! psppire_data_store_get_value (PSPPIRE_DATA_STORE (de->data_store),
353                                           row, var, &val))
354         return;
355
356       psppire_value_entry_set_value (PSPPIRE_VALUE_ENTRY (de->datum_entry),
357                                      &val, width);
358       value_destroy (&val, width);
359     }
360 }
361
362 static void
363 on_datum_entry_activate (GtkEntry *entry, PsppireDataEditor *de)
364 {
365   gint row, col;
366   if (ssw_sheet_get_active_cell (SSW_SHEET (de->data_sheet), &col, &row))
367     {
368       union value val;
369       const struct variable *var = psppire_dict_get_variable (de->dict, col);
370       if (var == NULL)
371         return;
372
373       int width = var_get_width (var);
374       value_init (&val, width);
375       if (psppire_value_entry_get_value (PSPPIRE_VALUE_ENTRY (de->datum_entry),
376                                          &val, width))
377         {
378           psppire_data_store_set_value (de->data_store, row, var, &val);
379         }
380       value_destroy (&val, width);
381     }
382 }
383
384
385 /* Called when the active cell or the selection in the data sheet changes */
386 static void
387 on_data_selection_change (PsppireDataEditor *de, SswRange *sel)
388 {
389   gchar *ref_cell_text = NULL;
390
391   gint n_cases = abs (sel->end_y - sel->start_y) + 1;
392   gint n_vars = abs (sel->end_x - sel->start_x) + 1;
393
394   if (n_cases == 1 && n_vars == 1)
395     {
396       /* A single cell is selected */
397       const struct variable *var = psppire_dict_get_variable (de->dict, sel->start_x);
398
399       if (var)
400         ref_cell_text = g_strdup_printf (_("%d : %s"),
401                                          sel->start_y + 1, var_get_name (var));
402     }
403   else
404     {
405       struct string s;
406
407       /* The glib string library does not understand the ' printf modifier
408          on all platforms, but the "struct string" library does (because
409          Gnulib fixes that problem), so use the latter.  */
410       ds_init_empty (&s);
411       ds_put_format (&s, ngettext ("%'d case", "%'d cases", n_cases),
412                      n_cases);
413       ds_put_byte (&s, ' ');
414       ds_put_unichar (&s, 0xd7); /* U+00D7 MULTIPLICATION SIGN */
415       ds_put_byte (&s, ' ');
416       ds_put_format (&s, ngettext ("%'d variable", "%'d variables",
417                                    n_vars),
418                      n_vars);
419       ref_cell_text = ds_steal_cstr (&s);
420     }
421
422   gtk_label_set_label (GTK_LABEL (de->cell_ref_label),
423                        ref_cell_text ? ref_cell_text : "");
424
425   g_free (ref_cell_text);
426 }
427
428
429 static void set_font_recursively (GtkWidget *w, gpointer data);
430
431 \f
432
433 void
434 psppire_data_editor_data_delete_variables (PsppireDataEditor *de)
435 {
436   SswRange *range = SSW_SHEET(de->data_sheet)->selection;
437
438   psppire_dict_delete_variables (de->dict, range->start_x,
439                                  (range->end_x - range->start_x + 1));
440
441   gtk_widget_queue_draw (GTK_WIDGET (de->data_sheet));
442 }
443
444 void
445 psppire_data_editor_var_delete_variables (PsppireDataEditor *de)
446 {
447   SswRange *range = SSW_SHEET(de->var_sheet)->selection;
448
449   psppire_dict_delete_variables (de->dict, range->start_y,
450                                  (range->end_y - range->start_y + 1));
451
452   gtk_widget_queue_draw (GTK_WIDGET (de->var_sheet));
453 }
454
455 void
456 psppire_data_editor_insert_new_case_at_posn  (PsppireDataEditor *de, gint posn)
457 {
458   psppire_data_store_insert_new_case (de->data_store, posn);
459
460   gtk_widget_queue_draw (GTK_WIDGET (de->data_sheet));
461 }
462
463 void
464 psppire_data_editor_insert_new_variable_at_posn (PsppireDataEditor *de, gint posn)
465 {
466   const struct variable *v = psppire_dict_insert_variable (de->dict, posn, NULL);
467   psppire_data_store_insert_value (de->data_store, var_get_width(v),
468                                    var_get_case_index (v));
469
470   gtk_widget_queue_draw (GTK_WIDGET (de));
471 }
472
473 static void
474 psppire_data_editor_init (PsppireDataEditor *de)
475 {
476   GtkWidget *hbox;
477   gchar *fontname = NULL;
478
479   GtkStyleContext *context = gtk_widget_get_style_context (GTK_WIDGET (de));
480   gtk_style_context_add_class (context, "psppire-data-editor");
481
482   de->font = NULL;
483
484   g_object_set (de, "tab-pos", GTK_POS_BOTTOM, NULL);
485
486   de->cell_ref_label = gtk_label_new ("");
487   gtk_label_set_width_chars (GTK_LABEL (de->cell_ref_label), 25);
488   gtk_widget_set_valign (de->cell_ref_label, GTK_ALIGN_CENTER);
489
490   de->datum_entry = psppire_value_entry_new ();
491   g_signal_connect (GTK_ENTRY (gtk_bin_get_child (GTK_BIN (de->datum_entry))),
492                     "activate", G_CALLBACK (on_datum_entry_activate), de);
493
494   hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
495   gtk_box_pack_start (GTK_BOX (hbox), de->cell_ref_label, FALSE, FALSE, 0);
496   gtk_box_pack_start (GTK_BOX (hbox), de->datum_entry, TRUE, TRUE, 0);
497
498   de->split = FALSE;
499   de->data_sheet = psppire_data_sheet_new ();
500
501   GtkWidget *data_button = ssw_sheet_get_button (SSW_SHEET (de->data_sheet));
502   gtk_button_set_label (GTK_BUTTON (data_button), _("Case"));
503   de->vbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
504   gtk_box_pack_start (GTK_BOX (de->vbox), hbox, FALSE, FALSE, 0);
505   gtk_box_pack_start (GTK_BOX (de->vbox), de->data_sheet, TRUE, TRUE, 0);
506
507
508   g_signal_connect_swapped (de->data_sheet, "selection-changed",
509                     G_CALLBACK (on_data_selection_change), de);
510
511   gtk_notebook_append_page (GTK_NOTEBOOK (de), de->vbox,
512                             gtk_label_new_with_mnemonic (_("Data View")));
513
514   gtk_widget_show_all (de->vbox);
515
516   de->var_sheet = psppire_variable_sheet_new ();
517
518   GtkWidget *var_button = ssw_sheet_get_button (SSW_SHEET (de->var_sheet));
519   gtk_button_set_label (GTK_BUTTON (var_button), _("Variable"));
520
521   gtk_notebook_append_page (GTK_NOTEBOOK (de), de->var_sheet,
522                             gtk_label_new_with_mnemonic (_("Variable View")));
523
524   gtk_widget_show_all (de->var_sheet);
525
526   g_signal_connect (de->var_sheet, "row-header-double-clicked",
527                     G_CALLBACK (on_var_sheet_var_double_clicked), de);
528
529   g_signal_connect (de->data_sheet, "column-header-double-clicked",
530                     G_CALLBACK (on_data_sheet_var_double_clicked), de);
531
532   g_object_set (de, "can-focus", FALSE, NULL);
533
534   if (psppire_conf_get_string (psppire_conf_new (),
535                            "Data Editor", "font",
536                                 &fontname) )
537     {
538       de->font = pango_font_description_from_string (fontname);
539       g_free (fontname);
540       set_font_recursively (GTK_WIDGET (de), de->font);
541     }
542
543   gtk_widget_add_events (GTK_WIDGET (de), GDK_KEY_PRESS_MASK);
544 }
545
546 GtkWidget*
547 psppire_data_editor_new (PsppireDict *dict,
548                          PsppireDataStore *data_store)
549 {
550   return  g_object_new (PSPPIRE_DATA_EDITOR_TYPE,
551                         "dictionary",  dict,
552                         "data-store",  data_store,
553                         NULL);
554 }
555 \f
556 /* Turns the visible grid on or off, according to GRID_VISIBLE, for DE's data
557    sheet(s) and variable sheet. */
558 void
559 psppire_data_editor_show_grid (PsppireDataEditor *de, gboolean grid_visible)
560 {
561   g_object_set (SSW_SHEET (de->var_sheet), "gridlines", grid_visible, NULL);
562   g_object_set (SSW_SHEET (de->data_sheet), "gridlines", grid_visible, NULL);
563 }
564
565
566 static void
567 set_font_recursively (GtkWidget *w, gpointer data)
568 {
569   PangoFontDescription *font_desc = data;
570
571   GtkStyleContext *style = gtk_widget_get_style_context (w);
572   GtkCssProvider *cssp = gtk_css_provider_new ();
573
574   gchar *str = pango_font_description_to_string (font_desc);
575   gchar *css =
576     g_strdup_printf ("* {font: %s}", str);
577   g_free (str);
578
579   GError *err = NULL;
580   gtk_css_provider_load_from_data (cssp, css, -1, &err);
581   if (err)
582     {
583       g_warning ("Failed to load font css \"%s\": %s", css, err->message);
584       g_error_free (err);
585     }
586   g_free (css);
587
588   gtk_style_context_add_provider (style,
589                                   GTK_STYLE_PROVIDER (cssp),
590                                   GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);
591   g_object_unref (cssp);
592
593
594   if ( GTK_IS_CONTAINER (w))
595     gtk_container_foreach (GTK_CONTAINER (w), set_font_recursively, font_desc);
596 }
597
598 /* Sets FONT_DESC as the font used by the data sheet(s) and variable sheet. */
599 void
600 psppire_data_editor_set_font (PsppireDataEditor *de, PangoFontDescription *font_desc)
601 {
602   gchar *font_name;
603   set_font_recursively (GTK_WIDGET (de), font_desc);
604
605   if (de->font)
606     pango_font_description_free (de->font);
607   de->font = pango_font_description_copy (font_desc);
608   font_name = pango_font_description_to_string (de->font);
609
610   psppire_conf_set_string (psppire_conf_new (),
611                            "Data Editor", "font",
612                            font_name);
613   g_free (font_name);
614 }
615
616 /* If SPLIT is TRUE, splits DE's data sheet into four panes.
617    If SPLIT is FALSE, un-splits it into a single pane. */
618 void
619 psppire_data_editor_split_window (PsppireDataEditor *de, gboolean split)
620 {
621   g_object_set (de, "split", split, NULL);
622 }
623
624 /* Makes the variable with dictionary index DICT_INDEX in DE's dictionary
625    visible and selected in the active view in DE. */
626 void
627 psppire_data_editor_goto_variable (PsppireDataEditor *de, gint dict_index)
628 {
629   gint page = gtk_notebook_get_current_page (GTK_NOTEBOOK (de));
630
631   switch (page)
632     {
633       case PSPPIRE_DATA_EDITOR_DATA_VIEW:
634         ssw_sheet_scroll_to (SSW_SHEET (de->data_sheet), dict_index, -1);
635         ssw_sheet_set_active_cell (SSW_SHEET (de->data_sheet), dict_index, -1, NULL);
636         break;
637       case PSPPIRE_DATA_EDITOR_VARIABLE_VIEW:
638         ssw_sheet_scroll_to (SSW_SHEET (de->var_sheet), -1, dict_index);
639         ssw_sheet_set_active_cell (SSW_SHEET (de->var_sheet), -1, dict_index, NULL);
640         break;
641     }
642 }
643
644 /* Set the datum at COL, ROW, to that contained in VALUE.
645  */
646 static void
647 store_set_datum (GtkTreeModel *model, gint col, gint row,
648                          const GValue *value)
649 {
650   PsppireDataStore *store = PSPPIRE_DATA_STORE (model);
651   GVariant *v = g_value_get_variant (value);
652   union value uv;
653   value_variant_get (&uv, v);
654   const struct variable *var = psppire_dict_get_variable (store->dict, col);
655   psppire_data_store_set_value (store, row, var, &uv);
656   value_destroy_from_variant (&uv, v);
657 }
658
659 void
660 psppire_data_editor_paste (PsppireDataEditor *de)
661 {
662   SswSheet *sheet = SSW_SHEET (de->data_sheet);
663   GtkClipboard *clip =
664     gtk_clipboard_get_for_display (gtk_widget_get_display (GTK_WIDGET (sheet)),
665                                    GDK_SELECTION_CLIPBOARD);
666
667   ssw_sheet_paste (sheet, clip, store_set_datum);
668 }