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;
65 /* --- prototypes --- */
66 static void psppire_dict_class_init (PsppireDictClass *class);
67 static void psppire_dict_init (PsppireDict *dict);
68 static void psppire_dict_dispose (GObject *object);
70 static void dictionary_tree_model_init (GtkTreeModelIface *iface);
75 gni (GListModel *list)
77 PsppireDict *dict = PSPPIRE_DICT (list);
79 return psppire_dict_get_var_cnt (dict);
83 git (GListModel *list)
85 return GTK_TYPE_BUTTON;
89 gi (GListModel *list, guint id)
91 GtkWidget *button = gtk_button_new ();
93 PsppireDict *dict = PSPPIRE_DICT (list);
95 if (id >= psppire_dict_get_var_cnt (dict))
97 gtk_button_set_label (GTK_BUTTON (button), _("Var"));
101 const struct variable *v = psppire_dict_get_variable (dict, id);
103 gtk_button_set_label (GTK_BUTTON (button), var_get_name (v));
104 gtk_widget_set_tooltip_text (button, var_get_label (v));
107 PangoContext *context = gtk_widget_create_pango_context (button);
108 PangoLayout *layout = pango_layout_new (context);
111 pango_layout_set_text (layout, "M", 1);
113 pango_layout_get_extents (layout, NULL, &rect);
115 g_object_unref (G_OBJECT (layout));
116 g_object_unref (G_OBJECT (context));
118 gtk_widget_set_size_request (button,
119 (0.25 + var_get_display_width (v))
120 * rect.width / PANGO_SCALE,
130 ssw_init_iface (GListModelInterface *iface)
132 iface->get_n_items = gni;
133 iface->get_item = gi;
134 iface->get_item_type = git;
138 /* --- variables --- */
139 static GObjectClass *parent_class = NULL;
141 static guint signals [n_SIGNALS];
143 /* --- functions --- */
145 * psppire_dict_get_type:
146 * @returns: the type ID for accelerator groups.
149 psppire_dict_get_type (void)
151 static GType object_type = 0;
155 static const GTypeInfo object_info = {
156 sizeof (PsppireDictClass),
157 (GBaseInitFunc) NULL,
158 (GBaseFinalizeFunc) NULL,
159 (GClassInitFunc) psppire_dict_class_init,
160 NULL, /* class_finalize */
161 NULL, /* class_data */
162 sizeof (PsppireDict),
164 (GInstanceInitFunc) psppire_dict_init,
167 static const GInterfaceInfo tree_model_info = {
168 (GInterfaceInitFunc) dictionary_tree_model_init,
173 static const GInterfaceInfo list_model_info = {
174 (GInterfaceInitFunc) ssw_init_iface,
179 object_type = g_type_register_static (G_TYPE_OBJECT,
183 g_type_add_interface_static (object_type, GTK_TYPE_TREE_MODEL,
186 g_type_add_interface_static (object_type, G_TYPE_LIST_MODEL,
195 psppire_dict_class_init (PsppireDictClass *class)
197 GObjectClass *object_class = G_OBJECT_CLASS (class);
199 parent_class = g_type_class_peek_parent (class);
201 object_class->dispose = psppire_dict_dispose;
203 signals [RESIZE_ITEM] =
204 g_signal_new ("resize-item",
205 G_TYPE_FROM_CLASS (class),
209 psppire_marshal_BOOLEAN__INT_INT,
215 signals [VARIABLE_CHANGED] =
216 g_signal_new ("variable-changed",
217 G_TYPE_FROM_CLASS (class),
221 psppire_marshal_VOID__INT_UINT_POINTER,
228 signals [VARIABLE_INSERTED] =
229 g_signal_new ("variable-inserted",
230 G_TYPE_FROM_CLASS (class),
234 g_cclosure_marshal_VOID__INT,
239 signals [VARIABLE_DELETED] =
240 g_signal_new ("variable-deleted",
241 G_TYPE_FROM_CLASS (class),
245 psppire_marshal_VOID__POINTER_INT_INT,
252 signals [WEIGHT_CHANGED] =
253 g_signal_new ("weight-changed",
254 G_TYPE_FROM_CLASS (class),
258 g_cclosure_marshal_VOID__INT,
263 signals [FILTER_CHANGED] =
264 g_signal_new ("filter-changed",
265 G_TYPE_FROM_CLASS (class),
269 g_cclosure_marshal_VOID__INT,
274 signals [SPLIT_CHANGED] =
275 g_signal_new ("split-changed",
276 G_TYPE_FROM_CLASS (class),
280 g_cclosure_marshal_VOID__VOID,
286 psppire_dict_dispose (GObject *object)
288 PsppireDict *d = PSPPIRE_DICT (object);
290 dict_set_callbacks (d->dict, NULL, NULL);
291 dict_unref (d->dict);
293 G_OBJECT_CLASS (parent_class)->dispose (object);
296 /* Pass on callbacks from src/data/dictionary, as
297 signals in the Gtk library */
299 addcb (struct dictionary *d, int idx, void *pd)
301 PsppireDict *dict = PSPPIRE_DICT (pd);
303 if ( ! dict->disable_insert_signal)
305 g_signal_emit (dict, signals [VARIABLE_INSERTED], 0, idx);
306 g_signal_emit_by_name (dict, "items-changed", idx, 1, 1);
311 delcb (struct dictionary *d, const struct variable *var,
312 int dict_idx, int case_idx, void *pd)
314 g_signal_emit (pd, signals [VARIABLE_DELETED], 0,
315 var, dict_idx, case_idx);
316 g_signal_emit_by_name (pd, "items-changed", dict_idx, 1, 0);
320 mutcb (struct dictionary *d, int idx, unsigned int what, const struct variable *oldvar, void *pd)
322 g_signal_emit (pd, signals [VARIABLE_CHANGED], 0, idx, what, oldvar);
323 g_signal_emit_by_name (pd, "items-changed", idx, 1, 1);
327 weight_changed_callback (struct dictionary *d, int idx, void *pd)
329 g_signal_emit (pd, signals [WEIGHT_CHANGED], 0, idx);
333 filter_changed_callback (struct dictionary *d, int idx, void *pd)
335 g_signal_emit (pd, signals [FILTER_CHANGED], 0, idx);
339 split_changed_callback (struct dictionary *d, void *pd)
341 g_signal_emit (pd, signals [SPLIT_CHANGED], 0);
344 static const struct dict_callbacks gui_callbacks =
349 weight_changed_callback,
350 filter_changed_callback,
351 split_changed_callback
355 psppire_dict_init (PsppireDict *psppire_dict)
357 psppire_dict->stamp = g_random_int ();
358 psppire_dict->disable_insert_signal = FALSE;
362 * psppire_dict_new_from_dict:
363 * @returns: a new #PsppireDict object
365 * Creates a new #PsppireDict.
368 psppire_dict_new_from_dict (struct dictionary *d)
370 PsppireDict *new_dict = g_object_new (PSPPIRE_TYPE_DICT, NULL);
371 new_dict->dict = dict_ref (d);
373 dict_set_callbacks (new_dict->dict, &gui_callbacks, new_dict);
380 psppire_dict_replace_dictionary (PsppireDict *dict, struct dictionary *d)
382 const struct variable *var = dict_get_weight (d);
384 struct dictionary *old_dict = dict->dict;
386 guint old_n = dict_get_var_cnt (dict->dict);
387 guint new_n = dict_get_var_cnt (d);
389 dict->dict = dict_ref (d);
390 dict_unref (old_dict);
392 weight_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
394 var = dict_get_filter (d);
395 filter_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
397 split_changed_callback (d, dict);
399 dict_set_callbacks (dict->dict, &gui_callbacks, dict);
401 g_signal_emit_by_name (dict, "items-changed", 0, old_n, new_n);
405 /* Stores a valid name for a new variable in DICT into the SIZE bytes in NAME.
406 Returns true if successful, false if SIZE is insufficient. */
408 psppire_dict_generate_name (const PsppireDict *dict, char *name, size_t size)
416 /* TRANSLATORS: This string must be a valid variable name. That means:
417 - The string must be at most 64 bytes (not characters) long.
418 - The string may not contain whitespace.
419 - The first character may not be '$'
420 - The first character may not be a digit
421 - The final character may not be '.' or '_'
423 len = snprintf (name, size, _("Var%04d"), d);
427 if (psppire_dict_lookup_var (dict, name) == NULL)
434 /* Insert a new variable at posn IDX, with the name NAME, and return the
436 IDX may take the special value -1, which will be treated the same as
437 zero. If NAME is null, then a name will be automatically assigned.
440 psppire_dict_insert_variable (PsppireDict *d, gint idx, const gchar *name)
442 struct variable *var;
445 if (idx == -1) /* Note bug #56392. */
447 g_return_val_if_fail (d, NULL);
448 g_return_val_if_fail (PSPPIRE_IS_DICT (d), NULL);
452 if (!psppire_dict_generate_name (d, tmpname, sizeof tmpname))
453 g_return_val_if_reached (NULL);
458 d->disable_insert_signal = TRUE;
460 var = dict_create_var (d->dict, name, 0);
462 dict_reorder_var (d->dict, var, idx);
464 d->disable_insert_signal = FALSE;
466 g_signal_emit (d, signals[VARIABLE_INSERTED], 0, idx);
467 g_signal_emit_by_name (d, "items-changed", idx, 0, 1);
472 /* Delete N variables beginning at FIRST */
474 psppire_dict_delete_variables (PsppireDict *d, gint first, gint n)
477 g_return_if_fail (d);
478 g_return_if_fail (d->dict);
479 g_return_if_fail (PSPPIRE_IS_DICT (d));
481 for (idx = 0 ; idx < n ; ++idx )
483 struct variable *var;
485 /* Do nothing if it's out of bounds */
486 if ( first >= dict_get_var_cnt (d->dict))
489 var = dict_get_var (d->dict, first);
490 dict_delete_var (d->dict, var);
496 psppire_dict_set_name (PsppireDict* d, gint idx, const gchar *name)
498 struct variable *var;
500 g_assert (PSPPIRE_IS_DICT (d));
502 if ( ! dict_id_is_valid (d->dict, name, false))
505 if ( idx < dict_get_var_cnt (d->dict))
507 /* This is an existing variable? */
508 var = dict_get_var (d->dict, idx);
509 dict_rename_var (d->dict, var, name);
514 dict_create_var (d->dict, name, 0);
522 /* Return the IDXth variable.
523 Will return NULL if IDX exceeds the number of variables in the dictionary.
526 psppire_dict_get_variable (const PsppireDict *d, gint idx)
528 g_return_val_if_fail (d, NULL);
529 g_return_val_if_fail (d->dict, NULL);
531 if ( dict_get_var_cnt (d->dict) <= idx )
534 return dict_get_var (d->dict, idx);
538 /* Return the number of variables in the dictionary */
540 psppire_dict_get_var_cnt (const PsppireDict *d)
542 g_return_val_if_fail (d, -1);
543 g_return_val_if_fail (d->dict, -1);
545 return dict_get_var_cnt (d->dict);
549 /* Return the number of `union value's in the dictionary */
551 psppire_dict_get_value_cnt (const PsppireDict *d)
553 g_return_val_if_fail (d, -1);
554 g_return_val_if_fail (d->dict, -1);
556 return dict_get_next_value_idx (d->dict);
560 /* Returns the prototype for the cases that match the dictionary */
561 const struct caseproto *
562 psppire_dict_get_proto (const PsppireDict *d)
564 g_return_val_if_fail (d, NULL);
565 g_return_val_if_fail (d->dict, NULL);
567 return dict_get_proto (d->dict);
571 /* Return a variable by name.
572 Return NULL if it doesn't exist
575 psppire_dict_lookup_var (const PsppireDict *d, const gchar *name)
577 g_return_val_if_fail (d, NULL);
578 g_return_val_if_fail (d->dict, NULL);
580 return dict_lookup_var (d->dict, name);
583 /* Clears the contents of D */
585 psppire_dict_clear (PsppireDict *d)
587 g_return_if_fail (d);
588 g_return_if_fail (d->dict);
591 dict_clear (d->dict);
596 /* Return true if NAME would be a valid name of a variable to add to the
597 dictionary. False otherwise.
598 If REPORT is true, then invalid names will be reported as such as errors
601 psppire_dict_check_name (const PsppireDict *dict,
602 const gchar *name, gboolean report)
604 if ( ! dict_id_is_valid (dict->dict, name, report ) )
607 if (psppire_dict_lookup_var (dict, name))
610 msg (ME, _("Duplicate variable name."));
619 psppire_dict_get_next_value_idx (const PsppireDict *dict)
621 return dict_get_next_value_idx (dict->dict);
625 /* Tree Model Stuff */
627 static GtkTreeModelFlags tree_model_get_flags (GtkTreeModel *model);
629 static gint tree_model_n_columns (GtkTreeModel *model);
631 static GType tree_model_column_type (GtkTreeModel *model, gint index);
633 static gboolean tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter,
636 static gboolean tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter);
638 static GtkTreePath * tree_model_get_path (GtkTreeModel *model,
641 static void tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
642 gint column, GValue *value);
644 static gboolean tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
645 GtkTreeIter *parent, gint n);
647 static gint tree_model_n_children (GtkTreeModel *tree_model,
650 static gboolean tree_model_iter_children (GtkTreeModel *,
654 static gboolean tree_model_iter_parent (GtkTreeModel *tree_model,
658 static gboolean tree_model_iter_has_child (GtkTreeModel *tree_model,
662 dictionary_tree_model_init (GtkTreeModelIface *iface)
664 iface->get_flags = tree_model_get_flags;
665 iface->get_n_columns = tree_model_n_columns;
666 iface->get_column_type = tree_model_column_type;
667 iface->get_iter = tree_model_get_iter;
668 iface->iter_next = tree_model_iter_next;
669 iface->get_path = tree_model_get_path;
670 iface->get_value = tree_model_get_value;
672 iface->iter_children = tree_model_iter_children ;
673 iface->iter_has_child = tree_model_iter_has_child ;
674 iface->iter_n_children = tree_model_n_children ;
675 iface->iter_nth_child = tree_model_nth_child ;
676 iface->iter_parent = tree_model_iter_parent ;
680 tree_model_iter_has_child (GtkTreeModel *tree_model,
687 tree_model_iter_parent (GtkTreeModel *tree_model,
694 static GtkTreeModelFlags
695 tree_model_get_flags (GtkTreeModel *model)
697 g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GtkTreeModelFlags) 0);
699 return GTK_TREE_MODEL_LIST_ONLY;
704 tree_model_n_columns (GtkTreeModel *model)
710 tree_model_column_type (GtkTreeModel *model, gint index)
712 g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GType) 0);
718 case DICT_TVM_COL_NAME:
719 case DICT_TVM_COL_LABEL:
722 case DICT_TVM_COL_DECIMAL:
723 case DICT_TVM_COL_WIDTH:
724 case DICT_TVM_COL_COLUMNS:
727 case DICT_TVM_COL_VAR:
728 t = PSPPIRE_VAR_PTR_TYPE;
730 case DICT_TVM_COL_ALIGNMENT:
733 case DICT_TVM_COL_MEASURE:
734 t = measure_enum_type;
736 case DICT_TVM_COL_ROLE:
745 tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter, GtkTreePath *path)
747 gint *indices, depth;
749 struct variable *var;
751 PsppireDict *dict = PSPPIRE_DICT (model);
753 g_return_val_if_fail (path, FALSE);
755 indices = gtk_tree_path_get_indices (path);
756 depth = gtk_tree_path_get_depth (path);
758 g_return_val_if_fail (depth == 1, FALSE);
762 if ( n < 0 || n >= psppire_dict_get_var_cnt (dict))
765 iter->user_data = NULL;
769 var = psppire_dict_get_variable (dict, n);
771 g_assert (var_get_dict_index (var) == n);
773 iter->stamp = dict->stamp;
774 iter->user_data = var;
781 tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter)
783 PsppireDict *dict = PSPPIRE_DICT (model);
784 struct variable *var;
787 if ( iter == NULL || iter->user_data == NULL)
790 g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
792 var = iter->user_data;
794 idx = var_get_dict_index (var);
796 if ( idx + 1 >= psppire_dict_get_var_cnt (dict))
798 iter->user_data = NULL;
803 var = psppire_dict_get_variable (dict, idx + 1);
805 g_assert (var_get_dict_index (var) == idx + 1);
807 iter->user_data = var;
813 tree_model_get_path (GtkTreeModel *model, GtkTreeIter *iter)
816 struct variable *var;
817 PsppireDict *dict = PSPPIRE_DICT (model);
819 g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
821 var = iter->user_data;
823 path = gtk_tree_path_new ();
824 gtk_tree_path_append_index (path, var_get_dict_index (var));
829 const struct fmt_spec *var_get_write_format (const struct variable *);
832 tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
833 gint column, GValue *value)
835 struct variable *var;
836 PsppireDict *dict = PSPPIRE_DICT (model);
838 g_return_if_fail (iter->stamp == dict->stamp);
840 var = iter->user_data;
842 const struct fmt_spec *fs = var_get_write_format (var);
846 case DICT_TVM_COL_NAME:
847 g_value_init (value, G_TYPE_STRING);
848 g_value_set_string (value, var_get_name (var));
850 case DICT_TVM_COL_WIDTH:
851 g_value_init (value, G_TYPE_INT);
852 g_value_set_int (value, fs->w);
854 case DICT_TVM_COL_DECIMAL:
855 g_value_init (value, G_TYPE_INT);
856 g_value_set_int (value, fs->d);
858 case DICT_TVM_COL_LABEL:
859 g_value_init (value, G_TYPE_STRING);
860 g_value_set_string (value, var_get_label (var));
862 case DICT_TVM_COL_COLUMNS:
863 g_value_init (value, G_TYPE_INT);
864 g_value_set_int (value, var_get_display_width (var));
866 case DICT_TVM_COL_ALIGNMENT:
867 g_value_init (value, align_enum_type);
868 g_value_set_enum (value, var_get_alignment (var));
870 case DICT_TVM_COL_MEASURE:
871 g_value_init (value, measure_enum_type);
872 g_value_set_enum (value, var_get_measure (var));
874 case DICT_TVM_COL_ROLE:
875 g_value_init (value, role_enum_type);
876 g_value_set_enum (value, var_get_role (var));
878 case DICT_TVM_COL_VAR:
879 g_value_init (value, PSPPIRE_VAR_PTR_TYPE);
880 g_value_set_boxed (value, var);
883 g_value_init (value, G_TYPE_STRING);
884 g_value_set_string (value, "????");
890 tree_model_iter_children (GtkTreeModel *tree_model,
898 tree_model_n_children (GtkTreeModel *model,
901 PsppireDict *dict = PSPPIRE_DICT (model);
904 return psppire_dict_get_var_cnt (dict);
910 tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
911 GtkTreeIter *parent, gint n)
915 g_return_val_if_fail (PSPPIRE_IS_DICT (model), FALSE);
917 dict = PSPPIRE_DICT (model);
922 if ( n >= psppire_dict_get_var_cnt (dict) )
925 iter->stamp = dict->stamp;
926 iter->user_data = psppire_dict_get_variable (dict, n);
928 if ( !iter->user_data)
936 psppire_dict_rename_var (PsppireDict *dict, struct variable *v,
939 if ( ! dict_id_is_valid (dict->dict, name, false))
942 /* Make sure no other variable has this name */
943 if ( NULL != psppire_dict_lookup_var (dict, name))
946 dict_rename_var (dict->dict, v, name);
953 psppire_dict_get_weight_variable (const PsppireDict *dict)
955 return dict_get_weight (dict->dict);
962 psppire_dict_dump (const PsppireDict *dict)
965 const struct dictionary *d = dict->dict;
967 for (i = 0; i < dict_get_var_cnt (d); ++i)
969 const struct variable *v = psppire_dict_get_variable (dict, i);
970 int di = var_get_dict_index (v);
971 g_print ("`%s' idx=%d, fv=%d\n",
974 var_get_case_index(v));
982 psppire_dict_encoding (const PsppireDict *dict)
984 return dict_get_encoding (dict->dict);