move UI extension headers into appropriate place, allow to go with mounted directory

Author: AnastaZIuk

src/nbl/ext/ImGui/shaders/common.hlsl renamed to include/nbl/ext/ImGui/builtin/hlsl/common.hlsl

@@ -23,18 +23,23 @@ nbl_create_ext_library_project(
 
 target_link_libraries(${LIB_NAME} PUBLIC imtestengine)
 
-# (*) -> I wish we could just take NSC, offline-precompile to SPIRV, embed into builtin resource library (as we did!) but then be smart & adjust at runtime OpDecorate of our resources according to wishes - unfortunately no linker yet we have and we are not going to make one ourselves so we compile imgui shaders at runtime
-set(_BR_TARGET_ extImguibuiltinResourceData)
-set(_RESOURCE_DIR_ "shaders")
-
-get_filename_component(_SEARCH_DIRECTORIES_ "${CMAKE_CURRENT_SOURCE_DIR}" ABSOLUTE)
+# this should be standard for all extensions
+get_filename_component(_ARCHIVE_ABSOLUTE_ENTRY_PATH_ "${NBL_EXT_INTERNAL_INCLUDE_DIR}/nbl/ext" ABSOLUTE)
 get_filename_component(_OUTPUT_DIRECTORY_SOURCE_ "${CMAKE_CURRENT_BINARY_DIR}/src" ABSOLUTE)
 get_filename_component(_OUTPUT_DIRECTORY_HEADER_ "${CMAKE_CURRENT_BINARY_DIR}/include" ABSOLUTE)
+set(_ARCHIVE_ENTRY_KEY_ "ImGui/builtin/hlsl") # then each one has unique archive key
+
+target_compile_definitions(${LIB_NAME} PRIVATE _ARCHIVE_ABSOLUTE_ENTRY_PATH_="${_ARCHIVE_ABSOLUTE_ENTRY_PATH_}")
+
+if(NBL_EMBED_BUILTIN_RESOURCES)
+	# (*) -> I wish we could just take NSC, offline-precompile to SPIRV, embed into builtin resource library (as we did!) but then be smart & adjust at runtime OpDecorate of our resources according to wishes - unfortunately no linker yet we have and we are not going to make one ourselves so we compile imgui shaders at runtime
+	set(_BR_TARGET_ extImguibuiltinResourceData)
 
-LIST_BUILTIN_RESOURCE(RESOURCES_TO_EMBED "common.hlsl")
-LIST_BUILTIN_RESOURCE(RESOURCES_TO_EMBED "psinput.hlsl")
-LIST_BUILTIN_RESOURCE(RESOURCES_TO_EMBED "vertex.hlsl") # (*) -> this we could precompile [no resources for which set/binding Ixs could be adjusted] but I'm not going to mix stuff
-LIST_BUILTIN_RESOURCE(RESOURCES_TO_EMBED "fragment.hlsl") # (*) -> but this we could not since we let users to provide external descriptor set layout + ImGUI textures & sampler state set/binding Ixs (for pipeline layout) at runtime
+	LIST_BUILTIN_RESOURCE(RESOURCES_TO_EMBED "common.hlsl")
+	LIST_BUILTIN_RESOURCE(RESOURCES_TO_EMBED "psinput.hlsl")
+	LIST_BUILTIN_RESOURCE(RESOURCES_TO_EMBED "vertex.hlsl") # (*) -> this we could precompile [no resources for which set/binding Ixs could be adjusted] but I'm not going to mix stuff
+	LIST_BUILTIN_RESOURCE(RESOURCES_TO_EMBED "fragment.hlsl") # (*) -> but this we could not since we let users to provide external descriptor set layout + ImGUI textures & sampler state set/binding Ixs (for pipeline layout) at runtime
 
-ADD_CUSTOM_BUILTIN_RESOURCES(${_BR_TARGET_} RESOURCES_TO_EMBED "${_SEARCH_DIRECTORIES_}" "${_RESOURCE_DIR_}" "nbl::ext::imgui::builtin" "${_OUTPUT_DIRECTORY_HEADER_}" "${_OUTPUT_DIRECTORY_SOURCE_}")
-LINK_BUILTIN_RESOURCES_TO_TARGET(${LIB_NAME} ${_BR_TARGET_})
+	ADD_CUSTOM_BUILTIN_RESOURCES(${_BR_TARGET_} RESOURCES_TO_EMBED "${_ARCHIVE_ABSOLUTE_ENTRY_PATH_}" "${_ARCHIVE_ENTRY_KEY_}" "nbl::ext::imgui::builtin" "${_OUTPUT_DIRECTORY_HEADER_}" "${_OUTPUT_DIRECTORY_SOURCE_}")
+	LINK_BUILTIN_RESOURCES_TO_TARGET(${LIB_NAME} ${_BR_TARGET_})
+endif()

src/nbl/ext/ImGui/shaders/fragment.hlsl renamed to include/nbl/ext/ImGui/builtin/hlsl/fragment.hlsl

@@ -8,7 +8,7 @@
 
 #include "nbl/system/CStdoutLogger.h"
 #include "nbl/ext/ImGui/ImGui.h"
-#include "shaders/common.hlsl"
+#include "nbl/ext/ImGui/builtin/hlsl/common.hlsl"
 #include "nbl/ext/ImGui/builtin/builtinResources.h"
 #include "nbl/ext/ImGui/builtin/CArchive.h"
 #include "imgui/imgui.h"
@@ -112,15 +112,27 @@ smart_refctd_ptr<IGPUPipelineLayout> UI::createDefaultPipelineLayout(ILogicalDev
 	return device->createPipelineLayout(PushConstantRanges, std::move(layouts[0u]), std::move(layouts[1u]), std::move(layouts[2u]), std::move(layouts[3u]));
 }
 
+// note we use archive entry explicitly for temporary compiler include search path & asset cwd to use keys directly
+constexpr std::string_view NBL_ARCHIVE_ENTRY = nbl::ext::imgui::builtin::pathPrefix;
+
 const smart_refctd_ptr<IFileArchive> UI::mount(smart_refctd_ptr<ILogger> logger, ISystem* system, const std::string_view archiveAlias)
 {
 	assert(system);
 
 	if(!system)
 		return nullptr;
 
+	// extension should mount everything for you, regardless if content goes from virtual filesystem 
+	// or disk directly - and you should never rely on application framework to expose extension data
+
+	#ifdef NBL_EMBED_BUILTIN_RESOURCES
 	auto archive = make_smart_refctd_ptr<builtin::CArchive>(smart_refctd_ptr(logger));
 	system->mount(smart_refctd_ptr(archive), archiveAlias.data());
+	#else
+	auto NBL_EXTENSION_MOUNT_DIRECTORY_ENTRY = (path(_ARCHIVE_ABSOLUTE_ENTRY_PATH_) / NBL_ARCHIVE_ENTRY).make_preferred();
+	auto archive = make_smart_refctd_ptr<nbl::system::CMountDirectoryArchive>(std::move(NBL_EXTENSION_MOUNT_DIRECTORY_ENTRY), smart_refctd_ptr(logger), system);
+	system->mount(smart_refctd_ptr(archive), NBL_ARCHIVE_ENTRY);
+	#endif
 
 	return smart_refctd_ptr(archive);
 }
@@ -140,23 +152,21 @@ core::smart_refctd_ptr<video::IGPUGraphicsPipeline> UI::createPipeline(SCreation
 		smart_refctd_ptr<IGPUShader> vertex, fragment;
 	} shaders;
 
-	{
-		constexpr std::string_view NBL_ARCHIVE_ALIAS = "nbl/ext/imgui/shaders";
-				
+	{		
 		//! proxy the system, we will touch it gently
 		auto system = smart_refctd_ptr<ISystem>(creationParams.assetManager->getSystem());
 
 		auto* set = creationParams.assetManager->getCompilerSet();
 		auto compiler = set->getShaderCompiler(IShader::E_CONTENT_TYPE::ECT_HLSL);
 		auto includeFinder = make_smart_refctd_ptr<IShaderCompiler::CIncludeFinder>(smart_refctd_ptr(system));
 		auto includeLoader = includeFinder->getDefaultFileSystemLoader();
-		includeFinder->addSearchPath(NBL_ARCHIVE_ALIAS.data(), includeLoader);
+		includeFinder->addSearchPath(NBL_ARCHIVE_ENTRY.data(), includeLoader);
 
 		auto createShader = [&]<StringLiteral key, IShader::E_SHADER_STAGE stage>() -> smart_refctd_ptr<IGPUShader>
 		{
 			IAssetLoader::SAssetLoadParams params = {};
 			params.logger = creationParams.utilities->getLogger();
-			params.workingDirectory = NBL_ARCHIVE_ALIAS.data();
+			params.workingDirectory = NBL_ARCHIVE_ENTRY.data();
 
 			auto bundle = creationParams.assetManager->getAsset(key.value, params);
 			const auto assets = bundle.getContents();
@@ -250,11 +260,12 @@ core::smart_refctd_ptr<video::IGPUGraphicsPipeline> UI::createPipeline(SCreation
 			return nullptr;
 		}
 
-		//! but we should never assume user will mount our internal archive since its the extension and not user's job to do it, hence we mount ourselves temporary archive to compile our extension sources then unmount it
-		auto archive = mount(smart_refctd_ptr<ILogger>(creationParams.utilities->getLogger()), system.get(), NBL_ARCHIVE_ALIAS.data());
+		//! but we should never assume user will mount our internal data since its the extension and not user's job to do it so we do to compile our extension sources
+		if(!system->isDirectory(path(NBL_ARCHIVE_ENTRY.data())))
+			mount(smart_refctd_ptr<ILogger>(creationParams.utilities->getLogger()), system.get());
+
 		shaders.vertex = createShader.template operator() < NBL_CORE_UNIQUE_STRING_LITERAL_TYPE("vertex.hlsl"), IShader::E_SHADER_STAGE::ESS_VERTEX > ();
 		shaders.fragment = createShader.template operator() < NBL_CORE_UNIQUE_STRING_LITERAL_TYPE("fragment.hlsl"), IShader::E_SHADER_STAGE::ESS_FRAGMENT > ();
-		system->unmount(archive.get(), NBL_ARCHIVE_ALIAS.data());
 
 		if (!shaders.vertex)
 		{