blob: 5536961c677ff7903a9bdb4b021696a75716d6a3 [file] [log] [blame]
// (C) Copyright Gennadiy Rozental 2006-2008.
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// See http://www.boost.org/libs/test for the library home page.
//
// File : $RCSfile$
//
// Version : $Revision: 49312 $
//
// Description : defines portable debug interfaces
// ***************************************************************************
#ifndef NDNBOOST_TEST_DEBUG_API_HPP_112006GER
#define NDNBOOST_TEST_DEBUG_API_HPP_112006GER
// Boost.Test
#include <ndnboost/test/detail/config.hpp>
#include <ndnboost/test/utils/callback.hpp>
#include <ndnboost/test/utils/basic_cstring/basic_cstring.hpp>
// STL
#include <string>
#include <ndnboost/test/detail/suppress_warnings.hpp>
//____________________________________________________________________________//
namespace ndnboost {
namespace debug {
// ************************************************************************** //
// ************** check if program is running under debugger ************** //
// ************************************************************************** //
bool NDNBOOST_TEST_DECL under_debugger();
// ************************************************************************** //
// ************** cause program to break execution ************** //
// ************** in debugger at call point ************** //
// ************************************************************************** //
void NDNBOOST_TEST_DECL debugger_break();
// ************************************************************************** //
// ************** gui debugger setup ************** //
// ************************************************************************** //
struct dbg_startup_info {
long pid;
bool break_or_continue;
unit_test::const_string binary_path;
unit_test::const_string display;
unit_test::const_string init_done_lock;
};
typedef unit_test::callback1<dbg_startup_info const&> dbg_starter;
// ************************************************************************** //
// ************** debugger setup ************** //
// ************************************************************************** //
#if NDNBOOST_WORKAROUND( NDNBOOST_MSVC, <1300)
std::string NDNBOOST_TEST_DECL set_debugger( unit_test::const_string dbg_id );
#else
std::string NDNBOOST_TEST_DECL set_debugger( unit_test::const_string dbg_id, dbg_starter s = dbg_starter() );
#endif
// ************************************************************************** //
// ************** attach debugger to the current process ************** //
// ************************************************************************** //
bool NDNBOOST_TEST_DECL attach_debugger( bool break_or_continue = true );
// ************************************************************************** //
// ************** switch on/off detect memory leaks feature ************** //
// ************************************************************************** //
void NDNBOOST_TEST_DECL detect_memory_leaks( bool on_off );
// ************************************************************************** //
// ************** cause program to break execution in ************** //
// ************** debugger at specific allocation point ************** //
// ************************************************************************** //
void NDNBOOST_TEST_DECL break_memory_alloc( long mem_alloc_order_num );
} // namespace debug
} // namespace ndnboost
#include <ndnboost/test/detail/enable_warnings.hpp>
#endif