🚚 Clean up boilerplate for executables

- separate cmake file for each target
- add cmake options for each target
- loader queries are now a separate executable, rather than special arguments for each executable
  - this is both cleaner, and opens the path to supporting loader queries for 32-bit too

Author: fredemmott

src/CMakeLists.txt

@@ -1,8 +1,8 @@
 # Copyright 2023 Fred Emmott <[email protected]>
 # SPDX-License-Identifier: ISC
 
-find_package(imgui CONFIG REQUIRED)
 find_package(nlohmann_json CONFIG REQUIRED)
+find_package(imgui CONFIG REQUIRED)
 find_package(OpenXR CONFIG REQUIRED)
 # Using fmt instead of fmt::format until MacOS/libc++ catch up
 find_package(fmt CONFIG REQUIRED)
@@ -25,198 +25,22 @@ configure_file(
   "${CODEGEN_BUILD_DIR}/Config.hpp"
   @ONLY
 )
+add_library(config-hpp INTERFACE "${CODEGEN_BUILD_DIR}/Config.hpp")
+target_include_directories(config-hpp INTERFACE "${CODEGEN_BUILD_DIR}")
 
-add_library(
-  lib
-  STATIC
-  APILayerDetails.cpp
-  APILayerSignature.hpp
-  ConstexprString.hpp
-  GUI.cpp
-  LoaderData.cpp LoaderData.hpp
-  SaveReport.cpp
-  Platform.cpp Platform.hpp
-  StringTemplateParameter.hpp
-)
-
-# Using an OBJECT library instead of `STATIC`, because otherwise
-# Microsoft's linker gets rid of the static initializers used to register linters :(
-add_library(
-  linters
-  OBJECT
-  Linter.cpp
-  LayerRules.cpp
-  linters/BadInstallationLinter.cpp
-  linters/DuplicatesLinter.cpp
-  linters/OrderingLinter.cpp
-  linters/DisabledByEnvironmentLinter.cpp
-  linters/SkippedByLoaderLinter.cpp
-)
-target_link_libraries(linters PUBLIC lib)
-target_include_directories(
-  lib
-  PUBLIC
-  "${CODEGEN_BUILD_DIR}"
-  "${CMAKE_CURRENT_SOURCE_DIR}"
-)
-
-target_link_libraries(
-  lib
-  PUBLIC
-  nlohmann_json::nlohmann_json
-  fmt::fmt-header-only
-  imgui::imgui
-  OpenXR::headers OpenXR::openxr_loader
-)
-
-add_executable(
-  gui
-  WIN32
-  "${CMAKE_SOURCE_DIR}/icon/icon.rc"
-)
-
-# Used by version.in.rc
-set(OUTPUT_NAME "OpenXR-API-Layers-GUI")
-set_target_properties(
-  gui
-  PROPERTIES
-  OUTPUT_NAME "${OUTPUT_NAME}"
-)
-target_link_libraries(gui PRIVATE lib linters)
-
-set(PLATFORM_APILAYERS_CPP "stubs/APILayerStore.cpp")
-set(PLATFORM_MAIN_CPP "main.cpp")
-set(PLATFORM_GUI_CPP "stubs/PlatformGUI.cpp")
-set(PLATFORM_REPORT_MAIN_CPP "SaveReport_main.cpp")
-
-if (WIN32)
-  set(PLATFORM_APILAYERS_CPP "windows/WindowsAPILayerStore.cpp")
-  set(PLATFORM_GUI_CPP "windows/WindowsPlatform.cpp")
-  set(PLATFORM_MAIN_CPP "windows/wWinMain.cpp")
-  set(PLATFORM_REPORT_MAIN_CPP "windows/SaveReport_wWinMain.cpp")
-
-  configure_file(
-    "${CMAKE_CURRENT_SOURCE_DIR}/version.in.rc"
-    "${CODEGEN_BUILD_DIR}/gui-version.rc"
-    @ONLY
-  )
-
-  target_sources(
-    lib
-    PRIVATE
-    windows/CheckForUpdates.cpp
-    windows/WindowsPlatform.hpp
-  )
-
-  target_sources(
-    linters
-    PRIVATE
-    linters/windows/NotADWORDLinter.cpp
-    linters/windows/OpenXRToolkitLinter.cpp
-    linters/windows/OutdatedOpenKneeboardLinter.cpp
-    linters/windows/ProgramFilesLinter.cpp
-    linters/windows/UnsignedDllLinter.cpp
-    linters/windows/XRNeckSaferLinter.cpp
-  )
-
-  target_sources(
-    gui
-    PRIVATE
-    "${CODEGEN_BUILD_DIR}/gui-version.rc"
-    manifest.xml
-  )
-
-  target_compile_definitions(
-    lib
-    PUBLIC
-    "WIN32_LEAN_AND_MEAN"
-    "NOMINMAX"
-    "UNICODE"
-    "_UNICODE"
-  )
-
-  target_compile_options(
-    lib
-    PUBLIC
-    "/EHsc"
-    "/diagnostics:caret"
-    "/utf-8"
-  )
-
-  target_link_libraries(
-    lib
-    PUBLIC
-    WIL::WIL
-  )
-  set(
-    WINDOWS_SDK_LIBRARIES
-    Comctl32
-    D3d11
-    DwmApi
-    Dxgi
-    RuntimeObject
-    Crypt32
-    WinTrust
-  )
-  foreach (NAME IN LISTS WINDOWS_SDK_LIBRARIES)
-    set(LIB_PATH_VAR "${NAME}_PATH}")
-    find_library("${LIB_PATH_VAR}" NAMES "${NAME}" REQUIRED)
-    target_link_libraries(lib PUBLIC "${${LIB_PATH_VAR}}")
-  endforeach ()
-
-  target_link_options(
-    gui
-    PRIVATE
-    "/MANIFESTUAC:level='requireAdministrator'"
-  )
+option(BUILD_EXECUTABLES "Build executables" ON)
 
