Merge lp:~compiz-team/compiz/compiz.fix_1159430 into lp:compiz/0.9.10

[Sam Spilsbury]

Handle ARGB desktop windows correctly.

core: compiz::private_screen::DesktopWindowCount - provide methods to
increment or decrement desktop windows based on their visual type.

desktopWindowCount () now returns the number of RGB and ARGB desktop windows,
argbDesktopWindowCount () just returns the number of ARGB desktop windows.

If they are equal, the only desktop window is ARGB.

opengl: Draw the root window background if the desktop window is ARGB.
wallpaper: Lie to core and say that our fake desktop window is RGB so that
core does not draw the root window background. Paint the desktop wallpaper
beneath the desktop window so that the ARGB desktop window is visible on
top of it.

Tests added for the increment/decrement logic in DesktopWindowCount.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:3742
http://jenkins.qa.ubuntu.com/job/compiz-ci/205/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/compiz-gles-ci/./build=pbuilder,distribution=raring,flavor=amd64/246/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/compiz-saucy-amd64-ci/18/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/compiz-saucy-armhf-ci/18/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/compiz-saucy-i386-ci/18/console

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:3743
http://jenkins.qa.ubuntu.com/job/compiz-ci/206/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/compiz-gles-ci/./build=pbuilder,distribution=raring,flavor=amd64/247/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/compiz-saucy-amd64-ci/19/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/compiz-saucy-armhf-ci/19/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/compiz-saucy-i386-ci/19/console

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:3744
http://jenkins.qa.ubuntu.com/job/compiz-ci/207/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/compiz-gles-ci/./build=pbuilder,distribution=raring,flavor=amd64/248
    SUCCESS: http://jenkins.qa.ubuntu.com/job/compiz-saucy-amd64-ci/20
    SUCCESS: http://jenkins.qa.ubuntu.com/job/compiz-saucy-armhf-ci/20
    SUCCESS: http://jenkins.qa.ubuntu.com/job/compiz-saucy-i386-ci/20

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

review: Approve (continuous-integration)

[MC Return (mc-return)]

I am sorry, I cannot test this...

(still on Raring, using a patched Nautilus 3.4 as Nautilus is getting worse and worse with each version)

review: Abstain

[MC Return (mc-return)]

Can anyone help with testing this on Saucy ?

[Alberts Muktupāvels (muktupavels)]

> Can anyone help with testing this on Saucy ?
How to test?

[Daniel van Vugt (vanvugt)]

Please re-target to lp:compiz

review: Needs Resubmitting

Unmerged revisions

3744. By Sam Spilsbury on 2013-06-22

Added more missing changes

3743. By Sam Spilsbury on 2013-06-21

Add missing change

3742. By Sam Spilsbury on 2013-06-21

Handle ARGB desktop windows correctly.

core: compiz::private_screen::DesktopWindowCount - provide methods to
increment or decrement desktop windows based on their visual type.

desktopWindowCount () now returns the number of RGB and ARGB desktop windows,
argbDesktopWindowCount () just returns the number of ARGB desktop windows.

If they are equal, the only desktop window is ARGB.

opengl: Draw the root window background if the desktop window is ARGB.
wallpaper: Lie to core and say that our fake desktop window is RGB so that
core does not draw the root window background. Paint the desktop wallpaper
beneath the desktop window so that the ARGB desktop window is visible on
top of it.

=== modified file 'debian/changelog'
--- debian/changelog	2013-06-01 00:10:24 +0000
+++ debian/changelog	2013-07-24 21:57:49 +0000
@@ -1,8 +1,9 @@
 compiz (1:0.9.10-0ubuntu1) UNRELEASED; urgency=low
 
   * Bump version to 0.9.10
+    - Bump ABI to 20130621
 
- -- Sam Spilsbury <smspillaz@interpol>  Thu, 25 Apr 2013 11:13:32 +0800
+ -- Sam Spilsbury <[e-mail]>  Thu, 25 Apr 2013 11:13:32 +0800
 
 compiz (1:0.9.9~daily13.02.28-0ubuntu1) raring; urgency=low
 

=== modified file 'include/core/abiversion.h'
--- include/core/abiversion.h	2013-04-17 06:58:36 +0000
+++ include/core/abiversion.h	2013-07-24 21:57:49 +0000
@@ -5,6 +5,6 @@
 #  error Conflicting definitions of CORE_ABIVERSION
 #endif
 
-#define CORE_ABIVERSION 20130415
+#define CORE_ABIVERSION 20130621
 
 #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	2013-07-24 21:57:49 +0000
@@ -167,9 +167,17 @@
 class DesktopWindowCount
 {
 public:
-    virtual void incrementDesktopWindowCount() = 0;
-    virtual void decrementDesktopWindowCount() = 0;
-    virtual int desktopWindowCount() = 0;
+
+    enum VisualType
+    {
+	RGB,
+	ARGB
+    };
+
+    virtual void incrementDesktopWindowCount (VisualType) = 0;
+    virtual void decrementDesktopWindowCount (VisualType) = 0;
+    virtual int desktopWindowCount () = 0;
+    virtual int argbDesktopWindowCount () = 0;
 protected:
     ~DesktopWindowCount() {}
 };

=== modified file 'plugins/opengl/src/paint.cpp'
--- plugins/opengl/src/paint.cpp	2013-06-28 01:10:57 +0000
+++ plugins/opengl/src/paint.cpp	2013-07-24 21:57:49 +0000
@@ -86,7 +86,12 @@
     if (!nBox)
 	return;
 
-    if (screen->desktopWindowCount ())
+    unsigned int rgbDesktops = screen->desktopWindowCount () -
+			       screen->argbDesktopWindowCount ();
+
+    /* RGB desktops are assumed to cover the entire background
+     * so we do not need to paint any background behind them */
+    if (rgbDesktops > 0)
     {
 	if (!backgroundTextures.empty ())
 	{

=== modified file 'plugins/wallpaper/src/wallpaper.cpp'
--- plugins/wallpaper/src/wallpaper.cpp	2013-05-15 22:15:41 +0000
+++ plugins/wallpaper/src/wallpaper.cpp	2013-07-24 21:57:49 +0000
@@ -567,8 +567,6 @@
 {
     WALLPAPER_SCREEN (screen);
 
-    bool ret = gWindow->glDraw (transform, attrib, region, mask);
-
     if ((!ws->desktop || ws->desktop == window) &&
 	!ws->backgroundsPrimary.empty()		&&
 	window->type () & CompWindowTypeDesktopMask)
@@ -597,6 +595,9 @@
 	ws->desktop = window;
     }
 
+    /* Draw wallpaper behind window */
+    bool ret = gWindow->glDraw (transform, attrib, region, mask);
+
     return ret;
 }
 
@@ -673,14 +674,40 @@
 	destroyFakeDesktopWindow ();
 }
 
+bool
+WallpaperWindow::alpha () const
+{
+    return true;
+}
+
 WallpaperWindow::WallpaperWindow (CompWindow *window) :
     PluginClassHandler <WallpaperWindow, CompWindow> (window),
     window (window),
     cWindow (CompositeWindow::get (window)),
     gWindow (GLWindow::get (window))
 {
+    WallpaperScreen *ws = WallpaperScreen::get (screen);
+
+    bool isFakeDesktopWindow =
+	window->id () == ws->fakeDesktop;
+
+    /* If we are the fake desktop, tell compiz that we have
+     * an alpha channel so that we don't get added to the argb
+     * desktop window count and compiz doesn't draw its own
+     * background */
+    WindowInterface::setHandler (window, isFakeDesktopWindow);
     CompositeWindowInterface::setHandler (cWindow, true);
     GLWindowInterface::setHandler (gWindow, true);
+
+    if (isFakeDesktopWindow)
+	ws->desktop = window;
+}
+
+WallpaperWindow::~WallpaperWindow ()
+{
+    WallpaperScreen *ws = WallpaperScreen::get (screen);
+    if (ws->desktop == window)
+	ws->desktop = NULL;
 }
 
 bool

=== modified file 'plugins/wallpaper/src/wallpaper.h'
--- plugins/wallpaper/src/wallpaper.h	2013-05-15 22:15:41 +0000
+++ plugins/wallpaper/src/wallpaper.h	2013-07-24 21:57:49 +0000
@@ -124,12 +124,14 @@
 
 class WallpaperWindow :
     public PluginClassHandler <WallpaperWindow, CompWindow>,
+    public WindowInterface,
     public CompositeWindowInterface,
     public GLWindowInterface
 {
     public:
 
 	WallpaperWindow (CompWindow *);
+	~WallpaperWindow ();
 
 	CompWindow      *window;
 	CompositeWindow *cWindow;
@@ -150,6 +152,8 @@
 
 	bool damageRect (bool            ,
 			 const CompRect &);
+
+	bool alpha () const;
 };
 
 #define WALLPAPER_SCREEN(s)				\

