Initial code for macOS support.

squidbus · squidbus · commit 54fe473cb1e8 · 2025-03-02T23:51:28.000-08:00
diff --git a/CMakePresets.json b/CMakePresets.json
@@ -113,6 +113,62 @@
                 "CMAKE_BUILD_TYPE": "Release",
                 "CMAKE_INTERPROCEDURAL_OPTIMIZATION": true
             }
+        },
+        {
+            "name": "macos-base",
+            "hidden": true,
+            "generator": "Ninja",
+            "binaryDir": "${sourceDir}/out/build/${presetName}",
+            "installDir": "${sourceDir}/out/install/${presetName}",
+            "cacheVariables": {
+                "CMAKE_OSX_ARCHITECTURES": "x86_64",
+                "CMAKE_TOOLCHAIN_FILE": {
+                    "value": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake",
+                    "type": "FILEPATH"
+                },
+                "VCPKG_TARGET_TRIPLET": {
+                    "value": "x64-osx",
+                    "type": "STRING"
+                }
+            },
+            "environment": {
+                "VCPKG_ROOT": "${sourceDir}/thirdparty/vcpkg"
+            },
+            "condition": {
+                "type": "equals",
+                "lhs": "${hostSystemName}",
+                "rhs": "Darwin"
+            },
+            "vendor": {
+                "microsoft.com/VisualStudioRemoteSettings/CMake/2.0": {
+                    "remoteSourceRootDir": "$env{HOME}/.vs/$ms{projectDirName}"
+                }
+            }
+        },
+        {
+            "name": "macos-debug",
+            "displayName": "macOS-Debug",
+            "inherits": "macos-base",
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "Debug"
+            }
+        },
+        {
+            "name": "macos-relwithdebinfo",
+            "displayName": "macOS-RelWithDebInfo",
+            "inherits": "macos-base",
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "RelWithDebInfo"
+            }
+        },
+        {
+            "name": "macos-release",
+            "displayName": "macOS-Release",
+            "inherits": "macos-base",
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "Release",
+                "CMAKE_INTERPROCEDURAL_OPTIMIZATION": true
+            }
         }
     ]
 }
diff --git a/UnleashedRecomp/CMakeLists.txt b/UnleashedRecomp/CMakeLists.txt
@@ -97,6 +97,14 @@ elseif (CMAKE_SYSTEM_NAME MATCHES "Linux")
         "os/linux/user_linux.cpp"
         "os/linux/version_linux.cpp"
     )
