Split archive into header CArchive.h and source CArchive.cpp files, have it compiled with one single builtin resources library. Rename BR_API to NBL_BR_API. Move creation of nblBuiltinResourceData, have Nabla created first to be capable of using it's properties. Target source builtin files with PRIVATE qualifier to Nabla target. Perform tests

Author: AnastaZIuk

src/nbl/CMakeLists.txt

@@ -114,10 +114,6 @@ endif()
 
 nbl_get_conf_dir(NABLA_CONF_DIR_DEBUG Debug)
 nbl_get_conf_dir(NABLA_CONF_DIR_RELEASE Release)
-if(NBL_EMBED_BUILTIN_RESOURCES)	
-	add_subdirectory(builtin)
-	NBL_ADD_BUILTIN_RESOURCES(nblBuiltinResourceData) # internal, must be added with the macro to properly propagate scope
-endif()
 nbl_get_conf_dir(NABLA_CONF_DIR_RELWITHDEBINFO RelWithDebInfo)
 
 if (NBL_COMPILE_WITH_CUDA)
@@ -360,25 +356,11 @@ set(COMMON_INCLUDE_DIRS
 file(GLOB_RECURSE NABLA_HEADERS_PRIV1 "*.h")
 file(GLOB_RECURSE NABLA_HEADERS_PRIV2 "${NBL_ROOT_PATH}/src/nbl/*.h")
 
-#always install builtins (some may be included in cpp regardless if embedded or not)
-
-get_target_property(_BUILTIN_RESOURCES_BUNDLE_ARCHIVE_ABSOLUTE_PATH_ nblBuiltinResourceData BUILTIN_RESOURCES_BUNDLE_ARCHIVE_ABSOLUTE_PATH)
-foreach(X IN LISTS NBL_RESOURCES_TO_EMBED)
-	list(APPEND NABLA_RESOURCES_TO_EMBED_PUBLIC "${NBL_ROOT_PATH}/include/${_BUILTIN_RESOURCES_BUNDLE_ARCHIVE_ABSOLUTE_PATH_}/${X}")
-endforeach()
-list(APPEND NABLA_HEADERS_PUBLIC ${NABLA_RESOURCES_TO_EMBED_PUBLIC})
-source_group("Resources to embed" FILES ${NABLA_RESOURCES_TO_EMBED_PUBLIC})
-set_source_files_properties(${NABLA_RESOURCES_TO_EMBED_PUBLIC}
-                            PROPERTIES HEADER_FILE_ONLY TRUE)
-
 set(NABLA_HEADERS "${NBL_ROOT_PATH}/include/nabla.h" ${NABLA_HEADERS_PUBLIC} ${NABLA_HEADERS_PIRV1} ${NABLA_HEADERS_PRIV2})
 
-get_target_property(_BUILTIN_RESOURCES_HEADER_DIRECTORY_ nblBuiltinResourceData BUILTIN_RESOURCES_HEADER_DIRECTORY)
-
 set(NBL_LIBRARY_CREATION_SOURCES 
 	${NABLA_SRCS_COMMON}
 	${NABLA_HEADERS}
-	${_BUILTIN_RESOURCES_HEADER_DIRECTORY_}
 	$<TARGET_OBJECTS:aesGladman>
 	$<TARGET_OBJECTS:bzip2>
 	$<TARGET_OBJECTS:lz4>
@@ -426,20 +408,6 @@ if(NOT NBL_STATIC_BUILD)
 	set_target_properties(Nabla PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${NBL_ASSEMBLY_DIRECTORY})
 endif()
 
-if(NBL_EMBED_BUILTIN_RESOURCES)
-	add_dependencies(Nabla nblBuiltinResourceData)
-	
-	if(NBL_STATIC_BUILD)
-		target_link_libraries(Nabla INTERFACE
-			nblBuiltinResourceData
-		)
-	else()
-		target_link_libraries(Nabla PRIVATE 
-			nblBuiltinResourceData
-		)
-	endif()
-endif()
-
 ## Set up 3rdparty deps
 # Parallel Hashmap
 target_include_directories(Nabla PUBLIC ${THIRD_PARTY_SOURCE_DIR}/parallel-hashmap/parallel_hashmap)
@@ -626,6 +594,36 @@ target_compile_definitions(Nabla
 	INTERFACE _NBL_PCH_IGNORE_PRIVATE_HEADERS
 )
 
+if(NBL_EMBED_BUILTIN_RESOURCES)
+	add_subdirectory(builtin)
+	NBL_ADD_BUILTIN_RESOURCES(nblBuiltinResourceData) # internal, must be added with the macro to properly propagate scope
+	add_dependencies(Nabla nblBuiltinResourceData)
+	
+	if(NBL_STATIC_BUILD)
+		target_link_libraries(Nabla INTERFACE
+			nblBuiltinResourceData
+		)
+	else()
+		target_link_libraries(Nabla PRIVATE 
+			nblBuiltinResourceData
+		)
+	endif()
+	
+	# always install builtins (some may be included in cpp regardless if embedded or not)
+	get_target_property(_BUILTIN_RESOURCES_BUNDLE_ARCHIVE_ABSOLUTE_PATH_ nblBuiltinResourceData BUILTIN_RESOURCES_BUNDLE_ARCHIVE_ABSOLUTE_PATH)
+	foreach(X IN LISTS NBL_RESOURCES_TO_EMBED)
+		list(APPEND NABLA_RESOURCES_TO_EMBED_PUBLIC "${NBL_ROOT_PATH}/include/${_BUILTIN_RESOURCES_BUNDLE_ARCHIVE_ABSOLUTE_PATH_}/${X}")
+	endforeach()
+	
+	target_sources(Nabla PRIVATE 
+		${NABLA_RESOURCES_TO_EMBED_PUBLIC}
+	)
+	
+	list(APPEND NABLA_HEADERS_PUBLIC ${NABLA_RESOURCES_TO_EMBED_PUBLIC})
+	source_group("Resources to embed" FILES ${NABLA_RESOURCES_TO_EMBED_PUBLIC})
+	set_source_files_properties(${NABLA_RESOURCES_TO_EMBED_PUBLIC} PROPERTIES HEADER_FILE_ONLY TRUE)
+endif()
+
 # generate Nabla definitions to a header
 glue_source_definitions(Nabla _NBL_SOURCE_DEFINITIONS_)
 set(_NBL_DEFINE_FILE_WRAPPER_ ${CMAKE_CURRENT_BINARY_DIR}/include/define.h)

src/nbl/builtin/builtinHeaderGen.py

@@ -37,22 +37,22 @@
     if isSharedLibrary:   
         outp.write("#if defined(__NBL_BUILDING_TARGET__) // currently compiling the target, this define is passed through the commandline\n")
         outp.write("#if defined(_MSC_VER)\n")
-        outp.write("#define BR_API __declspec(dllexport)\n")
+        outp.write("#define NBL_BR_API __declspec(dllexport)\n")
         outp.write("#elif defined(__GNUC__)\n")
-        outp.write('#define BR_API __attribute__ ((visibility ("default")))' + "\n")
+        outp.write('#define NBL_BR_API __attribute__ ((visibility ("default")))' + "\n")
         outp.write("#endif\n")
         outp.write("#else\n")
         outp.write("#if defined(_MSC_VER)\n")
-        outp.write("#define BR_API __declspec(dllimport)\n")
+        outp.write("#define NBL_BR_API __declspec(dllimport)\n")
         outp.write("#else\n")
-        outp.write("#define BR_API\n")
+        outp.write("#define NBL_BR_API\n")
         outp.write("#endif\n")
         outp.write("#endif\n\n")
 
     outp.write("namespace " + resourcesNamespace + " { \n")
 
     if isSharedLibrary:
-        outp.write("\t\tBR_API std::pair<const uint8_t*, size_t> get_resource_runtime(const std::string& filename);\n\n")
+        outp.write("\t\tNBL_BR_API std::pair<const uint8_t*, size_t> get_resource_runtime(const std::string& filename);\n\n")
     else:
         outp.write("\t\tstd::pair<const uint8_t*, size_t> get_resource_runtime(const std::string& filename);\n\n")
 
@@ -65,14 +65,14 @@
         x = itemData[0].rstrip()
 
         if isSharedLibrary:
-            outp.write('\n\t\ttemplate<> BR_API const std::pair<const uint8_t*, size_t> get_resource<NBL_CORE_UNIQUE_STRING_LITERAL_TYPE("%s")>();' % x)
+            outp.write('\n\t\ttemplate<> NBL_BR_API const std::pair<const uint8_t*, size_t> get_resource<NBL_CORE_UNIQUE_STRING_LITERAL_TYPE("%s")>();' % x)
         else:
             outp.write('\n\t\ttemplate<> const std::pair<const uint8_t*, size_t> get_resource<NBL_CORE_UNIQUE_STRING_LITERAL_TYPE("%s")>();' % x)
 
         if len(itemData) > 1:
             for i in range(1, len(itemData)):
                 if isSharedLibrary:
-                    outp.write('\n\t\ttemplate<> BR_API const std::pair<const uint8_t*, size_t> get_resource<NBL_CORE_UNIQUE_STRING_LITERAL_TYPE("%s")>();' % itemData[i].rstrip())
+                    outp.write('\n\t\ttemplate<> NBL_BR_API const std::pair<const uint8_t*, size_t> get_resource<NBL_CORE_UNIQUE_STRING_LITERAL_TYPE("%s")>();' % itemData[i].rstrip())
                 else:
                     outp.write('\n\t\ttemplate<> const std::pair<const uint8_t*, size_t> get_resource<NBL_CORE_UNIQUE_STRING_LITERAL_TYPE("%s")>();' % itemData[i].rstrip())
 

src/nbl/builtin/template/CArchive.cpp.in

@@ -0,0 +1,15 @@
+#include "CArchive.h"
+#include <memory>
+
+using namespace @_NAMESPACE_@;
+
+static const auto k_builtinArchiveFileList = std::make_shared<const nbl::core::vector<nbl::system::IFileArchive::SListEntry>>(nbl::core::vector<nbl::system::IFileArchive::SListEntry>{
+@_RESOURCES_INIT_LIST_@
+});
+
+CArchive::CArchive(nbl::system::logger_opt_smart_ptr&& logger)
+	: nbl::system::CFileArchive(nbl::system::path(pathPrefix.data()),std::move(logger), *const_cast<nbl::core::vector<nbl::system::IFileArchive::SListEntry>*>(k_builtinArchiveFileList.get())) 
+{
+
+}
+

src/nbl/builtin/template/CArchive.h.in

@@ -9,23 +9,17 @@ namespace @_NAMESPACE_@
 	constexpr std::string_view pathPrefix = "@_BUNDLE_ARCHIVE_ABSOLUTE_PATH_@";
 	constexpr bool hasPathPrefix(std::string_view str) { return str.find(pathPrefix) == 0ull; }
 
-	class CArchive final : public nbl::system::CFileArchive
+	class @_NBL_BR_API_@ CArchive final : public nbl::system::CFileArchive
 	{
 		public:
-			inline CArchive(nbl::system::logger_opt_smart_ptr&& logger)
-				: nbl::system::CFileArchive(nbl::system::path(pathPrefix.data()),std::move(logger), resources) {}
+			CArchive(nbl::system::logger_opt_smart_ptr&& logger);
 
 		protected:
 			file_buffer_t getFileBuffer(const nbl::system::IFileArchive::SListEntry* item) override
 			{
 					auto found = get_resource_runtime(item->pathRelativeToArchive.string());
 					return { const_cast<uint8_t*>(found.first), found.second, nullptr };
-			}
-
-			inline static const nbl::core::vector<nbl::system::IFileArchive::SListEntry> resources
-			{
-@_RESOURCES_INIT_LIST_@
-			};			
+			}			
 	};
 }
 

