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
   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 SCM_API scm_t_option scm_debug_opts[];
  46
  47 #define SCM_BREAKPOINTS_P       scm_debug_opts[1].val
  48 #define SCM_TRACE_P             scm_debug_opts[2].val
  49 #define SCM_REC_PROCNAMES_P     scm_debug_opts[3].val
  50 #define SCM_BACKWARDS_P         scm_debug_opts[4].val
  51 #define SCM_BACKTRACE_WIDTH     scm_debug_opts[5].val
  52 #define SCM_BACKTRACE_INDENT    scm_debug_opts[6].val
  53 #define SCM_N_FRAMES            scm_debug_opts[7].val
  54 #define SCM_BACKTRACE_MAXDEPTH  scm_debug_opts[8].val
  55 #define SCM_BACKTRACE_DEPTH     scm_debug_opts[9].val
  56 #define SCM_BACKTRACE_P         scm_debug_opts[10].val
  57 #define SCM_DEVAL_P             scm_debug_opts[11].val
  58 #define SCM_STACK_LIMIT         scm_debug_opts[12].val
  59 #define SCM_SHOW_FILE_NAME      scm_debug_opts[13].val
  60 #define SCM_WARN_DEPRECATED     scm_debug_opts[14].val
  61 #define SCM_N_DEBUG_OPTIONS 15
  62
  63 SCM_API int scm_debug_mode_p;
  64 SCM_API int scm_check_entry_p;
  65 SCM_API int scm_check_apply_p;
  66 SCM_API int scm_check_exit_p;
  67
  68 #define SCM_RESET_DEBUG_MODE \
  69 do {\
  70   scm_check_entry_p = (SCM_ENTER_FRAME_P || SCM_BREAKPOINTS_P)\
  71     && scm_is_true (SCM_ENTER_FRAME_HDLR);\
  72   scm_check_apply_p = (SCM_APPLY_FRAME_P || SCM_TRACE_P)\
  73     && scm_is_true (SCM_APPLY_FRAME_HDLR);\
  74   scm_check_exit_p = (SCM_EXIT_FRAME_P || SCM_TRACE_P)\
  75     && scm_is_true (SCM_EXIT_FRAME_HDLR);\
  76   scm_debug_mode_p = SCM_DEVAL_P\
  77     || scm_check_entry_p || scm_check_apply_p || scm_check_exit_p;\
  78 } while (0)
  79
  80 /* {Evaluator}
  81  */
  82
  83 typedef union scm_t_debug_info
  84 {
  85   struct { SCM exp, env; } e;
  86   struct { SCM proc, args; } a;
  87   SCM id;
  88 } scm_t_debug_info;
  89
  90 SCM_API long scm_debug_eframe_size;
  91
  92 typedef struct scm_t_debug_frame
  93 {
  94   struct scm_t_debug_frame *prev;
  95   long status;
  96   scm_t_debug_info *vect;
  97   scm_t_debug_info *info;
  98 } scm_t_debug_frame;
  99
 100 #define SCM_EVALFRAME    (0L << 11)
 101 #define SCM_APPLYFRAME   (1L << 11)
 102 #define SCM_VOIDFRAME    (3L << 11)
 103 #define SCM_MACROEXPF    (1L << 10)
 104 #define SCM_TAILREC      (1L << 9)
 105 #define SCM_TRACED_FRAME (1L << 8)
 106 #define SCM_ARGS_READY   (1L << 7)
 107 #define SCM_DOVERFLOW    (1L << 6)
 108 #define SCM_MAX_FRAME_SIZE 63
 109
 110 #define SCM_FRAMETYPE    (3L << 11)
 111
 112 #define SCM_EVALFRAMEP(x) (((x).status & SCM_FRAMETYPE) == SCM_EVALFRAME)
 113 #define SCM_APPLYFRAMEP(x) (((x).status & SCM_FRAMETYPE) == SCM_APPLYFRAME)
 114 #define SCM_VOIDFRAMEP(x) (((x).status & SCM_FRAMETYPE) == SCM_VOIDFRAME)
 115 #define SCM_OVERFLOWP(x) (((x).status & SCM_DOVERFLOW) != 0)
 116 #define SCM_ARGS_READY_P(x) (((x).status & SCM_ARGS_READY) != 0)
 117 #define SCM_TRACED_FRAME_P(x) (((x).status & SCM_TRACED_FRAME) != 0)
 118 #define SCM_TAILRECP(x) (((x).status & SCM_TAILREC) != 0)
 119 #define SCM_MACROEXPP(x) (((x).status & SCM_MACROEXPF) != 0)
 120 #define SCM_SET_OVERFLOW(x) ((x).status |= SCM_DOVERFLOW)
 121 #define SCM_SET_ARGSREADY(x) ((x).status |= SCM_ARGS_READY)
 122 #define SCM_CLEAR_ARGSREADY(x) ((x).status &= ~SCM_ARGS_READY)
 123 #define SCM_SET_TRACED_FRAME(x) ((x).status |= SCM_TRACED_FRAME)
 124 #define SCM_CLEAR_TRACED_FRAME(x) ((x).status &= ~SCM_TRACED_FRAME)
 125 #define SCM_SET_TAILREC(x) ((x).status |= SCM_TAILREC)
 126 #define SCM_SET_MACROEXP(x) ((x).status |= SCM_MACROEXPF)
 127 #define SCM_CLEAR_MACROEXP(x) ((x).status &= ~SCM_MACROEXPF)
 128
 129 /* {Debug Objects}
 130  */
 131
 132 SCM_API scm_t_bits scm_tc16_debugobj;
 133
 134 #define SCM_DEBUGOBJP(x) \
 135   SCM_TYP16_PREDICATE (scm_tc16_debugobj, x)
 136 #define SCM_DEBUGOBJ_FRAME(x) \
 137   ((scm_t_debug_frame *) SCM_CELL_WORD_1 (x))
 138 #define SCM_SET_DEBUGOBJ_FRAME(x, f)  SCM_SET_CELL_WORD_1 (x, f)
 139
 140 /* {Memoized Source}
 141  */
 142
 143 SCM_API scm_t_bits scm_tc16_memoized;
 144
 145 #define SCM_MEMOIZEDP(x)        SCM_TYP16_PREDICATE (scm_tc16_memoized, x)
 146 #define SCM_MEMOIZED_EXP(x)     SCM_CAR (SCM_CELL_OBJECT_1 (x))
 147 #define SCM_MEMOIZED_ENV(x)     SCM_CDR (SCM_CELL_OBJECT_1 (x))
 148
 149 \f
 150
 151 SCM_API SCM scm_debug_object_p (SCM obj);
 152 SCM_API SCM scm_local_eval (SCM exp, SCM env);
 153 SCM_API SCM scm_reverse_lookup (SCM env, SCM data);
 154 SCM_API SCM scm_start_stack (SCM info_id, SCM exp, SCM env);
 155 SCM_API SCM scm_procedure_environment (SCM proc);
 156 SCM_API SCM scm_procedure_source (SCM proc);
 157 SCM_API SCM scm_procedure_name (SCM proc);
 158 SCM_API SCM scm_memoized_environment (SCM m);
 159 SCM_API SCM scm_make_memoized (SCM exp, SCM env);
 160 SCM_API SCM scm_memoized_p (SCM obj);
 161 SCM_API SCM scm_with_traps (SCM thunk);
 162 SCM_API SCM scm_evaluator_traps (SCM setting);
 163 SCM_API SCM scm_debug_options (SCM setting);
 164 SCM_API SCM scm_make_debugobj (scm_t_debug_frame *debug);
 165
 166 SCM_API SCM scm_i_unmemoize_expr (SCM memoized);
 167 SCM_API void scm_init_debug (void);
 168
 169 #ifdef GUILE_DEBUG
 170 SCM_API SCM scm_memcons (SCM car, SCM cdr, SCM env);
 171 SCM_API SCM scm_mem_to_proc (SCM obj);
 172 SCM_API SCM scm_proc_to_mem (SCM obj);
 173 SCM_API SCM scm_debug_hang (SCM obj);
 174 #endif /*GUILE_DEBUG*/
 175
 176 #if SCM_ENABLE_DEPRECATED == 1
 177
 178 #define CHECK_ENTRY      scm_check_entry_p
 179 #define CHECK_APPLY      scm_check_apply_p
 180 #define CHECK_EXIT       scm_check_exit_p
 181
 182 /* Deprecated in guile 1.7.0 on 2004-03-29.  */
 183 #define SCM_DEBUGGINGP scm_debug_mode_p
 184 #define scm_debug_mode scm_debug_mode_p
 185
 186 #endif
 187
 188 #endif  /* SCM_DEBUG_H */
 189
 190 /*
 191   Local Variables:
 192   c-file-style: "gnu"
 193   End:
 194 */