* Fix some detected memory leaks
[modest] / src / maemo / modest-main-window.c
index be256e1..68bf108 100644 (file)
 #include "modest-mail-operation.h"
 #include "modest-icon-names.h"
 #include "modest-progress-bar-widget.h"
+#include "maemo/modest-osso-state-saving.h"
+
+#ifdef MODEST_HILDON_VERSION_0
+#include <hildon-widgets/hildon-program.h>
+#else
+#include <hildon/hildon-program.h>
+#endif /*MODEST_HILDON_VERSION_0*/
+
 
 /* 'private'/'protected' functions */
 static void modest_main_window_class_init    (ModestMainWindowClass *klass);
@@ -69,6 +77,9 @@ static void save_sizes (ModestMainWindow *self);
 static void modest_main_window_show_toolbar   (ModestWindow *window,
                                               gboolean show_toolbar);
 
+static void cancel_progressbar (GtkToolButton *toolbutton,
+                               ModestMainWindow *self);
+
 static void         on_queue_changed                     (ModestMailOperationQueue *queue,
                                                          ModestMailOperation *mail_op,
                                                          ModestMailOperationQueueNotification type,
@@ -115,11 +126,14 @@ struct _ModestMainWindowPrivate {
        GtkWidget   *cancel_toolitem;
        GtkWidget   *sort_toolitem;
        GtkWidget   *refresh_toolitem;
+       ModestToolBarModes current_toolbar_mode;
 
        /* On-demand widgets */
        GtkWidget *accounts_popup;
        GtkWidget *details_widget;
 
+       /* Optimized view enabled */
+       gboolean optimized_view;
 
        ModestHeaderView *header_view;
        ModestFolderView *folder_view;
@@ -157,6 +171,12 @@ static const GtkActionEntry modest_folder_view_action_entries [] = {
        { "FolderViewCSMHelp", NULL, N_("mcen_me_inbox_help"), NULL, NULL, NULL },
 };
 
+
+static const GtkToggleActionEntry modest_main_window_toggle_action_entries [] = {
+       { "ToolbarToggleView", MODEST_STOCK_SPLIT_VIEW, N_("gqn_toolb_rss_fldonoff"), "<CTRL>t", NULL, G_CALLBACK (modest_ui_actions_toggle_folders_view), FALSE },
+};
+
+
 /************************************************************************/
 
 GType
@@ -216,8 +236,11 @@ modest_main_window_init (ModestMainWindow *obj)
        priv->accounts_popup  = NULL;
        priv->details_widget  = NULL;
 
+       priv->optimized_view  = FALSE;
+
        priv->progress_widgets  = NULL;
        priv->progress_bar = NULL;
+       priv->current_toolbar_mode = TOOLBAR_MODE_NORMAL;
 
        priv->style  = MODEST_MAIN_WINDOW_STYLE_SPLIT;
        priv->contents_style  = MODEST_MAIN_WINDOW_CONTENTS_STYLE_HEADERS;
@@ -402,6 +425,44 @@ sync_accounts_cb (ModestMainWindow *win)
        return FALSE; /* Do not call this idle handler again. */
 }
 
+static void on_hildon_program_is_topmost_notify(GObject *self,
+       GParamSpec *propert_param, gpointer user_data)
+{
+       HildonProgram *app = HILDON_PROGRAM (self);
+       
+       /*
+       ModestWindow* self = MODEST_WINDOW(user_data);
+       */
+       
+       /* Note that use of hildon_program_set_can_hibernate() 
+        * is generally referred to as "setting the killable flag", 
+        * though hibernation does not seem equal to death.
+        * murrayc */
+                
+       if (hildon_program_get_is_topmost (app)) {
+               /* Prevent hibernation when the progam comes to the foreground,
+                * because hibernation should only happen when the application 
+                * is in the background: */
+               hildon_program_set_can_hibernate (app, FALSE);
+       } else {
+               /* Allow hibernation if the program has gone to the background: */
+               
+               /* However, prevent hibernation while the settings are being changed: */
+               gboolean settings_dialog_is_open = FALSE;
+               
+               if (settings_dialog_is_open)
+                       hildon_program_set_can_hibernate (app, FALSE);
+               else {
+                       
+                       /* Allow hibernation, after saving the state: */
+                       modest_osso_save_state();
+                       hildon_program_set_can_hibernate (app, TRUE);
+               }
+       }
+       
+}
+
+
 
 ModestWindow*
 modest_main_window_new (void)
@@ -441,6 +502,11 @@ modest_main_window_new (void)
                                             G_N_ELEMENTS (modest_toggle_action_entries),
                                             self);
 
