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