Merge lp:~3v1n0/bamf/window-action-menu into lp:bamf

[Marco Trevisan (Treviño)]

BamfLegacyScreen: When in Unity monitor for compiz ClientMessage's to show action menu

If we get a _COMPIZ_TOOLKIT_ACTION client message with the internal value
_COMPIZ_TOOLKIT_ACTION_WINDOW_MENU, then we are requested by compiz
to show the window action menu, and thus let's ask the proper BamfLegacyWindow
to do that, thanks to libwnck.

In Unity monitor for compiz Client messages, and if requested (by Alt+Space, Alt+right-click, or directly by it) we show the classic "libwnck" window actions menu in the proper position (top-left corner of the window if activated by keyboard, in the click position otherwise).

The rationale for putting this instead than in unity itself is that having it in unity, a part that it would have needed to add one more build dependency (not a big deal considering that bamf already is), it would have us forced to add one more libwnck screen which means a window event filter, and a lot of logic computation that we don't need at all (as we already do it in bamf itself).

So imho this is the best approach not to duplicate things.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:592
http://jenkins.qa.ubuntu.com/job/bamf-ci/98/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/bamf-trusty-amd64-ci/6
    SUCCESS: http://jenkins.qa.ubuntu.com/job/bamf-trusty-armhf-ci/6
        deb: http://jenkins.qa.ubuntu.com/job/bamf-trusty-armhf-ci/6/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/bamf-ci/98/rebuild

review: Approve (continuous-integration)

[Brandon Schaefer (brandontschaefer)]

LGTM

review: Approve

=== modified file 'src/bamf-legacy-screen.c'
--- src/bamf-legacy-screen.c	2013-08-20 15:09:48 +0000
+++ src/bamf-legacy-screen.c	2014-02-14 01:33:57 +0000
@@ -19,6 +19,7 @@
 
 #include "bamf-legacy-screen.h"
 #include "bamf-legacy-screen-private.h"
+#include <gdk/gdkx.h>
 #include <gio/gio.h>
 
 G_DEFINE_TYPE (BamfLegacyScreen, bamf_legacy_screen, G_TYPE_OBJECT);
@@ -38,6 +39,8 @@
 };
 
 static guint legacy_screen_signals[LAST_SIGNAL] = { 0 };
+static Atom _COMPIZ_TOOLKIT_ACTION = 0;
+static Atom _COMPIZ_TOOLKIT_ACTION_WINDOW_MENU = 0;
 
 struct _BamfLegacyScreenPrivate
 {
@@ -350,6 +353,25 @@
   return NULL;
 }
 
+static BamfLegacyWindow *
+bamf_legacy_screen_get_window_by_xid (BamfLegacyScreen *screen, Window xid)
+{
+  BamfLegacyWindow *window;
+  GList *l;
+
+  g_return_val_if_fail (BAMF_IS_LEGACY_SCREEN (screen), NULL);
+
+  for (l = screen->priv->windows; l; l = l->next)
+    {
+      window = l->data;
+
+      if (bamf_legacy_window_get_xid (window) == xid)
+        return window;
+    }
+
+  return NULL;
+}
+
 static void
 handle_active_window_changed (WnckScreen *screen, WnckWindow *previous, BamfLegacyScreen *self)
 {
@@ -428,6 +450,42 @@
                   G_TYPE_NONE, 0);
 }
 
+#include <gdk/gdkx.h>
+
+GdkFilterReturn filter_compiz_messages(GdkXEvent *gdkxevent, GdkEvent *event, gpointer data)
+{
+  BamfLegacyScreen *self = data;
+  BamfLegacyWindow *window;
+  XEvent *xevent = gdkxevent;
+
+  if (xevent->type == ClientMessage)
+    {
+      if (xevent->xclient.message_type == _COMPIZ_TOOLKIT_ACTION)
+        {
+          Atom msg = xevent->xclient.data.l[0];
+
+          if (msg == _COMPIZ_TOOLKIT_ACTION_WINDOW_MENU)
+            {
+              window = bamf_legacy_screen_get_window_by_xid (self, xevent->xany.window);
+
+              if (BAMF_IS_LEGACY_WINDOW (window))
+                {
+                  Time time = xevent->xclient.data.l[1];
+                  int button = xevent->xclient.data.l[2];
+                  int x = xevent->xclient.data.l[3];
+                  int y = xevent->xclient.data.l[4];
+
+                  bamf_legacy_window_show_action_menu (window, time, button, x, y);
+
+                  return GDK_FILTER_REMOVE;
+                }
+            }
+        }
+    }
+
+  return GDK_FILTER_CONTINUE;
+}
+
 BamfLegacyScreen *
 bamf_legacy_screen_get_default ()
 {
@@ -456,6 +514,14 @@
   g_signal_connect (G_OBJECT (self->priv->legacy_screen), "active-window-changed",
                     (GCallback) handle_active_window_changed, self);
 
+  if (g_strcmp0 (g_getenv ("XDG_CURRENT_DESKTOP"), "Unity") == 0)
+    {
+      Display *dpy = gdk_x11_get_default_xdisplay ();
+      _COMPIZ_TOOLKIT_ACTION = XInternAtom (dpy, "_COMPIZ_TOOLKIT_ACTION", False);
+      _COMPIZ_TOOLKIT_ACTION_WINDOW_MENU = XInternAtom (dpy, "_COMPIZ_TOOLKIT_ACTION_WINDOW_MENU", False);
+      gdk_window_add_filter (NULL, filter_compiz_messages, self);
+    }
+
   return static_screen;
 }
 

