build: various cmake fixes (#21902)

* build: various cmake refactors and simplifications

- Add STATUS keyword to message to ensure messages are shown in the
  correct order.
- Remove DEPS_CXX_COMPILER as we don't rely on C++ for any of our
  dependencies.
- Simplify how msgpack and luv configure options are constructed.
- Rely on the default installation for luv instead of manually passing
  configure, build and install commands.
- Simplify return code conditional.

* build: remove CMAKE_OSX_ARCHITECTURES_ALT_SEP workaround

CMAKE_OSX_ARCHITECTURES_ALT_SEP was defined as a workaround to prevent
the shell from interpreting `;`, which CMake uses as a list separator.
However, the same thing can be achieved by instead passing
CMAKE_OSX_ARCHITECTURES as a cache variable instead, which is a more
idiomatic way of achieving the same thing.

* build: define CMAKE_BUILD_TYPE before adding it to BUILD_TYPE_STRING

The problem with the current setup is that CMAKE_BUILD_TYPE is defined
after BUILD_TYPE_STRING. BUILD_TYPE_STRING will then be empty on the
first run, meaning that dependencies are built without a build type.
However, since CMAKE_BUILD_TYPE is a cache variable its value will
persist in subsequent runs. On the second run BUILD_TYPE_STRING will
have the correct value, but it's a different value from the ones the
dependencies were built with. This will force some dependencies to be
built again.

Fixes https://github.com/neovim/neovim/issues/21672.

4 files changed, 27 insertions, 56 deletions

diff --git a/cmake.deps/CMakeLists.txt b/cmake.deps/CMakeLists.txt
index 10f1ccc6d9..7fd14ec83b 100644
--- a/cmake.deps/CMakeLists.txt
+++ b/cmake.deps/CMakeLists.txt
@@ -12,13 +12,13 @@ list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake" "${PROJECT_SOURCE_DI
 include(CheckCCompilerFlag)
 include(Util)
 
+set_default_buildtype()
+
 get_property(isMultiConfig GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
 if(NOT isMultiConfig)
   set(BUILD_TYPE_STRING -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE})
 endif()
 
-set_default_buildtype()
-
 set(DEFAULT_MAKE_CFLAGS CFLAGS+=-g)
 
 check_c_compiler_flag(-Og HAS_OG_FLAG)
@@ -107,27 +107,16 @@ endif()
 
 set(DEPS_C_COMPILER "${CMAKE_C_COMPILER}")
 
-if(CMAKE_CXX_COMPILER)
-  set(DEPS_CXX_COMPILER "${CMAKE_CXX_COMPILER}")
-endif()
-
 if(CMAKE_OSX_SYSROOT)
   set(DEPS_C_COMPILER "${DEPS_C_COMPILER} -isysroot${CMAKE_OSX_SYSROOT}")
-  if(DEPS_CXX_COMPILER)
-    set(DEPS_CXX_COMPILER "${DEPS_CXX_COMPILER} -isysroot${CMAKE_OSX_SYSROOT}")
-  endif()
 endif()
 
 if(CMAKE_OSX_ARCHITECTURES)
-  string(REPLACE ";" "|" CMAKE_OSX_ARCHITECTURES_ALT_SEP "${CMAKE_OSX_ARCHITECTURES}")
   # The LuaJIT build does not like being passed multiple `-arch` flags
   # so we handle a universal build the old-fashioned way.
   set(LUAJIT_C_COMPILER "${DEPS_C_COMPILER}")
   foreach(ARCH IN LISTS CMAKE_OSX_ARCHITECTURES)
     set(DEPS_C_COMPILER "${DEPS_C_COMPILER} -arch ${ARCH}")
-    if(DEPS_CXX_COMPILER)
-      set(DEPS_CXX_COMPILER "${DEPS_CXX_COMPILER} -arch ${ARCH}")
-    endif()
   endforeach()
 endif()
 
@@ -140,7 +129,7 @@ if(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
                     OUTPUT_STRIP_TRAILING_WHITESPACE)
     set(CMAKE_OSX_DEPLOYMENT_TARGET "${MACOS_VERSION}")
   endif()
-  message("-- Using deployment target ${CMAKE_OSX_DEPLOYMENT_TARGET}")
+  message(STATUS "Using deployment target ${CMAKE_OSX_DEPLOYMENT_TARGET}")
 endif()
 
 include(ExternalProject)
diff --git a/cmake.deps/cmake/BuildLuv.cmake b/cmake.deps/cmake/BuildLuv.cmake
index 1a599a9ee2..c37a870b3d 100644
--- a/cmake.deps/cmake/BuildLuv.cmake
+++ b/cmake.deps/cmake/BuildLuv.cmake
@@ -1,13 +1,12 @@
-set(LUV_SRC_DIR ${DEPS_BUILD_DIR}/src/luv)
 set(LUV_INCLUDE_FLAGS
   "-I${DEPS_INSTALL_DIR}/include -I${DEPS_INSTALL_DIR}/include/luajit-2.1")
 
-set(LUV_CONFIGURE_COMMAND_COMMON
-  ${CMAKE_COMMAND} ${LUV_SRC_DIR}
+set(LUV_CMAKE_ARGS
   -DCMAKE_GENERATOR=${CMAKE_GENERATOR}
+  -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
+  -DCMAKE_GENERATOR_PLATFORM=${CMAKE_GENERATOR_PLATFORM}
   ${BUILD_TYPE_STRING}
   -DCMAKE_INSTALL_PREFIX=${DEPS_INSTALL_DIR}
-  -DCMAKE_OSX_ARCHITECTURES=${CMAKE_OSX_ARCHITECTURES_ALT_SEP}
   -DLUA_BUILD_TYPE=System
   -DLUA_COMPAT53_DIR=${DEPS_BUILD_DIR}/src/lua-compat-5.3
   -DWITH_SHARED_LIBUV=ON
@@ -16,42 +15,33 @@ set(LUV_CONFIGURE_COMMAND_COMMON
   -DBUILD_MODULE=OFF)
 
 if(USE_BUNDLED_LUAJIT)
-  list(APPEND LUV_CONFIGURE_COMMAND_COMMON -DWITH_LUA_ENGINE=LuaJit)
+  list(APPEND LUV_CMAKE_ARGS -DWITH_LUA_ENGINE=LuaJit)
 elseif(USE_BUNDLED_LUA)
-  list(APPEND LUV_CONFIGURE_COMMAND_COMMON -DWITH_LUA_ENGINE=Lua)
+  list(APPEND LUV_CMAKE_ARGS -DWITH_LUA_ENGINE=Lua)
 else()
   find_package(LuaJit)
   if(LUAJIT_FOUND)
-    list(APPEND LUV_CONFIGURE_COMMAND_COMMON -DWITH_LUA_ENGINE=LuaJit)
+    list(APPEND LUV_CMAKE_ARGS -DWITH_LUA_ENGINE=LuaJit)
   else()
-    list(APPEND LUV_CONFIGURE_COMMAND_COMMON -DWITH_LUA_ENGINE=Lua)
+    list(APPEND LUV_CMAKE_ARGS -DWITH_LUA_ENGINE=Lua)
   endif()
 endif()
 
 if(USE_BUNDLED_LIBUV)
-  set(LUV_CONFIGURE_COMMAND_COMMON
-    ${LUV_CONFIGURE_COMMAND_COMMON}
+  list(APPEND LUV_CMAKE_ARGS
     -DCMAKE_PREFIX_PATH=${DEPS_INSTALL_DIR}
     -DLIBUV_LIBRARIES=uv_a)
 endif()
 
 if(MSVC)
-  set(LUV_CONFIGURE_COMMAND
-    ${LUV_CONFIGURE_COMMAND_COMMON}
-    -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
-    -DCMAKE_GENERATOR_PLATFORM=${CMAKE_GENERATOR_PLATFORM}
-    "-DCMAKE_C_FLAGS:STRING=${LUV_INCLUDE_FLAGS}"
-    # Make sure we use the same generator, otherwise we may
-    # accidentally end up using different MSVC runtimes
-    -DCMAKE_GENERATOR=${CMAKE_GENERATOR})
+  list(APPEND LUV_CMAKE_ARGS
+    "-DCMAKE_C_FLAGS:STRING=${LUV_INCLUDE_FLAGS}")
 else()
-  set(LUV_CONFIGURE_COMMAND
-    ${LUV_CONFIGURE_COMMAND_COMMON}
-    -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
+  list(APPEND LUV_CMAKE_ARGS
     "-DCMAKE_C_FLAGS:STRING=${LUV_INCLUDE_FLAGS} -fPIC")
   if(CMAKE_GENERATOR MATCHES "Unix Makefiles" AND
       (CMAKE_SYSTEM_NAME MATCHES ".*BSD" OR CMAKE_SYSTEM_NAME MATCHES "DragonFly"))
-      set(LUV_CONFIGURE_COMMAND ${LUV_CONFIGURE_COMMAND} -DCMAKE_MAKE_PROGRAM=gmake)
+      list(APPEND LUV_CMAKE_ARGS -DCMAKE_MAKE_PROGRAM=gmake)
   endif()
 endif()
 
@@ -77,10 +67,9 @@ ExternalProject_Add(luv-static
   DOWNLOAD_NO_PROGRESS TRUE
   DOWNLOAD_DIR ${DEPS_DOWNLOAD_DIR}/luv
   SOURCE_DIR ${DEPS_BUILD_DIR}/src/luv
-  CONFIGURE_COMMAND "${LUV_CONFIGURE_COMMAND}"
-  BUILD_COMMAND ${CMAKE_COMMAND} --build . --config $<CONFIG>
-  INSTALL_COMMAND ${CMAKE_COMMAND} --build . --target install --config $<CONFIG>
-  LIST_SEPARATOR |)
+  CMAKE_ARGS ${LUV_CMAKE_ARGS}
+  CMAKE_CACHE_ARGS
+    -DCMAKE_OSX_ARCHITECTURES:STRING=${CMAKE_OSX_ARCHITECTURES})
 
 list(APPEND THIRD_PARTY_DEPS luv-static)
 if(USE_BUNDLED_LUAJIT)
diff --git a/cmake.deps/cmake/BuildMsgpack.cmake b/cmake.deps/cmake/BuildMsgpack.cmake
index 3197ec45a1..9d112c57b1 100644
--- a/cmake.deps/cmake/BuildMsgpack.cmake
+++ b/cmake.deps/cmake/BuildMsgpack.cmake
@@ -1,23 +1,15 @@
 set(MSGPACK_CMAKE_ARGS
-  -DMSGPACK_BUILD_TESTS=OFF
-  -DMSGPACK_BUILD_EXAMPLES=OFF
-  -DCMAKE_INSTALL_PREFIX=${DEPS_INSTALL_DIR}
-  -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
-  -DCMAKE_OSX_ARCHITECTURES=${CMAKE_OSX_ARCHITECTURES_ALT_SEP}
-  "-DCMAKE_C_FLAGS:STRING=-fPIC"
-  -DCMAKE_GENERATOR=${CMAKE_GENERATOR})
-
-if(MSVC)
-  set(MSGPACK_CMAKE_ARGS
     -DMSGPACK_BUILD_TESTS=OFF
     -DMSGPACK_BUILD_EXAMPLES=OFF
     -DCMAKE_INSTALL_PREFIX=${DEPS_INSTALL_DIR}
     -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
+    -DCMAKE_GENERATOR=${CMAKE_GENERATOR}
     -DCMAKE_GENERATOR_PLATFORM=${CMAKE_GENERATOR_PLATFORM}
-    ${BUILD_TYPE_STRING}
-    # Make sure we use the same generator, otherwise we may
-    # accidentally end up using different MSVC runtimes
-    -DCMAKE_GENERATOR=${CMAKE_GENERATOR})
+    ${BUILD_TYPE_STRING})
+
+if(NOT MSVC)
+  list(APPEND MSGPACK_CMAKE_ARGS
+    "-DCMAKE_C_FLAGS:STRING=-fPIC")
 endif()
 
 if(USE_EXISTING_SRC_DIR)
@@ -29,6 +21,7 @@ ExternalProject_Add(msgpack
   DOWNLOAD_NO_PROGRESS TRUE
   DOWNLOAD_DIR ${DEPS_DOWNLOAD_DIR}/msgpack
   CMAKE_ARGS "${MSGPACK_CMAKE_ARGS}"
-  LIST_SEPARATOR |)
+  CMAKE_CACHE_ARGS
+    -DCMAKE_OSX_ARCHITECTURES:STRING=${CMAKE_OSX_ARCHITECTURES})
 
 list(APPEND THIRD_PARTY_DEPS msgpack)
diff --git a/cmake/GenerateVersion.cmake b/cmake/GenerateVersion.cmake
index 34993d9552..c092645140 100644
--- a/cmake/GenerateVersion.cmake
+++ b/cmake/GenerateVersion.cmake
@@ -7,7 +7,7 @@ execute_process(
   OUTPUT_STRIP_TRAILING_WHITESPACE
   RESULT_VARIABLE RES)
 
-if(RES AND NOT RES EQUAL 0)
+if(RES)
   message(STATUS "Using NVIM_VERSION: ${NVIM_VERSION}")
   file(WRITE "${OUTPUT}" "")
   return()