CMakeLists.txt 14 KB

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