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