1 /***************************************************************************/
5 /* Debugging and logging component (body). */
7 /* Copyright 1996-2001, 2002, 2004, 2008, 2013 by */
8 /* David Turner, Robert Wilhelm, and Werner Lemberg. */
10 /* This file is part of the FreeType project, and may only be used, */
11 /* modified, and distributed under the terms of the FreeType project */
12 /* license, LICENSE.TXT. By continuing to use, modify, or distribute */
13 /* this file you indicate that you have read the license and */
14 /* understand and accept it fully. */
16 /***************************************************************************/
19 /*************************************************************************/
21 /* This component contains various macros and functions used to ease the */
22 /* debugging of the FreeType engine. Its main purpose is in assertion */
23 /* checking, tracing, and error detection. */
25 /* There are now three debugging modes: */
29 /* Error and trace messages are sent to the log file (which can be the */
30 /* standard error output). */
34 /* Only error messages are generated. */
38 /* No error message is sent or generated. The code is free from any */
39 /* debugging parts. */
41 /*************************************************************************/
45 #include FT_FREETYPE_H
46 #include FT_INTERNAL_DEBUG_H
49 #ifdef FT_DEBUG_LEVEL_ERROR
51 /* documentation is in ftdebug.h */
54 FT_Message( const char* fmt
,
61 vfprintf( stderr
, fmt
, ap
);
66 /* documentation is in ftdebug.h */
69 FT_Panic( const char* fmt
,
76 vfprintf( stderr
, fmt
, ap
);
83 /* documentation is in ftdebug.h */
86 FT_Throw( FT_Error error
,
97 #endif /* FT_DEBUG_LEVEL_ERROR */
101 #ifdef FT_DEBUG_LEVEL_TRACE
103 /* array of trace levels, initialized to 0 */
104 int ft_trace_levels
[trace_count
];
107 /* define array of trace toggle names */
108 #define FT_TRACE_DEF( x ) #x ,
110 static const char* ft_trace_toggles
[trace_count
+ 1] =
112 #include FT_INTERNAL_TRACE_H
119 /* documentation is in ftdebug.h */
121 FT_BASE_DEF( FT_Int
)
122 FT_Trace_Get_Count( void )
128 /* documentation is in ftdebug.h */
130 FT_BASE_DEF( const char * )
131 FT_Trace_Get_Name( FT_Int idx
)
133 int max
= FT_Trace_Get_Count();
137 return ft_trace_toggles
[idx
];
143 /*************************************************************************/
145 /* Initialize the tracing sub-system. This is done by retrieving the */
146 /* value of the `FT2_DEBUG' environment variable. It must be a list of */
147 /* toggles, separated by spaces, `;', or `,'. Example: */
149 /* export FT2_DEBUG="any:3 memory:7 stream:5" */
151 /* This requests that all levels be set to 3, except the trace level for */
152 /* the memory and stream components which are set to 7 and 5, */
155 /* See the file <include/internal/fttrace.h> for details of the */
156 /* available toggle names. */
158 /* The level must be between 0 and 7; 0 means quiet (except for serious */
159 /* runtime errors), and 7 means _very_ verbose. */
162 ft_debug_init( void )
164 const char* ft2_debug
= getenv( "FT2_DEBUG" );
169 const char* p
= ft2_debug
;
175 /* skip leading whitespace and separators */
176 if ( *p
== ' ' || *p
== '\t' || *p
== ',' || *p
== ';' || *p
== '=' )
179 /* read toggle name, followed by ':' */
181 while ( *p
&& *p
!= ':' )
187 if ( *p
== ':' && p
> q
)
189 FT_Int n
, i
, len
= (FT_Int
)( p
- q
);
190 FT_Int level
= -1, found
= -1;
193 for ( n
= 0; n
< trace_count
; n
++ )
195 const char* toggle
= ft_trace_toggles
[n
];
198 for ( i
= 0; i
< len
; i
++ )
200 if ( toggle
[i
] != q
[i
] )
204 if ( i
== len
&& toggle
[i
] == 0 )
216 if ( level
< 0 || level
> 7 )
220 if ( found
>= 0 && level
>= 0 )
222 if ( found
== trace_any
)
224 /* special case for `any' */
225 for ( n
= 0; n
< trace_count
; n
++ )
226 ft_trace_levels
[n
] = level
;
229 ft_trace_levels
[found
] = level
;
237 #else /* !FT_DEBUG_LEVEL_TRACE */
241 ft_debug_init( void )
247 FT_BASE_DEF( FT_Int
)
248 FT_Trace_Get_Count( void )
254 FT_BASE_DEF( const char * )
255 FT_Trace_Get_Name( FT_Int idx
)
263 #endif /* !FT_DEBUG_LEVEL_TRACE */