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 N_(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 gint n = datasheet_get_n_rows (store->datasheet);
89 static GtkTreeModelFlags
90 __tree_model_get_flags (GtkTreeModel *model)
92 g_return_val_if_fail (PSPPIRE_IS_DATA_STORE (model), (GtkTreeModelFlags) 0);
94 return GTK_TREE_MODEL_LIST_ONLY;
98 __tree_model_get_n_columns (GtkTreeModel *tree_model)
100 PsppireDataStore *store = PSPPIRE_DATA_STORE (tree_model);
102 return psppire_dict_get_var_cnt (store->dict);
107 __iter_nth_child (GtkTreeModel *tree_model,
112 PsppireDataStore *store = PSPPIRE_DATA_STORE (tree_model);
114 g_assert (parent == NULL);
116 g_return_val_if_fail (store, FALSE);
117 g_return_val_if_fail (store->datasheet, FALSE);
119 if (n >= datasheet_get_n_rows (store->datasheet))
122 iter->user_data = NULL;
126 iter->user_data = GINT_TO_POINTER (n);
127 iter->stamp = store->stamp;
133 myreversefunc (GtkTreeModel *model, gint col, gint row,
134 const gchar *in, GValue *out)
136 PsppireDataStore *store = PSPPIRE_DATA_STORE (model);
138 const struct variable *variable = psppire_dict_get_variable (store->dict, col);
139 g_return_if_fail (variable);
141 const struct fmt_spec *fmt = var_get_print_format (variable);
143 int width = var_get_width (variable);
146 value_init (&val, width);
148 data_in (ss_cstr (in), psppire_dict_encoding (store->dict),
149 fmt->type, &val, width, "UTF-8");
151 GVariant *vrnt = value_variant_new (&val, width);
152 value_destroy (&val, width);
154 g_value_init (out, G_TYPE_VARIANT);
155 g_value_set_variant (out, vrnt);
160 psppire_data_store_value_to_string (PsppireDataStore *store, gint col, gint row, const GValue *v)
162 const struct variable *variable = psppire_dict_get_variable (store->dict, col);
163 g_return_val_if_fail (variable, g_strdup ("???"));
165 GVariant *vrnt = g_value_get_variant (v);
167 value_variant_get (&val, vrnt);
169 const struct fmt_spec *fmt = var_get_print_format (variable);
170 char *out = data_out (&val, psppire_dict_encoding (store->dict), fmt);
171 value_destroy_from_variant (&val, vrnt);
177 __get_value (GtkTreeModel *tree_model,
182 PsppireDataStore *store = PSPPIRE_DATA_STORE (tree_model);
184 g_return_if_fail (iter->stamp == store->stamp);
186 const struct variable *variable = psppire_dict_get_variable (store->dict, column);
187 if (NULL == variable)
190 g_value_init (value, G_TYPE_VARIANT);
192 gint row = GPOINTER_TO_INT (iter->user_data);
194 struct ccase *cc = datasheet_get_row (store->datasheet, row);
196 const union value *val = case_data_idx (cc, var_get_case_index (variable));
198 GVariant *vv = value_variant_new (val, var_get_width (variable));
200 g_value_set_variant (value, vv);
207 __tree_model_init (GtkTreeModelIface *iface)
209 iface->get_flags = __tree_model_get_flags;
210 iface->get_n_columns = __tree_model_get_n_columns ;
211 iface->get_column_type = NULL;
212 iface->get_iter = NULL;
213 iface->iter_next = NULL;
214 iface->get_path = NULL;
215 iface->get_value = __get_value;
217 iface->iter_children = NULL;
218 iface->iter_has_child = NULL;
219 iface->iter_n_children = __tree_model_iter_n_children;
220 iface->iter_nth_child = __iter_nth_child;
221 iface->iter_parent = NULL;
226 psppire_data_store_get_type (void)
228 static GType data_store_type = 0;
230 if (!data_store_type)
232 static const GTypeInfo data_store_info =
234 sizeof (PsppireDataStoreClass),
235 NULL, /* base_init */
236 NULL, /* base_finalize */
237 (GClassInitFunc) psppire_data_store_class_init,
238 NULL, /* class_finalize */
239 NULL, /* class_data */
240 sizeof (PsppireDataStore),
242 (GInstanceInitFunc) psppire_data_store_init,
245 static const GInterfaceInfo tree_model_info = {
246 (GInterfaceInitFunc) __tree_model_init,
251 data_store_type = g_type_register_static (G_TYPE_OBJECT,
253 &data_store_info, 0);
255 g_type_add_interface_static (data_store_type, GTK_TYPE_TREE_MODEL,
259 return data_store_type;
264 psppire_data_store_class_init (PsppireDataStoreClass *class)
266 GObjectClass *object_class;
268 parent_class = g_type_class_peek_parent (class);
269 object_class = (GObjectClass*) class;
271 object_class->finalize = psppire_data_store_finalize;
272 object_class->dispose = psppire_data_store_dispose;
274 signals [ITEMS_CHANGED] =
275 g_signal_new ("items-changed",
276 G_TYPE_FROM_CLASS (class),
280 psppire_marshal_VOID__UINT_UINT_UINT,
283 G_TYPE_UINT, /* Index of the start of the change */
284 G_TYPE_UINT, /* The number of items deleted */
285 G_TYPE_UINT); /* The number of items inserted */
287 signals [CASE_CHANGED] =
288 g_signal_new ("case-changed",
289 G_TYPE_FROM_CLASS (class),
293 g_cclosure_marshal_VOID__INT,
302 psppire_data_store_get_case_count (const PsppireDataStore *store)
304 return datasheet_get_n_rows (store->datasheet);
308 psppire_data_store_get_value_count (const PsppireDataStore *store)
310 return psppire_dict_get_value_cnt (store->dict);
313 const struct caseproto *
314 psppire_data_store_get_proto (const PsppireDataStore *store)
316 return psppire_dict_get_proto (store->dict);
320 psppire_data_store_init (PsppireDataStore *data_store)
322 data_store->dict = NULL;
323 data_store->datasheet = NULL;
324 data_store->dispose_has_run = FALSE;
325 data_store->stamp = g_random_int ();
330 psppire_data_store_delete_value (PsppireDataStore *store, gint case_index)
332 g_return_if_fail (store->datasheet);
333 datasheet_delete_columns (store->datasheet, case_index, 1);
334 datasheet_insert_column (store->datasheet, NULL, -1, case_index);
339 A callback which occurs after a variable has been deleted.
342 delete_variable_callback (GObject *obj, const struct variable *var UNUSED,
343 gint dict_index, gint case_index,
346 PsppireDataStore *store = PSPPIRE_DATA_STORE (data);
348 psppire_data_store_delete_value (store, case_index);
351 struct resize_datum_aux
353 const struct dictionary *dict;
354 const struct variable *new_variable;
355 const struct variable *old_variable;
359 resize_datum (const union value *old, union value *new, const void *aux_)
361 const struct resize_datum_aux *aux = aux_;
362 int new_width = var_get_width (aux->new_variable);
363 const char *enc = dict_get_encoding (aux->dict);
364 const struct fmt_spec *newfmt = var_get_print_format (aux->new_variable);
365 char *s = data_out (old, enc, var_get_print_format (aux->old_variable));
366 enum fmt_type type = (fmt_usable_for_input (newfmt->type)
369 free (data_in (ss_cstr (s), enc, type, new, new_width, enc));
374 variable_changed_callback (GObject *obj, gint var_num, guint what, const struct variable *oldvar,
377 PsppireDataStore *store = PSPPIRE_DATA_STORE (data);
378 struct variable *variable = psppire_dict_get_variable (store->dict, var_num);
380 if (what & VAR_TRAIT_WIDTH)
382 int posn = var_get_case_index (variable);
383 struct resize_datum_aux aux;
384 aux.old_variable = oldvar;
385 aux.new_variable = variable;
386 aux.dict = store->dict->dict;
387 datasheet_resize_column (store->datasheet, posn, var_get_width (variable),
393 insert_variable_callback (GObject *obj, gint var_num, gpointer data)
395 struct variable *variable;
396 PsppireDataStore *store;
399 g_return_if_fail (data);
401 store = PSPPIRE_DATA_STORE (data);
403 variable = psppire_dict_get_variable (store->dict, var_num);
404 posn = var_get_case_index (variable);
405 psppire_data_store_insert_value (store, var_get_width (variable), posn);
409 * psppire_data_store_new:
410 * @dict: The dictionary for this data_store.
413 * Return value: a new #PsppireDataStore
416 psppire_data_store_new (PsppireDict *dict)
418 PsppireDataStore *retval;
420 retval = g_object_new (PSPPIRE_TYPE_DATA_STORE, NULL);
422 psppire_data_store_set_dictionary (retval, dict);
428 psppire_data_store_set_reader (PsppireDataStore *ds,
429 struct casereader *reader)
435 old_n = datasheet_get_n_rows (ds->datasheet);
436 datasheet_destroy (ds->datasheet);
439 ds->datasheet = datasheet_create (reader);
441 gint new_n = datasheet_get_n_rows (ds->datasheet);
444 for (i = 0 ; i < n_dict_signals; ++i )
446 if ( ds->dict_handler_id [i] > 0)
448 g_signal_handler_unblock (ds->dict,
449 ds->dict_handler_id[i]);
453 g_signal_emit (ds, signals[ITEMS_CHANGED], 0, 0, old_n, new_n);
458 * psppire_data_store_replace_set_dictionary:
459 * @data_store: The variable store
460 * @dict: The dictionary to set
462 * If a dictionary is already associated with the data-store, then it will be
466 psppire_data_store_set_dictionary (PsppireDataStore *data_store, PsppireDict *dict)
470 /* Disconnect any existing handlers */
471 if ( data_store->dict )
472 for (i = 0 ; i < n_dict_signals; ++i )
474 g_signal_handler_disconnect (data_store->dict,
475 data_store->dict_handler_id[i]);
478 data_store->dict = dict;
483 data_store->dict_handler_id [VARIABLE_INSERTED] =
484 g_signal_connect (dict, "variable-inserted",
485 G_CALLBACK (insert_variable_callback),
488 data_store->dict_handler_id [VARIABLE_DELETED] =
489 g_signal_connect (dict, "variable-deleted",
490 G_CALLBACK (delete_variable_callback),
493 data_store->dict_handler_id [VARIABLE_CHANGED] =
494 g_signal_connect (dict, "variable-changed",
495 G_CALLBACK (variable_changed_callback),
501 /* The entire model has changed */
503 if ( data_store->dict )
504 for (i = 0 ; i < n_dict_signals; ++i )
506 if ( data_store->dict_handler_id [i] > 0)
508 g_signal_handler_block (data_store->dict,
509 data_store->dict_handler_id[i]);
515 psppire_data_store_finalize (GObject *object)
517 PsppireDataStore *ds = PSPPIRE_DATA_STORE (object);
521 datasheet_destroy (ds->datasheet);
522 ds->datasheet = NULL;
526 (* parent_class->finalize) (object);
531 psppire_data_store_dispose (GObject *object)
533 PsppireDataStore *ds = PSPPIRE_DATA_STORE (object);
535 if (ds->dispose_has_run)
538 psppire_data_store_set_dictionary (ds, NULL);
541 (* parent_class->dispose) (object);
543 ds->dispose_has_run = TRUE;
548 /* Insert a blank case before POSN */
550 psppire_data_store_insert_new_case (PsppireDataStore *ds, casenumber posn)
553 const struct caseproto *proto;
555 g_return_val_if_fail (ds, FALSE);
557 proto = datasheet_get_proto (ds->datasheet);
558 g_return_val_if_fail (caseproto_get_n_widths (proto) > 0, FALSE);
559 g_return_val_if_fail (posn <= psppire_data_store_get_case_count (ds), FALSE);
561 cc = case_create (proto);
562 case_set_missing (cc);
564 result = psppire_data_store_insert_case (ds, cc, posn);
572 psppire_data_store_get_value (PsppireDataStore *store,
573 glong row, const struct variable *var,
576 g_return_val_if_fail (store != NULL, FALSE);
577 g_return_val_if_fail (store->datasheet != NULL, FALSE);
578 g_return_val_if_fail (var != NULL, FALSE);
580 if (row < 0 || row >= datasheet_get_n_rows (store->datasheet))
583 int width = var_get_width (var);
584 value_init (val, width);
585 datasheet_get_value (store->datasheet, row, var_get_case_index (var), val);
593 psppire_data_store_get_string (PsppireDataStore *store,
594 glong row, const struct variable *var,
595 bool use_value_label)
599 int width = var_get_width (var);
600 if (! psppire_data_store_get_value (store, row, var, &v))
606 const char *label = var_lookup_value_label (var, &v);
608 string = g_strdup (label);
611 string = value_to_text (v, var);
613 value_destroy (&v, width);
619 /* Attempts to update that part of the variable store which corresponds to VAR
620 within ROW with the value TEXT.
622 If USE_VALUE_LABEL is true, and TEXT is a value label for the column's
623 variable, then stores the value from that value label instead of the literal
626 Returns true if anything was updated, false otherwise. */
628 psppire_data_store_set_string (PsppireDataStore *store,
630 glong row, const struct variable *var,
631 gboolean use_value_label)
637 n_cases = psppire_data_store_get_case_count (store);
641 psppire_data_store_insert_new_case (store, row);
643 case_index = var_get_case_index (var);
646 const struct val_labs *vls = var_get_value_labels (var);
647 const union value *value = vls ? val_labs_find_value (vls, text) : NULL;
649 ok = datasheet_put_value (store->datasheet, row, case_index, value);
654 ok = psppire_data_store_data_in (store, row, case_index, ss_cstr (text),
655 var_get_print_format (var));
658 g_signal_emit (store, signals [CASE_CHANGED], 0, row);
665 psppire_data_store_clear (PsppireDataStore *ds)
667 datasheet_destroy (ds->datasheet);
668 ds->datasheet = NULL;
670 psppire_dict_clear (ds->dict);
672 g_signal_emit (ds, signals [ITEMS_CHANGED], 0, 0, -1, 0);
677 /* Return a casereader made from this datastore */
679 psppire_data_store_get_reader (PsppireDataStore *ds)
682 struct casereader *reader ;
685 for (i = 0 ; i < n_dict_signals; ++i )
687 g_signal_handler_block (ds->dict,
688 ds->dict_handler_id[i]);
691 reader = datasheet_make_reader (ds->datasheet);
693 /* We must not reference this again */
694 ds->datasheet = NULL;
699 /* Returns the CASENUMth case, or a null pointer on failure.
702 psppire_data_store_get_case (const PsppireDataStore *ds,
705 g_return_val_if_fail (ds, FALSE);
706 g_return_val_if_fail (ds->datasheet, FALSE);
708 return datasheet_get_row (ds->datasheet, casenum);
713 psppire_data_store_delete_cases (PsppireDataStore *ds, casenumber first,
716 g_return_val_if_fail (ds, FALSE);
717 g_return_val_if_fail (ds->datasheet, FALSE);
719 g_return_val_if_fail (first + n_cases <=
720 psppire_data_store_get_case_count (ds), FALSE);
723 datasheet_delete_rows (ds->datasheet, first, n_cases);
725 g_signal_emit (ds, signals[ITEMS_CHANGED], 0, first, n_cases, 0);
732 /* Insert case CC into the case file before POSN */
734 psppire_data_store_insert_case (PsppireDataStore *ds,
740 g_return_val_if_fail (ds, FALSE);
741 g_return_val_if_fail (ds->datasheet, FALSE);
744 result = datasheet_insert_rows (ds->datasheet, posn, &cc, 1);
748 g_signal_emit (ds, signals[ITEMS_CHANGED], 0, posn, 0, 1);
751 g_warning ("Cannot insert case at position %ld\n", posn);
757 /* Set the value of VAR in case CASENUM to V.
758 V must be the correct width for IDX.
759 Returns true if successful, false on I/O error. */
761 psppire_data_store_set_value (PsppireDataStore *ds, casenumber casenum,
762 const struct variable *var, const union value *v)
767 g_return_val_if_fail (ds, FALSE);
768 g_return_val_if_fail (ds->datasheet, FALSE);
770 n_cases = psppire_data_store_get_case_count (ds);
771 if ( casenum > n_cases)
774 if (casenum == n_cases)
775 psppire_data_store_insert_new_case (ds, casenum);
777 ok = datasheet_put_value (ds->datasheet, casenum, var_get_case_index (var),
780 g_signal_emit (ds, signals [CASE_CHANGED], 0, casenum);
788 /* Set the IDXth value of case C using D_IN */
790 psppire_data_store_data_in (PsppireDataStore *ds, casenumber casenum, gint idx,
791 struct substring input, const struct fmt_spec *fmt)
799 g_return_val_if_fail (ds, FALSE);
800 g_return_val_if_fail (ds->datasheet, FALSE);
802 g_return_val_if_fail (idx < datasheet_get_n_columns (ds->datasheet), FALSE);
806 width = fmt_var_width (fmt);
807 g_return_val_if_fail (caseproto_get_width (
808 datasheet_get_proto (ds->datasheet), idx) == width,
810 value_init (&value, width);
811 ok = (datasheet_get_value (ds->datasheet, casenum, idx, &value)
812 && data_in_msg (input, UTF8, fmt->type, &value, width,
813 dict_get_encoding (dict->dict))
814 && datasheet_put_value (ds->datasheet, casenum, idx, &value));
815 value_destroy (&value, width);
820 /* Resize the cases in the casefile, by inserting a value of the
821 given WIDTH into every one of them at the position immediately
825 psppire_data_store_insert_value (PsppireDataStore *ds,
826 gint width, gint where)
830 g_return_val_if_fail (ds, FALSE);
832 g_assert (width >= 0);
834 if ( ! ds->datasheet )
835 ds->datasheet = datasheet_create (NULL);
837 value_init (&value, width);
838 value_set_missing (&value, width);
840 datasheet_insert_column (ds->datasheet, &value, width, where);
841 value_destroy (&value, width);
847 psppire_data_store_filtered (PsppireDataStore *ds,
852 const struct dictionary *dict;
853 const struct variable *filter;
855 if ( row < 0 || row >= datasheet_get_n_rows (ds->datasheet))
858 dict = ds->dict->dict;
859 g_return_val_if_fail (dict, FALSE);
860 filter = dict_get_filter (dict);
864 g_return_val_if_fail (var_is_numeric (filter), FALSE);
865 value_init (&val, 0);
866 if ( ! datasheet_get_value (ds->datasheet, row,
867 var_get_case_index (filter),
871 return (val.f == 0.0);