PR #11587 from Eran: external json & pybind11_json

IntelRealSense · Mar 20, 2023 · 80240b1 · 80240b1
2 parents 50d0b92 + dd37915
commit 80240b1
Show file tree

Hide file tree

Showing 33 changed files with 165 additions and 24,851 deletions.
diff --git a/CMake/external_json.cmake b/CMake/external_json.cmake
@@ -0,0 +1,41 @@
+cmake_minimum_required(VERSION 3.6)
+include(ExternalProject)
+
+
+
+# We use a function to enforce a scoped variables creation only for the build
+# (i.e turn off BUILD_SHARED_LIBS which is used on LRS build as well)
+function(get_nlohmann_json)
+
+    message( STATUS #CHECK_START
+        "Fetching nlohmann/json..." )
+    #list( APPEND CMAKE_MESSAGE_INDENT "  " )  # Indent outputs
+
+    # We want to clone the pybind repo and build it here, during configuration, so we can use it.
+    # But ExternalProject_add is limited in that it only does its magic during build.
+    # This is possible in CMake 3.12+ with FetchContent and FetchContent_MakeAvailable in 3.14+ (meaning Ubuntu 20)
+    # but we need to adhere to CMake 3.10 (Ubuntu 18).
+    # So instead, we invoke a new CMake project just to download pybind:
+    configure_file( CMake/json-download.cmake.in
+                    ${CMAKE_BINARY_DIR}/external-projects/json-download/CMakeLists.txt )
+    execute_process( COMMAND "${CMAKE_COMMAND}" -G "${CMAKE_GENERATOR}" .
+                     WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/external-projects/json-download"
+                     OUTPUT_QUIET
+                     RESULT_VARIABLE configure_ret )
+    execute_process( COMMAND "${CMAKE_COMMAND}" --build .
+                     WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/external-projects/json-download"
+                     OUTPUT_QUIET
+                     RESULT_VARIABLE build_ret )
+
+    if( configure_ret OR build_ret )
+        message( FATAL_ERROR "Failed to download nlohmann/json" )
+    endif()
+
+    message( STATUS #CHECK_PASS
+        "Fetching nlohmann/json - Done" )
+    #list( POP_BACK CMAKE_MESSAGE_INDENT ) # Unindent outputs (requires cmake 3.15)
+
+endfunction()
+
+# Trigger the build
+get_nlohmann_json()
diff --git a/CMake/external_pybind11.cmake b/CMake/external_pybind11.cmake
@@ -28,7 +28,7 @@ function(get_pybind11)
                      RESULT_VARIABLE build_ret )
 
     if( configure_ret OR build_ret )
-        message( FATAL_ERROR "Failed to build pybind11" )
+        message( FATAL_ERROR "Failed to download pybind11" )
     endif()
 
     # Now that it's available, we can refer to it with an actual ExternalProject_add (but notice we're not
@@ -85,8 +85,45 @@ function(get_pybind11)
 
 endfunction()
 
+
+# We also want a json-compatible pybind interface:
+function(get_pybind11_json)
+
+    message( STATUS #CHECK_START
+        "Fetching pybind11_json..." )
+    #list( APPEND CMAKE_MESSAGE_INDENT "  " )  # Indent outputs
+
+    # We want to clone the pybind repo and build it here, during configuration, so we can use it.
+    # But ExternalProject_add is limited in that it only does its magic during build.
+    # This is possible in CMake 3.12+ with FetchContent and FetchContent_MakeAvailable in 3.14+ (meaning Ubuntu 20)
+    # but we need to adhere to CMake 3.10 (Ubuntu 18).
+    # So instead, we invoke a new CMake project just to download pybind:
+    configure_file( CMake/pybind11-json-download.cmake.in
+                    ${CMAKE_BINARY_DIR}/external-projects/pybind11-json-download/CMakeLists.txt )
+    execute_process( COMMAND "${CMAKE_COMMAND}" -G "${CMAKE_GENERATOR}" .
+                     WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/external-projects/pybind11-json-download"
+                     OUTPUT_QUIET
+                     RESULT_VARIABLE configure_ret )
+    execute_process( COMMAND "${CMAKE_COMMAND}" --build .
+                     WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/external-projects/pybind11-json-download"
+                     OUTPUT_QUIET
+                     RESULT_VARIABLE build_ret )
+
+    if( configure_ret OR build_ret )
+        message( FATAL_ERROR "Failed to download pybind11_json" )
+    endif()
+
+    # pybind11_add_module will add the directory automatically (see below)
+
+    message( STATUS #CHECK_PASS
+        "Fetching pybind11_json - Done" )
+    #list( POP_BACK CMAKE_MESSAGE_INDENT ) # Unindent outputs (requires cmake 3.15)
+
+endfunction()
+
 # Trigger the build
 get_pybind11()