src/nbl/builtin/utils.cmake

@@ -49,12 +49,15 @@ function(ADD_CUSTOM_BUILTIN_RESOURCES _TARGET_NAME_ _BUNDLE_NAME_ _BUNDLE_SEARCH
 	if("${ARGV7}" STREQUAL "SHARED")
 		set(_LIB_TYPE_ SHARED)
 		set(_SHARED_ True)
+		set(NBL_BR_API "NBL_BR_API")
 	else()
 		set(_LIB_TYPE_ STATIC)
 		set(_SHARED_ False)
+		unset(NBL_BR_API)
 	endif()
 
 	set(NBL_TEMPLATE_RESOURCES_ARCHIVE_HEADER "${CMAKE_CURRENT_FUNCTION_LIST_DIR}/template/CArchive.h.in")
+	set(NBL_TEMPLATE_RESOURCES_ARCHIVE_SOURCE "${CMAKE_CURRENT_FUNCTION_LIST_DIR}/template/CArchive.cpp.in")
 	set(NBL_BUILTIN_HEADER_GEN_PY "${CMAKE_CURRENT_FUNCTION_LIST_DIR}/builtinHeaderGen.py")
 	set(NBL_BUILTIN_DATA_GEN_PY "${CMAKE_CURRENT_FUNCTION_LIST_DIR}/builtinDataGen.py")
 	set(NBL_BS_HEADER_FILENAME "builtinResources.h")
@@ -112,6 +115,7 @@ function(ADD_CUSTOM_BUILTIN_RESOURCES _TARGET_NAME_ _BUNDLE_NAME_ _BUNDLE_SEARCH
 	endforeach()
 
 	configure_file("${NBL_TEMPLATE_RESOURCES_ARCHIVE_HEADER}" "${_OUTPUT_HEADER_DIRECTORY_}/CArchive.h")
+	configure_file("${NBL_TEMPLATE_RESOURCES_ARCHIVE_SOURCE}" "${_OUTPUT_SOURCE_DIRECTORY_}/CArchive.cpp")
 
 	list(APPEND NBL_DEPENDENCY_FILES "${NBL_BUILTIN_HEADER_GEN_PY}")
 	list(APPEND NBL_DEPENDENCY_FILES "${NBL_BUILTIN_DATA_GEN_PY}")
@@ -130,12 +134,14 @@ function(ADD_CUSTOM_BUILTIN_RESOURCES _TARGET_NAME_ _BUNDLE_NAME_ _BUNDLE_SEARCH
 		COMMAND "${_Python3_EXECUTABLE}" "${NBL_BUILTIN_DATA_GEN_PY}" "${NBL_BUILTIN_RESOURCE_DATA_SOURCE}" "${_BUNDLE_SEARCH_DIRECTORY_}/${_BUNDLE_ARCHIVE_ABSOLUTE_PATH_}" "${NBL_RESOURCES_LIST_FILE}" "${_NAMESPACE_}" "${NBL_BS_HEADER_FILENAME}"
 		COMMENT "Generating built-in resources"
 		DEPENDS ${NBL_DEPENDENCY_FILES}
-		VERBATIM  
+		VERBATIM
 	)
 
 	add_library(${_TARGET_NAME_} ${_LIB_TYPE_}
 		"${NBL_BUILTIN_RESOURCES_HEADER}"
 		"${NBL_BUILTIN_RESOURCE_DATA_SOURCE}"
+		"${_OUTPUT_SOURCE_DIRECTORY_}/CArchive.cpp"
+		"${_OUTPUT_HEADER_DIRECTORY_}/CArchive.h"
 	)
 
 	if(_LIB_TYPE_ STREQUAL SHARED)
@@ -144,8 +150,14 @@ function(ADD_CUSTOM_BUILTIN_RESOURCES _TARGET_NAME_ _BUNDLE_NAME_ _BUNDLE_SEARCH
 		)
 	endif()
 
+	get_target_property(_NABLA_INCLUDE_DIRECTORIES_ Nabla INCLUDE_DIRECTORIES)
+	
+	if(NOT DEFINED _NABLA_INCLUDE_DIRECTORIES_) # TODO, validate by populating generator expressions if any and checking whether a path to the BuildConfigOptions.h exists per config
+		message(ERROR "_NABLA_INCLUDE_DIRECTORIES_ has been not found. You are required to define _NABLA_INCLUDE_DIRECTORIES_ containing at least include search directory path to BuildConfigOptions.h")
+	endif()
+	
 	target_include_directories(${_TARGET_NAME_} PUBLIC 
-		"${NBL_ROOT_PATH}/include"
+		"${_NABLA_INCLUDE_DIRECTORIES_}"
 		"${_OUTPUT_HEADER_DIRECTORY_}"
 	)
 	set_target_properties(${_TARGET_NAME_} PROPERTIES CXX_STANDARD 20)