README.md 4.5 KB

Boost.Contract

Contract programming for C++. All contract programming features are supported: Subcontracting, class invariants (also static and volatile), postconditions (with old and return values), preconditions, customizable actions on assertion failure (e.g., terminate or throw), optional compilation and checking of assertions, disable assertions while already checking other assertions (to avoid infinite recursion), etc.

License

Distributed under the Boost Software License, Version 1.0.

Properties

  • C++11 (C++03 possible but not recommended without lambda functions and variadic macros, see documentation for more information).
  • Shared Library / DLL with BOOST_CONTRACT_DYN_LINK (static library with BOOST_CONTRACT_STATIC_LINK, header-only also possible but not recommended, see BOOST_CONTRACT_HEADER_ONLY documentation for more information).

Build Status

Branch Travis Appveyor Coverity Scan codecov.io Deps Docs Tests
master Build Status Build status Coverity Scan Build Status codecov Deps Documentation Enter the Matrix
develop Build Status Build status Coverity Scan Build Status codecov Deps Documentation Enter the Matrix

Directories

Name Purpose
build Build
doc Documentation
example Examples
include Header code
meta Integration with Boost
src Source code
test Unit tests

More Information

  • Ask questions.
  • Report bugs: Be sure to mention Boost version, platform and compiler you are using. A small compilable code sample to reproduce the problem is always good as well.
  • Submit your patches as pull requests against develop branch. Note that by submitting patches you agree to license your modifications under the Boost Software License, Version 1.0.
  • Discussions about the library are held on the Boost developers mailing list. Be sure to read the discussion policy before posting and add the [contract] text at the beginning of the subject line.