mirror/guile
mirror/guile
1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-30 00:40:20 +02:00
Code Activity

Document scm_on_unwind_with_scm and scm_on_rewind_with_scm.

Browse source
This commit is contained in:
Marius Vollmer 2004-01-06 18:17:17 +00:00
parent c05d0e8f1e
commit becc4b2716
1 changed files with 11 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

14
doc/ref/scheme-control.texi
View file

@ -1156,24 +1156,32 @@ This is an enumeration of several flags that modify the behavior of
the following table. the following table.
@table @code @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 The registered action is also carried out when the frame is entered or
left locally. left locally.
@end table @end table
@end deftp @end deftp
@deftypefn {C Function} void scm_on_unwind (void (*func)(void *), void *data, scm_t_wind_flags flags) @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 Arranges for @var{func} to be called with @var{data} as its arguments
when the current frame ends implicitly. If @var{flags} contains 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}. 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 @end deftypefn
@deftypefn {C Function} void scm_on_rewind (void (*func)(void *), void *data, scm_t_wind_flags flags) @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 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} 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. as well.
The function @code{scm_on_rewind_with_scm} takes care that @var{data}
is protected from garbage collected.
@end deftypefn @end deftypefn