CMakeLists.txt 12 KB

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