build: Add ClangCL profiles

Also fix some compilation errors catched by clang

Signed-off-by: Ali Cheraghi <[email protected]>

Author: alichraghi

3rdparty/CMakeLists.txt

@@ -493,7 +493,7 @@ if(ENABLE_HLSL)
 endif()
 
 foreach(trgt IN LISTS NBL_3RDPARTY_TARGETS)
-		if(NBL_DYNAMIC_MSVC_RUNTIME)
+		if(NBL_COMPILER_DYNAMIC_RUNTIME)
 			set_property(TARGET ${trgt} PROPERTY MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL")
 		else()
 			set_property(TARGET ${trgt} PROPERTY MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")

3rdparty/dxc/CMakeLists.txt

@@ -62,7 +62,7 @@ if(WIN32)
 	endif()
 endif()
 
-if(NBL_DYNAMIC_MSVC_RUNTIME)
+if(NBL_COMPILER_DYNAMIC_RUNTIME)
 	list(APPEND NBL_DXC_CMAKE_OPTIONS "-DCMAKE_MSVC_RUNTIME_LIBRARY:STATIC=MultiThreaded$<$<CONFIG:Debug>:Debug>DLL")
 else()
 	list(APPEND NBL_DXC_CMAKE_OPTIONS "-DCMAKE_MSVC_RUNTIME_LIBRARY:STATIC=MultiThreaded$<$<CONFIG:Debug>:Debug>")		

CMakeLists.txt

@@ -20,10 +20,10 @@ if(MSVC)
 endif()
 
 option(NBL_STATIC_BUILD "" OFF) # ON for static builds, OFF for shared
-option(NBL_DYNAMIC_MSVC_RUNTIME "" ON)
+option(NBL_COMPILER_DYNAMIC_RUNTIME "" ON)
 option(NBL_SANITIZE_ADDRESS OFF)
 
-if(MSVC)
+if(MSVC AND CMAKE_CXX_COMPILER_ID STREQUAL MSVC)
 	if(NBL_SANITIZE_ADDRESS)
 		set(CMAKE_MSVC_DEBUG_INFORMATION_FORMAT "$<$<CONFIG:Debug,RelWithDebInfo>:ProgramDatabase>")
 	else()
@@ -35,10 +35,10 @@ if(NBL_STATIC_BUILD)
 	message(STATUS "Static Nabla build enabled!")
 else()
 	if(MSVC)
-		if(NBL_DYNAMIC_MSVC_RUNTIME)
+		if(NBL_COMPILER_DYNAMIC_RUNTIME)
 			message(STATUS "Shared Nabla build enabled!")
 		else()
-			message(FATAL_ERROR "Turn NBL_DYNAMIC_MSVC_RUNTIME on! For dynamic Nabla builds dynamic MSVC runtime is mandatory!")
+			message(FATAL_ERROR "Turn NBL_COMPILER_DYNAMIC_RUNTIME on! For dynamic Nabla builds dynamic MSVC runtime is mandatory!")
 		endif()
 	else()
 		message(FATAL_ERROR "Nabla can't be built with shared libraries! Please make sure you are targetting Windows OS and MSVC compiler!")

CMakePresets.json

@@ -46,7 +46,7 @@
 			"hidden": true,
 			"inherits": "ci-configure-static-base",
 			"cacheVariables": {
-				"NBL_DYNAMIC_MSVC_RUNTIME": "OFF"
+				"NBL_COMPILER_DYNAMIC_RUNTIME": "OFF"
 			},
 			"condition": {
 				"type": "allOf",
@@ -69,7 +69,7 @@
 			"hidden": true,
 			"inherits": "ci-configure-dynamic-base",
 			"cacheVariables": {
-				"NBL_DYNAMIC_MSVC_RUNTIME": "ON"
+				"NBL_COMPILER_DYNAMIC_RUNTIME": "ON"
 			},
 			"condition": {
 				"type": "allOf",
@@ -156,7 +156,7 @@
 			"hidden": true,
 			"inherits": "user-configure-static-base",
 			"cacheVariables": {
-				"NBL_DYNAMIC_MSVC_RUNTIME": "OFF"
+				"NBL_COMPILER_DYNAMIC_RUNTIME": "OFF"
 			},
 			"condition": {
 				"type": "equals",
@@ -169,7 +169,7 @@
 			"hidden": true,
 			"inherits": "user-configure-dynamic-base",
 			"cacheVariables": {
-				"NBL_DYNAMIC_MSVC_RUNTIME": "ON"
+				"NBL_COMPILER_DYNAMIC_RUNTIME": "ON"
 			},
 			"condition": {
 				"type": "equals",
@@ -193,6 +193,22 @@
 			"generator": "Visual Studio 17 2022",
 			"toolset": "v143"
 		},
+		{
+			"name": "user-configure-static-clangcl",
+			"inherits": "user-configure-static-windows-base",
+			"displayName": "[USER]: Static library target, Visual Studio 17 2022 generator, ClangCL toolset",
+			"description": "Configure as static library with Visual Studio 17 2022 generator and ClangCL toolset",
+			"generator": "Visual Studio 17 2022",
+			"toolset": "ClangCL"
+		},
+		{
+			"name": "user-configure-dynamic-clangcl",
+			"inherits": "user-configure-dynamic-windows-base",
+			"displayName": "[USER]: Dynamic library target, Visual Studio 17 2022 generator, ClangCL toolset",
+			"description": "Configure as dynamic library with Visual Studio 17 2022 generator and ClangCL toolset",
+			"generator": "Visual Studio 17 2022",
+			"toolset": "ClangCL"
+		},
 		{
 			"name": "user-configure-static-ninja-multi",
 			"inherits": "user-configure-static-windows-base",

cmake/adjust/flags.cmake

@@ -40,17 +40,57 @@ option(NBL_REQUEST_SSE_4_2 "Request compilation with SSE 4.2 instruction set ena
 option(NBL_REQUEST_SSE_AXV2 "Request compilation with SSE Intel Advanced Vector Extensions 2 for Nabla projects" ON)
 
 # profiles
-if(MSVC)
-	include("${CMAKE_CURRENT_LIST_DIR}/template/windows/msvc.cmake")
-elseif(ANDROID)
-	include("${CMAKE_CURRENT_LIST_DIR}/template/unix/android.cmake")
-elseif(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
-	include("${CMAKE_CURRENT_LIST_DIR}/template/unix/gnu.cmake")
-elseif(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
-	include("${CMAKE_CURRENT_LIST_DIR}/template/unix/clang.cmake")
-else()
-	message(WARNING "UNTESTED COMPILER DETECTED, EXPECT WRONG OPTIMIZATION FLAGS! SUBMIT ISSUE ON GITHUB https://github.com/Devsh-Graphics-Programming/Nabla/issues")
-endif()
+foreach(NBL_COMPILER_LANGUAGE IN ITEMS C CXX)
+    # all list of all known by CMake vendors:
+    # https://cmake.org/cmake/help/latest/variable/CMAKE_LANG_COMPILER_ID.html
+    set(NBL_COMPILER_VENDOR "${CMAKE_${NBL_COMPILER_LANGUAGE}_COMPILER_ID}")
+    set(NBL_PROFILE_NAME "${NBL_COMPILER_LANGUAGE}_${NBL_COMPILER_VENDOR}") # eg. "cxx_MSVC.cmake"
+    set(NBL_PROFILE_PATH "${CMAKE_CURRENT_LIST_DIR}/template/vendor/${NBL_PROFILE_NAME}.cmake")
+
+    include("${NBL_PROFILE_PATH}" RESULT_VARIABLE _NBL_FOUND_)
+
+    if(NOT _NBL_FOUND_)
+        message(WARNING "UNSUPPORTED \"${NBL_COMPILER_LANGUAGE}\" COMPILER LANGUAGE FOR \"${NBL_COMPILER_VENDOR}\" DETECTED, CMAKE CONFIGURATION OR BUILD MAY FAIL AND COMPILE OPTIONS FLAGS WILL NOT BE SET! SUBMIT ISSUE ON GITHUB https://github.com/Devsh-Graphics-Programming/Nabla/issues")
+        continue()
+    endif()
+
+    # a profile MUST define 
+        # - "NBL_${NBL_COMPILER_LANGUAGE}_${CONFIGURATION}_COMPILE_OPTIONS" (configuration dependent)
+        # - "NBL_${NBL_COMPILER_LANGUAGE}_COMPILE_OPTIONS" (global)
+
+    # a profile MUST NOT define
+        # - NBL_COMPILE_OPTIONS
+
+    set(NBL_COMPILE_OPTIONS_VAR_NAME NBL_${NBL_COMPILER_LANGUAGE}_COMPILE_OPTIONS)
+    set(NBL_COMPILE_OPTIONS_VAR_VALUE ${${NBL_COMPILE_OPTIONS_VAR_NAME}})
+
+    if(NOT DEFINED ${NBL_COMPILE_OPTIONS_VAR_NAME})
+        message(FATAL_ERROR "\"${NBL_PROFILE_PATH}\" did not define \"${NBL_COMPILE_OPTIONS_VAR_NAME}\"!")
+    endif()
+
+    # update map with configuration dependent compile options
+    foreach(CONFIGURATION IN ITEMS RELEASE RELWITHDEBINFO DEBUG)
+        set(NBL_CONFIGURATION_COMPILE_OPTIONS_VAR_NAME NBL_${NBL_COMPILER_LANGUAGE}_${CONFIGURATION}_COMPILE_OPTIONS)
+        set(NBL_CONFIGURATION_COMPILE_OPTIONS_VAR_VALUE ${${NBL_CONFIGURATION_COMPILE_OPTIONS_VAR_NAME}})
+
+        if(NOT DEFINED ${NBL_CONFIGURATION_COMPILE_OPTIONS_VAR_NAME})
+            message(FATAL_ERROR "\"${NBL_PROFILE_PATH}\" did not define \"${NBL_CONFIGURATION_COMPILE_OPTIONS_VAR_NAME}\"!")
+        endif()
+
+        list(APPEND NBL_${CONFIGURATION}_COMPILE_OPTIONS
+            # note that "${NBL_CONFIGURATION_COMPILE_OPTIONS_VAR_VALUE}" MUST NOT contain ANY 
+            # $<$<CONFIG:<>> generator expression in order to support our configuration mapping features
+            $<$<COMPILE_LANGUAGE:${NBL_COMPILER_LANGUAGE}>:${NBL_CONFIGURATION_COMPILE_OPTIONS_VAR_VALUE}>
+        )
+
+        set(NBL_${CONFIGURATION}_COMPILE_OPTIONS  ${NBL_${CONFIGURATION}_COMPILE_OPTIONS})
+    endforeach()
+
+    # update map with global compile options
+    list(APPEND NBL_COMPILE_OPTIONS $<$<COMPILE_LANGUAGE:${NBL_COMPILER_LANGUAGE}>:${NBL_${NBL_COMPILER_LANGUAGE}_COMPILE_OPTIONS}>)
+
+    set(NBL_COMPILE_OPTIONS ${NBL_COMPILE_OPTIONS})
+endforeach()
 
 function(NBL_EXT_P_APPEND_COMPILE_OPTIONS NBL_LIST_NAME MAP_RELEASE MAP_RELWITHDEBINFO MAP_DEBUG)		
 	macro(NBL_MAP_CONFIGURATION NBL_CONFIG_FROM NBL_CONFIG_TO)
@@ -173,7 +213,7 @@ function(nbl_adjust_flags)
 
 			set(MAPPED_CONFIG $<TARGET_GENEX_EVAL:${NBL_TARGET_ITEM},$<TARGET_PROPERTY:${NBL_TARGET_ITEM},NBL_CONFIGURATION_MAP>>)
 
-			if(MSVC)
+			if(MSVC AND CMAKE_CXX_COMPILER_ID STREQUAL MSVC)
 				if(NBL_SANITIZE_ADDRESS)
 					set(NBL_TARGET_MSVC_DEBUG_INFORMATION_FORMAT "$<$<OR:$<STREQUAL:${MAPPED_CONFIG},DEBUG>,$<STREQUAL:${MAPPED_CONFIG},RELWITHDEBINFO>>:ProgramDatabase>")
 				else()

cmake/adjust/template/vendor/CXX_Clang.cmake

@@ -0,0 +1,45 @@
+include_guard(GLOBAL)
+
+# Debug
+set(NBL_CXX_DEBUG_COMPILE_OPTIONS
+	-ggdb3 -Wall -fno-omit-frame-pointer -fstack-protector-strong
+)
+
+# Release
+set(NBL_CXX_RELEASE_COMPILE_OPTIONS
+	-fexpensive-optimizations
+)
+
+# RelWithDebInfo
+set(NBL_CXX_RELWITHDEBINFO_COMPILE_OPTIONS "")
+
+# Global
+list(APPEND NBL_CXX_COMPILE_OPTIONS
+	-Wextra
+	-fno-strict-aliasing
+	-msse4.2
+	-mfpmath=sse		
+	-Wextra
+	-Wno-sequence-point
+	-Wno-unused-parameter
+	-Wno-unused-but-set-parameter
+	-Wno-error=ignored-attributes
+	-Wno-error=unused-function
+	-Wno-error=unused-variable
+	-Wno-error=unused-parameter
+	-Wno-error=ignored-attributes
+	-Wno-error=non-pod-varargs
+	-fno-exceptions
+)
+
+if(NBL_SANITIZE_ADDRESS)
+	list(APPEND NBL_CXX_COMPILE_OPTIONS -fsanitize=address)
+endif()
+
+if(NBL_SANITIZE_THREAD)
+	list(APPEND NBL_CXX_COMPILE_OPTIONS -fsanitize=thread)
+endif()
+
+# our pervious flags-set function called this, does not affect flags nor configs so I will keep it here temporary
+# TODO: move it out from the profile
+link_libraries(-fuse-ld=gold)

cmake/adjust/template/vendor/CXX_MSVC.cmake

@@ -0,0 +1,46 @@
+include_guard(GLOBAL)
+
+# https://learn.microsoft.com/en-us/cpp/build/reference/arch-x64?view=msvc-170
+
+# The default instruction set is SSE2 if no /arch option is specified.
+if(NBL_REQUEST_SSE_4_2)
+	NBL_REQUEST_COMPILE_OPTION_SUPPORT("/arch:SSE4.2")
+endif()
+
+# Enables Intel Advanced Vector Extensions 2.
+if(NBL_REQUEST_SSE_AXV2)
+	NBL_REQUEST_COMPILE_OPTION_SUPPORT("/arch:AVX2")
+endif()
+
+# Debug
+set(NBL_CXX_DEBUG_COMPILE_OPTIONS
+	/Zc:__cplusplus /Ob0 /Od /MP${_NBL_JOBS_AMOUNT_} /fp:fast /Zc:wchar_t /INCREMENTAL
+)
+
+if(NBL_SANITIZE_ADDRESS)
+	list(APPEND NBL_CXX_DEBUG_COMPILE_OPTIONS /RTC1)
+endif()
+
+set(NBL_DEBUG_CXX_COMPILE_OPTIONS
+	$<$<COMPILE_LANGUAGE:CXX>:${NBL_CXX_DEBUG_COMPILE_OPTIONS}>
+)
+
+# Release
+set(NBL_CXX_RELEASE_COMPILE_OPTIONS
+	/Zc:__cplusplus /O2 /Ob2 /DNDEBUG /GL /MP${_NBL_JOBS_AMOUNT_} /Gy- /Zc:wchar_t /sdl- /GF /GS- /fp:fast
+)
+
+# RelWithDebInfo
+set(NBL_CXX_RELWITHDEBINFO_COMPILE_OPTIONS
+	/Zc:__cplusplus /O2 /Ob1 /DNDEBUG /GL /Zc:wchar_t /MP${_NBL_JOBS_AMOUNT_} /Gy /sdl- /Oy- /fp:fast
+)
+
+if(NBL_SANITIZE_ADDRESS)
+	list(APPEND NBL_CXX_COMPILE_OPTIONS /fsanitize=address)
+endif()
+
+# this should also be not part of profile, pasting from old flags-set function temporary
+# TODO: use profile
+
+#reason for INCREMENTAL:NO: https://docs.microsoft.com/en-us/cpp/build/reference/ltcg-link-time-code-generation?view=vs-2019 /LTCG is not valid for use with /INCREMENTAL.
+set(CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO "${CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO} /INCREMENTAL:NO /LTCG:incremental")

cmake/adjust/template/vendor/C_Clang.cmake

@@ -0,0 +1,46 @@
+include_guard(GLOBAL)
+
+# Debug
+set(NBL_C_DEBUG_COMPILE_OPTIONS
+	-ggdb3 -Wall -fno-omit-frame-pointer -fstack-protector-strong
+)
+
+# Release
+set(NBL_C_RELEASE_COMPILE_OPTIONS
+	-fexpensive-optimizations
+)
+
+# RelWithDebInfo
+set(NBL_C_RELWITHDEBINFO_COMPILE_OPTIONS "")
+
+# Global
+list(APPEND NBL_C_COMPILE_OPTIONS 
+	-Wextra
+	-fno-strict-aliasing
+	-msse4.2
+	-mfpmath=sse	
+	-maes	
+	-Wextra
+	-Wno-sequence-point
+	-Wno-unused-parameter
+	-Wno-unused-but-set-parameter
+	-Wno-error=ignored-attributes
+	-Wno-error=unused-function
+	-Wno-error=unused-variable
+	-Wno-error=unused-parameter
+	-Wno-error=ignored-attributes
+	-Wno-error=non-pod-varargs
+	-fno-exceptions
+)
+
+if(NBL_SANITIZE_ADDRESS)
+	list(APPEND NBL_C_COMPILE_OPTIONS -fsanitize=address)
+endif()
+
+if(NBL_SANITIZE_THREAD)
+	list(APPEND NBL_C_COMPILE_OPTIONS -fsanitize=thread)
+endif()
+
+# our pervious flags-set function called this, does not affect flags nor configs so I will keep it here temporary
+# TODO: move it out from the profile
+link_libraries(-fuse-ld=gold)

cmake/adjust/template/windows/msvc.cmake renamed to cmake/adjust/template/vendor/C_MSVC.cmake

@@ -21,51 +21,20 @@ if(NBL_SANITIZE_ADDRESS)
 	list(APPEND NBL_C_DEBUG_COMPILE_OPTIONS /RTC1)
 endif()
 
-set(NBL_CXX_DEBUG_COMPILE_OPTIONS
-	/Zc:__cplusplus ${NBL_C_DEBUG_COMPILE_OPTIONS}
-)
-
-set(NBL_DEBUG_COMPILE_OPTIONS
-	$<$<COMPILE_LANGUAGE:CXX>:${NBL_CXX_DEBUG_COMPILE_OPTIONS}>
-	$<$<COMPILE_LANGUAGE:C>:${NBL_C_DEBUG_COMPILE_OPTIONS}>
-)
-
 # Release
 set(NBL_C_RELEASE_COMPILE_OPTIONS
 	/O2 /Ob2 /DNDEBUG /GL /MP${_NBL_JOBS_AMOUNT_} /Gy- /Zc:wchar_t /sdl- /GF /GS- /fp:fast
 )
-set(NBL_CXX_RELEASE_COMPILE_OPTIONS
-	/Zc:__cplusplus ${NBL_C_RELEASE_COMPILE_OPTIONS}
-)
-
-set(NBL_RELEASE_COMPILE_OPTIONS
-	$<$<COMPILE_LANGUAGE:CXX>:${NBL_CXX_RELEASE_COMPILE_OPTIONS}>
-	$<$<COMPILE_LANGUAGE:C>:${NBL_C_RELEASE_COMPILE_OPTIONS}>
-)
 
 # RelWithDebInfo
 set(NBL_C_RELWITHDEBINFO_COMPILE_OPTIONS
 	/O2 /Ob1 /DNDEBUG /GL /Zc:wchar_t /MP${_NBL_JOBS_AMOUNT_} /Gy /sdl- /Oy- /fp:fast
 )
-set(NBL_CXX_RELWITHDEBINFO_COMPILE_OPTIONS
-	/Zc:__cplusplus ${NBL_C_RELWITHDEBINFO_COMPILE_OPTIONS}
-)
-
-set(NBL_RELWITHDEBINFO_COMPILE_OPTIONS
-	$<$<COMPILE_LANGUAGE:CXX>:${NBL_CXX_RELWITHDEBINFO_COMPILE_OPTIONS}>
-	$<$<COMPILE_LANGUAGE:C>:${NBL_C_RELWITHDEBINFO_COMPILE_OPTIONS}>
-)
 
 if(NBL_SANITIZE_ADDRESS)
 	list(APPEND NBL_C_COMPILE_OPTIONS /fsanitize=address)
-	list(APPEND NBL_CXX_COMPILE_OPTIONS ${NBL_C_COMPILE_OPTIONS})
 endif()
 
-set(NBL_COMPILE_OPTIONS
-	$<$<COMPILE_LANGUAGE:CXX>:${NBL_CXX_COMPILE_OPTIONS}>
-	$<$<COMPILE_LANGUAGE:C>:${NBL_C_COMPILE_OPTIONS}>
-)
-
 # this should also be not part of profile, pasting from old flags-set function temporary
 # TODO: use profile