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));
104 PangoContext *context = gtk_widget_create_pango_context (button);
105 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,
126 ssw_init_iface (GListModelInterface *iface)
128 iface->get_n_items = gni;
129 iface->get_item = gi;
130 iface->get_item_type = git;
134 /* --- variables --- */
135 static GObjectClass *parent_class = NULL;
137 static guint signals [n_SIGNALS];
139 /* --- functions --- */
141 * psppire_dict_get_type:
142 * @returns: the type ID for accelerator groups.
145 psppire_dict_get_type (void)
147 static GType object_type = 0;
151 static const GTypeInfo object_info = {
152 sizeof (PsppireDictClass),
153 (GBaseInitFunc) NULL,
154 (GBaseFinalizeFunc) NULL,
155 (GClassInitFunc) psppire_dict_class_init,
156 NULL, /* class_finalize */
157 NULL, /* class_data */
158 sizeof (PsppireDict),
160 (GInstanceInitFunc) psppire_dict_init,
163 static const GInterfaceInfo tree_model_info = {
164 (GInterfaceInitFunc) dictionary_tree_model_init,
169 static const GInterfaceInfo list_model_info = {
170 (GInterfaceInitFunc) ssw_init_iface,
175 object_type = g_type_register_static (G_TYPE_OBJECT,
179 g_type_add_interface_static (object_type, GTK_TYPE_TREE_MODEL,
182 g_type_add_interface_static (object_type, G_TYPE_LIST_MODEL,
191 psppire_dict_class_init (PsppireDictClass *class)
193 GObjectClass *object_class = G_OBJECT_CLASS (class);
195 parent_class = g_type_class_peek_parent (class);
197 object_class->dispose = psppire_dict_dispose;
199 signals [VARIABLE_CHANGED] =
200 g_signal_new ("variable-changed",
201 G_TYPE_FROM_CLASS (class),
205 psppire_marshal_VOID__INT_UINT_POINTER,
212 signals [VARIABLE_INSERTED] =
213 g_signal_new ("variable-inserted",
214 G_TYPE_FROM_CLASS (class),
218 g_cclosure_marshal_VOID__INT,
223 signals [VARIABLE_DELETED] =
224 g_signal_new ("variable-deleted",
225 G_TYPE_FROM_CLASS (class),
229 psppire_marshal_VOID__POINTER_INT_INT,
236 signals [WEIGHT_CHANGED] =
237 g_signal_new ("weight-changed",
238 G_TYPE_FROM_CLASS (class),
242 g_cclosure_marshal_VOID__INT,
247 signals [FILTER_CHANGED] =
248 g_signal_new ("filter-changed",
249 G_TYPE_FROM_CLASS (class),
253 g_cclosure_marshal_VOID__INT,
258 signals [SPLIT_CHANGED] =
259 g_signal_new ("split-changed",
260 G_TYPE_FROM_CLASS (class),
264 g_cclosure_marshal_VOID__VOID,
270 psppire_dict_dispose (GObject *object)
272 PsppireDict *d = PSPPIRE_DICT (object);
274 dict_set_callbacks (d->dict, NULL, NULL);
276 G_OBJECT_CLASS (parent_class)->dispose (object);
279 /* Pass on callbacks from src/data/dictionary, as
280 signals in the Gtk library */
282 addcb (struct dictionary *d, int idx, void *pd)
284 PsppireDict *dict = PSPPIRE_DICT (pd);
286 if ( ! dict->disable_insert_signal)
288 g_signal_emit (dict, signals [VARIABLE_INSERTED], 0, idx);
289 g_signal_emit_by_name (dict, "items-changed", idx, 1, 1);
294 delcb (struct dictionary *d, const struct variable *var,
295 int dict_idx, int case_idx, void *pd)
297 g_signal_emit (pd, signals [VARIABLE_DELETED], 0,
298 var, dict_idx, case_idx);
299 g_signal_emit_by_name (pd, "items-changed", dict_idx, 1, 0);
303 mutcb (struct dictionary *d, int idx, unsigned int what, const struct variable *oldvar, void *pd)
305 g_signal_emit (pd, signals [VARIABLE_CHANGED], 0, idx, what, oldvar);
306 g_signal_emit_by_name (pd, "items-changed", idx, 1, 1);
310 weight_changed_callback (struct dictionary *d, int idx, void *pd)
312 g_signal_emit (pd, signals [WEIGHT_CHANGED], 0, idx);
316 filter_changed_callback (struct dictionary *d, int idx, void *pd)
318 g_signal_emit (pd, signals [FILTER_CHANGED], 0, idx);
322 split_changed_callback (struct dictionary *d, void *pd)
324 g_signal_emit (pd, signals [SPLIT_CHANGED], 0);
327 static const struct dict_callbacks gui_callbacks =
332 weight_changed_callback,
333 filter_changed_callback,
334 split_changed_callback
338 psppire_dict_init (PsppireDict *psppire_dict)
340 psppire_dict->stamp = g_random_int ();
341 psppire_dict->disable_insert_signal = FALSE;
345 * psppire_dict_new_from_dict:
346 * @returns: a new #PsppireDict object
348 * Creates a new #PsppireDict.
351 psppire_dict_new_from_dict (struct dictionary *d)
353 PsppireDict *new_dict = g_object_new (PSPPIRE_TYPE_DICT, NULL);
356 dict_set_callbacks (new_dict->dict, &gui_callbacks, new_dict);
363 psppire_dict_replace_dictionary (PsppireDict *dict, struct dictionary *d)
365 struct variable *var = dict_get_weight (d);
367 guint old_n = dict_get_var_cnt (dict->dict);
368 guint new_n = dict_get_var_cnt (d);
372 weight_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
374 var = dict_get_filter (d);
375 filter_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
377 split_changed_callback (d, dict);
379 dict_set_callbacks (dict->dict, &gui_callbacks, dict);
381 g_signal_emit_by_name (dict, "items-changed", 0, old_n, new_n);
385 /* Stores a valid name for a new variable in DICT into the SIZE bytes in NAME.
386 Returns true if successful, false if SIZE is insufficient. */
388 psppire_dict_generate_name (const PsppireDict *dict, char *name, size_t size)
396 /* TRANSLATORS: This string must be a valid variable name. That means:
397 - The string must be at most 64 bytes (not characters) long.
398 - The string may not contain whitespace.
399 - The first character may not be '$'
400 - The first character may not be a digit
401 - The final character may not be '.' or '_'
403 len = snprintf (name, size, _("Var%04d"), d);
407 if (psppire_dict_lookup_var (dict, name) == NULL)
414 /* Insert a new variable at posn IDX, with the name NAME, and return the
416 If NAME is null, then a name will be automatically assigned.
419 psppire_dict_insert_variable (PsppireDict *d, gint idx, const gchar *name)
421 struct variable *var;
424 g_return_val_if_fail (idx >= 0, NULL);
425 g_return_val_if_fail (d, NULL);
426 g_return_val_if_fail (PSPPIRE_IS_DICT (d), NULL);
430 if (!psppire_dict_generate_name (d, tmpname, sizeof tmpname))
431 g_return_val_if_reached (NULL);
436 d->disable_insert_signal = TRUE;
438 var = dict_create_var (d->dict, name, 0);
440 dict_reorder_var (d->dict, var, idx);
442 d->disable_insert_signal = FALSE;
444 g_signal_emit (d, signals[VARIABLE_INSERTED], 0, idx);
445 g_signal_emit_by_name (d, "items-changed", idx, 0, 1);
450 /* Delete N variables beginning at FIRST */
452 psppire_dict_delete_variables (PsppireDict *d, gint first, gint n)
455 g_return_if_fail (d);
456 g_return_if_fail (d->dict);
457 g_return_if_fail (PSPPIRE_IS_DICT (d));
459 for (idx = 0 ; idx < n ; ++idx )
461 struct variable *var;
463 /* Do nothing if it's out of bounds */
464 if ( first >= dict_get_var_cnt (d->dict))
467 var = dict_get_var (d->dict, first);
468 dict_delete_var (d->dict, var);
474 psppire_dict_set_name (PsppireDict* d, gint idx, const gchar *name)
476 struct variable *var;
478 g_assert (PSPPIRE_IS_DICT (d));
480 if ( ! dict_id_is_valid (d->dict, name, false))
483 if ( idx < dict_get_var_cnt (d->dict))
485 /* This is an existing variable? */
486 var = dict_get_var (d->dict, idx);
487 dict_rename_var (d->dict, var, name);
492 dict_create_var (d->dict, name, 0);
500 /* Return the IDXth variable.
501 Will return NULL if IDX exceeds the number of variables in the dictionary.
504 psppire_dict_get_variable (const PsppireDict *d, gint idx)
506 g_return_val_if_fail (d, NULL);
507 g_return_val_if_fail (d->dict, NULL);
509 if ( dict_get_var_cnt (d->dict) <= idx )
512 return dict_get_var (d->dict, idx);
516 /* Return the number of variables in the dictionary */
518 psppire_dict_get_var_cnt (const PsppireDict *d)
520 g_return_val_if_fail (d, -1);
521 g_return_val_if_fail (d->dict, -1);
523 return dict_get_var_cnt (d->dict);
527 /* Return the number of `union value's in the dictionary */
529 psppire_dict_get_value_cnt (const PsppireDict *d)
531 g_return_val_if_fail (d, -1);
532 g_return_val_if_fail (d->dict, -1);
534 return dict_get_next_value_idx (d->dict);
538 /* Returns the prototype for the cases that match the dictionary */
539 const struct caseproto *
540 psppire_dict_get_proto (const PsppireDict *d)
542 g_return_val_if_fail (d, NULL);
543 g_return_val_if_fail (d->dict, NULL);
545 return dict_get_proto (d->dict);
549 /* Return a variable by name.
550 Return NULL if it doesn't exist
553 psppire_dict_lookup_var (const PsppireDict *d, const gchar *name)
555 g_return_val_if_fail (d, NULL);
556 g_return_val_if_fail (d->dict, NULL);
558 return dict_lookup_var (d->dict, name);
561 /* Clears the contents of D */
563 psppire_dict_clear (PsppireDict *d)
565 g_return_if_fail (d);
566 g_return_if_fail (d->dict);
569 dict_clear (d->dict);
574 /* Return true if NAME would be a valid name of a variable to add to the
575 dictionary. False otherwise.
576 If REPORT is true, then invalid names will be reported as such as errors
579 psppire_dict_check_name (const PsppireDict *dict,
580 const gchar *name, gboolean report)
582 if ( ! dict_id_is_valid (dict->dict, name, report ) )
585 if (psppire_dict_lookup_var (dict, name))
588 msg (ME, _("Duplicate variable name."));
597 psppire_dict_get_next_value_idx (const PsppireDict *dict)
599 return dict_get_next_value_idx (dict->dict);
603 /* Tree Model Stuff */
605 static GtkTreeModelFlags tree_model_get_flags (GtkTreeModel *model);
607 static gint tree_model_n_columns (GtkTreeModel *model);
609 static GType tree_model_column_type (GtkTreeModel *model, gint index);
611 static gboolean tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter,
614 static gboolean tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter);
616 static GtkTreePath * tree_model_get_path (GtkTreeModel *model,
619 static void tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
620 gint column, GValue *value);
622 static gboolean tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
623 GtkTreeIter *parent, gint n);
625 static gint tree_model_n_children (GtkTreeModel *tree_model,
628 static gboolean tree_model_iter_children (GtkTreeModel *,
632 static gboolean tree_model_iter_parent (GtkTreeModel *tree_model,
636 static gboolean tree_model_iter_has_child (GtkTreeModel *tree_model,
640 dictionary_tree_model_init (GtkTreeModelIface *iface)
642 iface->get_flags = tree_model_get_flags;
643 iface->get_n_columns = tree_model_n_columns;
644 iface->get_column_type = tree_model_column_type;
645 iface->get_iter = tree_model_get_iter;
646 iface->iter_next = tree_model_iter_next;
647 iface->get_path = tree_model_get_path;
648 iface->get_value = tree_model_get_value;
650 iface->iter_children = tree_model_iter_children ;
651 iface->iter_has_child = tree_model_iter_has_child ;
652 iface->iter_n_children = tree_model_n_children ;
653 iface->iter_nth_child = tree_model_nth_child ;
654 iface->iter_parent = tree_model_iter_parent ;
658 tree_model_iter_has_child (GtkTreeModel *tree_model,
665 tree_model_iter_parent (GtkTreeModel *tree_model,
672 static GtkTreeModelFlags
673 tree_model_get_flags (GtkTreeModel *model)
675 g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GtkTreeModelFlags) 0);
677 return GTK_TREE_MODEL_LIST_ONLY;
682 tree_model_n_columns (GtkTreeModel *model)
688 tree_model_column_type (GtkTreeModel *model, gint index)
690 g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GType) 0);
696 case DICT_TVM_COL_NAME:
697 case DICT_TVM_COL_LABEL:
700 case DICT_TVM_COL_DECIMAL:
701 case DICT_TVM_COL_WIDTH:
702 case DICT_TVM_COL_COLUMNS:
705 case DICT_TVM_COL_VAR:
706 t = PSPPIRE_VAR_PTR_TYPE;
708 case DICT_TVM_COL_ALIGNMENT:
711 case DICT_TVM_COL_MEASURE:
712 t = measure_enum_type;
714 case DICT_TVM_COL_ROLE:
723 tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter, GtkTreePath *path)
725 gint *indices, depth;
727 struct variable *var;
729 PsppireDict *dict = PSPPIRE_DICT (model);
731 g_return_val_if_fail (path, FALSE);
733 indices = gtk_tree_path_get_indices (path);
734 depth = gtk_tree_path_get_depth (path);
736 g_return_val_if_fail (depth == 1, FALSE);
740 if ( n < 0 || n >= psppire_dict_get_var_cnt (dict))
743 iter->user_data = NULL;
747 var = psppire_dict_get_variable (dict, n);
749 g_assert (var_get_dict_index (var) == n);
751 iter->stamp = dict->stamp;
752 iter->user_data = var;
759 tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter)
761 PsppireDict *dict = PSPPIRE_DICT (model);
762 struct variable *var;
765 if ( iter == NULL || iter->user_data == NULL)
768 g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
770 var = iter->user_data;
772 idx = var_get_dict_index (var);
774 if ( idx + 1 >= psppire_dict_get_var_cnt (dict))
776 iter->user_data = NULL;
781 var = psppire_dict_get_variable (dict, idx + 1);
783 g_assert (var_get_dict_index (var) == idx + 1);
785 iter->user_data = var;
791 tree_model_get_path (GtkTreeModel *model, GtkTreeIter *iter)
794 struct variable *var;
795 PsppireDict *dict = PSPPIRE_DICT (model);
797 g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
799 var = iter->user_data;
801 path = gtk_tree_path_new ();
802 gtk_tree_path_append_index (path, var_get_dict_index (var));
807 const struct fmt_spec *var_get_write_format (const struct variable *);
810 tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
811 gint column, GValue *value)
813 struct variable *var;
814 PsppireDict *dict = PSPPIRE_DICT (model);
816 g_return_if_fail (iter->stamp == dict->stamp);
818 var = iter->user_data;
820 const struct fmt_spec *fs = var_get_write_format (var);
824 case DICT_TVM_COL_NAME:
825 g_value_init (value, G_TYPE_STRING);
826 g_value_set_string (value, var_get_name (var));
828 case DICT_TVM_COL_WIDTH:
829 g_value_init (value, G_TYPE_INT);
830 g_value_set_int (value, fs->w);
832 case DICT_TVM_COL_DECIMAL:
833 g_value_init (value, G_TYPE_INT);
834 g_value_set_int (value, fs->d);
836 case DICT_TVM_COL_LABEL:
837 g_value_init (value, G_TYPE_STRING);
838 g_value_set_string (value, var_get_label (var));
840 case DICT_TVM_COL_COLUMNS:
841 g_value_init (value, G_TYPE_INT);
842 g_value_set_int (value, var_get_display_width (var));
844 case DICT_TVM_COL_ALIGNMENT:
845 g_value_init (value, align_enum_type);
846 g_value_set_enum (value, var_get_alignment (var));
848 case DICT_TVM_COL_MEASURE:
849 g_value_init (value, measure_enum_type);
850 g_value_set_enum (value, var_get_measure (var));
852 case DICT_TVM_COL_ROLE:
853 g_value_init (value, role_enum_type);
854 g_value_set_enum (value, var_get_role (var));
856 case DICT_TVM_COL_VAR:
857 g_value_init (value, PSPPIRE_VAR_PTR_TYPE);
858 g_value_set_boxed (value, var);
861 g_value_init (value, G_TYPE_STRING);
862 g_value_set_string (value, "????");
868 tree_model_iter_children (GtkTreeModel *tree_model,
876 tree_model_n_children (GtkTreeModel *model,
879 PsppireDict *dict = PSPPIRE_DICT (model);
882 return psppire_dict_get_var_cnt (dict);
888 tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
889 GtkTreeIter *parent, gint n)
893 g_return_val_if_fail (PSPPIRE_IS_DICT (model), FALSE);
895 dict = PSPPIRE_DICT (model);
900 if ( n >= psppire_dict_get_var_cnt (dict) )
903 iter->stamp = dict->stamp;
904 iter->user_data = psppire_dict_get_variable (dict, n);
906 if ( !iter->user_data)
914 psppire_dict_rename_var (PsppireDict *dict, struct variable *v,
917 if ( ! dict_id_is_valid (dict->dict, name, false))
920 /* Make sure no other variable has this name */
921 if ( NULL != psppire_dict_lookup_var (dict, name))
924 dict_rename_var (dict->dict, v, name);
931 psppire_dict_get_weight_variable (const PsppireDict *dict)
933 return dict_get_weight (dict->dict);
940 psppire_dict_dump (const PsppireDict *dict)
943 const struct dictionary *d = dict->dict;
945 for (i = 0; i < dict_get_var_cnt (d); ++i)
947 const struct variable *v = psppire_dict_get_variable (dict, i);
948 int di = var_get_dict_index (v);
949 g_print ("`%s' idx=%d, fv=%d\n",
952 var_get_case_index(v));
960 psppire_dict_encoding (const PsppireDict *dict)
962 return dict_get_encoding (dict->dict);