pax_global_header00006660000000000000000000000064147715376330014532gustar00rootroot0000000000000052 comment=7382dc2be88e53fbc35cb50369b831855656f0fd simdjson-3.12.3/000077500000000000000000000000001477153763300134465ustar00rootroot00000000000000simdjson-3.12.3/.appveyor.yml000066400000000000000000000035241477153763300161200ustar00rootroot00000000000000version: '{build}' branches: { only: [ master ] } configuration: Release image: Visual Studio 2019 platform: x64 cache: - C:\dependencies -> dependencies\CMakeLists.txt environment: # Forward slash is used because this is used in CMake as is simdjson_DEPENDENCY_CACHE_DIR: C:/dependencies matrix: - job_name: VS2019 CMAKE_ARGS: -A %Platform% - job_name: VS2019ARM CMAKE_ARGS: -A ARM64 -DSIMDJSON_DEVELOPER_MODE=ON -DCMAKE_CROSSCOMPILING=1 -D SIMDJSON_GOOGLE_BENCHMARKS=OFF # Does Google Benchmark builds under VS ARM? - job_name: VS2017 (Static, No Threads) image: Visual Studio 2017 CMAKE_ARGS: -A %Platform% -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF -DSIMDJSON_ENABLE_THREADS=OFF CTEST_ARGS: -LE explicitonly - job_name: VS2019 (Win32) platform: Win32 CMAKE_ARGS: -A %Platform% -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=ON -DSIMDJSON_ENABLE_THREADS=ON # This should be the default. Testing anyway. CTEST_ARGS: -LE explicitonly - job_name: VS2019 (Win32, No Exceptions) platform: Win32 CMAKE_ARGS: -A %Platform% -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=ON -DSIMDJSON_ENABLE_THREADS=ON -DSIMDJSON_EXCEPTIONS=OFF CTEST_ARGS: -LE explicitonly - job_name: VS2015 image: Visual Studio 2015 CMAKE_ARGS: -A %Platform% -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF -DSIMDJSON_ENABLE_THREADS=OFF CTEST_ARGS: -LE explicitonly build_script: - mkdir build - cd build - cmake --version - cmake %CMAKE_ARGS% .. - cmake -LH .. - cmake --build . --config %Configuration% --verbose --parallel for: - matrix: except: - job_name: VS2019ARM test_script: - ctest --output-on-failure -C %Configuration% --verbose %CTEST_ARGS% --parallel clone_folder: c:\projects\simdjson matrix: fast_finish: true simdjson-3.12.3/.circleci/000077500000000000000000000000001477153763300153015ustar00rootroot00000000000000simdjson-3.12.3/.circleci/config.yml000066400000000000000000000265121477153763300172770ustar00rootroot00000000000000version: 2.1 # We constantly run out of memory so please do not use parallelism (-j, -j4). # Reusable image / compiler definitions executors: gcc8: docker: - image: conanio/gcc8 environment: CXX: g++-8 CC: gcc-8 CMAKE_BUILD_FLAGS: CTEST_FLAGS: --output-on-failure gcc9: docker: - image: conanio/gcc9 environment: CXX: g++-9 CC: gcc-9 CMAKE_BUILD_FLAGS: CTEST_FLAGS: --output-on-failure gcc10: docker: - image: conanio/gcc10 environment: CXX: g++-10 CC: gcc-10 CMAKE_BUILD_FLAGS: CTEST_FLAGS: --output-on-failure clang10: docker: - image: conanio/clang10 environment: CXX: clang++-10 CC: clang-10 CMAKE_BUILD_FLAGS: CTEST_FLAGS: --output-on-failure clang9: docker: - image: conanio/clang9 environment: CXX: clang++-9 CC: clang-9 CMAKE_BUILD_FLAGS: CTEST_FLAGS: --output-on-failure clang6: docker: - image: conanio/clang60 environment: CXX: clang++-6.0 CC: clang-6.0 CMAKE_BUILD_FLAGS: CTEST_FLAGS: --output-on-failure # Reusable test commands (and initializer for clang 6) commands: dependency_restore: steps: - restore_cache: keys: - cmake-cache-{{ checksum "dependencies/CMakeLists.txt" }} dependency_cache: steps: - save_cache: key: cmake-cache-{{ checksum "dependencies/CMakeLists.txt" }} paths: - dependencies/.cache install_cmake: steps: - run: apt-get update -qq - run: apt-get install -y cmake cmake_prep: steps: - checkout - run: mkdir -p build cmake_build_cache: steps: - cmake_prep - dependency_restore - run: cmake -DSIMDJSON_DEVELOPER_MODE=ON $CMAKE_FLAGS -DCMAKE_INSTALL_PREFIX:PATH=destination -B build . - dependency_cache # dependencies are produced in the configure step cmake_build: steps: - cmake_build_cache - run: cmake --build build cmake_test: steps: - cmake_build - run: | cd build && tools/json2json -h && ctest $CTEST_FLAGS -L acceptance && ctest $CTEST_FLAGS -LE acceptance -LE explicitonly cmake_assert_test: steps: - run: | cd build && tools/json2json -h && ctest $CTEST_FLAGS -L assert cmake_test_all: steps: - cmake_build - run: | cd build && tools/json2json -h && ctest $CTEST_FLAGS -DSIMDJSON_IMPLEMENTATION="haswell;westmere;fallback" -L acceptance -LE per_implementation && SIMDJSON_FORCE_IMPLEMENTATION=haswell ctest $CTEST_FLAGS -L per_implementation -LE explicitonly && SIMDJSON_FORCE_IMPLEMENTATION=westmere ctest $CTEST_FLAGS -L per_implementation -LE explicitonly && SIMDJSON_FORCE_IMPLEMENTATION=fallback ctest $CTEST_FLAGS -L per_implementation -LE explicitonly && ctest $CTEST_FLAGS -LE "acceptance|per_implementation" # Everything we haven't run yet, run now. cmake_perftest: steps: - cmake_build_cache - run: | cmake -DSIMDJSON_ENABLE_DOM_CHECKPERF=ON --build build --target checkperf && cd build && ctest --output-on-failure -R checkperf # we not only want cmake to build and run tests, but we want also a successful installation from which we can build, link and run programs cmake_install_test: # this version builds, install, test and then verify from the installation steps: - run: cd build && make install - run: echo -e '#include \nint main(int argc,char**argv) {simdjson::dom::parser parser;simdjson::dom::element tweets = parser.load(argv[1]); }' > tmp.cpp && c++ -Ibuild/destination/include -Lbuild/destination/lib -std=c++17 -Wl,-rpath,build/destination/lib -o linkandrun tmp.cpp -lsimdjson && ./linkandrun jsonexamples/twitter.json cmake_installed_test_cxx20: # assuming that it was installed, this tries to build using C++20 steps: - run: echo -e '#include \nint main(int argc,char**argv) {simdjson::dom::parser parser;simdjson::dom::element tweets = parser.load(argv[1]); }' > tmp.cpp && c++ -Ibuild/destination/include -Lbuild/destination/lib -std=c++20 -Wl,-rpath,build/destination/lib -o linkandrun tmp.cpp -lsimdjson && ./linkandrun jsonexamples/twitter.json jobs: # static justlib-gcc10: description: Build just the library, install it and do a basic test executor: gcc10 environment: { CMAKE_FLAGS: -DSIMDJSON_JUST_LIBRARY=ON } steps: [ cmake_build, cmake_install_test, cmake_installed_test_cxx20 ] assert-gcc10: description: Build the library with asserts on, install it and run tests executor: gcc10 environment: { CMAKE_FLAGS: -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DCMAKE_CXX_FLAGS_RELEASE=-O3 } steps: [ cmake_test, cmake_assert_test ] assert-clang10: description: Build just the library, install it and do a basic test executor: clang10 environment: { CMAKE_FLAGS: -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DCMAKE_CXX_FLAGS_RELEASE=-O3 } steps: [ cmake_test, cmake_assert_test ] gcc10-perftest: description: Build and run performance tests on GCC 10 and AVX 2 with a cmake static build, this test performance regression executor: gcc10 environment: { CMAKE_FLAGS: -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DBUILD_SHARED_LIBS=OFF } steps: [ cmake_perftest ] gcc10: description: Build and run tests on GCC 10 and AVX 2 with a cmake static build executor: gcc10 environment: { CMAKE_FLAGS: -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DBUILD_SHARED_LIBS=OFF } steps: [ cmake_test, cmake_install_test, cmake_installed_test_cxx20 ] clang6: description: Build and run tests on clang 6 and AVX 2 with a cmake static build executor: clang6 environment: { CMAKE_FLAGS: -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DBUILD_SHARED_LIBS=OFF } steps: [ cmake_test, cmake_install_test ] clang10: description: Build and run tests on clang 10 and AVX 2 with a cmake static build executor: clang10 environment: { CMAKE_FLAGS: -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DBUILD_SHARED_LIBS=OFF } steps: [ cmake_test, cmake_install_test, cmake_installed_test_cxx20 ] # libcpp libcpp-clang10: description: Build and run tests on clang 10 and AVX 2 with a cmake static build and libc++ executor: clang10 environment: { CMAKE_FLAGS: -DSIMDJSON_USE_LIBCPP=ON -DBUILD_SHARED_LIBS=OFF } steps: [ cmake_test, cmake_install_test, cmake_installed_test_cxx20 ] # sanitize sanitize-gcc10: description: Build and run tests on GCC 10 and AVX 2 with a cmake sanitize build executor: gcc10 environment: { CMAKE_FLAGS: -DCMAKE_BUILD_TYPE=Debug -DBUILD_SHARED_LIBS=ON -DSIMDJSON_SANITIZE=ON, CTEST_FLAGS: --output-on-failure -LE explicitonly } steps: [ cmake_test ] sanitize-clang10: description: Build and run tests on clang 10 and AVX 2 with a cmake sanitize build executor: clang10 environment: { CMAKE_FLAGS: -DBUILD_SHARED_LIBS=ON -DSIMDJSON_NO_FORCE_INLINING=ON -DSIMDJSON_SANITIZE=ON, CTEST_FLAGS: --output-on-failure -LE explicitonly } steps: [ cmake_test ] threadsanitize-gcc10: description: Build and run tests on GCC 10 and AVX 2 with a cmake sanitize build executor: gcc10 environment: { CMAKE_FLAGS: -DBUILD_SHARED_LIBS=ON -DSIMDJSON_SANITIZE_THREADS=ON, CTEST_FLAGS: --output-on-failure -LE explicitonly } steps: [ cmake_test ] threadsanitize-clang10: description: Build and run tests on clang 10 and AVX 2 with a cmake sanitize build executor: clang10 environment: { CMAKE_FLAGS: -DBUILD_SHARED_LIBS=ON -DSIMDJSON_NO_FORCE_INLINING=ON -DSIMDJSON_SANITIZE_THREADS=ON, CTEST_FLAGS: --output-on-failure -LE explicitonly } steps: [ cmake_test ] # dynamic dynamic-gcc10: description: Build and run tests on GCC 10 and AVX 2 with a cmake dynamic build executor: gcc10 environment: { CMAKE_FLAGS: -DBUILD_SHARED_LIBS=ON } steps: [ cmake_test, cmake_install_test ] dynamic-clang10: description: Build and run tests on clang 10 and AVX 2 with a cmake dynamic build executor: clang10 environment: { CMAKE_FLAGS: -DBUILD_SHARED_LIBS=ON } steps: [ cmake_test, cmake_install_test ] # unthreaded unthreaded-gcc10: description: Build and run tests on GCC 10 and AVX 2 *without* threads executor: gcc10 environment: { CMAKE_FLAGS: -DSIMDJSON_ENABLE_THREADS=OFF } steps: [ cmake_test, cmake_install_test ] unthreaded-clang10: description: Build and run tests on Clang 10 and AVX 2 *without* threads executor: clang10 environment: { CMAKE_FLAGS: -DSIMDJSON_ENABLE_THREADS=OFF } steps: [ cmake_test, cmake_install_test ] # noexcept noexcept-gcc10: description: Build and run tests on GCC 10 and AVX 2 with exceptions off executor: gcc10 environment: { CMAKE_FLAGS: -DSIMDJSON_EXCEPTIONS=OFF } steps: [ cmake_test, cmake_install_test ] noexcept-clang10: description: Build and run tests on Clang 10 and AVX 2 with exceptions off executor: clang10 environment: { CMAKE_FLAGS: -DSIMDJSON_EXCEPTIONS=OFF } steps: [ cmake_test, cmake_install_test ] # # Misc. # # make (test and checkperf) arch-haswell-gcc10: description: Build, run tests and check performance on GCC 10 with -march=haswell executor: gcc10 environment: { CXXFLAGS: -march=haswell } steps: [ cmake_test ] arch-nehalem-gcc10: description: Build, run tests and check performance on GCC 10 with -march=nehalem executor: gcc10 environment: { CXXFLAGS: -march=nehalem } steps: [ cmake_test ] sanitize-haswell-gcc10: description: Build and run tests on GCC 10 and AVX 2 with a cmake sanitize build executor: gcc10 environment: { CXXFLAGS: -march=haswell, CMAKE_FLAGS: -DCMAKE_BUILD_TYPE=Debug -DBUILD_SHARED_LIBS=ON -DSIMDJSON_SANITIZE=ON, CTEST_FLAGS: --output-on-failure -LE explicitonly } steps: [ cmake_test ] sanitize-haswell-clang10: description: Build and run tests on clang 10 and AVX 2 with a cmake sanitize build executor: clang10 environment: { CXXFLAGS: -march=haswell, CMAKE_FLAGS: -DBUILD_SHARED_LIBS=ON -DSIMDJSON_NO_FORCE_INLINING=ON -DSIMDJSON_SANITIZE=ON, CTEST_FLAGS: --output-on-failure -LE explicitonly } steps: [ cmake_test ] workflows: version: 2.1 build_and_test: jobs: # full multi-implementation tests #- gcc7 tested on GitHub actions - gcc10 # do not delete this as it tests our performance - clang6 #- clang10 # this gets tested a lot below # libc++ - libcpp-clang10 # full single-implementation tests - sanitize-gcc10 - sanitize-clang10 - threadsanitize-gcc10 - threadsanitize-clang10 - dynamic-gcc10 - dynamic-clang10 - unthreaded-gcc10 - unthreaded-clang10 # no exceptions - noexcept-gcc10 - noexcept-clang10 # quicker make single-implementation tests - arch-haswell-gcc10 - arch-nehalem-gcc10 # sanitized single-implementation tests - sanitize-haswell-gcc10 - sanitize-haswell-clang10 # testing "just the library" - justlib-gcc10 # testing asserts - assert-gcc10 - assert-clang10 # TODO add windows: https://circleci.com/docs/2.0/configuration-reference/#windows simdjson-3.12.3/.cirrus.yml000066400000000000000000000011441477153763300155560ustar00rootroot00000000000000task: timeout_in: 120m freebsd_instance: matrix: - image_family: freebsd-13-0-snap env: ASSUME_ALWAYS_YES: YES simdjson_DEPENDENCY_CACHE_DIR: $HOME/.dep_cache dep_cache: folder: $HOME/.dep_cache reupload_on_changes: false fingerprint_script: cat dependencies/CMakeLists.txt setup_script: - pkg update -f - pkg install bash - pkg install cmake - pkg install git build_script: - mkdir build - cd build - cmake -DSIMDJSON_BASH=OFF -DSIMDJSON_GIT=OFF .. - make test_script: - cd build - ctest --output-on-failure -LE explicitonly simdjson-3.12.3/.clang-format000066400000000000000000000000231477153763300160140ustar00rootroot00000000000000BasedOnStyle: LLVM simdjson-3.12.3/.clangd000066400000000000000000000025661477153763300147100ustar00rootroot00000000000000CompileFlags: CompilationDatabase: build Add: - -Werror -Wall -Wextra -Weffc++ -Wsign-compare -Wshadow -Wwrite-strings -Wpointer-arith -Winit-self -Wconversion -Wno-sign-conversion - -Wundefined-inline Diagnostics: Suppress: - misc-unused-alias-decls - misc-unused-using-decls - misc-definitions-in-headers # TODO fix and remove these violations --- If: PathMatch: - include/.* - src/.* PathExclude: - include/simdjson.h - src/simdjson.cpp CompileFlags: Add: - -Wno-unneeded-internal-declaration - -Wno-undefined-internal # TODO fix and remove these violations - -Wno-unused-function - -Wno-unused-const-variable Diagnostics: Suppress: - pp_including_mainfile_in_preamble - unused-includes --- # Amalgamated files that require or partly define an implementation If: PathMatch: - .*/(arm64|fallback|haswell|icelake|ppc64|westmere)/begin.h - .*/generic/.* Diagnostics: Suppress: - pragma_attribute_no_pop_eof --- # clang has a bad time detecting the push/pop together in src/ for some reason If: PathMatch: - include/simdjson/.*/end.h - src/(arm64|fallback|haswell|icelake|ppc64|westmere).cpp Diagnostics: Suppress: - pragma_attribute_no_pop_eof - pragma_attribute_stack_mismatch simdjson-3.12.3/.dockerignore000066400000000000000000000002171477153763300161220ustar00rootroot00000000000000* !.git !Makefile !amalgamate.py !benchmark !dependencies !include !jsonchecker !jsonexamples !scripts !singleheader !src !style !tests !tools simdjson-3.12.3/.drone.yml000066400000000000000000000330441477153763300153620ustar00rootroot00000000000000kind: pipeline name: gcc9 platform: { os: linux, arch: amd64 } steps: - name: Build and Test image: gcc:9 environment: CC: gcc CXX: g++ BUILD_FLAGS: -- -j CMAKE_FLAGS: -DBUILD_SHARED_LIBS=OFF -DSIMDJSON_IMPLEMENTATION=icelake;haswell;westmere;fallback CTEST_FLAGS: -j4 --output-on-failure -LE explicitonly commands: - echo "deb http://deb.debian.org/debian buster-backports main" >> /etc/apt/sources.list - apt-get update -qq - apt-get -t buster-backports install -y cmake - mkdir build - cd build - cmake $CMAKE_FLAGS .. - cmake --build . $BUILD_FLAGS - ctest $CTEST_FLAGS -L acceptance -LE per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=icelake ctest $CTEST_FLAGS -L per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=haswell ctest $CTEST_FLAGS -L per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=westmere ctest $CTEST_FLAGS -L per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=fallback ctest $CTEST_FLAGS -L per_implementation - ctest $CTEST_FLAGS -LE "acceptance|per_implementation" # Everything we haven't run yet, run now. --- kind: pipeline name: clang6 platform: { os: linux, arch: amd64 } steps: - name: Build and Test image: conanio/clang60 user: root environment: CC: clang-6.0 CXX: clang++-6.0 BUILD_FLAGS: -- -j CMAKE_FLAGS: -DBUILD_SHARED_LIBS=OFF -DSIMDJSON_IMPLEMENTATION=icelake;haswell;westmere;fallback CTEST_FLAGS: -j4 --output-on-failure -LE explicitonly commands: - mkdir build - cd build - cmake $CMAKE_FLAGS .. - cmake --build . $BUILD_FLAGS - ctest $CTEST_FLAGS -L acceptance -LE per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=icelake ctest $CTEST_FLAGS -L per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=haswell ctest $CTEST_FLAGS -L per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=westmere ctest $CTEST_FLAGS -L per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=fallback ctest $CTEST_FLAGS -L per_implementation - ctest $CTEST_FLAGS -LE "acceptance|per_implementation" # Everything we haven't run yet, run now. --- kind: pipeline name: dynamic-gcc9 platform: { os: linux, arch: amd64 } steps: - name: Build and Test image: gcc:9 environment: CC: gcc CXX: g++ BUILD_FLAGS: -- -j CMAKE_FLAGS: -DBUILD_SHARED_LIBS=ON CTEST_FLAGS: -j4 --output-on-failure -LE explicitonly commands: - echo "deb http://deb.debian.org/debian buster-backports main" >> /etc/apt/sources.list - apt-get update -qq - apt-get -t buster-backports install -y cmake - mkdir build - cd build - cmake $CMAKE_FLAGS .. - cmake --build . $BUILD_FLAGS - ctest $CTEST_FLAGS --- kind: pipeline name: dynamic-clang9 platform: { os: linux, arch: amd64 } steps: - name: Build and Test image: conanio/clang9 user: root environment: CC: clang-9 CXX: clang++-9 CMAKE_FLAGS: -DBUILD_SHARED_LIBS=ON BUILD_FLAGS: -- -j CTEST_FLAGS: -j4 --output-on-failure -LE explicitonly commands: - mkdir build - cd build - cmake $CMAKE_FLAGS .. - cmake --build . $BUILD_FLAGS - ctest $CTEST_FLAGS --- kind: pipeline name: sanitize-gcc9 platform: { os: linux, arch: amd64 } steps: - name: Build and Test image: gcc:9 environment: CC: gcc CXX: g++ BUILD_FLAGS: -- -j CMAKE_FLAGS: -DBUILD_SHARED_LIBS=OFF -DSIMDJSON_IMPLEMENTATION=icelake;haswell;westmere;fallback CTEST_FLAGS: -j4 --output-on-failure -LE explicitonly commands: - echo "deb http://deb.debian.org/debian buster-backports main" >> /etc/apt/sources.list - apt-get update -qq - apt-get -t buster-backports install -y cmake - mkdir build - cd build - cmake $CMAKE_FLAGS .. - cmake --build . $BUILD_FLAGS - ASAN_OPTIONS="detect_leaks=0" ctest $CTEST_FLAGS -L acceptance -LE per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=icelake ASAN_OPTIONS="detect_leaks=0" ctest $CTEST_FLAGS -L per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=haswell ASAN_OPTIONS="detect_leaks=0" ctest $CTEST_FLAGS -L per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=westmere ASAN_OPTIONS="detect_leaks=0" ctest $CTEST_FLAGS -L per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=fallback ASAN_OPTIONS="detect_leaks=0" ctest $CTEST_FLAGS -L per_implementation - ASAN_OPTIONS="detect_leaks=0" ctest $CTEST_FLAGS -LE "acceptance|per_implementation" # Everything we haven't run yet, run now. --- kind: pipeline name: sanitize-clang9 platform: { os: linux, arch: amd64 } steps: - name: Build and Test image: conanio/clang9 user: root environment: CC: clang-9 CXX: clang++-9 CMAKE_FLAGS: -DSIMDJSON_SANITIZE=ON -DSIMDJSON_IMPLEMENTATION=icelake;haswell;westmere;fallback BUILD_FLAGS: -- -j CTEST_FLAGS: -j4 --output-on-failure -LE explicitonly commands: - mkdir build - cd build - cmake $CMAKE_FLAGS .. - cmake --build . $BUILD_FLAGS - ASAN_OPTIONS="detect_leaks=0" ctest $CTEST_FLAGS -L acceptance -LE per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=icelake ASAN_OPTIONS="detect_leaks=0" ctest $CTEST_FLAGS -L per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=haswell ASAN_OPTIONS="detect_leaks=0" ctest $CTEST_FLAGS -L per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=westmere ASAN_OPTIONS="detect_leaks=0" ctest $CTEST_FLAGS -L per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=fallback ASAN_OPTIONS="detect_leaks=0" ctest $CTEST_FLAGS -L per_implementation - ASAN_OPTIONS="detect_leaks=0" ctest $CTEST_FLAGS -LE "acceptance|per_implementation" # Everything we haven't run yet, run now. --- kind: pipeline name: cpp20-clang11-libcpp platform: { os: linux, arch: amd64 } steps: - name: Build and Test image: pauldreik/llvm-11 user: root environment: CC: clang-11 CXX: clang++-11 CMAKE_FLAGS: -GNinja BUILD_FLAGS: CTEST_FLAGS: -j4 --output-on-failure -LE explicitonly CXXFLAGS: -std=c++20 -stdlib=libc++ commands: - mkdir build - cd build - cmake $CMAKE_FLAGS .. - cmake --build . $BUILD_FLAGS - ctest $CTEST_FLAGS --- kind: pipeline name: arm64-gcc8 platform: { os: linux, arch: arm64 } steps: - name: Build and Test image: gcc:8 environment: CC: gcc CXX: g++ BUILD_FLAGS: -- -j CMAKE_FLAGS: -DBUILD_SHARED_LIBS=OFF -DSIMDJSON_IMPLEMENTATION=arm64;fallback CTEST_FLAGS: -j4 --output-on-failure -LE explicitonly commands: - echo "deb http://deb.debian.org/debian buster-backports main" >> /etc/apt/sources.list - apt-get update -qq - apt-get -t buster-backports install -y cmake - mkdir build - cd build - cmake $CMAKE_FLAGS .. - cmake --build . $BUILD_FLAGS - ctest $CTEST_FLAGS -L acceptance -LE per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=arm64 ctest $CTEST_FLAGS -L per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=fallback ctest $CTEST_FLAGS -L per_implementation - ctest $CTEST_FLAGS -LE "acceptance|per_implementation" # Everything we haven't run yet, run now. --- kind: pipeline name: arm64-clang6 platform: { os: linux, arch: arm64 } steps: - name: Build and Test image: debian:buster-backports environment: CC: clang-6.0 CXX: clang++-6.0 CMAKE_FLAGS: -DBUILD_SHARED_LIBS=ON BUILD_FLAGS: -- -j CTEST_FLAGS: -j4 --output-on-failure -LE explicitonly commands: - apt-get -qq update - apt-get -t buster-backports install -y cmake - apt-get install -y clang-6.0 git - mkdir build - cd build - cmake $CMAKE_FLAGS .. - cmake --build . $BUILD_FLAGS - ctest $CTEST_FLAGS --- kind: pipeline name: arm64-dynamic-gcc8 platform: { os: linux, arch: arm64 } steps: - name: Build and Test image: gcc:8 environment: CC: gcc CXX: g++ BUILD_FLAGS: -- -j CMAKE_FLAGS: -DBUILD_SHARED_LIBS=ON CTEST_FLAGS: -j4 --output-on-failure -LE explicitonly commands: - echo "deb http://deb.debian.org/debian buster-backports main" >> /etc/apt/sources.list - apt-get update -qq - apt-get -t buster-backports install -y cmake - mkdir build - cd build - cmake $CMAKE_FLAGS .. - cmake --build . $BUILD_FLAGS - ctest $CTEST_FLAGS --- kind: pipeline name: arm64-dynamic-clang6 platform: { os: linux, arch: arm64 } steps: - name: Build and Test image: debian:buster-backports environment: CC: clang-6.0 CXX: clang++-6.0 CMAKE_FLAGS: -DBUILD_SHARED_LIBS=ON BUILD_FLAGS: -- -j CTEST_FLAGS: -j4 --output-on-failure -LE explicitonly commands: - apt-get -qq update - apt-get -t buster-backports install -y cmake - apt-get install -y clang-6.0 git - mkdir build - cd build - cmake $CMAKE_FLAGS .. - cmake --build . $BUILD_FLAGS - ctest $CTEST_FLAGS --- kind: pipeline name: arm64-sanitize-gcc8 platform: { os: linux, arch: arm64 } steps: - name: Build and Test image: gcc:8 environment: BUILD_FLAGS: -- -j CMAKE_FLAGS: -DBUILD_SHARED_LIBS=OFF -DSIMDJSON_IMPLEMENTATION=arm64;fallback CTEST_FLAGS: -j4 --output-on-failure -LE explicitonly CC: gcc CXX: g++ commands: - echo "deb http://deb.debian.org/debian buster-backports main" >> /etc/apt/sources.list - apt-get update -qq - apt-get -t buster-backports install -y cmake - apt-get install -y libstdc++6 - mkdir build - cd build - cmake $CMAKE_FLAGS .. - cmake --build . $BUILD_FLAGS - ASAN_OPTIONS="detect_leaks=0" ctest $CTEST_FLAGS -L acceptance -LE per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=arm64 ASAN_OPTIONS="detect_leaks=0" ctest $CTEST_FLAGS -L per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=fallback ASAN_OPTIONS="detect_leaks=0" ctest $CTEST_FLAGS -L per_implementation - ASAN_OPTIONS="detect_leaks=0" ctest $CTEST_FLAGS -LE "acceptance|per_implementation" # Everything we haven't run yet, run now. --- kind: pipeline name: arm64-sanitize-clang6 platform: { os: linux, arch: arm64 } steps: - name: Build and Test image: debian:buster-backports environment: CC: clang-6.0 CXX: clang++-6.0 CMAKE_FLAGS: -DSIMDJSON_SANITIZE=ON -DSIMDJSON_IMPLEMENTATION=arm64;fallback BUILD_FLAGS: -- -j CTEST_FLAGS: -j4 --output-on-failure -LE explicitonly commands: - apt-get -qq update - apt-get -t buster-backports install -y cmake - apt-get install -y clang-6.0 git - mkdir build - cd build - cmake $CMAKE_FLAGS .. - cmake --build . $BUILD_FLAGS - ASAN_OPTIONS="detect_leaks=0" ctest $CTEST_FLAGS -L acceptance -LE per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=arm64 ASAN_OPTIONS="detect_leaks=0" ctest $CTEST_FLAGS -L per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=fallback ASAN_OPTIONS="detect_leaks=0" ctest $CTEST_FLAGS -L per_implementation - ASAN_OPTIONS="detect_leaks=0" ctest $CTEST_FLAGS -LE "acceptance|per_implementation" # Everything we haven't run yet, run now. --- kind: pipeline name: ninja-clang9 platform: { os: linux, arch: amd64 } steps: - name: Build and Test image: conanio/clang9 user: root environment: CC: clang-9 CXX: clang++-9 BUILD_FLAGS: -- -j 4 CMAKE_FLAGS: -GNinja -DBUILD_SHARED_LIBS=OFF CTEST_FLAGS: -j4 --output-on-failure -LE explicitonly CXXFLAGS: -stdlib=libc++ commands: - mkdir build - cd build - cmake $CMAKE_FLAGS .. - cmake --build . $BUILD_FLAGS - ctest $CTEST_FLAGS --- kind: pipeline name: libcpp-clang9 platform: { os: linux, arch: amd64 } steps: - name: Build and Test image: conanio/clang9 user: root environment: CC: clang-9 CXX: clang++-9 BUILD_FLAGS: -- -j CMAKE_FLAGS: -DBUILD_SHARED_LIBS=OFF CTEST_FLAGS: -j4 --output-on-failure -LE explicitonly CXXFLAGS: -stdlib=libc++ commands: - mkdir build - cd build - cmake $CMAKE_FLAGS .. - cmake --build . $BUILD_FLAGS - ctest $CTEST_FLAGS --- kind: pipeline name: libcpp-clang7 platform: { os: linux, arch: amd64 } steps: - name: Build and Test image: conanio/clang7 user: root environment: CC: clang-7 CXX: clang++-7 BUILD_FLAGS: -- -j CMAKE_FLAGS: -DBUILD_SHARED_LIBS=OFF CTEST_FLAGS: -j4 --output-on-failure -LE explicitonly CXXFLAGS: -stdlib=libc++ commands: - mkdir build - cd build - cmake $CMAKE_FLAGS .. - cmake --build . $BUILD_FLAGS - ctest $CTEST_FLAGS --- kind: pipeline name: noexceptions-gcc9 platform: { os: linux, arch: amd64 } steps: - name: Build and Test image: gcc:9 environment: CC: gcc CXX: g++ BUILD_FLAGS: -- -j CMAKE_FLAGS: -DSIMDJSON_EXCEPTIONS=OFF CTEST_FLAGS: -j4 --output-on-failure -LE explicitonly commands: - echo "deb http://deb.debian.org/debian buster-backports main" >> /etc/apt/sources.list - apt-get update -qq - apt-get -t buster-backports install -y cmake - mkdir build - cd build - cmake $CMAKE_FLAGS .. - cmake --build . $BUILD_FLAGS - ctest $CTEST_FLAGS --- kind: pipeline name: arm64-fuzz platform: { os: linux, arch: arm64 } steps: - name: Build and run fuzzers shortly image: ubuntu:20.04 environment: CC: clang CXX: clang++ DEBIAN_FRONTEND: noninteractive ASAN_OPTIONS: detect_leaks=0 commands: - apt-get -qq update - apt-get install -q -y clang cmake git wget zip ninja-build - wget -O corpus.tar.gz https://readonly:readonly@www.pauldreik.se/fuzzdata/index.php?project=simdjson - tar xf corpus.tar.gz && rm corpus.tar.gz - fuzz/build_like_ossfuzz.sh - mkdir -p common_out - for fuzzer in build/fuzz/fuzz_* ; do echo $fuzzer;$fuzzer common_out out/* -max_total_time=40; done --- kind: pipeline name: stylecheck platform: { os: linux, arch: amd64 } steps: - name: Build and Test image: ubuntu:18.04 commands: - apt-get update -y - apt-get install -y python clang-format - ./style/run-clang-format.py -r include/ benchmark/ src/ tests/ simdjson-3.12.3/.github/000077500000000000000000000000001477153763300150065ustar00rootroot00000000000000simdjson-3.12.3/.github/ISSUE_TEMPLATE/000077500000000000000000000000001477153763300171715ustar00rootroot00000000000000simdjson-3.12.3/.github/ISSUE_TEMPLATE/bug_report.md000066400000000000000000000111111477153763300216560ustar00rootroot00000000000000--- name: Bug report about: Create a report to help us improve title: '' labels: bug (unverified) assignees: '' --- Before submitting an issue, please ensure that you have read the documentation: * Basics is an overview of how to use simdjson and its APIs: https://github.com/simdjson/simdjson/blob/master/doc/basics.md * Performance shows some more advanced scenarios and how to tune for them: https://github.com/simdjson/simdjson/blob/master/doc/performance.md * Contributing: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md * We follow the [JSON specification as described by RFC 8259](https://www.rfc-editor.org/rfc/rfc8259.txt) (T. Bray, 2017). If you wish to support features that are not part of RFC 8259, then you should not refer to your issue as a bug. **Describe the bug** A clear and concise description of what the bug is. A bug is a failure to build with normal compiler settings or a misbehaviour: when running the code, you get a result that differs from the expected result from our documentation. A compiler or static-analyzer warning is not a bug. It is possible with tools such as Visual Studio to require that rarely enabled warnings are considered errors. Do not report such cases as bugs. We do accept pull requests if you want to silence warnings issued by code analyzers, however. We are committed to providing good documentation. We accept the lack of documentation or a misleading documentation as a bug (a 'documentation bug'). An unexpected poor software performance can be accepted as a bug (a 'performance bug'). We accept the identification of an issue by a sanitizer or some checker tool (e.g., valgrind) as a bug, but you must first ensure that it is not a false positive. We recommend that you run your tests using different optimization levels. In particular, we recommend your run tests with the simdjson library and you code compiled in debug mode. The simdjson then sets the SIMDJSON_DEVELOPMENT_CHECKS macro to 1, and this triggers additional checks on your code and on the internals of the library. If possible, we recommend that you run tests with sanitizers (e.g., see [No more leaks with sanitize flags in gcc and clang](https://lemire.me/blog/2016/04/20/no-more-leaks-with-sanitize-flags-in-gcc-and-clang/)). You can compile the library with sanitizers for debugging purposes (e.g., set SIMDJSON_SANITIZE to ON using CMake), but you should also turn on sanitizers on your own code. You may also use tools like valgrind or the commercial equivalent. Before reporting a bug, please ensure that you have read our documentation. **To Reproduce** Steps to reproduce the behaviour: provide a code sample if possible. Please provide a complete test with data. Remember that a bug is either a failure to build or an unexpected result when running the code. If we cannot reproduce the issue, then we cannot address it. Note that a stack trace from your own program is not enough. A sample of your source code is insufficient: please provide a complete test for us to reproduce the issue. Please reduce the issue: use as small and as simple an example of the bug as possible. It should be possible to trigger the bug by using solely simdjson with our default build setup. If you can only observe the bug within some specific context, with some other software, please reduce the issue first. **simjson release** Unless you plan to contribute to simdjson, you should only work from releases. Please be mindful that our main branch may have additional features, bugs and documentation items. It is fine to report bugs against our main branch, but if that is what you are doing, please be explicit. **Configuration (please complete the following information if relevant)** - OS: [e.g. Ubuntu 16.04.6 LTS] - Compiler* [e.g. Apple clang version 11.0.3 (clang-1103.0.32.59) x86_64-apple-darwin19.4.0] - Version [e.g. 22] - Optimization setting (e.g., -O3) We support up-to-date 64-bit ARM and x64 FreeBSD, macOS, Windows and Linux systems. Please ensure that your configuration is supported before labelling the issue as a bug. * We do not support unreleased or experimental compilers. If you encounter an issue with a pre-release version of a compiler, do not report it as a bug to simdjson. However, we always invite contributions either in the form an analysis or of a code contribution. **Indicate whether you are willing or able to provide a bug fix as a pull request** If you plan to contribute to simdjson, please read our guide: * CONTRIBUTING guide: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md and our * HACKING guide: https://github.com/simdjson/simdjson/blob/master/HACKING.md simdjson-3.12.3/.github/ISSUE_TEMPLATE/config.yml000066400000000000000000000000341477153763300211560ustar00rootroot00000000000000blank_issues_enabled: false simdjson-3.12.3/.github/ISSUE_TEMPLATE/feature_request.md000066400000000000000000000035411477153763300227210ustar00rootroot00000000000000--- name: Feature request about: Suggest an idea for this project title: '' labels: '' assignees: '' --- Before submitting an issue, please ensure that you have read the documentation: * Basics is an overview of how to use simdjson and its APIs: https://github.com/simdjson/simdjson/blob/master/doc/basics.md * Performance shows some more advanced scenarios and how to tune for them: https://github.com/simdjson/simdjson/blob/master/doc/performance.md * Contributing: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md * We follow the [JSON specification as described by RFC 8259](https://www.rfc-editor.org/rfc/rfc8259.txt) (T. Bray, 2017). We do not make changes to simdjson without clearly identifiable benefits, which typically means either performance improvements, bug fixes or new features. Avoid bike-shedding: we all have opinions about how to write code, but we want to focus on what makes simdjson objectively better. **Is your feature request related to a problem? Please describe.** A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] **Describe the solution you'd like** A clear and concise description of what you want to happen. Please provide a clear rationale for the feature. Be advised that simdjson is a community-based project: you should consider providing help. **Describe alternatives you've considered** A clear and concise description of any alternative solutions or features you've considered. **Additional context** Add any other context or screenshots about the feature request here. **Are you willing to contribute code or documentation toward this new feature?** If you plan to contribute to simdjson, please read our * CONTRIBUTING guide: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md and our * HACKING guide: https://github.com/simdjson/simdjson/blob/master/HACKING.md simdjson-3.12.3/.github/ISSUE_TEMPLATE/standard-issue-template.md000066400000000000000000000033361477153763300242570ustar00rootroot00000000000000--- name: Standard issue template about: Issue title: '' labels: '' assignees: '' --- Before submitting an issue, please ensure that you have read the documentation: * Basics is an overview of how to use simdjson and its APIs: https://github.com/simdjson/simdjson/blob/master/doc/basics.md * Performance shows some more advanced scenarios and how to tune for them: https://github.com/simdjson/simdjson/blob/master/doc/performance.md * Contributing: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md * We follow the [JSON specification as described by RFC 8259](https://www.rfc-editor.org/rfc/rfc8259.txt) (T. Bray, 2017). We do not make changes to simdjson without clearly identifiable benefits, which typically means either performance improvements, bug fixes or new features. Avoid bike-shedding: we all have opinions about how to write code, but we want to focus on what makes simdjson objectively better. Is your issue: 1. A bug report? If so, please point at a reproducible test. Indicate whether you are willing or able to provide a bug fix as a pull request. As a matter of policy, we do not consider a compiler warning to be a bug. 2. A build issue? If so, provide all possible details regarding your system configuration. If we cannot reproduce your issue, we cannot fix it. 3. A feature request? Please provide a clear rationale for the feature. Be advised that simdjson is a community-based project: you should consider providing help. 4. A documentation issue? Can you suggest an improvement? If you plan to contribute to simdjson, please read our * CONTRIBUTING guide: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md and our * HACKING guide: https://github.com/simdjson/simdjson/blob/master/HACKING.md simdjson-3.12.3/.github/pull_request_template.md000066400000000000000000000011061477153763300217450ustar00rootroot00000000000000 Our tests check whether you have introduced trailing white space. If such a test fails, please check the "artifacts button" above, which if you click it gives a link to a downloadable file to help you identify the issue. You can also run scripts/remove_trailing_whitespace.sh locally if you have a bash shell and the sed command available on your system. If you plan to contribute to simdjson, please read our CONTRIBUTING guide: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md and our HACKING guide: https://github.com/simdjson/simdjson/blob/master/HACKING.md simdjson-3.12.3/.github/workflows/000077500000000000000000000000001477153763300170435ustar00rootroot00000000000000simdjson-3.12.3/.github/workflows/aarch64.yml000066400000000000000000000013241477153763300210160ustar00rootroot00000000000000name: Ubuntu ppc64le (GCC 11) on: push: branches: - master pull_request: branches: - master jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - uses: uraimo/run-on-arch-action@v3 name: Test id: runcmd with: arch: aarch64 distro: ubuntu_latest githubToken: ${{ github.token }} install: | apt-get update -q -y apt-get install -y cmake make g++ run: | cmake -DSIMDJSON_SANITIZE_UNDEFINED=ON -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_COMPETITION=OFF -B build cmake --build build -j=2 ctest --output-on-failure --test-dir build simdjson-3.12.3/.github/workflows/alpine.yml000066400000000000000000000021541477153763300210400ustar00rootroot00000000000000name: Alpine Linux on: [push, pull_request] jobs: ubuntu-build: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - uses: actions/cache@v4 with: path: dependencies/.cache key: ${{ hashFiles('dependencies/CMakeLists.txt') }} - name: start docker run: | docker run -w /src -dit --name alpine -v $PWD:/src alpine:latest echo 'docker exec alpine "$@";' > ./alpine.sh chmod +x ./alpine.sh - name: install packages run: | ./alpine.sh apk update ./alpine.sh apk add build-base cmake g++ linux-headers git bash - name: cmake run: | ./alpine.sh cmake -DSIMDJSON_DEVELOPER_MODE=ON -B build_for_alpine - name: build run: | ./alpine.sh cmake --build build_for_alpine - name: test run: | ./alpine.sh bash -c "cd build_for_alpine && ctest -LE explicitonly --output-on-failure" simdjson-3.12.3/.github/workflows/cifuzz.yml000066400000000000000000000012211477153763300210740ustar00rootroot00000000000000name: CIFuzz on: [pull_request] jobs: Fuzzing: runs-on: ubuntu-latest steps: - name: Build Fuzzers id: build uses: google/oss-fuzz/infra/cifuzz/actions/build_fuzzers@master with: oss-fuzz-project-name: 'simdjson' dry-run: false - name: Run Fuzzers uses: google/oss-fuzz/infra/cifuzz/actions/run_fuzzers@master with: oss-fuzz-project-name: 'simdjson' fuzz-seconds: 600 dry-run: false - name: Upload Crash uses: actions/upload-artifact@v4 if: failure() && steps.build.outcome == 'success' with: name: artifacts path: ./out/artifacts simdjson-3.12.3/.github/workflows/debian.yaml000066400000000000000000000011561477153763300211540ustar00rootroot00000000000000name: Debian on: [push, pull_request] defaults: run: shell: sh permissions: contents: read jobs: pkg-config: runs-on: ubuntu-latest container: image: debian:testing steps: - uses: actions/checkout@v4 - name: Install dependencies run: | apt -y update apt -y --no-install-recommends install g++ cmake make pkg-config - name: Build and install run: | cmake -B build cmake --build build cmake --install build - name: Test pkg-config run: g++ examples/quickstart/quickstart.cpp $(pkg-config --cflags --libs simdjson) simdjson-3.12.3/.github/workflows/documentation.yml000066400000000000000000000014701477153763300224410ustar00rootroot00000000000000name: Doxygen GitHub Pages on: release: types: [created] # Allows you to run this workflow manually from the Actions tab workflow_dispatch: permissions: contents: write pages: write id-token: write jobs: deploy: environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: Install Doxygen run: sudo apt-get install doxygen graphviz -y - run: mkdir docs - name: Install theme run: ./tools/prepare_doxygen.sh - name: Generate Doxygen Documentation run: doxygen - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: doc/api/html simdjson-3.12.3/.github/workflows/fix-trailing-whitespace.yml000066400000000000000000000021401477153763300243120ustar00rootroot00000000000000name: Detect trailing whitespace on: [push, pull_request] jobs: whitespace: runs-on: ubuntu-20.04 steps: - uses: actions/checkout@v4 - name: Remove whitespace and check the diff run: | set -eu scripts/remove_trailing_whitespace.sh git diff >whitespace.patch cat whitespace.patch if [ $(wc -c - ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') runs-on: ubuntu-latest env: # fuzzers that change behaviour with SIMDJSON_FORCE_IMPLEMENTATION defaultimplfuzzers: atpointer dump dump_raw_tape element minify parser print_json # fuzzers that loop over the implementations themselves, or don't need to switch. implfuzzers: implementations minifyimpl ndjson ondemand padded utf8 implementations: haswell westmere fallback UBSAN_OPTIONS: halt_on_error=1 MAXLEN: -max_len=4000 CLANGVERSION: 19 # which optimization level to use for the sanitizer build (see build_fuzzer.variants.sh) OPTLEVEL: -O3 steps: - name: Install packages necessary for building run: | sudo apt update sudo apt-get install --quiet ninja-build valgrind zip unzip lsb-release wget software-properties-common gnupg wget https://apt.llvm.org/llvm.sh sudo apt-get purge --auto-remove llvm python3-lldb-15 llvm-15 chmod +x llvm.sh sudo ./llvm.sh $CLANGVERSION - uses: actions/checkout@v4 - uses: actions/cache@v4 with: path: dependencies/.cache key: ${{ hashFiles('dependencies/CMakeLists.txt') }} - uses: actions/cache@v4 id: cache-corpus with: path: out/ key: corpus-${{ github.run_id }} restore-keys: corpus- - name: show statistics for the cached corpus run: | echo number of files in github action corpus cache: find out -type f |wc -l - name: Create and prepare the initial seed corpus run: | fuzz/build_corpus.sh mv corpus.zip seed_corpus.zip mkdir seedcorpus unzip -q -d seedcorpus seed_corpus.zip - name: List clang versions run: | ls /usr/bin/clang* which clang++ clang++ --version - name: Build all the variants run: CLANGSUFFIX=-$CLANGVERSION fuzz/build_fuzzer_variants.sh - name: Explore fast (release build, default implementation) run: | set -eux for fuzzer in $defaultimplfuzzers $implfuzzers; do mkdir -p out/$fuzzer # in case this is a new fuzzer, or the github action cached corpus is broken # get input from everyone else (corpus cross pollination) others=$(find out -type d -not -name $fuzzer -not -name out -not -name cmin) build-fast/fuzz/fuzz_$fuzzer out/$fuzzer $others seedcorpus -max_total_time=30 $MAXLEN done - name: Fuzz default impl. fuzzers with sanitizer+asserts (good at detecting errors) run: | set -eux for fuzzer in $defaultimplfuzzers; do # get input from everyone else (corpus cross pollination) others=$(find out -type d -not -name $fuzzer -not -name out -not -name cmin) for implementation in $implementations; do export SIMDJSON_FORCE_IMPLEMENTATION=$implementation build-sanitizers$OPTLEVEL/fuzz/fuzz_$fuzzer out/$fuzzer $others seedcorpus -max_total_time=20 $MAXLEN done echo now have $(ls out/$fuzzer |wc -l) files in corpus done - name: Fuzz differential impl. fuzzers with sanitizer+asserts (good at detecting errors) run: | set -eux for fuzzer in $implfuzzers; do # get input from everyone else (corpus cross pollination) others=$(find out -type d -not -name $fuzzer -not -name out -not -name cmin) build-sanitizers$OPTLEVEL/fuzz/fuzz_$fuzzer out/$fuzzer $others seedcorpus -max_total_time=20 $MAXLEN echo now have $(ls out/$fuzzer |wc -l) files in corpus done - name: Minimize the corpus with the fast fuzzer on the default implementation run: | set -eux for fuzzer in $defaultimplfuzzers $implfuzzers; do mkdir -p out/cmin/$fuzzer # get input from everyone else (corpus cross pollination) others=$(find out -type d -not -name $fuzzer -not -name out -not -name cmin) build-fast/fuzz/fuzz_$fuzzer -merge=1 $MAXLEN out/cmin/$fuzzer out/$fuzzer $others seedcorpus rm -rf out/$fuzzer mv out/cmin/$fuzzer out/$fuzzer done - name: Package the corpus into an artifact run: | for fuzzer in $defaultimplfuzzers $implfuzzers; do tar rf corpus.tar out/$fuzzer done - name: Save the corpus as a github artifact uses: actions/upload-artifact@v4 with: name: corpus path: corpus.tar - name: Store the corpus externally run: | gzip --keep corpus.tar curl -F"filedata=@corpus.tar.gz" https://simdjson:${{ secrets.fuzzdatapassword }}@www.pauldreik.se/fuzzdata/index.php # This takes a subset of the minimized corpus and run it through valgrind. It is slow, # therefore take a "random" subset. The random selection is accomplished by sorting on filenames, # which are hashes of the content. - name: Run some of the minimized corpus through valgrind (replay build, default implementation) run: | for fuzzer in $defaultimplfuzzers $implfuzzers; do find out/$fuzzer -type f |sort|head -n200|xargs -n40 valgrind build-replay/fuzz/fuzz_$fuzzer 2>&1|tee valgrind-$fuzzer.txt done - name: Compress the valgrind output run: tar cf valgrind.tar valgrind-*.txt - name: Save valgrind output as a github artifact uses: actions/upload-artifact@v4 if: always() with: name: valgrindresults path: valgrind.tar if-no-files-found: ignore - name: Archive any crashes as an artifact uses: actions/upload-artifact@v4 if: always() with: name: crashes path: | crash-* leak-* timeout-* if-no-files-found: ignore simdjson-3.12.3/.github/workflows/loongarch64.yml000066400000000000000000000033501477153763300217150ustar00rootroot00000000000000name: LoongArch64-CI on: [push, pull_request] jobs: loongarch64: runs-on: ubuntu-latest strategy: fail-fast: false matrix: platform: - { toolchain-version: 2023.08.08 } steps: - uses: actions/checkout@v4 - name: Install build requirements run: | sudo apt-get update -y sudo apt-get install -y --no-install-recommends cmake - uses: actions/cache/restore@v4 id: restore-cache with: path: /opt/cross-tools key: loongarch64-${{ matrix.platform.toolchain-version }} - name: Download LoongArch64 gcc+glibc toolchain if: ${{ !steps.restore-cache.outputs.cache-hit }} run: | url="https://github.com/loongson/build-tools/releases/download/${{ matrix.platform.toolchain-version }}/x86_64-cross-tools-loongarch64-gcc-libc.tar.xz" wget "$url" -O /tmp/toolchain.tar.xz mkdir -p /opt tar -C /opt -x -f /tmp/toolchain.tar.xz - uses: actions/cache/save@v3 if: ${{ !steps.restore-cache.outputs.cache-hit }} with: path: /opt/cross-tools key: loongarch64-${{ matrix.platform.toolchain-version }} - name: setup Loongarch64 build environment run: | echo "/opt/cross-tools/bin" >> $GITHUB_PATH echo "CC=loongarch64-unknown-linux-gnu-gcc" >> $GITHUB_ENV echo "CXX=loongarch64-unknown-linux-gnu-g++" >> $GITHUB_ENV - name: configure run: cmake -B build -DCMAKE_SYSTEM_PROCESSOR=loongarch64 -DARCH=lonngarch64 -DCMAKE_SYSTEM_NAME=Linux -DCMAKE_C_COMPILER=loongarch64-unknown-linux-gnu-gcc -DCMAKE_CXX_COMPILER=loongarch64-unknown-linux-gnu-g++ - name: build run: cmake --build build simdjson-3.12.3/.github/workflows/macos.yml000066400000000000000000000046751477153763300207040ustar00rootroot00000000000000name: Macos on: [push, pull_request] jobs: macos-build: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') runs-on: macos-latest steps: - uses: actions/checkout@v4 - uses: actions/cache@v4 with: path: dependencies/.cache key: ${{ hashFiles('dependencies/CMakeLists.txt') }} - name: Use cmake run: | mkdir builddebug && cd builddebug && cmake -DCMAKE_BUILD_TYPE=Debug -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF .. && cmake --build . && ctest --output-on-failure -LE explicitonly -j && cd .. && mkdir build && cd build && cmake -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF -DCMAKE_INSTALL_PREFIX:PATH=destination .. && cmake --build . && ctest --output-on-failure -LE explicitonly -j && cmake --install . && echo -e '#include \nint main(int argc,char**argv) {simdjson::dom::parser parser;simdjson::dom::element tweets = parser.load(argv[1]); }' > tmp.cpp && c++ -Idestination/include -Ldestination/lib -std=c++17 -Wl,-rpath,destination/lib -o linkandrun tmp.cpp -lsimdjson && ./linkandrun jsonexamples/twitter.json && cd ../tests/installation_tests/find && mkdir build && cd build && cmake -DCMAKE_INSTALL_PREFIX:PATH=../../../build/destination .. && cmake --build . - name: Use cmake (shared) run: | mkdir buildshared && cd buildshared && cmake -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=ON -DCMAKE_INSTALL_PREFIX:PATH=destination .. && cmake --build . && ctest --output-on-failure -LE explicitonly -j && cmake --install . && echo -e '#include \nint main(int argc,char**argv) {simdjson::dom::parser parser;simdjson::dom::element tweets = parser.load(argv[1]); }' > tmp.cpp && c++ -Idestination/include -Ldestination/lib -std=c++17 -Wl,-rpath,destination/lib -o linkandrun tmp.cpp -lsimdjson && ./linkandrun jsonexamples/twitter.json && cd ../tests/installation_tests/find && mkdir buildshared && cd buildshared && cmake -DCMAKE_INSTALL_PREFIX:PATH=../../../buildshared/destination .. && cmake --build . simdjson-3.12.3/.github/workflows/msys2-clang.yml000066400000000000000000000027561477153763300217370ustar00rootroot00000000000000name: MSYS2-CLANG-CI on: [push, pull_request] jobs: windows-mingw: name: ${{ matrix.msystem }} runs-on: windows-latest defaults: run: shell: msys2 {0} strategy: fail-fast: false matrix: include: - msystem: "MINGW64" install: mingw-w64-x86_64-libxml2 mingw-w64-x86_64-cmake mingw-w64-x86_64-ninja mingw-w64-x86_64-clang type: Release - msystem: "MINGW64" install: mingw-w64-x86_64-libxml2 mingw-w64-x86_64-cmake mingw-w64-x86_64-ninja mingw-w64-x86_64-clang type: Debug - msystem: "MINGW64" install: mingw-w64-x86_64-libxml2 mingw-w64-x86_64-cmake mingw-w64-x86_64-ninja mingw-w64-x86_64-clang type: RelWithDebInfo env: CMAKE_GENERATOR: Ninja steps: - uses: actions/checkout@v4 - uses: actions/cache@v4 with: path: dependencies/.cache key: ${{ hashFiles('dependencies/CMakeLists.txt') }} - uses: msys2/setup-msys2@v2 with: update: true msystem: ${{ matrix.msystem }} install: ${{ matrix.install }} - name: Build and Test run: | mkdir build cd build cmake -DSIMDJSON_DEVELOPER_MODE=ON -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_BUILD_TYPE=${{ matrix.type }} -DBUILD_SHARED_LIBS=OFF -DSIMDJSON_DO_NOT_USE_THREADS_NO_MATTER_WHAT=ON .. cmake --build . --verbose ctest -j4 --output-on-failure -LE explicitonly simdjson-3.12.3/.github/workflows/msys2.yml000066400000000000000000000030271477153763300206450ustar00rootroot00000000000000name: MSYS2-CI on: [push, pull_request] jobs: windows-mingw: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') name: ${{ matrix.msystem }} runs-on: windows-latest defaults: run: shell: msys2 {0} strategy: fail-fast: false matrix: include: - msystem: "MINGW64" install: mingw-w64-x86_64-cmake mingw-w64-x86_64-ninja mingw-w64-x86_64-gcc type: Release - msystem: "MINGW64" install: mingw-w64-x86_64-cmake mingw-w64-x86_64-ninja mingw-w64-x86_64-gcc type: Debug - msystem: "MINGW64" install: mingw-w64-x86_64-cmake mingw-w64-x86_64-ninja mingw-w64-x86_64-gcc type: RelWithDebInfo env: CMAKE_GENERATOR: Ninja steps: - uses: actions/checkout@v4 - uses: actions/cache@v4 with: path: dependencies/.cache key: ${{ hashFiles('dependencies/CMakeLists.txt') }} - uses: msys2/setup-msys2@v2 with: update: true msystem: ${{ matrix.msystem }} install: ${{ matrix.install }} - name: Build and Test run: | mkdir build cd build cmake -DSIMDJSON_DEVELOPER_MODE=ON -DCMAKE_BUILD_TYPE=${{ matrix.type }} -DBUILD_SHARED_LIBS=OFF -DSIMDJSON_DO_NOT_USE_THREADS_NO_MATTER_WHAT=ON .. cmake --build . --verbose ctest -j4 --output-on-failure -LE explicitonly simdjson-3.12.3/.github/workflows/ppc64.yml000066400000000000000000000013171477153763300205240ustar00rootroot00000000000000name: Ubuntu ppc64le (GCC 11) on: push: branches: - master pull_request: branches: - master jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - uses: uraimo/run-on-arch-action@v3 name: Test id: runcmd with: arch: ppc64le distro: ubuntu_latest githubToken: ${{ github.token }} install: | apt-get update -q -y apt-get install -y cmake make g++ run: | cmake -DCMAKE_BUILD_TYPE=Release -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_COMPETITION=OFF -B build cmake --build build -j=2 ctest --output-on-failure --test-dir build simdjson-3.12.3/.github/workflows/riscv64.yml000066400000000000000000000013171477153763300210700ustar00rootroot00000000000000name: Ubuntu riscv64 (GCC 11) on: push: branches: - master pull_request: branches: - master jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - uses: uraimo/run-on-arch-action@v3 name: Test id: runcmd with: arch: riscv64 distro: ubuntu_latest githubToken: ${{ github.token }} install: | apt-get update -q -y apt-get install -y cmake make g++ run: | cmake -DCMAKE_BUILD_TYPE=Release -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_COMPETITION=OFF -B build cmake --build build -j=2 ctest --output-on-failure --test-dir build simdjson-3.12.3/.github/workflows/s390x.yml000066400000000000000000000013131477153763300204520ustar00rootroot00000000000000name: Ubuntu s390x (GCC 11) on: push: branches: - master pull_request: branches: - master jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - uses: uraimo/run-on-arch-action@v3 name: Test id: runcmd with: arch: s390x distro: ubuntu_latest githubToken: ${{ github.token }} install: | apt-get update -q -y apt-get install -y cmake make g++ run: | cmake -DCMAKE_BUILD_TYPE=Release -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_COMPETITION=OFF -B build cmake --build build -j=2 ctest --output-on-failure --test-dir build simdjson-3.12.3/.github/workflows/ubuntu20-checkperf.yml000066400000000000000000000017061477153763300232060ustar00rootroot00000000000000name: Performance check on Ubuntu 20.04 CI (GCC 9) on: push: branches: - master pull_request: branches: - master jobs: ubuntu-build: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') runs-on: ubuntu-20.04 steps: - uses: actions/checkout@v4 - uses: actions/cache@v4 with: path: dependencies/.cache key: ${{ hashFiles('dependencies/CMakeLists.txt') }} - name: Use cmake run: | mkdir build && cd build && cmake -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_ENABLE_DOM_CHECKPERF=ON -DCMAKE_CXX_FLAGS="-Werror=old-style-cast -pedantic -Wpedantic" -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DBUILD_SHARED_LIBS=OFF -DCMAKE_INSTALL_PREFIX:PATH=destination .. && cmake --build . --target checkperf && ctest --output-on-failure -R checkperf simdjson-3.12.3/.github/workflows/ubuntu20-gcc8.yml000066400000000000000000000032771477153763300221050ustar00rootroot00000000000000name: Ubuntu 20.04 CI (GCC 8) on: [push, pull_request] jobs: ubuntu-build: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') runs-on: ubuntu-20.04 env: CXX: g++-8 CC: gcc-8 steps: - uses: actions/checkout@v4 - uses: actions/cache@v4 with: path: dependencies/.cache key: ${{ hashFiles('dependencies/CMakeLists.txt') }} - name: Install GCC 8 run: sudo apt-get install -y g++-8 - name: Use cmake run: | mkdir builddebug && cd builddebug && cmake -DCMAKE_BUILD_TYPE=Debug -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF .. && cmake --build . && ctest --output-on-failure -LE explicitonly -j && cd .. && mkdir build && cd build && cmake -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF -DCMAKE_INSTALL_PREFIX:PATH=destination .. && cmake --build . && ctest --output-on-failure -LE explicitonly -j && cmake --install . && echo -e '#include \nint main(int argc,char**argv) {simdjson::dom::parser parser;simdjson::dom::element tweets = parser.load(argv[1]); }' > tmp.cpp && c++ -Idestination/include -Ldestination/lib -std=c++17 -Wl,-rpath,destination/lib -o linkandrun tmp.cpp -lsimdjson && ./linkandrun jsonexamples/twitter.json && cd ../tests/installation_tests/find && mkdir build && cd build && cmake -DCMAKE_INSTALL_PREFIX:PATH=../../../build/destination .. && cmake --build . simdjson-3.12.3/.github/workflows/ubuntu20-noexcept.yml000066400000000000000000000035161477153763300231020ustar00rootroot00000000000000name: Ubuntu 20.04 CI (GCC 9) without exceptions on: [push, pull_request] jobs: ubuntu-build: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') runs-on: ubuntu-20.04 steps: - uses: actions/checkout@v4 - uses: actions/cache@v4 with: path: dependencies/.cache key: ${{ hashFiles('dependencies/CMakeLists.txt') }} - name: Use cmake run: | mkdir builddebug && cd builddebug && cmake -DCMAKE_BUILD_TYPE=Debug -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_EXCEPTIONS=OFF -DBUILD_SHARED_LIBS=OFF .. && cmake --build . && ctest --output-on-failure -LE explicitonly -j && cd .. && mkdir build && cd build && cmake -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DSIMDJSON_EXCEPTIONS=OFF -DBUILD_SHARED_LIBS=OFF -DCMAKE_INSTALL_PREFIX:PATH=destination .. && cmake --build . && ctest --output-on-failure -LE explicitonly -j && make install && echo -e '#include \nint main(int argc,char**argv) {simdjson::dom::parser parser;simdjson::dom::element tweets = parser.load(argv[1]); }' > tmp.cpp && c++ -Idestination/include -Ldestination/lib -std=c++17 -Wl,-rpath,destination/lib -o linkandrun tmp.cpp -lsimdjson && ./linkandrun jsonexamples/twitter.json && mkdir testfindpackage && cd testfindpackage && echo -e 'cmake_minimum_required(VERSION 3.1)\nproject(simdjsontester)\nset(CMAKE_CXX_STANDARD 17)\nfind_package(simdjson REQUIRED)'> CMakeLists.txt && mkdir build && cd build && cmake -DCMAKE_INSTALL_PREFIX:PATH=../destination .. && cmake --build . simdjson-3.12.3/.github/workflows/ubuntu20-nothread.yml000066400000000000000000000034641477153763300230630ustar00rootroot00000000000000name: Ubuntu 20.04 CI (GCC 9) Without Threads on: [push, pull_request] jobs: ubuntu-build: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') runs-on: ubuntu-20.04 steps: - uses: actions/checkout@v4 - uses: actions/cache@v4 with: path: dependencies/.cache key: ${{ hashFiles('dependencies/CMakeLists.txt') }} - name: Use cmake run: | mkdir builddebug && cd builddebug && cmake -DCMAKE_BUILD_TYPE=Debug -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_ENABLE_THREADS=OFF -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF .. && cmake --build . && ctest --output-on-failure -LE explicitonly -j && cd .. && mkdir build && cd build && cmake -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DSIMDJSON_ENABLE_THREADS=OFF -DBUILD_SHARED_LIBS=OFF -DCMAKE_INSTALL_PREFIX:PATH=destination .. && cmake --build . && ctest --output-on-failure -LE explicitonly -j && make install && echo -e '#include \nint main(int argc,char**argv) {simdjson::dom::parser parser;simdjson::dom::element tweets = parser.load(argv[1]); }' > tmp.cpp && c++ -Idestination/include -Ldestination/lib -std=c++17 -Wl,-rpath,destination/lib -o linkandrun tmp.cpp -lsimdjson && ./linkandrun jsonexamples/twitter.json && mkdir testfindpackage && cd testfindpackage && echo -e 'cmake_minimum_required(VERSION 3.1)\nproject(simdjsontester)\nset(CMAKE_CXX_STANDARD 17)\nfind_package(simdjson REQUIRED)'> CMakeLists.txt && mkdir build && cd build && cmake -DCMAKE_INSTALL_PREFIX:PATH=../destination .. && cmake --build . simdjson-3.12.3/.github/workflows/ubuntu20-sani.yml000066400000000000000000000031721477153763300222050ustar00rootroot00000000000000name: Ubuntu 20.04 CI (GCC 9) With Memory Sanitizer on: [push, pull_request] jobs: ubuntu-build-address-sanitizier: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') runs-on: ubuntu-20.04 steps: - uses: actions/checkout@v4 - uses: actions/cache@v4 with: path: dependencies/.cache key: ${{ hashFiles('dependencies/CMakeLists.txt') }} - name: Use cmake with address sanitizer run: | mkdir builddebug && cd builddebug && cmake -DSIMDJSON_SANITIZE=ON -DCMAKE_BUILD_TYPE=Debug -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF .. && cmake --build . && ctest --output-on-failure -LE explicitonly -j ubuntu-build-undefined-sanitizer: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') runs-on: ubuntu-20.04 steps: - uses: actions/checkout@v4 - uses: actions/cache@v4 with: path: dependencies/.cache key: ${{ hashFiles('dependencies/CMakeLists.txt') }} - name: Use cmake with undefined sanitizer run: | mkdir builddebugundefsani && cd builddebugundefsani && cmake -DSIMDJSON_SANITIZE_UNDEFINED=ON -DCMAKE_BUILD_TYPE=Debug -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF .. && cmake --build . && ctest --output-on-failure -LE explicitonly -j simdjson-3.12.3/.github/workflows/ubuntu20.yml000066400000000000000000000046421477153763300212600ustar00rootroot00000000000000name: Ubuntu 20.04 CI (GCC 9) on: [push, pull_request] jobs: ubuntu-build: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') runs-on: ubuntu-20.04 steps: - uses: actions/checkout@v4 - uses: actions/cache@v4 with: path: dependencies/.cache key: ${{ hashFiles('dependencies/CMakeLists.txt') }} - name: Use cmake to build just the library run: | mkdir buildjustlib && cd buildjustlib && cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=OFF -DSIMDJSON_DEVELOPER_MODE=OFF -DCMAKE_INSTALL_PREFIX:PATH=destination .. && cmake --build . && cmake --install . && echo -e '#include \nint main(int argc,char**argv) {simdjson::dom::parser parser;simdjson::dom::element tweets = parser.load(argv[1]); }' > tmp.cpp && c++ -Idestination/include -Ldestination/lib -std=c++17 -Wl,-rpath,destination/lib -o linkandrun tmp.cpp -lsimdjson && cd ../tests/installation_tests/find && mkdir buildjustlib && cd buildjustlib && cmake -DCMAKE_INSTALL_PREFIX:PATH=../../../buildjustlib/destination .. && cmake --build . - name: Use cmake run: | mkdir builddebug && cd builddebug && cmake -DCMAKE_BUILD_TYPE=Debug -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF .. && cmake --build . && ctest --output-on-failure -LE explicitonly -j && cd .. && mkdir build && cd build && cmake -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF -DCMAKE_INSTALL_PREFIX:PATH=destination .. && cmake --build . && ctest --output-on-failure -LE explicitonly -j && cmake --install . && echo -e '#include \nint main(int argc,char**argv) {simdjson::dom::parser parser;simdjson::dom::element tweets = parser.load(argv[1]); }' > tmp.cpp && c++ -Idestination/include -Ldestination/lib -std=c++17 -Wl,-rpath,destination/lib -o linkandrun tmp.cpp -lsimdjson && ./linkandrun jsonexamples/twitter.json && cd ../tests/installation_tests/find && mkdir build && cd build && cmake -DCMAKE_INSTALL_PREFIX:PATH=../../../build/destination .. && cmake --build . simdjson-3.12.3/.github/workflows/ubuntu22-clang13.yml000066400000000000000000000012661477153763300225070ustar00rootroot00000000000000name: Ubuntu 22.04 CI (CLANG 13) on: [push, pull_request] jobs: ubuntu-build: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v4 - uses: actions/cache@v4 with: path: dependencies/.cache key: ${{ hashFiles('dependencies/CMakeLists.txt') }} - name: Use cmake run: | mkdir build && cd build && CXX=clang++-13 cmake -DSIMDJSON_DEVELOPER_MODE=ON .. && cmake --build . && ctest --output-on-failure -LE explicitonly -jsimdjson-3.12.3/.github/workflows/ubuntu22-clang14.yml000066400000000000000000000012671477153763300225110ustar00rootroot00000000000000name: Ubuntu 22.04 CI (CLANG 14) on: [push, pull_request] jobs: ubuntu-build: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v4 - uses: actions/cache@v4 with: path: dependencies/.cache key: ${{ hashFiles('dependencies/CMakeLists.txt') }} - name: Use cmake run: | mkdir build && cd build && CXX=clang++-14 cmake -DSIMDJSON_DEVELOPER_MODE=ON .. && cmake --build . && ctest --output-on-failure -LE explicitonly -j simdjson-3.12.3/.github/workflows/ubuntu22-cxx20.yml000066400000000000000000000032431477153763300222200ustar00rootroot00000000000000name: Ubuntu 22.04 CI (GCC 12, CXX 20) on: [push, pull_request] jobs: ubuntu-build: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v4 - uses: actions/cache@v4 with: path: dependencies/.cache key: ${{ hashFiles('dependencies/CMakeLists.txt') }} - name: Use cmake run: | mkdir builddebug && cd builddebug && CXX=g++-12 cmake -DSIMDJSON_CXX_STANDARD=20 -DCMAKE_BUILD_TYPE=Debug -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF .. && cmake --build . && ctest --output-on-failure -LE explicitonly -j && cd .. && mkdir build && cd build && CXX=g++-12 cmake -DSIMDJSON_CXX_STANDARD=20 -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF -DCMAKE_INSTALL_PREFIX:PATH=destination .. && cmake --build . && ctest --output-on-failure -LE explicitonly -j && cmake --install . && echo -e '#include \nint main(int argc,char**argv) {simdjson::dom::parser parser;simdjson::dom::element tweets = parser.load(argv[1]); }' > tmp.cpp && c++ -Idestination/include -Ldestination/lib -std=c++17 -Wl,-rpath,destination/lib -o linkandrun tmp.cpp -lsimdjson && ./linkandrun jsonexamples/twitter.json && cd ../tests/installation_tests/find && mkdir build && cd build && cmake -DCMAKE_INSTALL_PREFIX:PATH=../../../build/destination .. && cmake --build . simdjson-3.12.3/.github/workflows/ubuntu22-gcc12.yml000066400000000000000000000012601477153763300221500ustar00rootroot00000000000000name: Ubuntu 22.04 CI (GCC 12) on: [push, pull_request] jobs: ubuntu-build: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v4 - uses: actions/cache@v4 with: path: dependencies/.cache key: ${{ hashFiles('dependencies/CMakeLists.txt') }} - name: Use cmake run: | mkdir build && cd build && CXX=g++-12 cmake -DSIMDJSON_DEVELOPER_MODE=ON .. && cmake --build . && ctest --output-on-failure -LE explicitonly -jsimdjson-3.12.3/.github/workflows/ubuntu22-glibcxxassertions.yml000066400000000000000000000015151477153763300250270ustar00rootroot00000000000000name: Ubuntu 22.04 CI GCC 12 with GLIBCXX_ASSERTIONS on: [push, pull_request] jobs: ubuntu-build: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v4 - uses: actions/cache@v4 with: path: dependencies/.cache key: ${{ hashFiles('dependencies/CMakeLists.txt') }} - name: Install gcc12 run: sudo apt-get install -y g++-12 - name: Use cmake run: | mkdir build && cd build && CXX=g++-12 cmake -DCMAKE_BUILD_TYPE=Debug -DSIMDJSON_GLIBCXX_ASSERTIONS=ON -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_DEVELOPER_MODE=ON .. && cmake --build . && ctest . -E avoid_simdjson-3.12.3/.github/workflows/ubuntu22-threadsani.yml000066400000000000000000000016101477153763300233720ustar00rootroot00000000000000name: Ubuntu 22.04 CI (GCC 12) with Thread Sanitizer on: [push, pull_request] jobs: ubuntu-build: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v4 - uses: actions/cache@v4 with: path: dependencies/.cache key: ${{ hashFiles('dependencies/CMakeLists.txt') }} - name: Use cmake run: | mkdir build && cd build && CXX=g++-12 cmake -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_SANITIZE_THREADS=ON .. && cmake --build . --target document_stream_tests --target ondemand_document_stream_tests --target parse_many_test && ctest --output-on-failure -R parse_many_test && ctest --output-on-failure -R document_stream_testssimdjson-3.12.3/.github/workflows/ubuntu22.yml000066400000000000000000000046431477153763300212630ustar00rootroot00000000000000name: Ubuntu 22.04 CI (GCC 11) on: [push, pull_request] jobs: ubuntu-build: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v4 - uses: actions/cache@v4 with: path: dependencies/.cache key: ${{ hashFiles('dependencies/CMakeLists.txt') }} - name: Use cmake to build just the library run: | mkdir buildjustlib && cd buildjustlib && cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=OFF -DSIMDJSON_DEVELOPER_MODE=OFF -DCMAKE_INSTALL_PREFIX:PATH=destination .. && cmake --build . && cmake --install . && echo -e '#include \nint main(int argc,char**argv) {simdjson::dom::parser parser;simdjson::dom::element tweets = parser.load(argv[1]); }' > tmp.cpp && c++ -Idestination/include -Ldestination/lib -std=c++17 -Wl,-rpath,destination/lib -o linkandrun tmp.cpp -lsimdjson && cd ../tests/installation_tests/find && mkdir buildjustlib && cd buildjustlib && cmake -DCMAKE_INSTALL_PREFIX:PATH=../../../buildjustlib/destination .. && cmake --build . - name: Use cmake run: | mkdir builddebug && cd builddebug && cmake -DCMAKE_BUILD_TYPE=Debug -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF .. && cmake --build . && ctest --output-on-failure -LE explicitonly -j && cd .. && mkdir build && cd build && cmake -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF -DCMAKE_INSTALL_PREFIX:PATH=destination .. && cmake --build . && ctest --output-on-failure -LE explicitonly -j && cmake --install . && echo -e '#include \nint main(int argc,char**argv) {simdjson::dom::parser parser;simdjson::dom::element tweets = parser.load(argv[1]); }' > tmp.cpp && c++ -Idestination/include -Ldestination/lib -std=c++17 -Wl,-rpath,destination/lib -o linkandrun tmp.cpp -lsimdjson && ./linkandrun jsonexamples/twitter.json && cd ../tests/installation_tests/find && mkdir build && cd build && cmake -DCMAKE_INSTALL_PREFIX:PATH=../../../build/destination .. && cmake --build . simdjson-3.12.3/.github/workflows/ubuntu24-cxx20.yml000066400000000000000000000012741477153763300222240ustar00rootroot00000000000000name: Ubuntu 24.04 CI (CXX 20) on: [push, pull_request] jobs: ubuntu-build: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') runs-on: ubuntu-24.04 strategy: matrix: cxx: [g++-13, clang++-16] steps: - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6 - name: Prepare run: cmake -DSIMDJSON_CXX_STANDARD=20 -DSIMDJSON_DEVELOPER_MODE=ON -B build env: CXX: ${{matrix.cxx}} - name: Build run: cmake --build build -j=2 - name: Test run: ctest --output-on-failure --test-dir buildsimdjson-3.12.3/.github/workflows/ubuntu24.yml000066400000000000000000000015771477153763300212700ustar00rootroot00000000000000name: Ubuntu 24.04 CI on: [push, pull_request] jobs: ubuntu-build: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') runs-on: ubuntu-24.04 strategy: matrix: shared: [ON, OFF] cxx: [g++-13, clang++-16] sanitizer: [ON, OFF] build_type: [RelWithDebInfo, Debug, Release] steps: - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6 - name: Prepare run: cmake -DCMAKE_BUILD_TYPE=${{matrix.build_type}} -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_SANITIZE=${{matrix.sanitizer}} -DBUILD_SHARED_LIBS=${{matrix.shared}} -B build env: CXX: ${{matrix.cxx}} - name: Build run: cmake --build build -j=2 - name: Test run: ctest --output-on-failure --test-dir buildsimdjson-3.12.3/.github/workflows/vs17-arm-ci.yml000066400000000000000000000011241477153763300215320ustar00rootroot00000000000000name: VS17-ARM-CI on: [push, pull_request] jobs: ci: name: windows-vs17 runs-on: windows-latest strategy: fail-fast: false matrix: include: - {arch: ARM64} - {arch: ARM64EC} steps: - name: checkout uses: actions/checkout@v4 - name: Use cmake run: | cmake -A ${{ matrix.arch }} -DCMAKE_SYSTEM_VERSION="10.0.22621.0" -DCMAKE_CROSSCOMPILING=1 -DSIMDJSON_DEVELOPER_MODE=ON -D SIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_EXCEPTIONS=OFF -B build && cmake --build build --verbose simdjson-3.12.3/.github/workflows/vs17-ci-cxx20.yml000066400000000000000000000030531477153763300217220ustar00rootroot00000000000000name: VS17-CI CXX20 on: [push, pull_request] jobs: ci: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') name: windows-vs17 runs-on: windows-latest strategy: fail-fast: false matrix: include: - {gen: Visual Studio 17 2022, arch: Win32, shared: ON} - {gen: Visual Studio 17 2022, arch: Win32, shared: OFF} - {gen: Visual Studio 17 2022, arch: x64, shared: ON} - {gen: Visual Studio 17 2022, arch: x64, shared: OFF} steps: - name: checkout uses: actions/checkout@v4 - name: Configure run: | cmake -DSIMDJSON_CXX_STANDARD=20 -G "${{matrix.gen}}" -A ${{matrix.arch}} -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_COMPETITION=OFF -DBUILD_SHARED_LIBS=${{matrix.shared}} -B build - name: Build Debug run: cmake --build build --config Debug --verbose - name: Build Release run: cmake --build build --config Release --verbose - name: Run Release tests run: | cd build ctest -C Release -LE explicitonly --output-on-failure - name: Run Debug tests run: | cd build ctest -C Debug -LE explicitonly --output-on-failure - name: Install run: | cmake --install build --config Release - name: Test Installation run: | cmake -G "${{matrix.gen}}" -A ${{matrix.arch}} -B build_install_test tests/installation_tests/find cmake --build build_install_test --config Releasesimdjson-3.12.3/.github/workflows/vs17-ci.yml000066400000000000000000000031711477153763300207610ustar00rootroot00000000000000name: VS17-CI on: [push, pull_request] jobs: ci: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') name: windows-vs17 runs-on: windows-latest strategy: fail-fast: false matrix: include: - {gen: Visual Studio 17 2022, arch: Win32, shared: ON, build_type: Release} - {gen: Visual Studio 17 2022, arch: Win32, shared: OFF, build_type: Release} - {gen: Visual Studio 17 2022, arch: x64, shared: ON, build_type: Release} - {gen: Visual Studio 17 2022, arch: x64, shared: OFF, build_type: Debug} - {gen: Visual Studio 17 2022, arch: x64, shared: OFF, build_type: Release} - {gen: Visual Studio 17 2022, arch: x64, shared: OFF, build_type: RelWithDebInfo} steps: - name: checkout uses: actions/checkout@v4 - name: Configure run: | cmake -G "${{matrix.gen}}" -A ${{matrix.arch}} -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_COMPETITION=OFF -DBUILD_SHARED_LIBS=${{matrix.shared}} -B build - name: Build Debug run: cmake --build build --config ${{matrix.build_type}} --verbose - name: Run tests run: | cd build ctest -C ${{matrix.build_type}} -LE explicitonly --output-on-failure - name: Install run: | cmake --install build --config ${{matrix.build_type}} - name: Test Installation run: | cmake -G "${{matrix.gen}}" -A ${{matrix.arch}} -B build_install_test tests/installation_tests/find cmake --build build_install_test --config ${{matrix.build_type}}simdjson-3.12.3/.github/workflows/vs17-clang-ci-cxx20.yml000066400000000000000000000024631477153763300230100ustar00rootroot00000000000000name: VS17-CLANG-CI on: [push, pull_request] jobs: ci: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') name: windows-vs17 runs-on: windows-latest strategy: fail-fast: false matrix: include: - {gen: Visual Studio 17 2022, arch: x64, build_type: Debug} - {gen: Visual Studio 17 2022, arch: x64, build_type: Release} - {gen: Visual Studio 17 2022, arch: x64, build_type: RelWithDebInfo} steps: - name: checkout uses: actions/checkout@v4 - name: Configure run: | cmake -G "${{matrix.gen}}" -A ${{matrix.arch}} -T ClangCL -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_COMPETITION=OFF -B build - name: Build run: cmake --build build --config ${{matrix.build_type}} --verbose - name: Run tests run: | cd build ctest -C ${{matrix.build_type}} -LE explicitonly --output-on-failure - name: Install run: | cmake --install build --config ${{matrix.build_type}} - name: Test Installation run: | cmake -G "${{matrix.gen}}" -A ${{matrix.arch}} -B build_install_test tests/installation_tests/find cmake --build build_install_test --config ${{matrix.build_type}}simdjson-3.12.3/.github/workflows/vs17-clang-ci.yml000066400000000000000000000024631477153763300220460ustar00rootroot00000000000000name: VS17-CLANG-CI on: [push, pull_request] jobs: ci: if: >- ! contains(toJSON(github.event.commits.*.message), '[skip ci]') && ! contains(toJSON(github.event.commits.*.message), '[skip github]') name: windows-vs17 runs-on: windows-latest strategy: fail-fast: false matrix: include: - {gen: Visual Studio 17 2022, arch: x64, build_type: Debug} - {gen: Visual Studio 17 2022, arch: x64, build_type: Release} - {gen: Visual Studio 17 2022, arch: x64, build_type: RelWithDebInfo} steps: - name: checkout uses: actions/checkout@v4 - name: Configure run: | cmake -G "${{matrix.gen}}" -A ${{matrix.arch}} -T ClangCL -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_COMPETITION=OFF -B build - name: Build run: cmake --build build --config ${{matrix.build_type}} --verbose - name: Run tests run: | cd build ctest -C ${{matrix.build_type}} -LE explicitonly --output-on-failure - name: Install run: | cmake --install build --config ${{matrix.build_type}} - name: Test Installation run: | cmake -G "${{matrix.gen}}" -A ${{matrix.arch}} -B build_install_test tests/installation_tests/find cmake --build build_install_test --config ${{matrix.build_type}}simdjson-3.12.3/.github/workflows/vs17-noexcept-ci.yml000066400000000000000000000017211477153763300226030ustar00rootroot00000000000000name: VS17-NoExcept-CI on: [push, pull_request] jobs: ci: name: windows-vs17 runs-on: windows-latest steps: - uses: actions/checkout@v4 - uses: actions/cache@v4 with: path: dependencies/.cache key: ${{ hashFiles('dependencies/CMakeLists.txt') }} - name: 'Run CMake with VS17' uses: lukka/run-cmake@v3 with: cmakeListsOrSettingsJson: CMakeListsTxtAdvanced cmakeListsTxtPath: '${{ github.workspace }}/CMakeLists.txt' buildDirectory: "${{ github.workspace }}/../../_temp/windows" cmakeBuildType: Release buildWithCMake: true cmakeGenerator: VS16Win64 cmakeAppendedArgs: -DSIMDJSON_COMPETITION=OFF -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_EXCEPTIONS=OFF buildWithCMakeArgs: --config Release - name: 'Run CTest' run: ctest -C Release -LE explicitonly --output-on-failure working-directory: "${{ github.workspace }}/../../_temp/windows" simdjson-3.12.3/.travis.yml000066400000000000000000000114321477153763300155600ustar00rootroot00000000000000language: cpp dist: bionic arch: - ppc64le cache: directories: - $HOME/.dep_cache env: global: - simdjson_DEPENDENCY_CACHE_DIR=$HOME/.dep_cache matrix: include: - os: linux addons: apt: sources: - ubuntu-toolchain-r-test packages: - g++-8 env: - COMPILER="CC=gcc-8 && CXX=g++-8" compiler: gcc-8 - os: linux addons: apt: sources: - ubuntu-toolchain-r-test packages: - g++-9 env: - COMPILER="CC=gcc-9 && CXX=g++-9" compiler: gcc-9 - os: linux addons: apt: sources: - ubuntu-toolchain-r-test packages: - g++-10 env: - COMPILER="CC=gcc-10 && CXX=g++-10" compiler: gcc-10 # The sanitizer runs fail systematically # - os: linux # addons: # apt: # sources: # - ubuntu-toolchain-r-test # packages: # - g++-10 # env: # - COMPILER="CC=gcc-10 && CXX=g++-10" # - SANITIZE="on" # compiler: gcc-10-sanitize - os: linux addons: apt: sources: - ubuntu-toolchain-r-test packages: - g++-10 env: - COMPILER="CC=gcc-10 && CXX=g++-10" - STATIC="on" compiler: gcc-10-static - os: linux addons: apt: sources: - llvm-toolchain-bionic-6.0 packages: - clang-6.0 env: - COMPILER="CC=clang-6.0 && CXX=clang++-6.0" compiler: clang-6 - os: linux addons: apt: sources: - llvm-toolchain-bionic-7 packages: - clang-7 env: - COMPILER="CC=clang-7 && CXX=clang++-7" compiler: clang-7 - os: linux addons: apt: sources: - llvm-toolchain-bionic-8 packages: - clang-8 env: - COMPILER="CC=clang-8 && CXX=clang++-8" compiler: clang-8 - os: linux addons: apt: sources: - llvm-toolchain-bionic-9 packages: - clang-9 env: - COMPILER="CC=clang-9 && CXX=clang++-9" compiler: clang-9 - os: linux addons: apt: packages: - clang-10 sources: - ubuntu-toolchain-r-test - sourceline: 'deb http://apt.llvm.org/bionic/ llvm-toolchain-bionic-10 main' key_url: 'https://apt.llvm.org/llvm-snapshot.gpg.key' env: - COMPILER="CC=clang-10 && CXX=clang++-10" compiler: clang-10 - os: linux addons: apt: packages: - clang-10 sources: - ubuntu-toolchain-r-test - sourceline: 'deb http://apt.llvm.org/bionic/ llvm-toolchain-bionic-10 main' key_url: 'https://apt.llvm.org/llvm-snapshot.gpg.key' env: - COMPILER="CC=clang-10 && CXX=clang++-10" - STATIC="on" compiler: clang-10-static # The clang sanitizer runs fail frequently at setup time # - os: linux # addons: # apt: # packages: # - clang-10 # sources: # - ubuntu-toolchain-r-test # - sourceline: 'deb http://apt.llvm.org/bionic/ llvm-toolchain-bionic-10 main' # key_url: 'https://apt.llvm.org/llvm-snapshot.gpg.key' # env: # - COMPILER="CC=clang-10 && CXX=clang++-10" # - SANITIZE="on" # compiler: clang-10-sanitize before_install: - eval "${COMPILER}" install: - wget -q -O - "https://raw.githubusercontent.com/simdjson/debian-ppa/master/key.gpg" | sudo apt-key add - - sudo apt-add-repository "deb https://raw.githubusercontent.com/simdjson/debian-ppa/master simdjson main" - sudo apt-get -qq update - sudo apt-get purge cmake cmake-data - sudo apt-get -t simdjson -y install cmake - export CMAKE_CXX_FLAGS="-maltivec -mcpu=power9 -mtune=power9" - export CMAKE_C_FLAGS="${CMAKE_CXX_FLAGS}" - export CMAKE_FLAGS="-DCMAKE_CXX_FLAGS=${CMAKE_CXX_FLAGS} -DCMAKE_C_FLAGS=${CMAKE_C_FLAGS} -DSIMDJSON_IMPLEMENTATION=ppc64;fallback"; - if [[ "${SANITIZE}" == "on" ]]; then export CMAKE_FLAGS="${CMAKE_FLAGS} -DSIMDJSON_SANITIZE=ON"; export ASAN_OPTIONS="detect_leaks=0"; fi - if [[ "${STATIC}" == "on" ]]; then export CMAKE_FLAGS="${CMAKE_FLAGS} -DBUILD_SHARED_LIBS=OFF"; fi - export CTEST_FLAGS="-j4 --output-on-failure -LE explicitonly" script: - mkdir build - cd build - cmake $CMAKE_FLAGS .. - cmake --build . -- -j2 - SIMDJSON_FORCE_IMPLEMENTATION=ppc64 ctest $CTEST_FLAGS -L per_implementation - SIMDJSON_FORCE_IMPLEMENTATION=fallback ctest $CTEST_FLAGS -L per_implementation - ctest $CTEST_FLAGS -LE "acceptance|per_implementation" simdjson-3.12.3/.vscode/000077500000000000000000000000001477153763300150075ustar00rootroot00000000000000simdjson-3.12.3/.vscode/extensions.json000066400000000000000000000011751477153763300201050ustar00rootroot00000000000000{ // See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations. // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp // List of extensions which should be recommended for users of this workspace. "recommendations": [ // C++ "llvm-vs-code-extensions.vscode-clangd", "xaver.clang-format", // Python "ms-python.python", // .github/* "github.vscode-github-actions", // cmake "ms-vscode.cmake-tools", "twxs.cmake" ], // List of extensions recommended by VS Code that should not be recommended for users of this workspace. "unwantedRecommendations": [ ] }simdjson-3.12.3/.vscode/settings.json000066400000000000000000000065631477153763300175540ustar00rootroot00000000000000{ "editor.rulers": [ {"column": 95 }, {"column": 120 } ], "files.trimTrailingWhitespace": true, "files.associations": { ".clangd": "yaml", "array": "cpp", "iterator": "cpp", "chrono": "cpp", "optional": "cpp", "__locale": "cpp", "__tuple": "cpp", "__bit_reference": "cpp", "__config": "cpp", "__debug": "cpp", "__errc": "cpp", "__functional_base": "cpp", "__hash_table": "cpp", "__mutex_base": "cpp", "__node_handle": "cpp", "__nullptr": "cpp", "__split_buffer": "cpp", "__string": "cpp", "__threading_support": "cpp", "__tree": "cpp", "algorithm": "cpp", "atomic": "cpp", "bit": "cpp", "bitset": "cpp", "cctype": "cpp", "cinttypes": "cpp", "clocale": "cpp", "cmath": "cpp", "codecvt": "cpp", "complex": "cpp", "condition_variable": "cpp", "cstdarg": "cpp", "cstddef": "cpp", "cstdint": "cpp", "cstdio": "cpp", "cstdlib": "cpp", "cstring": "cpp", "ctime": "cpp", "cwchar": "cpp", "cwctype": "cpp", "deque": "cpp", "exception": "cpp", "forward_list": "cpp", "fstream": "cpp", "functional": "cpp", "initializer_list": "cpp", "iomanip": "cpp", "ios": "cpp", "iosfwd": "cpp", "iostream": "cpp", "istream": "cpp", "limits": "cpp", "list": "cpp", "locale": "cpp", "map": "cpp", "memory": "cpp", "mutex": "cpp", "new": "cpp", "numeric": "cpp", "ostream": "cpp", "random": "cpp", "ratio": "cpp", "regex": "cpp", "set": "cpp", "sstream": "cpp", "stack": "cpp", "stdexcept": "cpp", "streambuf": "cpp", "string": "cpp", "string_view": "cpp", "system_error": "cpp", "thread": "cpp", "tuple": "cpp", "type_traits": "cpp", "typeinfo": "cpp", "unordered_map": "cpp", "unordered_set": "cpp", "utility": "cpp", "valarray": "cpp", "vector": "cpp", "*.ipp": "cpp", "__functional_base_03": "cpp", "filesystem": "cpp", "*.inc": "cpp", "compare": "cpp", "concepts": "cpp", "variant": "cpp", "__bits": "cpp", "csignal": "cpp", "future": "cpp", "queue": "cpp", "shared_mutex": "cpp", "ranges": "cpp", "span": "cpp", "__verbose_abort": "cpp", "charconv": "cpp", "source_location": "cpp", "strstream": "cpp", "typeindex": "cpp", "*.tcc": "cpp", "memory_resource": "cpp", "numbers": "cpp", "semaphore": "cpp", "stop_token": "cpp", "cfenv": "cpp", "format": "cpp", "xlocmes": "cpp", "xlocmon": "cpp", "xlocnum": "cpp", "xloctime": "cpp", "xutility": "cpp", "coroutine": "cpp", "xfacet": "cpp", "xhash": "cpp", "xiosbase": "cpp", "xlocale": "cpp", "xlocbuf": "cpp", "xlocinfo": "cpp", "xmemory": "cpp", "xstring": "cpp", "xtr1common": "cpp", "xtree": "cpp" } }simdjson-3.12.3/AUTHORS000066400000000000000000000001521477153763300145140ustar00rootroot00000000000000# List of authors for copyright purposes, in no particular order Daniel Lemire Geoff Langdale John Keiser simdjson-3.12.3/CMakeLists.txt000066400000000000000000000260521477153763300162130ustar00rootroot00000000000000cmake_minimum_required(VERSION 3.14) project( simdjson # The version number is modified by tools/release.py VERSION 3.12.3 DESCRIPTION "Parsing gigabytes of JSON per second" HOMEPAGE_URL "https://simdjson.org/" LANGUAGES CXX C ) set(SIMDJSON_GITHUB_REPOSITORY "https://github.com/simdjson/simdjson") string( COMPARE EQUAL "${CMAKE_SOURCE_DIR}" "${CMAKE_CURRENT_SOURCE_DIR}" is_top_project ) # ---- Options, variables ---- # These version numbers are modified by tools/release.py set(SIMDJSON_LIB_VERSION "25.0.0" CACHE STRING "simdjson library version") set(SIMDJSON_LIB_SOVERSION "25" CACHE STRING "simdjson library soversion") option(SIMDJSON_BUILD_STATIC_LIB "Build simdjson_static library along with simdjson (only makes sense if BUILD_SHARED_LIBS=ON)" OFF) if(SIMDJSON_BUILD_STATIC_LIB AND NOT BUILD_SHARED_LIBS) message(WARNING "SIMDJSON_BUILD_STATIC_LIB only makes sense if BUILD_SHARED_LIBS is set to ON") message(WARNING "You might be building and installing a two identical static libraries.") endif() option(SIMDJSON_ENABLE_THREADS "Link with thread support" ON) include(cmake/simdjson-props.cmake) include(cmake/implementation-flags.cmake) include(cmake/exception-flags.cmake) option(SIMDJSON_DISABLE_DEPRECATED_API "Disables deprecated APIs" OFF) if(SIMDJSON_DISABLE_DEPRECATED_API) simdjson_add_props( target_compile_definitions PUBLIC SIMDJSON_DISABLE_DEPRECATED_API=1 ) endif() option(SIMDJSON_DEVELOPMENT_CHECKS "Enable development-time aids, such as \ checks for incorrect API usage. Enabled by default in DEBUG." OFF) if(SIMDJSON_DEVELOPMENT_CHECKS) simdjson_add_props( target_compile_definitions PUBLIC SIMDJSON_DEVELOPMENT_CHECKS ) endif() if(is_top_project) option(SIMDJSON_DEVELOPER_MODE "Enable targets for developing simdjson" OFF) option(BUILD_SHARED_LIBS "Build simdjson as a shared library" OFF) option(SIMDJSON_SINGLEHEADER "Disable singleheader generation" ON) endif() include(cmake/handle-deprecations.cmake) include(cmake/developer-options.cmake) # ---- simdjson library ---- set(SIMDJSON_SOURCES src/simdjson.cpp) add_library(simdjson ${SIMDJSON_SOURCES}) add_library(simdjson::simdjson ALIAS simdjson) set(SIMDJSON_LIBRARIES simdjson) if(SIMDJSON_BUILD_STATIC_LIB) add_library(simdjson_static STATIC ${SIMDJSON_SOURCES}) add_library(simdjson::simdjson_static ALIAS simdjson_static) list(APPEND SIMDJSON_LIBRARIES simdjson_static) endif() set_target_properties( simdjson PROPERTIES VERSION "${SIMDJSON_LIB_VERSION}" SOVERSION "${SIMDJSON_LIB_SOVERSION}" # FIXME: symbols should be hidden by default WINDOWS_EXPORT_ALL_SYMBOLS YES ) # FIXME: Use proper CMake integration for exports if(MSVC AND BUILD_SHARED_LIBS) target_compile_definitions( simdjson PRIVATE SIMDJSON_BUILDING_WINDOWS_DYNAMIC_LIBRARY=1 INTERFACE SIMDJSON_USING_WINDOWS_DYNAMIC_LIBRARY=1 ) endif() simdjson_add_props( target_include_directories PUBLIC "$" PRIVATE "$" ) simdjson_add_props(target_compile_features PUBLIC cxx_std_11) # workaround for GNU GCC poor AVX load/store code generation if( CMAKE_CXX_COMPILER_ID STREQUAL "GNU" AND CMAKE_SYSTEM_PROCESSOR MATCHES "^(i.86|x86(_64)?)$" ) simdjson_add_props( target_compile_options PRIVATE -mno-avx256-split-unaligned-load -mno-avx256-split-unaligned-store ) endif() if(CMAKE_SYSTEM_PROCESSOR MATCHES "^(loongarch64)$") option(SIMDJSON_PREFER_LSX "Prefer LoongArch SX" ON) include(CheckCXXCompilerFlag) check_cxx_compiler_flag(-mlasx COMPILER_SUPPORTS_LASX) check_cxx_compiler_flag(-mlsx COMPILER_SUPPORTS_LSX) if(COMPILER_SUPPORTS_LASX AND NOT SIMDJSON_PREFER_LSX) simdjson_add_props( target_compile_options PRIVATE -mlasx ) elseif(COMPILER_SUPPORTS_LSX) simdjson_add_props( target_compile_options PRIVATE -mlsx ) endif() endif() # GCC and Clang have horrendous Debug builds when using SIMD. # A common fix is to use '-Og' instead. # bug https://gcc.gnu.org/bugzilla/show_bug.cgi?id=54412 if( (CMAKE_CXX_COMPILER_ID STREQUAL "GNU" OR CMAKE_CXX_COMPILER_ID STREQUAL "Clang" OR CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang") ) message(STATUS "Adding -Og to compile flag") simdjson_add_props( target_compile_options PRIVATE $<$:-Og> ) endif() if(SIMDJSON_ENABLE_THREADS) find_package(Threads REQUIRED) simdjson_add_props(target_link_libraries PUBLIC Threads::Threads) simdjson_add_props(target_compile_definitions PUBLIC SIMDJSON_THREADS_ENABLED=1) endif() simdjson_apply_props(simdjson) if(SIMDJSON_BUILD_STATIC_LIB) simdjson_apply_props(simdjson_static) endif() # ---- Install rules ---- include(CMakePackageConfigHelpers) include(GNUInstallDirs) if(SIMDJSON_SINGLEHEADER) install( FILES singleheader/simdjson.h DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}" COMPONENT simdjson_Development ) endif() install( TARGETS simdjson EXPORT simdjsonTargets RUNTIME COMPONENT simdjson_Runtime LIBRARY COMPONENT simdjson_Runtime NAMELINK_COMPONENT simdjson_Development ARCHIVE COMPONENT simdjson_Development INCLUDES DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}" ) configure_file(cmake/simdjson-config.cmake.in simdjson-config.cmake @ONLY) write_basic_package_version_file( simdjson-config-version.cmake COMPATIBILITY SameMinorVersion ) set( SIMDJSON_INSTALL_CMAKEDIR "${CMAKE_INSTALL_LIBDIR}/cmake/simdjson" CACHE STRING "CMake package config location relative to the install prefix" ) mark_as_advanced(SIMDJSON_INSTALL_CMAKEDIR) install( FILES "${PROJECT_BINARY_DIR}/simdjson-config.cmake" "${PROJECT_BINARY_DIR}/simdjson-config-version.cmake" DESTINATION "${SIMDJSON_INSTALL_CMAKEDIR}" COMPONENT simdjson_Development ) install( EXPORT simdjsonTargets NAMESPACE simdjson:: DESTINATION "${SIMDJSON_INSTALL_CMAKEDIR}" COMPONENT simdjson_Development ) if(SIMDJSON_BUILD_STATIC_LIB) install( TARGETS simdjson_static EXPORT simdjson_staticTargets ARCHIVE COMPONENT simdjson_Development INCLUDES DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}" ) install( EXPORT simdjson_staticTargets NAMESPACE simdjson:: DESTINATION "${SIMDJSON_INSTALL_CMAKEDIR}" COMPONENT simdjson_Development ) endif() # pkg-config include(cmake/JoinPaths.cmake) join_paths(PKGCONFIG_INCLUDEDIR "\${prefix}" "${CMAKE_INSTALL_INCLUDEDIR}") join_paths(PKGCONFIG_LIBDIR "\${prefix}" "${CMAKE_INSTALL_LIBDIR}") if(SIMDJSON_ENABLE_THREADS) set(PKGCONFIG_CFLAGS "-DSIMDJSON_THREADS_ENABLED=1") if(CMAKE_THREAD_LIBS_INIT) set(PKGCONFIG_LIBS_PRIVATE "Libs.private: ${CMAKE_THREAD_LIBS_INIT}") endif() endif() configure_file("simdjson.pc.in" "simdjson.pc" @ONLY) install( FILES "${CMAKE_CURRENT_BINARY_DIR}/simdjson.pc" DESTINATION "${CMAKE_INSTALL_LIBDIR}/pkgconfig" ) # # CPack # if(is_top_project) set(CPACK_PACKAGE_VENDOR "Daniel Lemire") set(CPACK_PACKAGE_CONTACT "lemire@gmail.com") set(CPACK_RESOURCE_FILE_LICENSE "${PROJECT_SOURCE_DIR}/LICENSE") set(CPACK_RESOURCE_FILE_README "${PROJECT_SOURCE_DIR}/README.md") set(CPACK_RPM_PACKAGE_LICENSE "${PROJECT_SOURCE_DIR}/LICENSE") set(CPACK_SOURCE_GENERATOR "TGZ;ZIP") include(CPack) endif() # ---- Developer mode extras ---- if(is_top_project AND NOT SIMDJSON_DEVELOPER_MODE) message(STATUS "Building only the library. Advanced users and contributors may want to turn SIMDJSON_DEVELOPER_MODE to ON, e.g., via -D SIMDJSON_DEVELOPER_MODE=ON.") elseif(SIMDJSON_DEVELOPER_MODE AND NOT is_top_project) message(AUTHOR_WARNING "Developer mode in simdjson is intended for the developers of simdjson") endif() if(NOT SIMDJSON_DEVELOPER_MODE) return() endif() simdjson_apply_props(simdjson-internal-flags) set( SIMDJSON_USER_CMAKECACHE "${CMAKE_BINARY_DIR}/.simdjson-user-CMakeCache.txt" ) add_custom_target( simdjson-user-cmakecache COMMAND "${CMAKE_COMMAND}" -D "BINARY_DIR=${CMAKE_BINARY_DIR}" -D "USER_CMAKECACHE=${SIMDJSON_USER_CMAKECACHE}" -P "${PROJECT_SOURCE_DIR}/cmake/simdjson-user-cmakecache.cmake" VERBATIM ) # Setup tests enable_testing() # So we can build just tests with "make all_tests" add_custom_target(all_tests) add_subdirectory(windows) include(cmake/CPM.cmake) add_subdirectory(dependencies) ## This needs to be before tools because of cxxopts add_subdirectory(tools) ## This needs to be before tests because of cxxopts # Data: jsonexamples is left with only the bare essential. # most of the data has been moved to https://github.com/simdjson/simdjson-data add_subdirectory(jsonexamples) if(SIMDJSON_SINGLEHEADER) add_subdirectory(singleheader) endif() # # Compile tools / tests / benchmarks # add_subdirectory(tests) add_subdirectory(examples) if(CMAKE_SIZEOF_VOID_P EQUAL 8) # we only include the benchmarks on 64-bit systems. add_subdirectory(benchmark) endif() add_subdirectory(fuzz) # # Source files should be just ASCII # find_program(FIND find) find_program(FILE file) find_program(GREP grep) if(FIND AND FILE AND GREP) add_test( NAME just_ascii COMMAND sh -c "\ ${FIND} include src windows tools singleheader tests examples benchmark \ -path benchmark/checkperf-reference -prune -name '*.h' -o -name '*.cpp' \ -type f -exec ${FILE} '{}' \; | ${GREP} -qv ASCII || exit 0 && exit 1" WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}" ) endif() ## ## In systems like R, libraries must not use stderr or abort to be acceptable. ## Thus we make it a hard rule that one is not allowed to call abort or stderr. ## The sanitized builds are allowed to abort. ## if(NOT SIMDJSON_SANITIZE) find_program(GREP grep) find_program(NM nm) if((NOT GREP) OR (NOT NM)) message("grep and nm are unavailable on this system.") else() add_test( NAME "avoid_abort" # Under FreeBSD, the __cxa_guard_abort symbol may appear but it is fine. # So we want to look for abort as a test. COMMAND sh -c "${NM} $ | ${GREP} ' _*abort' || exit 0 && exit 1" WORKING_DIRECTORY ${PROJECT_BINARY_DIR} ) add_test( NAME "avoid_cout" COMMAND sh -c "${NM} $ | ${GREP} ' _*cout' || exit 0 && exit 1" WORKING_DIRECTORY ${PROJECT_BINARY_DIR} ) add_test( NAME "avoid_cerr" COMMAND sh -c "${NM} $ | ${GREP} ' _*cerr' || exit 0 && exit 1" WORKING_DIRECTORY ${PROJECT_BINARY_DIR} ) add_test( NAME "avoid_printf" COMMAND sh -c "${NM} $ | ${GREP} ' _*printf' || exit 0 && exit 1" WORKING_DIRECTORY ${PROJECT_BINARY_DIR} ) add_test( NAME "avoid_stdout" COMMAND sh -c "${NM} $ | ${GREP} stdout || exit 0 && exit 1" WORKING_DIRECTORY ${PROJECT_BINARY_DIR} ) add_test( NAME "avoid_stderr" COMMAND sh -c "${NM} $ | ${GREP} stderr || exit 0 && exit 1" WORKING_DIRECTORY ${PROJECT_BINARY_DIR} ) endif() endif() simdjson-3.12.3/CONTRIBUTING.md000066400000000000000000000171441477153763300157060ustar00rootroot00000000000000Contributing ============ The simdjson library is an open project written in C++. Contributions are invited. Contributors agree to the project's license. We have an extensive list of issues, and contributions toward any of these issues is invited. Contributions can take the form of code samples, better documentation or design ideas. In particular, the following contributions are invited: - The library is focused on performance. Well-documented performance optimization are invited. - Fixes to known or newly discovered bugs are always welcome. Typically, a bug fix should come with a test demonstrating that the bug has been fixed. - The simdjson library is advanced software and maintainability and flexibility are always a concern. Specific contributions to improve maintainability and flexibility are invited. We discourage the following types of contributions: - Code refactoring. We all have our preferences as to how code should be written, but unnecessary refactoring can waste time and introduce new bugs. If you believe that refactoring is needed, you first must explain how it helps in concrete terms. Does it improve the performance? - Applications of new language features for their own sake. Using advanced C++ language constructs is actually a negative as it may reduce portability (to old compilers, old standard libraries and systems) and reduce accessibility (to programmers that have not kept up), so it must be offsetted by clear gains like performance or maintainability. When in doubt, avoid advanced C++ features (beyond C++11). - Style formatting. In general, please abstain from reformatting code just to make it look prettier. Though code formatting is important, it can also be a waste of time if several contributors try to tweak the code base toward their own preference. Please do not introduce unneeded white-space changes. In short, most code changes should either bring new features or better performance. We want to avoid unmotivated code changes. Specific rules ---------- We have few hard rules, but we have some: - Printing to standard output or standard error (`stderr`, `stdout`, `std::cerr`, `std::cout`) in the core library is forbidden. This follows from the [Writing R Extensions](https://cran.r-project.org/doc/manuals/R-exts.html) manual which states that "Compiled code should not write to stdout or stderr". - Calls to `abort()` are forbidden in the core library. This follows from the [Writing R Extensions](https://cran.r-project.org/doc/manuals/R-exts.html) manual which states that "Under no circumstances should your compiled code ever call abort or exit". - All source code files (.h, .cpp) must be ASCII. - All C macros introduced in public headers need to be prefixed with either `SIMDJSON_` or `simdjson_`. - We avoid trailing white space characters within lines. That is, your lines of code should not terminate with unnecessary spaces. Generally, please avoid making unnecessary changes to white-space characters when contributing code. Tools, tests and benchmarks are not held to these same strict rules. General Guidelines ---------- Contributors are encouraged to : - Document their changes. Though we do not enforce a rule regarding code comments, we prefer that non-trivial algorithms and techniques be somewhat documented in the code. - Follow as much as possible the existing code style. We do not enforce a specific code style, but we prefer consistency. We avoid contractions (isn't, aren't) in the comments. - Modify as few lines of code as possible when working on an issue. The more lines you modify, the harder it is for your fellow human beings to understand what is going on. - Tools may report "problems" with the code, but we never delegate programming to tools: if there is a problem with the code, we need to understand it. Thus we will not "fix" code merely to please a static analyzer. - Provide tests for any new feature. We will not merge a new feature without tests. - Run before/after benchmarks so that we can appreciate the effect of the changes on the performance. Pull Requests -------------- Pull requests are always invited. However, we ask that you follow these guidelines: - It is wise to discuss your ideas first as part of an issue before you start coding. If you omit this step and code first, be prepared to have your code receive scrutiny and be dropped. - Users should provide a rationale for their changes. Does it improve performance? Does it add a feature? Does it improve maintainability? Does it fix a bug? This must be explicitly stated as part of the pull request. Do not propose changes based on taste or intuition. We do not delegate programming to tools: that some tool suggested a code change is not reason enough to change the code. 1. When your code improves performance, please document the gains with a benchmark using hard numbers. 2. If your code fixes a bug, please either fix a failing test, or propose a new test. 3. Other types of changes must be clearly motivated. We openly discourage changes with no identifiable benefits. - Changes should be focused and minimal. You should change as few lines of code as possible. Please do not reformat or touch files needlessly. - New features must be accompanied by new tests, in general. - Your code should pass our continuous-integration tests. It is your responsibility to ensure that your proposal pass the tests. We do not merge pull requests that would break our build. - An exception to this would be changes to non-code files, such as documentation and assets, or trivial changes to code, such as comments, where it is encouraged to explicitly ask for skipping a CI run using the `[skip ci]` prefix in your Pull Request title **and** in the first line of the most recent commit in a push. Example for such a commit: `[skip ci] Fixed typo in power_of_ten's docs` This benefits the project in such a way that the CI pipeline is not burdened by running jobs on changes that don't change any behavior in the code, which reduces wait times for other Pull Requests that do change behavior and require testing. If the benefits of your proposed code remain unclear, we may choose to discard your code: that is not an insult, we frequently discard our own code. We may also consider various alternatives and choose another path. Again, that is not an insult or a sign that you have wasted your time. Style ----- Our formatting style is inspired by the LLVM style. The simdjson library is written using the snake case: when a variable or a function is a phrase, each space is replaced by an underscore character, and the first letter of each word written in lowercase. Compile-time constants are written entirely in uppercase with the same underscore convention. Code of Conduct --------------- Though we do not have a formal code of conduct, we will not tolerate bullying, bigotry or intimidation. Everyone is welcome to contribute. If you have concerns, you can raise them privately with the core team members (e.g., D. Lemire, J. Keiser). We welcome contributions from women and less represented groups. If you need help, please reach out. Consider the following points when engaging with the project: - We discourage arguments from authority: ideas are discussed on their own merits and not based on who stated it. - Be mindful that what you may view as an aggression is maybe merely a difference of opinion or a misunderstanding. - Be mindful that a collection of small aggressions, even if mild in isolation, can become harmful. Getting Started Hacking ----------------------- An overview of simdjson's directory structure, with pointers to architecture and design considerations and other helpful notes, can be found at [HACKING.md](HACKING.md). simdjson-3.12.3/CONTRIBUTORS000066400000000000000000000014451477153763300153320ustar00rootroot00000000000000# contributors (in no particular order) Thomas Navennec Kai Wolf Tyler Kennedy Frank Wessels George Fotopoulos Heinz N. Gies Emil Gedda Wojciech Muła Georgios Floros Dong Xie Nan Xiao Egor Bogatov Jinxi Wang Luiz Fernando Peres Wouter Bolsterlee Anish Karandikar Reini Urban Tom Dyson Ihor Dotsenko Alexey Milovidov Chang Liu Sunny Gleason John Keiser Zach Bjornson Vitaly Baranov Juho Lauri Michael Eisel Io Daza Dillon Paul Dreik Jeremie Piotte Matthew Wilson Dušan Jovanović Matjaž Ostroveršnik Nong Li Furkan Taşkale Brendan Knapp Danila Kutenin Pavel Pavlov Hao Chen Nicolas Boyer Kim Walisch and Jatin Bhateja (AVX-512 bitset decoder) Fangzheng Zhang and Weiqiang Wan (AVX-512 kernel) # if you have contributed to the project and your name does not # appear in this list, please let us know! simdjson-3.12.3/Doxyfile000066400000000000000000003346101477153763300151630ustar00rootroot00000000000000# Doxyfile 1.8.17 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the configuration # file that follow. The default is UTF-8 which is also the encoding used for all # text before the first occurrence of this tag. Doxygen uses libiconv (or the # iconv built into libc) for the transcoding. See # https://www.gnu.org/software/libiconv/ for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. This name is used in the # title of most generated pages and in a few other places. # The default value is: My Project. PROJECT_NAME = simdjson # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. PROJECT_NUMBER = "3.12.3" # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = "Ridiculously Fast JSON" # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. PROJECT_LOGO = images/logotiny.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = doc/api # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes # performance problems for the file system. # The default value is: NO. CREATE_SUBDIRS = NO # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. # The default value is: NO. ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all generated output in the proper direction. # Possible values are: None, LTR, RTL and Context. # The default value is: None. OUTPUT_TEXT_DIRECTION = None # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. # The default value is: YES. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found # as the leading text of the brief description, will be stripped from the text # and the result, after processing the whole list, is used as the annotated # text. Otherwise, the brief description is used as-is. If left blank, the # following values are used ($name is automatically replaced with the name of # the entity):The $name class, The $name widget, The $name file, is, provides, # specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = "The $name class" \ "The $name widget" \ "The $name file" \ is \ provides \ specifies \ contains \ represents \ a \ an \ the # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # doxygen will generate a detailed section even if there is only a brief # description. # The default value is: NO. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. # The default value is: NO. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. FULL_PATH_NAMES = YES # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the path to # strip. # # Note that you can specify absolute paths here, but also relative paths, which # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which # header file to include in order to use a class. If left blank only the name of # the header file containing the class definition is used. Otherwise one should # specify the list of include paths that are normally passed to the compiler # using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the # first line (until the first dot) of a Javadoc-style comment as the brief # description. If set to NO, the Javadoc-style will behave just like regular Qt- # style comments (thus requiring an explicit @brief command for a brief # description.) # The default value is: NO. JAVADOC_AUTOBRIEF = YES # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line # such as # /*************** # as being the beginning of a Javadoc-style comment "banner". If set to NO, the # Javadoc-style will behave just like regular comments and it will not be # interpreted by doxygen. # The default value is: NO. JAVADOC_BANNER = NO # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus # requiring an explicit \brief command for a brief description.) # The default value is: NO. QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as # a brief description. This used to be the default behavior. The new default is # to treat a multi-line C++ comment block as a detailed description. Set this # tag to YES if you prefer the old behavior instead. # # Note that setting this tag to YES also means that rational rose comments are # not recognized any more. # The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new # page for each member. If set to NO, the documentation of a member will be part # of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen # uses this value to replace tabs by spaces in code fragments. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 4 # This tag can be used to specify a number of aliases that act as commands in # the documentation. An alias has the form: # name=value # For example adding # "sideeffect=@par Side Effects:\n" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines (in the resulting output). You can put ^^ in the value part of an # alias to insert a newline as if a physical newline was in the original file. # When you need a literal { or } or , in the value part of an alias you have to # escape them by means of a backslash (\), this can lead to conflicts with the # commands \{ and \} for these it is advised to use the version @{ and @} or use # a double escape (\\{ and \\}) ALIASES = # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all # members will be omitted, etc. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored # for that language. For instance, namespaces will be presented as packages, # qualified scopes will look different, etc. # The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources. Doxygen will then generate output that is tailored for Fortran. # The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for VHDL. # The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice # sources only. Doxygen will then generate output that is more tailored for that # language. For instance, namespaces will be presented as modules, types will be # separated into more groups, etc. # The default value is: NO. OPTIMIZE_OUTPUT_SLICE = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser # tries to guess whether the code is fixed or free formatted code, this is the # default for Fortran type files), VHDL, tcl. For instance to make doxygen treat # .inc files as Fortran files (default is PHP), and .f files as C (default is # Fortran), use: inc=Fortran f=C. # # Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See https://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up # to that level are automatically included in the table of contents, even if # they do not have an id attribute. # Note: This feature currently applies only to Markdown headings. # Minimum value: 0, maximum value: 99, default value: 5. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. TOC_INCLUDE_HEADINGS = 5 # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or # globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this # tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); # versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make # doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. # The default value is: YES. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO # If one adds a struct or class to a group and this option is enabled, then also # any nested class or struct is added to the same group. By default this option # is disabled and one has to add nested compounds explicitly via \ingroup. # The default value is: NO. GROUP_NESTED_COMPOUNDS = NO # Set the SUBGROUPING tag to YES to allow class member groups of the same type # (for instance a group of public functions) to be put as a subgroup of that # type (e.g. under the Public Functions section). Set it to NO to prevent # subgrouping. Alternatively, this can be done per class using the # \nosubgrouping command. # The default value is: YES. SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions # are shown inside the group in which they are included (e.g. using \ingroup) # instead of on a separate page (for HTML and Man pages) or section (for LaTeX # and RTF). # # Note that this feature does not work in combination with # SEPARATE_MEMBER_PAGES. # The default value is: NO. INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions # with only public data fields or simple typedef fields will be shown inline in # the documentation of the scope in which they are defined (i.e. file, # namespace, or group documentation), provided this scope is documented. If set # to NO, structs, classes, and unions are shown on a separate page (for HTML and # Man pages) or section (for LaTeX and RTF). # The default value is: NO. INLINE_SIMPLE_STRUCTS = NO # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or # enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically be # useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. # The default value is: NO. TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual # methods of a class will be included in the documentation. # The default value is: NO. EXTRACT_PRIV_VIRTUAL = NO # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = NO # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. If set to YES, local methods, # which are defined in the implementation section but not in the interface are # included in the documentation. If set to NO, only methods in the interface are # included. # The default value is: NO. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base name of # the file that contains the anonymous namespace. By default anonymous namespace # are hidden. # The default value is: NO. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation # section is generated. This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option # has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # declarations. If set to NO, these declarations will be included in the # documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = YES # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any # documentation blocks found inside the body of a function. If set to NO, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation that is typed after a # \internal command is included. If the tag is set to NO then the documentation # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file # names in lower-case letters. If set to YES, upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # (including Cygwin) ands Mac users are advised to set this option to NO. # The default value is: system dependent. CASE_SENSE_NAMES = NO # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will # append additional text to a page's title, such as Class Reference. If set to # YES the compound reference will be hidden. # The default value is: NO. HIDE_COMPOUND_REFERENCE= NO # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = NO # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by # fully-qualified names, including namespaces. If set to NO, the class list will # be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the alphabetical # list. # The default value is: NO. SORT_BY_SCOPE_NAME = NO # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo # list. This list is created by putting \todo commands in the documentation. # The default value is: YES. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test # list. This list is created by putting \test commands in the documentation. # The default value is: YES. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond # ... \endcond blocks. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the # documentation. If the initializer consists of more lines than specified here # it will be hidden. Use a value of 0 to hide initializers completely. The # appearance of the value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at # the bottom of the documentation of classes and structs. If set to YES, the # list will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = YES # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = YES # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters # in a documented function, or documenting parameters that don't exist or using # markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO, doxygen will only warn about wrong or incomplete # parameter documentation, but not about the absence of documentation. If # EXTRACT_ALL is set to YES then this flag will automatically be disabled. # The default value is: NO. WARN_NO_PARAMDOC = NO # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. # The default value is: NO. WARN_AS_ERROR = NO # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard # error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or # directories like /usr/src/myproject. Separate the files or directories with # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. INPUT = doc include/simdjson include/simdjson/dom include/simdjson/generic # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: https://www.gnu.org/software/libiconv/) for the list of # possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # read by doxygen. # # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), # *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen # C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd, # *.vhdl, *.ucf, *.qsf and *.ice. FILE_PATTERNS = *.c \ *.cc \ *.cxx \ *.cpp \ *.c++ \ *.java \ *.ii \ *.ixx \ *.ipp \ *.i++ \ *.inl \ *.idl \ *.ddl \ *.odl \ *.h \ *.hh \ *.hxx \ *.hpp \ *.h++ \ *.cs \ *.d \ *.php \ *.php4 \ *.php5 \ *.phtml \ *.inc \ *.m \ *.markdown \ *.md \ *.mm \ *.dox \ *.doc \ *.txt \ *.py \ *.pyw \ *.f90 \ *.f95 \ *.f03 \ *.f08 \ *.f \ *.for \ *.tcl \ *.vhd \ *.vhdl \ *.ucf \ *.qsf \ *.ice # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. # The default value is: NO. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = simdjson::internal # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank all # files are included. EXAMPLE_PATTERNS = * # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude commands # irrespective of the value of the RECURSIVE tag. # The default value is: NO. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the # \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command: # # # # where is the value of the INPUT_FILTER tag, and is the # name of an input file. Doxygen will then use the output that the filter # program writes to standard output. If FILTER_PATTERNS is specified, this tag # will be ignored. # # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: pattern=filter # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and # it is also possible to disable source filtering for a specific pattern using # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = doc/basics_doxygen.md #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will be # generated. Documented entities will be cross-referenced with these sources. # # Note: To get rid of all source code in the generated output, make sure that # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = YES # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # entity all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see https://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a # verbatim copy of the header file for each class for which an include is # specified. Set to NO to disable this. # See also: Section \class. # The default value is: YES. VERBATIM_HEADERS = YES # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the # cost of reduced performance. This can be particularly helpful with template # rich C++ code for which doxygen's built-in parser lacks the necessary type # information. # Note: The availability of this option depends on whether or not doxygen was # generated with the -Duse_libclang=ON option for CMake. # The default value is: NO. CLANG_ASSISTED_PARSING = NO # If clang assisted parsing is enabled you can provide the compiler with command # line options that you would normally use when invoking the compiler. Note that # the include paths will already be set by doxygen for the files and directories # specified with INPUT and INCLUDE_PATH. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. CLANG_OPTIONS = # If clang assisted parsing is enabled you can provide the clang parser with the # path to the compilation database (see: # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files # were built. This is equivalent to specifying the "-p" option to a clang tool, # such as clang-check. These options will then be passed to the parser. # Note: The availability of this option depends on whether or not doxygen was # generated with the -Duse_libclang=ON option for CMake. CLANG_DATABASE_PATH = #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all # compounds will be generated. Enable this if the project contains a lot of # classes, structs, unions or interfaces. # The default value is: YES. ALPHABETICAL_INDEX = YES # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in # which the alphabetical index list will be split. # Minimum value: 1, maximum value: 20, default value: 5. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # it. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of # the HTML output. If left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = theme/doxygen-awesome.css \ theme/doxygen-awesome-sidebar-only.css \ theme/doxygen-awesome-sidebar-only-darkmode-toggle.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = theme/doxygen-awesome-darkmode-toggle.js \ theme/doxygen-awesome-interactive-toc.js \ theme/doxygen-awesome-fragment-copy-button.js \ theme/doxygen-awesome-paragraph-link.js # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # https://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 # gradually make the output lighter, whereas values above 100 make the output # darker. The value divided by 100 is the actual gamma applied, so 80 represents # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not # change the gamma. # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to YES can help to show when doxygen was last run and thus if the # documentation is up to date. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = NO # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that # are dynamically created via JavaScript. If disabled, the navigation index will # consists of multiple levels of tabs that are statically embedded in every HTML # page. Disable this option to support browsers that do not have JavaScript, # like the Qt help browser. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_MENUS = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to # such a level that at most the specified number of entries are visible (unless # a fully collapsed tree already exceeds this amount). So setting the number of # entries 1 will produce a full collapsed tree by default. 0 is a special value # representing an infinite number of entries and will result in a full expanded # tree by default. # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: https://developer.apple.com/xcode/), introduced with OSX # 10.5 (Leopard). To create a documentation set, doxygen will generate a # Makefile in the HTML output directory. Running make will produce the docset in # that directory and running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy # genXcode/_index.html for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO # This tag determines the name of the docset feed. A documentation feed provides # an umbrella under which multiple documentation sets from a single provider # (such as a company or product suite) can be grouped. # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # The CHM_FILE tag can be used to specify the file name of the resulting .chm # file. You can add a path in front of the file if the result should not be # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler (hhc.exe). If non-empty, # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated # (YES) or that it should be included in the master .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it # enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members to # the table of contents of the HTML help documentation and to the tree view. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help # (.qch) of the generated HTML documentation. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify # the file name of the resulting .qch file. The path specified is relative to # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace # (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual # Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- # folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To # install this plugin and make it available under the help contents menu in # Eclipse, the contents of the directory containing the HTML and XML files needs # to be copied into the plugins directory of eclipse. The name of the directory # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. # After copying Eclipse needs to be restarted before the help appears. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO # A unique identifier for the Eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have this # name. Each documentation set should have its own identifier. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project # If you want full control over the layout of the generated HTML pages it might # be necessary to disable the index and replace it with your own. The # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag # value is set to YES, a side panel will be generated containing a tree-like # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has # the same information as the tab index, you could consider setting # DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = YES # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands # to create new LaTeX commands to be used in formulas as building blocks. See # the section "Including formulas" for details. FORMULA_MACROFILE = # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # https://www.mathjax.org) which uses client side JavaScript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: # http://docs.mathjax.org/en/latest/output.html) for more details. # Possible values are: HTML-CSS (which is slower, but has the best # compatibility), NativeMML (i.e. MathML) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from https://www.mathjax.org before deployment. # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. # For large projects the javascript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically # , /