Fixed typo in comment
[pspp] / src / ui / gui / psppire-dictview.c
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyright (C) 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 <gtk/gtk.h>
20 #include "psppire-dictview.h"
21 #include "psppire-dict.h"
22 #include "dict-display.h"
23 #include "psppire-conf.h"
24 #include <data/format.h>
25 #include <libpspp/i18n.h>
26 #include "helper.h"
27
28 #include <gettext.h>
29 #define _(msgid) gettext (msgid)
30 #define N_(msgid) msgid
31
32 static void psppire_dict_view_base_finalize (PsppireDictViewClass *, gpointer);
33 static void psppire_dict_view_base_init     (PsppireDictViewClass *class);
34 static void psppire_dict_view_class_init    (PsppireDictViewClass *class);
35 static void psppire_dict_view_init          (PsppireDictView      *dict_view);
36
37 GType
38 psppire_dict_view_get_type (void)
39 {
40   static GType psppire_dict_view_type = 0;
41
42   if (!psppire_dict_view_type)
43     {
44       static const GTypeInfo psppire_dict_view_info =
45       {
46         sizeof (PsppireDictViewClass),
47         (GBaseInitFunc) psppire_dict_view_base_init,
48         (GBaseFinalizeFunc) psppire_dict_view_base_finalize,
49         (GClassInitFunc)psppire_dict_view_class_init,
50         (GClassFinalizeFunc) NULL,
51         NULL,
52         sizeof (PsppireDictView),
53         0,
54         (GInstanceInitFunc) psppire_dict_view_init,
55       };
56
57       psppire_dict_view_type =
58         g_type_register_static (GTK_TYPE_TREE_VIEW, "PsppireDictView",
59                                 &psppire_dict_view_info, 0);
60     }
61
62   return psppire_dict_view_type;
63 }
64
65
66 static void
67 psppire_dict_view_finalize (GObject *object)
68 {
69   PsppireDictView *dict_view = PSPPIRE_DICT_VIEW (object);
70
71   gtk_widget_destroy (dict_view->menu);
72 }
73
74 /* Properties */
75 enum
76 {
77   PROP_0,
78   PROP_DICTIONARY,
79   PROP_PREDICATE,
80   PROP_SELECTION_MODE
81 };
82
83
84
85 /* A GtkTreeModelFilterVisibleFunc to filter lines in the treeview */
86 static gboolean
87 filter_variables (GtkTreeModel *tmodel, GtkTreeIter *titer, gpointer data)
88 {
89   var_predicate_func *predicate = data;
90   struct variable *var;
91   GtkTreeModel *model = NULL;
92   GtkTreeIter iter ;
93   PsppireDict *dict ;
94   GtkTreePath *path ;
95   gint *idx;
96
97   get_base_model (tmodel, titer, &model, &iter);
98
99   dict = PSPPIRE_DICT (model);
100   path = gtk_tree_model_get_path (model, &iter);
101   idx = gtk_tree_path_get_indices (path);
102   var =  psppire_dict_get_variable (dict, *idx);
103
104   gtk_tree_path_free (path);
105
106   return predicate (var);
107 }
108
109
110 static gint
111 unsorted (GtkTreeModel *model,
112      GtkTreeIter *a,
113      GtkTreeIter *b,
114      gpointer user_data)
115 {
116   const struct variable *var_a;
117   const struct variable *var_b;
118
119
120   gtk_tree_model_get (model, a, DICT_TVM_COL_VAR,  &var_a, -1);
121   gtk_tree_model_get (model, b, DICT_TVM_COL_VAR,  &var_b, -1);
122
123   return compare_var_ptrs_by_dict_index (&var_a, &var_b, NULL);
124 }
125
126 static gint
127 sort_by_name (GtkTreeModel *model,
128      GtkTreeIter *a,
129      GtkTreeIter *b,
130      gpointer user_data)
131 {
132   const struct variable *var_a;
133   const struct variable *var_b;
134
135   gtk_tree_model_get (model, a, DICT_TVM_COL_VAR,  &var_a, -1);
136   gtk_tree_model_get (model, b, DICT_TVM_COL_VAR,  &var_b, -1);
137
138   return g_strcmp0 (var_get_name (var_a), var_get_name (var_b));
139 }
140
141
142 static gint
143 sort_by_label (GtkTreeModel *model,
144      GtkTreeIter *a,
145      GtkTreeIter *b,
146      gpointer user_data)
147 {
148   const struct variable *var_a;
149   const struct variable *var_b;
150
151   gtk_tree_model_get (model, a, DICT_TVM_COL_VAR,  &var_a, -1);
152   gtk_tree_model_get (model, b, DICT_TVM_COL_VAR,  &var_b, -1);
153
154   return g_strcmp0 (var_get_label (var_a), var_get_label (var_b));
155 }
156
157 static void
158 set_model (PsppireDictView *dict_view)
159 {
160   GtkTreeModel *model = NULL;
161
162   if ( dict_view->dict == NULL)
163     return;
164
165   dict_view->sorted_model = gtk_tree_model_sort_new_with_model (GTK_TREE_MODEL (dict_view->dict));
166   gtk_tree_sortable_set_default_sort_func (GTK_TREE_SORTABLE (dict_view->sorted_model), unsorted, dict_view, 0);
167   gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (dict_view->sorted_model), 
168                                         GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, GTK_SORT_ASCENDING);
169
170    if ( dict_view->predicate )
171     {
172       model = gtk_tree_model_filter_new (dict_view->sorted_model,        NULL);
173
174       gtk_tree_model_filter_set_visible_func (GTK_TREE_MODEL_FILTER (model),
175                                               filter_variables,
176                                               dict_view->predicate,
177                                               NULL);
178     }
179   else
180     {
181       model = dict_view->sorted_model;
182       g_object_ref (model);
183     }
184
185   gtk_tree_view_set_model (GTK_TREE_VIEW (dict_view), model);
186   g_object_unref (model);
187 }
188
189 static void
190 psppire_dict_view_set_property (GObject         *object,
191                                guint            prop_id,
192                                const GValue    *value,
193                                GParamSpec      *pspec)
194 {
195   PsppireDictView *dict_view = PSPPIRE_DICT_VIEW (object);
196
197   switch (prop_id)
198     {
199     case PROP_DICTIONARY:
200       dict_view->dict = g_value_get_object (value);
201       break;
202     case PROP_PREDICATE:
203       dict_view->predicate = g_value_get_pointer (value);
204       break;
205     case PROP_SELECTION_MODE:
206       {
207         GtkTreeSelection *selection =
208           gtk_tree_view_get_selection (GTK_TREE_VIEW (dict_view));
209
210         GtkSelectionMode mode = g_value_get_enum (value);
211
212         gtk_tree_selection_set_mode (selection, mode);
213       }
214       break;
215     default:
216       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
217       break;
218     };
219
220
221   set_model (dict_view);
222 }
223
224
225 static void
226 psppire_dict_view_get_property (GObject         *object,
227                                guint            prop_id,
228                                GValue          *value,
229                                GParamSpec      *pspec)
230 {
231   PsppireDictView *dict_view = PSPPIRE_DICT_VIEW (object);
232
233   switch (prop_id)
234     {
235     case PROP_DICTIONARY:
236       g_value_set_object (value, dict_view->dict);
237       break;
238     case PROP_PREDICATE:
239       g_value_set_pointer (value, dict_view->predicate);
240       break;
241     case PROP_SELECTION_MODE:
242       {
243         GtkTreeSelection *selection =
244           gtk_tree_view_get_selection (GTK_TREE_VIEW (dict_view));
245
246         g_value_set_enum (value, gtk_tree_selection_get_mode (selection));
247       }
248     default:
249       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
250       break;
251     };
252 }
253
254
255
256 static void
257 psppire_dict_view_class_init (PsppireDictViewClass *class)
258 {
259   GObjectClass *object_class = G_OBJECT_CLASS (class);
260
261   GParamSpec *predicate_spec =
262     g_param_spec_pointer ("predicate",
263                           "Predicate",
264                           "A predicate function",
265                           G_PARAM_READABLE | G_PARAM_WRITABLE);
266
267
268   GParamSpec *selection_mode_spec =
269     g_param_spec_enum ("selection-mode",
270                        "Selection Mode",
271                        "How many things can be selected",
272                        GTK_TYPE_SELECTION_MODE,
273                        GTK_SELECTION_MULTIPLE,
274                        G_PARAM_CONSTRUCT | G_PARAM_READABLE | G_PARAM_WRITABLE);
275
276   object_class->set_property = psppire_dict_view_set_property;
277   object_class->get_property = psppire_dict_view_get_property;
278
279   g_object_class_override_property (object_class,
280                                     PROP_DICTIONARY,
281                                     "model");
282
283   g_object_class_install_property (object_class,
284                                    PROP_PREDICATE,
285                                    predicate_spec);
286
287   g_object_class_install_property (object_class,
288                                    PROP_SELECTION_MODE,
289                                    selection_mode_spec);
290 }
291
292
293 static void
294 psppire_dict_view_base_init (PsppireDictViewClass *class)
295 {
296   GObjectClass *object_class = G_OBJECT_CLASS (class);
297
298   object_class->finalize = psppire_dict_view_finalize;
299 }
300
301
302
303 static void
304 psppire_dict_view_base_finalize (PsppireDictViewClass *class,
305                                  gpointer class_data)
306 {
307
308 }
309
310
311
312
313 /* A GtkTreeCellDataFunc which renders the name and/or label of the
314    variable */
315 static void
316 var_description_cell_data_func (GtkTreeViewColumn *col,
317                                 GtkCellRenderer *cell,
318                                 GtkTreeModel *top_model,
319                                 GtkTreeIter *top_iter,
320                                 gpointer data)
321 {
322   PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
323   struct variable *var;
324   GtkTreeIter iter;
325   GtkTreeModel *model;
326
327   get_base_model (top_model, top_iter, &model, &iter);
328
329   gtk_tree_model_get (model,
330                       &iter, DICT_TVM_COL_VAR, &var, -1);
331
332   if ( var_has_label (var) && dv->prefer_labels)
333     {
334       gchar *text = g_markup_printf_escaped (
335                                      "<span stretch=\"condensed\">%s</span>",
336                                      var_get_label (var));
337
338       g_object_set (cell, "markup", text, NULL);
339       g_free (text);
340     }
341   else
342     {
343       g_object_set (cell, "text", var_get_name (var), NULL);
344     }
345 }
346
347
348
349 /* A GtkTreeCellDataFunc which sets the icon appropriate to the type
350    of variable */
351 static void
352 var_icon_cell_data_func (GtkTreeViewColumn *col,
353                        GtkCellRenderer *cell,
354                        GtkTreeModel *model,
355                        GtkTreeIter *iter,
356                        gpointer data)
357 {
358   struct variable *var;
359
360   gtk_tree_model_get (model, iter, DICT_TVM_COL_VAR, &var, -1);
361
362   g_object_set (cell, "stock_id",
363                 get_var_measurement_stock_id (var_get_print_format (var)->type,
364                                               var_get_measure (var)),
365                 NULL);
366 }
367
368 const char *
369 get_var_measurement_stock_id (enum fmt_type type, enum measure measure)
370 {
371   switch (fmt_get_category (type))
372     {
373     case FMT_CAT_STRING:
374       switch (measure)
375         {
376         case MEASURE_NOMINAL: return "measure-string-nominal";
377         case MEASURE_ORDINAL: return "measure-string-ordinal";
378         case MEASURE_SCALE:   return "role-none";
379         case n_MEASURES: break;
380         }
381       break;
382
383     case FMT_CAT_DATE:
384     case FMT_CAT_TIME:
385       switch (measure)
386         {
387         case MEASURE_NOMINAL: return "measure-date-nominal";
388         case MEASURE_ORDINAL: return "measure-date-ordinal";
389         case MEASURE_SCALE:   return "measure-date-scale";
390         case n_MEASURES: break;
391         }
392       break;
393
394     default:
395       switch (measure)
396         {
397         case MEASURE_NOMINAL: return "measure-nominal";
398         case MEASURE_ORDINAL: return "measure-ordinal";
399         case MEASURE_SCALE:   return "measure-scale";
400         case n_MEASURES: break;
401         }
402       break;
403     }
404
405   g_return_val_if_reached ("");
406 }
407
408
409
410 /* Sets the tooltip to be the name of the variable under the cursor */
411 static gboolean
412 set_tooltip_for_variable (GtkTreeView  *treeview,
413                           gint        x,
414                           gint        y,
415                           gboolean    keyboard_mode,
416                           GtkTooltip *tooltip,
417                           gpointer    user_data)
418 {
419   gint bx, by;
420   GtkTreeIter iter;
421   GtkTreePath *path;
422   GtkTreeModel *tree_model;
423   struct variable *var = NULL;
424   gboolean ok;
425
426   gtk_tree_view_convert_widget_to_bin_window_coords (treeview,
427                                                      x, y, &bx, &by);
428
429   if (!gtk_tree_view_get_path_at_pos (treeview, bx, by,
430                                       &path, NULL, NULL, NULL))
431     return FALSE;
432
433   tree_model = gtk_tree_view_get_model (treeview);
434
435   gtk_tree_view_set_tooltip_row (treeview, tooltip, path);
436
437   ok = gtk_tree_model_get_iter (tree_model, &iter, path);
438
439   gtk_tree_path_free (path);
440   if (!ok)
441     return FALSE;
442
443
444   gtk_tree_model_get (tree_model, &iter, DICT_TVM_COL_VAR,  &var, -1);
445
446   if ( ! var_has_label (var))
447     return FALSE;
448
449   {
450     const gchar *tip ;
451     GtkTreeModel *m;
452
453     get_base_model (tree_model, NULL, &m, NULL);
454
455     if ( PSPPIRE_DICT_VIEW (treeview)->prefer_labels )
456       tip = var_get_name (var);
457     else
458       tip = var_get_label (var);
459
460     gtk_tooltip_set_text (tooltip, tip);
461   }
462
463   return TRUE;
464 }
465
466 static gboolean
467 show_menu (PsppireDictView *dv, GdkEventButton *event, gpointer data)
468 {
469   if (event->button != 3)
470     return FALSE;
471
472   gtk_menu_popup (GTK_MENU (dv->menu), NULL, NULL, NULL, NULL,
473                   event->button, event->time);
474
475   return TRUE;
476 }
477
478 static void
479 toggle_label_preference (GtkCheckMenuItem *checkbox, gpointer data)
480 {
481   PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
482
483   dv->prefer_labels = gtk_check_menu_item_get_active (checkbox);
484
485   gtk_widget_queue_draw (GTK_WIDGET (dv));
486 }
487
488
489 static void
490 set_sort_criteria (GtkCheckMenuItem *checkbox, PsppireDictView *dv, GtkTreeIterCompareFunc func)
491 {
492   if (!gtk_check_menu_item_get_active (checkbox))
493     {
494       gtk_widget_queue_draw (GTK_WIDGET (dv));
495       return;
496     }
497
498
499   gtk_tree_sortable_set_default_sort_func (GTK_TREE_SORTABLE (dv->sorted_model), func, 0, 0);
500
501
502   gtk_widget_queue_draw (GTK_WIDGET (dv));
503 }
504
505 static void
506 set_sort_criteria_name (GtkCheckMenuItem *checkbox, gpointer data)
507 {
508   PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
509   set_sort_criteria (checkbox, dv, sort_by_name);
510 }
511
512
513 static void
514 set_sort_criteria_label (GtkCheckMenuItem *checkbox, gpointer data)
515 {
516   PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
517   set_sort_criteria (checkbox, dv, sort_by_label);
518 }
519
520
521 static void
522 set_sort_criteria_unsorted (GtkCheckMenuItem *checkbox, gpointer data)
523 {
524   PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
525   set_sort_criteria (checkbox, dv, unsorted);
526 }
527
528
529
530 static void
531 psppire_dict_view_init (PsppireDictView *dict_view)
532 {
533   GtkTreeViewColumn *col = gtk_tree_view_column_new ();
534
535   GtkCellRenderer *renderer = gtk_cell_renderer_pixbuf_new ();
536
537   dict_view->prefer_labels = TRUE;
538   dict_view->sorted_model = NULL;
539
540   psppire_conf_get_boolean (psppire_conf_new (),
541                             G_OBJECT_TYPE_NAME (dict_view),
542                             "prefer-labels",
543                             &dict_view->prefer_labels);
544
545   gtk_tree_view_column_set_title (col, _("Variable"));
546
547   gtk_tree_view_column_pack_start (col, renderer, FALSE);
548
549   gtk_tree_view_column_set_cell_data_func (col, renderer,
550                                            var_icon_cell_data_func,
551                                            NULL, NULL);
552
553   renderer = gtk_cell_renderer_text_new ();
554   gtk_tree_view_column_pack_start (col, renderer, TRUE);
555   gtk_tree_view_column_set_cell_data_func (col, renderer,
556                                            var_description_cell_data_func,
557                                            dict_view, NULL);
558
559   g_object_set (renderer, "ellipsize-set", TRUE, NULL);
560   g_object_set (renderer, "ellipsize", PANGO_ELLIPSIZE_MIDDLE, NULL);
561
562   gtk_tree_view_column_set_sizing (col, GTK_TREE_VIEW_COLUMN_FIXED);
563
564   /* FIXME: make this a value in terms of character widths */
565   gtk_tree_view_column_set_min_width (col, 150);
566
567   gtk_tree_view_append_column (GTK_TREE_VIEW (dict_view), col);
568
569   g_object_set (dict_view,
570                 "has-tooltip", TRUE,
571                 "headers-visible", FALSE,
572                 NULL);
573
574   g_signal_connect (dict_view, "query-tooltip",
575                     G_CALLBACK (set_tooltip_for_variable), NULL);
576
577   dict_view->menu = gtk_menu_new ();
578
579
580   {
581     GSList *group = NULL;
582     GtkWidget *item =
583       gtk_check_menu_item_new_with_label  (_("Prefer variable labels"));
584
585     gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (item),
586                                     dict_view->prefer_labels);
587
588     g_signal_connect (item, "toggled",
589                       G_CALLBACK (toggle_label_preference), dict_view);
590
591     gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
592
593     item = gtk_separator_menu_item_new ();
594     gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
595
596     item = gtk_radio_menu_item_new_with_label (group, _("Unsorted (dictionary order)"));
597     group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (item));
598     gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (item), TRUE);
599     gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
600     g_signal_connect (item, "toggled", G_CALLBACK (set_sort_criteria_unsorted), dict_view);
601
602     item = gtk_radio_menu_item_new_with_label (group, _("Sort by name"));
603     group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (item));
604     gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
605     g_signal_connect (item, "toggled", G_CALLBACK (set_sort_criteria_name), dict_view);
606
607     item = gtk_radio_menu_item_new_with_label (group, _("Sort by label"));
608     group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (item));
609     gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
610     g_signal_connect (item, "toggled", G_CALLBACK (set_sort_criteria_label), dict_view);
611   }
612
613   gtk_widget_show_all (dict_view->menu);
614
615   g_signal_connect (dict_view, "button-press-event",
616                     G_CALLBACK (show_menu), NULL);
617 }
618
619
620 GtkWidget*
621 psppire_dict_view_new (void)
622 {
623   return GTK_WIDGET (g_object_new (psppire_dict_view_get_type (), NULL));
624 }
625
626 static struct variable *
627 psppire_dict_view_iter_to_var (PsppireDictView *dict_view,
628                                GtkTreeIter *top_iter)
629 {
630   GtkTreeView *treeview = GTK_TREE_VIEW (dict_view);
631   GtkTreeModel *top_model = gtk_tree_view_get_model (treeview);
632
633   struct variable *var;
634   GtkTreeModel *model;
635   GtkTreeIter iter;
636
637   get_base_model (top_model, top_iter, &model, &iter);
638
639   g_assert (PSPPIRE_IS_DICT (model));
640
641   gtk_tree_model_get (model,
642                       &iter, DICT_TVM_COL_VAR, &var, -1);
643
644   return var;
645 }
646
647 struct get_vars_aux
648   {
649     PsppireDictView *dict_view;
650     struct variable **vars;
651     size_t idx;
652   };
653
654 static void
655 get_vars_cb (GtkTreeModel *model, GtkTreePath *path, GtkTreeIter *iter,
656              gpointer data)
657 {
658   struct get_vars_aux *aux = data;
659   struct variable *var = psppire_dict_view_iter_to_var (aux->dict_view, iter);
660
661   g_return_if_fail (var != NULL);
662   aux->vars[aux->idx++] = var;
663 }
664
665 void
666 psppire_dict_view_get_selected_variables (PsppireDictView *dict_view,
667                                           struct variable ***vars,
668                                           size_t *n_varsp)
669 {
670   GtkTreeView *tree_view = GTK_TREE_VIEW (dict_view);
671   GtkTreeSelection *selection = gtk_tree_view_get_selection (tree_view);
672   gint n_vars = gtk_tree_selection_count_selected_rows (selection);
673   struct get_vars_aux aux;
674
675   *vars = g_malloc_n (n_vars, sizeof **vars);
676
677   aux.dict_view = dict_view;
678   aux.vars = *vars;
679   aux.idx = 0;
680   gtk_tree_selection_selected_foreach (selection, get_vars_cb, &aux);
681
682   *n_varsp = aux.idx;
683   g_return_if_fail (aux.idx >= n_vars);
684 }
685
686 struct variable *
687 psppire_dict_view_get_selected_variable (PsppireDictView *dict_view)
688 {
689   GtkTreeView *tree_view = GTK_TREE_VIEW (dict_view);
690   GtkTreeSelection *selection = gtk_tree_view_get_selection (tree_view);
691   GtkTreeIter iter;
692
693   if (gtk_tree_selection_get_selected (selection, NULL, &iter))
694     return psppire_dict_view_iter_to_var (dict_view, &iter);
695   else
696     return NULL;
697 }
698
699