mirror of
https://github.com/nlohmann/json.git
synced 2026-11-17 09:01:28 +00:00
Documentation: - basic_json_view::contains: basic_json::contains(json_pointer) never throws either; drop the claim that it does. - std::format support is dated 3.13.0 in the serialization feature page; std::optional is supported since 3.12.0 and std::filesystem::path since 3.10.5 in type_recipes.md. - basic_json_view::source_offset: also -1 for values written by an edit and arrays/objects whose elements an edit added or removed. - basic_json_view::items: const auto& works (binds to the temporary); by value is recommended, non-const auto& does not compile. - basic_json_view::operator==/!=: document the overload that compares a read-only with an editable view. - basic_json_document::erase: out_of_range.404 also for a last token "-". - json_editable_document/json_editable_view: mention insert and erase. - basic_json::swap/std::swap: describe the conditional noexcept (only a throwing move of json_base_class_t can make it throw) and that the std::swap specialization is not provided with C++20 (ADL swap is). - exceptions.md: out_of_range.405 also from front/pop_front and from basic_json_document::erase with an empty pointer; other_error.502 also for non-empty binary values in UBJSON/BJData Draft 2, as the writer does. - Macro pages: fix highlighted lines. Tests: - unit-unicode.cpp: enable the "incorrect sequences" sections that were disabled with #if 0 since 2017 without a reason. They pass; the reason was the runtime of the quadratic high/low surrogate sweep (1024 * 64512 parses, not finished after 3 CPU minutes). That sweep is thinned to all high surrogates against boundary code units, plus one high surrogate against every code unit with accept(). The sections are merged into the existing "incorrect sequences" section of the same name. Repository: - labeler.yml: match the moved json_view feature docs folder. - check_amalgamation.yml: take config_json_view.json from develop's tools. - FILES.md: list json_view_benchmarks.yml. - cmake/ci.cmake: remove the unused targets ci_test_amalgamation (a duplicate of make check-amalgamation), ci_benchmarks and ci_clean, and the .gitignore entry of the first. - make clean and .gitignore cover all tests/*_fuzzer binaries. - hedley_undef.hpp: regenerate with make update_hedley_undef (one line moves into sorted order); regenerate the amalgamation. Signed-off-by: Niels Lohmann <mail@nlohmann.me>
267 lines
14 KiB
Makefile
267 lines
14 KiB
Makefile
.PHONY: all amalgamate check-amalgamation check_build_options pretty install_astyle clean release update_hedley update_hedley_undef BUILD.bazel natvis macro_builder_check run_benchmarks pvs_studio serve_header reuse spdx
|
|
|
|
##########################################################################
|
|
# configuration
|
|
##########################################################################
|
|
|
|
# find GNU sed to use `-i` parameter
|
|
SED:=$(shell command -v gsed || which sed)
|
|
|
|
# find GNU tar to use `--sort` and `--pax-option` parameters
|
|
TAR:=$(shell command -v gtar || which tar)
|
|
|
|
|
|
##########################################################################
|
|
# source files
|
|
##########################################################################
|
|
|
|
# the list of sources in the include folder
|
|
SRCS=$(shell find include -type f | sort)
|
|
|
|
# the list of sources in the tests folder
|
|
TESTS_SRCS=$(shell find tests -type f \( -name '*.hpp' -o -name '*.cpp' -o -name '*.cu' \) -not -path 'tests/thirdparty/*' -not -path 'tests/abi/include/nlohmann/*' | sort)
|
|
|
|
# the single headers (amalgamated from the source files)
|
|
AMALGAMATED_FILE=single_include/nlohmann/json.hpp
|
|
AMALGAMATED_FWD_FILE=single_include/nlohmann/json_fwd.hpp
|
|
# json_literals.hpp only includes <nlohmann/json.hpp>, so it is copied verbatim
|
|
AMALGAMATED_LITERALS_FILE=single_include/nlohmann/json_literals.hpp
|
|
AMALGAMATED_VIEW_FILE=single_include/nlohmann/json_view.hpp
|
|
|
|
# the header with the argument-counting macros generated by tools/macro_builder
|
|
MACRO_SCOPE_HPP=include/nlohmann/detail/macro_scope.hpp
|
|
|
|
|
|
##########################################################################
|
|
# documentation of the Makefile's targets
|
|
##########################################################################
|
|
|
|
# main target
|
|
all:
|
|
@echo "amalgamate - amalgamate files single_include/nlohmann/json{,_fwd,_literals,_view}.hpp from the include/nlohmann sources"
|
|
@echo "BUILD.bazel - regenerate the Bazel BUILD file from the include/nlohmann sources"
|
|
@echo "check-amalgamation - check whether sources have been amalgamated and BUILD.bazel is up to date"
|
|
@echo "check_build_options - check that the Meson build and the pkg-config files offer the options of the CMake target"
|
|
@echo "clean - remove built files"
|
|
@echo "(fuzzers) - see tests/fuzzing.md, or run 'make -C tests fuzzers' to build the AFL fuzzers"
|
|
@echo "macro_builder_check - check that macro_scope.hpp matches tools/macro_builder's output"
|
|
@echo "natvis - regenerate nlohmann_json.natvis from the current ABI tags and version (pass generator options via NATVIS_ARGS, see tools/generate_natvis/README.md)"
|
|
@echo "pretty - beautify code with Artistic Style"
|
|
@echo "pvs_studio - run the PVS-Studio static analyzer and open the report"
|
|
@echo "release - create the release files (include.zip, json.tar.xz, single headers, signatures, hashes)"
|
|
@echo "reuse - annotate the source files with REUSE license headers and lint them"
|
|
@echo "run_benchmarks - build and run benchmarks"
|
|
@echo "serve_header - serve the single header, re-amalgamated on demand (see tools/serve_header)"
|
|
@echo "spdx - generate the SPDX software bill of materials nlohmann_json.spdx"
|
|
@echo "update_hedley - download Hedley and regenerate hedley.hpp / hedley_undef.hpp"
|
|
@echo "update_hedley_undef - rebuild hedley_undef.hpp from the JSON_HEDLEY_* #define names in hedley.hpp"
|
|
|
|
|
|
##########################################################################
|
|
# benchmarks
|
|
##########################################################################
|
|
|
|
run_benchmarks:
|
|
rm -fr cmake-build-benchmarks
|
|
mkdir cmake-build-benchmarks
|
|
cd cmake-build-benchmarks ; cmake ../tests/benchmarks -GNinja -DCMAKE_BUILD_TYPE=Release
|
|
cd cmake-build-benchmarks ; ninja
|
|
cd cmake-build-benchmarks ; ./json_benchmarks
|
|
|
|
|
|
##########################################################################
|
|
# Static analysis
|
|
##########################################################################
|
|
|
|
# call PVS-Studio Analyzer <https://www.viva64.com/en/pvs-studio/>
|
|
pvs_studio:
|
|
rm -fr cmake-build-pvs-studio
|
|
mkdir cmake-build-pvs-studio
|
|
cd cmake-build-pvs-studio ; cmake .. -DCMAKE_EXPORT_COMPILE_COMMANDS=On -DJSON_MultipleHeaders=ON
|
|
cd cmake-build-pvs-studio ; pvs-studio-analyzer analyze -j 10
|
|
cd cmake-build-pvs-studio ; plog-converter -a'GA:1,2;64:1;CS' -t fullhtml PVS-Studio.log -o pvs
|
|
open cmake-build-pvs-studio/pvs/index.html
|
|
|
|
|
|
##########################################################################
|
|
# Code format and source amalgamation
|
|
##########################################################################
|
|
|
|
ASTYLE=tools/astyle/venv/bin/astyle
|
|
|
|
install_astyle:
|
|
@test -d tools/astyle/venv || python3 -mvenv tools/astyle/venv ; tools/astyle/venv/bin/pip3 install --quiet --upgrade pip
|
|
@test -f $(ASTYLE) || tools/astyle/venv/bin/pip3 install --quiet -r tools/astyle/requirements.txt
|
|
@$(ASTYLE) --version
|
|
|
|
# call the Artistic Style pretty printer on all source files
|
|
pretty: install_astyle
|
|
$(ASTYLE) --project=tools/astyle/.astylerc $(SRCS) $(TESTS_SRCS) $(AMALGAMATED_FILE) $(AMALGAMATED_FWD_FILE) $(AMALGAMATED_LITERALS_FILE) $(AMALGAMATED_VIEW_FILE) docs/mkdocs/docs/examples/*.cpp docs/mkdocs/docs/examples/*.hpp
|
|
|
|
# create single header files and pretty print
|
|
amalgamate: $(AMALGAMATED_FILE) $(AMALGAMATED_FWD_FILE) $(AMALGAMATED_LITERALS_FILE) $(AMALGAMATED_VIEW_FILE)
|
|
$(MAKE) pretty
|
|
|
|
# call the amalgamation tool for json.hpp
|
|
$(AMALGAMATED_FILE): $(SRCS)
|
|
tools/amalgamate/amalgamate.py -c tools/amalgamate/config_json.json -s . --verbose=yes
|
|
|
|
# call the amalgamation tool for json_fwd.hpp
|
|
$(AMALGAMATED_FWD_FILE): $(SRCS)
|
|
tools/amalgamate/amalgamate.py -c tools/amalgamate/config_json_fwd.json -s . --verbose=yes
|
|
|
|
# copy json_literals.hpp
|
|
$(AMALGAMATED_LITERALS_FILE): include/nlohmann/json_literals.hpp
|
|
cp include/nlohmann/json_literals.hpp $(AMALGAMATED_LITERALS_FILE)
|
|
|
|
# call the amalgamation tool for json_view.hpp (keeps including json.hpp)
|
|
$(AMALGAMATED_VIEW_FILE): $(SRCS)
|
|
tools/amalgamate/amalgamate.py -c tools/amalgamate/config_json_view.json -s . --verbose=yes
|
|
|
|
NATVIS_VENV=tools/generate_natvis/venv
|
|
# extra options for generate_natvis.py, e.g. NATVIS_ARGS="--abi-tags _diag,_dp,_ns --output my.natvis"
|
|
NATVIS_ARGS=
|
|
|
|
# regenerate nlohmann_json.natvis from the ABI tags and version in include/nlohmann/detail/abi_macros.hpp
|
|
# (the dependencies are installed into a virtual environment first)
|
|
natvis:
|
|
@test -d $(NATVIS_VENV) || python3 -mvenv $(NATVIS_VENV)
|
|
@$(NATVIS_VENV)/bin/python3 -c 'import jinja2' 2>/dev/null || $(NATVIS_VENV)/bin/pip3 install --quiet -r tools/generate_natvis/requirements.txt
|
|
$(NATVIS_VENV)/bin/python3 tools/generate_natvis/generate_natvis.py $(NATVIS_ARGS) .
|
|
|
|
# regenerate the two tools/macro_builder blocks of $(MACRO_SCOPE_HPP) (see its README.md) and diff against the
|
|
# checked-in header; phony, because it never writes $(MACRO_SCOPE_HPP) itself
|
|
macro_builder_check: install_astyle
|
|
@set -e; \
|
|
TMPDIR=$$(mktemp -d ./macro_builder_check.XXXXXX); \
|
|
trap 'rm -rf "$$TMPDIR"' EXIT; \
|
|
$(CXX) -std=c++11 tools/macro_builder/main.cpp -o "$$TMPDIR/macro_builder"; \
|
|
"$$TMPDIR/macro_builder" > "$$TMPDIR/paste.hpp"; \
|
|
"$$TMPDIR/macro_builder" type_body > "$$TMPDIR/type_body.hpp"; \
|
|
$(ASTYLE) --project=tools/astyle/.astylerc --suffix=none --quiet "$$TMPDIR/paste.hpp" "$$TMPDIR/type_body.hpp"; \
|
|
sed -n '/^#define NLOHMANN_JSON_EXPAND( x ) x$$/,/^#define NLOHMANN_JSON_DOUBLE_PASTE63(/p' $(MACRO_SCOPE_HPP) > "$$TMPDIR/paste_actual.hpp"; \
|
|
sed -n '/^#define NLOHMANN_JSON_TYPE_BODY(Prefix, \.\.\.)/,/^ NLOHMANN_JSON_TYPE_BODY_SENTINEL))$$/p' $(MACRO_SCOPE_HPP) > "$$TMPDIR/type_body_actual.hpp"; \
|
|
diff "$$TMPDIR/paste.hpp" "$$TMPDIR/paste_actual.hpp" || (echo "===================================================================\n $(MACRO_SCOPE_HPP) (NLOHMANN_JSON_EXPAND..NLOHMANN_JSON_DOUBLE_PASTE63) is out of date!\n Regenerate it, see tools/macro_builder/README.md.\n===================================================================" ; exit 1); \
|
|
diff "$$TMPDIR/type_body.hpp" "$$TMPDIR/type_body_actual.hpp" || (echo "===================================================================\n $(MACRO_SCOPE_HPP) (NLOHMANN_JSON_TYPE_BODY) is out of date!\n Regenerate it, see tools/macro_builder/README.md.\n===================================================================" ; exit 1)
|
|
|
|
# check that the Meson build and the pkg-config files offer the options of the CMake target
|
|
check_build_options:
|
|
python3 tools/check_build_options/check_build_options.py .
|
|
|
|
# check if the single headers have been amalgamated from the nlohmann sources and if BUILD.bazel and
|
|
# nlohmann_json.natvis are up to date; all checks are run, and the checked-in files are always restored
|
|
check-amalgamation:
|
|
@status=0; \
|
|
banner() { printf '===================================================================\n %s\n===================================================================\n' "$$1"; }; \
|
|
for FILE in $(AMALGAMATED_FILE) $(AMALGAMATED_FWD_FILE) $(AMALGAMATED_LITERALS_FILE) $(AMALGAMATED_VIEW_FILE) BUILD.bazel nlohmann_json.natvis; do \
|
|
mv "$$FILE" "$$FILE~" || exit 1; \
|
|
done; \
|
|
$(MAKE) amalgamate || status=1; \
|
|
$(MAKE) BUILD.bazel || status=1; \
|
|
$(MAKE) natvis || status=1; \
|
|
for FILE in $(AMALGAMATED_FILE) $(AMALGAMATED_FWD_FILE) $(AMALGAMATED_LITERALS_FILE) $(AMALGAMATED_VIEW_FILE); do \
|
|
diff "$$FILE" "$$FILE~" || { banner "$$FILE is out of date! Amalgamation required! Please read the contribution guidelines in file .github/CONTRIBUTING.md."; status=1; }; \
|
|
done; \
|
|
diff BUILD.bazel BUILD.bazel~ || { banner "BUILD.bazel is out of date! Please run 'make BUILD.bazel'."; status=1; }; \
|
|
diff nlohmann_json.natvis nlohmann_json.natvis~ || { banner "nlohmann_json.natvis is out of date! Please run 'make natvis'."; status=1; }; \
|
|
for FILE in $(AMALGAMATED_FILE) $(AMALGAMATED_FWD_FILE) $(AMALGAMATED_LITERALS_FILE) $(AMALGAMATED_VIEW_FILE) BUILD.bazel nlohmann_json.natvis; do \
|
|
mv "$$FILE~" "$$FILE"; \
|
|
done; \
|
|
$(MAKE) macro_builder_check || status=1; \
|
|
exit $$status
|
|
|
|
# generate the Bazel BUILD file; phony, because a removed header would not trigger a rebuild
|
|
BUILD.bazel:
|
|
cmake -P cmake/scripts/gen_bazel_build_file.cmake
|
|
|
|
##########################################################################
|
|
# Release files
|
|
##########################################################################
|
|
|
|
# Create a tar.xz archive that contains sufficient files to be used as CMake project (e.g., using FetchContent). The
|
|
# archive is created according to the advices of <https://reproducible-builds.org/docs/archives/>.
|
|
json.tar.xz:
|
|
mkdir json
|
|
rsync -R $(shell find LICENSE.MIT nlohmann_json.natvis CMakeLists.txt cmake/*.in include single_include src/modules -type f) json
|
|
$(TAR) --sort=name --mtime="@$(shell git log -1 --pretty=%ct)" --owner=0 --group=0 --numeric-owner --pax-option=exthdr.name=%d/PaxHeaders/%f,delete=atime,delete=ctime --create --file - json | xz --compress -9e --threads=2 - > json.tar.xz
|
|
rm -fr json
|
|
|
|
# We use `-X` to make the resulting ZIP file reproducible, see
|
|
# <https://content.pivotal.io/blog/barriers-to-deterministic-reproducible-zip-files>.
|
|
include.zip: BUILD.bazel
|
|
zip -9 --recurse-paths -X include.zip $(SRCS) $(AMALGAMATED_FILE) $(AMALGAMATED_FWD_FILE) $(AMALGAMATED_LITERALS_FILE) $(AMALGAMATED_VIEW_FILE) BUILD.bazel MODULE.bazel meson.build meson_options.txt LICENSE.MIT
|
|
|
|
# Create the files for a release and add signatures and hashes.
|
|
release: include.zip json.tar.xz
|
|
rm -fr release_files
|
|
mkdir release_files
|
|
gpg --armor --detach-sig include.zip
|
|
gpg --armor --detach-sig $(AMALGAMATED_FILE)
|
|
gpg --armor --detach-sig $(AMALGAMATED_FWD_FILE)
|
|
gpg --armor --detach-sig $(AMALGAMATED_LITERALS_FILE)
|
|
gpg --armor --detach-sig $(AMALGAMATED_VIEW_FILE)
|
|
gpg --armor --detach-sig json.tar.xz
|
|
cp $(AMALGAMATED_FILE) release_files
|
|
cp $(AMALGAMATED_FWD_FILE) release_files
|
|
cp $(AMALGAMATED_LITERALS_FILE) release_files
|
|
cp $(AMALGAMATED_VIEW_FILE) release_files
|
|
mv $(AMALGAMATED_FILE).asc $(AMALGAMATED_FWD_FILE).asc $(AMALGAMATED_LITERALS_FILE).asc $(AMALGAMATED_VIEW_FILE).asc json.tar.xz json.tar.xz.asc include.zip include.zip.asc release_files
|
|
cd release_files ; shasum -a 256 $$(find . -type f -not -name '*.asc' | sed 's|^\./||' | sort) > hashes.txt
|
|
|
|
|
|
##########################################################################
|
|
# Maintenance
|
|
##########################################################################
|
|
|
|
# clean up
|
|
clean:
|
|
rm -fr *.dSYM tests/*.dSYM tests/*_fuzzer
|
|
rm -fr cmake-build-benchmarks cmake-build-pvs-studio release_files
|
|
$(MAKE) clean -Cdocs
|
|
|
|
|
|
##########################################################################
|
|
# Thirdparty code
|
|
##########################################################################
|
|
|
|
update_hedley:
|
|
rm -f include/nlohmann/thirdparty/hedley/hedley.hpp include/nlohmann/thirdparty/hedley/hedley_undef.hpp
|
|
curl https://raw.githubusercontent.com/nemequ/hedley/master/hedley.h -o include/nlohmann/thirdparty/hedley/hedley.hpp
|
|
$(SED) -i 's/HEDLEY_/JSON_HEDLEY_/g' include/nlohmann/thirdparty/hedley/hedley.hpp
|
|
$(SED) -i '1s/^/#pragma once\n\n/' include/nlohmann/thirdparty/hedley/hedley.hpp
|
|
$(MAKE) update_hedley_undef
|
|
$(MAKE) amalgamate
|
|
|
|
# Rebuild hedley_undef.hpp from every JSON_HEDLEY_* name that hedley.hpp
|
|
# #defines. Hedley does not #undef all of its public macros internally (see
|
|
# #5408), so grepping those #undef lines misses names such as
|
|
# JSON_HEDLEY_PRAGMA. cmake/scripts/gen_hedley_undef_check.cmake is the
|
|
# single source of truth for this extraction (tests/CMakeLists.txt uses the
|
|
# same script, in MODE=checks, to generate the matching leak-check test), so
|
|
# the vendored header, the generated #undef list, and the regression test
|
|
# cannot drift apart.
|
|
update_hedley_undef:
|
|
cmake -DHEDLEY_HPP=include/nlohmann/thirdparty/hedley/hedley.hpp \
|
|
-DOUTPUT=include/nlohmann/thirdparty/hedley/hedley_undef.hpp \
|
|
-DMODE=undef \
|
|
-P cmake/scripts/gen_hedley_undef_check.cmake
|
|
|
|
##########################################################################
|
|
# serve_header.py
|
|
##########################################################################
|
|
|
|
serve_header:
|
|
./tools/serve_header/serve_header.py --make $(MAKE)
|
|
|
|
##########################################################################
|
|
# REUSE
|
|
##########################################################################
|
|
|
|
reuse:
|
|
pipx run reuse annotate --recursive single_include include -tjson --license MIT --copyright "Niels Lohmann <https://nlohmann.me>" --year "2013-2026" --merge-copyrights
|
|
pipx run reuse annotate $(TESTS_SRCS) -tjson_support --license MIT --copyright "Niels Lohmann <https://nlohmann.me>" --year "2013-2026" --merge-copyrights
|
|
pipx run reuse lint
|
|
|
|
spdx:
|
|
pipx run reuse spdx --output nlohmann_json.spdx --creator-person "Niels Lohmann" --add-license-concluded
|