[bpt/guile.git] / libguile / debug.h

/* classes: h_files */

#ifndef SCM_DEBUG_H
#define SCM_DEBUG_H

/* Copyright (C) 1995,1996,1998,1999,2000,2001,2002,2004
 * Free Software Foundation, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

\f

#include "libguile/__scm.h"

#include "libguile/options.h"
\f

/*
 * Here comes some definitions for the debugging machinery.
 * It might seem strange to represent debug flags as ints,
 * but consider that any particular piece of code is normally
 * only interested in one flag at a time.  This is then
 * the most efficient representation.
 */

/* {Options}
 */

/* scm_debug_opts is  defined in eval.c.
 */

SCM_API scm_t_option 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_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_SHOW_FILE_NAME	scm_debug_opts[13].val
#define SCM_N_DEBUG_OPTIONS 14

SCM_API int scm_debug_mode_p;
SCM_API int scm_check_entry_p;
SCM_API int scm_check_apply_p;
SCM_API int scm_check_exit_p;

#define SCM_RESET_DEBUG_MODE \
do {\
  scm_check_entry_p = (SCM_ENTER_FRAME_P || SCM_BREAKPOINTS_P)\
    && scm_is_true (SCM_ENTER_FRAME_HDLR);\
  scm_check_apply_p = (SCM_APPLY_FRAME_P || SCM_TRACE_P)\
    && scm_is_true (SCM_APPLY_FRAME_HDLR);\
  scm_check_exit_p = (SCM_EXIT_FRAME_P || SCM_TRACE_P)\
    && scm_is_true (SCM_EXIT_FRAME_HDLR);\
  scm_debug_mode_p = SCM_DEVAL_P\
    || scm_check_entry_p || scm_check_apply_p || scm_check_exit_p;\
} while (0)

/* {Evaluator}
 */

typedef union scm_t_debug_info
{
  struct { SCM exp, env; } e;
  struct { SCM proc, args; } a;
  SCM id;
} scm_t_debug_info;

SCM_API long scm_debug_eframe_size;

typedef struct scm_t_debug_frame
{
  struct scm_t_debug_frame *prev;
  long status;
  scm_t_debug_info *vect;
  scm_t_debug_info *info;
} scm_t_debug_frame;

#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_MAX_FRAME_SIZE 63

#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)

/* {Debug Objects}
 */

SCM_API scm_t_bits scm_tc16_debugobj;

#define SCM_DEBUGOBJP(x) \
  SCM_TYP16_PREDICATE (scm_tc16_debugobj, x)
#define SCM_DEBUGOBJ_FRAME(x) \
  ((scm_t_debug_frame *) SCM_CELL_WORD_1 (x))
#define SCM_SET_DEBUGOBJ_FRAME(x, f)  SCM_SET_CELL_WORD_1 (x, f)

/* {Memoized Source}
 */

SCM_API scm_t_bits scm_tc16_memoized;

#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

SCM_API SCM scm_debug_object_p (SCM obj);
SCM_API SCM scm_local_eval (SCM exp, SCM env);
SCM_API SCM scm_reverse_lookup (SCM env, SCM data);
SCM_API SCM scm_start_stack (SCM info_id, SCM exp, SCM env);
SCM_API SCM scm_procedure_environment (SCM proc);
SCM_API SCM scm_procedure_source (SCM proc);
SCM_API SCM scm_procedure_name (SCM proc);
SCM_API SCM scm_memoized_environment (SCM m);
SCM_API SCM scm_make_memoized (SCM exp, SCM env);
SCM_API SCM scm_memoized_p (SCM obj);
SCM_API SCM scm_with_traps (SCM thunk);
SCM_API SCM scm_evaluator_traps (SCM setting);
SCM_API SCM scm_debug_options (SCM setting);
SCM_API SCM scm_make_debugobj (scm_t_debug_frame *debug);

SCM_API SCM scm_i_unmemoize_expr (SCM memoized);
SCM_API void scm_init_debug (void);

#ifdef GUILE_DEBUG
SCM_API SCM scm_memcons (SCM car, SCM cdr, SCM env);
SCM_API SCM scm_mem_to_proc (SCM obj);
SCM_API SCM scm_proc_to_mem (SCM obj);
SCM_API SCM scm_debug_hang (SCM obj);
#endif /*GUILE_DEBUG*/

#if SCM_ENABLE_DEPRECATED == 1

