summaryrefslogtreecommitdiff
path: root/doc/ref/scheme-control.texi
diff options
context:
space:
mode:
authorMarius Vollmer <mvo@zagadka.de>2004-01-06 18:17:17 +0000
committerMarius Vollmer <mvo@zagadka.de>2004-01-06 18:17:17 +0000
commitbecc4b2716b6d7a108ae8170eb20f730302f0585 (patch)
treed79124d6f613b4e49f71ec8430315d421f7e3c38 /doc/ref/scheme-control.texi
parentc05d0e8f1e2a20b021669125953209922d900c56 (diff)
downloadguile-becc4b2716b6d7a108ae8170eb20f730302f0585.tar.gz
Document scm_on_unwind_with_scm and scm_on_rewind_with_scm.
Diffstat (limited to 'doc/ref/scheme-control.texi')
-rw-r--r--doc/ref/scheme-control.texi14
1 files changed, 11 insertions, 3 deletions
diff --git a/doc/ref/scheme-control.texi b/doc/ref/scheme-control.texi
index af574e90a..023fdb9b7 100644
--- a/doc/ref/scheme-control.texi
+++ b/doc/ref/scheme-control.texi
@@ -1156,24 +1156,32 @@ This is an enumeration of several flags that modify the behavior of
the following table.
@table @code
-@item SCM_F_WIND_EXPLICITELY
+@item SCM_F_WIND_EXPLICITLY
The registered action is also carried out when the frame is entered or
left locally.
@end table
@end deftp
@deftypefn {C Function} void scm_on_unwind (void (*func)(void *), void *data, scm_t_wind_flags flags)
+@deftypefnx {C Function} void scm_on_unwind_with_scm (void (*func)(SCM), SCM data, scm_t_wind_flags flags)
Arranges for @var{func} to be called with @var{data} as its arguments
when the current frame ends implicitly. If @var{flags} contains
-@code{SCM_F_WIND_EXPLICITELY}, @var{func} is also called when the frame
+@code{SCM_F_WIND_EXPLICITLY}, @var{func} is also called when the frame
ends explicitly with @code{scm_end_frame}.
+
+The function @code{scm_on_unwind_with_scm} takes care that @var{data}
+is protected from garbage collected.
@end deftypefn
@deftypefn {C Function} void scm_on_rewind (void (*func)(void *), void *data, scm_t_wind_flags flags)
+@deftypefnx {C Function} void scm_on_rewind_with_scm (void (*func)(SCM), SCM data, scm_t_wind_flags flags)
Arrange for @var{func} to be called with @var{data} as its argument when
the current frame is restarted by rewinding the stack. When @var{flags}
-contains @code{SCM_F_WIND_EXPLICITELY}, @var{func} is called immediately
+contains @code{SCM_F_WIND_EXPLICITLY}, @var{func} is called immediately
as well.
+
+The function @code{scm_on_rewind_with_scm} takes care that @var{data}
+is protected from garbage collected.
@end deftypefn