+       gtk_action_group_add_toggle_actions (action_group,
+                                            modest_main_window_toggle_action_entries,
+                                            G_N_ELEMENTS (modest_main_window_toggle_action_entries),
+                                            self);
+
        gtk_ui_manager_insert_action_group (parent_priv->ui_manager, action_group, 0);
        g_object_unref (action_group);
 
@@ -532,6 +598,27 @@ modest_main_window_new (void)
        /* do send & receive when we are idle */
        g_idle_add ((GSourceFunc)sync_accounts_cb, self);
        
+
+       HildonProgram *app = hildon_program_get_instance ();
+       hildon_program_add_window (app, HILDON_WINDOW (self));
+       
+       /* Register HildonProgram  signal handlers: */
+       /* These are apparently deprecated, according to the 
+        * "HildonApp/HildonAppView to HildonProgram/HildonWindow migration guide",
+        * though the API reference does not mention that:
+        *
+       g_signal_connect (G_OBJECT(app), "topmost_status_lose",
+               G_CALLBACK (on_hildon_program_save_state), self);
+       g_signal_connect (G_OBJECT(app), "topmost_status_acquire",
+               G_CALLBACK (on_hildon_program_status_acquire), self);
+    */
+       g_signal_connect (G_OBJECT(app), "notify::is-topmost",
+               G_CALLBACK (on_hildon_program_is_topmost_notify), self);
+               
+       /* Load previous osso state, for instance if we are being restored from 
+        * hibernation:  */
+       modest_osso_load_state();
+
        return MODEST_WINDOW(self);
 }
 