+option(BUILD_GUI "Build the GUI" "${BUILD_EXECUTABLES}")
+if (BUILD_GUI)
+  include(gui.cmake)
 endif ()
 
-target_sources(
-  lib
-  PRIVATE
-  "${PLATFORM_APILAYERS_CPP}"
-  "${PLATFORM_GUI_CPP}"
-)
-target_sources(
-  gui
-  PRIVATE
-  "${PLATFORM_MAIN_CPP}"
-)
-
-set(OUTPUT_NAME "OpenXR-API-Layers-Create-Report")
-configure_file(
-  "${CMAKE_CURRENT_SOURCE_DIR}/version.in.rc"
-  "${CODEGEN_BUILD_DIR}/create-report-version.rc"
-  @ONLY
-)
-add_executable(
-  create-report
-  WIN32
-  "${PLATFORM_REPORT_MAIN_CPP}"
-  "${CMAKE_SOURCE_DIR}/icon/icon.rc"
-  "${CODEGEN_BUILD_DIR}/create-report-version.rc"
-)
-target_link_libraries(
-  create-report
-  PRIVATE
-  lib
-  linters
-)
-set_target_properties(
-  create-report
-  PROPERTIES
-  OUTPUT_NAME "${OUTPUT_NAME}"
-)
-
-if (WIN32)
-  set(UPDATER_FILENAME "fredemmott_OpenXR-API-Layers-GUI_Updater.exe")
-  add_custom_command(
-    TARGET gui POST_BUILD
-    COMMAND
-    "${CMAKE_COMMAND}" -E copy_if_different
-    "${UPDATER_EXE}"
-    "$<TARGET_FILE_DIR:gui>/${UPDATER_FILENAME}"
-    VERBATIM
-  )
+option(BUILD_CREATE_REPORT "Build the Create-Report executable" "${BUILD_EXECUTABLES}")
+if (BUILD_CREATE_REPORT)
+  include(create-report.cmake)
 endif ()
+
+option(BUILD_LOADER_DATA "Build the loader-data executable" "${BUILD_EXECUTABLES}")
+if (BUILD_LOADER_DATA)
+  include(loader-data.cmake)
+endif ()

src/LoaderData.cpp

