* validate.h
[bpt/guile.git] / libguile / debug.h
index a26e821..2ee0e77 100644 (file)
@@ -2,7 +2,7 @@
 
 #ifndef DEBUGH
 #define DEBUGH
-/*     Copyright (C) 1995,1996 Mikael Djurfeldt
+/*     Copyright (C) 1995,1996,1998, 1999, 2000 Free Software Foundation
  * 
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -16,7 +16,8 @@
  * 
  * You should have received a copy of the GNU General Public License
  * along with this software; see the file COPYING.  If not, write to
- * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+ * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
+ * Boston, MA 02111-1307 USA
  *
  * As a special exception, the Free Software Foundation gives permission
  * for additional uses of the text contained in its release of GUILE.
  * If you do not wish that, delete this exception notice.
  *
  * The author can be reached at djurfeldt@nada.kth.se
- * Mikael Djurfeldt, SANS/NADA KTH, 10044 STOCKHOLM, SWEDEN
- */
+ * Mikael Djurfeldt, SANS/NADA KTH, 10044 STOCKHOLM, SWEDEN */
+
+/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
+   gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
 \f
 
-#include "options.h"
-#include <libguile/__scm.h>
+#include "libguile/__scm.h"
 
+#include "libguile/options.h"
 \f
 
 /*
 /* {Options}
  */
 
-/* scm_debug_opts and scm_evaluator_trap_table are defined in eval.c.
+/* scm_debug_opts is  defined in eval.c.
  */
 
-extern scm_option scm_debug_opts[];
+extern scm_option_t scm_debug_opts[];
 
 #define SCM_CHEAPTRAPS_P       scm_debug_opts[0].val
 #define SCM_BREAKPOINTS_P      scm_debug_opts[1].val
 #define SCM_TRACE_P            scm_debug_opts[2].val
 #define SCM_REC_PROCNAMES_P    scm_debug_opts[3].val
 #define SCM_BACKWARDS_P                scm_debug_opts[4].val
-#define SCM_N_FRAMES           scm_debug_opts[5].val
-#define SCM_BACKTRACE_DEPTH    scm_debug_opts[6].val
-#define SCM_BACKTRACE_P                scm_debug_opts[7].val
-#define SCM_DEVAL_P            scm_debug_opts[8].val
-#define SCM_STACK_LIMIT                scm_debug_opts[9].val
-#define SCM_N_DEBUG_OPTIONS 10
-
-extern scm_option scm_evaluator_trap_table[];
+#define SCM_BACKTRACE_WIDTH    scm_debug_opts[5].val
+#define SCM_BACKTRACE_INDENT           scm_debug_opts[6].val
+#define SCM_N_FRAMES           scm_debug_opts[7].val
+#define SCM_BACKTRACE_MAXDEPTH scm_debug_opts[8].val
+#define SCM_BACKTRACE_DEPTH    scm_debug_opts[9].val
+#define SCM_BACKTRACE_P                scm_debug_opts[10].val
+#define SCM_DEVAL_P            scm_debug_opts[11].val
+#define SCM_STACK_LIMIT                scm_debug_opts[12].val
+#define SCM_N_DEBUG_OPTIONS 13
 
-#define SCM_ENTER_FRAME_P      scm_evaluator_trap_table[0].val
-#define SCM_APPLY_FRAME_P      scm_evaluator_trap_table[1].val
-#define SCM_EXIT_FRAME_P       scm_evaluator_trap_table[2].val
-#define SCM_N_EVALUATOR_TRAPS 3
-
-#ifdef __STDC__
 extern SCM (*scm_ceval_ptr) (SCM exp, SCM env);
-#else
-extern SCM (*scm_ceval_ptr) ();
-#endif
+
 extern int scm_debug_mode;
 extern int scm_check_entry_p, scm_check_apply_p, scm_check_exit_p;
 
@@ -100,77 +96,134 @@ extern int scm_check_entry_p, scm_check_apply_p, scm_check_exit_p;
 #define CHECK_EXIT       scm_check_exit_p
 
 #define SCM_RESET_DEBUG_MODE \
