refactor glue define code with regex generator expressions (and get rid of extra redundant build target + bugs caused by it); save work, now need to add ABS_KEYs to PUBLIC to make smoke pass

Author: AnastaZIuk

cmake/common.cmake

@@ -1072,87 +1072,6 @@ macro(propagate_changed_variables_to_parent_scope)
     endforeach()
 endmacro()
 
-macro(glue_source_definitions NBL_TARGET NBL_REFERENCE_RETURN_VARIABLE)
-	macro(NBL_INSERT_DEFINITIONS _NBL_DEFINITIONS_)
-		string(FIND "${_NBL_DEFINITIONS_}" "NOTFOUND" CHECK)
-			if(${CHECK} EQUAL -1)
-				list(APPEND TESTEST ${_NBL_DEFINITIONS_})
-			endif()
-	endmacro()
-		
-	get_directory_property(NBL_DIRECTORY_DEFINITIONS COMPILE_DEFINITIONS)
-
-	if(DEFINED NBL_DIRECTORY_DEFINITIONS)
-		NBL_INSERT_DEFINITIONS("${NBL_DIRECTORY_DEFINITIONS}")
-	endif()
-	
-	get_target_property(NBL_COMPILE_DEFS ${NBL_TARGET} COMPILE_DEFINITIONS)
-	if(DEFINED NBL_COMPILE_DEFS)
-		foreach(def IN LISTS NBL_COMPILE_DEFS)
-			NBL_INSERT_DEFINITIONS(${def})
-		endforeach()
-	endif()
-	
-	foreach(trgt IN LISTS _NBL_3RDPARTY_TARGETS_)			 
-			 get_target_property(NBL_COMPILE_DEFS ${trgt} COMPILE_DEFINITIONS)
-			 
-			 if(DEFINED NBL_COMPILE_DEFS)
-				NBL_INSERT_DEFINITIONS(${NBL_COMPILE_DEFS})
-			 endif()
-	endforeach()
-	
-	foreach(def IN LISTS TESTEST)	
-		string(FIND "${def}" "-D" CHECK)
-			if(${CHECK} EQUAL -1)
-				list(APPEND ${NBL_REFERENCE_RETURN_VARIABLE} ${def})
-			else()
-				string(LENGTH "-D" _NBL_D_LENGTH_)
-				string(LENGTH ${def} _NBL_DEFINITION_LENGTH_)
-				math(EXPR _NBL_DEFINITION_WITHOUT_D_LENGTH_ "${_NBL_DEFINITION_LENGTH_} - ${_NBL_D_LENGTH_}" OUTPUT_FORMAT DECIMAL)
-				string(SUBSTRING ${def} ${_NBL_D_LENGTH_} ${_NBL_DEFINITION_WITHOUT_D_LENGTH_} _NBL_DEFINITION_WITHOUT_D_)
-				
-				list(APPEND ${NBL_REFERENCE_RETURN_VARIABLE} ${_NBL_DEFINITION_WITHOUT_D_})
-			endif()
-	endforeach()
-	
-	list(REMOVE_DUPLICATES ${NBL_REFERENCE_RETURN_VARIABLE})
-	
-	foreach(_NBL_DEF_ IN LISTS ${NBL_REFERENCE_RETURN_VARIABLE})
-		string(FIND "${_NBL_DEF_}" "=" _NBL_POSITION_ REVERSE)
-		
-		# put target compile definitions without any value into wrapper file
-		if(_NBL_POSITION_ STREQUAL -1)
-			if(NOT ${_NBL_DEF_} STREQUAL "__NBL_BUILDING_NABLA__")
-				string(APPEND WRAPPER_CODE 
-					"#ifndef ${_NBL_DEF_}\n"
-					"#define ${_NBL_DEF_}\n"
-					"#endif // ${_NBL_DEF_}\n\n"
-				)
-			endif()
-		else()
-			# put target compile definitions with an assigned value into wrapper file
-			string(SUBSTRING "${_NBL_DEF_}" 0 ${_NBL_POSITION_} _NBL_CLEANED_DEF_)
-			
-			string(LENGTH "${_NBL_DEF_}" _NBL_DEF_LENGTH_)
-			math(EXPR _NBL_SHIFTED_POSITION_ "${_NBL_POSITION_} + 1" OUTPUT_FORMAT DECIMAL)
-			math(EXPR _NBL_DEF_VALUE_LENGTH_ "${_NBL_DEF_LENGTH_} - ${_NBL_SHIFTED_POSITION_}" OUTPUT_FORMAT DECIMAL)
-			string(SUBSTRING "${_NBL_DEF_}" ${_NBL_SHIFTED_POSITION_} ${_NBL_DEF_VALUE_LENGTH_} _NBL_DEF_VALUE_)
-			
-			string(APPEND WRAPPER_CODE 
-				"#ifndef ${_NBL_CLEANED_DEF_}\n"
-				"#define ${_NBL_CLEANED_DEF_} ${_NBL_DEF_VALUE_}\n"
-				"#endif // ${_NBL_CLEANED_DEF_}\n\n"
-			)
-		endif()
-	endforeach()
-	
-	set(${NBL_REFERENCE_RETURN_VARIABLE} "${WRAPPER_CODE}")
-endmacro()
-
-macro(write_source_definitions NBL_FILE NBL_WRAPPER_CODE_TO_WRITE)
-	file(WRITE "${NBL_FILE}" "${NBL_WRAPPER_CODE_TO_WRITE}")
-endmacro()
-
 function(NBL_GET_ALL_TARGETS NBL_OUTPUT_VAR)
     set(NBL_TARGETS)
     NBL_GET_ALL_TARGETS_RECURSIVE(NBL_TARGETS ${CMAKE_CURRENT_SOURCE_DIR})

