1 /* PSPPIRE - a graphical user interface for PSPP.
2 Copyright (C) 2004, 2006, 2007, 2009 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/>. */
22 #include <ui/gui/psppire-marshal.h>
24 #include "psppire-var-ptr.h"
25 #include "psppire-dict.h"
26 #include <data/dictionary.h>
27 #include <data/missing-values.h>
28 #include <data/value-labels.h>
29 #include <data/variable.h>
30 #include <libpspp/i18n.h>
33 #include "message-dialog.h"
43 VARIABLE_DISPLAY_WIDTH_CHANGED,
52 /* --- prototypes --- */
53 static void psppire_dict_class_init (PsppireDictClass *class);
54 static void psppire_dict_init (PsppireDict *dict);
55 static void psppire_dict_finalize (GObject *object);
57 static void dictionary_tree_model_init (GtkTreeModelIface *iface);
60 /* --- variables --- */
61 static GObjectClass *parent_class = NULL;
63 static guint signals [n_SIGNALS];
65 /* --- functions --- */
67 * psppire_dict_get_type:
68 * @returns: the type ID for accelerator groups.
71 psppire_dict_get_type (void)
73 static GType object_type = 0;
77 static const GTypeInfo object_info = {
78 sizeof (PsppireDictClass),
80 (GBaseFinalizeFunc) NULL,
81 (GClassInitFunc) psppire_dict_class_init,
82 NULL, /* class_finalize */
83 NULL, /* class_data */
86 (GInstanceInitFunc) psppire_dict_init,
89 static const GInterfaceInfo tree_model_info = {
90 (GInterfaceInitFunc) dictionary_tree_model_init,
95 object_type = g_type_register_static (G_TYPE_OBJECT,
99 g_type_add_interface_static (object_type, GTK_TYPE_TREE_MODEL,
108 psppire_dict_class_init (PsppireDictClass *class)
110 GObjectClass *object_class = G_OBJECT_CLASS (class);
112 parent_class = g_type_class_peek_parent (class);
114 object_class->finalize = psppire_dict_finalize;
116 signals [BACKEND_CHANGED] =
117 g_signal_new ("backend-changed",
118 G_TYPE_FROM_CLASS (class),
122 g_cclosure_marshal_VOID__VOID,
127 signals [VARIABLE_CHANGED] =
128 g_signal_new ("variable_changed",
129 G_TYPE_FROM_CLASS (class),
133 g_cclosure_marshal_VOID__INT,
140 signals [VARIABLE_INSERTED] =
141 g_signal_new ("variable_inserted",
142 G_TYPE_FROM_CLASS (class),
146 g_cclosure_marshal_VOID__INT,
152 signals [VARIABLE_DELETED] =
153 g_signal_new ("variable-deleted",
154 G_TYPE_FROM_CLASS (class),
158 psppire_marshal_VOID__INT_INT_INT,
166 signals [VARIABLE_RESIZED] =
167 g_signal_new ("dict-size-changed",
168 G_TYPE_FROM_CLASS (class),
172 psppire_marshal_VOID__INT_INT,
178 signals [VARIABLE_DISPLAY_WIDTH_CHANGED] =
179 g_signal_new ("variable-display-width-changed",
180 G_TYPE_FROM_CLASS (class),
184 g_cclosure_marshal_VOID__INT,
190 signals [WEIGHT_CHANGED] =
191 g_signal_new ("weight-changed",
192 G_TYPE_FROM_CLASS (class),
196 g_cclosure_marshal_VOID__INT,
202 signals [FILTER_CHANGED] =
203 g_signal_new ("filter-changed",
204 G_TYPE_FROM_CLASS (class),
208 g_cclosure_marshal_VOID__INT,
214 signals [SPLIT_CHANGED] =
215 g_signal_new ("split-changed",
216 G_TYPE_FROM_CLASS (class),
220 g_cclosure_marshal_VOID__VOID,
226 psppire_dict_finalize (GObject *object)
228 PsppireDict *d = PSPPIRE_DICT (object);
230 dict_destroy (d->dict);
232 G_OBJECT_CLASS (parent_class)->finalize (object);
235 /* Pass on callbacks from src/data/dictionary, as
236 signals in the Gtk library */
238 addcb (struct dictionary *d, int idx, void *pd)
240 PsppireDict *dict = PSPPIRE_DICT (pd);
242 if ( ! dict->disable_insert_signal)
243 g_signal_emit (dict, signals [VARIABLE_INSERTED], 0, idx);
247 delcb (struct dictionary *d, int dict_idx, int case_idx, int width, void *pd)
249 g_signal_emit (pd, signals [VARIABLE_DELETED], 0,
250 dict_idx, case_idx, width );
254 mutcb (struct dictionary *d, int idx, void *pd)
256 g_signal_emit (pd, signals [VARIABLE_CHANGED], 0, idx);
260 resize_cb (struct dictionary *d, int idx, int old_width, void *pd)
262 g_signal_emit (pd, signals [VARIABLE_RESIZED], 0, idx, old_width);
266 weight_changed_callback (struct dictionary *d, int idx, void *pd)
268 g_signal_emit (pd, signals [WEIGHT_CHANGED], 0, idx);
272 filter_changed_callback (struct dictionary *d, int idx, void *pd)
274 g_signal_emit (pd, signals [FILTER_CHANGED], 0, idx);
278 split_changed_callback (struct dictionary *d, void *pd)
280 g_signal_emit (pd, signals [SPLIT_CHANGED], 0);
284 variable_display_width_callback (struct dictionary *d, int idx, void *pd)
286 g_signal_emit (pd, signals [VARIABLE_DISPLAY_WIDTH_CHANGED], 0, idx);
291 static const struct dict_callbacks gui_callbacks =
297 weight_changed_callback,
298 filter_changed_callback,
299 split_changed_callback,
300 variable_display_width_callback
304 psppire_dict_init (PsppireDict *psppire_dict)
306 psppire_dict->stamp = g_random_int ();
307 psppire_dict->disable_insert_signal = FALSE;
311 * psppire_dict_new_from_dict:
312 * @returns: a new #PsppireDict object
314 * Creates a new #PsppireDict.
317 psppire_dict_new_from_dict (struct dictionary *d)
319 PsppireDict *new_dict = g_object_new (PSPPIRE_TYPE_DICT, NULL);
322 dict_set_callbacks (new_dict->dict, &gui_callbacks, new_dict);
329 psppire_dict_replace_dictionary (PsppireDict *dict, struct dictionary *d)
331 struct variable *var = dict_get_weight (d);
335 weight_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
337 var = dict_get_filter (d);
338 filter_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
340 split_changed_callback (d, dict);
342 dict_set_callbacks (dict->dict, &gui_callbacks, dict);
344 g_signal_emit (dict, signals [BACKEND_CHANGED], 0);
348 /* Returns a valid name for a new variable in DICT.
349 The return value is statically allocated */
351 auto_generate_var_name (PsppireDict *dict)
354 static gchar name[10];
356 while (g_snprintf (name, 10, "VAR%05d",d++),
357 psppire_dict_lookup_var (dict, name))
363 /* Insert a new variable at posn IDX, with the name NAME.
364 If NAME is null, then a name will be automatically assigned.
367 psppire_dict_insert_variable (PsppireDict *d, gint idx, const gchar *name)
369 struct variable *var ;
370 g_return_if_fail (idx >= 0);
371 g_return_if_fail (d);
372 g_return_if_fail (PSPPIRE_IS_DICT (d));
375 name = auto_generate_var_name (d);
377 d->disable_insert_signal = TRUE;
379 var = dict_create_var (d->dict, name, 0);
381 dict_reorder_var (d->dict, var, idx);
383 d->disable_insert_signal = FALSE;
385 g_signal_emit (d, signals[VARIABLE_INSERTED], 0, idx);
388 /* Delete N variables beginning at FIRST */
390 psppire_dict_delete_variables (PsppireDict *d, gint first, gint n)
393 g_return_if_fail (d);
394 g_return_if_fail (d->dict);
395 g_return_if_fail (PSPPIRE_IS_DICT (d));
397 for (idx = 0 ; idx < n ; ++idx )
399 struct variable *var;
401 /* Do nothing if it's out of bounds */
402 if ( first >= dict_get_var_cnt (d->dict))
405 var = dict_get_var (d->dict, first);
406 dict_delete_var (d->dict, var);
412 psppire_dict_set_name (PsppireDict* d, gint idx, const gchar *name)
414 struct variable *var;
416 g_assert (PSPPIRE_IS_DICT (d));
418 if ( ! var_is_valid_name (name, false))
421 if ( idx < dict_get_var_cnt (d->dict))
423 /* This is an existing variable? */
424 var = dict_get_var (d->dict, idx);
425 dict_rename_var (d->dict, var, name);
430 dict_create_var (d->dict, name, 0);
438 /* Return the IDXth variable.
439 Will return NULL if IDX exceeds the number of variables in the dictionary.
442 psppire_dict_get_variable (const PsppireDict *d, gint idx)
444 g_return_val_if_fail (d, NULL);
445 g_return_val_if_fail (d->dict, NULL);
447 if ( dict_get_var_cnt (d->dict) <= idx )
450 return dict_get_var (d->dict, idx);
454 /* Return the number of variables in the dictionary */
456 psppire_dict_get_var_cnt (const PsppireDict *d)
458 g_return_val_if_fail (d, -1);
459 g_return_val_if_fail (d->dict, -1);
461 return dict_get_var_cnt (d->dict);
465 /* Return the number of `union value's in the dictionary */
467 psppire_dict_get_value_cnt (const PsppireDict *d)
469 g_return_val_if_fail (d, -1);
470 g_return_val_if_fail (d->dict, -1);
472 return dict_get_next_value_idx (d->dict);
476 /* Returns the prototype for the cases that match the dictionary */
477 const struct caseproto *
478 psppire_dict_get_proto (const PsppireDict *d)
480 g_return_val_if_fail (d, NULL);
481 g_return_val_if_fail (d->dict, NULL);
483 return dict_get_proto (d->dict);
487 /* Return a variable by name.
488 Return NULL if it doesn't exist
491 psppire_dict_lookup_var (const PsppireDict *d, const gchar *name)
493 g_return_val_if_fail (d, NULL);
494 g_return_val_if_fail (d->dict, NULL);
496 return dict_lookup_var (d->dict, name);
499 /* Clears the contents of D */
501 psppire_dict_clear (PsppireDict *d)
503 g_return_if_fail (d);
504 g_return_if_fail (d->dict);
507 dict_clear (d->dict);
512 /* Return true is NAME would be a valid name of a variable to add to the
513 dictionary. False otherwise.
514 If REPORT is true, then invalid names will be reported as such as errors
517 psppire_dict_check_name (const PsppireDict *dict,
518 const gchar *name, gboolean report)
520 if ( ! var_is_valid_name (name, report ) )
523 if (psppire_dict_lookup_var (dict, name))
526 msg (ME,"Duplicate variable name.");
535 psppire_dict_get_next_value_idx (const PsppireDict *dict)
537 return dict_get_next_value_idx (dict->dict);
542 psppire_dict_resize_variable (PsppireDict *d, const struct variable *pv,
543 gint old_size, gint new_size)
545 g_return_if_fail (d);
546 g_return_if_fail (d->dict);
548 if ( old_size == new_size )
551 g_signal_emit (d, signals [VARIABLE_RESIZED], 0,
552 var_get_dict_index (pv),
553 new_size - old_size );
557 /* Tree Model Stuff */
559 static GtkTreeModelFlags tree_model_get_flags (GtkTreeModel *model);
561 static gint tree_model_n_columns (GtkTreeModel *model);
563 static GType tree_model_column_type (GtkTreeModel *model, gint index);
565 static gboolean tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter,
568 static gboolean tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter);
570 static GtkTreePath * tree_model_get_path (GtkTreeModel *model,
573 static void tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
574 gint column, GValue *value);
576 static gboolean tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
577 GtkTreeIter *parent, gint n);
579 static gint tree_model_n_children (GtkTreeModel *tree_model,
582 static gboolean tree_model_iter_children (GtkTreeModel *,
586 static gboolean tree_model_iter_parent (GtkTreeModel *tree_model,
590 static gboolean tree_model_iter_has_child (GtkTreeModel *tree_model,
594 dictionary_tree_model_init (GtkTreeModelIface *iface)
596 iface->get_flags = tree_model_get_flags;
597 iface->get_n_columns = tree_model_n_columns;
598 iface->get_column_type = tree_model_column_type;
599 iface->get_iter = tree_model_get_iter;
600 iface->iter_next = tree_model_iter_next;
601 iface->get_path = tree_model_get_path;
602 iface->get_value = tree_model_get_value;
604 iface->iter_children = tree_model_iter_children ;
605 iface->iter_has_child = tree_model_iter_has_child ;
606 iface->iter_n_children = tree_model_n_children ;
607 iface->iter_nth_child = tree_model_nth_child ;
608 iface->iter_parent = tree_model_iter_parent ;
612 tree_model_iter_has_child (GtkTreeModel *tree_model,
619 tree_model_iter_parent (GtkTreeModel *tree_model,
626 static GtkTreeModelFlags
627 tree_model_get_flags (GtkTreeModel *model)
629 g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GtkTreeModelFlags) 0);
631 return GTK_TREE_MODEL_LIST_ONLY;
636 tree_model_n_columns (GtkTreeModel *model)
642 tree_model_column_type (GtkTreeModel *model, gint index)
644 g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GType) 0);
648 case DICT_TVM_COL_NAME:
649 return G_TYPE_STRING;
651 case DICT_TVM_COL_VAR:
652 return PSPPIRE_VAR_PTR_TYPE;
655 g_return_val_if_reached ((GType)0);
659 g_assert_not_reached ();
664 tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter, GtkTreePath *path)
666 gint *indices, depth;
668 struct variable *var;
670 PsppireDict *dict = PSPPIRE_DICT (model);
672 g_return_val_if_fail (path, FALSE);
674 indices = gtk_tree_path_get_indices (path);
675 depth = gtk_tree_path_get_depth (path);
677 g_return_val_if_fail (depth == 1, FALSE);
681 if ( n < 0 || n >= psppire_dict_get_var_cnt (dict))
684 iter->user_data = NULL;
688 var = psppire_dict_get_variable (dict, n);
690 g_assert (var_get_dict_index (var) == n);
692 iter->stamp = dict->stamp;
693 iter->user_data = var;
700 tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter)
702 PsppireDict *dict = PSPPIRE_DICT (model);
703 struct variable *var;
706 g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
708 if ( iter == NULL || iter->user_data == NULL)
711 var = iter->user_data;
713 idx = var_get_dict_index (var);
715 if ( idx + 1 >= psppire_dict_get_var_cnt (dict))
717 iter->user_data = NULL;
722 var = psppire_dict_get_variable (dict, idx + 1);
724 g_assert (var_get_dict_index (var) == idx + 1);
726 iter->user_data = var;
732 tree_model_get_path (GtkTreeModel *model, GtkTreeIter *iter)
735 struct variable *var;
736 PsppireDict *dict = PSPPIRE_DICT (model);
738 g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
740 var = iter->user_data;
742 path = gtk_tree_path_new ();
743 gtk_tree_path_append_index (path, var_get_dict_index (var));
750 tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
751 gint column, GValue *value)
753 struct variable *var;
754 PsppireDict *dict = PSPPIRE_DICT (model);
756 g_return_if_fail (iter->stamp == dict->stamp);
758 var = iter->user_data;
762 case DICT_TVM_COL_NAME:
764 g_value_init (value, G_TYPE_STRING);
765 g_value_set_string (value, var_get_name (var));
768 case DICT_TVM_COL_VAR:
769 g_value_init (value, PSPPIRE_VAR_PTR_TYPE);
770 g_value_set_boxed (value, var);
773 g_return_if_reached ();
779 tree_model_iter_children (GtkTreeModel *tree_model,
787 tree_model_n_children (GtkTreeModel *model,
790 PsppireDict *dict = PSPPIRE_DICT (model);
793 return psppire_dict_get_var_cnt (dict);
799 tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
800 GtkTreeIter *parent, gint n)
804 g_return_val_if_fail (PSPPIRE_IS_DICT (model), FALSE);
806 dict = PSPPIRE_DICT (model);
811 if ( n >= psppire_dict_get_var_cnt (dict) )
814 iter->stamp = dict->stamp;
815 iter->user_data = psppire_dict_get_variable (dict, n);
817 if ( !iter->user_data)
825 psppire_dict_rename_var (PsppireDict *dict, struct variable *v,
828 if ( ! var_is_valid_name (name, false))
831 /* Make sure no other variable has this name */
832 if ( NULL != psppire_dict_lookup_var (dict, name))
835 dict_rename_var (dict->dict, v, name);
842 psppire_dict_get_weight_variable (const PsppireDict *dict)
844 return dict_get_weight (dict->dict);
851 psppire_dict_dump (const PsppireDict *dict)
854 const struct dictionary *d = dict->dict;
856 for (i = 0; i < dict_get_var_cnt (d); ++i)
858 const struct variable *v = psppire_dict_get_variable (dict, i);
859 int di = var_get_dict_index (v);
860 g_print ("\"%s\" idx=%d, fv=%d\n",
863 var_get_case_index(v));
873 psppire_dict_encoding (const PsppireDict *dict)
875 return dict_get_encoding (dict->dict);