Refactor common code in dialog implementations
[pspp] / src / ui / gui / psppire-syntax-window.c
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyright (C) 2008  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 #include <config.h>
18
19 #include <gtk/gtksignal.h>
20 #include <gtk/gtkbox.h>
21 #include <glade/glade.h>
22 #include "helper.h"
23
24 #include <libpspp/message.h>
25 #include <stdlib.h>
26
27 #include "psppire-syntax-window.h"
28
29 #include "psppire-data-window.h"
30 #include "psppire-window-register.h"
31 #include "about.h"
32 #include "psppire-syntax-window.h"
33 #include "syntax-editor-source.h"
34 #include <language/lexer/lexer.h>
35
36 #include <gettext.h>
37 #define _(msgid) gettext (msgid)
38 #define N_(msgid) msgid
39
40 static void psppire_syntax_window_base_finalize (PsppireSyntaxWindowClass *, gpointer);
41 static void psppire_syntax_window_base_init     (PsppireSyntaxWindowClass *class);
42 static void psppire_syntax_window_class_init    (PsppireSyntaxWindowClass *class);
43 static void psppire_syntax_window_init          (PsppireSyntaxWindow      *syntax_editor);
44
45 GType
46 psppire_syntax_window_get_type (void)
47 {
48   static GType psppire_syntax_window_type = 0;
49
50   if (!psppire_syntax_window_type)
51     {
52       static const GTypeInfo psppire_syntax_window_info =
53       {
54         sizeof (PsppireSyntaxWindowClass),
55         (GBaseInitFunc) psppire_syntax_window_base_init,
56         (GBaseFinalizeFunc) psppire_syntax_window_base_finalize,
57         (GClassInitFunc)psppire_syntax_window_class_init,
58         (GClassFinalizeFunc) NULL,
59         NULL,
60         sizeof (PsppireSyntaxWindow),
61         0,
62         (GInstanceInitFunc) psppire_syntax_window_init,
63       };
64
65       psppire_syntax_window_type =
66         g_type_register_static (PSPPIRE_WINDOW_TYPE, "PsppireSyntaxWindow",
67                                 &psppire_syntax_window_info, 0);
68     }
69
70   return psppire_syntax_window_type;
71 }
72
73 static void
74 psppire_syntax_window_finalize (GObject *object)
75 {
76   GObjectClass *class = G_OBJECT_GET_CLASS (object);
77
78   GObjectClass *parent_class = g_type_class_peek_parent (class);
79
80   if (G_OBJECT_CLASS (parent_class)->finalize)
81     (*G_OBJECT_CLASS (parent_class)->finalize) (object);
82 }
83
84
85 static void
86 psppire_syntax_window_class_init (PsppireSyntaxWindowClass *class)
87 {
88 }
89
90
91 static void
92 psppire_syntax_window_base_init (PsppireSyntaxWindowClass *class)
93 {
94   GObjectClass *object_class = G_OBJECT_CLASS (class);
95
96   object_class->finalize = psppire_syntax_window_finalize;
97 }
98
99
100
101 static void
102 psppire_syntax_window_base_finalize (PsppireSyntaxWindowClass *class,
103                                      gpointer class_data)
104 {
105 }
106
107
108 static void
109 editor_execute_syntax (const PsppireSyntaxWindow *se, GtkTextIter start,
110                 GtkTextIter stop)
111 {
112   execute_syntax (create_syntax_editor_source (se->buffer, start, stop));
113 }
114
115
116 /* Parse and execute all the text in the buffer */
117 static void
118 on_run_all (GtkMenuItem *menuitem, gpointer user_data)
119 {
120   GtkTextIter begin, end;
121   PsppireSyntaxWindow *se = PSPPIRE_SYNTAX_WINDOW (user_data);
122
123   gtk_text_buffer_get_iter_at_offset (se->buffer, &begin, 0);
124   gtk_text_buffer_get_iter_at_offset (se->buffer, &end, -1);
125
126   editor_execute_syntax (se, begin, end);
127 }
128
129 /* Parse and execute the currently selected text */
130 static void
131 on_run_selection (GtkMenuItem *menuitem, gpointer user_data)
132 {
133   GtkTextIter begin, end;
134   PsppireSyntaxWindow *se = PSPPIRE_SYNTAX_WINDOW (user_data);
135
136   if ( gtk_text_buffer_get_selection_bounds (se->buffer, &begin, &end) )
137     editor_execute_syntax (se, begin, end);
138 }
139
140
141 /* Parse and execute the from the current line, to the end of the
142    buffer */
143 static void
144 on_run_to_end (GtkMenuItem *menuitem, gpointer user_data)
145 {
146   GtkTextIter begin, end;
147   GtkTextIter here;
148   gint line;
149
150   PsppireSyntaxWindow *se = PSPPIRE_SYNTAX_WINDOW (user_data);
151
152   /* Get the current line */
153   gtk_text_buffer_get_iter_at_mark (se->buffer,
154                                     &here,
155                                     gtk_text_buffer_get_insert (se->buffer)
156                                     );
157
158   line = gtk_text_iter_get_line (&here) ;
159
160   /* Now set begin and end to the start of this line, and end of buffer
161      respectively */
162   gtk_text_buffer_get_iter_at_line (se->buffer, &begin, line);
163   gtk_text_buffer_get_iter_at_line (se->buffer, &end, -1);
164
165   editor_execute_syntax (se, begin, end);
166 }
167
168
169
170 /* Parse and execute the current line */
171 static void
172 on_run_current_line (GtkMenuItem *menuitem, gpointer user_data)
173 {
174   GtkTextIter begin, end;
175   GtkTextIter here;
176   gint line;
177
178   PsppireSyntaxWindow *se = PSPPIRE_SYNTAX_WINDOW (user_data);
179
180   /* Get the current line */
181   gtk_text_buffer_get_iter_at_mark (se->buffer,
182                                     &here,
183                                     gtk_text_buffer_get_insert (se->buffer)
184                                     );
185
186   line = gtk_text_iter_get_line (&here) ;
187
188   /* Now set begin and end to the start of this line, and start of
189      following line respectively */
190   gtk_text_buffer_get_iter_at_line (se->buffer, &begin, line);
191   gtk_text_buffer_get_iter_at_line (se->buffer, &end, line + 1);
192
193   editor_execute_syntax (se, begin, end);
194 }
195
196
197
198 /* Append ".sps" to FILENAME if necessary.
199    The returned result must be freed when no longer required.
200  */
201 static gchar *
202 append_suffix (const gchar *filename)
203 {
204   if ( ! g_str_has_suffix (filename, ".sps" ) &&
205        ! g_str_has_suffix (filename, ".SPS" ) )
206     {
207       return g_strdup_printf ("%s.sps", filename);
208     }
209
210   return strdup (filename);
211 }
212
213 /*
214   Save BUFFER to the file called FILENAME.
215   If successful, clears the buffer's modified flag
216 */
217 static gboolean
218 save_editor_to_file (PsppireSyntaxWindow *se,
219                      const gchar *filename,
220                      GError **err)
221 {
222   GtkTextBuffer *buffer = se->buffer;
223   gboolean result ;
224   GtkTextIter start, stop;
225   gchar *text;
226
227   gchar *suffixedname;
228   gchar *glibfilename;
229   g_assert (filename);
230
231   suffixedname = append_suffix (filename);
232
233   glibfilename = g_filename_from_utf8 (suffixedname, -1, 0, 0, err);
234
235   g_free ( suffixedname);
236
237   if ( ! glibfilename )
238     return FALSE;
239
240   gtk_text_buffer_get_iter_at_line (buffer, &start, 0);
241   gtk_text_buffer_get_iter_at_offset (buffer, &stop, -1);
242
243   text = gtk_text_buffer_get_text (buffer, &start, &stop, FALSE);
244
245   result =  g_file_set_contents (glibfilename, text, -1, err);
246
247   if ( result )
248     {
249       psppire_window_set_filename (PSPPIRE_WINDOW (se), filename);
250       gtk_text_buffer_set_modified (buffer, FALSE);
251     }
252
253   return result;
254 }
255
256 /* If the buffer's modified flag is set, then save it, and close the window.
257    Otherwise just close the window.
258 */
259 static void
260 save_if_modified (PsppireSyntaxWindow *se)
261 {
262
263   if ( TRUE == gtk_text_buffer_get_modified (se->buffer))
264     {
265       gint response;
266       GtkWidget *dialog;
267
268       const gchar *filename = psppire_window_get_filename (PSPPIRE_WINDOW (se));
269
270       g_return_if_fail (filename != NULL);
271
272       dialog =
273         gtk_message_dialog_new (GTK_WINDOW (se),
274                                 GTK_DIALOG_MODAL,
275                                 GTK_MESSAGE_QUESTION,
276                                 GTK_BUTTONS_NONE,
277                                 _("Save contents of syntax editor to %s?"),
278                                 filename);
279
280       gtk_dialog_add_button  (GTK_DIALOG (dialog),
281                               GTK_STOCK_YES,
282                               GTK_RESPONSE_ACCEPT);
283       gtk_dialog_add_button  (GTK_DIALOG (dialog),
284                               GTK_STOCK_NO,
285                               GTK_RESPONSE_REJECT);
286       gtk_dialog_add_button  (GTK_DIALOG (dialog),
287                               GTK_STOCK_CANCEL,
288                               GTK_RESPONSE_CANCEL);
289
290
291       response = gtk_dialog_run (GTK_DIALOG (dialog));
292
293       gtk_widget_destroy (dialog);
294
295       if ( response == GTK_RESPONSE_ACCEPT )
296         {
297           GError *err = NULL;
298
299           if ( ! save_editor_to_file (se, filename, &err) )
300             {
301               msg (ME, err->message);
302               g_error_free (err);
303             }
304         }
305
306       if ( response == GTK_RESPONSE_CANCEL )
307         return ;
308     }
309
310   gtk_widget_destroy (GTK_WIDGET (se));
311 }
312
313 /* Callback for the File->SaveAs menuitem */
314 static void
315 on_syntax_save_as (GtkMenuItem *menuitem, gpointer user_data)
316 {
317   GtkFileFilter *filter;
318   gint response;
319
320   PsppireSyntaxWindow *se = PSPPIRE_SYNTAX_WINDOW (user_data);
321
322   GtkWidget *dialog =
323     gtk_file_chooser_dialog_new (_("Save Syntax"),
324                                  GTK_WINDOW (se),
325                                  GTK_FILE_CHOOSER_ACTION_SAVE,
326                                  GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
327                                  GTK_STOCK_SAVE,   GTK_RESPONSE_ACCEPT,
328                                  NULL);
329
330   filter = gtk_file_filter_new ();
331   gtk_file_filter_set_name (filter, _("Syntax Files (*.sps) "));
332   gtk_file_filter_add_pattern (filter, "*.sps");
333   gtk_file_filter_add_pattern (filter, "*.SPS");
334   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
335
336   filter = gtk_file_filter_new ();
337   gtk_file_filter_set_name (filter, _("All Files"));
338   gtk_file_filter_add_pattern (filter, "*");
339   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
340
341   gtk_file_chooser_set_do_overwrite_confirmation (GTK_FILE_CHOOSER (dialog),
342                                                   TRUE);
343   response = gtk_dialog_run (GTK_DIALOG (dialog));
344
345   if ( response == GTK_RESPONSE_ACCEPT )
346     {
347       GError *err = NULL;
348       char *filename =
349         gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (dialog) );
350
351       if ( ! save_editor_to_file (se, filename, &err) )
352         {
353           msg ( ME, err->message );
354           g_error_free (err);
355         }
356
357       free (filename);
358     }
359
360   gtk_widget_destroy (dialog);
361 }
362
363
364 /* Callback for the File->Save menuitem */
365 static void
366 on_syntax_save (GtkMenuItem *menuitem, gpointer user_data)
367 {
368   PsppireSyntaxWindow *se = PSPPIRE_SYNTAX_WINDOW (user_data);
369   const gchar *filename = psppire_window_get_filename (PSPPIRE_WINDOW (se));
370
371
372   if ( filename == NULL )
373     on_syntax_save_as (menuitem, se);
374   else
375     {
376       GError *err = NULL;
377       save_editor_to_file (se, filename, &err);
378       if ( err )
379         {
380           msg (ME, err->message);
381           g_error_free (err);
382         }
383     }
384 }
385
386
387 /* Callback for the File->Quit menuitem */
388 static gboolean
389 on_quit (GtkMenuItem *menuitem, gpointer    user_data)
390 {
391   PsppireSyntaxWindow *se = PSPPIRE_SYNTAX_WINDOW (user_data);
392   save_if_modified (se);
393   return FALSE;
394 }
395
396
397 /* Callback for the "delete" action (clicking the x on the top right
398    hand corner of the window) */
399 static gboolean
400 on_delete (GtkWidget *w, GdkEvent *event, gpointer user_data)
401 {
402   PsppireSyntaxWindow *se = PSPPIRE_SYNTAX_WINDOW (user_data);
403
404   save_if_modified (se);
405   return TRUE;
406 }
407
408
409 void
410 create_syntax_window (void)
411 {
412   GtkWidget *w = psppire_syntax_window_new ();
413   gtk_widget_show (w);
414 }
415
416 /* Callback for the File->Open->Syntax menuitem */
417 void
418 open_syntax_window (GtkMenuItem *menuitem, gpointer parent)
419 {
420   GtkFileFilter *filter;
421   gint response;
422
423   GtkWidget *dialog =
424     gtk_file_chooser_dialog_new (_("Open Syntax"),
425                                  GTK_WINDOW (parent),
426                                  GTK_FILE_CHOOSER_ACTION_OPEN,
427                                  GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
428                                  GTK_STOCK_OPEN,   GTK_RESPONSE_ACCEPT,
429                                  NULL);
430
431   filter = gtk_file_filter_new ();
432   gtk_file_filter_set_name (filter, _("Syntax Files (*.sps) "));
433   gtk_file_filter_add_pattern (filter, "*.sps");
434   gtk_file_filter_add_pattern (filter, "*.SPS");
435   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
436
437   filter = gtk_file_filter_new ();
438   gtk_file_filter_set_name (filter, _("All Files"));
439   gtk_file_filter_add_pattern (filter, "*");
440   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
441
442   response = gtk_dialog_run (GTK_DIALOG (dialog));
443
444   if (response == GTK_RESPONSE_ACCEPT)
445     {
446       const char *file_name = gtk_file_chooser_get_filename
447         (GTK_FILE_CHOOSER (dialog));
448
449       GtkWidget *se = psppire_syntax_window_new ();
450
451       if ( psppire_syntax_window_load_from_file (PSPPIRE_SYNTAX_WINDOW (se), file_name, NULL) )
452 #if RECENT_LISTS_AVAILABLE
453       {
454         GtkRecentManager *manager = gtk_recent_manager_get_default();
455         gchar *uri = g_filename_to_uri (file_name, NULL, NULL);
456
457         gtk_recent_manager_remove_item (manager, uri, NULL);
458         if ( ! gtk_recent_manager_add_item (manager, uri))
459           g_warning ("Could not add item %s to recent list\n",uri);
460
461         g_free (uri);
462       }
463 #else
464       ;
465 #endif
466       gtk_widget_show (se);
467     }
468
469   gtk_widget_destroy (dialog);
470 }
471
472
473
474 extern struct source_stream *the_source_stream ;
475
476 static void
477 psppire_syntax_window_init (PsppireSyntaxWindow *window)
478 {
479   GladeXML *xml = XML_NEW ("syntax-editor.glade");
480   GtkWidget *box = gtk_vbox_new (FALSE, 0);
481   
482   GtkWidget *menubar = get_widget_assert (xml, "menubar2");
483   GtkWidget *sw = get_widget_assert (xml, "scrolledwindow8");
484   GtkWidget *sb = get_widget_assert (xml, "statusbar2");
485
486   GtkWidget *text_view = get_widget_assert (xml, "syntax_text_view");
487   window->buffer = gtk_text_view_get_buffer (GTK_TEXT_VIEW (text_view));
488   window->lexer = lex_create (the_source_stream);
489
490   connect_help (xml);
491
492   gtk_container_add (GTK_CONTAINER (window), box);
493
494   g_object_ref (menubar);
495   gtk_widget_unparent (menubar);
496
497   g_object_ref (sw);
498   gtk_widget_unparent (sw);
499
500   g_object_ref (sb);
501   gtk_widget_unparent (sb);
502
503
504   gtk_box_pack_start (GTK_BOX (box), menubar, FALSE, TRUE, 0);
505   gtk_box_pack_start (GTK_BOX (box), sw, TRUE, TRUE, 0);
506   gtk_box_pack_start (GTK_BOX (box), sb, FALSE, TRUE, 0);
507
508   gtk_widget_show_all (box);
509
510   g_signal_connect (get_widget_assert (xml,"file_new_syntax"),
511                     "activate",
512                     G_CALLBACK (create_syntax_window),
513                     NULL);
514
515   g_signal_connect (get_widget_assert (xml,"file_open_syntax"),
516                     "activate",
517                     G_CALLBACK (open_syntax_window),
518                     window);
519
520
521   g_signal_connect (get_widget_assert (xml,"file_new_data"),
522                     "activate",
523                     G_CALLBACK (create_data_window),
524                     window);
525
526   g_signal_connect (get_widget_assert (xml,"help_about"),
527                     "activate",
528                     G_CALLBACK (about_new),
529                     window);
530
531   g_signal_connect (get_widget_assert (xml,"help_reference"),
532                     "activate",
533                     G_CALLBACK (reference_manual),
534                     NULL);
535
536   g_signal_connect (get_widget_assert (xml, "file_save"),
537                     "activate",
538                     G_CALLBACK (on_syntax_save),
539                     window);
540
541   g_signal_connect (get_widget_assert (xml, "file_save_as"),
542                     "activate",
543                     G_CALLBACK (on_syntax_save_as),
544                     window);
545
546   g_signal_connect (get_widget_assert (xml,"file_quit"),
547                     "activate",
548                     G_CALLBACK (on_quit),
549                     window);
550
551   g_signal_connect (get_widget_assert (xml,"run_all"),
552                     "activate",
553                     G_CALLBACK (on_run_all),
554                     window);
555
556
557   g_signal_connect (get_widget_assert (xml,"run_selection"),
558                     "activate",
559                     G_CALLBACK (on_run_selection),
560                     window);
561
562   g_signal_connect (get_widget_assert (xml,"run_current_line"),
563                     "activate",
564                     G_CALLBACK (on_run_current_line),
565                     window);
566
567   g_signal_connect (get_widget_assert (xml,"run_to_end"),
568                     "activate",
569                     G_CALLBACK (on_run_to_end),
570                     window);
571
572   g_signal_connect (get_widget_assert (xml,"windows_minimise_all"),
573                     "activate",
574                     G_CALLBACK (psppire_window_minimise_all), NULL);
575
576   PSPPIRE_WINDOW (window)->menu = GTK_MENU_SHELL (get_widget_assert (xml,"windows_menu"));
577
578   g_object_unref (xml);
579
580   g_signal_connect (window, "delete-event",
581                     G_CALLBACK (on_delete), window);
582 }
583
584
585 GtkWidget*
586 psppire_syntax_window_new (void)
587 {
588   return GTK_WIDGET (g_object_new (psppire_syntax_window_get_type (),
589                                    "usage", PSPPIRE_WINDOW_USAGE_SYNTAX,
590                                    NULL));
591 }
592
593
594 /*
595   Loads the buffer from the file called FILENAME
596 */
597 gboolean
598 psppire_syntax_window_load_from_file (PsppireSyntaxWindow *se,
599                                       const gchar *filename,
600                                       GError **err)
601 {
602   gchar *text;
603   GtkTextIter iter;
604
605   gchar *glibfilename = g_filename_from_utf8 (filename, -1, 0, 0, err);
606
607   if ( ! glibfilename )
608     return FALSE;
609
610   /* FIXME: What if it's a very big file ? */
611   if ( ! g_file_get_contents (glibfilename, &text, NULL, err) )
612     {
613       g_free (glibfilename);
614       return FALSE;
615     }
616   g_free (glibfilename);
617
618   gtk_text_buffer_get_iter_at_line (se->buffer, &iter, 0);
619
620   gtk_text_buffer_insert (se->buffer, &iter, text, -1);
621
622   psppire_window_set_filename (PSPPIRE_WINDOW (se), filename);
623
624   gtk_text_buffer_set_modified (se->buffer, FALSE);
625
626   return TRUE;
627 }
628