2 /* pngconf.h - machine configurable file for libpng
4 * libpng version 1.6.2 - April 25, 2013
6 * Copyright (c) 1998-2013 Glenn Randers-Pehrson
7 * (Version 0.96 Copyright (c) 1996, 1997 Andreas Dilger)
8 * (Version 0.88 Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)
10 * This code is released under the libpng license.
11 * For conditions of distribution and use, see the disclaimer
12 * and license in png.h
16 /* Any machine specific code is near the front of this file, so if you
17 * are configuring libpng for a machine, you may want to read the section
18 * starting here down to where it starts to typedef png_color, png_text,
25 /* To do: Do all of this in scripts/pnglibconf.dfa */
26 #ifdef PNG_SAFE_LIMITS_SUPPORTED
27 # ifdef PNG_USER_WIDTH_MAX
28 # undef PNG_USER_WIDTH_MAX
29 # define PNG_USER_WIDTH_MAX 1000000L
31 # ifdef PNG_USER_HEIGHT_MAX
32 # undef PNG_USER_HEIGHT_MAX
33 # define PNG_USER_HEIGHT_MAX 1000000L
35 # ifdef PNG_USER_CHUNK_MALLOC_MAX
36 # undef PNG_USER_CHUNK_MALLOC_MAX
37 # define PNG_USER_CHUNK_MALLOC_MAX 4000000L
39 # ifdef PNG_USER_CHUNK_CACHE_MAX
40 # undef PNG_USER_CHUNK_CACHE_MAX
41 # define PNG_USER_CHUNK_CACHE_MAX 128
45 #ifndef PNG_BUILDING_SYMBOL_TABLE /* else includes may cause problems */
47 /* From libpng 1.6.0 libpng requires an ANSI X3.159-1989 ("ISOC90") compliant C
48 * compiler for correct compilation. The following header files are required by
49 * the standard. If your compiler doesn't provide these header files, or they
50 * do not match the standard, you will need to provide/improve them.
55 /* Library header files. These header files are all defined by ISOC90; libpng
56 * expects conformant implementations, however, an ISOC90 conformant system need
57 * not provide these header files if the functionality cannot be implemented.
58 * In this case it will be necessary to disable the relevant parts of libpng in
59 * the build of pnglibconf.h.
61 * Prior to 1.6.0 string.h was included here; the API changes in 1.6.0 to not
62 * include this unnecessary header file.
65 #ifdef PNG_STDIO_SUPPORTED
66 /* Required for the definition of FILE: */
70 #ifdef PNG_SETJMP_SUPPORTED
71 /* Required for the definition of jmp_buf and the declaration of longjmp: */
75 #ifdef PNG_CONVERT_tIME_SUPPORTED
76 /* Required for struct tm: */
80 #endif /* PNG_BUILDING_SYMBOL_TABLE */
82 /* Prior to 1.6.0 it was possible to turn off 'const' in declarations using
83 * PNG_NO_CONST; this is no longer supported except for data declarations which
84 * apparently still cause problems in 2011 on some compilers.
86 #define PNG_CONST const /* backward compatibility only */
88 /* This controls optimization of the reading of 16 and 32 bit values
89 * from PNG files. It can be set on a per-app-file basis - it
90 * just changes whether a macro is used when the function is called.
91 * The library builder sets the default; if read functions are not
92 * built into the library the macro implementation is forced on.
94 #ifndef PNG_READ_INT_FUNCTIONS_SUPPORTED
95 # define PNG_USE_READ_MACROS
97 #if !defined(PNG_NO_USE_READ_MACROS) && !defined(PNG_USE_READ_MACROS)
98 # if PNG_DEFAULT_READ_MACROS
99 # define PNG_USE_READ_MACROS
103 /* COMPILER SPECIFIC OPTIONS.
105 * These options are provided so that a variety of difficult compilers
106 * can be used. Some are fixed at build time (e.g. PNG_API_RULE
107 * below) but still have compiler specific implementations, others
108 * may be changed on a per-file basis when compiling against libpng.
111 /* The PNGARG macro was used in versions of libpng prior to 1.6.0 to protect
112 * against legacy (pre ISOC90) compilers that did not understand function
113 * prototypes. It is not required for modern C compilers.
116 # define PNGARG(arglist) arglist
119 /* Function calling conventions.
120 * =============================
121 * Normally it is not necessary to specify to the compiler how to call
122 * a function - it just does it - however on x86 systems derived from
123 * Microsoft and Borland C compilers ('IBM PC', 'DOS', 'Windows' systems
124 * and some others) there are multiple ways to call a function and the
125 * default can be changed on the compiler command line. For this reason
126 * libpng specifies the calling convention of every exported function and
127 * every function called via a user supplied function pointer. This is
128 * done in this file by defining the following macros:
130 * PNGAPI Calling convention for exported functions.
131 * PNGCBAPI Calling convention for user provided (callback) functions.
132 * PNGCAPI Calling convention used by the ANSI-C library (required
133 * for longjmp callbacks and sometimes used internally to
134 * specify the calling convention for zlib).
136 * These macros should never be overridden. If it is necessary to
137 * change calling convention in a private build this can be done
138 * by setting PNG_API_RULE (which defaults to 0) to one of the values
139 * below to select the correct 'API' variants.
141 * PNG_API_RULE=0 Use PNGCAPI - the 'C' calling convention - throughout.
142 * This is correct in every known environment.
143 * PNG_API_RULE=1 Use the operating system convention for PNGAPI and
144 * the 'C' calling convention (from PNGCAPI) for
145 * callbacks (PNGCBAPI). This is no longer required
146 * in any known environment - if it has to be used
147 * please post an explanation of the problem to the
148 * libpng mailing list.
150 * These cases only differ if the operating system does not use the C
151 * calling convention, at present this just means the above cases
152 * (x86 DOS/Windows sytems) and, even then, this does not apply to
153 * Cygwin running on those systems.
155 * Note that the value must be defined in pnglibconf.h so that what
156 * the application uses to call the library matches the conventions
157 * set when building the library.
162 * When building a shared library it is almost always necessary to tell
163 * the compiler which symbols to export. The png.h macro 'PNG_EXPORT'
164 * is used to mark the symbols. On some systems these symbols can be
165 * extracted at link time and need no special processing by the compiler,
166 * on other systems the symbols are flagged by the compiler and just
167 * the declaration requires a special tag applied (unfortunately) in a
168 * compiler dependent way. Some systems can do either.
170 * A small number of older systems also require a symbol from a DLL to
171 * be flagged to the program that calls it. This is a problem because
172 * we do not know in the header file included by application code that
173 * the symbol will come from a shared library, as opposed to a statically
174 * linked one. For this reason the application must tell us by setting
175 * the magic flag PNG_USE_DLL to turn on the special processing before
178 * Four additional macros are used to make this happen:
180 * PNG_IMPEXP The magic (if any) to cause a symbol to be exported from
181 * the build or imported if PNG_USE_DLL is set - compiler
182 * and system specific.
184 * PNG_EXPORT_TYPE(type) A macro that pre or appends PNG_IMPEXP to
185 * 'type', compiler specific.
187 * PNG_DLL_EXPORT Set to the magic to use during a libpng build to
188 * make a symbol exported from the DLL. Not used in the
189 * public header files; see pngpriv.h for how it is used
190 * in the libpng build.
192 * PNG_DLL_IMPORT Set to the magic to force the libpng symbols to come
193 * from a DLL - used to define PNG_IMPEXP when
194 * PNG_USE_DLL is set.
197 /* System specific discovery.
198 * ==========================
199 * This code is used at build time to find PNG_IMPEXP, the API settings
200 * and PNG_EXPORT_TYPE(), it may also set a macro to indicate the DLL
201 * import processing is possible. On Windows systems it also sets
202 * compiler-specific macros to the values required to change the calling
203 * conventions of the various functions.
205 #if defined(_Windows) || defined(_WINDOWS) || defined(WIN32) ||\
206 defined(_WIN32) || defined(__WIN32__) || defined(__CYGWIN__)
207 /* Windows system (DOS doesn't support DLLs). Includes builds under Cygwin or
208 * MinGW on any architecture currently supported by Windows. Also includes
209 * Watcom builds but these need special treatment because they are not
210 * compatible with GCC or Visual C because of different calling conventions.
212 # if PNG_API_RULE == 2
213 /* If this line results in an error, either because __watcall is not
214 * understood or because of a redefine just below you cannot use *this*
215 * build of the library with the compiler you are using. *This* build was
216 * build using Watcom and applications must also be built using Watcom!
218 # define PNGCAPI __watcall
221 # if defined(__GNUC__) || (defined(_MSC_VER) && (_MSC_VER >= 800))
222 # define PNGCAPI __cdecl
223 # if PNG_API_RULE == 1
224 /* If this line results in an error __stdcall is not understood and
225 * PNG_API_RULE should not have been set to '1'.
227 # define PNGAPI __stdcall
230 /* An older compiler, or one not detected (erroneously) above,
231 * if necessary override on the command line to get the correct
232 * variants for the compiler.
235 # define PNGCAPI _cdecl
237 # if PNG_API_RULE == 1 && !defined(PNGAPI)
238 # define PNGAPI _stdcall
240 # endif /* compiler/api */
241 /* NOTE: PNGCBAPI always defaults to PNGCAPI. */
243 # if defined(PNGAPI) && !defined(PNG_USER_PRIVATEBUILD)
244 # error "PNG_USER_PRIVATEBUILD must be defined if PNGAPI is changed"
247 # if (defined(_MSC_VER) && _MSC_VER < 800) ||\
248 (defined(__BORLANDC__) && __BORLANDC__ < 0x500)
249 /* older Borland and MSC
250 * compilers used '__export' and required this to be after
253 # ifndef PNG_EXPORT_TYPE
254 # define PNG_EXPORT_TYPE(type) type PNG_IMPEXP
256 # define PNG_DLL_EXPORT __export
257 # else /* newer compiler */
258 # define PNG_DLL_EXPORT __declspec(dllexport)
259 # ifndef PNG_DLL_IMPORT
260 # define PNG_DLL_IMPORT __declspec(dllimport)
262 # endif /* compiler */
265 # if (defined(__IBMC__) || defined(__IBMCPP__)) && defined(__OS2__)
266 # define PNGAPI _System
267 # else /* !Windows/x86 && !OS/2 */
268 /* Use the defaults, or define PNG*API on the command line (but
269 * this will have to be done for every compile!)
271 # endif /* other system, !OS/2 */
272 #endif /* !Windows/x86 */
274 /* Now do all the defaulting . */
279 # define PNGCBAPI PNGCAPI
282 # define PNGAPI PNGCAPI
285 /* PNG_IMPEXP may be set on the compilation system command line or (if not set)
286 * then in an internal header file when building the library, otherwise (when
287 * using the library) it is set here.
290 # if defined(PNG_USE_DLL) && defined(PNG_DLL_IMPORT)
291 /* This forces use of a DLL, disallowing static linking */
292 # define PNG_IMPEXP PNG_DLL_IMPORT
300 /* In 1.5.2 the definition of PNG_FUNCTION has been changed to always treat
301 * 'attributes' as a storage class - the attributes go at the start of the
302 * function definition, and attributes are always appended regardless of the
303 * compiler. This considerably simplifies these macros but may cause problems
304 * if any compilers both need function attributes and fail to handle them as
305 * a storage class (this is unlikely.)
308 # define PNG_FUNCTION(type, name, args, attributes) attributes type name args
311 #ifndef PNG_EXPORT_TYPE
312 # define PNG_EXPORT_TYPE(type) PNG_IMPEXP type
315 /* The ordinal value is only relevant when preprocessing png.h for symbol
316 * table entries, so we discard it here. See the .dfn files in the
321 # define PNG_EXPORTA(ordinal, type, name, args, attributes)\
322 PNG_FUNCTION(PNG_EXPORT_TYPE(type),(PNGAPI name),PNGARG(args), \
326 /* ANSI-C (C90) does not permit a macro to be invoked with an empty argument,
327 * so make something non-empty to satisfy the requirement:
329 #define PNG_EMPTY /*empty list*/
331 #define PNG_EXPORT(ordinal, type, name, args)\
332 PNG_EXPORTA(ordinal, type, name, args, PNG_EMPTY)
334 /* Use PNG_REMOVED to comment out a removed interface. */
336 # define PNG_REMOVED(ordinal, type, name, args, attributes)
340 # define PNG_CALLBACK(type, name, args) type (PNGCBAPI name) PNGARG(args)
343 /* Support for compiler specific function attributes. These are used
344 * so that where compiler support is available incorrect use of API
345 * functions in png.h will generate compiler warnings.
347 * Added at libpng-1.2.41.
350 #ifndef PNG_NO_PEDANTIC_WARNINGS
351 # ifndef PNG_PEDANTIC_WARNINGS_SUPPORTED
352 # define PNG_PEDANTIC_WARNINGS_SUPPORTED
356 #ifdef PNG_PEDANTIC_WARNINGS_SUPPORTED
357 /* Support for compiler specific function attributes. These are used
358 * so that where compiler support is available, incorrect use of API
359 * functions in png.h will generate compiler warnings. Added at libpng
360 * version 1.2.41. Disabling these removes the warnings but may also produce
361 * less efficient code.
363 # if defined(__GNUC__)
364 # ifndef PNG_USE_RESULT
365 # define PNG_USE_RESULT __attribute__((__warn_unused_result__))
367 # ifndef PNG_NORETURN
368 # define PNG_NORETURN __attribute__((__noreturn__))
371 # ifndef PNG_ALLOCATED
372 # define PNG_ALLOCATED __attribute__((__malloc__))
374 # ifndef PNG_DEPRECATED
375 # define PNG_DEPRECATED __attribute__((__deprecated__))
378 # if 0 /* Doesn't work so we use deprecated instead*/
379 # define PNG_PRIVATE \
380 __attribute__((warning("This function is not exported by libpng.")))
382 # define PNG_PRIVATE \
383 __attribute__((__deprecated__))
386 # if ((__GNUC__ != 3) || !defined(__GNUC_MINOR__) || (__GNUC_MINOR__ >= 1))
387 # ifndef PNG_RESTRICT
388 # define PNG_RESTRICT __restrict
390 # endif /* __GNUC__ == 3.0 */
391 # endif /* __GNUC__ >= 3 */
393 # elif defined(_MSC_VER) && (_MSC_VER >= 1300)
394 # ifndef PNG_USE_RESULT
395 # define PNG_USE_RESULT /* not supported */
397 # ifndef PNG_NORETURN
398 # define PNG_NORETURN __declspec(noreturn)
400 # ifndef PNG_ALLOCATED
401 # if (_MSC_VER >= 1400)
402 # define PNG_ALLOCATED __declspec(restrict)
405 # ifndef PNG_DEPRECATED
406 # define PNG_DEPRECATED __declspec(deprecated)
409 # define PNG_PRIVATE __declspec(deprecated)
411 # ifndef PNG_RESTRICT
412 # if (_MSC_VER >= 1400)
413 # define PNG_RESTRICT __restrict
417 # elif defined(__WATCOMC__)
418 # ifndef PNG_RESTRICT
419 # define PNG_RESTRICT __restrict
421 # endif /* _MSC_VER */
422 #endif /* PNG_PEDANTIC_WARNINGS */
424 #ifndef PNG_DEPRECATED
425 # define PNG_DEPRECATED /* Use of this function is deprecated */
427 #ifndef PNG_USE_RESULT
428 # define PNG_USE_RESULT /* The result of this function must be checked */
431 # define PNG_NORETURN /* This function does not return */
433 #ifndef PNG_ALLOCATED
434 # define PNG_ALLOCATED /* The result of the function is new memory */
437 # define PNG_PRIVATE /* This is a private libpng function */
440 # define PNG_RESTRICT /* The C99 "restrict" feature */
442 #ifndef PNG_FP_EXPORT /* A floating point API. */
443 # ifdef PNG_FLOATING_POINT_SUPPORTED
444 # define PNG_FP_EXPORT(ordinal, type, name, args)\
445 PNG_EXPORT(ordinal, type, name, args);
446 # else /* No floating point APIs */
447 # define PNG_FP_EXPORT(ordinal, type, name, args)
450 #ifndef PNG_FIXED_EXPORT /* A fixed point API. */
451 # ifdef PNG_FIXED_POINT_SUPPORTED
452 # define PNG_FIXED_EXPORT(ordinal, type, name, args)\
453 PNG_EXPORT(ordinal, type, name, args);
454 # else /* No fixed point APIs */
455 # define PNG_FIXED_EXPORT(ordinal, type, name, args)
459 #ifndef PNG_BUILDING_SYMBOL_TABLE
460 /* Some typedefs to get us started. These should be safe on most of the common
463 * png_uint_32 and png_int_32 may, currently, be larger than required to hold a
464 * 32-bit value however this is not normally advisable.
466 * png_uint_16 and png_int_16 should always be two bytes in size - this is
467 * verified at library build time.
469 * png_byte must always be one byte in size.
471 * The checks below use constants from limits.h, as defined by the ISOC90
474 #if CHAR_BIT == 8 && UCHAR_MAX == 255
475 typedef unsigned char png_byte
;
477 # error "libpng requires 8 bit bytes"
480 #if INT_MIN == -32768 && INT_MAX == 32767
481 typedef int png_int_16
;
482 #elif SHRT_MIN == -32768 && SHRT_MAX == 32767
483 typedef short png_int_16
;
485 # error "libpng requires a signed 16 bit type"
488 #if UINT_MAX == 65535
489 typedef unsigned int png_uint_16
;
490 #elif USHRT_MAX == 65535
491 typedef unsigned short png_uint_16
;
493 # error "libpng requires an unsigned 16 bit type"
496 #if INT_MIN < -2147483646 && INT_MAX > 2147483646
497 typedef int png_int_32
;
498 #elif LONG_MIN < -2147483646 && LONG_MAX > 2147483646
499 typedef long int png_int_32
;
501 # error "libpng requires a signed 32 bit (or more) type"
504 #if UINT_MAX > 4294967294
505 typedef unsigned int png_uint_32
;
506 #elif ULONG_MAX > 4294967294
507 typedef unsigned long int png_uint_32
;
509 # error "libpng requires an unsigned 32 bit (or more) type"
512 /* Prior to 1.6.0 it was possible to disable the use of size_t, 1.6.0, however,
513 * requires an ISOC90 compiler and relies on consistent behavior of sizeof.
515 typedef size_t png_size_t
;
516 typedef ptrdiff_t png_ptrdiff_t
;
518 /* libpng needs to know the maximum value of 'size_t' and this controls the
519 * definition of png_alloc_size_t, below. This maximum value of size_t limits
520 * but does not control the maximum allocations the library makes - there is
521 * direct application control of this through png_set_user_limits().
523 #ifndef PNG_SMALL_SIZE_T
524 /* Compiler specific tests for systems where size_t is known to be less than
525 * 32 bits (some of these systems may no longer work because of the lack of
526 * 'far' support; see above.)
528 # if (defined(__TURBOC__) && !defined(__FLAT__)) ||\
529 (defined(_MSC_VER) && defined(MAXSEG_64K))
530 # define PNG_SMALL_SIZE_T
534 /* png_alloc_size_t is guaranteed to be no smaller than png_size_t, and no
535 * smaller than png_uint_32. Casts from png_size_t or png_uint_32 to
536 * png_alloc_size_t are not necessary; in fact, it is recommended not to use
537 * them at all so that the compiler can complain when something turns out to be
540 * Casts in the other direction (from png_alloc_size_t to png_size_t or
541 * png_uint_32) should be explicitly applied; however, we do not expect to
542 * encounter practical situations that require such conversions.
544 * PNG_SMALL_SIZE_T must be defined if the maximum value of size_t is less than
545 * 4294967295 - i.e. less than the maximum value of png_uint_32.
547 #ifdef PNG_SMALL_SIZE_T
548 typedef png_uint_32 png_alloc_size_t
;
550 typedef png_size_t png_alloc_size_t
;
553 /* Prior to 1.6.0 libpng offered limited support for Microsoft C compiler
554 * implementations of Intel CPU specific support of user-mode segmented address
555 * spaces, where 16-bit pointers address more than 65536 bytes of memory using
556 * separate 'segment' registers. The implementation requires two different
557 * types of pointer (only one of which includes the segment value.)
559 * If required this support is available in version 1.2 of libpng and may be
560 * available in versions through 1.5, although the correctness of the code has
561 * not been verified recently.
564 /* Typedef for floating-point numbers that are converted to fixed-point with a
565 * multiple of 100,000, e.g., gamma
567 typedef png_int_32 png_fixed_point
;
569 /* Add typedefs for pointers */
570 typedef void * png_voidp
;
571 typedef const void * png_const_voidp
;
572 typedef png_byte
* png_bytep
;
573 typedef const png_byte
* png_const_bytep
;
574 typedef png_uint_32
* png_uint_32p
;
575 typedef const png_uint_32
* png_const_uint_32p
;
576 typedef png_int_32
* png_int_32p
;
577 typedef const png_int_32
* png_const_int_32p
;
578 typedef png_uint_16
* png_uint_16p
;
579 typedef const png_uint_16
* png_const_uint_16p
;
580 typedef png_int_16
* png_int_16p
;
581 typedef const png_int_16
* png_const_int_16p
;
582 typedef char * png_charp
;
583 typedef const char * png_const_charp
;
584 typedef png_fixed_point
* png_fixed_point_p
;
585 typedef const png_fixed_point
* png_const_fixed_point_p
;
586 typedef png_size_t
* png_size_tp
;
587 typedef const png_size_t
* png_const_size_tp
;
589 #ifdef PNG_STDIO_SUPPORTED
590 typedef FILE * png_FILE_p
;
593 #ifdef PNG_FLOATING_POINT_SUPPORTED
594 typedef double * png_doublep
;
595 typedef const double * png_const_doublep
;
598 /* Pointers to pointers; i.e. arrays */
599 typedef png_byte
* * png_bytepp
;
600 typedef png_uint_32
* * png_uint_32pp
;
601 typedef png_int_32
* * png_int_32pp
;
602 typedef png_uint_16
* * png_uint_16pp
;
603 typedef png_int_16
* * png_int_16pp
;
604 typedef const char * * png_const_charpp
;
605 typedef char * * png_charpp
;
606 typedef png_fixed_point
* * png_fixed_point_pp
;
607 #ifdef PNG_FLOATING_POINT_SUPPORTED
608 typedef double * * png_doublepp
;
611 /* Pointers to pointers to pointers; i.e., pointer to array */
612 typedef char * * * png_charppp
;
614 #endif /* PNG_BUILDING_SYMBOL_TABLE */
616 #endif /* PNGCONF_H */