Main/fg_debug.h

   1 /**************************************************************************
   2  * fg_debug.h -- Flight Gear debug utility functions
   3  *
   4  * Written by Paul Bleisch, started January 1998.
   5  *
   6  * Copyright (C) 1998 Paul Bleisch, pbleisch@acm.org
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License as
  10  * published by the Free Software Foundation; either version 2 of the
  11  * License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21  *
  22  * (Log is kept at end of this file)
  23  **************************************************************************/
  24
  25
  26 #ifndef _FG_DEBUG_H
  27 #define _FG_DEBUG_H
  28
  29 #include <stdio.h>
  30
  31 /* NB:  To add a dbg_class, add it here, and add it to the structure
  32    in fg_debug.c
  33 */
  34 typedef enum {
  35   FG_NONE    = 0x00000000,
  36
  37   FG_TERRAIN = 0x00000001,
  38   FG_ASTRO   = 0x00000002,
  39   FG_FLIGHT  = 0x00000004,
  40   FG_INPUT   = 0x00000008,
  41   FG_GL      = 0x00000010,
  42   FG_VIEW    = 0x00000020,
  43   FG_COCKPIT = 0x00000040,
  44   FG_GENERAL = 0x00000080,
  45   FG_MATH    = 0x00000100,
  46   FG_EVENT   = 0x00000200,
  47   FG_AIRCRAFT= 0x00000400,
  48
  49   FG_ALL     = 0xFFFFFFFF
  50 } fgDebugClass;
  51
  52 /* NB:  To add a priority, add it here.
  53 */
  54 typedef enum {
  55   FG_BULK,      /* For frequent messages */
  56   FG_DEBUG,     /* Less frequent debug type messages */
  57   FG_INFO,      /* Informatory messages */
  58   FG_WARN,      /* Possible impending problem */
  59   FG_ALERT,     /* Very possible impending problem */
  60   FG_EXIT,      /* Problem (no core) */
  61   FG_ABORT      /* Abandon ship (core) */
  62 } fgDebugPriority;
  63
  64 /* Initialize the debuggin stuff. */
  65 void fgInitDebug( void );
  66
  67 /* fgPrintf
  68
  69    Expects:
  70    class      fgDebugClass mask for this message.
  71    prio       fgDebugPriority of this message.
  72    fmt        printf like string format
  73    ...        var args for fmt
  74
  75    Returns:
  76    number of items in fmt handled.
  77
  78    This function works like the standard C library function printf() with
  79    the addition of message classes and priorities (see fgDebugClasses
  80    and fgDebugPriorities).  These additions allow us to classify messages
  81    and disable sets of messages at runtime.  Only messages with a prio
  82    greater than or equal to fg_DebugPriority and in the current debug class
  83    (fg_DebugClass) are printed.
  84 */
  85 int fgPrintf( fgDebugClass dbg_class, fgDebugPriority prio, char *fmt, ... );
  86
  87
  88 /* fgSetDebugLevels()
  89
  90    Expects:
  91    dbg_class      Bitmask representing classes to display.
  92    prio       Minimum priority of messages to display.
  93 */
  94 void fgSetDebugLevels( fgDebugClass dbg_class, fgDebugPriority prio );
  95
  96 /* fgSetDebugOutput()
  97
  98    Expects:
  99    file       A FILE* to a stream to send messages to.
 100
 101    It is assumed the file stream is open and writable.  The system
 102    defaults to stderr.  The current stream is flushed but not
 103    closed.
 104 */
 105 void fgSetDebugOutput( FILE *out );
 106
 107
 108 /* fgRegisterDebugCallback
 109
 110    Expects:
 111    callback   A function that takes parameters as defined by the
 112               fgDebugCallback type.
 113
 114    Returns:
 115    a pointer to the previously registered callback (if any)
 116
 117    Install a user defined debug log callback.   This callback is called w
 118    whenever fgPrintf is called.  The parameters passed to the callback are
 119    defined above by fgDebugCallback.  outstr is the string that is to be
 120    printed.  If callback returns nonzero, it is assumed that the message
 121    was handled fully by the callback and **fgPrintf need do no further
 122    processing of the message.**  Only one callback may be installed at a
 123    time.
 124 */
 125 typedef int (*fgDebugCallback)(fgDebugClass, fgDebugPriority, char *outstr);
 126 fgDebugCallback fgRegisterDebugCallback( fgDebugCallback callback );
 127
 128
 129 #endif /* _FG_DEBUG_H */
 130