fix: mirror tool qt framework headers build issue on macOS

Author: FlyAndNotDown

CMake/Target.cmake

@@ -238,7 +238,7 @@ function(exp_get_target_include_dirs_recurse)
 endfunction()
 
 function(exp_add_mirror_info_source_generation_target)
-    cmake_parse_arguments(PARAMS "DYNAMIC" "NAME;OUTPUT_SRC;OUTPUT_TARGET_NAME" "SEARCH_DIR;PUBLIC_INC;PRIVATE_INC;LIB" ${ARGN})
+    cmake_parse_arguments(PARAMS "DYNAMIC" "NAME;OUTPUT_SRC;OUTPUT_TARGET_NAME" "SEARCH_DIR;PUBLIC_INC;PRIVATE_INC;LIB;FRAMEWORK_DIR" ${ARGN})
 
     if (DEFINED PARAMS_PUBLIC_INC)
         list(APPEND INC ${PARAMS_PUBLIC_INC})
@@ -262,10 +262,20 @@ function(exp_add_mirror_info_source_generation_target)
     list(APPEND INC_ARGS "-I")
     foreach (I ${INC})
         get_filename_component(ABSOLUTE_I ${I} ABSOLUTE)
-        list(APPEND ABSOLUTE_INC ${ABSOLUTE_I})
         list(APPEND INC_ARGS ${ABSOLUTE_I})
     endforeach()
 
+    if (DEFINED PARAMS_FRAMEWORK_DIR)
+        list(APPEND FWK_DIR ${PARAMS_FRAMEWORK_DIR})
+        list(APPEND FWK_DIR_ARGS "-F")
+    endif ()
+    list(REMOVE_DUPLICATES FWK_DIR)
+
+    foreach (F ${FWK_DIR})
+        get_filename_component(ABSOLUTE_F ${F} ABSOLUTE)
+        list(APPEND FWK_DIR_ARGS ${ABSOLUTE_F})
+    endforeach ()
+
     if (${PARAMS_DYNAMIC})
         list(APPEND DYNAMIC_ARG "-d")
     endif ()
@@ -282,7 +292,7 @@ function(exp_add_mirror_info_source_generation_target)
 
             add_custom_command(
                 OUTPUT ${OUTPUT_SOURCE}
-                COMMAND "$<TARGET_FILE:MirrorTool>" ${DYNAMIC_ARG} "-i" ${INPUT_HEADER_FILE} "-o" ${OUTPUT_SOURCE} ${INC_ARGS}
+                COMMAND "$<TARGET_FILE:MirrorTool>" ${DYNAMIC_ARG} "-i" ${INPUT_HEADER_FILE} "-o" ${OUTPUT_SOURCE} ${INC_ARGS} ${FWK_DIR_ARGS}
                 DEPENDS MirrorTool ${INPUT_HEADER_FILE}
             )
         endforeach()

Editor/CMakeLists.txt

@@ -10,6 +10,7 @@ qt_standard_project_setup(REQUIRES ${QT_VERSION})
 if (${CMAKE_SYSTEM_NAME} STREQUAL "Darwin")
     set(PLATFORM_EXECUTABLE_HINT MACOSX_BUNDLE)
     set(BUNDLE_INSTALL_DESTINATION BUNDLE DESTINATION ${CMAKE_INSTALL_PREFIX}/Engine/Binaries)
+    set(PLATFORM_FRAMEWORK_DIR ${QT_LIB_PREFIX}/lib)
 endif ()
 
 set(EDITOR_INCLUDES Include)
