1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/docs/api-2.1/test_8h.html Sat Feb 06 19:11:44 2021 +0100
1.3 @@ -0,0 +1,547 @@
1.4 +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1.5 +<html xmlns="http://www.w3.org/1999/xhtml">
1.6 +<head>
1.7 +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
1.8 +<meta http-equiv="X-UA-Compatible" content="IE=9"/>
1.9 +<meta name="generator" content="Doxygen 1.8.13"/>
1.10 +<meta name="viewport" content="width=device-width, initial-scale=1"/>
1.11 +<title>ucx: /home/mike/workspace/c/ucx/src/ucx/test.h File Reference</title>
1.12 +<link href="tabs.css" rel="stylesheet" type="text/css"/>
1.13 +<script type="text/javascript" src="jquery.js"></script>
1.14 +<script type="text/javascript" src="dynsections.js"></script>
1.15 +<link href="search/search.css" rel="stylesheet" type="text/css"/>
1.16 +<script type="text/javascript" src="search/searchdata.js"></script>
1.17 +<script type="text/javascript" src="search/search.js"></script>
1.18 +<link href="doxygen.css" rel="stylesheet" type="text/css" />
1.19 +</head>
1.20 +<body>
1.21 +<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
1.22 +<div id="titlearea">
1.23 +<table cellspacing="0" cellpadding="0">
1.24 + <tbody>
1.25 + <tr style="height: 56px;">
1.26 + <td id="projectlogo"><img alt="Logo" src="uaplogo.png"/></td>
1.27 + <td id="projectalign" style="padding-left: 0.5em;">
1.28 + <div id="projectname">ucx
1.29 + </div>
1.30 + <div id="projectbrief">UAP Common Extensions</div>
1.31 + </td>
1.32 + </tr>
1.33 + </tbody>
1.34 +</table>
1.35 +</div>
1.36 +<!-- end header part -->
1.37 +<!-- Generated by Doxygen 1.8.13 -->
1.38 +<script type="text/javascript">
1.39 +var searchBox = new SearchBox("searchBox", "search",false,'Search');
1.40 +</script>
1.41 +<script type="text/javascript" src="menudata.js"></script>
1.42 +<script type="text/javascript" src="menu.js"></script>
1.43 +<script type="text/javascript">
1.44 +$(function() {
1.45 + initMenu('',true,false,'search.php','Search');
1.46 + $(document).ready(function() { init_search(); });
1.47 +});
1.48 +</script>
1.49 +<div id="main-nav"></div>
1.50 +<!-- window showing the filter options -->
1.51 +<div id="MSearchSelectWindow"
1.52 + onmouseover="return searchBox.OnSearchSelectShow()"
1.53 + onmouseout="return searchBox.OnSearchSelectHide()"
1.54 + onkeydown="return searchBox.OnSearchSelectKey(event)">
1.55 +</div>
1.56 +
1.57 +<!-- iframe showing the search results (closed by default) -->
1.58 +<div id="MSearchResultsWindow">
1.59 +<iframe src="javascript:void(0)" frameborder="0"
1.60 + name="MSearchResults" id="MSearchResults">
1.61 +</iframe>
1.62 +</div>
1.63 +
1.64 +<div id="nav-path" class="navpath">
1.65 + <ul>
1.66 +<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_69f4ea29401808fe6229564976cde3ce.html">ucx</a></li> </ul>
1.67 +</div>
1.68 +</div><!-- top -->
1.69 +<div class="header">
1.70 + <div class="summary">
1.71 +<a href="#nested-classes">Data Structures</a> |
1.72 +<a href="#define-members">Macros</a> |
1.73 +<a href="#typedef-members">Typedefs</a> |
1.74 +<a href="#func-members">Functions</a> </div>
1.75 + <div class="headertitle">
1.76 +<div class="title">test.h File Reference</div> </div>
1.77 +</div><!--header-->
1.78 +<div class="contents">
1.79 +
1.80 +<p>UCX Test Framework.
1.81 +<a href="#details">More...</a></p>
1.82 +<div class="textblock"><code>#include "<a class="el" href="ucx_8h_source.html">ucx.h</a>"</code><br />
1.83 +<code>#include <stdio.h></code><br />
1.84 +<code>#include <<a class="el" href="string_8h_source.html">string.h</a>></code><br />
1.85 +<code>#include <setjmp.h></code><br />
1.86 +</div>
1.87 +<p><a href="test_8h_source.html">Go to the source code of this file.</a></p>
1.88 +<table class="memberdecls">
1.89 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
1.90 +Data Structures</h2></td></tr>
1.91 +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxTestList.html">UcxTestList</a></td></tr>
1.92 +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure for the internal list of test cases. <a href="structUcxTestList.html#details">More...</a><br /></td></tr>
1.93 +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
1.94 +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxTestSuite.html">UcxTestSuite</a></td></tr>
1.95 +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A test suite containing multiple test cases. <a href="structUcxTestSuite.html#details">More...</a><br /></td></tr>
1.96 +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
1.97 +</table><table class="memberdecls">
1.98 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
1.99 +Macros</h2></td></tr>
1.100 +<tr class="memitem:a828bb1dfda1afd67ca795075903d227d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="test_8h.html#a828bb1dfda1afd67ca795075903d227d">__FUNCTION__</a>   __func__</td></tr>
1.101 +<tr class="memdesc:a828bb1dfda1afd67ca795075903d227d"><td class="mdescLeft"> </td><td class="mdescRight">Alias for the <code>__func__</code> preprocessor macro. <a href="#a828bb1dfda1afd67ca795075903d227d">More...</a><br /></td></tr>
1.102 +<tr class="separator:a828bb1dfda1afd67ca795075903d227d"><td class="memSeparator" colspan="2"> </td></tr>
1.103 +<tr class="memitem:a66cfb29c329fc9eaef071f2449836659"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="test_8h.html#a66cfb29c329fc9eaef071f2449836659">UCX_TEST</a>(name)   void name(<a class="el" href="structUcxTestSuite.html">UcxTestSuite</a>* _suite_,FILE *_output_)</td></tr>
1.104 +<tr class="memdesc:a66cfb29c329fc9eaef071f2449836659"><td class="mdescLeft"> </td><td class="mdescRight">Macro for a <a class="el" href="test_8h.html#ae906817354c010b83c2784260cce7a1c" title="Pointer to a test function. ">UcxTest</a> function header. <a href="#a66cfb29c329fc9eaef071f2449836659">More...</a><br /></td></tr>
1.105 +<tr class="separator:a66cfb29c329fc9eaef071f2449836659"><td class="memSeparator" colspan="2"> </td></tr>
1.106 +<tr class="memitem:a0547b8d4f3bcdb0633fdd8925e8aa5d4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="test_8h.html#a0547b8d4f3bcdb0633fdd8925e8aa5d4">UCX_TEST_BEGIN</a></td></tr>
1.107 +<tr class="memdesc:a0547b8d4f3bcdb0633fdd8925e8aa5d4"><td class="mdescLeft"> </td><td class="mdescRight">Marks the begin of a test. <a href="#a0547b8d4f3bcdb0633fdd8925e8aa5d4">More...</a><br /></td></tr>
1.108 +<tr class="separator:a0547b8d4f3bcdb0633fdd8925e8aa5d4"><td class="memSeparator" colspan="2"> </td></tr>
1.109 +<tr class="memitem:a08f477cd12fc3fe741a92493e5df58a9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="test_8h.html#a08f477cd12fc3fe741a92493e5df58a9">UCX_TEST_ASSERT</a>(condition, message)</td></tr>
1.110 +<tr class="memdesc:a08f477cd12fc3fe741a92493e5df58a9"><td class="mdescLeft"> </td><td class="mdescRight">Checks a test assertion. <a href="#a08f477cd12fc3fe741a92493e5df58a9">More...</a><br /></td></tr>
1.111 +<tr class="separator:a08f477cd12fc3fe741a92493e5df58a9"><td class="memSeparator" colspan="2"> </td></tr>
1.112 +<tr class="memitem:ae073cf5ead22cb27d662da048e16f44a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="test_8h.html#ae073cf5ead22cb27d662da048e16f44a">UCX_TEST_SUBROUTINE</a>(name, ...)</td></tr>
1.113 +<tr class="memdesc:ae073cf5ead22cb27d662da048e16f44a"><td class="mdescLeft"> </td><td class="mdescRight">Macro for a test subroutine function header. <a href="#ae073cf5ead22cb27d662da048e16f44a">More...</a><br /></td></tr>
1.114 +<tr class="separator:ae073cf5ead22cb27d662da048e16f44a"><td class="memSeparator" colspan="2"> </td></tr>
1.115 +<tr class="memitem:a0efbab91c54f5237a2ab207f48cf0e51"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="test_8h.html#a0efbab91c54f5237a2ab207f48cf0e51">UCX_TEST_CALL_SUBROUTINE</a>(name, ...)   name(_suite_,_output_,_env_,__VA_ARGS__);</td></tr>
1.116 +<tr class="memdesc:a0efbab91c54f5237a2ab207f48cf0e51"><td class="mdescLeft"> </td><td class="mdescRight">Macro for calling a test subroutine. <a href="#a0efbab91c54f5237a2ab207f48cf0e51">More...</a><br /></td></tr>
1.117 +<tr class="separator:a0efbab91c54f5237a2ab207f48cf0e51"><td class="memSeparator" colspan="2"> </td></tr>
1.118 +<tr class="memitem:a86e64857c04f0447f8b16fb9c2b3b639"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="test_8h.html#a86e64857c04f0447f8b16fb9c2b3b639">UCX_TEST_END</a>   fwrite("success.\n", 1, 9, _output_); _suite_->success++;}</td></tr>
1.119 +<tr class="memdesc:a86e64857c04f0447f8b16fb9c2b3b639"><td class="mdescLeft"> </td><td class="mdescRight">Marks the end of a test. <a href="#a86e64857c04f0447f8b16fb9c2b3b639">More...</a><br /></td></tr>
1.120 +<tr class="separator:a86e64857c04f0447f8b16fb9c2b3b639"><td class="memSeparator" colspan="2"> </td></tr>
1.121 +</table><table class="memberdecls">
1.122 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
1.123 +Typedefs</h2></td></tr>
1.124 +<tr class="memitem:a52115d1d0f1c4a565ed6ef7c1bfd0363"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structUcxTestSuite.html">UcxTestSuite</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="test_8h.html#a52115d1d0f1c4a565ed6ef7c1bfd0363">UcxTestSuite</a></td></tr>
1.125 +<tr class="memdesc:a52115d1d0f1c4a565ed6ef7c1bfd0363"><td class="mdescLeft"> </td><td class="mdescRight">Type for the <a class="el" href="structUcxTestSuite.html" title="A test suite containing multiple test cases. ">UcxTestSuite</a>. <a href="#a52115d1d0f1c4a565ed6ef7c1bfd0363">More...</a><br /></td></tr>
1.126 +<tr class="separator:a52115d1d0f1c4a565ed6ef7c1bfd0363"><td class="memSeparator" colspan="2"> </td></tr>
1.127 +<tr class="memitem:ae906817354c010b83c2784260cce7a1c"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="test_8h.html#ae906817354c010b83c2784260cce7a1c">UcxTest</a>) (<a class="el" href="structUcxTestSuite.html">UcxTestSuite</a> *, FILE *)</td></tr>
1.128 +<tr class="memdesc:ae906817354c010b83c2784260cce7a1c"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to a test function. <a href="#ae906817354c010b83c2784260cce7a1c">More...</a><br /></td></tr>
1.129 +<tr class="separator:ae906817354c010b83c2784260cce7a1c"><td class="memSeparator" colspan="2"> </td></tr>
1.130 +<tr class="memitem:a8048c50ae73ea690b776edfd63bd6a5d"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structUcxTestList.html">UcxTestList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="test_8h.html#a8048c50ae73ea690b776edfd63bd6a5d">UcxTestList</a></td></tr>
1.131 +<tr class="memdesc:a8048c50ae73ea690b776edfd63bd6a5d"><td class="mdescLeft"> </td><td class="mdescRight">Type for the internal list of test cases. <a href="#a8048c50ae73ea690b776edfd63bd6a5d">More...</a><br /></td></tr>
1.132 +<tr class="separator:a8048c50ae73ea690b776edfd63bd6a5d"><td class="memSeparator" colspan="2"> </td></tr>
1.133 +</table><table class="memberdecls">
1.134 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
1.135 +Functions</h2></td></tr>
1.136 +<tr class="memitem:a531f0df90363e0befbe900878f65f09e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxTestSuite.html">UcxTestSuite</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="test_8h.html#a531f0df90363e0befbe900878f65f09e">ucx_test_suite_new</a> ()</td></tr>
1.137 +<tr class="memdesc:a531f0df90363e0befbe900878f65f09e"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new test suite. <a href="#a531f0df90363e0befbe900878f65f09e">More...</a><br /></td></tr>
1.138 +<tr class="separator:a531f0df90363e0befbe900878f65f09e"><td class="memSeparator" colspan="2"> </td></tr>
1.139 +<tr class="memitem:a4a6ac61a6f72722273f8eaa7a343edde"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="test_8h.html#a4a6ac61a6f72722273f8eaa7a343edde">ucx_test_suite_free</a> (<a class="el" href="structUcxTestSuite.html">UcxTestSuite</a> *suite)</td></tr>
1.140 +<tr class="memdesc:a4a6ac61a6f72722273f8eaa7a343edde"><td class="mdescLeft"> </td><td class="mdescRight">Destroys a test suite. <a href="#a4a6ac61a6f72722273f8eaa7a343edde">More...</a><br /></td></tr>
1.141 +<tr class="separator:a4a6ac61a6f72722273f8eaa7a343edde"><td class="memSeparator" colspan="2"> </td></tr>
1.142 +<tr class="memitem:a8dfabc42f183d3a4d79379a5d17bf67d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="test_8h.html#a8dfabc42f183d3a4d79379a5d17bf67d">ucx_test_register</a> (<a class="el" href="structUcxTestSuite.html">UcxTestSuite</a> *suite, <a class="el" href="test_8h.html#ae906817354c010b83c2784260cce7a1c">UcxTest</a> test)</td></tr>
1.143 +<tr class="memdesc:a8dfabc42f183d3a4d79379a5d17bf67d"><td class="mdescLeft"> </td><td class="mdescRight">Registers a test function with the specified test suite. <a href="#a8dfabc42f183d3a4d79379a5d17bf67d">More...</a><br /></td></tr>
1.144 +<tr class="separator:a8dfabc42f183d3a4d79379a5d17bf67d"><td class="memSeparator" colspan="2"> </td></tr>
1.145 +<tr class="memitem:a3721458deeecb43aa322428f007714c3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="test_8h.html#a3721458deeecb43aa322428f007714c3">ucx_test_run</a> (<a class="el" href="structUcxTestSuite.html">UcxTestSuite</a> *suite, FILE *outstream)</td></tr>
1.146 +<tr class="memdesc:a3721458deeecb43aa322428f007714c3"><td class="mdescLeft"> </td><td class="mdescRight">Runs a test suite and writes the test log to the specified stream. <a href="#a3721458deeecb43aa322428f007714c3">More...</a><br /></td></tr>
1.147 +<tr class="separator:a3721458deeecb43aa322428f007714c3"><td class="memSeparator" colspan="2"> </td></tr>
1.148 +</table>
1.149 +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
1.150 +<div class="textblock"><p>UCX Test Framework. </p>
1.151 +<p>Usage of this test framework:</p>
1.152 +<p>**** IN HEADER FILE: ****</p>
1.153 +<pre>
1.154 +<a class="el" href="test_8h.html#a66cfb29c329fc9eaef071f2449836659" title="Macro for a UcxTest function header. ">UCX_TEST(function_name)</a>;
1.155 +<a class="el" href="test_8h.html#ae073cf5ead22cb27d662da048e16f44a" title="Macro for a test subroutine function header. ">UCX_TEST_SUBROUTINE(subroutine_name, paramlist)</a>; // optional
1.156 +</pre><p>**** IN SOURCE FILE: **** </p><pre>
1.157 +<a class="el" href="test_8h.html#ae073cf5ead22cb27d662da048e16f44a" title="Macro for a test subroutine function header. ">UCX_TEST_SUBROUTINE(subroutine_name, paramlist)</a> {
1.158 + // tests with <a class="el" href="test_8h.html#a08f477cd12fc3fe741a92493e5df58a9" title="Checks a test assertion. ">UCX_TEST_ASSERT()</a>
1.159 +}</pre><pre><a class="el" href="test_8h.html#a66cfb29c329fc9eaef071f2449836659" title="Macro for a UcxTest function header. ">UCX_TEST(function_name)</a> {
1.160 + // memory allocation and other stuff here
1.161 + <a class="el" href="test_8h.html#a0547b8d4f3bcdb0633fdd8925e8aa5d4" title="Marks the begin of a test. ">UCX_TEST_BEGIN</a>
1.162 + // tests with <a class="el" href="test_8h.html#a08f477cd12fc3fe741a92493e5df58a9" title="Checks a test assertion. ">UCX_TEST_ASSERT()</a> and/or
1.163 + // calls with <a class="el" href="test_8h.html#a0efbab91c54f5237a2ab207f48cf0e51" title="Macro for calling a test subroutine. ">UCX_TEST_CALL_SUBROUTINE()</a> here
1.164 + <a class="el" href="test_8h.html#a86e64857c04f0447f8b16fb9c2b3b639" title="Marks the end of a test. ">UCX_TEST_END</a>
1.165 + // cleanup of memory here
1.166 +}
1.167 +</pre><p><b>Note:</b> if a test fails, a longjump is performed back to the <a class="el" href="test_8h.html#a0547b8d4f3bcdb0633fdd8925e8aa5d4" title="Marks the begin of a test. ">UCX_TEST_BEGIN</a> macro!</p>
1.168 +<p><b>Attention:</b> Do not call own functions within a test, that use <a class="el" href="test_8h.html#a08f477cd12fc3fe741a92493e5df58a9" title="Checks a test assertion. ">UCX_TEST_ASSERT()</a> macros and are not defined by using <a class="el" href="test_8h.html#ae073cf5ead22cb27d662da048e16f44a" title="Macro for a test subroutine function header. ">UCX_TEST_SUBROUTINE()</a>.</p>
1.169 +<dl class="section author"><dt>Author</dt><dd>Mike Becker </dd>
1.170 +<dd>
1.171 +Olaf Wintermann </dd></dl>
1.172 +</div><h2 class="groupheader">Macro Definition Documentation</h2>
1.173 +<a id="a828bb1dfda1afd67ca795075903d227d"></a>
1.174 +<h2 class="memtitle"><span class="permalink"><a href="#a828bb1dfda1afd67ca795075903d227d">◆ </a></span>__FUNCTION__</h2>
1.175 +
1.176 +<div class="memitem">
1.177 +<div class="memproto">
1.178 + <table class="memname">
1.179 + <tr>
1.180 + <td class="memname">#define __FUNCTION__   __func__</td>
1.181 + </tr>
1.182 + </table>
1.183 +</div><div class="memdoc">
1.184 +
1.185 +<p>Alias for the <code>__func__</code> preprocessor macro. </p>
1.186 +<p>Some compilers use <code>__func__</code> and others use <b>FUNCTION</b>. We use <b>FUNCTION</b> so we define it for those compilers which use <code>__func__</code>. </p>
1.187 +
1.188 +</div>
1.189 +</div>
1.190 +<a id="a66cfb29c329fc9eaef071f2449836659"></a>
1.191 +<h2 class="memtitle"><span class="permalink"><a href="#a66cfb29c329fc9eaef071f2449836659">◆ </a></span>UCX_TEST</h2>
1.192 +
1.193 +<div class="memitem">
1.194 +<div class="memproto">
1.195 + <table class="memname">
1.196 + <tr>
1.197 + <td class="memname">#define UCX_TEST</td>
1.198 + <td>(</td>
1.199 + <td class="paramtype"> </td>
1.200 + <td class="paramname">name</td><td>)</td>
1.201 + <td>   void name(<a class="el" href="structUcxTestSuite.html">UcxTestSuite</a>* _suite_,FILE *_output_)</td>
1.202 + </tr>
1.203 + </table>
1.204 +</div><div class="memdoc">
1.205 +
1.206 +<p>Macro for a <a class="el" href="test_8h.html#ae906817354c010b83c2784260cce7a1c" title="Pointer to a test function. ">UcxTest</a> function header. </p>
1.207 +<p>Use this macro to declare and/or define a <a class="el" href="test_8h.html#ae906817354c010b83c2784260cce7a1c" title="Pointer to a test function. ">UcxTest</a> function.</p>
1.208 +<dl class="params"><dt>Parameters</dt><dd>
1.209 + <table class="params">
1.210 + <tr><td class="paramname">name</td><td>the name of the test function </td></tr>
1.211 + </table>
1.212 + </dd>
1.213 +</dl>
1.214 +
1.215 +</div>
1.216 +</div>
1.217 +<a id="a08f477cd12fc3fe741a92493e5df58a9"></a>
1.218 +<h2 class="memtitle"><span class="permalink"><a href="#a08f477cd12fc3fe741a92493e5df58a9">◆ </a></span>UCX_TEST_ASSERT</h2>
1.219 +
1.220 +<div class="memitem">
1.221 +<div class="memproto">
1.222 + <table class="memname">
1.223 + <tr>
1.224 + <td class="memname">#define UCX_TEST_ASSERT</td>
1.225 + <td>(</td>
1.226 + <td class="paramtype"> </td>
1.227 + <td class="paramname">condition, </td>
1.228 + </tr>
1.229 + <tr>
1.230 + <td class="paramkey"></td>
1.231 + <td></td>
1.232 + <td class="paramtype"> </td>
1.233 + <td class="paramname">message </td>
1.234 + </tr>
1.235 + <tr>
1.236 + <td></td>
1.237 + <td>)</td>
1.238 + <td></td><td></td>
1.239 + </tr>
1.240 + </table>
1.241 +</div><div class="memdoc">
1.242 +<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">if</span> (!(condition)) { \</div><div class="line"> fwrite(message<span class="stringliteral">".\n"</span>, 1, 2+strlen(message), _output_); \</div><div class="line"> _suite_->failure++; \</div><div class="line"> longjmp(_env_, 1);\</div><div class="line"> }</div></div><!-- fragment -->
1.243 +<p>Checks a test assertion. </p>
1.244 +<p>If the assertion is correct, the test carries on. If the assertion is not correct, the specified message (terminated by a dot and a line break) is written to the test suites output stream. </p><dl class="params"><dt>Parameters</dt><dd>
1.245 + <table class="params">
1.246 + <tr><td class="paramname">condition</td><td>the condition to check </td></tr>
1.247 + <tr><td class="paramname">message</td><td>the message that shall be printed out on failure </td></tr>
1.248 + </table>
1.249 + </dd>
1.250 +</dl>
1.251 +
1.252 +</div>
1.253 +</div>
1.254 +<a id="a0547b8d4f3bcdb0633fdd8925e8aa5d4"></a>
1.255 +<h2 class="memtitle"><span class="permalink"><a href="#a0547b8d4f3bcdb0633fdd8925e8aa5d4">◆ </a></span>UCX_TEST_BEGIN</h2>
1.256 +
1.257 +<div class="memitem">
1.258 +<div class="memproto">
1.259 + <table class="memname">
1.260 + <tr>
1.261 + <td class="memname">#define UCX_TEST_BEGIN</td>
1.262 + </tr>
1.263 + </table>
1.264 +</div><div class="memdoc">
1.265 +<b>Value:</b><div class="fragment"><div class="line">fwrite(<span class="stringliteral">"Running "</span>, 1, 8, _output_);\</div><div class="line"> fwrite(<a class="code" href="test_8h.html#a828bb1dfda1afd67ca795075903d227d">__FUNCTION__</a>, 1, strlen(<a class="code" href="test_8h.html#a828bb1dfda1afd67ca795075903d227d">__FUNCTION__</a>), _output_);\</div><div class="line"> fwrite(<span class="stringliteral">"... "</span>, 1, 4, _output_);\</div><div class="line"> jmp_buf _env_; \</div><div class="line"> if (!setjmp(_env_)) {</div><div class="ttc" id="test_8h_html_a828bb1dfda1afd67ca795075903d227d"><div class="ttname"><a href="test_8h.html#a828bb1dfda1afd67ca795075903d227d">__FUNCTION__</a></div><div class="ttdeci">#define __FUNCTION__</div><div class="ttdoc">Alias for the __func__ preprocessor macro. </div><div class="ttdef"><b>Definition:</b> test.h:91</div></div>
1.266 +</div><!-- fragment -->
1.267 +<p>Marks the begin of a test. </p>
1.268 +<p><b>Note:</b> Any <a class="el" href="test_8h.html#a08f477cd12fc3fe741a92493e5df58a9" title="Checks a test assertion. ">UCX_TEST_ASSERT()</a> calls must be performed <b>after</b> <a class="el" href="test_8h.html#a0547b8d4f3bcdb0633fdd8925e8aa5d4" title="Marks the begin of a test. ">UCX_TEST_BEGIN</a>.</p>
1.269 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="test_8h.html#a86e64857c04f0447f8b16fb9c2b3b639" title="Marks the end of a test. ">UCX_TEST_END</a> </dd></dl>
1.270 +
1.271 +</div>
1.272 +</div>
1.273 +<a id="a0efbab91c54f5237a2ab207f48cf0e51"></a>
1.274 +<h2 class="memtitle"><span class="permalink"><a href="#a0efbab91c54f5237a2ab207f48cf0e51">◆ </a></span>UCX_TEST_CALL_SUBROUTINE</h2>
1.275 +
1.276 +<div class="memitem">
1.277 +<div class="memproto">
1.278 + <table class="memname">
1.279 + <tr>
1.280 + <td class="memname">#define UCX_TEST_CALL_SUBROUTINE</td>
1.281 + <td>(</td>
1.282 + <td class="paramtype"> </td>
1.283 + <td class="paramname">name, </td>
1.284 + </tr>
1.285 + <tr>
1.286 + <td class="paramkey"></td>
1.287 + <td></td>
1.288 + <td class="paramtype"> </td>
1.289 + <td class="paramname"><em>...</em> </td>
1.290 + </tr>
1.291 + <tr>
1.292 + <td></td>
1.293 + <td>)</td>
1.294 + <td></td><td>   name(_suite_,_output_,_env_,__VA_ARGS__);</td>
1.295 + </tr>
1.296 + </table>
1.297 +</div><div class="memdoc">
1.298 +
1.299 +<p>Macro for calling a test subroutine. </p>
1.300 +<p>Subroutines declared with <a class="el" href="test_8h.html#ae073cf5ead22cb27d662da048e16f44a" title="Macro for a test subroutine function header. ">UCX_TEST_SUBROUTINE()</a> can be called by using this macro.</p>
1.301 +<p><b>Note:</b> You may <b>only</b> call subroutines within a <a class="el" href="test_8h.html#a0547b8d4f3bcdb0633fdd8925e8aa5d4" title="Marks the begin of a test. ">UCX_TEST_BEGIN</a>- <a class="el" href="test_8h.html#a86e64857c04f0447f8b16fb9c2b3b639" title="Marks the end of a test. ">UCX_TEST_END</a>-block.</p>
1.302 +<dl class="params"><dt>Parameters</dt><dd>
1.303 + <table class="params">
1.304 + <tr><td class="paramname">name</td><td>the name of the subroutine </td></tr>
1.305 + <tr><td class="paramname">...</td><td>the argument list</td></tr>
1.306 + </table>
1.307 + </dd>
1.308 +</dl>
1.309 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="test_8h.html#ae073cf5ead22cb27d662da048e16f44a" title="Macro for a test subroutine function header. ">UCX_TEST_SUBROUTINE()</a> </dd></dl>
1.310 +
1.311 +</div>
1.312 +</div>
1.313 +<a id="a86e64857c04f0447f8b16fb9c2b3b639"></a>
1.314 +<h2 class="memtitle"><span class="permalink"><a href="#a86e64857c04f0447f8b16fb9c2b3b639">◆ </a></span>UCX_TEST_END</h2>
1.315 +
1.316 +<div class="memitem">
1.317 +<div class="memproto">
1.318 + <table class="memname">
1.319 + <tr>
1.320 + <td class="memname">#define UCX_TEST_END   fwrite("success.\n", 1, 9, _output_); _suite_->success++;}</td>
1.321 + </tr>
1.322 + </table>
1.323 +</div><div class="memdoc">
1.324 +
1.325 +<p>Marks the end of a test. </p>
1.326 +<p><b>Note:</b> Any <a class="el" href="test_8h.html#a08f477cd12fc3fe741a92493e5df58a9" title="Checks a test assertion. ">UCX_TEST_ASSERT()</a> calls must be performed <b>before</b> <a class="el" href="test_8h.html#a86e64857c04f0447f8b16fb9c2b3b639" title="Marks the end of a test. ">UCX_TEST_END</a>.</p>
1.327 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="test_8h.html#a0547b8d4f3bcdb0633fdd8925e8aa5d4" title="Marks the begin of a test. ">UCX_TEST_BEGIN</a> </dd></dl>
1.328 +
1.329 +</div>
1.330 +</div>
1.331 +<a id="ae073cf5ead22cb27d662da048e16f44a"></a>
1.332 +<h2 class="memtitle"><span class="permalink"><a href="#ae073cf5ead22cb27d662da048e16f44a">◆ </a></span>UCX_TEST_SUBROUTINE</h2>
1.333 +
1.334 +<div class="memitem">
1.335 +<div class="memproto">
1.336 + <table class="memname">
1.337 + <tr>
1.338 + <td class="memname">#define UCX_TEST_SUBROUTINE</td>
1.339 + <td>(</td>
1.340 + <td class="paramtype"> </td>
1.341 + <td class="paramname">name, </td>
1.342 + </tr>
1.343 + <tr>
1.344 + <td class="paramkey"></td>
1.345 + <td></td>
1.346 + <td class="paramtype"> </td>
1.347 + <td class="paramname"><em>...</em> </td>
1.348 + </tr>
1.349 + <tr>
1.350 + <td></td>
1.351 + <td>)</td>
1.352 + <td></td><td></td>
1.353 + </tr>
1.354 + </table>
1.355 +</div><div class="memdoc">
1.356 +<b>Value:</b><div class="fragment"><div class="line"><span class="keywordtype">void</span> name(<a class="code" href="structUcxTestSuite.html">UcxTestSuite</a>* _suite_,\</div><div class="line"> FILE *_output_, jmp_buf _env_, __VA_ARGS__)</div><div class="ttc" id="structUcxTestSuite_html"><div class="ttname"><a href="structUcxTestSuite.html">UcxTestSuite</a></div><div class="ttdoc">A test suite containing multiple test cases. </div><div class="ttdef"><b>Definition:</b> test.h:116</div></div>
1.357 +</div><!-- fragment -->
1.358 +<p>Macro for a test subroutine function header. </p>
1.359 +<p>Use this to declare and/or define a subroutine that can be called by using <a class="el" href="test_8h.html#a0efbab91c54f5237a2ab207f48cf0e51" title="Macro for calling a test subroutine. ">UCX_TEST_CALL_SUBROUTINE()</a>.</p>
1.360 +<dl class="params"><dt>Parameters</dt><dd>
1.361 + <table class="params">
1.362 + <tr><td class="paramname">name</td><td>the name of the subroutine </td></tr>
1.363 + <tr><td class="paramname">...</td><td>the parameter list</td></tr>
1.364 + </table>
1.365 + </dd>
1.366 +</dl>
1.367 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="test_8h.html#a0efbab91c54f5237a2ab207f48cf0e51" title="Macro for calling a test subroutine. ">UCX_TEST_CALL_SUBROUTINE()</a> </dd></dl>
1.368 +
1.369 +</div>
1.370 +</div>
1.371 +<h2 class="groupheader">Typedef Documentation</h2>
1.372 +<a id="ae906817354c010b83c2784260cce7a1c"></a>
1.373 +<h2 class="memtitle"><span class="permalink"><a href="#ae906817354c010b83c2784260cce7a1c">◆ </a></span>UcxTest</h2>
1.374 +
1.375 +<div class="memitem">
1.376 +<div class="memproto">
1.377 + <table class="memname">
1.378 + <tr>
1.379 + <td class="memname">typedef void(* UcxTest) (<a class="el" href="structUcxTestSuite.html">UcxTestSuite</a> *, FILE *)</td>
1.380 + </tr>
1.381 + </table>
1.382 +</div><div class="memdoc">
1.383 +
1.384 +<p>Pointer to a test function. </p>
1.385 +
1.386 +</div>
1.387 +</div>
1.388 +<a id="a8048c50ae73ea690b776edfd63bd6a5d"></a>
1.389 +<h2 class="memtitle"><span class="permalink"><a href="#a8048c50ae73ea690b776edfd63bd6a5d">◆ </a></span>UcxTestList</h2>
1.390 +
1.391 +<div class="memitem">
1.392 +<div class="memproto">
1.393 + <table class="memname">
1.394 + <tr>
1.395 + <td class="memname">typedef struct <a class="el" href="structUcxTestList.html">UcxTestList</a> <a class="el" href="structUcxTestList.html">UcxTestList</a></td>
1.396 + </tr>
1.397 + </table>
1.398 +</div><div class="memdoc">
1.399 +
1.400 +<p>Type for the internal list of test cases. </p>
1.401 +
1.402 +</div>
1.403 +</div>
1.404 +<a id="a52115d1d0f1c4a565ed6ef7c1bfd0363"></a>
1.405 +<h2 class="memtitle"><span class="permalink"><a href="#a52115d1d0f1c4a565ed6ef7c1bfd0363">◆ </a></span>UcxTestSuite</h2>
1.406 +
1.407 +<div class="memitem">
1.408 +<div class="memproto">
1.409 + <table class="memname">
1.410 + <tr>
1.411 + <td class="memname">typedef struct <a class="el" href="structUcxTestSuite.html">UcxTestSuite</a> <a class="el" href="structUcxTestSuite.html">UcxTestSuite</a></td>
1.412 + </tr>
1.413 + </table>
1.414 +</div><div class="memdoc">
1.415 +
1.416 +<p>Type for the <a class="el" href="structUcxTestSuite.html" title="A test suite containing multiple test cases. ">UcxTestSuite</a>. </p>
1.417 +
1.418 +</div>
1.419 +</div>
1.420 +<h2 class="groupheader">Function Documentation</h2>
1.421 +<a id="a8dfabc42f183d3a4d79379a5d17bf67d"></a>
1.422 +<h2 class="memtitle"><span class="permalink"><a href="#a8dfabc42f183d3a4d79379a5d17bf67d">◆ </a></span>ucx_test_register()</h2>
1.423 +
1.424 +<div class="memitem">
1.425 +<div class="memproto">
1.426 + <table class="memname">
1.427 + <tr>
1.428 + <td class="memname">int ucx_test_register </td>
1.429 + <td>(</td>
1.430 + <td class="paramtype"><a class="el" href="structUcxTestSuite.html">UcxTestSuite</a> * </td>
1.431 + <td class="paramname"><em>suite</em>, </td>
1.432 + </tr>
1.433 + <tr>
1.434 + <td class="paramkey"></td>
1.435 + <td></td>
1.436 + <td class="paramtype"><a class="el" href="test_8h.html#ae906817354c010b83c2784260cce7a1c">UcxTest</a> </td>
1.437 + <td class="paramname"><em>test</em> </td>
1.438 + </tr>
1.439 + <tr>
1.440 + <td></td>
1.441 + <td>)</td>
1.442 + <td></td><td></td>
1.443 + </tr>
1.444 + </table>
1.445 +</div><div class="memdoc">
1.446 +
1.447 +<p>Registers a test function with the specified test suite. </p>
1.448 +<dl class="params"><dt>Parameters</dt><dd>
1.449 + <table class="params">
1.450 + <tr><td class="paramname">suite</td><td>the suite, the test function shall be added to </td></tr>
1.451 + <tr><td class="paramname">test</td><td>the test function to register </td></tr>
1.452 + </table>
1.453 + </dd>
1.454 +</dl>
1.455 +<dl class="section return"><dt>Returns</dt><dd><code>EXIT_SUCCESS</code> on success or <code>EXIT_FAILURE</code> on failure </dd></dl>
1.456 +
1.457 +</div>
1.458 +</div>
1.459 +<a id="a3721458deeecb43aa322428f007714c3"></a>
1.460 +<h2 class="memtitle"><span class="permalink"><a href="#a3721458deeecb43aa322428f007714c3">◆ </a></span>ucx_test_run()</h2>
1.461 +
1.462 +<div class="memitem">
1.463 +<div class="memproto">
1.464 + <table class="memname">
1.465 + <tr>
1.466 + <td class="memname">void ucx_test_run </td>
1.467 + <td>(</td>
1.468 + <td class="paramtype"><a class="el" href="structUcxTestSuite.html">UcxTestSuite</a> * </td>
1.469 + <td class="paramname"><em>suite</em>, </td>
1.470 + </tr>
1.471 + <tr>
1.472 + <td class="paramkey"></td>
1.473 + <td></td>
1.474 + <td class="paramtype">FILE * </td>
1.475 + <td class="paramname"><em>outstream</em> </td>
1.476 + </tr>
1.477 + <tr>
1.478 + <td></td>
1.479 + <td>)</td>
1.480 + <td></td><td></td>
1.481 + </tr>
1.482 + </table>
1.483 +</div><div class="memdoc">
1.484 +
1.485 +<p>Runs a test suite and writes the test log to the specified stream. </p>
1.486 +<dl class="params"><dt>Parameters</dt><dd>
1.487 + <table class="params">
1.488 + <tr><td class="paramname">suite</td><td>the test suite to run </td></tr>
1.489 + <tr><td class="paramname">outstream</td><td>the stream the log shall be written to </td></tr>
1.490 + </table>
1.491 + </dd>
1.492 +</dl>
1.493 +
1.494 +</div>
1.495 +</div>
1.496 +<a id="a4a6ac61a6f72722273f8eaa7a343edde"></a>
1.497 +<h2 class="memtitle"><span class="permalink"><a href="#a4a6ac61a6f72722273f8eaa7a343edde">◆ </a></span>ucx_test_suite_free()</h2>
1.498 +
1.499 +<div class="memitem">
1.500 +<div class="memproto">
1.501 + <table class="memname">
1.502 + <tr>
1.503 + <td class="memname">void ucx_test_suite_free </td>
1.504 + <td>(</td>
1.505 + <td class="paramtype"><a class="el" href="structUcxTestSuite.html">UcxTestSuite</a> * </td>
1.506 + <td class="paramname"><em>suite</em></td><td>)</td>
1.507 + <td></td>
1.508 + </tr>
1.509 + </table>
1.510 +</div><div class="memdoc">
1.511 +
1.512 +<p>Destroys a test suite. </p>
1.513 +<dl class="params"><dt>Parameters</dt><dd>
1.514 + <table class="params">
1.515 + <tr><td class="paramname">suite</td><td>the test suite to destroy </td></tr>
1.516 + </table>
1.517 + </dd>
1.518 +</dl>
1.519 +
1.520 +</div>
1.521 +</div>
1.522 +<a id="a531f0df90363e0befbe900878f65f09e"></a>
1.523 +<h2 class="memtitle"><span class="permalink"><a href="#a531f0df90363e0befbe900878f65f09e">◆ </a></span>ucx_test_suite_new()</h2>
1.524 +
1.525 +<div class="memitem">
1.526 +<div class="memproto">
1.527 + <table class="memname">
1.528 + <tr>
1.529 + <td class="memname"><a class="el" href="structUcxTestSuite.html">UcxTestSuite</a>* ucx_test_suite_new </td>
1.530 + <td>(</td>
1.531 + <td class="paramname"></td><td>)</td>
1.532 + <td></td>
1.533 + </tr>
1.534 + </table>
1.535 +</div><div class="memdoc">
1.536 +
1.537 +<p>Creates a new test suite. </p>
1.538 +<dl class="section return"><dt>Returns</dt><dd>a new test suite </dd></dl>
1.539 +
1.540 +</div>
1.541 +</div>
1.542 +</div><!-- contents -->
1.543 +<!-- start footer part -->
1.544 +<hr class="footer"/><address class="footer"><small>
1.545 +Generated on Thu Dec 19 2019 19:58:24 for ucx by  <a href="http://www.doxygen.org/index.html">
1.546 +<img class="footer" src="doxygen.png" alt="doxygen"/>
1.547 +</a> 1.8.13
1.548 +</small></address>
1.549 +</body>
1.550 +</html>
