JavaScriptCore/wtf/Assertions.h - WebKit - Git at Google

 /* -*- mode: c++; c-basic-offset: 4 -*- */
 /*
  * Copyright (C) 2003, 2006, 2007 Apple Inc.  All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
  *    documentation and/or other materials provided with the distribution.
  *
  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */

 #ifndef WTF_Assertions_h
 #define WTF_Assertions_h

 /*
    no namespaces because this file has to be includable from C and Objective-C

    Note, this file uses many GCC extensions, but it should be compatible with
    C, Objective C, C++, and Objective C++.

    For non-debug builds, everything is disabled by default.
    Defining any of the symbols explicitly prevents this from having any effect.

    MSVC7 note: variadic macro support was added in MSVC8, so for now we disable
    those macros in MSVC7. For more info, see the MSDN document on variadic
    macros here:

    http://msdn2.microsoft.com/en-us/library/ms177415(VS.80).aspx
 */

 #include "Platform.h"

 #if COMPILER(MSVC)
 #include <stddef.h>
 #else
 #include <inttypes.h>
 #endif

 #ifdef NDEBUG
 #define ASSERTIONS_DISABLED_DEFAULT 1
 #else
 #define ASSERTIONS_DISABLED_DEFAULT 0
 #endif

 #ifndef ASSERT_DISABLED
 #define ASSERT_DISABLED ASSERTIONS_DISABLED_DEFAULT
 #endif

 #ifndef ASSERT_ARG_DISABLED
 #define ASSERT_ARG_DISABLED ASSERTIONS_DISABLED_DEFAULT
 #endif

 #ifndef FATAL_DISABLED
 #define FATAL_DISABLED ASSERTIONS_DISABLED_DEFAULT
 #endif

 #ifndef ERROR_DISABLED
 #define ERROR_DISABLED ASSERTIONS_DISABLED_DEFAULT
 #endif

 #ifndef LOG_DISABLED
 #define LOG_DISABLED ASSERTIONS_DISABLED_DEFAULT
 #endif

 #if COMPILER(GCC)
 #define WTF_PRETTY_FUNCTION __PRETTY_FUNCTION__
 #else
 #define WTF_PRETTY_FUNCTION __FUNCTION__
 #endif

 // WTF logging functions can process %@ in the format string to log a NSObject* but the printf format attribute
 // emits a warning when %@ is used in the format string.  Until <rdar://problem/5195437> is resolved we can't include
 // the attribute when being used from Objective-C code in case it decides to use %@.
 #if COMPILER(GCC) && !defined(__OBJC__)
 #define WTF_ATTRIBUTE_PRINTF(formatStringArgument, extraArguments) __attribute__((__format__(printf, formatStringArgument, extraArguments)))
 #else
 #define WTF_ATTRIBUTE_PRINTF(formatStringArgument, extraArguments)
 #endif

 /* These helper functions are always declared, but not necessarily always defined if the corresponding function is disabled. */

 #ifdef __cplusplus
 extern "C" {
 #endif

 typedef enum { WTFLogChannelOff, WTFLogChannelOn } WTFLogChannelState;

 typedef struct {
     unsigned mask;
     const char *defaultName;
     WTFLogChannelState state;
 } WTFLogChannel;

 void WTFReportAssertionFailure(const char* file, int line, const char* function, const char* assertion);
 void WTFReportAssertionFailureWithMessage(const char* file, int line, const char* function, const char* assertion, const char* format, ...) WTF_ATTRIBUTE_PRINTF(5, 6);
 void WTFReportArgumentAssertionFailure(const char* file, int line, const char* function, const char* argName, const char* assertion);
 void WTFReportFatalError(const char* file, int line, const char* function, const char* format, ...) WTF_ATTRIBUTE_PRINTF(4, 5);
 void WTFReportError(const char* file, int line, const char* function, const char* format, ...) WTF_ATTRIBUTE_PRINTF(4, 5);
 void WTFLog(WTFLogChannel* channel, const char* format, ...) WTF_ATTRIBUTE_PRINTF(2, 3);
 void WTFLogVerbose(const char* file, int line, const char* function, WTFLogChannel* channel, const char* format, ...) WTF_ATTRIBUTE_PRINTF(5, 6);

 #ifdef __cplusplus
 }
 #endif

 /* CRASH -- gets us into the debugger or the crash reporter -- signals are ignored by the crash reporter so we must do better */

 #ifndef CRASH
 #define CRASH() *(int *)(uintptr_t)0xbbadbeef = 0
 #endif

 /* ASSERT, ASSERT_WITH_MESSAGE, ASSERT_NOT_REACHED */

 #if PLATFORM(WIN_OS)
 /* FIXME: Change to use something other than ASSERT to avoid this conflict with win32. */
 #undef ASSERT
 #endif

 #if ASSERT_DISABLED

 #define ASSERT(assertion) ((void)0)
 #define ASSERT_WITH_MESSAGE(assertion, ...) ((void)0)
 #define ASSERT_NOT_REACHED() ((void)0)

 #else

 #define ASSERT(assertion) do \
     if (!(assertion)) { \
         WTFReportAssertionFailure(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, #assertion); \
         CRASH(); \
     } \
 while (0)
 #if COMPILER(MSVC7)
 #define ASSERT_WITH_MESSAGE(assertion) ((void)0)
 #else
 #define ASSERT_WITH_MESSAGE(assertion, ...) do \
     if (!(assertion)) { \
         WTFReportAssertionFailureWithMessage(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, #assertion, __VA_ARGS__); \
         CRASH(); \
     } \
 while (0)
 #endif // COMPILER(MSVC7)
 #define ASSERT_NOT_REACHED() do { \
     WTFReportAssertionFailure(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, 0); \
     CRASH(); \
 } while (0)

 #endif

 /* ASSERT_ARG */

 #if ASSERT_ARG_DISABLED

 #define ASSERT_ARG(argName, assertion) ((void)0)

 #else

 #define ASSERT_ARG(argName, assertion) do \
     if (!(assertion)) { \
         WTFReportArgumentAssertionFailure(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, #argName, #assertion); \
         CRASH(); \
     } \
 while (0)

 #endif

 /* COMPILE_ASSERT */
 #ifndef COMPILE_ASSERT
 #define COMPILE_ASSERT(exp, name) typedef int dummy##name [(exp) ? 1 : -1];
 #endif

 /* FATAL */

 #if FATAL_DISABLED
 #define FATAL(...) ((void)0)
 #elif COMPILER(MSVC7)
 #define FATAL() ((void)0)
 #else
 #define FATAL(...) do { \
     WTFReportFatalError(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, __VA_ARGS__); \
     CRASH(); \
 } while (0)
 #endif

 /* LOG_ERROR */

 #if ERROR_DISABLED
 #define LOG_ERROR(...) ((void)0)
 #elif COMPILER(MSVC7)
 #define LOG_ERROR() ((void)0)
 #else
 #define LOG_ERROR(...) WTFReportError(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, __VA_ARGS__)
 #endif

 /* LOG */

 #if LOG_DISABLED
 #define LOG(channel, ...) ((void)0)
 #elif COMPILER(MSVC7)
 #define LOG() ((void)0)
 #else
 #define LOG(channel, ...) WTFLog(&JOIN_LOG_CHANNEL_WITH_PREFIX(LOG_CHANNEL_PREFIX, channel), __VA_ARGS__)
 #define JOIN_LOG_CHANNEL_WITH_PREFIX(prefix, channel) JOIN_LOG_CHANNEL_WITH_PREFIX_LEVEL_2(prefix, channel)
 #define JOIN_LOG_CHANNEL_WITH_PREFIX_LEVEL_2(prefix, channel) prefix ## channel
 #endif

 /* LOG_VERBOSE */

 #if LOG_DISABLED
 #define LOG_VERBOSE(channel, ...) ((void)0)
 #elif COMPILER(MSVC7)
 #define LOG_VERBOSE(channel) ((void)0)
 #else
 #define LOG_VERBOSE(channel, ...) WTFLogVerbose(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, &JOIN_LOG_CHANNEL_WITH_PREFIX(LOG_CHANNEL_PREFIX, channel), __VA_ARGS__)
 #endif

 #endif // WTF_Assertions_h
	/* -- mode: c++; c-basic-offset: 4 -- */
	/*
	* Copyright (C) 2003, 2006, 2007 Apple Inc. All rights reserved.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions
	* are met:
	* 1. Redistributions of source code must retain the above copyright
	* notice, this list of conditions and the following disclaimer.
	* 2. Redistributions in binary form must reproduce the above copyright
	* notice, this list of conditions and the following disclaimer in the
	* documentation and/or other materials provided with the distribution.
	*
	* THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
	* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
	* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR
	* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
	* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
	* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
	* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
	* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	*/

	#ifndef WTF_Assertions_h
	#define WTF_Assertions_h

	/*
	no namespaces because this file has to be includable from C and Objective-C

	Note, this file uses many GCC extensions, but it should be compatible with
	C, Objective C, C++, and Objective C++.

	For non-debug builds, everything is disabled by default.
	Defining any of the symbols explicitly prevents this from having any effect.

	MSVC7 note: variadic macro support was added in MSVC8, so for now we disable
	those macros in MSVC7. For more info, see the MSDN document on variadic
	macros here:

	http://msdn2.microsoft.com/en-us/library/ms177415(VS.80).aspx
	*/

	#include "Platform.h"

	#if COMPILER(MSVC)
	#include <stddef.h>
	#else
	#include <inttypes.h>
	#endif

	#ifdef NDEBUG
	#define ASSERTIONS_DISABLED_DEFAULT 1
	#else
	#define ASSERTIONS_DISABLED_DEFAULT 0
	#endif

	#ifndef ASSERT_DISABLED
	#define ASSERT_DISABLED ASSERTIONS_DISABLED_DEFAULT
	#endif

	#ifndef ASSERT_ARG_DISABLED
	#define ASSERT_ARG_DISABLED ASSERTIONS_DISABLED_DEFAULT
	#endif

	#ifndef FATAL_DISABLED
	#define FATAL_DISABLED ASSERTIONS_DISABLED_DEFAULT
	#endif

	#ifndef ERROR_DISABLED
	#define ERROR_DISABLED ASSERTIONS_DISABLED_DEFAULT
	#endif

	#ifndef LOG_DISABLED
	#define LOG_DISABLED ASSERTIONS_DISABLED_DEFAULT
	#endif

	#if COMPILER(GCC)
	#define WTF_PRETTY_FUNCTION __PRETTY_FUNCTION__
	#else
	#define WTF_PRETTY_FUNCTION __FUNCTION__
	#endif

	// WTF logging functions can process %@ in the format string to log a NSObject* but the printf format attribute
	// emits a warning when %@ is used in the format string. Until <rdar://problem/5195437> is resolved we can't include
	// the attribute when being used from Objective-C code in case it decides to use %@.
	#if COMPILER(GCC) && !defined(__OBJC__)
	#define WTF_ATTRIBUTE_PRINTF(formatStringArgument, extraArguments) __attribute__((__format__(printf, formatStringArgument, extraArguments)))
	#else
	#define WTF_ATTRIBUTE_PRINTF(formatStringArgument, extraArguments)
	#endif

	/* These helper functions are always declared, but not necessarily always defined if the corresponding function is disabled. */

	#ifdef __cplusplus
	extern "C" {
	#endif

	typedef enum { WTFLogChannelOff, WTFLogChannelOn } WTFLogChannelState;

	typedef struct {
	unsigned mask;
	const char *defaultName;
	WTFLogChannelState state;
	} WTFLogChannel;

	void WTFReportAssertionFailure(const char* file, int line, const char* function, const char* assertion);
	void WTFReportAssertionFailureWithMessage(const char* file, int line, const char* function, const char* assertion, const char* format, ...) WTF_ATTRIBUTE_PRINTF(5, 6);
	void WTFReportArgumentAssertionFailure(const char* file, int line, const char* function, const char* argName, const char* assertion);
	void WTFReportFatalError(const char* file, int line, const char* function, const char* format, ...) WTF_ATTRIBUTE_PRINTF(4, 5);
	void WTFReportError(const char* file, int line, const char* function, const char* format, ...) WTF_ATTRIBUTE_PRINTF(4, 5);
	void WTFLog(WTFLogChannel* channel, const char* format, ...) WTF_ATTRIBUTE_PRINTF(2, 3);
	void WTFLogVerbose(const char* file, int line, const char* function, WTFLogChannel* channel, const char* format, ...) WTF_ATTRIBUTE_PRINTF(5, 6);

	#ifdef __cplusplus
	}
	#endif

	/* CRASH -- gets us into the debugger or the crash reporter -- signals are ignored by the crash reporter so we must do better */

	#ifndef CRASH
	#define CRASH() (int )(uintptr_t)0xbbadbeef = 0
	#endif

	/* ASSERT, ASSERT_WITH_MESSAGE, ASSERT_NOT_REACHED */

	#if PLATFORM(WIN_OS)
	/* FIXME: Change to use something other than ASSERT to avoid this conflict with win32. */
	#undef ASSERT
	#endif

	#if ASSERT_DISABLED

	#define ASSERT(assertion) ((void)0)
	#define ASSERT_WITH_MESSAGE(assertion, ...) ((void)0)
	#define ASSERT_NOT_REACHED() ((void)0)

	#else

	#define ASSERT(assertion) do \
	if (!(assertion)) { \
	WTFReportAssertionFailure(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, #assertion); \
	CRASH(); \
	} \
	while (0)
	#if COMPILER(MSVC7)
	#define ASSERT_WITH_MESSAGE(assertion) ((void)0)
	#else
	#define ASSERT_WITH_MESSAGE(assertion, ...) do \
	if (!(assertion)) { \
	WTFReportAssertionFailureWithMessage(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, #assertion, __VA_ARGS__); \
	CRASH(); \
	} \
	while (0)
	#endif // COMPILER(MSVC7)
	#define ASSERT_NOT_REACHED() do { \
	WTFReportAssertionFailure(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, 0); \
	CRASH(); \
	} while (0)

	#endif

	/* ASSERT_ARG */

	#if ASSERT_ARG_DISABLED

	#define ASSERT_ARG(argName, assertion) ((void)0)

	#else

	#define ASSERT_ARG(argName, assertion) do \
	if (!(assertion)) { \
	WTFReportArgumentAssertionFailure(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, #argName, #assertion); \
	CRASH(); \
	} \
	while (0)

	#endif

	/* COMPILE_ASSERT */
	#ifndef COMPILE_ASSERT
	#define COMPILE_ASSERT(exp, name) typedef int dummy##name [(exp) ? 1 : -1];
	#endif

	/* FATAL */

	#if FATAL_DISABLED
	#define FATAL(...) ((void)0)
	#elif COMPILER(MSVC7)
	#define FATAL() ((void)0)
	#else
	#define FATAL(...) do { \
	WTFReportFatalError(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, __VA_ARGS__); \
	CRASH(); \
	} while (0)
	#endif

	/* LOG_ERROR */

	#if ERROR_DISABLED
	#define LOG_ERROR(...) ((void)0)
	#elif COMPILER(MSVC7)
	#define LOG_ERROR() ((void)0)
	#else
	#define LOG_ERROR(...) WTFReportError(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, __VA_ARGS__)
	#endif

	/* LOG */

	#if LOG_DISABLED
	#define LOG(channel, ...) ((void)0)
	#elif COMPILER(MSVC7)
	#define LOG() ((void)0)
	#else
	#define LOG(channel, ...) WTFLog(&JOIN_LOG_CHANNEL_WITH_PREFIX(LOG_CHANNEL_PREFIX, channel), __VA_ARGS__)
	#define JOIN_LOG_CHANNEL_WITH_PREFIX(prefix, channel) JOIN_LOG_CHANNEL_WITH_PREFIX_LEVEL_2(prefix, channel)
	#define JOIN_LOG_CHANNEL_WITH_PREFIX_LEVEL_2(prefix, channel) prefix ## channel
	#endif

	/* LOG_VERBOSE */

	#if LOG_DISABLED
	#define LOG_VERBOSE(channel, ...) ((void)0)
	#elif COMPILER(MSVC7)
	#define LOG_VERBOSE(channel) ((void)0)
	#else
	#define LOG_VERBOSE(channel, ...) WTFLogVerbose(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, &JOIN_LOG_CHANNEL_WITH_PREFIX(LOG_CHANNEL_PREFIX, channel), __VA_ARGS__)
	#endif

	#endif // WTF_Assertions_h