1 | /* $Id: DisplayServerType.h 106061 2024-09-16 14:03:52Z vboxsync $ */
|
---|
2 | /** @file
|
---|
3 | * Guest / Host common code - Display server type detection + handling.
|
---|
4 | */
|
---|
5 |
|
---|
6 | /*
|
---|
7 | * Copyright (C) 2023-2024 Oracle and/or its affiliates.
|
---|
8 | *
|
---|
9 | * This file is part of VirtualBox base platform packages, as
|
---|
10 | * available from https://www.alldomusa.eu.org.
|
---|
11 | *
|
---|
12 | * This program is free software; you can redistribute it and/or
|
---|
13 | * modify it under the terms of the GNU General Public License
|
---|
14 | * as published by the Free Software Foundation, in version 3 of the
|
---|
15 | * License.
|
---|
16 | *
|
---|
17 | * This program is distributed in the hope that it will be useful, but
|
---|
18 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
---|
20 | * General Public License for more details.
|
---|
21 | *
|
---|
22 | * You should have received a copy of the GNU General Public License
|
---|
23 | * along with this program; if not, see <https://www.gnu.org/licenses>.
|
---|
24 | *
|
---|
25 | * The contents of this file may alternatively be used under the terms
|
---|
26 | * of the Common Development and Distribution License Version 1.0
|
---|
27 | * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
|
---|
28 | * in the VirtualBox distribution, in which case the provisions of the
|
---|
29 | * CDDL are applicable instead of those of the GPL.
|
---|
30 | *
|
---|
31 | * You may elect to license modified versions of this file under the
|
---|
32 | * terms and conditions of either the GPL or the CDDL or both.
|
---|
33 | *
|
---|
34 | * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
|
---|
35 | */
|
---|
36 |
|
---|
37 | #ifndef VBOX_INCLUDED_GuestHost_DisplayServerType_h
|
---|
38 | #define VBOX_INCLUDED_GuestHost_DisplayServerType_h
|
---|
39 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
---|
40 | # pragma once
|
---|
41 | #endif
|
---|
42 |
|
---|
43 | #include <iprt/types.h>
|
---|
44 |
|
---|
45 | /** Environment variable which is exported when in Wayland Desktop Environment. */
|
---|
46 | #define VBGH_ENV_WAYLAND_DISPLAY "WAYLAND_DISPLAY"
|
---|
47 | /** Environment variable which contains information about currently running Desktop Environment. */
|
---|
48 | #define VBGH_ENV_XDG_CURRENT_DESKTOP "XDG_CURRENT_DESKTOP"
|
---|
49 | /** Environment variable which contains information about currently running session (X11, Wayland, etc). */
|
---|
50 | #define VBGH_ENV_XDG_SESSION_TYPE "XDG_SESSION_TYPE"
|
---|
51 | /** Another environment variable which may contain information about currently running session. */
|
---|
52 | #define VBGH_ENV_DESKTOP_SESSION "DESKTOP_SESSION"
|
---|
53 |
|
---|
54 | /**
|
---|
55 | * Enumeration holding a guest / host desktop display server type.
|
---|
56 | */
|
---|
57 | typedef enum
|
---|
58 | {
|
---|
59 | /** No display server detected or (explicitly) not set. */
|
---|
60 | VBGHDISPLAYSERVERTYPE_NONE = 0,
|
---|
61 | /** Automatic detection -- might not work reliably on all systems. */
|
---|
62 | VBGHDISPLAYSERVERTYPE_AUTO,
|
---|
63 | /** X11 (X.org). */
|
---|
64 | VBGHDISPLAYSERVERTYPE_X11,
|
---|
65 | /** Wayland. */
|
---|
66 | VBGHDISPLAYSERVERTYPE_PURE_WAYLAND,
|
---|
67 | /** XWayland; Wayland is running, but some (older) apps need X as a bridge as well. */
|
---|
68 | VBGHDISPLAYSERVERTYPE_XWAYLAND
|
---|
69 | } VBGHDISPLAYSERVERTYPE;
|
---|
70 |
|
---|
71 | const char *VBGHDisplayServerTypeToStr(VBGHDISPLAYSERVERTYPE enmType);
|
---|
72 | VBGHDISPLAYSERVERTYPE VBGHDisplayServerTypeDetect(void);
|
---|
73 | bool VBGHDisplayServerTypeIsGtkAvailable(void);
|
---|
74 | bool VBGHDisplayServerTypeIsXAvailable(VBGHDISPLAYSERVERTYPE enmType);
|
---|
75 | bool VBGHDisplayServerTypeIsWaylandAvailable(VBGHDISPLAYSERVERTYPE enmType);
|
---|
76 |
|
---|
77 | #endif /* !VBOX_INCLUDED_GuestHost_DisplayServerType_h */
|
---|
78 |
|
---|