Changeset 99620 in vbox

Timestamp:

May 5, 2023 9:08:00 AM (2 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

157146

Message:

Guest / Host: Renamed SessionType -> DisplayServerType (better naming to reflect its purpose). bugref:10427

Location:

trunk

Files:

• include/VBox/GuestHost/DisplayServerType.h (moved) (moved from trunk/include/VBox/GuestHost/SessionType.h ) (2 diffs)
• src/VBox/Additions/x11/VBoxClient/Makefile.kmk (modified) (1 diff)
• src/VBox/Additions/x11/VBoxClient/VBoxClient.h (modified) (2 diffs)
• src/VBox/Additions/x11/VBoxClient/clipboard.cpp (modified) (2 diffs)
• src/VBox/Additions/x11/VBoxClient/display-helper-gnome3.cpp (modified) (2 diffs)
• src/VBox/Additions/x11/VBoxClient/display-svga-x11.cpp (modified) (1 diff)
• src/VBox/Additions/x11/VBoxClient/draganddrop.cpp (modified) (1 diff)
• src/VBox/Additions/x11/VBoxClient/main.cpp (modified) (5 diffs)
• src/VBox/Additions/x11/VBoxClient/seamless.cpp (modified) (1 diff)
• src/VBox/Additions/x11/VBoxClient/testcase/tstSeamlessX11.cpp (modified) (2 diffs)
• src/VBox/GuestHost/DisplayServerType.cpp (moved) (moved from trunk/src/VBox/GuestHost/SessionType.cpp ) (9 diffs)

trunk/include/VBox/GuestHost/DisplayServerType.h

@@ -1 +1 @@
 /* $Id$ */
 /** @file
- * Guest / Host common code - Session type detection + handling.
+ * Guest / Host common code - Display server type detection + handling.
  */
 
@@ -51 +51 @@
 
 /**
- * Enumeration holding a guest / host desktop session type.
+ * Enumeration holding a guest / host desktop display server type.
  */
 typedef enum
 {
-    /** No session detected or (explicitly) not set. */
-    VBGHSESSIONTYPE_NONE = 0,
+    /** No display server detected or (explicitly) not set. */
+    VBGHDISPLAYSERVERTYPE_NONE = 0,
     /** Automatic detection -- might not work reliably on all systems. */
-    VBGHSESSIONTYPE_AUTO,
+    VBGHDISPLAYSERVERTYPE_AUTO,
     /** X11 (X.org). */
-    VBGHSESSIONTYPE_X11,
+    VBGHDISPLAYSERVERTYPE_X11,
     /** Wayland. */
-    VBGHSESSIONTYPE_WAYLAND,
+    VBGHDISPLAYSERVERTYPE_WAYLAND,
     /** XWayland; Wayland is running, but some (older) apps need X as a bridge as well. */
-    VBGHSESSIONTYPE_XWAYLAND
-} VBGHSESSIONTYPE;
+    VBGHDISPLAYSERVERTYPE_XWAYLAND
+} VBGHDISPLAYSERVERTYPE;
 
-const char *VBGHSessionTypeToStr(VBGHSESSIONTYPE enmType);
-VBGHSESSIONTYPE VBGHSessionTypeDetect(void);
-bool VBGHSessionTypeIsXAvailable(VBGHSESSIONTYPE enmType);
-bool VBGHSessionTypeIsWaylandAvailable(VBGHSESSIONTYPE enmType);
+const char *VBGHDisplayServerTypeToStr(VBGHDISPLAYSERVERTYPE enmType);
+VBGHDISPLAYSERVERTYPE VBGHDisplayServerTypeDetect(void);
+bool VBGHServerTypeIsXAvailable(VBGHDISPLAYSERVERTYPE enmType);
+bool VBGHDisplayServerTypeIsWaylandAvailable(VBGHDISPLAYSERVERTYPE enmType);
 
 #endif /* !VBOX_INCLUDED_GuestHost_SessionType_h */

trunk/src/VBox/Additions/x11/VBoxClient/Makefile.kmk

