CMakeLists.txt 14 KB

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