Merge lp:~robertcarr/unity-mir/default-input-focus into lp:unity-mir

[Robert Carr]

Focus the shell when no sessions are focused.

It's difficult with the current architecture for the shell to receive keyboard focus, as it does not have an associated application session. Work around this by implementing a defaulting FocusSetter, which assigns keyboard focus to the shell surface when focus would otherwise be cleared.

It's difficult with the current architecture for the shell to receive keyboard focus, as it does not have an associated application session. Work around this by implementing a defaulting FocusSetter, which assigns keyboard focus to the shell surface when focus would otherwise be cleared.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:102
http://jenkins.qa.ubuntu.com/job/unity-mir-ci/96/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-mir-saucy-amd64-ci/38
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-mir-saucy-armhf-ci/96
        deb: http://jenkins.qa.ubuntu.com/job/unity-mir-saucy-armhf-ci/96/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-mir-saucy-i386-ci/96

Click here to trigger a rebuild:
http://10.97.0.26:8080/job/unity-mir-ci/96/rebuild

review: Approve (continuous-integration)

[Gerry Boland (gerboland)]

Please adjust commit message to prepend a short description of the change - the discursive bit afterwards is fine.

+std::shared_ptr<mir::shell::FocusSetter> the_shell_focus_setter() override;
please fix the indent.

Code looks clean. Otherwise.

review: Approve (code review)

Unmerged revisions

=== modified file 'src/modules/Unity/Application/mirsurfacemanager.cpp'
--- src/modules/Unity/Application/mirsurfacemanager.cpp	2013-09-06 05:34:01 +0000
+++ src/modules/Unity/Application/mirsurfacemanager.cpp	2013-10-07 23:19:43 +0000
@@ -28,6 +28,7 @@
 #include "sessionlistener.h"
 #include "surfaceconfigurator.h"
 #include "surfacesource.h"
+#include "focussetter.h"
 #include "logging.h"
 
 namespace msh = mir::shell;
@@ -125,6 +126,9 @@
 {
     DLOG("MirSurfaceManager::shellSurfaceCreated (this=%p)", this);
     m_shellSurface = new MirSurface(surface, nullptr);
+
+    m_mirServer->focusSetter()->set_default_keyboard_target(surface);
+    
     Q_EMIT shellSurfaceChanged(m_shellSurface);
 }
 

=== added file 'src/unity-mir/focussetter.cpp'
--- src/unity-mir/focussetter.cpp	1970-01-01 00:00:00 +0000
+++ src/unity-mir/focussetter.cpp	2013-10-07 23:19:43 +0000
@@ -0,0 +1,56 @@
+/*
+ * Copyright (C) 2013 Canonical, Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License version 3, as published by
+ * the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranties of MERCHANTABILITY,
+ * SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <mir/shell/surface.h>
+
+#include "focussetter.h"
+#include "logging.h"
+
+namespace msh = mir::shell;
+
+FocusSetter::FocusSetter(std::shared_ptr<msh::FocusSetter> const& underlying_setter, std::shared_ptr<mir::shell::InputTargeter> const& keyboard_input_targeter, QObject *parent)
+    :   QObject(parent),
+        underlying_setter(underlying_setter),
+        keyboard_input_targeter(keyboard_input_targeter)
+{
+}
+
+FocusSetter::~FocusSetter()
+{
+}
+
+void FocusSetter::set_focus_to(std::shared_ptr<msh::Session> const& session)
+{
+    // Ensure we always call the underlying setter to dispatch focus/unfocus notifications.
+    underlying_setter->set_focus_to(session);
+    if (session == nullptr)
+    {
+        auto default_target = default_keyboard_target.lock();
+        if (!default_target)
+            return;
+        default_target->take_input_focus(keyboard_input_targeter);
+    }
+}
+
+void FocusSetter::set_default_keyboard_target(std::weak_ptr<msh::Surface> const& default_target)
+{
+    auto t = default_target.lock();
+    assert(t);
+
+    default_keyboard_target = default_target;
+    
+    t->take_input_focus(keyboard_input_targeter);
+}

=== added file 'src/unity-mir/focussetter.h'
--- src/unity-mir/focussetter.h	1970-01-01 00:00:00 +0000
+++ src/unity-mir/focussetter.h	2013-10-07 23:19:43 +0000
@@ -0,0 +1,56 @@
+/*
+ * Copyright (C) 2013 Canonical, Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License version 3, as published by
+ * the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranties of MERCHANTABILITY,
+ * SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef FOCUSSETTER_H
+#define FOCUSSETTER_H
+
+// mir
+#include <mir/shell/focus_setter.h>
+
+// Qt
+#include <QObject>
+
+namespace mir
+{
+namespace shell
+{
+class InputTargeter;
+class Surface;
+}
+}
+
+class FocusSetter : public QObject, public mir::shell::FocusSetter
+{
+    Q_OBJECT
+
+public:
+    FocusSetter(std::shared_ptr<mir::shell::FocusSetter> const& underlying_setter, std::shared_ptr<mir::shell::InputTargeter> const& keyboard_input_targeter, 
+                QObject *parent = 0);
+    ~FocusSetter();
+
+    void set_focus_to(std::shared_ptr<mir::shell::Session> const& session) override;
+    
+    // We support a surface to be given key input when focus is otherwise to be cleared.
+    void set_default_keyboard_target(std::weak_ptr<mir::shell::Surface> const& default_keyboard_target);
+
+private:
+    std::shared_ptr<mir::shell::FocusSetter> const underlying_setter;
+    std::shared_ptr<mir::shell::InputTargeter> const keyboard_input_targeter;
+    
+    std::weak_ptr<mir::shell::Surface> default_keyboard_target;
+};
+
+#endif // FOCUSSETTER_H

=== modified file 'src/unity-mir/shellserverconfiguration.cpp'
--- src/unity-mir/shellserverconfiguration.cpp	2013-08-21 23:10:11 +0000
+++ src/unity-mir/shellserverconfiguration.cpp	2013-10-07 23:19:43 +0000
@@ -22,6 +22,7 @@
 #include "surfacesource.h"
 #include "sessionauthorizer.h"
 #include "surfacecontroller.h"
+#include "focussetter.h"
 #include "logging.h"
 
 // mir
@@ -107,6 +108,16 @@
         });
 }
 
+std::shared_ptr<msh::FocusSetter>
+ShellServerConfiguration::the_shell_focus_setter()
+{
+    return shell_focus_setter(
+       [this]
+       {
+           return std::make_shared<FocusSetter>(DefaultServerConfiguration::the_shell_focus_setter(), the_input_targeter());
+       });
+}
+
 /************************************ Shell side ************************************/
 SessionAuthorizer *ShellServerConfiguration::sessionAuthorizer()
 {
@@ -130,3 +141,8 @@
 {
     return m_surfaceSource.get();
 }
+
+FocusSetter *ShellServerConfiguration::focusSetter()
+{
+    return static_cast<FocusSetter*>(the_shell_focus_setter().get());
+}

=== modified file 'src/unity-mir/shellserverconfiguration.h'
--- src/unity-mir/shellserverconfiguration.h	2013-08-21 23:10:11 +0000
+++ src/unity-mir/shellserverconfiguration.h	2013-10-07 23:19:43 +0000
@@ -20,6 +20,8 @@
 #include <QObject>
 #include <mir/default_server_configuration.h>
 
+
+class FocusSetter;
 class SessionListener;
 class SessionAuthorizer;
 class SurfaceSource;
@@ -43,6 +45,7 @@
     std::shared_ptr<mir::shell::SessionListener> the_shell_session_listener() override;
     std::shared_ptr<mir::shell::SurfaceConfigurator> the_shell_surface_configurator() override;
     std::shared_ptr<mir::shell::SurfaceFactory> the_shell_surface_factory() override;
+std::shared_ptr<mir::shell::FocusSetter> the_shell_focus_setter() override;
     std::shared_ptr<mir::frontend::SessionAuthorizer> the_session_authorizer() override;
     std::shared_ptr<mir::surfaces::SurfaceController> the_surface_controller() override;
 
@@ -52,6 +55,7 @@
     SessionListener *sessionListener();
     SurfaceConfigurator *surfaceConfigurator();
     SurfaceSource *surfaceSource();
+    FocusSetter *focusSetter();
 
 protected:
     std::shared_ptr<SurfaceSource> m_surfaceSource;

=== modified file 'src/unity-mir/unity-mir.pro'
--- src/unity-mir/unity-mir.pro	2013-09-26 09:51:23 +0000
+++ src/unity-mir/unity-mir.pro	2013-10-07 23:19:43 +0000
@@ -23,7 +23,8 @@
     shellserverconfiguration.cpp \
     surfacecontroller.cpp \
     surfacesource.cpp \
-    surfaceconfigurator.cpp
+    surfaceconfigurator.cpp \
+    focussetter.cpp
 
 HEADERS += \
     dbusscreen.h \
@@ -36,7 +37,8 @@
     surfacecontroller.h \
     surfacesource.h \
     surfaceconfigurator.h \
-    logging.h
+    logging.h \
+    focussetter.h
 
 target.path = $$[QT_INSTALL_LIBS]