CDRIVER-2801 Possibility to install as darwin framework.

Author: henrikedin

CMakeLists.txt

@@ -48,6 +48,7 @@ option (ENABLE_RDTSCP
    "Fast performance counters on Intel using the RDTSCP instruction"
    OFF
 )
+option (ENABLE_APPLE_FRAMEWORK "Build libraries as frameworks on darwin platforms" OFF) 
 set (ENABLE_ICU AUTO CACHE STRING "Enable ICU support, necessary to use non-ASCII usernames or passwords, default AUTO.")
 
 project (mongo-c-driver C)
@@ -140,19 +141,8 @@ set (BUILD_SOURCE_DIR ${CMAKE_BINARY_DIR})
 
 include (MakeDistFiles)
 
-if (NOT BSON_LIBRARIES)
-   message ("  -- Using bundled libbson")
-   if (ENABLE_STATIC MATCHES "ON|AUTO")
-      set (MONGOC_ENABLE_STATIC ON)
-   endif ()
-   add_subdirectory (src/libbson)
-   # Defined in src/libbson/CMakeLists.txt
-   set (BSON_STATIC_LIBRARIES bson_static)
-   set (BSON_LIBRARIES bson_shared)
-   set (BSON_STATIC_INCLUDE_DIRS "${PROJECT_SOURCE_DIR}/src/libbson/src" "${PROJECT_BINARY_DIR}/src/libbson/src")
-   set (BSON_INCLUDE_DIRS "${PROJECT_SOURCE_DIR}/src/libbson/src" "${PROJECT_BINARY_DIR}/src/libbson/src")
-   set (BSON_STATIC_DEFINITIONS "BSON_STATIC")
-endif ()
+# Ensure the default behavior: don't ignore RPATH settings.
+set (CMAKE_SKIP_BUILD_RPATH OFF)
 
 # Ensure the default behavior: don't use the final install destination as the
 # temporary RPATH for executables (ensure we can run tests and programs from
@@ -170,6 +160,20 @@ set (CMAKE_MACOSX_RPATH ON)
 # silence a CMake 3.11 warning that the old behavior is deprecated.
 cmake_policy (SET CMP0042 NEW)
 
+if (NOT BSON_LIBRARIES)
+   message ("  -- Using bundled libbson")
+   if (ENABLE_STATIC MATCHES "ON|AUTO")
+      set (MONGOC_ENABLE_STATIC ON)
+   endif ()
+   add_subdirectory (src/libbson)
+   # Defined in src/libbson/CMakeLists.txt
+   set (BSON_STATIC_LIBRARIES bson_static)
+   set (BSON_LIBRARIES bson_shared)
+   set (BSON_STATIC_INCLUDE_DIRS "${PROJECT_SOURCE_DIR}/src/libbson/src" "${PROJECT_BINARY_DIR}/src/libbson/src")
+   set (BSON_INCLUDE_DIRS "${PROJECT_SOURCE_DIR}/src/libbson/src" "${PROJECT_BINARY_DIR}/src/libbson/src")
+   set (BSON_STATIC_DEFINITIONS "BSON_STATIC")
+endif ()
+
 if (MSVC)
    add_definitions (-D_CRT_SECURE_NO_WARNINGS)
 endif ()

src/libbson/CMakeLists.txt

@@ -136,6 +136,13 @@ configure_file (
    "${PROJECT_BINARY_DIR}/src/bson/bson-version.h"
 )
 
+if (ENABLE_APPLE_FRAMEWORK)
+   configure_file (
+      "${PROJECT_SOURCE_DIR}/src/bson/modules/module.modulemap.in"
+      "${PROJECT_BINARY_DIR}/src/bson/modules/module.modulemap"
+   )
+endif ()
+
 include_directories ("${PROJECT_BINARY_DIR}/src")
 include_directories ("${PROJECT_SOURCE_DIR}/src")
 include_directories ("${PROJECT_SOURCE_DIR}/../../src/common")
