Merge pull request #5367 from franzpoeschel/fix-toml-json-version-mismatches

toml11/nlohmann-json: avoid symbol clashes with different versions in upstream dependencies

Author: ikbuibui

include/picongpu/CMakeLists.txt

@@ -580,22 +580,30 @@ if(PIC_HAVE_openPMD)
         PRIVATE $<TARGET_PROPERTY:toml11::toml11,INTERFACE_INCLUDE_DIRECTORIES>
     )
     target_link_libraries(picongpu-hostonly PRIVATE toml11::toml11)
+endif()
 
+foreach(target picongpu picongpu-hostonly)
     # This is a workaround for a missing API call in the openPMD-api,
     # which currently does not re-export backend version information.
     # https://github.com/openPMD/openPMD-api/issues/1563
-    if(openPMD_HAVE_ADIOS2)
-        foreach(target picongpu picongpu-hostonly)
-            target_compile_definitions(
-                ${target}
-                PRIVATE
-                    ADIOS2_VERSION_MAJOR=${ADIOS2_VERSION_MAJOR}
-                    ADIOS2_VERSION_MINOR=${ADIOS2_VERSION_MINOR}
-                    ADIOS2_VERSION_PATCH=${ADIOS2_VERSION_PATCH}
-            )
-        endforeach()
+    if(PIC_HAVE_openPMD AND openPMD_HAVE_ADIOS2)
+        target_compile_definitions(
+            ${target}
+            PRIVATE
+                ADIOS2_VERSION_MAJOR=${ADIOS2_VERSION_MAJOR}
+                ADIOS2_VERSION_MINOR=${ADIOS2_VERSION_MINOR}
+                ADIOS2_VERSION_PATCH=${ADIOS2_VERSION_PATCH}
+        )
     endif()
-endif()
+
+    # Workaround for this bug https://github.com/nlohmann/json/issues/3907
+    # We don't need ranges in <nlohmann/json.hpp>
+    target_compile_definitions(${target} PRIVATE JSON_HAS_RANGES=0)
+
+    # Automatic detection of std::source_location availability fails
+    # on Clang 12 through 14
+    target_compile_definitions(${target} PRIVATE TOML11_DISABLE_SOURCE_LOCATION)
+endforeach()
 
 ## annotate with RPATH's
 if(PIC_ADD_RPATH)

share/picongpu/unit/CMakeLists.txt

