2
0
mirror of https://github.com/boostorg/test.git synced 2026-01-26 19:12:10 +00:00
Files
test/doc/components/test_tools/reference/BOOST_REQUIRE.html
Gennadiy Rozental 8ee41f3ba4 New Version
[SVN r18711]
2003-06-09 08:07:03 +00:00

44 lines
2.1 KiB
HTML

<HTML>
<HEAD>
<TITLE>The Test Tools</TITLE>
<LINK rel="stylesheet" type="text/css" href="../../../style/btl.css" media="screen">
<LINK rel="stylesheet" type="text/css" href="../../../style/btl-print.css" media="print">
<META http-equiv="Content-Language" content="en-us">
<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<STYLE type="text/css">
H4
{
margin: 0px;
}
</STYLE>
</HEAD>
<BODY>
<DIV class="body">
<H3>BOOST_REQUIRE( predicate )</H3>
<P class="first_line_indented">This tool is used to validate the predicate value and abort the current
test case processing if it fails. </P>
<P class="first_line_indented">If predicate evaluates to <I>true</I>, the tool produces a conformation
message (note: to manage what messages appear in the test output stream set the proper log level),
in other case it produces an error message in a form &quot;fatal error in &lt;test case name&gt;:
test &lt;predicate&gt; fail&quot; and then abort the current test case processing.</P>
<P class="first_line_indented">The only parameter of this tool is the boolean predicate value that gets
validated. This could be any expression that could be evaluated and converted to boolean value. The
expression gets evaluated only once, so it's safe to pass complex expression for validation.</P>
<H4>Example: test.cpp</H4>
<PRE class="code"><SPAN class="cpp-type">int</SPAN> test_main( <SPAN class="cpp-type">int</SPAN>, <SPAN class="cpp-type">char</SPAN>* [] ) {
<SPAN class="cpp-type">int</SPAN> i = <SPAN class="literal">3</SPAN>;
BOOST_REQUIRE( i &gt; <SPAN class="literal">5</SPAN> );
BOOST_CHECK( i == <SPAN class="literal">6</SPAN> ); <SPAN class="comment">// will never reach this check</SPAN>
<SPAN class="reserv-word">return</SPAN> <SPAN class="literal">0</SPAN>;
}</PRE>
<H4>Output:</H4>
<P class="test-output">test.cpp(3) : fatal error in test_main: test i&gt;5 failed </P>
<DIV class="see_also">
<H4>See Also</H4>
<P class="see_also_content"><A href="BOOST_CHECK.html" target="descr">BOOST_CHECK</A></P>
</DIV>
</DIV>
</BODY>
</HTML>