CoCalc -- display_server

GitHub Repository: godotengine/godot
Path: blob/master/platform/linuxbsd/wayland/display_server_wayland.h
¹⁰²⁷⁸ views
1
/**************************************************************************/
2
/*  display_server_wayland.h                                              */
3
/**************************************************************************/
4
/*                         This file is part of:                          */
5
/*                             GODOT ENGINE                               */
6
/*                        https://godotengine.org                         */
7
/**************************************************************************/
8
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
10
/*                                                                        */
11
/* Permission is hereby granted, free of charge, to any person obtaining  */
12
/* a copy of this software and associated documentation files (the        */
13
/* "Software"), to deal in the Software without restriction, including    */
14
/* without limitation the rights to use, copy, modify, merge, publish,    */
15
/* distribute, sublicense, and/or sell copies of the Software, and to     */
16
/* permit persons to whom the Software is furnished to do so, subject to  */
17
/* the following conditions:                                              */
18
/*                                                                        */
19
/* The above copyright notice and this permission notice shall be         */
20
/* included in all copies or substantial portions of the Software.        */
21
/*                                                                        */
22
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */
23
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */
24
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */
26
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */
27
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */
28
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */
29
/**************************************************************************/
30

31
#pragma once
32

33
#ifdef WAYLAND_ENABLED
34

35
#include "wayland/wayland_thread.h"
36

37
#ifdef RD_ENABLED
38
#include "servers/rendering/rendering_device.h"
39

40
#ifdef VULKAN_ENABLED
41
#include "wayland/rendering_context_driver_vulkan_wayland.h"
42
#endif
43

44
#endif //RD_ENABLED
45

46
#ifdef GLES3_ENABLED
47
#include "drivers/egl/egl_manager.h"
48
#endif
49

50
#if defined(SPEECHD_ENABLED)
51
#include "tts_linux.h"
52
#endif
53

54
#ifdef DBUS_ENABLED
55
#include "freedesktop_at_spi_monitor.h"
56
#include "freedesktop_portal_desktop.h"
57
#include "freedesktop_screensaver.h"
58
#endif
59

60
#include "core/config/project_settings.h"
61
#include "core/input/input.h"
62
#include "servers/display_server.h"
63

64
#include <climits>
65
#include <cstdio>
66

67
#undef CursorShape
68

