Fix paths and aliases on mounted folders when NBL_EMBED_RESOURCES=OFF, missing return on CMountDirectoryArchive::getFile, made sure IFileArchive::m_absolutePath is preferred form and const.

devshgraphicsprogramming · devshgraphicsprogramming · commit b291f7adb4df · 2023-11-28T14:42:26.000+01:00
P.S. Also take the opportunity rename all the variables about DXC_BUILTIN into SPIRV_BUILTIN because
diff --git a/3rdparty/boost/CMakeLists.txt b/3rdparty/boost/CMakeLists.txt
@@ -3,12 +3,12 @@ set(BOOST_PREPROCESSOR_INCLUDE "${CMAKE_CURRENT_SOURCE_DIR}/superproject/libs/pr
 get_filename_component(_BOOST_PREPROCESSOR_BR_BUNDLE_SEARCH_DIRECTORY_ "${BOOST_PREPROCESSOR_INCLUDE}" ABSOLUTE)
 get_filename_component(_BOOST_PREPROCESSOR_BR_OUTPUT_DIRECTORY_SOURCE_ "${CMAKE_CURRENT_BINARY_DIR}/src" ABSOLUTE)
 get_filename_component(_BOOST_PREPROCESSOR_BR_OUTPUT_DIRECTORY_HEADER_ "${CMAKE_CURRENT_BINARY_DIR}/include" ABSOLUTE)
-set(BOOST_BUILTIN_RESOURCES_DIRECTORY_PATH "${_BOOST_PREPROCESSOR_BR_BUNDLE_SEARCH_DIRECTORY_}" CACHE INTERNAL "" FORCE)
+set(BOOST_BUILTIN_RESOURCES_DIRECTORY_PATH "${_BOOST_PREPROCESSOR_BR_BUNDLE_SEARCH_DIRECTORY_}/boost" CACHE INTERNAL "" FORCE)
 
 if(NBL_EMBED_BUILTIN_RESOURCES)
 	include("${NBL_ROOT_PATH}/src/nbl/builtin/utils.cmake")
 	
-	file(GLOB_RECURSE BOOST_HEADERS_REC_REL RELATIVE "${BOOST_PREPROCESSOR_INCLUDE}/boost" "${BOOST_PREPROCESSOR_INCLUDE}/*")
+	file(GLOB_RECURSE BOOST_HEADERS_REC_REL RELATIVE "${BOOST_BUILTIN_RESOURCES_DIRECTORY_PATH}" "${BOOST_PREPROCESSOR_INCLUDE}/*")
 	
 	foreach(BOOST_HEADER_REL IN LISTS BOOST_HEADERS_REC_REL)
 		LIST_BUILTIN_RESOURCE(BOOST_RESOURCES_TO_EMBED "${BOOST_HEADER_REL}")
diff --git a/3rdparty/dxc/CMakeLists.txt b/3rdparty/dxc/CMakeLists.txt
@@ -54,6 +54,7 @@ endif()
 
 # perform DXC compile standard requirement test
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
+# TODO: Don't they support a higher standard now, like 17 ?
 set(CMAKE_CXX_STANDARD 11) # compiler must support exactly c++11 or c++14 standard in order to be able to build DXC libraries
 
 try_compile(DXC_COMPILE_TEST_PASSED
@@ -166,7 +167,7 @@ CACHE INTERNAL "" FORCE)
 get_filename_component(_SPIRV_BR_BUNDLE_SEARCH_DIRECTORY_ "${DXC_SPIRV_HEADERS_DIR}/include" ABSOLUTE)
 get_filename_component(_SPIRV_BR_OUTPUT_DIRECTORY_SOURCE_ "${CMAKE_CURRENT_BINARY_DIR}/src" ABSOLUTE)
 get_filename_component(_SPIRV_BR_OUTPUT_DIRECTORY_HEADER_ "${CMAKE_CURRENT_BINARY_DIR}/include" ABSOLUTE)
-set(DXC_BUILTIN_RESOURCES_DIRECTORY_PATH "${_SPIRV_BR_BUNDLE_SEARCH_DIRECTORY_}" CACHE INTERNAL "" FORCE)
+set(SPIRV_BUILTIN_RESOURCES_DIRECTORY_PATH "${_SPIRV_BR_BUNDLE_SEARCH_DIRECTORY_}/spirv" CACHE INTERNAL "" FORCE)
 
 if(NBL_EMBED_BUILTIN_RESOURCES)
 	include("${NBL_ROOT_PATH}/src/nbl/builtin/utils.cmake")
@@ -175,6 +176,6 @@ if(NBL_EMBED_BUILTIN_RESOURCES)
     LIST_BUILTIN_RESOURCE(SPIRV_RESOURCES_TO_EMBED "unified1/spirv.h")
     LIST_BUILTIN_RESOURCE(SPIRV_RESOURCES_TO_EMBED "unified1/spirv.hpp")
 
-    ADD_CUSTOM_BUILTIN_RESOURCES(dxcBuiltinResourceData SPIRV_RESOURCES_TO_EMBED "${_SPIRV_BR_BUNDLE_SEARCH_DIRECTORY_}" "spirv" "spirv::builtin" "${_SPIRV_BR_OUTPUT_DIRECTORY_HEADER_}" "${_SPIRV_BR_OUTPUT_DIRECTORY_SOURCE_}" "STATIC" "INTERNAL")
+    ADD_CUSTOM_BUILTIN_RESOURCES(spirvBuiltinResourceData SPIRV_RESOURCES_TO_EMBED "${_SPIRV_BR_BUNDLE_SEARCH_DIRECTORY_}" "spirv" "spirv::builtin" "${_SPIRV_BR_OUTPUT_DIRECTORY_HEADER_}" "${_SPIRV_BR_OUTPUT_DIRECTORY_SOURCE_}" "STATIC" "INTERNAL")
 endif()
 
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -65,7 +65,7 @@ endif()
 get_filename_component(NBL_ROOT_PATH "${CMAKE_CURRENT_SOURCE_DIR}" ABSOLUTE)
 get_filename_component(NBL_ROOT_PATH_BINARY "${CMAKE_CURRENT_BINARY_DIR}" ABSOLUTE)
 get_filename_component(NBL_PYTHON_MODULE_ROOT_PATH "${CMAKE_CURRENT_SOURCE_DIR}/tests" ABSOLUTE)
-set(NBL_BUILTIN_RESOURCES_DIRECTORY_PATH "${NBL_ROOT_PATH}/include")
+set(NBL_BUILTIN_RESOURCES_DIRECTORY_PATH "${NBL_ROOT_PATH}/include/nbl/builtin")
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${NBL_ROOT_PATH}/cmake" CACHE PATH "")
 
 # Configure CCache if available
diff --git a/examples_tests b/examples_tests
@@ -1 +1 @@
-Subproject commit d9888e117781b1e25a33d8c94d22fe34ed66ac5e
+Subproject commit 224ecb27368d417bcb667a74e55c3227a6e19711
diff --git a/include/nbl/config/BuildConfigOptions.h.in b/include/nbl/config/BuildConfigOptions.h.in
@@ -83,7 +83,7 @@
 #endif
 
 #define NBL_BUILTIN_RESOURCES_DIRECTORY_PATH "@NBL_BUILTIN_RESOURCES_DIRECTORY_PATH@"
-#define DXC_BUILTIN_RESOURCES_DIRECTORY_PATH "@DXC_BUILTIN_RESOURCES_DIRECTORY_PATH@"
+#define SPIRV_BUILTIN_RESOURCES_DIRECTORY_PATH "@SPIRV_BUILTIN_RESOURCES_DIRECTORY_PATH@"
 #define BOOST_BUILTIN_RESOURCES_DIRECTORY_PATH "@BOOST_BUILTIN_RESOURCES_DIRECTORY_PATH@"
 
 // DDL exports
diff --git a/include/nbl/system/CMountDirectoryArchive.h b/include/nbl/system/CMountDirectoryArchive.h
@@ -11,49 +11,51 @@ namespace nbl::system
 
 class CMountDirectoryArchive : public IFileArchive
 {
-    ISystem* m_system;
+        ISystem* m_system;
 
-public:
-    inline CMountDirectoryArchive(path&& _defaultAbsolutePath, system::logger_opt_smart_ptr&& logger, ISystem* system) :
-        IFileArchive(std::move(_defaultAbsolutePath), std::move(logger))
-    {
-        m_system = system;
-    }
-
-    core::smart_refctd_ptr<IFile> getFile(const path& pathRelativeToArchive, const std::string_view& password) override
-    {
+    public:
+        inline CMountDirectoryArchive(path&& _defaultAbsolutePath, system::logger_opt_smart_ptr&& logger, ISystem* system) :
+            IFileArchive(std::move(_defaultAbsolutePath), std::move(logger))
         {
-            //std::unique_lock(itemMutex); already inside `getItemFromPath`
-            if (!getItemFromPath(pathRelativeToArchive))
-                return nullptr;
+            m_system = system;
         }
-        system::ISystem::future_t<core::smart_refctd_ptr<system::IFile>> future;
-        m_system->createFile(future, m_defaultAbsolutePath / pathRelativeToArchive, system::IFile::ECF_READ);
-        if (auto file = future.acquire())
-            return *file;
-    }
 
- 
-    SFileList listAssets() const override {
-        auto items = m_system->listItemsInDirectory(m_defaultAbsolutePath);
-        auto new_entries = std::make_shared<core::vector<SFileList::SEntry>>();
-        for (auto item : items)
+        core::smart_refctd_ptr<IFile> getFile(const path& pathRelativeToArchive, const std::string_view& password) override
         {
-            if (item.has_extension())
             {
-                auto relpath = item.lexically_relative(m_defaultAbsolutePath);
-                auto entry = SFileList::SEntry{ relpath, 0xdeadbeefu, 0xdeadbeefu, 0xdeadbeefu, EAT_NONE };
-                new_entries->push_back(entry);
+                //std::unique_lock(itemMutex); already inside `getItemFromPath`
+                if (!getItemFromPath(pathRelativeToArchive))
+                    return nullptr;
             }
+            system::ISystem::future_t<core::smart_refctd_ptr<system::IFile>> future;
+            m_system->createFile(future, m_defaultAbsolutePath / pathRelativeToArchive, system::IFile::ECF_READ);
+            if (auto file = future.acquire())
+                return *file;
+
+            return nullptr;
         }
-        setItemList(new_entries);
 
-        return IFileArchive::listAssets();
-    }
+ 
+        SFileList listAssets() const override {
+            auto items = m_system->listItemsInDirectory(m_defaultAbsolutePath);
+            auto new_entries = std::make_shared<core::vector<SFileList::SEntry>>();
+            for (auto item : items)
+            {
+                if (item.has_extension())
+                {
+                    auto relpath = item.lexically_relative(m_defaultAbsolutePath);
+                    auto entry = SFileList::SEntry{ relpath, 0xdeadbeefu, 0xdeadbeefu, 0xdeadbeefu, EAT_NONE };
+                    new_entries->push_back(entry);
+                }
+            }
+            setItemList(new_entries);
+
+            return IFileArchive::listAssets();
+        }
 
-    void populateItemList(const path& p) const {
-       
-    }
+        void populateItemList(const path& p) const
+        {   
+        }
 };
 
 } //namespace nbl::system