@@ -14,39 +14,6 @@
 
 namespace FredEmmott::OpenXRLayers {
 
-LoaderData QueryLoaderDataInCurrentProcess() {
-  LoaderData ret {
-    .mEnvironmentVariablesBeforeLoader
-    = Platform::Get().GetEnvironmentVariableNames(),
-  };
-
-  // We don't care about the extensions, but enumerating them can load the
-  // runtime DLL, which can call `setenv()` and change the rest
-  uint32_t propertyCount {};
-  ret.mQueryExtensionsResult = xrEnumerateInstanceExtensionProperties(
-    nullptr, 0, &propertyCount, nullptr);
-
-  uint32_t layerCount {};
-  ret.mQueryLayersResult
-    = xrEnumerateApiLayerProperties(0, &layerCount, nullptr);
-  ret.mEnvironmentVariablesAfterLoader
-    = Platform::Get().GetEnvironmentVariableNames();
-  if (XR_FAILED(ret.mQueryLayersResult)) {
-    return ret;
-  }
-
-  std::vector<XrApiLayerProperties> layers(
-    layerCount, {XR_TYPE_API_LAYER_PROPERTIES});
-  ret.mQueryLayersResult
-    = xrEnumerateApiLayerProperties(layerCount, &layerCount, layers.data());
-
-  for (auto&& layer: layers) {
-    ret.mEnabledLayerNames.emplace(layer.layerName);
-  }
-
-  return ret;
-}
-
 void to_json(nlohmann::json& j, const LoaderData& data) {
   j.update(
     nlohmann::json {
@@ -74,11 +41,4 @@ void from_json(const nlohmann::json& j, LoaderData& data) {
     .get_to(data.mEnvironmentVariablesAfterLoader);
 }
 
-void LoaderMain() {
-  const auto data = QueryLoaderDataInCurrentProcess();
-  const nlohmann::json json(data);
-
-  std::cout << std::setw(2) << json << std::endl;
-}
-
 }// namespace FredEmmott::OpenXRLayers

src/LoaderData.hpp

@@ -52,6 +52,4 @@ struct LoaderData {
 void from_json(const nlohmann::json&, LoaderData&);
 void to_json(nlohmann::json&, const LoaderData&);
 
-void LoaderMain();
-
 }// namespace FredEmmott::OpenXRLayers

src/LoaderDataMain.cpp

@@ -0,0 +1,54 @@
+// Copyright 2025 Fred Emmott <[email protected]>
+// SPDX-License-Identifier: MIT
+#include "LoaderDataMain.hpp"
+
+#include <nlohmann/json.hpp>
+
+#include <iostream>
+
+#include "LoaderData.hpp"
+#include "Platform.hpp"
+
+namespace FredEmmott::OpenXRLayers {
+
+static LoaderData QueryLoaderDataInCurrentProcess() {
+  LoaderData ret {
+    .mEnvironmentVariablesBeforeLoader
+    = Platform::Get().GetEnvironmentVariableNames(),
+  };
+
+  // We don't care about the extensions, but enumerating them can load the
+  // runtime DLL, which can call `setenv()` and change the rest
+  uint32_t propertyCount {};
+  ret.mQueryExtensionsResult = xrEnumerateInstanceExtensionProperties(
+    nullptr, 0, &propertyCount, nullptr);
+
+  uint32_t layerCount {};
+  ret.mQueryLayersResult
+    = xrEnumerateApiLayerProperties(0, &layerCount, nullptr);
+  ret.mEnvironmentVariablesAfterLoader
+    = Platform::Get().GetEnvironmentVariableNames();
+  if (XR_FAILED(ret.mQueryLayersResult)) {
+    return ret;
+  }
+
+  std::vector<XrApiLayerProperties> layers(
+    layerCount, {XR_TYPE_API_LAYER_PROPERTIES});
+  ret.mQueryLayersResult
+    = xrEnumerateApiLayerProperties(layerCount, &layerCount, layers.data());
+
+  for (auto&& layer: layers) {
+    ret.mEnabledLayerNames.emplace(layer.layerName);
+  }
+
+  return ret;
+}
+
+void LoaderDataMain() {
+  const auto data = QueryLoaderDataInCurrentProcess();
+  const nlohmann::json json(data);
+
+  std::cout << std::setw(2) << json << std::endl;
+}
+
+}// namespace FredEmmott::OpenXRLayers

src/LoaderDataMain.hpp

@@ -0,0 +1,7 @@
+// Copyright 2025 Fred Emmott <[email protected]>
+// SPDX-License-Identifier: MIT
+#pragma once
+
+namespace FredEmmott::OpenXRLayers {
+void LoaderDataMain();
+}

src/create-report.cmake

@@ -0,0 +1,32 @@
+include(lib.cmake)
+
+add_executable(create-report WIN32)
+
+target_link_libraries(
+  create-report
+  PRIVATE
+  lib
+  linters
+)
+
+set(OUTPUT_NAME "OpenXR-API-Layers-Create-Report")
+set_target_properties(
+  create-report
+  PROPERTIES
+  OUTPUT_NAME "${OUTPUT_NAME}"
+)
+configure_file(
+  "${CMAKE_CURRENT_SOURCE_DIR}/version.in.rc"
+  "${CODEGEN_BUILD_DIR}/create-report-version.rc"
+  @ONLY
+)
+
+if (WIN32)
+  target_sources(
+    create-report
+    PRIVATE
+    "${CMAKE_SOURCE_DIR}/icon/icon.rc"
+    windows/wWinMain-create-report.cpp
+    "${CODEGEN_BUILD_DIR}/create-report-version.rc"
+  )
+endif ()