Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/taocpp/config
C++ header-only config reader library based on JSON
https://github.com/taocpp/config
config cpp cpp17 header-only json
Last synced: 2 months ago
JSON representation
C++ header-only config reader library based on JSON
- Host: GitHub
- URL: https://github.com/taocpp/config
- Owner: taocpp
- License: mit
- Created: 2018-10-24T09:11:20.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T18:40:12.000Z (9 months ago)
- Last Synced: 2024-08-01T00:41:11.783Z (5 months ago)
- Topics: config, cpp, cpp17, header-only, json
- Language: C++
- Homepage:
- Size: 1.12 MB
- Stars: 180
- Watchers: 9
- Forks: 21
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesomecpp - taocpp/config - - header-only library that reads config files based on JSON and JAXN and produces a single JSON Value as result. (Configuration)
README
# The Art of C++ / Config
[](https://github.com/taocpp/config/actions?query=workflow%3AWindows)
[](https://github.com/taocpp/config/actions?query=workflow%3AmacOS)
[](https://github.com/taocpp/config/actions?query=workflow%3ALinux)
[](https://github.com/taocpp/config/actions?query=workflow%3Aclang-analyze)
[](https://github.com/taocpp/config/actions?query=workflow%3Aclang-tidy)
[](https://github.com/taocpp/config/actions?query=workflow%3ASanitizer)
[](https://github.com/taocpp/config/actions?query=workflow%3ACodeQL)
[](https://codecov.io/gh/taocpp/config)
[The Art of C++] / Config is a C++ header-only library that reads config files in a format based on [JSON] and [JAXN] and produces a single [JSON Value] as result.
## Documentation
* [Changelog](doc/Changelog.md)
* [Version 1.x](doc/README.md) (requires C++17)
## Contact
For questions and suggestions regarding The Art of C++ / Config, success or failure stories, and any other kind of feedback, please feel free to open a [discussion](https://github.com/taocpp/config/discussions), an [issue](https://github.com/taocpp/config/issues) or a [pull request](https://github.com/taocpp/config/pulls) on GitHub or contact the authors at `taocpp(at)icemx.net`.
## Introduction
* [JAXN] syntax with extensions (backward compatible with [JSON]).
* [JAXN] data model ([JSON] extended with binary data and non-finites).
* Meta data; all sub-values are annotated with filename and position.
* Copy via [reference](Writing-Config-Files.md#references), [overwrite](Writing-Config-Files.md#overwrite) and [delete](Writing-Config-Files.md#delete) anything in the data structure.
* [Include](doc/Writing-Config-Files.md#include-files) other config files into any position in the data structure.
* And more, the complete list of features is documented on the [Writing Config Files](doc/Writing-Config-Files.md) page.
* The function [`tao::config::from_file()`](doc/Parsing-Config-Files.md) is all you need to get going.
Every JSON file with a top-level object can be used as [config file](doc/Writing-Config-Files.md).
```
{
"ip": "127.0.0.2",
"port": 27960,
"maps": [ "ztn", "dm13", "t9" ]
}
```
This small example can be rendered differently using some of the additional syntactic possibilities of the [config file](doc/Writing-Config-Files.md) format.
```
#!/usr/local/bin/q3s
ip = "127.0.0.2"
port = 27960
maps = [ "ztn" "dm13" "t9" ] // Add dm6 or t4?
```
Semantic features like [deleting](doc/Writing-Config-Files.md#delete) and [referencing](doc/Writing-Config-Files.md#references) values, or [including files](doc/Writing-Config-Files.md#include-files) and [reading environment variables](doc/All-Config-Functions.md#env), usually only make sense with larger, non-trivial real-world examples.
These features can be used to manage situations that go beyond single deployments with a single config, for example providing the tools to manage configuration templates that are adapted to different environments.
[Parsing](doc/Parsing-Config-Files.md) a [config file](doc/Writing-Config-Files.md) is as simple as calling the appropriate `from_file()` function with the filename.
```
#include
const tao::config::value config = tao::config::from_file( "foo.cfg" );
```
The resulting value is a [JSON Value] from [taoJSON] with a custom taoCONFIG traits class that annotates every sub-value with the filename and position it was parsed from.
It can be inspected -- and manipulated -- using all the facilities of the [taoJSON] library.
## License
The Art of C++ / Config is certified [Open Source] software.
It may be used for any purpose, including commercial purposes, at absolutely no cost.
It is distributed under the terms of the [MIT license] reproduced here.
> Copyright (c) 2018-2024 Dr. Colin Hirsch and Daniel Frey
>
> 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:
>
> The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
[JAXN]: https://github.com/stand-art/jaxn/
[JSON]: https://tools.ietf.org/html/rfc8259
[JSON Value]: https://github.com/taocpp/json/
[MIT license]: http://www.opensource.org/licenses/mit-license.html
[Open Source]: http://www.opensource.org/docs/definition.html
[taoJSON]: https://github.com/taocpp/json/
[The Art of C++]: https://taocpp.github.io/