refactor: make use system cJSON library possible (#314)

* refactor: move cJSON_ex.* to a new object library

Signed-off-by: Coelacanthus <[email protected]>

* refactor: make use system cJSON library possible

* When USE_SYSTEM_DEPS is set, follow it.
* When USE_SYSTEM_DEPS is unset, try use system cJSON first, and 
  fallback to vendor one if not found.

Signed-off-by: Coelacanthus <[email protected]>

* refactor: use FetchContent to download cJSON instead of vendor

GIT_REPOSITORY and GIT_TAG SHALL be changed back if [1] was merged and
upstream released new version.

[1]: DaveGamble/cJSON#949

Signed-off-by: Coelacanthus <[email protected]>

* chore: remove unneeded vendor version cJSON

Signed-off-by: Coelacanthus <[email protected]>

* chore(ci): more robust license file copy...

Signed-off-by: Coelacanthus <[email protected]>

---------

Signed-off-by: Coelacanthus <[email protected]>

Author: CoelacanthusHex

.github/scripts/functions.sh

@@ -43,10 +43,8 @@ function download {
 function copy-license {
     local OUTPUT="$1"
 
-    cp "$WORKSPACE/src/LICENSE" "$OUTPUT/LICENSE-lpac"
-    cp "$WORKSPACE/euicc/LICENSE" "$OUTPUT/LICENSE-libeuicc"
-    cp "$WORKSPACE/cjson/LICENSE" "$OUTPUT/LICENSE-cjson"
-    cp "$WORKSPACE/dlfcn-win32/LICENSE" "$OUTPUT/LICENSE-dlfcn-win32"
+    mkdir "$OUTPUT/LICENSES"
+    cp -r "$WORKSPACE/LICENSES" "$OUTPUT/LICENSES"
 }
 
 function copy-curl-woa {

CMakeLists.txt

@@ -65,7 +65,46 @@ if(CPACK_GENERATOR)
     include(CPack)
 endif()
 
-add_subdirectory(cjson)
+include(FetchContent)
+FetchContent_Declare(
+    cjson
+    # FIXME: change back to DaveGamble/cJSON if upstream fix it
+    # https://github.com/DaveGamble/cJSON/pull/949
+    # https://github.com/DaveGamble/cJSON/pull/955
+    GIT_REPOSITORY https://github.com/CoelacanthusHex/cJSON
+    GIT_TAG 4818f043bda624b5738384eae3a0189b2bd1f5e1
+    GIT_PROGRESS ON
+    SOURCE_DIR cjson
+)
+if (NOT DEFINED USE_SYSTEM_DEPS)
+    find_package(cJSON)
+    if (NOT cJSON_FOUND)
+        if (NOT NO_NETWORK)
+            set(CJSON_OVERRIDE_BUILD_SHARED_LIBS ON)
+            set(CJSON_BUILD_SHARED_LIBS OFF)
+            set(ENABLE_CJSON_TEST OFF)
+            set(ENABLE_CUSTOM_COMPILER_FLAGS OFF)
+            FetchContent_MakeAvailable(cjson)
+            set(CJSON_LIBRARY cjson)
+        else()
+            message(FATAL_ERROR "System cJSON is not found and network access is not permitted!")
+        endif()
+    endif()
+else()
+    if (USE_SYSTEM_DEPS)
+        find_package(cJSON REQUIRED)
+    elseif(NOT NO_NETWORK)
+        set(CJSON_OVERRIDE_BUILD_SHARED_LIBS ON)
+        set(CJSON_BUILD_SHARED_LIBS OFF)
+        set(ENABLE_CJSON_TEST OFF)
+        set(ENABLE_CUSTOM_COMPILER_FLAGS OFF)
+        FetchContent_MakeAvailable(cjson)
+        set(CJSON_LIBRARY cjson)
+    else()
+        message(FATAL_ERROR "System cJSON is not found and network access is not permitted!")
+    endif()
+endif()
+add_subdirectory(cjson-ext)
 add_subdirectory(euicc)
 add_subdirectory(utils)
 add_subdirectory(driver)

REUSE.toml

@@ -34,11 +34,10 @@ SPDX-FileCopyrightText = "2023-2025 ESTKME TECHNOLOGY LIMITED, Hong Kong"
 SPDX-License-Identifier = "MIT"
 
 [[annotations]]
-path = ["cjson/**"]
-SPDX-FileCopyrightText = "2009-2017 Dave Gamble and cJSON contributors"
+path = ["cjson-ext/**"]
+SPDX-FileCopyrightText = "2023-2025 ESTKME TECHNOLOGY LIMITED, Hong Kong"
 SPDX-FileContributor = [
-    "ESTKME TECHNOLOGY LIMITED, Hong Kong",
-    "Celeste Liu"
+    "Celeste Liu",
 ]
 SPDX-License-Identifier = "MIT"
 

cjson-ext/CMakeLists.txt

@@ -0,0 +1,4 @@
+add_library(cjson-ext OBJECT cjson-ext/cJSON_ex.c)
+target_include_directories(cjson-ext PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
+target_link_libraries(cjson-ext PRIVATE ${CJSON_LIBRARY})
+target_compile_options(cjson-ext PRIVATE -Wall -Wextra)

cjson-ext/cjson-ext/cJSON_ex.c

@@ -0,0 +1,9 @@
+#include "cJSON_ex.h"
+
+cJSON *cJSON_AddStringOrNullToObject(cJSON *const object, const char *const name, const char *const string) {
+    if (string) {
+        return cJSON_AddStringToObject(object, name, string);
+    } else {
+        return cJSON_AddNullToObject(object, name);
+    }
+}

cjson-ext/cjson-ext/cJSON_ex.h

@@ -0,0 +1,5 @@
+#pragma once
+
+#include <cjson/cJSON.h>
+
+cJSON *cJSON_AddStringOrNullToObject(cJSON *const object, const char *const name, const char *const string);