forked from LemonHaze420/DCPopulous
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsafeprogramming.h
215 lines (191 loc) · 6.65 KB
/
safeprogramming.h
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
#ifndef _SAFE_PROGRAMMING_H_
#define _SAFE_PROGRAMMING_H_
#include "CompilerEnvironment.h"
#include <windows.h>
#include <stdlib.h>
#include <stdio.h>
#ifdef _CPPRTTI
#include <typeinfo.h>
#endif
#ifdef UNICODE
// ----
// Checks whether _ObjectRef is valid before using it!
// Outputs a debug message if the object is invalid.
#define SAFELY_CALL(_ObjectRef, _Method) \
if (!_ObjectRef) \
{ \
TCHAR dbmsg[256]; \
swprintf(dbmsg, L"WARNING: Attempt to use NULL object at line \"%d\" in \"%hs\"\n", __LINE__, __FILE__); \
OutputDebugString(dbmsg); \
} \
else \
_ObjectRef->_Method;
// ----
// A nice little macro that checks whether an object
// _ObjectRef is valid, calling a method if it is.
// Also preforms a test on the return value.
// Outputs a debug message if the object is invalid.
#define SAFELY_CONTROL(_Control, _ObjectRef, _Method, _Test, _TrueState) \
if (!_ObjectRef) \
{ \
TCHAR dbmsg[256]; \
swprintf(dbmsg, L"WARNING: Attempt to use NULL object at line \"%d\" in \"%hs\"\n", __LINE__, __FILE__); \
OutputDebugString(dbmsg); \
} \
else \
_Control (_ObjectRef->_Method _Test _TrueState)
// ----
// Prints out a string representation of the class data
#ifdef _CPPRTTI
#define SAFELY_PRINT_OBJECT(_ObjectRef) \
if (_ObjectRef) \
{ \
TCHAR dbmsg[256]; \
swprintf(dbmsg, L"Output of object %hs:\n", typeid(*_ObjectRef).name()); \
OutputDebugString(dbmsg); \
OutputDebugString(_ObjectRef->ToString()); \
OutputDebugString(TEXT("\n")); \
}
#else
#define SAFELY_PRINT_OBJECT(_ObjectRef) \
if ( (_ObjectRef) \
&& (_ObjectRef->ToString()) \
) \
{ \
OutputDebugString(TEXT("String representation of object:\n")); \
OutputDebugString(_ObjectRef->ToString()); \
OutputDebugString(TEXT("\nEnd.\n")); \
}
#endif
#else // Non-UNICODE
// ----
// Checks whether _ObjectRef is valid before using it!
// Outputs a debug message if the object is invalid.
#define SAFELY_CALL(_ObjectRef, _Method) \
if (!_ObjectRef) \
{ \
TCHAR dbmsg[256]; \
sprintf(dbmsg, "WARNING: Null object used at line \"%d\" in \"%hs\"\n", __LINE__, __FILE__); \
OutputDebugString(dbmsg); \
} \
else \
_ObjectRef->_Method;
// ----
// A nice little macro that checks whether an object
// _ObjectRef is valid, calling a method if it is.
// Also preforms a test on the return value.
// Outputs a debug message if the object is invalid.
#define SAFELY_CONTROL(_Control, _ObjectRef, _Method, _Test, _TrueState) \
if (!_ObjectRef) \
{ \
TCHAR dbmsg[256]; \
sprintf(dbmsg, "WARNING: Attempt to use NULL object at line \"%d\" in \"%hs\"\n", __LINE__, __FILE__); \
OutputDebugString(dbmsg); \
} \
else \
_Control (_ObjectRef->_Method _Test _TrueState)
// ----
// Prints out a string representation of the class data
#ifdef _CPPRTTI
#define SAFELY_PRINT_OBJECT(_ObjectRef) \
if (_ObjectRef) \
{ \
TCHAR dbmsg[256]; \
sprintf(dbmsg, "Output of object %hs:\n", typeid(*_ObjectRef).name()); \
OutputDebugString(dbmsg); \
OutputDebugString(_ObjectRef->ToString()); \
OutputDebugString("\n"); \
}
#else
#define SAFELY_PRINT_OBJECT(_ObjectRef) \
if (_ObjectRef) \
{ \
OutputDebugString("Object output:\n"); \
OutputDebugString(_ObjectRef->ToString()); \
OutputDebugString("\nEnd.\n"); \
}
#endif
#endif
// ----
// Returns the result of the method call, or NULL if the object is NULL.
#define SAFELY_RETURN(_ObjectRef, _Method) \
(_ObjectRef?_ObjectRef->_Method:NULL)
#ifdef NOT_FINAL_BUILD
// ----
// Free the object, but only if it exists!
#define SAFELY_DELETE(_ObjectRef) \
if (_ObjectRef) \
{ \
/* OutputDebugString(TEXT("DELETING ")); The compiler is crap and can't get this to work! \
TCHAR* CI = _ObjectRef->GetCreationInfo(); \
OutputDebugString(CI?CI:TEXT("Don't know\n")); \
OutputDebugString(TEXT("at line ")); \
TCHAR dbmsg[512]; \
swprintf(dbmsg, TEXT("%d in %hs\n"), __LINE__, __FILE__); \
OutputDebugString(dbmsg); */ \
delete _ObjectRef; \
_ObjectRef = NULL; \
}
#else
// ----
// Free the object, but only if it exists!
#define SAFELY_DELETE(_ObjectRef) \
if (_ObjectRef) \
{ \
delete _ObjectRef; \
_ObjectRef = NULL; \
}
#endif
#ifdef NOT_FINAL_BUILD
#define SAFELY_DELETE_C2248(_ObjectRef) \
if (_ObjectRef) \
{ \
OutputDebugString(TEXT("Deleting an object that caused C2248 compiler error (bug)."));\
delete _ObjectRef; \
_ObjectRef = NULL; \
}
#else
#define SAFELY_DELETE_C2248(_ObjectRef) \
if (_ObjectRef) \
{ \
delete _ObjectRef; \
_ObjectRef = NULL; \
}
#endif
// ----
// Free an array, but only if it exists!
#define SAFELY_DELETE_ARRAY(_ObjectRef) \
if (_ObjectRef) \
{ \
delete[] _ObjectRef; \
_ObjectRef = NULL; \
}
#ifdef NOT_FINAL_BUILD
// ----
// Create an object, and tell it where it was created.
#define NEW(_ObjectRef, _Constructor) \
_ObjectRef = new _Constructor; \
if (_ObjectRef) \
{ \
_ObjectRef->SetCreation(#_ObjectRef, #_Constructor, __FILE__, __LINE__); \
TCHAR* CI = _ObjectRef->GetCreationInfo(); \
OutputDebugString(CI?CI:TEXT("I could tell you where I'm from, but I'd have to kill ya!\n")); \
} \
else \
{ \
OutputDebugString(TEXT("Object creation FAILED!!!\n")); \
}
#else
#define NEW(_ObjectRef, _Constructor) _ObjectRef = new _Constructor;
#endif
#define NEW_C2248(_ObjectRef, _Constructor) _ObjectRef = new _Constructor;
// ----
// Lifted from Microsoft example.
// Use NODEFAULT when the default case can not be reached.
// This could speed up a switch statement.
//#ifdef _DEBUG
#define NODEFAULT ASSERT(0)
//#else
//#define NODEFAULT __assume(0)
//#endif
#endif