=== modified file 'src/event.cpp'
--- src/event.cpp	2013-06-28 01:10:57 +0000
+++ src/event.cpp	2013-07-24 21:57:49 +0000
@@ -1577,10 +1577,15 @@
 		{
 		    if (w->isViewable ())
 		    {
+			::compiz::DesktopWindowCount::VisualType visual =
+			    w->alpha () ?
+			    ::compiz::DesktopWindowCount::ARGB :
+			    ::compiz::DesktopWindowCount::RGB;
+
 			if (w->type () == CompWindowTypeDesktopMask)
-			    decrementDesktopWindowCount();
+			    decrementDesktopWindowCount (visual);
 			else if (type == CompWindowTypeDesktopMask)
-			    incrementDesktopWindowCount();
+			    incrementDesktopWindowCount (visual);
 		    }
 
 		    w->wmType () = type;

=== modified file 'src/privatescreen.h'
--- src/privatescreen.h	2013-05-12 08:20:10 +0000
+++ src/privatescreen.h	2013-07-24 21:57:49 +0000
@@ -531,11 +531,14 @@
 {
 public:
     DesktopWindowCount();
-    virtual void incrementDesktopWindowCount();
-    virtual void decrementDesktopWindowCount();
+
+    virtual void incrementDesktopWindowCount(VisualType);
+    virtual void decrementDesktopWindowCount(VisualType);
     virtual int desktopWindowCount();
+    virtual int argbDesktopWindowCount();
 private:
-    int       count;
+    int       rgbCount;
+    int       argbCount;
 };
 
 class MapNum :

=== modified file 'src/privatescreen/tests/test-privatescreen.cpp'
--- src/privatescreen/tests/test-privatescreen.cpp	2013-04-17 06:58:36 +0000
+++ src/privatescreen/tests/test-privatescreen.cpp	2013-07-24 21:57:49 +0000
@@ -144,6 +144,7 @@
 				CompSize   &size,
 				void       *&data));
     MOCK_METHOD0(desktopWindowCount, int ());
+    MOCK_METHOD0(argbDesktopWindowCount, int ());
     MOCK_METHOD0(attrib, XWindowAttributes ());
     MOCK_CONST_METHOD0(defaultIcon, CompIcon *());
     virtual bool otherGrabExist (const char *, ...) { return false; }  // TODO How to mock?
@@ -178,8 +179,8 @@
     MOCK_METHOD0(grabbed, bool ());
     MOCK_METHOD0(snDisplay, SnDisplay * ());
     MOCK_CONST_METHOD0(createFailed, bool ());
-    MOCK_METHOD0(incrementDesktopWindowCount, void ());
-    MOCK_METHOD0(decrementDesktopWindowCount, void ());
+    MOCK_METHOD1(incrementDesktopWindowCount, void (VisualType));
+    MOCK_METHOD1(decrementDesktopWindowCount, void (VisualType));
     MOCK_METHOD0(nextMapNum, unsigned int ());
     MOCK_CONST_METHOD0(updatePassiveKeyGrabs, void ());
     MOCK_METHOD1(updatePassiveButtonGrabs, void (Window serverFrame));
@@ -1416,3 +1417,67 @@
     ca::setActionActiveState (action, false);
     ASSERT_EQ (action.active (), false);
 }
+
+class DesktopWindowCountTest :
+    public ::testing::Test
+{
+    protected:
+
+	::compiz::private_screen::DesktopWindowCount count;
+};
+
+TEST_F (DesktopWindowCountTest, IncrementRGBIncCount)
+{
+    count.incrementDesktopWindowCount (compiz::DesktopWindowCount::RGB);
+    EXPECT_EQ (1, count.desktopWindowCount ());
+}
+
+TEST_F (DesktopWindowCountTest, IncrementRGBNoIncARGBCount)
+{
+    count.incrementDesktopWindowCount (compiz::DesktopWindowCount::RGB);
+    EXPECT_EQ (0, count.argbDesktopWindowCount ());
+}
+
+TEST_F (DesktopWindowCountTest, DecrementRGBDecCount)
+{
+    count.incrementDesktopWindowCount (compiz::DesktopWindowCount::RGB);
+    count.decrementDesktopWindowCount (compiz::DesktopWindowCount::RGB);
+    EXPECT_EQ (0, count.desktopWindowCount ());
+}
+
+TEST_F (DesktopWindowCountTest, DecrementRGBNoDecARGBCount)
+{
+    count.incrementDesktopWindowCount (compiz::DesktopWindowCount::RGB);
+    count.incrementDesktopWindowCount (compiz::DesktopWindowCount::ARGB);
+    count.decrementDesktopWindowCount (compiz::DesktopWindowCount::RGB);
+    EXPECT_EQ (1, count.argbDesktopWindowCount ());
+}
+
+TEST_F (DesktopWindowCountTest, IncrementARGBandRGBIncrementCountTwice)
+{
+    count.incrementDesktopWindowCount (compiz::DesktopWindowCount::RGB);
+    count.incrementDesktopWindowCount (compiz::DesktopWindowCount::ARGB);
+    EXPECT_EQ (2, count.desktopWindowCount ());
+}
+
+TEST_F (DesktopWindowCountTest, DecrementARGBandRGBDecrementCountTwice)
+{
+    count.incrementDesktopWindowCount (compiz::DesktopWindowCount::RGB);
+    count.incrementDesktopWindowCount (compiz::DesktopWindowCount::ARGB);
+    count.decrementDesktopWindowCount (compiz::DesktopWindowCount::RGB);
+    count.decrementDesktopWindowCount (compiz::DesktopWindowCount::ARGB);
+    EXPECT_EQ (0, count.desktopWindowCount ());
+}
+
+TEST_F (DesktopWindowCountTest, IncrementARGBNoIncRGBCount)
+{
+    count.incrementDesktopWindowCount (compiz::DesktopWindowCount::ARGB);
+    EXPECT_EQ (1, count.desktopWindowCount ());
+}
+
+TEST_F (DesktopWindowCountTest, NoRGBDesktopWindowsTest)
+{
+    count.incrementDesktopWindowCount (compiz::DesktopWindowCount::ARGB);
+    EXPECT_EQ (0, count.desktopWindowCount () -
+		  count.argbDesktopWindowCount ());
+}

