JasPer  3.0.1
jas_debug.h
Go to the documentation of this file.
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 
67 #ifndef JAS_DEBUG_H
68 #define JAS_DEBUG_H
69 
70 /******************************************************************************\
71 * Includes.
72 \******************************************************************************/
73 
74 /* The configuration header file should be included first. */
75 #include <jasper/jas_config.h>
76 
77 #include "jasper/jas_init.h"
78 #include "jasper/jas_debug.h"
79 
80 #include <stdio.h>
81 #include <stdarg.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_get_debug_level() >= (n)) ? (jas_eprintf x) : 0)
96 #else
97 #define JAS_DBGLOG(n, x)
98 #endif
99 
100 #if !defined(NDEBUG)
101 #define JAS_LOGDEBUGF(n, ...) \
102  ((jas_get_debug_level() >= (n)) ? jas_logdebugf((n), __VA_ARGS__) : 0)
103 #else
104 #define JAS_LOGDEBUGF(n, ...)
105 #endif
106 
111 JAS_EXPORT
112 void jas_deprecated(const char *fmt, ...);
113 
121 JAS_DEPRECATED
122 static inline
124 {
125  jas_deprecated("jas_getdbglevel is deprecated\n");
126  return jas_get_debug_level();
127 }
128 
133 JAS_EXPORT
134 int jas_setdbglevel(int dbglevel);
135 
140 JAS_EXPORT
141 int jas_eprintf(const char *fmt, ...);
142 
147 JAS_EXPORT
148 int jas_logprintf(const char *fmt, ...);
149 
154 JAS_EXPORT
155 int jas_logerrorf(const char *fmt, ...);
156 
161 JAS_EXPORT
162 int jas_logwarnf(const char *fmt, ...);
163 
168 JAS_EXPORT
169 int jas_loginfof(const char *fmt, ...);
170 
175 JAS_EXPORT
176 int jas_logdebugf(int priority, const char *fmt, ...);
177 
182 int jas_logmemdump(const void *data, size_t len);
183 
188 JAS_EXPORT
189 int jas_memdump(FILE *out, const void *data, size_t len);
190 
195 #define JAS_STRINGIFY(x) #x
196 
201 #define JAS_STRINGIFYX(x) JAS_STRINGIFY(x)
202 
203 #ifdef __cplusplus
204 }
205 #endif
206 
207 #endif
jas_init.h
JasPer Initialization/Cleanup Code.
jas_logwarnf
JAS_EXPORT int jas_logwarnf(const char *fmt,...)
Generate a warning log message.
Definition: jas_debug.c:131
jas_log.h
JasPer Logging Functionality.
jas_memdump
JAS_EXPORT int jas_memdump(FILE *out, const void *data, size_t len)
Dump memory to a stream.
Definition: jas_debug.c:227
JAS_LOGTYPE_CLASS_INFO
#define JAS_LOGTYPE_CLASS_INFO
Definition: jas_log.h:100
jas_logerrorf
JAS_EXPORT int jas_logerrorf(const char *fmt,...)
Generate an error log message.
Definition: jas_debug.c:119
JAS_LOGTYPE_CLASS_DEBUG
#define JAS_LOGTYPE_CLASS_DEBUG
Definition: jas_log.h:102
jas_eprintf
JAS_EXPORT int jas_eprintf(const char *fmt,...)
Print formatted text for the standard error stream (i.e., stderr).
Definition: jas_debug.c:96
jas_get_debug_level
static int jas_get_debug_level(void)
Get the debug level for a particular context.
Definition: jas_init.h:429
JAS_LOGTYPE_CLASS_NULL
#define JAS_LOGTYPE_CLASS_NULL
Definition: jas_log.h:94
JAS_LOGTYPE_CLASS_WARN
#define JAS_LOGTYPE_CLASS_WARN
Definition: jas_log.h:98
jas_get_vlogmsgf
static jas_vlogmsgf_t * jas_get_vlogmsgf(void)
Get the function to be used for log messages.
Definition: jas_init.h:482
jas_logtype_init
static jas_logtype_t jas_logtype_init(int clas, int priority)
Create an instance of a logtype.
Definition: jas_log.h:122
jas_debug.h
JasPer Debugging-Related Functionality.
jas_logdebugf
JAS_EXPORT int jas_logdebugf(int priority, const char *fmt,...)
Generate a debugging log message.
Definition: jas_debug.c:155
jas_vlogmsgf_stderr
JAS_EXPORT int jas_vlogmsgf_stderr(jas_logtype_t type, const char *fmt, va_list ap)
Output a log message to standard error.
Definition: jas_debug.c:181
jas_vlogmsgf
JAS_EXPORT int jas_vlogmsgf(jas_logtype_t type, const char *fmt, va_list ap)
Print formatted log message.
Definition: jas_debug.c:171
jas_types.h
Primitive Types.
jas_logprintf
JAS_EXPORT int jas_logprintf(const char *fmt,...)
Generate a generic log message.
Definition: jas_debug.c:107
jas_set_debug_level
JAS_EXPORT void jas_set_debug_level(int debug_level)
Set the debug level for a particular context.
Definition: jas_init.c:1002
jas_loginfof
JAS_EXPORT int jas_loginfof(const char *fmt,...)
Generate an informational log message.
Definition: jas_debug.c:143
JAS_UNUSED
#define JAS_UNUSED(x)
Indicate that a variable may be unused (in order to avoid a compiler warning).
Definition: jas_compiler.h:145
JAS_LOGTYPE_CLASS_ERROR
#define JAS_LOGTYPE_CLASS_ERROR
Definition: jas_log.h:96
jas_logtype_getclass
static int jas_logtype_getclass(jas_logtype_t type)
Get the class of a logtype.
Definition: jas_log.h:132
jas_logmemdump
int jas_logmemdump(const void *data, size_t len)
Dump memory.
Definition: jas_debug.c:245
jas_vlogmsgf_t
int() jas_vlogmsgf_t(jas_logtype_t, const char *, va_list)
Type used for formatted message logging function.
Definition: jas_log.h:117
jas_compiler.h
Compiler-related macros.
jas_logtype_t
Type used for the log type.
jas_getdbglevel
static JAS_DEPRECATED int jas_getdbglevel(void)
Get the library debug level.
Definition: jas_debug.h:123
jas_setdbglevel
JAS_EXPORT int jas_setdbglevel(int dbglevel)
Set the library debug level.
Definition: jas_debug.c:83
jas_deprecated
JAS_EXPORT void jas_deprecated(const char *fmt,...)
Warn about the use of deprecated functionality.
Definition: jas_debug.c:266
jas_vlogmsgf_discard
JAS_EXPORT int jas_vlogmsgf_discard(jas_logtype_t type, const char *fmt, va_list ap)
Output a log message to nowhere (i.e., discard the message).
Definition: jas_debug.c:218