Prevent var sheet from traversing to an invalid cell
[pspp-builds.git] / src / ui / gui / psppire-var-sheet.c
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyright (C) 2008, 2009 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #include <config.h>
18 #include "psppire-var-sheet.h"
19 #include <ui/gui/sheet/psppire-axis.h>
20
21 #include "helper.h"
22
23 #include "customentry.h"
24 #include <data/variable.h>
25 #include "psppire-var-store.h"
26
27 #include <gettext.h>
28 #define _(msgid) gettext (msgid)
29 #define N_(msgid) msgid
30
31
32 static void psppire_var_sheet_class_init  (PsppireVarSheetClass *klass);
33 static void psppire_var_sheet_init        (PsppireVarSheet      *vs);
34 static void psppire_var_sheet_realize     (GtkWidget *w);
35 static void psppire_var_sheet_unrealize   (GtkWidget *w);
36
37
38 enum
39   {
40     PSPPIRE_VAR_SHEET_MAY_CREATE_VARS = 1
41   };
42
43 GType
44 psppire_var_sheet_get_type (void)
45 {
46   static GType vs_type = 0;
47
48   if (!vs_type)
49     {
50       static const GTypeInfo vs_info =
51       {
52         sizeof (PsppireVarSheetClass),
53         NULL, /* base_init */
54         NULL, /* base_finalize */
55         (GClassInitFunc) psppire_var_sheet_class_init,
56         NULL, /* class_finalize */
57         NULL, /* class_data */
58         sizeof (PsppireVarSheet),
59         0,
60         (GInstanceInitFunc) psppire_var_sheet_init,
61       };
62
63       vs_type = g_type_register_static (PSPPIRE_TYPE_SHEET, "PsppireVarSheet",
64                                         &vs_info, 0);
65     }
66
67   return vs_type;
68 }
69
70 static GObjectClass * parent_class = NULL;
71
72 static void
73 psppire_var_sheet_dispose (GObject *obj)
74 {
75   PsppireVarSheet *vs = (PsppireVarSheet *)obj;
76
77   if (vs->dispose_has_run)
78     return;
79
80   /* Make sure dispose does not run twice. */
81   vs->dispose_has_run = TRUE;
82
83   /* Chain up to the parent class */
84   G_OBJECT_CLASS (parent_class)->dispose (obj);
85 }
86
87 static void
88 psppire_var_sheet_finalize (GObject *obj)
89 {
90    /* Chain up to the parent class */
91    G_OBJECT_CLASS (parent_class)->finalize (obj);
92 }
93
94
95 struct column_parameters
96 {
97   gchar label[20];
98   gint width ;
99 };
100
101 #define n_ALIGNMENTS 3
102
103 const gchar *const alignments[n_ALIGNMENTS + 1]={
104   N_("Left"),
105   N_("Right"),
106   N_("Center"),
107   0
108 };
109
110 const gchar *const measures[n_MEASURES + 1]={
111   N_("Nominal"),
112   N_("Ordinal"),
113   N_("Scale"),
114   0
115 };
116
117
118
119 /* Create a list store from an array of strings */
120 static GtkListStore *
121 create_label_list (const gchar *const *labels)
122 {
123   const gchar *s;
124   gint i = 0;
125   GtkTreeIter iter;
126
127   GtkListStore *list_store = gtk_list_store_new (1, G_TYPE_STRING);
128
129   while ( (s = labels[i++]))
130     {
131       gtk_list_store_append (list_store, &iter);
132       gtk_list_store_set (list_store, &iter,
133                           0, gettext (s),
134                           -1);
135     }
136
137   return list_store;
138 }
139
140
141 static void
142 psppire_var_sheet_set_property (GObject      *object,
143                                 guint         property_id,
144                                 const GValue *value,
145                                 GParamSpec   *pspec)
146 {
147   PsppireVarSheet *self = (PsppireVarSheet *) object;
148
149   switch (property_id)
150     {
151     case PSPPIRE_VAR_SHEET_MAY_CREATE_VARS:
152       self->may_create_vars = g_value_get_boolean (value);
153       break;
154
155     default:
156       G_OBJECT_WARN_INVALID_PROPERTY_ID(object, property_id, pspec);
157       break;
158     }
159 }
160
161 static void
162 psppire_var_sheet_get_property (GObject      *object,
163                                 guint         property_id,
164                                 GValue       *value,
165                                 GParamSpec   *pspec)
166 {
167   PsppireVarSheet *self = (PsppireVarSheet *) object;
168
169   switch (property_id)
170     {
171     case PSPPIRE_VAR_SHEET_MAY_CREATE_VARS:
172       g_value_set_boolean (value, self->may_create_vars);
173       break;
174
175     default:
176       G_OBJECT_WARN_INVALID_PROPERTY_ID(object, property_id, pspec);
177       break;
178     }
179 }
180
181
182 static void
183 psppire_var_sheet_class_init (PsppireVarSheetClass *klass)
184 {
185   GObjectClass *object_class = G_OBJECT_CLASS (klass);
186   GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
187   GParamSpec *pspec;
188
189   parent_class = g_type_class_peek_parent (klass);
190
191   object_class->dispose = psppire_var_sheet_dispose;
192   object_class->finalize = psppire_var_sheet_finalize;
193   widget_class->realize = psppire_var_sheet_realize;
194   widget_class->unrealize = psppire_var_sheet_unrealize;
195   object_class->set_property = psppire_var_sheet_set_property;
196   object_class->get_property = psppire_var_sheet_get_property;
197
198   pspec = g_param_spec_boolean ("may-create-vars",
199                                 "May create variables",
200                                 "Whether the user may create more variables",
201                                 TRUE,
202                                 G_PARAM_READWRITE);
203   g_object_class_install_property (object_class,
204                                    PSPPIRE_VAR_SHEET_MAY_CREATE_VARS,
205                                    pspec);
206
207   klass->measure_list = create_label_list (measures);
208   klass->alignment_list = create_label_list (alignments);
209 }
210
211
212
213 /* Callback for when the alignment combo box
214    item is selected */
215 static void
216 change_alignment (GtkComboBox *cb,
217                   struct variable *var)
218 {
219   gint active_item = gtk_combo_box_get_active (cb);
220
221   if ( active_item < 0 ) return ;
222
223   var_set_alignment (var, active_item);
224 }
225
226
227
228 /* Callback for when the measure combo box
229    item is selected */
230 static void
231 change_measure (GtkComboBox *cb,
232                 struct variable *var)
233 {
234   gint active_item = gtk_combo_box_get_active (cb);
235
236   if ( active_item < 0 ) return ;
237
238   var_set_measure (var, active_item);
239 }
240
241
242 /* Moves the focus to a new cell.
243    Returns TRUE iff the move should be disallowed */
244 static gboolean
245 traverse_cell_callback (PsppireSheet *sheet,
246                         const PsppireSheetCell *existing_cell,
247                         PsppireSheetCell *new_cell)
248 {
249   PsppireVarSheet *var_sheet = PSPPIRE_VAR_SHEET (sheet);
250   PsppireVarStore *var_store = PSPPIRE_VAR_STORE (psppire_sheet_get_model (sheet));
251
252   gint n_vars = psppire_var_store_get_var_cnt (var_store);
253
254   if (new_cell->col >=  PSPPIRE_VAR_STORE_n_COLS)
255     return TRUE;
256
257   if (new_cell->row >= n_vars && !var_sheet->may_create_vars)
258     return TRUE;
259
260   if ( existing_cell->row == n_vars && new_cell->row >= n_vars)
261     {
262       GtkEntry *entry = psppire_sheet_get_entry (sheet);
263
264       const gchar *name = gtk_entry_get_text (entry);
265
266       if (! psppire_dict_check_name (var_store->dictionary, name, TRUE))
267         return TRUE;
268
269       psppire_dict_insert_variable (var_store->dictionary, existing_cell->row, name);
270
271       return FALSE;
272     }
273
274
275   /* If the destination cell is outside the current  variables, then
276      automatically create variables for the new rows.
277   */
278   if ( ((new_cell->row > n_vars) ||
279         (new_cell->row == n_vars &&
280          new_cell->col != PSPPIRE_VAR_STORE_COL_NAME)) )
281     {
282       gint i;
283       for ( i = n_vars ; i <= new_cell->row; ++i )
284         psppire_dict_insert_variable (var_store->dictionary, i, NULL);
285     }
286
287   return FALSE;
288 }
289
290
291
292 /*
293    Callback whenever the active cell changes on the var sheet.
294 */
295 static void
296 var_sheet_change_active_cell (PsppireVarSheet *vs,
297                               gint row, gint column,
298                               gint oldrow, gint oldcolumn,
299                               gpointer data)
300 {
301   PsppireVarStore *var_store;
302   PsppireVarSheetClass *vs_class =
303     PSPPIRE_VAR_SHEET_CLASS(G_OBJECT_GET_CLASS (vs));
304
305   struct variable *var ;
306   PsppireSheet *sheet = PSPPIRE_SHEET (vs);
307
308   g_return_if_fail (sheet != NULL);
309
310   var_store = PSPPIRE_VAR_STORE (psppire_sheet_get_model (sheet));
311
312   g_assert (var_store);
313
314   g_return_if_fail (oldcolumn == PSPPIRE_VAR_STORE_COL_NAME ||
315                     row < psppire_var_store_get_var_cnt (var_store));
316
317   var = psppire_var_store_get_var (var_store, row);
318
319   switch (column)
320     {
321     case PSPPIRE_VAR_STORE_COL_ALIGN:
322       {
323         GtkEntry *entry;
324         static GtkListStore *list_store = NULL;
325         GtkComboBoxEntry *cbe;
326         psppire_sheet_change_entry (sheet, GTK_TYPE_COMBO_BOX_ENTRY);
327         entry = psppire_sheet_get_entry (sheet);
328         cbe = GTK_COMBO_BOX_ENTRY (GTK_WIDGET (entry)->parent);
329
330         if ( ! list_store) list_store = create_label_list (alignments);
331
332         gtk_combo_box_set_model (GTK_COMBO_BOX (cbe),
333                                 GTK_TREE_MODEL (vs_class->alignment_list));
334
335         gtk_combo_box_entry_set_text_column (cbe, 0);
336
337         g_signal_connect (cbe, "changed",
338                          G_CALLBACK (change_alignment), var);
339       }
340       break;
341
342     case PSPPIRE_VAR_STORE_COL_MEASURE:
343       {
344         GtkEntry *entry;
345         GtkComboBoxEntry *cbe;
346         psppire_sheet_change_entry (sheet, GTK_TYPE_COMBO_BOX_ENTRY);
347         entry = psppire_sheet_get_entry (sheet);
348         cbe = GTK_COMBO_BOX_ENTRY (GTK_WIDGET (entry)->parent);
349
350         gtk_combo_box_set_model (GTK_COMBO_BOX (cbe),
351                                 GTK_TREE_MODEL (vs_class->measure_list));
352
353         gtk_combo_box_entry_set_text_column (cbe, 0);
354
355         g_signal_connect (cbe, "changed",
356                           G_CALLBACK (change_measure), var);
357       }
358       break;
359
360     case PSPPIRE_VAR_STORE_COL_VALUES:
361       {
362         PsppireCustomEntry *customEntry;
363
364         psppire_sheet_change_entry (sheet, PSPPIRE_CUSTOM_ENTRY_TYPE);
365
366         customEntry =
367           PSPPIRE_CUSTOM_ENTRY (psppire_sheet_get_entry (sheet));
368
369         val_labs_dialog_set_target_variable (vs->val_labs_dialog, var);
370
371         g_signal_connect_swapped (customEntry,
372                                   "clicked",
373                                   G_CALLBACK (val_labs_dialog_show),
374                                   vs->val_labs_dialog);
375       }
376       break;
377
378     case PSPPIRE_VAR_STORE_COL_MISSING:
379       {
380         PsppireCustomEntry *customEntry;
381
382         psppire_sheet_change_entry (sheet, PSPPIRE_CUSTOM_ENTRY_TYPE);
383
384         customEntry =
385           PSPPIRE_CUSTOM_ENTRY (psppire_sheet_get_entry (sheet));
386
387         vs->missing_val_dialog->pv =
388           psppire_var_store_get_var (var_store, row);
389
390         vs->missing_val_dialog->dict = var_store->dictionary;
391
392         g_signal_connect_swapped (customEntry,
393                                   "clicked",
394                                   G_CALLBACK (missing_val_dialog_show),
395                                   vs->missing_val_dialog);
396       }
397       break;
398
399     case PSPPIRE_VAR_STORE_COL_TYPE:
400       {
401         PsppireCustomEntry *customEntry;
402
403         psppire_sheet_change_entry (sheet, PSPPIRE_CUSTOM_ENTRY_TYPE);
404
405         customEntry =
406           PSPPIRE_CUSTOM_ENTRY (psppire_sheet_get_entry (sheet));
407
408
409         /* Popup the Variable Type dialog box */
410         vs->var_type_dialog->pv = var;
411
412         g_signal_connect_swapped (customEntry,
413                                  "clicked",
414                                  G_CALLBACK (var_type_dialog_show),
415                                   vs->var_type_dialog);
416       }
417       break;
418
419     case PSPPIRE_VAR_STORE_COL_WIDTH:
420     case PSPPIRE_VAR_STORE_COL_DECIMALS:
421     case PSPPIRE_VAR_STORE_COL_COLUMNS:
422       {
423         if ( psppire_sheet_model_is_editable (PSPPIRE_SHEET_MODEL(var_store),
424                                               row, column))
425           {
426             gint r_min, r_max;
427
428             const gchar *s = psppire_sheet_cell_get_text (sheet, row, column);
429
430             if (s)
431               {
432                 GtkSpinButton *spinButton ;
433                 const gint current_value  = g_strtod (s, NULL);
434                 GtkObject *adj ;
435
436                 const struct fmt_spec *fmt = var_get_write_format (var);
437                 switch (column)
438                   {
439                   case PSPPIRE_VAR_STORE_COL_WIDTH:
440                     r_min = MAX (fmt->d + 1, fmt_min_output_width (fmt->type));
441                     r_max = fmt_max_output_width (fmt->type);
442                     break;
443                   case PSPPIRE_VAR_STORE_COL_DECIMALS:
444                     r_min = 0 ;
445                     r_max = fmt_max_output_decimals (fmt->type, fmt->w);
446                     break;
447                   case PSPPIRE_VAR_STORE_COL_COLUMNS:
448                     r_min = 1;
449                     r_max = 255 ; /* Is this a sensible value ? */
450                     break;
451                   default:
452                     g_assert_not_reached ();
453                   }
454
455                 adj = gtk_adjustment_new (current_value,
456                                          r_min, r_max,
457                                          1.0, 1.0, 1.0 /* steps */
458                                          );
459
460                 psppire_sheet_change_entry (sheet, GTK_TYPE_SPIN_BUTTON);
461
462                 spinButton =
463                   GTK_SPIN_BUTTON (psppire_sheet_get_entry (sheet));
464
465                 gtk_spin_button_set_adjustment (spinButton, GTK_ADJUSTMENT (adj));
466                 gtk_spin_button_set_digits (spinButton, 0);
467               }
468           }
469       }
470       break;
471
472     default:
473       psppire_sheet_change_entry (sheet, GTK_TYPE_ENTRY);
474       break;
475     }
476 }
477
478
479 static void
480 psppire_var_sheet_realize (GtkWidget *w)
481 {
482   PsppireVarSheet *vs = PSPPIRE_VAR_SHEET (w);
483
484   GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (vs));
485
486   vs->val_labs_dialog = val_labs_dialog_create (GTK_WINDOW (toplevel),
487                                                 PSPPIRE_VAR_STORE (psppire_sheet_get_model (PSPPIRE_SHEET (vs))));
488
489   vs->missing_val_dialog = missing_val_dialog_create (GTK_WINDOW (toplevel));
490   vs->var_type_dialog = var_type_dialog_create (GTK_WINDOW (toplevel));
491
492   /* Chain up to the parent class */
493   GTK_WIDGET_CLASS (parent_class)->realize (w);
494 }
495
496 static void
497 psppire_var_sheet_unrealize (GtkWidget *w)
498 {
499   PsppireVarSheet *vs = PSPPIRE_VAR_SHEET (w);
500
501   g_free (vs->val_labs_dialog);
502   g_free (vs->missing_val_dialog);
503   g_free (vs->var_type_dialog);
504
505   /* Chain up to the parent class */
506   GTK_WIDGET_CLASS (parent_class)->unrealize (w);
507 }
508
509
510
511 static void
512 psppire_var_sheet_init (PsppireVarSheet *vs)
513 {
514   GtkBuilder *builder = builder_new ("data-editor.ui");
515
516   connect_help (builder);
517
518   g_object_unref (builder);
519
520   vs->dispose_has_run = FALSE;
521   vs->may_create_vars = TRUE;
522
523   g_signal_connect (vs, "activate",
524                     G_CALLBACK (var_sheet_change_active_cell),
525                     NULL);
526
527   g_signal_connect (vs, "traverse",
528                     G_CALLBACK (traverse_cell_callback), NULL);
529 }
530
531
532 static const struct column_parameters column_def[] = {
533   { N_("Name"),    80},
534   { N_("Type"),    100},
535   { N_("Width"),   57},
536   { N_("Decimals"),91},
537   { N_("Label"),   95},
538   { N_("Values"),  103},
539   { N_("Missing"), 95},
540   { N_("Columns"), 80},
541   { N_("Align"),   69},
542   { N_("Measure"), 99},
543 };
544
545 GtkWidget*
546 psppire_var_sheet_new (void)
547 {
548   gint i;
549   PsppireAxis *ha = psppire_axis_new ();
550   PsppireAxis *va = psppire_axis_new ();
551
552   GtkWidget *w = g_object_new (psppire_var_sheet_get_type (), NULL);
553
554   for (i = 0 ; i < 10 ; ++i)
555     psppire_axis_append (ha, column_def[i].width);
556
557   g_object_set (va,
558                 "default-size", 25,
559                 NULL);
560
561   g_object_set (ha, "minimum-extent", 0,
562                 NULL);
563
564   g_object_set (w,
565                 "horizontal-axis", ha,
566                 "vertical-axis", va,
567                 NULL);
568
569   return w;
570 }