Continue CMake support improvement

- Update documentation - Remove type target - Remove typos - simplify target - improve 1-1 matchign with Bazel targets
abseil · Oct 31, 2017 · 058fbb2 · 058fbb2
1 parent 200b5a7
commit 058fbb2
Show file tree

Hide file tree

Showing 6 changed files with 175 additions and 50 deletions.
diff --git a/CMake/AbseilHelpers.cmake b/CMake/AbseilHelpers.cmake
@@ -16,10 +16,9 @@
 
 include(CMakeParseArguments)
 
-set(_ABSL_HELPERS_PATH "${CMAKE_CURRENT_LIST_DIR}")
 
 #
-# create a static library absl_based on the following variable
+# create a library in the absl namespace
 #
 # parameters
 # SOURCES : sources files for the library

diff --git a/CMake/README.md b/CMake/README.md
@@ -4,37 +4,66 @@
 
 ### Recommended usage : incorporate Abseil into an  CMake project
 
-    We recommended to build and use abseil in the same way than googletest
-    ( https://github.com/google/googletest/blob/master/googletest/README.md )
+  For API / ABI compatibility reasons, it is recommended to build
+  and use abseil in a subdirectory of your project or as an embedded
+  dependency
 
-    * Download abseil and copy it in a sub-directory in your project.
+  This is similar to the recommended usage of the googletest framework
+  ( https://github.com/google/googletest/blob/master/googletest/README.md )
 
-    * Or add abseil as a git-submodule in your project
+  Build and use step-by-step
 
-    You can then use the cmake `add_subdirectory()` command to include
-    abseil directly and use the abseil targets in your project.
 
-    Abseil requires CCTZ and the googletest framework. Consequently, 
+  1- Download abseil and copy it in a sub-directory in your project.
+      or add abseil as a git-submodule in your project
+
+  2- If not done yet, download and copy in your project the two dependencies of
+      abseil `cctz` and `googletest`
+
+    * cctz  https://github.com/google/cctz
+    * googletest https://github.com/google/googletest
+
+  3- You can then use the cmake command `add_subdirectory()` to include
+  abseil directly and use the abseil targets in your project.
+
+    Note: Abseil requires CCTZ and the googletest framework. Consequently,
     the targets  `gtest`, `gtest_main`, `gmock` and `cctz` need
-    to be declared in your project before including abseil with `add_subdirectory`. 
-    You can find instructions on how to get and build these projects at these 
+    to be declared in your project before including abseil with `add_subdirectory`.
+    You can find instructions on how to get and build these projects at these
     URL :
-        * cctz  https://github.com/google/cctz
-        * googletest https://github.com/google/googletest
-
-
-
-    Here is a short CMakeLists.txt example of a possible project file 
-    using abseil
-
-    project(my_project)
-
-    add_subdirectory(googletest)
-    add_subdirectory(cctz)    
-    add_subdirectory(abseil-cpp)
-
-    add_executable(my_exe source.cpp)
-    target_link_libraries(my_exe base synchronization strings)
+
+
+  4- Add the absl:: target you wish to use to the `target_link_libraries()`
+    section of your executable or of your library
+
+
+      Here is a short CMakeLists.txt example of a possible project file
+      using abseil
+
+      project(my_project)
+
+      add_subdirectory(googletest)
+      add_subdirectory(cctz)
+      add_subdirectory(abseil-cpp)
+
+      add_executable(my_exe source.cpp)
+      target_link_libraries(my_exe absl::base absl::synchronization absl::strings)
+
+
+    You will find here a non exhaustive list of absl public targets
+
+      absl::base
+      absl::algorithm
+      absl::container
+      absl::debugging
+      absl::memory
+      absl::meta
+      absl::numeric
+      absl::strings
+      absl::synchronization
+      absl::time
+      absl::utility
+
 
 
 

diff --git a/absl/base/CMakeLists.txt b/absl/base/CMakeLists.txt
@@ -65,10 +65,8 @@ list(APPEND BASE_SRC
   "internal/sysinfo.cc"
   "internal/thread_identity.cc"
   "internal/unscaledcycleclock.cc"
-  "internal/spinlock_wait.cc"
   "internal/low_level_alloc.cc"
   "internal/malloc_hook.cc"
-  "dynamic_annotations.cc"
   ${BASE_PUBLIC_HEADERS}
   ${BASE_INTERNAL_HEADERS}
 )
@@ -78,6 +76,9 @@ absl_library(
     absl_base
   SOURCES
     ${BASE_SRC}
+  PUBLIC_LIBRARIES
+    absl_dynamic_annotations
+    absl_spinlock_wait
   EXPORT_NAME
     base
 )
@@ -93,6 +94,8 @@ absl_library(
     ${MALLOC_EXTENSION_SRC}
   PUBLIC_LIBRARIES
     ${MALLOC_EXTENSION_PUBLIC_LIBRARIES}
+  EXPORT_NAME
+    malloc_extension
 )
 
 # throw delegate library
@@ -107,9 +110,51 @@ absl_library(
     ${THROW_DELEGATE_PUBLIC_LIBRARIES}
   PRIVATE_COMPILE_FLAGS
     ${ABSL_EXCEPTIONS_FLAG}
+  EXPORT_NAME
+    throw_delegate
 )
 
 
+# dynamic_annotations library
+set(DYNAMIC_ANNOTATIONS_SRC "dynamic_annotations.cc")
+
+absl_library(
+  TARGET
+    absl_dynamic_annotations
+  SOURCES
+    ${DYNAMIC_ANNOTATIONS_SRC}
+)
+
+
+# spinlock_wait library
+set(SPINLOCK_WAIT_SRC "internal/spinlock_wait.cc")
+
+absl_library(
+  TARGET
+    absl_spinlock_wait
+  SOURCES
+    ${SPINLOCK_WAIT_SRC}
+)
+
+
+# malloc_internal library
+list(APPEND MALLOC_INTERNAL_SRC
+  "internal/low_level_alloc.cc"
+  "internal/malloc_hook.cc"
+  "internal/malloc_hook_mmap_linux.inc"
+)
+
+absl_library(
+  TARGET
+    absl_malloc_internal
+  SOURCES
+    ${MALLOC_INTERNAL_SRC}
+  PUBLIC_LIBRARIES
+    absl_dynamic_annotations
+)
+
+
+
 #
 ## TESTS
 #

diff --git a/absl/debugging/CMakeLists.txt b/absl/debugging/CMakeLists.txt
@@ -42,17 +42,52 @@ absl_library(
     absl_stacktrace
   SOURCES
     ${STACKTRACE_SRC}
-  PUBLIC_LIBRARIES
-    ${STACKTRACE_PUBLIC_LIBRARIES}
   EXPORT_NAME
     stacktrace
 )
 
 
+list(APPEND LEAK_CHECK_SRC
+  "leak_check.cc"
+)
+
+
+# leak_check library
+absl_library(
+  TARGET
+    absl_leak_check
+  SOURCES
+    ${LEAK_CHECK_SRC}
+  PUBLIC_LIBRARIES
+    absl_base
+  EXPORT_NAME
+    leak_check
+)
+
+
+# component target
 absl_header_library(
   TARGET
     absl_debugging
+  PUBLIC_LIBRARIES
+    absl_stacktrace absl_leak_check
   EXPORT_NAME
     debugging
 )
 
+#
+## TESTS
+#
+
+# test leak_check_test
+list(APPEND LEAK_CHECK_TEST_SRC "leak_check_test.cc")
+
+absl_test(
+  TARGET
+    leak_check_test
+  SOURCES
+    ${LEAK_CHECK_TEST_SRC}
+  PUBLIC_LIBRARIES
+    absl_leak_check
+)
+
diff --git a/absl/strings/CMakeLists.txt b/absl/strings/CMakeLists.txt
@@ -16,7 +16,6 @@
 
 
 list(APPEND STRINGS_PUBLIC_HEADERS
-  "ascii_ctype.h"
   "ascii.h"
   "escaping.h"
   "match.h"

diff --git a/absl/types/CMakeLists.txt b/absl/types/CMakeLists.txt
@@ -23,34 +23,59 @@ list(APPEND TYPES_PUBLIC_HEADERS
 )
 
 
+# any library
+absl_header_library(
+  TARGET
+    absl_any
+  PUBLIC_LIBRARIES
+    absl::utility
+  EXPORT_NAME
+    any
+)
+
+# span library
+absl_header_library(
+  TARGET
+    absl_span
+  PUBLIC_LIBRARIES
+    absl::utility
+  EXPORT_NAME
+    span
+)
+
 
+# bad_any_cast library
 list(APPEND BAD_ANY_CAST_SRC
   "bad_any_cast.cc"
   ${TYPES_PUBLIC_HEADERS}
 )
-set(BAD_ANY_CAST_PUBLIC_LIBRARIES absl::base)
 
 absl_library(
   TARGET
     absl_bad_any_cast
   SOURCES
     ${BAD_ANY_CAST_SRC}
   PUBLIC_LIBRARIES
-    ${BAD_ANY_CAST_PUBLIC_LIBRARIES}
+    absl::base absl::any
+  EXPORT_NAME
+    bad_any_cast
 )
 
 
-
-set(OPTIONAL_SRC "optional.cc")
-set(OPTIONAL_PUBLIC_LIBRARIES absl::base)
+# optional library
+list(APPEND OPTIONAL_SRC
+  "optional.cc"
+)
 
 absl_library(
   TARGET
     absl_optional
   SOURCES
     ${OPTIONAL_SRC}
   PUBLIC_LIBRARIES
-    ${OPTIONAL_PUBLIC_LIBRARIES}
+    absl::base
+  EXPORT_NAME
+    optional
 )
 
 
@@ -64,27 +89,20 @@ absl_library(
     ${BAD_OPTIONAL_ACCESS_SRC}
   PUBLIC_LIBRARIES
     ${BAD_OPTIONAL_ACCESS_PUBLIC_LIBRARIES}
+  EXPORT_NAME
+    bad_optional_access
 )
 
 
 
-absl_header_library(
-  TARGET
-    absl_types
-  PUBLIC_LIBRARIES
-    absl_optional absl_bad_any_cast absl_bad_optional_access
-  EXPORT_NAME
-    types
-)
-
 #
 ## TESTS
 #
 
 
 # test any_test
 set(ANY_TEST_SRC "any_test.cc")
-set(ANY_TEST_PUBLIC_LIBRARIES absl::base absl_throw_delegate absl_bad_any_cast test_instance_tracker_lib)
+set(ANY_TEST_PUBLIC_LIBRARIES absl::base absl::throw_delegate absl::any absl::bad_any_cast test_instance_tracker_lib)
 
 absl_test(
   TARGET
@@ -111,7 +129,7 @@ absl_test(
 
 # test span_test
 set(SPAN_TEST_SRC "span_test.cc")
-set(SPAN_TEST_PUBLIC_LIBRARIES absl::base absl::strings absl_throw_delegate absl_bad_any_cast test_instance_tracker_lib)
+set(SPAN_TEST_PUBLIC_LIBRARIES absl::base absl::strings absl::throw_delegate absl::span test_instance_tracker_lib)
 
 absl_test(
   TARGET
@@ -139,7 +157,7 @@ absl_test(
 
 # test optional_test
 set(OPTIONAL_TEST_SRC "optional_test.cc")
-set(OPTIONAL_TEST_PUBLIC_LIBRARIES absl::base absl_throw_delegate absl_optional bad_optional_access)
+set(OPTIONAL_TEST_PUBLIC_LIBRARIES absl::base absl::throw_delegate absl::optional absl_bad_optional_access)
 
 absl_test(
   TARGET