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
  28 #include "psppire-syntax-window.h"
  29
  30 #include "psppire-data-window.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
  41
  42 static void psppire_syntax_window_base_finalize (PsppireSyntaxWindowClass *, gpointer);
  43 static void psppire_syntax_window_base_init     (PsppireSyntaxWindowClass *class);
  44 static void psppire_syntax_window_class_init    (PsppireSyntaxWindowClass *class);
  45 static void psppire_syntax_window_init          (PsppireSyntaxWindow      *syntax_editor);
  46
  47
  48 GType
  49 psppire_syntax_window_get_type (void)
  50 {
  51   static GType psppire_syntax_window_type = 0;
  52
  53   if (!psppire_syntax_window_type)
  54     {
  55       static const GTypeInfo psppire_syntax_window_info =
  56       {
  57         sizeof (PsppireSyntaxWindowClass),
  58         (GBaseInitFunc) psppire_syntax_window_base_init,
  59         (GBaseFinalizeFunc) psppire_syntax_window_base_finalize,
  60         (GClassInitFunc)psppire_syntax_window_class_init,
  61         (GClassFinalizeFunc) NULL,
  62         NULL,
  63         sizeof (PsppireSyntaxWindow),
  64         0,
  65         (GInstanceInitFunc) psppire_syntax_window_init,
  66       };
  67
  68       psppire_syntax_window_type =
  69         g_type_register_static (PSPPIRE_WINDOW_TYPE, "PsppireSyntaxWindow",
  70                                 &psppire_syntax_window_info, 0);
  71     }
  72
  73   return psppire_syntax_window_type;
  74 }
  75
  76
  77 static void
  78 psppire_syntax_window_finalize (GObject *object)
  79 {
  80   GObjectClass *class = G_OBJECT_GET_CLASS (object);
  81
  82   GObjectClass *parent_class = g_type_class_peek_parent (class);
  83
  84   if (G_OBJECT_CLASS (parent_class)->finalize)
  85     (*G_OBJECT_CLASS (parent_class)->finalize) (object);
  86 }
  87
  88
  89 static void
  90 psppire_syntax_window_class_init (PsppireSyntaxWindowClass *class)
  91 {
  92 }
  93
  94
  95 static void
  96 psppire_syntax_window_base_init (PsppireSyntaxWindowClass *class)
  97 {
  98   GObjectClass *object_class = G_OBJECT_CLASS (class);
  99
 100   object_class->finalize = psppire_syntax_window_finalize;
 101 }
 102
 103
 104
 105 static void
 106 psppire_syntax_window_base_finalize (PsppireSyntaxWindowClass *class,
 107                                      gpointer class_data)
 108 {
 109 }
 110
 111
 112 static void
 113 editor_execute_syntax (const PsppireSyntaxWindow *se, GtkTextIter start,
 114                 GtkTextIter stop)
 115 {
 116   execute_syntax (create_syntax_editor_source (se->buffer, start, stop));
 117 }
 118
 119
 120 /* Parse and execute all the text in the buffer */
 121 static void
 122 on_run_all (GtkMenuItem *menuitem, gpointer user_data)
 123 {
 124   GtkTextIter begin, end;
 125   PsppireSyntaxWindow *se = PSPPIRE_SYNTAX_WINDOW (user_data);
 126
 127   gtk_text_buffer_get_iter_at_offset (se->buffer, &begin, 0);
 128   gtk_text_buffer_get_iter_at_offset (se->buffer, &end, -1);
 129
 130   editor_execute_syntax (se, begin, end);
 131 }
 132
 133 /* Parse and execute the currently selected text */
 134 static void
 135 on_run_selection (GtkMenuItem *menuitem, gpointer user_data)
 136 {
 137   GtkTextIter begin, end;
 138   PsppireSyntaxWindow *se = PSPPIRE_SYNTAX_WINDOW (user_data);
 139
 140   if ( gtk_text_buffer_get_selection_bounds (se->buffer, &begin, &end) )
 141     editor_execute_syntax (se, begin, end);
 142 }
 143
 144
 145 /* Parse and execute the from the current line, to the end of the
 146    buffer */
 147 static void
 148 on_run_to_end (GtkMenuItem *menuitem, gpointer user_data)
 149 {
 150   GtkTextIter begin, end;
 151   GtkTextIter here;
 152   gint line;
 153
 154   PsppireSyntaxWindow *se = PSPPIRE_SYNTAX_WINDOW (user_data);
 155
 156   /* Get the current line */
 157   gtk_text_buffer_get_iter_at_mark (se->buffer,
 158                                     &here,
 159                                     gtk_text_buffer_get_insert (se->buffer)
 160                                     );
 161
 162   line = gtk_text_iter_get_line (&here) ;
 163
 164   /* Now set begin and end to the start of this line, and end of buffer
 165      respectively */
 166   gtk_text_buffer_get_iter_at_line (se->buffer, &begin, line);
 167   gtk_text_buffer_get_iter_at_line (se->buffer, &end, -1);
 168
 169   editor_execute_syntax (se, begin, end);
 170 }
 171
 172
 173
 174 /* Parse and execute the current line */
 175 static void
 176 on_run_current_line (GtkMenuItem *menuitem, gpointer user_data)
 177 {
 178   GtkTextIter begin, end;
 179   GtkTextIter here;
 180   gint line;
 181
 182   PsppireSyntaxWindow *se = PSPPIRE_SYNTAX_WINDOW (user_data);
 183
 184   /* Get the current line */
 185   gtk_text_buffer_get_iter_at_mark (se->buffer,
 186                                     &here,
 187                                     gtk_text_buffer_get_insert (se->buffer)
 188                                     );
 189
 190   line = gtk_text_iter_get_line (&here) ;
 191
 192   /* Now set begin and end to the start of this line, and start of
 193      following line respectively */
 194   gtk_text_buffer_get_iter_at_line (se->buffer, &begin, line);
 195   gtk_text_buffer_get_iter_at_line (se->buffer, &end, line + 1);
 196
 197   editor_execute_syntax (se, begin, end);
 198 }
 199
 200
 201
 202 /* Append ".sps" to FILENAME if necessary.
 203    The returned result must be freed when no longer required.
 204  */
 205 static gchar *
 206 append_suffix (const gchar *filename)
 207 {
 208   if ( ! g_str_has_suffix (filename, ".sps" ) &&
 209        ! g_str_has_suffix (filename, ".SPS" ) )
 210     {
 211       return g_strdup_printf ("%s.sps", filename);
 212     }
 213
 214   return strdup (filename);
 215 }
 216
 217 /*
 218   Save BUFFER to the file called FILENAME.
 219   If successful, clears the buffer's modified flag
 220 */
 221 static gboolean
 222 save_editor_to_file (PsppireSyntaxWindow *se,
 223                      const gchar *filename,
 224                      GError **err)
 225 {
 226   GtkTextBuffer *buffer = se->buffer;
 227   gboolean result ;
 228   GtkTextIter start, stop;
 229   gchar *text;
 230
 231   gchar *suffixedname;
 232   gchar *glibfilename;
 233   g_assert (filename);
 234
 235   suffixedname = append_suffix (filename);
 236
 237   glibfilename = g_filename_from_utf8 (suffixedname, -1, 0, 0, err);
 238
 239   g_free ( suffixedname);
 240
 241   if ( ! glibfilename )
 242     return FALSE;
 243
 244   gtk_text_buffer_get_iter_at_line (buffer, &start, 0);
 245   gtk_text_buffer_get_iter_at_offset (buffer, &stop, -1);
 246
 247   text = gtk_text_buffer_get_text (buffer, &start, &stop, FALSE);
 248
 249   result =  g_file_set_contents (glibfilename, text, -1, err);
 250
 251   if ( result )
 252     {
 253       psppire_window_set_filename (PSPPIRE_WINDOW (se), filename);
 254       gtk_text_buffer_set_modified (buffer, FALSE);
 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
 267   if ( TRUE == gtk_text_buffer_get_modified (se->buffer))
 268     {
 269       gint response;
 270       GtkWidget *dialog;
 271
 272       const gchar *filename = psppire_window_get_filename (PSPPIRE_WINDOW (se));
 273
 274       g_return_if_fail (filename != NULL);
 275
 276       dialog =
 277         gtk_message_dialog_new (GTK_WINDOW (se),
 278                                 GTK_DIALOG_MODAL,
 279                                 GTK_MESSAGE_QUESTION,
 280                                 GTK_BUTTONS_NONE,
 281                                 _("Save contents of syntax editor to %s?"),
 282                                 filename);
 283
 284       gtk_dialog_add_button  (GTK_DIALOG (dialog),
 285                               GTK_STOCK_YES,
 286                               GTK_RESPONSE_ACCEPT);
 287       gtk_dialog_add_button  (GTK_DIALOG (dialog),
 288                               GTK_STOCK_NO,
 289                               GTK_RESPONSE_REJECT);
 290       gtk_dialog_add_button  (GTK_DIALOG (dialog),
 291                               GTK_STOCK_CANCEL,
 292                               GTK_RESPONSE_CANCEL);
 293
 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 extern struct source_stream *the_source_stream ;
 478
 479 static void
 480 psppire_syntax_window_init (PsppireSyntaxWindow *window)
 481 {
 482   GladeXML *xml = XML_NEW ("syntax-editor.glade");
 483   GtkWidget *box = gtk_vbox_new (FALSE, 0);
 484
 485   GtkWidget *menubar = get_widget_assert (xml, "menubar2");
 486   GtkWidget *sw = get_widget_assert (xml, "scrolledwindow8");
 487   GtkWidget *sb = get_widget_assert (xml, "statusbar2");
 488
 489   GtkWidget *text_view = get_widget_assert (xml, "syntax_text_view");
 490   window->buffer = gtk_text_view_get_buffer (GTK_TEXT_VIEW (text_view));
 491   window->lexer = lex_create (the_source_stream);
 492
 493   connect_help (xml);
 494
 495   gtk_container_add (GTK_CONTAINER (window), box);
 496
 497   g_object_ref (menubar);
 498   gtk_widget_unparent (menubar);
 499
 500   g_object_ref (sw);
 501   gtk_widget_unparent (sw);
 502
 503   g_object_ref (sb);
 504   gtk_widget_unparent (sb);
 505
 506
 507   gtk_box_pack_start (GTK_BOX (box), menubar, FALSE, TRUE, 0);
 508   gtk_box_pack_start (GTK_BOX (box), sw, TRUE, TRUE, 0);
 509   gtk_box_pack_start (GTK_BOX (box), sb, FALSE, TRUE, 0);
 510
 511   gtk_widget_show_all (box);
 512
 513   g_signal_connect (get_widget_assert (xml,"file_new_syntax"),
 514                     "activate",
 515                     G_CALLBACK (create_syntax_window),
 516                     NULL);
 517
 518   g_signal_connect (get_widget_assert (xml,"file_open_syntax"),
 519                     "activate",
 520                     G_CALLBACK (open_syntax_window),
 521                     window);
 522
 523
 524   g_signal_connect (get_widget_assert (xml,"file_new_data"),
 525                     "activate",
 526                     G_CALLBACK (create_data_window),
 527                     window);
 528
 529   g_signal_connect (get_widget_assert (xml,"help_about"),
 530                     "activate",
 531                     G_CALLBACK (about_new),
 532                     window);
 533
 534   g_signal_connect (get_widget_assert (xml,"help_reference"),
 535                     "activate",
 536                     G_CALLBACK (reference_manual),
 537                     NULL);
 538
 539   g_signal_connect (get_widget_assert (xml, "file_save"),
 540                     "activate",
 541                     G_CALLBACK (on_syntax_save),
 542                     window);
 543
 544   g_signal_connect (get_widget_assert (xml, "file_save_as"),
 545                     "activate",
 546                     G_CALLBACK (on_syntax_save_as),
 547                     window);
 548
 549   g_signal_connect (get_widget_assert (xml,"file_quit"),
 550                     "activate",
 551                     G_CALLBACK (on_quit),
 552                     window);
 553
 554   g_signal_connect (get_widget_assert (xml,"run_all"),
 555                     "activate",
 556                     G_CALLBACK (on_run_all),
 557                     window);
 558
 559
 560   g_signal_connect (get_widget_assert (xml,"run_selection"),
 561                     "activate",
 562                     G_CALLBACK (on_run_selection),
 563                     window);
 564
 565   g_signal_connect (get_widget_assert (xml,"run_current_line"),
 566                     "activate",
 567                     G_CALLBACK (on_run_current_line),
 568                     window);
 569
 570   g_signal_connect (get_widget_assert (xml,"run_to_end"),
 571                     "activate",
 572                     G_CALLBACK (on_run_to_end),
 573                     window);
 574
 575   g_signal_connect (get_widget_assert (xml,"windows_minimise_all"),
 576                     "activate",
 577                     G_CALLBACK (psppire_window_minimise_all),
 578                     NULL);
 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