mirror of
https://github.com/gabime/spdlog.git
synced 2024-12-15 08:01:30 +08:00
375 lines
16 KiB
CMake
375 lines
16 KiB
CMake
# Copyright(c) 2019 spdlog authors Distributed under the MIT License (http://opensource.org/licenses/MIT)
|
|
|
|
cmake_minimum_required(VERSION 3.10...3.21)
|
|
|
|
# ---------------------------------------------------------------------------------------
|
|
# Start spdlog project
|
|
# ---------------------------------------------------------------------------------------
|
|
include(cmake/utils.cmake)
|
|
include(cmake/ide.cmake)
|
|
|
|
spdlog_extract_version()
|
|
|
|
project(spdlog VERSION ${SPDLOG_VERSION} LANGUAGES CXX)
|
|
message(STATUS "Build spdlog: ${SPDLOG_VERSION}")
|
|
|
|
include(GNUInstallDirs)
|
|
|
|
# ---------------------------------------------------------------------------------------
|
|
# Set default build to release
|
|
# ---------------------------------------------------------------------------------------
|
|
if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
|
|
set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose Release or Debug" FORCE)
|
|
endif()
|
|
|
|
# ---------------------------------------------------------------------------------------
|
|
# Compiler config
|
|
# ---------------------------------------------------------------------------------------
|
|
if(SPDLOG_USE_STD_FORMAT)
|
|
set(CMAKE_CXX_STANDARD 20)
|
|
set(CMAKE_CXX_STANDARD_REQUIRED ON)
|
|
elseif(NOT CMAKE_CXX_STANDARD)
|
|
set(CMAKE_CXX_STANDARD 11)
|
|
set(CMAKE_CXX_STANDARD_REQUIRED ON)
|
|
endif()
|
|
|
|
# under msvc make sure __cplusplus, parallel build and utf-8 enabled
|
|
if(CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
|
|
string(APPEND CMAKE_CXX_FLAGS " /Zc:__cplusplus /MP /utf-8")
|
|
endif()
|
|
|
|
set(CMAKE_CXX_EXTENSIONS OFF)
|
|
|
|
if(CMAKE_SYSTEM_NAME MATCHES "CYGWIN" OR CMAKE_SYSTEM_NAME MATCHES "MSYS" OR CMAKE_SYSTEM_NAME MATCHES "MINGW")
|
|
set(CMAKE_CXX_EXTENSIONS ON)
|
|
endif()
|
|
|
|
# ---------------------------------------------------------------------------------------
|
|
# Set SPDLOG_MASTER_PROJECT to ON if we are building spdlog
|
|
# ---------------------------------------------------------------------------------------
|
|
# Check if spdlog is being used directly or via add_subdirectory, but allow overriding
|
|
if(NOT DEFINED SPDLOG_MASTER_PROJECT)
|
|
if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
|
|
set(SPDLOG_MASTER_PROJECT ON)
|
|
else()
|
|
set(SPDLOG_MASTER_PROJECT OFF)
|
|
endif()
|
|
endif()
|
|
|
|
option(SPDLOG_BUILD_ALL "Build all artifacts" OFF)
|
|
|
|
# build shared option
|
|
option(SPDLOG_BUILD_SHARED "Build shared library" OFF)
|
|
|
|
# precompiled headers option
|
|
option(SPDLOG_ENABLE_PCH "Build static or shared library using precompiled header to speed up compilation time" OFF)
|
|
|
|
# build position independent code
|
|
option(SPDLOG_BUILD_PIC "Build position independent code (-fPIC)" OFF)
|
|
|
|
# example options
|
|
option(SPDLOG_BUILD_EXAMPLE "Build example" ${SPDLOG_MASTER_PROJECT})
|
|
option(SPDLOG_BUILD_EXAMPLE_HO "Build header only example" OFF)
|
|
|
|
# testing options
|
|
option(SPDLOG_BUILD_TESTS "Build tests" OFF)
|
|
option(SPDLOG_BUILD_TESTS_HO "Build tests using the header only version" OFF)
|
|
|
|
# bench options
|
|
option(SPDLOG_BUILD_BENCH "Build benchmarks (Requires https://github.com/google/benchmark.git to be installed)" OFF)
|
|
|
|
# sanitizer options
|
|
option(SPDLOG_SANITIZE_ADDRESS "Enable address sanitizer in tests" OFF)
|
|
option(SPDLOG_SANITIZE_THREAD "Enable thread sanitizer in tests" OFF)
|
|
if(SPDLOG_SANITIZE_ADDRESS AND SPDLOG_SANITIZE_THREAD)
|
|
message(FATAL_ERROR "SPDLOG_SANITIZE_ADDRESS and SPDLOG_SANITIZE_THREAD are mutually exclusive")
|
|
endif()
|
|
|
|
# warning options
|
|
option(SPDLOG_BUILD_WARNINGS "Enable compiler warnings" OFF)
|
|
|
|
# install options
|
|
option(SPDLOG_SYSTEM_INCLUDES "Include as system headers (skip for clang-tidy)." OFF)
|
|
option(SPDLOG_INSTALL "Generate the install target" ${SPDLOG_MASTER_PROJECT})
|
|
option(SPDLOG_USE_STD_FORMAT "Use std::format instead of fmt library." OFF)
|
|
option(SPDLOG_FMT_EXTERNAL "Use external fmt library instead of bundled" OFF)
|
|
option(SPDLOG_FMT_EXTERNAL_HO "Use external fmt header-only library instead of bundled" OFF)
|
|
option(SPDLOG_NO_EXCEPTIONS "Compile with -fno-exceptions. Call abort() on any spdlog exceptions" OFF)
|
|
|
|
if(SPDLOG_FMT_EXTERNAL AND SPDLOG_FMT_EXTERNAL_HO)
|
|
message(FATAL_ERROR "SPDLOG_FMT_EXTERNAL and SPDLOG_FMT_EXTERNAL_HO are mutually exclusive")
|
|
endif()
|
|
|
|
if(SPDLOG_USE_STD_FORMAT AND SPDLOG_FMT_EXTERNAL_HO)
|
|
message(FATAL_ERROR "SPDLOG_USE_STD_FORMAT and SPDLOG_FMT_EXTERNAL_HO are mutually exclusive")
|
|
endif()
|
|
|
|
if(SPDLOG_USE_STD_FORMAT AND SPDLOG_FMT_EXTERNAL)
|
|
message(FATAL_ERROR "SPDLOG_USE_STD_FORMAT and SPDLOG_FMT_EXTERNAL are mutually exclusive")
|
|
endif()
|
|
|
|
# misc tweakme options
|
|
if(WIN32)
|
|
option(SPDLOG_WCHAR_SUPPORT "Support wchar api" OFF)
|
|
option(SPDLOG_WCHAR_FILENAMES "Support wchar filenames" OFF)
|
|
option(SPDLOG_WCHAR_CONSOLE "Support wchar output to console" OFF)
|
|
else()
|
|
set(SPDLOG_WCHAR_SUPPORT OFF CACHE BOOL "non supported option" FORCE)
|
|
set(SPDLOG_WCHAR_FILENAMES OFF CACHE BOOL "non supported option" FORCE)
|
|
set(SPDLOG_WCHAR_CONSOLE OFF CACHE BOOL "non supported option" FORCE)
|
|
endif()
|
|
|
|
if(${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
|
|
option(SPDLOG_CLOCK_COARSE "Use CLOCK_REALTIME_COARSE instead of the regular clock," OFF)
|
|
else()
|
|
set(SPDLOG_CLOCK_COARSE OFF CACHE BOOL "non supported option" FORCE)
|
|
endif()
|
|
|
|
option(SPDLOG_PREVENT_CHILD_FD "Prevent from child processes to inherit log file descriptors" OFF)
|
|
option(SPDLOG_NO_THREAD_ID "prevent spdlog from querying the thread id on each log call if thread id is not needed" OFF)
|
|
option(SPDLOG_NO_TLS "prevent spdlog from using thread local storage" OFF)
|
|
option(
|
|
SPDLOG_NO_ATOMIC_LEVELS
|
|
"prevent spdlog from using of std::atomic log levels (use only if your code never modifies log levels concurrently"
|
|
OFF)
|
|
option(SPDLOG_DISABLE_DEFAULT_LOGGER "Disable default logger creation" OFF)
|
|
|
|
# clang-tidy
|
|
option(SPDLOG_TIDY "run clang-tidy" OFF)
|
|
|
|
if(SPDLOG_TIDY)
|
|
set(CMAKE_CXX_CLANG_TIDY "clang-tidy")
|
|
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
|
|
message(STATUS "Enabled clang-tidy")
|
|
endif()
|
|
|
|
if(SPDLOG_BUILD_PIC)
|
|
set(CMAKE_POSITION_INDEPENDENT_CODE ON)
|
|
endif()
|
|
|
|
find_package(Threads REQUIRED)
|
|
message(STATUS "Build type: " ${CMAKE_BUILD_TYPE})
|
|
# ---------------------------------------------------------------------------------------
|
|
# Static/Shared library
|
|
# ---------------------------------------------------------------------------------------
|
|
set(SPDLOG_SRCS src/spdlog.cpp src/stdout_sinks.cpp src/color_sinks.cpp src/file_sinks.cpp src/async.cpp src/cfg.cpp)
|
|
|
|
if(NOT SPDLOG_USE_STD_FORMAT AND NOT SPDLOG_FMT_EXTERNAL AND NOT SPDLOG_FMT_EXTERNAL_HO)
|
|
list(APPEND SPDLOG_SRCS src/bundled_fmtlib_format.cpp)
|
|
endif()
|
|
|
|
if(SPDLOG_BUILD_SHARED OR BUILD_SHARED_LIBS)
|
|
if(WIN32)
|
|
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/cmake/version.rc.in ${CMAKE_CURRENT_BINARY_DIR}/version.rc @ONLY)
|
|
list(APPEND SPDLOG_SRCS ${CMAKE_CURRENT_BINARY_DIR}/version.rc)
|
|
endif()
|
|
add_library(spdlog SHARED ${SPDLOG_SRCS} ${SPDLOG_ALL_HEADERS})
|
|
target_compile_definitions(spdlog PUBLIC SPDLOG_SHARED_LIB)
|
|
if(CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
|
|
target_compile_options(spdlog PUBLIC $<$<AND:$<CXX_COMPILER_ID:MSVC>,$<NOT:$<COMPILE_LANGUAGE:CUDA>>>:/wd4251
|
|
/wd4275>)
|
|
endif()
|
|
if(NOT SPDLOG_USE_STD_FORMAT AND NOT SPDLOG_FMT_EXTERNAL AND NOT SPDLOG_FMT_EXTERNAL_HO)
|
|
target_compile_definitions(spdlog PRIVATE FMT_LIB_EXPORT PUBLIC FMT_SHARED)
|
|
endif()
|
|
else()
|
|
add_library(spdlog STATIC ${SPDLOG_SRCS} ${SPDLOG_ALL_HEADERS})
|
|
endif()
|
|
|
|
add_library(spdlog::spdlog ALIAS spdlog)
|
|
|
|
set(SPDLOG_INCLUDES_LEVEL "")
|
|
if(SPDLOG_SYSTEM_INCLUDES)
|
|
set(SPDLOG_INCLUDES_LEVEL "SYSTEM")
|
|
endif()
|
|
|
|
target_compile_definitions(spdlog PUBLIC SPDLOG_COMPILED_LIB)
|
|
target_include_directories(spdlog ${SPDLOG_INCLUDES_LEVEL} PUBLIC "$<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/include>"
|
|
"$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>")
|
|
target_link_libraries(spdlog PUBLIC Threads::Threads)
|
|
spdlog_enable_warnings(spdlog)
|
|
|
|
set_target_properties(spdlog PROPERTIES VERSION ${SPDLOG_VERSION} SOVERSION
|
|
${SPDLOG_VERSION_MAJOR}.${SPDLOG_VERSION_MINOR})
|
|
set_target_properties(spdlog PROPERTIES DEBUG_POSTFIX d)
|
|
|
|
if(COMMAND target_precompile_headers AND SPDLOG_ENABLE_PCH)
|
|
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/cmake/pch.h.in ${PROJECT_BINARY_DIR}/spdlog_pch.h @ONLY)
|
|
target_precompile_headers(spdlog PRIVATE ${PROJECT_BINARY_DIR}/spdlog_pch.h)
|
|
endif()
|
|
|
|
# sanitizer support
|
|
if(SPDLOG_SANITIZE_ADDRESS)
|
|
spdlog_enable_addr_sanitizer(spdlog)
|
|
elseif (SPDLOG_SANITIZE_THREAD)
|
|
spdlog_enable_thread_sanitizer(spdlog)
|
|
endif ()
|
|
|
|
# ---------------------------------------------------------------------------------------
|
|
# Header only version
|
|
# ---------------------------------------------------------------------------------------
|
|
add_library(spdlog_header_only INTERFACE)
|
|
add_library(spdlog::spdlog_header_only ALIAS spdlog_header_only)
|
|
|
|
target_include_directories(
|
|
spdlog_header_only ${SPDLOG_INCLUDES_LEVEL} INTERFACE "$<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/include>"
|
|
"$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>")
|
|
target_link_libraries(spdlog_header_only INTERFACE Threads::Threads)
|
|
|
|
# ---------------------------------------------------------------------------------------
|
|
# Use fmt package if using external fmt
|
|
# ---------------------------------------------------------------------------------------
|
|
if(SPDLOG_FMT_EXTERNAL OR SPDLOG_FMT_EXTERNAL_HO)
|
|
if(NOT TARGET fmt::fmt)
|
|
find_package(fmt CONFIG REQUIRED)
|
|
endif()
|
|
target_compile_definitions(spdlog PUBLIC SPDLOG_FMT_EXTERNAL)
|
|
target_compile_definitions(spdlog_header_only INTERFACE SPDLOG_FMT_EXTERNAL)
|
|
|
|
# use external fmt-header-only
|
|
if(SPDLOG_FMT_EXTERNAL_HO)
|
|
target_link_libraries(spdlog PUBLIC fmt::fmt-header-only)
|
|
target_link_libraries(spdlog_header_only INTERFACE fmt::fmt-header-only)
|
|
else() # use external compile fmt
|
|
target_link_libraries(spdlog PUBLIC fmt::fmt)
|
|
target_link_libraries(spdlog_header_only INTERFACE fmt::fmt)
|
|
endif()
|
|
|
|
set(PKG_CONFIG_REQUIRES fmt) # add dependency to pkg-config
|
|
endif()
|
|
|
|
# ---------------------------------------------------------------------------------------
|
|
# Add required libraries for Android CMake build
|
|
# ---------------------------------------------------------------------------------------
|
|
if(ANDROID)
|
|
target_link_libraries(spdlog PUBLIC log)
|
|
target_link_libraries(spdlog_header_only INTERFACE log)
|
|
endif()
|
|
|
|
# ---------------------------------------------------------------------------------------
|
|
# Misc definitions according to tweak options
|
|
# ---------------------------------------------------------------------------------------
|
|
set(SPDLOG_WCHAR_TO_UTF8_SUPPORT ${SPDLOG_WCHAR_SUPPORT})
|
|
set(SPDLOG_UTF8_TO_WCHAR_CONSOLE ${SPDLOG_WCHAR_CONSOLE})
|
|
foreach(
|
|
SPDLOG_OPTION
|
|
SPDLOG_WCHAR_TO_UTF8_SUPPORT
|
|
SPDLOG_UTF8_TO_WCHAR_CONSOLE
|
|
SPDLOG_WCHAR_FILENAMES
|
|
SPDLOG_NO_EXCEPTIONS
|
|
SPDLOG_CLOCK_COARSE
|
|
SPDLOG_PREVENT_CHILD_FD
|
|
SPDLOG_NO_THREAD_ID
|
|
SPDLOG_NO_TLS
|
|
SPDLOG_NO_ATOMIC_LEVELS
|
|
SPDLOG_DISABLE_DEFAULT_LOGGER
|
|
SPDLOG_USE_STD_FORMAT)
|
|
if(${SPDLOG_OPTION})
|
|
target_compile_definitions(spdlog PUBLIC ${SPDLOG_OPTION})
|
|
target_compile_definitions(spdlog_header_only INTERFACE ${SPDLOG_OPTION})
|
|
endif()
|
|
endforeach()
|
|
|
|
# ---------------------------------------------------------------------------------------
|
|
# If exceptions are disabled, disable them in the bundled fmt as well
|
|
# ---------------------------------------------------------------------------------------
|
|
if(SPDLOG_NO_EXCEPTIONS)
|
|
if(NOT SPDLOG_FMT_EXTERNAL AND NOT SPDLOG_FMT_EXTERNAL_HO)
|
|
target_compile_definitions(spdlog PUBLIC FMT_EXCEPTIONS=0)
|
|
endif()
|
|
if(NOT MSVC)
|
|
target_compile_options(spdlog PRIVATE -fno-exceptions)
|
|
else()
|
|
target_compile_options(spdlog PRIVATE /EHs-c-)
|
|
endif()
|
|
endif()
|
|
# ---------------------------------------------------------------------------------------
|
|
# Build binaries
|
|
# ---------------------------------------------------------------------------------------
|
|
if(SPDLOG_BUILD_EXAMPLE OR SPDLOG_BUILD_EXAMPLE_HO OR SPDLOG_BUILD_ALL)
|
|
message(STATUS "Generating example(s)")
|
|
add_subdirectory(example)
|
|
spdlog_enable_warnings(example)
|
|
if(SPDLOG_BUILD_EXAMPLE_HO)
|
|
spdlog_enable_warnings(example_header_only)
|
|
endif()
|
|
endif()
|
|
|
|
if(SPDLOG_BUILD_TESTS OR SPDLOG_BUILD_TESTS_HO OR SPDLOG_BUILD_ALL)
|
|
message(STATUS "Generating tests")
|
|
enable_testing()
|
|
add_subdirectory(tests)
|
|
endif()
|
|
|
|
if(SPDLOG_BUILD_BENCH OR SPDLOG_BUILD_ALL)
|
|
message(STATUS "Generating benchmarks")
|
|
add_subdirectory(bench)
|
|
endif()
|
|
|
|
# ---------------------------------------------------------------------------------------
|
|
# Install
|
|
# ---------------------------------------------------------------------------------------
|
|
if(SPDLOG_INSTALL)
|
|
message(STATUS "Generating install")
|
|
set(project_config_in "${CMAKE_CURRENT_LIST_DIR}/cmake/spdlogConfig.cmake.in")
|
|
set(project_config_out "${CMAKE_CURRENT_BINARY_DIR}/spdlogConfig.cmake")
|
|
set(config_targets_file "spdlogConfigTargets.cmake")
|
|
set(version_config_file "${CMAKE_CURRENT_BINARY_DIR}/spdlogConfigVersion.cmake")
|
|
set(export_dest_dir "${CMAKE_INSTALL_LIBDIR}/cmake/spdlog")
|
|
set(pkgconfig_install_dir "${CMAKE_INSTALL_LIBDIR}/pkgconfig")
|
|
set(pkg_config "${CMAKE_BINARY_DIR}/${PROJECT_NAME}.pc")
|
|
|
|
# ---------------------------------------------------------------------------------------
|
|
# Include files
|
|
# ---------------------------------------------------------------------------------------
|
|
install(DIRECTORY include/ DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}" PATTERN "fmt/bundled" EXCLUDE)
|
|
install(
|
|
TARGETS spdlog spdlog_header_only
|
|
EXPORT spdlog
|
|
LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
|
|
ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
|
|
RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
|
|
|
|
if(NOT SPDLOG_USE_STD_FORMAT AND NOT SPDLOG_FMT_EXTERNAL AND NOT SPDLOG_FMT_EXTERNAL_HO)
|
|
install(DIRECTORY include/${PROJECT_NAME}/fmt/bundled/
|
|
DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}/fmt/bundled/")
|
|
endif()
|
|
|
|
# ---------------------------------------------------------------------------------------
|
|
# Install pkg-config file
|
|
# ---------------------------------------------------------------------------------------
|
|
if(IS_ABSOLUTE "${CMAKE_INSTALL_INCLUDEDIR}")
|
|
set(PKG_CONFIG_INCLUDEDIR "${CMAKE_INSTALL_INCLUDEDIR}")
|
|
else()
|
|
set(PKG_CONFIG_INCLUDEDIR "\${prefix}/${CMAKE_INSTALL_INCLUDEDIR}")
|
|
endif()
|
|
if(IS_ABSOLUTE "${CMAKE_INSTALL_LIBDIR}")
|
|
set(PKG_CONFIG_LIBDIR "${CMAKE_INSTALL_LIBDIR}")
|
|
else()
|
|
set(PKG_CONFIG_LIBDIR "\${exec_prefix}/${CMAKE_INSTALL_LIBDIR}")
|
|
endif()
|
|
get_target_property(PKG_CONFIG_DEFINES spdlog INTERFACE_COMPILE_DEFINITIONS)
|
|
string(REPLACE ";" " -D" PKG_CONFIG_DEFINES "${PKG_CONFIG_DEFINES}")
|
|
string(CONCAT PKG_CONFIG_DEFINES "-D" "${PKG_CONFIG_DEFINES}")
|
|
configure_file("cmake/${PROJECT_NAME}.pc.in" "${pkg_config}" @ONLY)
|
|
install(FILES "${pkg_config}" DESTINATION "${pkgconfig_install_dir}")
|
|
|
|
# ---------------------------------------------------------------------------------------
|
|
# Install CMake config files
|
|
# ---------------------------------------------------------------------------------------
|
|
export(TARGETS spdlog spdlog_header_only NAMESPACE spdlog::
|
|
FILE "${CMAKE_CURRENT_BINARY_DIR}/${config_targets_file}")
|
|
install(EXPORT spdlog DESTINATION ${export_dest_dir} NAMESPACE spdlog:: FILE ${config_targets_file})
|
|
|
|
include(CMakePackageConfigHelpers)
|
|
configure_package_config_file("${project_config_in}" "${project_config_out}" INSTALL_DESTINATION ${export_dest_dir})
|
|
|
|
write_basic_package_version_file("${version_config_file}" COMPATIBILITY SameMajorVersion)
|
|
install(FILES "${project_config_out}" "${version_config_file}" DESTINATION "${export_dest_dir}")
|
|
|
|
# ---------------------------------------------------------------------------------------
|
|
# Support creation of installable packages
|
|
# ---------------------------------------------------------------------------------------
|
|
include(cmake/spdlogCPack.cmake)
|
|
endif()
|