@@ -563,15 +650,21 @@ modest_main_window_set_style (ModestMainWindow *self,
                              ModestMainWindowStyle style)
 {
        ModestMainWindowPrivate *priv;
+       ModestWindowPrivate *parent_priv;
+       GtkAction *action;
 
        g_return_if_fail (MODEST_IS_MAIN_WINDOW (self));
 
        priv = MODEST_MAIN_WINDOW_GET_PRIVATE(self);
+       parent_priv = MODEST_WINDOW_GET_PRIVATE(self);
 
        /* no change -> nothing to do */
        if (priv->style == style)
                return;
 
+       /* Get toggle button */
+       action = gtk_ui_manager_get_action (parent_priv->ui_manager, "/ToolBar/ToolbarToggleView");
+
        priv->style = style;
 
        switch (style) {
@@ -583,6 +676,10 @@ modest_main_window_set_style (ModestMainWindow *self,
                /* Reparent the contents widget to the main vbox */
                gtk_widget_reparent (priv->contents_widget, priv->main_vbox);
 
+               g_signal_handlers_block_by_func (action, modest_ui_actions_toggle_folders_view, self);
+               gtk_toggle_action_set_active (GTK_TOGGLE_ACTION (action), TRUE);
+               g_signal_handlers_unblock_by_func (action, modest_ui_actions_toggle_folders_view, self);
+
                break;
        case MODEST_MAIN_WINDOW_STYLE_SPLIT:
                /* Remove header view */
@@ -592,6 +689,11 @@ modest_main_window_set_style (ModestMainWindow *self,
                /* Reparent the main paned */
                gtk_paned_add2 (GTK_PANED (priv->main_paned), priv->contents_widget);
                gtk_container_add (GTK_CONTAINER (priv->main_vbox), priv->main_paned);
+
+               g_signal_handlers_block_by_func (action, modest_ui_actions_toggle_folders_view, self);
+               gtk_toggle_action_set_active (GTK_TOGGLE_ACTION (action), FALSE);
+               g_signal_handlers_unblock_by_func (action, modest_ui_actions_toggle_folders_view, self);
+
                break;
        default:
                g_return_if_reached ();
@@ -618,6 +720,8 @@ modest_main_window_get_style (ModestMainWindow *self)
        return priv->style;
 }
 
+
+
 static gboolean
 modest_main_window_window_state_event (GtkWidget *widget, GdkEventWindowState *event, gpointer userdata)
 {
@@ -663,10 +767,14 @@ modest_main_window_show_toolbar (ModestWindow *self,
        GtkWidget *placeholder = NULL;
        gint insert_index;
 
-       parent_priv = MODEST_WINDOW_GET_PRIVATE(self);
+       g_return_if_fail (MODEST_IS_MAIN_WINDOW (self));
        priv = MODEST_MAIN_WINDOW_GET_PRIVATE(self);
+       parent_priv = MODEST_WINDOW_GET_PRIVATE(self);
 
-       if (!parent_priv->toolbar && show_toolbar) {
+       /* Set optimized view status */
+       priv->optimized_view = !show_toolbar;
+
+       if (!parent_priv->toolbar) {
                parent_priv->toolbar = gtk_ui_manager_get_widget (parent_priv->ui_manager, 
                                                                  "/ToolBar");
 
@@ -678,8 +786,8 @@ modest_main_window_show_toolbar (ModestWindow *self,
                priv->cancel_toolitem = gtk_ui_manager_get_widget (parent_priv->ui_manager, "/ToolBar/ToolbarCancel");
                priv->refresh_toolitem = gtk_ui_manager_get_widget (parent_priv->ui_manager, "/ToolBar/ToolbarSendReceive");
                priv->sort_toolitem = gtk_ui_manager_get_widget (parent_priv->ui_manager, "/ToolBar/ToolbarSort");
-               gtk_tool_item_set_expand (GTK_TOOL_ITEM (priv->progress_toolitem), FALSE);
                gtk_tool_item_set_homogeneous (GTK_TOOL_ITEM (priv->progress_toolitem), FALSE);
+               gtk_tool_item_set_expand (GTK_TOOL_ITEM (priv->progress_toolitem), FALSE);
                gtk_tool_item_set_homogeneous (GTK_TOOL_ITEM (priv->cancel_toolitem), FALSE);
                gtk_tool_item_set_expand (GTK_TOOL_ITEM (priv->cancel_toolitem), FALSE);
 
@@ -691,6 +799,11 @@ modest_main_window_show_toolbar (ModestWindow *self,
                gtk_container_add (GTK_CONTAINER (priv->progress_toolitem), priv->progress_bar);
                gtk_toolbar_insert(GTK_TOOLBAR(parent_priv->toolbar), GTK_TOOL_ITEM (priv->progress_toolitem), insert_index);
                
+               /* Connect cancel 'clicked' signal to abort progress mode */
+               g_signal_connect(priv->cancel_toolitem, "clicked",
+                                G_CALLBACK(cancel_progressbar),
+                                self);
+               
                /* Add it to the observers list */
                priv->progress_widgets = g_slist_prepend(priv->progress_widgets, priv->progress_bar);
 
@@ -710,14 +823,16 @@ modest_main_window_show_toolbar (ModestWindow *self,
                                   NULL, self);
        }
 
-       /* TODO: Why is this sometimes NULL? murrayc */
-       if (parent_priv->toolbar) {
-               if (show_toolbar) {
-                       gtk_widget_show (GTK_WIDGET (parent_priv->toolbar));
-                       set_toolbar_mode (MODEST_MAIN_WINDOW(self), TOOLBAR_MODE_NORMAL);
-               } else
-                       gtk_widget_hide (GTK_WIDGET (parent_priv->toolbar));
-       }
+       if (show_toolbar) {
+               /* Quick hack: this prevents toolbar icons "dance" when progress bar show status is changed */
+               /* TODO: resize mode migth be GTK_RESIZE_QUEUE, in order to avoid unneccesary shows */
+               gtk_container_set_resize_mode (GTK_CONTAINER(parent_priv->toolbar), GTK_RESIZE_IMMEDIATE);
+               
+               gtk_widget_show (GTK_WIDGET (parent_priv->toolbar));
+               set_toolbar_mode (MODEST_MAIN_WINDOW(self), TOOLBAR_MODE_NORMAL);
+       } else
+               gtk_widget_hide (GTK_WIDGET (parent_priv->toolbar));
+
 }
 
 /*
@@ -1042,56 +1157,105 @@ static void
 set_toolbar_mode (ModestMainWindow *self, 
                  ModestToolBarModes mode)
 {
-       ModestMainWindowPrivate *priv;
-
+       ModestWindowPrivate *parent_priv = NULL;
+       ModestMainWindowPrivate *priv = NULL;
+       GtkAction *sort_action = NULL, *refresh_action = NULL, *cancel_action = NULL;
+       
        g_return_if_fail (MODEST_IS_MAIN_WINDOW (self));
 
+       parent_priv = MODEST_WINDOW_GET_PRIVATE(self);
        priv = MODEST_MAIN_WINDOW_GET_PRIVATE(self);
-                       
+
+       g_return_if_fail (GTK_IS_TOOLBAR(parent_priv->toolbar)); 
+       
+       sort_action = gtk_ui_manager_get_action (parent_priv->ui_manager, "/ToolBar/ToolbarSort");
+       refresh_action = gtk_ui_manager_get_action (parent_priv->ui_manager, "/ToolBar/ToolbarSendReceive");
+       cancel_action = gtk_ui_manager_get_action (parent_priv->ui_manager, "/ToolBar/ToolbarCancel");
+
+       /* Sets current toolbar mode */
+       priv->current_toolbar_mode = mode;
+
+       /* Show and hide toolbar items */
        switch (mode) {
        case TOOLBAR_MODE_NORMAL:
-               if (priv->sort_toolitem)
-               gtk_widget_show (priv->sort_toolitem);
-               
-               if (priv->refresh_toolitem)
-                       gtk_widget_show (priv->refresh_toolitem);
-                       
-               if (priv->progress_toolitem)
+               if (sort_action) 
+                       gtk_action_set_visible (sort_action, TRUE);
+               if (refresh_action) 
+                       gtk_action_set_visible (refresh_action, TRUE);
+               if (priv->progress_toolitem) {
                        gtk_tool_item_set_expand (GTK_TOOL_ITEM (priv->progress_toolitem), FALSE);
+                       gtk_widget_hide (priv->progress_toolitem);
+               }
                if (priv->progress_bar)
-                       gtk_widget_hide (priv->progress_bar);
-                       
-               if (priv->cancel_toolitem)
-                       gtk_widget_hide (priv->cancel_toolitem);
+                       gtk_widget_hide (priv->progress_bar);                   
+               
+               if (cancel_action)
+                       gtk_action_set_visible (cancel_action, FALSE);
+
+               /* Hide toolbar if optimized view is enabled */
+               if (priv->optimized_view)
+                       gtk_widget_hide (GTK_WIDGET(parent_priv->toolbar));
                break;
        case TOOLBAR_MODE_TRANSFER:
-               if (priv->sort_toolitem)
-                       gtk_widget_hide (priv->sort_toolitem);
-               
-               if (priv->refresh_toolitem)
-                       gtk_widget_hide (priv->refresh_toolitem);
-               
-               if (priv->progress_toolitem)
+               if (sort_action)
+                       gtk_action_set_visible (sort_action, FALSE);
+               if (refresh_action)
+                       gtk_action_set_visible (refresh_action, FALSE);
+               if (cancel_action)
+                       gtk_action_set_visible (cancel_action, TRUE);
+               if (priv->progress_toolitem) {
                        gtk_tool_item_set_expand (GTK_TOOL_ITEM (priv->progress_toolitem), TRUE);
+                       gtk_widget_show (priv->progress_toolitem);
+               }
                if (priv->progress_bar)
-                       gtk_widget_show (priv->progress_bar);
-                       
-               if (priv->cancel_toolitem)
-                       gtk_widget_show (priv->cancel_toolitem);
+                       gtk_widget_show (priv->progress_bar);                   
+
+               /* Show toolbar if it's hiden (optimized view ) */
+               if (priv->optimized_view)
+                       gtk_widget_show (GTK_WIDGET (parent_priv->toolbar));
                break;
        default:
-               if (priv->cancel_toolitem)
-                       gtk_widget_show (priv->sort_toolitem);
-                       
-               if (priv->refresh_toolitem)
-                       gtk_widget_show (priv->refresh_toolitem);
-                       
-               if (priv->progress_bar)
-                       gtk_widget_hide (priv->progress_bar);
-                       
-               if (priv->cancel_toolitem)
-                       gtk_widget_hide (priv->cancel_toolitem);
+               g_return_if_reached ();
+       }
+}
+
+static void
+cancel_progressbar (GtkToolButton *toolbutton,
+                   ModestMainWindow *self)
+{
+       GSList *tmp;
+       ModestMainWindowPrivate *priv;
+       
+       priv = MODEST_MAIN_WINDOW_GET_PRIVATE(self);
+
+       /* Get operation observers and cancel its current operation */
+       tmp = priv->progress_widgets;
+       while (tmp) {
+               modest_progress_object_cancel_current_operation (MODEST_PROGRESS_OBJECT(tmp->data));
+               tmp=g_slist_next(tmp);
+       }
+}
+
+static gboolean
+observers_empty (ModestMainWindow *self)
+{
+       GSList *tmp = NULL;
+       ModestMainWindowPrivate *priv;
+       gboolean is_empty = TRUE;
+       guint pending_ops = 0;
+       priv = MODEST_MAIN_WINDOW_GET_PRIVATE(self);
+       tmp = priv->progress_widgets;
+
+       /* Check all observers */
+       while (tmp && is_empty)  {
+               pending_ops = modest_progress_object_num_pending_operations (MODEST_PROGRESS_OBJECT(tmp->data));
+               is_empty = pending_ops == 0;
+               
+               tmp = g_slist_next(tmp);
        }
+       
+       return is_empty;
 }
 
 static void
@@ -1100,45 +1264,56 @@ on_queue_changed (ModestMailOperationQueue *queue,
                  ModestMailOperationQueueNotification type,
                  ModestMainWindow *self)
 {
-       GSList *tmp;
        ModestMainWindowPrivate *priv;
        ModestMailOperationId op_id;
        ModestToolBarModes mode;
-       
-       priv = MODEST_MAIN_WINDOW_GET_PRIVATE(self);
+       GSList *tmp;
+       gboolean mode_changed = FALSE;
 
+       g_return_if_fail (MODEST_IS_MAIN_WINDOW (self));
+       priv = MODEST_MAIN_WINDOW_GET_PRIVATE(self);
+              
        /* Get toolbar mode from operation id*/
        op_id = modest_mail_operation_get_id (mail_op);
        switch (op_id) {
        case MODEST_MAIL_OPERATION_ID_SEND:
        case MODEST_MAIL_OPERATION_ID_RECEIVE:
                mode = TOOLBAR_MODE_TRANSFER;
+               if (priv->current_toolbar_mode == TOOLBAR_MODE_NORMAL)
+                       mode_changed = TRUE;
                break;
        default:
                mode = TOOLBAR_MODE_NORMAL;
                
        }
                
+                      
        /* Add operation observers and change toolbar if neccessary*/
        tmp = priv->progress_widgets;
        switch (type) {
        case MODEST_MAIL_OPERATION_QUEUE_OPERATION_ADDED:
-               if (mode != TOOLBAR_MODE_NORMAL) 
-                       set_toolbar_mode (MODEST_MAIN_WINDOW(self), mode);
-               while (tmp) {
-                       modest_progress_object_add_operation (MODEST_PROGRESS_OBJECT (tmp->data),
-                                                             mail_op);
-                       tmp = g_slist_next (tmp);
+               if (mode_changed)
+                       set_toolbar_mode (self, mode);
+               if (mode == TOOLBAR_MODE_TRANSFER) {
+                       while (tmp) {
+                               modest_progress_object_add_operation (MODEST_PROGRESS_OBJECT (tmp->data),
+                                                                     mail_op);
+                               tmp = g_slist_next (tmp);
+                       }
                }
                break;
        case MODEST_MAIL_OPERATION_QUEUE_OPERATION_REMOVED:
-               if (mode != TOOLBAR_MODE_NORMAL) 
-                       set_toolbar_mode (MODEST_MAIN_WINDOW(self), TOOLBAR_MODE_NORMAL);
-               while (tmp) {
-                       modest_progress_object_remove_operation (MODEST_PROGRESS_OBJECT (tmp->data),
-                                                                mail_op);
-                       tmp = g_slist_next (tmp);
+               if (mode == TOOLBAR_MODE_TRANSFER) {
+                       while (tmp) {
+                               modest_progress_object_remove_operation (MODEST_PROGRESS_OBJECT (tmp->data),
+                                                                        mail_op);
+                               tmp = g_slist_next (tmp);
+                       }
+                       
+                       /* If no more operations are being observed, NORMAL mode is enabled again */
+                       if (observers_empty (self))
+                               set_toolbar_mode (self, TOOLBAR_MODE_NORMAL);
                }
                break;
-       }
+       }       
 }