2016-01-26 22:59:57 +01:00
.PHONY : pretty clean ChangeLog .md
2015-08-21 19:05:47 +02:00
2017-08-14 20:45:33 +02:00
SRCDIR = ./src
SRCS = $( SRCDIR) /json.hpp \
$( SRCDIR) /json_fwd.hpp \
$( SRCDIR) /detail/macro_scope.hpp \
$( SRCDIR) /detail/macro_unscope.hpp \
$( SRCDIR) /detail/meta.hpp \
$( SRCDIR) /detail/exceptions.hpp \
$( SRCDIR) /detail/value_t.hpp \
$( SRCDIR) /detail/conversions/from_json.hpp \
$( SRCDIR) /detail/conversions/to_json.hpp \
$( SRCDIR) /detail/parsing/input_adapters.hpp \
$( SRCDIR) /detail/parsing/lexer.hpp \
$( SRCDIR) /detail/parsing/parser.hpp \
$( SRCDIR) /detail/iterators/primitive_iterator.hpp \
$( SRCDIR) /detail/iterators/internal_iterator.hpp \
$( SRCDIR) /detail/iterators/iter_impl.hpp \
$( SRCDIR) /detail/iterators/iteration_proxy.hpp \
$( SRCDIR) /detail/iterators/json_reverse_iterator.hpp \
$( SRCDIR) /detail/parsing/output_adapters.hpp \
$( SRCDIR) /detail/parsing/binary_reader.hpp \
$( SRCDIR) /detail/parsing/binary_writer.hpp \
$( SRCDIR) /detail/serializer.hpp \
$( SRCDIR) /detail/json_ref.hpp \
$( SRCDIR) /adl_serializer.hpp
UNAME = $( shell uname)
CXX = clang++
2017-08-14 14:41:01 +02:00
# main target
2016-11-27 16:19:26 +01:00
all :
2017-10-04 19:27:35 +02:00
@echo "ChangeLog.md - generate ChangeLog file"
@echo "check - compile and execute test suite"
@echo "check-fast - compile and execute test suite (skip long-running tests)"
@echo "clean - remove built files"
2017-10-05 00:17:09 +02:00
@echo "coverage - create coverage information with lcov"
2017-10-04 19:27:35 +02:00
@echo "cppcheck - analyze code with cppcheck"
@echo "doctest - compile example files and check their output"
@echo "fuzz_testing - prepare fuzz testing of the JSON parser"
@echo "fuzz_testing_cbor - prepare fuzz testing of the CBOR parser"
@echo "fuzz_testing_msgpack - prepare fuzz testing of the MessagePack parser"
@echo "json_unit - create single-file test executable"
@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"
2015-02-13 22:12:27 +01:00
2015-06-21 21:24:03 +02:00
##########################################################################
# unit tests
##########################################################################
2016-08-04 07:24:46 +02:00
# build unit tests
json_unit :
2016-11-27 16:19:26 +01:00
@$( MAKE) json_unit -C test
2015-06-21 21:24:03 +02:00
2016-08-04 07:24:46 +02:00
# run unit tests
2016-11-27 16:19:26 +01:00
check :
$( MAKE) check -C test
2015-02-13 22:12:27 +01:00
2016-11-27 16:19:26 +01:00
check-fast :
$( MAKE) check -C test TEST_PATTERN = ""
2016-08-04 22:05:16 +02:00
2017-10-04 19:27:35 +02:00
# clean up
clean :
rm -fr json_unit json_benchmarks fuzz fuzz-testing *.dSYM test/*.dSYM
rm -fr benchmarks/files/numbers/*.json
2017-10-05 00:17:09 +02:00
rm -fr build_coverage
2017-10-04 19:27:35 +02:00
$( MAKE) clean -Cdoc
$( MAKE) clean -Ctest
$( MAKE) clean -Cbenchmarks
2015-06-21 12:45:46 +02:00
2017-10-05 00:17:09 +02:00
##########################################################################
# coverage
##########################################################################
coverage :
mkdir build_coverage
cd build_coverage ; CXX = g++-5 cmake .. -GNinja -DJSON_Coverage= ON
cd build_coverage ; ninja
cd build_coverage ; ctest
cd build_coverage ; ninja lcov_html
open build_coverage/test/html/index.html
2016-02-14 16:42:48 +01:00
##########################################################################
# documentation tests
##########################################################################
# compile example files and check output
doctest :
2016-05-29 14:06:43 +02:00
$( MAKE) check_output -C doc
2017-02-22 18:14:29 +01:00
##########################################################################
# warning detector
##########################################################################
# calling Clang with all warnings, except:
# -Wno-documentation-unknown-command: code uses user-defined commands like @complexity
# -Wno-exit-time-destructors: warning in Catch code
# -Wno-keyword-macro: unit-tests use "#define private public"
2017-03-29 00:39:47 +02:00
# -Wno-deprecated-declarations: the library deprecated some functions
2017-03-06 21:00:13 +01:00
# -Wno-weak-vtables: exception class is defined inline, but has virtual method
2017-04-02 18:46:21 +02:00
# -Wno-range-loop-analysis: iterator_wrapper tests "for(const auto i...)"
# -Wno-float-equal: not all comparisons in the tests can be replaced by Approx
2017-10-04 19:27:35 +02:00
# -Wno-switch-enum -Wno-covered-switch-default: pedantic/contradicting warnings about switches
# -Wno-padded: padding is nothing to warn about
2017-03-16 18:35:45 +01:00
pedantic_clang :
2017-02-22 18:14:29 +01:00
$( MAKE) json_unit CXXFLAGS = " \
2017-06-20 23:05:37 +02:00
-std= c++11 -Wno-c++98-compat -Wno-c++98-compat-pedantic \
2017-02-22 18:14:29 +01:00
-Werror \
-Weverything \
-Wno-documentation-unknown-command \
-Wno-exit-time-destructors \
-Wno-keyword-macro \
2017-03-29 00:39:47 +02:00
-Wno-deprecated-declarations \
2017-03-06 21:00:13 +01:00
-Wno-weak-vtables \
2017-04-02 18:46:21 +02:00
-Wno-range-loop-analysis \
2017-06-20 23:05:37 +02:00
-Wno-float-equal \
-Wno-switch-enum -Wno-covered-switch-default \
-Wno-padded"
2017-02-22 18:14:29 +01:00
2017-03-16 18:35:45 +01:00
# calling GCC with most warnings
pedantic_gcc :
2017-12-16 22:19:30 +01:00
$( MAKE) json_unit CXXFLAGS = " \
2017-03-16 18:35:45 +01:00
-std= c++11 \
2017-03-29 00:39:47 +02:00
-Wno-deprecated-declarations \
2017-03-16 18:35:45 +01:00
-Werror \
-Wall -Wpedantic -Wextra \
-Walloca \
-Warray-bounds= 2 \
-Wcast-qual -Wcast-align \
-Wchar-subscripts \
-Wconditionally-supported \
-Wconversion \
-Wdate-time \
-Wdeprecated \
-Wdisabled-optimization \
-Wdouble-promotion \
-Wduplicated-branches \
-Wduplicated-cond \
-Wformat-overflow= 2 \
-Wformat-signedness \
-Wformat-truncation= 2 \
-Wformat= 2 \
2017-07-07 22:41:22 +02:00
-Wno-ignored-qualifiers \
2017-03-16 18:35:45 +01:00
-Wimplicit-fallthrough= 5 \
-Wlogical-op \
-Wmissing-declarations \
-Wmissing-format-attribute \
-Wmissing-include-dirs \
-Wnoexcept \
-Wnonnull \
-Wnull-dereference \
-Wold-style-cast \
-Woverloaded-virtual \
-Wparentheses \
-Wplacement-new= 2 \
-Wredundant-decls \
-Wreorder \
-Wrestrict \
-Wshadow= global \
-Wshift-overflow= 2 \
-Wsign-conversion \
-Wsign-promo \
-Wsized-deallocation \
-Wstrict-overflow= 5 \
-Wsuggest-attribute= const \
-Wsuggest-attribute= format \
-Wsuggest-attribute= noreturn \
-Wsuggest-attribute= pure \
-Wsuggest-final-methods \
-Wsuggest-final-types \
-Wsuggest-override \
-Wtrigraphs \
-Wundef \
-Wuninitialized -Wunknown-pragmas \
-Wunused \
-Wunused-const-variable= 2 \
-Wunused-macros \
-Wunused-parameter \
-Wuseless-cast \
-Wvariadic-macros"
2017-02-22 18:14:29 +01:00
2016-02-12 10:35:08 +01:00
##########################################################################
# fuzzing
##########################################################################
2016-02-14 18:38:29 +01: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 11:09:26 +01:00
$( MAKE) parse_afl_fuzzer -C test CXX = afl-clang++
2016-12-22 12:08:36 +01:00
mv test/parse_afl_fuzzer fuzz-testing/fuzzer
2016-05-11 02:25:54 +02:00
find test/data/json_tests -size -5k -name *json | xargs -I{ } cp "{}" fuzz-testing/testcases
2016-12-22 11:09:26 +01:00
@echo "Execute: afl-fuzz -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer"
2016-02-14 18:38:29 +01:00
2016-12-22 12:08:36 +01: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 16:07:10 +01:00
find test/data -size -5k -name *.cbor | xargs -I{ } cp "{}" fuzz-testing/testcases
2016-12-22 12:08:36 +01:00
@echo "Execute: afl-fuzz -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer"
2016-12-25 16:18:56 +01: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"
2016-12-25 16:36:43 +01: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 10:35:08 +01:00
2015-06-21 21:24:03 +02:00
##########################################################################
# static analyzer
##########################################################################
2015-02-13 22:12:27 +01:00
2015-06-21 21:24:03 +02:00
# call cppcheck on the main header file
2015-02-13 22:12:27 +01:00
cppcheck :
2016-08-18 18:29:19 +02:00
cppcheck --enable= warning --inconclusive --force --std= c++11 src/json.hpp --error-exitcode= 1
2015-06-21 21:24:03 +02:00
2016-11-27 16:19:26 +01:00
2015-06-21 21:24:03 +02:00
##########################################################################
# maintainer targets
##########################################################################
2015-02-13 22:12:27 +01:00
# pretty printer
pretty :
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 \
2016-04-16 12:19:10 +02:00
--lineend= linux --preserve-date --suffix= none --formatted \
2017-08-14 14:41:01 +02:00
$( SRCS) test/src/*.cpp \
2017-10-04 19:27:35 +02:00
benchmarks/src/benchmarks.cpp doc/examples/*.cpp
2016-01-26 22:59:57 +01:00
2017-08-14 20:45:33 +02:00
2016-01-26 22:59:57 +01:00
##########################################################################
# changelog
##########################################################################
2016-07-31 13:37:04 +02:00
NEXT_VERSION ?= "unreleased"
2016-01-26 22:59:57 +01:00
ChangeLog.md :
2016-07-31 13:37:04 +02:00
github_changelog_generator -o ChangeLog.md --simple-list --release-url https://github.com/nlohmann/json/releases/tag/%s --future-release $( NEXT_VERSION)
2016-01-26 23:10:52 +01:00
gsed -i 's|https://github.com/nlohmann/json/releases/tag/HEAD|https://github.com/nlohmann/json/tree/HEAD|' ChangeLog.md
2016-01-26 23:27:07 +01:00
gsed -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