Merge pull request nlohmann#18 from nlohmann/develop

Sync Fork from Upstream Repo

.github/workflows/windows_clang.yml

@@ -0,0 +1,32 @@
+name: Windows
+
+on: [push, pull_request]
+
+jobs:
+ clang9:
+ runs-on: windows-latest
+
+ steps:
+ - uses: actions/checkout@v1
+ - name: install Clang
+ run: curl -fsSL -o LLVM9.exe https://releases.llvm.org/9.0.0/LLVM-9.0.0-win64.exe ; 7z x LLVM9.exe -y -o"C:/Program Files/LLVM"
+ - name: cmake
+ run: cmake -S . -B build -DCMAKE_CXX_COMPILER="C:/Program Files/LLVM/bin/clang++.exe" -G"MinGW Makefiles" -DCMAKE_BUILD_TYPE=Debug -DJSON_BuildTests=On
+ - name: build
+ run: cmake --build build --parallel 10
+ - name: test
+ run: cd build ; ctest -j 10 -C Debug --exclude-regex "test-unicode" --output-on-failure
+
+ clang10:
+ runs-on: windows-latest
+
+ steps:
+ - uses: actions/checkout@v1
+ - name: install Clang
+ run: curl -fsSL -o LLVM10.exe https:/llvm/llvm-project/releases/download/llvmorg-10.0.0/LLVM-10.0.0-win64.exe ; 7z x LLVM10.exe -y -o"C:/Program Files/LLVM"
+ - name: cmake
+ run: cmake -S . -B build -DCMAKE_CXX_COMPILER="C:/Program Files/LLVM/bin/clang++.exe" -G"MinGW Makefiles" -DCMAKE_BUILD_TYPE=Debug -DJSON_BuildTests=On
+ - name: build
+ run: cmake --build build --parallel 10
+ - name: test
+ run: cd build ; ctest -j 10 -C Debug --exclude-regex "test-unicode" --output-on-failure

.github/workflows/windows_clang_cl.yml

@@ -0,0 +1,30 @@
+name: Windows
+
+on: [push, pull_request]
+
+jobs:
+ clang-cl-10-x64:
+
+ runs-on: windows-latest
+
+ steps:
+ - uses: actions/checkout@v1
+ - name: cmake
+ run: cmake -S . -B build -G "Visual Studio 16 2019" -A x64 -T ClangCL -DJSON_BuildTests=On
+ - name: build
+ run: cmake --build build --config Debug --parallel 10
+ - name: test
+ run: cd build ; ctest -j 10 -C Debug --exclude-regex "test-unicode" --output-on-failure
+
+ clang-cl-10-x86:
+
+ runs-on: windows-latest
+
+ steps:
+ - uses: actions/checkout@v1
+ - name: cmake
+ run: cmake -S . -B build -G "Visual Studio 16 2019" -A Win32 -T ClangCL -DJSON_BuildTests=On
+ - name: build
+ run: cmake --build build --config Debug --parallel 10
+ - name: test
+ run: cd build ; ctest -j 10 -C Debug --exclude-regex "test-unicode" --output-on-failure

.travis.yml

@@ -10,17 +10,6 @@ sudo: required
 group: edge
 
 
-###################
-# global settings #
-###################
-
-env:
- global:
- # The next declaration is the encrypted COVERITY_SCAN_TOKEN, created
- # via the "travis encrypt" command using the project repo's public key
- - secure: "m89SSgE+ASLO38rSKx7MTXK3n5NkP9bIx95jwY71YEiuFzib30PDJ/DifKnXxBjvy/AkCGztErQRk/8ZCvq+4HXozU2knEGnL/RUitvlwbhzfh2D4lmS3BvWBGS3N3NewoPBrRmdcvnT0xjOGXxtZaJ3P74TkB9GBnlz/HmKORA="
-
-
 ################
 # build matrix #
 ################
@@ -129,6 +118,9 @@ matrix:
  env:
  - SPECIAL=coverity
  - COMPILER=clang++-3.6
