David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 1 | /***************************************************************************/ |
| 2 | /* */ |
| 3 | /* ftdebug.c */ |
| 4 | /* */ |
| 5 | /* Debugging and logging component (body). */ |
| 6 | /* */ |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 7 | /* Copyright 1996-2001, 2002, 2004 by */ |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 8 | /* David Turner, Robert Wilhelm, and Werner Lemberg. */ |
| 9 | /* */ |
Werner Lemberg | 4e6dd85 | 2000-06-05 05:26:15 +0000 | [diff] [blame] | 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 */ |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 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. */ |
| 15 | /* */ |
| 16 | /***************************************************************************/ |
| 17 | |
| 18 | |
Werner Lemberg | 9a754ce | 2000-06-02 21:31:32 +0000 | [diff] [blame] | 19 | /*************************************************************************/ |
| 20 | /* */ |
| 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. */ |
| 24 | /* */ |
| 25 | /* There are now three debugging modes: */ |
| 26 | /* */ |
| 27 | /* - trace mode */ |
| 28 | /* */ |
| 29 | /* Error and trace messages are sent to the log file (which can be the */ |
| 30 | /* standard error output). */ |
| 31 | /* */ |
| 32 | /* - error mode */ |
| 33 | /* */ |
| 34 | /* Only error messages are generated. */ |
| 35 | /* */ |
| 36 | /* - release mode: */ |
| 37 | /* */ |
| 38 | /* No error message is sent or generated. The code is free from any */ |
| 39 | /* debugging parts. */ |
| 40 | /* */ |
| 41 | /*************************************************************************/ |
| 42 | |
Werner Lemberg | cc069be | 2000-12-08 16:17:16 +0000 | [diff] [blame] | 43 | |
| 44 | #include <ft2build.h> |
David Turner | 88027fd | 2002-04-17 11:32:10 +0000 | [diff] [blame] | 45 | #include FT_FREETYPE_H |
Werner Lemberg | cc069be | 2000-12-08 16:17:16 +0000 | [diff] [blame] | 46 | #include FT_INTERNAL_DEBUG_H |
| 47 | |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 48 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 49 | #if defined( FT_DEBUG_LEVEL_ERROR ) |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 50 | |
Werner Lemberg | f814d0f | 2001-06-27 16:18:10 +0000 | [diff] [blame] | 51 | FT_EXPORT_DEF( void ) |
| 52 | FT_Message( const char* fmt, ... ) |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 53 | { |
| 54 | va_list ap; |
| 55 | |
| 56 | |
| 57 | va_start( ap, fmt ); |
| 58 | vprintf( fmt, ap ); |
| 59 | va_end( ap ); |
| 60 | } |
| 61 | |
| 62 | |
Werner Lemberg | f814d0f | 2001-06-27 16:18:10 +0000 | [diff] [blame] | 63 | FT_EXPORT_DEF( void ) |
| 64 | FT_Panic( const char* fmt, ... ) |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 65 | { |
| 66 | va_list ap; |
| 67 | |
| 68 | |
| 69 | va_start( ap, fmt ); |
| 70 | vprintf( fmt, ap ); |
| 71 | va_end( ap ); |
| 72 | |
| 73 | exit( EXIT_FAILURE ); |
| 74 | } |
| 75 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 76 | #endif /* FT_DEBUG_LEVEL_ERROR */ |
| 77 | |
| 78 | |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 79 | |
| 80 | #ifdef FT_DEBUG_LEVEL_TRACE |
| 81 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 82 | /* array of trace levels, initialized to 0 */ |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 83 | int ft_trace_levels[trace_count]; |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 84 | |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 85 | |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 86 | /* define array of trace toggle names */ |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 87 | #define FT_TRACE_DEF( x ) #x , |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 88 | |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 89 | static const char* ft_trace_toggles[trace_count + 1] = |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 90 | { |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 91 | #include FT_INTERNAL_TRACE_H |
| 92 | NULL |
| 93 | }; |
| 94 | |
| 95 | #undef FT_TRACE_DEF |
| 96 | |
| 97 | |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 98 | /* documentation is in ftdebug.h */ |
| 99 | |
| 100 | FT_EXPORT_DEF( FT_Int ) |
| 101 | FT_Trace_Get_Count( void ) |
| 102 | { |
| 103 | return trace_count; |
| 104 | } |
| 105 | |
| 106 | |
| 107 | /* documentation is in ftdebug.h */ |
| 108 | |
| 109 | FT_EXPORT_DEF( const char * ) |
| 110 | FT_Trace_Get_Name( FT_Int index ) |
| 111 | { |
| 112 | int max = FT_Trace_Get_Count(); |
| 113 | |
| 114 | |
| 115 | if ( index < max ) |
| 116 | return ft_trace_toggles[index]; |
| 117 | else |
| 118 | return NULL; |
| 119 | } |
| 120 | |
| 121 | |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 122 | /*************************************************************************/ |
| 123 | /* */ |
| 124 | /* Initialize the tracing sub-system. This is done by retrieving the */ |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 125 | /* value of the `FT2_DEBUG' environment variable. It must be a list of */ |
| 126 | /* toggles, separated by spaces, `;', or `,'. Example: */ |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 127 | /* */ |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 128 | /* export FT2_DEBUG="any:3 memory:6 stream:5" */ |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 129 | /* */ |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 130 | /* This requests that all levels be set to 3, except the trace level for */ |
| 131 | /* the memory and stream components which are set to 6 and 5, */ |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 132 | /* respectively. */ |
| 133 | /* */ |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 134 | /* See the file <include/freetype/internal/fttrace.h> for details of the */ |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 135 | /* available toggle names. */ |
| 136 | /* */ |
| 137 | /* The level must be between 0 and 6; 0 means quiet (except for serious */ |
| 138 | /* runtime errors), and 6 means _very_ verbose. */ |
| 139 | /* */ |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 140 | FT_BASE_DEF( void ) |
| 141 | ft_debug_init( void ) |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 142 | { |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 143 | const char* ft2_debug = getenv( "FT2_DEBUG" ); |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 144 | |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 145 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 146 | if ( ft2_debug ) |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 147 | { |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 148 | const char* p = ft2_debug; |
| 149 | const char* q; |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 150 | |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 151 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 152 | for ( ; *p; p++ ) |
| 153 | { |
| 154 | /* skip leading whitespace and separators */ |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 155 | if ( *p == ' ' || *p == '\t' || *p == ',' || *p == ';' || *p == '=' ) |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 156 | continue; |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 157 | |
| 158 | /* read toggle name, followed by ':' */ |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 159 | q = p; |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 160 | while ( *p && *p != ':' ) |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 161 | p++; |
David Turner | ee06410 | 2002-07-09 16:49:12 +0000 | [diff] [blame] | 162 | |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 163 | if ( *p == ':' && p > q ) |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 164 | { |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 165 | FT_Int n, i, len = (FT_Int)( p - q ); |
Werner Lemberg | 68e9f92 | 2002-09-27 11:09:23 +0000 | [diff] [blame] | 166 | FT_Int level = -1, found = -1; |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 167 | |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 168 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 169 | for ( n = 0; n < trace_count; n++ ) |
| 170 | { |
| 171 | const char* toggle = ft_trace_toggles[n]; |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 172 | |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 173 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 174 | for ( i = 0; i < len; i++ ) |
| 175 | { |
| 176 | if ( toggle[i] != q[i] ) |
| 177 | break; |
| 178 | } |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 179 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 180 | if ( i == len && toggle[i] == 0 ) |
| 181 | { |
| 182 | found = n; |
| 183 | break; |
| 184 | } |
| 185 | } |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 186 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 187 | /* read level */ |
| 188 | p++; |
| 189 | if ( *p ) |
| 190 | { |
| 191 | level = *p++ - '0'; |
| 192 | if ( level < 0 || level > 6 ) |
| 193 | level = -1; |
| 194 | } |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 195 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 196 | if ( found >= 0 && level >= 0 ) |
| 197 | { |
| 198 | if ( found == trace_any ) |
| 199 | { |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 200 | /* special case for `any' */ |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 201 | for ( n = 0; n < trace_count; n++ ) |
| 202 | ft_trace_levels[n] = level; |
| 203 | } |
| 204 | else |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 205 | ft_trace_levels[found] = level; |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 206 | } |
| 207 | } |
| 208 | } |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 209 | } |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 210 | } |
| 211 | |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 212 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 213 | #else /* !FT_DEBUG_LEVEL_TRACE */ |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 214 | |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 215 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 216 | FT_BASE_DEF( void ) |
David Turner | 88027fd | 2002-04-17 11:32:10 +0000 | [diff] [blame] | 217 | ft_debug_init( void ) |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 218 | { |
| 219 | /* nothing */ |
| 220 | } |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 221 | |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 222 | |
| 223 | FT_EXPORT_DEF( FT_Int ) |
| 224 | FT_Trace_Get_Count( void ) |
| 225 | { |
| 226 | return 0; |
| 227 | } |
| 228 | |
| 229 | |
| 230 | FT_EXPORT_DEF( const char * ) |
| 231 | FT_Trace_Get_Name( FT_Int index ) |
| 232 | { |
| 233 | return NULL; |
| 234 | } |
| 235 | |
| 236 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 237 | #endif /* !FT_DEBUG_LEVEL_TRACE */ |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 238 | |
Werner Lemberg | 63408a1 | 2000-12-13 23:44:37 +0000 | [diff] [blame] | 239 | |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 240 | /* END */ |