1 /* GDK - The GIMP Drawing Kit
2 * Copyright (C) 2000 Red Hat, Inc.
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16 */
17
18 /*
19 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
20 * file for a list of people on the GTK+ Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
23 */
24
25 #include "config.h"
26
27 #include "gdkconfig.h"
28 #include "gdkdisplaymanagerprivate.h"
29 #include "gdkdisplayprivate.h"
30 #include "gdkinternals.h"
31 #include "gdkkeysprivate.h"
32 #include "gdkintl.h"
33
34 #ifdef GDK_WINDOWING_X11
35 #include "x11/gdkx.h"
36 #include "x11/gdkprivate-x11.h"
37 #endif
38
39 #ifdef GDK_WINDOWING_BROADWAY
40 #include "broadway/gdkprivate-broadway.h"
41 #endif
42
43 #ifdef GDK_WINDOWING_MACOS
44 #include "macos/gdkmacosdisplay-private.h"
45 #endif
46
47 #ifdef GDK_WINDOWING_WIN32
48 #include "win32/gdkwin32.h"
49 #include "win32/gdkprivate-win32.h"
50 #endif
51
52 #ifdef GDK_WINDOWING_WAYLAND
53 #include "wayland/gdkprivate-wayland.h"
54 #endif
55
56 /**
57 * GdkDisplayManager:
58 *
59 * A singleton object that offers notification when displays appear or
60 * disappear.
61 *
62 * You can use [func@Gdk.DisplayManager.get] to obtain the `GdkDisplayManager`
63 * singleton, but that should be rarely necessary. Typically, initializing
64 * GTK opens a display that you can work with without ever accessing the
65 * `GdkDisplayManager`.
66 *
67 * The GDK library can be built with support for multiple backends.
68 * The `GdkDisplayManager` object determines which backend is used
69 * at runtime.
70 *
71 * In the rare case that you need to influence which of the backends
72 * is being used, you can use [func@Gdk.set_allowed_backends]. Note
73 * that you need to call this function before initializing GTK.
74 *
75 * ## Backend-specific code
76 *
77 * When writing backend-specific code that is supposed to work with
78 * multiple GDK backends, you have to consider both compile time and
79 * runtime. At compile time, use the `GDK_WINDOWING_X11`, `GDK_WINDOWING_WIN32`
80 * macros, etc. to find out which backends are present in the GDK library
81 * you are building your application against. At runtime, use type-check
82 * macros like GDK_IS_X11_DISPLAY() to find out which backend is in use:
83 *
84 * ```c
85 * #ifdef GDK_WINDOWING_X11
86 * if (GDK_IS_X11_DISPLAY (display))
87 * {
88 * // make X11-specific calls here
89 * }
90 * else
91 * #endif
92 * #ifdef GDK_WINDOWING_MACOS
93 * if (GDK_IS_MACOS_DISPLAY (display))
94 * {
95 * // make Quartz-specific calls here
96 * }
97 * else
98 * #endif
99 * g_error ("Unsupported GDK backend");
100 * ```
101 */
102
103 enum {
104 PROP_0,
105 PROP_DEFAULT_DISPLAY
106 };
107
108 enum {
109 DISPLAY_OPENED,
110 LAST_SIGNAL
111 };
112
113 static void gdk_display_manager_set_property (GObject *object,
114 guint prop_id,
115 const GValue *value,
116 GParamSpec *pspec);
117 static void gdk_display_manager_get_property (GObject *object,
118 guint prop_id,
119 GValue *value,
120 GParamSpec *pspec);
121
122 static guint signals[LAST_SIGNAL] = { 0 };
123
G_DEFINE_TYPE(GdkDisplayManager,gdk_display_manager,G_TYPE_OBJECT)124 G_DEFINE_TYPE (GdkDisplayManager, gdk_display_manager, G_TYPE_OBJECT)
125
126 static void
127 gdk_display_manager_class_init (GdkDisplayManagerClass *klass)
128 {
129 GObjectClass *object_class = G_OBJECT_CLASS (klass);
130
131 object_class->set_property = gdk_display_manager_set_property;
132 object_class->get_property = gdk_display_manager_get_property;
133
134 /**
135 * GdkDisplayManager::display-opened:
136 * @manager: the object on which the signal is emitted
137 * @display: the opened display
138 *
139 * Emitted when a display is opened.
140 */
141 signals[DISPLAY_OPENED] =
142 g_signal_new (g_intern_static_string ("display-opened"),
143 G_OBJECT_CLASS_TYPE (object_class),
144 G_SIGNAL_RUN_LAST,
145 G_STRUCT_OFFSET (GdkDisplayManagerClass, display_opened),
146 NULL, NULL,
147 NULL,
148 G_TYPE_NONE,
149 1,
150 GDK_TYPE_DISPLAY);
151
152 /**
153 * GdkDisplayManager:default-display: (attributes org.gtk.Property.get=gdk_display_manager_get_default_display)
154 *
155 * The default display.
156 */
157 g_object_class_install_property (object_class,
158 PROP_DEFAULT_DISPLAY,
159 g_param_spec_object ("default-display",
160 P_("Default Display"),
161 P_("The default display for GDK"),
162 GDK_TYPE_DISPLAY,
163 G_PARAM_READWRITE|G_PARAM_STATIC_STRINGS));
164 }
165
166 static void
gdk_display_manager_init(GdkDisplayManager * manager)167 gdk_display_manager_init (GdkDisplayManager *manager)
168 {
169 }
170
171 static void
gdk_display_manager_set_property(GObject * object,guint prop_id,const GValue * value,GParamSpec * pspec)172 gdk_display_manager_set_property (GObject *object,
173 guint prop_id,
174 const GValue *value,
175 GParamSpec *pspec)
176 {
177 switch (prop_id)
178 {
179 case PROP_DEFAULT_DISPLAY:
180 gdk_display_manager_set_default_display (GDK_DISPLAY_MANAGER (object),
181 g_value_get_object (value));
182 break;
183 default:
184 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
185 break;
186 }
187 }
188
189 static void
gdk_display_manager_get_property(GObject * object,guint prop_id,GValue * value,GParamSpec * pspec)190 gdk_display_manager_get_property (GObject *object,
191 guint prop_id,
192 GValue *value,
193 GParamSpec *pspec)
194 {
195 switch (prop_id)
196 {
197 case PROP_DEFAULT_DISPLAY:
198 g_value_set_object (value,
199 gdk_display_manager_get_default_display (GDK_DISPLAY_MANAGER (object)));
200 break;
201 default:
202 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
203 break;
204 }
205 }
206
207 static const char *allowed_backends;
208
209 /**
210 * gdk_set_allowed_backends:
211 * @backends: a comma-separated list of backends
212 *
213 * Sets a list of backends that GDK should try to use.
214 *
215 * This can be useful if your application does not
216 * work with certain GDK backends.
217 *
218 * By default, GDK tries all included backends.
219 *
220 * For example:
221 *
222 * ```c
223 * gdk_set_allowed_backends ("wayland,macos,*");
224 * ```
225 *
226 * instructs GDK to try the Wayland backend first, followed by the
227 * MacOs backend, and then all others.
228 *
229 * If the `GDK_BACKEND` environment variable is set, it determines
230 * what backends are tried in what order, while still respecting the
231 * set of allowed backends that are specified by this function.
232 *
233 * The possible backend names are:
234 *
235 * - `broadway`
236 * - `macos`
237 * - `wayland`.
238 * - `win32`
239 * - `x11`
240 *
241 * You can also include a `*` in the list to try all remaining backends.
242 *
243 * This call must happen prior to functions that open a display, such
244 * as [func@Gdk.Display.open], `gtk_init()`, or `gtk_init_check()`
245 * in order to take effect.
246 */
247 void
gdk_set_allowed_backends(const char * backends)248 gdk_set_allowed_backends (const char *backends)
249 {
250 allowed_backends = g_strdup (backends);
251 }
252
253 typedef struct _GdkBackend GdkBackend;
254
255 struct _GdkBackend {
256 const char *name;
257 GdkDisplay * (* open_display) (const char *name);
258 };
259
260 static GdkBackend gdk_backends[] = {
261 #ifdef GDK_WINDOWING_MACOS
262 { "macos", _gdk_macos_display_open },
263 #endif
264 #ifdef GDK_WINDOWING_WIN32
265 { "win32", _gdk_win32_display_open },
266 #endif
267 #ifdef GDK_WINDOWING_WAYLAND
268 { "wayland", _gdk_wayland_display_open },
269 #endif
270 #ifdef GDK_WINDOWING_X11
271 { "x11", gdk_x11_display_open },
272 #endif
273 #ifdef GDK_WINDOWING_BROADWAY
274 { "broadway", _gdk_broadway_display_open },
275 #endif
276 /* NULL-terminating this array so we can use commas above */
277 { NULL, NULL }
278 };
279
280 /**
281 * gdk_display_manager_get:
282 *
283 * Gets the singleton `GdkDisplayManager` object.
284 *
285 * When called for the first time, this function consults the
286 * `GDK_BACKEND` environment variable to find out which of the
287 * supported GDK backends to use (in case GDK has been compiled
288 * with multiple backends).
289 *
290 * Applications can use [func@set_allowed_backends] to limit what
291 * backends wil be used.
292 *
293 * Returns: (transfer none): The global `GdkDisplayManager` singleton
294 */
295 GdkDisplayManager*
gdk_display_manager_get(void)296 gdk_display_manager_get (void)
297 {
298 static GdkDisplayManager *manager = NULL;
299
300 if (manager == NULL)
301 manager = g_object_new (GDK_TYPE_DISPLAY_MANAGER, NULL);
302
303 return manager;
304 }
305
306 /**
307 * gdk_display_manager_get_default_display: (attributes org.gtk.Method.get_property=default-display)
308 * @manager: a `GdkDisplayManager`
309 *
310 * Gets the default `GdkDisplay`.
311 *
312 * Returns: (nullable) (transfer none): a `GdkDisplay`
313 */
314 GdkDisplay *
gdk_display_manager_get_default_display(GdkDisplayManager * manager)315 gdk_display_manager_get_default_display (GdkDisplayManager *manager)
316 {
317 return manager->default_display;
318 }
319
320 /**
321 * gdk_display_get_default:
322 *
323 * Gets the default `GdkDisplay`.
324 *
325 * This is a convenience function for:
326 *
327 * gdk_display_manager_get_default_display (gdk_display_manager_get ())
328 *
329 * Returns: (nullable) (transfer none): a `GdkDisplay`, or %NULL if
330 * there is no default display
331 */
332 GdkDisplay *
gdk_display_get_default(void)333 gdk_display_get_default (void)
334 {
335 return gdk_display_manager_get_default_display (gdk_display_manager_get ());
336 }
337
338 /**
339 * gdk_display_manager_set_default_display:
340 * @manager: a `GdkDisplayManager`
341 * @display: a `GdkDisplay`
342 *
343 * Sets @display as the default display.
344 */
345 void
gdk_display_manager_set_default_display(GdkDisplayManager * manager,GdkDisplay * display)346 gdk_display_manager_set_default_display (GdkDisplayManager *manager,
347 GdkDisplay *display)
348 {
349 manager->default_display = display;
350
351 if (display)
352 GDK_DISPLAY_GET_CLASS (display)->make_default (display);
353
354 g_object_notify (G_OBJECT (manager), "default-display");
355 }
356
357 /**
358 * gdk_display_manager_list_displays:
359 * @manager: a `GdkDisplayManager`
360 *
361 * List all currently open displays.
362 *
363 * Returns: (transfer container) (element-type GdkDisplay): a newly
364 * allocated `GSList` of `GdkDisplay` objects
365 */
366 GSList *
gdk_display_manager_list_displays(GdkDisplayManager * manager)367 gdk_display_manager_list_displays (GdkDisplayManager *manager)
368 {
369 return g_slist_copy (manager->displays);
370 }
371
372 /**
373 * gdk_display_manager_open_display:
374 * @manager: a `GdkDisplayManager`
375 * @name: the name of the display to open
376 *
377 * Opens a display.
378 *
379 * Returns: (nullable) (transfer none): a `GdkDisplay`, or %NULL
380 * if the display could not be opened
381 */
382 GdkDisplay *
gdk_display_manager_open_display(GdkDisplayManager * manager,const char * name)383 gdk_display_manager_open_display (GdkDisplayManager *manager,
384 const char *name)
385 {
386 const char *backend_list;
387 GdkDisplay *display;
388 char **backends;
389 int i, j;
390 gboolean allow_any;
391
392 if (allowed_backends == NULL)
393 allowed_backends = "*";
394 allow_any = strstr (allowed_backends, "*") != NULL;
395
396 backend_list = g_getenv ("GDK_BACKEND");
397 if (backend_list == NULL)
398 backend_list = allowed_backends;
399 else if (g_strcmp0 (backend_list, "help") == 0)
400 {
401 fprintf (stderr, "Supported GDK backends:");
402 for (i = 0; gdk_backends[i].name != NULL; i++)
403 fprintf (stderr, " %s", gdk_backends[i].name);
404 fprintf (stderr, "\n");
405
406 backend_list = allowed_backends;
407 }
408 backends = g_strsplit (backend_list, ",", 0);
409
410 display = NULL;
411
412 for (i = 0; display == NULL && backends[i] != NULL; i++)
413 {
414 const char *backend = backends[i];
415 gboolean any = g_str_equal (backend, "*");
416
417 if (!allow_any && !any && !strstr (allowed_backends, backend))
418 continue;
419
420 for (j = 0; gdk_backends[j].name != NULL; j++)
421 {
422 if ((any && allow_any) ||
423 (any && strstr (allowed_backends, gdk_backends[j].name)) ||
424 g_str_equal (backend, gdk_backends[j].name))
425 {
426 GDK_NOTE (MISC, g_message ("Trying %s backend", gdk_backends[j].name));
427 display = gdk_backends[j].open_display (name);
428 if (display)
429 break;
430 }
431 }
432 }
433
434 g_strfreev (backends);
435
436 return display;
437 }
438
439 void
_gdk_display_manager_add_display(GdkDisplayManager * manager,GdkDisplay * display)440 _gdk_display_manager_add_display (GdkDisplayManager *manager,
441 GdkDisplay *display)
442 {
443 if (manager->displays == NULL)
444 gdk_display_manager_set_default_display (manager, display);
445
446 manager->displays = g_slist_prepend (manager->displays, display);
447
448 g_signal_emit (manager, signals[DISPLAY_OPENED], 0, display);
449 }
450
451 /* NB: This function can be called multiple times per display. */
452 void
_gdk_display_manager_remove_display(GdkDisplayManager * manager,GdkDisplay * display)453 _gdk_display_manager_remove_display (GdkDisplayManager *manager,
454 GdkDisplay *display)
455 {
456 manager->displays = g_slist_remove (manager->displays, display);
457
458 if (manager->default_display == display)
459 {
460 if (manager->displays)
461 gdk_display_manager_set_default_display (manager, manager->displays->data);
462 else
463 gdk_display_manager_set_default_display (manager, NULL);
464 }
465 }
466