more properties, validation, logs and args for NBL_CREATE_NSC_COMPILE_RULES, update examples_tests

Author: AnastaZIuk

cmake/common.cmake

@@ -1238,6 +1238,8 @@ function(NBL_PARSE_REQUIRED PREFIX)
 	endforeach()
 endfunction()
 
+# TODO: could create them in the function as <TARGET>_<PROPERTY> properties
+
 define_property(SOURCE PROPERTY NBL_SPIRV_REGISTERED_INPUT
 	BRIEF_DOCS "Absolute path to input shader which will be glued with device permutation config caps auto-gen file using #include directive, used as part of NSC compile rule to produce SPIRV output"
 )
@@ -1247,13 +1249,30 @@ define_property(SOURCE PROPERTY NBL_SPIRV_PERMUTATION_CONFIG
 	FULL_DOCS "The file is auto-generated at configuration time, contains DeviceConfigCaps struct with permuted device caps after which #include directive glues it with an input shader"
 )
 
+define_property(SOURCE PROPERTY NBL_SPIRV_BINARY_DIR
+	BRIEF_DOCS "a <SPIRV output> = NBL_SPIRV_BINARY_DIR/NBL_SPIRV_ACCESS_KEY"
+)
+define_property(SOURCE PROPERTY NBL_SPIRV_ACCESS_KEY
+	BRIEF_DOCS "a <SPIRV output> = NBL_SPIRV_BINARY_DIR/NBL_SPIRV_ACCESS_KEY"
+)
+
+define_property(TARGET PROPERTY NBL_CANONICAL_IDENTIFIERS
+	BRIEF_DOCS "List of identifiers composed as NBL_SPIRV_BINARY_DIR/KEY"
+	FULL_DOCS "For a given NBL_SPIRV_BINARY_DIR we define a set of canonical KEYs, each unique given which at runtime one can get SPIRV key to access <SPIRV output> by the canonical key which may contain special permutation part in character of <key>(.<name>=<value>)(.<name>=<value>)(...)"
+)
+
 define_property(TARGET PROPERTY NBL_SPIRV_OUTPUTS
-	BRIEF_DOCS "Absolute paths to SPIRV outputs, part of NSC compile rules"
+	BRIEF_DOCS "Absolute paths to all <SPIRV output>s which are part of NSC compile rules"
 )
 
-# NBL_SPIRV_OUTPUT = NBL_SPIRV_BINARY_DIR/NBL_SPIRV_ACCESS_KEY
-define_property(SOURCE PROPERTY NBL_SPIRV_BINARY_DIR)
-define_property(SOURCE PROPERTY NBL_SPIRV_ACCESS_KEY)
+define_property(TARGET PROPERTY NBL_HEADER_PATH
+	BRIEF_DOCS "Relative path for auto-gen include file with key getters"
+)
+define_property(TARGET PROPERTY NBL_HEADER_GENERATED_RULE)
+
+define_property(TARGET PROPERTY NBL_HEADER_CONTENT
+	BRIEF_DOCS "Contains NBL_HEADER_PATH's content"
+)
 
 function(NBL_CREATE_NSC_COMPILE_RULES)
     set(COMMENT "this code has been autogenerated with Nabla CMake NBL_CREATE_HLSL_COMPILE_RULES utility")
@@ -1301,14 +1320,67 @@ struct DeviceConfigCaps
 		)
 	endif()
 
-    set(REQUIRED_SINGLE_ARGS TARGET BINARY_DIR OUTPUT_VAR INPUTS)
+    set(REQUIRED_SINGLE_ARGS TARGET BINARY_DIR OUTPUT_VAR INPUTS INCLUDE NAMESPACE)
     cmake_parse_arguments(IMPL "" "${REQUIRED_SINGLE_ARGS}" "COMMON_OPTIONS" ${ARGV})
     NBL_PARSE_REQUIRED(IMPL ${REQUIRED_SINGLE_ARGS})
 
 	if(NOT TARGET ${IMPL_TARGET})
 		add_library(${IMPL_TARGET} INTERFACE)
 	endif()
 
