[WIP] Implement a Wayland DisplayServer

.github/workflows/linux_builds.yml

@@ -87,8 +87,8 @@ jobs:
           # The actual dependencies
           sudo apt-get install build-essential pkg-config libx11-dev libxcursor-dev \
               libxinerama-dev libgl1-mesa-dev libglu-dev libasound2-dev libpulse-dev \
-              libdbus-1-dev libudev-dev libxi-dev libxrandr-dev yasm xvfb wget unzip \
-              llvm libspeechd-dev speech-dispatcher
+              libdbus-1-dev libudev-dev libxi-dev libxkbcommon-dev libxrandr-dev \
+              libwayland-dev yasm xvfb wget unzip llvm libspeechd-dev speech-dispatcher
 
       - name: Setup Godot build cache
         uses: ./.github/actions/godot-cache

drivers/vulkan/SCsub

@@ -18,7 +18,10 @@ if env["platform"] == "android":
 elif env["platform"] == "iphone":
     env.AppendUnique(CPPDEFINES=["VK_USE_PLATFORM_IOS_MVK"])
 elif env["platform"] == "linuxbsd":
-    env.AppendUnique(CPPDEFINES=["VK_USE_PLATFORM_XLIB_KHR"])
+    if env["x11"]:
+        env.AppendUnique(CPPDEFINES=["VK_USE_PLATFORM_XLIB_KHR"])
+    if env["wayland"]:
+        env.AppendUnique(CPPDEFINES=["VK_USE_PLATFORM_WAYLAND_KHR"])
 elif env["platform"] == "osx":
     env.AppendUnique(CPPDEFINES=["VK_USE_PLATFORM_MACOS_MVK"])
 elif env["platform"] == "windows":

modules/openxr/SCsub

@@ -35,7 +35,10 @@ if env["platform"] == "android":
 
     # may need to include java parts of the openxr loader
 elif env["platform"] == "linuxbsd":
-    env_thirdparty.AppendUnique(CPPDEFINES=["XR_OS_LINUX", "XR_USE_PLATFORM_XLIB"])
+    if env["x11"] == True:
+        env_thirdparty.AppendUnique(CPPDEFINES=["XR_OS_LINUX", "XR_USE_PLATFORM_XLIB"])
+    if env["wayland"] == True:
+        env_thirdparty.AppendUnique(CPPDEFINES=["XR_OS_LINUX", "XR_USE_PLATFORM_WAYLAND"])
     # FIXME: Review what needs to be set for Android and macOS.
     env_thirdparty.AppendUnique(CPPDEFINES=["HAVE_SECURE_GETENV"])
 elif env["platform"] == "windows":

platform/linuxbsd/SCsub

@@ -5,6 +5,8 @@ Import("env")
 from platform_methods import run_in_subprocess
 import platform_linuxbsd_builders
 
+thirdparty_dir = "#thirdparty"
+
 common_linuxbsd = [
     "crash_handler_linuxbsd.cpp",
     "os_linuxbsd.cpp",
@@ -20,12 +22,87 @@ if "x11" in env and env["x11"]:
         "key_mapping_x11.cpp",
     ]
 
