Prevent data sheet from traversing into an invalid column.
[pspp-builds.git] / src / ui / gui / psppire-data-editor.c
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyrigght (C) 2008 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 <gtk/gtksignal.h>
19 #include <gtk/gtk.h>
20 #include <gtksheet/gtksheet.h>
21 #include "psppire-data-editor.h"
22 #include "psppire-var-sheet.h"
23
24 #include <gtksheet/gsheet-hetero-column.h>
25 #include <language/syntax-string-source.h>
26 #include "psppire-data-store.h"
27 #include "helper.h"
28
29 #include <gettext.h>
30 #define _(msgid) gettext (msgid)
31 #define N_(msgid) msgid
32
33
34 enum {
35   DATA_SELECTION_CHANGED,
36   DATA_AVAILABLE_CHANGED,
37   CASES_SELECTED,
38   VARIABLES_SELECTED,
39   n_SIGNALS
40 };
41
42
43 static guint data_editor_signals [n_SIGNALS] = { 0 };
44
45
46 static gboolean data_is_selected (PsppireDataEditor *de);
47
48 static void psppire_data_editor_class_init          (PsppireDataEditorClass *klass);
49 static void psppire_data_editor_init                (PsppireDataEditor      *de);
50
51 GType
52 psppire_data_editor_get_type (void)
53 {
54   static GType de_type = 0;
55
56   if (!de_type)
57     {
58       static const GTypeInfo de_info =
59       {
60         sizeof (PsppireDataEditorClass),
61         NULL, /* base_init */
62         NULL, /* base_finalize */
63         (GClassInitFunc) psppire_data_editor_class_init,
64         NULL, /* class_finalize */
65         NULL, /* class_data */
66         sizeof (PsppireDataEditor),
67         0,
68         (GInstanceInitFunc) psppire_data_editor_init,
69       };
70
71       de_type = g_type_register_static (GTK_TYPE_NOTEBOOK, "PsppireDataEditor",
72                                         &de_info, 0);
73     }
74
75   return de_type;
76 }
77
78 static GObjectClass * parent_class = NULL;
79
80 static void
81 psppire_data_editor_dispose (GObject *obj)
82 {
83   PsppireDataEditor *de = (PsppireDataEditor *) obj;
84
85   if (de->dispose_has_run)
86     return;
87
88   g_object_unref (de->data_store);
89   g_object_unref (de->var_store);
90
91   /* Make sure dispose does not run twice. */
92   de->dispose_has_run = TRUE;
93
94   /* Chain up to the parent class */
95   G_OBJECT_CLASS (parent_class)->dispose (obj);
96 }
97
98 static void
99 psppire_data_editor_finalize (GObject *obj)
100 {
101    /* Chain up to the parent class */
102    G_OBJECT_CLASS (parent_class)->finalize (obj);
103 }
104
105
106
107 static void popup_variable_menu (GtkSheet *sheet, gint column,
108                                  GdkEventButton *event, gpointer data);
109
110 static void popup_cases_menu (GtkSheet *sheet, gint row,
111                               GdkEventButton *event, gpointer data);
112
113
114
115
116 /* Callback which occurs when the data sheet's column title
117    is double clicked */
118 static gboolean
119 on_data_column_clicked (PsppireDataEditor *de, gint col, gpointer data)
120 {
121
122   gint current_row, current_column;
123
124   gtk_notebook_set_current_page (GTK_NOTEBOOK (de), PSPPIRE_DATA_EDITOR_VARIABLE_VIEW);
125
126   gtk_sheet_get_active_cell (GTK_SHEET (de->var_sheet),
127                              &current_row, &current_column);
128
129   gtk_sheet_set_active_cell (GTK_SHEET (de->var_sheet), col, current_column);
130
131   return FALSE;
132 }
133
134
135 /* Callback which occurs when the var sheet's row title
136    button is double clicked */
137 static gboolean
138 on_var_row_clicked (PsppireDataEditor *de, gint row, gpointer data)
139 {
140   GtkSheetRange visible_range;
141
142   gint current_row, current_column;
143
144   gtk_notebook_set_current_page (GTK_NOTEBOOK(de), PSPPIRE_DATA_EDITOR_DATA_VIEW);
145
146   gtk_sheet_get_active_cell (GTK_SHEET (de->data_sheet),
147                              &current_row, &current_column);
148
149   gtk_sheet_set_active_cell (GTK_SHEET (de->data_sheet), current_row, row);
150
151   gtk_sheet_get_visible_range (GTK_SHEET (de->data_sheet), &visible_range);
152
153   if ( row < visible_range.col0 || row > visible_range.coli)
154     {
155       gtk_sheet_moveto (GTK_SHEET (de->data_sheet),
156                         current_row, row, 0, 0);
157     }
158
159   return FALSE;
160 }
161
162
163
164 enum
165   {
166     PROP_0,
167     PROP_DATA_STORE,
168     PROP_VAR_STORE,
169     PROP_COLUMN_MENU,
170     PROP_ROW_MENU,
171     PROP_VALUE_LABELS,
172     PROP_CURRENT_CASE,
173     PROP_CURRENT_VAR,
174     PROP_DATA_SELECTED
175   };
176
177 static void
178 psppire_data_editor_set_property (GObject         *object,
179                                   guint            prop_id,
180                                   const GValue    *value,
181                                   GParamSpec      *pspec)
182 {
183   PsppireDataEditor *de = PSPPIRE_DATA_EDITOR (object);
184
185   switch (prop_id)
186     {
187     case PROP_DATA_STORE:
188       if ( de->data_store) g_object_unref (de->data_store);
189       de->data_store = g_value_get_pointer (value);
190       g_object_ref (de->data_store);
191
192       g_object_set (de->data_sheet,
193                     "row-geometry", de->data_store,
194                     "column-geometry", de->data_store,
195                     "model", de->data_store,
196                     NULL);
197       break;
198     case PROP_VAR_STORE:
199       if ( de->var_store) g_object_unref (de->var_store);
200       de->var_store = g_value_get_pointer (value);
201       g_object_ref (de->var_store);
202
203       g_object_set (de->var_sheet,
204                     "row-geometry", de->var_store,
205                     "model", de->var_store,
206                     NULL);
207       break;
208     case PROP_COLUMN_MENU:
209       {
210         GObject *menu = g_value_get_object (value);
211
212         g_signal_connect (de->data_sheet, "button-event-column",
213                           G_CALLBACK (popup_variable_menu), menu);
214       }
215       break;
216     case PROP_ROW_MENU:
217       {
218         GObject *menu = g_value_get_object (value);
219
220         g_signal_connect (de->data_sheet, "button-event-row",
221                           G_CALLBACK (popup_cases_menu), menu);
222       }
223       break;
224     case PROP_CURRENT_VAR:
225       {
226         gint row, col;
227         gint var = g_value_get_long (value);
228         switch (gtk_notebook_get_current_page (GTK_NOTEBOOK (object)))
229           {
230           case PSPPIRE_DATA_EDITOR_DATA_VIEW:
231             gtk_sheet_get_active_cell (GTK_SHEET (de->data_sheet), &row, &col);
232             gtk_sheet_set_active_cell (GTK_SHEET (de->data_sheet), row, var);
233             gtk_sheet_moveto (GTK_SHEET (de->data_sheet), row, var, 0.5, 0.5);
234             break;
235           case PSPPIRE_DATA_EDITOR_VARIABLE_VIEW:
236             gtk_sheet_get_active_cell (GTK_SHEET (de->var_sheet), &row, &col);
237             gtk_sheet_set_active_cell (GTK_SHEET (de->var_sheet), var, col);
238             gtk_sheet_moveto (GTK_SHEET (de->var_sheet), var, col,  0.5, 0.5);
239             break;
240           default:
241             g_assert_not_reached ();
242             break;
243           };
244       }
245       break;
246     case PROP_CURRENT_CASE:
247       {
248         gint row, col;
249         gint case_num = g_value_get_long (value);
250         gtk_sheet_get_active_cell (GTK_SHEET (de->data_sheet), &row, &col);
251         gtk_sheet_set_active_cell (GTK_SHEET (de->data_sheet), case_num, col);
252         gtk_sheet_moveto (GTK_SHEET (de->data_sheet), case_num, col, 0.5, 0.5);
253       }
254       break;
255     case PROP_VALUE_LABELS:
256       {
257         psppire_data_store_show_labels (de->data_store,
258                                         g_value_get_boolean (value));
259       }
260       break;
261     default:
262       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
263       break;
264     };
265 }
266
267 static void
268 psppire_data_editor_get_property (GObject         *object,
269                                   guint            prop_id,
270                                   GValue          *value,
271                                   GParamSpec      *pspec)
272 {
273   PsppireDataEditor *de = PSPPIRE_DATA_EDITOR (object);
274
275   switch (prop_id)
276     {
277     case PROP_DATA_STORE:
278       g_value_set_pointer (value, de->data_store);
279       break;
280     case PROP_VAR_STORE:
281       g_value_set_pointer (value, de->var_store);
282       break;
283     case PROP_CURRENT_CASE:
284       {
285         gint row, column;
286         gtk_sheet_get_active_cell (GTK_SHEET (de->data_sheet), &row, &column);
287         g_value_set_long (value, row);
288       }
289       break;
290     case PROP_CURRENT_VAR:
291       {
292         gint row, column;
293         gtk_sheet_get_active_cell (GTK_SHEET (de->data_sheet), &row, &column);
294         g_value_set_long (value, column);
295       }
296       break;
297     case PROP_DATA_SELECTED:
298       g_value_set_boolean (value, data_is_selected (de));
299       break;
300     default:
301       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
302       break;
303     };
304 }
305
306
307 static void
308 psppire_data_editor_class_init (PsppireDataEditorClass *klass)
309 {
310   GParamSpec *data_store_spec ;
311   GParamSpec *var_store_spec ;
312   GParamSpec *column_menu_spec;
313   GParamSpec *row_menu_spec;
314   GParamSpec *value_labels_spec;
315   GParamSpec *current_case_spec;
316   GParamSpec *current_var_spec;
317   GParamSpec *data_selected_spec;
318   GObjectClass *object_class = G_OBJECT_CLASS (klass);
319
320   parent_class = g_type_class_peek_parent (klass);
321
322   object_class->dispose = psppire_data_editor_dispose;
323   object_class->finalize = psppire_data_editor_finalize;
324
325   object_class->set_property = psppire_data_editor_set_property;
326   object_class->get_property = psppire_data_editor_get_property;
327
328   data_store_spec =
329     g_param_spec_pointer ("data-store",
330                           "Data Store",
331                           "A pointer to the data store associated with this editor",
332                           G_PARAM_CONSTRUCT_ONLY | G_PARAM_WRITABLE | G_PARAM_READABLE );
333
334   g_object_class_install_property (object_class,
335                                    PROP_DATA_STORE,
336                                    data_store_spec);
337
338   var_store_spec =
339     g_param_spec_pointer ("var-store",
340                           "Variable Store",
341                           "A pointer to the variable store associated with this editor",
342                           G_PARAM_CONSTRUCT_ONLY | G_PARAM_WRITABLE | G_PARAM_READABLE );
343
344   g_object_class_install_property (object_class,
345                                    PROP_VAR_STORE,
346                                    var_store_spec);
347
348   column_menu_spec =
349     g_param_spec_object ("column-menu",
350                          "Column Menu",
351                          "A menu to be displayed when button 3 is pressed in the column title buttons",
352                          GTK_TYPE_MENU,
353                          G_PARAM_WRITABLE);
354
355   g_object_class_install_property (object_class,
356                                    PROP_COLUMN_MENU,
357                                    column_menu_spec);
358
359
360   row_menu_spec =
361     g_param_spec_object ("row-menu",
362                          "Row Menu",
363                          "A menu to be displayed when button 3 is pressed in the row title buttons",
364                          GTK_TYPE_MENU,
365                          G_PARAM_WRITABLE);
366
367   g_object_class_install_property (object_class,
368                                    PROP_ROW_MENU,
369                                    row_menu_spec);
370
371   value_labels_spec =
372     g_param_spec_boolean ("value-labels",
373                          "Value Labels",
374                          "Whether or not the data sheet should display labels instead of values",
375                           FALSE,
376                          G_PARAM_WRITABLE | G_PARAM_READABLE);
377
378   g_object_class_install_property (object_class,
379                                    PROP_VALUE_LABELS,
380                                    value_labels_spec);
381
382
383   current_case_spec =
384     g_param_spec_long ("current-case",
385                        "Current Case",
386                        "Zero based number of the selected case",
387                        0, CASENUMBER_MAX,
388                        0,
389                        G_PARAM_WRITABLE | G_PARAM_READABLE);
390
391   g_object_class_install_property (object_class,
392                                    PROP_CURRENT_CASE,
393                                    current_case_spec);
394
395
396   current_var_spec =
397     g_param_spec_long ("current-variable",
398                        "Current Variable",
399                        "Zero based number of the selected variable",
400                        0, G_MAXINT,
401                        0,
402                        G_PARAM_WRITABLE | G_PARAM_READABLE);
403
404   g_object_class_install_property (object_class,
405                                    PROP_CURRENT_VAR,
406                                    current_var_spec);
407
408
409   data_selected_spec =
410     g_param_spec_boolean ("data-selected",
411                           "Data Selected",
412                           "True iff the data view is active and  one or more cells of data have been selected.",
413                           FALSE,
414                           G_PARAM_READABLE);
415
416   g_object_class_install_property (object_class,
417                                    PROP_DATA_SELECTED,
418                                    data_selected_spec);
419
420
421
422   data_editor_signals [DATA_SELECTION_CHANGED] =
423     g_signal_new ("data-selection-changed",
424                   G_TYPE_FROM_CLASS (klass),
425                   G_SIGNAL_RUN_FIRST,
426                   0,
427                   NULL, NULL,
428                   g_cclosure_marshal_VOID__BOOLEAN,
429                   G_TYPE_NONE,
430                   1,
431                   G_TYPE_BOOLEAN);
432
433   data_editor_signals [CASES_SELECTED] =
434     g_signal_new ("cases-selected",
435                   G_TYPE_FROM_CLASS (klass),
436                   G_SIGNAL_RUN_FIRST,
437                   0,
438                   NULL, NULL,
439                   g_cclosure_marshal_VOID__INT,
440                   G_TYPE_NONE,
441                   1,
442                   G_TYPE_INT);
443
444
445   data_editor_signals [VARIABLES_SELECTED] =
446     g_signal_new ("variables-selected",
447                   G_TYPE_FROM_CLASS (klass),
448                   G_SIGNAL_RUN_FIRST,
449                   0,
450                   NULL, NULL,
451                   g_cclosure_marshal_VOID__INT,
452                   G_TYPE_NONE,
453                   1,
454                   G_TYPE_INT);
455
456
457   data_editor_signals [DATA_AVAILABLE_CHANGED] =
458     g_signal_new ("data-available-changed",
459                   G_TYPE_FROM_CLASS (klass),
460                   G_SIGNAL_RUN_FIRST,
461                   0,
462                   NULL, NULL,
463                   g_cclosure_marshal_VOID__BOOLEAN,
464                   G_TYPE_NONE,
465                   1,
466                   G_TYPE_BOOLEAN);
467 }
468
469 /* Update the data_ref_entry with the reference of the active cell */
470 static gint
471 update_data_ref_entry (const GtkSheet *sheet, gint row, gint col, gpointer data)
472 {
473   PsppireDataEditor *de = data;
474
475   PsppireDataStore *data_store =
476     PSPPIRE_DATA_STORE (gtk_sheet_get_model (sheet));
477
478   if (data_store)
479     {
480       const struct variable *var =
481         psppire_dict_get_variable (data_store->dict, col);
482
483       if ( var )
484         {
485           gchar *text = g_strdup_printf ("%d: %s", row + FIRST_CASE_NUMBER,
486                                          var_get_name (var));
487
488           gchar *s = pspp_locale_to_utf8 (text, -1, 0);
489
490           g_free (text);
491
492           gtk_entry_set_text (GTK_ENTRY (de->cell_ref_entry), s);
493
494           g_free (s);
495         }
496       else
497         goto blank_entry;
498
499       if ( var )
500         {
501           gchar *text =
502             psppire_data_store_get_string (data_store, row,
503                                            var_get_dict_index(var));
504
505           if ( ! text )
506             goto blank_entry;
507
508           g_strchug (text);
509
510           gtk_entry_set_text (GTK_ENTRY (de->datum_entry), text);
511
512           g_free (text);
513         }
514       else
515         goto blank_entry;
516
517     }
518
519   return FALSE;
520
521  blank_entry:
522   gtk_entry_set_text (GTK_ENTRY (de->datum_entry), "");
523
524   return FALSE;
525 }
526
527
528 static void
529 datum_entry_activate (GtkEntry *entry, gpointer data)
530 {
531   gint row, column;
532   PsppireDataEditor *de = data;
533
534   const gchar *text = gtk_entry_get_text (entry);
535
536   gtk_sheet_get_active_cell (GTK_SHEET (de->data_sheet), &row, &column);
537
538   if ( row == -1 || column == -1)
539     return;
540
541   psppire_data_store_set_string (de->data_store, text, row, column);
542 }
543
544
545 static void on_activate (PsppireDataEditor *de);
546 static void on_deactivate (PsppireDataEditor *de);
547 static gboolean on_switch_page (PsppireDataEditor *de, GtkNotebookPage *p, gint pagenum, gpointer data);
548 static void on_select_range (PsppireDataEditor *de);
549
550 static void on_select_row (GtkSheet *, gint, PsppireDataEditor *);
551 static void on_select_variable (GtkSheet *, gint, PsppireDataEditor *);
552
553
554 static void on_owner_change (GtkClipboard *,
555                              GdkEventOwnerChange *, gpointer);
556
557 static void
558 on_map (GtkWidget *w)
559 {
560   GtkClipboard *clip = gtk_widget_get_clipboard (w, GDK_SELECTION_CLIPBOARD);
561
562   g_signal_connect (clip, "owner-change", G_CALLBACK (on_owner_change), w);
563 }
564
565 static gboolean
566 traverse_cell_callback (GtkSheet *sheet,
567                         gint row, gint column,
568                         gint *new_row, gint *new_column,
569                         gpointer data)
570 {
571   PsppireDataStore *data_store = PSPPIRE_DATA_STORE (data);
572
573   if ( *new_column >= psppire_dict_get_var_cnt (data_store->dict))
574     return FALSE;
575
576   return TRUE;
577 }
578
579 static void
580 psppire_data_editor_init (PsppireDataEditor *de)
581 {
582   GtkWidget *vbox = gtk_vbox_new (FALSE, 0);
583   GtkWidget *hbox = gtk_hbox_new (FALSE, 0);
584   GtkWidget *sw_ds = gtk_scrolled_window_new (NULL, NULL);
585   GtkWidget *sw_vs = gtk_scrolled_window_new (NULL, NULL);
586
587
588   de->data_sheet = gtk_sheet_new (NULL, NULL, NULL);
589   de->var_sheet = psppire_var_sheet_new ();
590
591   g_object_set (de, "tab-pos", GTK_POS_BOTTOM, NULL);
592
593   de->datum_entry = gtk_entry_new ();
594   de->cell_ref_entry = gtk_entry_new ();
595
596   g_object_set (de->cell_ref_entry,
597                 "sensitive", FALSE,
598                 "editable",  FALSE,
599                 "width_chars", 25,
600                 NULL);
601
602   gtk_box_pack_start (GTK_BOX (hbox), de->cell_ref_entry, FALSE, FALSE, 0);
603   gtk_box_pack_start (GTK_BOX (hbox), de->datum_entry, TRUE, TRUE, 0);
604
605
606   gtk_container_add (GTK_CONTAINER (sw_vs), de->var_sheet);
607   gtk_widget_show_all (sw_vs);
608
609
610   gtk_container_add (GTK_CONTAINER (sw_ds), de->data_sheet);
611   gtk_box_pack_start (GTK_BOX (vbox), hbox, FALSE, FALSE, 0);
612   gtk_box_pack_start (GTK_BOX (vbox), sw_ds, TRUE, TRUE, 0);
613
614   gtk_widget_show_all (vbox);
615
616   gtk_notebook_append_page (GTK_NOTEBOOK (de), vbox,
617                             gtk_label_new_with_mnemonic (_("Data View")));
618
619   gtk_notebook_append_page (GTK_NOTEBOOK (de), sw_vs,
620                             gtk_label_new_with_mnemonic (_("Variable View")));
621
622   g_signal_connect (de->data_sheet, "activate",
623                     G_CALLBACK (update_data_ref_entry),
624                     de);
625
626   g_signal_connect (de->datum_entry, "activate",
627                     G_CALLBACK (datum_entry_activate),
628                     de);
629
630
631   g_signal_connect_swapped (de->data_sheet,
632                     "double-click-column",
633                     G_CALLBACK (on_data_column_clicked),
634                     de);
635
636   g_signal_connect_swapped (de->var_sheet,
637                     "double-click-row",
638                     G_CALLBACK (on_var_row_clicked),
639                     de);
640
641   g_signal_connect_swapped (de->data_sheet, "activate",
642                             G_CALLBACK (on_activate),
643                             de);
644
645   g_signal_connect_swapped (de->data_sheet, "deactivate",
646                             G_CALLBACK (on_deactivate),
647                             de);
648
649   g_signal_connect_swapped (de->data_sheet, "select-range",
650                             G_CALLBACK (on_select_range),
651                             de);
652
653   g_signal_connect (de->data_sheet, "select-row",
654                     G_CALLBACK (on_select_row), de);
655
656   g_signal_connect (de->data_sheet, "select-column",
657                     G_CALLBACK (on_select_variable), de);
658
659
660   g_signal_connect (de->var_sheet, "select-row",
661                     G_CALLBACK (on_select_variable), de);
662
663
664   g_signal_connect_after (de, "switch-page",
665                     G_CALLBACK (on_switch_page),
666                     NULL);
667
668
669   g_signal_connect (de, "map", G_CALLBACK (on_map), NULL);
670
671   de->dispose_has_run = FALSE;
672 }
673
674
675 GtkWidget*
676 psppire_data_editor_new (PsppireVarStore *var_store,
677                          PsppireDataStore *data_store)
678 {
679   GtkWidget *widget;
680
681   widget =  g_object_new (PSPPIRE_DATA_EDITOR_TYPE,
682                           "var-store",  var_store,
683                           "data-store",  data_store,
684                           NULL);
685
686   g_signal_connect (PSPPIRE_DATA_EDITOR(widget)->data_sheet, "traverse",
687                     G_CALLBACK (traverse_cell_callback), data_store);
688
689   return widget;
690 }
691
692 static void data_sheet_set_clip (GtkSheet *sheet);
693 static void data_sheet_contents_received_callback (GtkClipboard *clipboard,
694                                                    GtkSelectionData *sd,
695                                                    gpointer data);
696
697
698 void
699 psppire_data_editor_clip_copy (PsppireDataEditor *de)
700 {
701   data_sheet_set_clip (GTK_SHEET (de->data_sheet));
702 }
703
704 void
705 psppire_data_editor_clip_paste (PsppireDataEditor *de)
706 {
707   GtkClipboard *clipboard = gtk_clipboard_get (GDK_SELECTION_CLIPBOARD);
708
709   gtk_clipboard_request_contents (clipboard,
710                                   gdk_atom_intern ("UTF8_STRING", TRUE),
711                                   data_sheet_contents_received_callback,
712                                   de);
713 }
714
715
716
717 void
718 psppire_data_editor_clip_cut (PsppireDataEditor *de)
719 {
720   gint max_rows, max_columns;
721   gint r;
722   GtkSheetRange range;
723   PsppireDataStore *ds = de->data_store;
724
725   data_sheet_set_clip (GTK_SHEET (de->data_sheet));
726
727   /* Now blank all the cells */
728   gtk_sheet_get_selected_range (GTK_SHEET (de->data_sheet), &range);
729
730    /* If nothing selected, then use active cell */
731   if ( range.row0 < 0 || range.col0 < 0 )
732     {
733       gint row, col;
734       gtk_sheet_get_active_cell (GTK_SHEET (de->data_sheet), &row, &col);
735
736       range.row0 = range.rowi = row;
737       range.col0 = range.coli = col;
738     }
739
740   /* The sheet range can include cells that do not include data.
741      Exclude them from the range. */
742   max_rows = psppire_data_store_get_case_count (ds);
743   if (range.rowi >= max_rows)
744     {
745       if (max_rows == 0)
746         return;
747       range.rowi = max_rows - 1;
748     }
749
750   max_columns = dict_get_var_cnt (ds->dict->dict);
751   if (range.coli >= max_columns)
752     {
753       if (max_columns == 0)
754         return;
755       range.coli = max_columns - 1;
756     }
757
758   g_return_if_fail (range.rowi >= range.row0);
759   g_return_if_fail (range.row0 >= 0);
760   g_return_if_fail (range.coli >= range.col0);
761   g_return_if_fail (range.col0 >= 0);
762
763
764   for (r = range.row0; r <= range.rowi ; ++r )
765     {
766       gint c;
767
768       for (c = range.col0 ; c <= range.coli; ++c)
769         {
770           psppire_data_store_set_string (ds, "", r, c);
771         }
772     }
773
774   /* and remove the selection */
775   gtk_sheet_unselect_range (GTK_SHEET (de->data_sheet));
776 }
777
778
779 \f
780
781 /* Popup menu related stuff */
782
783 static void
784 popup_variable_menu (GtkSheet *sheet, gint column,
785                      GdkEventButton *event, gpointer data)
786 {
787   GtkMenu *menu = GTK_MENU (data);
788
789   PsppireDataStore *data_store =
790     PSPPIRE_DATA_STORE (gtk_sheet_get_model (sheet));
791
792   const struct variable *v =
793     psppire_dict_get_variable (data_store->dict, column);
794
795   if ( v && event->button == 3)
796     {
797       gtk_sheet_select_column (sheet, column);
798
799       gtk_menu_popup (menu,
800                       NULL, NULL, NULL, NULL,
801                       event->button, event->time);
802     }
803 }
804
805
806 static void
807 popup_cases_menu (GtkSheet *sheet, gint row,
808                   GdkEventButton *event, gpointer data)
809 {
810   GtkMenu *menu = GTK_MENU (data);
811
812   PsppireDataStore *data_store =
813     PSPPIRE_DATA_STORE (gtk_sheet_get_model (sheet));
814
815   if ( row <= psppire_data_store_get_case_count (data_store) &&
816        event->button == 3)
817     {
818       gtk_sheet_select_row (sheet, row);
819
820       gtk_menu_popup (menu,
821                       NULL, NULL, NULL, NULL,
822                       event->button, event->time);
823     }
824 }
825
826 \f
827
828 /* Sorting */
829
830 static void
831 do_sort (PsppireDataStore *ds, int var, gboolean descend)
832 {
833   GString *string = g_string_new ("SORT CASES BY ");
834
835   const struct variable *v =
836     psppire_dict_get_variable (ds->dict, var);
837
838   g_string_append_printf (string, "%s", var_get_name (v));
839
840   if ( descend )
841     g_string_append (string, " (D)");
842
843   g_string_append (string, ".");
844
845   execute_syntax (create_syntax_string_source (string->str));
846
847   g_string_free (string, TRUE);
848 }
849
850
851 /* Sort the data by the the variable which the editor has currently
852    selected */
853 void
854 psppire_data_editor_sort_ascending  (PsppireDataEditor *de)
855 {
856   GtkSheetRange range;
857   gtk_sheet_get_selected_range (GTK_SHEET(de->data_sheet), &range);
858
859   do_sort (de->data_store,  range.col0, FALSE);
860 }
861
862
863 /* Sort the data by the the variable which the editor has currently
864    selected */
865 void
866 psppire_data_editor_sort_descending (PsppireDataEditor *de)
867 {
868   GtkSheetRange range;
869   gtk_sheet_get_selected_range (GTK_SHEET(de->data_sheet), &range);
870
871   do_sort (de->data_store,  range.col0, TRUE);
872 }
873
874
875 \f
876
877
878 /* Insert a new variable  before the currently selected position */
879 void
880 psppire_data_editor_insert_variable (PsppireDataEditor *de)
881 {
882   glong posn = -1;
883
884   if ( de->data_sheet->state == GTK_SHEET_COLUMN_SELECTED )
885     posn = GTK_SHEET (de->data_sheet)->range.col0;
886   else
887     posn = GTK_SHEET (de->data_sheet)->active_cell.col;
888
889   if ( posn == -1 ) posn = 0;
890
891   psppire_dict_insert_variable (de->data_store->dict, posn, NULL);
892 }
893
894 /* Insert a new case before the currently selected position */
895 void
896 psppire_data_editor_insert_case (PsppireDataEditor *de)
897 {
898   glong posn = -1;
899
900   if ( de->data_sheet->state == GTK_SHEET_ROW_SELECTED )
901     posn = GTK_SHEET (de->data_sheet)->range.row0;
902   else
903     posn = GTK_SHEET (de->data_sheet)->active_cell.row;
904
905   if ( posn == -1 ) posn = 0;
906
907   psppire_data_store_insert_new_case (de->data_store, posn);
908 }
909
910 /* Delete the cases currently selected in the data sheet */
911 void
912 psppire_data_editor_delete_cases    (PsppireDataEditor *de)
913 {
914   gint first = GTK_SHEET (de->data_sheet)->range.row0;
915   gint n = GTK_SHEET (de->data_sheet)->range.rowi - first + 1;
916
917   psppire_data_store_delete_cases (de->data_store, first, n);
918
919   gtk_sheet_unselect_range (GTK_SHEET (de->data_sheet));
920 }
921
922 /* Delete the variables currently selected in the
923    datasheet or variable sheet */
924 void
925 psppire_data_editor_delete_variables (PsppireDataEditor *de)
926 {
927   gint first, n;
928
929   switch (gtk_notebook_get_current_page (GTK_NOTEBOOK (de)))
930     {
931     case PSPPIRE_DATA_EDITOR_DATA_VIEW:
932       first = GTK_SHEET (de->data_sheet)->range.col0;
933       n = GTK_SHEET (de->data_sheet)->range.coli - first + 1;
934       break;
935     case PSPPIRE_DATA_EDITOR_VARIABLE_VIEW:
936       first = GTK_SHEET (de->var_sheet)->range.row0;
937       n = GTK_SHEET (de->var_sheet)->range.rowi - first + 1;
938       break;
939     default:
940       g_assert_not_reached ();
941       break;
942     }
943
944   psppire_dict_delete_variables (de->var_store->dict, first, n);
945
946   gtk_sheet_unselect_range (GTK_SHEET (de->data_sheet));
947   gtk_sheet_unselect_range (GTK_SHEET (de->var_sheet));
948 }
949
950
951 void
952 psppire_data_editor_show_grid (PsppireDataEditor *de, gboolean grid_visible)
953 {
954   gtk_sheet_show_grid (GTK_SHEET (de->var_sheet), grid_visible);
955   gtk_sheet_show_grid (GTK_SHEET (de->data_sheet), grid_visible);
956 }
957
958 void
959 psppire_data_editor_set_font (PsppireDataEditor *de, PangoFontDescription *font_desc)
960 {
961   psppire_data_store_set_font (de->data_store, font_desc);
962   psppire_var_store_set_font (de->var_store, font_desc);
963 }
964
965
966 \f
967
968
969 static void
970 emit_selected_signal (PsppireDataEditor *de)
971 {
972   gboolean data_selected = data_is_selected (de);
973
974   g_signal_emit (de, data_editor_signals[DATA_SELECTION_CHANGED], 0, data_selected);
975 }
976
977 static void
978 on_activate (PsppireDataEditor *de)
979 {
980   gint row, col;
981   gtk_sheet_get_active_cell (GTK_SHEET (de->data_sheet), &row, &col);
982
983   if ( row < psppire_data_store_get_case_count (de->data_store)
984        &&
985        col < psppire_var_store_get_var_cnt (de->var_store))
986     {
987       emit_selected_signal (de);
988       return ;
989     }
990
991   emit_selected_signal (de);
992 }
993
994
995 static void
996 on_deactivate (PsppireDataEditor *de)
997 {
998   emit_selected_signal (de);
999 }
1000
1001 static void
1002 on_select_range (PsppireDataEditor *de)
1003 {
1004   GtkSheetRange range;
1005
1006   gtk_sheet_get_selected_range (GTK_SHEET (de->data_sheet), &range);
1007
1008   if ( range.rowi < psppire_data_store_get_case_count (de->data_store)
1009        &&
1010        range.coli < psppire_var_store_get_var_cnt (de->var_store))
1011     {
1012       emit_selected_signal (de);
1013       return;
1014     }
1015
1016   emit_selected_signal (de);
1017 }
1018
1019
1020 static gboolean
1021 on_switch_page (PsppireDataEditor *de, GtkNotebookPage *p, gint pagenum, gpointer data)
1022 {
1023   if ( pagenum != PSPPIRE_DATA_EDITOR_DATA_VIEW )
1024     {
1025       emit_selected_signal (de);
1026       return TRUE;
1027     }
1028
1029   on_select_range (de);
1030
1031   return TRUE;
1032 }
1033
1034
1035
1036 static gboolean
1037 data_is_selected (PsppireDataEditor *de)
1038 {
1039   GtkSheetRange range;
1040   gint row, col;
1041
1042   if ( gtk_notebook_get_current_page (GTK_NOTEBOOK (de)) != PSPPIRE_DATA_EDITOR_DATA_VIEW)
1043     return FALSE;
1044
1045   gtk_sheet_get_active_cell (GTK_SHEET (de->data_sheet), &row, &col);
1046
1047   if ( row >= psppire_data_store_get_case_count (de->data_store)
1048        ||
1049        col >= psppire_var_store_get_var_cnt (de->var_store))
1050     {
1051       return FALSE;
1052     }
1053
1054   gtk_sheet_get_selected_range (GTK_SHEET (de->data_sheet), &range);
1055
1056   if ( range.rowi >= psppire_data_store_get_case_count (de->data_store)
1057        ||
1058        range.coli >= psppire_var_store_get_var_cnt (de->var_store))
1059     {
1060       return FALSE;
1061     }
1062
1063   return TRUE;
1064 }
1065
1066
1067 static void
1068 on_select_row (GtkSheet *sheet, gint row, PsppireDataEditor *de)
1069 {
1070   g_signal_emit (de, data_editor_signals[CASES_SELECTED], 0, row);
1071 }
1072
1073
1074 static void
1075 on_select_variable (GtkSheet *sheet, gint var, PsppireDataEditor *de)
1076 {
1077   g_signal_emit (de, data_editor_signals[VARIABLES_SELECTED], 0, var);
1078 }
1079
1080
1081 \f
1082
1083 /* Clipboard stuff */
1084
1085
1086 #include <data/casereader.h>
1087 #include <data/case-map.h>
1088 #include <data/casewriter.h>
1089
1090 #include <data/data-out.h>
1091 #include "xalloc.h"
1092
1093 /* A casereader and dictionary holding the data currently in the clip */
1094 static struct casereader *clip_datasheet = NULL;
1095 static struct dictionary *clip_dict = NULL;
1096
1097
1098 static void data_sheet_update_clipboard (GtkSheet *);
1099
1100 /* Set the clip according to the currently
1101    selected range in the data sheet */
1102 static void
1103 data_sheet_set_clip (GtkSheet *sheet)
1104 {
1105   int i;
1106   struct casewriter *writer ;
1107   GtkSheetRange range;
1108   PsppireDataStore *ds;
1109   struct case_map *map = NULL;
1110   casenumber max_rows;
1111   size_t max_columns;
1112
1113   ds = PSPPIRE_DATA_STORE (gtk_sheet_get_model (sheet));
1114
1115   gtk_sheet_get_selected_range (sheet, &range);
1116
1117    /* If nothing selected, then use active cell */
1118   if ( range.row0 < 0 || range.col0 < 0 )
1119     {
1120       gint row, col;
1121       gtk_sheet_get_active_cell (sheet, &row, &col);
1122
1123       range.row0 = range.rowi = row;
1124       range.col0 = range.coli = col;
1125     }
1126
1127   /* The sheet range can include cells that do not include data.
1128      Exclude them from the range. */
1129   max_rows = psppire_data_store_get_case_count (ds);
1130   if (range.rowi >= max_rows)
1131     {
1132       if (max_rows == 0)
1133         return;
1134       range.rowi = max_rows - 1;
1135     }
1136   max_columns = dict_get_var_cnt (ds->dict->dict);
1137   if (range.coli >= max_columns)
1138     {
1139       if (max_columns == 0)
1140         return;
1141       range.coli = max_columns - 1;
1142     }
1143
1144   g_return_if_fail (range.rowi >= range.row0);
1145   g_return_if_fail (range.row0 >= 0);
1146   g_return_if_fail (range.coli >= range.col0);
1147   g_return_if_fail (range.col0 >= 0);
1148
1149   /* Destroy any existing clip */
1150   if ( clip_datasheet )
1151     {
1152       casereader_destroy (clip_datasheet);
1153       clip_datasheet = NULL;
1154     }
1155
1156   if ( clip_dict )
1157     {
1158       dict_destroy (clip_dict);
1159       clip_dict = NULL;
1160     }
1161
1162   /* Construct clip dictionary. */
1163   clip_dict = dict_create ();
1164   for (i = range.col0; i <= range.coli; i++)
1165     {
1166       const struct variable *old = dict_get_var (ds->dict->dict, i);
1167       dict_clone_var_assert (clip_dict, old, var_get_name (old));
1168     }
1169
1170   /* Construct clip data. */
1171   map = case_map_by_name (ds->dict->dict, clip_dict);
1172   writer = autopaging_writer_create (dict_get_next_value_idx (clip_dict));
1173   for (i = range.row0; i <= range.rowi ; ++i )
1174     {
1175       struct ccase old;
1176
1177       if (psppire_case_file_get_case (ds->case_file, i, &old))
1178         {
1179           struct ccase new;
1180
1181           case_map_execute (map, &old, &new);
1182           case_destroy (&old);
1183           casewriter_write (writer, &new);
1184         }
1185       else
1186         casewriter_force_error (writer);
1187     }
1188   case_map_destroy (map);
1189
1190   clip_datasheet = casewriter_make_reader (writer);
1191
1192   data_sheet_update_clipboard (sheet);
1193 }
1194
1195 enum {
1196   SELECT_FMT_NULL,
1197   SELECT_FMT_TEXT,
1198   SELECT_FMT_HTML
1199 };
1200
1201
1202 /* Perform data_out for case CC, variable V, appending to STRING */
1203 static void
1204 data_out_g_string (GString *string, const struct variable *v,
1205                    const struct ccase *cc)
1206 {
1207   char *buf ;
1208
1209   const struct fmt_spec *fs = var_get_print_format (v);
1210   const union value *val = case_data (cc, v);
1211   buf = xzalloc (fs->w);
1212
1213   data_out (val, fs, buf);
1214
1215   g_string_append_len (string, buf, fs->w);
1216
1217   g_free (buf);
1218 }
1219
1220 static GString *
1221 clip_to_text (void)
1222 {
1223   casenumber r;
1224   GString *string;
1225
1226   const size_t val_cnt = casereader_get_value_cnt (clip_datasheet);
1227   const casenumber case_cnt = casereader_get_case_cnt (clip_datasheet);
1228   const size_t var_cnt = dict_get_var_cnt (clip_dict);
1229
1230   string = g_string_sized_new (10 * val_cnt * case_cnt);
1231
1232   for (r = 0 ; r < case_cnt ; ++r )
1233     {
1234       int c;
1235       struct ccase cc;
1236       if ( !  casereader_peek (clip_datasheet, r, &cc))
1237         {
1238           g_warning ("Clipboard seems to have inexplicably shrunk");
1239           break;
1240         }
1241
1242       for (c = 0 ; c < var_cnt ; ++c)
1243         {
1244           const struct variable *v = dict_get_var (clip_dict, c);
1245           data_out_g_string (string, v, &cc);
1246           if ( c < val_cnt - 1 )
1247             g_string_append (string, "\t");
1248         }
1249
1250       if ( r < case_cnt)
1251         g_string_append (string, "\n");
1252
1253       case_destroy (&cc);
1254     }
1255
1256   return string;
1257 }
1258
1259
1260 static GString *
1261 clip_to_html (void)
1262 {
1263   casenumber r;
1264   GString *string;
1265
1266   const size_t val_cnt = casereader_get_value_cnt (clip_datasheet);
1267   const casenumber case_cnt = casereader_get_case_cnt (clip_datasheet);
1268   const size_t var_cnt = dict_get_var_cnt (clip_dict);
1269
1270
1271   /* Guestimate the size needed */
1272   string = g_string_sized_new (20 * val_cnt * case_cnt);
1273
1274   g_string_append (string, "<table>\n");
1275   for (r = 0 ; r < case_cnt ; ++r )
1276     {
1277       int c;
1278       struct ccase cc;
1279       if ( !  casereader_peek (clip_datasheet, r, &cc))
1280         {
1281           g_warning ("Clipboard seems to have inexplicably shrunk");
1282           break;
1283         }
1284       g_string_append (string, "<tr>\n");
1285
1286       for (c = 0 ; c < var_cnt ; ++c)
1287         {
1288           const struct variable *v = dict_get_var (clip_dict, c);
1289           g_string_append (string, "<td>");
1290           data_out_g_string (string, v, &cc);
1291           g_string_append (string, "</td>\n");
1292         }
1293
1294       g_string_append (string, "</tr>\n");
1295
1296       case_destroy (&cc);
1297     }
1298   g_string_append (string, "</table>\n");
1299
1300   return string;
1301 }
1302
1303
1304
1305 static void
1306 clipboard_get_cb (GtkClipboard     *clipboard,
1307                   GtkSelectionData *selection_data,
1308                   guint             info,
1309                   gpointer          data)
1310 {
1311   GString *string = NULL;
1312
1313   switch (info)
1314     {
1315     case SELECT_FMT_TEXT:
1316       string = clip_to_text ();
1317       break;
1318     case SELECT_FMT_HTML:
1319       string = clip_to_html ();
1320       break;
1321     default:
1322       g_assert_not_reached ();
1323     }
1324
1325   gtk_selection_data_set (selection_data, selection_data->target,
1326                           8,
1327                           (const guchar *) string->str, string->len);
1328
1329   g_string_free (string, TRUE);
1330 }
1331
1332 static void
1333 clipboard_clear_cb (GtkClipboard *clipboard,
1334                     gpointer data)
1335 {
1336   dict_destroy (clip_dict);
1337   clip_dict = NULL;
1338
1339   casereader_destroy (clip_datasheet);
1340   clip_datasheet = NULL;
1341 }
1342
1343
1344 static const GtkTargetEntry targets[] = {
1345   { "UTF8_STRING",   0, SELECT_FMT_TEXT },
1346   { "STRING",        0, SELECT_FMT_TEXT },
1347   { "TEXT",          0, SELECT_FMT_TEXT },
1348   { "COMPOUND_TEXT", 0, SELECT_FMT_TEXT },
1349   { "text/plain;charset=utf-8", 0, SELECT_FMT_TEXT },
1350   { "text/plain",    0, SELECT_FMT_TEXT },
1351   { "text/html",     0, SELECT_FMT_HTML }
1352 };
1353
1354
1355
1356 static void
1357 data_sheet_update_clipboard (GtkSheet *sheet)
1358 {
1359   GtkClipboard *clipboard =
1360     gtk_widget_get_clipboard (GTK_WIDGET (sheet),
1361                               GDK_SELECTION_CLIPBOARD);
1362
1363   if (!gtk_clipboard_set_with_owner (clipboard, targets,
1364                                      G_N_ELEMENTS (targets),
1365                                      clipboard_get_cb, clipboard_clear_cb,
1366                                      G_OBJECT (sheet)))
1367     clipboard_clear_cb (clipboard, sheet);
1368 }
1369
1370
1371
1372 /* A callback for when the clipboard contents have been received */
1373 static void
1374 data_sheet_contents_received_callback (GtkClipboard *clipboard,
1375                                       GtkSelectionData *sd,
1376                                       gpointer data)
1377 {
1378   gint count = 0;
1379   gint row, column;
1380   gint next_row, next_column;
1381   gint first_column;
1382   char *c;
1383   PsppireDataEditor *data_editor = data;
1384
1385   if ( sd->length < 0 )
1386     return;
1387
1388   if ( sd->type != gdk_atom_intern ("UTF8_STRING", FALSE))
1389     return;
1390
1391   c = (char *) sd->data;
1392
1393   /* Paste text to selected position */
1394   gtk_sheet_get_active_cell (GTK_SHEET (data_editor->data_sheet),
1395                              &row, &column);
1396
1397   g_return_if_fail (row >= 0);
1398   g_return_if_fail (column >= 0);
1399
1400   first_column = column;
1401   next_row = row;
1402   next_column = column;
1403   while (count < sd->length)
1404     {
1405       char *s = c;
1406
1407       row = next_row;
1408       column = next_column;
1409       while (*c != '\t' && *c != '\n' && count < sd->length)
1410         {
1411           c++;
1412           count++;
1413         }
1414       if ( *c == '\t')
1415         {
1416           next_row = row ;
1417           next_column = column + 1;
1418         }
1419       else if ( *c == '\n')
1420         {
1421           next_row = row + 1;
1422           next_column = first_column;
1423         }
1424       *c++ = '\0';
1425       count++;
1426
1427
1428       /* Append some new cases if pasting beyond the last row */
1429       if ( row >= psppire_data_store_get_case_count (data_editor->data_store))
1430         psppire_data_store_insert_new_case (data_editor->data_store, row);
1431
1432       psppire_data_store_set_string (data_editor->data_store, s, row, column);
1433     }
1434 }
1435
1436
1437 static void
1438 on_owner_change (GtkClipboard *clip, GdkEventOwnerChange *event, gpointer data)
1439 {
1440   gint i;
1441   gboolean compatible_target = FALSE;
1442   PsppireDataEditor *de = PSPPIRE_DATA_EDITOR (data);
1443
1444   for (i = 0 ; i < sizeof (targets) / sizeof(targets[0]) ; ++i )
1445     {
1446       GdkAtom atom = gdk_atom_intern (targets[i].target, TRUE);
1447       if ( gtk_clipboard_wait_is_target_available (clip, atom))
1448         {
1449           compatible_target = TRUE;
1450           break;
1451         }
1452     }
1453
1454   g_signal_emit (de, data_editor_signals[DATA_AVAILABLE_CHANGED], 0,
1455                  compatible_target);
1456 }