2
* Copyright (C) 2003, 2006, 2007 Apple Inc. All rights reserved.
4
* Redistribution and use in source and binary forms, with or without
5
* modification, are permitted provided that the following conditions
7
* 1. Redistributions of source code must retain the above copyright
8
* notice, this list of conditions and the following disclaimer.
9
* 2. Redistributions in binary form must reproduce the above copyright
10
* notice, this list of conditions and the following disclaimer in the
11
* documentation and/or other materials provided with the distribution.
13
* THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26
#ifndef WTF_Assertions_h
27
#define WTF_Assertions_h
30
no namespaces because this file has to be includable from C and Objective-C
32
Note, this file uses many GCC extensions, but it should be compatible with
33
C, Objective C, C++, and Objective C++.
35
For non-debug builds, everything is disabled by default.
36
Defining any of the symbols explicitly prevents this from having any effect.
38
MSVC7 note: variadic macro support was added in MSVC8, so for now we disable
39
those macros in MSVC7. For more info, see the MSDN document on variadic
42
http://msdn2.microsoft.com/en-us/library/ms177415(VS.80).aspx
59
#define ASSERTIONS_DISABLED_DEFAULT 1
61
#define ASSERTIONS_DISABLED_DEFAULT 0
64
#ifndef ASSERT_DISABLED
65
#define ASSERT_DISABLED ASSERTIONS_DISABLED_DEFAULT
68
#ifndef ASSERT_ARG_DISABLED
69
#define ASSERT_ARG_DISABLED ASSERTIONS_DISABLED_DEFAULT
72
#ifndef FATAL_DISABLED
73
#define FATAL_DISABLED ASSERTIONS_DISABLED_DEFAULT
76
#ifndef ERROR_DISABLED
77
#define ERROR_DISABLED ASSERTIONS_DISABLED_DEFAULT
81
#define LOG_DISABLED ASSERTIONS_DISABLED_DEFAULT
85
#define WTF_PRETTY_FUNCTION __PRETTY_FUNCTION__
87
#define WTF_PRETTY_FUNCTION __FUNCTION__
90
/* WTF logging functions can process %@ in the format string to log a NSObject* but the printf format attribute
91
emits a warning when %@ is used in the format string. Until <rdar://problem/5195437> is resolved we can't include
92
the attribute when being used from Objective-C code in case it decides to use %@. */
93
#if COMPILER(GCC) && !defined(__OBJC__)
94
#define WTF_ATTRIBUTE_PRINTF(formatStringArgument, extraArguments) __attribute__((__format__(printf, formatStringArgument, extraArguments)))
96
#define WTF_ATTRIBUTE_PRINTF(formatStringArgument, extraArguments)
99
/* These helper functions are always declared, but not necessarily always defined if the corresponding function is disabled. */
105
typedef enum { WTFLogChannelOff, WTFLogChannelOn } WTFLogChannelState;
109
const char *defaultName;
110
WTFLogChannelState state;
113
void WTFReportAssertionFailure(const char* file, int line, const char* function, const char* assertion);
114
void WTFReportAssertionFailureWithMessage(const char* file, int line, const char* function, const char* assertion, const char* format, ...) WTF_ATTRIBUTE_PRINTF(5, 6);
115
void WTFReportArgumentAssertionFailure(const char* file, int line, const char* function, const char* argName, const char* assertion);
116
void WTFReportFatalError(const char* file, int line, const char* function, const char* format, ...) WTF_ATTRIBUTE_PRINTF(4, 5);
117
void WTFReportError(const char* file, int line, const char* function, const char* format, ...) WTF_ATTRIBUTE_PRINTF(4, 5);
118
void WTFLog(WTFLogChannel* channel, const char* format, ...) WTF_ATTRIBUTE_PRINTF(2, 3);
119
void WTFLogVerbose(const char* file, int line, const char* function, WTFLogChannel* channel, const char* format, ...) WTF_ATTRIBUTE_PRINTF(5, 6);
125
/* CRASH -- gets us into the debugger or the crash reporter -- signals are ignored by the crash reporter so we must do better */
128
#if PLATFORM(SYMBIAN)
129
#define CRASH() do { \
131
User::Panic(_L("Webkit CRASH"),0); \
134
#define CRASH() do { \
135
*(int *)(uintptr_t)0xbbadbeef = 0; \
136
((void(*)())0)(); /* More reliable, but doesn't say BBADBEEF */ \
141
/* ASSERT, ASSERT_WITH_MESSAGE, ASSERT_NOT_REACHED */
143
#if PLATFORM(WINCE) && !PLATFORM(TORCHMOBILE)
144
/* FIXME: We include this here only to avoid a conflict with the ASSERT macro. */
151
#if PLATFORM(WIN_OS) || PLATFORM(SYMBIAN)
152
/* FIXME: Change to use something other than ASSERT to avoid this conflict with the underlying platform */
158
#define ASSERT(assertion) ((void)0)
160
#define ASSERT_WITH_MESSAGE(assertion) ((void)0)
161
#elif PLATFORM(SYMBIAN)
162
#define ASSERT_WITH_MESSAGE(assertion...) ((void)0)
164
#define ASSERT_WITH_MESSAGE(assertion, ...) ((void)0)
165
#endif /* COMPILER(MSVC7) */
166
#define ASSERT_NOT_REACHED() ((void)0)
167
#define ASSERT_UNUSED(variable, assertion) ((void)variable)
171
#define ASSERT(assertion) do \
172
if (!(assertion)) { \
173
WTFReportAssertionFailure(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, #assertion); \
178
#define ASSERT_WITH_MESSAGE(assertion) ((void)0)
179
#elif PLATFORM(SYMBIAN)
180
#define ASSERT_WITH_MESSAGE(assertion...) ((void)0)
182
#define ASSERT_WITH_MESSAGE(assertion, ...) do \
183
if (!(assertion)) { \
184
WTFReportAssertionFailureWithMessage(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, #assertion, __VA_ARGS__); \
188
#endif /* COMPILER(MSVC7) */
189
#define ASSERT_NOT_REACHED() do { \
190
WTFReportAssertionFailure(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, 0); \
194
#define ASSERT_UNUSED(variable, assertion) ASSERT(assertion)
200
#if ASSERT_ARG_DISABLED
202
#define ASSERT_ARG(argName, assertion) ((void)0)
206
#define ASSERT_ARG(argName, assertion) do \
207
if (!(assertion)) { \
208
WTFReportArgumentAssertionFailure(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, #argName, #assertion); \
216
#ifndef COMPILE_ASSERT
217
#define COMPILE_ASSERT(exp, name) typedef int dummy##name [(exp) ? 1 : -1]
222
#if FATAL_DISABLED && !COMPILER(MSVC7) && !PLATFORM(SYMBIAN)
223
#define FATAL(...) ((void)0)
224
#elif COMPILER(MSVC7)
225
#define FATAL() ((void)0)
226
#elif PLATFORM(SYMBIAN)
227
#define FATAL(args...) ((void)0)
229
#define FATAL(...) do { \
230
WTFReportFatalError(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, __VA_ARGS__); \
237
#if ERROR_DISABLED && !COMPILER(MSVC7) && !PLATFORM(SYMBIAN)
238
#define LOG_ERROR(...) ((void)0)
239
#elif COMPILER(MSVC7)
240
#define LOG_ERROR() ((void)0)
241
#elif PLATFORM(SYMBIAN)
242
#define LOG_ERROR(args...) ((void)0)
244
#define LOG_ERROR(...) WTFReportError(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, __VA_ARGS__)
249
#if LOG_DISABLED && !COMPILER(MSVC7) && !PLATFORM(SYMBIAN)
250
#define LOG(channel, ...) ((void)0)
251
#elif COMPILER(MSVC7)
252
#define LOG() ((void)0)
253
#elif PLATFORM(SYMBIAN)
254
#define LOG(channel, args...) ((void)0)
256
#define LOG(channel, ...) WTFLog(&JOIN_LOG_CHANNEL_WITH_PREFIX(LOG_CHANNEL_PREFIX, channel), __VA_ARGS__)
257
#define JOIN_LOG_CHANNEL_WITH_PREFIX(prefix, channel) JOIN_LOG_CHANNEL_WITH_PREFIX_LEVEL_2(prefix, channel)
258
#define JOIN_LOG_CHANNEL_WITH_PREFIX_LEVEL_2(prefix, channel) prefix ## channel
263
#if LOG_DISABLED && !COMPILER(MSVC7) && !PLATFORM(SYMBIAN)
264
#define LOG_VERBOSE(channel, ...) ((void)0)
265
#elif COMPILER(MSVC7)
266
#define LOG_VERBOSE(channel) ((void)0)
267
#elif PLATFORM(SYMBIAN)
268
#define LOG_VERBOSE(channel, args...) ((void)0)
270
#define LOG_VERBOSE(channel, ...) WTFLogVerbose(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, &JOIN_LOG_CHANNEL_WITH_PREFIX(LOG_CHANNEL_PREFIX, channel), __VA_ARGS__)
273
#endif /* WTF_Assertions_h */