jas_debug.h
1 /*
2 * Copyright (c) 2001-2002 Michael David Adams.
3 * All rights reserved.
4 */
5
6 /* __START_OF_JASPER_LICENSE__
7 *
8 * JasPer License Version 2.0
9 *
10 * Copyright (c) 2001-2006 Michael David Adams
11 * Copyright (c) 1999-2000 Image Power, Inc.
12 * Copyright (c) 1999-2000 The University of British Columbia
13 *
14 * All rights reserved.
15 *
16 * Permission is hereby granted, free of charge, to any person (the
17 * "User") obtaining a copy of this software and associated documentation
18 * files (the "Software"), to deal in the Software without restriction,
19 * including without limitation the rights to use, copy, modify, merge,
20 * publish, distribute, and/or sell copies of the Software, and to permit
21 * persons to whom the Software is furnished to do so, subject to the
22 * following conditions:
23 *
24 * 1. The above copyright notices and this permission notice (which
25 * includes the disclaimer below) shall be included in all copies or
26 * substantial portions of the Software.
27 *
28 * 2. The name of a copyright holder shall not be used to endorse or
29 * promote products derived from the Software without specific prior
30 * written permission.
31 *
32 * THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
33 * LICENSE. NO USE OF THE SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER
34 * THIS DISCLAIMER. THE SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS
35 * "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
36 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
37 * PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. IN NO
38 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
39 * INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
40 * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
41 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
42 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. NO ASSURANCES ARE
43 * PROVIDED BY THE COPYRIGHT HOLDERS THAT THE SOFTWARE DOES NOT INFRINGE
44 * THE PATENT OR OTHER INTELLECTUAL PROPERTY RIGHTS OF ANY OTHER ENTITY.
45 * EACH COPYRIGHT HOLDER DISCLAIMS ANY LIABILITY TO THE USER FOR CLAIMS
46 * BROUGHT BY ANY OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL
47 * PROPERTY RIGHTS OR OTHERWISE. AS A CONDITION TO EXERCISING THE RIGHTS
48 * GRANTED HEREUNDER, EACH USER HEREBY ASSUMES SOLE RESPONSIBILITY TO SECURE
49 * ANY OTHER INTELLECTUAL PROPERTY RIGHTS NEEDED, IF ANY. THE SOFTWARE
50 * IS NOT FAULT-TOLERANT AND IS NOT INTENDED FOR USE IN MISSION-CRITICAL
51 * SYSTEMS, SUCH AS THOSE USED IN THE OPERATION OF NUCLEAR FACILITIES,
52 * AIRCRAFT NAVIGATION OR COMMUNICATION SYSTEMS, AIR TRAFFIC CONTROL
53 * SYSTEMS, DIRECT LIFE SUPPORT MACHINES, OR WEAPONS SYSTEMS, IN WHICH
54 * THE FAILURE OF THE SOFTWARE OR SYSTEM COULD LEAD DIRECTLY TO DEATH,
55 * PERSONAL INJURY, OR SEVERE PHYSICAL OR ENVIRONMENTAL DAMAGE ("HIGH
56 * RISK ACTIVITIES"). THE COPYRIGHT HOLDERS SPECIFICALLY DISCLAIM ANY
57 * EXPRESS OR IMPLIED WARRANTY OF FITNESS FOR HIGH RISK ACTIVITIES.
58 *
59 * __END_OF_JASPER_LICENSE__
60 */
61
62 /*
63 * Debugging-Related Code
64 *
65 * $Id$
66 */
67
68 #ifndef JAS_DEBUG_H
69 #define JAS_DEBUG_H
70
71 /******************************************************************************\
72 * Includes.
73 \******************************************************************************/
74
75 /* The configuration header file should be included first. */
76 #include <jasper/jas_config.h>
77
78 #include <stdio.h>
79
80 #include <jasper/jas_types.h>
81 #include <jasper/jas_debug.h>
82
83 #ifdef __cplusplus
84 extern "C" {
85 #endif
86
87 /******************************************************************************\
88 * Macros and functions.
89 \******************************************************************************/
90
91 /* Output debugging information to standard error provided that the debug
92 level is set sufficiently high. */
93 #if !defined(NDEBUG)
94 #define JAS_DBGLOG(n, x) \
95 ((jas_getdbglevel() >= (n)) ? (jas_eprintf x) : 0)
96 #else
97 #define JAS_DBGLOG(n, x)
98 #endif
99
100 /* Get the library debug level. */
101 JAS_DLLEXPORT int jas_getdbglevel(void);
102
103 /* Set the library debug level. */
104 JAS_DLLEXPORT int jas_setdbglevel(int dbglevel);
105
106 /* Perform formatted output to standard error. */
107 JAS_DLLEXPORT int jas_eprintf(const char *fmt, ...);
108
109 /* Dump memory to a stream. */
110 int jas_memdump(FILE *out, void *data, size_t len);
111
112 /* Warn about use of deprecated functionality. */
113 void jas_deprecated(const char *s);
114
115 /* Convert to a string literal */
116 #define JAS_STRINGIFY(x) #x
117
118 /* Convert to a string literal after macro expansion */
119 #define JAS_STRINGIFYX(x) JAS_STRINGIFY(x)
120
121 #ifdef __cplusplus
122 }
123 #endif
124
125 #endif