Merge lp:~3v1n0/compiz/push-grab-types into lp:compiz/0.9.12

[Marco Trevisan (Treviño)]

Screen: add pushKeyboardGrab and pushPointerGrab methods to add different kinds of grabs

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:3931
http://jenkins.qa.ubuntu.com/job/compiz-ci/80/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/compiz-wily-amd64-ci/25/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/compiz-wily-armhf-ci/25/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/compiz-wily-i386-ci/25/console

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

review: Needs Fixing (continuous-integration)

[lp:~3v1n0/compiz/push-grab-types]

3932. By Marco Trevisan (Treviño) on 2015-09-18

debian/patches/ubuntu_super_p.patch: refresh to fix merging

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:3932
http://jenkins.qa.ubuntu.com/job/compiz-ci/81/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/compiz-wily-amd64-ci/26/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/compiz-wily-armhf-ci/26/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/compiz-wily-i386-ci/26/console

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

review: Needs Fixing (continuous-integration)

[lp:~3v1n0/compiz/push-grab-types]

3933. By Marco Trevisan (Treviño) on 2015-09-18

Screen: use GrabType when calling removing or updating a Grab

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:3933
http://jenkins.qa.ubuntu.com/job/compiz-ci/84/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/compiz-wily-amd64-ci/29/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/compiz-wily-armhf-ci/29/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/compiz-wily-i386-ci/29/console

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

review: Needs Fixing (continuous-integration)

[lp:~3v1n0/compiz/push-grab-types]

3934. By Marco Trevisan (Treviño) on 2015-10-09

Screen: add missing space

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:3934
http://jenkins.qa.ubuntu.com/job/compiz-ci/93/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/compiz-wily-amd64-ci/38
    SUCCESS: http://jenkins.qa.ubuntu.com/job/compiz-wily-armhf-ci/38
    SUCCESS: http://jenkins.qa.ubuntu.com/job/compiz-wily-i386-ci/38

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

review: Approve (continuous-integration)

[lp:~3v1n0/compiz/push-grab-types]

3935. By Marco Trevisan (Treviño) on 2015-10-13

Screen: properly ungrab / change grab owners depending on the grab types

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:3935
http://jenkins.qa.ubuntu.com/job/compiz-ci/102/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/compiz-wily-amd64-ci/47
    SUCCESS: http://jenkins.qa.ubuntu.com/job/compiz-wily-armhf-ci/47
    SUCCESS: http://jenkins.qa.ubuntu.com/job/compiz-wily-i386-ci/47

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

review: Approve (continuous-integration)

[lp:~3v1n0/compiz/push-grab-types]

3936. By Marco Trevisan (Treviño) on 2015-10-26

PrivateScreen: fix typo in GrabType definition

[Andrea Azzarone (azzar1)]

LGTM

review: Approve

[lp:~3v1n0/compiz/push-grab-types]

3937. By Marco Trevisan (Treviño) on 2015-10-26

Merging with trunk

[MC Return (mc-return)]

I'm late to the party, but wanted to express a:
Great job on that one, Marco. +1

Very useful separation indeed. Top Job.

review: Approve

=== modified file 'include/core/abiversion.h'
--- include/core/abiversion.h	2015-02-17 14:57:27 +0000
+++ include/core/abiversion.h	2015-10-26 17:12:40 +0000
@@ -5,6 +5,6 @@
 #  error Conflicting definitions of CORE_ABIVERSION
 #endif
 
-#define CORE_ABIVERSION 20150217
+#define CORE_ABIVERSION 20150918
 
 #endif // COMPIZ_ABIVERSION_H

=== modified file 'include/core/screen.h'
--- include/core/screen.h	2012-12-03 10:36:42 +0000
+++ include/core/screen.h	2015-10-26 17:12:40 +0000
@@ -364,6 +364,8 @@
     virtual CompIcon *defaultIcon () const = 0;
     virtual bool otherGrabExist (const char *, ...) = 0;
     virtual GrabHandle pushGrab (Cursor cursor, const char *name) = 0;
