create REGISTER_COMMON_BUILTINS, register example API source & include archives, update common/include/nbl/examples/common/BuiltinResourcesApplication.hpp and test on 09 example

Author: AnastaZIuk

CMakeLists.txt

@@ -95,6 +95,8 @@ if(NBL_BUILD_EXAMPLES)
         target_link_libraries(${T} PUBLIC ${NBL_EXAMPLES_API_TARGET})
 		target_include_directories(${T} PUBLIC $<TARGET_PROPERTY:${NBL_EXAMPLES_API_TARGET},INCLUDE_DIRECTORIES>)
 		target_precompile_headers(${T} REUSE_FROM "${NBL_EXAMPLES_API_TARGET}")
+		LINK_BUILTIN_RESOURCES_TO_TARGET(${T} NblExtExamplesAPIBuiltinsSource)
+		LINK_BUILTIN_RESOURCES_TO_TARGET(${T} NblExtExamplesAPIBuiltinsInclude)
     endforeach()
 
 	NBL_ADJUST_FOLDERS(examples)

common/CMakeLists.txt

@@ -13,6 +13,53 @@ nbl_create_ext_library_project(ExamplesAPI "" "${CMAKE_CURRENT_SOURCE_DIR}/src/n
 set_target_properties(${LIB_NAME} PROPERTIES DISABLE_PRECOMPILE_HEADERS OFF)
 target_precompile_headers(${LIB_NAME} PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/include/nbl/examples/PCH.hpp")
 
+function(REGISTER_COMMON_BUILTINS)
+	cmake_parse_arguments(EX "" "TARGET;ARCHIVE_ABS_ENTRY;ARCHIVE_NAMESPACE" "GLOB_RGX" ${ARGN})
+
+    get_filename_component(INPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" ABSOLUTE)
+    get_filename_component(OUTPUT_SRC "${CMAKE_CURRENT_BINARY_DIR}/builtin/${EX_TARGET}/src" ABSOLUTE)
+    get_filename_component(OUTPUT_INCLUDE "${CMAKE_CURRENT_BINARY_DIR}/builtin/${EX_TARGET}/include" ABSOLUTE)
+
+    set(KEYS_ENTRY "${INPUT_DIRECTORY}/${EX_ARCHIVE_ABS_ENTRY}")
+    list(TRANSFORM EX_GLOB_RGX PREPEND "${KEYS_ENTRY}/")
+	file(GLOB_RECURSE KEYS RELATIVE "${KEYS_ENTRY}" CONFIGURE_DEPENDS ${EX_GLOB_RGX})
+
+    #[[
+        note we do force you to specify full globbing expressions relative to keys entry which we do not filter
+        because if runtime outputs .spv compilation artifacts/shader cache preprocessed.hlsl(s) to source you will hit CMake
+        reconfiguration each time the file content or timestampts change and it could lead to embeding intermediate trash
+    ]]
+	
+    unset(EXAMPLES_RESOURCES_TO_EMBED)
+	foreach(KEY IN LISTS KEYS)
+		LIST_BUILTIN_RESOURCE(EXAMPLES_RESOURCES_TO_EMBED "${KEY}")
+	endforeach()
+
+    ADD_CUSTOM_BUILTIN_RESOURCES(${EX_TARGET} EXAMPLES_RESOURCES_TO_EMBED "${INPUT_DIRECTORY}" "${EX_ARCHIVE_ABS_ENTRY}" "${EX_ARCHIVE_NAMESPACE}" "${OUTPUT_INCLUDE}" "${OUTPUT_SRC}")
+
+    # even though builtin target is static library its still valid to reuse common PCH to boost its build speed to not preprocess entire Nabla again
+    set_target_properties(${EX_TARGET} PROPERTIES DISABLE_PRECOMPILE_HEADERS OFF)
+    target_precompile_headers(${EX_TARGET} REUSE_FROM "${LIB_NAME}")
+
+    target_include_directories(${EX_TARGET} PUBLIC "${INPUT_DIRECTORY}/include")
+    target_link_libraries(${EX_TARGET} INTERFACE ${LIB_NAME})
+endfunction()
+
+#! common example API builtins as static library targets linked to each example
+if(NBL_EMBED_BUILTIN_RESOURCES)
+    REGISTER_COMMON_BUILTINS(TARGET NblExtExamplesAPIBuiltinsSource 
+        ARCHIVE_ABS_ENTRY src/nbl/examples 
+        ARCHIVE_NAMESPACE nbl::builtin::examples::src 
+        GLOB_RGX *.hlsl *.txt
+    )
+
+    REGISTER_COMMON_BUILTINS(TARGET NblExtExamplesAPIBuiltinsInclude 
+        ARCHIVE_ABS_ENTRY include/nbl/examples 
+        ARCHIVE_NAMESPACE nbl::builtin::examples::include
+        GLOB_RGX *.hpp *.h *.hlsl *.txt
+    )
+endif()
+
 #! Examples API common libraries
 #[[
     The rule is to avoid creating additional libraries as part of the examples' common
@@ -24,7 +71,8 @@ target_precompile_headers(${LIB_NAME} PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/includ
     but If you have a good reason to create library because you cannot make it header only 
     AND you *can REUSE* the examples' PCH then go ahead anyway and put it under `src/nbl/examples`, 
     otherwise keep it header only - a good example would be to use our embedded-whatever-you-want tool
-    which does create library but can reuse example's PCH
+    which does create library but can reuse example's PCH (see NblExtExamplesAPIBuiltinsSource 
+    and NblExtExamplesAPIBuiltinsInclude targets)
 ]]
 
 #! NOTE: as I write it we don't have any targets there yet
@@ -35,7 +83,7 @@ list(REMOVE_ITEM TARGETS ${LIB_NAME})
 
 # the Examples API proxy library CMake target name
 #[[
-    this one gets linked to each executable automatically
+    this one gets linked to each executable automatically with its interface libraries
 ]]
 set(NBL_EXAMPLES_API_TARGET ${LIB_NAME} PARENT_SCOPE)
 
@@ -45,4 +93,6 @@ set(NBL_EXAMPLES_API_TARGET ${LIB_NAME} PARENT_SCOPE)
     then you must target_link_libraries() the lib you want as we 
     don't link all those libraries to each executable automatically
 ]]
-set(NBL_EXAMPLES_API_LIBRARIES ${TARGETS} PARENT_SCOPE)
+set(NBL_EXAMPLES_API_LIBRARIES ${TARGETS} PARENT_SCOPE)
+
+NBL_ADJUST_FOLDERS(common)

common/include/nbl/examples/common/BuiltinResourcesApplication.hpp

@@ -9,9 +9,9 @@
 #include "nbl/application_templates/MonoAssetManagerApplication.hpp"
 
 #ifdef NBL_EMBED_BUILTIN_RESOURCES
-// TODO: the include/header `nbl/examples` archive
-// TODO: the source `nbl/examples` archive
-// TODO: the build `nbl/examples` archive
+	#include "nbl/builtin/examples/include/CArchive.h"
+	#include "nbl/builtin/examples/src/CArchive.h"
+	// TODO: the build `nbl/examples` archive
 #if __has_include("nbl/this_example/builtin/CArchive.h")
 	#include "nbl/this_example/builtin/CArchive.h"
 #endif
@@ -42,7 +42,10 @@ class BuiltinResourcesApplication : public virtual application_templates::MonoAs
 
 			smart_refctd_ptr<system::IFileArchive> examplesHeaderArch,examplesSourceArch,examplesBuildArch,thisExampleArch;
 		#ifdef NBL_EMBED_BUILTIN_RESOURCES
-// TODO: the 3 examples archives
+			examplesHeaderArch = core::make_smart_refctd_ptr<nbl::builtin::examples::include::CArchive>(smart_refctd_ptr(m_logger));
+			examplesSourceArch = core::make_smart_refctd_ptr<nbl::builtin::examples::src::CArchive>(smart_refctd_ptr(m_logger));
+			// TODO: the build archive
+
 			#ifdef _NBL_THIS_EXAMPLE_BUILTIN_C_ARCHIVE_H_
 				thisExampleArch = make_smart_refctd_ptr<nbl::this_example::builtin::CArchive>(smart_refctd_ptr(m_logger));
 			#endif