CXX-760 CMake and package search improvements

Author: acmorrow

.travis.yml

@@ -10,7 +10,7 @@ env:
         - REPO_TYPE="precise/mongodb-enterprise/stable multiverse"
         - SOURCES_LOC="/etc/apt/sources.list.d/mongodb-enterprise.list"
         - KEY_SERVER="hkp://keyserver.ubuntu.com:80"
-        - CMAKE_VERSION="cmake-3.1.3-Linux-x86_64"
+        - CMAKE_VERSION="cmake-3.2.3-Linux-x86_64"
         - CMAKE_BINARY="${CMAKE_VERSION}/bin/cmake"
 
     matrix:
@@ -25,7 +25,7 @@ before_install:
     - wget -O - http://llvm.org/apt/llvm-snapshot.gpg.key | sudo apt-key add -
 
     # Get the latest CMake
-    - curl -O https://cmake.org/files/v3.1/${CMAKE_VERSION}.tar.gz
+    - curl -O https://cmake.org/files/v3.2/${CMAKE_VERSION}.tar.gz
 
     # MongoDB Enterprise Edition, latest stable version
     - sudo apt-key adv --keyserver ${KEY_SERVER} --recv 7F0CEB10

CMakeLists.txt

@@ -1,12 +1,15 @@
 project(MONGO_CXX_DRIVER LANGUAGES CXX)
 
-cmake_minimum_required(VERSION 3.1.0 FATAL_ERROR)
+cmake_minimum_required(VERSION 3.2 FATAL_ERROR)
 
 set (CMAKE_SKIP_BUILD_RPATH false)
 set (CMAKE_BUILD_WITH_INSTALL_RPATH false)
 set (CMAKE_INSTALL_RPATH_USE_LINK_PATH true)
+# Ensure that RPATH is used on OSX
+set(CMAKE_MACOSX_RPATH 1)
 
-# Add in our modules
+# Add in our modules, we write FindX modules for libbson and libmongoc
+# since they don't currently install them.
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/")
 
 # Enforce the C++ standard, and disable extensions
@@ -16,19 +19,6 @@ endif()
 
 set(CMAKE_CXX_EXTENSIONS OFF)
 
-# CMake 3.1 doesn't know how to C++11 for clang.
-if(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
-    if (CMAKE_CXX_STANDARD EQUAL 11)
-        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
-    elseif (CMAKE_CXX_STANDARD EQUAL 14)
-        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++14")
-    else()
-        error("Don't know how to do that standard for Clang")
-    endif()
-else()
-    set(CMAKE_CXX_STANDARD_REQUIRED ON)
-endif()
-
 # Include the required modules
 include(GenerateExportHeader)
 include(InstallRequiredSystemLibraries)
@@ -39,19 +29,6 @@ if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
     set (CMAKE_INSTALL_PREFIX "${CMAKE_BINARY_DIR}/install" CACHE PATH "default install path" FORCE)
 endif()
 
-# Ensure we have Package Config
-find_package(PkgConfig)
-
-# Set PKG_CONFIG_PATH
-if(DEFINED $ENV{PKG_CONFIG_PATH})
-    set(PKG_CONFIG_PATH $ENV{PKG_CONFIG_PATH})
-else()
-    set(PKG_CONFIG_PATH "${CMAKE_INSTALL_PREFIX}/lib/pkgconfig")
-endif()
-
-# Ensure that RPATH is used on OSX
-set(CMAKE_MACOSX_RPATH 1)
-
 if(NOT CMAKE_BUILD_TYPE)
     message(STATUS "No build type selected, default is Release")
     set(CMAKE_BUILD_TYPE "Release")

cmake/FindLibBSON.cmake

@@ -0,0 +1,24 @@
+# Find libbson, either via pkg-config, find-package in config mode,
+# or other less admirable jiggery-pokery
+
+SET(LIBBSON_DIR "" CACHE STRING "Manual search path for libbson")
+
+include(FindPackageHandleStandardArgs)
+
+# Load up PkgConfig if we have it
+find_package(PkgConfig QUIET)
+
+if (PKG_CONFIG_FOUND)
+  pkg_check_modules(LIBBSON REQUIRED libbson-1.0>=${LibBSON_FIND_VERSION} )
+  # We don't reiterate the version information here because we assume that
+  # pkg_check_modules has honored our request.
+  find_package_handle_standard_args(LIBBSON DEFAULT_MSG LIBBSON_FOUND)
+elseif(LIBBSON_DIR)
+  # The best we can do until libbson starts installing a libbson-config.cmake file
+  set(LIBBSON_LIBRARIES bson-1.0 CACHE INTERNAL "")
+  set(LIBBSON_LIBRARY_DIRS ${LIBBSON_DIR}/lib CACHE INTERNAL "")
+  set(LIBBSON_INCLUDE_DIRS ${LIBBSON_DIR}/include/libbson-1.0 CACHE INTERNAL "")
+  find_package_handle_standard_args(LIBBSON DEFAULT_MSG LIBBSON_LIBRARIES LIBBSON_LIBRARY_DIRS LIBBSON_INCLUDE_DIRS)
+else()
+  message(FATAL_ERROR "Don't know how to find libbson; please set LIBBSON_DIR to the prefix directory with which libbson was configured.")
+endif()

cmake/FindLibMongoC.cmake

@@ -0,0 +1,24 @@
+# Find libmongo-c, either via pkg-config, find-package in config mode,
+# or other less admirable jiggery-pokery
+
+SET(LIBMONGOC_DIR "" CACHE STRING "Manual search path for libmongoc")
+
+include(FindPackageHandleStandardArgs)
+
+# Load up PkgConfig if we have it
+find_package(PkgConfig QUIET)
+
+if (PKG_CONFIG_FOUND)
+  pkg_check_modules(LIBMONGOC REQUIRED libmongoc-1.0>=${LibMongoC_FIND_VERSION} )
+  # We don't reiterate the version information here because we assume that
+  # pkg_check_modules has honored our request.
+  find_package_handle_standard_args(LIBMONGOC DEFAULT_MSG LIBMONGOC_FOUND)
+elseif(LIBMONGOC_DIR)
+  # The best we can do until libMONGOC starts installing a libmongoc-config.cmake file
+  set(LIBMONGOC_LIBRARIES mongoc-1.0 CACHE INTERNAL "")
+  set(LIBMONGOC_LIBRARY_DIRS ${LIBMONGOC_DIR}/lib CACHE INTERNAL "")
+  set(LIBMONGOC_INCLUDE_DIRS ${LIBMONGOC_DIR}/include/libMONGOC-1.0 CACHE INTERNAL "")
+  find_package_handle_standard_args(LIBMONGOC DEFAULT_MSG LIBMONGOC_LIBRARIES LIBMONGOC_LIBRARY_DIRS LIBMONGOC_INCLUDE_DIRS)
+else()
+    message(FATAL_ERROR "Don't know how to find libmongoc; please set LIBMONGOC_DIR to the prefix directory with which libbson was configured.")
+endif()

cmake/Findbsoncxx.cmake

@@ -1,11 +1,11 @@
 add_custom_target(install_headers
     COMMAND "${CMAKE_COMMAND}" -DCMAKE_INSTALL_COMPONENT=dev -P "${CMAKE_BINARY_DIR}/cmake_install.cmake"
-    DEPENDS bsoncxx mongocxx
+    DEPENDS bsoncxx_built mongocxx_built
 )
 
 add_custom_target(install_libs
     COMMAND "${CMAKE_COMMAND}" -DCMAKE_INSTALL_COMPONENT=runtime -P "${CMAKE_BINARY_DIR}/cmake_install.cmake"
-    DEPENDS bsoncxx mongocxx
+    DEPENDS bsoncxx_built mongocxx_built
 )
 
 add_subdirectory(bsoncxx)

cmake/Findmongocxx.cmake

@@ -1,13 +1,15 @@
 project(BSONCXX)
 
+set(LIBBSON_REQUIRED_ABI_VERSION 1.0)
+find_package(LibBSON 1.3.0 REQUIRED)
+
 # Update these as needed.
 # TODO: read from file
 set(BSONCXX_VERSION_MAJOR 0)
 set(BSONCXX_VERSION_MINOR 3)
 set(BSONCXX_VERSION_PATCH 0)
 set(BSONCXX_VERSION_EXTRA "-pre")
 set(BSONCXX_ABI_VERSION 0)
-set(LIBBSON_REQUIRED_ABI_VERSION 1.0)
 
 set(BSONCXX_VERSION ${BSONCXX_VERSION_MAJOR}.${BSONCXX_VERSION_MINOR}.${BSONCXX_VERSION_PATCH})
 set(BSONCXX_INLINE_NAMESPACE "v${BSONCXX_ABI_VERSION}")
@@ -22,8 +24,6 @@ option(BSONCXX_POLY_USE_MNMLSTC "Use mnmlstc/core for stdx polyfills" ON)
 option(BSONCXX_POLY_USE_SYSTEM_MNMLSTC "Obtain mnmlstc/core from system" OFF)
 option(BSONCXX_POLY_USE_BOOST "Use boost for stdx polyfills" OFF)
 
-pkg_check_modules(LIBBSON REQUIRED libbson-${LIBBSON_REQUIRED_ABI_VERSION})
-
 add_subdirectory(third_party)
 add_subdirectory(config)
 
@@ -65,10 +65,20 @@ add_library(bsoncxx_static STATIC
     ${bsoncxx_sources}
 )
 
+target_compile_definitions(bsoncxx_static PUBLIC BSONCXX_STATIC)
+
 set_target_properties(bsoncxx_static PROPERTIES
     OUTPUT_NAME bsoncxx
 )
 
+# Follow the boost convention to disambiguate the dll and static
+# library names
+if (WIN32)
+    set_target_properties(bsoncxx_static PROPERTIES
+        PREFIX lib
+    )
+endif()
+
 add_library(bsoncxx SHARED
     ${bsoncxx_sources}
 )
@@ -88,7 +98,7 @@ generate_export_header(bsoncxx
     BASE_NAME BSONCXX
     EXPORT_MACRO_NAME BSONCXX_API
     NO_EXPORT_MACRO_NAME BSONCXX_PRIVATE
-    EXPORT_FILE_NAME export.hpp
+    EXPORT_FILE_NAME config/export.hpp
     STATIC_DEFINE BSONCXX_STATIC
 )
 
@@ -114,19 +124,58 @@ install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
 )
 
 install(FILES
-    ${CMAKE_CURRENT_BINARY_DIR}/export.hpp
-    DESTINATION ${BSONCXX_HEADER_INSTALL_DIR}/bsoncxx
+    ${CMAKE_CURRENT_BINARY_DIR}/config/export.hpp
+    DESTINATION ${BSONCXX_HEADER_INSTALL_DIR}/bsoncxx/config
     COMPONENT dev
 )
 
 install(TARGETS
     bsoncxx
     LIBRARY DESTINATION lib COMPONENT runtime
+    ARCHIVE DESTINATION lib COMPONENT dev
 )
 
 install(TARGETS
     bsoncxx_static
-    ARCHIVE DESTINATION lib COMPONENT runtime
+    ARCHIVE DESTINATION lib COMPONENT dev
+)
+
+set(PACKAGE_INCLUDE_INSTALL_DIRS ${BSONCXX_HEADER_INSTALL_DIR})
+set(PACKAGE_LIBRARY_INSTALL_DIRS lib)
+set(PACKAGE_LIBRARIES bsoncxx)
+
+include(CMakePackageConfigHelpers)
+
+configure_package_config_file(
+  cmake/libbsoncxx-config.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/libbsoncxx-config.cmake
+  INSTALL_DESTINATION lib/cmake/libbsoncxx-${BSONCXX_VERSION}
+  PATH_VARS PACKAGE_INCLUDE_INSTALL_DIRS PACKAGE_LIBRARY_INSTALL_DIRS
+)
+
+write_basic_package_version_file(
+  ${CMAKE_CURRENT_BINARY_DIR}/libbsoncxx-config-version.cmake
+  VERSION ${BSONCXX_VERSION}
+  COMPATIBILITY SameMajorVersion
+)
+
+install(
+  FILES ${CMAKE_CURRENT_BINARY_DIR}/libbsoncxx-config.cmake ${CMAKE_CURRENT_BINARY_DIR}/libbsoncxx-config-version.cmake
+  DESTINATION lib/cmake/libbsoncxx-${BSONCXX_VERSION}
+)
+
+# Add all generated targets as dependencies here. This is a proxy
+# to allow the examples build to be sequenced after the mongocxx build
+# since you can't currently depend on an install target in CMake.
+add_custom_target(bsoncxx_built
+  DEPENDS
+  bsoncxx
+  bsoncxx_static
+  ${CMAKE_CURRENT_BINARY_DIR}/config/export.hpp
+  ${CMAKE_CURRENT_BINARY_DIR}/config/version.hpp
+  ${CMAKE_CURRENT_BINARY_DIR}/config/config.hpp
+  ${CMAKE_CURRENT_BINARY_DIR}/config/private/config.hpp
+  ${CMAKE_CURRENT_BINARY_DIR}/libbsoncxx-config.cmake
+  ${CMAKE_CURRENT_BINARY_DIR}/libbsoncxx-config-version.cmake
 )
 
 add_subdirectory(test)

