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);
331 if ( adjustment > 0 )
333 psppire_case_file_insert_values (store->case_file, adjustment, posn);
339 * psppire_data_store_new:
340 * @dict: The dictionary for this data_store.
343 * Return value: a new #PsppireDataStore
346 psppire_data_store_new (PsppireDict *dict)
348 PsppireDataStore *retval;
350 retval = g_object_new (GTK_TYPE_DATA_STORE, NULL);
352 psppire_data_store_set_dictionary(retval, dict);
361 * psppire_data_store_replace_set_dictionary:
362 * @data_store: The variable store
363 * @dict: The dictionary to set
365 * If a dictionary is already associated with the data-store, then it will be
369 psppire_data_store_set_dictionary(PsppireDataStore *data_store, PsppireDict *dict)
371 gint var_cnt = psppire_dict_get_next_value_idx(dict);
373 if ( data_store->dict ) g_object_unref(data_store->dict);
376 data_store->dict = dict;
378 if ( data_store->case_file)
380 g_object_unref(data_store->case_file);
381 data_store->case_file = 0;
384 data_store->case_file = psppire_case_file_new(var_cnt);
386 g_signal_connect(data_store->case_file, "cases-deleted",
387 G_CALLBACK(delete_cases_callback),
390 g_signal_connect(data_store->case_file, "case-inserted",
391 G_CALLBACK(insert_case_callback),
395 g_signal_connect(data_store->case_file, "case-changed",
396 G_CALLBACK(changed_case_callback),
399 g_signal_connect(dict, "variable-inserted",
400 G_CALLBACK(insert_variable_callback),
403 g_signal_connect(dict, "variables-deleted",
404 G_CALLBACK(delete_variables_callback),
407 g_signal_connect (dict, "dict-size-changed",
408 G_CALLBACK(dict_size_change_callback),
411 /* The entire model has changed */
412 g_sheet_model_range_changed (G_SHEET_MODEL(data_store), -1, -1, -1, -1);
414 g_sheet_column_columns_changed(G_SHEET_COLUMN(data_store), 0, -1);
418 psppire_data_store_finalize (GObject *object)
422 (* parent_class->finalize) (object);
427 psppire_data_store_get_string(const GSheetModel *model, gint row, gint column)
431 const struct fmt_spec *fp ;
432 const struct PsppireVariable *pv ;
433 const union value *v ;
435 PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
437 g_return_val_if_fail(store->dict, NULL);
438 g_return_val_if_fail(store->case_file, NULL);
440 if (column >= psppire_dict_get_var_cnt(store->dict))
443 if ( row >= psppire_case_file_get_case_count(store->case_file))
446 pv = psppire_dict_get_variable(store->dict, column);
448 idx = psppire_variable_get_fv(pv);
450 v = psppire_case_file_get_value(store->case_file, row, idx);
452 g_return_val_if_fail(v, NULL);
454 if ( store->show_labels)
456 const struct val_labs * vl = psppire_variable_get_value_labels(pv);
459 if ( (label = val_labs_find(vl, *v)) )
461 return pspp_locale_to_utf8(label, -1, 0);
465 fp = psppire_variable_get_write_spec(pv);
467 s = g_string_sized_new (fp->w + 1);
468 g_string_set_size(s, fp->w);
470 memset(s->str, 0, fp->w);
472 g_assert(fp->w == s->len);
474 /* Converts binary value V into printable form in the exactly
475 FP->W character in buffer S according to format specification
476 FP. No null terminator is appended to the buffer. */
477 data_out (s->str, fp, v);
479 text = pspp_locale_to_utf8(s->str, fp->w, 0);
480 g_string_free(s, TRUE);
487 psppire_data_store_clear_datum(GSheetModel *model,
491 PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
494 const struct PsppireVariable *pv = psppire_dict_get_variable(store->dict, col);
496 const gint index = psppire_variable_get_fv(pv) ;
498 if ( psppire_variable_get_type(pv) == NUMERIC)
501 memcpy(v.s, "", MAX_SHORT_STRING);
503 psppire_case_file_set_value(store->case_file, row, index, &v,
504 psppire_variable_get_width(pv));
509 /* Attempts to update that part of the variable store which corresponds
510 to ROW, COL with the value TEXT.
511 Returns true if anything was updated, false otherwise.
514 psppire_data_store_set_string(GSheetModel *model,
515 const gchar *text, gint row, gint col)
517 PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
519 const struct PsppireVariable *pv = psppire_dict_get_variable(store->dict, col);
520 g_return_val_if_fail(pv, FALSE);
523 /* Allow the user to insert a lot of blank cases, simply by skipping rows */
524 for(r = psppire_case_file_get_case_count(store->case_file); r <= row ; ++r)
529 psppire_case_array_insert_case(store->cases, r, 0, 0);
532 for (c = 0 ; c < psppire_dict_get_var_cnt(store->dict); ++c )
533 psppire_data_store_clear_datum(model, r, c);
538 const gint index = psppire_variable_get_fv(pv);
542 d_in.e = text + strlen(text);
544 d_in.f1 = d_in.f2 = 0;
545 d_in.format = * psppire_variable_get_write_spec(pv);
548 psppire_case_file_data_in(store->case_file, row, index, &d_in) ;
556 psppire_data_store_set_font(PsppireDataStore *store,
557 const PangoFontDescription *fd)
559 g_return_if_fail (store);
560 g_return_if_fail (PSPPIRE_IS_DATA_STORE (store));
562 store->font_desc = fd;
564 store->width_of_m = calc_m_width(fd);
566 g_signal_emit(store, signal[FONT_CHANGED], 0);
569 g_sheet_model_range_changed (G_SHEET_MODEL(store),
575 psppire_data_store_show_labels(PsppireDataStore *store, gboolean show_labels)
577 g_return_if_fail (store);
578 g_return_if_fail (PSPPIRE_IS_DATA_STORE (store));
580 store->show_labels = show_labels;
582 g_sheet_model_range_changed (G_SHEET_MODEL(store),
588 /* FIXME: There's no reason to actually have this function.
589 It should be done by a procedure */
591 psppire_data_store_create_system_file(PsppireDataStore *store,
592 struct file_handle *handle)
595 const struct sfm_write_options wo = {
596 true, /* writeable */
597 false, /* dont compress */
601 struct sfm_writer *writer ;
605 writer = sfm_open_writer(handle, store->dict->dict, wo);
611 var_cnt = psppire_data_store_get_var_count (G_SHEET_MODEL(store));
613 for (i = 0 ; i < psppire_case_file_get_case_count(store->case_file); ++i )
617 case_create (&c, var_cnt);
618 psppire_case_file_get_case (store->case_file, i, &c);
619 sfm_write_case (writer, &c);
624 sfm_close_writer(writer);
630 psppire_data_store_clear(PsppireDataStore *data_store)
632 psppire_case_file_clear(data_store->case_file);
634 psppire_dict_clear(data_store->dict);
640 /* Column related funcs */
643 geometry_get_column_count(const GSheetColumn *geom)
645 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
647 return MAX(MIN_COLUMNS, psppire_dict_get_var_cnt(ds->dict));
653 geometry_get_width(const GSheetColumn *geom, gint unit)
655 const struct PsppireVariable *pv ;
656 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
658 if ( unit >= psppire_dict_get_var_cnt(ds->dict) )
659 return ds->width_of_m * 8 ;
661 pv = psppire_dict_get_variable(ds->dict, unit);
664 return ds->width_of_m * 8 ;
666 return ds->width_of_m * psppire_variable_get_columns(pv);
670 geometry_set_width(GSheetColumn *geom, gint unit, gint width)
672 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
674 struct PsppireVariable *pv = psppire_dict_get_variable(ds->dict, unit);
676 psppire_variable_set_columns(pv, width / ds->width_of_m );
681 static GtkJustification
682 geometry_get_justification(const GSheetColumn *geom, gint unit)
684 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
685 const struct PsppireVariable *pv ;
688 if ( unit >= psppire_dict_get_var_cnt(ds->dict) )
689 return GTK_JUSTIFY_LEFT;
691 pv = psppire_dict_get_variable(ds->dict, unit);
693 /* Kludge: Happily GtkJustification is defined similarly
694 to enum alignment from pspp/variable.h */
695 return psppire_variable_get_alignment(pv);
699 static const gchar null_var_name[]=N_("var");
702 geometry_get_column_button_label(const GSheetColumn *geom, gint unit)
705 struct PsppireVariable *pv ;
706 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
708 if ( unit >= psppire_dict_get_var_cnt(ds->dict) )
709 return g_locale_to_utf8(null_var_name, -1, 0, 0, 0);
711 pv = psppire_dict_get_variable(ds->dict, unit);
713 text = pspp_locale_to_utf8(psppire_variable_get_name(pv), -1, 0);
720 geometry_get_sensitivity(const GSheetColumn *geom, gint unit)
722 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
724 return (unit < psppire_dict_get_var_cnt(ds->dict));
729 psppire_data_store_sheet_column_init (GSheetColumnIface *iface)
731 iface->get_column_count = geometry_get_column_count;
732 iface->get_width = geometry_get_width;
733 iface->set_width = geometry_set_width;
734 iface->get_visibility = always_true;
735 iface->get_sensitivity = geometry_get_sensitivity;
736 iface->get_justification = geometry_get_justification;
737 iface->get_button_label = geometry_get_column_button_label;
741 /* Row related funcs */
744 geometry_get_row_count(const GSheetRow *geom, gpointer data)
746 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
748 return TRAILING_ROWS + psppire_case_file_get_case_count(ds->case_file);
753 geometry_get_height(const GSheetRow *geom, gint unit, gpointer data)
760 geometry_get_row_sensitivity(const GSheetRow *geom, gint unit, gpointer data)
762 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
765 return (unit < psppire_case_file_get_case_count(ds->case_file));
770 geometry_get_row_button_label(const GSheetRow *geom, gint unit, gpointer data)
774 PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
777 TRAILING_ROWS + psppire_case_file_get_case_count(ds->case_file))
780 s = g_strdup_printf(_("%d"), unit);
782 text = pspp_locale_to_utf8(s, -1, 0);
791 psppire_data_store_sheet_row_init (GSheetRowIface *iface)
793 iface->get_row_count = geometry_get_row_count;
795 iface->get_height = geometry_get_height;
796 iface->set_height = 0;
797 iface->get_visibility = always_true;
798 iface->get_sensitivity = geometry_get_row_sensitivity;
800 iface->get_button_label = geometry_get_row_button_label;