debug.h

Go to the documentation of this file.

/* Debugging macros and interface.
Copyright (C) 1999-2020 Free Software Foundation, Inc.
This file is part of GNU Make.

GNU Make is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation; either version 3 of the License, or (at your option) any later
version.

GNU Make is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program.  If not, see <http://www.gnu.org/licenses/>.  */

#ifndef DEBUG_H
#define DEBUG_H

#include "types.h"

typedef enum {
  DB_NONE           = 0x000, 
  DB_BASIC          = 0x001, 
  DB_VERBOSE        = 0x002, 
  DB_JOBS           = 0x004, 
  DB_IMPLICIT       = 0x008, 
  DB_TRACE          = 0x010, 
  DB_SHELL          = 0x020, 
  DB_MAKEFILES      = 0x100,
  DB_READ_MAKEFILES = 0x200, 
  DB_CALL           = 0x400, 
  DB_UPDATE_GOAL    = 0x800, 
  DB_ALL            = 0xfff  
} debug_level_mask_t;

typedef enum {
  DEBUGGER_ON_ERROR  = 0x1,   
  DEBUGGER_ON_FATAL  = 0x2,   
  DEBUGGER_ON_SIG    = 0x4    
} debug_enter_debugger_t;

typedef enum {
  DEBUGGER_QUIT_RC   = 77,    
} debug_dummy_t;

extern debug_level_mask_t debug_dummy_level_mask;
extern debug_enter_debugger_t debug_dummy_enter_debugger_mask;

extern int db_level;

extern int in_debugger;

#include <setjmp.h>
extern jmp_buf debugger_loop;

struct stringlist
{
  const char **list;    
  unsigned int idx;     
  unsigned int max;     
};

extern int debug_flag;

extern int no_extended_errors;

extern int show_variable_definitions;

extern bool b_debugger_goal;

extern bool b_debugger_preread;

extern unsigned int i_debugger_stepping;

extern unsigned int i_debugger_nexting;

extern unsigned int debugger_on_error;

extern unsigned int debugger_enabled;

extern stringlist_t *db_flags;

#define ISDB(_l)    ((_l)&db_level)

/* When adding macros to this list be sure to update the value of
   XGETTEXT_OPTIONS in the po/Makevars file.  */

#define DBPRINT(_x)           \
   printf _x; fflush (stdout)

#define DBPRINTS(_x, _depth) \
   print_spaces (_depth);    \
   DBPRINT(_x)

#define DBS(_l,_x)           \
  do {                       \
    if(ISDB(_l)) {           \
       DBPRINTS(_x, depth);  \
    }                        \
  } while(0)

#define DBSD(_l,_x,_depth)   \
  do {                       \
    if(ISDB(_l)) {           \
      DBPRINTS(_x, _depth);   \
    }                        \
  } while(0)

extern int db_level;

#define ISDB(_l)    ((_l)&db_level)

#define DBF(_l,_x)  do{ if(ISDB(_l)) {print_spaces (depth); \
                                      printf (_x, file->name); \
                                      fflush (stdout);} }while(0)

#define DB(_l,_x)   do{ if(ISDB(_l)) {printf _x; fflush (stdout);} }while(0)


#endif /*DEBUG_H*/