CMakeLists.txt 11 KB

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