1999-12-17 00:11:37 +01:00
|
|
|
/***************************************************************************/
|
|
|
|
/* */
|
|
|
|
/* ftdebug.h */
|
|
|
|
/* */
|
|
|
|
/* Debugging and logging component (specification). */
|
|
|
|
/* */
|
2002-03-30 00:23:28 +01:00
|
|
|
/* Copyright 1996-2001, 2002 by */
|
1999-12-17 00:11:37 +01:00
|
|
|
/* David Turner, Robert Wilhelm, and Werner Lemberg. */
|
|
|
|
/* */
|
2000-07-18 08:50:03 +02:00
|
|
|
/* This file is part of the FreeType project, and may only be used, */
|
|
|
|
/* modified, and distributed under the terms of the FreeType project */
|
1999-12-17 00:11:37 +01:00
|
|
|
/* license, LICENSE.TXT. By continuing to use, modify, or distribute */
|
|
|
|
/* this file you indicate that you have read the license and */
|
|
|
|
/* understand and accept it fully. */
|
|
|
|
/* */
|
2002-07-09 01:02:32 +02:00
|
|
|
/* */
|
|
|
|
/* IMPORTANT: A description of FreeType's debugging support can be */
|
|
|
|
/* found in "docs/DEBUG.TXT". Read it if you need to use */
|
|
|
|
/* or understand this code. */
|
|
|
|
/* */
|
1999-12-17 00:11:37 +01:00
|
|
|
/***************************************************************************/
|
|
|
|
|
|
|
|
|
2000-12-01 00:12:33 +01:00
|
|
|
#ifndef __FTDEBUG_H__
|
|
|
|
#define __FTDEBUG_H__
|
1999-12-17 00:11:37 +01:00
|
|
|
|
2000-12-09 01:45:38 +01:00
|
|
|
|
|
|
|
#include <ft2build.h>
|
|
|
|
#include FT_CONFIG_CONFIG_H
|
|
|
|
|
1999-12-17 00:11:37 +01:00
|
|
|
|
2000-12-01 00:12:33 +01:00
|
|
|
FT_BEGIN_HEADER
|
1999-12-17 00:11:37 +01:00
|
|
|
|
2000-12-09 01:45:38 +01:00
|
|
|
|
2002-03-30 00:23:28 +01:00
|
|
|
/* force the definition of FT_DEBUG_LEVEL_ERROR if FT_DEBUG_LEVEL_TRACE */
|
|
|
|
/* is already defined; this simplifies the following #ifdefs */
|
|
|
|
/* */
|
1999-12-17 00:11:37 +01:00
|
|
|
#ifdef FT_DEBUG_LEVEL_TRACE
|
2002-02-22 01:58:04 +01:00
|
|
|
#undef FT_DEBUG_LEVEL_ERROR
|
|
|
|
#define FT_DEBUG_LEVEL_ERROR
|
2002-02-21 12:48:48 +01:00
|
|
|
#endif
|
1999-12-17 00:11:37 +01:00
|
|
|
|
|
|
|
|
2002-02-21 12:48:48 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* */
|
2002-03-30 00:23:28 +01:00
|
|
|
/* Define the trace enums as well as the trace levels array when they */
|
|
|
|
/* are needed. */
|
2002-02-21 12:48:48 +01:00
|
|
|
/* */
|
|
|
|
/*************************************************************************/
|
2000-06-03 08:03:11 +02:00
|
|
|
|
2002-02-21 12:48:48 +01:00
|
|
|
#ifdef FT_DEBUG_LEVEL_TRACE
|
|
|
|
|
2002-02-22 01:58:04 +01:00
|
|
|
#define FT_TRACE_DEF( x ) trace_ ## x ,
|
2002-02-21 12:48:48 +01:00
|
|
|
|
2002-07-09 01:02:32 +02:00
|
|
|
/* defining the enumeration */
|
2002-02-21 12:48:48 +01:00
|
|
|
typedef enum
|
1999-12-17 00:11:37 +01:00
|
|
|
{
|
2002-07-09 01:02:32 +02:00
|
|
|
#include FT_INTERNAL_TRACE_H
|
2002-02-22 01:58:04 +01:00
|
|
|
trace_count
|
1999-12-17 00:11:37 +01:00
|
|
|
|
|
|
|
} FT_Trace;
|
|
|
|
|
2000-07-18 08:50:03 +02:00
|
|
|
|
2002-02-22 01:58:04 +01:00
|
|
|
/* defining the array of trace levels, provided by `src/base/ftdebug.c' */
|
2002-03-30 00:23:28 +01:00
|
|
|
extern int ft_trace_levels[trace_count];
|
2002-02-21 12:48:48 +01:00
|
|
|
|
2002-02-22 01:58:04 +01:00
|
|
|
#undef FT_TRACE_DEF
|
2002-02-21 12:48:48 +01:00
|
|
|
|
|
|
|
#endif /* FT_DEBUG_LEVEL_TRACE */
|
|
|
|
|
1999-12-17 00:11:37 +01:00
|
|
|
|
|
|
|
/*************************************************************************/
|
|
|
|
/* */
|
2002-03-30 00:23:28 +01:00
|
|
|
/* Define the FT_TRACE macro */
|
2002-02-21 12:48:48 +01:00
|
|
|
/* */
|
1999-12-17 00:11:37 +01:00
|
|
|
/* IMPORTANT! */
|
|
|
|
/* */
|
2000-06-03 08:03:11 +02:00
|
|
|
/* Each component must define the macro FT_COMPONENT to a valid FT_Trace */
|
|
|
|
/* value before using any TRACE macro. */
|
1999-12-17 00:11:37 +01:00
|
|
|
/* */
|
|
|
|
/*************************************************************************/
|
|
|
|
|
2002-02-21 12:48:48 +01:00
|
|
|
#ifdef FT_DEBUG_LEVEL_TRACE
|
1999-12-17 00:11:37 +01:00
|
|
|
|
2002-02-22 01:58:04 +01:00
|
|
|
#define FT_TRACE( level, varformat ) \
|
2000-06-03 08:03:11 +02:00
|
|
|
do \
|
|
|
|
{ \
|
|
|
|
if ( ft_trace_levels[FT_COMPONENT] >= level ) \
|
2000-11-29 16:18:54 +01:00
|
|
|
FT_Message varformat; \
|
2000-01-08 18:10:33 +01:00
|
|
|
} while ( 0 )
|
1999-12-17 00:11:37 +01:00
|
|
|
|
2002-02-21 12:48:48 +01:00
|
|
|
#else /* !FT_DEBUG_LEVEL_TRACE */
|
|
|
|
|
2002-02-22 01:58:04 +01:00
|
|
|
#define FT_TRACE( level, varformat ) do ; while ( 0 ) /* nothing */
|
2002-02-21 12:48:48 +01:00
|
|
|
|
|
|
|
#endif /* !FT_DEBUG_LEVEL_TRACE */
|
1999-12-17 00:11:37 +01:00
|
|
|
|
2002-02-22 01:58:04 +01:00
|
|
|
|
2000-11-07 18:21:11 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* */
|
2002-02-21 12:48:48 +01:00
|
|
|
/* You need two opening resp. closing parentheses! */
|
2000-11-07 18:21:11 +01:00
|
|
|
/* */
|
2002-02-21 12:48:48 +01:00
|
|
|
/* Example: FT_TRACE0(( "Value is %i", foo )) */
|
2000-11-07 18:21:11 +01:00
|
|
|
/* */
|
2002-02-21 12:48:48 +01:00
|
|
|
/*************************************************************************/
|
1999-12-17 00:11:37 +01:00
|
|
|
|
2002-02-21 12:48:48 +01:00
|
|
|
#define FT_TRACE0( varformat ) FT_TRACE( 0, varformat )
|
|
|
|
#define FT_TRACE1( varformat ) FT_TRACE( 1, varformat )
|
|
|
|
#define FT_TRACE2( varformat ) FT_TRACE( 2, varformat )
|
|
|
|
#define FT_TRACE3( varformat ) FT_TRACE( 3, varformat )
|
|
|
|
#define FT_TRACE4( varformat ) FT_TRACE( 4, varformat )
|
|
|
|
#define FT_TRACE5( varformat ) FT_TRACE( 5, varformat )
|
|
|
|
#define FT_TRACE6( varformat ) FT_TRACE( 6, varformat )
|
|
|
|
#define FT_TRACE7( varformat ) FT_TRACE( 7, varformat )
|
1999-12-17 00:11:37 +01:00
|
|
|
|
|
|
|
|
2002-02-21 12:48:48 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* */
|
|
|
|
/* Define the FT_ERROR macro */
|
|
|
|
/* */
|
|
|
|
/*************************************************************************/
|
1999-12-17 00:11:37 +01:00
|
|
|
|
2002-02-21 12:48:48 +01:00
|
|
|
#ifdef FT_DEBUG_LEVEL_ERROR
|
1999-12-17 00:11:37 +01:00
|
|
|
|
2002-02-22 01:58:04 +01:00
|
|
|
#define FT_ERROR( varformat ) FT_Message varformat
|
1999-12-17 00:11:37 +01:00
|
|
|
|
2002-02-21 12:48:48 +01:00
|
|
|
#else /* !FT_DEBUG_LEVEL_ERROR */
|
1999-12-17 00:11:37 +01:00
|
|
|
|
2002-02-22 01:58:04 +01:00
|
|
|
#define FT_ERROR( varformat ) do ; while ( 0 ) /* nothing */
|
1999-12-17 00:11:37 +01:00
|
|
|
|
2002-02-21 12:48:48 +01:00
|
|
|
#endif /* !FT_DEBUG_LEVEL_ERROR */
|
1999-12-17 00:11:37 +01:00
|
|
|
|
|
|
|
|
|
|
|
/*************************************************************************/
|
|
|
|
/* */
|
2002-03-30 00:23:28 +01:00
|
|
|
/* Define the FT_ASSERT macro */
|
1999-12-17 00:11:37 +01:00
|
|
|
/* */
|
|
|
|
/*************************************************************************/
|
|
|
|
|
2002-02-21 12:48:48 +01:00
|
|
|
#ifdef FT_DEBUG_LEVEL_ERROR
|
2000-06-03 08:03:11 +02:00
|
|
|
|
2002-02-21 12:48:48 +01:00
|
|
|
#define FT_ASSERT( condition ) \
|
2000-01-08 18:10:33 +01:00
|
|
|
do \
|
|
|
|
{ \
|
|
|
|
if ( !( condition ) ) \
|
|
|
|
FT_Panic( "assertion failed on line %d of file %s\n", \
|
|
|
|
__LINE__, __FILE__ ); \
|
|
|
|
} while ( 0 )
|
1999-12-17 00:11:37 +01:00
|
|
|
|
2002-02-21 12:48:48 +01:00
|
|
|
#else /* !FT_DEBUG_LEVEL_ERROR */
|
|
|
|
|
2002-02-22 01:58:04 +01:00
|
|
|
#define FT_ASSERT( condition ) do ; while ( 0 )
|
2002-02-21 12:48:48 +01:00
|
|
|
|
|
|
|
#endif /* !FT_DEBUG_LEVEL_ERROR */
|
|
|
|
|
|
|
|
|
|
|
|
/*************************************************************************/
|
|
|
|
/* */
|
|
|
|
/* Define 'FT_Message' and 'FT_Panic' when needed */
|
|
|
|
/* */
|
|
|
|
/*************************************************************************/
|
|
|
|
|
|
|
|
#ifdef FT_DEBUG_LEVEL_ERROR
|
|
|
|
|
|
|
|
#include "stdio.h" /* for vprintf() */
|
|
|
|
|
2000-01-08 18:10:33 +01:00
|
|
|
/* print a message */
|
2001-06-28 19:49:10 +02:00
|
|
|
FT_EXPORT( void )
|
|
|
|
FT_Message( const char* fmt, ... );
|
1999-12-17 00:11:37 +01:00
|
|
|
|
|
|
|
/* print a message and exit */
|
2001-06-28 19:49:10 +02:00
|
|
|
FT_EXPORT( void )
|
|
|
|
FT_Panic( const char* fmt, ... );
|
1999-12-17 00:11:37 +01:00
|
|
|
|
2002-02-21 12:48:48 +01:00
|
|
|
#endif /* FT_DEBUG_LEVEL_ERROR */
|
1999-12-17 00:11:37 +01:00
|
|
|
|
|
|
|
|
2002-03-30 00:23:28 +01:00
|
|
|
FT_BASE( void )
|
|
|
|
ft_debug_init( void );
|
1999-12-17 00:11:37 +01:00
|
|
|
|
2001-06-20 01:03:41 +02:00
|
|
|
|
2001-06-19 10:28:24 +02:00
|
|
|
#if defined( _MSC_VER ) /* Visual C++ (and Intel C++) */
|
|
|
|
|
2001-06-20 01:03:41 +02:00
|
|
|
/* we disable the warning `conditional expression is constant' here */
|
|
|
|
/* in order to compile cleanly with the maximum level of warnings */
|
2001-06-19 10:28:24 +02:00
|
|
|
#pragma warning( disable : 4127 )
|
|
|
|
|
|
|
|
#endif /* _MSC_VER */
|
|
|
|
|
1999-12-17 00:11:37 +01:00
|
|
|
|
2000-12-01 00:12:33 +01:00
|
|
|
FT_END_HEADER
|
1999-12-17 00:11:37 +01:00
|
|
|
|
2000-12-01 00:12:33 +01:00
|
|
|
#endif /* __FTDEBUG_H__ */
|
1999-12-17 00:11:37 +01:00
|
|
|
|
|
|
|
|
|
|
|
/* END */
|