gui: Fix g_object_get() memory leaks for PsppireWindow's filename.
[pspp-builds.git] / src / ui / gui / psppire-window.c
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyright (C) 2009, 2010, 2011  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 "psppire-window.h"
20
21 #include <gtk/gtk.h>
22
23 #include <stdlib.h>
24 #include <xalloc.h>
25
26 #include <gettext.h>
27 #define _(msgid) gettext (msgid)
28 #define N_(msgid) msgid
29
30 #include "data/any-reader.h"
31 #include "data/dataset.h"
32
33 #include "helper.h"
34 #include "psppire-conf.h"
35 #include "psppire-data-window.h"
36 #include "psppire-syntax-window.h"
37 #include "psppire-window-register.h"
38 #include "psppire.h"
39
40 static void psppire_window_base_finalize (PsppireWindowClass *, gpointer);
41 static void psppire_window_base_init     (PsppireWindowClass *class);
42 static void psppire_window_class_init    (PsppireWindowClass *class);
43 static void psppire_window_init          (PsppireWindow      *window);
44
45
46 static GObjectClass *parent_class;
47
48 GType
49 psppire_window_get_type (void)
50 {
51   static GType psppire_window_type = 0;
52
53   if (!psppire_window_type)
54     {
55       static const GTypeInfo psppire_window_info =
56       {
57         sizeof (PsppireWindowClass),
58         (GBaseInitFunc) psppire_window_base_init,
59         (GBaseFinalizeFunc) psppire_window_base_finalize,
60         (GClassInitFunc) psppire_window_class_init,
61         (GClassFinalizeFunc) NULL,
62         NULL,
63         sizeof (PsppireWindow),
64         0,
65         (GInstanceInitFunc) psppire_window_init,
66       };
67
68       psppire_window_type =
69         g_type_register_static (GTK_TYPE_WINDOW, "PsppireWindow",
70                                 &psppire_window_info, G_TYPE_FLAG_ABSTRACT);
71     }
72
73   return psppire_window_type;
74 }
75
76
77 /* Properties */
78 enum
79 {
80   PROP_0,
81   PROP_FILENAME,
82   PROP_DESCRIPTION
83 };
84
85
86 gchar *
87 uniquify (const gchar *str, int *x)
88 {
89   return g_strdup_printf ("%s%d", str, (*x)++);
90 }
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 ", window->basename ? window->basename : "");
98   g_string_append_unichar (title, 0x2014); /* em dash */
99   g_string_printf (title, " PSPPIRE %s", 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                          /* TRANSLATORS: This will form a filename.  Please avoid whitespace. */
247                          _("Untitled"),
248                          G_PARAM_CONSTRUCT | G_PARAM_READWRITE);
249
250   object_class->set_property = psppire_window_set_property;
251   object_class->get_property = psppire_window_get_property;
252
253   g_object_class_install_property (object_class,
254                                    PROP_DESCRIPTION,
255                                    description_spec);
256
257   g_object_class_install_property (object_class,
258                                    PROP_FILENAME,
259                                    filename_spec);
260
261   parent_class = g_type_class_peek_parent (class);
262 }
263
264
265 static void
266 psppire_window_base_init (PsppireWindowClass *class)
267 {
268   GObjectClass *object_class = G_OBJECT_CLASS (class);
269
270   object_class->finalize = psppire_window_finalize;
271 }
272
273
274
275 static void
276 psppire_window_base_finalize (PsppireWindowClass *class,
277                                 gpointer class_data)
278 {
279 }
280
281 static void
282 menu_toggled (GtkCheckMenuItem *mi, gpointer data)
283 {
284   /* Prohibit changes to the state */
285   mi->active = !mi->active;
286 }
287
288
289 /* Look up the window associated with this menuitem and present it to the user */
290 static void
291 menu_activate (GtkMenuItem *mi, gpointer data)
292 {
293   const gchar *key = data;
294
295   PsppireWindowRegister *reg = psppire_window_register_new ();
296
297   PsppireWindow *window = psppire_window_register_lookup (reg, key);
298
299   gtk_window_present (GTK_WINDOW (window));
300 }
301
302 static void
303 insert_menuitem_into_menu (PsppireWindow *window, gpointer key)
304 {
305   gchar *filename;
306   GtkWidget *item;
307
308   /* Add a separator before adding the first real item.  If we add a separator
309      at any other time, sometimes GtkUIManager removes it. */
310   if (g_hash_table_size (window->menuitem_table) == 0)
311     {
312       GtkWidget *separator = gtk_separator_menu_item_new ();
313       gtk_widget_show (separator);
314       gtk_menu_shell_append (window->menu, separator);
315     }
316
317   filename = g_filename_display_name (key);
318   item = gtk_check_menu_item_new_with_label (filename);
319   g_free (filename);
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   const gchar *base = G_OBJECT_TYPE_NAME (w);
383
384   PsppireConf *conf = psppire_conf_new ();
385
386   psppire_conf_save_window_geometry (conf, base, GTK_WINDOW (w));
387
388
389   if ( w->dirty )
390     {
391       gint response = psppire_window_query_save (w);
392
393       switch (response)
394         {
395         default:
396         case GTK_RESPONSE_CANCEL:
397           return TRUE;
398           break;
399         case GTK_RESPONSE_APPLY:
400           psppire_window_save (w);
401           break;
402         case GTK_RESPONSE_REJECT:
403           break;
404         }
405     }
406
407   if ( 1 == psppire_window_register_n_items (reg))
408     gtk_main_quit ();
409
410   return FALSE;
411 }
412
413
414 static void
415 psppire_window_init (PsppireWindow *window)
416 {
417   window->name = NULL;
418   window->menu = NULL;
419   window->description = xstrdup ("");
420
421   window->menuitem_table  = g_hash_table_new (g_str_hash, g_str_equal);
422
423
424   g_signal_connect (window,  "realize", G_CALLBACK (insert_existing_items), NULL);
425
426   window->insert_handler = g_signal_connect (psppire_window_register_new (),
427                                              "inserted",
428                                              G_CALLBACK (insert_menuitem),
429                                              window);
430
431   window->remove_handler = g_signal_connect (psppire_window_register_new (),
432                                              "removed",
433                                              G_CALLBACK (remove_menuitem),
434                                              window);
435
436   window->dirty = FALSE;
437
438   g_signal_connect_swapped (window, "delete-event", G_CALLBACK (on_delete), window);
439
440   g_object_set (window, "icon-name", "psppicon", NULL);
441
442   g_signal_connect (window, "realize",
443                     G_CALLBACK (on_realize), window);
444 }
445
446 /*
447    Ask the user if the buffer should be saved.
448    Return the response.
449 */
450 gint
451 psppire_window_query_save (PsppireWindow *se)
452 {
453   gchar *fn;
454   gint response;
455   GtkWidget *dialog;
456   GtkWidget *cancel_button;
457
458   const gchar *description;
459   const gchar *filename = psppire_window_get_filename (se);
460
461   GTimeVal time;
462
463   g_get_current_time (&time);
464
465   g_object_get (se, "description", &description, NULL);
466
467   g_return_val_if_fail (filename != NULL, GTK_RESPONSE_NONE);
468
469
470   fn = g_filename_display_basename (filename);
471
472   dialog =
473     gtk_message_dialog_new (GTK_WINDOW (se),
474                             GTK_DIALOG_MODAL,
475                             GTK_MESSAGE_WARNING,
476                             GTK_BUTTONS_NONE,
477                             _("Save the changes to `%s' before closing?"),
478                             fn);
479   g_free (fn);
480
481   g_object_set (dialog, "icon-name", "psppicon", NULL);
482
483   gtk_message_dialog_format_secondary_text (GTK_MESSAGE_DIALOG (dialog),
484                                             _("If you don't save, changes from the last %ld seconds will be permanently lost."),
485                                             time.tv_sec - se->savetime.tv_sec);
486
487   gtk_dialog_add_button  (GTK_DIALOG (dialog),
488                           _("Close _without saving"),
489                           GTK_RESPONSE_REJECT);
490
491   cancel_button = gtk_dialog_add_button  (GTK_DIALOG (dialog),
492                                           GTK_STOCK_CANCEL,
493                                           GTK_RESPONSE_CANCEL);
494
495   gtk_dialog_add_button  (GTK_DIALOG (dialog),
496                           GTK_STOCK_SAVE,
497                           GTK_RESPONSE_APPLY);
498
499   gtk_widget_grab_focus (cancel_button);
500
501   response = gtk_dialog_run (GTK_DIALOG (dialog));
502
503   gtk_widget_destroy (dialog);
504
505   return response;
506 }
507
508
509
510 const gchar *
511 psppire_window_get_filename (PsppireWindow *w)
512 {
513   return w->filename;
514 }
515
516
517 void
518 psppire_window_set_filename (PsppireWindow *w, const gchar *filename)
519 {
520   g_object_set (w, "filename", filename, NULL);
521 }
522
523 void
524 psppire_window_set_unsaved (PsppireWindow *w)
525 {
526   if ( w->dirty == FALSE)
527     g_get_current_time (&w->savetime);
528
529   w->dirty = TRUE;
530
531   psppire_window_set_title (w);
532 }
533
534 gboolean
535 psppire_window_get_unsaved (PsppireWindow *w)
536 {
537   return w->dirty;
538 }
539
540
541 \f
542
543
544 static void
545 minimise_window (gpointer key, gpointer value, gpointer data)
546 {
547   gtk_window_iconify (GTK_WINDOW (value));
548 }
549
550
551 void
552 psppire_window_minimise_all (void)
553 {
554   PsppireWindowRegister *reg = psppire_window_register_new ();
555
556   g_hash_table_foreach (reg->name_table, minimise_window, NULL);
557 }
558
559
560 \f
561
562 GType
563 psppire_window_model_get_type (void)
564 {
565   static GType window_model_type = 0;
566
567   if (! window_model_type)
568     {
569       static const GTypeInfo window_model_info =
570       {
571         sizeof (PsppireWindowIface), /* class_size */
572         NULL,           /* base_init */
573         NULL,           /* base_finalize */
574         NULL,
575         NULL,           /* class_finalize */
576         NULL,           /* class_data */
577         0,
578         0,              /* n_preallocs */
579         NULL
580       };
581
582       window_model_type =
583         g_type_register_static (G_TYPE_INTERFACE, "PsppireWindowModel",
584                                 &window_model_info, 0);
585
586       g_type_interface_add_prerequisite (window_model_type, G_TYPE_OBJECT);
587     }
588
589   return window_model_type;
590 }
591
592
593 void
594 psppire_window_save (PsppireWindow *w)
595 {
596   PsppireWindowIface *i = PSPPIRE_WINDOW_MODEL_GET_IFACE (w);
597
598   g_assert (PSPPIRE_IS_WINDOW_MODEL (w));
599
600   g_assert (i);
601
602   g_return_if_fail (i->save);
603
604   i->save (w);
605
606   w->dirty = FALSE;
607   psppire_window_set_title (w);
608 }
609
610 extern GtkRecentManager *the_recent_mgr;
611
612 static void add_most_recent (const char *file_name, GtkRecentManager *rm);
613 static void delete_recent (const char *file_name, GtkRecentManager *rm);
614
615 gboolean
616 psppire_window_load (PsppireWindow *w, const gchar *file)
617 {
618   gboolean ok;
619   PsppireWindowIface *i = PSPPIRE_WINDOW_MODEL_GET_IFACE (w);
620
621   g_assert (PSPPIRE_IS_WINDOW_MODEL (w));
622
623   g_assert (i);
624
625   g_return_val_if_fail (i->load, FALSE);
626
627   ok = i->load (w, file);
628
629   if ( ok )
630     {
631       psppire_window_set_filename (w, file);
632       add_most_recent (file, the_recent_mgr);
633       w->dirty = FALSE;
634     }
635   else
636     delete_recent (file, the_recent_mgr);
637
638   psppire_window_set_title (w);
639
640   return ok;
641 }
642
643 GtkWidget *
644 psppire_window_file_chooser_dialog (PsppireWindow *toplevel)
645 {
646   GtkWidget *dialog =
647     gtk_file_chooser_dialog_new (_("Open"),
648                                  GTK_WINDOW (toplevel),
649                                  GTK_FILE_CHOOSER_ACTION_OPEN,
650                                  GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
651                                  GTK_STOCK_OPEN, GTK_RESPONSE_ACCEPT,
652                                  NULL);
653
654   GtkFileFilter *filter;
655
656   filter = gtk_file_filter_new ();
657   gtk_file_filter_set_name (filter, _("Data and Syntax Files"));
658   gtk_file_filter_add_pattern (filter, "*.sav");
659   gtk_file_filter_add_pattern (filter, "*.SAV");
660   gtk_file_filter_add_pattern (filter, "*.por");
661   gtk_file_filter_add_pattern (filter, "*.POR");
662   gtk_file_filter_add_pattern (filter, "*.sps");
663   gtk_file_filter_add_pattern (filter, "*.SPS");
664   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
665
666   filter = gtk_file_filter_new ();
667   gtk_file_filter_set_name (filter, _("System Files (*.sav)"));
668   gtk_file_filter_add_pattern (filter, "*.sav");
669   gtk_file_filter_add_pattern (filter, "*.SAV");
670   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
671
672   filter = gtk_file_filter_new ();
673   gtk_file_filter_set_name (filter, _("Portable Files (*.por) "));
674   gtk_file_filter_add_pattern (filter, "*.por");
675   gtk_file_filter_add_pattern (filter, "*.POR");
676   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
677
678   filter = gtk_file_filter_new ();
679   gtk_file_filter_set_name (filter, _("Syntax Files (*.sps) "));
680   gtk_file_filter_add_pattern (filter, "*.sps");
681   gtk_file_filter_add_pattern (filter, "*.SPS");
682   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
683
684   filter = gtk_file_filter_new ();
685   gtk_file_filter_set_name (filter, _("All Files"));
686   gtk_file_filter_add_pattern (filter, "*");
687   gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (dialog), filter);
688
689   {
690     gchar *dir_name;
691     gchar *filename = NULL;
692     g_object_get (toplevel, "filename", &filename, NULL);
693
694     if ( ! g_path_is_absolute (filename))
695       {
696         gchar *path =
697           g_build_filename (g_get_current_dir (), filename, NULL);
698         dir_name = g_path_get_dirname (path);
699         g_free (path);
700       }
701     else
702       {
703         dir_name = g_path_get_dirname (filename);
704       }
705     gtk_file_chooser_set_current_folder (GTK_FILE_CHOOSER (dialog),
706                                          dir_name);
707     free (dir_name);
708   }
709
710   return dialog;
711 }
712
713 /* Callback for the file_open action.
714    Prompts for a filename and opens it */
715 void
716 psppire_window_open (PsppireWindow *de)
717 {
718   GtkWidget *dialog = psppire_window_file_chooser_dialog (de);
719
720   switch (gtk_dialog_run (GTK_DIALOG (dialog)))
721     {
722     case GTK_RESPONSE_ACCEPT:
723       {
724         gchar *name =
725           gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (dialog));
726
727         gchar *sysname = convert_glib_filename_to_system_filename (name, NULL);
728
729         if (any_reader_may_open (sysname))
730           {
731             PsppireWindow *window;
732
733 #if 0
734             if (PSPPIRE_IS_DATA_WINDOW (de)
735                 && psppire_data_window_is_empty (PSPPIRE_DATA_WINDOW (de)))
736               window = de;
737             else
738               window = PSPPIRE_WINDOW (psppire_data_window_new (NULL));
739 #else
740             window = PSPPIRE_WINDOW (psppire_default_data_window ());
741 #endif
742
743             psppire_window_load (window, name);
744             gtk_widget_show (GTK_WIDGET (window));
745           }
746         else
747           open_syntax_window (name);
748
749         g_free (sysname);
750         g_free (name);
751       }
752       break;
753     default:
754       break;
755     }
756
757   gtk_widget_destroy (dialog);
758 }
759
760
761 /* Puts FILE_NAME into the recent list.
762    If it's already in the list, it moves it to the top
763 */
764 static void
765 add_most_recent (const char *file_name, GtkRecentManager *rm)
766 {
767   gchar *uri = g_filename_to_uri  (file_name, NULL, NULL);
768
769   if ( uri )
770     gtk_recent_manager_add_item (rm, uri);
771
772   g_free (uri);
773 }
774
775
776
777 /*
778    If FILE_NAME exists in the recent list, then  delete it.
779  */
780 static void
781 delete_recent (const char *file_name, GtkRecentManager *rm)
782 {
783   gchar *uri = g_filename_to_uri  (file_name, NULL, NULL);
784
785   if ( uri )
786     gtk_recent_manager_remove_item (rm, uri, NULL);
787
788   g_free (uri);
789 }
790