mirror/curl
2
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2025-02-17 14:59:45 +08:00
Code Issues Packages Projects Releases Wiki Activity
master
curl/CMake/FindLibpsl.cmake

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

84 lines
2.9 KiB
CMake
Raw Permalink Normal View History

cmake: add libpsl support Fixes #8865 Closes #8867
2022-05-19 21:29:54 +08:00
#***************************************************************************
# _ _ ____ _
# Project ___| | | | _ \| |
# / __| | | | |_) | |
# | (__| |_| | _ <| |___
# \___|\___/|_| \_\_____|
#
copyright: update all copyright lines and remove year ranges - they are mostly pointless in all major jurisdictions - many big corporations and projects already don't use them - saves us from pointless churn - git keeps history for us - the year range is kept in COPYING checksrc is updated to allow non-year using copyright statements Closes #10205
2023-01-02 20:51:48 +08:00
# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
cmake: add libpsl support Fixes #8865 Closes #8867
2022-05-19 21:29:54 +08:00
#
# 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
copyright: make repository REUSE compliant Add licensing and copyright information for all files in this repository. This either happens in the file itself as a comment header or in the file `.reuse/dep5`. This commit also adds a Github workflow to check pull requests and adapts copyright.pl to the changes. Closes #8869
2022-05-17 17:16:50 +08:00
#
cmake: add libpsl support Fixes #8865 Closes #8867
2022-05-19 21:29:54 +08:00
###########################################################################
cmake: more syntax tidy-up - quote string literals. In the hope it improves syntax-highlighting and readability. - use lowercase, underscore-prefixed local var names. As a hint for scope, to help readability. - prefer `pkg_search_module` (over `pkg_check_modules`). They are the same, but `pkg_search_module` stops searching at the first hit. - more `IN LISTS` in `foreach()`. - OtherTests.cmake: clear `CMAKE_EXTRA_INCLUDE_FILES` after use. - add `PROJECT_LABEL` for http/client and unit test targets. - sync `Find*` module comments and formatting. - drop a few local variables. - drop bogus `CARES_LIBRARIES` from comment. - unquote numeric literal. Follow-up to acbc6b703f6b0ee568d053f6f2565fbc107b5fd3 #14197 Closes #14388
2024-08-05 02:35:13 +08:00
# Find the libpsl library
cmake: add libpsl support Fixes #8865 Closes #8867
2022-05-19 21:29:54 +08:00
#
cmake: tidy up more in Find modules - add `NAMES` where missing. - document input variables (including deprecated ones.) - comment cleanups. - FindWolfSSL: drop stray `QUIET` from `pkg_check_modules()`. (`QUIET` may be re-added for all modules in the future.) Closes #14579
2024-08-18 05:39:49 +08:00
# Input variables:
#
cmake: document `-D` and env build options Extend `INSTALL-CMAKE` document with the list of available options, a short description and default values. The list may not be 100% complete. There are no component boundaries in CMake, so the line is blurry between curl options, CMake options, CMake Find modules options. I included certain CMake options that seemed useful, and/or have dedicated use withing curl's CMake source. But, all CMake built-in options are usable, as documented upstream in CMake. The naming of the options has a heritage and the inconsistencies with it, including a lack of clear namespace. This may be subject to future updates, also after figuring out which name has special meaning within CMake and/or CMake projects out of unwritten convention or something more tangible. CMake allows to initialize any internal variable via `-D`. This may be useful to pre-initialize/override feature check results. The list doesn't contain these, and they remain officially undocumented. Also: - make adjustments to keep the spellchecker happy. - retrofit description changes to the cmake sources. - stop documenting deprecated `Find*` variables. Reported-by: Daniel Stenberg Fixes https://github.com/curl/curl/discussions/14885 Closes #15388
2024-10-24 08:04:22 +08:00
# - `LIBPSL_INCLUDE_DIR`: The libpsl include directory.
# - `LIBPSL_LIBRARY`: Path to `libpsl` library.
cmake: tidy up more in Find modules - add `NAMES` where missing. - document input variables (including deprecated ones.) - comment cleanups. - FindWolfSSL: drop stray `QUIET` from `pkg_check_modules()`. (`QUIET` may be re-added for all modules in the future.) Closes #14579
2024-08-18 05:39:49 +08:00
#
# Result variables:
cmake: more syntax tidy-up - quote string literals. In the hope it improves syntax-highlighting and readability. - use lowercase, underscore-prefixed local var names. As a hint for scope, to help readability. - prefer `pkg_search_module` (over `pkg_check_modules`). They are the same, but `pkg_search_module` stops searching at the first hit. - more `IN LISTS` in `foreach()`. - OtherTests.cmake: clear `CMAKE_EXTRA_INCLUDE_FILES` after use. - add `PROJECT_LABEL` for http/client and unit test targets. - sync `Find*` module comments and formatting. - drop a few local variables. - drop bogus `CARES_LIBRARIES` from comment. - unquote numeric literal. Follow-up to acbc6b703f6b0ee568d053f6f2565fbc107b5fd3 #14197 Closes #14388
2024-08-05 02:35:13 +08:00
#
cmake: document `-D` and env build options Extend `INSTALL-CMAKE` document with the list of available options, a short description and default values. The list may not be 100% complete. There are no component boundaries in CMake, so the line is blurry between curl options, CMake options, CMake Find modules options. I included certain CMake options that seemed useful, and/or have dedicated use withing curl's CMake source. But, all CMake built-in options are usable, as documented upstream in CMake. The naming of the options has a heritage and the inconsistencies with it, including a lack of clear namespace. This may be subject to future updates, also after figuring out which name has special meaning within CMake and/or CMake projects out of unwritten convention or something more tangible. CMake allows to initialize any internal variable via `-D`. This may be useful to pre-initialize/override feature check results. The list doesn't contain these, and they remain officially undocumented. Also: - make adjustments to keep the spellchecker happy. - retrofit description changes to the cmake sources. - stop documenting deprecated `Find*` variables. Reported-by: Daniel Stenberg Fixes https://github.com/curl/curl/discussions/14885 Closes #15388
2024-10-24 08:04:22 +08:00
# - `LIBPSL_FOUND`: System has libpsl.
# - `LIBPSL_INCLUDE_DIRS`: The libpsl include directories.
# - `LIBPSL_LIBRARIES`: The libpsl library names.
cmake: add native `pkg-config` detection for remaining Find modules brotli, c-ares, libpsl, libssh2, nghttp2, nghttp3, ntgcp2, zstd. Also: Add workaround for CMake reporting successful libssh2 detection, but leaving the header directory empty, and causing `libssh2.h` not found while compiling. It happens when `pkgconf` is not detecting libssh2 dependency libcrypto in Homebrew after `brew unlink openssl` (as in GHA/macos). The workaround is to require a non-empty header directory to consider the detection successful. This workaround may need to be tweaked and/or applied to other Find modules. Follow-up to 7bab201abe3915a0167c002f9308950cb8a06e4b #15193 Closes #15408
2024-10-25 08:26:33 +08:00
# - `LIBPSL_LIBRARY_DIRS`: The libpsl library directories.
cmake: move `pkg-config` names to Find modules Make the Find modules set and return their respective `pkg-config` module name(s) to the CMake build process, which then adds those to the `Requires:` list. Before this patch, `pkg-config` module names were maintainted in two separate places. After this patch, they are maintained in the Find modules for dependencies that have one (most do). Re-align existing modules with this change: msh3, mbedtls, rustls. These modules return their `pkg-config` module name only when detected via `pkg-config`. Follow-up to d511ec8b0a56b2a99226fe556abe9f815153c648 #15573 Closes #15800
2024-12-22 18:30:45 +08:00
# - `LIBPSL_PC_REQUIRES`: The libpsl pkg-config packages.
cmake: add native `pkg-config` detection for remaining Find modules brotli, c-ares, libpsl, libssh2, nghttp2, nghttp3, ntgcp2, zstd. Also: Add workaround for CMake reporting successful libssh2 detection, but leaving the header directory empty, and causing `libssh2.h` not found while compiling. It happens when `pkgconf` is not detecting libssh2 dependency libcrypto in Homebrew after `brew unlink openssl` (as in GHA/macos). The workaround is to require a non-empty header directory to consider the detection successful. This workaround may need to be tweaked and/or applied to other Find modules. Follow-up to 7bab201abe3915a0167c002f9308950cb8a06e4b #15193 Closes #15408
2024-10-25 08:26:33 +08:00
# - `LIBPSL_CFLAGS`: Required compiler flags.
cmake: document `-D` and env build options Extend `INSTALL-CMAKE` document with the list of available options, a short description and default values. The list may not be 100% complete. There are no component boundaries in CMake, so the line is blurry between curl options, CMake options, CMake Find modules options. I included certain CMake options that seemed useful, and/or have dedicated use withing curl's CMake source. But, all CMake built-in options are usable, as documented upstream in CMake. The naming of the options has a heritage and the inconsistencies with it, including a lack of clear namespace. This may be subject to future updates, also after figuring out which name has special meaning within CMake and/or CMake projects out of unwritten convention or something more tangible. CMake allows to initialize any internal variable via `-D`. This may be useful to pre-initialize/override feature check results. The list doesn't contain these, and they remain officially undocumented. Also: - make adjustments to keep the spellchecker happy. - retrofit description changes to the cmake sources. - stop documenting deprecated `Find*` variables. Reported-by: Daniel Stenberg Fixes https://github.com/curl/curl/discussions/14885 Closes #15388
2024-10-24 08:04:22 +08:00
# - `LIBPSL_VERSION`: Version of libpsl.
cmake: add libpsl support Fixes #8865 Closes #8867
2022-05-19 21:29:54 +08:00
cmake: move `pkg-config` names to Find modules Make the Find modules set and return their respective `pkg-config` module name(s) to the CMake build process, which then adds those to the `Requires:` list. Before this patch, `pkg-config` module names were maintainted in two separate places. After this patch, they are maintained in the Find modules for dependencies that have one (most do). Re-align existing modules with this change: msh3, mbedtls, rustls. These modules return their `pkg-config` module name only when detected via `pkg-config`. Follow-up to d511ec8b0a56b2a99226fe556abe9f815153c648 #15573 Closes #15800
2024-12-22 18:30:45 +08:00
set(LIBPSL_PC_REQUIRES "libpsl")
cmake: add native `pkg-config` detection for remaining Find modules brotli, c-ares, libpsl, libssh2, nghttp2, nghttp3, ntgcp2, zstd. Also: Add workaround for CMake reporting successful libssh2 detection, but leaving the header directory empty, and causing `libssh2.h` not found while compiling. It happens when `pkgconf` is not detecting libssh2 dependency libcrypto in Homebrew after `brew unlink openssl` (as in GHA/macos). The workaround is to require a non-empty header directory to consider the detection successful. This workaround may need to be tweaked and/or applied to other Find modules. Follow-up to 7bab201abe3915a0167c002f9308950cb8a06e4b #15193 Closes #15408
2024-10-25 08:26:33 +08:00
if(CURL_USE_PKGCONFIG AND
NOT DEFINED LIBPSL_INCLUDE_DIR AND
NOT DEFINED LIBPSL_LIBRARY)
cmake: add missing `pkg-config` hints to Find modules - brotli, c-ares, libpsl, libssh2, mbedtls, rustls: Use `pkg-config` for path hints and version info. Syncing them up with the rest of Find modules. - GHA/macos: force-disable libssh2 with cmake to sync with autotools. After this patch, cmake auto-detects libssh2 in this job. Closes #14545
2024-08-13 17:20:00 +08:00
find_package(PkgConfig QUIET)
cmake: move `pkg-config` names to Find modules Make the Find modules set and return their respective `pkg-config` module name(s) to the CMake build process, which then adds those to the `Requires:` list. Before this patch, `pkg-config` module names were maintainted in two separate places. After this patch, they are maintained in the Find modules for dependencies that have one (most do). Re-align existing modules with this change: msh3, mbedtls, rustls. These modules return their `pkg-config` module name only when detected via `pkg-config`. Follow-up to d511ec8b0a56b2a99226fe556abe9f815153c648 #15573 Closes #15800
2024-12-22 18:30:45 +08:00
pkg_check_modules(LIBPSL ${LIBPSL_PC_REQUIRES})
cmake: add missing `pkg-config` hints to Find modules - brotli, c-ares, libpsl, libssh2, mbedtls, rustls: Use `pkg-config` for path hints and version info. Syncing them up with the rest of Find modules. - GHA/macos: force-disable libssh2 with cmake to sync with autotools. After this patch, cmake auto-detects libssh2 in this job. Closes #14545
2024-08-13 17:20:00 +08:00
endif()
cmake/FindLibpsl: protect against `pkg-config` "half-detection" Same issue as seen before with libssh2: `libpsl`'s pkg-config module depends on another module, but that's not found. CMake ends up reporting `LIBPSL_FOUND=YES`, while leaving `LIBPSL_INCLUDE_DIRS` empty. Then the build fails to find `psl.h`. The missing dependency in this case is `icu4c`, which is "keg-only", meaning it's not exposed in the default Homebrew header, pkg-config, lib, etc locations. It must be added to the `PKG_CONFIG_PATH` env, as suggested by the warnings messages of `pkgconf`. To avoid this fallout, let's ensure that `LIBPSL_INCLUDE_DIRS` is non-empty when detecting via `pkg-config` and fall back to the CMake detection method otherwise. This was an issue till Homebrew libpsl 0.21.5_1, fixed in 0.21.5_2, that no longer depends on `icu4c`. Example log: ``` -- Checking for module 'libpsl' -- Found libpsl, version 0.21.5 Package icu-uc was not found in the pkg-config search path. Perhaps you should add the directory containing `icu-uc.pc' to the PKG_CONFIG_PATH environment variable Package 'icu-uc', required by 'libpsl', not found [...] -- Found Libpsl (via pkg-config): (found version "0.21.5") [...] In file included from curl/_bld/lib/CMakeFiles/libcurl_static.dir/Unity/unity_0_c.c:4: In file included from curl/lib/altsvc.c:32: In file included from curl/lib/urldata.h:145: curl/lib/psl.h:28:10: fatal error: 'libpsl.h' file not found ^~~~~~~~~~ 1 error generated. ``` Follow-up to 39c741b7b008b5959980b29ac721357ff75de3f5 #15408 Closes #15827
2024-12-24 17:12:31 +08:00
if(LIBPSL_FOUND AND LIBPSL_INCLUDE_DIRS)
cmake/Find: set `<Modulename>_FOUND` for compatibility when found via `pkg-config` For Find modules where `<Modulename>` is not fully uppercase. `<Modulename>` is case-exact name used in the Find modules filename: `CMake/Find<Moduleame>.cmake`. `find_package_handle_standard_args()` sets both `<MODULENAME>_FOUND` and `<Modulename>_FOUND` when detecting the dependency. Some CMake code relies on this and 3rd-party code may rely on it too. Make sure to set the latter variant when detecting the dependency via `pkg-config`, where we don't call `find_package_handle_standard_args()`. CMake sets these variable to `TRUE` (not `ON` or `1`). Replicate this for compatibility. Closes #16153
2025-02-02 21:45:21 +08:00
set(Libpsl_FOUND TRUE)
cmake: add native `pkg-config` detection for remaining Find modules brotli, c-ares, libpsl, libssh2, nghttp2, nghttp3, ntgcp2, zstd. Also: Add workaround for CMake reporting successful libssh2 detection, but leaving the header directory empty, and causing `libssh2.h` not found while compiling. It happens when `pkgconf` is not detecting libssh2 dependency libcrypto in Homebrew after `brew unlink openssl` (as in GHA/macos). The workaround is to require a non-empty header directory to consider the detection successful. This workaround may need to be tweaked and/or applied to other Find modules. Follow-up to 7bab201abe3915a0167c002f9308950cb8a06e4b #15193 Closes #15408
2024-10-25 08:26:33 +08:00
string(REPLACE ";" " " LIBPSL_CFLAGS "${LIBPSL_CFLAGS}")
message(STATUS "Found Libpsl (via pkg-config): ${LIBPSL_INCLUDE_DIRS} (found version \"${LIBPSL_VERSION}\")")
else()
find_path(LIBPSL_INCLUDE_DIR NAMES "libpsl.h")
find_library(LIBPSL_LIBRARY NAMES "psl" "libpsl")
cmake: add libpsl support Fixes #8865 Closes #8867
2022-05-19 21:29:54 +08:00
cmake: add native `pkg-config` detection for remaining Find modules brotli, c-ares, libpsl, libssh2, nghttp2, nghttp3, ntgcp2, zstd. Also: Add workaround for CMake reporting successful libssh2 detection, but leaving the header directory empty, and causing `libssh2.h` not found while compiling. It happens when `pkgconf` is not detecting libssh2 dependency libcrypto in Homebrew after `brew unlink openssl` (as in GHA/macos). The workaround is to require a non-empty header directory to consider the detection successful. This workaround may need to be tweaked and/or applied to other Find modules. Follow-up to 7bab201abe3915a0167c002f9308950cb8a06e4b #15193 Closes #15408
2024-10-25 08:26:33 +08:00
unset(LIBPSL_VERSION CACHE)
if(LIBPSL_INCLUDE_DIR AND EXISTS "${LIBPSL_INCLUDE_DIR}/libpsl.h")
set(_version_regex "#[\t ]*define[\t ]+PSL_VERSION[\t ]+\"([^\"]*)\"")
file(STRINGS "${LIBPSL_INCLUDE_DIR}/libpsl.h" _version_str REGEX "${_version_regex}")
string(REGEX REPLACE "${_version_regex}" "\\1" _version_str "${_version_str}")
set(LIBPSL_VERSION "${_version_str}")
unset(_version_regex)
unset(_version_str)
endif()
cmake: add libpsl support Fixes #8865 Closes #8867
2022-05-19 21:29:54 +08:00
cmake: add native `pkg-config` detection for remaining Find modules brotli, c-ares, libpsl, libssh2, nghttp2, nghttp3, ntgcp2, zstd. Also: Add workaround for CMake reporting successful libssh2 detection, but leaving the header directory empty, and causing `libssh2.h` not found while compiling. It happens when `pkgconf` is not detecting libssh2 dependency libcrypto in Homebrew after `brew unlink openssl` (as in GHA/macos). The workaround is to require a non-empty header directory to consider the detection successful. This workaround may need to be tweaked and/or applied to other Find modules. Follow-up to 7bab201abe3915a0167c002f9308950cb8a06e4b #15193 Closes #15408
2024-10-25 08:26:33 +08:00
include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(Libpsl
REQUIRED_VARS
LIBPSL_INCLUDE_DIR
LIBPSL_LIBRARY
VERSION_VAR
LIBPSL_VERSION
)
cmake: add libpsl support Fixes #8865 Closes #8867
2022-05-19 21:29:54 +08:00
cmake: add native `pkg-config` detection for remaining Find modules brotli, c-ares, libpsl, libssh2, nghttp2, nghttp3, ntgcp2, zstd. Also: Add workaround for CMake reporting successful libssh2 detection, but leaving the header directory empty, and causing `libssh2.h` not found while compiling. It happens when `pkgconf` is not detecting libssh2 dependency libcrypto in Homebrew after `brew unlink openssl` (as in GHA/macos). The workaround is to require a non-empty header directory to consider the detection successful. This workaround may need to be tweaked and/or applied to other Find modules. Follow-up to 7bab201abe3915a0167c002f9308950cb8a06e4b #15193 Closes #15408
2024-10-25 08:26:33 +08:00
if(LIBPSL_FOUND)
set(LIBPSL_INCLUDE_DIRS ${LIBPSL_INCLUDE_DIR})
set(LIBPSL_LIBRARIES ${LIBPSL_LIBRARY})
endif()
cmake: add libpsl support Fixes #8865 Closes #8867
2022-05-19 21:29:54 +08:00
cmake: add native `pkg-config` detection for remaining Find modules brotli, c-ares, libpsl, libssh2, nghttp2, nghttp3, ntgcp2, zstd. Also: Add workaround for CMake reporting successful libssh2 detection, but leaving the header directory empty, and causing `libssh2.h` not found while compiling. It happens when `pkgconf` is not detecting libssh2 dependency libcrypto in Homebrew after `brew unlink openssl` (as in GHA/macos). The workaround is to require a non-empty header directory to consider the detection successful. This workaround may need to be tweaked and/or applied to other Find modules. Follow-up to 7bab201abe3915a0167c002f9308950cb8a06e4b #15193 Closes #15408
2024-10-25 08:26:33 +08:00
mark_as_advanced(LIBPSL_INCLUDE_DIR LIBPSL_LIBRARY)
cmake: sync up result variable names in Find modules - bearssl, c-ares, gss, libpsl, libssh2, mbedtls: Before this patch these Find modules returned results via `<NAME>_INCLUDE_DIR` and `<NAME>_LIBRARY`. This patch makes them return `<NAME>_INCLUDE_DIRS` (note the `S`) and `<NAME>_LIBRARIES` like other modules already did. - bearssl, mbedtls: Before this patch these Find modules allowed custom configuration via `<NAME>_INCLUDE_DIRS` (note the `S`). This patch makes them accept `<NAME>_INCLUDE_DIR`, like the rest of the modules did. Deprecate the old variables, but keep accepting them for compatibility. - bearssl: add missing `mark_as_advanced()` call. Closes #14542
2024-08-14 09:09:08 +08:00
endif()
Reference in New Issue Copy Permalink