src/ui/gui/syntax-editor.c

   1 /*
   2     PSPPIRE --- A Graphical User Interface for PSPP
   3     Copyright (C) 2006  Free Software Foundation
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  18     02110-1301, USA. */
  19
  20 #include <config.h>
  21 #include <stdlib.h>
  22 #include <gettext.h>
  23 #define _(msgid) gettext (msgid)
  24 #define N_(msgid) msgid
  25
  26 #include <glade/glade.h>
  27 #include <gtk/gtk.h>
  28 #include <libpspp/message.h>
  29 #include <libpspp/getl.h>
  30 #include "helper.h"
  31 #include "data-editor.h"
  32 #include "about.h"
  33
  34 #include "window-manager.h"
  35
  36 #include <data/dictionary.h>
  37 #include <language/lexer/lexer.h>
  38 #include <language/command.h>
  39 #include <data/procedure.h>
  40 #include "syntax-editor.h"
  41 #include "syntax-editor-source.h"
  42
  43 extern struct source_stream *the_source_stream ;
  44 extern struct dataset *the_dataset;
  45
  46 static gboolean save_editor_to_file (struct syntax_editor *se,
  47                                      const gchar *filename,
  48                                      GError **err);
  49
  50 /* Append ".sps" to FILENAME if necessary.
  51    The returned result must be freed when no longer required.
  52  */
  53 static gchar *
  54 append_suffix (const gchar *filename)
  55 {
  56   if ( ! g_str_has_suffix (filename, ".sps" ) &&
  57        ! g_str_has_suffix (filename, ".SPS" ) )
  58     {
  59       return g_strdup_printf ("%s.sps", filename);
  60     }
  61
  62   return strdup (filename);
  63 }
  64
  65 /* If the buffer's modified flag is set, then save it, and close the window.
  66    Otherwise just close the window.
  67 */
  68 static void
  69 save_if_modified (struct syntax_editor *se)
  70 {
  71   struct editor_window *e = (struct editor_window *) se;
  72   if ( TRUE == gtk_text_buffer_get_modified (se->buffer))
  73     {
  74       gint response;
  75       GtkWidget *dialog =
  76         gtk_message_dialog_new (GTK_WINDOW (e->window),
  77                                 GTK_DIALOG_MODAL,
  78                                 GTK_MESSAGE_QUESTION,
  79                                 GTK_BUTTONS_NONE,
  80                                 _("Save contents of syntax editor to %s?"),
  81                                 e->name
  82                                 );
  83
  84       gtk_dialog_add_button  (GTK_DIALOG (dialog),
  85                               GTK_STOCK_YES,
  86                               GTK_RESPONSE_ACCEPT);
  87       gtk_dialog_add_button  (GTK_DIALOG (dialog),
  88                               GTK_STOCK_NO,
  89                               GTK_RESPONSE_REJECT);
  90       gtk_dialog_add_button  (GTK_DIALOG (dialog),
  91                               GTK_STOCK_CANCEL,
  92                               GTK_RESPONSE_CANCEL);
  93
  94
  95       response = gtk_dialog_run (GTK_DIALOG (dialog));
  96
  97       gtk_widget_destroy (dialog);
  98
  99       if ( response == GTK_RESPONSE_ACCEPT )
 100         {
 101           GError *err = NULL;
 102
 103           if ( ! save_editor_to_file (se, e->name, &err) )
 104             {
 105               msg (ME, err->message);
 106               g_error_free (err);
 107             }
 108         }
 109
 110       if ( response == GTK_RESPONSE_CANCEL )
 111         return ;
 112     }
 113
 114   gtk_widget_destroy (GTK_WIDGET (e->window));
 115 }
 116
 117 /* Callback for the File->SaveAs menuitem */
 118 static void
 119 on_syntax_save_as (GtkMenuItem *menuitem, gpointer user_data)
 120 {
 121   GtkFileFilter *filter;
 122   gint response;
 123   struct syntax_editor *se = user_data;
 124   struct editor_window *e = user_data;
 125
 126   GtkWidget *dialog =
 127     gtk_file_chooser_dialog_new (_("Save Syntax"),
 128                                  GTK_WINDOW (e->window),
 129                                  GTK_FILE_CHOOSER_ACTION_SAVE,
 130                                  GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
 131                                  GTK_STOCK_SAVE,   GTK_RESPONSE_ACCEPT,
 132                                  NULL);
 133
 134   filter = gtk_file_filter_new ();
 135   gtk_file_filter_set_name (filter, _("Syntax Files (*.sps) "));
 136   gtk_file_filter_add_pattern (filter, "*.sps");
 137   gtk_file_filter_add_pattern (filter, "*.SPS");
 138   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
 139
 140   filter = gtk_file_filter_new ();
 141   gtk_file_filter_set_name (filter, _("All Files"));
 142   gtk_file_filter_add_pattern (filter, "*");
 143   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
 144
 145   gtk_file_chooser_set_do_overwrite_confirmation (GTK_FILE_CHOOSER (dialog),
 146                                                   TRUE);
 147   response = gtk_dialog_run (GTK_DIALOG (dialog));
 148
 149   if ( response == GTK_RESPONSE_ACCEPT )
 150     {
 151       GError *err = NULL;
 152       char *filename =
 153         gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (dialog) );
 154
 155       if ( save_editor_to_file (se, filename, &err) )
 156         {
 157           g_free (e->name);
 158           e->name = g_strdup (filename);
 159         }
 160       else
 161         {
 162           msg ( ME, err->message );
 163           g_error_free (err);
 164         }
 165
 166       free (filename);
 167     }
 168
 169   gtk_widget_destroy ( dialog );
 170 }
 171
 172 /* Callback for the File->Save menuitem */
 173 static void
 174 on_syntax_save (GtkMenuItem *menuitem, gpointer user_data)
 175 {
 176   struct syntax_editor *se = user_data;
 177   struct editor_window *e = user_data;
 178
 179   if ( e->name == NULL )
 180     on_syntax_save_as (menuitem, user_data);
 181   else
 182     {
 183       GError *err = NULL;
 184       save_editor_to_file (se, e->name, &err);
 185       if ( err )
 186         {
 187           msg (ME, err->message);
 188           g_error_free (err);
 189         }
 190     }
 191 }
 192
 193
 194 /* Callback for the "delete" action (clicking the x on the top right
 195    hand corner of the window) */
 196 static gboolean
 197 on_delete (GtkWidget *w, GdkEvent *event, gpointer user_data)
 198 {
 199   struct syntax_editor *se = user_data;
 200   save_if_modified (se);
 201   return TRUE;
 202 }
 203
 204
 205 /* Callback for the File->Quit menuitem */
 206 static gboolean
 207 on_quit (GtkMenuItem *menuitem, gpointer    user_data)
 208 {
 209   struct syntax_editor *se = user_data;
 210   save_if_modified (se);
 211   return FALSE;
 212 }
 213
 214 static void
 215 editor_execute_syntax (const struct syntax_editor *se, GtkTextIter start,
 216                 GtkTextIter stop)
 217 {
 218   execute_syntax (create_syntax_editor_source (se, start, stop));
 219 }
 220
 221 /* Parse and execute all the text in the buffer */
 222 static void
 223 on_run_all (GtkMenuItem *menuitem, gpointer user_data)
 224 {
 225   GtkTextIter begin, end;
 226   struct syntax_editor *se = user_data;
 227
 228   gtk_text_buffer_get_iter_at_offset (se->buffer, &begin, 0);
 229   gtk_text_buffer_get_iter_at_offset (se->buffer, &end, -1);
 230
 231   editor_execute_syntax (se, begin, end);
 232 }
 233
 234 /* Parse and execute the currently selected text */
 235 static void
 236 on_run_selection (GtkMenuItem *menuitem, gpointer user_data)
 237 {
 238   GtkTextIter begin, end;
 239   struct syntax_editor *se = user_data;
 240
 241   if ( gtk_text_buffer_get_selection_bounds (se->buffer, &begin, &end) )
 242     editor_execute_syntax (se, begin, end);
 243 }
 244
 245
 246 /* Parse and execute the current line */
 247 static void
 248 on_run_current_line (GtkMenuItem *menuitem, gpointer user_data)
 249 {
 250   GtkTextIter begin, end;
 251   GtkTextIter here;
 252   gint line;
 253
 254   struct syntax_editor *se = user_data;
 255
 256   /* Get the current line */
 257   gtk_text_buffer_get_iter_at_mark (se->buffer,
 258                                     &here,
 259                                     gtk_text_buffer_get_insert (se->buffer)
 260                                     );
 261
 262   line = gtk_text_iter_get_line (&here) ;
 263
 264   /* Now set begin and end to the start of this line, and start of
 265      following line respectively */
 266   gtk_text_buffer_get_iter_at_line (se->buffer, &begin, line);
 267   gtk_text_buffer_get_iter_at_line (se->buffer, &end, line + 1);
 268
 269   editor_execute_syntax (se, begin, end);
 270 }
 271
 272
 273
 274 /* Parse and execute the from the current line, to the end of the
 275    buffer */
 276 static void
 277 on_run_to_end (GtkMenuItem *menuitem, gpointer user_data)
 278 {
 279   GtkTextIter begin, end;
 280   GtkTextIter here;
 281   gint line;
 282
 283   struct syntax_editor *se = user_data;
 284
 285   /* Get the current line */
 286   gtk_text_buffer_get_iter_at_mark (se->buffer,
 287                                     &here,
 288                                     gtk_text_buffer_get_insert (se->buffer)
 289                                     );
 290
 291   line = gtk_text_iter_get_line (&here) ;
 292
 293   /* Now set begin and end to the start of this line, and end of buffer
 294      respectively */
 295   gtk_text_buffer_get_iter_at_line (se->buffer, &begin, line);
 296   gtk_text_buffer_get_iter_at_line (se->buffer, &end, -1);
 297
 298   editor_execute_syntax (se, begin, end);
 299 }
 300
 301
 302
 303
 304 /*
 305   Create a new syntax editor with NAME.
 306   If NAME is NULL, a name will be automatically assigned
 307 */
 308 struct syntax_editor *
 309 new_syntax_editor (void)
 310 {
 311   GladeXML *xml =
 312     glade_xml_new (PKGDATADIR "/syntax-editor.glade", NULL, NULL);
 313
 314   GtkWidget *text_view;
 315   struct syntax_editor *se ;
 316   struct editor_window *e;
 317
 318   connect_help (xml);
 319
 320   se = g_malloc (sizeof (*se));
 321
 322   e = (struct editor_window *)se;
 323
 324   e->window = GTK_WINDOW (get_widget_assert (xml, "syntax_editor"));
 325   text_view = get_widget_assert (xml, "syntax_text_view");
 326   se->buffer = gtk_text_view_get_buffer (GTK_TEXT_VIEW (text_view));
 327   se->lexer = lex_create (the_source_stream);
 328
 329   g_signal_connect (get_widget_assert (xml,"file_new_syntax"),
 330                     "activate",
 331                     G_CALLBACK (new_syntax_window),
 332                     e->window);
 333
 334   g_signal_connect (get_widget_assert (xml,"file_open_syntax"),
 335                     "activate",
 336                     G_CALLBACK (open_syntax_window),
 337                     e->window);
 338
 339   g_signal_connect (get_widget_assert (xml,"file_new_data"),
 340                     "activate",
 341                     G_CALLBACK (new_data_window),
 342                     e->window);
 343
 344   g_signal_connect (get_widget_assert (xml,"file_open_data"),
 345                     "activate",
 346                     G_CALLBACK (open_data_window),
 347                     e->window);
 348
 349
 350   g_signal_connect (get_widget_assert (xml,"help_about"),
 351                     "activate",
 352                     G_CALLBACK (about_new),
 353                     e->window);
 354
 355   g_signal_connect (get_widget_assert (xml,"help_reference"),
 356                     "activate",
 357                     G_CALLBACK (reference_manual),
 358                     NULL);
 359
 360
 361   g_signal_connect (get_widget_assert (xml, "file_save"),
 362                     "activate",
 363                     G_CALLBACK (on_syntax_save),
 364                     se);
 365
 366   g_signal_connect (get_widget_assert (xml, "file_save_as"),
 367                     "activate",
 368                     G_CALLBACK (on_syntax_save_as),
 369                     se);
 370
 371
 372   g_signal_connect (get_widget_assert (xml,"file_quit"),
 373                     "activate",
 374                     G_CALLBACK (on_quit),
 375                     se);
 376
 377
 378   g_signal_connect (get_widget_assert (xml,"run_all"),
 379                     "activate",
 380                     G_CALLBACK (on_run_all),
 381                     se);
 382
 383
 384   g_signal_connect (get_widget_assert (xml,"run_selection"),
 385                     "activate",
 386                     G_CALLBACK (on_run_selection),
 387                     se);
 388
 389   g_signal_connect (get_widget_assert (xml,"run_current_line"),
 390                     "activate",
 391                     G_CALLBACK (on_run_current_line),
 392                     se);
 393
 394
 395   g_signal_connect (get_widget_assert (xml,"run_to_end"),
 396                     "activate",
 397                     G_CALLBACK (on_run_to_end),
 398                     se);
 399
 400
 401   g_signal_connect (get_widget_assert (xml,"windows_minimise_all"),
 402                     "activate",
 403                     G_CALLBACK (minimise_all_windows),
 404                     NULL);
 405
 406
 407
 408   g_object_unref (xml);
 409
 410   g_signal_connect (e->window, "delete-event",
 411                     G_CALLBACK (on_delete), se);
 412
 413
 414
 415   return se;
 416 }
 417
 418 /*
 419    Callback for the File->New->Syntax menuitem
 420 */
 421 void
 422 new_syntax_window (GtkMenuItem     *menuitem,
 423                    gpointer         user_data)
 424 {
 425   window_create (WINDOW_SYNTAX, NULL);
 426 }
 427
 428
 429 /*
 430   Save BUFFER to the file called FILENAME.
 431   If successful, clears the buffer's modified flag
 432 */
 433 static gboolean
 434 save_editor_to_file (struct syntax_editor *se,
 435                      const gchar *filename,
 436                      GError **err)
 437 {
 438   GtkTextBuffer *buffer = se->buffer;
 439   gboolean result ;
 440   GtkTextIter start, stop;
 441   gchar *text;
 442
 443   gchar *suffixedname;
 444   gchar *glibfilename;
 445   g_assert (filename);
 446
 447   suffixedname = append_suffix (filename);
 448
 449   glibfilename = g_filename_from_utf8 (suffixedname, -1, 0, 0, err);
 450
 451   g_free ( suffixedname);
 452
 453   if ( ! glibfilename )
 454     return FALSE;
 455
 456   gtk_text_buffer_get_iter_at_line (buffer, &start, 0);
 457   gtk_text_buffer_get_iter_at_offset (buffer, &stop, -1);
 458
 459   text = gtk_text_buffer_get_text (buffer, &start, &stop, FALSE);
 460
 461   result =  g_file_set_contents (glibfilename, text, -1, err);
 462
 463   if ( result )
 464     {
 465       window_set_name_from_filename ((struct editor_window *) se, filename);
 466       gtk_text_buffer_set_modified (buffer, FALSE);
 467     }
 468
 469   return result;
 470 }
 471
 472
 473 /*
 474   Loads the buffer from the file called FILENAME
 475 */
 476 static gboolean
 477 load_editor_from_file (struct syntax_editor *se,
 478                        const gchar *filename,
 479                        GError **err)
 480 {
 481   GtkTextBuffer *buffer = se->buffer;
 482   gchar *text;
 483   GtkTextIter iter;
 484
 485   gchar *glibfilename = g_filename_from_utf8 (filename, -1, 0, 0, err);
 486
 487   if ( ! glibfilename )
 488     return FALSE;
 489
 490   /* FIXME: What if it's a very big file ? */
 491   if ( ! g_file_get_contents (glibfilename, &text, NULL, err) )
 492     {
 493       g_free (glibfilename);
 494       return FALSE;
 495     }
 496   g_free (glibfilename);
 497
 498   gtk_text_buffer_get_iter_at_line (buffer, &iter, 0);
 499
 500   gtk_text_buffer_insert (buffer, &iter, text, -1);
 501
 502   window_set_name_from_filename ((struct editor_window *)se, filename);
 503   gtk_text_buffer_set_modified (buffer, FALSE);
 504
 505   return TRUE;
 506 }
 507
 508
 509 /* Callback for the File->Open->Syntax menuitem */
 510 void
 511 open_syntax_window (GtkMenuItem *menuitem, gpointer parent)
 512 {
 513   GtkFileFilter *filter;
 514   gint response;
 515
 516   GtkWidget *dialog =
 517     gtk_file_chooser_dialog_new (_("Open Syntax"),
 518                                  GTK_WINDOW (parent),
 519                                  GTK_FILE_CHOOSER_ACTION_OPEN,
 520                                  GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
 521                                  GTK_STOCK_OPEN,   GTK_RESPONSE_ACCEPT,
 522                                  NULL);
 523
 524   filter = gtk_file_filter_new ();
 525   gtk_file_filter_set_name (filter, _("Syntax Files (*.sps) "));
 526   gtk_file_filter_add_pattern (filter, "*.sps");
 527   gtk_file_filter_add_pattern (filter, "*.SPS");
 528   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
 529
 530   filter = gtk_file_filter_new ();
 531   gtk_file_filter_set_name (filter, _("All Files"));
 532   gtk_file_filter_add_pattern (filter, "*");
 533   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
 534
 535   response = gtk_dialog_run (GTK_DIALOG (dialog));
 536
 537   if (response == GTK_RESPONSE_ACCEPT)
 538     {
 539       const char *file_name = gtk_file_chooser_get_filename
 540         (GTK_FILE_CHOOSER (dialog));
 541
 542       struct syntax_editor *se = (struct syntax_editor *)
 543         window_create (WINDOW_SYNTAX, file_name);
 544
 545       load_editor_from_file (se, file_name, NULL);
 546     }
 547
 548   gtk_widget_destroy (dialog);
 549 }
 550