Chris@16: //  (C) Copyright Gennadiy Rozental 2006-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 portable debug interfaces
Chris@16: // ***************************************************************************
Chris@16: 
Chris@16: #ifndef BOOST_TEST_DEBUG_API_HPP_112006GER
Chris@16: #define BOOST_TEST_DEBUG_API_HPP_112006GER
Chris@16: 
Chris@16: // Boost.Test
Chris@16: #include <boost/test/detail/config.hpp>
Chris@16: #include <boost/test/utils/callback.hpp>
Chris@16: #include <boost/test/utils/basic_cstring/basic_cstring.hpp>
Chris@16: 
Chris@16: // STL
Chris@16: #include <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 debug {
Chris@16: 
Chris@16: // ************************************************************************** //
Chris@16: // **************  check if program is running under debugger  ************** //
Chris@16: // ************************************************************************** //
Chris@16: 
Chris@16: bool BOOST_TEST_DECL under_debugger();
Chris@16: 
Chris@16: // ************************************************************************** //
Chris@16: // **************       cause program to break execution       ************** //
Chris@16: // **************           in debugger at call point          ************** //
Chris@16: // ************************************************************************** //
Chris@16: 
Chris@16: void BOOST_TEST_DECL debugger_break();
Chris@16: 
Chris@16: // ************************************************************************** //
Chris@16: // **************              gui debugger setup              ************** //
Chris@16: // ************************************************************************** //
Chris@16: 
Chris@16: struct dbg_startup_info {
Chris@16:     long                    pid;
Chris@16:     bool                    break_or_continue;
Chris@16:     unit_test::const_string binary_path;
Chris@16:     unit_test::const_string display;
Chris@16:     unit_test::const_string init_done_lock;
Chris@16: };
Chris@16: 
Chris@16: typedef unit_test::callback1<dbg_startup_info const&> dbg_starter;
Chris@16: 
Chris@16: // ************************************************************************** //
Chris@16: // **************                debugger setup                ************** //
Chris@16: // ************************************************************************** //
Chris@16: 
Chris@16: #if BOOST_WORKAROUND( BOOST_MSVC, <1300)
Chris@16: 
Chris@16: std::string BOOST_TEST_DECL set_debugger( unit_test::const_string dbg_id );
Chris@16: 
Chris@16: #else 
Chris@16: 
Chris@16: std::string BOOST_TEST_DECL set_debugger( unit_test::const_string dbg_id, dbg_starter s = dbg_starter() );
Chris@16: 
Chris@16: #endif
Chris@16: 
Chris@16: 
Chris@16: // ************************************************************************** //
Chris@16: // **************    attach debugger to the current process    ************** //
Chris@16: // ************************************************************************** //
Chris@16: 
Chris@16: bool BOOST_TEST_DECL attach_debugger( bool break_or_continue = true );
Chris@16: 
Chris@16: // ************************************************************************** //
Chris@16: // **************   switch on/off detect memory leaks feature  ************** //
Chris@16: // ************************************************************************** //
Chris@16: 
Chris@16: void BOOST_TEST_DECL detect_memory_leaks( bool on_off );
Chris@16: 
Chris@16: // ************************************************************************** //
Chris@16: // **************      cause program to break execution in     ************** //
Chris@16: // **************     debugger at specific allocation point    ************** //
Chris@16: // ************************************************************************** //
Chris@16: 
Chris@16: void BOOST_TEST_DECL break_memory_alloc( long mem_alloc_order_num );
Chris@16: 
Chris@16: } // namespace debug
Chris@16: 
Chris@16: } // namespace boost
Chris@16: 
Chris@16: #include <boost/test/detail/enable_warnings.hpp>
Chris@16: 
Chris@16: #endif