+	if(IS_ABSOLUTE "${IMPL_INCLUDE}")
+		message(FATAL_ERROR "INCLUDE argument must be relative path")
+	endif()
+
+	set_target_properties(${IMPL_TARGET} PROPERTIES NBL_HEADER_PATH "${IMPL_INCLUDE}")
+
+	get_target_property(HEADER_RULE_GENERATED ${IMPL_TARGET} NBL_HEADER_GENERATED_RULE)
+	if(NOT HEADER_RULE_GENERATED)
+		set(INCLUDE_DIR "$<TARGET_PROPERTY:${IMPL_TARGET},BINARY_DIR>/${IMPL_TARGET}/.cmake/include")
+		set(INCLUDE_FILE "${INCLUDE_DIR}/$<TARGET_PROPERTY:${IMPL_TARGET},NBL_HEADER_PATH>")
+		set(INCLUDE_CONTENT $<TARGET_PROPERTY:${IMPL_TARGET},NBL_HEADER_CONTENT>)
+
+		file(GENERATE OUTPUT ${INCLUDE_FILE}
+			CONTENT ${INCLUDE_CONTENT}
+			TARGET ${IMPL_TARGET}
+		)
+
+		target_include_directories(${IMPL_TARGET} INTERFACE ${INCLUDE_DIR})
+		set_target_properties(${IMPL_TARGET} PROPERTIES NBL_HEADER_GENERATED_RULE ON)
+
+		set(HEADER_ITEM_VIEW [=[
+#include "nabla.h"
+
+]=])
+		set_property(TARGET ${IMPL_TARGET} APPEND_STRING PROPERTY NBL_HEADER_CONTENT "${HEADER_ITEM_VIEW}")
+	endif()
+
+	string(MAKE_C_IDENTIFIER "${IMPL_TARGET}_${IMPL_NAMESPACE}" NS_IMPL_KEYS_PROPERTY)
+	get_property(NS_IMPL_KEYS_PROPERTY_DEFINED
+		TARGET    ${IMPL_TARGET}
+		PROPERTY "${NS_IMPL_KEYS_PROPERTY}"
+		DEFINED
+	)
+	if(NOT NS_IMPL_KEYS_PROPERTY_DEFINED)
+		set(HEADER_ITEM_VIEW [=[
+namespace @IMPL_NAMESPACE@ {
+	template<nbl::core::StringLiteral Key>
+	inline const nbl::core::string get_spirv_key(const nbl::video::SPhysicalDeviceLimits& limits, const nbl::video::SPhysicalDeviceFeatures& features);
+
+	template<nbl::core::StringLiteral Key>
+	inline const nbl::core::string get_spirv_key(const nbl::video::ILogicalDevice* device)
+	{
+		return get_spirv_key<Key>(device->getPhysicalDevice()->getLimits(), device->getEnabledFeatures());
+	}
+}
+
+]=])
+		string(CONFIGURE "${HEADER_ITEM_VIEW}" HEADER_ITEM_EVAL @ONLY)
+		set_property(TARGET ${IMPL_TARGET} APPEND_STRING PROPERTY NBL_HEADER_CONTENT "${HEADER_ITEM_EVAL}")
+		define_property(TARGET PROPERTY "${NS_IMPL_KEYS_PROPERTY}")
+	endif()
+
+
     string(JSON JSON_LENGTH LENGTH "${IMPL_INPUTS}")
     math(EXPR LAST_INDEX "${JSON_LENGTH} - 1")
 
@@ -1349,21 +1421,55 @@ struct DeviceConfigCaps
             endif()
         endif()
 
+		function(ERROR_WHILE_PARSING_ITEM)
+			string(JSON ITEM GET "${IMPL_INPUTS}" ${INDEX})
+			message(FATAL_ERROR 
+				"While parsing ${IMPL_TARGET}'s NSC compile rule\n${ITEM}\n"
+				${ARGV}
+			)
+		endfunction()
+
         set(CAP_NAMES "")
         set(CAP_TYPES "")
         if(HAS_CAPS)
             math(EXPR LAST_CAP "${CAPS_LENGTH} - 1")
             foreach(CAP_IDX RANGE 0 ${LAST_CAP})
                 string(JSON CAP_NAME GET "${IMPL_INPUTS}" ${INDEX} CAPS ${CAP_IDX} name)
                 string(JSON CAP_TYPE GET "${IMPL_INPUTS}" ${INDEX} CAPS ${CAP_IDX} type)
-                string(JSON CAP_VALUES_LENGTH LENGTH "${IMPL_INPUTS}" ${INDEX} CAPS ${CAP_IDX} values)
 
-                set(VALUES "")
-                math(EXPR LAST_VAL "${CAP_VALUES_LENGTH} - 1")
-                foreach(VAL_IDX RANGE 0 ${LAST_VAL})
-                    string(JSON VALUE GET "${IMPL_INPUTS}" ${INDEX} CAPS ${CAP_IDX} values ${VAL_IDX})
-                    list(APPEND VALUES "${VALUE}")
-                endforeach()
+				if(NOT CAP_TYPE MATCHES "^(bool|uint16_t|uint32_t|uint64_t)$")
+					ERROR_WHILE_PARSING_ITEM(
+						"Invalid CAP type \"${CAP_TYPE}\" for ${CAP_NAME}\n"
+						"Allowed types are: bool, uint16_t, uint32_t, uint64_t"
+					)
+				endif()
+
+				string(JSON CAP_VALUES_LENGTH LENGTH "${IMPL_INPUTS}" ${INDEX} CAPS ${CAP_IDX} values)
+
+				set(VALUES "")
+				math(EXPR LAST_VAL "${CAP_VALUES_LENGTH} - 1")
+				foreach(VAL_IDX RANGE 0 ${LAST_VAL})
+					string(JSON VALUE GET "${IMPL_INPUTS}" ${INDEX} CAPS ${CAP_IDX} values ${VAL_IDX})
+					string(JSON VAL_TYPE TYPE "${IMPL_INPUTS}" ${INDEX} CAPS ${CAP_IDX} values ${VAL_IDX})
+
+					if(NOT VAL_TYPE STREQUAL "NUMBER")
+						ERROR_WHILE_PARSING_ITEM(
+							"Invalid CAP value \"${VALUE}\" for CAP \"${CAP_NAME}\" of type ${CAP_TYPE}\n"
+							"Use numbers for uint*_t and 0/1 for bools."
+						)
+					endif()
+
+					if(CAP_TYPE STREQUAL "bool")
+						if(NOT VALUE MATCHES "^[01]$")
+							ERROR_WHILE_PARSING_ITEM(
+								"Invalid bool value \"${VALUE}\" for ${CAP_NAME}\n"
+								"Boolean CAPs can only have values 0 or 1."
+							)
+						endif()
+					endif()
+
+					list(APPEND VALUES "${VALUE}")
+				endforeach()
 
                 set(CAP_VALUES_${CAP_IDX} "${VALUES}")
                 list(APPEND CAP_NAMES "${CAP_NAME}")
@@ -1378,9 +1484,47 @@ struct DeviceConfigCaps
 			set(TARGET_INPUT "${CMAKE_CURRENT_SOURCE_DIR}/${TARGET_INPUT}")
 		endif()
 
+		get_target_property(CANONICAL_IDENTIFIERS ${IMPL_TARGET} NBL_CANONICAL_IDENTIFIERS)
+
+		set(NEW_CANONICAL_IDENTIFIER "${IMPL_BINARY_DIR}/${BASE_KEY}")
+		if(CANONICAL_IDENTIFIERS)
+			list(FIND CANONICAL_IDENTIFIERS "${NEW_CANONICAL_IDENTIFIER}" FOUND)
+
+			if(NOT FOUND STREQUAL -1)
+				string(JSON ITEM GET "${IMPL_INPUTS}" ${INDEX})
+				message(FATAL_ERROR "While parsing ${IMPL_TARGET}'s NSC compile rule\n${ITEM}\nwith binary directory \"${IMPL_BINARY_DIR}\",\ncanonical key \"${BASE_KEY}\" already defined!")
+			endif()
+		endif()
+
+		set_property(TARGET ${IMPL_TARGET} APPEND PROPERTY NBL_CANONICAL_IDENTIFIERS "${NEW_CANONICAL_IDENTIFIER}")
+
+		set(HEADER_ITEM_VIEW [=[
+namespace @IMPL_NAMESPACE@ {
+	template<>
+	inline const nbl::core::string get_spirv_key<NBL_CORE_UNIQUE_STRING_LITERAL_TYPE("@BASE_KEY@")>
+	(const nbl::video::SPhysicalDeviceLimits& limits, const nbl::video::SPhysicalDeviceFeatures& features)
+	{
+		nbl::core::string retval = "@BASE_KEY@";
+@RETVAL_EVAL@
+		retval += ".spv";
+		return retval;
+	}
+}
+
+]=])
+		unset(RETVAL_EVAL)
+		foreach(CAP ${CAP_NAMES})
+			string(CONFIGURE [=[
+		retval += ".@CAP@_" + std::to_string(limits.@CAP@);
+]=] RETVALUE_VIEW @ONLY)
+			string(APPEND RETVAL_EVAL "${RETVALUE_VIEW}")
+		endforeach(CAP)
+		string(CONFIGURE "${HEADER_ITEM_VIEW}" HEADER_ITEM_EVAL @ONLY)
+		set_property(TARGET ${IMPL_TARGET} APPEND_STRING PROPERTY NBL_HEADER_CONTENT "${HEADER_ITEM_EVAL}")
+		
 		function(GENERATE_KEYS PREFIX CAP_INDEX CAPS_EVAL_PART)
 			if(NUM_CAPS EQUAL 0 OR CAP_INDEX EQUAL ${NUM_CAPS})
-				set(FINAL_KEY "${BASE_KEY}${PREFIX}")
+				set(FINAL_KEY "${BASE_KEY}${PREFIX}.spv") # always add ext even if its already there to make sure asset loader always is able to load as IShader
 
 				set(TARGET_OUTPUT "${IMPL_BINARY_DIR}/${FINAL_KEY}")
 				set(CONFIG_FILE "${TARGET_OUTPUT}.config")
@@ -1420,7 +1564,6 @@ struct DeviceConfigCaps
 				)
 
 				set_property(TARGET ${IMPL_TARGET} APPEND PROPERTY NBL_SPIRV_OUTPUTS "${TARGET_OUTPUT}")
-
 				return()
 			endif()
 
@@ -1430,7 +1573,7 @@ struct DeviceConfigCaps
 			set(VALUES "${${VAR_NAME}}")
 
 			foreach(V IN LISTS VALUES)
-				set(NEW_PREFIX "${PREFIX}.${CURRENT_CAP}=${V}")
+				set(NEW_PREFIX "${PREFIX}.${CURRENT_CAP}_${V}")
 				set(NEW_EVAL "${CAPS_EVAL_PART}NBL_CONSTEXPR_STATIC_INLINE ${CURRENT_TYPE} ${CURRENT_CAP} = (${CURRENT_TYPE}) ${V}; // got permuted\n")
 				math(EXPR NEXT_INDEX "${CAP_INDEX} + 1")
 				GENERATE_KEYS("${NEW_PREFIX}" "${NEXT_INDEX}" "${NEW_EVAL}")
@@ -1440,6 +1583,7 @@ struct DeviceConfigCaps
        	GENERATE_KEYS("" 0 "")
     endforeach()
 
+	unset(KEYS)
 	get_target_property(SPIRVs ${IMPL_TARGET} NBL_SPIRV_OUTPUTS)
 	foreach(SPIRV ${SPIRVs})
 		get_source_file_property(CONFIG ${SPIRV} NBL_SPIRV_PERMUTATION_CONFIG)
@@ -1449,15 +1593,6 @@ struct DeviceConfigCaps
 		list(APPEND CONFIGS ${CONFIG})
 		list(APPEND INPUTS ${INPUT})
 		list(APPEND KEYS ${ACCESS_KEY})
-
-		if(NBL_LOG_VERBOSE)
-			get_source_file_property(BINARY_DIR ${SPIRV} NBL_SPIRV_BINARY_DIR)
-			message(STATUS "[${IMPL_TARGET}'s SPIRV]: ${SPIRV}")
-			message(STATUS "-- BINARY_DIR: ${BINARY_DIR}")
-			message(STATUS "-- ACCESS_KEY: ${ACCESS_KEY}")
-			message(STATUS "-- CONFIG: ${CONFIG}")
-			message(STATUS "-- INPUT: ${INPUT}")
-		endif()
 	endforeach()
 
 	set(RTE "NSC Rules")
@@ -1499,8 +1634,9 @@ function(NBL_CREATE_RESOURCE_ARCHIVE)
 
 		ADD_CUSTOM_BUILTIN_RESOURCES(${IMPL_TARGET} NBL_RESOURCES_TO_EMBED "${_BUNDLE_SEARCH_DIRECTORY_}" "${_BUNDLE_ARCHIVE_ABSOLUTE_PATH_}" "${_BUILTIN_RESOURCES_NAMESPACE_}" "${_OUTPUT_DIRECTORY_HEADER_}" "${_OUTPUT_DIRECTORY_SOURCE_}" "${_LINK_MODE_}")
 	else()
-		add_library(${IMPL_TARGET} INTERFACE)
+		add_library(${IMPL_TARGET} INTERFACE) # (***)
 	endif()
 
+	# TODO (***): actually I better have this in meta target created by NBL_CREATE_NSC_COMPILE_RULES, then I kill its INTERFACE when builtins are off
 	target_compile_definitions(${IMPL_TARGET} INTERFACE ${IMPL_MOUNT_POINT_DEFINE}="${_BUNDLE_SEARCH_DIRECTORY_}")
 endfunction()