Merge pull request #413 from Devsh-Graphics-Programming/git-submodules

New approach of updating submodules in CMake

Author: AnastaZIuk

3rdparty/CMakeLists.txt

@@ -4,35 +4,6 @@
 
 include(../cmake/common.cmake)
 
-# mandatory
-option(NBL_UPDATE_GIT_SUBMODULE "" ON)
-
-if(NBL_UPDATE_GIT_SUBMODULE)
-	update_git_submodule(./volk)
-	update_git_submodule(./SPIRV-Headers)
-	update_git_submodule(./SPIRV-Tools)
-	update_git_submodule(./glslang)
-	update_git_submodule(./shaderc)
-	update_git_submodule(./bzip2)
-	update_git_submodule(./lz4)
-	update_git_submodule(./nbl_spirv_cross)
-	update_git_submodule(./zlib)
-	update_git_submodule(./openexr)
-	update_git_submodule(./libpng)
-	update_git_submodule(./openssl)
-	update_git_submodule(./libjpeg-turbo)
-	update_git_submodule(./parallel-hashmap)
-	update_git_submodule(./gli)
-	# exceptions that get automatically cloned
-	update_git_submodule(./glm)
-	update_git_submodule(./freetype2)
-	update_git_submodule(./portable-file-dialogs)
-	update_git_submodule(./simdjson)
-	update_git_submodule(./glTFSampleModels)
-	update_git_submodule(./pstl/oneTBB)
-	update_git_submodule(./pstl/oneDPL/oneDPL)
-endif()
-
 # simdjson
 set(_OLD_BUILD_SHARED_LIBS ${BUILD_SHARED_LIBS})
 set(_OLD_BUILD_STATIC_LIBS ${BUILD_STATIC_LIBS})

CMakeLists.txt

@@ -287,12 +287,12 @@ option(NBL_BUILD_DOCS "Enable building documentation?" OFF) # No one has doxygen
 set(THIRD_PARTY_SOURCE_DIR "${PROJECT_SOURCE_DIR}/3rdparty")
 set(THIRD_PARTY_BINARY_DIR "${PROJECT_BINARY_DIR}/3rdparty")
 
-if(NBL_UPDATE_GIT_SUBMODULE)
-execute_process(COMMAND git submodule init
-		WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}")
-execute_process(COMMAND git submodule sync --recursive
-		WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}")
-endif()
+option(NBL_UPDATE_GIT_SUBMODULE "Turn this ON to let CMake update all public submodules for you" ON)
+option(NBL_UPDATE_GIT_SUBMODULE_INCLUDE_PRIVATE "Turn this ON to attempt to update private Nabla submodules" OFF)
+find_package(Git REQUIRED)
+include(common)
+
+NBL_UPDATE_SUBMODULES()
 add_subdirectory(${THIRD_PARTY_SOURCE_DIR})
 
 OPTION(NBL_EMBED_BUILTIN_RESOURCES "Embed built-in resources?" ON)

cmake/FindGitBash.cmake

@@ -0,0 +1,11 @@
+if(NOT DEFINED GIT_EXECUTABLE)
+	message(FATAL_ERROR "GIT_EXECUTABLE must be defined!")
+endif()
+
+cmake_path(GET GIT_EXECUTABLE PARENT_PATH _GIT_CMD_INSTALL_DIR_) # /cmd directory
+cmake_path(GET _GIT_CMD_INSTALL_DIR_ PARENT_PATH _GIT_INSTALL_DIR_) # /Git directory
+
+find_program(GIT_BASH_EXECUTABLE NAMES "git-bash.exe" PATHS "${_GIT_INSTALL_DIR_}")
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(GitBash REQUIRED_VARS GIT_BASH_EXECUTABLE)

cmake/common.cmake

@@ -638,3 +638,62 @@ endmacro()
 macro(write_source_definitions NBL_FILE NBL_WRAPPER_CODE_TO_WRITE)
 	file(WRITE "${NBL_FILE}" "${NBL_WRAPPER_CODE_TO_WRITE}")
 endmacro()
