1 /* psppire-data-store.c
3 PSPPIRE --- A Graphical User Interface for PSPP
4 Copyright (C) 2006 Free Software Foundation
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
25 #define _(msgid) gettext (msgid)
26 #define N_(msgid) msgid
28 #include <data/casewriter.h>
29 #include <data/datasheet.h>
30 #include <data/data-out.h>
31 #include <data/variable.h>
33 #include <gtksheet/gtksheet.h>
34 #include <gtksheet/gsheetmodel.h>
35 #include <gtksheet/gsheet-column-iface.h>
37 #include <pango/pango-context.h>
39 #include "psppire-data-store.h"
40 #include "psppire-case-file.h"
43 #include <data/dictionary.h>
44 #include <data/missing-values.h>
45 #include <data/value-labels.h>
46 #include <data/data-in.h>
48 #include <data/file-handle-def.h>
49 #include <data/sys-file-writer.h>
53 static void psppire_data_store_init (PsppireDataStore *data_store);
54 static void psppire_data_store_class_init (PsppireDataStoreClass *class);
55 static void psppire_data_store_sheet_model_init (GSheetModelIface *iface);
56 static void psppire_data_store_sheet_column_init (GSheetColumnIface *iface);
57 static void psppire_data_store_sheet_row_init (GSheetRowIface *iface);
59 static void psppire_data_store_finalize (GObject *object);
61 static gboolean psppire_data_store_clear_datum (GSheetModel *model,
62 gint row, gint column);
65 #define MIN_COLUMNS 10
67 #define TRAILING_ROWS 10
69 static GObjectClass *parent_class = NULL;
75 static guint signals [n_SIGNALS];
79 psppire_data_store_get_type (void)
81 static GType data_store_type = 0;
85 static const GTypeInfo data_store_info =
87 sizeof (PsppireDataStoreClass),
89 NULL, /* base_finalize */
90 (GClassInitFunc) psppire_data_store_class_init,
91 NULL, /* class_finalize */
92 NULL, /* class_data */
93 sizeof (PsppireDataStore),
95 (GInstanceInitFunc) psppire_data_store_init,
98 static const GInterfaceInfo sheet_model_info =
100 (GInterfaceInitFunc) psppire_data_store_sheet_model_init,
105 static const GInterfaceInfo sheet_column_info =
107 (GInterfaceInitFunc) psppire_data_store_sheet_column_init,
112 static const GInterfaceInfo sheet_row_info =
114 (GInterfaceInitFunc) psppire_data_store_sheet_row_init,
120 data_store_type = g_type_register_static (G_TYPE_OBJECT, "PsppireDataStore",
121 &data_store_info, 0);
123 g_type_add_interface_static (data_store_type,
127 g_type_add_interface_static (data_store_type,
131 g_type_add_interface_static (data_store_type,
136 return data_store_type;
141 psppire_data_store_class_init (PsppireDataStoreClass *class)
143 GObjectClass *object_class;
145 parent_class = g_type_class_peek_parent (class);
146 object_class = (GObjectClass*) class;
148 object_class->finalize = psppire_data_store_finalize;
150 signals [FONT_CHANGED] =
151 g_signal_new ("font_changed",
152 G_TYPE_FROM_CLASS (class),
156 g_cclosure_marshal_VOID__VOID,
164 psppire_data_store_get_var_count (const GSheetModel *model)
166 const PsppireDataStore *store = PSPPIRE_DATA_STORE (model);
168 return psppire_dict_get_var_cnt (store->dict);
172 psppire_data_store_get_case_count (const GSheetModel *model)
174 const PsppireDataStore *store = PSPPIRE_DATA_STORE (model);
176 return psppire_case_file_get_case_count (store->case_file);
181 psppire_data_store_init (PsppireDataStore *data_store)
183 data_store->dict = 0;
184 data_store->case_file = 0;
185 data_store->width_of_m = 10;
188 const PangoFontDescription *
189 psppire_data_store_get_font_desc (const GSheetModel *model,
190 gint row, gint column)
192 PsppireDataStore *store = PSPPIRE_DATA_STORE (model);
194 return store->font_desc;
197 static inline gchar *
198 psppire_data_store_get_string_wrapper (const GSheetModel *model, gint row,
201 return psppire_data_store_get_string (PSPPIRE_DATA_STORE (model), row, column);
205 static inline gboolean
206 psppire_data_store_set_string_wrapper (GSheetModel *model,
208 gint row, gint column)
210 return psppire_data_store_set_string (PSPPIRE_DATA_STORE (model), text,
218 psppire_data_store_sheet_model_init (GSheetModelIface *iface)
220 iface->free_strings = TRUE;
221 iface->get_string = psppire_data_store_get_string_wrapper;
222 iface->set_string = psppire_data_store_set_string_wrapper;
223 iface->clear_datum = psppire_data_store_clear_datum;
224 iface->is_editable = NULL;
225 iface->is_visible = NULL;
226 iface->get_foreground = NULL;
227 iface->get_background = NULL;
228 iface->get_font_desc = psppire_data_store_get_font_desc;
229 iface->get_cell_border = NULL;
230 iface->get_column_count = psppire_data_store_get_var_count;
231 iface->get_row_count = psppire_data_store_get_case_count;
235 gboolean always_true ()
242 delete_cases_callback (GtkWidget *w, gint first, gint n_cases, gpointer data)
244 PsppireDataStore *store ;
246 g_return_if_fail (data);
248 store = PSPPIRE_DATA_STORE (data);
250 g_assert (first >= 0);
252 g_sheet_model_rows_deleted (G_SHEET_MODEL (store), first, n_cases);
257 insert_case_callback (GtkWidget *w, gint casenum, gpointer data)
259 PsppireDataStore *store ;
261 g_return_if_fail (data);
263 store = PSPPIRE_DATA_STORE (data);
265 g_sheet_model_range_changed (G_SHEET_MODEL (store),
267 psppire_case_file_get_case_count (store->case_file),
270 g_sheet_model_rows_inserted (G_SHEET_MODEL (store), casenum, 1);
275 changed_case_callback (GtkWidget *w, gint casenum, gpointer data)
277 PsppireDataStore *store ;
278 g_return_if_fail (data);
280 store = PSPPIRE_DATA_STORE (data);
282 g_sheet_model_range_changed (G_SHEET_MODEL (store),
289 delete_variables_callback (GObject *obj, gint var_num, gint n_vars, gpointer data)
291 PsppireDataStore *store ;
293 g_return_if_fail (data);
295 store = PSPPIRE_DATA_STORE (data);
297 g_sheet_model_columns_deleted (G_SHEET_MODEL (store), var_num, n_vars);
299 g_sheet_column_columns_changed (G_SHEET_COLUMN (store),
305 variable_changed_callback (GObject *obj, gint var_num, gpointer data)
307 PsppireDataStore *store;
309 g_return_if_fail (data);
311 store = PSPPIRE_DATA_STORE (data);
313 g_sheet_column_columns_changed (G_SHEET_COLUMN (store),
317 g_sheet_model_range_changed (G_SHEET_MODEL (store),
323 insert_variable_callback (GObject *obj, gint var_num, gpointer data)
325 PsppireDataStore *store;
328 g_return_if_fail (data);
330 store = PSPPIRE_DATA_STORE (data);
334 struct variable *variable =
335 psppire_dict_get_variable (store->dict, var_num);
337 g_assert (variable != NULL);
339 posn = var_get_case_index (variable);
346 psppire_case_file_insert_values (store->case_file, 1, posn);
348 g_sheet_column_columns_changed (G_SHEET_COLUMN (store),
351 g_sheet_model_columns_inserted (G_SHEET_MODEL (store), var_num, 1);
356 dict_size_change_callback (GObject *obj,
357 gint posn, gint adjustment, gpointer data)
359 PsppireDataStore *store ;
361 g_return_if_fail (data);
363 store = PSPPIRE_DATA_STORE (data);
365 psppire_case_file_insert_values (store->case_file, adjustment, posn);
371 * psppire_data_store_new:
372 * @dict: The dictionary for this data_store.
375 * Return value: a new #PsppireDataStore
378 psppire_data_store_new (PsppireDict *dict)
380 PsppireDataStore *retval;
382 retval = g_object_new (GTK_TYPE_DATA_STORE, NULL);
384 psppire_data_store_set_dictionary (retval, dict);
391 psppire_data_store_set_case_file (PsppireDataStore *data_store,
394 if ( data_store->case_file)
396 g_object_unref (data_store->case_file);
399 data_store->case_file = cf;
401 g_signal_connect (data_store->case_file, "cases-deleted",
402 G_CALLBACK (delete_cases_callback),
405 g_signal_connect (data_store->case_file, "case-inserted",
406 G_CALLBACK (insert_case_callback),
410 g_signal_connect (data_store->case_file, "case-changed",
411 G_CALLBACK (changed_case_callback),
418 * psppire_data_store_replace_set_dictionary:
419 * @data_store: The variable store
420 * @dict: The dictionary to set
422 * If a dictionary is already associated with the data-store, then it will be
426 psppire_data_store_set_dictionary (PsppireDataStore *data_store, PsppireDict *dict)
428 data_store->dict = dict;
430 g_signal_connect (dict, "variable-inserted",
431 G_CALLBACK (insert_variable_callback),
434 g_signal_connect (dict, "variables-deleted",
435 G_CALLBACK (delete_variables_callback),
438 g_signal_connect (dict, "variable-changed",
439 G_CALLBACK (variable_changed_callback),
443 g_signal_connect (dict, "dict-size-changed",
444 G_CALLBACK (dict_size_change_callback),
447 /* The entire model has changed */
448 g_sheet_model_range_changed (G_SHEET_MODEL (data_store), -1, -1, -1, -1);
450 g_sheet_column_columns_changed (G_SHEET_COLUMN (data_store), 0, -1);
454 psppire_data_store_finalize (GObject *object)
458 (* parent_class->finalize) (object);
463 /* Insert a blank case before POSN */
465 psppire_data_store_insert_new_case (PsppireDataStore *ds, gint posn)
470 g_return_val_if_fail (ds, FALSE);
473 /* Opportunity for optimisation exists here when creating a blank case */
474 val_cnt = datasheet_get_column_cnt (ds->case_file->datasheet) ;
476 case_create (&cc, val_cnt);
478 memset ( case_data_rw_idx (&cc, 0), 0, val_cnt * MAX_SHORT_STRING);
480 for (v = 0 ; v < psppire_dict_get_var_cnt (ds->dict) ; ++v)
482 const struct variable *pv = psppire_dict_get_variable (ds->dict, v);
483 if ( var_is_alpha (pv))
486 case_data_rw (&cc, pv)->f = SYSMIS;
489 result = psppire_case_file_insert_case (ds->case_file, &cc, posn);
498 psppire_data_store_get_string (PsppireDataStore *store, gint row, gint column)
502 const struct fmt_spec *fp ;
503 const struct variable *pv ;
507 g_return_val_if_fail (store->dict, NULL);
508 g_return_val_if_fail (store->case_file, NULL);
510 if (column >= psppire_dict_get_var_cnt (store->dict))
513 if ( row >= psppire_case_file_get_case_count (store->case_file))
516 pv = psppire_dict_get_variable (store->dict, column);
520 idx = var_get_case_index (pv);
524 v = psppire_case_file_get_value (store->case_file, row, idx, NULL,
527 g_return_val_if_fail (v, NULL);
529 if ( store->show_labels)
531 const gchar *label = var_lookup_value_label (pv, v);
535 return pspp_locale_to_utf8 (label, -1, 0);
539 fp = var_get_write_format (pv);
541 s = g_string_sized_new (fp->w + 1);
542 g_string_set_size (s, fp->w);
544 memset (s->str, 0, fp->w);
546 g_assert (fp->w == s->len);
548 /* Converts binary value V into printable form in the exactly
549 FP->W character in buffer S according to format specification
550 FP. No null terminator is appended to the buffer. */
551 data_out (v, fp, s->str);
553 text = pspp_locale_to_utf8 (s->str, fp->w, 0);
554 g_string_free (s, TRUE);
564 psppire_data_store_clear_datum (GSheetModel *model,
568 PsppireDataStore *store = PSPPIRE_DATA_STORE (model);
571 const struct variable *pv = psppire_dict_get_variable (store->dict, col);
573 const gint index = var_get_case_index (pv) ;
575 if ( var_is_numeric (pv))
578 memcpy (v.s, "", MAX_SHORT_STRING);
580 psppire_case_file_set_value (store->case_file, row, index, &v,
587 /* Attempts to update that part of the variable store which corresponds
588 to ROW, COL with the value TEXT.
589 Returns true if anything was updated, false otherwise.
592 psppire_data_store_set_string (PsppireDataStore *store,
593 const gchar *text, gint row, gint col)
595 const struct variable *pv = psppire_dict_get_variable (store->dict, col);
596 g_return_val_if_fail (pv, FALSE);
599 /* Allow the user to insert a lot of blank cases, simply by skipping rows */
600 for (r = psppire_case_file_get_case_count (store->case_file); r <= row ; ++r)
605 psppire_case_array_insert_case (store->cases, r, 0, 0);
608 for (c = 0 ; c < psppire_dict_get_var_cnt (store->dict); ++c )
609 psppire_data_store_clear_datum (model, r, c);
613 psppire_case_file_data_in (store->case_file, row,
614 var_get_case_index (pv), ss_cstr (text),
615 var_get_write_format (pv));
622 psppire_data_store_set_font (PsppireDataStore *store,
623 const PangoFontDescription *fd)
625 g_return_if_fail (store);
626 g_return_if_fail (PSPPIRE_IS_DATA_STORE (store));
628 store->font_desc = fd;
630 store->width_of_m = calc_m_width (fd);
632 g_signal_emit (store, signals [FONT_CHANGED], 0);
635 g_sheet_model_range_changed (G_SHEET_MODEL (store),
641 psppire_data_store_show_labels (PsppireDataStore *store, gboolean show_labels)
643 g_return_if_fail (store);
644 g_return_if_fail (PSPPIRE_IS_DATA_STORE (store));
646 store->show_labels = show_labels;
648 g_sheet_model_range_changed (G_SHEET_MODEL (store),
654 /* FIXME: There's no reason to actually have this function.
655 It should be done by a procedure */
657 psppire_data_store_create_system_file (PsppireDataStore *store,
658 struct file_handle *handle)
661 const struct sfm_write_options wo = {
662 true, /* writeable */
663 false, /* dont compress */
667 struct casewriter *writer;
671 writer = sfm_open_writer (handle, store->dict->dict, wo);
677 var_cnt = psppire_data_store_get_var_count (G_SHEET_MODEL (store));
679 for (i = 0 ; i < psppire_case_file_get_case_count (store->case_file); ++i )
682 psppire_case_file_get_case (store->case_file, i, &c);
683 casewriter_write (writer, &c);
685 casewriter_destroy (writer);
691 psppire_data_store_clear (PsppireDataStore *data_store)
693 psppire_case_file_clear (data_store->case_file);
695 psppire_dict_clear (data_store->dict);
700 /* Return a casereader made from this datastore */
702 psppire_data_store_get_reader (PsppireDataStore *ds)
704 struct casereader *reader ;
706 reader = psppire_case_file_make_reader (ds->case_file);
713 /* Column related funcs */
716 geometry_get_column_count (const GSheetColumn *geom)
718 PsppireDataStore *ds = PSPPIRE_DATA_STORE (geom);
720 return MAX (MIN_COLUMNS, psppire_dict_get_var_cnt (ds->dict));
726 geometry_get_width (const GSheetColumn *geom, gint unit)
728 const struct variable *pv ;
729 PsppireDataStore *ds = PSPPIRE_DATA_STORE (geom);
731 if ( unit >= psppire_dict_get_var_cnt (ds->dict) )
732 return ds->width_of_m * 8 ;
734 pv = psppire_dict_get_variable (ds->dict, unit);
737 return ds->width_of_m * 8 ;
739 return ds->width_of_m * var_get_display_width (pv);
743 geometry_set_width (GSheetColumn *geom, gint unit, gint width)
745 PsppireDataStore *ds = PSPPIRE_DATA_STORE (geom);
747 struct variable *pv = psppire_dict_get_variable (ds->dict, unit);
749 var_set_display_width (pv, width / ds->width_of_m );
754 static GtkJustification
755 geometry_get_justification (const GSheetColumn *geom, gint unit)
757 PsppireDataStore *ds = PSPPIRE_DATA_STORE (geom);
758 const struct variable *pv ;
761 if ( unit >= psppire_dict_get_var_cnt (ds->dict) )
762 return GTK_JUSTIFY_LEFT;
764 pv = psppire_dict_get_variable (ds->dict, unit);
766 return (var_get_alignment (pv) == ALIGN_LEFT ? GTK_JUSTIFY_LEFT
767 : var_get_alignment (pv) == ALIGN_RIGHT ? GTK_JUSTIFY_RIGHT
768 : GTK_JUSTIFY_CENTER);
772 static const gchar null_var_name[]=N_("var");
775 geometry_get_column_button_label (const GSheetColumn *geom, gint unit)
778 struct variable *pv ;
779 PsppireDataStore *ds = PSPPIRE_DATA_STORE (geom);
781 if ( unit >= psppire_dict_get_var_cnt (ds->dict) )
782 return g_locale_to_utf8 (null_var_name, -1, 0, 0, 0);
784 pv = psppire_dict_get_variable (ds->dict, unit);
786 text = pspp_locale_to_utf8 (var_get_name (pv), -1, 0);
793 geometry_get_sensitivity (const GSheetColumn *geom, gint unit)
795 PsppireDataStore *ds = PSPPIRE_DATA_STORE (geom);
797 return (unit < psppire_dict_get_var_cnt (ds->dict));
802 psppire_data_store_sheet_column_init (GSheetColumnIface *iface)
804 iface->get_column_count = geometry_get_column_count;
805 iface->get_width = geometry_get_width;
806 iface->set_width = geometry_set_width;
807 iface->get_visibility = always_true;
808 iface->get_sensitivity = geometry_get_sensitivity;
809 iface->get_justification = geometry_get_justification;
810 iface->get_button_label = geometry_get_column_button_label;
814 /* Row related funcs */
817 geometry_get_row_count (const GSheetRow *geom, gpointer data)
819 PsppireDataStore *ds = PSPPIRE_DATA_STORE (geom);
821 return TRAILING_ROWS + psppire_case_file_get_case_count (ds->case_file);
826 geometry_get_height (const GSheetRow *geom, gint unit, gpointer data)
833 geometry_get_row_sensitivity (const GSheetRow *geom, gint unit, gpointer data)
835 PsppireDataStore *ds = PSPPIRE_DATA_STORE (geom);
838 return (unit < psppire_case_file_get_case_count (ds->case_file));
843 geometry_get_row_button_label (const GSheetRow *geom, gint unit, gpointer data)
847 PsppireDataStore *ds = PSPPIRE_DATA_STORE (geom);
850 TRAILING_ROWS + psppire_case_file_get_case_count (ds->case_file))
853 s = g_strdup_printf (_("%d"), unit);
855 text = pspp_locale_to_utf8 (s, -1, 0);
864 psppire_data_store_sheet_row_init (GSheetRowIface *iface)
866 iface->get_row_count = geometry_get_row_count;
868 iface->get_height = geometry_get_height;
869 iface->set_height = 0;
870 iface->get_visibility = always_true;
871 iface->get_sensitivity = geometry_get_row_sensitivity;
873 iface->get_button_label = geometry_get_row_button_label;