=== modified file 'src/bamf-legacy-window-test.c'
--- src/bamf-legacy-window-test.c	2014-01-07 19:15:14 +0000
+++ src/bamf-legacy-window-test.c	2014-02-14 01:33:57 +0000
@@ -436,6 +436,10 @@
   return g_strdup (BAMF_LEGACY_WINDOW_TEST (window)->icon);
 }
 
+void
+bamf_legacy_window_test_show_action_menu (BamfLegacyWindow *window, guint32 time, guint button, gint x, gint y)
+{}
+
 static void
 bamf_legacy_window_test_finalize (GObject *object)
 {
@@ -488,6 +492,7 @@
   win_class->is_closed        = bamf_legacy_window_test_is_closed;
   win_class->get_hint         = bamf_legacy_window_test_get_hint;
   win_class->set_hint         = bamf_legacy_window_test_set_hint;
+  win_class->show_action_menu = bamf_legacy_window_test_show_action_menu;
   win_class->reopen           = bamf_legacy_window_test_reopen;
 }
 

=== modified file 'src/bamf-legacy-window.c'
--- src/bamf-legacy-window.c	2013-08-08 11:49:22 +0000
+++ src/bamf-legacy-window.c	2014-02-14 01:33:57 +0000
@@ -539,6 +539,36 @@
 }
 
 static void
+top_window_action_menu (GtkMenu *menu, gint *x, gint *y, gboolean *push, gpointer data)
+{
+  BamfLegacyWindow *self = data;
+  gint w, h;
+  wnck_window_get_client_window_geometry (self->priv->legacy_window, x, y, &w, &h);
+  *push = TRUE;
+}
+
+void bamf_legacy_window_show_action_menu (BamfLegacyWindow *self, guint32 time,
+                                          guint button, gint x, gint y)
+{
+  g_return_if_fail (BAMF_IS_LEGACY_WINDOW (self));
+
+  if (BAMF_LEGACY_WINDOW_GET_CLASS (self)->show_action_menu)
+    return BAMF_LEGACY_WINDOW_GET_CLASS (self)->show_action_menu (self, button, time, x, y);
+
+  g_return_if_fail (WNCK_IS_WINDOW (self->priv->legacy_window));
+
+  GtkWidget *menu = wnck_action_menu_new (self->priv->legacy_window);
+  g_signal_connect (G_OBJECT (menu), "unmap", G_CALLBACK (g_object_unref), NULL);
+  g_object_ref_sink (menu);
+
+  gtk_menu_set_screen (GTK_MENU (menu), gdk_screen_get_default ());
+  gtk_widget_show (menu);
+
+  GtkMenuPositionFunc position = button ? NULL : top_window_action_menu;
+  gtk_menu_popup (GTK_MENU (menu), NULL, NULL, position, self, button, time);
+}
+
+static void
 handle_window_closed (WnckScreen *screen,
                       WnckWindow *window,
                       BamfLegacyWindow *self)

=== modified file 'src/bamf-legacy-window.h'
--- src/bamf-legacy-window.h	2013-08-08 11:49:22 +0000
+++ src/bamf-legacy-window.h	2014-02-14 01:33:57 +0000
@@ -99,6 +99,8 @@
                                            gint *x, gint *y, gint *w, gint *h);
   void         (*set_hint)                (BamfLegacyWindow *legacy_window,
                                            const gchar *name, const gchar *value);
+  void         (*show_action_menu)        (BamfLegacyWindow *legacy_window,
+                                           guint32 time, guint button, gint x, gint y);
   void         (*reopen)                  (BamfLegacyWindow *legacy_window);
 
   /*< signals >*/
@@ -169,6 +171,10 @@
 
 gint               bamf_legacy_window_get_stacking_position (BamfLegacyWindow *self);
 
+void               bamf_legacy_window_show_action_menu     (BamfLegacyWindow *self,
+                                                            guint32 time, guint button,
+                                                            gint x, gint y);
+
 void               bamf_legacy_window_reopen               (BamfLegacyWindow *self);
 
 BamfLegacyWindow * bamf_legacy_window_new                  (WnckWindow *legacy_window);

=== modified file 'src/bamf-xutils.c'
--- src/bamf-xutils.c	2013-10-29 00:31:14 +0000
+++ src/bamf-xutils.c	2014-02-14 01:33:57 +0000
@@ -19,6 +19,7 @@
  */
 
 #include "bamf-xutils.h"
+#include <X11/Xatom.h>
 #include <string.h>
 
 static Display *

=== modified file 'src/bamf-xutils.h'
--- src/bamf-xutils.h	2012-10-09 08:32:34 +0000
+++ src/bamf-xutils.h	2014-02-14 01:33:57 +0000
@@ -22,7 +22,6 @@
 #define __BAMF_XUTILS_H__
 
 #include <glib.h>
-#include <X11/Xatom.h>
 #include <X11/Xlib.h>
 #include <gdk/gdkx.h>