PxAssert.h

Go to the documentation of this file.
00001 //
00002 // Redistribution and use in source and binary forms, with or without
00003 // modification, are permitted provided that the following conditions
00004 // are met:
00005 //  * Redistributions of source code must retain the above copyright
00006 //    notice, this list of conditions and the following disclaimer.
00007 //  * Redistributions in binary form must reproduce the above copyright
00008 //    notice, this list of conditions and the following disclaimer in the
00009 //    documentation and/or other materials provided with the distribution.
00010 //  * Neither the name of NVIDIA CORPORATION nor the names of its
00011 //    contributors may be used to endorse or promote products derived
00012 //    from this software without specific prior written permission.
00013 //
00014 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
00015 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00016 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00017 // PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
00018 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00019 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00020 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00021 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
00022 // OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00023 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00024 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00025 //
00026 // Copyright (c) 2008-2018 NVIDIA Corporation. All rights reserved.
00027 // Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
00028 // Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
00029 
00030 #ifndef PXFOUNDATION_PXASSERT_H
00031 #define PXFOUNDATION_PXASSERT_H
00032 
00036 #include "foundation/Px.h"
00037 
00038 #if !PX_DOXYGEN
00039 namespace physx
00040 {
00041 #endif
00042 
00043 /* Base class to handle assert failures */
00044 class PxAssertHandler
00045 {
00046   public:
00047     virtual ~PxAssertHandler()
00048     {
00049     }
00050     virtual void operator()(const char* exp, const char* file, int line, bool& ignore) = 0;
00051 };
00052 
00053 PX_FOUNDATION_API PxAssertHandler& PxGetAssertHandler();
00054 PX_FOUNDATION_API void PxSetAssertHandler(PxAssertHandler& handler);
00055 
00056 #if !PX_DOXYGEN
00057 } // namespace physx
00058 #endif
00059 
00060 #if !PX_ENABLE_ASSERTS
00061 #define PX_ASSERT(exp) ((void)0)
00062 #define PX_ALWAYS_ASSERT_MESSAGE(exp) ((void)0)
00063 #define PX_ASSERT_WITH_MESSAGE(condition, message) ((void)0)
00064 #else
00065 #if PX_VC
00066 #define PX_CODE_ANALYSIS_ASSUME(exp)                                                                                   \
00067     __analysis_assume(!!(exp)) // This macro will be used to get rid of analysis warning messages if a PX_ASSERT is used
00068 // to "guard" illegal mem access, for example.
00069 #else
00070 #define PX_CODE_ANALYSIS_ASSUME(exp)
00071 #endif
00072 #define PX_ASSERT(exp)                                                                                                 \
00073     {                                                                                                                  \
00074         static bool _ignore = false;                                                                                   \
00075         ((void)((!!(exp)) || (!_ignore && (physx::PxGetAssertHandler()(#exp, __FILE__, __LINE__, _ignore), false))));  \
00076         PX_CODE_ANALYSIS_ASSUME(exp);                                                                                  \
00077     }
00078 #define PX_ALWAYS_ASSERT_MESSAGE(exp)                                                                                  \
00079     {                                                                                                                  \
00080         static bool _ignore = false;                                                                                   \
00081         if(!_ignore)                                                                                                   \
00082             physx::PxGetAssertHandler()(exp, __FILE__, __LINE__, _ignore);                                             \
00083     }
00084 #define PX_ASSERT_WITH_MESSAGE(exp, message)                                                                             \
00085     {                                                                                                                    \
00086         static bool _ignore = false;                                                                                     \
00087         ((void)((!!(exp)) || (!_ignore && (physx::PxGetAssertHandler()(message, __FILE__, __LINE__, _ignore), false)))); \
00088         PX_CODE_ANALYSIS_ASSUME(exp);                                                                                    \
00089     }
00090 #endif
00091 
00092 #define PX_ALWAYS_ASSERT() PX_ASSERT(0)
00093 
00095 #endif // #ifndef PXFOUNDATION_PXASSERT_H


Copyright © 2008-2018 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com