@@ -52 +52 @@
 VBOX_GH_SOURCES := \
         $(PATH_ROOT)/src/VBox/GuestHost/Log.cpp \
-        $(PATH_ROOT)/src/VBox/GuestHost/SessionType.cpp
+        $(PATH_ROOT)/src/VBox/GuestHost/DisplayServerType.cpp
 
 VBoxClient_TEMPLATE = VBoxGuestR3Exe

trunk/src/VBox/Additions/x11/VBoxClient/VBoxClient.h

@@ -38 +38 @@
 
 #include <VBox/GuestHost/Log.h>
-#include <VBox/GuestHost/SessionType.h>
+#include <VBox/GuestHost/DisplayServerType.h>
 
 int VBClShowNotify(const char *pszHeader, const char *pszBody);
@@ -54 +54 @@
 extern void VBClShutdown(bool fExit = true);
 
-extern VBGHSESSIONTYPE VBClGetSessionType(void);
+extern VBGHDISPLAYSERVERTYPE VBClGetDisplayServerType(void);
 
 /**

trunk/src/VBox/Additions/x11/VBoxClient/clipboard.cpp

@@ -83 +83 @@
     int rc = VINF_SUCCESS;
 
-    if (VBClGetSessionType() == VBGHSESSIONTYPE_X11)
+    if (VBClGetDisplayServerType() == VBGHDISPLAYSERVERTYPE_X11)
     {
         rc = VBClX11ClipboardInit();
@@ -95 +95 @@
     }
 #if 0
-    else (VBClGetSessionType() == VBGHSESSIONTYPE_WAYLAND)
+    else (VBClGetSessionType() == GHDISPLAYSERVERTYPE_WAYLAND)
     {
 

trunk/src/VBox/Additions/x11/VBoxClient/display-helper-gnome3.cpp

@@ -982 +982 @@
     int rc;
 
-    if (VBClGetSessionType() == VBGHSESSIONTYPE_X11)
+    if (VBClGetDisplayServerType() == VBGHDISPLAYSERVERTYPE_X11)
     {
         rc = vbcl_hlp_generic_init();
@@ -998 +998 @@
     int rc;
 
-    if (VBClGetSessionType() == VBGHSESSIONTYPE_X11)
+    if (VBClGetDisplayServerType() == VBGHDISPLAYSERVERTYPE_X11)
     {
         rc = vbcl_hlp_generic_term();

trunk/src/VBox/Additions/x11/VBoxClient/display-svga-x11.cpp

@@ -581 +581 @@
     }
 
-    if (VBClGetSessionType() == VBGHSESSIONTYPE_WAYLAND)
+    if (VBClGetDisplayServerType() == VBGHDISPLAYSERVERTYPE_WAYLAND)
     {
         rc = VbglR3DrmClientStart();

trunk/src/VBox/Additions/x11/VBoxClient/draganddrop.cpp

@@ -42 +42 @@
 static DECLCALLBACK(int) vbclDnDInit(void)
 {
-    switch (VBClGetSessionType())
+    switch (VBClGetDisplayServerType())
     {
-        case VBGHSESSIONTYPE_X11:
+        case VBGHDISPLAYSERVERTYPE_X11:
             g_pSvc = new VBClX11DnDSvc();
             break;
 
-        case VBGHSESSIONTYPE_WAYLAND:
+        case VBGHDISPLAYSERVERTYPE_WAYLAND:
             RT_FALL_THROUGH();
         default:

trunk/src/VBox/Additions/x11/VBoxClient/main.cpp

@@ -114 +114 @@
 /** The file handle of parent process pidfile. */
 static RTFILE          g_hControlPidFile;
