CMakeLists.txt 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371
  1. #[[
  2. Build options:
  3. * Standard BUILD_SHARED_LIBS is supported and sets HTTPLIB_SHARED default value.
  4. * HTTPLIB_USE_OPENSSL_IF_AVAILABLE (default on)
  5. * HTTPLIB_USE_ZLIB_IF_AVAILABLE (default on)
  6. * HTTPLIB_USE_BROTLI_IF_AVAILABLE (default on)
  7. * HTTPLIB_USE_ZSTD_IF_AVAILABLE (default on)
  8. * HTTPLIB_REQUIRE_OPENSSL (default off)
  9. * HTTPLIB_REQUIRE_ZLIB (default off)
  10. * HTTPLIB_REQUIRE_BROTLI (default off)
  11. * HTTPLIB_REQUIRE_ZSTD (default off)
  12. * HTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN (default on)
  13. * HTTPLIB_USE_NON_BLOCKING_GETADDRINFO (default on)
  14. * HTTPLIB_COMPILE (default off)
  15. * HTTPLIB_INSTALL (default on)
  16. * HTTPLIB_SHARED (default off) builds as a shared library (if HTTPLIB_COMPILE is ON)
  17. * HTTPLIB_TEST (default off)
  18. * BROTLI_USE_STATIC_LIBS - tells Cmake to use the static Brotli libs (only works if you have them installed).
  19. * OPENSSL_USE_STATIC_LIBS - tells Cmake to use the static OpenSSL libs (only works if you have them installed).
  20. -------------------------------------------------------------------------------
  21. After installation with Cmake, a find_package(httplib COMPONENTS OpenSSL ZLIB Brotli zstd) is available.
  22. This creates a httplib::httplib target (if found and if listed components are supported).
  23. It can be linked like so:
  24. target_link_libraries(your_exe httplib::httplib)
  25. The following will build & install for later use.
  26. Linux/macOS:
  27. mkdir -p build
  28. cd build
  29. cmake -DCMAKE_BUILD_TYPE=Release ..
  30. sudo cmake --build . --target install
  31. Windows:
  32. mkdir build
  33. cd build
  34. cmake ..
  35. runas /user:Administrator "cmake --build . --config Release --target install"
  36. -------------------------------------------------------------------------------
  37. These variables are available after you run find_package(httplib)
  38. * HTTPLIB_HEADER_PATH - this is the full path to the installed header (e.g. /usr/include/httplib.h).
  39. * HTTPLIB_IS_USING_OPENSSL - a bool for if OpenSSL support is enabled.
  40. * HTTPLIB_IS_USING_ZLIB - a bool for if ZLIB support is enabled.
  41. * HTTPLIB_IS_USING_BROTLI - a bool for if Brotli support is enabled.
  42. * HTTPLIB_IS_USING_ZSTD - a bool for if ZSTD support is enabled.
  43. * HTTPLIB_IS_USING_CERTS_FROM_MACOSX_KEYCHAIN - a bool for if support of loading system certs from the Apple Keychain is enabled.
  44. * HTTPLIB_IS_USING_NON_BLOCKING_GETADDRINFO - a bool for if nonblocking getaddrinfo is enabled.
  45. * HTTPLIB_IS_COMPILED - a bool for if the library is compiled, or otherwise header-only.
  46. * HTTPLIB_INCLUDE_DIR - the root path to httplib's header (e.g. /usr/include).
  47. * HTTPLIB_LIBRARY - the full path to the library if compiled (e.g. /usr/lib/libhttplib.so).
  48. * httplib_VERSION or HTTPLIB_VERSION - the project's version string.
  49. * HTTPLIB_FOUND - a bool for if the target was found.
  50. Want to use precompiled headers (Cmake feature since v3.16)?
  51. It's as simple as doing the following (before linking):
  52. target_precompile_headers(httplib::httplib INTERFACE "${HTTPLIB_HEADER_PATH}")
  53. -------------------------------------------------------------------------------
  54. ARCH_INDEPENDENT option of write_basic_package_version_file() requires Cmake v3.14
  55. ]]
  56. cmake_minimum_required(VERSION 3.14.0 FATAL_ERROR)
  57. # Get the CPPHTTPLIB_VERSION value and use it as a version
  58. # This gets the string with the CPPHTTPLIB_VERSION value from the header.
  59. # This is so the maintainer doesn't actually need to update this manually.
  60. file(STRINGS httplib.h _raw_version_string REGEX "CPPHTTPLIB_VERSION \"([0-9]+\\.[0-9]+\\.[0-9]+)\"")
  61. # Extracts just the version string itself from the whole string contained in _raw_version_string
  62. # since _raw_version_string would contain the entire line of code where it found the version string
  63. string(REGEX MATCH "([0-9]+\\.?)+" _httplib_version "${_raw_version_string}")
  64. project(httplib
  65. VERSION ${_httplib_version}
  66. LANGUAGES CXX
  67. DESCRIPTION "A C++ header-only HTTP/HTTPS server and client library."
  68. HOMEPAGE_URL "https://github.com/yhirose/cpp-httplib"
  69. )
  70. # Change as needed to set an OpenSSL minimum version.
  71. # This is used in the installed Cmake config file.
  72. set(_HTTPLIB_OPENSSL_MIN_VER "3.0.0")
  73. # Lets you disable C++ exception during CMake configure time.
  74. # The value is used in the install CMake config file.
  75. option(HTTPLIB_NO_EXCEPTIONS "Disable the use of C++ exceptions" OFF)
  76. # Allow for a build to require OpenSSL to pass, instead of just being optional
  77. option(HTTPLIB_REQUIRE_OPENSSL "Requires OpenSSL to be found & linked, or fails build." OFF)
  78. option(HTTPLIB_REQUIRE_ZLIB "Requires ZLIB to be found & linked, or fails build." OFF)
  79. # Allow for a build to casually enable OpenSSL/ZLIB support, but silently continue if not found.
  80. # Make these options so their automatic use can be specifically disabled (as needed)
  81. option(HTTPLIB_USE_OPENSSL_IF_AVAILABLE "Uses OpenSSL (if available) to enable HTTPS support." ON)
  82. option(HTTPLIB_USE_ZLIB_IF_AVAILABLE "Uses ZLIB (if available) to enable Zlib compression support." ON)
  83. # Lets you compile the program as a regular library instead of header-only
  84. option(HTTPLIB_COMPILE "If ON, uses a Python script to split the header into a compilable header & source file (requires Python v3)." OFF)
  85. # Lets you disable the installation (useful when fetched from another CMake project)
  86. option(HTTPLIB_INSTALL "Enables the installation target" ON)
  87. option(HTTPLIB_TEST "Enables testing and builds tests" OFF)
  88. option(HTTPLIB_REQUIRE_BROTLI "Requires Brotli to be found & linked, or fails build." OFF)
  89. option(HTTPLIB_USE_BROTLI_IF_AVAILABLE "Uses Brotli (if available) to enable Brotli decompression support." ON)
  90. option(HTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN "Enable feature to load system certs from the Apple Keychain." ON)
  91. option(HTTPLIB_USE_NON_BLOCKING_GETADDRINFO "Enables the non-blocking alternatives for getaddrinfo." ON)
  92. option(HTTPLIB_REQUIRE_ZSTD "Requires ZSTD to be found & linked, or fails build." OFF)
  93. option(HTTPLIB_USE_ZSTD_IF_AVAILABLE "Uses ZSTD (if available) to enable zstd support." ON)
  94. # Defaults to static library but respects standard BUILD_SHARED_LIBS if set
  95. include(CMakeDependentOption)
  96. cmake_dependent_option(HTTPLIB_SHARED "Build the library as a shared library instead of static. Has no effect if using header-only."
  97. "${BUILD_SHARED_LIBS}" HTTPLIB_COMPILE OFF
  98. )
  99. if(HTTPLIB_SHARED)
  100. set(HTTPLIB_LIB_TYPE SHARED)
  101. if(WIN32)
  102. # Necessary for Windows if building shared libs
  103. # See https://stackoverflow.com/a/40743080
  104. set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)
  105. endif()
  106. else()
  107. set(HTTPLIB_LIB_TYPE STATIC)
  108. endif()
  109. if(CMAKE_SYSTEM_NAME MATCHES "Windows")
  110. if(CMAKE_SYSTEM_VERSION)
  111. if(${CMAKE_SYSTEM_VERSION} VERSION_LESS "10.0.0")
  112. message(SEND_ERROR "Windows ${CMAKE_SYSTEM_VERSION} or lower is not supported. Please use Windows 10 or later.")
  113. endif()
  114. else()
  115. set(CMAKE_SYSTEM_VERSION "10.0.19041.0")
  116. message(WARNING "The target is Windows but CMAKE_SYSTEM_VERSION is not set, the default system version is set to Windows 10.")
  117. endif()
  118. endif()
  119. if(CMAKE_SIZEOF_VOID_P LESS 8)
  120. message(WARNING "Pointer size ${CMAKE_SIZEOF_VOID_P} is not supported. Please use a 64-bit compiler.")
  121. endif()
  122. # Set some variables that are used in-tree and while building based on our options
  123. set(HTTPLIB_IS_COMPILED ${HTTPLIB_COMPILE})
  124. set(HTTPLIB_IS_USING_CERTS_FROM_MACOSX_KEYCHAIN ${HTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN})
  125. set(HTTPLIB_IS_USING_NON_BLOCKING_GETADDRINFO ${HTTPLIB_USE_NON_BLOCKING_GETADDRINFO})
  126. # Threads needed for <thread> on some systems, and for <pthread.h> on Linux
  127. set(THREADS_PREFER_PTHREAD_FLAG TRUE)
  128. find_package(Threads REQUIRED)
  129. # Since Cmake v3.11, Crypto & SSL became optional when not specified as COMPONENTS.
  130. if(HTTPLIB_REQUIRE_OPENSSL)
  131. find_package(OpenSSL ${_HTTPLIB_OPENSSL_MIN_VER} COMPONENTS Crypto SSL REQUIRED)
  132. set(HTTPLIB_IS_USING_OPENSSL TRUE)
  133. elseif(HTTPLIB_USE_OPENSSL_IF_AVAILABLE)
  134. find_package(OpenSSL ${_HTTPLIB_OPENSSL_MIN_VER} COMPONENTS Crypto SSL QUIET)
  135. # Avoid a rare circumstance of not finding all components but the end-user did their
  136. # own call for OpenSSL, which might trick us into thinking we'd otherwise have what we wanted
  137. if (TARGET OpenSSL::SSL AND TARGET OpenSSL::Crypto)
  138. set(HTTPLIB_IS_USING_OPENSSL ${OPENSSL_FOUND})
  139. else()
  140. set(HTTPLIB_IS_USING_OPENSSL FALSE)
  141. endif()
  142. endif()
  143. if(HTTPLIB_REQUIRE_ZLIB)
  144. find_package(ZLIB REQUIRED)
  145. set(HTTPLIB_IS_USING_ZLIB TRUE)
  146. elseif(HTTPLIB_USE_ZLIB_IF_AVAILABLE)
  147. find_package(ZLIB QUIET)
  148. # FindZLIB doesn't have a ZLIB_FOUND variable, so check the target.
  149. if(TARGET ZLIB::ZLIB)
  150. set(HTTPLIB_IS_USING_ZLIB TRUE)
  151. endif()
  152. endif()
  153. # Adds our cmake folder to the search path for find_package
  154. # This is so we can use our custom FindBrotli.cmake
  155. list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
  156. if(HTTPLIB_REQUIRE_BROTLI)
  157. find_package(Brotli COMPONENTS encoder decoder common REQUIRED)
  158. set(HTTPLIB_IS_USING_BROTLI TRUE)
  159. elseif(HTTPLIB_USE_BROTLI_IF_AVAILABLE)
  160. find_package(Brotli COMPONENTS encoder decoder common QUIET)
  161. set(HTTPLIB_IS_USING_BROTLI ${Brotli_FOUND})
  162. endif()
  163. # NOTE: When using cpp-httplib as a subproject (e.g., via FetchContent), the zstd::libzstd target may not be visible in the parent project scope.
  164. # If you encounter a "target not found" error, see https://github.com/yhirose/cpp-httplib/issues/2313 for a workaround.
  165. if(HTTPLIB_REQUIRE_ZSTD)
  166. find_package(zstd)
  167. if(NOT zstd_FOUND)
  168. find_package(PkgConfig REQUIRED)
  169. pkg_check_modules(zstd REQUIRED IMPORTED_TARGET libzstd)
  170. add_library(zstd::libzstd ALIAS PkgConfig::zstd)
  171. endif()
  172. set(HTTPLIB_IS_USING_ZSTD TRUE)
  173. elseif(HTTPLIB_USE_ZSTD_IF_AVAILABLE)
  174. find_package(zstd QUIET)
  175. if(NOT zstd_FOUND)
  176. find_package(PkgConfig QUIET)
  177. if(PKG_CONFIG_FOUND)
  178. pkg_check_modules(zstd QUIET IMPORTED_TARGET libzstd)
  179. if(TARGET PkgConfig::zstd)
  180. add_library(zstd::libzstd ALIAS PkgConfig::zstd)
  181. endif()
  182. endif()
  183. endif()
  184. # Both find_package and PkgConf set a XXX_FOUND var
  185. set(HTTPLIB_IS_USING_ZSTD ${zstd_FOUND})
  186. endif()
  187. # Used for default, common dirs that the end-user can change (if needed)
  188. # like CMAKE_INSTALL_INCLUDEDIR or CMAKE_INSTALL_DATADIR
  189. include(GNUInstallDirs)
  190. if(HTTPLIB_COMPILE)
  191. # Put the split script into the build dir
  192. configure_file(split.py "${CMAKE_CURRENT_BINARY_DIR}/split.py"
  193. COPYONLY
  194. )
  195. # Needs to be in the same dir as the python script
  196. configure_file(httplib.h "${CMAKE_CURRENT_BINARY_DIR}/httplib.h"
  197. COPYONLY
  198. )
  199. # Used outside of this if-else
  200. set(_INTERFACE_OR_PUBLIC PUBLIC)
  201. # Brings in the Python3_EXECUTABLE path we can use.
  202. find_package(Python3 REQUIRED)
  203. # Actually split the file
  204. # Keeps the output in the build dir to not pollute the main dir
  205. execute_process(COMMAND ${Python3_EXECUTABLE} "${CMAKE_CURRENT_BINARY_DIR}/split.py"
  206. WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
  207. ERROR_VARIABLE _httplib_split_error
  208. )
  209. if(_httplib_split_error)
  210. message(FATAL_ERROR "Failed when trying to split cpp-httplib with the Python script.\n${_httplib_split_error}")
  211. endif()
  212. # split.py puts output in "out"
  213. set(_httplib_build_includedir "${CMAKE_CURRENT_BINARY_DIR}/out")
  214. add_library(${PROJECT_NAME} ${HTTPLIB_LIB_TYPE} "${_httplib_build_includedir}/httplib.cc")
  215. target_sources(${PROJECT_NAME}
  216. PUBLIC
  217. $<BUILD_INTERFACE:${_httplib_build_includedir}/httplib.h>
  218. $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/httplib.h>
  219. )
  220. set_target_properties(${PROJECT_NAME}
  221. PROPERTIES
  222. VERSION ${${PROJECT_NAME}_VERSION}
  223. SOVERSION "${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}"
  224. OUTPUT_NAME cpp-httplib
  225. )
  226. else()
  227. # This is for header-only.
  228. set(_INTERFACE_OR_PUBLIC INTERFACE)
  229. add_library(${PROJECT_NAME} INTERFACE)
  230. set(_httplib_build_includedir "${CMAKE_CURRENT_SOURCE_DIR}")
  231. endif()
  232. # Lets you address the target with httplib::httplib
  233. # Only useful if building in-tree, versus using it from an installation.
  234. add_library(${PROJECT_NAME}::${PROJECT_NAME} ALIAS ${PROJECT_NAME})
  235. # Require C++11
  236. target_compile_features(${PROJECT_NAME} ${_INTERFACE_OR_PUBLIC} cxx_std_11)
  237. target_include_directories(${PROJECT_NAME} SYSTEM ${_INTERFACE_OR_PUBLIC}
  238. $<BUILD_INTERFACE:${_httplib_build_includedir}>
  239. $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
  240. )
  241. target_link_libraries(${PROJECT_NAME} ${_INTERFACE_OR_PUBLIC}
  242. # Always require threads
  243. Threads::Threads
  244. # Needed for Windows libs on Mingw, as the pragma comment(lib, "xyz") aren't triggered.
  245. $<$<PLATFORM_ID:Windows>:ws2_32>
  246. $<$<PLATFORM_ID:Windows>:crypt32>
  247. # Needed for API from MacOS Security framework
  248. "$<$<AND:$<PLATFORM_ID:Darwin>,$<BOOL:${HTTPLIB_IS_USING_OPENSSL}>,$<BOOL:${HTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN}>>:-framework CFNetwork -framework CoreFoundation -framework Security>"
  249. # Needed for non-blocking getaddrinfo on MacOS
  250. "$<$<AND:$<PLATFORM_ID:Darwin>,$<BOOL:${HTTPLIB_USE_NON_BLOCKING_GETADDRINFO}>>:-framework CFNetwork -framework CoreFoundation>"
  251. # Can't put multiple targets in a single generator expression or it bugs out.
  252. $<$<BOOL:${HTTPLIB_IS_USING_BROTLI}>:Brotli::common>
  253. $<$<BOOL:${HTTPLIB_IS_USING_BROTLI}>:Brotli::encoder>
  254. $<$<BOOL:${HTTPLIB_IS_USING_BROTLI}>:Brotli::decoder>
  255. $<$<BOOL:${HTTPLIB_IS_USING_ZLIB}>:ZLIB::ZLIB>
  256. $<$<BOOL:${HTTPLIB_IS_USING_ZSTD}>:zstd::libzstd>
  257. $<$<BOOL:${HTTPLIB_IS_USING_OPENSSL}>:OpenSSL::SSL>
  258. $<$<BOOL:${HTTPLIB_IS_USING_OPENSSL}>:OpenSSL::Crypto>
  259. )
  260. # Set the definitions to enable optional features
  261. target_compile_definitions(${PROJECT_NAME} ${_INTERFACE_OR_PUBLIC}
  262. $<$<BOOL:${HTTPLIB_NO_EXCEPTIONS}>:CPPHTTPLIB_NO_EXCEPTIONS>
  263. $<$<BOOL:${HTTPLIB_IS_USING_BROTLI}>:CPPHTTPLIB_BROTLI_SUPPORT>
  264. $<$<BOOL:${HTTPLIB_IS_USING_ZLIB}>:CPPHTTPLIB_ZLIB_SUPPORT>
  265. $<$<BOOL:${HTTPLIB_IS_USING_ZSTD}>:CPPHTTPLIB_ZSTD_SUPPORT>
  266. $<$<BOOL:${HTTPLIB_IS_USING_OPENSSL}>:CPPHTTPLIB_OPENSSL_SUPPORT>
  267. $<$<AND:$<PLATFORM_ID:Darwin>,$<BOOL:${HTTPLIB_IS_USING_OPENSSL}>,$<BOOL:${HTTPLIB_IS_USING_CERTS_FROM_MACOSX_KEYCHAIN}>>:CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN>
  268. $<$<BOOL:${HTTPLIB_USE_NON_BLOCKING_GETADDRINFO}>:CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO>
  269. )
  270. # CMake configuration files installation directory
  271. set(_TARGET_INSTALL_CMAKEDIR "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}")
  272. include(CMakePackageConfigHelpers)
  273. # Configures the meta-file httplibConfig.cmake.in to replace variables with paths/values/etc.
  274. configure_package_config_file("cmake/${PROJECT_NAME}Config.cmake.in"
  275. "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
  276. INSTALL_DESTINATION "${_TARGET_INSTALL_CMAKEDIR}"
  277. # Passes the includedir install path
  278. PATH_VARS CMAKE_INSTALL_FULL_INCLUDEDIR
  279. )
  280. if(HTTPLIB_COMPILE)
  281. write_basic_package_version_file("${PROJECT_NAME}ConfigVersion.cmake"
  282. # Example: if you find_package(httplib 0.5.4)
  283. # then anything >= 0.5.4 and < 0.6 is accepted
  284. COMPATIBILITY SameMinorVersion
  285. )
  286. else()
  287. write_basic_package_version_file("${PROJECT_NAME}ConfigVersion.cmake"
  288. # Example: if you find_package(httplib 0.5.4)
  289. # then anything >= 0.5.4 and < 0.6 is accepted
  290. COMPATIBILITY SameMinorVersion
  291. # Tells Cmake that it's a header-only lib
  292. # Mildly useful for end-users :)
  293. ARCH_INDEPENDENT
  294. )
  295. endif()
  296. if(HTTPLIB_INSTALL)
  297. # Creates the export httplibTargets.cmake
  298. # This is strictly what holds compilation requirements
  299. # and linkage information (doesn't find deps though).
  300. install(TARGETS ${PROJECT_NAME} EXPORT httplibTargets)
  301. install(FILES "${_httplib_build_includedir}/httplib.h" TYPE INCLUDE)
  302. install(FILES
  303. "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
  304. "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
  305. # Install it so it can be used later by the httplibConfig.cmake file.
  306. # Put it in the same dir as our config file instead of a global path so we don't potentially stomp on other packages.
  307. "${CMAKE_CURRENT_SOURCE_DIR}/cmake/FindBrotli.cmake"
  308. DESTINATION ${_TARGET_INSTALL_CMAKEDIR}
  309. )
  310. # NOTE: This path changes depending on if it's on Windows or Linux
  311. install(EXPORT httplibTargets
  312. # Puts the targets into the httplib namespace
  313. # So this makes httplib::httplib linkable after doing find_package(httplib)
  314. NAMESPACE ${PROJECT_NAME}::
  315. DESTINATION ${_TARGET_INSTALL_CMAKEDIR}
  316. )
  317. # Install documentation & license
  318. # ex: /usr/share/doc/httplib/README.md and /usr/share/licenses/httplib/LICENSE
  319. install(FILES "README.md" DESTINATION "${CMAKE_INSTALL_DOCDIR}")
  320. install(FILES "LICENSE" DESTINATION "${CMAKE_INSTALL_DATADIR}/licenses/${PROJECT_NAME}")
  321. include(CPack)
  322. endif()
  323. if(HTTPLIB_TEST)
  324. include(CTest)
  325. add_subdirectory(test)
  326. endif()