Initial revision
[bpt/guile.git] / libguile / stacks.c
index e708a14..508b2e2 100644 (file)
@@ -1,5 +1,5 @@
 /* Representation of stack frame debug information
- * Copyright (C) 1996 Mikael Djurfeldt
+ * Copyright (C) 1996,1997,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
@@ -13,7 +13,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 */
+
+
 \f
 
-#include <stdio.h>
-#include "_scm.h"
-#include "debug.h"
-#include "continuations.h"
+#include "libguile/_scm.h"
+#include "libguile/eval.h"
+#include "libguile/debug.h"
+#include "libguile/continuations.h"
+#include "libguile/struct.h"
+#include "libguile/macros.h"
+#include "libguile/procprop.h"
+#include "libguile/modules.h"
+#include "libguile/root.h"
+#include "libguile/strings.h"
 
-#include "stacks.h"
+#include "libguile/validate.h"
+#include "libguile/stacks.h"
 
 \f
 /* {Frames and stacks}
  *
  * Representation:
  *
- * The stack is represented as an ordinary scheme vector.  It is
- * logically divided into sections of SCM values.  Each section is an
- * scm_info_frame struct.
+ * The stack is represented as a struct with an id slot and a tail
+ * array of scm_t_info_frame structs.
  *
  * A frame is represented as a pair where the car contains a stack and
  * the cdr an inum.  The inum is an index to the first SCM value of
- * the scm_info_frame struct.
+ * the scm_t_info_frame struct.
  *
  * Stacks
  *   Constructor
  *     make-stack
- *   Selector
+ *   Selectors
+ *     stack-id
  *     stack-ref
  *   Inspector
  *     stack-length
  *     frame-real?
  *     frame-procedure?
  *     frame-evaluating-args?
- *     frame-overflow?
- */
+ *     frame-overflow?  */
 
 \f
 
 /* Some auxiliary functions for reading debug frames off the stack.
  */
 
+/* Stacks often contain pointers to other items on the stack; for
+   example, each scm_t_debug_frame structure contains a pointer to the
+   next frame out.  When we capture a continuation, we copy the stack
+   into the heap, and just leave all the pointers unchanged.  This
+   makes it simple to restore the continuation --- just copy the stack
+   back!  However, if we retrieve a pointer from the heap copy to
+   another item that was originally on the stack, we have to add an
+   offset to the pointer to discover the new referent.
+
+   If PTR is a pointer retrieved from a continuation, whose original
+   target was on the stack, and OFFSET is the appropriate offset from
+   the original stack to the continuation, then RELOC_MUMBLE (PTR,
+   OFFSET) is a pointer to the copy in the continuation of the
+   original referent, cast to an scm_debug_MUMBLE *.  */
+#define RELOC_INFO(ptr, offset) \
+  ((scm_t_debug_info *) ((SCM_STACKITEM *) (ptr) + (offset)))
+#define RELOC_FRAME(ptr, offset) \
+  ((scm_t_debug_frame *) ((SCM_STACKITEM *) (ptr) + (offset)))
+
+
 /* Count number of debug info frames on a stack, beginning with
  * DFRAME.  OFFSET is used for relocation of pointers when the stack
  * is read from a continuation.
  */
-static int stack_depth SCM_P ((scm_debug_frame *dframe, long offset, int *maxp));
-static int
-stack_depth (dframe, offset, maxp)
-     scm_debug_frame *dframe;
-     long offset;
-     int *maxp;
+static scm_t_bits
+stack_depth (scm_t_debug_frame *dframe,long offset,SCM *id,int *maxp)
 {
-  int n, size;
-  int max_depth = SCM_BACKTRACE_MAXDEPTH;
-  scm_debug_info *info;
+  long n;
+  long max_depth = SCM_BACKTRACE_MAXDEPTH;
   for (n = 0;
-       dframe && n < max_depth;
-       dframe = (scm_debug_frame *) ((SCM_STACKITEM *) dframe->prev + offset))
+       dframe && !SCM_VOIDFRAMEP (*dframe) && n < max_depth;
+       dframe = RELOC_FRAME (dframe->prev, offset))
     {
       if (SCM_EVALFRAMEP (*dframe))
        {
-         size = dframe->status & SCM_MAX_FRAME_SIZE;
-         info = (scm_debug_info *) (*((SCM_STACKITEM **) &dframe->vect[size])
-                                    + offset);
+         scm_t_debug_info * info = RELOC_INFO (dframe->info, offset);
          n += (info - dframe->vect) / 2 + 1;
          /* Data in the apply part of an eval info frame comes from previous
-            stack frame if the scm_debug_info vector is overflowed. */
+            stack frame if the scm_t_debug_info vector is overflowed. */
          if ((((info - dframe->vect) & 1) == 0)
              && SCM_OVERFLOWP (*dframe)
              && !SCM_UNBNDP (info[1].a.proc))
@@ -152,33 +173,27 @@ stack_depth (dframe, offset, maxp)
       else
        ++n;
     }
-  if (dframe)
+  if (dframe && SCM_VOIDFRAMEP (*dframe))
+    *id = dframe->vect[0].id;
+  else if (dframe)
     *maxp = 1;
   return n;
 }
 
 /* Read debug info from DFRAME into IFRAME.
  */