+    virtual GrabHandle pushPointerGrab (Cursor cursor, const char *name) = 0;
+    virtual GrabHandle pushKeyboardGrab (const char *name) = 0;
     virtual void removeGrab (GrabHandle handle, CompPoint *restorePointer) = 0;
     virtual bool writeImageToFile (CompString &path,
 			       const char *format,

=== modified file 'src/privatescreen.h'
--- src/privatescreen.h	2014-12-02 19:37:10 +0000
+++ src/privatescreen.h	2015-10-26 17:12:40 +0000
@@ -239,6 +239,20 @@
 	CompStringSet blacklist;
 };
 
+enum GrabType {
+    POINTER = 1 << 0,
+    KEYBOARD = 1 << 1,
+    ALL = POINTER|KEYBOARD
+};
+
+struct Grab {
+    Grab (GrabType type, Cursor cursor, const char *name) : type(type), cursor(cursor), name(name) {}
+    Grab (Cursor cursor, const char *name) : Grab(GrabType::ALL, cursor, name) {}
+    GrabType   type;
+    Cursor     cursor;
+    const char *name;
+};
+
 class GrabList
 {
     // TODO: std::list<Grab *> is almost certainly the wrong data
@@ -249,13 +263,14 @@
 public:
     typedef GrabPtrList::iterator GrabIterator;
 
-    bool grabsEmpty() const { return grabs.empty(); }
-    void grabsPush(Grab* grab) { grabs.push_back (grab); }
-    GrabIterator grabsBegin() { return grabs.begin(); }
-    GrabIterator grabsEnd() { return grabs.end(); }
-    void grabsRemove(Grab* grab);
+    bool grabsEmpty () const { return grabs.empty (); }
+    void grabsPush (Grab* grab) { grabs.push_back (grab); }
+    GrabIterator grabsBegin () { return begin (grabs); }
+    GrabIterator grabsEnd () { return end (grabs); }
+    void grabsRemove (Grab* grab);
     bool grabExist (const char *grab);
-    Grab* grabsBack() { return grabs.back (); }
+    Grab* topGrab (GrabType t) { auto it = std::find_if (begin (grabs), end (grabs), [t] (Grab *g) { return (g->type & t); }); return (it != end (grabs)) ? *it : NULL; }
+    Grab* grabsBack () { return grabs.back (); }
 
 private:
     GrabPtrList grabs;
@@ -349,12 +364,6 @@
 	int          count;
 };
 
-struct Grab {
-	Grab(Cursor cursor, const char *name) : cursor(cursor), name(name) {}
-	Cursor     cursor;
-	const char *name;
-};
-
 // data members that don't belong (these probably belong
 // in CompScreenImpl as PrivateScreen doesn't use them)
 struct OrphanData : boost::noncopyable
@@ -571,9 +580,6 @@
     Display* const& dpy;
 };
 
-
-
-
 unsigned int windowStateMask (Atom state);
 
 }} // namespace compiz::private_screen
@@ -703,6 +709,10 @@
 	static void compScreenSnEvent (SnMonitorEvent *event,
 			   void           *userData);
 
+	CompScreen::GrabHandle pushGrabGeneric (::compiz::private_screen::GrabType type,
+						Cursor cursor,
+						const char *name);
+
 	int  getXkbEvent() const { return xkbEvent.get(); }
 	std::vector<XineramaScreenInfo>& getScreenInfo () { return screenInfo; }
 	SnDisplay* getSnDisplay () const { return snDisplay; }
@@ -963,6 +973,12 @@
 	 * be grabbed once and the actual grab refcounted */
 	GrabHandle pushGrab (Cursor cursor, const char *name);
 
+	/* Adds an X Pointer grab to the stack. */
+	GrabHandle pushPointerGrab (Cursor cursor, const char *name);
+
+	/* Adds an X Keyboard grab to the stack. */
+    	GrabHandle pushKeyboardGrab (const char *name);
+
 	/* Allows you to change the pointer of your grab */
 	void updateGrab (GrabHandle handle, Cursor cursor);
 

