1 /* PSPPIRE - a graphical user interface for PSPP.
2 Copyright (C) 2004, 2006, 2007, 2009, 2010, 2011, 2012 Free Software Foundation
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19 #include "ui/gui/psppire-dict.h"
25 #include "data/dictionary.h"
26 #include "data/identifier.h"
27 #include "data/missing-values.h"
28 #include "data/value-labels.h"
29 #include "data/variable.h"
30 #include "libpspp/i18n.h"
31 #include "libpspp/message.h"
32 #include "ui/gui/helper.h"
33 #include "ui/gui/psppire-marshal.h"
34 #include "ui/gui/psppire-var-ptr.h"
37 #define _(msgid) gettext (msgid)
38 #define N_(msgid) msgid
47 VARIABLE_DISPLAY_WIDTH_CHANGED,
56 /* --- prototypes --- */
57 static void psppire_dict_class_init (PsppireDictClass *class);
58 static void psppire_dict_init (PsppireDict *dict);
59 static void psppire_dict_dispose (GObject *object);
61 static void dictionary_tree_model_init (GtkTreeModelIface *iface);
64 /* --- variables --- */
65 static GObjectClass *parent_class = NULL;
67 static guint signals [n_SIGNALS];
69 /* --- functions --- */
71 * psppire_dict_get_type:
72 * @returns: the type ID for accelerator groups.
75 psppire_dict_get_type (void)
77 static GType object_type = 0;
81 static const GTypeInfo object_info = {
82 sizeof (PsppireDictClass),
84 (GBaseFinalizeFunc) NULL,
85 (GClassInitFunc) psppire_dict_class_init,
86 NULL, /* class_finalize */
87 NULL, /* class_data */
90 (GInstanceInitFunc) psppire_dict_init,
93 static const GInterfaceInfo tree_model_info = {
94 (GInterfaceInitFunc) dictionary_tree_model_init,
99 object_type = g_type_register_static (G_TYPE_OBJECT,
103 g_type_add_interface_static (object_type, GTK_TYPE_TREE_MODEL,
112 psppire_dict_class_init (PsppireDictClass *class)
114 GObjectClass *object_class = G_OBJECT_CLASS (class);
116 parent_class = g_type_class_peek_parent (class);
118 object_class->dispose = psppire_dict_dispose;
120 signals [BACKEND_CHANGED] =
121 g_signal_new ("backend-changed",
122 G_TYPE_FROM_CLASS (class),
126 g_cclosure_marshal_VOID__VOID,
131 signals [VARIABLE_CHANGED] =
132 g_signal_new ("variable-changed",
133 G_TYPE_FROM_CLASS (class),
137 psppire_marshal_VOID__INT_UINT_POINTER,
147 signals [VARIABLE_INSERTED] =
148 g_signal_new ("variable-inserted",
149 G_TYPE_FROM_CLASS (class),
153 g_cclosure_marshal_VOID__INT,
159 signals [VARIABLE_DELETED] =
160 g_signal_new ("variable-deleted",
161 G_TYPE_FROM_CLASS (class),
165 psppire_marshal_VOID__POINTER_INT_INT,
173 signals [VARIABLE_RESIZED] =
174 g_signal_new ("dict-size-changed",
175 G_TYPE_FROM_CLASS (class),
179 psppire_marshal_VOID__INT_INT,
185 signals [VARIABLE_DISPLAY_WIDTH_CHANGED] =
186 g_signal_new ("variable-display-width-changed",
187 G_TYPE_FROM_CLASS (class),
191 g_cclosure_marshal_VOID__INT,
197 signals [WEIGHT_CHANGED] =
198 g_signal_new ("weight-changed",
199 G_TYPE_FROM_CLASS (class),
203 g_cclosure_marshal_VOID__INT,
209 signals [FILTER_CHANGED] =
210 g_signal_new ("filter-changed",
211 G_TYPE_FROM_CLASS (class),
215 g_cclosure_marshal_VOID__INT,
221 signals [SPLIT_CHANGED] =
222 g_signal_new ("split-changed",
223 G_TYPE_FROM_CLASS (class),
227 g_cclosure_marshal_VOID__VOID,
233 psppire_dict_dispose (GObject *object)
235 PsppireDict *d = PSPPIRE_DICT (object);
237 dict_set_callbacks (d->dict, NULL, NULL);
239 G_OBJECT_CLASS (parent_class)->dispose (object);
242 /* Pass on callbacks from src/data/dictionary, as
243 signals in the Gtk library */
245 addcb (struct dictionary *d, int idx, void *pd)
247 PsppireDict *dict = PSPPIRE_DICT (pd);
249 if ( ! dict->disable_insert_signal)
250 g_signal_emit (dict, signals [VARIABLE_INSERTED], 0, idx);
254 delcb (struct dictionary *d, const struct variable *var,
255 int dict_idx, int case_idx, void *pd)
257 g_signal_emit (pd, signals [VARIABLE_DELETED], 0,
258 var, dict_idx, case_idx);
262 mutcb (struct dictionary *d, int idx, unsigned int what, const struct variable *oldvar, void *pd)
264 g_signal_emit (pd, signals [VARIABLE_CHANGED], 0, idx, what, oldvar);
268 resize_cb (struct dictionary *d, int idx, int old_width, void *pd)
270 g_signal_emit (pd, signals [VARIABLE_RESIZED], 0, idx, old_width);
274 weight_changed_callback (struct dictionary *d, int idx, void *pd)
276 g_signal_emit (pd, signals [WEIGHT_CHANGED], 0, idx);
280 filter_changed_callback (struct dictionary *d, int idx, void *pd)
282 g_signal_emit (pd, signals [FILTER_CHANGED], 0, idx);
286 split_changed_callback (struct dictionary *d, void *pd)
288 g_signal_emit (pd, signals [SPLIT_CHANGED], 0);
292 variable_display_width_callback (struct dictionary *d, int idx, void *pd)
294 g_signal_emit (pd, signals [VARIABLE_DISPLAY_WIDTH_CHANGED], 0, idx);
299 static const struct dict_callbacks gui_callbacks =
305 weight_changed_callback,
306 filter_changed_callback,
307 split_changed_callback,
308 variable_display_width_callback
312 psppire_dict_init (PsppireDict *psppire_dict)
314 psppire_dict->stamp = g_random_int ();
315 psppire_dict->disable_insert_signal = FALSE;
319 * psppire_dict_new_from_dict:
320 * @returns: a new #PsppireDict object
322 * Creates a new #PsppireDict.
325 psppire_dict_new_from_dict (struct dictionary *d)
327 PsppireDict *new_dict = g_object_new (PSPPIRE_TYPE_DICT, NULL);
330 dict_set_callbacks (new_dict->dict, &gui_callbacks, new_dict);
337 psppire_dict_replace_dictionary (PsppireDict *dict, struct dictionary *d)
339 struct variable *var = dict_get_weight (d);
343 weight_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
345 var = dict_get_filter (d);
346 filter_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
348 split_changed_callback (d, dict);
350 dict_set_callbacks (dict->dict, &gui_callbacks, dict);
352 g_signal_emit (dict, signals [BACKEND_CHANGED], 0);
356 /* Stores a valid name for a new variable in DICT into the SIZE bytes in NAME.
357 Returns true if successful, false if SIZE is insufficient. */
359 psppire_dict_generate_name (const PsppireDict *dict, char *name, size_t size)
367 /* TRANSLATORS: This string must be a valid variable name. That means:
368 - The string must be at most 64 bytes (not characters) long.
369 - The string may not contain whitespace.
370 - The first character may not be '$'
371 - The first character may not be a digit
372 - The final charactor may not be '.' or '_'
374 len = snprintf (name, size, _("Var%04d"), d);
378 if (psppire_dict_lookup_var (dict, name) == NULL)
385 /* Insert a new variable at posn IDX, with the name NAME, and return the
387 If NAME is null, then a name will be automatically assigned.
390 psppire_dict_insert_variable (PsppireDict *d, gint idx, const gchar *name)
392 struct variable *var;
395 g_return_val_if_fail (idx >= 0, NULL);
396 g_return_val_if_fail (d, NULL);
397 g_return_val_if_fail (PSPPIRE_IS_DICT (d), NULL);
401 if (!psppire_dict_generate_name (d, tmpname, sizeof tmpname))
402 g_return_val_if_reached (NULL);
407 d->disable_insert_signal = TRUE;
409 var = dict_create_var (d->dict, name, 0);
411 dict_reorder_var (d->dict, var, idx);
413 d->disable_insert_signal = FALSE;
415 g_signal_emit (d, signals[VARIABLE_INSERTED], 0, idx);
420 /* Delete N variables beginning at FIRST */
422 psppire_dict_delete_variables (PsppireDict *d, gint first, gint n)
425 g_return_if_fail (d);
426 g_return_if_fail (d->dict);
427 g_return_if_fail (PSPPIRE_IS_DICT (d));
429 for (idx = 0 ; idx < n ; ++idx )
431 struct variable *var;
433 /* Do nothing if it's out of bounds */
434 if ( first >= dict_get_var_cnt (d->dict))
437 var = dict_get_var (d->dict, first);
438 dict_delete_var (d->dict, var);
444 psppire_dict_set_name (PsppireDict* d, gint idx, const gchar *name)
446 struct variable *var;
448 g_assert (PSPPIRE_IS_DICT (d));
450 if ( ! dict_id_is_valid (d->dict, name, false))
453 if ( idx < dict_get_var_cnt (d->dict))
455 /* This is an existing variable? */
456 var = dict_get_var (d->dict, idx);
457 dict_rename_var (d->dict, var, name);
462 dict_create_var (d->dict, name, 0);
470 /* Return the IDXth variable.
471 Will return NULL if IDX exceeds the number of variables in the dictionary.
474 psppire_dict_get_variable (const PsppireDict *d, gint idx)
476 g_return_val_if_fail (d, NULL);
477 g_return_val_if_fail (d->dict, NULL);
479 if ( dict_get_var_cnt (d->dict) <= idx )
482 return dict_get_var (d->dict, idx);
486 /* Return the number of variables in the dictionary */
488 psppire_dict_get_var_cnt (const PsppireDict *d)
490 g_return_val_if_fail (d, -1);
491 g_return_val_if_fail (d->dict, -1);
493 return dict_get_var_cnt (d->dict);
497 /* Return the number of `union value's in the dictionary */
499 psppire_dict_get_value_cnt (const PsppireDict *d)
501 g_return_val_if_fail (d, -1);
502 g_return_val_if_fail (d->dict, -1);
504 return dict_get_next_value_idx (d->dict);
508 /* Returns the prototype for the cases that match the dictionary */
509 const struct caseproto *
510 psppire_dict_get_proto (const PsppireDict *d)
512 g_return_val_if_fail (d, NULL);
513 g_return_val_if_fail (d->dict, NULL);
515 return dict_get_proto (d->dict);
519 /* Return a variable by name.
520 Return NULL if it doesn't exist
523 psppire_dict_lookup_var (const PsppireDict *d, const gchar *name)
525 g_return_val_if_fail (d, NULL);
526 g_return_val_if_fail (d->dict, NULL);
528 return dict_lookup_var (d->dict, name);
531 /* Clears the contents of D */
533 psppire_dict_clear (PsppireDict *d)
535 g_return_if_fail (d);
536 g_return_if_fail (d->dict);
539 dict_clear (d->dict);
544 /* Return true is NAME would be a valid name of a variable to add to the
545 dictionary. False otherwise.
546 If REPORT is true, then invalid names will be reported as such as errors
549 psppire_dict_check_name (const PsppireDict *dict,
550 const gchar *name, gboolean report)
552 if ( ! dict_id_is_valid (dict->dict, name, report ) )
555 if (psppire_dict_lookup_var (dict, name))
558 msg (ME, _("Duplicate variable name."));
567 psppire_dict_get_next_value_idx (const PsppireDict *dict)
569 return dict_get_next_value_idx (dict->dict);
574 psppire_dict_resize_variable (PsppireDict *d, const struct variable *pv,
575 gint old_size, gint new_size)
577 g_return_if_fail (d);
578 g_return_if_fail (d->dict);
580 if ( old_size == new_size )
583 g_signal_emit (d, signals [VARIABLE_RESIZED], 0,
584 var_get_dict_index (pv),
585 new_size - old_size );
589 /* Tree Model Stuff */
591 static GtkTreeModelFlags tree_model_get_flags (GtkTreeModel *model);
593 static gint tree_model_n_columns (GtkTreeModel *model);
595 static GType tree_model_column_type (GtkTreeModel *model, gint index);
597 static gboolean tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter,
600 static gboolean tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter);
602 static GtkTreePath * tree_model_get_path (GtkTreeModel *model,
605 static void tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
606 gint column, GValue *value);
608 static gboolean tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
609 GtkTreeIter *parent, gint n);
611 static gint tree_model_n_children (GtkTreeModel *tree_model,
614 static gboolean tree_model_iter_children (GtkTreeModel *,
618 static gboolean tree_model_iter_parent (GtkTreeModel *tree_model,
622 static gboolean tree_model_iter_has_child (GtkTreeModel *tree_model,
626 dictionary_tree_model_init (GtkTreeModelIface *iface)
628 iface->get_flags = tree_model_get_flags;
629 iface->get_n_columns = tree_model_n_columns;
630 iface->get_column_type = tree_model_column_type;
631 iface->get_iter = tree_model_get_iter;
632 iface->iter_next = tree_model_iter_next;
633 iface->get_path = tree_model_get_path;
634 iface->get_value = tree_model_get_value;
636 iface->iter_children = tree_model_iter_children ;
637 iface->iter_has_child = tree_model_iter_has_child ;
638 iface->iter_n_children = tree_model_n_children ;
639 iface->iter_nth_child = tree_model_nth_child ;
640 iface->iter_parent = tree_model_iter_parent ;
644 tree_model_iter_has_child (GtkTreeModel *tree_model,
651 tree_model_iter_parent (GtkTreeModel *tree_model,
658 static GtkTreeModelFlags
659 tree_model_get_flags (GtkTreeModel *model)
661 g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GtkTreeModelFlags) 0);
663 return GTK_TREE_MODEL_LIST_ONLY;
668 tree_model_n_columns (GtkTreeModel *model)
674 tree_model_column_type (GtkTreeModel *model, gint index)
676 g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GType) 0);
680 case DICT_TVM_COL_NAME:
681 return G_TYPE_STRING;
683 case DICT_TVM_COL_VAR:
684 return PSPPIRE_VAR_PTR_TYPE;
687 g_return_val_if_reached ((GType)0);
691 g_assert_not_reached ();
696 tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter, GtkTreePath *path)
698 gint *indices, depth;
700 struct variable *var;
702 PsppireDict *dict = PSPPIRE_DICT (model);
704 g_return_val_if_fail (path, FALSE);
706 indices = gtk_tree_path_get_indices (path);
707 depth = gtk_tree_path_get_depth (path);
709 g_return_val_if_fail (depth == 1, FALSE);
713 if ( n < 0 || n >= psppire_dict_get_var_cnt (dict))
716 iter->user_data = NULL;
720 var = psppire_dict_get_variable (dict, n);
722 g_assert (var_get_dict_index (var) == n);
724 iter->stamp = dict->stamp;
725 iter->user_data = var;
732 tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter)
734 PsppireDict *dict = PSPPIRE_DICT (model);
735 struct variable *var;
738 g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
740 if ( iter == NULL || iter->user_data == NULL)
743 var = iter->user_data;
745 idx = var_get_dict_index (var);
747 if ( idx + 1 >= psppire_dict_get_var_cnt (dict))
749 iter->user_data = NULL;
754 var = psppire_dict_get_variable (dict, idx + 1);
756 g_assert (var_get_dict_index (var) == idx + 1);
758 iter->user_data = var;
764 tree_model_get_path (GtkTreeModel *model, GtkTreeIter *iter)
767 struct variable *var;
768 PsppireDict *dict = PSPPIRE_DICT (model);
770 g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
772 var = iter->user_data;
774 path = gtk_tree_path_new ();
775 gtk_tree_path_append_index (path, var_get_dict_index (var));
782 tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
783 gint column, GValue *value)
785 struct variable *var;
786 PsppireDict *dict = PSPPIRE_DICT (model);
788 g_return_if_fail (iter->stamp == dict->stamp);
790 var = iter->user_data;
794 case DICT_TVM_COL_NAME:
796 g_value_init (value, G_TYPE_STRING);
797 g_value_set_string (value, var_get_name (var));
800 case DICT_TVM_COL_VAR:
801 g_value_init (value, PSPPIRE_VAR_PTR_TYPE);
802 g_value_set_boxed (value, var);
805 g_return_if_reached ();
811 tree_model_iter_children (GtkTreeModel *tree_model,
819 tree_model_n_children (GtkTreeModel *model,
822 PsppireDict *dict = PSPPIRE_DICT (model);
825 return psppire_dict_get_var_cnt (dict);
831 tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
832 GtkTreeIter *parent, gint n)
836 g_return_val_if_fail (PSPPIRE_IS_DICT (model), FALSE);
838 dict = PSPPIRE_DICT (model);
843 if ( n >= psppire_dict_get_var_cnt (dict) )
846 iter->stamp = dict->stamp;
847 iter->user_data = psppire_dict_get_variable (dict, n);
849 if ( !iter->user_data)
857 psppire_dict_rename_var (PsppireDict *dict, struct variable *v,
860 if ( ! dict_id_is_valid (dict->dict, name, false))
863 /* Make sure no other variable has this name */
864 if ( NULL != psppire_dict_lookup_var (dict, name))
867 dict_rename_var (dict->dict, v, name);
874 psppire_dict_get_weight_variable (const PsppireDict *dict)
876 return dict_get_weight (dict->dict);
883 psppire_dict_dump (const PsppireDict *dict)
886 const struct dictionary *d = dict->dict;
888 for (i = 0; i < dict_get_var_cnt (d); ++i)
890 const struct variable *v = psppire_dict_get_variable (dict, i);
891 int di = var_get_dict_index (v);
892 g_print ("`%s' idx=%d, fv=%d\n",
895 var_get_case_index(v));
905 psppire_dict_encoding (const PsppireDict *dict)
907 return dict_get_encoding (dict->dict);