3 * $Id: trace.h,v 1.7 2004/04/08 01:36:13 mdw Exp $
5 * Tracing functions for debugging
7 * (c) 1998 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of the mLib utilities library.
14 * mLib is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
19 * mLib is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
24 * You should have received a copy of the GNU Library General Public
25 * License along with mLib; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
37 /*----- Header files ------------------------------------------------------*/
41 /*----- Data structures ---------------------------------------------------*/
43 typedef struct trace_opt
{
49 /*----- Functions provided ------------------------------------------------*/
53 * Arguments: @unsigned l@ = trace level for output
54 * @const char *f@ = a @printf@-style format string
55 * @...@ = other arguments
59 * Use: Reports a message to the trace output.
62 extern void trace(unsigned /*l*/, const char */
*f*/
, ...);
64 /* --- @trace_block@ --- *
66 * Arguments: @unsigned l@ = trace level for output
67 * @const char *s@ = some header string to write
68 * @const void *b@ = pointer to a block of memory to dump
69 * @size_t sz@ = size of the block of memory
73 * Use: Dumps the contents of a block to the trace output.
76 extern void trace_block(unsigned /*l*/, const char */
*s*/
,
77 const void */
*b*/
, size_t /*sz*/);
79 /* --- @trace_on@ --- *
81 * Arguments: @FILE *fp@ = a file to trace on
82 * @unsigned l@ = trace level to set
86 * Use: Enables tracing to a file.
89 extern void trace_on(FILE */
*fp*/
, unsigned /*l*/);
91 /* --- @trace_custom@ --- *
93 * Arguments: @void (*func)(const char *buf, size_t sz, void *v)@ =
95 * @void *v@ = magic handle to give to function
99 * Use: Sets up a custom trace handler.
102 extern void trace_custom(void (*/
*func*/
)(const char */
*buf*/
,
103 size_t /*sz*/, void */
*v*/
),
106 /* --- @trace_level@ --- *
108 * Arguments: @unsigned l@ = trace level to set
112 * Use: Sets the tracing level.
115 extern void trace_level(unsigned /*l*/);
117 /* --- @tracing@ --- *
121 * Returns: Zero if not tracing, tracing level if tracing.
123 * Use: Informs the caller whether tracing is enabled.
126 extern unsigned tracing(void);
128 /* --- @traceopt@ --- *
130 * Arguments: @const trace_opt *t@ = pointer to trace options table
131 * @const char *p@ = option string supplied by user
132 * @unsigned f@ = initial tracing flags
133 * @unsigned bad@ = forbidden tracing flags
135 * Returns: Trace flags as set by user.
137 * Use: Parses an option string from the user and sets the
138 * appropriate trace flags. If the argument is null or a single
139 * `?' character, a help message is displayed.
142 extern unsigned traceopt(const trace_opt */
*t*/
, const char */
*p*/
,
143 unsigned /*f*/, unsigned /*bad*/);
145 /*----- Tracing macros ----------------------------------------------------*/
149 # define IF_TRACING(l, x) if ((l) & tracing()) x
152 # define IF_TRACING(l, x)
155 /*----- That's all, folks -------------------------------------------------*/