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       psppire_window_set_filename (PSPPIRE_WINDOW (se), filename);
 251       gtk_text_buffer_set_modified (buffer, FALSE);
 252     }
 253
 254   return result;
 255 }
 256
 257 /* If the buffer's modified flag is set, then save it, and close the window.
 258    Otherwise just close the window.
 259 */
 260 static void
 261 save_if_modified (PsppireSyntaxWindow *se)
 262 {
 263
 264   if ( TRUE == gtk_text_buffer_get_modified (se->buffer))
 265     {
 266       gint response;
 267       GtkWidget *dialog;
 268
 269       const gchar *filename = psppire_window_get_filename (PSPPIRE_WINDOW (se));
 270
 271       g_return_if_fail (filename != NULL);
 272
 273       dialog =
 274         gtk_message_dialog_new (GTK_WINDOW (se),
 275                                 GTK_DIALOG_MODAL,
 276                                 GTK_MESSAGE_QUESTION,
 277                                 GTK_BUTTONS_NONE,
 278                                 _("Save contents of syntax editor to %s?"),
 279                                 filename);
 280
 281       gtk_dialog_add_button  (GTK_DIALOG (dialog),
 282                               GTK_STOCK_YES,
 283                               GTK_RESPONSE_ACCEPT);
 284       gtk_dialog_add_button  (GTK_DIALOG (dialog),
 285                               GTK_STOCK_NO,
 286                               GTK_RESPONSE_REJECT);
 287       gtk_dialog_add_button  (GTK_DIALOG (dialog),
 288                               GTK_STOCK_CANCEL,
 289                               GTK_RESPONSE_CANCEL);
 290
 291
 292       response = gtk_dialog_run (GTK_DIALOG (dialog));
 293
 294       gtk_widget_destroy (dialog);
 295
 296       if ( response == GTK_RESPONSE_ACCEPT )
 297         {
 298           GError *err = NULL;
 299
 300           if ( ! save_editor_to_file (se, filename, &err) )
 301             {
 302               msg (ME, err->message);
 303               g_error_free (err);
 304             }
 305         }
 306
 307       if ( response == GTK_RESPONSE_CANCEL )
 308         return ;
 309     }
 310
 311   gtk_widget_destroy (GTK_WIDGET (se));
 312 }
 313
 314 /* Callback for the File->SaveAs menuitem */
 315 static void
 316 on_syntax_save_as (GtkMenuItem *menuitem, gpointer user_data)
 317 {
 318   GtkFileFilter *filter;
 319   gint response;
 320
 321   PsppireSyntaxWindow *se = PSPPIRE_SYNTAX_WINDOW (user_data);
 322
 323   GtkWidget *dialog =
 324     gtk_file_chooser_dialog_new (_("Save Syntax"),
 325                                  GTK_WINDOW (se),
 326                                  GTK_FILE_CHOOSER_ACTION_SAVE,
 327                                  GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
 328                                  GTK_STOCK_SAVE,   GTK_RESPONSE_ACCEPT,
 329                                  NULL);
 330
 331   filter = gtk_file_filter_new ();
 332   gtk_file_filter_set_name (filter, _("Syntax Files (*.sps) "));
 333   gtk_file_filter_add_pattern (filter, "*.sps");
 334   gtk_file_filter_add_pattern (filter, "*.SPS");
 335   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
 336
 337   filter = gtk_file_filter_new ();
 338   gtk_file_filter_set_name (filter, _("All Files"));
 339   gtk_file_filter_add_pattern (filter, "*");
 340   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
 341
 342   gtk_file_chooser_set_do_overwrite_confirmation (GTK_FILE_CHOOSER (dialog),
 343                                                   TRUE);
 344   response = gtk_dialog_run (GTK_DIALOG (dialog));
 345
 346   if ( response == GTK_RESPONSE_ACCEPT )
 347     {
 348       GError *err = NULL;
 349       char *filename =
 350         gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (dialog) );
 351
 352       if ( ! save_editor_to_file (se, filename, &err) )
 353         {
 354           msg ( ME, err->message );
 355           g_error_free (err);
 356         }
 357
 358       free (filename);
 359     }
 360
 361   gtk_widget_destroy (dialog);
 362 }
 363
 364
 365 /* Callback for the File->Save menuitem */
 366 static void
 367 on_syntax_save (GtkMenuItem *menuitem, gpointer user_data)
 368 {
 369   PsppireSyntaxWindow *se = PSPPIRE_SYNTAX_WINDOW (user_data);
 370   const gchar *filename = psppire_window_get_filename (PSPPIRE_WINDOW (se));
 371
 372
 373   if ( filename == NULL )
 374     on_syntax_save_as (menuitem, se);
 375   else
 376     {
 377       GError *err = NULL;
 378       save_editor_to_file (se, filename, &err);
 379       if ( err )
 380         {
 381           msg (ME, err->message);
 382           g_error_free (err);
 383         }
 384     }
 385 }
 386
 387
 388 /* Callback for the File->Quit menuitem */
 389 static gboolean
 390 on_quit (GtkMenuItem *menuitem, gpointer    user_data)
 391 {
 392   PsppireSyntaxWindow *se = PSPPIRE_SYNTAX_WINDOW (user_data);
 393   save_if_modified (se);
 394   return FALSE;
 395 }
 396
 397
 398 /* Callback for the "delete" action (clicking the x on the top right
 399    hand corner of the window) */
 400 static gboolean
 401 on_delete (GtkWidget *w, GdkEvent *event, gpointer user_data)
 402 {
 403   PsppireSyntaxWindow *se = PSPPIRE_SYNTAX_WINDOW (user_data);
 404
 405   save_if_modified (se);
 406   return TRUE;
 407 }
 408
 409
 410 void
 411 create_syntax_window (void)
 412 {
 413   GtkWidget *w = psppire_syntax_window_new ();
 414   gtk_widget_show (w);
 415 }
 416
 417 /* Callback for the File->Open->Syntax menuitem */
 418 void
 419 open_syntax_window (GtkMenuItem *menuitem, gpointer parent)
 420 {
 421   GtkFileFilter *filter;
 422   gint response;
 423
 424   GtkWidget *dialog =
 425     gtk_file_chooser_dialog_new (_("Open Syntax"),
 426                                  GTK_WINDOW (parent),
 427                                  GTK_FILE_CHOOSER_ACTION_OPEN,
 428                                  GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
 429                                  GTK_STOCK_OPEN,   GTK_RESPONSE_ACCEPT,
 430                                  NULL);
 431
 432   filter = gtk_file_filter_new ();
 433   gtk_file_filter_set_name (filter, _("Syntax Files (*.sps) "));
 434   gtk_file_filter_add_pattern (filter, "*.sps");
 435   gtk_file_filter_add_pattern (filter, "*.SPS");
 436   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
 437
 438   filter = gtk_file_filter_new ();
 439   gtk_file_filter_set_name (filter, _("All Files"));
 440   gtk_file_filter_add_pattern (filter, "*");
 441   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
 442
 443   response = gtk_dialog_run (GTK_DIALOG (dialog));
 444
 445   if (response == GTK_RESPONSE_ACCEPT)
 446     {
 447       const char *file_name = gtk_file_chooser_get_filename
 448         (GTK_FILE_CHOOSER (dialog));
 449
 450       GtkWidget *se = psppire_syntax_window_new ();
 451
 452       if ( psppire_syntax_window_load_from_file (PSPPIRE_SYNTAX_WINDOW (se), file_name, NULL) )
 453 #if RECENT_LISTS_AVAILABLE
 454       {
 455         GtkRecentManager *manager = gtk_recent_manager_get_default();
 456         gchar *uri = g_filename_to_uri (file_name, NULL, NULL);
 457
 458         gtk_recent_manager_remove_item (manager, uri, NULL);
 459         if ( ! gtk_recent_manager_add_item (manager, uri))
 460           g_warning ("Could not add item %s to recent list\n",uri);
 461
 462         g_free (uri);
 463       }
 464 #else
 465       ;
 466 #endif
 467       gtk_widget_show (se);
 468     }
 469
 470   gtk_widget_destroy (dialog);
 471 }
 472
 473
 474
 475 extern struct source_stream *the_source_stream ;
 476
 477 static void
 478 psppire_syntax_window_init (PsppireSyntaxWindow *window)
 479 {
 480   GladeXML *xml = XML_NEW ("syntax-editor.glade");
 481   GtkWidget *box = gtk_vbox_new (FALSE, 0);
 482
 483   GtkWidget *menubar = get_widget_assert (xml, "menubar2");
 484   GtkWidget *sw = get_widget_assert (xml, "scrolledwindow8");
 485   GtkWidget *sb = get_widget_assert (xml, "statusbar2");
 486
 487   GtkWidget *text_view = get_widget_assert (xml, "syntax_text_view");
 488   window->buffer = gtk_text_view_get_buffer (GTK_TEXT_VIEW (text_view));
 489   window->lexer = lex_create (the_source_stream);
 490
 491   connect_help (xml);
 492
 493   gtk_container_add (GTK_CONTAINER (window), box);
 494
 495   g_object_ref (menubar);
 496
 497   g_object_ref (sw);
 498
 499   g_object_ref (sb);
 500
 501
 502   gtk_box_pack_start (GTK_BOX (box), menubar, FALSE, TRUE, 0);
 503   gtk_box_pack_start (GTK_BOX (box), sw, TRUE, TRUE, 0);
 504   gtk_box_pack_start (GTK_BOX (box), sb, FALSE, TRUE, 0);
 505
 506   gtk_widget_show_all (box);
 507
 508   g_signal_connect (get_widget_assert (xml,"file_new_syntax"),
 509                     "activate",
 510                     G_CALLBACK (create_syntax_window),
 511                     NULL);
 512
 513   g_signal_connect (get_widget_assert (xml,"file_open_syntax"),
 514                     "activate",
 515                     G_CALLBACK (open_syntax_window),
 516                     window);
 517
 518 #if 0
 519   g_signal_connect (get_widget_assert (xml,"file_new_data"),
 520                     "activate",
 521                     G_CALLBACK (create_data_window),
 522                     window);
 523 #endif
 524
 525   g_signal_connect (get_widget_assert (xml,"help_about"),
 526                     "activate",
 527                     G_CALLBACK (about_new),
 528                     window);
 529
 530   g_signal_connect (get_widget_assert (xml,"help_reference"),
 531                     "activate",
 532                     G_CALLBACK (reference_manual),
 533                     NULL);
 534
 535   g_signal_connect (get_widget_assert (xml, "file_save"),
 536                     "activate",
 537                     G_CALLBACK (on_syntax_save),
 538                     window);
 539
 540   g_signal_connect (get_widget_assert (xml, "file_save_as"),
 541                     "activate",
 542                     G_CALLBACK (on_syntax_save_as),
 543                     window);
 544
 545   g_signal_connect (get_widget_assert (xml,"file_quit"),
 546                     "activate",
 547                     G_CALLBACK (on_quit),
 548                     window);
 549
 550   g_signal_connect (get_widget_assert (xml,"run_all"),
 551                     "activate",
 552                     G_CALLBACK (on_run_all),
 553                     window);
 554
 555
 556   g_signal_connect (get_widget_assert (xml,"run_selection"),
 557                     "activate",
 558                     G_CALLBACK (on_run_selection),
 559                     window);
 560
 561   g_signal_connect (get_widget_assert (xml,"run_current_line"),
 562                     "activate",
 563                     G_CALLBACK (on_run_current_line),
 564                     window);
 565
 566   g_signal_connect (get_widget_assert (xml,"run_to_end"),
 567                     "activate",
 568                     G_CALLBACK (on_run_to_end),
 569                     window);
 570
 571   g_signal_connect (get_widget_assert (xml,"windows_minimise_all"),
 572                     "activate",
 573                     G_CALLBACK (psppire_window_minimise_all), NULL);
 574
 575   PSPPIRE_WINDOW (window)->menu = GTK_MENU_SHELL (get_widget_assert (xml,"windows_menu"));
 576
 577   g_object_unref (xml);
 578
 579   g_signal_connect (window, "delete-event",
 580                     G_CALLBACK (on_delete), window);
 581 }
 582
 583
 584 GtkWidget*
 585 psppire_syntax_window_new (void)
 586 {
 587   return GTK_WIDGET (g_object_new (psppire_syntax_window_get_type (),
 588                                    "usage", PSPPIRE_WINDOW_USAGE_SYNTAX,
 589                                    NULL));
 590 }
 591
 592
 593 /*
 594   Loads the buffer from the file called FILENAME
 595 */
 596 gboolean
 597 psppire_syntax_window_load_from_file (PsppireSyntaxWindow *se,
 598                                       const gchar *filename,
 599                                       GError **err)
 600 {
 601   gchar *text;
 602   GtkTextIter iter;
 603
 604   gchar *glibfilename = g_filename_from_utf8 (filename, -1, 0, 0, err);
 605
 606   if ( ! glibfilename )
 607     return FALSE;
 608
 609   /* FIXME: What if it's a very big file ? */
 610   if ( ! g_file_get_contents (glibfilename, &text, NULL, err) )
 611     {
 612       g_free (glibfilename);
 613       return FALSE;
 614     }
 615   g_free (glibfilename);
 616
 617   gtk_text_buffer_get_iter_at_line (se->buffer, &iter, 0);
 618
 619   gtk_text_buffer_insert (se->buffer, &iter, text, -1);
 620
 621   psppire_window_set_filename (PSPPIRE_WINDOW (se), filename);
 622
 623   gtk_text_buffer_set_modified (se->buffer, FALSE);
 624
 625   return TRUE;
 626 }
 627