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>
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;
136 __get_value (GtkTreeModel *tree_model,
141 PsppireDataStore *store = PSPPIRE_DATA_STORE (tree_model);
143 g_return_if_fail (iter->stamp == store->stamp);
145 const struct variable *variable = psppire_dict_get_variable (store->dict, column);
146 if (NULL == variable)
149 if (var_is_numeric (variable))
150 g_value_init (value, G_TYPE_DOUBLE);
152 g_value_init (value, G_TYPE_STRING);
154 gint row = GPOINTER_TO_INT (iter->user_data);
156 struct ccase *cc = datasheet_get_row (store->datasheet, row);
158 if (var_is_numeric (variable))
159 g_value_set_double (value, case_data_idx (cc, column)->f);
162 const gchar *ss = value_str (case_data_idx (cc, column),
163 var_get_width (variable));
164 g_value_set_string (value, ss);
171 __get_type (GtkTreeModel *tree_model, gint idx)
173 PsppireDataStore *store = PSPPIRE_DATA_STORE (tree_model);
175 const struct variable *variable = psppire_dict_get_variable (store->dict, idx);
177 if (NULL == variable)
180 if (var_is_numeric (variable))
181 return G_TYPE_DOUBLE;
183 return G_TYPE_STRING;
187 __tree_model_init (GtkTreeModelIface *iface)
189 iface->get_flags = __tree_model_get_flags;
190 iface->get_n_columns = __tree_model_get_n_columns ;
191 iface->get_column_type = __get_type;
192 iface->get_iter = NULL;
193 iface->iter_next = NULL;
194 iface->get_path = NULL;
195 iface->get_value = __get_value;
197 iface->iter_children = NULL;
198 iface->iter_has_child = NULL;
199 iface->iter_n_children = __tree_model_iter_n_children;
200 iface->iter_nth_child = __iter_nth_child;
201 iface->iter_parent = NULL;
206 psppire_data_store_get_type (void)
208 static GType data_store_type = 0;
210 if (!data_store_type)
212 static const GTypeInfo data_store_info =
214 sizeof (PsppireDataStoreClass),
215 NULL, /* base_init */
216 NULL, /* base_finalize */
217 (GClassInitFunc) psppire_data_store_class_init,
218 NULL, /* class_finalize */
219 NULL, /* class_data */
220 sizeof (PsppireDataStore),
222 (GInstanceInitFunc) psppire_data_store_init,
225 static const GInterfaceInfo tree_model_info = {
226 (GInterfaceInitFunc) __tree_model_init,
231 data_store_type = g_type_register_static (G_TYPE_OBJECT,
233 &data_store_info, 0);
235 g_type_add_interface_static (data_store_type, GTK_TYPE_TREE_MODEL,
239 return data_store_type;
244 psppire_data_store_class_init (PsppireDataStoreClass *class)
246 GObjectClass *object_class;
248 parent_class = g_type_class_peek_parent (class);
249 object_class = (GObjectClass*) class;
251 object_class->finalize = psppire_data_store_finalize;
252 object_class->dispose = psppire_data_store_dispose;
254 signals [ITEMS_CHANGED] =
255 g_signal_new ("changed",
256 G_TYPE_FROM_CLASS (class),
260 psppire_marshal_VOID__UINT_UINT_UINT,
267 signals [CASE_INSERTED] =
268 g_signal_new ("case-inserted",
269 G_TYPE_FROM_CLASS (class),
273 g_cclosure_marshal_VOID__INT,
279 signals [CASE_CHANGED] =
280 g_signal_new ("case-changed",
281 G_TYPE_FROM_CLASS (class),
285 g_cclosure_marshal_VOID__INT,
290 signals [CASES_DELETED] =
291 g_signal_new ("cases-deleted",
292 G_TYPE_FROM_CLASS (class),
296 psppire_marshal_VOID__INT_INT,
306 psppire_data_store_insert_value (PsppireDataStore *ds,
307 gint width, gint where);
310 psppire_data_store_get_case_count (const PsppireDataStore *store)
312 return datasheet_get_n_rows (store->datasheet);
316 psppire_data_store_get_value_count (const PsppireDataStore *store)
318 return psppire_dict_get_value_cnt (store->dict);
321 const struct caseproto *
322 psppire_data_store_get_proto (const PsppireDataStore *store)
324 return psppire_dict_get_proto (store->dict);
328 psppire_data_store_init (PsppireDataStore *data_store)
330 data_store->dict = NULL;
331 data_store->datasheet = NULL;
332 data_store->dispose_has_run = FALSE;
333 data_store->stamp = g_random_int ();
337 A callback which occurs after a variable has been deleted.
340 delete_variable_callback (GObject *obj, const struct variable *var UNUSED,
341 gint dict_index, gint case_index,
344 PsppireDataStore *store = PSPPIRE_DATA_STORE (data);
346 g_return_if_fail (store->datasheet);
348 datasheet_delete_columns (store->datasheet, case_index, 1);
349 datasheet_insert_column (store->datasheet, NULL, -1, case_index);
352 struct resize_datum_aux
354 const struct dictionary *dict;
355 const struct variable *new_variable;
356 const struct variable *old_variable;
360 resize_datum (const union value *old, union value *new, const void *aux_)
362 const struct resize_datum_aux *aux = aux_;
363 int new_width = var_get_width (aux->new_variable);
364 const char *enc = dict_get_encoding (aux->dict);
365 const struct fmt_spec *newfmt = var_get_print_format (aux->new_variable);
366 char *s = data_out (old, enc, var_get_print_format (aux->old_variable));
367 enum fmt_type type = (fmt_usable_for_input (newfmt->type)
370 free (data_in (ss_cstr (s), enc, type, new, new_width, enc));
375 variable_changed_callback (GObject *obj, gint var_num, guint what, const struct variable *oldvar,
378 PsppireDataStore *store = PSPPIRE_DATA_STORE (data);
379 struct variable *variable = psppire_dict_get_variable (store->dict, var_num);
381 if (what & VAR_TRAIT_WIDTH)
383 int posn = var_get_case_index (variable);
384 struct resize_datum_aux aux;
385 aux.old_variable = oldvar;
386 aux.new_variable = variable;
387 aux.dict = store->dict->dict;
388 datasheet_resize_column (store->datasheet, posn, var_get_width (variable),
394 insert_variable_callback (GObject *obj, gint var_num, gpointer data)
396 struct variable *variable;
397 PsppireDataStore *store;
400 g_return_if_fail (data);
402 store = PSPPIRE_DATA_STORE (data);
404 variable = psppire_dict_get_variable (store->dict, var_num);
405 posn = var_get_case_index (variable);
406 psppire_data_store_insert_value (store, var_get_width (variable), posn);
410 * psppire_data_store_new:
411 * @dict: The dictionary for this data_store.
414 * Return value: a new #PsppireDataStore
417 psppire_data_store_new (PsppireDict *dict)
419 PsppireDataStore *retval;
421 retval = g_object_new (PSPPIRE_TYPE_DATA_STORE, NULL);
423 psppire_data_store_set_dictionary (retval, dict);
429 psppire_data_store_set_reader (PsppireDataStore *ds,
430 struct casereader *reader)
436 old_n = datasheet_get_n_rows (ds->datasheet);
437 datasheet_destroy (ds->datasheet);
440 ds->datasheet = datasheet_create (reader);
442 gint new_n = datasheet_get_n_rows (ds->datasheet);
445 for (i = 0 ; i < n_dict_signals; ++i )
447 if ( ds->dict_handler_id [i] > 0)
449 g_signal_handler_unblock (ds->dict,
450 ds->dict_handler_id[i]);
454 g_signal_emit (ds, signals[ITEMS_CHANGED], 0, 0, old_n, new_n);
459 * psppire_data_store_replace_set_dictionary:
460 * @data_store: The variable store
461 * @dict: The dictionary to set
463 * If a dictionary is already associated with the data-store, then it will be
467 psppire_data_store_set_dictionary (PsppireDataStore *data_store, PsppireDict *dict)
471 /* Disconnect any existing handlers */
472 if ( data_store->dict )
473 for (i = 0 ; i < n_dict_signals; ++i )
475 g_signal_handler_disconnect (data_store->dict,
476 data_store->dict_handler_id[i]);
479 data_store->dict = dict;
484 data_store->dict_handler_id [VARIABLE_INSERTED] =
485 g_signal_connect (dict, "variable-inserted",
486 G_CALLBACK (insert_variable_callback),
489 data_store->dict_handler_id [VARIABLE_DELETED] =
490 g_signal_connect (dict, "variable-deleted",
491 G_CALLBACK (delete_variable_callback),
494 data_store->dict_handler_id [VARIABLE_CHANGED] =
495 g_signal_connect (dict, "variable-changed",
496 G_CALLBACK (variable_changed_callback),
502 /* The entire model has changed */
504 if ( data_store->dict )
505 for (i = 0 ; i < n_dict_signals; ++i )
507 if ( data_store->dict_handler_id [i] > 0)
509 g_signal_handler_block (data_store->dict,
510 data_store->dict_handler_id[i]);
516 psppire_data_store_finalize (GObject *object)
518 PsppireDataStore *ds = PSPPIRE_DATA_STORE (object);
522 datasheet_destroy (ds->datasheet);
523 ds->datasheet = NULL;
527 (* parent_class->finalize) (object);
532 psppire_data_store_dispose (GObject *object)
534 PsppireDataStore *ds = PSPPIRE_DATA_STORE (object);
536 if (ds->dispose_has_run)
539 psppire_data_store_set_dictionary (ds, NULL);
542 (* parent_class->dispose) (object);
544 ds->dispose_has_run = TRUE;
549 /* Insert a blank case before POSN */
551 psppire_data_store_insert_new_case (PsppireDataStore *ds, casenumber posn)
554 const struct caseproto *proto;
556 g_return_val_if_fail (ds, FALSE);
558 proto = datasheet_get_proto (ds->datasheet);
559 g_return_val_if_fail (caseproto_get_n_widths (proto) > 0, FALSE);
560 g_return_val_if_fail (posn <= psppire_data_store_get_case_count (ds), FALSE);
562 cc = case_create (proto);
563 case_set_missing (cc);
565 result = psppire_data_store_insert_case (ds, cc, posn);
573 psppire_data_store_get_string (PsppireDataStore *store,
574 glong row, const struct variable *var,
575 bool use_value_label)
581 g_return_val_if_fail (store != NULL, NULL);
582 g_return_val_if_fail (store->datasheet != NULL, NULL);
583 g_return_val_if_fail (var != NULL, NULL);
585 if (row < 0 || row >= datasheet_get_n_rows (store->datasheet))
588 width = var_get_width (var);
589 value_init (&v, width);
590 datasheet_get_value (store->datasheet, row, var_get_case_index (var), &v);
595 const char *label = var_lookup_value_label (var, &v);
597 string = g_strdup (label);
600 string = value_to_text (v, var);
602 value_destroy (&v, width);
608 /* Attempts to update that part of the variable store which corresponds to VAR
609 within ROW with the value TEXT.
611 If USE_VALUE_LABEL is true, and TEXT is a value label for the column's
612 variable, then stores the value from that value label instead of the literal
615 Returns true if anything was updated, false otherwise. */
617 psppire_data_store_set_string (PsppireDataStore *store,
619 glong row, const struct variable *var,
620 gboolean use_value_label)
626 n_cases = psppire_data_store_get_case_count (store);
630 psppire_data_store_insert_new_case (store, row);
632 case_index = var_get_case_index (var);
635 const struct val_labs *vls = var_get_value_labels (var);
636 const union value *value = vls ? val_labs_find_value (vls, text) : NULL;
638 ok = datasheet_put_value (store->datasheet, row, case_index, value);
643 ok = psppire_data_store_data_in (store, row, case_index, ss_cstr (text),
644 var_get_print_format (var));
647 g_signal_emit (store, signals [CASE_CHANGED], 0, row);
654 psppire_data_store_clear (PsppireDataStore *ds)
656 datasheet_destroy (ds->datasheet);
657 ds->datasheet = NULL;
659 psppire_dict_clear (ds->dict);
661 g_signal_emit (ds, signals [CASES_DELETED], 0, 0, -1);
666 /* Return a casereader made from this datastore */
668 psppire_data_store_get_reader (PsppireDataStore *ds)
671 struct casereader *reader ;
674 for (i = 0 ; i < n_dict_signals; ++i )
676 g_signal_handler_block (ds->dict,
677 ds->dict_handler_id[i]);
680 reader = datasheet_make_reader (ds->datasheet);
682 /* We must not reference this again */
683 ds->datasheet = NULL;
690 /* Column related funcs */
693 static const gchar null_var_name[]=N_("var");
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 [CASES_DELETED], 0, first, n_cases);
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);
747 g_signal_emit (ds, signals [CASE_INSERTED], 0, posn);
749 g_warning ("Cannot insert case at position %ld\n", posn);
755 /* Set the value of VAR in case CASENUM to V.
756 V must be the correct width for IDX.
757 Returns true if successful, false on I/O error. */
759 psppire_data_store_set_value (PsppireDataStore *ds, casenumber casenum,
760 const struct variable *var, const union value *v)
765 g_return_val_if_fail (ds, FALSE);
766 g_return_val_if_fail (ds->datasheet, FALSE);
768 n_cases = psppire_data_store_get_case_count (ds);
769 if ( casenum > n_cases)
772 if (casenum == n_cases)
773 psppire_data_store_insert_new_case (ds, casenum);
775 ok = datasheet_put_value (ds->datasheet, casenum, var_get_case_index (var),
778 g_signal_emit (ds, signals [CASE_CHANGED], 0, casenum);
786 /* Set the IDXth value of case C using D_IN */
788 psppire_data_store_data_in (PsppireDataStore *ds, casenumber casenum, gint idx,
789 struct substring input, const struct fmt_spec *fmt)
797 g_return_val_if_fail (ds, FALSE);
798 g_return_val_if_fail (ds->datasheet, FALSE);
800 g_return_val_if_fail (idx < datasheet_get_n_columns (ds->datasheet), FALSE);
804 width = fmt_var_width (fmt);
805 g_return_val_if_fail (caseproto_get_width (
806 datasheet_get_proto (ds->datasheet), idx) == width,
808 value_init (&value, width);
809 ok = (datasheet_get_value (ds->datasheet, casenum, idx, &value)
810 && data_in_msg (input, UTF8, fmt->type, &value, width,
811 dict_get_encoding (dict->dict))
812 && datasheet_put_value (ds->datasheet, casenum, idx, &value));
813 value_destroy (&value, width);
818 /* Resize the cases in the casefile, by inserting a value of the
819 given WIDTH into every one of them at the position immediately
823 psppire_data_store_insert_value (PsppireDataStore *ds,
824 gint width, gint where)
828 g_return_val_if_fail (ds, FALSE);
830 g_assert (width >= 0);
832 if ( ! ds->datasheet )
833 ds->datasheet = datasheet_create (NULL);
835 value_init (&value, width);
836 value_set_missing (&value, width);
838 datasheet_insert_column (ds->datasheet, &value, width, where);
839 value_destroy (&value, width);
845 psppire_data_store_filtered (PsppireDataStore *ds,
850 const struct dictionary *dict;
851 const struct variable *filter;
853 if ( row < 0 || row >= datasheet_get_n_rows (ds->datasheet))
856 dict = ds->dict->dict;
857 g_return_val_if_fail (dict, FALSE);
858 filter = dict_get_filter (dict);
862 g_return_val_if_fail (var_is_numeric (filter), FALSE);
863 value_init (&val, 0);
864 if ( ! datasheet_get_value (ds->datasheet, row,
865 var_get_case_index (filter),
869 return (val.f == 0.0);