src/ui/gui/psppire-window.c

   1 /* PSPPIRE - a graphical user interface for PSPP.
   2    Copyright (C) 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/gtkstock.h>
  20 #include <gtk/gtkmessagedialog.h>
  21 #include <gtk/gtksignal.h>
  22 #include <gtk/gtkwindow.h>
  23 #include <gtk/gtkcheckmenuitem.h>
  24 #include <gtk/gtkmain.h>
  25
  26 #include <stdlib.h>
  27
  28 #include <gettext.h>
  29 #define _(msgid) gettext (msgid)
  30 #define N_(msgid) msgid
  31
  32 #include "psppire-window.h"
  33 #include "psppire-window-register.h"
  34 #include "psppire-conf.h"
  35
  36 static void psppire_window_base_finalize (PsppireWindowClass *, gpointer);
  37 static void psppire_window_base_init     (PsppireWindowClass *class);
  38 static void psppire_window_class_init    (PsppireWindowClass *class);
  39 static void psppire_window_init          (PsppireWindow      *window);
  40
  41
  42 static PsppireWindowClass *the_class;
  43 static GObjectClass *parent_class;
  44
  45 GType
  46 psppire_window_get_type (void)
  47 {
  48   static GType psppire_window_type = 0;
  49
  50   if (!psppire_window_type)
  51     {
  52       static const GTypeInfo psppire_window_info =
  53       {
  54         sizeof (PsppireWindowClass),
  55         (GBaseInitFunc) psppire_window_base_init,
  56         (GBaseFinalizeFunc) psppire_window_base_finalize,
  57         (GClassInitFunc) psppire_window_class_init,
  58         (GClassFinalizeFunc) NULL,
  59         NULL,
  60         sizeof (PsppireWindow),
  61         0,
  62         (GInstanceInitFunc) psppire_window_init,
  63       };
  64
  65       psppire_window_type =
  66         g_type_register_static (GTK_TYPE_WINDOW, "PsppireWindow",
  67                                 &psppire_window_info, G_TYPE_FLAG_ABSTRACT);
  68     }
  69
  70   return psppire_window_type;
  71 }
  72
  73
  74 /* Properties */
  75 enum
  76 {
  77   PROP_0,
  78   PROP_FILENAME,
  79   PROP_DESCRIPTION
  80 };
  81
  82
  83 gchar *
  84 uniquify (const gchar *str, int *x)
  85 {
  86   return g_strdup_printf ("%s%d", str, (*x)++);
  87 }
  88
  89 static gchar mdash[6] = {0,0,0,0,0,0};
  90
  91 static void
  92 psppire_window_set_title (PsppireWindow *window)
  93 {
  94   GString *title = g_string_sized_new (80);
  95
  96   g_string_printf (title, _("%s %s PSPPIRE %s"),
  97                    window->basename ? window->basename : "",
  98                    mdash, window->description);
  99
 100   if ( window->unsaved)
 101     g_string_prepend_c (title, '*');
 102
 103   gtk_window_set_title (GTK_WINDOW (window), title->str);
 104
 105   g_string_free (title, TRUE);
 106 }
 107
 108 static void
 109 psppire_window_set_property (GObject         *object,
 110                              guint            prop_id,
 111                              const GValue    *value,
 112                              GParamSpec      *pspec)
 113 {
 114   PsppireWindow *window = PSPPIRE_WINDOW (object);
 115
 116   switch (prop_id)
 117     {
 118     case PROP_DESCRIPTION:
 119       window->description = g_value_dup_string (value);
 120       psppire_window_set_title (window);
 121       break;
 122     case PROP_FILENAME:
 123       {
 124         PsppireWindowRegister *reg = psppire_window_register_new ();
 125
 126         gchar *candidate_name ;
 127
 128         {
 129           const gchar *name = g_value_get_string (value);
 130           int x = 0;
 131           GValue def = {0};
 132           g_value_init (&def, pspec->value_type);
 133
 134           if ( NULL == name)
 135             {
 136               g_param_value_set_default (pspec, &def);
 137               name = g_value_get_string (&def);
 138             }
 139
 140           candidate_name = strdup (name);
 141
 142           while ( psppire_window_register_lookup (reg, candidate_name))
 143             {
 144               free (candidate_name);
 145               candidate_name = uniquify (name, &x);
 146             }
 147
 148           window->basename = g_path_get_basename (candidate_name);
 149
 150           g_value_unset (&def);
 151         }
 152
 153         psppire_window_set_title (window);
 154
 155         if ( window->name)
 156           psppire_window_register_remove (reg, window->name);
 157
 158         free (window->name);
 159         window->name = candidate_name;
 160
 161         psppire_window_register_insert (reg, window, window->name);
 162       }
 163       break;
 164     default:
 165       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 166       break;
 167     };
 168 }
 169
 170
 171 static void
 172 psppire_window_get_property (GObject         *object,
 173                              guint            prop_id,
 174                              GValue          *value,
 175                              GParamSpec      *pspec)
 176 {
 177   PsppireWindow *window = PSPPIRE_WINDOW (object);
 178
 179   switch (prop_id)
 180     {
 181     case PROP_FILENAME:
 182       g_value_set_string (value, window->name);
 183       break;
 184     case PROP_DESCRIPTION:
 185       g_value_set_string (value, window->description);
 186       break;
 187     default:
 188       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 189       break;
 190     };
 191 }
 192
 193
 194 static void
 195 on_realize (GtkWindow *window, gpointer data)
 196 {
 197   PsppireConf *conf = psppire_conf_new ();
 198
 199   const gchar *base = G_OBJECT_TYPE_NAME (window);
 200
 201   psppire_conf_set_window_geometry (conf, base, window);
 202 }
 203
 204
 205 static gboolean
 206 on_configure (GtkWidget *window, GdkEventConfigure *event, gpointer data)
 207 {
 208   const gchar *base = G_OBJECT_TYPE_NAME (window);
 209
 210   PsppireConf *conf = psppire_conf_new ();
 211
 212   psppire_conf_save_window_geometry (conf, base, event);
 213
 214   return FALSE;
 215 }
 216
 217
 218 static void
 219 psppire_window_finalize (GObject *object)
 220 {
 221   PsppireWindow *window = PSPPIRE_WINDOW (object);
 222
 223   PsppireWindowRegister *reg = psppire_window_register_new ();
 224
 225   psppire_window_register_remove (reg, window->name);
 226   free (window->name);
 227   free (window->description);
 228
 229   g_signal_handler_disconnect (psppire_window_register_new (),
 230                                window->remove_handler);
 231
 232   g_signal_handler_disconnect (psppire_window_register_new (),
 233                                window->insert_handler);
 234
 235   g_hash_table_destroy (window->menuitem_table);
 236
 237   if (G_OBJECT_CLASS (parent_class)->finalize)
 238     G_OBJECT_CLASS (parent_class)->finalize (object);
 239 }
 240
 241
 242 static void
 243 psppire_window_class_init (PsppireWindowClass *class)
 244 {
 245   GObjectClass *object_class = G_OBJECT_CLASS (class);
 246
 247   GParamSpec *description_spec =
 248     g_param_spec_string ("description",
 249                        "Description",
 250                        "A string describing the usage of the window",
 251                          "??????", /*Should be overridden by derived classes */
 252                        G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
 253
 254   GParamSpec *filename_spec =
 255     g_param_spec_string ("filename",
 256                        "File name",
 257                        "The name of the file associated with this window, if any",
 258                          "Untitled",
 259                          G_PARAM_CONSTRUCT | G_PARAM_READWRITE);
 260
 261   g_unichar_to_utf8 (0x2014, mdash);
 262
 263   object_class->set_property = psppire_window_set_property;
 264   object_class->get_property = psppire_window_get_property;
 265
 266   g_object_class_install_property (object_class,
 267                                    PROP_DESCRIPTION,
 268                                    description_spec);
 269
 270   g_object_class_install_property (object_class,
 271                                    PROP_FILENAME,
 272                                    filename_spec);
 273
 274   the_class = class;
 275   parent_class = g_type_class_peek_parent (class);
 276 }
 277
 278
 279 static void
 280 psppire_window_base_init (PsppireWindowClass *class)
 281 {
 282   GObjectClass *object_class = G_OBJECT_CLASS (class);
 283
 284   object_class->finalize = psppire_window_finalize;
 285 }
 286
 287
 288
 289 static void
 290 psppire_window_base_finalize (PsppireWindowClass *class,
 291                                 gpointer class_data)
 292 {
 293 }
 294
 295 static void
 296 menu_toggled (GtkCheckMenuItem *mi, gpointer data)
 297 {
 298   /* Prohibit changes to the state */
 299   mi->active = !mi->active;
 300 }
 301
 302
 303 /* Look up the window associated with this menuitem and present it to the user */
 304 static void
 305 menu_activate (GtkMenuItem *mi, gpointer data)
 306 {
 307   const gchar *key = data;
 308
 309   PsppireWindowRegister *reg = psppire_window_register_new ();
 310
 311   PsppireWindow *window = psppire_window_register_lookup (reg, key);
 312
 313   gtk_window_present (GTK_WINDOW (window));
 314 }
 315
 316 static void
 317 insert_menuitem_into_menu (PsppireWindow *window, gpointer key)
 318 {
 319   GtkWidget *item = gtk_check_menu_item_new_with_label (key);
 320
 321   g_signal_connect (item, "toggled", G_CALLBACK (menu_toggled), NULL);
 322   g_signal_connect (item, "activate", G_CALLBACK (menu_activate), key);
 323
 324   gtk_widget_show (item);
 325
 326   gtk_menu_shell_append (window->menu, item);
 327
 328   /* Set the state without emitting a signal */
 329   GTK_CHECK_MENU_ITEM (item)->active =
 330    (psppire_window_register_lookup (psppire_window_register_new (), key) == window);
 331
 332   g_hash_table_insert (window->menuitem_table, key, item);
 333 }
 334
 335 static void
 336 insert_item (gpointer key, gpointer value, gpointer data)
 337 {
 338   PsppireWindow *window = PSPPIRE_WINDOW (data);
 339
 340   if ( NULL != g_hash_table_lookup (window->menuitem_table, key))
 341     return;
 342
 343   insert_menuitem_into_menu (window, key);
 344 }
 345
 346 /* Insert a new item into the window menu */
 347 static void
 348 insert_menuitem (GObject *reg, const gchar *key, gpointer data)
 349 {
 350   PsppireWindow *window = PSPPIRE_WINDOW (data);
 351
 352   insert_menuitem_into_menu (window, (gpointer) key);
 353 }
 354
 355
 356 static void
 357 remove_menuitem (PsppireWindowRegister *reg, const gchar *key, gpointer data)
 358 {
 359   PsppireWindow *window = PSPPIRE_WINDOW (data);
 360   GtkWidget *item ;
 361
 362   item = g_hash_table_lookup (window->menuitem_table, key);
 363
 364   g_hash_table_remove (window->menuitem_table, key);
 365
 366   if (GTK_IS_CONTAINER (window->menu))
 367     gtk_container_remove (GTK_CONTAINER (window->menu), item);
 368 }
 369
 370 static void
 371 insert_existing_items (PsppireWindow *window)
 372 {
 373   psppire_window_register_foreach (psppire_window_register_new (), insert_item, window);
 374 }
 375
 376
 377 static gboolean
 378 on_delete (PsppireWindow *w, GdkEvent *event, gpointer user_data)
 379 {
 380   PsppireWindowRegister *reg = psppire_window_register_new ();
 381
 382   if ( w->unsaved )
 383     {
 384       gint response = psppire_window_query_save (w);
 385
 386       if ( response == GTK_RESPONSE_CANCEL)
 387         return TRUE;
 388
 389       if ( response == GTK_RESPONSE_ACCEPT)
 390         {
 391           psppire_window_save (w);
 392         }
 393     }
 394
 395   if ( 1 == psppire_window_register_n_items (reg))
 396     gtk_main_quit ();
 397
 398   return FALSE;
 399 }
 400
 401
 402 static void
 403 psppire_window_init (PsppireWindow *window)
 404 {
 405   window->name = NULL;
 406   window->menu = NULL;
 407
 408   window->menuitem_table  = g_hash_table_new (g_str_hash, g_str_equal);
 409
 410
 411   g_signal_connect (window,  "realize", G_CALLBACK (insert_existing_items), NULL);
 412
 413   window->insert_handler = g_signal_connect (psppire_window_register_new (),
 414                                              "inserted",
 415                                              G_CALLBACK (insert_menuitem),
 416                                              window);
 417
 418   window->remove_handler = g_signal_connect (psppire_window_register_new (),
 419                                              "removed",
 420                                              G_CALLBACK (remove_menuitem),
 421                                              window);
 422
 423   window->unsaved = FALSE;
 424
 425   g_signal_connect_swapped (window, "delete-event", G_CALLBACK (on_delete), window);
 426
 427   g_object_set (window, "icon-name", "psppicon", NULL);
 428
 429   g_signal_connect (window, "configure-event",
 430                     G_CALLBACK (on_configure), window);
 431
 432   g_signal_connect (window, "realize",
 433                     G_CALLBACK (on_realize), window);
 434
 435 }
 436
 437
 438 /*
 439    Ask the user if the buffer should be saved.
 440    Return the response.
 441 */
 442 gint
 443 psppire_window_query_save (PsppireWindow *se)
 444 {
 445   gint response;
 446   GtkWidget *dialog;
 447
 448   const gchar *description;
 449   const gchar *filename = psppire_window_get_filename (se);
 450
 451   g_object_get (se, "description", &description, NULL);
 452
 453   g_return_val_if_fail (filename != NULL, GTK_RESPONSE_NONE);
 454
 455   dialog =
 456     gtk_message_dialog_new (GTK_WINDOW (se),
 457                             GTK_DIALOG_MODAL,
 458                             GTK_MESSAGE_QUESTION,
 459                             GTK_BUTTONS_NONE,
 460                             _("Save contents of %s to \"%s\"?"),
 461                             description,
 462                             filename);
 463
 464   gtk_dialog_add_button  (GTK_DIALOG (dialog),
 465                           GTK_STOCK_YES,
 466                           GTK_RESPONSE_ACCEPT);
 467
 468   gtk_dialog_add_button  (GTK_DIALOG (dialog),
 469                           GTK_STOCK_NO,
 470                           GTK_RESPONSE_REJECT);
 471
 472   gtk_dialog_add_button  (GTK_DIALOG (dialog),
 473                           GTK_STOCK_CANCEL,
 474                           GTK_RESPONSE_CANCEL);
 475
 476   response = gtk_dialog_run (GTK_DIALOG (dialog));
 477
 478   gtk_widget_destroy (dialog);
 479
 480   return response;
 481 }
 482
 483
 484 const gchar *
 485 psppire_window_get_filename (PsppireWindow *w)
 486 {
 487   const gchar *name = NULL;
 488   g_object_get (w, "filename", &name, NULL);
 489   return name;
 490 }
 491
 492
 493 void
 494 psppire_window_set_filename (PsppireWindow *w, const gchar *filename)
 495 {
 496   g_object_set (w, "filename", filename, NULL);
 497 }
 498
 499 void
 500 psppire_window_set_unsaved (PsppireWindow *w, gboolean unsaved)
 501 {
 502   w->unsaved = unsaved;
 503
 504   psppire_window_set_title (w);
 505 }
 506
 507 gboolean
 508 psppire_window_get_unsaved (PsppireWindow *w)
 509 {
 510   return w->unsaved;
 511 }
 512
 513
 514 \f
 515
 516
 517 static void
 518 minimise_window (gpointer key, gpointer value, gpointer data)
 519 {
 520   gtk_window_iconify (GTK_WINDOW (value));
 521 }
 522
 523
 524 void
 525 psppire_window_minimise_all (void)
 526 {
 527   PsppireWindowRegister *reg = psppire_window_register_new ();
 528
 529   g_hash_table_foreach (reg->name_table, minimise_window, NULL);
 530 }
 531
 532
 533 \f
 534
 535 GType
 536 psppire_window_model_get_type (void)
 537 {
 538   static GType window_model_type = 0;
 539
 540   if (! window_model_type)
 541     {
 542       static const GTypeInfo window_model_info =
 543       {
 544         sizeof (PsppireWindowIface), /* class_size */
 545         NULL,           /* base_init */
 546         NULL,           /* base_finalize */
 547         NULL,
 548         NULL,           /* class_finalize */
 549         NULL,           /* class_data */
 550         0,
 551         0,              /* n_preallocs */
 552         NULL
 553       };
 554
 555       window_model_type =
 556         g_type_register_static (G_TYPE_INTERFACE, "PsppireWindowModel",
 557                                 &window_model_info, 0);
 558
 559       g_type_interface_add_prerequisite (window_model_type, G_TYPE_OBJECT);
 560     }
 561
 562   return window_model_type;
 563 }
 564
 565
 566 void
 567 psppire_window_save (PsppireWindow *w)
 568 {
 569   PsppireWindowIface *i = PSPPIRE_WINDOW_MODEL_GET_IFACE (w);
 570
 571   g_assert (PSPPIRE_IS_WINDOW_MODEL (w));
 572
 573   g_assert (i);
 574
 575   g_return_if_fail (i->save);
 576
 577   i->save (w);
 578 }
 579
 580
 581 /* Puts FILE_NAME into the recent list.
 582    If it's already in the list, it moves it to the top
 583 */
 584 void
 585 add_most_recent (const char *file_name, GtkRecentManager *rm)
 586 {
 587   gchar *uri = g_filename_to_uri  (file_name, NULL, NULL);
 588
 589   if ( uri )
 590     gtk_recent_manager_add_item (rm, uri);
 591
 592   g_free (uri);
 593 }
 594
 595
 596
 597 /*
 598    If FILE_NAME exists in the recent list, then  delete it.
 599  */
 600 void
 601 delete_recent (const char *file_name, GtkRecentManager *rm)
 602 {
 603   gchar *uri = g_filename_to_uri  (file_name, NULL, NULL);
 604
 605   if ( uri )
 606     gtk_recent_manager_remove_item (rm, uri, NULL);
 607
 608   g_free (uri);
 609
 610 }
 611