--- /dev/null
+/* Debugging extensions for Guile
+ * Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003, 2006, 2008 Free Software Foundation
+ *
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+
+#ifdef HAVE_CONFIG_H
+# include <config.h>
+#endif
+
+#include "libguile/_scm.h"
+#include "libguile/async.h"
+#include "libguile/eval.h"
+#include "libguile/list.h"
+#include "libguile/stackchk.h"
+#include "libguile/throw.h"
+#include "libguile/macros.h"
+#include "libguile/smob.h"
+#include "libguile/procprop.h"
+#include "libguile/srcprop.h"
+#include "libguile/alist.h"
+#include "libguile/continuations.h"
+#include "libguile/strports.h"
+#include "libguile/read.h"
+#include "libguile/feature.h"
+#include "libguile/dynwind.h"
+#include "libguile/modules.h"
+#include "libguile/ports.h"
+#include "libguile/root.h"
+#include "libguile/fluids.h"
+#include "libguile/objects.h"
+
+#include "libguile/validate.h"
+#include "libguile/debug.h"
+\f
+
+/* {Run time control of the debugging evaluator}
+ */
+
+SCM_DEFINE (scm_debug_options, "debug-options-interface", 0, 1, 0,
+ (SCM setting),
+ "Option interface for the debug options. Instead of using\n"
+ "this procedure directly, use the procedures @code{debug-enable},\n"
+ "@code{debug-disable}, @code{debug-set!} and @code{debug-options}.")
+#define FUNC_NAME s_scm_debug_options
+{
+ SCM ans;
+
+ scm_dynwind_begin (0);
+ scm_dynwind_critical_section (SCM_BOOL_F);
+
+ ans = scm_options (setting, scm_debug_opts, SCM_N_DEBUG_OPTIONS, FUNC_NAME);
+ if (!(1 <= SCM_N_FRAMES && SCM_N_FRAMES <= SCM_MAX_FRAME_SIZE))
+ {
+ scm_options (ans, scm_debug_opts, SCM_N_DEBUG_OPTIONS, FUNC_NAME);
+ SCM_OUT_OF_RANGE (1, setting);
+ }
+ SCM_RESET_DEBUG_MODE;
+ scm_stack_checking_enabled_p = SCM_STACK_CHECKING_P;
+ scm_debug_eframe_size = 2 * SCM_N_FRAMES;
+
+ scm_dynwind_end ();
+ return ans;
+}
+#undef FUNC_NAME
+
+static void
+with_traps_before (void *data)
+{
+ int *trap_flag = data;
+ *trap_flag = SCM_TRAPS_P;
+ SCM_TRAPS_P = 1;
+}
+
+static void
+with_traps_after (void *data)
+{
+ int *trap_flag = data;
+ SCM_TRAPS_P = *trap_flag;
+}
+
+static SCM
+with_traps_inner (void *data)
+{
+ SCM thunk = SCM_PACK ((scm_t_bits) data);
+ return scm_call_0 (thunk);
+}
+
+SCM_DEFINE (scm_with_traps, "with-traps", 1, 0, 0,
+ (SCM thunk),
+ "Call @var{thunk} with traps enabled.")
+#define FUNC_NAME s_scm_with_traps
+{
+ int trap_flag;
+ SCM_VALIDATE_THUNK (1, thunk);
+ return scm_internal_dynamic_wind (with_traps_before,
+ with_traps_inner,
+ with_traps_after,
+ (void *) SCM_UNPACK (thunk),
+ &trap_flag);
+}
+#undef FUNC_NAME
+
+\f
+
+SCM_SYMBOL (scm_sym_procname, "procname");
+SCM_SYMBOL (scm_sym_dots, "...");
+SCM_SYMBOL (scm_sym_source, "source");
+
+/* {Memoized Source}
+ */
+
+scm_t_bits scm_tc16_memoized;
+
+static int
+memoized_print (SCM obj, SCM port, scm_print_state *pstate)
+{
+ int writingp = SCM_WRITINGP (pstate);
+ scm_puts ("#<memoized ", port);
+ SCM_SET_WRITINGP (pstate, 1);
+ scm_iprin1 (SCM_MEMOIZED_EXP (obj), port, pstate);
+ SCM_SET_WRITINGP (pstate, writingp);
+ scm_putc ('>', port);
+ return 1;
+}
+
+SCM_DEFINE (scm_memoized_p, "memoized?", 1, 0, 0,
+ (SCM obj),
+ "Return @code{#t} if @var{obj} is memoized.")
+#define FUNC_NAME s_scm_memoized_p
+{
+ return scm_from_bool(SCM_MEMOIZEDP (obj));
+}
+#undef FUNC_NAME
+
+SCM
+scm_make_memoized (SCM exp, SCM env)
+{
+ /* *fixme* Check that env is a valid environment. */
+ SCM_RETURN_NEWSMOB (scm_tc16_memoized, SCM_UNPACK (scm_cons (exp, env)));
+}
+
+#ifdef GUILE_DEBUG
+/*
+ * Some primitives for construction of memoized code
+ *
+ * - procedure: memcons CAR CDR [ENV]
+ *
+ * Construct a pair, encapsulated in a memoized object.
+ *
+ * The CAR and CDR can be either normal or memoized. If ENV isn't
+ * specified, the top-level environment of the current module will
+ * be assumed. All environments must match.
+ *
+ * - procedure: make-iloc FRAME BINDING CDRP
+ *
+ * Return an iloc referring to frame no. FRAME, binding
+ * no. BINDING. If CDRP is non-#f, the iloc is referring to a
+ * frame consisting of a single pair, with the value stored in the
+ * CDR.
+ *
+ * - procedure: iloc? OBJECT
+ *
+ * Return #t if OBJECT is an iloc.
+ *
+ * - procedure: mem->proc MEMOIZED
+ *
+ * Construct a closure from the memoized lambda expression MEMOIZED
+ *
+ * WARNING! The code is not copied!
+ *
+ * - procedure: proc->mem CLOSURE
+ *
+ * Turn the closure CLOSURE into a memoized object.
+ *
+ * WARNING! The code is not copied!
+ *
+ * - constant: SCM_IM_AND
+ * - constant: SCM_IM_BEGIN
+ * - constant: SCM_IM_CASE
+ * - constant: SCM_IM_COND
+ * - constant: SCM_IM_DO
+ * - constant: SCM_IM_IF
+ * - constant: SCM_IM_LAMBDA
+ * - constant: SCM_IM_LET
+ * - constant: SCM_IM_LETSTAR
+ * - constant: SCM_IM_LETREC
+ * - constant: SCM_IM_OR
+ * - constant: SCM_IM_QUOTE
+ * - constant: SCM_IM_SET
+ * - constant: SCM_IM_DEFINE
+ * - constant: SCM_IM_APPLY
+ * - constant: SCM_IM_CONT
+ * - constant: SCM_IM_DISPATCH
+ */
+
+#include "libguile/variable.h"
+#include "libguile/procs.h"
+
+SCM_DEFINE (scm_memcons, "memcons", 2, 1, 0,
+ (SCM car, SCM cdr, SCM env),
+ "Return a new memoized cons cell with @var{car} and @var{cdr}\n"
+ "as members and @var{env} as the environment.")
+#define FUNC_NAME s_scm_memcons
+{
+ if (SCM_MEMOIZEDP (car))
+ {
+ /*fixme* environments may be two different but equal top-level envs */
+ if (!SCM_UNBNDP (env) && SCM_MEMOIZED_ENV (car) != env)
+ SCM_MISC_ERROR ("environment mismatch arg1 <-> arg3",
+ scm_list_2 (car, env));
+ else
+ env = SCM_MEMOIZED_ENV (car);
+ car = SCM_MEMOIZED_EXP (car);
+ }
+ if (SCM_MEMOIZEDP (cdr))
+ {
+ if (!SCM_UNBNDP (env) && SCM_MEMOIZED_ENV (cdr) != env)
+ SCM_MISC_ERROR ("environment mismatch arg2 <-> arg3",
+ scm_list_2 (cdr, env));
+ else
+ env = SCM_MEMOIZED_ENV (cdr);
+ cdr = SCM_MEMOIZED_EXP (cdr);
+ }
+ if (SCM_UNBNDP (env))
+ env = scm_top_level_env (SCM_TOP_LEVEL_LOOKUP_CLOSURE);
+ else
+ SCM_VALIDATE_NULLORCONS (3, env);
+ return scm_make_memoized (scm_cons (car, cdr), env);
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_mem_to_proc, "mem->proc", 1, 0, 0,
+ (SCM obj),
+ "Convert a memoized object (which must represent a body)\n"
+ "to a procedure.")
+#define FUNC_NAME s_scm_mem_to_proc
+{
+ SCM env;
+ SCM_VALIDATE_MEMOIZED (1, obj);
+ env = SCM_MEMOIZED_ENV (obj);
+ obj = SCM_MEMOIZED_EXP (obj);
+ return scm_closure (obj, env);
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_proc_to_mem, "proc->mem", 1, 0, 0,
+ (SCM obj),
+ "Convert a procedure to a memoized object.")
+#define FUNC_NAME s_scm_proc_to_mem
+{
+ SCM_VALIDATE_CLOSURE (1, obj);
+ return scm_make_memoized (SCM_CODE (obj), SCM_ENV (obj));
+}
+#undef FUNC_NAME
+
+#endif /* GUILE_DEBUG */
+
+SCM_DEFINE (scm_i_unmemoize_expr, "unmemoize-expr", 1, 0, 0,
+ (SCM m),
+ "Unmemoize the memoized expression @var{m},")
+#define FUNC_NAME s_scm_i_unmemoize_expr
+{
+ SCM_VALIDATE_MEMOIZED (1, m);
+ return scm_i_unmemocopy_expr (SCM_MEMOIZED_EXP (m), SCM_MEMOIZED_ENV (m));
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_memoized_environment, "memoized-environment", 1, 0, 0,
+ (SCM m),
+ "Return the environment of the memoized expression @var{m}.")
+#define FUNC_NAME s_scm_memoized_environment
+{
+ SCM_VALIDATE_MEMOIZED (1, m);
+ return SCM_MEMOIZED_ENV (m);
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_procedure_name, "procedure-name", 1, 0, 0,
+ (SCM proc),
+ "Return the name of the procedure @var{proc}")
+#define FUNC_NAME s_scm_procedure_name
+{
+ SCM_VALIDATE_PROC (1, proc);
+ switch (SCM_TYP7 (proc)) {
+ case scm_tcs_subrs:
+ return SCM_SNAME (proc);
+ default:
+ {
+ SCM name = scm_procedure_property (proc, scm_sym_name);
+#if 0
+ /* Source property scm_sym_procname not implemented yet... */
+ SCM name = scm_source_property (SCM_CAR (SCM_CLOSURE_BODY (proc)), scm_sym_procname);
+ if (scm_is_false (name))
+ name = scm_procedure_property (proc, scm_sym_name);
+#endif
+ if (scm_is_false (name) && SCM_CLOSUREP (proc))
+ name = scm_reverse_lookup (SCM_ENV (proc), proc);
+ return name;
+ }
+ }
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_procedure_source, "procedure-source", 1, 0, 0,
+ (SCM proc),
+ "Return the source of the procedure @var{proc}.")
+#define FUNC_NAME s_scm_procedure_source
+{
+ SCM_VALIDATE_NIM (1, proc);
+ again:
+ switch (SCM_TYP7 (proc)) {
+ case scm_tcs_closures:
+ {
+ const SCM formals = SCM_CLOSURE_FORMALS (proc);
+ const SCM body = SCM_CLOSURE_BODY (proc);
+ const SCM src = scm_source_property (body, scm_sym_copy);
+
+ if (scm_is_true (src))
+ {
+ return scm_cons2 (scm_sym_lambda, formals, src);
+ }
+ else
+ {
+ const SCM env = SCM_EXTEND_ENV (formals, SCM_EOL, SCM_ENV (proc));
+ return scm_cons2 (scm_sym_lambda,
+ scm_i_finite_list_copy (formals),
+ scm_i_unmemocopy_body (body, env));
+ }
+ }
+ case scm_tcs_struct:
+ if (!SCM_I_OPERATORP (proc))
+ break;
+ goto procprop;
+ case scm_tc7_smob:
+ if (!SCM_SMOB_DESCRIPTOR (proc).apply)
+ break;
+ case scm_tcs_subrs:
+#ifdef CCLO
+ case scm_tc7_cclo:
+#endif
+ procprop:
+ /* It would indeed be a nice thing if we supplied source even for
+ built in procedures! */
+ return scm_procedure_property (proc, scm_sym_source);
+ case scm_tc7_pws:
+ {
+ SCM src = scm_procedure_property (proc, scm_sym_source);
+ if (scm_is_true (src))
+ return src;
+ proc = SCM_PROCEDURE (proc);
+ goto again;
+ }
+ default:
+ ;
+ }
+ SCM_WRONG_TYPE_ARG (1, proc);
+ return SCM_BOOL_F; /* not reached */
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_procedure_environment, "procedure-environment", 1, 0, 0,
+ (SCM proc),
+ "Return the environment of the procedure @var{proc}.")
+#define FUNC_NAME s_scm_procedure_environment
+{
+ SCM_VALIDATE_NIM (1, proc);
+ switch (SCM_TYP7 (proc)) {
+ case scm_tcs_closures:
+ return SCM_ENV (proc);
+ case scm_tcs_subrs:
+#ifdef CCLO
+ case scm_tc7_cclo:
+#endif
+ return SCM_EOL;
+ default:
+ SCM_WRONG_TYPE_ARG (1, proc);
+ /* not reached */
+ }
+}
+#undef FUNC_NAME
+
+\f
+
+/* Eval in a local environment. We would like to have the ability to
+ * evaluate in a specified local environment, but due to the
+ * memoization this isn't normally possible. We solve it by copying
+ * the code before evaluating. One solution would be to have eval.c
+ * generate yet another evaluator. They are not very big actually.
+ */
+SCM_DEFINE (scm_local_eval, "local-eval", 1, 1, 0,
+ (SCM exp, SCM env),
+ "Evaluate @var{exp} in its environment. If @var{env} is supplied,\n"
+ "it is the environment in which to evaluate @var{exp}. Otherwise,\n"
+ "@var{exp} must be a memoized code object (in which case, its environment\n"
+ "is implicit).")
+#define FUNC_NAME s_scm_local_eval
+{
+ if (SCM_UNBNDP (env))
+ {
+ SCM_VALIDATE_MEMOIZED (1, exp);
+ return scm_i_eval_x (SCM_MEMOIZED_EXP (exp), SCM_MEMOIZED_ENV (exp));
+ }
+ return scm_i_eval (exp, env);
+}
+#undef FUNC_NAME
+
+#if 0
+SCM_REGISTER_PROC (s_reverse_lookup, "reverse-lookup", 2, 0, 0, scm_reverse_lookup);
+#endif
+
+SCM
+scm_reverse_lookup (SCM env, SCM data)
+{
+ while (scm_is_pair (env) && scm_is_pair (SCM_CAR (env)))
+ {
+ SCM names = SCM_CAAR (env);
+ SCM values = SCM_CDAR (env);
+ while (scm_is_pair (names))
+ {
+ if (scm_is_eq (SCM_CAR (values), data))
+ return SCM_CAR (names);
+ names = SCM_CDR (names);
+ values = SCM_CDR (values);
+ }
+ if (!scm_is_null (names) && scm_is_eq (values, data))
+ return names;
+ env = SCM_CDR (env);
+ }
+ return SCM_BOOL_F;
+}
+
+SCM
+scm_start_stack (SCM id, SCM exp, SCM env)
+{
+ SCM answer;
+ scm_t_debug_frame vframe;
+ scm_t_debug_info vframe_vect_body;
+ vframe.prev = scm_i_last_debug_frame ();
+ vframe.status = SCM_VOIDFRAME;
+ vframe.vect = &vframe_vect_body;
+ vframe.vect[0].id = id;
+ scm_i_set_last_debug_frame (&vframe);
+ answer = scm_i_eval (exp, env);
+ scm_i_set_last_debug_frame (vframe.prev);
+ return answer;
+}
+
+SCM_SYNTAX(s_start_stack, "start-stack", scm_makacro, scm_m_start_stack);
+
+static SCM
+scm_m_start_stack (SCM exp, SCM env)
+#define FUNC_NAME s_start_stack
+{
+ exp = SCM_CDR (exp);
+ if (!scm_is_pair (exp)
+ || !scm_is_pair (SCM_CDR (exp))
+ || !scm_is_null (SCM_CDDR (exp)))
+ SCM_WRONG_NUM_ARGS ();
+ return scm_start_stack (scm_eval_car (exp, env), SCM_CADR (exp), env);
+}
+#undef FUNC_NAME
+
+
+/* {Debug Objects}
+ *
+ * The debugging evaluator throws these on frame traps.
+ */
+
+scm_t_bits scm_tc16_debugobj;
+
+static int
+debugobj_print (SCM obj, SCM port, scm_print_state *pstate SCM_UNUSED)
+{
+ scm_puts ("#<debug-object ", port);
+ scm_intprint ((long) SCM_DEBUGOBJ_FRAME (obj), 16, port);
+ scm_putc ('>', port);
+ return 1;
+}
+
+SCM_DEFINE (scm_debug_object_p, "debug-object?", 1, 0, 0,
+ (SCM obj),
+ "Return @code{#t} if @var{obj} is a debug object.")
+#define FUNC_NAME s_scm_debug_object_p
+{
+ return scm_from_bool(SCM_DEBUGOBJP (obj));
+}
+#undef FUNC_NAME
+
+
+SCM
+scm_make_debugobj (scm_t_debug_frame *frame)
+{
+ return scm_cell (scm_tc16_debugobj, (scm_t_bits) frame);
+}
+
+\f
+
+/* Undocumented debugging procedure */
+#ifdef GUILE_DEBUG
+SCM_DEFINE (scm_debug_hang, "debug-hang", 0, 1, 0,
+ (SCM obj),
+ "Go into an endless loop, which can be only terminated with\n"
+ "a debugger.")
+#define FUNC_NAME s_scm_debug_hang
+{
+ int go = 0;
+ while (!go) ;
+ return SCM_UNSPECIFIED;
+}
+#undef FUNC_NAME
+#endif
+
+\f
+
+void
+scm_init_debug ()
+{
+ scm_init_opts (scm_debug_options, scm_debug_opts, SCM_N_DEBUG_OPTIONS);
+
+ scm_tc16_memoized = scm_make_smob_type ("memoized", 0);
+ scm_set_smob_mark (scm_tc16_memoized, scm_markcdr);
+ scm_set_smob_print (scm_tc16_memoized, memoized_print);
+
+ scm_tc16_debugobj = scm_make_smob_type ("debug-object", 0);
+ scm_set_smob_print (scm_tc16_debugobj, debugobj_print);
+
+#ifdef GUILE_DEBUG
+ scm_c_define ("SCM_IM_AND", SCM_IM_AND);
+ scm_c_define ("SCM_IM_BEGIN", SCM_IM_BEGIN);
+ scm_c_define ("SCM_IM_CASE", SCM_IM_CASE);
+ scm_c_define ("SCM_IM_COND", SCM_IM_COND);
+ scm_c_define ("SCM_IM_DO", SCM_IM_DO);
+ scm_c_define ("SCM_IM_IF", SCM_IM_IF);
+ scm_c_define ("SCM_IM_LAMBDA", SCM_IM_LAMBDA);
+ scm_c_define ("SCM_IM_LET", SCM_IM_LET);
+ scm_c_define ("SCM_IM_LETSTAR", SCM_IM_LETSTAR);
+ scm_c_define ("SCM_IM_LETREC", SCM_IM_LETREC);
+ scm_c_define ("SCM_IM_OR", SCM_IM_OR);
+ scm_c_define ("SCM_IM_QUOTE", SCM_IM_QUOTE);
+ scm_c_define ("SCM_IM_SET_X", SCM_IM_SET_X);
+ scm_c_define ("SCM_IM_DEFINE", SCM_IM_DEFINE);
+ scm_c_define ("SCM_IM_APPLY", SCM_IM_APPLY);
+ scm_c_define ("SCM_IM_CONT", SCM_IM_CONT);
+ scm_c_define ("SCM_IM_DISPATCH", SCM_IM_DISPATCH);
+#endif
+ scm_add_feature ("debug-extensions");
+
+#include "libguile/debug.x"
+}
+
+/*
+ Local Variables:
+ c-file-style: "gnu"
+ End:
+*/
projects / lilypond.git / blobdiff