+elseif (APPLE)
+    set(UNLEASHED_RECOMP_OS_CXX_SOURCES
+        "os/macos/logger_macos.cpp"
+        "os/macos/media_macos.cpp"
+        "os/macos/process_macos.cpp"
+        "os/macos/user_macos.cpp"
+        "os/macos/version_macos.cpp"
+    )
 endif()
 
 set(UNLEASHED_RECOMP_CPU_CXX_SOURCES
diff --git a/UnleashedRecomp/framework.h b/UnleashedRecomp/framework.h
@@ -63,3 +63,47 @@ inline std::unique_ptr<uint8_t[]> ReadAllBytes(const char* filePath, size_t& fil
 
     return data;
 }
+
+#ifndef __cpp_lib_atomic_ref
+// Polyfill for std::atomic_ref
+namespace std {
+template <typename value_type>
+class atomic_ref
+{
+public:
+    atomic_ref(value_type& ref)
+    {
+        ptr = reinterpret_cast<std::atomic<value_type>*>(&ref);
+    }
+
+    void store(value_type desired)
+    {
+        ptr->store(desired);
+    }
+
+    bool compare_exchange_weak(value_type& expected, value_type desired)
+    {
+        return ptr->compare_exchange_weak(expected, desired);
+    }
+
+    void wait(value_type old)
+    {
+        ptr->wait(old);
+    }
+
+    void notify_one()
+    {
+        ptr->notify_one();
+    }
+
+    bool operator=(const value_type& rhs)
+    {
+        store(rhs);
+    }
+
+private:
+    std::atomic<value_type>* ptr;
+};
+}
+#endif
+
diff --git a/UnleashedRecomp/gpu/rhi/plume_render_interface_types.h b/UnleashedRecomp/gpu/rhi/plume_render_interface_types.h
@@ -26,7 +26,7 @@
 #undef ControlMask
 #undef Success
 #elif defined(__APPLE__)
-typedef struct _NSWindow NSWindow;
+typedef void CAMetalLayer;
 #endif
 
 #ifdef SDL_VULKAN_ENABLED
@@ -52,9 +52,9 @@ namespace plume {
     };
 #elif defined(__APPLE__)
     struct RenderWindow {
-        NSWindow* window;
+        CAMetalLayer* layer;
         bool operator==(const struct RenderWindow& rhs) const {
-            return window == rhs.window;
+            return layer == rhs.layer;
         }
         bool operator!=(const struct RenderWindow& rhs) const { return !(*this == rhs); }
     };
diff --git a/UnleashedRecomp/gpu/rhi/plume_vulkan.cpp b/UnleashedRecomp/gpu/rhi/plume_vulkan.cpp
@@ -51,6 +51,9 @@ namespace plume {
         VK_KHR_ANDROID_SURFACE_EXTENSION_NAME,
 #   elif defined(__linux__)
         VK_KHR_XLIB_SURFACE_EXTENSION_NAME,
+#   elif defined(__APPLE__)
+        VK_EXT_METAL_SURFACE_EXTENSION_NAME,
+        VK_KHR_PORTABILITY_ENUMERATION_EXTENSION_NAME,
 #   endif
     };
 
@@ -65,7 +68,11 @@ namespace plume {
         VK_KHR_BUFFER_DEVICE_ADDRESS_EXTENSION_NAME,
         VK_KHR_SAMPLER_MIRROR_CLAMP_TO_EDGE_EXTENSION_NAME,
 #   ifdef VULKAN_OBJECT_NAMES_ENABLED
-        VK_EXT_DEBUG_UTILS_EXTENSION_NAME
+        VK_EXT_DEBUG_UTILS_EXTENSION_NAME,
+#   endif
+#   ifdef __APPLE__
+        // Vulkan spec requires this to be enabled if supported.
+        VK_KHR_PORTABILITY_SUBSET_EXTENSION_NAME,
 #   endif
     };
     
@@ -2045,6 +2052,18 @@ namespace plume {
             fprintf(stderr, "vkCreateXlibSurfaceKHR failed with error code 0x%X.\n", res);
             return;
         }
+#   elif defined(__APPLE__)
+        assert(renderWindow.window != nullptr);
+        VkMetalSurfaceCreateInfoEXT surfaceCreateInfo = {};
+        surfaceCreateInfo.sType = VK_STRUCTURE_TYPE_METAL_SURFACE_CREATE_INFO_EXT;
+        surfaceCreateInfo.pLayer = renderWindow.layer;
+
+        VulkanInterface *renderInterface = commandQueue->device->renderInterface;
+        res = vkCreateMetalSurfaceEXT(renderInterface->instance, &surfaceCreateInfo, nullptr, &surface);
+        if (res != VK_SUCCESS) {
+            fprintf(stderr, "vkCreateMetalSurfaceEXT failed with error code 0x%X.\n", res);
+            return;
+        }
 #   endif
 
         VkBool32 presentSupported = false;
@@ -4321,6 +4340,10 @@ namespace plume {
             }
         }
 #   endif
