gdkdisplaymanager.c 14.4 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GDK - The GIMP Drawing Kit
Owen Taylor's avatar
Owen Taylor committed
2 3 4 5 6 7 8 9 10 11 12 13 14
 * Copyright (C) 2000 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Owen Taylor's avatar
Owen Taylor committed
16 17 18 19 20 21
 */

/*
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
22
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
Owen Taylor's avatar
Owen Taylor committed
23 24
 */

25
#include "config.h"
Owen Taylor's avatar
Owen Taylor committed
26

27
#include "gdkconfig.h"
28
#include "gdkdisplaymanagerprivate.h"
29
#include "gdkdisplayprivate.h"
Owen Taylor's avatar
Owen Taylor committed
30
#include "gdkinternals.h"
31
#include "gdkkeysprivate.h"
Owen Taylor's avatar
Owen Taylor committed
32 33 34
#include "gdkmarshalers.h"
#include "gdkintl.h"

35 36
#ifdef GDK_WINDOWING_X11
#include "x11/gdkx.h"
37
#include "x11/gdkprivate-x11.h"
38 39
#endif

40
#ifdef GDK_WINDOWING_QUARTZ
41 42
/* When the gdk_quartz_display_open function is removed We can
 * immediately include gdkquartzdisplaymanager.h here instead of
43
 * gdkprivate-quartz.h so that we won’t have to enable -xobjective-c
44
 * for the “generic” GDK source code.
45
 * #include "quartz/gdkquartzdisplaymanager.h"
46
 */
47
#include "quartz/gdkprivate-quartz.h"
48 49
#endif

50
#ifdef GDK_WINDOWING_BROADWAY
51
#include "broadway/gdkprivate-broadway.h"
52 53
#endif

Hans Breuer's avatar
Hans Breuer committed
54 55
#ifdef GDK_WINDOWING_WIN32
#include "win32/gdkwin32.h"
56
#include "win32/gdkprivate-win32.h"
Hans Breuer's avatar
Hans Breuer committed
57
#endif
58

Kristian Høgsberg's avatar
Kristian Høgsberg committed
59
#ifdef GDK_WINDOWING_WAYLAND
60
#include "wayland/gdkprivate-wayland.h"
Kristian Høgsberg's avatar
Kristian Høgsberg committed
61 62
#endif

63 64 65 66
#ifdef GDK_WINDOWING_MIR
#include "mir/gdkmir-private.h"
#endif

67 68 69 70 71 72 73 74
/**
 * SECTION:gdkdisplaymanager
 * @Short_description: Maintains a list of all open GdkDisplays
 * @Title: GdkDisplayManager
 *
 * The purpose of the #GdkDisplayManager singleton object is to offer
 * notification when displays appear or disappear or the default display
 * changes.
75
 *
76
 * You can use gdk_display_manager_get() to obtain the #GdkDisplayManager
77 78
 * singleton, but that should be rarely necessary. Typically, initializing
 * GTK+ opens a display that you can work with without ever accessing the
79
 * #GdkDisplayManager.
80 81
 *
 * The GDK library can be built with support for multiple backends.
82
 * The #GdkDisplayManager object determines which backend is used
83 84 85 86 87 88 89 90 91
 * at runtime.
 *
 * When writing backend-specific code that is supposed to work with
 * multiple GDK backends, you have to consider both compile time and
 * runtime. At compile time, use the #GDK_WINDOWING_X11, #GDK_WINDOWING_WIN32
 * macros, etc. to find out which backends are present in the GDK library
 * you are building your application against. At runtime, use type-check
 * macros like GDK_IS_X11_DISPLAY() to find out which backend is in use:
 *
92 93
 * ## Backend-specific code ## {#backend-specific}
 *
94
 * |[<!-- language="C" -->
95 96 97
 * #ifdef GDK_WINDOWING_X11
 *   if (GDK_IS_X11_DISPLAY (display))
 *     {
98
 *       // make X11-specific calls here
99 100 101 102 103 104
 *     }
 *   else
 * #endif
 * #ifdef GDK_WINDOWING_QUARTZ
 *   if (GDK_IS_QUARTZ_DISPLAY (display))
 *     {
105
 *       // make Quartz-specific calls here
106 107 108 109
*     }
 *   else
 * #endif
 *   g_error ("Unsupported GDK backend");
110
 * ]|
111 112
 */

