#error This file is not used in MySQL - see ../include/my_dbug.h instead
/******************************************************************************
 *               *
 *       N O T I C E          *
 *               *
 *        Copyright Abandoned, 1987, Fred Fish        *
 *               *
 *               *
 * This previously copyrighted work has been placed into the  public     *
 * domain by  the  author  and  may be freely used for any purpose,     *
 * private or commercial.            *
 *               *
 * Because of the number of inquiries I was receiving about the  use     *
 * of this product in commercially developed works I have decided to     *
 * simply make it public domain to further its unrestricted use. I     *
 * specifically  would  be  most happy to see this material become a     *
 * part of the standard Unix distributions by AT&T and the  Berkeley     *
 * Computer  Science  Research Group, and a standard part of the GNU     *
 * system from the Free Software Foundation.         *
 *               *
 * I would appreciate it, as a courtesy, if this notice is  left  in     *
 * all copies and derivative works.  Thank you.         *
 *               *
 * The author makes no warranty of any kind  with respect  to  this     *
 * product  and  explicitly disclaims any implied warranties of mer-     *
 * chantability or fitness for any particular purpose.        *
 *               *
 ******************************************************************************
 */

/*
 *  FILE
 *
 * dbug.h   user include file for programs using the dbug package
 *
 *  SYNOPSIS
 *
 * #include <local/dbug.h>
 *
 *  SCCS ID
 *
 * @(#)dbug.h 1.13 7/17/89
 *
 *  DESCRIPTION
 *
 * Programs which use the dbug package must include this file.
 * It contains the appropriate macros to call support routines
 * in the dbug runtime library.
 *
 * To disable compilation of the macro expansions define the
 * preprocessor symbol "DBUG_OFF".  This will result in null
 * macros expansions so that the resulting code will be smaller
 * and faster.  (The difference may be smaller than you think
 * so this step is recommended only when absolutely necessary).
 * In general, tradeoffs between space and efficiency are
 * decided in favor of efficiency since space is seldom a
 * problem on the new machines).
 *
 * All externally visible symbol names follow the pattern
 * "_db_xxx..xx_" to minimize the possibility of a dbug package
 * symbol colliding with a user defined symbol.
 *
 * The DBUG_<N> style macros are obsolete and should not be used
 * in new code.  Macros to map them to instances of DBUG_PRINT
 * are provided for compatibility with older code.  They may go
 * away completely in subsequent releases.
 *
 *  AUTHOR
 *
 * Fred Fish
 * (Currently employed by Motorola Computer Division, Tempe, Az.)
 * hao!noao!mcdsun!fnf
 * (602) 438-3614
 *
 */

/*
 * Internally used dbug variables which must be global.
 */

#ifndef DBUG_OFF
    extern int _db_on_;   /* TRUE if debug currently enabled */
    extern FILE *_db_fp_;  /* Current debug output stream */
    extern char *_db_process_;  /* Name of current process */
    extern int _db_keyword_ ();  /* Accept/reject keyword */
    extern void _db_push_ ();  /* Push state, set up new state */
    extern void _db_pop_ ();  /* Pop previous debug state */
    extern void _db_enter_ ();  /* New user function entered */
    extern void _db_return_ ();  /* User function return */
    extern void _db_pargs_ ();  /* Remember args for line */
    extern void _db_doprnt_ ();  /* Print debug output */
    extern void _db_setjmp_ ();  /* Save debugger environment */
    extern void _db_longjmp_ (); /* Restore debugger environment */
    extern void _db_dump_();  /* Dump memory */
# endif


/*
 *       These macros provide a user interface into functions in the
 *       dbug runtime support library.  They isolate users from changes
 *       in the MACROS and/or runtime support.
 *
 *       The symbols "__LINE__" and "__FILE__" are expanded by the
 *       preprocessor to the current source file line number and file
 *       name respectively.
 *
 *       WARNING ---  Because the DBUG_ENTER macro allocates space on
 *       the user function's stack, it must precede any executable
 *       statements in the user function.
 *
 */

# ifdef DBUG_OFF
#    define DBUG_ENTER(a1)
#    define DBUG_RETURN(a1) return(a1)
#    define DBUG_VOID_RETURN return
#    define DBUG_EXECUTE(keyword,a1)
#    define DBUG_PRINT(keyword,arglist)
#    define DBUG_PUSH(a1)
#    define DBUG_POP()
#    define DBUG_PROCESS(a1)
#    define DBUG_FILE (stderr)
#    define DBUG_DUMP(keyword,a1)
# else
#    define DBUG_ENTER(a) \
 auto char *_db_func_; auto char *_db_file_; auto int _db_level_; \
 auto char **_db_framep_; \
 _db_enter_ (a,__FILE__,__LINE__,&_db_func_,&_db_file_,&_db_level_, \
      &_db_framep_)
#    define DBUG_LEAVE \
       (_db_return_ (__LINE__, &_db_func_, &_db_file_, &_db_level_))
#    define DBUG_RETURN(a1) return (DBUG_LEAVE, (a1))
/*   define DBUG_RETURN(a1) {DBUG_LEAVE; return(a1);}  Alternate form */
#    define DBUG_VOID_RETURN {DBUG_LEAVE; return;}
#    define DBUG_EXECUTE(keyword,a1) \
       {if (_db_on_) {if (_db_keyword_ (keyword)) { a1 }}}
#    define DBUG_PRINT(keyword,arglist) \
       {if (_db_on_) {_db_pargs_(__LINE__,keyword); _db_doprnt_ arglist;}}
#    define DBUG_PUSH(a1) _db_push_ (a1)
#    define DBUG_POP() _db_pop_ ()
#    define DBUG_PROCESS(a1) (_db_process_ = a1)
#    define DBUG_FILE (_db_fp_)
#    define DBUG_DUMP(keyword,a1,a2) _db_dump_(__LINE__,keyword,a1,a2)
# endif