3 * $Id: trace.h,v 1.3 1999/05/06 19:51:35 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,
30 /*----- Revision history --------------------------------------------------*
33 * Revision 1.3 1999/05/06 19:51:35 mdw
34 * Reformatted the LGPL notice a little bit.
36 * Revision 1.2 1999/05/05 18:50:31 mdw
37 * Change licensing conditions to LGPL.
39 * Revision 1.1.1.1 1998/06/17 23:44:42 mdw
40 * Initial version of mLib
53 /*----- Functions provided ------------------------------------------------*/
57 * Arguments: @unsigned int l@ = trace level for output
58 * @const char *f@ = a @printf@-style format string
59 * @...@ = other arguments
63 * Use: Reports a message to the trace output.
66 extern void trace(unsigned int /*l*/, const char */
*f*/
, ...);
68 /* --- @trace_block@ --- *
70 * Arguments: @unsigned int l@ = trace level for output
71 * @const char *s@ = some header string to write
72 * @const void *b@ = pointer to a block of memory to dump
73 * @size_t sz@ = size of the block of memory
77 * Use: Dumps the contents of a block to the trace output.
80 extern void trace_block(unsigned int /*l*/, const char */
*s*/
,
81 const void */
*b*/
, size_t /*sz*/);
83 /* --- @trace_on@ --- *
85 * Arguments: @FILE *fp@ = a file to trace on
86 * @unsigned int l@ = trace level to set
90 * Use: Enables tracing to a file.
93 extern void trace_on(FILE */
*fp*/
, unsigned int /*l*/);
95 /* --- @trace_setLevel@ --- *
97 * Arguments: @unsigned int l@ = trace level to set
101 * Use: Sets the tracing level.
104 extern void trace_setLevel(unsigned int /*l*/);
106 /* --- @tracing@ --- *
110 * Returns: Zero if not tracing, tracing level if tracing.
112 * Use: Informs the caller whether tracing is enabled.
115 extern unsigned int tracing(void);
117 /*----- Tracing macros ----------------------------------------------------*/
121 # define IF_TRACING(l, x) if ((l) & tracing()) x
124 # define IF_TRACING(l, x)
127 /*----- That's all, folks -------------------------------------------------*/