Add editable dependency mode for local development

Author: AnastaZIuk

CMakeLists.txt

@@ -11,6 +11,7 @@ endif()
 option(WASM_AUTO_FETCH_TOOLS "Auto-download missing tools during configure" ON)
 option(WEBVULKAN_BUILD_TESTS "Build maintainer smoke tests" OFF)
 option(WEBVULKAN_ALLOW_DEP_UPDATES "Allow dependency git update during configure" OFF)
+option(WEBVULKAN_DEPS_EDITABLE "Use editable local dependency checkouts without automatic git reset/update" OFF)
 set(WASM_EMSDK_VERSION "latest" CACHE STRING "emsdk version or tag")
 set(WASM_EMSDK_GIT_URL "https://github.com/emscripten-core/emsdk.git" CACHE STRING "emsdk git repository URL")
 set(WASM_EMSDK_GIT_REF "14c18b569f55138fe4963924162244251f454fb0" CACHE STRING "Pinned emsdk git ref")
@@ -25,7 +26,7 @@ set(WASM_BUILD_DIR "${WEBVULKAN_BUILD_DIR}/wasm" CACHE PATH "WASM sub-build dire
 set(WEBVULKAN_EMSCRIPTEN_TOOLCHAIN_FILE "${PROJECT_SOURCE_DIR}/cmake/toolchains/WebVulkanEmscripten.cmake" CACHE FILEPATH "Custom Emscripten toolchain file")
 set(MESA_SRC_DIR "${WEBVULKAN_THIRDPARTY_DIR}/mesa" CACHE PATH "Path where Mesa is cloned")
 set(MESA_GIT_URL "https://github.com/Devsh-Graphics-Programming/mesa.git" CACHE STRING "Mesa git repository URL")
-set(MESA_GIT_REF "ca61cf8e8fcf6b2e57ca714ecc3fdb7d5699cf64" CACHE STRING "Pinned Mesa git ref")
+set(MESA_GIT_REF "caeeea677046411288c1a5155d81b27640aedd3a" CACHE STRING "Pinned Mesa git ref")
 set(MESA_WASM_BUILD_DIR "${WEBVULKAN_BUILD_DIR}/mesa-wasm" CACHE PATH "Mesa WASM build directory")
 set(LLVM_SRC_DIR "${WEBVULKAN_THIRDPARTY_DIR}/llvm-project" CACHE PATH "Path where llvm-project is cloned")
 set(LLVM_HOST_BUILD_DIR "${WEBVULKAN_BUILD_DIR}/llvm-host-tools" CACHE PATH "LLVM host tools build directory")
@@ -58,7 +59,10 @@ endif()
 
 set(CPM_SOURCE_CACHE "${WEBVULKAN_CPM_SOURCE_CACHE}" CACHE PATH "CPM source cache path" FORCE)
 set(FETCHCONTENT_QUIET OFF)
-if(WEBVULKAN_ALLOW_DEP_UPDATES)
+if(WEBVULKAN_DEPS_EDITABLE)
+  set(_WEBVULKAN_FETCH_UPDATES_DISCONNECTED ON)
+  message(STATUS "WEBVULKAN_DEPS_EDITABLE=ON: local dependency checkouts are used without remote updates")
+elseif(WEBVULKAN_ALLOW_DEP_UPDATES)
   set(_WEBVULKAN_FETCH_UPDATES_DISCONNECTED OFF)
 else()
   set(_WEBVULKAN_FETCH_UPDATES_DISCONNECTED ON)

cmake/FetchWebVulkanSources.cmake

@@ -65,6 +65,17 @@ function(webvulkan_fetch_git_source NAME)
   _webvulkan_state_file_for_source("${NAME}" _state_file)
   _webvulkan_source_state_key("${FETCH_REPOSITORY}" "${FETCH_TAG}" _state_key)
 
+  set(_editable_mode OFF)
+  if(DEFINED WEBVULKAN_DEPS_EDITABLE AND WEBVULKAN_DEPS_EDITABLE)
+    set(_editable_mode ON)
+  endif()
+
+  if(EXISTS "${FETCH_SOURCE_DIR}/.git" AND _editable_mode)
+    file(WRITE "${_state_file}" "${_state_key}\n")
+    message(STATUS "Using editable source for ${NAME} from ${FETCH_SOURCE_DIR}")
+    return()
+  endif()
+
   set(_should_fetch ON)
   if(EXISTS "${FETCH_SOURCE_DIR}/.git")
     set(_should_fetch OFF)

tests/CMakeLists.txt

@@ -5,8 +5,10 @@ if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
 endif()
 
 set(WEBVULKAN_TEST_THIRDPARTY_DIR "${CMAKE_CURRENT_LIST_DIR}/../.3rdparty/tests" CACHE PATH "Test-only third-party root directory")
+set(WEBVULKAN_THIRDPARTY_STATE_DIR "${CMAKE_CURRENT_LIST_DIR}/../.3rdparty/.state" CACHE PATH "State directory for fetched third-party metadata")
 set(WEBVULKAN_VOLK_GIT_URL "https://github.com/zeux/volk.git" CACHE STRING "volk git repository URL for smoke tests")
 set(WEBVULKAN_VOLK_GIT_REF "1.4.304" CACHE STRING "Pinned volk git ref for smoke tests")
+set(WEBVULKAN_TEST_VOLK_SOURCE_DIR "${WEBVULKAN_TEST_THIRDPARTY_DIR}/volk" CACHE PATH "Path where volk is cloned for smoke tests")
 
 set(WEBVULKAN_TEST_MODE "auto" CACHE STRING "Test mode: auto, in-tree, or package")
 set_property(CACHE WEBVULKAN_TEST_MODE PROPERTY STRINGS auto in-tree package)
@@ -26,7 +28,13 @@ if(NOT COMMAND CPMAddPackage)
   if(NOT DEFINED WEBVULKAN_ALLOW_DEP_UPDATES)
     set(WEBVULKAN_ALLOW_DEP_UPDATES OFF CACHE BOOL "Allow dependency git update during configure")
   endif()
-  if(WEBVULKAN_ALLOW_DEP_UPDATES)
+  set(_webvulkan_allow_dep_updates "${WEBVULKAN_ALLOW_DEP_UPDATES}")
+  if(NOT DEFINED WEBVULKAN_DEPS_EDITABLE)
+    set(WEBVULKAN_DEPS_EDITABLE OFF CACHE BOOL "Use editable local dependency checkouts without automatic git reset/update")
+  endif()
+  if(WEBVULKAN_DEPS_EDITABLE)
+    set(CPM_UPDATE_DISCONNECTED ON CACHE BOOL "CPM update disconnected mode" FORCE)
+  elseif(_webvulkan_allow_dep_updates)
     set(CPM_UPDATE_DISCONNECTED OFF CACHE BOOL "CPM update disconnected mode" FORCE)
   else()
     set(CPM_UPDATE_DISCONNECTED ON CACHE BOOL "CPM update disconnected mode" FORCE)
@@ -95,13 +103,31 @@ if(NOT SUBBUILD_GENERATOR)
   message(FATAL_ERROR "No CMake generator is available for wasm smoke sub-build")
 endif()
 
-CPMAddPackage(
-  NAME webvulkan_volk
-  GIT_REPOSITORY "${WEBVULKAN_VOLK_GIT_URL}"
-  GIT_TAG "${WEBVULKAN_VOLK_GIT_REF}"
-  GIT_SHALLOW TRUE
-  DOWNLOAD_ONLY YES
-)
+if(NOT COMMAND webvulkan_fetch_git_source)
+  set(_webvulkan_root_fetch_sources "${CMAKE_CURRENT_LIST_DIR}/../cmake/FetchWebVulkanSources.cmake")
+  if(EXISTS "${_webvulkan_root_fetch_sources}")
+    include("${_webvulkan_root_fetch_sources}")
+  endif()
+endif()
+
+if(COMMAND webvulkan_fetch_git_source)
+  webvulkan_fetch_git_source(webvulkan_volk
+    REPOSITORY "${WEBVULKAN_VOLK_GIT_URL}"
+    TAG "${WEBVULKAN_VOLK_GIT_REF}"
+    SOURCE_DIR "${WEBVULKAN_TEST_VOLK_SOURCE_DIR}"
+  )
+  set(webvulkan_volk_SOURCE_DIR "${WEBVULKAN_TEST_VOLK_SOURCE_DIR}")
+else()
+  CPMAddPackage(
+    NAME webvulkan_volk
+    GIT_REPOSITORY "${WEBVULKAN_VOLK_GIT_URL}"
+    GIT_TAG "${WEBVULKAN_VOLK_GIT_REF}"
+    GIT_SHALLOW TRUE
+    GIT_REMOTE_UPDATE_STRATEGY CHECKOUT
+    SOURCE_DIR "${WEBVULKAN_TEST_VOLK_SOURCE_DIR}"
+    DOWNLOAD_ONLY YES
+  )
+endif()
 set(_webvulkan_volk_include_dir "${webvulkan_volk_SOURCE_DIR}")
 set(_webvulkan_volk_source "${webvulkan_volk_SOURCE_DIR}/volk.c")
 set(_webvulkan_volk_header "${webvulkan_volk_SOURCE_DIR}/volk.h")