=== modified file 'src/privatescreen/tests/test-privatescreen.cpp'
--- src/privatescreen/tests/test-privatescreen.cpp	2015-09-23 23:17:54 +0000
+++ src/privatescreen/tests/test-privatescreen.cpp	2015-10-26 17:12:40 +0000
@@ -148,6 +148,8 @@
     MOCK_CONST_METHOD0(defaultIcon, CompIcon *());
     virtual bool otherGrabExist (const char *, ...) { return false; }  // TODO How to mock?
     MOCK_METHOD2(pushGrab, GrabHandle (Cursor cursor, const char *name));
+    MOCK_METHOD2(pushPointerGrab, GrabHandle (Cursor cursor, const char *name));
+    MOCK_METHOD1(pushKeyboardGrab, GrabHandle (const char *name));
     MOCK_METHOD2(removeGrab, void (GrabHandle handle, CompPoint *restorePointer));
     MOCK_METHOD4(writeImageToFile, bool (CompString &path,
 			       const char *format,

=== modified file 'src/screen.cpp'
--- src/screen.cpp	2014-12-02 19:37:10 +0000
+++ src/screen.cpp	2015-10-26 17:12:40 +0000
@@ -104,7 +104,7 @@
 void CompScreenImpl::sizePluginClasses(unsigned int size)
 {
     if(size != pluginClasses.size ())
- 	pluginClasses.resize (size);
+	pluginClasses.resize (size);
 }
 
 void CompScreenImpl::setWindowState (unsigned int state, Window id)
@@ -712,7 +712,7 @@
 	return false;
 
     if (!CompOption::findOption (getOptions (), name, &index))
-        return false;
+	return false;
 
     switch (index) {
 	case CoreOptions::ActivePlugins:
@@ -870,7 +870,7 @@
 	    break;
 	default:
 	    break;
-        }
+	}
 
 	sn_display_process_event (snDisplay, &event);
 
@@ -1584,8 +1584,8 @@
 
     i = compiz::window::fillStateData (state, data);
     XChangeProperty (dpy, id, Atoms::winState,
-                     XA_ATOM, 32, PropModeReplace,
-                     (unsigned char *) data, i);
+		     XA_ATOM, 32, PropModeReplace,
+		     (unsigned char *) data, i);
 }
 
 unsigned int
@@ -2760,10 +2760,10 @@
     }
     else
     {
-        CompWindow::Map::const_iterator it = windowsMap.find (id);
+	CompWindow::Map::const_iterator it = windowsMap.find (id);
 
-        if (it != windowsMap.end ())
-            return (lastFoundWindow = it->second);
+	if (it != windowsMap.end ())
+	    return (lastFoundWindow = it->second);
     }
 
     return 0;
@@ -2933,7 +2933,7 @@
 cps::WindowManager::eraseWindowFromMap (Window id)
 {
     if (id != 1)
-        windowsMap.erase (id);
+	windowsMap.erase (id);
 }
 
 void
@@ -3024,73 +3024,166 @@
 #define POINTER_GRAB_MASK (ButtonReleaseMask | \
 			   ButtonPressMask   | \
 			   PointerMotionMask)
