Table of Contents

Wwise SDK 2019.1.6
AkAssert.h
Go to the documentation of this file.
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Version: <VERSION> Build: <BUILDNUMBER>
25  Copyright (c) <COPYRIGHTYEAR> Audiokinetic Inc.
26 *******************************************************************************/
27 
28 #ifndef _AK_AKASSERT_H_
29 #define _AK_AKASSERT_H_
30 
31 #if defined( _DEBUG ) && !(defined AK_DISABLE_ASSERTS)
32  #ifndef AK_ENABLE_ASSERTS
33  #define AK_ENABLE_ASSERTS
34  #endif
35 #endif
36 
37 #if !defined( AKASSERT )
38 
39  #include <AK/SoundEngine/Common/AkTypes.h> //For AK_Fail/Success
41 
42  #if defined( AK_ENABLE_ASSERTS )
43 
44  #ifndef AK_ASSERT_HOOK
45  AK_CALLBACK( void, AkAssertHook)(
46  const char * in_pszExpression, ///< Expression
47  const char * in_pszFileName, ///< File Name
48  int in_lineNumber ///< Line Number
49  );
50  #define AK_ASSERT_HOOK
51  #endif
52 
53  extern AKSOUNDENGINE_API AkAssertHook g_pAssertHook;
54 
55  // These platforms use a built-in g_pAssertHook (and do not fall back to the regular assert macro)
56  #define AKASSERT(Condition) ((Condition) ? ((void) 0) : g_pAssertHook( #Condition, __FILE__, __LINE__) )
57 
58 
59  #define AKVERIFY AKASSERT
60 
61  #ifdef _DEBUG
62  #define AKASSERTD AKASSERT
63  #else
64  #define AKASSERTD(Condition) ((void)0)
65  #endif
66 
67  #else // defined( AK_ENABLE_ASSERTS )
68 
69  #define AKASSERT(Condition) ((void)0)
70  #define AKASSERTD(Condition) ((void)0)
71  #define AKVERIFY(x) ((void)(x))
72 
73  #endif // defined( AK_ENABLE_ASSERTS )
74 
75  #define AKASSERT_RANGE(Value, Min, Max) (AKASSERT(((Value) >= (Min)) && ((Value) <= (Max))))
76 
77  #define AKASSERTANDRETURN( __Expression, __ErrorCode )\
78  if (!(__Expression))\
79  {\
80  AKASSERT(__Expression);\
81  return __ErrorCode;\
82  }\
83 
84  #define AKASSERTPOINTERORFAIL( __Pointer ) AKASSERTANDRETURN( __Pointer != NULL, AK_Fail )
85  #define AKASSERTSUCCESSORRETURN( __akr ) AKASSERTANDRETURN( __akr == AK_Success, __akr )
86 
87  #define AKASSERTPOINTERORRETURN( __Pointer ) \
88  if ((__Pointer) == NULL)\
89  {\
90  AKASSERT((__Pointer) == NULL);\
91  return ;\
92  }\
93 
94  #if defined( AK_WIN ) && ( _MSC_VER >= 1600 )
95  // Compile-time assert
96  #define AKSTATICASSERT( __expr__, __msg__ ) static_assert( (__expr__), (__msg__) )
97  #else
98  // Compile-time assert
99  #define AKSTATICASSERT( __expr__, __msg__ ) typedef char __AKSTATICASSERT__[(__expr__)?1:-1]
100  #endif
101 
102 #endif // ! defined( AKASSERT )
103 
104 #ifdef AK_ENABLE_ASSERTS
105 
106 
107 //Do nothing. This is a dummy function, so that g_pAssertHook is never NULL.
108 #define DEFINEDUMMYASSERTHOOK void AkAssertHookFunc( \
109 const char* in_pszExpression,\
110 const char* in_pszFileName,\
111 int in_lineNumber)\
112 {\
113 \
114 }\
115 AkAssertHook g_pAssertHook = AkAssertHookFunc;
116 #else
117 #define DEFINEDUMMYASSERTHOOK
118 
119 #endif
120 
121 // Compile-time assert. Usage:
122 // AkStaticAssert<[your boolean expression here]>::Assert();
123 // Example:
124 // AkStaticAssert<sizeof(MyStruct) == 20>::Assert(); //If you hit this, you changed the size of MyStruct!
125 // Empty default template
126 template <bool b>
127 struct AkStaticAssert {};
128 
129 // Template specialized on true
130 template <>
131 struct AkStaticAssert<true>
132 {
133  static void Assert() {}
134 };
135 
136 #endif
137 
#define AK_CALLBACK(__TYPE__, __NAME__)
#define AKSOUNDENGINE_API
static void Assert()
Definition: AkAssert.h:133
void(* AkAssertHook)(const char *in_pszExpression, const char *in_pszFileName, int in_lineNumber)
Definition: AkSoundEngine.h:98