69
class DisplayServerWayland : public DisplayServer {
70
	GDSOFTCLASS(DisplayServerWayland, DisplayServer);
71

72
	struct WindowData {
73
		WindowID id = INVALID_WINDOW_ID;
74

75
		WindowID parent_id = INVALID_WINDOW_ID;
76

77
		// For popups.
78
		WindowID root_id = INVALID_WINDOW_ID;
79

80
		// For toplevels.
81
		List<WindowID> popup_stack;
82

83
		Rect2i rect;
84
		Size2i max_size;
85
		Size2i min_size;
86

87
		Rect2i safe_rect;
88

89
		bool emulate_vsync = false;
90

91
#ifdef GLES3_ENABLED
92
		struct wl_egl_window *wl_egl_window = nullptr;
93
#endif
94

95
		// Flags whether we have allocated a buffer through the video drivers.
96
		bool visible = false;
97

98
		DisplayServer::VSyncMode vsync_mode = VSYNC_ENABLED;
99

100
		uint32_t flags = 0;
101

102
		DisplayServer::WindowMode mode = WINDOW_MODE_WINDOWED;
103

104
		Callable rect_changed_callback;
105
		Callable window_event_callback;
106
		Callable input_event_callback;
107
		Callable drop_files_callback;
108
		Callable input_text_callback;
109

110
		String title;
111
		ObjectID instance_id;
112
	};
113

114
	struct CustomCursor {
115
		Ref<Resource> resource;
116
		Point2i hotspot;
117
	};
118

119
	enum class SuspendState {
120
		NONE, // Unsuspended.
121
		TIMEOUT, // Legacy fallback.
122
		CAPABILITY, // New "suspended" wm_capability flag.
123
	};
124

125
	CursorShape cursor_shape = CURSOR_ARROW;
126
	DisplayServer::MouseMode mouse_mode = DisplayServer::MOUSE_MODE_VISIBLE;
127
	DisplayServer::MouseMode mouse_mode_base = MOUSE_MODE_VISIBLE;
128
	DisplayServer::MouseMode mouse_mode_override = MOUSE_MODE_VISIBLE;
129
	bool mouse_mode_override_enabled = false;
130
	void _mouse_update_mode();
131

132
	HashMap<CursorShape, CustomCursor> custom_cursors;
133

134
	HashMap<WindowID, WindowData> windows;
135
	WindowID window_id_counter = MAIN_WINDOW_ID;
136

137
	WaylandThread wayland_thread;
138

139
	Context context;
140
	bool swap_cancel_ok = false;
141

142
	// NOTE: These are the based on WINDOW_FLAG_POPUP, which does NOT imply what it
143
	// seems. It's particularly confusing for our usecase, but just know that these
144
	// are the "take all input thx" windows while the `popup_stack` variable keeps
145
	// track of all the generic floating window concept.
146
	List<WindowID> popup_menu_list;
147
	BitField<MouseButtonMask> last_mouse_monitor_mask = MouseButtonMask::NONE;
148

149
	String ime_text;
150
	Vector2i ime_selection;
151

152
	SuspendState suspend_state = SuspendState::NONE;
153

154
	String rendering_driver;
155

156
#ifdef RD_ENABLED
157
	RenderingContextDriver *rendering_context = nullptr;
158
	RenderingDevice *rendering_device = nullptr;
159
#endif
160

161
#ifdef GLES3_ENABLED
162
	EGLManager *egl_manager = nullptr;
163
#endif
164

165
#ifdef SPEECHD_ENABLED
166
	TTS_Linux *tts = nullptr;
167
#endif
168
	NativeMenu *native_menu = nullptr;
169

170
#if DBUS_ENABLED
171
	FreeDesktopPortalDesktop *portal_desktop = nullptr;
172
	FreeDesktopAtSPIMonitor *atspi_monitor = nullptr;
173

174
	FreeDesktopScreenSaver *screensaver = nullptr;
175
	bool screensaver_inhibited = false;
176
#endif
177
	static String _get_app_id_from_context(Context p_context);
178

179
	void _send_window_event(WindowEvent p_event, WindowID p_window_id = MAIN_WINDOW_ID);
180

181
	static void dispatch_input_events(const Ref<InputEvent> &p_event);
182
	void _dispatch_input_event(const Ref<InputEvent> &p_event);
183

184
	void _update_window_rect(const Rect2i &p_rect, WindowID p_window_id = MAIN_WINDOW_ID);
185

186
	void try_suspend();
187

188
	void initialize_tts() const;
189

190
public:
191
	virtual bool has_feature(Feature p_feature) const override;
192

193
	virtual String get_name() const override;
194

195
#ifdef SPEECHD_ENABLED
196
	virtual bool tts_is_speaking() const override;
197
	virtual bool tts_is_paused() const override;
198
	virtual TypedArray<Dictionary> tts_get_voices() const override;
199

200
	virtual void tts_speak(const String &p_text, const String &p_voice, int p_volume = 50, float p_pitch = 1.f, float p_rate = 1.f, int p_utterance_id = 0, bool p_interrupt = false) override;
201
	virtual void tts_pause() override;
202
	virtual void tts_resume() override;
203
	virtual void tts_stop() override;
204
#endif
205

206
#ifdef DBUS_ENABLED
207
	virtual bool is_dark_mode_supported() const override;
208
	virtual bool is_dark_mode() const override;
209
	virtual Color get_accent_color() const override;
210
	virtual void set_system_theme_change_callback(const Callable &p_callable) override;
211

212
	virtual Error file_dialog_show(const String &p_title, const String &p_current_directory, const String &p_filename, bool p_show_hidden, FileDialogMode p_mode, const Vector<String> &p_filters, const Callable &p_callback, WindowID p_window_id) override;
213
	virtual Error file_dialog_with_options_show(const String &p_title, const String &p_current_directory, const String &p_root, const String &p_filename, bool p_show_hidden, FileDialogMode p_mode, const Vector<String> &p_filters, const TypedArray<Dictionary> &p_options, const Callable &p_callback, WindowID p_window_id) override;
214
#endif
215

216
	virtual void beep() const override;
217

218
	virtual void mouse_set_mode(MouseMode p_mode) override;
219
	virtual MouseMode mouse_get_mode() const override;
220
	virtual void mouse_set_mode_override(MouseMode p_mode) override;
221
	virtual MouseMode mouse_get_mode_override() const override;
222
	virtual void mouse_set_mode_override_enabled(bool p_override_enabled) override;
223
	virtual bool mouse_is_mode_override_enabled() const override;
224

225
	virtual void warp_mouse(const Point2i &p_to) override;
226
	virtual Point2i mouse_get_position() const override;
227
	virtual BitField<MouseButtonMask> mouse_get_button_state() const override;
228

229
	virtual void clipboard_set(const String &p_text) override;
230
	virtual String clipboard_get() const override;
231
	virtual Ref<Image> clipboard_get_image() const override;
232
	virtual void clipboard_set_primary(const String &p_text) override;
233
	virtual String clipboard_get_primary() const override;
234

235
	virtual int get_screen_count() const override;
236
	virtual int get_primary_screen() const override;
237
	virtual Point2i screen_get_position(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
238
	virtual Size2i screen_get_size(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
239
	virtual Rect2i screen_get_usable_rect(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
240
	virtual int screen_get_dpi(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
241
	virtual float screen_get_scale(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
242
	virtual float screen_get_refresh_rate(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
243

244
	virtual void screen_set_keep_on(bool p_enable) override;
245
	virtual bool screen_is_kept_on() const override;
246

247
	virtual Vector<DisplayServer::WindowID> get_window_list() const override;
248

249
	virtual WindowID create_sub_window(WindowMode p_mode, VSyncMode p_vsync_mode, uint32_t p_flags, const Rect2i &p_rect = Rect2i(), bool p_exclusive = false, WindowID p_transient_parent = INVALID_WINDOW_ID) override;
250
	virtual void show_window(WindowID p_id) override;
251
	virtual void delete_sub_window(WindowID p_id) override;
252

253
	virtual WindowID window_get_active_popup() const override;
254
	virtual void window_set_popup_safe_rect(WindowID p_window, const Rect2i &p_rect) override;
255
	virtual Rect2i window_get_popup_safe_rect(WindowID p_window) const override;
256

257
	virtual int64_t window_get_native_handle(HandleType p_handle_type, WindowID p_window = MAIN_WINDOW_ID) const override;
258

259
	virtual WindowID get_window_at_screen_position(const Point2i &p_position) const override;
260

261
	virtual void window_attach_instance_id(ObjectID p_instance, WindowID p_window_id = MAIN_WINDOW_ID) override;
262
	virtual ObjectID window_get_attached_instance_id(WindowID p_window_id = MAIN_WINDOW_ID) const override;
263

264
	virtual void window_set_title(const String &p_title, WindowID p_window_id = MAIN_WINDOW_ID) override;
265
	virtual void window_set_mouse_passthrough(const Vector<Vector2> &p_region, WindowID p_window_id = MAIN_WINDOW_ID) override;
266

267
	virtual void window_set_rect_changed_callback(const Callable &p_callable, WindowID p_window_id = MAIN_WINDOW_ID) override;
268
	virtual void window_set_window_event_callback(const Callable &p_callable, WindowID p_window_id = MAIN_WINDOW_ID) override;
269
	virtual void window_set_input_event_callback(const Callable &p_callable, WindowID p_window_id = MAIN_WINDOW_ID) override;
270
	virtual void window_set_input_text_callback(const Callable &p_callable, WindowID p_window_id = MAIN_WINDOW_ID) override;
271
	virtual void window_set_drop_files_callback(const Callable &p_callable, WindowID p_window_id = MAIN_WINDOW_ID) override;
272

273
	virtual int window_get_current_screen(WindowID p_window_id = MAIN_WINDOW_ID) const override;
274
	virtual void window_set_current_screen(int p_screen, WindowID p_window_id = MAIN_WINDOW_ID) override;
275

276
	virtual Point2i window_get_position(WindowID p_window_id = MAIN_WINDOW_ID) const override;
277
	virtual Point2i window_get_position_with_decorations(WindowID p_window_id = MAIN_WINDOW_ID) const override;
278
	virtual void window_set_position(const Point2i &p_position, WindowID p_window_id = MAIN_WINDOW_ID) override;
279

280
	virtual void window_set_max_size(const Size2i p_size, WindowID p_window_id = MAIN_WINDOW_ID) override;
281
	virtual Size2i window_get_max_size(WindowID p_window_id = MAIN_WINDOW_ID) const override;
282
	virtual void gl_window_make_current(DisplayServer::WindowID p_window_id) override;
283

284
	virtual void window_set_transient(WindowID p_window_id, WindowID p_parent) override;
285

286
	virtual void window_set_min_size(const Size2i p_size, WindowID p_window_id = MAIN_WINDOW_ID) override;
287
	virtual Size2i window_get_min_size(WindowID p_window_id = MAIN_WINDOW_ID) const override;
288

289
	virtual void window_set_size(const Size2i p_size, WindowID p_window_id = MAIN_WINDOW_ID) override;
290
	virtual Size2i window_get_size(WindowID p_window_id = MAIN_WINDOW_ID) const override;
291
	virtual Size2i window_get_size_with_decorations(WindowID p_window_id = MAIN_WINDOW_ID) const override;
292

293
	virtual void window_set_mode(WindowMode p_mode, WindowID p_window_id = MAIN_WINDOW_ID) override;
294
	virtual WindowMode window_get_mode(WindowID p_window_id = MAIN_WINDOW_ID) const override;
295

296
	virtual bool window_is_maximize_allowed(WindowID p_window_id = MAIN_WINDOW_ID) const override;
297

298
	virtual void window_set_flag(WindowFlags p_flag, bool p_enabled, WindowID p_window_id = MAIN_WINDOW_ID) override;
299
	virtual bool window_get_flag(WindowFlags p_flag, WindowID p_window_id = MAIN_WINDOW_ID) const override;
300

301
	virtual void window_request_attention(WindowID p_window_id = MAIN_WINDOW_ID) override;
302

303
	virtual void window_move_to_foreground(WindowID p_window_id = MAIN_WINDOW_ID) override;
304
	virtual bool window_is_focused(WindowID p_window = MAIN_WINDOW_ID) const override;
305

306
	virtual bool window_can_draw(WindowID p_window_id = MAIN_WINDOW_ID) const override;
307

308
	virtual bool can_any_window_draw() const override;
309

310
	virtual void window_set_ime_active(const bool p_active, WindowID p_window_id = MAIN_WINDOW_ID) override;
311
	virtual void window_set_ime_position(const Point2i &p_pos, WindowID p_window_id = MAIN_WINDOW_ID) override;
312

313
	virtual int accessibility_should_increase_contrast() const override;
314
	virtual int accessibility_screen_reader_active() const override;
315

316
	virtual Point2i ime_get_selection() const override;
317
	virtual String ime_get_text() const override;
318

319
	virtual void window_set_vsync_mode(DisplayServer::VSyncMode p_vsync_mode, WindowID p_window_id = MAIN_WINDOW_ID) override;
320
	virtual DisplayServer::VSyncMode window_get_vsync_mode(WindowID p_window_id) const override;
321

322
	virtual void window_start_drag(WindowID p_window = MAIN_WINDOW_ID) override;
323
	virtual void window_start_resize(WindowResizeEdge p_edge, WindowID p_window) override;
324

325
	virtual void cursor_set_shape(CursorShape p_shape) override;
326
	virtual CursorShape cursor_get_shape() const override;
327
	virtual void cursor_set_custom_image(const Ref<Resource> &p_cursor, CursorShape p_shape, const Vector2 &p_hotspot) override;
328

329
	virtual bool get_swap_cancel_ok() override;
330

331
	virtual int keyboard_get_layout_count() const override;
332
	virtual int keyboard_get_current_layout() const override;
333
	virtual void keyboard_set_current_layout(int p_index) override;
334
	virtual String keyboard_get_layout_language(int p_index) const override;
335
	virtual String keyboard_get_layout_name(int p_index) const override;
336
	virtual Key keyboard_get_keycode_from_physical(Key p_keycode) const override;
337

338
	virtual bool color_picker(const Callable &p_callback) override;
339

340
	virtual void process_events() override;
341

342
	virtual void release_rendering_thread() override;
343
	virtual void swap_buffers() override;
344

345
	virtual void set_context(Context p_context) override;
346

347
	virtual bool is_window_transparency_available() const override;
348

349
	static DisplayServer *create_func(const String &p_rendering_driver, WindowMode p_mode, VSyncMode p_vsync_mode, uint32_t p_flags, const Point2i *p_position, const Size2i &p_resolution, int p_screen, Context p_context, int64_t p_parent_window, Error &r_error);
350
	static Vector<String> get_rendering_drivers_func();
351

352
	static void register_wayland_driver();
353

354
	DisplayServerWayland(const String &p_rendering_driver, WindowMode p_mode, VSyncMode p_vsync_mode, uint32_t p_flags, const Vector2i &p_resolution, Context p_context, int64_t p_parent_window, Error &r_error);
355
	~DisplayServerWayland();
356
};
357

358
#endif // WAYLAND_ENABLED
359

360
Product

Resources

Company