-{\
-  if (SCM_ENTER_FRAME_P || SCM_BREAKPOINTS_P) CHECK_ENTRY = 1;\
-  if (SCM_APPLY_FRAME_P || SCM_TRACE_P) CHECK_APPLY = 1;\
-  if (SCM_EXIT_FRAME_P || SCM_TRACE_P) CHECK_EXIT = 1;\
-  scm_debug_mode = SCM_DEVAL_P || SCM_BACKTRACE_P || CHECK_ENTRY || CHECK_APPLY || CHECK_EXIT;\
+do {\
+  CHECK_ENTRY = SCM_ENTER_FRAME_P || SCM_BREAKPOINTS_P;\
+  CHECK_APPLY = SCM_APPLY_FRAME_P || SCM_TRACE_P;\
+  CHECK_EXIT = SCM_EXIT_FRAME_P || SCM_TRACE_P;\
+  scm_debug_mode = SCM_DEVAL_P || CHECK_ENTRY || CHECK_APPLY || CHECK_EXIT;\
   scm_ceval_ptr = scm_debug_mode ? scm_deval : scm_ceval;\
-}
+} while (0)
 
 
 /* {Evaluator}
  */
 
-typedef union scm_debug_info
+typedef union scm_debug_info_t
 {
   struct { SCM exp, env; } e;
   struct { SCM proc, args; } a;
-} scm_debug_info;
+  SCM id;
+} scm_debug_info_t;
 
-extern int scm_debug_eframe_size;
+extern scm_bits_t scm_debug_eframe_size;
 
-typedef struct scm_debug_frame
+typedef struct scm_debug_frame_t
 {
-  struct scm_debug_frame *prev;
+  struct scm_debug_frame_t *prev;
   long status;
-  scm_debug_info vect[1];
-} scm_debug_frame;
+  scm_debug_info_t *vect;
+  scm_debug_info_t *info;
+} scm_debug_frame_t;
+
+#if (SCM_DEBUG_DEPRECATED == 0)
+# define scm_debug_info scm_debug_info_t
+# define scm_debug_frame scm_debug_frame_t
+#endif
 
-extern scm_debug_frame *last_debug_info_frame;
+#ifndef USE_THREADS
+extern scm_debug_frame_t *scm_last_debug_frame;
+#endif
 
-#define SCM_TAILREC     (1L << 10)
-#define SCM_TRACED_FRAME (1L << 9)
-#define SCM_APPLYFRAME  (1L << 8)
+#define SCM_EVALFRAME    (0L << 11)
+#define SCM_APPLYFRAME   (1L << 11)
+#define SCM_VOIDFRAME    (3L << 11)
+#define SCM_MACROEXPF    (1L << 10)
+#define SCM_TAILREC      (1L << 9)
+#define SCM_TRACED_FRAME (1L << 8)
 #define SCM_ARGS_READY   (1L << 7)
-#define SCM_DOVERFLOW   (1L << 6)
+#define SCM_DOVERFLOW    (1L << 6)
 #define SCM_MAX_FRAME_SIZE 63 /* also used as a mask for the size field */
 
-#define SCM_EVALFRAMEP(x) (((x).status & SCM_APPLYFRAME) == 0)
-#define SCM_APPLYFRAMEP(x) (((x).status & SCM_APPLYFRAME) != 0)
+#define SCM_FRAMETYPE    (3L << 11)
+
+#define SCM_EVALFRAMEP(x) (((x).status & SCM_FRAMETYPE) == SCM_EVALFRAME)
+#define SCM_APPLYFRAMEP(x) (((x).status & SCM_FRAMETYPE) == SCM_APPLYFRAME)
+#define SCM_VOIDFRAMEP(x) (((x).status & SCM_FRAMETYPE) == SCM_VOIDFRAME)
 #define SCM_OVERFLOWP(x) (((x).status & SCM_DOVERFLOW) != 0)
 #define SCM_ARGS_READY_P(x) (((x).status & SCM_ARGS_READY) != 0)
 #define SCM_TRACED_FRAME_P(x) (((x).status & SCM_TRACED_FRAME) != 0)
 #define SCM_TAILRECP(x) (((x).status & SCM_TAILREC) != 0)
