✨ Specifically warn about OpenXR Toolkit

Singling out OpenXR Toolkit for now as it's the only layer I'm aware of that is explicitly unsupported and known to cause problems.

This may become more generic in the future if additional layers become unsupported.

Author: fredemmott

.clang-format

@@ -1,21 +1,20 @@
 BasedOnStyle: Google
 AlignAfterOpenBracket: AlwaysBreak
-AlignConsecutiveDeclarations: 'false'
-AlignEscapedNewlinesLeft: DontAlign
-AlignOperands: 'false'
-AlignTrailingComments: 'false'
-AllowAllParametersOfDeclarationOnNextLine: 'false'
-AllowShortBlocksOnASingleLine: 'false'
-AllowShortFunctionsOnASingleLine: false
+AlignConsecutiveDeclarations: 'None'
+AlignOperands: false
+AlignTrailingComments: false
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortBlocksOnASingleLine: 'Never'
+AllowShortFunctionsOnASingleLine: 'None'
 AllowShortIfStatementsOnASingleLine: 'false'
-AllowShortLoopsOnASingleLine: 'false'
-BinPackArguments: 'false'
-BinPackParameters: 'false'
-BreakBeforeBinaryOperators: 'true'
-ColumnLimit: '80'
-ConstructorInitializerAllOnOneLineOrOnePerLine: 'true'
-ConstructorInitializerIndentWidth: '2'
-ContinuationIndentWidth: '2'
+AllowShortLoopsOnASingleLine: false
+BinPackArguments: false
+BinPackParameters: false
+BreakBeforeBinaryOperators: true
+ColumnLimit: 80
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 2
+ContinuationIndentWidth: 2
 DeriveLineEnding: false
 DerivePointerAlignment: false
 IncludeBlocks: Regroup
@@ -46,16 +45,15 @@ IncludeCategories:
     CaseSensitive: true
   - Regex: '^<[a-z0-9_]+\.h>$'
     Priority: 43
-IndentRequires: true
-IndentWidth: '2'
+IndentWidth: 2
 LineEnding: 'LF'
-MaxEmptyLinesToKeep: '1'
+MaxEmptyLinesToKeep: 1
 PointerAlignment: Left
 ReflowComments: true
-SpaceBeforeCpp11BracedList: 'true'
-SpaceBeforeAssignmentOperators: 'true'
-SpaceBeforeRangeBasedForLoopColon: 'false'
-SpacesBeforeTrailingComments: '0'
+SpaceBeforeCpp11BracedList: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeRangeBasedForLoopColon: false
+SpacesBeforeTrailingComments: 0
 Standard: c++20
-TabWidth: '2'
+TabWidth: 2
 UseTab: Never

src/CMakeLists.txt

@@ -111,6 +111,7 @@ if(WIN32)
     linters
     PRIVATE
     linters/windows/NotADWORDLinter.cpp
+    linters/windows/OpenXRToolkitLinter.cpp
     linters/windows/OutdatedOpenKneeboardLinter.cpp
     linters/windows/ProgramFilesLinter.cpp
     linters/windows/UnsignedDllLinter.cpp

src/linters/windows/OpenXRToolkitLinter.cpp

@@ -0,0 +1,44 @@
+// Copyright 2023 Fred Emmott <[email protected]>
+// SPDX-License-Identifier: ISC
+
+#include <fmt/core.h>
+
+#include <ShlObj.h>
+
+#include "Linter.hpp"
+#include "windows/WindowsAPILayerStore.hpp"
+
+namespace FredEmmott::OpenXRLayers {
+
+class OpenXRToolkitLinter final : public Linter {
+  virtual std::vector<std::shared_ptr<LintError>> Lint(
+    const APILayerStore* store,
+    const std::vector<std::tuple<APILayer, APILayerDetails>>& layers) {
+    auto winStore = dynamic_cast<const WindowsAPILayerStore*>(store);
+    if (
+      winStore->GetRegistryBitness()
+      != WindowsAPILayerStore::RegistryBitness::Wow64_64) {
+      return {};
+    }
+
+    std::vector<std::shared_ptr<LintError>> errors;
+    for (const auto& [layer, details]: layers) {
+      if (!layer.IsEnabled()) {
+        continue;
+      }
+      if (details.mName != "XR_APILAYER_MBUCCHIA_toolkit") {
+        continue;
+      }
+      errors.push_back(std::make_shared<LintError>(
+        "OpenXR Toolkit is unsupported, and is known to cause crashes and "
+        "other issues in modern games; you should disable it if you encounter "
+        "problems.",
+        PathSet { layer.mJSONPath }));
+    }
+    return errors;
+  }
+};
+
+static OpenXRToolkitLinter gInstance;
+
+}// namespace FredEmmott::OpenXRLayers