External/yaml-cpp
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
https://github.com/jbeder/yaml-cpp
902 Commits 8 Branches 20 Tags 6.8 MiB
C++ 86.5%
Python 10%
C 1.2%
CMake 1.2%
Starlark 0.6%
Other 0.4%
ff9a466152
Go to file
Pras Velagapudi ff9a466152 Add an into() operator on Node to do optional assignment. 
This adds an `into()` operator to the Node class modeled off
the `get_to()` operator in the popular nlohmann::json library.
(See: https://github.com/nlohmann/json#basic-usage)

This operator assigns a casted value to an existing variable
if that node has a defined value, and otherwise leaves the
variable unchanged.  It returns `true` if the variable was
overwritten and `false` if the variable was unchanged.

This operator is extremely useful in applications where YAML
is being used as a configuration source that overrides
default values coming from another source, e.g.:

```c++
struct MyConfig {
  int foo = 4;
  double bar = 5.0;
  std::string baz = "six";
};

MyConfig config;
node["foo"].into(config.foo);
node["bar"].into(config.bar);

if (!node["baz"].into(config.baz))
  std::cerr << "Using default value for .baz!" << std::endl;
```
2021-11-25 09:30:53 -05:00
.github/workflows github actions for mac/linux/windows (#1056) 2021-10-31 11:59:40 -05:00
docs Support as<uint8_t>/as<int8_t>. 2020-06-15 10:31:59 -05:00
include/yaml-cpp Add an into() operator on Node to do optional assignment. 2021-11-25 09:30:53 -05:00
src Use static_cast<unsigned char> on DecodeBase64 to prevent SEGV on negative values (#1051) 2021-10-20 10:18:08 -05:00
test Add an into() operator on Node to do optional assignment. 2021-11-25 09:30:53 -05:00
util Remove unused code from parse util (#1048) 2021-10-13 15:56:11 -05:00
.clang-format Update .clang-format to use C++ 11 style. 2016-04-01 20:06:28 -05:00
.codedocs test: Upgrade googlemock 1.7.0 to googletest 1.8.0 2017-08-24 22:49:17 -05:00
.gitignore Add bazel Support (#724) 2019-09-27 10:11:38 -05:00
.travis.yml Update travis config to use updated versions of OS and compilers. (#845) 2020-04-07 22:46:47 -05:00
appveyor.yml Add the AppVeyor configuration file (#927) 2020-07-23 23:04:02 -05:00
BUILD.bazel Allow including yaml-cpp as system headers (#829) 2020-02-29 22:27:16 -06:00
CMakeLists.txt Partially revert commit 0733aeb4 to make dll.h a non-generated file (#1064) 2021-11-22 22:40:08 -06:00
CONTRIBUTING.md Update CONTRIBUTING.md 2016-03-28 23:47:21 -05:00
install.txt Added newline to install and license files 2009-12-21 20:35:27 +00:00
LICENSE Rename license file and update copyright date. 2015-03-30 20:32:46 -05:00
README.md Fix github actions badge. 2021-11-22 22:44:31 -06:00
WORKSPACE Add bazel Support (#724) 2019-09-27 10:11:38 -05:00
yaml-cpp-config.cmake.in Add yaml-cpp-config.cmake and yaml-cpp-config-version.cmake files for importing yaml-cpp into external projects (through find_package). 2015-01-24 11:21:26 -06:00
yaml-cpp.pc.in Fix .pc paths for absolute GNUInstallDirs (#1058) 2021-11-02 21:34:46 -05:00

README.md

yaml-cpp Build Status Documentation

yaml-cpp is a YAML parser and emitter in C++ matching the YAML 1.2 spec.

Usage

See Tutorial and How to Emit YAML for reference. For the old API (until 0.5.0), see How To Parse A Document.

Any Problems?

If you find a bug, post an issue! If you have questions about how to use yaml-cpp, please post it on http://stackoverflow.com and tag it yaml-cpp.

How to Build

yaml-cpp uses CMake to support cross-platform building. Install CMake (Resources -> Download) before proceeding. The basic steps to build are:

Note: If you don't use the provided installer for your platform, make sure that you add CMake's bin folder to your path.

1. Navigate into the source directory, create build folder and run CMake:

mkdir build
cd build
cmake [-G generator] [-YAML_BUILD_SHARED_LIBS=on|OFF] ..

  • The generator option is the build system you'd like to use. Run cmake without arguments to see a full list of available generators.

    • On Windows, you might use "Visual Studio 12 2013" (VS 2013 32-bits), or "Visual Studio 14 2015 Win64" (VS 2015 64-bits).
    • On OS X, you might use "Xcode".
    • On a UNIX-like system, omit the option (for a Makefile).

  • yaml-cpp builds a static library by default, you may want to build a shared library by specifying -YAML_BUILD_SHARED_LIBS=ON.

  • For more options on customizing the build, see the CMakeLists.txt file.

2. Build it!

  • The command you'll need to run depends on the generator you chose earlier.

Note: To clean up, just remove the build directory.

Recent Releases

yaml-cpp 0.6.0 released! This release requires C++11, and no longer depends on Boost.

yaml-cpp 0.3.0 is still available if you want the old API.

The old API will continue to be supported, and will still receive bugfixes! The 0.3.x and 0.4.x versions will be old API releases, and 0.5.x and above will all be new API releases.

API Documentation

The autogenerated API reference is hosted on CodeDocs

Third Party Integrations

The following projects are not officially supported: