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-dict.h"
25 #include <data/dictionary.h>
26 #include <data/missing-values.h>
27 #include <data/value-labels.h>
28 #include <data/variable.h>
29 #include <libpspp/i18n.h>
32 #include "message-dialog.h"
42 VARIABLE_DISPLAY_WIDTH_CHANGED,
51 /* --- prototypes --- */
52 static void psppire_dict_class_init (PsppireDictClass *class);
53 static void psppire_dict_init (PsppireDict *dict);
54 static void psppire_dict_finalize (GObject *object);
56 static void dictionary_tree_model_init (GtkTreeModelIface *iface);
59 /* --- variables --- */
60 static GObjectClass *parent_class = NULL;
62 static guint signals [n_SIGNALS];
64 /* --- functions --- */
66 * psppire_dict_get_type:
67 * @returns: the type ID for accelerator groups.
70 psppire_dict_get_type (void)
72 static GType object_type = 0;
76 static const GTypeInfo object_info = {
77 sizeof (PsppireDictClass),
79 (GBaseFinalizeFunc) NULL,
80 (GClassInitFunc) psppire_dict_class_init,
81 NULL, /* class_finalize */
82 NULL, /* class_data */
85 (GInstanceInitFunc) psppire_dict_init,
88 static const GInterfaceInfo tree_model_info = {
89 (GInterfaceInitFunc) dictionary_tree_model_init,
94 object_type = g_type_register_static (G_TYPE_OBJECT,
98 g_type_add_interface_static (object_type, GTK_TYPE_TREE_MODEL,
107 psppire_dict_class_init (PsppireDictClass *class)
109 GObjectClass *object_class = G_OBJECT_CLASS (class);
111 parent_class = g_type_class_peek_parent (class);
113 object_class->finalize = psppire_dict_finalize;
115 signals [BACKEND_CHANGED] =
116 g_signal_new ("backend-changed",
117 G_TYPE_FROM_CLASS (class),
121 g_cclosure_marshal_VOID__VOID,
126 signals [VARIABLE_CHANGED] =
127 g_signal_new ("variable_changed",
128 G_TYPE_FROM_CLASS (class),
132 g_cclosure_marshal_VOID__INT,
139 signals [VARIABLE_INSERTED] =
140 g_signal_new ("variable_inserted",
141 G_TYPE_FROM_CLASS (class),
145 g_cclosure_marshal_VOID__INT,
151 signals [VARIABLE_DELETED] =
152 g_signal_new ("variable-deleted",
153 G_TYPE_FROM_CLASS (class),
157 psppire_marshal_VOID__INT_INT_INT,
165 signals [VARIABLE_RESIZED] =
166 g_signal_new ("dict-size-changed",
167 G_TYPE_FROM_CLASS (class),
171 psppire_marshal_VOID__INT_INT,
177 signals [VARIABLE_DISPLAY_WIDTH_CHANGED] =
178 g_signal_new ("variable-display-width-changed",
179 G_TYPE_FROM_CLASS (class),
183 g_cclosure_marshal_VOID__INT,
189 signals [WEIGHT_CHANGED] =
190 g_signal_new ("weight-changed",
191 G_TYPE_FROM_CLASS (class),
195 g_cclosure_marshal_VOID__INT,
201 signals [FILTER_CHANGED] =
202 g_signal_new ("filter-changed",
203 G_TYPE_FROM_CLASS (class),
207 g_cclosure_marshal_VOID__INT,
213 signals [SPLIT_CHANGED] =
214 g_signal_new ("split-changed",
215 G_TYPE_FROM_CLASS (class),
219 g_cclosure_marshal_VOID__VOID,
225 psppire_dict_finalize (GObject *object)
227 PsppireDict *d = PSPPIRE_DICT (object);
229 dict_destroy (d->dict);
231 G_OBJECT_CLASS (parent_class)->finalize (object);
234 /* Pass on callbacks from src/data/dictionary, as
235 signals in the Gtk library */
237 addcb (struct dictionary *d, int idx, void *pd)
239 PsppireDict *dict = PSPPIRE_DICT (pd);
241 if ( ! dict->disable_insert_signal)
242 g_signal_emit (dict, signals [VARIABLE_INSERTED], 0, idx);
246 delcb (struct dictionary *d, int dict_idx, int case_idx, int width, void *pd)
248 g_signal_emit (pd, signals [VARIABLE_DELETED], 0,
249 dict_idx, case_idx, width );
253 mutcb (struct dictionary *d, int idx, void *pd)
255 g_signal_emit (pd, signals [VARIABLE_CHANGED], 0, idx);
259 resize_cb (struct dictionary *d, int idx, int old_width, void *pd)
261 g_signal_emit (pd, signals [VARIABLE_RESIZED], 0, idx, old_width);
265 weight_changed_callback (struct dictionary *d, int idx, void *pd)
267 g_signal_emit (pd, signals [WEIGHT_CHANGED], 0, idx);
271 filter_changed_callback (struct dictionary *d, int idx, void *pd)
273 g_signal_emit (pd, signals [FILTER_CHANGED], 0, idx);
277 split_changed_callback (struct dictionary *d, void *pd)
279 g_signal_emit (pd, signals [SPLIT_CHANGED], 0);
283 variable_display_width_callback (struct dictionary *d, int idx, void *pd)
285 g_signal_emit (pd, signals [VARIABLE_DISPLAY_WIDTH_CHANGED], 0, idx);
290 static const struct dict_callbacks gui_callbacks =
296 weight_changed_callback,
297 filter_changed_callback,
298 split_changed_callback,
299 variable_display_width_callback
303 psppire_dict_init (PsppireDict *psppire_dict)
305 psppire_dict->stamp = g_random_int ();
306 psppire_dict->disable_insert_signal = FALSE;
310 * psppire_dict_new_from_dict:
311 * @returns: a new #PsppireDict object
313 * Creates a new #PsppireDict.
316 psppire_dict_new_from_dict (struct dictionary *d)
318 PsppireDict *new_dict = g_object_new (PSPPIRE_TYPE_DICT, NULL);
321 dict_set_callbacks (new_dict->dict, &gui_callbacks, new_dict);
328 psppire_dict_replace_dictionary (PsppireDict *dict, struct dictionary *d)
330 struct variable *var = dict_get_weight (d);
334 weight_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
336 var = dict_get_filter (d);
337 filter_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
339 split_changed_callback (d, dict);
341 dict_set_callbacks (dict->dict, &gui_callbacks, dict);
343 g_signal_emit (dict, signals [BACKEND_CHANGED], 0);
347 /* Returns a valid name for a new variable in DICT.
348 The return value is statically allocated */
350 auto_generate_var_name (PsppireDict *dict)
353 static gchar name[10];
355 while (g_snprintf (name, 10, "VAR%05d",d++),
356 psppire_dict_lookup_var (dict, name))
362 /* Insert a new variable at posn IDX, with the name NAME.
363 If NAME is null, then a name will be automatically assigned.
366 psppire_dict_insert_variable (PsppireDict *d, gint idx, const gchar *name)
368 struct variable *var ;
369 g_return_if_fail (idx >= 0);
370 g_return_if_fail (d);
371 g_return_if_fail (PSPPIRE_IS_DICT (d));
374 name = auto_generate_var_name (d);
376 d->disable_insert_signal = TRUE;
378 var = dict_create_var (d->dict, name, 0);
380 dict_reorder_var (d->dict, var, idx);
382 d->disable_insert_signal = FALSE;
384 g_signal_emit (d, signals[VARIABLE_INSERTED], 0, idx);
387 /* Delete N variables beginning at FIRST */
389 psppire_dict_delete_variables (PsppireDict *d, gint first, gint n)
392 g_return_if_fail (d);
393 g_return_if_fail (d->dict);
394 g_return_if_fail (PSPPIRE_IS_DICT (d));
396 for (idx = 0 ; idx < n ; ++idx )
398 struct variable *var;
400 /* Do nothing if it's out of bounds */
401 if ( first >= dict_get_var_cnt (d->dict))
404 var = dict_get_var (d->dict, first);
405 dict_delete_var (d->dict, var);
411 psppire_dict_set_name (PsppireDict* d, gint idx, const gchar *name)
413 struct variable *var;
415 g_assert (PSPPIRE_IS_DICT (d));
417 if ( ! var_is_valid_name (name, false))
420 if ( idx < dict_get_var_cnt (d->dict))
422 /* This is an existing variable? */
423 var = dict_get_var (d->dict, idx);
424 dict_rename_var (d->dict, var, name);
429 dict_create_var (d->dict, name, 0);
437 /* Return the IDXth variable.
438 Will return NULL if IDX exceeds the number of variables in the dictionary.
441 psppire_dict_get_variable (const PsppireDict *d, gint idx)
443 g_return_val_if_fail (d, NULL);
444 g_return_val_if_fail (d->dict, NULL);
446 if ( dict_get_var_cnt (d->dict) <= idx )
449 return dict_get_var (d->dict, idx);
453 /* Return the number of variables in the dictionary */
455 psppire_dict_get_var_cnt (const PsppireDict *d)
457 g_return_val_if_fail (d, -1);
458 g_return_val_if_fail (d->dict, -1);
460 return dict_get_var_cnt (d->dict);
464 /* Return the number of `union value's in the dictionary */
466 psppire_dict_get_value_cnt (const PsppireDict *d)
468 g_return_val_if_fail (d, -1);
469 g_return_val_if_fail (d->dict, -1);
471 return dict_get_next_value_idx (d->dict);
475 /* Returns the prototype for the cases that match the dictionary */
476 const struct caseproto *
477 psppire_dict_get_proto (const PsppireDict *d)
479 g_return_val_if_fail (d, NULL);
480 g_return_val_if_fail (d->dict, NULL);
482 return dict_get_proto (d->dict);
486 /* Return a variable by name.
487 Return NULL if it doesn't exist
490 psppire_dict_lookup_var (const PsppireDict *d, const gchar *name)
492 g_return_val_if_fail (d, NULL);
493 g_return_val_if_fail (d->dict, NULL);
495 return dict_lookup_var (d->dict, name);
498 /* Clears the contents of D */
500 psppire_dict_clear (PsppireDict *d)
502 g_return_if_fail (d);
503 g_return_if_fail (d->dict);
506 dict_clear (d->dict);
511 /* Return true is NAME would be a valid name of a variable to add to the
512 dictionary. False otherwise.
513 If REPORT is true, then invalid names will be reported as such as errors
516 psppire_dict_check_name (const PsppireDict *dict,
517 const gchar *name, gboolean report)
519 if ( ! var_is_valid_name (name, report ) )
522 if (psppire_dict_lookup_var (dict, name))
525 msg (ME,"Duplicate variable name.");
534 psppire_dict_get_next_value_idx (const PsppireDict *dict)
536 return dict_get_next_value_idx (dict->dict);
541 psppire_dict_resize_variable (PsppireDict *d, const struct variable *pv,
542 gint old_size, gint new_size)
544 g_return_if_fail (d);
545 g_return_if_fail (d->dict);
547 if ( old_size == new_size )
550 g_signal_emit (d, signals [VARIABLE_RESIZED], 0,
551 var_get_dict_index (pv),
552 new_size - old_size );
556 /* Tree Model Stuff */
558 static GtkTreeModelFlags tree_model_get_flags (GtkTreeModel *model);
560 static gint tree_model_n_columns (GtkTreeModel *model);
562 static GType tree_model_column_type (GtkTreeModel *model, gint index);
564 static gboolean tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter,
567 static gboolean tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter);
569 static GtkTreePath * tree_model_get_path (GtkTreeModel *model,
572 static void tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
573 gint column, GValue *value);
575 static gboolean tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
576 GtkTreeIter *parent, gint n);
578 static gint tree_model_n_children (GtkTreeModel *tree_model,
581 static gboolean tree_model_iter_children (GtkTreeModel *,
585 static gboolean tree_model_iter_parent (GtkTreeModel *tree_model,
589 static gboolean tree_model_iter_has_child (GtkTreeModel *tree_model,
593 dictionary_tree_model_init (GtkTreeModelIface *iface)
595 iface->get_flags = tree_model_get_flags;
596 iface->get_n_columns = tree_model_n_columns;
597 iface->get_column_type = tree_model_column_type;
598 iface->get_iter = tree_model_get_iter;
599 iface->iter_next = tree_model_iter_next;
600 iface->get_path = tree_model_get_path;
601 iface->get_value = tree_model_get_value;
603 iface->iter_children = tree_model_iter_children ;
604 iface->iter_has_child = tree_model_iter_has_child ;
605 iface->iter_n_children = tree_model_n_children ;
606 iface->iter_nth_child = tree_model_nth_child ;
607 iface->iter_parent = tree_model_iter_parent ;
611 tree_model_iter_has_child (GtkTreeModel *tree_model,
618 tree_model_iter_parent (GtkTreeModel *tree_model,
625 static GtkTreeModelFlags
626 tree_model_get_flags (GtkTreeModel *model)
628 g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GtkTreeModelFlags) 0);
630 return GTK_TREE_MODEL_LIST_ONLY;
635 tree_model_n_columns (GtkTreeModel *model)
641 tree_model_column_type (GtkTreeModel *model, gint index)
643 g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GType) 0);
647 case DICT_TVM_COL_NAME:
648 return G_TYPE_STRING;
650 case DICT_TVM_COL_VAR:
651 return G_TYPE_POINTER;
654 g_return_val_if_reached ((GType)0);
658 g_assert_not_reached ();
663 tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter, GtkTreePath *path)
665 gint *indices, depth;
667 struct variable *var;
669 PsppireDict *dict = PSPPIRE_DICT (model);
671 g_return_val_if_fail (path, FALSE);
673 indices = gtk_tree_path_get_indices (path);
674 depth = gtk_tree_path_get_depth (path);
676 g_return_val_if_fail (depth == 1, FALSE);
680 if ( n < 0 || n >= psppire_dict_get_var_cnt (dict))
683 iter->user_data = NULL;
687 var = psppire_dict_get_variable (dict, n);
689 g_assert (var_get_dict_index (var) == n);
691 iter->stamp = dict->stamp;
692 iter->user_data = var;
699 tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter)
701 PsppireDict *dict = PSPPIRE_DICT (model);
702 struct variable *var;
705 g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
707 if ( iter == NULL || iter->user_data == NULL)
710 var = iter->user_data;
712 idx = var_get_dict_index (var);
714 if ( idx + 1 >= psppire_dict_get_var_cnt (dict))
716 iter->user_data = NULL;
721 var = psppire_dict_get_variable (dict, idx + 1);
723 g_assert (var_get_dict_index (var) == idx + 1);
725 iter->user_data = var;
731 tree_model_get_path (GtkTreeModel *model, GtkTreeIter *iter)
734 struct variable *var;
735 PsppireDict *dict = PSPPIRE_DICT (model);
737 g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
739 var = iter->user_data;
741 path = gtk_tree_path_new ();
742 gtk_tree_path_append_index (path, var_get_dict_index (var));
749 tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
750 gint column, GValue *value)
752 struct variable *var;
753 PsppireDict *dict = PSPPIRE_DICT (model);
755 g_return_if_fail (iter->stamp == dict->stamp);
757 var = iter->user_data;
761 case DICT_TVM_COL_NAME:
763 gchar *name = recode_string (UTF8, psppire_dict_encoding (dict),
764 var_get_name (var), -1);
765 g_value_init (value, G_TYPE_STRING);
766 g_value_set_string (value, name);
770 case DICT_TVM_COL_VAR:
771 g_value_init (value, G_TYPE_POINTER);
772 g_value_set_pointer (value, var);
775 g_return_if_reached ();
781 tree_model_iter_children (GtkTreeModel *tree_model,
789 tree_model_n_children (GtkTreeModel *model,
792 PsppireDict *dict = PSPPIRE_DICT (model);
795 return psppire_dict_get_var_cnt (dict);
801 tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
802 GtkTreeIter *parent, gint n)
806 g_return_val_if_fail (PSPPIRE_IS_DICT (model), FALSE);
808 dict = PSPPIRE_DICT (model);
813 if ( n >= psppire_dict_get_var_cnt (dict) )
816 iter->stamp = dict->stamp;
817 iter->user_data = psppire_dict_get_variable (dict, n);
819 if ( !iter->user_data)
827 psppire_dict_rename_var (PsppireDict *dict, struct variable *v,
830 if ( ! var_is_valid_name (name, false))
833 /* Make sure no other variable has this name */
834 if ( NULL != psppire_dict_lookup_var (dict, name))
837 dict_rename_var (dict->dict, v, name);
844 psppire_dict_get_weight_variable (const PsppireDict *dict)
846 return dict_get_weight (dict->dict);
853 psppire_dict_dump (const PsppireDict *dict)
856 const struct dictionary *d = dict->dict;
858 for (i = 0; i < dict_get_var_cnt (d); ++i)
860 const struct variable *v = psppire_dict_get_variable (dict, i);
861 int di = var_get_dict_index (v);
862 g_print ("\"%s\" idx=%d, fv=%d, size=%d\n",
865 var_get_case_index(v),
866 value_cnt_from_width(var_get_width(v)));
876 psppire_dict_encoding (const PsppireDict *dict)
878 return dict_get_encoding (dict->dict);