Save windows' maximized status as well as their geometry.
[pspp] / 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
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
29 #include <gettext.h>
30 #define _(msgid) gettext (msgid)
31 #define N_(msgid) msgid
32
33 #include "psppire-window.h"
34 #include "psppire-window-register.h"
35 #include "psppire-conf.h"
36
37 static void psppire_window_base_finalize (PsppireWindowClass *, gpointer);
38 static void psppire_window_base_init     (PsppireWindowClass *class);
39 static void psppire_window_class_init    (PsppireWindowClass *class);
40 static void psppire_window_init          (PsppireWindow      *window);
41
42
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->dirty)
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 save_geometry (GtkWidget *window, GdkEvent *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   parent_class = g_type_class_peek_parent (class);
275 }
276
277
278 static void
279 psppire_window_base_init (PsppireWindowClass *class)
280 {
281   GObjectClass *object_class = G_OBJECT_CLASS (class);
282
283   object_class->finalize = psppire_window_finalize;
284 }
285
286
287
288 static void
289 psppire_window_base_finalize (PsppireWindowClass *class,
290                                 gpointer class_data)
291 {
292 }
293
294 static void
295 menu_toggled (GtkCheckMenuItem *mi, gpointer data)
296 {
297   /* Prohibit changes to the state */
298   mi->active = !mi->active;
299 }
300
301
302 /* Look up the window associated with this menuitem and present it to the user */
303 static void
304 menu_activate (GtkMenuItem *mi, gpointer data)
305 {
306   const gchar *key = data;
307
308   PsppireWindowRegister *reg = psppire_window_register_new ();
309
310   PsppireWindow *window = psppire_window_register_lookup (reg, key);
311
312   gtk_window_present (GTK_WINDOW (window));
313 }
314
315 static void
316 insert_menuitem_into_menu (PsppireWindow *window, gpointer key)
317 {
318   GtkWidget *item = gtk_check_menu_item_new_with_label (key);
319
320   g_signal_connect (item, "toggled", G_CALLBACK (menu_toggled), NULL);
321   g_signal_connect (item, "activate", G_CALLBACK (menu_activate), key);
322
323   gtk_widget_show (item);
324
325   gtk_menu_shell_append (window->menu, item);
326
327   /* Set the state without emitting a signal */
328   GTK_CHECK_MENU_ITEM (item)->active =
329    (psppire_window_register_lookup (psppire_window_register_new (), key) == window);
330
331   g_hash_table_insert (window->menuitem_table, key, item);
332 }
333
334 static void
335 insert_item (gpointer key, gpointer value, gpointer data)
336 {
337   PsppireWindow *window = PSPPIRE_WINDOW (data);
338
339   if ( NULL != g_hash_table_lookup (window->menuitem_table, key))
340     return;
341
342   insert_menuitem_into_menu (window, key);
343 }
344
345 /* Insert a new item into the window menu */
346 static void
347 insert_menuitem (GObject *reg, const gchar *key, gpointer data)
348 {
349   PsppireWindow *window = PSPPIRE_WINDOW (data);
350   
351   insert_menuitem_into_menu (window, (gpointer) key);
352 }
353
354
355 static void
356 remove_menuitem (PsppireWindowRegister *reg, const gchar *key, gpointer data)
357 {
358   PsppireWindow *window = PSPPIRE_WINDOW (data);
359   GtkWidget *item ;
360
361   item = g_hash_table_lookup (window->menuitem_table, key);
362
363   g_hash_table_remove (window->menuitem_table, key);
364
365   if (GTK_IS_CONTAINER (window->menu))
366     gtk_container_remove (GTK_CONTAINER (window->menu), item);
367 }
368
369 static void
370 insert_existing_items (PsppireWindow *window)
371 {
372   psppire_window_register_foreach (psppire_window_register_new (), insert_item, window);
373 }
374
375
376 static gboolean
377 on_delete (PsppireWindow *w, GdkEvent *event, gpointer user_data)
378 {
379   PsppireWindowRegister *reg = psppire_window_register_new ();
380
381   if ( w->dirty )
382     {
383       gint response = psppire_window_query_save (w);
384
385       switch (response)
386         {
387         default:
388         case GTK_RESPONSE_CANCEL:
389           return TRUE;
390           break;
391         case GTK_RESPONSE_APPLY:
392           psppire_window_save (w);
393           break;
394         case GTK_RESPONSE_REJECT:
395           break;
396         }
397     }
398
399   if ( 1 == psppire_window_register_n_items (reg))
400     gtk_main_quit ();
401
402   return FALSE;
403 }
404
405
406 static void
407 psppire_window_init (PsppireWindow *window)
408 {
409   window->name = NULL;
410   window->menu = NULL;
411
412   window->menuitem_table  = g_hash_table_new (g_str_hash, g_str_equal);
413
414
415   g_signal_connect (window,  "realize", G_CALLBACK (insert_existing_items), NULL);
416
417   window->insert_handler = g_signal_connect (psppire_window_register_new (),
418                                              "inserted",
419                                              G_CALLBACK (insert_menuitem),
420                                              window);
421
422   window->remove_handler = g_signal_connect (psppire_window_register_new (),
423                                              "removed",
424                                              G_CALLBACK (remove_menuitem),
425                                              window);
426
427   window->dirty = FALSE;
428
429   g_signal_connect_swapped (window, "delete-event", G_CALLBACK (on_delete), window);
430
431   g_object_set (window, "icon-name", "psppicon", NULL);
432
433   g_signal_connect (window, "configure-event",
434                     G_CALLBACK (save_geometry), window);
435
436   g_signal_connect (window, "window-state-event",
437                     G_CALLBACK (save_geometry), window);
438
439   g_signal_connect (window, "realize",
440                     G_CALLBACK (on_realize), window);
441
442 }
443
444 /*
445    Ask the user if the buffer should be saved.
446    Return the response.
447 */
448 gint
449 psppire_window_query_save (PsppireWindow *se)
450 {
451   gint response;
452   GtkWidget *dialog;
453   GtkWidget *cancel_button;
454
455   const gchar *description;
456   const gchar *filename = psppire_window_get_filename (se);
457
458   GTimeVal time;
459
460   g_get_current_time (&time);
461
462   g_object_get (se, "description", &description, NULL);
463
464   g_return_val_if_fail (filename != NULL, GTK_RESPONSE_NONE);
465
466
467   dialog =
468     gtk_message_dialog_new (GTK_WINDOW (se),
469                             GTK_DIALOG_MODAL,
470                             GTK_MESSAGE_WARNING,
471                             GTK_BUTTONS_NONE,
472                             _("Save the changes to \"%s\" before closing?"),
473                             filename);
474
475   g_object_set (dialog, "icon-name", "psppicon", NULL);
476
477   gtk_message_dialog_format_secondary_text (GTK_MESSAGE_DIALOG (dialog),
478                                             _("If you don't save, changes from the last %ld seconds will be permanently lost."),
479                                             time.tv_sec - se->savetime.tv_sec);
480
481   gtk_dialog_add_button  (GTK_DIALOG (dialog),
482                           _("Close _without saving"),
483                           GTK_RESPONSE_REJECT);
484
485   cancel_button = gtk_dialog_add_button  (GTK_DIALOG (dialog),
486                                           GTK_STOCK_CANCEL,
487                                           GTK_RESPONSE_CANCEL);
488
489   gtk_dialog_add_button  (GTK_DIALOG (dialog),
490                           GTK_STOCK_SAVE,
491                           GTK_RESPONSE_APPLY);
492
493   gtk_widget_grab_focus (cancel_button);
494
495   response = gtk_dialog_run (GTK_DIALOG (dialog));
496
497   gtk_widget_destroy (dialog);
498
499   return response;
500 }
501
502
503
504 const gchar *
505 psppire_window_get_filename (PsppireWindow *w)
506 {
507   const gchar *name = NULL;
508   g_object_get (w, "filename", &name, NULL);
509   return name;
510 }
511
512
513 void
514 psppire_window_set_filename (PsppireWindow *w, const gchar *filename)
515 {
516   g_object_set (w, "filename", filename, NULL);
517 }
518
519 void
520 psppire_window_set_unsaved (PsppireWindow *w)
521 {
522   if ( w->dirty == FALSE)
523     g_get_current_time (&w->savetime);
524
525   w->dirty = TRUE;
526
527   psppire_window_set_title (w);
528 }
529
530 gboolean
531 psppire_window_get_unsaved (PsppireWindow *w)
532 {
533   return w->dirty;
534 }
535
536
537 \f
538
539
540 static void
541 minimise_window (gpointer key, gpointer value, gpointer data)
542 {
543   gtk_window_iconify (GTK_WINDOW (value));
544 }
545
546
547 void
548 psppire_window_minimise_all (void)
549 {
550   PsppireWindowRegister *reg = psppire_window_register_new ();
551
552   g_hash_table_foreach (reg->name_table, minimise_window, NULL);
553 }
554
555
556 \f
557
558 GType
559 psppire_window_model_get_type (void)
560 {
561   static GType window_model_type = 0;
562
563   if (! window_model_type)
564     {
565       static const GTypeInfo window_model_info =
566       {
567         sizeof (PsppireWindowIface), /* class_size */
568         NULL,           /* base_init */
569         NULL,           /* base_finalize */
570         NULL,
571         NULL,           /* class_finalize */
572         NULL,           /* class_data */
573         0,
574         0,              /* n_preallocs */
575         NULL
576       };
577
578       window_model_type =
579         g_type_register_static (G_TYPE_INTERFACE, "PsppireWindowModel",
580                                 &window_model_info, 0);
581
582       g_type_interface_add_prerequisite (window_model_type, G_TYPE_OBJECT);
583     }
584
585   return window_model_type;
586 }
587
588
589 void
590 psppire_window_save (PsppireWindow *w)
591 {
592   PsppireWindowIface *i = PSPPIRE_WINDOW_MODEL_GET_IFACE (w);
593
594   g_assert (PSPPIRE_IS_WINDOW_MODEL (w));
595
596   g_assert (i);
597
598   g_return_if_fail (i->save);
599
600   i->save (w);
601
602   w->dirty = FALSE;
603   psppire_window_set_title (w);
604 }
605
606 extern GtkRecentManager *the_recent_mgr;
607
608 static void add_most_recent (const char *file_name, GtkRecentManager *rm);
609 static void delete_recent (const char *file_name, GtkRecentManager *rm);
610
611 gboolean
612 psppire_window_load (PsppireWindow *w, const gchar *file)
613 {
614   gboolean ok;
615   PsppireWindowIface *i = PSPPIRE_WINDOW_MODEL_GET_IFACE (w);
616
617   g_assert (PSPPIRE_IS_WINDOW_MODEL (w));
618
619   g_assert (i);
620
621   g_return_val_if_fail (i->load, FALSE);
622
623   ok = i->load (w, file);
624
625   if ( ok )
626     {
627       add_most_recent (file, the_recent_mgr);
628       w->dirty = FALSE;
629     }
630   else
631     delete_recent (file, the_recent_mgr);
632
633   psppire_window_set_title (w);
634
635   return ok;
636 }
637
638
639 /* Puts FILE_NAME into the recent list.
640    If it's already in the list, it moves it to the top
641 */
642 static void
643 add_most_recent (const char *file_name, GtkRecentManager *rm)
644 {
645   gchar *uri = g_filename_to_uri  (file_name, NULL, NULL);
646
647   if ( uri )
648     gtk_recent_manager_add_item (rm, uri);
649
650   g_free (uri);
651 }
652
653
654
655 /*
656    If FILE_NAME exists in the recent list, then  delete it.
657  */
658 static void
659 delete_recent (const char *file_name, GtkRecentManager *rm)
660 {
661   gchar *uri = g_filename_to_uri  (file_name, NULL, NULL);
662
663   if ( uri )
664     gtk_recent_manager_remove_item (rm, uri, NULL);
665
666   g_free (uri);
667 }
668