diff --git a/include/nbl/system/IFileArchive.h b/include/nbl/system/IFileArchive.h
@@ -100,19 +100,21 @@ class NBL_API2 IFileArchive : public core::IReferenceCounted
 
 	protected:
 		IFileArchive(path&& _defaultAbsolutePath, system::logger_opt_smart_ptr&& logger) :
-			m_defaultAbsolutePath(std::move(_defaultAbsolutePath)), m_logger(std::move(logger)) {}
+			m_defaultAbsolutePath(std::move(_defaultAbsolutePath.make_preferred())), m_logger(std::move(logger))
+		{
+		}
 
 		inline const SFileList::SEntry* getItemFromPath(const system::path& pathRelativeToArchive) const
 		{
             const  SFileList::SEntry itemToFind = { pathRelativeToArchive };
 			auto items = m_items.load();
 			const auto found = std::lower_bound(items->begin(), items->end(),itemToFind);
-			if (found== items->end() || found->pathRelativeToArchive != pathRelativeToArchive)
+			if (found==items->end() || found->pathRelativeToArchive != pathRelativeToArchive)
 				return nullptr;
 			return &(*found);
 		}
 
-		path m_defaultAbsolutePath;
+		const path m_defaultAbsolutePath;
 		// files and directories
 		//
 		system::logger_opt_smart_ptr m_logger;
