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 execute_syntax (const struct syntax_editor *se, GtkTextIter start,
 216                 GtkTextIter stop)
 217 {
 218   g_return_if_fail (proc_has_source (the_dataset));
 219
 220   getl_append_source (the_source_stream,
 221                       create_syntax_editor_source (se, start, stop));
 222   for (;;)
 223     {
 224       const struct dictionary *dict = dataset_dict (the_dataset);
 225       int result = cmd_parse (se->lexer, the_dataset,
 226                               dict_get_var_cnt (dict) > 0 ?
 227                               CMD_STATE_DATA : CMD_STATE_INITIAL);
 228       if (result == CMD_EOF || result == CMD_FINISH)
 229         break;
 230     }
 231 }
 232
 233 /* Parse and execute all the text in the buffer */
 234 static void
 235 on_run_all (GtkMenuItem *menuitem, gpointer user_data)
 236 {
 237   GtkTextIter begin, end;
 238   struct syntax_editor *se = user_data;
 239
 240   gtk_text_buffer_get_iter_at_line (se->buffer, &begin, 0);
 241   gtk_text_buffer_get_iter_at_line (se->buffer, &end, -1);
 242
 243
 244   execute_syntax (se, begin, end);
 245 }
 246
 247 /* Parse and execute the currently selected text */
 248 static void
 249 on_run_selection (GtkMenuItem *menuitem, gpointer user_data)
 250 {
 251   GtkTextIter begin, end;
 252   struct syntax_editor *se = user_data;
 253
 254   if ( gtk_text_buffer_get_selection_bounds (se->buffer, &begin, &end) )
 255     execute_syntax (se, begin, end);
 256 }
 257
 258
 259 /* Parse and execute the current line */
 260 static void
 261 on_run_current_line (GtkMenuItem *menuitem, gpointer user_data)
 262 {
 263   GtkTextIter begin, end;
 264   GtkTextIter here;
 265   gint line;
 266
 267   struct syntax_editor *se = user_data;
 268
 269   /* Get the current line */
 270   gtk_text_buffer_get_iter_at_mark (se->buffer,
 271                                     &here,
 272                                     gtk_text_buffer_get_insert (se->buffer)
 273                                     );
 274
 275   line = gtk_text_iter_get_line (&here) ;
 276
 277   /* Now set begin and end to the start of this line, and start of
 278      following line respectively */
 279   gtk_text_buffer_get_iter_at_line (se->buffer, &begin, line);
 280   gtk_text_buffer_get_iter_at_line (se->buffer, &end, line + 1);
 281
 282   execute_syntax (se, begin, end);
 283 }
 284
 285
 286
 287 /* Parse and execute the from the current line, to the end of the
 288    buffer */
 289 static void
 290 on_run_to_end (GtkMenuItem *menuitem, gpointer user_data)
 291 {
 292   GtkTextIter begin, end;
 293   GtkTextIter here;
 294   gint line;
 295
 296   struct syntax_editor *se = user_data;
 297
 298   /* Get the current line */
 299   gtk_text_buffer_get_iter_at_mark (se->buffer,
 300                                     &here,
 301                                     gtk_text_buffer_get_insert (se->buffer)
 302                                     );
 303
 304   line = gtk_text_iter_get_line (&here) ;
 305
 306   /* Now set begin and end to the start of this line, and end of buffer
 307      respectively */
 308   gtk_text_buffer_get_iter_at_line (se->buffer, &begin, line);
 309   gtk_text_buffer_get_iter_at_line (se->buffer, &end, -1);
 310
 311   execute_syntax (se, begin, end);
 312 }
 313
 314
 315
 316
 317 /*
 318   Create a new syntax editor with NAME.
 319   If NAME is NULL, a name will be automatically assigned
 320 */
 321 struct syntax_editor *
 322 new_syntax_editor (void)
 323 {
 324   GladeXML *xml =
 325     glade_xml_new (PKGDATADIR "/syntax-editor.glade", NULL, NULL);
 326
 327   GtkWidget *text_view;
 328   struct syntax_editor *se ;
 329   struct editor_window *e;
 330
 331   connect_help (xml);
 332
 333   se = g_malloc (sizeof (*se));
 334
 335   e = (struct editor_window *)se;
 336
 337   e->window = GTK_WINDOW (get_widget_assert (xml, "syntax_editor"));
 338   text_view = get_widget_assert (xml, "syntax_text_view");
 339   se->buffer = gtk_text_view_get_buffer (GTK_TEXT_VIEW (text_view));
 340   se->lexer = lex_create (the_source_stream);
 341
 342   g_signal_connect (get_widget_assert (xml,"file_new_syntax"),
 343                     "activate",
 344                     G_CALLBACK (new_syntax_window),
 345                     e->window);
 346
 347   g_signal_connect (get_widget_assert (xml,"file_open_syntax"),
 348                     "activate",
 349                     G_CALLBACK (open_syntax_window),
 350                     e->window);
 351
 352   g_signal_connect (get_widget_assert (xml,"file_new_data"),
 353                     "activate",
 354                     G_CALLBACK (new_data_window),
 355                     e->window);
 356
 357   g_signal_connect (get_widget_assert (xml,"file_open_data"),
 358                     "activate",
 359                     G_CALLBACK (open_data_window),
 360                     e->window);
 361
 362
 363   g_signal_connect (get_widget_assert (xml,"help_about"),
 364                     "activate",
 365                     G_CALLBACK (about_new),
 366                     e->window);
 367
 368   g_signal_connect (get_widget_assert (xml,"help_reference"),
 369                     "activate",
 370                     G_CALLBACK (reference_manual),
 371                     NULL);
 372
 373
 374   g_signal_connect (get_widget_assert (xml, "file_save"),
 375                     "activate",
 376                     G_CALLBACK (on_syntax_save),
 377                     se);
 378
 379   g_signal_connect (get_widget_assert (xml, "file_save_as"),
 380                     "activate",
 381                     G_CALLBACK (on_syntax_save_as),
 382                     se);
 383
 384
 385   g_signal_connect (get_widget_assert (xml,"file_quit"),
 386                     "activate",
 387                     G_CALLBACK (on_quit),
 388                     se);
 389
 390
 391   g_signal_connect (get_widget_assert (xml,"run_all"),
 392                     "activate",
 393                     G_CALLBACK (on_run_all),
 394                     se);
 395
 396
 397   g_signal_connect (get_widget_assert (xml,"run_selection"),
 398                     "activate",
 399                     G_CALLBACK (on_run_selection),
 400                     se);
 401
 402   g_signal_connect (get_widget_assert (xml,"run_current_line"),
 403                     "activate",
 404                     G_CALLBACK (on_run_current_line),
 405                     se);
 406
 407
 408   g_signal_connect (get_widget_assert (xml,"run_to_end"),
 409                     "activate",
 410                     G_CALLBACK (on_run_to_end),
 411                     se);
 412
 413
 414   g_signal_connect (get_widget_assert (xml,"windows_minimise_all"),
 415                     "activate",
 416                     G_CALLBACK (minimise_all_windows),
 417                     NULL);
 418
 419
 420
 421   g_object_unref (xml);
 422
 423   g_signal_connect (e->window, "delete-event",
 424                     G_CALLBACK (on_delete), se);
 425
 426
 427
 428   return se;
 429 }
 430
 431 /*
 432    Callback for the File->New->Syntax menuitem
 433 */
 434 void
 435 new_syntax_window (GtkMenuItem     *menuitem,
 436                    gpointer         user_data)
 437 {
 438   window_create (WINDOW_SYNTAX, NULL);
 439 }
 440
 441
 442 /*
 443   Save BUFFER to the file called FILENAME.
 444   If successful, clears the buffer's modified flag
 445 */
 446 static gboolean
 447 save_editor_to_file (struct syntax_editor *se,
 448                      const gchar *filename,
 449                      GError **err)
 450 {
 451   GtkTextBuffer *buffer = se->buffer;
 452   gboolean result ;
 453   GtkTextIter start, stop;
 454   gchar *text;
 455
 456   gchar *suffixedname;
 457   gchar *glibfilename;
 458   g_assert (filename);
 459
 460   suffixedname = append_suffix (filename);
 461
 462   glibfilename = g_filename_from_utf8 (suffixedname, -1, 0, 0, err);
 463
 464   g_free ( suffixedname);
 465
 466   if ( ! glibfilename )
 467     return FALSE;
 468
 469   gtk_text_buffer_get_iter_at_line (buffer, &start, 0);
 470   gtk_text_buffer_get_iter_at_offset (buffer, &stop, -1);
 471
 472   text = gtk_text_buffer_get_text (buffer, &start, &stop, FALSE);
 473
 474   result =  g_file_set_contents (glibfilename, text, -1, err);
 475
 476   if ( result )
 477     {
 478       window_set_name_from_filename ((struct editor_window *) se, filename);
 479       gtk_text_buffer_set_modified (buffer, FALSE);
 480     }
 481
 482   return result;
 483 }
 484
 485
 486 /*
 487   Loads the buffer from the file called FILENAME
 488 */
 489 static gboolean
 490 load_editor_from_file (struct syntax_editor *se,
 491                        const gchar *filename,
 492                        GError **err)
 493 {
 494   GtkTextBuffer *buffer = se->buffer;
 495   gchar *text;
 496   GtkTextIter iter;
 497
 498   gchar *glibfilename = g_filename_from_utf8 (filename, -1, 0, 0, err);
 499
 500   if ( ! glibfilename )
 501     return FALSE;
 502
 503   /* FIXME: What if it's a very big file ? */
 504   if ( ! g_file_get_contents (glibfilename, &text, NULL, err) )
 505     {
 506       g_free (glibfilename);
 507       return FALSE;
 508     }
 509   g_free (glibfilename);
 510
 511   gtk_text_buffer_get_iter_at_line (buffer, &iter, 0);
 512
 513   gtk_text_buffer_insert (buffer, &iter, text, -1);
 514
 515   window_set_name_from_filename ((struct editor_window *)se, filename);
 516   gtk_text_buffer_set_modified (buffer, FALSE);
 517
 518   return TRUE;
 519 }
 520
 521
 522 /* Callback for the File->Open->Syntax menuitem */
 523 void
 524 open_syntax_window (GtkMenuItem *menuitem, gpointer parent)
 525 {
 526   GtkFileFilter *filter;
 527   gint response;
 528
 529   GtkWidget *dialog =
 530     gtk_file_chooser_dialog_new (_("Open Syntax"),
 531                                  GTK_WINDOW (parent),
 532                                  GTK_FILE_CHOOSER_ACTION_OPEN,
 533                                  GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
 534                                  GTK_STOCK_OPEN,   GTK_RESPONSE_ACCEPT,
 535                                  NULL);
 536
 537   filter = gtk_file_filter_new ();
 538   gtk_file_filter_set_name (filter, _("Syntax Files (*.sps) "));
 539   gtk_file_filter_add_pattern (filter, "*.sps");
 540   gtk_file_filter_add_pattern (filter, "*.SPS");
 541   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
 542
 543   filter = gtk_file_filter_new ();
 544   gtk_file_filter_set_name (filter, _("All Files"));
 545   gtk_file_filter_add_pattern (filter, "*");
 546   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
 547
 548   response = gtk_dialog_run (GTK_DIALOG (dialog));
 549
 550   if (response == GTK_RESPONSE_ACCEPT)
 551     {
 552       const char *file_name = gtk_file_chooser_get_filename
 553         (GTK_FILE_CHOOSER (dialog));
 554
 555       struct syntax_editor *se = (struct syntax_editor *)
 556         window_create (WINDOW_SYNTAX, file_name);
 557
 558       load_editor_from_file (se, file_name, NULL);
 559     }
 560
 561   gtk_widget_destroy (dialog);
 562 }
 563