debug.h   [plain text]

/*
 * Copyright (c) 2000-2001 Apple Computer, Inc. All Rights Reserved.
 * 
 * The contents of this file constitute Original Code as defined in and are
 * subject to the Apple Public Source License Version 1.2 (the 'License').
 * You may not use this file except in compliance with the License. Please obtain
 * a copy of the License at http://www.apple.com/publicsource and read it before
 * using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
 * OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT
 * LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 * PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
 * specific language governing rights and limitations under the License.
 */


/*
	File:		debug.h

	Contains:	Debugging macros.

	Written by:	Doug Mitchell

	Copyright:	(c) 1999 by Apple Computer, Inc., all rights reserved.

	Change History (most recent first):

		12/07/99	dpm		Created.
 
*/

#ifndef	_DEBUG_H_
#define _DEBUG_H_

extern void yarrowPanic(const char *errStr);

#define ERROR_LOG_ENABLE	0

#define LOG_VIA_PRINTF		1

#if		DEBUG || ERROR_LOG_ENABLE

#include <stdio.h>

#if		!LOG_VIA_PRINTF

#include <string.h>
#include <Types.h>
#include <TextUtils.h>

#if defined(__cplusplus)
extern "C" {
#endif

/* common log macros */

extern void dblog0(char *str);
extern void dblog1(char *str, void * arg1);
extern void dblog2(char *str, void * arg1, void * arg2);
extern void dblog3(char *str, void * arg1, void * arg2, void * arg3);
extern void dblog4(char *str, void * arg1, void * arg2, void * arg3, void * arg4);

#if defined(__cplusplus)
}
#endif

#else	/* LOG_VIA_PRINTF */

#define dblog0(str)								printf(str)
#define dblog1(str, arg1)						printf(str, arg1)
#define dblog2(str, arg1, arg2)					printf(str, arg1, arg2)
#define dblog3(str, arg1, arg2, arg3)			printf(str, arg1, arg2, arg3)
#define dblog4(str, arg1, arg2, arg3, arg4)		printf(str, arg1, arg2, arg3, arg4)

#endif	/* LOG_VIA_PRINTF */

#else	/* log macros disabled */

#define dblog0(str)
#define dblog1(str, arg1)
#define dblog2(str, arg1, arg2)
#define dblog3(str, arg1, arg2, arg3)
#define dblog4(str, arg1, arg2, arg3, arg4)

#endif	/* log macros */

#if	DEBUG

#define dprintf0(str)								dblog0(str)
#define dprintf1(str, arg1)							dblog1(str, (void *)arg1)
#define dprintf2(str, arg1, arg2)					dblog2(str, (void *)arg1, (void *)arg2)
#define dprintf3(str, arg1, arg2, arg3)				dblog3(str, (void *)arg1, (void *)arg2, (void *)arg3)
#define dprintf4(str, arg1, arg2, arg3, arg4)		dblog4(str, (void *)arg1, (void *)arg2, (void *)arg3, (void *) arg4)

#define CASSERT(expression) 							\
  ((expression) ? (void)0 : 							\
   (dprintf1 ("Assertion failed: " #expression 			\
      ", file " __FILE__ ", line %d.\n", __LINE__), 	\
    yarrowPanic("Assertion Failure")))

#else	/* DEBUG */

#define dprintf0(str)
#define dprintf1(str, arg1)
#define dprintf2(str, arg1, arg2)
#define dprintf3(str, arg1, arg2, arg3)
#define dprintf4(str, arg1, arg2, arg3, arg4)

#define CASSERT(expression)

#endif	/* DEBUG */

/*
 * Error logging. This may well be platform dependent.
 */
#if		ERROR_LOG_ENABLE
#define errorLog0(str)								dblog0(str);
#define errorLog1(str, arg1)						dblog1(str, (void *)arg1)
#define errorLog2(str, arg1, arg2)					dblog2(str, (void *)arg1, (void *)arg2)
#define errorLog3(str, arg1, arg2, arg3)			dblog3(str, (void *)arg1, (void *)arg2, (void *)arg3)
#define errorLog4(str, arg1, arg2, arg3, arg4)		dblog4(str, (void *)arg1, (void *)arg2, (void *)arg3, (void *)arg4)

#else	/* ERROR_LOG_ENABLE */

#define errorLog0(str)
#define errorLog1(str, arg1)
#define errorLog2(str, arg1, arg2)
#define errorLog3(str, arg1, arg2, arg3)
#define errorLog4(str, arg1, arg2, arg3, arg4)

#endif	/* ERROR_LOG_ENABLE */

#endif	/* _DEBUG_H_ */