+get_pybind11_json()
 
 # This function overrides "pybind11_add_module" function,  arguments is same as "pybind11_add_module" arguments
 # pybind11_add_module(<name> SHARED [file, file2, ...] )
@@ -103,5 +140,7 @@ function( pybind11_add_module project_name library_type ...)
     # (workaround for RS5-10582; see also https://github.com/pybind/pybind11/issues/2898)
     # NOTE: this workaround seems to be needed for debug compilations only
     target_compile_definitions( ${project_name} PRIVATE -DPYBIND11_COMPILER_TYPE=\"_${project_name}_abi\" )
-
+
+    target_include_directories( ${project_name} PRIVATE "${CMAKE_BINARY_DIR}/third-party/pybind11-json/include" )
+
 endfunction()
diff --git a/CMake/json-download.cmake.in b/CMake/json-download.cmake.in
@@ -0,0 +1,19 @@
+cmake_minimum_required(VERSION 3.6)
+project(nlohmann-json-download NONE)
+
+include(ExternalProject)
+ExternalProject_Add(
+    nlohmann_json
+    PREFIX .
+    GIT_REPOSITORY "https://github.com/nlohmann/json.git"
+    #GIT_TAG        v3.11.2
+    GIT_CONFIG     advice.detachedHead=false  # otherwise we'll get "You are in 'detached HEAD' state..."
+    SOURCE_DIR     "${CMAKE_BINARY_DIR}/third-party/json"
+    GIT_SHALLOW    1        # No history needed (requires cmake 3.6)
+    # Override default steps with no action, we just want the clone step.
+    CONFIGURE_COMMAND ""
+    BUILD_COMMAND ""
+    INSTALL_COMMAND ""
+    )
+
+
diff --git a/CMake/pybind11-json-download.cmake.in b/CMake/pybind11-json-download.cmake.in
@@ -0,0 +1,19 @@
+cmake_minimum_required(VERSION 3.6)
+project(pybind11-json-download NONE)
+
+include(ExternalProject)
+ExternalProject_Add(
+    pybind11_json
+    PREFIX .
+    GIT_REPOSITORY "https://github.com/pybind/pybind11_json.git"
+    GIT_TAG        0.2.13
+    GIT_CONFIG     advice.detachedHead=false  # otherwise we'll get "You are in 'detached HEAD' state..."
+    SOURCE_DIR     "${CMAKE_BINARY_DIR}/third-party/pybind11-json"
+    GIT_SHALLOW    ON        # No history needed (requires cmake 3.6)
+    # Override default steps with no action, we just want the clone step.
+    CONFIGURE_COMMAND ""
+    BUILD_COMMAND ""
+    INSTALL_COMMAND ""
+    )
+
+
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -61,6 +61,12 @@ include(src/CMakeLists.txt)
 include(third-party/CMakeLists.txt)
 include(common/utilities/CMakeLists.txt)
 
+include(CMake/external_json.cmake)
+target_include_directories( rsutils
+    PUBLIC
+        $<BUILD_INTERFACE:${CMAKE_BINARY_DIR}/third-party/json/include>
+    )
+
 target_link_libraries( ${LRS_TARGET} PUBLIC rsutils )
 
 if(BUILD_WITH_DDS)

diff --git a/common/device-model.h b/common/device-model.h
@@ -6,7 +6,7 @@
 #include <set>
 #include "notifications.h"
 #include "realsense-ui-advanced-mode.h"
-#include <json.hpp>
+#include <nlohmann/json.hpp>
 #include "sw-update/dev-updates-profile.h"
 #include <rsutils/time/periodic-timer.h>
 #include "updates-model.h"

diff --git a/common/rs-config.cpp b/common/rs-config.cpp
@@ -3,7 +3,7 @@
 
 #include "rs-config.h"
 
-#include "../third-party/json.hpp"
+#include <nlohmann/json.hpp>
 
 #include "model-views.h"
 
@@ -139,4 +139,4 @@ config_file& config_file::operator=(const config_file& other)
 bool config_file::operator==(const config_file& other) const
 {
     return _values == other._values;
-}
+}
diff --git a/common/subdevice-model.h b/common/subdevice-model.h
@@ -17,7 +17,7 @@
 #include <array>
 #include <unordered_map>
 