+    if "vulkan" in env and env["vulkan"]:
+        common_linuxbsd.append("vulkan_context_x11.cpp")
+
+if "wayland" in env and env["wayland"]:
+    # TODO: Add warning to headers and code about their autogenerated status.
+    WAYLAND_BUILDERS = {
+        "WAYLAND_API_HEADER": Builder(
+            action=Action(
+                "wayland-scanner -c client-header ${SOURCE} ${TARGET}", 'Building Wayland client header: "${TARGET}"'
+            ),
+            single_source=True,
+        ),
+        "WAYLAND_API_CODE": Builder(
+            action=Action(
+                "wayland-scanner -c private-code ${SOURCE} ${TARGET}",
+                'Building Wayland protocol marshalling code: "${TARGET}"',
+            ),
+            single_source=True,
+        ),
+    }
+
+    env.Append(BUILDERS=WAYLAND_BUILDERS)
+
+    # TODO: Rebuild headers if they change
+    env.WAYLAND_API_HEADER(target="wayland.gen.h", source="#thirdparty/wayland/protocol/wayland.xml")
+    env.WAYLAND_API_CODE(target="wayland.gen.c", source="#thirdparty/wayland/protocol/wayland.xml")
+
+    env.WAYLAND_API_HEADER(
+        target="xdg_shell.gen.h", source="#thirdparty/wayland-protocols/stable/xdg-shell/xdg-shell.xml"
+    )
+
+    env.WAYLAND_API_CODE(
+        target="xdg_shell.gen.c", source="#thirdparty/wayland-protocols/stable/xdg-shell/xdg-shell.xml"
+    )
+
+    env.WAYLAND_API_HEADER(
+        target="relative_pointer.gen.h",
+        source="#thirdparty/wayland-protocols/unstable/relative-pointer/relative-pointer-unstable-v1.xml",
+    )
+
+    env.WAYLAND_API_CODE(
+        target="relative_pointer.gen.c",
+        source="#thirdparty/wayland-protocols/unstable/relative-pointer/relative-pointer-unstable-v1.xml",
+    )
+
+    env.WAYLAND_API_HEADER(
+        target="pointer_constraints.gen.h",
+        source="#thirdparty/wayland-protocols/unstable/pointer-constraints/pointer-constraints-unstable-v1.xml",
+    )
+
+    env.WAYLAND_API_CODE(
+        target="pointer_constraints.gen.c",
+        source="#thirdparty/wayland-protocols/unstable/pointer-constraints/pointer-constraints-unstable-v1.xml",
+    )
+
+    env.WAYLAND_API_HEADER(
+        target="wlr_data_control.gen.h",
+        source="#thirdparty/wlr-protocols/unstable/wlr-data-control-unstable-v1.xml",
+    )
+
+    env.WAYLAND_API_CODE(
+        target="wlr_data_control.gen.c",
+        source="#thirdparty/wlr-protocols/unstable/wlr-data-control-unstable-v1.xml",
+    )
+
+    common_linuxbsd += [
+        "wayland.gen.c",
+        "xdg_shell.gen.c",
+        "relative_pointer.gen.c",
+        "pointer_constraints.gen.c",
+        "wlr_data_control.gen.c",
+        "display_server_wayland.cpp",
+        "key_mapping_xkb.cpp",
+    ]
+
+    if "vulkan" in env and env["vulkan"]:
+        common_linuxbsd.append("vulkan_context_wayland.cpp")
+
 if "speechd" in env and env["speechd"]:
     common_linuxbsd.append(["speechd-so_wrap.c", "tts_linux.cpp"])
 
-if "vulkan" in env and env["vulkan"]:
-    common_linuxbsd.append("vulkan_context_x11.cpp")
-
 if "udev" in env and env["udev"]:
     common_linuxbsd.append("libudev-so_wrap.c")
 

platform/linuxbsd/detect.py

@@ -16,11 +16,22 @@ def can_build():
         return False
 
     # Check the minimal dependencies
-    x11_error = os.system("pkg-config --version > /dev/null")
-    if x11_error:
+    pkgconfig_error = os.system("pkg-config --version > /dev/null")
+    if pkgconfig_error:
         print("Error: pkg-config not found. Aborting.")
         return False
 
+    # TODO: Make X11 and Wayland coesist peacefully.
+    #    if env["x11"]:
+    #        return check_x11_dependencies()
+    #
+    #    if env["wayland"]:
+    #        return check_wayland_dependencies()
+    #
+    return True
+
+
+def check_x11_dependencies():
     x11_error = os.system("pkg-config x11 --modversion > /dev/null")
     if x11_error:
         print("Error: X11 libraries not found. Aborting.")
@@ -59,6 +70,45 @@ def can_build():
     return True
 
 
