libguile/debug.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_DEBUG_H
   4 #define SCM_DEBUG_H
   5
   6 /* Copyright (C) 1995,1996,1998,1999,2000,2001,2002,2004,2008
   7  * Free Software Foundation, Inc.
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2.1 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  22  */
  23
  24 \f
  25
  26 #include "libguile/__scm.h"
  27
  28 #include "libguile/options.h"
  29 \f
  30
  31 /*
  32  * Here comes some definitions for the debugging machinery.
  33  * It might seem strange to represent debug flags as ints,
  34  * but consider that any particular piece of code is normally
  35  * only interested in one flag at a time.  This is then
  36  * the most efficient representation.
  37  */
  38
  39 /* {Options}
  40  */
  41
  42 /* scm_debug_opts is  defined in eval.c.
  43  */
  44
  45
  46
  47 SCM_API int scm_debug_mode_p;
  48 SCM_API int scm_check_entry_p;
  49 SCM_API int scm_check_apply_p;
  50 SCM_API int scm_check_exit_p;
  51 SCM_API int scm_check_memoize_p;
  52
  53 #define SCM_RESET_DEBUG_MODE \
  54 do {\
  55   scm_check_entry_p = (SCM_ENTER_FRAME_P || SCM_BREAKPOINTS_P)\
  56     && scm_is_true (SCM_ENTER_FRAME_HDLR);\
  57   scm_check_apply_p = (SCM_APPLY_FRAME_P || SCM_TRACE_P)\
  58     && scm_is_true (SCM_APPLY_FRAME_HDLR);\
  59   scm_check_exit_p = (SCM_EXIT_FRAME_P || SCM_TRACE_P)\
  60     && scm_is_true (SCM_EXIT_FRAME_HDLR);\
  61   scm_check_memoize_p = (SCM_MEMOIZE_P)\
  62     && scm_is_true (SCM_MEMOIZE_HDLR);\
  63   scm_debug_mode_p = SCM_DEVAL_P\
  64     || scm_check_memoize_p || scm_check_entry_p || scm_check_apply_p || scm_check_exit_p;\
  65 } while (0)
  66
  67 /* {Evaluator}
  68  */
  69
  70 typedef union scm_t_debug_info
  71 {
  72   struct { SCM exp, env; } e;
  73   struct { SCM proc, args; } a;
  74   SCM id;
  75 } scm_t_debug_info;
  76
  77 SCM_API long scm_debug_eframe_size;
  78
  79 typedef struct scm_t_debug_frame
  80 {
  81   struct scm_t_debug_frame *prev;
  82   long status;
  83   scm_t_debug_info *vect;
  84   scm_t_debug_info *info;
  85 } scm_t_debug_frame;
  86
  87 #define SCM_EVALFRAME    (0L << 11)
  88 #define SCM_APPLYFRAME   (1L << 11)
  89 #define SCM_VOIDFRAME    (3L << 11)
  90 #define SCM_MACROEXPF    (1L << 10)
  91 #define SCM_TAILREC      (1L << 9)
  92 #define SCM_TRACED_FRAME (1L << 8)
  93 #define SCM_ARGS_READY   (1L << 7)
  94 #define SCM_DOVERFLOW    (1L << 6)
  95 #define SCM_MAX_FRAME_SIZE 63
  96
  97 #define SCM_FRAMETYPE    (3L << 11)
  98
  99 #define SCM_EVALFRAMEP(x) (((x).status & SCM_FRAMETYPE) == SCM_EVALFRAME)
 100 #define SCM_APPLYFRAMEP(x) (((x).status & SCM_FRAMETYPE) == SCM_APPLYFRAME)
 101 #define SCM_VOIDFRAMEP(x) (((x).status & SCM_FRAMETYPE) == SCM_VOIDFRAME)
 102 #define SCM_OVERFLOWP(x) (((x).status & SCM_DOVERFLOW) != 0)
 103 #define SCM_ARGS_READY_P(x) (((x).status & SCM_ARGS_READY) != 0)
 104 #define SCM_TRACED_FRAME_P(x) (((x).status & SCM_TRACED_FRAME) != 0)
 105 #define SCM_TAILRECP(x) (((x).status & SCM_TAILREC) != 0)
 106 #define SCM_MACROEXPP(x) (((x).status & SCM_MACROEXPF) != 0)
 107 #define SCM_SET_OVERFLOW(x) ((x).status |= SCM_DOVERFLOW)
 108 #define SCM_SET_ARGSREADY(x) ((x).status |= SCM_ARGS_READY)
 109 #define SCM_CLEAR_ARGSREADY(x) ((x).status &= ~SCM_ARGS_READY)
 110 #define SCM_SET_TRACED_FRAME(x) ((x).status |= SCM_TRACED_FRAME)
 111 #define SCM_CLEAR_TRACED_FRAME(x) ((x).status &= ~SCM_TRACED_FRAME)
 112 #define SCM_SET_TAILREC(x) ((x).status |= SCM_TAILREC)
 113 #define SCM_SET_MACROEXP(x) ((x).status |= SCM_MACROEXPF)
 114 #define SCM_CLEAR_MACROEXP(x) ((x).status &= ~SCM_MACROEXPF)
 115
 116 /* {Debug Objects}
 117  */
 118
 119 SCM_API scm_t_bits scm_tc16_debugobj;
 120
 121 #define SCM_DEBUGOBJP(x) \
 122   SCM_TYP16_PREDICATE (scm_tc16_debugobj, x)
 123 #define SCM_DEBUGOBJ_FRAME(x) \
 124   ((scm_t_debug_frame *) SCM_CELL_WORD_1 (x))
 125 #define SCM_SET_DEBUGOBJ_FRAME(x, f)  SCM_SET_CELL_WORD_1 (x, f)
 126
 127 /* {Memoized Source}
 128  */
 129
 130 SCM_API scm_t_bits scm_tc16_memoized;
 131
 132 #define SCM_MEMOIZEDP(x)        SCM_TYP16_PREDICATE (scm_tc16_memoized, x)
 133 #define SCM_MEMOIZED_EXP(x)     SCM_CAR (SCM_CELL_OBJECT_1 (x))
 134 #define SCM_MEMOIZED_ENV(x)     SCM_CDR (SCM_CELL_OBJECT_1 (x))
 135
 136 \f
 137
 138 SCM_API SCM scm_debug_object_p (SCM obj);
 139 SCM_API SCM scm_local_eval (SCM exp, SCM env);
 140 SCM_API SCM scm_reverse_lookup (SCM env, SCM data);
 141 SCM_API SCM scm_sys_start_stack (SCM info_id, SCM thunk);
 142 SCM_API SCM scm_procedure_environment (SCM proc);
 143 SCM_API SCM scm_procedure_source (SCM proc);
 144 SCM_API SCM scm_procedure_name (SCM proc);
 145 SCM_API SCM scm_memoized_environment (SCM m);
 146 SCM_API SCM scm_make_memoized (SCM exp, SCM env);
 147 SCM_API SCM scm_memoized_p (SCM obj);
 148 SCM_API SCM scm_with_traps (SCM thunk);
 149 SCM_API SCM scm_evaluator_traps (SCM setting);
 150 SCM_API SCM scm_debug_options (SCM setting);
 151 SCM_API SCM scm_make_debugobj (scm_t_debug_frame *debug);
 152
 153 SCM_INTERNAL SCM scm_i_unmemoize_expr (SCM memoized);
 154 SCM_INTERNAL void scm_init_debug (void);
 155
 156 #ifdef GUILE_DEBUG
 157 SCM_API SCM scm_memcons (SCM car, SCM cdr, SCM env);
 158 SCM_API SCM scm_mem_to_proc (SCM obj);
 159 SCM_API SCM scm_proc_to_mem (SCM obj);
 160 SCM_API SCM scm_debug_hang (SCM obj);
 161 #endif /*GUILE_DEBUG*/
 162
 163 #if SCM_ENABLE_DEPRECATED == 1
 164
 165 #define CHECK_ENTRY      scm_check_entry_p
 166 #define CHECK_APPLY      scm_check_apply_p
 167 #define CHECK_EXIT       scm_check_exit_p
 168
 169 /* Deprecated in guile 1.7.0 on 2004-03-29.  */
 170 #define SCM_DEBUGGINGP scm_debug_mode_p
 171 #define scm_debug_mode scm_debug_mode_p
 172
 173 #endif
 174
 175 #endif  /* SCM_DEBUG_H */
 176
 177 /*
 178   Local Variables:
 179   c-file-style: "gnu"
 180   End:
 181 */