Added include sorting and ordering

UE4SS-RE · Dec 14, 2024 · ebd74b9 · ebd74b9
1 parent 4fc8691
commit ebd74b9
Show file tree

Hide file tree

Showing 137 changed files with 548 additions and 404 deletions.
diff --git a/.clang-format b/.clang-format
@@ -16,5 +16,38 @@ PenaltyBreakBeforeFirstCallParameter: 120
 PenaltyExcessCharacter: 5
 PointerAlignment: Left
 Standard: Latest
-SortIncludes: false
+SortIncludes: CaseSensitive
+# Uncomment MainIncludeChar when clang-format 19 is commonly used.
+#MainIncludeChar: "Any"
+IncludeBlocks: Regroup
+IncludeCategories:
+  # Unreal.
+  - Regex: '^<(Unreal\/)'
+    Priority: 3
+    CaseSensitive: true
+  # First-party dependencies.
+  - Regex: '^<ArgsParser|ASMHelper|Constructs|DynamicOutput|File|Function|Helpers|IniParser|Input|JSON|LuaMadeSimple|LuaRaw|MProgram|ParserBase|Profiler|ScopedTimer|SigScanner|String\/.+>'
+    Priority: 2
+    CaseSensitive: true
+  # UE4SS Project files.
+  - Regex: '^<[A-Z].+.hpp>'
+    Priority: 1
+    CaseSensitive: true
+  # C++ Standard files.
+  - Regex: '^<([^.]+)>$'
+    Priority: 97
+    CaseSensitive: true
+  # Windows.h.
+  - Regex: 'Windows.h'
+    Priority: 98
+    CaseSensitive: false
+  # Windows sub-headers.
+  - Regex: 'Psapi.h|ImageHlp.h|tchar.h|tlhelp32.h'
+    Priority: 99
+    CaseSensitive: false
+  # Everything else, and we use this to ensure Windows includes is actually at the bottom, without this it won't be.
+  # This includes third-party dependencies.
+  - Regex: '.+'
+    Priority: 96
+    CaseSensitive: false
 ...
diff --git a/UE4SS/include/ExceptionHandling.hpp b/UE4SS/include/ExceptionHandling.hpp
@@ -1,10 +1,10 @@
 #pragma once
 
-#include <stdexcept>
-
 #include <DynamicOutput/DynamicOutput.hpp>
 #include <Helpers/String.hpp>
 
