]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
cmake: add shell completion support
authorViktor Szakats <commit@vsz.me>
Wed, 22 Jan 2025 14:13:47 +0000 (15:13 +0100)
committerViktor Szakats <commit@vsz.me>
Fri, 28 Mar 2025 12:51:38 +0000 (13:51 +0100)
Add the last (*) missing bit for feature parity with autotools.

Also test in CI. Add a new `cmake install` step to GHA/macos.

(*) AFAIK. Let us know if there's something else missing.

Closes #16833

.github/workflows/linux.yml
.github/workflows/macos.yml
CMakeLists.txt
docs/INSTALL-CMAKE.md
scripts/CMakeLists.txt [new file with mode: 0644]
scripts/Makefile.am

index 53f35da61a30c0429dfb1349605f8eb171ac83d7..3e4b54bb5516a01a29bf90ef6b77bbae5361cd11 100644 (file)
@@ -127,7 +127,7 @@ jobs:
           - name: mbedtls-pkg !pc
             install_packages: libnghttp2-dev libmbedtls-dev
             install_steps: skipall
-            generate: -DCURL_USE_MBEDTLS=ON -DENABLE_DEBUG=ON -DCURL_USE_PKGCONFIG=OFF
+            generate: -DCURL_USE_MBEDTLS=ON -DENABLE_DEBUG=ON -DCURL_USE_PKGCONFIG=OFF -DCURL_COMPLETION_FISH=ON -DCURL_COMPLETION_ZSH=ON
 
           - name: msh3
             install_packages: zlib1g-dev
index 181525487a8145e08defbcaad8b9e7538c16444d..4b471bc83bffc5f38a582c244bf145ac30581352 100644 (file)
@@ -134,8 +134,8 @@ jobs:
             install: gsasl rtmpdump
             generate: -DOPENSSL_ROOT_DIR=$(brew --prefix openssl) -DCURL_USE_GSASL=ON -DUSE_LIBRTMP=ON -DUSE_APPLE_IDN=ON
           - name: 'MultiSSL AppleIDN clang-tidy +examples'
-            install: llvm brotli zstd gnutls nettle mbedtls gsasl rtmpdump
-            generate: -DCURL_USE_OPENSSL=ON -DOPENSSL_ROOT_DIR=$(brew --prefix openssl) -DCURL_DEFAULT_SSL_BACKEND=openssl -DCURL_USE_GNUTLS=ON -DCURL_USE_MBEDTLS=ON -DENABLE_ARES=ON -DCURL_USE_GSASL=ON -DUSE_LIBRTMP=ON -DUSE_APPLE_IDN=ON -DUSE_SSLS_EXPORT=ON -DCURL_CLANG_TIDY=ON -DCLANG_TIDY=$(brew --prefix llvm)/bin/clang-tidy
+            install: llvm brotli zstd gnutls nettle mbedtls gsasl rtmpdump fish
+            generate: -DCURL_USE_OPENSSL=ON -DOPENSSL_ROOT_DIR=$(brew --prefix openssl) -DCURL_DEFAULT_SSL_BACKEND=openssl -DCURL_USE_GNUTLS=ON -DCURL_USE_MBEDTLS=ON -DENABLE_ARES=ON -DCURL_USE_GSASL=ON -DUSE_LIBRTMP=ON -DUSE_APPLE_IDN=ON -DUSE_SSLS_EXPORT=ON -DCURL_CLANG_TIDY=ON -DCLANG_TIDY=$(brew --prefix llvm)/bin/clang-tidy -DCURL_COMPLETION_FISH=ON -DCURL_COMPLETION_ZSH=ON
             clang-tidy: true
             chkprefill: _chkprefill
           - name: 'quictls +static libssh +examples'
@@ -239,6 +239,7 @@ jobs:
               [[ '${{ matrix.build.install_steps }}' = *'pytest'* ]] && options+=' -DTEST_NGHTTPX= -DHTTPD_NGHTTPX='
               [ "${_chkprefill}" = '_chkprefill' ] && options+=' -D_CURL_PREFILL=OFF'
               cmake -B "bld${_chkprefill}" -G Ninja -D_CURL_PREFILL=ON \
