1 /* PSPPIRE - a graphical user interface for PSPP.
2 Copyright (C) 2004, 2006, 2007, 2009, 2010, 2011, 2012,
3 2016, 2017 Free Software Foundation
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.
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.
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/>. */
20 #include "ui/gui/psppire-dict.h"
26 #include "data/dictionary.h"
27 #include "data/identifier.h"
28 #include "data/missing-values.h"
29 #include "data/value-labels.h"
30 #include "data/variable.h"
31 #include "libpspp/i18n.h"
32 #include "libpspp/message.h"
33 #include "ui/gui/helper.h"
34 #include "ui/gui/psppire-marshal.h"
35 #include "ui/gui/psppire-var-ptr.h"
37 #include <gobject/genums.h>
40 #define _(msgid) gettext (msgid)
41 #define N_(msgid) msgid
45 GType align_enum_type;
46 GType measure_enum_type;
62 /* --- prototypes --- */
63 static void psppire_dict_class_init (PsppireDictClass *class);
64 static void psppire_dict_init (PsppireDict *dict);
65 static void psppire_dict_dispose (GObject *object);
67 static void dictionary_tree_model_init (GtkTreeModelIface *iface);
72 gni (GListModel *list)
74 PsppireDict *dict = PSPPIRE_DICT (list);
76 return psppire_dict_get_var_cnt (dict);
80 git (GListModel *list)
82 return GTK_TYPE_BUTTON;
86 gi (GListModel *list, guint id)
88 GtkWidget *button = gtk_button_new ();
90 PsppireDict *dict = PSPPIRE_DICT (list);
92 if (id >= psppire_dict_get_var_cnt (dict))
94 gtk_button_set_label (GTK_BUTTON (button), _("Var"));
98 const struct variable *v = psppire_dict_get_variable (dict, id);
100 gtk_button_set_label (GTK_BUTTON (button), var_get_name (v));
101 gtk_widget_set_tooltip_text (button, var_get_label (v));
105 PangoContext *context = gtk_widget_create_pango_context (button);
106 PangoLayout *layout = pango_layout_new (context);
108 pango_layout_set_text (layout, "M", 1);
110 pango_layout_get_extents (layout, NULL, &rect);
112 g_object_unref (G_OBJECT (layout));
113 g_object_unref (G_OBJECT (context));
115 gtk_widget_set_size_request (button,
116 var_get_display_width (v) * rect.width / PANGO_SCALE,
125 ssw_init_iface (GListModelInterface *iface)
127 iface->get_n_items = gni;
128 iface->get_item = gi;
129 iface->get_item_type = git;
133 /* --- variables --- */
134 static GObjectClass *parent_class = NULL;
136 static guint signals [n_SIGNALS];
138 /* --- functions --- */
140 * psppire_dict_get_type:
141 * @returns: the type ID for accelerator groups.
144 psppire_dict_get_type (void)
146 static GType object_type = 0;
150 static const GTypeInfo object_info = {
151 sizeof (PsppireDictClass),
152 (GBaseInitFunc) NULL,
153 (GBaseFinalizeFunc) NULL,
154 (GClassInitFunc) psppire_dict_class_init,
155 NULL, /* class_finalize */
156 NULL, /* class_data */
157 sizeof (PsppireDict),
159 (GInstanceInitFunc) psppire_dict_init,
162 static const GInterfaceInfo tree_model_info = {
163 (GInterfaceInitFunc) dictionary_tree_model_init,
168 static const GInterfaceInfo list_model_info = {
169 (GInterfaceInitFunc) ssw_init_iface,
174 object_type = g_type_register_static (G_TYPE_OBJECT,
178 g_type_add_interface_static (object_type, GTK_TYPE_TREE_MODEL,
181 g_type_add_interface_static (object_type, G_TYPE_LIST_MODEL,
190 psppire_dict_class_init (PsppireDictClass *class)
192 GObjectClass *object_class = G_OBJECT_CLASS (class);
194 parent_class = g_type_class_peek_parent (class);
196 object_class->dispose = psppire_dict_dispose;
198 signals [VARIABLE_CHANGED] =
199 g_signal_new ("variable-changed",
200 G_TYPE_FROM_CLASS (class),
204 psppire_marshal_VOID__INT_UINT_POINTER,
214 signals [VARIABLE_INSERTED] =
215 g_signal_new ("variable-inserted",
216 G_TYPE_FROM_CLASS (class),
220 g_cclosure_marshal_VOID__INT,
226 signals [VARIABLE_DELETED] =
227 g_signal_new ("variable-deleted",
228 G_TYPE_FROM_CLASS (class),
232 psppire_marshal_VOID__POINTER_INT_INT,
240 signals [WEIGHT_CHANGED] =
241 g_signal_new ("weight-changed",
242 G_TYPE_FROM_CLASS (class),
246 g_cclosure_marshal_VOID__INT,
252 signals [FILTER_CHANGED] =
253 g_signal_new ("filter-changed",
254 G_TYPE_FROM_CLASS (class),
258 g_cclosure_marshal_VOID__INT,
264 signals [SPLIT_CHANGED] =
265 g_signal_new ("split-changed",
266 G_TYPE_FROM_CLASS (class),
270 g_cclosure_marshal_VOID__VOID,
276 psppire_dict_dispose (GObject *object)
278 PsppireDict *d = PSPPIRE_DICT (object);
280 dict_set_callbacks (d->dict, NULL, NULL);
282 G_OBJECT_CLASS (parent_class)->dispose (object);
285 /* Pass on callbacks from src/data/dictionary, as
286 signals in the Gtk library */
288 addcb (struct dictionary *d, int idx, void *pd)
290 PsppireDict *dict = PSPPIRE_DICT (pd);
292 if ( ! dict->disable_insert_signal)
294 g_signal_emit (dict, signals [VARIABLE_INSERTED], 0, idx);
295 g_signal_emit_by_name (dict, "items-changed", idx, 1, 1);
300 delcb (struct dictionary *d, const struct variable *var,
301 int dict_idx, int case_idx, void *pd)
303 g_signal_emit (pd, signals [VARIABLE_DELETED], 0,
304 var, dict_idx, case_idx);
305 g_signal_emit_by_name (pd, "items-changed", dict_idx, 1, 0);
309 mutcb (struct dictionary *d, int idx, unsigned int what, const struct variable *oldvar, void *pd)
311 g_signal_emit (pd, signals [VARIABLE_CHANGED], 0, idx, what, oldvar);
312 g_signal_emit_by_name (pd, "items-changed", idx, 1, 1);
316 weight_changed_callback (struct dictionary *d, int idx, void *pd)
318 g_signal_emit (pd, signals [WEIGHT_CHANGED], 0, idx);
322 filter_changed_callback (struct dictionary *d, int idx, void *pd)
324 g_signal_emit (pd, signals [FILTER_CHANGED], 0, idx);
328 split_changed_callback (struct dictionary *d, void *pd)
330 g_signal_emit (pd, signals [SPLIT_CHANGED], 0);
333 static const struct dict_callbacks gui_callbacks =
338 weight_changed_callback,
339 filter_changed_callback,
340 split_changed_callback
344 psppire_dict_init (PsppireDict *psppire_dict)
346 psppire_dict->stamp = g_random_int ();
347 psppire_dict->disable_insert_signal = FALSE;
351 * psppire_dict_new_from_dict:
352 * @returns: a new #PsppireDict object
354 * Creates a new #PsppireDict.
357 psppire_dict_new_from_dict (struct dictionary *d)
359 PsppireDict *new_dict = g_object_new (PSPPIRE_TYPE_DICT, NULL);
362 dict_set_callbacks (new_dict->dict, &gui_callbacks, new_dict);
369 psppire_dict_replace_dictionary (PsppireDict *dict, struct dictionary *d)
371 struct variable *var = dict_get_weight (d);
373 guint old_n = dict_get_var_cnt (dict->dict);
374 guint new_n = dict_get_var_cnt (d);
378 weight_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
380 var = dict_get_filter (d);
381 filter_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
383 split_changed_callback (d, dict);
385 dict_set_callbacks (dict->dict, &gui_callbacks, dict);
387 g_signal_emit_by_name (dict, "items-changed", 0, old_n, new_n);
391 /* Stores a valid name for a new variable in DICT into the SIZE bytes in NAME.
392 Returns true if successful, false if SIZE is insufficient. */
394 psppire_dict_generate_name (const PsppireDict *dict, char *name, size_t size)
402 /* TRANSLATORS: This string must be a valid variable name. That means:
403 - The string must be at most 64 bytes (not characters) long.
404 - The string may not contain whitespace.
405 - The first character may not be '$'
406 - The first character may not be a digit
407 - The final character may not be '.' or '_'
409 len = snprintf (name, size, _("Var%04d"), d);
413 if (psppire_dict_lookup_var (dict, name) == NULL)
420 /* Insert a new variable at posn IDX, with the name NAME, and return the
422 If NAME is null, then a name will be automatically assigned.
425 psppire_dict_insert_variable (PsppireDict *d, gint idx, const gchar *name)
427 struct variable *var;
430 g_return_val_if_fail (idx >= 0, NULL);
431 g_return_val_if_fail (d, NULL);
432 g_return_val_if_fail (PSPPIRE_IS_DICT (d), NULL);
436 if (!psppire_dict_generate_name (d, tmpname, sizeof tmpname))
437 g_return_val_if_reached (NULL);
442 d->disable_insert_signal = TRUE;
444 var = dict_create_var (d->dict, name, 0);
446 dict_reorder_var (d->dict, var, idx);
448 d->disable_insert_signal = FALSE;
450 g_signal_emit (d, signals[VARIABLE_INSERTED], 0, idx);
451 g_signal_emit_by_name (d, "items-changed", idx, 0, 1);
456 /* Delete N variables beginning at FIRST */
458 psppire_dict_delete_variables (PsppireDict *d, gint first, gint n)
461 g_return_if_fail (d);
462 g_return_if_fail (d->dict);
463 g_return_if_fail (PSPPIRE_IS_DICT (d));
465 for (idx = 0 ; idx < n ; ++idx )
467 struct variable *var;
469 /* Do nothing if it's out of bounds */
470 if ( first >= dict_get_var_cnt (d->dict))
473 var = dict_get_var (d->dict, first);
474 dict_delete_var (d->dict, var);
480 psppire_dict_set_name (PsppireDict* d, gint idx, const gchar *name)
482 struct variable *var;
484 g_assert (PSPPIRE_IS_DICT (d));
486 if ( ! dict_id_is_valid (d->dict, name, false))
489 if ( idx < dict_get_var_cnt (d->dict))
491 /* This is an existing variable? */
492 var = dict_get_var (d->dict, idx);
493 dict_rename_var (d->dict, var, name);
498 dict_create_var (d->dict, name, 0);
506 /* Return the IDXth variable.
507 Will return NULL if IDX exceeds the number of variables in the dictionary.
510 psppire_dict_get_variable (const PsppireDict *d, gint idx)
512 g_return_val_if_fail (d, NULL);
513 g_return_val_if_fail (d->dict, NULL);
515 if ( dict_get_var_cnt (d->dict) <= idx )
518 return dict_get_var (d->dict, idx);
522 /* Return the number of variables in the dictionary */
524 psppire_dict_get_var_cnt (const PsppireDict *d)
526 g_return_val_if_fail (d, -1);
527 g_return_val_if_fail (d->dict, -1);
529 return dict_get_var_cnt (d->dict);
533 /* Return the number of `union value's in the dictionary */
535 psppire_dict_get_value_cnt (const PsppireDict *d)
537 g_return_val_if_fail (d, -1);
538 g_return_val_if_fail (d->dict, -1);
540 return dict_get_next_value_idx (d->dict);
544 /* Returns the prototype for the cases that match the dictionary */
545 const struct caseproto *
546 psppire_dict_get_proto (const PsppireDict *d)
548 g_return_val_if_fail (d, NULL);
549 g_return_val_if_fail (d->dict, NULL);
551 return dict_get_proto (d->dict);
555 /* Return a variable by name.
556 Return NULL if it doesn't exist
559 psppire_dict_lookup_var (const PsppireDict *d, const gchar *name)
561 g_return_val_if_fail (d, NULL);
562 g_return_val_if_fail (d->dict, NULL);
564 return dict_lookup_var (d->dict, name);
567 /* Clears the contents of D */
569 psppire_dict_clear (PsppireDict *d)
571 g_return_if_fail (d);
572 g_return_if_fail (d->dict);
575 dict_clear (d->dict);
580 /* Return true if NAME would be a valid name of a variable to add to the
581 dictionary. False otherwise.
582 If REPORT is true, then invalid names will be reported as such as errors
585 psppire_dict_check_name (const PsppireDict *dict,
586 const gchar *name, gboolean report)
588 if ( ! dict_id_is_valid (dict->dict, name, report ) )
591 if (psppire_dict_lookup_var (dict, name))
594 msg (ME, _("Duplicate variable name."));
603 psppire_dict_get_next_value_idx (const PsppireDict *dict)
605 return dict_get_next_value_idx (dict->dict);
609 /* Tree Model Stuff */
611 static GtkTreeModelFlags tree_model_get_flags (GtkTreeModel *model);
613 static gint tree_model_n_columns (GtkTreeModel *model);
615 static GType tree_model_column_type (GtkTreeModel *model, gint index);
617 static gboolean tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter,
620 static gboolean tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter);
622 static GtkTreePath * tree_model_get_path (GtkTreeModel *model,
625 static void tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
626 gint column, GValue *value);
628 static gboolean tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
629 GtkTreeIter *parent, gint n);
631 static gint tree_model_n_children (GtkTreeModel *tree_model,
634 static gboolean tree_model_iter_children (GtkTreeModel *,
638 static gboolean tree_model_iter_parent (GtkTreeModel *tree_model,
642 static gboolean tree_model_iter_has_child (GtkTreeModel *tree_model,
646 dictionary_tree_model_init (GtkTreeModelIface *iface)
648 iface->get_flags = tree_model_get_flags;
649 iface->get_n_columns = tree_model_n_columns;
650 iface->get_column_type = tree_model_column_type;
651 iface->get_iter = tree_model_get_iter;
652 iface->iter_next = tree_model_iter_next;
653 iface->get_path = tree_model_get_path;
654 iface->get_value = tree_model_get_value;
656 iface->iter_children = tree_model_iter_children ;
657 iface->iter_has_child = tree_model_iter_has_child ;
658 iface->iter_n_children = tree_model_n_children ;
659 iface->iter_nth_child = tree_model_nth_child ;
660 iface->iter_parent = tree_model_iter_parent ;
664 tree_model_iter_has_child (GtkTreeModel *tree_model,
671 tree_model_iter_parent (GtkTreeModel *tree_model,
678 static GtkTreeModelFlags
679 tree_model_get_flags (GtkTreeModel *model)
681 g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GtkTreeModelFlags) 0);
683 return GTK_TREE_MODEL_LIST_ONLY;
688 tree_model_n_columns (GtkTreeModel *model)
694 tree_model_column_type (GtkTreeModel *model, gint index)
696 g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GType) 0);
702 case DICT_TVM_COL_NAME:
703 case DICT_TVM_COL_LABEL:
706 case DICT_TVM_COL_DECIMAL:
707 case DICT_TVM_COL_WIDTH:
708 case DICT_TVM_COL_COLUMNS:
711 case DICT_TVM_COL_VAR:
712 t = PSPPIRE_VAR_PTR_TYPE;
714 case DICT_TVM_COL_ALIGNMENT:
717 case DICT_TVM_COL_MEASURE:
718 t = measure_enum_type;
720 case DICT_TVM_COL_ROLE:
729 tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter, GtkTreePath *path)
731 gint *indices, depth;
733 struct variable *var;
735 PsppireDict *dict = PSPPIRE_DICT (model);
737 g_return_val_if_fail (path, FALSE);
739 indices = gtk_tree_path_get_indices (path);
740 depth = gtk_tree_path_get_depth (path);
742 g_return_val_if_fail (depth == 1, FALSE);
746 if ( n < 0 || n >= psppire_dict_get_var_cnt (dict))
749 iter->user_data = NULL;
753 var = psppire_dict_get_variable (dict, n);
755 g_assert (var_get_dict_index (var) == n);
757 iter->stamp = dict->stamp;
758 iter->user_data = var;
765 tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter)
767 PsppireDict *dict = PSPPIRE_DICT (model);
768 struct variable *var;
771 if ( iter == NULL || iter->user_data == NULL)
774 g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
776 var = iter->user_data;
778 idx = var_get_dict_index (var);
780 if ( idx + 1 >= psppire_dict_get_var_cnt (dict))
782 iter->user_data = NULL;
787 var = psppire_dict_get_variable (dict, idx + 1);
789 g_assert (var_get_dict_index (var) == idx + 1);
791 iter->user_data = var;
797 tree_model_get_path (GtkTreeModel *model, GtkTreeIter *iter)
800 struct variable *var;
801 PsppireDict *dict = PSPPIRE_DICT (model);
803 g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
805 var = iter->user_data;
807 path = gtk_tree_path_new ();
808 gtk_tree_path_append_index (path, var_get_dict_index (var));
813 const struct fmt_spec *var_get_write_format (const struct variable *);
816 tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
817 gint column, GValue *value)
819 struct variable *var;
820 PsppireDict *dict = PSPPIRE_DICT (model);
822 g_return_if_fail (iter->stamp == dict->stamp);
824 var = iter->user_data;
826 const struct fmt_spec *fs = var_get_write_format (var);
830 case DICT_TVM_COL_NAME:
831 g_value_init (value, G_TYPE_STRING);
832 g_value_set_string (value, var_get_name (var));
834 case DICT_TVM_COL_WIDTH:
835 g_value_init (value, G_TYPE_INT);
836 g_value_set_int (value, fs->w);
838 case DICT_TVM_COL_DECIMAL:
839 g_value_init (value, G_TYPE_INT);
840 g_value_set_int (value, fs->d);
842 case DICT_TVM_COL_LABEL:
843 g_value_init (value, G_TYPE_STRING);
844 g_value_set_string (value, var_get_label (var));
846 case DICT_TVM_COL_COLUMNS:
847 g_value_init (value, G_TYPE_INT);
848 g_value_set_int (value, var_get_display_width (var));
850 case DICT_TVM_COL_ALIGNMENT:
851 g_value_init (value, align_enum_type);
852 g_value_set_enum (value, var_get_alignment (var));
854 case DICT_TVM_COL_MEASURE:
855 g_value_init (value, measure_enum_type);
856 g_value_set_enum (value, var_get_measure (var));
858 case DICT_TVM_COL_ROLE:
859 g_value_init (value, role_enum_type);
860 g_value_set_enum (value, var_get_role (var));
862 case DICT_TVM_COL_VAR:
863 g_value_init (value, PSPPIRE_VAR_PTR_TYPE);
864 g_value_set_boxed (value, var);
867 g_value_init (value, G_TYPE_STRING);
868 g_value_set_string (value, "????");
874 tree_model_iter_children (GtkTreeModel *tree_model,
882 tree_model_n_children (GtkTreeModel *model,
885 PsppireDict *dict = PSPPIRE_DICT (model);
888 return psppire_dict_get_var_cnt (dict);
894 tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
895 GtkTreeIter *parent, gint n)
899 g_return_val_if_fail (PSPPIRE_IS_DICT (model), FALSE);
901 dict = PSPPIRE_DICT (model);
906 if ( n >= psppire_dict_get_var_cnt (dict) )
909 iter->stamp = dict->stamp;
910 iter->user_data = psppire_dict_get_variable (dict, n);
912 if ( !iter->user_data)
920 psppire_dict_rename_var (PsppireDict *dict, struct variable *v,
923 if ( ! dict_id_is_valid (dict->dict, name, false))
926 /* Make sure no other variable has this name */
927 if ( NULL != psppire_dict_lookup_var (dict, name))
930 dict_rename_var (dict->dict, v, name);
937 psppire_dict_get_weight_variable (const PsppireDict *dict)
939 return dict_get_weight (dict->dict);
946 psppire_dict_dump (const PsppireDict *dict)
949 const struct dictionary *d = dict->dict;
951 for (i = 0; i < dict_get_var_cnt (d); ++i)
953 const struct variable *v = psppire_dict_get_variable (dict, i);
954 int di = var_get_dict_index (v);
955 g_print ("`%s' idx=%d, fv=%d\n",
958 var_get_case_index(v));
968 psppire_dict_encoding (const PsppireDict *dict)
970 return dict_get_encoding (dict->dict);