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