+def check_wayland_dependencies():
+    wayland_error = os.system("pkg-config wayland-client --modversion > /dev/null")
+    if wayland_error:
+        print("Error: wayland-client library not found. Aborting.")
+        return False
+
+    wayland_error = os.system("pkg-config wayland-cursor --modversion > /dev/null")
+    if wayland_error:
+        print("Error: wayland-cursor library not found. Aborting.")
+        return False
+
+    wayland_error = os.system("pkg-config wayland-scanner --modversion > /dev/null")
+    if wayland_error:
+        print("Error: wayland-scanner not found. Aborting.")
+        return False
+
+    # We need at least version 1.20
+    min_wayland_client_version = "1.20"
+
+    import subprocess
+
+    wayland_client_version = subprocess.check_output(["pkg-config", "wayland-client", "--modversion"]).decode("utf-8")
+    if wayland_client_version < min_wayland_client_version:
+        # Abort as system wayland-client was requested but too old
+        print(
+            "wayland-client: System version {0} does not match minimal requirements ({1}). Aborting.".format(
+                wayland_client_version, min_wayland_client_version
+            )
+        )
+        return False
+
+    wayland_error = os.system("pkg-config xkbcommon --modversion > /dev/null")
+    if wayland_error:
+        print("Error: xkbcommon library not found. Aborting.")
+        return False
+
+    return True
+
+
 def get_opts():
     from SCons.Variables import BoolVariable, EnumVariable
 
@@ -78,6 +128,7 @@ def get_opts():
         BoolVariable("speechd", "Detect and use Speech Dispatcher for Text-to-Speech support", True),
         BoolVariable("udev", "Use udev for gamepad connection callbacks", True),
         BoolVariable("x11", "Enable X11 display", True),
+        BoolVariable("wayland", "Enable Wayland display", True),
         BoolVariable("debug_symbols", "Add debugging symbols to release/release_debug builds", True),
         BoolVariable("separate_debug_symbols", "Create a separate file containing debugging symbols", False),
         BoolVariable("touch", "Enable touch events", True),
@@ -220,13 +271,19 @@ def configure(env):
 
     ## Dependencies
 
-    env.ParseConfig("pkg-config x11 --cflags --libs")
-    env.ParseConfig("pkg-config xcursor --cflags --libs")
-    env.ParseConfig("pkg-config xinerama --cflags --libs")
-    env.ParseConfig("pkg-config xext --cflags --libs")
-    env.ParseConfig("pkg-config xrandr --cflags --libs")
-    env.ParseConfig("pkg-config xrender --cflags --libs")
-    env.ParseConfig("pkg-config xi --cflags --libs")
+    if env["x11"]:
+        env.ParseConfig("pkg-config x11 --cflags --libs")
+        env.ParseConfig("pkg-config xcursor --cflags --libs")
+        env.ParseConfig("pkg-config xinerama --cflags --libs")
+        env.ParseConfig("pkg-config xext --cflags --libs")
+        env.ParseConfig("pkg-config xrandr --cflags --libs")
+        env.ParseConfig("pkg-config xrender --cflags --libs")
+        env.ParseConfig("pkg-config xi --cflags --libs")
+
+    if env["wayland"]:
+        env.ParseConfig("pkg-config wayland-client --cflags --libs")
+        env.ParseConfig("pkg-config wayland-cursor --cflags --libs")
+        env.ParseConfig("pkg-config xkbcommon --cflags --libs")
 
     if env["touch"]:
         env.Append(CPPDEFINES=["TOUCH_ENABLED"])
@@ -371,6 +428,12 @@ def configure(env):
             env.Exit(255)
         env.Append(CPPDEFINES=["X11_ENABLED"])
 
+    if env["wayland"]:
+        if not env["vulkan"]:
+            print("Error: Wayland support requires vulkan=yes")
+            env.Exit(255)
+        env.Append(CPPDEFINES=["WAYLAND_ENABLED"])
+
     env.Append(CPPDEFINES=["UNIX_ENABLED"])
     env.Append(CPPDEFINES=[("_FILE_OFFSET_BITS", 64)])
 
@@ -382,8 +445,9 @@ def configure(env):
             # No pkgconfig file so far, hardcode expected lib name.
             env.Append(LIBS=["glslang", "SPIRV"])
 
-    env.Append(CPPDEFINES=["GLES3_ENABLED"])
-    env.ParseConfig("pkg-config gl --cflags --libs")
+    # TODO: Make this work, maybe reporting a missing conditional
+    # env.Append(CPPDEFINES=["GLES3_ENABLED"])
+    # env.Append(LIBS=["GL"])
 
     env.Append(LIBS=["pthread"])