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);
292 G_OBJECT_CLASS (parent_class)->dispose (object);
295 /* Pass on callbacks from src/data/dictionary, as
296 signals in the Gtk library */
298 addcb (struct dictionary *d, int idx, void *pd)
300 PsppireDict *dict = PSPPIRE_DICT (pd);
302 if ( ! dict->disable_insert_signal)
304 g_signal_emit (dict, signals [VARIABLE_INSERTED], 0, idx);
305 g_signal_emit_by_name (dict, "items-changed", idx, 1, 1);
310 delcb (struct dictionary *d, const struct variable *var,
311 int dict_idx, int case_idx, void *pd)
313 g_signal_emit (pd, signals [VARIABLE_DELETED], 0,
314 var, dict_idx, case_idx);
315 g_signal_emit_by_name (pd, "items-changed", dict_idx, 1, 0);
319 mutcb (struct dictionary *d, int idx, unsigned int what, const struct variable *oldvar, void *pd)
321 g_signal_emit (pd, signals [VARIABLE_CHANGED], 0, idx, what, oldvar);
322 g_signal_emit_by_name (pd, "items-changed", idx, 1, 1);
326 weight_changed_callback (struct dictionary *d, int idx, void *pd)
328 g_signal_emit (pd, signals [WEIGHT_CHANGED], 0, idx);
332 filter_changed_callback (struct dictionary *d, int idx, void *pd)
334 g_signal_emit (pd, signals [FILTER_CHANGED], 0, idx);
338 split_changed_callback (struct dictionary *d, void *pd)
340 g_signal_emit (pd, signals [SPLIT_CHANGED], 0);
343 static const struct dict_callbacks gui_callbacks =
348 weight_changed_callback,
349 filter_changed_callback,
350 split_changed_callback
354 psppire_dict_init (PsppireDict *psppire_dict)
356 psppire_dict->stamp = g_random_int ();
357 psppire_dict->disable_insert_signal = FALSE;
361 * psppire_dict_new_from_dict:
362 * @returns: a new #PsppireDict object
364 * Creates a new #PsppireDict.
367 psppire_dict_new_from_dict (struct dictionary *d)
369 PsppireDict *new_dict = g_object_new (PSPPIRE_TYPE_DICT, NULL);
372 dict_set_callbacks (new_dict->dict, &gui_callbacks, new_dict);
379 psppire_dict_replace_dictionary (PsppireDict *dict, struct dictionary *d)
381 struct variable *var = dict_get_weight (d);
383 guint old_n = dict_get_var_cnt (dict->dict);
384 guint new_n = dict_get_var_cnt (d);
388 weight_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
390 var = dict_get_filter (d);
391 filter_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
393 split_changed_callback (d, dict);
395 dict_set_callbacks (dict->dict, &gui_callbacks, dict);
397 g_signal_emit_by_name (dict, "items-changed", 0, old_n, new_n);
401 /* Stores a valid name for a new variable in DICT into the SIZE bytes in NAME.
402 Returns true if successful, false if SIZE is insufficient. */
404 psppire_dict_generate_name (const PsppireDict *dict, char *name, size_t size)
412 /* TRANSLATORS: This string must be a valid variable name. That means:
413 - The string must be at most 64 bytes (not characters) long.
414 - The string may not contain whitespace.
415 - The first character may not be '$'
416 - The first character may not be a digit
417 - The final character may not be '.' or '_'
419 len = snprintf (name, size, _("Var%04d"), d);
423 if (psppire_dict_lookup_var (dict, name) == NULL)
430 /* Insert a new variable at posn IDX, with the name NAME, and return the
432 If NAME is null, then a name will be automatically assigned.
435 psppire_dict_insert_variable (PsppireDict *d, gint idx, const gchar *name)
437 struct variable *var;
440 g_return_val_if_fail (idx >= 0, NULL);
441 g_return_val_if_fail (d, NULL);
442 g_return_val_if_fail (PSPPIRE_IS_DICT (d), NULL);
446 if (!psppire_dict_generate_name (d, tmpname, sizeof tmpname))
447 g_return_val_if_reached (NULL);
452 d->disable_insert_signal = TRUE;
454 var = dict_create_var (d->dict, name, 0);
456 dict_reorder_var (d->dict, var, idx);
458 d->disable_insert_signal = FALSE;
460 g_signal_emit (d, signals[VARIABLE_INSERTED], 0, idx);
461 g_signal_emit_by_name (d, "items-changed", idx, 0, 1);
466 /* Delete N variables beginning at FIRST */
468 psppire_dict_delete_variables (PsppireDict *d, gint first, gint n)
471 g_return_if_fail (d);
472 g_return_if_fail (d->dict);
473 g_return_if_fail (PSPPIRE_IS_DICT (d));
475 for (idx = 0 ; idx < n ; ++idx )
477 struct variable *var;
479 /* Do nothing if it's out of bounds */
480 if ( first >= dict_get_var_cnt (d->dict))
483 var = dict_get_var (d->dict, first);
484 dict_delete_var (d->dict, var);
490 psppire_dict_set_name (PsppireDict* d, gint idx, const gchar *name)
492 struct variable *var;
494 g_assert (PSPPIRE_IS_DICT (d));
496 if ( ! dict_id_is_valid (d->dict, name, false))
499 if ( idx < dict_get_var_cnt (d->dict))
501 /* This is an existing variable? */
502 var = dict_get_var (d->dict, idx);
503 dict_rename_var (d->dict, var, name);
508 dict_create_var (d->dict, name, 0);
516 /* Return the IDXth variable.
517 Will return NULL if IDX exceeds the number of variables in the dictionary.
520 psppire_dict_get_variable (const PsppireDict *d, gint idx)
522 g_return_val_if_fail (d, NULL);
523 g_return_val_if_fail (d->dict, NULL);
525 if ( dict_get_var_cnt (d->dict) <= idx )
528 return dict_get_var (d->dict, idx);
532 /* Return the number of variables in the dictionary */
534 psppire_dict_get_var_cnt (const PsppireDict *d)
536 g_return_val_if_fail (d, -1);
537 g_return_val_if_fail (d->dict, -1);
539 return dict_get_var_cnt (d->dict);
543 /* Return the number of `union value's in the dictionary */
545 psppire_dict_get_value_cnt (const PsppireDict *d)
547 g_return_val_if_fail (d, -1);
548 g_return_val_if_fail (d->dict, -1);
550 return dict_get_next_value_idx (d->dict);
554 /* Returns the prototype for the cases that match the dictionary */
555 const struct caseproto *
556 psppire_dict_get_proto (const PsppireDict *d)
558 g_return_val_if_fail (d, NULL);
559 g_return_val_if_fail (d->dict, NULL);
561 return dict_get_proto (d->dict);
565 /* Return a variable by name.
566 Return NULL if it doesn't exist
569 psppire_dict_lookup_var (const PsppireDict *d, const gchar *name)
571 g_return_val_if_fail (d, NULL);
572 g_return_val_if_fail (d->dict, NULL);
574 return dict_lookup_var (d->dict, name);
577 /* Clears the contents of D */
579 psppire_dict_clear (PsppireDict *d)
581 g_return_if_fail (d);
582 g_return_if_fail (d->dict);
585 dict_clear (d->dict);
590 /* Return true if NAME would be a valid name of a variable to add to the
591 dictionary. False otherwise.
592 If REPORT is true, then invalid names will be reported as such as errors
595 psppire_dict_check_name (const PsppireDict *dict,
596 const gchar *name, gboolean report)
598 if ( ! dict_id_is_valid (dict->dict, name, report ) )
601 if (psppire_dict_lookup_var (dict, name))
604 msg (ME, _("Duplicate variable name."));
613 psppire_dict_get_next_value_idx (const PsppireDict *dict)
615 return dict_get_next_value_idx (dict->dict);
619 /* Tree Model Stuff */
621 static GtkTreeModelFlags tree_model_get_flags (GtkTreeModel *model);
623 static gint tree_model_n_columns (GtkTreeModel *model);
625 static GType tree_model_column_type (GtkTreeModel *model, gint index);
627 static gboolean tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter,
630 static gboolean tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter);
632 static GtkTreePath * tree_model_get_path (GtkTreeModel *model,
635 static void tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
636 gint column, GValue *value);
638 static gboolean tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
639 GtkTreeIter *parent, gint n);
641 static gint tree_model_n_children (GtkTreeModel *tree_model,
644 static gboolean tree_model_iter_children (GtkTreeModel *,
648 static gboolean tree_model_iter_parent (GtkTreeModel *tree_model,
652 static gboolean tree_model_iter_has_child (GtkTreeModel *tree_model,
656 dictionary_tree_model_init (GtkTreeModelIface *iface)
658 iface->get_flags = tree_model_get_flags;
659 iface->get_n_columns = tree_model_n_columns;
660 iface->get_column_type = tree_model_column_type;
661 iface->get_iter = tree_model_get_iter;
662 iface->iter_next = tree_model_iter_next;
663 iface->get_path = tree_model_get_path;
664 iface->get_value = tree_model_get_value;
666 iface->iter_children = tree_model_iter_children ;
667 iface->iter_has_child = tree_model_iter_has_child ;
668 iface->iter_n_children = tree_model_n_children ;
669 iface->iter_nth_child = tree_model_nth_child ;
670 iface->iter_parent = tree_model_iter_parent ;
674 tree_model_iter_has_child (GtkTreeModel *tree_model,
681 tree_model_iter_parent (GtkTreeModel *tree_model,
688 static GtkTreeModelFlags
689 tree_model_get_flags (GtkTreeModel *model)
691 g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GtkTreeModelFlags) 0);
693 return GTK_TREE_MODEL_LIST_ONLY;
698 tree_model_n_columns (GtkTreeModel *model)
704 tree_model_column_type (GtkTreeModel *model, gint index)
706 g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GType) 0);
712 case DICT_TVM_COL_NAME:
713 case DICT_TVM_COL_LABEL:
716 case DICT_TVM_COL_DECIMAL:
717 case DICT_TVM_COL_WIDTH:
718 case DICT_TVM_COL_COLUMNS:
721 case DICT_TVM_COL_VAR:
722 t = PSPPIRE_VAR_PTR_TYPE;
724 case DICT_TVM_COL_ALIGNMENT:
727 case DICT_TVM_COL_MEASURE:
728 t = measure_enum_type;
730 case DICT_TVM_COL_ROLE:
739 tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter, GtkTreePath *path)
741 gint *indices, depth;
743 struct variable *var;
745 PsppireDict *dict = PSPPIRE_DICT (model);
747 g_return_val_if_fail (path, FALSE);
749 indices = gtk_tree_path_get_indices (path);
750 depth = gtk_tree_path_get_depth (path);
752 g_return_val_if_fail (depth == 1, FALSE);
756 if ( n < 0 || n >= psppire_dict_get_var_cnt (dict))
759 iter->user_data = NULL;
763 var = psppire_dict_get_variable (dict, n);
765 g_assert (var_get_dict_index (var) == n);
767 iter->stamp = dict->stamp;
768 iter->user_data = var;
775 tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter)
777 PsppireDict *dict = PSPPIRE_DICT (model);
778 struct variable *var;
781 if ( iter == NULL || iter->user_data == NULL)
784 g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
786 var = iter->user_data;
788 idx = var_get_dict_index (var);
790 if ( idx + 1 >= psppire_dict_get_var_cnt (dict))
792 iter->user_data = NULL;
797 var = psppire_dict_get_variable (dict, idx + 1);
799 g_assert (var_get_dict_index (var) == idx + 1);
801 iter->user_data = var;
807 tree_model_get_path (GtkTreeModel *model, GtkTreeIter *iter)
810 struct variable *var;
811 PsppireDict *dict = PSPPIRE_DICT (model);
813 g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
815 var = iter->user_data;
817 path = gtk_tree_path_new ();
818 gtk_tree_path_append_index (path, var_get_dict_index (var));
823 const struct fmt_spec *var_get_write_format (const struct variable *);
826 tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
827 gint column, GValue *value)
829 struct variable *var;
830 PsppireDict *dict = PSPPIRE_DICT (model);
832 g_return_if_fail (iter->stamp == dict->stamp);
834 var = iter->user_data;
836 const struct fmt_spec *fs = var_get_write_format (var);
840 case DICT_TVM_COL_NAME:
841 g_value_init (value, G_TYPE_STRING);
842 g_value_set_string (value, var_get_name (var));
844 case DICT_TVM_COL_WIDTH:
845 g_value_init (value, G_TYPE_INT);
846 g_value_set_int (value, fs->w);
848 case DICT_TVM_COL_DECIMAL:
849 g_value_init (value, G_TYPE_INT);
850 g_value_set_int (value, fs->d);
852 case DICT_TVM_COL_LABEL:
853 g_value_init (value, G_TYPE_STRING);
854 g_value_set_string (value, var_get_label (var));
856 case DICT_TVM_COL_COLUMNS:
857 g_value_init (value, G_TYPE_INT);
858 g_value_set_int (value, var_get_display_width (var));
860 case DICT_TVM_COL_ALIGNMENT:
861 g_value_init (value, align_enum_type);
862 g_value_set_enum (value, var_get_alignment (var));
864 case DICT_TVM_COL_MEASURE:
865 g_value_init (value, measure_enum_type);
866 g_value_set_enum (value, var_get_measure (var));
868 case DICT_TVM_COL_ROLE:
869 g_value_init (value, role_enum_type);
870 g_value_set_enum (value, var_get_role (var));
872 case DICT_TVM_COL_VAR:
873 g_value_init (value, PSPPIRE_VAR_PTR_TYPE);
874 g_value_set_boxed (value, var);
877 g_value_init (value, G_TYPE_STRING);
878 g_value_set_string (value, "????");
884 tree_model_iter_children (GtkTreeModel *tree_model,
892 tree_model_n_children (GtkTreeModel *model,
895 PsppireDict *dict = PSPPIRE_DICT (model);
898 return psppire_dict_get_var_cnt (dict);
904 tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
905 GtkTreeIter *parent, gint n)
909 g_return_val_if_fail (PSPPIRE_IS_DICT (model), FALSE);
911 dict = PSPPIRE_DICT (model);
916 if ( n >= psppire_dict_get_var_cnt (dict) )
919 iter->stamp = dict->stamp;
920 iter->user_data = psppire_dict_get_variable (dict, n);
922 if ( !iter->user_data)
930 psppire_dict_rename_var (PsppireDict *dict, struct variable *v,
933 if ( ! dict_id_is_valid (dict->dict, name, false))
936 /* Make sure no other variable has this name */
937 if ( NULL != psppire_dict_lookup_var (dict, name))
940 dict_rename_var (dict->dict, v, name);
947 psppire_dict_get_weight_variable (const PsppireDict *dict)
949 return dict_get_weight (dict->dict);
956 psppire_dict_dump (const PsppireDict *dict)
959 const struct dictionary *d = dict->dict;
961 for (i = 0; i < dict_get_var_cnt (d); ++i)
963 const struct variable *v = psppire_dict_get_variable (dict, i);
964 int di = var_get_dict_index (v);
965 g_print ("`%s' idx=%d, fv=%d\n",
968 var_get_case_index(v));
976 psppire_dict_encoding (const PsppireDict *dict)
978 return dict_get_encoding (dict->dict);