AbseilHelpers.cmake (15250B)
1 # 2 # Copyright 2017 The Abseil Authors. 3 # 4 # Licensed under the Apache License, Version 2.0 (the "License"); 5 # you may not use this file except in compliance with the License. 6 # You may obtain a copy of the License at 7 # 8 # https://www.apache.org/licenses/LICENSE-2.0 9 # 10 # Unless required by applicable law or agreed to in writing, software 11 # distributed under the License is distributed on an "AS IS" BASIS, 12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 # See the License for the specific language governing permissions and 14 # limitations under the License. 15 # 16 17 include(CMakeParseArguments) 18 include(AbseilConfigureCopts) 19 include(AbseilDll) 20 21 # The IDE folder for Abseil that will be used if Abseil is included in a CMake 22 # project that sets 23 # set_property(GLOBAL PROPERTY USE_FOLDERS ON) 24 # For example, Visual Studio supports folders. 25 if(NOT DEFINED ABSL_IDE_FOLDER) 26 set(ABSL_IDE_FOLDER Abseil) 27 endif() 28 29 if(ABSL_USE_SYSTEM_INCLUDES) 30 set(ABSL_INTERNAL_INCLUDE_WARNING_GUARD SYSTEM) 31 else() 32 set(ABSL_INTERNAL_INCLUDE_WARNING_GUARD "") 33 endif() 34 35 # absl_cc_library() 36 # 37 # CMake function to imitate Bazel's cc_library rule. 38 # 39 # Parameters: 40 # NAME: name of target (see Note) 41 # HDRS: List of public header files for the library 42 # SRCS: List of source files for the library 43 # DEPS: List of other libraries to be linked in to the binary targets 44 # COPTS: List of private compile options 45 # DEFINES: List of public defines 46 # LINKOPTS: List of link options 47 # PUBLIC: Add this so that this library will be exported under absl:: 48 # Also in IDE, target will appear in Abseil folder while non PUBLIC will be in Abseil/internal. 49 # TESTONLY: When added, this target will only be built if both 50 # BUILD_TESTING=ON and ABSL_BUILD_TESTING=ON. 51 # 52 # Note: 53 # By default, absl_cc_library will always create a library named absl_${NAME}, 54 # and alias target absl::${NAME}. The absl:: form should always be used. 55 # This is to reduce namespace pollution. 56 # 57 # absl_cc_library( 58 # NAME 59 # awesome 60 # HDRS 61 # "a.h" 62 # SRCS 63 # "a.cc" 64 # ) 65 # absl_cc_library( 66 # NAME 67 # fantastic_lib 68 # SRCS 69 # "b.cc" 70 # DEPS 71 # absl::awesome # not "awesome" ! 72 # PUBLIC 73 # ) 74 # 75 # absl_cc_library( 76 # NAME 77 # main_lib 78 # ... 79 # DEPS 80 # absl::fantastic_lib 81 # ) 82 # 83 # TODO(b/320467376): Implement "ALWAYSLINK". 84 function(absl_cc_library) 85 cmake_parse_arguments(ABSL_CC_LIB 86 "DISABLE_INSTALL;PUBLIC;TESTONLY" 87 "NAME" 88 "HDRS;SRCS;COPTS;DEFINES;LINKOPTS;DEPS" 89 ${ARGN} 90 ) 91 92 if(ABSL_CC_LIB_TESTONLY AND 93 NOT ((BUILD_TESTING AND ABSL_BUILD_TESTING) OR 94 (ABSL_BUILD_TEST_HELPERS AND ABSL_CC_LIB_PUBLIC))) 95 return() 96 endif() 97 98 if(ABSL_ENABLE_INSTALL) 99 set(_NAME "${ABSL_CC_LIB_NAME}") 100 else() 101 set(_NAME "absl_${ABSL_CC_LIB_NAME}") 102 endif() 103 104 # Check if this is a header-only library 105 # Note that as of February 2019, many popular OS's (for example, Ubuntu 106 # 16.04 LTS) only come with cmake 3.5 by default. For this reason, we can't 107 # use list(FILTER...) 108 set(ABSL_CC_SRCS "${ABSL_CC_LIB_SRCS}") 109 foreach(src_file IN LISTS ABSL_CC_SRCS) 110 if(${src_file} MATCHES ".*\\.(h|inc)") 111 list(REMOVE_ITEM ABSL_CC_SRCS "${src_file}") 112 endif() 113 endforeach() 114 115 if(ABSL_CC_SRCS STREQUAL "") 116 set(ABSL_CC_LIB_IS_INTERFACE 1) 117 else() 118 set(ABSL_CC_LIB_IS_INTERFACE 0) 119 endif() 120 121 # Determine this build target's relationship to the DLL. It's one of four things: 122 # 1. "dll" -- This target is part of the DLL 123 # 2. "dll_dep" -- This target is not part of the DLL, but depends on the DLL. 124 # Note that we assume any target not in the DLL depends on the 125 # DLL. This is not a technical necessity but a convenience 126 # which happens to be true, because nearly every target is 127 # part of the DLL. 128 # 3. "shared" -- This is a shared library, perhaps on a non-windows platform 129 # where DLL doesn't make sense. 130 # 4. "static" -- This target does not depend on the DLL and should be built 131 # statically. 132 if (${ABSL_BUILD_DLL}) 133 if(ABSL_ENABLE_INSTALL) 134 absl_internal_dll_contains(TARGET ${_NAME} OUTPUT _in_dll) 135 absl_internal_test_dll_contains(TARGET ${_NAME} OUTPUT _in_test_dll) 136 else() 137 absl_internal_dll_contains(TARGET ${ABSL_CC_LIB_NAME} OUTPUT _in_dll) 138 absl_internal_test_dll_contains(TARGET ${ABSL_CC_LIB_NAME} OUTPUT _in_test_dll) 139 endif() 140 if (${_in_dll} OR ${_in_test_dll}) 141 # This target should be replaced by the DLL 142 set(_build_type "dll") 143 set(ABSL_CC_LIB_IS_INTERFACE 1) 144 else() 145 # Building a DLL, but this target is not part of the DLL 146 set(_build_type "dll_dep") 147 endif() 148 elseif(BUILD_SHARED_LIBS) 149 set(_build_type "shared") 150 else() 151 set(_build_type "static") 152 endif() 153 154 # Generate a pkg-config file for every library: 155 if(ABSL_ENABLE_INSTALL) 156 if(absl_VERSION) 157 set(PC_VERSION "${absl_VERSION}") 158 else() 159 set(PC_VERSION "head") 160 endif() 161 if(NOT _build_type STREQUAL "dll") 162 set(LNK_LIB "${LNK_LIB} -labsl_${_NAME}") 163 endif() 164 foreach(dep ${ABSL_CC_LIB_DEPS}) 165 if(${dep} MATCHES "^absl::(.*)") 166 # for DLL builds many libs are not created, but add 167 # the pkgconfigs nevertheless, pointing to the dll. 168 if(_build_type STREQUAL "dll") 169 # hide this MATCHES in an if-clause so it doesn't overwrite 170 # the CMAKE_MATCH_1 from (${dep} MATCHES "^absl::(.*)") 171 if(NOT PC_DEPS MATCHES "abseil_dll") 172 # Join deps with commas. 173 if(PC_DEPS) 174 set(PC_DEPS "${PC_DEPS},") 175 endif() 176 # don't duplicate dll-dep if it exists already 177 set(PC_DEPS "${PC_DEPS} abseil_dll = ${PC_VERSION}") 178 set(LNK_LIB "${LNK_LIB} -labseil_dll") 179 endif() 180 else() 181 # Join deps with commas. 182 if(PC_DEPS) 183 set(PC_DEPS "${PC_DEPS},") 184 endif() 185 set(PC_DEPS "${PC_DEPS} absl_${CMAKE_MATCH_1} = ${PC_VERSION}") 186 endif() 187 endif() 188 endforeach() 189 foreach(cflag ${ABSL_CC_LIB_COPTS}) 190 # Strip out the CMake-specific `SHELL:` prefix, which is used to construct 191 # a group of space-separated options. 192 # https://cmake.org/cmake/help/v3.30/command/target_compile_options.html#option-de-duplication 193 string(REGEX REPLACE "^SHELL:" "" cflag "${cflag}") 194 if(${cflag} MATCHES "^-Xarch_") 195 # An -Xarch_ flag implies that its successor only applies to the 196 # specified platform. Such option groups are each specified in a single 197 # `SHELL:`-prefixed string in the COPTS list, which we simply ignore. 198 elseif(${cflag} MATCHES "^(-Wno-|/wd)") 199 # These flags are needed to suppress warnings that might fire in our headers. 200 set(PC_CFLAGS "${PC_CFLAGS} ${cflag}") 201 elseif(${cflag} MATCHES "^(-W|/w[1234eo])") 202 # Don't impose our warnings on others. 203 elseif(${cflag} MATCHES "^-m") 204 # Don't impose CPU instruction requirements on others, as 205 # the code performs feature detection on runtime. 206 else() 207 set(PC_CFLAGS "${PC_CFLAGS} ${cflag}") 208 endif() 209 endforeach() 210 string(REPLACE ";" " " PC_LINKOPTS "${ABSL_CC_LIB_LINKOPTS}") 211 FILE(GENERATE OUTPUT "${CMAKE_BINARY_DIR}/lib/pkgconfig/absl_${_NAME}.pc" CONTENT "\ 212 prefix=${CMAKE_INSTALL_PREFIX}\n\ 213 exec_prefix=\${prefix}\n\ 214 libdir=${CMAKE_INSTALL_FULL_LIBDIR}\n\ 215 includedir=${CMAKE_INSTALL_FULL_INCLUDEDIR}\n\ 216 \n\ 217 Name: absl_${_NAME}\n\ 218 Description: Abseil ${_NAME} library\n\ 219 URL: https://abseil.io/\n\ 220 Version: ${PC_VERSION}\n\ 221 Requires:${PC_DEPS}\n\ 222 Libs: -L\${libdir} $<$<NOT:$<BOOL:${ABSL_CC_LIB_IS_INTERFACE}>>:${LNK_LIB}> ${PC_LINKOPTS}\n\ 223 Cflags: -I\${includedir}${PC_CFLAGS}\n") 224 INSTALL(FILES "${CMAKE_BINARY_DIR}/lib/pkgconfig/absl_${_NAME}.pc" 225 DESTINATION "${CMAKE_INSTALL_LIBDIR}/pkgconfig") 226 endif() 227 228 if(NOT ABSL_CC_LIB_IS_INTERFACE) 229 if(_build_type STREQUAL "dll_dep") 230 # This target depends on the DLL. When adding dependencies to this target, 231 # any depended-on-target which is contained inside the DLL is replaced 232 # with a dependency on the DLL. 233 add_library(${_NAME} STATIC "") 234 target_sources(${_NAME} PRIVATE ${ABSL_CC_LIB_SRCS} ${ABSL_CC_LIB_HDRS}) 235 absl_internal_dll_targets( 236 DEPS ${ABSL_CC_LIB_DEPS} 237 OUTPUT _dll_deps 238 ) 239 target_link_libraries(${_NAME} 240 PUBLIC ${_dll_deps} 241 PRIVATE 242 ${ABSL_CC_LIB_LINKOPTS} 243 ${ABSL_DEFAULT_LINKOPTS} 244 ) 245 246 if (ABSL_CC_LIB_TESTONLY) 247 set(_gtest_link_define "GTEST_LINKED_AS_SHARED_LIBRARY=1") 248 else() 249 set(_gtest_link_define) 250 endif() 251 252 target_compile_definitions(${_NAME} 253 PUBLIC 254 ABSL_CONSUME_DLL 255 "${_gtest_link_define}" 256 ) 257 258 elseif(_build_type STREQUAL "static" OR _build_type STREQUAL "shared") 259 add_library(${_NAME} "") 260 target_sources(${_NAME} PRIVATE ${ABSL_CC_LIB_SRCS} ${ABSL_CC_LIB_HDRS}) 261 if(APPLE) 262 set_target_properties(${_NAME} PROPERTIES 263 INSTALL_RPATH "@loader_path") 264 elseif(UNIX) 265 set_target_properties(${_NAME} PROPERTIES 266 INSTALL_RPATH "$ORIGIN") 267 endif() 268 target_link_libraries(${_NAME} 269 PUBLIC ${ABSL_CC_LIB_DEPS} 270 PRIVATE 271 ${ABSL_CC_LIB_LINKOPTS} 272 ${ABSL_DEFAULT_LINKOPTS} 273 ) 274 else() 275 message(FATAL_ERROR "Invalid build type: ${_build_type}") 276 endif() 277 278 # Linker language can be inferred from sources, but in the case of DLLs we 279 # don't have any .cc files so it would be ambiguous. We could set it 280 # explicitly only in the case of DLLs but, because "CXX" is always the 281 # correct linker language for static or for shared libraries, we set it 282 # unconditionally. 283 set_property(TARGET ${_NAME} PROPERTY LINKER_LANGUAGE "CXX") 284 285 target_include_directories(${_NAME} ${ABSL_INTERNAL_INCLUDE_WARNING_GUARD} 286 PUBLIC 287 "$<BUILD_INTERFACE:${ABSL_COMMON_INCLUDE_DIRS}>" 288 $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}> 289 ) 290 target_compile_options(${_NAME} 291 PRIVATE ${ABSL_CC_LIB_COPTS}) 292 target_compile_definitions(${_NAME} PUBLIC ${ABSL_CC_LIB_DEFINES}) 293 294 # Add all Abseil targets to a a folder in the IDE for organization. 295 if(ABSL_CC_LIB_PUBLIC) 296 set_property(TARGET ${_NAME} PROPERTY FOLDER ${ABSL_IDE_FOLDER}) 297 elseif(ABSL_CC_LIB_TESTONLY) 298 set_property(TARGET ${_NAME} PROPERTY FOLDER ${ABSL_IDE_FOLDER}/test) 299 else() 300 set_property(TARGET ${_NAME} PROPERTY FOLDER ${ABSL_IDE_FOLDER}/internal) 301 endif() 302 303 if(ABSL_PROPAGATE_CXX_STD) 304 # Abseil libraries require C++17 as the current minimum standard. When 305 # compiled with a higher standard (either because it is the compiler's 306 # default or explicitly requested), then Abseil requires that standard. 307 target_compile_features(${_NAME} PUBLIC ${ABSL_INTERNAL_CXX_STD_FEATURE}) 308 endif() 309 310 # When being installed, we lose the absl_ prefix. We want to put it back 311 # to have properly named lib files. This is a no-op when we are not being 312 # installed. 313 if(ABSL_ENABLE_INSTALL) 314 set_target_properties(${_NAME} PROPERTIES 315 OUTPUT_NAME "absl_${_NAME}" 316 SOVERSION "${ABSL_SOVERSION}" 317 ) 318 endif() 319 else() 320 # Generating header-only library 321 add_library(${_NAME} INTERFACE) 322 target_include_directories(${_NAME} ${ABSL_INTERNAL_INCLUDE_WARNING_GUARD} 323 INTERFACE 324 "$<BUILD_INTERFACE:${ABSL_COMMON_INCLUDE_DIRS}>" 325 $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}> 326 ) 327 328 if (_build_type STREQUAL "dll") 329 set(ABSL_CC_LIB_DEPS abseil_dll) 330 endif() 331 332 target_link_libraries(${_NAME} 333 INTERFACE 334 ${ABSL_CC_LIB_DEPS} 335 ${ABSL_CC_LIB_LINKOPTS} 336 ${ABSL_DEFAULT_LINKOPTS} 337 ) 338 target_compile_definitions(${_NAME} INTERFACE ${ABSL_CC_LIB_DEFINES}) 339 340 if(ABSL_PROPAGATE_CXX_STD) 341 # Abseil libraries require C++17 as the current minimum standard. 342 # Top-level application CMake projects should ensure a consistent C++ 343 # standard for all compiled sources by setting CMAKE_CXX_STANDARD. 344 target_compile_features(${_NAME} INTERFACE ${ABSL_INTERNAL_CXX_STD_FEATURE}) 345 endif() 346 endif() 347 348 if(ABSL_ENABLE_INSTALL) 349 install(TARGETS ${_NAME} EXPORT ${PROJECT_NAME}Targets 350 RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} 351 LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} 352 ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} 353 ) 354 endif() 355 356 add_library(absl::${ABSL_CC_LIB_NAME} ALIAS ${_NAME}) 357 endfunction() 358 359 # absl_cc_test() 360 # 361 # CMake function to imitate Bazel's cc_test rule. 362 # 363 # Parameters: 364 # NAME: name of target (see Usage below) 365 # SRCS: List of source files for the binary 366 # DEPS: List of other libraries to be linked in to the binary targets 367 # COPTS: List of private compile options 368 # DEFINES: List of public defines 369 # LINKOPTS: List of link options 370 # 371 # Note: 372 # By default, absl_cc_test will always create a binary named absl_${NAME}. 373 # This will also add it to ctest list as absl_${NAME}. 374 # 375 # Usage: 376 # absl_cc_library( 377 # NAME 378 # awesome 379 # HDRS 380 # "a.h" 381 # SRCS 382 # "a.cc" 383 # PUBLIC 384 # ) 385 # 386 # absl_cc_test( 387 # NAME 388 # awesome_test 389 # SRCS 390 # "awesome_test.cc" 391 # DEPS 392 # absl::awesome 393 # GTest::gmock 394 # GTest::gtest_main 395 # ) 396 function(absl_cc_test) 397 if(NOT (BUILD_TESTING AND ABSL_BUILD_TESTING)) 398 return() 399 endif() 400 401 cmake_parse_arguments(ABSL_CC_TEST 402 "" 403 "NAME" 404 "SRCS;COPTS;DEFINES;LINKOPTS;DEPS" 405 ${ARGN} 406 ) 407 408 set(_NAME "absl_${ABSL_CC_TEST_NAME}") 409 410 add_executable(${_NAME} "") 411 target_sources(${_NAME} PRIVATE ${ABSL_CC_TEST_SRCS}) 412 target_include_directories(${_NAME} 413 PUBLIC ${ABSL_COMMON_INCLUDE_DIRS} 414 PRIVATE ${absl_gtest_src_dir}/googletest/include ${absl_gtest_src_dir}/googlemock/include 415 ) 416 417 if (${ABSL_BUILD_DLL}) 418 target_compile_definitions(${_NAME} 419 PUBLIC 420 ${ABSL_CC_TEST_DEFINES} 421 ABSL_CONSUME_DLL 422 ABSL_CONSUME_TEST_DLL 423 GTEST_LINKED_AS_SHARED_LIBRARY=1 424 ) 425 426 # Replace dependencies on targets inside the DLL with abseil_dll itself. 427 absl_internal_dll_targets( 428 DEPS ${ABSL_CC_TEST_DEPS} 429 OUTPUT ABSL_CC_TEST_DEPS 430 ) 431 absl_internal_dll_targets( 432 DEPS ${ABSL_CC_TEST_LINKOPTS} 433 OUTPUT ABSL_CC_TEST_LINKOPTS 434 ) 435 else() 436 target_compile_definitions(${_NAME} 437 PUBLIC 438 ${ABSL_CC_TEST_DEFINES} 439 ) 440 endif() 441 target_compile_options(${_NAME} 442 PRIVATE ${ABSL_CC_TEST_COPTS} 443 ) 444 445 target_link_libraries(${_NAME} 446 PUBLIC ${ABSL_CC_TEST_DEPS} 447 PRIVATE ${ABSL_CC_TEST_LINKOPTS} 448 ) 449 # Add all Abseil targets to a folder in the IDE for organization. 450 set_property(TARGET ${_NAME} PROPERTY FOLDER ${ABSL_IDE_FOLDER}/test) 451 452 if(ABSL_PROPAGATE_CXX_STD) 453 # Abseil libraries require C++17 as the current minimum standard. 454 # Top-level application CMake projects should ensure a consistent C++ 455 # standard for all compiled sources by setting CMAKE_CXX_STANDARD. 456 target_compile_features(${_NAME} PUBLIC ${ABSL_INTERNAL_CXX_STD_FEATURE}) 457 endif() 458 459 add_test(NAME ${_NAME} COMMAND ${_NAME}) 460 endfunction()