luo980/yaml-cpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
A YAML parser and emitter in C++
927 Commits 7 Branches 20 Tags 7 MiB
C++ 87.3%
Python 9.4%
C 1.1%
CMake 1.1%
Starlark 0.6%
Other 0.4%
5b1c606801
Go to file
Karl Twesten 5b1c606801 Support for building with exceptions disabled 
1) A new macro YAML_CPP_NORETURN to annotate functions as not returning in dll.h
2) A new function YAML_throw<ExceptionType>(args...) in exception.h
   this function will throw an exception unless exceptions are disabled in the compiler,
   detected by checking the pre-defined macro __cpp_exceptions
   In this case the exception class will be instantiated, and the user-provided function
   YAML::handle_exception(const char*) will be called on the exception's what() method
3) if exceptions are disabled,and the library's user does not provide YAML::handle_exception,
   there will be a linker error
4) all other files have been changed automatedly by running the following sed commands
   sed -i "s/throw \([A-Za-z]*\)(\(.*\))/YAML_throw<\1>(\2)/g" # throw statements for non-templated exceptions
   sed -i "s/throw \(.*\)<\(.*\)>(/YAML_throw<\1<\2> >(/g" # throw statements for templated exceptions
2022-10-21 17:05:47 +02:00
.github/workflows Improve bazel build for Windows. (#1100) 2022-04-27 09:10:13 -05:00
docs Support as<uint8_t>/as<int8_t>. 2020-06-15 10:31:59 -05:00
include/yaml-cpp Support for building with exceptions disabled 2022-10-21 17:05:47 +02:00
src Support for building with exceptions disabled 2022-10-21 17:05:47 +02:00
test Include property nodes in the long key check (#1140) 2022-10-04 18:51: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 Improve bazel build for Windows. (#1100) 2022-04-27 09:10:13 -05:00
cmake_uninstall.cmake.in Add the "make uninstall" target (#1130) 2022-09-20 00:03:40 -05:00
CMakeLists.txt Export library directory and shared libs to CMake config (#1113) 2022-09-20 00:26:59 -05:00
CONTRIBUTING.md Basic update to CMakeLists.txt to address #1116 (#1117) 2022-09-20 00:24:35 -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 typo in README about building shared libraries. 2021-12-10 08:54:35 -06:00
WORKSPACE Add bazel Support (#724) 2019-09-27 10:11:38 -05:00
yaml-cpp-config.cmake.in Export library directory and shared libs to CMake config (#1113) 2022-09-20 00:26:59 -05: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] [-DYAML_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 -DYAML_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: