1 /* PSPPIRE - a graphical user interface for PSPP.
2 Copyright (C) 2006, 2008, 2009, 2010, 2011, 2012 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];
81 psppire_data_store_get_type (void)
83 static GType data_store_type = 0;
87 static const GTypeInfo data_store_info =
89 sizeof (PsppireDataStoreClass),
91 NULL, /* base_finalize */
92 (GClassInitFunc) psppire_data_store_class_init,
93 NULL, /* class_finalize */
94 NULL, /* class_data */
95 sizeof (PsppireDataStore),
97 (GInstanceInitFunc) psppire_data_store_init,
100 data_store_type = g_type_register_static (G_TYPE_OBJECT,
102 &data_store_info, 0);
105 return data_store_type;
110 psppire_data_store_class_init (PsppireDataStoreClass *class)
112 GObjectClass *object_class;
114 parent_class = g_type_class_peek_parent (class);
115 object_class = (GObjectClass*) class;
117 object_class->finalize = psppire_data_store_finalize;
118 object_class->dispose = psppire_data_store_dispose;
120 signals [BACKEND_CHANGED] =
121 g_signal_new ("backend-changed",
122 G_TYPE_FROM_CLASS (class),
126 g_cclosure_marshal_VOID__VOID,
130 signals [CASE_INSERTED] =
131 g_signal_new ("case-inserted",
132 G_TYPE_FROM_CLASS (class),
136 g_cclosure_marshal_VOID__INT,
142 signals [CASE_CHANGED] =
143 g_signal_new ("case-changed",
144 G_TYPE_FROM_CLASS (class),
148 g_cclosure_marshal_VOID__INT,
153 signals [CASES_DELETED] =
154 g_signal_new ("cases-deleted",
155 G_TYPE_FROM_CLASS (class),
159 psppire_marshal_VOID__INT_INT,
169 psppire_data_store_insert_value (PsppireDataStore *ds,
170 gint width, gint where);
173 psppire_data_store_get_case_count (const PsppireDataStore *store)
175 return datasheet_get_n_rows (store->datasheet);
179 psppire_data_store_get_value_count (const PsppireDataStore *store)
181 return psppire_dict_get_value_cnt (store->dict);
184 const struct caseproto *
185 psppire_data_store_get_proto (const PsppireDataStore *store)
187 return psppire_dict_get_proto (store->dict);
191 psppire_data_store_init (PsppireDataStore *data_store)
193 data_store->dict = NULL;
194 data_store->datasheet = NULL;
195 data_store->dispose_has_run = FALSE;
199 A callback which occurs after a variable has been deleted.
202 delete_variable_callback (GObject *obj, const struct variable *var UNUSED,
203 gint dict_index, gint case_index,
206 PsppireDataStore *store = PSPPIRE_DATA_STORE (data);
209 datasheet_delete_columns (store->datasheet, case_index, 1);
210 datasheet_insert_column (store->datasheet, NULL, -1, case_index);
213 struct resize_datum_aux
215 const struct dictionary *dict;
216 const struct variable *new_variable;
217 const struct variable *old_variable;
221 resize_datum (const union value *old, union value *new, const void *aux_)
223 const struct resize_datum_aux *aux = aux_;
224 int new_width = var_get_width (aux->new_variable);
225 const char *enc = dict_get_encoding (aux->dict);
226 const struct fmt_spec *newfmt = var_get_print_format (aux->new_variable);
227 char *s = data_out (old, enc, var_get_print_format (aux->old_variable));
228 free (data_in (ss_cstr (s), enc, newfmt->type, new, new_width, enc));
233 variable_changed_callback (GObject *obj, gint var_num, guint what, const struct variable *oldvar,
236 PsppireDataStore *store = PSPPIRE_DATA_STORE (data);
237 struct variable *variable = psppire_dict_get_variable (store->dict, var_num);
239 if (what & VAR_TRAIT_WIDTH)
241 int posn = var_get_case_index (variable);
242 struct resize_datum_aux aux;
243 aux.old_variable = oldvar;
244 aux.new_variable = variable;
245 aux.dict = store->dict->dict;
246 datasheet_resize_column (store->datasheet, posn, var_get_width (variable),
252 insert_variable_callback (GObject *obj, gint var_num, gpointer data)
254 struct variable *variable;
255 PsppireDataStore *store;
258 g_return_if_fail (data);
260 store = PSPPIRE_DATA_STORE (data);
262 variable = psppire_dict_get_variable (store->dict, var_num);
263 posn = var_get_case_index (variable);
264 psppire_data_store_insert_value (store, var_get_width (variable), posn);
268 * psppire_data_store_new:
269 * @dict: The dictionary for this data_store.
272 * Return value: a new #PsppireDataStore
275 psppire_data_store_new (PsppireDict *dict)
277 PsppireDataStore *retval;
279 retval = g_object_new (PSPPIRE_TYPE_DATA_STORE, NULL);
281 psppire_data_store_set_dictionary (retval, dict);
287 psppire_data_store_set_reader (PsppireDataStore *ds,
288 struct casereader *reader)
293 datasheet_destroy (ds->datasheet);
295 ds->datasheet = datasheet_create (reader);
298 for (i = 0 ; i < n_dict_signals; ++i )
300 if ( ds->dict_handler_id [i] > 0)
302 g_signal_handler_unblock (ds->dict,
303 ds->dict_handler_id[i]);
307 g_signal_emit (ds, signals[BACKEND_CHANGED], 0);
312 * psppire_data_store_replace_set_dictionary:
313 * @data_store: The variable store
314 * @dict: The dictionary to set
316 * If a dictionary is already associated with the data-store, then it will be
320 psppire_data_store_set_dictionary (PsppireDataStore *data_store, PsppireDict *dict)
324 /* Disconnect any existing handlers */
325 if ( data_store->dict )
326 for (i = 0 ; i < n_dict_signals; ++i )
328 g_signal_handler_disconnect (data_store->dict,
329 data_store->dict_handler_id[i]);
332 data_store->dict = dict;
337 data_store->dict_handler_id [VARIABLE_INSERTED] =
338 g_signal_connect (dict, "variable-inserted",
339 G_CALLBACK (insert_variable_callback),
342 data_store->dict_handler_id [VARIABLE_DELETED] =
343 g_signal_connect (dict, "variable-deleted",
344 G_CALLBACK (delete_variable_callback),
347 data_store->dict_handler_id [VARIABLE_CHANGED] =
348 g_signal_connect (dict, "variable-changed",
349 G_CALLBACK (variable_changed_callback),
355 /* The entire model has changed */
357 if ( data_store->dict )
358 for (i = 0 ; i < n_dict_signals; ++i )
360 if ( data_store->dict_handler_id [i] > 0)
362 g_signal_handler_block (data_store->dict,
363 data_store->dict_handler_id[i]);
369 psppire_data_store_finalize (GObject *object)
371 PsppireDataStore *ds = PSPPIRE_DATA_STORE (object);
375 datasheet_destroy (ds->datasheet);
376 ds->datasheet = NULL;
380 (* parent_class->finalize) (object);
385 psppire_data_store_dispose (GObject *object)
387 PsppireDataStore *ds = PSPPIRE_DATA_STORE (object);
389 if (ds->dispose_has_run)
394 (* parent_class->dispose) (object);
396 ds->dispose_has_run = TRUE;
401 /* Insert a blank case before POSN */
403 psppire_data_store_insert_new_case (PsppireDataStore *ds, casenumber posn)
406 const struct caseproto *proto;
408 g_return_val_if_fail (ds, FALSE);
410 proto = datasheet_get_proto (ds->datasheet);
411 g_return_val_if_fail (caseproto_get_n_widths (proto) > 0, FALSE);
412 g_return_val_if_fail (posn <= psppire_data_store_get_case_count (ds), FALSE);
414 cc = case_create (proto);
415 case_set_missing (cc);
417 result = psppire_data_store_insert_case (ds, cc, posn);
425 psppire_data_store_get_string (PsppireDataStore *store,
426 glong row, const struct variable *var,
427 bool use_value_label)
433 g_return_val_if_fail (store != NULL, NULL);
434 g_return_val_if_fail (var != NULL, NULL);
436 if (row < 0 || row >= datasheet_get_n_rows (store->datasheet))
439 width = var_get_width (var);
440 value_init (&v, width);
441 datasheet_get_value (store->datasheet, row, var_get_case_index (var), &v);
446 const char *label = var_lookup_value_label (var, &v);
448 string = g_strdup (label);
451 string = value_to_text (v, var);
453 value_destroy (&v, width);
459 /* Attempts to update that part of the variable store which corresponds to VAR
460 within ROW with the value TEXT.
462 If USE_VALUE_LABEL is true, and TEXT is a value label for the column's
463 variable, then stores the value from that value label instead of the literal
466 Returns true if anything was updated, false otherwise. */
468 psppire_data_store_set_string (PsppireDataStore *store,
470 glong row, const struct variable *var,
471 gboolean use_value_label)
477 n_cases = psppire_data_store_get_case_count (store);
481 psppire_data_store_insert_new_case (store, row);
483 case_index = var_get_case_index (var);
486 const struct val_labs *vls = var_get_value_labels (var);
487 const union value *value = vls ? val_labs_find_value (vls, text) : NULL;
489 ok = datasheet_put_value (store->datasheet, row, case_index, value);
494 ok = psppire_data_store_data_in (store, row, case_index, ss_cstr (text),
495 var_get_print_format (var));
498 g_signal_emit (store, signals [CASE_CHANGED], 0, row);
505 psppire_data_store_clear (PsppireDataStore *ds)
507 datasheet_destroy (ds->datasheet);
508 ds->datasheet = NULL;
510 psppire_dict_clear (ds->dict);
512 g_signal_emit (ds, signals [CASES_DELETED], 0, 0, -1);
517 /* Return a casereader made from this datastore */
519 psppire_data_store_get_reader (PsppireDataStore *ds)
522 struct casereader *reader ;
525 for (i = 0 ; i < n_dict_signals; ++i )
527 g_signal_handler_block (ds->dict,
528 ds->dict_handler_id[i]);
531 reader = datasheet_make_reader (ds->datasheet);
533 /* We must not reference this again */
534 ds->datasheet = NULL;
541 /* Column related funcs */
544 static const gchar null_var_name[]=N_("var");
550 /* Returns the CASENUMth case, or a null pointer on failure.
553 psppire_data_store_get_case (const PsppireDataStore *ds,
556 g_return_val_if_fail (ds, FALSE);
557 g_return_val_if_fail (ds->datasheet, FALSE);
559 return datasheet_get_row (ds->datasheet, casenum);
564 psppire_data_store_delete_cases (PsppireDataStore *ds, casenumber first,
567 g_return_val_if_fail (ds, FALSE);
568 g_return_val_if_fail (ds->datasheet, FALSE);
570 g_return_val_if_fail (first + n_cases <=
571 psppire_data_store_get_case_count (ds), FALSE);
574 datasheet_delete_rows (ds->datasheet, first, n_cases);
576 g_signal_emit (ds, signals [CASES_DELETED], 0, first, n_cases);
583 /* Insert case CC into the case file before POSN */
585 psppire_data_store_insert_case (PsppireDataStore *ds,
591 g_return_val_if_fail (ds, FALSE);
592 g_return_val_if_fail (ds->datasheet, FALSE);
595 result = datasheet_insert_rows (ds->datasheet, posn, &cc, 1);
598 g_signal_emit (ds, signals [CASE_INSERTED], 0, posn);
600 g_warning ("Cannot insert case at position %ld\n", posn);
606 /* Set the value of VAR in case CASENUM to V.
607 V must be the correct width for IDX.
608 Returns true if successful, false on I/O error. */
610 psppire_data_store_set_value (PsppireDataStore *ds, casenumber casenum,
611 const struct variable *var, const union value *v)
616 g_return_val_if_fail (ds, FALSE);
617 g_return_val_if_fail (ds->datasheet, FALSE);
619 n_cases = psppire_data_store_get_case_count (ds);
620 if ( casenum > n_cases)
623 if (casenum == n_cases)
624 psppire_data_store_insert_new_case (ds, casenum);
626 ok = datasheet_put_value (ds->datasheet, casenum, var_get_case_index (var),
629 g_signal_emit (ds, signals [CASE_CHANGED], 0, casenum);
637 /* Set the IDXth value of case C using D_IN */
639 psppire_data_store_data_in (PsppireDataStore *ds, casenumber casenum, gint idx,
640 struct substring input, const struct fmt_spec *fmt)
648 g_return_val_if_fail (ds, FALSE);
649 g_return_val_if_fail (ds->datasheet, FALSE);
651 g_return_val_if_fail (idx < datasheet_get_n_columns (ds->datasheet), FALSE);
655 width = fmt_var_width (fmt);
656 g_return_val_if_fail (caseproto_get_width (
657 datasheet_get_proto (ds->datasheet), idx) == width,
659 value_init (&value, width);
660 ok = (datasheet_get_value (ds->datasheet, casenum, idx, &value)
661 && data_in_msg (input, UTF8, fmt->type, &value, width,
662 dict_get_encoding (dict->dict))
663 && datasheet_put_value (ds->datasheet, casenum, idx, &value));
664 value_destroy (&value, width);
669 /* Resize the cases in the casefile, by inserting a value of the
670 given WIDTH into every one of them at the position immediately
674 psppire_data_store_insert_value (PsppireDataStore *ds,
675 gint width, gint where)
679 g_return_val_if_fail (ds, FALSE);
681 g_assert (width >= 0);
683 if ( ! ds->datasheet )
684 ds->datasheet = datasheet_create (NULL);
686 value_init (&value, width);
687 value_set_missing (&value, width);
689 datasheet_insert_column (ds->datasheet, &value, width, where);
690 value_destroy (&value, width);
696 psppire_data_store_filtered (PsppireDataStore *ds,
701 const struct dictionary *dict;
702 const struct variable *filter;
704 if ( row < 0 || row >= datasheet_get_n_rows (ds->datasheet))
707 dict = ds->dict->dict;
708 g_return_val_if_fail (dict, FALSE);
709 filter = dict_get_filter (dict);
713 g_return_val_if_fail (var_is_numeric (filter), FALSE);
714 value_init (&val, 0);
715 if ( ! datasheet_get_value (ds->datasheet, row,
716 var_get_case_index (filter),
720 return (val.f == 0.0);