* Fixed scm_thunk_p's results when applied to closures.
[bpt/guile.git] / libguile / debug.c
index 45431ad..20fa8d7 100644 (file)
@@ -1,5 +1,5 @@
- /* Debugging extensions for Guile
- * Copyright (C) 1995, 1996, 1997, 1998, 1999 Free Software Foundation
+/* Debugging extensions for Guile
+ * Copyright (C) 1995,1996,1997,1998,1999,2000,2001 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
    gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
 
 
-#include <stdio.h>
-#include "_scm.h"
-#include "eval.h"
-#include "stackchk.h"
-#include "throw.h"
-#include "genio.h"
-#include "macros.h"
-#include "smob.h"
-#include "procprop.h"
-#include "srcprop.h"
-#include "alist.h"
-#include "continuations.h"
-#include "strports.h"
-#include "read.h"
-#include "feature.h"
-#include "dynwind.h"
-#include "modules.h"
-
-#include "validate.h"
-#include "debug.h"
+#include "libguile/_scm.h"
+#include "libguile/eval.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/validate.h"
+#include "libguile/debug.h"
 \f
 
 /* {Run time control of the debugging evaluator}
@@ -74,7 +75,9 @@
 
 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 @var{debug-options}.")
 #define FUNC_NAME s_scm_debug_options
 {
   SCM ans;
@@ -116,13 +119,13 @@ with_traps_after (void *data)
 static SCM
 with_traps_inner (void *data)
 {
-  SCM thunk = (SCM) data;
+  SCM thunk = SCM_PACK (data);
   return scm_apply (thunk, SCM_EOL, SCM_EOL);
 }
 
 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;
@@ -130,23 +133,24 @@ SCM_DEFINE (scm_with_traps, "with-traps", 1, 0, 0,
   return scm_internal_dynamic_wind (with_traps_before,
                                    with_traps_inner,
                                    with_traps_after,
-                                   (void *) thunk,
+                                   (void *) SCM_UNPACK (thunk),
                                    &trap_flag);
 }
 #undef FUNC_NAME
 
 \f
-static SCM scm_sym_source, scm_sym_dots;
-static SCM scm_sym_procname;
+
+SCM_SYMBOL (scm_sym_procname, "procname");
+SCM_SYMBOL (scm_sym_dots, "...");
+SCM_SYMBOL (scm_sym_source, "source");
 
 /* {Memoized Source}
  */
 
-long scm_tc16_memoized;
-
+scm_bits_t scm_tc16_memoized;
 
 static int
-prinmemoized (SCM obj,SCM port,scm_print_state *pstate)
+memoized_print (SCM obj, SCM port, scm_print_state *pstate)
 {
   int writingp = SCM_WRITINGP (pstate);
   scm_puts ("#<memoized ", port);
@@ -163,7 +167,7 @@ prinmemoized (SCM obj,SCM port,scm_print_state *pstate)
 
 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_BOOL(SCM_MEMOIZEDP (obj));
@@ -176,8 +180,8 @@ scm_make_memoized (SCM exp, SCM env)
   /* *fixme* Check that env is a valid environment. */
   register SCM z, ans;
   SCM_ENTER_A_SECTION;
-  SCM_NEWSMOB (z, exp, env);
-  SCM_NEWSMOB (ans, scm_tc16_memoized, z);
+  SCM_NEWSMOB (z, SCM_UNPACK (exp), SCM_UNPACK (env));
+  SCM_NEWSMOB (ans, scm_tc16_memoized, SCM_UNPACK (z));
   SCM_EXIT_A_SECTION;
   return ans;
 }
@@ -247,12 +251,13 @@ scm_make_memoized (SCM exp, SCM env)
  * - constant: SCM_IM_DISPATCH
  */
 