@@ -106,6 +106,10 @@ add_library(
 target_link_libraries(argparser PRIVATE ${HOST_LIBS})
 target_link_libraries(argparser PRIVATE pmacc::pmacc)
 
+# Workaround for this bug https://github.com/nlohmann/json/issues/3907
+# We don't need ranges in <nlohmann/json.hpp>
+target_compile_definitions(argparser PRIVATE JSON_HAS_RANGES=0)
+
 # Add subdirectories for tests
 add_subdirectory(dimensional_tests)
 add_subdirectory(non_dimensional_tests)

share/picongpu/unit/dimensional_tests/CMakeLists.txt

@@ -8,6 +8,9 @@ foreach(dim 2 3)
         alpaka_add_executable(${testExe} ${testCaseFilepath})
         target_include_directories(${testExe} PRIVATE BEFORE "${CMAKE_CURRENT_SOURCE_DIR}/../../../../include")
         target_include_directories(${testExe} PRIVATE BEFORE "${CMAKE_CURRENT_SOURCE_DIR}/include")
+        # Workaround for this bug https://github.com/nlohmann/json/issues/3907
+        # We don't need ranges in <nlohmann/json.hpp>
+        target_compile_definitions(${testExe} PRIVATE JSON_HAS_RANGES=0)
         target_compile_definitions(${testExe} PRIVATE TEST_DIM=${dim})
         target_link_libraries(${testExe} PUBLIC Catch2 Catch2WithMain)
         target_link_libraries(${testExe} PRIVATE pmacc::pmacc)

share/picongpu/unit/non_dimensional_tests/CMakeLists.txt

@@ -6,6 +6,9 @@ foreach(testCaseFilepath ${NON_DIMENSIONAL_TESTS})
     set(testExe "${PROJECT_NAME}-${testCase}")
     alpaka_add_executable(${testExe} ${testCaseFilepath})
     target_include_directories(${testExe} PRIVATE BEFORE "${CMAKE_CURRENT_SOURCE_DIR}/../../../../include")
+    # Workaround for this bug https://github.com/nlohmann/json/issues/3907
+    # We don't need ranges in <nlohmann/json.hpp>
+    target_compile_definitions(${testExe} PRIVATE JSON_HAS_RANGES=0)
     target_link_libraries(${testExe} PUBLIC Catch2 Catch2WithMain)
     target_link_libraries(${testExe} PRIVATE pmacc::pmacc)
     if(${testExe} MATCHES ".*CLI.*")

test/picongpuHeaderCheck/CMakeLists.txt

@@ -96,6 +96,10 @@ alpaka_add_executable(
         ${_FILES_SOURCE}
 )
 
+# Workaround for this bug https://github.com/nlohmann/json/issues/3907
+# We don't need ranges in <nlohmann/json.hpp>
+target_compile_definitions(${_TARGET_NAME} PRIVATE JSON_HAS_RANGES=0)
+
 target_link_libraries(${_TARGET_NAME} PUBLIC Catch2 Catch2WithMain)
 target_link_libraries(${_TARGET_NAME} PRIVATE pmacc::pmacc)
 target_include_directories(

thirdParty/nlohmann_json/CMakeLists.txt

@@ -1,15 +1,25 @@
-cmake_minimum_required(VERSION 3.1)
+cmake_minimum_required(VERSION 3.5...4.0)
 
 ##
 ## PROJECT
 ## name and version
 ##
-project(nlohmann_json VERSION 3.9.1 LANGUAGES CXX)
+project(nlohmann_json VERSION 3.12.0 LANGUAGES CXX)
+
+##
+## MAIN_PROJECT CHECK
+## determine if nlohmann_json is built as a subproject (using add_subdirectory) or if it is the main project
+##
+set(MAIN_PROJECT OFF)
+if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
+    set(MAIN_PROJECT ON)
+endif()
 
 ##
 ## INCLUDE
 ##
 ##
+set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake ${CMAKE_MODULE_PATH})
 include(ExternalProject)
 
 ##
@@ -21,26 +31,47 @@ if (POLICY CMP0077)
     cmake_policy(SET CMP0077 NEW)
 endif ()
 
-option(JSON_BuildTests "Build the unit tests when BUILD_TESTING is enabled." ON)
-option(JSON_Install "Install CMake targets during install step." ON)
-option(JSON_MultipleHeaders "Use non-amalgamated version of the library." OFF)
-option(JSON_ImplicitConversions "Enable implicit conversions." ON)
+# VERSION_GREATER_EQUAL is not available in CMake 3.1
+if(${MAIN_PROJECT} AND (${CMAKE_VERSION} VERSION_EQUAL 3.13 OR ${CMAKE_VERSION} VERSION_GREATER 3.13))
+    set(JSON_BuildTests_INIT ON)
+else()
+    set(JSON_BuildTests_INIT OFF)
+endif()
+option(JSON_BuildTests                     "Build the unit tests when BUILD_TESTING is enabled." ${JSON_BuildTests_INIT})
+option(JSON_CI                             "Enable CI build targets." OFF)
+option(JSON_Diagnostics                    "Use extended diagnostic messages." OFF)
+option(JSON_Diagnostic_Positions           "Enable diagnostic positions." OFF)
+option(JSON_GlobalUDLs                     "Place user-defined string literals in the global namespace." ON)
+option(JSON_ImplicitConversions            "Enable implicit conversions." ON)
+option(JSON_DisableEnumSerialization       "Disable default integer enum serialization." OFF)
+option(JSON_LegacyDiscardedValueComparison "Enable legacy discarded value comparison." OFF)
+option(JSON_Install                        "Install CMake targets during install step." ${MAIN_PROJECT})
+option(JSON_MultipleHeaders                "Use non-amalgamated version of the library." ON)
+option(JSON_SystemInclude                  "Include as system headers (skip for clang-tidy)." OFF)
+
+if (JSON_CI)
+    include(ci)
+endif ()
 
 ##
 ## CONFIGURATION
 ##
 include(GNUInstallDirs)
 
-set(NLOHMANN_JSON_TARGET_NAME               ${PROJECT_NAME})
-set(NLOHMANN_JSON_CONFIG_INSTALL_DIR        "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}" CACHE INTERNAL "")
+if (NOT DEFINED NLOHMANN_JSON_TARGET_NAME)
+    # Allow overriding the target name when using FetchContent / add_subdirectory.
+    set(NLOHMANN_JSON_TARGET_NAME ${PROJECT_NAME})
+endif()
+
+set(NLOHMANN_JSON_CONFIG_INSTALL_DIR        "${CMAKE_INSTALL_DATADIR}/cmake/${PROJECT_NAME}" CACHE INTERNAL "")
 set(NLOHMANN_JSON_INCLUDE_INSTALL_DIR       "${CMAKE_INSTALL_INCLUDEDIR}")
 set(NLOHMANN_JSON_TARGETS_EXPORT_NAME       "${PROJECT_NAME}Targets")
 set(NLOHMANN_JSON_CMAKE_CONFIG_TEMPLATE     "cmake/config.cmake.in")
 set(NLOHMANN_JSON_CMAKE_CONFIG_DIR          "${CMAKE_CURRENT_BINARY_DIR}")
 set(NLOHMANN_JSON_CMAKE_VERSION_CONFIG_FILE "${NLOHMANN_JSON_CMAKE_CONFIG_DIR}/${PROJECT_NAME}ConfigVersion.cmake")
 set(NLOHMANN_JSON_CMAKE_PROJECT_CONFIG_FILE "${NLOHMANN_JSON_CMAKE_CONFIG_DIR}/${PROJECT_NAME}Config.cmake")
 set(NLOHMANN_JSON_CMAKE_PROJECT_TARGETS_FILE "${NLOHMANN_JSON_CMAKE_CONFIG_DIR}/${PROJECT_NAME}Targets.cmake")
-set(NLOHMANN_JSON_PKGCONFIG_INSTALL_DIR     "${CMAKE_INSTALL_LIBDIR}/pkgconfig")
+set(NLOHMANN_JSON_PKGCONFIG_INSTALL_DIR     "${CMAKE_INSTALL_DATADIR}/pkgconfig")
 
 if (JSON_MultipleHeaders)
     set(NLOHMANN_JSON_INCLUDE_BUILD_DIR "${PROJECT_SOURCE_DIR}/include/")
@@ -51,7 +82,31 @@ else()
 endif()
 
 if (NOT JSON_ImplicitConversions)
-    message(STATUS "Implicit conversions are disabled")
+    message(STATUS "Implicit conversions are disabled (JSON_USE_IMPLICIT_CONVERSIONS=0)")
+endif()
+
+if (JSON_DisableEnumSerialization)
+    message(STATUS "Enum integer serialization is disabled (JSON_DISABLE_ENUM_SERIALIZATION=0)")
+endif()
+
+if (JSON_LegacyDiscardedValueComparison)
+    message(STATUS "Legacy discarded value comparison enabled (JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON=1)")
+endif()
+
+if (JSON_Diagnostics)
+    message(STATUS "Diagnostics enabled (JSON_DIAGNOSTICS=1)")
+endif()
+
+if (JSON_Diagnostic_Positions)
+    message(STATUS "Diagnostic positions enabled (JSON_DIAGNOSTIC_POSITIONS=1)")
+endif()
+
+if (NOT JSON_GlobalUDLs)
+    message(STATUS "User-defined string literals are not put in the global namespace (JSON_USE_GLOBAL_UDLS=0)")
+endif()
+
+if (JSON_SystemInclude)
+    set(NLOHMANN_JSON_SYSTEM_INCLUDE "SYSTEM")
 endif()
 
 ##
@@ -69,14 +124,19 @@ endif()
 target_compile_definitions(
     ${NLOHMANN_JSON_TARGET_NAME}
     INTERFACE
-    JSON_USE_IMPLICIT_CONVERSIONS=$<BOOL:${JSON_ImplicitConversions}>
+    $<$<NOT:$<BOOL:${JSON_GlobalUDLs}>>:JSON_USE_GLOBAL_UDLS=0>
+    $<$<NOT:$<BOOL:${JSON_ImplicitConversions}>>:JSON_USE_IMPLICIT_CONVERSIONS=0>
+    $<$<BOOL:${JSON_DisableEnumSerialization}>:JSON_DISABLE_ENUM_SERIALIZATION=1>
+    $<$<BOOL:${JSON_Diagnostics}>:JSON_DIAGNOSTICS=1>
+    $<$<BOOL:${JSON_Diagnostic_Positions}>:JSON_DIAGNOSTIC_POSITIONS=1>
+    $<$<BOOL:${JSON_LegacyDiscardedValueComparison}>:JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON=1>
 )
 
 target_include_directories(
     ${NLOHMANN_JSON_TARGET_NAME}
-    INTERFACE
+    ${NLOHMANN_JSON_SYSTEM_INCLUDE} INTERFACE
     $<BUILD_INTERFACE:${NLOHMANN_JSON_INCLUDE_BUILD_DIR}>
-    $<INSTALL_INTERFACE:include>
+    $<INSTALL_INTERFACE:${NLOHMANN_JSON_INCLUDE_INSTALL_DIR}>
 )
 
 ## add debug view definition file for msvc (natvis)
@@ -93,19 +153,19 @@ endif()
 
 # Install a pkg-config file, so other tools can find this.
 CONFIGURE_FILE(
-  "${CMAKE_CURRENT_SOURCE_DIR}/cmake/pkg-config.pc.in"
-  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc"
+    "${CMAKE_CURRENT_SOURCE_DIR}/cmake/pkg-config.pc.in"
+    "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc"
+    @ONLY
 )
 
 ##
 ## TESTS
 ## create and configure the unit test target
 ##
-include(CTest) #adds option BUILD_TESTING (default ON)
-
-if(BUILD_TESTING AND JSON_BuildTests)
+if (JSON_BuildTests)
+    include(CTest)
     enable_testing()
-    add_subdirectory(test)
+    add_subdirectory(tests)
 endif()
 
 ##
@@ -141,7 +201,7 @@ if(JSON_Install)
             FILES ${NLOHMANN_NATVIS_FILE}
             DESTINATION .
     )
-endif()
+    endif()
     export(
         TARGETS ${NLOHMANN_JSON_TARGET_NAME}
         NAMESPACE ${PROJECT_NAME}::
@@ -161,4 +221,5 @@ endif()
         FILES "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc"
         DESTINATION ${NLOHMANN_JSON_PKGCONFIG_INSTALL_DIR}
     )
+    include(CPack)
 endif()

thirdParty/nlohmann_json/LICENSE.MIT

@@ -1,6 +1,6 @@
 MIT License 
 
-Copyright (c) 2013-2020 Niels Lohmann
+Copyright (c) 2013-2025 Niels Lohmann
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal