df70a68984
Viktor Szakats
2025-10-07
Subject
cmake: support building some complicated examples, build them in CI
Binary
No binary (build failed)
Architecture & Compiler Flags
—
Build Log
(log yok)
Commit Diff GitHub →
.github/workflows/linux.yml +2 -2.github/workflows/macos.yml +2 -2docs/examples/CMakeLists.txt +31 -3docs/examples/Makefile.am +3 -2docs/examples/Makefile.inc +10 -6docs/examples/cacertinmem.c +2 -0docs/examples/multi-uv.c +3 -1docs/examples/multithread.c +2 -0docs/examples/sessioninfo.c +2 -0docs/examples/threaded-ssl.c +2 -1docs/examples/usercertinmem.c +2 -0
.github/workflows/linux.yml+2 -2
| @@ -109,10 +109,10 @@ jobs: | |
| configure: CC=clang LDFLAGS=-Wl,-rpath,/home/runner/mbedtls/lib --with-mbedtls=/home/runner/mbedtls --enable-debug --with-fish-functions-dir --with-zsh-functions-dir | |
| - name: 'mbedtls' | |
| - | install_packages: libnghttp2-dev |
| + | install_packages: libnghttp2-dev libuv1-dev |
| install_steps: mbedtls | |
| PKG_CONFIG_PATH: /home/runner/mbedtls/lib/pkgconfig # Requires v3.6.0 | |
| - | generate: -DCURL_USE_MBEDTLS=ON -DENABLE_DEBUG=ON |
| + | generate: -DCURL_USE_MBEDTLS=ON -DCURL_USE_LIBUV=ON -DENABLE_DEBUG=ON |
| - name: 'mbedtls-pkg MultiSSL !pc' | |
| install_packages: libnghttp2-dev libmbedtls-dev | |
.github/workflows/macos.yml+2 -2
| @@ -276,7 +276,7 @@ jobs: | |
| configure: --enable-debug --with-openssl=/opt/homebrew/opt/openssl | |
| tflags: --test-event | |
| # cmake | |
| - | - name: 'OpenSSL gsasl rtmp AppleIDN SecTrust' |
| + | - name: 'OpenSSL gsasl rtmp AppleIDN SecTrust +examples' |
| install: libnghttp3 libngtcp2 gsasl rtmpdump | |
| generate: -DOPENSSL_ROOT_DIR=/opt/homebrew/opt/openssl -DCURL_USE_GSASL=ON -DUSE_LIBRTMP=ON -DUSE_APPLE_IDN=ON -DUSE_NGTCP2=ON -DCURL_DISABLE_VERBOSE_STRINGS=ON -DUSE_APPLE_SECTRUST=ON | |
| - name: 'MultiSSL AppleIDN clang-tidy +examples' | |
| @@ -314,7 +314,7 @@ jobs: | |
| install: brotli mbedtls zstd | |
| install_steps: codeset-test | |
| generate: -DCURL_USE_MBEDTLS=ON -DCURL_DISABLE_LDAP=ON -DCURL_DEFAULT_SSL_BACKEND=mbedtls -DCURL_USE_OPENSSL=ON -DUSE_APPLE_IDN=ON | |
| - | - name: 'GnuTLS !ldap krb5' |
| + | - name: 'GnuTLS !ldap krb5 +examples' |
| install: gnutls nettle krb5 | |
| generate: -DENABLE_DEBUG=ON -DCURL_USE_GNUTLS=ON -DCURL_USE_OPENSSL=OFF -DCURL_USE_GSSAPI=ON -DGSS_ROOT_DIR=/opt/homebrew/opt/krb5 -DCURL_DISABLE_LDAP=ON -DUSE_SSLS_EXPORT=ON | |
| - name: 'aws-lc' | |
docs/examples/CMakeLists.txt+31 -3
| @@ -24,14 +24,22 @@ | |
| add_custom_target(curl-examples) | |
| - | # Get check_PROGRAMS variable |
| + | # Get check_PROGRAMS, COMPLICATED_MAY_BUILD, COMPLICATED_EXAMPLES variables |
| curl_transform_makefile_inc("Makefile.inc" "${CMAKE_CURRENT_BINARY_DIR}/Makefile.inc.cmake") | |
| include("${CMAKE_CURRENT_BINARY_DIR}/Makefile.inc.cmake") | |
| + | set(_with_deps "") |
| set(_all_src "") | |
| set(_all_canary "") | |
| set(_all "all") | |
| - | foreach(_target IN LISTS check_PROGRAMS _all) # keep '_all' last |
| + | foreach(_target IN LISTS COMPLICATED_MAY_BUILD check_PROGRAMS _all) # keep 'COMPLICATED_MAY_BUILD' first, and '_all' last |
| + | # Strip .c suffix from COMPLICATED_MAY_BUILD items |
| + | if(CMAKE_VERSION VERSION_GREATER_EQUAL 3.20) |
| + | cmake_path(GET _target STEM _target) |
| + | else() |
| + | get_filename_component(_target "${_target}" NAME_WE) |
| + | endif() |
| + | set(_more_libs "") |
| set(_target_name "curl-example-${_target}") | |
| if(_target STREQUAL "all") | |
| if(CMAKE_VERSION VERSION_GREATER_EQUAL 3.12) | |
| @@ -50,16 +58,36 @@ foreach(_target IN LISTS check_PROGRAMS _all) # keep '_all' last | |
| else() | |
| add_library(${_target_name} STATIC EXCLUDE_FROM_ALL ${_all_src}) | |
| endif() | |
| + | if(_with_deps) |
| + | set(_more_libs ${CURL_LIBS}) # If any examples required dependencies, link them |
| + | endif() |
| add_custom_target(curl-examples-build) # Special target to compile all tests quickly and build a single test to probe linkage | |
| add_dependencies(curl-examples-build ${_target_name} ${_all_canary}) # Include a full build of a single test | |
| else() | |
| + | # Check if the example requires a build option. Then check if that build option is enabled. |
| + | # If it is, link all dependencies to the example. |
| + | set(_requires_regex "/\\* Requires: ([A-Z0-9_]+) \\*/") |
| + | file(STRINGS "${_target}.c" _req REGEX "${_requires_regex}") |
| + | string(REGEX REPLACE "${_requires_regex}" "\\1" _req "${_req}") |
| + | if(_req) |
| + | if(${${_req}}) |
| + | string(APPEND _with_deps " ${_target}:${_req}") |
| + | set(_more_libs ${CURL_LIBS}) |
| + | else() |
| + | continue() # Option required, but not found |
| + | endif() |
| + | endif() |
| set(_all_canary ${_target_name}) # Save the last test for the curl-examples-build target | |
| list(APPEND _all_src "${_target}.c") | |
| add_executable(${_target_name} EXCLUDE_FROM_ALL "${_target}.c") | |
| add_dependencies(curl-examples ${_target_name}) | |
| endif() | |
| - | target_link_libraries(${_target_name} ${LIB_SELECTED} ${CURL_NETWORK_AND_TIME_LIBS}) |
| + | target_link_libraries(${_target_name} ${LIB_SELECTED} ${CURL_NETWORK_AND_TIME_LIBS} ${_more_libs}) |
| target_compile_definitions(${_target_name} PRIVATE "CURL_NO_OLDIES" | |
| "$<$<BOOL:${WIN32}>:WIN32_LEAN_AND_MEAN>" "$<$<BOOL:${MSVC}>:_CRT_SECURE_NO_DEPRECATE>") | |
| set_target_properties(${_target_name} PROPERTIES OUTPUT_NAME "${_target}" PROJECT_LABEL "Example ${_target}" UNITY_BUILD OFF) | |
| endforeach() | |
| + | |
| + | if(_with_deps) |
| + | message(STATUS "Enabled examples with dependencies:${_with_deps}") |
| + | endif() |
docs/examples/Makefile.am+3 -2
| @@ -24,7 +24,8 @@ | |
| AUTOMAKE_OPTIONS = foreign nostdinc | |
| - | EXTRA_DIST = CMakeLists.txt .checksrc README.md Makefile.example $(COMPLICATED_EXAMPLES) |
| + | EXTRA_DIST = CMakeLists.txt .checksrc README.md Makefile.example \ |
| + | $(COMPLICATED_MAY_BUILD) $(COMPLICATED_EXAMPLES) |
| # Specify our include paths here, and do it relative to $(top_srcdir) and | |
| # $(top_builddir), to ensure that these paths which belong to the library | |
| @@ -53,7 +54,7 @@ LDADD = $(top_builddir)/lib/libcurl.la | |
| # This might hold -Werror | |
| CFLAGS += @CURL_CFLAG_EXTRAS@ | |
| - | # Get check_PROGRAMS variable |
| + | # Get check_PROGRAMS, COMPLICATED_MAY_BUILD, COMPLICATED_EXAMPLES variables |
| include Makefile.inc | |
| all: $(check_PROGRAMS) | |
docs/examples/Makefile.inc+10 -6
| @@ -140,10 +140,19 @@ check_PROGRAMS = \ | |
| websocket-cb \ | |
| websocket-updown | |
| + | # These examples require external dependencies that may be available during |
| + | # the build. |
| + | COMPLICATED_MAY_BUILD = \ |
| + | cacertinmem.c \ |
| + | multi-uv.c \ |
| + | multithread.c \ |
| + | sessioninfo.c \ |
| + | threaded-ssl.c \ |
| + | usercertinmem.c |
| + | |
| # These examples require external dependencies that may not be commonly | |
| # available on POSIX systems, so do not bother attempting to compile them here. | |
| COMPLICATED_EXAMPLES = \ | |
| - | cacertinmem.c \ |
| crawler.c \ | |
| ephiperfifo.c \ | |
| evhiperfifo.c \ | |
| @@ -152,11 +161,6 @@ COMPLICATED_EXAMPLES = \ | |
| htmltidy.c \ | |
| htmltitle.cpp \ | |
| multi-event.c \ | |
| - | multi-uv.c \ |
| - | multithread.c \ |
| - | sessioninfo.c \ |
| smooth-gtk-thread.c \ | |
| - | threaded-ssl.c \ |
| - | usercertinmem.c \ |
| version-check.pl \ | |
| xmlstream.c | |
docs/examples/cacertinmem.c+2 -0
| @@ -26,6 +26,8 @@ | |
| * </DESC> | |
| */ | |
| + | /* Requires: USE_OPENSSL */ |
| + | |
| #include <openssl/err.h> | |
| #include <openssl/ssl.h> | |
| #include <curl/curl.h> | |
docs/examples/multi-uv.c+3 -1
| @@ -21,11 +21,11 @@ | |
| * SPDX-License-Identifier: curl | |
| * | |
| ***************************************************************************/ | |
| - | |
| /* <DESC> | |
| * multi_socket API using libuv | |
| * </DESC> | |
| */ | |
| + | |
| /* Use the socket_action interface to download multiple files in parallel, | |
| powered by libuv. | |
| @@ -34,6 +34,8 @@ | |
| See https://docs.libuv.org/en/v1.x/index.html libuv API documentation | |
| */ | |
| + | /* Requires: USE_LIBUV */ |
| + | |
| #include <stdio.h> | |
| #include <stdlib.h> | |
| #include <uv.h> | |
docs/examples/multithread.c+2 -0
| @@ -26,6 +26,8 @@ | |
| * </DESC> | |
| */ | |
| + | /* Requires: HAVE_PTHREAD_H */ |
| + | |
| #include <stdio.h> | |
| #include <pthread.h> | |
| #include <curl/curl.h> | |
docs/examples/sessioninfo.c+2 -0
| @@ -29,6 +29,8 @@ | |
| /* Note that this example currently requires curl to be linked against | |
| GnuTLS (and this program must also be linked against -lgnutls). */ | |
| + | /* Requires: USE_GNUTLS */ |
| + | |
| #ifndef CURL_DISABLE_DEPRECATION | |
| #define CURL_DISABLE_DEPRECATION | |
| #endif | |
docs/examples/threaded-ssl.c+2 -1
| @@ -36,7 +36,8 @@ | |
| * https://github.com/curl/curl/blob/curl-7_88_1/docs/examples/threaded-ssl.c | |
| */ | |
| - | #define USE_OPENSSL /* or USE_GNUTLS accordingly */ |
| + | /* Requires: HAVE_PTHREAD_H */ |
| + | /* Also requires TLS support to run */ |
| #include <stdio.h> | |
| #include <pthread.h> | |
docs/examples/usercertinmem.c+2 -0
| @@ -31,6 +31,8 @@ | |
| * must be used in real circumstances when a secure connection is required. | |
| */ | |
| + | /* Requires: USE_OPENSSL */ |
| + | |
| #ifndef OPENSSL_SUPPRESS_DEPRECATED | |
| #define OPENSSL_SUPPRESS_DEPRECATED | |
| #endif | |