annotate DEPENDENCIES/generic/include/boost/test/framework.hpp @ 133:4acb5d8d80b6 tip

Don't fail environmental check if README.md exists (but .txt and no-suffix don't)
author Chris Cannam
date Tue, 30 Jul 2019 12:25:44 +0100
parents c530137014c0
children
rev   line source
Chris@16 1 // (C) Copyright Gennadiy Rozental 2005-2008.
Chris@16 2 // Distributed under the Boost Software License, Version 1.0.
Chris@16 3 // (See accompanying file LICENSE_1_0.txt or copy at
Chris@16 4 // http://www.boost.org/LICENSE_1_0.txt)
Chris@16 5
Chris@16 6 // See http://www.boost.org/libs/test for the library home page.
Chris@16 7 //
Chris@16 8 // File : $RCSfile$
Chris@16 9 //
Chris@101 10 // Version : $Revision$
Chris@16 11 //
Chris@16 12 // Description : defines framework interface
Chris@16 13 // ***************************************************************************
Chris@16 14
Chris@16 15 #ifndef BOOST_TEST_FRAMEWORK_HPP_020805GER
Chris@16 16 #define BOOST_TEST_FRAMEWORK_HPP_020805GER
Chris@16 17
Chris@16 18 // Boost.Test
Chris@16 19 #include <boost/test/detail/global_typedef.hpp>
Chris@16 20 #include <boost/test/detail/fwd_decl.hpp>
Chris@16 21 #include <boost/test/utils/trivial_singleton.hpp>
Chris@16 22
Chris@16 23 #include <boost/test/detail/suppress_warnings.hpp>
Chris@16 24
Chris@16 25 // STL
Chris@16 26 #include <stdexcept>
Chris@16 27
Chris@16 28 //____________________________________________________________________________//
Chris@16 29
Chris@16 30 namespace boost {
Chris@16 31
Chris@16 32 namespace unit_test {
Chris@16 33
Chris@16 34 // ************************************************************************** //
Chris@16 35 // ************** init_unit_test_func ************** //
Chris@16 36 // ************************************************************************** //
Chris@16 37
Chris@16 38 #ifdef BOOST_TEST_ALTERNATIVE_INIT_API
Chris@16 39 typedef bool (*init_unit_test_func)();
Chris@16 40 #else
Chris@16 41 typedef test_suite* (*init_unit_test_func)( int, char* [] );
Chris@16 42 #endif
Chris@16 43
Chris@16 44 // ************************************************************************** //
Chris@16 45 // ************** framework ************** //
Chris@16 46 // ************************************************************************** //
Chris@16 47
Chris@16 48 namespace framework {
Chris@16 49
Chris@16 50 // initialization
Chris@16 51 BOOST_TEST_DECL void init( init_unit_test_func init_func, int argc, char* argv[] );
Chris@16 52 BOOST_TEST_DECL bool is_initialized();
Chris@16 53
Chris@16 54 // mutation access methods
Chris@16 55 BOOST_TEST_DECL void register_test_unit( test_case* tc );
Chris@16 56 BOOST_TEST_DECL void register_test_unit( test_suite* ts );
Chris@16 57 BOOST_TEST_DECL void deregister_test_unit( test_unit* tu );
Chris@16 58 BOOST_TEST_DECL void clear();
Chris@16 59
Chris@16 60 BOOST_TEST_DECL void register_observer( test_observer& );
Chris@16 61 BOOST_TEST_DECL void deregister_observer( test_observer& );
Chris@16 62 BOOST_TEST_DECL void reset_observers();
Chris@16 63
Chris@16 64 BOOST_TEST_DECL master_test_suite_t& master_test_suite();
Chris@16 65
Chris@16 66 // constant access methods
Chris@16 67 BOOST_TEST_DECL test_case const& current_test_case();
Chris@16 68
Chris@16 69 BOOST_TEST_DECL test_unit& get( test_unit_id, test_unit_type );
Chris@16 70 template<typename UnitType>
Chris@16 71 UnitType& get( test_unit_id id )
Chris@16 72 {
Chris@16 73 return static_cast<UnitType&>( get( id, static_cast<test_unit_type>(UnitType::type) ) );
Chris@16 74 }
Chris@16 75
Chris@16 76 // test initiation
Chris@16 77 BOOST_TEST_DECL void run( test_unit_id = INV_TEST_UNIT_ID, bool continue_test = true );
Chris@16 78 BOOST_TEST_DECL void run( test_unit const*, bool continue_test = true );
Chris@16 79
Chris@16 80 // public test events dispatchers
Chris@16 81 BOOST_TEST_DECL void assertion_result( bool passed );
Chris@16 82 BOOST_TEST_DECL void exception_caught( execution_exception const& );
Chris@16 83 BOOST_TEST_DECL void test_unit_aborted( test_unit const& );
Chris@16 84
Chris@16 85 // ************************************************************************** //
Chris@16 86 // ************** framework errors ************** //
Chris@16 87 // ************************************************************************** //
Chris@16 88
Chris@16 89 struct internal_error : std::runtime_error {
Chris@16 90 internal_error( const_string m ) : std::runtime_error( std::string( m.begin(), m.size() ) ) {}
Chris@16 91 };
Chris@16 92
Chris@16 93 struct setup_error : std::runtime_error {
Chris@16 94 setup_error( const_string m ) : std::runtime_error( std::string( m.begin(), m.size() ) ) {}
Chris@16 95 };
Chris@16 96
Chris@16 97 #define BOOST_TEST_SETUP_ASSERT( cond, msg ) if( cond ) {} else throw unit_test::framework::setup_error( msg )
Chris@16 98
Chris@16 99 struct nothing_to_test {}; // not really an error
Chris@16 100
Chris@16 101 } // namespace framework
Chris@16 102
Chris@16 103 } // unit_test
Chris@16 104
Chris@16 105 } // namespace boost
Chris@16 106
Chris@16 107 //____________________________________________________________________________//
Chris@16 108
Chris@16 109 #include <boost/test/detail/enable_warnings.hpp>
Chris@16 110
Chris@16 111 #endif // BOOST_TEST_FRAMEWORK_HPP_020805GER
Chris@16 112