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

N
Niels 已提交
3
# used programs
4
RE2C := $(shell command -v re2c 2> /dev/null)
N
Niels 已提交
5
SED = sed
N
Niels 已提交
6

N
Niels 已提交
7
# main target
8 9
all:
	$(MAKE) -C test
N
Niels 已提交
10 11 12

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

N
Niels 已提交
18 19 20 21 22

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

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

N
Niels 已提交
27
# run unit tests
28 29
check:
	$(MAKE) check -C test
N
Niels 已提交
30

31 32
check-fast:
	$(MAKE) check -C test TEST_PATTERN=""
N
Niels 已提交
33

N
Niels 已提交
34

N
Niels 已提交
35 36 37 38 39 40
##########################################################################
# documentation tests
##########################################################################

# compile example files and check output
doctest:
N
Niels 已提交
41 42 43
	$(MAKE) check_output -C doc


44 45 46 47 48 49 50 51
##########################################################################
# 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"
52
# -Wno-weak-vtables: exception class is defined inline, but has virtual method
53
# -Wno-range-loop-analysis: iterator_wrapper tests tests "for(const auto i...)"
54
pedantic_clang:
55 56 57 58 59 60 61
	$(MAKE) json_unit CXXFLAGS="\
		-std=c++11 \
		-Werror \
		-Weverything \
		-Wno-documentation-unknown-command \
		-Wno-exit-time-destructors \
		-Wno-keyword-macro \
62
		-Wno-weak-vtables \
63 64
		-Wno-range-loop-analysis"

65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 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
# calling GCC with most warnings
pedantic_gcc:
	$(MAKE) json_unit CXX=g++ CXXFLAGS="\
		-std=c++11 \
		-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 \
		-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"
125

126 127 128 129
##########################################################################
# fuzzing
##########################################################################

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

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

147 148 149 150 151 152 153 154
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"

155 156 157 158 159 160 161 162 163 164 165 166 167
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
168

N
Niels 已提交
169 170 171
##########################################################################
# static analyzer
##########################################################################
N
Niels 已提交
172

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

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

181

N
Niels 已提交
182 183 184 185 186 187
##########################################################################
# maintainer targets
##########################################################################

# create scanner with re2c
re2c: src/json.hpp.re2c
188 189 190
ifndef RE2C
	$(error "re2c is not available, please install re2c")
endif
N
Niels 已提交
191
	$(RE2C) -W --utf-8 --encoding-policy fail --bit-vectors --nested-ifs --no-debug-info $< | $(SED) '1d' > src/json.hpp
N
Niels 已提交
192

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

N
Niels 已提交
203 204 205 206

##########################################################################
# benchmarks
##########################################################################
N
Niels 已提交
207 208

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


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

N
Niels 已提交
219 220
NEXT_VERSION ?= "unreleased"

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