Makefile 7.7 KB
Newer Older
N
Niels 已提交
1
.PHONY: pretty clean ChangeLog.md
N
Niels 已提交
2

N
Niels 已提交
3
# main target
4 5
all:
	$(MAKE) -C test
N
Niels 已提交
6 7 8

# clean up
clean:
N
Niels Lohmann 已提交
9
	rm -fr json_unit json_benchmarks fuzz fuzz-testing *.dSYM test/*.dSYM
N
Niels 已提交
10
	rm -fr benchmarks/files/numbers/*.json
N
Niels 已提交
11
	$(MAKE) clean -Cdoc
N
Niels 已提交
12
	$(MAKE) clean -Ctest
N
Niels 已提交
13

N
Niels 已提交
14 15 16 17 18

##########################################################################
# unit tests
##########################################################################

N
Niels 已提交
19 20
# build unit tests
json_unit:
21
	@$(MAKE) json_unit -C test
N
Niels 已提交
22

N
Niels 已提交
23
# run unit tests
24 25
check:
	$(MAKE) check -C test
N
Niels 已提交
26

27 28
check-fast:
	$(MAKE) check -C test TEST_PATTERN=""
N
Niels 已提交
29

N
Niels 已提交
30

N
Niels 已提交
31 32 33 34 35 36
##########################################################################
# documentation tests
##########################################################################

# compile example files and check output
doctest:
N
Niels 已提交
37 38 39
	$(MAKE) check_output -C doc


40 41 42 43 44 45 46 47
##########################################################################
# 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"
48
# -Wno-deprecated-declarations: the library deprecated some functions
49
# -Wno-weak-vtables: exception class is defined inline, but has virtual method
N
Niels Lohmann 已提交
50 51
# -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
52
pedantic_clang:
53
	$(MAKE) json_unit CXXFLAGS="\
N
Niels Lohmann 已提交
54
		-std=c++11 -Wno-c++98-compat -Wno-c++98-compat-pedantic \
55 56 57 58 59
		-Werror \
		-Weverything \
		-Wno-documentation-unknown-command \
		-Wno-exit-time-destructors \
		-Wno-keyword-macro \
60
		-Wno-deprecated-declarations \
61
		-Wno-weak-vtables \
N
Niels Lohmann 已提交
62
		-Wno-range-loop-analysis \
N
Niels Lohmann 已提交
63 64 65
		-Wno-float-equal \
		-Wno-switch-enum -Wno-covered-switch-default \
		-Wno-padded"
66

67 68 69 70
# calling GCC with most warnings
pedantic_gcc:
	$(MAKE) json_unit CXX=g++ CXXFLAGS="\
		-std=c++11 \
71
		-Wno-deprecated-declarations \
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
		-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 \
		-Weffc++ \
		-Wformat-overflow=2 \
		-Wformat-signedness \
		-Wformat-truncation=2 \
		-Wformat=2 \
91
		-Wno-ignored-qualifiers \
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
		-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"
129

130 131 132 133
##########################################################################
# fuzzing
##########################################################################

N
Niels 已提交
134 135 136 137
# the overall fuzz testing target
fuzz_testing:
	rm -fr fuzz-testing
	mkdir -p fuzz-testing fuzz-testing/testcases fuzz-testing/out
138
	$(MAKE) parse_afl_fuzzer -C test CXX=afl-clang++
N
Niels Lohmann 已提交
139
	mv test/parse_afl_fuzzer fuzz-testing/fuzzer
140
	find test/data/json_tests -size -5k -name *json | xargs -I{} cp "{}" fuzz-testing/testcases
141
	@echo "Execute: afl-fuzz -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer"
N
Niels 已提交
142

N
Niels Lohmann 已提交
143 144 145 146 147
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
148
	find test/data -size -5k -name *.cbor | xargs -I{} cp "{}" fuzz-testing/testcases
N
Niels Lohmann 已提交
149 150
	@echo "Execute: afl-fuzz -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer"

151 152 153 154 155 156 157 158
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"

159 160 161 162 163 164 165 166 167 168 169 170 171
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
172

N
Niels 已提交
173 174 175
##########################################################################
# static analyzer
##########################################################################
N
Niels 已提交
176

N
Niels 已提交
177
# call cppcheck on the main header file
N
Niels 已提交
178
cppcheck:
N
Niels 已提交
179
	cppcheck --enable=warning --inconclusive --force --std=c++11 src/json.hpp --error-exitcode=1
N
Niels 已提交
180

181
# run clang sanitize (we are overrding the CXXFLAGS provided by travis in order to use gcc's libstdc++)
N
Niels 已提交
182
clang_sanitize: clean
N
Niels Lohmann 已提交
183
	CXX=clang++ CXXFLAGS="-g -O2 -fsanitize=address -fsanitize=undefined -fno-omit-frame-pointer" $(MAKE) check
N
Niels 已提交
184

185

N
Niels 已提交
186 187 188 189
##########################################################################
# maintainer targets
##########################################################################

N
Niels 已提交
190 191 192 193 194 195
# 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 \
N
Niels 已提交
196
	   --lineend=linux --preserve-date --suffix=none --formatted \
N
Niels Lohmann 已提交
197
	   src/json.hpp test/src/*.cpp \
198
	   benchmarks/benchmarks.cpp doc/examples/*.cpp
N
Niels 已提交
199

N
Niels 已提交
200 201 202 203

##########################################################################
# benchmarks
##########################################################################
N
Niels 已提交
204 205

# benchmarks
N
Niels 已提交
206
json_benchmarks: benchmarks/benchmarks.cpp benchmarks/benchpress.hpp benchmarks/cxxopts.hpp src/json.hpp
N
Niels 已提交
207
	cd benchmarks/files/numbers ; python generate.py
208
	$(CXX) -std=c++11 -pthread $(CXXFLAGS) -DNDEBUG -O3 -flto -I src -I benchmarks $< $(LDFLAGS) -o $@
N
Niels 已提交
209
	./json_benchmarks
N
Niels 已提交
210 211 212 213 214 215


##########################################################################
# changelog
##########################################################################

N
Niels 已提交
216 217
NEXT_VERSION ?= "unreleased"

N
Niels 已提交
218
ChangeLog.md:
N
Niels 已提交
219
	github_changelog_generator -o ChangeLog.md --simple-list --release-url https://github.com/nlohmann/json/releases/tag/%s --future-release $(NEXT_VERSION)
N
Niels 已提交
220
	gsed -i 's|https://github.com/nlohmann/json/releases/tag/HEAD|https://github.com/nlohmann/json/tree/HEAD|' ChangeLog.md
N
Niels 已提交
221
	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