+ # The next declaration is the encrypted COVERITY_SCAN_TOKEN, created
+ # via the "travis encrypt" command using the project repo's public key
+ - secure: "m89SSgE+ASLO38rSKx7MTXK3n5NkP9bIx95jwY71YEiuFzib30PDJ/DifKnXxBjvy/AkCGztErQRk/8ZCvq+4HXozU2knEGnL/RUitvlwbhzfh2D4lmS3BvWBGS3N3NewoPBrRmdcvnT0xjOGXxtZaJ3P74TkB9GBnlz/HmKORA="
 
  # OSX / Clang
 
@@ -150,6 +142,9 @@ matrix:
  - os: osx
  osx_image: xcode11.2
 
+ - os: osx
+ osx_image: xcode12
+
  # Linux / GCC
 
  - os: linux

CMakeLists.txt

@@ -4,7 +4,7 @@ cmake_minimum_required(VERSION 3.1)
 ## PROJECT
 ## name and version
 ##
-project(nlohmann_json VERSION 3.8.0 DESCRIPTION "JSON for Modern C++" LANGUAGES CXX)
+project(nlohmann_json VERSION 3.8.0 LANGUAGES CXX)
 
 ##
 ## INCLUDE

Makefile

@@ -5,7 +5,7 @@
 ##########################################################################
 
 # directory to recent compiler binaries
-COMPILER_DIR=/Users/niels/Documents/projects/compilers/local/bin
+COMPILER_DIR=/usr/local/opt/llvm/bin
 
 # find GNU sed to use `-i` parameter
 SED:=$(shell command -v gsed || which sed)
@@ -30,7 +30,6 @@ AMALGAMATED_FILE=single_include/nlohmann/json.hpp
 all:
  @echo "amalgamate - amalgamate file single_include/nlohmann/json.hpp from the include/nlohmann sources"
  @echo "ChangeLog.md - generate ChangeLog file"
- @echo "check - compile and execute test suite"
  @echo "check-amalgamation - check whether sources have been amalgamated"
  @echo "clean - remove built files"
  @echo "coverage - create coverage information with lcov"
@@ -44,26 +43,12 @@ all:
  @echo "fuzz_testing_cbor - prepare fuzz testing of the CBOR parser"
  @echo "fuzz_testing_msgpack - prepare fuzz testing of the MessagePack parser"
  @echo "fuzz_testing_ubjson - prepare fuzz testing of the UBJSON 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"
  @echo "run_benchmarks - build and run benchmarks"
 
 
-##########################################################################
-# unit tests
-##########################################################################
-
-# build unit tests
-json_unit:
- @$(MAKE) json_unit -C test
-
-# run unit tests
-check:
- $(MAKE) check -C test
-
-
 ##########################################################################
 # coverage
 ##########################################################################
@@ -484,13 +469,13 @@ cpplint:
 
 # call Clang-Tidy <https://clang.llvm.org/extra/clang-tidy/>
 clang_tidy:
- $(COMPILER_DIR)/clang-tidy $(AMALGAMATED_FILE) -- -Iinclude -std=c++11
+ $(COMPILER_DIR)/clang-tidy $(SRCS) -- -Iinclude -std=c++11
 
 # call PVS-Studio Analyzer <https://www.viva64.com/en/pvs-studio/>
 pvs_studio:
  rm -fr pvs_studio_build
  mkdir pvs_studio_build
- cd pvs_studio_build ; cmake .. -DCMAKE_EXPORT_COMPILE_COMMANDS=On
+ cd pvs_studio_build ; cmake .. -DCMAKE_EXPORT_COMPILE_COMMANDS=On -DJSON_MultipleHeaders=ON
  cd pvs_studio_build ; pvs-studio-analyzer analyze -j 10
  cd pvs_studio_build ; plog-converter -a'GA:1,2;64:1;CS' -t fullhtml PVS-Studio.log -o pvs
  open pvs_studio_build/pvs/index.html
@@ -499,7 +484,7 @@ pvs_studio:
 infer:
  rm -fr infer_build
  mkdir infer_build
