Chris@16: //  (C) Copyright Gennadiy Rozental 2003-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 : 
Chris@16: // ***************************************************************************
Chris@16: 
Chris@16: #ifndef BOOST_TEST_UNIT_TEST_LOG_FORMATTER_HPP_071894GER
Chris@16: #define BOOST_TEST_UNIT_TEST_LOG_FORMATTER_HPP_071894GER
Chris@16: 
Chris@16: // Boost.Test
Chris@16: #include <boost/test/detail/global_typedef.hpp>
Chris@16: #include <boost/test/detail/log_level.hpp>
Chris@16: #include <boost/test/detail/fwd_decl.hpp>
Chris@16: 
Chris@16: #include <boost/test/execution_monitor.hpp>
Chris@16: 
Chris@16: // STL
Chris@16: #include <iosfwd>
Chris@16: #include <string> // for std::string
Chris@16: 
Chris@16: #include <boost/test/detail/suppress_warnings.hpp>
Chris@16: 
Chris@16: //____________________________________________________________________________//
Chris@16: 
Chris@16: namespace boost {
Chris@16: 
Chris@16: namespace unit_test {
Chris@16: 
Chris@16: // ************************************************************************** //
Chris@16: // **************                log_entry_data                ************** //
Chris@16: // ************************************************************************** //
Chris@16: 
Chris@16: struct BOOST_TEST_DECL log_entry_data {
Chris@16:     log_entry_data()
Chris@16:     {
Chris@16:         m_file_name.reserve( 200 );
Chris@16:     }
Chris@16: 
Chris@16:     std::string     m_file_name;
Chris@16:     std::size_t     m_line_num;
Chris@16:     log_level       m_level;
Chris@16: 
Chris@16:     void clear()
Chris@16:     {
Chris@16:         m_file_name.erase();
Chris@16:         m_line_num      = 0;
Chris@16:         m_level     = log_nothing;
Chris@16:     }
Chris@16: };
Chris@16: 
Chris@16: // ************************************************************************** //
Chris@16: // **************                checkpoint_data               ************** //
Chris@16: // ************************************************************************** //
Chris@16: 
Chris@16: struct BOOST_TEST_DECL log_checkpoint_data
Chris@16: {
Chris@16:     const_string    m_file_name;
Chris@16:     std::size_t     m_line_num;
Chris@16:     std::string     m_message;
Chris@16: 
Chris@16:     void clear()
Chris@16:     {
Chris@16:         m_file_name.clear();
Chris@16:         m_line_num    = 0;
Chris@16:         m_message = std::string();
Chris@16:     }
Chris@16: };
Chris@16: 
Chris@16: // ************************************************************************** //
Chris@16: // **************            unit_test_log_formatter           ************** //
Chris@16: // ************************************************************************** //
Chris@16: 
Chris@16: class BOOST_TEST_DECL unit_test_log_formatter {
Chris@16: public:
Chris@16:     enum log_entry_types { BOOST_UTL_ET_INFO, 
Chris@16:                            BOOST_UTL_ET_MESSAGE,
Chris@16:                            BOOST_UTL_ET_WARNING,
Chris@16:                            BOOST_UTL_ET_ERROR,
Chris@16:                            BOOST_UTL_ET_FATAL_ERROR };
Chris@16: 
Chris@16:     // Destructor
Chris@16:     virtual             ~unit_test_log_formatter() {}
Chris@16: 
Chris@16:     // Formatter interface
Chris@16:     virtual void        log_start( std::ostream&, counter_t test_cases_amount ) = 0;
Chris@16:     virtual void        log_finish( std::ostream& ) = 0;
Chris@16:     virtual void        log_build_info( std::ostream& ) = 0;
Chris@16: 
Chris@16:     virtual void        test_unit_start( std::ostream&, test_unit const& tu ) = 0;
Chris@16:     virtual void        test_unit_finish( std::ostream&, test_unit const& tu, unsigned long elapsed ) = 0;
Chris@16:     virtual void        test_unit_skipped( std::ostream&, test_unit const& ) = 0;
Chris@16: 
Chris@16:     virtual void        log_exception( std::ostream& os, log_checkpoint_data const& cd, execution_exception const& ex )
Chris@16:     {
Chris@16:         // for backward compatibility
Chris@16:         log_exception( os, cd, ex.what() );
Chris@16:     }
Chris@16:     virtual void        log_exception( std::ostream&, log_checkpoint_data const&, const_string /* explanation */ ) {}
Chris@16: 
Chris@16:     virtual void        log_entry_start( std::ostream&, log_entry_data const&, log_entry_types let ) = 0;
Chris@16:     virtual void        log_entry_value( std::ostream&, const_string value ) = 0;
Chris@16:     virtual void        log_entry_value( std::ostream&, lazy_ostream const& value ); // there is a default impl
Chris@16:     virtual void        log_entry_finish( std::ostream& ) = 0;
Chris@16: };
Chris@16: 
Chris@16: } // namespace 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_UNIT_TEST_LOG_FORMATTER_HPP_071894GER
Chris@16: