Whitespace changes only.
[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
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.
10
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.
15
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
19    02110-1301, USA. */
20
21 #include <config.h>
22 #include <string.h>
23 #include <stdlib.h>
24 #include <gettext.h>
25 #define _(msgid) gettext (msgid)
26 #define N_(msgid) msgid
27
28 #include <data/casefile.h>
29 #include <data/case.h>
30 #include <data/data-out.h>
31 #include <data/variable.h>
32
33 #include <gtksheet/gtksheet.h>
34 #include <gtksheet/gsheetmodel.h>
35 #include <gtksheet/gsheet-column-iface.h>
36
37 #include <pango/pango-context.h>
38
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 variable *variable;
302       variable = psppire_dict_get_variable (store->dict, var_num);
303
304       posn = var_get_case_index (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   psppire_case_file_insert_values (store->case_file, adjustment, posn);
331 }
332
333
334
335 /**
336  * psppire_data_store_new:
337  * @dict: The dictionary for this data_store.
338  *
339  *
340  * Return value: a new #PsppireDataStore
341  **/
342 PsppireDataStore *
343 psppire_data_store_new (PsppireDict *dict)
344 {
345   PsppireDataStore *retval;
346
347   retval = g_object_new (GTK_TYPE_DATA_STORE, NULL);
348
349   psppire_data_store_set_dictionary (retval, dict);
350
351
352   return retval;
353 }
354
355
356
357 /**
358  * psppire_data_store_replace_set_dictionary:
359  * @data_store: The variable store
360  * @dict: The dictionary to set
361  *
362  * If a dictionary is already associated with the data-store, then it will be
363  * destroyed.
364  **/
365 void
366 psppire_data_store_set_dictionary (PsppireDataStore *data_store, PsppireDict *dict)
367 {
368   gint var_cnt = psppire_dict_get_next_value_idx (dict);
369
370   data_store->dict = dict;
371
372   if ( data_store->case_file)
373     {
374       g_object_unref (data_store->case_file);
375       data_store->case_file = 0;
376     }
377
378   data_store->case_file = psppire_case_file_new (var_cnt);
379
380   g_signal_connect (data_store->case_file, "cases-deleted",
381                    G_CALLBACK (delete_cases_callback),
382                    data_store);
383
384   g_signal_connect (data_store->case_file, "case-inserted",
385                    G_CALLBACK (insert_case_callback),
386                    data_store);
387
388
389   g_signal_connect (data_store->case_file, "case-changed",
390                    G_CALLBACK (changed_case_callback),
391                    data_store);
392
393   g_signal_connect (dict, "variable-inserted",
394                    G_CALLBACK (insert_variable_callback),
395                    data_store);
396
397   g_signal_connect (dict, "variables-deleted",
398                    G_CALLBACK (delete_variables_callback),
399                    data_store);
400
401   g_signal_connect (dict, "dict-size-changed",
402                     G_CALLBACK (dict_size_change_callback),
403                     data_store);
404
405   /* The entire model has changed */
406   g_sheet_model_range_changed (G_SHEET_MODEL (data_store), -1, -1, -1, -1);
407
408   g_sheet_column_columns_changed (G_SHEET_COLUMN (data_store), 0, -1);
409 }
410
411 static void
412 psppire_data_store_finalize (GObject *object)
413 {
414
415   /* must chain up */
416   (* parent_class->finalize) (object);
417 }
418
419
420
421 /* Insert a blank case before POSN */
422 gboolean
423 psppire_data_store_insert_new_case (PsppireDataStore *ds, gint posn)
424 {
425   gboolean result;
426   gint val_cnt, v;
427   struct ccase cc;
428   g_return_val_if_fail (ds, FALSE);
429
430
431   /* Opportunity for optimisation exists here when creating a blank case */
432   val_cnt = casefile_get_value_cnt (ds->case_file->flexifile) ;
433
434   case_create (&cc, val_cnt);
435
436   memset ( case_data_rw_idx (&cc, 0), 0, val_cnt * MAX_SHORT_STRING);
437
438   for (v = 0 ; v < psppire_dict_get_var_cnt (ds->dict) ; ++v)
439     {
440       const struct variable *pv = psppire_dict_get_variable (ds->dict, v);
441       if ( var_is_alpha (pv))
442         continue;
443
444       case_data_rw (&cc, pv)->f = SYSMIS;
445     }
446
447   result = psppire_case_file_insert_case (ds->case_file, &cc, posn);
448
449   case_destroy (&cc);
450
451   return result;
452 }
453
454
455 static gchar *
456 psppire_data_store_get_string (const GSheetModel *model, gint row, gint column)
457 {
458   gint idx;
459   char *text;
460   const struct fmt_spec *fp ;
461   const struct variable *pv ;
462   const union value *v ;
463   GString *s;
464   PsppireDataStore *store = PSPPIRE_DATA_STORE (model);
465
466   g_return_val_if_fail (store->dict, NULL);
467   g_return_val_if_fail (store->case_file, NULL);
468
469   if (column >= psppire_dict_get_var_cnt (store->dict))
470     return NULL;
471
472   if ( row >= psppire_case_file_get_case_count (store->case_file))
473     return NULL;
474
475   pv = psppire_dict_get_variable (store->dict, column);
476
477   idx = var_get_case_index (pv);
478
479   v = psppire_case_file_get_value (store->case_file, row, idx);
480
481   g_return_val_if_fail (v, NULL);
482
483   if ( store->show_labels)
484     {
485       const struct val_labs * vl = var_get_value_labels (pv);
486
487       const gchar *label;
488       if ( (label = val_labs_find (vl, *v)) )
489         {
490           return pspp_locale_to_utf8 (label, -1, 0);
491         }
492     }
493
494   fp = var_get_write_format (pv);
495
496   s = g_string_sized_new (fp->w + 1);
497   g_string_set_size (s, fp->w);
498
499   memset (s->str, 0, fp->w);
500
501   g_assert (fp->w == s->len);
502
503   /* Converts binary value V into printable form in the exactly
504      FP->W character in buffer S according to format specification
505      FP.  No null terminator is appended to the buffer.  */
506   data_out (v, fp, s->str);
507
508   text = pspp_locale_to_utf8 (s->str, fp->w, 0);
509   g_string_free (s, TRUE);
510
511   g_strchomp (text);
512
513   return text;
514 }
515
516
517 static gboolean
518 psppire_data_store_clear_datum (GSheetModel *model,
519                                           gint row, gint col)
520
521 {
522   PsppireDataStore *store = PSPPIRE_DATA_STORE (model);
523
524   union value v;
525   const struct variable *pv = psppire_dict_get_variable (store->dict, col);
526
527   const gint index = var_get_case_index (pv) ;
528
529   if ( var_is_numeric (pv))
530     v.f = SYSMIS;
531   else
532     memcpy (v.s, "", MAX_SHORT_STRING);
533
534   psppire_case_file_set_value (store->case_file, row, index, &v,
535                               var_get_width (pv));
536
537   return TRUE;
538 }
539
540
541 /* Attempts to update that part of the variable store which corresponds
542    to ROW, COL with  the value TEXT.
543    Returns true if anything was updated, false otherwise.
544 */
545 static gboolean
546 psppire_data_store_set_string (GSheetModel *model,
547                           const gchar *text, gint row, gint col)
548 {
549   PsppireDataStore *store = PSPPIRE_DATA_STORE (model);
550
551   const struct variable *pv = psppire_dict_get_variable (store->dict, col);
552   g_return_val_if_fail (pv, FALSE);
553
554 #if 0
555   /* Allow the user to insert a lot of blank cases, simply by skipping rows */
556   for (r = psppire_case_file_get_case_count (store->case_file); r <= row ; ++r)
557     {
558
559       gint c;
560
561       psppire_case_array_insert_case (store->cases, r, 0, 0);
562
563
564       for (c = 0 ; c < psppire_dict_get_var_cnt (store->dict); ++c )
565         psppire_data_store_clear_datum (model, r, c);
566     }
567 #endif
568
569   psppire_case_file_data_in (store->case_file, row,
570                              var_get_case_index (pv), ss_cstr (text),
571                              var_get_write_format (pv));
572
573   return TRUE;
574 }
575
576
577 void
578 psppire_data_store_set_font (PsppireDataStore *store,
579                             const PangoFontDescription *fd)
580 {
581   g_return_if_fail (store);
582   g_return_if_fail (PSPPIRE_IS_DATA_STORE (store));
583
584   store->font_desc = fd;
585 #if 0
586   store->width_of_m = calc_m_width (fd);
587 #endif
588   g_signal_emit (store, signal[FONT_CHANGED], 0);
589
590
591   g_sheet_model_range_changed (G_SHEET_MODEL (store),
592                                  -1, -1, -1, -1);
593 }
594
595
596 void
597 psppire_data_store_show_labels (PsppireDataStore *store, gboolean show_labels)
598 {
599   g_return_if_fail (store);
600   g_return_if_fail (PSPPIRE_IS_DATA_STORE (store));
601
602   store->show_labels = show_labels;
603
604   g_sheet_model_range_changed (G_SHEET_MODEL (store),
605                                  -1, -1, -1, -1);
606 }
607
608
609
610 /* FIXME: There's no reason to actually have this function.
611    It should be done by a procedure */
612 void
613 psppire_data_store_create_system_file (PsppireDataStore *store,
614                               struct file_handle *handle)
615 {
616   gint i, var_cnt;
617   const struct sfm_write_options wo = {
618     true, /* writeable */
619     false, /* dont compress */
620     3 /* version */
621   };
622
623   struct sfm_writer *writer ;
624
625   g_assert (handle);
626
627   writer = sfm_open_writer (handle, store->dict->dict, wo);
628
629   if ( ! writer)
630     return;
631
632
633   var_cnt = psppire_data_store_get_var_count (G_SHEET_MODEL (store));
634
635   for (i = 0 ; i < psppire_case_file_get_case_count (store->case_file); ++i )
636     {
637       struct ccase c;
638
639       case_create (&c, var_cnt);
640       psppire_case_file_get_case (store->case_file, i, &c);
641       sfm_write_case (writer, &c);
642
643       case_destroy (&c);
644     }
645
646   sfm_close_writer (writer);
647 }
648
649
650
651 void
652 psppire_data_store_clear (PsppireDataStore *data_store)
653 {
654   psppire_case_file_clear (data_store->case_file);
655
656   psppire_dict_clear (data_store->dict);
657 }
658
659
660
661
662 /* Column related funcs */
663
664 static gint
665 geometry_get_column_count (const GSheetColumn *geom)
666 {
667   PsppireDataStore *ds = PSPPIRE_DATA_STORE (geom);
668
669   return MAX (MIN_COLUMNS, psppire_dict_get_var_cnt (ds->dict));
670 }
671
672
673
674 static gint
675 geometry_get_width (const GSheetColumn *geom, gint unit)
676 {
677   const struct variable *pv ;
678   PsppireDataStore *ds = PSPPIRE_DATA_STORE (geom);
679
680   if ( unit >= psppire_dict_get_var_cnt (ds->dict) )
681     return ds->width_of_m * 8 ;
682
683   pv = psppire_dict_get_variable (ds->dict, unit);
684
685   if ( pv == NULL )
686     return ds->width_of_m * 8 ;
687
688   return ds->width_of_m * var_get_display_width (pv);
689 }
690
691 static void
692 geometry_set_width (GSheetColumn *geom, gint unit, gint width)
693 {
694   PsppireDataStore *ds = PSPPIRE_DATA_STORE (geom);
695
696   struct variable *pv = psppire_dict_get_variable (ds->dict, unit);
697
698   var_set_display_width (pv, width / ds->width_of_m );
699 }
700
701
702
703 static GtkJustification
704 geometry_get_justification (const GSheetColumn *geom, gint unit)
705 {
706   PsppireDataStore *ds = PSPPIRE_DATA_STORE (geom);
707   const struct variable *pv ;
708
709
710   if ( unit >= psppire_dict_get_var_cnt (ds->dict) )
711     return GTK_JUSTIFY_LEFT;
712
713   pv = psppire_dict_get_variable (ds->dict, unit);
714
715   return (var_get_alignment (pv) == ALIGN_LEFT ? GTK_JUSTIFY_LEFT
716           : var_get_alignment (pv) == ALIGN_RIGHT ? GTK_JUSTIFY_RIGHT
717           : GTK_JUSTIFY_CENTER);
718 }
719
720
721 static const gchar null_var_name[]=N_("var");
722
723 static gchar *
724 geometry_get_column_button_label (const GSheetColumn *geom, gint unit)
725 {
726   gchar *text;
727   struct variable *pv ;
728   PsppireDataStore *ds = PSPPIRE_DATA_STORE (geom);
729
730   if ( unit >= psppire_dict_get_var_cnt (ds->dict) )
731     return g_locale_to_utf8 (null_var_name, -1, 0, 0, 0);
732
733   pv = psppire_dict_get_variable (ds->dict, unit);
734
735   text =  pspp_locale_to_utf8 (var_get_name (pv), -1, 0);
736
737   return text;
738 }
739
740
741 static gboolean
742 geometry_get_sensitivity (const GSheetColumn *geom, gint unit)
743 {
744   PsppireDataStore *ds = PSPPIRE_DATA_STORE (geom);
745
746   return (unit < psppire_dict_get_var_cnt (ds->dict));
747 }
748
749
750 static void
751 psppire_data_store_sheet_column_init (GSheetColumnIface *iface)
752 {
753   iface->get_column_count = geometry_get_column_count;
754   iface->get_width = geometry_get_width;
755   iface->set_width = geometry_set_width;
756   iface->get_visibility = always_true;
757   iface->get_sensitivity = geometry_get_sensitivity;
758   iface->get_justification = geometry_get_justification;
759   iface->get_button_label = geometry_get_column_button_label;
760 }
761
762
763 /* Row related funcs */
764
765 static gint
766 geometry_get_row_count (const GSheetRow *geom, gpointer data)
767 {
768   PsppireDataStore *ds = PSPPIRE_DATA_STORE (geom);
769
770   return TRAILING_ROWS + psppire_case_file_get_case_count (ds->case_file);
771 }
772
773
774 static gint
775 geometry_get_height (const GSheetRow *geom, gint unit, gpointer data)
776 {
777   return 25;
778 }
779
780
781 static gboolean
782 geometry_get_row_sensitivity (const GSheetRow *geom, gint unit, gpointer data)
783 {
784   PsppireDataStore *ds = PSPPIRE_DATA_STORE (geom);
785
786
787   return (unit < psppire_case_file_get_case_count (ds->case_file));
788 }
789
790
791 static gchar *
792 geometry_get_row_button_label (const GSheetRow *geom, gint unit, gpointer data)
793 {
794   gchar *text;
795   gchar *s;
796   PsppireDataStore *ds = PSPPIRE_DATA_STORE (geom);
797
798   if ( unit >
799        TRAILING_ROWS + psppire_case_file_get_case_count (ds->case_file))
800     return 0;
801
802   s = g_strdup_printf (_("%d"), unit);
803
804   text =  pspp_locale_to_utf8 (s, -1, 0);
805
806   g_free (s);
807
808   return text;
809 }
810
811
812 static void
813 psppire_data_store_sheet_row_init (GSheetRowIface *iface)
814 {
815   iface->get_row_count = geometry_get_row_count;
816
817   iface->get_height = geometry_get_height;
818   iface->set_height = 0;
819   iface->get_visibility = always_true;
820   iface->get_sensitivity = geometry_get_row_sensitivity;
821
822   iface->get_button_label = geometry_get_row_button_label;
823 }