1 /* PSPPIRE - a graphical user interface for PSPP.
2 Copyright (C) 2006, 2008, 2009, 2010, 2011, 2012, 2013 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/>. */
21 #define _(msgid) gettext (msgid)
22 #define N_(msgid) msgid
24 #include <data/datasheet.h>
25 #include <data/data-out.h>
26 #include <data/variable.h>
28 #include <ui/gui/psppire-marshal.h>
30 #include <pango/pango-context.h>
32 #include "psppire-data-store.h"
33 #include <libpspp/i18n.h>
36 #include <data/dictionary.h>
37 #include <data/missing-values.h>
38 #include <data/value-labels.h>
39 #include <data/data-in.h>
40 #include <data/format.h>
42 #include <math/sort.h>
47 #include "value-variant.h"
49 static void psppire_data_store_init (PsppireDataStore *data_store);
50 static void psppire_data_store_class_init (PsppireDataStoreClass *class);
52 static void psppire_data_store_finalize (GObject *object);
53 static void psppire_data_store_dispose (GObject *object);
55 static gboolean psppire_data_store_insert_case (PsppireDataStore *ds,
60 static gboolean psppire_data_store_data_in (PsppireDataStore *ds,
61 casenumber casenum, gint idx,
62 struct substring input,
63 const struct fmt_spec *fmt);
65 static GObjectClass *parent_class = NULL;
77 static guint signals [n_SIGNALS];
80 __tree_model_iter_n_children (GtkTreeModel *tree_model,
83 PsppireDataStore *store = PSPPIRE_DATA_STORE (tree_model);
85 gint n = datasheet_get_n_rows (store->datasheet);
90 static GtkTreeModelFlags
91 __tree_model_get_flags (GtkTreeModel *model)
93 g_return_val_if_fail (PSPPIRE_IS_DATA_STORE (model), (GtkTreeModelFlags) 0);
95 return GTK_TREE_MODEL_LIST_ONLY;
99 __tree_model_get_n_columns (GtkTreeModel *tree_model)
101 PsppireDataStore *store = PSPPIRE_DATA_STORE (tree_model);
103 return psppire_dict_get_value_cnt (store->dict);
108 __iter_nth_child (GtkTreeModel *tree_model,
113 PsppireDataStore *store = PSPPIRE_DATA_STORE (tree_model);
115 g_assert (parent == NULL);
117 g_return_val_if_fail (store, FALSE);
118 g_return_val_if_fail (store->datasheet, FALSE);
120 if (n >= datasheet_get_n_rows (store->datasheet))
123 iter->user_data = NULL;
127 iter->user_data = GINT_TO_POINTER (n);
128 iter->stamp = store->stamp;
134 myreversefunc (GtkTreeModel *model, gint col, gint row,
135 const gchar *in, GValue *out)
137 PsppireDataStore *store = PSPPIRE_DATA_STORE (model);
139 const struct variable *variable = psppire_dict_get_variable (store->dict, col);
140 g_return_if_fail (variable);
142 const struct fmt_spec *fmt = var_get_print_format (variable);
144 int width = var_get_width (variable);
147 value_init (&val, width);
149 data_in (ss_cstr (in), psppire_dict_encoding (store->dict),
150 fmt->type, &val, width, "UTF-8");
152 GVariant *vrnt = value_variant_new (&val, width);
153 value_destroy (&val, width);
155 g_value_init (out, G_TYPE_VARIANT);
156 g_value_set_variant (out, vrnt);
161 myconvfunc (GtkTreeModel *model, gint col, gint row, const GValue *v)
163 PsppireDataStore *store = PSPPIRE_DATA_STORE (model);
165 const struct variable *variable = psppire_dict_get_variable (store->dict, col);
166 g_return_val_if_fail (variable, g_strdup ("???"));
168 GVariant *vrnt = g_value_get_variant (v);
170 value_variant_get (&val, vrnt);
172 const struct fmt_spec *fmt = var_get_print_format (variable);
173 char *out = data_out (&val, psppire_dict_encoding (store->dict), fmt);
174 value_destroy_from_variant (&val, vrnt);
180 __get_value (GtkTreeModel *tree_model,
185 PsppireDataStore *store = PSPPIRE_DATA_STORE (tree_model);
187 g_return_if_fail (iter->stamp == store->stamp);
189 const struct variable *variable = psppire_dict_get_variable (store->dict, column);
190 if (NULL == variable)
193 g_value_init (value, G_TYPE_VARIANT);
195 gint row = GPOINTER_TO_INT (iter->user_data);
197 struct ccase *cc = datasheet_get_row (store->datasheet, row);
199 const union value *val = case_data_idx (cc, column);
201 GVariant *vv = value_variant_new (val, var_get_width (variable));
203 g_value_set_variant (value, vv);
210 __tree_model_init (GtkTreeModelIface *iface)
212 iface->get_flags = __tree_model_get_flags;
213 iface->get_n_columns = __tree_model_get_n_columns ;
214 iface->get_column_type = NULL;
215 iface->get_iter = NULL;
216 iface->iter_next = NULL;
217 iface->get_path = NULL;
218 iface->get_value = __get_value;
220 iface->iter_children = NULL;
221 iface->iter_has_child = NULL;
222 iface->iter_n_children = __tree_model_iter_n_children;
223 iface->iter_nth_child = __iter_nth_child;
224 iface->iter_parent = NULL;
229 psppire_data_store_get_type (void)
231 static GType data_store_type = 0;
233 if (!data_store_type)
235 static const GTypeInfo data_store_info =
237 sizeof (PsppireDataStoreClass),
238 NULL, /* base_init */
239 NULL, /* base_finalize */
240 (GClassInitFunc) psppire_data_store_class_init,
241 NULL, /* class_finalize */
242 NULL, /* class_data */
243 sizeof (PsppireDataStore),
245 (GInstanceInitFunc) psppire_data_store_init,
248 static const GInterfaceInfo tree_model_info = {
249 (GInterfaceInitFunc) __tree_model_init,
254 data_store_type = g_type_register_static (G_TYPE_OBJECT,
256 &data_store_info, 0);
258 g_type_add_interface_static (data_store_type, GTK_TYPE_TREE_MODEL,
262 return data_store_type;
267 psppire_data_store_class_init (PsppireDataStoreClass *class)
269 GObjectClass *object_class;
271 parent_class = g_type_class_peek_parent (class);
272 object_class = (GObjectClass*) class;
274 object_class->finalize = psppire_data_store_finalize;
275 object_class->dispose = psppire_data_store_dispose;
277 signals [ITEMS_CHANGED] =
278 g_signal_new ("changed",
279 G_TYPE_FROM_CLASS (class),
283 psppire_marshal_VOID__UINT_UINT_UINT,
290 signals [CASE_INSERTED] =
291 g_signal_new ("case-inserted",
292 G_TYPE_FROM_CLASS (class),
296 g_cclosure_marshal_VOID__INT,
302 signals [CASE_CHANGED] =
303 g_signal_new ("case-changed",
304 G_TYPE_FROM_CLASS (class),
308 g_cclosure_marshal_VOID__INT,
313 signals [CASES_DELETED] =
314 g_signal_new ("cases-deleted",
315 G_TYPE_FROM_CLASS (class),
319 psppire_marshal_VOID__INT_INT,
329 psppire_data_store_insert_value (PsppireDataStore *ds,
330 gint width, gint where);
333 psppire_data_store_get_case_count (const PsppireDataStore *store)
335 return datasheet_get_n_rows (store->datasheet);
339 psppire_data_store_get_value_count (const PsppireDataStore *store)
341 return psppire_dict_get_value_cnt (store->dict);
344 const struct caseproto *
345 psppire_data_store_get_proto (const PsppireDataStore *store)
347 return psppire_dict_get_proto (store->dict);
351 psppire_data_store_init (PsppireDataStore *data_store)
353 data_store->dict = NULL;
354 data_store->datasheet = NULL;
355 data_store->dispose_has_run = FALSE;
356 data_store->stamp = g_random_int ();
360 A callback which occurs after a variable has been deleted.
363 delete_variable_callback (GObject *obj, const struct variable *var UNUSED,
364 gint dict_index, gint case_index,
367 PsppireDataStore *store = PSPPIRE_DATA_STORE (data);
369 g_return_if_fail (store->datasheet);
371 datasheet_delete_columns (store->datasheet, case_index, 1);
372 datasheet_insert_column (store->datasheet, NULL, -1, case_index);
375 struct resize_datum_aux
377 const struct dictionary *dict;
378 const struct variable *new_variable;
379 const struct variable *old_variable;
383 resize_datum (const union value *old, union value *new, const void *aux_)
385 const struct resize_datum_aux *aux = aux_;
386 int new_width = var_get_width (aux->new_variable);
387 const char *enc = dict_get_encoding (aux->dict);
388 const struct fmt_spec *newfmt = var_get_print_format (aux->new_variable);
389 char *s = data_out (old, enc, var_get_print_format (aux->old_variable));
390 enum fmt_type type = (fmt_usable_for_input (newfmt->type)
393 free (data_in (ss_cstr (s), enc, type, new, new_width, enc));
398 variable_changed_callback (GObject *obj, gint var_num, guint what, const struct variable *oldvar,
401 PsppireDataStore *store = PSPPIRE_DATA_STORE (data);
402 struct variable *variable = psppire_dict_get_variable (store->dict, var_num);
404 if (what & VAR_TRAIT_WIDTH)
406 int posn = var_get_case_index (variable);
407 struct resize_datum_aux aux;
408 aux.old_variable = oldvar;
409 aux.new_variable = variable;
410 aux.dict = store->dict->dict;
411 datasheet_resize_column (store->datasheet, posn, var_get_width (variable),
417 insert_variable_callback (GObject *obj, gint var_num, gpointer data)
419 struct variable *variable;
420 PsppireDataStore *store;
423 g_return_if_fail (data);
425 store = PSPPIRE_DATA_STORE (data);
427 variable = psppire_dict_get_variable (store->dict, var_num);
428 posn = var_get_case_index (variable);
429 psppire_data_store_insert_value (store, var_get_width (variable), posn);
433 * psppire_data_store_new:
434 * @dict: The dictionary for this data_store.
437 * Return value: a new #PsppireDataStore
440 psppire_data_store_new (PsppireDict *dict)
442 PsppireDataStore *retval;
444 retval = g_object_new (PSPPIRE_TYPE_DATA_STORE, NULL);
446 psppire_data_store_set_dictionary (retval, dict);
452 psppire_data_store_set_reader (PsppireDataStore *ds,
453 struct casereader *reader)
459 old_n = datasheet_get_n_rows (ds->datasheet);
460 datasheet_destroy (ds->datasheet);
463 ds->datasheet = datasheet_create (reader);
465 gint new_n = datasheet_get_n_rows (ds->datasheet);
468 for (i = 0 ; i < n_dict_signals; ++i )
470 if ( ds->dict_handler_id [i] > 0)
472 g_signal_handler_unblock (ds->dict,
473 ds->dict_handler_id[i]);
477 g_signal_emit (ds, signals[ITEMS_CHANGED], 0, 0, old_n, new_n);
482 * psppire_data_store_replace_set_dictionary:
483 * @data_store: The variable store
484 * @dict: The dictionary to set
486 * If a dictionary is already associated with the data-store, then it will be
490 psppire_data_store_set_dictionary (PsppireDataStore *data_store, PsppireDict *dict)
494 /* Disconnect any existing handlers */
495 if ( data_store->dict )
496 for (i = 0 ; i < n_dict_signals; ++i )
498 g_signal_handler_disconnect (data_store->dict,
499 data_store->dict_handler_id[i]);
502 data_store->dict = dict;
507 data_store->dict_handler_id [VARIABLE_INSERTED] =
508 g_signal_connect (dict, "variable-inserted",
509 G_CALLBACK (insert_variable_callback),
512 data_store->dict_handler_id [VARIABLE_DELETED] =
513 g_signal_connect (dict, "variable-deleted",
514 G_CALLBACK (delete_variable_callback),
517 data_store->dict_handler_id [VARIABLE_CHANGED] =
518 g_signal_connect (dict, "variable-changed",
519 G_CALLBACK (variable_changed_callback),
525 /* The entire model has changed */
527 if ( data_store->dict )
528 for (i = 0 ; i < n_dict_signals; ++i )
530 if ( data_store->dict_handler_id [i] > 0)
532 g_signal_handler_block (data_store->dict,
533 data_store->dict_handler_id[i]);
539 psppire_data_store_finalize (GObject *object)
541 PsppireDataStore *ds = PSPPIRE_DATA_STORE (object);
545 datasheet_destroy (ds->datasheet);
546 ds->datasheet = NULL;
550 (* parent_class->finalize) (object);
555 psppire_data_store_dispose (GObject *object)
557 PsppireDataStore *ds = PSPPIRE_DATA_STORE (object);
559 if (ds->dispose_has_run)
562 psppire_data_store_set_dictionary (ds, NULL);
565 (* parent_class->dispose) (object);
567 ds->dispose_has_run = TRUE;
572 /* Insert a blank case before POSN */
574 psppire_data_store_insert_new_case (PsppireDataStore *ds, casenumber posn)
577 const struct caseproto *proto;
579 g_return_val_if_fail (ds, FALSE);
581 proto = datasheet_get_proto (ds->datasheet);
582 g_return_val_if_fail (caseproto_get_n_widths (proto) > 0, FALSE);
583 g_return_val_if_fail (posn <= psppire_data_store_get_case_count (ds), FALSE);
585 cc = case_create (proto);
586 case_set_missing (cc);
588 result = psppire_data_store_insert_case (ds, cc, posn);
596 psppire_data_store_get_string (PsppireDataStore *store,
597 glong row, const struct variable *var,
598 bool use_value_label)
604 g_return_val_if_fail (store != NULL, NULL);
605 g_return_val_if_fail (store->datasheet != NULL, NULL);
606 g_return_val_if_fail (var != NULL, NULL);
608 if (row < 0 || row >= datasheet_get_n_rows (store->datasheet))
611 width = var_get_width (var);
612 value_init (&v, width);
613 datasheet_get_value (store->datasheet, row, var_get_case_index (var), &v);
618 const char *label = var_lookup_value_label (var, &v);
620 string = g_strdup (label);
623 string = value_to_text (v, var);
625 value_destroy (&v, width);
631 /* Attempts to update that part of the variable store which corresponds to VAR
632 within ROW with the value TEXT.
634 If USE_VALUE_LABEL is true, and TEXT is a value label for the column's
635 variable, then stores the value from that value label instead of the literal
638 Returns true if anything was updated, false otherwise. */
640 psppire_data_store_set_string (PsppireDataStore *store,
642 glong row, const struct variable *var,
643 gboolean use_value_label)
649 n_cases = psppire_data_store_get_case_count (store);
653 psppire_data_store_insert_new_case (store, row);
655 case_index = var_get_case_index (var);
658 const struct val_labs *vls = var_get_value_labels (var);
659 const union value *value = vls ? val_labs_find_value (vls, text) : NULL;
661 ok = datasheet_put_value (store->datasheet, row, case_index, value);
666 ok = psppire_data_store_data_in (store, row, case_index, ss_cstr (text),
667 var_get_print_format (var));
670 g_signal_emit (store, signals [CASE_CHANGED], 0, row);
677 psppire_data_store_clear (PsppireDataStore *ds)
679 datasheet_destroy (ds->datasheet);
680 ds->datasheet = NULL;
682 psppire_dict_clear (ds->dict);
684 g_signal_emit (ds, signals [CASES_DELETED], 0, 0, -1);
689 /* Return a casereader made from this datastore */
691 psppire_data_store_get_reader (PsppireDataStore *ds)
694 struct casereader *reader ;
697 for (i = 0 ; i < n_dict_signals; ++i )
699 g_signal_handler_block (ds->dict,
700 ds->dict_handler_id[i]);
703 reader = datasheet_make_reader (ds->datasheet);
705 /* We must not reference this again */
706 ds->datasheet = NULL;
713 /* Column related funcs */
716 static const gchar null_var_name[]=N_("var");
722 /* Returns the CASENUMth case, or a null pointer on failure.
725 psppire_data_store_get_case (const PsppireDataStore *ds,
728 g_return_val_if_fail (ds, FALSE);
729 g_return_val_if_fail (ds->datasheet, FALSE);
731 return datasheet_get_row (ds->datasheet, casenum);
736 psppire_data_store_delete_cases (PsppireDataStore *ds, casenumber first,
739 g_return_val_if_fail (ds, FALSE);
740 g_return_val_if_fail (ds->datasheet, FALSE);
742 g_return_val_if_fail (first + n_cases <=
743 psppire_data_store_get_case_count (ds), FALSE);
746 datasheet_delete_rows (ds->datasheet, first, n_cases);
748 g_signal_emit (ds, signals [CASES_DELETED], 0, first, n_cases);
755 /* Insert case CC into the case file before POSN */
757 psppire_data_store_insert_case (PsppireDataStore *ds,
763 g_return_val_if_fail (ds, FALSE);
764 g_return_val_if_fail (ds->datasheet, FALSE);
767 result = datasheet_insert_rows (ds->datasheet, posn, &cc, 1);
770 g_signal_emit (ds, signals [CASE_INSERTED], 0, posn);
772 g_warning ("Cannot insert case at position %ld\n", posn);
778 /* Set the value of VAR in case CASENUM to V.
779 V must be the correct width for IDX.
780 Returns true if successful, false on I/O error. */
782 psppire_data_store_set_value (PsppireDataStore *ds, casenumber casenum,
783 const struct variable *var, const union value *v)
788 g_return_val_if_fail (ds, FALSE);
789 g_return_val_if_fail (ds->datasheet, FALSE);
791 n_cases = psppire_data_store_get_case_count (ds);
792 if ( casenum > n_cases)
795 if (casenum == n_cases)
796 psppire_data_store_insert_new_case (ds, casenum);
798 ok = datasheet_put_value (ds->datasheet, casenum, var_get_case_index (var),
801 g_signal_emit (ds, signals [CASE_CHANGED], 0, casenum);
809 /* Set the IDXth value of case C using D_IN */
811 psppire_data_store_data_in (PsppireDataStore *ds, casenumber casenum, gint idx,
812 struct substring input, const struct fmt_spec *fmt)
820 g_return_val_if_fail (ds, FALSE);
821 g_return_val_if_fail (ds->datasheet, FALSE);
823 g_return_val_if_fail (idx < datasheet_get_n_columns (ds->datasheet), FALSE);
827 width = fmt_var_width (fmt);
828 g_return_val_if_fail (caseproto_get_width (
829 datasheet_get_proto (ds->datasheet), idx) == width,
831 value_init (&value, width);
832 ok = (datasheet_get_value (ds->datasheet, casenum, idx, &value)
833 && data_in_msg (input, UTF8, fmt->type, &value, width,
834 dict_get_encoding (dict->dict))
835 && datasheet_put_value (ds->datasheet, casenum, idx, &value));
836 value_destroy (&value, width);
841 /* Resize the cases in the casefile, by inserting a value of the
842 given WIDTH into every one of them at the position immediately
846 psppire_data_store_insert_value (PsppireDataStore *ds,
847 gint width, gint where)
851 g_return_val_if_fail (ds, FALSE);
853 g_assert (width >= 0);
855 if ( ! ds->datasheet )
856 ds->datasheet = datasheet_create (NULL);
858 value_init (&value, width);
859 value_set_missing (&value, width);
861 datasheet_insert_column (ds->datasheet, &value, width, where);
862 value_destroy (&value, width);
868 psppire_data_store_filtered (PsppireDataStore *ds,
873 const struct dictionary *dict;
874 const struct variable *filter;
876 if ( row < 0 || row >= datasheet_get_n_rows (ds->datasheet))
879 dict = ds->dict->dict;
880 g_return_val_if_fail (dict, FALSE);
881 filter = dict_get_filter (dict);
885 g_return_val_if_fail (var_is_numeric (filter), FALSE);
886 value_init (&val, 0);
887 if ( ! datasheet_get_value (ds->datasheet, row,
888 var_get_case_index (filter),
892 return (val.f == 0.0);