annotate DEPENDENCIES/generic/include/boost/test/results_reporter.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 2001-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 class unit_test_result that is responsible for
Chris@16 13 // gathering test results and presenting this information to end-user
Chris@16 14 // ***************************************************************************
Chris@16 15
Chris@16 16 #ifndef BOOST_TEST_RESULTS_REPORTER_HPP_021205GER
Chris@16 17 #define BOOST_TEST_RESULTS_REPORTER_HPP_021205GER
Chris@16 18
Chris@16 19 // Boost.Test
Chris@16 20 #include <boost/test/detail/global_typedef.hpp>
Chris@16 21 #include <boost/test/detail/fwd_decl.hpp>
Chris@16 22
Chris@16 23 // STL
Chris@16 24 #include <iosfwd> // for std::ostream&
Chris@16 25
Chris@16 26 #include <boost/test/detail/suppress_warnings.hpp>
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 namespace results_reporter {
Chris@16 35
Chris@16 36 // ************************************************************************** //
Chris@16 37 // ************** formatter interface ************** //
Chris@16 38 // ************************************************************************** //
Chris@16 39
Chris@16 40 class BOOST_TEST_DECL format {
Chris@16 41 public:
Chris@16 42 // Destructor
Chris@16 43 virtual ~format() {}
Chris@16 44
Chris@16 45 virtual void results_report_start( std::ostream& ostr ) = 0;
Chris@16 46 virtual void results_report_finish( std::ostream& ostr ) = 0;
Chris@16 47
Chris@16 48 virtual void test_unit_report_start( test_unit const&, std::ostream& ostr ) = 0;
Chris@16 49 virtual void test_unit_report_finish( test_unit const&, std::ostream& ostr ) = 0;
Chris@16 50
Chris@16 51 virtual void do_confirmation_report( test_unit const&, std::ostream& ostr ) = 0;
Chris@16 52 };
Chris@16 53
Chris@16 54 // ************************************************************************** //
Chris@16 55 // ************** report configuration ************** //
Chris@16 56 // ************************************************************************** //
Chris@16 57
Chris@16 58 BOOST_TEST_DECL void set_level( report_level );
Chris@16 59 BOOST_TEST_DECL void set_stream( std::ostream& );
Chris@16 60 BOOST_TEST_DECL void set_format( output_format );
Chris@16 61 BOOST_TEST_DECL void set_format( results_reporter::format* );
Chris@16 62
Chris@16 63 BOOST_TEST_DECL std::ostream& get_stream();
Chris@16 64
Chris@16 65 // ************************************************************************** //
Chris@16 66 // ************** report initiation ************** //
Chris@16 67 // ************************************************************************** //
Chris@16 68
Chris@16 69 BOOST_TEST_DECL void make_report( report_level l = INV_REPORT_LEVEL, test_unit_id = INV_TEST_UNIT_ID );
Chris@16 70 inline void confirmation_report( test_unit_id id = INV_TEST_UNIT_ID )
Chris@16 71 { make_report( CONFIRMATION_REPORT, id ); }
Chris@16 72 inline void short_report( test_unit_id id = INV_TEST_UNIT_ID )
Chris@16 73 { make_report( SHORT_REPORT, id ); }
Chris@16 74 inline void detailed_report( test_unit_id id = INV_TEST_UNIT_ID )
Chris@16 75 { make_report( DETAILED_REPORT, id ); }
Chris@16 76
Chris@16 77 } // namespace results_reporter
Chris@16 78
Chris@16 79 } // namespace unit_test
Chris@16 80
Chris@16 81 } // namespace boost
Chris@16 82
Chris@16 83 //____________________________________________________________________________//
Chris@16 84
Chris@16 85 #include <boost/test/detail/enable_warnings.hpp>
Chris@16 86
Chris@16 87 #endif // BOOST_TEST_RESULTS_REPORTER_HPP_021205GER
Chris@16 88