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 | b114b7c | 2013-03-17 22:42:07 +0100 | [diff] [blame] | 7 | /* Copyright 1996-2001, 2002, 2004, 2008, 2013 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 | |
Werner Lemberg | 0219728 | 2008-11-29 09:31:44 +0000 | [diff] [blame] | 49 | #ifdef FT_DEBUG_LEVEL_ERROR |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 50 | |
Werner Lemberg | ece8b20 | 2004-12-13 23:16:59 +0000 | [diff] [blame] | 51 | /* documentation is in ftdebug.h */ |
| 52 | |
Wu, Chia-I (吳佳一) | 35bfc0f | 2005-11-17 01:53:07 +0000 | [diff] [blame] | 53 | FT_BASE_DEF( void ) |
Werner Lemberg | b114b7c | 2013-03-17 22:42:07 +0100 | [diff] [blame] | 54 | FT_Message( const char* fmt, |
| 55 | ... ) |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 56 | { |
| 57 | va_list ap; |
| 58 | |
| 59 | |
| 60 | va_start( ap, fmt ); |
Werner Lemberg | 16dc51f | 2008-05-18 17:36:15 +0000 | [diff] [blame] | 61 | vfprintf( stderr, fmt, ap ); |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 62 | va_end( ap ); |
| 63 | } |
| 64 | |
| 65 | |
Werner Lemberg | ece8b20 | 2004-12-13 23:16:59 +0000 | [diff] [blame] | 66 | /* documentation is in ftdebug.h */ |
| 67 | |
Wu, Chia-I (吳佳一) | 35bfc0f | 2005-11-17 01:53:07 +0000 | [diff] [blame] | 68 | FT_BASE_DEF( void ) |
Werner Lemberg | b114b7c | 2013-03-17 22:42:07 +0100 | [diff] [blame] | 69 | FT_Panic( const char* fmt, |
| 70 | ... ) |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 71 | { |
| 72 | va_list ap; |
| 73 | |
| 74 | |
| 75 | va_start( ap, fmt ); |
Werner Lemberg | 16dc51f | 2008-05-18 17:36:15 +0000 | [diff] [blame] | 76 | vfprintf( stderr, fmt, ap ); |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 77 | va_end( ap ); |
| 78 | |
| 79 | exit( EXIT_FAILURE ); |
| 80 | } |
| 81 | |
Werner Lemberg | c58ce3b | 2013-03-13 11:06:39 +0100 | [diff] [blame] | 82 | |
| 83 | /* documentation is in ftdebug.h */ |
| 84 | |
| 85 | FT_BASE_DEF( int ) |
| 86 | FT_Throw( FT_Error error, |
| 87 | int line, |
| 88 | const char* file ) |
| 89 | { |
| 90 | FT_UNUSED( error ); |
| 91 | FT_UNUSED( line ); |
| 92 | FT_UNUSED( file ); |
| 93 | |
| 94 | return 0; |
| 95 | } |
| 96 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 97 | #endif /* FT_DEBUG_LEVEL_ERROR */ |
| 98 | |
| 99 | |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 100 | |
| 101 | #ifdef FT_DEBUG_LEVEL_TRACE |
| 102 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 103 | /* array of trace levels, initialized to 0 */ |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 104 | int ft_trace_levels[trace_count]; |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 105 | |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 106 | |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 107 | /* define array of trace toggle names */ |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 108 | #define FT_TRACE_DEF( x ) #x , |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 109 | |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 110 | static const char* ft_trace_toggles[trace_count + 1] = |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 111 | { |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 112 | #include FT_INTERNAL_TRACE_H |
| 113 | NULL |
| 114 | }; |
| 115 | |
| 116 | #undef FT_TRACE_DEF |
| 117 | |
| 118 | |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 119 | /* documentation is in ftdebug.h */ |
| 120 | |
Wu, Chia-I (吳佳一) | 35bfc0f | 2005-11-17 01:53:07 +0000 | [diff] [blame] | 121 | FT_BASE_DEF( FT_Int ) |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 122 | FT_Trace_Get_Count( void ) |
| 123 | { |
| 124 | return trace_count; |
| 125 | } |
| 126 | |
| 127 | |
| 128 | /* documentation is in ftdebug.h */ |
| 129 | |
Wu, Chia-I (吳佳一) | 35bfc0f | 2005-11-17 01:53:07 +0000 | [diff] [blame] | 130 | FT_BASE_DEF( const char * ) |
Werner Lemberg | 391de1a | 2004-04-11 16:44:54 +0000 | [diff] [blame] | 131 | FT_Trace_Get_Name( FT_Int idx ) |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 132 | { |
| 133 | int max = FT_Trace_Get_Count(); |
| 134 | |
| 135 | |
Werner Lemberg | 391de1a | 2004-04-11 16:44:54 +0000 | [diff] [blame] | 136 | if ( idx < max ) |
| 137 | return ft_trace_toggles[idx]; |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 138 | else |
| 139 | return NULL; |
| 140 | } |
| 141 | |
| 142 | |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 143 | /*************************************************************************/ |
| 144 | /* */ |
| 145 | /* Initialize the tracing sub-system. This is done by retrieving the */ |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 146 | /* value of the `FT2_DEBUG' environment variable. It must be a list of */ |
| 147 | /* toggles, separated by spaces, `;', or `,'. Example: */ |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 148 | /* */ |
Werner Lemberg | 92c9f10 | 2004-09-04 06:53:36 +0000 | [diff] [blame] | 149 | /* export FT2_DEBUG="any:3 memory:7 stream:5" */ |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 150 | /* */ |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 151 | /* This requests that all levels be set to 3, except the trace level for */ |
Werner Lemberg | 92c9f10 | 2004-09-04 06:53:36 +0000 | [diff] [blame] | 152 | /* the memory and stream components which are set to 7 and 5, */ |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 153 | /* respectively. */ |
| 154 | /* */ |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 155 | /* See the file <include/freetype/internal/fttrace.h> for details of the */ |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 156 | /* available toggle names. */ |
| 157 | /* */ |
Werner Lemberg | 92c9f10 | 2004-09-04 06:53:36 +0000 | [diff] [blame] | 158 | /* The level must be between 0 and 7; 0 means quiet (except for serious */ |
| 159 | /* runtime errors), and 7 means _very_ verbose. */ |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 160 | /* */ |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 161 | FT_BASE_DEF( void ) |
| 162 | ft_debug_init( void ) |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 163 | { |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 164 | const char* ft2_debug = getenv( "FT2_DEBUG" ); |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 165 | |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 166 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 167 | if ( ft2_debug ) |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 168 | { |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 169 | const char* p = ft2_debug; |
| 170 | const char* q; |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 171 | |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 172 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 173 | for ( ; *p; p++ ) |
| 174 | { |
| 175 | /* skip leading whitespace and separators */ |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 176 | if ( *p == ' ' || *p == '\t' || *p == ',' || *p == ';' || *p == '=' ) |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 177 | continue; |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 178 | |
| 179 | /* read toggle name, followed by ':' */ |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 180 | q = p; |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 181 | while ( *p && *p != ':' ) |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 182 | p++; |
David Turner | 10bf05a | 2004-04-21 14:30:37 +0000 | [diff] [blame] | 183 | |
Brian Nixon | 8d6025c | 2013-05-13 09:06:42 +0200 | [diff] [blame^] | 184 | if ( !*p ) |
| 185 | break; |
| 186 | |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 187 | if ( *p == ':' && p > q ) |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 188 | { |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 189 | FT_Int n, i, len = (FT_Int)( p - q ); |
Werner Lemberg | 68e9f92 | 2002-09-27 11:09:23 +0000 | [diff] [blame] | 190 | FT_Int level = -1, found = -1; |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 191 | |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 192 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 193 | for ( n = 0; n < trace_count; n++ ) |
| 194 | { |
| 195 | const char* toggle = ft_trace_toggles[n]; |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 196 | |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 197 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 198 | for ( i = 0; i < len; i++ ) |
| 199 | { |
| 200 | if ( toggle[i] != q[i] ) |
| 201 | break; |
| 202 | } |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 203 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 204 | if ( i == len && toggle[i] == 0 ) |
| 205 | { |
| 206 | found = n; |
| 207 | break; |
| 208 | } |
| 209 | } |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 210 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 211 | /* read level */ |
| 212 | p++; |
| 213 | if ( *p ) |
| 214 | { |
Brian Nixon | 8d6025c | 2013-05-13 09:06:42 +0200 | [diff] [blame^] | 215 | level = *p - '0'; |
Werner Lemberg | 92c9f10 | 2004-09-04 06:53:36 +0000 | [diff] [blame] | 216 | if ( level < 0 || level > 7 ) |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 217 | level = -1; |
| 218 | } |
David Turner | 02c3aed | 2002-07-08 23:02:32 +0000 | [diff] [blame] | 219 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 220 | if ( found >= 0 && level >= 0 ) |
| 221 | { |
| 222 | if ( found == trace_any ) |
| 223 | { |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 224 | /* special case for `any' */ |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 225 | for ( n = 0; n < trace_count; n++ ) |
| 226 | ft_trace_levels[n] = level; |
| 227 | } |
| 228 | else |
Werner Lemberg | af8df85 | 2002-02-22 00:58:04 +0000 | [diff] [blame] | 229 | ft_trace_levels[found] = level; |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 230 | } |
| 231 | } |
| 232 | } |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 233 | } |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 234 | } |
| 235 | |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 236 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 237 | #else /* !FT_DEBUG_LEVEL_TRACE */ |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 238 | |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 239 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 240 | FT_BASE_DEF( void ) |
David Turner | 88027fd | 2002-04-17 11:32:10 +0000 | [diff] [blame] | 241 | ft_debug_init( void ) |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 242 | { |
| 243 | /* nothing */ |
| 244 | } |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 245 | |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 246 | |
Wu, Chia-I (吳佳一) | 35bfc0f | 2005-11-17 01:53:07 +0000 | [diff] [blame] | 247 | FT_BASE_DEF( FT_Int ) |
David Turner | 10bf05a | 2004-04-21 14:30:37 +0000 | [diff] [blame] | 248 | FT_Trace_Get_Count( void ) |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 249 | { |
David Turner | 10bf05a | 2004-04-21 14:30:37 +0000 | [diff] [blame] | 250 | return 0; |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 251 | } |
| 252 | |
| 253 | |
Wu, Chia-I (吳佳一) | 35bfc0f | 2005-11-17 01:53:07 +0000 | [diff] [blame] | 254 | FT_BASE_DEF( const char * ) |
David Turner | 10bf05a | 2004-04-21 14:30:37 +0000 | [diff] [blame] | 255 | FT_Trace_Get_Name( FT_Int idx ) |
| 256 | { |
| 257 | FT_UNUSED( idx ); |
| 258 | |
| 259 | return NULL; |
Werner Lemberg | 460355a | 2004-02-24 07:52:45 +0000 | [diff] [blame] | 260 | } |
| 261 | |
| 262 | |
David Turner | 222cec8 | 2002-02-21 11:48:48 +0000 | [diff] [blame] | 263 | #endif /* !FT_DEBUG_LEVEL_TRACE */ |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 264 | |
Werner Lemberg | 63408a1 | 2000-12-13 23:44:37 +0000 | [diff] [blame] | 265 | |
David Turner | d2b1f35 | 1999-12-16 23:11:37 +0000 | [diff] [blame] | 266 | /* END */ |