- cd infer_build ; infer compile -- cmake .. ; infer run -- make -j 4
+ cd infer_build ; infer compile -- cmake .. -DJSON_MultipleHeaders=ON ; infer run -- make -j 4
 
 # call OCLint <http://oclint.org> static analyzer
 oclint:
@@ -562,7 +547,7 @@ check-amalgamation:
 check-single-includes:
  @for x in $(SRCS); do \
  echo "Checking self-sufficiency of $$x..." ; \
- echo "#include <$$x>\nint main() {}\n" | sed 's|include/||' > single_include_test.cpp; \
+ echo "#include <$$x>\nint main() {}\n" | $(SED) 's|include/||' > single_include_test.cpp; \
  $(CXX) $(CXXFLAGS) -Iinclude -std=c++11 single_include_test.cpp -o single_include_test; \
  rm -f single_include_test.cpp single_include_test; \
  done
@@ -572,17 +557,17 @@ check-single-includes:
 # CMake
 ##########################################################################
 
-# grep "^option" CMakeLists.txt test/CMakeLists.txt | sed 's/(/ /' | awk '{print $2}' | xargs
+# grep "^option" CMakeLists.txt test/CMakeLists.txt | $(SED) 's/(/ /' | awk '{print $2}' | xargs
 
 # check if all flags of our CMake files work
 check_cmake_flags_do:
  $(CMAKE_BINARY) --version
- for flag in '' JSON_BuildTests JSON_Install JSON_MultipleHeaders JSON_Sanitizer JSON_Valgrind JSON_NoExceptions JSON_Coverage; do \
+ for flag in JSON_BuildTests JSON_Install JSON_MultipleHeaders JSON_Sanitizer JSON_Valgrind JSON_NoExceptions JSON_Coverage; do \
  rm -fr cmake_build; \
  mkdir cmake_build; \
- echo "$(CMAKE_BINARY) .. -D$$flag=On" ; \
+ echo "\n\n$(CMAKE_BINARY) .. -D$$flag=On\n" ; \
  cd cmake_build ; \
- CXX=g++-8 $(CMAKE_BINARY) .. -D$$flag=On -DCMAKE_CXX_COMPILE_FEATURES="cxx_std_11;cxx_range_for" -DCMAKE_CXX_FLAGS="-std=gnu++11" ; \
+ $(CMAKE_BINARY) -Werror=dev .. -D$$flag=On -DCMAKE_CXX_COMPILE_FEATURES="cxx_std_11;cxx_range_for" -DCMAKE_CXX_FLAGS="-std=gnu++11" ; \
  test -f Makefile || exit 1 ; \
  cd .. ; \
  done;
@@ -642,7 +627,6 @@ clean:
  rm -fr cmake-3.1.0-Darwin64.tar.gz cmake-3.1.0-Darwin64
  rm -fr build_coverage build_benchmarks fuzz-testing clang_analyze_build pvs_studio_build infer_build clang_sanitize_build cmake_build
  $(MAKE) clean -Cdoc
- $(MAKE) clean -Ctest
 
 ##########################################################################
 # Thirdparty code
@@ -651,6 +635,6 @@ clean:
 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
