Compare commits
94 Commits
views-test
...
develop
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f3dc4684b4 | ||
|
|
0b938993e1 | ||
|
|
543d8e4179 | ||
|
|
f2e4946865 | ||
|
|
8215dbafbd | ||
|
|
a3143f5f2f | ||
|
|
0b6881a95f | ||
|
|
a43350c4e5 | ||
|
|
8fb5d6f92d | ||
|
|
2dc82053dc | ||
|
|
bf6b1e2f40 | ||
|
|
606b6347ed | ||
|
|
c7d949f9f0 | ||
|
|
e90c860d53 | ||
|
|
d0789e365d | ||
|
|
97dd60c22a | ||
|
|
666d061443 | ||
|
|
bf8ccc20e9 | ||
|
|
786c5040e2 | ||
|
|
bd4fea39ea | ||
|
|
8c7dcd3b43 | ||
|
|
b23cdeac2c | ||
|
|
1b813519c2 | ||
|
|
f06604fce0 | ||
|
|
d23291ba26 | ||
|
|
0f9e6ae098 | ||
|
|
8a882f32ed | ||
|
|
bdb8d2b7b3 | ||
|
|
e72046ef9f | ||
|
|
4a0081a1cf | ||
|
|
52b2614217 | ||
|
|
f74e5c6a57 | ||
|
|
e25a824616 | ||
|
|
26cfec34be | ||
|
|
ad2ee18539 | ||
|
|
2d42229f4d | ||
|
|
1809b3d800 | ||
|
|
48e7b4c23b | ||
|
|
0cb1241d5e | ||
|
|
2e50d5b2f3 | ||
|
|
60c48755e3 | ||
|
|
a6255cc418 | ||
|
|
f038ac4c9d | ||
|
|
4f64d8d0b4 | ||
|
|
2134cb947a | ||
|
|
6057b31df7 | ||
|
|
0fa326a8e8 | ||
|
|
8314ac2f76 | ||
|
|
69c8758d51 | ||
|
|
5ff90d9e02 | ||
|
|
6be4e85600 | ||
|
|
663058e7d1 | ||
|
|
af4ad7915c | ||
|
|
58f5f25968 | ||
|
|
733c59588d | ||
|
|
6cb099e30e | ||
|
|
094bd2651b | ||
|
|
30cd44df95 | ||
|
|
5362012fdd | ||
|
|
861ec9c3c6 | ||
|
|
f4910b20ce | ||
|
|
f2a4ac0673 | ||
|
|
8e1b800017 | ||
|
|
677e19e39c | ||
|
|
9e23b5d61e | ||
|
|
eb142e33c0 | ||
|
|
1c8e26dcb4 | ||
|
|
b6b8378c8c | ||
|
|
58949c0ad5 | ||
|
|
7cfbe321be | ||
|
|
4003f8da02 | ||
|
|
6a2ae22a5a | ||
|
|
620034ecec | ||
|
|
e6cafa573a | ||
|
|
e0a17f8475 | ||
|
|
20ae363a71 | ||
|
|
589641b175 | ||
|
|
f385fe28f2 | ||
|
|
981a4c39f4 | ||
|
|
dd81f878f7 | ||
|
|
549c79ba7e | ||
|
|
9f60e85557 | ||
|
|
a006a7a48b | ||
|
|
1b9a9d1f21 | ||
|
|
935c6eeb5a | ||
|
|
e41905fcb0 | ||
|
|
d333f08958 | ||
|
|
3d6c664de2 | ||
|
|
ee32bfc1c2 | ||
|
|
a97041a98f | ||
|
|
f9f8c07792 | ||
|
|
378e091795 | ||
|
|
1f218e1074 | ||
|
|
64f68dc563 |
@ -1,84 +0,0 @@
|
|||||||
#AccessModifierOffset: 2
|
|
||||||
AlignAfterOpenBracket: Align
|
|
||||||
AlignConsecutiveAssignments: false
|
|
||||||
#AlignConsecutiveBitFields: false
|
|
||||||
AlignConsecutiveDeclarations: false
|
|
||||||
AlignConsecutiveMacros: false
|
|
||||||
AlignEscapedNewlines: Right
|
|
||||||
#AlignOperands: AlignAfterOperator
|
|
||||||
AlignTrailingComments: true
|
|
||||||
AllowAllArgumentsOnNextLine: false
|
|
||||||
AllowAllConstructorInitializersOnNextLine: false
|
|
||||||
AllowAllParametersOfDeclarationOnNextLine: false
|
|
||||||
AllowShortBlocksOnASingleLine: Empty
|
|
||||||
AllowShortCaseLabelsOnASingleLine: false
|
|
||||||
#AllowShortEnumsOnASingleLine: true
|
|
||||||
AllowShortFunctionsOnASingleLine: Empty
|
|
||||||
AllowShortIfStatementsOnASingleLine: Never
|
|
||||||
AllowShortLambdasOnASingleLine: Empty
|
|
||||||
AllowShortLoopsOnASingleLine: false
|
|
||||||
AlwaysBreakAfterReturnType: None
|
|
||||||
AlwaysBreakBeforeMultilineStrings: false
|
|
||||||
AlwaysBreakTemplateDeclarations: Yes
|
|
||||||
BinPackArguments: false
|
|
||||||
BinPackParameters: false
|
|
||||||
#BitFieldColonSpacing: Both
|
|
||||||
BreakBeforeBraces: Custom # or Allman
|
|
||||||
BraceWrapping:
|
|
||||||
AfterCaseLabel: true
|
|
||||||
AfterClass: true
|
|
||||||
AfterControlStatement: Always
|
|
||||||
AfterEnum: true
|
|
||||||
AfterFunction: true
|
|
||||||
AfterNamespace: false
|
|
||||||
AfterStruct: true
|
|
||||||
AfterUnion: true
|
|
||||||
AfterExternBlock: false
|
|
||||||
BeforeCatch: true
|
|
||||||
BeforeElse: true
|
|
||||||
#BeforeLambdaBody: false
|
|
||||||
#BeforeWhile: false
|
|
||||||
SplitEmptyFunction: false
|
|
||||||
SplitEmptyRecord: false
|
|
||||||
SplitEmptyNamespace: false
|
|
||||||
BreakBeforeTernaryOperators: true
|
|
||||||
BreakConstructorInitializers: BeforeComma
|
|
||||||
BreakStringLiterals: false
|
|
||||||
ColumnLimit: 0
|
|
||||||
CompactNamespaces: false
|
|
||||||
ConstructorInitializerIndentWidth: 2
|
|
||||||
Cpp11BracedListStyle: true
|
|
||||||
PointerAlignment: Left
|
|
||||||
FixNamespaceComments: true
|
|
||||||
IncludeBlocks: Preserve
|
|
||||||
#IndentCaseBlocks: false
|
|
||||||
IndentCaseLabels: true
|
|
||||||
IndentGotoLabels: false
|
|
||||||
IndentPPDirectives: BeforeHash
|
|
||||||
IndentWidth: 4
|
|
||||||
KeepEmptyLinesAtTheStartOfBlocks: false
|
|
||||||
MaxEmptyLinesToKeep: 1
|
|
||||||
NamespaceIndentation: None
|
|
||||||
ReflowComments: false
|
|
||||||
SortIncludes: true
|
|
||||||
SortUsingDeclarations: true
|
|
||||||
SpaceAfterCStyleCast: false
|
|
||||||
SpaceAfterLogicalNot: false
|
|
||||||
SpaceAfterTemplateKeyword: false
|
|
||||||
SpaceBeforeAssignmentOperators: true
|
|
||||||
SpaceBeforeCpp11BracedList: false
|
|
||||||
SpaceBeforeParens: ControlStatements
|
|
||||||
SpaceBeforeRangeBasedForLoopColon: true
|
|
||||||
SpaceBeforeSquareBrackets: false
|
|
||||||
SpaceInEmptyBlock: false
|
|
||||||
SpaceInEmptyParentheses: false
|
|
||||||
SpacesBeforeTrailingComments: 2
|
|
||||||
SpacesInAngles: false
|
|
||||||
SpacesInCStyleCastParentheses: false
|
|
||||||
SpacesInConditionalStatement: false
|
|
||||||
SpacesInContainerLiterals: false
|
|
||||||
SpacesInParentheses: false
|
|
||||||
SpacesInSquareBrackets: false
|
|
||||||
Standard: c++11
|
|
||||||
TabWidth: 4
|
|
||||||
UseTab: Never
|
|
||||||
128
.github/CODE_OF_CONDUCT.md
vendored
128
.github/CODE_OF_CONDUCT.md
vendored
@ -2,45 +2,131 @@
|
|||||||
|
|
||||||
## Our Pledge
|
## Our Pledge
|
||||||
|
|
||||||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
We as members, contributors, and leaders pledge to make participation in our
|
||||||
|
community a harassment-free experience for everyone, regardless of age, body
|
||||||
|
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||||
|
identity and expression, level of experience, education, socio-economic status,
|
||||||
|
nationality, personal appearance, race, caste, color, religion, or sexual
|
||||||
|
identity and orientation.
|
||||||
|
|
||||||
|
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||||
|
diverse, inclusive, and healthy community.
|
||||||
|
|
||||||
## Our Standards
|
## Our Standards
|
||||||
|
|
||||||
Examples of behavior that contributes to creating a positive environment include:
|
Examples of behavior that contributes to a positive environment for our
|
||||||
|
community include:
|
||||||
|
|
||||||
* Using welcoming and inclusive language
|
* Demonstrating empathy and kindness toward other people
|
||||||
* Being respectful of differing viewpoints and experiences
|
* Being respectful of differing opinions, viewpoints, and experiences
|
||||||
* Gracefully accepting constructive criticism
|
* Giving and gracefully accepting constructive feedback
|
||||||
* Focusing on what is best for the community
|
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||||
* Showing empathy towards other community members
|
and learning from the experience
|
||||||
|
* Focusing on what is best not just for us as individuals, but for the overall
|
||||||
|
community
|
||||||
|
|
||||||
Examples of unacceptable behavior by participants include:
|
Examples of unacceptable behavior include:
|
||||||
|
|
||||||
* The use of sexualized language or imagery and unwelcome sexual attention or advances
|
* The use of sexualized language or imagery, and sexual attention or advances of
|
||||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
any kind
|
||||||
|
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||||
* Public or private harassment
|
* Public or private harassment
|
||||||
* Publishing others' private information, such as a physical or electronic address, without explicit permission
|
* Publishing others' private information, such as a physical or email address,
|
||||||
* Other conduct which could reasonably be considered inappropriate in a professional setting
|
without their explicit permission
|
||||||
|
* Other conduct which could reasonably be considered inappropriate in a
|
||||||
|
professional setting
|
||||||
|
|
||||||
## Our Responsibilities
|
## Enforcement Responsibilities
|
||||||
|
|
||||||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
|
Community leaders are responsible for clarifying and enforcing our standards of
|
||||||
|
acceptable behavior and will take appropriate and fair corrective action in
|
||||||
|
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||||
|
or harmful.
|
||||||
|
|
||||||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
|
Community leaders have the right and responsibility to remove, edit, or reject
|
||||||
|
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||||
|
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||||
|
decisions when appropriate.
|
||||||
|
|
||||||
## Scope
|
## Scope
|
||||||
|
|
||||||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
|
This Code of Conduct applies within all community spaces, and also applies when
|
||||||
|
an individual is officially representing the community in public spaces.
|
||||||
|
Examples of representing our community include using an official email address,
|
||||||
|
posting via an official social media account, or acting as an appointed
|
||||||
|
representative at an online or offline event.
|
||||||
|
|
||||||
## Enforcement
|
## Enforcement
|
||||||
|
|
||||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at mail@nlohmann.me. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
|
reported to the community leaders responsible for enforcement at
|
||||||
|
[mail@nlohmann.me](mailto:mail@nlohmann.me).
|
||||||
|
All complaints will be reviewed and investigated promptly and fairly.
|
||||||
|
|
||||||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
|
All community leaders are obligated to respect the privacy and security of the
|
||||||
|
reporter of any incident.
|
||||||
|
|
||||||
|
## Enforcement Guidelines
|
||||||
|
|
||||||
|
Community leaders will follow these Community Impact Guidelines in determining
|
||||||
|
the consequences for any action they deem in violation of this Code of Conduct:
|
||||||
|
|
||||||
|
### 1. Correction
|
||||||
|
|
||||||
|
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||||
|
unprofessional or unwelcome in the community.
|
||||||
|
|
||||||
|
**Consequence**: A private, written warning from community leaders, providing
|
||||||
|
clarity around the nature of the violation and an explanation of why the
|
||||||
|
behavior was inappropriate. A public apology may be requested.
|
||||||
|
|
||||||
|
### 2. Warning
|
||||||
|
|
||||||
|
**Community Impact**: A violation through a single incident or series of
|
||||||
|
actions.
|
||||||
|
|
||||||
|
**Consequence**: A warning with consequences for continued behavior. No
|
||||||
|
interaction with the people involved, including unsolicited interaction with
|
||||||
|
those enforcing the Code of Conduct, for a specified period of time. This
|
||||||
|
includes avoiding interactions in community spaces as well as external channels
|
||||||
|
like social media. Violating these terms may lead to a temporary or permanent
|
||||||
|
ban.
|
||||||
|
|
||||||
|
### 3. Temporary Ban
|
||||||
|
|
||||||
|
**Community Impact**: A serious violation of community standards, including
|
||||||
|
sustained inappropriate behavior.
|
||||||
|
|
||||||
|
**Consequence**: A temporary ban from any sort of interaction or public
|
||||||
|
communication with the community for a specified period of time. No public or
|
||||||
|
private interaction with the people involved, including unsolicited interaction
|
||||||
|
with those enforcing the Code of Conduct, is allowed during this period.
|
||||||
|
Violating these terms may lead to a permanent ban.
|
||||||
|
|
||||||
|
### 4. Permanent Ban
|
||||||
|
|
||||||
|
**Community Impact**: Demonstrating a pattern of violation of community
|
||||||
|
standards, including sustained inappropriate behavior, harassment of an
|
||||||
|
individual, or aggression toward or disparagement of classes of individuals.
|
||||||
|
|
||||||
|
**Consequence**: A permanent ban from any sort of public interaction within the
|
||||||
|
community.
|
||||||
|
|
||||||
## Attribution
|
## Attribution
|
||||||
|
|
||||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||||
|
version 2.1, available at
|
||||||
|
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
||||||
|
|
||||||
[homepage]: http://contributor-covenant.org
|
Community Impact Guidelines were inspired by
|
||||||
[version]: http://contributor-covenant.org/version/1/4/
|
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
||||||
|
|
||||||
|
For answers to common questions about this code of conduct, see the FAQ at
|
||||||
|
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
||||||
|
[https://www.contributor-covenant.org/translations][translations].
|
||||||
|
|
||||||
|
[homepage]: https://www.contributor-covenant.org
|
||||||
|
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
||||||
|
[Mozilla CoC]: https://github.com/mozilla/diversity
|
||||||
|
[FAQ]: https://www.contributor-covenant.org/faq
|
||||||
|
[translations]: https://www.contributor-covenant.org/translations
|
||||||
|
|||||||
231
.github/CONTRIBUTING.md
vendored
231
.github/CONTRIBUTING.md
vendored
@ -1,69 +1,222 @@
|
|||||||
# How to contribute
|
# Contribution Guidelines
|
||||||
|
|
||||||
This project started as a little excuse to exercise some of the cool new C++11 features. Over time, people actually started to use the JSON library (yey!) and started to help improve it by proposing features, finding bugs, or even fixing my mistakes. I am really [thankful](https://github.com/nlohmann/json/blob/master/README.md#thanks) for this and try to keep track of all the helpers.
|
Thank you for your interest in contributing to this project! What began as an exercise to explore the exciting features
|
||||||
|
of C++11 has evolved into a [widely-used](https://json.nlohmann.me/home/customers/) JSON library. I truly appreciate all
|
||||||
|
the contributions from the community, whether it's proposing features, identifying bugs, or fixing mistakes! To ensure
|
||||||
|
that our collaboration is efficient and effective, please follow these guidelines.
|
||||||
|
|
||||||
To make it as easy as possible for you to contribute and for me to keep an overview, here are a few guidelines which should help us avoid all kinds of unnecessary work or disappointment. And of course, this document is subject to discussion, so please [create an issue](https://github.com/nlohmann/json/issues/new/choose) or a pull request if you find a way to improve it!
|
Feel free to discuss or suggest improvements to this document
|
||||||
|
[by submitting a pull request](https://github.com/nlohmann/json/edit/develop/.github/CONTRIBUTING.md).
|
||||||
|
|
||||||
## Private reports
|
## Ways to Contribute
|
||||||
|
|
||||||
Usually, all issues are tracked publicly on [GitHub](https://github.com/nlohmann/json/issues). If you want to make a private report (e.g., for a vulnerability or to attach an example that is not meant to be published), please send an email to <mail@nlohmann.me>.
|
There are multiple ways to contribute.
|
||||||
|
|
||||||
## Prerequisites
|
### Reporting an issue
|
||||||
|
|
||||||
Please [create an issue](https://github.com/nlohmann/json/issues/new/choose), assuming one does not already exist, and describe your concern. Note you need a [GitHub account](https://github.com/signup/free) for this.
|
Please [create an issue](https://github.com/nlohmann/json/issues/new/choose), assuming one does not already exist, and
|
||||||
|
describe your concern. Note you need a [GitHub account](https://github.com/signup/free) for this.
|
||||||
## Describe your issue
|
|
||||||
|
|
||||||
Clearly describe the issue:
|
Clearly describe the issue:
|
||||||
|
|
||||||
- If it is a bug, please describe how to **reproduce** it. If possible, attach a complete example which demonstrates the error. Please also state what you **expected** to happen instead of the error.
|
- If it is a bug, please describe how to **reproduce** it. If possible, attach a _complete example_ which demonstrates
|
||||||
- If you propose a change or addition, try to give an **example** how the improved code could look like or how to use it.
|
the error. Please also state what you **expected** to happen instead of the error.
|
||||||
- If you found a compilation error, please tell us which **compiler** (version and operating system) you used and paste the (relevant part of) the error messages to the ticket.
|
- If you propose a change or addition, try to give an **example** how the improved code could look like or how to use
|
||||||
|
it.
|
||||||
|
- If you found a compilation error, please tell us which **compiler** (version and operating system) you used and paste
|
||||||
|
the (relevant part of) the error messages to the ticket.
|
||||||
|
|
||||||
Please stick to the provided issue template ([bug report](https://github.com/nlohmann/json/blob/develop/.github/ISSUE_TEMPLATE/bug.yaml) if possible. For questions, feature or support requests, please [open a discussion](https://github.com/nlohmann/json/discussions/new).
|
Please stick to the provided issue template
|
||||||
|
[bug report](https://github.com/nlohmann/json/blob/develop/.github/ISSUE_TEMPLATE/bug.yaml) if possible.
|
||||||
|
|
||||||
## Files to change
|
### Reporting a security vulnerability
|
||||||
|
|
||||||
:exclamation: Before you make any changes, note the single-header files [`single_include/nlohmann/json.hpp`](https://github.com/nlohmann/json/blob/develop/single_include/nlohmann/json.hpp) and [`single_include/nlohmann/json_fwd.hpp`](https://github.com/nlohmann/json/blob/develop/single_include/nlohmann/json_fwd.hpp) are **generated** from the source files in the [`include/nlohmann` directory](https://github.com/nlohmann/json/tree/develop/include/nlohmann). Please **do not** edit the files `single_include/nlohmann/json.hpp` and `single_include/nlohmann/json_fwd.hpp` directly, but change the `include/nlohmann` sources and regenerate the files by executing `make amalgamate`.
|
You can report a security vulnerability according to our
|
||||||
|
[security policy](https://github.com/nlohmann/json/security/policy).
|
||||||
|
|
||||||
To make changes, you need to edit the following files:
|
### Discussing a new feature
|
||||||
|
|
||||||
1. [`include/nlohmann/*`](https://github.com/nlohmann/json/tree/develop/include/nlohmann) - These files are the sources of the library. Before testing or creating a pull request, execute `make amalgamate` to regenerate `single_include/nlohmann/json.hpp` and `single_include/nlohmann/json_fwd.hpp`.
|
For questions, feature or support requests, please
|
||||||
|
[open a discussion](https://github.com/nlohmann/json/discussions/new). If you find a proposed answer satisfactory,
|
||||||
|
please use the "Mark as answer" button to make it easier for readers to see what helped and for the community to filter
|
||||||
|
for open questions.
|
||||||
|
|
||||||
2. [`tests/src/unit-*.cpp`](https://github.com/nlohmann/json/tree/develop/tests/src) - These files contain the [doctest](https://github.com/onqtam/doctest) unit tests which currently cover [100 %](https://coveralls.io/github/nlohmann/json) of the library's code. Before creating a pull request, execute `make pretty` to make sure that the style is correct, as this will be checked by the CI.
|
### Proposing a fix or an improvement
|
||||||
|
|
||||||
If you add or change a feature, please also add a unit test to this file. The unit tests can be compiled and executed with
|
Join an ongoing discussion or comment on an existing issue before starting to code. This can help to avoid duplicate
|
||||||
|
efforts or other frustration during the later review.
|
||||||
|
|
||||||
|
Create a [pull request](https://github.com/nlohmann/json/pulls?q=sort%3Aupdated-desc+is%3Apr+is%3Aopen) against the
|
||||||
|
`develop` branch and follow the pull request template. In particular,
|
||||||
|
|
||||||
|
- describe the changes in detail, both the what and why,
|
||||||
|
- reference existing issues where applicable,
|
||||||
|
- add tests to maintain 100% test coverage,
|
||||||
|
- update the documentation as needed, and
|
||||||
|
- ensure the source code is amalgamated.
|
||||||
|
|
||||||
|
We describe all points in detail below.
|
||||||
|
|
||||||
|
All contributions (including pull requests) must agree to the
|
||||||
|
[Developer Certificate of Origin (DCO) version 1.1](https://developercertificate.org). This is exactly the same one
|
||||||
|
created and used by the Linux kernel developers and posted on http://developercertificate.org/. This is a developer's
|
||||||
|
certification that he or she has the right to submit the patch for inclusion into the project.
|
||||||
|
|
||||||
|
## How to...
|
||||||
|
|
||||||
|
### Describe your changes
|
||||||
|
|
||||||
|
This library is primarily maintained as a spare-time project. As such, I can not make any guarantee how quickly changes
|
||||||
|
are merged and released. Therefore, it is very important to make the review as smooth as possible by explaining not only
|
||||||
|
_what_ you changed, but _why_. This rationale can be very valuable down the road when improvements or bugs are discussed
|
||||||
|
years later.
|
||||||
|
|
||||||
|
### Reference existing issues
|
||||||
|
|
||||||
|
[Link a pull request to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue)
|
||||||
|
to clarify that a fix is forthcoming and which issue can be closed after merging. Only few cases (e.g., fixing typos)
|
||||||
|
don’t require prior discussions.
|
||||||
|
|
||||||
|
### Write tests
|
||||||
|
|
||||||
|
The library has an extensive test suite that currently covers [100 %](https://coveralls.io/github/nlohmann/json) of the
|
||||||
|
library's code. These test are crucial to maintain API stability and give future contributors confidence that they do
|
||||||
|
not accidentally break things. As Titus Winters aptly put it:
|
||||||
|
|
||||||
|
> If you liked it, you should have put a test on it.
|
||||||
|
|
||||||
|
#### Run the tests
|
||||||
|
|
||||||
|
First, ensure the test suite runs before making any changes:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
$ mkdir build
|
$ cmake -S. -B build
|
||||||
$ cd build
|
$ cmake --build build -j 10
|
||||||
$ cmake ..
|
$ ctest --test-dir build -j 10
|
||||||
$ cmake --build .
|
|
||||||
$ ctest
|
|
||||||
```
|
```
|
||||||
|
|
||||||
The test cases are also executed with several different compilers on [Travis](https://travis-ci.org/nlohmann/json) once you open a pull request.
|
The test suite should report:
|
||||||
|
|
||||||
|
```
|
||||||
|
100% tests passed, 0 tests failed out of 98
|
||||||
|
```
|
||||||
|
|
||||||
## Note
|
#### Add tests
|
||||||
|
|
||||||
- If you open a pull request, the code will be automatically tested with [Valgrind](http://valgrind.org)'s Memcheck tool to detect memory leaks. Please be aware that the execution with Valgrind _may_ in rare cases yield different behavior than running the code directly. This can result in failing unit tests which run successfully without Valgrind.
|
The tests are located in [`tests/src/unit-*.cpp`](https://github.com/nlohmann/json/tree/develop/tests/src) and contain
|
||||||
- There is a Makefile target `make pretty` which runs [Artistic Style](http://astyle.sourceforge.net) to fix indentation. If possible, run it before opening the pull request. Otherwise, we shall run it afterward.
|
[doctest assertions](https://github.com/doctest/doctest/blob/master/doc/markdown/assertions.md) like `CHECK`. The tests
|
||||||
|
are structured along the features of the library or the nature of the tests. Usually, it should be clear from the
|
||||||
|
context which existing file needs to be extended, and only very few cases require creating new test files.
|
||||||
|
|
||||||
## Please don't
|
When fixing a bug, edit `unit-regression2.cpp` and add a section referencing the fixed issue.
|
||||||
|
|
||||||
- The C++11 support varies between different **compilers** and versions. Please note the [list of supported compilers](https://github.com/nlohmann/json/blob/master/README.md#supported-compilers). Some compilers like GCC 4.7 (and earlier), Clang 3.3 (and earlier), or Microsoft Visual Studio 13.0 and earlier are known not to work due to missing or incomplete C++11 support. Please refrain from proposing changes that work around these compiler's limitations with `#ifdef`s or other means.
|
#### Exceptions
|
||||||
- Specifically, I am aware of compilation problems with **Microsoft Visual Studio** (there even is an [issue label](https://github.com/nlohmann/json/issues?utf8=✓&q=label%3A%22visual+studio%22+) for this kind of bug). I understand that even in 2016, complete C++11 support isn't there yet. But please also understand that I do not want to drop features or uglify the code just to make Microsoft's sub-standard compiler happy. The past has shown that there are ways to express the functionality such that the code compiles with the most recent MSVC - unfortunately, this is not the main objective of the project.
|
|
||||||
- Please refrain from proposing changes that would **break [JSON](https://json.org) conformance**. If you propose a conformant extension of JSON to be supported by the library, please motivate this extension.
|
|
||||||
- We shall not extend the library to **support comments**. There is quite some [controversy](https://www.reddit.com/r/programming/comments/4v6chu/why_json_doesnt_support_comments_douglas_crockford/) around this topic, and there were quite some [issues](https://github.com/nlohmann/json/issues/376) on this. We believe that JSON is fine without comments.
|
|
||||||
- We do not preserve the **insertion order of object elements**. The [JSON standard](https://tools.ietf.org/html/rfc8259.html) defines objects as "an unordered collection of zero or more name/value pairs". To this end, this library does not preserve insertion order of name/value pairs. (In fact, keys will be traversed in alphabetical order as `std::map` with `std::less` is used by default.) Note this behavior conforms to the standard, and we shall not change it to any other order. If you do want to preserve the insertion order, you can specialize the object type with containers like [`tsl::ordered_map`](https://github.com/Tessil/ordered-map) or [`nlohmann::fifo_map`](https://github.com/nlohmann/fifo_map).
|
|
||||||
|
|
||||||
- Please do not open pull requests that address **multiple issues**.
|
When you test exceptions, please use `CHECK_THROWS_WITH_AS` which also takes the `what()` argument of the thrown
|
||||||
|
exception into account.
|
||||||
|
|
||||||
|
#### Coverage
|
||||||
|
|
||||||
|
If test coverage decreases, an automatic warning comment will be posted on the pull request. You can access a code
|
||||||
|
coverage report as artifact to the “Ubuntu” workflow.
|
||||||
|
|
||||||
|
### Update the documentation
|
||||||
|
|
||||||
|
The [main documentation](https://json.nlohmann.me) of the library is generated from the files
|
||||||
|
[`docs/mkdocs/docs`](https://github.com/nlohmann/json/blob/develop/docs/mkdocs/docs). This folder contains dedicated
|
||||||
|
pages for [certain features](https://github.com/nlohmann/json/tree/develop/docs/mkdocs/docs/features), a list of
|
||||||
|
[all exceptions](https://github.com/nlohmann/json/blob/develop/docs/mkdocs/docs/home/exceptions.md), and an
|
||||||
|
[extensive API documentation](https://github.com/nlohmann/json/tree/develop/docs/mkdocs/docs/api) with details on every
|
||||||
|
public API function.
|
||||||
|
|
||||||
|
Build the documentation locally using:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
make install_venv -C docs/mkdocs
|
||||||
|
make serve -C docs/mkdocs
|
||||||
|
```
|
||||||
|
|
||||||
|
The documentation will then available at <http://127.0.0.1:8000/>. See the documentation of
|
||||||
|
[mkdocs](https://www.mkdocs.org) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) for more
|
||||||
|
information.
|
||||||
|
|
||||||
|
### Amalgamate the source code
|
||||||
|
|
||||||
|
The single-header files
|
||||||
|
[`single_include/nlohmann/json.hpp`](https://github.com/nlohmann/json/blob/develop/single_include/nlohmann/json.hpp) and
|
||||||
|
[`single_include/nlohmann/json_fwd.hpp`](https://github.com/nlohmann/json/blob/develop/single_include/nlohmann/json_fwd.hpp)
|
||||||
|
are **generated** from the source files in the
|
||||||
|
[`include/nlohmann` directory](https://github.com/nlohmann/json/tree/develop/include/nlohmann). **Do not** edit the
|
||||||
|
files directly; instead, modify the include/nlohmann sources and regenerate the files by executing:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
make amalgamate
|
||||||
|
```
|
||||||
|
|
||||||
|
## Recommended documentation
|
||||||
|
|
||||||
|
- The library’s [README file](https://github.com/nlohmann/json/blob/master/README.md) is an excellent starting point to
|
||||||
|
understand its functionality.
|
||||||
|
- The [documentation page](https://json.nlohmann.me) is the reference documentation of the library.
|
||||||
|
- [RFC 8259](https://datatracker.ietf.org/doc/html/rfc8259) is the reference for the JavaScript Object Notation (JSON)
|
||||||
|
Data Interchange Format.
|
||||||
|
|
||||||
|
## Please don't...
|
||||||
|
|
||||||
|
Certain contributions are not helpful.
|
||||||
|
|
||||||
|
### Break the public API
|
||||||
|
|
||||||
|
We take pride in the library being used by
|
||||||
|
[numerous customers across various industries](https://json.nlohmann.me/home/customers/). They all rely on the
|
||||||
|
guarantees provided by [semantic versioning](https://semver.org). Please do not change the library such that the public
|
||||||
|
API of the 3.x.y version is broken. This includes:
|
||||||
|
|
||||||
|
- Changing function signatures (altering parameter types, return types, number of parameters) or changing the const-ness
|
||||||
|
of member functions.
|
||||||
|
- Removing functions.
|
||||||
|
- Renaming functions or classes.
|
||||||
|
- Changing exception handling.
|
||||||
|
- Changing exception ids.
|
||||||
|
- Changing access specifiers.
|
||||||
|
- Changing default arguments.
|
||||||
|
|
||||||
|
Although these guidelines may seem restrictive, they are essential for maintaining the library’s utility.
|
||||||
|
|
||||||
|
Breaking changes may be introduced when they are guarded with a feature macro such as
|
||||||
|
[`JSON_USE_IMPLICIT_CONVERSIONS`](https://json.nlohmann.me/api/macros/json_use_implicit_conversions/) which allows to
|
||||||
|
selectively change the behavior of the library. In next steps, the current behavior can then be deprecated. Using
|
||||||
|
feature macros then allows users to test their code against the library in the next major release.
|
||||||
|
|
||||||
|
### Break C++11 language conformance
|
||||||
|
|
||||||
|
This library is designed to work with C++11 and later. This means that any
|
||||||
|
[supported C++11 compiler](https://github.com/nlohmann/json/blob/master/README.md#supported-compilers) should compile
|
||||||
|
the library without problems. Some compilers like GCC 4.7 (and earlier), Clang 3.3 (and earlier), or Microsoft Visual
|
||||||
|
Studio 13.0 and earlier are known not to work due to missing or incomplete C++11 support.
|
||||||
|
|
||||||
|
Please do not add features that do not work with the mentioned supported compilers. Please guard features from C++14 and
|
||||||
|
later against the respective [`JSON_HAS_CPP_14`](https://json.nlohmann.me/api/macros/json_has_cpp_11/) macros.
|
||||||
|
|
||||||
|
### Break JSON conformance
|
||||||
|
|
||||||
|
Please refrain from proposing changes that would **break [JSON](https://datatracker.ietf.org/doc/html/rfc8259)
|
||||||
|
conformance**. If you propose a conformant extension of JSON to be supported by the library, please motivate this
|
||||||
|
extension.
|
||||||
|
|
||||||
## Wanted
|
## Wanted
|
||||||
|
|
||||||
The following areas really need contribution:
|
The following areas really need contribution and are always welcomed:
|
||||||
|
|
||||||
- Extending the **continuous integration** toward more exotic compilers such as Android NDK, Intel's Compiler, or the bleeding-edge versions Clang.
|
- Extending the **continuous integration** toward more exotic compilers such as Android NDK, Intel's Compiler, or the
|
||||||
- Improving the efficiency of the **JSON parser**. The current parser is implemented as a naive recursive descent parser with hand coded string handling. More sophisticated approaches like LALR parsers would be really appreciated. That said, parser generators like Bison or ANTLR do not play nice with single-header files -- I really would like to keep the parser inside the `json.hpp` header, and I am not aware of approaches similar to [`re2c`](http://re2c.org) for parsing.
|
bleeding-edge versions Clang.
|
||||||
- Extending and updating existing **benchmarks** to include (the most recent version of) this library. Though efficiency is not everything, speed and memory consumption are very important characteristics for C++ developers, so having proper comparisons would be interesting.
|
- Improving the efficiency of the **JSON parser**. The current parser is implemented as a naive recursive descent parser
|
||||||
|
with hand coded string handling. More sophisticated approaches like LALR parsers would be really appreciated. That
|
||||||
|
said, parser generators like Bison or ANTLR do not play nice with single-header files -- I really would like to keep
|
||||||
|
the parser inside the `json.hpp` header, and I am not aware of approaches similar to [`re2c`](http://re2c.org) for
|
||||||
|
parsing.
|
||||||
|
- Extending and updating existing **benchmarks** to include (the most recent version of) this library. Though efficiency
|
||||||
|
is not everything, speed and memory consumption are very important characteristics for C++ developers, so having
|
||||||
|
proper comparisons would be interesting.
|
||||||
|
|
||||||
|
We look forward to your contributions and collaboration to enhance the library!
|
||||||
|
|||||||
2
.github/FUNDING.yml
vendored
2
.github/FUNDING.yml
vendored
@ -1,2 +1,2 @@
|
|||||||
github: nlohmann
|
github: nlohmann
|
||||||
custom: http://paypal.me/nlohmann
|
custom: https://paypal.me/nlohmann
|
||||||
|
|||||||
2
.github/ISSUE_TEMPLATE/bug.yaml
vendored
2
.github/ISSUE_TEMPLATE/bug.yaml
vendored
@ -13,7 +13,7 @@ body:
|
|||||||
|
|
||||||
Note that this form is for bug reports only. Please
|
Note that this form is for bug reports only. Please
|
||||||
[open a discussion](https://github.com/nlohmann/json/discussions/new)
|
[open a discussion](https://github.com/nlohmann/json/discussions/new)
|
||||||
for questions, feature requests, or support requests
|
for questions, feature requests, or support requests.
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: summary
|
id: summary
|
||||||
attributes:
|
attributes:
|
||||||
|
|||||||
20
.github/PULL_REQUEST_TEMPLATE.md
vendored
20
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -1,19 +1,9 @@
|
|||||||
[Describe your pull request here. Please read the text below the line, and make sure you follow the checklist.]
|
[Describe your pull request here. Please read the text below the line, and make sure you follow the checklist.]
|
||||||
|
|
||||||
* * *
|
- [ ] The changes are described in detail, both the what and why.
|
||||||
|
- [ ] If applicable, an [existing issue](https://github.com/nlohmann/json/issues) is referenced.
|
||||||
## Pull request checklist
|
- [ ] The [Code coverage](https://coveralls.io/github/nlohmann/json) remained at 100%. A test case for every new line of code.
|
||||||
|
- [ ] If applicable, the [documentation](https://json.nlohmann.me) is updated.
|
||||||
|
- [ ] The source code is amalgamated by running `make amalgamate`.
|
||||||
|
|
||||||
Read the [Contribution Guidelines](https://github.com/nlohmann/json/blob/develop/.github/CONTRIBUTING.md) for detailed information.
|
Read the [Contribution Guidelines](https://github.com/nlohmann/json/blob/develop/.github/CONTRIBUTING.md) for detailed information.
|
||||||
|
|
||||||
- [ ] Changes are described in the pull request, or an [existing issue is referenced](https://github.com/nlohmann/json/issues).
|
|
||||||
- [ ] The test suite [compiles and runs](https://github.com/nlohmann/json/blob/develop/README.md#execute-unit-tests) without error.
|
|
||||||
- [ ] [Code coverage](https://coveralls.io/github/nlohmann/json) is 100%. Test cases can be added by editing the [test suite](https://github.com/nlohmann/json/tree/develop/test/src).
|
|
||||||
- [ ] The source code is amalgamated; that is, after making changes to the sources in the `include/nlohmann` directory, run `make amalgamate` to create the single-header files `single_include/nlohmann/json.hpp` and `single_include/nlohmann/json_fwd.hpp`. The whole process is described [here](https://github.com/nlohmann/json/blob/develop/.github/CONTRIBUTING.md#files-to-change).
|
|
||||||
|
|
||||||
## Please don't
|
|
||||||
|
|
||||||
- The C++11 support varies between different **compilers** and versions. Please note the [list of supported compilers](https://github.com/nlohmann/json/blob/master/README.md#supported-compilers). Some compilers like GCC 4.7 (and earlier), Clang 3.3 (and earlier), or Microsoft Visual Studio 13.0 and earlier are known not to work due to missing or incomplete C++11 support. Please refrain from proposing changes that work around these compiler's limitations with `#ifdef`s or other means.
|
|
||||||
- Specifically, I am aware of compilation problems with **Microsoft Visual Studio** (there even is an [issue label](https://github.com/nlohmann/json/issues?utf8=✓&q=label%3A%22visual+studio%22+) for this kind of bug). I understand that even in 2016, complete C++11 support isn't there yet. But please also understand that I do not want to drop features or uglify the code just to make Microsoft's sub-standard compiler happy. The past has shown that there are ways to express the functionality such that the code compiles with the most recent MSVC - unfortunately, this is not the main objective of the project.
|
|
||||||
- Please refrain from proposing changes that would **break [JSON](https://json.org) conformance**. If you propose a conformant extension of JSON to be supported by the library, please motivate this extension.
|
|
||||||
- Please do not open pull requests that address **multiple issues**.
|
|
||||||
|
|||||||
22
.github/SECURITY.md
vendored
22
.github/SECURITY.md
vendored
@ -2,4 +2,24 @@
|
|||||||
|
|
||||||
## Reporting a Vulnerability
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
Usually, all issues are tracked publicly on [GitHub](https://github.com/nlohmann/json/issues). If you want to make a private report (e.g., for a vulnerability or to attach an example that is not meant to be published), please send an email to <mail@nlohmann.me>. You can use [this key](https://keybase.io/nlohmann/pgp_keys.asc?fingerprint=797167ae41c0a6d9232e48457f3cea63ae251b69) for encryption.
|
We value the security of our users and appreciate your efforts to responsibly disclose vulnerabilities. If you have
|
||||||
|
identified a security vulnerability in this repository, please use the GitHub Security Advisory
|
||||||
|
["Report a Vulnerability"](https://github.com/nlohmann/json/security/advisories/new) tab.
|
||||||
|
|
||||||
|
Until it is published, this draft security advisory will only be visible to the maintainers of this project. Other
|
||||||
|
users and teams may be added once the advisory is created.
|
||||||
|
|
||||||
|
We will send a response indicating the next steps in handling your report. After the initial reply to your report, we
|
||||||
|
will keep you informed of the progress towards a fix and full announcement and may ask for additional information or
|
||||||
|
guidance.
|
||||||
|
|
||||||
|
For vulnerabilities in third-party dependencies or modules, please report them directly to the respective maintainers.
|
||||||
|
|
||||||
|
## Additional Resources
|
||||||
|
|
||||||
|
- Explore security-related topics and contribute to tools and projects through
|
||||||
|
[GitHub Security Lab](https://securitylab.github.com/).
|
||||||
|
- Learn more about responsible disclosure and reporting vulnerabilities in GitHub at
|
||||||
|
[About coordinated disclosure of security vulnerabilities](https://docs.github.com/en/code-security/repository-security-advisories/about-coordinated-disclosure-of-security-vulnerabilities).
|
||||||
|
|
||||||
|
We sincerely thank you for contributing to the security and integrity of this project!
|
||||||
|
|||||||
5
.github/config.yml
vendored
5
.github/config.yml
vendored
@ -6,7 +6,7 @@ sentimentBotToxicityThreshold: .7
|
|||||||
|
|
||||||
# *Required* Comment to reply with
|
# *Required* Comment to reply with
|
||||||
sentimentBotReplyComment: >
|
sentimentBotReplyComment: >
|
||||||
Please be sure to review the [code of conduct](https://github.com/nlohmann/json/blob/develop/CODE_OF_CONDUCT.md) and be respectful of other users. cc/ @nlohmann
|
Please be sure to review the [code of conduct](https://github.com/nlohmann/json/blob/develop/.github/CODE_OF_CONDUCT.md) and be respectful of other users. cc/ @nlohmann
|
||||||
|
|
||||||
|
|
||||||
# Configuration for request-info - https://github.com/behaviorbot/request-info
|
# Configuration for request-info - https://github.com/behaviorbot/request-info
|
||||||
@ -17,3 +17,6 @@ requestInfoReplyComment: >
|
|||||||
|
|
||||||
# *OPTIONAL* Label to be added to Issues and Pull Requests with insufficient information given
|
# *OPTIONAL* Label to be added to Issues and Pull Requests with insufficient information given
|
||||||
requestInfoLabelToAdd: "state: needs more info"
|
requestInfoLabelToAdd: "state: needs more info"
|
||||||
|
|
||||||
|
checkIssueTemplate: true
|
||||||
|
checkPullRequestTemplate: true
|
||||||
|
|||||||
31
.github/dependabot.yml
vendored
Normal file
31
.github/dependabot.yml
vendored
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
version: 2
|
||||||
|
updates:
|
||||||
|
- package-ecosystem: github-actions
|
||||||
|
directory: /
|
||||||
|
schedule:
|
||||||
|
interval: daily
|
||||||
|
|
||||||
|
- package-ecosystem: pip
|
||||||
|
directory: /docs/mkdocs
|
||||||
|
schedule:
|
||||||
|
interval: daily
|
||||||
|
|
||||||
|
- package-ecosystem: pip
|
||||||
|
directory: /tools/astyle
|
||||||
|
schedule:
|
||||||
|
interval: daily
|
||||||
|
|
||||||
|
- package-ecosystem: pip
|
||||||
|
directory: /tools/generate_natvis
|
||||||
|
schedule:
|
||||||
|
interval: daily
|
||||||
|
|
||||||
|
- package-ecosystem: pip
|
||||||
|
directory: /tools/serve_header
|
||||||
|
schedule:
|
||||||
|
interval: daily
|
||||||
|
|
||||||
|
- package-ecosystem: pip
|
||||||
|
directory: /cmake/requirements
|
||||||
|
schedule:
|
||||||
|
interval: daily
|
||||||
17
.github/stale.yml
vendored
17
.github/stale.yml
vendored
@ -1,17 +0,0 @@
|
|||||||
# Number of days of inactivity before an issue becomes stale
|
|
||||||
daysUntilStale: 30
|
|
||||||
# Number of days of inactivity before a stale issue is closed
|
|
||||||
daysUntilClose: 7
|
|
||||||
# Issues with these labels will never be considered stale
|
|
||||||
exemptLabels:
|
|
||||||
- pinned
|
|
||||||
- security
|
|
||||||
# Label to use when marking an issue as stale
|
|
||||||
staleLabel: "state: stale"
|
|
||||||
# Comment to post when marking an issue as stale. Set to `false` to disable
|
|
||||||
markComment: >
|
|
||||||
This issue has been automatically marked as stale because it has not had
|
|
||||||
recent activity. It will be closed if no further activity occurs. Thank you
|
|
||||||
for your contributions.
|
|
||||||
# Comment to post when closing a stale issue. Set to `false` to disable
|
|
||||||
closeComment: false
|
|
||||||
32
.github/workflows/check_amalgamation.yml
vendored
32
.github/workflows/check_amalgamation.yml
vendored
@ -3,18 +3,24 @@ name: "Check amalgamation"
|
|||||||
on:
|
on:
|
||||||
pull_request:
|
pull_request:
|
||||||
|
|
||||||
permissions: read-all
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
save:
|
save:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
|
- name: Harden Runner
|
||||||
|
uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
|
||||||
|
with:
|
||||||
|
egress-policy: audit
|
||||||
|
|
||||||
- name: Save PR number
|
- name: Save PR number
|
||||||
run: |
|
run: |
|
||||||
mkdir -p ./pr
|
mkdir -p ./pr
|
||||||
echo ${{ github.event.number }} > ./pr/number
|
echo ${{ github.event.number }} > ./pr/number
|
||||||
echo ${{ github.event.pull_request.user.login }} > ./pr/author
|
echo ${{ github.event.pull_request.user.login }} > ./pr/author
|
||||||
- uses: actions/upload-artifact@v4
|
- uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
|
||||||
with:
|
with:
|
||||||
name: pr
|
name: pr
|
||||||
path: pr/
|
path: pr/
|
||||||
@ -25,29 +31,29 @@ jobs:
|
|||||||
MAIN_DIR: ${{ github.workspace }}/main
|
MAIN_DIR: ${{ github.workspace }}/main
|
||||||
INCLUDE_DIR: ${{ github.workspace }}/main/single_include/nlohmann
|
INCLUDE_DIR: ${{ github.workspace }}/main/single_include/nlohmann
|
||||||
TOOL_DIR: ${{ github.workspace }}/tools/tools/amalgamate
|
TOOL_DIR: ${{ github.workspace }}/tools/tools/amalgamate
|
||||||
ASTYLE_FLAGS: >
|
|
||||||
--style=allman --indent=spaces=4 --indent-modifiers --indent-switches --indent-preproc-block
|
|
||||||
--indent-preproc-define --indent-col1-comments --pad-oper --pad-header --align-pointer=type
|
|
||||||
--align-reference=type --add-brackets --convert-tabs --close-templates --lineend=linux --preserve-date
|
|
||||||
--formatted
|
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
|
- name: Harden Runner
|
||||||
|
uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
|
||||||
|
with:
|
||||||
|
egress-policy: audit
|
||||||
|
|
||||||
- name: Checkout pull request
|
- name: Checkout pull request
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
with:
|
with:
|
||||||
path: main
|
path: main
|
||||||
ref: ${{ github.event.pull_request.head.sha }}
|
ref: ${{ github.event.pull_request.head.sha }}
|
||||||
|
|
||||||
- name: Checkout tools
|
- name: Checkout tools
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
with:
|
with:
|
||||||
path: tools
|
path: tools
|
||||||
ref: develop
|
ref: develop
|
||||||
|
|
||||||
- name: Install astyle
|
- name: Install astyle
|
||||||
run: |
|
run: |
|
||||||
sudo apt-get update
|
python3 -mvenv venv
|
||||||
sudo apt-get install astyle
|
venv/bin/pip3 install -r $MAIN_DIR/tools/astyle/requirements.txt
|
||||||
|
|
||||||
- name: Check amalgamation
|
- name: Check amalgamation
|
||||||
run: |
|
run: |
|
||||||
@ -60,11 +66,11 @@ jobs:
|
|||||||
python3 $TOOL_DIR/amalgamate.py -c $TOOL_DIR/config_json.json -s .
|
python3 $TOOL_DIR/amalgamate.py -c $TOOL_DIR/config_json.json -s .
|
||||||
python3 $TOOL_DIR/amalgamate.py -c $TOOL_DIR/config_json_fwd.json -s .
|
python3 $TOOL_DIR/amalgamate.py -c $TOOL_DIR/config_json_fwd.json -s .
|
||||||
echo "Format (1)"
|
echo "Format (1)"
|
||||||
astyle $ASTYLE_FLAGS --suffix=none --quiet $INCLUDE_DIR/json.hpp $INCLUDE_DIR/json_fwd.hpp
|
${{ github.workspace }}/venv/bin/astyle --project=tools/astyle/.astylerc --suffix=none --quiet $INCLUDE_DIR/json.hpp $INCLUDE_DIR/json_fwd.hpp
|
||||||
|
|
||||||
diff $INCLUDE_DIR/json.hpp~ $INCLUDE_DIR/json.hpp
|
diff $INCLUDE_DIR/json.hpp~ $INCLUDE_DIR/json.hpp
|
||||||
diff $INCLUDE_DIR/json_fwd.hpp~ $INCLUDE_DIR/json_fwd.hpp
|
diff $INCLUDE_DIR/json_fwd.hpp~ $INCLUDE_DIR/json_fwd.hpp
|
||||||
|
|
||||||
astyle $ASTYLE_FLAGS $(find docs/examples include tests -type f \( -name '*.hpp' -o -name '*.cpp' -o -name '*.cu' \) -not -path 'tests/thirdparty/*' -not -path 'tests/abi/include/nlohmann/*' | sort)
|
${{ github.workspace }}/venv/bin/astyle --project=tools/astyle/.astylerc --suffix=orig $(find docs/examples include tests -type f \( -name '*.hpp' -o -name '*.cpp' -o -name '*.cu' \) -not -path 'tests/thirdparty/*' -not -path 'tests/abi/include/nlohmann/*' | sort)
|
||||||
echo Check
|
echo Check
|
||||||
find $MAIN_DIR -name '*.orig' -exec false {} \+
|
find $MAIN_DIR -name '*.orig' -exec false {} \+
|
||||||
|
|||||||
11
.github/workflows/cifuzz.yml
vendored
11
.github/workflows/cifuzz.yml
vendored
@ -8,22 +8,27 @@ jobs:
|
|||||||
Fuzzing:
|
Fuzzing:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
|
- name: Harden Runner
|
||||||
|
uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
|
||||||
|
with:
|
||||||
|
egress-policy: audit
|
||||||
|
|
||||||
- name: Build Fuzzers
|
- name: Build Fuzzers
|
||||||
id: build
|
id: build
|
||||||
uses: google/oss-fuzz/infra/cifuzz/actions/build_fuzzers@master
|
uses: google/oss-fuzz/infra/cifuzz/actions/build_fuzzers@57fe4475324c5506adbfecdcdd2917f65c86ee9e # master
|
||||||
with:
|
with:
|
||||||
oss-fuzz-project-name: 'json'
|
oss-fuzz-project-name: 'json'
|
||||||
dry-run: false
|
dry-run: false
|
||||||
language: c++
|
language: c++
|
||||||
- name: Run Fuzzers
|
- name: Run Fuzzers
|
||||||
uses: google/oss-fuzz/infra/cifuzz/actions/run_fuzzers@master
|
uses: google/oss-fuzz/infra/cifuzz/actions/run_fuzzers@57fe4475324c5506adbfecdcdd2917f65c86ee9e # master
|
||||||
with:
|
with:
|
||||||
oss-fuzz-project-name: 'json'
|
oss-fuzz-project-name: 'json'
|
||||||
fuzz-seconds: 300
|
fuzz-seconds: 300
|
||||||
dry-run: false
|
dry-run: false
|
||||||
language: c++
|
language: c++
|
||||||
- name: Upload Crash
|
- name: Upload Crash
|
||||||
uses: actions/upload-artifact@v4
|
uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
|
||||||
if: failure() && steps.build.outcome == 'success'
|
if: failure() && steps.build.outcome == 'success'
|
||||||
with:
|
with:
|
||||||
name: artifacts
|
name: artifacts
|
||||||
|
|||||||
19
.github/workflows/codeql-analysis.yml
vendored
19
.github/workflows/codeql-analysis.yml
vendored
@ -11,13 +11,13 @@ on:
|
|||||||
- cron: '0 19 * * 1'
|
- cron: '0 19 * * 1'
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
concurrency:
|
concurrency:
|
||||||
group: ${{ github.workflow }}-${{ github.ref || github.run_id }}
|
group: ${{ github.workflow }}-${{ github.ref || github.run_id }}
|
||||||
cancel-in-progress: true
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
CodeQL-Build:
|
CodeQL-Build:
|
||||||
|
|
||||||
@ -26,19 +26,24 @@ jobs:
|
|||||||
security-events: write
|
security-events: write
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
|
- name: Harden Runner
|
||||||
|
uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
|
||||||
|
with:
|
||||||
|
egress-policy: audit
|
||||||
|
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
|
|
||||||
# Initializes the CodeQL tools for scanning.
|
# Initializes the CodeQL tools for scanning.
|
||||||
- name: Initialize CodeQL
|
- name: Initialize CodeQL
|
||||||
uses: github/codeql-action/init@v3
|
uses: github/codeql-action/init@b56ba49b26e50535fa1e7f7db0f4f7b4bf65d80d # v3.28.10
|
||||||
with:
|
with:
|
||||||
languages: c-cpp
|
languages: c-cpp
|
||||||
|
|
||||||
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
|
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
|
||||||
# If this step fails, then you should remove it and run the build manually (see below)
|
# If this step fails, then you should remove it and run the build manually (see below)
|
||||||
- name: Autobuild
|
- name: Autobuild
|
||||||
uses: github/codeql-action/autobuild@v2
|
uses: github/codeql-action/autobuild@b56ba49b26e50535fa1e7f7db0f4f7b4bf65d80d # v3.28.10
|
||||||
|
|
||||||
- name: Perform CodeQL Analysis
|
- name: Perform CodeQL Analysis
|
||||||
uses: github/codeql-action/analyze@v2
|
uses: github/codeql-action/analyze@b56ba49b26e50535fa1e7f7db0f4f7b4bf65d80d # v3.28.10
|
||||||
|
|||||||
12
.github/workflows/comment_check_amalgamation.yml
vendored
12
.github/workflows/comment_check_amalgamation.yml
vendored
@ -5,7 +5,8 @@ on:
|
|||||||
types:
|
types:
|
||||||
- completed
|
- completed
|
||||||
|
|
||||||
permissions: {}
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
comment:
|
comment:
|
||||||
@ -17,8 +18,13 @@ jobs:
|
|||||||
issues: read
|
issues: read
|
||||||
pull-requests: write
|
pull-requests: write
|
||||||
steps:
|
steps:
|
||||||
|
- name: Harden Runner
|
||||||
|
uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
|
||||||
|
with:
|
||||||
|
egress-policy: audit
|
||||||
|
|
||||||
- name: 'Download artifact'
|
- name: 'Download artifact'
|
||||||
uses: actions/github-script@98814c53be79b1d30f795b907e553d8679345975 # v6.4.0
|
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
|
||||||
with:
|
with:
|
||||||
script: |
|
script: |
|
||||||
var artifacts = await github.rest.actions.listWorkflowRunArtifacts({
|
var artifacts = await github.rest.actions.listWorkflowRunArtifacts({
|
||||||
@ -40,7 +46,7 @@ jobs:
|
|||||||
- run: unzip pr.zip
|
- run: unzip pr.zip
|
||||||
|
|
||||||
- name: 'Comment on PR'
|
- name: 'Comment on PR'
|
||||||
uses: actions/github-script@98814c53be79b1d30f795b907e553d8679345975 # v6.4.0
|
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
|
||||||
with:
|
with:
|
||||||
github-token: ${{ secrets.GITHUB_TOKEN }}
|
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
script: |
|
script: |
|
||||||
|
|||||||
27
.github/workflows/dependency-review.yml
vendored
Normal file
27
.github/workflows/dependency-review.yml
vendored
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
# Dependency Review Action
|
||||||
|
#
|
||||||
|
# This Action will scan dependency manifest files that change as part of a Pull Request,
|
||||||
|
# surfacing known-vulnerable versions of the packages declared or updated in the PR.
|
||||||
|
# Once installed, if the workflow run is marked as required,
|
||||||
|
# PRs introducing known-vulnerable packages will be blocked from merging.
|
||||||
|
#
|
||||||
|
# Source repository: https://github.com/actions/dependency-review-action
|
||||||
|
name: 'Dependency Review'
|
||||||
|
on: [pull_request]
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
dependency-review:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Harden Runner
|
||||||
|
uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
|
||||||
|
with:
|
||||||
|
egress-policy: audit
|
||||||
|
|
||||||
|
- name: 'Checkout Repository'
|
||||||
|
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
|
- name: 'Dependency Review'
|
||||||
|
uses: actions/dependency-review-action@3b139cfc5fae8b618d3eae3675e383bb1769c019 # v4.5.0
|
||||||
10
.github/workflows/labeler.yml
vendored
10
.github/workflows/labeler.yml
vendored
@ -4,7 +4,8 @@ on:
|
|||||||
pull_request_target:
|
pull_request_target:
|
||||||
types: [opened, synchronize]
|
types: [opened, synchronize]
|
||||||
|
|
||||||
permissions: {}
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
label:
|
label:
|
||||||
@ -15,6 +16,11 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: srvaroa/labeler@master
|
- name: Harden Runner
|
||||||
|
uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
|
||||||
|
with:
|
||||||
|
egress-policy: audit
|
||||||
|
|
||||||
|
- uses: srvaroa/labeler@e216fb40e2e6d3b17d90fb1d950f98bee92f65ce # master
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
|
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
|
||||||
|
|||||||
55
.github/workflows/macos.yml
vendored
55
.github/workflows/macos.yml
vendored
@ -9,13 +9,13 @@ on:
|
|||||||
pull_request:
|
pull_request:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
concurrency:
|
concurrency:
|
||||||
group: ${{ github.workflow }}-${{ github.ref || github.run_id }}
|
group: ${{ github.workflow }}-${{ github.ref || github.run_id }}
|
||||||
cancel-in-progress: true
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
# macos-11 is deprecated
|
# macos-11 is deprecated
|
||||||
# macos-11:
|
# macos-11:
|
||||||
@ -27,7 +27,7 @@ jobs:
|
|||||||
# DEVELOPER_DIR: /Applications/Xcode_${{ matrix.xcode }}.app/Contents/Developer
|
# DEVELOPER_DIR: /Applications/Xcode_${{ matrix.xcode }}.app/Contents/Developer
|
||||||
#
|
#
|
||||||
# steps:
|
# steps:
|
||||||
# - uses: actions/checkout@v4
|
# - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
# - name: Run CMake
|
# - name: Run CMake
|
||||||
# run: cmake -S . -B build -D CMAKE_BUILD_TYPE=Debug -DJSON_BuildTests=On -DJSON_FastTests=ON
|
# run: cmake -S . -B build -D CMAKE_BUILD_TYPE=Debug -DJSON_BuildTests=On -DJSON_FastTests=ON
|
||||||
# - name: Build
|
# - name: Build
|
||||||
@ -35,33 +35,34 @@ jobs:
|
|||||||
# - name: Test
|
# - name: Test
|
||||||
# run: cd build ; ctest -j 10 --output-on-failure
|
# run: cd build ; ctest -j 10 --output-on-failure
|
||||||
|
|
||||||
macos-12:
|
# macos-12 is deprecated (https://github.com/actions/runner-images/issues/10721)
|
||||||
runs-on: macos-12 # https://github.com/actions/runner-images/blob/main/images/macos/macos-12-Readme.md
|
# macos-12:
|
||||||
strategy:
|
# runs-on: macos-12 # https://github.com/actions/runner-images/blob/main/images/macos/macos-12-Readme.md
|
||||||
matrix:
|
# strategy:
|
||||||
xcode: ['13.1', '13.2.1', '13.3.1', '13.4.1', '14.0', '14.0.1', '14.1']
|
# matrix:
|
||||||
env:
|
# xcode: ['13.1', '13.2.1', '13.3.1', '13.4.1', '14.0', '14.0.1', '14.1']
|
||||||
DEVELOPER_DIR: /Applications/Xcode_${{ matrix.xcode }}.app/Contents/Developer
|
# env:
|
||||||
|
# DEVELOPER_DIR: /Applications/Xcode_${{ matrix.xcode }}.app/Contents/Developer
|
||||||
steps:
|
#
|
||||||
- uses: actions/checkout@v4
|
# steps:
|
||||||
- name: Run CMake
|
# - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
run: cmake -S . -B build -D CMAKE_BUILD_TYPE=Debug -DJSON_BuildTests=On -DJSON_FastTests=ON
|
# - name: Run CMake
|
||||||
- name: Build
|
# run: cmake -S . -B build -D CMAKE_BUILD_TYPE=Debug -DJSON_BuildTests=On -DJSON_FastTests=ON
|
||||||
run: cmake --build build --parallel 10
|
# - name: Build
|
||||||
- name: Test
|
# run: cmake --build build --parallel 10
|
||||||
run: cd build ; ctest -j 10 --output-on-failure
|
# - name: Test
|
||||||
|
# run: cd build ; ctest -j 10 --output-on-failure
|
||||||
|
|
||||||
macos-13:
|
macos-13:
|
||||||
runs-on: macos-13 # https://github.com/actions/runner-images/blob/main/images/macos/macos-13-Readme.md
|
runs-on: macos-13 # https://github.com/actions/runner-images/blob/main/images/macos/macos-13-Readme.md
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
xcode: [ '14.2', '14.3', '14.3.1', '15.0.1', '15.1', '15.2']
|
xcode: ['14.1', '14.2', '14.3', '14.3.1', '15.0.1', '15.1', '15.2']
|
||||||
env:
|
env:
|
||||||
DEVELOPER_DIR: /Applications/Xcode_${{ matrix.xcode }}.app/Contents/Developer
|
DEVELOPER_DIR: /Applications/Xcode_${{ matrix.xcode }}.app/Contents/Developer
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -D CMAKE_BUILD_TYPE=Debug -DJSON_BuildTests=On -DJSON_FastTests=ON
|
run: cmake -S . -B build -D CMAKE_BUILD_TYPE=Debug -DJSON_BuildTests=On -DJSON_FastTests=ON
|
||||||
- name: Build
|
- name: Build
|
||||||
@ -78,7 +79,7 @@ jobs:
|
|||||||
DEVELOPER_DIR: /Applications/Xcode_${{ matrix.xcode }}.app/Contents/Developer
|
DEVELOPER_DIR: /Applications/Xcode_${{ matrix.xcode }}.app/Contents/Developer
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -D CMAKE_BUILD_TYPE=Debug -DJSON_BuildTests=On -DJSON_FastTests=ON
|
run: cmake -S . -B build -D CMAKE_BUILD_TYPE=Debug -DJSON_BuildTests=On -DJSON_FastTests=ON
|
||||||
- name: Build
|
- name: Build
|
||||||
@ -90,12 +91,12 @@ jobs:
|
|||||||
runs-on: macos-15 # https://github.com/actions/runner-images/blob/main/images/macos/macos-15-Readme.md
|
runs-on: macos-15 # https://github.com/actions/runner-images/blob/main/images/macos/macos-15-Readme.md
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
xcode: ['16.0', '16.1']
|
xcode: ['16.0', '16.1', '16.2']
|
||||||
env:
|
env:
|
||||||
DEVELOPER_DIR: /Applications/Xcode_${{ matrix.xcode }}.app/Contents/Developer
|
DEVELOPER_DIR: /Applications/Xcode_${{ matrix.xcode }}.app/Contents/Developer
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -D CMAKE_BUILD_TYPE=Debug -DJSON_BuildTests=On -DJSON_FastTests=ON
|
run: cmake -S . -B build -D CMAKE_BUILD_TYPE=Debug -DJSON_BuildTests=On -DJSON_FastTests=ON
|
||||||
- name: Build
|
- name: Build
|
||||||
@ -107,10 +108,10 @@ jobs:
|
|||||||
runs-on: macos-latest
|
runs-on: macos-latest
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
standard: [11, 14, 17, 20, 23]
|
standard: [11, 14, 17, 20, 23, 26]
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -D CMAKE_BUILD_TYPE=Debug -DJSON_BuildTests=On -DJSON_TestStandards=${{ matrix.standard }}
|
run: cmake -S . -B build -D CMAKE_BUILD_TYPE=Debug -DJSON_BuildTests=On -DJSON_TestStandards=${{ matrix.standard }}
|
||||||
- name: Build
|
- name: Build
|
||||||
|
|||||||
19
.github/workflows/publish_documentation.yml
vendored
19
.github/workflows/publish_documentation.yml
vendored
@ -10,23 +10,28 @@ on:
|
|||||||
- docs/examples/**
|
- docs/examples/**
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
# we don't want to have concurrent jobs, and we don't want to cancel running jobs to avoid broken publications
|
# we don't want to have concurrent jobs, and we don't want to cancel running jobs to avoid broken publications
|
||||||
concurrency:
|
concurrency:
|
||||||
group: documentation
|
group: documentation
|
||||||
cancel-in-progress: false
|
cancel-in-progress: false
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
publish_documentation:
|
publish_documentation:
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
|
||||||
if: github.repository == 'nlohmann/json'
|
if: github.repository == 'nlohmann/json'
|
||||||
runs-on: ubuntu-22.04
|
runs-on: ubuntu-22.04
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- name: Harden Runner
|
||||||
|
uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
|
||||||
|
with:
|
||||||
|
egress-policy: audit
|
||||||
|
|
||||||
- name: Install and update PlantUML
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
run: sudo apt-get update ; sudo apt-get install -y plantuml
|
|
||||||
|
|
||||||
- name: Install virtual environment
|
- name: Install virtual environment
|
||||||
run: make install_venv -C docs/mkdocs
|
run: make install_venv -C docs/mkdocs
|
||||||
@ -35,7 +40,7 @@ jobs:
|
|||||||
run: make build -C docs/mkdocs
|
run: make build -C docs/mkdocs
|
||||||
|
|
||||||
- name: Deploy documentation
|
- name: Deploy documentation
|
||||||
uses: peaceiris/actions-gh-pages@v4
|
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
|
||||||
with:
|
with:
|
||||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
publish_dir: ./docs/mkdocs/site
|
publish_dir: ./docs/mkdocs/site
|
||||||
|
|||||||
81
.github/workflows/scorecards.yml
vendored
Normal file
81
.github/workflows/scorecards.yml
vendored
Normal file
@ -0,0 +1,81 @@
|
|||||||
|
# This workflow uses actions that are not certified by GitHub. They are provided
|
||||||
|
# by a third-party and are governed by separate terms of service, privacy
|
||||||
|
# policy, and support documentation.
|
||||||
|
|
||||||
|
name: Scorecard supply-chain security
|
||||||
|
on:
|
||||||
|
# For Branch-Protection check. Only the default branch is supported. See
|
||||||
|
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
|
||||||
|
branch_protection_rule:
|
||||||
|
# To guarantee Maintained check is occasionally updated. See
|
||||||
|
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
|
||||||
|
schedule:
|
||||||
|
- cron: '20 7 * * 2'
|
||||||
|
push:
|
||||||
|
branches: ["develop"]
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
analysis:
|
||||||
|
name: Scorecard analysis
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
# Needed to upload the results to code-scanning dashboard.
|
||||||
|
security-events: write
|
||||||
|
# Needed to publish results and get a badge (see publish_results below).
|
||||||
|
id-token: write
|
||||||
|
contents: read
|
||||||
|
actions: read
|
||||||
|
# To allow GraphQL ListCommits to work
|
||||||
|
issues: read
|
||||||
|
pull-requests: read
|
||||||
|
# To detect SAST tools
|
||||||
|
checks: read
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Harden Runner
|
||||||
|
uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
|
||||||
|
with:
|
||||||
|
egress-policy: audit
|
||||||
|
|
||||||
|
- name: "Checkout code"
|
||||||
|
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
|
with:
|
||||||
|
persist-credentials: false
|
||||||
|
|
||||||
|
- name: "Run analysis"
|
||||||
|
uses: ossf/scorecard-action@f49aabe0b5af0936a0987cfb85d86b75731b0186 # v2.4.1
|
||||||
|
with:
|
||||||
|
results_file: results.sarif
|
||||||
|
results_format: sarif
|
||||||
|
# (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
|
||||||
|
# - you want to enable the Branch-Protection check on a *public* repository, or
|
||||||
|
# - you are installing Scorecards on a *private* repository
|
||||||
|
# To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat.
|
||||||
|
# repo_token: ${{ secrets.SCORECARD_TOKEN }}
|
||||||
|
|
||||||
|
# Public repositories:
|
||||||
|
# - Publish results to OpenSSF REST API for easy access by consumers
|
||||||
|
# - Allows the repository to include the Scorecard badge.
|
||||||
|
# - See https://github.com/ossf/scorecard-action#publishing-results.
|
||||||
|
# For private repositories:
|
||||||
|
# - `publish_results` will always be set to `false`, regardless
|
||||||
|
# of the value entered here.
|
||||||
|
publish_results: true
|
||||||
|
|
||||||
|
# Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
|
||||||
|
# format to the repository Actions tab.
|
||||||
|
- name: "Upload artifact"
|
||||||
|
uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
|
||||||
|
with:
|
||||||
|
name: SARIF file
|
||||||
|
path: results.sarif
|
||||||
|
retention-days: 5
|
||||||
|
|
||||||
|
# Upload the results to GitHub's code scanning dashboard.
|
||||||
|
- name: "Upload to code-scanning"
|
||||||
|
uses: github/codeql-action/upload-sarif@b56ba49b26e50535fa1e7f7db0f4f7b4bf65d80d # v3.28.10
|
||||||
|
with:
|
||||||
|
sarif_file: results.sarif
|
||||||
34
.github/workflows/stale.yml
vendored
Normal file
34
.github/workflows/stale.yml
vendored
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
name: 'Comment and close stale issues and PR'
|
||||||
|
on:
|
||||||
|
schedule:
|
||||||
|
- cron: '0 0 * * *'
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
stale:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
issues: write
|
||||||
|
pull-requests: write
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Harden Runner
|
||||||
|
uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
|
||||||
|
with:
|
||||||
|
egress-policy: audit
|
||||||
|
|
||||||
|
- uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # v9.1.0
|
||||||
|
with:
|
||||||
|
stale-issue-label: 'state: stale'
|
||||||
|
stale-pr-label: 'state: stale'
|
||||||
|
exempt-issue-labels: 'pinned,security'
|
||||||
|
stale-issue-message: 'This issue has been marked as stale because it has been open for 90 days without activity. If this issue is still relevant, please add a comment or remove the "stale" label. Otherwise, it will be closed in 10 days. Thank you for helping us prioritize our work!'
|
||||||
|
stale-pr-message: 'This pull request has been marked as stale because it has had no activity for 30 days. While we won’t close it automatically, we encourage you to update or comment if it is still relevant. Keeping pull requests active and up-to-date helps us review and merge changes more efficiently. Thank you for your contributions!'
|
||||||
|
close-issue-message: 'This issue has been closed after being marked as stale for 10 days without any further activity. If this was done in error or the issue is still relevant, please feel free to reopen it or create a new issue. We appreciate your understanding and contributions.'
|
||||||
|
days-before-stale: 90
|
||||||
|
days-before-pr-stale: 30
|
||||||
|
days-before-close: 10
|
||||||
|
days-before-pr-close: -1
|
||||||
144
.github/workflows/ubuntu.yml
vendored
144
.github/workflows/ubuntu.yml
vendored
@ -17,52 +17,44 @@ concurrency:
|
|||||||
cancel-in-progress: true
|
cancel-in-progress: true
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
ci_test_clang:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
container: silkeh/clang:dev
|
|
||||||
steps:
|
|
||||||
- name: Install git and unzip
|
|
||||||
run: apt-get update ; apt-get install -y git unzip
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- name: Get latest CMake and ninja
|
|
||||||
uses: lukka/get-cmake@v3.31.0
|
|
||||||
- name: Run CMake
|
|
||||||
run: cmake -S . -B build -DJSON_CI=On
|
|
||||||
- name: Build
|
|
||||||
run: cmake --build build --target ci_test_clang
|
|
||||||
|
|
||||||
ci_test_gcc:
|
ci_test_gcc:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
container: ghcr.io/nlohmann/json-ci:v2.4.0
|
container: gcc:latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
|
- name: Get latest CMake and ninja
|
||||||
|
uses: lukka/get-cmake@56d043d188c3612951d8755da8f4b709ec951ad6 # v3.31.6
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -DJSON_CI=On
|
run: cmake -S . -B build -DJSON_CI=On
|
||||||
- name: Build
|
- name: Build
|
||||||
run: cmake --build build --target ci_test_gcc
|
run: cmake --build build --target ci_test_gcc
|
||||||
|
|
||||||
ci_static_analysis:
|
ci_infer:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
container: ghcr.io/nlohmann/json-ci:v2.4.0
|
container: ghcr.io/nlohmann/json-ci:v2.4.0
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
target: [ci_cppcheck, ci_test_valgrind, ci_test_amalgamation, ci_test_single_header, ci_single_binaries, ci_infer]
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -DJSON_CI=On
|
run: cmake -S . -B build -DJSON_CI=On
|
||||||
- name: Build
|
- name: Build
|
||||||
run: cmake --build build --target ${{ matrix.target }}
|
run: cmake --build build --target ci_infer
|
||||||
|
|
||||||
ci_static_analysis_ubuntu:
|
ci_static_analysis_ubuntu:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
target: [ci_cpplint, ci_reproducible_tests, ci_non_git_tests, ci_offline_testdata]
|
target: [ci_test_amalgamation, ci_test_single_header, ci_cppcheck, ci_cpplint, ci_reproducible_tests, ci_non_git_tests, ci_offline_testdata, ci_reuse_compliance, ci_test_valgrind]
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- name: Harden Runner
|
||||||
|
uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
|
||||||
|
with:
|
||||||
|
egress-policy: audit
|
||||||
|
|
||||||
|
- name: Install Valgrind
|
||||||
|
run: sudo apt-get update ; sudo apt-get install -y valgrind
|
||||||
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Get latest CMake and ninja
|
- name: Get latest CMake and ninja
|
||||||
uses: lukka/get-cmake@v3.31.0
|
uses: lukka/get-cmake@56d043d188c3612951d8755da8f4b709ec951ad6 # v3.31.6
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -DJSON_CI=On
|
run: cmake -S . -B build -DJSON_CI=On
|
||||||
- name: Build
|
- name: Build
|
||||||
@ -73,13 +65,13 @@ jobs:
|
|||||||
container: silkeh/clang:dev
|
container: silkeh/clang:dev
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
target: [ci_clang_tidy, ci_test_clang_sanitizer, ci_clang_analyze]
|
target: [ci_test_clang, ci_clang_tidy, ci_test_clang_sanitizer, ci_clang_analyze, ci_single_binaries]
|
||||||
steps:
|
steps:
|
||||||
- name: Install git, clang-tools, and unzip
|
- name: Install git, clang-tools, iwyu (ci_single_binaries), and unzip
|
||||||
run: apt-get update ; apt-get install -y git clang-tools unzip
|
run: apt-get update ; apt-get install -y git clang-tools iwyu unzip
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Get latest CMake and ninja
|
- name: Get latest CMake and ninja
|
||||||
uses: lukka/get-cmake@v3.31.0
|
uses: lukka/get-cmake@56d043d188c3612951d8755da8f4b709ec951ad6 # v3.31.6
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -DJSON_CI=On
|
run: cmake -S . -B build -DJSON_CI=On
|
||||||
- name: Build
|
- name: Build
|
||||||
@ -90,13 +82,13 @@ jobs:
|
|||||||
container: ubuntu:focal
|
container: ubuntu:focal
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
target: [ci_cmake_flags, ci_test_diagnostics, ci_test_noexceptions, ci_test_noimplicitconversions, ci_test_legacycomparison, ci_test_noglobaludls]
|
target: [ci_cmake_flags, ci_test_diagnostics, ci_test_diagnostic_positions, ci_test_noexceptions, ci_test_noimplicitconversions, ci_test_legacycomparison, ci_test_noglobaludls]
|
||||||
steps:
|
steps:
|
||||||
- name: Install build-essential
|
- name: Install build-essential
|
||||||
run: apt-get update ; apt-get install -y build-essential unzip wget git
|
run: apt-get update ; apt-get install -y build-essential unzip wget git
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Get latest CMake and ninja
|
- name: Get latest CMake and ninja
|
||||||
uses: lukka/get-cmake@v3.31.0
|
uses: lukka/get-cmake@56d043d188c3612951d8755da8f4b709ec951ad6 # v3.31.6
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -DJSON_CI=On
|
run: cmake -S . -B build -DJSON_CI=On
|
||||||
- name: Build
|
- name: Build
|
||||||
@ -104,23 +96,31 @@ jobs:
|
|||||||
|
|
||||||
ci_test_coverage:
|
ci_test_coverage:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
container: ghcr.io/nlohmann/json-ci:v2.4.0
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
checks: write
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- name: Harden Runner
|
||||||
|
uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
|
||||||
|
with:
|
||||||
|
egress-policy: audit
|
||||||
|
|
||||||
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
|
- name: Install dependencies and de_DE locale
|
||||||
|
run: |
|
||||||
|
sudo apt-get clean
|
||||||
|
sudo apt-get update
|
||||||
|
sudo apt-get install -y build-essential cmake lcov ninja-build make locales gcc-multilib g++-multilib
|
||||||
|
sudo locale-gen de_DE
|
||||||
|
sudo update-locale
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -DJSON_CI=On
|
run: cmake -S . -B build -DJSON_CI=On
|
||||||
- name: Build
|
- name: Build
|
||||||
run: cmake --build build --target ci_test_coverage
|
run: cmake --build build --target ci_test_coverage
|
||||||
- name: Archive coverage report
|
- name: Archive coverage report
|
||||||
uses: actions/upload-artifact@v3
|
uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
|
||||||
with:
|
with:
|
||||||
name: code-coverage-report
|
name: code-coverage-report
|
||||||
path: ${{ github.workspace }}/build/html
|
path: ${{ github.workspace }}/build/html
|
||||||
- name: Publish report to Coveralls
|
- name: Publish report to Coveralls
|
||||||
uses: coverallsapp/github-action@master
|
uses: coverallsapp/github-action@648a8eb78e6d50909eff900e4ec85cab4524a45b # v2.3.6
|
||||||
with:
|
with:
|
||||||
github-token: ${{ secrets.GITHUB_TOKEN }}
|
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
path-to-lcov: ${{ github.workspace }}/build/json.info.filtered.noexcept
|
path-to-lcov: ${{ github.workspace }}/build/json.info.filtered.noexcept
|
||||||
@ -132,7 +132,7 @@ jobs:
|
|||||||
compiler: ['4.8', '4.9', '5', '6']
|
compiler: ['4.8', '4.9', '5', '6']
|
||||||
container: ghcr.io/nlohmann/json-ci:v2.4.0
|
container: ghcr.io/nlohmann/json-ci:v2.4.0
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: CXX=g++-${{ matrix.compiler }} cmake -S . -B build -DJSON_CI=On
|
run: CXX=g++-${{ matrix.compiler }} cmake -S . -B build -DJSON_CI=On
|
||||||
- name: Build
|
- name: Build
|
||||||
@ -146,9 +146,9 @@ jobs:
|
|||||||
compiler: ['7', '8', '9', '10', '11', '12', '13', '14', 'latest']
|
compiler: ['7', '8', '9', '10', '11', '12', '13', '14', 'latest']
|
||||||
container: gcc:${{ matrix.compiler }}
|
container: gcc:${{ matrix.compiler }}
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Get latest CMake and ninja
|
- name: Get latest CMake and ninja
|
||||||
uses: lukka/get-cmake@v3.31.0
|
uses: lukka/get-cmake@56d043d188c3612951d8755da8f4b709ec951ad6 # v3.31.6
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -DJSON_CI=On
|
run: cmake -S . -B build -DJSON_CI=On
|
||||||
- name: Build
|
- name: Build
|
||||||
@ -158,14 +158,14 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
compiler: ['3.5', '3.6', '3.7', '3.8', '3.9', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15-bullseye', '16', '17', '18', '19', 'latest']
|
compiler: ['3.4', '3.5', '3.6', '3.7', '3.8', '3.9', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15-bullseye', '16', '17', '18', '19', 'latest']
|
||||||
container: silkeh/clang:${{ matrix.compiler }}
|
container: silkeh/clang:${{ matrix.compiler }}
|
||||||
steps:
|
steps:
|
||||||
- name: Install unzip and git
|
- name: Install unzip and git
|
||||||
run: apt-get update ; apt-get install -y unzip git
|
run: apt-get update ; apt-get install -y unzip git
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Get latest CMake and ninja
|
- name: Get latest CMake and ninja
|
||||||
uses: lukka/get-cmake@v3.31.0
|
uses: lukka/get-cmake@56d043d188c3612951d8755da8f4b709ec951ad6 # v3.31.6
|
||||||
- name: Set env FORCE_STDCPPFS_FLAG for clang 7 / 8 / 9 / 10
|
- name: Set env FORCE_STDCPPFS_FLAG for clang 7 / 8 / 9 / 10
|
||||||
run: echo "JSON_FORCED_GLOBAL_COMPILE_OPTIONS=-DJSON_HAS_FILESYSTEM=0;-DJSON_HAS_EXPERIMENTAL_FILESYSTEM=0" >> "$GITHUB_ENV"
|
run: echo "JSON_FORCED_GLOBAL_COMPILE_OPTIONS=-DJSON_HAS_FILESYSTEM=0;-DJSON_HAS_EXPERIMENTAL_FILESYSTEM=0" >> "$GITHUB_ENV"
|
||||||
if: ${{ matrix.compiler == '7' || matrix.compiler == '8' || matrix.compiler == '9' || matrix.compiler == '10' }}
|
if: ${{ matrix.compiler == '7' || matrix.compiler == '8' || matrix.compiler == '9' || matrix.compiler == '10' }}
|
||||||
@ -174,27 +174,16 @@ jobs:
|
|||||||
- name: Build
|
- name: Build
|
||||||
run: cmake --build build --target ci_test_compiler_default
|
run: cmake --build build --target ci_test_compiler_default
|
||||||
|
|
||||||
ci_test_compilers:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
container: ghcr.io/nlohmann/json-ci:v2.4.0
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
compiler: [g++-4.8]
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- name: Run CMake
|
|
||||||
run: cmake -S . -B build -DJSON_CI=On
|
|
||||||
- name: Build
|
|
||||||
run: cmake --build build --target ci_test_compiler_${{ matrix.compiler }}
|
|
||||||
|
|
||||||
ci_test_standards_gcc:
|
ci_test_standards_gcc:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
container: ghcr.io/nlohmann/json-ci:v2.4.0
|
container: gcc:latest
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
standard: [11, 14, 17, 20, 23]
|
standard: [11, 14, 17, 20, 23, 26]
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
|
- name: Get latest CMake and ninja
|
||||||
|
uses: lukka/get-cmake@56d043d188c3612951d8755da8f4b709ec951ad6 # v3.31.6
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -DJSON_CI=On
|
run: cmake -S . -B build -DJSON_CI=On
|
||||||
- name: Build
|
- name: Build
|
||||||
@ -205,14 +194,14 @@ jobs:
|
|||||||
container: silkeh/clang:latest
|
container: silkeh/clang:latest
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
standard: [11, 14, 17, 20, 23]
|
standard: [11, 14, 17, 20, 23, 26]
|
||||||
stdlib: [libcxx, libstdcxx]
|
stdlib: [libcxx, libstdcxx]
|
||||||
steps:
|
steps:
|
||||||
- name: Install git and unzip
|
- name: Install git and unzip
|
||||||
run: apt-get update ; apt-get install -y git unzip
|
run: apt-get update ; apt-get install -y git unzip
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Get latest CMake and ninja
|
- name: Get latest CMake and ninja
|
||||||
uses: lukka/get-cmake@v3.31.0
|
uses: lukka/get-cmake@56d043d188c3612951d8755da8f4b709ec951ad6 # v3.31.6
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -DJSON_CI=On
|
run: cmake -S . -B build -DJSON_CI=On
|
||||||
- name: Build with libc++
|
- name: Build with libc++
|
||||||
@ -226,7 +215,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
container: ghcr.io/nlohmann/json-ci:v2.4.0
|
container: ghcr.io/nlohmann/json-ci:v2.4.0
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -DJSON_CI=On
|
run: cmake -S . -B build -DJSON_CI=On
|
||||||
- name: Build
|
- name: Build
|
||||||
@ -236,7 +225,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
container: ghcr.io/nlohmann/json-ci:v2.2.0
|
container: ghcr.io/nlohmann/json-ci:v2.2.0
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -DJSON_CI=On
|
run: cmake -S . -B build -DJSON_CI=On
|
||||||
- name: Build
|
- name: Build
|
||||||
@ -244,25 +233,18 @@ jobs:
|
|||||||
. /opt/intel/oneapi/setvars.sh
|
. /opt/intel/oneapi/setvars.sh
|
||||||
cmake --build build --target ci_icpc
|
cmake --build build --target ci_icpc
|
||||||
|
|
||||||
ci_reuse_compliance:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- uses: actions/setup-python@v5
|
|
||||||
with:
|
|
||||||
python-version: '3.11'
|
|
||||||
- name: Install REUSE tool
|
|
||||||
run: python -m pip install reuse
|
|
||||||
- name: Run REUSE lint
|
|
||||||
run: reuse lint
|
|
||||||
|
|
||||||
ci_test_documentation:
|
ci_test_documentation:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
target: [ci_test_examples, ci_test_api_documentation]
|
target: [ci_test_examples, ci_test_build_documentation]
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- name: Harden Runner
|
||||||
|
uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
|
||||||
|
with:
|
||||||
|
egress-policy: audit
|
||||||
|
|
||||||
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -DJSON_CI=On
|
run: cmake -S . -B build -DJSON_CI=On
|
||||||
- name: Build
|
- name: Build
|
||||||
|
|||||||
16
.github/workflows/windows.yml
vendored
16
.github/workflows/windows.yml
vendored
@ -24,9 +24,9 @@ jobs:
|
|||||||
architecture: [x64, x86]
|
architecture: [x64, x86]
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Set up MinGW
|
- name: Set up MinGW
|
||||||
uses: egor-tensin/setup-mingw@v2
|
uses: egor-tensin/setup-mingw@84c781b557efd538dec66bde06988d81cd3138cf # v2.2.0
|
||||||
with:
|
with:
|
||||||
platform: ${{ matrix.architecture }}
|
platform: ${{ matrix.architecture }}
|
||||||
version: 12.2.0 # https://github.com/egor-tensin/setup-mingw/issues/14
|
version: 12.2.0 # https://github.com/egor-tensin/setup-mingw/issues/14
|
||||||
@ -45,7 +45,7 @@ jobs:
|
|||||||
architecture: [Win32, x64]
|
architecture: [Win32, x64]
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -G "Visual Studio 16 2019" -A ${{ matrix.architecture }} -DJSON_BuildTests=On -DCMAKE_CXX_FLAGS="/W4 /WX"
|
run: cmake -S . -B build -G "Visual Studio 16 2019" -A ${{ matrix.architecture }} -DJSON_BuildTests=On -DCMAKE_CXX_FLAGS="/W4 /WX"
|
||||||
if: matrix.build_type == 'Release'
|
if: matrix.build_type == 'Release'
|
||||||
@ -61,7 +61,7 @@ jobs:
|
|||||||
runs-on: windows-2019
|
runs-on: windows-2019
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -G "Visual Studio 16 2019" -DJSON_BuildTests=On -DCMAKE_CXX_FLAGS="/permissive- /std:c++latest /utf-8 /W4 /WX"
|
run: cmake -S . -B build -G "Visual Studio 16 2019" -DJSON_BuildTests=On -DCMAKE_CXX_FLAGS="/permissive- /std:c++latest /utf-8 /W4 /WX"
|
||||||
- name: Build
|
- name: Build
|
||||||
@ -77,7 +77,7 @@ jobs:
|
|||||||
architecture: [Win32, x64]
|
architecture: [Win32, x64]
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -G "Visual Studio 17 2022" -A ${{ matrix.architecture }} -DJSON_BuildTests=On -DCMAKE_CXX_FLAGS="/W4 /WX"
|
run: cmake -S . -B build -G "Visual Studio 17 2022" -A ${{ matrix.architecture }} -DJSON_BuildTests=On -DCMAKE_CXX_FLAGS="/W4 /WX"
|
||||||
if: matrix.build_type == 'Release'
|
if: matrix.build_type == 'Release'
|
||||||
@ -93,7 +93,7 @@ jobs:
|
|||||||
runs-on: windows-2022
|
runs-on: windows-2022
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -G "Visual Studio 17 2022" -DJSON_BuildTests=On -DCMAKE_CXX_FLAGS="/permissive- /std:c++latest /utf-8 /W4 /WX"
|
run: cmake -S . -B build -G "Visual Studio 17 2022" -DJSON_BuildTests=On -DCMAKE_CXX_FLAGS="/permissive- /std:c++latest /utf-8 /W4 /WX"
|
||||||
- name: Build
|
- name: Build
|
||||||
@ -108,7 +108,7 @@ jobs:
|
|||||||
version: [11, 12, 13, 14, 15]
|
version: [11, 12, 13, 14, 15]
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Install Clang
|
- name: Install Clang
|
||||||
run: curl -fsSL -o LLVM${{ matrix.version }}.exe https://github.com/llvm/llvm-project/releases/download/llvmorg-${{ matrix.version }}.0.0/LLVM-${{ matrix.version }}.0.0-win64.exe ; 7z x LLVM${{ matrix.version }}.exe -y -o"C:/Program Files/LLVM"
|
run: curl -fsSL -o LLVM${{ matrix.version }}.exe https://github.com/llvm/llvm-project/releases/download/llvmorg-${{ matrix.version }}.0.0/LLVM-${{ matrix.version }}.0.0-win64.exe ; 7z x LLVM${{ matrix.version }}.exe -y -o"C:/Program Files/LLVM"
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
@ -125,7 +125,7 @@ jobs:
|
|||||||
architecture: [Win32, x64]
|
architecture: [Win32, x64]
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
- name: Run CMake
|
- name: Run CMake
|
||||||
run: cmake -S . -B build -G "Visual Studio 16 2019" -A ${{ matrix.architecture }} -T ClangCL -DJSON_BuildTests=On
|
run: cmake -S . -B build -G "Visual Studio 16 2019" -A ${{ matrix.architecture }} -T ClangCL -DJSON_BuildTests=On
|
||||||
- name: Build
|
- name: Build
|
||||||
|
|||||||
15
.gitignore
vendored
15
.gitignore
vendored
@ -4,9 +4,6 @@
|
|||||||
*.gcda
|
*.gcda
|
||||||
.DS_Store
|
.DS_Store
|
||||||
|
|
||||||
.wsjcpp-logs/*
|
|
||||||
.wsjcpp/*
|
|
||||||
|
|
||||||
/.idea
|
/.idea
|
||||||
/cmake-build-*
|
/cmake-build-*
|
||||||
|
|
||||||
@ -26,12 +23,11 @@
|
|||||||
/tests/parse_*_fuzzer
|
/tests/parse_*_fuzzer
|
||||||
|
|
||||||
# documentation
|
# documentation
|
||||||
/docs/docset/docSet.dsidx
|
|
||||||
/docs/docset/JSON_for_Modern_C++.docset/
|
/docs/docset/JSON_for_Modern_C++.docset/
|
||||||
/docs/docset/JSON_for_Modern_C++.tgz
|
/docs/docset/JSON_for_Modern_C++.tgz
|
||||||
|
/docs/docset/docSet.dsidx
|
||||||
|
/docs/mkdocs/.cache/
|
||||||
/docs/mkdocs/docs/__pycache__/
|
/docs/mkdocs/docs/__pycache__/
|
||||||
/docs/mkdocs/docs/examples/
|
|
||||||
/docs/mkdocs/docs/images/json.gif
|
|
||||||
/docs/mkdocs/site/
|
/docs/mkdocs/site/
|
||||||
/docs/mkdocs/venv/
|
/docs/mkdocs/venv/
|
||||||
|
|
||||||
@ -42,3 +38,10 @@
|
|||||||
|
|
||||||
# Swift Package Manager build directory
|
# Swift Package Manager build directory
|
||||||
/.build
|
/.build
|
||||||
|
|
||||||
|
venv
|
||||||
|
|
||||||
|
nlohmann_json.spdx
|
||||||
|
|
||||||
|
# Bazel-related
|
||||||
|
MODULE.bazel.lock
|
||||||
|
|||||||
@ -1,4 +0,0 @@
|
|||||||
path_classifiers:
|
|
||||||
thirdparty:
|
|
||||||
- /tools/amalgamate
|
|
||||||
- /tools/cpplint
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
# REUSE Software
|
|
||||||
|
|
||||||
This directory contains supporting files to make the project compliant with the REUSE specification.
|
|
||||||
|
|
||||||
The root `Makefile` contains a target `reuse` that updates copyright headers and checks for compliance.
|
|
||||||
|
|
||||||
See <http://reuse.software> for more information.
|
|
||||||
12
.reuse/dep5
12
.reuse/dep5
@ -4,11 +4,15 @@ Upstream-Contact: Niels Lohmann <mail@nlohmann.me>
|
|||||||
Source: https://github.com/nlohmann/json
|
Source: https://github.com/nlohmann/json
|
||||||
|
|
||||||
Files: *
|
Files: *
|
||||||
Copyright: 2013-2022 Niels Lohmann <https://nlohmann.me>
|
Copyright: 2013-2025 Niels Lohmann <https://nlohmann.me>
|
||||||
License: MIT
|
License: MIT
|
||||||
|
|
||||||
|
Files: include/nlohmann/thirdparty/hedley.hpp
|
||||||
|
Copyright: 2016-2021 Evan Nemerson <evan@nemerson.com>
|
||||||
|
License: CC0
|
||||||
|
|
||||||
Files: tests/thirdparty/doctest/*
|
Files: tests/thirdparty/doctest/*
|
||||||
Copyright: 2016-2021 Viktor Kirilov
|
Copyright: 2016-2023 Viktor Kirilov
|
||||||
License: MIT
|
License: MIT
|
||||||
|
|
||||||
Files: tests/thirdparty/fifo_map/*
|
Files: tests/thirdparty/fifo_map/*
|
||||||
@ -16,7 +20,7 @@ Copyright: 2015-2017 Niels Lohmann
|
|||||||
License: MIT
|
License: MIT
|
||||||
|
|
||||||
Files: tests/thirdparty/Fuzzer/*
|
Files: tests/thirdparty/Fuzzer/*
|
||||||
Copyright: 2003-2022, LLVM Project.
|
Copyright: 2003-2022 LLVM Project.
|
||||||
License: Apache-2.0
|
License: Apache-2.0
|
||||||
|
|
||||||
Files: tests/thirdparty/imapdl/*
|
Files: tests/thirdparty/imapdl/*
|
||||||
@ -27,6 +31,6 @@ Files: tools/amalgamate/*
|
|||||||
Copyright: 2012 Erik Edlund <erik.edlund@32767.se>
|
Copyright: 2012 Erik Edlund <erik.edlund@32767.se>
|
||||||
License: BSD-3-Clause
|
License: BSD-3-Clause
|
||||||
|
|
||||||
Files: tools/gdb_pretty_printer
|
Files: tools/gdb_pretty_printer/*
|
||||||
Copyright: 2020 Hannes Domani <https://github.com/ssbssa>
|
Copyright: 2020 Hannes Domani <https://github.com/ssbssa>
|
||||||
License: MIT
|
License: MIT
|
||||||
|
|||||||
28
BUILD.bazel
28
BUILD.bazel
@ -1,3 +1,20 @@
|
|||||||
|
load("@rules_cc//cc:cc_library.bzl", "cc_library")
|
||||||
|
load("@rules_license//rules:license.bzl", "license")
|
||||||
|
|
||||||
|
package(
|
||||||
|
default_applicable_licenses = [":license"],
|
||||||
|
)
|
||||||
|
|
||||||
|
exports_files([
|
||||||
|
"LICENSE.MIT",
|
||||||
|
])
|
||||||
|
|
||||||
|
license(
|
||||||
|
name = "license",
|
||||||
|
license_kinds = ["@rules_license//licenses/spdx:MIT"],
|
||||||
|
license_text = "LICENSE.MIT",
|
||||||
|
)
|
||||||
|
|
||||||
cc_library(
|
cc_library(
|
||||||
name = "json",
|
name = "json",
|
||||||
hdrs = [
|
hdrs = [
|
||||||
@ -40,6 +57,7 @@ cc_library(
|
|||||||
"include/nlohmann/detail/output/serializer.hpp",
|
"include/nlohmann/detail/output/serializer.hpp",
|
||||||
"include/nlohmann/detail/string_concat.hpp",
|
"include/nlohmann/detail/string_concat.hpp",
|
||||||
"include/nlohmann/detail/string_escape.hpp",
|
"include/nlohmann/detail/string_escape.hpp",
|
||||||
|
"include/nlohmann/detail/string_utils.hpp",
|
||||||
"include/nlohmann/detail/value_t.hpp",
|
"include/nlohmann/detail/value_t.hpp",
|
||||||
"include/nlohmann/json.hpp",
|
"include/nlohmann/json.hpp",
|
||||||
"include/nlohmann/json_fwd.hpp",
|
"include/nlohmann/json_fwd.hpp",
|
||||||
@ -49,4 +67,14 @@ cc_library(
|
|||||||
],
|
],
|
||||||
includes = ["include"],
|
includes = ["include"],
|
||||||
visibility = ["//visibility:public"],
|
visibility = ["//visibility:public"],
|
||||||
|
alwayslink = True,
|
||||||
|
)
|
||||||
|
|
||||||
|
cc_library(
|
||||||
|
name = "singleheader-json",
|
||||||
|
hdrs = [
|
||||||
|
"single_include/nlohmann/json.hpp",
|
||||||
|
],
|
||||||
|
includes = ["single_include"],
|
||||||
|
visibility = ["//visibility:public"],
|
||||||
)
|
)
|
||||||
|
|||||||
@ -40,7 +40,8 @@ endif()
|
|||||||
option(JSON_BuildTests "Build the unit tests when BUILD_TESTING is enabled." ${JSON_BuildTests_INIT})
|
option(JSON_BuildTests "Build the unit tests when BUILD_TESTING is enabled." ${JSON_BuildTests_INIT})
|
||||||
option(JSON_CI "Enable CI build targets." OFF)
|
option(JSON_CI "Enable CI build targets." OFF)
|
||||||
option(JSON_Diagnostics "Use extended diagnostic messages." OFF)
|
option(JSON_Diagnostics "Use extended diagnostic messages." OFF)
|
||||||
option(JSON_GlobalUDLs "Place use-defined string literals in the global namespace." ON)
|
option(JSON_Diagnostic_Positions "Enable diagnostic positions." OFF)
|
||||||
|
option(JSON_GlobalUDLs "Place user-defined string literals in the global namespace." ON)
|
||||||
option(JSON_ImplicitConversions "Enable implicit conversions." ON)
|
option(JSON_ImplicitConversions "Enable implicit conversions." ON)
|
||||||
option(JSON_DisableEnumSerialization "Disable default integer enum serialization." OFF)
|
option(JSON_DisableEnumSerialization "Disable default integer enum serialization." OFF)
|
||||||
option(JSON_LegacyDiscardedValueComparison "Enable legacy discarded value comparison." OFF)
|
option(JSON_LegacyDiscardedValueComparison "Enable legacy discarded value comparison." OFF)
|
||||||
@ -81,19 +82,27 @@ else()
|
|||||||
endif()
|
endif()
|
||||||
|
|
||||||
if (NOT JSON_ImplicitConversions)
|
if (NOT JSON_ImplicitConversions)
|
||||||
message(STATUS "Implicit conversions are disabled")
|
message(STATUS "Implicit conversions are disabled (JSON_USE_IMPLICIT_CONVERSIONS=0)")
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
if (JSON_DisableEnumSerialization)
|
if (JSON_DisableEnumSerialization)
|
||||||
message(STATUS "Enum integer serialization is disabled")
|
message(STATUS "Enum integer serialization is disabled (JSON_DISABLE_ENUM_SERIALIZATION=0)")
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
if (JSON_LegacyDiscardedValueComparison)
|
if (JSON_LegacyDiscardedValueComparison)
|
||||||
message(STATUS "Legacy discarded value comparison enabled")
|
message(STATUS "Legacy discarded value comparison enabled (JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON=1)")
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
if (JSON_Diagnostics)
|
if (JSON_Diagnostics)
|
||||||
message(STATUS "Diagnostics enabled")
|
message(STATUS "Diagnostics enabled (JSON_DIAGNOSTICS=1)")
|
||||||
|
endif()
|
||||||
|
|
||||||
|
if (JSON_Diagnostic_Positions)
|
||||||
|
message(STATUS "Diagnostic positions enabled (JSON_DIAGNOSTIC_POSITIONS=1)")
|
||||||
|
endif()
|
||||||
|
|
||||||
|
if (NOT JSON_GlobalUDLs)
|
||||||
|
message(STATUS "User-defined string literals are not put in the global namespace (JSON_USE_GLOBAL_UDLS=0)")
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
if (JSON_SystemInclude)
|
if (JSON_SystemInclude)
|
||||||
@ -119,6 +128,7 @@ target_compile_definitions(
|
|||||||
$<$<NOT:$<BOOL:${JSON_ImplicitConversions}>>:JSON_USE_IMPLICIT_CONVERSIONS=0>
|
$<$<NOT:$<BOOL:${JSON_ImplicitConversions}>>:JSON_USE_IMPLICIT_CONVERSIONS=0>
|
||||||
$<$<BOOL:${JSON_DisableEnumSerialization}>:JSON_DISABLE_ENUM_SERIALIZATION=1>
|
$<$<BOOL:${JSON_DisableEnumSerialization}>:JSON_DISABLE_ENUM_SERIALIZATION=1>
|
||||||
$<$<BOOL:${JSON_Diagnostics}>:JSON_DIAGNOSTICS=1>
|
$<$<BOOL:${JSON_Diagnostics}>:JSON_DIAGNOSTICS=1>
|
||||||
|
$<$<BOOL:${JSON_Diagnostic_Positions}>:JSON_DIAGNOSTIC_POSITIONS=1>
|
||||||
$<$<BOOL:${JSON_LegacyDiscardedValueComparison}>:JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON=1>
|
$<$<BOOL:${JSON_LegacyDiscardedValueComparison}>:JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON=1>
|
||||||
)
|
)
|
||||||
|
|
||||||
@ -145,6 +155,7 @@ endif()
|
|||||||
CONFIGURE_FILE(
|
CONFIGURE_FILE(
|
||||||
"${CMAKE_CURRENT_SOURCE_DIR}/cmake/pkg-config.pc.in"
|
"${CMAKE_CURRENT_SOURCE_DIR}/cmake/pkg-config.pc.in"
|
||||||
"${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc"
|
"${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc"
|
||||||
|
@ONLY
|
||||||
)
|
)
|
||||||
|
|
||||||
##
|
##
|
||||||
|
|||||||
355
ChangeLog.md
355
ChangeLog.md
@ -1,9 +1,340 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).
|
All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).
|
||||||
|
|
||||||
## [3.11.2](https://github.com/nlohmann/json/releases/tag/3.11.2) (2022-08-12)
|
## [unreleased](https://github.com/nlohmann/json/releases/tag/unreleased) (2024-12-22)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/nlohmann/json/compare/v3.11.1...3.11.2)
|
[Full Changelog](https://github.com/nlohmann/json/compare/v3.11.3...unreleased)
|
||||||
|
|
||||||
|
- Impossible de read json file create with nlohmann::ordered\_json::dump [\#4556](https://github.com/nlohmann/json/issues/4556)
|
||||||
|
- Error C2039 : 'json\_sax\_dom\_callback\_parser': is not a member of 'nlohmann::json\_abi\_v3\_11\_3::detail' [\#4529](https://github.com/nlohmann/json/issues/4529)
|
||||||
|
- `json_fwd.hpp` don't define default template arguments for ordered\_map [\#4518](https://github.com/nlohmann/json/issues/4518)
|
||||||
|
- new repo version seems stop create any the ingress-nginx controller with opentelemetry-cpp.git [\#4515](https://github.com/nlohmann/json/issues/4515)
|
||||||
|
- Error converting to/from scoped enumerations [\#4499](https://github.com/nlohmann/json/issues/4499)
|
||||||
|
- Default initialized iterators are not comparable [\#4493](https://github.com/nlohmann/json/issues/4493)
|
||||||
|
- Bug json.exception.type\_error.302 [\#4492](https://github.com/nlohmann/json/issues/4492)
|
||||||
|
- tests fail to build with clang-19 and libc++ due to unsupported `std::char_traits` [\#4490](https://github.com/nlohmann/json/issues/4490)
|
||||||
|
- Brace-Initialization Fails with json::parse and Key Access on Linux [\#4488](https://github.com/nlohmann/json/issues/4488)
|
||||||
|
- Crash when parsing nullptr [\#4485](https://github.com/nlohmann/json/issues/4485)
|
||||||
|
- Namespace macros are not respected in many instances [\#4484](https://github.com/nlohmann/json/issues/4484)
|
||||||
|
- ohos model to json string garbage characters [\#4481](https://github.com/nlohmann/json/issues/4481)
|
||||||
|
- Missing newlines in deserialized string [\#4479](https://github.com/nlohmann/json/issues/4479)
|
||||||
|
- Latest tag not available on NuGet [\#4478](https://github.com/nlohmann/json/issues/4478)
|
||||||
|
- Invalid union access for get\_ref/get\_ptr with unsigned integer [\#4475](https://github.com/nlohmann/json/issues/4475)
|
||||||
|
- /accesswallet [\#4469](https://github.com/nlohmann/json/issues/4469)
|
||||||
|
- struct reflect json with error C2440 [\#4467](https://github.com/nlohmann/json/issues/4467)
|
||||||
|
- Compiler error when using macro NLOHMANN\_DEFINE\_TYPE\_NON\_INTRUSIVE [\#4463](https://github.com/nlohmann/json/issues/4463)
|
||||||
|
- Issue when dumping a vector of derived classes [\#4462](https://github.com/nlohmann/json/issues/4462)
|
||||||
|
- whit std::wstring compile error [\#4460](https://github.com/nlohmann/json/issues/4460)
|
||||||
|
- Inconsisten operator\[\] [\#4458](https://github.com/nlohmann/json/issues/4458)
|
||||||
|
- json parse enclosing json object with \[\] [\#4457](https://github.com/nlohmann/json/issues/4457)
|
||||||
|
- \[bug\] nlohmann::json constructor behaves improperly [\#4450](https://github.com/nlohmann/json/issues/4450)
|
||||||
|
- parse OOM [\#4449](https://github.com/nlohmann/json/issues/4449)
|
||||||
|
- Library Cannot Parse JSON File It Wrote [\#4448](https://github.com/nlohmann/json/issues/4448)
|
||||||
|
- Unexpected Integer Conversion of JSON Values on ARM64 [\#4447](https://github.com/nlohmann/json/issues/4447)
|
||||||
|
- Structure declared in natvis file template doesn't seem to match current structure of `basic_json<>` [\#4438](https://github.com/nlohmann/json/issues/4438)
|
||||||
|
- A lot of EOT in json file [\#4436](https://github.com/nlohmann/json/issues/4436)
|
||||||
|
- CVE-2024-34062 [\#4429](https://github.com/nlohmann/json/issues/4429)
|
||||||
|
- CVE-2024-39689 [\#4428](https://github.com/nlohmann/json/issues/4428)
|
||||||
|
- CVE-2024-5569 [\#4427](https://github.com/nlohmann/json/issues/4427)
|
||||||
|
- CVE-2024-37891 [\#4426](https://github.com/nlohmann/json/issues/4426)
|
||||||
|
- Tornado vulnerabilities [\#4425](https://github.com/nlohmann/json/issues/4425)
|
||||||
|
- CVE-2024-35195 [\#4424](https://github.com/nlohmann/json/issues/4424)
|
||||||
|
- CVE-2024-22195, CVE-2024-34064 [\#4423](https://github.com/nlohmann/json/issues/4423)
|
||||||
|
- CVE-2024-3651 [\#4422](https://github.com/nlohmann/json/issues/4422)
|
||||||
|
- CVE-2024-22190 [\#4421](https://github.com/nlohmann/json/issues/4421)
|
||||||
|
- CVE-2024-39705 [\#4420](https://github.com/nlohmann/json/issues/4420)
|
||||||
|
- Failing to read complex Unicode string embedded in JSON [\#4417](https://github.com/nlohmann/json/issues/4417)
|
||||||
|
- Unable to parse JSON string from snake case to camel case [\#4399](https://github.com/nlohmann/json/issues/4399)
|
||||||
|
- Crashes when I try to use ‘json::at\(\)’ on a properly structured, non null, and correctly constructed ‘.json’ file [\#4387](https://github.com/nlohmann/json/issues/4387)
|
||||||
|
- JSON\_BuildTests fail when JSON\_DisableEnumSerialization is set to ON [\#4384](https://github.com/nlohmann/json/issues/4384)
|
||||||
|
- JSON can't parse a simple data [\#4383](https://github.com/nlohmann/json/issues/4383)
|
||||||
|
- json.exception.type\_error.302 [\#4373](https://github.com/nlohmann/json/issues/4373)
|
||||||
|
- iteration\_proxy has limited usefulness in C++20 range views [\#4371](https://github.com/nlohmann/json/issues/4371)
|
||||||
|
- Clone is long due to large history [\#4370](https://github.com/nlohmann/json/issues/4370)
|
||||||
|
- Can't use nlohmann on Linux [\#4363](https://github.com/nlohmann/json/issues/4363)
|
||||||
|
- CodeQL suppressions lack justification [\#4361](https://github.com/nlohmann/json/issues/4361)
|
||||||
|
- \[json.exception.parse\_error.101\] parse error at line 1, column 4520: syntax error while parsing value - invalid string: forbidden character after backslash; last read: '".\? [\#4352](https://github.com/nlohmann/json/issues/4352)
|
||||||
|
- Cannot unflatten json object [\#4349](https://github.com/nlohmann/json/issues/4349)
|
||||||
|
- Json parsed from raw string does not interpret lists of objects like json parsed from file [\#4341](https://github.com/nlohmann/json/issues/4341)
|
||||||
|
- natvis not updated to 3.11.3 [\#4340](https://github.com/nlohmann/json/issues/4340)
|
||||||
|
- Wrong function name in documentation example [\#4334](https://github.com/nlohmann/json/issues/4334)
|
||||||
|
- git ref got interpreted as number [\#4332](https://github.com/nlohmann/json/issues/4332)
|
||||||
|
- Is float valid number been limited? [\#4322](https://github.com/nlohmann/json/issues/4322)
|
||||||
|
- Crash when construct a new json object [\#4321](https://github.com/nlohmann/json/issues/4321)
|
||||||
|
- gdb-pretty-print broken since m\_data added [\#4309](https://github.com/nlohmann/json/issues/4309)
|
||||||
|
- Docs have incorrect info for `update()` [\#4307](https://github.com/nlohmann/json/issues/4307)
|
||||||
|
- CBOR data cannot be decoded [\#4301](https://github.com/nlohmann/json/issues/4301)
|
||||||
|
- Inconsistent behaviour of json construction using `std::initializer_list` [\#4299](https://github.com/nlohmann/json/issues/4299)
|
||||||
|
- Assertion failed when accessing non-existing object with const json object [\#4297](https://github.com/nlohmann/json/issues/4297)
|
||||||
|
- Validatable release artifacts are not sufficient for packaging \(trying to run tests\) [\#4296](https://github.com/nlohmann/json/issues/4296)
|
||||||
|
- ordered json pointer corruption [\#4289](https://github.com/nlohmann/json/issues/4289)
|
||||||
|
- Incorrect floating point parsing [\#4285](https://github.com/nlohmann/json/issues/4285)
|
||||||
|
- Segfault on parse when using "\#pragma pack \(push, 1\)" [\#4284](https://github.com/nlohmann/json/issues/4284)
|
||||||
|
- Simple example with nlohmann::ordered\_json doesn't compile [\#4282](https://github.com/nlohmann/json/issues/4282)
|
||||||
|
- Program crashes with ordered\_json, but works fine with json [\#4279](https://github.com/nlohmann/json/issues/4279)
|
||||||
|
- JSON parses as array when assigned in initializer list. [\#4278](https://github.com/nlohmann/json/issues/4278)
|
||||||
|
- Can't run `make amalgamate` [\#4275](https://github.com/nlohmann/json/issues/4275)
|
||||||
|
- Parsing the unicode string got the wrong result [\#4272](https://github.com/nlohmann/json/issues/4272)
|
||||||
|
- Issue with including \<version\> [\#4241](https://github.com/nlohmann/json/issues/4241)
|
||||||
|
- Exception when trying to insert my json object inside json file [\#4239](https://github.com/nlohmann/json/issues/4239)
|
||||||
|
- `to_json` is erroneously converting enums with underlying unsigned types to signed numbers [\#4236](https://github.com/nlohmann/json/issues/4236)
|
||||||
|
- Build failure on macOS Sonoma 14.1.1 [\#4228](https://github.com/nlohmann/json/issues/4228)
|
||||||
|
- Deprecation warning on save action in check-amalgamation CI step [\#4227](https://github.com/nlohmann/json/issues/4227)
|
||||||
|
- 3.11.3: test suite fails in 4 units [\#4224](https://github.com/nlohmann/json/issues/4224)
|
||||||
|
- Exception thrown when dumping utf-8 characters when using std::string [\#4213](https://github.com/nlohmann/json/issues/4213)
|
||||||
|
- patch\_inplace assumes StringType is std::string [\#4134](https://github.com/nlohmann/json/issues/4134)
|
||||||
|
- Getting a weak-vtables warning with clang on ubuntu 22.04 [\#4087](https://github.com/nlohmann/json/issues/4087)
|
||||||
|
- SAX interface unexpectedly gets locale-altered float representation. [\#4084](https://github.com/nlohmann/json/issues/4084)
|
||||||
|
- Feat: hash pin github workflow dependencies [\#4058](https://github.com/nlohmann/json/issues/4058)
|
||||||
|
- compiler error using clang-16.0.5 when using gcc-13.1 standard library [\#4051](https://github.com/nlohmann/json/issues/4051)
|
||||||
|
- Missing requirement on `plantuml` binary package [\#4026](https://github.com/nlohmann/json/issues/4026)
|
||||||
|
- Compile failure for macos 10.10 SDK + darwin14 [\#3991](https://github.com/nlohmann/json/issues/3991)
|
||||||
|
- Test suite does not compile with C++20 and Clang 17 [\#3979](https://github.com/nlohmann/json/issues/3979)
|
||||||
|
- `modernize-avoid-c-arrays` clang-tidy warning when using `NLOHMANN_JSON_SERIALIZE_ENUM` macro [\#3924](https://github.com/nlohmann/json/issues/3924)
|
||||||
|
- JSON\_DIAGNOSTICS trigger assertion [\#3915](https://github.com/nlohmann/json/issues/3915)
|
||||||
|
- Compiler warning 'array-bounds' on g++12.2.0 on Ubuntu 22.10 kinetic with RelWithDebugInfo [\#3808](https://github.com/nlohmann/json/issues/3808)
|
||||||
|
- The MSVC team recently test JSON project failed to run test on release configuration on windows\_x64. [\#3542](https://github.com/nlohmann/json/issues/3542)
|
||||||
|
- Bad JSON diff when removing object in array of object [\#3146](https://github.com/nlohmann/json/issues/3146)
|
||||||
|
- Limit AppVeyor use [\#3089](https://github.com/nlohmann/json/issues/3089)
|
||||||
|
- pkgconfig integration wrongly rendered if tests are run [\#2907](https://github.com/nlohmann/json/issues/2907)
|
||||||
|
- Compile error for json in template and variadic macros. [\#2794](https://github.com/nlohmann/json/issues/2794)
|
||||||
|
- How to Serialize derived class to JSON object? [\#2199](https://github.com/nlohmann/json/issues/2199)
|
||||||
|
- \[C++17\] Allow std::optional to convert to nlohmann::json [\#1749](https://github.com/nlohmann/json/issues/1749)
|
||||||
|
|
||||||
|
- Fix typo in nlohmann\_define\_derived\_type.md [\#4565](https://github.com/nlohmann/json/pull/4565) ([gregmarr](https://github.com/gregmarr))
|
||||||
|
- Add ONLY\_SERIALIZE for NLOHMANN\_DEFINE\_DERIVED\_TYPE\_\* macros [\#4562](https://github.com/nlohmann/json/pull/4562) ([EinarsNG](https://github.com/EinarsNG))
|
||||||
|
- Suppress modernize-use-integer-sign-comparison [\#4558](https://github.com/nlohmann/json/pull/4558) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Bump actions/upload-artifact from 4.4.3 to 4.5.0 [\#4557](https://github.com/nlohmann/json/pull/4557) ([dependabot[bot]](https://github.com/apps/dependabot))
|
||||||
|
- Clean up CI [\#4553](https://github.com/nlohmann/json/pull/4553) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- \[StepSecurity\] ci: Harden GitHub Actions [\#4551](https://github.com/nlohmann/json/pull/4551) ([step-security-bot](https://github.com/step-security-bot))
|
||||||
|
- Fix token permissions warnings [\#4550](https://github.com/nlohmann/json/pull/4550) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Add step to build the documentation [\#4549](https://github.com/nlohmann/json/pull/4549) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Bump mkdocs-material from 9.5.48 to 9.5.49 in /docs/mkdocs [\#4548](https://github.com/nlohmann/json/pull/4548) ([dependabot[bot]](https://github.com/apps/dependabot))
|
||||||
|
- Move reuse dependency to requirements.txt file [\#4547](https://github.com/nlohmann/json/pull/4547) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Clean up [\#4546](https://github.com/nlohmann/json/pull/4546) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- ⬆️ Bump ossf/scorecard-action from 2.3.3 to 2.4.0 [\#4545](https://github.com/nlohmann/json/pull/4545) ([dependabot[bot]](https://github.com/apps/dependabot))
|
||||||
|
- ⬆️ Bump lukka/get-cmake from 3.31.0 to 3.31.2 [\#4544](https://github.com/nlohmann/json/pull/4544) ([dependabot[bot]](https://github.com/apps/dependabot))
|
||||||
|
- ⬆️ Bump github/codeql-action from 2.27.9 to 3.27.9 [\#4543](https://github.com/nlohmann/json/pull/4543) ([dependabot[bot]](https://github.com/apps/dependabot))
|
||||||
|
- ⬆️ Bump watchdog from 2.1.7 to 6.0.0 in /tools/serve\_header [\#4542](https://github.com/nlohmann/json/pull/4542) ([dependabot[bot]](https://github.com/apps/dependabot))
|
||||||
|
- ⬆️ Bump pyyaml from 6.0 to 6.0.2 in /tools/serve\_header [\#4541](https://github.com/nlohmann/json/pull/4541) ([dependabot[bot]](https://github.com/apps/dependabot))
|
||||||
|
- ⬆️ Bump actions/github-script from 6.4.0 to 7.0.1 [\#4540](https://github.com/nlohmann/json/pull/4540) ([dependabot[bot]](https://github.com/apps/dependabot))
|
||||||
|
- \[StepSecurity\] Apply security best practices [\#4539](https://github.com/nlohmann/json/pull/4539) ([step-security-bot](https://github.com/step-security-bot))
|
||||||
|
- Set parents after insert call [\#4537](https://github.com/nlohmann/json/pull/4537) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Allow patch and diff to be used with arbitrary string types [\#4536](https://github.com/nlohmann/json/pull/4536) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Add more package managers [\#4533](https://github.com/nlohmann/json/pull/4533) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Replace EOF with char\_traits [\#4532](https://github.com/nlohmann/json/pull/4532) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Fix return value of get\_ptr for unsigned integers [\#4525](https://github.com/nlohmann/json/pull/4525) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Add more GCC warning flags [\#4524](https://github.com/nlohmann/json/pull/4524) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Update licenses [\#4521](https://github.com/nlohmann/json/pull/4521) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- json start/end position implementation [\#4517](https://github.com/nlohmann/json/pull/4517) ([sushshring](https://github.com/sushshring))
|
||||||
|
- Overwork documentation [\#4516](https://github.com/nlohmann/json/pull/4516) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Allow comparing default initialized iterators [\#4512](https://github.com/nlohmann/json/pull/4512) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- fix: integer parsed as float when EINTR set in errno [\#4506](https://github.com/nlohmann/json/pull/4506) ([StuartGorman](https://github.com/StuartGorman))
|
||||||
|
- Make SAX output locale-independent [\#4505](https://github.com/nlohmann/json/pull/4505) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Skip enum tests when JSON\_DisableEnumSerialization=ON [\#4504](https://github.com/nlohmann/json/pull/4504) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Fix weak-vtables warning [\#4500](https://github.com/nlohmann/json/pull/4500) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Suppress warnings in NLOHMANN\_JSON\_SERIALIZE\_ENUM [\#4497](https://github.com/nlohmann/json/pull/4497) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Add comment for \#4494 [\#4496](https://github.com/nlohmann/json/pull/4496) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Add test for libstdc++ [\#4495](https://github.com/nlohmann/json/pull/4495) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Another desperate try to fix the CI [\#4489](https://github.com/nlohmann/json/pull/4489) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Possible fix for \#4485 [\#4487](https://github.com/nlohmann/json/pull/4487) ([jordan-hoang](https://github.com/jordan-hoang))
|
||||||
|
- Update CONTRIBUTING.md [\#4486](https://github.com/nlohmann/json/pull/4486) ([zerocukor287](https://github.com/zerocukor287))
|
||||||
|
- Allow overriding the CMake target name [\#4483](https://github.com/nlohmann/json/pull/4483) ([iboB](https://github.com/iboB))
|
||||||
|
- Update is\_structured.md [\#4472](https://github.com/nlohmann/json/pull/4472) ([thetimr](https://github.com/thetimr))
|
||||||
|
- Add CPack support [\#4459](https://github.com/nlohmann/json/pull/4459) ([zjyhjqs](https://github.com/zjyhjqs))
|
||||||
|
- CMake: generate a pkg-config file that follow pkg-config conventions [\#4456](https://github.com/nlohmann/json/pull/4456) ([dcbaker](https://github.com/dcbaker))
|
||||||
|
- Update natvis to reflect 3.11.3 and the current structure of basic\_json [\#4451](https://github.com/nlohmann/json/pull/4451) ([gmyers18](https://github.com/gmyers18))
|
||||||
|
- Docs: fix typos of 'whether' in `operator_{gt,le,lt}.md` [\#4412](https://github.com/nlohmann/json/pull/4412) ([tsnl](https://github.com/tsnl))
|
||||||
|
- Remove alwayslink=True Bazel flag [\#4396](https://github.com/nlohmann/json/pull/4396) ([mering](https://github.com/mering))
|
||||||
|
- Optimize binary `get_number` implementation by reading multiple bytes at once [\#4391](https://github.com/nlohmann/json/pull/4391) ([TianyiChen](https://github.com/TianyiChen))
|
||||||
|
- Make iterator\_proxy\_value a forward\_iterator \(\#4371\) [\#4372](https://github.com/nlohmann/json/pull/4372) ([captaincrutches](https://github.com/captaincrutches))
|
||||||
|
- Add lgtm explanation [\#4362](https://github.com/nlohmann/json/pull/4362) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- chore: fix some typos in comments [\#4345](https://github.com/nlohmann/json/pull/4345) ([laterlaugh](https://github.com/laterlaugh))
|
||||||
|
- Fix gdb pretty printer [\#4343](https://github.com/nlohmann/json/pull/4343) ([MrJia1997](https://github.com/MrJia1997))
|
||||||
|
- Fix for incorrect function name in documentation example [\#4342](https://github.com/nlohmann/json/pull/4342) ([alexprabhat99](https://github.com/alexprabhat99))
|
||||||
|
- Fixed an error in the `Custom data source` example. [\#4335](https://github.com/nlohmann/json/pull/4335) ([philip-paul-mueller](https://github.com/philip-paul-mueller))
|
||||||
|
- Updated exception handling to catch const reference in out\_of\_range [\#4331](https://github.com/nlohmann/json/pull/4331) ([LeilaShcheglova](https://github.com/LeilaShcheglova))
|
||||||
|
- \#4307 Updated docx to 3.10.5 from 3.10.4 [\#4310](https://github.com/nlohmann/json/pull/4310) ([AniketDhemare](https://github.com/AniketDhemare))
|
||||||
|
- Align astyle flags in Makefile with CI [\#4277](https://github.com/nlohmann/json/pull/4277) ([serge-s](https://github.com/serge-s))
|
||||||
|
- Suppress Clang-Tidy warnings [\#4276](https://github.com/nlohmann/json/pull/4276) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Remove broken link from CONTRIBUTING.md [\#4274](https://github.com/nlohmann/json/pull/4274) ([serge-s](https://github.com/serge-s))
|
||||||
|
- Fix version in json\_has\_static\_rtti.md [\#4269](https://github.com/nlohmann/json/pull/4269) ([ALF-ONE](https://github.com/ALF-ONE))
|
||||||
|
- Add support of multi-dim C-style array member of struct. [\#4262](https://github.com/nlohmann/json/pull/4262) ([peng-wang-cn](https://github.com/peng-wang-cn))
|
||||||
|
- Docs: Fix wrong code usage in the Value access section of `json_pointer.md` [\#4255](https://github.com/nlohmann/json/pull/4255) ([Fallen-Breath](https://github.com/Fallen-Breath))
|
||||||
|
- Fix `to_json` for enums when the enum has an unsigned underlying type. [\#4237](https://github.com/nlohmann/json/pull/4237) ([TheJCAB](https://github.com/TheJCAB))
|
||||||
|
- feat: Rebase `feature/optional` to `develop` [\#4036](https://github.com/nlohmann/json/pull/4036) ([fsandhei](https://github.com/fsandhei))
|
||||||
|
- Add NLOHMANN\_DEFINE\_DERIVED\_TYPE\_\* macros [\#4033](https://github.com/nlohmann/json/pull/4033) ([rotolof](https://github.com/rotolof))
|
||||||
|
|
||||||
|
## [v3.11.3](https://github.com/nlohmann/json/releases/tag/v3.11.3) (2023-11-28)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/nlohmann/json/compare/v3.11.2...v3.11.3)
|
||||||
|
|
||||||
|
- Parser and constructor resolve integer types differently [\#4207](https://github.com/nlohmann/json/issues/4207)
|
||||||
|
- README.md overuses `template` keyword before `get` function [\#4205](https://github.com/nlohmann/json/issues/4205)
|
||||||
|
- Exception SIGSEGV - Segmentation violation signal on file parsing \(v3.11.2, linux, doctest\) [\#4193](https://github.com/nlohmann/json/issues/4193)
|
||||||
|
- In highly nested functions, passing json into a function leads to a segmentation fault/bus error [\#4186](https://github.com/nlohmann/json/issues/4186)
|
||||||
|
- why a single-object json file appears in an array [\#4183](https://github.com/nlohmann/json/issues/4183)
|
||||||
|
- Initializing `json` by direct initialization and copy initialization invokes different constructors [\#4174](https://github.com/nlohmann/json/issues/4174)
|
||||||
|
- Deprecation warning about std::char\_traits\<unsigned char\> [\#4163](https://github.com/nlohmann/json/issues/4163)
|
||||||
|
- LLVM 16.0.6 issues warning for literal operators when Wdeprecated-literal-operator [\#4129](https://github.com/nlohmann/json/issues/4129)
|
||||||
|
- GCC compiler warning about violating the C++ One Definition Rule \[-Wodr\] [\#4116](https://github.com/nlohmann/json/issues/4116)
|
||||||
|
- error: building nlohmann-json:arm64-osx failed with: BUILD\_FAILED [\#4091](https://github.com/nlohmann/json/issues/4091)
|
||||||
|
- dump\(\): Non-conforming with JSON-spec escape of strings? [\#4088](https://github.com/nlohmann/json/issues/4088)
|
||||||
|
- Compiling in visual studio 2022 gives a warning [\#4081](https://github.com/nlohmann/json/issues/4081)
|
||||||
|
- Upgrade CMake minimum version [\#4076](https://github.com/nlohmann/json/issues/4076)
|
||||||
|
- \ character in the content of a string cause error in parser.? [\#4067](https://github.com/nlohmann/json/issues/4067)
|
||||||
|
- JSON Parsing Freeze Issue on Nintendo Switch [\#4066](https://github.com/nlohmann/json/issues/4066)
|
||||||
|
- Clang++ compilation fails on extremely small example [\#4061](https://github.com/nlohmann/json/issues/4061)
|
||||||
|
- how about open a new repository for header only version? [\#4060](https://github.com/nlohmann/json/issues/4060)
|
||||||
|
- json::count returns only 0 or 1 [\#4052](https://github.com/nlohmann/json/issues/4052)
|
||||||
|
- std::function error [\#4050](https://github.com/nlohmann/json/issues/4050)
|
||||||
|
- Json package not compiling properly [\#4042](https://github.com/nlohmann/json/issues/4042)
|
||||||
|
- Explicit conversion example in docs should use `template get` [\#4038](https://github.com/nlohmann/json/issues/4038)
|
||||||
|
- Improve wording of parse\_error exception [\#4037](https://github.com/nlohmann/json/issues/4037)
|
||||||
|
- Parse error on valid JSON file [\#4028](https://github.com/nlohmann/json/issues/4028)
|
||||||
|
- Empty JSON object returns size of 1 [\#4027](https://github.com/nlohmann/json/issues/4027)
|
||||||
|
- Help needed to fix CI [\#4025](https://github.com/nlohmann/json/issues/4025)
|
||||||
|
- Security vulnerabilities detected: CVE-2022-24439, WS-2022-0438, WS-2022-0437 [\#4020](https://github.com/nlohmann/json/issues/4020)
|
||||||
|
- multithreading use from\_msgpack leading very slow [\#4016](https://github.com/nlohmann/json/issues/4016)
|
||||||
|
- Error with sol for Lua: items\(\) is not a recognized container [\#4012](https://github.com/nlohmann/json/issues/4012)
|
||||||
|
- Parser does not read non ascii characters : ŞÜİĞ [\#4007](https://github.com/nlohmann/json/issues/4007)
|
||||||
|
- malloc\(\): unaligned fastbin chunk detected [\#3999](https://github.com/nlohmann/json/issues/3999)
|
||||||
|
- try/catch block doesn't work while accessing const json& array. [\#3998](https://github.com/nlohmann/json/issues/3998)
|
||||||
|
- a bug about list [\#3995](https://github.com/nlohmann/json/issues/3995)
|
||||||
|
- heap corruption when i use nlohmann::json::accept function to check a valid json [\#3994](https://github.com/nlohmann/json/issues/3994)
|
||||||
|
- Exception on gcc but not apple clang [\#3986](https://github.com/nlohmann/json/issues/3986)
|
||||||
|
- Can't support convert the type? std::string json\_str = R"\({"value": "3.1415"}\)"; float value = j\["value"\].get\<float\>\(\); [\#3984](https://github.com/nlohmann/json/issues/3984)
|
||||||
|
- `#pragma once` not supported with C++20 modules in clang [\#3974](https://github.com/nlohmann/json/issues/3974)
|
||||||
|
- const array\_t::operator\[\] results in buffer overflow / segv on nullptr on out of bounds access [\#3973](https://github.com/nlohmann/json/issues/3973)
|
||||||
|
- Set minimal permissions to Github Workflows [\#3971](https://github.com/nlohmann/json/issues/3971)
|
||||||
|
- Parsing array error [\#3968](https://github.com/nlohmann/json/issues/3968)
|
||||||
|
- why I can return tuple as json? [\#3961](https://github.com/nlohmann/json/issues/3961)
|
||||||
|
- type must be number, but is null [\#3956](https://github.com/nlohmann/json/issues/3956)
|
||||||
|
- Class Composition of json members produces incorrect json when constructing with initialization list [\#3955](https://github.com/nlohmann/json/issues/3955)
|
||||||
|
- exit without error message [\#3948](https://github.com/nlohmann/json/issues/3948)
|
||||||
|
- NLOHMANN\_DEFINE\_TYPE\_INTRUSIVE doesn't work with "json\_fwd.hpp" [\#3946](https://github.com/nlohmann/json/issues/3946)
|
||||||
|
- Dangerous use of pull\_request\_target [\#3945](https://github.com/nlohmann/json/issues/3945)
|
||||||
|
- Test \#7: test-bjdata\_cpp11 ............................\*\*\*Failed [\#3941](https://github.com/nlohmann/json/issues/3941)
|
||||||
|
- Memory leak detection with basic usage of NLOHMANN\_JSON\_SERIALIZE\_ENUM [\#3939](https://github.com/nlohmann/json/issues/3939)
|
||||||
|
- Parse doesnt work [\#3936](https://github.com/nlohmann/json/issues/3936)
|
||||||
|
- Clean up badges [\#3935](https://github.com/nlohmann/json/issues/3935)
|
||||||
|
- \[json.exception.type\_error.305\] cannot use operator\[\] with a string argument with array [\#3931](https://github.com/nlohmann/json/issues/3931)
|
||||||
|
- GCC 13 build failures [\#3927](https://github.com/nlohmann/json/issues/3927)
|
||||||
|
- Exception throw even though code is inside try/catch [\#3926](https://github.com/nlohmann/json/issues/3926)
|
||||||
|
- Please fix failing tests [\#3923](https://github.com/nlohmann/json/issues/3923)
|
||||||
|
- Security vulnerability in dependency: future 0.18.2 [\#3922](https://github.com/nlohmann/json/issues/3922)
|
||||||
|
- json pretty printer causes python exceptions on non-json types [\#3919](https://github.com/nlohmann/json/issues/3919)
|
||||||
|
- how does a normal basic\_json\<\> object cuase assertion `false` [\#3918](https://github.com/nlohmann/json/issues/3918)
|
||||||
|
- The library can not parse JSON generate by Chome DevTools Protocol [\#3903](https://github.com/nlohmann/json/issues/3903)
|
||||||
|
- Typo in `cmake/test.cmake` [\#3902](https://github.com/nlohmann/json/issues/3902)
|
||||||
|
- Parser adds wrapping array when compiled with GCC [\#3897](https://github.com/nlohmann/json/issues/3897)
|
||||||
|
- when i use for\(auto iter& : jsonObject\) it occure some error [\#3893](https://github.com/nlohmann/json/issues/3893)
|
||||||
|
- Check Drone CI [\#3890](https://github.com/nlohmann/json/issues/3890)
|
||||||
|
- Json::accept\(std::ifstream\) [\#3884](https://github.com/nlohmann/json/issues/3884)
|
||||||
|
- \[json.exception.parse\_error.101\] parse error at line 1, column 1: syntax error while parsing value - unexpected end of input; expected '\[', '{', or a literal [\#3882](https://github.com/nlohmann/json/issues/3882)
|
||||||
|
- Memory leak when exception is thrown in adl\_serializer::to\_json [\#3881](https://github.com/nlohmann/json/issues/3881)
|
||||||
|
- building with cmake [\#3880](https://github.com/nlohmann/json/issues/3880)
|
||||||
|
- \[json.exception.type\_error.316\] invalid UTF-8 byte at index 0: 0xB6 [\#3879](https://github.com/nlohmann/json/issues/3879)
|
||||||
|
- Visual Studio 2015 C2664 error std::pair\< [\#3867](https://github.com/nlohmann/json/issues/3867)
|
||||||
|
- I want the data field to be empty serialized and deserialized to each other [\#3866](https://github.com/nlohmann/json/issues/3866)
|
||||||
|
- Generated natvis is invalid XML [\#3858](https://github.com/nlohmann/json/issues/3858)
|
||||||
|
- Json Arrays have inconsistent nesting levels across different OSs [\#3854](https://github.com/nlohmann/json/issues/3854)
|
||||||
|
- Occur error when parse character '\' [\#3844](https://github.com/nlohmann/json/issues/3844)
|
||||||
|
- Proccess crash as soon as I parse json [\#3843](https://github.com/nlohmann/json/issues/3843)
|
||||||
|
- json::parse and constructor with the same json generates different type [\#3842](https://github.com/nlohmann/json/issues/3842)
|
||||||
|
- json::accept return false on valid JSON [\#3838](https://github.com/nlohmann/json/issues/3838)
|
||||||
|
- decode\(state, codep, byte\) generates warnings. [\#3837](https://github.com/nlohmann/json/issues/3837)
|
||||||
|
- Arithmetic operators are not working as expected [\#3832](https://github.com/nlohmann/json/issues/3832)
|
||||||
|
- array\_index does not catch std::invalid\_argument exception from std::stoull [\#3831](https://github.com/nlohmann/json/issues/3831)
|
||||||
|
- 3.11.2: test suite is failing in two units [\#3828](https://github.com/nlohmann/json/issues/3828)
|
||||||
|
- Compile Error on g++ using get\(\) function [\#3827](https://github.com/nlohmann/json/issues/3827)
|
||||||
|
- nlohmann::json::parse can't handle the "€" symbol. [\#3825](https://github.com/nlohmann/json/issues/3825)
|
||||||
|
- When reading a non-existent key, I unexpectedly get a value. Is it the wrong way I use it? [\#3811](https://github.com/nlohmann/json/issues/3811)
|
||||||
|
- Code analysis warning string\_concat.hpp C26800: Use of a moved from object [\#3805](https://github.com/nlohmann/json/issues/3805)
|
||||||
|
- The code used to build with 3.10.2 but fails now [\#3804](https://github.com/nlohmann/json/issues/3804)
|
||||||
|
- Inconsistent Behaviour of NaN & Null Values [\#3799](https://github.com/nlohmann/json/issues/3799)
|
||||||
|
- json\_fwd.hpp doesn't work [\#3796](https://github.com/nlohmann/json/issues/3796)
|
||||||
|
- Compilation fails in MSVC 22 [\#3787](https://github.com/nlohmann/json/issues/3787)
|
||||||
|
- parsing json with missing key throws exception [\#3784](https://github.com/nlohmann/json/issues/3784)
|
||||||
|
- Allow to disable inline namespaces completley [\#3746](https://github.com/nlohmann/json/issues/3746)
|
||||||
|
- double free or Assertion failed! [\#3729](https://github.com/nlohmann/json/issues/3729)
|
||||||
|
- Amalgated json\_fwd.hpp not included in include.zip [\#3727](https://github.com/nlohmann/json/issues/3727)
|
||||||
|
- INT64\_MIN/MAX not defined for newer g++ [\#3722](https://github.com/nlohmann/json/issues/3722)
|
||||||
|
- Compilation error with JSON\_DIAGNOSTICS enabled [\#3717](https://github.com/nlohmann/json/issues/3717)
|
||||||
|
- class-level enum not serialized as string via NLOHMANN\_JSON\_SERIALIZE\_ENUM [\#3715](https://github.com/nlohmann/json/issues/3715)
|
||||||
|
- Local copy given by operator\[\] or at\(\) [\#3704](https://github.com/nlohmann/json/issues/3704)
|
||||||
|
- nlohmann::to\_json method not acting as expected with nlohmann::adl\_serializer specialization. [\#3340](https://github.com/nlohmann/json/issues/3340)
|
||||||
|
- braced-init-list: array vs other constructor [\#2583](https://github.com/nlohmann/json/issues/2583)
|
||||||
|
|
||||||
|
- JSON for Modern C++ 3.11.3 [\#4222](https://github.com/nlohmann/json/pull/4222) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Update documentation for the next release [\#4216](https://github.com/nlohmann/json/pull/4216) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Fix failing CI checks [\#4215](https://github.com/nlohmann/json/pull/4215) ([colbychaskell](https://github.com/colbychaskell))
|
||||||
|
- Fix CI \(again\) [\#4196](https://github.com/nlohmann/json/pull/4196) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- fix cmake header path in install with custom CMAKE\_INSTALL\_INCLUDEDIR [\#4194](https://github.com/nlohmann/json/pull/4194) ([bebuch](https://github.com/bebuch))
|
||||||
|
- Add more specific error message when attempting to parse empty input [\#4180](https://github.com/nlohmann/json/pull/4180) ([colbychaskell](https://github.com/colbychaskell))
|
||||||
|
- Fix char\_traits deprecation warning [\#4179](https://github.com/nlohmann/json/pull/4179) ([colbychaskell](https://github.com/colbychaskell))
|
||||||
|
- Fix MinGW CI [\#4175](https://github.com/nlohmann/json/pull/4175) ([scribam](https://github.com/scribam))
|
||||||
|
- Fix spellcheck issue [\#4173](https://github.com/nlohmann/json/pull/4173) ([mwestphal](https://github.com/mwestphal))
|
||||||
|
- Fix source highlighting in user defined type macros docs [\#4169](https://github.com/nlohmann/json/pull/4169) ([ZeronSix](https://github.com/ZeronSix))
|
||||||
|
- Fix deprecation warning [\#4161](https://github.com/nlohmann/json/pull/4161) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Fix CI [\#4160](https://github.com/nlohmann/json/pull/4160) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Update index.md [\#4159](https://github.com/nlohmann/json/pull/4159) ([miny1233](https://github.com/miny1233))
|
||||||
|
- Update index.md [\#4149](https://github.com/nlohmann/json/pull/4149) ([HO-COOH](https://github.com/HO-COOH))
|
||||||
|
- Correct a typo in serve\_header/README.md [\#4143](https://github.com/nlohmann/json/pull/4143) ([felixonmars](https://github.com/felixonmars))
|
||||||
|
- Fixed init-list construction when size\_type is not int [\#4140](https://github.com/nlohmann/json/pull/4140) ([tomalakgeretkal](https://github.com/tomalakgeretkal))
|
||||||
|
- Update CODEOWNERS [\#4126](https://github.com/nlohmann/json/pull/4126) ([tarolling](https://github.com/tarolling))
|
||||||
|
- Accept NEW CMake policies up to CMake 3.14 [\#4112](https://github.com/nlohmann/json/pull/4112) ([craigscott-crascit](https://github.com/craigscott-crascit))
|
||||||
|
- Fix typo in afl\_driver.cpp [\#4109](https://github.com/nlohmann/json/pull/4109) ([eltociear](https://github.com/eltociear))
|
||||||
|
- Capture exceptions by const& in docs. [\#4099](https://github.com/nlohmann/json/pull/4099) ([iwanders](https://github.com/iwanders))
|
||||||
|
- Fix CI, again [\#4083](https://github.com/nlohmann/json/pull/4083) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Fix Clang-Tidy warnings [\#4047](https://github.com/nlohmann/json/pull/4047) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Fix compile error with \_HAS\_STATIC\_RTTI=0 [\#4046](https://github.com/nlohmann/json/pull/4046) ([ALF-ONE](https://github.com/ALF-ONE))
|
||||||
|
- Add to CONTRIBUTING.md that `make pretty` is required for test updates. [\#4045](https://github.com/nlohmann/json/pull/4045) ([gregmarr](https://github.com/gregmarr))
|
||||||
|
- Added to tests the file unit-algorithm.cpp \(c++ 11\) functions from algorithm library [\#4044](https://github.com/nlohmann/json/pull/4044) ([Tomerkm](https://github.com/Tomerkm))
|
||||||
|
- Use template get instead of get in examples [\#4039](https://github.com/nlohmann/json/pull/4039) ([tusooa](https://github.com/tusooa))
|
||||||
|
- Support Apple's Swift Package Manager [\#4010](https://github.com/nlohmann/json/pull/4010) ([aleksproger](https://github.com/aleksproger))
|
||||||
|
- Add Vcpkg port version badge [\#3988](https://github.com/nlohmann/json/pull/3988) ([njakob](https://github.com/njakob))
|
||||||
|
- Fix CI + new Doctest [\#3985](https://github.com/nlohmann/json/pull/3985) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Set minimal permissions to Github Workflows [\#3972](https://github.com/nlohmann/json/pull/3972) ([joycebrum](https://github.com/joycebrum))
|
||||||
|
- Refactor amalgamation workflow to avoid dangerous use of pull\_request\_target [\#3969](https://github.com/nlohmann/json/pull/3969) ([joycebrum](https://github.com/joycebrum))
|
||||||
|
- Fix typo in test.cmake [\#3951](https://github.com/nlohmann/json/pull/3951) ([theevilone45](https://github.com/theevilone45))
|
||||||
|
- tests/unit-iterators2: use std::ranges::equals for range comparisons [\#3950](https://github.com/nlohmann/json/pull/3950) ([ArsenArsen](https://github.com/ArsenArsen))
|
||||||
|
- 3935, removed lgtm badge and added Cirrus CI badge [\#3937](https://github.com/nlohmann/json/pull/3937) ([haadfida](https://github.com/haadfida))
|
||||||
|
- ⬆️ Bump future from 0.18.2 to 0.18.3 in /docs/mkdocs [\#3934](https://github.com/nlohmann/json/pull/3934) ([dependabot[bot]](https://github.com/apps/dependabot))
|
||||||
|
- Change 2022 to 2023 [\#3932](https://github.com/nlohmann/json/pull/3932) ([floriansegginger](https://github.com/floriansegginger))
|
||||||
|
- PrettyPrinter: Check if match is valid before accessing group [\#3920](https://github.com/nlohmann/json/pull/3920) ([Finkman](https://github.com/Finkman))
|
||||||
|
- Fix CI issues [\#3906](https://github.com/nlohmann/json/pull/3906) ([barcode](https://github.com/barcode))
|
||||||
|
- Prevent memory leak when exception is thrown in adl\_serializer::to\_json [\#3901](https://github.com/nlohmann/json/pull/3901) ([barcode](https://github.com/barcode))
|
||||||
|
- custom allocators: define missing 'rebind' type [\#3895](https://github.com/nlohmann/json/pull/3895) ([trofi](https://github.com/trofi))
|
||||||
|
- Try old MinGW script [\#3892](https://github.com/nlohmann/json/pull/3892) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Upgrade Python packages [\#3891](https://github.com/nlohmann/json/pull/3891) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Fix warning about moved from object [\#3889](https://github.com/nlohmann/json/pull/3889) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Remove a magic number [\#3888](https://github.com/nlohmann/json/pull/3888) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Add migration guide [\#3887](https://github.com/nlohmann/json/pull/3887) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Clang 15 [\#3876](https://github.com/nlohmann/json/pull/3876) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Bump certifi from 2022.6.15 to 2022.12.7 in /docs/mkdocs [\#3872](https://github.com/nlohmann/json/pull/3872) ([dependabot[bot]](https://github.com/apps/dependabot))
|
||||||
|
- Fix natvis XML [\#3863](https://github.com/nlohmann/json/pull/3863) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Fix pipeline [\#3862](https://github.com/nlohmann/json/pull/3862) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Add CIFuzz CI GitHub action [\#3845](https://github.com/nlohmann/json/pull/3845) ([DavidKorczynski](https://github.com/DavidKorczynski))
|
||||||
|
- Add serialization-only user defined type macros [\#3816](https://github.com/nlohmann/json/pull/3816) ([ZeronSix](https://github.com/ZeronSix))
|
||||||
|
- Bump joblib from 1.1.0 to 1.2.0 in /docs/mkdocs [\#3781](https://github.com/nlohmann/json/pull/3781) ([dependabot[bot]](https://github.com/apps/dependabot))
|
||||||
|
- Fix some typos for n-dimensional arrays [\#3767](https://github.com/nlohmann/json/pull/3767) ([striezel](https://github.com/striezel))
|
||||||
|
- Fix 'declaration hides global declaration' warning [\#3751](https://github.com/nlohmann/json/pull/3751) ([falbrechtskirchinger](https://github.com/falbrechtskirchinger))
|
||||||
|
- Fix typos in .md files [\#3748](https://github.com/nlohmann/json/pull/3748) ([tocic](https://github.com/tocic))
|
||||||
|
- Update Codacy link [\#3740](https://github.com/nlohmann/json/pull/3740) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Add missing files to release artifacts [\#3728](https://github.com/nlohmann/json/pull/3728) ([falbrechtskirchinger](https://github.com/falbrechtskirchinger))
|
||||||
|
- Add dark mode toggle to documentation [\#3726](https://github.com/nlohmann/json/pull/3726) ([falbrechtskirchinger](https://github.com/falbrechtskirchinger))
|
||||||
|
- Add clang-tools to required tools for ci\_static\_analysis\_clang [\#3724](https://github.com/nlohmann/json/pull/3724) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Replace limit macros with std::numeric\_limits [\#3723](https://github.com/nlohmann/json/pull/3723) ([falbrechtskirchinger](https://github.com/falbrechtskirchinger))
|
||||||
|
- Add missing \<numeric\> include [\#3719](https://github.com/nlohmann/json/pull/3719) ([falbrechtskirchinger](https://github.com/falbrechtskirchinger))
|
||||||
|
- Add Bazel build support [\#3709](https://github.com/nlohmann/json/pull/3709) ([Vertexwahn](https://github.com/Vertexwahn))
|
||||||
|
- Use official Clang/GCC containers [\#3703](https://github.com/nlohmann/json/pull/3703) ([nlohmann](https://github.com/nlohmann))
|
||||||
|
- Add 'Check amalgamation' workflow [\#3693](https://github.com/nlohmann/json/pull/3693) ([falbrechtskirchinger](https://github.com/falbrechtskirchinger))
|
||||||
|
- Allow custom base class as node customization point [\#3110](https://github.com/nlohmann/json/pull/3110) ([barcode](https://github.com/barcode))
|
||||||
|
|
||||||
|
## [v3.11.2](https://github.com/nlohmann/json/releases/tag/v3.11.2) (2022-08-12)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/nlohmann/json/compare/v3.11.1...v3.11.2)
|
||||||
|
|
||||||
- MSVC natvis visualizer does not work after introduction of inline ABI namespace [\#3696](https://github.com/nlohmann/json/issues/3696)
|
- MSVC natvis visualizer does not work after introduction of inline ABI namespace [\#3696](https://github.com/nlohmann/json/issues/3696)
|
||||||
- The use of parenthesis gives compilation errors in some situations [\#3682](https://github.com/nlohmann/json/issues/3682)
|
- The use of parenthesis gives compilation errors in some situations [\#3682](https://github.com/nlohmann/json/issues/3682)
|
||||||
@ -145,7 +476,7 @@ All notable changes to this project will be documented in this file. This projec
|
|||||||
- Fix warning [\#3634](https://github.com/nlohmann/json/pull/3634) ([nlohmann](https://github.com/nlohmann))
|
- Fix warning [\#3634](https://github.com/nlohmann/json/pull/3634) ([nlohmann](https://github.com/nlohmann))
|
||||||
- Add license header to new files [\#3633](https://github.com/nlohmann/json/pull/3633) ([nlohmann](https://github.com/nlohmann))
|
- Add license header to new files [\#3633](https://github.com/nlohmann/json/pull/3633) ([nlohmann](https://github.com/nlohmann))
|
||||||
- Add a unit test including windows.h [\#3631](https://github.com/nlohmann/json/pull/3631) ([falbrechtskirchinger](https://github.com/falbrechtskirchinger))
|
- Add a unit test including windows.h [\#3631](https://github.com/nlohmann/json/pull/3631) ([falbrechtskirchinger](https://github.com/falbrechtskirchinger))
|
||||||
- Fixed latest build error in msvc platform [\#3630](https://github.com/nlohmann/json/pull/3630) ([KsaNL](https://github.com/KsaNL))
|
- Fixed latest build error in msvc platform [\#3630](https://github.com/nlohmann/json/pull/3630) ([Lioncky](https://github.com/Lioncky))
|
||||||
- Add regression tests for \#3204 and \#3333 [\#3629](https://github.com/nlohmann/json/pull/3629) ([falbrechtskirchinger](https://github.com/falbrechtskirchinger))
|
- Add regression tests for \#3204 and \#3333 [\#3629](https://github.com/nlohmann/json/pull/3629) ([falbrechtskirchinger](https://github.com/falbrechtskirchinger))
|
||||||
- Fix patch::add creating nonexistent parents [\#3628](https://github.com/nlohmann/json/pull/3628) ([falbrechtskirchinger](https://github.com/falbrechtskirchinger))
|
- Fix patch::add creating nonexistent parents [\#3628](https://github.com/nlohmann/json/pull/3628) ([falbrechtskirchinger](https://github.com/falbrechtskirchinger))
|
||||||
- Adjust JSON Pointer examples [\#3622](https://github.com/nlohmann/json/pull/3622) ([nlohmann](https://github.com/nlohmann))
|
- Adjust JSON Pointer examples [\#3622](https://github.com/nlohmann/json/pull/3622) ([nlohmann](https://github.com/nlohmann))
|
||||||
@ -178,7 +509,7 @@ All notable changes to this project will be documented in this file. This projec
|
|||||||
- Use REUSE framework [\#3546](https://github.com/nlohmann/json/pull/3546) ([nlohmann](https://github.com/nlohmann))
|
- Use REUSE framework [\#3546](https://github.com/nlohmann/json/pull/3546) ([nlohmann](https://github.com/nlohmann))
|
||||||
- Use `std::iterator_traits` to extract `iterator_category` [\#3544](https://github.com/nlohmann/json/pull/3544) ([Mike-Leo-Smith](https://github.com/Mike-Leo-Smith))
|
- Use `std::iterator_traits` to extract `iterator_category` [\#3544](https://github.com/nlohmann/json/pull/3544) ([Mike-Leo-Smith](https://github.com/Mike-Leo-Smith))
|
||||||
- BJData dimension length can not be string\_t::npos, fix \#3541 [\#3543](https://github.com/nlohmann/json/pull/3543) ([fangq](https://github.com/fangq))
|
- BJData dimension length can not be string\_t::npos, fix \#3541 [\#3543](https://github.com/nlohmann/json/pull/3543) ([fangq](https://github.com/fangq))
|
||||||
- Allow disabling default enum conversions [\#3536](https://github.com/nlohmann/json/pull/3536) ([zxey](https://github.com/zxey))
|
- Allow disabling default enum conversions [\#3536](https://github.com/nlohmann/json/pull/3536) ([richardhozak](https://github.com/richardhozak))
|
||||||
- Add to\_json\(\) for std::vector\<bool\>::reference [\#3534](https://github.com/nlohmann/json/pull/3534) ([falbrechtskirchinger](https://github.com/falbrechtskirchinger))
|
- Add to\_json\(\) for std::vector\<bool\>::reference [\#3534](https://github.com/nlohmann/json/pull/3534) ([falbrechtskirchinger](https://github.com/falbrechtskirchinger))
|
||||||
- CI: Enable 32bit unit test \(3\) [\#3532](https://github.com/nlohmann/json/pull/3532) ([falbrechtskirchinger](https://github.com/falbrechtskirchinger))
|
- CI: Enable 32bit unit test \(3\) [\#3532](https://github.com/nlohmann/json/pull/3532) ([falbrechtskirchinger](https://github.com/falbrechtskirchinger))
|
||||||
- Use new CI image [\#3528](https://github.com/nlohmann/json/pull/3528) ([nlohmann](https://github.com/nlohmann))
|
- Use new CI image [\#3528](https://github.com/nlohmann/json/pull/3528) ([nlohmann](https://github.com/nlohmann))
|
||||||
@ -639,7 +970,6 @@ All notable changes to this project will be documented in this file. This projec
|
|||||||
- array\_index possible out of range [\#2205](https://github.com/nlohmann/json/issues/2205)
|
- array\_index possible out of range [\#2205](https://github.com/nlohmann/json/issues/2205)
|
||||||
- Object deserialized as array [\#2204](https://github.com/nlohmann/json/issues/2204)
|
- Object deserialized as array [\#2204](https://github.com/nlohmann/json/issues/2204)
|
||||||
- Sending to a function a reference to a sub-branch [\#2200](https://github.com/nlohmann/json/issues/2200)
|
- Sending to a function a reference to a sub-branch [\#2200](https://github.com/nlohmann/json/issues/2200)
|
||||||
- How to Serialize derived class to JSON object? [\#2199](https://github.com/nlohmann/json/issues/2199)
|
|
||||||
- JSON incorrectly serialized [\#2198](https://github.com/nlohmann/json/issues/2198)
|
- JSON incorrectly serialized [\#2198](https://github.com/nlohmann/json/issues/2198)
|
||||||
- Exception Unhandled out\_of\_range error [\#2197](https://github.com/nlohmann/json/issues/2197)
|
- Exception Unhandled out\_of\_range error [\#2197](https://github.com/nlohmann/json/issues/2197)
|
||||||
- msgpack serialisation : float is treated as 64bit float, not 32bit float. [\#2196](https://github.com/nlohmann/json/issues/2196)
|
- msgpack serialisation : float is treated as 64bit float, not 32bit float. [\#2196](https://github.com/nlohmann/json/issues/2196)
|
||||||
@ -672,7 +1002,6 @@ All notable changes to this project will be documented in this file. This projec
|
|||||||
- Compilation failure using Clang on Windows [\#1898](https://github.com/nlohmann/json/issues/1898)
|
- Compilation failure using Clang on Windows [\#1898](https://github.com/nlohmann/json/issues/1898)
|
||||||
- Fail to build when including json.hpp as a system include [\#1818](https://github.com/nlohmann/json/issues/1818)
|
- Fail to build when including json.hpp as a system include [\#1818](https://github.com/nlohmann/json/issues/1818)
|
||||||
- Parsing string into json doesn't preserve the order correctly. [\#1817](https://github.com/nlohmann/json/issues/1817)
|
- Parsing string into json doesn't preserve the order correctly. [\#1817](https://github.com/nlohmann/json/issues/1817)
|
||||||
- \[C++17\] Allow std::optional to convert to nlohmann::json [\#1749](https://github.com/nlohmann/json/issues/1749)
|
|
||||||
- How can I save json object in file in order? [\#1717](https://github.com/nlohmann/json/issues/1717)
|
- How can I save json object in file in order? [\#1717](https://github.com/nlohmann/json/issues/1717)
|
||||||
- Support for Comments [\#1513](https://github.com/nlohmann/json/issues/1513)
|
- Support for Comments [\#1513](https://github.com/nlohmann/json/issues/1513)
|
||||||
- clang compiler: error : unknown type name 'not' [\#1119](https://github.com/nlohmann/json/issues/1119)
|
- clang compiler: error : unknown type name 'not' [\#1119](https://github.com/nlohmann/json/issues/1119)
|
||||||
@ -1692,7 +2021,7 @@ All notable changes to this project will be documented in this file. This projec
|
|||||||
- Use a version check to provide backwards comatible CMake imported target names [\#1245](https://github.com/nlohmann/json/pull/1245) ([chuckatkins](https://github.com/chuckatkins))
|
- Use a version check to provide backwards comatible CMake imported target names [\#1245](https://github.com/nlohmann/json/pull/1245) ([chuckatkins](https://github.com/chuckatkins))
|
||||||
- Fix issue \#1237 [\#1238](https://github.com/nlohmann/json/pull/1238) ([theodelrieu](https://github.com/theodelrieu))
|
- Fix issue \#1237 [\#1238](https://github.com/nlohmann/json/pull/1238) ([theodelrieu](https://github.com/theodelrieu))
|
||||||
- Add a get overload taking a parameter. [\#1231](https://github.com/nlohmann/json/pull/1231) ([theodelrieu](https://github.com/theodelrieu))
|
- Add a get overload taking a parameter. [\#1231](https://github.com/nlohmann/json/pull/1231) ([theodelrieu](https://github.com/theodelrieu))
|
||||||
- Move lambda out of unevaluated context [\#1230](https://github.com/nlohmann/json/pull/1230) ([mandreyel](https://github.com/mandreyel))
|
- Move lambda out of unevaluated context [\#1230](https://github.com/nlohmann/json/pull/1230) ([vimpunk](https://github.com/vimpunk))
|
||||||
- Remove static asserts [\#1228](https://github.com/nlohmann/json/pull/1228) ([theodelrieu](https://github.com/theodelrieu))
|
- Remove static asserts [\#1228](https://github.com/nlohmann/json/pull/1228) ([theodelrieu](https://github.com/theodelrieu))
|
||||||
- Better error 305 [\#1221](https://github.com/nlohmann/json/pull/1221) ([rivertam](https://github.com/rivertam))
|
- Better error 305 [\#1221](https://github.com/nlohmann/json/pull/1221) ([rivertam](https://github.com/rivertam))
|
||||||
- Fix \#1213 [\#1214](https://github.com/nlohmann/json/pull/1214) ([simnalamburt](https://github.com/simnalamburt))
|
- Fix \#1213 [\#1214](https://github.com/nlohmann/json/pull/1214) ([simnalamburt](https://github.com/simnalamburt))
|
||||||
@ -1859,8 +2188,8 @@ All notable changes to this project will be documented in this file. This projec
|
|||||||
- Fix unit tests that were silently skipped or crashed \(depending on the compiler\) [\#1176](https://github.com/nlohmann/json/pull/1176) ([grembo](https://github.com/grembo))
|
- Fix unit tests that were silently skipped or crashed \(depending on the compiler\) [\#1176](https://github.com/nlohmann/json/pull/1176) ([grembo](https://github.com/grembo))
|
||||||
- Refactor/no virtual sax [\#1153](https://github.com/nlohmann/json/pull/1153) ([theodelrieu](https://github.com/theodelrieu))
|
- Refactor/no virtual sax [\#1153](https://github.com/nlohmann/json/pull/1153) ([theodelrieu](https://github.com/theodelrieu))
|
||||||
- Fixed compiler error in VS 2015 for debug mode [\#1151](https://github.com/nlohmann/json/pull/1151) ([sonulohani](https://github.com/sonulohani))
|
- Fixed compiler error in VS 2015 for debug mode [\#1151](https://github.com/nlohmann/json/pull/1151) ([sonulohani](https://github.com/sonulohani))
|
||||||
- Fix links to cppreference named requirements \(formerly concepts\) [\#1144](https://github.com/nlohmann/json/pull/1144) ([jrakow](https://github.com/jrakow))
|
- Fix links to cppreference named requirements \(formerly concepts\) [\#1144](https://github.com/nlohmann/json/pull/1144) ([ghost](https://github.com/ghost))
|
||||||
- meson: fix include directory [\#1142](https://github.com/nlohmann/json/pull/1142) ([jrakow](https://github.com/jrakow))
|
- meson: fix include directory [\#1142](https://github.com/nlohmann/json/pull/1142) ([ghost](https://github.com/ghost))
|
||||||
- Feature/unordered map conversion [\#1138](https://github.com/nlohmann/json/pull/1138) ([theodelrieu](https://github.com/theodelrieu))
|
- Feature/unordered map conversion [\#1138](https://github.com/nlohmann/json/pull/1138) ([theodelrieu](https://github.com/theodelrieu))
|
||||||
- fixed compile error for \#1045 [\#1134](https://github.com/nlohmann/json/pull/1134) ([Daniel599](https://github.com/Daniel599))
|
- fixed compile error for \#1045 [\#1134](https://github.com/nlohmann/json/pull/1134) ([Daniel599](https://github.com/Daniel599))
|
||||||
- test \(non\)equality for alt\_string implementation [\#1130](https://github.com/nlohmann/json/pull/1130) ([agrianius](https://github.com/agrianius))
|
- test \(non\)equality for alt\_string implementation [\#1130](https://github.com/nlohmann/json/pull/1130) ([agrianius](https://github.com/agrianius))
|
||||||
@ -1869,7 +2198,7 @@ All notable changes to this project will be documented in this file. This projec
|
|||||||
- fix typo in README [\#1078](https://github.com/nlohmann/json/pull/1078) ([martin-mfg](https://github.com/martin-mfg))
|
- fix typo in README [\#1078](https://github.com/nlohmann/json/pull/1078) ([martin-mfg](https://github.com/martin-mfg))
|
||||||
- Fix typo [\#1058](https://github.com/nlohmann/json/pull/1058) ([dns13](https://github.com/dns13))
|
- Fix typo [\#1058](https://github.com/nlohmann/json/pull/1058) ([dns13](https://github.com/dns13))
|
||||||
- Misc cmake packaging enhancements [\#1048](https://github.com/nlohmann/json/pull/1048) ([chuckatkins](https://github.com/chuckatkins))
|
- Misc cmake packaging enhancements [\#1048](https://github.com/nlohmann/json/pull/1048) ([chuckatkins](https://github.com/chuckatkins))
|
||||||
- Fixed incorrect LLVM version number in README [\#1047](https://github.com/nlohmann/json/pull/1047) ([jammehcow](https://github.com/jammehcow))
|
- Fixed incorrect LLVM version number in README [\#1047](https://github.com/nlohmann/json/pull/1047) ([jupjohn](https://github.com/jupjohn))
|
||||||
- Fix trivial typo in comment. [\#1043](https://github.com/nlohmann/json/pull/1043) ([coryan](https://github.com/coryan))
|
- Fix trivial typo in comment. [\#1043](https://github.com/nlohmann/json/pull/1043) ([coryan](https://github.com/coryan))
|
||||||
- Package Manager: Spack [\#1041](https://github.com/nlohmann/json/pull/1041) ([ax3l](https://github.com/ax3l))
|
- Package Manager: Spack [\#1041](https://github.com/nlohmann/json/pull/1041) ([ax3l](https://github.com/ax3l))
|
||||||
- CMake: 3.8+ is Sufficient [\#1040](https://github.com/nlohmann/json/pull/1040) ([ax3l](https://github.com/ax3l))
|
- CMake: 3.8+ is Sufficient [\#1040](https://github.com/nlohmann/json/pull/1040) ([ax3l](https://github.com/ax3l))
|
||||||
@ -2398,7 +2727,7 @@ All notable changes to this project will be documented in this file. This projec
|
|||||||
- Fix "not constraint" grammar in docs [\#674](https://github.com/nlohmann/json/pull/674) ([wincent](https://github.com/wincent))
|
- Fix "not constraint" grammar in docs [\#674](https://github.com/nlohmann/json/pull/674) ([wincent](https://github.com/wincent))
|
||||||
- Add documentation for integration with CMake and hunter [\#671](https://github.com/nlohmann/json/pull/671) ([dan-42](https://github.com/dan-42))
|
- Add documentation for integration with CMake and hunter [\#671](https://github.com/nlohmann/json/pull/671) ([dan-42](https://github.com/dan-42))
|
||||||
- REFACTOR: rewrite CMakeLists.txt for better inlcude and reuse [\#669](https://github.com/nlohmann/json/pull/669) ([dan-42](https://github.com/dan-42))
|
- REFACTOR: rewrite CMakeLists.txt for better inlcude and reuse [\#669](https://github.com/nlohmann/json/pull/669) ([dan-42](https://github.com/dan-42))
|
||||||
- enable\_testing only if the JSON\_BuildTests is ON [\#666](https://github.com/nlohmann/json/pull/666) ([effolkronium](https://github.com/effolkronium))
|
- enable\_testing only if the JSON\_BuildTests is ON [\#666](https://github.com/nlohmann/json/pull/666) ([ilqvya](https://github.com/ilqvya))
|
||||||
- Support moving from rvalues in std::initializer\_list [\#663](https://github.com/nlohmann/json/pull/663) ([himikof](https://github.com/himikof))
|
- Support moving from rvalues in std::initializer\_list [\#663](https://github.com/nlohmann/json/pull/663) ([himikof](https://github.com/himikof))
|
||||||
- add ensure\_ascii parameter to dump. \#330 [\#654](https://github.com/nlohmann/json/pull/654) ([ryanjmulder](https://github.com/ryanjmulder))
|
- add ensure\_ascii parameter to dump. \#330 [\#654](https://github.com/nlohmann/json/pull/654) ([ryanjmulder](https://github.com/ryanjmulder))
|
||||||
- Rename BuildTests to JSON\_BuildTests [\#652](https://github.com/nlohmann/json/pull/652) ([olegendo](https://github.com/olegendo))
|
- Rename BuildTests to JSON\_BuildTests [\#652](https://github.com/nlohmann/json/pull/652) ([olegendo](https://github.com/olegendo))
|
||||||
@ -2917,11 +3246,11 @@ All notable changes to this project will be documented in this file. This projec
|
|||||||
- Keyword 'inline' is useless when member functions are defined in headers [\#87](https://github.com/nlohmann/json/pull/87) ([ahamez](https://github.com/ahamez))
|
- Keyword 'inline' is useless when member functions are defined in headers [\#87](https://github.com/nlohmann/json/pull/87) ([ahamez](https://github.com/ahamez))
|
||||||
- Remove useless typename [\#86](https://github.com/nlohmann/json/pull/86) ([ahamez](https://github.com/ahamez))
|
- Remove useless typename [\#86](https://github.com/nlohmann/json/pull/86) ([ahamez](https://github.com/ahamez))
|
||||||
- Avoid warning with Xcode's clang [\#85](https://github.com/nlohmann/json/pull/85) ([ahamez](https://github.com/ahamez))
|
- Avoid warning with Xcode's clang [\#85](https://github.com/nlohmann/json/pull/85) ([ahamez](https://github.com/ahamez))
|
||||||
- Fix typos [\#73](https://github.com/nlohmann/json/pull/73) ([aqnouch](https://github.com/aqnouch))
|
- Fix typos [\#73](https://github.com/nlohmann/json/pull/73) ([maqnouch](https://github.com/maqnouch))
|
||||||
- Replace `default_callback` function with `nullptr` and check for null… [\#72](https://github.com/nlohmann/json/pull/72) ([aburgh](https://github.com/aburgh))
|
- Replace `default_callback` function with `nullptr` and check for null… [\#72](https://github.com/nlohmann/json/pull/72) ([aburgh](https://github.com/aburgh))
|
||||||
- support enum [\#71](https://github.com/nlohmann/json/pull/71) ([likebeta](https://github.com/likebeta))
|
- support enum [\#71](https://github.com/nlohmann/json/pull/71) ([likebeta](https://github.com/likebeta))
|
||||||
- Fix performance regression introduced with the parsing callback feature. [\#69](https://github.com/nlohmann/json/pull/69) ([aburgh](https://github.com/aburgh))
|
- Fix performance regression introduced with the parsing callback feature. [\#69](https://github.com/nlohmann/json/pull/69) ([aburgh](https://github.com/aburgh))
|
||||||
- Improve the implementations of the comparission-operators [\#63](https://github.com/nlohmann/json/pull/63) ([Florianjw](https://github.com/Florianjw))
|
- Improve the implementations of the comparission-operators [\#63](https://github.com/nlohmann/json/pull/63) ([Fiona-J-W](https://github.com/Fiona-J-W))
|
||||||
- Fix compilation of json\_unit with GCC 5 [\#59](https://github.com/nlohmann/json/pull/59) ([dkopecek](https://github.com/dkopecek))
|
- Fix compilation of json\_unit with GCC 5 [\#59](https://github.com/nlohmann/json/pull/59) ([dkopecek](https://github.com/dkopecek))
|
||||||
- Parse streams incrementally. [\#40](https://github.com/nlohmann/json/pull/40) ([aburgh](https://github.com/aburgh))
|
- Parse streams incrementally. [\#40](https://github.com/nlohmann/json/pull/40) ([aburgh](https://github.com/aburgh))
|
||||||
- Feature/small float serialization [\#38](https://github.com/nlohmann/json/pull/38) ([jrandall](https://github.com/jrandall))
|
- Feature/small float serialization [\#38](https://github.com/nlohmann/json/pull/38) ([jrandall](https://github.com/jrandall))
|
||||||
|
|||||||
239
FILES.md
Normal file
239
FILES.md
Normal file
@ -0,0 +1,239 @@
|
|||||||
|
# Supporting files
|
||||||
|
|
||||||
|
This file describes the source for supporting files; that is, files that are not part of the library, but define the infrastructure and other aspects of the project.
|
||||||
|
|
||||||
|
- [Continuous Integration](#continuous-integration)
|
||||||
|
- [GitHub](#github)
|
||||||
|
- [REUSE](#reuse)
|
||||||
|
- [Package Managers](#package-managers)
|
||||||
|
|
||||||
|
## Continuous Integration
|
||||||
|
|
||||||
|
### `.cirrus.yml`
|
||||||
|
|
||||||
|
Configuration file for the pipeline at [Cirrus CI](https://cirrus-ci.com/github/nlohmann/json).
|
||||||
|
|
||||||
|
Further documentation:
|
||||||
|
|
||||||
|
- [Writing tasks](https://cirrus-ci.org/guide/writing-tasks/)
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> The filename `.cirrus.yml` and position (root of the repository) are predetermined by Cirrus CI.
|
||||||
|
|
||||||
|
### `.github/external_ci/appveyor.yml`
|
||||||
|
|
||||||
|
Configuration for the pipelines at [AppVeyor](https://ci.appveyor.com/project/nlohmann/json).
|
||||||
|
|
||||||
|
Further documentation:
|
||||||
|
|
||||||
|
- [appveyor.yml reference](https://www.appveyor.com/docs/appveyor-yml/)
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> The filename can be freely configured in the AppVeyor project.
|
||||||
|
|
||||||
|
## GitHub
|
||||||
|
|
||||||
|
### `CITATION.cff`
|
||||||
|
|
||||||
|
A file to configure the citation for the repository which is displayed in the sidebar of the project.
|
||||||
|
|
||||||
|
Further documentation:
|
||||||
|
|
||||||
|
- [About CITATION files](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files)
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> The filename `CITATION.cff` and position (root of the repository) are predetermined by GitHub.
|
||||||
|
|
||||||
|
### `.github/CODE_OF_CONDUCT.md`
|
||||||
|
|
||||||
|
The code of conduct for the project. This is the Markdown version of the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/). The code of conduct is linked on the [Community Standards](https://github.com/nlohmann/json/community) page and is mentioned by the Sentiment Bot.
|
||||||
|
|
||||||
|
Further documentation:
|
||||||
|
|
||||||
|
- [Adding a code of conduct to your project](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> The filename `.github/CODE_OF_CONDUCT.md` is predetermined by GitHub.
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> The file is part of the documentation and is included in `docs/mkdocs/docs/community/code_of_conduct.md`.
|
||||||
|
|
||||||
|
### `.github/CODEOWNERS`
|
||||||
|
|
||||||
|
The code owners file for the project which is used to select reviewers for new pull requests.
|
||||||
|
|
||||||
|
Further documentation:
|
||||||
|
|
||||||
|
- [About code owners](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> The filename `.github/CODEOWNERS` is predetermined by GitHub.
|
||||||
|
|
||||||
|
### `.github/config.yml`
|
||||||
|
|
||||||
|
Configuration file for [probot](https://probot.github.io/apps/), in particular the [Sentiment Bot](https://probot.github.io/apps/sentiment-bot/) and the [Request Info](https://probot.github.io/apps/request-info/).
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> The filename `.github/config.yml` is predetermined by probot.
|
||||||
|
|
||||||
|
### `.github/CONTRIBUTING.md`
|
||||||
|
|
||||||
|
The contribution guidelines which are linked in the [Community Standards](https://github.com/nlohmann/json/community) and at <https://github.com/nlohmann/json/contribute>.
|
||||||
|
|
||||||
|
Further documentation:
|
||||||
|
|
||||||
|
- [Setting guidelines for repository contributors](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> The filename `.github/CONTRIBUTING.md` is predetermined by GitHub.
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> The file is part of the documentation and is included in `docs/mkdocs/docs/community/contribution_guidelines.md`.
|
||||||
|
|
||||||
|
### `.github/dependabot.yml`
|
||||||
|
|
||||||
|
The configuration of [dependabot](https://github.com/dependabot) which ensures the dependencies (GitHub actions and Python packages used in the CI) remain up-to-date.
|
||||||
|
|
||||||
|
Further documentation:
|
||||||
|
|
||||||
|
- [Configuring Dependabot security updates](https://docs.github.com/en/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates)
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> The filename `.github/dependabot.yml` is predetermined by GitHub.
|
||||||
|
|
||||||
|
### `.github/FUNDING.yml`
|
||||||
|
|
||||||
|
A file to configure the sponsor button of the repository which is displayed in the sidebar of the project.
|
||||||
|
|
||||||
|
Further documentation:
|
||||||
|
|
||||||
|
- [Displaying a sponsor button in your repository](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository)
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> The filename `.github/FUNDING.yml` is predetermined by GitHub.
|
||||||
|
|
||||||
|
### `.github/ISSUE_TEMPLATE/bug.yaml`
|
||||||
|
|
||||||
|
Issue form template for bugs.
|
||||||
|
|
||||||
|
Further documentation:
|
||||||
|
|
||||||
|
- [Configuring issue templates for your repository](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository)
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> The folder `.github/ISSUE_TEMPLATE` is predetermined by GitHub.
|
||||||
|
|
||||||
|
### `.github/ISSUE_TEMPLATE/config.yaml`
|
||||||
|
|
||||||
|
Issue template chooser configuration. The file is used to configure the dialog when a new issue is created.
|
||||||
|
|
||||||
|
Further documentation:
|
||||||
|
|
||||||
|
- [Configuring issue templates for your repository](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository)
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> The filename `.github/ISSUE_TEMPLATE/config.yaml` is predetermined by GitHub.
|
||||||
|
|
||||||
|
### `.github/labeler.yml`
|
||||||
|
|
||||||
|
Configuration file for the "Pull Request Labeler" workflow defined in `workflows/labeler.yml`. This file defines rules how labels are assigned to pull requests based on which files are changed.
|
||||||
|
|
||||||
|
Further documentation:
|
||||||
|
|
||||||
|
- [Label manager for PRs and issues based on configurable conditions](https://github.com/srvaroa/labeler)
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> The filename defaults to `.github/labeler.yml` and can be configured in the workflow.
|
||||||
|
|
||||||
|
### `.github/PULL_REQUEST_TEMPLATE.md`
|
||||||
|
|
||||||
|
The pull request template which prefills new pull requests.
|
||||||
|
|
||||||
|
Further documentation:
|
||||||
|
|
||||||
|
- [Creating a pull request template for your repository](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository)
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> The filename `.github/PULL_REQUEST_TEMPLATE.md` is predetermined by GitHub.
|
||||||
|
|
||||||
|
### `.github/SECURITY.md`
|
||||||
|
|
||||||
|
The goal is to describe how to securely report security vulnerabilities for this repository. The security policy is linked at <https://github.com/nlohmann/json/security/policy>.
|
||||||
|
|
||||||
|
Further documentation:
|
||||||
|
|
||||||
|
- [Adding a security policy to your repository](https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository)
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> The filename `.github/SECURITY.yml` is predetermined by GitHub.
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> The file is part of the documentation and is included in `docs/mkdocs/docs/community/security_policy.md`.
|
||||||
|
|
||||||
|
### `LICENSE.MIT`
|
||||||
|
|
||||||
|
The license of the project.
|
||||||
|
|
||||||
|
Further documentation:
|
||||||
|
|
||||||
|
- [Adding a license to a repository](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository)
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> The filename `LICENSE.MIT` is partly predetermined by GitHub. The root filename must be `LICENSE`.
|
||||||
|
|
||||||
|
## REUSE
|
||||||
|
|
||||||
|
### `.reuse/dep5`
|
||||||
|
|
||||||
|
The file defines the licenses of certain third-party component in the repository. The root `Makefile` contains a target `reuse` that checks for compliance.
|
||||||
|
|
||||||
|
Further documentation:
|
||||||
|
|
||||||
|
- [DEP5](https://reuse.software/spec-3.2/#dep5-deprecated)
|
||||||
|
- [reuse command-line tool](https://pypi.org/project/reuse/)
|
||||||
|
- [documentation of linting](https://reuse.readthedocs.io/en/stable/man/reuse-lint.html)
|
||||||
|
- [REUSE](http://reuse.software)
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> The filename `.reuse/dep5` is predetermined by REUSE. Alternatively, a `REUSE.toml` file can be used.
|
||||||
|
|
||||||
|
### `.reuse/templates`
|
||||||
|
|
||||||
|
Copyright header templates for source files. The root `Makefile` contains a target `reuse` that updates copyright headers with the templates.
|
||||||
|
|
||||||
|
Further information:
|
||||||
|
|
||||||
|
- [reuse command-line tool](https://pypi.org/project/reuse/)
|
||||||
|
- [documentation on templates](https://reuse.readthedocs.io/en/stable/man/reuse-annotate.html#cmdoption-t)
|
||||||
|
- [REUSE](http://reuse.software)
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> The folder name `.reuse/templates` is predetermined by REUSE.
|
||||||
|
|
||||||
|
### `LICENSES`
|
||||||
|
|
||||||
|
A folder that contains every license of all licenses files (library and third-party code).
|
||||||
|
|
||||||
|
Further documentation:
|
||||||
|
|
||||||
|
- [REUSE specification](https://reuse.software/spec-3.3/)
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> The folder name `LICENSES` is predetermined by REUSE.
|
||||||
|
|
||||||
|
|
||||||
|
## Package Managers
|
||||||
|
|
||||||
|
### `BUILD.bazel`
|
||||||
|
|
||||||
|
The file can be updated by calling
|
||||||
|
|
||||||
|
```shell
|
||||||
|
make BUILD.bazel
|
||||||
|
```
|
||||||
|
|
||||||
|
### `meson.build`
|
||||||
|
|
||||||
|
### `Package.swift`
|
||||||
|
|
||||||
|
### `WORKSPACE.bazel`
|
||||||
@ -1,6 +1,6 @@
|
|||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2013-2022 Niels Lohmann
|
Copyright (c) 2013-2025 Niels Lohmann
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|||||||
7
MODULE.bazel
Normal file
7
MODULE.bazel
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
module(
|
||||||
|
name = "nlohmann_json",
|
||||||
|
compatibility_level = 1,
|
||||||
|
)
|
||||||
|
|
||||||
|
bazel_dep(name = "rules_cc", version = "0.0.17")
|
||||||
|
bazel_dep(name = "rules_license", version = "1.0.0")
|
||||||
50
Makefile
50
Makefile
@ -43,15 +43,6 @@ all:
|
|||||||
@echo "run_benchmarks - build and run benchmarks"
|
@echo "run_benchmarks - build and run benchmarks"
|
||||||
|
|
||||||
|
|
||||||
##########################################################################
|
|
||||||
# documentation tests
|
|
||||||
##########################################################################
|
|
||||||
|
|
||||||
# compile example files and check output
|
|
||||||
doctest:
|
|
||||||
$(MAKE) check_output -C docs
|
|
||||||
|
|
||||||
|
|
||||||
##########################################################################
|
##########################################################################
|
||||||
# benchmarks
|
# benchmarks
|
||||||
##########################################################################
|
##########################################################################
|
||||||
@ -142,32 +133,20 @@ pvs_studio:
|
|||||||
# Code format and source amalgamation
|
# Code format and source amalgamation
|
||||||
##########################################################################
|
##########################################################################
|
||||||
|
|
||||||
|
ASTYLE=tools/astyle/venv/bin/astyle
|
||||||
|
|
||||||
|
install_astyle:
|
||||||
|
@test -d tools/astyle/venv || python3 -mvenv tools/astyle/venv ; tools/astyle/venv/bin/pip3 install --quiet --upgrade pip
|
||||||
|
@test -f $(ASTYLE) || tools/astyle/venv/bin/pip3 install --quiet -r tools/astyle/requirements.txt
|
||||||
|
@$(ASTYLE) --version
|
||||||
|
|
||||||
# call the Artistic Style pretty printer on all source files
|
# call the Artistic Style pretty printer on all source files
|
||||||
pretty:
|
pretty: install_astyle
|
||||||
astyle \
|
$(ASTYLE) --project=tools/astyle/.astylerc $(SRCS) $(TESTS_SRCS) $(AMALGAMATED_FILE) $(AMALGAMATED_FWD_FILE) docs/mkdocs/docs/examples/*.cpp
|
||||||
--style=allman \
|
|
||||||
--indent=spaces=4 \
|
|
||||||
--indent-modifiers \
|
|
||||||
--indent-switches \
|
|
||||||
--indent-preproc-block \
|
|
||||||
--indent-preproc-define \
|
|
||||||
--indent-col1-comments \
|
|
||||||
--pad-oper \
|
|
||||||
--pad-header \
|
|
||||||
--align-pointer=type \
|
|
||||||
--align-reference=type \
|
|
||||||
--add-braces \
|
|
||||||
--convert-tabs \
|
|
||||||
--close-templates \
|
|
||||||
--lineend=linux \
|
|
||||||
--preserve-date \
|
|
||||||
--suffix=none \
|
|
||||||
--formatted \
|
|
||||||
$(SRCS) $(TESTS_SRCS) $(AMALGAMATED_FILE) $(AMALGAMATED_FWD_FILE) docs/examples/*.cpp
|
|
||||||
|
|
||||||
# call the Clang-Format on all source files
|
# call the Clang-Format on all source files
|
||||||
pretty_format:
|
pretty_format:
|
||||||
for FILE in $(SRCS) $(TESTS_SRCS) $(AMALGAMATED_FILE) docs/examples/*.cpp; do echo $$FILE; clang-format -i $$FILE; done
|
for FILE in $(SRCS) $(TESTS_SRCS) $(AMALGAMATED_FILE) docs/mkdocs/docs/examples/*.cpp; do echo $$FILE; clang-format -i $$FILE; done
|
||||||
|
|
||||||
# create single header files and pretty print
|
# create single header files and pretty print
|
||||||
amalgamate: $(AMALGAMATED_FILE) $(AMALGAMATED_FWD_FILE)
|
amalgamate: $(AMALGAMATED_FILE) $(AMALGAMATED_FWD_FILE)
|
||||||
@ -215,7 +194,7 @@ ChangeLog.md:
|
|||||||
# Release files
|
# Release files
|
||||||
##########################################################################
|
##########################################################################
|
||||||
|
|
||||||
# Create a tar.gz archive that contains sufficient files to be used as CMake project (e.g., using FetchContent). The
|
# Create a tar.xz archive that contains sufficient files to be used as CMake project (e.g., using FetchContent). The
|
||||||
# archive is created according to the advices of <https://reproducible-builds.org/docs/archives/>.
|
# archive is created according to the advices of <https://reproducible-builds.org/docs/archives/>.
|
||||||
json.tar.xz:
|
json.tar.xz:
|
||||||
mkdir json
|
mkdir json
|
||||||
@ -279,6 +258,9 @@ serve_header:
|
|||||||
##########################################################################
|
##########################################################################
|
||||||
|
|
||||||
reuse:
|
reuse:
|
||||||
pipx run reuse addheader --recursive single_include include -tjson --license MIT --copyright "Niels Lohmann <https://nlohmann.me>" --year "2013-2022"
|
pipx run reuse annotate --recursive single_include include -tjson --license MIT --copyright "Niels Lohmann <https://nlohmann.me>" --year "2013-2025" --merge-copyrights
|
||||||
pipx run reuse addheader $(TESTS_SRCS) --style=c -tjson_support --license MIT --copyright "Niels Lohmann <https://nlohmann.me>" --year "2013-2022"
|
pipx run reuse annotate $(TESTS_SRCS) -tjson_support --license MIT --copyright "Niels Lohmann <https://nlohmann.me>" --year "2013-2025" --merge-copyrights
|
||||||
pipx run reuse lint
|
pipx run reuse lint
|
||||||
|
|
||||||
|
spdx:
|
||||||
|
pipx run reuse spdx --output nlohmann_json.spdx --creator-person "Niels Lohmann" --add-license-concluded
|
||||||
|
|||||||
@ -6,7 +6,7 @@ import PackageDescription
|
|||||||
let package = Package(
|
let package = Package(
|
||||||
name: "nlohmann-json",
|
name: "nlohmann-json",
|
||||||
platforms: [
|
platforms: [
|
||||||
.iOS(.v12), .macOS(.v10_13), .tvOS(.v12), .watchOS(.v4)
|
.iOS(.v12), .macOS(.v10_13), .tvOS(.v12), .watchOS(.v4), .visionOS(.v1)
|
||||||
],
|
],
|
||||||
products: [
|
products: [
|
||||||
.library(name: "json", targets: ["json"])
|
.library(name: "json", targets: ["json"])
|
||||||
|
|||||||
301
README.md
301
README.md
@ -1,4 +1,4 @@
|
|||||||
[](https://github.com/nlohmann/json/releases)
|
[](https://github.com/nlohmann/json/releases)
|
||||||
|
|
||||||
[](https://ci.appveyor.com/project/nlohmann/json)
|
[](https://ci.appveyor.com/project/nlohmann/json)
|
||||||
[](https://github.com/nlohmann/json/actions?query=workflow%3AUbuntu)
|
[](https://github.com/nlohmann/json/actions?query=workflow%3AUbuntu)
|
||||||
@ -6,19 +6,19 @@
|
|||||||
[](https://github.com/nlohmann/json/actions?query=workflow%3AWindows)
|
[](https://github.com/nlohmann/json/actions?query=workflow%3AWindows)
|
||||||
[](https://coveralls.io/github/nlohmann/json?branch=develop)
|
[](https://coveralls.io/github/nlohmann/json?branch=develop)
|
||||||
[](https://scan.coverity.com/projects/nlohmann-json)
|
[](https://scan.coverity.com/projects/nlohmann-json)
|
||||||
[](https://www.codacy.com/gh/nlohmann/json/dashboard?utm_source=github.com&utm_medium=referral&utm_content=nlohmann/json&utm_campaign=Badge_Grade)
|
[](https://app.codacy.com/gh/nlohmann/json/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
|
||||||
[](https://cirrus-ci.com/github/nlohmann/json)
|
[](https://cirrus-ci.com/github/nlohmann/json)
|
||||||
[](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:json)
|
[](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:json)
|
||||||
[](https://wandbox.org/permlink/1mp10JbaANo6FUc7)
|
[](https://wandbox.org/permlink/1mp10JbaANo6FUc7)
|
||||||
[](https://json.nlohmann.me)
|
[](https://json.nlohmann.me)
|
||||||
[](https://raw.githubusercontent.com/nlohmann/json/master/LICENSE.MIT)
|
[](https://raw.githubusercontent.com/nlohmann/json/master/LICENSE.MIT)
|
||||||
[](https://github.com/nlohmann/json/releases)
|
[](https://github.com/nlohmann/json/releases)
|
||||||
[](https://vcpkg.link/ports/nlohmann-json)
|
|
||||||
[](https://repology.org/project/nlohmann-json/versions)
|
[](https://repology.org/project/nlohmann-json/versions)
|
||||||
[](https://github.com/nlohmann/json/releases)
|
[](https://github.com/nlohmann/json/releases)
|
||||||
[](https://github.com/nlohmann/json/issues)
|
[](https://github.com/nlohmann/json/issues)
|
||||||
[](https://isitmaintained.com/project/nlohmann/json "Average time to resolve an issue")
|
[](https://isitmaintained.com/project/nlohmann/json "Average time to resolve an issue")
|
||||||
[](https://bestpractices.coreinfrastructure.org/projects/289)
|
[](https://bestpractices.coreinfrastructure.org/projects/289)
|
||||||
|
[](https://scorecard.dev/viewer/?uri=github.com/nlohmann/json)
|
||||||
[](https://github.com/sponsors/nlohmann)
|
[](https://github.com/sponsors/nlohmann)
|
||||||
[](https://api.reuse.software/info/github.com/nlohmann/json)
|
[](https://api.reuse.software/info/github.com/nlohmann/json)
|
||||||
[](https://discord.gg/6mrGXKvX7y)
|
[](https://discord.gg/6mrGXKvX7y)
|
||||||
@ -26,6 +26,7 @@
|
|||||||
- [Design goals](#design-goals)
|
- [Design goals](#design-goals)
|
||||||
- [Sponsors](#sponsors)
|
- [Sponsors](#sponsors)
|
||||||
- [Support](#support) ([documentation](https://json.nlohmann.me), [FAQ](https://json.nlohmann.me/home/faq/), [discussions](https://github.com/nlohmann/json/discussions), [API](https://json.nlohmann.me/api/basic_json/), [bug issues](https://github.com/nlohmann/json/issues))
|
- [Support](#support) ([documentation](https://json.nlohmann.me), [FAQ](https://json.nlohmann.me/home/faq/), [discussions](https://github.com/nlohmann/json/discussions), [API](https://json.nlohmann.me/api/basic_json/), [bug issues](https://github.com/nlohmann/json/issues))
|
||||||
|
- [Quick reference](#quick-reference)
|
||||||
- [Examples](#examples)
|
- [Examples](#examples)
|
||||||
- [Read JSON from a file](#read-json-from-a-file)
|
- [Read JSON from a file](#read-json-from-a-file)
|
||||||
- [Creating `json` objects from JSON literals](#creating-json-objects-from-json-literals)
|
- [Creating `json` objects from JSON literals](#creating-json-objects-from-json-literals)
|
||||||
@ -39,6 +40,7 @@
|
|||||||
- [Conversions to/from arbitrary types](#arbitrary-types-conversions)
|
- [Conversions to/from arbitrary types](#arbitrary-types-conversions)
|
||||||
- [Specializing enum conversion](#specializing-enum-conversion)
|
- [Specializing enum conversion](#specializing-enum-conversion)
|
||||||
- [Binary formats (BSON, CBOR, MessagePack, UBJSON, and BJData)](#binary-formats-bson-cbor-messagepack-ubjson-and-bjdata)
|
- [Binary formats (BSON, CBOR, MessagePack, UBJSON, and BJData)](#binary-formats-bson-cbor-messagepack-ubjson-and-bjdata)
|
||||||
|
- [Customers](#customers)
|
||||||
- [Supported compilers](#supported-compilers)
|
- [Supported compilers](#supported-compilers)
|
||||||
- [Integration](#integration)
|
- [Integration](#integration)
|
||||||
- [CMake](#cmake)
|
- [CMake](#cmake)
|
||||||
@ -48,7 +50,6 @@
|
|||||||
- [Contact](#contact)
|
- [Contact](#contact)
|
||||||
- [Thanks](#thanks)
|
- [Thanks](#thanks)
|
||||||
- [Used third-party tools](#used-third-party-tools)
|
- [Used third-party tools](#used-third-party-tools)
|
||||||
- [Projects using JSON for Modern C++](#projects-using-json-for-modern-c)
|
|
||||||
- [Notes](#notes)
|
- [Notes](#notes)
|
||||||
- [Execute unit tests](#execute-unit-tests)
|
- [Execute unit tests](#execute-unit-tests)
|
||||||
|
|
||||||
@ -58,9 +59,9 @@ There are myriads of [JSON](https://json.org) libraries out there, and each may
|
|||||||
|
|
||||||
- **Intuitive syntax**. In languages such as Python, JSON feels like a first class data type. We used all the operator magic of modern C++ to achieve the same feeling in your code. Check out the [examples below](#examples) and you'll know what I mean.
|
- **Intuitive syntax**. In languages such as Python, JSON feels like a first class data type. We used all the operator magic of modern C++ to achieve the same feeling in your code. Check out the [examples below](#examples) and you'll know what I mean.
|
||||||
|
|
||||||
- **Trivial integration**. Our whole code consists of a single header file [`json.hpp`](https://github.com/nlohmann/json/blob/develop/single_include/nlohmann/json.hpp). That's it. No library, no subproject, no dependencies, no complex build system. The class is written in vanilla C++11. All in all, everything should require no adjustment of your compiler flags or project settings.
|
- **Trivial integration**. Our whole code consists of a single header file [`json.hpp`](https://github.com/nlohmann/json/blob/develop/single_include/nlohmann/json.hpp). That's it. No library, no subproject, no dependencies, no complex build system. The class is written in vanilla C++11. All in all, everything should require no adjustment of your compiler flags or project settings. The library is also included in all popular [package managers](https://json.nlohmann.me/integration/package_managers/).
|
||||||
|
|
||||||
- **Serious testing**. Our code is heavily [unit-tested](https://github.com/nlohmann/json/tree/develop/tests/src) and covers [100%](https://coveralls.io/r/nlohmann/json) of the code, including all exceptional behavior. Furthermore, we checked with [Valgrind](https://valgrind.org) and the [Clang Sanitizers](https://clang.llvm.org/docs/index.html) that there are no memory leaks. [Google OSS-Fuzz](https://github.com/google/oss-fuzz/tree/master/projects/json) additionally runs fuzz tests against all parsers 24/7, effectively executing billions of tests so far. To maintain high quality, the project is following the [Core Infrastructure Initiative (CII) best practices](https://bestpractices.coreinfrastructure.org/projects/289).
|
- **Serious testing**. Our code is heavily [unit-tested](https://github.com/nlohmann/json/tree/develop/tests/src) and covers [100%](https://coveralls.io/r/nlohmann/json) of the code, including all exceptional behavior. Furthermore, we checked with [Valgrind](https://valgrind.org) and the [Clang Sanitizers](https://clang.llvm.org/docs/index.html) that there are no memory leaks. [Google OSS-Fuzz](https://github.com/google/oss-fuzz/tree/master/projects/json) additionally runs fuzz tests against all parsers 24/7, effectively executing billions of tests so far. To maintain high quality, the project is following the [Core Infrastructure Initiative (CII) best practices](https://bestpractices.coreinfrastructure.org/projects/289). See the [quality assurance](https://json.nlohmann.me/community/quality_assurance) overview documentation.
|
||||||
|
|
||||||
Other aspects were not so important to us:
|
Other aspects were not so important to us:
|
||||||
|
|
||||||
@ -70,7 +71,6 @@ Other aspects were not so important to us:
|
|||||||
|
|
||||||
See the [contribution guidelines](https://github.com/nlohmann/json/blob/master/.github/CONTRIBUTING.md#please-dont) for more information.
|
See the [contribution guidelines](https://github.com/nlohmann/json/blob/master/.github/CONTRIBUTING.md#please-dont) for more information.
|
||||||
|
|
||||||
|
|
||||||
## Sponsors
|
## Sponsors
|
||||||
|
|
||||||
You can sponsor this library at [GitHub Sponsors](https://github.com/sponsors/nlohmann).
|
You can sponsor this library at [GitHub Sponsors](https://github.com/sponsors/nlohmann).
|
||||||
@ -78,6 +78,7 @@ You can sponsor this library at [GitHub Sponsors](https://github.com/sponsors/nl
|
|||||||
### :raising_hand: Priority Sponsor
|
### :raising_hand: Priority Sponsor
|
||||||
|
|
||||||
- [Martti Laine](https://github.com/codeclown)
|
- [Martti Laine](https://github.com/codeclown)
|
||||||
|
- [Paul Harrington](https://github.com/phrrngtn)
|
||||||
|
|
||||||
### :label: Named Sponsors
|
### :label: Named Sponsors
|
||||||
|
|
||||||
@ -88,20 +89,49 @@ You can sponsor this library at [GitHub Sponsors](https://github.com/sponsors/nl
|
|||||||
- [Steve Wagner](https://github.com/ciroque)
|
- [Steve Wagner](https://github.com/ciroque)
|
||||||
- [Lion Yang](https://github.com/LionNatsu)
|
- [Lion Yang](https://github.com/LionNatsu)
|
||||||
|
|
||||||
|
### Further support
|
||||||
|
|
||||||
|
The development of the library is further supported by JetBrains by providing free access to their IDE tools.
|
||||||
|
|
||||||
|
[](https://jb.gg/OpenSourceSupport)
|
||||||
|
|
||||||
Thanks everyone!
|
Thanks everyone!
|
||||||
|
|
||||||
## Support
|
## Support
|
||||||
|
|
||||||
:question: If you have a **question**, please check if it is already answered in the [**FAQ**](https://json.nlohmann.me/home/faq/) or the [**Q&A**](https://github.com/nlohmann/json/discussions/categories/q-a) section. If not, please [**ask a new question**](https://github.com/nlohmann/json/discussions/new) there.
|
:question: If you have a **question**, please check if it is already answered in the [**FAQ**](https://json.nlohmann.me/home/faq/) or the [**Q&A**](https://github.com/nlohmann/json/discussions/categories/q-a) section. If not, please [**ask a new question**](https://github.com/nlohmann/json/discussions/new) there.
|
||||||
|
|
||||||
:books: If you want to **learn more** about how to use the library, check out the rest of the [**README**](#examples), have a look at [**code examples**](https://github.com/nlohmann/json/tree/develop/docs/examples), or browse through the [**help pages**](https://json.nlohmann.me).
|
:books: If you want to **learn more** about how to use the library, check out the rest of the [**README**](#examples), have a look at [**code examples**](https://github.com/nlohmann/json/tree/develop/docs/mkdocs/docs/examples), or browse through the [**help pages**](https://json.nlohmann.me).
|
||||||
|
|
||||||
:construction: If you want to understand the **API** better, check out the [**API Reference**](https://json.nlohmann.me/api/basic_json/).
|
:construction: If you want to understand the **API** better, check out the [**API Reference**](https://json.nlohmann.me/api/basic_json/) or have a look at the [quick reference](#quick-reference) below.
|
||||||
|
|
||||||
:bug: If you found a **bug**, please check the [**FAQ**](https://json.nlohmann.me/home/faq/) if it is a known issue or the result of a design decision. Please also have a look at the [**issue list**](https://github.com/nlohmann/json/issues) before you [**create a new issue**](https://github.com/nlohmann/json/issues/new/choose). Please provide as much information as possible to help us understand and reproduce your issue.
|
:bug: If you found a **bug**, please check the [**FAQ**](https://json.nlohmann.me/home/faq/) if it is a known issue or the result of a design decision. Please also have a look at the [**issue list**](https://github.com/nlohmann/json/issues) before you [**create a new issue**](https://github.com/nlohmann/json/issues/new/choose). Please provide as much information as possible to help us understand and reproduce your issue.
|
||||||
|
|
||||||
There is also a [**docset**](https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/JSON_for_Modern_C%2B%2B) for the documentation browsers [Dash](https://kapeli.com/dash), [Velocity](https://velocity.silverlakesoftware.com), and [Zeal](https://zealdocs.org) that contains the full [documentation](https://json.nlohmann.me) as offline resource.
|
There is also a [**docset**](https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/JSON_for_Modern_C%2B%2B) for the documentation browsers [Dash](https://kapeli.com/dash), [Velocity](https://velocity.silverlakesoftware.com), and [Zeal](https://zealdocs.org) that contains the full [documentation](https://json.nlohmann.me) as offline resource.
|
||||||
|
|
||||||
|
## Quick reference
|
||||||
|
|
||||||
|
- **Constructors** [basic_json](https://json.nlohmann.me/api/basic_json/basic_json), [array](https://json.nlohmann.me/api/basic_json/array), [binary](https://json.nlohmann.me/api/basic_json/binary), [object](https://json.nlohmann.me/api/basic_json/object)
|
||||||
|
- **Object inspection**: [type](https://json.nlohmann.me/api/basic_json/type), [operator value_t](https://json.nlohmann.me/api/basic_json/operator_value_t), [type_name](https://json.nlohmann.me/api/basic_json/type_name), [is_primitive](https://json.nlohmann.me/api/basic_json/is_primitive), [is_structured](https://json.nlohmann.me/api/basic_json/is_structured), [is_null](https://json.nlohmann.me/api/basic_json/is_null), [is_boolean](https://json.nlohmann.me/api/basic_json/is_boolean), [is_number](https://json.nlohmann.me/api/basic_json/is_number), [is_number_integer](https://json.nlohmann.me/api/basic_json/is_number_integer), [is_number_unsigned](https://json.nlohmann.me/api/basic_json/is_number_unsigned), [is_number_float](https://json.nlohmann.me/api/basic_json/is_number_float), [is_object](https://json.nlohmann.me/api/basic_json/is_object), [is_array](https://json.nlohmann.me/api/basic_json/is_array), [is_string](https://json.nlohmann.me/api/basic_json/is_string), [is_binary](https://json.nlohmann.me/api/basic_json/is_binary), [is_discarded](https://json.nlohmann.me/api/basic_json/is_discarded)
|
||||||
|
- **Value access**; [get](https://json.nlohmann.me/api/basic_json/get), [get_to](https://json.nlohmann.me/api/basic_json/get_to), [get_ptr](https://json.nlohmann.me/api/basic_json/get_ptr), [get_ref](https://json.nlohmann.me/api/basic_json/get_ref), [operator ValueType](https://json.nlohmann.me/api/basic_json/operator_ValueType), [get_binary](https://json.nlohmann.me/api/basic_json/get_binary)
|
||||||
|
- **Element access**: [at](https://json.nlohmann.me/api/basic_json/at), [operator[]](https://json.nlohmann.me/api/basic_json/operator[]), [value](https://json.nlohmann.me/api/basic_json/value), [front](https://json.nlohmann.me/api/basic_json/front), [back](https://json.nlohmann.me/api/basic_json/back)
|
||||||
|
- **Lookup**: [find](https://json.nlohmann.me/api/basic_json/find), [count](https://json.nlohmann.me/api/basic_json/count), [contains](https://json.nlohmann.me/api/basic_json/contains)
|
||||||
|
- **Iterators**: [begin](https://json.nlohmann.me/api/basic_json/begin), [cbegin](https://json.nlohmann.me/api/basic_json/cbegin), [end](https://json.nlohmann.me/api/basic_json/end), [cend](https://json.nlohmann.me/api/basic_json/cend), [rbegin](https://json.nlohmann.me/api/basic_json/rbegin), [rend](https://json.nlohmann.me/api/basic_json/rend), [crbegin](https://json.nlohmann.me/api/basic_json/crbegin), [crend](https://json.nlohmann.me/api/basic_json/crend), [items](https://json.nlohmann.me/api/basic_json/items)
|
||||||
|
- **Capacity**: [empty](https://json.nlohmann.me/api/basic_json/empty), [size](https://json.nlohmann.me/api/basic_json/size), [max_size](https://json.nlohmann.me/api/basic_json/max_size)
|
||||||
|
- **Modifiers**: [clear](https://json.nlohmann.me/api/basic_json/clear), [push_back](https://json.nlohmann.me/api/basic_json/push_back), [operator+=](https://json.nlohmann.me/api/basic_json/operator+=), [emplace_back](https://json.nlohmann.me/api/basic_json/emplace_back), [emplace](https://json.nlohmann.me/api/basic_json/emplace), [erase](https://json.nlohmann.me/api/basic_json/erase), [insert](https://json.nlohmann.me/api/basic_json/insert), [update](https://json.nlohmann.me/api/basic_json/update), [swap](https://json.nlohmann.me/api/basic_json/swap)
|
||||||
|
- **Lexicographical comparison operators**: [operator==](https://json.nlohmann.me/api/basic_json/operator_eq), [operator!=](https://json.nlohmann.me/api/basic_json/operator_ne), [operator<](https://json.nlohmann.me/api/basic_json/operator_lt), [operator>](https://json.nlohmann.me/api/basic_json/operator_gt), [operator<=](https://json.nlohmann.me/api/basic_json/operator_le), [operator>=](https://json.nlohmann.me/api/basic_json/operator_ge), [operator<=>](https://json.nlohmann.me/api/basic_json/operator_spaceship)
|
||||||
|
- **Serialization / Dumping**: [dump](https://json.nlohmann.me/api/basic_json/dump)
|
||||||
|
- **Deserialization / Parsing**: [parse](https://json.nlohmann.me/api/basic_json/parse), [accept](https://json.nlohmann.me/api/basic_json/accept), [sax_parse](https://json.nlohmann.me/api/basic_json/sax_parse)
|
||||||
|
- **JSON Pointer functions**: [flatten](https://json.nlohmann.me/api/basic_json/flatten), [unflatten](https://json.nlohmann.me/api/basic_json/unflatten)
|
||||||
|
- **JSON Patch functions**: [patch](https://json.nlohmann.me/api/basic_json/patch), [patch_inplace](https://json.nlohmann.me/api/basic_json/patch_inplace), [diff](https://json.nlohmann.me/api/basic_json/diff), [merge_patch](https://json.nlohmann.me/api/basic_json/merge_patch)
|
||||||
|
- **Static functions**: [meta](https://json.nlohmann.me/api/basic_json/meta), [get_allocator](https://json.nlohmann.me/api/basic_json/get_allocator)
|
||||||
|
- **Binary formats**: [from_bjdata](https://json.nlohmann.me/api/basic_json/from_bjdata), [from_bson](https://json.nlohmann.me/api/basic_json/from_bson), [from_cbor](https://json.nlohmann.me/api/basic_json/from_cbor), [from_msgpack](https://json.nlohmann.me/api/basic_json/from_msgpack), [from_ubjson](https://json.nlohmann.me/api/basic_json/from_ubjson), [to_bjdata](https://json.nlohmann.me/api/basic_json/to_bjdata), [to_bson](https://json.nlohmann.me/api/basic_json/to_bson), [to_cbor](https://json.nlohmann.me/api/basic_json/to_cbor), [to_msgpack](https://json.nlohmann.me/api/basic_json/to_msgpack), [to_ubjson](https://json.nlohmann.me/api/basic_json/to_ubjson)
|
||||||
|
- **Non-member functions**: [operator<<](https://json.nlohmann.me/api/operator_ltlt/), [operator>>](https://json.nlohmann.me/api/operator_gtgt/), [to_string](https://json.nlohmann.me/api/basic_json/to_string)
|
||||||
|
- **Literals**: [operator""_json](https://json.nlohmann.me/api/operator_literal_json)
|
||||||
|
- **Helper classes**: [std::hash<basic_json>](https://json.nlohmann.me/api/basic_json/std_hash), [std::swap<basic_json>](https://json.nlohmann.me/api/basic_json/std_swap)
|
||||||
|
|
||||||
|
[**Full API documentation**](https://json.nlohmann.me/api/basic_json/)
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
Here are some examples to give you an idea how to use the class.
|
Here are some examples to give you an idea how to use the class.
|
||||||
@ -109,9 +139,8 @@ Here are some examples to give you an idea how to use the class.
|
|||||||
Beside the examples below, you may want to:
|
Beside the examples below, you may want to:
|
||||||
|
|
||||||
→ Check the [documentation](https://json.nlohmann.me/)\
|
→ Check the [documentation](https://json.nlohmann.me/)\
|
||||||
→ Browse the [standalone example files](https://github.com/nlohmann/json/tree/develop/docs/examples)
|
→ Browse the [standalone example files](https://github.com/nlohmann/json/tree/develop/docs/mkdocs/docs/examples)\
|
||||||
|
→ Read the full [API Documentation](https://json.nlohmann.me/api/basic_json/) with self-contained examples for every function
|
||||||
Every API function (documented in the [API Documentation](https://json.nlohmann.me/api/basic_json/)) has a corresponding standalone example file. For example, the [`emplace()`](https://json.nlohmann.me/api/basic_json/emplace/) function has a matching [emplace.cpp](https://github.com/nlohmann/json/blob/develop/docs/examples/emplace.cpp) example file.
|
|
||||||
|
|
||||||
### Read JSON from a file
|
### Read JSON from a file
|
||||||
|
|
||||||
@ -547,7 +576,6 @@ int fob_present = o.count("fob"); // 0
|
|||||||
o.erase("foo");
|
o.erase("foo");
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### Conversion from STL containers
|
### Conversion from STL containers
|
||||||
|
|
||||||
Any sequence container (`std::array`, `std::vector`, `std::deque`, `std::forward_list`, `std::list`) whose values can be used to construct JSON values (e.g., integers, floating point numbers, Booleans, string types, or again STL containers described in this section) can be used to create a JSON array. The same holds for similar associative containers (`std::set`, `std::multiset`, `std::unordered_set`, `std::unordered_multiset`), but in these cases the order of the elements of the array depends on how the elements are ordered in the respective STL container.
|
Any sequence container (`std::array`, `std::vector`, `std::deque`, `std::forward_list`, `std::list`) whose values can be used to construct JSON values (e.g., integers, floating point numbers, Booleans, string types, or again STL containers described in this section) can be used to create a JSON array. The same holds for similar associative containers (`std::set`, `std::multiset`, `std::unordered_set`, `std::unordered_multiset`), but in these cases the order of the elements of the array depends on how the elements are ordered in the respective STL container.
|
||||||
@ -803,26 +831,21 @@ Likewise, when calling `template get<your_type>()` or `get_to(your_type&)`, the
|
|||||||
|
|
||||||
Some important things:
|
Some important things:
|
||||||
|
|
||||||
* Those methods **MUST** be in your type's namespace (which can be the global namespace), or the library will not be able to locate them (in this example, they are in namespace `ns`, where `person` is defined).
|
- Those methods **MUST** be in your type's namespace (which can be the global namespace), or the library will not be able to locate them (in this example, they are in namespace `ns`, where `person` is defined).
|
||||||
* Those methods **MUST** be available (e.g., proper headers must be included) everywhere you use these conversions. Look at [issue 1108](https://github.com/nlohmann/json/issues/1108) for errors that may occur otherwise.
|
- Those methods **MUST** be available (e.g., proper headers must be included) everywhere you use these conversions. Look at [issue 1108](https://github.com/nlohmann/json/issues/1108) for errors that may occur otherwise.
|
||||||
* When using `template get<your_type>()`, `your_type` **MUST** be [DefaultConstructible](https://en.cppreference.com/w/cpp/named_req/DefaultConstructible). (There is a way to bypass this requirement described later.)
|
- When using `template get<your_type>()`, `your_type` **MUST** be [DefaultConstructible](https://en.cppreference.com/w/cpp/named_req/DefaultConstructible). (There is a way to bypass this requirement described later.)
|
||||||
* In function `from_json`, use function [`at()`](https://json.nlohmann.me/api/basic_json/at/) to access the object values rather than `operator[]`. In case a key does not exist, `at` throws an exception that you can handle, whereas `operator[]` exhibits undefined behavior.
|
- In function `from_json`, use function [`at()`](https://json.nlohmann.me/api/basic_json/at/) to access the object values rather than `operator[]`. In case a key does not exist, `at` throws an exception that you can handle, whereas `operator[]` exhibits undefined behavior.
|
||||||
* You do not need to add serializers or deserializers for STL types like `std::vector`: the library already implements these.
|
- You do not need to add serializers or deserializers for STL types like `std::vector`: the library already implements these.
|
||||||
|
|
||||||
#### Simplify your life with macros
|
#### Simplify your life with macros
|
||||||
|
|
||||||
If you just want to serialize/deserialize some structs, the `to_json`/`from_json` functions can be a lot of boilerplate.
|
If you just want to serialize/deserialize some structs, the `to_json`/`from_json` functions can be a lot of boilerplate. There are [**several macros**](https://json.nlohmann.me/features/arbitrary_types/#simplify-your-life-with-macros) to make your life easier as long as you (1) want to use a JSON object as serialization and (2) want to use the member variable names as object keys in that object.
|
||||||
|
|
||||||
There are two macros to make your life easier as long as you (1) want to use a JSON object as serialization and (2) want to use the member variable names as object keys in that object:
|
Which macro to choose depends on whether private member variables need to be accessed, a deserialization is needed, missing values should yield an error or should be replaced by default values, and if derived classes are used. See [this overview to choose the right one for your use case](https://json.nlohmann.me/api/macros/#serializationdeserialization-macros).
|
||||||
|
|
||||||
- `NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE(name, member1, member2, ...)` is to be defined inside the namespace of the class/struct to create code for.
|
##### Example usage of macros
|
||||||
- `NLOHMANN_DEFINE_TYPE_INTRUSIVE(name, member1, member2, ...)` is to be defined inside the class/struct to create code for. This macro can also access private members.
|
|
||||||
|
|
||||||
In both macros, the first parameter is the name of the class/struct, and all remaining parameters name the members.
|
The `to_json`/`from_json` functions for the `person` struct above can be created with [`NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE`](https://json.nlohmann.me/api/macros/nlohmann_define_type_non_intrusive/). In all macros, the first parameter is the name of the class/struct, and all remaining parameters name the members.
|
||||||
|
|
||||||
##### Examples
|
|
||||||
|
|
||||||
The `to_json`/`from_json` functions for the `person` struct above can be created with:
|
|
||||||
|
|
||||||
```cpp
|
```cpp
|
||||||
namespace ns {
|
namespace ns {
|
||||||
@ -830,7 +853,7 @@ namespace ns {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Here is an example with private members, where `NLOHMANN_DEFINE_TYPE_INTRUSIVE` is needed:
|
Here is another example with private members, where [`NLOHMANN_DEFINE_TYPE_INTRUSIVE`](https://json.nlohmann.me/api/macros/nlohmann_define_type_intrusive/) is needed:
|
||||||
|
|
||||||
```cpp
|
```cpp
|
||||||
namespace ns {
|
namespace ns {
|
||||||
@ -973,14 +996,14 @@ struct bad_serializer
|
|||||||
{
|
{
|
||||||
template <typename BasicJsonType>
|
template <typename BasicJsonType>
|
||||||
static void to_json(BasicJsonType& j, const T& value) {
|
static void to_json(BasicJsonType& j, const T& value) {
|
||||||
// this calls BasicJsonType::json_serializer<T>::to_json(j, value);
|
// this calls BasicJsonType::json_serializer<T>::to_json(j, value)
|
||||||
// if BasicJsonType::json_serializer == bad_serializer ... oops!
|
// if BasicJsonType::json_serializer == bad_serializer ... oops!
|
||||||
j = value;
|
j = value;
|
||||||
}
|
}
|
||||||
|
|
||||||
template <typename BasicJsonType>
|
template <typename BasicJsonType>
|
||||||
static void to_json(const BasicJsonType& j, T& value) {
|
static void to_json(const BasicJsonType& j, T& value) {
|
||||||
// this calls BasicJsonType::json_serializer<T>::from_json(j, value);
|
// this calls BasicJsonType::json_serializer<T>::from_json(j, value)
|
||||||
// if BasicJsonType::json_serializer == bad_serializer ... oops!
|
// if BasicJsonType::json_serializer == bad_serializer ... oops!
|
||||||
value = j.template get<T>(); // oops!
|
value = j.template get<T>(); // oops!
|
||||||
}
|
}
|
||||||
@ -1030,10 +1053,12 @@ assert(jPi.template get<TaskState>() == TS_INVALID );
|
|||||||
```
|
```
|
||||||
|
|
||||||
Just as in [Arbitrary Type Conversions](#arbitrary-types-conversions) above,
|
Just as in [Arbitrary Type Conversions](#arbitrary-types-conversions) above,
|
||||||
|
|
||||||
- `NLOHMANN_JSON_SERIALIZE_ENUM()` MUST be declared in your enum type's namespace (which can be the global namespace), or the library will not be able to locate it, and it will default to integer serialization.
|
- `NLOHMANN_JSON_SERIALIZE_ENUM()` MUST be declared in your enum type's namespace (which can be the global namespace), or the library will not be able to locate it, and it will default to integer serialization.
|
||||||
- It MUST be available (e.g., proper headers must be included) everywhere you use the conversions.
|
- It MUST be available (e.g., proper headers must be included) everywhere you use the conversions.
|
||||||
|
|
||||||
Other Important points:
|
Other Important points:
|
||||||
|
|
||||||
- When using `template get<ENUM_TYPE>()`, undefined JSON values will default to the first pair specified in your map. Select this default pair carefully.
|
- When using `template get<ENUM_TYPE>()`, undefined JSON values will default to the first pair specified in your map. Select this default pair carefully.
|
||||||
- If an enum or JSON value is specified more than once in your map, the first matching occurrence from the top of the map will be returned when converting to or from JSON.
|
- If an enum or JSON value is specified more than once in your map, the first matching occurrence from the top of the map will be returned when converting to or from JSON.
|
||||||
|
|
||||||
@ -1108,10 +1133,15 @@ binary.set_subtype(0x10);
|
|||||||
auto cbor = json::to_msgpack(j); // 0xD5 (fixext2), 0x10, 0xCA, 0xFE
|
auto cbor = json::to_msgpack(j); // 0xD5 (fixext2), 0x10, 0xCA, 0xFE
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Customers
|
||||||
|
|
||||||
|
The library is used in multiple projects, applications, operating systems, etc. The list below is not exhaustive, but the result of an internet search. If you know further customers of the library, please let me know, see [contact](#contact).
|
||||||
|
|
||||||
|
[](https://json.nlohmann.me/home/customers/)
|
||||||
|
|
||||||
## Supported compilers
|
## Supported compilers
|
||||||
|
|
||||||
Though it's 2024 already, the support for C++11 is still a bit sparse. Currently, the following compilers are known to work:
|
Though it's 2025 already, the support for C++11 is still a bit sparse. Currently, the following compilers are known to work:
|
||||||
|
|
||||||
- GCC 4.8 - 14.2 (and possibly later)
|
- GCC 4.8 - 14.2 (and possibly later)
|
||||||
- Clang 3.4 - 20.0 (and possibly later)
|
- Clang 3.4 - 20.0 (and possibly later)
|
||||||
@ -1127,10 +1157,10 @@ I would be happy to learn about other compilers/versions.
|
|||||||
|
|
||||||
Please note:
|
Please note:
|
||||||
|
|
||||||
- GCC 4.8 has a bug [57824](https://gcc.gnu.org/bugzilla/show_bug.cgi?id=57824)): multiline raw strings cannot be the arguments to macros. Don't use multiline raw strings directly in macros with this compiler.
|
- GCC 4.8 has a bug [57824](https://gcc.gnu.org/bugzilla/show_bug.cgi?id=57824): multiline raw strings cannot be the arguments to macros. Don't use multiline raw strings directly in macros with this compiler.
|
||||||
- Android defaults to using very old compilers and C++ libraries. To fix this, add the following to your `Application.mk`. This will switch to the LLVM C++ library, the Clang compiler, and enable C++11 and other features disabled by default.
|
- Android defaults to using very old compilers and C++ libraries. To fix this, add the following to your `Application.mk`. This will switch to the LLVM C++ library, the Clang compiler, and enable C++11 and other features disabled by default.
|
||||||
|
|
||||||
```
|
```makefile
|
||||||
APP_STL := c++_shared
|
APP_STL := c++_shared
|
||||||
NDK_TOOLCHAIN_VERSION := clang3.6
|
NDK_TOOLCHAIN_VERSION := clang3.6
|
||||||
APP_CPPFLAGS += -frtti -fexceptions
|
APP_CPPFLAGS += -frtti -fexceptions
|
||||||
@ -1142,82 +1172,7 @@ Please note:
|
|||||||
|
|
||||||
- Unsupported versions of GCC and Clang are rejected by `#error` directives. This can be switched off by defining `JSON_SKIP_UNSUPPORTED_COMPILER_CHECK`. Note that you can expect no support in this case.
|
- Unsupported versions of GCC and Clang are rejected by `#error` directives. This can be switched off by defining `JSON_SKIP_UNSUPPORTED_COMPILER_CHECK`. Note that you can expect no support in this case.
|
||||||
|
|
||||||
The following compilers are currently used in continuous integration at [AppVeyor](https://ci.appveyor.com/project/nlohmann/json), [Cirrus CI](https://cirrus-ci.com/github/nlohmann/json), and [GitHub Actions](https://github.com/nlohmann/json/actions):
|
See the page [quality assurance](https://json.nlohmann.me/community/quality_assurance) on the compilers used to check the library in the CI.
|
||||||
|
|
||||||
| Compiler | Operating System | CI Provider |
|
|
||||||
|--------------------------------------------------------------------------------------------------------|--------------------|----------------|
|
|
||||||
| Apple Clang 13.0.0 (clang-1300.0.29.3); Xcode 13.1 | macOS 12.7.6 | GitHub Actions |
|
|
||||||
| Apple Clang 13.0.0 (clang-1300.0.29.30); Xcode 13.2.1 | macOS 12.7.6 | GitHub Actions |
|
|
||||||
| Apple Clang 13.1.6 (clang-1316.0.21.2.3); Xcode 13.3.1 | macOS 12.7.6 | GitHub Actions |
|
|
||||||
| Apple Clang 13.1.6 (clang-1316.0.21.2.5); Xcode 13.4.1 | macOS 12.7.6 | GitHub Actions |
|
|
||||||
| Apple Clang 14.0.0 (clang-1400.0.29.102); Xcode 14.0 | macOS 12.7.6 | GitHub Actions |
|
|
||||||
| Apple Clang 14.0.0 (clang-1400.0.29.102); Xcode 14.0.1 | macOS 12.7.6 | GitHub Actions |
|
|
||||||
| Apple Clang 14.0.0 (clang-1400.0.29.202); Xcode 14.1 | macOS 12.7.6 | GitHub Actions |
|
|
||||||
| Apple Clang 14.0.0 (clang-1400.0.29.202); Xcode 14.2 | macOS 13.7 | GitHub Actions |
|
|
||||||
| Apple Clang 14.0.3 (clang-1403.0.22.14.1); Xcode 14.3 | macOS 13.7 | GitHub Actions |
|
|
||||||
| Apple Clang 14.0.3 (clang-1403.0.22.14.1); Xcode 14.3.1 | macOS 13.7.1 | GitHub Actions |
|
|
||||||
| Apple Clang 15.0.0 (clang-1500.0.40.1); Xcode 15.0.1 | macOS 13.7 | GitHub Actions |
|
|
||||||
| Apple Clang 15.0.0 (clang-1500.1.0.2.5); Xcode 15.1 | macOS 13.7 | GitHub Actions |
|
|
||||||
| Apple Clang 15.0.0 (clang-1500.1.0.2.5); Xcode 15.2 | macOS 13.7 | GitHub Actions |
|
|
||||||
| Apple Clang 15.0.0 (clang-1500.3.9.4); Xcode 15.3 | macOS 14.7 | GitHub Actions |
|
|
||||||
| Apple Clang 15.0.0 (clang-1500.3.9.4); Xcode 15.4 | macOS 14.7 | GitHub Actions |
|
|
||||||
| Apple Clang 16.0.0 (clang-1600.0.26.3); Xcode 16.0 | macOS 15.0.1 | GitHub Actions |
|
|
||||||
| Apple Clang 16.0.0 (clang-1600.0.26.4); Xcode 16.1 | macOS 15.0.1 | GitHub Actions |
|
|
||||||
| Clang 3.5.2 | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| Clang 3.6.2 | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| Clang 3.7.1 | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| Clang 3.8.1 | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| Clang 3.9.1 | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| Clang 4.0.1 | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| Clang 5.0.2 | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| Clang 6.0.1 | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| Clang 7.0.1 | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| Clang 8.0.0 | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| Clang 9.0.0 | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| Clang 10.0.0 | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| Clang 10.0.0 with GNU-like command-line | Windows-10.0.17763 | GitHub Actions |
|
|
||||||
| Clang 11.0.0 with GNU-like command-line | Windows-10.0.17763 | GitHub Actions |
|
|
||||||
| Clang 11.0.0 with MSVC-like command-line | Windows-10.0.17763 | GitHub Actions |
|
|
||||||
| Clang 11.0.0 | Ubuntu 20.04.3 LTS | GitHub Actions |
|
|
||||||
| Clang 12.0.0 | Ubuntu 20.04.3 LTS | GitHub Actions |
|
|
||||||
| Clang 12.0.0 with GNU-like command-line | Windows-10.0.17763 | GitHub Actions |
|
|
||||||
| Clang 13.0.0 | Ubuntu 20.04.3 LTS | GitHub Actions |
|
|
||||||
| Clang 13.0.0 with GNU-like command-line | Windows-10.0.17763 | GitHub Actions |
|
|
||||||
| Clang 14.0.0 | Ubuntu 20.04.3 LTS | GitHub Actions |
|
|
||||||
| Clang 14.0.0 with GNU-like command-line | Windows-10.0.17763 | GitHub Actions |
|
|
||||||
| Clang 15.0.0 with GNU-like command-line | Windows-10.0.17763 | GitHub Actions |
|
|
||||||
| Clang 15.0.4 | Ubuntu 20.04.3 LTS | GitHub Actions |
|
|
||||||
| Clang 16.0.0 (16.0.0-++20221031071727+500876226c60-1~exp1~20221031071831.439) | Ubuntu 20.04.3 LTS | GitHub Actions |
|
|
||||||
| Clang 16.0.6 (++20231112084702+7cbf1a259152-1~exp1~20231112084757.16) | Ubuntu 20.04.1 LTS | GitHub Actions |
|
|
||||||
| Clang 17.0.6 (++20231208085813+6009708b4367-1~exp1~20231208085906.81) | Ubuntu 20.04.1 LTS | GitHub Actions |
|
|
||||||
| Clang 18.1.8 (++20240731024826+3b5b5c1ec4a3-1~exp1~20240731144843.145) | Ubuntu 20.04.1 LTS | GitHub Actions |
|
|
||||||
| Clang 19.1.2 (++20241016063422+7ba7d8e2f7b6-1~exp1~20241016063541.55) | Ubuntu 20.04.1 LTS | GitHub Actions |
|
|
||||||
| Clang 20.0.0 (++20241022113049+f1ade1f874db-1~exp1~20241022113104.1036) | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| GCC 4.8.5 (Ubuntu 4.8.5-4ubuntu8) | Ubuntu 20.04.4 LTS | GitHub Actions |
|
|
||||||
| GCC 4.9.3 (Ubuntu 4.9.3-13ubuntu2) | Ubuntu 20.04.4 LTS | GitHub Actions |
|
|
||||||
| GCC 4.8.5 (Ubuntu 4.8.5-4ubuntu2) | Ubuntu 20.04.4 LTS | GitHub Actions |
|
|
||||||
| GCC 5.5.0 (Ubuntu 5.5.0-12ubuntu1) | Ubuntu 20.04.4 LTS | GitHub Actions |
|
|
||||||
| GCC 6.4.0 (Ubuntu 6.4.0-17ubuntu1) | Ubuntu 20.04.4 LTS | GitHub Actions |
|
|
||||||
| GCC 7.5.0 | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| GCC 8.1.0 (i686-posix-dwarf-rev0, Built by MinGW-W64 project) | Windows-10.0.17763 | GitHub Actions |
|
|
||||||
| GCC 8.1.0 (x86_64-posix-seh-rev0, Built by MinGW-W64 project) | Windows-10.0.17763 | GitHub Actions |
|
|
||||||
| GCC 8.5.0 | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| GCC 9.5.0 | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| GCC 10.5.0 | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| GCC 11.1.0 | Ubuntu (aarch64) | Cirrus CI |
|
|
||||||
| GCC 11.5.0 | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| GCC 12.4.0 | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| GCC 13.0.0 20220605 (experimental) | Ubuntu 20.04.3 LTS | GitHub Actions |
|
|
||||||
| GCC 13.3.0 | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| GCC 14.2.0 | Ubuntu 22.04.1 LTS | GitHub Actions |
|
|
||||||
| Intel C++ Compiler 2021.5.0.20211109 | Ubuntu 20.04.3 LTS | GitHub Actions |
|
|
||||||
| NVCC 11.0.221 | Ubuntu 20.04.3 LTS | GitHub Actions |
|
|
||||||
| Visual Studio 14 2015 MSVC 19.0.24241.7 (Build Engine version 14.0.25420.1) | Windows-6.3.9600 | AppVeyor |
|
|
||||||
| Visual Studio 15 2017 MSVC 19.16.27035.0 (Build Engine version 15.9.21+g9802d43bc3 for .NET Framework) | Windows-10.0.14393 | AppVeyor |
|
|
||||||
| Visual Studio 16 2019 MSVC 19.28.29912.0 (Build Engine version 16.9.0+57a23d249 for .NET Framework) | Windows-10.0.17763 | GitHub Actions |
|
|
||||||
| Visual Studio 16 2019 MSVC 19.28.29912.0 (Build Engine version 16.9.0+57a23d249 for .NET Framework) | Windows-10.0.17763 | AppVeyor |
|
|
||||||
| Visual Studio 17 2022 MSVC 19.30.30709.0 (Build Engine version 17.0.31804.368 for .NET Framework) | Windows-10.0.20348 | GitHub Actions |
|
|
||||||
|
|
||||||
|
|
||||||
## Integration
|
## Integration
|
||||||
|
|
||||||
@ -1244,7 +1199,7 @@ To use this library from a CMake project, you can locate it directly with `find_
|
|||||||
|
|
||||||
```cmake
|
```cmake
|
||||||
# CMakeLists.txt
|
# CMakeLists.txt
|
||||||
find_package(nlohmann_json 3.2.0 REQUIRED)
|
find_package(nlohmann_json 3.11.3 REQUIRED)
|
||||||
...
|
...
|
||||||
add_library(foo ...)
|
add_library(foo ...)
|
||||||
...
|
...
|
||||||
@ -1284,6 +1239,7 @@ Since CMake v3.11,
|
|||||||
be used to automatically download a release as a dependency at configure time.
|
be used to automatically download a release as a dependency at configure time.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
```cmake
|
```cmake
|
||||||
include(FetchContent)
|
include(FetchContent)
|
||||||
|
|
||||||
@ -1314,11 +1270,12 @@ add_library(foo ...)
|
|||||||
# import method
|
# import method
|
||||||
target_link_libraries(foo PRIVATE nlohmann_json::nlohmann_json)
|
target_link_libraries(foo PRIVATE nlohmann_json::nlohmann_json)
|
||||||
```
|
```
|
||||||
|
|
||||||
```cmake
|
```cmake
|
||||||
# thirdparty/CMakeLists.txt
|
# thirdparty/CMakeLists.txt
|
||||||
...
|
...
|
||||||
if(FOO_USE_EXTERNAL_JSON)
|
if(FOO_USE_EXTERNAL_JSON)
|
||||||
find_package(nlohmann_json 3.2.0 REQUIRED)
|
find_package(nlohmann_json 3.11.3 REQUIRED)
|
||||||
else()
|
else()
|
||||||
set(JSON_BuildTests OFF CACHE INTERNAL "")
|
set(JSON_BuildTests OFF CACHE INTERNAL "")
|
||||||
add_subdirectory(nlohmann_json)
|
add_subdirectory(nlohmann_json)
|
||||||
@ -1330,51 +1287,24 @@ endif()
|
|||||||
|
|
||||||
### Package Managers
|
### Package Managers
|
||||||
|
|
||||||
:beer: If you are using OS X and [Homebrew](https://brew.sh), just type `brew install nlohmann-json` and you're set. If you want the bleeding edge rather than the latest release, use `brew install nlohmann-json --HEAD`. See [nlohmann-json](https://formulae.brew.sh/formula/nlohmann-json) for more information.
|
Use your favorite [**package manager**](https://json.nlohmann.me/integration/package_managers/) to use the library.
|
||||||
|
|
||||||
If you are using the [Meson Build System](https://mesonbuild.com), add this source tree as a [meson subproject](https://mesonbuild.com/Subprojects.html#using-a-subproject). You may also use the `include.zip` published in this project's [Releases](https://github.com/nlohmann/json/releases) to reduce the size of the vendored source tree. Alternatively, you can get a wrap file by downloading it from [Meson WrapDB](https://wrapdb.mesonbuild.com/nlohmann_json), or simply use `meson wrap install nlohmann_json`. Please see the meson project for any issues regarding the packaging.
|
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/homebrew.svg" height="20"> [**Homebrew**](https://json.nlohmann.me/integration/package_managers/#homebrew) `nlohmann-json`
|
||||||
|
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/meson.svg" height="20"> [**Meson**](https://json.nlohmann.me/integration/package_managers/#meson) `nlohmann_json`
|
||||||
|
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/bazel.svg" height="20"> [**Bazel**](https://json.nlohmann.me/integration/package_managers/#bazel) `nlohmann_json`
|
||||||
|
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/conan.svg" height="20"> [**Conan**](https://json.nlohmann.me/integration/package_managers/#conan) `nlohmann_json`
|
||||||
|
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/spack.svg" height="20"> [**Spack**](https://json.nlohmann.me/integration/package_managers/#spack) `nlohmann-json`
|
||||||
|
- [**Hunter**](https://json.nlohmann.me/integration/package_managers/#hunter) `nlohmann_json`
|
||||||
|
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/vcpkg.png" height="20"> [**vcpkg**](https://json.nlohmann.me/integration/package_managers/#vcpkg) `nlohmann-json`
|
||||||
|
- [**cget**](https://json.nlohmann.me/integration/package_managers/#cget) `nlohmann/json`
|
||||||
|
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/swift.svg" height="20"> [**Swift Package Manager**](https://json.nlohmann.me/integration/package_managers/#swift-package-manager) `nlohmann/json`
|
||||||
|
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/nuget.svg" height="20"> [**Nuget**](https://json.nlohmann.me/integration/package_managers/#nuget) `nlohmann.json`
|
||||||
|
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/conda.svg" height="20"> [**Conda**](https://json.nlohmann.me/integration/package_managers/#conda) `nlohmann_json`
|
||||||
|
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/macports.svg" height="20"> [**MacPorts**](https://json.nlohmann.me/integration/package_managers/#macports) `nlohmann-json`
|
||||||
|
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/CPM.png" height="20"> [**cpm.cmake**](https://json.nlohmann.me/integration/package_managers/#cpmcmake) `gh:nlohmann/json`
|
||||||
|
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/xmake.svg" height="20"> [**xmake**](https://json.nlohmann.me/integration/package_managers/#xmake) `nlohmann_json`
|
||||||
|
|
||||||
The provided `meson.build` can also be used as an alternative to CMake for installing `nlohmann_json` system-wide in which case a pkg-config file is installed. To use it, simply have your build system require the `nlohmann_json` pkg-config dependency. In Meson, it is preferred to use the [`dependency()`](https://mesonbuild.com/Reference-manual.html#dependency) object with a subproject fallback, rather than using the subproject directly.
|
The library is part of many package managers. See the [**documentation**](https://json.nlohmann.me/integration/package_managers/) for detailed descriptions and examples.
|
||||||
|
|
||||||
If you are using [Bazel](https://bazel.build/) you can simply reference this repository using `http_archive` or `git_repository` and depend on `@nlohmann_json//:json`.
|
|
||||||
|
|
||||||
If you are using [Conan](https://www.conan.io/) to manage your dependencies, merely add [`nlohmann_json/x.y.z`](https://conan.io/center/nlohmann_json) to your `conanfile`'s requires, where `x.y.z` is the release version you want to use. Please file issues [here](https://github.com/conan-io/conan-center-index/issues) if you experience problems with the packages.
|
|
||||||
|
|
||||||
If you are using [Spack](https://www.spack.io/) to manage your dependencies, you can use the [`nlohmann-json` package](https://spack.readthedocs.io/en/latest/package_list.html#nlohmann-json). Please see the [spack project](https://github.com/spack/spack) for any issues regarding the packaging.
|
|
||||||
|
|
||||||
If you are using [hunter](https://github.com/cpp-pm/hunter) on your project for external dependencies, then you can use the [nlohmann_json package](https://hunter.readthedocs.io/en/latest/packages/pkg/nlohmann_json.html). Please see the hunter project for any issues regarding the packaging.
|
|
||||||
|
|
||||||
If you are using [Buckaroo](https://buckaroo.pm), you can install this library's module with `buckaroo add github.com/buckaroo-pm/nlohmann-json`. Please file issues [here](https://github.com/buckaroo-pm/nlohmann-json). There is a demo repo [here](https://github.com/njlr/buckaroo-nholmann-json-example).
|
|
||||||
|
|
||||||
If you are using [vcpkg](https://github.com/Microsoft/vcpkg/) on your project for external dependencies, then you can install the [nlohmann-json package](https://github.com/Microsoft/vcpkg/tree/master/ports/nlohmann-json) with `vcpkg install nlohmann-json` and follow the then displayed descriptions. Please see the vcpkg project for any issues regarding the packaging.
|
|
||||||
|
|
||||||
If you are using [cget](https://cget.readthedocs.io/en/latest/), you can install the latest development version with `cget install nlohmann/json`. A specific version can be installed with `cget install nlohmann/json@v3.1.0`. Also, the multiple header version can be installed by adding the `-DJSON_MultipleHeaders=ON` flag (i.e., `cget install nlohmann/json -DJSON_MultipleHeaders=ON`).
|
|
||||||
|
|
||||||
If you are using [CocoaPods](https://cocoapods.org), you can use the library by adding pod `"nlohmann_json", '~>3.1.2'` to your podfile (see [an example](https://bitbucket.org/benman/nlohmann_json-cocoapod/src/master/)). Please file issues [here](https://bitbucket.org/benman/nlohmann_json-cocoapod/issues?status=new&status=open).
|
|
||||||
|
|
||||||
If you are using [Swift Package Manager](https://swift.org/package-manager/), you can use the library by adding a package dependency to this repository. And target dependency as `.product(name: "nlohmann-json", package: "json")`.
|
|
||||||
|
|
||||||
If you are using [NuGet](https://www.nuget.org), you can use the package [nlohmann.json](https://www.nuget.org/packages/nlohmann.json/). Please check [this extensive description](https://github.com/nlohmann/json/issues/1132#issuecomment-452250255) on how to use the package. Please file issues [here](https://github.com/hnkb/nlohmann-json-nuget/issues).
|
|
||||||
|
|
||||||
If you are using [conda](https://conda.io/), you can use the package [nlohmann_json](https://github.com/conda-forge/nlohmann_json-feedstock) from [conda-forge](https://conda-forge.org) executing `conda install -c conda-forge nlohmann_json`. Please file issues [here](https://github.com/conda-forge/nlohmann_json-feedstock/issues).
|
|
||||||
|
|
||||||
If you are using [MSYS2](https://www.msys2.org/), you can use the [mingw-w64-nlohmann-json](https://packages.msys2.org/base/mingw-w64-nlohmann-json) package, just type `pacman -S mingw-w64-i686-nlohmann-json` or `pacman -S mingw-w64-x86_64-nlohmann-json` for installation. Please file issues [here](https://github.com/msys2/MINGW-packages/issues/new?title=%5Bnlohmann-json%5D) if you experience problems with the packages.
|
|
||||||
|
|
||||||
If you are using [MacPorts](https://ports.macports.org), execute `sudo port install nlohmann-json` to install the [nlohmann-json](https://ports.macports.org/port/nlohmann-json/) package.
|
|
||||||
|
|
||||||
If you are using [`build2`](https://build2.org), you can use the [`nlohmann-json`](https://cppget.org/nlohmann-json) package from the public repository https://cppget.org or directly from the [package's sources repository](https://github.com/build2-packaging/nlohmann-json). In your project's `manifest` file, just add `depends: nlohmann-json` (probably with some [version constraints](https://build2.org/build2-toolchain/doc/build2-toolchain-intro.xhtml#guide-add-remove-deps)). If you are not familiar with using dependencies in `build2`, [please read this introduction](https://build2.org/build2-toolchain/doc/build2-toolchain-intro.xhtml).
|
|
||||||
Please file issues [here](https://github.com/build2-packaging/nlohmann-json) if you experience problems with the packages.
|
|
||||||
|
|
||||||
If you are using [`wsjcpp`](https://wsjcpp.org), you can use the command `wsjcpp install "https://github.com/nlohmann/json:develop"` to get the latest version. Note you can change the branch ":develop" to an existing tag or another branch.
|
|
||||||
|
|
||||||
If you are using [`CPM.cmake`](https://github.com/TheLartians/CPM.cmake), you can check this [`example`](https://github.com/TheLartians/CPM.cmake/tree/master/examples/json). After [adding CPM script](https://github.com/TheLartians/CPM.cmake#adding-cpm) to your project, implement the following snippet to your CMake:
|
|
||||||
|
|
||||||
```cmake
|
|
||||||
CPMAddPackage(
|
|
||||||
NAME nlohmann_json
|
|
||||||
GITHUB_REPOSITORY nlohmann/json
|
|
||||||
VERSION 3.9.1)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Pkg-config
|
### Pkg-config
|
||||||
|
|
||||||
@ -1384,20 +1314,13 @@ If you are using bare Makefiles, you can use `pkg-config` to generate the includ
|
|||||||
pkg-config nlohmann_json --cflags
|
pkg-config nlohmann_json --cflags
|
||||||
```
|
```
|
||||||
|
|
||||||
Users of the Meson build system will also be able to use a system-wide library, which will be found by `pkg-config`:
|
|
||||||
|
|
||||||
```meson
|
|
||||||
json = dependency('nlohmann_json', required: true)
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
<img align="right" src="https://opensource.org/trademarks/opensource/OSI-Approved-License-100x137.png">
|
<img align="right" src="https://149753425.v2.pressablecdn.com/wp-content/uploads/2009/06/OSIApproved_100X125.png" alt="OSI approved license">
|
||||||
|
|
||||||
The class is licensed under the [MIT License](https://opensource.org/licenses/MIT):
|
The class is licensed under the [MIT License](https://opensource.org/licenses/MIT):
|
||||||
|
|
||||||
Copyright © 2013-2022 [Niels Lohmann](https://nlohmann.me)
|
Copyright © 2013-2025 [Niels Lohmann](https://nlohmann.me)
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
@ -1407,13 +1330,19 @@ THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR I
|
|||||||
|
|
||||||
* * *
|
* * *
|
||||||
|
|
||||||
The class contains the UTF-8 Decoder from Bjoern Hoehrmann which is licensed under the [MIT License](https://opensource.org/licenses/MIT) (see above). Copyright © 2008-2009 [Björn Hoehrmann](https://bjoern.hoehrmann.de/) <bjoern@hoehrmann.de>
|
- The class contains the UTF-8 Decoder from Bjoern Hoehrmann which is licensed under the [MIT License](https://opensource.org/licenses/MIT) (see above). Copyright © 2008-2009 [Björn Hoehrmann](https://bjoern.hoehrmann.de/) <bjoern@hoehrmann.de>
|
||||||
|
- The class contains a slightly modified version of the Grisu2 algorithm from Florian Loitsch which is licensed under the [MIT License](https://opensource.org/licenses/MIT) (see above). Copyright © 2009 [Florian Loitsch](https://florian.loitsch.com/)
|
||||||
|
- The class contains a copy of [Hedley](https://nemequ.github.io/hedley/) from Evan Nemerson which is licensed as [CC0-1.0](https://creativecommons.org/publicdomain/zero/1.0/).
|
||||||
|
- The class contains parts of [Google Abseil](https://github.com/abseil/abseil-cpp) which is licensed under the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0).
|
||||||
|
|
||||||
The class contains a slightly modified version of the Grisu2 algorithm from Florian Loitsch which is licensed under the [MIT License](https://opensource.org/licenses/MIT) (see above). Copyright © 2009 [Florian Loitsch](https://florian.loitsch.com/)
|
<img align="right" src="https://git.fsfe.org/reuse/reuse-ci/raw/branch/master/reuse-horizontal.png" alt="REUSE Software">
|
||||||
|
|
||||||
The class contains a copy of [Hedley](https://nemequ.github.io/hedley/) from Evan Nemerson which is licensed as [CC0-1.0](https://creativecommons.org/publicdomain/zero/1.0/).
|
The library is compliant to version 3.3 of the [**REUSE specification**](https://reuse.software):
|
||||||
|
|
||||||
The class contains parts of [Google Abseil](https://github.com/abseil/abseil-cpp) which is licensed under the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0).
|
- Every source file contains an SPDX copyright header.
|
||||||
|
- The full text of all licenses used in the repository can be found in the `LICENSES` folder.
|
||||||
|
- File `.reuse/dep5` contains an overview of all files' copyrights and licenses.
|
||||||
|
- Run `pipx run reuse lint` to verify the project's REUSE compliance and `pipx run reuse spdx` to generate a SPDX SBOM.
|
||||||
|
|
||||||
## Contact
|
## Contact
|
||||||
|
|
||||||
@ -1429,7 +1358,7 @@ Only if your request would contain confidential information, please [send me an
|
|||||||
|
|
||||||
I deeply appreciate the help of the following people.
|
I deeply appreciate the help of the following people.
|
||||||
|
|
||||||
<img src="https://raw.githubusercontent.com/nlohmann/json/develop/docs/avatars.png" align="right">
|
<img src="https://raw.githubusercontent.com/nlohmann/json/develop/docs/avatars.png" align="right" alt="GitHub avatars of the contributors">
|
||||||
|
|
||||||
1. [Teemperor](https://github.com/Teemperor) implemented CMake support and lcov integration, realized escape and Unicode handling in the string parser, and fixed the JSON serialization.
|
1. [Teemperor](https://github.com/Teemperor) implemented CMake support and lcov integration, realized escape and Unicode handling in the string parser, and fixed the JSON serialization.
|
||||||
2. [elliotgoodrich](https://github.com/elliotgoodrich) fixed an issue with double deletion in the iterator classes.
|
2. [elliotgoodrich](https://github.com/elliotgoodrich) fixed an issue with double deletion in the iterator classes.
|
||||||
@ -1548,7 +1477,7 @@ I deeply appreciate the help of the following people.
|
|||||||
115. [Matthias Möller](https://github.com/TinyTinni) removed the dependency from `std::stringstream`.
|
115. [Matthias Möller](https://github.com/TinyTinni) removed the dependency from `std::stringstream`.
|
||||||
116. [agrianius](https://github.com/agrianius) added code to use alternative string implementations.
|
116. [agrianius](https://github.com/agrianius) added code to use alternative string implementations.
|
||||||
117. [Daniel599](https://github.com/Daniel599) allowed to use more algorithms with the `items()` function.
|
117. [Daniel599](https://github.com/Daniel599) allowed to use more algorithms with the `items()` function.
|
||||||
118. [Julius Rakow](https://github.com/jrakow) fixed the Meson include directory and fixed the links to [cppreference.com](cppreference.com).
|
118. [Julius Rakow](https://github.com/jrakow) fixed the Meson include directory and fixed the links to [cppreference.com](https://cppreference.com).
|
||||||
119. [Sonu Lohani](https://github.com/sonulohani) fixed the compilation with MSVC 2015 in debug mode.
|
119. [Sonu Lohani](https://github.com/sonulohani) fixed the compilation with MSVC 2015 in debug mode.
|
||||||
120. [grembo](https://github.com/grembo) fixed the test suite and re-enabled several test cases.
|
120. [grembo](https://github.com/grembo) fixed the test suite and re-enabled several test cases.
|
||||||
121. [Hyeon Kim](https://github.com/simnalamburt) introduced the macro `JSON_INTERNAL_CATCH` to control the exception handling inside the library.
|
121. [Hyeon Kim](https://github.com/simnalamburt) introduced the macro `JSON_INTERNAL_CATCH` to control the exception handling inside the library.
|
||||||
@ -1780,7 +1709,6 @@ I deeply appreciate the help of the following people.
|
|||||||
|
|
||||||
Thanks a lot for helping out! Please [let me know](mailto:mail@nlohmann.me) if I forgot someone.
|
Thanks a lot for helping out! Please [let me know](mailto:mail@nlohmann.me) if I forgot someone.
|
||||||
|
|
||||||
|
|
||||||
## Used third-party tools
|
## Used third-party tools
|
||||||
|
|
||||||
The library itself consists of a single header file licensed under the MIT license. However, it is built, tested, documented, and whatnot using a lot of third-party tools and services. Thanks a lot!
|
The library itself consists of a single header file licensed under the MIT license. However, it is built, tested, documented, and whatnot using a lot of third-party tools and services. Thanks a lot!
|
||||||
@ -1791,16 +1719,15 @@ The library itself consists of a single header file licensed under the MIT licen
|
|||||||
- [**Artistic Style**](http://astyle.sourceforge.net) for automatic source code indentation
|
- [**Artistic Style**](http://astyle.sourceforge.net) for automatic source code indentation
|
||||||
- [**Clang**](https://clang.llvm.org) for compilation with code sanitizers
|
- [**Clang**](https://clang.llvm.org) for compilation with code sanitizers
|
||||||
- [**CMake**](https://cmake.org) for build automation
|
- [**CMake**](https://cmake.org) for build automation
|
||||||
- [**Codacy**](https://www.codacy.com) for further [code analysis](https://www.codacy.com/app/nlohmann/json)
|
- [**Codacy**](https://www.codacy.com) for further [code analysis](https://app.codacy.com/gh/nlohmann/json/dashboard)
|
||||||
- [**Coveralls**](https://coveralls.io) to measure [code coverage](https://coveralls.io/github/nlohmann/json)
|
- [**Coveralls**](https://coveralls.io) to measure [code coverage](https://coveralls.io/github/nlohmann/json)
|
||||||
- [**Coverity Scan**](https://scan.coverity.com) for [static analysis](https://scan.coverity.com/projects/nlohmann-json)
|
- [**Coverity Scan**](https://scan.coverity.com) for [static analysis](https://scan.coverity.com/projects/nlohmann-json)
|
||||||
- [**cppcheck**](http://cppcheck.sourceforge.net) for static analysis
|
- [**cppcheck**](http://cppcheck.sourceforge.net) for static analysis
|
||||||
- [**doctest**](https://github.com/onqtam/doctest) for the unit tests
|
- [**doctest**](https://github.com/onqtam/doctest) for the unit tests
|
||||||
- [**git-update-ghpages**](https://github.com/rstacruz/git-update-ghpages) to upload the documentation to gh-pages
|
|
||||||
- [**GitHub Changelog Generator**](https://github.com/skywinder/github-changelog-generator) to generate the [ChangeLog](https://github.com/nlohmann/json/blob/develop/ChangeLog.md)
|
- [**GitHub Changelog Generator**](https://github.com/skywinder/github-changelog-generator) to generate the [ChangeLog](https://github.com/nlohmann/json/blob/develop/ChangeLog.md)
|
||||||
- [**Google Benchmark**](https://github.com/google/benchmark) to implement the benchmarks
|
- [**Google Benchmark**](https://github.com/google/benchmark) to implement the benchmarks
|
||||||
- [**Hedley**](https://nemequ.github.io/hedley/) to avoid re-inventing several compiler-agnostic feature macros
|
- [**Hedley**](https://nemequ.github.io/hedley/) to avoid re-inventing several compiler-agnostic feature macros
|
||||||
- [**lcov**](http://ltp.sourceforge.net/coverage/lcov.php) to process coverage information and create an HTML view
|
- [**lcov**](https://github.com/linux-test-project/lcov) to process coverage information and create an HTML view
|
||||||
- [**libFuzzer**](https://llvm.org/docs/LibFuzzer.html) to implement fuzz testing for OSS-Fuzz
|
- [**libFuzzer**](https://llvm.org/docs/LibFuzzer.html) to implement fuzz testing for OSS-Fuzz
|
||||||
- [**Material for MkDocs**](https://squidfunk.github.io/mkdocs-material/) for the style of the documentation site
|
- [**Material for MkDocs**](https://squidfunk.github.io/mkdocs-material/) for the style of the documentation site
|
||||||
- [**MkDocs**](https://www.mkdocs.org) for the documentation site
|
- [**MkDocs**](https://www.mkdocs.org) for the documentation site
|
||||||
@ -1808,12 +1735,6 @@ The library itself consists of a single header file licensed under the MIT licen
|
|||||||
- [**Probot**](https://probot.github.io) for automating maintainer tasks such as closing stale issues, requesting missing information, or detecting toxic comments.
|
- [**Probot**](https://probot.github.io) for automating maintainer tasks such as closing stale issues, requesting missing information, or detecting toxic comments.
|
||||||
- [**Valgrind**](https://valgrind.org) to check for correct memory management
|
- [**Valgrind**](https://valgrind.org) to check for correct memory management
|
||||||
|
|
||||||
|
|
||||||
## Projects using JSON for Modern C++
|
|
||||||
|
|
||||||
The library is currently used in Apple macOS Sierra-Monterey and iOS 10-15. I am not sure what they are using the library for, but I am happy that it runs on so many devices.
|
|
||||||
|
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
### Character encoding
|
### Character encoding
|
||||||
@ -1837,7 +1758,7 @@ This library does not support comments by default. It does so for three reasons:
|
|||||||
2. This was not an oversight: Douglas Crockford [wrote on this](https://plus.google.com/118095276221607585885/posts/RK8qyGVaGSr) in May 2012:
|
2. This was not an oversight: Douglas Crockford [wrote on this](https://plus.google.com/118095276221607585885/posts/RK8qyGVaGSr) in May 2012:
|
||||||
|
|
||||||
> I removed comments from JSON because I saw people were using them to hold parsing directives, a practice which would have destroyed interoperability. I know that the lack of comments makes some people sad, but it shouldn't.
|
> I removed comments from JSON because I saw people were using them to hold parsing directives, a practice which would have destroyed interoperability. I know that the lack of comments makes some people sad, but it shouldn't.
|
||||||
|
>
|
||||||
> Suppose you are using JSON to keep configuration files, which you would like to annotate. Go ahead and insert all the comments you like. Then pipe it through JSMin before handing it to your JSON parser.
|
> Suppose you are using JSON to keep configuration files, which you would like to annotate. Go ahead and insert all the comments you like. Then pipe it through JSMin before handing it to your JSON parser.
|
||||||
|
|
||||||
3. It is dangerous for interoperability if some libraries would add comment support while others don't. Please check [The Harmful Consequences of the Robustness Principle](https://tools.ietf.org/html/draft-iab-protocol-maintenance-01) on this.
|
3. It is dangerous for interoperability if some libraries would add comment support while others don't. Please check [The Harmful Consequences of the Robustness Principle](https://tools.ietf.org/html/draft-iab-protocol-maintenance-01) on this.
|
||||||
@ -1850,6 +1771,8 @@ By default, the library does not preserve the **insertion order of object elemen
|
|||||||
|
|
||||||
If you do want to preserve the insertion order, you can try the type [`nlohmann::ordered_json`](https://github.com/nlohmann/json/issues/2179). Alternatively, you can use a more sophisticated ordered map like [`tsl::ordered_map`](https://github.com/Tessil/ordered-map) ([integration](https://github.com/nlohmann/json/issues/546#issuecomment-304447518)) or [`nlohmann::fifo_map`](https://github.com/nlohmann/fifo_map) ([integration](https://github.com/nlohmann/json/issues/485#issuecomment-333652309)).
|
If you do want to preserve the insertion order, you can try the type [`nlohmann::ordered_json`](https://github.com/nlohmann/json/issues/2179). Alternatively, you can use a more sophisticated ordered map like [`tsl::ordered_map`](https://github.com/Tessil/ordered-map) ([integration](https://github.com/nlohmann/json/issues/546#issuecomment-304447518)) or [`nlohmann::fifo_map`](https://github.com/nlohmann/fifo_map) ([integration](https://github.com/nlohmann/json/issues/485#issuecomment-333652309)).
|
||||||
|
|
||||||
|
See the [**documentation on object order**](https://json.nlohmann.me/features/object_order/) for more information.
|
||||||
|
|
||||||
### Memory Release
|
### Memory Release
|
||||||
|
|
||||||
We checked with Valgrind and the Address Sanitizer (ASAN) that there are no memory leaks.
|
We checked with Valgrind and the Address Sanitizer (ASAN) that there are no memory leaks.
|
||||||
@ -1861,21 +1784,21 @@ Here is a related issue [#1924](https://github.com/nlohmann/json/issues/1924).
|
|||||||
|
|
||||||
### Further notes
|
### Further notes
|
||||||
|
|
||||||
- The code contains numerous debug **assertions** which can be switched off by defining the preprocessor macro `NDEBUG`, see the [documentation of `assert`](https://en.cppreference.com/w/cpp/error/assert). In particular, note [`operator[]`](https://json.nlohmann.me/api/basic_json/operator%5B%5D/) implements **unchecked access** for const objects: If the given key is not present, the behavior is undefined (think of a dereferenced null pointer) and yields an [assertion failure](https://github.com/nlohmann/json/issues/289) if assertions are switched on. If you are not sure whether an element in an object exists, use checked access with the [`at()` function](https://json.nlohmann.me/api/basic_json/at/). Furthermore, you can define `JSON_ASSERT(x)` to replace calls to `assert(x)`.
|
- The code contains numerous debug **assertions** which can be switched off by defining the preprocessor macro `NDEBUG`, see the [documentation of `assert`](https://en.cppreference.com/w/cpp/error/assert). In particular, note [`operator[]`](https://json.nlohmann.me/api/basic_json/operator%5B%5D/) implements **unchecked access** for const objects: If the given key is not present, the behavior is undefined (think of a dereferenced null pointer) and yields an [assertion failure](https://github.com/nlohmann/json/issues/289) if assertions are switched on. If you are not sure whether an element in an object exists, use checked access with the [`at()` function](https://json.nlohmann.me/api/basic_json/at/). Furthermore, you can define `JSON_ASSERT(x)` to replace calls to `assert(x)`. See the [**documentation on runtime assertions**](https://json.nlohmann.me/features/assertions/) for more information.
|
||||||
- As the exact number type is not defined in the [JSON specification](https://tools.ietf.org/html/rfc8259.html), this library tries to choose the best fitting C++ number type automatically. As a result, the type `double` may be used to store numbers which may yield [**floating-point exceptions**](https://github.com/nlohmann/json/issues/181) in certain rare situations if floating-point exceptions have been unmasked in the calling code. These exceptions are not caused by the library and need to be fixed in the calling code, such as by re-masking the exceptions prior to calling library functions.
|
- As the exact number type is not defined in the [JSON specification](https://tools.ietf.org/html/rfc8259.html), this library tries to choose the best fitting C++ number type automatically. As a result, the type `double` may be used to store numbers which may yield [**floating-point exceptions**](https://github.com/nlohmann/json/issues/181) in certain rare situations if floating-point exceptions have been unmasked in the calling code. These exceptions are not caused by the library and need to be fixed in the calling code, such as by re-masking the exceptions prior to calling library functions.
|
||||||
- The code can be compiled without C++ **runtime type identification** features; that is, you can use the `-fno-rtti` compiler flag.
|
- The code can be compiled without C++ **runtime type identification** features; that is, you can use the `-fno-rtti` compiler flag.
|
||||||
- **Exceptions** are used widely within the library. They can, however, be switched off with either using the compiler flag `-fno-exceptions` or by defining the symbol `JSON_NOEXCEPTION`. In this case, exceptions are replaced by `abort()` calls. You can further control this behavior by defining `JSON_THROW_USER` (overriding `throw`), `JSON_TRY_USER` (overriding `try`), and `JSON_CATCH_USER` (overriding `catch`). Note that `JSON_THROW_USER` should leave the current scope (e.g., by throwing or aborting), as continuing after it may yield undefined behavior. Note the explanatory [`what()`](https://en.cppreference.com/w/cpp/error/exception/what) string of exceptions is not available for MSVC if exceptions are disabled, see [#2824](https://github.com/nlohmann/json/discussions/2824).
|
- **Exceptions** are used widely within the library. They can, however, be switched off with either using the compiler flag `-fno-exceptions` or by defining the symbol `JSON_NOEXCEPTION`. In this case, exceptions are replaced by `abort()` calls. You can further control this behavior by defining `JSON_THROW_USER` (overriding `throw`), `JSON_TRY_USER` (overriding `try`), and `JSON_CATCH_USER` (overriding `catch`). Note that `JSON_THROW_USER` should leave the current scope (e.g., by throwing or aborting), as continuing after it may yield undefined behavior. Note the explanatory [`what()`](https://en.cppreference.com/w/cpp/error/exception/what) string of exceptions is not available for MSVC if exceptions are disabled, see [#2824](https://github.com/nlohmann/json/discussions/2824). See the [**documentation of exceptions**](https://json.nlohmann.me/home/exceptions/) for more information.
|
||||||
|
|
||||||
## Execute unit tests
|
## Execute unit tests
|
||||||
|
|
||||||
To compile and run the tests, you need to execute
|
To compile and run the tests, you need to execute
|
||||||
|
|
||||||
```sh
|
```shell
|
||||||
$ mkdir build
|
mkdir build
|
||||||
$ cd build
|
cd build
|
||||||
$ cmake .. -DJSON_BuildTests=On
|
cmake .. -DJSON_BuildTests=On
|
||||||
$ cmake --build .
|
cmake --build .
|
||||||
$ ctest --output-on-failure
|
ctest --output-on-failure
|
||||||
```
|
```
|
||||||
|
|
||||||
Note that during the `ctest` stage, several JSON test files are downloaded from an [external repository](https://github.com/nlohmann/json_test_data). If policies forbid downloading artifacts during testing, you can download the files yourself and pass the directory with the test files via `-DJSON_TestDataDirectory=path` to CMake. Then, no Internet connectivity is required. See [issue #2189](https://github.com/nlohmann/json/issues/2189) for more information.
|
Note that during the `ctest` stage, several JSON test files are downloaded from an [external repository](https://github.com/nlohmann/json_test_data). If policies forbid downloading artifacts during testing, you can download the files yourself and pass the directory with the test files via `-DJSON_TestDataDirectory=path` to CMake. Then, no Internet connectivity is required. See [issue #2189](https://github.com/nlohmann/json/issues/2189) for more information.
|
||||||
@ -1902,4 +1825,4 @@ Some tests change the installed files and hence make the whole process not repro
|
|||||||
|
|
||||||
Note you need to call `cmake -LE "not_reproducible|git_required"` to exclude both labels. See [issue #2596](https://github.com/nlohmann/json/issues/2596) for more information.
|
Note you need to call `cmake -LE "not_reproducible|git_required"` to exclude both labels. See [issue #2596](https://github.com/nlohmann/json/issues/2596) for more information.
|
||||||
|
|
||||||
As Intel compilers use unsafe floating point optimization by default, the unit tests may fail. Use flag [`/fp:precise`](https://software.intel.com/content/www/us/en/develop/documentation/cpp-compiler-developer-guide-and-reference/top/compiler-reference/compiler-options/compiler-option-details/floating-point-options/fp-model-fp.html) then.
|
As Intel compilers use unsafe floating point optimization by default, the unit tests may fail. Use flag [`/fp:precise`](https://www.intel.com/content/www/us/en/docs/cpp-compiler/developer-guide-reference/2021-8/fp-model-fp.html) then.
|
||||||
|
|||||||
@ -1 +0,0 @@
|
|||||||
workspace(name = "nlohmann_json")
|
|
||||||
410
cmake/ci.cmake
410
cmake/ci.cmake
@ -8,34 +8,24 @@ set(N 10)
|
|||||||
include(FindPython3)
|
include(FindPython3)
|
||||||
find_package(Python3 COMPONENTS Interpreter)
|
find_package(Python3 COMPONENTS Interpreter)
|
||||||
|
|
||||||
find_program(ASTYLE_TOOL NAMES astyle)
|
|
||||||
execute_process(COMMAND ${ASTYLE_TOOL} --version OUTPUT_VARIABLE ASTYLE_TOOL_VERSION ERROR_VARIABLE ASTYLE_TOOL_VERSION)
|
|
||||||
string(REGEX MATCH "[0-9]+(\\.[0-9]+)+" ASTYLE_TOOL_VERSION "${ASTYLE_TOOL_VERSION}")
|
|
||||||
message(STATUS "🔖 Artistic Style ${ASTYLE_TOOL_VERSION} (${ASTYLE_TOOL})")
|
|
||||||
|
|
||||||
find_program(CLANG_TOOL NAMES clang++-HEAD clang++ clang++-20 clang++-19 clang++-18 clang++-17 clang++-16 clang++-15 clang++-14 clang++-13 clang++-12 clang++-11 clang++)
|
find_program(CLANG_TOOL NAMES clang++-HEAD clang++ clang++-20 clang++-19 clang++-18 clang++-17 clang++-16 clang++-15 clang++-14 clang++-13 clang++-12 clang++-11 clang++)
|
||||||
execute_process(COMMAND ${CLANG_TOOL} --version OUTPUT_VARIABLE CLANG_TOOL_VERSION ERROR_VARIABLE CLANG_TOOL_VERSION)
|
execute_process(COMMAND ${CLANG_TOOL} --version OUTPUT_VARIABLE CLANG_TOOL_VERSION ERROR_VARIABLE CLANG_TOOL_VERSION)
|
||||||
string(REGEX MATCH "[0-9]+(\\.[0-9]+)+" CLANG_TOOL_VERSION "${CLANG_TOOL_VERSION}")
|
string(REGEX MATCH "[0-9]+(\\.[0-9]+)+" CLANG_TOOL_VERSION "${CLANG_TOOL_VERSION}")
|
||||||
message(STATUS "🔖 Clang ${CLANG_TOOL_VERSION} (${CLANG_TOOL})")
|
message(STATUS "🔖 Clang ${CLANG_TOOL_VERSION} (${CLANG_TOOL})")
|
||||||
|
|
||||||
find_program(CLANG_TIDY_TOOL NAMES clang-tidy-17 clang-tidy-16 clang-tidy-15 clang-tidy-14 clang-tidy-13 clang-tidy-12 clang-tidy-11 clang-tidy)
|
find_program(CLANG_TIDY_TOOL NAMES clang-tidy-20 clang-tidy-19 clang-tidy-18 clang-tidy-17 clang-tidy-16 clang-tidy-15 clang-tidy-14 clang-tidy-13 clang-tidy-12 clang-tidy-11 clang-tidy)
|
||||||
execute_process(COMMAND ${CLANG_TIDY_TOOL} --version OUTPUT_VARIABLE CLANG_TIDY_TOOL_VERSION ERROR_VARIABLE CLANG_TIDY_TOOL_VERSION)
|
execute_process(COMMAND ${CLANG_TIDY_TOOL} --version OUTPUT_VARIABLE CLANG_TIDY_TOOL_VERSION ERROR_VARIABLE CLANG_TIDY_TOOL_VERSION)
|
||||||
string(REGEX MATCH "[0-9]+(\\.[0-9]+)+" CLANG_TIDY_TOOL_VERSION "${CLANG_TIDY_TOOL_VERSION}")
|
string(REGEX MATCH "[0-9]+(\\.[0-9]+)+" CLANG_TIDY_TOOL_VERSION "${CLANG_TIDY_TOOL_VERSION}")
|
||||||
message(STATUS "🔖 Clang-Tidy ${CLANG_TIDY_TOOL_VERSION} (${CLANG_TIDY_TOOL})")
|
message(STATUS "🔖 Clang-Tidy ${CLANG_TIDY_TOOL_VERSION} (${CLANG_TIDY_TOOL})")
|
||||||
|
|
||||||
message(STATUS "🔖 CMake ${CMAKE_VERSION} (${CMAKE_COMMAND})")
|
message(STATUS "🔖 CMake ${CMAKE_VERSION} (${CMAKE_COMMAND})")
|
||||||
|
|
||||||
find_program(CPPCHECK_TOOL NAMES cppcheck)
|
find_program(GCC_TOOL NAMES g++-latest g++-HEAD g++ g++-15 g++-14 g++-13 g++-12 g++-11 g++-10)
|
||||||
execute_process(COMMAND ${CPPCHECK_TOOL} --version OUTPUT_VARIABLE CPPCHECK_TOOL_VERSION ERROR_VARIABLE CPPCHECK_TOOL_VERSION)
|
|
||||||
string(REGEX MATCH "[0-9]+(\\.[0-9]+)+" CPPCHECK_TOOL_VERSION "${CPPCHECK_TOOL_VERSION}")
|
|
||||||
message(STATUS "🔖 Cppcheck ${CPPCHECK_TOOL_VERSION} (${CPPCHECK_TOOL})")
|
|
||||||
|
|
||||||
find_program(GCC_TOOL NAMES g++-latest g++-HEAD g++-13 g++-12 g++-11 g++-10)
|
|
||||||
execute_process(COMMAND ${GCC_TOOL} --version OUTPUT_VARIABLE GCC_TOOL_VERSION ERROR_VARIABLE GCC_TOOL_VERSION)
|
execute_process(COMMAND ${GCC_TOOL} --version OUTPUT_VARIABLE GCC_TOOL_VERSION ERROR_VARIABLE GCC_TOOL_VERSION)
|
||||||
string(REGEX MATCH "[0-9]+(\\.[0-9]+)+" GCC_TOOL_VERSION "${GCC_TOOL_VERSION}")
|
string(REGEX MATCH "[0-9]+(\\.[0-9]+)+" GCC_TOOL_VERSION "${GCC_TOOL_VERSION}")
|
||||||
message(STATUS "🔖 GCC ${GCC_TOOL_VERSION} (${GCC_TOOL})")
|
message(STATUS "🔖 GCC ${GCC_TOOL_VERSION} (${GCC_TOOL})")
|
||||||
|
|
||||||
find_program(GCOV_TOOL NAMES gcov-HEAD gcov-11 gcov-10 gcov)
|
find_program(GCOV_TOOL NAMES gcov-HEAD gcov gcov-15 gcov-14 gcov-13 gcov-12 gcov-11 gcov-10)
|
||||||
execute_process(COMMAND ${GCOV_TOOL} --version OUTPUT_VARIABLE GCOV_TOOL_VERSION ERROR_VARIABLE GCOV_TOOL_VERSION)
|
execute_process(COMMAND ${GCOV_TOOL} --version OUTPUT_VARIABLE GCOV_TOOL_VERSION ERROR_VARIABLE GCOV_TOOL_VERSION)
|
||||||
string(REGEX MATCH "[0-9]+(\\.[0-9]+)+" GCOV_TOOL_VERSION "${GCOV_TOOL_VERSION}")
|
string(REGEX MATCH "[0-9]+(\\.[0-9]+)+" GCOV_TOOL_VERSION "${GCOV_TOOL_VERSION}")
|
||||||
message(STATUS "🔖 GCOV ${GCOV_TOOL_VERSION} (${GCOV_TOOL})")
|
message(STATUS "🔖 GCOV ${GCOV_TOOL_VERSION} (${GCOV_TOOL})")
|
||||||
@ -88,332 +78,8 @@ file(GLOB_RECURSE SRC_FILES ${PROJECT_SOURCE_DIR}/include/nlohmann/*.hpp)
|
|||||||
# Thorough check with recent compilers
|
# Thorough check with recent compilers
|
||||||
###############################################################################
|
###############################################################################
|
||||||
|
|
||||||
# Ignored Clang warnings:
|
include(clang_flags)
|
||||||
# -Wno-c++98-compat The library targets C++11.
|
include(gcc_flags)
|
||||||
# -Wno-c++98-compat-pedantic The library targets C++11.
|
|
||||||
# -Wno-deprecated-declarations The library contains annotations for deprecated functions.
|
|
||||||
# -Wno-extra-semi-stmt The library uses std::assert which triggers this warning.
|
|
||||||
# -Wno-padded We do not care about padding warnings.
|
|
||||||
# -Wno-covered-switch-default All switches list all cases and a default case.
|
|
||||||
# -Wno-unsafe-buffer-usage Otherwise Doctest would not compile.
|
|
||||||
# -Wno-weak-vtables The library is header-only.
|
|
||||||
# -Wreserved-identifier See https://github.com/onqtam/doctest/issues/536.
|
|
||||||
|
|
||||||
set(CLANG_CXXFLAGS
|
|
||||||
-Werror
|
|
||||||
-Weverything
|
|
||||||
-Wno-c++98-compat
|
|
||||||
-Wno-c++98-compat-pedantic
|
|
||||||
-Wno-deprecated-declarations
|
|
||||||
-Wno-extra-semi-stmt
|
|
||||||
-Wno-padded
|
|
||||||
-Wno-covered-switch-default
|
|
||||||
-Wno-unsafe-buffer-usage
|
|
||||||
-Wno-weak-vtables
|
|
||||||
-Wno-reserved-identifier
|
|
||||||
)
|
|
||||||
|
|
||||||
# Warning flags determined for GCC 13.0 (experimental) with https://github.com/nlohmann/gcc_flags:
|
|
||||||
# Ignored GCC warnings:
|
|
||||||
# -Wno-abi-tag We do not care about ABI tags.
|
|
||||||
# -Wno-aggregate-return The library uses aggregate returns.
|
|
||||||
# -Wno-long-long The library uses the long long type to interface with system functions.
|
|
||||||
# -Wno-namespaces The library uses namespaces.
|
|
||||||
# -Wno-padded We do not care about padding warnings.
|
|
||||||
# -Wno-system-headers We do not care about warnings in system headers.
|
|
||||||
# -Wno-templates The library uses templates.
|
|
||||||
|
|
||||||
set(GCC_CXXFLAGS
|
|
||||||
-pedantic
|
|
||||||
-Werror
|
|
||||||
--all-warnings
|
|
||||||
--extra-warnings
|
|
||||||
-W
|
|
||||||
-WNSObject-attribute
|
|
||||||
-Wno-abi-tag
|
|
||||||
-Waddress
|
|
||||||
-Waddress-of-packed-member
|
|
||||||
-Wno-aggregate-return
|
|
||||||
-Waggressive-loop-optimizations
|
|
||||||
-Waligned-new=all
|
|
||||||
-Wall
|
|
||||||
-Walloc-zero
|
|
||||||
-Walloca
|
|
||||||
-Wanalyzer-double-fclose
|
|
||||||
-Wanalyzer-double-free
|
|
||||||
-Wanalyzer-exposure-through-output-file
|
|
||||||
-Wanalyzer-file-leak
|
|
||||||
-Wanalyzer-free-of-non-heap
|
|
||||||
-Wanalyzer-malloc-leak
|
|
||||||
-Wanalyzer-mismatching-deallocation
|
|
||||||
-Wanalyzer-null-argument
|
|
||||||
-Wanalyzer-null-dereference
|
|
||||||
-Wanalyzer-possible-null-argument
|
|
||||||
-Wanalyzer-possible-null-dereference
|
|
||||||
-Wanalyzer-shift-count-negative
|
|
||||||
-Wanalyzer-shift-count-overflow
|
|
||||||
-Wanalyzer-stale-setjmp-buffer
|
|
||||||
-Wanalyzer-tainted-allocation-size
|
|
||||||
-Wanalyzer-tainted-array-index
|
|
||||||
-Wanalyzer-tainted-divisor
|
|
||||||
-Wanalyzer-tainted-offset
|
|
||||||
-Wanalyzer-tainted-size
|
|
||||||
-Wanalyzer-too-complex
|
|
||||||
-Wanalyzer-unsafe-call-within-signal-handler
|
|
||||||
-Wanalyzer-use-after-free
|
|
||||||
-Wanalyzer-use-of-pointer-in-stale-stack-frame
|
|
||||||
-Wanalyzer-use-of-uninitialized-value
|
|
||||||
-Wanalyzer-va-arg-type-mismatch
|
|
||||||
-Wanalyzer-va-list-exhausted
|
|
||||||
-Wanalyzer-va-list-leak
|
|
||||||
-Wanalyzer-va-list-use-after-va-end
|
|
||||||
-Wanalyzer-write-to-const
|
|
||||||
-Wanalyzer-write-to-string-literal
|
|
||||||
-Warith-conversion
|
|
||||||
-Warray-bounds=2
|
|
||||||
-Warray-compare
|
|
||||||
-Warray-parameter=2
|
|
||||||
-Wattribute-alias=2
|
|
||||||
-Wattribute-warning
|
|
||||||
-Wattributes
|
|
||||||
-Wbool-compare
|
|
||||||
-Wbool-operation
|
|
||||||
-Wbuiltin-declaration-mismatch
|
|
||||||
-Wbuiltin-macro-redefined
|
|
||||||
-Wc++0x-compat
|
|
||||||
-Wc++11-compat
|
|
||||||
-Wc++11-extensions
|
|
||||||
-Wc++14-compat
|
|
||||||
-Wc++14-extensions
|
|
||||||
-Wc++17-compat
|
|
||||||
-Wc++17-extensions
|
|
||||||
-Wc++1z-compat
|
|
||||||
-Wc++20-compat
|
|
||||||
-Wc++20-extensions
|
|
||||||
-Wc++23-extensions
|
|
||||||
-Wc++2a-compat
|
|
||||||
-Wcannot-profile
|
|
||||||
-Wcast-align
|
|
||||||
-Wcast-align=strict
|
|
||||||
-Wcast-function-type
|
|
||||||
-Wcast-qual
|
|
||||||
-Wcatch-value=3
|
|
||||||
-Wchar-subscripts
|
|
||||||
-Wclass-conversion
|
|
||||||
-Wclass-memaccess
|
|
||||||
-Wclobbered
|
|
||||||
-Wcomma-subscript
|
|
||||||
-Wcomment
|
|
||||||
-Wcomments
|
|
||||||
-Wconditionally-supported
|
|
||||||
-Wconversion
|
|
||||||
-Wconversion-null
|
|
||||||
-Wcoverage-invalid-line-number
|
|
||||||
-Wcoverage-mismatch
|
|
||||||
-Wcpp
|
|
||||||
-Wctad-maybe-unsupported
|
|
||||||
-Wctor-dtor-privacy
|
|
||||||
-Wdangling-else
|
|
||||||
-Wdangling-pointer=2
|
|
||||||
-Wdate-time
|
|
||||||
-Wdelete-incomplete
|
|
||||||
-Wdelete-non-virtual-dtor
|
|
||||||
-Wdeprecated
|
|
||||||
-Wdeprecated-copy
|
|
||||||
-Wdeprecated-copy-dtor
|
|
||||||
-Wdeprecated-declarations
|
|
||||||
-Wdeprecated-enum-enum-conversion
|
|
||||||
-Wdeprecated-enum-float-conversion
|
|
||||||
-Wdisabled-optimization
|
|
||||||
-Wdiv-by-zero
|
|
||||||
-Wdouble-promotion
|
|
||||||
-Wduplicated-branches
|
|
||||||
-Wduplicated-cond
|
|
||||||
-Weffc++
|
|
||||||
-Wempty-body
|
|
||||||
-Wendif-labels
|
|
||||||
-Wenum-compare
|
|
||||||
-Wenum-conversion
|
|
||||||
-Wexceptions
|
|
||||||
-Wexpansion-to-defined
|
|
||||||
-Wextra
|
|
||||||
-Wextra-semi
|
|
||||||
-Wfloat-conversion
|
|
||||||
-Wfloat-equal
|
|
||||||
-Wformat-diag
|
|
||||||
-Wformat-overflow=2
|
|
||||||
-Wformat-signedness
|
|
||||||
-Wformat-truncation=2
|
|
||||||
-Wformat=2
|
|
||||||
-Wframe-address
|
|
||||||
-Wfree-nonheap-object
|
|
||||||
-Whsa
|
|
||||||
-Wif-not-aligned
|
|
||||||
-Wignored-attributes
|
|
||||||
-Wignored-qualifiers
|
|
||||||
-Wimplicit-fallthrough=5
|
|
||||||
-Winaccessible-base
|
|
||||||
-Winfinite-recursion
|
|
||||||
-Winherited-variadic-ctor
|
|
||||||
-Winit-list-lifetime
|
|
||||||
-Winit-self
|
|
||||||
-Winline
|
|
||||||
-Wint-in-bool-context
|
|
||||||
-Wint-to-pointer-cast
|
|
||||||
-Winterference-size
|
|
||||||
-Winvalid-imported-macros
|
|
||||||
-Winvalid-memory-model
|
|
||||||
-Winvalid-offsetof
|
|
||||||
-Winvalid-pch
|
|
||||||
-Wliteral-suffix
|
|
||||||
-Wlogical-not-parentheses
|
|
||||||
-Wlogical-op
|
|
||||||
-Wno-long-long
|
|
||||||
-Wlto-type-mismatch
|
|
||||||
-Wmain
|
|
||||||
-Wmaybe-uninitialized
|
|
||||||
-Wmemset-elt-size
|
|
||||||
-Wmemset-transposed-args
|
|
||||||
-Wmisleading-indentation
|
|
||||||
-Wmismatched-dealloc
|
|
||||||
-Wmismatched-new-delete
|
|
||||||
-Wmismatched-tags
|
|
||||||
-Wmissing-attributes
|
|
||||||
-Wmissing-braces
|
|
||||||
-Wmissing-declarations
|
|
||||||
-Wmissing-field-initializers
|
|
||||||
-Wmissing-include-dirs
|
|
||||||
-Wmissing-profile
|
|
||||||
-Wmissing-requires
|
|
||||||
-Wmissing-template-keyword
|
|
||||||
-Wmultichar
|
|
||||||
-Wmultiple-inheritance
|
|
||||||
-Wmultistatement-macros
|
|
||||||
-Wno-namespaces
|
|
||||||
-Wnarrowing
|
|
||||||
-Wnoexcept
|
|
||||||
-Wnoexcept-type
|
|
||||||
-Wnon-template-friend
|
|
||||||
-Wnon-virtual-dtor
|
|
||||||
-Wnonnull
|
|
||||||
-Wnonnull-compare
|
|
||||||
-Wnormalized=nfkc
|
|
||||||
-Wnull-dereference
|
|
||||||
-Wodr
|
|
||||||
-Wold-style-cast
|
|
||||||
-Wopenacc-parallelism
|
|
||||||
-Wopenmp-simd
|
|
||||||
-Woverflow
|
|
||||||
-Woverlength-strings
|
|
||||||
-Woverloaded-virtual
|
|
||||||
-Wpacked
|
|
||||||
-Wpacked-bitfield-compat
|
|
||||||
-Wpacked-not-aligned
|
|
||||||
-Wno-padded
|
|
||||||
-Wparentheses
|
|
||||||
-Wpedantic
|
|
||||||
-Wpessimizing-move
|
|
||||||
-Wplacement-new=2
|
|
||||||
-Wpmf-conversions
|
|
||||||
-Wpointer-arith
|
|
||||||
-Wpointer-compare
|
|
||||||
-Wpragmas
|
|
||||||
-Wprio-ctor-dtor
|
|
||||||
-Wpsabi
|
|
||||||
-Wrange-loop-construct
|
|
||||||
-Wredundant-decls
|
|
||||||
-Wredundant-move
|
|
||||||
-Wredundant-tags
|
|
||||||
-Wregister
|
|
||||||
-Wreorder
|
|
||||||
-Wrestrict
|
|
||||||
-Wreturn-local-addr
|
|
||||||
-Wreturn-type
|
|
||||||
-Wscalar-storage-order
|
|
||||||
-Wsequence-point
|
|
||||||
-Wshadow=compatible-local
|
|
||||||
-Wshadow=global
|
|
||||||
-Wshadow=local
|
|
||||||
-Wshift-count-negative
|
|
||||||
-Wshift-count-overflow
|
|
||||||
-Wshift-negative-value
|
|
||||||
-Wshift-overflow=2
|
|
||||||
-Wsign-compare
|
|
||||||
-Wsign-conversion
|
|
||||||
-Wsign-promo
|
|
||||||
-Wsized-deallocation
|
|
||||||
-Wsizeof-array-argument
|
|
||||||
-Wsizeof-array-div
|
|
||||||
-Wsizeof-pointer-div
|
|
||||||
-Wsizeof-pointer-memaccess
|
|
||||||
-Wstack-protector
|
|
||||||
-Wstrict-aliasing=3
|
|
||||||
-Wstrict-null-sentinel
|
|
||||||
-Wno-strict-overflow
|
|
||||||
-Wstring-compare
|
|
||||||
-Wstringop-overflow=4
|
|
||||||
-Wstringop-overread
|
|
||||||
-Wstringop-truncation
|
|
||||||
-Wsubobject-linkage
|
|
||||||
-Wsuggest-attribute=cold
|
|
||||||
-Wsuggest-attribute=const
|
|
||||||
-Wsuggest-attribute=format
|
|
||||||
-Wsuggest-attribute=malloc
|
|
||||||
-Wsuggest-attribute=noreturn
|
|
||||||
-Wsuggest-attribute=pure
|
|
||||||
-Wsuggest-final-methods
|
|
||||||
-Wsuggest-final-types
|
|
||||||
-Wsuggest-override
|
|
||||||
-Wswitch
|
|
||||||
-Wswitch-bool
|
|
||||||
-Wswitch-default
|
|
||||||
-Wswitch-enum
|
|
||||||
-Wswitch-outside-range
|
|
||||||
-Wswitch-unreachable
|
|
||||||
-Wsync-nand
|
|
||||||
-Wsynth
|
|
||||||
-Wno-system-headers
|
|
||||||
-Wtautological-compare
|
|
||||||
-Wno-templates
|
|
||||||
-Wterminate
|
|
||||||
-Wtrampolines
|
|
||||||
-Wtrigraphs
|
|
||||||
-Wtrivial-auto-var-init
|
|
||||||
-Wtsan
|
|
||||||
-Wtype-limits
|
|
||||||
-Wundef
|
|
||||||
-Wuninitialized
|
|
||||||
-Wunknown-pragmas
|
|
||||||
-Wunreachable-code
|
|
||||||
-Wunsafe-loop-optimizations
|
|
||||||
-Wunused
|
|
||||||
-Wunused-but-set-parameter
|
|
||||||
-Wunused-but-set-variable
|
|
||||||
-Wunused-const-variable=2
|
|
||||||
-Wunused-function
|
|
||||||
-Wunused-label
|
|
||||||
-Wunused-local-typedefs
|
|
||||||
-Wunused-macros
|
|
||||||
-Wunused-parameter
|
|
||||||
-Wunused-result
|
|
||||||
-Wunused-value
|
|
||||||
-Wunused-variable
|
|
||||||
-Wuse-after-free=3
|
|
||||||
-Wuseless-cast
|
|
||||||
-Wvarargs
|
|
||||||
-Wvariadic-macros
|
|
||||||
-Wvector-operation-performance
|
|
||||||
-Wvexing-parse
|
|
||||||
-Wvirtual-inheritance
|
|
||||||
-Wvirtual-move-assign
|
|
||||||
-Wvla
|
|
||||||
-Wvla-parameter
|
|
||||||
-Wvolatile
|
|
||||||
-Wvolatile-register-var
|
|
||||||
-Wwrite-strings
|
|
||||||
-Wzero-as-null-pointer-constant
|
|
||||||
-Wzero-length-bounds
|
|
||||||
)
|
|
||||||
|
|
||||||
add_custom_target(ci_test_gcc
|
add_custom_target(ci_test_gcc
|
||||||
COMMAND CXX=${GCC_TOOL} CXXFLAGS="${GCC_CXXFLAGS}" ${CMAKE_COMMAND}
|
COMMAND CXX=${GCC_TOOL} CXXFLAGS="${GCC_CXXFLAGS}" ${CMAKE_COMMAND}
|
||||||
@ -439,7 +105,7 @@ add_custom_target(ci_test_clang
|
|||||||
# Different C++ Standards.
|
# Different C++ Standards.
|
||||||
###############################################################################
|
###############################################################################
|
||||||
|
|
||||||
foreach(CXX_STANDARD 11 14 17 20 23)
|
foreach(CXX_STANDARD 11 14 17 20 23 26)
|
||||||
add_custom_target(ci_test_gcc_cxx${CXX_STANDARD}
|
add_custom_target(ci_test_gcc_cxx${CXX_STANDARD}
|
||||||
COMMAND CXX=${GCC_TOOL} CXXFLAGS="${GCC_CXXFLAGS}" ${CMAKE_COMMAND}
|
COMMAND CXX=${GCC_TOOL} CXXFLAGS="${GCC_CXXFLAGS}" ${CMAKE_COMMAND}
|
||||||
-DCMAKE_BUILD_TYPE=Debug -GNinja
|
-DCMAKE_BUILD_TYPE=Debug -GNinja
|
||||||
@ -518,6 +184,20 @@ add_custom_target(ci_test_diagnostics
|
|||||||
COMMENT "Compile and test with improved diagnostics enabled"
|
COMMENT "Compile and test with improved diagnostics enabled"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
###############################################################################
|
||||||
|
# Enable diagnostic positions support.
|
||||||
|
###############################################################################
|
||||||
|
|
||||||
|
add_custom_target(ci_test_diagnostic_positions
|
||||||
|
COMMAND ${CMAKE_COMMAND}
|
||||||
|
-DCMAKE_BUILD_TYPE=Debug -GNinja
|
||||||
|
-DJSON_BuildTests=ON -DJSON_Diagnostic_Positions=ON
|
||||||
|
-S${PROJECT_SOURCE_DIR} -B${PROJECT_BINARY_DIR}/build_diagnostic_positions
|
||||||
|
COMMAND ${CMAKE_COMMAND} --build ${PROJECT_BINARY_DIR}/build_diagnostic_positions
|
||||||
|
COMMAND cd ${PROJECT_BINARY_DIR}/build_diagnostic_positions && ${CMAKE_CTEST_COMMAND} --parallel ${N} --output-on-failure
|
||||||
|
COMMENT "Compile and test with diagnostic positions enabled"
|
||||||
|
)
|
||||||
|
|
||||||
###############################################################################
|
###############################################################################
|
||||||
# Enable legacy discarded value comparison.
|
# Enable legacy discarded value comparison.
|
||||||
###############################################################################
|
###############################################################################
|
||||||
@ -566,8 +246,8 @@ add_custom_target(ci_test_coverage
|
|||||||
COMMAND ${CMAKE_COMMAND} --build ${PROJECT_BINARY_DIR}/build_coverage32
|
COMMAND ${CMAKE_COMMAND} --build ${PROJECT_BINARY_DIR}/build_coverage32
|
||||||
COMMAND cd ${PROJECT_BINARY_DIR}/build_coverage32 && ${CMAKE_CTEST_COMMAND} --parallel ${N} --output-on-failure
|
COMMAND cd ${PROJECT_BINARY_DIR}/build_coverage32 && ${CMAKE_CTEST_COMMAND} --parallel ${N} --output-on-failure
|
||||||
|
|
||||||
COMMAND ${LCOV_TOOL} --directory . --capture --output-file json.info --rc lcov_branch_coverage=1
|
COMMAND ${LCOV_TOOL} --directory . --capture --output-file json.info --rc branch_coverage=1 --rc geninfo_unexecuted_blocks=1 --ignore-errors mismatch --ignore-errors unused
|
||||||
COMMAND ${LCOV_TOOL} -e json.info ${SRC_FILES} --output-file json.info.filtered --rc lcov_branch_coverage=1
|
COMMAND ${LCOV_TOOL} -e json.info ${SRC_FILES} --output-file json.info.filtered --rc branch_coverage=1 --ignore-errors unused
|
||||||
COMMAND ${CMAKE_SOURCE_DIR}/tests/thirdparty/imapdl/filterbr.py json.info.filtered > json.info.filtered.noexcept
|
COMMAND ${CMAKE_SOURCE_DIR}/tests/thirdparty/imapdl/filterbr.py json.info.filtered > json.info.filtered.noexcept
|
||||||
COMMAND genhtml --title "JSON for Modern C++" --legend --demangle-cpp --output-directory html --show-details --branch-coverage json.info.filtered.noexcept
|
COMMAND genhtml --title "JSON for Modern C++" --legend --demangle-cpp --output-directory html --show-details --branch-coverage json.info.filtered.noexcept
|
||||||
|
|
||||||
@ -594,8 +274,6 @@ add_custom_target(ci_test_clang_sanitizer
|
|||||||
# Check if header is amalgamated and sources are properly indented.
|
# Check if header is amalgamated and sources are properly indented.
|
||||||
###############################################################################
|
###############################################################################
|
||||||
|
|
||||||
set(ASTYLE_FLAGS --style=allman --indent=spaces=4 --indent-modifiers --indent-switches --indent-preproc-block --indent-preproc-define --indent-col1-comments --pad-oper --pad-header --align-pointer=type --align-reference=type --add-brackets --convert-tabs --close-templates --lineend=linux --preserve-date --formatted)
|
|
||||||
|
|
||||||
file(GLOB_RECURSE INDENT_FILES
|
file(GLOB_RECURSE INDENT_FILES
|
||||||
${PROJECT_SOURCE_DIR}/include/nlohmann/*.hpp
|
${PROJECT_SOURCE_DIR}/include/nlohmann/*.hpp
|
||||||
${PROJECT_SOURCE_DIR}/tests/src/*.cpp
|
${PROJECT_SOURCE_DIR}/tests/src/*.cpp
|
||||||
@ -611,14 +289,18 @@ add_custom_target(ci_test_amalgamation
|
|||||||
COMMAND cp ${include_dir}/json.hpp ${include_dir}/json.hpp~
|
COMMAND cp ${include_dir}/json.hpp ${include_dir}/json.hpp~
|
||||||
COMMAND cp ${include_dir}/json_fwd.hpp ${include_dir}/json_fwd.hpp~
|
COMMAND cp ${include_dir}/json_fwd.hpp ${include_dir}/json_fwd.hpp~
|
||||||
|
|
||||||
|
COMMAND ${Python3_EXECUTABLE} -mvenv venv_astyle
|
||||||
|
COMMAND venv_astyle/bin/pip3 --quiet install -r ${CMAKE_SOURCE_DIR}/tools/astyle/requirements.txt
|
||||||
|
COMMAND venv_astyle/bin/astyle --version
|
||||||
|
|
||||||
COMMAND ${Python3_EXECUTABLE} ${tool_dir}/amalgamate.py -c ${tool_dir}/config_json.json -s .
|
COMMAND ${Python3_EXECUTABLE} ${tool_dir}/amalgamate.py -c ${tool_dir}/config_json.json -s .
|
||||||
COMMAND ${Python3_EXECUTABLE} ${tool_dir}/amalgamate.py -c ${tool_dir}/config_json_fwd.json -s .
|
COMMAND ${Python3_EXECUTABLE} ${tool_dir}/amalgamate.py -c ${tool_dir}/config_json_fwd.json -s .
|
||||||
COMMAND ${ASTYLE_TOOL} ${ASTYLE_FLAGS} --suffix=none --quiet ${include_dir}/json.hpp ${include_dir}/json_fwd.hpp
|
COMMAND venv_astyle/bin/astyle --project=tools/astyle/.astylerc --suffix=none ${include_dir}/json.hpp ${include_dir}/json_fwd.hpp
|
||||||
|
|
||||||
COMMAND diff ${include_dir}/json.hpp~ ${include_dir}/json.hpp
|
COMMAND diff ${include_dir}/json.hpp~ ${include_dir}/json.hpp
|
||||||
COMMAND diff ${include_dir}/json_fwd.hpp~ ${include_dir}/json_fwd.hpp
|
COMMAND diff ${include_dir}/json_fwd.hpp~ ${include_dir}/json_fwd.hpp
|
||||||
|
|
||||||
COMMAND ${ASTYLE_TOOL} ${ASTYLE_FLAGS} ${INDENT_FILES}
|
COMMAND venv_astyle/bin/astyle --project=tools/astyle/.astylerc --suffix=orig ${INDENT_FILES}
|
||||||
COMMAND for FILE in `find . -name '*.orig'`\; do false \; done
|
COMMAND for FILE in `find . -name '*.orig'`\; do false \; done
|
||||||
|
|
||||||
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
|
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
|
||||||
@ -630,7 +312,7 @@ add_custom_target(ci_test_amalgamation
|
|||||||
###############################################################################
|
###############################################################################
|
||||||
|
|
||||||
add_custom_target(ci_test_single_header
|
add_custom_target(ci_test_single_header
|
||||||
COMMAND CXX=${GCC_TOOL} CXXFLAGS="${GCC_CXXFLAGS}" ${CMAKE_COMMAND}
|
COMMAND ${CMAKE_COMMAND}
|
||||||
-DCMAKE_BUILD_TYPE=Debug -GNinja
|
-DCMAKE_BUILD_TYPE=Debug -GNinja
|
||||||
-DJSON_BuildTests=ON -DJSON_MultipleHeaders=OFF -DJSON_FastTests=ON
|
-DJSON_BuildTests=ON -DJSON_MultipleHeaders=OFF -DJSON_FastTests=ON
|
||||||
-S${PROJECT_SOURCE_DIR} -B${PROJECT_BINARY_DIR}/build_single_header
|
-S${PROJECT_SOURCE_DIR} -B${PROJECT_BINARY_DIR}/build_single_header
|
||||||
@ -673,7 +355,16 @@ add_custom_target(ci_clang_analyze
|
|||||||
###############################################################################
|
###############################################################################
|
||||||
|
|
||||||
add_custom_target(ci_cppcheck
|
add_custom_target(ci_cppcheck
|
||||||
COMMAND ${CPPCHECK_TOOL} --enable=warning --suppress=missingReturn --inline-suppr --inconclusive --force --std=c++11 ${PROJECT_SOURCE_DIR}/single_include/nlohmann/json.hpp --error-exitcode=1
|
COMMAND mkdir -p cppcheck
|
||||||
|
COMMAND clang -dM -E -x c++ -std=c++11 ${CMAKE_SOURCE_DIR}/include/nlohmann/thirdparty/hedley/hedley.hpp > default_defines.hpp 2> /dev/null
|
||||||
|
COMMAND ${Python3_EXECUTABLE} -mvenv venv_cppcheck
|
||||||
|
COMMAND venv_cppcheck/bin/pip3 --quiet install -r ${CMAKE_SOURCE_DIR}/cmake/requirements/requirements-cppcheck.txt
|
||||||
|
COMMAND venv_cppcheck/bin/cppcheck --enable=warning --check-level=exhaustive --inline-suppr --inconclusive --force
|
||||||
|
--std=c++11 ${PROJECT_SOURCE_DIR}/include/nlohmann/json.hpp -I ${CMAKE_SOURCE_DIR}/include
|
||||||
|
--error-exitcode=1 --relative-paths=${PROJECT_SOURCE_DIR} -j ${N} --include=default_defines.hpp
|
||||||
|
--cppcheck-build-dir=cppcheck --check-level=exhaustive
|
||||||
|
-UJSON_CATCH_USER -UJSON_TRY_USER -UJSON_ASSERT -UJSON_INTERNAL_CATCH -UJSON_THROW
|
||||||
|
-DJSON_HAS_CPP_11 -UJSON_HAS_CPP_14 -UJSON_HAS_CPP_17 -UJSON_HAS_CPP_20 -UJSON_HAS_THREE_WAY_COMPARISON
|
||||||
COMMENT "Check code with Cppcheck"
|
COMMENT "Check code with Cppcheck"
|
||||||
)
|
)
|
||||||
|
|
||||||
@ -683,7 +374,7 @@ add_custom_target(ci_cppcheck
|
|||||||
|
|
||||||
add_custom_target(ci_cpplint
|
add_custom_target(ci_cpplint
|
||||||
COMMAND ${Python3_EXECUTABLE} -mvenv venv_cpplint
|
COMMAND ${Python3_EXECUTABLE} -mvenv venv_cpplint
|
||||||
COMMAND venv_cpplint/bin/pip3 --quiet install cpplint
|
COMMAND venv_cpplint/bin/pip3 --quiet install -r ${CMAKE_SOURCE_DIR}/cmake/requirements/requirements-cpplint.txt
|
||||||
COMMAND venv_cpplint/bin/cpplint --filter=-whitespace,-legal,-runtime/references,-runtime/explicit,-runtime/indentation_namespace,-readability/casting,-readability/nolint --quiet --recursive ${SRC_FILES}
|
COMMAND venv_cpplint/bin/cpplint --filter=-whitespace,-legal,-runtime/references,-runtime/explicit,-runtime/indentation_namespace,-readability/casting,-readability/nolint --quiet --recursive ${SRC_FILES}
|
||||||
COMMENT "Check code with cpplint"
|
COMMENT "Check code with cpplint"
|
||||||
WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
|
WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
|
||||||
@ -868,7 +559,7 @@ endfunction()
|
|||||||
ci_get_cmake(3.1.0 CMAKE_3_1_0_BINARY)
|
ci_get_cmake(3.1.0 CMAKE_3_1_0_BINARY)
|
||||||
ci_get_cmake(3.13.0 CMAKE_3_13_0_BINARY)
|
ci_get_cmake(3.13.0 CMAKE_3_13_0_BINARY)
|
||||||
|
|
||||||
set(JSON_CMAKE_FLAGS_3_1_0 JSON_Diagnostics JSON_GlobalUDLs JSON_ImplicitConversions JSON_DisableEnumSerialization
|
set(JSON_CMAKE_FLAGS_3_1_0 JSON_Diagnostics JSON_Diagnostic_Positions JSON_GlobalUDLs JSON_ImplicitConversions JSON_DisableEnumSerialization
|
||||||
JSON_LegacyDiscardedValueComparison JSON_Install JSON_MultipleHeaders JSON_SystemInclude JSON_Valgrind)
|
JSON_LegacyDiscardedValueComparison JSON_Install JSON_MultipleHeaders JSON_SystemInclude JSON_Valgrind)
|
||||||
set(JSON_CMAKE_FLAGS_3_13_0 JSON_BuildTests)
|
set(JSON_CMAKE_FLAGS_3_13_0 JSON_BuildTests)
|
||||||
|
|
||||||
@ -970,6 +661,17 @@ add_custom_target(ci_icpc
|
|||||||
COMMENT "Compile and test with ICPC"
|
COMMENT "Compile and test with ICPC"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
###############################################################################
|
||||||
|
# REUSE
|
||||||
|
###############################################################################
|
||||||
|
|
||||||
|
add_custom_target(ci_reuse_compliance
|
||||||
|
COMMAND ${Python3_EXECUTABLE} -mvenv venv_reuse
|
||||||
|
COMMAND venv_reuse/bin/pip3 --quiet install -r ${PROJECT_SOURCE_DIR}/cmake/requirements/requirements-reuse.txt
|
||||||
|
COMMAND venv_reuse/bin/reuse --root ${PROJECT_SOURCE_DIR} lint
|
||||||
|
COMMENT "Check REUSE specification compliance"
|
||||||
|
)
|
||||||
|
|
||||||
###############################################################################
|
###############################################################################
|
||||||
# test documentation
|
# test documentation
|
||||||
###############################################################################
|
###############################################################################
|
||||||
@ -980,10 +682,12 @@ add_custom_target(ci_test_examples
|
|||||||
COMMENT "Check that all examples compile and create the desired output"
|
COMMENT "Check that all examples compile and create the desired output"
|
||||||
)
|
)
|
||||||
|
|
||||||
add_custom_target(ci_test_api_documentation
|
add_custom_target(ci_test_build_documentation
|
||||||
COMMAND ${Python3_EXECUTABLE} scripts/check_structure.py
|
COMMAND ${Python3_EXECUTABLE} -mvenv venv
|
||||||
|
COMMAND venv/bin/pip3 --quiet install -r requirements.txt
|
||||||
|
COMMAND make build
|
||||||
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/docs/mkdocs
|
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/docs/mkdocs
|
||||||
COMMENT "Lint the API documentation"
|
COMMENT "Build the documentation"
|
||||||
)
|
)
|
||||||
|
|
||||||
###############################################################################
|
###############################################################################
|
||||||
|
|||||||
20
cmake/clang_flags.cmake
Normal file
20
cmake/clang_flags.cmake
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
# Ignored Clang warnings:
|
||||||
|
# -Wno-c++98-compat The library targets C++11.
|
||||||
|
# -Wno-c++98-compat-pedantic The library targets C++11.
|
||||||
|
# -Wno-deprecated-declarations The library contains annotations for deprecated functions.
|
||||||
|
# -Wno-extra-semi-stmt The library uses assert which triggers this warning.
|
||||||
|
# -Wno-padded We do not care about padding warnings.
|
||||||
|
# -Wno-covered-switch-default All switches list all cases and a default case.
|
||||||
|
# -Wno-unsafe-buffer-usage Otherwise Doctest would not compile.
|
||||||
|
|
||||||
|
set(CLANG_CXXFLAGS
|
||||||
|
-Werror
|
||||||
|
-Weverything
|
||||||
|
-Wno-c++98-compat
|
||||||
|
-Wno-c++98-compat-pedantic
|
||||||
|
-Wno-deprecated-declarations
|
||||||
|
-Wno-extra-semi-stmt
|
||||||
|
-Wno-padded
|
||||||
|
-Wno-covered-switch-default
|
||||||
|
-Wno-unsafe-buffer-usage
|
||||||
|
)
|
||||||
348
cmake/gcc_flags.cmake
Normal file
348
cmake/gcc_flags.cmake
Normal file
@ -0,0 +1,348 @@
|
|||||||
|
# Warning flags determined for GCC 14.2.0 with https://github.com/nlohmann/gcc_flags:
|
||||||
|
# Ignored GCC warnings:
|
||||||
|
# -Wno-abi-tag We do not care about ABI tags.
|
||||||
|
# -Wno-aggregate-return The library uses aggregate returns.
|
||||||
|
# -Wno-long-long The library uses the long long type to interface with system functions.
|
||||||
|
# -Wno-namespaces The library uses namespaces.
|
||||||
|
# -Wno-nrvo Doctest triggers this warning.
|
||||||
|
# -Wno-padded We do not care about padding warnings.
|
||||||
|
# -Wno-system-headers We do not care about warnings in system headers.
|
||||||
|
# -Wno-templates The library uses templates.
|
||||||
|
|
||||||
|
set(GCC_CXXFLAGS
|
||||||
|
-pedantic
|
||||||
|
-Werror
|
||||||
|
--all-warnings
|
||||||
|
--extra-warnings
|
||||||
|
-W
|
||||||
|
-WNSObject-attribute
|
||||||
|
-Wno-abi-tag
|
||||||
|
-Waddress
|
||||||
|
-Waddress-of-packed-member
|
||||||
|
-Wno-aggregate-return
|
||||||
|
-Waggressive-loop-optimizations
|
||||||
|
-Waligned-new=all
|
||||||
|
-Wall
|
||||||
|
-Walloc-size
|
||||||
|
-Walloc-zero
|
||||||
|
-Walloca
|
||||||
|
-Wanalyzer-allocation-size
|
||||||
|
-Wanalyzer-deref-before-check
|
||||||
|
-Wanalyzer-double-fclose
|
||||||
|
-Wanalyzer-double-free
|
||||||
|
-Wanalyzer-exposure-through-output-file
|
||||||
|
-Wanalyzer-exposure-through-uninit-copy
|
||||||
|
-Wanalyzer-fd-access-mode-mismatch
|
||||||
|
-Wanalyzer-fd-double-close
|
||||||
|
-Wanalyzer-fd-leak
|
||||||
|
-Wanalyzer-fd-phase-mismatch
|
||||||
|
-Wanalyzer-fd-type-mismatch
|
||||||
|
-Wanalyzer-fd-use-after-close
|
||||||
|
-Wanalyzer-fd-use-without-check
|
||||||
|
-Wanalyzer-file-leak
|
||||||
|
-Wanalyzer-free-of-non-heap
|
||||||
|
-Wanalyzer-imprecise-fp-arithmetic
|
||||||
|
-Wanalyzer-infinite-loop
|
||||||
|
-Wanalyzer-infinite-recursion
|
||||||
|
-Wanalyzer-jump-through-null
|
||||||
|
-Wanalyzer-malloc-leak
|
||||||
|
-Wanalyzer-mismatching-deallocation
|
||||||
|
-Wanalyzer-null-argument
|
||||||
|
-Wanalyzer-null-dereference
|
||||||
|
-Wanalyzer-out-of-bounds
|
||||||
|
-Wanalyzer-overlapping-buffers
|
||||||
|
-Wanalyzer-possible-null-argument
|
||||||
|
-Wanalyzer-possible-null-dereference
|
||||||
|
-Wanalyzer-putenv-of-auto-var
|
||||||
|
-Wanalyzer-shift-count-negative
|
||||||
|
-Wanalyzer-shift-count-overflow
|
||||||
|
-Wanalyzer-stale-setjmp-buffer
|
||||||
|
-Wanalyzer-symbol-too-complex
|
||||||
|
-Wanalyzer-tainted-allocation-size
|
||||||
|
-Wanalyzer-tainted-array-index
|
||||||
|
-Wanalyzer-tainted-assertion
|
||||||
|
-Wanalyzer-tainted-divisor
|
||||||
|
-Wanalyzer-tainted-offset
|
||||||
|
-Wanalyzer-tainted-size
|
||||||
|
-Wanalyzer-too-complex
|
||||||
|
-Wanalyzer-undefined-behavior-strtok
|
||||||
|
-Wanalyzer-unsafe-call-within-signal-handler
|
||||||
|
-Wanalyzer-use-after-free
|
||||||
|
-Wanalyzer-use-of-pointer-in-stale-stack-frame
|
||||||
|
-Wanalyzer-use-of-uninitialized-value
|
||||||
|
-Wanalyzer-va-arg-type-mismatch
|
||||||
|
-Wanalyzer-va-list-exhausted
|
||||||
|
-Wanalyzer-va-list-leak
|
||||||
|
-Wanalyzer-va-list-use-after-va-end
|
||||||
|
-Wanalyzer-write-to-const
|
||||||
|
-Wanalyzer-write-to-string-literal
|
||||||
|
-Warith-conversion
|
||||||
|
-Warray-bounds=2
|
||||||
|
-Warray-compare
|
||||||
|
-Warray-parameter=2
|
||||||
|
-Wattribute-alias=2
|
||||||
|
-Wattribute-warning
|
||||||
|
-Wattributes
|
||||||
|
-Wbool-compare
|
||||||
|
-Wbool-operation
|
||||||
|
-Wbuiltin-declaration-mismatch
|
||||||
|
-Wbuiltin-macro-redefined
|
||||||
|
-Wc++0x-compat
|
||||||
|
-Wc++11-compat
|
||||||
|
-Wc++11-extensions
|
||||||
|
-Wc++14-compat
|
||||||
|
-Wc++14-extensions
|
||||||
|
-Wc++17-compat
|
||||||
|
-Wc++17-extensions
|
||||||
|
-Wc++1z-compat
|
||||||
|
-Wc++20-compat
|
||||||
|
-Wc++20-extensions
|
||||||
|
-Wc++23-extensions
|
||||||
|
-Wc++26-extensions
|
||||||
|
-Wc++2a-compat
|
||||||
|
-Wcalloc-transposed-args
|
||||||
|
-Wcannot-profile
|
||||||
|
-Wcast-align
|
||||||
|
-Wcast-align=strict
|
||||||
|
-Wcast-function-type
|
||||||
|
-Wcast-qual
|
||||||
|
-Wcast-user-defined
|
||||||
|
-Wcatch-value=3
|
||||||
|
-Wchanges-meaning
|
||||||
|
-Wchar-subscripts
|
||||||
|
-Wclass-conversion
|
||||||
|
-Wclass-memaccess
|
||||||
|
-Wclobbered
|
||||||
|
-Wcomma-subscript
|
||||||
|
-Wcomment
|
||||||
|
-Wcomments
|
||||||
|
-Wcomplain-wrong-lang
|
||||||
|
-Wconditionally-supported
|
||||||
|
-Wconversion
|
||||||
|
-Wconversion-null
|
||||||
|
-Wcoverage-invalid-line-number
|
||||||
|
-Wcoverage-mismatch
|
||||||
|
-Wcoverage-too-many-conditions
|
||||||
|
-Wcpp
|
||||||
|
-Wctad-maybe-unsupported
|
||||||
|
-Wctor-dtor-privacy
|
||||||
|
-Wdangling-else
|
||||||
|
-Wdangling-pointer=2
|
||||||
|
-Wdangling-reference
|
||||||
|
-Wdate-time
|
||||||
|
-Wdelete-incomplete
|
||||||
|
-Wdelete-non-virtual-dtor
|
||||||
|
-Wdeprecated
|
||||||
|
-Wdeprecated-copy
|
||||||
|
-Wdeprecated-copy-dtor
|
||||||
|
-Wdeprecated-declarations
|
||||||
|
-Wdeprecated-enum-enum-conversion
|
||||||
|
-Wdeprecated-enum-float-conversion
|
||||||
|
-Wdisabled-optimization
|
||||||
|
-Wdiv-by-zero
|
||||||
|
-Wdouble-promotion
|
||||||
|
-Wduplicated-branches
|
||||||
|
-Wduplicated-cond
|
||||||
|
-Weffc++
|
||||||
|
-Welaborated-enum-base
|
||||||
|
-Wempty-body
|
||||||
|
-Wendif-labels
|
||||||
|
-Wenum-compare
|
||||||
|
-Wenum-conversion
|
||||||
|
-Wexceptions
|
||||||
|
-Wexpansion-to-defined
|
||||||
|
-Wextra
|
||||||
|
-Wextra-semi
|
||||||
|
-Wflex-array-member-not-at-end
|
||||||
|
-Wfloat-conversion
|
||||||
|
-Wfloat-equal
|
||||||
|
-Wformat -Wformat-contains-nul
|
||||||
|
-Wformat -Wformat-extra-args
|
||||||
|
-Wformat -Wformat-nonliteral
|
||||||
|
-Wformat -Wformat-security
|
||||||
|
-Wformat -Wformat-y2k
|
||||||
|
-Wformat -Wformat-zero-length
|
||||||
|
-Wformat-diag
|
||||||
|
-Wformat-overflow=2
|
||||||
|
-Wformat-signedness
|
||||||
|
-Wformat-truncation=2
|
||||||
|
-Wformat=2
|
||||||
|
-Wframe-address
|
||||||
|
-Wfree-nonheap-object
|
||||||
|
-Wglobal-module
|
||||||
|
-Whardened
|
||||||
|
-Whsa
|
||||||
|
-Wif-not-aligned
|
||||||
|
-Wignored-attributes
|
||||||
|
-Wignored-qualifiers
|
||||||
|
-Wimplicit-fallthrough=5
|
||||||
|
-Winaccessible-base
|
||||||
|
-Winfinite-recursion
|
||||||
|
-Winherited-variadic-ctor
|
||||||
|
-Winit-list-lifetime
|
||||||
|
-Winit-self
|
||||||
|
-Winline
|
||||||
|
-Wint-in-bool-context
|
||||||
|
-Wint-to-pointer-cast
|
||||||
|
-Winterference-size
|
||||||
|
-Winvalid-constexpr
|
||||||
|
-Winvalid-imported-macros
|
||||||
|
-Winvalid-memory-model
|
||||||
|
-Winvalid-offsetof
|
||||||
|
-Winvalid-pch
|
||||||
|
-Winvalid-utf8
|
||||||
|
-Wliteral-suffix
|
||||||
|
-Wlogical-not-parentheses
|
||||||
|
-Wlogical-op
|
||||||
|
-Wno-long-long
|
||||||
|
-Wlto-type-mismatch
|
||||||
|
-Wmain
|
||||||
|
-Wmaybe-uninitialized
|
||||||
|
-Wmemset-elt-size
|
||||||
|
-Wmemset-transposed-args
|
||||||
|
-Wmisleading-indentation
|
||||||
|
-Wmismatched-dealloc
|
||||||
|
-Wmismatched-new-delete
|
||||||
|
-Wmismatched-tags
|
||||||
|
-Wmissing-attributes
|
||||||
|
-Wmissing-braces
|
||||||
|
-Wmissing-declarations
|
||||||
|
-Wmissing-field-initializers
|
||||||
|
-Wmissing-include-dirs
|
||||||
|
-Wmissing-profile
|
||||||
|
-Wmissing-requires
|
||||||
|
-Wmissing-template-keyword
|
||||||
|
-Wmultichar
|
||||||
|
-Wmultiple-inheritance
|
||||||
|
-Wmultistatement-macros
|
||||||
|
-Wno-namespaces
|
||||||
|
-Wnarrowing
|
||||||
|
-Wnoexcept
|
||||||
|
-Wnoexcept-type
|
||||||
|
-Wnon-template-friend
|
||||||
|
-Wnon-virtual-dtor
|
||||||
|
-Wnonnull
|
||||||
|
-Wnonnull-compare
|
||||||
|
-Wnormalized=nfkc
|
||||||
|
-Wno-nrvo
|
||||||
|
-Wnull-dereference
|
||||||
|
-Wodr
|
||||||
|
-Wold-style-cast
|
||||||
|
-Wopenacc-parallelism
|
||||||
|
-Wopenmp
|
||||||
|
-Wopenmp-simd
|
||||||
|
-Woverflow
|
||||||
|
-Woverlength-strings
|
||||||
|
-Woverloaded-virtual=2
|
||||||
|
-Wpacked
|
||||||
|
-Wpacked-bitfield-compat
|
||||||
|
-Wpacked-not-aligned
|
||||||
|
-Wno-padded
|
||||||
|
-Wparentheses
|
||||||
|
-Wpedantic
|
||||||
|
-Wpessimizing-move
|
||||||
|
-Wplacement-new=2
|
||||||
|
-Wpmf-conversions
|
||||||
|
-Wpointer-arith
|
||||||
|
-Wpointer-compare
|
||||||
|
-Wpragmas
|
||||||
|
-Wprio-ctor-dtor
|
||||||
|
-Wpsabi
|
||||||
|
-Wrange-loop-construct
|
||||||
|
-Wredundant-decls
|
||||||
|
-Wredundant-move
|
||||||
|
-Wredundant-tags
|
||||||
|
-Wregister
|
||||||
|
-Wreorder
|
||||||
|
-Wrestrict
|
||||||
|
-Wreturn-local-addr
|
||||||
|
-Wreturn-type
|
||||||
|
-Wscalar-storage-order
|
||||||
|
-Wself-move
|
||||||
|
-Wsequence-point
|
||||||
|
-Wshadow=compatible-local
|
||||||
|
-Wshadow=global
|
||||||
|
-Wshadow=local
|
||||||
|
-Wshift-count-negative
|
||||||
|
-Wshift-count-overflow
|
||||||
|
-Wshift-negative-value
|
||||||
|
-Wshift-overflow=2
|
||||||
|
-Wsign-compare
|
||||||
|
-Wsign-conversion
|
||||||
|
-Wsign-promo
|
||||||
|
-Wsized-deallocation
|
||||||
|
-Wsizeof-array-argument
|
||||||
|
-Wsizeof-array-div
|
||||||
|
-Wsizeof-pointer-div
|
||||||
|
-Wsizeof-pointer-memaccess
|
||||||
|
-Wstack-protector
|
||||||
|
-Wstrict-aliasing=3
|
||||||
|
-Wstrict-null-sentinel
|
||||||
|
-Wstrict-overflow
|
||||||
|
-Wstring-compare
|
||||||
|
-Wstringop-overflow=4
|
||||||
|
-Wstringop-overread
|
||||||
|
-Wstringop-truncation
|
||||||
|
-Wsubobject-linkage
|
||||||
|
-Wsuggest-attribute=cold
|
||||||
|
-Wsuggest-attribute=const
|
||||||
|
-Wsuggest-attribute=format
|
||||||
|
-Wsuggest-attribute=malloc
|
||||||
|
-Wsuggest-attribute=noreturn
|
||||||
|
-Wsuggest-attribute=pure
|
||||||
|
-Wsuggest-attribute=returns_nonnull
|
||||||
|
-Wsuggest-final-methods
|
||||||
|
-Wsuggest-final-types
|
||||||
|
-Wsuggest-override
|
||||||
|
-Wswitch
|
||||||
|
-Wswitch-bool
|
||||||
|
-Wswitch-default
|
||||||
|
-Wswitch-enum
|
||||||
|
-Wswitch-outside-range
|
||||||
|
-Wswitch-unreachable
|
||||||
|
-Wsync-nand
|
||||||
|
-Wsynth
|
||||||
|
-Wno-system-headers
|
||||||
|
-Wtautological-compare
|
||||||
|
-Wno-templates
|
||||||
|
-Wterminate
|
||||||
|
-Wtrampolines
|
||||||
|
-Wtrigraphs
|
||||||
|
-Wtrivial-auto-var-init
|
||||||
|
-Wtsan
|
||||||
|
-Wtype-limits
|
||||||
|
-Wundef
|
||||||
|
-Wunicode
|
||||||
|
-Wuninitialized
|
||||||
|
-Wunknown-pragmas
|
||||||
|
-Wunreachable-code
|
||||||
|
-Wunsafe-loop-optimizations
|
||||||
|
-Wunused
|
||||||
|
-Wunused-but-set-parameter
|
||||||
|
-Wunused-but-set-variable
|
||||||
|
-Wunused-const-variable=2
|
||||||
|
-Wunused-function
|
||||||
|
-Wunused-label
|
||||||
|
-Wunused-local-typedefs
|
||||||
|
-Wunused-macros
|
||||||
|
-Wunused-parameter
|
||||||
|
-Wunused-result
|
||||||
|
-Wunused-value
|
||||||
|
-Wunused-variable
|
||||||
|
-Wuse-after-free=3
|
||||||
|
-Wuseless-cast
|
||||||
|
-Wvarargs
|
||||||
|
-Wvariadic-macros
|
||||||
|
-Wvector-operation-performance
|
||||||
|
-Wvexing-parse
|
||||||
|
-Wvirtual-inheritance
|
||||||
|
-Wvirtual-move-assign
|
||||||
|
-Wvla
|
||||||
|
-Wvla-parameter
|
||||||
|
-Wvolatile
|
||||||
|
-Wvolatile-register-var
|
||||||
|
-Wwrite-strings
|
||||||
|
-Wxor-used-as-pow
|
||||||
|
-Wzero-as-null-pointer-constant
|
||||||
|
-Wzero-length-bounds
|
||||||
|
)
|
||||||
@ -1,4 +1,7 @@
|
|||||||
Name: ${PROJECT_NAME}
|
prefix=@CMAKE_INSTALL_PREFIX@
|
||||||
|
includedir=${prefix}/@CMAKE_INSTALL_INCLUDEDIR@
|
||||||
|
|
||||||
|
Name: @PROJECT_NAME@
|
||||||
Description: JSON for Modern C++
|
Description: JSON for Modern C++
|
||||||
Version: ${PROJECT_VERSION}
|
Version: @PROJECT_VERSION@
|
||||||
Cflags: -I${CMAKE_INSTALL_FULL_INCLUDEDIR}
|
Cflags: -I${includedir}
|
||||||
|
|||||||
1
cmake/requirements/requirements-cppcheck.txt
Normal file
1
cmake/requirements/requirements-cppcheck.txt
Normal file
@ -0,0 +1 @@
|
|||||||
|
cppcheck==1.4.7
|
||||||
1
cmake/requirements/requirements-cpplint.txt
Normal file
1
cmake/requirements/requirements-cpplint.txt
Normal file
@ -0,0 +1 @@
|
|||||||
|
cpplint==2.0.0
|
||||||
1
cmake/requirements/requirements-reuse.txt
Normal file
1
cmake/requirements/requirements-reuse.txt
Normal file
@ -0,0 +1 @@
|
|||||||
|
reuse==5.0.2
|
||||||
@ -7,7 +7,7 @@ all: create_output
|
|||||||
##########################################################################
|
##########################################################################
|
||||||
|
|
||||||
# where are the example cpp files
|
# where are the example cpp files
|
||||||
EXAMPLES = $(wildcard examples/*.cpp)
|
EXAMPLES = $(wildcard mkdocs/docs/examples/*.cpp)
|
||||||
|
|
||||||
cxx_standard = $(lastword c++11 $(filter c++%, $(subst ., ,$1)))
|
cxx_standard = $(lastword c++11 $(filter c++%, $(subst ., ,$1)))
|
||||||
|
|
||||||
@ -37,9 +37,8 @@ check_output: $(EXAMPLES:.cpp=.test)
|
|||||||
|
|
||||||
# check output of all stand-alone example files (exclude files with platform-dependent output.)
|
# check output of all stand-alone example files (exclude files with platform-dependent output.)
|
||||||
# This target is used in the CI (ci_test_documentation).
|
# This target is used in the CI (ci_test_documentation).
|
||||||
check_output_portable: $(filter-out examples/meta.test examples/max_size.test examples/std_hash.test examples/basic_json__CompatibleType.test,$(EXAMPLES:.cpp=.test))
|
check_output_portable: $(filter-out mkdocs/docs/examples/meta.test mkdocs/docs/examples/max_size.test mkdocs/docs/examples/std_hash.test mkdocs/docs/examples/basic_json__CompatibleType.test,$(EXAMPLES:.cpp=.test))
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
rm -fr $(EXAMPLES:.cpp=)
|
rm -fr $(EXAMPLES:.cpp=)
|
||||||
$(MAKE) clean -C docset
|
$(MAKE) clean -C docset
|
||||||
$(MAKE) clean -C mkdocs
|
|
||||||
|
|||||||
@ -16,6 +16,7 @@ JSON_for_Modern_C++.docset: Info.plist docSet.dsidx
|
|||||||
cp icon*.png JSON_for_Modern_C++.docset
|
cp icon*.png JSON_for_Modern_C++.docset
|
||||||
cp Info.plist JSON_for_Modern_C++.docset/Contents
|
cp Info.plist JSON_for_Modern_C++.docset/Contents
|
||||||
# build and copy documentation
|
# build and copy documentation
|
||||||
|
$(MAKE) install_venv -C ../mkdocs
|
||||||
$(MAKE) build -C ../mkdocs
|
$(MAKE) build -C ../mkdocs
|
||||||
cp -r ../mkdocs/site/* JSON_for_Modern_C++.docset/Contents/Resources/Documents
|
cp -r ../mkdocs/site/* JSON_for_Modern_C++.docset/Contents/Resources/Documents
|
||||||
# patch CSS to hide navigation items
|
# patch CSS to hide navigation items
|
||||||
|
|||||||
@ -38,6 +38,7 @@ INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::emplace', 'Method
|
|||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::emplace_back', 'Method', 'api/basic_json/emplace_back/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::emplace_back', 'Method', 'api/basic_json/emplace_back/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::empty', 'Method', 'api/basic_json/empty/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::empty', 'Method', 'api/basic_json/empty/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::end', 'Method', 'api/basic_json/end/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::end', 'Method', 'api/basic_json/end/index.html');
|
||||||
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::end_pos', 'Method', 'api/basic_json/end_pos/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::erase', 'Method', 'api/basic_json/erase/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::erase', 'Method', 'api/basic_json/erase/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::error_handler_t', 'Enum', 'api/basic_json/error_handler_t/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::error_handler_t', 'Enum', 'api/basic_json/error_handler_t/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::exception', 'Class', 'api/basic_json/exception/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::exception', 'Class', 'api/basic_json/exception/index.html');
|
||||||
@ -72,6 +73,7 @@ INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::is_primitive', 'M
|
|||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::is_string', 'Method', 'api/basic_json/is_string/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::is_string', 'Method', 'api/basic_json/is_string/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::is_structured', 'Method', 'api/basic_json/is_structured/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::is_structured', 'Method', 'api/basic_json/is_structured/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::items', 'Method', 'api/basic_json/items/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::items', 'Method', 'api/basic_json/items/index.html');
|
||||||
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::json_base_class_t', 'Type', 'api/basic_json/json_base_class_t/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::json_serializer', 'Class', 'api/basic_json/json_serializer/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::json_serializer', 'Class', 'api/basic_json/json_serializer/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::max_size', 'Method', 'api/basic_json/max_size/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::max_size', 'Method', 'api/basic_json/max_size/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::merge_patch', 'Method', 'api/basic_json/merge_patch/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::merge_patch', 'Method', 'api/basic_json/merge_patch/index.html');
|
||||||
@ -107,6 +109,7 @@ INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::rbegin', 'Method'
|
|||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::rend', 'Method', 'api/basic_json/rend/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::rend', 'Method', 'api/basic_json/rend/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::sax_parse', 'Function', 'api/basic_json/sax_parse/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::sax_parse', 'Function', 'api/basic_json/sax_parse/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::size', 'Method', 'api/basic_json/size/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::size', 'Method', 'api/basic_json/size/index.html');
|
||||||
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::start_pos', 'Method', 'api/basic_json/start_pos/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::string_t', 'Type', 'api/basic_json/string_t/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::string_t', 'Type', 'api/basic_json/string_t/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::swap', 'Method', 'api/basic_json/swap/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::swap', 'Method', 'api/basic_json/swap/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::type', 'Method', 'api/basic_json/type/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::type', 'Method', 'api/basic_json/type/index.html');
|
||||||
@ -175,6 +178,7 @@ INSERT INTO searchIndex(name, type, path) VALUES ('Element Access', 'Guide', 'fe
|
|||||||
INSERT INTO searchIndex(name, type, path) VALUES ('Element Access: Access with default value: value', 'Guide', 'features/element_access/default_value/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('Element Access: Access with default value: value', 'Guide', 'features/element_access/default_value/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('Element Access: Checked access: at', 'Guide', 'features/element_access/checked_access/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('Element Access: Checked access: at', 'Guide', 'features/element_access/checked_access/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('Element Access: Unchecked access: operator[]', 'Guide', 'features/element_access/unchecked_access/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('Element Access: Unchecked access: operator[]', 'Guide', 'features/element_access/unchecked_access/index.html');
|
||||||
|
INSERT INTO searchIndex(name, type, path) VALUES ('Exceptions', 'Guide', 'home/exceptions/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('Integration: Migration Guide', 'Guide', 'integration/migration_guide/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('Integration: Migration Guide', 'Guide', 'integration/migration_guide/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('Integration: CMake', 'Guide', 'integration/cmake/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('Integration: CMake', 'Guide', 'integration/cmake/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('Integration: Header only', 'Guide', 'integration/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('Integration: Header only', 'Guide', 'integration/index.html');
|
||||||
@ -201,6 +205,7 @@ INSERT INTO searchIndex(name, type, path) VALUES ('Supported Macros', 'Guide', '
|
|||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_ASSERT', 'Macro', 'api/macros/json_assert/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_ASSERT', 'Macro', 'api/macros/json_assert/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_CATCH_USER', 'Macro', 'api/macros/json_throw_user/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_CATCH_USER', 'Macro', 'api/macros/json_throw_user/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_DIAGNOSTICS', 'Macro', 'api/macros/json_diagnostics/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_DIAGNOSTICS', 'Macro', 'api/macros/json_diagnostics/index.html');
|
||||||
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_DIAGNOSTIC_POSITIONS', 'Macro', 'api/macros/json_diagnostic_positions/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_DISABLE_ENUM_SERIALIZATION', 'Macro', 'api/macros/json_disable_enum_serialization/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_DISABLE_ENUM_SERIALIZATION', 'Macro', 'api/macros/json_disable_enum_serialization/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_HAS_CPP_11', 'Macro', 'api/macros/json_has_cpp_11/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_HAS_CPP_11', 'Macro', 'api/macros/json_has_cpp_11/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_HAS_CPP_14', 'Macro', 'api/macros/json_has_cpp_11/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_HAS_CPP_14', 'Macro', 'api/macros/json_has_cpp_11/index.html');
|
||||||
@ -209,6 +214,7 @@ INSERT INTO searchIndex(name, type, path) VALUES ('JSON_HAS_CPP_20', 'Macro', 'a
|
|||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_HAS_EXPERIMENTAL_FILESYSTEM', 'Macro', 'api/macros/json_has_filesystem/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_HAS_EXPERIMENTAL_FILESYSTEM', 'Macro', 'api/macros/json_has_filesystem/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_HAS_FILESYSTEM', 'Macro', 'api/macros/json_has_filesystem/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_HAS_FILESYSTEM', 'Macro', 'api/macros/json_has_filesystem/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_HAS_RANGES', 'Macro', 'api/macros/json_has_ranges/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_HAS_RANGES', 'Macro', 'api/macros/json_has_ranges/index.html');
|
||||||
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_HAS_STATIC_RTTI', 'Macro', 'api/macros/json_has_static_rtti/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_HAS_THREE_WAY_COMPARISON', 'Macro', 'api/macros/json_has_three_way_comparison/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_HAS_THREE_WAY_COMPARISON', 'Macro', 'api/macros/json_has_three_way_comparison/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_NOEXCEPTION', 'Macro', 'api/macros/json_noexception/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_NOEXCEPTION', 'Macro', 'api/macros/json_noexception/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_NO_IO', 'Macro', 'api/macros/json_no_io/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_NO_IO', 'Macro', 'api/macros/json_no_io/index.html');
|
||||||
@ -220,6 +226,10 @@ INSERT INTO searchIndex(name, type, path) VALUES ('JSON_USE_GLOBAL_UDLS', 'Macro
|
|||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_USE_IMPLICIT_CONVERSIONS', 'Macro', 'api/macros/json_use_implicit_conversions/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_USE_IMPLICIT_CONVERSIONS', 'Macro', 'api/macros/json_use_implicit_conversions/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON', 'Macro', 'api/macros/json_use_legacy_discarded_value_comparison/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON', 'Macro', 'api/macros/json_use_legacy_discarded_value_comparison/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('Macros', 'Macro', 'api/macros/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('Macros', 'Macro', 'api/macros/index.html');
|
||||||
|
INSERT INTO searchIndex(name, type, path) VALUES ('NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE', 'Macro', 'api/macros/nlohmann_define_derived_type/index.html');
|
||||||
|
INSERT INTO searchIndex(name, type, path) VALUES ('NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_WITH_DEFAULT', 'Macro', 'api/macros/nlohmann_define_derived_type/index.html');
|
||||||
|
INSERT INTO searchIndex(name, type, path) VALUES ('NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE', 'Macro', 'api/macros/nlohmann_define_derived_type/index.html');
|
||||||
|
INSERT INTO searchIndex(name, type, path) VALUES ('NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_WITH_DEFAULT', 'Macro', 'api/macros/nlohmann_define_derived_type/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('NLOHMANN_DEFINE_TYPE_INTRUSIVE', 'Macro', 'api/macros/nlohmann_define_type_intrusive/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('NLOHMANN_DEFINE_TYPE_INTRUSIVE', 'Macro', 'api/macros/nlohmann_define_type_intrusive/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_DEFAULT', 'Macro', 'api/macros/nlohmann_define_type_intrusive/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_DEFAULT', 'Macro', 'api/macros/nlohmann_define_type_intrusive/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE', 'Macro', 'api/macros/nlohmann_define_type_non_intrusive/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE', 'Macro', 'api/macros/nlohmann_define_type_non_intrusive/index.html');
|
||||||
|
|||||||
@ -1,37 +1,45 @@
|
|||||||
# serve the site locally
|
# serve the site locally
|
||||||
serve: prepare_files style_check
|
serve: style_check
|
||||||
venv/bin/mkdocs serve
|
venv/bin/mkdocs serve
|
||||||
|
|
||||||
serve_dirty: prepare_files style_check
|
serve_dirty: style_check
|
||||||
venv/bin/mkdocs serve --dirtyreload
|
venv/bin/mkdocs serve --dirtyreload
|
||||||
|
|
||||||
build: prepare_files style_check
|
# This target is used in the CI (ci_test_build_documentation).
|
||||||
|
# This target is used by the docset Makefile.
|
||||||
|
build: style_check
|
||||||
venv/bin/mkdocs build
|
venv/bin/mkdocs build
|
||||||
|
|
||||||
# create files that are not versioned inside the mkdocs folder (images, examples)
|
|
||||||
prepare_files: clean
|
|
||||||
mkdir docs/examples
|
|
||||||
cp -r ../json.gif docs/images
|
|
||||||
cp -r ../examples/*.cpp ../examples/*.output docs/examples
|
|
||||||
|
|
||||||
style_check:
|
style_check:
|
||||||
@cd docs ; python3 ../scripts/check_structure.py
|
@cd docs ; ../venv/bin/python3 ../scripts/check_structure.py
|
||||||
|
|
||||||
# clean subfolders
|
# check the links in the documentation files in docs/mkdocs
|
||||||
clean:
|
link_check:
|
||||||
rm -fr docs/images/json.gif docs/examples
|
ENABLED_HTMLPROOFER=true venv/bin/mkdocs build
|
||||||
|
|
||||||
|
# check the links in all other Markdown files
|
||||||
|
link_check_markdowns:
|
||||||
|
npx markdown-link-check --progress --alive 200,429 ../../README.md ../../FILES.md ../../.github/*.md
|
||||||
|
|
||||||
# publish site to GitHub pages (not working in GitHub Actions; need special action)
|
# publish site to GitHub pages (not working in GitHub Actions; need special action)
|
||||||
publish: prepare_files
|
publish:
|
||||||
venv/bin/mkdocs gh-deploy --clean --force
|
venv/bin/mkdocs gh-deploy --clean --force
|
||||||
|
|
||||||
# install a Python virtual environment
|
# install a Python virtual environment
|
||||||
|
# This target is used by the docset Makefile.
|
||||||
install_venv: requirements.txt
|
install_venv: requirements.txt
|
||||||
python3 -mvenv venv
|
python3 -mvenv venv
|
||||||
venv/bin/pip install --upgrade pip
|
venv/bin/pip install --upgrade pip
|
||||||
venv/bin/pip install wheel
|
|
||||||
venv/bin/pip install -r requirements.txt
|
venv/bin/pip install -r requirements.txt
|
||||||
|
|
||||||
# uninstall the virtual environment
|
# uninstall the virtual environment
|
||||||
uninstall_venv: clean
|
uninstall_venv:
|
||||||
rm -fr venv
|
rm -fr venv
|
||||||
|
|
||||||
|
update_requirements:
|
||||||
|
rm -fr venv_small
|
||||||
|
python3 -mvenv venv_small
|
||||||
|
venv_small/bin/pip3 install pur
|
||||||
|
venv_small/bin/pur -r requirements.txt
|
||||||
|
rm -fr venv_small venv
|
||||||
|
make install_venv
|
||||||
|
|||||||
@ -20,7 +20,7 @@ Checks whether the input is valid JSON.
|
|||||||
The value_type of the iterator must be an integral type with size of 1, 2 or 4 bytes, which will be interpreted
|
The value_type of the iterator must be an integral type with size of 1, 2 or 4 bytes, which will be interpreted
|
||||||
respectively as UTF-8, UTF-16 and UTF-32.
|
respectively as UTF-8, UTF-16 and UTF-32.
|
||||||
|
|
||||||
Unlike the [`parse`](parse.md) function, this function neither throws an exception in case of invalid JSON input
|
Unlike the [`parse()`](parse.md) function, this function neither throws an exception in case of invalid JSON input
|
||||||
(i.e., a parse error) nor creates diagnostic information.
|
(i.e., a parse error) nor creates diagnostic information.
|
||||||
|
|
||||||
## Template parameters
|
## Template parameters
|
||||||
@ -29,9 +29,9 @@ Unlike the [`parse`](parse.md) function, this function neither throws an excepti
|
|||||||
: A compatible input, for instance:
|
: A compatible input, for instance:
|
||||||
|
|
||||||
- an `std::istream` object
|
- an `std::istream` object
|
||||||
- a `FILE` pointer (must not be null)
|
- a `#!c FILE` pointer (throws if null)
|
||||||
- a C-style array of characters
|
- a C-style array of characters
|
||||||
- a pointer to a null-terminated string of single byte characters
|
- a pointer to a null-terminated string of single byte characters (throws if null)
|
||||||
- a `std::string`
|
- a `std::string`
|
||||||
- an object `obj` for which `begin(obj)` and `end(obj)` produces a valid pair of iterators.
|
- an object `obj` for which `begin(obj)` and `end(obj)` produces a valid pair of iterators.
|
||||||
|
|
||||||
@ -64,18 +64,17 @@ Whether the input is valid JSON.
|
|||||||
|
|
||||||
Strong guarantee: if an exception is thrown, there are no changes in the JSON value.
|
Strong guarantee: if an exception is thrown, there are no changes in the JSON value.
|
||||||
|
|
||||||
|
## Exceptions
|
||||||
|
|
||||||
|
Throws [`parse_error.101`](../../home/exceptions.md#jsonexceptionparse_error101) in case of an empty input like a null `#!c FILE*` or `#!c char*` pointer.
|
||||||
|
|
||||||
## Complexity
|
## Complexity
|
||||||
|
|
||||||
Linear in the length of the input. The parser is a predictive LL(1) parser.
|
Linear in the length of the input. The parser is a predictive LL(1) parser.
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
(1) A UTF-8 byte order mark is silently ignored.
|
A UTF-8 byte order mark is silently ignored.
|
||||||
|
|
||||||
!!! danger "Runtime assertion"
|
|
||||||
|
|
||||||
The precondition that a passed `#!cpp FILE` pointer must not be null is enforced with a
|
|
||||||
[runtime assertion](../../features/assertions.md).
|
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@ -102,6 +101,7 @@ Linear in the length of the input. The parser is a predictive LL(1) parser.
|
|||||||
|
|
||||||
- Added in version 3.0.0.
|
- Added in version 3.0.0.
|
||||||
- Ignoring comments via `ignore_comments` added in version 3.9.0.
|
- Ignoring comments via `ignore_comments` added in version 3.9.0.
|
||||||
|
- Changed [runtime assertion](../../features/assertions.md) in case of `FILE*` null pointers to exception in version 3.11.4.
|
||||||
|
|
||||||
!!! warning "Deprecation"
|
!!! warning "Deprecation"
|
||||||
|
|
||||||
|
|||||||
@ -215,8 +215,8 @@ Strong exception safety: if an exception occurs, the original value stays intact
|
|||||||
## See also
|
## See also
|
||||||
|
|
||||||
- documentation on [checked access](../../features/element_access/checked_access.md)
|
- documentation on [checked access](../../features/element_access/checked_access.md)
|
||||||
- see [`operator[]`](operator%5B%5D.md) for unchecked access by reference
|
- [`operator[]`](operator%5B%5D.md) for unchecked access by reference
|
||||||
- see [`value`](value.md) for access with default value
|
- [`value`](value.md) for access with default value
|
||||||
|
|
||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
|
|||||||
@ -14,6 +14,11 @@ created from `args`.
|
|||||||
`Args`
|
`Args`
|
||||||
: compatible types to create a `basic_json` object
|
: compatible types to create a `basic_json` object
|
||||||
|
|
||||||
|
## Iterator invalidation
|
||||||
|
|
||||||
|
For [`ordered_json`](../ordered_json.md), adding a value to an object can yield a reallocation, in which case all
|
||||||
|
iterators (including the `end()` iterator) and all references to the elements are invalidated.
|
||||||
|
|
||||||
## Parameters
|
## Parameters
|
||||||
|
|
||||||
`args` (in)
|
`args` (in)
|
||||||
|
|||||||
@ -13,6 +13,12 @@ Creates a JSON value from the passed parameters `args` to the end of the JSON va
|
|||||||
`Args`
|
`Args`
|
||||||
: compatible types to create a `basic_json` object
|
: compatible types to create a `basic_json` object
|
||||||
|
|
||||||
|
## Iterator invalidation
|
||||||
|
|
||||||
|
By adding an element to the end of the array, a reallocation can happen, in which case all iterators (including the
|
||||||
|
[`end()`](end.md) iterator) and all references to the elements are invalidated. Otherwise, only the [`end()`](end.md)
|
||||||
|
iterator is invalidated.
|
||||||
|
|
||||||
## Parameters
|
## Parameters
|
||||||
|
|
||||||
`args` (in)
|
`args` (in)
|
||||||
@ -48,6 +54,11 @@ Amortized constant.
|
|||||||
--8<-- "examples/emplace_back.output"
|
--8<-- "examples/emplace_back.output"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## See also
|
||||||
|
|
||||||
|
- [operator+=](operator+=.md) add a value to an array/object
|
||||||
|
- [push_back](push_back.md) add a value to an array/object
|
||||||
|
|
||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
- Since version 2.0.8.
|
- Since version 2.0.8.
|
||||||
|
|||||||
68
docs/mkdocs/docs/api/basic_json/end_pos.md
Normal file
68
docs/mkdocs/docs/api/basic_json/end_pos.md
Normal file
@ -0,0 +1,68 @@
|
|||||||
|
# <small>nlohmann::basic_json::</small>end_pos
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
#if JSON_DIAGNOSTIC_POSITIONS
|
||||||
|
constexpr std::size_t end_pos() const noexcept;
|
||||||
|
#endif
|
||||||
|
```
|
||||||
|
|
||||||
|
Returns the position immediately following the last character of the JSON string from which the value was parsed from.
|
||||||
|
|
||||||
|
| JSON type | return value |
|
||||||
|
|-----------|-----------------------------------|
|
||||||
|
| object | position after the closing `}` |
|
||||||
|
| array | position after the closing `]` |
|
||||||
|
| string | position after the closing `"` |
|
||||||
|
| number | position after the last character |
|
||||||
|
| boolean | position after `e` |
|
||||||
|
| null | position after `l` |
|
||||||
|
|
||||||
|
## Return value
|
||||||
|
|
||||||
|
the position of the character _following_ the last character of the given value in the parsed JSON string, if the
|
||||||
|
value was created by the [`parse`](parse.md) function, or `std::string::npos` if the value was constructed otherwise
|
||||||
|
|
||||||
|
## Exception safety
|
||||||
|
|
||||||
|
No-throw guarantee: this member function never throws exceptions.
|
||||||
|
|
||||||
|
## Complexity
|
||||||
|
|
||||||
|
Constant.
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
!!! note "Note"
|
||||||
|
|
||||||
|
The function is only available if macro [`JSON_DIAGNOSTIC_POSITIONS`](../macros/json_diagnostic_positions.md) has
|
||||||
|
been defined to `#!cpp 1` before including the library header.
|
||||||
|
|
||||||
|
!!! warning "Invalidation"
|
||||||
|
|
||||||
|
The returned positions are only valid as long as the JSON value is not changed. The positions are *not* updated
|
||||||
|
when the JSON value is changed.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
??? example "Example"
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
--8<-- "examples/diagnostic_positions.cpp"
|
||||||
|
```
|
||||||
|
|
||||||
|
Output:
|
||||||
|
|
||||||
|
```
|
||||||
|
--8<-- "examples/diagnostic_positions.output"
|
||||||
|
```
|
||||||
|
|
||||||
|
The output shows the start/end positions of all the objects and fields in the JSON string.
|
||||||
|
|
||||||
|
## See also
|
||||||
|
|
||||||
|
- [start_pos](start_pos.md) to access the start position
|
||||||
|
- [JSON_DIAGNOSTIC_POSITIONS](../macros/json_diagnostic_positions.md) for an overview of the diagnostic positions
|
||||||
|
|
||||||
|
## Version history
|
||||||
|
|
||||||
|
- Added in version 3.12.0.
|
||||||
@ -8,24 +8,36 @@ This class is an extension of [`std::exception`](https://en.cppreference.com/w/c
|
|||||||
member `id` for exception ids. It is used as the base class for all exceptions thrown by the `basic_json` class. This
|
member `id` for exception ids. It is used as the base class for all exceptions thrown by the `basic_json` class. This
|
||||||
class can hence be used as "wildcard" to catch exceptions, see example below.
|
class can hence be used as "wildcard" to catch exceptions, see example below.
|
||||||
|
|
||||||
```plantuml
|
```mermaid
|
||||||
std::exception <|-- basic_json::exception
|
classDiagram
|
||||||
basic_json::exception <|-- basic_json::parse_error
|
direction LR
|
||||||
basic_json::exception <|-- basic_json::invalid_iterator
|
|
||||||
basic_json::exception <|-- basic_json::type_error
|
|
||||||
basic_json::exception <|-- basic_json::out_of_range
|
|
||||||
basic_json::exception <|-- basic_json::other_error
|
|
||||||
|
|
||||||
interface std::exception {}
|
class std_exception ["std::exception"] {
|
||||||
|
<<interface>>
|
||||||
|
}
|
||||||
|
|
||||||
class basic_json::exception #FFFF00 {
|
class json_exception ["basic_json::exception"] {
|
||||||
+const int id
|
+const int id
|
||||||
+const char* what() const
|
+const char* what() const
|
||||||
}
|
}
|
||||||
|
|
||||||
class basic_json::parse_error {
|
class json_parse_error ["basic_json::parse_error"] {
|
||||||
+const std::size_t byte
|
+const std::size_t byte
|
||||||
}
|
}
|
||||||
|
|
||||||
|
class json_invalid_iterator ["basic_json::invalid_iterator"]
|
||||||
|
class json_type_error ["basic_json::type_error"]
|
||||||
|
class json_out_of_range ["basic_json::out_of_range"]
|
||||||
|
class json_other_error ["basic_json::other_error"]
|
||||||
|
|
||||||
|
std_exception <|-- json_exception
|
||||||
|
json_exception <|-- json_parse_error
|
||||||
|
json_exception <|-- json_invalid_iterator
|
||||||
|
json_exception <|-- json_type_error
|
||||||
|
json_exception <|-- json_out_of_range
|
||||||
|
json_exception <|-- json_other_error
|
||||||
|
|
||||||
|
style json_exception fill:#CCCCFF
|
||||||
```
|
```
|
||||||
|
|
||||||
Subclasses:
|
Subclasses:
|
||||||
|
|||||||
@ -35,7 +35,37 @@ Constant.
|
|||||||
|
|
||||||
!!! danger "Undefined behavior"
|
!!! danger "Undefined behavior"
|
||||||
|
|
||||||
Writing data to the pointee of the result yields an undefined state.
|
The pointer becomes invalid if the underlying JSON object changes.
|
||||||
|
|
||||||
|
Consider the following example code where the pointer `ptr` changes after the array is resized. As a result,
|
||||||
|
reading or writing to `ptr` after the array change would be undefined behavior. The address of the first array
|
||||||
|
element changes, because the underlying `std::vector` is resized after adding a fifth element.
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
#include <iostream>
|
||||||
|
#include <nlohmann/json.hpp>
|
||||||
|
|
||||||
|
using json = nlohmann::json;
|
||||||
|
|
||||||
|
int main()
|
||||||
|
{
|
||||||
|
json j = {1, 2, 3, 4};
|
||||||
|
auto* ptr = j[0].get_ptr<std::int64_t*>();
|
||||||
|
std::cout << "value at " << ptr << " is " << *ptr << std::endl;
|
||||||
|
|
||||||
|
j.push_back(5);
|
||||||
|
|
||||||
|
ptr = j[0].get_ptr<std::int64_t*>();
|
||||||
|
std::cout << "value at " << ptr << " is " << *ptr << std::endl;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Output:
|
||||||
|
|
||||||
|
```
|
||||||
|
value at 0x6000012fc1c8 is 1
|
||||||
|
value at 0x6000029fc088 is 1
|
||||||
|
```
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@ -54,6 +84,10 @@ Constant.
|
|||||||
--8<-- "examples/get_ptr.output"
|
--8<-- "examples/get_ptr.output"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## See also
|
||||||
|
|
||||||
|
- [get_ref()](get_ref.md) get a reference value
|
||||||
|
|
||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
- Added in version 1.0.0.
|
- Added in version 1.0.0.
|
||||||
|
|||||||
@ -40,7 +40,7 @@ Constant.
|
|||||||
|
|
||||||
!!! danger "Undefined behavior"
|
!!! danger "Undefined behavior"
|
||||||
|
|
||||||
Writing data to the referee of the result yields an undefined state.
|
The reference becomes invalid if the underlying JSON object changes.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@ -58,6 +58,10 @@ Constant.
|
|||||||
--8<-- "examples/get_ref.output"
|
--8<-- "examples/get_ref.output"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## See also
|
||||||
|
|
||||||
|
- [get_ptr()](get_ptr.md) get a pointer value
|
||||||
|
|
||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
- Added in version 1.1.0.
|
- Added in version 1.1.0.
|
||||||
|
|||||||
@ -42,7 +42,15 @@ class basic_json;
|
|||||||
|
|
||||||
## Iterator invalidation
|
## Iterator invalidation
|
||||||
|
|
||||||
Todo
|
All operations that add values to an **array** ([`push_back`](push_back.md) , [`operator+=`](operator+=.md),
|
||||||
|
[`emplace_back`](emplace_back.md), [`insert`](insert.md), and [`operator[]`](operator%5B%5D.md) for a non-existing
|
||||||
|
index) can yield a reallocation, in which case all iterators (including the [`end()`](end.md) iterator) and all
|
||||||
|
references to the elements are invalidated.
|
||||||
|
|
||||||
|
For [`ordered_json`](../ordered_json.md), also all operations that add a value to an **object**
|
||||||
|
([`push_back`](push_back.md), [`operator+=`](operator+=.md), [`emplace`](emplace.md), [`insert`](insert.md),
|
||||||
|
[`update`](update.md), and [`operator[]`](operator%5B%5D.md) for a non-existing key) can yield a reallocation, in
|
||||||
|
which case all iterators (including the [`end()`](end.md) iterator) and all references to the elements are invalidated.
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
@ -148,9 +156,9 @@ The class satisfies the following concept requirements:
|
|||||||
- [(constructor)](basic_json.md)
|
- [(constructor)](basic_json.md)
|
||||||
- [(destructor)](~basic_json.md)
|
- [(destructor)](~basic_json.md)
|
||||||
- [**operator=**](operator=.md) - copy assignment
|
- [**operator=**](operator=.md) - copy assignment
|
||||||
- [**array**](array_t.md) (_static_) - explicitly create an array
|
- [**array**](array.md) (_static_) - explicitly create an array
|
||||||
- [**binary**](binary.md) (_static_) - explicitly create a binary array
|
- [**binary**](binary.md) (_static_) - explicitly create a binary array
|
||||||
- [**object**](object_t.md) (_static_) - explicitly create an object
|
- [**object**](object.md) (_static_) - explicitly create an object
|
||||||
|
|
||||||
### Object inspection
|
### Object inspection
|
||||||
|
|
||||||
@ -173,6 +181,11 @@ Functions to inspect the type of a JSON value.
|
|||||||
- [**is_binary**](is_binary.md) - return whether value is a binary array
|
- [**is_binary**](is_binary.md) - return whether value is a binary array
|
||||||
- [**is_discarded**](is_discarded.md) - return whether value is discarded
|
- [**is_discarded**](is_discarded.md) - return whether value is discarded
|
||||||
|
|
||||||
|
Optional functions to access the [diagnostic positions](../macros/json_diagnostic_positions.md).
|
||||||
|
|
||||||
|
- [**start_pos**](start_pos.md) - return the start position of the value
|
||||||
|
- [**end_pos**](end_pos.md) - return the one past the end position of the value
|
||||||
|
|
||||||
### Value access
|
### Value access
|
||||||
|
|
||||||
Direct access to the stored value of a JSON value.
|
Direct access to the stored value of a JSON value.
|
||||||
|
|||||||
@ -24,6 +24,17 @@ void insert(const_iterator first, const_iterator last);
|
|||||||
4. Inserts elements from initializer list `ilist` into array before iterator `pos`.
|
4. Inserts elements from initializer list `ilist` into array before iterator `pos`.
|
||||||
5. Inserts elements from range `[first, last)` into object.
|
5. Inserts elements from range `[first, last)` into object.
|
||||||
|
|
||||||
|
## Iterator invalidation
|
||||||
|
|
||||||
|
For all cases where an element is added to an **array**, a reallocation can happen, in which case all iterators
|
||||||
|
(including the [`end()`](end.md) iterator) and all references to the elements are invalidated. Otherwise, only the
|
||||||
|
[`end()`](end.md) iterator is invalidated. Also, any iterator or reference after the insertion point will point to the
|
||||||
|
same index which is now a different value.
|
||||||
|
|
||||||
|
For [`ordered_json`](../ordered_json.md), also adding an element to an **object** can yield a reallocation which again
|
||||||
|
invalidates all iterators and all references. Also, any iterator or reference after the insertion point will point to
|
||||||
|
the same index which is now a different value.
|
||||||
|
|
||||||
## Parameters
|
## Parameters
|
||||||
|
|
||||||
`pos` (in)
|
`pos` (in)
|
||||||
|
|||||||
@ -8,26 +8,36 @@ This exception is thrown if iterators passed to a library function do not match
|
|||||||
|
|
||||||
Exceptions have ids 2xx (see [list of iterator errors](../../home/exceptions.md#iterator-errors)).
|
Exceptions have ids 2xx (see [list of iterator errors](../../home/exceptions.md#iterator-errors)).
|
||||||
|
|
||||||
```plantuml
|
```mermaid
|
||||||
std::exception <|-- basic_json::exception
|
classDiagram
|
||||||
basic_json::exception <|-- basic_json::parse_error
|
direction LR
|
||||||
basic_json::exception <|-- basic_json::invalid_iterator
|
|
||||||
basic_json::exception <|-- basic_json::type_error
|
|
||||||
basic_json::exception <|-- basic_json::out_of_range
|
|
||||||
basic_json::exception <|-- basic_json::other_error
|
|
||||||
|
|
||||||
interface std::exception {}
|
class std_exception ["std::exception"] {
|
||||||
|
<<interface>>
|
||||||
|
}
|
||||||
|
|
||||||
class basic_json::exception {
|
class json_exception ["basic_json::exception"] {
|
||||||
+const int id
|
+const int id
|
||||||
+const char* what() const
|
+const char* what() const
|
||||||
}
|
}
|
||||||
|
|
||||||
class basic_json::parse_error {
|
class json_parse_error ["basic_json::parse_error"] {
|
||||||
+const std::size_t byte
|
+const std::size_t byte
|
||||||
}
|
}
|
||||||
|
|
||||||
class basic_json::invalid_iterator #FFFF00 {}
|
class json_invalid_iterator ["basic_json::invalid_iterator"]
|
||||||
|
class json_type_error ["basic_json::type_error"]
|
||||||
|
class json_out_of_range ["basic_json::out_of_range"]
|
||||||
|
class json_other_error ["basic_json::other_error"]
|
||||||
|
|
||||||
|
std_exception <|-- json_exception
|
||||||
|
json_exception <|-- json_parse_error
|
||||||
|
json_exception <|-- json_invalid_iterator
|
||||||
|
json_exception <|-- json_type_error
|
||||||
|
json_exception <|-- json_out_of_range
|
||||||
|
json_exception <|-- json_other_error
|
||||||
|
|
||||||
|
style json_invalid_iterator fill:#CCCCFF
|
||||||
```
|
```
|
||||||
|
|
||||||
## Member functions
|
## Member functions
|
||||||
|
|||||||
@ -66,7 +66,7 @@ When iterating over an array, `key()` will return the index of the element as st
|
|||||||
!!! danger "Lifetime issues"
|
!!! danger "Lifetime issues"
|
||||||
|
|
||||||
Using `items()` on temporary objects is dangerous. Make sure the object's lifetime exceeds the iteration. See
|
Using `items()` on temporary objects is dangerous. Make sure the object's lifetime exceeds the iteration. See
|
||||||
<https://github.com/nlohmann/json/issues/2040> for more information.
|
[#2040](https://github.com/nlohmann/json/issues/2040) for more information.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
@ -27,6 +27,15 @@ reference operator+=(initializer_list_t init);
|
|||||||
`init` is converted into an object element and added using `operator+=(const typename object_t::value_type&)`.
|
`init` is converted into an object element and added using `operator+=(const typename object_t::value_type&)`.
|
||||||
Otherwise, `init` is converted to a JSON value and added using `operator+=(basic_json&&)`.
|
Otherwise, `init` is converted to a JSON value and added using `operator+=(basic_json&&)`.
|
||||||
|
|
||||||
|
## Iterator invalidation
|
||||||
|
|
||||||
|
For all cases where an element is added to an **array**, a reallocation can happen, in which case all iterators (including
|
||||||
|
the [`end()`](end.md) iterator) and all references to the elements are invalidated. Otherwise, only the
|
||||||
|
[`end()`](end.md) iterator is invalidated.
|
||||||
|
|
||||||
|
For [`ordered_json`](../ordered_json.md), also adding an element to an **object** can yield a reallocation which again
|
||||||
|
invalidates all iterators and all references.
|
||||||
|
|
||||||
## Parameters
|
## Parameters
|
||||||
|
|
||||||
`val` (in)
|
`val` (in)
|
||||||
@ -103,6 +112,11 @@ interpreted as `object_t::value_type` or `std::initializer_list<basic_json>`, se
|
|||||||
--8<-- "examples/push_back__initializer_list.output"
|
--8<-- "examples/push_back__initializer_list.output"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## See also
|
||||||
|
|
||||||
|
- [emplace_back](emplace_back.md) add a value to an array
|
||||||
|
- [push_back](push_back.md) add a value to an array/object
|
||||||
|
|
||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
1. Since version 1.0.0.
|
1. Since version 1.0.0.
|
||||||
|
|||||||
@ -34,6 +34,15 @@ const_reference operator[](const json_pointer& ptr) const;
|
|||||||
[`string_t`](string_t.md) using [`object_comparator_t`](object_comparator_t.md).
|
[`string_t`](string_t.md) using [`object_comparator_t`](object_comparator_t.md).
|
||||||
This can also be a string view (C++17).
|
This can also be a string view (C++17).
|
||||||
|
|
||||||
|
## Iterator invalidation
|
||||||
|
|
||||||
|
For the non-const versions 1. and 4., when passing an **array** index that does not exist, it is created and filled with
|
||||||
|
a `#!json null` value before a reference to it is returned. For this, a reallocation can happen, in which case all
|
||||||
|
iterators (including the [`end()`](end.md) iterator) and all references to the elements are invalidated.
|
||||||
|
|
||||||
|
For [`ordered_json`](../ordered_json.md), also passing an **object key** to the non-const versions 2., 3., and 4., a
|
||||||
|
reallocation can happen which again invalidates all iterators and all references.
|
||||||
|
|
||||||
## Parameters
|
## Parameters
|
||||||
|
|
||||||
`idx` (in)
|
`idx` (in)
|
||||||
|
|||||||
@ -8,26 +8,36 @@ This exception is thrown in case of errors that cannot be classified with the ot
|
|||||||
|
|
||||||
Exceptions have ids 5xx (see [list of other errors](../../home/exceptions.md#further-exceptions)).
|
Exceptions have ids 5xx (see [list of other errors](../../home/exceptions.md#further-exceptions)).
|
||||||
|
|
||||||
```plantuml
|
```mermaid
|
||||||
std::exception <|-- basic_json::exception
|
classDiagram
|
||||||
basic_json::exception <|-- basic_json::parse_error
|
direction LR
|
||||||
basic_json::exception <|-- basic_json::invalid_iterator
|
|
||||||
basic_json::exception <|-- basic_json::type_error
|
|
||||||
basic_json::exception <|-- basic_json::out_of_range
|
|
||||||
basic_json::exception <|-- basic_json::other_error
|
|
||||||
|
|
||||||
interface std::exception {}
|
class std_exception ["std::exception"] {
|
||||||
|
<<interface>>
|
||||||
|
}
|
||||||
|
|
||||||
class basic_json::exception {
|
class json_exception ["basic_json::exception"] {
|
||||||
+const int id
|
+const int id
|
||||||
+const char* what() const
|
+const char* what() const
|
||||||
}
|
}
|
||||||
|
|
||||||
class basic_json::parse_error {
|
class json_parse_error ["basic_json::parse_error"] {
|
||||||
+const std::size_t byte
|
+const std::size_t byte
|
||||||
}
|
}
|
||||||
|
|
||||||
class basic_json::other_error #FFFF00 {}
|
class json_invalid_iterator ["basic_json::invalid_iterator"]
|
||||||
|
class json_type_error ["basic_json::type_error"]
|
||||||
|
class json_out_of_range ["basic_json::out_of_range"]
|
||||||
|
class json_other_error ["basic_json::other_error"]
|
||||||
|
|
||||||
|
std_exception <|-- json_exception
|
||||||
|
json_exception <|-- json_parse_error
|
||||||
|
json_exception <|-- json_invalid_iterator
|
||||||
|
json_exception <|-- json_type_error
|
||||||
|
json_exception <|-- json_out_of_range
|
||||||
|
json_exception <|-- json_other_error
|
||||||
|
|
||||||
|
style json_other_error fill:#CCCCFF
|
||||||
```
|
```
|
||||||
|
|
||||||
## Member functions
|
## Member functions
|
||||||
|
|||||||
@ -9,26 +9,36 @@ instance in case of array indices or nonexisting object keys.
|
|||||||
|
|
||||||
Exceptions have ids 4xx (see [list of out-of-range errors](../../home/exceptions.md#out-of-range)).
|
Exceptions have ids 4xx (see [list of out-of-range errors](../../home/exceptions.md#out-of-range)).
|
||||||
|
|
||||||
```plantuml
|
```mermaid
|
||||||
std::exception <|-- basic_json::exception
|
classDiagram
|
||||||
basic_json::exception <|-- basic_json::parse_error
|
direction LR
|
||||||
basic_json::exception <|-- basic_json::invalid_iterator
|
|
||||||
basic_json::exception <|-- basic_json::type_error
|
|
||||||
basic_json::exception <|-- basic_json::out_of_range
|
|
||||||
basic_json::exception <|-- basic_json::other_error
|
|
||||||
|
|
||||||
interface std::exception {}
|
class std_exception ["std::exception"] {
|
||||||
|
<<interface>>
|
||||||
|
}
|
||||||
|
|
||||||
class basic_json::exception {
|
class json_exception ["basic_json::exception"] {
|
||||||
+const int id
|
+const int id
|
||||||
+const char* what() const
|
+const char* what() const
|
||||||
}
|
}
|
||||||
|
|
||||||
class basic_json::parse_error {
|
class json_parse_error ["basic_json::parse_error"] {
|
||||||
+const std::size_t byte
|
+const std::size_t byte
|
||||||
}
|
}
|
||||||
|
|
||||||
class basic_json::out_of_range #FFFF00 {}
|
class json_invalid_iterator ["basic_json::invalid_iterator"]
|
||||||
|
class json_type_error ["basic_json::type_error"]
|
||||||
|
class json_out_of_range ["basic_json::out_of_range"]
|
||||||
|
class json_other_error ["basic_json::other_error"]
|
||||||
|
|
||||||
|
std_exception <|-- json_exception
|
||||||
|
json_exception <|-- json_parse_error
|
||||||
|
json_exception <|-- json_invalid_iterator
|
||||||
|
json_exception <|-- json_type_error
|
||||||
|
json_exception <|-- json_out_of_range
|
||||||
|
json_exception <|-- json_other_error
|
||||||
|
|
||||||
|
style json_out_of_range fill:#CCCCFF
|
||||||
```
|
```
|
||||||
|
|
||||||
## Member functions
|
## Member functions
|
||||||
|
|||||||
@ -28,9 +28,9 @@ static basic_json parse(IteratorType first, IteratorType last,
|
|||||||
: A compatible input, for instance:
|
: A compatible input, for instance:
|
||||||
|
|
||||||
- an `std::istream` object
|
- an `std::istream` object
|
||||||
- a `FILE` pointer (must not be null)
|
- a `FILE` pointer (throws if null)
|
||||||
- a C-style array of characters
|
- a C-style array of characters
|
||||||
- a pointer to a null-terminated string of single byte characters
|
- a pointer to a null-terminated string of single byte characters (throws if null)
|
||||||
- a `std::string`
|
- a `std::string`
|
||||||
- an object `obj` for which `begin(obj)` and `end(obj)` produces a valid pair of iterators.
|
- an object `obj` for which `begin(obj)` and `end(obj)` produces a valid pair of iterators.
|
||||||
|
|
||||||
@ -73,10 +73,11 @@ Strong guarantee: if an exception is thrown, there are no changes in the JSON va
|
|||||||
|
|
||||||
## Exceptions
|
## Exceptions
|
||||||
|
|
||||||
- Throws [`parse_error.101`](../../home/exceptions.md#jsonexceptionparse_error101) in case of an unexpected token.
|
- Throws [`parse_error.101`](../../home/exceptions.md#jsonexceptionparse_error101) in case of an unexpected token, or
|
||||||
- Throws [`parse_error.102`](../../home/exceptions.md#jsonexceptionparse_error102) if to_unicode fails or surrogate
|
empty input like a null `FILE*` or `char*` pointer.
|
||||||
|
- Throws [`parse_error.102`](../../home/exceptions.md#jsonexceptionparse_error102) if `to_unicode` fails or surrogate
|
||||||
error.
|
error.
|
||||||
- Throws [`parse_error.103`](../../home/exceptions.md#jsonexceptionparse_error103) if to_unicode fails.
|
- Throws [`parse_error.103`](../../home/exceptions.md#jsonexceptionparse_error103) if `to_unicode` fails.
|
||||||
|
|
||||||
## Complexity
|
## Complexity
|
||||||
|
|
||||||
@ -86,12 +87,7 @@ super-linear complexity.
|
|||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
(1) A UTF-8 byte order mark is silently ignored.
|
A UTF-8 byte order mark is silently ignored.
|
||||||
|
|
||||||
!!! danger "Runtime assertion"
|
|
||||||
|
|
||||||
The precondition that a passed `#!cpp FILE` pointer must not be null is enforced with a
|
|
||||||
[runtime assertion](../../features/assertions.md).
|
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@ -203,6 +199,7 @@ super-linear complexity.
|
|||||||
- Added in version 1.0.0.
|
- Added in version 1.0.0.
|
||||||
- Overload for contiguous containers (1) added in version 2.0.3.
|
- Overload for contiguous containers (1) added in version 2.0.3.
|
||||||
- Ignoring comments via `ignore_comments` added in version 3.9.0.
|
- Ignoring comments via `ignore_comments` added in version 3.9.0.
|
||||||
|
- Changed [runtime assertion](../../features/assertions.md) in case of `FILE*` null pointers to exception in version 3.11.4.
|
||||||
|
|
||||||
!!! warning "Deprecation"
|
!!! warning "Deprecation"
|
||||||
|
|
||||||
|
|||||||
@ -11,24 +11,36 @@ Member `byte` holds the byte index of the last read character in the input file
|
|||||||
|
|
||||||
Exceptions have ids 1xx (see [list of parse errors](../../home/exceptions.md#parse-errors)).
|
Exceptions have ids 1xx (see [list of parse errors](../../home/exceptions.md#parse-errors)).
|
||||||
|
|
||||||
```plantuml
|
```mermaid
|
||||||
std::exception <|-- basic_json::exception
|
classDiagram
|
||||||
basic_json::exception <|-- basic_json::parse_error
|
direction LR
|
||||||
basic_json::exception <|-- basic_json::invalid_iterator
|
|
||||||
basic_json::exception <|-- basic_json::type_error
|
|
||||||
basic_json::exception <|-- basic_json::out_of_range
|
|
||||||
basic_json::exception <|-- basic_json::other_error
|
|
||||||
|
|
||||||
interface std::exception {}
|
class std_exception ["std::exception"] {
|
||||||
|
<<interface>>
|
||||||
|
}
|
||||||
|
|
||||||
class basic_json::exception {
|
class json_exception ["basic_json::exception"] {
|
||||||
+const int id
|
+const int id
|
||||||
+const char* what() const
|
+const char* what() const
|
||||||
}
|
}
|
||||||
|
|
||||||
class basic_json::parse_error #FFFF00 {
|
class json_parse_error ["basic_json::parse_error"] {
|
||||||
+const std::size_t byte
|
+const std::size_t byte
|
||||||
}
|
}
|
||||||
|
|
||||||
|
class json_invalid_iterator ["basic_json::invalid_iterator"]
|
||||||
|
class json_type_error ["basic_json::type_error"]
|
||||||
|
class json_out_of_range ["basic_json::out_of_range"]
|
||||||
|
class json_other_error ["basic_json::other_error"]
|
||||||
|
|
||||||
|
std_exception <|-- json_exception
|
||||||
|
json_exception <|-- json_parse_error
|
||||||
|
json_exception <|-- json_invalid_iterator
|
||||||
|
json_exception <|-- json_type_error
|
||||||
|
json_exception <|-- json_out_of_range
|
||||||
|
json_exception <|-- json_other_error
|
||||||
|
|
||||||
|
style json_parse_error fill:#CCCCFF
|
||||||
```
|
```
|
||||||
|
|
||||||
## Member functions
|
## Member functions
|
||||||
|
|||||||
@ -27,6 +27,15 @@ void push_back(initializer_list_t init);
|
|||||||
`init` is converted into an object element and added using `push_back(const typename object_t::value_type&)`.
|
`init` is converted into an object element and added using `push_back(const typename object_t::value_type&)`.
|
||||||
Otherwise, `init` is converted to a JSON value and added using `push_back(basic_json&&)`.
|
Otherwise, `init` is converted to a JSON value and added using `push_back(basic_json&&)`.
|
||||||
|
|
||||||
|
## Iterator invalidation
|
||||||
|
|
||||||
|
For all cases where an element is added to an **array**, a reallocation can happen, in which case all iterators (including
|
||||||
|
the [`end()`](end.md) iterator) and all references to the elements are invalidated. Otherwise, only the
|
||||||
|
[`end()`](end.md) iterator is invalidated.
|
||||||
|
|
||||||
|
For [`ordered_json`](../ordered_json.md), also adding an element to an **object** can yield a reallocation which again
|
||||||
|
invalidates all iterators and all references.
|
||||||
|
|
||||||
## Parameters
|
## Parameters
|
||||||
|
|
||||||
`val` (in)
|
`val` (in)
|
||||||
@ -99,6 +108,11 @@ All functions can throw the following exception:
|
|||||||
--8<-- "examples/push_back__initializer_list.output"
|
--8<-- "examples/push_back__initializer_list.output"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## See also
|
||||||
|
|
||||||
|
- [emplace_back](emplace_back.md) add a value to an array
|
||||||
|
- [operator+=](operator+=.md) add a value to an array/object
|
||||||
|
|
||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
1. Since version 1.0.0.
|
1. Since version 1.0.0.
|
||||||
|
|||||||
68
docs/mkdocs/docs/api/basic_json/start_pos.md
Normal file
68
docs/mkdocs/docs/api/basic_json/start_pos.md
Normal file
@ -0,0 +1,68 @@
|
|||||||
|
# <small>nlohmann::basic_json::</small>start_pos
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
#if JSON_DIAGNOSTIC_POSITIONS
|
||||||
|
constexpr std::size_t start_pos() const noexcept;
|
||||||
|
#endif
|
||||||
|
```
|
||||||
|
|
||||||
|
Returns the position of the first character in the JSON string from which the value was parsed from.
|
||||||
|
|
||||||
|
| JSON type | return value |
|
||||||
|
|-----------|------------------------------------------------|
|
||||||
|
| object | position of the opening `{` |
|
||||||
|
| array | position of the opening `[` |
|
||||||
|
| string | position of the opening `"` |
|
||||||
|
| number | position of the first character |
|
||||||
|
| boolean | position of `t` for `true` and `f` for `false` |
|
||||||
|
| null | position of `n` |
|
||||||
|
|
||||||
|
## Return value
|
||||||
|
|
||||||
|
the position of the first character of the value in the parsed JSON string, if the value was created by the
|
||||||
|
[`parse`](parse.md) function, or `std::string::npos` if the value was constructed otherwise
|
||||||
|
|
||||||
|
## Exception safety
|
||||||
|
|
||||||
|
No-throw guarantee: this member function never throws exceptions.
|
||||||
|
|
||||||
|
## Complexity
|
||||||
|
|
||||||
|
Constant.
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
!!! note "Note"
|
||||||
|
|
||||||
|
The function is only available if macro [`JSON_DIAGNOSTIC_POSITIONS`](../macros/json_diagnostic_positions.md) has
|
||||||
|
been defined to `#!cpp 1` before including the library header.
|
||||||
|
|
||||||
|
!!! warning "Invalidation"
|
||||||
|
|
||||||
|
The returned positions are only valid as long as the JSON value is not changed. The positions are *not* updated
|
||||||
|
when the JSON value is changed.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
??? example "Example"
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
--8<-- "examples/diagnostic_positions.cpp"
|
||||||
|
```
|
||||||
|
|
||||||
|
Output:
|
||||||
|
|
||||||
|
```
|
||||||
|
--8<-- "examples/diagnostic_positions.output"
|
||||||
|
```
|
||||||
|
|
||||||
|
The output shows the start/end positions of all the objects and fields in the JSON string.
|
||||||
|
|
||||||
|
## See also
|
||||||
|
|
||||||
|
- [end_pos](end_pos.md) to access the end position
|
||||||
|
- [JSON_DIAGNOSTIC_POSITIONS](../macros/json_diagnostic_positions.md) for an overview of the diagnostic positions
|
||||||
|
|
||||||
|
## Version history
|
||||||
|
|
||||||
|
- Added in version 3.12.0.
|
||||||
@ -4,13 +4,16 @@
|
|||||||
// (1)
|
// (1)
|
||||||
static std::vector<std::uint8_t> to_bjdata(const basic_json& j,
|
static std::vector<std::uint8_t> to_bjdata(const basic_json& j,
|
||||||
const bool use_size = false,
|
const bool use_size = false,
|
||||||
const bool use_type = false);
|
const bool use_type = false,
|
||||||
|
const bjdata_version_t version = bjdata_version_t::draft2);
|
||||||
|
|
||||||
// (2)
|
// (2)
|
||||||
static void to_bjdata(const basic_json& j, detail::output_adapter<std::uint8_t> o,
|
static void to_bjdata(const basic_json& j, detail::output_adapter<std::uint8_t> o,
|
||||||
const bool use_size = false, const bool use_type = false);
|
const bool use_size = false, const bool use_type = false,
|
||||||
|
const bjdata_version_t version = bjdata_version_t::draft2);
|
||||||
static void to_bjdata(const basic_json& j, detail::output_adapter<char> o,
|
static void to_bjdata(const basic_json& j, detail::output_adapter<char> o,
|
||||||
const bool use_size = false, const bool use_type = false);
|
const bool use_size = false, const bool use_type = false,
|
||||||
|
const bjdata_version_t version = bjdata_version_t::draft2);
|
||||||
```
|
```
|
||||||
|
|
||||||
Serializes a given JSON value `j` to a byte vector using the BJData (Binary JData) serialization format. BJData aims to
|
Serializes a given JSON value `j` to a byte vector using the BJData (Binary JData) serialization format. BJData aims to
|
||||||
@ -36,6 +39,10 @@ The exact mapping and its limitations is described on a [dedicated page](../../f
|
|||||||
: whether to add type annotations to container types (must be combined with `#!cpp use_size = true`); optional,
|
: whether to add type annotations to container types (must be combined with `#!cpp use_size = true`); optional,
|
||||||
`#!cpp false` by default.
|
`#!cpp false` by default.
|
||||||
|
|
||||||
|
`version` (in)
|
||||||
|
: which version of BJData to use (see note on "Binary values" on [BJData](../../features/binary_formats/bjdata.md));
|
||||||
|
optional, `#!cpp bjdata_version_t::draft2` by default.
|
||||||
|
|
||||||
## Return value
|
## Return value
|
||||||
|
|
||||||
1. BJData serialization as byte vector
|
1. BJData serialization as byte vector
|
||||||
@ -68,3 +75,4 @@ Linear in the size of the JSON value `j`.
|
|||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
- Added in version 3.11.0.
|
- Added in version 3.11.0.
|
||||||
|
- BJData version parameter (for draft3 binary encoding) added in version 3.12.0.
|
||||||
@ -9,26 +9,36 @@ does not match the expected semantics.
|
|||||||
|
|
||||||
Exceptions have ids 3xx (see [list of type errors](../../home/exceptions.md#type-errors)).
|
Exceptions have ids 3xx (see [list of type errors](../../home/exceptions.md#type-errors)).
|
||||||
|
|
||||||
```plantuml
|
```mermaid
|
||||||
std::exception <|-- basic_json::exception
|
classDiagram
|
||||||
basic_json::exception <|-- basic_json::parse_error
|
direction LR
|
||||||
basic_json::exception <|-- basic_json::invalid_iterator
|
|
||||||
basic_json::exception <|-- basic_json::type_error
|
|
||||||
basic_json::exception <|-- basic_json::out_of_range
|
|
||||||
basic_json::exception <|-- basic_json::other_error
|
|
||||||
|
|
||||||
interface std::exception {}
|
class std_exception ["std::exception"] {
|
||||||
|
<<interface>>
|
||||||
|
}
|
||||||
|
|
||||||
class basic_json::exception {
|
class json_exception ["basic_json::exception"] {
|
||||||
+const int id
|
+const int id
|
||||||
+const char* what() const
|
+const char* what() const
|
||||||
}
|
}
|
||||||
|
|
||||||
class basic_json::parse_error {
|
class json_parse_error ["basic_json::parse_error"] {
|
||||||
+const std::size_t byte
|
+const std::size_t byte
|
||||||
}
|
}
|
||||||
|
|
||||||
class basic_json::type_error #FFFF00 {}
|
class json_invalid_iterator ["basic_json::invalid_iterator"]
|
||||||
|
class json_type_error ["basic_json::type_error"]
|
||||||
|
class json_out_of_range ["basic_json::out_of_range"]
|
||||||
|
class json_other_error ["basic_json::other_error"]
|
||||||
|
|
||||||
|
std_exception <|-- json_exception
|
||||||
|
json_exception <|-- json_parse_error
|
||||||
|
json_exception <|-- json_invalid_iterator
|
||||||
|
json_exception <|-- json_type_error
|
||||||
|
json_exception <|-- json_out_of_range
|
||||||
|
json_exception <|-- json_other_error
|
||||||
|
|
||||||
|
style json_type_error fill:#CCCCFF
|
||||||
```
|
```
|
||||||
|
|
||||||
## Member functions
|
## Member functions
|
||||||
|
|||||||
@ -17,6 +17,11 @@ recursively merges objects with common keys.
|
|||||||
The function is motivated by Python's [dict.update](https://docs.python.org/3.6/library/stdtypes.html#dict.update)
|
The function is motivated by Python's [dict.update](https://docs.python.org/3.6/library/stdtypes.html#dict.update)
|
||||||
function.
|
function.
|
||||||
|
|
||||||
|
## Iterator invalidation
|
||||||
|
|
||||||
|
For [`ordered_json`](../ordered_json.md), adding a value to an object can yield a reallocation, in which case all
|
||||||
|
iterators (including the `end()` iterator) and all references to the elements are invalidated.
|
||||||
|
|
||||||
## Parameters
|
## Parameters
|
||||||
|
|
||||||
`j` (in)
|
`j` (in)
|
||||||
|
|||||||
@ -103,6 +103,30 @@ changes to any JSON value.
|
|||||||
2. Logarithmic in the size of the container.
|
2. Logarithmic in the size of the container.
|
||||||
3. Logarithmic in the size of the container.
|
3. Logarithmic in the size of the container.
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
!!! warning "Return type"
|
||||||
|
|
||||||
|
The value function is a template, and the return type of the function is determined by the type of the provided
|
||||||
|
default value unless otherwise specified. This can have unexpected effects. In the example below, we store a 64-bit
|
||||||
|
unsigned integer. We get exactly that value when using [`operator[]`](operator[].md). However, when we call `value`
|
||||||
|
and provide `#!c 0` as default value, then `#!c -1` is returned. The occurs, because `#!c 0` has type `#!c int`
|
||||||
|
which overflows when handling the value `#!c 18446744073709551615`.
|
||||||
|
|
||||||
|
To address this issue, either provide a correctly typed default value or use the template parameter to specify the
|
||||||
|
desired return type. Note that this issue occurs even when a value is stored at the provided key, and the default
|
||||||
|
value is not used as the return value.
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
--8<-- "examples/value__return_type.cpp"
|
||||||
|
```
|
||||||
|
|
||||||
|
Output:
|
||||||
|
|
||||||
|
```json
|
||||||
|
--8<-- "examples/value__return_type.output"
|
||||||
|
```
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
??? example "Example: (1) access specified object element with default value"
|
??? example "Example: (1) access specified object element with default value"
|
||||||
|
|||||||
@ -42,6 +42,10 @@ operator string_t() const
|
|||||||
--8<-- "examples/json_pointer__operator_string_t.output"
|
--8<-- "examples/json_pointer__operator_string_t.output"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## See also
|
||||||
|
|
||||||
|
- [string_t](../basic_json/string_t.md)- type for strings
|
||||||
|
|
||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
- Since version 2.0.0.
|
- Since version 2.0.0.
|
||||||
|
|||||||
@ -11,6 +11,7 @@ header. See also the [macro overview page](../../features/macros.md).
|
|||||||
|
|
||||||
- [**JSON_CATCH_USER(exception)**<br>**JSON_THROW_USER(exception)**<br>**JSON_TRY_USER**](json_throw_user.md) - control exceptions
|
- [**JSON_CATCH_USER(exception)**<br>**JSON_THROW_USER(exception)**<br>**JSON_TRY_USER**](json_throw_user.md) - control exceptions
|
||||||
- [**JSON_DIAGNOSTICS**](json_diagnostics.md) - control extended diagnostics
|
- [**JSON_DIAGNOSTICS**](json_diagnostics.md) - control extended diagnostics
|
||||||
|
- [**JSON_DIAGNOSTIC_POSITIONS**](json_diagnostic_positions.md) - access positions of elements
|
||||||
- [**JSON_NOEXCEPTION**](json_noexception.md) - switch off exceptions
|
- [**JSON_NOEXCEPTION**](json_noexception.md) - switch off exceptions
|
||||||
|
|
||||||
## Language support
|
## Language support
|
||||||
@ -42,7 +43,6 @@ header. See also the [macro overview page](../../features/macros.md).
|
|||||||
- [**JSON_DISABLE_ENUM_SERIALIZATION**](json_disable_enum_serialization.md) - switch off default serialization/deserialization functions for enums
|
- [**JSON_DISABLE_ENUM_SERIALIZATION**](json_disable_enum_serialization.md) - switch off default serialization/deserialization functions for enums
|
||||||
- [**JSON_USE_IMPLICIT_CONVERSIONS**](json_use_implicit_conversions.md) - control implicit conversions
|
- [**JSON_USE_IMPLICIT_CONVERSIONS**](json_use_implicit_conversions.md) - control implicit conversions
|
||||||
|
|
||||||
<!-- comment-->
|
|
||||||
## Comparison behavior
|
## Comparison behavior
|
||||||
|
|
||||||
- [**JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON**](json_use_legacy_discarded_value_comparison.md) -
|
- [**JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON**](json_use_legacy_discarded_value_comparison.md) -
|
||||||
@ -50,13 +50,34 @@ header. See also the [macro overview page](../../features/macros.md).
|
|||||||
|
|
||||||
## Serialization/deserialization macros
|
## Serialization/deserialization macros
|
||||||
|
|
||||||
- [**NLOHMANN_DEFINE_TYPE_INTRUSIVE(type, member...)**<br>**NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_DEFAULT(type, member...)**
|
### Enums
|
||||||
<br>**NLOHMANN_DEFINE_TYPE_INTRUSIVE_ONLY_SERIALIZE(type, member...)**][DefInt]
|
|
||||||
\- serialization/deserialization of types _with_ access to private variables
|
|
||||||
- [**NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE(type, member...)**<br>**NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT(type, member...)**
|
|
||||||
<br>**NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_ONLY_SERIALIZE(type, member...)**][DefNonInt]
|
|
||||||
\- serialization/deserialization of types _without_ access to private variables
|
|
||||||
- [**NLOHMANN_JSON_SERIALIZE_ENUM(type, ...)**](nlohmann_json_serialize_enum.md) - serialization/deserialization of enum types
|
|
||||||
|
|
||||||
[DefInt]: nlohmann_define_type_intrusive.md
|
- [**NLOHMANN_JSON_SERIALIZE_ENUM**](nlohmann_json_serialize_enum.md) - serialize/deserialize an enum
|
||||||
[DefNonInt]: nlohmann_define_type_non_intrusive.md
|
|
||||||
|
### Classes and structs
|
||||||
|
|
||||||
|
- [**NLOHMANN_DEFINE_TYPE_INTRUSIVE**](nlohmann_define_type_intrusive.md) - serialize/deserialize a non-derived class
|
||||||
|
with private members
|
||||||
|
- [**NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_DEFAULT**](nlohmann_define_type_intrusive.md) - serialize/deserialize a
|
||||||
|
non-derived class with private members; uses default values
|
||||||
|
- [**NLOHMANN_DEFINE_TYPE_INTRUSIVE_ONLY_SERIALIZE**](nlohmann_define_type_intrusive.md) - serialize a non-derived class
|
||||||
|
with private members
|
||||||
|
- [**NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE**](nlohmann_define_type_non_intrusive.md) - serialize/deserialize a non-derived
|
||||||
|
class
|
||||||
|
- [**NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT**](nlohmann_define_type_non_intrusive.md) - serialize/deserialize a
|
||||||
|
non-derived class; uses default values
|
||||||
|
- [**NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_ONLY_SERIALIZE**](nlohmann_define_type_non_intrusive.md) - serialize a
|
||||||
|
non-derived class
|
||||||
|
|
||||||
|
- [**NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE**](nlohmann_define_derived_type.md) - serialize/deserialize a derived class
|
||||||
|
with private members
|
||||||
|
- [**NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_WITH_DEFAULT**](nlohmann_define_derived_type.md) - serialize/deserialize a
|
||||||
|
derived class with private members; uses default values
|
||||||
|
- [**NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_ONLY_SERIALIZE**](nlohmann_define_derived_type.md) - serialize a derived
|
||||||
|
class with private members
|
||||||
|
- [**NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE**](nlohmann_define_derived_type.md) - serialize/deserialize a derived
|
||||||
|
class
|
||||||
|
- [**NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_WITH_DEFAULT**](nlohmann_define_derived_type.md) - serialize/deserialize
|
||||||
|
a derived class; uses default values
|
||||||
|
- [**NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_ONLY_SERIALIZE**](nlohmann_define_derived_type.md) - serialize a derived
|
||||||
|
class
|
||||||
|
|||||||
@ -79,6 +79,10 @@ Therefore, assertions can be switched off by defining `NDEBUG`.
|
|||||||
assertion error in operator[]
|
assertion error in operator[]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## See also
|
||||||
|
|
||||||
|
- [Runtime Assertions](../../features/assertions.md) - overview documentation
|
||||||
|
|
||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
- Added in version 3.9.0.
|
- Added in version 3.9.0.
|
||||||
|
|||||||
119
docs/mkdocs/docs/api/macros/json_diagnostic_positions.md
Normal file
119
docs/mkdocs/docs/api/macros/json_diagnostic_positions.md
Normal file
@ -0,0 +1,119 @@
|
|||||||
|
# JSON_DIAGNOSTIC_POSITIONS
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
#define JSON_DIAGNOSTIC_POSITIONS /* value */
|
||||||
|
```
|
||||||
|
|
||||||
|
This macro enables position diagnostics for generated JSON objects.
|
||||||
|
|
||||||
|
When enabled, two new member functions [`start_pos()`](../basic_json/start_pos.md) and
|
||||||
|
[`end_pos()`](../basic_json/end_pos.md) are added to [`basic_json`](../basic_json/index.md) values. If the value was
|
||||||
|
created by calling the[`parse`](../basic_json/parse.md) function, then these functions allow to query the byte positions
|
||||||
|
of the value in the input it was parsed from. In case the value was constructed by other means, `std::string::npos` is
|
||||||
|
returned.
|
||||||
|
|
||||||
|
[`start_pos()`](../basic_json/start_pos.md) returns the position of the first character of a given value in the original
|
||||||
|
JSON string, while [`end_pos()`](../basic_json/end_pos.md) returns the position of the character _following_ the last
|
||||||
|
character. For objects and arrays, the first and last characters correspond to the opening or closing braces/brackets,
|
||||||
|
respectively. For primitive values, the first and last character represent the opening and closing quotes (strings) or
|
||||||
|
the first and last character of the field's numerical or predefined value (`true`, `false`, `null`), respectively.
|
||||||
|
|
||||||
|
| JSON type | return value [`start_pos()`](../basic_json/start_pos.md) | return value [`end_pos()`](../basic_json/end_pos.md) |
|
||||||
|
|-----------|----------------------------------------------------------|------------------------------------------------------|
|
||||||
|
| object | position of the opening `{` | position after the closing `}` |
|
||||||
|
| array | position of the opening `[` | position after the closing `]` |
|
||||||
|
| string | position of the opening `"` | position after the closing `"` |
|
||||||
|
| number | position of the first character | position after the last character |
|
||||||
|
| boolean | position of `t` for `true` and `f` for `false` | position after `e` |
|
||||||
|
| null | position of `n` | position after `l` |
|
||||||
|
|
||||||
|
Given the above, [`end_pos()`](../basic_json/end_pos.md)` - `[`start_pos()`](../basic_json/start_pos.md) for a JSON
|
||||||
|
value provides the length of the parsed JSON string for that value, including the opening or closing braces, brackets,
|
||||||
|
or quotes.
|
||||||
|
|
||||||
|
Note that enabling this macro increases the size of every JSON value by two `std::size_t` fields and adds slight runtime
|
||||||
|
overhead to parsing, copying JSON value objects, and the generation of error messages for exceptions. It also causes
|
||||||
|
these values to be reported in those error messages.
|
||||||
|
|
||||||
|
## Default definition
|
||||||
|
|
||||||
|
The default value is `0` (position diagnostics are switched off).
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
#define JSON_DIAGNOSTIC_POSITIONS 0
|
||||||
|
```
|
||||||
|
|
||||||
|
When the macro is not defined, the library will define it to its default value.
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
!!! note "CMake option"
|
||||||
|
|
||||||
|
Diagnostic positions can also be controlled with the CMake option
|
||||||
|
[`JSON_Diagnostic_Positions`](../../integration/cmake.md#json_diagnostic_positions) (`OFF` by default)
|
||||||
|
which defines `JSON_DIAGNOSTIC_POSITIONS` accordingly.
|
||||||
|
|
||||||
|
!!! note "Availability"
|
||||||
|
|
||||||
|
Diagnostic positions are only available if the value was created by the [`parse`](../basic_json/parse.md) function.
|
||||||
|
The [`sax_parse`](../basic_json/sax_parse.md) function or all other means to create a JSON value **do not** set the
|
||||||
|
diagnostic positions and [`start_pos()`](../basic_json/start_pos.md) and [`end_pos()`](../basic_json/end_pos.md)
|
||||||
|
will only return `std::string::npos` for these values.
|
||||||
|
|
||||||
|
!!! warning "Invalidation"
|
||||||
|
|
||||||
|
The returned positions are only valid as long as the JSON value is not changed. The positions are *not* updated
|
||||||
|
when the JSON value is changed.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
??? example "Example: retrieving positions"
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
--8<-- "examples/diagnostic_positions.cpp"
|
||||||
|
```
|
||||||
|
|
||||||
|
Output:
|
||||||
|
|
||||||
|
```
|
||||||
|
--8<-- "examples/diagnostic_positions.output"
|
||||||
|
```
|
||||||
|
|
||||||
|
The output shows the start/end positions of all the objects and fields in the JSON string.
|
||||||
|
|
||||||
|
??? example "Example 2: using only diagnostic positions in exceptions"
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
--8<-- "examples/diagnostic_positions_exception.cpp"
|
||||||
|
```
|
||||||
|
|
||||||
|
Output:
|
||||||
|
|
||||||
|
```
|
||||||
|
--8<-- "examples/diagnostic_positions_exception.output"
|
||||||
|
```
|
||||||
|
|
||||||
|
The output shows the exception with start/end positions only.
|
||||||
|
|
||||||
|
??? example "Example 3: using extended diagnostics with positions enabled in exceptions"
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
--8<-- "examples/diagnostics_extended_positions.cpp"
|
||||||
|
```
|
||||||
|
|
||||||
|
Output:
|
||||||
|
|
||||||
|
```
|
||||||
|
--8<-- "examples/diagnostics_extended_positions.output"
|
||||||
|
```
|
||||||
|
|
||||||
|
The output shows the exception with diagnostic path info and start/end positions.
|
||||||
|
|
||||||
|
## See also
|
||||||
|
|
||||||
|
- [:simple-cmake: JSON_Diagnostic_Positions](../../integration/cmake.md#json_diagnostic_positions) - CMake option to control the macro
|
||||||
|
- [JSON_DIAGNOSTICS](json_diagnostics.md) - macro to control extended diagnostics
|
||||||
|
|
||||||
|
## Version history
|
||||||
|
|
||||||
|
- Added in version 3.12.0.
|
||||||
@ -70,6 +70,24 @@ When the macro is not defined, the library will define it to its default value.
|
|||||||
|
|
||||||
Now the exception message contains a JSON Pointer `/address/housenumber` that indicates which value has the wrong type.
|
Now the exception message contains a JSON Pointer `/address/housenumber` that indicates which value has the wrong type.
|
||||||
|
|
||||||
|
??? example "Example 3: using only diagnostic positions in exceptions"
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
--8<-- "examples/diagnostic_positions_exception.cpp"
|
||||||
|
```
|
||||||
|
|
||||||
|
Output:
|
||||||
|
|
||||||
|
```
|
||||||
|
--8<-- "examples/diagnostic_positions_exception.output"
|
||||||
|
```
|
||||||
|
The output shows the exception with start/end positions only.
|
||||||
|
|
||||||
|
## See also
|
||||||
|
|
||||||
|
- [:simple-cmake: JSON_Diagnostics](../../integration/cmake.md#json_diagnostics) - CMake option to control the macro
|
||||||
|
- [JSON_DIAGNOSTIC_POSITIONS](json_diagnostic_positions.md) - macro to access positions of elements
|
||||||
|
|
||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
- Added in version 3.10.0.
|
- Added in version 3.10.0.
|
||||||
|
|||||||
@ -145,7 +145,9 @@ The default value is `0`.
|
|||||||
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [`NLOHMANN_JSON_SERIALIZE_ENUM`](nlohmann_json_serialize_enum.md)
|
- [:simple-cmake: JSON_DisableEnumSerialization](../../integration/cmake.md#json_disableenumserialization) - CMake option to control
|
||||||
|
the macro
|
||||||
|
- [`NLOHMANN_JSON_SERIALIZE_ENUM`](nlohmann_json_serialize_enum.md) - serialize/deserialize an enum
|
||||||
|
|
||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
|
|||||||
@ -92,6 +92,7 @@ When the macro is not defined, the library will define it to its default value.
|
|||||||
|
|
||||||
- [`operator""_json`](../operator_literal_json.md)
|
- [`operator""_json`](../operator_literal_json.md)
|
||||||
- [`operator""_json_pointer`](../operator_literal_json_pointer.md)
|
- [`operator""_json_pointer`](../operator_literal_json_pointer.md)
|
||||||
|
- [:simple-cmake: JSON_GlobalUDLs](../../integration/cmake.md#json_globaludls) - CMake option to control the macro
|
||||||
|
|
||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
|
|||||||
@ -27,7 +27,7 @@ By default, implicit conversions are enabled.
|
|||||||
!!! hint "CMake option"
|
!!! hint "CMake option"
|
||||||
|
|
||||||
Implicit conversions can also be controlled with the CMake option
|
Implicit conversions can also be controlled with the CMake option
|
||||||
[`JSON_ImplicitConversions`](../../integration/cmake.md#json_legacydiscardedvaluecomparison)
|
[`JSON_ImplicitConversions`](../../integration/cmake.md#json_implicitconversions)
|
||||||
(`ON` by default) which defines `JSON_USE_IMPLICIT_CONVERSIONS` accordingly.
|
(`ON` by default) which defines `JSON_USE_IMPLICIT_CONVERSIONS` accordingly.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
@ -53,6 +53,7 @@ By default, implicit conversions are enabled.
|
|||||||
|
|
||||||
- [**operator ValueType**](../basic_json/operator_ValueType.md) - get a value (implicit)
|
- [**operator ValueType**](../basic_json/operator_ValueType.md) - get a value (implicit)
|
||||||
- [**get**](../basic_json/get.md) - get a value (explicit)
|
- [**get**](../basic_json/get.md) - get a value (explicit)
|
||||||
|
- [:simple-cmake: JSON_ImplicitConversions](../../integration/cmake.md#json_implicitconversions) - CMake option to control the macro
|
||||||
|
|
||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
|
|||||||
@ -56,7 +56,7 @@ When the macro is not defined, the library will define it to its default value.
|
|||||||
!!! hint "CMake option"
|
!!! hint "CMake option"
|
||||||
|
|
||||||
Legacy comparison can also be controlled with the CMake option
|
Legacy comparison can also be controlled with the CMake option
|
||||||
[`JSON_LegacyDiscardedValueComparison`](../../integration/cmake.md#json_legacydiscardedvaluecomparison)
|
[`JSON_LegacyDiscardedValueComparison`](../../integration/cmake.md#json_implicitconversions)
|
||||||
(`OFF` by default) which defines `JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON` accordingly.
|
(`OFF` by default) which defines `JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON` accordingly.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
@ -72,6 +72,10 @@ When the macro is not defined, the library will define it to its default value.
|
|||||||
...
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### See also
|
||||||
|
|
||||||
|
- [:simple-cmake: JSON_LegacyDiscardedValueComparison](../../integration/cmake.md#json_legacydiscardedvaluecomparison) - CMake option to control the macro
|
||||||
|
|
||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
- Added in version 3.11.0.
|
- Added in version 3.11.0.
|
||||||
|
|||||||
@ -1,35 +1,53 @@
|
|||||||
# NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE, NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_WITH_DEFAULT
|
<h1>NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE, NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_WITH_DEFAULT,
|
||||||
|
NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_ONLY_SERIALIZE, NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE,
|
||||||
# NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE, NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_WITH_DEFAULT
|
NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_WITH_DEFAULT, NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_ONLY_SERIALIZE</h1>
|
||||||
|
|
||||||
```cpp
|
```cpp
|
||||||
#define NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE(type, base_type, member...) // (1)
|
// (1)
|
||||||
#define NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_WITH_DEFAULT(type, base_type, member...) // (2)
|
#define NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE(type, base_type, member...)
|
||||||
|
// (2)
|
||||||
|
#define NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_WITH_DEFAULT(type, base_type, member...)
|
||||||
|
// (3)
|
||||||
|
#define NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_ONLY_SERIALIZE(type, base_type, member...)
|
||||||
|
|
||||||
#define NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE(type, base_type, member...) // (3)
|
// (4)
|
||||||
#define NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_WITH_DEFAULT(type, base_type, member...) // (4)
|
#define NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE(type, base_type, member...)
|
||||||
|
// (5)
|
||||||
|
#define NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_WITH_DEFAULT(type, base_type, member...)
|
||||||
|
// (6)
|
||||||
|
#define NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_ONLY_SERIALIZE(type, base_type, member...)
|
||||||
```
|
```
|
||||||
|
|
||||||
These macros can be used to simplify the serialization/deserialization of derived types if you want to use a JSON
|
These macros can be used to simplify the serialization/deserialization of derived types if you want to use a JSON
|
||||||
object as serialization and want to use the member variable names as object keys in that object.
|
object as serialization and want to use the member variable names as object keys in that object.
|
||||||
|
|
||||||
- Macros 1 and 2 are to be defined **inside** the class/struct to create code for.
|
- Macros 1, 2 and 3 are to be defined **inside** the class/struct to create code for.
|
||||||
Like [`NLOHMANN_DEFINE_TYPE_INTRUSIVE`](nlohmann_define_type_intrusive.md), they can access private members.
|
Like [`NLOHMANN_DEFINE_TYPE_INTRUSIVE`](nlohmann_define_type_intrusive.md), they can access private members.
|
||||||
- Macros 3 and 4 are to be defined **outside** the class/struct to create code for, but **inside** its namespace.
|
- Macros 4, 5 and 6 are to be defined **outside** the class/struct to create code for, but **inside** its namespace.
|
||||||
Like [`NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE`](nlohmann_define_type_non_intrusive.md),
|
Like [`NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE`](nlohmann_define_type_non_intrusive.md),
|
||||||
they **cannot** access private members.
|
they **cannot** access private members.
|
||||||
|
|
||||||
|
|
||||||
The first parameter is the name of the derived class/struct,
|
The first parameter is the name of the derived class/struct,
|
||||||
the second parameter is the name of the base class/struct and all remaining parameters name the members.
|
the second parameter is the name of the base class/struct and all remaining parameters name the members.
|
||||||
The base type **must** be already serializable/deserializable.
|
The base type **must** be already serializable/deserializable.
|
||||||
|
|
||||||
- Macros 1 and 3 will use [`at`](../basic_json/at.md) during deserialization and will throw
|
- Macros 1 and 4 will use [`at`](../basic_json/at.md) during deserialization and will throw
|
||||||
[`out_of_range.403`](../../home/exceptions.md#jsonexceptionout_of_range403) if a key is missing in the JSON object.
|
[`out_of_range.403`](../../home/exceptions.md#jsonexceptionout_of_range403) if a key is missing in the JSON object.
|
||||||
- Macros 2 and 4 will use [`value`](../basic_json/value.md) during deserialization and fall back to the default value for the
|
- Macros 2 and 5 will use [`value`](../basic_json/value.md) during deserialization and fall back to the default value for the
|
||||||
respective type of the member variable if a key in the JSON object is missing. The generated `from_json()` function
|
respective type of the member variable if a key in the JSON object is missing. The generated `from_json()` function
|
||||||
default constructs an object and uses its values as the defaults when calling the `value` function.
|
default constructs an object and uses its values as the defaults when calling the `value` function.
|
||||||
|
|
||||||
|
Summary:
|
||||||
|
|
||||||
|
| Need access to private members | Need only de-serialization | Allow missing values when de-serializing | macro |
|
||||||
|
|------------------------------------------------------------------|------------------------------------------------------------------|------------------------------------------------------------------|---------------------------------------------------------------|
|
||||||
|
| <div style="color: green;">:octicons-check-circle-fill-24:</div> | <div style="color: red;">:octicons-x-circle-fill-24:</div> | <div style="color: red;">:octicons-x-circle-fill-24:</div> | **NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE** |
|
||||||
|
| <div style="color: green;">:octicons-check-circle-fill-24:</div> | <div style="color: red;">:octicons-x-circle-fill-24:</div> | <div style="color: green;">:octicons-check-circle-fill-24:</div> | **NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_WITH_DEFAULT** |
|
||||||
|
| <div style="color: green;">:octicons-check-circle-fill-24:</div> | <div style="color: green;">:octicons-check-circle-fill-24:</div> | <div style="color: grey;">:octicons-skip-fill-24:</div> | **NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_ONLY_SERIALIZE** |
|
||||||
|
| <div style="color: red;">:octicons-x-circle-fill-24:</div> | <div style="color: red;">:octicons-x-circle-fill-24:</div> | <div style="color: red;">:octicons-x-circle-fill-24:</div> | **NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE** |
|
||||||
|
| <div style="color: red;">:octicons-x-circle-fill-24:</div> | <div style="color: red;">:octicons-x-circle-fill-24:</div> | <div style="color: green;">:octicons-check-circle-fill-24:</div> | **NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_WITH_DEFAULT** |
|
||||||
|
| <div style="color: red;">:octicons-x-circle-fill-24:</div> | <div style="color: green;">:octicons-check-circle-fill-24:</div> | <div style="color: grey;">:octicons-skip-fill-24:</div> | **NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_ONLY_SERIALIZE** |
|
||||||
|
|
||||||
## Parameters
|
## Parameters
|
||||||
|
|
||||||
`type` (in)
|
`type` (in)
|
||||||
@ -46,73 +64,114 @@ The base type **must** be already serializable/deserializable.
|
|||||||
Macros 1 and 2 add two friend functions to the class which take care of the serialization and deserialization:
|
Macros 1 and 2 add two friend functions to the class which take care of the serialization and deserialization:
|
||||||
|
|
||||||
```cpp
|
```cpp
|
||||||
friend void to_json(nlohmann::json&, const type&);
|
template<typename BasicJsonType>
|
||||||
friend void from_json(const nlohmann::json&, type&);
|
friend void to_json(BasicJsonType&, const type&);
|
||||||
|
template<typename BasicJsonType>
|
||||||
|
friend void from_json(const BasicJsonType&, type&);
|
||||||
```
|
```
|
||||||
|
|
||||||
Macros 3 and 4 add two functions to the namespace which take care of the serialization and deserialization:
|
Macros 4 and 5 add two functions to the namespace which take care of the serialization and deserialization:
|
||||||
|
|
||||||
```cpp
|
```cpp
|
||||||
void to_json(nlohmann::json&, const type&);
|
template<typename BasicJsonType>
|
||||||
void from_json(const nlohmann::json&, type&);
|
void to_json(BasicJsonType&, const type&);
|
||||||
|
template<typename BasicJsonType>
|
||||||
|
void from_json(const BasicJsonType&, type&);
|
||||||
```
|
```
|
||||||
|
|
||||||
In both cases they call the `to_json`/`from_json` functions of the base type
|
Macros 3 and 6 add one function to the namespace which take care of the serialization only:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
template<typename BasicJsonType>
|
||||||
|
void to_json(BasicJsonType&, const type&);
|
||||||
|
```
|
||||||
|
|
||||||
|
In first two cases, they call the `to_json`/`from_json` functions of the base type
|
||||||
before serializing/deserializing the members of the derived type:
|
before serializing/deserializing the members of the derived type:
|
||||||
|
|
||||||
```cpp
|
```cpp
|
||||||
class A { /* ... */ };
|
class A { /* ... */ };
|
||||||
class B : public A { /* ... */ };
|
class B : public A { /* ... */ };
|
||||||
|
|
||||||
void to_json(nlohmann::json& j, const B& b) {
|
template<typename BasicJsonType>
|
||||||
|
void to_json(BasicJsonType& j, const B& b) {
|
||||||
nlohmann::to_json(j, static_cast<const A&>(b));
|
nlohmann::to_json(j, static_cast<const A&>(b));
|
||||||
// ...
|
// ...
|
||||||
}
|
}
|
||||||
|
|
||||||
void from_json(const nlohmann::json& j, B& b) {
|
template<typename BasicJsonType>
|
||||||
|
void from_json(const BasicJsonType& j, B& b) {
|
||||||
nlohmann::from_json(j, static_cast<A&>(b));
|
nlohmann::from_json(j, static_cast<A&>(b));
|
||||||
// ...
|
// ...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
In the third case, only `to_json` will be called:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
class A { /* ... */ };
|
||||||
|
class B : public A { /* ... */ };
|
||||||
|
|
||||||
|
template<typename BasicJsonType>
|
||||||
|
void to_json(BasicJsonType& j, const B& b) {
|
||||||
|
nlohmann::to_json(j, static_cast<const A&>(b));
|
||||||
|
// ...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
!!! info "Prerequisites"
|
!!! info "Prerequisites"
|
||||||
|
|
||||||
- Macros 1 and 2 have the same prerequisites of NLOHMANN_DEFINE_TYPE_INTRUSIVE.
|
- Macros 1, 2, and 3 have the same prerequisites of [NLOHMANN_DEFINE_TYPE_INTRUSIVE](nlohmann_define_type_intrusive.md).
|
||||||
- Macros 3 and 3 have the same prerequisites of NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE.
|
- Macros 4, 5, and 6 have the same prerequisites of [NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE](nlohmann_define_type_non_intrusive.md).
|
||||||
- Serialization/deserialization of base types must be defined.
|
- Serialization/deserialization of base types must be defined.
|
||||||
|
|
||||||
!!! warning "Implementation limits"
|
!!! warning "Implementation limits"
|
||||||
|
|
||||||
- See Implementation limits for NLOHMANN_DEFINE_TYPE_INTRUSIVE and NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE.
|
See Implementation limits for [NLOHMANN_DEFINE_TYPE_INTRUSIVE](nlohmann_define_type_intrusive.md) and
|
||||||
|
[NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE](nlohmann_define_type_non_intrusive.md), respectively.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
Example of `NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE` usage:
|
??? example "NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE"
|
||||||
|
|
||||||
```cpp
|
Consider the following complete example:
|
||||||
class A {
|
|
||||||
double Aa;
|
|
||||||
double Ab;
|
|
||||||
NLOHMANN_DEFINE_TYPE_INTRUSIVE(A, Aa, Ab)
|
|
||||||
};
|
|
||||||
|
|
||||||
class B : public A {
|
```cpp hl_lines="28"
|
||||||
int Ba;
|
--8<-- "examples/nlohmann_define_derived_type_intrusive_macro.cpp"
|
||||||
int Bb;
|
|
||||||
NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE(B, A, Ba, Bb)
|
|
||||||
};
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Output:
|
||||||
|
|
||||||
|
```json
|
||||||
|
--8<-- "examples/nlohmann_define_derived_type_intrusive_macro.output"
|
||||||
|
```
|
||||||
|
|
||||||
|
Notes:
|
||||||
|
|
||||||
|
- `A` and `B` are default-constructible. This is a requirement for using the macro.
|
||||||
|
- `A` has private members and is not a derived class. Hence, macro `NLOHMANN_DEFINE_TYPE_INTRUSIVE` is used.
|
||||||
|
- As `B` is a derived class, `NLOHMANN_DEFINE_TYPE_INTRUSIVE` is not applicable, but
|
||||||
|
`NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE` must be used.
|
||||||
|
- The macro `NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE` is used _inside_ the class use as
|
||||||
|
`NLOHMANN_DEFINE_TYPE_INTRUSIVE`.
|
||||||
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [NLOHMANN_DEFINE_TYPE_INTRUSIVE / NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_DEFAULT](nlohmann_define_type_intrusive.md)
|
- [NLOHMANN_DEFINE_TYPE_INTRUSIVE / NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_DEFAULT /
|
||||||
|
NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_ONLY_SERIALIZE](nlohmann_define_type_intrusive.md)
|
||||||
for similar macros that can be defined _inside_ a non-derived type.
|
for similar macros that can be defined _inside_ a non-derived type.
|
||||||
- [NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE / NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT](nlohmann_define_type_non_intrusive.md)
|
- [NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE / NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT /
|
||||||
for a similar macros that can be defined _outside_ a non-derived type.
|
NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_ONLY_SERIALIZE](nlohmann_define_type_non_intrusive.md)
|
||||||
|
for similar macros that can be defined _outside_ a non-derived type.
|
||||||
- [Arbitrary Type Conversions](../../features/arbitrary_types.md) for an overview.
|
- [Arbitrary Type Conversions](../../features/arbitrary_types.md) for an overview.
|
||||||
|
|
||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
1. Added in version 3.11.x.
|
1. Added in version 3.11.x.
|
||||||
|
2. Added in version 3.11.x.
|
||||||
|
3. Added in version 3.11.x.
|
||||||
|
4. Added in version 3.11.x.
|
||||||
|
5. Added in version 3.11.x.
|
||||||
|
6. Added in version 3.11.x.
|
||||||
|
|||||||
@ -19,6 +19,14 @@ parameter is the name of the class/struct, and all remaining parameters name the
|
|||||||
default constructs an object and uses its values as the defaults when calling the `value` function.
|
default constructs an object and uses its values as the defaults when calling the `value` function.
|
||||||
3. Only defines the serialization. Useful in cases when the type does not have a default constructor and only serialization in required.
|
3. Only defines the serialization. Useful in cases when the type does not have a default constructor and only serialization in required.
|
||||||
|
|
||||||
|
Summary:
|
||||||
|
|
||||||
|
| Need access to private members | Need only de-serialization | Allow missing values when de-serializing | macro |
|
||||||
|
|------------------------------------------------------------------|------------------------------------------------------------------|------------------------------------------------------------------|-------------------------------------------------------|
|
||||||
|
| <div style="color: green;">:octicons-check-circle-fill-24:</div> | <div style="color: red;">:octicons-x-circle-fill-24:</div> | <div style="color: red;">:octicons-x-circle-fill-24:</div> | **NLOHMANN_DEFINE_TYPE_INTRUSIVE** |
|
||||||
|
| <div style="color: green;">:octicons-check-circle-fill-24:</div> | <div style="color: red;">:octicons-x-circle-fill-24:</div> | <div style="color: green;">:octicons-check-circle-fill-24:</div> | **NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_DEFAULT** |
|
||||||
|
| <div style="color: green;">:octicons-check-circle-fill-24:</div> | <div style="color: green;">:octicons-check-circle-fill-24:</div> | <div style="color: grey;">:octicons-skip-fill-24:</div> | **NLOHMANN_DEFINE_TYPE_INTRUSIVE_ONLY_SERIALIZE** |
|
||||||
|
|
||||||
## Parameters
|
## Parameters
|
||||||
|
|
||||||
`type` (in)
|
`type` (in)
|
||||||
@ -32,8 +40,10 @@ parameter is the name of the class/struct, and all remaining parameters name the
|
|||||||
The macros add two friend functions to the class which take care of the serialization and deserialization:
|
The macros add two friend functions to the class which take care of the serialization and deserialization:
|
||||||
|
|
||||||
```cpp
|
```cpp
|
||||||
friend void to_json(nlohmann::json&, const type&);
|
template<typename BasicJsonType>
|
||||||
friend void from_json(const nlohmann::json&, type&); // except (3)
|
friend void to_json(BasicJsonType&, const type&);
|
||||||
|
template<typename BasicJsonType>
|
||||||
|
friend void from_json(const BasicJsonType&, type&); // except (3)
|
||||||
```
|
```
|
||||||
|
|
||||||
See examples below for the concrete generated code.
|
See examples below for the concrete generated code.
|
||||||
@ -52,8 +62,6 @@ See examples below for the concrete generated code.
|
|||||||
|
|
||||||
- The current implementation is limited to at most 64 member variables. If you want to serialize/deserialize types
|
- The current implementation is limited to at most 64 member variables. If you want to serialize/deserialize types
|
||||||
with more than 64 member variables, you need to define the `to_json`/`from_json` functions manually.
|
with more than 64 member variables, you need to define the `to_json`/`from_json` functions manually.
|
||||||
- The macros only work for the [`nlohmann::json`](../json.md) type; other specializations such as
|
|
||||||
[`nlohmann::ordered_json`](../ordered_json.md) are currently unsupported.
|
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@ -82,7 +90,7 @@ See examples below for the concrete generated code.
|
|||||||
|
|
||||||
The macro is equivalent to:
|
The macro is equivalent to:
|
||||||
|
|
||||||
```cpp hl_lines="22 23 24 25 26 27 28 29 30 31 32 33 34"
|
```cpp hl_lines="22 23 24 25 26 27 28 29 30 31 32 33 34 35 36"
|
||||||
--8<-- "examples/nlohmann_define_type_intrusive_explicit.cpp"
|
--8<-- "examples/nlohmann_define_type_intrusive_explicit.cpp"
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -110,7 +118,7 @@ See examples below for the concrete generated code.
|
|||||||
|
|
||||||
The macro is equivalent to:
|
The macro is equivalent to:
|
||||||
|
|
||||||
```cpp hl_lines="22 23 24 25 26 27 28 29 30 31 32 33 34 35"
|
```cpp hl_lines="22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37"
|
||||||
--8<-- "examples/nlohmann_define_type_intrusive_with_default_explicit.cpp"
|
--8<-- "examples/nlohmann_define_type_intrusive_with_default_explicit.cpp"
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -139,18 +147,24 @@ See examples below for the concrete generated code.
|
|||||||
|
|
||||||
The macro is equivalent to:
|
The macro is equivalent to:
|
||||||
|
|
||||||
```cpp hl_lines="22 22 23 24 25 26 27"
|
```cpp hl_lines="22 22 23 24 25 26 27 28"
|
||||||
--8<-- "examples/nlohmann_define_type_intrusive_only_serialize_explicit.cpp"
|
--8<-- "examples/nlohmann_define_type_intrusive_only_serialize_explicit.cpp"
|
||||||
```
|
```
|
||||||
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE{_WITH_DEFAULT, _ONLY_SERIALIZE}](nlohmann_define_type_non_intrusive.md)
|
- [NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE, NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT,
|
||||||
|
NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_ONLY_SERIALIZE](nlohmann_define_type_non_intrusive.md)
|
||||||
for a similar macro that can be defined _outside_ the type.
|
for a similar macro that can be defined _outside_ the type.
|
||||||
|
- [NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE, NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_WITH_DEFAULT,
|
||||||
|
NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_ONLY_SERIALIZE, NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE,
|
||||||
|
NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_WITH_DEFAULT,
|
||||||
|
NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_ONLY_SERIALIZE](nlohmann_define_derived_type.md) for similar macros for
|
||||||
|
derived types
|
||||||
- [Arbitrary Type Conversions](../../features/arbitrary_types.md) for an overview.
|
- [Arbitrary Type Conversions](../../features/arbitrary_types.md) for an overview.
|
||||||
|
|
||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
1. Added in version 3.9.0.
|
1. Added in version 3.9.0.
|
||||||
2. Added in version 3.11.0.
|
2. Added in version 3.11.0.
|
||||||
3. Added in version TODO.
|
3. Added in version 3.11.3.
|
||||||
|
|||||||
@ -19,6 +19,14 @@ parameter is the name of the class/struct, and all remaining parameters name the
|
|||||||
default constructs an object and uses its values as the defaults when calling the `value` function.
|
default constructs an object and uses its values as the defaults when calling the `value` function.
|
||||||
3. Only defines the serialization. Useful in cases when the type does not have a default constructor and only serialization in required.
|
3. Only defines the serialization. Useful in cases when the type does not have a default constructor and only serialization in required.
|
||||||
|
|
||||||
|
Summary:
|
||||||
|
|
||||||
|
| Need access to private members | Need only de-serialization | Allow missing values when de-serializing | macro |
|
||||||
|
|------------------------------------------------------------------|------------------------------------------------------------------|------------------------------------------------------------------|-------------------------------------------------------|
|
||||||
|
| <div style="color: red;">:octicons-x-circle-fill-24:</div> | <div style="color: red;">:octicons-x-circle-fill-24:</div> | <div style="color: red;">:octicons-x-circle-fill-24:</div> | **NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE** |
|
||||||
|
| <div style="color: red;">:octicons-x-circle-fill-24:</div> | <div style="color: red;">:octicons-x-circle-fill-24:</div> | <div style="color: green;">:octicons-check-circle-fill-24:</div> | **NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT** |
|
||||||
|
| <div style="color: red;">:octicons-x-circle-fill-24:</div> | <div style="color: green;">:octicons-check-circle-fill-24:</div> | <div style="color: grey;">:octicons-skip-fill-24:</div> | **NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_ONLY_SERIALIZE** |
|
||||||
|
|
||||||
## Parameters
|
## Parameters
|
||||||
|
|
||||||
`type` (in)
|
`type` (in)
|
||||||
@ -32,8 +40,10 @@ parameter is the name of the class/struct, and all remaining parameters name the
|
|||||||
The macros add two functions to the namespace which take care of the serialization and deserialization:
|
The macros add two functions to the namespace which take care of the serialization and deserialization:
|
||||||
|
|
||||||
```cpp
|
```cpp
|
||||||
void to_json(nlohmann::json&, const type&);
|
template<typename BasicJsonType>
|
||||||
void from_json(const nlohmann::json&, type&); // except (3)
|
void to_json(BasicJsonType&, const type&);
|
||||||
|
template<typename BasicJsonType>
|
||||||
|
void from_json(const BasicJsonType&, type&); // except (3)
|
||||||
```
|
```
|
||||||
|
|
||||||
See examples below for the concrete generated code.
|
See examples below for the concrete generated code.
|
||||||
@ -53,8 +63,6 @@ See examples below for the concrete generated code.
|
|||||||
|
|
||||||
- The current implementation is limited to at most 64 member variables. If you want to serialize/deserialize types
|
- The current implementation is limited to at most 64 member variables. If you want to serialize/deserialize types
|
||||||
with more than 64 member variables, you need to define the `to_json`/`from_json` functions manually.
|
with more than 64 member variables, you need to define the `to_json`/`from_json` functions manually.
|
||||||
- The macros only work for the [`nlohmann::json`](../json.md) type; other specializations such as
|
|
||||||
[`nlohmann::ordered_json`](../ordered_json.md) are currently unsupported.
|
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@ -82,7 +90,7 @@ See examples below for the concrete generated code.
|
|||||||
|
|
||||||
The macro is equivalent to:
|
The macro is equivalent to:
|
||||||
|
|
||||||
```cpp hl_lines="16 17 18 19 20 21 22 23 24 25 26 27 28"
|
```cpp hl_lines="16 17 18 19 20 21 22 23 24 25 26 27 28 29 30"
|
||||||
--8<-- "examples/nlohmann_define_type_non_intrusive_explicit.cpp"
|
--8<-- "examples/nlohmann_define_type_non_intrusive_explicit.cpp"
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -90,7 +98,7 @@ See examples below for the concrete generated code.
|
|||||||
|
|
||||||
Consider the following complete example:
|
Consider the following complete example:
|
||||||
|
|
||||||
```cpp hl_lines="22"
|
```cpp hl_lines="21"
|
||||||
--8<-- "examples/nlohmann_define_type_non_intrusive_with_default_macro.cpp"
|
--8<-- "examples/nlohmann_define_type_non_intrusive_with_default_macro.cpp"
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -111,7 +119,7 @@ See examples below for the concrete generated code.
|
|||||||
|
|
||||||
The macro is equivalent to:
|
The macro is equivalent to:
|
||||||
|
|
||||||
```cpp hl_lines="22 23 24 25 26 27 28 29 30 31 32 33 34 35"
|
```cpp hl_lines="21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36"
|
||||||
--8<-- "examples/nlohmann_define_type_non_intrusive_with_default_explicit.cpp"
|
--8<-- "examples/nlohmann_define_type_non_intrusive_with_default_explicit.cpp"
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -140,18 +148,24 @@ See examples below for the concrete generated code.
|
|||||||
|
|
||||||
The macro is equivalent to:
|
The macro is equivalent to:
|
||||||
|
|
||||||
```cpp hl_lines="16 17 18 19 20 21"
|
```cpp hl_lines="16 17 18 19 20 21 22"
|
||||||
--8<-- "examples/nlohmann_define_type_non_intrusive_only_serialize_explicit.cpp"
|
--8<-- "examples/nlohmann_define_type_non_intrusive_only_serialize_explicit.cpp"
|
||||||
```
|
```
|
||||||
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [NLOHMANN_DEFINE_TYPE_INTRUSIVE{_WITH_DEFAULT, _ONLY_SERIALIZE}](nlohmann_define_type_intrusive.md)
|
- [NLOHMANN_DEFINE_TYPE_INTRUSIVE, NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_DEFAULT,
|
||||||
|
NLOHMANN_DEFINE_TYPE_INTRUSIVE_ONLY_SERIALIZE](nlohmann_define_type_intrusive.md)
|
||||||
for a similar macro that can be defined _inside_ the type.
|
for a similar macro that can be defined _inside_ the type.
|
||||||
|
- [NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE, NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_WITH_DEFAULT,
|
||||||
|
NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_ONLY_SERIALIZE, NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE,
|
||||||
|
NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_WITH_DEFAULT,
|
||||||
|
NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_ONLY_SERIALIZE](nlohmann_define_derived_type.md) for similar macros for
|
||||||
|
derived types
|
||||||
- [Arbitrary Type Conversions](../../features/arbitrary_types.md) for an overview.
|
- [Arbitrary Type Conversions](../../features/arbitrary_types.md) for an overview.
|
||||||
|
|
||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
1. Added in version 3.9.0.
|
1. Added in version 3.9.0.
|
||||||
2. Added in version 3.11.0.
|
2. Added in version 3.11.0.
|
||||||
3. Added in version TODO.
|
3. Added in version 3.11.3.
|
||||||
|
|||||||
@ -20,7 +20,7 @@ The `NLOHMANN_JSON_SERIALIZE_ENUM` allows to define a user-defined serialization
|
|||||||
|
|
||||||
## Default definition
|
## Default definition
|
||||||
|
|
||||||
The macros add two friend functions to the class which take care of the serialization and deserialization:
|
The macro adds two functions to the namespace which take care of the serialization and deserialization:
|
||||||
|
|
||||||
```cpp
|
```cpp
|
||||||
template<typename BasicJsonType>
|
template<typename BasicJsonType>
|
||||||
|
|||||||
@ -17,7 +17,7 @@ using namespace nlohmann;
|
|||||||
```
|
```
|
||||||
|
|
||||||
This is suggested to ease migration to the next major version release of the library. See
|
This is suggested to ease migration to the next major version release of the library. See
|
||||||
['JSON_USE_GLOBAL_UDLS`](macros/json_use_global_udls.md#notes) for details.
|
[`JSON_USE_GLOBAL_UDLS`](macros/json_use_global_udls.md#notes) for details.
|
||||||
|
|
||||||
## Parameters
|
## Parameters
|
||||||
|
|
||||||
|
|||||||
@ -16,7 +16,7 @@ using namespace nlohmann::literals::json_literals;
|
|||||||
using namespace nlohmann;
|
using namespace nlohmann;
|
||||||
```
|
```
|
||||||
This is suggested to ease migration to the next major version release of the library. See
|
This is suggested to ease migration to the next major version release of the library. See
|
||||||
['JSON_USE_GLOBAL_UDLS`](macros/json_use_global_udls.md#notes) for details.
|
[`JSON_USE_GLOBAL_UDLS`](macros/json_use_global_udls.md#notes) for details.
|
||||||
|
|
||||||
## Parameters
|
## Parameters
|
||||||
|
|
||||||
|
|||||||
@ -6,6 +6,13 @@ using ordered_json = basic_json<ordered_map>;
|
|||||||
|
|
||||||
This type preserves the insertion order of object keys.
|
This type preserves the insertion order of object keys.
|
||||||
|
|
||||||
|
## Iterator invalidation
|
||||||
|
|
||||||
|
The type is based on [`ordered_map`](ordered_map.md) which in turn uses a `std::vector` to store object elements.
|
||||||
|
Therefore, adding object elements can yield a reallocation in which case all iterators (including the
|
||||||
|
[`end()`](basic_json/end.md) iterator) and all references to the elements are invalidated. Also, any iterator or
|
||||||
|
reference after the insertion point will point to the same index which is now a different value.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
??? example
|
??? example
|
||||||
|
|||||||
@ -23,6 +23,11 @@ A minimal map-like container that preserves insertion order for use within [`nlo
|
|||||||
`Allocator`
|
`Allocator`
|
||||||
: allocator type
|
: allocator type
|
||||||
|
|
||||||
|
## Iterator invalidation
|
||||||
|
|
||||||
|
The type uses a `std::vector` to store object elements. Therefore, adding elements can yield a reallocation in which
|
||||||
|
case all iterators (including the `end()` iterator) and all references to the elements are invalidated.
|
||||||
|
|
||||||
## Member types
|
## Member types
|
||||||
|
|
||||||
- **key_type** - key type (`Key`)
|
- **key_type** - key type (`Key`)
|
||||||
|
|||||||
1
docs/mkdocs/docs/community/code_of_conduct.md
Normal file
1
docs/mkdocs/docs/community/code_of_conduct.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
--8<-- "../../../.github/CODE_OF_CONDUCT.md"
|
||||||
1
docs/mkdocs/docs/community/contribution_guidelines.md
Normal file
1
docs/mkdocs/docs/community/contribution_guidelines.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
--8<-- "../../../.github/CONTRIBUTING.md"
|
||||||
122
docs/mkdocs/docs/community/governance.md
Normal file
122
docs/mkdocs/docs/community/governance.md
Normal file
@ -0,0 +1,122 @@
|
|||||||
|
# Governance
|
||||||
|
|
||||||
|
The governance model for the JSON for Modern C++ project is a **Benevolent Dictator for Life (BDFL)** structure. As the
|
||||||
|
sole maintainer, [Niels Lohmann](https://github.com/nlohmann) is responsible for all key aspects of the project. The
|
||||||
|
project governance may evolve as the project grows, but any changes will be documented here and communicated to
|
||||||
|
contributors.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
This project is led by a benevolent dictator, [Niels Lohmann](https://github.com/nlohmann), and managed by the
|
||||||
|
community. That is, the community actively contributes to the day-to-day maintenance of the project, but the general
|
||||||
|
strategic line is drawn by the benevolent dictator. In case of disagreement, they have the last word. It is the
|
||||||
|
benevolent dictator’s job to resolve disputes within the community and to ensure that the project is able to progress in
|
||||||
|
a coordinated way. In turn, it is the community’s job to guide the decisions of the benevolent dictator through active
|
||||||
|
engagement and contribution.
|
||||||
|
|
||||||
|
## Roles and responsibilities
|
||||||
|
|
||||||
|
### Benevolent dictator (project lead)
|
||||||
|
|
||||||
|
Typically, the benevolent dictator, or project lead, is self-appointed. However, because the community always has the
|
||||||
|
ability to fork, this person is fully answerable to the community. The project lead’s role is a difficult one: they set
|
||||||
|
the strategic objectives of the project and communicate these clearly to the community. They also have to understand the
|
||||||
|
community as a whole and strive to satisfy as many conflicting needs as possible, while ensuring that the project
|
||||||
|
survives in the long term.
|
||||||
|
|
||||||
|
In many ways, the role of the benevolent dictator is less about dictatorship and more about diplomacy. The key is to
|
||||||
|
ensure that, as the project expands, the right people are given influence over it and the community rallies behind the
|
||||||
|
vision of the project lead. The lead’s job is then to ensure that the committers (see below) make the right decisions on
|
||||||
|
behalf of the project. Generally speaking, as long as the committers are aligned with the project’s strategy, the
|
||||||
|
project lead will allow them to proceed as they desire.
|
||||||
|
|
||||||
|
### Committers
|
||||||
|
|
||||||
|
Committers are contributors who have made several valuable contributions to the project and are now relied upon to both
|
||||||
|
write code directly to the repository and screen the contributions of others. In many cases they are programmers but it
|
||||||
|
is also possible that they contribute in a different role. Typically, a committer will focus on a specific aspect of the
|
||||||
|
project, and will bring a level of expertise and understanding that earns them the respect of the community and the
|
||||||
|
project lead. The role of committer is not an official one, it is simply a position that influential members of the
|
||||||
|
community will find themselves in as the project lead looks to them for guidance and support.
|
||||||
|
|
||||||
|
Committers have no authority over the overall direction of the project. However, they do have the ear of the project
|
||||||
|
lead. It is a committer’s job to ensure that the lead is aware of the community’s needs and collective objectives, and
|
||||||
|
to help develop or elicit appropriate contributions to the project. Often, committers are given informal control over
|
||||||
|
their specific areas of responsibility, and are assigned rights to directly modify certain areas of the source code.
|
||||||
|
That is, although committers do not have explicit decision-making authority, they will often find that their actions are
|
||||||
|
synonymous with the decisions made by the lead.
|
||||||
|
|
||||||
|
### Contributors
|
||||||
|
|
||||||
|
Contributors are community members who either have no desire to become committers, or have not yet been given the
|
||||||
|
opportunity by the benevolent dictator. They make valuable contributions, such as those outlined in the list below, but
|
||||||
|
generally do not have the authority to make direct changes to the project code. Contributors engage with the project
|
||||||
|
through communication tools, such as email lists, and via reports and patches attached to issues in the issue tracker,
|
||||||
|
as detailed in our community tools document.
|
||||||
|
|
||||||
|
Anyone can become a contributor. There is no expectation of commitment to the project, no specific skill requirements
|
||||||
|
and no selection process. To become a contributor, a community member simply has to perform one or more actions that are
|
||||||
|
beneficial to the project.
|
||||||
|
|
||||||
|
Some contributors will already be engaging with the project as users, but will also find themselves doing one or more of
|
||||||
|
the following:
|
||||||
|
|
||||||
|
- supporting new users (current users often provide the most effective new user support)
|
||||||
|
- reporting bugs
|
||||||
|
- identifying requirements
|
||||||
|
- supplying graphics and web design
|
||||||
|
- programming
|
||||||
|
- assisting with project infrastructure
|
||||||
|
- writing documentation
|
||||||
|
- fixing bugs
|
||||||
|
- adding features
|
||||||
|
|
||||||
|
As contributors gain experience and familiarity with the project, they may find that the project lead starts relying on
|
||||||
|
them more and more. When this begins to happen, they gradually adopt the role of committer, as described above.
|
||||||
|
|
||||||
|
### Users
|
||||||
|
|
||||||
|
Users are community members who have a need for the project. They are the most important members of the community:
|
||||||
|
without them, the project would have no purpose. Anyone can be a user; there are no specific requirements.
|
||||||
|
|
||||||
|
Users should be encouraged to participate in the life of the project and the community as much as possible. User
|
||||||
|
contributions enable the project team to ensure that they are satisfying the needs of those users. Common user
|
||||||
|
activities include (but are not limited to):
|
||||||
|
|
||||||
|
- evangelising about the project
|
||||||
|
- informing developers of project strengths and weaknesses from a new user’s perspective
|
||||||
|
- providing moral support (a ‘thank you’ goes a long way)
|
||||||
|
- providing financial support
|
||||||
|
|
||||||
|
Users who continue to engage with the project and its community will often find themselves becoming more and more
|
||||||
|
involved. Such users may then go on to become contributors, as described above.
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
All participants in the community are encouraged to provide support for new users within the project management
|
||||||
|
infrastructure. This support is provided as a way of growing the community. Those seeking support should recognise that
|
||||||
|
all support activity within the project is voluntary and is therefore provided as and when time allows. A user requiring
|
||||||
|
guaranteed response times or results should therefore seek to purchase a support contract from a vendor. (Of course,
|
||||||
|
that vendor should be an active member of the community.) However, for those willing to engage with the project on its
|
||||||
|
own terms, and willing to help support other users, the community support channels are ideal.
|
||||||
|
|
||||||
|
## Contribution Process
|
||||||
|
|
||||||
|
Anyone can contribute to the project, regardless of their skills, as there are many ways to contribute. For instance, a
|
||||||
|
contributor might be active on the project mailing list and issue tracker, or might supply patches. The various ways of
|
||||||
|
contributing are described in more detail in our roles in open source document.
|
||||||
|
|
||||||
|
The developer mailing list is the most appropriate place for a contributor to ask for help when making their first
|
||||||
|
contribution.
|
||||||
|
|
||||||
|
## Decision-Making Process
|
||||||
|
|
||||||
|
The benevolent dictatorship model does not need a formal conflict resolution process, since the project lead’s word is
|
||||||
|
final. If the community chooses to question the wisdom of the actions of a committer, the project lead can review their
|
||||||
|
decisions by checking the email archives, and either uphold or reverse them.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
!!! quote "Source"
|
||||||
|
|
||||||
|
The text was taken from http://oss-watch.ac.uk/resources/benevolentdictatorgovernancemodel.
|
||||||
7
docs/mkdocs/docs/community/index.md
Normal file
7
docs/mkdocs/docs/community/index.md
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
# Community
|
||||||
|
|
||||||
|
- [Code of Conduct](code_of_conduct.md) - the rules and norms of this project
|
||||||
|
- [Contribution Guidelines](contribution_guidelines.md) - guidelines how to contribute to this project
|
||||||
|
- [Governance](governance.md) - the governance model of this project
|
||||||
|
- [Quality Assurance](quality_assurance.md) - how quality of this project is assured
|
||||||
|
- [Security Policy](security_policy.md) - the security policy of the project
|
||||||
210
docs/mkdocs/docs/community/quality_assurance.md
Normal file
210
docs/mkdocs/docs/community/quality_assurance.md
Normal file
@ -0,0 +1,210 @@
|
|||||||
|
# Quality assurance
|
||||||
|
|
||||||
|
Ensuring quality is paramount for this project, particularly because [numerous other projects](../home/customers.md)
|
||||||
|
depend on it. Each commit to the library undergoes rigorous checks against the following requirements, and any
|
||||||
|
violations will result in a failed build.
|
||||||
|
|
||||||
|
## C++ language compliance and compiler compatibility
|
||||||
|
|
||||||
|
!!! success "Requirement: Compiler support"
|
||||||
|
|
||||||
|
Any compiler with complete C++11 support can compile the library without warnings.
|
||||||
|
|
||||||
|
- [x] The library is compiled library with 50+ different C++ compilers with different operating systems and platforms,
|
||||||
|
including the oldest versions known to compile the library.
|
||||||
|
|
||||||
|
??? abstract "Compilers used in continuous integration"
|
||||||
|
|
||||||
|
| Compiler | Architecture | Operating System | CI |
|
||||||
|
|----------------------------------------------|--------------|--------------------------|-----------|
|
||||||
|
| AppleClang 14.0.0.14000029; Xcode 14.1 | x86_64 | macOS 13.7.2 (Ventura) | GitHub |
|
||||||
|
| AppleClang 14.0.0.14000029; Xcode 14.2 | x86_64 | macOS 13.7.2 (Ventura) | GitHub |
|
||||||
|
| AppleClang 14.0.3.14030022; Xcode 14.3.1 | x86_64 | macOS 13.7.2 (Ventura) | GitHub |
|
||||||
|
| AppleClang 15.0.0.15000040; Xcode 15.0.1 | x86_64 | macOS 13.7.2 (Ventura) | GitHub |
|
||||||
|
| AppleClang 15.0.0.15000100; Xcode 15.1 | x86_64 | macOS 13.7.2 (Ventura) | GitHub |
|
||||||
|
| AppleClang 15.0.0.15000100; Xcode 15.2 | x86_64 | macOS 13.7.2 (Ventura) | GitHub |
|
||||||
|
| AppleClang 15.0.0.15000309; Xcode 15.3 | arm64 | macOS 14.7.2 (Sonoma) | GitHub |
|
||||||
|
| AppleClang 15.0.0.15000309; Xcode 15.4 | arm64 | macOS 14.7.2 (Sonoma) | GitHub |
|
||||||
|
| AppleClang 16.0.0.16000026; Xcode 16 | arm64 | macOS 15.2 (Sequoia) | GitHub |
|
||||||
|
| AppleClang 16.0.0.16000026; Xcode 16.1 | arm64 | macOS 15.2 (Sequoia) | GitHub |
|
||||||
|
| AppleClang 16.0.0.16000026; Xcode 16.2 | arm64 | macOS 15.2 (Sequoia) | GitHub |
|
||||||
|
| Clang 3.5.2 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 3.6.2 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 3.7.1 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 3.8.1 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 3.9.1 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 4.0.1 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 5.0.2 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 6.0.1 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 7.1.0 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 8.0.1 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 9.0.1 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 10.0.1 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 11.0.0 with GNU-like command-line | x86_64 | Windows 10 (Build 17763) | GitHub |
|
||||||
|
| Clang 11.1.0 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 12.0.0 with GNU-like command-line | x86_64 | Windows 10 (Build 17763) | GitHub |
|
||||||
|
| Clang 12.0.0 with MSVC-like command-line | x86_64 | Windows 10 (Build 17763) | GitHub |
|
||||||
|
| Clang 12.0.1 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 13.0.0 with GNU-like command-line | x86_64 | Windows 10 (Build 17763) | GitHub |
|
||||||
|
| Clang 13.0.1 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 14.0.0 with GNU-like command-line | x86_64 | Windows 10 (Build 17763) | GitHub |
|
||||||
|
| Clang 14.0.6 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 15.0.0 with GNU-like command-line | x86_64 | Windows 10 (Build 17763) | GitHub |
|
||||||
|
| Clang 15.0.7 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 16.0.6 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 17.0.6 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 18.1.8 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 19.1.6 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| Clang 20.0.0 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| GNU 4.8.5 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| GNU 4.9.3 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| GNU 5.5.0 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| GNU 6.4.0 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| GNU 7.5.0 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| GNU 8.5.0 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| GNU 9.3.0 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| GNU 9.4.0 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| GNU 9.5.0 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| GNU 10.5.0 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| GNU 11.4.0 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| GNU 11.5.0 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| GNU 12.2.0 (MinGW-W64 i686-ucrt-posix-dwarf) | x86_64 | Windows 10 (Build 17763) | GitHub |
|
||||||
|
| GNU 12.2.0 (MinGW-W64 x86_64-ucrt-posix-seh) | x86_64 | Windows 10 (Build 17763) | GitHub |
|
||||||
|
| GNU 12.4.0 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| GNU 13.3.0 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| GNU 14.2.0 | x86_64 | Ubuntu 22.04.1 LTS | GitHub |
|
||||||
|
| GNU 14.2.0 | arm64 | Linux 6.1.100 | Cirrus CI |
|
||||||
|
| MSVC 19.0.24241.7 | x86 | Windows 8.1 | AppVeyor |
|
||||||
|
| MSVC 19.16.27035.0 | x86 | Windows-10 (Build 14393) | AppVeyor |
|
||||||
|
| MSVC 19.29.30157.0 | x86 | Windows 10 (Build 17763) | GitHub |
|
||||||
|
| MSVC 19.29.30157.0 | x86_64 | Windows 10 (Build 17763) | GitHub |
|
||||||
|
| MSVC 19.29.30157.0 | x86 | Windows-10 (Build 17763) | AppVeyor |
|
||||||
|
| MSVC 19.42.34435.0 | x86 | Windows 10 (Build 20348) | GitHub |
|
||||||
|
| MSVC 19.42.34435.0 | x86_64 | Windows 10 (Build 20348) | GitHub |
|
||||||
|
|
||||||
|
- [x] The library is compiled with all C++ language revisions (C++11, C++14, C++17, C++20, C++23, and C++26) to detect
|
||||||
|
and fix language deprecations early.
|
||||||
|
- [x] The library is checked for compiler warnings:
|
||||||
|
- On Clang, `-Weverything` is used with 7 exceptions.
|
||||||
|
|
||||||
|
??? abstract "Clang warnings"
|
||||||
|
|
||||||
|
```cmake
|
||||||
|
--8<-- "../../../cmake/clang_flags.cmake"
|
||||||
|
```
|
||||||
|
|
||||||
|
- On GCC, 300+ warnings are enabled with 8 exceptions.
|
||||||
|
|
||||||
|
??? abstract "GCC warnings"
|
||||||
|
|
||||||
|
```cmake
|
||||||
|
--8<-- "../../../cmake/gcc_flags.cmake"
|
||||||
|
```
|
||||||
|
|
||||||
|
## C++ standard library compliance
|
||||||
|
|
||||||
|
!!! success "Requirement: No prerequisites"
|
||||||
|
|
||||||
|
The library has no prerequisites other than the Standard Template Library (STL).
|
||||||
|
|
||||||
|
- [x] The library compiled and tested with both [libc++](https://libcxx.llvm.org) and
|
||||||
|
[libstdc++](https://gcc.gnu.org/onlinedocs/libstdc++/) to detect subtle differences or incompatibilities.
|
||||||
|
- [x] The code checked with [Include What You Use (IWYU)](https://include-what-you-use.org) that all required standard
|
||||||
|
headers are included.
|
||||||
|
- [x] On Windows, the library is compiled with `<Windows.h>` being included to detect and avoid common bugs.
|
||||||
|
- [x] The library is compiled with exceptions disabled to support alternative means of error handling.
|
||||||
|
|
||||||
|
## Stable public API
|
||||||
|
|
||||||
|
!!! success "Requirement: Stable public API"
|
||||||
|
|
||||||
|
Any change to the library does not break the public API.
|
||||||
|
|
||||||
|
- [x] All public API functions are tested with a variety of arguments.
|
||||||
|
- [x] The library is compiled and tested with different template arguments for number, string, array, and object types.
|
||||||
|
- [x] All lines of the code base are covered by unit tests.
|
||||||
|
- [x] Every exception of the library is thrown in the test suite and the error messages and exception ids are checked.
|
||||||
|
|
||||||
|
!!! success "Requirement: Complete documentation"
|
||||||
|
|
||||||
|
The public API is extensively documented.
|
||||||
|
|
||||||
|
- [x] Every public API function has a dedicated page in the
|
||||||
|
[API reference documentation](https://json.nlohmann.me/api/basic_json/) with a self-contained code example.
|
||||||
|
- [x] All examples in the documentation are tested and changes in their output is treated as an error.
|
||||||
|
|
||||||
|
## Robust input processing
|
||||||
|
|
||||||
|
!!! success "Requirement: Standards compliance"
|
||||||
|
|
||||||
|
The library is compliant to JSON as defined in [RFC 8259](https://datatracker.ietf.org/doc/html/rfc8259).
|
||||||
|
|
||||||
|
- [x] The lexer is tested with all valid Unicode code points and all prefixes of all invalid Unicode code points.
|
||||||
|
- [x] The parser is tested against extensive correctness suites for JSON compliance.
|
||||||
|
- [x] In addition, the library is continuously fuzz-tested at [OSS-Fuzz](https://google.github.io/oss-fuzz/) where the
|
||||||
|
library is checked against billions of inputs.
|
||||||
|
|
||||||
|
## Static analysis
|
||||||
|
|
||||||
|
!!! success "Requirement: State-of-the-art code analysis"
|
||||||
|
|
||||||
|
The code is checked with state-of-the-art static code analysis tools.
|
||||||
|
|
||||||
|
- [x] The code is checked with the latest [Clang-Tidy](https://clang.llvm.org/extra/clang-tidy/).
|
||||||
|
|
||||||
|
??? abstract "Clang-Tidy configuration (.clang-tidy)"
|
||||||
|
|
||||||
|
```ini
|
||||||
|
--8<-- "../../../.clang-tidy"
|
||||||
|
```
|
||||||
|
|
||||||
|
- [x] The code is checked with the latest [Cppcheck](https://cppcheck.sourceforge.io) with all warnings enabled.
|
||||||
|
- [x] The code is checked with the latest [Clang Static Analyzer](https://clang-analyzer.llvm.org) with 89 enabled
|
||||||
|
rules.
|
||||||
|
- [x] The code is checked with [Infer](https://fbinfer.com).
|
||||||
|
- [x] The code is checked with [Codacy](https://app.codacy.com/gh/nlohmann/json/dashboard).
|
||||||
|
|
||||||
|
## Dynamic analysis
|
||||||
|
|
||||||
|
!!! success "Requirement: Correctness"
|
||||||
|
|
||||||
|
The library is checked for memory correctness and absence of undefined behavior.
|
||||||
|
|
||||||
|
- [x] The test suite is executed with enabled [runtime assertions](https://json.nlohmann.me/features/assertions/) to
|
||||||
|
check invariants and preconditions of functions to detect undefined behavior.
|
||||||
|
- [x] The test suite is executed with [Valgrind](https://valgrind.org) (Memcheck) to detect memory leaks.
|
||||||
|
- [x] The test suite is executed with [Sanitizers](https://github.com/google/sanitizers) (address sanitizer, undefined
|
||||||
|
behavior sanitizer, integer overflow detection, nullability violations).
|
||||||
|
|
||||||
|
## Style check
|
||||||
|
|
||||||
|
!!! success "Requirement: Common code style"
|
||||||
|
|
||||||
|
A common code style is used throughout all code files of the library.
|
||||||
|
|
||||||
|
- [x] The code is formatted with [Artistic Style](https://astyle.sourceforge.net) (astyle) against a style configuration
|
||||||
|
that is also enforced in the CI.
|
||||||
|
|
||||||
|
??? abstract "Astyle configuration (tools/astyle/.astylerc)"
|
||||||
|
|
||||||
|
```ini
|
||||||
|
--8<-- "../../../tools/astyle/.astylerc"
|
||||||
|
```
|
||||||
|
|
||||||
|
- [x] The code style is checked with [cpplint](https://github.com/cpplint/cpplint) with 61 enabled rules.
|
||||||
|
|
||||||
|
## Simple integration
|
||||||
|
|
||||||
|
!!! success "Requirement: Single header"
|
||||||
|
|
||||||
|
The library can be used by adding a single header to a C++ project.
|
||||||
|
|
||||||
|
- [x] An amalgamation script is used to check if the source code is exposed as self-contained single-header file.
|
||||||
|
- [x] The test suite is checked against the amalgamated source file as well as the individual source file.
|
||||||
|
|
||||||
|
!!! success "Requirement: CMake as primary development tool"
|
||||||
|
|
||||||
|
All library functions are exposed and usable by CMake.
|
||||||
|
|
||||||
|
- [x] All library options are exposed as [CMake options](https://json.nlohmann.me/integration/cmake/) and tested.
|
||||||
|
- [x] The library is tested against the earliest supported CMake version.
|
||||||
1
docs/mkdocs/docs/community/security_policy.md
Normal file
1
docs/mkdocs/docs/community/security_policy.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
--8<-- "../../../.github/SECURITY.md"
|
||||||
@ -1,4 +1,4 @@
|
|||||||
/* disable ligatures in code and preformatted blocks */
|
/* enable ligatures in code and preformatted blocks */
|
||||||
code, pre {
|
.md-typeset code, .md-typeset pre {
|
||||||
font-variant-ligatures: none;
|
font-variant-ligatures: common-ligatures;
|
||||||
}
|
}
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user