+
+function(NBL_UPDATE_SUBMODULES)
+	macro(NBL_WRAPPER_COMMAND GIT_RELATIVE_ENTRY GIT_SUBMODULE_PATH SHOULD_RECURSIVE)
+		set(SHOULD_RECURSIVE ${SHOULD_RECURSIVE})
+	
+		if(SHOULD_RECURSIVE)
+			string(APPEND _NBL_UPDATE_SUBMODULES_COMMANDS_ "\"${GIT_EXECUTABLE}\" -C \"${NBL_ROOT_PATH}/${GIT_RELATIVE_ENTRY}\" submodule update --init --recursive ${GIT_SUBMODULE_PATH}\n")
+		else()
+			string(APPEND _NBL_UPDATE_SUBMODULES_COMMANDS_ "\"${GIT_EXECUTABLE}\" -C \"${NBL_ROOT_PATH}/${GIT_RELATIVE_ENTRY}\" submodule update --init ${GIT_SUBMODULE_PATH}\n")
+		endif()
+	endmacro()
+	
+	if(NBL_UPDATE_GIT_SUBMODULE)
+		execute_process(COMMAND ${CMAKE_COMMAND} -E echo "All submodules are about to get updated and initialized in repository because NBL_UPDATE_GIT_SUBMODULE is turned ON!")
+		set(_NBL_UPDATE_SUBMODULES_CMD_NAME_ "nbl-update-submodules")
+		set(_NBL_UPDATE_SUBMODULES_CMD_FILE_ "${NBL_ROOT_PATH_BINARY}/${_NBL_UPDATE_SUBMODULES_CMD_NAME_}.cmd")
+		message(STATUS "test")
+		if(NBL_UPDATE_GIT_SUBMODULE_INCLUDE_PRIVATE)
+			NBL_WRAPPER_COMMAND("" "" TRUE)
+		else()
+			NBL_WRAPPER_COMMAND("" ./3rdparty TRUE)
+			#NBL_WRAPPER_COMMAND("" ./ci TRUE) TODO: enable it once we merge Ditt, etc
+			NBL_WRAPPER_COMMAND("" ./examples_tests FALSE)
+			NBL_WRAPPER_COMMAND(examples_tests ./media FALSE)
+		endif()
+				
+		file(WRITE "${_NBL_UPDATE_SUBMODULES_CMD_FILE_}" "${_NBL_UPDATE_SUBMODULES_COMMANDS_}")
+
+		if(WIN32)
+			find_package(GitBash REQUIRED)
+		
+			execute_process(COMMAND "${GIT_BASH_EXECUTABLE}" "-c"
+[=[
+>&2 echo ""
+clear
+./nbl-update-submodules.cmd 2>&1 | tee nbl-update-submodules.log
+sleep 1
+clear
+tput setaf 2; echo -e "Submodules have been updated! 
+Created nbl-update-submodules.log in your build directory. 
+This window will be closed in 5 seconds..."
+sleep 5
+]=]
+				WORKING_DIRECTORY ${NBL_ROOT_PATH_BINARY}
+				OUTPUT_VARIABLE _NBL_TMP_OUTPUT_
+				RESULT_VARIABLE _NBL_TMP_RET_CODE_
+				OUTPUT_STRIP_TRAILING_WHITESPACE
+				ERROR_STRIP_TRAILING_WHITESPACE
+			)
+
+			unset(_NBL_TMP_OUTPUT_)
+			unset(_NBL_TMP_RET_CODE_)
+		else()
+			execute_process(COMMAND "${_NBL_UPDATE_SUBMODULES_CMD_FILE_}")
+		endif()
+	else()
+		execute_process(COMMAND ${CMAKE_COMMAND} -E echo "NBL_UPDATE_GIT_SUBMODULE is turned OFF therefore submodules won't get updated.")
+	endif()
+endfunction()