Chris@16: //  (C) Copyright Gennadiy Rozental 2005-2008.
Chris@16: //  Distributed under the Boost Software License, Version 1.0.
Chris@16: //  (See accompanying file LICENSE_1_0.txt or copy at 
Chris@16: //  http://www.boost.org/LICENSE_1_0.txt)
Chris@16: 
Chris@16: //  See http://www.boost.org/libs/test for the library home page.
Chris@16: //
Chris@16: //  File        : $RCSfile$
Chris@16: //
Chris@101: //  Version     : $Revision$
Chris@16: //
Chris@16: //  Description : defines framework interface
Chris@16: // ***************************************************************************
Chris@16: 
Chris@16: #ifndef BOOST_TEST_FRAMEWORK_HPP_020805GER
Chris@16: #define BOOST_TEST_FRAMEWORK_HPP_020805GER
Chris@16: 
Chris@16: // Boost.Test
Chris@16: #include <boost/test/detail/global_typedef.hpp>
Chris@16: #include <boost/test/detail/fwd_decl.hpp>
Chris@16: #include <boost/test/utils/trivial_singleton.hpp>
Chris@16: 
Chris@16: #include <boost/test/detail/suppress_warnings.hpp>
Chris@16: 
Chris@16: // STL
Chris@16: #include <stdexcept>
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: namespace boost {
Chris@16: 
Chris@16: namespace unit_test {
Chris@16: 
Chris@16: // ************************************************************************** //
Chris@16: // **************              init_unit_test_func             ************** //
Chris@16: // ************************************************************************** //
Chris@16: 
Chris@16: #ifdef BOOST_TEST_ALTERNATIVE_INIT_API
Chris@16: typedef bool        (*init_unit_test_func)();
Chris@16: #else
Chris@16: typedef test_suite* (*init_unit_test_func)( int, char* [] );
Chris@16: #endif
Chris@16: 
Chris@16: // ************************************************************************** //
Chris@16: // **************                   framework                  ************** //
Chris@16: // ************************************************************************** //
Chris@16: 
Chris@16: namespace framework {
Chris@16: 
Chris@16: // initialization
Chris@16: BOOST_TEST_DECL void    init( init_unit_test_func init_func, int argc, char* argv[] );
Chris@16: BOOST_TEST_DECL bool    is_initialized();
Chris@16: 
Chris@16: // mutation access methods
Chris@16: BOOST_TEST_DECL void    register_test_unit( test_case* tc );
Chris@16: BOOST_TEST_DECL void    register_test_unit( test_suite* ts );
Chris@16: BOOST_TEST_DECL void    deregister_test_unit( test_unit* tu );
Chris@16: BOOST_TEST_DECL void    clear();
Chris@16: 
Chris@16: BOOST_TEST_DECL void    register_observer( test_observer& );
Chris@16: BOOST_TEST_DECL void    deregister_observer( test_observer& );
Chris@16: BOOST_TEST_DECL void    reset_observers();
Chris@16: 
Chris@16: BOOST_TEST_DECL master_test_suite_t& master_test_suite();
Chris@16: 
Chris@16: // constant access methods
Chris@16: BOOST_TEST_DECL test_case const&    current_test_case();
Chris@16: 
Chris@16: BOOST_TEST_DECL test_unit&  get( test_unit_id, test_unit_type );
Chris@16: template<typename UnitType>
Chris@16: UnitType&               get( test_unit_id id )
Chris@16: {
Chris@16:     return static_cast<UnitType&>( get( id, static_cast<test_unit_type>(UnitType::type) ) );
Chris@16: }
Chris@16: 
Chris@16: // test initiation
Chris@16: BOOST_TEST_DECL void    run( test_unit_id = INV_TEST_UNIT_ID, bool continue_test = true );
Chris@16: BOOST_TEST_DECL void    run( test_unit const*, bool continue_test = true );
Chris@16: 
Chris@16: // public test events dispatchers
Chris@16: BOOST_TEST_DECL void    assertion_result( bool passed );
Chris@16: BOOST_TEST_DECL void    exception_caught( execution_exception const& );
Chris@16: BOOST_TEST_DECL void    test_unit_aborted( test_unit const& );
Chris@16: 
Chris@16: // ************************************************************************** //
Chris@16: // **************                framework errors              ************** //
Chris@16: // ************************************************************************** //
Chris@16: 
Chris@16: struct internal_error : std::runtime_error {
Chris@16:     internal_error( const_string m ) : std::runtime_error( std::string( m.begin(), m.size() ) ) {}
Chris@16: };
Chris@16: 
Chris@16: struct setup_error : std::runtime_error {
Chris@16:     setup_error( const_string m ) : std::runtime_error( std::string( m.begin(), m.size() ) ) {}
Chris@16: };
Chris@16: 
Chris@16: #define BOOST_TEST_SETUP_ASSERT( cond, msg ) if( cond ) {} else throw unit_test::framework::setup_error( msg )
Chris@16: 
Chris@16: struct nothing_to_test {}; // not really an error
Chris@16: 
Chris@16: } // namespace framework
Chris@16: 
Chris@16: } // unit_test
Chris@16: 
Chris@16: } // namespace boost
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: #include <boost/test/detail/enable_warnings.hpp>
Chris@16: 
Chris@16: #endif // BOOST_TEST_FRAMEWORK_HPP_020805GER
Chris@16: