add a cleanup callback to the prompt interface. when the prompt's callback returns...

diff --git a/openbox/actions/execute.c b/openbox/actions/execute.c
index f87fe00..636dbeb 100644 (file)
--- a/openbox/actions/execute.c
+++ b/openbox/actions/execute.c
@@ -98,11 +98,15 @@ static Options* dup_options(Options *in)
 
 static gboolean run_func(ObActionsData *data, gpointer options);
 
-static void prompt_cb(ObPrompt *p, gint result, gpointer options)
+static gboolean prompt_cb(ObPrompt *p, gint result, gpointer options)
 {
     if (result)
         run_func(NULL, options);
+    return TRUE; /* call the cleanup func */
+}
 
+static void prompt_cleanup(ObPrompt *p, gpointer options)
+{
     prompt_unref(p);
     free_func(options);
 }
@@ -126,7 +130,8 @@ static gboolean run_func(ObActionsData *data, gpointer options)
         };
 
         ocp = dup_options(options);
-        p = prompt_new(o->prompt, answers, 2, 0, 0, prompt_cb, ocp);
+        p = prompt_new(o->prompt, answers, 2, 0, 0,
+                       prompt_cb, prompt_cleanup, ocp);
         prompt_show(p, NULL, FALSE);
 
         return FALSE;

diff --git a/openbox/actions/exit.c b/openbox/actions/exit.c
index 747514f..67545cd 100644 (file)
--- a/openbox/actions/exit.c
+++ b/openbox/actions/exit.c
@@ -29,10 +29,15 @@ static gpointer setup_func(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node)
     return o;
 }
 
-static void prompt_cb(ObPrompt *p, gint result, gpointer data)
+static gboolean prompt_cb(ObPrompt *p, gint result, gpointer data)
 {
     if (result)
         ob_exit(0);
+    return TRUE; /* call the cleanup func */
+}
+
+static void prompt_cleanup(ObPrompt *p, gpointer data)
+{
     prompt_unref(p);
 }
 
@@ -49,7 +54,7 @@ static gboolean run_func(ObActionsData *data, gpointer options)
         };
 
         p = prompt_new(_("Are you sure you want to exit Openbox?"),
-                       answers, 2, 0, 0, prompt_cb, NULL);
+                       answers, 2, 0, 0, prompt_cb, prompt_cleanup, NULL);
         prompt_show(p, NULL, FALSE);
     }
     else

diff --git a/openbox/actions/session.c b/openbox/actions/session.c
index fc66d25..ef1497c 100644 (file)
--- a/openbox/actions/session.c
+++ b/openbox/actions/session.c
@@ -31,7 +31,7 @@ static gpointer setup_func(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node)
     return o;
 }
 
-static void prompt_cb(ObPrompt *p, gint result, gpointer data)
+static gboolean prompt_cb(ObPrompt *p, gint result, gpointer data)
 {
     Options *o = data;
     if (result) {
@@ -41,7 +41,12 @@ static void prompt_cb(ObPrompt *p, gint result, gpointer data)
         g_message(_("The SessionLogout actions is not available since Openbox was built without session management support"));
 #endif
     }
-    g_free(o);
+    return TRUE; /* call cleanup func */
+}
+
+static void prompt_cleanup(ObPrompt *p, gpointer data)
+{
+    g_free(data);
     prompt_unref(p);
 }
 
@@ -60,7 +65,7 @@ static gboolean logout_func(ObActionsData *data, gpointer options)
 
         o2 = g_memdup(o, sizeof(Options));
         p = prompt_new(_("Are you sure you want to log out?"),
-                       answers, 2, 0, 0, prompt_cb, o2);
+                       answers, 2, 0, 0, prompt_cb, prompt_cleanup, o2);
         prompt_show(p, NULL, FALSE);
     }
     else

diff --git a/openbox/client.c b/openbox/client.c
index 98d1035..44b1287 100644 (file)
--- a/openbox/client.c
+++ b/openbox/client.c
@@ -3400,12 +3400,20 @@ void client_close(ObClient *self)
 #define OB_KILL_RESULT_NO 0
 #define OB_KILL_RESULT_YES 1
 
-static void client_kill_requested(ObPrompt *p, gint result, gpointer data)
+static gboolean client_kill_requested(ObPrompt *p, gint result, gpointer data)
 {
     ObClient *self = data;
 
     if (result == OB_KILL_RESULT_YES)
         client_kill(self);
+    return TRUE; /* call the cleanup func */
+}
+
+static void client_kill_cleanup(ObPrompt *p, gpointer data)
+{
+    ObClient *self = data;
+
+    g_assert(p == self->kill_prompt);
 
     prompt_unref(self->kill_prompt);
     self->kill_prompt = NULL;
@@ -3456,7 +3464,9 @@ static void client_prompt_kill(ObClient *self)
                                        sizeof(answers)/sizeof(answers[0]),
                                        OB_KILL_RESULT_NO, /* default = no */
                                        OB_KILL_RESULT_NO, /* cancel = no */
-                                       client_kill_requested, self);
+                                       client_kill_requested,
+                                       client_kill_cleanup,
+                                       self);
         g_free(m);
     }
 

diff --git a/openbox/openbox.c b/openbox/openbox.c
index eb7934e..377b219 100644 (file)
--- a/openbox/openbox.c
+++ b/openbox/openbox.c
@@ -323,7 +323,6 @@ gint main(gint argc, gchar **argv)
             grab_startup(reconfigure);
             group_startup(reconfigure);
             ping_startup(reconfigure);
-            prompt_startup(reconfigure);
             client_startup(reconfigure);
             dock_startup(reconfigure);
             moveresize_startup(reconfigure);
@@ -331,6 +330,7 @@ gint main(gint argc, gchar **argv)
             mouse_startup(reconfigure);
             menu_frame_startup(reconfigure);
             menu_startup(reconfigure);
+            prompt_startup(reconfigure);
 
             if (!reconfigure) {
                 guint32 xid;
@@ -377,6 +377,7 @@ gint main(gint argc, gchar **argv)
                 client_unmanage_all();
             }
 
+            prompt_shutdown(reconfigure);
             menu_shutdown(reconfigure);
             menu_frame_shutdown(reconfigure);
             mouse_shutdown(reconfigure);
@@ -384,7 +385,6 @@ gint main(gint argc, gchar **argv)
             moveresize_shutdown(reconfigure);
             dock_shutdown(reconfigure);
             client_shutdown(reconfigure);
-            prompt_shutdown(reconfigure);
             ping_shutdown(reconfigure);
             group_shutdown(reconfigure);
             grab_shutdown(reconfigure);

diff --git a/openbox/prompt.c b/openbox/prompt.c
index 6084d79..e57b141 100644 (file)
--- a/openbox/prompt.c
+++ b/openbox/prompt.c
@@ -28,7 +28,6 @@
 #include "gettext.h"
 
 static GList *prompt_list = NULL;
-static GList *prompt_msg_list = NULL;
 
 /* we construct these */
 static RrAppearance *prompt_a_bg;
@@ -51,6 +50,7 @@ static void prompt_layout(ObPrompt *self);
 static void render_all(ObPrompt *self);
 static void render_button(ObPrompt *self, ObPromptElement *e);
 static void prompt_resize(ObPrompt *self, gint w, gint h);
