aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/PxAssert_8h-source.html
blob: 6beeadeee20f5dd420886a8f148196cdca065036 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxAssert.h Source File</title>
		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
		<LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css">
	</head>

	<body bgcolor="#FFFFFF">
		<div id="header">
			<hr class="first">
			<img alt="" src="images/PhysXlogo.png" align="middle"> <br>
			<center>
				<a class="qindex" href="main.html">Main Page</a> &nbsp; 
				<a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; 
				<a class="qindex" href="annotated.html">Compound List</a> &nbsp; 
				<a class="qindex" href="functions.html">Compound Members</a> &nbsp;  
			</center>
			<hr class="second">
		</div>
<!-- Generated by Doxygen 1.5.8 -->
<h1>PxAssert.h</h1><a href="PxAssert_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">//</span>
<a name="l00002"></a>00002 <span class="comment">// Redistribution and use in source and binary forms, with or without</span>
<a name="l00003"></a>00003 <span class="comment">// modification, are permitted provided that the following conditions</span>
<a name="l00004"></a>00004 <span class="comment">// are met:</span>
<a name="l00005"></a>00005 <span class="comment">//  * Redistributions of source code must retain the above copyright</span>
<a name="l00006"></a>00006 <span class="comment">//    notice, this list of conditions and the following disclaimer.</span>
<a name="l00007"></a>00007 <span class="comment">//  * Redistributions in binary form must reproduce the above copyright</span>
<a name="l00008"></a>00008 <span class="comment">//    notice, this list of conditions and the following disclaimer in the</span>
<a name="l00009"></a>00009 <span class="comment">//    documentation and/or other materials provided with the distribution.</span>
<a name="l00010"></a>00010 <span class="comment">//  * Neither the name of NVIDIA CORPORATION nor the names of its</span>
<a name="l00011"></a>00011 <span class="comment">//    contributors may be used to endorse or promote products derived</span>
<a name="l00012"></a>00012 <span class="comment">//    from this software without specific prior written permission.</span>
<a name="l00013"></a>00013 <span class="comment">//</span>
<a name="l00014"></a>00014 <span class="comment">// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY</span>
<a name="l00015"></a>00015 <span class="comment">// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span>
<a name="l00016"></a>00016 <span class="comment">// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR</span>
<a name="l00017"></a>00017 <span class="comment">// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR</span>
<a name="l00018"></a>00018 <span class="comment">// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span>
<a name="l00019"></a>00019 <span class="comment">// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span>
<a name="l00020"></a>00020 <span class="comment">// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</span>
<a name="l00021"></a>00021 <span class="comment">// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY</span>
<a name="l00022"></a>00022 <span class="comment">// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span>
<a name="l00023"></a>00023 <span class="comment">// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span>
<a name="l00024"></a>00024 <span class="comment">// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
<a name="l00025"></a>00025 <span class="comment">//</span>
<a name="l00026"></a>00026 <span class="comment">// Copyright (c) 2008-2018 NVIDIA Corporation. All rights reserved.</span>
<a name="l00027"></a>00027 <span class="comment">// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.</span>
<a name="l00028"></a>00028 <span class="comment">// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.</span>
<a name="l00029"></a>00029 
<a name="l00030"></a>00030 <span class="preprocessor">#ifndef PXFOUNDATION_PXASSERT_H</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#define PXFOUNDATION_PXASSERT_H</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00036"></a>00036 <span class="preprocessor">#include "<a class="code" href="Px_8h.html">foundation/Px.h</a>"</span>
<a name="l00037"></a>00037 
<a name="l00038"></a>00038 <span class="preprocessor">#if !PX_DOXYGEN</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="keyword">namespace </span>physx
<a name="l00040"></a>00040 {
<a name="l00041"></a>00041 <span class="preprocessor">#endif</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span>
<a name="l00043"></a>00043 <span class="comment">/* Base class to handle assert failures */</span>
<a name="l00044"></a><a class="code" href="classPxAssertHandler.html">00044</a> <span class="keyword">class </span><a class="code" href="classPxAssertHandler.html">PxAssertHandler</a>
<a name="l00045"></a>00045 {
<a name="l00046"></a>00046   <span class="keyword">public</span>:
<a name="l00047"></a><a class="code" href="classPxAssertHandler.html#65e427030347eb6bd67d859f3e562563">00047</a>     <span class="keyword">virtual</span> ~<a class="code" href="classPxAssertHandler.html">PxAssertHandler</a>()
<a name="l00048"></a>00048     {
<a name="l00049"></a>00049     }
<a name="l00050"></a>00050     <span class="keyword">virtual</span> <span class="keywordtype">void</span> operator()(<span class="keyword">const</span> <span class="keywordtype">char</span>* exp, <span class="keyword">const</span> <span class="keywordtype">char</span>* file, <span class="keywordtype">int</span> line, <span class="keywordtype">bool</span>&amp; ignore) = 0;
<a name="l00051"></a>00051 };
<a name="l00052"></a>00052 
<a name="l00053"></a>00053 PX_FOUNDATION_API <a class="code" href="classPxAssertHandler.html">PxAssertHandler</a>&amp; <a class="code" href="group__foundation.html#g2184ad1a4338eacc3e80cfaa1d2024e5">PxGetAssertHandler</a>();
<a name="l00054"></a>00054 PX_FOUNDATION_API <span class="keywordtype">void</span> <a class="code" href="group__foundation.html#g315fba4871d4de90d9e36b992b43aaf6">PxSetAssertHandler</a>(<a class="code" href="classPxAssertHandler.html">PxAssertHandler</a>&amp; handler);
<a name="l00055"></a>00055 
<a name="l00056"></a>00056 <span class="preprocessor">#if !PX_DOXYGEN</span>
<a name="l00057"></a>00057 <span class="preprocessor"></span>} <span class="comment">// namespace physx</span>
<a name="l00058"></a>00058 <span class="preprocessor">#endif</span>
<a name="l00059"></a>00059 <span class="preprocessor"></span>
<a name="l00060"></a>00060 <span class="preprocessor">#if !PX_ENABLE_ASSERTS</span>
<a name="l00061"></a><a class="code" href="group__foundation.html#g4a83a657390b324a460f14684e5accee">00061</a> <span class="preprocessor"></span><span class="preprocessor">#define PX_ASSERT(exp) ((void)0)</span>
<a name="l00062"></a><a class="code" href="group__foundation.html#g5ff30cdf70b6b77fc0a17427ad5ef7de">00062</a> <span class="preprocessor"></span><span class="preprocessor">#define PX_ALWAYS_ASSERT_MESSAGE(exp) ((void)0)</span>
<a name="l00063"></a><a class="code" href="group__foundation.html#g09414aeb1a283b875edb1fa83e551aca">00063</a> <span class="preprocessor"></span><span class="preprocessor">#define PX_ASSERT_WITH_MESSAGE(condition, message) ((void)0)</span>
<a name="l00064"></a>00064 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00065"></a>00065 <span class="preprocessor"></span><span class="preprocessor">#if PX_VC</span>
<a name="l00066"></a>00066 <span class="preprocessor"></span><span class="preprocessor">#define PX_CODE_ANALYSIS_ASSUME(exp)                                                                                   \</span>
<a name="l00067"></a>00067 <span class="preprocessor">    __analysis_assume(!!(exp)) // This macro will be used to get rid of analysis warning messages if a PX_ASSERT is used</span>
<a name="l00068"></a>00068 <span class="preprocessor"></span><span class="comment">// to "guard" illegal mem access, for example.</span>
<a name="l00069"></a>00069 <span class="preprocessor">#else</span>
<a name="l00070"></a>00070 <span class="preprocessor"></span><span class="preprocessor">#define PX_CODE_ANALYSIS_ASSUME(exp)</span>
<a name="l00071"></a>00071 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00072"></a>00072 <span class="preprocessor"></span><span class="preprocessor">#define PX_ASSERT(exp)                                                                                                 \</span>
<a name="l00073"></a>00073 <span class="preprocessor">    {                                                                                                                  \</span>
<a name="l00074"></a>00074 <span class="preprocessor">        static bool _ignore = false;                                                                                   \</span>
<a name="l00075"></a>00075 <span class="preprocessor">        ((void)((!!(exp)) || (!_ignore &amp;&amp; (physx::PxGetAssertHandler()(#exp, __FILE__, __LINE__, _ignore), false))));  \</span>
<a name="l00076"></a>00076 <span class="preprocessor">        PX_CODE_ANALYSIS_ASSUME(exp);                                                                                  \</span>
<a name="l00077"></a>00077 <span class="preprocessor">    }</span>
<a name="l00078"></a>00078 <span class="preprocessor"></span><span class="preprocessor">#define PX_ALWAYS_ASSERT_MESSAGE(exp)                                                                                  \</span>
<a name="l00079"></a>00079 <span class="preprocessor">    {                                                                                                                  \</span>
<a name="l00080"></a>00080 <span class="preprocessor">        static bool _ignore = false;                                                                                   \</span>
<a name="l00081"></a>00081 <span class="preprocessor">        if(!_ignore)                                                                                                   \</span>
<a name="l00082"></a>00082 <span class="preprocessor">            physx::PxGetAssertHandler()(exp, __FILE__, __LINE__, _ignore);                                             \</span>
<a name="l00083"></a>00083 <span class="preprocessor">    }</span>
<a name="l00084"></a>00084 <span class="preprocessor"></span><span class="preprocessor">#define PX_ASSERT_WITH_MESSAGE(exp, message)                                                                             \</span>
<a name="l00085"></a>00085 <span class="preprocessor">    {                                                                                                                    \</span>
<a name="l00086"></a>00086 <span class="preprocessor">        static bool _ignore = false;                                                                                     \</span>
<a name="l00087"></a>00087 <span class="preprocessor">        ((void)((!!(exp)) || (!_ignore &amp;&amp; (physx::PxGetAssertHandler()(message, __FILE__, __LINE__, _ignore), false)))); \</span>
<a name="l00088"></a>00088 <span class="preprocessor">        PX_CODE_ANALYSIS_ASSUME(exp);                                                                                    \</span>
<a name="l00089"></a>00089 <span class="preprocessor">    }</span>
<a name="l00090"></a>00090 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00091"></a>00091 <span class="preprocessor"></span>
<a name="l00092"></a><a class="code" href="group__foundation.html#g5332a7e82c543612744a0c821cf48b78">00092</a> <span class="preprocessor">#define PX_ALWAYS_ASSERT() PX_ASSERT(0)</span>
<a name="l00093"></a>00093 <span class="preprocessor"></span>
<a name="l00095"></a>00095 <span class="preprocessor">#endif // #ifndef PXFOUNDATION_PXASSERT_H</span>
</pre></div></div>

<hr style="width: 100%; height: 2px;"><br>
Copyright &copy; 2008-2018 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a>
</body>
</html>