-CompScreenImpl::GrabHandle
-CompScreenImpl::pushGrab (Cursor cursor, const char *name)
+
+CompScreen::GrabHandle
+PrivateScreen::pushGrabGeneric (cps::GrabType type,
+				Cursor cursor,
+				const char *name)
 {
-    if (privateScreen.eventManager.grabsEmpty ())
+    int status = GrabSuccess;
+
+    if (eventManager.grabsEmpty ())
     {
-	int status;
-
-	status = XGrabPointer (privateScreen.dpy, privateScreen.eventManager.getGrabWindow(), true,
-			       POINTER_GRAB_MASK,
-			       GrabModeAsync, GrabModeAsync,
-			       privateScreen.rootWindow(), cursor,
-			       CurrentTime);
+	if (type & cps::GrabType::POINTER)
+	{
+	    status = XGrabPointer (dpy, eventManager.getGrabWindow (), true,
+				   POINTER_GRAB_MASK,
+				   GrabModeAsync, GrabModeAsync,
+				   root, cursor,
+				   CurrentTime);
+	}
 
 	if (status == GrabSuccess)
 	{
-	    status = XGrabKeyboard (privateScreen.dpy,
-				    privateScreen.eventManager.getGrabWindow(), true,
+	    if (type & cps::GrabType::KEYBOARD)
+	    {
+		status = XGrabKeyboard (dpy,
+					eventManager.getGrabWindow (), true,
+					GrabModeAsync, GrabModeAsync,
+					CurrentTime);
+		if (status != GrabSuccess)
+		{
+		    if (type & cps::GrabType::POINTER)
+			XUngrabPointer (dpy, CurrentTime);
+
+		    return NULL;
+		}
+	    }
+	}
+	else
+	    return NULL;
+    }
+    else
+    {
+	if (type & cps::GrabType::POINTER)
+	{
+	    if (eventManager.topGrab (cps::GrabType::POINTER))
+	    {
+		XChangeActivePointerGrab (dpy, POINTER_GRAB_MASK,
+					  cursor, CurrentTime);
+	    }
+	    else
+	    {
+		status = XGrabPointer (dpy, eventManager.getGrabWindow (), true,
+				       POINTER_GRAB_MASK,
+				       GrabModeAsync, GrabModeAsync,
+				       root, cursor,
+				       CurrentTime);
+
+		if (status != GrabSuccess)
+		    return NULL;
+	    }
+	}
+
+	if ((type & cps::GrabType::KEYBOARD) &&
+            !eventManager.topGrab (cps::GrabType::KEYBOARD))
+	{
+	    status = XGrabKeyboard (dpy,
+				    eventManager.getGrabWindow (), true,
 				    GrabModeAsync, GrabModeAsync,
 				    CurrentTime);
+
 	    if (status != GrabSuccess)
 	    {
-		XUngrabPointer (privateScreen.dpy, CurrentTime);
+		if (type & cps::GrabType::POINTER)
+		{
+		    if (cps::Grab *lastPtrGrab = eventManager.topGrab (cps::GrabType::POINTER))
+		    {
+			XChangeActivePointerGrab (dpy, POINTER_GRAB_MASK,
+						  lastPtrGrab->cursor, CurrentTime);
+		    }
+		    else
+		    {
+		    	XUngrabPointer (dpy, CurrentTime);
+		    }
+		}
+
 		return NULL;
 	    }
 	}
-	else
-	    return NULL;
     }
-    else
+
+    cps::Grab *grab = new cps::Grab (type, cursor, name);
+    eventManager.grabsPush (grab);
+
+    return grab;
+}
+
+CompScreenImpl::GrabHandle
+CompScreenImpl::pushGrab (Cursor cursor, const char *name)
+{
+    return privateScreen.pushGrabGeneric(cps::GrabType::ALL, cursor, name);
+}
+
+CompScreenImpl::GrabHandle
+CompScreenImpl::pushPointerGrab (Cursor cursor, const char *name)
+{
+    return privateScreen.pushGrabGeneric(cps::GrabType::POINTER, cursor, name);
+}
+
+CompScreenImpl::GrabHandle
+CompScreenImpl::pushKeyboardGrab (const char *name)
+{
+    return privateScreen.pushGrabGeneric(cps::GrabType::KEYBOARD, XC_X_cursor, name);
+}
+
+void
+CompScreenImpl::updateGrab (CompScreen::GrabHandle handle, Cursor cursor)
+{
+    if (!handle || !(handle->type & cps::GrabType::POINTER))
+	return;
+
+    if (privateScreen.eventManager.topGrab (cps::GrabType::POINTER) == handle)
     {
 	XChangeActivePointerGrab (privateScreen.dpy, POINTER_GRAB_MASK,
 				  cursor, CurrentTime);
     }
 
-    cps::Grab *grab = new cps::Grab (cursor, name);
-    privateScreen.eventManager.grabsPush (grab);
-
-    return grab;
-}
-
-void
-CompScreenImpl::updateGrab (CompScreen::GrabHandle handle, Cursor cursor)
-{
-    if (!handle)
-	return;
-
-    XChangeActivePointerGrab (privateScreen.dpy, POINTER_GRAB_MASK,
-			      cursor, CurrentTime);
-
     handle->cursor = cursor;
 }
 
 void
 CompScreenImpl::removeGrab (CompScreen::GrabHandle handle,
-			CompPoint *restorePointer)
+			    CompPoint *restorePointer)
 {
     if (!handle)
 	return;
 
+    cps::GrabType removedType = handle->type;
     privateScreen.eventManager.grabsRemove(handle);
 
     if (!privateScreen.eventManager.grabsEmpty ())
     {
-	XChangeActivePointerGrab (privateScreen.dpy,
-				  POINTER_GRAB_MASK,
-				  privateScreen.eventManager.grabsBack ()->cursor,
-				  CurrentTime);
+	if (removedType & cps::GrabType::POINTER)
+	{
+	    if (CompScreen::GrabHandle topPtrGrab = privateScreen.eventManager.topGrab (cps::GrabType::POINTER))
+	    {
+		XChangeActivePointerGrab (privateScreen.dpy,
+					  POINTER_GRAB_MASK,
+					  topPtrGrab->cursor,
+					  CurrentTime);
+	    }
+	    else
+	    {
+	        XUngrabPointer (privateScreen.dpy, CurrentTime);
+	    }
+	}
+
+	if (removedType & cps::GrabType::KEYBOARD)
+	{
+	    if (!privateScreen.eventManager.topGrab (cps::GrabType::KEYBOARD))
+		XUngrabKeyboard (privateScreen.dpy, CurrentTime);
+	}
     }
     else
     {
@@ -3098,8 +3191,11 @@
 	    warpPointer (restorePointer->x () - pointerX,
 			 restorePointer->y () - pointerY);
 
-	XUngrabPointer (privateScreen.dpy, CurrentTime);
-	XUngrabKeyboard (privateScreen.dpy, CurrentTime);
+	if (removedType & cps::GrabType::POINTER)
+	    XUngrabPointer (privateScreen.dpy, CurrentTime);
+
+	if (removedType & cps::GrabType::KEYBOARD)
+	    XUngrabKeyboard (privateScreen.dpy, CurrentTime);
     }
 }
 
