Merge lp:~dgadomski/compiz/remember-focus-improved into lp:compiz/0.9.12

[Dariusz Gadomski]

Adds handling for the unity launcher initiated focusing. In CompWindow::activate() call the window id is cached for the appropriate viewport.

Additionally I have included Brandon's fix for LP: #1398512.

Fixes: LP: #1393020, LP: #1398512.

[Christopher Townsend (townsend)]

Please rebase to what's in lp:compiz now as there are 2 text conflicts when merging your branch. Once done, we'll continue reviewing.

review: Needs Fixing

[Christopher Townsend (townsend)]

Also, I'm targeting bug #1125442 instead of the other two because those other two were fixed in reverting the original fix and this MP still fixes the original bug without (hopefully) causing any regressions.

[Dariusz Gadomski (dgadomski)]

Please find the rebased version of the patches.

[Marco Trevisan (Treviño) (3v1n0)]

review: Needs Information

[Brandon Schaefer (brandontschaefer)]

One thing as well, new features like this need to be disabled by default. Though its a nice change it does still change the default behavior which means it needs to be false:

23 + <default>true</default>

review: Needs Fixing

[Brandon Schaefer (brandontschaefer)]

If i open an always on top window on the Top Left workspace then focus a window below, then move to the Top Right workspace. Then start moving randomly to any workspace (with out letting go) Doing this a few times and the always on top window gets focus... This seems to be not a wanted behavior.

review: Needs Fixing

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:3920
No commit message was specified in the merge proposal. Click on the following link and set the commit message (if you want a jenkins rebuild you need to trigger it yourself):
https://code.launchpad.net/~dgadomski/compiz/remember-focus-improved/+merge/245211/+edit-commit-message

http://jenkins.qa.ubuntu.com/job/compiz-ci/58/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/compiz-wily-amd64-ci/3/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/compiz-wily-armhf-ci/3/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/compiz-wily-i386-ci/3/console

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

review: Needs Fixing (continuous-integration)

[Sam Spilsbury (smspillaz)]

Is this branch still in use today?

Unmerged revisions

3920. By Brandon Schaefer on 2014-12-19

When you move through a workspace, it ends up saving the ActiveWindow() under
that workspace. This is incorrect, since that window doesn't belong to that
workspace.

The fix, is simple to double check a window belong to the workspace we are
attempting to restore focus to.

Fixes: 1398512

3919. By Dariusz Gadomski on 2014-12-19

CompScreen: Fix "Remember Focus" interaction with Unity launcher.

Adds an additional Window caching on explicit window activation.

Fixes: 1393020

3918. By Dariusz Gadomski on 2014-12-19

CompScreen: Save focused window id before changing viewport.

This allows to restore focus after returning to one of the previous viewport positions.
Introduces a new setting (General Options / Focus & Raise Behaviour / Remember Focus)
Fixes: LP #1125442

=== modified file 'include/core/screen.h'
--- include/core/screen.h	2012-12-03 10:36:42 +0000
+++ include/core/screen.h	2014-12-19 16:42:32 +0000
@@ -417,6 +417,7 @@
     virtual void setNextActiveWindow(Window id) = 0;
     virtual Window getNextActiveWindow() const = 0;
     virtual CompWindow * focusTopMostWindow () = 0;
+    virtual void saveViewportFocus (const CompPoint& vp, Window id) = 0;
     // End of "internal use only" functions
 
 protected:

=== modified file 'metadata/core.xml.in'
--- metadata/core.xml.in	2014-12-02 19:37:10 +0000
+++ metadata/core.xml.in	2014-12-19 16:42:32 +0000
@@ -141,6 +141,11 @@
 			<_long>Focus prevention windows</_long>
 			<default>any</default>
 			</option>
+			<option type="bool" name="remember_vp_focus">
+			<_short>Remember Focus</_short>
+			<_long>Remember Focus Per Workspace</_long>
+			<default>true</default>
+			</option>
 		</group>
 		<group>
 		<_short>Key bindings</_short>

=== modified file 'src/privatescreen.h'
--- src/privatescreen.h	2014-12-02 19:37:10 +0000
+++ src/privatescreen.h	2014-12-19 16:42:32 +0000
@@ -47,6 +47,7 @@
 
 #include "core_options.h"
 
