The FSF has a new address.
[bpt/guile.git] / libguile / continuations.h
dissimilarity index 89%
index d107f87..ce19917 100644 (file)
-/* classes: h_files */
-
-#ifndef CONTINUATIONSH
-#define CONTINUATIONSH
-/*     Copyright (C) 1995,1996, 2000 Free Software Foundation, Inc.
- * 
- * 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
- * the Free Software Foundation; either version 2, or (at your option)
- * any later version.
- * 
- * This program 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 General Public License for more details.
- * 
- * 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, 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.
- *
- * The exception is that, if you link the GUILE library with other files
- * to produce an executable, this does not by itself cause the
- * resulting executable to be covered by the GNU General Public License.
- * Your use of that executable is in no way restricted on account of
- * linking the GUILE library code into it.
- *
- * This exception does not however invalidate any other reasons why
- * the executable file might be covered by the GNU General Public License.
- *
- * This exception applies only to the code released by the
- * Free Software Foundation under the name GUILE.  If you copy
- * code from other Free Software Foundation releases into a copy of
- * GUILE, as the General Public License permits, the exception does
- * not apply to the code that you add in this way.  To avoid misleading
- * anyone as to the status of such modified files, you must delete
- * this exception notice from them.
- *
- * If you write modifications of your own for GUILE, it is your choice
- * whether to permit this exception to apply to your modifications.
- * If you do not wish that, delete this exception notice.  */
-\f
-#include "libguile/__scm.h"
-
-\f
-
-typedef struct 
-{
-  SCM throw_value;
-  jmp_buf jmpbuf;
-  SCM dynenv;
-  SCM_STACKITEM *base;
-  unsigned long seq;
-
-#ifdef DEBUG_EXTENSIONS
-  struct scm_debug_frame *dframe;
-#endif
-} scm_contregs;
-
-
-#define SCM_CONTREGS(x)                ((scm_contregs *) SCM_CELL_WORD_1 (x))   
-#define SCM_SET_CONTREGS(x, r) (SCM_SET_CELL_WORD_1 ((x), (scm_bits_t) (r))) 
-#define SCM_CONTINUATION_LENGTH(x) (((unsigned long) SCM_CELL_WORD_0 (x)) >> 8)
-#define SCM_SET_CONTINUATION_LENGTH(x, l) (SCM_SET_CELL_WORD_0 ((x), ((l) << 8) + scm_tc7_contin))
-
-#define SCM_JMPBUF(x)          ((SCM_CONTREGS (x))->jmpbuf)
-#define SCM_DYNENV(x)          ((SCM_CONTREGS (x))->dynenv)
-#define SCM_THROW_VALUE(x)     ((SCM_CONTREGS (x))->throw_value)
-#define SCM_BASE(x)            ((SCM_CONTREGS (x))->base) 
-#define SCM_SEQ(x)             ((SCM_CONTREGS (x))->seq)   
-#define SCM_DFRAME(x)          ((SCM_CONTREGS (x))->dframe)
-
-\f
-
-extern SCM scm_make_cont (SCM * answer);
-extern SCM scm_call_continuation (SCM cont, SCM val);
-extern void scm_init_continuations (void);
-
-\f
-
-#if (SCM_DEBUG_DEPRECATED == 0)
-
-#define SCM_SETJMPBUF(x, r) (SCM_SET_CONTREGS ((x), (r)))
-
-#endif  /* SCM_DEBUG_DEPRECATED == 0 */
-
-#endif  /* CONTINUATIONSH */
-
-/*
-  Local Variables:
-  c-file-style: "gnu"
-  End:
-*/
+/* classes: h_files */
+
+#ifndef SCM_CONTINUATIONS_H
+#define SCM_CONTINUATIONS_H
+
+/* Copyright (C) 1995,1996,2000,2001 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+\f
+
+#include "libguile/__scm.h"
+
+#ifdef __ia64__
+#include <signal.h>
+#include <ucontext.h>
+extern unsigned long * __libc_ia64_register_backing_store_base;
+#endif /* __ia64__ */
+\f
+
+/* a continuation SCM is a non-immediate pointing to a heap cell with:
+   word 0: bits 0-15: smob type tag: scm_tc16_continuation.
+           bits 16-31: unused.
+   word 1: malloc block containing an scm_t_contregs structure with a
+           tail array of SCM_STACKITEM.  the size of the array is stored
+          in the num_stack_items field of the structure.
+*/
+
+SCM_API scm_t_bits scm_tc16_continuation;
+
+typedef struct 
+{
+  SCM throw_value;
+  jmp_buf jmpbuf;
+  SCM dynenv;
+#ifdef __ia64__
+  ucontext_t ctx;
+  void *backing_store;
+  unsigned long backing_store_size;
+#endif /* __ia64__ */
+  size_t num_stack_items;   /* size of the saved stack.  */
+  SCM root;                 /* continuation root identifier.  */
+
+  /* The offset from the live stack location to this copy.  This is
+     used to adjust pointers from within the copied stack to the stack
+     itself.
+
+     Thus, when you read a pointer from the copied stack that points
+     into the live stack, you need to add OFFSET so that it points
+     into the copy.
+  */
+  scm_t_ptrdiff offset;
+
+  /* The most recently created debug frame on the live stack, before
+     it was saved.  This needs to be adjusted with OFFSET, above.
+  */
+  struct scm_t_debug_frame *dframe;
+
+  SCM_STACKITEM stack[1];    /* copied stack of size num_stack_items.  */ 
+} scm_t_contregs;
+
+#define SCM_CONTINUATIONP(x)   SCM_TYP16_PREDICATE (scm_tc16_continuation, x)
+
+#define SCM_CONTREGS(x)                ((scm_t_contregs *) SCM_CELL_WORD_1 (x))
+
+#define SCM_CONTINUATION_LENGTH(x) (SCM_CONTREGS (x)->num_stack_items)
+#define SCM_SET_CONTINUATION_LENGTH(x, n)\
+   (SCM_CONTREGS (x)->num_stack_items = (n))
+#define SCM_JMPBUF(x)           ((SCM_CONTREGS (x))->jmpbuf)
+#define SCM_DYNENV(x)           ((SCM_CONTREGS (x))->dynenv)
+#define SCM_THROW_VALUE(x)      ((SCM_CONTREGS (x))->throw_value)
+#define SCM_CONTINUATION_ROOT(x) ((SCM_CONTREGS (x))->root)   
+#define SCM_DFRAME(x)           ((SCM_CONTREGS (x))->dframe)
+
+\f
+
+SCM_API SCM scm_make_continuation (int *first);
+
+SCM_API void *scm_c_with_continuation_barrier (void *(*func)(void*), void *);
+SCM_API SCM scm_with_continuation_barrier (SCM proc);
+
+SCM_API SCM scm_i_with_continuation_barrier (scm_t_catch_body body,
+                                            void *body_data,
+                                            scm_t_catch_handler handler,
+                                            void *handler_data);
+
+SCM_API void scm_init_continuations (void);
+
+#endif  /* SCM_CONTINUATIONS_H */
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/