include/config/ftconfig.h

   1 /***************************************************************************/
   2 /*                                                                         */
   3 /*  ftconfig.h                                                             */
   4 /*                                                                         */
   5 /*    ANSI-specific configuration file (specification only).               */
   6 /*                                                                         */
   7 /*  Copyright 1996-2004, 2006-2008, 2010-2011, 2013, 2014 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   /*************************************************************************/
  20   /*                                                                       */
  21   /* This header file contains a number of macro definitions that are used */
  22   /* by the rest of the engine.  Most of the macros here are automatically */
  23   /* determined at compile time, and you should not need to change it to   */
  24   /* port FreeType, except to compile the library with a non-ANSI          */
  25   /* compiler.                                                             */
  26   /*                                                                       */
  27   /* Note however that if some specific modifications are needed, we       */
  28   /* advise you to place a modified copy in your build directory.          */
  29   /*                                                                       */
  30   /* The build directory is usually `builds/<system>', and contains        */
  31   /* system-specific files that are always included first when building    */
  32   /* the library.                                                          */
  33   /*                                                                       */
  34   /* This ANSI version should stay in `include/config/'.                   */
  35   /*                                                                       */
  36   /*************************************************************************/
  37
  38 #ifndef __FTCONFIG_H__
  39 #define __FTCONFIG_H__
  40
  41 #include <ft2build.h>
  42 #include FT_CONFIG_OPTIONS_H
  43 #include FT_CONFIG_STANDARD_LIBRARY_H
  44
  45
  46 FT_BEGIN_HEADER
  47
  48
  49   /*************************************************************************/
  50   /*                                                                       */
  51   /*               PLATFORM-SPECIFIC CONFIGURATION MACROS                  */
  52   /*                                                                       */
  53   /* These macros can be toggled to suit a specific system.  The current   */
  54   /* ones are defaults used to compile FreeType in an ANSI C environment   */
  55   /* (16bit compilers are also supported).  Copy this file to your own     */
  56   /* `builds/<system>' directory, and edit it to port the engine.          */
  57   /*                                                                       */
  58   /*************************************************************************/
  59
  60
  61   /* There are systems (like the Texas Instruments 'C54x) where a `char' */
  62   /* has 16 bits.  ANSI C says that sizeof(char) is always 1.  Since an  */
  63   /* `int' has 16 bits also for this system, sizeof(int) gives 1 which   */
  64   /* is probably unexpected.                                             */
  65   /*                                                                     */
  66   /* `CHAR_BIT' (defined in limits.h) gives the number of bits in a      */
  67   /* `char' type.                                                        */
  68
  69 #ifndef FT_CHAR_BIT
  70 #define FT_CHAR_BIT  CHAR_BIT
  71 #endif
  72
  73
  74   /* The size of an `int' type.  */
  75 #if                                 FT_UINT_MAX == 0xFFFFUL
  76 #define FT_SIZEOF_INT  (16 / FT_CHAR_BIT)
  77 #elif                               FT_UINT_MAX == 0xFFFFFFFFUL
  78 #define FT_SIZEOF_INT  (32 / FT_CHAR_BIT)
  79 #elif FT_UINT_MAX > 0xFFFFFFFFUL && FT_UINT_MAX == 0xFFFFFFFFFFFFFFFFUL
  80 #define FT_SIZEOF_INT  (64 / FT_CHAR_BIT)
  81 #else
  82 #error "Unsupported size of `int' type!"
  83 #endif
  84
  85   /* The size of a `long' type.  A five-byte `long' (as used e.g. on the */
  86   /* DM642) is recognized but avoided.                                   */
  87 #if                                  FT_ULONG_MAX == 0xFFFFFFFFUL
  88 #define FT_SIZEOF_LONG  (32 / FT_CHAR_BIT)
  89 #elif FT_ULONG_MAX > 0xFFFFFFFFUL && FT_ULONG_MAX == 0xFFFFFFFFFFUL
  90 #define FT_SIZEOF_LONG  (32 / FT_CHAR_BIT)
  91 #elif FT_ULONG_MAX > 0xFFFFFFFFUL && FT_ULONG_MAX == 0xFFFFFFFFFFFFFFFFUL
  92 #define FT_SIZEOF_LONG  (64 / FT_CHAR_BIT)
  93 #else
  94 #error "Unsupported size of `long' type!"
  95 #endif
  96
  97
  98   /* FT_UNUSED is a macro used to indicate that a given parameter is not  */
  99   /* used -- this is only used to get rid of unpleasant compiler warnings */
 100 #ifndef FT_UNUSED
 101 #define FT_UNUSED( arg )  ( (arg) = (arg) )
 102 #endif
 103
 104
 105   /*************************************************************************/
 106   /*                                                                       */
 107   /*                     AUTOMATIC CONFIGURATION MACROS                    */
 108   /*                                                                       */
 109   /* These macros are computed from the ones defined above.  Don't touch   */
 110   /* their definition, unless you know precisely what you are doing.  No   */
 111   /* porter should need to mess with them.                                 */
 112   /*                                                                       */
 113   /*************************************************************************/
 114
 115
 116   /*************************************************************************/
 117   /*                                                                       */
 118   /* Mac support                                                           */
 119   /*                                                                       */
 120   /*   This is the only necessary change, so it is defined here instead    */
 121   /*   providing a new configuration file.                                 */
 122   /*                                                                       */
 123 #if defined( __APPLE__ ) || ( defined( __MWERKS__ ) && defined( macintosh ) )
 124   /* no Carbon frameworks for 64bit 10.4.x */
 125   /* AvailabilityMacros.h is available since Mac OS X 10.2,        */
 126   /* so guess the system version by maximum errno before inclusion */
 127 #include <errno.h>
 128 #ifdef ECANCELED /* defined since 10.2 */
 129 #include "AvailabilityMacros.h"
 130 #endif
 131 #if defined( __LP64__ ) && \
 132     ( MAC_OS_X_VERSION_MIN_REQUIRED <= MAC_OS_X_VERSION_10_4 )
 133 #undef FT_MACINTOSH
 134 #endif
 135
 136 #elif defined( __SC__ ) || defined( __MRC__ )
 137   /* Classic MacOS compilers */
 138 #include "ConditionalMacros.h"
 139 #if TARGET_OS_MAC
 140 #define FT_MACINTOSH 1
 141 #endif
 142
 143 #endif
 144
 145
 146   /*************************************************************************/
 147   /*                                                                       */
 148   /* <Section>                                                             */
 149   /*    basic_types                                                        */
 150   /*                                                                       */
 151   /*************************************************************************/
 152
 153
 154   /*************************************************************************/
 155   /*                                                                       */
 156   /* <Type>                                                                */
 157   /*    FT_Int16                                                           */
 158   /*                                                                       */
 159   /* <Description>                                                         */
 160   /*    A typedef for a 16bit signed integer type.                         */
 161   /*                                                                       */
 162   typedef signed short  FT_Int16;
 163
 164
 165   /*************************************************************************/
 166   /*                                                                       */
 167   /* <Type>                                                                */
 168   /*    FT_UInt16                                                          */
 169   /*                                                                       */
 170   /* <Description>                                                         */
 171   /*    A typedef for a 16bit unsigned integer type.                       */
 172   /*                                                                       */
 173   typedef unsigned short  FT_UInt16;
 174
 175   /* */
 176
 177
 178   /* this #if 0 ... #endif clause is for documentation purposes */
 179 #if 0
 180
 181   /*************************************************************************/
 182   /*                                                                       */
 183   /* <Type>                                                                */
 184   /*    FT_Int32                                                           */
 185   /*                                                                       */
 186   /* <Description>                                                         */
 187   /*    A typedef for a 32bit signed integer type.  The size depends on    */
 188   /*    the configuration.                                                 */
 189   /*                                                                       */
 190   typedef signed XXX  FT_Int32;
 191
 192
 193   /*************************************************************************/
 194   /*                                                                       */
 195   /* <Type>                                                                */
 196   /*    FT_UInt32                                                          */
 197   /*                                                                       */
 198   /*    A typedef for a 32bit unsigned integer type.  The size depends on  */
 199   /*    the configuration.                                                 */
 200   /*                                                                       */
 201   typedef unsigned XXX  FT_UInt32;
 202
 203
 204   /*************************************************************************/
 205   /*                                                                       */
 206   /* <Type>                                                                */
 207   /*    FT_Int64                                                           */
 208   /*                                                                       */
 209   /*    A typedef for a 64bit signed integer type.  The size depends on    */
 210   /*    the configuration.  Only defined if there is real 64bit support;   */
 211   /*    otherwise, it gets emulated with a structure (if necessary).       */
 212   /*                                                                       */
 213   typedef signed XXX  FT_Int64;
 214
 215
 216   /*************************************************************************/
 217   /*                                                                       */
 218   /* <Type>                                                                */
 219   /*    FT_UInt64                                                          */
 220   /*                                                                       */
 221   /*    A typedef for a 64bit unsigned integer type.  The size depends on  */
 222   /*    the configuration.  Only defined if there is real 64bit support;   */
 223   /*    otherwise, it gets emulated with a structure (if necessary).       */
 224   /*                                                                       */
 225   typedef unsigned XXX  FT_UInt64;
 226
 227   /* */
 228
 229 #endif
 230
 231 #if FT_SIZEOF_INT == (32 / FT_CHAR_BIT)
 232
 233   typedef signed int      FT_Int32;
 234   typedef unsigned int    FT_UInt32;
 235
 236 #elif FT_SIZEOF_LONG == (32 / FT_CHAR_BIT)
 237
 238   typedef signed long     FT_Int32;
 239   typedef unsigned long   FT_UInt32;
 240
 241 #else
 242 #error "no 32bit type found -- please check your configuration files"
 243 #endif
 244
 245
 246   /* look up an integer type that is at least 32 bits */
 247 #if FT_SIZEOF_INT >= (32 / FT_CHAR_BIT)
 248
 249   typedef int            FT_Fast;
 250   typedef unsigned int   FT_UFast;
 251
 252 #elif FT_SIZEOF_LONG >= (32 / FT_CHAR_BIT)
 253
 254   typedef long           FT_Fast;
 255   typedef unsigned long  FT_UFast;
 256
 257 #endif
 258
 259
 260   /* determine whether we have a 64-bit int type for platforms without */
 261   /* Autoconf                                                          */
 262 #if FT_SIZEOF_LONG == (64 / FT_CHAR_BIT)
 263
 264   /* FT_LONG64 must be defined if a 64-bit type is available */
 265 #define FT_LONG64
 266 #define FT_INT64   long
 267 #define FT_UINT64  unsigned long
 268
 269   /*************************************************************************/
 270   /*                                                                       */
 271   /* A 64-bit data type may create compilation problems if you compile     */
 272   /* in strict ANSI mode.  To avoid them, we disable other 64-bit data     */
 273   /* types if __STDC__ is defined.  You can however ignore this rule       */
 274   /* by defining the FT_CONFIG_OPTION_FORCE_INT64 configuration macro.     */
 275   /*                                                                       */
 276 #elif !defined( __STDC__ ) || defined( FT_CONFIG_OPTION_FORCE_INT64 )
 277
 278 #if defined( _MSC_VER ) && _MSC_VER >= 900  /* Visual C++ (and Intel C++) */
 279
 280   /* this compiler provides the __int64 type */
 281 #define FT_LONG64
 282 #define FT_INT64   __int64
 283 #define FT_UINT64  unsigned __int64
 284
 285 #elif defined( __BORLANDC__ )  /* Borland C++ */
 286
 287   /* XXXX: We should probably check the value of __BORLANDC__ in order */
 288   /*       to test the compiler version.                               */
 289
 290   /* this compiler provides the __int64 type */
 291 #define FT_LONG64
 292 #define FT_INT64   __int64
 293 #define FT_UINT64  unsigned __int64
 294
 295 #elif defined( __WATCOMC__ )   /* Watcom C++ */
 296
 297   /* Watcom doesn't provide 64-bit data types */
 298
 299 #elif defined( __MWERKS__ )    /* Metrowerks CodeWarrior */
 300
 301 #define FT_LONG64
 302 #define FT_INT64   long long int
 303 #define FT_UINT64  unsigned long long int
 304
 305 #elif defined( __GNUC__ )
 306
 307   /* GCC provides the `long long' type */
 308 #define FT_LONG64
 309 #define FT_INT64   long long int
 310 #define FT_UINT64  unsigned long long int
 311
 312 #endif /* _MSC_VER */
 313
 314 #endif /* FT_SIZEOF_LONG == (64 / FT_CHAR_BIT) */
 315
 316 #ifdef FT_LONG64
 317   typedef FT_INT64   FT_Int64;
 318   typedef FT_UINT64  FT_UInt64;
 319 #endif
 320
 321
 322 #define FT_BEGIN_STMNT  do {
 323 #define FT_END_STMNT    } while ( 0 )
 324 #define FT_DUMMY_STMNT  FT_BEGIN_STMNT FT_END_STMNT
 325
 326
 327 #ifdef FT_MAKE_OPTION_SINGLE_OBJECT
 328
 329 #define FT_LOCAL( x )      static  x
 330 #define FT_LOCAL_DEF( x )  static  x
 331
 332 #else
 333
 334 #ifdef __cplusplus
 335 #define FT_LOCAL( x )      extern "C"  x
 336 #define FT_LOCAL_DEF( x )  extern "C"  x
 337 #else
 338 #define FT_LOCAL( x )      extern  x
 339 #define FT_LOCAL_DEF( x )  x
 340 #endif
 341
 342 #endif /* FT_MAKE_OPTION_SINGLE_OBJECT */
 343
 344 #define FT_LOCAL_ARRAY( x )      extern const  x
 345 #define FT_LOCAL_ARRAY_DEF( x )  const  x
 346
 347
 348 #ifndef FT_BASE
 349
 350 #ifdef __cplusplus
 351 #define FT_BASE( x )  extern "C"  x
 352 #else
 353 #define FT_BASE( x )  extern  x
 354 #endif
 355
 356 #endif /* !FT_BASE */
 357
 358
 359 #ifndef FT_BASE_DEF
 360
 361 #ifdef __cplusplus
 362 #define FT_BASE_DEF( x )  x
 363 #else
 364 #define FT_BASE_DEF( x )  x
 365 #endif
 366
 367 #endif /* !FT_BASE_DEF */
 368
 369
 370 #ifndef FT_EXPORT
 371
 372 #ifdef __cplusplus
 373 #define FT_EXPORT( x )  extern "C"  x
 374 #else
 375 #define FT_EXPORT( x )  extern  x
 376 #endif
 377
 378 #endif /* !FT_EXPORT */
 379
 380
 381 #ifndef FT_EXPORT_DEF
 382
 383 #ifdef __cplusplus
 384 #define FT_EXPORT_DEF( x )  extern "C"  x
 385 #else
 386 #define FT_EXPORT_DEF( x )  extern  x
 387 #endif
 388
 389 #endif /* !FT_EXPORT_DEF */
 390
 391
 392 #ifndef FT_EXPORT_VAR
 393
 394 #ifdef __cplusplus
 395 #define FT_EXPORT_VAR( x )  extern "C"  x
 396 #else
 397 #define FT_EXPORT_VAR( x )  extern  x
 398 #endif
 399
 400 #endif /* !FT_EXPORT_VAR */
 401
 402   /* The following macros are needed to compile the library with a   */
 403   /* C++ compiler and with 16bit compilers.                          */
 404   /*                                                                 */
 405
 406   /* This is special.  Within C++, you must specify `extern "C"' for */
 407   /* functions which are used via function pointers, and you also    */
 408   /* must do that for structures which contain function pointers to  */
 409   /* assure C linkage -- it's not possible to have (local) anonymous */
 410   /* functions which are accessed by (global) function pointers.     */
 411   /*                                                                 */
 412   /*                                                                 */
 413   /* FT_CALLBACK_DEF is used to _define_ a callback function.        */
 414   /*                                                                 */
 415   /* FT_CALLBACK_TABLE is used to _declare_ a constant variable that */
 416   /* contains pointers to callback functions.                        */
 417   /*                                                                 */
 418   /* FT_CALLBACK_TABLE_DEF is used to _define_ a constant variable   */
 419   /* that contains pointers to callback functions.                   */
 420   /*                                                                 */
 421   /*                                                                 */
 422   /* Some 16bit compilers have to redefine these macros to insert    */
 423   /* the infamous `_cdecl' or `__fastcall' declarations.             */
 424   /*                                                                 */
 425 #ifndef FT_CALLBACK_DEF
 426 #ifdef __cplusplus
 427 #define FT_CALLBACK_DEF( x )  extern "C"  x
 428 #else
 429 #define FT_CALLBACK_DEF( x )  static  x
 430 #endif
 431 #endif /* FT_CALLBACK_DEF */
 432
 433 #ifndef FT_CALLBACK_TABLE
 434 #ifdef __cplusplus
 435 #define FT_CALLBACK_TABLE      extern "C"
 436 #define FT_CALLBACK_TABLE_DEF  extern "C"
 437 #else
 438 #define FT_CALLBACK_TABLE      extern
 439 #define FT_CALLBACK_TABLE_DEF  /* nothing */
 440 #endif
 441 #endif /* FT_CALLBACK_TABLE */
 442
 443
 444 FT_END_HEADER
 445
 446
 447 #endif /* __FTCONFIG_H__ */
 448
 449
 450 /* END */