1 /* PSPPIRE - a graphical user interface for PSPP.
2 Copyright (C) 2006, 2008, 2009, 2010, 2011, 2012,
3 2013, 2016, 2017 Free Software Foundation
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #define _(msgid) gettext (msgid)
23 #define P_(msgid) msgid
25 #include <data/datasheet.h>
26 #include <data/data-out.h>
27 #include <data/variable.h>
29 #include <ui/gui/psppire-marshal.h>
31 #include <pango/pango-context.h>
33 #include "psppire-data-store.h"
34 #include <libpspp/i18n.h>
37 #include <data/dictionary.h>
38 #include <data/missing-values.h>
39 #include <data/value-labels.h>
40 #include <data/data-in.h>
41 #include <data/format.h>
43 #include <math/sort.h>
48 #include "value-variant.h"
50 static void psppire_data_store_init (PsppireDataStore *data_store);
51 static void psppire_data_store_class_init (PsppireDataStoreClass *class);
53 static void psppire_data_store_finalize (GObject *object);
54 static void psppire_data_store_dispose (GObject *object);
56 static gboolean psppire_data_store_insert_case (PsppireDataStore *ds,
61 static gboolean psppire_data_store_data_in (PsppireDataStore *ds,
62 casenumber casenum, gint idx,
63 struct substring input,
64 const struct fmt_spec *fmt);
66 static GObjectClass *parent_class = NULL;
76 static guint signals [n_SIGNALS];
79 __tree_model_iter_n_children (GtkTreeModel *tree_model,
82 PsppireDataStore *store = PSPPIRE_DATA_STORE (tree_model);
84 if (store->datasheet == NULL)
87 gint n = datasheet_get_n_rows (store->datasheet);
92 static GtkTreeModelFlags
93 __tree_model_get_flags (GtkTreeModel *model)
95 g_return_val_if_fail (PSPPIRE_IS_DATA_STORE (model), (GtkTreeModelFlags) 0);
97 return GTK_TREE_MODEL_LIST_ONLY;
101 __tree_model_get_n_columns (GtkTreeModel *tree_model)
103 PsppireDataStore *store = PSPPIRE_DATA_STORE (tree_model);
105 return psppire_dict_get_var_cnt (store->dict);
110 __iter_nth_child (GtkTreeModel *tree_model,
115 PsppireDataStore *store = PSPPIRE_DATA_STORE (tree_model);
117 g_assert (parent == NULL);
118 g_return_val_if_fail (store, FALSE);
120 if (!store->datasheet || 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_val_if_fail (variable, FALSE);
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);
162 unlabeled_value (PsppireDataStore *store, const struct variable *variable, const union value *val)
164 const struct fmt_spec *fmt = var_get_print_format (variable);
165 return data_out (val, psppire_dict_encoding (store->dict), fmt);
169 psppire_data_store_value_to_string (gpointer unused, PsppireDataStore *store, gint col, gint row, const GValue *v)
171 const struct variable *variable = psppire_dict_get_variable (store->dict, col);
172 g_return_val_if_fail (variable, g_strdup ("???"));
174 GVariant *vrnt = g_value_get_variant (v);
176 value_variant_get (&val, vrnt);
178 char *out = unlabeled_value (store, variable, &val);
180 value_destroy_from_variant (&val, vrnt);
186 psppire_data_store_value_to_string_with_labels (gpointer unused, PsppireDataStore *store, gint col, gint row, const GValue *v)
188 const struct variable *variable = psppire_dict_get_variable (store->dict, col);
189 g_return_val_if_fail (variable, g_strdup ("???"));
191 GVariant *vrnt = g_value_get_variant (v);
193 value_variant_get (&val, vrnt);
197 const struct val_labs *vls = var_get_value_labels (variable);
198 struct val_lab *vl = val_labs_lookup (vls, &val);
200 out = strdup (val_lab_get_label (vl));
202 out = unlabeled_value (store, variable, &val);
204 value_destroy_from_variant (&val, vrnt);
210 __get_value (GtkTreeModel *tree_model,
215 PsppireDataStore *store = PSPPIRE_DATA_STORE (tree_model);
217 g_return_if_fail (iter->stamp == store->stamp);
219 const struct variable *variable = psppire_dict_get_variable (store->dict, column);
220 if (NULL == variable)
223 g_value_init (value, G_TYPE_VARIANT);
225 gint row = GPOINTER_TO_INT (iter->user_data);
227 struct ccase *cc = datasheet_get_row (store->datasheet, row);
229 const union value *val = case_data_idx (cc, var_get_case_index (variable));
231 GVariant *vv = value_variant_new (val, var_get_width (variable));
233 g_value_set_variant (value, vv);
240 __tree_model_init (GtkTreeModelIface *iface)
242 iface->get_flags = __tree_model_get_flags;
243 iface->get_n_columns = __tree_model_get_n_columns ;
244 iface->get_column_type = NULL;
245 iface->get_iter = NULL;
246 iface->iter_next = NULL;
247 iface->get_path = NULL;
248 iface->get_value = __get_value;
250 iface->iter_children = NULL;
251 iface->iter_has_child = NULL;
252 iface->iter_n_children = __tree_model_iter_n_children;
253 iface->iter_nth_child = __iter_nth_child;
254 iface->iter_parent = NULL;
259 psppire_data_store_get_type (void)
261 static GType data_store_type = 0;
263 if (!data_store_type)
265 static const GTypeInfo data_store_info =
267 sizeof (PsppireDataStoreClass),
268 NULL, /* base_init */
269 NULL, /* base_finalize */
270 (GClassInitFunc) psppire_data_store_class_init,
271 NULL, /* class_finalize */
272 NULL, /* class_data */
273 sizeof (PsppireDataStore),
275 (GInstanceInitFunc) psppire_data_store_init,
278 static const GInterfaceInfo tree_model_info = {
279 (GInterfaceInitFunc) __tree_model_init,
284 data_store_type = g_type_register_static (G_TYPE_OBJECT,
286 &data_store_info, 0);
288 g_type_add_interface_static (data_store_type, GTK_TYPE_TREE_MODEL,
292 return data_store_type;
297 psppire_data_store_class_init (PsppireDataStoreClass *class)
299 GObjectClass *object_class;
301 parent_class = g_type_class_peek_parent (class);
302 object_class = (GObjectClass*) class;
304 object_class->finalize = psppire_data_store_finalize;
305 object_class->dispose = psppire_data_store_dispose;
307 signals [ITEMS_CHANGED] =
308 g_signal_new ("items-changed",
309 G_TYPE_FROM_CLASS (class),
313 psppire_marshal_VOID__UINT_UINT_UINT,
316 G_TYPE_UINT, /* Index of the start of the change */
317 G_TYPE_UINT, /* The number of items deleted */
318 G_TYPE_UINT); /* The number of items inserted */
320 signals [CASE_CHANGED] =
321 g_signal_new ("case-changed",
322 G_TYPE_FROM_CLASS (class),
326 g_cclosure_marshal_VOID__INT,
335 psppire_data_store_get_case_count (const PsppireDataStore *store)
337 return datasheet_get_n_rows (store->datasheet);
341 psppire_data_store_get_value_count (const PsppireDataStore *store)
343 return psppire_dict_get_value_cnt (store->dict);
346 const struct caseproto *
347 psppire_data_store_get_proto (const PsppireDataStore *store)
349 return psppire_dict_get_proto (store->dict);
353 psppire_data_store_init (PsppireDataStore *data_store)
355 data_store->dict = NULL;
356 data_store->datasheet = NULL;
357 data_store->dispose_has_run = FALSE;
358 data_store->stamp = g_random_int ();
363 psppire_data_store_delete_value (PsppireDataStore *store, gint case_index)
365 g_return_if_fail (store->datasheet);
366 datasheet_delete_columns (store->datasheet, case_index, 1);
367 datasheet_insert_column (store->datasheet, NULL, -1, case_index);
372 A callback which occurs after a variable has been deleted.
375 delete_variable_callback (GObject *obj, const struct variable *var UNUSED,
376 gint dict_index, gint case_index,
379 PsppireDataStore *store = PSPPIRE_DATA_STORE (data);
381 psppire_data_store_delete_value (store, case_index);
384 struct resize_datum_aux
386 const struct dictionary *dict;
387 const struct variable *new_variable;
388 const struct variable *old_variable;
392 resize_datum (const union value *old, union value *new, const void *aux_)
394 const struct resize_datum_aux *aux = aux_;
395 int new_width = var_get_width (aux->new_variable);
396 const char *enc = dict_get_encoding (aux->dict);
397 const struct fmt_spec *newfmt = var_get_print_format (aux->new_variable);
398 char *s = data_out (old, enc, var_get_print_format (aux->old_variable));
399 enum fmt_type type = (fmt_usable_for_input (newfmt->type)
402 free (data_in (ss_cstr (s), enc, type, new, new_width, enc));
407 variable_changed_callback (GObject *obj, gint var_num, guint what, const struct variable *oldvar,
410 PsppireDataStore *store = PSPPIRE_DATA_STORE (data);
411 struct variable *variable = psppire_dict_get_variable (store->dict, var_num);
413 if (what & VAR_TRAIT_WIDTH)
415 int posn = var_get_case_index (variable);
416 struct resize_datum_aux aux;
417 aux.old_variable = oldvar;
418 aux.new_variable = variable;
419 aux.dict = store->dict->dict;
420 datasheet_resize_column (store->datasheet, posn, var_get_width (variable),
426 insert_variable_callback (GObject *obj, gint var_num, gpointer data)
428 struct variable *variable;
429 PsppireDataStore *store;
432 g_return_if_fail (data);
434 store = PSPPIRE_DATA_STORE (data);
436 variable = psppire_dict_get_variable (store->dict, var_num);
437 posn = var_get_case_index (variable);
438 psppire_data_store_insert_value (store, var_get_width (variable), posn);
442 * psppire_data_store_new:
443 * @dict: The dictionary for this data_store.
446 * Return value: a new #PsppireDataStore
449 psppire_data_store_new (PsppireDict *dict)
451 PsppireDataStore *retval;
453 retval = g_object_new (PSPPIRE_TYPE_DATA_STORE, NULL);
455 psppire_data_store_set_dictionary (retval, dict);
461 psppire_data_store_set_reader (PsppireDataStore *ds,
462 struct casereader *reader)
468 old_n = datasheet_get_n_rows (ds->datasheet);
469 datasheet_destroy (ds->datasheet);
472 ds->datasheet = datasheet_create (reader);
474 gint new_n = datasheet_get_n_rows (ds->datasheet);
477 for (i = 0 ; i < n_dict_signals; ++i )
479 if ( ds->dict_handler_id [i] > 0)
481 g_signal_handler_unblock (ds->dict,
482 ds->dict_handler_id[i]);
486 g_signal_emit (ds, signals[ITEMS_CHANGED], 0, 0, old_n, new_n);
491 * psppire_data_store_replace_set_dictionary:
492 * @data_store: The variable store
493 * @dict: The dictionary to set
495 * If a dictionary is already associated with the data-store, then it will be
499 psppire_data_store_set_dictionary (PsppireDataStore *data_store, PsppireDict *dict)
503 /* Disconnect any existing handlers */
504 if ( data_store->dict )
505 for (i = 0 ; i < n_dict_signals; ++i )
507 g_signal_handler_disconnect (data_store->dict,
508 data_store->dict_handler_id[i]);
511 data_store->dict = dict;
516 data_store->dict_handler_id [VARIABLE_INSERTED] =
517 g_signal_connect (dict, "variable-inserted",
518 G_CALLBACK (insert_variable_callback),
521 data_store->dict_handler_id [VARIABLE_DELETED] =
522 g_signal_connect (dict, "variable-deleted",
523 G_CALLBACK (delete_variable_callback),
526 data_store->dict_handler_id [VARIABLE_CHANGED] =
527 g_signal_connect (dict, "variable-changed",
528 G_CALLBACK (variable_changed_callback),
534 /* The entire model has changed */
536 if ( data_store->dict )
537 for (i = 0 ; i < n_dict_signals; ++i )
539 if ( data_store->dict_handler_id [i] > 0)
541 g_signal_handler_block (data_store->dict,
542 data_store->dict_handler_id[i]);
548 psppire_data_store_finalize (GObject *object)
550 PsppireDataStore *ds = PSPPIRE_DATA_STORE (object);
554 datasheet_destroy (ds->datasheet);
555 ds->datasheet = NULL;
559 (* parent_class->finalize) (object);
564 psppire_data_store_dispose (GObject *object)
566 PsppireDataStore *ds = PSPPIRE_DATA_STORE (object);
568 if (ds->dispose_has_run)
571 psppire_data_store_set_dictionary (ds, NULL);
574 (* parent_class->dispose) (object);
576 ds->dispose_has_run = TRUE;
581 /* Insert a blank case before POSN */
583 psppire_data_store_insert_new_case (PsppireDataStore *ds, casenumber posn)
586 const struct caseproto *proto;
588 g_return_val_if_fail (ds, FALSE);
590 proto = datasheet_get_proto (ds->datasheet);
591 g_return_val_if_fail (caseproto_get_n_widths (proto) > 0, FALSE);
592 g_return_val_if_fail (posn <= psppire_data_store_get_case_count (ds), FALSE);
594 cc = case_create (proto);
595 case_set_missing (cc);
597 result = psppire_data_store_insert_case (ds, cc, posn);
605 psppire_data_store_get_value (PsppireDataStore *store,
606 glong row, const struct variable *var,
609 g_return_val_if_fail (store != NULL, FALSE);
610 g_return_val_if_fail (store->datasheet != NULL, FALSE);
611 g_return_val_if_fail (var != NULL, FALSE);
613 if (row < 0 || row >= datasheet_get_n_rows (store->datasheet))
616 int width = var_get_width (var);
617 value_init (val, width);
618 datasheet_get_value (store->datasheet, row, var_get_case_index (var), val);
626 psppire_data_store_get_string (PsppireDataStore *store,
627 glong row, const struct variable *var,
628 bool use_value_label)
632 int width = var_get_width (var);
633 if (! psppire_data_store_get_value (store, row, var, &v))
639 const char *label = var_lookup_value_label (var, &v);
641 string = g_strdup (label);
644 string = value_to_text (v, var);
646 value_destroy (&v, width);
652 /* Attempts to update that part of the variable store which corresponds to VAR
653 within ROW with the value TEXT.
655 If USE_VALUE_LABEL is true, and TEXT is a value label for the column's
656 variable, then stores the value from that value label instead of the literal
659 Returns true if anything was updated, false otherwise. */
661 psppire_data_store_set_string (PsppireDataStore *store,
663 glong row, const struct variable *var,
664 gboolean use_value_label)
670 n_cases = psppire_data_store_get_case_count (store);
674 psppire_data_store_insert_new_case (store, row);
676 case_index = var_get_case_index (var);
679 const struct val_labs *vls = var_get_value_labels (var);
680 const union value *value = vls ? val_labs_find_value (vls, text) : NULL;
682 ok = datasheet_put_value (store->datasheet, row, case_index, value);
687 ok = psppire_data_store_data_in (store, row, case_index, ss_cstr (text),
688 var_get_print_format (var));
691 g_signal_emit (store, signals [CASE_CHANGED], 0, row);
698 psppire_data_store_clear (PsppireDataStore *ds)
700 datasheet_destroy (ds->datasheet);
701 ds->datasheet = NULL;
703 psppire_dict_clear (ds->dict);
705 g_signal_emit (ds, signals [ITEMS_CHANGED], 0, 0, -1, 0);
710 /* Return a casereader made from this datastore */
712 psppire_data_store_get_reader (PsppireDataStore *ds)
715 struct casereader *reader ;
718 for (i = 0 ; i < n_dict_signals; ++i )
720 g_signal_handler_block (ds->dict,
721 ds->dict_handler_id[i]);
724 reader = datasheet_make_reader (ds->datasheet);
726 /* We must not reference this again */
727 ds->datasheet = NULL;
732 /* Returns the CASENUMth case, or a null pointer on failure.
735 psppire_data_store_get_case (const PsppireDataStore *ds,
738 g_return_val_if_fail (ds, FALSE);
739 g_return_val_if_fail (ds->datasheet, FALSE);
741 return datasheet_get_row (ds->datasheet, casenum);
746 psppire_data_store_delete_cases (PsppireDataStore *ds, casenumber first,
749 g_return_val_if_fail (ds, FALSE);
750 g_return_val_if_fail (ds->datasheet, FALSE);
752 g_return_val_if_fail (first + n_cases <=
753 psppire_data_store_get_case_count (ds), FALSE);
756 datasheet_delete_rows (ds->datasheet, first, n_cases);
758 g_signal_emit (ds, signals[ITEMS_CHANGED], 0, first, n_cases, 0);
765 /* Insert case CC into the case file before POSN */
767 psppire_data_store_insert_case (PsppireDataStore *ds,
773 g_return_val_if_fail (ds, FALSE);
774 g_return_val_if_fail (ds->datasheet, FALSE);
777 result = datasheet_insert_rows (ds->datasheet, posn, &cc, 1);
781 g_signal_emit (ds, signals[ITEMS_CHANGED], 0, posn, 0, 1);
784 g_warning ("Cannot insert case at position %ld\n", posn);
790 /* Set the value of VAR in case CASENUM to V.
791 V must be the correct width for IDX.
792 Returns true if successful, false on I/O error. */
794 psppire_data_store_set_value (PsppireDataStore *ds, casenumber casenum,
795 const struct variable *var, const union value *v)
800 g_return_val_if_fail (ds, FALSE);
801 g_return_val_if_fail (ds->datasheet, FALSE);
803 n_cases = psppire_data_store_get_case_count (ds);
804 if ( casenum > n_cases)
807 if (casenum == n_cases)
808 psppire_data_store_insert_new_case (ds, casenum);
810 ok = datasheet_put_value (ds->datasheet, casenum, var_get_case_index (var),
813 g_signal_emit (ds, signals [CASE_CHANGED], 0, casenum);
821 /* Set the IDXth value of case C using D_IN */
823 psppire_data_store_data_in (PsppireDataStore *ds, casenumber casenum, gint idx,
824 struct substring input, const struct fmt_spec *fmt)
832 g_return_val_if_fail (ds, FALSE);
833 g_return_val_if_fail (ds->datasheet, FALSE);
835 g_return_val_if_fail (idx < datasheet_get_n_columns (ds->datasheet), FALSE);
839 width = fmt_var_width (fmt);
840 g_return_val_if_fail (caseproto_get_width (
841 datasheet_get_proto (ds->datasheet), idx) == width,
843 value_init (&value, width);
844 ok = (datasheet_get_value (ds->datasheet, casenum, idx, &value)
845 && data_in_msg (input, UTF8, fmt->type, &value, width,
846 dict_get_encoding (dict->dict))
847 && datasheet_put_value (ds->datasheet, casenum, idx, &value));
848 value_destroy (&value, width);
853 /* Resize the cases in the casefile, by inserting a value of the
854 given WIDTH into every one of them at the position immediately
858 psppire_data_store_insert_value (PsppireDataStore *ds,
859 gint width, gint where)
863 g_return_val_if_fail (ds, FALSE);
865 g_assert (width >= 0);
867 if ( ! ds->datasheet )
868 ds->datasheet = datasheet_create (NULL);
870 value_init (&value, width);
871 value_set_missing (&value, width);
873 datasheet_insert_column (ds->datasheet, &value, width, where);
874 value_destroy (&value, width);
880 psppire_data_store_filtered (PsppireDataStore *ds,
885 const struct dictionary *dict;
886 const struct variable *filter;
888 if ( row < 0 || row >= datasheet_get_n_rows (ds->datasheet))
891 dict = ds->dict->dict;
892 g_return_val_if_fail (dict, FALSE);
893 filter = dict_get_filter (dict);
897 g_return_val_if_fail (var_is_numeric (filter), FALSE);
898 value_init (&val, 0);
899 if ( ! datasheet_get_value (ds->datasheet, row,
900 var_get_case_index (filter),
904 return (val.f == 0.0);