libguile/debug.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_DEBUG_H
   4 #define SCM_DEBUG_H
   5 /* Copyright (C) 1995,1996,1998,1999,2000,2001 Free Software Foundation
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2, or (at your option)
  10  * any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this software; see the file COPYING.  If not, write to
  19  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  20  * Boston, MA 02111-1307 USA
  21  *
  22  * As a special exception, the Free Software Foundation gives permission
  23  * for additional uses of the text contained in its release of GUILE.
  24  *
  25  * The exception is that, if you link the GUILE library with other files
  26  * to produce an executable, this does not by itself cause the
  27  * resulting executable to be covered by the GNU General Public License.
  28  * Your use of that executable is in no way restricted on account of
  29  * linking the GUILE library code into it.
  30  *
  31  * This exception does not however invalidate any other reasons why
  32  * the executable file might be covered by the GNU General Public License.
  33  *
  34  * This exception applies only to the code released by the
  35  * Free Software Foundation under the name GUILE.  If you copy
  36  * code from other Free Software Foundation releases into a copy of
  37  * GUILE, as the General Public License permits, the exception does
  38  * not apply to the code that you add in this way.  To avoid misleading
  39  * anyone as to the status of such modified files, you must delete
  40  * this exception notice from them.
  41  *
  42  * If you write modifications of your own for GUILE, it is your choice
  43  * whether to permit this exception to apply to your modifications.
  44  * If you do not wish that, delete this exception notice.
  45  *
  46  * The author can be reached at djurfeldt@nada.kth.se
  47  * Mikael Djurfeldt, SANS/NADA KTH, 10044 STOCKHOLM, SWEDEN */
  48
  49 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
  50    gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
  51 \f
  52
  53 #include "libguile/__scm.h"
  54
  55 #include "libguile/options.h"
  56 \f
  57
  58 /*
  59  * Here comes some definitions for the debugging machinery.
  60  * It might seem strange to represent debug flags as ints,
  61  * but consider that any particular piece of code is normally
  62  * only interested in one flag at a time.  This is then
  63  * the most efficient representation.
  64  */
  65
  66 /* {Options}
  67  */
  68
  69 /* scm_debug_opts is  defined in eval.c.
  70  */
  71
  72 extern scm_t_option scm_debug_opts[];
  73
  74 #define SCM_CHEAPTRAPS_P        scm_debug_opts[0].val
  75 #define SCM_BREAKPOINTS_P       scm_debug_opts[1].val
  76 #define SCM_TRACE_P             scm_debug_opts[2].val
  77 #define SCM_REC_PROCNAMES_P     scm_debug_opts[3].val
  78 #define SCM_BACKWARDS_P         scm_debug_opts[4].val
  79 #define SCM_BACKTRACE_WIDTH     scm_debug_opts[5].val
  80 #define SCM_BACKTRACE_INDENT    scm_debug_opts[6].val
  81 #define SCM_N_FRAMES            scm_debug_opts[7].val
  82 #define SCM_BACKTRACE_MAXDEPTH  scm_debug_opts[8].val
  83 #define SCM_BACKTRACE_DEPTH     scm_debug_opts[9].val
  84 #define SCM_BACKTRACE_P         scm_debug_opts[10].val
  85 #define SCM_DEVAL_P             scm_debug_opts[11].val
  86 #define SCM_STACK_LIMIT         scm_debug_opts[12].val
  87 #define SCM_SHOW_FILE_NAME      scm_debug_opts[13].val
  88 #define SCM_N_DEBUG_OPTIONS 14
  89
  90 extern SCM (*scm_ceval_ptr) (SCM exp, SCM env);
  91
  92 extern int scm_debug_mode;
  93 extern int scm_check_entry_p, scm_check_apply_p, scm_check_exit_p;
  94
  95 #define CHECK_ENTRY      scm_check_entry_p
  96 #define CHECK_APPLY      scm_check_apply_p
  97 #define CHECK_EXIT       scm_check_exit_p
  98
  99 #define SCM_RESET_DEBUG_MODE \
 100 do {\
 101   CHECK_ENTRY = (SCM_ENTER_FRAME_P || SCM_BREAKPOINTS_P)\
 102     && SCM_NFALSEP (SCM_ENTER_FRAME_HDLR);\
 103   CHECK_APPLY = (SCM_APPLY_FRAME_P || SCM_TRACE_P)\
 104     && SCM_NFALSEP (SCM_APPLY_FRAME_HDLR);\
 105   CHECK_EXIT = (SCM_EXIT_FRAME_P || SCM_TRACE_P)\
 106     && SCM_NFALSEP (SCM_EXIT_FRAME_HDLR);\
 107   scm_debug_mode = SCM_DEVAL_P || CHECK_ENTRY || CHECK_APPLY || CHECK_EXIT;\
 108   scm_ceval_ptr = scm_debug_mode ? scm_deval : scm_ceval;\
 109 } while (0)
 110
 111 /* {Evaluator}
 112  */
 113
 114 typedef union scm_t_debug_info
 115 {
 116   struct { SCM exp, env; } e;
 117   struct { SCM proc, args; } a;
 118   SCM id;
 119 } scm_t_debug_info;
 120
 121 extern long scm_debug_eframe_size;
 122
 123 typedef struct scm_t_debug_frame
 124 {
 125   struct scm_t_debug_frame *prev;
 126   long status;
 127   scm_t_debug_info *vect;
 128   scm_t_debug_info *info;
 129 } scm_t_debug_frame;
 130
 131 #if (SCM_DEBUG_DEPRECATED == 0)
 132 # define scm_debug_info scm_t_debug_info
 133 # define scm_debug_frame scm_t_debug_frame
 134 #endif
 135
 136 #ifndef USE_THREADS
 137 extern scm_t_debug_frame *scm_last_debug_frame;
 138 #endif
 139
 140 #define SCM_EVALFRAME    (0L << 11)
 141 #define SCM_APPLYFRAME   (1L << 11)
 142 #define SCM_VOIDFRAME    (3L << 11)
 143 #define SCM_MACROEXPF    (1L << 10)
 144 #define SCM_TAILREC      (1L << 9)
 145 #define SCM_TRACED_FRAME (1L << 8)
 146 #define SCM_ARGS_READY   (1L << 7)
 147 #define SCM_DOVERFLOW    (1L << 6)
 148 #define SCM_MAX_FRAME_SIZE 63 /* also used as a mask for the size field */
 149
 150 #define SCM_FRAMETYPE    (3L << 11)
 151
 152 #define SCM_EVALFRAMEP(x) (((x).status & SCM_FRAMETYPE) == SCM_EVALFRAME)
 153 #define SCM_APPLYFRAMEP(x) (((x).status & SCM_FRAMETYPE) == SCM_APPLYFRAME)
 154 #define SCM_VOIDFRAMEP(x) (((x).status & SCM_FRAMETYPE) == SCM_VOIDFRAME)
 155 #define SCM_OVERFLOWP(x) (((x).status & SCM_DOVERFLOW) != 0)
 156 #define SCM_ARGS_READY_P(x) (((x).status & SCM_ARGS_READY) != 0)
 157 #define SCM_TRACED_FRAME_P(x) (((x).status & SCM_TRACED_FRAME) != 0)
 158 #define SCM_TAILRECP(x) (((x).status & SCM_TAILREC) != 0)
 159 #define SCM_MACROEXPP(x) (((x).status & SCM_MACROEXPF) != 0)
 160 #define SCM_SET_OVERFLOW(x) ((x).status |= SCM_DOVERFLOW)
 161 #define SCM_SET_ARGSREADY(x) ((x).status |= SCM_ARGS_READY)
 162 #define SCM_CLEAR_ARGSREADY(x) ((x).status &= ~SCM_ARGS_READY)
 163 #define SCM_SET_TRACED_FRAME(x) ((x).status |= SCM_TRACED_FRAME)
 164 #define SCM_CLEAR_TRACED_FRAME(x) ((x).status &= ~SCM_TRACED_FRAME)
 165 #define SCM_SET_TAILREC(x) ((x).status |= SCM_TAILREC)
 166 #define SCM_SET_MACROEXP(x) ((x).status |= SCM_MACROEXPF)
 167 #define SCM_CLEAR_MACROEXP(x) ((x).status &= ~SCM_MACROEXPF)
 168
 169 #define SCM_DEBUGGINGP scm_debug_mode
 170 #define SCM_DSIDEVAL(x, env) if NIMP(x) scm_deval((x), (env))
 171
 172 /* {Debug Objects}
 173  */
 174
 175 extern scm_t_bits scm_tc16_debugobj;
 176
 177 #define SCM_DEBUGOBJP(x) \
 178   SCM_TYP16_PREDICATE (scm_tc16_debugobj, x)
 179 #define SCM_DEBUGOBJ_FRAME(x) \
 180   ((scm_t_debug_frame *) SCM_CELL_WORD_1 (x))
 181 #define SCM_SET_DEBUGOBJ_FRAME(x, f)  SCM_SET_CELL_WORD_1 (x, f)
 182
 183 /* {Memoized Source}
 184  */
 185
 186 extern scm_t_bits scm_tc16_memoized;
 187
 188 #define SCM_MEMOIZEDP(x)        SCM_TYP16_PREDICATE (scm_tc16_memoized, x)
 189 #define SCM_MEMOIZED_EXP(x)     SCM_CAR (SCM_CELL_OBJECT_1 (x))
 190 #define SCM_MEMOIZED_ENV(x)     SCM_CDR (SCM_CELL_OBJECT_1 (x))
 191
 192 \f
 193
 194 extern int scm_ready_p (void);
 195 extern void debug_print (SCM obj);
 196 extern SCM scm_debug_object_p (SCM obj);
 197 extern SCM scm_local_eval (SCM exp, SCM env);
 198 extern SCM scm_reverse_lookup (SCM env, SCM data);
 199 extern SCM scm_start_stack (SCM id, SCM exp, SCM env);
 200 extern SCM scm_procedure_environment (SCM proc);
 201 extern SCM scm_procedure_source (SCM proc);
 202 extern SCM scm_procedure_name (SCM proc);
 203 extern SCM scm_memoized_environment (SCM m);
 204 extern SCM scm_make_memoized (SCM exp, SCM env);
 205 extern SCM scm_memoized_p (SCM obj);
 206 extern SCM scm_with_traps (SCM thunk);
 207 extern SCM scm_evaluator_traps (SCM setting);
 208 extern SCM scm_debug_options (SCM setting);
 209 extern SCM scm_unmemoize (SCM memoized);
 210 extern SCM scm_make_debugobj (scm_t_debug_frame *debug);
 211 extern void scm_init_debug (void);
 212
 213 #ifdef GUILE_DEBUG
 214 extern SCM scm_make_gloc (SCM var, SCM env);
 215 extern SCM scm_gloc_p (SCM obj);
 216 extern SCM scm_make_iloc (SCM frame, SCM binding, SCM cdrp);
 217 extern SCM scm_iloc_p (SCM obj);
 218 extern SCM scm_memcons (SCM car, SCM cdr, SCM env);
 219 extern SCM scm_mem_to_proc (SCM obj);
 220 extern SCM scm_proc_to_mem (SCM obj);
 221 extern SCM scm_debug_hang (SCM obj);
 222 #endif /*GUILE_DEBUG*/
 223
 224 #endif /* SCM_DEBUG_H */
 225
 226 /*
 227   Local Variables:
 228   c-file-style: "gnu"
 229   End:
 230 */