+                -DCMAKE_INSTALL_PREFIX="$HOME/curl" \
                 -DCMAKE_UNITY_BUILD=ON -DCURL_TEST_BUNDLES=ON -DCURL_WERROR=ON \
                 -DCMAKE_OSX_SYSROOT="${sysroot}" \
                 -DCMAKE_C_COMPILER_TARGET="$(uname -m | sed 's/arm64/aarch64/')-apple-darwin$(uname -r)" \
@@ -288,6 +289,10 @@ jobs:
       - name: 'curl version'
         run: bld/src/curl --disable --version
 
+      - name: 'cmake install'
+        if: ${{ matrix.build.generate }}
+        run: cmake --install bld --strip
+
       - name: 'build tests'
         run: |
           if [ -n '${{ matrix.build.generate }}' ]; then
index cdc1c8f43409f47546abbde1b99f1bb8a7792ce4..7052e1c51da647ae42dec9adea22e5bef19b687a 100644 (file)
@@ -2051,6 +2051,8 @@ if(HAVE_MANUAL_TOOLS)
   add_subdirectory(docs)
 endif()
 
+add_subdirectory(scripts)  # for shell completions
+
 list(REMOVE_DUPLICATES CURL_LIBDIRS)
 
 add_subdirectory(lib)
index b845cb0bd6d791ce1697db0382a44a039ed4f50c..ddfaeffd57a430b3373409d9955c8d1d41c66c6b 100644 (file)
@@ -229,6 +229,10 @@ target_link_libraries(my_target PRIVATE CURL::libcurl)
 - `BUILD_TESTING`:                          Build tests. Default: `ON`
 - `CURL_CLANG_TIDY`:                        Run the build through `clang-tidy`. Default: `OFF`
 - `CURL_CLANG_TIDYFLAGS`:                   Custom options to pass to `clang-tidy`. Default: (empty)
+- `CURL_COMPLETION_FISH`:                   Install fish completions. Default: `OFF`
+- `CURL_COMPLETION_FISH_DIR`:               Custom fish completion install directory.
+- `CURL_COMPLETION_ZSH`:                    Install zsh completions. Default: `OFF`
+- `CURL_COMPLETION_ZSH_DIR`:                Custom zsh completion install directory.
 - `CURL_DEFAULT_SSL_BACKEND`:               Override default TLS backend in MultiSSL builds.
                                             Accepted values in order of default priority:
                                             `wolfssl`, `gnutls`, `mbedtls`, `openssl`, `secure-transport`, `schannel`, `bearssl`, `rustls`
