3 * fg_debug.h -- Flight Gear debug utility functions
5 * Written by Paul Bleisch, started January 1998.
7 * Copyright (C) 1998 Paul Bleisch, pbleisch@acm.org
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License as
11 * published by the Free Software Foundation; either version 2 of the
12 * License, or (at your option) any later version.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 * (Log is kept at end of this file)
24 **************************************************************************/
26 #error "use logstream"
38 /* NB: To add a dbg_class, add it here, and add it to the structure in
43 FG_TERRAIN = 0x00000001,
44 FG_ASTRO = 0x00000002,
45 FG_FLIGHT = 0x00000004,
46 FG_INPUT = 0x00000008,
49 FG_COCKPIT = 0x00000040,
50 FG_GENERAL = 0x00000080,
52 FG_EVENT = 0x00000200,
53 FG_AIRCRAFT = 0x00000400,
54 FG_AUTOPILOT = 0x00000800,
55 FG_UNDEFD = 0x00001000, // For range checking
60 /* NB: To add a priority, add it here. */
62 FG_BULK, /* For frequent messages */
63 FG_DEBUG, /* Less frequent debug type messages */
64 FG_INFO, /* Informatory messages */
65 FG_WARN, /* Possible impending problem */
66 FG_ALERT, /* Very possible impending problem */
67 FG_EXIT, /* Problem (no core) */
68 FG_ABORT /* Abandon ship (core) */
72 /* Initialize the debuggin stuff. */
73 void fgInitDebug( void );
79 class fgDebugClass mask for this message.
80 prio fgDebugPriority of this message.
81 fmt printf like string format
85 number of items in fmt handled.
87 This function works like the standard C library function printf() with
88 the addition of message classes and priorities (see fgDebugClasses
89 and fgDebugPriorities). These additions allow us to classify messages
90 and disable sets of messages at runtime. Only messages with a prio
91 greater than or equal to fg_DebugPriority and in the current debug class
92 (fg_DebugClass) are printed.
94 int fgPrintf( fgDebugClass dbg_class, fgDebugPriority prio, char *fmt, ... );
100 dbg_class Bitmask representing classes to display.
101 prio Minimum priority of messages to display.
103 void fgSetDebugLevels( fgDebugClass dbg_class, fgDebugPriority prio );
105 /* fgSetDebugOutput()
108 file A FILE* to a stream to send messages to.
110 It is assumed the file stream is open and writable. The system
111 defaults to stderr. The current stream is flushed but not
114 void fgSetDebugOutput( FILE *out );
117 /* fgRegisterDebugCallback
120 callback A function that takes parameters as defined by the
121 fgDebugCallback type.
124 a pointer to the previously registered callback (if any)
126 Install a user defined debug log callback. This callback is called w
127 whenever fgPrintf is called. The parameters passed to the callback are
128 defined above by fgDebugCallback. outstr is the string that is to be
129 printed. If callback returns nonzero, it is assumed that the message
130 was handled fully by the callback and **fgPrintf need do no further
131 processing of the message.** Only one callback may be installed at a
135 //typedef int (*fgDebugCallback)(fgDebugClass, fgDebugPriority, char *outstr);
136 //fgDebugCallback fgRegisterDebugCallback( fgDebugCallback callback );
138 typedef int (*fgDebugCallback)( int DebugClass, int DebugPriority, char *outstr);
139 fgDebugCallback fgRegisterDebugCallback( fgDebugCallback callback );
142 // Leave these alone. Access intended for fg_debug and command line processing.
144 extern fgDebugClass fg_DebugClass;
145 extern fgDebugPriority fg_DebugPriority;
147 extern FILE * fg_DebugOutput;
155 #endif /* _FG_DEBUG_H */