Owen Taylor's avatar
Owen Taylor committed
113 114 115 116 117 118 119 120 121 122 123 124

enum {
  PROP_0,
  PROP_DEFAULT_DISPLAY
};

enum {
  DISPLAY_OPENED,
  LAST_SIGNAL
};

static void gdk_display_manager_set_property (GObject                *object,
125 126 127
                                              guint                   prop_id,
                                              const GValue           *value,
                                              GParamSpec             *pspec);
Owen Taylor's avatar
Owen Taylor committed
128
static void gdk_display_manager_get_property (GObject                *object,
129 130 131
                                              guint                   prop_id,
                                              GValue                 *value,
                                              GParamSpec             *pspec);
Owen Taylor's avatar
Owen Taylor committed
132 133 134

static guint signals[LAST_SIGNAL] = { 0 };

135
G_DEFINE_TYPE (GdkDisplayManager, gdk_display_manager, G_TYPE_OBJECT)
Owen Taylor's avatar
Owen Taylor committed
136 137 138 139 140 141 142 143 144

static void
gdk_display_manager_class_init (GdkDisplayManagerClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

  object_class->set_property = gdk_display_manager_set_property;
  object_class->get_property = gdk_display_manager_get_property;

145 146
  /**
   * GdkDisplayManager::display-opened:
147
   * @manager: the object on which the signal is emitted
148 149
   * @display: the opened display
   *
150
   * The ::display-opened signal is emitted when a display is opened.
151 152 153
   *
   * Since: 2.2
   */
Owen Taylor's avatar
Owen Taylor committed
154
  signals[DISPLAY_OPENED] =
155
    g_signal_new (g_intern_static_string ("display-opened"),
156 157 158 159 160 161 162 163
                  G_OBJECT_CLASS_TYPE (object_class),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (GdkDisplayManagerClass, display_opened),
                  NULL, NULL,
                  _gdk_marshal_VOID__OBJECT,
                  G_TYPE_NONE,
                  1,
                  GDK_TYPE_DISPLAY);
Owen Taylor's avatar
Owen Taylor committed
164 165

  g_object_class_install_property (object_class,
166 167 168 169 170 171 172
                                   PROP_DEFAULT_DISPLAY,
                                   g_param_spec_object ("default-display",
                                                        P_("Default Display"),
                                                        P_("The default display for GDK"),
                                                        GDK_TYPE_DISPLAY,
                                                        G_PARAM_READWRITE|G_PARAM_STATIC_NAME|
                                                        G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
Owen Taylor's avatar
Owen Taylor committed
173 174
}

Matthias Clasen's avatar
Matthias Clasen committed
175 176 177 178 179
static void
gdk_display_manager_init (GdkDisplayManager *manager)
{
}

Owen Taylor's avatar
Owen Taylor committed
180 181
static void
gdk_display_manager_set_property (GObject      *object,
182 183 184
                                  guint         prop_id,
                                  const GValue *value,
                                  GParamSpec   *pspec)
Owen Taylor's avatar
Owen Taylor committed
185 186 187 188
{
  switch (prop_id)
    {
    case PROP_DEFAULT_DISPLAY:
189
      gdk_display_manager_set_default_display (GDK_DISPLAY_MANAGER (object),
190
                                               g_value_get_object (value));
Owen Taylor's avatar
Owen Taylor committed
191 192 193 194 195 196 197 198 199
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
gdk_display_manager_get_property (GObject      *object,
200 201 202
                                  guint         prop_id,
                                  GValue       *value,
                                  GParamSpec   *pspec)
Owen Taylor's avatar
Owen Taylor committed
203 204 205 206
{
  switch (prop_id)
    {
    case PROP_DEFAULT_DISPLAY:
207 208
      g_value_set_object (value,
                          gdk_display_manager_get_default_display (GDK_DISPLAY_MANAGER (object)));
Owen Taylor's avatar
Owen Taylor committed
209 210 211 212 213 214 215
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

216 217 218 219 220 221 222 223 224 225 226 227 228 229
static const gchar *allowed_backends;

/**
 * gdk_set_allowed_backends:
 * @backends: a comma-separated list of backends
 *
 * Sets a list of backends that GDK should try to use.
 *
 * This can be be useful if your application does not
 * work with certain GDK backends.
 *
 * By default, GDK tries all included backends.
 *
 * For example,
230
 * |[<!-- language="C" -->
231
 * gdk_set_allowed_backends ("wayland,quartz,*");
232
 * ]|
233 234 235 236
 * instructs GDK to try the Wayland backend first,
 * followed by the Quartz backend, and then all
 * others.
 *
237
 * If the `GDK_BACKEND` environment variable
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
 * is set, it determines what backends are tried in what
 * order, while still respecting the set of allowed backends
 * that are specified by this function.
 *
 * The possible backend names are x11, win32, quartz,
 * broadway, wayland. You can also include a * in the
 * list to try all remaining backends.
 *
 * This call must happen prior to gdk_display_open(),
 * gtk_init(), gtk_init_with_args() or gtk_init_check()
 * in order to take effect.
 *
 * Since: 3.10
 */
void
gdk_set_allowed_backends (const gchar *backends)
{
  allowed_backends = g_strdup (backends);
}

Benjamin Otte's avatar
Benjamin Otte committed
258 259 260 261
typedef struct _GdkBackend GdkBackend;

struct _GdkBackend {
  const char *name;
262
  GdkDisplay * (* open_display) (const char *name);
Benjamin Otte's avatar
Benjamin Otte committed
263 264
};

Matthias Clasen's avatar
Matthias Clasen committed
265
static GdkBackend gdk_backends[] = {
Benjamin Otte's avatar
Benjamin Otte committed
266
#ifdef GDK_WINDOWING_QUARTZ
267
  { "quartz",   _gdk_quartz_display_open },
Benjamin Otte's avatar
Benjamin Otte committed
268 269
#endif
#ifdef GDK_WINDOWING_WIN32
270
  { "win32",    _gdk_win32_display_open },
Benjamin Otte's avatar
Benjamin Otte committed
271
#endif
272 273 274
#ifdef GDK_WINDOWING_WAYLAND
  { "wayland",  _gdk_wayland_display_open },
#endif
Matthias Clasen's avatar
Matthias Clasen committed
275 276 277
#ifdef GDK_WINDOWING_X11
  { "x11",      _gdk_x11_display_open },
#endif
278 279 280
#ifdef GDK_WINDOWING_MIR
  { "mir",  _gdk_mir_display_open },
#endif
Benjamin Otte's avatar
Benjamin Otte committed
281
#ifdef GDK_WINDOWING_BROADWAY
282
  { "broadway", _gdk_broadway_display_open },
Benjamin Otte's avatar
Benjamin Otte committed
283 284 285 286 287
#endif
  /* NULL-terminating this array so we can use commas above */
  { NULL, NULL }
};

288
/**
289
 * gdk_display_manager_get:
290
 *
291 292 293
 * Gets the singleton #GdkDisplayManager object.
 *
 * When called for the first time, this function consults the
294
 * `GDK_BACKEND` environment variable to find out which
295 296 297
 * of the supported GDK backends to use (in case GDK has been compiled
 * with multiple backends). Applications can use gdk_set_allowed_backends()
 * to limit what backends can be used.
298
 *
299 300 301
 * Returns: (transfer none): The global #GdkDisplayManager singleton;
 *     gdk_parse_args(), gdk_init(), or gdk_init_check() must have
 *     been called first.
302
 *
303 304 305 306
 * Since: 2.2
 **/
GdkDisplayManager*
gdk_display_manager_get (void)
Owen Taylor's avatar
Owen Taylor committed
307
{
308 309
  static GdkDisplayManager *manager = NULL;

310
  if (manager == NULL)
311 312
    manager = g_object_new (GDK_TYPE_DISPLAY_MANAGER, NULL);
  
313
  return manager;
Owen Taylor's avatar
Owen Taylor committed
314 315 316 317
}

/**
 * gdk_display_manager_get_default_display:
318
 * @manager: a #GdkDisplayManager
Owen Taylor's avatar
Owen Taylor committed
319
 *
320 321
 * Gets the default #GdkDisplay.
 *
322 323
 * Returns: (nullable) (transfer none): a #GdkDisplay, or %NULL if
 *     there is no default display.
324 325
 *
 * Since: 2.2
Owen Taylor's avatar
Owen Taylor committed
326 327
 */
GdkDisplay *
328
gdk_display_manager_get_default_display (GdkDisplayManager *manager)
Owen Taylor's avatar
Owen Taylor committed
329
{
330
  return manager->default_display;
Owen Taylor's avatar
Owen Taylor committed
331 332 333 334 335 336
}

/**
 * gdk_display_get_default:
 *
 * Gets the default #GdkDisplay. This is a convenience
337 338
 * function for:
 * `gdk_display_manager_get_default_display (gdk_display_manager_get ())`.
339
 *
340 341
 * Returns: (nullable) (transfer none): a #GdkDisplay, or %NULL if
 *   there is no default display.
342 343
 *
 * Since: 2.2
Owen Taylor's avatar
Owen Taylor committed
344 345 346 347
 */
GdkDisplay *
gdk_display_get_default (void)
{
348
  return gdk_display_manager_get_default_display (gdk_display_manager_get ());
Owen Taylor's avatar
Owen Taylor committed
349 350 351 352 353 354 355
}

/**
 * gdk_screen_get_default:
 *
 * Gets the default screen for the default display. (See
 * gdk_display_get_default ()).
356
 *
357 358
 * Returns: (nullable) (transfer none): a #GdkScreen, or %NULL if
 *     there is no default display.
359 360
 *
 * Since: 2.2
Owen Taylor's avatar
Owen Taylor committed
361 362 363 364
 */
GdkScreen *
gdk_screen_get_default (void)
{
365
  GdkDisplay *display;
366

367
  display = gdk_display_get_default ();
368

369 370
  if (display)
    return GDK_DISPLAY_GET_CLASS (display)->get_default_screen (display);
371 372
  else
    return NULL;
Owen Taylor's avatar
Owen Taylor committed
373 374 375 376
}

/**
 * gdk_display_manager_set_default_display:
377
 * @manager: a #GdkDisplayManager
Owen Taylor's avatar
Owen Taylor committed
378 379 380
 * @display: a #GdkDisplay
 * 
 * Sets @display as the default display.
381 382
 *
 * Since: 2.2
Owen Taylor's avatar
Owen Taylor committed
383 384
 **/
void
385 386
gdk_display_manager_set_default_display (GdkDisplayManager *manager,
                                         GdkDisplay        *display)
Owen Taylor's avatar
Owen Taylor committed
387
{
388 389
  manager->default_display = display;

390 391
  if (display)
    GDK_DISPLAY_GET_CLASS (display)->make_default (display);
Owen Taylor's avatar
Owen Taylor committed
392

393
  g_object_notify (G_OBJECT (manager), "default-display");
Owen Taylor's avatar
Owen Taylor committed
394 395 396 397
}

/**
 * gdk_display_manager_list_displays:
398
 * @manager: a #GdkDisplayManager
Owen Taylor's avatar
Owen Taylor committed
399 400
 *
 * List all currently open displays.
401
 *
402
 * Returns: (transfer container) (element-type GdkDisplay): a newly
403 404
 *     allocated #GSList of #GdkDisplay objects. Free with g_slist_free()
 *     when you are done with it.
405 406
 *
 * Since: 2.2
Owen Taylor's avatar
Owen Taylor committed
407 408
 **/
GSList *
409 410
gdk_display_manager_list_displays (GdkDisplayManager *manager)
{
411
  return g_slist_copy (manager->displays);
412 413
}

Matthias Clasen's avatar
Matthias Clasen committed
414 415 416 417 418 419 420
/**
 * gdk_display_manager_open_display:
 * @manager: a #GdkDisplayManager
 * @name: the name of the display to open
 *
 * Opens a display.
 *
421 422
 * Returns: (nullable) (transfer none): a #GdkDisplay, or %NULL if the
 *     display could not be opened
Matthias Clasen's avatar
Matthias Clasen committed
423 424 425
 *
 * Since: 3.0
 */
426 427 428
GdkDisplay *
gdk_display_manager_open_display (GdkDisplayManager *manager,
                                  const gchar       *name)
Owen Taylor's avatar
Owen Taylor committed
429
{
430 431 432 433 434
  const gchar *backend_list;
  GdkDisplay *display;
  gchar **backends;
  gint i, j;
  gboolean allow_any;
435

436 437 438 439 440 441 442
  if (allowed_backends == NULL)
    allowed_backends = "*";
  allow_any = strstr (allowed_backends, "*") != NULL;

  backend_list = g_getenv ("GDK_BACKEND");
  if (backend_list == NULL)
    backend_list = allowed_backends;
443 444 445 446 447 448 449 450 451
  else if (g_strcmp0 (backend_list, "help") == 0)
    {
      fprintf (stderr, "Supported GDK backends:");
      for (i = 0; gdk_backends[i].name != NULL; i++)
        fprintf (stderr, " %s", gdk_backends[i].name);
      fprintf (stderr, "\n");

      backend_list = allowed_backends;
    }
452 453 454 455 456
  backends = g_strsplit (backend_list, ",", 0);

  display = NULL;

  for (i = 0; display == NULL && backends[i] != NULL; i++)
457
    {
458 459 460 461 462 463 464
      const gchar *backend = backends[i];
      gboolean any = g_str_equal (backend, "*");

      if (!allow_any && !any && !strstr (allowed_backends, backend))
        continue;

      for (j = 0; gdk_backends[j].name != NULL; j++)
465
        {
466 467 468 469 470 471 472 473 474
          if ((any && allow_any) ||
              (any && strstr (allowed_backends, gdk_backends[j].name)) ||
              g_str_equal (backend, gdk_backends[j].name))
            {
              GDK_NOTE (MISC, g_message ("Trying %s backend", gdk_backends[j].name));
              display = gdk_backends[j].open_display (name);
              if (display)
                break;
            }
475 476 477
        }
    }

478
  g_strfreev (backends);
479

480
  return display;
Owen Taylor's avatar
Owen Taylor committed
481
}
Matthias Clasen's avatar
Matthias Clasen committed
482

483 484 485 486 487 488 489 490
void
_gdk_display_manager_add_display (GdkDisplayManager *manager,
                                  GdkDisplay        *display)
{
  if (manager->displays == NULL)
    gdk_display_manager_set_default_display (manager, display);

  manager->displays = g_slist_prepend (manager->displays, display);
491 492

  g_signal_emit (manager, signals[DISPLAY_OPENED], 0, display);
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
}

/* NB: This function can be called multiple times per display. */
void
_gdk_display_manager_remove_display (GdkDisplayManager *manager,
                                     GdkDisplay        *display)
{
  manager->displays = g_slist_remove (manager->displays, display);

  if (manager->default_display == display)
    {
      if (manager->displays)
        gdk_display_manager_set_default_display (manager, manager->displays->data);
      else
        gdk_display_manager_set_default_display (manager, NULL);
    }
}