AccessKit integration for macOS, Linux, and Windows.

Author: bruvzg

.github/workflows/linux_builds.yml

@@ -5,7 +5,7 @@ on:
 # Global Settings
 env:
   GODOT_CPP_BRANCH: 4.4
-  SCONSFLAGS: verbose=yes warnings=extra werror=yes module_text_server_fb_enabled=yes strict_checks=yes
+  SCONSFLAGS: verbose=yes warnings=extra werror=yes module_text_server_fb_enabled=yes strict_checks=yes "accesskit_sdk_path=${{ github.workspace }}/accesskit-c-0.15.1/"
   DOTNET_NOLOGO: true
   DOTNET_CLI_TELEMETRY_OPTOUT: true
   TSAN_OPTIONS: suppressions=${{ github.workspace }}/misc/error_suppressions/tsan.txt
@@ -151,6 +151,17 @@ jobs:
           # Targeting the oldest version we want to support to ensure it still builds.
           dotnet-version: 8.0.100
 
+      - name: Download pre-built AccessKit
+        uses: dsaltares/[email protected]
+        with:
+          repo: AccessKit/accesskit-c
+          version: tags/0.15.1
+          file: accesskit-c-0.15.1.zip
+          target: accesskit-c-0.15.1/accesskit_c.zip
+
+      - name: Extract pre-built AccessKit
+        run: unzip -o accesskit-c-0.15.1/accesskit_c.zip
+
       - name: Compilation
         uses: ./.github/actions/godot-build
         with:

.github/workflows/macos_builds.yml

@@ -4,7 +4,7 @@ on:
 
 # Global Settings
 env:
-  SCONSFLAGS: verbose=yes warnings=extra werror=yes module_text_server_fb_enabled=yes strict_checks=yes
+  SCONSFLAGS: verbose=yes warnings=extra werror=yes module_text_server_fb_enabled=yes strict_checks=yes "accesskit_sdk_path=${{ github.workspace }}/accesskit-c-0.15.1/"
 
 jobs:
   build-macos:
@@ -43,6 +43,17 @@ jobs:
       - name: Setup Python and SCons
         uses: ./.github/actions/godot-deps
 
+      - name: Download pre-built AccessKit
+        uses: dsaltares/[email protected]
+        with:
+          repo: AccessKit/accesskit-c
+          version: tags/0.15.1
+          file: accesskit-c-0.15.1.zip
+          target: accesskit-c-0.15.1/accesskit_c.zip
+
+      - name: Extract pre-built AccessKit
+        run: unzip -o accesskit-c-0.15.1/accesskit_c.zip
+
       - name: Setup Vulkan SDK
         id: vulkan-sdk
         run: |

.github/workflows/windows_builds.yml

@@ -5,7 +5,7 @@ on:
 # Global Settings
 # SCONS_CACHE for windows must be set in the build environment
 env:
-  SCONSFLAGS: verbose=yes warnings=extra werror=yes module_text_server_fb_enabled=yes d3d12=yes strict_checks=yes "angle_libs=${{ github.workspace }}/"
+  SCONSFLAGS: verbose=yes warnings=extra werror=yes module_text_server_fb_enabled=yes d3d12=yes strict_checks=yes "angle_libs=${{ github.workspace }}/" "accesskit_sdk_path=${{ github.workspace }}/accesskit-c-0.15.1/"
   SCONS_CACHE_MSVC_CONFIG: true
 
 jobs:
@@ -81,6 +81,17 @@ jobs:
       - name: Extract pre-built ANGLE static libraries
         run: Expand-Archive -Force angle/angle.zip ${{ github.workspace }}/
 
+      - name: Download pre-built AccessKit
+        uses: dsaltares/[email protected]
+        with:
+          repo: AccessKit/accesskit-c
+          version: tags/0.15.1
+          file: accesskit-c-0.15.1.zip
+          target: accesskit-c-0.15.1/accesskit_c.zip
+
+      - name: Extract pre-built AccessKit
+        run: unzip -o accesskit-c-0.15.1/accesskit_c.zip
+
       - name: Compilation
         uses: ./.github/actions/godot-build
         with:

.pre-commit-config.yaml

@@ -4,9 +4,7 @@ default_language_version:
 exclude: |
   (?x)^(
     .*thirdparty/.*|
-    .*-so_wrap\.(h|c)|
-    .*-dll_wrap\.(h|c)|
-    .*-dylib_wrap\.(h|c)|
+    .*-(dll|dylib|so)_wrap\.[ch]|
     platform/android/java/editor/src/main/java/com/android/.*|
     platform/android/java/lib/src/com/google/.*
   )$

COPYRIGHT.txt

@@ -163,6 +163,11 @@ Comment: Temporal Anti-Aliasing resolve implementation
 Copyright: 2016, Panos Karabelas
 License: Expat
 
+Files: thirdparty/accesskit/*
+Comment: AccessKit
+Copyright: 2023, The AccessKit Authors.
+License: Expat
+
 Files: thirdparty/amd-fsr/*
 Comment: AMD FidelityFX Super Resolution
 Copyright: 2021, Advanced Micro Devices, Inc.

SConstruct

@@ -191,6 +191,8 @@ opts.Add(BoolVariable("use_volk", "Use the volk library to load the Vulkan loade
 opts.Add(BoolVariable("disable_exceptions", "Force disabling exception handling code", True))
 opts.Add("custom_modules", "A list of comma-separated directory paths containing custom modules to build.", "")
 opts.Add(BoolVariable("custom_modules_recursive", "Detect custom modules recursively for each specified path.", True))
+opts.Add(BoolVariable("accesskit", "Use AccessKit C SDK", True))
+opts.Add(("accesskit_sdk_path", "Path to the AccessKit C SDK", ""))
 
 # Advanced options
 opts.Add(

drivers/SCsub

@@ -26,9 +26,15 @@ if env["xaudio2"]:
         print_error("Target platform '{}' does not support the XAudio2 audio driver".format(env["platform"]))
         Exit(255)
     SConscript("xaudio2/SCsub")
+
 # Shared Apple platform drivers
 if env["platform"] in ["macos", "ios"]:
     SConscript("apple/SCsub")
+
+# Accessibility
+if env["accesskit"] and env["platform"] in ["macos", "windows", "linuxbsd"]:
+    SConscript("accesskit/SCsub")
+
 # Midi drivers
 SConscript("alsamidi/SCsub")
 if env["platform"] in ["macos", "ios"]:

drivers/accesskit/SCsub

@@ -0,0 +1,16 @@
+#!/usr/bin/env python
+from misc.utility.scons_hints import *
+
+Import("env")
+
+# Driver source files
+env.add_source_files(env.drivers_sources, "accessibility_driver_accesskit.cpp")
+
+if env["accesskit_sdk_path"] == "":
+    if env["platform"] == "windows":
+        env.add_source_files(env.drivers_sources, "dynwrappers/accesskit-dll_wrap.c")
+    if env["platform"] == "macos":
+        env.add_source_files(env.drivers_sources, "dynwrappers/accesskit-dylib_wrap.c")
+    if env["platform"] == "linuxbsd":
+        env.add_source_files(env.drivers_sources, "dynwrappers/accesskit-so_wrap.c")
+    env.Prepend(CPPPATH=["#thirdparty/accesskit/include"])