Re-enabled saving of the current file.
[pspp-builds.git] / src / ui / gui / psppire-data-store.c
1 /* psppire-data-store.c
2  
3    PSPPIRE --- A Graphical User Interface for PSPP
4    Copyright (C) 2006  Free Software Foundation
5    Written by John Darrington
6
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.
11
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.
16
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
20    02110-1301, USA. */
21
22 #include <config.h>
23 #include <string.h>
24 #include <stdlib.h>
25 #include <gettext.h>
26 #define _(msgid) gettext(msgid)
27 #define N_(msgid) msgid
28
29 #include <data/casefile.h>
30 #include <data/case.h>
31
32 #include <gtksheet/gtksheet.h>
33 #include <gtksheet/gsheetmodel.h>
34 #include <gtksheet/gsheet-column-iface.h>
35
36 #include <pango/pango-context.h>
37
38 #include "psppire-variable.h"
39 #include "psppire-data-store.h"
40 #include "psppire-case-file.h"
41 #include "helper.h"
42
43 #include <data/dictionary.h>
44 #include <data/missing-values.h>
45 #include <data/value-labels.h>
46 #include <data/data-in.h>
47
48 #include <data/file-handle-def.h>
49 #include <data/sys-file-writer.h>
50
51
52
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);
58
59 static void psppire_data_store_finalize        (GObject           *object);
60
61 static gchar *psppire_data_store_get_string(const GSheetModel *sheet_model, gint row, gint column);
62
63 static gboolean psppire_data_store_set_string(GSheetModel *model, 
64                                           const gchar *text, gint row, gint column);
65
66 static gboolean psppire_data_store_clear_datum(GSheetModel *model, 
67                                           gint row, gint column);
68
69
70 #define MIN_COLUMNS 10
71
72 #define TRAILING_ROWS 10
73
74 static GObjectClass *parent_class = NULL;
75
76
77 enum  {FONT_CHANGED,
78        n_SIGNALS};
79
80 static guint signal[n_SIGNALS];
81
82
83 inline GType
84 psppire_data_store_get_type (void)
85 {
86   static GType data_store_type = 0;
87
88   if (!data_store_type)
89     {
90       static const GTypeInfo data_store_info =
91       {
92         sizeof (PsppireDataStoreClass),
93         NULL,           /* base_init */
94         NULL,           /* base_finalize */
95         (GClassInitFunc) psppire_data_store_class_init,
96         NULL,           /* class_finalize */
97         NULL,           /* class_data */
98         sizeof (PsppireDataStore),
99         0,
100         (GInstanceInitFunc) psppire_data_store_init,
101       };
102
103       static const GInterfaceInfo sheet_model_info =
104       {
105         (GInterfaceInitFunc) psppire_data_store_sheet_model_init,
106         NULL,
107         NULL
108       };
109
110       static const GInterfaceInfo sheet_column_info =
111       {
112         (GInterfaceInitFunc) psppire_data_store_sheet_column_init,
113         NULL,
114         NULL
115       };
116
117       static const GInterfaceInfo sheet_row_info =
118       {
119         (GInterfaceInitFunc) psppire_data_store_sheet_row_init,
120         NULL,
121         NULL
122       };
123
124
125       data_store_type = g_type_register_static (G_TYPE_OBJECT, "PsppireDataStore",
126                                                 &data_store_info, 0);
127
128       g_type_add_interface_static (data_store_type,
129                                    G_TYPE_SHEET_MODEL,
130                                    &sheet_model_info);
131
132       g_type_add_interface_static (data_store_type,
133                                    G_TYPE_SHEET_COLUMN,
134                                    &sheet_column_info);
135
136       g_type_add_interface_static (data_store_type,
137                                    G_TYPE_SHEET_ROW,
138                                    &sheet_row_info);
139     }
140
141   return data_store_type;
142 }
143
144
145 static void
146 psppire_data_store_class_init (PsppireDataStoreClass *class)
147 {
148   GObjectClass *object_class;
149
150   parent_class = g_type_class_peek_parent (class);
151   object_class = (GObjectClass*) class;
152
153   object_class->finalize = psppire_data_store_finalize;
154
155   signal[FONT_CHANGED] =
156     g_signal_new ("font_changed",
157                   G_TYPE_FROM_CLASS(class),
158                   G_SIGNAL_RUN_FIRST,
159                   0,
160                   NULL, NULL,
161                   g_cclosure_marshal_VOID__VOID,
162                   G_TYPE_NONE, 
163                   0);
164 }
165
166
167
168 static gint
169 psppire_data_store_get_var_count (const GSheetModel *model)
170 {
171   const PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
172   
173   return psppire_dict_get_var_cnt(store->dict);
174 }
175
176 static gint
177 psppire_data_store_get_case_count (const GSheetModel *model)
178 {
179   const PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
180
181   return psppire_case_file_get_case_count(store->case_file);
182 }
183
184
185 static void
186 psppire_data_store_init (PsppireDataStore *data_store)
187 {
188   data_store->dict = 0;
189   data_store->case_file = 0;
190   data_store->width_of_m = 10;
191 }
192
193 const PangoFontDescription *
194 psppire_data_store_get_font_desc(const GSheetModel *model,
195                               gint row, gint column)
196 {
197   PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
198   
199   return store->font_desc;
200 }
201
202
203 static void
204 psppire_data_store_sheet_model_init (GSheetModelIface *iface)
205 {
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;
218 }
219
220 static
221 gboolean always_true()
222 {
223   return TRUE;
224 }
225
226
227 static void
228 delete_cases_callback(GtkWidget *w, gint first, gint n_cases, gpointer data)
229 {
230   PsppireDataStore *store  ;
231
232   g_return_if_fail (data);
233
234   store  = PSPPIRE_DATA_STORE(data);
235
236   g_assert(first >= 0);
237
238   g_sheet_model_rows_deleted (G_SHEET_MODEL(store), first, n_cases);
239 }
240
241
242 static void
243 insert_case_callback(GtkWidget *w, gint casenum, gpointer data)
244 {
245   PsppireDataStore *store  ;
246
247   g_return_if_fail (data);
248
249   store  = PSPPIRE_DATA_STORE(data);
250   
251   g_sheet_model_range_changed (G_SHEET_MODEL(store),
252                                casenum, -1,
253                                psppire_case_file_get_case_count(store->case_file),
254                                -1);
255
256   g_sheet_model_rows_inserted (G_SHEET_MODEL(store), casenum, 1);
257 }
258
259
260 static void
261 changed_case_callback(GtkWidget *w, gint casenum, gpointer data)
262 {
263   PsppireDataStore *store  ;
264   g_return_if_fail (data);
265
266   store  = PSPPIRE_DATA_STORE(data);
267   
268   g_sheet_model_range_changed (G_SHEET_MODEL(store),
269                                  casenum, -1,
270                                  casenum, -1);
271 }
272
273
274 static void
275 delete_variables_callback(GObject *obj, gint var_num, gint n_vars, gpointer data)
276 {
277   PsppireDataStore *store ;
278
279   g_return_if_fail (data);
280
281   store  = PSPPIRE_DATA_STORE(data);
282
283   g_sheet_model_columns_deleted (G_SHEET_MODEL(store), var_num, n_vars);
284
285   g_sheet_column_columns_changed(G_SHEET_COLUMN(store),
286                                    var_num, -1);
287 }
288
289 static void
290 insert_variable_callback(GObject *obj, gint var_num, gpointer data)
291 {
292   PsppireDataStore *store;
293   gint posn;
294
295   g_return_if_fail (data);
296
297   store  = PSPPIRE_DATA_STORE(data);
298   
299   if ( var_num > 0 ) 
300     {
301       struct PsppireVariable *variable;
302       variable = psppire_dict_get_variable(store->dict, var_num);
303
304       posn = psppire_variable_get_fv(variable);
305     }
306   else
307     {
308       posn = 0;
309     }
310
311   psppire_case_file_insert_values(store->case_file, 1, posn);
312
313   g_sheet_column_columns_changed(G_SHEET_COLUMN(store),
314                                   var_num, 1);
315
316   g_sheet_model_columns_inserted (G_SHEET_MODEL(store), var_num, 1);
317 }
318
319
320 static void
321 dict_size_change_callback(GObject *obj, 
322                           gint posn, gint adjustment, gpointer data)
323 {
324   PsppireDataStore *store ;
325
326   g_return_if_fail (data);
327
328   store  = PSPPIRE_DATA_STORE(data);
329
330   /* 
331   if ( adjustment > 0 )
332   */
333   psppire_case_file_insert_values (store->case_file, adjustment, posn);
334 }
335
336
337
338 /**
339  * psppire_data_store_new:
340  * @dict: The dictionary for this data_store.
341  *
342  *
343  * Return value: a new #PsppireDataStore
344  **/
345 PsppireDataStore *
346 psppire_data_store_new (PsppireDict *dict)
347 {
348   PsppireDataStore *retval;
349
350   retval = g_object_new (GTK_TYPE_DATA_STORE, NULL);
351
352   psppire_data_store_set_dictionary(retval, dict);
353
354
355   return retval;
356 }
357
358
359
360 /**
361  * psppire_data_store_replace_set_dictionary:
362  * @data_store: The variable store
363  * @dict: The dictionary to set
364  *
365  * If a dictionary is already associated with the data-store, then it will be
366  * destroyed.
367  **/
368 void
369 psppire_data_store_set_dictionary(PsppireDataStore *data_store, PsppireDict *dict)
370 {
371   gint var_cnt = psppire_dict_get_next_value_idx(dict);
372 #if 0
373   if ( data_store->dict ) g_object_unref(data_store->dict);
374 #endif
375
376   data_store->dict = dict;
377
378   if ( data_store->case_file)
379     {
380       g_object_unref(data_store->case_file);
381       data_store->case_file = 0;
382     }
383
384   data_store->case_file = psppire_case_file_new(var_cnt);
385
386   g_signal_connect(data_store->case_file, "cases-deleted", 
387                    G_CALLBACK(delete_cases_callback), 
388                    data_store);
389
390   g_signal_connect(data_store->case_file, "case-inserted", 
391                    G_CALLBACK(insert_case_callback), 
392                    data_store);
393
394
395   g_signal_connect(data_store->case_file, "case-changed", 
396                    G_CALLBACK(changed_case_callback), 
397                    data_store);
398
399   g_signal_connect(dict, "variable-inserted", 
400                    G_CALLBACK(insert_variable_callback), 
401                    data_store);
402
403   g_signal_connect(dict, "variables-deleted", 
404                    G_CALLBACK(delete_variables_callback), 
405                    data_store);
406
407   g_signal_connect (dict, "dict-size-changed", 
408                     G_CALLBACK(dict_size_change_callback),
409                     data_store);
410
411   /* The entire model has changed */
412   g_sheet_model_range_changed (G_SHEET_MODEL(data_store), -1, -1, -1, -1);
413   
414   g_sheet_column_columns_changed(G_SHEET_COLUMN(data_store), 0, -1);
415 }
416
417 static void
418 psppire_data_store_finalize (GObject *object)
419 {
420
421   /* must chain up */
422   (* parent_class->finalize) (object);
423 }
424
425
426 static gchar *
427 psppire_data_store_get_string(const GSheetModel *model, gint row, gint column)
428 {
429   gint idx;
430   char *text;
431   const struct fmt_spec *fp ;
432   const struct PsppireVariable *pv ;
433   const union value *v ;
434   GString *s;
435   PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
436
437   g_return_val_if_fail(store->dict, NULL);
438   g_return_val_if_fail(store->case_file, NULL);
439
440   if (column >= psppire_dict_get_var_cnt(store->dict))
441     return NULL;
442
443   if ( row >= psppire_case_file_get_case_count(store->case_file))
444     return NULL;
445
446   pv = psppire_dict_get_variable(store->dict, column);
447
448   idx = psppire_variable_get_fv(pv);
449
450   v = psppire_case_file_get_value(store->case_file, row, idx);
451
452   g_return_val_if_fail(v, NULL);
453
454   if ( store->show_labels) 
455     {
456       const struct val_labs * vl = psppire_variable_get_value_labels(pv);
457
458       const gchar *label;
459       if ( (label = val_labs_find(vl, *v)) )
460         {
461           return pspp_locale_to_utf8(label, -1, 0);
462         }
463     }
464
465   fp = psppire_variable_get_write_spec(pv);
466
467   s = g_string_sized_new (fp->w + 1);
468   g_string_set_size(s, fp->w);
469   
470   memset(s->str, 0, fp->w);
471
472   g_assert(fp->w == s->len);
473     
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);
478
479   text = pspp_locale_to_utf8(s->str, fp->w, 0);
480   g_string_free(s, TRUE);
481
482   return text;
483 }
484
485
486 static gboolean 
487 psppire_data_store_clear_datum(GSheetModel *model, 
488                                           gint row, gint col)
489
490 {
491   PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
492
493   union value v;
494   const struct PsppireVariable *pv = psppire_dict_get_variable(store->dict, col);
495
496   const gint index = psppire_variable_get_fv(pv) ;
497
498   if ( psppire_variable_get_type(pv) == NUMERIC) 
499     v.f = SYSMIS;
500   else
501     memcpy(v.s, "", MAX_SHORT_STRING);
502
503   psppire_case_file_set_value(store->case_file, row, index, &v, 
504                               psppire_variable_get_width(pv));
505   return TRUE;
506 }
507
508
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.
512 */
513 static gboolean 
514 psppire_data_store_set_string(GSheetModel *model, 
515                           const gchar *text, gint row, gint col)
516 {
517   PsppireDataStore *store = PSPPIRE_DATA_STORE(model);
518
519   const struct PsppireVariable *pv = psppire_dict_get_variable(store->dict, col);
520   g_return_val_if_fail(pv, FALSE);
521
522 #if 0
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) 
525     {
526
527       gint c;
528
529       psppire_case_array_insert_case(store->cases, r, 0, 0);
530
531
532       for (c = 0 ; c < psppire_dict_get_var_cnt(store->dict); ++c ) 
533         psppire_data_store_clear_datum(model, r, c);
534     }
535 #endif
536
537   {
538     const gint index = psppire_variable_get_fv(pv);
539
540     struct data_in d_in;
541     d_in.s = text;
542     d_in.e = text + strlen(text);
543     d_in.v = 0;
544     d_in.f1 = d_in.f2 = 0;
545     d_in.format = * psppire_variable_get_write_spec(pv);
546     d_in.flags = 0;
547
548     psppire_case_file_data_in(store->case_file, row, index, &d_in) ;
549   }
550
551   return TRUE;
552 }
553
554
555 void
556 psppire_data_store_set_font(PsppireDataStore *store, 
557                             const PangoFontDescription *fd)
558 {
559   g_return_if_fail (store);
560   g_return_if_fail (PSPPIRE_IS_DATA_STORE (store));
561
562   store->font_desc = fd;
563 #if 0
564   store->width_of_m = calc_m_width(fd);
565 #endif
566   g_signal_emit(store, signal[FONT_CHANGED], 0);  
567
568
569   g_sheet_model_range_changed (G_SHEET_MODEL(store),
570                                  -1, -1, -1, -1);
571 }
572
573
574 void
575 psppire_data_store_show_labels(PsppireDataStore *store, gboolean show_labels)
576 {
577   g_return_if_fail (store);
578   g_return_if_fail (PSPPIRE_IS_DATA_STORE (store));
579
580   store->show_labels = show_labels;
581
582   g_sheet_model_range_changed (G_SHEET_MODEL(store),
583                                  -1, -1, -1, -1);
584 }
585
586
587
588 /* FIXME: There's no reason to actually have this function.
589    It should be done by a procedure */
590 void
591 psppire_data_store_create_system_file(PsppireDataStore *store,
592                               struct file_handle *handle)
593 {
594   gint i, var_cnt;
595   const struct sfm_write_options wo = {
596     true, /* writeable */
597     false, /* dont compress */
598     3 /* version */
599   }; 
600
601   struct sfm_writer *writer ;
602
603   g_assert(handle);
604
605   writer = sfm_open_writer(handle, store->dict->dict, wo);
606
607   if ( ! writer) 
608     return;
609
610
611   var_cnt = psppire_data_store_get_var_count (G_SHEET_MODEL(store));
612
613   for (i = 0 ; i < psppire_case_file_get_case_count(store->case_file); ++i ) 
614     {
615       struct ccase c;
616       
617       case_create (&c, var_cnt);
618       psppire_case_file_get_case (store->case_file, i, &c);
619       sfm_write_case (writer, &c);
620
621       case_destroy (&c);
622     }
623
624   sfm_close_writer(writer);
625 }
626
627
628
629 void 
630 psppire_data_store_clear(PsppireDataStore *data_store)
631 {
632   psppire_case_file_clear(data_store->case_file);
633
634   psppire_dict_clear(data_store->dict);
635 }
636
637
638
639
640 /* Column related funcs */
641
642 static gint
643 geometry_get_column_count(const GSheetColumn *geom)
644 {
645   PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
646
647   return MAX(MIN_COLUMNS, psppire_dict_get_var_cnt(ds->dict));
648 }
649
650
651
652 static gint
653 geometry_get_width(const GSheetColumn *geom, gint unit)
654 {
655   const struct PsppireVariable *pv ;
656   PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
657
658   if ( unit >= psppire_dict_get_var_cnt(ds->dict) )
659     return ds->width_of_m * 8 ;
660
661   pv = psppire_dict_get_variable(ds->dict, unit);
662
663   if ( pv == NULL ) 
664     return ds->width_of_m * 8 ;
665
666   return ds->width_of_m * psppire_variable_get_columns(pv);
667 }
668
669 static void
670 geometry_set_width(GSheetColumn *geom, gint unit, gint width)
671 {
672   PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
673
674   struct PsppireVariable *pv = psppire_dict_get_variable(ds->dict, unit);
675
676   psppire_variable_set_columns(pv, width / ds->width_of_m );
677 }
678
679
680
681 static GtkJustification
682 geometry_get_justification(const GSheetColumn *geom, gint unit)
683 {
684   PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
685   const struct PsppireVariable *pv ;
686
687
688   if ( unit >= psppire_dict_get_var_cnt(ds->dict) )
689     return GTK_JUSTIFY_LEFT;
690
691   pv = psppire_dict_get_variable(ds->dict, unit);
692
693   /* Kludge: Happily GtkJustification is defined similarly
694      to enum alignment from pspp/variable.h */
695   return psppire_variable_get_alignment(pv);
696 }
697
698
699 static const gchar null_var_name[]=N_("var");
700  
701 static gchar *
702 geometry_get_column_button_label(const GSheetColumn *geom, gint unit)
703 {
704   gchar *text;
705   struct PsppireVariable *pv ;
706   PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
707
708   if ( unit >= psppire_dict_get_var_cnt(ds->dict) )
709     return g_locale_to_utf8(null_var_name, -1, 0, 0, 0);
710
711   pv = psppire_dict_get_variable(ds->dict, unit);
712
713   text =  pspp_locale_to_utf8(psppire_variable_get_name(pv), -1, 0);
714
715   return text;
716 }
717
718
719 static gboolean
720 geometry_get_sensitivity(const GSheetColumn *geom, gint unit)
721 {
722   PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
723
724   return (unit < psppire_dict_get_var_cnt(ds->dict));
725 }
726
727
728 static void
729 psppire_data_store_sheet_column_init (GSheetColumnIface *iface)
730 {
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;
738 }
739
740
741 /* Row related funcs */
742
743 static gint
744 geometry_get_row_count(const GSheetRow *geom, gpointer data)
745 {
746   PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
747
748   return TRAILING_ROWS + psppire_case_file_get_case_count(ds->case_file);
749 }
750
751
752 static gint
753 geometry_get_height(const GSheetRow *geom, gint unit, gpointer data)
754 {
755   return 25;
756 }
757
758
759 static gboolean
760 geometry_get_row_sensitivity(const GSheetRow *geom, gint unit, gpointer data)
761 {
762   PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
763
764   
765   return (unit < psppire_case_file_get_case_count(ds->case_file));
766 }
767
768
769 static gchar *
770 geometry_get_row_button_label(const GSheetRow *geom, gint unit, gpointer data)
771 {
772   gchar *text;
773   gchar *s;
774   PsppireDataStore *ds = PSPPIRE_DATA_STORE(geom);
775
776   if ( unit > 
777        TRAILING_ROWS + psppire_case_file_get_case_count(ds->case_file))
778     return 0;
779
780   s = g_strdup_printf(_("%d"), unit);
781
782   text =  pspp_locale_to_utf8(s, -1, 0);
783   
784   g_free(s);
785   
786   return text;
787 }
788
789
790 static void
791 psppire_data_store_sheet_row_init (GSheetRowIface *iface)
792 {
793   iface->get_row_count = geometry_get_row_count;
794
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;
799
800   iface->get_button_label = geometry_get_row_button_label;
801 }