gui: Factor out duplicated code for executing and pasting syntax.
[pspp] / src / ui / gui / val-labs-dialog.c
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyright (C) 2005, 2009  Free Software Foundation
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
18 /*  This module describes the behaviour of the Value Labels dialog box,
19     used for input of the value labels in the variable sheet */
20
21 #include <config.h>
22
23 #include <string.h>
24
25 #include "helper.h"
26 #include "val-labs-dialog.h"
27 #include <data/value-labels.h>
28 #include <data/format.h>
29 #include "psppire-var-sheet.h"
30 #include "psppire-var-store.h"
31 #include <libpspp/i18n.h>
32
33 #include <gettext.h>
34 #define _(msgid) gettext (msgid)
35 #define N_(msgid) msgid
36
37 struct val_labs_dialog
38 {
39   GtkWidget *window;
40
41   PsppireVarStore *var_store;
42   PsppireDict *dict;
43
44   /* The variable to be updated */
45   struct variable *pv;
46
47   /* Local copy of labels */
48   struct val_labs *labs;
49
50   /* Actions */
51   GtkWidget *add_button;
52   GtkWidget *remove_button;
53   GtkWidget *change_button;
54
55   /* Entry Boxes */
56   GtkWidget *value_entry;
57   GtkWidget *label_entry;
58
59   /* Signal handler ids */
60   gint change_handler_id;
61   gint value_handler_id;
62
63   GtkWidget *treeview;
64 };
65
66
67 /* This callback occurs when the text in the label entry box
68    is changed */
69 static void
70 on_label_entry_change (GtkEntry *entry, gpointer data)
71 {
72   union value v;
73   const gchar *text ;
74   struct val_labs_dialog *dialog = data;
75   g_assert (dialog->labs);
76
77   text = gtk_entry_get_text (GTK_ENTRY (dialog->value_entry));
78
79   text_to_value (text,
80                  dialog->dict,
81                  dialog->pv,
82                  &v);
83
84   if (val_labs_find (dialog->labs, &v))
85     {
86       gtk_widget_set_sensitive (dialog->change_button, TRUE);
87       gtk_widget_set_sensitive (dialog->add_button, FALSE);
88     }
89   else
90     {
91       gtk_widget_set_sensitive (dialog->change_button, FALSE);
92       gtk_widget_set_sensitive (dialog->add_button, TRUE);
93     }
94
95   value_destroy (&v, var_get_width (dialog->pv));
96 }
97
98
99 /* Set the TREEVIEW list cursor to the item which has the value VAL */
100 static void
101 select_treeview_from_value (GtkTreeView *treeview, union value *val)
102 {
103   GtkTreePath *path ;
104
105   /*
106     We do this with a linear search through the model --- hardly
107     efficient, but the list is short ... */
108   GtkTreeIter iter;
109
110   GtkTreeModel * model  = gtk_tree_view_get_model (treeview);
111
112   gboolean success;
113   for (success = gtk_tree_model_get_iter_first (model, &iter);
114        success;
115        success = gtk_tree_model_iter_next (model, &iter))
116     {
117       union value v;
118       GValue gvalue = {0};
119
120       gtk_tree_model_get_value (model, &iter, 1, &gvalue);
121
122       v.f = g_value_get_double (&gvalue);
123
124       if ( 0 == memcmp (&v, val, sizeof (union value)))
125         {
126           break;
127         }
128     }
129
130   path = gtk_tree_model_get_path (model, &iter);
131   if ( path )
132     {
133       gtk_tree_view_set_cursor (treeview, path, 0, 0);
134       gtk_tree_path_free (path);
135     }
136
137 }
138
139
140 /* This callback occurs when the text in the value entry box is
141    changed */
142 static void
143 on_value_entry_change (GtkEntry *entry, gpointer data)
144 {
145   const char *s;
146
147   struct val_labs_dialog *dialog = data;
148
149   const gchar *text = gtk_entry_get_text (GTK_ENTRY (dialog->value_entry));
150
151   union value v;
152   text_to_value (text,
153                  dialog->dict,
154                  dialog->pv,
155                  &v);
156
157
158   g_signal_handler_block (GTK_ENTRY (dialog->label_entry),
159                          dialog->change_handler_id);
160
161   gtk_entry_set_text (GTK_ENTRY (dialog->label_entry),"");
162
163
164   if ( (s = val_labs_find (dialog->labs, &v)) )
165     {
166       gtk_entry_set_text (GTK_ENTRY (dialog->label_entry), s);
167       gtk_widget_set_sensitive (dialog->add_button, FALSE);
168       gtk_widget_set_sensitive (dialog->remove_button, TRUE);
169       select_treeview_from_value (GTK_TREE_VIEW (dialog->treeview), &v);
170     }
171   else
172     {
173       gtk_widget_set_sensitive (dialog->remove_button, FALSE);
174       gtk_widget_set_sensitive (dialog->add_button, TRUE);
175     }
176
177   g_signal_handler_unblock (GTK_ENTRY (dialog->label_entry),
178                          dialog->change_handler_id);
179
180   value_destroy (&v, var_get_width (dialog->pv));
181 }
182
183
184 /* Callback for when the Value Labels dialog is closed using
185    the OK button.*/
186 static gint
187 val_labs_ok (GtkWidget *w, gpointer data)
188 {
189   struct val_labs_dialog *dialog = data;
190
191   var_set_value_labels (dialog->pv, dialog->labs);
192
193   val_labs_destroy (dialog->labs);
194
195   dialog->labs = 0;
196
197   gtk_widget_hide (dialog->window);
198
199   return FALSE;
200 }
201
202 /* Callback for when the Value Labels dialog is closed using
203    the Cancel button.*/
204 static void
205 val_labs_cancel (struct val_labs_dialog *dialog)
206 {
207   val_labs_destroy (dialog->labs);
208
209   dialog->labs = 0;
210
211   gtk_widget_hide (dialog->window);
212 }
213
214
215 /* Callback for when the Value Labels dialog is closed using
216    the Cancel button.*/
217 static void
218 on_cancel (GtkWidget *w, gpointer data)
219 {
220   struct val_labs_dialog *dialog = data;
221
222   val_labs_cancel (dialog);
223 }
224
225
226 /* Callback for when the Value Labels dialog is closed using
227    the window delete button.*/
228 static gint
229 on_delete (GtkWidget *w, GdkEvent *e, gpointer data)
230 {
231   struct val_labs_dialog *dialog = data;
232
233   val_labs_cancel (dialog);
234
235   return TRUE;
236 }
237
238
239 /* Return the value-label pair currently selected in the dialog box  */
240 static void
241 get_selected_tuple (struct val_labs_dialog *dialog,
242                     union value *valuep, const char **label)
243 {
244   GtkTreeView *treeview = GTK_TREE_VIEW (dialog->treeview);
245
246   GtkTreeIter iter ;
247   GValue the_value = {0};
248   union value value;
249
250   GtkTreeSelection* sel =  gtk_tree_view_get_selection (treeview);
251
252   GtkTreeModel * model  = gtk_tree_view_get_model (treeview);
253
254   gtk_tree_selection_get_selected (sel, &model, &iter);
255
256   gtk_tree_model_get_value (model, &iter, 1, &the_value);
257
258   value.f = g_value_get_double (&the_value);
259   g_value_unset (&the_value);
260
261   if (valuep != NULL)
262     *valuep = value;
263   if (label != NULL)
264     *label = val_labs_find (dialog->labs, &value);
265 }
266
267
268 static void repopulate_dialog (struct val_labs_dialog *dialog);
269
270 /* Callback which occurs when the "Change" button is clicked */
271 static void
272 on_change (GtkWidget *w, gpointer data)
273 {
274   struct val_labs_dialog *dialog = data;
275
276   const gchar *val_text = gtk_entry_get_text (GTK_ENTRY (dialog->value_entry));
277
278   union value v;
279
280   text_to_value (val_text,
281                  dialog->dict,
282                  dialog->pv,
283                  &v);
284
285   val_labs_replace (dialog->labs, &v,
286                     gtk_entry_get_text (GTK_ENTRY (dialog->label_entry)));
287
288   gtk_widget_set_sensitive (dialog->change_button, FALSE);
289
290   repopulate_dialog (dialog);
291   gtk_widget_grab_focus (dialog->value_entry);
292
293   value_destroy (&v, var_get_width (dialog->pv));
294 }
295
296 /* Callback which occurs when the "Add" button is clicked */
297 static void
298 on_add (GtkWidget *w, gpointer data)
299 {
300   struct val_labs_dialog *dialog = data;
301
302   union value v;
303
304   const gchar *text = gtk_entry_get_text (GTK_ENTRY (dialog->value_entry));
305
306   text_to_value (text,
307                  dialog->dict,
308                  dialog->pv,
309                  &v);
310
311   if (val_labs_add (dialog->labs, &v,
312                     gtk_entry_get_text
313                     ( GTK_ENTRY (dialog->label_entry)) ) )
314     {
315       gtk_widget_set_sensitive (dialog->add_button, FALSE);
316
317       repopulate_dialog (dialog);
318       gtk_widget_grab_focus (dialog->value_entry);
319     }
320
321   value_destroy (&v, var_get_width (dialog->pv));
322 }
323
324 /* Callback which occurs when the "Remove" button is clicked */
325 static void
326 on_remove (GtkWidget *w, gpointer data)
327 {
328   struct val_labs_dialog *dialog = data;
329
330   union value value;
331   struct val_lab *vl;
332
333   get_selected_tuple (dialog, &value, NULL);
334   vl = val_labs_lookup (dialog->labs, &value);
335   if (vl != NULL)
336     val_labs_remove (dialog->labs, vl);
337
338   repopulate_dialog (dialog);
339   gtk_widget_grab_focus (dialog->value_entry);
340
341   gtk_widget_set_sensitive (dialog->remove_button, FALSE);
342 }
343
344
345
346 /* Callback which occurs when a line item is selected in the list of
347    value--label pairs.*/
348 static void
349 on_select_row (GtkTreeView *treeview, gpointer data)
350 {
351   struct val_labs_dialog *dialog = data;
352
353   union value value;
354   const char *label = NULL;
355
356   gchar *text;
357
358   get_selected_tuple (dialog, &value, &label);
359   text = value_to_text (value, dialog->dict, *var_get_write_format (dialog->pv));
360
361   g_signal_handler_block (GTK_ENTRY (dialog->value_entry),
362                          dialog->value_handler_id);
363
364   gtk_entry_set_text (GTK_ENTRY (dialog->value_entry), text);
365
366   g_signal_handler_unblock (GTK_ENTRY (dialog->value_entry),
367                          dialog->value_handler_id);
368   g_free (text);
369
370   g_signal_handler_block (GTK_ENTRY (dialog->label_entry),
371                          dialog->change_handler_id);
372
373
374   gtk_entry_set_text (GTK_ENTRY (dialog->label_entry),
375                       label);
376
377   g_signal_handler_unblock (GTK_ENTRY (dialog->label_entry),
378                          dialog->change_handler_id);
379
380   gtk_widget_set_sensitive (dialog->remove_button, TRUE);
381   gtk_widget_set_sensitive (dialog->change_button, FALSE);
382 }
383
384
385 /* Create a new dialog box
386    (there should  normally be only one)*/
387 struct val_labs_dialog *
388 val_labs_dialog_create (GtkWindow *toplevel, PsppireVarStore *var_store)
389 {
390   GtkTreeViewColumn *column;
391
392   GtkCellRenderer *renderer ;
393
394   GtkBuilder *xml = builder_new ("var-sheet-dialogs.ui");
395
396   struct val_labs_dialog *dialog = g_malloc (sizeof (*dialog));
397
398   dialog->var_store = var_store;
399   g_object_get (var_store, "dictionary", &dialog->dict, NULL);
400   dialog->window = get_widget_assert (xml,"val_labs_dialog");
401   dialog->value_entry = get_widget_assert (xml,"value_entry");
402   dialog->label_entry = get_widget_assert (xml,"label_entry");
403
404   gtk_window_set_transient_for
405     (GTK_WINDOW (dialog->window), toplevel);
406
407   dialog->add_button = get_widget_assert (xml, "val_labs_add");
408   dialog->remove_button = get_widget_assert (xml, "val_labs_remove");
409   dialog->change_button = get_widget_assert (xml, "val_labs_change");
410
411   dialog->treeview = get_widget_assert (xml,"treeview1");
412
413   gtk_tree_view_set_headers_visible (GTK_TREE_VIEW (dialog->treeview), FALSE);
414
415   renderer = gtk_cell_renderer_text_new ();
416
417   column = gtk_tree_view_column_new_with_attributes ("Title",
418                                                      renderer,
419                                                      "text",
420                                                      0,
421                                                      NULL);
422
423   gtk_tree_view_append_column (GTK_TREE_VIEW (dialog->treeview), column);
424
425   g_signal_connect (get_widget_assert (xml, "val_labs_cancel"),
426                    "clicked",
427                    G_CALLBACK (on_cancel), dialog);
428
429   g_signal_connect (dialog->window, "delete-event",
430                     G_CALLBACK (on_delete), dialog);
431
432   g_signal_connect (get_widget_assert (xml, "val_labs_ok"),
433                    "clicked",
434                    G_CALLBACK (val_labs_ok), dialog);
435
436   dialog->change_handler_id =
437     g_signal_connect (dialog->label_entry,
438                      "changed",
439                      G_CALLBACK (on_label_entry_change), dialog);
440
441   dialog->value_handler_id  =
442     g_signal_connect (dialog->value_entry,
443                      "changed",
444                      G_CALLBACK (on_value_entry_change), dialog);
445
446   g_signal_connect (dialog->change_button,
447                    "clicked",
448                    G_CALLBACK (on_change), dialog);
449
450
451   g_signal_connect (dialog->treeview, "cursor-changed",
452                    G_CALLBACK (on_select_row), dialog);
453
454   g_signal_connect (dialog->remove_button, "clicked",
455                    G_CALLBACK (on_remove), dialog);
456
457   g_signal_connect (dialog->add_button, "clicked",
458                    G_CALLBACK (on_add), dialog);
459
460   dialog->labs = 0;
461
462   g_object_unref (xml);
463
464   return dialog;
465 }
466
467
468 void
469 val_labs_dialog_set_target_variable (struct val_labs_dialog *dialog,
470                                      struct variable *var)
471 {
472   dialog->pv = var;
473 }
474
475
476
477 /* Populate the components of the dialog box, from the 'labs' member
478    variable */
479 static void
480 repopulate_dialog (struct val_labs_dialog *dialog)
481 {
482   const struct val_lab **labels;
483   size_t n_labels;
484   size_t i;
485
486   GtkTreeIter iter;
487
488   GtkListStore *list_store = gtk_list_store_new (2,
489                                                  G_TYPE_STRING,
490                                                  G_TYPE_DOUBLE);
491
492   g_signal_handler_block (GTK_ENTRY (dialog->label_entry),
493                          dialog->change_handler_id);
494   g_signal_handler_block (GTK_ENTRY (dialog->value_entry),
495                          dialog->value_handler_id);
496
497   gtk_entry_set_text (GTK_ENTRY (dialog->value_entry), "");
498   gtk_entry_set_text (GTK_ENTRY (dialog->label_entry), "");
499
500   g_signal_handler_unblock (GTK_ENTRY (dialog->value_entry),
501                          dialog->value_handler_id);
502   g_signal_handler_unblock (GTK_ENTRY (dialog->label_entry),
503                            dialog->change_handler_id);
504
505   labels = val_labs_sorted (dialog->labs);
506   n_labels = val_labs_count (dialog->labs);
507   for (i = 0; i < n_labels; i++)
508     {
509       const struct val_lab *vl = labels[i];
510
511       gchar *const vstr  =
512         value_to_text (vl->value, dialog->dict,
513                       *var_get_write_format (dialog->pv));
514
515       gchar *const text = g_strdup_printf (_("%s = `%s'"),
516                                            vstr, val_lab_get_label (vl));
517
518       gtk_list_store_append (list_store, &iter);
519       gtk_list_store_set (list_store, &iter,
520                           0, text,
521                           1, vl->value.f,
522                           -1);
523
524       g_free (text);
525       g_free (vstr);
526     }
527   free (labels);
528
529   gtk_tree_view_set_model (GTK_TREE_VIEW (dialog->treeview),
530                           GTK_TREE_MODEL (list_store));
531
532   g_object_unref (list_store);
533
534 }
535
536 /* Initialise and display the dialog box */
537 void
538 val_labs_dialog_show (struct val_labs_dialog *dialog)
539 {
540   const struct val_labs *value_labels;
541
542   g_assert (!dialog->labs);
543
544   value_labels = var_get_value_labels (dialog->pv);
545
546   if (value_labels)
547     dialog->labs = val_labs_clone ( value_labels );
548   else
549     dialog->labs = val_labs_create ( var_get_width (dialog->pv));
550
551   gtk_widget_set_sensitive (dialog->remove_button, FALSE);
552   gtk_widget_set_sensitive (dialog->change_button, FALSE);
553   gtk_widget_set_sensitive (dialog->add_button, FALSE);
554
555   gtk_widget_grab_focus (dialog->value_entry);
556
557   repopulate_dialog (dialog);
558   gtk_widget_show (dialog->window);
559 }
560