source: NonGTP/FCollada/Documentation/_f_u_assert_8h.html @ 964

Revision 964, 7.8 KB checked in by igarcia, 19 years ago (diff)
RevLine 
[964]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>FCollada: FUtils/FUAssert.h File Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.4.6-NO -->
8<div class="tabs">
9  <ul>
10    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11    <li><a href="modules.html"><span>Modules</span></a></li>
12    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
13    <li><a href="classes.html"><span>Classes</span></a></li>
14    <li id="current"><a href="files.html"><span>Files</span></a></li>
15    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
16  </ul></div>
17<div class="tabs">
18  <ul>
19    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
20    <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
21  </ul></div>
22<h1>FUtils/FUAssert.h File Reference</h1>This file contains a simple debugging assertion mechanism. <a href="#_details">More...</a>
23<p>
24
25<p>
26<a href="_f_u_assert_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
27<tr><td></td></tr>
28<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
29<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_f_u_assert_8h.html#8be9594f924b19bb72ce88afbff5ae63">__DEBUGGER_BREAK</a></td></tr>
30
31<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Breaks into the debugger.  <a href="#8be9594f924b19bb72ce88afbff5ae63"></a><br></td></tr>
32<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_f_u_assert_8h.html#2aaf258bf29e8c9d10c172100670807d">FUFail</a>(command)&nbsp;&nbsp;&nbsp;{ __DEBUGGER_BREAK; command; }</td></tr>
33
34<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Forces the debugger to break, or take the fall-back.  <a href="#2aaf258bf29e8c9d10c172100670807d"></a><br></td></tr>
35<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_f_u_assert_8h.html#72b8444eb608787f1db6bf1d53e0310f">FUAssert</a>(condition, fall_back)&nbsp;&nbsp;&nbsp;{ if (!(condition)) { __DEBUGGER_BREAK; fall_back; } }</td></tr>
36
37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Asserts that a condition is met.  <a href="#72b8444eb608787f1db6bf1d53e0310f"></a><br></td></tr>
38<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_f_u_assert_8h.html#3f8e304ec999fd5b47b525eac6fa3f4d">FUCheckMemory</a>(fallback)</td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Asserts that the memory is intact.  <a href="#3f8e304ec999fd5b47b525eac6fa3f4d"></a><br></td></tr>
41</table>
42<hr><a name="_details"></a><h2>Detailed Description</h2>
43This file contains a simple debugging assertion mechanism.
44<p>
45<hr><h2>Define Documentation</h2>
46<a class="anchor" name="8be9594f924b19bb72ce88afbff5ae63"></a><!-- doxytag: member="FUAssert.h::__DEBUGGER_BREAK" ref="8be9594f924b19bb72ce88afbff5ae63" args="" --><p>
47<table class="mdTable" cellpadding="2" cellspacing="0">
48  <tr>
49    <td class="mdRow">
50      <table cellpadding="0" cellspacing="0" border="0">
51        <tr>
52          <td class="md" nowrap valign="top">#define __DEBUGGER_BREAK          </td>
53        </tr>
54      </table>
55    </td>
56  </tr>
57</table>
58<table cellspacing="5" cellpadding="0" border="0">
59  <tr>
60    <td>
61      &nbsp;
62    </td>
63    <td>
64
65<p>
66Breaks into the debugger.
67<p>
68In debug builds, this intentionally crashes the application. In release builds, this is an empty function.     </td>
69  </tr>
70</table>
71<a class="anchor" name="72b8444eb608787f1db6bf1d53e0310f"></a><!-- doxytag: member="FUAssert.h::FUAssert" ref="72b8444eb608787f1db6bf1d53e0310f" args="(condition, fall_back)" --><p>
72<table class="mdTable" cellpadding="2" cellspacing="0">
73  <tr>
74    <td class="mdRow">
75      <table cellpadding="0" cellspacing="0" border="0">
76        <tr>
77          <td class="md" nowrap valign="top">#define FUAssert          </td>
78          <td class="md" valign="top">(&nbsp;</td>
79          <td class="md" nowrap valign="top">condition,         <tr>
80          <td class="md" nowrap align="right"></td>
81          <td class="md"></td>
82          <td class="md" nowrap>fall_back&nbsp;</td>
83          <td class="mdname1" valign="top" nowrap>          </td>
84          <td class="md" valign="top">&nbsp;)&nbsp;</td>
85          <td class="md" nowrap>&nbsp;&nbsp;&nbsp;{ if (!(condition)) { __DEBUGGER_BREAK; fall_back; } }</td>
86        </tr>
87      </table>
88    </td>
89  </tr>
90</table>
91<table cellspacing="5" cellpadding="0" border="0">
92  <tr>
93    <td>
94      &nbsp;
95    </td>
96    <td>
97
98<p>
99Asserts that a condition is met.
100<p>
101Use this macro, instead of 'if' statements when you are asserting for a programmer's error. <dl compact><dt><b>Parameters:</b></dt><dd>
102  <table border="0" cellspacing="2" cellpadding="0">
103    <tr><td valign="top"></td><td valign="top"><em>condition</em>&nbsp;</td><td>The condition to assert. </td></tr>
104    <tr><td valign="top"></td><td valign="top"><em>fall_back</em>&nbsp;</td><td>The command to execute if the condition is not met. </td></tr>
105  </table>
106</dl>
107    </td>
108  </tr>
109</table>
110<a class="anchor" name="3f8e304ec999fd5b47b525eac6fa3f4d"></a><!-- doxytag: member="FUAssert.h::FUCheckMemory" ref="3f8e304ec999fd5b47b525eac6fa3f4d" args="(fallback)" --><p>
111<table class="mdTable" cellpadding="2" cellspacing="0">
112  <tr>
113    <td class="mdRow">
114      <table cellpadding="0" cellspacing="0" border="0">
115        <tr>
116          <td class="md" nowrap valign="top">#define FUCheckMemory          </td>
117          <td class="md" valign="top">(&nbsp;</td>
118          <td class="md" nowrap valign="top">fallback&nbsp;</td>
119          <td class="mdname1" valign="top" nowrap>          </td>
120          <td class="md" valign="top">&nbsp;)&nbsp;</td>
121          <td class="md" nowrap></td>
122        </tr>
123      </table>
124    </td>
125  </tr>
126</table>
127<table cellspacing="5" cellpadding="0" border="0">
128  <tr>
129    <td>
130      &nbsp;
131    </td>
132    <td>
133
134<p>
135Asserts that the memory is intact.
136<p>
137This function is only supported on Windows, debug builds right now: it uses the _CrtCheckMemory function and is very expensive.     </td>
138  </tr>
139</table>
140<a class="anchor" name="2aaf258bf29e8c9d10c172100670807d"></a><!-- doxytag: member="FUAssert.h::FUFail" ref="2aaf258bf29e8c9d10c172100670807d" args="(command)" --><p>
141<table class="mdTable" cellpadding="2" cellspacing="0">
142  <tr>
143    <td class="mdRow">
144      <table cellpadding="0" cellspacing="0" border="0">
145        <tr>
146          <td class="md" nowrap valign="top">#define FUFail          </td>
147          <td class="md" valign="top">(&nbsp;</td>
148          <td class="md" nowrap valign="top">command&nbsp;</td>
149          <td class="mdname1" valign="top" nowrap>          </td>
150          <td class="md" valign="top">&nbsp;)&nbsp;</td>
151          <td class="md" nowrap>&nbsp;&nbsp;&nbsp;{ __DEBUGGER_BREAK; command; }</td>
152        </tr>
153      </table>
154    </td>
155  </tr>
156</table>
157<table cellspacing="5" cellpadding="0" border="0">
158  <tr>
159    <td>
160      &nbsp;
161    </td>
162    <td>
163
164<p>
165Forces the debugger to break, or take the fall-back.
166<p>
167<dl compact><dt><b>Parameters:</b></dt><dd>
168  <table border="0" cellspacing="2" cellpadding="0">
169    <tr><td valign="top"></td><td valign="top"><em>command</em>&nbsp;</td><td>The fall_back command to execute. </td></tr>
170  </table>
171</dl>
172    </td>
173  </tr>
174</table>
175<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:40 2006 for FCollada by&nbsp;
176<a href="http://www.doxygen.org/index.html">
177<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
178</body>
179</html>
Note: See TracBrowser for help on using the repository browser.