+#define SCM_MACROEXPP(x) (((x).status & SCM_MACROEXPF) != 0)
 #define SCM_SET_OVERFLOW(x) ((x).status |= SCM_DOVERFLOW)
 #define SCM_SET_ARGSREADY(x) ((x).status |= SCM_ARGS_READY)
 #define SCM_CLEAR_ARGSREADY(x) ((x).status &= ~SCM_ARGS_READY)
 #define SCM_SET_TRACED_FRAME(x) ((x).status |= SCM_TRACED_FRAME)
 #define SCM_CLEAR_TRACED_FRAME(x) ((x).status &= ~SCM_TRACED_FRAME)
 #define SCM_SET_TAILREC(x) ((x).status |= SCM_TAILREC)
+#define SCM_SET_MACROEXP(x) ((x).status |= SCM_MACROEXPF)
+#define SCM_CLEAR_MACROEXP(x) ((x).status &= ~SCM_MACROEXPF)
 
 #define SCM_DEBUGGINGP scm_debug_mode
 #define SCM_DSIDEVAL(x, env) if NIMP(x) scm_deval((x), (env))
 
+/* {Debug Objects}
+ */
+
+extern scm_bits_t scm_tc16_debugobj;
+
+#define SCM_DEBUGOBJP(x)              SCM_TYP16_PREDICATE (scm_tc16_debugobj, x)
+#define SCM_DEBUGOBJ_FRAME(x)         SCM_CELL_WORD_1 (x)
+#define SCM_SET_DEBUGOBJ_FRAME(x, f)  SCM_SET_CELL_WORD_1 (x, f)
+
 /* {Memoized Source}
  */
 
-extern long scm_tc16_memoized;
+extern scm_bits_t scm_tc16_memoized;
 
-#define SCM_MEMOIZEDP(x) (scm_tc16_memoized == SCM_TYP16 (x))
-#define SCM_MEMOEXP(x) SCM_CAR (SCM_CDR (x))
-#define SCM_MEMOENV(x) SCM_CDR (SCM_CDR (x))
+#define SCM_MEMOIZEDP(x)       SCM_TYP16_PREDICATE (scm_tc16_memoized, x)
+#define SCM_MEMOIZED_EXP(x)    SCM_CAR (SCM_CELL_OBJECT_1 (x))
+#define SCM_MEMOIZED_ENV(x)    SCM_CDR (SCM_CELL_OBJECT_1 (x))
 
 \f
 
-#ifdef __STDC__
+extern SCM * scm_lookup_cstr (char *str, int len, SCM env);
+extern SCM * scm_lookup_soft (SCM var, SCM genv);
+extern SCM scm_evstr (char *str);
+extern SCM scm_eval_string (SCM str);
+extern int scm_ready_p (void);
+extern void debug_print (SCM obj);
+extern SCM scm_debug_object_p (SCM obj);
+extern SCM scm_local_eval (SCM exp, SCM env);
+extern SCM scm_reverse_lookup (SCM env, SCM data);
+extern SCM scm_start_stack (SCM id, SCM exp, SCM env);
+extern SCM scm_procedure_environment (SCM proc);
+extern SCM scm_procedure_source (SCM proc);
+extern SCM scm_procedure_name (SCM proc);
+extern SCM scm_memoized_environment (SCM m);
+extern SCM scm_make_memoized (SCM exp, SCM env);
+extern SCM scm_memoized_p (SCM obj);
+extern SCM scm_with_traps (SCM thunk);
+extern SCM scm_evaluator_traps (SCM setting);
+extern SCM scm_debug_options (SCM setting);
 extern SCM scm_unmemoize (SCM memoized);
-extern SCM scm_make_debugobj (scm_debug_framedebug);
+extern SCM scm_make_debugobj (scm_debug_frame_t *debug);
 extern void scm_init_debug (void);
-#else
-extern SCM scm_unmemoize ();
-extern SCM scm_make_debugobj ();
-extern void scm_init_debug ();
-#endif
+
+#ifdef GUILE_DEBUG
+extern SCM scm_make_gloc (SCM var, SCM env);
+extern SCM scm_gloc_p (SCM obj);
+extern SCM scm_make_iloc (SCM frame, SCM binding, SCM cdrp);
+extern SCM scm_iloc_p (SCM obj);
+extern SCM scm_memcons (SCM car, SCM cdr, SCM env);
+extern SCM scm_mem_to_proc (SCM obj);
+extern SCM scm_proc_to_mem (SCM obj);
+extern SCM scm_debug_hang (SCM obj);
+#endif /*GUILE_DEBUG*/
 
 #endif /* DEBUGH */
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/