2019-03-28 21:22:48 +08:00
.PHONY : pretty clean ChangeLog .md release
2017-08-14 20:41:01 +08:00
2019-03-28 21:22:48 +08:00
##########################################################################
# configuration
##########################################################################
2018-01-29 18:21:11 +08:00
2019-01-13 22:31:22 +08:00
# directory to recent compiler binaries
2020-07-16 15:44:07 +08:00
COMPILER_DIR = /usr/local/opt/llvm/bin
2019-01-13 22:31:22 +08:00
2019-03-28 21:22:48 +08:00
# find GNU sed to use `-i` parameter
SED := $( shell command -v gsed || which sed)
##########################################################################
# source files
##########################################################################
# the list of sources in the include folder
SRCS = $( shell find include -type f | sort)
# the single header (amalgamated from the source files)
AMALGAMATED_FILE = single_include/nlohmann/json.hpp
##########################################################################
# documentation of the Makefile's targets
##########################################################################
2017-08-14 20:41:01 +08:00
# main target
2016-11-27 23:19:26 +08:00
all :
2018-01-29 18:21:11 +08:00
@echo "amalgamate - amalgamate file single_include/nlohmann/json.hpp from the include/nlohmann sources"
2017-10-05 01:27:35 +08:00
@echo "ChangeLog.md - generate ChangeLog file"
2018-01-14 20:08:28 +08:00
@echo "check-amalgamation - check whether sources have been amalgamated"
2017-10-05 01:27:35 +08:00
@echo "clean - remove built files"
2017-10-05 06:17:09 +08:00
@echo "coverage - create coverage information with lcov"
2017-10-05 01:27:35 +08:00
@echo "cppcheck - analyze code with cppcheck"
2019-03-17 07:30:08 +08:00
@echo "cpplint - analyze code with cpplint"
@echo "clang_tidy - analyze code with Clang-Tidy"
@echo "clang_analyze - analyze code with Clang-Analyzer"
2017-10-05 01:27:35 +08:00
@echo "doctest - compile example files and check their output"
@echo "fuzz_testing - prepare fuzz testing of the JSON parser"
2018-10-24 21:43:37 +08:00
@echo "fuzz_testing_bson - prepare fuzz testing of the BSON parser"
2017-10-05 01:27:35 +08:00
@echo "fuzz_testing_cbor - prepare fuzz testing of the CBOR parser"
@echo "fuzz_testing_msgpack - prepare fuzz testing of the MessagePack parser"
2018-01-28 01:38:11 +08:00
@echo "fuzz_testing_ubjson - prepare fuzz testing of the UBJSON parser"
2017-10-05 01:27:35 +08:00
@echo "pedantic_clang - run Clang with maximal warning flags"
@echo "pedantic_gcc - run GCC with maximal warning flags"
@echo "pretty - beautify code with Artistic Style"
2018-02-10 21:46:39 +08:00
@echo "run_benchmarks - build and run benchmarks"
2015-02-14 05:12:27 +08:00
2019-03-28 21:22:48 +08:00
2017-10-05 06:17:09 +08:00
##########################################################################
# coverage
##########################################################################
coverage :
2020-07-23 19:02:53 +08:00
rm -fr cmake-build-coverage
mkdir cmake-build-coverage
cd cmake-build-coverage ; cmake .. -GNinja -DCMAKE_BUILD_TYPE= Debug -DJSON_Coverage= ON -DJSON_MultipleHeaders= ON
cd cmake-build-coverage ; ninja
cd cmake-build-coverage ; ctest -j10
cd cmake-build-coverage ; ninja lcov_html
open cmake-build-coverage/test/html/index.html
2017-10-05 06:17:09 +08:00
2016-02-14 23:42:48 +08:00
##########################################################################
# documentation tests
##########################################################################
# compile example files and check output
doctest :
2016-05-29 20:06:43 +08:00
$( MAKE) check_output -C doc
2017-02-23 01:14:29 +08:00
##########################################################################
# warning detector
##########################################################################
# calling Clang with all warnings, except:
2019-03-29 20:10:11 +08:00
# -Wno-c++2a-compat: u8 literals will behave differently in C++20...
# -Wno-deprecated-declarations: the library deprecated some functions
2017-02-23 01:14:29 +08:00
# -Wno-documentation-unknown-command: code uses user-defined commands like @complexity
2019-03-27 06:58:53 +08:00
# -Wno-exit-time-destructors: warning in json code triggered by NLOHMANN_JSON_SERIALIZE_ENUM
2019-03-29 20:10:11 +08:00
# -Wno-float-equal: not all comparisons in the tests can be replaced by Approx
2017-02-23 01:14:29 +08:00
# -Wno-keyword-macro: unit-tests use "#define private public"
2020-07-06 19:19:06 +08:00
# -Wno-missing-prototypes: for NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE
2019-03-29 20:10:11 +08:00
# -Wno-padded: padding is nothing to warn about
2018-01-23 23:33:08 +08:00
# -Wno-range-loop-analysis: items tests "for(const auto i...)"
2017-10-05 01:27:35 +08:00
# -Wno-switch-enum -Wno-covered-switch-default: pedantic/contradicting warnings about switches
2019-03-29 20:10:11 +08:00
# -Wno-weak-vtables: exception class is defined inline, but has virtual method
2017-03-17 01:35:45 +08:00
pedantic_clang :
2020-07-23 19:02:53 +08:00
rm -fr cmake-build-pedantic
2020-05-16 20:26:17 +08:00
CXXFLAGS = " \
2017-06-21 05:05:37 +08:00
-std= c++11 -Wno-c++98-compat -Wno-c++98-compat-pedantic \
2017-02-23 01:14:29 +08:00
-Werror \
-Weverything \
2019-03-29 20:10:11 +08:00
-Wno-c++2a-compat \
-Wno-deprecated-declarations \
2017-02-23 01:14:29 +08:00
-Wno-documentation-unknown-command \
-Wno-exit-time-destructors \
2019-03-29 20:10:11 +08:00
-Wno-float-equal \
2017-02-23 01:14:29 +08:00
-Wno-keyword-macro \
2020-07-06 19:19:06 +08:00
-Wno-missing-prototypes \
2019-03-29 20:10:11 +08:00
-Wno-padded \
2017-04-03 00:46:21 +08:00
-Wno-range-loop-analysis \
2017-06-21 05:05:37 +08:00
-Wno-switch-enum -Wno-covered-switch-default \
2020-07-23 19:02:53 +08:00
-Wno-weak-vtables" cmake -S . -B cmake-build-pedantic -GNinja -DCMAKE_BUILD_TYPE=Debug -DJSON_MultipleHeaders=ON -DJSON_BuildTests=On
cmake --build cmake-build-pedantic
2017-02-23 01:14:29 +08:00
2017-03-17 01:35:45 +08:00
# calling GCC with most warnings
pedantic_gcc :
2020-07-23 19:02:53 +08:00
rm -fr cmake-build-pedantic
2020-05-16 20:26:17 +08:00
CXXFLAGS = " \
2017-03-17 01:35:45 +08:00
-std= c++11 \
2020-05-28 19:46:56 +08:00
-pedantic \
2019-03-17 07:30:08 +08:00
-Werror \
2020-05-28 19:46:56 +08:00
--all-warnings \
--extra-warnings \
-W \
2020-05-28 18:53:22 +08:00
-Wno-abi-tag \
-Waddress \
-Waddress-of-packed-member \
-Wno-aggregate-return \
-Waggressive-loop-optimizations \
-Waligned-new= all \
-Wall \
-Walloc-zero \
-Walloca \
-Wanalyzer-double-fclose \
-Wanalyzer-double-free \
-Wanalyzer-exposure-through-output-file \
-Wanalyzer-file-leak \
-Wanalyzer-free-of-non-heap \
-Wanalyzer-malloc-leak \
-Wanalyzer-null-argument \
-Wanalyzer-null-dereference \
-Wanalyzer-possible-null-argument \
-Wanalyzer-possible-null-dereference \
-Wanalyzer-stale-setjmp-buffer \
-Wanalyzer-tainted-array-index \
-Wanalyzer-too-complex \
-Wanalyzer-unsafe-call-within-signal-handler \
-Wanalyzer-use-after-free \
-Wanalyzer-use-of-pointer-in-stale-stack-frame \
-Warith-conversion \
-Warray-bounds \
-Warray-bounds= 2 \
-Wattribute-alias= 2 \
-Wattribute-warning \
-Wattributes \
-Wbool-compare \
-Wbool-operation \
-Wbuiltin-declaration-mismatch \
-Wbuiltin-macro-redefined \
2020-05-28 19:46:56 +08:00
-Wc++0x-compat \
2020-05-28 18:53:22 +08:00
-Wc++11-compat \
-Wc++14-compat \
-Wc++17-compat \
2020-05-28 19:46:56 +08:00
-Wc++1z-compat \
2020-05-28 18:53:22 +08:00
-Wc++20-compat \
2020-05-28 19:46:56 +08:00
-Wc++2a-compat \
2020-05-28 18:53:22 +08:00
-Wcannot-profile \
-Wcast-align \
-Wcast-align= strict \
-Wcast-function-type \
-Wcast-qual \
-Wcatch-value= 3 \
-Wchar-subscripts \
-Wclass-conversion \
-Wclass-memaccess \
-Wclobbered \
-Wcomma-subscript \
-Wcomment \
2020-05-28 19:46:56 +08:00
-Wcomments \
2020-05-28 18:53:22 +08:00
-Wconditionally-supported \
-Wconversion \
-Wconversion-null \
-Wcoverage-mismatch \
-Wcpp \
-Wctor-dtor-privacy \
-Wdangling-else \
-Wdate-time \
-Wdelete-incomplete \
-Wdelete-non-virtual-dtor \
-Wdeprecated \
-Wdeprecated-copy \
-Wdeprecated-copy-dtor \
-Wdeprecated-declarations \
-Wdisabled-optimization \
-Wdiv-by-zero \
-Wdouble-promotion \
-Wduplicated-branches \
-Wduplicated-cond \
-Weffc++ \
-Wempty-body \
-Wendif-labels \
-Wenum-compare \
-Wexpansion-to-defined \
-Wextra \
-Wextra-semi \
-Wfloat-conversion \
-Wfloat-equal \
-Wformat -Wformat-contains-nul \
-Wformat -Wformat-extra-args \
-Wformat -Wformat-nonliteral \
-Wformat -Wformat-security \
-Wformat -Wformat-y2k \
-Wformat -Wformat-zero-length \
-Wformat-diag \
-Wformat-overflow= 2 \
-Wformat-signedness \
-Wformat-truncation= 2 \
-Wformat= 2 \
-Wframe-address \
-Wfree-nonheap-object \
-Whsa \
-Wif-not-aligned \
-Wignored-attributes \
-Wignored-qualifiers \
-Wimplicit-fallthrough= 5 \
-Winaccessible-base \
-Winherited-variadic-ctor \
-Winit-list-lifetime \
-Winit-self \
-Winline \
-Wint-in-bool-context \
-Wint-to-pointer-cast \
-Winvalid-memory-model \
-Winvalid-offsetof \
-Winvalid-pch \
-Wliteral-suffix \
-Wlogical-not-parentheses \
-Wlogical-op \
-Wno-long-long \
-Wlto-type-mismatch \
-Wmain \
-Wmaybe-uninitialized \
-Wmemset-elt-size \
-Wmemset-transposed-args \
-Wmisleading-indentation \
-Wmismatched-tags \
-Wmissing-attributes \
-Wmissing-braces \
2020-07-06 18:37:39 +08:00
-Wno-missing-declarations \
2020-05-28 18:53:22 +08:00
-Wmissing-field-initializers \
-Wmissing-include-dirs \
-Wmissing-profile \
-Wmultichar \
-Wmultiple-inheritance \
-Wmultistatement-macros \
-Wno-namespaces \
-Wnarrowing \
-Wno-noexcept \
-Wnoexcept-type \
-Wnon-template-friend \
-Wnon-virtual-dtor \
-Wnonnull \
-Wnonnull-compare \
-Wnonportable-cfstrings \
-Wnormalized= nfkc \
-Wnull-dereference \
-Wodr \
-Wold-style-cast \
-Wopenmp-simd \
-Woverflow \
-Woverlength-strings \
-Woverloaded-virtual \
-Wpacked \
-Wpacked-bitfield-compat \
-Wpacked-not-aligned \
-Wno-padded \
-Wparentheses \
-Wpedantic \
-Wpessimizing-move \
-Wplacement-new= 2 \
-Wpmf-conversions \
-Wpointer-arith \
-Wpointer-compare \
-Wpragmas \
-Wprio-ctor-dtor \
-Wpsabi \
-Wredundant-decls \
-Wredundant-move \
-Wredundant-tags \
-Wregister \
-Wreorder \
-Wrestrict \
-Wreturn-local-addr \
-Wreturn-type \
-Wscalar-storage-order \
-Wsequence-point \
-Wshadow= compatible-local \
2020-05-28 19:46:56 +08:00
-Wshadow= global \
2020-05-28 18:53:22 +08:00
-Wshadow= local \
-Wshift-count-negative \
-Wshift-count-overflow \
-Wshift-negative-value \
-Wshift-overflow= 2 \
-Wsign-compare \
-Wsign-conversion \
-Wsign-promo \
-Wsized-deallocation \
-Wsizeof-array-argument \
-Wsizeof-pointer-div \
-Wsizeof-pointer-memaccess \
-Wstack-protector \
-Wstrict-aliasing \
-Wstrict-aliasing= 3 \
-Wstrict-null-sentinel \
-Wstrict-overflow \
-Wstrict-overflow= 5 \
-Wstring-compare \
-Wstringop-overflow \
-Wstringop-overflow= 4 \
-Wstringop-truncation \
-Wsubobject-linkage \
-Wsuggest-attribute= cold \
-Wsuggest-attribute= const \
-Wsuggest-attribute= format \
-Wsuggest-attribute= malloc \
-Wsuggest-attribute= noreturn \
-Wsuggest-attribute= pure \
-Wsuggest-final-methods \
-Wsuggest-final-types \
-Wsuggest-override \
-Wswitch \
-Wswitch-bool \
-Wswitch-default \
-Wno-switch-enum \
-Wswitch-outside-range \
-Wswitch-unreachable \
-Wsync-nand \
-Wsynth \
-Wno-system-headers \
-Wtautological-compare \
-Wno-templates \
-Wterminate \
-Wtrampolines \
-Wtrigraphs \
-Wtype-limits \
-Wundef \
-Wuninitialized \
-Wunknown-pragmas \
-Wunreachable-code \
-Wunsafe-loop-optimizations \
-Wunused \
-Wunused-but-set-parameter \
-Wunused-but-set-variable \
-Wunused-const-variable= 2 \
-Wunused-function \
-Wunused-label \
2020-06-06 20:30:17 +08:00
-Wno-unused-local-typedefs \
2020-05-28 18:53:22 +08:00
-Wunused-macros \
-Wunused-parameter \
-Wunused-result \
-Wunused-value \
-Wunused-variable \
-Wuseless-cast \
-Wvarargs \
-Wvariadic-macros \
-Wvector-operation-performance \
-Wvirtual-inheritance \
-Wvirtual-move-assign \
-Wvla \
-Wvolatile \
-Wvolatile-register-var \
-Wwrite-strings \
-Wzero-as-null-pointer-constant \
-Wzero-length-bounds \
2020-07-23 19:02:53 +08:00
" cmake -S . -B cmake-build-pedantic -GNinja -DCMAKE_BUILD_TYPE=Debug -DJSON_MultipleHeaders=ON -DJSON_BuildTests=On
cmake --build cmake-build-pedantic
2017-02-23 01:14:29 +08:00
2018-02-10 21:46:39 +08:00
##########################################################################
# benchmarks
##########################################################################
run_benchmarks :
2020-07-23 19:02:53 +08:00
rm -fr cmake-build-benchmarks
mkdir cmake-build-benchmarks
cd cmake-build-benchmarks ; cmake ../benchmarks -GNinja -DCMAKE_BUILD_TYPE= Release -DJSON_BuildTests= On
cd cmake-build-benchmarks ; ninja
cd cmake-build-benchmarks ; ./json_benchmarks
2018-02-10 21:46:39 +08:00
2016-02-12 17:35:08 +08:00
##########################################################################
# fuzzing
##########################################################################
2016-02-15 01:38:29 +08:00
# the overall fuzz testing target
fuzz_testing :
rm -fr fuzz-testing
mkdir -p fuzz-testing fuzz-testing/testcases fuzz-testing/out
2016-12-22 18:09:26 +08:00
$( MAKE) parse_afl_fuzzer -C test CXX = afl-clang++
2016-12-22 19:08:36 +08:00
mv test/parse_afl_fuzzer fuzz-testing/fuzzer
2016-05-11 08:25:54 +08:00
find test/data/json_tests -size -5k -name *json | xargs -I{ } cp "{}" fuzz-testing/testcases
2016-12-22 18:09:26 +08:00
@echo "Execute: afl-fuzz -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer"
2016-02-15 01:38:29 +08:00
2018-10-24 21:43:37 +08:00
fuzz_testing_bson :
rm -fr fuzz-testing
mkdir -p fuzz-testing fuzz-testing/testcases fuzz-testing/out
$( MAKE) parse_bson_fuzzer -C test CXX = afl-clang++
mv test/parse_bson_fuzzer fuzz-testing/fuzzer
find test/data -size -5k -name *.bson | xargs -I{ } cp "{}" fuzz-testing/testcases
@echo "Execute: afl-fuzz -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer"
2016-12-22 19:08:36 +08:00
fuzz_testing_cbor :
rm -fr fuzz-testing
mkdir -p fuzz-testing fuzz-testing/testcases fuzz-testing/out
$( MAKE) parse_cbor_fuzzer -C test CXX = afl-clang++
mv test/parse_cbor_fuzzer fuzz-testing/fuzzer
2016-12-25 23:07:10 +08:00
find test/data -size -5k -name *.cbor | xargs -I{ } cp "{}" fuzz-testing/testcases
2016-12-22 19:08:36 +08:00
@echo "Execute: afl-fuzz -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer"
2016-12-25 23:18:56 +08:00
fuzz_testing_msgpack :
rm -fr fuzz-testing
mkdir -p fuzz-testing fuzz-testing/testcases fuzz-testing/out
$( MAKE) parse_msgpack_fuzzer -C test CXX = afl-clang++
mv test/parse_msgpack_fuzzer fuzz-testing/fuzzer
find test/data -size -5k -name *.msgpack | xargs -I{ } cp "{}" fuzz-testing/testcases
@echo "Execute: afl-fuzz -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer"
2018-01-28 01:38:11 +08:00
fuzz_testing_ubjson :
rm -fr fuzz-testing
mkdir -p fuzz-testing fuzz-testing/testcases fuzz-testing/out
$( MAKE) parse_ubjson_fuzzer -C test CXX = afl-clang++
mv test/parse_ubjson_fuzzer fuzz-testing/fuzzer
find test/data -size -5k -name *.ubjson | xargs -I{ } cp "{}" fuzz-testing/testcases
@echo "Execute: afl-fuzz -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer"
2016-12-25 23:36:43 +08:00
fuzzing-start :
afl-fuzz -S fuzzer1 -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer > /dev/null &
afl-fuzz -S fuzzer2 -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer > /dev/null &
afl-fuzz -S fuzzer3 -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer > /dev/null &
afl-fuzz -S fuzzer4 -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer > /dev/null &
afl-fuzz -S fuzzer5 -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer > /dev/null &
afl-fuzz -S fuzzer6 -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer > /dev/null &
afl-fuzz -S fuzzer7 -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer > /dev/null &
afl-fuzz -M fuzzer0 -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer
fuzzing-stop :
-killall fuzzer
-killall afl-fuzz
2016-02-12 17:35:08 +08:00
2019-03-28 21:22:48 +08:00
2015-06-22 03:24:03 +08:00
##########################################################################
2019-03-28 21:22:48 +08:00
# Static analysis
2015-06-22 03:24:03 +08:00
##########################################################################
2015-02-14 05:12:27 +08:00
2019-03-28 21:22:48 +08:00
# call cppcheck <http://cppcheck.sourceforge.net>
# Note: this target is called by Travis
2015-02-14 05:12:27 +08:00
cppcheck :
2019-07-30 00:49:21 +08:00
cppcheck --enable= warning --inline-suppr --inconclusive --force --std= c++11 $( AMALGAMATED_FILE) --error-exitcode= 1
2015-06-22 03:24:03 +08:00
2019-03-28 21:22:48 +08:00
# call Clang Static Analyzer <https://clang-analyzer.llvm.org>
2018-03-01 02:59:54 +08:00
clang_analyze :
2020-07-23 19:02:53 +08:00
rm -fr cmake-build-clang-analyze
mkdir cmake-build-clang-analyze
cd cmake-build-clang-analyze ; CCC_CXX = $( COMPILER_DIR) /clang++ CXX = $( COMPILER_DIR) /clang++ $( COMPILER_DIR) /scan-build cmake .. -GNinja -DJSON_BuildTests= On
cd cmake-build-clang-analyze ; \
2019-03-28 21:22:48 +08:00
$( COMPILER_DIR) /scan-build \
-enable-checker alpha.core.BoolAssignment,alpha.core.CallAndMessageUnInitRefArg,alpha.core.CastSize,alpha.core.CastToStruct,alpha.core.Conversion,alpha.core.DynamicTypeChecker,alpha.core.FixedAddr,alpha.core.PointerArithm,alpha.core.PointerSub,alpha.core.SizeofPtr,alpha.core.StackAddressAsyncEscape,alpha.core.TestAfterDivZero,alpha.deadcode.UnreachableCode,core.builtin.BuiltinFunctions,core.builtin.NoReturnFunctions,core.CallAndMessage,core.DivideZero,core.DynamicTypePropagation,core.NonnilStringConstants,core.NonNullParamChecker,core.NullDereference,core.StackAddressEscape,core.UndefinedBinaryOperatorResult,core.uninitialized.ArraySubscript,core.uninitialized.Assign,core.uninitialized.Branch,core.uninitialized.CapturedBlockVariable,core.uninitialized.UndefReturn,core.VLASize,cplusplus.InnerPointer,cplusplus.Move,cplusplus.NewDelete,cplusplus.NewDeleteLeaks,cplusplus.SelfAssignment,deadcode.DeadStores,nullability.NullableDereferenced,nullability.NullablePassedToNonnull,nullability.NullableReturnedFromNonnull,nullability.NullPassedToNonnull,nullability.NullReturnedFromNonnull \
--use-c++= $( COMPILER_DIR) /clang++ -analyze-headers -o report ninja
2020-07-23 19:02:53 +08:00
open cmake-build-clang-analyze/report/*/index.html
2019-03-28 21:22:48 +08:00
# call cpplint <https://github.com/cpplint/cpplint>
# Note: some errors expected due to false positives
2019-03-17 07:30:08 +08:00
cpplint :
2019-03-28 21:22:48 +08:00
third_party/cpplint/cpplint.py \
--filter= -whitespace,-legal,-readability/alt_tokens,-runtime/references,-runtime/explicit \
--quiet --recursive $( SRCS)
2019-03-17 07:30:08 +08:00
2019-03-28 21:22:48 +08:00
# call Clang-Tidy <https://clang.llvm.org/extra/clang-tidy/>
2019-03-17 07:30:08 +08:00
clang_tidy :
2020-07-16 15:44:07 +08:00
$( COMPILER_DIR) /clang-tidy $( SRCS) -- -Iinclude -std= c++11
2019-03-17 07:30:08 +08:00
2019-03-28 21:22:48 +08:00
# call PVS-Studio Analyzer <https://www.viva64.com/en/pvs-studio/>
2019-03-17 07:30:08 +08:00
pvs_studio :
2020-07-23 19:02:53 +08:00
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
2019-03-17 07:30:08 +08:00
2019-03-28 21:22:48 +08:00
# call Infer <https://fbinfer.com> static analyzer
2019-03-18 07:19:28 +08:00
infer :
2020-07-23 19:02:53 +08:00
rm -fr cmake-build-infer
mkdir cmake-build-infer
cd cmake-build-infer ; infer compile -- cmake .. -DJSON_MultipleHeaders= ON ; infer run -- make -j 4
2019-03-18 07:19:28 +08:00
2019-03-28 21:22:48 +08:00
# call OCLint <http://oclint.org> static analyzer
2019-03-18 07:19:28 +08:00
oclint :
oclint $( SRCS) -report-type html -enable-global-analysis -o oclint_report.html -max-priority-1= 10000 -max-priority-2= 10000 -max-priority-3= 10000 -- -std= c++11 -Iinclude
open oclint_report.html
2019-03-28 21:22:48 +08:00
# execute the test suite with Clang sanitizers (address and undefined behavior)
clang_sanitize :
2020-07-23 19:02:53 +08:00
rm -fr cmake-build-clang-sanitize
mkdir cmake-build-clang-sanitize
cd cmake-build-clang-sanitize ; CXX = $( COMPILER_DIR) /clang++ cmake .. -DJSON_Sanitizer= On -DJSON_MultipleHeaders= ON -DJSON_BuildTests= On -GNinja
cd cmake-build-clang-sanitize ; ninja
cd cmake-build-clang-sanitize ; ctest -j10
2019-03-28 21:22:48 +08:00
2015-06-22 03:24:03 +08:00
##########################################################################
2019-03-28 21:22:48 +08:00
# Code format and source amalgamation
2015-06-22 03:24:03 +08:00
##########################################################################
2019-03-28 21:22:48 +08:00
# call the Artistic Style pretty printer on all source files
2015-02-14 05:12:27 +08:00
pretty :
2019-03-28 21:22:48 +08:00
astyle \
--style= allman \
--indent= spaces = 4 \
--indent-modifiers \
--indent-switches \
--indent-preproc-block \
--indent-preproc-define \
--indent-col1-comments \
--pad-oper \
--pad-header \
--align-pointer= type \
--align-reference= type \
--add-brackets \
--convert-tabs \
--close-templates \
--lineend= linux \
--preserve-date \
--suffix= none \
--formatted \
2020-07-26 20:07:34 +08:00
$( SRCS) $( AMALGAMATED_FILE) test/src/*.cpp test/src/*.hpp benchmarks/src/benchmarks.cpp doc/examples/*.cpp
2016-01-27 05:59:57 +08:00
2018-01-10 06:15:06 +08:00
# create single header file
2018-01-29 18:21:11 +08:00
amalgamate : $( AMALGAMATED_FILE )
2018-01-10 06:15:06 +08:00
2019-03-28 21:22:48 +08:00
# call the amalgamation tool and pretty print
2018-01-29 18:21:11 +08:00
$(AMALGAMATED_FILE) : $( SRCS )
third_party/amalgamate/amalgamate.py -c third_party/amalgamate/config.json -s . --verbose= yes
2018-01-10 06:15:06 +08:00
$( MAKE) pretty
2019-03-28 21:22:48 +08:00
# check if file single_include/nlohmann/json.hpp has been amalgamated from the nlohmann sources
# Note: this target is called by Travis
2018-01-14 20:08:28 +08:00
check-amalgamation :
2018-01-29 18:21:11 +08:00
@mv $( AMALGAMATED_FILE) $( AMALGAMATED_FILE) ~
2018-01-14 17:10:23 +08:00
@$( MAKE) amalgamate
2018-01-29 18:21:11 +08:00
@diff $( AMALGAMATED_FILE) $( AMALGAMATED_FILE) ~ || ( echo "===================================================================\n Amalgamation required! Please read the contribution guidelines\n in file .github/CONTRIBUTING.md.\n===================================================================" ; mv $( AMALGAMATED_FILE) ~ $( AMALGAMATED_FILE) ; false )
@mv $( AMALGAMATED_FILE) ~ $( AMALGAMATED_FILE)
2018-01-14 17:10:23 +08:00
2019-03-28 21:22:48 +08:00
# check if every header in nlohmann includes sufficient headers to be compiled individually
2018-01-28 22:36:56 +08:00
check-single-includes :
2019-01-13 22:31:22 +08:00
@for x in $( SRCS) ; do \
echo " Checking self-sufficiency of $$ x... " ; \
2020-07-13 20:44:40 +08:00
echo " #include < $$ x>\nint main() {}\n " | $( SED) 's|include/||' > single_include_test.cpp; \
2018-01-29 18:21:11 +08:00
$( CXX) $( CXXFLAGS) -Iinclude -std= c++11 single_include_test.cpp -o single_include_test; \
2019-01-13 22:31:22 +08:00
rm -f single_include_test.cpp single_include_test; \
2018-01-28 22:36:56 +08:00
done
2017-08-15 02:45:33 +08:00
2019-03-28 21:22:48 +08:00
2016-01-27 05:59:57 +08:00
##########################################################################
2019-03-28 21:22:48 +08:00
# CMake
2016-01-27 05:59:57 +08:00
##########################################################################
2020-07-13 20:44:40 +08:00
# grep "^option" CMakeLists.txt test/CMakeLists.txt | $(SED) 's/(/ /' | awk '{print $2}' | xargs
2019-03-28 21:22:48 +08:00
# check if all flags of our CMake files work
check_cmake_flags_do :
$( CMAKE_BINARY) --version
2020-07-16 18:14:06 +08:00
for flag in JSON_BuildTests JSON_Install JSON_MultipleHeaders JSON_Sanitizer JSON_Valgrind JSON_NoExceptions JSON_Coverage; do \
2019-03-28 21:22:48 +08:00
rm -fr cmake_build; \
mkdir cmake_build; \
2020-07-16 18:14:06 +08:00
echo " \n\n $( CMAKE_BINARY) .. -D $$ flag=On\n " ; \
2019-03-28 21:22:48 +08:00
cd cmake_build ; \
2020-07-16 18:14:06 +08:00
$( CMAKE_BINARY) -Werror= dev .. -D$$ flag = On -DCMAKE_CXX_COMPILE_FEATURES= "cxx_std_11;cxx_range_for" -DCMAKE_CXX_FLAGS= "-std=gnu++11" ; \
2019-03-28 21:22:48 +08:00
test -f Makefile || exit 1 ; \
cd .. ; \
done ;
# call target `check_cmake_flags_do` twice: once for minimal required CMake version 3.1.0 and once for the installed version
check_cmake_flags :
wget https://github.com/Kitware/CMake/releases/download/v3.1.0/cmake-3.1.0-Darwin64.tar.gz
tar xfz cmake-3.1.0-Darwin64.tar.gz
CMAKE_BINARY = $( abspath cmake-3.1.0-Darwin64/CMake.app/Contents/bin/cmake) $( MAKE) check_cmake_flags_do
CMAKE_BINARY = $( shell which cmake) $( MAKE) check_cmake_flags_do
##########################################################################
# ChangeLog
##########################################################################
# Create a ChangeLog based on the git log using the GitHub Changelog Generator
# (<https://github.com/github-changelog-generator/github-changelog-generator>).
# variable to control the diffs between the last released version and the current repository state
2016-07-31 19:37:04 +08:00
NEXT_VERSION ?= "unreleased"
2016-01-27 05:59:57 +08:00
ChangeLog.md :
2020-05-13 01:36:33 +08:00
github_changelog_generator -o ChangeLog.md --user nlohmann --project json --simple-list --release-url https://github.com/nlohmann/json/releases/tag/%s --future-release $( NEXT_VERSION)
2019-03-28 21:22:48 +08:00
$( SED) -i 's|https://github.com/nlohmann/json/releases/tag/HEAD|https://github.com/nlohmann/json/tree/HEAD|' ChangeLog.md
$( SED) -i '2i All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).' ChangeLog.md
2018-02-04 20:29:23 +08:00
##########################################################################
2019-03-28 21:22:48 +08:00
# Release files
2018-02-04 20:29:23 +08:00
##########################################################################
2019-07-28 23:55:01 +08:00
# Create the files for a release and add signatures and hashes. We use `-X` to make the resulting ZIP file
2019-03-28 21:22:48 +08:00
# reproducible, see <https://content.pivotal.io/blog/barriers-to-deterministic-reproducible-zip-files>.
2018-02-04 20:29:23 +08:00
release :
2019-03-28 21:22:48 +08:00
rm -fr release_files
2018-02-11 23:50:01 +08:00
mkdir release_files
2019-08-01 03:43:31 +08:00
zip -9 --recurse-paths -X include.zip $( SRCS) $( AMALGAMATED_FILE) meson.build
2018-02-04 20:29:23 +08:00
gpg --armor --detach-sig include.zip
2018-02-11 23:50:01 +08:00
mv include.zip include.zip.asc release_files
2019-03-28 21:22:48 +08:00
gpg --armor --detach-sig $( AMALGAMATED_FILE)
cp $( AMALGAMATED_FILE) release_files
mv $( AMALGAMATED_FILE) .asc release_files
2018-02-11 23:50:01 +08:00
cd release_files ; shasum -a 256 json.hpp > hashes.txt
cd release_files ; shasum -a 256 include.zip >> hashes.txt
2019-03-28 21:22:48 +08:00
##########################################################################
# Maintenance
##########################################################################
# clean up
clean :
rm -fr json_unit json_benchmarks fuzz fuzz-testing *.dSYM test/*.dSYM oclint_report.html
rm -fr benchmarks/files/numbers/*.json
rm -fr cmake-3.1.0-Darwin64.tar.gz cmake-3.1.0-Darwin64
2020-07-23 19:02:53 +08:00
rm -fr cmake-build-coverage cmake-build-benchmarks fuzz-testing cmake-build-clang-analyze cmake-build-pvs-studio cmake-build-infer cmake-build-clang-sanitize cmake_build
2019-03-28 21:22:48 +08:00
$( MAKE) clean -Cdoc
2019-07-02 04:24:39 +08:00
2019-07-02 04:37:30 +08:00
##########################################################################
# Thirdparty code
##########################################################################
2019-07-02 04:24:39 +08:00
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
2020-07-13 20:44:40 +08:00
$( SED) -i 's/HEDLEY_/JSON_HEDLEY_/g' include/nlohmann/thirdparty/hedley/hedley.hpp
grep "[[:blank:]]*#[[:blank:]]*undef" include/nlohmann/thirdparty/hedley/hedley.hpp | grep -v "__" | sort | uniq | $( SED) 's/ //g' | $( SED) 's/undef/undef /g' > include/nlohmann/thirdparty/hedley/hedley_undef.hpp
2019-07-02 04:24:39 +08:00
$( MAKE) amalgamate