-#include "../third-party/json.hpp"
+#include <nlohmann/json.hpp>
 #include "objects-in-frame.h"
 #include "processing-block-model.h"
 

diff --git a/common/sw-update/versions-db-manager.cpp b/common/sw-update/versions-db-manager.cpp
@@ -5,7 +5,7 @@
 #include <algorithm>
 #include <regex>
 
-#include "json.hpp"
+#include <nlohmann/json.hpp>
 #include "versions-db-manager.h"
 #include <types.h>
 

diff --git a/src/context.h b/src/context.h
@@ -8,7 +8,7 @@
 #include "core/streaming.h"
 
 #include <vector>
-#include <third-party/json_fwd.hpp>
+#include <nlohmann/json_fwd.hpp>
 #include "media/playback/playback_device.h"
 
 namespace librealsense

diff --git a/src/ds/advanced_mode/json_loader.hpp b/src/ds/advanced_mode/json_loader.hpp
@@ -12,7 +12,7 @@
 #include <string>
 #include <iomanip>
 
-#include "../../../third-party/json.hpp"
+#include <nlohmann/json.hpp>
 #include <librealsense2/h/rs_advanced_mode_command.h>
 #include "types.h"
 #include "presets.h"

diff --git a/src/ds/d400/d400-auto-calibration.cpp b/src/ds/d400/d400-auto-calibration.cpp
@@ -2,7 +2,7 @@
 // Copyright(c) 2016 Intel Corporation. All Rights Reserved.
 
 #include <numeric>
-#include "../third-party/json.hpp"
+#include <nlohmann/json.hpp>
 #include "d400-device.h"
 #include "d400-private.h"
 #include "d400-thermal-monitor.h"

diff --git a/src/ds/d400/d400-device.cpp b/src/ds/d400/d400-device.cpp
@@ -25,7 +25,7 @@
 #include "d400-thermal-monitor.h"
 #include <common/fw/firmware-version.h>
 #include <src/fw-update/fw-update-unsigned.h>
-#include <third-party/json.hpp>
+#include <nlohmann/json.hpp>
 
 #include <regex>
 #include <iterator>

diff --git a/src/l500/l500-serializable.cpp b/src/l500/l500-serializable.cpp
@@ -4,7 +4,7 @@
 #include <set>
 #include "l500-serializable.h"
 #include "l500-options.h"
-#include <third-party/json.hpp>
+#include <nlohmann/json.hpp>
 #include <src/serialized-utilities.h>
 
 namespace librealsense

diff --git a/src/serialized-utilities.h b/src/serialized-utilities.h
@@ -5,7 +5,7 @@
 #include <string>
 #include <map>
 #include <types.h>
-#include <third-party/json.hpp>
+#include <nlohmann/json.hpp>
 
 
 namespace librealsense

diff --git a/src/software-device.cpp b/src/software-device.cpp
@@ -6,7 +6,7 @@
 
 #include <rsutils/string/from.h>
 #include <rsutils/deferred.h>
-#include <third-party/json.hpp>
+#include <nlohmann/json.hpp>
 
 using rsutils::deferred;