- gsed -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 | gsed 's/ //g' | gsed 's/undef/undef /g' > include/nlohmann/thirdparty/hedley/hedley_undef.hpp
+ $(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
  $(MAKE) amalgamate

README.md

@@ -483,7 +483,7 @@ MyIterator begin(MyContainer& tgt) {
 }
 
 MyIterator end(const MyContainer&) {
- return {}; 
+ return {};
 }
 
 void foo() {
@@ -761,7 +761,7 @@ j_document.merge_patch(j_patch);
 Supported types can be implicitly converted to JSON values.
 
 It is recommended to **NOT USE** implicit conversions **FROM** a JSON value.
-You can find more details about this recommendation [here](https://github.com/nlohmann/json/issues/958). 
+You can find more details about this recommendation [here](https://github.com/nlohmann/json/issues/958).
 
 ```cpp
 // strings
@@ -914,7 +914,7 @@ namespace ns {
  std::string street;
  int housenumber;
  int postcode;
- 
+
  public:
  NLOHMANN_DEFINE_TYPE_INTRUSIVE(address, street, housenumber, postcode)
  };
@@ -1190,6 +1190,7 @@ Though it's 2020 already, the support for C++11 is still a bit sparse. Currently
 
 - GCC 4.8 - 10.1 (and possibly later)
 - Clang 3.4 - 10.0 (and possibly later)
+- Apple Clang 9.1 - 12.0 (and possibly later)
 - Intel C++ Compiler 17.0.2 (and possibly later)
 - Microsoft Visual C++ 2015 / Build Tools 14.0.25123.0 (and possibly later)
 - Microsoft Visual C++ 2017 / Build Tools 15.5.180.51428 (and possibly later)
@@ -1225,6 +1226,7 @@ The following compilers are currently used in continuous integration at [Travis]
 | Apple Clang 10.0.1 (clang-1001.0.46.4); Xcode 10.2.1 | macOS 10.14.4 | Travis |
 | Apple Clang 11.0.0 (clang-1100.0.33.12); Xcode 11.2.1 | macOS 10.14.6 | Travis |
 | Apple Clang 11.0.3 (clang-1103.0.32.59); Xcode 11.4.1 | macOS 10.15.4 | GitHub Actions |
+| Apple Clang 12.0.0 (clang-1200.0.22.7); Xcode 11.4.1 | macOS 10.15.5 | Travis |
 | Clang 3.5.0 (3.5.0-4ubuntu2~trusty2) | Ubuntu 14.04.5 LTS | Travis |
 | Clang 3.6.2 (3.6.2-svn240577-1~exp1) | Ubuntu 14.04.5 LTS | Travis |
 | Clang 3.7.1 (3.7.1-svn253571-1~exp1) | Ubuntu 14.04.5 LTS | Travis |
@@ -1235,6 +1237,8 @@ The following compilers are currently used in continuous integration at [Travis]
 | Clang 6.0.1 (6.0.1-svn334776-1~exp1~20190309042707.121) | Ubuntu 14.04.5 LTS | Travis |
 | Clang 7.1.0 (7.1.0-svn353565-1~exp1~20190419134007.64) | Ubuntu 14.04.5 LTS | Travis |
 | Clang 7.5.0 (Ubuntu 7.5.0-3ubuntu1~18.04) | Ubuntu 18.04.4 LTS | Travis |
+| Clang 9.0.0 (x86_64-pc-windows-msvc) | Windows-10.0.17763 | GitHub Actions |
+| Clang 10.0.0 (x86_64-pc-windows-msvc) | Windows-10.0.17763 | GitHub Actions |
 | GCC 4.8.5 (Ubuntu 4.8.5-4ubuntu8~14.04.2) | Ubuntu 14.04.5 LTS | Travis |
 | GCC 4.9.4 (Ubuntu 4.9.4-2ubuntu1~14.04.1) | Ubuntu 14.04.5 LTS | Travis |
 | GCC 5.5.0 (Ubuntu 5.5.0-12ubuntu1~14.04) | Ubuntu 14.04.5 LTS | Travis |
@@ -1250,6 +1254,7 @@ The following compilers are currently used in continuous integration at [Travis]
 | MSVC 19.16.27035.0 (15.9.21+g9802d43bc3 for .NET Framework) | Windows-10.0.14393 | AppVeyor |
 | MSVC 19.25.28614.0 (Build Engine version 16.5.0+d4cbfca49 for .NET Framework) | Windows-10.0.17763 | AppVeyor |
 | MSVC 19.25.28614.0 (Build Engine version 16.5.0+d4cbfca49 for .NET Framework) | Windows-10.0.17763 | GitHub Actions |
+| MSVC 19.25.28614.0 (Build Engine version 16.5.0+d4cbfca49 for .NET Framework) with ClangCL 10.0.0 | Windows-10.0.17763 | GitHub Actions |
 
 ## License
 
@@ -1564,7 +1569,7 @@ This library does not support comments by default. It does so for three reasons:
 1. Comments are not part of the [JSON specification](https://tools.ietf.org/html/rfc8259). You may argue that `//` or `/* */` are allowed in JavaScript, but JSON is not JavaScript.
 2. This was not an oversight: Douglas Crockford [wrote on this](https://plus.google.com/118095276221607585885/posts/RK8qyGVaGSr) in May 2012:
 
- > I removed comments from JSON because I saw people were using them to hold parsing directives, a practice which would have destroyed interoperability. I know that the lack of comments makes some people sad, but it shouldn't. 
+ > I removed comments from JSON because I saw people were using them to hold parsing directives, a practice which would have destroyed interoperability. I know that the lack of comments makes some people sad, but it shouldn't.
 
  > Suppose you are using JSON to keep configuration files, which you would like to annotate. Go ahead and insert all the comments you like. Then pipe it through JSMin before handing it to your JSON parser.
 
@@ -1574,13 +1579,15 @@ However, you can pass set parameter `ignore_comments` to true in the `parse` fun
 
 ### Order of object keys
 
-By default, the library does not preserve the **insertion order of object elements**. This is standards-compliant, as the [JSON standard](https://tools.ietf.org/html/rfc8259.html) defines objects as "an unordered collection of zero or more name/value pairs". If you do want to preserve the insertion order, you can specialize the object type with containers like [`tsl::ordered_map`](https:/Tessil/ordered-map) ([integration](https:/nlohmann/json/issues/546#issuecomment-304447518)) or [`nlohmann::fifo_map`](https:/nlohmann/fifo_map) ([integration](https:/nlohmann/json/issues/485#issuecomment-333652309)).
+By default, the library does not preserve the **insertion order of object elements**. This is standards-compliant, as the [JSON standard](https://tools.ietf.org/html/rfc8259.html) defines objects as "an unordered collection of zero or more name/value pairs".
+
+If you do want to preserve the insertion order, you can try the type [`nlohmann::ordered_json`](https:/nlohmann/json/issues/2179). Alternatively, you can use a more sophisticated ordered map like [`tsl::ordered_map`](https:/Tessil/ordered-map) ([integration](https:/nlohmann/json/issues/546#issuecomment-304447518)) or [`nlohmann::fifo_map`](https:/nlohmann/fifo_map) ([integration](https:/nlohmann/json/issues/485#issuecomment-333652309)).
 
 ### Memory Release
 
-We checked with Valgrind and the Address Sanitizer (ASAN) that there are no memory leaks. 
+We checked with Valgrind and the Address Sanitizer (ASAN) that there are no memory leaks.
 
-If you find that a parsing program with this library does not release memory, please consider the following case and it maybe unrelated to this library. 
+If you find that a parsing program with this library does not release memory, please consider the following case and it maybe unrelated to this library.
 
 **Your program is compiled with glibc.** There is a tunable threshold that glibc uses to decide whether to actually return memory to the system or whether to cache it for later reuse. If in your program you make lots of small allocations and those small allocations are not a contiguous block and are presumably below the threshold, then they will not get returned to the OS.
 Here is a related issue [#1924](https:/nlohmann/json/issues/1924).

cmake/pkg-config.pc.in

@@ -1,4 +1,4 @@
 Name: ${PROJECT_NAME}
-Description: ${PROJECT_DESCRIPTION}
+Description: JSON for Modern C++
 Version: ${PROJECT_VERSION}
 Cflags: -I${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_INCLUDEDIR}

include/nlohmann/adl_serializer.hpp

@@ -37,7 +37,7 @@ struct adl_serializer
  @param[in,out] j JSON value to write to
  @param[in] val value to read from
  */
- template <typename BasicJsonType, typename ValueType>
+ template<typename BasicJsonType, typename ValueType>
  static auto to_json(BasicJsonType& j, ValueType&& val) noexcept(
  noexcept(::nlohmann::to_json(j, std::forward<ValueType>(val))))
  -> decltype(::nlohmann::to_json(j, std::forward<ValueType>(val)), void())