+static void prompt_run_callback(ObPrompt *self, gint result);
 
 void prompt_startup(gboolean reconfig)
 {
@@ -122,8 +122,16 @@ void prompt_startup(gboolean reconfig)
 
 void prompt_shutdown(gboolean reconfig)
 {
-    while (prompt_msg_list)
-        prompt_cancel(prompt_msg_list->data);
+    GList *it;
+
+    if (!reconfig) {
+        for (it = prompt_list; it; it = g_list_next(it)) {
+            ObPrompt *p = it->data;
+            if (p->cleanup) p->cleanup(p, p->data);
+        }
+
+        g_assert(prompt_list == NULL);
+    }
 
     RrAppearanceFree(prompt_a_button);
     RrAppearanceFree(prompt_a_focus);
@@ -135,7 +143,8 @@ void prompt_shutdown(gboolean reconfig)
 ObPrompt* prompt_new(const gchar *msg,
                      const ObPromptAnswer *answers, gint n_answers,
                      gint default_result, gint cancel_result,
-                     ObPromptCallback func, gpointer data)
+                     ObPromptCallback func, ObPromptCleanup cleanup,
+                     gpointer data)
 {
     ObPrompt *self;
     XSetWindowAttributes attrib;
@@ -146,6 +155,7 @@ ObPrompt* prompt_new(const gchar *msg,
     self = g_new0(ObPrompt, 1);
     self->ref = 1;
     self->func = func;
+    self->cleanup = cleanup;
     self->data = data;
     self->default_result = default_result;
     self->cancel_result = cancel_result;
@@ -524,8 +534,7 @@ gboolean prompt_key_event(ObPrompt *self, XEvent *e)
     else if (e->xkey.keycode == ob_keycode(OB_KEY_RETURN) ||
              e->xkey.keycode == ob_keycode(OB_KEY_SPACE))
     {
-        if (self->func) self->func(self, self->focus->result, self->data);
-        prompt_hide(self);
+        prompt_run_callback(self, self->focus->result);
     }
     else if (e->xkey.keycode == ob_keycode(OB_KEY_TAB) ||
              e->xkey.keycode == ob_keycode(OB_KEY_LEFT) ||
@@ -583,10 +592,8 @@ gboolean prompt_mouse_event(ObPrompt *self, XEvent *e)
         render_button(self, but);
     }
     else if (e->type == ButtonRelease) {
-        if (but->pressed) {
-            if (self->func) self->func(self, but->result, self->data);
-            prompt_hide(self);
-        }
+        if (but->pressed)
+            prompt_run_callback(self, but->result);
     }
     else if (e->type == MotionNotify) {
         gboolean press;
@@ -604,13 +611,16 @@ gboolean prompt_mouse_event(ObPrompt *self, XEvent *e)
 
 void prompt_cancel(ObPrompt *self)
 {
-    if (self->func) self->func(self, self->cancel_result, self->data);
-    prompt_hide(self);
+    prompt_run_callback(self, self->cancel_result);
 }
 
-static void prompt_show_message_cb(ObPrompt *p, int res, gpointer data)
+static gboolean prompt_show_message_cb(ObPrompt *p, int res, gpointer data)
+{
+    return TRUE; /* call the cleanup func */
+}
+
+static void prompt_show_message_cleanup(ObPrompt *p, gpointer data)
 {
-    prompt_msg_list = g_list_remove(prompt_msg_list, p);
     prompt_unref(p);
 }
 
@@ -621,7 +631,19 @@ void prompt_show_message(const gchar *msg, const gchar *answer)
         { answer, 0 }
     };
 
-    p = prompt_new(msg, ans, 1, 0, 0, prompt_show_message_cb, NULL);
-    prompt_msg_list = g_list_prepend(prompt_msg_list, p);
+    p = prompt_new(msg, ans, 1, 0, 0,
+                   prompt_show_message_cb, prompt_show_message_cleanup, NULL);
     prompt_show(p, NULL, FALSE);
 }
+
+static void prompt_run_callback(ObPrompt *self, gint result)
+{
+    prompt_ref(self);
+    if (self->func) {
+        gboolean clean = self->func(self, self->focus->result, self->data);
+        if (clean && self->cleanup)
+            self->cleanup(self, self->data);
+    }
+    prompt_hide(self);
+    prompt_unref(self);
+}

diff --git a/openbox/prompt.h b/openbox/prompt.h
index c4558ad..007dae9 100644 (file)
--- a/openbox/prompt.h
+++ b/openbox/prompt.h
@@ -29,7 +29,8 @@ typedef struct _ObPrompt       ObPrompt;
 typedef struct _ObPromptElement ObPromptElement;
 typedef struct _ObPromptAnswer ObPromptAnswer;
 
-typedef void (*ObPromptCallback)(ObPrompt *p, gint result, gpointer data);
+typedef gboolean (*ObPromptCallback)(ObPrompt *p, gint result, gpointer data);
+typedef void (*ObPromptCleanup)(ObPrompt *p, gpointer data);
 
 struct _ObPromptElement {
     gchar *text;
@@ -69,6 +70,7 @@ struct _ObPrompt
     gint cancel_result;
 
     ObPromptCallback func;
+    ObPromptCleanup cleanup;
     gpointer data;
 };
 
@@ -90,12 +92,19 @@ void prompt_shutdown(gboolean reconfig);
          of having a button presssed
   @param func The callback function which is called when the dialog is closed
          or a button is pressed
+  @param cleanup The cleanup function which is called if the prompt system
+         is shutting down, and someone is still holding a reference to the
+         prompt.  This callback should cause the prompt's refcount to go to
+         zero so it can be freed, and free any other memory associated with
+         the prompt.  The cleanup function is also called if the prompt's
+         callback function returns TRUE.
   @param data User defined data which will be passed to the callback
 */
 ObPrompt* prompt_new(const gchar *msg,
                      const ObPromptAnswer *answers, gint n_answers,
                      gint default_result, gint cancel_result,
-                     ObPromptCallback func, gpointer data);
+                     ObPromptCallback func, ObPromptCleanup cleanup,
+                     gpointer data);
 void prompt_ref(ObPrompt *self);
 void prompt_unref(ObPrompt *self);