integrate the terrors

.github/workflows/rolling-release.yml

@@ -74,7 +74,6 @@ jobs:
         call update_rc_version.bat
         cd ..\..
         git update-index --assume-unchanged src/duckstation-qt/duckstation-qt.rc
-        git update-index --assume-unchanged src/duckstation-nogui/duckstation-nogui.rc
 
     - name: Compile x64 release build
       shell: cmd
@@ -166,7 +165,6 @@ jobs:
         call update_rc_version.bat
         cd ..\..
         git update-index --assume-unchanged src/duckstation-qt/duckstation-qt.rc
-        git update-index --assume-unchanged src/duckstation-nogui/duckstation-nogui.rc
 
     - name: Compile arm64 release build
       shell: cmd
@@ -240,11 +238,11 @@ jobs:
       uses: actions/[email protected]
       with:
         path: ~/deps
-        key: deps ${{ hashFiles('scripts/build-dependencies.sh') }}
+        key: deps ${{ hashFiles('scripts/build-dependencies-linux.sh') }}
 
     - name: Build Dependencies
       if: steps.cache-deps.outputs.cache-hit != 'true'
-      run: scripts/build-dependencies.sh "$HOME/deps"
+      run: scripts/build-dependencies-linux.sh "$HOME/deps"
 
     - name: Tag as preview build
       if: github.ref == 'refs/heads/master'
@@ -283,7 +281,7 @@ jobs:
   linux-flatpak-build:
     runs-on: ubuntu-22.04
     container:
-      image: ghcr.io/flathub-infra/flatpak-github-actions:kde-6.6
+      image: ghcr.io/flathub-infra/flatpak-github-actions:kde-6.7
       options: --privileged
     timeout-minutes: 120
     steps:
@@ -322,7 +320,7 @@ jobs:
         branch: master
         cache: true
         restore-cache: true
-        cache-key: flatpak-x64-${{ hashFiles('.scripts/flatpak/**/*.json') }}
+        cache-key: flatpak-x64-${{ hashFiles('scripts/flatpak/**/*.json') }}
 
     # fails due to screenshots..
     #- name: Validate build
@@ -344,11 +342,6 @@ jobs:
       with:
         fetch-depth: 0
 
-    # Python 3.12 removed distutils, used by MoltenVK -> glslang.
-    - uses: actions/setup-python@v4
-      with:
-        python-version: '3.11'
-
     - name: Install packages
       shell: bash
       run: |

ATTRIBUTION.md

@@ -1,8 +1,13 @@
-This fork is only meant to stage minimal code and configuration needed for building UWP binaries.  Any general feature requests should go upstream and then be pulled into this project.
+This fork is intended to provide a (mostly) identical DuckStation experience on Xbox.
+
+Any general feature requests should go upstream and then be pulled into this project.
 
 Credits:
-- stenzek/duckstation for inspiration of original UWP app and reuse of UWP downloaders.
-- SirMangler/pcsx2 for UWPUtils.h
+- stenzek/duckstation for the initial UWP development
+- SirMangler/pcsx2 for UWPUtils.h and being a general implementation reference
+- worleydl for the initial development of this
+
+~~WinRT App.cpp is heavily linked to nogui\_host with platform abstractions stripped out.  It is my intent to create a WinRT platform to use with noguihost however I've ran into issues with debugging DX in that approach and haven't found a resolution yet.  Apologies in advance for DRY violations until this issue is resolved.~~
 
-WinRT App.cpp is heavily linked to nogui\_host with platform abstractions stripped out.  It is my intent to create a WinRT platform to use with noguihost however I've ran into issues with debugging DX in that approach and haven't found a resolution yet.  Apologies in advance for DRY violations until this issue is resolved.
+The project no longer relies on NoGUI in any fashion -- WinRT is it's own Host, using FSUI as the husk for most functions (as XAML doesn't work with this configuration, as far as I've tested.
 

CMakeLists.txt

@@ -5,6 +5,17 @@ project(duckstation C CXX)
 cmake_policy(SET CMP0069 NEW)
 set(CMAKE_POLICY_DEFAULT_CMP0069 NEW)
 