@@ -28,6 +29,7 @@ exp_add_mirror_info_source_generation_target(
     SEARCH_DIR Include
     PRIVATE_INC ${EDITOR_INCLUDES}
     LIB ${EDITOR_LIBS}
+    FRAMEWORK_DIR ${PLATFORM_FRAMEWORK_DIR}
 )
 
 file(GLOB_RECURSE SOURCES Src/*.cpp)

Tool/MirrorTool/ExeSrc/Main.cpp

@@ -31,12 +31,14 @@ int main(int argc, char* argv[]) // NOLINT
     std::string inputFile;
     std::string outputFile;
     std::vector<std::string> headerDirs;
+    std::vector<std::string> frameworkDirs;
     bool dynamic = false;
 
     if (const auto cli = (
             clipp::required("-i").doc("input header file") & clipp::value("input header file", inputFile),
             clipp::required("-o").doc("output file") & clipp::value("output file", outputFile),
             clipp::option("-I").doc("header search dirs") & clipp::values("header search dirs", headerDirs),
+            clipp::option("-F").doc("framework search dirs") & clipp::values("framework search dirs", frameworkDirs),
             clipp::option("-d").set(dynamic).doc("used for dynamic library (auto unload some metas)"));
         !clipp::parse(argc, argv, cli)) {
         std::cout << clipp::make_man_page(cli, argv[0]);
@@ -58,7 +60,7 @@ int main(int argc, char* argv[]) // NOLINT
         return 1;
     }
 
-    MirrorTool::Parser parser(inputFile, headerDirs);
+    MirrorTool::Parser parser(inputFile, headerDirs, frameworkDirs);
     auto [parseSuccess, parseResultOrError] = parser.Parse();
 
     if (!parseSuccess) {

Tool/MirrorTool/Include/MirrorTool/Parser.h

@@ -94,7 +94,7 @@ namespace MirrorTool {
         using Result = std::pair<bool, std::variant<std::string, MetaInfo>>;
 
         NonCopyable(Parser)
-        explicit Parser(std::string inSourceFile, std::vector<std::string> inHeaderDirs);
+        explicit Parser(std::string inSourceFile, std::vector<std::string> inHeaderDirs, std::vector<std::string> inFrameworkDirs);
         ~Parser();
 
         Result Parse() const;
@@ -105,5 +105,6 @@ namespace MirrorTool {
 
         std::string sourceFile;
         std::vector<std::string> headerDirs;
+        std::vector<std::string> frameworkDirs;
     };
 }

Tool/MirrorTool/Src/Parser.cpp

@@ -413,7 +413,10 @@ namespace MirrorTool {
 }
 
 namespace MirrorTool {
-    Parser::Parser(std::string inSourceFile, std::vector<std::string> inHeaderDirs) : sourceFile(std::move(inSourceFile)), headerDirs(std::move(inHeaderDirs))
+    Parser::Parser(std::string inSourceFile, std::vector<std::string> inHeaderDirs, std::vector<std::string> inFrameworkDirs)
+        : sourceFile(std::move(inSourceFile))
+        , headerDirs(std::move(inHeaderDirs))
+        , frameworkDirs(std::move(inFrameworkDirs))
     {
     }
 
@@ -451,6 +454,12 @@ namespace MirrorTool {
         for (const std::string& headerDir : headerDirs) {
             argumentStrs.emplace_back(std::string("-I") + headerDir);
         }
+#if PLATFORM_MACOS
+        for (const std::string& frameworkDir : frameworkDirs) {
+            argumentStrs.emplace_back("-iframework");
+            argumentStrs.emplace_back(frameworkDir);
+        }
+#endif
 
         std::vector<const char*> arguments(argumentStrs.size());
         for (auto i = 0; i < arguments.size(); i++) {

Tool/MirrorTool/Test/Main.cpp

@@ -120,7 +120,7 @@ void AssertNamespaceInfoEqual(const NamespaceInfo& lhs, const NamespaceInfo& rhs
 
 TEST(MirrorTest, ParserTest)
 {
-    const Parser parser("../Test/Resource/Mirror/MirrorToolInput.h", { "../Test/Resource/Mirror" });
+    const Parser parser("../Test/Resource/Mirror/MirrorToolInput.h", { "../Test/Resource/Mirror" }, {});
     auto [parseSuccess, parseResultOrError] = parser.Parse();
     ASSERT_TRUE(parseSuccess);
 
@@ -160,7 +160,7 @@ TEST(MirrorTest, ParserTest)
 
 TEST(MirrorTest, GeneratorTest)
 {
-    const Parser parser("../Test/Resource/Mirror/MirrorToolInput.h", { "../Test/Resource/Mirror" });
+    const Parser parser("../Test/Resource/Mirror/MirrorToolInput.h", { "../Test/Resource/Mirror" }, {});
     auto [parseSuccess, parseResultOrError] = parser.Parse();
     ASSERT_TRUE(parseSuccess);