diff --git a/scripts/CMakeLists.txt b/scripts/CMakeLists.txt
new file mode 100644 (file)
index 0000000..8c98fbe
--- /dev/null
@@ -0,0 +1,86 @@
+#***************************************************************************
+#                                  _   _ ____  _
+#  Project                     ___| | | |  _ \| |
+#                             / __| | | | |_) | |
+#                            | (__| |_| |  _ <| |___
+#                             \___|\___/|_| \_\_____|
+#
+# Copyright (C) Viktor Szakats, et al.
+#
+# This software is licensed as described in the file COPYING, which
+# you should have received as part of this distribution. The terms
+# are also available at https://curl.se/docs/copyright.html.
+#
+# You may opt to use, copy, modify, merge, publish, distribute and/or sell
+# copies of the Software, and permit persons to whom the Software is
+# furnished to do so, under the terms of the COPYING file.
+#
+# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
+# KIND, either express or implied.
+#
+# SPDX-License-Identifier: curl
+#
+###########################################################################
+
+option(CURL_COMPLETION_FISH "Install fish completions" OFF)
+option(CURL_COMPLETION_ZSH "Install zsh completions" OFF)
+
+if(CURL_COMPLETION_FISH OR
+   CURL_COMPLETION_ZSH)
+  if(PERL_FOUND)
+    if(CURL_COMPLETION_FISH)
+      set(_completion_fish "curl.fish")
+      add_custom_command(OUTPUT "${_completion_fish}"
+        COMMAND "${PERL_EXECUTABLE}" "${CMAKE_CURRENT_SOURCE_DIR}/completion.pl"
+          --opts-dir "${PROJECT_SOURCE_DIR}/docs/cmdline-opts" --shell fish > "${_completion_fish}"
+        DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/completion.pl"
+        VERBATIM
+      )
+      add_custom_target("curl-completion-fish" ALL DEPENDS "${_completion_fish}")
+    endif()
+
+    if(CURL_COMPLETION_ZSH)
+      set(_completion_zsh "_curl")
+      add_custom_command(OUTPUT "${_completion_zsh}"
+        COMMAND "${PERL_EXECUTABLE}" "${CMAKE_CURRENT_SOURCE_DIR}/completion.pl"
+          --opts-dir "${PROJECT_SOURCE_DIR}/docs/cmdline-opts" --shell zsh > "${_completion_zsh}"
+        DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/completion.pl"
+        VERBATIM
+      )
+      add_custom_target("curl-completion-zsh" ALL DEPENDS "${_completion_zsh}")
+    endif()
+
+    if(NOT CURL_DISABLE_INSTALL)
+      if(NOT CMAKE_CROSSCOMPILING)
+        if(NOT CURL_COMPLETION_FISH_DIR)
+          find_package(PkgConfig QUIET)
+          pkg_get_variable(CURL_COMPLETION_FISH_DIR "fish" "completionsdir")
+          if(NOT _pkg_fish_completionsdir)
+            include(GNUInstallDirs)
+            if(CMAKE_INSTALL_DATAROOTDIR)
+              set(CURL_COMPLETION_FISH_DIR "${CMAKE_INSTALL_DATAROOTDIR}/fish/vendor_completions.d")
+            endif()
+          endif()
+        endif()
+        if(NOT CURL_COMPLETION_ZSH_DIR)
+          include(GNUInstallDirs)
+          if(CMAKE_INSTALL_DATAROOTDIR)
+            set(CURL_COMPLETION_ZSH_DIR "${CMAKE_INSTALL_DATAROOTDIR}/zsh/site-functions")
+          endif()
+        endif()
+        if(CURL_COMPLETION_FISH_DIR)
+          install(FILES "${CMAKE_CURRENT_BINARY_DIR}/${_completion_fish}"
+                  DESTINATION "${CURL_COMPLETION_FISH_DIR}")
+        endif()
+        if(CURL_COMPLETION_ZSH_DIR)
+          install(FILES "${CMAKE_CURRENT_BINARY_DIR}/${_completion_zsh}"
+                  DESTINATION "${CURL_COMPLETION_ZSH_DIR}")
+        endif()
+      else()
+        message(STATUS "We cannot install completion scripts when cross-compiling")
+      endif()
+    endif()
+  else()
+    message(WARNING "No perl: cannot generate completion script")
+  endif()
+endif()
index d54f271fe8ed1debc82df9f3860b0be9fed1e8b8..2c95179c5bf5a223d4c80b2c16d7349c5b1f3be3 100644 (file)
@@ -24,7 +24,8 @@
 
 EXTRA_DIST = coverage.sh completion.pl firefox-db2pem.sh checksrc.pl              \
   mk-ca-bundle.pl mk-unity.pl schemetable.c cd2nroff nroff2cd cdall cd2cd managen \
-  dmaketgz maketgz release-tools.sh verify-release cmakelint.sh mdlinkcheck
+  dmaketgz maketgz release-tools.sh verify-release cmakelint.sh mdlinkcheck       \
+  CMakeLists.txt
 
 ZSH_FUNCTIONS_DIR = @ZSH_FUNCTIONS_DIR@
 FISH_FUNCTIONS_DIR = @FISH_FUNCTIONS_DIR@