src/nbl/CMakeLists.txt

@@ -365,6 +365,7 @@ endif()
 
 target_compile_definitions(Nabla 
 	PUBLIC _DXC_DLL_="${DXC_DLL}"
+	PUBLIC _DXC_DLL_NAME_="$<PATH:REMOVE_EXTENSION,${DXC_DLL_NAME}>"
 	PRIVATE __NBL_BUILDING_NABLA__
 )
 
@@ -595,7 +596,7 @@ target_include_directories(Nabla PUBLIC "${THIRD_PARTY_SOURCE_DIR}/Vulkan-Header
 target_include_directories(Nabla PUBLIC "${THIRD_PARTY_SOURCE_DIR}/volk")
 target_link_libraries(Nabla PRIVATE volk)
 if(WIN32)
-	target_compile_definitions(Nabla PRIVATE VK_USE_PLATFORM_WIN32_KHR)
+	target_compile_definitions(Nabla PUBLIC VK_USE_PLATFORM_WIN32_KHR) # volk is part of public interface headers in Nabla
 endif()
 # CUDA
 if (NBL_COMPILE_WITH_CUDA)
@@ -637,12 +638,10 @@ target_include_directories(Nabla PUBLIC "${NBL_DEVICE_GEN_INCLUDE_DIR}")
 if(NBL_EMBED_BUILTIN_RESOURCES)
 	add_subdirectory(builtin EXCLUDE_FROM_ALL)
 
-	function(NBL_HOOK_INTERNAL_BUILTIN_RESOURCES NBL_TARGETS)
-		get_target_property(_NABLA_INCLUDE_DIRECTORIES_ Nabla INCLUDE_DIRECTORIES)
-	
+	function(NBL_HOOK_INTERNAL_BUILTIN_RESOURCES NBL_TARGETS)	
 		foreach(NBL_TARGET IN LISTS NBL_TARGETS)
 			get_target_property(_INTERNAL_BR_OUTPUT_INCLUDE_SEARCH_DIRECTORY_ ${NBL_TARGET} BUILTIN_RESOURCES_INCLUDE_SEARCH_DIRECTORY)
-			target_include_directories(${NBL_TARGET} PUBLIC "${_NABLA_INCLUDE_DIRECTORIES_}")
+			target_include_directories(${NBL_TARGET} PUBLIC "$<TARGET_PROPERTY:Nabla,INCLUDE_DIRECTORIES>")
 			target_include_directories(Nabla PUBLIC "${_INTERNAL_BR_OUTPUT_INCLUDE_SEARCH_DIRECTORY_}")
 		endforeach()
 
@@ -683,10 +682,25 @@ target_compile_definitions(Nabla
 	PUBLIC _NABLA_INSTALL_DIR_="${CMAKE_INSTALL_PREFIX}"
 )
 
-# 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)
-write_source_definitions("${_NBL_DEFINE_FILE_WRAPPER_}" "${_NBL_SOURCE_DEFINITIONS_}")
+set(DEFINE_H "${CMAKE_CURRENT_BINARY_DIR}/include/$<CONFIG>/define.h")
+target_include_directories(Nabla BEFORE PUBLIC "$<PATH:GET_PARENT_PATH,${DEFINE_H}>")
+
+# get consumer definitions
+get_directory_property(DEFS COMPILE_DEFINITIONS)
+list(APPEND DEFS $<TARGET_PROPERTY:INTERFACE_COMPILE_DEFINITIONS>)
+
+# and generate define.h header aligned for install interface
+file(GENERATE OUTPUT ${DEFINE_H}
+	# note: could be ^([^=]*)=?(.*)$ with 2 regex match groups, first for define name second for optional value defaulted to empty string
+	# but CMake seems to have a bug https://gitlab.kitware.com/cmake/cmake/-/issues/16899 hence we do 2 sandwitched transforms
+    CONTENT "$<JOIN:$<LIST:TRANSFORM,$<LIST:TRANSFORM,${DEFS},REPLACE,^([^=]+)(=.*|)$,#ifndef \\1\\n#define \\1\\2\\n#endif // \\1\\n>,REPLACE,(#define [^=\\n]*)=,\\1 >,\n>"
+	TARGET Nabla
+)
+
+# TODO: we should not expose definitions which contain any absolute paths to install headers, 
+# eg. _NABLA_INSTALL_DIR_, _NABLA_OUTPUT_DIR_, _DXC_DLL_, imo those can be compiled into binary  
+# for dev purposes, but shall use BUILD_INTERFACE generator expression to keep trash out of install interface
+nbl_install_file("${DEFINE_H}")
 
 # git version tracking
 target_link_libraries(Nabla PUBLIC gtml)
@@ -725,25 +739,7 @@ start_tracking_variables_for_propagation_to_parent()
 add_subdirectory(ext)
 propagate_changed_variables_to_parent_scope()
 
-if(NOT NBL_STATIC_BUILD)
-	add_custom_command(OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/$<CONFIG>/generated/define.h"
-		COMMAND "${CMAKE_COMMAND}" -DNBL_ROOT_PATH:PATH=${NBL_ROOT_PATH} -DNBL_WRAPPER_FILE:FILEPATH=${_NBL_DEFINE_FILE_WRAPPER_} -DNBL_GEN_DIRECTORY:PATH=${CMAKE_CURRENT_BINARY_DIR}/$<CONFIG>/generated -D_NABLA_DLL_NAME_:STRING=$<PATH:REMOVE_EXTENSION,$<TARGET_FILE_NAME:Nabla>> -D_DXC_DLL_NAME_:STRING=${DXC_DLL_NAME} -D_NABLA_INSTALL_DIR_:PATH="${CMAKE_INSTALL_PREFIX}" -P ${NBL_ROOT_PATH}/cmake/scripts/nbl/nablaDefines.cmake
-		COMMENT "Launching defines.h generation script!"
-		VERBATIM
-	)
-	
-	add_custom_target(generate_nabla_defines ALL
-        DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/$<CONFIG>/generated/define.h"
-        VERBATIM
-    )
-	
-	add_dependencies(Nabla generate_nabla_defines)
-endif()
-
 nbl_install_headers("${NABLA_HEADERS_PUBLIC}")
-if(NOT NBL_STATIC_BUILD)
-	nbl_install_file("${CMAKE_CURRENT_BINARY_DIR}/$<CONFIG>/generated/define.h")
-endif()
 nbl_install_file_spec("${NBL_ROOT_PATH_BINARY}/include/nbl/builtin/builtinResources.h" "nbl/builtin")
 nbl_install_config_header(BuildConfigOptions.h)