1b50c217251b086440efcdb273c22f86a06c80cbaChris Craik
2b50c217251b086440efcdb273c22f86a06c80cbaChris Craik/* pngdebug.h - Debugging macros for libpng, also used in pngtest.c
3b50c217251b086440efcdb273c22f86a06c80cbaChris Craik *
49b1fe63dcc7ba076b9730b7bfa031cc0dbc25561Matt Sarett * Last changed in libpng 1.6.8 [December 19, 2013]
5114668651129dc978b9710d0f0ad107ee5ee3281Matt Sarett * Copyright (c) 1998-2002,2004,2006-2013 Glenn Randers-Pehrson
6b50c217251b086440efcdb273c22f86a06c80cbaChris Craik * (Version 0.96 Copyright (c) 1996, 1997 Andreas Dilger)
7b50c217251b086440efcdb273c22f86a06c80cbaChris Craik * (Version 0.88 Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)
8b50c217251b086440efcdb273c22f86a06c80cbaChris Craik *
9b50c217251b086440efcdb273c22f86a06c80cbaChris Craik * This code is released under the libpng license.
10b50c217251b086440efcdb273c22f86a06c80cbaChris Craik * For conditions of distribution and use, see the disclaimer
11b50c217251b086440efcdb273c22f86a06c80cbaChris Craik * and license in png.h
12b50c217251b086440efcdb273c22f86a06c80cbaChris Craik */
13b50c217251b086440efcdb273c22f86a06c80cbaChris Craik
14b50c217251b086440efcdb273c22f86a06c80cbaChris Craik/* Define PNG_DEBUG at compile time for debugging information.  Higher
15b50c217251b086440efcdb273c22f86a06c80cbaChris Craik * numbers for PNG_DEBUG mean more debugging information.  This has
16b50c217251b086440efcdb273c22f86a06c80cbaChris Craik * only been added since version 0.95 so it is not implemented throughout
17b50c217251b086440efcdb273c22f86a06c80cbaChris Craik * libpng yet, but more support will be added as needed.
18b50c217251b086440efcdb273c22f86a06c80cbaChris Craik *
19b50c217251b086440efcdb273c22f86a06c80cbaChris Craik * png_debug[1-2]?(level, message ,arg{0-2})
20b50c217251b086440efcdb273c22f86a06c80cbaChris Craik *   Expands to a statement (either a simple expression or a compound
21b50c217251b086440efcdb273c22f86a06c80cbaChris Craik *   do..while(0) statement) that outputs a message with parameter
22b50c217251b086440efcdb273c22f86a06c80cbaChris Craik *   substitution if PNG_DEBUG is defined to 2 or more.  If PNG_DEBUG
23b50c217251b086440efcdb273c22f86a06c80cbaChris Craik *   is undefined, 0 or 1 every png_debug expands to a simple expression
24b50c217251b086440efcdb273c22f86a06c80cbaChris Craik *   (actually ((void)0)).
25b50c217251b086440efcdb273c22f86a06c80cbaChris Craik *
26b50c217251b086440efcdb273c22f86a06c80cbaChris Craik *   level: level of detail of message, starting at 0.  A level 'n'
27b478e66e7c2621eef5f465e4629ce642db00716bSireesh Tripurari *          message is preceded by 'n' 3-space indentations (not implemented
28b50c217251b086440efcdb273c22f86a06c80cbaChris Craik *          on Microsoft compilers unless PNG_DEBUG_FILE is also
29b50c217251b086440efcdb273c22f86a06c80cbaChris Craik *          defined, to allow debug DLL compilation with no standard IO).
30b50c217251b086440efcdb273c22f86a06c80cbaChris Craik *   message: a printf(3) style text string.  A trailing '\n' is added
31b50c217251b086440efcdb273c22f86a06c80cbaChris Craik *            to the message.
32b50c217251b086440efcdb273c22f86a06c80cbaChris Craik *   arg: 0 to 2 arguments for printf(3) style substitution in message.
33b50c217251b086440efcdb273c22f86a06c80cbaChris Craik */
34b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#ifndef PNGDEBUG_H
35b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#define PNGDEBUG_H
36b50c217251b086440efcdb273c22f86a06c80cbaChris Craik/* These settings control the formatting of messages in png.c and pngerror.c */
37b50c217251b086440efcdb273c22f86a06c80cbaChris Craik/* Moved to pngdebug.h at 1.5.0 */
38b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#  ifndef PNG_LITERAL_SHARP
39b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#    define PNG_LITERAL_SHARP 0x23
40b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#  endif
41b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#  ifndef PNG_LITERAL_LEFT_SQUARE_BRACKET
42b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#    define PNG_LITERAL_LEFT_SQUARE_BRACKET 0x5b
43b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#  endif
44b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#  ifndef PNG_LITERAL_RIGHT_SQUARE_BRACKET
45b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#    define PNG_LITERAL_RIGHT_SQUARE_BRACKET 0x5d
46b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#  endif
47b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#  ifndef PNG_STRING_NEWLINE
48b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#    define PNG_STRING_NEWLINE "\n"
49b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#  endif
50b50c217251b086440efcdb273c22f86a06c80cbaChris Craik
51b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#ifdef PNG_DEBUG
52b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#  if (PNG_DEBUG > 0)
53b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#    if !defined(PNG_DEBUG_FILE) && defined(_MSC_VER)
54b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#      include <crtdbg.h>
55b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#      if (PNG_DEBUG > 1)
56b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#        ifndef _DEBUG
57b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#          define _DEBUG
58b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#        endif
59b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#        ifndef png_debug
60b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#          define png_debug(l,m)  _RPT0(_CRT_WARN,m PNG_STRING_NEWLINE)
61b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#        endif
62b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#        ifndef png_debug1
63b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#          define png_debug1(l,m,p1)  _RPT1(_CRT_WARN,m PNG_STRING_NEWLINE,p1)
64b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#        endif
65b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#        ifndef png_debug2
66b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#          define png_debug2(l,m,p1,p2) \
67b50c217251b086440efcdb273c22f86a06c80cbaChris Craik             _RPT2(_CRT_WARN,m PNG_STRING_NEWLINE,p1,p2)
68b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#        endif
69b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#      endif
70b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#    else /* PNG_DEBUG_FILE || !_MSC_VER */
71b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#      ifndef PNG_STDIO_SUPPORTED
72b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#        include <stdio.h> /* not included yet */
73b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#      endif
74b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#      ifndef PNG_DEBUG_FILE
75b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#        define PNG_DEBUG_FILE stderr
76b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#      endif /* PNG_DEBUG_FILE */
77b50c217251b086440efcdb273c22f86a06c80cbaChris Craik
78b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#      if (PNG_DEBUG > 1)
79b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#        ifdef __STDC__
80b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#          ifndef png_debug
81b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#            define png_debug(l,m) \
82b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       do { \
83b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       int num_tabs=l; \
84b478e66e7c2621eef5f465e4629ce642db00716bSireesh Tripurari       fprintf(PNG_DEBUG_FILE,"%s" m PNG_STRING_NEWLINE,(num_tabs==1 ? "   " : \
85b478e66e7c2621eef5f465e4629ce642db00716bSireesh Tripurari         (num_tabs==2 ? "      " : (num_tabs>2 ? "         " : "")))); \
86b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       } while (0)
87b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#          endif
88b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#          ifndef png_debug1
89b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#            define png_debug1(l,m,p1) \
90b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       do { \
91b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       int num_tabs=l; \
92b478e66e7c2621eef5f465e4629ce642db00716bSireesh Tripurari       fprintf(PNG_DEBUG_FILE,"%s" m PNG_STRING_NEWLINE,(num_tabs==1 ? "   " : \
93b478e66e7c2621eef5f465e4629ce642db00716bSireesh Tripurari         (num_tabs==2 ? "      " : (num_tabs>2 ? "         " : ""))),p1); \
94b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       } while (0)
95b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#          endif
96b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#          ifndef png_debug2
97b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#            define png_debug2(l,m,p1,p2) \
98b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       do { \
99b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       int num_tabs=l; \
100b478e66e7c2621eef5f465e4629ce642db00716bSireesh Tripurari       fprintf(PNG_DEBUG_FILE,"%s" m PNG_STRING_NEWLINE,(num_tabs==1 ? "   " : \
101b478e66e7c2621eef5f465e4629ce642db00716bSireesh Tripurari         (num_tabs==2 ? "      " : (num_tabs>2 ? "         " : ""))),p1,p2);\
102b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       } while (0)
103b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#          endif
104b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#        else /* __STDC __ */
105b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#          ifndef png_debug
106b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#            define png_debug(l,m) \
107b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       do { \
108b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       int num_tabs=l; \
109b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       char format[256]; \
110b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       snprintf(format,256,"%s%s%s",(num_tabs==1 ? "\t" : \
111b50c217251b086440efcdb273c22f86a06c80cbaChris Craik         (num_tabs==2 ? "\t\t":(num_tabs>2 ? "\t\t\t":""))), \
112b50c217251b086440efcdb273c22f86a06c80cbaChris Craik         m,PNG_STRING_NEWLINE); \
113b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       fprintf(PNG_DEBUG_FILE,format); \
114b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       } while (0)
115b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#          endif
116b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#          ifndef png_debug1
117b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#            define png_debug1(l,m,p1) \
118b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       do { \
119b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       int num_tabs=l; \
120b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       char format[256]; \
121b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       snprintf(format,256,"%s%s%s",(num_tabs==1 ? "\t" : \
122b50c217251b086440efcdb273c22f86a06c80cbaChris Craik         (num_tabs==2 ? "\t\t":(num_tabs>2 ? "\t\t\t":""))), \
123b50c217251b086440efcdb273c22f86a06c80cbaChris Craik         m,PNG_STRING_NEWLINE); \
124b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       fprintf(PNG_DEBUG_FILE,format,p1); \
125b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       } while (0)
126b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#          endif
127b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#          ifndef png_debug2
128b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#            define png_debug2(l,m,p1,p2) \
129b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       do { \
130b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       int num_tabs=l; \
131b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       char format[256]; \
132b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       snprintf(format,256,"%s%s%s",(num_tabs==1 ? "\t" : \
133b50c217251b086440efcdb273c22f86a06c80cbaChris Craik         (num_tabs==2 ? "\t\t":(num_tabs>2 ? "\t\t\t":""))), \
134b50c217251b086440efcdb273c22f86a06c80cbaChris Craik         m,PNG_STRING_NEWLINE); \
135b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       fprintf(PNG_DEBUG_FILE,format,p1,p2); \
136b50c217251b086440efcdb273c22f86a06c80cbaChris Craik       } while (0)
137b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#          endif
138b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#        endif /* __STDC __ */
139b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#      endif /* (PNG_DEBUG > 1) */
140b50c217251b086440efcdb273c22f86a06c80cbaChris Craik
141b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#    endif /* _MSC_VER */
142b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#  endif /* (PNG_DEBUG > 0) */
143b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#endif /* PNG_DEBUG */
144b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#ifndef png_debug
145b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#  define png_debug(l, m) ((void)0)
146b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#endif
147b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#ifndef png_debug1
148b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#  define png_debug1(l, m, p1) ((void)0)
149b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#endif
150b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#ifndef png_debug2
151b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#  define png_debug2(l, m, p1, p2) ((void)0)
152b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#endif
153b50c217251b086440efcdb273c22f86a06c80cbaChris Craik#endif /* PNGDEBUG_H */
154