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