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 <optional>
28 #include <set>
29 
30 struct wl_display;
31 struct wl_client;
32 struct wl_resource;
33 
34 namespace mir { class Server; }
35 
36 namespace miral
37 {
38 class Window;
39 
49 {
50 public:
53 
54  void operator()(mir::Server& server) const;
55 
59 
64  auto all_supported() const -> std::set<std::string>;
65 
68  class Context
69  {
70  public:
71  virtual auto display() const -> wl_display* = 0;
72  virtual void run_on_wayland_mainloop(std::function<void()>&& work) const = 0;
73 
74  protected:
75  Context() = default;
76  virtual ~Context() = default;
77  Context(Context const&) = delete;
78  Context& operator=(Context const&) = delete;
79  };
80 
83  struct Builder
84  {
86  std::string name;
87 
93  std::function<std::shared_ptr<void>(Context const* context)> build;
94  };
95 
98  class EnableInfo
99  {
100  public:
102  auto app() const -> Application const&;
104  auto name() const -> const char*;
106  auto user_preference() const -> std::optional<bool>;
107 
108  private:
109  friend WaylandExtensions;
110  EnableInfo(Application const& app, const char* name, std::optional<bool> user_preference);
111  struct Self;
112  std::unique_ptr<Self> const self;
113  };
114 
116  using Filter = std::function<bool(Application const& app, char const* protocol)>;
117 
119  using EnableCallback = std::function<bool(EnableInfo const& info)>;
120 
125  [[deprecated("use conditionally_enable() instead")]]
126  void set_filter(Filter const& extension_filter);
127 
138  static char const* const zwlr_layer_shell_v1;
139 
142  static char const* const zxdg_output_manager_v1;
143 
148  static char const* const zwlr_foreign_toplevel_manager_v1;
149 
154  static char const* const zwp_virtual_keyboard_manager_v1;
155 
156 
162  static char const* const zwp_input_method_manager_v2;
163 
168  [[deprecated("use zwp_virtual_keyboard_manager_v1 instead")]]
169  static char const* const zwp_virtual_keyboard_v1;
170  [[deprecated("use zwp_input_method_manager_v2 instead")]]
171  static char const* const zwp_input_method_v2;
177  void add_extension(Builder const& builder);
178 
182 
186  static auto recommended() -> std::set<std::string>;
187 
192  static auto supported() -> std::set<std::string>;
193 
198  auto enable(std::string name) -> WaylandExtensions&;
199 
204  auto disable(std::string name) -> WaylandExtensions&;
205 
210  auto conditionally_enable(std::string name, EnableCallback const& callback) -> WaylandExtensions&;
211 
212 private:
213  struct Self;
214  std::shared_ptr<Self> self;
215 };
216 
220 auto application_for(wl_client* client) -> Application;
221 
225 auto application_for(wl_resource* resource) -> Application;
226 
234 auto window_for(wl_resource* surface) -> Window;
235 }
236 
237 #endif //MIRAL_WAYLAND_EXTENSIONS_H
Context information useful for implementing Wayland extensions.
Definition: wayland_extensions.h:69
virtual auto display() const -> wl_display *=0
Information that can be used to determine if to enable a conditionally enabled extension.
Definition: wayland_extensions.h:99
auto app() const -> Application const &
The application that is being given access to this extension.
auto name() const -> const char *
The name of the extension/global, always the same as given to conditionally_enable()
auto user_preference() const -> std::optional< bool >
If the user has enabled or disabled this extension one of the wayland extension Mir options.
Enable configuration of the Wayland extensions enabled at runtime.
Definition: wayland_extensions.h:49
static char const *const zwlr_layer_shell_v1
Supported wayland extensions that are not enabled by default.
Definition: wayland_extensions.h:138
std::function< bool(EnableInfo const &info)> EnableCallback
Definition: wayland_extensions.h:119
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".
static char const *const zwp_virtual_keyboard_manager_v1
Allows clients to act as a virtual keyboard, useful for on-screen keyboards. Clients are not required...
Definition: wayland_extensions.h:154
static char const *const zwp_input_method_manager_v2
Allows clients (such as on-screen keyboards) to intercept physical key events and act as a source of ...
Definition: wayland_extensions.h:162
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...
static char const *const zwp_input_method_v2
Definition: wayland_extensions.h:171
static char const *const zwp_virtual_keyboard_v1
Definition: wayland_extensions.h:169
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:142
void operator()(mir::Server &server) const
auto enable(std::string name) -> WaylandExtensions &
Enable a Wayland extension by default. The user can still disable it with the drop-wayland-extensions...
std::function< bool(Application const &app, char const *protocol)> Filter
Definition: wayland_extensions.h:116
auto disable(std::string name) -> WaylandExtensions &
Disable a Wayland extension by default. The user can still enable it with the add-wayland-extensions ...
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:148
void set_filter(Filter const &extension_filter)
Set an extension filter callback to control the extensions available to specific clients....
auto conditionally_enable(std::string name, EnableCallback const &callback) -> WaylandExtensions &
Enable a Wayland extension only when the callback returns true. The callback can use info....
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:84
std::function< std::shared_ptr< void >Context const *context)> build
Functor that creates and registers an extension protocol.
Definition: wayland_extensions.h:93
std::string name
Name of the protocol extension's Wayland global.
Definition: wayland_extensions.h:86

Copyright © 2012-2022 Canonical Ltd.
Generated on Mon Feb 28 07:07:30 UTC 2022
This documentation is licensed under the GPL version 2 or 3.