#define CHECK_ENTRY      scm_check_entry_p
#define CHECK_APPLY	 scm_check_apply_p
#define CHECK_EXIT       scm_check_exit_p

/* Deprecated in guile 1.7.0 on 2004-03-29.  */
#define SCM_DEBUGGINGP scm_debug_mode_p
#define scm_debug_mode scm_debug_mode_p

#endif

#endif  /* SCM_DEBUG_H */

/*
  Local Variables:
  c-file-style: "gnu"
  End:
*/
Commit	Line	Data
c7ecd529 MD	1	/* classes: h_files */
c7ecd529 MD	2
13dcb666 DH	3	#ifndef SCM_DEBUG_H
13dcb666 DH	4	#define SCM_DEBUG_H
b29058ff	5
434f2f7a DH	6	/* Copyright (C) 1995,1996,1998,1999,2000,2001,2002,2004
434f2f7a DH	7	* Free Software Foundation, Inc.
b29058ff	8	*
73be1d9e MV	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.
b29058ff	13	*
73be1d9e	14	* This library is distributed in the hope that it will be useful,
c7ecd529	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
73be1d9e MV	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
73be1d9e MV	17	* Lesser General Public License for more details.
b29058ff	18	*
73be1d9e MV	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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	22	*/
d3a6bc94	23
c7ecd529 MD	24	\f
c7ecd529 MD	25
b4309c3c	26	#include "libguile/__scm.h"
c7ecd529	27
e771f866	28	#include "libguile/options.h"
c7ecd529 MD	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
33b97402	42	/* scm_debug_opts is defined in eval.c.
5e8d7fd4 MD	43	*/
5e8d7fd4 MD	44
33b001fd	45	SCM_API scm_t_option scm_debug_opts[];
c7ecd529	46
5e8d7fd4 MD	47	#define SCM_CHEAPTRAPS_P scm_debug_opts[0].val
	48	#define SCM_BREAKPOINTS_P scm_debug_opts[1].val
	49	#define SCM_TRACE_P scm_debug_opts[2].val
	50	#define SCM_REC_PROCNAMES_P scm_debug_opts[3].val
	51	#define SCM_BACKWARDS_P scm_debug_opts[4].val
274dc5fd MD	52	#define SCM_BACKTRACE_WIDTH scm_debug_opts[5].val
	53	#define SCM_BACKTRACE_INDENT scm_debug_opts[6].val
	54	#define SCM_N_FRAMES scm_debug_opts[7].val
	55	#define SCM_BACKTRACE_MAXDEPTH scm_debug_opts[8].val
	56	#define SCM_BACKTRACE_DEPTH scm_debug_opts[9].val
	57	#define SCM_BACKTRACE_P scm_debug_opts[10].val
	58	#define SCM_DEVAL_P scm_debug_opts[11].val
	59	#define SCM_STACK_LIMIT scm_debug_opts[12].val
29067b9d MV	60	#define SCM_SHOW_FILE_NAME scm_debug_opts[13].val
29067b9d MV	61	#define SCM_N_DEBUG_OPTIONS 14
c7ecd529	62
434f2f7a	63	SCM_API int scm_debug_mode_p;
33b001fd MV	64	SCM_API int scm_check_entry_p;
	65	SCM_API int scm_check_apply_p;
	66	SCM_API int scm_check_exit_p;
c7ecd529	67
5e8d7fd4	68	#define SCM_RESET_DEBUG_MODE \
d3a6bc94	69	do {\
5132eef0	70	scm_check_entry_p = (SCM_ENTER_FRAME_P \|\| SCM_BREAKPOINTS_P)\
7888309b	71	&& scm_is_true (SCM_ENTER_FRAME_HDLR);\
5132eef0	72	scm_check_apply_p = (SCM_APPLY_FRAME_P \|\| SCM_TRACE_P)\
7888309b	73	&& scm_is_true (SCM_APPLY_FRAME_HDLR);\
5132eef0	74	scm_check_exit_p = (SCM_EXIT_FRAME_P \|\| SCM_TRACE_P)\
7888309b	75	&& scm_is_true (SCM_EXIT_FRAME_HDLR);\
434f2f7a	76	scm_debug_mode_p = SCM_DEVAL_P\
5132eef0	77	\|\| scm_check_entry_p \|\| scm_check_apply_p \|\| scm_check_exit_p;\
d3a6bc94	78	} while (0)
c7ecd529	79
c7ecd529 MD	80	/* {Evaluator}
	81	*/
	82