-#include "variable.h"
-#include "procs.h"
+#include "libguile/variable.h"
+#include "libguile/procs.h"
 
 SCM_DEFINE (scm_make_gloc, "make-gloc", 1, 1, 0, 
             (SCM var, SCM env),
-"")
+           "Create a gloc for variable @var{var} in the environment\n"
+           "@var{env}.")
 #define FUNC_NAME s_scm_make_gloc
 {
 #if 1 /* Unsafe */
@@ -262,7 +267,7 @@ SCM_DEFINE (scm_make_gloc, "make-gloc", 1, 1, 0,
 #endif
     SCM_VALIDATE_VARIABLE (1,var);
   if (SCM_UNBNDP (env))
-    env = scm_top_level_env (SCM_CDR (scm_top_level_lookup_closure_var));
+    env = scm_top_level_env (SCM_TOP_LEVEL_LOOKUP_CLOSURE);
   else
     SCM_VALIDATE_NULLORCONS (2,env);
   return scm_make_memoized (SCM_VARVCELL (var) + 1, env);
@@ -271,17 +276,18 @@ SCM_DEFINE (scm_make_gloc, "make-gloc", 1, 1, 0,
 
 SCM_DEFINE (scm_gloc_p, "gloc?", 1, 0, 0, 
             (SCM obj),
-"")
+           "Return @code{#t} if @var{obj} is a gloc.")
 #define FUNC_NAME s_scm_gloc_p
 {
   return SCM_BOOL((SCM_MEMOIZEDP (obj)
-                   && (SCM_ASWORD(SCM_MEMOIZED_EXP (obj)) & 7) == 1));
+                   && (SCM_UNPACK(SCM_MEMOIZED_EXP (obj)) & 7) == 1));
 }
 #undef FUNC_NAME
 
 SCM_DEFINE (scm_make_iloc, "make-iloc", 3, 0, 0,
             (SCM frame, SCM binding, SCM cdrp),
-"")
+           "Return a new iloc with frame offset @var{frame}, binding\n"
+           "offset @var{binding} and the cdr flag @var{cdrp}.")
 #define FUNC_NAME s_scm_make_iloc
 {
   SCM_VALIDATE_INUM (1,frame);
@@ -295,7 +301,7 @@ SCM_DEFINE (scm_make_iloc, "make-iloc", 3, 0, 0,
 
 SCM_DEFINE (scm_iloc_p, "iloc?", 1, 0, 0, 
           (SCM obj),
-"")
+           "Return @code{#t} if @var{obj} is an iloc.")
 #define FUNC_NAME s_scm_iloc_p
 {
   return SCM_BOOL(SCM_ILOCP (obj));
@@ -304,7 +310,8 @@ SCM_DEFINE (scm_iloc_p, "iloc?", 1, 0, 0,
 
 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))
@@ -327,7 +334,7 @@ SCM_DEFINE (scm_memcons, "memcons", 2, 1, 0,
       cdr = SCM_MEMOIZED_EXP (cdr);
     }
   if (SCM_UNBNDP (env))
-    env = scm_top_level_env (SCM_CDR (scm_top_level_lookup_closure_var));
+    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);
@@ -336,7 +343,8 @@ SCM_DEFINE (scm_memcons, "memcons", 2, 1, 0,
 
 SCM_DEFINE (scm_mem_to_proc, "mem->proc", 1, 0, 0, 
             (SCM obj),
-"")
+           "Convert a memoized object (which must be a lambda expression)\n"
+           "to a procedure.")
 #define FUNC_NAME s_scm_mem_to_proc
 {
   SCM env;
@@ -352,7 +360,7 @@ SCM_DEFINE (scm_mem_to_proc, "mem->proc", 1, 0, 0,
 
 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);
@@ -365,7 +373,7 @@ SCM_DEFINE (scm_proc_to_mem, "proc->mem", 1, 0, 0,
 
 SCM_DEFINE (scm_unmemoize, "unmemoize", 1, 0, 0, 
             (SCM m),
-"")
+           "Unmemoize the memoized expression @var{m},")
 #define FUNC_NAME s_scm_unmemoize
 {
   SCM_VALIDATE_MEMOIZED (1,m);
@@ -375,7 +383,7 @@ SCM_DEFINE (scm_unmemoize, "unmemoize", 1, 0, 0,
 
 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);
@@ -385,7 +393,7 @@ SCM_DEFINE (scm_memoized_environment, "memoized-environment", 1, 0, 0,
 
 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);
@@ -411,7 +419,7 @@ SCM_DEFINE (scm_procedure_name, "procedure-name", 1, 0, 0,
 
 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);
@@ -420,8 +428,8 @@ SCM_DEFINE (scm_procedure_source, "procedure-source", 1, 0, 0,
     {
       SCM src;
       src = scm_source_property (SCM_CDR (SCM_CODE (proc)), scm_sym_copy);
-      if (src != SCM_BOOL_F)
-       return scm_cons2 (scm_sym_lambda, SCM_CAR (SCM_CODE (proc)), src);
+      if (! SCM_FALSEP (src))
+       return scm_cons2 (scm_sym_lambda, SCM_CLOSURE_FORMALS (proc), src);
       src = SCM_CODE (proc);
       return scm_cons (scm_sym_lambda,
                       scm_unmemocopy (src,
@@ -429,7 +437,6 @@ SCM_DEFINE (scm_procedure_source, "procedure-source", 1, 0, 0,
                                                           SCM_EOL,
                                                           SCM_ENV (proc))));
     }
-  case scm_tc7_contin:
   case scm_tcs_subrs:
 #ifdef CCLO
   case scm_tc7_cclo:
@@ -438,30 +445,29 @@ SCM_DEFINE (scm_procedure_source, "procedure-source", 1, 0, 0,
        built in procedures! */
     return scm_procedure_property (proc, scm_sym_source);
   default:
-    SCM_WTA(1,proc);
-    return 0;
+    SCM_WRONG_TYPE_ARG (1, proc);
+    /* 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_tc7_contin:
   case scm_tcs_subrs:
 #ifdef CCLO
   case scm_tc7_cclo:
 #endif
     return SCM_EOL;
   default:
-    SCM_WTA(1,proc);
-    return 0;
+    SCM_WRONG_TYPE_ARG (1, proc);
+    /* not reached */
   }
 }
 #undef FUNC_NAME
@@ -484,10 +490,10 @@ SCM_DEFINE (scm_local_eval, "local-eval", 1, 1, 0,
 {
   if (SCM_UNBNDP (env))
   {
-    SCM_VALIDATE_MEMOIZED (1,exp);
-    return scm_eval_3 (SCM_MEMOIZED_EXP (exp), 0, SCM_MEMOIZED_ENV (exp));
+    SCM_VALIDATE_MEMOIZED (1, exp);
+    return scm_i_eval_x (SCM_MEMOIZED_EXP (exp), SCM_MEMOIZED_ENV (exp));
   }
-  return scm_eval_3 (exp, 1, env);
+  return scm_i_eval (exp, env);
 }
 #undef FUNC_NAME
 
@@ -498,19 +504,18 @@ SCM_REGISTER_PROC (s_reverse_lookup, "reverse-lookup", 2, 0, 0, scm_reverse_look
 SCM
 scm_reverse_lookup (SCM env, SCM data)
 {
-  SCM names, values;
-  while (SCM_NIMP (env) && SCM_SLOPPY_CONSP (SCM_CAR (env)))
+  while (SCM_CONSP (env) && SCM_CONSP (SCM_CAR (env)))
     {
-      names = SCM_CAAR (env);
-      values = SCM_CDAR (env);
+      SCM names = SCM_CAAR (env);
+      SCM values = SCM_CDAR (env);
       while (SCM_CONSP (names))
        {
-         if (SCM_CAR (values) == data)
+         if (SCM_EQ_P (SCM_CAR (values), data))
            return SCM_CAR (names);
          names = SCM_CDR (names);
          values = SCM_CDR (values);
        }
-      if (names != SCM_EOL && values == data)
+      if (!SCM_NULLP (names) && SCM_EQ_P (values, data))
        return names;
       env = SCM_CDR (env);
     }
@@ -528,7 +533,7 @@ scm_start_stack (SCM id, SCM exp, SCM env)
   vframe.vect = &vframe_vect_body;
   vframe.vect[0].id = id;
   scm_last_debug_frame = &vframe;
-  answer = scm_eval_3 (exp, 1, env);
+  answer = scm_i_eval (exp, env);
   scm_last_debug_frame = vframe.prev;
   return answer;
 }
@@ -537,26 +542,27 @@ 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);
-  SCM_ASSERT (SCM_ECONSP (exp)
-              && SCM_ECONSP (SCM_CDR (exp))
-             && SCM_NULLP (SCM_CDDR (exp)),
-             exp,
-             SCM_WNA,
-             s_start_stack);
+  if (!SCM_ECONSP (exp) 
+      || !SCM_ECONSP (SCM_CDR (exp))
+      || !SCM_NULLP (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.
  */
 
-long scm_tc16_debugobj;
+scm_bits_t scm_tc16_debugobj;
 
 static int
-prindebugobj (SCM obj,SCM port,scm_print_state *pstate)
+debugobj_print (SCM obj, SCM port, scm_print_state *pstate)
 {
   scm_puts ("#<debug-object ", port);
   scm_intprint ((int) SCM_DEBUGOBJ_FRAME (obj), 16, port);
@@ -566,7 +572,7 @@ prindebugobj (SCM obj,SCM port,scm_print_state *pstate)
 
 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_BOOL(SCM_DEBUGOBJP (obj));
@@ -580,8 +586,8 @@ scm_make_debugobj (scm_debug_frame *frame)
   register SCM z;
   SCM_NEWCELL (z);
   SCM_ENTER_A_SECTION;
-  SCM_SET_DEBUGOBJ_FRAME (z, (SCM) frame);
-  SCM_SETCAR (z, scm_tc16_debugobj);
+  SCM_SET_DEBUGOBJ_FRAME (z, frame);
+  SCM_SET_CELL_TYPE (z, scm_tc16_debugobj);
   SCM_EXIT_A_SECTION;
   return z;
 }
@@ -592,7 +598,8 @@ scm_make_debugobj (scm_debug_frame *frame)
 #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;
@@ -609,15 +616,12 @@ scm_init_debug ()
 {
   scm_init_opts (scm_debug_options, scm_debug_opts, SCM_N_DEBUG_OPTIONS);
 
-  scm_tc16_memoized = scm_make_smob_type_mfpe ("memoized", 0,
-                                              scm_markcdr, NULL, prinmemoized, NULL);
+  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_mfpe ("debug-object", 0,
-                                              NULL, NULL, prindebugobj, NULL);
-
-  scm_sym_procname = SCM_CAR (scm_sysintern ("procname", SCM_UNDEFINED));
-  scm_sym_dots = SCM_CAR (scm_sysintern ("...", SCM_UNDEFINED));
-  scm_sym_source = SCM_CAR (scm_sysintern ("source", SCM_UNDEFINED));
+  scm_tc16_debugobj = scm_make_smob_type ("debug-object", 0);
+  scm_set_smob_print (scm_tc16_debugobj, debugobj_print);
 
 #ifdef GUILE_DEBUG
   scm_sysintern ("SCM_IM_AND", SCM_IM_AND);
@@ -640,5 +644,13 @@ scm_init_debug ()
 #endif
   scm_add_feature ("debug-extensions");
 
-#include "debug.x"
+#ifndef SCM_MAGIC_SNARFER
+#include "libguile/debug.x"
+#endif
 }
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/