Removed GtkXPaned which is currently not used
[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     case PROP_VALUE_LABELS:
171       break;
172
173     default:
174       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
175       break;
176     };
177 }
178
179 static void
180 psppire_data_editor_get_property (GObject         *object,
181                                   guint            prop_id,
182                                   GValue          *value,
183                                   GParamSpec      *pspec)
184 {
185   PsppireDataEditor *de = PSPPIRE_DATA_EDITOR (object);
186
187   switch (prop_id)
188     {
189     case PROP_SPLIT_WINDOW:
190       g_value_set_boolean (value, de->split);
191       break;
192     case PROP_DATA_STORE:
193       g_value_set_pointer (value, de->data_store);
194       break;
195     case PROP_DICTIONARY:
196       g_value_set_pointer (value, de->dict);
197       break;
198     case PROP_VALUE_LABELS:
199       break;
200     default:
201       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
202       break;
203     }
204 }
205
206 static void
207 psppire_data_editor_switch_page (GtkNotebook     *notebook,
208                                  GtkWidget *w,
209                                  guint            page_num)
210 {
211   GTK_NOTEBOOK_CLASS (parent_class)->switch_page (notebook, w, page_num);
212
213 }
214
215 static void
216 psppire_data_editor_set_focus_child (GtkContainer *container,
217                                      GtkWidget    *widget)
218 {
219   GTK_CONTAINER_CLASS (parent_class)->set_focus_child (container, widget);
220
221 }
222
223 static void
224 psppire_data_editor_class_init (PsppireDataEditorClass *klass)
225 {
226   GParamSpec *data_store_spec ;
227   GParamSpec *dict_spec ;
228   GParamSpec *value_labels_spec;
229   GParamSpec *split_window_spec;
230
231   GObjectClass *object_class = G_OBJECT_CLASS (klass);
232   GtkContainerClass *container_class = GTK_CONTAINER_CLASS (klass);
233   GtkNotebookClass *notebook_class = GTK_NOTEBOOK_CLASS (klass);
234
235   parent_class = g_type_class_peek_parent (klass);
236
237   object_class->dispose = psppire_data_editor_dispose;
238   object_class->set_property = psppire_data_editor_set_property;
239   object_class->get_property = psppire_data_editor_get_property;
240
241   container_class->set_focus_child = psppire_data_editor_set_focus_child;
242
243   notebook_class->switch_page = psppire_data_editor_switch_page;
244
245   data_store_spec =
246     g_param_spec_pointer ("data-store",
247                           "Data Store",
248                           "A pointer to the data store associated with this editor",
249                           G_PARAM_CONSTRUCT_ONLY | G_PARAM_WRITABLE | G_PARAM_READABLE );
250
251   g_object_class_install_property (object_class,
252                                    PROP_DATA_STORE,
253                                    data_store_spec);
254
255   dict_spec =
256     g_param_spec_pointer ("dictionary",
257                           "Dictionary",
258                           "A pointer to the dictionary associated with this editor",
259                           G_PARAM_CONSTRUCT_ONLY | G_PARAM_WRITABLE | G_PARAM_READABLE );
260
261   g_object_class_install_property (object_class,
262                                    PROP_DICTIONARY,
263                                    dict_spec);
264
265   value_labels_spec =
266     g_param_spec_boolean ("value-labels",
267                          "Value Labels",
268                          "Whether or not the data sheet should display labels instead of values",
269                           FALSE,
270                          G_PARAM_WRITABLE | G_PARAM_READABLE);
271
272   g_object_class_install_property (object_class,
273                                    PROP_VALUE_LABELS,
274                                    value_labels_spec);
275
276
277   split_window_spec =
278     g_param_spec_boolean ("split",
279                           "Split Window",
280                           "True iff the data sheet is split",
281                           FALSE,
282                           G_PARAM_READABLE | G_PARAM_WRITABLE);
283
284   g_object_class_install_property (object_class,
285                                    PROP_SPLIT_WINDOW,
286                                    split_window_spec);
287 }
288
289
290 static void
291 on_var_sheet_var_double_clicked (void *var_sheet, gint dict_index,
292                                  PsppireDataEditor *de)
293 {
294   gtk_notebook_set_current_page (GTK_NOTEBOOK (de),
295                                  PSPPIRE_DATA_EDITOR_DATA_VIEW);
296
297   ssw_sheet_scroll_to (SSW_SHEET (de->data_sheet), dict_index, -1);
298 }
299
300
301 static void
302 on_data_sheet_var_double_clicked (SswSheet *data_sheet, gint dict_index,
303                                  PsppireDataEditor *de)
304 {
305
306   gtk_notebook_set_current_page (GTK_NOTEBOOK (de),
307                                  PSPPIRE_DATA_EDITOR_VARIABLE_VIEW);
308
309   ssw_sheet_scroll_to (SSW_SHEET (de->var_sheet), -1, dict_index);
310 }
311
312
313
314 /* Refreshes 'de->cell_ref_label' and 'de->datum_entry' from the currently
315    active cell or cells. */
316 static void
317 refresh_entry (PsppireDataEditor *de)
318 {
319   gint row, col;
320   if (ssw_sheet_get_active_cell (SSW_SHEET (de->data_sheet), &col, &row))
321     {
322       union value val;
323       const struct variable *var = psppire_dict_get_variable (de->dict, col);
324       if (var == NULL)
325         return;
326
327       psppire_value_entry_set_variable (PSPPIRE_VALUE_ENTRY (de->datum_entry), var);
328
329       int width = var_get_width (var);
330       if (! psppire_data_store_get_value (PSPPIRE_DATA_STORE (de->data_store),
331                                           row, var, &val))
332         return;
333
334       psppire_value_entry_set_value (PSPPIRE_VALUE_ENTRY (de->datum_entry),
335                                      &val, width);
336       value_destroy (&val, width);
337     }
338 }
339
340 static void
341 on_datum_entry_activate (PsppireValueEntry *entry, PsppireDataEditor *de)
342 {
343 }
344
345
346 /* Called when the active cell or the selection in the data sheet changes */
347 static void
348 on_data_selection_change (PsppireDataEditor *de, SswRange *sel)
349 {
350   gchar *ref_cell_text = NULL;
351
352   gint n_cases = abs (sel->end_y - sel->start_y) + 1;
353   gint n_vars = abs (sel->end_x - sel->start_x) + 1;
354
355   if (n_cases == 1 && n_vars == 1)
356     {
357       /* A single cell is selected */
358       const struct variable *var = psppire_dict_get_variable (de->dict, sel->start_x);
359
360       if (var)
361         ref_cell_text = g_strdup_printf (_("%d : %s"),
362                                          sel->start_y + 1, var_get_name (var));
363     }
364   else
365     {
366       struct string s;
367
368       /* The glib string library does not understand the ' printf modifier
369          on all platforms, but the "struct string" library does (because
370          Gnulib fixes that problem), so use the latter.  */
371       ds_init_empty (&s);
372       ds_put_format (&s, ngettext ("%'d case", "%'d cases", n_cases),
373                      n_cases);
374       ds_put_byte (&s, ' ');
375       ds_put_unichar (&s, 0xd7); /* U+00D7 MULTIPLICATION SIGN */
376       ds_put_byte (&s, ' ');
377       ds_put_format (&s, ngettext ("%'d variable", "%'d variables",
378                                    n_vars),
379                      n_vars);
380       ref_cell_text = ds_steal_cstr (&s);
381     }
382
383   gtk_label_set_label (GTK_LABEL (de->cell_ref_label),
384                        ref_cell_text ? ref_cell_text : "");
385
386   g_free (ref_cell_text);
387 }
388
389
390 static void set_font_recursively (GtkWidget *w, gpointer data);
391
392 \f
393
394 void
395 psppire_data_editor_data_delete_variables (PsppireDataEditor *de)
396 {
397   SswRange *range = SSW_SHEET(de->data_sheet)->selection;
398
399   psppire_dict_delete_variables (de->dict, range->start_x,
400                                  (range->end_x - range->start_x + 1));
401
402   gtk_widget_queue_draw (GTK_WIDGET (de->data_sheet));
403 }
404
405 void
406 psppire_data_editor_var_delete_variables (PsppireDataEditor *de)
407 {
408   SswRange *range = SSW_SHEET(de->var_sheet)->selection;
409
410   psppire_dict_delete_variables (de->dict, range->start_y,
411                                  (range->end_y - range->start_y + 1));
412
413   gtk_widget_queue_draw (GTK_WIDGET (de->var_sheet));
414 }
415
416 void
417 psppire_data_editor_insert_new_case_at_posn  (PsppireDataEditor *de, gint posn)
418 {
419   psppire_data_store_insert_new_case (de->data_store, posn);
420
421   gtk_widget_queue_draw (GTK_WIDGET (de->data_sheet));
422 }
423
424 void
425 psppire_data_editor_insert_new_variable_at_posn (PsppireDataEditor *de, gint posn)
426 {
427   const struct variable *v = psppire_dict_insert_variable (de->dict, posn, NULL);
428   psppire_data_store_insert_value (de->data_store, var_get_width(v),
429                                    var_get_case_index (v));
430
431   gtk_widget_queue_draw (GTK_WIDGET (de));
432 }
433
434 static void
435 psppire_data_editor_init (PsppireDataEditor *de)
436 {
437   GtkWidget *hbox;
438   gchar *fontname = NULL;
439
440   GtkStyleContext *context = gtk_widget_get_style_context (GTK_WIDGET (de));
441   gtk_style_context_add_class (context, "psppire-data-editor");
442
443   de->font = NULL;
444
445   g_object_set (de, "tab-pos", GTK_POS_BOTTOM, NULL);
446
447   de->cell_ref_label = gtk_label_new ("");
448   gtk_label_set_width_chars (GTK_LABEL (de->cell_ref_label), 25);
449   gtk_widget_set_valign (de->cell_ref_label, GTK_ALIGN_CENTER);
450
451   de->datum_entry = psppire_value_entry_new ();
452   g_signal_connect (GTK_ENTRY (gtk_bin_get_child (GTK_BIN (de->datum_entry))),
453                     "activate", G_CALLBACK (on_datum_entry_activate), de);
454
455   hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
456   gtk_box_pack_start (GTK_BOX (hbox), de->cell_ref_label, FALSE, FALSE, 0);
457   gtk_box_pack_start (GTK_BOX (hbox), de->datum_entry, TRUE, TRUE, 0);
458
459   de->split = FALSE;
460   de->data_sheet = psppire_data_sheet_new ();
461
462   GtkWidget *data_button = ssw_sheet_get_button (SSW_SHEET (de->data_sheet));
463   gtk_button_set_label (GTK_BUTTON (data_button), _("Case"));
464   de->vbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
465   gtk_box_pack_start (GTK_BOX (de->vbox), hbox, FALSE, FALSE, 0);
466   gtk_box_pack_start (GTK_BOX (de->vbox), de->data_sheet, TRUE, TRUE, 0);
467
468
469   g_signal_connect_swapped (de->data_sheet, "selection-changed",
470                     G_CALLBACK (on_data_selection_change), de);
471
472   gtk_notebook_append_page (GTK_NOTEBOOK (de), de->vbox,
473                             gtk_label_new_with_mnemonic (_("Data View")));
474
475   gtk_widget_show_all (de->vbox);
476
477   de->var_sheet = psppire_variable_sheet_new ();
478
479   GtkWidget *var_button = ssw_sheet_get_button (SSW_SHEET (de->var_sheet));
480   gtk_button_set_label (GTK_BUTTON (var_button), _("Variable"));
481
482   gtk_notebook_append_page (GTK_NOTEBOOK (de), de->var_sheet,
483                             gtk_label_new_with_mnemonic (_("Variable View")));
484
485   gtk_widget_show_all (de->var_sheet);
486
487   g_signal_connect (de->var_sheet, "row-header-double-clicked",
488                     G_CALLBACK (on_var_sheet_var_double_clicked), de);
489
490   g_signal_connect (de->data_sheet, "column-header-double-clicked",
491                     G_CALLBACK (on_data_sheet_var_double_clicked), de);
492
493   g_object_set (de, "can-focus", FALSE, NULL);
494
495   if (psppire_conf_get_string (psppire_conf_new (),
496                            "Data Editor", "font",
497                                 &fontname) )
498     {
499       de->font = pango_font_description_from_string (fontname);
500       g_free (fontname);
501       set_font_recursively (GTK_WIDGET (de), de->font);
502     }
503
504 }
505
506 GtkWidget*
507 psppire_data_editor_new (PsppireDict *dict,
508                          PsppireDataStore *data_store)
509 {
510   return  g_object_new (PSPPIRE_DATA_EDITOR_TYPE,
511                         "dictionary",  dict,
512                         "data-store",  data_store,
513                         NULL);
514 }
515 \f
516 /* Turns the visible grid on or off, according to GRID_VISIBLE, for DE's data
517    sheet(s) and variable sheet. */
518 void
519 psppire_data_editor_show_grid (PsppireDataEditor *de, gboolean grid_visible)
520 {
521   g_object_set (SSW_SHEET (de->var_sheet), "gridlines", grid_visible, NULL);
522   g_object_set (SSW_SHEET (de->data_sheet), "gridlines", grid_visible, NULL);
523 }
524
525
526 static void
527 set_font_recursively (GtkWidget *w, gpointer data)
528 {
529   PangoFontDescription *font_desc = data;
530
531   GtkStyleContext *style = gtk_widget_get_style_context (w);
532   GtkCssProvider *cssp = gtk_css_provider_new ();
533
534   gchar *str = pango_font_description_to_string (font_desc);
535   gchar *css =
536     g_strdup_printf ("* {font: %s}", str);
537   g_free (str);
538
539   GError *err = NULL;
540   gtk_css_provider_load_from_data (cssp, css, -1, &err);
541   if (err)
542     {
543       g_warning ("Failed to load font css \"%s\": %s", css, err->message);
544       g_error_free (err);
545     }
546   g_free (css);
547
548   gtk_style_context_add_provider (style,
549                                   GTK_STYLE_PROVIDER (cssp),
550                                   GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);
551   g_object_unref (cssp);
552
553
554   if ( GTK_IS_CONTAINER (w))
555     gtk_container_foreach (GTK_CONTAINER (w), set_font_recursively, font_desc);
556 }
557
558 /* Sets FONT_DESC as the font used by the data sheet(s) and variable sheet. */
559 void
560 psppire_data_editor_set_font (PsppireDataEditor *de, PangoFontDescription *font_desc)
561 {
562   gchar *font_name;
563   set_font_recursively (GTK_WIDGET (de), font_desc);
564
565   if (de->font)
566     pango_font_description_free (de->font);
567   de->font = pango_font_description_copy (font_desc);
568   font_name = pango_font_description_to_string (de->font);
569
570   psppire_conf_set_string (psppire_conf_new (),
571                            "Data Editor", "font",
572                            font_name);
573   g_free (font_name);
574 }
575
576 /* If SPLIT is TRUE, splits DE's data sheet into four panes.
577    If SPLIT is FALSE, un-splits it into a single pane. */
578 void
579 psppire_data_editor_split_window (PsppireDataEditor *de, gboolean split)
580 {
581   g_object_set (de, "split", split, NULL);
582 }
583
584 /* Makes the variable with dictionary index DICT_INDEX in DE's dictionary
585    visible and selected in the active view in DE. */
586 void
587 psppire_data_editor_goto_variable (PsppireDataEditor *de, gint dict_index)
588 {
589   gint page = gtk_notebook_get_current_page (GTK_NOTEBOOK (de));
590
591   switch (page)
592     {
593       case PSPPIRE_DATA_EDITOR_DATA_VIEW:
594         ssw_sheet_scroll_to (SSW_SHEET (de->data_sheet), dict_index, -1);
595         ssw_sheet_set_active_cell (SSW_SHEET (de->data_sheet), dict_index, -1, NULL);
596         break;
597       case PSPPIRE_DATA_EDITOR_VARIABLE_VIEW:
598         ssw_sheet_scroll_to (SSW_SHEET (de->var_sheet), -1, dict_index);
599         ssw_sheet_set_active_cell (SSW_SHEET (de->var_sheet), -1, dict_index, NULL);
600         break;
601     }
602 }
603
604 /* Set the datum at COL, ROW, to that contained in VALUE.
605  */
606 static void
607 store_set_datum (GtkTreeModel *model, gint col, gint row,
608                          const GValue *value)
609 {
610   PsppireDataStore *store = PSPPIRE_DATA_STORE (model);
611   GVariant *v = g_value_get_variant (value);
612   union value uv;
613   value_variant_get (&uv, v);
614   const struct variable *var = psppire_dict_get_variable (store->dict, col);
615   psppire_data_store_set_value (store, row, var, &uv);
616   value_destroy_from_variant (&uv, v);
617 }
618
619 void
620 psppire_data_editor_paste (PsppireDataEditor *de)
621 {
622   SswSheet *sheet = SSW_SHEET (de->data_sheet);
623   GtkClipboard *clip =
624     gtk_clipboard_get_for_display (gtk_widget_get_display (GTK_WIDGET (sheet)),
625                                    GDK_SELECTION_CLIPBOARD);
626
627   ssw_sheet_paste (sheet, clip, store_set_datum);
628 }