1 /* PSPPIRE - a graphical user interface for PSPP.
2 Copyright (C) 2004, 2006, 2007, 2009, 2010, 2011 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_finalize (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->finalize = psppire_dict_finalize;
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 g_cclosure_marshal_VOID__INT,
144 signals [VARIABLE_INSERTED] =
145 g_signal_new ("variable_inserted",
146 G_TYPE_FROM_CLASS (class),
150 g_cclosure_marshal_VOID__INT,
156 signals [VARIABLE_DELETED] =
157 g_signal_new ("variable-deleted",
158 G_TYPE_FROM_CLASS (class),
162 psppire_marshal_VOID__INT_INT_INT,
170 signals [VARIABLE_RESIZED] =
171 g_signal_new ("dict-size-changed",
172 G_TYPE_FROM_CLASS (class),
176 psppire_marshal_VOID__INT_INT,
182 signals [VARIABLE_DISPLAY_WIDTH_CHANGED] =
183 g_signal_new ("variable-display-width-changed",
184 G_TYPE_FROM_CLASS (class),
188 g_cclosure_marshal_VOID__INT,
194 signals [WEIGHT_CHANGED] =
195 g_signal_new ("weight-changed",
196 G_TYPE_FROM_CLASS (class),
200 g_cclosure_marshal_VOID__INT,
206 signals [FILTER_CHANGED] =
207 g_signal_new ("filter-changed",
208 G_TYPE_FROM_CLASS (class),
212 g_cclosure_marshal_VOID__INT,
218 signals [SPLIT_CHANGED] =
219 g_signal_new ("split-changed",
220 G_TYPE_FROM_CLASS (class),
224 g_cclosure_marshal_VOID__VOID,
230 psppire_dict_finalize (GObject *object)
232 PsppireDict *d = PSPPIRE_DICT (object);
234 dict_destroy (d->dict);
236 G_OBJECT_CLASS (parent_class)->finalize (object);
239 /* Pass on callbacks from src/data/dictionary, as
240 signals in the Gtk library */
242 addcb (struct dictionary *d, int idx, void *pd)
244 PsppireDict *dict = PSPPIRE_DICT (pd);
246 if ( ! dict->disable_insert_signal)
247 g_signal_emit (dict, signals [VARIABLE_INSERTED], 0, idx);
251 delcb (struct dictionary *d, int dict_idx, int case_idx, int width, void *pd)
253 g_signal_emit (pd, signals [VARIABLE_DELETED], 0,
254 dict_idx, case_idx, width );
258 mutcb (struct dictionary *d, int idx, void *pd)
260 g_signal_emit (pd, signals [VARIABLE_CHANGED], 0, idx);
264 resize_cb (struct dictionary *d, int idx, int old_width, void *pd)
266 g_signal_emit (pd, signals [VARIABLE_RESIZED], 0, idx, old_width);
270 weight_changed_callback (struct dictionary *d, int idx, void *pd)
272 g_signal_emit (pd, signals [WEIGHT_CHANGED], 0, idx);
276 filter_changed_callback (struct dictionary *d, int idx, void *pd)
278 g_signal_emit (pd, signals [FILTER_CHANGED], 0, idx);
282 split_changed_callback (struct dictionary *d, void *pd)
284 g_signal_emit (pd, signals [SPLIT_CHANGED], 0);
288 variable_display_width_callback (struct dictionary *d, int idx, void *pd)
290 g_signal_emit (pd, signals [VARIABLE_DISPLAY_WIDTH_CHANGED], 0, idx);
295 static const struct dict_callbacks gui_callbacks =
301 weight_changed_callback,
302 filter_changed_callback,
303 split_changed_callback,
304 variable_display_width_callback
308 psppire_dict_init (PsppireDict *psppire_dict)
310 psppire_dict->stamp = g_random_int ();
311 psppire_dict->disable_insert_signal = FALSE;
315 * psppire_dict_new_from_dict:
316 * @returns: a new #PsppireDict object
318 * Creates a new #PsppireDict.
321 psppire_dict_new_from_dict (struct dictionary *d)
323 PsppireDict *new_dict = g_object_new (PSPPIRE_TYPE_DICT, NULL);
326 dict_set_callbacks (new_dict->dict, &gui_callbacks, new_dict);
333 psppire_dict_replace_dictionary (PsppireDict *dict, struct dictionary *d)
335 struct variable *var = dict_get_weight (d);
339 weight_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
341 var = dict_get_filter (d);
342 filter_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
344 split_changed_callback (d, dict);
346 dict_set_callbacks (dict->dict, &gui_callbacks, dict);
348 g_signal_emit (dict, signals [BACKEND_CHANGED], 0);
352 /* Returns a valid name for a new variable in DICT.
353 The return value is statically allocated */
355 auto_generate_var_name (PsppireDict *dict)
358 static gchar name[10];
360 /* TRANSLATORS: This string must be a valid variable name. That means:
361 - The string must be at most 64 bytes (not characters) long.
362 - The string may not contain whitespace.
363 - The first character may not be '$'
364 - The first character may not be a digit
365 - The final charactor may not be '.' or '_'
367 while (g_snprintf (name, 10, _("VAR%05d"), d++),
368 psppire_dict_lookup_var (dict, name))
374 /* Insert a new variable at posn IDX, with the name NAME.
375 If NAME is null, then a name will be automatically assigned.
378 psppire_dict_insert_variable (PsppireDict *d, gint idx, const gchar *name)
380 struct variable *var ;
381 g_return_if_fail (idx >= 0);
382 g_return_if_fail (d);
383 g_return_if_fail (PSPPIRE_IS_DICT (d));
386 name = auto_generate_var_name (d);
388 d->disable_insert_signal = TRUE;
390 var = dict_create_var (d->dict, name, 0);
392 dict_reorder_var (d->dict, var, idx);
394 d->disable_insert_signal = FALSE;
396 g_signal_emit (d, signals[VARIABLE_INSERTED], 0, idx);
399 /* Delete N variables beginning at FIRST */
401 psppire_dict_delete_variables (PsppireDict *d, gint first, gint n)
404 g_return_if_fail (d);
405 g_return_if_fail (d->dict);
406 g_return_if_fail (PSPPIRE_IS_DICT (d));
408 for (idx = 0 ; idx < n ; ++idx )
410 struct variable *var;
412 /* Do nothing if it's out of bounds */
413 if ( first >= dict_get_var_cnt (d->dict))
416 var = dict_get_var (d->dict, first);
417 dict_delete_var (d->dict, var);
423 psppire_dict_set_name (PsppireDict* d, gint idx, const gchar *name)
425 struct variable *var;
427 g_assert (PSPPIRE_IS_DICT (d));
429 if ( ! dict_id_is_valid (d->dict, name, false))
432 if ( idx < dict_get_var_cnt (d->dict))
434 /* This is an existing variable? */
435 var = dict_get_var (d->dict, idx);
436 dict_rename_var (d->dict, var, name);
441 dict_create_var (d->dict, name, 0);
449 /* Return the IDXth variable.
450 Will return NULL if IDX exceeds the number of variables in the dictionary.
453 psppire_dict_get_variable (const PsppireDict *d, gint idx)
455 g_return_val_if_fail (d, NULL);
456 g_return_val_if_fail (d->dict, NULL);
458 if ( dict_get_var_cnt (d->dict) <= idx )
461 return dict_get_var (d->dict, idx);
465 /* Return the number of variables in the dictionary */
467 psppire_dict_get_var_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_var_cnt (d->dict);
476 /* Return the number of `union value's in the dictionary */
478 psppire_dict_get_value_cnt (const PsppireDict *d)
480 g_return_val_if_fail (d, -1);
481 g_return_val_if_fail (d->dict, -1);
483 return dict_get_next_value_idx (d->dict);
487 /* Returns the prototype for the cases that match the dictionary */
488 const struct caseproto *
489 psppire_dict_get_proto (const PsppireDict *d)
491 g_return_val_if_fail (d, NULL);
492 g_return_val_if_fail (d->dict, NULL);
494 return dict_get_proto (d->dict);
498 /* Return a variable by name.
499 Return NULL if it doesn't exist
502 psppire_dict_lookup_var (const PsppireDict *d, const gchar *name)
504 g_return_val_if_fail (d, NULL);
505 g_return_val_if_fail (d->dict, NULL);
507 return dict_lookup_var (d->dict, name);
510 /* Clears the contents of D */
512 psppire_dict_clear (PsppireDict *d)
514 g_return_if_fail (d);
515 g_return_if_fail (d->dict);
518 dict_clear (d->dict);
523 /* Return true is NAME would be a valid name of a variable to add to the
524 dictionary. False otherwise.
525 If REPORT is true, then invalid names will be reported as such as errors
528 psppire_dict_check_name (const PsppireDict *dict,
529 const gchar *name, gboolean report)
531 if ( ! dict_id_is_valid (dict->dict, name, report ) )
534 if (psppire_dict_lookup_var (dict, name))
537 msg (ME, _("Duplicate variable name."));
546 psppire_dict_get_next_value_idx (const PsppireDict *dict)
548 return dict_get_next_value_idx (dict->dict);
553 psppire_dict_resize_variable (PsppireDict *d, const struct variable *pv,
554 gint old_size, gint new_size)
556 g_return_if_fail (d);
557 g_return_if_fail (d->dict);
559 if ( old_size == new_size )
562 g_signal_emit (d, signals [VARIABLE_RESIZED], 0,
563 var_get_dict_index (pv),
564 new_size - old_size );
568 /* Tree Model Stuff */
570 static GtkTreeModelFlags tree_model_get_flags (GtkTreeModel *model);
572 static gint tree_model_n_columns (GtkTreeModel *model);
574 static GType tree_model_column_type (GtkTreeModel *model, gint index);
576 static gboolean tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter,
579 static gboolean tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter);
581 static GtkTreePath * tree_model_get_path (GtkTreeModel *model,
584 static void tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
585 gint column, GValue *value);
587 static gboolean tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
588 GtkTreeIter *parent, gint n);
590 static gint tree_model_n_children (GtkTreeModel *tree_model,
593 static gboolean tree_model_iter_children (GtkTreeModel *,
597 static gboolean tree_model_iter_parent (GtkTreeModel *tree_model,
601 static gboolean tree_model_iter_has_child (GtkTreeModel *tree_model,
605 dictionary_tree_model_init (GtkTreeModelIface *iface)
607 iface->get_flags = tree_model_get_flags;
608 iface->get_n_columns = tree_model_n_columns;
609 iface->get_column_type = tree_model_column_type;
610 iface->get_iter = tree_model_get_iter;
611 iface->iter_next = tree_model_iter_next;
612 iface->get_path = tree_model_get_path;
613 iface->get_value = tree_model_get_value;
615 iface->iter_children = tree_model_iter_children ;
616 iface->iter_has_child = tree_model_iter_has_child ;
617 iface->iter_n_children = tree_model_n_children ;
618 iface->iter_nth_child = tree_model_nth_child ;
619 iface->iter_parent = tree_model_iter_parent ;
623 tree_model_iter_has_child (GtkTreeModel *tree_model,
630 tree_model_iter_parent (GtkTreeModel *tree_model,
637 static GtkTreeModelFlags
638 tree_model_get_flags (GtkTreeModel *model)
640 g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GtkTreeModelFlags) 0);
642 return GTK_TREE_MODEL_LIST_ONLY;
647 tree_model_n_columns (GtkTreeModel *model)
653 tree_model_column_type (GtkTreeModel *model, gint index)
655 g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GType) 0);
659 case DICT_TVM_COL_NAME:
660 return G_TYPE_STRING;
662 case DICT_TVM_COL_VAR:
663 return PSPPIRE_VAR_PTR_TYPE;
666 g_return_val_if_reached ((GType)0);
670 g_assert_not_reached ();
675 tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter, GtkTreePath *path)
677 gint *indices, depth;
679 struct variable *var;
681 PsppireDict *dict = PSPPIRE_DICT (model);
683 g_return_val_if_fail (path, FALSE);
685 indices = gtk_tree_path_get_indices (path);
686 depth = gtk_tree_path_get_depth (path);
688 g_return_val_if_fail (depth == 1, FALSE);
692 if ( n < 0 || n >= psppire_dict_get_var_cnt (dict))
695 iter->user_data = NULL;
699 var = psppire_dict_get_variable (dict, n);
701 g_assert (var_get_dict_index (var) == n);
703 iter->stamp = dict->stamp;
704 iter->user_data = var;
711 tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter)
713 PsppireDict *dict = PSPPIRE_DICT (model);
714 struct variable *var;
717 g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
719 if ( iter == NULL || iter->user_data == NULL)
722 var = iter->user_data;
724 idx = var_get_dict_index (var);
726 if ( idx + 1 >= psppire_dict_get_var_cnt (dict))
728 iter->user_data = NULL;
733 var = psppire_dict_get_variable (dict, idx + 1);
735 g_assert (var_get_dict_index (var) == idx + 1);
737 iter->user_data = var;
743 tree_model_get_path (GtkTreeModel *model, GtkTreeIter *iter)
746 struct variable *var;
747 PsppireDict *dict = PSPPIRE_DICT (model);
749 g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
751 var = iter->user_data;
753 path = gtk_tree_path_new ();
754 gtk_tree_path_append_index (path, var_get_dict_index (var));
761 tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
762 gint column, GValue *value)
764 struct variable *var;
765 PsppireDict *dict = PSPPIRE_DICT (model);
767 g_return_if_fail (iter->stamp == dict->stamp);
769 var = iter->user_data;
773 case DICT_TVM_COL_NAME:
775 g_value_init (value, G_TYPE_STRING);
776 g_value_set_string (value, var_get_name (var));
779 case DICT_TVM_COL_VAR:
780 g_value_init (value, PSPPIRE_VAR_PTR_TYPE);
781 g_value_set_boxed (value, var);
784 g_return_if_reached ();
790 tree_model_iter_children (GtkTreeModel *tree_model,
798 tree_model_n_children (GtkTreeModel *model,
801 PsppireDict *dict = PSPPIRE_DICT (model);
804 return psppire_dict_get_var_cnt (dict);
810 tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
811 GtkTreeIter *parent, gint n)
815 g_return_val_if_fail (PSPPIRE_IS_DICT (model), FALSE);
817 dict = PSPPIRE_DICT (model);
822 if ( n >= psppire_dict_get_var_cnt (dict) )
825 iter->stamp = dict->stamp;
826 iter->user_data = psppire_dict_get_variable (dict, n);
828 if ( !iter->user_data)
836 psppire_dict_rename_var (PsppireDict *dict, struct variable *v,
839 if ( ! dict_id_is_valid (dict->dict, name, false))
842 /* Make sure no other variable has this name */
843 if ( NULL != psppire_dict_lookup_var (dict, name))
846 dict_rename_var (dict->dict, v, name);
853 psppire_dict_get_weight_variable (const PsppireDict *dict)
855 return dict_get_weight (dict->dict);
862 psppire_dict_dump (const PsppireDict *dict)
865 const struct dictionary *d = dict->dict;
867 for (i = 0; i < dict_get_var_cnt (d); ++i)
869 const struct variable *v = psppire_dict_get_variable (dict, i);
870 int di = var_get_dict_index (v);
871 g_print ("`%s' idx=%d, fv=%d\n",
874 var_get_case_index(v));
884 psppire_dict_encoding (const PsppireDict *dict)
886 return dict_get_encoding (dict->dict);