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>
31 #include <data/data-out.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-variable.h"
40 #include "psppire-data-store.h"
41 #include "psppire-case-file.h"
44 #include <data/dictionary.h>
45 #include <data/missing-values.h>
46 #include <data/value-labels.h>
47 #include <data/data-in.h>
49 #include <data/file-handle-def.h>
50 #include <data/sys-file-writer.h>
54 static void psppire_data_store_init (PsppireDataStore *data_store);
55 static void psppire_data_store_class_init (PsppireDataStoreClass *class);
56 static void psppire_data_store_sheet_model_init (GSheetModelIface *iface);
57 static void psppire_data_store_sheet_column_init (GSheetColumnIface *iface);
58 static void psppire_data_store_sheet_row_init (GSheetRowIface *iface);
60 static void psppire_data_store_finalize (GObject *object);
62 static gchar *psppire_data_store_get_string(const GSheetModel *sheet_model, gint row, gint column);
64 static gboolean psppire_data_store_set_string(GSheetModel *model,
65 const gchar *text, gint row, gint column);
67 static gboolean psppire_data_store_clear_datum(GSheetModel *model,
68 gint row, gint column);
71 #define MIN_COLUMNS 10
73 #define TRAILING_ROWS 10
75 static GObjectClass *parent_class = NULL;
81 static guint signal[n_SIGNALS];
85 psppire_data_store_get_type (void)
87 static GType data_store_type = 0;
91 static const GTypeInfo data_store_info =
93 sizeof (PsppireDataStoreClass),
95 NULL, /* base_finalize */
96 (GClassInitFunc) psppire_data_store_class_init,
97 NULL, /* class_finalize */
98 NULL, /* class_data */
99 sizeof (PsppireDataStore),
101 (GInstanceInitFunc) psppire_data_store_init,
104 static const GInterfaceInfo sheet_model_info =
106 (GInterfaceInitFunc) psppire_data_store_sheet_model_init,
111 static const GInterfaceInfo sheet_column_info =
113 (GInterfaceInitFunc) psppire_data_store_sheet_column_init,
118 static const GInterfaceInfo sheet_row_info =
120 (GInterfaceInitFunc) psppire_data_store_sheet_row_init,
126 data_store_type = g_type_register_static (G_TYPE_OBJECT, "PsppireDataStore",
127 &data_store_info, 0);
129 g_type_add_interface_static (data_store_type,
133 g_type_add_interface_static (data_store_type,
137 g_type_add_interface_static (data_store_type,
142 return data_store_type;
147 psppire_data_store_class_init (PsppireDataStoreClass *class)
149 GObjectClass *object_class;
151 parent_class = g_type_class_peek_parent (class);
152 object_class = (GObjectClass*) class;
154 object_class->finalize = psppire_data_store_finalize;
156 signal[FONT_CHANGED] =
157 g_signal_new ("font_changed",
158 G_TYPE_FROM_CLASS(class),
162 g_cclosure_marshal_VOID__VOID,
170 psppire_data_store_get_var_count (const GSheetModel *model)
172 const PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
174 return psppire_dict_get_var_cnt(store->dict);
178 psppire_data_store_get_case_count (const GSheetModel *model)
180 const PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
182 return psppire_case_file_get_case_count(store->case_file);
187 psppire_data_store_init (PsppireDataStore *data_store)
189 data_store->dict = 0;
190 data_store->case_file = 0;
191 data_store->width_of_m = 10;
194 const PangoFontDescription *
195 psppire_data_store_get_font_desc(const GSheetModel *model,
196 gint row, gint column)
198 PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
200 return store->font_desc;
205 psppire_data_store_sheet_model_init (GSheetModelIface *iface)
207 iface->free_strings = TRUE;
208 iface->get_string = psppire_data_store_get_string;
209 iface->set_string = psppire_data_store_set_string;
210 iface->clear_datum = psppire_data_store_clear_datum;
211 iface->is_editable = NULL;
212 iface->is_visible = NULL;
213 iface->get_foreground = NULL;
214 iface->get_background = NULL;
215 iface->get_font_desc = psppire_data_store_get_font_desc;
216 iface->get_cell_border = NULL;
217 iface->get_column_count = psppire_data_store_get_var_count;
218 iface->get_row_count = psppire_data_store_get_case_count;
222 gboolean always_true()
229 delete_cases_callback(GtkWidget *w, gint first, gint n_cases, gpointer data)
231 PsppireDataStore *store ;
233 g_return_if_fail (data);
235 store = PSPPIRE_DATA_STORE(data);
237 g_assert(first >= 0);
239 g_sheet_model_rows_deleted (G_SHEET_MODEL(store), first, n_cases);
244 insert_case_callback(GtkWidget *w, gint casenum, gpointer data)
246 PsppireDataStore *store ;
248 g_return_if_fail (data);
250 store = PSPPIRE_DATA_STORE(data);
252 g_sheet_model_range_changed (G_SHEET_MODEL(store),
254 psppire_case_file_get_case_count(store->case_file),
257 g_sheet_model_rows_inserted (G_SHEET_MODEL(store), casenum, 1);
262 changed_case_callback(GtkWidget *w, gint casenum, gpointer data)
264 PsppireDataStore *store ;
265 g_return_if_fail (data);
267 store = PSPPIRE_DATA_STORE(data);
269 g_sheet_model_range_changed (G_SHEET_MODEL(store),
276 delete_variables_callback(GObject *obj, gint var_num, gint n_vars, gpointer data)
278 PsppireDataStore *store ;
280 g_return_if_fail (data);
282 store = PSPPIRE_DATA_STORE(data);
284 g_sheet_model_columns_deleted (G_SHEET_MODEL(store), var_num, n_vars);
286 g_sheet_column_columns_changed(G_SHEET_COLUMN(store),
291 insert_variable_callback(GObject *obj, gint var_num, gpointer data)
293 PsppireDataStore *store;
296 g_return_if_fail (data);
298 store = PSPPIRE_DATA_STORE(data);
302 struct PsppireVariable *variable;
303 variable = psppire_dict_get_variable(store->dict, var_num);
305 posn = psppire_variable_get_fv(variable);
312 psppire_case_file_insert_values(store->case_file, 1, posn);
314 g_sheet_column_columns_changed(G_SHEET_COLUMN(store),
317 g_sheet_model_columns_inserted (G_SHEET_MODEL(store), var_num, 1);
322 dict_size_change_callback(GObject *obj,
323 gint posn, gint adjustment, gpointer data)
325 PsppireDataStore *store ;
327 g_return_if_fail (data);
329 store = PSPPIRE_DATA_STORE(data);
331 psppire_case_file_insert_values (store->case_file, adjustment, posn);
337 * psppire_data_store_new:
338 * @dict: The dictionary for this data_store.
341 * Return value: a new #PsppireDataStore
344 psppire_data_store_new (PsppireDict *dict)
346 PsppireDataStore *retval;
348 retval = g_object_new (GTK_TYPE_DATA_STORE, NULL);
350 psppire_data_store_set_dictionary(retval, dict);
359 * psppire_data_store_replace_set_dictionary:
360 * @data_store: The variable store
361 * @dict: The dictionary to set
363 * If a dictionary is already associated with the data-store, then it will be
367 psppire_data_store_set_dictionary(PsppireDataStore *data_store, PsppireDict *dict)
369 gint var_cnt = psppire_dict_get_next_value_idx(dict);
371 if ( data_store->dict ) g_object_unref(data_store->dict);
374 data_store->dict = dict;
376 if ( data_store->case_file)
378 g_object_unref(data_store->case_file);
379 data_store->case_file = 0;
382 data_store->case_file = psppire_case_file_new(var_cnt);
384 g_signal_connect(data_store->case_file, "cases-deleted",
385 G_CALLBACK(delete_cases_callback),
388 g_signal_connect(data_store->case_file, "case-inserted",
389 G_CALLBACK(insert_case_callback),
393 g_signal_connect(data_store->case_file, "case-changed",
394 G_CALLBACK(changed_case_callback),
397 g_signal_connect(dict, "variable-inserted",
398 G_CALLBACK(insert_variable_callback),
401 g_signal_connect(dict, "variables-deleted",
402 G_CALLBACK(delete_variables_callback),
405 g_signal_connect (dict, "dict-size-changed",
406 G_CALLBACK(dict_size_change_callback),
409 /* The entire model has changed */
410 g_sheet_model_range_changed (G_SHEET_MODEL(data_store), -1, -1, -1, -1);
412 g_sheet_column_columns_changed(G_SHEET_COLUMN(data_store), 0, -1);
416 psppire_data_store_finalize (GObject *object)
420 (* parent_class->finalize) (object);
425 /* Insert a blank case before POSN */
427 psppire_data_store_insert_new_case(PsppireDataStore *ds, gint posn)
432 g_return_val_if_fail (ds, FALSE);
435 /* Opportunity for optimisation exists here when creating a blank case */
436 val_cnt = casefile_get_value_cnt(ds->case_file->flexifile) ;
438 case_create (&cc, val_cnt);
440 memset ( case_data_rw (&cc, 0), 0, val_cnt * MAX_SHORT_STRING);
442 for (v = 0 ; v < psppire_dict_get_var_cnt (ds->dict) ; ++v)
444 const struct PsppireVariable *pv = psppire_dict_get_variable(ds->dict, v);
445 if (ALPHA == psppire_variable_get_type(pv) )
448 case_data_rw (&cc, psppire_variable_get_fv (pv))->f = SYSMIS;
451 result = psppire_case_file_insert_case (ds->case_file, &cc, posn);
460 psppire_data_store_get_string (const GSheetModel *model, gint row, gint column)
464 const struct fmt_spec *fp ;
465 const struct PsppireVariable *pv ;
466 const union value *v ;
468 PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
470 g_return_val_if_fail (store->dict, NULL);
471 g_return_val_if_fail (store->case_file, NULL);
473 if (column >= psppire_dict_get_var_cnt (store->dict))
476 if ( row >= psppire_case_file_get_case_count (store->case_file))
479 pv = psppire_dict_get_variable (store->dict, column);
481 idx = psppire_variable_get_fv (pv);
483 v = psppire_case_file_get_value (store->case_file, row, idx);
485 g_return_val_if_fail(v, NULL);
487 if ( store->show_labels)
489 const struct val_labs * vl = psppire_variable_get_value_labels (pv);
492 if ( (label = val_labs_find(vl, *v)) )
494 return pspp_locale_to_utf8(label, -1, 0);
498 fp = psppire_variable_get_write_spec (pv);
500 s = g_string_sized_new (fp->w + 1);
501 g_string_set_size (s, fp->w);
503 memset (s->str, 0, fp->w);
505 g_assert (fp->w == s->len);
507 /* Converts binary value V into printable form in the exactly
508 FP->W character in buffer S according to format specification
509 FP. No null terminator is appended to the buffer. */
510 data_out (v, fp, s->str);
512 text = pspp_locale_to_utf8 (s->str, fp->w, 0);
513 g_string_free (s, TRUE);
522 psppire_data_store_clear_datum (GSheetModel *model,
526 PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
529 const struct PsppireVariable *pv = psppire_dict_get_variable(store->dict, col);
531 const gint index = psppire_variable_get_fv(pv) ;
533 if ( psppire_variable_get_type(pv) == NUMERIC)
536 memcpy(v.s, "", MAX_SHORT_STRING);
538 psppire_case_file_set_value(store->case_file, row, index, &v,
539 psppire_variable_get_width(pv));
544 /* Attempts to update that part of the variable store which corresponds
545 to ROW, COL with the value TEXT.
546 Returns true if anything was updated, false otherwise.
549 psppire_data_store_set_string(GSheetModel *model,
550 const gchar *text, gint row, gint col)
552 PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
554 const struct PsppireVariable *pv = psppire_dict_get_variable(store->dict, col);
555 g_return_val_if_fail(pv, FALSE);
558 /* Allow the user to insert a lot of blank cases, simply by skipping rows */
559 for(r = psppire_case_file_get_case_count(store->case_file); r <= row ; ++r)
564 psppire_case_array_insert_case(store->cases, r, 0, 0);
567 for (c = 0 ; c < psppire_dict_get_var_cnt(store->dict); ++c )
568 psppire_data_store_clear_datum(model, r, c);
573 const gint index = psppire_variable_get_fv(pv);
577 d_in.e = text + strlen(text);
579 d_in.f1 = d_in.f2 = 0;
580 d_in.format = * psppire_variable_get_write_spec(pv);
583 psppire_case_file_data_in(store->case_file, row, index, &d_in) ;
591 psppire_data_store_set_font(PsppireDataStore *store,
592 const PangoFontDescription *fd)
594 g_return_if_fail (store);
595 g_return_if_fail (PSPPIRE_IS_DATA_STORE (store));
597 store->font_desc = fd;
599 store->width_of_m = calc_m_width(fd);
601 g_signal_emit(store, signal[FONT_CHANGED], 0);
604 g_sheet_model_range_changed (G_SHEET_MODEL(store),
610 psppire_data_store_show_labels(PsppireDataStore *store, gboolean show_labels)
612 g_return_if_fail (store);
613 g_return_if_fail (PSPPIRE_IS_DATA_STORE (store));
615 store->show_labels = show_labels;
617 g_sheet_model_range_changed (G_SHEET_MODEL(store),
623 /* FIXME: There's no reason to actually have this function.
624 It should be done by a procedure */
626 psppire_data_store_create_system_file(PsppireDataStore *store,
627 struct file_handle *handle)
630 const struct sfm_write_options wo = {
631 true, /* writeable */
632 false, /* dont compress */
636 struct sfm_writer *writer ;
640 writer = sfm_open_writer(handle, store->dict->dict, wo);
646 var_cnt = psppire_data_store_get_var_count (G_SHEET_MODEL(store));
648 for (i = 0 ; i < psppire_case_file_get_case_count(store->case_file); ++i )
652 case_create (&c, var_cnt);
653 psppire_case_file_get_case (store->case_file, i, &c);
654 sfm_write_case (writer, &c);
659 sfm_close_writer(writer);
665 psppire_data_store_clear(PsppireDataStore *data_store)
667 psppire_case_file_clear(data_store->case_file);
669 psppire_dict_clear(data_store->dict);
675 /* Column related funcs */
678 geometry_get_column_count(const GSheetColumn *geom)
680 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
682 return MAX(MIN_COLUMNS, psppire_dict_get_var_cnt(ds->dict));
688 geometry_get_width(const GSheetColumn *geom, gint unit)
690 const struct PsppireVariable *pv ;
691 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
693 if ( unit >= psppire_dict_get_var_cnt(ds->dict) )
694 return ds->width_of_m * 8 ;
696 pv = psppire_dict_get_variable(ds->dict, unit);
699 return ds->width_of_m * 8 ;
701 return ds->width_of_m * psppire_variable_get_columns(pv);
705 geometry_set_width(GSheetColumn *geom, gint unit, gint width)
707 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
709 struct PsppireVariable *pv = psppire_dict_get_variable(ds->dict, unit);
711 psppire_variable_set_columns(pv, width / ds->width_of_m );
716 static GtkJustification
717 geometry_get_justification(const GSheetColumn *geom, gint unit)
719 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
720 const struct PsppireVariable *pv ;
723 if ( unit >= psppire_dict_get_var_cnt(ds->dict) )
724 return GTK_JUSTIFY_LEFT;
726 pv = psppire_dict_get_variable(ds->dict, unit);
728 /* Kludge: Happily GtkJustification is defined similarly
729 to enum alignment from pspp/variable.h */
730 return psppire_variable_get_alignment(pv);
734 static const gchar null_var_name[]=N_("var");
737 geometry_get_column_button_label(const GSheetColumn *geom, gint unit)
740 struct PsppireVariable *pv ;
741 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
743 if ( unit >= psppire_dict_get_var_cnt(ds->dict) )
744 return g_locale_to_utf8(null_var_name, -1, 0, 0, 0);
746 pv = psppire_dict_get_variable(ds->dict, unit);
748 text = pspp_locale_to_utf8(psppire_variable_get_name(pv), -1, 0);
755 geometry_get_sensitivity(const GSheetColumn *geom, gint unit)
757 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
759 return (unit < psppire_dict_get_var_cnt(ds->dict));
764 psppire_data_store_sheet_column_init (GSheetColumnIface *iface)
766 iface->get_column_count = geometry_get_column_count;
767 iface->get_width = geometry_get_width;
768 iface->set_width = geometry_set_width;
769 iface->get_visibility = always_true;
770 iface->get_sensitivity = geometry_get_sensitivity;
771 iface->get_justification = geometry_get_justification;
772 iface->get_button_label = geometry_get_column_button_label;
776 /* Row related funcs */
779 geometry_get_row_count(const GSheetRow *geom, gpointer data)
781 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
783 return TRAILING_ROWS + psppire_case_file_get_case_count(ds->case_file);
788 geometry_get_height(const GSheetRow *geom, gint unit, gpointer data)
795 geometry_get_row_sensitivity(const GSheetRow *geom, gint unit, gpointer data)
797 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
800 return (unit < psppire_case_file_get_case_count(ds->case_file));
805 geometry_get_row_button_label(const GSheetRow *geom, gint unit, gpointer data)
809 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
812 TRAILING_ROWS + psppire_case_file_get_case_count(ds->case_file))
815 s = g_strdup_printf(_("%d"), unit);
817 text = pspp_locale_to_utf8(s, -1, 0);
826 psppire_data_store_sheet_row_init (GSheetRowIface *iface)
828 iface->get_row_count = geometry_get_row_count;
830 iface->get_height = geometry_get_height;
831 iface->set_height = 0;
832 iface->get_visibility = always_true;
833 iface->get_sensitivity = geometry_get_row_sensitivity;
835 iface->get_button_label = geometry_get_row_button_label;