1 /* psppire-data-store.c
3 PSPPIRE --- A Graphical User Interface for PSPP
4 Copyright (C) 2006 Free Software Foundation
5 Written by John Darrington
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
26 #define _(msgid) gettext(msgid)
27 #define N_(msgid) msgid
29 #include <data/casefile.h>
30 #include <data/case.h>
32 #include <gtksheet/gtksheet.h>
33 #include <gtksheet/gsheetmodel.h>
34 #include <gtksheet/gsheet-column-iface.h>
36 #include <pango/pango-context.h>
38 #include "psppire-variable.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 gchar *psppire_data_store_get_string(const GSheetModel *sheet_model, gint row, gint column);
63 static gboolean psppire_data_store_set_string(GSheetModel *model,
64 const gchar *text, gint row, gint column);
66 static gboolean psppire_data_store_clear_datum(GSheetModel *model,
67 gint row, gint column);
70 #define MIN_COLUMNS 10
72 #define TRAILING_ROWS 10
74 static GObjectClass *parent_class = NULL;
80 static guint signal[n_SIGNALS];
84 psppire_data_store_get_type (void)
86 static GType data_store_type = 0;
90 static const GTypeInfo data_store_info =
92 sizeof (PsppireDataStoreClass),
94 NULL, /* base_finalize */
95 (GClassInitFunc) psppire_data_store_class_init,
96 NULL, /* class_finalize */
97 NULL, /* class_data */
98 sizeof (PsppireDataStore),
100 (GInstanceInitFunc) psppire_data_store_init,
103 static const GInterfaceInfo sheet_model_info =
105 (GInterfaceInitFunc) psppire_data_store_sheet_model_init,
110 static const GInterfaceInfo sheet_column_info =
112 (GInterfaceInitFunc) psppire_data_store_sheet_column_init,
117 static const GInterfaceInfo sheet_row_info =
119 (GInterfaceInitFunc) psppire_data_store_sheet_row_init,
125 data_store_type = g_type_register_static (G_TYPE_OBJECT, "PsppireDataStore",
126 &data_store_info, 0);
128 g_type_add_interface_static (data_store_type,
132 g_type_add_interface_static (data_store_type,
136 g_type_add_interface_static (data_store_type,
141 return data_store_type;
146 psppire_data_store_class_init (PsppireDataStoreClass *class)
148 GObjectClass *object_class;
150 parent_class = g_type_class_peek_parent (class);
151 object_class = (GObjectClass*) class;
153 object_class->finalize = psppire_data_store_finalize;
155 signal[FONT_CHANGED] =
156 g_signal_new ("font_changed",
157 G_TYPE_FROM_CLASS(class),
161 g_cclosure_marshal_VOID__VOID,
169 psppire_data_store_get_var_count (const GSheetModel *model)
171 const PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
173 return psppire_dict_get_var_cnt(store->dict);
177 psppire_data_store_get_case_count (const GSheetModel *model)
179 const PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
181 return psppire_case_file_get_case_count(store->case_file);
186 psppire_data_store_init (PsppireDataStore *data_store)
188 data_store->dict = 0;
189 data_store->case_file = 0;
190 data_store->width_of_m = 10;
193 const PangoFontDescription *
194 psppire_data_store_get_font_desc(const GSheetModel *model,
195 gint row, gint column)
197 PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
199 return store->font_desc;
204 psppire_data_store_sheet_model_init (GSheetModelIface *iface)
206 iface->free_strings = TRUE;
207 iface->get_string = psppire_data_store_get_string;
208 iface->set_string = psppire_data_store_set_string;
209 iface->clear_datum = psppire_data_store_clear_datum;
210 iface->is_editable = NULL;
211 iface->is_visible = NULL;
212 iface->get_foreground = NULL;
213 iface->get_background = NULL;
214 iface->get_font_desc = psppire_data_store_get_font_desc;
215 iface->get_cell_border = NULL;
216 iface->get_column_count = psppire_data_store_get_var_count;
217 iface->get_row_count = psppire_data_store_get_case_count;
221 gboolean always_true()
228 delete_cases_callback(GtkWidget *w, gint first, gint n_cases, gpointer data)
230 PsppireDataStore *store ;
232 g_return_if_fail (data);
234 store = PSPPIRE_DATA_STORE(data);
236 g_assert(first >= 0);
238 g_sheet_model_rows_deleted (G_SHEET_MODEL(store), first, n_cases);
243 insert_case_callback(GtkWidget *w, gint casenum, gpointer data)
245 PsppireDataStore *store ;
247 g_return_if_fail (data);
249 store = PSPPIRE_DATA_STORE(data);
251 g_sheet_model_range_changed (G_SHEET_MODEL(store),
253 psppire_case_file_get_case_count(store->case_file),
256 g_sheet_model_rows_inserted (G_SHEET_MODEL(store), casenum, 1);
261 changed_case_callback(GtkWidget *w, gint casenum, gpointer data)
263 PsppireDataStore *store ;
264 g_return_if_fail (data);
266 store = PSPPIRE_DATA_STORE(data);
268 g_sheet_model_range_changed (G_SHEET_MODEL(store),
275 delete_variables_callback(GObject *obj, gint var_num, gint n_vars, gpointer data)
277 PsppireDataStore *store ;
279 g_return_if_fail (data);
281 store = PSPPIRE_DATA_STORE(data);
283 g_sheet_model_columns_deleted (G_SHEET_MODEL(store), var_num, n_vars);
285 g_sheet_column_columns_changed(G_SHEET_COLUMN(store),
290 insert_variable_callback(GObject *obj, gint var_num, gpointer data)
292 PsppireDataStore *store;
295 g_return_if_fail (data);
297 store = PSPPIRE_DATA_STORE(data);
301 struct PsppireVariable *variable;
302 variable = psppire_dict_get_variable(store->dict, var_num);
304 posn = psppire_variable_get_fv(variable);
311 psppire_case_file_insert_values(store->case_file, 1, posn);
313 g_sheet_column_columns_changed(G_SHEET_COLUMN(store),
316 g_sheet_model_columns_inserted (G_SHEET_MODEL(store), var_num, 1);
321 dict_size_change_callback(GObject *obj,
322 gint posn, gint adjustment, gpointer data)
324 PsppireDataStore *store ;
326 g_return_if_fail (data);
328 store = PSPPIRE_DATA_STORE(data);
330 psppire_case_file_insert_values (store->case_file, adjustment, posn);
336 * psppire_data_store_new:
337 * @dict: The dictionary for this data_store.
340 * Return value: a new #PsppireDataStore
343 psppire_data_store_new (PsppireDict *dict)
345 PsppireDataStore *retval;
347 retval = g_object_new (GTK_TYPE_DATA_STORE, NULL);
349 psppire_data_store_set_dictionary(retval, dict);
358 * psppire_data_store_replace_set_dictionary:
359 * @data_store: The variable store
360 * @dict: The dictionary to set
362 * If a dictionary is already associated with the data-store, then it will be
366 psppire_data_store_set_dictionary(PsppireDataStore *data_store, PsppireDict *dict)
368 gint var_cnt = psppire_dict_get_next_value_idx(dict);
370 if ( data_store->dict ) g_object_unref(data_store->dict);
373 data_store->dict = dict;
375 if ( data_store->case_file)
377 g_object_unref(data_store->case_file);
378 data_store->case_file = 0;
381 data_store->case_file = psppire_case_file_new(var_cnt);
383 g_signal_connect(data_store->case_file, "cases-deleted",
384 G_CALLBACK(delete_cases_callback),
387 g_signal_connect(data_store->case_file, "case-inserted",
388 G_CALLBACK(insert_case_callback),
392 g_signal_connect(data_store->case_file, "case-changed",
393 G_CALLBACK(changed_case_callback),
396 g_signal_connect(dict, "variable-inserted",
397 G_CALLBACK(insert_variable_callback),
400 g_signal_connect(dict, "variables-deleted",
401 G_CALLBACK(delete_variables_callback),
404 g_signal_connect (dict, "dict-size-changed",
405 G_CALLBACK(dict_size_change_callback),
408 /* The entire model has changed */
409 g_sheet_model_range_changed (G_SHEET_MODEL(data_store), -1, -1, -1, -1);
411 g_sheet_column_columns_changed(G_SHEET_COLUMN(data_store), 0, -1);
415 psppire_data_store_finalize (GObject *object)
419 (* parent_class->finalize) (object);
424 /* Insert a blank case before POSN */
426 psppire_data_store_insert_new_case(PsppireDataStore *ds, gint posn)
431 g_return_val_if_fail (ds, FALSE);
434 /* Opportunity for optimisation exists here when creating a blank case */
435 val_cnt = casefile_get_value_cnt(ds->case_file->flexifile) ;
437 case_create (&cc, val_cnt);
439 memset ( case_data_rw (&cc, 0), 0, val_cnt * MAX_SHORT_STRING);
441 for (v = 0 ; v < psppire_dict_get_var_cnt (ds->dict) ; ++v)
443 const struct PsppireVariable *pv = psppire_dict_get_variable(ds->dict, v);
444 if (ALPHA == psppire_variable_get_type(pv) )
447 case_data_rw (&cc, psppire_variable_get_fv (pv))->f = SYSMIS;
450 result = psppire_case_file_insert_case (ds->case_file, &cc, posn);
459 psppire_data_store_get_string (const GSheetModel *model, gint row, gint column)
463 const struct fmt_spec *fp ;
464 const struct PsppireVariable *pv ;
465 const union value *v ;
467 PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
469 g_return_val_if_fail (store->dict, NULL);
470 g_return_val_if_fail (store->case_file, NULL);
472 if (column >= psppire_dict_get_var_cnt (store->dict))
475 if ( row >= psppire_case_file_get_case_count (store->case_file))
478 pv = psppire_dict_get_variable (store->dict, column);
480 idx = psppire_variable_get_fv (pv);
482 v = psppire_case_file_get_value (store->case_file, row, idx);
484 g_return_val_if_fail(v, NULL);
486 if ( store->show_labels)
488 const struct val_labs * vl = psppire_variable_get_value_labels (pv);
491 if ( (label = val_labs_find(vl, *v)) )
493 return pspp_locale_to_utf8(label, -1, 0);
497 fp = psppire_variable_get_write_spec (pv);
499 s = g_string_sized_new (fp->w + 1);
500 g_string_set_size (s, fp->w);
502 memset (s->str, 0, fp->w);
504 g_assert (fp->w == s->len);
506 /* Converts binary value V into printable form in the exactly
507 FP->W character in buffer S according to format specification
508 FP. No null terminator is appended to the buffer. */
509 data_out (s->str, fp, v);
511 text = pspp_locale_to_utf8 (s->str, fp->w, 0);
512 g_string_free (s, TRUE);
521 psppire_data_store_clear_datum (GSheetModel *model,
525 PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
528 const struct PsppireVariable *pv = psppire_dict_get_variable(store->dict, col);
530 const gint index = psppire_variable_get_fv(pv) ;
532 if ( psppire_variable_get_type(pv) == NUMERIC)
535 memcpy(v.s, "", MAX_SHORT_STRING);
537 psppire_case_file_set_value(store->case_file, row, index, &v,
538 psppire_variable_get_width(pv));
543 /* Attempts to update that part of the variable store which corresponds
544 to ROW, COL with the value TEXT.
545 Returns true if anything was updated, false otherwise.
548 psppire_data_store_set_string(GSheetModel *model,
549 const gchar *text, gint row, gint col)
551 PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
553 const struct PsppireVariable *pv = psppire_dict_get_variable(store->dict, col);
554 g_return_val_if_fail(pv, FALSE);
557 /* Allow the user to insert a lot of blank cases, simply by skipping rows */
558 for(r = psppire_case_file_get_case_count(store->case_file); r <= row ; ++r)
563 psppire_case_array_insert_case(store->cases, r, 0, 0);
566 for (c = 0 ; c < psppire_dict_get_var_cnt(store->dict); ++c )
567 psppire_data_store_clear_datum(model, r, c);
572 const gint index = psppire_variable_get_fv(pv);
576 d_in.e = text + strlen(text);
578 d_in.f1 = d_in.f2 = 0;
579 d_in.format = * psppire_variable_get_write_spec(pv);
582 psppire_case_file_data_in(store->case_file, row, index, &d_in) ;
590 psppire_data_store_set_font(PsppireDataStore *store,
591 const PangoFontDescription *fd)
593 g_return_if_fail (store);
594 g_return_if_fail (PSPPIRE_IS_DATA_STORE (store));
596 store->font_desc = fd;
598 store->width_of_m = calc_m_width(fd);
600 g_signal_emit(store, signal[FONT_CHANGED], 0);
603 g_sheet_model_range_changed (G_SHEET_MODEL(store),
609 psppire_data_store_show_labels(PsppireDataStore *store, gboolean show_labels)
611 g_return_if_fail (store);
612 g_return_if_fail (PSPPIRE_IS_DATA_STORE (store));
614 store->show_labels = show_labels;
616 g_sheet_model_range_changed (G_SHEET_MODEL(store),
622 /* FIXME: There's no reason to actually have this function.
623 It should be done by a procedure */
625 psppire_data_store_create_system_file(PsppireDataStore *store,
626 struct file_handle *handle)
629 const struct sfm_write_options wo = {
630 true, /* writeable */
631 false, /* dont compress */
635 struct sfm_writer *writer ;
639 writer = sfm_open_writer(handle, store->dict->dict, wo);
645 var_cnt = psppire_data_store_get_var_count (G_SHEET_MODEL(store));
647 for (i = 0 ; i < psppire_case_file_get_case_count(store->case_file); ++i )
651 case_create (&c, var_cnt);
652 psppire_case_file_get_case (store->case_file, i, &c);
653 sfm_write_case (writer, &c);
658 sfm_close_writer(writer);
664 psppire_data_store_clear(PsppireDataStore *data_store)
666 psppire_case_file_clear(data_store->case_file);
668 psppire_dict_clear(data_store->dict);
674 /* Column related funcs */
677 geometry_get_column_count(const GSheetColumn *geom)
679 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
681 return MAX(MIN_COLUMNS, psppire_dict_get_var_cnt(ds->dict));
687 geometry_get_width(const GSheetColumn *geom, gint unit)
689 const struct PsppireVariable *pv ;
690 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
692 if ( unit >= psppire_dict_get_var_cnt(ds->dict) )
693 return ds->width_of_m * 8 ;
695 pv = psppire_dict_get_variable(ds->dict, unit);
698 return ds->width_of_m * 8 ;
700 return ds->width_of_m * psppire_variable_get_columns(pv);
704 geometry_set_width(GSheetColumn *geom, gint unit, gint width)
706 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
708 struct PsppireVariable *pv = psppire_dict_get_variable(ds->dict, unit);
710 psppire_variable_set_columns(pv, width / ds->width_of_m );
715 static GtkJustification
716 geometry_get_justification(const GSheetColumn *geom, gint unit)
718 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
719 const struct PsppireVariable *pv ;
722 if ( unit >= psppire_dict_get_var_cnt(ds->dict) )
723 return GTK_JUSTIFY_LEFT;
725 pv = psppire_dict_get_variable(ds->dict, unit);
727 /* Kludge: Happily GtkJustification is defined similarly
728 to enum alignment from pspp/variable.h */
729 return psppire_variable_get_alignment(pv);
733 static const gchar null_var_name[]=N_("var");
736 geometry_get_column_button_label(const GSheetColumn *geom, gint unit)
739 struct PsppireVariable *pv ;
740 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
742 if ( unit >= psppire_dict_get_var_cnt(ds->dict) )
743 return g_locale_to_utf8(null_var_name, -1, 0, 0, 0);
745 pv = psppire_dict_get_variable(ds->dict, unit);
747 text = pspp_locale_to_utf8(psppire_variable_get_name(pv), -1, 0);
754 geometry_get_sensitivity(const GSheetColumn *geom, gint unit)
756 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
758 return (unit < psppire_dict_get_var_cnt(ds->dict));
763 psppire_data_store_sheet_column_init (GSheetColumnIface *iface)
765 iface->get_column_count = geometry_get_column_count;
766 iface->get_width = geometry_get_width;
767 iface->set_width = geometry_set_width;
768 iface->get_visibility = always_true;
769 iface->get_sensitivity = geometry_get_sensitivity;
770 iface->get_justification = geometry_get_justification;
771 iface->get_button_label = geometry_get_column_button_label;
775 /* Row related funcs */
778 geometry_get_row_count(const GSheetRow *geom, gpointer data)
780 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
782 return TRAILING_ROWS + psppire_case_file_get_case_count(ds->case_file);
787 geometry_get_height(const GSheetRow *geom, gint unit, gpointer data)
794 geometry_get_row_sensitivity(const GSheetRow *geom, gint unit, gpointer data)
796 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
799 return (unit < psppire_case_file_get_case_count(ds->case_file));
804 geometry_get_row_button_label(const GSheetRow *geom, gint unit, gpointer data)
808 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
811 TRAILING_ROWS + psppire_case_file_get_case_count(ds->case_file))
814 s = g_strdup_printf(_("%d"), unit);
816 text = pspp_locale_to_utf8(s, -1, 0);
825 psppire_data_store_sheet_row_init (GSheetRowIface *iface)
827 iface->get_row_count = geometry_get_row_count;
829 iface->get_height = geometry_get_height;
830 iface->set_height = 0;
831 iface->get_visibility = always_true;
832 iface->get_sensitivity = geometry_get_row_sensitivity;
834 iface->get_button_label = geometry_get_row_button_label;