@@ -3265,12 +3361,12 @@
 	     * keys, and know to cancel the tap if <modifier>+k is pressed.
 	     */
 	    if (!(currentState & CompAction::StateIgnoreTap))
-            {
- 		int minCode, maxCode;
- 		XDisplayKeycodes (screen->dpy(), &minCode, &maxCode);
- 		for (k = minCode; k <= maxCode; k++)
- 		    grabUngrabOneKey (modifiers | modifierForKeycode | ignore, k, grab);
-            }
+	    {
+		int minCode, maxCode;
+		XDisplayKeycodes (screen->dpy(), &minCode, &maxCode);
+		for (k = minCode; k <= maxCode; k++)
+		    grabUngrabOneKey (modifiers | modifierForKeycode | ignore, k, grab);
+	    }
 	}
 
 	if (CompScreen::checkForError (screen->dpy()))
@@ -3517,7 +3613,7 @@
 CompScreenImpl::removeAction (CompAction *action)
 {
     if (!privateScreen.initialized ||
-        !action->active ())
+	!action->active ())
 	return;
 
     grabManager.setCurrentState(action->state());
@@ -3746,7 +3842,7 @@
 	pos = env.find (':');
 	if (pos != std::string::npos)
 	{
-            size_t pointPos = env.find ('.', pos);
+	    size_t pointPos = env.find ('.', pos);
 
 	    if (pointPos != std::string::npos)
 	    {
@@ -3754,7 +3850,7 @@
 	    }
 	    else
 	    {
-                unsigned int displayNum = atoi (env.substr (pos + 1).c_str ());
+		unsigned int displayNum = atoi (env.substr (pos + 1).c_str ());
 		env.erase (pos);
 		env.append (compPrintf (":%i", displayNum));
 	    }
@@ -5160,7 +5256,7 @@
     privateScreen.startupSequence.removeAllSequences ();
 
     while (!windowManager.getWindows().empty ())
-        delete windowManager.getWindows().front ();
+	delete windowManager.getWindows().front ();
 
     while (CompPlugin* p = CompPlugin::pop ())
 	CompPlugin::unload (p);