src/ui/gui/psppire-syntax-window.c

   1 /* PSPPIRE - a graphical user interface for PSPP.
   2    Copyright (C) 2008, 2009  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 "helper.h"
  22
  23 #include <libpspp/message.h>
  24 #include <stdlib.h>
  25
  26 #include "psppire.h"
  27 #include "psppire-syntax-window.h"
  28
  29 #include "psppire-data-window.h"
  30 #include "psppire-window-register.h"
  31 #include "psppire.h"
  32 #include "about.h"
  33 #include "psppire-syntax-window.h"
  34 #include "syntax-editor-source.h"
  35 #include <language/lexer/lexer.h>
  36
  37 #include <gettext.h>
  38 #define _(msgid) gettext (msgid)
  39 #define N_(msgid) msgid
  40
  41 static void psppire_syntax_window_base_finalize (PsppireSyntaxWindowClass *, gpointer);
  42 static void psppire_syntax_window_base_init     (PsppireSyntaxWindowClass *class);
  43 static void psppire_syntax_window_class_init    (PsppireSyntaxWindowClass *class);
  44 static void psppire_syntax_window_init          (PsppireSyntaxWindow      *syntax_editor);
  45
  46
  47 static void psppire_syntax_window_iface_init (PsppireWindowIface *iface);
  48
  49
  50 GType
  51 psppire_syntax_window_get_type (void)
  52 {
  53   static GType psppire_syntax_window_type = 0;
  54
  55   if (!psppire_syntax_window_type)
  56     {
  57       static const GTypeInfo psppire_syntax_window_info =
  58       {
  59         sizeof (PsppireSyntaxWindowClass),
  60         (GBaseInitFunc) psppire_syntax_window_base_init,
  61         (GBaseFinalizeFunc) psppire_syntax_window_base_finalize,
  62         (GClassInitFunc)psppire_syntax_window_class_init,
  63         (GClassFinalizeFunc) NULL,
  64         NULL,
  65         sizeof (PsppireSyntaxWindow),
  66         0,
  67         (GInstanceInitFunc) psppire_syntax_window_init,
  68       };
  69
  70       static const GInterfaceInfo window_interface_info =
  71         {
  72           (GInterfaceInitFunc) psppire_syntax_window_iface_init,
  73           NULL,
  74           NULL
  75         };
  76
  77       psppire_syntax_window_type =
  78         g_type_register_static (PSPPIRE_TYPE_WINDOW, "PsppireSyntaxWindow",
  79                                 &psppire_syntax_window_info, 0);
  80
  81       g_type_add_interface_static (psppire_syntax_window_type,
  82                                    PSPPIRE_TYPE_WINDOW_MODEL,
  83                                    &window_interface_info);
  84     }
  85
  86   return psppire_syntax_window_type;
  87 }
  88
  89 static GObjectClass *parent_class ;
  90
  91 static void
  92 psppire_syntax_window_finalize (GObject *object)
  93 {
  94   if (G_OBJECT_CLASS (parent_class)->finalize)
  95     (*G_OBJECT_CLASS (parent_class)->finalize) (object);
  96 }
  97
  98
  99 static void
 100 psppire_syntax_window_class_init (PsppireSyntaxWindowClass *class)
 101 {
 102   parent_class = g_type_class_peek_parent (class);
 103 }
 104
 105
 106 static void
 107 psppire_syntax_window_base_init (PsppireSyntaxWindowClass *class)
 108 {
 109   GObjectClass *object_class = G_OBJECT_CLASS (class);
 110
 111   object_class->finalize = psppire_syntax_window_finalize;
 112 }
 113
 114
 115
 116 static void
 117 psppire_syntax_window_base_finalize (PsppireSyntaxWindowClass *class,
 118                                      gpointer class_data)
 119 {
 120 }
 121
 122
 123 static void
 124 editor_execute_syntax (const PsppireSyntaxWindow *sw, GtkTextIter start,
 125                        GtkTextIter stop)
 126 {
 127   PsppireWindow *win = PSPPIRE_WINDOW (sw);
 128   const gchar *name = psppire_window_get_filename (win);
 129   execute_syntax (create_syntax_editor_source (sw->buffer, start, stop, name));
 130 }
 131
 132
 133 /* Parse and execute all the text in the buffer */
 134 static void
 135 on_run_all (GtkMenuItem *menuitem, gpointer user_data)
 136 {
 137   GtkTextIter begin, end;
 138   PsppireSyntaxWindow *se = PSPPIRE_SYNTAX_WINDOW (user_data);
 139
 140   gtk_text_buffer_get_iter_at_offset (se->buffer, &begin, 0);
 141   gtk_text_buffer_get_iter_at_offset (se->buffer, &end, -1);
 142
 143   editor_execute_syntax (se, begin, end);
 144 }
 145
 146 /* Parse and execute the currently selected text */
 147 static void
 148 on_run_selection (GtkMenuItem *menuitem, gpointer user_data)
 149 {
 150   GtkTextIter begin, end;
 151   PsppireSyntaxWindow *se = PSPPIRE_SYNTAX_WINDOW (user_data);
 152
 153   if ( gtk_text_buffer_get_selection_bounds (se->buffer, &begin, &end) )
 154     editor_execute_syntax (se, begin, end);
 155 }
 156
 157
 158 /* Parse and execute the from the current line, to the end of the
 159    buffer */
 160 static void
 161 on_run_to_end (GtkMenuItem *menuitem, gpointer user_data)
 162 {
 163   GtkTextIter begin, end;
 164   GtkTextIter here;
 165   gint line;
 166
 167   PsppireSyntaxWindow *se = PSPPIRE_SYNTAX_WINDOW (user_data);
 168
 169   /* Get the current line */
 170   gtk_text_buffer_get_iter_at_mark (se->buffer,
 171                                     &here,
 172                                     gtk_text_buffer_get_insert (se->buffer)
 173                                     );
 174
 175   line = gtk_text_iter_get_line (&here) ;
 176
 177   /* Now set begin and end to the start of this line, and end of buffer
 178      respectively */
 179   gtk_text_buffer_get_iter_at_line (se->buffer, &begin, line);
 180   gtk_text_buffer_get_iter_at_line (se->buffer, &end, -1);
 181
 182   editor_execute_syntax (se, begin, end);
 183 }
 184
 185
 186
 187 /* Parse and execute the current line */
 188 static void
 189 on_run_current_line (GtkMenuItem *menuitem, gpointer user_data)
 190 {
 191   GtkTextIter begin, end;
 192   GtkTextIter here;
 193   gint line;
 194
 195   PsppireSyntaxWindow *se = PSPPIRE_SYNTAX_WINDOW (user_data);
 196
 197   /* Get the current line */
 198   gtk_text_buffer_get_iter_at_mark (se->buffer,
 199                                     &here,
 200                                     gtk_text_buffer_get_insert (se->buffer)
 201                                     );
 202
 203   line = gtk_text_iter_get_line (&here) ;
 204
 205   /* Now set begin and end to the start of this line, and start of
 206      following line respectively */
 207   gtk_text_buffer_get_iter_at_line (se->buffer, &begin, line);
 208   gtk_text_buffer_get_iter_at_line (se->buffer, &end, line + 1);
 209
 210   editor_execute_syntax (se, begin, end);
 211 }
 212
 213
 214
 215 /* Append ".sps" to FILENAME if necessary.
 216    The returned result must be freed when no longer required.
 217  */
 218 static gchar *
 219 append_suffix (const gchar *filename)
 220 {
 221   if ( ! g_str_has_suffix (filename, ".sps" ) &&
 222        ! g_str_has_suffix (filename, ".SPS" ) )
 223     {
 224       return g_strdup_printf ("%s.sps", filename);
 225     }
 226
 227   return strdup (filename);
 228 }
 229
 230 /*
 231   Save BUFFER to the file called FILENAME.
 232   FILENAME must be encoded in Glib filename encoding.
 233   If successful, clears the buffer's modified flag.
 234 */
 235 static gboolean
 236 save_editor_to_file (PsppireSyntaxWindow *se,
 237                      const gchar *filename,
 238                      GError **err)
 239 {
 240   GtkTextBuffer *buffer = se->buffer;
 241   gboolean result ;
 242   GtkTextIter start, stop;
 243   gchar *text;
 244
 245   gchar *suffixedname;
 246   g_assert (filename);
 247
 248   suffixedname = append_suffix (filename);
 249
 250   gtk_text_buffer_get_iter_at_line (buffer, &start, 0);
 251   gtk_text_buffer_get_iter_at_offset (buffer, &stop, -1);
 252
 253   text = gtk_text_buffer_get_text (buffer, &start, &stop, FALSE);
 254
 255   result =  g_file_set_contents (suffixedname, text, -1, err);
 256
 257   g_free (suffixedname);
 258
 259   if ( result )
 260     {
 261       char *fn = g_filename_display_name (filename);
 262       gchar *msg = g_strdup_printf (_("Saved file \"%s\""), fn);
 263       g_free (fn);
 264       gtk_statusbar_push (GTK_STATUSBAR (se->sb), se->text_context, msg);
 265       gtk_text_buffer_set_modified (buffer, FALSE);
 266       g_free (msg);
 267     }
 268
 269   return result;
 270 }
 271
 272
 273 /* Callback for the File->SaveAs menuitem */
 274 static void
 275 syntax_save_as (PsppireWindow *se)
 276 {
 277   GtkFileFilter *filter;
 278   gint response;
 279
 280   GtkWidget *dialog =
 281     gtk_file_chooser_dialog_new (_("Save Syntax"),
 282                                  GTK_WINDOW (se),
 283                                  GTK_FILE_CHOOSER_ACTION_SAVE,
 284                                  GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
 285                                  GTK_STOCK_SAVE,   GTK_RESPONSE_ACCEPT,
 286                                  NULL);
 287
 288   filter = gtk_file_filter_new ();
 289   gtk_file_filter_set_name (filter, _("Syntax Files (*.sps) "));
 290   gtk_file_filter_add_pattern (filter, "*.sps");
 291   gtk_file_filter_add_pattern (filter, "*.SPS");
 292   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
 293
 294   filter = gtk_file_filter_new ();
 295   gtk_file_filter_set_name (filter, _("All Files"));
 296   gtk_file_filter_add_pattern (filter, "*");
 297   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
 298
 299   gtk_file_chooser_set_do_overwrite_confirmation (GTK_FILE_CHOOSER (dialog),
 300                                                   TRUE);
 301   response = gtk_dialog_run (GTK_DIALOG (dialog));
 302
 303   if ( response == GTK_RESPONSE_ACCEPT )
 304     {
 305       GError *err = NULL;
 306       char *filename =
 307         gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (dialog) );
 308
 309       if ( ! save_editor_to_file (PSPPIRE_SYNTAX_WINDOW (se), filename, &err) )
 310         {
 311           msg ( ME, err->message );
 312           g_error_free (err);
 313         }
 314
 315       free (filename);
 316     }
 317
 318   gtk_widget_destroy (dialog);
 319 }
 320
 321
 322 /* Callback for the File->Save menuitem */
 323 static void
 324 syntax_save (PsppireWindow *se)
 325 {
 326   const gchar *filename = psppire_window_get_filename (se);
 327
 328   if ( filename == NULL )
 329     syntax_save_as (se);
 330   else
 331     {
 332       GError *err = NULL;
 333       save_editor_to_file (PSPPIRE_SYNTAX_WINDOW (se), filename, &err);
 334       if ( err )
 335         {
 336           msg (ME, err->message);
 337           g_error_free (err);
 338         }
 339     }
 340 }
 341
 342
 343 /* Callback for the File->Quit menuitem */
 344 static gboolean
 345 on_quit (GtkMenuItem *menuitem, gpointer    user_data)
 346 {
 347   psppire_quit ();
 348
 349   return FALSE;
 350 }
 351
 352
 353 void
 354 create_syntax_window (void)
 355 {
 356   GtkWidget *w = psppire_syntax_window_new ();
 357   gtk_widget_show (w);
 358 }
 359
 360 /* Callback for the File->Open->Syntax menuitem */
 361 void
 362 open_syntax_window (GtkMenuItem *menuitem, gpointer parent)
 363 {
 364   GtkFileFilter *filter;
 365   gint response;
 366
 367   GtkWidget *dialog =
 368     gtk_file_chooser_dialog_new (_("Open Syntax"),
 369                                  GTK_WINDOW (parent),
 370                                  GTK_FILE_CHOOSER_ACTION_OPEN,
 371                                  GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
 372                                  GTK_STOCK_OPEN,   GTK_RESPONSE_ACCEPT,
 373                                  NULL);
 374
 375   filter = gtk_file_filter_new ();
 376   gtk_file_filter_set_name (filter, _("Syntax Files (*.sps) "));
 377   gtk_file_filter_add_pattern (filter, "*.sps");
 378   gtk_file_filter_add_pattern (filter, "*.SPS");
 379   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
 380
 381   filter = gtk_file_filter_new ();
 382   gtk_file_filter_set_name (filter, _("All Files"));
 383   gtk_file_filter_add_pattern (filter, "*");
 384   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
 385
 386   response = gtk_dialog_run (GTK_DIALOG (dialog));
 387
 388   if (response == GTK_RESPONSE_ACCEPT)
 389     {
 390       const char *file_name = gtk_file_chooser_get_filename
 391         (GTK_FILE_CHOOSER (dialog));
 392
 393       GtkWidget *se = psppire_syntax_window_new ();
 394
 395       if ( psppire_window_load (PSPPIRE_WINDOW (se), file_name) )
 396         gtk_widget_show (se);
 397       else
 398         gtk_widget_destroy (se);
 399     }
 400
 401   gtk_widget_destroy (dialog);
 402 }
 403
 404
 405 static void
 406 on_text_changed (GtkTextBuffer *buffer, PsppireSyntaxWindow *window)
 407 {
 408   gtk_statusbar_pop (GTK_STATUSBAR (window->sb), window->text_context);
 409 }
 410
 411 static void
 412 on_modified_changed (GtkTextBuffer *buffer, PsppireWindow *window)
 413 {
 414   if (gtk_text_buffer_get_modified (buffer))
 415     psppire_window_set_unsaved (window);
 416 }
 417
 418 extern struct source_stream *the_source_stream ;
 419
 420 static void
 421 psppire_syntax_window_init (PsppireSyntaxWindow *window)
 422 {
 423   GtkBuilder *xml = builder_new ("syntax-editor.ui");
 424   GtkWidget *box = gtk_vbox_new (FALSE, 0);
 425
 426   GtkWidget *menubar = get_widget_assert (xml, "menubar2");
 427   GtkWidget *sw = get_widget_assert (xml, "scrolledwindow8");
 428
 429
 430   GtkWidget *text_view = get_widget_assert (xml, "syntax_text_view");
 431   window->buffer = gtk_text_view_get_buffer (GTK_TEXT_VIEW (text_view));
 432   window->lexer = lex_create (the_source_stream);
 433
 434   window->sb = get_widget_assert (xml, "statusbar2");
 435   window->text_context = gtk_statusbar_get_context_id (GTK_STATUSBAR (window->sb), "Text Context");
 436
 437   g_signal_connect (window->buffer, "changed", G_CALLBACK (on_text_changed), window);
 438
 439   g_signal_connect (window->buffer, "modified-changed",
 440                     G_CALLBACK (on_modified_changed), window);
 441
 442   connect_help (xml);
 443
 444   gtk_container_add (GTK_CONTAINER (window), box);
 445
 446   g_object_ref (menubar);
 447
 448   g_object_ref (sw);
 449
 450   g_object_ref (window->sb);
 451
 452
 453   gtk_box_pack_start (GTK_BOX (box), menubar, FALSE, TRUE, 0);
 454   gtk_box_pack_start (GTK_BOX (box), sw, TRUE, TRUE, 0);
 455   gtk_box_pack_start (GTK_BOX (box), window->sb, FALSE, TRUE, 0);
 456
 457   gtk_widget_show_all (box);
 458
 459   g_signal_connect (get_action_assert (xml,"file_new_syntax"),
 460                     "activate",
 461                     G_CALLBACK (create_syntax_window),
 462                     NULL);
 463
 464   g_signal_connect (get_action_assert (xml,"file_open_syntax"),
 465                     "activate",
 466                     G_CALLBACK (open_syntax_window),
 467                     window);
 468
 469 #if 0
 470   g_signal_connect (get_action_assert (xml,"file_new_data"),
 471                     "activate",
 472                     G_CALLBACK (create_data_window),
 473                     window);
 474 #endif
 475
 476   {
 477     GtkAction *abt = get_action_assert (xml, "help_about");
 478     g_object_set (abt, "stock-id", "gtk-about", NULL);
 479
 480     g_signal_connect (abt,
 481                       "activate",
 482                       G_CALLBACK (about_new),
 483                       window);
 484   }
 485
 486   g_signal_connect (get_action_assert (xml,"help_reference"),
 487                     "activate",
 488                     G_CALLBACK (reference_manual),
 489                     NULL);
 490
 491   g_signal_connect_swapped (get_action_assert (xml, "file_save"),
 492                     "activate",
 493                     G_CALLBACK (syntax_save),
 494                     window);
 495
 496   g_signal_connect_swapped (get_action_assert (xml, "file_save_as"),
 497                     "activate",
 498                     G_CALLBACK (syntax_save_as),
 499                     window);
 500
 501   g_signal_connect (get_action_assert (xml,"file_quit"),
 502                     "activate",
 503                     G_CALLBACK (on_quit),
 504                     window);
 505
 506   g_signal_connect (get_action_assert (xml,"run_all"),
 507                     "activate",
 508                     G_CALLBACK (on_run_all),
 509                     window);
 510
 511
 512   g_signal_connect (get_action_assert (xml,"run_selection"),
 513                     "activate",
 514                     G_CALLBACK (on_run_selection),
 515                     window);
 516
 517   g_signal_connect (get_action_assert (xml,"run_current_line"),
 518                     "activate",
 519                     G_CALLBACK (on_run_current_line),
 520                     window);
 521
 522   g_signal_connect (get_action_assert (xml,"run_to_end"),
 523                     "activate",
 524                     G_CALLBACK (on_run_to_end),
 525                     window);
 526
 527   g_signal_connect (get_action_assert (xml,"windows_minimise_all"),
 528                     "activate",
 529                     G_CALLBACK (psppire_window_minimise_all), NULL);
 530
 531
 532   {
 533   GtkUIManager *uim = GTK_UI_MANAGER (get_object_assert (xml, "uimanager1", GTK_TYPE_UI_MANAGER));
 534
 535   PSPPIRE_WINDOW (window)->menu =
 536     GTK_MENU_SHELL (gtk_ui_manager_get_widget (uim,"/ui/menubar2/windows/windows_minimise_all")->parent);
 537   }
 538
 539   g_object_unref (xml);
 540 }
 541
 542
 543 GtkWidget*
 544 psppire_syntax_window_new (void)
 545 {
 546   return GTK_WIDGET (g_object_new (psppire_syntax_window_get_type (),
 547                                    "filename", "Syntax",
 548                                    "description", _("Syntax Editor"),
 549                                    NULL));
 550 }
 551
 552 static void
 553 error_dialog (GtkWindow *w, const gchar *filename,  GError *err)
 554 {
 555   gchar *fn = g_filename_display_basename (filename);
 556
 557   GtkWidget *dialog =
 558     gtk_message_dialog_new (w,
 559                             GTK_DIALOG_DESTROY_WITH_PARENT,
 560                             GTK_MESSAGE_ERROR,
 561                             GTK_BUTTONS_CLOSE,
 562                             _("Cannot load syntax file '%s'"),
 563                             fn);
 564
 565   g_free (fn);
 566
 567   g_object_set (dialog, "icon-name", "psppicon", NULL);
 568
 569   gtk_message_dialog_format_secondary_text (GTK_MESSAGE_DIALOG (dialog),
 570                                             err->message);
 571
 572   gtk_dialog_run (GTK_DIALOG (dialog));
 573
 574   gtk_widget_destroy (dialog);
 575 }
 576
 577 /*
 578   Loads the buffer from the file called FILENAME
 579 */
 580 static gboolean
 581 syntax_load (PsppireWindow *window, const gchar *filename)
 582 {
 583   GError *err = NULL;
 584   gchar *text;
 585   GtkTextIter iter;
 586   PsppireSyntaxWindow *sw = PSPPIRE_SYNTAX_WINDOW (window);
 587
 588   /* FIXME: What if it's a very big file ? */
 589   if ( ! g_file_get_contents (filename, &text, NULL, &err) )
 590     {
 591       error_dialog (GTK_WINDOW (window), filename, err);
 592       g_clear_error (&err);
 593       return FALSE;
 594     }
 595
 596   gtk_text_buffer_get_iter_at_line (sw->buffer, &iter, 0);
 597
 598   gtk_text_buffer_insert (sw->buffer, &iter, text, -1);
 599
 600   gtk_text_buffer_set_modified (sw->buffer, FALSE);
 601
 602   return TRUE;
 603 }
 604
 605 \f
 606
 607 static void
 608 psppire_syntax_window_iface_init (PsppireWindowIface *iface)
 609 {
 610   iface->save = syntax_save;
 611   iface->load = syntax_load;
 612 }