Compare commits

..

6 Commits

Author SHA1 Message Date
Daniel Lemire 01b4710ff8 added missing 'auto' 2025-07-18 13:02:52 -04:00
Daniel Lemire 049f70aef3 removing <optional>, use concepts 2025-07-18 08:54:02 -04:00
Francisco Geiman Thiesen d874ab7239 Removing trailing whitespace. 2025-07-18 10:49:47 +00:00
Francisco Geiman Thiesen a27a17484d Removing unintentional endline. 2025-07-18 05:12:21 +00:00
Francisco Geiman Thiesen 20cea8b477 Adding support for string-based enum serlalization and deserialization. 2025-07-18 05:01:40 +00:00
Francisco Geiman Thiesen 0517fb3aaa Adding type validation, enhancing optional type support and adding test a few more tests. 2025-07-17 21:43:44 +00:00
199 changed files with 4423 additions and 48238 deletions
+316
View File
@@ -0,0 +1,316 @@
version: 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 <simdjson.h>\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 <simdjson.h>\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
+2 -5
View File
@@ -9,8 +9,7 @@ assignees: ''
Before submitting an issue, please ensure that you have read the documentation: Before submitting an issue, please ensure that you have read the documentation:
* Basics is an overview of how to use simdjson and its APIs to parse JSON: https://github.com/simdjson/simdjson/blob/master/doc/basics.md * Basics is an overview of how to use simdjson and its APIs: https://github.com/simdjson/simdjson/blob/master/doc/basics.md
* Builder is an overview of how to use simdjson to generate JSON: https://github.com/simdjson/simdjson/blob/master/doc/builder.md
* Performance shows some more advanced scenarios and how to tune for them: https://github.com/simdjson/simdjson/blob/master/doc/performance.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 * 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. * 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.
@@ -38,7 +37,7 @@ If we cannot reproduce the issue, then we cannot address it. Note that a stack t
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. 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.
**simdjson release** **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. 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.
@@ -56,8 +55,6 @@ We support up-to-date 64-bit ARM and x64 FreeBSD, macOS, Windows and Linux syste
pre-release version of a compiler, do not report it as a bug to simdjson. However, we always 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. invite contributions either in the form an analysis or of a code contribution.
Under Windows, we support Visual Studio (both with LLVM and without). We do not support MinGW and other alternate compiler systems. Windows users should be aware that there [is a long-running bug with GCC under Windows](https://gcc.gnu.org/bugzilla/show_bug.cgi?id=54412).
**Indicate whether you are willing or able to provide a bug fix as a pull request** **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: If you plan to contribute to simdjson, please read our guide:
+1 -2
View File
@@ -9,8 +9,7 @@ assignees: ''
Before submitting an issue, please ensure that you have read the documentation: Before submitting an issue, please ensure that you have read the documentation:
* Basics is an overview of how to use simdjson and its APIs to parse JSON: https://github.com/simdjson/simdjson/blob/master/doc/basics.md * Basics is an overview of how to use simdjson and its APIs: https://github.com/simdjson/simdjson/blob/master/doc/basics.md
* Builder is an overview of how to use simdjson to generate JSON: https://github.com/simdjson/simdjson/blob/master/doc/builder.md
* Performance shows some more advanced scenarios and how to tune for them: https://github.com/simdjson/simdjson/blob/master/doc/performance.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 * 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 follow the [JSON specification as described by RFC 8259](https://www.rfc-editor.org/rfc/rfc8259.txt) (T. Bray, 2017).
@@ -9,8 +9,7 @@ assignees: ''
Before submitting an issue, please ensure that you have read the documentation: Before submitting an issue, please ensure that you have read the documentation:
* Basics is an overview of how to use simdjson and its APIs to parse JSON: https://github.com/simdjson/simdjson/blob/master/doc/basics.md * Basics is an overview of how to use simdjson and its APIs: https://github.com/simdjson/simdjson/blob/master/doc/basics.md
* Builder is an overview of how to use simdjson to generate JSON: https://github.com/simdjson/simdjson/blob/master/doc/builder.md
* Performance shows some more advanced scenarios and how to tune for them: https://github.com/simdjson/simdjson/blob/master/doc/performance.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 * 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 follow the [JSON specification as described by RFC 8259](https://www.rfc-editor.org/rfc/rfc8259.txt) (T. Bray, 2017).
+4 -49
View File
@@ -1,53 +1,8 @@
Short title (summary):
Description
- What did you change and why? (1-3 sentences)
- Issue reproduced / related issue: link the issue if relevant (e.g. #123)
Type of change
- [ ] Bug fix
- [ ] New feature
- [ ] Refactor / cleanup
- [ ] Documentation / tests
- [ ] Other (please describe):
How to verify / test
- Add additional tests to verify bugs or new features.
- If you claim performance gains, you should provide benchmark numbers using high quality benchmarking code.
Please read before contributing: 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.
- CONTRIBUTING: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md
- HACKING: https://github.com/simdjson/simdjson/blob/master/HACKING.md
If you plan to contribute to simdjson, please read our
CONTRIBUTING guide: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md and our
If you can, we recommend running our tests with the sanitizers turned on. HACKING guide: https://github.com/simdjson/simdjson/blob/master/HACKING.md
For non-Visual Studio users, it is as easy as doing:
```bash
cmake -B build -D SIMDJSON_SANITIZE=ON -D SIMDJSON_DEVELOPER_MODE=ON
cmake --build build
ctest --test-dir build
```
Our CI checks, among other things, for trailing whitespace. If a test fails for that reason,
use the "artifacts" button to download the artifact and inspect the problematic lines,
or run `scripts/remove_trailing_whitespace.sh` locally if you have a bash shell and `sed`.
Checklist before submitting
- [ ] I added/updated tests covering my change (if applicable)
- [ ] Code builds locally and passes my check
- [ ] Documentation / README updated if needed
- [ ] Commits are atomic and messages are clear
- [ ] I linked the related issue (if applicable)
Final notes
- For large PRs, prefer smaller incremental PRs or request staged review.
Thanks for the contribution!
+1 -1
View File
@@ -1,4 +1,4 @@
name: Ubuntu aarch64 (GCC 13) name: Ubuntu ppc64le (GCC 11)
on: on:
push: push:
+2 -8
View File
@@ -2,13 +2,7 @@ name: Doxygen GitHub Pages
on: on:
release: release:
# Trigger when a release object is created and when it's published. types: [created]
# Some GitHub flows create a release object then publish it later; include both.
types: [created, published]
# Also trigger on tag creation pushes so releasing via Git tags still runs the workflow
push:
tags:
- "v*" # common release tag pattern like v1.2.3
# Allows you to run this workflow manually from the Actions tab # Allows you to run this workflow manually from the Actions tab
workflow_dispatch: workflow_dispatch:
@@ -33,7 +27,7 @@ jobs:
- name: Generate Doxygen Documentation - name: Generate Doxygen Documentation
run: doxygen run: doxygen
- name: Deploy to GitHub Pages - name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4 uses: peaceiris/actions-gh-pages@v3
with: with:
github_token: ${{ secrets.GITHUB_TOKEN }} github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: doc/api/html publish_dir: doc/api/html
-29
View File
@@ -1,29 +0,0 @@
name: Ubuntu rvv VLEN=1024 (clang 18)
on:
push:
branches:
- master
pull_request:
branches:
- master
jobs:
build:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- name: Install packages
run: |
sudo apt-get update -q -y
sudo apt-get install -y cmake make g++-riscv64-linux-gnu qemu-user-static clang-18
- name: Build
run: |
CXX=clang++-18 CXXFLAGS="--target=riscv64-linux-gnu -march=rv64gcv_zvbb" \
cmake --toolchain=cmake/toolchains-ci/riscv64-linux-gnu.cmake -DCMAKE_BUILD_TYPE=Release -B build
cmake --build build/ -j$(nproc)
- name: Test VLEN=1024
run: |
export QEMU_LD_PREFIX="/usr/riscv64-linux-gnu"
export QEMU_CPU="rv64,v=on,zvbb=on,vlen=1024,rvv_ta_all_1s=on,rvv_ma_all_1s=on"
ctest --timeout 1800 --output-on-failure --test-dir build -j $(nproc)
-29
View File
@@ -1,29 +0,0 @@
name: Ubuntu rvv VLEN=128 (clang 17)
on:
push:
branches:
- master
pull_request:
branches:
- master
jobs:
build:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- name: Install packages
run: |
sudo apt-get update -q -y
sudo apt-get install -y cmake make g++-riscv64-linux-gnu qemu-user-static clang-17
- name: Build
run: |
CXX=clang++-17 CXXFLAGS="--target=riscv64-linux-gnu -march=rv64gcv" \
cmake --toolchain=cmake/toolchains-ci/riscv64-linux-gnu.cmake -DCMAKE_BUILD_TYPE=Release -B build
cmake --build build/ -j$(nproc)
- name: Test VLEN=128
run: |
export QEMU_LD_PREFIX="/usr/riscv64-linux-gnu"
export QEMU_CPU="rv64,v=on,vlen=128,rvv_ta_all_1s=on,rvv_ma_all_1s=on"
ctest --timeout 1800 --output-on-failure --test-dir build -j $(nproc)
-29
View File
@@ -1,29 +0,0 @@
name: Ubuntu rvv VLEN=256 (gcc 14)
on:
push:
branches:
- master
pull_request:
branches:
- master
jobs:
build:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- name: Install packages
run: |
sudo apt-get update -q -y
sudo apt-get install -y cmake make g++-14-riscv64-linux-gnu qemu-user-static
- name: Build
run: |
CXX=riscv64-linux-gnu-g++-14 CXXFLAGS=-march=rv64gcv \
cmake --toolchain=cmake/toolchains-ci/riscv64-linux-gnu.cmake -DCMAKE_BUILD_TYPE=Release -B build
cmake --build build/ -j$(nproc)
- name: Test VLEN=256
run: |
export QEMU_LD_PREFIX="/usr/riscv64-linux-gnu"
export QEMU_CPU="rv64,v=on,zvbb=on,vlen=256,rvv_ta_all_1s=on,rvv_ma_all_1s=on"
ctest --timeout 1800 --output-on-failure --test-dir build -j $(nproc)
+16 -48
View File
@@ -14,52 +14,20 @@ jobs:
with: with:
path: dependencies/.cache path: dependencies/.cache
key: ${{ hashFiles('dependencies/CMakeLists.txt') }} key: ${{ hashFiles('dependencies/CMakeLists.txt') }}
- name: Use cmake
- name: Configure Debug Build
run: | run: |
CXX=g++-12 cmake -DSIMDJSON_CXX_STANDARD=20 -DCMAKE_BUILD_TYPE=Debug -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF -B builddebug mkdir builddebug &&
cd builddebug &&
- name: Compile Debug Build CXX=g++-12 cmake -DSIMDJSON_CXX_STANDARD=20 -DCMAKE_BUILD_TYPE=Debug -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF .. &&
run: | cmake --build . &&
cmake --build builddebug ctest --output-on-failure -LE explicitonly -j &&
cd .. &&
- name: Test Debug Build mkdir build &&
run: | cd build &&
ctest --output-on-failure -LE explicitonly -j --test-dir builddebug 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 . &&
- name: Configure Release Build ctest --output-on-failure -LE explicitonly -j &&
run: | cmake --install . &&
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 -B build echo -e '#include <simdjson.h>\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 &&
- name: Compile Release Build mkdir build && cd build && cmake -DCMAKE_INSTALL_PREFIX:PATH=../../../build/destination .. && cmake --build .
run: |
cmake --build build
- name: Test Release Build
run: |
ctest --output-on-failure -LE explicitonly -j --test-dir build
- name: Install Release Build
run: |
cmake --install build
- name: Generate Example Code
run: |
echo -e '#include <simdjson.h>\nint main(int argc,char**argv) {simdjson::dom::parser parser;simdjson::dom::element tweets = parser.load(argv[1]); }' > tmp.cpp
- name: Compile Example Code
run: |
c++ -Idestination/include -Ldestination/lib -std=c++17 -Wl,-rpath,destination/lib -o linkandrun tmp.cpp -lsimdjson
- name: Run Example Code
run: |
./linkandrun jsonexamples/twitter.json
- name: Configure Find Tests
run: |
cd tests/installation_tests/find && \
cmake -DCMAKE_INSTALL_PREFIX:PATH=../../../destination -B build
- name: Compile Find Tests
run: |
cd tests/installation_tests/find && cmake --build build
@@ -1,22 +0,0 @@
name: Ubuntu 24.04 CI (CXX 20, noexcept)
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_EXCEPTIONS=OFF -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 build
+1 -1
View File
@@ -31,4 +31,4 @@ jobs:
echo -e '#include <simdjson.h>\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 && echo -e '#include <simdjson.h>\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 && mkdir testfindpackage &&
cd testfindpackage && cd testfindpackage &&
echo -e 'cmake_minimum_required(VERSION 3.14)\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 . 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 .
+1 -1
View File
@@ -31,4 +31,4 @@ jobs:
echo -e '#include <simdjson.h>\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 && echo -e '#include <simdjson.h>\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 && mkdir testfindpackage &&
cd testfindpackage && cd testfindpackage &&
echo -e 'cmake_minimum_required(VERSION 3.14)\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 . 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 .
-30
View File
@@ -1,30 +0,0 @@
name: VS17-CI-SANITIZE
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, 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}} -DSANITIZE=ON -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_COMPETITION=OFF -DBUILD_SHARED_LIBS=${{matrix.shared}} -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
+1 -1
View File
@@ -38,7 +38,7 @@ cmake-build-release/
.history/ .history/
# Visual Studio artifacts # Visual Studio artifacts
/.vs/ /VS/
# C/C++ build outputs # C/C++ build outputs
.build/ .build/
-3
View File
@@ -3,9 +3,6 @@
{"column": 95 }, {"column": 95 },
{"column": 120 } {"column": 120 }
], ],
"cmake.configureArgs": [
"-DSIMDJSON_DEVELOPER_MODE=ON"
],
"files.trimTrailingWhitespace": true, "files.trimTrailingWhitespace": true,
"files.associations": { "files.associations": {
".clangd": "yaml", ".clangd": "yaml",
+5 -3
View File
@@ -1,9 +1,11 @@
cmake_minimum_required(VERSION 3.14) cmake_minimum_required(VERSION 3.14)
cmake_policy(VERSION 3.5) # For doctest
project( project(
simdjson simdjson
# The version number is modified by tools/release.py # The version number is modified by tools/release.py
VERSION 4.2.3 VERSION 3.13.0
DESCRIPTION "Parsing gigabytes of JSON per second" DESCRIPTION "Parsing gigabytes of JSON per second"
HOMEPAGE_URL "https://simdjson.org/" HOMEPAGE_URL "https://simdjson.org/"
LANGUAGES CXX C LANGUAGES CXX C
@@ -20,8 +22,8 @@ string(
# ---- Options, variables ---- # ---- Options, variables ----
# These version numbers are modified by tools/release.py # These version numbers are modified by tools/release.py
set(SIMDJSON_LIB_VERSION "29.0.0" CACHE STRING "simdjson library version") set(SIMDJSON_LIB_VERSION "26.0.0" CACHE STRING "simdjson library version")
set(SIMDJSON_LIB_SOVERSION "29" CACHE STRING "simdjson library soversion") set(SIMDJSON_LIB_SOVERSION "26" 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) 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) if(SIMDJSON_BUILD_STATIC_LIB AND NOT BUILD_SHARED_LIBS)
+1 -1
View File
@@ -38,7 +38,7 @@ PROJECT_NAME = simdjson
# could be handy for archiving the generated documentation or if some version # could be handy for archiving the generated documentation or if some version
# control system is used. # control system is used.
PROJECT_NUMBER = "4.2.3" PROJECT_NUMBER = "3.13.0"
# Using the PROJECT_BRIEF tag one can provide an optional one line description # 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 # for a project that appears at the top of each page and should give viewer a
+8 -46
View File
@@ -20,54 +20,13 @@ If you plan to contribute to simdjson, please read our [CONTRIBUTING](https://gi
Build Quickstart Build Quickstart
------------------------------ ------------------------------
For non-Windows system,
```bash ```bash
cmake -B -D SIMDJSON_DEVELOPER_MODE=ON .. mkdir build
cmake --build build cd build
ctest --test-dir build cmake -D SIMDJSON_DEVELOPER_MODE=ON ..
cmake --build .
``` ```
It is similar for Visual Studio users, please see the CMake or Visual Studio documentation.
By default the library is built in Release mode.
Assertions and development checks
------------------------------
We do not use conventional `assert` in simdjson. Instead we use the macro
`SIMDJSON_ASSUME`:
```cpp
SIMDJSON_ASSUME(something_that_is_true());
```
Sometimes, you need to do a bit more work that a simple check.
The `SIMDJSON_DEVELOPMENT_CHECKS` macro is true only in Debug mode unless manually set.
It is acceptable to add checks that you would not do in Release mode as long as
they are guarded:
```cpp
#if SIMDJSON_DEVELOPMENT_CHECKS
// do sanity checks here
```
Working with sanitizers
------------------------------
The simdjson library must be memory-safe. We cannot allow buffer overruns.
During development, if you system supports it, we recommend configuring
the project with `-D SIMDJSON_SANITIZE=ON`.
```bash
cmake -B -D SIMDJSON_SANITIZE=ON -D SIMDJSON_DEVELOPER_MODE=ON ..
cmake --build build
ctest --test-dir build
```
Design notes Design notes
------------------------------ ------------------------------
@@ -144,9 +103,12 @@ simdjson's source structure, from the top level, looks like this:
* generic/stage2/*.h: `simdjson::<implementation>::stage2` namespace. Generic implementation of the tape creator, which consumes the index from stage 1 and actually parses numbers and string and such. Used for the DOM interface. * generic/stage2/*.h: `simdjson::<implementation>::stage2` namespace. Generic implementation of the tape creator, which consumes the index from stage 1 and actually parses numbers and string and such. Used for the DOM interface.
Other important files and directories: Other important files and directories:
* **.drone.yml:** Definitions for Drone CI.
* **.appveyor.yml:** Definitions for Appveyor CI (Windows).
* **.circleci:** Definitions for Circle CI.
* **.github/workflows:** Definitions for GitHub Actions (CI). * **.github/workflows:** Definitions for GitHub Actions (CI).
* **singleheader:** Contains generated `simdjson.h` and `simdjson.cpp` that we release. The files `singleheader/simdjson.h` and `singleheader/simdjson.cpp` should never be edited by hand. * **singleheader:** Contains generated `simdjson.h` and `simdjson.cpp` that we release. The files `singleheader/simdjson.h` and `singleheader/simdjson.cpp` should never be edited by hand.
* **singleheader/amalgamate.py:** Generates `singleheader/simdjson.h` and `singleheader/simdjson.cpp` for release (python script). If you add a new implementation (e.g., rvv), you need to edit this file (IMPLEMENTATIONS). * **singleheader/amalgamate.py:** Generates `singleheader/simdjson.h` and `singleheader/simdjson.cpp` for release (python script).
* **benchmark:** This is where we do benchmarking. Benchmarking is core to every change we make; the * **benchmark:** This is where we do benchmarking. Benchmarking is core to every change we make; the
cardinal rule is don't regress performance without knowing exactly why, and what you're trading cardinal rule is don't regress performance without knowing exactly why, and what you're trading
for it. Many of our benchmarks are microbenchmarks. We are effectively doing controlled scientific experiments for the purpose of understanding what affects our performance. So we simplify as much as possible. We try to avoid irrelevant factors such as page faults, interrupts, unnecessary system calls. We recommend checking the performance as follows: for it. Many of our benchmarks are microbenchmarks. We are effectively doing controlled scientific experiments for the purpose of understanding what affects our performance. So we simplify as much as possible. We try to avoid irrelevant factors such as page faults, interrupts, unnecessary system calls. We recommend checking the performance as follows:
+3 -15
View File
@@ -1,3 +1,5 @@
[![Fuzzing Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/simdjson.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:simdjson)
[![][license img]][license] [![][licensemit img]][licensemit] [![][license img]][license] [![][licensemit img]][licensemit]
@@ -62,14 +64,10 @@ Real-world usage
- [WasmEdge](https://wasmedge.org) - [WasmEdge](https://wasmedge.org)
- [RonDB](https://github.com/logicalclocks/rondb) - [RonDB](https://github.com/logicalclocks/rondb)
- [GreptimeDB](https://github.com/GreptimeTeam/greptimedb) - [GreptimeDB](https://github.com/GreptimeTeam/greptimedb)
- [mamba](https://github.com/mamba-org/mamba)
If you are planning to use simdjson in a product, please work from one of our releases. If you are planning to use simdjson in a product, please work from one of our releases.
Quick Start Quick Start
----------- -----------
@@ -86,7 +84,7 @@ The simdjson library is easily consumable with a single .h and .cpp file.
``` ```
2. Create `quickstart.cpp`: 2. Create `quickstart.cpp`:
```cpp ```c++
#include <iostream> #include <iostream>
#include "simdjson.h" #include "simdjson.h"
using namespace simdjson; using namespace simdjson;
@@ -116,14 +114,11 @@ Usage documentation is available:
* [Implementation Selection](doc/implementation-selection.md) describes runtime CPU detection and * [Implementation Selection](doc/implementation-selection.md) describes runtime CPU detection and
how you can work with it. how you can work with it.
* [API](https://simdjson.github.io/simdjson/) contains the automatically generated API documentation. * [API](https://simdjson.github.io/simdjson/) contains the automatically generated API documentation.
* [Compile-Time Parsing](doc/compile_time.md) presents our compile-time parsing function (C++26 only).
Godbolt Godbolt
------------- -------------
Some users may want to browse code along with the compiled assembly. You want to check out the following lists of examples: Some users may want to browse code along with the compiled assembly. You want to check out the following lists of examples:
* [C++26 reflection example](https://godbolt.org/z/K3Px64TqK)
* [simdjson examples with errors handled through exceptions](https://godbolt.org/z/7G5qE4sr9) * [simdjson examples with errors handled through exceptions](https://godbolt.org/z/7G5qE4sr9)
* [simdjson examples with errors without exceptions](https://godbolt.org/z/e9dWb9E4v) * [simdjson examples with errors without exceptions](https://godbolt.org/z/e9dWb9E4v)
@@ -232,13 +227,6 @@ Contributing to simdjson
Head over to [CONTRIBUTING.md](CONTRIBUTING.md) for information on contributing to simdjson, and Head over to [CONTRIBUTING.md](CONTRIBUTING.md) for information on contributing to simdjson, and
[HACKING.md](HACKING.md) for information on source, building, and architecture/design. [HACKING.md](HACKING.md) for information on source, building, and architecture/design.
Stars
------
[![Star History Chart](https://api.star-history.com/svg?repos=simdjson/simdjson&type=Date)](https://www.star-history.com/#simdjson/simdjson&Date)
License License
------- -------
-10
View File
@@ -35,16 +35,6 @@ if (TARGET benchmark::benchmark)
endif() endif()
endif() endif()
include(CheckCXXCompilerFlag)
check_cxx_compiler_flag("-std=c++20" SIMDJSON_COMPILER_SUPPORTS_CXX20)
if(SIMDJSON_STATIC_REFLECTION) if(SIMDJSON_STATIC_REFLECTION)
add_subdirectory(static_reflect) add_subdirectory(static_reflect)
else()
if(SIMDJSON_EXCEPTIONS AND SIMDJSON_COMPILER_SUPPORTS_CXX20)
add_subdirectory(from)
add_subdirectory(car_builder)
endif()
endif(SIMDJSON_STATIC_REFLECTION) endif(SIMDJSON_STATIC_REFLECTION)
-46
View File
@@ -1,46 +0,0 @@
# Accessor Performance Benchmarks (C++26)
These benchmarks compare the performance of runtime vs compile-time JSON accessors.
For the comparison to be meaningful, you must build simdjson with support for
C++26 reflexion. See the `p2996` repository in the main project directory.
## Files
- `accessor_benchmark.h` - Common benchmark framework and test data
- `runtime_accessors.h` - Runtime `at_path()` benchmarks
- `compile_time_accessors.h` - Compile-time `at_path_compiled()` benchmarks (requires C++26 reflection)
## Benchmarks
Each benchmark measures parsing + single field access:
1. **accessor_simple** - Simple field: `.name`
2. **accessor_nested** - Nested field: `.address.city`
3. **accessor_deep** - Deep nested field: `.address.coordinates.lat`
## Building (Linux/macOS)
```bash
cmake -B build -D SIMDJSON_STATIC_REFLECTION=ON -DSIMDJSON_DEVELOPER_MODE=ON
cmake --build build --target=bench_ondemand
```
The `SIMDJSON_STATIC_REFLECTION` will be made unnecessary once mainstream compilers
begin supporting C++26 sufficiently well.
## Running (Linux/macOS)
```bash
# Run all accessor benchmarks
./build/bench_ondemand --benchmark_filter="accessor"
```
## Results
We find that compile-time accessors show performance improvements that scale with path depth:
- Simple fields: ~1.2x faster
- Nested fields: ~1.5x faster
- Deep nested fields: ~1.8x faster
The speedup comes from eliminating runtime path parsing and conversion overhead.
@@ -1,132 +0,0 @@
#pragma once
#include "json_benchmark/file_runner.h"
#include <string>
namespace accessor_performance {
using namespace json_benchmark;
// Test JSON for accessor benchmarks
static const char* TEST_JSON = R"({
"name": "Alice",
"age": 30,
"email": "alice@example.com",
"address": {
"street": "123 Main St",
"city": "Boston",
"state": "MA",
"zip": 12345,
"coordinates": {
"lat": 42.3601,
"lon": -71.0589
}
},
"scores": [95, 87, 92, 88, 91],
"preferences": {
"theme": "dark",
"notifications": {
"email": true,
"push": false,
"sms": true
}
}
})";
// Struct definitions for compile-time validation
#if SIMDJSON_STATIC_REFLECTION
struct Coordinates {
double lat;
double lon;
};
struct Address {
std::string street;
std::string city;
std::string state;
int64_t zip;
Coordinates coordinates;
};
struct Notifications {
bool email;
bool push;
bool sms;
};
struct Preferences {
std::string theme;
Notifications notifications;
};
struct TestData {
std::string name;
int64_t age;
std::string email;
Address address;
std::vector<int64_t> scores;
Preferences preferences;
};
#endif // SIMDJSON_STATIC_REFLECTION
// Single-access benchmark runner: measures ONE field access per iteration
template<typename I>
struct single_access_runner : public file_runner<I> {
std::string result_string;
int64_t result_int{};
double result_double{};
bool result_bool{};
bool setup(benchmark::State &state) {
this->json = simdjson::padded_string(TEST_JSON, strlen(TEST_JSON));
state.SetBytesProcessed(int64_t(state.iterations()) * int64_t(this->json.size()));
return true;
}
bool before_run(benchmark::State &state) {
if (!file_runner<I>::before_run(state)) { return false; }
result_string.clear();
result_int = 0;
result_double = 0.0;
result_bool = false;
return true;
}
bool run(benchmark::State &) {
return this->implementation.run(this->json, result_string, result_int, result_double, result_bool);
}
template<typename R>
bool diff(benchmark::State &state, single_access_runner<R> &reference) {
if (result_string != reference.result_string ||
result_int != reference.result_int ||
result_double != reference.result_double ||
result_bool != reference.result_bool) {
std::cerr << "Accessor benchmark results differ!" << std::endl;
return false;
}
return true;
}
size_t items_per_iteration() {
return 1;
}
};
// Benchmark template definitions
struct runtime_at_path_simple;
template<typename I> simdjson_inline static void accessor_simple(benchmark::State &state) {
run_json_benchmark<single_access_runner<I>, single_access_runner<runtime_at_path_simple>>(state);
}
struct runtime_at_path_nested;
template<typename I> simdjson_inline static void accessor_nested(benchmark::State &state) {
run_json_benchmark<single_access_runner<I>, single_access_runner<runtime_at_path_nested>>(state);
}
struct runtime_at_path_deep;
template<typename I> simdjson_inline static void accessor_deep(benchmark::State &state) {
run_json_benchmark<single_access_runner<I>, single_access_runner<runtime_at_path_deep>>(state);
}
} // namespace accessor_performance
@@ -1,56 +0,0 @@
#pragma once
#if SIMDJSON_EXCEPTIONS && SIMDJSON_STATIC_REFLECTION
#include "accessor_benchmark.h"
namespace accessor_performance {
using namespace simdjson;
struct compile_time_at_path_simple {
ondemand::parser parser{};
bool run(simdjson::padded_string &json, std::string &result_str, int64_t&, double&, bool&) {
auto doc = parser.iterate(json);
std::string_view name;
auto r = ondemand::json_path::at_path_compiled<TestData, ".name">(doc);
if (r.get(name) != SUCCESS) return false;
result_str = name;
return true;
}
};
struct compile_time_at_path_nested {
ondemand::parser parser{};
bool run(simdjson::padded_string &json, std::string &result_str, int64_t&, double&, bool&) {
auto doc = parser.iterate(json);
std::string_view city;
auto r = ondemand::json_path::at_path_compiled<TestData, ".address.city">(doc);
if (r.get(city) != SUCCESS) return false;
result_str = city;
return true;
}
};
struct compile_time_at_path_deep {
ondemand::parser parser{};
bool run(simdjson::padded_string &json, std::string&, int64_t&, double &result_dbl, bool&) {
auto doc = parser.iterate(json);
double lat;
auto r = ondemand::json_path::at_path_compiled<TestData, ".address.coordinates.lat">(doc);
if (r.get(lat) != SUCCESS) return false;
result_dbl = lat;
return true;
}
};
BENCHMARK_TEMPLATE(accessor_simple, compile_time_at_path_simple)->UseManualTime();
BENCHMARK_TEMPLATE(accessor_nested, compile_time_at_path_nested)->UseManualTime();
BENCHMARK_TEMPLATE(accessor_deep, compile_time_at_path_deep)->UseManualTime();
} // namespace accessor_performance
#endif // SIMDJSON_EXCEPTIONS && SIMDJSON_STATIC_REFLECTION
@@ -1,53 +0,0 @@
#pragma once
#if SIMDJSON_EXCEPTIONS
#include "accessor_benchmark.h"
namespace accessor_performance {
using namespace simdjson;
struct runtime_at_path_simple {
ondemand::parser parser{};
bool run(simdjson::padded_string &json, std::string &result_str, int64_t&, double&, bool&) {
auto doc = parser.iterate(json);
std::string_view name;
if (doc.at_path(".name").get(name) != SUCCESS) return false;
result_str = name;
return true;
}
};
struct runtime_at_path_nested {
ondemand::parser parser{};
bool run(simdjson::padded_string &json, std::string &result_str, int64_t&, double&, bool&) {
auto doc = parser.iterate(json);
std::string_view city;
if (doc.at_path(".address.city").get(city) != SUCCESS) return false;
result_str = city;
return true;
}
};
struct runtime_at_path_deep {
ondemand::parser parser{};
bool run(simdjson::padded_string &json, std::string&, int64_t&, double &result_dbl, bool&) {
auto doc = parser.iterate(json);
double lat;
if (doc.at_path(".address.coordinates.lat").get(lat) != SUCCESS) return false;
result_dbl = lat;
return true;
}
};
BENCHMARK_TEMPLATE(accessor_simple, runtime_at_path_simple)->UseManualTime();
BENCHMARK_TEMPLATE(accessor_nested, runtime_at_path_nested)->UseManualTime();
BENCHMARK_TEMPLATE(accessor_deep, runtime_at_path_deep)->UseManualTime();
} // namespace accessor_performance
#endif // SIMDJSON_EXCEPTIONS
-5
View File
@@ -148,9 +148,4 @@ SIMDJSON_POP_DISABLE_WARNINGS
#include "large_amazon_cellphones/simdjson_dom.h" #include "large_amazon_cellphones/simdjson_dom.h"
#include "large_amazon_cellphones/simdjson_ondemand.h" #include "large_amazon_cellphones/simdjson_ondemand.h"
#include "accessor_performance/runtime_accessors.h"
#if SIMDJSON_STATIC_REFLECTION
#include "accessor_performance/compile_time_accessors.h"
#endif
BENCHMARK_MAIN(); BENCHMARK_MAIN();
-14
View File
@@ -1,14 +0,0 @@
# Executable
add_executable(benchmark_car_builder benchmark_car_builder.cpp)
# Compile for C++20.
target_compile_features(benchmark_car_builder PRIVATE cxx_std_20)
# Check if -march=native is supported
include(CheckCXXCompilerFlag)
check_cxx_compiler_flag("-march=native" SIMDJSON_SUPPORTS_MARCH_NATIVE)
if(SIMDJSON_SUPPORTS_MARCH_NATIVE)
target_compile_options(benchmark_car_builder PRIVATE -march=native)
endif()
target_include_directories(benchmark_car_builder PRIVATE ${CMAKE_CURRENT_LIST_DIR}/..)
@@ -1,127 +0,0 @@
#include "event_counter.h"
#include <random>
#include <vector>
#include <simdjson.h>
event_collector collector;
struct Car {
std::string make;
std::string model;
int64_t year; // We deliberately do not include the tire pressure.
};
std::vector<Car> generate_random_cars(size_t count) {
static const std::vector<std::string> makes = {"Toyota", "Honda", "Ford",
"BMW", "Mazda"};
static const std::vector<std::string> models = {"Camry", "Civic", "Focus",
"320i", "3"};
static thread_local std::mt19937 rng{std::random_device{}()};
std::uniform_int_distribution<int> make_dist(0, makes.size() - 1);
std::uniform_int_distribution<int> model_dist(0, models.size() - 1);
std::uniform_int_distribution<int64_t> year_dist(2000, 2025);
std::uniform_real_distribution<double> pressure_dist(30.0, 45.0);
std::vector<Car> cars;
cars.reserve(count);
for (size_t i = 0; i < count; ++i) {
Car car;
car.make = makes[make_dist(rng)];
car.model = models[model_dist(rng)];
car.year = year_dist(rng);
cars.push_back(std::move(car));
}
return cars;
}
std::string_view serialize(simdjson::builder::string_builder &sb,
const std::vector<Car> &cars) {
sb.clear();
sb.start_array();
for (const auto &car : cars) {
sb.start_object();
sb.append_key_value("make", car.make);
sb.append_comma();
sb.append_key_value("model", car.model);
sb.append_comma();
sb.append_key_value("year", car.year);
sb.end_object();
}
sb.end_array();
std::string_view result;
if (sb.view().get(result)) {
return ""; // unexpected (error)
}
return result;
}
double pretty_print(const std::string &name, size_t num_chars,
std::pair<event_aggregate, size_t> result) {
const auto &agg = result.first;
size_t N = result.second;
num_chars *= N;
printf("%-40s : %8.2f ns %8.2f GB/s", name.c_str(),
agg.elapsed_ns() / num_chars, num_chars / agg.elapsed_ns());
if (collector.has_events()) {
printf(" %8.2f GHz %8.2f cycles/char %8.2f ins./char %8.2f i/c",
agg.cycles() / agg.elapsed_ns(), agg.cycles() / num_chars,
agg.instructions() / num_chars, agg.instructions() / agg.cycles());
}
printf("\n");
return num_chars / agg.elapsed_ns();
}
template <class function_type>
std::pair<event_aggregate, size_t>
bench(const function_type &&function, size_t min_repeat = 100,
size_t min_time_ns = 40'000'000, size_t max_repeat = 10000000) {
size_t N = min_repeat;
if (N == 0) {
N = 1;
}
event_aggregate warm_aggregate{};
for (size_t i = 0; i < N; i++) {
std::atomic_thread_fence(std::memory_order_acquire);
collector.start();
function();
std::atomic_thread_fence(std::memory_order_release);
event_count allocate_count = collector.end();
warm_aggregate << allocate_count;
if ((i + 1 == N) && (warm_aggregate.total_elapsed_ns() < min_time_ns) &&
(N < max_repeat)) {
N *= 10;
}
}
event_aggregate aggregate{};
for (size_t i = 0; i < 10; i++) {
std::atomic_thread_fence(std::memory_order_acquire);
collector.start();
for (size_t i = 0; i < N; i++) {
function();
}
std::atomic_thread_fence(std::memory_order_release);
event_count allocate_count = collector.end();
aggregate << allocate_count;
}
return {aggregate, N};
}
void run_benchmarks() {
std::vector<Car> source = generate_random_cars(100000);
simdjson::builder::string_builder sb;
size_t volume = serialize(sb, source).size();
pretty_print("string_builder", volume, bench([&source, &sb]() -> size_t {
return serialize(sb, source).size();
}));
}
int main() {
for (size_t trial = 0; trial < 3; trial++) {
printf("Trial %zu:\n", trial + 1);
run_benchmarks();
printf("\n");
}
return EXIT_SUCCESS;
}
+2 -9
View File
@@ -44,10 +44,7 @@ struct yyjson_base {
struct yyjson : yyjson_base { struct yyjson : yyjson_base {
bool run(simdjson::padded_string &json, std::vector<uint64_t> &result) { bool run(simdjson::padded_string &json, std::vector<uint64_t> &result) {
yyjson_doc *doc = yyjson_read(json.data(), json.size(), 0); return yyjson_base::run(yyjson_read(json.data(), json.size(), 0), result);
bool b = yyjson_base::run(doc, result);
yyjson_doc_free(doc);
return b;
} }
}; };
BENCHMARK_TEMPLATE(distinct_user_id, yyjson)->UseManualTime(); BENCHMARK_TEMPLATE(distinct_user_id, yyjson)->UseManualTime();
@@ -55,15 +52,11 @@ BENCHMARK_TEMPLATE(distinct_user_id, yyjson)->UseManualTime();
#if SIMDJSON_COMPETITION_ONDEMAND_INSITU #if SIMDJSON_COMPETITION_ONDEMAND_INSITU
struct yyjson_insitu : yyjson_base { struct yyjson_insitu : yyjson_base {
bool run(simdjson::padded_string &json, std::vector<uint64_t> &result) { bool run(simdjson::padded_string &json, std::vector<uint64_t> &result) {
yyjson_doc *doc = yyjson_read_opts(json.data(), json.size(), YYJSON_READ_INSITU, 0, 0); return yyjson_base::run(yyjson_read_opts(json.data(), json.size(), YYJSON_READ_INSITU, 0, 0), result);
bool b = yyjson_base::run(doc, result);
yyjson_doc_free(doc);
return b;
} }
}; };
BENCHMARK_TEMPLATE(distinct_user_id, yyjson_insitu)->UseManualTime(); BENCHMARK_TEMPLATE(distinct_user_id, yyjson_insitu)->UseManualTime();
#endif // SIMDJSON_COMPETITION_ONDEMAND_INSITU #endif // SIMDJSON_COMPETITION_ONDEMAND_INSITU
} // namespace distinct_user_id } // namespace distinct_user_id
#endif // SIMDJSON_COMPETITION_YYJSON #endif // SIMDJSON_COMPETITION_YYJSON
+3 -2
View File
@@ -25,11 +25,12 @@ int main(int argc, char *argv[]) {
exit(1); exit(1);
} }
const char *filename = argv[1]; const char *filename = argv[1];
simdjson::padded_string p; auto v = simdjson::padded_string::load(filename);
if (simdjson::padded_string::load(filename).get(p)) { if (v.error()) {
std::cerr << "Could not load the file " << filename << std::endl; std::cerr << "Could not load the file " << filename << std::endl;
return EXIT_FAILURE; return EXIT_FAILURE;
} }
const simdjson::padded_string& p = v.value_unsafe();
if (test_baseline) { if (test_baseline) {
std::wclog << "Baseline: Getline + normal parse... " << std::endl; std::wclog << "Baseline: Getline + normal parse... " << std::endl;
std::cout << "Gigabytes/second\t" std::cout << "Gigabytes/second\t"
+2 -10
View File
@@ -36,26 +36,18 @@ struct yyjson_base {
struct yyjson : yyjson_base { struct yyjson : yyjson_base {
bool run(simdjson::padded_string &json, uint64_t find_id, std::string_view &result) { bool run(simdjson::padded_string &json, uint64_t find_id, std::string_view &result) {
yyjson_doc *doc = yyjson_read(json.data(), json.size(), 0); return yyjson_base::run(yyjson_read(json.data(), json.size(), 0), find_id, result);
bool b = yyjson_base::run(doc, find_id, result);
yyjson_doc_free(doc);
return b;
} }
}; };
BENCHMARK_TEMPLATE(find_tweet, yyjson)->UseManualTime(); BENCHMARK_TEMPLATE(find_tweet, yyjson)->UseManualTime();
#if SIMDJSON_COMPETITION_ONDEMAND_INSITU #if SIMDJSON_COMPETITION_ONDEMAND_INSITU
struct yyjson_insitu : yyjson_base { struct yyjson_insitu : yyjson_base {
bool run(simdjson::padded_string &json, uint64_t find_id, std::string_view &result) { bool run(simdjson::padded_string &json, uint64_t find_id, std::string_view &result) {
yyjson_doc *doc = yyjson_read_opts(json.data(), json.size(), YYJSON_READ_INSITU, 0, 0); return yyjson_base::run(yyjson_read_opts(json.data(), json.size(), YYJSON_READ_INSITU, 0, 0), find_id, result);
bool b = yyjson_base::run(doc, find_id, result);
yyjson_doc_free(doc);
return b;
} }
}; };
BENCHMARK_TEMPLATE(find_tweet, yyjson_insitu)->UseManualTime(); BENCHMARK_TEMPLATE(find_tweet, yyjson_insitu)->UseManualTime();
#endif // SIMDJSON_COMPETITION_ONDEMAND_INSITU #endif // SIMDJSON_COMPETITION_ONDEMAND_INSITU
} // namespace find_tweet } // namespace find_tweet
#endif // SIMDJSON_COMPETITION_YYJSON #endif // SIMDJSON_COMPETITION_YYJSON
-15
View File
@@ -1,15 +0,0 @@
# Executable
add_executable(from_benchmark from_benchmark.cpp)
# Compile for C++20.
if(CMAKE_CXX_STANDARD LESS 20)
target_compile_features(from_benchmark PRIVATE cxx_std_20)
endif()
# Check if -march=native is supported
include(CheckCXXCompilerFlag)
check_cxx_compiler_flag("-march=native" SIMDJSON_SUPPORTS_MARCH_NATIVE)
if(SIMDJSON_SUPPORTS_MARCH_NATIVE)
target_compile_options(from_benchmark PRIVATE -march=native)
endif()
target_include_directories(from_benchmark PRIVATE ${CMAKE_CURRENT_LIST_DIR}/..)
-77
View File
@@ -1,77 +0,0 @@
#ifndef BENCHMARK_HELPERS_H
#define BENCHMARK_HELPERS_H
#include "event_counter.h"
#include <atomic>
event_collector collector;
template <class function_type>
std::pair<event_aggregate, size_t>
bench(const function_type &&function, size_t min_repeat = 10,
size_t min_time_ns = 40'000'000, size_t max_repeat = 10000000) {
size_t N = min_repeat;
if (N == 0) {
N = 1;
}
event_aggregate warm_aggregate{};
for (size_t i = 0; i < N; i++) {
std::atomic_thread_fence(std::memory_order_acquire);
collector.start();
function();
std::atomic_thread_fence(std::memory_order_release);
event_count allocate_count = collector.end();
warm_aggregate << allocate_count;
if ((i + 1 == N) && (warm_aggregate.total_elapsed_ns() < min_time_ns) &&
(N < max_repeat)) {
N *= 10;
}
}
event_aggregate aggregate{};
for (size_t i = 0; i < 10; i++) {
std::atomic_thread_fence(std::memory_order_acquire);
collector.start();
for (size_t i = 0; i < N; i++) {
function();
}
std::atomic_thread_fence(std::memory_order_release);
event_count allocate_count = collector.end();
aggregate << allocate_count;
}
return {aggregate, N};
}
double pretty_print(const std::string &name, size_t num_chars,
std::pair<event_aggregate, size_t> result) {
const auto &agg = result.first;
size_t N = result.second;
num_chars *= N;
printf("%-40s : %8.2f ns %8.2f GB/s", name.c_str(),
agg.elapsed_ns() / num_chars, num_chars / agg.elapsed_ns());
if (collector.has_events()) {
printf(" %8.2f GHz %8.2f cycles/char %8.2f ins./char %8.2f i/c",
agg.cycles() / agg.elapsed_ns(), agg.cycles() / num_chars,
agg.instructions() / num_chars, agg.instructions() / agg.cycles());
}
printf("\n");
return num_chars / agg.elapsed_ns();
}
double pretty_print_array(const std::string &name, size_t num_chars, size_t num_elements,
std::pair<event_aggregate, size_t> result) {
const auto &agg = result.first;
size_t N = result.second;
num_chars *= N;
printf("%-40s : %8.2f ns/char %8.2f ns/value %8.2f GB/s", name.c_str(),
agg.elapsed_ns() / num_chars, agg.elapsed_ns() / num_elements, num_chars / agg.elapsed_ns());
if (collector.has_events()) {
printf(" %8.2f GHz %8.2f cycles/char %8.2f ins./char %8.2f ins./value %8.2f i/c",
agg.cycles() / agg.elapsed_ns(), agg.cycles() / num_chars,
agg.instructions() / num_chars, agg.instructions() / num_elements, agg.instructions() / agg.cycles());
}
printf("\n");
return num_chars / agg.elapsed_ns();
}
#endif
-146
View File
@@ -1,146 +0,0 @@
#ifndef CAR_HELPERS_H
#define CAR_HELPERS_H
#include <iomanip>
#include <random>
#include <sstream>
#include <vector>
#include <simdjson.h>
struct Car {
std::string make;
std::string model;
int64_t year; // We deliberately do not include the tire pressure.
};
using namespace simdjson;
std::string random_car_json() {
static const std::vector<std::string> makes = {"Toyota", "Honda", "Ford",
"BMW", "Mazda"};
static const std::vector<std::string> models = {"Camry", "Civic", "Focus",
"320i", "3"};
static thread_local std::mt19937 rng{std::random_device{}()};
std::uniform_int_distribution<int> make_dist(0, makes.size() - 1);
std::uniform_int_distribution<int> model_dist(0, models.size() - 1);
std::uniform_int_distribution<int> year_dist(2000, 2025);
std::uniform_real_distribution<double> pressure_dist(30.0, 45.0);
std::ostringstream oss;
oss << R"({ "make": ")" << makes[make_dist(rng)] << R"(", "model": ")"
<< models[model_dist(rng)] << R"(", "year": )" << year_dist(rng)
<< R"(, "tire_pressure": [ )" << std::fixed << std::setprecision(1)
<< pressure_dist(rng) << ", " << pressure_dist(rng) << R"( ] })";
return oss.str();
}
std::string generate_car_json_stream(size_t N) {
std::ostringstream oss;
for (size_t i = 0; i < N; ++i) {
oss << random_car_json();
oss << "\n";
}
return oss.str();
}
std::string generate_car_json_array(size_t N) {
std::ostringstream oss;
oss << "[\n";
for (size_t i = 0; i < N; ++i) {
oss << random_car_json();
if (i < N - 1) {
oss << ",";
}
oss << "\n";
}
oss << "]";
return oss.str();
}
// We want to maximize C++ portability, but this is not needed with static
// reflection (C++26).
template <>
simdjson_inline simdjson_result<Car>
simdjson::ondemand::document::get() & noexcept {
ondemand::object obj;
auto error = get_object().get(obj);
if (error) {
return error;
}
Car car;
if ((error = obj["make"].get_string(car.make))) {
return error;
}
if ((error = obj["model"].get_string(car.model))) {
return error;
}
if ((error = obj["year"].get_int64().get(car.year))) {
return error;
}
return car;
}
template <>
simdjson_inline simdjson_result<Car> simdjson::ondemand::value::get() noexcept {
ondemand::object obj;
auto error = get_object().get(obj);
if (error) {
return error;
}
Car car;
if ((error = obj["make"].get_string(car.make))) {
return error;
}
if ((error = obj["model"].get_string(car.model))) {
return error;
}
if ((error = obj["year"].get_int64().get(car.year))) {
return error;
}
return car;
}
template <>
simdjson_inline simdjson_result<Car>
simdjson::ondemand::document_reference::get() & noexcept {
ondemand::object obj;
auto error = get_object().get(obj);
if (error) {
return error;
}
Car car;
if ((error = obj["make"].get_string(car.make))) {
return error;
}
if ((error = obj["model"].get_string(car.model))) {
return error;
}
if ((error = obj["year"].get_int64().get(car.year))) {
return error;
}
return car;
}
template <>
simdjson_inline simdjson_result<Car>
simdjson::ondemand::document_reference::get() && noexcept {
ondemand::object obj;
auto error = get_object().get(obj);
if (error) {
return error;
}
Car car;
if ((error = obj["make"].get_string(car.make))) {
return error;
}
if ((error = obj["model"].get_string(car.model))) {
return error;
}
if ((error = obj["year"].get_int64().get(car.year))) {
return error;
}
return car;
}
#endif
-132
View File
@@ -1,132 +0,0 @@
// We are going to assume C++20.
#include <cstdint>
#include <cstdio>
#include <cstdlib>
#include <simdjson.h>
#include <string>
#include "benchmark_helpers.h"
#include "car_helpers.h"
using namespace simdjson;
void run_benchmarks() {
printf("Running benchmarks on tiny input...\n");
simdjson::padded_string json =
R"({ "make": "Toyota", "model": "Camry", "year": 2018, "tire_pressure": [ 40.1, 39.9 ] })"_padded;
volatile size_t dummy = 0;
ondemand::parser parser;
// Classic On-Demand
pretty_print("simdjson classic", json.size(),
bench([&json, &dummy, &parser]() {
ondemand::document doc = parser.iterate(json);
Car car = doc.get<Car>();
dummy = dummy + car.year;
}));
// Benchmark simdjson::from() without parser
pretty_print("simdjson::from<Car>() (no parser)", json.size(),
bench([&json, &dummy]() {
Car car = simdjson::from(json);
dummy = dummy + car.year;
}));
// Benchmark simdjson::from() with parser
pretty_print("simdjson::from<Car>() (with parser)", json.size(),
bench([&json, &dummy, &parser]() {
Car car = simdjson::from(parser, json);
dummy = dummy + car.year;
}));
}
void run_array_benchmarks() {
printf("Running benchmarks on large array...\n");
size_t N = 1'000'000;
simdjson::padded_string json = generate_car_json_array(N);
volatile size_t dummy = 0;
ondemand::parser parser;
// Classic On-Demand
pretty_print_array("simdjson classic", json.size(), N,
bench([&json, &dummy, &parser]() {
dummy = 0;
ondemand::document doc = parser.iterate(json);
ondemand::array array = doc.get_array();
for (auto value : array) {
Car car = value.get<Car>();
dummy = dummy + car.year;
}
}));
// from with array
pretty_print_array("simdjson::from(json).array()", json.size(), N,
bench([&json, &dummy, &parser]() {
dummy = 0;
for (auto value : simdjson::from(json).array()) {
Car car = value.get<Car>();
dummy = dummy + car.year;
}
}));
#if SIMDJSON_SUPPORTS_RANGES_FROM
// Benchmark simdjson::from() without parser (EXPERIMENTAL)
pretty_print_array("simdjson::from<Car>() (experimental, no parser)",
json.size(), N, bench([&json, &dummy]() {
dummy = 0;
for (Car car :
simdjson::from(json) | simdjson::as<Car>()) {
dummy = dummy + car.year;
}
}));
// Benchmark simdjson::from() with parser (EXPERIMENTAL)
pretty_print_array("simdjson::from<Car>() (experimental, with parser)",
json.size(), N, bench([&json, &dummy, &parser]() {
dummy = 0;
for (Car car : simdjson::from(parser, json) |
simdjson::as<Car>()) {
dummy = dummy + car.year;
}
}));
#endif // SIMDJSON_SUPPORTS_RANGES_FROM
}
void run_stream_benchmarks() {
printf("Running stream benchmarks...\n");
simdjson::padded_string json = generate_car_json_stream(1'000'000);
volatile size_t dummy = 0;
ondemand::parser parser;
// Classic On-Demand
pretty_print("simdjson classic", json.size(),
bench([&json, &dummy, &parser]() {
ondemand::document_stream stream = parser.iterate_many(json);
for (auto doc : stream) {
Car car = doc.get<Car>();
dummy = dummy + car.year;
}
}));
// from_many
pretty_print("simdjson with thread local", json.size(),
bench([&json, &dummy, &parser]() {
ondemand::document_stream stream =
ondemand::parser::get_parser().iterate_many(json);
for (auto doc : stream) {
Car car = doc.get<Car>();
dummy = dummy + car.year;
}
}));
}
int main() {
for (size_t trial = 0; trial < 3; trial++) {
printf("Trial %zu:\n", trial + 1);
run_array_benchmarks();
run_stream_benchmarks();
run_benchmarks();
printf("\n");
}
return EXIT_SUCCESS;
}
+1 -5
View File
@@ -9,11 +9,7 @@ simdjson_never_inline
double bench(std::string filename, simdjson::padded_string& p) { double bench(std::string filename, simdjson::padded_string& p) {
std::chrono::time_point<std::chrono::steady_clock> start_clock = std::chrono::time_point<std::chrono::steady_clock> start_clock =
std::chrono::steady_clock::now(); std::chrono::steady_clock::now();
auto error = simdjson::padded_string::load(filename).get(p); simdjson::padded_string::load(filename).value_unsafe().swap(p);
if(error) {
std::cerr << simdjson::error_message(error) << std::endl;
std::abort();
}
std::chrono::time_point<std::chrono::steady_clock> end_clock = std::chrono::time_point<std::chrono::steady_clock> end_clock =
std::chrono::steady_clock::now(); std::chrono::steady_clock::now();
std::chrono::duration<double> elapsed = end_clock - start_clock; std::chrono::duration<double> elapsed = end_clock - start_clock;
-2
View File
@@ -100,7 +100,6 @@ struct yyjson : yyjson2msgpack {
std::string_view &result) { std::string_view &result) {
yyjson_doc *doc = yyjson_read(json.data(), json.size(), 0); yyjson_doc *doc = yyjson_read(json.data(), json.size(), 0);
result = to_msgpack(doc, reinterpret_cast<uint8_t*>(buffer)); result = to_msgpack(doc, reinterpret_cast<uint8_t*>(buffer));
yyjson_doc_free(doc);
return true; return true;
} }
}; };
@@ -114,7 +113,6 @@ struct yyjson_insitu : yyjson2msgpack {
yyjson_doc *doc = yyjson_doc *doc =
yyjson_read_opts(json.data(), json.size(), YYJSON_READ_INSITU, 0, 0); yyjson_read_opts(json.data(), json.size(), YYJSON_READ_INSITU, 0, 0);
result = to_msgpack(doc, reinterpret_cast<uint8_t*>(buffer)); result = to_msgpack(doc, reinterpret_cast<uint8_t*>(buffer));
yyjson_doc_free(doc);
return true; return true;
} }
}; };
+2 -10
View File
@@ -49,26 +49,18 @@ struct yyjson_base {
struct yyjson : yyjson_base { struct yyjson : yyjson_base {
bool run(simdjson::padded_string &json, std::vector<point> &result) { bool run(simdjson::padded_string &json, std::vector<point> &result) {
yyjson_doc *doc = yyjson_read(json.data(), json.size(), 0); return yyjson_base::run(yyjson_read(json.data(), json.size(), 0), result);
bool b = yyjson_base::run(doc, result);
yyjson_doc_free(doc);
return b;
} }
}; };
BENCHMARK_TEMPLATE(kostya, yyjson)->UseManualTime(); BENCHMARK_TEMPLATE(kostya, yyjson)->UseManualTime();
#if SIMDJSON_COMPETITION_ONDEMAND_INSITU #if SIMDJSON_COMPETITION_ONDEMAND_INSITU
struct yyjson_insitu : yyjson_base { struct yyjson_insitu : yyjson_base {
bool run(simdjson::padded_string &json, std::vector<point> &result) { bool run(simdjson::padded_string &json, std::vector<point> &result) {
yyjson_doc *doc = yyjson_read_opts(json.data(), json.size(), YYJSON_READ_INSITU, 0, 0); return yyjson_base::run(yyjson_read_opts(json.data(), json.size(), YYJSON_READ_INSITU, 0, 0), result);
bool b = yyjson_base::run(doc, result);
yyjson_doc_free(doc);
return b;
} }
}; };
BENCHMARK_TEMPLATE(kostya, yyjson_insitu)->UseManualTime(); BENCHMARK_TEMPLATE(kostya, yyjson_insitu)->UseManualTime();
#endif // SIMDJSON_COMPETITION_ONDEMAND_INSITU #endif // SIMDJSON_COMPETITION_ONDEMAND_INSITU
} // namespace kostya } // namespace kostya
#endif // SIMDJSON_COMPETITION_YYJSON #endif // SIMDJSON_COMPETITION_YYJSON
+2 -10
View File
@@ -47,26 +47,18 @@ struct yyjson_base {
struct yyjson : yyjson_base { struct yyjson : yyjson_base {
bool run(simdjson::padded_string &json, std::vector<point> &result) { bool run(simdjson::padded_string &json, std::vector<point> &result) {
yyjson_doc *doc = yyjson_read(json.data(), json.size(), 0); return yyjson_base::run(yyjson_read(json.data(), json.size(), 0), result);
bool b = yyjson_base::run(doc, result);
yyjson_doc_free(doc);
return b;
} }
}; };
BENCHMARK_TEMPLATE(large_random, yyjson)->UseManualTime(); BENCHMARK_TEMPLATE(large_random, yyjson)->UseManualTime();
#if SIMDJSON_COMPETITION_ONDEMAND_INSITU #if SIMDJSON_COMPETITION_ONDEMAND_INSITU
struct yyjson_insitu : yyjson_base { struct yyjson_insitu : yyjson_base {
bool run(simdjson::padded_string &json, std::vector<point> &result) { bool run(simdjson::padded_string &json, std::vector<point> &result) {
yyjson_doc *doc = yyjson_read_opts(json.data(), json.size(), YYJSON_READ_INSITU, 0, 0); return yyjson_base::run(yyjson_read_opts(json.data(), json.size(), YYJSON_READ_INSITU, 0, 0), result);
bool b = yyjson_base::run(doc, result);
yyjson_doc_free(doc);
return b;
} }
}; };
BENCHMARK_TEMPLATE(large_random, yyjson_insitu)->UseManualTime(); BENCHMARK_TEMPLATE(large_random, yyjson_insitu)->UseManualTime();
#endif // SIMDJSON_COMPETITION_ONDEMAND_INSITU #endif // SIMDJSON_COMPETITION_ONDEMAND_INSITU
} // namespace large_random } // namespace large_random
#endif // SIMDJSON_COMPETITION_YYJSON #endif // SIMDJSON_COMPETITION_YYJSON
+3 -10
View File
@@ -62,26 +62,19 @@ struct yyjson_base {
struct yyjson : yyjson_base { struct yyjson : yyjson_base {
bool run(simdjson::padded_string &json, std::vector<tweet<std::string_view>> &result) { bool run(simdjson::padded_string &json, std::vector<tweet<std::string_view>> &result) {
yyjson_doc *doc = yyjson_read(json.data(), json.size(), 0); return yyjson_base::run(yyjson_read(json.data(), json.size(), 0), result);
bool b = yyjson_base::run(doc, result);
yyjson_doc_free(doc);
return b;
} }
}; };
BENCHMARK_TEMPLATE(partial_tweets, yyjson)->UseManualTime(); BENCHMARK_TEMPLATE(partial_tweets, yyjson)->UseManualTime();
#if SIMDJSON_COMPETITION_ONDEMAND_INSITU #if SIMDJSON_COMPETITION_ONDEMAND_INSITU
struct yyjson_insitu : yyjson_base { struct yyjson_insitu : yyjson_base {
bool run(simdjson::padded_string &json, std::vector<tweet<std::string_view>> &result) { bool run(simdjson::padded_string &json, std::vector<tweet<std::string_view>> &result) {
yyjson_doc *doc = yyjson_read_opts(json.data(), json.size(), YYJSON_READ_INSITU, 0, 0); return yyjson_base::run(yyjson_read_opts(json.data(), json.size(), YYJSON_READ_INSITU, 0, 0), result);
bool b = yyjson_base::run(doc, result);
yyjson_doc_free(doc);
return b;
} }
}; };
BENCHMARK_TEMPLATE(partial_tweets, yyjson_insitu)->UseManualTime(); BENCHMARK_TEMPLATE(partial_tweets, yyjson_insitu)->UseManualTime();
#endif // SIMDJSON_COMPETITION_ONDEMAND_INSITU #endif // SIMDJSON_COMPETITION_ONDEMAND_INSITU
} // namespace partial_tweets } // namespace partial_tweets
#endif // SIMDJSON_COMPETITION_YYJSON #endif // SIMDJSON_COMPETITION_YYJSON
+10 -14
View File
@@ -6,27 +6,26 @@ CPMAddPackage(
EXCLUDE_FROM_ALL YES EXCLUDE_FROM_ALL YES
) )
option(SIMDJSON_USE_RUST "Build the static_reflect benchmark" OFF)
if(SIMDJSON_USER_RUST)
if(NOT WIN32) if(NOT WIN32)
# We want the check whether Rust is available before trying to build a crate. # We want the check whether Rust is available before trying to build a crate.
CPMAddPackage( CPMAddPackage(
NAME corrosion NAME corrosion
GITHUB_REPOSITORY corrosion-rs/corrosion GITHUB_REPOSITORY corrosion-rs/corrosion
VERSION 0.4.4 VERSION 0.4.4
DOWNLOAD_ONLY ON DOWNLOAD_ONLY ON
OPTIONS "Rust_FIND_QUIETLY OFF" OPTIONS "Rust_FIND_QUIETLY OFF"
) )
include("${corrosion_SOURCE_DIR}/cmake/FindRust.cmake") include("${corrosion_SOURCE_DIR}/cmake/FindRust.cmake")
endif() endif()
if(RUST_FOUND) if(RUST_FOUND)
message(STATUS "Rust found: " ${Rust_VERSION} ) message(STATUS "Rust found: " ${Rust_VERSION} )
add_subdirectory("${corrosion_SOURCE_DIR}" "${PROJECT_BINARY_DIR}/_deps/corrosion" EXCLUDE_FROM_ALL) add_subdirectory("${corrosion_SOURCE_DIR}" "${PROJECT_BINARY_DIR}/_deps/corrosion" EXCLUDE_FROM_ALL)
# Important: we want to build in release mode! # Important: we want to build in release mode!
corrosion_import_crate(MANIFEST_PATH "serde-benchmark/Cargo.toml" NO_LINKER_OVERRIDE PROFILE release) corrosion_import_crate(MANIFEST_PATH "serde-benchmark/Cargo.toml" NO_LINKER_OVERRIDE PROFILE release)
else() else()
message(STATUS "Rust/Cargo is unavailable." ) message(STATUS "Rust/Cargo is unavailable." )
message(STATUS "We will not benchmark serde-benchmark." ) message(STATUS "We will not benchmark serde-benchmark." )
if (${CMAKE_SYSTEM_NAME} MATCHES "Darwin") if (${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
@@ -38,10 +37,7 @@ if(SIMDJSON_USER_RUST)
message(STATUS "or" ) message(STATUS "or" )
message(STATUS "curl https://sh.rustup.rs -sSf | sh") message(STATUS "curl https://sh.rustup.rs -sSf | sh")
endif() endif()
endif() endif()
else(SIMDJSON_USER_RUST)
message(STATUS "We will not benchmark serde-benchmark." )
endif(SIMDJSON_USER_RUST)
# Add the benchmark executable targets # Add the benchmark executable targets
add_subdirectory(twitter_benchmark) add_subdirectory(twitter_benchmark)
+2 -10
View File
@@ -51,26 +51,18 @@ struct yyjson_base {
struct yyjson : yyjson_base { struct yyjson : yyjson_base {
bool run(simdjson::padded_string &json, int64_t max_retweet_count, top_tweet_result<StringType> &result) { bool run(simdjson::padded_string &json, int64_t max_retweet_count, top_tweet_result<StringType> &result) {
yyjson_doc *doc = yyjson_read(json.data(), json.size(), 0); return yyjson_base::run(yyjson_read(json.data(), json.size(), 0), max_retweet_count, result);
bool b = yyjson_base::run(doc, max_retweet_count, result);
yyjson_doc_free(doc);
return b;
} }
}; };
BENCHMARK_TEMPLATE(top_tweet, yyjson)->UseManualTime(); BENCHMARK_TEMPLATE(top_tweet, yyjson)->UseManualTime();
#if SIMDJSON_COMPETITION_ONDEMAND_INSITU #if SIMDJSON_COMPETITION_ONDEMAND_INSITU
struct yyjson_insitu : yyjson_base { struct yyjson_insitu : yyjson_base {
bool run(simdjson::padded_string &json, int64_t max_retweet_count, top_tweet_result<StringType> &result) { bool run(simdjson::padded_string &json, int64_t max_retweet_count, top_tweet_result<StringType> &result) {
yyjson_doc *doc = yyjson_read_opts(json.data(), json.size(), YYJSON_READ_INSITU, 0, 0); return yyjson_base::run(yyjson_read_opts(json.data(), json.size(), YYJSON_READ_INSITU, 0, 0), max_retweet_count, result);
bool b = yyjson_base::run(doc, max_retweet_count, result);
yyjson_doc_free(doc);
return b;
} }
}; };
BENCHMARK_TEMPLATE(top_tweet, yyjson_insitu)->UseManualTime(); BENCHMARK_TEMPLATE(top_tweet, yyjson_insitu)->UseManualTime();
#endif // SIMDJSON_COMPETITION_ONDEMAND_INSITU #endif // SIMDJSON_COMPETITION_ONDEMAND_INSITU
} // namespace top_tweet } // namespace top_tweet
#endif // SIMDJSON_COMPETITION_YYJSON #endif // SIMDJSON_COMPETITION_YYJSON
+1 -8
View File
@@ -4,7 +4,7 @@
add_library(simdjson-internal-flags INTERFACE) add_library(simdjson-internal-flags INTERFACE)
if(NOT DEFINED CMAKE_POSITION_INDEPENDENT_CODE) if(NOT DEFINED CMAKE_POSITION_INDEPENDENT_CODE)
# We default to ON for all targets, so that we can use the library in shared libraries. # We default to ON for all targets, so that we can use the library in shared libraries.
set_target_properties(simdjson-internal-flags PROPERTIES INTERFACE_POSITION_INDEPENDENT_CODE ON) set_target_properties(simdjson-internal-flags PROPERTIES POSITION_INDEPENDENT_CODE ON)
endif(NOT DEFINED CMAKE_POSITION_INDEPENDENT_CODE) endif(NOT DEFINED CMAKE_POSITION_INDEPENDENT_CODE)
option(SIMDJSON_CHECK_EOF "Check for the end of the input buffer. The setting is unnecessary since we require padding of the inputs. You should expect tests to fail with this option turned on." OFF) option(SIMDJSON_CHECK_EOF "Check for the end of the input buffer. The setting is unnecessary since we require padding of the inputs. You should expect tests to fail with this option turned on." OFF)
@@ -32,9 +32,6 @@ undefined behavior.")
link_libraries( link_libraries(
-fsanitize=address -fno-omit-frame-pointer -fno-sanitize-recover=all -fsanitize=address -fno-omit-frame-pointer -fno-sanitize-recover=all
) )
elseif (CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
add_compile_options(-fsanitize=address)
link_libraries(-fsanitize=address)
else() else()
message( message(
STATUS STATUS
@@ -174,10 +171,6 @@ else()
-Werror -Wall -Wextra -Weffc++ -Wsign-compare -Wshadow -Wwrite-strings -Werror -Wall -Wextra -Weffc++ -Wsign-compare -Wshadow -Wwrite-strings
-Wpointer-arith -Winit-self -Wconversion -Wno-sign-conversion -Wpointer-arith -Winit-self -Wconversion -Wno-sign-conversion
) )
if(CMAKE_CXX_STANDARD VERSION_GREATER_EQUAL 20)
target_compile_options(simdjson-internal-flags INTERFACE -Wctad-maybe-unsupported)
endif()
endif() endif()
option(SIMDJSON_GLIBCXX_ASSERTIONS "Set _GLIBCXX_ASSERTIONS" OFF) option(SIMDJSON_GLIBCXX_ASSERTIONS "Set _GLIBCXX_ASSERTIONS" OFF)
+1 -2
View File
@@ -17,9 +17,8 @@ editing CMAKE_CXX_FLAGS")
# /EHc used in conjection with /EHs indicates that extern "C" functions # /EHc used in conjection with /EHs indicates that extern "C" functions
# never throw (terminate-on-throw) # never throw (terminate-on-throw)
# Here, we disable both with the - argument negation operator # Here, we disable both with the - argument negation operator
if(CMAKE_CXX_FLAGS)
string(REPLACE "/EHsc" "/EHs-c-" CMAKE_CXX_FLAGS ${CMAKE_CXX_FLAGS}) string(REPLACE "/EHsc" "/EHs-c-" CMAKE_CXX_FLAGS ${CMAKE_CXX_FLAGS})
endif()
# Because we cannot change the flag above on an individual target (yet), the # Because we cannot change the flag above on an individual target (yet), the
# definition below must similarly be added globally # definition below must similarly be added globally
add_definitions(-D_HAS_EXCEPTIONS=0) add_definitions(-D_HAS_EXCEPTIONS=0)
@@ -1,4 +0,0 @@
set(CMAKE_SYSTEM_NAME Linux)
set(CMAKE_SYSTEM_PROCESSOR riscv64)
set(CMAKE_CROSSCOMPILING_EMULATOR "qemu-riscv64-static")
+171 -494
View File
File diff suppressed because it is too large Load Diff
+3 -6
View File
@@ -1,8 +1,5 @@
We take our documentation seriously. Please start reading the documentation before you attempt to use simdjson. We hope you will enjoy reading us. We take our documentation seriously. Please start reading the documentation before you attempt to use simdjson. We hope you will enjoy reading us.
* [Basics](doc/basics.md) is an overview of how to use simdjson and its APIs. * Basics: https://github.com/simdjson/simdjson/blob/master/doc/basics.md is an overview of how to use simdjson and its APIs.
* [Builder](doc/builder.md) is an overview of how to efficiently write JSON strings using simdjson. * iterate_many: https://github.com/simdjson/simdjson/blob/master/doc/iterate_many.md describes an interface providing features to work with files or streams containing multiple small JSON documents. As fast and convenient as possible.
* [Performance](doc/performance.md) shows some more advanced scenarios and how to tune for them. * Performance: https://github.com/simdjson/simdjson/blob/master/doc/performance.md shows some more advanced scenarios and how to tune for them.
* [Implementation Selection](doc/implementation-selection.md) describes runtime CPU detection and
how you can work with it.
* [API](https://simdjson.github.io/simdjson/) contains the automatically generated API documentation.
+23 -257
View File
@@ -4,29 +4,16 @@ Builder
Sometimes you want to generate JSON string outputs efficiently. Sometimes you want to generate JSON string outputs efficiently.
The simdjson library provides high-performance low-level facilities. The simdjson library provides high-performance low-level facilities.
When using these low-level functionalities, you are responsible to When using these low-level functionalities, you are responsible to
define the structure of your JSON document. Our more advanced interface define the structure of your JSON document. However, string escaping
automates the process using C++26 static reflection: you get both high and UTF-8 validation is automated.
speed and high convenience.
- [Builder](#builder)
* [Overview: string_builder](#overview--string-builder)
* [Example: string_builder](#example--string-builder)
* [C++26 static reflection](#c--26-static-reflection)
+ [Without `string_buffer` instance](#without--string-buffer--instance)
+ [Without `string_buffer` instance but with explicit error handling](#without--string-buffer--instance-but-with-explicit-error-handling)
Overview: string_builder Overview: string_builder
--------------------------- ---------------------------
The string_builder class is a low-level utility for constructing JSON strings representing documents. It is optimized for performance, potentially leveraging kernel-specific features like SIMD instructions for tasks such as string escaping. This class supports atomic types (e.g., booleans, numbers, strings) but does not handle composed types directly (like arrays or objects). The string_builder class is a low-level utility for constructing JSON strings representing documents. It is optimized for performance, potentially leveraging kernel-specific features like SIMD instructions for tasks such as string escaping. This class supports atomic types (e.g., booleans, numbers, strings) but does not handle composed types directly (like arrays or objects).
Note that JSON strings are always encoded as UTF-8.
An `string_builder` is created with an initial buffer capacity (e.g., 1kB). The memory An `string_builder` is created with an initial buffer capacity (e.g., 1kB). The memory
is reallocated when needed. is reallocated when needed. It has the following methods to add content to the string:
The efficiency of `string_builder` stems from its internal use of a resizable array or buffer. When you append data, it adds the characters to this buffer, resizing it only when necessary, typically in a way that minimizes reallocations. This approach contrasts with regular string concatenation, where each operation creates a new string, copying all previous content, leading to quadratic time complexity for repeated concatenations.
It has the following methods to add content to the string:
- `append(number_type v)`: Appends a number (including booleans) to the JSON buffer. Booleans are converted to the strings "false" or "true". Numbers are formatted according to the JSON standard, with floating-point numbers using the shortest representation that accurately reflects the value. - `append(number_type v)`: Appends a number (including booleans) to the JSON buffer. Booleans are converted to the strings "false" or "true". Numbers are formatted according to the JSON standard, with floating-point numbers using the shortest representation that accurately reflects the value.
@@ -34,41 +21,31 @@ It has the following methods to add content to the string:
- `append_null()`: Appends the string "null" to the JSON buffer. - `append_null()`: Appends the string "null" to the JSON buffer.
- `clear()`: Clears the contents of the JSON buffer, resetting the position to 0 while retaining the allocated capacity. - `clear()`: Clears the contents of the JSON buffer, resetting the position to 0 while retaining the allocated capacity.
- `escape_and_append(std::string_view input)`: Appends a string view to the JSON buffer after escaping special characters (e.g., quotes, backslashes) as required by JSON. - `escape_and_append(std::string_view input)`: Appends a string view to the JSON buffer after escaping special characters (e.g., quotes, backslashes) as required by JSON.
- `escape_and_append_with_quotes(std::string_view input)` Appends a string view surrounded by double quotes (e.g., "input") to the JSON buffer after escaping special characters. For constant strings, you may also do `escape_and_append_with_quotes<"mystring">()`. - `escape_and_append_with_quotes(std::string_view input)` Appends a string view surrounded by double quotes (e.g., "input") to the JSON buffer after escaping special characters.
Parameters:
- `escape_and_append_with_quotes(char input)`: Appends a single character surrounded by double quotes (e.g., "c") to the JSON buffer after escaping it if necessary. - `escape_and_append_with_quotes(char input)`: Appends a single character surrounded by double quotes (e.g., "c") to the JSON buffer after escaping it if necessary.
- `append_raw(const char *c)`: Appends a null-terminated C string directly to the JSON buffer without escaping. - `append_raw(const char *c)`: Appends a null-terminated C string directly to the JSON buffer without escaping.
- `append_raw(std::string_view input)`: Appends a string view directly to the JSON buffer without escaping. - `append_raw(std::string_view input)`: Appends a string view directly to the JSON buffer without escaping.
- `append_raw(const char *str, size_t len)`: Appends a specified number of characters from a C string directly to the JSON - `append_raw(const char *str, size_t len)`: Appends a specified number of characters from a C string directly to the JSON
- `append_key_value(key,value)`: Appends a key and a value (`"json":somevalue`)
- `append_key_value<"mykey">(value)`: Appends a key and a value (`"json":somevalue`), useful when the key is a compile-time constant (C++20).
After writing the content, if you have reasons to believe that the content might violate UTF-8 conventions, you can check it as follows: After writting the content, if you have reasons to believe that the content might violate UTF-8 conventions, you can check it as follows:
- `validate_unicode()`: Checks if the content in the JSON buffer is valid UTF-8. Returns: true if the content is valid UTF-8, false otherwise. - `validate_unicode()`: Checks if the content in the JSON buffer is valid UTF-8. Returns: true if the content is valid UTF-8, false otherwise.
You might need to do unicode validation if you have strings in your data structures containing
malformed UTF-8. Note that we do not automatically call `validate_unicode()`.
Once you are satisfied, you can recover the string as follows: Once you are satisfied, you can recover the string as follows:
- `operator std::string()`: Converts the JSON buffer to an std::string. (Might throw if an error occurred.) - `operator std::string()`: Converts the JSON buffer to an std::string. (Might throw if an error occurred.)
- `operator std::string_view()`: Converts the JSON buffer to an std::string_view. (Might throw if an error occurred.) - `operator std::string_view()`: Converts the JSON buffer to an std::string_view. (Might throw if an error occurred.)
- `view()`: Returns a view of the written JSON buffer as a `simdjson_result<std::string_view>` (C++20). - `view()`: Returns a view of the written JSON buffer as a `simdjson_result<std::string_view>`.
The later method (`view()`) is recommended. For performance reasons, we expect you to explicitly call `validate_unicode()` as needed (e.g., prior to calling `view()`). The later method (`view()`) is recommended.
Example: string_builder Example: string_builder
--------------------------- ---------------------------
```cpp ```C++
struct Car {
std::string make;
std::string model;
int64_t year;
std::vector<double> tire_pressure;
};
void serialize_car(const Car& car, simdjson::builder::string_builder& builder) { void serialize_car(const Car& car, simdjson::builder::string_builder& builder) {
// start of JSON // start of JSON
builder.start_object(); builder.start_object();
@@ -97,136 +74,25 @@ void serialize_car(const Car& car, simdjson::builder::string_builder& builder) {
} }
builder.end_array(); builder.end_array();
builder.end_object(); builder.end_object();
} }
bool car_test() { bool car_test() {
simdjson::builder::string_builder sb; simdjson::builder::string_builder sb;
Car c = {"Toyota", "Corolla", 2017, {30.0,30.2,30.513,30.79}}; Car c = {"Toyota", "Corolla", 2017, {30.0,30.2,30.513,30.79}};
serialize_car(c, sb); serialize_car(c, sb);
std::string_view p{sb};
// p holds the JSON:
// "{\"make\":\"Toyota\",\"model\":\"Corolla\",\"year\":2017,\"tire_pressure\":[30.0,30.2,30.513,30.79]}"
return true;
}
```
The `string_builder` constructor takes an optional parameter which specifies the initial
memory allocation in byte. If you know approximately the size of your JSON output, you can
pass this value as a parameter (e.g., `simdjson::builder::string_builder sb{1233213}`).
The `string_builder` might throw an exception in case of error when you cast it result to `std::string_view`. If you wish to avoid exceptions, you can use the following programming pattern:
```cpp
std::string_view p; std::string_view p;
if(sb.view().get(p)) { if(sb.view().get(p)) {
return false; // there was an error return false; // there was an error
} }
``` // p holds the JSON:
// "{\"make\":\"Toyota\",\"model\":\"Corolla\",\"year\":2017,\"tire_pressure\":[30.0,30.2,30.513,30.79]}"
In all cases, the `std::string_view` instance depends the corresponding `string_builder` instance. return true;
}
### C++20
If you have C++20, you can simplify the code, as the `std::vector<double>` is automatically supported. Further, we can pass the keys (which are compile-time
constant) as template parameter (for improved performance).
```cpp
Car c = {"Toyota", "Corolla", 2017, {30.0,30.2,30.513,30.79}};
simdjson::builder::string_builder sb;
sb.start_object();
sb.append_key_value<"make">(c.make);
sb.append_comma();
sb.append_key_value<"model">(c.model);
sb.append_comma();
sb.append_key_value<"year">(c.year);
sb.append_comma();
sb.append_key_value<"tire_pressure">(c.tire_pressure);
sb.end_object();
std::string_view p = sb.view();
```
With C++20, you can similarly handle standard containers transparently.
For example, you can serialize `std::map<std::string,T>` types.
```cpp
std::map<std::string,double> c = {{"key1", 1}, {"key2", 1}};
simdjson::builder::string_builder sb;
sb.append(c);
std::string_view p = sb.view();
```
You can also serialize `std::vector<T>` types.
```cpp
std::vector<std::vector<double>> c = {{1.0, 2.0}, {3.0, 4.0}};
simdjson::builder::string_builder sb;
sb.append(c);
std::string_view p = sb.view();
```
You can also skip the creation for the `string_builder` instance in such simple cases.
```cpp
std::vector<std::vector<double>> c = {{1.0, 2.0}, {3.0, 4.0}};
std::string json = simdjson::to_json(c);
```
We also have an overload for when you want to reuse the same `std::string` instance:
```cpp
std::vector<std::vector<double>> c = {{1.0, 2.0}, {3.0, 4.0}};
std::string json;
auto error = simdjson::to_json(c, json);
if(error) { /* there was an error */ }
```
We do recommend that you create and reuse the `string_builder` instance for performance
reasons.
You can also add custom serialization functions using a `tag_invoke` function.
For example, the following
function will allow you to serialize instances of the type `Car`.
```cpp
#include <simdjson>
struct Car {
std::string make;
std::string model;
int64_t year;
std::vector<float> tire_pressure;
};
namespace simdjson {
template <typename builder_type>
void tag_invoke(serialize_tag, builder_type &builder, const Car& car) {
builder.start_object();
builder.append_key_value("make", car.make);
builder.append_comma();
builder.append_key_value("model", car.model);
builder.append_comma();
builder.append_key_value("year", car.year);
builder.append_comma();
builder.append_key_value("tire_pressure", car.tire_pressure);
builder.end_object();
}
} // namespace simdjson
``` ```
C++26 static reflection C++26 static reflection
------------------------ ------------------------
Static reflection (or compile-time reflection) in C++26 introduces a powerful compile-time mechanism that allows a program to inspect and manipulate its own structure, such as types, variables, functions, and other program elements, during compilation. Unlike runtime reflection in languages like Java or Python, C++26s static reflection operates entirely at compile time, aligning with C++s emphasis on zero-overhead abstractions and high performance. It means
that you can delegate much of the work to the library.
If you have a compiler with support C++26 static reflection, you can compile If you have a compiler with support C++26 static reflection, you can compile
your code with the `SIMDJSON_STATIC_REFLECTION` macro set: your code with the `SIMDJSON_STATIC_REFLECTION` macro set:
@@ -240,127 +106,27 @@ And then you can append your data structures to a `string_builder` instance
automatically. In most cases, it should work automatically: automatically. In most cases, it should work automatically:
```cpp ```cpp
struct Car {
std::string make;
std::string model;
int64_t year;
std::vector<double> tire_pressure;
};
bool car_test() { bool car_test() {
simdjson::builder::string_builder sb; simdjson::builder::string_builder sb;
Car c = {"Toyota", "Corolla", 2017, {30.0,30.2,30.513,30.79}}; Car c = {"Toyota", "Corolla", 2017, {30.0,30.2,30.513,30.79}};
sb << c; append(sb, c);
std::string_view p{sb}; std::string_view p;
if(sb.view().get(p)) {
return false; // there was an error
}
// p holds the JSON: // p holds the JSON:
// "{\"make\":\"Toyota\",\"model\":\"Corolla\",\"year\":2017,\"tire_pressure\":[30.0,30.2,30.513,30.79]}" // "{\"make\":\"Toyota\",\"model\":\"Corolla\",\"year\":2017,\"tire_pressure\":[30.0,30.2,30.513,30.79]}"
return true; return true;
} }
``` ```
If you prefer, you can also create a string directly:
### Without `string_buffer` instance
In some instances, you might want to create a string directly from your own data type.
You can create a string directly, without an explicit `string_builder` instance
with the `simdjson::to_json` template function.
(Under the hood a `string_builder` instance may still be created.)
```cpp
struct Car {
std::string make;
std::string model;
int64_t year;
std::vector<double> tire_pressure;
};
void f() {
Car c = {"Toyota", "Corolla", 2017, {30.0,30.2,30.513,30.79}};
std::string json = simdjson::to_json(c);
}
```
If you know the output size, in bytes, of your JSON string, you may
pass it as a second parameter (e.g., `simdjson::to_json(c, 31123)`).
Sometimes you may want to reuse the same `std::string` instance. We
have an overload for this purpose:
```cpp
Car c = {"Toyota", "Corolla", 2017, {30.0,30.2,30.513,30.79}};
std::string s;
auto error = simdjson::to_json(c, s);
if(error) { /* there was an error */ }
```
You can then also add a third parameter for the expected output size in bytes.
### Extracting just some fields
In some instances, your class might have many fields that you do not want to serialize.
You can achieve this result with the `simdjson::extract_from` template. In the following
example, we serialize only the `year` and `price` fields on the `Car` instance.
```cpp
struct Car {
std::string make;
std::string model;
int year;
double price;
bool electric;
};
Car car{"Ford", "F-150", 2024, 55000.0, false};
// Extract year and price
std::string json_result = simdjson::extract_from<"year", "price">(car);
// Alternatively:
// std::string json_result;
// auto error = extract_from<"year", "price">(car).get(json_result);
// if(error) { /* error handling */ }
```
### Without `string_buffer` instance but with explicit error handling
If prefer a version without exceptions and explicit error handling, you can use the following
pattern:
```cpp ```cpp
std::string json; std::string json;
if(simdjson::to_json(c).get(json)) { if(simdjson::builder::to_json_string(c).get(json)) {
// there was an error // there was an error
} else { } else {
// json contain the serialized JSON // json contain the serialized JSON
} }
``` ```
### Customization
If you want to serialize a value in a custome way, you can do it with a
`tag_invoke` specialization like the following example which will map
the year attribute to a string.
```cpp
#include <simdjson>
struct Car {
std::string make;
std::string model;
int64_t year;
std::vector<float> tire_pressure;
};
namespace simdjson {
template <typename builder_type>
void tag_invoke(serialize_tag, builder_type &builder, const Car& car) {
builder.start_object();
builder.append_key_value("make", car.make);
builder.append_comma();
builder.append_key_value("model", car.model);
builder.append_comma();
builder.append_key_value("year", std::to_string(car.year));
builder.append_comma();
builder.append_key_value("tire_pressure", car.tire_pressure);
builder.end_object();
}
} // namespace simdjson
```
-227
View File
@@ -1,227 +0,0 @@
# Parse json at compile time
* [Introduction](#introduction)
* [Example](#example)
* [Concepts](#concepts)
* [Loading from disk](#loading-from-disk)
* [Limitations (compile-time errors)](#limitations-compile-time-errors)
## Introduction
In some instances, you may want to configure your software at compile-time with a JSON document.
Maybe you have a single code base but many different possible configurations, all resulting in
different software. For example, you might be programming robots, using the same software, but
different robot configurations.
To achieve the desired result, you have a few options. You may start the software and parser a
JSON file at runtime. Or you might convert your JSON data into C++ code that you can compile with
your software.
With C++26, there is another way: parse the JSON file along with your C++ code. In this manner,
the JSON data becomes native C++ data.
The simdjson library supports parsing JSON documents at compile time if you have C++26 support. To
activate C++26 reflection support, you can compile
your code with the `SIMDJSON_STATIC_REFLECTION` macro set:
```cpp
#define SIMDJSON_STATIC_REFLECTION 1
//...
#include "simdjson.h"
```
The `simdjson::compile_time::parse_json` function parses a JSON document at **compile time** and returns a `constexpr` structure reflecting its content. We support the full range of JSON values, which are mapped to C++ types as in
the following table.
| JSON type | C++ type |
|----------------|----------------------------------|
| object | anonymous struct |
| array | `std::array<T, N>` (homogeneous) |
| string | `const char*` (UTF-8) |
| number | `int64_t`, `uint64_t`, `double` |
| `true`/`false` | `bool` |
| `null` | `std::nullptr_t` |
## Example
Suppose you want to parse the following JSON document:
```cpp
{
"port": 8080,
"host": "localhost",
"debug": true
}
```
**Reminder**: In C++, `R"( )"` allows us to write multi-line strings with unescaped quotes.
You can do so, at compile-time, as follows:
```cpp
constexpr auto cfg = R"(
{
"port": 8080,
"host": "localhost",
"debug": true
}
)"_json;
// cfg.port == 8080
// std::string_view(cfg.host) == "localhost"
// cfg.debug == true
```
You can nest objects and arrays:
```cpp
constexpr auto data = R"(
{
"servers": [
{"host": "s1", "port": 3000},
{"host": "s2", "port": 3001}
]
}
)"_json;
// data.servers.size() == 2
// std::string_view(data.servers[0].host) == "s1"
```
Top-level arrays are allowed:
```cpp
constexpr auto arr = R"(
[1, 2, 3]
)"_json;
static_assert(arr.size() == 3);
static_assert(arr[1] == 2);
```
## Concepts
Given that the parsed data is made of structures that depend on the JSON input, you might
want to check that it conforms to your expectation. You can do so with concepts.
Let us consider this example:
```cpp
constexpr auto config = R"(
[
{ "name": "Alice", "age": 30 },
{ "name": "Bob", "age": 25 },
{ "name": "Charlie", "age": 35 }
]
)"_json;
```
You might want to ensure that the result is an array of persons. You can define your
expection with concepts like so:
```cpp
template <typename T>
concept person = requires(T p) {
std::string_view(p.name); // has name field convertible to string_view
p.age; // has age field
requires std::is_integral_v<decltype(p.age)>; // age is integral
};
/**
* Concept to validate that a type is an array of person objects
*/
template <typename T>
concept array_of_person = requires(T arr) {
arr.size(); // has size method
arr[0]; // can access elements with []
requires person<decltype(arr[0])>; // elements satisfy person concept
};
```
And then a simple static assert with `decltype` is sufficient to check that the expectation is met:
```cpp
constexpr auto config = R"(
[
{ "name": "Alice", "age": 30 },
{ "name": "Bob", "age": 25 },
{ "name": "Charlie", "age": 35 }
]
)"_json;
// Validate that the array satisfies the array_of_person concept
static_assert(array_of_person<decltype(config)>);
```
## Loading from disk
In practice, you may have a JSON file, say `json_data` that you want to parse
at compile time. You may do so as follows.
```c++
constexpr const char json_data[] = {
#embed "test.json"
, 0
};
constexpr auto json = simdjson::compile_time::parse_json<json_data>();
```
## Limitations (compile-time errors)
We have a few limitations which trigger compile-time errors if violated.
- Only JSON objects and arrays are supported at the top level (no primitives).
We will lift this limitation in the future.
- Strings are represented using the `const char*` in UTF-8, but they must not
contain embedded nulls. We would prefer to represent them as std::string or
std::string_view, and hope to do so in the future.
- Heterogeneous arrays are not supported yet. E.g., you need to have arrays of
all integers, or all strings, all floats, all compatible objects, etc.
For example, the following is accepted:
```json
[
{ "name": "Alice", "age": 30 },
{ "name": "Bob", "age": 25 },
{ "name": "Charlie", "age": 35 }
]
```
but the following is not:
```json
[
{ "name": "Alice", "age": 30 },
"Just a string",
42,
{ "name": "Charlie", "age": 35 }
]
```
We may support heterogeneous arrays in the future with std::variant types.
- We parse the first JSON document encountered in the string. Trailing
characters are ignored. Thus if your JSON begins with {"a":1}, everything
after the closing brace is ignored. This limitation will be lifted in the future,
reporting an error.
These limitations are safe in the sense that they result in compile-time errors.
Thus you will not get truncated strings or imprecise floats silently.
Although we are committed to maintaining the functionality in the long run, the
`compile_time::parse_json` function is subject to change.
-445
View File
@@ -1,445 +0,0 @@
# Compile-Time JSONPath and JSON Pointer Accessors
**Note:** This feature requires C++26 Static Reflection support (P2996) and is currently only available with experimental compilers. You must enable it with `-DSIMDJSON_STATIC_REFLECTION=ON` when building.
## Overview
simdjson provides compile-time JSONPath and JSON Pointer accessors that validate paths against struct definitions at compile time and generate optimized accessor code with zero runtime overhead. This combines the safety of compile-time type checking with the performance of pre-parsed, pre-validated access paths.
## Requirements
- C++26 compiler with Static Reflection support (P2996)
- Experimental compiler flags:
- Clang with P2996 support: `-std=c++26 -freflection -fexpansion-statements`
- Build configuration: `-DSIMDJSON_STATIC_REFLECTION=ON`
## How It Works
**Compile Time:**
1. Path string is parsed and converted to access steps
2. Path is validated against struct definition using reflection
3. Field types are checked and verified
4. Optimized accessor code is generated
**Runtime:**
- Direct navigation with no parsing
- No validation overhead
- No string comparisons for path components
- Type-safe extraction
## Two Usage Modes
### Mode 1: With Type Validation (Recommended)
When you provide a struct type, the compiler validates the entire path at compile time:
```cpp
struct User {
std::string name;
int age;
std::vector<std::string> emails;
};
// R"( ... )" is a C++ raw string literal.
const padded_string json = R"({
"name": "Alice",
"age": 30,
"emails": ["alice@example.com", "alice@work.com"]
})"_padded;
ondemand::parser parser;
auto doc = parser.iterate(json);
// Compile-time validation: checks that User has "name" field of type std::string
std::string name;
auto result = ondemand::json_path::at_path_compiled<User, ".name">(doc);
result.get(name); // name = "Alice"
// Compile-time validation: checks that "emails" is array-like with string elements
std::string email;
result = ondemand::json_path::at_path_compiled<User, ".emails[0]">(doc);
result.get(email); // email = "alice@example.com"
```
**Benefits:**
- **Compile-time errors** if path doesn't exist in struct
- **Type safety** - verifies field types match expected types
- **Refactoring protection** - renaming struct fields causes compile errors
**What gets validated:**
- Field existence
- Field types
- Array/container access validity
- Nested struct navigation
### Mode 2: Without Validation
When you omit the struct type, the path is parsed at compile time but not validated:
```cpp
const padded_string json = R"({
"name": "Alice",
"age": 30,
"address": {"city": "Boston"}
})"_padded;
ondemand::parser parser;
auto doc = parser.iterate(json);
// No compile-time validation - path is only parsed
std::string name;
auto result = ondemand::json_path::at_path_compiled<".name">(doc);
result.get(name); // name = "Alice"
std::string_view city;
result = ondemand::json_path::at_path_compiled<".address.city">(doc);
result.get(city); // city = "Boston"
```
**Benefits:**
- Works with dynamic/unknown JSON structures
- Still benefits from compile-time path parsing
- No runtime string parsing overhead
**Use when:**
- JSON structure is not known at compile time
- Working with varied JSON schemas
- Prototyping or exploratory parsing
## JSONPath Syntax
JSONPath uses dot notation and bracket notation for field access:
### Supported Syntax
| Syntax | Description | Example |
|--------|-------------|---------|
| `.field` | Dot notation for field access | `.name`, `.address.city` |
| `["field"]` | Bracket notation with quotes | `["name"]`, `["address"]["city"]` |
| `[index]` | Array index access | `[0]`, `[1]` |
| Mixed | Combination of notations | `.emails[0]`, `["users"][0].name` |
| `$` prefix | Optional root indicator | `$.name`, `$["name"]` |
### Examples
```cpp
struct Address {
std::string city;
int zip;
};
struct Person {
std::string name;
int age;
Address address;
std::vector<std::string> emails;
};
// Dot notation
at_path_compiled<Person, ".name">(doc)
at_path_compiled<Person, ".address.city">(doc)
// Bracket notation
at_path_compiled<Person, "[\"name\"]">(doc)
at_path_compiled<Person, "[\"address\"][\"city\"]">(doc)
// Array access
at_path_compiled<Person, ".emails[0]">(doc)
at_path_compiled<Person, ".emails[1]">(doc)
// Mixed notation
at_path_compiled<Person, ".address[\"zip\"]">(doc)
at_path_compiled<Person, "[\"emails\"][0]">(doc)
// With root indicator
at_path_compiled<Person, "$.name">(doc)
at_path_compiled<Person, "$.address.city">(doc)
```
## JSON Pointer Syntax
JSON Pointer (RFC 6901) uses slash-separated paths:
### Supported Syntax
| Syntax | Description | Example |
|--------|-------------|---------|
| `/field` | Field access | `/name`, `/address/city` |
| `/index` | Array index | `/0`, `/1` |
| `~0` | Escaped `~` | `/field~0name` → field~name |
| `~1` | Escaped `/` | `/field~1name` → field/name |
### Examples
```cpp
struct Car {
std::string make;
std::string model;
int64_t year;
std::vector<double> tire_pressure;
};
// Field access
at_pointer_compiled<Car, "/make">(doc)
at_pointer_compiled<Car, "/model">(doc)
// Array access
at_pointer_compiled<Car, "/tire_pressure/0">(doc)
at_pointer_compiled<Car, "/tire_pressure/1">(doc)
// Root pointer (returns whole document)
at_pointer_compiled<Car, "">(doc)
at_pointer_compiled<Car, "/">(doc)
```
## API Reference
### JSONPath Functions
```cpp
// With type validation
template<typename T, constevalutil::fixed_string Path, typename DocOrValue>
simdjson_result<value> at_path_compiled(DocOrValue& doc_or_val);
// Without validation
template<constevalutil::fixed_string Path, typename DocOrValue>
simdjson_result<value> at_path_compiled(DocOrValue& doc_or_val);
```
### JSON Pointer Functions
```cpp
// With type validation
template<typename T, constevalutil::fixed_string Pointer, typename DocOrValue>
simdjson_result<value> at_pointer_compiled(DocOrValue& doc_or_val);
// Without validation
template<constevalutil::fixed_string Pointer, typename DocOrValue>
simdjson_result<value> at_pointer_compiled(DocOrValue& doc_or_val);
```
### Direct Field Extraction
Extract values directly into variables with compile-time type checking:
```cpp
// JSONPath
template<typename T, constevalutil::fixed_string Path>
struct path_accessor {
template<typename DocOrValue, typename FieldType>
static error_code extract_field(DocOrValue& doc_or_val, FieldType& target);
};
// JSON Pointer
template<typename T, constevalutil::fixed_string Pointer>
struct pointer_accessor {
template<typename DocOrValue, typename FieldType>
static error_code extract_field(DocOrValue& doc_or_val, FieldType& target);
};
```
**Example:**
```cpp
struct User {
std::string name;
int age;
};
ondemand::parser parser;
auto doc = parser.iterate(json);
// Extract directly into variable
std::string name;
ondemand::json_path::path_accessor<User, ".name">::extract_field(doc, name);
int age;
ondemand::json_path::pointer_accessor<User, "/age">::extract_field(doc, age);
```
The compiler verifies that the target variable type matches the field type at the path.
## Complete Examples
### Example 1: Validated Access
```cpp
#include "simdjson.h"
using namespace simdjson;
struct Car {
std::string make;
std::string model;
int64_t year;
std::vector<double> tire_pressure;
};
int main() {
const padded_string json = R"({
"make": "Toyota",
"model": "Camry",
"year": 2018,
"tire_pressure": [40.1, 39.9, 37.7, 40.4]
})"_padded;
ondemand::parser parser;
auto doc = parser.iterate(json);
// Type-validated access
std::string make;
auto result = ondemand::json_path::at_path_compiled<Car, ".make">(doc);
result.get(make); // make = "Toyota"
// Array access with validation
double pressure;
result = ondemand::json_path::at_path_compiled<Car, ".tire_pressure[1]">(doc);
result.get(pressure); // pressure = 39.9
return 0;
}
```
### Example 2: Non-Validated Access
```cpp
#include "simdjson.h"
using namespace simdjson;
int main() {
const padded_string json = R"({
"user": {
"name": "Alice",
"preferences": {
"theme": "dark",
"notifications": true
}
}
})"_padded;
ondemand::parser parser;
auto doc = parser.iterate(json);
// No validation - works with any JSON structure
std::string_view theme;
auto result = ondemand::json_path::at_path_compiled<".user.preferences.theme">(doc);
result.get(theme); // theme = "dark"
bool notifications;
result = ondemand::json_path::at_path_compiled<".user.preferences.notifications">(doc);
result.get(notifications); // notifications = true
return 0;
}
```
### Example 3: Direct Extraction
```cpp
#include "simdjson.h"
using namespace simdjson;
struct Person {
std::string name;
int age;
std::vector<std::string> emails;
};
int main() {
const padded_string json = R"({
"name": "Bob",
"age": 25,
"emails": ["bob@example.com", "bob@work.com"]
})"_padded;
ondemand::parser parser;
auto doc = parser.iterate(json);
// Extract with type validation
std::string name;
ondemand::json_path::path_accessor<Person, ".name">::extract_field(doc, name);
// name = "Bob"
int age;
ondemand::json_path::pointer_accessor<Person, "/age">::extract_field(doc, age);
// age = 25
std::string email;
ondemand::json_path::path_accessor<Person, ".emails[0]">::extract_field(doc, email);
// email = "bob@example.com"
return 0;
}
```
## Error Handling
Compile-time errors occur when:
- Path doesn't exist in struct: `static_assert` failure
- Field type mismatch: `static_assert` failure
- Invalid array access on non-array field: `static_assert` failure
Runtime errors occur when:
- JSON structure doesn't match expected structure
- Array index out of bounds
- Type conversion failures
```cpp
struct User {
std::string name;
int age;
};
// Compile-time error: no "email" field in User
// auto result = ondemand::json_path::at_path_compiled<User, ".email">(doc);
// Compile-time error: age is not an array
// auto result = ondemand::json_path::at_path_compiled<User, ".age[0]">(doc);
// Runtime error if JSON doesn't have "name" field
auto result = ondemand::json_path::at_path_compiled<User, ".name">(doc);
std::string name;
if (result.get(name) != SUCCESS) {
// Handle error
}
```
## Performance
Compile-time accessors provide:
- **Zero path parsing overhead** - paths parsed at compile time
- **Zero validation overhead** - validation done at compile time
- **Direct field access** - no runtime path traversal
- **Type-safe extraction** - no dynamic type checking
Compared to runtime `at_path()` and `at_pointer()`:
- Eliminates runtime path string parsing
- Eliminates runtime path validation
- Generates optimal code path directly
## Limitations
- Requires C++26 compiler with P2996 support (experimental)
- Paths must be compile-time constants (string literals)
- Cannot use runtime-computed paths
- Limited to struct types that support reflection
- Array indices must be compile-time constants in the path
## When to Use
**Use compile-time accessors when:**
- You have well-defined struct types
- JSON structure is known at compile time
- You want maximum type safety
- Performance is critical
**Use runtime `at_path()`/`at_pointer()` when:**
- JSON structure varies or is unknown
- Paths are computed at runtime
- Working with C++20 or earlier
- Flexibility is more important than compile-time checks
## See Also
- [JSON Pointer](basics.md#json-pointer) - Runtime JSON Pointer support
- [JSONPath](basics.md#jsonpath) - Runtime JSONPath support
- [Static Reflection for Deserialization](basics.md#3-using-static-reflection-c26) - Using reflection for full struct deserialization
+34 -127
View File
@@ -1,10 +1,7 @@
The Document-Object-Model (DOM) front-end The Document-Object-Model (DOM) front-end
========== ==========
An overview of what you need to know to use simdjson to parse JSON documents with An overview of what you need to know to use simdjson, with examples.
our DOM API, with examples. [Our documentation regarding the generation (serialization) of JSON documents is in a
separate document](https://github.com/simdjson/simdjson/blob/master/doc/builder.md).
* [DOM vs On-Demand](#dom-vs-on-demand) * [DOM vs On-Demand](#dom-vs-on-demand)
* [The Basics: Loading and Parsing JSON Documents](#the-basics-loading-and-parsing-json-documents-using-the-dom-front-end) * [The Basics: Loading and Parsing JSON Documents](#the-basics-loading-and-parsing-json-documents-using-the-dom-front-end)
@@ -31,17 +28,13 @@ a conventional Document-Object-Model (DOM) front-end. In such a scenario, the JS
entirely parsed, validated and materialized in memory as the first step. The programmer may entirely parsed, validated and materialized in memory as the first step. The programmer may
then access the parsed data using this in-memory model. then access the parsed data using this in-memory model.
On-Demand is a different model where you parse just what you need, directly into your own
data structure. The On-Demand approach, when well tuned, can provide superior performance.
[We refer you to the On-Demand documentation for further details](https://github.com/simdjson/simdjson/blob/master/doc/basics.md).
The Basics: Loading and Parsing JSON Documents using the DOM front-end The Basics: Loading and Parsing JSON Documents using the DOM front-end
---------------------------------------------- ----------------------------------------------
The simdjson library offers a simple DOM tree API, which you can access by creating a The simdjson library offers a simple DOM tree API, which you can access by creating a
`dom::parser` and calling the `load()` method: `dom::parser` and calling the `load()` method:
```cpp ```c++
dom::parser parser; dom::parser parser;
dom::element doc = parser.load(filename); // load and parse a file dom::element doc = parser.load(filename); // load and parse a file
``` ```
@@ -49,37 +42,21 @@ dom::element doc = parser.load(filename); // load and parse a file
Or by creating a padded string (for efficiency reasons, simdjson requires a string with Or by creating a padded string (for efficiency reasons, simdjson requires a string with
SIMDJSON_PADDING bytes at the end) and calling `parse()`: SIMDJSON_PADDING bytes at the end) and calling `parse()`:
```cpp ```c++
dom::parser parser; dom::parser parser;
dom::element doc = parser.parse("[1,2,3]"_padded); // parse a string, the _padded suffix creates a simdjson::padded_string instance dom::element doc = parser.parse("[1,2,3]"_padded); // parse a string, the _padded suffix creates a simdjson::padded_string instance
``` ```
You can also load a `padded_string` from a file.
```cpp
auto json = padded_string::load("twitter.json"); // load JSON file 'twitter.json'.
dom::element doc = parser.parse(json);
```
(Windows users compiling with C++17 or better may use `wchar_t` strings to support non-ASCII
filenames: `padded_string::load(L"twitter.json")`.)
(Windows users compiling with C++17 or better may use `wchar_t` strings to support non-ASCII
filenames: `padded_string::load(L"twitter.json")`.)
You can copy your data directly on a `simdjson::padded_string` as follows: You can copy your data directly on a `simdjson::padded_string` as follows:
```cpp ```c++
const char * data = "my data"; // 7 bytes const char * data = "my data"; // 7 bytes
simdjson::padded_string my_padded_data(data, 7); // copies to a padded buffer simdjson::padded_string my_padded_data(data, 7); // copies to a padded buffer
``` ```
Or as follows... Or as follows...
```cpp ```c++
std::string data = "my data"; std::string data = "my data";
simdjson::padded_string my_padded_data(data); // copies to a padded buffer simdjson::padded_string my_padded_data(data); // copies to a padded buffer
``` ```
@@ -99,7 +76,7 @@ container-overflow checks, you may encounter sanitizer warnings.
You can safely ignore these warnings. Or you can call `simdjson::pad(std::string&)` to pad the You can safely ignore these warnings. Or you can call `simdjson::pad(std::string&)` to pad the
string with `SIMDJSON_PADDING` spaces: this function returns a `simdjson::padding_string_view` which can be be passed to the parser's iterator function: string with `SIMDJSON_PADDING` spaces: this function returns a `simdjson::padding_string_view` which can be be passed to the parser's iterator function:
```cpp ```c++
std::string json = "[1]"; std::string json = "[1]";
dom::element doc = parser.parse(simdjson::pad(json)); dom::element doc = parser.parse(simdjson::pad(json));
``` ```
@@ -133,9 +110,8 @@ Once you have an element, you can navigate it with idiomatic C++ iterators, oper
dom::object and dom::array. An exception (`simdjson::simdjson_error`) is thrown if the cast is not possible. dom::object and dom::array. An exception (`simdjson::simdjson_error`) is thrown if the cast is not possible.
* **Extracting Values (without exceptions):** You can use a variant usage of `get()` with error codes to avoid exceptions. You first declare the variable of the appropriate type (`double`, `uint64_t`, `int64_t`, `bool`, `std::string_view`, * **Extracting Values (without exceptions):** You can use a variant usage of `get()` with error codes to avoid exceptions. You first declare the variable of the appropriate type (`double`, `uint64_t`, `int64_t`, `bool`, `std::string_view`,
`dom::object` and `dom::array`) and pass it by reference to `get()` which gives you back an error code: e.g., `dom::object` and `dom::array`) and pass it by reference to `get()` which gives you back an error code: e.g.,
```cpp ```c++
simdjson::error_code error; simdjson::error_code error;
// _padded returns an simdjson::padded_string instance
simdjson::padded_string numberstring = "1.2"_padded; // our JSON input ("1.2") simdjson::padded_string numberstring = "1.2"_padded; // our JSON input ("1.2")
simdjson::dom::parser parser; simdjson::dom::parser parser;
double value; // variable where we store the value to be parsed double value; // variable where we store the value to be parsed
@@ -146,7 +122,7 @@ Once you have an element, you can navigate it with idiomatic C++ iterators, oper
The strings contain unescaped valid UTF-8 strings: no unmatched surrogate is allowed. The strings contain unescaped valid UTF-8 strings: no unmatched surrogate is allowed.
Internally, numbers are stored as either 64-bit integers or 64-bit floating-point numbers. Internally, numbers are stored as either 64-bit integers or 64-bit floating-point numbers.
Thus it is possible to get the full 64-bit integer range (either signed or unsigned). Thus it is possible to get the full 64-bit integer range (either signed or unsigned).
By default, the string `-0` is parsed as the integer 0 as in Python or C++. If you set the macro By default, the string `-0` is parsed as the integer 0 as in Pytho or C++. If you set the macro
`SIMDJSON_MINUS_ZERO_AS_FLOAT` to `1` when building simdjson, you can get that `-0` is mapped to `-0.0` `SIMDJSON_MINUS_ZERO_AS_FLOAT` to `1` when building simdjson, you can get that `-0` is mapped to `-0.0`
as in JavaScript. You can get the desired effect by building simdjson with cmake setting the as in JavaScript. You can get the desired effect by building simdjson with cmake setting the
`SIMDJSON_MINUS_ZERO_AS_FLOAT` to on: `cmake -B build -D SIMDJSON_MINUS_ZERO_AS_FLOAT=ON`. `SIMDJSON_MINUS_ZERO_AS_FLOAT` to on: `cmake -B build -D SIMDJSON_MINUS_ZERO_AS_FLOAT=ON`.
@@ -169,8 +145,7 @@ Once you have an element, you can navigate it with idiomatic C++ iterators, oper
The following code illustrates all of the above: The following code illustrates all of the above:
```cpp ```c++
// R"( ... )" is a C++ raw string literal.
auto cars_json = R"( [ auto cars_json = R"( [
{ "make": "Toyota", "model": "Camry", "year": 2018, "tire_pressure": [ 40.1, 39.9, 37.7, 40.4 ] }, { "make": "Toyota", "model": "Camry", "year": 2018, "tire_pressure": [ 40.1, 39.9, 37.7, 40.4 ] },
{ "make": "Kia", "model": "Soul", "year": 2012, "tire_pressure": [ 30.1, 31.0, 28.6, 28.7 ] }, { "make": "Kia", "model": "Soul", "year": 2012, "tire_pressure": [ 30.1, 31.0, 28.6, 28.7 ] },
@@ -203,7 +178,7 @@ for (dom::object car : parser.parse(cars_json)) {
Here is a different example illustrating the same ideas: Here is a different example illustrating the same ideas:
```cpp ```C++
auto abstract_json = R"( [ auto abstract_json = R"( [
{ "12345" : {"a":12.34, "b":56.78, "c": 9998877} }, { "12345" : {"a":12.34, "b":56.78, "c": 9998877} },
{ "12545" : {"a":11.44, "b":12.78, "c": 11111111} } { "12545" : {"a":11.44, "b":12.78, "c": 11111111} }
@@ -225,7 +200,7 @@ for (dom::object obj : parser.parse(abstract_json)) {
And another one: And another one:
```cpp ```C++
auto abstract_json = R"( auto abstract_json = R"(
{ "str" : { "123" : {"abc" : 3.14 } } } )"_padded; { "str" : { "123" : {"abc" : 3.14 } } } )"_padded;
dom::parser parser; dom::parser parser;
@@ -239,7 +214,7 @@ C++17 Support
While the simdjson library can be used in any project using C++ 11 and above, field iteration has special support C++ 17's destructuring syntax. For example: While the simdjson library can be used in any project using C++ 11 and above, field iteration has special support C++ 17's destructuring syntax. For example:
```cpp ```c++
padded_string json = R"( { "foo": 1, "bar": 2 } )"_padded; padded_string json = R"( { "foo": 1, "bar": 2 } )"_padded;
dom::parser parser; dom::parser parser;
dom::object object; // invalid until the get() succeeds dom::object object; // invalid until the get() succeeds
@@ -252,7 +227,7 @@ for (auto [key, value] : object) {
For comparison, here is the C++ 11 version of the same code: For comparison, here is the C++ 11 version of the same code:
```cpp ```c++
// C++ 11 version for comparison // C++ 11 version for comparison
padded_string json = R"( { "foo": 1, "bar": 2 } )"_padded; padded_string json = R"( { "foo": 1, "bar": 2 } )"_padded;
dom::parser parser; dom::parser parser;
@@ -269,7 +244,7 @@ C++20 Support
simdjson library also supports some C++20 feature including `std::ranges`: simdjson library also supports some C++20 feature including `std::ranges`:
```cpp ```c++
auto cars_json = R"( [ auto cars_json = R"( [
{ "make": "Toyota", "model": "Camry", "year": 2018, "tire_pressure": [ 40.1, 39.9, 37.7, 40.4 ] }, { "make": "Toyota", "model": "Camry", "year": 2018, "tire_pressure": [ 40.1, 39.9, 37.7, 40.4 ] },
{ "make": "Kia", "model": "Soul", "year": 2012, "tire_pressure": [ 30.1, 31.0, 28.6, 28.7 ] }, { "make": "Kia", "model": "Soul", "year": 2012, "tire_pressure": [ 30.1, 31.0, 28.6, 28.7 ] },
@@ -288,7 +263,7 @@ JSON Pointer
The simdjson library also supports [JSON pointer](https://tools.ietf.org/html/rfc6901) through the The simdjson library also supports [JSON pointer](https://tools.ietf.org/html/rfc6901) through the
`at_pointer()` method, letting you reach further down into the document in a single call: `at_pointer()` method, letting you reach further down into the document in a single call:
```cpp ```c++
auto cars_json = R"( [ auto cars_json = R"( [
{ "make": "Toyota", "model": "Camry", "year": 2018, "tire_pressure": [ 40.1, 39.9, 37.7, 40.4 ] }, { "make": "Toyota", "model": "Camry", "year": 2018, "tire_pressure": [ 40.1, 39.9, 37.7, 40.4 ] },
{ "make": "Kia", "model": "Soul", "year": 2012, "tire_pressure": [ 30.1, 31.0, 28.6, 28.7 ] }, { "make": "Kia", "model": "Soul", "year": 2012, "tire_pressure": [ 30.1, 31.0, 28.6, 28.7 ] },
@@ -309,7 +284,7 @@ You can apply a JSON Pointer expression to any node and the path gets interprete
Consider the following example: Consider the following example:
```cpp ```c++
auto cars_json = R"( [ auto cars_json = R"( [
{ "make": "Toyota", "model": "Camry", "year": 2018, "tire_pressure": [ 40.1, 39.9, 37.7, 40.4 ] }, { "make": "Toyota", "model": "Camry", "year": 2018, "tire_pressure": [ 40.1, 39.9, 37.7, 40.4 ] },
{ "make": "Kia", "model": "Soul", "year": 2012, "tire_pressure": [ 30.1, 31.0, 28.6, 28.7 ] }, { "make": "Kia", "model": "Soul", "year": 2012, "tire_pressure": [ 30.1, 31.0, 28.6, 28.7 ] },
@@ -331,11 +306,11 @@ JSONPath
------------ ------------
The simdjson library supports a subset of [JSONPath](https://www.rfc-editor.org/rfc/rfc9535) (RFC 9535) through the `at_path()` method, allowing you to reach further into the document in a single call. The subset of JSONPath that is implemented is the subset that is trivially convertible into the JSON Pointer format, using `.` to access a field and `[]` to access a specific index. The simdjson library supports a subset of [JSONPath](https://datatracker.ietf.org/doc/html/draft-normington-jsonpath-00) through the `at_path()` method, allowing you to reach further into the document in a single call. The subset of JSONPath that is implemented is the subset that is trivially convertible into the JSON Pointer format, using `.` to access a field and `[]` to access a specific index.
Consider the following example: Consider the following example:
```cpp ```c++
auto cars_json = R"( [ auto cars_json = R"( [
{ "make": "Toyota", "model": "Camry", "year": 2018, "tire_pressure": [ 40.1, 39.9, 37.7, 40.4 ] }, { "make": "Toyota", "model": "Camry", "year": 2018, "tire_pressure": [ 40.1, 39.9, 37.7, 40.4 ] },
{ "make": "Kia", "model": "Soul", "year": 2012, "tire_pressure": [ 30.1, 31.0, 28.6, 28.7 ] }, { "make": "Kia", "model": "Soul", "year": 2012, "tire_pressure": [ 30.1, 31.0, 28.6, 28.7 ] },
@@ -354,7 +329,7 @@ cout << p << endl; // Prints 39.9
We also support the `$` prefix. When you start a JSONPath expression with $, you are indicating that the path starts from the root of the JSON document. E.g., We also support the `$` prefix. When you start a JSONPath expression with $, you are indicating that the path starts from the root of the JSON document. E.g.,
```cpp ```c++
auto json = R"( { "c" :{ "foo": { "a": [ 10, 20, 30 ] }}, "d": { "foo2": { "a": [ 10, 20, 30 ] }} , "e": 120 })"_padded; auto json = R"( { "c" :{ "foo": { "a": [ 10, 20, 30 ] }}, "d": { "foo2": { "a": [ 10, 20, 30 ] }} , "e": 120 })"_padded;
dom::parser parser; dom::parser parser;
dom::element doc; dom::element doc;
@@ -372,81 +347,13 @@ if(error) { /*won't happen*/ }
``` ```
## Using `at_path_with_wildcard` for JSONPath Queries
The `at_path_with_wildcard` function in simdjson extends the JSONPath querying capabilities by supporting wildcard expressions (`*`) in JSON paths. This allows users to retrieve multiple elements from a JSON document in a single query. For example, you can use `$.address.*` to fetch all fields within the `address` object or `$.phoneNumbers[*].numbers[*]` to retrieve all phone numbers across multiple objects in an array.
The `*` wildcard matches all elements at a specific level. For instance, `$.address.*` retrieves all key-value pairs in the `address` object, while `$.*.streetAddress` fetches all `streetAddress` fields across objects at the root level. You can combine wildcards with array indexing. For example, `$.phoneNumbers[*].numbers[1]` retrieves the second number from each `numbers` array in the `phoneNumbers` array. If no elements match the wildcard query, the function returns an empty result. For instance, querying `$.empty_object.*` or `$.empty_array.*` will yield an empty set.
### Example Usage
Here is an example demonstrating the use of `at_path_with_wildcard`:
```cpp
simdjson::padded_string json_string = R"(
{
"firstName": "John",
"lastName": "doe",
"age": 26,
"address": {
"streetAddress": "naist street",
"city": "Nara",
"postalCode": "630-0192"
},
"phoneNumbers": [
{
"type": "iPhone",
"numbers": ["0123-4567-8888", "0123-4567-8788"]
},
{
"type": "home",
"numbers": ["0123-4567-8910"]
}
]
})"_padded;
dom::parser parser;
dom::element parsed_json = parser.parse(json_string);
std::vector<dom::element> values;
// Fetch all fields in the address object
auto error = parsed_json.at_path_with_wildcard("$.address.*").get(values);
if(error) {
// do something
}
for (auto &value : values) {
std::string_view field;
error = value.get(field);
if(error) {
// do something
}
std::cout << field << std::endl;
}
// Fetch all phone numbers
error = parsed_json.at_path_with_wildcard("$.phoneNumbers[*].numbers[*]").get(values);
if(error) {
// do something
}
for (auto &value : values) {
std::string_view number;
error = value.get(number);
if(error) {
// do something
}
std::cout << number << std::endl;
}
```
This function is particularly useful for extracting data from complex JSON structures with nested arrays and objects. By leveraging wildcards, you can simplify your queries and reduce the need for multiple iterations.
Error Handling Error Handling
-------------- --------------
All simdjson APIs that can fail return `simdjson_result<T>`, which is a &lt;value, error_code&gt; All simdjson APIs that can fail return `simdjson_result<T>`, which is a &lt;value, error_code&gt;
pair. You can retrieve the value with .get(), like so: pair. You can retrieve the value with .get(), like so:
```cpp ```c++
dom::element doc; dom::element doc;
auto error = parser.parse(json).get(doc); auto error = parser.parse(json).get(doc);
if (error) { cerr << error << endl; exit(1); } if (error) { cerr << error << endl; exit(1); }
@@ -480,7 +387,7 @@ We can write a "quick start" example where we attempt to parse the following JSO
Our program loads the file, selects value corresponding to key "search_metadata" which expected to be an object, and then Our program loads the file, selects value corresponding to key "search_metadata" which expected to be an object, and then
it selects the key "count" within that object. it selects the key "count" within that object.
```cpp ```C++
#include <iostream> #include <iostream>
#include "simdjson.h" #include "simdjson.h"
@@ -508,7 +415,7 @@ triggering exceptions. To do this, we use `["statuses"].at(0)["id"]`. We break t
Observe how we use the `at` method when querying an index into an array, and not the bracket operator. Observe how we use the `at` method when querying an index into an array, and not the bracket operator.
```cpp ```C++
#include <iostream> #include <iostream>
#include "simdjson.h" #include "simdjson.h"
@@ -532,7 +439,7 @@ over the content of an array.
This is how the example in "Using the Parsed JSON" could be written using only error code checking: This is how the example in "Using the Parsed JSON" could be written using only error code checking:
```cpp ```c++
auto cars_json = R"( [ auto cars_json = R"( [
{ "make": "Toyota", "model": "Camry", "year": 2018, "tire_pressure": [ 40.1, 39.9, 37.7, 40.4 ] }, { "make": "Toyota", "model": "Camry", "year": 2018, "tire_pressure": [ 40.1, 39.9, 37.7, 40.4 ] },
{ "make": "Kia", "model": "Soul", "year": 2012, "tire_pressure": [ 30.1, 31.0, 28.6, 28.7 ] }, { "make": "Kia", "model": "Soul", "year": 2012, "tire_pressure": [ 30.1, 31.0, 28.6, 28.7 ] },
@@ -579,7 +486,7 @@ for (dom::element car_element : cars) {
Here is another example: Here is another example:
```cpp ```C++
auto abstract_json = R"( [ auto abstract_json = R"( [
{ "12345" : {"a":12.34, "b":56.78, "c": 9998877} }, { "12345" : {"a":12.34, "b":56.78, "c": 9998877} },
{ "12545" : {"a":11.44, "b":12.78, "c": 11111111} } { "12545" : {"a":11.44, "b":12.78, "c": 11111111} }
@@ -612,7 +519,7 @@ for (dom::element elem : array) {
And another one: And another one:
```cpp ```C++
auto abstract_json = R"( auto abstract_json = R"(
{ "str" : { "123" : {"abc" : 3.14 } } } )"_padded; { "str" : { "123" : {"abc" : 3.14 } } } )"_padded;
dom::parser parser; dom::parser parser;
@@ -626,7 +533,7 @@ Notice how we can string several operations (`parser.parse(abstract_json)["str"]
The next two functions will take as input a JSON document containing an array with a single element, either a string or a number. They return true upon success. The next two functions will take as input a JSON document containing an array with a single element, either a string or a number. They return true upon success.
```cpp ```C++
simdjson::dom::parser parser{}; simdjson::dom::parser parser{};
bool parse_double(const char *j, double &d) { bool parse_double(const char *j, double &d) {
@@ -658,7 +565,7 @@ target_compile_definitions(simdjson PUBLIC SIMDJSON_EXCEPTIONS=OFF)
Users more comfortable with an exception flow may choose to directly cast the `simdjson_result<T>` to the desired type: Users more comfortable with an exception flow may choose to directly cast the `simdjson_result<T>` to the desired type:
```cpp ```c++
dom::element doc = parser.parse(json); // Throws an exception if there was an error! dom::element doc = parser.parse(json); // Throws an exception if there was an error!
``` ```
@@ -668,7 +575,7 @@ program from continuing if there was an error.
If one is willing to trigger exceptions, it is possible to write simpler code: If one is willing to trigger exceptions, it is possible to write simpler code:
```cpp ```C++
#include <iostream> #include <iostream>
#include "simdjson.h" #include "simdjson.h"
@@ -689,7 +596,7 @@ inspect or walk over JSON elements. To do that, you can use iterators and the ty
example, here's a quick and dirty recursive function that verbosely prints the JSON document as JSON example, here's a quick and dirty recursive function that verbosely prints the JSON document as JSON
(* ignoring nuances like trailing commas and escaping strings, for brevity's sake): (* ignoring nuances like trailing commas and escaping strings, for brevity's sake):
```cpp ```c++
void print_json(dom::element element) { void print_json(dom::element element) {
switch (element.type()) { switch (element.type()) {
case dom::element_type::ARRAY: case dom::element_type::ARRAY:
@@ -745,7 +652,7 @@ and reuse it. The simdjson library will allocate and retain internal buffers bet
buffers hot in cache and keeping memory allocation and initialization to a minimum. In this manner, buffers hot in cache and keeping memory allocation and initialization to a minimum. In this manner,
you can parse terabytes of JSON data without doing any new allocation. you can parse terabytes of JSON data without doing any new allocation.
```cpp ```c++
dom::parser parser; dom::parser parser;
// This initializes buffers and a document big enough to handle this JSON. // This initializes buffers and a document big enough to handle this JSON.
@@ -788,7 +695,7 @@ without bound:
* You can set a *max capacity* when constructing a parser: * You can set a *max capacity* when constructing a parser:
```cpp ```c++
dom::parser parser(1000*1000); // Never grow past documents > 1MB dom::parser parser(1000*1000); // Never grow past documents > 1MB
for (web_request request : listen()) { for (web_request request : listen()) {
dom::element doc; dom::element doc;
@@ -804,7 +711,7 @@ without bound:
* You can set a *fixed capacity* that never grows, as well, which can be excellent for * You can set a *fixed capacity* that never grows, as well, which can be excellent for
predictability and reliability, since simdjson will never call malloc after startup! predictability and reliability, since simdjson will never call malloc after startup!
```cpp ```c++
dom::parser parser(0); // This parser will refuse to automatically grow capacity dom::parser parser(0); // This parser will refuse to automatically grow capacity
auto error = parser.allocate(1000*1000); // This allocates enough capacity to handle documents <= 1MB auto error = parser.allocate(1000*1000); // This allocates enough capacity to handle documents <= 1MB
if (error) { cerr << error << endl; exit(1); } if (error) { cerr << error << endl; exit(1); }
@@ -835,7 +742,7 @@ When calling `parser.parse` on a pointer (e.g., `parser.parse(my_char_pointer, m
Some users may not be able use our `padded_string` class or to load the data directly from disk (`parser.load`). They may need to pass data pointers to the library. If these users wish to avoid temporary copies and corresponding temporary memory allocations, they may want to call `parser.parse` with the `realloc_if_needed` parameter set to false (e.g., `parser.parse(my_char_pointer, my_length_in_bytes, false)`). In such cases, they need to ensure that there are at least SIMDJSON_PADDING extra bytes at the end that can be safely accessed and read. They do not need to initialize the padded bytes to any value in particular. The following example is safe: Some users may not be able use our `padded_string` class or to load the data directly from disk (`parser.load`). They may need to pass data pointers to the library. If these users wish to avoid temporary copies and corresponding temporary memory allocations, they may want to call `parser.parse` with the `realloc_if_needed` parameter set to false (e.g., `parser.parse(my_char_pointer, my_length_in_bytes, false)`). In such cases, they need to ensure that there are at least SIMDJSON_PADDING extra bytes at the end that can be safely accessed and read. They do not need to initialize the padded bytes to any value in particular. The following example is safe:
```cpp ```C++
const char *json = R"({"key":"value"})"; const char *json = R"({"key":"value"})";
const size_t json_len = std::strlen(json); const size_t json_len = std::strlen(json);
std::unique_ptr<char[]> padded_json_copy{new char[json_len + SIMDJSON_PADDING]}; std::unique_ptr<char[]> padded_json_copy{new char[json_len + SIMDJSON_PADDING]};
@@ -843,7 +750,7 @@ memcpy(padded_json_copy.get(), json, json_len);
memset(padded_json_copy.get() + json_len, 0, SIMDJSON_PADDING); memset(padded_json_copy.get() + json_len, 0, SIMDJSON_PADDING);
simdjson::dom::parser parser; simdjson::dom::parser parser;
simdjson::dom::element element = parser.parse(padded_json_copy.get(), json_len, false); simdjson::dom::element element = parser.parse(padded_json_copy.get(), json_len, false);
``` ````
Setting the `realloc_if_needed` parameter `false` in this manner may lead to better performance since copies are avoided, but it requires that the user takes more responsibilities: the simdjson library cannot verify that the input buffer was padded with SIMDJSON_PADDING extra bytes. Setting the `realloc_if_needed` parameter `false` in this manner may lead to better performance since copies are avoided, but it requires that the user takes more responsibilities: the simdjson library cannot verify that the input buffer was padded with SIMDJSON_PADDING extra bytes.
+6 -6
View File
@@ -55,7 +55,7 @@ Inspecting the Detected Implementation
You can check what implementation is running with `active_implementation`: You can check what implementation is running with `active_implementation`:
```cpp ```c++
cout << "simdjson v" << SIMDJSON_VERSION << endl; cout << "simdjson v" << SIMDJSON_VERSION << endl;
cout << "Detected the best implementation for your machine: " << simdjson::get_active_implementation()->name(); cout << "Detected the best implementation for your machine: " << simdjson::get_active_implementation()->name();
cout << "(" << simdjson::get_active_implementation()->description() << ")" << endl; cout << "(" << simdjson::get_active_implementation()->description() << ")" << endl;
@@ -68,7 +68,7 @@ Querying Available Implementations
You can list all available implementations, regardless of which one was selected: You can list all available implementations, regardless of which one was selected:
```cpp ```c++
for (auto implementation : simdjson::get_available_implementations()) { for (auto implementation : simdjson::get_available_implementations()) {
cout << implementation->name() << ": " << implementation->description() << endl; cout << implementation->name() << ": " << implementation->description() << endl;
} }
@@ -76,7 +76,7 @@ for (auto implementation : simdjson::get_available_implementations()) {
And look them up by name: And look them up by name:
```cpp ```c++
cout << simdjson::get_available_implementations()["fallback"]->description() << endl; cout << simdjson::get_available_implementations()["fallback"]->description() << endl;
``` ```
When an implementation is not available, the bracket call `simdjson::get_available_implementations()[name]` When an implementation is not available, the bracket call `simdjson::get_available_implementations()[name]`
@@ -93,7 +93,7 @@ Manually Selecting the Implementation
If you're trying to do performance tests or see how different implementations of simdjson run, you If you're trying to do performance tests or see how different implementations of simdjson run, you
can select the CPU architecture yourself: can select the CPU architecture yourself:
```cpp ```c++
// Use the fallback implementation, even though my machine is fast enough for anything // Use the fallback implementation, even though my machine is fast enough for anything
simdjson::get_active_implementation() = simdjson::get_available_implementations()["fallback"]; simdjson::get_active_implementation() = simdjson::get_available_implementations()["fallback"];
``` ```
@@ -102,7 +102,7 @@ You are responsible for ensuring that the requirements of the selected implement
Furthermore, you should check that the implementation is available before setting it to `simdjson::get_active_implementation()` Furthermore, you should check that the implementation is available before setting it to `simdjson::get_active_implementation()`
by comparing it with the null pointer. by comparing it with the null pointer.
```cpp ```c++
auto my_implementation = simdjson::get_available_implementations()["haswell"]; auto my_implementation = simdjson::get_available_implementations()["haswell"];
if (! my_implementation) { exit(1); } if (! my_implementation) { exit(1); }
if (! my_implementation->supported_by_runtime_system()) { exit(1); } if (! my_implementation->supported_by_runtime_system()) { exit(1); }
@@ -114,7 +114,7 @@ Checking that an Implementation can Run on your System
You should call `supported_by_runtime_system()` to compare the processor's features with the need of the implementation. You should call `supported_by_runtime_system()` to compare the processor's features with the need of the implementation.
```cpp ```c++
for (auto implementation : simdjson::get_available_implementations()) { for (auto implementation : simdjson::get_available_implementations()) {
if (implementation->supported_by_runtime_system()) { if (implementation->supported_by_runtime_system()) {
cout << implementation->name() << ": " << implementation->description() << endl; cout << implementation->name() << ": " << implementation->description() << endl;
+11 -13
View File
@@ -8,7 +8,7 @@ library provides high-speed access to files or streams containing multiple small
{"text":"a"} {"text":"a"}
{"text":"b"} {"text":"b"}
{"text":"c"} {"text":"c"}
"..." ...
``` ```
... you want to read the entries (individual JSON documents) as quickly and as conveniently as possible. Importantly, the input might span several gigabytes, but you want to use a small (fixed) amount of memory. Ideally, you'd also like the parallelize the processing (using more than one core) to speed up the process. ... you want to read the entries (individual JSON documents) as quickly and as conveniently as possible. Importantly, the input might span several gigabytes, but you want to use a small (fixed) amount of memory. Ideally, you'd also like the parallelize the processing (using more than one core) to speed up the process.
@@ -132,7 +132,7 @@ E.g., `[1,2]{"32":1}` is recognized as two documents.
Some official formats **(non-exhaustive list)**: Some official formats **(non-exhaustive list)**:
- [Newline-Delimited JSON (NDJSON)](https://github.com/ndjson/ndjson-spec/) - [Newline-Delimited JSON (NDJSON)](https://github.com/ndjson/ndjson-spec/)
- [JSON lines (JSONL)](http://jsonlines.org/) - [JSON lines (JSONL)](http://jsonlines.org/)
- [Record separator-delimited JSON (RFC 7464)](https://tools.ietf.org/html/rfc7464) <- Not supported by simdjson! - [Record separator-delimited JSON (RFC 7464)](https://tools.ietf.org/html/rfc7464) <- Not supported by JsonStream!
- [More on Wikipedia...](https://en.wikipedia.org/wiki/JSON_streaming) - [More on Wikipedia...](https://en.wikipedia.org/wiki/JSON_streaming)
API API
@@ -140,10 +140,8 @@ API
Example: Example:
```cpp ```c++
// R"( ... )" is a C++ raw string literal.
auto json = R"({ "foo": 1 } { "foo": 2 } { "foo": 3 } )"_padded; auto json = R"({ "foo": 1 } { "foo": 2 } { "foo": 3 } )"_padded;
// _padded returns an simdjson::padded_string instance
ondemand::parser parser; ondemand::parser parser;
ondemand::document_stream docs = parser.iterate_many(json); ondemand::document_stream docs = parser.iterate_many(json);
for (auto doc : docs) { for (auto doc : docs) {
@@ -199,7 +197,7 @@ and `error()` to check if there were any error.
Let us illustrate the idea with code: Let us illustrate the idea with code:
```cpp ```C++
auto json = R"([1,2,3] {"1":1,"2":3,"4":4} [1,2,3] )"_padded; auto json = R"([1,2,3] {"1":1,"2":3,"4":4} [1,2,3] )"_padded;
simdjson::ondemand::parser parser; simdjson::ondemand::parser parser;
simdjson::ondemand::document_stream stream; simdjson::ondemand::document_stream stream;
@@ -240,7 +238,7 @@ Some users may need to work with truncated streams. The simdjson may truncate do
Consider the following example where a truncated document (`{"key":"intentionally unclosed string `) containing 39 bytes has been left within the stream. In such cases, the first two whole documents are parsed and returned, and the `truncated_bytes()` method returns 39. Consider the following example where a truncated document (`{"key":"intentionally unclosed string `) containing 39 bytes has been left within the stream. In such cases, the first two whole documents are parsed and returned, and the `truncated_bytes()` method returns 39.
```cpp ```C++
auto json = R"([1,2,3] {"1":1,"2":3,"4":4} {"key":"intentionally unclosed string )"_padded; auto json = R"([1,2,3] {"1":1,"2":3,"4":4} {"key":"intentionally unclosed string )"_padded;
simdjson::ondemand::parser parser; simdjson::ondemand::parser parser;
simdjson::ondemand::document_stream stream; simdjson::ondemand::document_stream stream;
@@ -269,7 +267,7 @@ is effectively ignored, as it is set to at least the document size.
Example: Example:
```cpp ```C++
auto json = R"( 1, 2, 3, 4, "a", "b", "c", {"hello": "world"} , [1, 2, 3])"_padded; auto json = R"( 1, 2, 3, 4, "a", "b", "c", {"hello": "world"} , [1, 2, 3])"_padded;
ondemand::parser parser; ondemand::parser parser;
ondemand::document_stream doc_stream; ondemand::document_stream doc_stream;
@@ -311,12 +309,12 @@ The first argument is usually a tag type (often an empty struct) that uniquely i
You can deserialize you own data structures conveniently if your system supports C++20. You can deserialize you own data structures conveniently if your system supports C++20.
When it is the case, the macro `SIMDJSON_SUPPORTS_CONCEPTS` will be set to 1 by When it is the case, the macro `SIMDJSON_SUPPORTS_DESERIALIZATION` will be set to 1 by
the simdjson library. the simdjson library.
Consider a custom class `Car`: Consider a custom class `Car`:
```cpp ```C++
struct Car { struct Car {
std::string make; std::string make;
std::string model; std::string model;
@@ -330,7 +328,7 @@ You may support deserializing directly from a JSON value or document to your own
by defining a single `tag_invoke` function: by defining a single `tag_invoke` function:
```cpp ```C++
namespace simdjson { namespace simdjson {
// This tag_invoke MUST be inside simdjson namespace // This tag_invoke MUST be inside simdjson namespace
template <typename simdjson_value> template <typename simdjson_value>
@@ -372,7 +370,7 @@ tag_invoke functions.
Given a stream of JSON documents, you can add them to a data structure Given a stream of JSON documents, you can add them to a data structure
such as a `std::vector<Car>` like so if you support exceptions: such as a `std::vector<Car>` like so if you support exceptions:
```cpp ```C++
padded_string json = padded_string json =
R"( { "make": "Toyota", "model": "Camry", "year": 2018, R"( { "make": "Toyota", "model": "Camry", "year": 2018,
"tire_pressure": [ 40.1, 39.9 ] } "tire_pressure": [ 40.1, 39.9 ] }
@@ -393,7 +391,7 @@ such as a `std::vector<Car>` like so if you support exceptions:
Otherwise you may use this longer version for explicit handling of errors: Otherwise you may use this longer version for explicit handling of errors:
```cpp ```C++
std::vector<Car> cars; std::vector<Car> cars;
for(auto doc : stream) { for(auto doc : stream) {
Car c; Car c;
+19 -21
View File
@@ -23,7 +23,7 @@ applications with a computation efficiency that is difficult to surpass.
A code example illustrates our API from a programmer's point of view: A code example illustrates our API from a programmer's point of view:
```cpp ```c++
ondemand::parser parser; ondemand::parser parser;
auto doc = parser.iterate(json); auto doc = parser.iterate(json);
for (auto tweet : doc["statuses"]) { for (auto tweet : doc["statuses"]) {
@@ -109,7 +109,7 @@ The DOM approach was the only way to parse JSON documents up to version 0.6 of t
Our DOM API looks similar to our On-Demand example, except Our DOM API looks similar to our On-Demand example, except
it calls `parse` instead of `iterate`: it calls `parse` instead of `iterate`:
```cpp ```c++
dom::parser parser; dom::parser parser;
auto doc = parser.parse(json); auto doc = parser.parse(json);
for (auto tweet : doc["statuses"]) { for (auto tweet : doc["statuses"]) {
@@ -157,7 +157,7 @@ examples. To make it short enough to use as an example at all, it has heavily re
a part of the problem (does not get user.screen_name), it has bugs (it does not handle sub-objects a part of the problem (does not get user.screen_name), it has bugs (it does not handle sub-objects
in a tweet at all), and it uses a theoretical, simple event-based API that minimizes ceremony. in a tweet at all), and it uses a theoretical, simple event-based API that minimizes ceremony.
```cpp ```c++
struct twitter_callbacks { struct twitter_callbacks {
bool in_statuses; bool in_statuses;
bool in_tweet; bool in_tweet;
@@ -284,14 +284,14 @@ To help visualize the algorithm, we'll walk through the example C++ given at the
This declaration does not allocate any memory; that will happen in the next step. This declaration does not allocate any memory; that will happen in the next step.
```cpp ```c++
ondemand::parser parser; ondemand::parser parser;
``` ```
2. We then start iterating the JSON document by allocating internal parser buffers, preprocessing 2. We then start iterating the JSON document by allocating internal parser buffers, preprocessing
the JSON, and initializing the iterator. the JSON, and initializing the iterator.
```cpp ```c++
auto doc = parser.iterate(json); auto doc = parser.iterate(json);
``` ```
@@ -337,14 +337,14 @@ To help visualize the algorithm, we'll walk through the example C++ given at the
3. We iterate over the "statuses" field using a typical C++ iterator, reading past the initial 3. We iterate over the "statuses" field using a typical C++ iterator, reading past the initial
`{ "statuses": [ {`. `{ "statuses": [ {`.
```cpp ```c++
for (ondemand::object tweet : doc["statuses"]) { for (ondemand::object tweet : doc["statuses"]) {
``` ```
This shorthand does a lot, and it is helpful to see what it expands to. This shorthand does a lot, and it is helpful to see what it expands to.
Comments in front of each one explain what's going on: Comments in front of each one explain what's going on:
```cpp ```c++
// Validate that the top-level value is an object: check for {. Increase depth to 2 (root > field). // Validate that the top-level value is an object: check for {. Increase depth to 2 (root > field).
ondemand::object top = doc.get_object(); ondemand::object top = doc.get_object();
@@ -396,7 +396,7 @@ To help visualize the algorithm, we'll walk through the example C++ given at the
4. We get the `"text"` field as a string. 4. We get the `"text"` field as a string.
```cpp ```c++
std::string_view text = tweet["text"]; std::string_view text = tweet["text"];
``` ```
@@ -435,7 +435,7 @@ To help visualize the algorithm, we'll walk through the example C++ given at the
4. We get the `"screen_name"` from the `"user"` object. 4. We get the `"screen_name"` from the `"user"` object.
```cpp ```c++
ondemand::object user = tweet["user"]; ondemand::object user = tweet["user"];
screen_name = user["screen_name"]; screen_name = user["screen_name"];
``` ```
@@ -469,7 +469,7 @@ To help visualize the algorithm, we'll walk through the example C++ given at the
5. We get `"retweet_count"` as an unsigned integer. 5. We get `"retweet_count"` as an unsigned integer.
```cpp ```c++
uint64_t retweets = tweet["retweet_count"]; uint64_t retweets = tweet["retweet_count"];
``` ```
@@ -513,7 +513,7 @@ To help visualize the algorithm, we'll walk through the example C++ given at the
6. We loop to the next tweet. 6. We loop to the next tweet.
```cpp ```c++
for (ondemand::object tweet : doc["statuses"]) { for (ondemand::object tweet : doc["statuses"]) {
... ...
} }
@@ -521,7 +521,7 @@ To help visualize the algorithm, we'll walk through the example C++ given at the
The relevant parts of the loop are: The relevant parts of the loop are:
```cpp ```c++
while (iter != statuses.end()) { while (iter != statuses.end()) {
ondemand::object tweet = *iter; ondemand::object tweet = *iter;
... ...
@@ -545,7 +545,7 @@ To help visualize the algorithm, we'll walk through the example C++ given at the
"statuses": [ "statuses": [
{ "id": 1, "text": "first!", "user": { "screen_name": "lemire", "name": "Daniel" }, "retweet_count": 40 }, { "id": 1, "text": "first!", "user": { "screen_name": "lemire", "name": "Daniel" }, "retweet_count": 40 },
{ "id": 2, "text": "second!", "user": { "screen_name": "jkeiser2", "name": "John" }, "retweet_count": 3 } { "id": 2, "text": "second!", "user": { "screen_name": "jkeiser2", "name": "John" }, "retweet_count": 3 }
^ (depth 4 - root > statuses > tweet > field) ^ (depth 3 - root > statuses > tweet)
], ],
"search_metadata": { "count": 2 } "search_metadata": { "count": 2 }
} }
@@ -566,7 +566,7 @@ To help visualize the algorithm, we'll walk through the example C++ given at the
8. The loop ends. Recall the relevant parts of the statuses loop: 8. The loop ends. Recall the relevant parts of the statuses loop:
```cpp ```c++
while (iter != statuses.end()) { while (iter != statuses.end()) {
ondemand::object tweet = *iter; ondemand::object tweet = *iter;
... ...
@@ -610,7 +610,7 @@ When the user requests strings, we unescape them to a single string buffer much
so that users enjoy the same string performance as the core simdjson. We do not write the length to the so that users enjoy the same string performance as the core simdjson. We do not write the length to the
string buffer, however; that is stored in the `string_view` instance we return to the user. string buffer, however; that is stored in the `string_view` instance we return to the user.
```cpp ```C++
ondemand::parser parser; ondemand::parser parser;
auto doc = parser.iterate(json); auto doc = parser.iterate(json);
std::set<std::string_view> default_users; std::set<std::string_view> default_users;
@@ -645,7 +645,7 @@ from the `unescaped_key()` method has a lifecycle tied to the `parser` instance:
is destroyed or reused with another document, the `std::string_view` instance becomes invalid. is destroyed or reused with another document, the `std::string_view` instance becomes invalid.
```cpp ```C++
auto doc = parser.iterate(json); auto doc = parser.iterate(json);
for(auto field : doc.get_object()) { for(auto field : doc.get_object()) {
std::string_view keyv = field.unescaped_key(); std::string_view keyv = field.unescaped_key();
@@ -670,11 +670,9 @@ in production systems:
Some care is needed when using the On-Demand API in scenarios where you need to access several sibling arrays or objects because Some care is needed when using the On-Demand API in scenarios where you need to access several sibling arrays or objects because
only one object or array can be active at any one time. Let us consider the following example: only one object or array can be active at any one time. Let us consider the following example:
```cpp ```C++
ondemand::parser parser; ondemand::parser parser;
// R"( ... )" is a C++ raw string literal.
const padded_string json = R"({ "parent": {"child1": {"name": "John"} , "child2": {"name": "Daniel"}} })"_padded; const padded_string json = R"({ "parent": {"child1": {"name": "John"} , "child2": {"name": "Daniel"}} })"_padded;
// _padded returns an simdjson padded_string instance
auto doc = parser.iterate(json); auto doc = parser.iterate(json);
ondemand::object parent = doc["parent"]; ondemand::object parent = doc["parent"];
// parent owns the focus // parent owns the focus
@@ -690,7 +688,7 @@ in production systems:
A correct usage is given by the following example: A correct usage is given by the following example:
```cpp ```C++
ondemand::parser parser; ondemand::parser parser;
const padded_string json = R"({ "parent": {"child1": {"name": "John"} , "child2": {"name": "Daniel"}} })"_padded; const padded_string json = R"({ "parent": {"child1": {"name": "John"} , "child2": {"name": "Daniel"}} })"_padded;
auto doc = parser.iterate(json); auto doc = parser.iterate(json);
@@ -756,7 +754,7 @@ Some users wish to run at the best possible speed. Under recent Intel and AMD pr
Given that the On-Demand API offer limited runtime dispatching, it matters that your code is compiled against a specific CPU target. You should verify that the code is compiled against the target you expect. Thankfully, the simdjson library will tell you exactly what it detects as an implementation: `icelake` (AVX512 x64 processors), `haswell` (AVX2 x64 processors), `westmere` (SSE4 x64 processors), `arm64` (64-bit ARM), `ppc64` (64-bit POWER), `lasx` (LoongArch), `lsx` (LoongArch), `fallback` (others). Under x64 processors, many programmers will want to target `haswell` whereas under ARM, most programmers will want to target `arm64` (and it should do so automatically). The `fallback` is probably only good for testing purposes, not for deployment. Given that the On-Demand API offer limited runtime dispatching, it matters that your code is compiled against a specific CPU target. You should verify that the code is compiled against the target you expect. Thankfully, the simdjson library will tell you exactly what it detects as an implementation: `icelake` (AVX512 x64 processors), `haswell` (AVX2 x64 processors), `westmere` (SSE4 x64 processors), `arm64` (64-bit ARM), `ppc64` (64-bit POWER), `lasx` (LoongArch), `lsx` (LoongArch), `fallback` (others). Under x64 processors, many programmers will want to target `haswell` whereas under ARM, most programmers will want to target `arm64` (and it should do so automatically). The `fallback` is probably only good for testing purposes, not for deployment.
```cpp ```C++
std::cout << simdjson::builtin_implementation()->name() << std::endl; std::cout << simdjson::builtin_implementation()->name() << std::endl;
``` ```
+3 -3
View File
@@ -132,7 +132,7 @@ Whitespace Characters:
Some official formats **(non-exhaustive list)**: Some official formats **(non-exhaustive list)**:
- [Newline-Delimited JSON (NDJSON)](https://github.com/ndjson/ndjson-spec) - [Newline-Delimited JSON (NDJSON)](https://github.com/ndjson/ndjson-spec)
- [JSON lines (JSONL)](http://jsonlines.org/) - [JSON lines (JSONL)](http://jsonlines.org/)
- [Record separator-delimited JSON (RFC 7464)](https://tools.ietf.org/html/rfc7464) <- Not supported by simdjson! - [Record separator-delimited JSON (RFC 7464)](https://tools.ietf.org/html/rfc7464) <- Not supported by JsonStream!
- [More on Wikipedia...](https://en.wikipedia.org/wiki/JSON_streaming) - [More on Wikipedia...](https://en.wikipedia.org/wiki/JSON_streaming)
API API
@@ -184,7 +184,7 @@ You may also call the `source()` method to get a `std::string_view` instance on
Let us illustrate the idea with code: Let us illustrate the idea with code:
```cpp ```C++
auto json = R"([1,2,3] {"1":1,"2":3,"4":4} [1,2,3] )"_padded; auto json = R"([1,2,3] {"1":1,"2":3,"4":4} [1,2,3] )"_padded;
simdjson::dom::parser parser; simdjson::dom::parser parser;
simdjson::dom::document_stream stream; simdjson::dom::document_stream stream;
@@ -225,7 +225,7 @@ Some users may need to work with truncated streams. The simdjson may truncate do
Consider the following example where a truncated document (`{"key":"intentionally unclosed string `) containing 39 bytes has been left within the stream. In such cases, the first two whole documents are parsed and returned, and the `truncated_bytes()` method returns 39. Consider the following example where a truncated document (`{"key":"intentionally unclosed string `) containing 39 bytes has been left within the stream. In such cases, the first two whole documents are parsed and returned, and the `truncated_bytes()` method returns 39.
```cpp ```C++
auto json = R"([1,2,3] {"1":1,"2":3,"4":4} {"key":"intentionally unclosed string )"_padded; auto json = R"([1,2,3] {"1":1,"2":3,"4":4} {"key":"intentionally unclosed string )"_padded;
simdjson::dom::parser parser; simdjson::dom::parser parser;
simdjson::dom::document_stream stream; simdjson::dom::document_stream stream;
+8 -6
View File
@@ -47,7 +47,7 @@ and reuse it. The simdjson library will allocate and retain internal buffers bet
buffers hot in cache and keeping memory allocation and initialization to a minimum. In this manner, buffers hot in cache and keeping memory allocation and initialization to a minimum. In this manner,
you can parse terabytes of JSON data without doing any new allocation. you can parse terabytes of JSON data without doing any new allocation.
```cpp ```c++
ondemand::parser parser; ondemand::parser parser;
// This initializes buffers big enough to handle this JSON. // This initializes buffers big enough to handle this JSON.
@@ -71,14 +71,14 @@ Reusing string buffers
We recommend against creating many `std::string` or `simdjson::padded_string` instances to store the JSON content in your application. [Creating many non-trivial objects is convenient but often surprisingly slow](https://lemire.me/blog/2020/08/08/performance-tip-constructing-many-non-trivial-objects-is-slow/). Instead, as much as possible, you should allocate (once or a few times) reusable memory buffers where you write your JSON content. If you have a buffer `json_str` (of type `char*`) allocated for `capacity` bytes and you store a JSON document spanning `length` bytes, you can pass it to simdjson as follows: We recommend against creating many `std::string` or `simdjson::padded_string` instances to store the JSON content in your application. [Creating many non-trivial objects is convenient but often surprisingly slow](https://lemire.me/blog/2020/08/08/performance-tip-constructing-many-non-trivial-objects-is-slow/). Instead, as much as possible, you should allocate (once or a few times) reusable memory buffers where you write your JSON content. If you have a buffer `json_str` (of type `char*`) allocated for `capacity` bytes and you store a JSON document spanning `length` bytes, you can pass it to simdjson as follows:
```cpp ```c++
auto doc = parser.iterate(padded_string_view(json_str, length, capacity)); auto doc = parser.iterate(padded_string_view(json_str, length, capacity));
``` ```
or simply or simply
```cpp ```c++
auto doc = parser.iterate(json_str, length, capacity); auto doc = parser.iterate(json_str, length, capacity);
``` ```
@@ -89,7 +89,7 @@ Server Loops: Long-Running Processes and Memory Capacity
The On-Demand approach also automatically expands its memory capacity when larger documents are parsed. However, for longer processes where very large files are processed (such as server loops), this capacity is not resized down. On-Demand also lets you adjust the maximal capacity that the parser can process: The On-Demand approach also automatically expands its memory capacity when larger documents are parsed. However, for longer processes where very large files are processed (such as server loops), this capacity is not resized down. On-Demand also lets you adjust the maximal capacity that the parser can process:
* You can set an upper bound (*max_capacity*) when construction the parser: * You can set an upper bound (*max_capacity*) when construction the parser:
```cpp ```C++
ondemand::parser parser(1000*1000); // Never grows past documents > 1 MB ondemand::parser parser(1000*1000); // Never grows past documents > 1 MB
auto doc = parser.iterate(json); auto doc = parser.iterate(json);
for (web_request request : listen()) { for (web_request request : listen()) {
@@ -105,7 +105,7 @@ The On-Demand approach also automatically expands its memory capacity when large
The capacity will grow as the parser encounters larger documents up to 1 MB. The capacity will grow as the parser encounters larger documents up to 1 MB.
* You can also allocate a *fixed capacity* that will never grow: * You can also allocate a *fixed capacity* that will never grow:
```cpp ```C++
ondemand::parser parser(1000*1000); ondemand::parser parser(1000*1000);
parser.allocate(1000*1000) // Fix the capacity to 1 MB parser.allocate(1000*1000) // Fix the capacity to 1 MB
auto doc = parser.iterate(json); auto doc = parser.iterate(json);
@@ -173,6 +173,8 @@ Recent versions of Microsoft Visual Studio on Windows provides support for the L
We recommend Visual Studio users prefer LLVM (clang-cl). It compiles to faster release binaries. Furthermore, it compilers faster in release mode. We recommend Visual Studio users prefer LLVM (clang-cl). It compiles to faster release binaries. Furthermore, it compilers faster in release mode.
Under Windows, we also support the GNU GCC compiler via MSYS2. The performance of 64-bit MSYS2 under Windows is excellent (on par with Linux).
Power Usage and Downclocking Power Usage and Downclocking
-------------- --------------
@@ -253,7 +255,7 @@ long page_size() {
// page boundary. // page boundary.
bool need_allocation(const char *buf, size_t len) { bool need_allocation(const char *buf, size_t len) {
return ((reinterpret_cast<uintptr_t>(buf + len - 1) % page_size()) return ((reinterpret_cast<uintptr_t>(buf + len - 1) % page_size())
+ simdjson::SIMDJSON_PADDING >= static_cast<uintptr_t>(page_size())); + simdjson::SIMDJSON_PADDING > static_cast<uintptr_t>(page_size()));
} }
simdjson::padded_string_view simdjson::padded_string_view
+7 -2
View File
@@ -8,12 +8,17 @@
* Minifies by first parsing, then minifying. * Minifies by first parsing, then minifying.
*/ */
extern "C" int LLVMFuzzerTestOneInput(const uint8_t *Data, size_t Size) { extern "C" int LLVMFuzzerTestOneInput(const uint8_t *Data, size_t Size) {
simdjson::padded_string str(reinterpret_cast<const char *>(Data), Size);
auto begin = as_chars(Data);
auto end = begin + Size;
std::string str(begin, end);
simdjson::dom::parser parser; simdjson::dom::parser parser;
simdjson::dom::element elem; simdjson::dom::element elem;
auto error = parser.parse(str).get(elem); auto error = parser.parse(str).get(elem);
if (error) { return 0; } if (error) { return 0; }
std::string minified = simdjson::minify(elem);
std::string minified=simdjson::minify(elem);
(void)minified; (void)minified;
return 0; return 0;
} }
-7
View File
@@ -53,11 +53,4 @@
#include "simdjson/dom.h" #include "simdjson/dom.h"
#include "simdjson/ondemand.h" #include "simdjson/ondemand.h"
#include "simdjson/convert.h"
#include "simdjson/convert-inl.h"
// Compile-time JSON parsing (C++26 P2996 reflection)
#include "simdjson/compile_time_json.h"
#include "simdjson/compile_time_json-inl.h"
#endif // SIMDJSON_H #endif // SIMDJSON_H
+1
View File
@@ -23,6 +23,7 @@ public:
) const noexcept final; ) const noexcept final;
simdjson_warn_unused error_code minify(const uint8_t *buf, size_t len, uint8_t *dst, size_t &dst_len) const noexcept final; simdjson_warn_unused error_code minify(const uint8_t *buf, size_t len, uint8_t *dst, size_t &dst_len) const noexcept final;
simdjson_warn_unused bool validate_utf8(const char *buf, size_t len) const noexcept final; simdjson_warn_unused bool validate_utf8(const char *buf, size_t len) const noexcept final;
simdjson_warn_unused size_t write_string_escaped(const std::string_view input, char *out) const noexcept final;
}; };
} // namespace arm64 } // namespace arm64
+1 -1
View File
@@ -17,7 +17,7 @@ using namespace simd;
struct backslash_and_quote { struct backslash_and_quote {
public: public:
static constexpr uint32_t BYTES_PROCESSED = 32; static constexpr uint32_t BYTES_PROCESSED = 32;
simdjson_inline backslash_and_quote copy_and_find(const uint8_t *src, uint8_t *dst); simdjson_inline static backslash_and_quote copy_and_find(const uint8_t *src, uint8_t *dst);
simdjson_inline bool has_quote_first() { return ((bs_bits - 1) & quote_bits) != 0; } simdjson_inline bool has_quote_first() { return ((bs_bits - 1) & quote_bits) != 0; }
simdjson_inline bool has_backslash() { return bs_bits != 0; } simdjson_inline bool has_backslash() { return bs_bits != 0; }
-1
View File
@@ -10,7 +10,6 @@
#include "simdjson/error.h" #include "simdjson/error.h"
#include "simdjson/portability.h" #include "simdjson/portability.h"
#include "simdjson/concepts.h" #include "simdjson/concepts.h"
#include "simdjson/constevalutil.h"
/** /**
* @brief The top level simdjson namespace, containing everything the library provides. * @brief The top level simdjson namespace, containing everything the library provides.
+11 -12
View File
@@ -199,6 +199,17 @@ double from_chars(const char *first, const char* end) noexcept;
// We assume by default static linkage // We assume by default static linkage
#define SIMDJSON_DLLIMPORTEXPORT #define SIMDJSON_DLLIMPORTEXPORT
#endif #endif
/**
* Workaround for the vcpkg package manager. Only vcpkg should
* ever touch the next line. The SIMDJSON_USING_LIBRARY macro is otherwise unused.
*/
#if SIMDJSON_USING_LIBRARY
#define SIMDJSON_DLLIMPORTEXPORT __declspec(dllimport)
#endif
/**
* End of workaround for the vcpkg package manager.
*/
#else #else
#define SIMDJSON_DLLIMPORTEXPORT #define SIMDJSON_DLLIMPORTEXPORT
#endif #endif
@@ -345,16 +356,4 @@ namespace std {
#define SIMDJSON_AVX512_ALLOWED 1 #define SIMDJSON_AVX512_ALLOWED 1
#endif #endif
#ifndef __has_cpp_attribute
#define simdjson_lifetime_bound
#elif __has_cpp_attribute(msvc::lifetimebound)
#define simdjson_lifetime_bound [[msvc::lifetimebound]]
#elif __has_cpp_attribute(clang::lifetimebound)
#define simdjson_lifetime_bound [[clang::lifetimebound]]
#elif __has_cpp_attribute(lifetimebound)
#define simdjson_lifetime_bound [[lifetimebound]]
#else
#define simdjson_lifetime_bound
#endif
#endif // SIMDJSON_COMMON_DEFS_H #endif // SIMDJSON_COMMON_DEFS_H
File diff suppressed because it is too large Load Diff
-75
View File
@@ -1,75 +0,0 @@
/**
* @file compile_time_json.h
* @brief Compile-time JSON parsing using C++26 reflection with
* std::meta::substitute()
*/
#ifndef SIMDJSON_GENERIC_COMPILE_TIME_JSON_H
#define SIMDJSON_GENERIC_COMPILE_TIME_JSON_H
#if SIMDJSON_STATIC_REFLECTION
#include <algorithm>
#include <array>
#include <charconv>
#include <cstdint>
#include <expected>
#include <meta>
#include <string>
#include <string_view>
#include <vector>
namespace simdjson {
namespace compile_time {
/**
* @brief Compile-time JSON parser. This function parses the provided JSON
* string at compile time and returns a custom struct type representing the JSON
* object.
*
* We have a few limitations which trigger compile-time errors if violated:
* - Only JSON objects and arrays are supported at the top level (no primitives).
* We will lift this limitation in the future.
* - Strings are represented using the const char * in UTF-8, but they must not
* contain embedded nulls. We would prefer to represent them as std::string or
* std::string_view, and hope to do so in the future.
* - Heterogeneous arrays are not supported yet. E.g., you need to have arrays of
* all integers, or all strings, all floats, all compatible objects, etc.
* For example, the following is accepted:
* [
* { "name": "Alice", "age": 30 },
* { "name": "Bob", "age": 25 },
* { "name": "Charlie", "age": 35 }
* ]
* but the following is not:
* [
* { "name": "Alice", "age": 30 },
* "Just a string",
* 42,
* { "name": "Charlie", "age": 35 }
* ]
*
* We may support heterogeneous arrays in the future with std::variant types.
* - We parse the first JSON document encountered in the string. Trailing
* characters are ignored. Thus if your JSON begins with {"a":1}, everything
* after the closing } is ignored. This limitation will be lifted in the future,
* reporting an error.
*
* These limitations are safe in the sense that they result in compile-time errors.
* Thus you will not get truncated strings or imprecise floats silently.
*
* This function is subject to change in the future.
*/
template <constevalutil::fixed_string json_str> consteval auto parse_json();
} // namespace compile_time
} // namespace simdjson
template <simdjson::constevalutil::fixed_string str>
consteval auto operator ""_json() {
return simdjson::compile_time::parse_json<str>();
}
#endif // SIMDJSON_STATIC_REFLECTION
#endif // SIMDJSON_GENERIC_COMPILE_TIME_JSON_H
+5 -24
View File
@@ -13,11 +13,6 @@
#endif #endif
#endif #endif
// C++ 26
#if !defined(SIMDJSON_CPLUSPLUS26) && (SIMDJSON_CPLUSPLUS >= 202402L) // update when the standard is finalized
#define SIMDJSON_CPLUSPLUS26 1
#endif
// C++ 23 // C++ 23
#if !defined(SIMDJSON_CPLUSPLUS23) && (SIMDJSON_CPLUSPLUS >= 202302L) #if !defined(SIMDJSON_CPLUSPLUS23) && (SIMDJSON_CPLUSPLUS >= 202302L)
#define SIMDJSON_CPLUSPLUS23 1 #define SIMDJSON_CPLUSPLUS23 1
@@ -86,38 +81,24 @@
#endif #endif
#endif #endif
#if defined(__cpp_lib_ranges) && __cpp_lib_ranges >= 201911L
#include <ranges>
#define SIMDJSON_SUPPORTS_RANGES 1
#else
#define SIMDJSON_SUPPORTS_RANGES 0
#endif
#if defined(__cpp_concepts) && !defined(SIMDJSON_CONCEPT_DISABLED) #if defined(__cpp_concepts) && !defined(SIMDJSON_CONCEPT_DISABLED)
#if __cpp_concepts >= 201907L #if __cpp_concepts >= 201907L
#include <utility> #include <utility>
#define SIMDJSON_SUPPORTS_CONCEPTS 1
#else
#define SIMDJSON_SUPPORTS_CONCEPTS 0
#endif
#else // defined(__cpp_concepts) && !defined(SIMDJSON_CONCEPT_DISABLED)
#define SIMDJSON_SUPPORTS_CONCEPTS 0
#endif // defined(__cpp_concepts) && !defined(SIMDJSON_CONCEPT_DISABLED)
// copy SIMDJSON_SUPPORTS_CONCEPTS to SIMDJSON_SUPPORTS_DESERIALIZATION.
#if SIMDJSON_SUPPORTS_CONCEPTS
#define SIMDJSON_SUPPORTS_DESERIALIZATION 1 #define SIMDJSON_SUPPORTS_DESERIALIZATION 1
#else #else
#define SIMDJSON_SUPPORTS_DESERIALIZATION 0 #define SIMDJSON_SUPPORTS_DESERIALIZATION 0
#endif #endif
#else // defined(__cpp_concepts) && !defined(SIMDJSON_CONCEPT_DISABLED)
#define SIMDJSON_SUPPORTS_DESERIALIZATION 0
#endif // defined(__cpp_concepts) && !defined(SIMDJSON_CONCEPT_DISABLED)
#if !defined(SIMDJSON_CONSTEVAL) #if !defined(SIMDJSON_CONSTEVAL)
#if defined(__cpp_consteval) && __cpp_consteval >= 201811L && defined(__cpp_lib_constexpr_string) && __cpp_lib_constexpr_string >= 201907L #if defined(__cpp_consteval) && __cpp_consteval >= 201811L
#define SIMDJSON_CONSTEVAL 1 #define SIMDJSON_CONSTEVAL 1
#else #else
#define SIMDJSON_CONSTEVAL 0 #define SIMDJSON_CONSTEVAL 0
#endif // defined(__cpp_consteval) && __cpp_consteval >= 201811L && defined(__cpp_lib_constexpr_string) && __cpp_lib_constexpr_string >= 201907L #endif // defined(__cpp_consteval) && __cpp_consteval >= 201811L
#endif // !defined(SIMDJSON_CONSTEVAL) #endif // !defined(SIMDJSON_CONSTEVAL)
#endif // SIMDJSON_COMPILER_CHECK_H #endif // SIMDJSON_COMPILER_CHECK_H
+3 -59
View File
@@ -1,6 +1,6 @@
#ifndef SIMDJSON_CONCEPTS_H #ifndef SIMDJSON_CONCEPTS_H
#define SIMDJSON_CONCEPTS_H #define SIMDJSON_CONCEPTS_H
#if SIMDJSON_SUPPORTS_CONCEPTS #if SIMDJSON_SUPPORTS_DESERIALIZATION
#include <concepts> #include <concepts>
#include <type_traits> #include <type_traits>
@@ -32,9 +32,7 @@ SIMDJSON_IMPL_CONCEPT(op_append, operator+=)
#undef SIMDJSON_IMPL_CONCEPT #undef SIMDJSON_IMPL_CONCEPT
} // namespace details } // namespace details
template <typename T>
concept is_pair = requires { typename T::first_type; typename T::second_type; } &&
std::same_as<T, std::pair<typename T::first_type, typename T::second_type>>;
template <typename T> template <typename T>
concept string_view_like = std::is_convertible_v<T, std::string_view> && concept string_view_like = std::is_convertible_v<T, std::string_view> &&
!std::is_convertible_v<T, const char*>; !std::is_convertible_v<T, const char*>;
@@ -122,65 +120,11 @@ concept optional_type = requires(std::remove_cvref_t<T> obj) {
} -> std::convertible_to<typename std::remove_cvref_t<T>::value_type>; } -> std::convertible_to<typename std::remove_cvref_t<T>::value_type>;
}; };
{ static_cast<bool>(obj) } -> std::same_as<bool>; // convertible to bool { static_cast<bool>(obj) } -> std::same_as<bool>; // convertible to bool
{ obj.reset() } noexcept -> std::same_as<void>;
}; };
// Types we serialize as JSON strings (not as containers)
template <typename T>
concept string_like =
std::is_same_v<std::remove_cvref_t<T>, std::string> ||
std::is_same_v<std::remove_cvref_t<T>, std::string_view> ||
std::is_same_v<std::remove_cvref_t<T>, const char*> ||
std::is_same_v<std::remove_cvref_t<T>, char*>;
// Concept that checks if a type is a container but not a string (because
// strings handling must be handled differently)
// Now uses iterator-based approach for broader container support
template <typename T>
concept container_but_not_string =
std::ranges::input_range<T> && !string_like<T> && !concepts::string_view_keyed_map<T>;
// Concept: Indexable container that is not a string or associative container
// Accepts: std::vector, std::array, std::deque (have operator[], value_type, not string_like)
// Rejects: std::string (string_like), std::list (no operator[]), std::map (has key_type)
template<typename Container>
concept indexable_container = requires {
typename Container::value_type;
requires !concepts::string_like<Container>;
requires !requires { typename Container::key_type; }; // Reject maps/sets
requires requires(Container& c, std::size_t i) {
{ c[i] } -> std::convertible_to<typename Container::value_type>;
};
};
// Variable template to use with std::meta::substitute
template<typename Container>
constexpr bool indexable_container_v = indexable_container<Container>;
} // namespace concepts } // namespace concepts
/**
* We use tag_invoke as our customization point mechanism.
*/
template <typename Tag, typename... Args>
concept tag_invocable = requires(Tag tag, Args... args) {
tag_invoke(std::forward<Tag>(tag), std::forward<Args>(args)...);
};
template <typename Tag, typename... Args>
concept nothrow_tag_invocable =
tag_invocable<Tag, Args...> && requires(Tag tag, Args... args) {
{
tag_invoke(std::forward<Tag>(tag), std::forward<Args>(args)...)
} noexcept;
};
} // namespace simdjson } // namespace simdjson
#endif // SIMDJSON_SUPPORTS_CONCEPTS #endif // SIMDJSON_SUPPORTS_DESERIALIZATION
#endif // SIMDJSON_CONCEPTS_H #endif // SIMDJSON_CONCEPTS_H
-89
View File
@@ -1,89 +0,0 @@
#ifndef SIMDJSON_CONSTEVALUTIL_H
#define SIMDJSON_CONSTEVALUTIL_H
#include <string>
#include <string_view>
#include <array>
namespace simdjson {
namespace constevalutil {
#if SIMDJSON_CONSTEVAL
constexpr static std::array<uint8_t, 256> json_quotable_character = {
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
constexpr static std::array<std::string_view, 32> control_chars = {
"\\u0000", "\\u0001", "\\u0002", "\\u0003", "\\u0004", "\\u0005", "\\u0006",
"\\u0007", "\\b", "\\t", "\\n", "\\u000b", "\\f", "\\r",
"\\u000e", "\\u000f", "\\u0010", "\\u0011", "\\u0012", "\\u0013", "\\u0014",
"\\u0015", "\\u0016", "\\u0017", "\\u0018", "\\u0019", "\\u001a", "\\u001b",
"\\u001c", "\\u001d", "\\u001e", "\\u001f"};
// unoptimized, meant for compile-time execution
consteval std::string consteval_to_quoted_escaped(std::string_view input) {
std::string out = "\"";
for (char c : input) {
if (json_quotable_character[uint8_t(c)]) {
if (c == '"') {
out.append("\\\"");
} else if (c == '\\') {
out.append("\\\\");
} else {
std::string_view v = control_chars[uint8_t(c)];
out.append(v);
}
} else {
out.push_back(c);
}
}
out.push_back('"');
return out;
}
#endif // SIMDJSON_CONSTEVAL
#if SIMDJSON_SUPPORTS_CONCEPTS
template <size_t N>
struct fixed_string {
constexpr fixed_string(const char (&str)[N]) {
for (std::size_t i = 0; i < N; ++i) {
data[i] = str[i];
}
}
char data[N];
constexpr std::string_view view() const { return {data, N - 1}; }
constexpr size_t size() const { return N ; }
constexpr operator std::string_view() const { return view(); }
constexpr char operator[](std::size_t index) const { return data[index]; }
constexpr bool operator==(const fixed_string& other) const {
if (N != other.size()) {
return false;
}
for (std::size_t i = 0; i < N; ++i) {
if (data[i] != other.data[i]) {
return false;
}
}
return true;
}
};
template <std::size_t N>
fixed_string(const char (&)[N]) -> fixed_string<N>;
template <fixed_string str>
struct string_constant {
static constexpr std::string_view value = str.view();
};
#endif // SIMDJSON_SUPPORTS_CONCEPTS
} // namespace constevalutil
} // namespace simdjson
#endif // SIMDJSON_CONSTEVALUTIL_H
-135
View File
@@ -1,135 +0,0 @@
#ifndef SIMDJSON_CONVERT_INL_H
#define SIMDJSON_CONVERT_INL_H
#include "simdjson/convert.h"
#if SIMDJSON_SUPPORTS_CONCEPTS
namespace simdjson {
namespace convert {
namespace internal {
// auto_parser method definitions
template <typename parser_type>
inline auto_parser<parser_type>::auto_parser(parser_type &&parser, ondemand::document &&doc) noexcept requires(!std::is_pointer_v<parser_type>)
: m_parser{std::move(parser)}, m_doc{std::move(doc)} {}
template <typename parser_type>
inline auto_parser<parser_type>::auto_parser(parser_type &&parser, padded_string_view const str) noexcept requires(!std::is_pointer_v<parser_type>)
: m_parser{std::move(parser)}, m_doc{}, m_error{SUCCESS} {
m_error = m_parser.iterate(str).get(m_doc);
}
template <typename parser_type>
inline auto_parser<parser_type>::auto_parser(std::remove_pointer_t<parser_type> &parser, ondemand::document &&doc) noexcept requires(std::is_pointer_v<parser_type>)
: m_parser{&parser}, m_doc{std::move(doc)} {}
template <typename parser_type>
inline auto_parser<parser_type>::auto_parser(std::remove_pointer_t<parser_type> &parser, padded_string_view const str) noexcept requires(std::is_pointer_v<parser_type>)
: m_parser{&parser}, m_doc{}, m_error{SUCCESS} {
m_error = m_parser->iterate(str).get(m_doc);
}
template <typename parser_type>
inline auto_parser<parser_type>::auto_parser(padded_string_view const str) noexcept requires(std::is_pointer_v<parser_type>)
: auto_parser{ondemand::parser::get_parser(), str} {}
template <typename parser_type>
inline auto_parser<parser_type>::auto_parser(parser_type parser, ondemand::document &&doc) noexcept requires(std::is_pointer_v<parser_type>)
: auto_parser{*parser, std::move(doc)} {}
template <typename parser_type>
inline std::remove_pointer_t<parser_type> &auto_parser<parser_type>::parser() noexcept {
if constexpr (std::is_pointer_v<parser_type>) {
return *m_parser;
} else {
return m_parser;
}
}
template <typename parser_type>
template <typename T>
inline simdjson_result<T> auto_parser<parser_type>::result() noexcept(is_nothrow_gettable<T>) {
if (m_error != SUCCESS) {
return m_error;
}
return m_doc.get<T>();
}
template <typename parser_type>
template <typename T>
simdjson_warn_unused simdjson_inline error_code auto_parser<parser_type>::get(T &value) && noexcept(is_nothrow_gettable<T>) {
return result<T>().get(value);
}
template <typename parser_type>
inline simdjson_result<ondemand::array> auto_parser<parser_type>::array() noexcept {
return result<ondemand::array>();
}
template <typename parser_type>
inline simdjson_result<ondemand::object> auto_parser<parser_type>::object() noexcept {
return result<ondemand::object>();
}
template <typename parser_type>
inline simdjson_result<ondemand::number> auto_parser<parser_type>::number() noexcept {
return result<ondemand::number>();
}
#if SIMDJSON_EXCEPTIONS
template <typename parser_type>
template <typename T>
inline auto_parser<parser_type>::operator T() noexcept(false) {
if (m_error != SUCCESS) {
throw simdjson_error(m_error);
}
return m_doc.get<T>();
}
#endif // SIMDJSON_EXCEPTIONS
template <typename parser_type>
template <typename T>
inline std::optional<T> auto_parser<parser_type>::optional() noexcept(is_nothrow_gettable<T>) {
if (m_error != SUCCESS) {
return std::nullopt;
}
T value;
if (m_doc.get<T>().get(value)) [[unlikely]] {
return std::nullopt;
}
return {std::move(value)};
}
// to_adaptor method definitions
template <typename T>
inline T to_adaptor<T>::operator()(simdjson_result<ondemand::value> &val) const noexcept {
return val.get<T>();
}
template <typename T>
inline auto to_adaptor<T>::operator()(padded_string_view const str) const noexcept {
return auto_parser<ondemand::parser *>{str};
}
template <typename T>
inline auto to_adaptor<T>::operator()(ondemand::parser &parser, padded_string_view const str) const noexcept {
return auto_parser<ondemand::parser *>{parser, str};
}
template <typename T>
inline auto to_adaptor<T>::operator()(std::string str) const noexcept {
return auto_parser<ondemand::parser *>{pad_with_reserve(str)};
}
template <typename T>
inline auto to_adaptor<T>::operator()(ondemand::parser &parser, std::string str) const noexcept {
return auto_parser<ondemand::parser *>{parser, pad_with_reserve(str)};
}
} // namespace internal
} // namespace convert
} // namespace simdjson
#endif // SIMDJSON_SUPPORTS_CONCEPTS
#endif // SIMDJSON_CONVERT_INL_H
-121
View File
@@ -1,121 +0,0 @@
#ifndef SIMDJSON_CONVERT_H
#define SIMDJSON_CONVERT_H
#include "simdjson/ondemand.h"
#include <optional>
#if SIMDJSON_SUPPORTS_CONCEPTS
namespace simdjson {
namespace convert {
namespace internal {
/**
* A utility class for automatically parsing JSON documents.
* This template is NOT part of our public API.
* It is subject to changes.
* @private
*/
template <typename parser_type = ondemand::parser*>
struct auto_parser {
private:
parser_type m_parser;
ondemand::document m_doc;
error_code m_error{SUCCESS};
template <typename T>
static constexpr bool is_nothrow_gettable = requires(ondemand::document doc) {
{ doc.get<T>() } noexcept;
};
public:
explicit auto_parser(parser_type &&parser, ondemand::document &&doc) noexcept requires(!std::is_pointer_v<parser_type>);
explicit auto_parser(parser_type &&parser, padded_string_view const str) noexcept requires(!std::is_pointer_v<parser_type>);
explicit auto_parser(std::remove_pointer_t<parser_type> &parser, ondemand::document &&doc) noexcept requires(std::is_pointer_v<parser_type>);
explicit auto_parser(std::remove_pointer_t<parser_type> &parser, padded_string_view const str) noexcept requires(std::is_pointer_v<parser_type>);
explicit auto_parser(padded_string_view const str) noexcept requires(std::is_pointer_v<parser_type>);
explicit auto_parser(parser_type parser, ondemand::document &&doc) noexcept requires(std::is_pointer_v<parser_type>);
auto_parser(auto_parser const &) = delete;
auto_parser &operator=(auto_parser const &) = delete;
auto_parser(auto_parser &&) noexcept = default;
auto_parser &operator=(auto_parser &&) noexcept = default;
~auto_parser() = default;
simdjson_warn_unused std::remove_pointer_t<parser_type> &parser() noexcept;
template <typename T>
simdjson_warn_unused simdjson_inline simdjson_result<T> result() noexcept(is_nothrow_gettable<T>);
template <typename T>
simdjson_warn_unused simdjson_inline error_code get(T &value) && noexcept(is_nothrow_gettable<T>);
simdjson_warn_unused simdjson_inline simdjson_result<ondemand::array> array() noexcept;
simdjson_warn_unused simdjson_inline simdjson_result<ondemand::object> object() noexcept;
simdjson_warn_unused simdjson_inline simdjson_result<ondemand::number> number() noexcept;
#if SIMDJSON_EXCEPTIONS
template <typename T>
simdjson_warn_unused simdjson_inline explicit(false) operator T() noexcept(false);
#endif // SIMDJSON_EXCEPTIONS
template <typename T>
simdjson_warn_unused simdjson_inline std::optional<T> optional() noexcept(is_nothrow_gettable<T>);
};
/**
* A utility class for adapting values for the `auto_parser`.
* This template is not part of our public API. It is subject to changes.
* @private
*/
template <typename T = void>
struct to_adaptor {
T operator()(simdjson_result<ondemand::value> &val) const noexcept;
auto operator()(padded_string_view const str) const noexcept;
auto operator()(ondemand::parser &parser, padded_string_view const str) const noexcept;
// The std::string is padded with reserve to ensure there is enough space for padding.
// Some sanitizers may not like this, so you can use simdjson::pad instead.
// simdjson::from(simdjson::pad(str))
auto operator()(std::string str) const noexcept;
auto operator()(ondemand::parser &parser, std::string str) const noexcept;
};
// deduction guide
auto_parser(padded_string_view const str) -> auto_parser<ondemand::parser*>;
} // namespace internal
} // namespace convert
/**
* The simdjson::from instance is EXPERIMENTAL AND SUBJECT TO CHANGES.
*
* The `from` instance is a utility adaptor for parsing JSON strings into objects.
* It provides a convenient way to convert JSON data into C++ objects using the `auto_parser`.
*
* Example usage:
*
* ```cpp
* std::map<std::string, std::string> obj =
* simdjson::from(R"({"key": "value"})"_padded);
* ```
*
* This will parse the JSON string and return an object representation. By default, we
* use the simdjson::ondemand::parser::get_parser() instance. A parser instance should
* be used for just one document at a time.
*
* You can also pass you own parser instance:
* ```cpp
* simdjson::ondemand::parser parser;
* std::map<std::string, std::string> obj =
* simdjson::from(parser, R"({"key": "value"})"_padded);
* ```
* The parser instance can be reused.
*
* This functionality requires C++20 or better.
*/
static constexpr convert::internal::to_adaptor<> from{};
} // namespace simdjson
#endif // SIMDJSON_SUPPORTS_CONCEPTS
#endif // SIMDJSON_CONVERT_H
+2 -109
View File
@@ -52,22 +52,11 @@ inline simdjson_result<dom::element> simdjson_result<dom::array>::at_pointer(std
return at_pointer(json_pointer); return at_pointer(json_pointer);
} }
inline simdjson_result<std::vector<dom::element>> simdjson_result<dom::array>::at_path_with_wildcard(std::string_view json_path) const noexcept {
if (error()) {
return error();
}
return first.at_path_with_wildcard(json_path);
}
inline simdjson_result<dom::element> simdjson_result<dom::array>::at(size_t index) const noexcept { inline simdjson_result<dom::element> simdjson_result<dom::array>::at(size_t index) const noexcept {
if (error()) { return error(); } if (error()) { return error(); }
return first.at(index); return first.at(index);
} }
inline std::vector<dom::element>& simdjson_result<dom::array>::get_values(std::vector<dom::element>& out) const noexcept {
return first.get_values(out);
}
namespace dom { namespace dom {
// //
@@ -138,93 +127,6 @@ inline simdjson_result<element> array::at_path(std::string_view json_path) const
return at_pointer(json_pointer); return at_pointer(json_pointer);
} }
inline void array::process_json_path_of_child_elements(std::vector<element>::iterator& current, std::vector<element>::iterator& end, const std::string_view& path_suffix, std::vector<element>& accumulator) const noexcept {
if (current == end) {
return;
}
simdjson_result<std::vector<element>> result;
for (auto it = current; it != end; ++it) {
std::vector<element> child_result;
auto error = it->at_path_with_wildcard(path_suffix).get(child_result);
if(error) {
continue;
}
accumulator.reserve(accumulator.size() + child_result.size());
accumulator.insert(accumulator.end(),
std::make_move_iterator(child_result.begin()),
std::make_move_iterator(child_result.end()));
}
}
inline simdjson_result<std::vector<element>> array::at_path_with_wildcard(std::string_view json_path) const noexcept {
SIMDJSON_DEVELOPMENT_ASSERT(tape.usable()); // https://github.com/simdjson/simdjson/issues/1914
size_t i = 0;
// json_path.starts_with('$') requires C++20.
if (!json_path.empty() && json_path.front() == '$') {
i = 1;
}
if (i >= json_path.size() || (json_path[i] != '.' && json_path[i] != '[')) {
return INVALID_JSON_POINTER;
}
if (json_path.find("*") != std::string::npos) {
std::vector<element> child_values;
if (
(json_path.compare(i, 3, "[*]") == 0 && json_path.size() == i + 3) ||
(json_path.compare(i, 2,".*") == 0 && json_path.size() == i + 2)
) {
get_values(child_values);
return child_values;
}
std::pair<std::string_view, std::string_view> key_and_json_path = get_next_key_and_json_path(json_path);
std::string_view key = key_and_json_path.first;
json_path = key_and_json_path.second;
if (key.size() > 0) {
if (key == "*") {
get_values(child_values);
} else {
element pointer_result;
std::string json_pointer = std::string("/") + std::string(key);
auto error = at_pointer(json_pointer).get(pointer_result);
if (!error) {
child_values.emplace_back(pointer_result);
}
}
std::vector<element> result = {};
if (child_values.size() > 0) {
std::vector<element>::iterator child_values_begin = child_values.begin();
std::vector<element>::iterator child_values_end = child_values.end();
process_json_path_of_child_elements(child_values_begin, child_values_end, json_path, result);
}
return result;
} else {
return INVALID_JSON_POINTER;
}
} else {
element result;
auto error = at_path(json_path).get(result);
if (error) {
return error;
}
return std::vector<element>{std::move(result)};
}
}
inline simdjson_result<element> array::at(size_t index) const noexcept { inline simdjson_result<element> array::at(size_t index) const noexcept {
SIMDJSON_DEVELOPMENT_ASSERT(tape.usable()); // https://github.com/simdjson/simdjson/issues/1914 SIMDJSON_DEVELOPMENT_ASSERT(tape.usable()); // https://github.com/simdjson/simdjson/issues/1914
size_t i=0; size_t i=0;
@@ -235,15 +137,6 @@ inline simdjson_result<element> array::at(size_t index) const noexcept {
return INDEX_OUT_OF_BOUNDS; return INDEX_OUT_OF_BOUNDS;
} }
inline std::vector<element>& array::get_values(std::vector<element>& out) const noexcept {
out.reserve(this->size());
for (auto element : *this) {
out.emplace_back(element);
}
return out;
}
inline array::operator element() const noexcept { inline array::operator element() const noexcept {
return element(tape); return element(tape);
} }
@@ -290,13 +183,13 @@ inline bool array::iterator::operator>(const array::iterator& other) const noexc
#include "simdjson/dom/element-inl.h" #include "simdjson/dom/element-inl.h"
#if SIMDJSON_SUPPORTS_RANGES #if defined(__cpp_lib_ranges)
static_assert(std::ranges::view<simdjson::dom::array>); static_assert(std::ranges::view<simdjson::dom::array>);
static_assert(std::ranges::sized_range<simdjson::dom::array>); static_assert(std::ranges::sized_range<simdjson::dom::array>);
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
static_assert(std::ranges::view<simdjson::simdjson_result<simdjson::dom::array>>); static_assert(std::ranges::view<simdjson::simdjson_result<simdjson::dom::array>>);
static_assert(std::ranges::sized_range<simdjson::simdjson_result<simdjson::dom::array>>); static_assert(std::ranges::sized_range<simdjson::simdjson_result<simdjson::dom::array>>);
#endif // SIMDJSON_EXCEPTIONS #endif // SIMDJSON_EXCEPTIONS
#endif // SIMDJSON_SUPPORTS_RANGES #endif // defined(__cpp_lib_ranges)
#endif // SIMDJSON_ARRAY_INL_H #endif // SIMDJSON_ARRAY_INL_H
+5 -28
View File
@@ -1,8 +1,6 @@
#ifndef SIMDJSON_DOM_ARRAY_H #ifndef SIMDJSON_DOM_ARRAY_H
#define SIMDJSON_DOM_ARRAY_H #define SIMDJSON_DOM_ARRAY_H
#include <vector>
#include "simdjson/dom/base.h" #include "simdjson/dom/base.h"
#include "simdjson/internal/tape_ref.h" #include "simdjson/internal/tape_ref.h"
@@ -110,23 +108,12 @@ public:
*/ */
inline simdjson_result<element> at_pointer(std::string_view json_pointer) const noexcept; inline simdjson_result<element> at_pointer(std::string_view json_pointer) const noexcept;
/**
* Recursive function which processes the JSON path of each child element
*/
inline void process_json_path_of_child_elements(std::vector<element>::iterator& current, std::vector<element>::iterator& end, const std::string_view& path_suffix, std::vector<element>& accumulator) const noexcept;
/**
* Adds support for JSONPath expression with wildcards '*'
*/
inline simdjson_result<std::vector<element>> at_path_with_wildcard(std::string_view json_path) const noexcept;
/** /**
* Get the value associated with the given JSONPath expression. We only support * Get the value associated with the given JSONPath expression. We only support
* JSONPath queries that trivially convertible to JSON Pointer queries: key * JSONPath queries that trivially convertible to JSON Pointer queries: key
* names and array indices. * names and array indices.
* *
* https://www.rfc-editor.org/rfc/rfc9535 (RFC 9535) * https://datatracker.ietf.org/doc/html/draft-normington-jsonpath-00
* *
* @return The value associated with the given JSONPath expression, or: * @return The value associated with the given JSONPath expression, or:
* - INVALID_JSON_POINTER if the JSONPath to JSON Pointer conversion fails * - INVALID_JSON_POINTER if the JSONPath to JSON Pointer conversion fails
@@ -154,15 +141,6 @@ public:
*/ */
inline simdjson_result<element> at(size_t index) const noexcept; inline simdjson_result<element> at(size_t index) const noexcept;
/**
* Gets the values of items in an array element
* This function has linear-time complexity: the values are checked one by one.
*
* @return The child elements of an array
*/
inline std::vector<element>& get_values(std::vector<element>& out) const noexcept;
/** /**
* Implicitly convert object to element * Implicitly convert object to element
*/ */
@@ -189,11 +167,8 @@ public:
simdjson_inline simdjson_result(error_code error) noexcept; ///< @private simdjson_inline simdjson_result(error_code error) noexcept; ///< @private
inline simdjson_result<dom::element> at_pointer(std::string_view json_pointer) const noexcept; inline simdjson_result<dom::element> at_pointer(std::string_view json_pointer) const noexcept;
inline void process_json_path_of_child_elements(std::vector<dom::element>::iterator& current, std::vector<dom::element>::iterator& end, const std::string_view& path_suffix, std::vector<dom::element>& accumulator) const noexcept;
inline simdjson_result<std::vector<dom::element>> at_path_with_wildcard(std::string_view json_path) const noexcept;
inline simdjson_result<dom::element> at_path(std::string_view json_path) const noexcept; inline simdjson_result<dom::element> at_path(std::string_view json_path) const noexcept;
inline simdjson_result<dom::element> at(size_t index) const noexcept; inline simdjson_result<dom::element> at(size_t index) const noexcept;
inline std::vector<dom::element>& get_values(std::vector<dom::element>& out) const noexcept;
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
inline dom::array::iterator begin() const noexcept(false); inline dom::array::iterator begin() const noexcept(false);
@@ -206,7 +181,9 @@ public:
} // namespace simdjson } // namespace simdjson
#if SIMDJSON_SUPPORTS_RANGES #if defined(__cpp_lib_ranges)
#include <ranges>
namespace std { namespace std {
namespace ranges { namespace ranges {
template<> template<>
@@ -217,6 +194,6 @@ inline constexpr bool enable_view<simdjson::simdjson_result<simdjson::dom::array
#endif // SIMDJSON_EXCEPTIONS #endif // SIMDJSON_EXCEPTIONS
} // namespace ranges } // namespace ranges
} // namespace std } // namespace std
#endif // SIMDJSON_SUPPORTS_RANGES #endif // defined(__cpp_lib_ranges)
#endif // SIMDJSON_DOM_ARRAY_H #endif // SIMDJSON_DOM_ARRAY_H
+1 -1
View File
@@ -74,7 +74,7 @@ public:
/** /**
* Construct an uninitialized document_stream. * Construct an uninitialized document_stream.
* *
* ```cpp * ```c++
* document_stream docs; * document_stream docs;
* error = parser.parse_many(json).get(docs); * error = parser.parse_many(json).get(docs);
* ``` * ```
-20
View File
@@ -128,12 +128,6 @@ simdjson_inline simdjson_result<dom::element> simdjson_result<dom::element>::at_
if (json_pointer == "-1") { return INVALID_JSON_POINTER; } if (json_pointer == "-1") { return INVALID_JSON_POINTER; }
return at_pointer(json_pointer); return at_pointer(json_pointer);
} }
simdjson_inline simdjson_result<std::vector<dom::element>> simdjson_result<dom::element>::at_path_with_wildcard(const std::string_view json_path) const noexcept {
if (error()) { return error(); }
return first.at_path_with_wildcard(json_path);
}
#ifndef SIMDJSON_DISABLE_DEPRECATED_API #ifndef SIMDJSON_DISABLE_DEPRECATED_API
[[deprecated("For standard compliance, use at_pointer instead, and prefix your pointers with a slash '/', see RFC6901 ")]] [[deprecated("For standard compliance, use at_pointer instead, and prefix your pointers with a slash '/', see RFC6901 ")]]
simdjson_inline simdjson_result<dom::element> simdjson_result<dom::element>::at(const std::string_view json_pointer) const noexcept { simdjson_inline simdjson_result<dom::element> simdjson_result<dom::element>::at(const std::string_view json_pointer) const noexcept {
@@ -424,20 +418,6 @@ inline simdjson_result<element> element::at_pointer(std::string_view json_pointe
} }
} }
} }
inline simdjson_result<std::vector<element>> element::at_path_with_wildcard(std::string_view json_path) const noexcept {
SIMDJSON_DEVELOPMENT_ASSERT(tape.usable()); // https://github.com/simdjson/simdjson/issues/1914
switch (tape.tape_ref_type()) {
case internal::tape_type::START_OBJECT:
return object(tape).at_path_with_wildcard(json_path);
case internal::tape_type::START_ARRAY:
return array(tape).at_path_with_wildcard(json_path);
default:
return std::vector<element>{};
}
}
inline simdjson_result<element> element::at_path(std::string_view json_path) const noexcept { inline simdjson_result<element> element::at_path(std::string_view json_path) const noexcept {
auto json_pointer = json_path_to_pointer_conversion(json_path); auto json_pointer = json_path_to_pointer_conversion(json_path);
if (json_pointer == "-1") { return INVALID_JSON_POINTER; } if (json_pointer == "-1") { return INVALID_JSON_POINTER; }
+1 -6
View File
@@ -1,8 +1,6 @@
#ifndef SIMDJSON_DOM_ELEMENT_H #ifndef SIMDJSON_DOM_ELEMENT_H
#define SIMDJSON_DOM_ELEMENT_H #define SIMDJSON_DOM_ELEMENT_H
#include <vector>
#include "simdjson/dom/base.h" #include "simdjson/dom/base.h"
#include "simdjson/dom/array.h" #include "simdjson/dom/array.h"
@@ -401,14 +399,12 @@ public:
*/ */
inline simdjson_result<element> at_pointer(const std::string_view json_pointer) const noexcept; inline simdjson_result<element> at_pointer(const std::string_view json_pointer) const noexcept;
inline simdjson_result<std::vector<element>> at_path_with_wildcard(const std::string_view json_path) const noexcept;
/** /**
* Get the value associated with the given JSONPath expression. We only support * Get the value associated with the given JSONPath expression. We only support
* JSONPath queries that trivially convertible to JSON Pointer queries: key * JSONPath queries that trivially convertible to JSON Pointer queries: key
* names and array indices. * names and array indices.
* *
* https://www.rfc-editor.org/rfc/rfc9535 (RFC 9535) * https://datatracker.ietf.org/doc/html/draft-normington-jsonpath-00
* *
* @return The value associated with the given JSONPath expression, or: * @return The value associated with the given JSONPath expression, or:
* - INVALID_JSON_POINTER if the JSONPath to JSON Pointer conversion fails * - INVALID_JSON_POINTER if the JSONPath to JSON Pointer conversion fails
@@ -548,7 +544,6 @@ public:
simdjson_inline simdjson_result<dom::element> operator[](const char *key) const noexcept; simdjson_inline simdjson_result<dom::element> operator[](const char *key) const noexcept;
simdjson_result<dom::element> operator[](int) const noexcept = delete; simdjson_result<dom::element> operator[](int) const noexcept = delete;
simdjson_inline simdjson_result<dom::element> at_pointer(const std::string_view json_pointer) const noexcept; simdjson_inline simdjson_result<dom::element> at_pointer(const std::string_view json_pointer) const noexcept;
simdjson_inline simdjson_result<std::vector<dom::element>> at_path_with_wildcard(const std::string_view json_path) const noexcept;
simdjson_inline simdjson_result<dom::element> at_path(const std::string_view json_path) const noexcept; simdjson_inline simdjson_result<dom::element> at_path(const std::string_view json_path) const noexcept;
[[deprecated("For standard compliance, use at_pointer instead, and prefix your pointers with a slash '/', see RFC6901 ")]] [[deprecated("For standard compliance, use at_pointer instead, and prefix your pointers with a slash '/', see RFC6901 ")]]
simdjson_inline simdjson_result<dom::element> at(const std::string_view json_pointer) const noexcept; simdjson_inline simdjson_result<dom::element> at(const std::string_view json_pointer) const noexcept;
+2 -114
View File
@@ -40,19 +40,10 @@ inline simdjson_result<dom::element> simdjson_result<dom::object>::at_path(std::
if (json_pointer == "-1") { return INVALID_JSON_POINTER; } if (json_pointer == "-1") { return INVALID_JSON_POINTER; }
return at_pointer(json_pointer); return at_pointer(json_pointer);
} }
inline simdjson_result<std::vector<dom::element>> simdjson_result<dom::object>::at_path_with_wildcard(std::string_view json_path) const noexcept {
if (error()) {
return error();
}
return first.at_path_with_wildcard(json_path);
}
inline simdjson_result<dom::element> simdjson_result<dom::object>::at_key(std::string_view key) const noexcept { inline simdjson_result<dom::element> simdjson_result<dom::object>::at_key(std::string_view key) const noexcept {
if (error()) { return error(); } if (error()) { return error(); }
return first.at_key(key); return first.at_key(key);
} }
inline std::vector<dom::element>& simdjson_result<dom::object>::get_values(std::vector<dom::element>& out) const noexcept {
return first.get_values(out);
}
inline simdjson_result<dom::element> simdjson_result<dom::object>::at_key_case_insensitive(std::string_view key) const noexcept { inline simdjson_result<dom::element> simdjson_result<dom::object>::at_key_case_insensitive(std::string_view key) const noexcept {
if (error()) { return error(); } if (error()) { return error(); }
return first.at_key_case_insensitive(key); return first.at_key_case_insensitive(key);
@@ -152,97 +143,6 @@ inline simdjson_result<element> object::at_path(std::string_view json_path) cons
return at_pointer(json_pointer); return at_pointer(json_pointer);
} }
inline void object::process_json_path_of_child_elements(std::vector<element>::iterator& current, std::vector<element>::iterator& end, const std::string_view& path_suffix, std::vector<element>& accumulator) const noexcept {
if (current == end) {
return;
}
simdjson_result<std::vector<element>> result;
for (auto it = current; it != end; ++it) {
std::vector<element> child_result;
auto error = it->at_path_with_wildcard(path_suffix).get(child_result);
if(error) {
continue;
}
accumulator.reserve(accumulator.size() + child_result.size());
accumulator.insert(accumulator.end(),
std::make_move_iterator(child_result.begin()),
std::make_move_iterator(child_result.end()));
}
}
inline simdjson_result<std::vector<element>> object::at_path_with_wildcard(std::string_view json_path) const noexcept {
SIMDJSON_DEVELOPMENT_ASSERT(tape.usable()); // https://github.com/simdjson/simdjson/issues/1914
size_t i = 0;
if (json_path.empty()) {
return INVALID_JSON_POINTER;
}
// if JSONPath starts with $, skip it
// json_path.starts_with('$') requires C++20.
if (json_path.front() == '$') {
i = 1;
}
if (i >= json_path.size() || (json_path[i] != '.' && json_path[i] != '[')) {
// expect JSONPath expressions to always start with $ but this isn't currently
// expected in jsonpathutil.h.
return INVALID_JSON_POINTER;
}
if (json_path.find("*") != std::string::npos) {
std::vector<element> child_values;
if (
(json_path.compare(i, 3, "[*]") == 0 && json_path.size() == i + 3) ||
(json_path.compare(i, 2,".*") == 0 && json_path.size() == i + 2)
) {
get_values(child_values);
return child_values;
}
std::pair<std::string_view, std::string_view> key_and_json_path = get_next_key_and_json_path(json_path);
std::string_view key = key_and_json_path.first;
json_path = key_and_json_path.second;
if (key.size() > 0) {
if (key == "*") {
get_values(child_values);
} else {
element pointer_result;
auto error = at_pointer(std::string("/") + std::string(key)).get(pointer_result);
if (!error) {
child_values.emplace_back(pointer_result);
}
}
std::vector<element> result = {};
if (child_values.size() > 0) {
std::vector<element>::iterator child_values_begin = child_values.begin();
std::vector<element>::iterator child_values_end = child_values.end();
process_json_path_of_child_elements(child_values_begin, child_values_end, json_path, result);
}
return result;
} else {
return INVALID_JSON_POINTER;
}
} else {
element result;
auto error = this->at_path(json_path).get(result);
if (error) {
return error;
}
return std::vector<element>{std::move(result)};
}
}
inline simdjson_result<element> object::at_key(std::string_view key) const noexcept { inline simdjson_result<element> object::at_key(std::string_view key) const noexcept {
iterator end_field = end(); iterator end_field = end();
for (iterator field = begin(); field != end_field; ++field) { for (iterator field = begin(); field != end_field; ++field) {
@@ -252,18 +152,6 @@ inline simdjson_result<element> object::at_key(std::string_view key) const noexc
} }
return NO_SUCH_FIELD; return NO_SUCH_FIELD;
} }
inline std::vector<element>& object::get_values(std::vector<element>& out) const noexcept {
iterator end_field = end();
iterator begin_field = begin();
out.reserve(std::distance(begin_field, end_field));
for (iterator field = begin_field; field != end_field; ++field) {
out.emplace_back(field.value());
}
return out;
}
// In case you wonder why we need this, please see // In case you wonder why we need this, please see
// https://github.com/simdjson/simdjson/issues/323 // https://github.com/simdjson/simdjson/issues/323
// People do seek keys in a case-insensitive manner. // People do seek keys in a case-insensitive manner.
@@ -375,13 +263,13 @@ inline key_value_pair::key_value_pair(std::string_view _key, element _value) noe
} // namespace simdjson } // namespace simdjson
#if SIMDJSON_SUPPORTS_RANGES #if defined(__cpp_lib_ranges)
static_assert(std::ranges::view<simdjson::dom::object>); static_assert(std::ranges::view<simdjson::dom::object>);
static_assert(std::ranges::sized_range<simdjson::dom::object>); static_assert(std::ranges::sized_range<simdjson::dom::object>);
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
static_assert(std::ranges::view<simdjson::simdjson_result<simdjson::dom::object>>); static_assert(std::ranges::view<simdjson::simdjson_result<simdjson::dom::object>>);
static_assert(std::ranges::sized_range<simdjson::simdjson_result<simdjson::dom::object>>); static_assert(std::ranges::sized_range<simdjson::simdjson_result<simdjson::dom::object>>);
#endif // SIMDJSON_EXCEPTIONS #endif // SIMDJSON_EXCEPTIONS
#endif // SIMDJSON_SUPPORTS_RANGES #endif // defined(__cpp_lib_ranges)
#endif // SIMDJSON_OBJECT_INL_H #endif // SIMDJSON_OBJECT_INL_H
+5 -26
View File
@@ -1,8 +1,6 @@
#ifndef SIMDJSON_DOM_OBJECT_H #ifndef SIMDJSON_DOM_OBJECT_H
#define SIMDJSON_DOM_OBJECT_H #define SIMDJSON_DOM_OBJECT_H
#include <vector>
#include "simdjson/dom/base.h" #include "simdjson/dom/base.h"
#include "simdjson/dom/element.h" #include "simdjson/dom/element.h"
#include "simdjson/internal/tape_ref.h" #include "simdjson/internal/tape_ref.h"
@@ -174,22 +172,12 @@ public:
*/ */
inline simdjson_result<element> at_pointer(std::string_view json_pointer) const noexcept; inline simdjson_result<element> at_pointer(std::string_view json_pointer) const noexcept;
/**
* Recursive function which processes the JSON path of each child element
*/
inline void process_json_path_of_child_elements(std::vector<element>::iterator& current, std::vector<element>::iterator& end, const std::string_view& path_suffix, std::vector<element>& accumulator) const noexcept;
/**
* Adds support for JSONPath expression with wildcards '*'
*/
inline simdjson_result<std::vector<element>> at_path_with_wildcard(std::string_view json_path) const noexcept;
/** /**
* Get the value associated with the given JSONPath expression. We only support * Get the value associated with the given JSONPath expression. We only support
* JSONPath queries that trivially convertible to JSON Pointer queries: key * JSONPath queries that trivially convertible to JSON Pointer queries: key
* names and array indices. * names and array indices.
* *
* https://www.rfc-editor.org/rfc/rfc9535 (RFC 9535) * https://datatracker.ietf.org/doc/html/draft-normington-jsonpath-00
* *
* @return The value associated with the given JSONPath expression, or: * @return The value associated with the given JSONPath expression, or:
* - INVALID_JSON_POINTER if the JSONPath to JSON Pointer conversion fails * - INVALID_JSON_POINTER if the JSONPath to JSON Pointer conversion fails
@@ -215,14 +203,6 @@ public:
*/ */
inline simdjson_result<element> at_key(std::string_view key) const noexcept; inline simdjson_result<element> at_key(std::string_view key) const noexcept;
/**
* Gets the values associated with keys of an object
* This function has linear-time complexity: the keys are checked one by one.
*
* @return the values associated with each key of an object
*/
inline std::vector<element>& get_values(std::vector<element>& out) const noexcept;
/** /**
* Get the value associated with the given key in a case-insensitive manner. * Get the value associated with the given key in a case-insensitive manner.
* It is only guaranteed to work over ASCII inputs. * It is only guaranteed to work over ASCII inputs.
@@ -281,11 +261,8 @@ public:
inline simdjson_result<dom::element> operator[](const char *key) const noexcept; inline simdjson_result<dom::element> operator[](const char *key) const noexcept;
simdjson_result<dom::element> operator[](int) const noexcept = delete; simdjson_result<dom::element> operator[](int) const noexcept = delete;
inline simdjson_result<dom::element> at_pointer(std::string_view json_pointer) const noexcept; inline simdjson_result<dom::element> at_pointer(std::string_view json_pointer) const noexcept;
inline void process_json_path_of_child_elements(std::vector<dom::element>::iterator& current, std::vector<dom::element>::iterator& end, const std::string_view& path_suffix, std::vector<dom::element>& accumulator) const noexcept;
inline simdjson_result<std::vector<dom::element>> at_path_with_wildcard(std::string_view json_path_new) const noexcept;
inline simdjson_result<dom::element> at_path(std::string_view json_path) const noexcept; inline simdjson_result<dom::element> at_path(std::string_view json_path) const noexcept;
inline simdjson_result<dom::element> at_key(std::string_view key) const noexcept; inline simdjson_result<dom::element> at_key(std::string_view key) const noexcept;
inline std::vector<dom::element>& get_values(std::vector<dom::element>& out) const noexcept;
inline simdjson_result<dom::element> at_key_case_insensitive(std::string_view key) const noexcept; inline simdjson_result<dom::element> at_key_case_insensitive(std::string_view key) const noexcept;
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
@@ -297,7 +274,9 @@ public:
} // namespace simdjson } // namespace simdjson
#if SIMDJSON_SUPPORTS_RANGES #if defined(__cpp_lib_ranges)
#include <ranges>
namespace std { namespace std {
namespace ranges { namespace ranges {
template<> template<>
@@ -308,6 +287,6 @@ inline constexpr bool enable_view<simdjson::simdjson_result<simdjson::dom::objec
#endif // SIMDJSON_EXCEPTIONS #endif // SIMDJSON_EXCEPTIONS
} // namespace ranges } // namespace ranges
} // namespace std } // namespace std
#endif // SIMDJSON_SUPPORTS_RANGES #endif // defined(__cpp_lib_ranges)
#endif // SIMDJSON_DOM_OBJECT_H #endif // SIMDJSON_DOM_OBJECT_H
+5 -5
View File
@@ -35,11 +35,11 @@ inline bool parser::dump_raw_tape(std::ostream &os) const noexcept {
return valid ? doc.dump_raw_tape(os) : false; return valid ? doc.dump_raw_tape(os) : false;
} }
inline simdjson_result<size_t> parser::read_file(std::string_view path) noexcept { inline simdjson_result<size_t> parser::read_file(const std::string &path) noexcept {
// Open the file // Open the file
SIMDJSON_PUSH_DISABLE_WARNINGS SIMDJSON_PUSH_DISABLE_WARNINGS
SIMDJSON_DISABLE_DEPRECATED_WARNING // Disable CRT_SECURE warning on MSVC: manually verified this is safe SIMDJSON_DISABLE_DEPRECATED_WARNING // Disable CRT_SECURE warning on MSVC: manually verified this is safe
std::FILE *fp = std::fopen(path.data(), "rb"); std::FILE *fp = std::fopen(path.c_str(), "rb");
SIMDJSON_POP_DISABLE_WARNINGS SIMDJSON_POP_DISABLE_WARNINGS
if (fp == nullptr) { if (fp == nullptr) {
@@ -91,18 +91,18 @@ inline simdjson_result<size_t> parser::read_file(std::string_view path) noexcept
return bytes_read; return bytes_read;
} }
inline simdjson_result<element> parser::load(std::string_view path) & noexcept { inline simdjson_result<element> parser::load(const std::string &path) & noexcept {
return load_into_document(doc, path); return load_into_document(doc, path);
} }
inline simdjson_result<element> parser::load_into_document(document& provided_doc, std::string_view path) & noexcept { inline simdjson_result<element> parser::load_into_document(document& provided_doc, const std::string &path) & noexcept {
size_t len; size_t len;
auto _error = read_file(path).get(len); auto _error = read_file(path).get(len);
if (_error) { return _error; } if (_error) { return _error; }
return parse_into_document(provided_doc, loaded_bytes.get(), len, false); return parse_into_document(provided_doc, loaded_bytes.get(), len, false);
} }
inline simdjson_result<document_stream> parser::load_many(std::string_view path, size_t batch_size) noexcept { inline simdjson_result<document_stream> parser::load_many(const std::string &path, size_t batch_size) noexcept {
size_t len; size_t len;
auto _error = read_file(path).get(len); auto _error = read_file(path).get(len);
if (_error) { return _error; } if (_error) { return _error; }
+11 -8
View File
@@ -102,8 +102,8 @@ public:
* - other json errors if parsing fails. You should not rely on these errors to always the same for the * - other json errors if parsing fails. You should not rely on these errors to always the same for the
* same document: they may vary under runtime dispatch (so they may vary depending on your system and hardware). * same document: they may vary under runtime dispatch (so they may vary depending on your system and hardware).
*/ */
inline simdjson_result<element> load(std::string_view path) & noexcept; inline simdjson_result<element> load(const std::string &path) & noexcept;
inline simdjson_result<element> load(std::string_view path) && = delete ; inline simdjson_result<element> load(const std::string &path) && = delete ;
/** /**
* Load a JSON document from a file into a provide document instance and return a temporary reference to it. * Load a JSON document from a file into a provide document instance and return a temporary reference to it.
@@ -148,8 +148,8 @@ public:
* - other json errors if parsing fails. You should not rely on these errors to always the same for the * - other json errors if parsing fails. You should not rely on these errors to always the same for the
* same document: they may vary under runtime dispatch (so they may vary depending on your system and hardware). * same document: they may vary under runtime dispatch (so they may vary depending on your system and hardware).
*/ */
inline simdjson_result<element> load_into_document(document& doc, std::string_view path) & noexcept; inline simdjson_result<element> load_into_document(document& doc, const std::string &path) & noexcept;
inline simdjson_result<element> load_into_document(document& doc, std::string_view path) && =delete; inline simdjson_result<element> load_into_document(document& doc, const std::string &path) && =delete;
/** /**
* Parse a JSON document and return a temporary reference to it. * Parse a JSON document and return a temporary reference to it.
@@ -204,7 +204,10 @@ public:
* *
* ### std::string references * ### std::string references
* *
* Whenever you pass an std::string reference, the parser may access the bytes beyond the end of * If you pass a mutable std::string reference (std::string&), the parser will seek to extend
* its capacity to SIMDJSON_PADDING bytes beyond the end of the string.
*
* Whenever you pass an std::string reference, the parser will access the bytes beyond the end of
* the string but before the end of the allocated memory (std::string::capacity()). * the string but before the end of the allocated memory (std::string::capacity()).
* If you are using a sanitizer that checks for reading uninitialized bytes or std::string's * If you are using a sanitizer that checks for reading uninitialized bytes or std::string's
* container-overflow checks, you may encounter sanitizer warnings. * container-overflow checks, you may encounter sanitizer warnings.
@@ -236,7 +239,7 @@ public:
/** @overload parse(const uint8_t *buf, size_t len, bool realloc_if_needed) */ /** @overload parse(const uint8_t *buf, size_t len, bool realloc_if_needed) */
simdjson_inline simdjson_result<element> parse(const char *buf, size_t len, bool realloc_if_needed = true) & noexcept; simdjson_inline simdjson_result<element> parse(const char *buf, size_t len, bool realloc_if_needed = true) & noexcept;
simdjson_inline simdjson_result<element> parse(const char *buf, size_t len, bool realloc_if_needed = true) && =delete; simdjson_inline simdjson_result<element> parse(const char *buf, size_t len, bool realloc_if_needed = true) && =delete;
/** @overload parse(const std::string &) */ /** @overload parse(const uint8_t *buf, size_t len, bool realloc_if_needed) */
simdjson_inline simdjson_result<element> parse(const std::string &s) & noexcept; simdjson_inline simdjson_result<element> parse(const std::string &s) & noexcept;
simdjson_inline simdjson_result<element> parse(const std::string &s) && =delete; simdjson_inline simdjson_result<element> parse(const std::string &s) && =delete;
/** @overload parse(const uint8_t *buf, size_t len, bool realloc_if_needed) */ /** @overload parse(const uint8_t *buf, size_t len, bool realloc_if_needed) */
@@ -383,7 +386,7 @@ public:
* - other json errors if parsing fails. You should not rely on these errors to always the same for the * - other json errors if parsing fails. You should not rely on these errors to always the same for the
* same document: they may vary under runtime dispatch (so they may vary depending on your system and hardware). * same document: they may vary under runtime dispatch (so they may vary depending on your system and hardware).
*/ */
inline simdjson_result<document_stream> load_many(std::string_view path, size_t batch_size = dom::DEFAULT_BATCH_SIZE) noexcept; inline simdjson_result<document_stream> load_many(const std::string &path, size_t batch_size = dom::DEFAULT_BATCH_SIZE) noexcept;
/** /**
* Parse a buffer containing many JSON documents. * Parse a buffer containing many JSON documents.
@@ -654,7 +657,7 @@ private:
inline error_code ensure_capacity(document& doc, size_t desired_capacity) noexcept; inline error_code ensure_capacity(document& doc, size_t desired_capacity) noexcept;
/** Read the file into loaded_bytes */ /** Read the file into loaded_bytes */
inline simdjson_result<size_t> read_file(std::string_view path) noexcept; inline simdjson_result<size_t> read_file(const std::string &path) noexcept;
friend class parser::Iterator; friend class parser::Iterator;
friend class document_stream; friend class document_stream;
+108 -139
View File
@@ -3,8 +3,8 @@
#define SIMDJSON_SERIALIZATION_INL_H #define SIMDJSON_SERIALIZATION_INL_H
#include "simdjson/dom/base.h" #include "simdjson/dom/base.h"
#include "simdjson/dom/parser.h"
#include "simdjson/dom/serialization.h" #include "simdjson/dom/serialization.h"
#include "simdjson/dom/parser.h"
#include "simdjson/internal/tape_type.h" #include "simdjson/internal/tape_type.h"
#include "simdjson/dom/array-inl.h" #include "simdjson/dom/array-inl.h"
@@ -16,9 +16,7 @@
namespace simdjson { namespace simdjson {
namespace dom { namespace dom {
inline bool parser::print_json(std::ostream &os) const noexcept { inline bool parser::print_json(std::ostream &os) const noexcept {
if (!valid) { if (!valid) { return false; }
return false;
}
simdjson::internal::string_builder<> sb; simdjson::internal::string_builder<> sb;
sb.append(doc.root()); sb.append(doc.root());
std::string_view answer = sb.str(); std::string_view answer = sb.str();
@@ -26,50 +24,36 @@ inline bool parser::print_json(std::ostream &os) const noexcept {
return true; return true;
} }
inline std::ostream &operator<<(std::ostream &out, inline std::ostream& operator<<(std::ostream& out, simdjson::dom::element value) {
simdjson::dom::element value) {
simdjson::internal::string_builder<> sb; simdjson::internal::string_builder<> sb;
sb.append(value); sb.append(value);
return (out << sb.str()); return (out << sb.str());
} }
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
inline std::ostream & inline std::ostream& operator<<(std::ostream& out, simdjson::simdjson_result<simdjson::dom::element> x) {
operator<<(std::ostream &out, if (x.error()) { throw simdjson::simdjson_error(x.error()); }
simdjson::simdjson_result<simdjson::dom::element> x) {
if (x.error()) {
throw simdjson::simdjson_error(x.error());
}
return (out << x.value()); return (out << x.value());
} }
#endif #endif
inline std::ostream &operator<<(std::ostream &out, simdjson::dom::array value) { inline std::ostream& operator<<(std::ostream& out, simdjson::dom::array value) {
simdjson::internal::string_builder<> sb; simdjson::internal::string_builder<> sb;
sb.append(value); sb.append(value);
return (out << sb.str()); return (out << sb.str());
} }
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
inline std::ostream & inline std::ostream& operator<<(std::ostream& out, simdjson::simdjson_result<simdjson::dom::array> x) {
operator<<(std::ostream &out, if (x.error()) { throw simdjson::simdjson_error(x.error()); }
simdjson::simdjson_result<simdjson::dom::array> x) {
if (x.error()) {
throw simdjson::simdjson_error(x.error());
}
return (out << x.value()); return (out << x.value());
} }
#endif #endif
inline std::ostream &operator<<(std::ostream &out, inline std::ostream& operator<<(std::ostream& out, simdjson::dom::object value) {
simdjson::dom::object value) {
simdjson::internal::string_builder<> sb; simdjson::internal::string_builder<> sb;
sb.append(value); sb.append(value);
return (out << sb.str()); return (out << sb.str());
} }
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
inline std::ostream & inline std::ostream& operator<<(std::ostream& out, simdjson::simdjson_result<simdjson::dom::object> x) {
operator<<(std::ostream &out, if (x.error()) { throw simdjson::simdjson_error(x.error()); }
simdjson::simdjson_result<simdjson::dom::object> x) {
if (x.error()) {
throw simdjson::simdjson_error(x.error());
}
return (out << x.value()); return (out << x.value());
} }
#endif #endif
@@ -86,8 +70,7 @@ namespace {
**/ **/
struct escape_sequence { struct escape_sequence {
uint8_t length; uint8_t length;
const char const char string[7]; // technically, we only ever need 6 characters, we pad to 8
string[7]; // technically, we only ever need 6 characters, we pad to 8
}; };
/**@private /**@private
* This converts a signed integer into a character sequence. * This converts a signed integer into a character sequence.
@@ -103,7 +86,7 @@ static char *fast_itoa(char *output, int64_t value) noexcept {
char buffer[20]; char buffer[20];
uint64_t value_positive; uint64_t value_positive;
// In general, negating a signed integer is unsafe. // In general, negating a signed integer is unsafe.
if (value < 0) { if(value < 0) {
*output++ = '-'; *output++ = '-';
// Doing value_positive = -value; while avoiding // Doing value_positive = -value; while avoiding
// undefined behavior warnings. // undefined behavior warnings.
@@ -122,7 +105,7 @@ static char *fast_itoa(char *output, int64_t value) noexcept {
// A faster approach is possible if we expect large integers: // A faster approach is possible if we expect large integers:
// unroll the loop (work in 100s, 1000s) and use some kind of // unroll the loop (work in 100s, 1000s) and use some kind of
// memoization. // memoization.
while (value_positive >= 10) { while(value_positive >= 10) {
*write_pointer-- = char('0' + (value_positive % 10)); *write_pointer-- = char('0' + (value_positive % 10));
value_positive /= 10; value_positive /= 10;
} }
@@ -148,7 +131,7 @@ static char *fast_itoa(char *output, uint64_t value) noexcept {
// A faster approach is possible if we expect large integers: // A faster approach is possible if we expect large integers:
// unroll the loop (work in 100s, 1000s) and use some kind of // unroll the loop (work in 100s, 1000s) and use some kind of
// memoization. // memoization.
while (value >= 10) { while(value >= 10) {
*write_pointer-- = char('0' + (value % 10)); *write_pointer-- = char('0' + (value % 10));
value /= 10; value /= 10;
}; };
@@ -158,6 +141,7 @@ static char *fast_itoa(char *output, uint64_t value) noexcept {
return output + len; return output + len;
} }
} // anonymous namespace } // anonymous namespace
namespace internal { namespace internal {
@@ -165,154 +149,129 @@ namespace internal {
* Minifier/formatter code. * Minifier/formatter code.
**/ **/
template <class formatter> template<class formatter>
simdjson_inline void base_formatter<formatter>::number(uint64_t x) { simdjson_inline void base_formatter<formatter>::number(uint64_t x) {
char number_buffer[24]; char number_buffer[24];
char *newp = fast_itoa(number_buffer, x); char *newp = fast_itoa(number_buffer, x);
chars(number_buffer, newp); buffer.insert(buffer.end(), number_buffer, newp);
} }
template <class formatter> template<class formatter>
simdjson_inline void base_formatter<formatter>::number(int64_t x) { simdjson_inline void base_formatter<formatter>::number(int64_t x) {
char number_buffer[24]; char number_buffer[24];
char *newp = fast_itoa(number_buffer, x); char *newp = fast_itoa(number_buffer, x);
chars(number_buffer, newp); buffer.insert(buffer.end(), number_buffer, newp);
} }
template <class formatter> template<class formatter>
simdjson_inline void base_formatter<formatter>::number(double x) { simdjson_inline void base_formatter<formatter>::number(double x) {
char number_buffer[24]; char number_buffer[24];
// Currently, passing the nullptr to the second argument is // Currently, passing the nullptr to the second argument is
// safe because our implementation does not check the second // safe because our implementation does not check the second
// argument. // argument.
char *newp = internal::to_chars(number_buffer, nullptr, x); char *newp = internal::to_chars(number_buffer, nullptr, x);
chars(number_buffer, newp); buffer.insert(buffer.end(), number_buffer, newp);
} }
template <class formatter> template<class formatter>
simdjson_inline void base_formatter<formatter>::start_array() { simdjson_inline void base_formatter<formatter>::start_array() { one_char('['); }
one_char('[');
}
template <class formatter>
simdjson_inline void base_formatter<formatter>::end_array() {
one_char(']');
}
template <class formatter> template<class formatter>
simdjson_inline void base_formatter<formatter>::start_object() { simdjson_inline void base_formatter<formatter>::end_array() { one_char(']'); }
one_char('{');
}
template <class formatter> template<class formatter>
simdjson_inline void base_formatter<formatter>::end_object() { simdjson_inline void base_formatter<formatter>::start_object() { one_char('{'); }
one_char('}');
}
template <class formatter> template<class formatter>
simdjson_inline void base_formatter<formatter>::comma() { simdjson_inline void base_formatter<formatter>::end_object() { one_char('}'); }
one_char(',');
}
template <class formatter> template<class formatter>
simdjson_inline void base_formatter<formatter>::comma() { one_char(','); }
template<class formatter>
simdjson_inline void base_formatter<formatter>::true_atom() { simdjson_inline void base_formatter<formatter>::true_atom() {
const char *s = "true"; const char * s = "true";
chars(s, s + 4); buffer.insert(buffer.end(), s, s + 4);
} }
template <class formatter> template<class formatter>
simdjson_inline void base_formatter<formatter>::false_atom() { simdjson_inline void base_formatter<formatter>::false_atom() {
const char *s = "false"; const char * s = "false";
chars(s, s + 5); buffer.insert(buffer.end(), s, s + 5);
} }
template <class formatter> template<class formatter>
simdjson_inline void base_formatter<formatter>::null_atom() { simdjson_inline void base_formatter<formatter>::null_atom() {
const char *s = "null"; const char * s = "null";
chars(s, s + 4); buffer.insert(buffer.end(), s, s + 4);
} }
template <class formatter> template<class formatter>
simdjson_inline void base_formatter<formatter>::one_char(char c) { simdjson_inline void base_formatter<formatter>::one_char(char c) { buffer.push_back(c); }
buffer.push_back(c);
}
template <class formatter> template<class formatter>
simdjson_inline void base_formatter<formatter>::chars(const char *begin, simdjson_inline void base_formatter<formatter>::key(std::string_view unescaped) {
const char *end) {
buffer.append(begin, end);
}
template <class formatter>
simdjson_inline void
base_formatter<formatter>::key(std::string_view unescaped) {
string(unescaped); string(unescaped);
one_char(':'); one_char(':');
} }
template <class formatter> template<class formatter>
simdjson_inline void simdjson_inline void base_formatter<formatter>::string(std::string_view unescaped) {
base_formatter<formatter>::string(std::string_view unescaped) {
one_char('\"'); one_char('\"');
size_t i = 0; size_t i = 0;
// Fast path for the case where we have no control character, no ", and no // Fast path for the case where we have no control character, no ", and no backslash.
// backslash. This should include most keys. // This should include most keys.
// //
// We would like to use 'bool' but some compilers take offense to bitwise // We would like to use 'bool' but some compilers take offense to bitwise operation
// operation with bool types. // with bool types.
constexpr static char needs_escaping[] = { constexpr static char needs_escaping[] = {1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0,
1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, for(;i + 8 <= unescaped.length(); i += 8) {
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
for (; i + 8 <= unescaped.length(); i += 8) {
// Poor's man vectorization. This could get much faster if we used SIMD. // Poor's man vectorization. This could get much faster if we used SIMD.
// //
// It is not the case that replacing '|' with '||' would be neutral // It is not the case that replacing '|' with '||' would be neutral performance-wise.
// performance-wise. if(needs_escaping[uint8_t(unescaped[i])] | needs_escaping[uint8_t(unescaped[i+1])]
if (needs_escaping[uint8_t(unescaped[i])] | | needs_escaping[uint8_t(unescaped[i+2])] | needs_escaping[uint8_t(unescaped[i+3])]
needs_escaping[uint8_t(unescaped[i + 1])] | | needs_escaping[uint8_t(unescaped[i+4])] | needs_escaping[uint8_t(unescaped[i+5])]
needs_escaping[uint8_t(unescaped[i + 2])] | | needs_escaping[uint8_t(unescaped[i+6])] | needs_escaping[uint8_t(unescaped[i+7])]
needs_escaping[uint8_t(unescaped[i + 3])] | ) { break; }
needs_escaping[uint8_t(unescaped[i + 4])] |
needs_escaping[uint8_t(unescaped[i + 5])] |
needs_escaping[uint8_t(unescaped[i + 6])] |
needs_escaping[uint8_t(unescaped[i + 7])]) {
break;
} }
for(;i < unescaped.length(); i++) {
if(needs_escaping[uint8_t(unescaped[i])]) { break; }
} }
for (; i < unescaped.length(); i++) { // The following is also possible and omits a 256-byte table, but it is slower:
if (needs_escaping[uint8_t(unescaped[i])]) { // for (; (i < unescaped.length()) && (uint8_t(unescaped[i]) > 0x1F)
break;
}
}
// The following is also possible and omits a 256-byte table, but it is
// slower: for (; (i < unescaped.length()) && (uint8_t(unescaped[i]) > 0x1F)
// && (unescaped[i] != '\"') && (unescaped[i] != '\\'); i++) {} // && (unescaped[i] != '\"') && (unescaped[i] != '\\'); i++) {}
// At least for long strings, the following should be fast. We could // At least for long strings, the following should be fast. We could
// do better by integrating the checks and the insertion. // do better by integrating the checks and the insertion.
chars(unescaped.data(), unescaped.data() + i); buffer.insert(buffer.end(), unescaped.data(), unescaped.data() + i);
// We caught a control character if we enter this loop (slow). // We caught a control character if we enter this loop (slow).
// Note that we are do not restart from the beginning, but rather we continue // Note that we are do not restart from the beginning, but rather we continue
// from the point where we encountered something that requires escaping. // from the point where we encountered something that requires escaping.
for (; i < unescaped.length(); i++) { for (; i < unescaped.length(); i++) {
switch (unescaped[i]) { switch (unescaped[i]) {
case '\"': { case '\"':
const char *s = "\\\""; {
chars(s, s + 2); const char * s = "\\\"";
} break; buffer.insert(buffer.end(), s, s + 2);
case '\\': { }
const char *s = "\\\\"; break;
chars(s, s + 2); case '\\':
} break; {
const char * s = "\\\\";
buffer.insert(buffer.end(), s, s + 2);
}
break;
default: default:
if (uint8_t(unescaped[i]) <= 0x1F) { if (uint8_t(unescaped[i]) <= 0x1F) {
// If packed, this uses 8 * 32 bytes. // If packed, this uses 8 * 32 bytes.
@@ -328,7 +287,7 @@ base_formatter<formatter>::string(std::string_view unescaped) {
{6, "\\u0018"}, {6, "\\u0019"}, {6, "\\u001a"}, {6, "\\u001b"}, {6, "\\u0018"}, {6, "\\u0019"}, {6, "\\u001a"}, {6, "\\u001b"},
{6, "\\u001c"}, {6, "\\u001d"}, {6, "\\u001e"}, {6, "\\u001f"}}; {6, "\\u001c"}, {6, "\\u001d"}, {6, "\\u001e"}, {6, "\\u001f"}};
auto u = escaped[uint8_t(unescaped[i])]; auto u = escaped[uint8_t(unescaped[i])];
chars(u.string, u.string + u.length); buffer.insert(buffer.end(), u.string, u.string + u.length);
} else { } else {
one_char(unescaped[i]); one_char(unescaped[i]);
} }
@@ -337,36 +296,46 @@ base_formatter<formatter>::string(std::string_view unescaped) {
one_char('\"'); one_char('\"');
} }
template <class formatter> inline void base_formatter<formatter>::clear() {
template<class formatter>
inline void base_formatter<formatter>::clear() {
buffer.clear(); buffer.clear();
} }
template <class formatter> template<class formatter>
simdjson_inline std::string_view base_formatter<formatter>::str() const { simdjson_inline std::string_view base_formatter<formatter>::str() const {
return buffer.str(); return std::string_view(buffer.data(), buffer.size());
} }
simdjson_inline void mini_formatter::print_newline() { return; } simdjson_inline void mini_formatter::print_newline() {
return;
}
simdjson_inline void mini_formatter::print_indents(size_t depth) { simdjson_inline void mini_formatter::print_indents(size_t depth) {
(void)depth; (void)depth;
return; return;
} }
simdjson_inline void mini_formatter::print_space() { return; } simdjson_inline void mini_formatter::print_space() {
return;
}
simdjson_inline void pretty_formatter::print_newline() { one_char('\n'); } simdjson_inline void pretty_formatter::print_newline() {
one_char('\n');
}
simdjson_inline void pretty_formatter::print_indents(size_t depth) { simdjson_inline void pretty_formatter::print_indents(size_t depth) {
if (this->indent_step <= 0) { if(this->indent_step <= 0) {
return; return;
} }
for (size_t i = 0; i < this->indent_step * depth; i++) { for(size_t i = 0; i < this->indent_step * depth; i++) {
one_char(' '); one_char(' ');
} }
} }
simdjson_inline void pretty_formatter::print_space() { one_char(' '); } simdjson_inline void pretty_formatter::print_space() {
one_char(' ');
}
/*** /***
* String building code. * String building code.
@@ -545,8 +514,7 @@ inline void string_builder<serializer>::append(simdjson::dom::array value) {
} }
template <class serializer> template <class serializer>
simdjson_inline void simdjson_inline void string_builder<serializer>::append(simdjson::dom::key_value_pair kv) {
string_builder<serializer>::append(simdjson::dom::key_value_pair kv) {
format.key(kv.key); format.key(kv.key);
append(kv.value); append(kv.value);
} }
@@ -561,6 +529,7 @@ simdjson_inline std::string_view string_builder<serializer>::str() const {
return format.str(); return format.str();
} }
} // namespace internal } // namespace internal
} // namespace simdjson } // namespace simdjson
+44 -105
View File
@@ -5,6 +5,8 @@
#include "simdjson/dom/element.h" #include "simdjson/dom/element.h"
#include "simdjson/dom/object.h" #include "simdjson/dom/object.h"
#include <vector>
namespace simdjson { namespace simdjson {
/** /**
@@ -14,7 +16,8 @@ namespace simdjson {
*/ */
namespace internal { namespace internal {
template <class formatter> class base_formatter { template<class formatter>
class base_formatter {
public: public:
/** Add a comma **/ /** Add a comma **/
simdjson_inline void comma(); simdjson_inline void comma();
@@ -53,77 +56,25 @@ public:
/** Prints one character **/ /** Prints one character **/
simdjson_inline void one_char(char c); simdjson_inline void one_char(char c);
/** Prints characters in [begin, end) verbatim. **/
simdjson_inline void chars(const char *begin, const char *end);
simdjson_inline void call_print_newline() { simdjson_inline void call_print_newline() {
static_cast<formatter *>(this)->print_newline(); static_cast<formatter*>(this)->print_newline();
} }
simdjson_inline void call_print_indents(size_t depth) { simdjson_inline void call_print_indents(size_t depth) {
static_cast<formatter *>(this)->print_indents(depth); static_cast<formatter*>(this)->print_indents(depth);
} }
simdjson_inline void call_print_space() { simdjson_inline void call_print_space() {
static_cast<formatter *>(this)->print_space(); static_cast<formatter*>(this)->print_space();
} }
protected: protected:
// implementation details (subject to change) // implementation details (subject to change)
/** Backing buffer **/ /** Backing buffer **/
struct vector_with_small_buffer { std::vector<char> buffer{}; // not ideal!
vector_with_small_buffer() = default;
~vector_with_small_buffer() { free_buffer(); }
vector_with_small_buffer(const vector_with_small_buffer &) = delete;
vector_with_small_buffer &
operator=(const vector_with_small_buffer &) = delete;
void clear() {
size = 0;
capacity = StaticCapacity;
free_buffer();
buffer = array;
}
simdjson_inline void push_back(char c) {
if (capacity < size + 1)
grow(capacity * 2);
buffer[size++] = c;
}
simdjson_inline void append(const char *begin, const char *end) {
const size_t new_size = size + (end - begin);
if (capacity < new_size)
// std::max(new_size, capacity * 2); is broken in tests on Windows
grow(new_size < capacity * 2 ? capacity * 2 : new_size);
std::copy(begin, end, buffer + size);
size = new_size;
}
std::string_view str() const { return std::string_view(buffer, size); }
private:
void free_buffer() {
if (buffer != array)
delete[] buffer;
}
void grow(size_t new_capacity) {
auto new_buffer = new char[new_capacity];
std::copy(buffer, buffer + size, new_buffer);
free_buffer();
buffer = new_buffer;
capacity = new_capacity;
}
static const size_t StaticCapacity = 64;
char array[StaticCapacity];
char *buffer = array;
size_t size = 0;
size_t capacity = StaticCapacity;
} buffer{};
}; };
/** /**
* @private This is the class that we expect to use with the string_builder * @private This is the class that we expect to use with the string_builder
* template. It tries to produce a compact version of the JSON element * template. It tries to produce a compact version of the JSON element
@@ -156,11 +107,9 @@ protected:
* by a "formatter" which handles the details. Thus * by a "formatter" which handles the details. Thus
* the string_builder template could support both minification * the string_builder template could support both minification
* and prettification, and various other tradeoffs. * and prettification, and various other tradeoffs.
*
* This is not to be confused with the simdjson::builder::string_builder
* which is a different class.
*/ */
template <class formatter = mini_formatter> class string_builder { template <class formatter = mini_formatter>
class string_builder {
public: public:
/** Construct an initially empty builder, would print the empty string **/ /** Construct an initially empty builder, would print the empty string **/
string_builder() = default; string_builder() = default;
@@ -182,12 +131,11 @@ public:
simdjson_inline std::string_view str() const; simdjson_inline std::string_view str() const;
/** Append a key_value_pair to the builder (to be printed) **/ /** Append a key_value_pair to the builder (to be printed) **/
simdjson_inline void append(simdjson::dom::key_value_pair value); simdjson_inline void append(simdjson::dom::key_value_pair value);
private: private:
formatter format{}; formatter format{};
}; };
} // namespace internal } // internal
namespace dom { namespace dom {
@@ -196,43 +144,33 @@ namespace dom {
* *
* @param out The output stream. * @param out The output stream.
* @param value The element. * @param value The element.
* @throw if there is an error with the underlying output stream. simdjson * @throw if there is an error with the underlying output stream. simdjson itself will not throw.
* itself will not throw.
*/ */
inline std::ostream &operator<<(std::ostream &out, inline std::ostream& operator<<(std::ostream& out, simdjson::dom::element value);
simdjson::dom::element value);
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
inline std::ostream & inline std::ostream& operator<<(std::ostream& out, simdjson::simdjson_result<simdjson::dom::element> x);
operator<<(std::ostream &out,
simdjson::simdjson_result<simdjson::dom::element> x);
#endif #endif
/** /**
* Print JSON to an output stream. * Print JSON to an output stream.
* *
* @param out The output stream. * @param out The output stream.
* @param value The array. * @param value The array.
* @throw if there is an error with the underlying output stream. simdjson * @throw if there is an error with the underlying output stream. simdjson itself will not throw.
* itself will not throw.
*/ */
inline std::ostream &operator<<(std::ostream &out, simdjson::dom::array value); inline std::ostream& operator<<(std::ostream& out, simdjson::dom::array value);
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
inline std::ostream & inline std::ostream& operator<<(std::ostream& out, simdjson::simdjson_result<simdjson::dom::array> x);
operator<<(std::ostream &out,
simdjson::simdjson_result<simdjson::dom::array> x);
#endif #endif
/** /**
* Print JSON to an output stream. * Print JSON to an output stream.
* *
* @param out The output stream. * @param out The output stream.
* @param value The object. * @param value The object.
* @throw if there is an error with the underlying output stream. simdjson * @throw if there is an error with the underlying output stream. simdjson itself will not throw.
* itself will not throw.
*/ */
inline std::ostream &operator<<(std::ostream &out, simdjson::dom::object value); inline std::ostream& operator<<(std::ostream& out, simdjson::dom::object value);
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
inline std::ostream & inline std::ostream& operator<<(std::ostream& out, simdjson::simdjson_result<simdjson::dom::object> x);
operator<<(std::ostream &out,
simdjson::simdjson_result<simdjson::dom::object> x);
#endif #endif
} // namespace dom } // namespace dom
@@ -244,47 +182,47 @@ operator<<(std::ostream &out,
* cout << to_string(doc) << endl; // prints [1,2,3] * cout << to_string(doc) << endl; // prints [1,2,3]
* *
*/ */
template <class T> std::string to_string(T x) { template <class T>
// in C++, to_string is standard: std::string to_string(T x) {
// http://www.cplusplus.com/reference/string/to_string/ Currently minify and // in C++, to_string is standard: http://www.cplusplus.com/reference/string/to_string/
// to_string are identical but in the future, they may differ. // Currently minify and to_string are identical but in the future, they may
// differ.
simdjson::internal::string_builder<> sb; simdjson::internal::string_builder<> sb;
sb.append(x); sb.append(x);
std::string_view answer = sb.str(); std::string_view answer = sb.str();
return std::string(answer.data(), answer.size()); return std::string(answer.data(), answer.size());
} }
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
template <class T> std::string to_string(simdjson_result<T> x) { template <class T>
if (x.error()) { std::string to_string(simdjson_result<T> x) {
throw simdjson_error(x.error()); if (x.error()) { throw simdjson_error(x.error()); }
}
return to_string(x.value()); return to_string(x.value());
} }
#endif #endif
/** /**
* Minifies a JSON element or document, printing the smallest possible valid * Minifies a JSON element or document, printing the smallest possible valid JSON.
* JSON.
* *
* dom::parser parser; * dom::parser parser;
* element doc = parser.parse(" [ 1 , 2 , 3 ] "_padded); * element doc = parser.parse(" [ 1 , 2 , 3 ] "_padded);
* cout << minify(doc) << endl; // prints [1,2,3] * cout << minify(doc) << endl; // prints [1,2,3]
* *
*/ */
template <class T> std::string minify(T x) { return to_string(x); } template <class T>
std::string minify(T x) {
return to_string(x);
}
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
template <class T> std::string minify(simdjson_result<T> x) { template <class T>
if (x.error()) { std::string minify(simdjson_result<T> x) {
throw simdjson_error(x.error()); if (x.error()) { throw simdjson_error(x.error()); }
}
return to_string(x.value()); return to_string(x.value());
} }
#endif #endif
/** /**
* Prettifies a JSON element or document, printing the valid JSON with * Prettifies a JSON element or document, printing the valid JSON with indentation.
* indentation.
* *
* dom::parser parser; * dom::parser parser;
* element doc = parser.parse(" [ 1 , 2 , 3 ] "_padded); * element doc = parser.parse(" [ 1 , 2 , 3 ] "_padded);
@@ -300,7 +238,8 @@ template <class T> std::string minify(simdjson_result<T> x) {
* cout << prettify(doc) << endl; * cout << prettify(doc) << endl;
* *
*/ */
template <class T> std::string prettify(T x) { template <class T>
std::string prettify(T x) {
simdjson::internal::string_builder<simdjson::internal::pretty_formatter> sb; simdjson::internal::string_builder<simdjson::internal::pretty_formatter> sb;
sb.append(x); sb.append(x);
std::string_view answer = sb.str(); std::string_view answer = sb.str();
@@ -308,14 +247,14 @@ template <class T> std::string prettify(T x) {
} }
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
template <class T> std::string prettify(simdjson_result<T> x) { template <class T>
if (x.error()) { std::string prettify(simdjson_result<T> x) {
throw simdjson_error(x.error()); if (x.error()) { throw simdjson_error(x.error()); }
}
return to_string(x.value()); return to_string(x.value());
} }
#endif #endif
} // namespace simdjson } // namespace simdjson
#endif #endif
+18 -33
View File
@@ -67,38 +67,8 @@ simdjson_inline error_code simdjson_result_base<T>::error() const noexcept {
return this->second; return this->second;
} }
template<typename T>
simdjson_inline bool simdjson_result_base<T>::has_value() const noexcept {
return this->error() == SUCCESS;
}
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
template<typename T>
simdjson_inline T& simdjson_result_base<T>::operator*() & noexcept(false) {
return this->value();
}
template<typename T>
simdjson_inline T&& simdjson_result_base<T>::operator*() && noexcept(false) {
return std::forward<internal::simdjson_result_base<T>>(*this).value();
}
template<typename T>
simdjson_inline T* simdjson_result_base<T>::operator->() noexcept(false) {
if (this->error()) { throw simdjson_error(this->error()); }
return &this->first;
}
template<typename T>
simdjson_inline const T* simdjson_result_base<T>::operator->() const noexcept(false) {
if (this->error()) { throw simdjson_error(this->error()); }
return &this->first;
}
template<typename T> template<typename T>
simdjson_inline T& simdjson_result_base<T>::value() & noexcept(false) { simdjson_inline T& simdjson_result_base<T>::value() & noexcept(false) {
if (error()) { throw simdjson_error(error()); } if (error()) { throw simdjson_error(error()); }
@@ -123,7 +93,6 @@ simdjson_inline simdjson_result_base<T>::operator T&&() && noexcept(false) {
#endif // SIMDJSON_EXCEPTIONS #endif // SIMDJSON_EXCEPTIONS
template<typename T> template<typename T>
simdjson_inline const T& simdjson_result_base<T>::value_unsafe() const& noexcept { simdjson_inline const T& simdjson_result_base<T>::value_unsafe() const& noexcept {
return this->first; return this->first;
@@ -159,11 +128,27 @@ simdjson_inline void simdjson_result<T>::tie(T &value, error_code &error) && noe
} }
template<typename T> template<typename T>
simdjson_warn_unused simdjson_inline error_code simdjson_warn_unused simdjson_inline error_code simdjson_result<T>::get(T &value) && noexcept {
simdjson_result<T>::get(T &value) && noexcept {
return std::forward<internal::simdjson_result_base<T>>(*this).get(value); return std::forward<internal::simdjson_result_base<T>>(*this).get(value);
} }
template<typename T>
simdjson_warn_unused simdjson_inline error_code
simdjson_result<T>::get(std::string &value) && noexcept
#if SIMDJSON_SUPPORTS_DESERIALIZATION
requires (!std::is_same_v<T, std::string>)
#endif // SIMDJSON_SUPPORTS_DESERIALIZATION
{
// SFINAE : n'active que pour T = std::string_view
static_assert(std::is_same<T, std::string_view>::value, "simdjson_result<T>::get(std::string&) n'est disponible que pour T = std::string_view");
std::string_view v;
error_code error = std::forward<simdjson_result<T>>(*this).get(v);
if (!error) {
value.assign(v.data(), v.size());
}
return error;
}
template<typename T> template<typename T>
simdjson_inline error_code simdjson_result<T>::error() const noexcept { simdjson_inline error_code simdjson_result<T>::error() const noexcept {
return internal::simdjson_result_base<T>::error(); return internal::simdjson_result_base<T>::error();
+7 -74
View File
@@ -108,10 +108,6 @@ namespace internal {
/** /**
* The result of a simdjson operation that could fail. * The result of a simdjson operation that could fail.
* *
* IMPORTANT: For the ondemand API, we use implementation_simdjson_result_base<T> as a base class
* to avoid some compilation issue. Thus, if you modify this class, please ensure that the ondemand
* implementation_simdjson_result_base<T> is also modified.
*
* Gives the option of reading error codes, or throwing an exception by casting to the desired result. * Gives the option of reading error codes, or throwing an exception by casting to the desired result.
* *
* This is a base class for implementations that want to add functions to the result type for * This is a base class for implementations that want to add functions to the result type for
@@ -172,27 +168,8 @@ struct simdjson_result_base : protected std::pair<T, error_code> {
*/ */
simdjson_inline error_code error() const noexcept; simdjson_inline error_code error() const noexcept;
/**
* Whether there is a value.
*/
simdjson_inline bool has_value() const noexcept;
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
/**
* Dereference operator to access the contained value.
*
* @throw simdjson_error if there was an error.
*/
simdjson_inline T& operator*() & noexcept(false);
simdjson_inline T&& operator*() && noexcept(false);
/**
* Arrow operator to access members of the contained value.
*
* @throw simdjson_error if there was an error.
*/
simdjson_inline T* operator->() noexcept(false);
simdjson_inline const T* operator->() const noexcept(false);
/** /**
* Get the result value. * Get the result value.
* *
@@ -226,47 +203,15 @@ struct simdjson_result_base : protected std::pair<T, error_code> {
/** /**
* Get the result value. This function is safe if and only * Get the result value. This function is safe if and only
* the error() method returns a value that evaluates to false. * the error() method returns a value that evaluates to false.
* We discourage the use of value_unsafe().
*
* The recommended pattern is:
*
* T value; // where T is the type
* auto error = result.get(value);
* if (error) {
* // handle error
* }
*
* Or you may call 'value()' which will raise an exception
* in case of error:
*
* T value = result.value();
*/ */
simdjson_inline const T& value_unsafe() const& noexcept; simdjson_inline const T& value_unsafe() const& noexcept;
/** /**
* Take the result value (move it). This function is safe if and only * Take the result value (move it). This function is safe if and only
* the error() method returns a value that evaluates to false. * the error() method returns a value that evaluates to false.
* We discourage the use of value_unsafe().
*
* The recommended pattern is:
*
* T value; // where T is the type
* auto error = result.get(value);
* if (error) {
* // handle error, return, exit, abort
* } else {
* // use value here.
* }
*
* Or you may call 'value()' which will raise an exception
* in case of error:
*
* T value = result.value();
*/ */
simdjson_inline T&& value_unsafe() && noexcept; simdjson_inline T&& value_unsafe() && noexcept;
using value_type = T;
using error_type = error_code;
}; // struct simdjson_result_base }; // struct simdjson_result_base
} // namespace internal } // namespace internal
@@ -278,7 +223,6 @@ struct simdjson_result_base : protected std::pair<T, error_code> {
*/ */
template<typename T> template<typename T>
struct simdjson_result : public internal::simdjson_result_base<T> { struct simdjson_result : public internal::simdjson_result_base<T> {
/** /**
* @private Create a new empty result with error = UNINITIALIZED. * @private Create a new empty result with error = UNINITIALIZED.
*/ */
@@ -310,33 +254,24 @@ struct simdjson_result : public internal::simdjson_result_base<T> {
* @param value The variable to assign the value to. May not be set if there is an error. * @param value The variable to assign the value to. May not be set if there is an error.
*/ */
simdjson_warn_unused simdjson_inline error_code get(T &value) && noexcept; simdjson_warn_unused simdjson_inline error_code get(T &value) && noexcept;
//
/** /**
* Copy the value to a provided std::string, only enabled for std::string_view. * Copy the value to a provided std::string, only enabled for std::string_view.
* *
* @param value The variable to assign the value to. May not be set if there is an error. * @param value The variable to assign the value to. May not be set if there is an error.
*/ */
template <typename U = T> simdjson_warn_unused simdjson_inline error_code get(std::string &value) && noexcept
simdjson_warn_unused simdjson_inline error_code get(std::string &value) && noexcept { #if SIMDJSON_SUPPORTS_DESERIALIZATION
static_assert(std::is_same<U, std::string_view>::value, "SFINAE"); requires (!std::is_same_v<T, std::string>)
std::string_view v; #endif // SIMDJSON_SUPPORTS_DESERIALIZATION
error_code error = std::forward<simdjson_result<T>>(*this).get(v); ;
if (!error) {
value.assign(v.data(), v.size());
}
return error;
}
/** /**
* The error. * The error.
*/ */
simdjson_inline error_code error() const noexcept; simdjson_inline error_code error() const noexcept;
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
using internal::simdjson_result_base<T>::operator*;
using internal::simdjson_result_base<T>::operator->;
/** /**
* Get the result value. * Get the result value.
* *
@@ -378,8 +313,6 @@ struct simdjson_result : public internal::simdjson_result_base<T> {
*/ */
simdjson_inline T&& value_unsafe() && noexcept; simdjson_inline T&& value_unsafe() && noexcept;
using value_type = T;
using error_type = error_code;
}; // struct simdjson_result }; // struct simdjson_result
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
@@ -26,6 +26,7 @@ public:
) const noexcept final; ) const noexcept final;
simdjson_warn_unused error_code minify(const uint8_t *buf, size_t len, uint8_t *dst, size_t &dst_len) const noexcept final; simdjson_warn_unused error_code minify(const uint8_t *buf, size_t len, uint8_t *dst, size_t &dst_len) const noexcept final;
simdjson_warn_unused bool validate_utf8(const char *buf, size_t len) const noexcept final; simdjson_warn_unused bool validate_utf8(const char *buf, size_t len) const noexcept final;
simdjson_warn_unused size_t write_string_escaped(const std::string_view input, char *out) const noexcept final;
}; };
} // namespace fallback } // namespace fallback
@@ -13,7 +13,7 @@ namespace {
struct backslash_and_quote { struct backslash_and_quote {
public: public:
static constexpr uint32_t BYTES_PROCESSED = 1; static constexpr uint32_t BYTES_PROCESSED = 1;
simdjson_inline backslash_and_quote copy_and_find(const uint8_t *src, uint8_t *dst); simdjson_inline static backslash_and_quote copy_and_find(const uint8_t *src, uint8_t *dst);
simdjson_inline bool has_quote_first() { return c == '"'; } simdjson_inline bool has_quote_first() { return c == '"'; }
simdjson_inline bool has_backslash() { return c == '\\'; } simdjson_inline bool has_backslash() { return c == '\\'; }
@@ -29,41 +29,12 @@ simdjson_warn_unused simdjson_inline error_code implementation_simdjson_result_b
} }
template<typename T> template<typename T>
simdjson_warn_unused simdjson_inline error_code implementation_simdjson_result_base<T>::error() const noexcept { simdjson_inline error_code implementation_simdjson_result_base<T>::error() const noexcept {
return this->second; return this->second;
} }
template<typename T>
simdjson_warn_unused simdjson_inline bool implementation_simdjson_result_base<T>::has_value() const noexcept {
return this->error() == SUCCESS;
}
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
template<typename T>
simdjson_inline T& implementation_simdjson_result_base<T>::operator*() & noexcept(false) {
return this->value();
}
template<typename T>
simdjson_inline T&& implementation_simdjson_result_base<T>::operator*() && noexcept(false) {
return std::forward<implementation_simdjson_result_base<T>>(*this).value();
}
template<typename T>
simdjson_inline T* implementation_simdjson_result_base<T>::operator->() noexcept(false) {
if (this->error()) { throw simdjson_error(this->error()); }
return &this->first;
}
template<typename T>
simdjson_inline const T* implementation_simdjson_result_base<T>::operator->() const noexcept(false) {
if (this->error()) { throw simdjson_error(this->error()); }
return &this->first;
}
template<typename T> template<typename T>
simdjson_inline T& implementation_simdjson_result_base<T>::value() & noexcept(false) { simdjson_inline T& implementation_simdjson_result_base<T>::value() & noexcept(false) {
if (error()) { throw simdjson_error(error()); } if (error()) { throw simdjson_error(error()); }
@@ -67,17 +67,12 @@ struct implementation_simdjson_result_base {
* *
* @param value The variable to assign the value to. May not be set if there is an error. * @param value The variable to assign the value to. May not be set if there is an error.
*/ */
simdjson_warn_unused simdjson_inline error_code get(T &value) && noexcept; simdjson_inline error_code get(T &value) && noexcept;
/** /**
* The error. * The error.
*/ */
simdjson_warn_unused simdjson_inline error_code error() const noexcept; simdjson_inline error_code error() const noexcept;
/**
* Whether there is a value.
*/
simdjson_warn_unused simdjson_inline bool has_value() const noexcept;
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
@@ -86,16 +81,6 @@ struct implementation_simdjson_result_base {
* *
* @throw simdjson_error if there was an error. * @throw simdjson_error if there was an error.
*/ */
simdjson_inline T& operator*() & noexcept(false);
simdjson_inline T&& operator*() && noexcept(false);
/**
* Arrow operator to access members of the contained value.
*
* @throw simdjson_error if there was an error.
*/
simdjson_inline T* operator->() noexcept(false);
simdjson_inline const T* operator->() const noexcept(false);
simdjson_inline T& value() & noexcept(false); simdjson_inline T& value() & noexcept(false);
/** /**
@@ -137,10 +122,6 @@ struct implementation_simdjson_result_base {
* the error() method returns a value that evaluates to false. * the error() method returns a value that evaluates to false.
*/ */
simdjson_inline T&& value_unsafe() && noexcept; simdjson_inline T&& value_unsafe() && noexcept;
using value_type = T;
using error_type = error_code;
protected: protected:
/** users should never directly access first and second. **/ /** users should never directly access first and second. **/
T first{}; /** Users should never directly access 'first'. **/ T first{}; /** Users should never directly access 'first'. **/
+6 -15
View File
@@ -167,12 +167,7 @@ simdjson_inline bool compute_float_64(int64_t power, uint64_t i, bool negative,
// with a returned value of type value128 with a "low component" corresponding to the // with a returned value of type value128 with a "low component" corresponding to the
// 64-bit least significant bits of the product and with a "high component" corresponding // 64-bit least significant bits of the product and with a "high component" corresponding
// to the 64-bit most significant bits of the product. // to the 64-bit most significant bits of the product.
#if SIMDJSON_STATIC_REFLECTION
simdjson::internal::value128 firstproduct = full_multiplication(i, simdjson::internal::powers_template<>::power_of_five_128[index]);
#else
simdjson::internal::value128 firstproduct = full_multiplication(i, simdjson::internal::power_of_five_128[index]); simdjson::internal::value128 firstproduct = full_multiplication(i, simdjson::internal::power_of_five_128[index]);
#endif
// Both i and power_of_five_128[index] have their most significant bit set to 1 which // Both i and power_of_five_128[index] have their most significant bit set to 1 which
// implies that the either the most or the second most significant bit of the product // implies that the either the most or the second most significant bit of the product
// is 1. We pack values in this manner for efficiency reasons: it maximizes the use // is 1. We pack values in this manner for efficiency reasons: it maximizes the use
@@ -205,11 +200,7 @@ simdjson_inline bool compute_float_64(int64_t power, uint64_t i, bool negative,
// with a returned value of type value128 with a "low component" corresponding to the // with a returned value of type value128 with a "low component" corresponding to the
// 64-bit least significant bits of the product and with a "high component" corresponding // 64-bit least significant bits of the product and with a "high component" corresponding
// to the 64-bit most significant bits of the product. // to the 64-bit most significant bits of the product.
#if SIMDJSON_STATIC_REFLECTION
simdjson::internal::value128 secondproduct = full_multiplication(i, simdjson::internal::powers_template<>::power_of_five_128[index + 1]);
#else
simdjson::internal::value128 secondproduct = full_multiplication(i, simdjson::internal::power_of_five_128[index + 1]); simdjson::internal::value128 secondproduct = full_multiplication(i, simdjson::internal::power_of_five_128[index + 1]);
#endif
firstproduct.low += secondproduct.high; firstproduct.low += secondproduct.high;
if(secondproduct.high > firstproduct.low) { firstproduct.high++; } if(secondproduct.high > firstproduct.low) { firstproduct.high++; }
// As it has been proven by Noble Mushtak and Daniel Lemire in "Fast Number Parsing Without // As it has been proven by Noble Mushtak and Daniel Lemire in "Fast Number Parsing Without
@@ -370,7 +361,7 @@ simdjson_inline bool is_digit(const uint8_t c) {
return static_cast<uint8_t>(c - '0') <= 9; return static_cast<uint8_t>(c - '0') <= 9;
} }
simdjson_warn_unused simdjson_inline error_code parse_decimal_after_separator(simdjson_unused const uint8_t *const src, const uint8_t *&p, uint64_t &i, int64_t &exponent) { simdjson_inline error_code parse_decimal_after_separator(simdjson_unused const uint8_t *const src, const uint8_t *&p, uint64_t &i, int64_t &exponent) {
// we continue with the fiction that we have an integer. If the // we continue with the fiction that we have an integer. If the
// floating point number is representable as x * 10^z for some integer // floating point number is representable as x * 10^z for some integer
// z that fits in 53 bits, then we will be able to convert back the // z that fits in 53 bits, then we will be able to convert back the
@@ -398,7 +389,7 @@ simdjson_warn_unused simdjson_inline error_code parse_decimal_after_separator(si
return SUCCESS; return SUCCESS;
} }
simdjson_warn_unused simdjson_inline error_code parse_exponent(simdjson_unused const uint8_t *const src, const uint8_t *&p, int64_t &exponent) { simdjson_inline error_code parse_exponent(simdjson_unused const uint8_t *const src, const uint8_t *&p, int64_t &exponent) {
// Exp Sign: -123.456e[-]78 // Exp Sign: -123.456e[-]78
bool neg_exp = ('-' == *p); bool neg_exp = ('-' == *p);
if (neg_exp || '+' == *p) { p++; } // Skip + as well if (neg_exp || '+' == *p) { p++; } // Skip + as well
@@ -487,7 +478,7 @@ static error_code slow_float_parsing(simdjson_unused const uint8_t * src, double
/** @private */ /** @private */
template<typename W> template<typename W>
simdjson_warn_unused simdjson_inline error_code write_float(const uint8_t *const src, bool negative, uint64_t i, const uint8_t * start_digits, size_t digit_count, int64_t exponent, W &writer) { simdjson_inline error_code write_float(const uint8_t *const src, bool negative, uint64_t i, const uint8_t * start_digits, size_t digit_count, int64_t exponent, W &writer) {
// If we frequently had to deal with long strings of digits, // If we frequently had to deal with long strings of digits,
// we could extend our code by using a 128-bit integer instead // we could extend our code by using a 128-bit integer instead
// of a 64-bit integer. However, this is uncommon in practice. // of a 64-bit integer. However, this is uncommon in practice.
@@ -550,13 +541,13 @@ simdjson_warn_unused simdjson_inline error_code write_float(const uint8_t *const
// //
// Our objective is accurate parsing (ULP of 0) at high speed. // Our objective is accurate parsing (ULP of 0) at high speed.
template<typename W> template<typename W>
simdjson_warn_unused simdjson_inline error_code parse_number(const uint8_t *const src, W &writer); simdjson_inline error_code parse_number(const uint8_t *const src, W &writer);
// for performance analysis, it is sometimes useful to skip parsing // for performance analysis, it is sometimes useful to skip parsing
#ifdef SIMDJSON_SKIPNUMBERPARSING #ifdef SIMDJSON_SKIPNUMBERPARSING
template<typename W> template<typename W>
simdjson_warn_unused simdjson_inline error_code parse_number(const uint8_t *const, W &writer) { simdjson_inline error_code parse_number(const uint8_t *const, W &writer) {
writer.append_s64(0); // always write zero writer.append_s64(0); // always write zero
return SUCCESS; // always succeeds return SUCCESS; // always succeeds
} }
@@ -582,7 +573,7 @@ simdjson_unused simdjson_inline simdjson_result<number_type> get_number_type(con
// //
// Our objective is accurate parsing (ULP of 0) at high speed. // Our objective is accurate parsing (ULP of 0) at high speed.
template<typename W> template<typename W>
simdjson_warn_unused simdjson_inline error_code parse_number(const uint8_t *const src, W &writer) { simdjson_inline error_code parse_number(const uint8_t *const src, W &writer) {
// //
// Check for minus sign // Check for minus sign
// //
@@ -14,9 +14,6 @@
#include "simdjson/generic/ondemand/raw_json_string.h" #include "simdjson/generic/ondemand/raw_json_string.h"
#include "simdjson/generic/ondemand/parser.h" #include "simdjson/generic/ondemand/parser.h"
// JSON builder - needed for extract_into functionality
#include "simdjson/generic/ondemand/json_string_builder.h"
// All other declarations // All other declarations
#include "simdjson/generic/ondemand/array.h" #include "simdjson/generic/ondemand/array.h"
#include "simdjson/generic/ondemand/array_iterator.h" #include "simdjson/generic/ondemand/array_iterator.h"
@@ -48,10 +45,9 @@
#include "simdjson/generic/ondemand/token_iterator-inl.h" #include "simdjson/generic/ondemand/token_iterator-inl.h"
#include "simdjson/generic/ondemand/value_iterator-inl.h" #include "simdjson/generic/ondemand/value_iterator-inl.h"
// JSON builder inline definitions // JSON builder, ideally they should not be part of the ondemand directory
// but it is convenient for now to have them here.
#include "simdjson/generic/ondemand/json_string_builder.h"
#include "simdjson/generic/ondemand/json_string_builder-inl.h" #include "simdjson/generic/ondemand/json_string_builder-inl.h"
#include "simdjson/generic/ondemand/json_builder.h" #include "simdjson/generic/ondemand/json_builder.h"
// JSON path accessor (compile-time) - must be after inline definitions
#include "simdjson/generic/ondemand/compile_time_accessors.h"
+1 -66
View File
@@ -85,7 +85,7 @@ simdjson_inline simdjson_result<array_iterator> array::begin() noexcept {
simdjson_inline simdjson_result<array_iterator> array::end() noexcept { simdjson_inline simdjson_result<array_iterator> array::end() noexcept {
return array_iterator(iter); return array_iterator(iter);
} }
simdjson_warn_unused simdjson_warn_unused simdjson_inline error_code array::consume() noexcept { simdjson_inline error_code array::consume() noexcept {
auto error = iter.json_iter().skip_child(iter.depth()-1); auto error = iter.json_iter().skip_child(iter.depth()-1);
if(error) { iter.abandon(); } if(error) { iter.abandon(); }
return error; return error;
@@ -170,67 +170,6 @@ inline simdjson_result<value> array::at_path(std::string_view json_path) noexcep
return at_pointer(json_pointer); return at_pointer(json_pointer);
} }
inline simdjson_result<std::vector<value>> array::at_path_with_wildcard(std::string_view json_path) noexcept {
std::vector<value> result;
auto result_pair = get_next_key_and_json_path(json_path);
std::string_view key = result_pair.first;
std::string_view remaining_path = result_pair.second;
// Wildcard case
if(key=="*"){
for(auto element: *this){
if(element.error()){
return element.error();
}
if(remaining_path.empty()){
// Use value_unsafe() because we've already checked for errors above.
// The 'element' is a simdjson_result<value> wrapper, and we need to extract
// the underlying value. value_unsafe() is safe here because error() returned false.
result.push_back(std::move(element).value_unsafe());
}else{
auto nested_result = element.at_path_with_wildcard(remaining_path);
if(nested_result.error()){
return nested_result.error();
}
// Same logic as above.
std::vector<value> nested_matches = std::move(nested_result).value_unsafe();
result.insert(result.end(),
std::make_move_iterator(nested_matches.begin()),
std::make_move_iterator(nested_matches.end()));
}
}
return result;
}else{
// Specific index case in which we access the element at the given index
size_t idx=0;
for(char c:key){
if(c < '0' || c > '9'){
return INVALID_JSON_POINTER;
}
idx = idx*10 + (c - '0');
}
auto element = at(idx);
if(element.error()){
return element.error();
}
if(remaining_path.empty()){
result.push_back(std::move(element).value_unsafe());
return result;
}else{
return element.at_path_with_wildcard(remaining_path);
}
}
}
simdjson_inline simdjson_result<value> array::at(size_t index) noexcept { simdjson_inline simdjson_result<value> array::at(size_t index) noexcept {
size_t i = 0; size_t i = 0;
for (auto value : *this) { for (auto value : *this) {
@@ -289,10 +228,6 @@ simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> simdj
if (error()) { return error(); } if (error()) { return error(); }
return first.at_path(json_path); return first.at_path(json_path);
} }
simdjson_inline simdjson_result<std::vector<SIMDJSON_IMPLEMENTATION::ondemand::value>> simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array>::at_path_with_wildcard(std::string_view json_path) noexcept {
if (error()) { return error(); }
return first.at_path_with_wildcard(json_path);
}
simdjson_inline simdjson_result<std::string_view> simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array>::raw_json() noexcept { simdjson_inline simdjson_result<std::string_view> simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array>::raw_json() noexcept {
if (error()) { return error(); } if (error()) { return error(); }
return first.raw_json(); return first.raw_json();
+8 -19
View File
@@ -5,7 +5,6 @@
#include "simdjson/generic/ondemand/base.h" #include "simdjson/generic/ondemand/base.h"
#include "simdjson/generic/implementation_simdjson_result_base.h" #include "simdjson/generic/implementation_simdjson_result_base.h"
#include "simdjson/generic/ondemand/value_iterator.h" #include "simdjson/generic/ondemand/value_iterator.h"
#include <vector>
#endif // SIMDJSON_CONDITIONAL_INCLUDE #endif // SIMDJSON_CONDITIONAL_INCLUDE
namespace simdjson { namespace simdjson {
@@ -108,7 +107,7 @@ public:
* JSONPath queries that trivially convertible to JSON Pointer queries: key * JSONPath queries that trivially convertible to JSON Pointer queries: key
* names and array indices. * names and array indices.
* *
* https://www.rfc-editor.org/rfc/rfc9535 (RFC 9535) * https://datatracker.ietf.org/doc/html/draft-normington-jsonpath-00
* *
* @return The value associated with the given JSONPath expression, or: * @return The value associated with the given JSONPath expression, or:
* - INVALID_JSON_POINTER if the JSONPath to JSON Pointer conversion fails * - INVALID_JSON_POINTER if the JSONPath to JSON Pointer conversion fails
@@ -118,15 +117,6 @@ public:
*/ */
inline simdjson_result<value> at_path(std::string_view json_path) noexcept; inline simdjson_result<value> at_path(std::string_view json_path) noexcept;
/**
* Get all values matching the given JSONPath expression with wildcard support.
* Supports wildcard patterns like "[*]" to match all array elements.
*
* @param json_path JSONPath expression with wildcards
* @return Vector of values matching the wildcard pattern
*/
inline simdjson_result<std::vector<value>> at_path_with_wildcard(std::string_view json_path) noexcept;
/** /**
* Consumes the array and returns a string_view instance corresponding to the * Consumes the array and returns a string_view instance corresponding to the
* array as represented in JSON. It points inside the original document. * array as represented in JSON. It points inside the original document.
@@ -142,7 +132,7 @@ public:
*/ */
simdjson_inline simdjson_result<value> at(size_t index) noexcept; simdjson_inline simdjson_result<value> at(size_t index) noexcept;
#if SIMDJSON_SUPPORTS_CONCEPTS #if SIMDJSON_SUPPORTS_DESERIALIZATION
/** /**
* Get this array as the given type. * Get this array as the given type.
* *
@@ -151,7 +141,7 @@ public:
* @returns SUCCESS If the parse succeeded and the out parameter was set to the value. * @returns SUCCESS If the parse succeeded and the out parameter was set to the value.
*/ */
template <typename T> template <typename T>
simdjson_warn_unused simdjson_inline error_code get(T &out) simdjson_inline error_code get(T &out)
noexcept(custom_deserializable<T, array> ? nothrow_custom_deserializable<T, array> : true) { noexcept(custom_deserializable<T, array> ? nothrow_custom_deserializable<T, array> : true) {
static_assert(custom_deserializable<T, array>); static_assert(custom_deserializable<T, array>);
return deserialize(*this, out); return deserialize(*this, out);
@@ -171,12 +161,12 @@ public:
SIMDJSON_TRY(get<T>(out)); SIMDJSON_TRY(get<T>(out));
return out; return out;
} }
#endif // SIMDJSON_SUPPORTS_CONCEPTS #endif // SIMDJSON_SUPPORTS_DESERIALIZATION
protected: protected:
/** /**
* Go to the end of the array, no matter where you are right now. * Go to the end of the array, no matter where you are right now.
*/ */
simdjson_warn_unused simdjson_inline error_code consume() noexcept; simdjson_inline error_code consume() noexcept;
/** /**
* Begin array iteration. * Begin array iteration.
@@ -249,9 +239,8 @@ public:
simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at(size_t index) noexcept; simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at(size_t index) noexcept;
simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at_pointer(std::string_view json_pointer) noexcept; simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at_pointer(std::string_view json_pointer) noexcept;
simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at_path(std::string_view json_path) noexcept; simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at_path(std::string_view json_path) noexcept;
simdjson_inline simdjson_result<std::vector<SIMDJSON_IMPLEMENTATION::ondemand::value>> at_path_with_wildcard(std::string_view json_path) noexcept;
simdjson_inline simdjson_result<std::string_view> raw_json() noexcept; simdjson_inline simdjson_result<std::string_view> raw_json() noexcept;
#if SIMDJSON_SUPPORTS_CONCEPTS #if SIMDJSON_SUPPORTS_DESERIALIZATION
// TODO: move this code into object-inl.h // TODO: move this code into object-inl.h
template<typename T> template<typename T>
@@ -263,7 +252,7 @@ public:
return first.get<T>(); return first.get<T>();
} }
template<typename T> template<typename T>
simdjson_warn_unused simdjson_inline error_code get(T& out) noexcept { simdjson_inline error_code get(T& out) noexcept {
if (error()) { return error(); } if (error()) { return error(); }
if constexpr (std::is_same_v<T, SIMDJSON_IMPLEMENTATION::ondemand::array>) { if constexpr (std::is_same_v<T, SIMDJSON_IMPLEMENTATION::ondemand::array>) {
out = first; out = first;
@@ -272,7 +261,7 @@ public:
} }
return SUCCESS; return SUCCESS;
} }
#endif // SIMDJSON_SUPPORTS_CONCEPTS #endif // SIMDJSON_SUPPORTS_DESERIALIZATION
}; };
} // namespace simdjson } // namespace simdjson
@@ -36,9 +36,6 @@ simdjson_inline array_iterator &array_iterator::operator++() noexcept {
return *this; return *this;
} }
simdjson_inline bool array_iterator::at_end() const noexcept {
return iter.at_end();
}
} // namespace ondemand } // namespace ondemand
} // namespace SIMDJSON_IMPLEMENTATION } // namespace SIMDJSON_IMPLEMENTATION
} // namespace simdjson } // namespace simdjson
@@ -75,9 +72,7 @@ simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array_iterato
++(first); ++(first);
return *this; return *this;
} }
simdjson_inline bool simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array_iterator>::at_end() const noexcept {
return !first.iter.is_valid() || first.at_end();
}
} // namespace simdjson } // namespace simdjson
#endif // SIMDJSON_GENERIC_ONDEMAND_ARRAY_ITERATOR_INL_H #endif // SIMDJSON_GENERIC_ONDEMAND_ARRAY_ITERATOR_INL_H
@@ -34,8 +34,7 @@ public:
* *
* Part of the std::iterator interface. * Part of the std::iterator interface.
*/ */
simdjson_inline simdjson_result<value> simdjson_inline simdjson_result<value> operator*() noexcept; // MUST ONLY BE CALLED ONCE PER ITERATION.
operator*() noexcept; // MUST ONLY BE CALLED ONCE PER ITERATION.
/** /**
* Check if we are at the end of the JSON. * Check if we are at the end of the JSON.
* *
@@ -59,11 +58,6 @@ public:
*/ */
simdjson_inline array_iterator &operator++() noexcept; simdjson_inline array_iterator &operator++() noexcept;
/**
* Check if the array is at the end.
*/
simdjson_warn_unused simdjson_inline bool at_end() const noexcept;
private: private:
value_iterator iter{}; value_iterator iter{};
@@ -82,6 +76,7 @@ namespace simdjson {
template<> template<>
struct simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array_iterator> : public SIMDJSON_IMPLEMENTATION::implementation_simdjson_result_base<SIMDJSON_IMPLEMENTATION::ondemand::array_iterator> { struct simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array_iterator> : public SIMDJSON_IMPLEMENTATION::implementation_simdjson_result_base<SIMDJSON_IMPLEMENTATION::ondemand::array_iterator> {
public:
simdjson_inline simdjson_result(SIMDJSON_IMPLEMENTATION::ondemand::array_iterator &&value) noexcept; ///< @private simdjson_inline simdjson_result(SIMDJSON_IMPLEMENTATION::ondemand::array_iterator &&value) noexcept; ///< @private
simdjson_inline simdjson_result(error_code error) noexcept; ///< @private simdjson_inline simdjson_result(error_code error) noexcept; ///< @private
simdjson_inline simdjson_result() noexcept = default; simdjson_inline simdjson_result() noexcept = default;
@@ -94,8 +89,6 @@ struct simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array_iterator> : publ
simdjson_inline bool operator==(const simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array_iterator> &) const noexcept; simdjson_inline bool operator==(const simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array_iterator> &) const noexcept;
simdjson_inline bool operator!=(const simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array_iterator> &) const noexcept; simdjson_inline bool operator!=(const simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array_iterator> &) const noexcept;
simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array_iterator> &operator++() noexcept; simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array_iterator> &operator++() noexcept;
simdjson_warn_unused simdjson_inline bool at_end() const noexcept;
}; };
} // namespace simdjson } // namespace simdjson
@@ -1,938 +0,0 @@
/**
* Compile-time JSON Path and JSON Pointer accessors using C++26 reflection (P2996)
*
* This file validates JSON paths/pointers against struct definitions at compile time
* and generates optimized accessor code with zero runtime overhead.
*
* ## How It Works
*
* **Compile Time**: Path is parsed, validated against struct, types are checked
* **Runtime**: Direct navigation with no parsing or validation overhead
*
* Example:
* ```cpp
* struct User { std::string name; std::vector<std::string> emails; };
*
* std::string email;
* path_accessor<User, ".emails[0]">::extract_field(doc, email);
*
* // Compile time validates:
* // 1. User has "emails" field
* // 2. "emails" is array-like
* // 3. Element type is std::string
* // 4. static_assert(^^std::string == ^^std::string)
*
* // Runtime just navigates:
* // doc.get_object().find_field("emails").get_array().at(0).get(email)
* ```
*
* ## Key Reflection APIs
*
* - `^^Type`: Reflect operator, converts type to std::meta::info
* - `std::meta::nonstatic_data_members_of(type)`: Get all fields of a struct
* - `std::meta::identifier_of(member)`: Get field name as string_view
* - `std::meta::type_of(member)`: Get reflected type of a field
* - `std::meta::is_array_type(type)`: Check if C-style array
* - `std::meta::remove_extent(array)`: Extract element type from array
* - `std::meta::members_of(type)`: Get all members including typedefs
* - `std::meta::is_type(member)`: Check if member is a type (vs field)
*
* All operations execute at compile time in consteval contexts.
*/
#ifndef SIMDJSON_GENERIC_ONDEMAND_COMPILE_TIME_ACCESSORS_H
#ifndef SIMDJSON_CONDITIONAL_INCLUDE
#define SIMDJSON_GENERIC_ONDEMAND_COMPILE_TIME_ACCESSORS_H
#endif // SIMDJSON_CONDITIONAL_INCLUDE
// Arguably, we should just check SIMDJSON_STATIC_REFLECTION since it
// is unlikely that we will have reflection support without concepts support.
#if SIMDJSON_SUPPORTS_CONCEPTS && SIMDJSON_STATIC_REFLECTION
#include <string_view>
#include <cstddef>
#include <array>
namespace simdjson {
namespace SIMDJSON_IMPLEMENTATION {
namespace ondemand {
/***
* JSONPath implementation for compile-time access
* RFC 9535 JSONPath: Query Expressions for JSON, https://www.rfc-editor.org/rfc/rfc9535
*/
namespace json_path {
// Note: value type must be fully defined before this header is included
// This is ensured by including this in amalgamated.h after value-inl.h
using ::simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value;
// Path step types
enum class step_type {
field, // .field_name or ["field_name"]
array_index // [index]
};
// Represents a single step in a JSON path
template<std::size_t N>
struct path_step {
step_type type;
char key[N]; // Field name (empty for array indices)
std::size_t index; // Array index (0 for field access)
constexpr path_step(step_type t, const char (&k)[N], std::size_t idx = 0)
: type(t), index(idx) {
for (std::size_t i = 0; i < N; ++i) {
key[i] = k[i];
}
}
constexpr std::string_view key_view() const {
return {key, N - 1};
}
};
// Helper to create field step
template<std::size_t N>
consteval auto make_field_step(const char (&name)[N]) {
return path_step<N>(step_type::field, name, 0);
}
// Helper to create array index step
consteval auto make_index_step(std::size_t idx) {
return path_step<1>(step_type::array_index, "", idx);
}
// Parse state for compile-time JSON path parsing
struct parse_result {
bool success;
std::size_t pos;
std::string_view error_msg;
};
// Compile-time JSON path parser
// Supports subset: .field, ["field"], [index], nested combinations
template<constevalutil::fixed_string Path>
struct json_path_parser {
static constexpr std::string_view path_str = Path.view();
// Skip leading $ if present
static consteval std::size_t skip_root() {
if (!path_str.empty() && path_str[0] == '$') {
return 1;
}
return 0;
}
// Count the number of steps in the path at compile time
static consteval std::size_t count_steps() {
std::size_t count = 0;
std::size_t i = skip_root();
while (i < path_str.size()) {
if (path_str[i] == '.') {
// Field access: .field
++i;
if (i >= path_str.size()) break;
// Skip field name
while (i < path_str.size() && path_str[i] != '.' && path_str[i] != '[') {
++i;
}
++count;
} else if (path_str[i] == '[') {
// Array or bracket notation
++i;
if (i >= path_str.size()) break;
if (path_str[i] == '"' || path_str[i] == '\'') {
// Field access: ["field"] or ['field']
char quote = path_str[i];
++i;
while (i < path_str.size() && path_str[i] != quote) {
++i;
}
if (i < path_str.size()) ++i; // skip closing quote
if (i < path_str.size() && path_str[i] == ']') ++i;
} else {
// Array index: [0], [123]
while (i < path_str.size() && path_str[i] != ']') {
++i;
}
if (i < path_str.size()) ++i; // skip ]
}
++count;
} else {
++i;
}
}
return count;
}
// Parse a field name at compile time
static consteval std::size_t parse_field_name(std::size_t start, char* out, std::size_t max_len) {
std::size_t len = 0;
std::size_t i = start;
while (i < path_str.size() && path_str[i] != '.' && path_str[i] != '[' && len < max_len - 1) {
out[len++] = path_str[i++];
}
out[len] = '\0';
return i;
}
// Parse an array index at compile time
static consteval std::pair<std::size_t, std::size_t> parse_array_index(std::size_t start) {
std::size_t index = 0;
std::size_t i = start;
while (i < path_str.size() && path_str[i] >= '0' && path_str[i] <= '9') {
index = index * 10 + (path_str[i] - '0');
++i;
}
return {i, index};
}
};
// Compile-time path accessor generator
template<typename T, constevalutil::fixed_string Path>
struct path_accessor {
using value = ::simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value;
static constexpr auto parser = json_path_parser<Path>();
static constexpr std::size_t num_steps = parser.count_steps();
static constexpr std::string_view path_view = Path.view();
// Compile-time accessor generation
// If T is a struct, validates the path at compile time
// If T is void, skips validation
template<typename DocOrValue>
static inline simdjson_result<value> access(DocOrValue& doc_or_val) noexcept {
// Validate path at compile time if T is a struct
if constexpr (std::is_class_v<T>) {
constexpr bool path_valid = validate_path();
static_assert(path_valid, "JSON path does not match struct definition");
}
// Parse the path at compile time to build access steps
return access_impl<parser.skip_root()>(doc_or_val.get_value());
}
// Extract value at path directly into target with compile-time type validation
// Example: std::string name; path_accessor<User, ".name">::extract_field(doc, name);
template<typename DocOrValue, typename FieldType>
static inline error_code extract_field(DocOrValue& doc_or_val, FieldType& target) noexcept {
static_assert(std::is_class_v<T>, "extract_field requires T to be a struct type for validation");
// Validate path exists in struct definition
constexpr bool path_valid = validate_path();
static_assert(path_valid, "JSON path does not match struct definition");
// Get the type at the end of the path
constexpr auto final_type = get_final_type();
// Verify target type matches the field type
static_assert(final_type == ^^FieldType, "Target type does not match the field type at the path");
// All validation done at compile time - just navigate and extract
auto json_value = access_impl<parser.skip_root()>(doc_or_val.get_value());
if (json_value.error()) return json_value.error();
return json_value.get(target);
}
private:
// Get the final type by walking the path through the struct type
template<typename U = T>
static consteval std::enable_if_t<std::is_class_v<U>, std::meta::info> get_final_type() {
auto current_type = ^^T;
std::size_t i = parser.skip_root();
while (i < path_view.size()) {
if (path_view[i] == '.') {
// .field syntax
++i;
std::size_t field_start = i;
while (i < path_view.size() && path_view[i] != '.' && path_view[i] != '[') {
++i;
}
std::string_view field_name = path_view.substr(field_start, i - field_start);
auto members = std::meta::nonstatic_data_members_of(
current_type, std::meta::access_context::unchecked()
);
for (auto mem : members) {
if (std::meta::identifier_of(mem) == field_name) {
current_type = std::meta::type_of(mem);
break;
}
}
} else if (path_view[i] == '[') {
++i;
if (i >= path_view.size()) break;
if (path_view[i] == '"' || path_view[i] == '\'') {
// ["field"] syntax
char quote = path_view[i];
++i;
std::size_t field_start = i;
while (i < path_view.size() && path_view[i] != quote) {
++i;
}
std::string_view field_name = path_view.substr(field_start, i - field_start);
if (i < path_view.size()) ++i; // skip quote
if (i < path_view.size() && path_view[i] == ']') ++i;
auto members = std::meta::nonstatic_data_members_of(
current_type, std::meta::access_context::unchecked()
);
for (auto mem : members) {
if (std::meta::identifier_of(mem) == field_name) {
current_type = std::meta::type_of(mem);
break;
}
}
} else {
// [index] syntax - extract element type
while (i < path_view.size() && path_view[i] >= '0' && path_view[i] <= '9') {
++i;
}
if (i < path_view.size() && path_view[i] == ']') ++i;
current_type = get_element_type_reflected(current_type);
}
} else {
++i;
}
}
return current_type;
}
private:
// Walk path and extract directly into final field using compile-time reflection
template<std::meta::info CurrentType, std::size_t PathPos, typename TargetType>
static inline error_code extract_with_reflection(simdjson_result<value> current, TargetType& target_ref) noexcept {
if (current.error()) return current.error();
// Base case: end of path - extract into target
if constexpr (PathPos >= path_view.size()) {
return current.get(target_ref);
}
// Field access: .field_name
else if constexpr (path_view[PathPos] == '.') {
constexpr auto field_info = parse_next_field(PathPos);
constexpr std::string_view field_name = std::get<0>(field_info);
constexpr std::size_t next_pos = std::get<1>(field_info);
constexpr auto member_info = find_member_by_name(CurrentType, field_name);
static_assert(member_info != ^^void, "Field not found in struct");
constexpr auto member_type = std::meta::type_of(member_info);
auto obj_result = current.get_object();
if (obj_result.error()) return obj_result.error();
auto obj = obj_result.value_unsafe();
auto field_value = obj.find_field_unordered(field_name);
if constexpr (next_pos >= path_view.size()) {
return field_value.get(target_ref);
} else {
return extract_with_reflection<member_type, next_pos>(field_value, target_ref);
}
}
// Bracket notation: [index] or ["field"]
else if constexpr (path_view[PathPos] == '[') {
constexpr auto bracket_info = parse_bracket(PathPos);
constexpr bool is_field = std::get<0>(bracket_info);
constexpr std::size_t next_pos = std::get<2>(bracket_info);
if constexpr (is_field) {
constexpr std::string_view field_name = std::get<1>(bracket_info);
constexpr auto member_info = find_member_by_name(CurrentType, field_name);
static_assert(member_info != ^^void, "Field not found in struct");
constexpr auto member_type = std::meta::type_of(member_info);
auto obj_result = current.get_object();
if (obj_result.error()) return obj_result.error();
auto obj = obj_result.value_unsafe();
auto field_value = obj.find_field_unordered(field_name);
if constexpr (next_pos >= path_view.size()) {
return field_value.get(target_ref);
} else {
return extract_with_reflection<member_type, next_pos>(field_value, target_ref);
}
} else {
constexpr std::size_t index = std::get<3>(bracket_info);
constexpr auto elem_type = get_element_type_reflected(CurrentType);
static_assert(elem_type != ^^void, "Could not determine array element type");
auto arr_result = current.get_array();
if (arr_result.error()) return arr_result.error();
auto arr = arr_result.value_unsafe();
auto elem_value = arr.at(index);
if constexpr (next_pos >= path_view.size()) {
return elem_value.get(target_ref);
} else {
return extract_with_reflection<elem_type, next_pos>(elem_value, target_ref);
}
}
}
// Skip unexpected characters and continue
else {
return extract_with_reflection<CurrentType, PathPos + 1>(current, target_ref);
}
}
// Find member by name in reflected type
static consteval std::meta::info find_member_by_name(std::meta::info type_refl, std::string_view name) {
auto members = std::meta::nonstatic_data_members_of(type_refl, std::meta::access_context::unchecked());
for (auto mem : members) {
if (std::meta::identifier_of(mem) == name) {
return mem;
}
}
}
// Generate compile-time accessor code by walking the path
template<std::size_t PathPos>
static inline simdjson_result<value> access_impl(simdjson_result<value> current) noexcept {
if (current.error()) return current;
if constexpr (PathPos >= path_view.size()) {
return current;
} else if constexpr (path_view[PathPos] == '.') {
constexpr auto field_info = parse_next_field(PathPos);
constexpr std::string_view field_name = std::get<0>(field_info);
constexpr std::size_t next_pos = std::get<1>(field_info);
auto obj_result = current.get_object();
if (obj_result.error()) return obj_result.error();
auto obj = obj_result.value_unsafe();
auto next_value = obj.find_field_unordered(field_name);
return access_impl<next_pos>(next_value);
} else if constexpr (path_view[PathPos] == '[') {
constexpr auto bracket_info = parse_bracket(PathPos);
constexpr bool is_field = std::get<0>(bracket_info);
constexpr std::size_t next_pos = std::get<2>(bracket_info);
if constexpr (is_field) {
constexpr std::string_view field_name = std::get<1>(bracket_info);
auto obj_result = current.get_object();
if (obj_result.error()) return obj_result.error();
auto obj = obj_result.value_unsafe();
auto next_value = obj.find_field_unordered(field_name);
return access_impl<next_pos>(next_value);
} else {
constexpr std::size_t index = std::get<3>(bracket_info);
auto arr_result = current.get_array();
if (arr_result.error()) return arr_result.error();
auto arr = arr_result.value_unsafe();
auto next_value = arr.at(index);
return access_impl<next_pos>(next_value);
}
} else {
return access_impl<PathPos + 1>(current);
}
}
// Parse next field name
static consteval auto parse_next_field(std::size_t start) {
std::size_t i = start + 1;
std::size_t field_start = i;
while (i < path_view.size() && path_view[i] != '.' && path_view[i] != '[') {
++i;
}
std::string_view field_name = path_view.substr(field_start, i - field_start);
return std::make_tuple(field_name, i);
}
// Parse bracket notation: returns (is_field, field_name, next_pos, index)
static consteval auto parse_bracket(std::size_t start) {
std::size_t i = start + 1; // skip '['
if (i < path_view.size() && (path_view[i] == '"' || path_view[i] == '\'')) {
// Field access
char quote = path_view[i];
++i;
std::size_t field_start = i;
while (i < path_view.size() && path_view[i] != quote) {
++i;
}
std::string_view field_name = path_view.substr(field_start, i - field_start);
if (i < path_view.size()) ++i; // skip closing quote
if (i < path_view.size() && path_view[i] == ']') ++i;
return std::make_tuple(true, field_name, i, std::size_t(0));
} else {
// Array index
std::size_t index = 0;
while (i < path_view.size() && path_view[i] >= '0' && path_view[i] <= '9') {
index = index * 10 + (path_view[i] - '0');
++i;
}
if (i < path_view.size() && path_view[i] == ']') ++i;
return std::make_tuple(false, std::string_view{}, i, index);
}
}
public:
// Check if reflected type is array-like (C-style array or indexable container)
// Uses reflection to test: 1) std::meta::is_array_type() for C arrays
// 2) std::meta::substitute() to test concepts::indexable_container concept
static consteval bool is_array_like_reflected(std::meta::info type_reflection) {
if (std::meta::is_array_type(type_reflection)) {
return true;
}
if (std::meta::can_substitute(^^concepts::indexable_container_v, {type_reflection})) {
return std::meta::extract<bool>(std::meta::substitute(^^concepts::indexable_container_v, {type_reflection}));
}
return false;
}
// Extract element type from reflected array or container
// For C arrays: uses std::meta::remove_extent()
// For containers: finds value_type member using std::meta::members_of()
static consteval std::meta::info get_element_type_reflected(std::meta::info type_reflection) {
if (std::meta::is_array_type(type_reflection)) {
return std::meta::remove_extent(type_reflection);
}
auto members = std::meta::members_of(type_reflection, std::meta::access_context::unchecked());
for (auto mem : members) {
if (std::meta::is_type(mem)) {
auto name = std::meta::identifier_of(mem);
if (name == "value_type") {
return mem;
}
}
}
return ^^void;
}
private:
// Check if type has member with given name
template<typename Type>
static consteval bool has_member(std::string_view member_name) {
constexpr auto members = std::meta::nonstatic_data_members_of(^^Type, std::meta::access_context::unchecked());
for (auto mem : members) {
if (std::meta::identifier_of(mem) == member_name) {
return true;
}
}
return false;
}
// Get type of member by name
template<typename Type>
static consteval auto get_member_type(std::string_view member_name) {
constexpr auto members = std::meta::nonstatic_data_members_of(^^Type, std::meta::access_context::unchecked());
for (auto mem : members) {
if (std::meta::identifier_of(mem) == member_name) {
return std::meta::type_of(mem);
}
}
return ^^void;
}
// Check if non-reflected type is array-like
template<typename Type>
static consteval bool is_container_type() {
using BaseType = std::remove_cvref_t<Type>;
if constexpr (requires { typename BaseType::value_type; }) {
return true;
}
if constexpr (std::is_array_v<BaseType>) {
return true;
}
return false;
}
// Extract element type from non-reflected container
template<typename Type>
using extract_element_type = std::conditional_t<
requires { typename std::remove_cvref_t<Type>::value_type; },
typename std::remove_cvref_t<Type>::value_type,
std::conditional_t<
std::is_array_v<std::remove_cvref_t<Type>>,
std::remove_extent_t<std::remove_cvref_t<Type>>,
void
>
>;
// Validate path matches struct definition
static consteval bool validate_path() {
if constexpr (!std::is_class_v<T>) {
return true;
}
auto current_type = ^^T;
std::size_t i = parser.skip_root();
while (i < path_view.size()) {
if (path_view[i] == '.') {
++i;
std::size_t field_start = i;
while (i < path_view.size() && path_view[i] != '.' && path_view[i] != '[') {
++i;
}
std::string_view field_name = path_view.substr(field_start, i - field_start);
bool found = false;
auto members = std::meta::nonstatic_data_members_of(current_type, std::meta::access_context::unchecked());
for (auto mem : members) {
if (std::meta::identifier_of(mem) == field_name) {
current_type = std::meta::type_of(mem);
found = true;
break;
}
}
if (!found) {
return false;
}
} else if (path_view[i] == '[') {
++i;
if (i >= path_view.size()) return false;
if (path_view[i] == '"' || path_view[i] == '\'') {
char quote = path_view[i];
++i;
std::size_t field_start = i;
while (i < path_view.size() && path_view[i] != quote) {
++i;
}
std::string_view field_name = path_view.substr(field_start, i - field_start);
if (i < path_view.size()) ++i;
if (i < path_view.size() && path_view[i] == ']') ++i;
bool found = false;
auto members = std::meta::nonstatic_data_members_of(current_type, std::meta::access_context::unchecked());
for (auto mem : members) {
if (std::meta::identifier_of(mem) == field_name) {
current_type = std::meta::type_of(mem);
found = true;
break;
}
}
if (!found) {
return false;
}
} else {
while (i < path_view.size() && path_view[i] >= '0' && path_view[i] <= '9') {
++i;
}
if (i < path_view.size() && path_view[i] == ']') ++i;
if (!is_array_like_reflected(current_type)) {
return false;
}
auto new_type = get_element_type_reflected(current_type);
if (new_type == ^^void) {
return false;
}
current_type = new_type;
}
} else {
++i;
}
}
return true;
}
};
// Compile-time path accessor with validation
template<typename T, constevalutil::fixed_string Path, typename DocOrValue>
inline simdjson_result<::simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value> at_path_compiled(DocOrValue& doc_or_val) noexcept {
using accessor = path_accessor<T, Path>;
return accessor::access(doc_or_val);
}
// Overload without type parameter (no validation)
template<constevalutil::fixed_string Path, typename DocOrValue>
inline simdjson_result<::simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value> at_path_compiled(DocOrValue& doc_or_val) noexcept {
using accessor = path_accessor<void, Path>;
return accessor::access(doc_or_val);
}
// ============================================================================
// JSON Pointer Compile-Time Support (RFC 6901)
// ============================================================================
// JSON Pointer parser: /field/0/nested (slash-separated)
template<constevalutil::fixed_string Pointer>
struct json_pointer_parser {
static constexpr std::string_view pointer_str = Pointer.view();
// Unescape token: ~0 -> ~, ~1 -> /
static consteval void unescape_token(std::string_view src, char* dest, std::size_t& out_len) {
out_len = 0;
for (std::size_t i = 0; i < src.size(); ++i) {
if (src[i] == '~' && i + 1 < src.size()) {
if (src[i + 1] == '0') {
dest[out_len++] = '~';
++i;
} else if (src[i + 1] == '1') {
dest[out_len++] = '/';
++i;
} else {
dest[out_len++] = src[i];
}
} else {
dest[out_len++] = src[i];
}
}
}
// Check if token is numeric
static consteval bool is_numeric(std::string_view token) {
if (token.empty()) return false;
if (token[0] == '0' && token.size() > 1) return false;
for (char c : token) {
if (c < '0' || c > '9') return false;
}
return true;
}
// Parse numeric token to index
static consteval std::size_t parse_index(std::string_view token) {
std::size_t result = 0;
for (char c : token) {
result = result * 10 + (c - '0');
}
return result;
}
// Count tokens in pointer
static consteval std::size_t count_tokens() {
if (pointer_str.empty() || pointer_str == "/") return 0;
std::size_t count = 0;
std::size_t pos = pointer_str[0] == '/' ? 1 : 0;
while (pos < pointer_str.size()) {
++count;
std::size_t next_slash = pointer_str.find('/', pos);
if (next_slash == std::string_view::npos) break;
pos = next_slash + 1;
}
return count;
}
// Get Nth token
static consteval std::string_view get_token(std::size_t token_index) {
std::size_t pos = pointer_str[0] == '/' ? 1 : 0;
std::size_t current_token = 0;
while (current_token < token_index) {
std::size_t next_slash = pointer_str.find('/', pos);
pos = next_slash + 1;
++current_token;
}
std::size_t token_end = pointer_str.find('/', pos);
if (token_end == std::string_view::npos) token_end = pointer_str.size();
return pointer_str.substr(pos, token_end - pos);
}
};
// JSON Pointer accessor
template<typename T, constevalutil::fixed_string Pointer>
struct pointer_accessor {
using parser = json_pointer_parser<Pointer>;
static constexpr std::string_view pointer_view = Pointer.view();
static constexpr std::size_t token_count = parser::count_tokens();
// Validate pointer against struct definition
static consteval bool validate_pointer() {
if constexpr (!std::is_class_v<T>) {
return true;
}
auto current_type = ^^T;
std::size_t pos = pointer_view[0] == '/' ? 1 : 0;
while (pos < pointer_view.size()) {
// Extract token up to next /
std::size_t token_end = pointer_view.find('/', pos);
if (token_end == std::string_view::npos) token_end = pointer_view.size();
std::string_view token = pointer_view.substr(pos, token_end - pos);
if (parser::is_numeric(token)) {
if (!path_accessor<T, Pointer>::is_array_like_reflected(current_type)) {
return false;
}
current_type = path_accessor<T, Pointer>::get_element_type_reflected(current_type);
} else {
bool found = false;
auto members = std::meta::nonstatic_data_members_of(current_type, std::meta::access_context::unchecked());
for (auto mem : members) {
if (std::meta::identifier_of(mem) == token) {
current_type = std::meta::type_of(mem);
found = true;
break;
}
}
if (!found) return false;
}
pos = token_end + 1;
}
return true;
}
// Recursive accessor
template<std::size_t TokenIndex>
static inline simdjson_result<value> access_impl(simdjson_result<value> current) noexcept {
if constexpr (TokenIndex >= token_count) {
return current;
} else {
constexpr std::string_view token = parser::get_token(TokenIndex);
if constexpr (parser::is_numeric(token)) {
constexpr std::size_t index = parser::parse_index(token);
auto arr = current.get_array().value_unsafe();
auto next_value = arr.at(index);
return access_impl<TokenIndex + 1>(next_value);
} else {
auto obj = current.get_object().value_unsafe();
auto next_value = obj.find_field_unordered(token);
return access_impl<TokenIndex + 1>(next_value);
}
}
}
// Access JSON value at pointer
template<typename DocOrValue>
static inline simdjson_result<value> access(DocOrValue& doc_or_val) noexcept {
if constexpr (std::is_class_v<T>) {
constexpr bool pointer_valid = validate_pointer();
static_assert(pointer_valid, "JSON Pointer does not match struct definition");
}
if (pointer_view.empty() || pointer_view == "/") {
if constexpr (requires { doc_or_val.get_value(); }) {
return doc_or_val.get_value();
} else {
return doc_or_val;
}
}
simdjson_result<value> current = doc_or_val.get_value();
return access_impl<0>(current);
}
// Extract value at pointer directly into target with type validation
template<typename DocOrValue, typename FieldType>
static inline error_code extract_field(DocOrValue& doc_or_val, FieldType& target) noexcept {
static_assert(std::is_class_v<T>, "extract_field requires T to be a struct type for validation");
constexpr bool pointer_valid = validate_pointer();
static_assert(pointer_valid, "JSON Pointer does not match struct definition");
constexpr auto final_type = get_final_type();
static_assert(final_type == ^^FieldType, "Target type does not match the field type at the pointer");
simdjson_result<value> current_value = doc_or_val.get_value();
auto json_value = access_impl<0>(current_value);
if (json_value.error()) return json_value.error();
return json_value.get(target);
}
private:
// Get final type by walking pointer through struct
template<typename U = T>
static consteval std::enable_if_t<std::is_class_v<U>, std::meta::info> get_final_type() {
auto current_type = ^^T;
std::size_t pos = pointer_view[0] == '/' ? 1 : 0;
while (pos < pointer_view.size()) {
std::size_t token_end = pointer_view.find('/', pos);
if (token_end == std::string_view::npos) token_end = pointer_view.size();
std::string_view token = pointer_view.substr(pos, token_end - pos);
if (parser::is_numeric(token)) {
current_type = path_accessor<T, "">::get_element_type_reflected(current_type);
} else {
auto members = std::meta::nonstatic_data_members_of(current_type, std::meta::access_context::unchecked());
for (auto mem : members) {
if (std::meta::identifier_of(mem) == token) {
current_type = std::meta::type_of(mem);
break;
}
}
}
pos = token_end + 1;
}
return current_type;
}
};
// Compile-time JSON Pointer accessor with validation
template<typename T, constevalutil::fixed_string Pointer, typename DocOrValue>
inline simdjson_result<::simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value> at_pointer_compiled(DocOrValue& doc_or_val) noexcept {
using accessor = pointer_accessor<T, Pointer>;
return accessor::access(doc_or_val);
}
// Overload without type parameter (no validation)
template<constevalutil::fixed_string Pointer, typename DocOrValue>
inline simdjson_result<::simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value> at_pointer_compiled(DocOrValue& doc_or_val) noexcept {
using accessor = pointer_accessor<void, Pointer>;
return accessor::access(doc_or_val);
}
} // namespace json_path
} // namespace ondemand
} // namespace SIMDJSON_IMPLEMENTATION
} // namespace simdjson
#endif // SIMDJSON_SUPPORTS_CONCEPTS && SIMDJSON_STATIC_REFLECTION
#endif // SIMDJSON_GENERIC_ONDEMAND_COMPILE_TIME_ACCESSORS_H
@@ -1,4 +1,4 @@
#if SIMDJSON_SUPPORTS_CONCEPTS #if SIMDJSON_SUPPORTS_DESERIALIZATION
#ifndef SIMDJSON_ONDEMAND_DESERIALIZE_H #ifndef SIMDJSON_ONDEMAND_DESERIALIZE_H
#ifndef SIMDJSON_CONDITIONAL_INCLUDE #ifndef SIMDJSON_CONDITIONAL_INCLUDE
@@ -7,8 +7,55 @@
#include "simdjson/generic/ondemand/array.h" #include "simdjson/generic/ondemand/array.h"
#endif // SIMDJSON_CONDITIONAL_INCLUDE #endif // SIMDJSON_CONDITIONAL_INCLUDE
#include <concepts>
namespace simdjson { namespace simdjson {
namespace tag_invoke_fn_ns {
void tag_invoke();
struct tag_invoke_fn {
template <typename Tag, typename... Args>
requires requires(Tag tag, Args &&...args) {
tag_invoke(std::forward<Tag>(tag), std::forward<Args>(args)...);
}
constexpr auto operator()(Tag tag, Args &&...args) const
noexcept(noexcept(tag_invoke(std::forward<Tag>(tag),
std::forward<Args>(args)...)))
-> decltype(tag_invoke(std::forward<Tag>(tag),
std::forward<Args>(args)...)) {
return tag_invoke(std::forward<Tag>(tag), std::forward<Args>(args)...);
}
};
} // namespace tag_invoke_fn_ns
inline namespace tag_invoke_ns {
inline constexpr tag_invoke_fn_ns::tag_invoke_fn tag_invoke = {};
} // namespace tag_invoke_ns
template <typename Tag, typename... Args>
concept tag_invocable = requires(Tag tag, Args... args) {
tag_invoke(std::forward<Tag>(tag), std::forward<Args>(args)...);
};
template <typename Tag, typename... Args>
concept nothrow_tag_invocable =
tag_invocable<Tag, Args...> && requires(Tag tag, Args... args) {
{
tag_invoke(std::forward<Tag>(tag), std::forward<Args>(args)...)
} noexcept;
};
template <typename Tag, typename... Args>
using tag_invoke_result =
std::invoke_result<decltype(tag_invoke), Tag, Args...>;
template <typename Tag, typename... Args>
using tag_invoke_result_t =
std::invoke_result_t<decltype(tag_invoke), Tag, Args...>;
template <auto &Tag> using tag_t = std::decay_t<decltype(Tag)>;
struct deserialize_tag; struct deserialize_tag;
/// These types are deserializable in a built-in way /// These types are deserializable in a built-in way
@@ -30,7 +77,7 @@ template <typename T, typename ValT = SIMDJSON_IMPLEMENTATION::ondemand::value>
concept custom_deserializable = tag_invocable<deserialize_tag, ValT&, T&>; concept custom_deserializable = tag_invocable<deserialize_tag, ValT&, T&>;
template <typename T, typename ValT = SIMDJSON_IMPLEMENTATION::ondemand::value> template <typename T, typename ValT = SIMDJSON_IMPLEMENTATION::ondemand::value>
concept deserializable = custom_deserializable<T, ValT> || is_builtin_deserializable_v<T> || concepts::optional_type<T>; concept deserializable = custom_deserializable<T, ValT> || is_builtin_deserializable_v<T>;
template <typename T, typename ValT = SIMDJSON_IMPLEMENTATION::ondemand::value> template <typename T, typename ValT = SIMDJSON_IMPLEMENTATION::ondemand::value>
concept nothrow_custom_deserializable = nothrow_tag_invocable<deserialize_tag, ValT&, T&>; concept nothrow_custom_deserializable = nothrow_tag_invocable<deserialize_tag, ValT&, T&>;
@@ -50,35 +97,35 @@ inline constexpr struct deserialize_tag {
// Customization Point for array // Customization Point for array
template <typename T> template <typename T>
requires custom_deserializable<T, value_type> requires custom_deserializable<T, value_type>
simdjson_warn_unused constexpr /* error_code */ auto operator()(array_type &object, T& output) const noexcept(nothrow_custom_deserializable<T, value_type>) { [[nodiscard]] constexpr /* error_code */ auto operator()(array_type &object, T& output) const noexcept(nothrow_custom_deserializable<T, value_type>) {
return tag_invoke(*this, object, output); return tag_invoke(*this, object, output);
} }
// Customization Point for object // Customization Point for object
template <typename T> template <typename T>
requires custom_deserializable<T, value_type> requires custom_deserializable<T, value_type>
simdjson_warn_unused constexpr /* error_code */ auto operator()(object_type &object, T& output) const noexcept(nothrow_custom_deserializable<T, value_type>) { [[nodiscard]] constexpr /* error_code */ auto operator()(object_type &object, T& output) const noexcept(nothrow_custom_deserializable<T, value_type>) {
return tag_invoke(*this, object, output); return tag_invoke(*this, object, output);
} }
// Customization Point for value // Customization Point for value
template <typename T> template <typename T>
requires custom_deserializable<T, value_type> requires custom_deserializable<T, value_type>
simdjson_warn_unused constexpr /* error_code */ auto operator()(value_type &object, T& output) const noexcept(nothrow_custom_deserializable<T, value_type>) { [[nodiscard]] constexpr /* error_code */ auto operator()(value_type &object, T& output) const noexcept(nothrow_custom_deserializable<T, value_type>) {
return tag_invoke(*this, object, output); return tag_invoke(*this, object, output);
} }
// Customization Point for document // Customization Point for document
template <typename T> template <typename T>
requires custom_deserializable<T, document_type> requires custom_deserializable<T, document_type>
simdjson_warn_unused constexpr /* error_code */ auto operator()(document_type &object, T& output) const noexcept(nothrow_custom_deserializable<T, document_type>) { [[nodiscard]] constexpr /* error_code */ auto operator()(document_type &object, T& output) const noexcept(nothrow_custom_deserializable<T, document_type>) {
return tag_invoke(*this, object, output); return tag_invoke(*this, object, output);
} }
// Customization Point for document reference // Customization Point for document reference
template <typename T> template <typename T>
requires custom_deserializable<T, document_reference_type> requires custom_deserializable<T, document_reference_type>
simdjson_warn_unused constexpr /* error_code */ auto operator()(document_reference_type &object, T& output) const noexcept(nothrow_custom_deserializable<T, document_reference_type>) { [[nodiscard]] constexpr /* error_code */ auto operator()(document_reference_type &object, T& output) const noexcept(nothrow_custom_deserializable<T, document_reference_type>) {
return tag_invoke(*this, object, output); return tag_invoke(*this, object, output);
} }
@@ -88,5 +135,5 @@ inline constexpr struct deserialize_tag {
} // namespace simdjson } // namespace simdjson
#endif // SIMDJSON_ONDEMAND_DESERIALIZE_H #endif // SIMDJSON_ONDEMAND_DESERIALIZE_H
#endif // SIMDJSON_SUPPORTS_CONCEPTS #endif // SIMDJSON_SUPPORTS_DESERIALIZATION
+26 -123
View File
@@ -141,7 +141,7 @@ simdjson_inline simdjson_result<std::string_view> document::get_string(bool allo
return get_root_value_iterator().get_root_string(true, allow_replacement); return get_root_value_iterator().get_root_string(true, allow_replacement);
} }
template <typename string_type> template <typename string_type>
simdjson_warn_unused simdjson_inline error_code document::get_string(string_type& receiver, bool allow_replacement) noexcept { simdjson_inline error_code document::get_string(string_type& receiver, bool allow_replacement) noexcept {
return get_root_value_iterator().get_root_string(receiver, true, allow_replacement); return get_root_value_iterator().get_root_string(receiver, true, allow_replacement);
} }
simdjson_inline simdjson_result<std::string_view> document::get_wobbly_string() noexcept { simdjson_inline simdjson_result<std::string_view> document::get_wobbly_string() noexcept {
@@ -167,15 +167,15 @@ template<> simdjson_inline simdjson_result<int64_t> document::get() & noexcept {
template<> simdjson_inline simdjson_result<bool> document::get() & noexcept { return get_bool(); } template<> simdjson_inline simdjson_result<bool> document::get() & noexcept { return get_bool(); }
template<> simdjson_inline simdjson_result<value> document::get() & noexcept { return get_value(); } template<> simdjson_inline simdjson_result<value> document::get() & noexcept { return get_value(); }
template<> simdjson_warn_unused simdjson_inline error_code document::get(array& out) & noexcept { return get_array().get(out); } template<> simdjson_inline error_code document::get(array& out) & noexcept { return get_array().get(out); }
template<> simdjson_warn_unused simdjson_inline error_code document::get(object& out) & noexcept { return get_object().get(out); } template<> simdjson_inline error_code document::get(object& out) & noexcept { return get_object().get(out); }
template<> simdjson_warn_unused simdjson_inline error_code document::get(raw_json_string& out) & noexcept { return get_raw_json_string().get(out); } template<> simdjson_inline error_code document::get(raw_json_string& out) & noexcept { return get_raw_json_string().get(out); }
template<> simdjson_warn_unused simdjson_inline error_code document::get(std::string_view& out) & noexcept { return get_string(false).get(out); } template<> simdjson_inline error_code document::get(std::string_view& out) & noexcept { return get_string(false).get(out); }
template<> simdjson_warn_unused simdjson_inline error_code document::get(double& out) & noexcept { return get_double().get(out); } template<> simdjson_inline error_code document::get(double& out) & noexcept { return get_double().get(out); }
template<> simdjson_warn_unused simdjson_inline error_code document::get(uint64_t& out) & noexcept { return get_uint64().get(out); } template<> simdjson_inline error_code document::get(uint64_t& out) & noexcept { return get_uint64().get(out); }
template<> simdjson_warn_unused simdjson_inline error_code document::get(int64_t& out) & noexcept { return get_int64().get(out); } template<> simdjson_inline error_code document::get(int64_t& out) & noexcept { return get_int64().get(out); }
template<> simdjson_warn_unused simdjson_inline error_code document::get(bool& out) & noexcept { return get_bool().get(out); } template<> simdjson_inline error_code document::get(bool& out) & noexcept { return get_bool().get(out); }
template<> simdjson_warn_unused simdjson_inline error_code document::get(value& out) & noexcept { return get_value().get(out); } template<> simdjson_inline error_code document::get(value& out) & noexcept { return get_value().get(out); }
template<> simdjson_deprecated simdjson_inline simdjson_result<raw_json_string> document::get() && noexcept { return get_raw_json_string(); } template<> simdjson_deprecated simdjson_inline simdjson_result<raw_json_string> document::get() && noexcept { return get_raw_json_string(); }
template<> simdjson_deprecated simdjson_inline simdjson_result<std::string_view> document::get() && noexcept { return get_string(false); } template<> simdjson_deprecated simdjson_inline simdjson_result<std::string_view> document::get() && noexcept { return get_string(false); }
@@ -195,8 +195,8 @@ simdjson_inline document::operator object() & noexcept(false) { return get_objec
simdjson_inline document::operator uint64_t() noexcept(false) { return get_uint64(); } simdjson_inline document::operator uint64_t() noexcept(false) { return get_uint64(); }
simdjson_inline document::operator int64_t() noexcept(false) { return get_int64(); } simdjson_inline document::operator int64_t() noexcept(false) { return get_int64(); }
simdjson_inline document::operator double() noexcept(false) { return get_double(); } simdjson_inline document::operator double() noexcept(false) { return get_double(); }
simdjson_inline document::operator std::string_view() noexcept(false) simdjson_lifetime_bound { return get_string(false); } simdjson_inline document::operator std::string_view() noexcept(false) { return get_string(false); }
simdjson_inline document::operator raw_json_string() noexcept(false) simdjson_lifetime_bound { return get_raw_json_string(); } simdjson_inline document::operator raw_json_string() noexcept(false) { return get_raw_json_string(); }
simdjson_inline document::operator bool() noexcept(false) { return get_bool(); } simdjson_inline document::operator bool() noexcept(false) { return get_bool(); }
simdjson_inline document::operator value() noexcept(false) { return get_value(); } simdjson_inline document::operator value() noexcept(false) { return get_value(); }
@@ -245,7 +245,7 @@ simdjson_inline simdjson_result<value> document::operator[](const char *key) & n
return start_or_resume_object()[key]; return start_or_resume_object()[key];
} }
simdjson_warn_unused simdjson_inline error_code document::consume() noexcept { simdjson_inline error_code document::consume() noexcept {
bool scalar = false; bool scalar = false;
auto error = is_scalar().get(scalar); auto error = is_scalar().get(scalar);
if(error) { return error; } if(error) { return error; }
@@ -347,69 +347,6 @@ simdjson_inline simdjson_result<value> document::at_path(std::string_view json_p
} }
} }
simdjson_inline simdjson_result<std::vector<value>> document::at_path_with_wildcard(std::string_view json_path) noexcept {
rewind(); // Rewind the document each time at_path_with_wildcard is called
if (json_path.empty()) {
return INVALID_JSON_POINTER;
}
json_type t;
SIMDJSON_TRY(type().get(t));
switch (t) {
case json_type::array:
return (*this).get_array().at_path_with_wildcard(json_path);
case json_type::object:
return (*this).get_object().at_path_with_wildcard(json_path);
default:
return INVALID_JSON_POINTER;
}
}
#if SIMDJSON_SUPPORTS_CONCEPTS && SIMDJSON_STATIC_REFLECTION
template<constevalutil::fixed_string... FieldNames, typename T>
requires(std::is_class_v<T> && (sizeof...(FieldNames) > 0))
simdjson_warn_unused simdjson_inline error_code document::extract_into(T& out) & noexcept {
// Helper to check if a field name matches any of the requested fields
auto should_extract = [](std::string_view field_name) constexpr -> bool {
return ((FieldNames.view() == field_name) || ...);
};
// Iterate through all members of T using reflection
template for (constexpr auto mem : std::define_static_array(
std::meta::nonstatic_data_members_of(^^T, std::meta::access_context::unchecked()))) {
if constexpr (!std::meta::is_const(mem) && std::meta::is_public(mem)) {
constexpr std::string_view key = std::define_static_string(std::meta::identifier_of(mem));
// Only extract this field if it's in our list of requested fields
if constexpr (should_extract(key)) {
// Try to find and extract the field
if constexpr (concepts::optional_type<decltype(out.[:mem:])>) {
// For optional fields, it's ok if they're missing
auto field_result = find_field_unordered(key);
if (!field_result.error()) {
auto error = field_result.get(out.[:mem:]);
if (error && error != NO_SUCH_FIELD) {
return error;
}
} else if (field_result.error() != NO_SUCH_FIELD) {
return field_result.error();
} else {
out.[:mem:].reset();
}
} else {
// For required fields (in the requested list), fail if missing
SIMDJSON_TRY((*this)[key].get(out.[:mem:]));
}
}
}
};
return SUCCESS;
}
#endif // SIMDJSON_SUPPORTS_CONCEPTS && SIMDJSON_STATIC_REFLECTION
} // namespace ondemand } // namespace ondemand
} // namespace SIMDJSON_IMPLEMENTATION } // namespace SIMDJSON_IMPLEMENTATION
} // namespace simdjson } // namespace simdjson
@@ -517,7 +454,7 @@ simdjson_inline simdjson_result<std::string_view> simdjson_result<SIMDJSON_IMPLE
return first.get_string(allow_replacement); return first.get_string(allow_replacement);
} }
template <typename string_type> template <typename string_type>
simdjson_warn_unused simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document>::get_string(string_type& receiver, bool allow_replacement) noexcept { simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document>::get_string(string_type& receiver, bool allow_replacement) noexcept {
if (error()) { return error(); } if (error()) { return error(); }
return first.get_string(receiver, allow_replacement); return first.get_string(receiver, allow_replacement);
} }
@@ -553,12 +490,12 @@ simdjson_deprecated simdjson_inline simdjson_result<T> simdjson_result<SIMDJSON_
return std::forward<SIMDJSON_IMPLEMENTATION::ondemand::document>(first).get<T>(); return std::forward<SIMDJSON_IMPLEMENTATION::ondemand::document>(first).get<T>();
} }
template<typename T> template<typename T>
simdjson_warn_unused simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document>::get(T &out) & noexcept { simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document>::get(T &out) & noexcept {
if (error()) { return error(); } if (error()) { return error(); }
return first.get<T>(out); return first.get<T>(out);
} }
template<typename T> template<typename T>
simdjson_warn_unused simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document>::get(T &out) && noexcept { simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document>::get(T &out) && noexcept {
if (error()) { return error(); } if (error()) { return error(); }
return std::forward<SIMDJSON_IMPLEMENTATION::ondemand::document>(first).get<T>(out); return std::forward<SIMDJSON_IMPLEMENTATION::ondemand::document>(first).get<T>(out);
} }
@@ -568,8 +505,8 @@ template<> simdjson_deprecated simdjson_inline simdjson_result<SIMDJSON_IMPLEMEN
if (error()) { return error(); } if (error()) { return error(); }
return std::forward<SIMDJSON_IMPLEMENTATION::ondemand::document>(first); return std::forward<SIMDJSON_IMPLEMENTATION::ondemand::document>(first);
} }
template<> simdjson_warn_unused simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document>::get<SIMDJSON_IMPLEMENTATION::ondemand::document>(SIMDJSON_IMPLEMENTATION::ondemand::document &out) & noexcept = delete; template<> simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document>::get<SIMDJSON_IMPLEMENTATION::ondemand::document>(SIMDJSON_IMPLEMENTATION::ondemand::document &out) & noexcept = delete;
template<> simdjson_warn_unused simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document>::get<SIMDJSON_IMPLEMENTATION::ondemand::document>(SIMDJSON_IMPLEMENTATION::ondemand::document &out) && noexcept { template<> simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document>::get<SIMDJSON_IMPLEMENTATION::ondemand::document>(SIMDJSON_IMPLEMENTATION::ondemand::document &out) && noexcept {
if (error()) { return error(); } if (error()) { return error(); }
out = std::forward<SIMDJSON_IMPLEMENTATION::ondemand::document>(first); out = std::forward<SIMDJSON_IMPLEMENTATION::ondemand::document>(first);
return SUCCESS; return SUCCESS;
@@ -687,20 +624,6 @@ simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> simdjs
return first.at_path(json_path); return first.at_path(json_path);
} }
simdjson_inline simdjson_result<std::vector<SIMDJSON_IMPLEMENTATION::ondemand::value>> simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document>::at_path_with_wildcard(std::string_view json_path) noexcept {
if (error()) { return error(); }
return first.at_path_with_wildcard(json_path);
}
#if SIMDJSON_STATIC_REFLECTION
template<constevalutil::fixed_string... FieldNames, typename T>
requires(std::is_class_v<T> && (sizeof...(FieldNames) > 0))
simdjson_warn_unused simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document>::extract_into(T& out) & noexcept {
if (error()) { return error(); }
return first.extract_into<FieldNames...>(out);
}
#endif // SIMDJSON_STATIC_REFLECTION
} // namespace simdjson } // namespace simdjson
@@ -735,7 +658,7 @@ simdjson_inline simdjson_result<double> document_reference::get_double() noexcep
simdjson_inline simdjson_result<double> document_reference::get_double_in_string() noexcept { return doc->get_root_value_iterator().get_root_double(false); } simdjson_inline simdjson_result<double> document_reference::get_double_in_string() noexcept { return doc->get_root_value_iterator().get_root_double(false); }
simdjson_inline simdjson_result<std::string_view> document_reference::get_string(bool allow_replacement) noexcept { return doc->get_root_value_iterator().get_root_string(false, allow_replacement); } simdjson_inline simdjson_result<std::string_view> document_reference::get_string(bool allow_replacement) noexcept { return doc->get_root_value_iterator().get_root_string(false, allow_replacement); }
template <typename string_type> template <typename string_type>
simdjson_warn_unused simdjson_inline error_code document_reference::get_string(string_type& receiver, bool allow_replacement) noexcept { return doc->get_root_value_iterator().get_root_string(receiver, false, allow_replacement); } simdjson_inline error_code document_reference::get_string(string_type& receiver, bool allow_replacement) noexcept { return doc->get_root_value_iterator().get_root_string(receiver, false, allow_replacement); }
simdjson_inline simdjson_result<std::string_view> document_reference::get_wobbly_string() noexcept { return doc->get_root_value_iterator().get_root_wobbly_string(false); } simdjson_inline simdjson_result<std::string_view> document_reference::get_wobbly_string() noexcept { return doc->get_root_value_iterator().get_root_wobbly_string(false); }
simdjson_inline simdjson_result<raw_json_string> document_reference::get_raw_json_string() noexcept { return doc->get_root_value_iterator().get_root_raw_json_string(false); } simdjson_inline simdjson_result<raw_json_string> document_reference::get_raw_json_string() noexcept { return doc->get_root_value_iterator().get_root_raw_json_string(false); }
simdjson_inline simdjson_result<bool> document_reference::get_bool() noexcept { return doc->get_root_value_iterator().get_root_bool(false); } simdjson_inline simdjson_result<bool> document_reference::get_bool() noexcept { return doc->get_root_value_iterator().get_root_bool(false); }
@@ -786,16 +709,9 @@ simdjson_inline simdjson_result<number> document_reference::get_number() noexcep
simdjson_inline simdjson_result<std::string_view> document_reference::raw_json_token() noexcept { return doc->raw_json_token(); } simdjson_inline simdjson_result<std::string_view> document_reference::raw_json_token() noexcept { return doc->raw_json_token(); }
simdjson_inline simdjson_result<value> document_reference::at_pointer(std::string_view json_pointer) noexcept { return doc->at_pointer(json_pointer); } simdjson_inline simdjson_result<value> document_reference::at_pointer(std::string_view json_pointer) noexcept { return doc->at_pointer(json_pointer); }
simdjson_inline simdjson_result<value> document_reference::at_path(std::string_view json_path) noexcept { return doc->at_path(json_path); } simdjson_inline simdjson_result<value> document_reference::at_path(std::string_view json_path) noexcept { return doc->at_path(json_path); }
simdjson_inline simdjson_result<std::vector<value>> document_reference::at_path_with_wildcard(std::string_view json_path) noexcept { return doc->at_path_with_wildcard(json_path); }
simdjson_inline simdjson_result<std::string_view> document_reference::raw_json() noexcept { return doc->raw_json();} simdjson_inline simdjson_result<std::string_view> document_reference::raw_json() noexcept { return doc->raw_json();}
simdjson_inline document_reference::operator document&() const noexcept { return *doc; } simdjson_inline document_reference::operator document&() const noexcept { return *doc; }
#if SIMDJSON_SUPPORTS_CONCEPTS && SIMDJSON_STATIC_REFLECTION
template<constevalutil::fixed_string... FieldNames, typename T>
requires(std::is_class_v<T> && (sizeof...(FieldNames) > 0))
simdjson_warn_unused simdjson_inline error_code document_reference::extract_into(T& out) & noexcept {
return doc->extract_into<FieldNames...>(out);
}
#endif // SIMDJSON_SUPPORTS_CONCEPTS && SIMDJSON_STATIC_REFLECTION
} // namespace ondemand } // namespace ondemand
} // namespace SIMDJSON_IMPLEMENTATION } // namespace SIMDJSON_IMPLEMENTATION
} // namespace simdjson } // namespace simdjson
@@ -892,7 +808,7 @@ simdjson_inline simdjson_result<std::string_view> simdjson_result<SIMDJSON_IMPLE
return first.get_string(allow_replacement); return first.get_string(allow_replacement);
} }
template <typename string_type> template <typename string_type>
simdjson_warn_unused simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document_reference>::get_string(string_type& receiver, bool allow_replacement) noexcept { simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document_reference>::get_string(string_type& receiver, bool allow_replacement) noexcept {
if (error()) { return error(); } if (error()) { return error(); }
return first.get_string(receiver, allow_replacement); return first.get_string(receiver, allow_replacement);
} }
@@ -927,12 +843,12 @@ simdjson_inline simdjson_result<T> simdjson_result<SIMDJSON_IMPLEMENTATION::onde
return std::forward<SIMDJSON_IMPLEMENTATION::ondemand::document_reference>(first).get<T>(); return std::forward<SIMDJSON_IMPLEMENTATION::ondemand::document_reference>(first).get<T>();
} }
template <class T> template <class T>
simdjson_warn_unused simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document_reference>::get(T &out) & noexcept { simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document_reference>::get(T &out) & noexcept {
if (error()) { return error(); } if (error()) { return error(); }
return first.get<T>(out); return first.get<T>(out);
} }
template <class T> template <class T>
simdjson_warn_unused simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document_reference>::get(T &out) && noexcept { simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document_reference>::get(T &out) && noexcept {
if (error()) { return error(); } if (error()) { return error(); }
return std::forward<SIMDJSON_IMPLEMENTATION::ondemand::document_reference>(first).get<T>(out); return std::forward<SIMDJSON_IMPLEMENTATION::ondemand::document_reference>(first).get<T>(out);
} }
@@ -949,13 +865,13 @@ simdjson_inline simdjson_result<bool> simdjson_result<SIMDJSON_IMPLEMENTATION::o
return first.is_string(); return first.is_string();
} }
template <> template <>
simdjson_warn_unused simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document_reference>::get(SIMDJSON_IMPLEMENTATION::ondemand::document_reference &out) & noexcept { simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document_reference>::get(SIMDJSON_IMPLEMENTATION::ondemand::document_reference &out) & noexcept {
if (error()) { return error(); } if (error()) { return error(); }
out = first; out = first;
return SUCCESS; return SUCCESS;
} }
template <> template <>
simdjson_warn_unused simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document_reference>::get(SIMDJSON_IMPLEMENTATION::ondemand::document_reference &out) && noexcept { simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document_reference>::get(SIMDJSON_IMPLEMENTATION::ondemand::document_reference &out) && noexcept {
if (error()) { return error(); } if (error()) { return error(); }
out = first; out = first;
return SUCCESS; return SUCCESS;
@@ -1043,20 +959,7 @@ simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> simdjs
} }
return first.at_path(json_path); return first.at_path(json_path);
} }
simdjson_inline simdjson_result<std::vector<SIMDJSON_IMPLEMENTATION::ondemand::value>> simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document_reference>::at_path_with_wildcard(std::string_view json_path) noexcept {
if (error()) {
return error();
}
return first.at_path_with_wildcard(json_path);
}
#if SIMDJSON_STATIC_REFLECTION
template<constevalutil::fixed_string... FieldNames, typename T>
requires(std::is_class_v<T> && (sizeof...(FieldNames) > 0))
simdjson_warn_unused simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document_reference>::extract_into(T& out) & noexcept {
if (error()) { return error(); }
return first.extract_into<FieldNames...>(out);
}
#endif // SIMDJSON_STATIC_REFLECTION
} // namespace simdjson } // namespace simdjson
#endif // SIMDJSON_GENERIC_ONDEMAND_DOCUMENT_INL_H #endif // SIMDJSON_GENERIC_ONDEMAND_DOCUMENT_INL_H
+24 -109
View File
@@ -6,7 +6,6 @@
#include "simdjson/generic/ondemand/json_iterator.h" #include "simdjson/generic/ondemand/json_iterator.h"
#include "simdjson/generic/ondemand/deserialize.h" #include "simdjson/generic/ondemand/deserialize.h"
#include "simdjson/generic/ondemand/value.h" #include "simdjson/generic/ondemand/value.h"
#include <vector>
#endif // SIMDJSON_CONDITIONAL_INCLUDE #endif // SIMDJSON_CONDITIONAL_INCLUDE
@@ -118,7 +117,7 @@ public:
* @returns INCORRECT_TYPE if the JSON value is not a string. Otherwise, we return SUCCESS. * @returns INCORRECT_TYPE if the JSON value is not a string. Otherwise, we return SUCCESS.
*/ */
template <typename string_type> template <typename string_type>
simdjson_warn_unused simdjson_inline error_code get_string(string_type& receiver, bool allow_replacement = false) noexcept; simdjson_inline error_code get_string(string_type& receiver, bool allow_replacement = false) noexcept;
/** /**
* Cast this JSON value to a string. * Cast this JSON value to a string.
* *
@@ -184,7 +183,7 @@ public:
*/ */
template <typename T> template <typename T>
simdjson_inline simdjson_result<T> get() & simdjson_inline simdjson_result<T> get() &
#if SIMDJSON_SUPPORTS_CONCEPTS #if SIMDJSON_SUPPORTS_DESERIALIZATION
noexcept(custom_deserializable<T, document> ? nothrow_custom_deserializable<T, document> : true) noexcept(custom_deserializable<T, document> ? nothrow_custom_deserializable<T, document> : true)
#else #else
noexcept noexcept
@@ -207,7 +206,7 @@ public:
*/ */
template<typename T> template<typename T>
simdjson_inline simdjson_result<T> get() && simdjson_inline simdjson_result<T> get() &&
#if SIMDJSON_SUPPORTS_CONCEPTS #if SIMDJSON_SUPPORTS_DESERIALIZATION
noexcept(custom_deserializable<T, document> ? nothrow_custom_deserializable<T, document> : true) noexcept(custom_deserializable<T, document> ? nothrow_custom_deserializable<T, document> : true)
#else #else
noexcept noexcept
@@ -229,14 +228,14 @@ public:
* @returns SUCCESS If the parse succeeded and the out parameter was set to the value. * @returns SUCCESS If the parse succeeded and the out parameter was set to the value.
*/ */
template<typename T> template<typename T>
simdjson_warn_unused simdjson_inline error_code get(T &out) & simdjson_inline error_code get(T &out) &
#if SIMDJSON_SUPPORTS_CONCEPTS #if SIMDJSON_SUPPORTS_DESERIALIZATION
noexcept(custom_deserializable<T, document> ? nothrow_custom_deserializable<T, document> : true) noexcept(custom_deserializable<T, document> ? nothrow_custom_deserializable<T, document> : true)
#else #else
noexcept noexcept
#endif #endif
{ {
#if SIMDJSON_SUPPORTS_CONCEPTS #if SIMDJSON_SUPPORTS_DESERIALIZATION
if constexpr (custom_deserializable<T, document>) { if constexpr (custom_deserializable<T, document>) {
return deserialize(*this, out); return deserialize(*this, out);
} else { } else {
@@ -248,7 +247,7 @@ public:
static_cast<void>(out); // to get rid of unused errors static_cast<void>(out); // to get rid of unused errors
return UNINITIALIZED; return UNINITIALIZED;
} }
#else // SIMDJSON_SUPPORTS_CONCEPTS #else // SIMDJSON_SUPPORTS_DESERIALIZATION
// Unless the simdjson library or the user provides an inline implementation, calling this method should // Unless the simdjson library or the user provides an inline implementation, calling this method should
// immediately fail. // immediately fail.
static_assert(!sizeof(T), "The get method with given type is not implemented by the simdjson library. " static_assert(!sizeof(T), "The get method with given type is not implemented by the simdjson library. "
@@ -258,7 +257,7 @@ public:
" You may also add support for custom types, see our documentation."); " You may also add support for custom types, see our documentation.");
static_cast<void>(out); // to get rid of unused errors static_cast<void>(out); // to get rid of unused errors
return UNINITIALIZED; return UNINITIALIZED;
#endif // SIMDJSON_SUPPORTS_CONCEPTS #endif // SIMDJSON_SUPPORTS_DESERIALIZATION
} }
/** @overload template<typename T> error_code get(T &out) & noexcept */ /** @overload template<typename T> error_code get(T &out) & noexcept */
@@ -323,7 +322,7 @@ public:
* time it parses a document or when it is destroyed. * time it parses a document or when it is destroyed.
* @exception simdjson_error(INCORRECT_TYPE) if the JSON value is not a string. * @exception simdjson_error(INCORRECT_TYPE) if the JSON value is not a string.
*/ */
simdjson_inline operator std::string_view() noexcept(false) simdjson_lifetime_bound; simdjson_inline operator std::string_view() noexcept(false);
/** /**
* Cast this JSON value to a raw_json_string. * Cast this JSON value to a raw_json_string.
* *
@@ -332,7 +331,7 @@ public:
* @returns A pointer to the raw JSON for the given string. * @returns A pointer to the raw JSON for the given string.
* @exception simdjson_error(INCORRECT_TYPE) if the JSON value is not a string. * @exception simdjson_error(INCORRECT_TYPE) if the JSON value is not a string.
*/ */
simdjson_inline operator raw_json_string() noexcept(false) simdjson_lifetime_bound; simdjson_inline operator raw_json_string() noexcept(false);
/** /**
* Cast this JSON value to a bool. * Cast this JSON value to a bool.
* *
@@ -408,7 +407,7 @@ public:
* The following code reads z, then y, then x, and thus will not retrieve x or y if fed the * The following code reads z, then y, then x, and thus will not retrieve x or y if fed the
* JSON `{ "x": 1, "y": 2, "z": 3 }`: * JSON `{ "x": 1, "y": 2, "z": 3 }`:
* *
* ```cpp * ```c++
* simdjson::ondemand::parser parser; * simdjson::ondemand::parser parser;
* auto obj = parser.parse(R"( { "x": 1, "y": 2, "z": 3 } )"_padded); * auto obj = parser.parse(R"( { "x": 1, "y": 2, "z": 3 } )"_padded);
* double z = obj.find_field("z"); * double z = obj.find_field("z");
@@ -482,27 +481,11 @@ public:
* E.g., you must still call "is_null()" to check that a value is null even if * E.g., you must still call "is_null()" to check that a value is null even if
* "type()" returns json_type::null. * "type()" returns json_type::null.
* *
* The answer can be one of
* simdjson::ondemand::json_type::object,
* simdjson::ondemand::json_type::array,
* simdjson::ondemand::json_type::string,
* simdjson::ondemand::json_type::number,
* simdjson::ondemand::json_type::boolean,
* simdjson::ondemand::json_type::null.
*
* Starting with simdjson 4.0, this function will return simdjson::ondemand::json_type::unknown
* given a bad token.
* This allows you to identify a case such as {"key": NaN} and identify the NaN value.
* The simdjson::ondemand::json_type::unknown value should only happen with non-valid JSON.
*
* NOTE: If you're only expecting a value to be one type (a typical case), it's generally * NOTE: If you're only expecting a value to be one type (a typical case), it's generally
* better to just call .get_double, .get_string, etc. and check for INCORRECT_TYPE (or just * better to just call .get_double, .get_string, etc. and check for INCORRECT_TYPE (or just
* let it throw an exception). * let it throw an exception).
* *
* Prior to simdjson 4.0, this function would return an error given a bad token. * @error TAPE_ERROR when the JSON value is a bad token like "}" "," or "alse".
* Starting with simdjson 4.0, it will return simdjson::ondemand::json_type::unknown.
* This allows you to identify a case such as {"key": NaN} and identify the NaN value.
* The simdjson::ondemand::json_type::unknown value should only happen with non-valid JSON.
*/ */
simdjson_inline simdjson_result<json_type> type() noexcept; simdjson_inline simdjson_result<json_type> type() noexcept;
@@ -702,7 +685,7 @@ public:
* JSONPath queries that trivially convertible to JSON Pointer queries: key * JSONPath queries that trivially convertible to JSON Pointer queries: key
* names and array indices. * names and array indices.
* *
* https://www.rfc-editor.org/rfc/rfc9535 (RFC 9535) * https://datatracker.ietf.org/doc/html/draft-normington-jsonpath-00
* *
* Key values are matched exactly, without unescaping or Unicode normalization. * Key values are matched exactly, without unescaping or Unicode normalization.
* We do a byte-by-byte comparison. E.g. * We do a byte-by-byte comparison. E.g.
@@ -720,64 +703,17 @@ public:
*/ */
simdjson_inline simdjson_result<value> at_path(std::string_view json_path) noexcept; simdjson_inline simdjson_result<value> at_path(std::string_view json_path) noexcept;
/**
* Get all values matching the given JSONPath expression with wildcard support.
*
* Supports wildcard patterns like "$.array[*]" or "$.object.*" to match multiple elements.
*
* This method materializes all matching values into a vector.
* The document will be consumed after this call.
*
* @param json_path JSONPath expression with wildcards
* @return Vector of values matching the wildcard pattern, or:
* - INVALID_JSON_POINTER if the JSONPath cannot be parsed
* - NO_SUCH_FIELD if a field does not exist
* - INDEX_OUT_OF_BOUNDS if an array index is out of bounds
* - INCORRECT_TYPE if path traversal encounters wrong type
*/
simdjson_inline simdjson_result<std::vector<value>> at_path_with_wildcard(std::string_view json_path) noexcept;
/** /**
* Consumes the document and returns a string_view instance corresponding to the * Consumes the document and returns a string_view instance corresponding to the
* document as represented in JSON. It points inside the original byte array containing * document as represented in JSON. It points inside the original byte array containing
* the JSON document. * the JSON document.
*/ */
simdjson_inline simdjson_result<std::string_view> raw_json() noexcept; simdjson_inline simdjson_result<std::string_view> raw_json() noexcept;
#if SIMDJSON_STATIC_REFLECTION
/**
* Extract only specific fields from the JSON object into a struct.
*
* This allows selective deserialization of only the fields you need,
* potentially improving performance by skipping unwanted fields.
*
* Example:
* ```cpp
* struct Car {
* std::string make;
* std::string model;
* int year;
* double price;
* };
*
* Car car;
* doc.extract_into<"make", "model">(car);
* // Only 'make' and 'model' fields are extracted from JSON
* ```
*
* @tparam FieldNames Compile-time string literals specifying which fields to extract
* @param out The output struct to populate with selected fields
* @returns SUCCESS on success, or an error code if a required field is missing or has wrong type
*/
template<constevalutil::fixed_string... FieldNames, typename T>
requires(std::is_class_v<T> && (sizeof...(FieldNames) > 0))
simdjson_warn_unused simdjson_inline error_code extract_into(T& out) & noexcept;
#endif // SIMDJSON_STATIC_REFLECTION
protected: protected:
/** /**
* Consumes the document. * Consumes the document.
*/ */
simdjson_warn_unused simdjson_inline error_code consume() noexcept; simdjson_inline error_code consume() noexcept;
simdjson_inline document(ondemand::json_iterator &&iter) noexcept; simdjson_inline document(ondemand::json_iterator &&iter) noexcept;
simdjson_inline const uint8_t *text(uint32_t idx) const noexcept; simdjson_inline const uint8_t *text(uint32_t idx) const noexcept;
@@ -830,7 +766,7 @@ public:
simdjson_inline simdjson_result<double> get_double_in_string() noexcept; simdjson_inline simdjson_result<double> get_double_in_string() noexcept;
simdjson_inline simdjson_result<std::string_view> get_string(bool allow_replacement = false) noexcept; simdjson_inline simdjson_result<std::string_view> get_string(bool allow_replacement = false) noexcept;
template <typename string_type> template <typename string_type>
simdjson_warn_unused simdjson_inline error_code get_string(string_type& receiver, bool allow_replacement = false) noexcept; simdjson_inline error_code get_string(string_type& receiver, bool allow_replacement = false) noexcept;
simdjson_inline simdjson_result<std::string_view> get_wobbly_string() noexcept; simdjson_inline simdjson_result<std::string_view> get_wobbly_string() noexcept;
simdjson_inline simdjson_result<raw_json_string> get_raw_json_string() noexcept; simdjson_inline simdjson_result<raw_json_string> get_raw_json_string() noexcept;
simdjson_inline simdjson_result<bool> get_bool() noexcept; simdjson_inline simdjson_result<bool> get_bool() noexcept;
@@ -839,7 +775,7 @@ public:
simdjson_inline simdjson_result<bool> is_null() noexcept; simdjson_inline simdjson_result<bool> is_null() noexcept;
template <typename T> template <typename T>
simdjson_inline simdjson_result<T> get() & simdjson_inline simdjson_result<T> get() &
#if SIMDJSON_SUPPORTS_CONCEPTS #if SIMDJSON_SUPPORTS_DESERIALIZATION
noexcept(custom_deserializable<T, document> ? nothrow_custom_deserializable<T, document> : true) noexcept(custom_deserializable<T, document> ? nothrow_custom_deserializable<T, document> : true)
#else #else
noexcept noexcept
@@ -852,7 +788,7 @@ public:
} }
template<typename T> template<typename T>
simdjson_inline simdjson_result<T> get() && simdjson_inline simdjson_result<T> get() &&
#if SIMDJSON_SUPPORTS_CONCEPTS #if SIMDJSON_SUPPORTS_DESERIALIZATION
noexcept(custom_deserializable<T, document> ? nothrow_custom_deserializable<T, document> : true) noexcept(custom_deserializable<T, document> ? nothrow_custom_deserializable<T, document> : true)
#else #else
noexcept noexcept
@@ -874,14 +810,14 @@ public:
* @returns SUCCESS If the parse succeeded and the out parameter was set to the value. * @returns SUCCESS If the parse succeeded and the out parameter was set to the value.
*/ */
template<typename T> template<typename T>
simdjson_warn_unused simdjson_inline error_code get(T &out) & simdjson_inline error_code get(T &out) &
#if SIMDJSON_SUPPORTS_CONCEPTS #if SIMDJSON_SUPPORTS_DESERIALIZATION
noexcept(custom_deserializable<T, document> ? nothrow_custom_deserializable<T, document_reference> : true) noexcept(custom_deserializable<T, document> ? nothrow_custom_deserializable<T, document_reference> : true)
#else #else
noexcept noexcept
#endif #endif
{ {
#if SIMDJSON_SUPPORTS_CONCEPTS #if SIMDJSON_SUPPORTS_DESERIALIZATION
if constexpr (custom_deserializable<T, document_reference>) { if constexpr (custom_deserializable<T, document_reference>) {
return deserialize(*this, out); return deserialize(*this, out);
} else { } else {
@@ -893,7 +829,7 @@ public:
static_cast<void>(out); // to get rid of unused errors static_cast<void>(out); // to get rid of unused errors
return UNINITIALIZED; return UNINITIALIZED;
} }
#else // SIMDJSON_SUPPORTS_CONCEPTS #else // SIMDJSON_SUPPORTS_DESERIALIZATION
// Unless the simdjson library or the user provides an inline implementation, calling this method should // Unless the simdjson library or the user provides an inline implementation, calling this method should
// immediately fail. // immediately fail.
static_assert(!sizeof(T), "The get method with given type is not implemented by the simdjson library. " static_assert(!sizeof(T), "The get method with given type is not implemented by the simdjson library. "
@@ -903,17 +839,12 @@ public:
" You may also add support for custom types, see our documentation."); " You may also add support for custom types, see our documentation.");
static_cast<void>(out); // to get rid of unused errors static_cast<void>(out); // to get rid of unused errors
return UNINITIALIZED; return UNINITIALIZED;
#endif // SIMDJSON_SUPPORTS_CONCEPTS #endif // SIMDJSON_SUPPORTS_DESERIALIZATION
} }
/** @overload template<typename T> error_code get(T &out) & noexcept */ /** @overload template<typename T> error_code get(T &out) & noexcept */
template<typename T> simdjson_inline error_code get(T &out) && noexcept; template<typename T> simdjson_inline error_code get(T &out) && noexcept;
simdjson_inline simdjson_result<std::string_view> raw_json() noexcept; simdjson_inline simdjson_result<std::string_view> raw_json() noexcept;
#if SIMDJSON_STATIC_REFLECTION
template<constevalutil::fixed_string... FieldNames, typename T>
requires(std::is_class_v<T> && (sizeof...(FieldNames) > 0))
simdjson_warn_unused simdjson_inline error_code extract_into(T& out) & noexcept;
#endif // SIMDJSON_STATIC_REFLECTION
simdjson_inline operator document&() const noexcept; simdjson_inline operator document&() const noexcept;
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
template <class T> template <class T>
@@ -954,7 +885,6 @@ public:
simdjson_inline simdjson_result<std::string_view> raw_json_token() noexcept; simdjson_inline simdjson_result<std::string_view> raw_json_token() noexcept;
simdjson_inline simdjson_result<value> at_pointer(std::string_view json_pointer) noexcept; simdjson_inline simdjson_result<value> at_pointer(std::string_view json_pointer) noexcept;
simdjson_inline simdjson_result<value> at_path(std::string_view json_path) noexcept; simdjson_inline simdjson_result<value> at_path(std::string_view json_path) noexcept;
simdjson_inline simdjson_result<std::vector<value>> at_path_with_wildcard(std::string_view json_path) noexcept;
private: private:
document *doc{nullptr}; document *doc{nullptr};
@@ -983,7 +913,7 @@ public:
simdjson_inline simdjson_result<double> get_double_in_string() noexcept; simdjson_inline simdjson_result<double> get_double_in_string() noexcept;
simdjson_inline simdjson_result<std::string_view> get_string(bool allow_replacement = false) noexcept; simdjson_inline simdjson_result<std::string_view> get_string(bool allow_replacement = false) noexcept;
template <typename string_type> template <typename string_type>
simdjson_warn_unused simdjson_inline error_code get_string(string_type& receiver, bool allow_replacement = false) noexcept; simdjson_inline error_code get_string(string_type& receiver, bool allow_replacement = false) noexcept;
simdjson_inline simdjson_result<std::string_view> get_wobbly_string() noexcept; simdjson_inline simdjson_result<std::string_view> get_wobbly_string() noexcept;
simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::raw_json_string> get_raw_json_string() noexcept; simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::raw_json_string> get_raw_json_string() noexcept;
simdjson_inline simdjson_result<bool> get_bool() noexcept; simdjson_inline simdjson_result<bool> get_bool() noexcept;
@@ -996,9 +926,6 @@ public:
template<typename T> simdjson_inline error_code get(T &out) & noexcept; template<typename T> simdjson_inline error_code get(T &out) & noexcept;
template<typename T> simdjson_inline error_code get(T &out) && noexcept; template<typename T> simdjson_inline error_code get(T &out) && noexcept;
#if SIMDJSON_EXCEPTIONS #if SIMDJSON_EXCEPTIONS
using SIMDJSON_IMPLEMENTATION::implementation_simdjson_result_base<SIMDJSON_IMPLEMENTATION::ondemand::document>::operator*;
using SIMDJSON_IMPLEMENTATION::implementation_simdjson_result_base<SIMDJSON_IMPLEMENTATION::ondemand::document>::operator->;
template <class T, typename std::enable_if<std::is_same<T, SIMDJSON_IMPLEMENTATION::ondemand::document>::value == false>::type> template <class T, typename std::enable_if<std::is_same<T, SIMDJSON_IMPLEMENTATION::ondemand::document>::value == false>::type>
explicit simdjson_inline operator T() noexcept(false); explicit simdjson_inline operator T() noexcept(false);
simdjson_inline operator SIMDJSON_IMPLEMENTATION::ondemand::array() & noexcept(false); simdjson_inline operator SIMDJSON_IMPLEMENTATION::ondemand::array() & noexcept(false);
@@ -1038,12 +965,6 @@ public:
simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at_pointer(std::string_view json_pointer) noexcept; simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at_pointer(std::string_view json_pointer) noexcept;
simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at_path(std::string_view json_path) noexcept; simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at_path(std::string_view json_path) noexcept;
simdjson_inline simdjson_result<std::vector<SIMDJSON_IMPLEMENTATION::ondemand::value>> at_path_with_wildcard(std::string_view json_path) noexcept;
#if SIMDJSON_STATIC_REFLECTION
template<constevalutil::fixed_string... FieldNames, typename T>
requires(std::is_class_v<T> && (sizeof...(FieldNames) > 0))
simdjson_warn_unused simdjson_inline error_code extract_into(T& out) & noexcept;
#endif // SIMDJSON_STATIC_REFLECTION
}; };
@@ -1070,7 +991,7 @@ public:
simdjson_inline simdjson_result<double> get_double_in_string() noexcept; simdjson_inline simdjson_result<double> get_double_in_string() noexcept;
simdjson_inline simdjson_result<std::string_view> get_string(bool allow_replacement = false) noexcept; simdjson_inline simdjson_result<std::string_view> get_string(bool allow_replacement = false) noexcept;
template <typename string_type> template <typename string_type>
simdjson_warn_unused simdjson_inline error_code get_string(string_type& receiver, bool allow_replacement = false) noexcept; simdjson_inline error_code get_string(string_type& receiver, bool allow_replacement = false) noexcept;
simdjson_inline simdjson_result<std::string_view> get_wobbly_string() noexcept; simdjson_inline simdjson_result<std::string_view> get_wobbly_string() noexcept;
simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::raw_json_string> get_raw_json_string() noexcept; simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::raw_json_string> get_raw_json_string() noexcept;
simdjson_inline simdjson_result<bool> get_bool() noexcept; simdjson_inline simdjson_result<bool> get_bool() noexcept;
@@ -1121,12 +1042,6 @@ public:
simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at_pointer(std::string_view json_pointer) noexcept; simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at_pointer(std::string_view json_pointer) noexcept;
simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at_path(std::string_view json_path) noexcept; simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at_path(std::string_view json_path) noexcept;
simdjson_inline simdjson_result<std::vector<SIMDJSON_IMPLEMENTATION::ondemand::value>> at_path_with_wildcard(std::string_view json_path) noexcept;
#if SIMDJSON_STATIC_REFLECTION
template<constevalutil::fixed_string... FieldNames, typename T>
requires(std::is_class_v<T> && (sizeof...(FieldNames) > 0))
simdjson_warn_unused simdjson_inline error_code extract_into(T& out) & noexcept;
#endif // SIMDJSON_STATIC_REFLECTION
}; };
@@ -182,19 +182,10 @@ simdjson_inline document_stream::iterator& document_stream::iterator::operator++
return *this; return *this;
} }
simdjson_inline bool document_stream::iterator::at_end() const noexcept {
return finished;
}
simdjson_inline bool document_stream::iterator::operator!=(const document_stream::iterator &other) const noexcept { simdjson_inline bool document_stream::iterator::operator!=(const document_stream::iterator &other) const noexcept {
return finished != other.finished; return finished != other.finished;
} }
simdjson_inline bool document_stream::iterator::operator==(const document_stream::iterator &other) const noexcept {
return finished == other.finished;
}
simdjson_inline document_stream::iterator document_stream::begin() noexcept { simdjson_inline document_stream::iterator document_stream::begin() noexcept {
start(); start();
// If there are no documents, we're finished. // If there are no documents, we're finished.
@@ -312,10 +303,7 @@ inline void document_stream::next_document() noexcept {
// Always set depth=1 at the start of document // Always set depth=1 at the start of document
doc.iter._depth = 1; doc.iter._depth = 1;
// consume comma if comma separated is allowed // consume comma if comma separated is allowed
if (allow_comma_separated) { if (allow_comma_separated) { doc.iter.consume_character(','); }
error_code ignored = doc.iter.consume_character(',');
static_cast<void>(ignored); // ignored on purpose
}
// Resets the string buffer at the beginning, thus invalidating the strings. // Resets the string buffer at the beginning, thus invalidating the strings.
doc.iter._string_buf_loc = parser->string_buf.get(); doc.iter._string_buf_loc = parser->string_buf.get();
doc.iter._root = doc.iter.position(); doc.iter._root = doc.iter.position();
@@ -81,7 +81,7 @@ public:
/** /**
* Construct an uninitialized document_stream. * Construct an uninitialized document_stream.
* *
* ```cpp * ```c++
* document_stream docs; * document_stream docs;
* auto error = parser.iterate_many(json).get(docs); * auto error = parser.iterate_many(json).get(docs);
* ``` * ```
@@ -131,7 +131,6 @@ public:
* Default constructor. * Default constructor.
*/ */
simdjson_inline iterator() noexcept; simdjson_inline iterator() noexcept;
simdjson_inline iterator(const iterator &other) noexcept = default;
/** /**
* Get the current document (or error). * Get the current document (or error).
*/ */
@@ -145,7 +144,6 @@ public:
* @param other the end iterator to compare to. * @param other the end iterator to compare to.
*/ */
simdjson_inline bool operator!=(const iterator &other) const noexcept; simdjson_inline bool operator!=(const iterator &other) const noexcept;
simdjson_inline bool operator==(const iterator &other) const noexcept;
/** /**
* @private * @private
* *
@@ -189,11 +187,6 @@ public:
*/ */
inline error_code error() const noexcept; inline error_code error() const noexcept;
/**
* Returns whether the iterator is at the end.
*/
inline bool at_end() const noexcept;
private: private:
simdjson_inline iterator(document_stream *s, bool finished) noexcept; simdjson_inline iterator(document_stream *s, bool finished) noexcept;
/** The document_stream we're iterating through. */ /** The document_stream we're iterating through. */
@@ -205,7 +198,6 @@ public:
friend class document_stream; friend class document_stream;
friend class json_iterator; friend class json_iterator;
}; };
using iterator = document_stream::iterator;
/** /**
* Start iterating the documents in the stream. * Start iterating the documents in the stream.
@@ -114,7 +114,7 @@ simdjson_inline simdjson_result<std::string_view> simdjson_result<SIMDJSON_IMPLE
} }
template<typename string_type> template<typename string_type>
simdjson_warn_unused simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::field>::unescaped_key(string_type &receiver, bool allow_replacement) noexcept { simdjson_inline error_code simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::field>::unescaped_key(string_type &receiver, bool allow_replacement) noexcept {
if (error()) { return error(); } if (error()) { return error(); }
return first.unescaped_key(receiver, allow_replacement); return first.unescaped_key(receiver, allow_replacement);
} }

Some files were not shown because too many files have changed in this diff Show More