1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
/*
* Copyright © 2016 Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU 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 warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Authored by: Alan Griffiths <alan@octopull.co.uk>
*/
#ifndef MIRAL_WINDOW_MANAGER_TOOLS_IMPLEMENTATION_H
#define MIRAL_WINDOW_MANAGER_TOOLS_IMPLEMENTATION_H
#include "miral/application.h"
#include <mir/geometry/displacement.h>
#include <functional>
#include <memory>
namespace mir { namespace scene { class Surface; } }
namespace miral
{
class Window;
struct WindowInfo;
struct ApplicationInfo;
class WindowSpecification;
// The interface through which the policy instructs the controller.
class WindowManagerToolsImplementation
{
public:
/** @name Update Model
* These functions assume that the BasicWindowManager data structures can be accessed freely.
* I.e. they should only be used by a thread that has called the WindowManagementPolicy methods
* (where any necessary locks are held) or via a invoke_under_lock() callback.
* @{ */
virtual auto count_applications() const -> unsigned int = 0;
virtual void for_each_application(std::function<void(ApplicationInfo& info)> const& functor) = 0;
virtual auto find_application(std::function<bool(ApplicationInfo const& info)> const& predicate)
-> Application = 0;
virtual auto info_for(std::weak_ptr<mir::scene::Session> const& session) const -> ApplicationInfo& = 0;
virtual auto info_for(std::weak_ptr<mir::scene::Surface> const& surface) const -> WindowInfo& = 0;
virtual auto info_for(Window const& window) const -> WindowInfo& = 0;
virtual void ask_client_to_close(Window const& window) = 0;
virtual auto active_window() const -> Window = 0;
virtual auto select_active_window(Window const& hint) -> Window = 0;
virtual void drag_active_window(mir::geometry::Displacement movement) = 0;
virtual void focus_next_application() = 0;
virtual void focus_next_within_application() = 0;
virtual auto window_at(mir::geometry::Point cursor) const -> Window = 0;
virtual auto active_display() -> mir::geometry::Rectangle const = 0;
virtual void raise_tree(Window const& root) = 0;
virtual void modify_window(WindowInfo& window_info, WindowSpecification const& modifications) = 0;
virtual auto info_for_window_id(std::string const& id) const -> WindowInfo& = 0;
virtual auto id_for_window(Window const& window) const -> std::string = 0;
/** @} */
/** @name Multi-thread support
* Allows threads that don't hold a lock on the model to acquire one and call the "Update Model"
* member functions.
* This should NOT be used by a thread that has called the WindowManagementPolicy methods (and
* already holds the lock).
* @{ */
virtual void invoke_under_lock(std::function<void()> const& callback) = 0;
/** @} */
virtual ~WindowManagerToolsImplementation() = default;
WindowManagerToolsImplementation() = default;
WindowManagerToolsImplementation(WindowManagerToolsImplementation const&) = delete;
WindowManagerToolsImplementation& operator=(WindowManagerToolsImplementation const&) = delete;
};
}
#endif //MIRAL_WINDOW_MANAGER_TOOLS_IMPLEMENTATION_H
|