-static void read_frame SCM_P ((scm_debug_frame *dframe, long offset, scm_info_frame *iframe));
 static void
-read_frame (dframe, offset, iframe)
-     scm_debug_frame *dframe;
-     long offset;
-     scm_info_frame *iframe;
+read_frame (scm_t_debug_frame *dframe,long offset,scm_t_info_frame *iframe)
 {
-  SCM flags = SCM_INUM0;
-  int size;
-  scm_debug_info *info;
+  scm_t_bits flags = SCM_UNPACK (SCM_INUM0); /* UGh. */
   if (SCM_EVALFRAMEP (*dframe))
     {
-      size = dframe->status & SCM_MAX_FRAME_SIZE;
-      info = (scm_debug_info *) (*((SCM_STACKITEM **) &dframe->vect[size])
-                                + offset);
+      scm_t_debug_info * info = RELOC_INFO (dframe->info, offset);
       if ((info - dframe->vect) & 1)
        {
          /* Debug.vect ends with apply info. */
          --info;
-         if (info[1].a.proc != SCM_UNDEFINED)
+         if (!SCM_UNBNDP (info[1].a.proc))
            {
              flags |= SCM_FRAMEF_PROC;
              iframe->proc = info[1].a.proc;
@@ -198,100 +213,190 @@ read_frame (dframe, offset, iframe)
   iframe->flags = flags;
 }
 
-/* Fill the scm_info_frame vector IFRAME with data from N stack frames
+/* Look up the first body form of the apply closure.  We'll use this
+   below to prevent it from being displayed.
+*/
+static SCM
+get_applybody ()
+{
+  SCM var = scm_sym2var (scm_sym_apply, SCM_BOOL_F, SCM_BOOL_F);
+  if (SCM_VARIABLEP (var) && SCM_CLOSUREP (SCM_VARIABLE_REF (var)))
+    return SCM_CAR (SCM_CLOSURE_BODY (SCM_VARIABLE_REF (var)));
+  else
+    return SCM_UNDEFINED;
+}
+
+#define NEXT_FRAME(iframe, n, quit) \
+do { \
+  if (SCM_MEMOIZEDP (iframe->source) \
+      && SCM_EQ_P (SCM_MEMOIZED_EXP (iframe->source), applybody)) \
+    { \
+      iframe->source = SCM_BOOL_F; \
+      if (SCM_FALSEP (iframe->proc)) \
+       { \
+         --iframe; \
+         ++n; \
+       } \
+    } \
+  ++iframe; \
+  if (--n == 0) \
+    goto quit; \
+} while (0)
+
+
+/* Fill the scm_t_info_frame vector IFRAME with data from N stack frames
  * starting with the first stack frame represented by debug frame
  * DFRAME.
  */
-static void read_frames SCM_P ((scm_debug_frame *dframe, long offset, int skip, int n, scm_info_frame *iframes));
-static void
-read_frames (dframe, offset, skip, n, iframes)
-     scm_debug_frame *dframe;
-     long offset;
-     int skip;
-     int n;
-     scm_info_frame *iframes;
+
+static scm_t_bits
+read_frames (scm_t_debug_frame *dframe,long offset,long n,scm_t_info_frame *iframes)
 {
-  int size;
-  scm_info_frame *iframe = iframes;
-  scm_debug_info *info;
+  scm_t_info_frame *iframe = iframes;
+  scm_t_debug_info *info;
+  static SCM applybody = SCM_UNDEFINED;
   
+  /* The value of applybody has to be setup after r4rs.scm has executed. */
+  if (SCM_UNBNDP (applybody))
+    applybody = get_applybody ();
   for (;
-       dframe && n > 0;
-       dframe = (scm_debug_frame *) ((SCM_STACKITEM *) dframe->prev + offset))
+       dframe && !SCM_VOIDFRAMEP (*dframe) && n > 0;
+       dframe = RELOC_FRAME (dframe->prev, offset))
     {
       read_frame (dframe, offset, iframe);
       if (SCM_EVALFRAMEP (*dframe))
        {
-         size = dframe->status & SCM_MAX_FRAME_SIZE;
-         info = (scm_debug_info *) (*((SCM_STACKITEM **) &dframe->vect[size])
-                                    + offset);
+         /* If current frame is a macro during expansion, we should
+            skip the previously recorded macro transformer
+            application frame.  */
+         if (SCM_MACROEXPP (*dframe) && iframe > iframes)
+           {
+             *(iframe - 1) = *iframe;
+             --iframe;
+           }
+         info =  RELOC_INFO (dframe->info, offset);
          if ((info - dframe->vect) & 1)
            --info;
          /* Data in the apply part of an eval info frame comes from
-            previous stack frame if the scm_debug_info vector is overflowed. */
+            previous stack frame if the scm_t_debug_info vector is
+            overflowed. */
          else if (SCM_OVERFLOWP (*dframe)
                   && !SCM_UNBNDP (info[1].a.proc))
            {
-             if (skip)
-               --skip;
-             else
-               {
-                 ++iframe;
-                 if (--n == 0)
-                   goto quit;
-               }
-             iframe->flags = SCM_INUM0 | SCM_FRAMEF_PROC;
+             NEXT_FRAME (iframe, n, quit);
+             iframe->flags = SCM_UNPACK(SCM_INUM0) | SCM_FRAMEF_PROC;
              iframe->proc = info[1].a.proc;
              iframe->args = info[1].a.args;
            }
          if (SCM_OVERFLOWP (*dframe))
            iframe->flags |= SCM_FRAMEF_OVERFLOW;
          info -= 2;
-         if (skip)
-           --skip;
-         else
-           {
-             ++iframe;
-             if (--n == 0)
-               goto quit;
-           }
+         NEXT_FRAME (iframe, n, quit);
          while (info >= dframe->vect)
            {
              if (!SCM_UNBNDP (info[1].a.proc))
                {
-                 iframe->flags = SCM_INUM0 | SCM_FRAMEF_PROC;
+                 iframe->flags = SCM_UNPACK(SCM_INUM0) | SCM_FRAMEF_PROC;
                  iframe->proc = info[1].a.proc;
                  iframe->args = info[1].a.args;
                }
              else
-               iframe->flags = SCM_INUM0;
+               iframe->flags = SCM_UNPACK (SCM_INUM0);
              iframe->source = scm_make_memoized (info[0].e.exp,
                                                  info[0].e.env);
              info -= 2;
-             if (skip)
-               --skip;
-             else
-               {
-                 ++iframe;
-                 if (--n == 0)
-                   goto quit;
-               }
+             NEXT_FRAME (iframe, n, quit);
            }
        }
+      else if (SCM_EQ_P (iframe->proc, scm_f_gsubr_apply))
+       /* Skip gsubr apply frames. */
+       continue;
       else
        {
-         if (skip)
-           --skip;
-         else
-           {
-             ++iframe;
-             --n;
-           }
+         NEXT_FRAME (iframe, n, quit);
        }
     quit:
       if (iframe > iframes)
        (iframe - 1) -> flags |= SCM_FRAMEF_REAL;
     }
+  return iframe - iframes;  /* Number of frames actually read */
+}
+
+/* Narrow STACK by cutting away stackframes (mutatingly).
+ *
+ * Inner frames (most recent) are cut by advancing the frames pointer.
+ * Outer frames are cut by decreasing the recorded length.
+ *
+ * Cut maximally INNER inner frames and OUTER outer frames using
+ * the keys INNER_KEY and OUTER_KEY.
+ *
+ * Frames are cut away starting at the end points and moving towards
+ * the center of the stack.  The key is normally compared to the
+ * operator in application frames.  Frames up to and including the key
+ * are cut.
+ *
+ * If INNER_KEY is #t a different scheme is used for inner frames:
+ *
+ * Frames up to but excluding the first source frame originating from
+ * a user module are cut, except for possible application frames
+ * between the user frame and the last system frame previously
+ * encountered.
+ */
+
+static void
+narrow_stack (SCM stack,long inner,SCM inner_key,long outer,SCM outer_key)
+{
+  scm_t_stack *s = SCM_STACK (stack);
+  unsigned long int i;
+  long n = s->length;
+  
+  /* Cut inner part. */
+  if (SCM_EQ_P (inner_key, SCM_BOOL_T))
+    {
+      /* Cut all frames up to user module code */
+      for (i = 0; inner; ++i, --inner)
+       {
+         SCM m = s->frames[i].source;
+         if (SCM_MEMOIZEDP (m)
+             && !SCM_IMP (SCM_MEMOIZED_ENV (m))
+             && SCM_FALSEP (scm_system_module_env_p (SCM_MEMOIZED_ENV (m))))
+           {
+             /* Back up in order to include any non-source frames */
+             while (i > 0)
+               {
+                 m = s->frames[i - 1].source;
+                 if (SCM_MEMOIZEDP (m))
+                   break;
+
+                 m = s->frames[i - 1].proc;
+                 if (!SCM_FALSEP (scm_procedure_p (m))
+                     && !SCM_FALSEP (scm_procedure_property
+                                     (m, scm_sym_system_procedure)))
+                   break;
+
+                 --i;
+                 ++inner;
+               }
+             break;
+           }
+       }
+    }
+  else
+    /* Use standard cutting procedure. */
+    {
+      for (i = 0; inner; --inner)
+       if (SCM_EQ_P (s->frames[i++].proc, inner_key))
+         break;
+    }
+  s->frames = &s->frames[i];
+  n -= i;
+
+  /* Cut outer part. */
+  for (; n && outer; --outer)
+    if (SCM_EQ_P (s->frames[--n].proc, outer_key))
+      break;
+
+  s->length = n;
 }
 
 \f
@@ -299,280 +404,390 @@ read_frames (dframe, offset, skip, n, iframes)
 /* Stacks
  */
 
-SCM_PROC (s_make_stack, "make-stack", 0, 3, 0, scm_make_stack);
-SCM
-scm_make_stack (obj, inner_cut, outer_cut)
-     SCM obj;
-     SCM inner_cut;
-     SCM outer_cut;
+SCM scm_stack_type;
+
+SCM_DEFINE (scm_stack_p, "stack?", 1, 0, 0, 
+            (SCM obj),
+           "Return @code{#t} if @var{obj} is a calling stack.")
+#define FUNC_NAME s_scm_stack_p
 {
-  int i, n, maxp = 0, size;
-  scm_debug_frame *dframe;
-  scm_info_frame *iframe;
+  return SCM_BOOL(SCM_STACKP (obj));
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_make_stack, "make-stack", 1, 0, 1, 
+            (SCM obj, SCM args),
+           "Create a new stack. If @var{obj} is @code{#t}, the current\n"
+           "evaluation stack is used for creating the stack frames,\n"
+           "otherwise the frames are taken from @var{obj} (which must be\n"
+           "either a debug object or a continuation).\n\n"
+           "@var{args} should be a list containing any combination of\n"
+           "integer, procedure and @code{#t} values.\n\n"
+           "These values specify various ways of cutting away uninteresting\n"
+           "stack frames from the top and bottom of the stack that\n"
+           "@code{make-stack} returns.  They come in pairs like this:\n"
+           "@code{(@var{inner_cut_1} @var{outer_cut_1} @var{inner_cut_2}\n"
+           "@var{outer_cut_2} @dots{})}.\n\n"
+           "Each @var{inner_cut_N} can be @code{#t}, an integer, or a\n"
+           "procedure.  @code{#t} means to cut away all frames up to but\n"
+           "excluding the first user module frame.  An integer means to cut\n"
+           "away exactly that number of frames.  A procedure means to cut\n"
+           "away all frames up to but excluding the application frame whose\n"
+           "procedure matches the specified one.\n\n"
+           "Each @var{outer_cut_N} can be an integer or a procedure.  An\n"
+           "integer means to cut away that number of frames.  A procedure\n"
+           "means to cut away frames down to but excluding the application\n"
+           "frame whose procedure matches the specified one.\n\n"
+           "If the @var{outer_cut_N} of the last pair is missing, it is\n"
+           "taken as 0.")
+#define FUNC_NAME s_scm_make_stack
+{
+  long n, size;
+  int maxp;
+  scm_t_debug_frame *dframe;
+  scm_t_info_frame *iframe;
   long offset = 0;
-  SCM stack;
+  SCM stack, id;
+  SCM inner_cut, outer_cut;
 
-  if (SCM_UNBNDP (inner_cut))
-    inner_cut = SCM_INUM0;
-  if (SCM_UNBNDP (outer_cut))
-    outer_cut = SCM_INUM0;
-  SCM_ASSERT (SCM_INUMP (inner_cut), inner_cut, SCM_ARG2, s_make_stack);
-  SCM_ASSERT (SCM_INUMP (outer_cut), outer_cut, SCM_ARG3, s_make_stack);
-  
-  if (SCM_IMP (obj)
-      || (!SCM_DEBUGOBJP (obj) && (scm_tc7_contin != SCM_TYP7 (obj))))
-    dframe = scm_last_debug_frame;
-  else
+  /* Extract a pointer to the innermost frame of whatever object
+     scm_make_stack was given.  */
+  if (SCM_EQ_P (obj, SCM_BOOL_T))
     {
-      SCM_ASSERT (SCM_NIMP (obj), obj, SCM_ARG1, s_make_stack);
-      if (SCM_DEBUGOBJP (obj))
-       dframe = (scm_debug_frame *) SCM_DEBUGOBJ_FRAME (obj);
-      else if (scm_tc7_contin == SCM_TYP7 (obj))
-       {
-         offset = ((SCM_STACKITEM *) (SCM_CHARS (obj) + sizeof (scm_contregs))
-                   - SCM_BASE (obj));
+      dframe = scm_last_debug_frame;
+    }
+  else if (SCM_DEBUGOBJP (obj))
+    {
+      dframe = SCM_DEBUGOBJ_FRAME (obj);
+    }
+  else if (SCM_CONTINUATIONP (obj))
+    {
+      offset = ((SCM_STACKITEM *) ((char *) SCM_CONTREGS (obj) + sizeof (scm_t_contregs))
+               - SCM_BASE (obj));
 #ifndef STACK_GROWS_UP
-         offset += SCM_LENGTH (obj);
+      offset += SCM_CONTINUATION_LENGTH (obj);
 #endif
-         dframe = (scm_debug_frame *) ((SCM_STACKITEM *) SCM_DFRAME (obj)
-                                      + offset);
-       }
-      else scm_wta (obj, (char *) SCM_ARG1, s_make_stack);
+      dframe = RELOC_FRAME (SCM_DFRAME (obj), offset);
+    }
+  else
+    {
+      SCM_WRONG_TYPE_ARG (SCM_ARG1, obj);
+      /* not reached */
     }
 
-  i = SCM_INUM (inner_cut);
-  n = stack_depth (dframe, offset, &maxp) - i - SCM_INUM (outer_cut);
-  if (n < 0)
-    n = 0;
+  /* Count number of frames.  Also get stack id tag and check whether
+     there are more stackframes than we want to record
+     (SCM_BACKTRACE_MAXDEPTH). */
+  id = SCM_BOOL_F;
+  maxp = 0;
+  n = stack_depth (dframe, offset, &id, &maxp);
   size = n * SCM_FRAME_N_SLOTS;
 
-  stack = scm_make_vector (SCM_MAKINUM (size), SCM_BOOL_F, SCM_UNDEFINED);
-  iframe = (scm_info_frame *) SCM_VELTS (stack);
-  read_frames ((scm_debug_frame *) ((SCM_STACKITEM *) dframe + offset),
-              offset,
-              i,
-              n,
-              iframe);
+  /* Make the stack object. */
+  stack = scm_make_struct (scm_stack_type, SCM_MAKINUM (size), SCM_EOL);
+  SCM_STACK (stack) -> id = id;
+  iframe = &SCM_STACK (stack) -> tail[0];
+  SCM_STACK (stack) -> frames = iframe;
+
+  /* Translate the current chain of stack frames into debugging information. */
+  n = read_frames (RELOC_FRAME (dframe, offset), offset, n, iframe);
+  SCM_STACK (stack) -> length = n;
 
-  if (n > 0 && maxp)
-    iframe[n - 1].flags |= SCM_FRAMEF_OVERFLOW;
+  /* Narrow the stack according to the arguments given to scm_make_stack. */
+  SCM_VALIDATE_REST_ARGUMENT (args);
+  while (n > 0 && !SCM_NULLP (args))
+    {
+      inner_cut = SCM_CAR (args);
+      args = SCM_CDR (args);
+      if (SCM_NULLP (args)) 
+       {
+         outer_cut = SCM_INUM0;
+       } 
+      else
+       {
+         outer_cut = SCM_CAR (args);
+         args = SCM_CDR (args);
+       }
+      
+      narrow_stack (stack,
+                   SCM_INUMP (inner_cut) ? SCM_INUM (inner_cut) : n,
+                   SCM_INUMP (inner_cut) ? 0 : inner_cut,
+                   SCM_INUMP (outer_cut) ? SCM_INUM (outer_cut) : n,
+                   SCM_INUMP (outer_cut) ? 0 : outer_cut);
+
+      n = SCM_STACK (stack) -> length;
+    }
   
-  return stack;
+  if (n > 0)
+    {
+      if (maxp)
+       iframe[n - 1].flags |= SCM_FRAMEF_OVERFLOW;
+      return stack;
+    }
+  else
+    return SCM_BOOL_F;
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_stack_id, "stack-id", 1, 0, 0, 
+            (SCM stack),
+           "Return the identifier given to @var{stack} by @code{start-stack}.")
+#define FUNC_NAME s_scm_stack_id
+{
+  scm_t_debug_frame *dframe;
+  long offset = 0;
+  if (SCM_EQ_P (stack, SCM_BOOL_T))
+    {
+      dframe = scm_last_debug_frame;
+    }
+  else if (SCM_DEBUGOBJP (stack))
+    {
+      dframe = SCM_DEBUGOBJ_FRAME (stack);
+    }
+  else if (SCM_CONTINUATIONP (stack))
+    {
+      offset = ((SCM_STACKITEM *) ((char *) SCM_CONTREGS (stack) + sizeof (scm_t_contregs))
+               - SCM_BASE (stack));
+#ifndef STACK_GROWS_UP
+      offset += SCM_CONTINUATION_LENGTH (stack);
+#endif
+      dframe = RELOC_FRAME (SCM_DFRAME (stack), offset);
+    }
+  else if (SCM_STACKP (stack))
+    {
+      return SCM_STACK (stack) -> id;
+    }
+  else
+    {
+      SCM_WRONG_TYPE_ARG (1, stack);
+    }
+
+  while (dframe && !SCM_VOIDFRAMEP (*dframe))
+    dframe = RELOC_FRAME (dframe->prev, offset);
+  if (dframe && SCM_VOIDFRAMEP (*dframe))
+    return dframe->vect[0].id;
+  return SCM_BOOL_F;
 }
+#undef FUNC_NAME
 
-SCM_PROC(s_stack_ref, "stack-ref", 2, 0, 0, scm_stack_ref);
-SCM
-scm_stack_ref (stack, i)
-     SCM stack;
-     SCM i;
+SCM_DEFINE (scm_stack_ref, "stack-ref", 2, 0, 0,
+            (SCM stack, SCM index),
+           "Return the @var{index}'th frame from @var{stack}.")
+#define FUNC_NAME s_scm_stack_ref
 {
-  SCM_ASSERT (SCM_NIMP (stack)
-             && SCM_STACKP (stack),
-             stack,
-             SCM_ARG1,
-             s_stack_ref);
-  SCM_ASSERT (SCM_INUMP (i), i, SCM_ARG2, s_stack_ref);
-  SCM_ASSERT (SCM_INUM (i) >= 0
-             && SCM_INUM (i) < SCM_STACK_LENGTH (stack),
-             i,
-             SCM_OUTOFRANGE,
-             s_stack_ref);
-  return scm_cons (stack, i);
+  unsigned long int c_index;
+
+  SCM_VALIDATE_STACK (1, stack);
+  SCM_VALIDATE_INUM (2, index);
+  SCM_ASSERT_RANGE (1, index, SCM_INUM (index) >= 0);
+  c_index = SCM_INUM (index);
+  SCM_ASSERT_RANGE (1, index, c_index < SCM_STACK_LENGTH (stack));
+  return scm_cons (stack, index);
 }
+#undef FUNC_NAME
 
-SCM_PROC(s_stack_length, "stack-length", 1, 0, 0, scm_stack_length);
-SCM
-scm_stack_length (stack)
-     SCM stack;
+SCM_DEFINE (scm_stack_length, "stack-length", 1, 0, 0, 
+           (SCM stack),
+           "Return the length of @var{stack}.")
+#define FUNC_NAME s_scm_stack_length
 {
-  SCM_ASSERT (SCM_NIMP (stack)
-             && SCM_STACKP (stack),
-             stack,
-             SCM_ARG1,
-             s_stack_length);
+  SCM_VALIDATE_STACK (1,stack);
   return SCM_MAKINUM (SCM_STACK_LENGTH (stack));
 }
+#undef FUNC_NAME
 
 /* Frames
  */
 
-SCM_PROC(s_last_stack_frame, "last-stack-frame", 1, 0, 0, scm_last_stack_frame);
-SCM
-scm_last_stack_frame (obj)
-     SCM obj;
+SCM_DEFINE (scm_frame_p, "frame?", 1, 0, 0, 
+            (SCM obj),
+           "Return @code{#t} if @var{obj} is a stack frame.")
+#define FUNC_NAME s_scm_frame_p
 {
-  scm_debug_frame *dframe;
+  return SCM_BOOL(SCM_FRAMEP (obj));
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_last_stack_frame, "last-stack-frame", 1, 0, 0, 
+           (SCM obj),
+           "Return a stack which consists of a single frame, which is the\n"
+           "last stack frame for @var{obj}. @var{obj} must be either a\n"
+           "debug object or a continuation.")
+#define FUNC_NAME s_scm_last_stack_frame
+{
+  scm_t_debug_frame *dframe;
   long offset = 0;
-  SCM fobj, v;
+  SCM stack;
   
-  SCM_ASSERT (SCM_NIMP (obj), obj, SCM_ARG1, s_last_stack_frame);
   if (SCM_DEBUGOBJP (obj))
-    dframe = (scm_debug_frame *) SCM_DEBUGOBJ_FRAME (obj);
-  else if (scm_tc7_contin == SCM_TYP7 (obj))
     {
-      offset = ((SCM_STACKITEM *) (SCM_CHARS (obj) + sizeof (scm_contregs))
+      dframe = SCM_DEBUGOBJ_FRAME (obj);
+    }
+  else if (SCM_CONTINUATIONP (obj))
+    {
+      offset = ((SCM_STACKITEM *) ((char *) SCM_CONTREGS (obj) + sizeof (scm_t_contregs))
                - SCM_BASE (obj));
 #ifndef STACK_GROWS_UP
-      offset += SCM_LENGTH (obj);
+      offset += SCM_CONTINUATION_LENGTH (obj);
 #endif
-      dframe = (scm_debug_frame *) ((SCM_STACKITEM *) SCM_DFRAME (obj) + offset);
+      dframe = RELOC_FRAME (SCM_DFRAME (obj), offset);
+    }
+  else
+    {
+      SCM_WRONG_TYPE_ARG (1, obj);
+      /* not reached */
     }
-  else scm_wta (obj, (char *) SCM_ARG1, s_last_stack_frame);
   
-  if (!dframe)
+  if (!dframe || SCM_VOIDFRAMEP (*dframe))
     return SCM_BOOL_F;
 
-  v = scm_make_vector (SCM_MAKINUM (SCM_FRAME_N_SLOTS),
-                      SCM_BOOL_F,
-                      SCM_UNDEFINED);
-
-  SCM_NEWCELL (fobj);
-  SCM_DEFER_INTS;
-  SCM_SETCAR (fobj, v);
-  SCM_SETCDR (fobj, SCM_INUM0);
-  SCM_ALLOW_INTS;
-  
-  read_frame (dframe, offset, (scm_info_frame *) SCM_VELTS (v));
+  stack = scm_make_struct (scm_stack_type, SCM_MAKINUM (SCM_FRAME_N_SLOTS),
+                          SCM_EOL);
+  SCM_STACK (stack) -> length = 1;
+  SCM_STACK (stack) -> frames = &SCM_STACK (stack) -> tail[0];
+  read_frame (dframe, offset,
+             (scm_t_info_frame *) &SCM_STACK (stack) -> frames[0]);
   
-  return fobj;
+  return scm_cons (stack, SCM_INUM0);
 }
+#undef FUNC_NAME
 
-SCM_PROC(s_frame_number, "frame-number", 1, 0, 0, scm_frame_number);
-SCM
-scm_frame_number (frame)
-     SCM frame;
+SCM_DEFINE (scm_frame_number, "frame-number", 1, 0, 0, 
+           (SCM frame),
+           "Return the frame number of @var{frame}.")
+#define FUNC_NAME s_scm_frame_number
 {
-  SCM_ASSERT (SCM_NIMP (frame) && SCM_FRAMEP (frame),
-             frame,
-             SCM_ARG1,
-             s_frame_number);
+  SCM_VALIDATE_FRAME (1,frame);
   return SCM_MAKINUM (SCM_FRAME_NUMBER (frame));
 }
+#undef FUNC_NAME
 
-SCM_PROC(s_frame_source, "frame-source", 1, 0, 0, scm_frame_source);
-SCM
-scm_frame_source (frame)
-     SCM frame;
+SCM_DEFINE (scm_frame_source, "frame-source", 1, 0, 0, 
+           (SCM frame),
+           "Return the source of @var{frame}.")
+#define FUNC_NAME s_scm_frame_source
 {
-  SCM_ASSERT (SCM_NIMP (frame) && SCM_FRAMEP (frame),
-             frame,
-             SCM_ARG1,
-             s_frame_source);
+  SCM_VALIDATE_FRAME (1,frame);
   return SCM_FRAME_SOURCE (frame);
 }
+#undef FUNC_NAME
 
-SCM_PROC(s_frame_procedure, "frame-procedure", 1, 0, 0, scm_frame_procedure);
-SCM
-scm_frame_procedure (frame)
-     SCM frame;
+SCM_DEFINE (scm_frame_procedure, "frame-procedure", 1, 0, 0, 
+           (SCM frame),
+           "Return the procedure for @var{frame}, or @code{#f} if no\n"
+           "procedure is associated with @var{frame}.")
+#define FUNC_NAME s_scm_frame_procedure
 {
-  SCM_ASSERT (SCM_NIMP (frame) && SCM_FRAMEP (frame),
-             frame,
-             SCM_ARG1,
-             s_frame_procedure);
+  SCM_VALIDATE_FRAME (1,frame);
   return (SCM_FRAME_PROC_P (frame)
-         ? SCM_BOOL_F
-         : SCM_FRAME_PROC (frame));
+         ? SCM_FRAME_PROC (frame)
+         : SCM_BOOL_F);
 }
+#undef FUNC_NAME
 
-SCM_PROC(s_frame_arguments, "frame-arguments", 1, 0, 0, scm_frame_arguments);
-SCM
-scm_frame_arguments (frame)
-     SCM frame;
+SCM_DEFINE (scm_frame_arguments, "frame-arguments", 1, 0, 0, 
+           (SCM frame),
+           "Return the arguments of @var{frame}.")
+#define FUNC_NAME s_scm_frame_arguments
 {
-  SCM_ASSERT (SCM_NIMP (frame) && SCM_FRAMEP (frame),
-             frame,
-             SCM_ARG1,
-             s_frame_arguments);
+  SCM_VALIDATE_FRAME (1,frame);
   return SCM_FRAME_ARGS (frame);
 }
+#undef FUNC_NAME
 
-SCM_PROC(s_frame_previous, "frame-previous", 1, 0, 0, scm_frame_previous);
-SCM
-scm_frame_previous (frame)
-     SCM frame;
+SCM_DEFINE (scm_frame_previous, "frame-previous", 1, 0, 0, 
+           (SCM frame),
+           "Return the previous frame of @var{frame}, or @code{#f} if\n"
+           "@var{frame} is the first frame in its stack.")
+#define FUNC_NAME s_scm_frame_previous
 {
-  int n;
-  SCM_ASSERT (SCM_NIMP (frame) && SCM_FRAMEP (frame),
-             frame,
-             SCM_ARG1,
-             s_frame_previous);
+  unsigned long int n;
+  SCM_VALIDATE_FRAME (1, frame);
   n = SCM_INUM (SCM_CDR (frame)) + 1;
   if (n >= SCM_STACK_LENGTH (SCM_CAR (frame)))
     return SCM_BOOL_F;
   else
     return scm_cons (SCM_CAR (frame), SCM_MAKINUM (n));
 }
+#undef FUNC_NAME
 
-SCM_PROC(s_frame_next, "frame-next", 1, 0, 0, scm_frame_next);
-SCM
-scm_frame_next (frame)
-     SCM frame;
+SCM_DEFINE (scm_frame_next, "frame-next", 1, 0, 0, 
+           (SCM frame),
+           "Return the next frame of @var{frame}, or @code{#f} if\n"
+           "@var{frame} is the last frame in its stack.")
+#define FUNC_NAME s_scm_frame_next
 {
-  int n;
-  SCM_ASSERT (SCM_NIMP (frame) && SCM_FRAMEP (frame),
-             frame,
-             SCM_ARG1,
-             s_frame_next);
-  n = SCM_INUM (SCM_CDR (frame)) - 1;
-  if (n < 0)
+  unsigned long int n;
+  SCM_VALIDATE_FRAME (1, frame);
+  n = SCM_INUM (SCM_CDR (frame));
+  if (n == 0)
     return SCM_BOOL_F;
   else
-    return scm_cons (SCM_CAR (frame), SCM_MAKINUM (n));
+    return scm_cons (SCM_CAR (frame), SCM_MAKINUM (n - 1));
 }
+#undef FUNC_NAME
 
-SCM_PROC(s_frame_real_p, "frame-real?", 1, 0, 0, scm_frame_real_p);
-SCM
-scm_frame_real_p (frame)
-     SCM frame;
+SCM_DEFINE (scm_frame_real_p, "frame-real?", 1, 0, 0, 
+           (SCM frame),
+           "Return @code{#t} if @var{frame} is a real frame.")
+#define FUNC_NAME s_scm_frame_real_p
 {
-  SCM_ASSERT (SCM_NIMP (frame) && SCM_FRAMEP (frame),
-             frame,
-             SCM_ARG1,
-             s_frame_real_p);
-  return SCM_FRAME_REAL_P (frame) ? SCM_BOOL_T : SCM_BOOL_F;
+  SCM_VALIDATE_FRAME (1,frame);
+  return SCM_BOOL(SCM_FRAME_REAL_P (frame));
 }
+#undef FUNC_NAME
 
-SCM_PROC(s_frame_procedure_p, "frame-procedure?", 1, 0, 0, scm_frame_procedure_p);
-SCM
-scm_frame_procedure_p (frame)
-     SCM frame;
+SCM_DEFINE (scm_frame_procedure_p, "frame-procedure?", 1, 0, 0, 
+           (SCM frame),
+           "Return @code{#t} if a procedure is associated with @var{frame}.")
+#define FUNC_NAME s_scm_frame_procedure_p
 {
-  SCM_ASSERT (SCM_NIMP (frame) && SCM_FRAMEP (frame),
-             frame,
-             SCM_ARG1,
-             s_frame_procedure_p);
-  return SCM_FRAME_PROC_P (frame) ? SCM_BOOL_T : SCM_BOOL_F;
+  SCM_VALIDATE_FRAME (1,frame);
+  return SCM_BOOL(SCM_FRAME_PROC_P (frame));
 }
+#undef FUNC_NAME
 
-SCM_PROC(s_frame_evaluating_args_p, "frame-evaluating-args?", 1, 0, 0, scm_frame_evaluating_args_p);
-SCM
-scm_frame_evaluating_args_p (frame)
-     SCM frame;
+SCM_DEFINE (scm_frame_evaluating_args_p, "frame-evaluating-args?", 1, 0, 0, 
+           (SCM frame),
+           "Return @code{#t} if @var{frame} contains evaluated arguments.")
+#define FUNC_NAME s_scm_frame_evaluating_args_p
 {
-  SCM_ASSERT (SCM_NIMP (frame) && SCM_FRAMEP (frame),
-             frame,
-             SCM_ARG1,
-             s_frame_evaluating_args_p);
-  return SCM_FRAME_EVAL_ARGS_P (frame) ? SCM_BOOL_T : SCM_BOOL_F;
+  SCM_VALIDATE_FRAME (1,frame);
+  return SCM_BOOL(SCM_FRAME_EVAL_ARGS_P (frame));
 }
+#undef FUNC_NAME
 
-SCM_PROC(s_frame_overflow_p, "frame-overflow?", 1, 0, 0, scm_frame_overflow_p);
-SCM
-scm_frame_overflow_p (frame)
-     SCM frame;
+SCM_DEFINE (scm_frame_overflow_p, "frame-overflow?", 1, 0, 0, 
+           (SCM frame),
+           "Return @code{#t} if @var{frame} is an overflow frame.")
+#define FUNC_NAME s_scm_frame_overflow_p
 {
-  SCM_ASSERT (SCM_NIMP (frame) && SCM_FRAMEP (frame),
-             frame,
-             SCM_ARG1,
-             s_frame_overflow_p);
-  return SCM_FRAME_OVERFLOW_P (frame) ? SCM_BOOL_T : SCM_BOOL_F;
+  SCM_VALIDATE_FRAME (1,frame);
+  return SCM_BOOL(SCM_FRAME_OVERFLOW_P (frame));
 }
+#undef FUNC_NAME
 
 \f
 
 void
 scm_init_stacks ()
 {
-#include "stacks.x"
+  SCM vtable;
+  SCM stack_layout
+    = scm_make_struct_layout (scm_makfrom0str (SCM_STACK_LAYOUT));
+  vtable = scm_make_vtable_vtable (scm_nullstr, SCM_INUM0, SCM_EOL);
+  scm_stack_type
+    = scm_permanent_object (scm_make_struct (vtable, SCM_INUM0,
+                                            scm_cons (stack_layout,
+                                                      SCM_EOL)));
+  scm_set_struct_vtable_name_x (scm_stack_type, scm_str2symbol ("stack"));
+#ifndef SCM_MAGIC_SNARFER
+#include "libguile/stacks.x"
+#endif
 }
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/