Files
recastnavigation/DetourAssert_8h.html

222 lines
12 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Recast Navigation: DetourAssert.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Recast Navigation
</div>
<div id="projectbrief">Navigation-mesh Toolset for Games</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('DetourAssert_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">DetourAssert.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;assert.h&gt;</code><br />
</div>
<p><a href="DetourAssert_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ad9878e9fa0121ff8d1390e21dc086951"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="DetourAssert_8h.html#ad9878e9fa0121ff8d1390e21dc086951">dtAssert</a>(expression)</td></tr>
<tr class="separator:ad9878e9fa0121ff8d1390e21dc086951"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ad95d59f19355eca1ab12d2773d36455c"><td class="memItemLeft" align="right" valign="top">typedef void()&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="DetourAssert_8h.html#ad95d59f19355eca1ab12d2773d36455c">dtAssertFailFunc</a>(const char *expression, const char *file, int line)</td></tr>
<tr class="memdesc:ad95d59f19355eca1ab12d2773d36455c"><td class="mdescLeft">&#160;</td><td class="mdescRight">An assertion failure function. <a href="DetourAssert_8h.html#ad95d59f19355eca1ab12d2773d36455c">More...</a><br /></td></tr>
<tr class="separator:ad95d59f19355eca1ab12d2773d36455c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a34ec62fa292227b2ce32428549fe2b97"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="DetourAssert_8h.html#a34ec62fa292227b2ce32428549fe2b97">dtAssertFailSetCustom</a> (<a class="el" href="DetourAssert_8h.html#ad95d59f19355eca1ab12d2773d36455c">dtAssertFailFunc</a> *assertFailFunc)</td></tr>
<tr class="memdesc:a34ec62fa292227b2ce32428549fe2b97"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the base custom assertion failure function to be used by Detour. <a href="DetourAssert_8h.html#a34ec62fa292227b2ce32428549fe2b97">More...</a><br /></td></tr>
<tr class="separator:a34ec62fa292227b2ce32428549fe2b97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad48579f8f6df6d400f91ad83a7d7cad2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="DetourAssert_8h.html#ad95d59f19355eca1ab12d2773d36455c">dtAssertFailFunc</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="DetourAssert_8h.html#ad48579f8f6df6d400f91ad83a7d7cad2">dtAssertFailGetCustom</a> ()</td></tr>
<tr class="memdesc:ad48579f8f6df6d400f91ad83a7d7cad2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the base custom assertion failure function to be used by Detour. <a href="DetourAssert_8h.html#ad48579f8f6df6d400f91ad83a7d7cad2">More...</a><br /></td></tr>
<tr class="separator:ad48579f8f6df6d400f91ad83a7d7cad2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ad9878e9fa0121ff8d1390e21dc086951"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9878e9fa0121ff8d1390e21dc086951">&#9670;&nbsp;</a></span>dtAssert</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define dtAssert</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">expression</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> { \</div>
<div class="line"> dtAssertFailFunc* failFunc = <a class="code" href="DetourAssert_8h.html#ad48579f8f6df6d400f91ad83a7d7cad2">dtAssertFailGetCustom</a>(); \</div>
<div class="line"> if(failFunc == NULL) { assert(expression); } \</div>
<div class="line"> else <span class="keywordflow">if</span>(!(expression)) { (*failFunc)(#expression, __FILE__, __LINE__); } \</div>
<div class="line"> }</div>
<div class="ttc" id="aDetourAssert_8h_html_ad48579f8f6df6d400f91ad83a7d7cad2"><div class="ttname"><a href="DetourAssert_8h.html#ad48579f8f6df6d400f91ad83a7d7cad2">dtAssertFailGetCustom</a></div><div class="ttdeci">dtAssertFailFunc * dtAssertFailGetCustom()</div><div class="ttdoc">Gets the base custom assertion failure function to be used by Detour.</div><div class="ttdef"><b>Definition:</b> DetourAssert.cpp:30</div></div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ad95d59f19355eca1ab12d2773d36455c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad95d59f19355eca1ab12d2773d36455c">&#9670;&nbsp;</a></span>dtAssertFailFunc</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void() dtAssertFailFunc(const char *expression, const char *file, int line)</td>
</tr>
</table>
</div><div class="memdoc">
<p>An assertion failure function. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="DetourAssert_8h.html#a34ec62fa292227b2ce32428549fe2b97" title="Sets the base custom assertion failure function to be used by Detour.">dtAssertFailSetCustom</a> </dd></dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ad48579f8f6df6d400f91ad83a7d7cad2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad48579f8f6df6d400f91ad83a7d7cad2">&#9670;&nbsp;</a></span>dtAssertFailGetCustom()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="DetourAssert_8h.html#ad95d59f19355eca1ab12d2773d36455c">dtAssertFailFunc</a>* dtAssertFailGetCustom </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the base custom assertion failure function to be used by Detour. </p>
</div>
</div>
<a id="a34ec62fa292227b2ce32428549fe2b97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34ec62fa292227b2ce32428549fe2b97">&#9670;&nbsp;</a></span>dtAssertFailSetCustom()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dtAssertFailSetCustom </td>
<td>(</td>
<td class="paramtype"><a class="el" href="DetourAssert_8h.html#ad95d59f19355eca1ab12d2773d36455c">dtAssertFailFunc</a> *&#160;</td>
<td class="paramname"><em>assertFailFunc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the base custom assertion failure function to be used by Detour. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">assertFailFunc</td><td>The function to be invoked in case of failure of <a class="el" href="DetourAssert_8h.html#ad9878e9fa0121ff8d1390e21dc086951">dtAssert</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.6-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_49bbc5a28a7ee729bdecc682ba5a63c9.html">Detour</a></li><li class="navelem"><a class="el" href="dir_97c6bac6df0065e0578eb2a70aa0bb50.html">Include</a></li><li class="navelem"><a class="el" href="DetourAssert_8h.html">DetourAssert.h</a></li>
&nbsp;&nbsp;<a href="https://github.com/recastnavigation/recastnavigation">Project Home</a>
| <a href="./License.txt">Licence (ZLib)</a>
| Copyright 2009 Mikko Mononen
</ul>
</div>
</body>
</html>