examples/CMakeLists.txt

@@ -0,0 +1,11 @@
+set(LIBBSONCXX_VERSION_MAJOR @BSONCXX_VERSION_MAJOR@)
+set(LIBBSONCXX_VERSION_MINOR @BSONCXX_VERSION_MINOR@)
+set(LIBBSONCXX_VERSION_PATCH @BSONCXX_VERSION_PATCH@)
+set(LIBBSONCXX_PACKAGE_VERSION @BSONCXX_VERSION@)
+set(LIBBSONCXX_LIBRARIES bsoncxx)
+
+@PACKAGE_INIT@
+
+set_and_check(LIBBSONCXX_INCLUDE_DIRS "${PACKAGE_PREFIX_DIR}/@PACKAGE_INCLUDE_INSTALL_DIRS@")
+set_and_check(LIBBSONCXX_LIBRARY_DIRS "${PACKAGE_PREFIX_DIR}/@PACKAGE_LIBRARY_INSTALL_DIRS@")
+

src/bsoncxx/CMakeLists.txt

@@ -28,6 +28,6 @@ configure_file(
 
 install(FILES
     "${CMAKE_CURRENT_BINARY_DIR}/libbsoncxx.pc"
-    DESTINATION "${PKG_CONFIG_PATH}"
-    COMPONENT runtime
+    DESTINATION lib/pkgconfig
+    COMPONENT dev
 )

src/bsoncxx/cmake/libbsoncxx-config.cmake.in

@@ -12,4 +12,15 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+#if defined(_MSC_VER)
+
+// Disable MSVC warnings that cause a lot of noise related to DLL visibility
+// for types that we don't control (like std::unique_ptr).
+#pragma warning(push)
+#pragma warning(disable: 4251)
+
+#define BSONCXX_INLINE inline __forceinline
+
+#else
 #define BSONCXX_INLINE inline __attribute__((__visibility__("hidden"), __always_inline__))
+#endif

src/bsoncxx/config/CMakeLists.txt

@@ -2,8 +2,8 @@ prefix=@CMAKE_INSTALL_PREFIX@
 includedir=${prefix}/include
 libdir=${prefix}/lib
 
-Name: bsoncxx
-Description: The BSON C++ Library
+Name: libbsoncxx
+Description: The MongoDB C++11 BSON Library
 URL: http://github.com/mongodb/mongo-cxx-driver
 Version: @BSONCXX_VERSION@
 Requires.private: libbson-@LIBBSON_REQUIRED_ABI_VERSION@

src/bsoncxx/config/compiler.hpp

@@ -19,6 +19,9 @@
 // compiler.hpp
 #undef BSONCXX_INLINE
 #pragma pop_macro("BSONCXX_INLINE")
+#if defined(_MSC_VER)
+#pragma warning(pop)
+#endif
 
 // src/bsoncxx/config/config.hpp.in
 #undef BSONCXX_INLINE_NAMESPACE_BEGIN
@@ -63,6 +66,8 @@ static_assert(false, "BSONCXX_ENUM must be undef'ed");
 #pragma pop_macro("BSONCXX_NO_DEPRECATED")
 #undef BSONCXX_PRIVATE
 #pragma pop_macro("BSONCXX_PRIVATE")
+#undef BSONCXX_API
+#pragma pop_macro("BSONCXX_API")
 
 // prelude.hpp
 #undef BSONCXX_UNREACHABLE

src/bsoncxx/config/libbsoncxx.pc.in

@@ -61,11 +61,13 @@
 #undef BSONCXX_NO_DEPRECATED
 #pragma push_macro("BSONCXX_PRIVATE")
 #undef BSONCXX_PRIVATE
+#pragma push_macro("BSONCXX_API")
+#undef BSONCXX_API
 
 #include <bsoncxx/config/compiler.hpp>
 #include <bsoncxx/config/config.hpp>
 #include <bsoncxx/config/version.hpp>
-#include <bsoncxx/export.hpp>
+#include <bsoncxx/config/export.hpp>
 
 #pragma push_macro("BSONCXX_UNREACHABLE")
 #undef BSONCXX_UNREACHABLE