1 // (C) Copyright Gennadiy Rozental 2001.
2 // Distributed under the Boost Software License, Version 1.0.
3 // (See accompanying file LICENSE_1_0.txt or copy at
4 // http://www.boost.org/LICENSE_1_0.txt)
6 // See http://www.boost.org/libs/test for the library home page.
10 // Version : $Revision: 81247 $
12 // Description : contains definition for all test tools in test toolbox
13 // ***************************************************************************
15 #ifndef BOOST_TEST_TOOLS_INTERFACE_HPP_111712GER
16 #define BOOST_TEST_TOOLS_INTERFACE_HPP_111712GER
19 #include <boost/test/unit_test_log.hpp>
20 #ifdef BOOST_TEST_TOOLS_DEBUGGABLE
21 #include <boost/test/debug.hpp>
23 #ifdef BOOST_NO_CXX11_AUTO_DECLARATIONS
24 #include <boost/test/tools/detail/expression_holder.hpp>
27 #include <boost/test/detail/pp_variadic.hpp>
29 #ifdef BOOST_TEST_NO_OLD_TOOLS
30 #include <boost/preprocessor/seq/to_tuple.hpp>
33 #endif // BOOST_TEST_NO_OLD_TOOLS
35 #include <boost/test/detail/suppress_warnings.hpp>
37 //____________________________________________________________________________//
39 // ************************************************************************** //
40 // ************** BOOST_TEST_<level> ************** //
41 // ************************************************************************** //
43 #define BOOST_TEST_BUILD_ASSERTION( P ) \
44 (::boost::test_tools::assertion::seed()->*P) \
47 //____________________________________________________________________________//
49 // Implementation based on direct predicate evaluation
50 #define BOOST_TEST_TOOL_DIRECT_IMPL( P, level, M ) \
52 ::boost::test_tools::assertion_result res = (P); \
55 BOOST_TEST_LAZY_MSG( M ), \
56 BOOST_TEST_L(__FILE__), \
57 static_cast<std::size_t>(__LINE__), \
58 ::boost::test_tools::tt_detail::level, \
59 ::boost::test_tools::tt_detail::CHECK_MSG, \
61 } while( ::boost::test_tools::tt_detail::dummy_cond() ) \
64 //____________________________________________________________________________//
66 // Implementation based on expression template construction
67 #define BOOST_TEST_TOOL_ET_IMPL( P, level ) \
69 BOOST_TEST_PASSPOINT(); \
71 ::boost::test_tools::tt_detail:: \
73 BOOST_TEST_BUILD_ASSERTION( P ).evaluate(), \
74 BOOST_TEST_LAZY_MSG( BOOST_TEST_STRINGIZE( P ) ), \
75 BOOST_TEST_L(__FILE__), \
76 static_cast<std::size_t>(__LINE__), \
77 ::boost::test_tools::tt_detail::level, \
78 ::boost::test_tools::tt_detail::CHECK_BUILT_ASSERTION, \
80 } while( ::boost::test_tools::tt_detail::dummy_cond() ) \
83 //____________________________________________________________________________//
85 // Implementation based on expression template construction with extra tool arguments
86 #define BOOST_TEST_TOOL_ET_IMPL_EX( P, level, arg ) \
88 BOOST_TEST_PASSPOINT(); \
90 ::boost::test_tools::tt_detail:: \
92 ::boost::test_tools::tt_detail::assertion_evaluate( \
93 BOOST_TEST_BUILD_ASSERTION( P ) ) \
95 ::boost::test_tools::tt_detail::assertion_text( \
96 BOOST_TEST_LAZY_MSG( BOOST_TEST_STRINGIZE(P) ), \
97 BOOST_TEST_LAZY_MSG( arg ) ), \
98 BOOST_TEST_L(__FILE__), \
99 static_cast<std::size_t>(__LINE__), \
100 ::boost::test_tools::tt_detail::level, \
101 ::boost::test_tools::tt_detail::assertion_type() \
104 } while( ::boost::test_tools::tt_detail::dummy_cond() ) \
107 //____________________________________________________________________________//
109 #ifdef BOOST_TEST_TOOLS_UNDER_DEBUGGER
111 #define BOOST_TEST_TOOL_UNIV( level, P ) \
112 BOOST_TEST_TOOL_DIRECT_IMPL( P, level, BOOST_TEST_STRINGIZE( P ) ) \
115 #define BOOST_TEST_TOOL_UNIV_EX( level, P, ... ) \
116 BOOST_TEST_TOOL_UNIV( level, P ) \
119 #elif defined(BOOST_TEST_TOOLS_DEBUGGABLE)
121 #define BOOST_TEST_TOOL_UNIV( level, P ) \
123 if( ::boost::debug::under_debugger() ) \
124 BOOST_TEST_TOOL_DIRECT_IMPL( P, level, BOOST_TEST_STRINGIZE( P ) ); \
126 BOOST_TEST_TOOL_ET_IMPL( P, level ); \
127 } while( ::boost::test_tools::tt_detail::dummy_cond() ) \
130 #define BOOST_TEST_TOOL_UNIV_EX( level, P, ... ) \
131 BOOST_TEST_TOOL_UNIV( level, P ) \
136 #define BOOST_TEST_TOOL_UNIV( level, P ) \
137 BOOST_TEST_TOOL_ET_IMPL( P, level ) \
140 #define BOOST_TEST_TOOL_UNIV_EX( level, P, ... ) \
141 BOOST_TEST_TOOL_ET_IMPL_EX( P, level, __VA_ARGS__ ) \
146 //____________________________________________________________________________//
148 #define BOOST_TEST_WARN( ... ) BOOST_TEST_INVOKE_IF_N_ARGS( \
149 2, BOOST_TEST_TOOL_UNIV, BOOST_TEST_TOOL_UNIV_EX, WARN, __VA_ARGS__ ) \
151 #define BOOST_TEST_CHECK( ... ) BOOST_TEST_INVOKE_IF_N_ARGS( \
152 2, BOOST_TEST_TOOL_UNIV, BOOST_TEST_TOOL_UNIV_EX, CHECK, __VA_ARGS__ ) \
154 #define BOOST_TEST_REQUIRE( ... ) BOOST_TEST_INVOKE_IF_N_ARGS( \
155 2, BOOST_TEST_TOOL_UNIV, BOOST_TEST_TOOL_UNIV_EX, REQUIRE, __VA_ARGS__ )\
158 #define BOOST_TEST( ... ) BOOST_TEST_INVOKE_IF_N_ARGS( \
159 2, BOOST_TEST_TOOL_UNIV, BOOST_TEST_TOOL_UNIV_EX, CHECK, __VA_ARGS__ ) \
162 //____________________________________________________________________________//
164 #define BOOST_TEST_ERROR( M ) BOOST_CHECK_MESSAGE( false, M )
165 #define BOOST_TEST_FAIL( M ) BOOST_REQUIRE_MESSAGE( false, M )
167 //____________________________________________________________________________//
169 #define BOOST_TEST_IS_DEFINED( symb ) ::boost::test_tools::tt_detail::is_defined_impl( symb, BOOST_STRINGIZE(= symb) )
171 //____________________________________________________________________________//
173 #ifdef BOOST_TEST_NO_OLD_TOOLS
175 #ifdef BOOST_TEST_TOOLS_UNDER_DEBUGGER
177 #define BOOST_CHECK_THROW_IMPL(S, E, TL, Ppassed, Mpassed, Pcaught, Mcaught)\
180 BOOST_TEST_TOOL_DIRECT_IMPL( Ppassed, TL, Mpassed ); \
182 BOOST_TEST_TOOL_DIRECT_IMPL( Pcaught, TL, Mcaught ); \
183 }} while( ::boost::test_tools::tt_detail::dummy_cond() ) \
186 #elif defined(BOOST_TEST_TOOLS_DEBUGGABLE)
188 #define BOOST_CHECK_THROW_IMPL(S, E, TL, Ppassed, Mpassed, Pcaught, Mcaught)\
190 if( ::boost::debug::under_debugger() ) \
191 BOOST_TEST_PASSPOINT(); \
193 BOOST_TEST_TOOL_DIRECT_IMPL( Ppassed, TL, Mpassed ); \
195 BOOST_TEST_TOOL_DIRECT_IMPL( Pcaught, TL, Mcaught ); \
196 }} while( ::boost::test_tools::tt_detail::dummy_cond() ) \
201 #define BOOST_CHECK_THROW_IMPL(S, E, TL, Ppassed, Mpassed, Pcaught, Mcaught)\
203 BOOST_TEST_PASSPOINT(); \
205 BOOST_TEST_TOOL_DIRECT_IMPL( Ppassed, TL, Mpassed ); \
207 BOOST_TEST_TOOL_DIRECT_IMPL( Pcaught, TL, Mcaught ); \
208 }} while( ::boost::test_tools::tt_detail::dummy_cond() ) \
213 //____________________________________________________________________________//
215 #define BOOST_WARN_THROW( S, E ) \
216 BOOST_CHECK_THROW_IMPL(S, E const&, WARN, \
217 false, "exception " BOOST_STRINGIZE(E) " is expected", \
218 true , "exception " BOOST_STRINGIZE(E) " is caught" ) \
220 #define BOOST_CHECK_THROW( S, E ) \
221 BOOST_CHECK_THROW_IMPL(S, E const&, CHECK, \
222 false, "exception " BOOST_STRINGIZE(E) " is expected", \
223 true , "exception " BOOST_STRINGIZE(E) " is caught" ) \
225 #define BOOST_REQUIRE_THROW( S, E ) \
226 BOOST_CHECK_THROW_IMPL(S, E const&, REQUIRE, \
227 false, "exception " BOOST_STRINGIZE(E) " is expected", \
228 true , "exception " BOOST_STRINGIZE(E) " is caught" ) \
231 //____________________________________________________________________________//
233 #define BOOST_WARN_EXCEPTION( S, E, P ) \
234 BOOST_CHECK_THROW_IMPL(S, E const& ex, WARN, \
235 false, "exception " BOOST_STRINGIZE(E) " is expected", \
236 P(ex), "incorrect exception " BOOST_STRINGIZE(E) " is caught" ) \
238 #define BOOST_CHECK_EXCEPTION( S, E, P ) \
239 BOOST_CHECK_THROW_IMPL(S, E const& ex, CHECK, \
240 false, "exception " BOOST_STRINGIZE(E) " is expected", \
241 P(ex), "incorrect exception " BOOST_STRINGIZE(E) " is caught" ) \
243 #define BOOST_REQUIRE_EXCEPTION( S, E, P ) \
244 BOOST_CHECK_THROW_IMPL(S, E const& ex, REQUIRE, \
245 false, "exception " BOOST_STRINGIZE(E) " is expected", \
246 P(ex), "incorrect exception " BOOST_STRINGIZE(E) " is caught" ) \
249 //____________________________________________________________________________//
251 #define BOOST_WARN_NO_THROW( S ) \
252 BOOST_CHECK_THROW_IMPL(S, ..., WARN, \
253 true , "no exceptions thrown by " BOOST_STRINGIZE( S ), \
254 false, "exception thrown by " BOOST_STRINGIZE( S ) ) \
256 #define BOOST_CHECK_NO_THROW( S ) \
257 BOOST_CHECK_THROW_IMPL(S, ..., CHECK, \
258 true , "no exceptions thrown by " BOOST_STRINGIZE( S ), \
259 false, "exception thrown by " BOOST_STRINGIZE( S ) ) \
261 #define BOOST_REQUIRE_NO_THROW( S ) \
262 BOOST_CHECK_THROW_IMPL(S, ..., REQUIRE, \
263 true , "no exceptions thrown by " BOOST_STRINGIZE( S ), \
264 false, "exception thrown by " BOOST_STRINGIZE( S ) ) \
267 //____________________________________________________________________________//
269 #define BOOST_WARN_MESSAGE( P, M ) BOOST_TEST_TOOL_DIRECT_IMPL( P, WARN, M )
270 #define BOOST_CHECK_MESSAGE( P, M ) BOOST_TEST_TOOL_DIRECT_IMPL( P, CHECK, M )
271 #define BOOST_REQUIRE_MESSAGE( P, M ) BOOST_TEST_TOOL_DIRECT_IMPL( P, REQUIRE, M )
273 //____________________________________________________________________________//
275 ////////////////////////////////////////////////////////////////////////////////
276 ///////////////////////////// DEPRECATED TOOLS /////////////////////////////
278 #define BOOST_WARN( P ) BOOST_TEST_WARN( P )
279 #define BOOST_CHECK( P ) BOOST_TEST_CHECK( P )
280 #define BOOST_REQUIRE( P ) BOOST_TEST_REQUIRE( P )
282 //____________________________________________________________________________//
284 #define BOOST_ERROR( M ) BOOST_TEST_ERROR( M )
285 #define BOOST_FAIL( M ) BOOST_TEST_FAIL( M )
287 //____________________________________________________________________________//
289 #define BOOST_WARN_EQUAL( L, R ) BOOST_TEST_WARN( L == R )
290 #define BOOST_CHECK_EQUAL( L, R ) BOOST_TEST_CHECK( L == R )
291 #define BOOST_REQUIRE_EQUAL( L, R ) BOOST_TEST_REQUIRE( L == R )
293 #define BOOST_WARN_NE( L, R ) BOOST_TEST_WARN( L != R )
294 #define BOOST_CHECK_NE( L, R ) BOOST_TEST_CHECK( L != R )
295 #define BOOST_REQUIRE_NE( L, R ) BOOST_TEST_REQUIRE( L != R )
297 #define BOOST_WARN_LT( L, R ) BOOST_TEST_WARN( L < R )
298 #define BOOST_CHECK_LT( L, R ) BOOST_TEST_CHECK( L < R )
299 #define BOOST_REQUIRE_LT( L, R ) BOOST_TEST_REQUIRE( L < R )
301 #define BOOST_WARN_LE( L, R ) BOOST_TEST_WARN( L <= R )
302 #define BOOST_CHECK_LE( L, R ) BOOST_TEST_CHECK( L <= R )
303 #define BOOST_REQUIRE_LE( L, R ) BOOST_TEST_REQUIRE( L <= R )
305 #define BOOST_WARN_GT( L, R ) BOOST_TEST_WARN( L > R )
306 #define BOOST_CHECK_GT( L, R ) BOOST_TEST_CHECK( L > R )
307 #define BOOST_REQUIRE_GT( L, R ) BOOST_TEST_REQUIRE( L > R )
309 #define BOOST_WARN_GE( L, R ) BOOST_TEST_WARN( L >= R )
310 #define BOOST_CHECK_GE( L, R ) BOOST_TEST_CHECK( L >= R )
311 #define BOOST_REQUIRE_GE( L, R ) BOOST_TEST_REQUIRE( L >= R )
313 //____________________________________________________________________________//
315 #define BOOST_WARN_CLOSE( L, R, T ) BOOST_TEST_WARN( L == R, T % ::boost::test_tools::tolerance() )
316 #define BOOST_CHECK_CLOSE( L, R, T ) BOOST_TEST_CHECK( L == R, T % ::boost::test_tools::tolerance() )
317 #define BOOST_REQUIRE_CLOSE( L, R, T ) BOOST_TEST_REQUIRE( L == R, T % ::boost::test_tools::tolerance() )
319 #define BOOST_WARN_CLOSE_FRACTION(L, R, T) BOOST_TEST_WARN( L == R, ::boost::test_tools::tolerance( T ) )
320 #define BOOST_CHECK_CLOSE_FRACTION(L, R, T) BOOST_TEST_CHECK( L == R, ::boost::test_tools::tolerance( T ) )
321 #define BOOST_REQUIRE_CLOSE_FRACTION(L,R,T) BOOST_TEST_REQUIRE( L == R, ::boost::test_tools::tolerance( T ) )
323 #define BOOST_WARN_SMALL( FPV, T ) BOOST_TEST_WARN( FPV == 0., ::boost::test_tools::tolerance( T ) )
324 #define BOOST_CHECK_SMALL( FPV, T ) BOOST_TEST_CHECK( FPV == 0., ::boost::test_tools::tolerance( T ) )
325 #define BOOST_REQUIRE_SMALL( FPV, T ) BOOST_TEST_REQUIRE( FPV == 0., ::boost::test_tools::tolerance( T ) )
327 //____________________________________________________________________________//
329 #define BOOST_WARN_EQUAL_COLLECTIONS( L_begin, L_end, R_begin, R_end ) \
330 BOOST_TEST_WARN( ::boost::test_tools::tt_detail::make_it_pair(L_begin, L_end) ==\
331 ::boost::test_tools::tt_detail::make_it_pair(R_begin, R_end), \
332 ::boost::test_tools::per_element() ) \
335 #define BOOST_CHECK_EQUAL_COLLECTIONS( L_begin, L_end, R_begin, R_end ) \
336 BOOST_TEST_CHECK( ::boost::test_tools::tt_detail::make_it_pair(L_begin, L_end) ==\
337 ::boost::test_tools::tt_detail::make_it_pair(R_begin, R_end), \
338 ::boost::test_tools::per_element() ) \
341 #define BOOST_REQUIRE_EQUAL_COLLECTIONS( L_begin, L_end, R_begin, R_end ) \
342 BOOST_TEST_REQUIRE( ::boost::test_tools::tt_detail::make_it_pair(L_begin, L_end) ==\
343 ::boost::test_tools::tt_detail::make_it_pair(R_begin, R_end), \
344 ::boost::test_tools::per_element() ) \
347 //____________________________________________________________________________//
349 #define BOOST_WARN_BITWISE_EQUAL( L, R ) BOOST_TEST_WARN( L == R, ::boost::test_tools::bitwise() )
350 #define BOOST_CHECK_BITWISE_EQUAL( L, R ) BOOST_TEST_CHECK( L == R, ::boost::test_tools::bitwise() )
351 #define BOOST_REQUIRE_BITWISE_EQUAL( L, R ) BOOST_TEST_REQUIRE( L == R, ::boost::test_tools::bitwise() )
353 //____________________________________________________________________________//
355 #define BOOST_WARN_PREDICATE( P, ARGS ) BOOST_TEST_WARN( P BOOST_PP_SEQ_TO_TUPLE(ARGS) )
356 #define BOOST_CHECK_PREDICATE( P, ARGS ) BOOST_TEST_CHECK( P BOOST_PP_SEQ_TO_TUPLE(ARGS) )
357 #define BOOST_REQUIRE_PREDICATE( P, ARGS ) BOOST_TEST_REQUIRE( P BOOST_PP_SEQ_TO_TUPLE(ARGS) )
359 //____________________________________________________________________________//
361 #define BOOST_IS_DEFINED( symb ) ::boost::test_tools::tt_detail::is_defined_impl( #symb, BOOST_STRINGIZE(= symb) )
363 //____________________________________________________________________________//
365 #endif // BOOST_TEST_NO_OLD_TOOLS
367 #include <boost/test/detail/enable_warnings.hpp>
369 #endif // BOOST_TEST_TOOLS_INTERFACE_HPP_111712GER