Unity update for beatsaber-hook

.github/workflows/build-ndk.yml

@@ -71,7 +71,7 @@ jobs:
         uses: actions/upload-artifact@v2
         with:
           name: debug_${{ steps.libname.outputs.NAME }}
-          path: ./build/debug_${{ steps.libname.outputs.NAME }}
+          path: ./build/debug/${{ steps.libname.outputs.NAME }}
           if-no-files-found: error
 
     # TODO: Add auto-populating releases, auto update versions, auto publish package on release

.github/workflows/publish.yml

@@ -78,6 +78,6 @@ jobs:
           tag_name: ${{ github.event.inputs.version }}
           files: |
             ./build/${{ steps.libname.outputs.NAME }}
-            ./build/debug_${{ steps.libname.outputs.NAME }}
+            ./build/debug/${{ steps.libname.outputs.NAME }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CMakeLists.txt

@@ -9,6 +9,7 @@ set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED 20)
 # LTO
 set(CMAKE_INTERPROCEDURAL_OPTIMIZATION TRUE)
+set(CMAKE_EXPORT_COMPILE_COMMANDS TRUE)
 
 # define that stores the actual source directory
 set(SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/src)
@@ -22,65 +23,106 @@ add_compile_definitions(VERSION=\"${MOD_VERSION}\")
 add_compile_definitions(MOD_ID=\"${MOD_ID}\")
 add_compile_definitions(VERSION_NUMBER=300150000)
 add_compile_definitions(UNITY_2019)
+add_compile_definitions(UNITY_2021)
 
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
-if (DEFINED TEST_BUILD)
-    MESSAGE(STATUS "Compiling with test defines")
-    add_compile_definitions(TEST_CALLBACKS)
-    add_compile_definitions(TEST_SAFEPTR)
-    add_compile_definitions(TEST_BYREF)
-    add_compile_definitions(TEST_ARRAY)
-    add_compile_definitions(TEST_LIST)
-    add_compile_definitions(TEST_STRING)
-    add_compile_definitions(TEST_HOOK)
-endif()
-
-add_library(
-    ${COMPILE_ID} 
-    SHARED 
+function(setup_target target add_test)
+    message(STATUS "Setting up target ${target}")
+
+    add_library(
+        ${target}
+        SHARED
+    )
+
+    if (add_test)
+        target_compile_definitions(
+            ${target}
+            PRIVATE
+
+            TEST_CALLBACKS
+            TEST_SAFEPTR
+            TEST_BYREF
+            TEST_ARRAY
+            TEST_LIST
+            TEST_STRING
+            TEST_HOOK
+        )
+    endif()
+
+    # recursively get all src files
+    RECURSE_FILES(cpp_file_list_utils ${SOURCE_DIR}/utils/*.cpp)
+    RECURSE_FILES(c_file_list_utils ${SOURCE_DIR}/utils/*.c)
+    target_sources(${target} PRIVATE ${cpp_file_list_utils})
+    target_sources(${target} PRIVATE ${c_file_list_utils})
+
+    RECURSE_FILES(cpp_file_list_config ${SOURCE_DIR}/config/*.cpp)
+    RECURSE_FILES(c_file_list_config ${SOURCE_DIR}/config/*.c)
+    target_sources(${target} PRIVATE ${cpp_file_list_config})
+    target_sources(${target} PRIVATE ${c_file_list_config})
+
+    if (add_test)
+        message(STATUS "Adding tests source files to target ${target}")
+        RECURSE_FILES(cpp_file_list_tests ${SOURCE_DIR}/tests/*.cpp)
+        RECURSE_FILES(c_file_list_tests ${SOURCE_DIR}/tests/*.c)
+        target_sources(${target} PRIVATE ${cpp_file_list_tests})
+        target_sources(${target} PRIVATE ${c_file_list_tests})
+    endif()
+
+    # add root dir as include dir
+    target_include_directories(${target} PRIVATE ${CMAKE_SOURCE_DIR})
+    # add src dir as include dir
+    target_include_directories(${target} PRIVATE ${SOURCE_DIR})
+    # add include dir as include dir
+    target_include_directories(${target} PRIVATE ${INCLUDE_DIR})
+    # add shared dir as include dir
+    target_include_directories(${target} PUBLIC ${SHARED_DIR})
+
+    target_link_directories(${target} PRIVATE ${EXTERN_DIR}/libs)
+    target_link_libraries(${target} PRIVATE -llog)
+    target_link_options(${target} PRIVATE "-fuse-ld=ld")
+
+    file(GLOB_RECURSE so_libs ${EXTERN_DIR}/libs/*.so)
+    file(GLOB_RECURSE a_libs ${EXTERN_DIR}/libs/*.a)
+
+    target_link_libraries(
+        ${target}
+        PRIVATE
+        ${so_libs}
+        ${a_libs}
+    )
+
+    target_include_directories(${target} PRIVATE ${EXTERN_DIR}/includes)
+    target_include_directories(${target} SYSTEM PRIVATE ${EXTERN_DIR}/includes/libil2cpp/il2cpp/libil2cpp)
+endfunction()
+
+# compile test as one project
+setup_target(test-${COMPILE_ID} YES)
+# regular bs hook
+setup_target(${COMPILE_ID} NO)
+
+add_dependencies(${COMPILE_ID} test-${COMPILE_ID})
+
+target_compile_definitions(
+    ${COMPILE_ID}
+    PRIVATE
+    NO_TEST
 )
 
-# recursively get all src files
-RECURSE_FILES(cpp_file_list_utils ${SOURCE_DIR}/utils/*.cpp)
-RECURSE_FILES(c_file_list_utils ${SOURCE_DIR}/utils/*.c)
-target_sources(${COMPILE_ID} PRIVATE ${cpp_file_list_utils})
-target_sources(${COMPILE_ID} PRIVATE ${c_file_list_utils})
-
-RECURSE_FILES(cpp_file_list_config ${SOURCE_DIR}/config/*.cpp)
-RECURSE_FILES(c_file_list_config ${SOURCE_DIR}/config/*.c)
-target_sources(${COMPILE_ID} PRIVATE ${cpp_file_list_config})
-target_sources(${COMPILE_ID} PRIVATE ${c_file_list_config})
-
-if (DEFINED TEST_BUILD)
-RECURSE_FILES(cpp_file_list_tests ${SOURCE_DIR}/tests/*.cpp)
-RECURSE_FILES(c_file_list_tests ${SOURCE_DIR}/tests/*.c)
-target_sources(${COMPILE_ID} PRIVATE ${cpp_file_list_tests})
-target_sources(${COMPILE_ID} PRIVATE ${c_file_list_tests})
-endif()
-
-# add root dir as include dir
-target_include_directories(${COMPILE_ID} PRIVATE ${CMAKE_SOURCE_DIR})
-# add src dir as include dir
-target_include_directories(${COMPILE_ID} PRIVATE ${SOURCE_DIR})
-# add include dir as include dir
-target_include_directories(${COMPILE_ID} PRIVATE ${INCLUDE_DIR})
-# add shared dir as include dir
-target_include_directories(${COMPILE_ID} PUBLIC ${SHARED_DIR})
-
-target_link_libraries(${COMPILE_ID} PRIVATE -llog)
-target_link_options(${COMPILE_ID} PRIVATE "-fuse-ld=ld")
-
-# add extern stuff like libs and other includes
-include(extern.cmake)
+# make bs hook build depend on the build of bs hook tests
+# add_dependencies(${COMPILE_ID} ${COMPILE_ID}-test)
 
 add_custom_command(TARGET ${COMPILE_ID} POST_BUILD
             COMMAND ${CMAKE_STRIP} -g -S -d --strip-all
             "lib${COMPILE_ID}.so" -o "stripped_lib${COMPILE_ID}.so"
             COMMENT "Strip debug symbols done on final binary.")
 
 add_custom_command(TARGET ${COMPILE_ID} POST_BUILD
-            COMMAND ${CMAKE_COMMAND} -E rename lib${COMPILE_ID}.so debug_lib${COMPILE_ID}.so
+            COMMAND ${CMAKE_COMMAND} -E make_directory debug
+            COMMENT "Create the debug dir"
+)
+add_custom_command(TARGET ${COMPILE_ID} POST_BUILD
+            COMMAND ${CMAKE_COMMAND} -E rename lib${COMPILE_ID}.so debug/lib${COMPILE_ID}.so
             COMMENT "Rename the lib to debug_ since it has debug symbols"
             )
 

build.ps1

@@ -1,3 +1,7 @@
+param (
+    [Parameter(Mandatory=$false)]
+    [Switch] $clean
+)
 
 function Clean-Build-Folder {
     if (Test-Path -Path "build")
@@ -9,28 +13,14 @@ function Clean-Build-Folder {
     }
 }
 
-$NDKPath = Get-Content $PSScriptRoot/ndkpath.txt
-
-Clean-Build-Folder
-
-& cmake -G "Ninja" -DCMAKE_BUILD_TYPE="RelWithDebInfo" -DTEST_BUILD=1 . -B build
-& cmake --build ./build
-
-$ExitCode = $LastExitCode
-
-if (-not ($ExitCode -eq 0)) {
-    $msg = "ExitCode: " + $ExitCode
-    Write-Output $msg
-    exit $ExitCode
+if ($clean.IsPresent) {
+    Clean-Build-Folder
 }
 
-# clean folder
-Clean-Build-Folder
 # build mod
-
 & cmake -G "Ninja" -DCMAKE_BUILD_TYPE="RelWithDebInfo" . -B build
 & cmake --build ./build
 
 $ExitCode = $LastExitCode
 
-exit $ExitCode
+exit $ExitCode

qpm.json

@@ -20,7 +20,7 @@
     },
     {
       "id": "libil2cpp",
-      "versionRange": ">=0.1.2, <0.3.0",
+      "versionRange": "^0.3.0",
       "additionalData": {}
     },
     {

qpm.shared.json

@@ -21,7 +21,7 @@
       },
       {
         "id": "libil2cpp",
-        "versionRange": ">=0.1.2, <0.3.0",
+        "versionRange": "^0.3.0",
         "additionalData": {}
       },
       {
@@ -44,12 +44,12 @@
     {
       "dependency": {
         "id": "libil2cpp",
-        "versionRange": "=0.2.3",
+        "versionRange": "=0.3.1",
         "additionalData": {
           "headersOnly": true
         }
       },
-      "version": "0.2.3"
+      "version": "0.3.1"
     },
     {
       "dependency": {

shared/utils/base-wrapper-type.hpp

@@ -3,16 +3,7 @@
 #include <concepts>
 #include <cstdint>
 #include "il2cpp-type-check.hpp"
-
-namespace il2cpp_utils {
-    template<class T>
-    /// @brief A concept depicting if a type is a wrapper type.
-    // TODO: Make this use a static creation method instead of a constructor
-    concept has_il2cpp_conversion = requires (T t) {
-        {t.convert()} -> std::same_as<void*>;
-        std::is_constructible_v<T, void*>;
-    };
-}
+#include "type-concepts.hpp"
 
 namespace bs_hook {
     /// @brief Represents the most basic wrapper type.
@@ -28,6 +19,7 @@ namespace bs_hook {
             return const_cast<void*>(instance);
         }
 
+        Il2CppObject* operator ->() const noexcept { return const_cast<Il2CppObject*>(static_cast<Il2CppObject const*>(instance)); }
         operator Il2CppObject*() const noexcept { return const_cast<Il2CppObject*>(static_cast<Il2CppObject const*>(instance)); }
 
         protected:

shared/utils/byref.hpp

@@ -1,5 +1,6 @@
 #pragma once
 #include "il2cpp-type-check.hpp"
+#include "type-concepts.hpp"
 
 /// @brief Represents a byref parameter.
 /// This is REQUIRED for codegen invokes, as RunMethodThrow can't tell the difference between a reference parameter and a byref on constexpr time.
@@ -33,6 +34,7 @@ struct ByRef {
     }
     static_assert(sizeof(T*) == sizeof(void*));
 };
+MARK_GEN_REF_T(ByRef);
 
 // Type specializations for byref specifics
 // We do not need il2cpp_no_arg_class specialization for ByRef, since it will never get to that point.
@@ -56,4 +58,4 @@ struct ::il2cpp_utils::il2cpp_type_check::il2cpp_arg_type<ByRef<T>> {
 };
 
 // Creates a ByRef type to wrap a reference
-#define byref(...) (ByRef(__VA_ARGS__))
+#define byref(...) (ByRef(__VA_ARGS__))

shared/utils/enum-wrapper-type.hpp

@@ -0,0 +1,35 @@
+#pragma once
+
+#include "value-wrapper-type.hpp"
+
+namespace bs_hook {
+    // 0 special case, but otherwise the size should be an actual amount of bytes it could be
+    template<std::size_t sz>
+    requires(sz == 0x0 || sz == 0x1 || sz == 0x2 || sz == 0x4 || sz == 0x8)
+    struct EnumTypeWrapper : public ValueTypeWrapper<sz> {
+        static constexpr auto VALUE_TYPE_SIZE = ValueTypeWrapper<sz>::VALUE_TYPE_SIZE;
+        using ValueTypeWrapper<sz>::ValueTypeWrapper;
+
+        constexpr EnumTypeWrapper() = default;
+        ~EnumTypeWrapper() = default;
+
+        constexpr EnumTypeWrapper(EnumTypeWrapper&&) = default;
+        constexpr EnumTypeWrapper(EnumTypeWrapper const&) = default;
+
+        constexpr EnumTypeWrapper& operator=(EnumTypeWrapper&&) = default;
+        constexpr EnumTypeWrapper& operator=(EnumTypeWrapper const&) = default;
+    };
+
+    /// @brief struct to pass a pointer to an enum into a method
+    struct EnumPtr : public VTPtr {
+        template<std::size_t sz>
+        EnumPtr(EnumTypeWrapper<sz>& e) : VTPtr(e) {};
+
+        explicit EnumPtr(void* i) : VTPtr(i) {};
+    };
+}
+
+template<std::size_t sz>
+struct ::il2cpp_utils::ValueTypeTrait<::bs_hook::EnumTypeWrapper<sz>> {
+    constexpr static bool value = true;
+};

shared/utils/hooking.hpp

@@ -454,7 +454,7 @@ struct Hook_##name_ { \
     using funcType = retval (*)(__VA_ARGS__); \
     static_assert(std::is_same_v<funcType, ::Hooking::InternalMethodCheck<decltype(mPtr)>::funcType>, "Hook method signature does not match!"); \
     constexpr static const char* name() { return #name_; } \
-    static const MethodInfo* getInfo() { return ::il2cpp_utils::il2cpp_type_check::MetadataGetter<mPtr>::get(); } \
+    static const MethodInfo* getInfo() { return ::il2cpp_utils::il2cpp_type_check::MetadataGetter<mPtr>::methodInfo(); } \
     static funcType* trampoline() { return &name_; } \
     static inline retval (*name_)(__VA_ARGS__) = nullptr; \
     static funcType hook() { return &::Hooking::HookCatchWrapper<&hook_##name_, funcType>::wrapper; } \
@@ -469,7 +469,7 @@ struct Hook_##name_ { \
     using funcType = retval (*)(__VA_ARGS__); \
     static_assert(std::is_same_v<funcType, ::Hooking::InternalMethodCheck<decltype(mPtr)>::funcType>, "Hook method signature does not match!"); \
     constexpr static const char* name() { return #name_; } \
-    static const MethodInfo* getInfo() { return ::il2cpp_utils::il2cpp_type_check::MetadataGetter<mPtr>::get(); } \
+    static const MethodInfo* getInfo() { return ::il2cpp_utils::il2cpp_type_check::MetadataGetter<mPtr>::methodInfo(); } \
     static funcType* trampoline() { return &name_; } \
     static inline retval (*name_)(__VA_ARGS__) = nullptr; \
     static funcType hook() { return hook_##name_; } \
@@ -542,7 +542,7 @@ struct Hook_##name_ { \
     using funcType = decltype(&::Hooking::HookWrapperCompose<&hook_##name_>::wrapper); \
     /* static_assert(std::is_same_v<funcType, ::Hooking::InternalMethodCheck<decltype(mPtr)>::funcType>, "Hook method signature does not match!"); */ \
     constexpr static const char* name() { return #name_; } \
-    static const MethodInfo* getInfo() { return ::il2cpp_utils::il2cpp_type_check::MetadataGetter<mPtr>::get(); } \
+    static const MethodInfo* getInfo() { return ::il2cpp_utils::il2cpp_type_check::MetadataGetter<mPtr>::methodInfo(); } \
     static funcType* trampoline() { return &orig_base; } \
     static inline funcType orig_base = nullptr; \
     template<class... TArgs> \
@@ -691,4 +691,4 @@ void InstallHookDirect(L& logger, void* dst) {
 
 // TODO: Not yet implemented
 #define UNINSTALL_HOOK_DIRECT(logger, name, addr) void
-}
+}