+if(${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR})
+  message(FATAL_ERROR "DuckStation does not support in-tree builds. Please make a build directory that is not the source"
+                      "directory and generate your CMake project there using either `cmake -B build_directory` or by "
+                      "running cmake from the build directory.")
+endif()
+
+if(NOT CMAKE_BUILD_TYPE MATCHES "Debug|Devel|MinSizeRel|RelWithDebInfo|Release")
+  message(STATUS "CMAKE_BUILD_TYPE not set, defaulting to Release.")
+  set(CMAKE_BUILD_TYPE "Release")
+endif()
+
 message(STATUS "CMake Version: ${CMAKE_VERSION}")
 message(STATUS "CMake System Name: ${CMAKE_SYSTEM_NAME}")
 message(STATUS "Build Type: ${CMAKE_BUILD_TYPE}")
@@ -13,58 +24,19 @@ message(STATUS "Build Type: ${CMAKE_BUILD_TYPE}")
 set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/CMakeModules/")
 include(DuckStationUtils)
 
-# Platform detection.
-if(${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
-  set(LINUX TRUE)
-elseif(${CMAKE_SYSTEM_NAME} STREQUAL "FreeBSD")
-  set(FREEBSD TRUE)
-endif()
-
-# Renderer options.
-option(ENABLE_OPENGL "Build with OpenGL renderer" ON)
-option(ENABLE_VULKAN "Build with Vulkan renderer" ON)
-
-# Global options.
-if(NOT ANDROID)
-  option(BUILD_NOGUI_FRONTEND "Build the NoGUI frontend" OFF)
-  option(BUILD_QT_FRONTEND "Build the Qt frontend" ON)
-  option(BUILD_REGTEST "Build regression test runner" OFF)
-  option(BUILD_TESTS "Build unit tests" OFF)
-
-  set(ENABLE_CUBEB ON)
-  set(ENABLE_DISCORD_PRESENCE ON)
-  set(ENABLE_SDL2 ON)
-
-  if(LINUX OR FREEBSD)
-    option(ENABLE_X11 "Support X11 window system" ON)
-    option(ENABLE_WAYLAND "Support Wayland window system" ON)
-  endif()
-  if(APPLE)
-    option(SKIP_POSTPROCESS_BUNDLE "Disable bundle post-processing, including Qt additions" OFF)
-  endif()
-endif()
-
-# Everything except Windows/Mac use EGL.
-if(ENABLE_OPENGL AND (LINUX OR FREEBSD OR ANDROID))
-  set(ENABLE_EGL TRUE)
-endif()
-
-if(ENABLE_X11)
-  find_package(X11 REQUIRED)
-  if (NOT X11_Xrandr_FOUND)
-    message(FATAL_ERROR "XRandR extension is required")
-  endif()
-endif()
-if(ENABLE_WAYLAND)
-  message(STATUS "Wayland support enabled")
-endif()
+# Detect system attributes.
+detect_operating_system()
+detect_compiler()
+detect_architecture()
+detect_page_size()
 
+# Build options. Depends on system attributes.
+include(DuckStationBuildOptions)
 
 # Set _DEBUG macro for Debug builds.
 set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -D_DEBUG")
 set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -D_DEBUG")
 
-
 # Release build optimizations for MSVC.
 if(MSVC)
   add_definitions("/D_CRT_SECURE_NO_WARNINGS")
@@ -88,101 +60,16 @@ if(MSVC)
   set(CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO "${CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO} /OPT:REF /OPT:ICF")
 endif()
 
-
-# Default symbol visibility to hidden, that way we don't go through the PLT for intra-library calls.
-if(ANDROID)
-  cmake_policy(SET CMP0063 NEW)
-  set(CMAKE_POLICY_DEFAULT_CMP0063 NEW)
-  set(CMAKE_C_VISIBILITY_PRESET hidden)
-  set(CMAKE_CXX_VISIBILITY_PRESET hidden)
-  set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fno-semantic-interposition")
-  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-semantic-interposition")
-endif()
-
-
 # Warning disables.
-if(CMAKE_COMPILER_IS_GNUCC OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
-    include(CheckCXXFlag)
-    check_cxx_flag(-Wall COMPILER_SUPPORTS_WALL)
-    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wno-switch")
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-switch")
-    if(NOT ANDROID)
-      check_cxx_flag(-Wno-class-memaccess COMPILER_SUPPORTS_MEMACCESS)
-      check_cxx_flag(-Wno-invalid-offsetof COMPILER_SUPPORTS_OFFSETOF)
-    endif()
+if(COMPILER_CLANG OR COMPILER_CLANG_CL OR COMPILER_GCC)
+  include(CheckCXXFlag)
+  check_cxx_flag(-Wall COMPILER_SUPPORTS_WALL)
+  check_cxx_flag(-Wno-class-memaccess COMPILER_SUPPORTS_MEMACCESS)
+  check_cxx_flag(-Wno-invalid-offsetof COMPILER_SUPPORTS_OFFSETOF)
+  set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wno-switch")
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-switch")
 endif()
 
-
-# Detect processor type.
-if(APPLE AND NOT "${CMAKE_OSX_ARCHITECTURES}" STREQUAL "")
-  # Universal binaries.
-  if("x86_64" IN_LIST CMAKE_OSX_ARCHITECTURES)
-    set(CPU_ARCH_X64 TRUE)
-    message(STATUS "Building x86_64 MacOS binaries.")
-  endif()
-  if("arm64" IN_LIST CMAKE_OSX_ARCHITECTURES)
-    set(CPU_ARCH_ARM64 TRUE)
-    message(STATUS "Building ARM64 MacOS binaries.")
-  endif()
-elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "x86_64" OR "${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "amd64" OR
-       "${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "AMD64" OR "${CMAKE_OSX_ARCHITECTURES}" STREQUAL "x86_64")
-  if(CMAKE_SIZEOF_VOID_P EQUAL 8)
-    set(CPU_ARCH_X64 TRUE)
-    message(STATUS "Building x86_64 binaries.")
-  else()
-    # Cross-compiling 32-bit build. 32-bit hosts are not supported.
-    set(CPU_ARCH_X86 TRUE)
-    message(FATAL_ERROR "Building x86_32 binaries is not supported.")
-  endif()
-elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "x86" OR "${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "i386" OR
-       "${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "i686")
-  set(CPU_ARCH_X86 TRUE)
-  message(FATAL_ERROR "Building x86_32 binaries is not supported.")
-elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "aarch64" OR "${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "arm64")
-  if(CMAKE_SIZEOF_VOID_P EQUAL 8) # Might have an A64 kernel, e.g. Raspbian.
-    set(CPU_ARCH_ARM64 TRUE)
-    message(STATUS "Building ARM64 binaries.")
-  else()
-    set(CPU_ARCH_ARM32 TRUE)
-    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -marm -march=armv7-a")
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -marm -march=armv7-a")
-    message(STATUS "Building ARM32 binaries on ARM64.")
-  endif()
-elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "arm" OR "${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "armv7-a" OR
-       "${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "armv7l")
-  set(CPU_ARCH_ARM32 TRUE)
-  message(STATUS "Building ARM32 binaries.")
-  if(ANDROID)
-    # Force ARM mode, since apparently ANDROID_ARM_MODE isn't working..
-    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -marm")
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -marm")
-  else()
-    # Enable NEON.
-    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -marm -march=armv7-a")
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -marm -march=armv7-a")
-  endif()
-elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "riscv64")
-  set(CPU_ARCH_RISCV64 TRUE)
-  message(STATUS "Building RISC-V 64 binaries.")
-  set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -finline-atomics")
-  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -finline-atomics")
-
-  # Still need this, apparently.
-  link_libraries("-latomic")
-
-  if(NOT "${CMAKE_BUILD_TYPE}" STREQUAL "Debug")
-    # Frame pointers generate an annoying amount of code on leaf functions.
-    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fomit-frame-pointer")
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fomit-frame-pointer")
-  endif()
-else()
-  message(FATAL_ERROR "Unknown system processor: ${CMAKE_SYSTEM_PROCESSOR}")
-endif()
-
-# Detect page size if needed.
-detect_page_size()
-
-
 # We don't need exceptions, disable them to save a bit of code size.
 if(MSVC)
   string(REPLACE "/EHsc" "" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
@@ -193,49 +80,30 @@ else()
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-exceptions -fno-rtti")
 endif()
 
-
 # Write binaries to a seperate directory.
-if(WIN32)
-  set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/bin/${CPU_ARCH}")
-else()
-  set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/bin")
-endif()
-
-# Needed for Linux - put shared libraries in the binary directory.
-set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}")
-
-
-# Enable threads everywhere.
-set(THREADS_PREFER_PTHREAD_FLAG ON)
-find_package(Threads REQUIRED)
-
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/bin")
 
 # Enable large file support on Linux 32-bit platforms.
-# Android is deliberately ommitted here as it didn't support 64-bit ops on files until Android 7/N.
-if((LINUX OR FREEBSD) AND (CPU_ARCH_X86 OR CPU_ARCH_ARM32))
+if(CMAKE_SIZEOF_VOID_P EQUAL 4)
   add_definitions("-D_FILE_OFFSET_BITS=64")
 endif()
 
+# Optional unit tests.
 if(BUILD_TESTS)
   enable_testing()
 endif()
 
 # Prevent fmt from being built with exceptions, or being thrown at call sites.
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DFMT_EXCEPTIONS=0")
 
-# Use C++17 for building dependencies (some aren't C++20-aware, e.g. reshadefx).
-set(CMAKE_CXX_STANDARD 17)
+# Use C++20.
+set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 # Recursively include the source tree.
 include(DuckStationDependencies)
 add_subdirectory(dep)
-
-# Use C++20 for building the main libraries.
-set(CMAKE_CXX_STANDARD 20)
-set(CMAKE_CXX_STANDARD_REQUIRED ON)
 add_subdirectory(src)
 
-if(ANDROID)
-  add_subdirectory(android/app/src/cpp)
-endif()
+# Output build summary.
+include(DuckStationBuildSummary)

CMakeModules/DuckStationBuildOptions.cmake

@@ -0,0 +1,15 @@
+# Renderer options.
+option(ENABLE_OPENGL "Build with OpenGL renderer" ON)
+option(ENABLE_VULKAN "Build with Vulkan renderer" ON)
+option(BUILD_NOGUI_FRONTEND "Build the NoGUI frontend" OFF)
+option(BUILD_QT_FRONTEND "Build the Qt frontend" ON)
+option(BUILD_REGTEST "Build regression test runner" OFF)
+option(BUILD_TESTS "Build unit tests" OFF)
+
+if(LINUX OR BSD)
+  option(ENABLE_X11 "Support X11 window system" ON)
+  option(ENABLE_WAYLAND "Support Wayland window system" ON)
+endif()
+if(APPLE)
+  option(SKIP_POSTPROCESS_BUNDLE "Disable bundle post-processing, including Qt additions" OFF)
+endif()

CMakeModules/DuckStationBuildSummary.cmake

@@ -0,0 +1,45 @@
+if(ENABLE_OPENGL)
+  message(STATUS "Building with OpenGL support.")
+endif()
+if(ENABLE_VULKAN)
+  message(STATUS "Building with Vulkan support.")
+endif()
+if(ENABLE_X11)
+  message(STATUS "Building with X11 support.")
+endif()
+if(ENABLE_WAYLAND)
+  message(STATUS "Building with Wayland support.")
+endif()
+
+if(BUILD_QT_FRONTEND)
+  message(STATUS "Building Qt frontend.")
+endif()
+if(BUILD_NOGUI_FRONTEND)
+  message(STATUS "Building NoGUI frontend.")
+endif()
+if(BUILD_REGTEST)
+  message(STATUS "Building RegTest frontend.")
+endif()
+if(BUILD_TESTS)
+  message(STATUS "Building unit tests.")
+endif()
+
+if(NOT IS_SUPPORTED_COMPILER)
+  message(WARNING "
+*************** UNSUPPORTED CONFIGURATION ***************
+You are not compiling DuckStation with a supported compiler.
+It may not even build successfully.
+DuckStation only supports the Clang and MSVC compilers.
+No support will be provided, continue at your own risk.
+*********************************************************")
+endif()
+
+if(WIN32)
+  message(WARNING "
+*************** UNSUPPORTED CONFIGURATION ***************
+You are compiling DuckStation with CMake on Windows.
+It may not even build successfully.
+DuckStation only supports MSBuild on Windows.
+No support will be provided, continue at your own risk.
+*********************************************************")
+endif()