=== modified file 'src/screen.cpp'
--- src/screen.cpp	2013-05-13 13:27:30 +0000
+++ src/screen.cpp	2013-07-24 21:57:49 +0000
@@ -4314,7 +4314,13 @@
 int
 cps::DesktopWindowCount::desktopWindowCount ()
 {
-    return count;
+    return rgbCount + argbCount;
+}
+
+int
+cps::DesktopWindowCount::argbDesktopWindowCount ()
+{
+    return argbCount;
 }
 
 unsigned int
@@ -4627,20 +4633,27 @@
     windowManager.incrementPendingDestroys();
 }
 
-cps::DesktopWindowCount::DesktopWindowCount() :
-count(0)
+cps::DesktopWindowCount::DesktopWindowCount () :
+    rgbCount (0),
+    argbCount (0)
 {
 }
 
 void
-cps::DesktopWindowCount::incrementDesktopWindowCount()
+cps::DesktopWindowCount::incrementDesktopWindowCount (VisualType type)
 {
-    count++;
+    if (type == ARGB)
+	++argbCount;
+    else
+	++rgbCount;
 }
 void
-cps::DesktopWindowCount::decrementDesktopWindowCount()
+cps::DesktopWindowCount::decrementDesktopWindowCount (VisualType type)
 {
-    count--;
+    if (type == ARGB)
+	--argbCount;
+    else
+	--rgbCount;
 }
 
 cps::MapNum::MapNum() :

=== modified file 'src/window.cpp'
--- src/window.cpp	2013-07-19 18:39:38 +0000
+++ src/window.cpp	2013-07-24 21:57:49 +0000
@@ -1337,7 +1337,13 @@
 	screen->updateClientList ();
 
 	if (priv->type & CompWindowTypeDesktopMask)
-	    screen->incrementDesktopWindowCount();
+	{
+	    ::compiz::DesktopWindowCount::VisualType visual =
+		alpha () ?
+		::compiz::DesktopWindowCount::ARGB :
+		::compiz::DesktopWindowCount::RGB;
+	    screen->incrementDesktopWindowCount (visual);
+	}
 
 	if (priv->protocols & CompWindowProtocolSyncRequestMask)
 	{
@@ -1421,7 +1427,13 @@
 	return;
 
     if (priv->type == CompWindowTypeDesktopMask)
-	screen->decrementDesktopWindowCount();
+    {
+	::compiz::DesktopWindowCount::VisualType visual =
+	    alpha () ?
+	    ::compiz::DesktopWindowCount::ARGB :
+	    ::compiz::DesktopWindowCount::RGB;
+	screen->decrementDesktopWindowCount (visual);
+    }
 
     priv->attrib.map_state = IsUnmapped;
     priv->invisible        = true;
@@ -6219,8 +6231,13 @@
 
     if (priv->attrib.map_state == IsViewable)
     {
+	::compiz::DesktopWindowCount::VisualType visual =
+	    alpha () ?
+	    ::compiz::DesktopWindowCount::ARGB :
+	    ::compiz::DesktopWindowCount::RGB;
+
 	if (priv->type == CompWindowTypeDesktopMask)
-	    screen->decrementDesktopWindowCount ();
+	    screen->decrementDesktopWindowCount (visual);
 
 	if (priv->destroyed && priv->struts)
 	    screen->updateWorkarea ();