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;
133 /* Set the contents of OUT to reflect the information provided by IN, COL, and
134 ROW, for MODEL. Returns TRUE if successful. */
136 psppire_data_store_string_to_value (GtkTreeModel *model, gint col, gint row,
137 const gchar *in, GValue *out)
139 PsppireDataStore *store = PSPPIRE_DATA_STORE (model);
141 while (col >= psppire_dict_get_var_cnt (store->dict))
143 const struct variable *var =
144 psppire_dict_insert_variable (store->dict,
145 psppire_dict_get_var_cnt (store->dict),
147 g_return_val_if_fail (var, FALSE);
150 const struct variable *variable = psppire_dict_get_variable (store->dict, col);
151 g_return_val_if_fail (variable, FALSE);
153 const struct fmt_spec *fmt = var_get_print_format (variable);
155 int width = var_get_width (variable);
158 value_init (&val, width);
160 data_in (ss_cstr (in), psppire_dict_encoding (store->dict),
161 fmt->type, &val, width, "UTF-8");
163 GVariant *vrnt = value_variant_new (&val, width);
164 value_destroy (&val, width);
166 g_value_init (out, G_TYPE_VARIANT);
167 g_value_set_variant (out, vrnt);
173 unlabeled_value (PsppireDataStore *store, const struct variable *variable, const union value *val)
175 const struct fmt_spec *fmt = var_get_print_format (variable);
176 return data_out (val, psppire_dict_encoding (store->dict), fmt);
180 psppire_data_store_value_to_string (gpointer unused, PsppireDataStore *store, gint col, gint row, const GValue *v)
182 const struct variable *variable = psppire_dict_get_variable (store->dict, col);
183 g_return_val_if_fail (variable, g_strdup ("???"));
185 GVariant *vrnt = g_value_get_variant (v);
186 g_return_val_if_fail (vrnt, g_strdup ("???"));
189 value_variant_get (&val, vrnt);
191 char *out = unlabeled_value (store, variable, &val);
193 value_destroy_from_variant (&val, vrnt);
199 psppire_data_store_value_to_string_with_labels (gpointer unused, PsppireDataStore *store, gint col, gint row, const GValue *v)
201 const struct variable *variable = psppire_dict_get_variable (store->dict, col);
202 g_return_val_if_fail (variable, g_strdup ("???"));
204 GVariant *vrnt = g_value_get_variant (v);
206 value_variant_get (&val, vrnt);
210 const struct val_labs *vls = var_get_value_labels (variable);
211 struct val_lab *vl = val_labs_lookup (vls, &val);
213 out = strdup (val_lab_get_label (vl));
215 out = unlabeled_value (store, variable, &val);
217 value_destroy_from_variant (&val, vrnt);
223 __get_value (GtkTreeModel *tree_model,
228 PsppireDataStore *store = PSPPIRE_DATA_STORE (tree_model);
230 g_return_if_fail (iter->stamp == store->stamp);
232 const struct variable *variable = psppire_dict_get_variable (store->dict, column);
233 if (NULL == variable)
236 gint row = GPOINTER_TO_INT (iter->user_data);
238 struct ccase *cc = datasheet_get_row (store->datasheet, row);
240 g_return_if_fail (cc);
242 g_value_init (value, G_TYPE_VARIANT);
244 const union value *val = case_data_idx (cc, var_get_case_index (variable));
246 GVariant *vv = value_variant_new (val, var_get_width (variable));
248 g_value_set_variant (value, vv);
255 __tree_model_init (GtkTreeModelIface *iface)
257 iface->get_flags = __tree_model_get_flags;
258 iface->get_n_columns = __tree_model_get_n_columns ;
259 iface->get_column_type = NULL;
260 iface->get_iter = NULL;
261 iface->iter_next = NULL;
262 iface->get_path = NULL;
263 iface->get_value = __get_value;
265 iface->iter_children = NULL;
266 iface->iter_has_child = NULL;
267 iface->iter_n_children = __tree_model_iter_n_children;
268 iface->iter_nth_child = __iter_nth_child;
269 iface->iter_parent = NULL;
274 psppire_data_store_get_type (void)
276 static GType data_store_type = 0;
278 if (!data_store_type)
280 static const GTypeInfo data_store_info =
282 sizeof (PsppireDataStoreClass),
283 NULL, /* base_init */
284 NULL, /* base_finalize */
285 (GClassInitFunc) psppire_data_store_class_init,
286 NULL, /* class_finalize */
287 NULL, /* class_data */
288 sizeof (PsppireDataStore),
290 (GInstanceInitFunc) psppire_data_store_init,
293 static const GInterfaceInfo tree_model_info = {
294 (GInterfaceInitFunc) __tree_model_init,
299 data_store_type = g_type_register_static (G_TYPE_OBJECT,
301 &data_store_info, 0);
303 g_type_add_interface_static (data_store_type, GTK_TYPE_TREE_MODEL,
307 return data_store_type;
312 psppire_data_store_class_init (PsppireDataStoreClass *class)
314 GObjectClass *object_class;
316 parent_class = g_type_class_peek_parent (class);
317 object_class = (GObjectClass*) class;
319 object_class->finalize = psppire_data_store_finalize;
320 object_class->dispose = psppire_data_store_dispose;
322 signals [ITEMS_CHANGED] =
323 g_signal_new ("items-changed",
324 G_TYPE_FROM_CLASS (class),
328 psppire_marshal_VOID__UINT_UINT_UINT,
331 G_TYPE_UINT, /* Index of the start of the change */
332 G_TYPE_UINT, /* The number of items deleted */
333 G_TYPE_UINT); /* The number of items inserted */
335 signals [CASE_CHANGED] =
336 g_signal_new ("case-changed",
337 G_TYPE_FROM_CLASS (class),
341 g_cclosure_marshal_VOID__INT,
350 psppire_data_store_get_case_count (const PsppireDataStore *store)
352 return datasheet_get_n_rows (store->datasheet);
356 psppire_data_store_get_value_count (const PsppireDataStore *store)
358 return psppire_dict_get_value_cnt (store->dict);
361 const struct caseproto *
362 psppire_data_store_get_proto (const PsppireDataStore *store)
364 return psppire_dict_get_proto (store->dict);
368 psppire_data_store_init (PsppireDataStore *data_store)
370 data_store->dict = NULL;
371 data_store->datasheet = NULL;
372 data_store->dispose_has_run = FALSE;
373 data_store->stamp = g_random_int ();
378 psppire_data_store_delete_value (PsppireDataStore *store, gint case_index)
380 g_return_if_fail (store->datasheet);
381 datasheet_delete_columns (store->datasheet, case_index, 1);
382 datasheet_insert_column (store->datasheet, NULL, -1, case_index);
387 A callback which occurs after a variable has been deleted.
390 delete_variable_callback (GObject *obj, const struct variable *var UNUSED,
391 gint dict_index, gint case_index,
394 PsppireDataStore *store = PSPPIRE_DATA_STORE (data);
396 psppire_data_store_delete_value (store, case_index);
399 struct resize_datum_aux
401 const struct dictionary *dict;
402 const struct variable *new_variable;
403 const struct variable *old_variable;
407 resize_datum (const union value *old, union value *new, const void *aux_)
409 const struct resize_datum_aux *aux = aux_;
410 int new_width = var_get_width (aux->new_variable);
411 const char *enc = dict_get_encoding (aux->dict);
412 const struct fmt_spec *newfmt = var_get_print_format (aux->new_variable);
413 char *s = data_out (old, enc, var_get_print_format (aux->old_variable));
414 enum fmt_type type = (fmt_usable_for_input (newfmt->type)
417 free (data_in (ss_cstr (s), enc, type, new, new_width, enc));
422 variable_changed_callback (GObject *obj, gint var_num, guint what, const struct variable *oldvar,
425 PsppireDataStore *store = PSPPIRE_DATA_STORE (data);
426 struct variable *variable = psppire_dict_get_variable (store->dict, var_num);
428 if (what & VAR_TRAIT_WIDTH)
430 int posn = var_get_case_index (variable);
431 struct resize_datum_aux aux;
432 aux.old_variable = oldvar;
433 aux.new_variable = variable;
434 aux.dict = store->dict->dict;
435 datasheet_resize_column (store->datasheet, posn, var_get_width (variable),
441 insert_variable_callback (GObject *obj, gint var_num, gpointer data)
443 struct variable *variable;
444 PsppireDataStore *store;
447 g_return_if_fail (data);
449 store = PSPPIRE_DATA_STORE (data);
451 variable = psppire_dict_get_variable (store->dict, var_num);
452 posn = var_get_case_index (variable);
453 psppire_data_store_insert_value (store, var_get_width (variable), posn);
457 * psppire_data_store_new:
458 * @dict: The dictionary for this data_store.
461 * Return value: a new #PsppireDataStore
464 psppire_data_store_new (PsppireDict *dict)
466 PsppireDataStore *retval;
468 retval = g_object_new (PSPPIRE_TYPE_DATA_STORE, NULL);
470 psppire_data_store_set_dictionary (retval, dict);
476 psppire_data_store_set_reader (PsppireDataStore *ds,
477 struct casereader *reader)
483 old_n = datasheet_get_n_rows (ds->datasheet);
484 datasheet_destroy (ds->datasheet);
487 ds->datasheet = datasheet_create (reader);
489 gint new_n = datasheet_get_n_rows (ds->datasheet);
492 for (i = 0 ; i < n_dict_signals; ++i )
494 if ( ds->dict_handler_id [i] > 0)
496 g_signal_handler_unblock (ds->dict,
497 ds->dict_handler_id[i]);
501 g_signal_emit (ds, signals[ITEMS_CHANGED], 0, 0, old_n, new_n);
506 * psppire_data_store_replace_set_dictionary:
507 * @data_store: The variable store
508 * @dict: The dictionary to set
510 * If a dictionary is already associated with the data-store, then it will be
514 psppire_data_store_set_dictionary (PsppireDataStore *data_store, PsppireDict *dict)
518 /* Disconnect any existing handlers */
519 if ( data_store->dict )
520 for (i = 0 ; i < n_dict_signals; ++i )
522 g_signal_handler_disconnect (data_store->dict,
523 data_store->dict_handler_id[i]);
526 data_store->dict = dict;
531 data_store->dict_handler_id [VARIABLE_INSERTED] =
532 g_signal_connect (dict, "variable-inserted",
533 G_CALLBACK (insert_variable_callback),
536 data_store->dict_handler_id [VARIABLE_DELETED] =
537 g_signal_connect (dict, "variable-deleted",
538 G_CALLBACK (delete_variable_callback),
541 data_store->dict_handler_id [VARIABLE_CHANGED] =
542 g_signal_connect (dict, "variable-changed",
543 G_CALLBACK (variable_changed_callback),
549 /* The entire model has changed */
551 if ( data_store->dict )
552 for (i = 0 ; i < n_dict_signals; ++i )
554 if ( data_store->dict_handler_id [i] > 0)
556 g_signal_handler_block (data_store->dict,
557 data_store->dict_handler_id[i]);
563 psppire_data_store_finalize (GObject *object)
565 PsppireDataStore *ds = PSPPIRE_DATA_STORE (object);
569 datasheet_destroy (ds->datasheet);
570 ds->datasheet = NULL;
574 (* parent_class->finalize) (object);
579 psppire_data_store_dispose (GObject *object)
581 PsppireDataStore *ds = PSPPIRE_DATA_STORE (object);
583 if (ds->dispose_has_run)
586 psppire_data_store_set_dictionary (ds, NULL);
589 (* parent_class->dispose) (object);
591 ds->dispose_has_run = TRUE;
596 /* Insert a blank case before POSN */
598 psppire_data_store_insert_new_case (PsppireDataStore *ds, casenumber posn)
601 const struct caseproto *proto;
603 g_return_val_if_fail (ds, FALSE);
605 proto = datasheet_get_proto (ds->datasheet);
606 g_return_val_if_fail (caseproto_get_n_widths (proto) > 0, FALSE);
607 g_return_val_if_fail (posn <= psppire_data_store_get_case_count (ds), FALSE);
609 cc = case_create (proto);
610 case_set_missing (cc);
612 result = psppire_data_store_insert_case (ds, cc, posn);
620 psppire_data_store_get_value (PsppireDataStore *store,
621 glong row, const struct variable *var,
624 g_return_val_if_fail (store != NULL, FALSE);
625 g_return_val_if_fail (store->datasheet != NULL, FALSE);
626 g_return_val_if_fail (var != NULL, FALSE);
628 if (row < 0 || row >= datasheet_get_n_rows (store->datasheet))
631 int width = var_get_width (var);
632 value_init (val, width);
633 datasheet_get_value (store->datasheet, row, var_get_case_index (var), val);
641 psppire_data_store_get_string (PsppireDataStore *store,
642 glong row, const struct variable *var,
643 bool use_value_label)
647 int width = var_get_width (var);
648 if (! psppire_data_store_get_value (store, row, var, &v))
654 const char *label = var_lookup_value_label (var, &v);
656 string = g_strdup (label);
659 string = value_to_text (v, var);
661 value_destroy (&v, width);
667 /* Attempts to update that part of the variable store which corresponds to VAR
668 within ROW with the value TEXT.
670 If USE_VALUE_LABEL is true, and TEXT is a value label for the column's
671 variable, then stores the value from that value label instead of the literal
674 Returns true if anything was updated, false otherwise. */
676 psppire_data_store_set_string (PsppireDataStore *store,
678 glong row, const struct variable *var,
679 gboolean use_value_label)
685 n_cases = psppire_data_store_get_case_count (store);
689 psppire_data_store_insert_new_case (store, row);
691 case_index = var_get_case_index (var);
694 const struct val_labs *vls = var_get_value_labels (var);
695 const union value *value = vls ? val_labs_find_value (vls, text) : NULL;
697 ok = datasheet_put_value (store->datasheet, row, case_index, value);
702 ok = psppire_data_store_data_in (store, row, case_index, ss_cstr (text),
703 var_get_print_format (var));
706 g_signal_emit (store, signals [CASE_CHANGED], 0, row);
713 psppire_data_store_clear (PsppireDataStore *ds)
715 datasheet_destroy (ds->datasheet);
716 ds->datasheet = NULL;
718 psppire_dict_clear (ds->dict);
720 g_signal_emit (ds, signals [ITEMS_CHANGED], 0, 0, -1, 0);
725 /* Return a casereader made from this datastore */
727 psppire_data_store_get_reader (PsppireDataStore *ds)
730 struct casereader *reader ;
733 for (i = 0 ; i < n_dict_signals; ++i )
735 g_signal_handler_block (ds->dict,
736 ds->dict_handler_id[i]);
739 reader = datasheet_make_reader (ds->datasheet);
741 /* We must not reference this again */
742 ds->datasheet = NULL;
747 /* Returns the CASENUMth case, or a null pointer on failure.
750 psppire_data_store_get_case (const PsppireDataStore *ds,
753 g_return_val_if_fail (ds, FALSE);
754 g_return_val_if_fail (ds->datasheet, FALSE);
756 return datasheet_get_row (ds->datasheet, casenum);
761 psppire_data_store_delete_cases (PsppireDataStore *ds, casenumber first,
764 g_return_val_if_fail (ds, FALSE);
765 g_return_val_if_fail (ds->datasheet, FALSE);
767 g_return_val_if_fail (first + n_cases <=
768 psppire_data_store_get_case_count (ds), FALSE);
771 datasheet_delete_rows (ds->datasheet, first, n_cases);
773 g_signal_emit (ds, signals[ITEMS_CHANGED], 0, first, n_cases, 0);
780 /* Insert case CC into the case file before POSN */
782 psppire_data_store_insert_case (PsppireDataStore *ds,
788 g_return_val_if_fail (ds, FALSE);
789 g_return_val_if_fail (ds->datasheet, FALSE);
792 result = datasheet_insert_rows (ds->datasheet, posn, &cc, 1);
796 g_signal_emit (ds, signals[ITEMS_CHANGED], 0, posn, 0, 1);
799 g_warning ("Cannot insert case at position %ld\n", posn);
805 /* Set the value of VAR in case CASENUM to V.
806 V must be the correct width for IDX.
807 Returns true if successful, false on I/O error. */
809 psppire_data_store_set_value (PsppireDataStore *ds, casenumber casenum,
810 const struct variable *var, const union value *v)
815 g_return_val_if_fail (ds, FALSE);
816 g_return_val_if_fail (ds->datasheet, FALSE);
818 n_cases = psppire_data_store_get_case_count (ds);
819 if ( casenum > n_cases)
822 if (casenum == n_cases)
823 psppire_data_store_insert_new_case (ds, casenum);
825 ok = datasheet_put_value (ds->datasheet, casenum, var_get_case_index (var),
829 g_signal_emit (ds, signals [CASE_CHANGED], 0, casenum);
830 g_signal_emit (ds, signals [ITEMS_CHANGED], 0, casenum, 1, 1);
839 /* Set the IDXth value of case C using D_IN */
841 psppire_data_store_data_in (PsppireDataStore *ds, casenumber casenum, gint idx,
842 struct substring input, const struct fmt_spec *fmt)
850 g_return_val_if_fail (ds, FALSE);
851 g_return_val_if_fail (ds->datasheet, FALSE);
853 g_return_val_if_fail (idx < datasheet_get_n_columns (ds->datasheet), FALSE);
857 width = fmt_var_width (fmt);
858 g_return_val_if_fail (caseproto_get_width (
859 datasheet_get_proto (ds->datasheet), idx) == width,
861 value_init (&value, width);
862 ok = (datasheet_get_value (ds->datasheet, casenum, idx, &value)
863 && data_in_msg (input, UTF8, fmt->type, &value, width,
864 dict_get_encoding (dict->dict))
865 && datasheet_put_value (ds->datasheet, casenum, idx, &value));
866 value_destroy (&value, width);
871 /* Resize the cases in the casefile, by inserting a value of the
872 given WIDTH into every one of them at the position immediately
876 psppire_data_store_insert_value (PsppireDataStore *ds,
877 gint width, gint where)
881 g_return_val_if_fail (ds, FALSE);
883 g_assert (width >= 0);
885 if ( ! ds->datasheet )
886 ds->datasheet = datasheet_create (NULL);
888 value_init (&value, width);
889 value_set_missing (&value, width);
891 datasheet_insert_column (ds->datasheet, &value, width, where);
892 value_destroy (&value, width);
898 psppire_data_store_filtered (PsppireDataStore *ds,
903 const struct dictionary *dict;
904 const struct variable *filter;
906 if ( row < 0 || row >= datasheet_get_n_rows (ds->datasheet))
909 dict = ds->dict->dict;
910 g_return_val_if_fail (dict, FALSE);
911 filter = dict_get_filter (dict);
915 g_return_val_if_fail (var_is_numeric (filter), FALSE);
916 value_init (&val, 0);
917 if ( ! datasheet_get_value (ds->datasheet, row,
918 var_get_case_index (filter),
922 return (val.f == 0.0);