aboutsummaryrefslogtreecommitdiff
path: root/PxShared/include/foundation/PxAssert.h
blob: 2301f6027a6236dc79e71b2ed50f52d127c419f8 (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
// This code contains NVIDIA Confidential Information and is disclosed to you
// under a form of NVIDIA software license agreement provided separately to you.
//
// Notice
// NVIDIA Corporation and its licensors retain all intellectual property and
// proprietary rights in and to this software and related documentation and
// any modifications thereto. Any use, reproduction, disclosure, or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA Corporation is strictly prohibited.
//
// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
//
// Information and code furnished is believed to be accurate and reliable.
// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2008-2018 NVIDIA Corporation. All rights reserved.
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.

#ifndef PXFOUNDATION_PXASSERT_H
#define PXFOUNDATION_PXASSERT_H

/** \addtogroup foundation
@{ */

#include "foundation/Px.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

/* Base class to handle assert failures */
class PxAssertHandler
{
  public:
	virtual ~PxAssertHandler()
	{
	}
	virtual void operator()(const char* exp, const char* file, int line, bool& ignore) = 0;
};

PX_FOUNDATION_API PxAssertHandler& PxGetAssertHandler();
PX_FOUNDATION_API void PxSetAssertHandler(PxAssertHandler& handler);

#if !PX_DOXYGEN
} // namespace physx
#endif

#if !PX_ENABLE_ASSERTS
#define PX_ASSERT(exp) ((void)0)
#define PX_ALWAYS_ASSERT_MESSAGE(exp) ((void)0)
#define PX_ASSERT_WITH_MESSAGE(condition, message) ((void)0)
#else
#if PX_VC
#define PX_CODE_ANALYSIS_ASSUME(exp)                                                                                   \
	__analysis_assume(!!(exp)) // This macro will be used to get rid of analysis warning messages if a PX_ASSERT is used
// to "guard" illegal mem access, for example.
#else
#define PX_CODE_ANALYSIS_ASSUME(exp)
#endif
#define PX_ASSERT(exp)                                                                                                 \
	{                                                                                                                  \
		static bool _ignore = false;                                                                                   \
		((void)((!!(exp)) || (!_ignore && (physx::PxGetAssertHandler()(#exp, __FILE__, __LINE__, _ignore), false))));  \
		PX_CODE_ANALYSIS_ASSUME(exp);                                                                                  \
	}
#define PX_ALWAYS_ASSERT_MESSAGE(exp)                                                                                  \
	{                                                                                                                  \
		static bool _ignore = false;                                                                                   \
		if(!_ignore)                                                                                                   \
			physx::PxGetAssertHandler()(exp, __FILE__, __LINE__, _ignore);                                             \
	}
#define PX_ASSERT_WITH_MESSAGE(exp, message)                                                                             \
	{                                                                                                                    \
		static bool _ignore = false;                                                                                     \
		((void)((!!(exp)) || (!_ignore && (physx::PxGetAssertHandler()(message, __FILE__, __LINE__, _ignore), false)))); \
		PX_CODE_ANALYSIS_ASSUME(exp);                                                                                    \
	}
#endif

#define PX_ALWAYS_ASSERT() PX_ASSERT(0)

/** @} */
#endif // #ifndef PXFOUNDATION_PXASSERT_H