-/** The session type to use. */
-static VBGHSESSIONTYPE g_enmSessionType = VBGHSESSIONTYPE_AUTO;
+/** The display server type to use. */
+static VBGHDISPLAYSERVERTYPE g_enmDisplayServerType = VBGHDISPLAYSERVERTYPE_AUTO;
 
 /** Global critical section held during the clean-up routine (to prevent it
@@ -165 +165 @@
 
 /**
- * Returns the current session type.
+ * Returns the current display server type.
  *
- * @returns The session type.
- */
-VBGHSESSIONTYPE VBClGetSessionType(void)
-{
-    return g_enmSessionType;
+ * @returns The display server type.
+ */
+VBGHDISPLAYSERVERTYPE VBClGetDisplayServerType(void)
+{
+    return g_enmDisplayServerType;
 }
 
@@ -668 +668 @@
             {
                 if (!RTStrICmp(ValueUnion.psz, "x11"))
-                    g_enmSessionType = VBGHSESSIONTYPE_X11;
+                    g_enmDisplayServerType = VBGHDISPLAYSERVERTYPE_X11;
                 else if (!RTStrICmp(ValueUnion.psz, "wayland"))
-                    g_enmSessionType = VBGHSESSIONTYPE_WAYLAND;
+                    g_enmDisplayServerType = VBGHDISPLAYSERVERTYPE_WAYLAND;
                 else if (!RTStrICmp(ValueUnion.psz, "none"))
-                    g_enmSessionType = VBGHSESSIONTYPE_NONE;
+                    g_enmDisplayServerType = VBGHDISPLAYSERVERTYPE_NONE;
                 else if (!RTStrICmp(ValueUnion.psz, "auto"))
-                    g_enmSessionType = VBGHSESSIONTYPE_AUTO;
+                    g_enmDisplayServerType = VBGHDISPLAYSERVERTYPE_AUTO;
                 else
                 {
                     RTMsgError("Session type \"%s\" is invalid; defaulting to \"auto\" instead.\n", ValueUnion.psz);
-                    g_enmSessionType = VBGHSESSIONTYPE_AUTO;
+                    g_enmDisplayServerType = VBGHDISPLAYSERVERTYPE_AUTO;
                 }
                 break;
@@ -741 +741 @@
 
     /* Try to detect the current session type early on, if needed. */
-    if (g_enmSessionType == VBGHSESSIONTYPE_AUTO)
-    {
-        g_enmSessionType = VBGHSessionTypeDetect();
+    if (g_enmDisplayServerType == VBGHDISPLAYSERVERTYPE_AUTO)
+    {
+        g_enmDisplayServerType = VBGHDisplayServerTypeDetect();
     }
     else
-        VBClLogInfo("Session type was manually set to: %s\n", VBGHSessionTypeToStr(g_enmSessionType));
-
-    VBClLogInfo("Session type is: %s\n", VBGHSessionTypeToStr(g_enmSessionType));
+        VBClLogInfo("Session type was manually set to: %s\n", VBGHDisplayServerTypeToStr(g_enmDisplayServerType));
+
+    VBClLogInfo("Session type is: %s\n", VBGHDisplayServerTypeToStr(g_enmDisplayServerType));
 
     VBClLogInfo("Service: %s\n", g_Service.pDesc->pszDesc);
@@ -796 +796 @@
     }
 
-    if (g_enmSessionType == VBGHSESSIONTYPE_X11)
+    if (g_enmDisplayServerType == VBGHDISPLAYSERVERTYPE_X11)
     {
         /* This should never be called twice in one process - in fact one Display

trunk/src/VBox/Additions/x11/VBoxClient/seamless.cpp

@@ -84 +84 @@
 static DECLCALLBACK(int) vbclSeamlessInit(void)
 {
-    switch (VBClGetSessionType())
+    switch (VBClGetDisplayServerType())
     {
-        case VBGHSESSIONTYPE_X11:
+        case VBGHDISPLAYSERVERTYPE_X11:
             g_pSvc = new VBClX11SeamlessSvc();
             break;
 
-        case VBGHSESSIONTYPE_WAYLAND:
+        case VBGHDISPLAYSERVERTYPE_WAYLAND:
             RT_FALL_THROUGH();
         default:

trunk/src/VBox/Additions/x11/VBoxClient/testcase/tstSeamlessX11.cpp

@@ -35 +35 @@
 
 #include <VBox/VBoxGuestLib.h>
-#include <VBox/GuestHost/SessionType.h>
+#include <VBox/GuestHost/DisplayServerType.h>
 
 #include "../seamless.h"
@@ -41 +41 @@
 static RTSEMEVENT eventSem;
 
-VBGHSESSIONTYPE VBClGetSessionType(void)
+VBGHDISPLAYSERVERTYPE VBClGetDisplayServerType(void)
 {
-    return VBGHSESSIONTYPE_X11;
+    return VBGHDISPLAYSERVERTYPE_X11;
 }
 

trunk/src/VBox/GuestHost/DisplayServerType.cpp

@@ -36 +36 @@
 
 #include <VBox/GuestHost/Log.h>
-#include <VBox/GuestHost/SessionType.h>
+#include <VBox/GuestHost/DisplayServerType.h>
 
 
@@ -44 +44 @@
 
 /**
- * Returns the VBGHSESSIONTYPE as a string.
- *
- * @returns VBGHSESSIONTYPE as a string.
- * @param   enmType             VBGHSESSIONTYPE to return as a string.
- */
-const char *VBGHSessionTypeToStr(VBGHSESSIONTYPE enmType)
+ * Returns the VBGHDISPLAYSERVERTYPE as a string.
+ *
+ * @returns VBGHDISPLAYSERVERTYPE as a string.
+ * @param   enmType             VBGHDISPLAYSERVERTYPE to return as a string.
+ */
+const char *VBGHDisplayServerTypeToStr(VBGHDISPLAYSERVERTYPE enmType)
 {
     switch (enmType)
     {
-        RT_CASE_RET_STR(VBGHSESSIONTYPE_NONE);
-        RT_CASE_RET_STR(VBGHSESSIONTYPE_AUTO);
-        RT_CASE_RET_STR(VBGHSESSIONTYPE_X11);
-        RT_CASE_RET_STR(VBGHSESSIONTYPE_WAYLAND);
-        RT_CASE_RET_STR(VBGHSESSIONTYPE_XWAYLAND);
+        RT_CASE_RET_STR(VBGHDISPLAYSERVERTYPE_NONE);
+        RT_CASE_RET_STR(VBGHDISPLAYSERVERTYPE_AUTO);
+        RT_CASE_RET_STR(VBGHDISPLAYSERVERTYPE_X11);
+        RT_CASE_RET_STR(VBGHDISPLAYSERVERTYPE_WAYLAND);
+        RT_CASE_RET_STR(VBGHDISPLAYSERVERTYPE_XWAYLAND);
         default: break;
     }
@@ -65 +65 @@
 
 /**
- * Tries to detect the desktop session type the process is running in.
- *
- * @returns A value of VBGHSESSIONTYPE, or VBGHSESSIONTYPE_NONE if detection was not successful.
+ * Tries to detect the desktop display server type the process is running in.
+ *
+ * @returns A value of VBGHDISPLAYSERVERTYPE, or VBGHDISPLAYSERVERTYPE_NONE if detection was not successful.
  *
  * @note    Precedence is:
@@ -77 +77 @@
  *          Will print a warning to the release log if configuration mismatches.
  */
-VBGHSESSIONTYPE VBGHSessionTypeDetect(void)
-{
-    VBGHLogVerbose(1, "Detecting session type ...\n");
+VBGHDISPLAYSERVERTYPE VBGHDisplayServerTypeDetect(void)
+{
+    VBGHLogVerbose(1, "Detecting display server ...\n");
 
     /* Try to connect to the wayland display, assuming it succeeds only when a wayland compositor is active: */
@@ -110 +110 @@
 
     /* If both wayland and X11 display can be connected then we should have XWayland: */
-    VBGHSESSIONTYPE retSessionType = VBGHSESSIONTYPE_NONE;
+    VBGHDISPLAYSERVERTYPE retSessionType = VBGHDISPLAYSERVERTYPE_NONE;
     if (pWaylandDisplay && pXDisplay)
-        retSessionType = VBGHSESSIONTYPE_XWAYLAND;
+        retSessionType = VBGHDISPLAYSERVERTYPE_XWAYLAND;
     else if (pWaylandDisplay && !pXDisplay)
-        retSessionType = VBGHSESSIONTYPE_WAYLAND;
+        retSessionType = VBGHDISPLAYSERVERTYPE_WAYLAND;
     else if (!pWaylandDisplay && pXDisplay)
-        retSessionType = VBGHSESSIONTYPE_X11;
-
-    VBGHLogVerbose(1, "Detected via connection: %s\n", VBGHSessionTypeToStr(retSessionType));
+        retSessionType = VBGHDISPLAYSERVERTYPE_X11;
+
+    VBGHLogVerbose(1, "Detected via connection: %s\n", VBGHDisplayServerTypeToStr(retSessionType));
 
     /* If retSessionType is set, we assume we're done here;
      * otherwise try the environment variables as a fallback. */
-    if (retSessionType != VBGHSESSIONTYPE_NONE)
+    if (retSessionType != VBGHDISPLAYSERVERTYPE_NONE)
         return retSessionType;
 
@@ -130 +130 @@
      * Therefore we check the Wayland specific display environment variable first.
      */
-    VBGHSESSIONTYPE waylandDisplayType = VBGHSESSIONTYPE_NONE;
+    VBGHDISPLAYSERVERTYPE waylandDisplayType = VBGHDISPLAYSERVERTYPE_NONE;
     const char *const pWaylandDisplayType = RTEnvGet(VBGH_ENV_WAYLAND_DISPLAY);
     if (pWaylandDisplayType != NULL)
-        waylandDisplayType = VBGHSESSIONTYPE_WAYLAND;
-
-    VBGHLogVerbose(1, "Wayland display type is: %s\n", VBGHSessionTypeToStr(waylandDisplayType));
-
-    VBGHSESSIONTYPE xdgSessionType = VBGHSESSIONTYPE_NONE;
+        waylandDisplayType = VBGHDISPLAYSERVERTYPE_WAYLAND;
+
+    VBGHLogVerbose(1, "Wayland display type is: %s\n", VBGHDisplayServerTypeToStr(waylandDisplayType));
+
+    VBGHDISPLAYSERVERTYPE xdgSessionType = VBGHDISPLAYSERVERTYPE_NONE;
     const char *pSessionType = RTEnvGet(VBGH_ENV_XDG_SESSION_TYPE);
     if (pSessionType)
     {
         if (RTStrIStartsWith(pSessionType, "wayland"))
-            xdgSessionType = VBGHSESSIONTYPE_WAYLAND;
+            xdgSessionType = VBGHDISPLAYSERVERTYPE_WAYLAND;
         else if (RTStrIStartsWith(pSessionType, "x11"))
-            xdgSessionType = VBGHSESSIONTYPE_X11;
-    }
-
-    VBGHLogVerbose(1, "XDG session type is: %s\n", VBGHSessionTypeToStr(xdgSessionType));
-
-    VBGHSESSIONTYPE xdgCurrentDesktopType = VBGHSESSIONTYPE_NONE;
+            xdgSessionType = VBGHDISPLAYSERVERTYPE_X11;
+    }
+
+    VBGHLogVerbose(1, "XDG session type is: %s\n", VBGHDisplayServerTypeToStr(xdgSessionType));
+
+    VBGHDISPLAYSERVERTYPE xdgCurrentDesktopType = VBGHDISPLAYSERVERTYPE_NONE;
 
     const char *pszCurDesktop = RTEnvGet(VBGH_ENV_XDG_CURRENT_DESKTOP);
@@ -155 +155 @@
     {
         if (RTStrIStr(pszCurDesktop, "wayland"))
-            xdgCurrentDesktopType = VBGHSESSIONTYPE_WAYLAND;
+            xdgCurrentDesktopType = VBGHDISPLAYSERVERTYPE_WAYLAND;
         else if (RTStrIStr(pszCurDesktop, "x11"))
-            xdgCurrentDesktopType = VBGHSESSIONTYPE_X11;
-    }
-
-    VBGHLogVerbose(1, "XDG current desktop type is: %s\n", VBGHSessionTypeToStr(xdgCurrentDesktopType));
+            xdgCurrentDesktopType = VBGHDISPLAYSERVERTYPE_X11;
+    }
+
+    VBGHLogVerbose(1, "XDG current desktop type is: %s\n", VBGHDisplayServerTypeToStr(xdgCurrentDesktopType));
 
     /* Set the returning type according to the precedence. */
-    if      (waylandDisplayType    != VBGHSESSIONTYPE_NONE) retSessionType = waylandDisplayType;
-    else if (xdgSessionType        != VBGHSESSIONTYPE_NONE) retSessionType = xdgSessionType;
-    else if (xdgCurrentDesktopType != VBGHSESSIONTYPE_NONE) retSessionType = xdgCurrentDesktopType;
-    else                                                    retSessionType = VBGHSESSIONTYPE_NONE;
+    if      (waylandDisplayType    != VBGHDISPLAYSERVERTYPE_NONE) retSessionType = waylandDisplayType;
+    else if (xdgSessionType        != VBGHDISPLAYSERVERTYPE_NONE) retSessionType = xdgSessionType;
+    else if (xdgCurrentDesktopType != VBGHDISPLAYSERVERTYPE_NONE) retSessionType = xdgCurrentDesktopType;
+    else                                                    retSessionType = VBGHDISPLAYSERVERTYPE_NONE;
 
     /* Try to detect any mismatches between the variables above.
      * This might indicate a misconfigred / broken system, and we can warn the user then. */
 #define COMPARE_SESSION_TYPES(a_Type1, a_Type2) \
-    if (   (a_Type1 != VBGHSESSIONTYPE_NONE) \
-        && (a_Type2 != VBGHSESSIONTYPE_NONE) \
+    if (   (a_Type1 != VBGHDISPLAYSERVERTYPE_NONE) \
+        && (a_Type2 != VBGHDISPLAYSERVERTYPE_NONE) \
         && (a_Type1 != a_Type2)) \
         { \
             VBGHLogError("Unable to reliably detect desktop environment:\n"); \
             VBGHLogError("Mismatch between %s (%s) and %s (%s) detected! This might indicate a misconfigured and/or broken system!\n", \
-                         #a_Type1, VBGHSessionTypeToStr(a_Type1), #a_Type2, VBGHSessionTypeToStr(a_Type2)); \
+                         #a_Type1, VBGHDisplayServerTypeToStr(a_Type1), #a_Type2, VBGHDisplayServerTypeToStr(a_Type2)); \
             VBGHLogError("Use --session-type to override this detection.\n"); \
-            retSessionType = VBGHSESSIONTYPE_NONE; \
+            retSessionType = VBGHDISPLAYSERVERTYPE_NONE; \
         }
 
@@ -197 +197 @@
  * @param   enmType             Type to check.
  */
-bool VBGHSessionTypeIsXAvailable(VBGHSESSIONTYPE enmType)
-{
-    return    enmType == VBGHSESSIONTYPE_XWAYLAND
-           || enmType == VBGHSESSIONTYPE_X11;
+bool VBGHDisplayServerTypeIsXAvailable(VBGHDISPLAYSERVERTYPE enmType)
+{
+    return    enmType == VBGHDISPLAYSERVERTYPE_XWAYLAND
+           || enmType == VBGHDISPLAYSERVERTYPE_X11;
 }
 
@@ -209 +209 @@
  * @param   enmType             Type to check.
  */
-bool VBGHSessionTypeIsWaylandAvailable(VBGHSESSIONTYPE enmType)
-{
-    return    enmType == VBGHSESSIONTYPE_XWAYLAND
-           || enmType == VBGHSESSIONTYPE_WAYLAND;
-}
-
+bool VBGHDisplayServerTypeIsWaylandAvailable(VBGHDISPLAYSERVERTYPE enmType)
+{
+    return    enmType == VBGHDISPLAYSERVERTYPE_XWAYLAND
+           || enmType == VBGHDISPLAYSERVERTYPE_WAYLAND;
+}
+