[gnome-shell] Make popdown,popup methods idempotent; remove 'popdown' for 'cancelled'

[Colin Walters <walters src gnome org>]

commit 7ac9fb2dd0bec76ffa9218728c94bf8c7ec8fe34
Author: Colin Walters <walters verbum org>
Date:   Fri Sep 11 17:16:49 2009 -0400

    Make popdown,popup methods idempotent; remove 'popdown' for 'cancelled'
    
    Callers will generally expect _popup and _popdown to be a no-op if
    the menu is already in that state; make it so.
    
    Also change the 'popdown' signal to be 'cancelled'; this is
    clearer and allows us to avoid having activate also call popdown.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=594699

 js/ui/appDisplay.js |    6 ++++--
 src/shell-menu.c    |   51 ++++++++++++++++++++++++++++++++++++++-------------
 2 files changed, 42 insertions(+), 15 deletions(-)
---
diff --git a/js/ui/appDisplay.js b/js/ui/appDisplay.js
index fe5b432..3662d6f 100644
--- a/js/ui/appDisplay.js
+++ b/js/ui/appDisplay.js
@@ -502,9 +502,9 @@ WellMenu.prototype = {
                                                  padding: 4,
                                                  corner_radius: WELL_MENU_CORNER_RADIUS,
                                                  width: Main.overview._dash.actor.width * 0.75 });
-        this._windowContainer.connect('popdown', Lang.bind(this, this._onPopdown));
         this._windowContainer.connect('unselected', Lang.bind(this, this._onWindowUnselected));
         this._windowContainer.connect('selected', Lang.bind(this, this._onWindowSelected));
+        this._windowContainer.connect('cancelled', Lang.bind(this, this._onWindowSelectionCancelled));
         this._windowContainer.connect('activate', Lang.bind(this, this._onWindowActivate));
         this.actor.add_actor(this._windowContainer);
 
@@ -655,9 +655,11 @@ WellMenu.prototype = {
     _onWindowActivate: function (actor, child) {
         let window = child._window;
         Main.overview.activateWindow(window, Clutter.get_current_event_time());
+        this.emit('popup', false);
+        this.actor.hide();
     },
 
-    _onPopdown: function () {
+    _onWindowSelectionCancelled: function () {
         this.emit('highlight-window', null);
         this.emit('popup', false);
         this.actor.hide();
diff --git a/src/shell-menu.c b/src/shell-menu.c
index 6debaf8..cfb60a1 100644
--- a/src/shell-menu.c
+++ b/src/shell-menu.c
@@ -13,6 +13,7 @@
 G_DEFINE_TYPE(ShellMenu, shell_menu, BIG_TYPE_BOX);
 
 struct _ShellMenuPrivate {
+  gboolean popped_up;
   gboolean have_grab;
 
   ClutterActor *selected;
@@ -24,7 +25,7 @@ enum
   UNSELECTED,
   SELECTED,
   ACTIVATE,
-  POPDOWN,
+  CANCELLED,
   LAST_SIGNAL
 };
 
@@ -42,6 +43,15 @@ shell_menu_contains (ShellMenu     *box,
 }
 
 static void
+shell_menu_popdown_nosignal (ShellMenu *box)
+{
+  box->priv->popped_up = FALSE;
+  if (box->priv->have_grab)
+    clutter_ungrab_pointer ();
+  clutter_actor_hide (CLUTTER_ACTOR (box));
+}
+
+static void
 on_selected_destroy (ClutterActor  *actor,
                      ShellMenu     *box)
 {
@@ -107,13 +117,19 @@ shell_menu_button_release_event (ClutterActor       *actor,
   if (event->button != 1)
     return FALSE;
 
-  shell_menu_popdown (box);
+  shell_menu_popdown_nosignal (box);
 
-  if (!shell_menu_contains (box, event->source))
-    return FALSE;
+  if (!shell_menu_contains (CLUTTER_CONTAINER (box), event->source))
+    {
+      g_signal_emit (G_OBJECT (box), shell_menu_signals[CANCELLED], 0);
+      return FALSE;
+    }
 
   if (box->priv->selected == NULL)
-    return FALSE;
+    {
+      g_signal_emit (G_OBJECT (box), shell_menu_signals[CANCELLED], 0);
+      return FALSE;
+    }
 
   g_signal_emit (G_OBJECT (box), shell_menu_signals[ACTIVATE], 0, box->priv->selected);
 
@@ -125,17 +141,26 @@ shell_menu_popup (ShellMenu         *box,
                   guint              button,
                   guint32            activate_time)
 {
+  if (box->priv->popped_up)
+    return;
+  box->priv->popped_up = TRUE;
   box->priv->have_grab = TRUE;
   clutter_grab_pointer (CLUTTER_ACTOR (box));
 }
 
+/**
+ * shell_menu_popdown:
+ * @box:
+ *
+ * If the menu is currently active, hide it, emitting the 'cancelled' signal.
+ */
 void
 shell_menu_popdown (ShellMenu *box)
 {
-  if (box->priv->have_grab)
-    clutter_ungrab_pointer ();
-  clutter_actor_hide (CLUTTER_ACTOR (box));
-  g_signal_emit (G_OBJECT (box), shell_menu_signals[POPDOWN], 0);
+  if (!box->priv->popped_up)
+    return;
+  shell_menu_popdown_nosignal (box);
+  g_signal_emit (G_OBJECT (box), shell_menu_signals[CANCELLED], 0);
 }
 
 /**
@@ -218,13 +243,13 @@ shell_menu_class_init (ShellMenuClass *klass)
                   G_TYPE_NONE, 1, CLUTTER_TYPE_ACTOR);
 
   /**
-   * ShellMenu::popdown
+   * ShellMenu::cancelled
    * @box: The #ShellMenu
    *
-   * This signal is emitted when the menu is removed from the display.
+   * This signal is emitted when the menu is closed without an option selected.
    */
-  shell_menu_signals[POPDOWN] =
-    g_signal_new ("popdown",
+  shell_menu_signals[CANCELLED] =
+    g_signal_new ("cancelled",
                   G_TYPE_FROM_CLASS (klass),
                   G_SIGNAL_RUN_LAST,
                   0,