diff --git a/src/nbl/CMakeLists.txt b/src/nbl/CMakeLists.txt
@@ -537,7 +537,7 @@ if(_NBL_COMPILE_WITH_GLI_)
 	target_include_directories(Nabla PUBLIC ${THIRD_PARTY_SOURCE_DIR}/gli)
 endif()
 
-# DXC
+# DXC (TODO: nah, lets remove/disable it)
 if(_NBL_ENABLE_DXC_COMPILE_TESTS_)
 	add_dependencies(Nabla HLSL_NABLA_COMPILE_TEST)
 endif()
@@ -610,19 +610,19 @@ endif()
 
 if(NBL_EMBED_BUILTIN_RESOURCES)
 	get_target_property(_NABLA_INCLUDE_DIRECTORIES_ Nabla INCLUDE_DIRECTORIES)
-	get_target_property(_DXC_BR_OUTPUT_INCLUDE_SEARCH_DIRECTORY_ dxcBuiltinResourceData BUILTIN_RESOURCES_INCLUDE_SEARCH_DIRECTORY)
+	get_target_property(_SPIRV_BR_OUTPUT_INCLUDE_SEARCH_DIRECTORY_ spirvBuiltinResourceData BUILTIN_RESOURCES_INCLUDE_SEARCH_DIRECTORY)
 	get_target_property(_BOOST_BR_OUTPUT_INCLUDE_SEARCH_DIRECTORY_ boostBuiltinResourceData BUILTIN_RESOURCES_INCLUDE_SEARCH_DIRECTORY)
 	
-	target_include_directories(dxcBuiltinResourceData PUBLIC "${_NABLA_INCLUDE_DIRECTORIES_}") # the reason behind the patch is because this internal BR target gets created before Nabla
+	target_include_directories(spirvBuiltinResourceData PUBLIC "${_NABLA_INCLUDE_DIRECTORIES_}") # the reason behind the patch is because this internal BR target gets created before Nabla
 	target_include_directories(boostBuiltinResourceData PUBLIC "${_NABLA_INCLUDE_DIRECTORIES_}") # the reason behind the patch is because this internal BR target gets created before Nabla
 	
 	target_include_directories(Nabla PUBLIC 
-		"${_DXC_BR_OUTPUT_INCLUDE_SEARCH_DIRECTORY_}"
+		"${_SPIRV_BR_OUTPUT_INCLUDE_SEARCH_DIRECTORY_}"
 		"${_BOOST_BR_OUTPUT_INCLUDE_SEARCH_DIRECTORY_}"
 	)
 	
 	add_subdirectory(builtin)
-	add_dependencies(Nabla nblBuiltinResourceData dxcBuiltinResourceData boostBuiltinResourceData)
+	add_dependencies(Nabla nblBuiltinResourceData spirvBuiltinResourceData boostBuiltinResourceData)
 	
 	if(NBL_STATIC_BUILD)
 		set(_NBL_LINK_QUALIFIER_ INTERFACE)
@@ -632,7 +632,7 @@ if(NBL_EMBED_BUILTIN_RESOURCES)
 	
 	target_link_libraries(Nabla ${_NBL_LINK_QUALIFIER_}
 		nblBuiltinResourceData
-		dxcBuiltinResourceData
+		spirvBuiltinResourceData
 		boostBuiltinResourceData
 	)
 	
@@ -693,7 +693,7 @@ nbl_install_config_header(BuildConfigOptions.h)
 
 if(NBL_EMBED_BUILTIN_RESOURCES)
 	nbl_install_builtin_resources(nblBuiltinResourceData)
-	nbl_install_builtin_resources(dxcBuiltinResourceData)
+	nbl_install_builtin_resources(spirvBuiltinResourceData)
 	nbl_install_builtin_resources(boostBuiltinResourceData)
 endif()
 
diff --git a/src/nbl/system/ISystem.cpp b/src/nbl/system/ISystem.cpp
@@ -26,7 +26,7 @@ ISystem::ISystem(core::smart_refctd_ptr<ISystem::ICaller>&& caller) : m_dispatch
     #else
     // TODO: absolute default entry paths? we should do something with it
     mount(core::make_smart_refctd_ptr<nbl::system::CMountDirectoryArchive>(NBL_BUILTIN_RESOURCES_DIRECTORY_PATH, nullptr, this), "nbl/builtin");
-    mount(core::make_smart_refctd_ptr<nbl::system::CMountDirectoryArchive>(DXC_BUILTIN_RESOURCES_DIRECTORY_PATH, nullptr, this), "dxc");
+    mount(core::make_smart_refctd_ptr<nbl::system::CMountDirectoryArchive>(SPIRV_BUILTIN_RESOURCES_DIRECTORY_PATH, nullptr, this), "spirv");
     mount(core::make_smart_refctd_ptr<nbl::system::CMountDirectoryArchive>(BOOST_BUILTIN_RESOURCES_DIRECTORY_PATH, nullptr, this), "boost");
     #endif
 }

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ ISystem::ISystem(core::smart_refctd_ptr<ISystem::ICaller>&& caller) : m_dispatch`
`26`	`26`	`#else`
`27`	`27`	`// TODO: absolute default entry paths? we should do something with it`
`28`	`28`	`mount(core::make_smart_refctd_ptr<nbl::system::CMountDirectoryArchive>(NBL_BUILTIN_RESOURCES_DIRECTORY_PATH, nullptr, this), "nbl/builtin");`
`29`		`- mount(core::make_smart_refctd_ptr<nbl::system::CMountDirectoryArchive>(DXC_BUILTIN_RESOURCES_DIRECTORY_PATH, nullptr, this), "dxc");`
	`29`	`+ mount(core::make_smart_refctd_ptr<nbl::system::CMountDirectoryArchive>(SPIRV_BUILTIN_RESOURCES_DIRECTORY_PATH, nullptr, this), "spirv");`
`30`	`30`	`mount(core::make_smart_refctd_ptr<nbl::system::CMountDirectoryArchive>(BOOST_BUILTIN_RESOURCES_DIRECTORY_PATH, nullptr, this), "boost");`
`31`	`31`	`#endif`
`32`	`32`	`}`