+
+#   ifdef __APPLE__
+        createInfo.flags |= VK_INSTANCE_CREATE_ENUMERATE_PORTABILITY_BIT_KHR;
+#   endif
         
         res = vkCreateInstance(&createInfo, nullptr, &instance);
         if (res != VK_SUCCESS) {
diff --git a/UnleashedRecomp/gpu/rhi/plume_vulkan.h b/UnleashedRecomp/gpu/rhi/plume_vulkan.h
@@ -20,6 +20,10 @@
 #define VK_USE_PLATFORM_ANDROID_KHR
 #elif defined(__linux__)
 #define VK_USE_PLATFORM_XLIB_KHR
+#elif defined(__APPLE__)
+#define VK_USE_PLATFORM_METAL_EXT
+// For VK_KHR_portability_subset
+#define VK_ENABLE_BETA_EXTENSIONS
 #endif
 
 #include <volk.h>
diff --git a/UnleashedRecomp/install/update_checker.cpp b/UnleashedRecomp/install/update_checker.cpp
@@ -166,6 +166,9 @@ void UpdateChecker::visitWebsite()
 #elif defined(__linux__)
     std::string command = "xdg-open " + std::string(VISIT_URL) + " &";
     std::system(command.c_str());
+#elif defined(__APPLE__)
+    std::string command = "open " + std::string(VISIT_URL) + " &";
+    std::system(command.c_str());
 #else
     static_assert(false, "Visit website not implemented for this platform.");
 #endif
diff --git a/UnleashedRecomp/os/macos/logger_macos.cpp b/UnleashedRecomp/os/macos/logger_macos.cpp
@@ -0,0 +1,17 @@
+#include <os/logger.h>
+
+void os::logger::Init()
+{
+}
+
+void os::logger::Log(const std::string_view str, ELogType type, const char* func)
+{
+    if (func)
+    {
+        fmt::println("[{}] {}", func, str);
+    }
+    else
+    {
+        fmt::println("{}", str);
+    }
+}
diff --git a/UnleashedRecomp/os/macos/media_macos.cpp b/UnleashedRecomp/os/macos/media_macos.cpp
@@ -0,0 +1,7 @@
+#include <os/media.h>
+
+bool os::media::IsExternalMediaPlaying()
+{
+    // This functionality is not supported in macOS.
+    return false;
+}
diff --git a/UnleashedRecomp/os/macos/process_macos.cpp b/UnleashedRecomp/os/macos/process_macos.cpp
@@ -0,0 +1,76 @@
+#include <os/process.h>
+
+#include <mach-o/dyld.h>
+#include <signal.h>
+#include <unistd.h>
+
+std::filesystem::path os::process::GetExecutablePath()
+{
+    uint32_t exePathSize = PATH_MAX;
+    char exePath[PATH_MAX] = {};
+    if (_NSGetExecutablePath(exePath, &exePathSize) == 0)
+    {
+        return std::filesystem::path(std::u8string_view((const char8_t*)(exePath)));
+    }
+    else
+    {
+        return std::filesystem::path();
+    }
+}
+
+std::filesystem::path os::process::GetWorkingDirectory()
+{
+    char cwd[PATH_MAX] = {};
+    char *res = getcwd(cwd, sizeof(cwd));
+    if (res != nullptr)
+    {
+        return std::filesystem::path(std::u8string_view((const char8_t*)(cwd)));
+    }
+    else
+    {
+        return std::filesystem::path();
+    }
+}
+
+bool os::process::SetWorkingDirectory(const std::filesystem::path& path)
+{
+    return chdir(path.c_str()) == 0;
+}
+
+bool os::process::StartProcess(const std::filesystem::path& path, const std::vector<std::string>& args, std::filesystem::path work)
+{
+    pid_t pid = fork();
+    if (pid < 0)
+        return false;
+
+    if (pid == 0)
+    {
+        setsid();
+
+        std::u8string workU8 = work.u8string();
+        chdir((const char*)(workU8.c_str()));
+
+        std::u8string pathU8 = path.u8string();
+        std::vector<char*> argStrs;
+        argStrs.push_back((char*)(pathU8.c_str()));
+        for (const std::string& arg : args)
+            argStrs.push_back((char *)(arg.c_str()));
+
+        argStrs.push_back(nullptr);
+        execvp((const char*)(pathU8.c_str()), argStrs.data());
+        raise(SIGKILL);
+    }
+
+    return true;
+}
+
+void os::process::CheckConsole()
+{
+    // Always visible on macOS.
+    g_consoleVisible = true;
+}
+
+void os::process::ShowConsole()
+{
+    // Unnecessary on macOS.
+}
diff --git a/UnleashedRecomp/os/macos/registry_macos.inl b/UnleashedRecomp/os/macos/registry_macos.inl
@@ -0,0 +1,21 @@
+#include <os/registry.h>
+
+// TODO: Implement
+inline bool os::registry::Init()
+{
+    return false;
+}
+
+// TODO: read from file?
+template<typename T>
+bool os::registry::ReadValue(const std::string_view& name, T& data)
+{
+    return false;
+}
+
+// TODO: write to file?
+template<typename T>
+bool os::registry::WriteValue(const std::string_view& name, const T& data)
+{
+    return false;
+}
diff --git a/UnleashedRecomp/os/macos/user_macos.cpp b/UnleashedRecomp/os/macos/user_macos.cpp
@@ -0,0 +1,6 @@
+#include <os/user.h>
+
+bool os::user::IsDarkTheme()
+{
+    return false;
+}
diff --git a/UnleashedRecomp/os/macos/version_macos.cpp b/UnleashedRecomp/os/macos/version_macos.cpp
@@ -0,0 +1,7 @@
+#include <os/version.h>
+
+os::version::OSVersion os::version::GetOSVersion()
+{
+    assert(false && "Unimplemented.");
+    return os::version::OSVersion();
+}
diff --git a/UnleashedRecomp/os/registry.h b/UnleashedRecomp/os/registry.h
@@ -15,4 +15,6 @@ namespace os::registry
 #include <os/win32/registry_win32.inl>
 #elif defined(__linux__)
 #include <os/linux/registry_linux.inl>
+#elif defined(__APPLE__)
+#include <os/macos/registry_macos.inl>
 #endif
diff --git a/UnleashedRecomp/ui/button_guide.cpp b/UnleashedRecomp/ui/button_guide.cpp
@@ -20,7 +20,7 @@ std::unique_ptr<GuestTexture> g_upKBMIcons;
 
 float g_sideMargins = DEFAULT_SIDE_MARGINS;
 
-std::vector<Button> g_buttons;
+static std::vector<Button> g_buttons;
 
 std::unordered_map<EButtonIcon, float> g_iconWidths =
 {
diff --git a/UnleashedRecomp/ui/game_window.cpp b/UnleashedRecomp/ui/game_window.cpp
@@ -211,6 +211,8 @@ void GameWindow::Init(const char* sdlVideoDriver)
     s_renderWindow = s_pWindow;
 #elif defined(__linux__)
     s_renderWindow = { info.info.x11.display, info.info.x11.window };
+#elif defined(__APPLE__)
+    s_renderWindow = { SDL_Metal_GetLayer(SDL_Metal_CreateView(s_pWindow)) };
 #else
     static_assert(false, "Unknown platform.");
 #endif
diff --git a/UnleashedRecomp/ui/message_window.cpp b/UnleashedRecomp/ui/message_window.cpp
@@ -41,7 +41,7 @@ static ImFont* g_fntSeurat;
 
 std::string g_text;
 int g_result;
-std::vector<std::string> g_buttons;
+static std::vector<std::string> g_buttons;
 int g_defaultButtonIndex;
 int g_cancelButtonIndex;
 
diff --git a/UnleashedRecomp/user/paths.cpp b/UnleashedRecomp/user/paths.cpp

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ std::unique_ptr<GuestTexture> g_upKBMIcons;`
`20`	`20`
`21`	`21`	`float g_sideMargins = DEFAULT_SIDE_MARGINS;`
`22`	`22`
`23`		`-std::vector<Button> g_buttons;`
	`23`	`+static std::vector<Button> g_buttons;`
`24`	`24`
`25`	`25`	`std::unordered_map<EButtonIcon, float> g_iconWidths =`
`26`	`26`	`{`