+#include <map>
 #include <set>
 
 CompPlugin::VTable * getCoreVTable ();
@@ -89,6 +90,17 @@
     unsigned int		viewportY;
 };
 
+// to allow using CompPoint as std::map keys
+struct PointCompare
+{
+    bool operator () (const CompPoint& p1, const CompPoint& p2)
+    {
+	if (p1.x () == p2.x ())
+	    return p1.y () < p2.y ();
+	return p1.x () < p2.x ();
+    }
+};
+
 namespace compiz
 {
 namespace core
@@ -1071,6 +1083,7 @@
 	virtual void setNextActiveWindow(Window id);
 	virtual Window getNextActiveWindow() const;
 	virtual CompWindow * focusTopMostWindow ();
+	virtual void saveViewportFocus (const CompPoint& vp, Window id);
 
     public :
 
@@ -1165,6 +1178,8 @@
 
         bool handlePingTimeout();
 
+	CompWindow * findViewportFocusCandidate ();
+
         Window below;
 	CompTimer autoRaiseTimer_;
 	Window    autoRaiseWindow_;
@@ -1175,6 +1190,8 @@
         PrivateScreen privateScreen;
         compiz::private_screen::WindowManager windowManager;
         unsigned int showingDesktopMask_;
+	typedef std::map<CompPoint, Window, PointCompare> FocusMap;
+	FocusMap savedViewportFocus;
 };
 
 #endif

=== modified file 'src/screen.cpp'
--- src/screen.cpp	2014-12-02 19:37:10 +0000
+++ src/screen.cpp	2014-12-19 16:42:32 +0000
@@ -2688,6 +2688,11 @@
 	    }
 	}
     }
+    else
+    {
+	// check if there was a focused window stored
+	focus = findViewportFocusCandidate ();
+    }
 
     if (!focus)
     {
@@ -3784,6 +3789,8 @@
     if (!tx && !ty)
 	return;
 
+    saveViewportFocus (privateScreen.viewPort.vp, activeWindow ());
+
     privateScreen.viewPort.vp.setX (privateScreen.viewPort.vp.x () + tx);
     privateScreen.viewPort.vp.setY (privateScreen.viewPort.vp.y () + ty);
 
@@ -5155,6 +5162,41 @@
     return true;
 }
 
+void
+CompScreenImpl::saveViewportFocus (const CompPoint& vp, Window id)
+{
+    if (privateScreen.optionGetRememberVpFocus () &&
+	(privateScreen.optionGetHsize () * privateScreen.optionGetVsize () > 1))
+    {
+	if (id != None)
+	{
+	    savedViewportFocus[vp] = id;
+	}
+    }
+}
+
+CompWindow *
+CompScreenImpl::findViewportFocusCandidate ()
+{
+    if (privateScreen.optionGetRememberVpFocus () &&
+	(privateScreen.optionGetHsize () * privateScreen.optionGetVsize () > 1))
+    {
+	FocusMap::iterator it = savedViewportFocus.find (privateScreen.viewPort.vp);
+	if (it != savedViewportFocus.end ())
+	{
+	    Window id = it->second;
+	    CompWindow *const w = findWindow (id);
+	    savedViewportFocus.erase (it);
+
+	    if (w->defaultViewport () != privateScreen.viewPort.vp)
+		return NULL;
+
+	    return findWindow (id);
+	}
+    }
+    return NULL;
+}
+
 CompScreenImpl::~CompScreenImpl ()
 {
     privateScreen.startupSequence.removeAllSequences ();

=== modified file 'src/window.cpp'
--- src/window.cpp	2014-09-16 19:37:23 +0000
+++ src/window.cpp	2014-12-19 16:42:32 +0000
@@ -4484,6 +4484,7 @@
     priv->ensureWindowVisibility ();
     updateAttributes (CompStackingUpdateModeAboveFullscreen);
     moveInputFocusTo ();
+    screen->saveViewportFocus (defaultViewport (), id ());
 }
 
 #define PVertResizeInc (1 << 0)