92c2555f	83	typedef union scm_t_debug_info
c7ecd529 MD	84	{
	85	struct { SCM exp, env; } e;
	86	struct { SCM proc, args; } a;
473c250d	87	SCM id;
92c2555f	88	} scm_t_debug_info;
c7ecd529	89
33b001fd	90	SCM_API long scm_debug_eframe_size;
c7ecd529	91
92c2555f	92	typedef struct scm_t_debug_frame
c7ecd529	93	{
92c2555f	94	struct scm_t_debug_frame *prev;
c7ecd529	95	long status;
92c2555f MV	96	scm_t_debug_info *vect;
	97	scm_t_debug_info *info;
	98	} scm_t_debug_frame;
1be6b49c	99
77debe3c MD	100	#define SCM_EVALFRAME (0L << 11)
	101	#define SCM_APPLYFRAME (1L << 11)
	102	#define SCM_VOIDFRAME (3L << 11)
	103	#define SCM_MACROEXPF (1L << 10)
fcbb26b2 MD	104	#define SCM_TAILREC (1L << 9)
fcbb26b2 MD	105	#define SCM_TRACED_FRAME (1L << 8)
5e8d7fd4	106	#define SCM_ARGS_READY (1L << 7)
fcbb26b2	107	#define SCM_DOVERFLOW (1L << 6)
020c890c	108	#define SCM_MAX_FRAME_SIZE 63
5e8d7fd4	109
77debe3c	110	#define SCM_FRAMETYPE (3L << 11)
fcbb26b2	111
77debe3c	112	#define SCM_EVALFRAMEP(x) (((x).status & SCM_FRAMETYPE) == SCM_EVALFRAME)
fcbb26b2	113	#define SCM_APPLYFRAMEP(x) (((x).status & SCM_FRAMETYPE) == SCM_APPLYFRAME)
473c250d	114	#define SCM_VOIDFRAMEP(x) (((x).status & SCM_FRAMETYPE) == SCM_VOIDFRAME)
5e8d7fd4 MD	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)
77debe3c	119	#define SCM_MACROEXPP(x) (((x).status & SCM_MACROEXPF) != 0)
5e8d7fd4 MD	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)
77debe3c MD	126	#define SCM_SET_MACROEXP(x) ((x).status \|= SCM_MACROEXPF)
77debe3c MD	127	#define SCM_CLEAR_MACROEXP(x) ((x).status &= ~SCM_MACROEXPF)
5e8d7fd4	128
fcbb26b2 MD	129	/* {Debug Objects}
	130	*/
	131
33b001fd	132	SCM_API scm_t_bits scm_tc16_debugobj;
fcbb26b2	133
13dcb666 DH	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))
e841c3e0	138	#define SCM_SET_DEBUGOBJ_FRAME(x, f) SCM_SET_CELL_WORD_1 (x, f)
fcbb26b2	139
c7ecd529 MD	140	/* {Memoized Source}
	141	*/
	142
33b001fd	143	SCM_API scm_t_bits scm_tc16_memoized;
c7ecd529	144
e841c3e0 KN	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))
c7ecd529 MD	148
	149	\f
	150
33b001fd MV	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);
00f9eace	154	SCM_API SCM scm_start_stack (SCM info_id, SCM exp, SCM env);
33b001fd MV	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);
33b001fd	164	SCM_API SCM scm_make_debugobj (scm_t_debug_frame *debug);
9fcf3cbb DH	165
9fcf3cbb DH	166	SCM_API SCM scm_i_unmemoize_expr (SCM memoized);
33b001fd	167	SCM_API void scm_init_debug (void);
c7ecd529	168
f3667f52	169	#ifdef GUILE_DEBUG
33b001fd MV	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);
f3667f52 JB	174	#endif /GUILE_DEBUG/
f3667f52 JB	175
5132eef0	176	#if SCM_ENABLE_DEPRECATED == 1
434f2f7a	177
5132eef0 DH	178	#define CHECK_ENTRY scm_check_entry_p
	179	#define CHECK_APPLY scm_check_apply_p
	180	#define CHECK_EXIT scm_check_exit_p
434f2f7a DH	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
5132eef0 DH	186	#endif
5132eef0 DH	187
b29058ff	188	#endif /* SCM_DEBUG_H */
89e00824 ML	189
	190	/*
	191	Local Variables:
	192	c-file-style: "gnu"
	193	End:
	194	*/