CMakeLists.txt 12 KB

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