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

[Dariusz Gadomski]

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)

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: 1125442

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

Just a few inline comments...

One thing on style, make sure that you follow the compiz style, for example, adding one space between the function name and the parenthesis (such as "function ();").

Also, the indentation should be (a little annoying, I know :P):
1st level: 4 spaces, 2nd level 1 tab (set at 8 spaces), 3rd level: 1 tab + 4 spaces, 4th level: 2 tabs, and so on... :)

[Dariusz Gadomski (dgadomski)]

Thanks Marco, I will improve the fix.

[lp:~dgadomski/compiz/remember-focus]

3891. By Dariusz Gadomski on 2014-10-02

Minor refactoring and style changes to remember-focus.

3892. By Dariusz Gadomski on 2014-10-02

Applied style fixes for PointCompare.

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

Looks good, just few more style fixes.

I was thinking that probably it would be better to rename the functions/members so that they mention the WS or VP (as you prefer) in their name, so that we have saveViewPortFocus() and findViewPortFocusCandidate()...

[lp:~dgadomski/compiz/remember-focus]

3893. By Dariusz Gadomski on 2014-10-02

remember_vp_focus is set to true by default.
Added 'viewport' to method names.
Corrected indentation.

[lp:~dgadomski/compiz/remember-focus]

3894. By Dariusz Gadomski on 2014-10-03

Erasing saved focus even if window was not found.

3895. By Dariusz Gadomski on 2014-10-03

Simplified findViewportFocusCandidate.

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

Cool, looks good!

review: Approve

=== modified file 'metadata/core.xml.in'
--- metadata/core.xml.in	2014-04-16 12:35:24 +0000
+++ metadata/core.xml.in	2014-10-03 10:15:44 +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	2013-12-17 21:35:41 +0000
+++ src/privatescreen.h	2014-10-03 10:15:44 +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
@@ -1165,6 +1177,9 @@
 
         bool handlePingTimeout();
 
+	void saveViewportFocus ();
+	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-06-06 09:42:08 +0000
+++ src/screen.cpp	2014-10-03 10:15:44 +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.setX (privateScreen.viewPort.vp.x () + tx);
     privateScreen.viewPort.vp.setY (privateScreen.viewPort.vp.y () + ty);
 
@@ -5155,6 +5162,37 @@
     return true;
 }
 
+void
+CompScreenImpl::saveViewportFocus ()
+{
+    if ((privateScreen.optionGetHsize () > 1 || privateScreen.optionGetVsize () > 1) &&
+	privateScreen.optionGetRememberVpFocus ())
+    {
+	Window id = activeWindow ();
+	if (id != None)
+	{
+	    savedViewportFocus[privateScreen.viewPort.vp] = id;
+	}
+    }
+}
+
+CompWindow *
+CompScreenImpl::findViewportFocusCandidate ()
+{
+    if ((privateScreen.optionGetHsize () > 1 || privateScreen.optionGetVsize () > 1) &&
+	privateScreen.optionGetRememberVpFocus ())
+    {
+	FocusMap::iterator it = savedViewportFocus.find (privateScreen.viewPort.vp);
+	if (it != savedViewportFocus.end ())
+	{
+	    Window id = it->second;
+	    savedViewportFocus.erase (it);
+	    return findWindow (id);
+	}
+    }
+    return NULL;
+}
+
 CompScreenImpl::~CompScreenImpl ()
 {
     privateScreen.startupSequence.removeAllSequences ();