include/freetype/internal/ftdebug.h

   1 /***************************************************************************/
   2 /*                                                                         */
   3 /*  ftdebug.h                                                              */
   4 /*                                                                         */
   5 /*    Debugging and logging component (specification).                     */
   6 /*                                                                         */
   7 /*  Copyright 1996-2000 by                                                 */
   8 /*  David Turner, Robert Wilhelm, and Werner Lemberg.                      */
   9 /*                                                                         */
  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.                                        */
  15 /*                                                                         */
  16 /***************************************************************************/
  17
  18
  19 #ifndef FTDEBUG_H
  20 #define FTDEBUG_H
  21
  22 #include <freetype/config/ftconfig.h>   /* for FT_DEBUG_LEVEL_TRACE, */
  23                                         /* FT_DEBUG_LEVEL_ERROR      */
  24
  25 #ifdef __cplusplus
  26   extern "C" {
  27 #endif
  28
  29
  30   /* A very stupid pre-processor trick.  See K&R version 2 */
  31   /* section A12.3 for details...                          */
  32   /*                                                       */
  33   /* It is also described in the section `Separate         */
  34   /* Expansion of Macro Arguments' in the info file        */
  35   /* `cpp.info', describing GNU cpp.                       */
  36   /*                                                       */
  37 #define FT_CAT( x, y )   x ## y
  38 #define FT_XCAT( x, y )  FT_CAT( x, y )
  39
  40
  41 #ifdef FT_DEBUG_LEVEL_TRACE
  42
  43
  44   /* note that not all levels are used currently */
  45
  46   typedef enum  FT_Trace_
  47   {
  48     /* the first level must always be `trace_any' */
  49     trace_any = 0,
  50
  51     /* base components */
  52     trace_aaraster,  /* anti-aliasing raster    (ftgrays.c)  */
  53     trace_calc,      /* calculations            (ftcalc.c)   */
  54     trace_extend,    /* extension manager       (ftextend.c) */
  55     trace_glyph,     /* glyph manager           (ftglyph.c)  */
  56     trace_io,        /* i/o monitoring          (ftsystem.c) */
  57     trace_init,      /* initialization          (ftinit.c)   */
  58     trace_list,      /* list manager            (ftlist.c)   */
  59     trace_memory,    /* memory manager          (ftobjs.c)   */
  60     trace_mm,        /* MM interface            (ftmm.c)     */
  61     trace_objs,      /* base objects            (ftobjs.c)   */
  62     trace_outline,   /* outline management      (ftoutln.c)  */
  63     trace_raster,    /* rasterizer              (ftraster.c) */
  64     trace_stream,    /* stream manager          (ftstream.c) */
  65
  66     /* SFNT driver components */
  67     trace_sfobjs,    /* SFNT object handler     (sfobjs.c)   */
  68     trace_ttcmap,    /* charmap handler         (ttcmap.c)   */
  69     trace_ttload,    /* basic TrueType tables   (ttload.c)   */
  70     trace_ttpost,    /* PS table processing     (ttpost.c)   */
  71     trace_ttsbit,    /* TrueType sbit handling  (ttsbit.c)   */
  72
  73     /* TrueType driver components */
  74     trace_ttdriver,  /* TT font driver          (ttdriver.c) */
  75     trace_ttgload,   /* TT glyph loader         (ttgload.c)  */
  76     trace_ttinterp,  /* bytecode interpreter    (ttinterp.c) */
  77     trace_ttobjs,    /* TT objects manager      (ttobjs.c)   */
  78     trace_ttpload,   /* TT data/program loader  (ttpload.c)  */
  79
  80     /* Type 1 driver components */
  81     trace_t1driver,
  82     trace_t1gload,
  83     trace_t1hint,
  84     trace_t1load,
  85     trace_t1objs,
  86
  87     /* experimental Type 1 driver components */
  88     trace_z1driver,
  89     trace_z1gload,
  90     trace_z1hint,
  91     trace_z1load,
  92     trace_z1objs,
  93     trace_z1parse,
  94
  95     /* Type 2 driver components */
  96     trace_t2driver,
  97     trace_t2gload,
  98     trace_t2load,
  99     trace_t2objs,
 100     trace_t2parse,
 101
 102     /* CID driver components */
 103     trace_cidafm,
 104     trace_ciddriver,
 105     trace_cidgload,
 106     trace_cidload,
 107     trace_cidobjs,
 108     trace_cidparse,
 109
 110     /* Windows fonts component */
 111     trace_winfnt,
 112
 113     /* the last level must always be `trace_max' */
 114     trace_max
 115
 116   } FT_Trace;
 117
 118
 119   /* declared in ftdebug.c */
 120   extern char  ft_trace_levels[trace_max];
 121
 122
 123   /*************************************************************************/
 124   /*                                                                       */
 125   /* IMPORTANT!                                                            */
 126   /*                                                                       */
 127   /* Each component must define the macro FT_COMPONENT to a valid FT_Trace */
 128   /* value before using any TRACE macro.                                   */
 129   /*                                                                       */
 130   /*************************************************************************/
 131
 132
 133 #if __GNUC__ >= 3
 134 #define FT_TRACE( level, varformat )         do ; while ( 0 )      /* nothing */
 135 #else
 136 #define FT_TRACE( level, varformat )                      \
 137           do                                              \
 138           {                                               \
 139             if ( ft_trace_levels[FT_COMPONENT] >= level ) \
 140               FT_XCAT( FT_Message, varformat );           \
 141           } while ( 0 )
 142 #endif
 143
 144
 145   FT_EXPORT_DEF( void )  FT_SetTraceLevel( FT_Trace  component,
 146                                            char      level );
 147
 148
 149 #elif defined( FT_DEBUG_LEVEL_ERROR )
 150
 151
 152 #define FT_TRACE( level, varformat )  do ; while ( 0 )      /* nothing */
 153
 154
 155 #else  /* release mode */
 156
 157
 158 #define FT_Assert( condition )        do ; while ( 0 )      /* nothing */
 159
 160 #define FT_TRACE( level, varformat )  do ; while ( 0 )      /* nothing */
 161 #define FT_ERROR( varformat )         do ; while ( 0 )      /* nothing */
 162
 163
 164 #endif /* FT_DEBUG_LEVEL_TRACE, FT_DEBUG_LEVEL_ERROR */
 165
 166
 167   /*************************************************************************/
 168   /*                                                                       */
 169   /* Define macros and functions that are common to the debug and trace    */
 170   /* modes.                                                                */
 171   /*                                                                       */
 172   /* You need vprintf() to be able to compile ftdebug.c.                   */
 173   /*                                                                       */
 174   /*************************************************************************/
 175
 176
 177 #if defined( FT_DEBUG_LEVEL_TRACE ) || defined( FT_DEBUG_LEVEL_ERROR )
 178
 179
 180 #include "stdio.h"  /* for vprintf() */
 181
 182
 183 #define FT_Assert( condition )                                      \
 184           do                                                        \
 185           {                                                         \
 186             if ( !( condition ) )                                   \
 187               FT_Panic( "assertion failed on line %d of file %s\n", \
 188                         __LINE__, __FILE__ );                       \
 189           } while ( 0 )
 190
 191   /* print a message */
 192   FT_EXPORT_DEF( void )  FT_Message( const char*  fmt, ... );
 193
 194   /* print a message and exit */
 195   FT_EXPORT_DEF( void )  FT_Panic( const char*  fmt, ... );
 196
 197 #if __GNUC__ >= 3
 198 #define FT_ERROR( varformat )         do ; while ( 0 )      /* nothing */
 199 #else
 200 #define FT_ERROR( varformat )  FT_XCAT( FT_Message, varformat )
 201 #endif
 202
 203 #endif /* FT_DEBUG_LEVEL_TRACE || FT_DEBUG_LEVEL_ERROR */
 204
 205
 206   /*************************************************************************/
 207   /*                                                                       */
 208   /* You need two opening resp. closing parentheses!                       */
 209   /*                                                                       */
 210   /* Example: FT_TRACE0(( "Value is %i", foo ))                            */
 211   /*                                                                       */
 212   /*************************************************************************/
 213
 214 #define FT_TRACE0( varformat )  FT_TRACE( 0, varformat )
 215 #define FT_TRACE1( varformat )  FT_TRACE( 1, varformat )
 216 #define FT_TRACE2( varformat )  FT_TRACE( 2, varformat )
 217 #define FT_TRACE3( varformat )  FT_TRACE( 3, varformat )
 218 #define FT_TRACE4( varformat )  FT_TRACE( 4, varformat )
 219 #define FT_TRACE5( varformat )  FT_TRACE( 5, varformat )
 220 #define FT_TRACE6( varformat )  FT_TRACE( 6, varformat )
 221 #define FT_TRACE7( varformat )  FT_TRACE( 7, varformat )
 222
 223
 224 #ifdef __cplusplus
 225   }
 226 #endif
 227
 228
 229 #endif /* FTDEBUG_H */
 230
 231
 232 /* END */