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));
109 ssw_init_iface (GListModelInterface *iface)
111 iface->get_n_items = gni;
112 iface->get_item = gi;
113 iface->get_item_type = git;
117 /* --- variables --- */
118 static GObjectClass *parent_class = NULL;
120 static guint signals [n_SIGNALS];
122 /* --- functions --- */
124 * psppire_dict_get_type:
125 * @returns: the type ID for accelerator groups.
128 psppire_dict_get_type (void)
130 static GType object_type = 0;
134 static const GTypeInfo object_info = {
135 sizeof (PsppireDictClass),
136 (GBaseInitFunc) NULL,
137 (GBaseFinalizeFunc) NULL,
138 (GClassInitFunc) psppire_dict_class_init,
139 NULL, /* class_finalize */
140 NULL, /* class_data */
141 sizeof (PsppireDict),
143 (GInstanceInitFunc) psppire_dict_init,
146 static const GInterfaceInfo tree_model_info = {
147 (GInterfaceInitFunc) dictionary_tree_model_init,
152 static const GInterfaceInfo list_model_info = {
153 (GInterfaceInitFunc) ssw_init_iface,
158 object_type = g_type_register_static (G_TYPE_OBJECT,
162 g_type_add_interface_static (object_type, GTK_TYPE_TREE_MODEL,
165 g_type_add_interface_static (object_type, G_TYPE_LIST_MODEL,
174 psppire_dict_class_init (PsppireDictClass *class)
176 GObjectClass *object_class = G_OBJECT_CLASS (class);
178 parent_class = g_type_class_peek_parent (class);
180 object_class->dispose = psppire_dict_dispose;
182 signals [VARIABLE_CHANGED] =
183 g_signal_new ("variable-changed",
184 G_TYPE_FROM_CLASS (class),
188 psppire_marshal_VOID__INT_UINT_POINTER,
198 signals [VARIABLE_INSERTED] =
199 g_signal_new ("variable-inserted",
200 G_TYPE_FROM_CLASS (class),
204 g_cclosure_marshal_VOID__INT,
210 signals [VARIABLE_DELETED] =
211 g_signal_new ("variable-deleted",
212 G_TYPE_FROM_CLASS (class),
216 psppire_marshal_VOID__POINTER_INT_INT,
224 signals [WEIGHT_CHANGED] =
225 g_signal_new ("weight-changed",
226 G_TYPE_FROM_CLASS (class),
230 g_cclosure_marshal_VOID__INT,
236 signals [FILTER_CHANGED] =
237 g_signal_new ("filter-changed",
238 G_TYPE_FROM_CLASS (class),
242 g_cclosure_marshal_VOID__INT,
248 signals [SPLIT_CHANGED] =
249 g_signal_new ("split-changed",
250 G_TYPE_FROM_CLASS (class),
254 g_cclosure_marshal_VOID__VOID,
260 psppire_dict_dispose (GObject *object)
262 PsppireDict *d = PSPPIRE_DICT (object);
264 dict_set_callbacks (d->dict, NULL, NULL);
266 G_OBJECT_CLASS (parent_class)->dispose (object);
269 /* Pass on callbacks from src/data/dictionary, as
270 signals in the Gtk library */
272 addcb (struct dictionary *d, int idx, void *pd)
274 PsppireDict *dict = PSPPIRE_DICT (pd);
276 if ( ! dict->disable_insert_signal)
278 g_signal_emit (dict, signals [VARIABLE_INSERTED], 0, idx);
279 g_signal_emit_by_name (dict, "items-changed", idx, 1, 1);
284 delcb (struct dictionary *d, const struct variable *var,
285 int dict_idx, int case_idx, void *pd)
287 g_signal_emit (pd, signals [VARIABLE_DELETED], 0,
288 var, dict_idx, case_idx);
289 g_signal_emit_by_name (pd, "items-changed", dict_idx, 1, 0);
293 mutcb (struct dictionary *d, int idx, unsigned int what, const struct variable *oldvar, void *pd)
295 g_signal_emit (pd, signals [VARIABLE_CHANGED], 0, idx, what, oldvar);
296 g_signal_emit_by_name (pd, "items-changed", idx, 1, 1);
300 weight_changed_callback (struct dictionary *d, int idx, void *pd)
302 g_signal_emit (pd, signals [WEIGHT_CHANGED], 0, idx);
306 filter_changed_callback (struct dictionary *d, int idx, void *pd)
308 g_signal_emit (pd, signals [FILTER_CHANGED], 0, idx);
312 split_changed_callback (struct dictionary *d, void *pd)
314 g_signal_emit (pd, signals [SPLIT_CHANGED], 0);
317 static const struct dict_callbacks gui_callbacks =
322 weight_changed_callback,
323 filter_changed_callback,
324 split_changed_callback
328 psppire_dict_init (PsppireDict *psppire_dict)
330 psppire_dict->stamp = g_random_int ();
331 psppire_dict->disable_insert_signal = FALSE;
335 * psppire_dict_new_from_dict:
336 * @returns: a new #PsppireDict object
338 * Creates a new #PsppireDict.
341 psppire_dict_new_from_dict (struct dictionary *d)
343 PsppireDict *new_dict = g_object_new (PSPPIRE_TYPE_DICT, NULL);
346 dict_set_callbacks (new_dict->dict, &gui_callbacks, new_dict);
353 psppire_dict_replace_dictionary (PsppireDict *dict, struct dictionary *d)
355 struct variable *var = dict_get_weight (d);
357 guint old_n = dict_get_var_cnt (dict->dict);
358 guint new_n = dict_get_var_cnt (d);
362 weight_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
364 var = dict_get_filter (d);
365 filter_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
367 split_changed_callback (d, dict);
369 dict_set_callbacks (dict->dict, &gui_callbacks, dict);
371 g_signal_emit_by_name (dict, "items-changed", 0, old_n, new_n);
375 /* Stores a valid name for a new variable in DICT into the SIZE bytes in NAME.
376 Returns true if successful, false if SIZE is insufficient. */
378 psppire_dict_generate_name (const PsppireDict *dict, char *name, size_t size)
386 /* TRANSLATORS: This string must be a valid variable name. That means:
387 - The string must be at most 64 bytes (not characters) long.
388 - The string may not contain whitespace.
389 - The first character may not be '$'
390 - The first character may not be a digit
391 - The final character may not be '.' or '_'
393 len = snprintf (name, size, _("Var%04d"), d);
397 if (psppire_dict_lookup_var (dict, name) == NULL)
404 /* Insert a new variable at posn IDX, with the name NAME, and return the
406 If NAME is null, then a name will be automatically assigned.
409 psppire_dict_insert_variable (PsppireDict *d, gint idx, const gchar *name)
411 struct variable *var;
414 g_return_val_if_fail (idx >= 0, NULL);
415 g_return_val_if_fail (d, NULL);
416 g_return_val_if_fail (PSPPIRE_IS_DICT (d), NULL);
420 if (!psppire_dict_generate_name (d, tmpname, sizeof tmpname))
421 g_return_val_if_reached (NULL);
426 d->disable_insert_signal = TRUE;
428 var = dict_create_var (d->dict, name, 0);
430 dict_reorder_var (d->dict, var, idx);
432 d->disable_insert_signal = FALSE;
434 g_signal_emit (d, signals[VARIABLE_INSERTED], 0, idx);
435 g_signal_emit_by_name (d, "items-changed", idx, 0, 1);
440 /* Delete N variables beginning at FIRST */
442 psppire_dict_delete_variables (PsppireDict *d, gint first, gint n)
445 g_return_if_fail (d);
446 g_return_if_fail (d->dict);
447 g_return_if_fail (PSPPIRE_IS_DICT (d));
449 for (idx = 0 ; idx < n ; ++idx )
451 struct variable *var;
453 /* Do nothing if it's out of bounds */
454 if ( first >= dict_get_var_cnt (d->dict))
457 var = dict_get_var (d->dict, first);
458 dict_delete_var (d->dict, var);
464 psppire_dict_set_name (PsppireDict* d, gint idx, const gchar *name)
466 struct variable *var;
468 g_assert (PSPPIRE_IS_DICT (d));
470 if ( ! dict_id_is_valid (d->dict, name, false))
473 if ( idx < dict_get_var_cnt (d->dict))
475 /* This is an existing variable? */
476 var = dict_get_var (d->dict, idx);
477 dict_rename_var (d->dict, var, name);
482 dict_create_var (d->dict, name, 0);
490 /* Return the IDXth variable.
491 Will return NULL if IDX exceeds the number of variables in the dictionary.
494 psppire_dict_get_variable (const PsppireDict *d, gint idx)
496 g_return_val_if_fail (d, NULL);
497 g_return_val_if_fail (d->dict, NULL);
499 if ( dict_get_var_cnt (d->dict) <= idx )
502 return dict_get_var (d->dict, idx);
506 /* Return the number of variables in the dictionary */
508 psppire_dict_get_var_cnt (const PsppireDict *d)
510 g_return_val_if_fail (d, -1);
511 g_return_val_if_fail (d->dict, -1);
513 return dict_get_var_cnt (d->dict);
517 /* Return the number of `union value's in the dictionary */
519 psppire_dict_get_value_cnt (const PsppireDict *d)
521 g_return_val_if_fail (d, -1);
522 g_return_val_if_fail (d->dict, -1);
524 return dict_get_next_value_idx (d->dict);
528 /* Returns the prototype for the cases that match the dictionary */
529 const struct caseproto *
530 psppire_dict_get_proto (const PsppireDict *d)
532 g_return_val_if_fail (d, NULL);
533 g_return_val_if_fail (d->dict, NULL);
535 return dict_get_proto (d->dict);
539 /* Return a variable by name.
540 Return NULL if it doesn't exist
543 psppire_dict_lookup_var (const PsppireDict *d, const gchar *name)
545 g_return_val_if_fail (d, NULL);
546 g_return_val_if_fail (d->dict, NULL);
548 return dict_lookup_var (d->dict, name);
551 /* Clears the contents of D */
553 psppire_dict_clear (PsppireDict *d)
555 g_return_if_fail (d);
556 g_return_if_fail (d->dict);
559 dict_clear (d->dict);
564 /* Return true if NAME would be a valid name of a variable to add to the
565 dictionary. False otherwise.
566 If REPORT is true, then invalid names will be reported as such as errors
569 psppire_dict_check_name (const PsppireDict *dict,
570 const gchar *name, gboolean report)
572 if ( ! dict_id_is_valid (dict->dict, name, report ) )
575 if (psppire_dict_lookup_var (dict, name))
578 msg (ME, _("Duplicate variable name."));
587 psppire_dict_get_next_value_idx (const PsppireDict *dict)
589 return dict_get_next_value_idx (dict->dict);
593 /* Tree Model Stuff */
595 static GtkTreeModelFlags tree_model_get_flags (GtkTreeModel *model);
597 static gint tree_model_n_columns (GtkTreeModel *model);
599 static GType tree_model_column_type (GtkTreeModel *model, gint index);
601 static gboolean tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter,
604 static gboolean tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter);
606 static GtkTreePath * tree_model_get_path (GtkTreeModel *model,
609 static void tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
610 gint column, GValue *value);
612 static gboolean tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
613 GtkTreeIter *parent, gint n);
615 static gint tree_model_n_children (GtkTreeModel *tree_model,
618 static gboolean tree_model_iter_children (GtkTreeModel *,
622 static gboolean tree_model_iter_parent (GtkTreeModel *tree_model,
626 static gboolean tree_model_iter_has_child (GtkTreeModel *tree_model,
630 dictionary_tree_model_init (GtkTreeModelIface *iface)
632 iface->get_flags = tree_model_get_flags;
633 iface->get_n_columns = tree_model_n_columns;
634 iface->get_column_type = tree_model_column_type;
635 iface->get_iter = tree_model_get_iter;
636 iface->iter_next = tree_model_iter_next;
637 iface->get_path = tree_model_get_path;
638 iface->get_value = tree_model_get_value;
640 iface->iter_children = tree_model_iter_children ;
641 iface->iter_has_child = tree_model_iter_has_child ;
642 iface->iter_n_children = tree_model_n_children ;
643 iface->iter_nth_child = tree_model_nth_child ;
644 iface->iter_parent = tree_model_iter_parent ;
648 tree_model_iter_has_child (GtkTreeModel *tree_model,
655 tree_model_iter_parent (GtkTreeModel *tree_model,
662 static GtkTreeModelFlags
663 tree_model_get_flags (GtkTreeModel *model)
665 g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GtkTreeModelFlags) 0);
667 return GTK_TREE_MODEL_LIST_ONLY;
672 tree_model_n_columns (GtkTreeModel *model)
678 tree_model_column_type (GtkTreeModel *model, gint index)
680 g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GType) 0);
686 case DICT_TVM_COL_NAME:
687 case DICT_TVM_COL_LABEL:
690 case DICT_TVM_COL_DECIMAL:
691 case DICT_TVM_COL_WIDTH:
692 case DICT_TVM_COL_COLUMNS:
695 case DICT_TVM_COL_VAR:
696 t = PSPPIRE_VAR_PTR_TYPE;
698 case DICT_TVM_COL_ALIGNMENT:
701 case DICT_TVM_COL_MEASURE:
702 t = measure_enum_type;
704 case DICT_TVM_COL_ROLE:
713 tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter, GtkTreePath *path)
715 gint *indices, depth;
717 struct variable *var;
719 PsppireDict *dict = PSPPIRE_DICT (model);
721 g_return_val_if_fail (path, FALSE);
723 indices = gtk_tree_path_get_indices (path);
724 depth = gtk_tree_path_get_depth (path);
726 g_return_val_if_fail (depth == 1, FALSE);
730 if ( n < 0 || n >= psppire_dict_get_var_cnt (dict))
733 iter->user_data = NULL;
737 var = psppire_dict_get_variable (dict, n);
739 g_assert (var_get_dict_index (var) == n);
741 iter->stamp = dict->stamp;
742 iter->user_data = var;
749 tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter)
751 PsppireDict *dict = PSPPIRE_DICT (model);
752 struct variable *var;
755 if ( iter == NULL || iter->user_data == NULL)
758 g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
760 var = iter->user_data;
762 idx = var_get_dict_index (var);
764 if ( idx + 1 >= psppire_dict_get_var_cnt (dict))
766 iter->user_data = NULL;
771 var = psppire_dict_get_variable (dict, idx + 1);
773 g_assert (var_get_dict_index (var) == idx + 1);
775 iter->user_data = var;
781 tree_model_get_path (GtkTreeModel *model, GtkTreeIter *iter)
784 struct variable *var;
785 PsppireDict *dict = PSPPIRE_DICT (model);
787 g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
789 var = iter->user_data;
791 path = gtk_tree_path_new ();
792 gtk_tree_path_append_index (path, var_get_dict_index (var));
797 const struct fmt_spec *var_get_write_format (const struct variable *);
800 tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
801 gint column, GValue *value)
803 struct variable *var;
804 PsppireDict *dict = PSPPIRE_DICT (model);
806 g_return_if_fail (iter->stamp == dict->stamp);
808 var = iter->user_data;
810 const struct fmt_spec *fs = var_get_write_format (var);
814 case DICT_TVM_COL_NAME:
815 g_value_init (value, G_TYPE_STRING);
816 g_value_set_string (value, var_get_name (var));
818 case DICT_TVM_COL_WIDTH:
819 g_value_init (value, G_TYPE_INT);
820 g_value_set_int (value, fs->w);
822 case DICT_TVM_COL_DECIMAL:
823 g_value_init (value, G_TYPE_INT);
824 g_value_set_int (value, fs->d);
826 case DICT_TVM_COL_LABEL:
827 g_value_init (value, G_TYPE_STRING);
828 g_value_set_string (value, var_get_label (var));
830 case DICT_TVM_COL_COLUMNS:
831 g_value_init (value, G_TYPE_INT);
832 g_value_set_int (value, var_get_display_width (var));
834 case DICT_TVM_COL_ALIGNMENT:
835 g_value_init (value, align_enum_type);
836 g_value_set_enum (value, var_get_alignment (var));
838 case DICT_TVM_COL_MEASURE:
839 g_value_init (value, measure_enum_type);
840 g_value_set_enum (value, var_get_measure (var));
842 case DICT_TVM_COL_ROLE:
843 g_value_init (value, role_enum_type);
844 g_value_set_enum (value, var_get_role (var));
846 case DICT_TVM_COL_VAR:
847 g_value_init (value, PSPPIRE_VAR_PTR_TYPE);
848 g_value_set_boxed (value, var);
851 g_value_init (value, G_TYPE_STRING);
852 g_value_set_string (value, "????");
858 tree_model_iter_children (GtkTreeModel *tree_model,
866 tree_model_n_children (GtkTreeModel *model,
869 PsppireDict *dict = PSPPIRE_DICT (model);
872 return psppire_dict_get_var_cnt (dict);
878 tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
879 GtkTreeIter *parent, gint n)
883 g_return_val_if_fail (PSPPIRE_IS_DICT (model), FALSE);
885 dict = PSPPIRE_DICT (model);
890 if ( n >= psppire_dict_get_var_cnt (dict) )
893 iter->stamp = dict->stamp;
894 iter->user_data = psppire_dict_get_variable (dict, n);
896 if ( !iter->user_data)
904 psppire_dict_rename_var (PsppireDict *dict, struct variable *v,
907 if ( ! dict_id_is_valid (dict->dict, name, false))
910 /* Make sure no other variable has this name */
911 if ( NULL != psppire_dict_lookup_var (dict, name))
914 dict_rename_var (dict->dict, v, name);
921 psppire_dict_get_weight_variable (const PsppireDict *dict)
923 return dict_get_weight (dict->dict);
930 psppire_dict_dump (const PsppireDict *dict)
933 const struct dictionary *d = dict->dict;
935 for (i = 0; i < dict_get_var_cnt (d); ++i)
937 const struct variable *v = psppire_dict_get_variable (dict, i);
938 int di = var_get_dict_index (v);
939 g_print ("`%s' idx=%d, fv=%d\n",
942 var_get_case_index(v));
952 psppire_dict_encoding (const PsppireDict *dict)
954 return dict_get_encoding (dict->dict);