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>
24 #include <boost/test/detail/pp_variadic.hpp>
26 #ifdef BOOST_TEST_NO_OLD_TOOLS
27 #include <boost/preprocessor/seq/to_tuple.hpp>
30 #endif // BOOST_TEST_NO_OLD_TOOLS
32 #include <boost/test/detail/suppress_warnings.hpp>
34 //____________________________________________________________________________//
36 // ************************************************************************** //
37 // ************** BOOST_TEST_<level> ************** //
38 // ************************************************************************** //
40 #define BOOST_TEST_BUILD_ASSERTION( P ) \
41 (::boost::test_tools::assertion::seed()->*P) \
44 //____________________________________________________________________________//
46 // Implementation based on direct predicate evaluation
47 #define BOOST_TEST_TOOL_DIRECT_IMPL( P, level, M ) \
49 ::boost::test_tools::assertion_result res = (P); \
52 BOOST_TEST_LAZY_MSG( M ), \
53 BOOST_TEST_L(__FILE__), \
54 static_cast<std::size_t>(__LINE__), \
55 ::boost::test_tools::tt_detail::level, \
56 ::boost::test_tools::tt_detail::CHECK_MSG, \
58 } while( ::boost::test_tools::tt_detail::dummy_cond() ) \
61 //____________________________________________________________________________//
63 // Implementation based on expression template construction
64 #define BOOST_TEST_TOOL_ET_IMPL( P, level ) \
66 BOOST_TEST_PASSPOINT(); \
68 ::boost::test_tools::tt_detail:: \
70 BOOST_TEST_BUILD_ASSERTION( P ).evaluate(), \
71 BOOST_TEST_LAZY_MSG( BOOST_TEST_STRINGIZE( P ) ), \
72 BOOST_TEST_L(__FILE__), \
73 static_cast<std::size_t>(__LINE__), \
74 ::boost::test_tools::tt_detail::level, \
75 ::boost::test_tools::tt_detail::CHECK_BUILT_ASSERTION, \
77 } while( ::boost::test_tools::tt_detail::dummy_cond() ) \
80 //____________________________________________________________________________//
82 // Implementation based on expression template construction with extra tool arguments
83 #define BOOST_TEST_TOOL_ET_IMPL_EX( P, level, arg ) \
85 BOOST_TEST_PASSPOINT(); \
87 ::boost::test_tools::tt_detail:: \
89 ::boost::test_tools::tt_detail::assertion_evaluate( \
90 BOOST_TEST_BUILD_ASSERTION( P ) ) \
92 ::boost::test_tools::tt_detail::assertion_text( \
93 BOOST_TEST_LAZY_MSG( BOOST_TEST_STRINGIZE(P) ), \
94 BOOST_TEST_LAZY_MSG( arg ) ), \
95 BOOST_TEST_L(__FILE__), \
96 static_cast<std::size_t>(__LINE__), \
97 ::boost::test_tools::tt_detail::level, \
98 ::boost::test_tools::tt_detail::assertion_type() \
101 } while( ::boost::test_tools::tt_detail::dummy_cond() ) \
104 //____________________________________________________________________________//
106 #ifdef BOOST_TEST_TOOLS_UNDER_DEBUGGER
108 #define BOOST_TEST_TOOL_UNIV( level, P ) \
109 BOOST_TEST_TOOL_DIRECT_IMPL( P, level, BOOST_TEST_STRINGIZE( P ) ) \
112 #define BOOST_TEST_TOOL_UNIV_EX( level, P, ... ) \
113 BOOST_TEST_TOOL_UNIV( level, P ) \
116 #elif defined(BOOST_TEST_TOOLS_DEBUGGABLE)
118 #define BOOST_TEST_TOOL_UNIV( level, P ) \
120 if( ::boost::debug::under_debugger() ) \
121 BOOST_TEST_TOOL_DIRECT_IMPL( P, level, BOOST_TEST_STRINGIZE( P ) ); \
123 BOOST_TEST_TOOL_ET_IMPL( P, level ); \
124 } while( ::boost::test_tools::tt_detail::dummy_cond() ) \
127 #define BOOST_TEST_TOOL_UNIV_EX( level, P, ... ) \
128 BOOST_TEST_TOOL_UNIV( level, P ) \
133 #define BOOST_TEST_TOOL_UNIV( level, P ) \
134 BOOST_TEST_TOOL_ET_IMPL( P, level ) \
137 #define BOOST_TEST_TOOL_UNIV_EX( level, P, ... ) \
138 BOOST_TEST_TOOL_ET_IMPL_EX( P, level, __VA_ARGS__ ) \
143 //____________________________________________________________________________//
145 #define BOOST_TEST_WARN( ... ) BOOST_TEST_INVOKE_IF_N_ARGS( \
146 2, BOOST_TEST_TOOL_UNIV, BOOST_TEST_TOOL_UNIV_EX, WARN, __VA_ARGS__ ) \
148 #define BOOST_TEST_CHECK( ... ) BOOST_TEST_INVOKE_IF_N_ARGS( \
149 2, BOOST_TEST_TOOL_UNIV, BOOST_TEST_TOOL_UNIV_EX, CHECK, __VA_ARGS__ ) \
151 #define BOOST_TEST_REQUIRE( ... ) BOOST_TEST_INVOKE_IF_N_ARGS( \
152 2, BOOST_TEST_TOOL_UNIV, BOOST_TEST_TOOL_UNIV_EX, REQUIRE, __VA_ARGS__ )\
155 #define BOOST_TEST( ... ) BOOST_TEST_INVOKE_IF_N_ARGS( \
156 2, BOOST_TEST_TOOL_UNIV, BOOST_TEST_TOOL_UNIV_EX, CHECK, __VA_ARGS__ ) \
159 //____________________________________________________________________________//
161 #define BOOST_TEST_ERROR( M ) BOOST_CHECK_MESSAGE( false, M )
162 #define BOOST_TEST_FAIL( M ) BOOST_REQUIRE_MESSAGE( false, M )
164 //____________________________________________________________________________//
166 #define BOOST_TEST_IS_DEFINED( symb ) ::boost::test_tools::tt_detail::is_defined_impl( symb, BOOST_STRINGIZE(= symb) )
168 //____________________________________________________________________________//
170 #ifdef BOOST_TEST_NO_OLD_TOOLS
172 #ifdef BOOST_TEST_TOOLS_UNDER_DEBUGGER
174 #define BOOST_CHECK_THROW_IMPL(S, E, TL, Ppassed, Mpassed, Pcaught, Mcaught)\
177 BOOST_TEST_TOOL_DIRECT_IMPL( Ppassed, TL, Mpassed ); \
179 BOOST_TEST_TOOL_DIRECT_IMPL( Pcaught, TL, Mcaught ); \
180 }} while( ::boost::test_tools::tt_detail::dummy_cond() ) \
183 #elif defined(BOOST_TEST_TOOLS_DEBUGGABLE)
185 #define BOOST_CHECK_THROW_IMPL(S, E, TL, Ppassed, Mpassed, Pcaught, Mcaught)\
187 if( ::boost::debug::under_debugger() ) \
188 BOOST_TEST_PASSPOINT(); \
190 BOOST_TEST_TOOL_DIRECT_IMPL( Ppassed, TL, Mpassed ); \
192 BOOST_TEST_TOOL_DIRECT_IMPL( Pcaught, TL, Mcaught ); \
193 }} while( ::boost::test_tools::tt_detail::dummy_cond() ) \
198 #define BOOST_CHECK_THROW_IMPL(S, E, TL, Ppassed, Mpassed, Pcaught, Mcaught)\
200 BOOST_TEST_PASSPOINT(); \
202 BOOST_TEST_TOOL_DIRECT_IMPL( Ppassed, TL, Mpassed ); \
204 BOOST_TEST_TOOL_DIRECT_IMPL( Pcaught, TL, Mcaught ); \
205 }} while( ::boost::test_tools::tt_detail::dummy_cond() ) \
210 //____________________________________________________________________________//
212 #define BOOST_WARN_THROW( S, E ) \
213 BOOST_CHECK_THROW_IMPL(S, E const&, WARN, \
214 false, "exception " BOOST_STRINGIZE(E) " is expected", \
215 true , "exception " BOOST_STRINGIZE(E) " is caught" ) \
217 #define BOOST_CHECK_THROW( S, E ) \
218 BOOST_CHECK_THROW_IMPL(S, E const&, CHECK, \
219 false, "exception " BOOST_STRINGIZE(E) " is expected", \
220 true , "exception " BOOST_STRINGIZE(E) " is caught" ) \
222 #define BOOST_REQUIRE_THROW( S, E ) \
223 BOOST_CHECK_THROW_IMPL(S, E const&, REQUIRE, \
224 false, "exception " BOOST_STRINGIZE(E) " is expected", \
225 true , "exception " BOOST_STRINGIZE(E) " is caught" ) \
228 //____________________________________________________________________________//
230 #define BOOST_WARN_EXCEPTION( S, E, P ) \
231 BOOST_CHECK_THROW_IMPL(S, E const& ex, WARN, \
232 false, "exception " BOOST_STRINGIZE(E) " is expected", \
233 P(ex), "incorrect exception " BOOST_STRINGIZE(E) " is caught" ) \
235 #define BOOST_CHECK_EXCEPTION( S, E, P ) \
236 BOOST_CHECK_THROW_IMPL(S, E const& ex, CHECK, \
237 false, "exception " BOOST_STRINGIZE(E) " is expected", \
238 P(ex), "incorrect exception " BOOST_STRINGIZE(E) " is caught" ) \
240 #define BOOST_REQUIRE_EXCEPTION( S, E, P ) \
241 BOOST_CHECK_THROW_IMPL(S, E const& ex, REQUIRE, \
242 false, "exception " BOOST_STRINGIZE(E) " is expected", \
243 P(ex), "incorrect exception " BOOST_STRINGIZE(E) " is caught" ) \
246 //____________________________________________________________________________//
248 #define BOOST_WARN_NO_THROW( S ) \
249 BOOST_CHECK_THROW_IMPL(S, ..., WARN, \
250 true , "no exceptions thrown by " BOOST_STRINGIZE( S ), \
251 false, "exception thrown by " BOOST_STRINGIZE( S ) ) \
253 #define BOOST_CHECK_NO_THROW( S ) \
254 BOOST_CHECK_THROW_IMPL(S, ..., CHECK, \
255 true , "no exceptions thrown by " BOOST_STRINGIZE( S ), \
256 false, "exception thrown by " BOOST_STRINGIZE( S ) ) \
258 #define BOOST_REQUIRE_NO_THROW( S ) \
259 BOOST_CHECK_THROW_IMPL(S, ..., REQUIRE, \
260 true , "no exceptions thrown by " BOOST_STRINGIZE( S ), \
261 false, "exception thrown by " BOOST_STRINGIZE( S ) ) \
264 //____________________________________________________________________________//
266 #define BOOST_WARN_MESSAGE( P, M ) BOOST_TEST_TOOL_DIRECT_IMPL( P, WARN, M )
267 #define BOOST_CHECK_MESSAGE( P, M ) BOOST_TEST_TOOL_DIRECT_IMPL( P, CHECK, M )
268 #define BOOST_REQUIRE_MESSAGE( P, M ) BOOST_TEST_TOOL_DIRECT_IMPL( P, REQUIRE, M )
270 //____________________________________________________________________________//
272 ////////////////////////////////////////////////////////////////////////////////
273 ///////////////////////////// DEPRECATED TOOLS /////////////////////////////
275 #define BOOST_WARN( P ) BOOST_TEST_WARN( P )
276 #define BOOST_CHECK( P ) BOOST_TEST_CHECK( P )
277 #define BOOST_REQUIRE( P ) BOOST_TEST_REQUIRE( P )
279 //____________________________________________________________________________//
281 #define BOOST_ERROR( M ) BOOST_TEST_ERROR( M )
282 #define BOOST_FAIL( M ) BOOST_TEST_FAIL( M )
284 //____________________________________________________________________________//
286 #define BOOST_WARN_EQUAL( L, R ) BOOST_TEST_WARN( L == R )
287 #define BOOST_CHECK_EQUAL( L, R ) BOOST_TEST_CHECK( L == R )
288 #define BOOST_REQUIRE_EQUAL( L, R ) BOOST_TEST_REQUIRE( L == R )
290 #define BOOST_WARN_NE( L, R ) BOOST_TEST_WARN( L != R )
291 #define BOOST_CHECK_NE( L, R ) BOOST_TEST_CHECK( L != R )
292 #define BOOST_REQUIRE_NE( L, R ) BOOST_TEST_REQUIRE( L != R )
294 #define BOOST_WARN_LT( L, R ) BOOST_TEST_WARN( L < R )
295 #define BOOST_CHECK_LT( L, R ) BOOST_TEST_CHECK( L < R )
296 #define BOOST_REQUIRE_LT( L, R ) BOOST_TEST_REQUIRE( L < R )
298 #define BOOST_WARN_LE( L, R ) BOOST_TEST_WARN( L <= R )
299 #define BOOST_CHECK_LE( L, R ) BOOST_TEST_CHECK( L <= R )
300 #define BOOST_REQUIRE_LE( L, R ) BOOST_TEST_REQUIRE( L <= R )
302 #define BOOST_WARN_GT( L, R ) BOOST_TEST_WARN( L > R )
303 #define BOOST_CHECK_GT( L, R ) BOOST_TEST_CHECK( L > R )
304 #define BOOST_REQUIRE_GT( L, R ) BOOST_TEST_REQUIRE( L > R )
306 #define BOOST_WARN_GE( L, R ) BOOST_TEST_WARN( L >= R )
307 #define BOOST_CHECK_GE( L, R ) BOOST_TEST_CHECK( L >= R )
308 #define BOOST_REQUIRE_GE( L, R ) BOOST_TEST_REQUIRE( L >= R )
310 //____________________________________________________________________________//
312 #define BOOST_WARN_CLOSE( L, R, T ) BOOST_TEST_WARN( L == R, T % ::boost::test_tools::tolerance() )
313 #define BOOST_CHECK_CLOSE( L, R, T ) BOOST_TEST_CHECK( L == R, T % ::boost::test_tools::tolerance() )
314 #define BOOST_REQUIRE_CLOSE( L, R, T ) BOOST_TEST_REQUIRE( L == R, T % ::boost::test_tools::tolerance() )
316 #define BOOST_WARN_CLOSE_FRACTION(L, R, T) BOOST_TEST_WARN( L == R, ::boost::test_tools::tolerance( T ) )
317 #define BOOST_CHECK_CLOSE_FRACTION(L, R, T) BOOST_TEST_CHECK( L == R, ::boost::test_tools::tolerance( T ) )
318 #define BOOST_REQUIRE_CLOSE_FRACTION(L,R,T) BOOST_TEST_REQUIRE( L == R, ::boost::test_tools::tolerance( T ) )
320 #define BOOST_WARN_SMALL( FPV, T ) BOOST_TEST_WARN( FPV == 0., ::boost::test_tools::tolerance( T ) )
321 #define BOOST_CHECK_SMALL( FPV, T ) BOOST_TEST_CHECK( FPV == 0., ::boost::test_tools::tolerance( T ) )
322 #define BOOST_REQUIRE_SMALL( FPV, T ) BOOST_TEST_REQUIRE( FPV == 0., ::boost::test_tools::tolerance( T ) )
324 //____________________________________________________________________________//
326 #define BOOST_WARN_EQUAL_COLLECTIONS( L_begin, L_end, R_begin, R_end ) \
327 BOOST_TEST_WARN( ::boost::test_tools::tt_detail::make_it_pair(L_begin, L_end) ==\
328 ::boost::test_tools::tt_detail::make_it_pair(R_begin, R_end), \
329 ::boost::test_tools::per_element() ) \
332 #define BOOST_CHECK_EQUAL_COLLECTIONS( L_begin, L_end, R_begin, R_end ) \
333 BOOST_TEST_CHECK( ::boost::test_tools::tt_detail::make_it_pair(L_begin, L_end) ==\
334 ::boost::test_tools::tt_detail::make_it_pair(R_begin, R_end), \
335 ::boost::test_tools::per_element() ) \
338 #define BOOST_REQUIRE_EQUAL_COLLECTIONS( L_begin, L_end, R_begin, R_end ) \
339 BOOST_TEST_REQUIRE( ::boost::test_tools::tt_detail::make_it_pair(L_begin, L_end) ==\
340 ::boost::test_tools::tt_detail::make_it_pair(R_begin, R_end), \
341 ::boost::test_tools::per_element() ) \
344 //____________________________________________________________________________//
346 #define BOOST_WARN_BITWISE_EQUAL( L, R ) BOOST_TEST_WARN( L == R, ::boost::test_tools::bitwise() )
347 #define BOOST_CHECK_BITWISE_EQUAL( L, R ) BOOST_TEST_CHECK( L == R, ::boost::test_tools::bitwise() )
348 #define BOOST_REQUIRE_BITWISE_EQUAL( L, R ) BOOST_TEST_REQUIRE( L == R, ::boost::test_tools::bitwise() )
350 //____________________________________________________________________________//
352 #define BOOST_WARN_PREDICATE( P, ARGS ) BOOST_TEST_WARN( P BOOST_PP_SEQ_TO_TUPLE(ARGS) )
353 #define BOOST_CHECK_PREDICATE( P, ARGS ) BOOST_TEST_CHECK( P BOOST_PP_SEQ_TO_TUPLE(ARGS) )
354 #define BOOST_REQUIRE_PREDICATE( P, ARGS ) BOOST_TEST_REQUIRE( P BOOST_PP_SEQ_TO_TUPLE(ARGS) )
356 //____________________________________________________________________________//
358 #define BOOST_IS_DEFINED( symb ) ::boost::test_tools::tt_detail::is_defined_impl( #symb, BOOST_STRINGIZE(= symb) )
360 //____________________________________________________________________________//
362 #endif // BOOST_TEST_NO_OLD_TOOLS
364 #include <boost/test/detail/enable_warnings.hpp>
366 #endif // BOOST_TEST_TOOLS_INTERFACE_HPP_111712GER