From 46732b5441d3a4056fdde7f933d40b2f16f5eebf Mon Sep 17 00:00:00 2001 From: Gary Houston Date: Tue, 9 Jul 2002 22:40:03 +0000 Subject: [PATCH] * dynl.c (scm_dynamic_call): docstring editing. --- doc/maint/guile.texi | 25 ++++++++++++++++--------- doc/ref/new-docstrings.texi | 12 +++++++++++- doc/ref/scheme-modules.texi | 25 ++++++++++++++++--------- libguile/ChangeLog | 4 ++++ libguile/dynl.c | 25 ++++++++++++++++--------- 5 files changed, 63 insertions(+), 28 deletions(-) diff --git a/doc/maint/guile.texi b/doc/maint/guile.texi index ed7576b51..84a4c1c8f 100644 --- a/doc/maint/guile.texi +++ b/doc/maint/guile.texi @@ -493,18 +493,25 @@ needed or not and will add it when necessary. dynamic-call @deffn {Scheme Procedure} dynamic-call func dobj @deffnx {C Function} scm_dynamic_call (func, dobj) -Call the C function indicated by @var{func} and @var{dobj}. -The function is passed no arguments and its return value is -ignored. When @var{function} is something returned by -@code{dynamic-func}, call that function and ignore @var{dobj}. -When @var{func} is a string , look it up in @var{dynobj}; this -is equivalent to +Call a C function in a dynamic object. Two styles of +invocation are supported: + +@itemize @bullet +@item @var{func} can be a function handle returned by +@code{dynamic-func}. In this case @var{dobj} is +ignored +@item @var{func} can be a string with the name of the +function to call, with @var{dobj} the handle of the +dynamic object in which to find the function. +This is equivalent to @smallexample -(dynamic-call (dynamic-func @var{func} @var{dobj} #f)) + +(dynamic-call (dynamic-func @var{func} @var{dobj}) #f) @end smallexample +@end itemize -Interrupts are deferred while the C function is executing (with -@code{SCM_DEFER_INTS}/@code{SCM_ALLOW_INTS}). +In either case, the function is passed no arguments +and its return value is ignored. @end deffn dynamic-args-call diff --git a/doc/ref/new-docstrings.texi b/doc/ref/new-docstrings.texi index 2180561a6..17aa45680 100644 --- a/doc/ref/new-docstrings.texi +++ b/doc/ref/new-docstrings.texi @@ -412,7 +412,7 @@ from the arguments @var{initargs}. @end deffn @deffn {Scheme Procedure} slot-exists? obj slot_name -@deffnx {C Function} scm_slots_exists_p (obj, slot_name) +@deffnx {C Function} scm_slot_exists_p (obj, slot_name) Return @code{#t} if @var{obj} has a slot named @var{slot_name}. @end deffn @@ -689,3 +689,13 @@ implemented by the C function "scm_single_thread_p" Return an integer that for the lifetime of @var{obj} is uniquely returned by this function for @var{obj} @end deffn + +@deffn {Scheme Procedure} nan +@deffnx {C Function} scm_nan () +Return NaN. +@end deffn + +@deffn {Scheme Procedure} inf +@deffnx {C Function} scm_inf () +Return Inf. +@end deffn diff --git a/doc/ref/scheme-modules.texi b/doc/ref/scheme-modules.texi index 75b739647..032330973 100644 --- a/doc/ref/scheme-modules.texi +++ b/doc/ref/scheme-modules.texi @@ -542,18 +542,25 @@ needed or not and will add it when necessary. @deffn {Scheme Procedure} dynamic-call func dobj @deffnx {C Function} scm_dynamic_call (func, dobj) -Call the C function indicated by @var{func} and @var{dobj}. -The function is passed no arguments and its return value is -ignored. When @var{function} is something returned by -@code{dynamic-func}, call that function and ignore @var{dobj}. -When @var{func} is a string , look it up in @var{dynobj}; this -is equivalent to +Call a C function in a dynamic object. Two styles of +invocation are supported: + +@itemize @bullet +@item @var{func} can be a function handle returned by +@code{dynamic-func}. In this case @var{dobj} is +ignored +@item @var{func} can be a string with the name of the +function to call, with @var{dobj} the handle of the +dynamic object in which to find the function. +This is equivalent to @smallexample -(dynamic-call (dynamic-func @var{func} @var{dobj} #f)) + +(dynamic-call (dynamic-func @var{func} @var{dobj}) #f) @end smallexample +@end itemize -Interrupts are deferred while the C function is executing (with -@code{SCM_DEFER_INTS}/@code{SCM_ALLOW_INTS}). +In either case, the function is passed no arguments +and its return value is ignored. @end deffn @deffn {Scheme Procedure} dynamic-args-call func dobj args diff --git a/libguile/ChangeLog b/libguile/ChangeLog index 6aaad7db1..c347f3225 100644 --- a/libguile/ChangeLog +++ b/libguile/ChangeLog @@ -1,3 +1,7 @@ +2002-07-09 Gary Houston + + * dynl.c (scm_dynamic_call): docstring editing. + 2002-07-08 Rob Browning * gc_os_dep.c: HURD fixes. diff --git a/libguile/dynl.c b/libguile/dynl.c index de4ee6ca0..4d90827cb 100644 --- a/libguile/dynl.c +++ b/libguile/dynl.c @@ -284,15 +284,22 @@ SCM_DEFINE (scm_dynamic_func, "dynamic-func", 2, 0, 0, SCM_DEFINE (scm_dynamic_call, "dynamic-call", 2, 0, 0, (SCM func, SCM dobj), - "Call the C function indicated by @var{func} and @var{dobj}.\n" - "The function is passed no arguments and its return value is\n" - "ignored. When @var{function} is something returned by\n" - "@code{dynamic-func}, call that function and ignore @var{dobj}.\n" - "When @var{func} is a string , look it up in @var{dynobj}; this\n" - "is equivalent to\n" - "@smallexample\n" - "(dynamic-call (dynamic-func @var{func} @var{dobj} #f))\n" - "@end smallexample\n\n") + "Call a C function in a dynamic object. Two styles of\n" + "invocation are supported:\n\n" + "@itemize @bullet\n" + "@item @var{func} can be a function handle returned by\n" + "@code{dynamic-func}. In this case @var{dobj} is\n" + "ignored\n" + "@item @var{func} can be a string with the name of the\n" + "function to call, with @var{dobj} the handle of the\n" + "dynamic object in which to find the function.\n" + "This is equivalent to\n" + "@smallexample\n\n" + "(dynamic-call (dynamic-func @var{func} @var{dobj}) #f)\n" + "@end smallexample\n" + "@end itemize\n\n" + "In either case, the function is passed no arguments\n" + "and its return value is ignored.") #define FUNC_NAME s_scm_dynamic_call { void (*fptr) (); -- 2.20.1