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