blob: 45e12760c6c3509f3a746506183d575c23cd970f [file] [log] [blame]
Glenn Randers-Pehrsonc17c9572010-03-08 21:26:48 -06001
2/* pngdebug.h - Debugging macros for libpng, also used in pngtest.c
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -06003 *
Glenn Randers-Pehrson1f63da32013-11-28 13:41:10 -06004 * Copyright (c) 1998-2013 Glenn Randers-Pehrson
Glenn Randers-Pehrsonc17c9572010-03-08 21:26:48 -06005 * (Version 0.96 Copyright (c) 1996, 1997 Andreas Dilger)
6 * (Version 0.88 Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)
7 *
Glenn Randers-Pehrson83b132f2013-11-28 14:00:04 -06008 * Last changed in libpng 1.5.18 [(PENDING RELEASE)]
Glenn Randers-Pehrsonc17c9572010-03-08 21:26:48 -06009 *
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
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -060013 */
14
15/* Define PNG_DEBUG at compile time for debugging information. Higher
16 * numbers for PNG_DEBUG mean more debugging information. This has
17 * only been added since version 0.95 so it is not implemented throughout
18 * libpng yet, but more support will be added as needed.
Glenn Randers-Pehrson632a84e2010-03-09 22:28:33 -060019 *
20 * png_debug[1-2]?(level, message ,arg{0-2})
21 * Expands to a statement (either a simple expression or a compound
22 * do..while(0) statement) that outputs a message with parameter
23 * substitution if PNG_DEBUG is defined to 2 or more. If PNG_DEBUG
24 * is undefined, 0 or 1 every png_debug expands to a simple expression
25 * (actually ((void)0)).
26 *
27 * level: level of detail of message, starting at 0. A level 'n'
Glenn Randers-Pehrson83b132f2013-11-28 14:00:04 -060028 * message is preceded by 'n' 3-space indentations (not implemented
Glenn Randers-Pehrson821b7102010-06-24 16:16:32 -050029 * on Microsoft compilers unless PNG_DEBUG_FILE is also
Glenn Randers-Pehrson632a84e2010-03-09 22:28:33 -060030 * defined, to allow debug DLL compilation with no standard IO).
31 * message: a printf(3) style text string. A trailing '\n' is added
32 * to the message.
33 * arg: 0 to 2 arguments for printf(3) style substitution in message.
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -060034 */
Glenn Randers-Pehrsonc957b6b2010-03-08 21:47:07 -060035#ifndef PNGDEBUG_H
36#define PNGDEBUG_H
Glenn Randers-Pehrson53c07f52010-06-18 18:55:55 -050037/* These settings control the formatting of messages in png.c and pngerror.c */
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -050038/* Moved to pngdebug.h at 1.5.0 */
39# ifndef PNG_LITERAL_SHARP
40# define PNG_LITERAL_SHARP 0x23
41# endif
42# ifndef PNG_LITERAL_LEFT_SQUARE_BRACKET
43# define PNG_LITERAL_LEFT_SQUARE_BRACKET 0x5b
44# endif
45# ifndef PNG_LITERAL_RIGHT_SQUARE_BRACKET
46# define PNG_LITERAL_RIGHT_SQUARE_BRACKET 0x5d
47# endif
48# ifndef PNG_STRING_NEWLINE
49# define PNG_STRING_NEWLINE "\n"
50# endif
51
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -060052#ifdef PNG_DEBUG
53# if (PNG_DEBUG > 0)
54# if !defined(PNG_DEBUG_FILE) && defined(_MSC_VER)
55# include <crtdbg.h>
56# if (PNG_DEBUG > 1)
57# ifndef _DEBUG
58# define _DEBUG
59# endif
60# ifndef png_debug
61# define png_debug(l,m) _RPT0(_CRT_WARN,m PNG_STRING_NEWLINE)
62# endif
63# ifndef png_debug1
64# define png_debug1(l,m,p1) _RPT1(_CRT_WARN,m PNG_STRING_NEWLINE,p1)
65# endif
66# ifndef png_debug2
67# define png_debug2(l,m,p1,p2) \
68 _RPT2(_CRT_WARN,m PNG_STRING_NEWLINE,p1,p2)
69# endif
70# endif
71# else /* PNG_DEBUG_FILE || !_MSC_VER */
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -050072# ifndef PNG_STDIO_SUPPORTED
73# include <stdio.h> /* not included yet */
74# endif
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -060075# ifndef PNG_DEBUG_FILE
76# define PNG_DEBUG_FILE stderr
77# endif /* PNG_DEBUG_FILE */
78
79# if (PNG_DEBUG > 1)
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -060080# ifdef __STDC__
81# ifndef png_debug
82# define png_debug(l,m) \
Glenn Randers-Pehrson632a84e2010-03-09 22:28:33 -060083 do { \
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -060084 int num_tabs=l; \
Glenn Randers-Pehrson1f63da32013-11-28 13:41:10 -060085 fprintf(PNG_DEBUG_FILE,"%s" m PNG_STRING_NEWLINE,(num_tabs==1 ? " " : \
86 (num_tabs==2 ? " " : (num_tabs>2 ? " " : "")))); \
Glenn Randers-Pehrson632a84e2010-03-09 22:28:33 -060087 } while (0)
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -060088# endif
89# ifndef png_debug1
90# define png_debug1(l,m,p1) \
Glenn Randers-Pehrson632a84e2010-03-09 22:28:33 -060091 do { \
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -060092 int num_tabs=l; \
Glenn Randers-Pehrson1f63da32013-11-28 13:41:10 -060093 fprintf(PNG_DEBUG_FILE,"%s" m PNG_STRING_NEWLINE,(num_tabs==1 ? " " : \
94 (num_tabs==2 ? " " : (num_tabs>2 ? " " : ""))),p1); \
Glenn Randers-Pehrson632a84e2010-03-09 22:28:33 -060095 } while (0)
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -060096# endif
97# ifndef png_debug2
98# define png_debug2(l,m,p1,p2) \
Glenn Randers-Pehrson632a84e2010-03-09 22:28:33 -060099 do { \
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -0600100 int num_tabs=l; \
Glenn Randers-Pehrson1f63da32013-11-28 13:41:10 -0600101 fprintf(PNG_DEBUG_FILE,"%s" m PNG_STRING_NEWLINE,(num_tabs==1 ? " " : \
102 (num_tabs==2 ? " " : (num_tabs>2 ? " " : ""))),p1,p2);\
Glenn Randers-Pehrson632a84e2010-03-09 22:28:33 -0600103 } while (0)
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -0600104# endif
105# else /* __STDC __ */
106# ifndef png_debug
107# define png_debug(l,m) \
Glenn Randers-Pehrson632a84e2010-03-09 22:28:33 -0600108 do { \
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -0600109 int num_tabs=l; \
110 char format[256]; \
111 snprintf(format,256,"%s%s%s",(num_tabs==1 ? "\t" : \
112 (num_tabs==2 ? "\t\t":(num_tabs>2 ? "\t\t\t":""))), \
113 m,PNG_STRING_NEWLINE); \
114 fprintf(PNG_DEBUG_FILE,format); \
Glenn Randers-Pehrson632a84e2010-03-09 22:28:33 -0600115 } while (0)
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -0600116# endif
117# ifndef png_debug1
118# define png_debug1(l,m,p1) \
Glenn Randers-Pehrson632a84e2010-03-09 22:28:33 -0600119 do { \
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -0600120 int num_tabs=l; \
121 char format[256]; \
122 snprintf(format,256,"%s%s%s",(num_tabs==1 ? "\t" : \
123 (num_tabs==2 ? "\t\t":(num_tabs>2 ? "\t\t\t":""))), \
124 m,PNG_STRING_NEWLINE); \
125 fprintf(PNG_DEBUG_FILE,format,p1); \
Glenn Randers-Pehrson632a84e2010-03-09 22:28:33 -0600126 } while (0)
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -0600127# endif
128# ifndef png_debug2
129# define png_debug2(l,m,p1,p2) \
Glenn Randers-Pehrson632a84e2010-03-09 22:28:33 -0600130 do { \
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -0600131 int num_tabs=l; \
132 char format[256]; \
133 snprintf(format,256,"%s%s%s",(num_tabs==1 ? "\t" : \
134 (num_tabs==2 ? "\t\t":(num_tabs>2 ? "\t\t\t":""))), \
135 m,PNG_STRING_NEWLINE); \
136 fprintf(PNG_DEBUG_FILE,format,p1,p2); \
Glenn Randers-Pehrson632a84e2010-03-09 22:28:33 -0600137 } while (0)
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -0600138# endif
139# endif /* __STDC __ */
140# endif /* (PNG_DEBUG > 1) */
141
142# endif /* _MSC_VER */
143# endif /* (PNG_DEBUG > 0) */
144#endif /* PNG_DEBUG */
145#ifndef png_debug
Glenn Randers-Pehrson632a84e2010-03-09 22:28:33 -0600146# define png_debug(l, m) ((void)0)
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -0600147#endif
148#ifndef png_debug1
Glenn Randers-Pehrson632a84e2010-03-09 22:28:33 -0600149# define png_debug1(l, m, p1) ((void)0)
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -0600150#endif
151#ifndef png_debug2
Glenn Randers-Pehrson632a84e2010-03-09 22:28:33 -0600152# define png_debug2(l, m, p1, p2) ((void)0)
Glenn Randers-Pehrsonc3cd22b2010-03-08 21:10:25 -0600153#endif
Glenn Randers-Pehrsonc957b6b2010-03-08 21:47:07 -0600154#endif /* PNGDEBUG_H */