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
  48   FG_ALL     = 0xFFFFFFFF
  49 } fgDebugClass;
  50
  51 /* NB:  To add a priority, add it here.
  52 */
  53 typedef enum {
  54   FG_BULK,      /* For frequent messages */
  55   FG_DEBUG,     /* Less frequent debug type messages */
  56   FG_INFO,      /* Informatory messages */
  57   FG_WARN,      /* Possible impending problem */
  58   FG_ALERT,     /* Very possible impending problem */
  59   FG_EXIT,      /* Problem (no core) */
  60   FG_ABORT      /* Abandon ship (core) */
  61 } fgDebugPriority;
  62
  63 /* Initialize the debuggin stuff. */
  64 void fgInitDebug( void );
  65
  66 /* fgPrintf
  67
  68    Expects:
  69    class      fgDebugClass mask for this message.
  70    prio       fgDebugPriority of this message.
  71    fmt        printf like string format
  72    ...        var args for fmt
  73
  74    Returns:
  75    number of items in fmt handled.
  76
  77    This function works like the standard C library function printf() with
  78    the addition of message classes and priorities (see fgDebugClasses
  79    and fgDebugPriorities).  These additions allow us to classify messages
  80    and disable sets of messages at runtime.  Only messages with a prio
  81    greater than or equal to fg_DebugPriority and in the current debug class
  82    (fg_DebugClass) are printed.
  83 */
  84 int fgPrintf( fgDebugClass dbg_class, fgDebugPriority prio, char *fmt, ... );
  85
  86
  87 /* fgSetDebugLevels()
  88
  89    Expects:
  90    dbg_class      Bitmask representing classes to display.
  91    prio       Minimum priority of messages to display.
  92 */
  93 void fgSetDebugLevels( fgDebugClass dbg_class, fgDebugPriority prio );
  94
  95 /* fgSetDebugOutput()
  96
  97    Expects:
  98    file       A FILE* to a stream to send messages to.
  99
 100    It is assumed the file stream is open and writable.  The system
 101    defaults to stderr.  The current stream is flushed but not
 102    closed.
 103 */
 104 void fgSetDebugOutput( FILE *out );
 105
 106
 107 /* fgRegisterDebugCallback
 108
 109    Expects:
 110    callback   A function that takes parameters as defined by the
 111               fgDebugCallback type.
 112
 113    Returns:
 114    a pointer to the previously registered callback (if any)
 115
 116    Install a user defined debug log callback.   This callback is called w
 117    whenever fgPrintf is called.  The parameters passed to the callback are
 118    defined above by fgDebugCallback.  outstr is the string that is to be
 119    printed.  If callback returns nonzero, it is assumed that the message
 120    was handled fully by the callback and **fgPrintf need do no further
 121    processing of the message.**  Only one callback may be installed at a
 122    time.
 123 */
 124 typedef int (*fgDebugCallback)(fgDebugClass, fgDebugPriority, char *outstr);
 125 fgDebugCallback fgRegisterDebugCallback( fgDebugCallback callback );
 126
 127
 128 #endif /* _FG_DEBUG_H */
 129