Mir
wayland_extensions.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2018-2019 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify it
5  * under the terms of the GNU General Public License version 2 or 3 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Alan Griffiths <alan@octopull.co.uk>
17  */
18 
19 #ifndef MIRAL_WAYLAND_EXTENSIONS_H
20 #define MIRAL_WAYLAND_EXTENSIONS_H
21 
22 #include "application.h"
23 
24 #include <functional>
25 #include <memory>
26 #include <string>
27 #include <set>
28 
29 struct wl_display;
30 struct wl_client;
31 struct wl_resource;
32 
33 namespace mir { class Server; }
34 
35 namespace miral
36 {
37 class Window;
38 
48 {
49 public:
52 
53  void operator()(mir::Server& server) const;
54 
58 
63  auto all_supported() const -> std::set<std::string>;
64 
67  class Context
68  {
69  public:
70  virtual auto display() const -> wl_display* = 0;
71  virtual void run_on_wayland_mainloop(std::function<void()>&& work) const = 0;
72 
73  protected:
74  Context() = default;
75  virtual ~Context() = default;
76  Context(Context const&) = delete;
77  Context& operator=(Context const&) = delete;
78  };
79 
82  struct Builder
83  {
85  std::string name;
86 
92  std::function<std::shared_ptr<void>(Context const* context)> build;
93  };
94 
96  using Filter = std::function<bool(Application const& app, char const* protocol)>;
97 
100  void set_filter(Filter const& extension_filter);
101 
112  static char const* const zwlr_layer_shell_v1;
113 
116  static char const* const zxdg_output_manager_v1;
117 
122  static char const* const zwlr_foreign_toplevel_manager_v1;
127  void add_extension(Builder const& builder);
128 
132 
136  static auto recommended() -> std::set<std::string>;
137 
142  static auto supported() -> std::set<std::string>;
143 
147  auto enable(std::string name) -> WaylandExtensions&;
148 
152  auto disable(std::string name) -> WaylandExtensions&;
153 
154 private:
155  struct Self;
156  std::shared_ptr<Self> self;
157 };
158 
162 auto application_for(wl_client* client) -> Application;
163 
167 auto application_for(wl_resource* resource) -> Application;
168 
176 auto window_for(wl_resource* surface) -> Window;
177 }
178 
179 #endif //MIRAL_WAYLAND_EXTENSIONS_H
Context information useful for implementing Wayland extensions.
Definition: wayland_extensions.h:68
virtual auto display() const -> wl_display *=0
Enable configuration of the Wayland extensions enabled at runtime.
Definition: wayland_extensions.h:48
static char const *const zwlr_layer_shell_v1
Supported wayland extensions that are not enabled by default.
Definition: wayland_extensions.h:112
static auto supported() -> std::set< std::string >
The set of Wayland extensions that core Mir supports. Does not include bespoke extensions A superset ...
void add_extension_disabled_by_default(Builder const &builder)
Add a bespoke Wayland extension both to "supported" but not "enabled by default".
void add_extension(Builder const &builder)
Add a bespoke Wayland extension both to "supported" and "enabled by default".
static auto recommended() -> std::set< std::string >
The set of Wayland extensions that Mir recommends. Also the set that is enabled by default upon const...
auto operator=(WaylandExtensions const &) -> WaylandExtensions &
WaylandExtensions(WaylandExtensions const &)
static char const *const zxdg_output_manager_v1
Allows clients to retrieve additional information about outputs.
Definition: wayland_extensions.h:116
void operator()(mir::Server &server) const
auto enable(std::string name) -> WaylandExtensions &
Enable a Wayland extension Throws a std::runtime_error if the extension is not supported.
std::function< bool(Application const &app, char const *protocol)> Filter
Definition: wayland_extensions.h:96
auto disable(std::string name) -> WaylandExtensions &
Disable a Wayand extension Throws a std::runtime_error if the extension is not supported.
auto all_supported() const -> std::set< std::string >
All Wayland extensions supported. This includes both the supported() provided by Mir and any extensio...
static char const *const zwlr_foreign_toplevel_manager_v1
Allows a client to get information and gain control over all toplevels of all clients Useful for task...
Definition: wayland_extensions.h:122
void set_filter(Filter const &extension_filter)
Set an extension filter callback to control the extensions available to specific clients.
WaylandExtensions()
Default to enabling the extensions recommended by Mir.
Handle class to manage a Mir surface. It may be null (e.g. default initialized)
Definition: window.h:38
Definition: splash_session.h:24
Mir Abstraction Layer.
Definition: floating_window_manager.h:31
std::shared_ptr< mir::scene::Session > Application
Definition: application.h:34
auto application_for(wl_client *client) -> Application
Get the MirAL application for a wl_client.
auto window_for(wl_resource *surface) -> Window
Get the MirAL Window for a Wayland Surface, XdgSurface, etc. Note that there may not be a correspondi...
A Builder creates and registers an extension protocol.
Definition: wayland_extensions.h:83
std::function< std::shared_ptr< void >Context const *context)> build
Functor that creates and registers an extension protocol.
Definition: wayland_extensions.h:92
std::string name
Name of the protocol extension.
Definition: wayland_extensions.h:85

Copyright © 2012-2021 Canonical Ltd.
Generated on Wed Mar 31 15:54:02 UTC 2021
This documentation is licensed under the GPL version 2 or 3.