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>
47 #include "value-variant.h"
49 static void psppire_data_store_finalize (GObject *object);
50 static void psppire_data_store_dispose (GObject *object);
52 static gboolean psppire_data_store_insert_case (PsppireDataStore *ds,
57 static gboolean psppire_data_store_data_in (PsppireDataStore *ds,
58 casenumber casenum, gint idx,
59 struct substring input,
60 const struct fmt_spec *fmt);
62 static GObjectClass *parent_class = NULL;
72 static guint signals [n_SIGNALS];
75 __tree_model_iter_n_children (GtkTreeModel *tree_model,
78 PsppireDataStore *store = PSPPIRE_DATA_STORE (tree_model);
80 if (store->datasheet == NULL)
83 gint n = datasheet_get_n_rows (store->datasheet);
88 static GtkTreeModelFlags
89 __tree_model_get_flags (GtkTreeModel *model)
91 g_return_val_if_fail (PSPPIRE_IS_DATA_STORE (model), (GtkTreeModelFlags) 0);
93 return GTK_TREE_MODEL_LIST_ONLY;
97 __tree_model_get_n_columns (GtkTreeModel *tree_model)
99 PsppireDataStore *store = PSPPIRE_DATA_STORE (tree_model);
101 return psppire_dict_get_var_cnt (store->dict);
106 __iter_nth_child (GtkTreeModel *tree_model,
111 PsppireDataStore *store = PSPPIRE_DATA_STORE (tree_model);
113 g_assert (parent == NULL);
114 g_return_val_if_fail (store, FALSE);
116 if (!store->datasheet || n >= datasheet_get_n_rows (store->datasheet))
119 iter->user_data = NULL;
123 iter->user_data = GINT_TO_POINTER (n);
124 iter->stamp = store->stamp;
129 /* Set the contents of OUT to reflect the information provided by IN, COL, and
130 ROW, for MODEL. Returns TRUE if successful. */
132 psppire_data_store_string_to_value (GtkTreeModel *model, gint col, gint row,
133 const gchar *in, GValue *out)
135 PsppireDataStore *store = PSPPIRE_DATA_STORE (model);
137 while (col >= psppire_dict_get_var_cnt (store->dict))
139 const struct variable *var =
140 psppire_dict_insert_variable (store->dict,
141 psppire_dict_get_var_cnt (store->dict),
143 g_return_val_if_fail (var, FALSE);
146 const struct variable *variable = psppire_dict_get_variable (store->dict, col);
147 g_return_val_if_fail (variable, FALSE);
149 const struct fmt_spec *fmt = var_get_print_format (variable);
151 int width = var_get_width (variable);
154 value_init (&val, width);
155 const struct val_labs *value_labels = var_get_value_labels (variable);
156 const union value *vp = NULL;
159 vp = val_labs_find_value (value_labels, in);
161 value_copy (&val, vp, width);
166 xx = data_in (ss_cstr (in), psppire_dict_encoding (store->dict),
167 fmt->type, &val, width, "UTF-8");
170 GVariant *vrnt = value_variant_new (&val, width);
171 value_destroy (&val, width);
173 g_value_init (out, G_TYPE_VARIANT);
174 g_value_set_variant (out, vrnt);
180 unlabeled_value (PsppireDataStore *store, const struct variable *variable, const union value *val)
182 if (var_is_numeric (variable) &&
183 var_is_value_missing (variable, val, MV_SYSTEM))
184 return g_strdup ("");
186 const struct fmt_spec *fmt = var_get_print_format (variable);
187 return value_to_text__ (*val, fmt, psppire_dict_encoding (store->dict));
191 psppire_data_store_value_to_string (gpointer unused, PsppireDataStore *store, gint col, gint row, const GValue *v)
193 const struct variable *variable = psppire_dict_get_variable (store->dict, col);
194 g_return_val_if_fail (variable, g_strdup ("???"));
196 GVariant *vrnt = g_value_get_variant (v);
197 g_return_val_if_fail (vrnt, g_strdup ("???"));
200 value_variant_get (&val, vrnt);
202 char *out = unlabeled_value (store, variable, &val);
204 value_destroy_from_variant (&val, vrnt);
210 psppire_data_store_value_to_string_with_labels (gpointer unused, PsppireDataStore *store, gint col, gint row, const GValue *v)
212 const struct variable *variable = psppire_dict_get_variable (store->dict, col);
213 g_return_val_if_fail (variable, g_strdup ("???"));
215 GVariant *vrnt = g_value_get_variant (v);
217 value_variant_get (&val, vrnt);
221 const struct val_labs *vls = var_get_value_labels (variable);
222 struct val_lab *vl = val_labs_lookup (vls, &val);
224 out = strdup (val_lab_get_label (vl));
226 out = unlabeled_value (store, variable, &val);
228 value_destroy_from_variant (&val, vrnt);
234 __get_value (GtkTreeModel *tree_model,
239 PsppireDataStore *store = PSPPIRE_DATA_STORE (tree_model);
241 g_return_if_fail (iter->stamp == store->stamp);
243 const struct variable *variable = psppire_dict_get_variable (store->dict, column);
244 if (NULL == variable)
247 gint row = GPOINTER_TO_INT (iter->user_data);
249 struct ccase *cc = datasheet_get_row (store->datasheet, row);
251 g_return_if_fail (cc);
253 g_value_init (value, G_TYPE_VARIANT);
255 const union value *val = case_data_idx (cc, var_get_case_index (variable));
257 GVariant *vv = value_variant_new (val, var_get_width (variable));
259 g_value_set_variant (value, vv);
266 __tree_model_init (GtkTreeModelIface *iface)
268 iface->get_flags = __tree_model_get_flags;
269 iface->get_n_columns = __tree_model_get_n_columns ;
270 iface->get_column_type = NULL;
271 iface->get_iter = NULL;
272 iface->iter_next = NULL;
273 iface->get_path = NULL;
274 iface->get_value = __get_value;
276 iface->iter_children = NULL;
277 iface->iter_has_child = NULL;
278 iface->iter_n_children = __tree_model_iter_n_children;
279 iface->iter_nth_child = __iter_nth_child;
280 iface->iter_parent = NULL;
283 G_DEFINE_TYPE_WITH_CODE (PsppireDataStore, psppire_data_store, G_TYPE_OBJECT,
284 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_MODEL,
288 psppire_data_store_class_init (PsppireDataStoreClass *class)
290 GObjectClass *object_class;
292 parent_class = g_type_class_peek_parent (class);
293 object_class = (GObjectClass*) class;
295 object_class->finalize = psppire_data_store_finalize;
296 object_class->dispose = psppire_data_store_dispose;
298 signals [ITEMS_CHANGED] =
299 g_signal_new ("items-changed",
300 G_TYPE_FROM_CLASS (class),
304 psppire_marshal_VOID__UINT_UINT_UINT,
307 G_TYPE_UINT, /* Index of the start of the change */
308 G_TYPE_UINT, /* The number of items deleted */
309 G_TYPE_UINT); /* The number of items inserted */
311 signals [CASE_CHANGED] =
312 g_signal_new ("case-changed",
313 G_TYPE_FROM_CLASS (class),
317 g_cclosure_marshal_VOID__INT,
326 psppire_data_store_get_case_count (const PsppireDataStore *store)
328 return datasheet_get_n_rows (store->datasheet);
332 psppire_data_store_get_value_count (const PsppireDataStore *store)
334 return psppire_dict_get_value_cnt (store->dict);
337 const struct caseproto *
338 psppire_data_store_get_proto (const PsppireDataStore *store)
340 return psppire_dict_get_proto (store->dict);
344 psppire_data_store_init (PsppireDataStore *data_store)
346 data_store->dict = NULL;
347 data_store->datasheet = NULL;
348 data_store->dispose_has_run = FALSE;
349 data_store->stamp = g_random_int ();
354 psppire_data_store_delete_value (PsppireDataStore *store, gint case_index)
356 g_return_if_fail (store->datasheet);
357 g_return_if_fail (case_index < datasheet_get_n_columns (store->datasheet));
359 datasheet_delete_columns (store->datasheet, case_index, 1);
360 datasheet_insert_column (store->datasheet, NULL, -1, case_index);
365 A callback which occurs after a variable has been deleted.
368 delete_variable_callback (GObject *obj, const struct variable *var UNUSED,
369 gint dict_index, gint case_index,
372 PsppireDataStore *store = PSPPIRE_DATA_STORE (data);
374 psppire_data_store_delete_value (store, case_index);
377 struct resize_datum_aux
379 const struct dictionary *dict;
380 const struct variable *new_variable;
381 const struct variable *old_variable;
385 resize_datum (const union value *old, union value *new, const void *aux_)
387 const struct resize_datum_aux *aux = aux_;
388 int new_width = var_get_width (aux->new_variable);
389 const char *enc = dict_get_encoding (aux->dict);
390 const struct fmt_spec *newfmt = var_get_print_format (aux->new_variable);
391 char *s = data_out (old, enc, var_get_print_format (aux->old_variable));
392 enum fmt_type type = (fmt_usable_for_input (newfmt->type)
395 free (data_in (ss_cstr (s), enc, type, new, new_width, enc));
400 variable_changed_callback (GObject *obj, gint var_num, guint what, const struct variable *oldvar,
403 PsppireDataStore *store = PSPPIRE_DATA_STORE (data);
404 struct variable *variable = psppire_dict_get_variable (store->dict, var_num);
406 if (what & VAR_TRAIT_WIDTH)
408 int posn = var_get_case_index (variable);
409 struct resize_datum_aux aux;
410 aux.old_variable = oldvar;
411 aux.new_variable = variable;
412 aux.dict = store->dict->dict;
413 datasheet_resize_column (store->datasheet, posn, var_get_width (variable),
419 insert_variable_callback (GObject *obj, gint var_num, gpointer data)
421 struct variable *variable;
422 PsppireDataStore *store;
425 g_return_if_fail (data);
427 store = PSPPIRE_DATA_STORE (data);
429 variable = psppire_dict_get_variable (store->dict, var_num);
430 posn = var_get_case_index (variable);
431 psppire_data_store_insert_value (store, var_get_width (variable), posn);
435 * psppire_data_store_new:
436 * @dict: The dictionary for this data_store.
439 * Return value: a new #PsppireDataStore
442 psppire_data_store_new (PsppireDict *dict)
444 PsppireDataStore *retval;
446 retval = g_object_new (PSPPIRE_TYPE_DATA_STORE, NULL);
448 psppire_data_store_set_dictionary (retval, dict);
454 psppire_data_store_set_reader (PsppireDataStore *ds,
455 struct casereader *reader)
461 old_n = datasheet_get_n_rows (ds->datasheet);
462 datasheet_destroy (ds->datasheet);
465 ds->datasheet = datasheet_create (reader);
467 gint new_n = datasheet_get_n_rows (ds->datasheet);
470 for (i = 0 ; i < n_dict_signals; ++i)
472 if (ds->dict_handler_id [i] > 0)
474 g_signal_handler_unblock (ds->dict,
475 ds->dict_handler_id[i]);
479 g_signal_emit (ds, signals[ITEMS_CHANGED], 0, 0, old_n, new_n);
484 * psppire_data_store_replace_set_dictionary:
485 * @data_store: The variable store
486 * @dict: The dictionary to set
488 * If a dictionary is already associated with the data-store, then it will be
492 psppire_data_store_set_dictionary (PsppireDataStore *data_store, PsppireDict *dict)
496 /* Disconnect any existing handlers */
497 if (data_store->dict)
498 for (i = 0 ; i < n_dict_signals; ++i)
500 g_signal_handler_disconnect (data_store->dict,
501 data_store->dict_handler_id[i]);
504 data_store->dict = dict;
509 data_store->dict_handler_id [VARIABLE_INSERTED] =
510 g_signal_connect (dict, "variable-inserted",
511 G_CALLBACK (insert_variable_callback),
514 data_store->dict_handler_id [VARIABLE_DELETED] =
515 g_signal_connect (dict, "variable-deleted",
516 G_CALLBACK (delete_variable_callback),
519 data_store->dict_handler_id [VARIABLE_CHANGED] =
520 g_signal_connect (dict, "variable-changed",
521 G_CALLBACK (variable_changed_callback),
527 /* The entire model has changed */
529 if (data_store->dict)
530 for (i = 0 ; i < n_dict_signals; ++i)
532 if (data_store->dict_handler_id [i] > 0)
534 g_signal_handler_block (data_store->dict,
535 data_store->dict_handler_id[i]);
541 psppire_data_store_finalize (GObject *object)
543 PsppireDataStore *ds = PSPPIRE_DATA_STORE (object);
547 datasheet_destroy (ds->datasheet);
548 ds->datasheet = NULL;
552 (* parent_class->finalize) (object);
557 psppire_data_store_dispose (GObject *object)
559 PsppireDataStore *ds = PSPPIRE_DATA_STORE (object);
561 if (ds->dispose_has_run)
564 psppire_data_store_set_dictionary (ds, NULL);
567 (* parent_class->dispose) (object);
569 ds->dispose_has_run = TRUE;
574 /* Insert a blank case before POSN */
576 psppire_data_store_insert_new_case (PsppireDataStore *ds, casenumber posn)
579 const struct caseproto *proto;
581 g_return_val_if_fail (ds, FALSE);
583 proto = datasheet_get_proto (ds->datasheet);
584 g_return_val_if_fail (caseproto_get_n_widths (proto) > 0, FALSE);
585 g_return_val_if_fail (posn <= psppire_data_store_get_case_count (ds), FALSE);
587 cc = case_create (proto);
588 case_set_missing (cc);
590 result = psppire_data_store_insert_case (ds, cc, posn);
598 psppire_data_store_get_value (PsppireDataStore *store,
599 glong row, const struct variable *var,
602 g_return_val_if_fail (store != NULL, FALSE);
603 g_return_val_if_fail (store->datasheet != NULL, FALSE);
604 g_return_val_if_fail (var != NULL, FALSE);
606 if (row < 0 || row >= datasheet_get_n_rows (store->datasheet))
609 int width = var_get_width (var);
610 value_init (val, width);
611 datasheet_get_value (store->datasheet, row, var_get_case_index (var), val);
619 psppire_data_store_get_string (PsppireDataStore *store,
620 glong row, const struct variable *var,
621 bool use_value_label)
625 int width = var_get_width (var);
626 if (! psppire_data_store_get_value (store, row, var, &v))
632 const char *label = var_lookup_value_label (var, &v);
634 string = g_strdup (label);
637 string = value_to_text (v, var);
639 value_destroy (&v, width);
645 /* Attempts to update that part of the variable store which corresponds to VAR
646 within ROW with the value TEXT.
648 If USE_VALUE_LABEL is true, and TEXT is a value label for the column's
649 variable, then stores the value from that value label instead of the literal
652 Returns true if anything was updated, false otherwise. */
654 psppire_data_store_set_string (PsppireDataStore *store,
656 glong row, const struct variable *var,
657 gboolean use_value_label)
663 n_cases = psppire_data_store_get_case_count (store);
667 psppire_data_store_insert_new_case (store, row);
669 case_index = var_get_case_index (var);
672 const struct val_labs *vls = var_get_value_labels (var);
673 const union value *value = vls ? val_labs_find_value (vls, text) : NULL;
675 ok = datasheet_put_value (store->datasheet, row, case_index, value);
680 ok = psppire_data_store_data_in (store, row, case_index, ss_cstr (text),
681 var_get_print_format (var));
684 g_signal_emit (store, signals [CASE_CHANGED], 0, row);
691 psppire_data_store_clear (PsppireDataStore *ds)
693 datasheet_destroy (ds->datasheet);
694 ds->datasheet = NULL;
696 psppire_dict_clear (ds->dict);
698 g_signal_emit (ds, signals [ITEMS_CHANGED], 0, 0, -1, 0);
703 /* Return a casereader made from this datastore */
705 psppire_data_store_get_reader (PsppireDataStore *ds)
708 struct casereader *reader ;
711 for (i = 0 ; i < n_dict_signals; ++i)
713 g_signal_handler_block (ds->dict,
714 ds->dict_handler_id[i]);
717 reader = datasheet_make_reader (ds->datasheet);
719 /* We must not reference this again */
720 ds->datasheet = NULL;
725 /* Returns the CASENUMth case, or a null pointer on failure.
728 psppire_data_store_get_case (const PsppireDataStore *ds,
731 g_return_val_if_fail (ds, FALSE);
732 g_return_val_if_fail (ds->datasheet, FALSE);
734 return datasheet_get_row (ds->datasheet, casenum);
739 psppire_data_store_delete_cases (PsppireDataStore *ds, casenumber first,
742 g_return_val_if_fail (ds, FALSE);
743 g_return_val_if_fail (ds->datasheet, FALSE);
745 g_return_val_if_fail (first + n_cases <=
746 psppire_data_store_get_case_count (ds), FALSE);
749 datasheet_delete_rows (ds->datasheet, first, n_cases);
751 g_signal_emit (ds, signals[ITEMS_CHANGED], 0, first, n_cases, 0);
758 /* Insert case CC into the case file before POSN */
760 psppire_data_store_insert_case (PsppireDataStore *ds,
766 g_return_val_if_fail (ds, FALSE);
767 g_return_val_if_fail (ds->datasheet, FALSE);
770 result = datasheet_insert_rows (ds->datasheet, posn, &cc, 1);
774 g_signal_emit (ds, signals[ITEMS_CHANGED], 0, posn, 0, 1);
777 g_warning ("Cannot insert case at position %ld\n", posn);
783 /* Set the value of VAR in case CASENUM to V.
784 V must be the correct width for IDX.
785 Returns true if successful, false on I/O error. */
787 psppire_data_store_set_value (PsppireDataStore *ds, casenumber casenum,
788 const struct variable *var, const union value *v)
793 g_return_val_if_fail (ds, FALSE);
794 g_return_val_if_fail (ds->datasheet, FALSE);
796 n_cases = psppire_data_store_get_case_count (ds);
797 if (casenum > n_cases)
800 if (casenum == n_cases)
801 psppire_data_store_insert_new_case (ds, casenum);
803 ok = datasheet_put_value (ds->datasheet, casenum, var_get_case_index (var),
807 g_signal_emit (ds, signals [CASE_CHANGED], 0, casenum);
808 g_signal_emit (ds, signals [ITEMS_CHANGED], 0, casenum, 1, 1);
817 /* Set the IDXth value of case C using D_IN */
819 psppire_data_store_data_in (PsppireDataStore *ds, casenumber casenum, gint idx,
820 struct substring input, const struct fmt_spec *fmt)
828 g_return_val_if_fail (ds, FALSE);
829 g_return_val_if_fail (ds->datasheet, FALSE);
831 g_return_val_if_fail (idx < datasheet_get_n_columns (ds->datasheet), FALSE);
835 width = fmt_var_width (fmt);
836 g_return_val_if_fail (caseproto_get_width (
837 datasheet_get_proto (ds->datasheet), idx) == width,
839 value_init (&value, width);
840 ok = (datasheet_get_value (ds->datasheet, casenum, idx, &value)
841 && data_in_msg (input, UTF8, fmt->type, &value, width,
842 dict_get_encoding (dict->dict))
843 && datasheet_put_value (ds->datasheet, casenum, idx, &value));
844 value_destroy (&value, width);
849 /* Resize the cases in the casefile, by inserting a value of the
850 given WIDTH into every one of them at the position immediately
854 psppire_data_store_insert_value (PsppireDataStore *ds,
855 gint width, gint where)
859 g_return_val_if_fail (ds, FALSE);
861 g_assert (width >= 0);
864 ds->datasheet = datasheet_create (NULL);
866 value_init (&value, width);
867 value_set_missing (&value, width);
869 datasheet_insert_column (ds->datasheet, &value, width, where);
870 value_destroy (&value, width);
876 psppire_data_store_filtered (PsppireDataStore *ds,
881 const struct dictionary *dict;
882 const struct variable *filter;
884 if (row < 0 || row >= datasheet_get_n_rows (ds->datasheet))
887 dict = ds->dict->dict;
888 g_return_val_if_fail (dict, FALSE);
889 filter = dict_get_filter (dict);
893 g_return_val_if_fail (var_is_numeric (filter), FALSE);
894 value_init (&val, 0);
895 if (! datasheet_get_value (ds->datasheet, row,
896 var_get_case_index (filter),
900 return (val.f == 0.0);