CMakeLists.txt 13 KB

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