@@ -216,6 +223,17 @@ set_target_properties (bson_shared PROPERTIES COMPILE_DEFINITIONS "BSON_COMPILAT
 set_target_properties (bson_shared PROPERTIES VERSION 0.0.0 SOVERSION 0)
 set_target_properties (bson_shared PROPERTIES OUTPUT_NAME "bson-${BSON_API_VERSION}" PREFIX "lib")
 
+if (ENABLE_APPLE_FRAMEWORK)
+   set_target_properties(bson_shared PROPERTIES 
+      FRAMEWORK TRUE 
+      MACOSX_FRAMEWORK_BUNDLE_VERSION ${MONGOC_VERSION} 
+      MACOSX_FRAMEWORK_SHORT_VERSION_STRING ${MONGOC_VERSION}
+      MACOSX_FRAMEWORK_IDENTIFIER org.mongodb.bson
+      OUTPUT_NAME "bson"
+      PUBLIC_HEADER "${HEADERS}" 
+   )
+endif ()
+
 if (RT_LIBRARY)
    target_link_libraries (bson_shared ${RT_LIBRARY})
 endif ()
@@ -291,13 +309,15 @@ install (
    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+   FRAMEWORK DESTINATION ${CMAKE_INSTALL_BINDIR} 
 )
 if (ENABLE_STATIC MATCHES "ON|AUTO")
    install (
       TARGETS bson_static ${EXAMPLES}
       LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
       ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
       RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+      FRAMEWORK DESTINATION ${CMAKE_INSTALL_BINDIR} 
    )
 endif ()
 install (
@@ -309,6 +329,13 @@ install (
    DESTINATION "${BSON_HEADER_INSTALL_DIR}"
 )
 
+if (ENABLE_APPLE_FRAMEWORK)
+   install (
+      FILES "${PROJECT_BINARY_DIR}/src/bson/modules/module.modulemap"
+      DESTINATION "${CMAKE_INSTALL_BINDIR}/bson.framework/Modules/"
+   )
+endif ()
+
 set (LIBBSON_LIBRARIES "")
 foreach (_lib ${CMAKE_C_IMPLICIT_LINK_LIBRARIES} ${BSON_LIBRARIES})
    if (_lib MATCHES ".*/.*" OR _lib MATCHES "^-")

src/libbson/src/bson/modules/module.modulemap.in

@@ -0,0 +1,5 @@
+framework module bson [system] {
+    umbrella header "bson.h"
+    
+    export *
+}

src/libmongoc/CMakeLists.txt

@@ -374,6 +374,13 @@ configure_file (
    "${PROJECT_BINARY_DIR}/src/mongoc/mongoc-version.h"
 )
 
+if (ENABLE_APPLE_FRAMEWORK)
+   configure_file (
+      "${PROJECT_SOURCE_DIR}/src/mongoc/modules/module.modulemap.in"
+      "${PROJECT_BINARY_DIR}/src/mongoc/modules/module.modulemap"
+   )
+endif ()
+
 include_directories ("${PROJECT_BINARY_DIR}/src")
 include_directories ("${PROJECT_SOURCE_DIR}/src")
 include_directories ("${PROJECT_SOURCE_DIR}/../../src/common")
@@ -620,6 +627,17 @@ if (MONGOC_ENABLE_STATIC)
    set_target_properties (mongoc_static PROPERTIES OUTPUT_NAME "mongoc-static-${MONGOC_API_VERSION}")
 endif ()
 
+if (ENABLE_APPLE_FRAMEWORK)
+   set_target_properties (mongoc_shared PROPERTIES 
+      FRAMEWORK TRUE 
+      MACOSX_FRAMEWORK_BUNDLE_VERSION ${MONGOC_VERSION} 
+      MACOSX_FRAMEWORK_SHORT_VERSION_STRING ${MONGOC_VERSION}
+      MACOSX_FRAMEWORK_IDENTIFIER org.mongodb.mongoc
+      OUTPUT_NAME "mongoc"
+      PUBLIC_HEADER "${HEADERS}" 
+   )
+endif ()
+
 add_executable (mongoc-stat ${PROJECT_SOURCE_DIR}/../../src/tools/mongoc-stat.c)
 target_link_libraries (mongoc-stat mongoc_shared)
 
@@ -857,6 +875,7 @@ install (
    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+   FRAMEWORK DESTINATION ${CMAKE_INSTALL_BINDIR} 
 )
 
 if (MONGOC_ENABLE_STATIC)
@@ -865,6 +884,7 @@ if (MONGOC_ENABLE_STATIC)
       LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
       ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
       RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+      FRAMEWORK DESTINATION ${CMAKE_INSTALL_BINDIR} 
    )
 endif ()
 
@@ -882,6 +902,13 @@ install (
    DESTINATION "${MONGOC_HEADER_INSTALL_DIR}"
 )
 
+if (ENABLE_APPLE_FRAMEWORK)
+   install (
+      FILES "${PROJECT_BINARY_DIR}/src/mongoc/modules/module.modulemap"
+      DESTINATION "${CMAKE_INSTALL_BINDIR}/mongoc.framework/Modules/"
+   )
+endif ()
+
 # Define pkg-config files
 set (VERSION "${MONGOC_VERSION}")
 set (prefix "${CMAKE_INSTALL_PREFIX}")

src/libmongoc/src/mongoc/modules/module.modulemap.in

@@ -0,0 +1,5 @@
+framework module mongoc {
+    umbrella header "mongoc.h"
+    
+    export *
+}