+#include <stdexcept>
+
 #define UE4SS_ERROR_OUTPUTTER()                                                                                                                                \
     if (!Output::has_internal_error())                                                                                                                         \
     {                                                                                                                                                          \

diff --git a/UE4SS/include/GUI/Console.hpp b/UE4SS/include/GUI/Console.hpp
@@ -1,13 +1,14 @@
 #pragma once
 
-#include <mutex>
-#include <string>
-#include <vector>
-
 #include <DynamicOutput/OutputDevice.hpp>
+
 #include <TextEditor.h>
 #include <imgui.h>
 
+#include <mutex>
+#include <string>
+#include <vector>
+
 using namespace RC;
 
 namespace RC::GUI

diff --git a/UE4SS/include/GUI/GUI.hpp b/UE4SS/include/GUI/GUI.hpp
@@ -1,15 +1,17 @@
 #pragma once
 
-#include <functional>
-#include <memory>
-#include <thread>
-
 #include <GUI/Console.hpp>
 #include <GUI/GUITab.hpp>
 #include <GUI/LiveView.hpp>
+
 #include <Helpers/String.hpp>
+
 #include <imgui.h>
 
+#include <functional>
+#include <memory>
+#include <thread>
+
 struct ImGuiSettingsHandler;
 
 namespace RC::GUI

diff --git a/UE4SS/include/GUI/GUITab.hpp b/UE4SS/include/GUI/GUITab.hpp
@@ -1,9 +1,10 @@
 #pragma once
 
-#include <utility>
+#include <GUI/GUI.hpp>
 
 #include <File/Macros.hpp>
-#include <GUI/GUI.hpp>
+
+#include <utility>
 
 namespace RC
 {

diff --git a/UE4SS/include/GUI/ImGuiUtility.hpp b/UE4SS/include/GUI/ImGuiUtility.hpp
@@ -3,6 +3,7 @@
 #include <JSON/JSON.hpp>
 // #include <JSONParser/JSON.hpp>
 #include <JSON/Parser/Parser.hpp>
+
 #include <imgui.h>
 
 namespace RC::GUI

diff --git a/UE4SS/include/GUI/LiveView.hpp b/UE4SS/include/GUI/LiveView.hpp
@@ -1,16 +1,17 @@
 #pragma once
 
+#include <DynamicOutput/DynamicOutput.hpp>
+
+#include <Unreal/UFunctionStructs.hpp>
+#include <Unreal/UnrealFlags.hpp>
+
 #include <functional>
 #include <memory>
 #include <unordered_map>
 #include <unordered_set>
 #include <variant>
 #include <vector>
 
-#include <DynamicOutput/DynamicOutput.hpp>
-#include <Unreal/UFunctionStructs.hpp>
-#include <Unreal/UnrealFlags.hpp>
-
 namespace RC::Unreal
 {
     struct FUObjectItem;

diff --git a/UE4SS/include/GUI/LiveView/Filter/ClassNamesFilter.hpp b/UE4SS/include/GUI/LiveView/Filter/ClassNamesFilter.hpp
@@ -1,6 +1,7 @@
 #pragma once
 
 #include <GUI/LiveView/Filter/SearchFilter.hpp>
+
 #include <Unreal/UClass.hpp>
 
 namespace RC::GUI::Filter

diff --git a/UE4SS/include/GUI/LiveView/Filter/FunctionParamFlags.hpp b/UE4SS/include/GUI/LiveView/Filter/FunctionParamFlags.hpp
@@ -1,6 +1,7 @@
 #pragma once
 
 #include <GUI/LiveView/Filter/SearchFilter.hpp>
+
 #include <Unreal/FProperty.hpp>
 #include <Unreal/UFunction.hpp>
 

diff --git a/UE4SS/include/GUI/LiveView/Filter/HasProperty.hpp b/UE4SS/include/GUI/LiveView/Filter/HasProperty.hpp
@@ -1,6 +1,7 @@
 #pragma once
 
 #include <GUI/LiveView/Filter/SearchFilter.hpp>
+
 #include <Unreal/UClass.hpp>
 
 namespace RC::GUI::Filter

diff --git a/UE4SS/include/GUI/LiveView/Filter/HasPropertyType.hpp b/UE4SS/include/GUI/LiveView/Filter/HasPropertyType.hpp
@@ -1,8 +1,10 @@
 #pragma once
 
 #include <GUI/LiveView/Filter/SearchFilter.hpp>
-#include <Unreal/UClass.hpp>
+
 #include <Unreal/NameTypes.hpp>
+#include <Unreal/UClass.hpp>
+
 #include <vector>
 
 namespace RC::GUI::Filter

diff --git a/UE4SS/include/GUI/LiveView/Filter/NonInstancesOnly.hpp b/UE4SS/include/GUI/LiveView/Filter/NonInstancesOnly.hpp
@@ -1,6 +1,7 @@
 #pragma once
 
 #include <GUI/LiveView/Filter/SearchFilter.hpp>
+
 #include <Unreal/UFunction.hpp>
 
 namespace RC::GUI::Filter

diff --git a/UE4SS/include/GUI/UFunctionCallerWidget.hpp b/UE4SS/include/GUI/UFunctionCallerWidget.hpp
@@ -1,10 +1,10 @@
 #pragma once
 
+#include <GUI/SearcherWidget.hpp>
+
 #include <string>
 #include <vector>
 
-#include <GUI/SearcherWidget.hpp>
-
 namespace RC::Unreal
 {
     class UObject;

diff --git a/UE4SS/include/LuaCustomMemberFunctions.hpp b/UE4SS/include/LuaCustomMemberFunctions.hpp
@@ -1,15 +1,16 @@
 #pragma once
 
-#include <unordered_map>
-
-#include <Unreal/Core/HAL/Platform.hpp>
 #include <Unreal/Core/Containers/ScriptArray.hpp>
+#include <Unreal/Core/HAL/Platform.hpp>
 #include <Unreal/Property/FArrayProperty.hpp>
 #include <Unreal/Property/FObjectProperty.hpp>
 #include <Unreal/UObject.hpp>
 #include <Unreal/UScriptStruct.hpp>
+
 #include <lua.hpp>
 
+#include <unordered_map>
+
 namespace RC
 {
     extern std::unordered_map<Unreal::FName, Unreal::UScriptStruct*> g_script_struct_cache_map;

diff --git a/UE4SS/include/LuaLibrary.hpp b/UE4SS/include/LuaLibrary.hpp
@@ -1,10 +1,11 @@
 #pragma once
 
 #include <Common.hpp>
-#include <cstdint>
 
 #include <String/StringType.hpp>
 
+#include <cstdint>
+
 #define DefaultStructMemberData(member_name)                                                                                                                   \
     union {                                                                                                                                                    \
         const char* as_string{};                                                                                                                               \

diff --git a/UE4SS/include/LuaTests.hpp b/UE4SS/include/LuaTests.hpp
@@ -1,10 +1,10 @@
 #pragma once
 
-#include <cstdint>
-
 #include <Unreal/Core/Containers/Array.hpp>
 #include <Unreal/World.hpp>
 
+#include <cstdint>
+
 namespace RC
 {
     using namespace Unreal;

diff --git a/UE4SS/include/LuaType/LuaAActor.hpp b/UE4SS/include/LuaType/LuaAActor.hpp
@@ -1,8 +1,9 @@
 #pragma once
 
-#include <LuaMadeSimple/LuaMadeSimple.hpp>
 #include <LuaType/LuaUObject.hpp>
 
+#include <LuaMadeSimple/LuaMadeSimple.hpp>
+
 namespace RC::Unreal
 {
     class AActor;

diff --git a/UE4SS/include/LuaType/LuaCustomProperty.hpp b/UE4SS/include/LuaType/LuaCustomProperty.hpp
@@ -1,11 +1,11 @@
 #pragma once
 
+#include <String/StringType.hpp>
+
 #include <memory>
 #include <string>
 #include <vector>
 
-#include <String/StringType.hpp>
-
 namespace RC::Unreal
 {
     class UObject;

diff --git a/UE4SS/include/LuaType/LuaFName.hpp b/UE4SS/include/LuaType/LuaFName.hpp
@@ -1,6 +1,7 @@
 #pragma once
 
 #include <LuaType/LuaUObject.hpp>
+
 #include <Unreal/NameTypes.hpp>
 
 namespace RC::LuaType

diff --git a/UE4SS/include/LuaType/LuaFSoftObjectPath.hpp b/UE4SS/include/LuaType/LuaFSoftObjectPath.hpp
@@ -1,6 +1,7 @@
 #pragma once
 
 #include <LuaType/LuaUObject.hpp>
+
 #include <Unreal/Property/FSoftObjectProperty.hpp>
 
 namespace RC::LuaType

diff --git a/UE4SS/include/LuaType/LuaFText.hpp b/UE4SS/include/LuaType/LuaFText.hpp
@@ -1,8 +1,9 @@
 #pragma once
 
-#include <LuaMadeSimple/LuaMadeSimple.hpp>
 #include <LuaType/LuaUObject.hpp>
 
+#include <LuaMadeSimple/LuaMadeSimple.hpp>
+
 namespace RC::Unreal
 {
     class FText;

diff --git a/UE4SS/include/LuaType/LuaFURL.hpp b/UE4SS/include/LuaType/LuaFURL.hpp
@@ -1,6 +1,7 @@
 #pragma once
 
 #include <LuaType/LuaUObject.hpp>
+
 #include <Unreal/FURL.hpp>
 
 namespace RC::LuaType

diff --git a/UE4SS/include/LuaType/LuaTSoftClassPtr.hpp b/UE4SS/include/LuaType/LuaTSoftClassPtr.hpp
@@ -1,6 +1,7 @@
 #pragma once
 
 #include <LuaType/LuaUObject.hpp>
+
 #include <Unreal/Property/FSoftClassProperty.hpp>
 
 namespace RC::LuaType

diff --git a/UE4SS/include/LuaType/LuaUClass.hpp b/UE4SS/include/LuaType/LuaUClass.hpp
@@ -1,9 +1,10 @@
 #pragma once
 
-#include <LuaMadeSimple/LuaObject.hpp>
 #include <LuaType/LuaUObject.hpp>
 #include <LuaType/LuaUStruct.hpp>
 
+#include <LuaMadeSimple/LuaObject.hpp>
+
 namespace RC::Unreal
 {
     class UClass;

diff --git a/UE4SS/include/LuaType/LuaUFunction.hpp b/UE4SS/include/LuaType/LuaUFunction.hpp
@@ -1,9 +1,10 @@
 #pragma once
 
-#include <array>
+#include <LuaType/LuaUObject.hpp>
 
 #include <LuaMadeSimple/LuaMadeSimple.hpp>
-#include <LuaType/LuaUObject.hpp>
+
+#include <array>
 
 namespace RC::Unreal
 {

diff --git a/UE4SS/include/LuaType/LuaUInterface.hpp b/UE4SS/include/LuaType/LuaUInterface.hpp
@@ -1,9 +1,10 @@
 #pragma once
 
-#include <LuaMadeSimple/LuaObject.hpp>
 #include <LuaType/LuaUObject.hpp>
 #include <LuaType/LuaUStruct.hpp>
 
+#include <LuaMadeSimple/LuaObject.hpp>
+
 namespace RC::Unreal
 {
     class UInterface;

diff --git a/UE4SS/include/LuaType/LuaUObject.hpp b/UE4SS/include/LuaType/LuaUObject.hpp
@@ -2,15 +2,16 @@
 
 #define NOMINMAX
 
-#include <format>
-#include <functional>
+#include <Common.hpp>
+#include <LuaType/LuaCustomProperty.hpp>
 
 #include <Constructs/Generator.hpp>
 #include <DynamicOutput/DynamicOutput.hpp>
 #include <Helpers/String.hpp>
-#include <Common.hpp>
 #include <LuaMadeSimple/LuaObject.hpp>
-#include <LuaType/LuaCustomProperty.hpp>
+
+#include <format>
+#include <functional>
 #pragma warning(disable : 4005)
 #include <Unreal/FOutputDevice.hpp>
 #include <Unreal/FProperty.hpp>

diff --git a/UE4SS/include/LuaType/LuaUStruct.hpp b/UE4SS/include/LuaType/LuaUStruct.hpp
@@ -1,8 +1,9 @@
 #pragma once
 
-#include <LuaMadeSimple/LuaObject.hpp>
 #include <LuaType/LuaUObject.hpp>
 
+#include <LuaMadeSimple/LuaObject.hpp>
+
 namespace RC::Unreal
 {
     class UStruct;

diff --git a/UE4SS/include/LuaType/LuaUWorld.hpp b/UE4SS/include/LuaType/LuaUWorld.hpp
@@ -1,8 +1,9 @@
 #pragma once
 
-#include <LuaMadeSimple/LuaObject.hpp>
 #include <LuaType/LuaUObject.hpp>
 
+#include <LuaMadeSimple/LuaObject.hpp>
+
 namespace RC::Unreal
 {
     class UWorld;