summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNeil Jerram <neil@ossau.uklinux.net>2002-03-15 14:03:53 +0000
committerNeil Jerram <neil@ossau.uklinux.net>2002-03-15 14:03:53 +0000
commit198586ed746e9a0288a443cb1c0b335e244461b9 (patch)
tree9c502f34575ef4854a46c4b139a01e4f86b338ed
parenta6d344d3475e5e2731ef62bac34626b875273d79 (diff)
downloadguile-198586ed746e9a0288a443cb1c0b335e244461b9.tar.gz
Manual updates.
-rw-r--r--doc/maint/ChangeLog4
-rw-r--r--doc/maint/guile.texi764
-rw-r--r--doc/ref/ChangeLog14
-rw-r--r--doc/ref/guile.texi31
-rw-r--r--doc/ref/new-docstrings.texi4
-rwxr-xr-xdoc/ref/scheme-data.texi6
-rw-r--r--doc/ref/scheme-debug.texi2
-rw-r--r--doc/ref/scheme-io.texi2
-rw-r--r--doc/ref/scheme-memory.texi4
-rw-r--r--doc/ref/scheme-procedures.texi4
-rw-r--r--doc/ref/scheme-utility.texi156
-rw-r--r--doc/ref/scripts.texi1
12 files changed, 193 insertions, 799 deletions
diff --git a/doc/maint/ChangeLog b/doc/maint/ChangeLog
index 013a5377d..a01af41b7 100644
--- a/doc/maint/ChangeLog
+++ b/doc/maint/ChangeLog
@@ -1,3 +1,7 @@
+2002-03-15 Neil Jerram <neil@ossau.uklinux.net>
+
+ * guile.texi: Replaced by regenerated libguile version.
+
2002-03-12 Neil Jerram <neil@ossau.uklinux.net>
* guile.texi: Replaced by regenerated libguile version.
diff --git a/doc/maint/guile.texi b/doc/maint/guile.texi
index 516591987..ed7576b51 100644
--- a/doc/maint/guile.texi
+++ b/doc/maint/guile.texi
@@ -1,6 +1,5 @@
acons
-@c snarfed from alist.c:59
@deffn {Scheme Procedure} acons key value alist
@deffnx {C Function} scm_acons (key, value, alist)
Add a new key-value pair to @var{alist}. A new pair is
@@ -10,7 +9,6 @@ function is @emph{not} destructive; @var{alist} is not modified.
@end deffn
sloppy-assq
-@c snarfed from alist.c:73
@deffn {Scheme Procedure} sloppy-assq key alist
@deffnx {C Function} scm_sloppy_assq (key, alist)
Behaves like @code{assq} but does not do any error checking.
@@ -18,7 +16,6 @@ Recommended only for use in Guile internals.
@end deffn
sloppy-assv
-@c snarfed from alist.c:91
@deffn {Scheme Procedure} sloppy-assv key alist
@deffnx {C Function} scm_sloppy_assv (key, alist)
Behaves like @code{assv} but does not do any error checking.
@@ -26,7 +23,6 @@ Recommended only for use in Guile internals.
@end deffn
sloppy-assoc
-@c snarfed from alist.c:109
@deffn {Scheme Procedure} sloppy-assoc key alist
@deffnx {C Function} scm_sloppy_assoc (key, alist)
Behaves like @code{assoc} but does not do any error checking.
@@ -34,7 +30,6 @@ Recommended only for use in Guile internals.
@end deffn
assq
-@c snarfed from alist.c:136
@deffn {Scheme Procedure} assq key alist
@deffnx {Scheme Procedure} assv key alist
@deffnx {Scheme Procedure} assoc key alist
@@ -49,21 +44,18 @@ return the entire alist entry found (i.e. both the key and the value).
@end deffn
assv
-@c snarfed from alist.c:157
@deffn {Scheme Procedure} assv key alist
@deffnx {C Function} scm_assv (key, alist)
Behaves like @code{assq} but uses @code{eqv?} for key comparison.
@end deffn
assoc
-@c snarfed from alist.c:178
@deffn {Scheme Procedure} assoc key alist
@deffnx {C Function} scm_assoc (key, alist)
Behaves like @code{assq} but uses @code{equal?} for key comparison.
@end deffn
assq-ref
-@c snarfed from alist.c:222
@deffn {Scheme Procedure} assq-ref alist key
@deffnx {Scheme Procedure} assv-ref alist key
@deffnx {Scheme Procedure} assoc-ref alist key
@@ -81,21 +73,18 @@ where @var{associator} is one of @code{assq}, @code{assv} or @code{assoc}.
@end deffn
assv-ref
-@c snarfed from alist.c:239
@deffn {Scheme Procedure} assv-ref alist key
@deffnx {C Function} scm_assv_ref (alist, key)
Behaves like @code{assq-ref} but uses @code{eqv?} for key comparison.
@end deffn
assoc-ref
-@c snarfed from alist.c:256
@deffn {Scheme Procedure} assoc-ref alist key
@deffnx {C Function} scm_assoc_ref (alist, key)
Behaves like @code{assq-ref} but uses @code{equal?} for key comparison.
@end deffn
assq-set!
-@c snarfed from alist.c:285
@deffn {Scheme Procedure} assq-set! alist key val
@deffnx {Scheme Procedure} assv-set! alist key value
@deffnx {Scheme Procedure} assoc-set! alist key value
@@ -111,21 +100,18 @@ association list.
@end deffn
assv-set!
-@c snarfed from alist.c:303
@deffn {Scheme Procedure} assv-set! alist key val
@deffnx {C Function} scm_assv_set_x (alist, key, val)
Behaves like @code{assq-set!} but uses @code{eqv?} for key comparison.
@end deffn
assoc-set!
-@c snarfed from alist.c:321
@deffn {Scheme Procedure} assoc-set! alist key val
@deffnx {C Function} scm_assoc_set_x (alist, key, val)
Behaves like @code{assq-set!} but uses @code{equal?} for key comparison.
@end deffn
assq-remove!
-@c snarfed from alist.c:345
@deffn {Scheme Procedure} assq-remove! alist key
@deffnx {Scheme Procedure} assv-remove! alist key
@deffnx {Scheme Procedure} assoc-remove! alist key
@@ -135,21 +121,18 @@ the resulting alist.
@end deffn
assv-remove!
-@c snarfed from alist.c:361
@deffn {Scheme Procedure} assv-remove! alist key
@deffnx {C Function} scm_assv_remove_x (alist, key)
Behaves like @code{assq-remove!} but uses @code{eqv?} for key comparison.
@end deffn
assoc-remove!
-@c snarfed from alist.c:377
@deffn {Scheme Procedure} assoc-remove! alist key
@deffnx {C Function} scm_assoc_remove_x (alist, key)
Behaves like @code{assq-remove!} but uses @code{equal?} for key comparison.
@end deffn
make-arbiter
-@c snarfed from arbiters.c:82
@deffn {Scheme Procedure} make-arbiter name
@deffnx {C Function} scm_make_arbiter (name)
Return an object of type arbiter and name @var{name}. Its
@@ -158,7 +141,6 @@ process synchronization.
@end deffn
try-arbiter
-@c snarfed from arbiters.c:92
@deffn {Scheme Procedure} try-arbiter arb
@deffnx {C Function} scm_try_arbiter (arb)
Return @code{#t} and lock the arbiter @var{arb} if the arbiter
@@ -166,7 +148,6 @@ was unlocked. Otherwise, return @code{#f}.
@end deffn
release-arbiter
-@c snarfed from arbiters.c:113
@deffn {Scheme Procedure} release-arbiter arb
@deffnx {C Function} scm_release_arbiter (arb)
Return @code{#t} and unlock the arbiter @var{arb} if the
@@ -174,14 +155,12 @@ arbiter was locked. Otherwise, return @code{#f}.
@end deffn
async
-@c snarfed from async.c:289
@deffn {Scheme Procedure} async thunk
@deffnx {C Function} scm_async (thunk)
Create a new async for the procedure @var{thunk}.
@end deffn
system-async
-@c snarfed from async.c:299
@deffn {Scheme Procedure} system-async thunk
@deffnx {C Function} scm_system_async (thunk)
Create a new async for the procedure @var{thunk}. Also
@@ -189,28 +168,24 @@ add it to the system's list of active async objects.
@end deffn
async-mark
-@c snarfed from async.c:310
@deffn {Scheme Procedure} async-mark a
@deffnx {C Function} scm_async_mark (a)
Mark the async @var{a} for future execution.
@end deffn
system-async-mark
-@c snarfed from async.c:326
@deffn {Scheme Procedure} system-async-mark a
@deffnx {C Function} scm_system_async_mark (a)
Mark the async @var{a} for future execution.
@end deffn
run-asyncs
-@c snarfed from async.c:351
@deffn {Scheme Procedure} run-asyncs list_of_a
@deffnx {C Function} scm_run_asyncs (list_of_a)
Execute all thunks from the asyncs of the list @var{list_of_a}.
@end deffn
noop
-@c snarfed from async.c:385
@deffn {Scheme Procedure} noop . args
@deffnx {C Function} scm_noop (args)
Do nothing. When called without arguments, return @code{#f},
@@ -218,26 +193,23 @@ otherwise return the first argument.
@end deffn
unmask-signals
-@c snarfed from async.c:437
@deffn {Scheme Procedure} unmask-signals
@deffnx {C Function} scm_unmask_signals ()
Unmask signals. The returned value is not specified.
@end deffn
mask-signals
-@c snarfed from async.c:448
@deffn {Scheme Procedure} mask-signals
@deffnx {C Function} scm_mask_signals ()
Mask signals. The returned value is not specified.
@end deffn
display-error
-@c snarfed from backtrace.c:266
@deffn {Scheme Procedure} display-error stack port subr message args rest
@deffnx {C Function} scm_display_error (stack, port, subr, message, args, rest)
Display an error message to the output port @var{port}.
@var{stack} is the saved stack for the error, @var{subr} is
-the name of the procedure in which the error occured and
+the name of the procedure in which the error occurred and
@var{message} is the actual error message, which may contain
formatting instructions. These will format the arguments in
the list @var{args} accordingly. @var{rest} is currently
@@ -245,7 +217,6 @@ ignored.
@end deffn
display-application
-@c snarfed from backtrace.c:402
@deffn {Scheme Procedure} display-application frame [port [indent]]
@deffnx {C Function} scm_display_application (frame, port, indent)
Display a procedure application @var{frame} to the output port
@@ -254,7 +225,6 @@ output.
@end deffn
display-backtrace
-@c snarfed from backtrace.c:713
@deffn {Scheme Procedure} display-backtrace stack port [first [depth]]
@deffnx {C Function} scm_display_backtrace (stack, port, first, depth)
Display a backtrace to the output port @var{port}. @var{stack}
@@ -265,7 +235,6 @@ which means that default values will be used.
@end deffn
backtrace
-@c snarfed from backtrace.c:736
@deffn {Scheme Procedure} backtrace
@deffnx {C Function} scm_backtrace ()
Display a backtrace of the stack saved by the last error
@@ -273,97 +242,83 @@ to the current output port.
@end deffn
not
-@c snarfed from boolean.c:55
@deffn {Scheme Procedure} not x
@deffnx {C Function} scm_not (x)
Return @code{#t} iff @var{x} is @code{#f}, else return @code{#f}.
@end deffn
boolean?
-@c snarfed from boolean.c:65
@deffn {Scheme Procedure} boolean? obj
@deffnx {C Function} scm_boolean_p (obj)
Return @code{#t} iff @var{obj} is either @code{#t} or @code{#f}.
@end deffn
char?
-@c snarfed from chars.c:54
@deffn {Scheme Procedure} char? x
@deffnx {C Function} scm_char_p (x)
Return @code{#t} iff @var{x} is a character, else @code{#f}.
@end deffn
char=?
-@c snarfed from chars.c:63
@deffn {Scheme Procedure} char=? x y
Return @code{#t} iff @var{x} is the same character as @var{y}, else @code{#f}.
@end deffn
char<?
-@c snarfed from chars.c:76
@deffn {Scheme Procedure} char<? x y
Return @code{#t} iff @var{x} is less than @var{y} in the ASCII sequence,
else @code{#f}.
@end deffn
char<=?
-@c snarfed from chars.c:88
@deffn {Scheme Procedure} char<=? x y
Return @code{#t} iff @var{x} is less than or equal to @var{y} in the
ASCII sequence, else @code{#f}.
@end deffn
char>?
-@c snarfed from chars.c:100
@deffn {Scheme Procedure} char>? x y
Return @code{#t} iff @var{x} is greater than @var{y} in the ASCII
sequence, else @code{#f}.
@end deffn
char>=?
-@c snarfed from chars.c:112
@deffn {Scheme Procedure} char>=? x y
Return @code{#t} iff @var{x} is greater than or equal to @var{y} in the
ASCII sequence, else @code{#f}.
@end deffn
char-ci=?
-@c snarfed from chars.c:124
@deffn {Scheme Procedure} char-ci=? x y
Return @code{#t} iff @var{x} is the same character as @var{y} ignoring
case, else @code{#f}.
@end deffn
char-ci<?
-@c snarfed from chars.c:136
@deffn {Scheme Procedure} char-ci<? x y
Return @code{#t} iff @var{x} is less than @var{y} in the ASCII sequence
ignoring case, else @code{#f}.
@end deffn
char-ci<=?
-@c snarfed from chars.c:148
@deffn {Scheme Procedure} char-ci<=? x y
Return @code{#t} iff @var{x} is less than or equal to @var{y} in the
ASCII sequence ignoring case, else @code{#f}.
@end deffn
char-ci>?
-@c snarfed from chars.c:160
@deffn {Scheme Procedure} char-ci>? x y
Return @code{#t} iff @var{x} is greater than @var{y} in the ASCII
sequence ignoring case, else @code{#f}.
@end deffn
char-ci>=?
-@c snarfed from chars.c:172
@deffn {Scheme Procedure} char-ci>=? x y
Return @code{#t} iff @var{x} is greater than or equal to @var{y} in the
ASCII sequence ignoring case, else @code{#f}.
@end deffn
char-alphabetic?
-@c snarfed from chars.c:185
@deffn {Scheme Procedure} char-alphabetic? chr
@deffnx {C Function} scm_char_alphabetic_p (chr)
Return @code{#t} iff @var{chr} is alphabetic, else @code{#f}.
@@ -371,7 +326,6 @@ Alphabetic means the same thing as the isalpha C library function.
@end deffn
char-numeric?
-@c snarfed from chars.c:196
@deffn {Scheme Procedure} char-numeric? chr
@deffnx {C Function} scm_char_numeric_p (chr)
Return @code{#t} iff @var{chr} is numeric, else @code{#f}.
@@ -379,7 +333,6 @@ Numeric means the same thing as the isdigit C library function.
@end deffn
char-whitespace?
-@c snarfed from chars.c:207
@deffn {Scheme Procedure} char-whitespace? chr
@deffnx {C Function} scm_char_whitespace_p (chr)
Return @code{#t} iff @var{chr} is whitespace, else @code{#f}.
@@ -387,7 +340,6 @@ Whitespace means the same thing as the isspace C library function.
@end deffn
char-upper-case?
-@c snarfed from chars.c:220
@deffn {Scheme Procedure} char-upper-case? chr
@deffnx {C Function} scm_char_upper_case_p (chr)
Return @code{#t} iff @var{chr} is uppercase, else @code{#f}.
@@ -395,7 +347,6 @@ Uppercase means the same thing as the isupper C library function.
@end deffn
char-lower-case?
-@c snarfed from chars.c:232
@deffn {Scheme Procedure} char-lower-case? chr
@deffnx {C Function} scm_char_lower_case_p (chr)
Return @code{#t} iff @var{chr} is lowercase, else @code{#f}.
@@ -403,7 +354,6 @@ Lowercase means the same thing as the islower C library function.
@end deffn
char-is-both?
-@c snarfed from chars.c:246
@deffn {Scheme Procedure} char-is-both? chr
@deffnx {C Function} scm_char_is_both_p (chr)
Return @code{#t} iff @var{chr} is either uppercase or lowercase, else @code{#f}.
@@ -412,7 +362,6 @@ C library functions.
@end deffn
char->integer
-@c snarfed from chars.c:260
@deffn {Scheme Procedure} char->integer chr
@deffnx {C Function} scm_char_to_integer (chr)
Return the number corresponding to ordinal position of @var{chr} in the
@@ -420,86 +369,74 @@ ASCII sequence.
@end deffn
integer->char
-@c snarfed from chars.c:272
@deffn {Scheme Procedure} integer->char n
@deffnx {C Function} scm_integer_to_char (n)
Return the character at position @var{n} in the ASCII sequence.
@end deffn
char-upcase
-@c snarfed from chars.c:283
@deffn {Scheme Procedure} char-upcase chr
@deffnx {C Function} scm_char_upcase (chr)
Return the uppercase character version of @var{chr}.
@end deffn
char-downcase
-@c snarfed from chars.c:294
@deffn {Scheme Procedure} char-downcase chr
@deffnx {C Function} scm_char_downcase (chr)
Return the lowercase character version of @var{chr}.
@end deffn
debug-options-interface
-@c snarfed from debug.c:79
@deffn {Scheme Procedure} debug-options-interface [setting]
@deffnx {C Function} scm_debug_options (setting)
Option interface for the debug options. Instead of using
this procedure directly, use the procedures @code{debug-enable},
-@code{debug-disable}, @code{debug-set!} and @var{debug-options}.
+@code{debug-disable}, @code{debug-set!} and @code{debug-options}.
@end deffn
with-traps
-@c snarfed from debug.c:127
@deffn {Scheme Procedure} with-traps thunk
@deffnx {C Function} scm_with_traps (thunk)
Call @var{thunk} with traps enabled.
@end deffn
memoized?
-@c snarfed from debug.c:169
@deffn {Scheme Procedure} memoized? obj
@deffnx {C Function} scm_memoized_p (obj)
Return @code{#t} if @var{obj} is memoized.
@end deffn
unmemoize
-@c snarfed from debug.c:333
@deffn {Scheme Procedure} unmemoize m
@deffnx {C Function} scm_unmemoize (m)
Unmemoize the memoized expression @var{m},
@end deffn
memoized-environment
-@c snarfed from debug.c:343
@deffn {Scheme Procedure} memoized-environment m
@deffnx {C Function} scm_memoized_environment (m)
Return the environment of the memoized expression @var{m}.
@end deffn
procedure-name
-@c snarfed from debug.c:353
@deffn {Scheme Procedure} procedure-name proc
@deffnx {C Function} scm_procedure_name (proc)
Return the name of the procedure @var{proc}
@end deffn
procedure-source
-@c snarfed from debug.c:379
@deffn {Scheme Procedure} procedure-source proc
@deffnx {C Function} scm_procedure_source (proc)
Return the source of the procedure @var{proc}.
@end deffn
procedure-environment
-@c snarfed from debug.c:412
@deffn {Scheme Procedure} procedure-environment proc
@deffnx {C Function} scm_procedure_environment (proc)
Return the environment of the procedure @var{proc}.
@end deffn
local-eval
-@c snarfed from debug.c:444
@deffn {Scheme Procedure} local-eval exp [env]
@deffnx {C Function} scm_local_eval (exp, env)
Evaluate @var{exp} in its environment. If @var{env} is supplied,
@@ -509,14 +446,12 @@ is implicit).
@end deffn
debug-object?
-@c snarfed from debug.c:531
@deffn {Scheme Procedure} debug-object? obj
@deffnx {C Function} scm_debug_object_p (obj)
Return @code{#t} if @var{obj} is a debug object.
@end deffn
dynamic-link
-@c snarfed from dynl.c:266
@deffn {Scheme Procedure} dynamic-link filename
@deffnx {C Function} scm_dynamic_link (filename)
Open the dynamic library called @var{filename}. A library
@@ -526,7 +461,6 @@ functions.
@end deffn
dynamic-object?
-@c snarfed from dynl.c:281
@deffn {Scheme Procedure} dynamic-object? obj
@deffnx {C Function} scm_dynamic_object_p (obj)
Return @code{#t} if @var{obj} is a dynamic library handle, or @code{#f}
@@ -534,7 +468,6 @@ otherwise.
@end deffn
dynamic-unlink
-@c snarfed from dynl.c:294
@deffn {Scheme Procedure} dynamic-unlink dobj
@deffnx {C Function} scm_dynamic_unlink (dobj)
Unlink the indicated object file from the application. The
@@ -544,7 +477,6 @@ called on @var{dobj}, its content is no longer accessible.
@end deffn
dynamic-func
-@c snarfed from dynl.c:321
@deffn {Scheme Procedure} dynamic-func name dobj
@deffnx {C Function} scm_dynamic_func (name, dobj)
Search the dynamic object @var{dobj} for the C function
@@ -559,7 +491,6 @@ needed or not and will add it when necessary.
@end deffn
dynamic-call
-@c snarfed from dynl.c:360
@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}.
@@ -577,7 +508,6 @@ Interrupts are deferred while the C function is executing (with
@end deffn
dynamic-args-call
-@c snarfed from dynl.c:388
@deffn {Scheme Procedure} dynamic-args-call func dobj args
@deffnx {C Function} scm_dynamic_args_call (func, dobj, args)
Call the C function indicated by @var{func} and @var{dobj},
@@ -596,7 +526,6 @@ converted to a Scheme number and returned from the call to
@end deffn
dynamic-wind
-@c snarfed from dynwind.c:119
@deffn {Scheme Procedure} dynamic-wind in_guard thunk out_guard
@deffnx {C Function} scm_dynamic_wind (in_guard, thunk, out_guard)
All three arguments must be 0-argument procedures.
@@ -650,7 +579,6 @@ a-cont
@end deffn
environment?
-@c snarfed from environments.c:129
@deffn {Scheme Procedure} environment? obj
@deffnx {C Function} scm_environment_p (obj)
Return @code{#t} if @var{obj} is an environment, or @code{#f}
@@ -658,7 +586,6 @@ otherwise.
@end deffn
environment-bound?
-@c snarfed from environments.c:140
@deffn {Scheme Procedure} environment-bound? env sym
@deffnx {C Function} scm_environment_bound_p (env, sym)
Return @code{#t} if @var{sym} is bound in @var{env}, or
@@ -666,7 +593,6 @@ Return @code{#t} if @var{sym} is bound in @var{env}, or
@end deffn
environment-ref
-@c snarfed from environments.c:155
@deffn {Scheme Procedure} environment-ref env sym
@deffnx {C Function} scm_environment_ref (env, sym)
Return the value of the location bound to @var{sym} in
@@ -675,7 +601,6 @@ Return the value of the location bound to @var{sym} in
@end deffn
environment-fold
-@c snarfed from environments.c:225
@deffn {Scheme Procedure} environment-fold env proc init
@deffnx {C Function} scm_environment_fold (env, proc, init)
Iterate over all the bindings in @var{env}, accumulating some
@@ -712,7 +637,6 @@ using environment-fold:
@end deffn
environment-define
-@c snarfed from environments.c:260
@deffn {Scheme Procedure} environment-define env sym val
@deffnx {C Function} scm_environment_define (env, sym, val)
Bind @var{sym} to a new location containing @var{val} in
@@ -725,7 +649,6 @@ immutable, signal an @code{environment:immutable-binding} error.
@end deffn
environment-undefine
-@c snarfed from environments.c:286
@deffn {Scheme Procedure} environment-undefine env sym
@deffnx {C Function} scm_environment_undefine (env, sym)
Remove any binding for @var{sym} from @var{env}. If @var{sym}
@@ -736,7 +659,6 @@ immutable, signal an @code{environment:immutable-binding} error.
@end deffn
environment-set!
-@c snarfed from environments.c:314
@deffn {Scheme Procedure} environment-set! env sym val
@deffnx {C Function} scm_environment_set_x (env, sym, val)
If @var{env} binds @var{sym} to some location, change that
@@ -749,7 +671,6 @@ to an immutable location, signal an
@end deffn
environment-cell
-@c snarfed from environments.c:349
@deffn {Scheme Procedure} environment-cell env sym for_write
@deffnx {C Function} scm_environment_cell (env, sym, for_write)
Return the value cell which @var{env} binds to @var{sym}, or
@@ -767,7 +688,6 @@ re-bound to a new value cell, or becomes undefined.
@end deffn
environment-observe
-@c snarfed from environments.c:401
@deffn {Scheme Procedure} environment-observe env proc
@deffnx {C Function} scm_environment_observe (env, proc)
Whenever @var{env}'s bindings change, apply @var{proc} to
@@ -779,7 +699,6 @@ token is unspecified.
@end deffn
environment-observe-weak
-@c snarfed from environments.c:418
@deffn {Scheme Procedure} environment-observe-weak env proc
@deffnx {C Function} scm_environment_observe_weak (env, proc)
This function is the same as environment-observe, except that
@@ -791,7 +710,6 @@ list of observing procedures.
@end deffn
environment-unobserve
-@c snarfed from environments.c:454
@deffn {Scheme Procedure} environment-unobserve token
@deffnx {C Function} scm_environment_unobserve (token)
Cancel the observation request which returned the value
@@ -803,7 +721,6 @@ bindings change.
@end deffn
make-leaf-environment
-@c snarfed from environments.c:1031
@deffn {Scheme Procedure} make-leaf-environment
@deffnx {C Function} scm_make_leaf_environment ()
Create a new leaf environment, containing no bindings.
@@ -812,7 +729,6 @@ will be mutable.
@end deffn
leaf-environment?
-@c snarfed from environments.c:1054
@deffn {Scheme Procedure} leaf-environment? object
@deffnx {C Function} scm_leaf_environment_p (object)
Return @code{#t} if object is a leaf environment, or @code{#f}
@@ -820,7 +736,6 @@ otherwise.
@end deffn
make-eval-environment
-@c snarfed from environments.c:1419
@deffn {Scheme Procedure} make-eval-environment local imported
@deffnx {C Function} scm_make_eval_environment (local, imported)
Return a new environment object eval whose bindings are the
@@ -847,7 +762,6 @@ In typical use, @var{local} will be a finite environment, and
@end deffn
eval-environment?
-@c snarfed from environments.c:1456
@deffn {Scheme Procedure} eval-environment? object
@deffnx {C Function} scm_eval_environment_p (object)
Return @code{#t} if object is an eval environment, or @code{#f}
@@ -855,35 +769,30 @@ otherwise.
@end deffn
eval-environment-local
-@c snarfed from environments.c:1466
@deffn {Scheme Procedure} eval-environment-local env
@deffnx {C Function} scm_eval_environment_local (env)
Return the local environment of eval environment @var{env}.
@end deffn
eval-environment-set-local!
-@c snarfed from environments.c:1478
@deffn {Scheme Procedure} eval-environment-set-local! env local
@deffnx {C Function} scm_eval_environment_set_local_x (env, local)
Change @var{env}'s local environment to @var{local}.
@end deffn
eval-environment-imported
-@c snarfed from environments.c:1504
@deffn {Scheme Procedure} eval-environment-imported env
@deffnx {C Function} scm_eval_environment_imported (env)
Return the imported environment of eval environment @var{env}.
@end deffn
eval-environment-set-imported!
-@c snarfed from environments.c:1516
@deffn {Scheme Procedure} eval-environment-set-imported! env imported
@deffnx {C Function} scm_eval_environment_set_imported_x (env, imported)
Change @var{env}'s imported environment to @var{imported}.
@end deffn
make-import-environment
-@c snarfed from environments.c:1839
@deffn {Scheme Procedure} make-import-environment imports conflict_proc
@deffnx {C Function} scm_make_import_environment (imports, conflict_proc)
Return a new environment @var{imp} whose bindings are the union
@@ -914,7 +823,6 @@ if one of its imported environments changes.
@end deffn
import-environment?
-@c snarfed from environments.c:1868
@deffn {Scheme Procedure} import-environment? object
@deffnx {C Function} scm_import_environment_p (object)
Return @code{#t} if object is an import environment, or
@@ -922,7 +830,6 @@ Return @code{#t} if object is an import environment, or
@end deffn
import-environment-imports
-@c snarfed from environments.c:1879
@deffn {Scheme Procedure} import-environment-imports env
@deffnx {C Function} scm_import_environment_imports (env)
Return the list of environments imported by the import
@@ -930,7 +837,6 @@ environment @var{env}.
@end deffn
import-environment-set-imports!
-@c snarfed from environments.c:1892
@deffn {Scheme Procedure} import-environment-set-imports! env imports
@deffnx {C Function} scm_import_environment_set_imports_x (env, imports)
Change @var{env}'s list of imported environments to
@@ -938,7 +844,6 @@ Change @var{env}'s list of imported environments to
@end deffn
make-export-environment
-@c snarfed from environments.c:2159
@deffn {Scheme Procedure} make-export-environment private signature
@deffnx {C Function} scm_make_export_environment (private, signature)
Return a new environment @var{exp} containing only those
@@ -988,7 +893,6 @@ if the bindings in private change.
@end deffn
export-environment?
-@c snarfed from environments.c:2194
@deffn {Scheme Procedure} export-environment? object
@deffnx {C Function} scm_export_environment_p (object)
Return @code{#t} if object is an export environment, or
@@ -996,35 +900,30 @@ Return @code{#t} if object is an export environment, or
@end deffn
export-environment-private
-@c snarfed from environments.c:2204
@deffn {Scheme Procedure} export-environment-private env
@deffnx {C Function} scm_export_environment_private (env)
Return the private environment of export environment @var{env}.
@end deffn
export-environment-set-private!
-@c snarfed from environments.c:2216
@deffn {Scheme Procedure} export-environment-set-private! env private
@deffnx {C Function} scm_export_environment_set_private_x (env, private)
Change the private environment of export environment @var{env}.
@end deffn
export-environment-signature
-@c snarfed from environments.c:2238
@deffn {Scheme Procedure} export-environment-signature env
@deffnx {C Function} scm_export_environment_signature (env)
Return the signature of export environment @var{env}.
@end deffn
export-environment-set-signature!
-@c snarfed from environments.c:2312
@deffn {Scheme Procedure} export-environment-set-signature! env signature
@deffnx {C Function} scm_export_environment_set_signature_x (env, signature)
Change the signature of export environment @var{env}.
@end deffn
eq?
-@c snarfed from eq.c:62
@deffn {Scheme Procedure} eq? x y
Return @code{#t} iff @var{x} references the same object as @var{y}.
@code{eq?} is similar to @code{eqv?} except that in some cases it is
@@ -1033,7 +932,6 @@ capable of discerning distinctions finer than those detectable by
@end deffn
eqv?
-@c snarfed from eq.c:76
@deffn {Scheme Procedure} eqv? x y
The @code{eqv?} procedure defines a useful equivalence relation on objects.
Briefly, it returns @code{#t} if @var{x} and @var{y} should normally be
@@ -1043,7 +941,6 @@ and inexact numbers.
@end deffn
equal?
-@c snarfed from eq.c:125
@deffn {Scheme Procedure} equal? x y
Return @code{#t} iff @var{x} and @var{y} are recursively @code{eqv?} equivalent.
@code{equal?} recursively compares the contents of pairs,
@@ -1054,7 +951,6 @@ terminate if its arguments are circular data structures.
@end deffn
scm-error
-@c snarfed from error.c:117
@deffn {Scheme Procedure} scm-error key subr message args data
@deffnx {C Function} scm_error_scm (key, subr, message, args, data)
Raise an error with key @var{key}. @var{subr} can be a string
@@ -1073,7 +969,6 @@ it will usually be @code{#f}.
@end deffn
strerror
-@c snarfed from error.c:168
@deffn {Scheme Procedure} strerror err
@deffnx {C Function} scm_strerror (err)
Return the Unix error message corresponding to @var{err}, which
@@ -1081,7 +976,6 @@ must be an integer value.
@end deffn
apply:nconc2last
-@c snarfed from eval.c:3485
@deffn {Scheme Procedure} apply:nconc2last lst
@deffnx {C Function} scm_nconc2last (lst)
Given a list (@var{arg1} @dots{} @var{args}), this function
@@ -1094,7 +988,6 @@ destroys its argument, so use with care.
@end deffn
force
-@c snarfed from eval.c:4021
@deffn {Scheme Procedure} force x
@deffnx {C Function} scm_force (x)
If the promise @var{x} has not been computed yet, compute and
@@ -1103,7 +996,6 @@ value.
@end deffn
promise?
-@c snarfed from eval.c:4044
@deffn {Scheme Procedure} promise? obj
@deffnx {C Function} scm_promise_p (obj)
Return true if @var{obj} is a promise, i.e. a delayed computation
@@ -1111,7 +1003,6 @@ Return true if @var{obj} is a promise, i.e. a delayed computation
@end deffn
cons-source
-@c snarfed from eval.c:4056
@deffn {Scheme Procedure} cons-source xorig x y
@deffnx {C Function} scm_cons_source (xorig, x, y)
Create and return a new pair whose car and cdr are @var{x} and @var{y}.
@@ -1120,7 +1011,6 @@ with the new pair.
@end deffn
copy-tree
-@c snarfed from eval.c:4076
@deffn {Scheme Procedure} copy-tree obj
@deffnx {C Function} scm_copy_tree (obj)
Recursively copy the data tree that is bound to @var{obj}, and return a
@@ -1131,7 +1021,6 @@ any other object.
@end deffn
primitive-eval
-@c snarfed from eval.c:4169
@deffn {Scheme Procedure} primitive-eval exp
@deffnx {C Function} scm_primitive_eval (exp)
Evaluate @var{exp} in the top-level environment specified by
@@ -1139,7 +1028,6 @@ the current module.
@end deffn
eval
-@c snarfed from eval.c:4238
@deffn {Scheme Procedure} eval exp module
@deffnx {C Function} scm_eval (exp, module)
Evaluate @var{exp}, a list representing a Scheme expression,
@@ -1150,36 +1038,31 @@ is reset to its previous value when @var{eval} returns.
@end deffn
eval-options-interface
-@c snarfed from eval.c:1782
@deffn {Scheme Procedure} eval-options-interface [setting]
@deffnx {C Function} scm_eval_options_interface (setting)
Option interface for the evaluation options. Instead of using
this procedure directly, use the procedures @code{eval-enable},
-@code{eval-disable}, @code{eval-set!} and @var{eval-options}.
+@code{eval-disable}, @code{eval-set!} and @code{eval-options}.
@end deffn
evaluator-traps-interface
-@c snarfed from eval.c:1799
@deffn {Scheme Procedure} evaluator-traps-interface [setting]
@deffnx {C Function} scm_evaluator_traps (setting)
Option interface for the evaluator trap options.
@end deffn
defined?
-@c snarfed from evalext.c:75
@deffn {Scheme Procedure} defined? sym [env]
@deffnx {C Function} scm_definedp (sym, env)
Return @code{#t} if @var{sym} is defined in the lexical environment @var{env}. When @var{env} is not specified, look in the top-level environment as defined by the current module.
@end deffn
map-in-order
-@c snarfed from evalext.c:144
@deffn {Scheme Procedure} map-in-order
implemented by the C function "scm_map"
@end deffn
load-extension
-@c snarfed from extensions.c:152
@deffn {Scheme Procedure} load-extension lib init
@deffnx {C Function} scm_load_extension (lib, init)
Load and initialize the extension designated by LIB and INIT.
@@ -1219,7 +1102,6 @@ well. For example,
@end deffn
program-arguments
-@c snarfed from feature.c:77
@deffn {Scheme Procedure} program-arguments
@deffnx {Scheme Procedure} command-line
@deffnx {C Function} scm_program_arguments ()
@@ -1230,7 +1112,6 @@ options like @code{-e} and @code{-l}.
@end deffn
make-fluid
-@c snarfed from fluids.c:124
@deffn {Scheme Procedure} make-fluid
@deffnx {C Function} scm_make_fluid ()
Return a newly created fluid.
@@ -1243,7 +1124,6 @@ in its own dynamic root, you can use fluids for thread local storage.
@end deffn
fluid?
-@c snarfed from fluids.c:137
@deffn {Scheme Procedure} fluid? obj
@deffnx {C Function} scm_fluid_p (obj)
Return @code{#t} iff @var{obj} is a fluid; otherwise, return
@@ -1251,7 +1131,6 @@ Return @code{#t} iff @var{obj} is a fluid; otherwise, return
@end deffn
fluid-ref
-@c snarfed from fluids.c:148
@deffn {Scheme Procedure} fluid-ref fluid
@deffnx {C Function} scm_fluid_ref (fluid)
Return the value associated with @var{fluid} in the current
@@ -1260,14 +1139,12 @@ dynamic root. If @var{fluid} has not been set, then return
@end deffn
fluid-set!
-@c snarfed from fluids.c:164
@deffn {Scheme Procedure} fluid-set! fluid value
@deffnx {C Function} scm_fluid_set_x (fluid, value)
Set the value associated with @var{fluid} in the current dynamic root.
@end deffn
with-fluids*
-@c snarfed from fluids.c:223
@deffn {Scheme Procedure} with-fluids* fluids values thunk
@deffnx {C Function} scm_with_fluids (fluids, values, thunk)
Set @var{fluids} to @var{values} temporary, and call @var{thunk}.
@@ -1277,7 +1154,6 @@ one after another. @var{thunk} must be a procedure with no argument.
@end deffn
setvbuf
-@c snarfed from fports.c:156
@deffn {Scheme Procedure} setvbuf port mode [size]
@deffnx {C Function} scm_setvbuf (port, mode, size)
Set the buffering mode for @var{port}. @var{mode} can be:
@@ -1293,14 +1169,12 @@ If @var{size} is omitted, a default size will be used.
@end deffn
file-port?
-@c snarfed from fports.c:245
@deffn {Scheme Procedure} file-port? obj
@deffnx {C Function} scm_file_port_p (obj)
Determine whether @var{obj} is a port that is related to a file.
@end deffn
open-file
-@c snarfed from fports.c:299
@deffn {Scheme Procedure} open-file filename mode
@deffnx {C Function} scm_open_file (filename, mode)
Open the file whose name is @var{filename}, and return a port
@@ -1343,7 +1217,6 @@ requested, @code{open-file} throws an exception.
@end deffn
gc-stats
-@c snarfed from gc.c:735
@deffn {Scheme Procedure} gc-stats
@deffnx {C Function} scm_gc_stats ()
Return an association list of statistics about Guile's current
@@ -1351,7 +1224,6 @@ use of storage.
@end deffn
object-address
-@c snarfed from gc.c:832
@deffn {Scheme Procedure} object-address obj
@deffnx {C Function} scm_object_address (obj)
Return an integer that for the lifetime of @var{obj} is uniquely
@@ -1359,7 +1231,6 @@ returned by this function for @var{obj}
@end deffn
gc
-@c snarfed from gc.c:843
@deffn {Scheme Procedure} gc
@deffnx {C Function} scm_gc ()
Scans all of SCM objects and reclaims for further use those that are
@@ -1367,7 +1238,6 @@ no longer accessible.
@end deffn
%compute-slots
-@c snarfed from goops.c:291
@deffn {Scheme Procedure} %compute-slots class
@deffnx {C Function} scm_sys_compute_slots (class)
Return a list consisting of the names of all slots belonging to
@@ -1376,7 +1246,6 @@ its superclasses.
@end deffn
get-keyword
-@c snarfed from goops.c:376
@deffn {Scheme Procedure} get-keyword key l default_value
@deffnx {C Function} scm_get_keyword (key, l, default_value)
Determine an associated value for the keyword @var{key} from
@@ -1388,7 +1257,6 @@ If @var{l} does not hold a value for @var{key}, the value
@end deffn
%initialize-object
-@c snarfed from goops.c:399
@deffn {Scheme Procedure} %initialize-object obj initargs
@deffnx {C Function} scm_sys_initialize_object (obj, initargs)
Initialize the object @var{obj} with the given arguments
@@ -1396,147 +1264,126 @@ Initialize the object @var{obj} with the given arguments
@end deffn
%prep-layout!
-@c snarfed from goops.c:479
@deffn {Scheme Procedure} %prep-layout! class
@deffnx {C Function} scm_sys_prep_layout_x (class)
@end deffn
%inherit-magic!
-@c snarfed from goops.c:556
@deffn {Scheme Procedure} %inherit-magic! class dsupers
@deffnx {C Function} scm_sys_inherit_magic_x (class, dsupers)
@end deffn
instance?
-@c snarfed from goops.c:799
@deffn {Scheme Procedure} instance? obj
@deffnx {C Function} scm_instance_p (obj)
Return @code{#t} if @var{obj} is an instance.
@end deffn
class-name
-@c snarfed from goops.c:814
@deffn {Scheme Procedure} class-name obj
@deffnx {C Function} scm_class_name (obj)
Return the class name of @var{obj}.
@end deffn
class-direct-supers
-@c snarfed from goops.c:824
@deffn {Scheme Procedure} class-direct-supers obj
@deffnx {C Function} scm_class_direct_supers (obj)
Return the direct superclasses of the class @var{obj}.
@end deffn
class-direct-slots
-@c snarfed from goops.c:834
@deffn {Scheme Procedure} class-direct-slots obj
@deffnx {C Function} scm_class_direct_slots (obj)
Return the direct slots of the class @var{obj}.
@end deffn
class-direct-subclasses
-@c snarfed from goops.c:844
@deffn {Scheme Procedure} class-direct-subclasses obj
@deffnx {C Function} scm_class_direct_subclasses (obj)
Return the direct subclasses of the class @var{obj}.
@end deffn
class-direct-methods
-@c snarfed from goops.c:854
@deffn {Scheme Procedure} class-direct-methods obj
@deffnx {C Function} scm_class_direct_methods (obj)
Return the direct methods of the class @var{obj}
@end deffn
class-precedence-list
-@c snarfed from goops.c:864
@deffn {Scheme Procedure} class-precedence-list obj
@deffnx {C Function} scm_class_precedence_list (obj)
Return the class precedence list of the class @var{obj}.
@end deffn
class-slots
-@c snarfed from goops.c:874
@deffn {Scheme Procedure} class-slots obj
@deffnx {C Function} scm_class_slots (obj)
Return the slot list of the class @var{obj}.
@end deffn
class-environment
-@c snarfed from goops.c:884
@deffn {Scheme Procedure} class-environment obj
@deffnx {C Function} scm_class_environment (obj)
Return the environment of the class @var{obj}.
@end deffn
generic-function-name
-@c snarfed from goops.c:895
@deffn {Scheme Procedure} generic-function-name obj
@deffnx {C Function} scm_generic_function_name (obj)
Return the name of the generic function @var{obj}.
@end deffn
generic-function-methods
-@c snarfed from goops.c:905
@deffn {Scheme Procedure} generic-function-methods obj
@deffnx {C Function} scm_generic_function_methods (obj)
Return the methods of the generic function @var{obj}.
@end deffn
method-generic-function
-@c snarfed from goops.c:916
@deffn {Scheme Procedure} method-generic-function obj
@deffnx {C Function} scm_method_generic_function (obj)
-Return the generic function fot the method @var{obj}.
+Return the generic function for the method @var{obj}.
@end deffn
method-specializers
-@c snarfed from goops.c:926
@deffn {Scheme Procedure} method-specializers obj
@deffnx {C Function} scm_method_specializers (obj)
Return specializers of the method @var{obj}.
@end deffn
method-procedure
-@c snarfed from goops.c:936
@deffn {Scheme Procedure} method-procedure obj
@deffnx {C Function} scm_method_procedure (obj)
Return the procedure of the method @var{obj}.
@end deffn
accessor-method-slot-definition
-@c snarfed from goops.c:946
@deffn {Scheme Procedure} accessor-method-slot-definition obj
@deffnx {C Function} scm_accessor_method_slot_definition (obj)
Return the slot definition of the accessor @var{obj}.
@end deffn
%tag-body
-@c snarfed from goops.c:956
@deffn {Scheme Procedure} %tag-body body
@deffnx {C Function} scm_sys_tag_body (body)
Internal GOOPS magic---don't use this function!
@end deffn
make-unbound
-@c snarfed from goops.c:971
@deffn {Scheme Procedure} make-unbound
@deffnx {C Function} scm_make_unbound ()
Return the unbound value.
@end deffn
unbound?
-@c snarfed from goops.c:980
@deffn {Scheme Procedure} unbound? obj
@deffnx {C Function} scm_unbound_p (obj)
Return @code{#t} if @var{obj} is unbound.
@end deffn
assert-bound
-@c snarfed from goops.c:990
@deffn {Scheme Procedure} assert-bound value obj
@deffnx {C Function} scm_assert_bound (value, obj)
Return @var{value} if it is bound, and invoke the
@@ -1544,7 +1391,6 @@ Return @var{value} if it is bound, and invoke the
@end deffn
@@assert-bound-ref
-@c snarfed from goops.c:1002
@deffn {Scheme Procedure} @@assert-bound-ref obj index
@deffnx {C Function} scm_at_assert_bound_ref (obj, index)
Like @code{assert-bound}, but use @var{index} for accessing
@@ -1552,14 +1398,12 @@ the value from @var{obj}.
@end deffn
%fast-slot-ref
-@c snarfed from goops.c:1014
@deffn {Scheme Procedure} %fast-slot-ref obj index
@deffnx {C Function} scm_sys_fast_slot_ref (obj, index)
Return the slot value with index @var{index} from @var{obj}.
@end deffn
%fast-slot-set!
-@c snarfed from goops.c:1032
@deffn {Scheme Procedure} %fast-slot-set! obj index value
@deffnx {C Function} scm_sys_fast_slot_set_x (obj, index, value)
Set the slot with index @var{index} in @var{obj} to
@@ -1567,35 +1411,30 @@ Set the slot with index @var{index} in @var{obj} to
@end deffn
slot-ref-using-class
-@c snarfed from goops.c:1162
@deffn {Scheme Procedure} slot-ref-using-class class obj slot_name
@deffnx {C Function} scm_slot_ref_using_class (class, obj, slot_name)
@end deffn
slot-set-using-class!
-@c snarfed from goops.c:1181
@deffn {Scheme Procedure} slot-set-using-class! class obj slot_name value
@deffnx {C Function} scm_slot_set_using_class_x (class, obj, slot_name, value)
@end deffn
slot-bound-using-class?
-@c snarfed from goops.c:1195
@deffn {Scheme Procedure} slot-bound-using-class? class obj slot_name
@deffnx {C Function} scm_slot_bound_using_class_p (class, obj, slot_name)
@end deffn
slot-exists-using-class?
-@c snarfed from goops.c:1210
@deffn {Scheme Procedure} slot-exists-using-class? class obj slot_name
@deffnx {C Function} scm_slot_exists_using_class_p (class, obj, slot_name)
@end deffn
slot-ref
-@c snarfed from goops.c:1226
@deffn {Scheme Procedure} slot-ref obj slot_name
@deffnx {C Function} scm_slot_ref (obj, slot_name)
Return the value from @var{obj}'s slot with the name
@@ -1603,14 +1442,12 @@ Return the value from @var{obj}'s slot with the name
@end deffn
slot-set!
-@c snarfed from goops.c:1243
@deffn {Scheme Procedure} slot-set! obj slot_name value
@deffnx {C Function} scm_slot_set_x (obj, slot_name, value)
Set the slot named @var{slot_name} of @var{obj} to @var{value}.
@end deffn
slot-bound?
-@c snarfed from goops.c:1260
@deffn {Scheme Procedure} slot-bound? obj slot_name
@deffnx {C Function} scm_slot_bound_p (obj, slot_name)
Return @code{#t} if the slot named @var{slot_name} of @var{obj}
@@ -1618,14 +1455,12 @@ is bound.
@end deffn
slot-exists?
-@c snarfed from goops.c:1278
@deffn {Scheme Procedure} slot-exists? obj slot_name
@deffnx {C Function} scm_slots_exists_p (obj, slot_name)
Return @code{#t} if @var{obj} has a slot named @var{slot_name}.
@end deffn
%allocate-instance
-@c snarfed from goops.c:1317
@deffn {Scheme Procedure} %allocate-instance class initargs
@deffnx {C Function} scm_sys_allocate_instance (class, initargs)
Create a new instance of class @var{class} and initialize it
@@ -1633,63 +1468,54 @@ from the arguments @var{initargs}.
@end deffn
%set-object-setter!
-@c snarfed from goops.c:1387
@deffn {Scheme Procedure} %set-object-setter! obj setter
@deffnx {C Function} scm_sys_set_object_setter_x (obj, setter)
@end deffn
%modify-instance
-@c snarfed from goops.c:1412
@deffn {Scheme Procedure} %modify-instance old new
@deffnx {C Function} scm_sys_modify_instance (old, new)
@end deffn
%modify-class
-@c snarfed from goops.c:1438
@deffn {Scheme Procedure} %modify-class old new
@deffnx {C Function} scm_sys_modify_class (old, new)
@end deffn
%invalidate-class
-@c snarfed from goops.c:1462
@deffn {Scheme Procedure} %invalidate-class class
@deffnx {C Function} scm_sys_invalidate_class (class)
@end deffn
%invalidate-method-cache!
-@c snarfed from goops.c:1589
@deffn {Scheme Procedure} %invalidate-method-cache! gf
@deffnx {C Function} scm_sys_invalidate_method_cache_x (gf)
@end deffn
generic-capability?
-@c snarfed from goops.c:1615
@deffn {Scheme Procedure} generic-capability? proc
@deffnx {C Function} scm_generic_capability_p (proc)
@end deffn
enable-primitive-generic!
-@c snarfed from goops.c:1628
@deffn {Scheme Procedure} enable-primitive-generic! . subrs
@deffnx {C Function} scm_enable_primitive_generic_x (subrs)
@end deffn
primitive-generic-generic
-@c snarfed from goops.c:1649
@deffn {Scheme Procedure} primitive-generic-generic subr
@deffnx {C Function} scm_primitive_generic_generic (subr)
@end deffn
make
-@c snarfed from goops.c:2010
@deffn {Scheme Procedure} make . args
@deffnx {C Function} scm_make (args)
Make a new object. @var{args} must contain the class and
@@ -1697,21 +1523,18 @@ all necessary initialization information.
@end deffn
find-method
-@c snarfed from goops.c:2103
@deffn {Scheme Procedure} find-method . l
@deffnx {C Function} scm_find_method (l)
@end deffn
%method-more-specific?
-@c snarfed from goops.c:2123
@deffn {Scheme Procedure} %method-more-specific? m1 m2 targs
@deffnx {C Function} scm_sys_method_more_specific_p (m1, m2, targs)
@end deffn
%goops-loaded
-@c snarfed from goops.c:2648
@deffn {Scheme Procedure} %goops-loaded
@deffnx {C Function} scm_sys_goops_loaded ()
Announce that GOOPS is loaded and perform initialization
@@ -1719,7 +1542,6 @@ on the C level which depends on the loaded GOOPS modules.
@end deffn
make-guardian
-@c snarfed from guardians.c:330
@deffn {Scheme Procedure} make-guardian [greedy_p]
@deffnx {C Function} scm_make_guardian (greedy_p)
Create a new guardian.
@@ -1750,21 +1572,18 @@ paper still (mostly) accurately describes the interface).
@end deffn
guardian-destroyed?
-@c snarfed from guardians.c:358
@deffn {Scheme Procedure} guardian-destroyed? guardian
@deffnx {C Function} scm_guardian_destroyed_p (guardian)
Return @code{#t} if @var{guardian} has been destroyed, otherwise @code{#f}.
@end deffn
guardian-greedy?
-@c snarfed from guardians.c:376
@deffn {Scheme Procedure} guardian-greedy? guardian
@deffnx {C Function} scm_guardian_greedy_p (guardian)
Return @code{#t} if @var{guardian} is a greedy guardian, otherwise @code{#f}.
@end deffn
destroy-guardian!
-@c snarfed from guardians.c:387
@deffn {Scheme Procedure} destroy-guardian! guardian
@deffnx {C Function} scm_destroy_guardian_x (guardian)
Destroys @var{guardian}, by making it impossible to put any more
@@ -1773,7 +1592,6 @@ objects guarded by @var{guardian}.
@end deffn
hashq
-@c snarfed from hash.c:200
@deffn {Scheme Procedure} hashq key size
@deffnx {C Function} scm_hashq (key, size)
Determine a hash value for @var{key} that is suitable for
@@ -1789,7 +1607,6 @@ different values, since @code{foo} will be garbage collected.
@end deffn
hashv
-@c snarfed from hash.c:236
@deffn {Scheme Procedure} hashv key size
@deffnx {C Function} scm_hashv (key, size)
Determine a hash value for @var{key} that is suitable for
@@ -1805,7 +1622,6 @@ different values, since @code{foo} will be garbage collected.
@end deffn
hash
-@c snarfed from hash.c:259
@deffn {Scheme Procedure} hash key size
@deffnx {C Function} scm_hash (key, size)
Determine a hash value for @var{key} that is suitable for
@@ -1815,7 +1631,6 @@ integer in the range 0 to @var{size} - 1.
@end deffn
hashq-get-handle
-@c snarfed from hashtab.c:173
@deffn {Scheme Procedure} hashq-get-handle table key
@deffnx {C Function} scm_hashq_get_handle (table, key)
This procedure returns the @code{(key . value)} pair from the
@@ -1825,7 +1640,6 @@ Uses @code{eq?} for equality testing.
@end deffn
hashq-create-handle!
-@c snarfed from hashtab.c:185
@deffn {Scheme Procedure} hashq-create-handle! table key init
@deffnx {C Function} scm_hashq_create_handle_x (table, key, init)
This function looks up @var{key} in @var{table} and returns its handle.
@@ -1834,7 +1648,6 @@ associates @var{key} with @var{init}.
@end deffn
hashq-ref
-@c snarfed from hashtab.c:198
@deffn {Scheme Procedure} hashq-ref table key [dflt]
@deffnx {C Function} scm_hashq_ref (table, key, dflt)
Look up @var{key} in the hash table @var{table}, and return the
@@ -1844,7 +1657,6 @@ is supplied). Uses @code{eq?} for equality testing.
@end deffn
hashq-set!
-@c snarfed from hashtab.c:212
@deffn {Scheme Procedure} hashq-set! table key val
@deffnx {C Function} scm_hashq_set_x (table, key, val)
Find the entry in @var{table} associated with @var{key}, and
@@ -1852,7 +1664,6 @@ store @var{value} there. Uses @code{eq?} for equality testing.
@end deffn
hashq-remove!
-@c snarfed from hashtab.c:224
@deffn {Scheme Procedure} hashq-remove! table key
@deffnx {C Function} scm_hashq_remove_x (table, key)
Remove @var{key} (and any value associated with it) from
@@ -1860,7 +1671,6 @@ Remove @var{key} (and any value associated with it) from
@end deffn
hashv-get-handle
-@c snarfed from hashtab.c:240
@deffn {Scheme Procedure} hashv-get-handle table key
@deffnx {C Function} scm_hashv_get_handle (table, key)
This procedure returns the @code{(key . value)} pair from the
@@ -1870,7 +1680,6 @@ Uses @code{eqv?} for equality testing.
@end deffn
hashv-create-handle!
-@c snarfed from hashtab.c:252
@deffn {Scheme Procedure} hashv-create-handle! table key init
@deffnx {C Function} scm_hashv_create_handle_x (table, key, init)
This function looks up @var{key} in @var{table} and returns its handle.
@@ -1879,7 +1688,6 @@ associates @var{key} with @var{init}.
@end deffn
hashv-ref
-@c snarfed from hashtab.c:266
@deffn {Scheme Procedure} hashv-ref table key [dflt]
@deffnx {C Function} scm_hashv_ref (table, key, dflt)
Look up @var{key} in the hash table @var{table}, and return the
@@ -1889,7 +1697,6 @@ is supplied). Uses @code{eqv?} for equality testing.
@end deffn
hashv-set!
-@c snarfed from hashtab.c:280
@deffn {Scheme Procedure} hashv-set! table key val
@deffnx {C Function} scm_hashv_set_x (table, key, val)
Find the entry in @var{table} associated with @var{key}, and
@@ -1897,7 +1704,6 @@ store @var{value} there. Uses @code{eqv?} for equality testing.
@end deffn
hashv-remove!
-@c snarfed from hashtab.c:291
@deffn {Scheme Procedure} hashv-remove! table key
@deffnx {C Function} scm_hashv_remove_x (table, key)
Remove @var{key} (and any value associated with it) from
@@ -1905,7 +1711,6 @@ Remove @var{key} (and any value associated with it) from
@end deffn
hash-get-handle
-@c snarfed from hashtab.c:306
@deffn {Scheme Procedure} hash-get-handle table key
@deffnx {C Function} scm_hash_get_handle (table, key)
This procedure returns the @code{(key . value)} pair from the
@@ -1915,7 +1720,6 @@ Uses @code{equal?} for equality testing.
@end deffn
hash-create-handle!
-@c snarfed from hashtab.c:318
@deffn {Scheme Procedure} hash-create-handle! table key init
@deffnx {C Function} scm_hash_create_handle_x (table, key, init)
This function looks up @var{key} in @var{table} and returns its handle.
@@ -1924,7 +1728,6 @@ associates @var{key} with @var{init}.
@end deffn
hash-ref
-@c snarfed from hashtab.c:331
@deffn {Scheme Procedure} hash-ref table key [dflt]
@deffnx {C Function} scm_hash_ref (table, key, dflt)
Look up @var{key} in the hash table @var{table}, and return the
@@ -1934,7 +1737,6 @@ is supplied). Uses @code{equal?} for equality testing.
@end deffn
hash-set!
-@c snarfed from hashtab.c:346
@deffn {Scheme Procedure} hash-set! table key val
@deffnx {C Function} scm_hash_set_x (table, key, val)
Find the entry in @var{table} associated with @var{key}, and
@@ -1943,7 +1745,6 @@ testing.
@end deffn
hash-remove!
-@c snarfed from hashtab.c:358
@deffn {Scheme Procedure} hash-remove! table key
@deffnx {C Function} scm_hash_remove_x (table, key)
Remove @var{key} (and any value associated with it) from
@@ -1951,7 +1752,6 @@ Remove @var{key} (and any value associated with it) from
@end deffn
hashx-get-handle
-@c snarfed from hashtab.c:422
@deffn {Scheme Procedure} hashx-get-handle hash assoc table key
@deffnx {C Function} scm_hashx_get_handle (hash, assoc, table, key)
This behaves the same way as the corresponding
@@ -1963,7 +1763,6 @@ table size. @code{assoc} must be an associator function, like
@end deffn
hashx-create-handle!
-@c snarfed from hashtab.c:441
@deffn {Scheme Procedure} hashx-create-handle! hash assoc table key init
@deffnx {C Function} scm_hashx_create_handle_x (hash, assoc, table, key, init)
This behaves the same way as the corresponding
@@ -1975,7 +1774,6 @@ table size. @code{assoc} must be an associator function, like
@end deffn
hashx-ref
-@c snarfed from hashtab.c:464
@deffn {Scheme Procedure} hashx-ref hash assoc table key [dflt]
@deffnx {C Function} scm_hashx_ref (hash, assoc, table, key, dflt)
This behaves the same way as the corresponding @code{ref}
@@ -1990,7 +1788,6 @@ equivalent to @code{hashx-ref hashq assq table key}.
@end deffn
hashx-set!
-@c snarfed from hashtab.c:490
@deffn {Scheme Procedure} hashx-set! hash assoc table key val
@deffnx {C Function} scm_hashx_set_x (hash, assoc, table, key, val)
This behaves the same way as the corresponding @code{set!}
@@ -2005,7 +1802,6 @@ equivalent to @code{hashx-set! hashq assq table key}.
@end deffn
hash-fold
-@c snarfed from hashtab.c:528
@deffn {Scheme Procedure} hash-fold proc init table
@deffnx {C Function} scm_hash_fold (proc, init, table)
An iterator over hash-table elements.
@@ -2019,7 +1815,6 @@ table into an a-list of key-value pairs.
@end deffn
make-hook
-@c snarfed from hooks.c:178
@deffn {Scheme Procedure} make-hook [n_args]
@deffnx {C Function} scm_make_hook (n_args)
Create a hook for storing procedure of arity @var{n_args}.
@@ -2028,14 +1823,12 @@ object to be used with the other hook procedures.
@end deffn
hook?
-@c snarfed from hooks.c:201
@deffn {Scheme Procedure} hook? x
@deffnx {C Function} scm_hook_p (x)
Return @code{#t} if @var{x} is a hook, @code{#f} otherwise.
@end deffn
hook-empty?
-@c snarfed from hooks.c:212
@deffn {Scheme Procedure} hook-empty? hook
@deffnx {C Function} scm_hook_empty_p (hook)
Return @code{#t} if @var{hook} is an empty hook, @code{#f}
@@ -2043,7 +1836,6 @@ otherwise.
@end deffn
add-hook!
-@c snarfed from hooks.c:226
@deffn {Scheme Procedure} add-hook! hook proc [append_p]
@deffnx {C Function} scm_add_hook_x (hook, proc, append_p)
Add the procedure @var{proc} to the hook @var{hook}. The
@@ -2053,7 +1845,6 @@ procedure is not specified.
@end deffn
remove-hook!
-@c snarfed from hooks.c:253
@deffn {Scheme Procedure} remove-hook! hook proc
@deffnx {C Function} scm_remove_hook_x (hook, proc)
Remove the procedure @var{proc} from the hook @var{hook}. The
@@ -2061,7 +1852,6 @@ return value of this procedure is not specified.
@end deffn
reset-hook!
-@c snarfed from hooks.c:267
@deffn {Scheme Procedure} reset-hook! hook
@deffnx {C Function} scm_reset_hook_x (hook)
Remove all procedures from the hook @var{hook}. The return
@@ -2069,7 +1859,6 @@ value of this procedure is not specified.
@end deffn
run-hook
-@c snarfed from hooks.c:281
@deffn {Scheme Procedure} run-hook hook . args
@deffnx {C Function} scm_run_hook (hook, args)
Apply all procedures from the hook @var{hook} to the arguments
@@ -2078,14 +1867,12 @@ last. The return value of this procedure is not specified.
@end deffn
hook->list
-@c snarfed from hooks.c:308
@deffn {Scheme Procedure} hook->list hook
@deffnx {C Function} scm_hook_to_list (hook)
Convert the procedure list of @var{hook} to a list.
@end deffn
ftell
-@c snarfed from ioext.c:73
@deffn {Scheme Procedure} ftell fd_port
@deffnx {C Function} scm_ftell (fd_port)
Return an integer representing the current position of
@@ -2097,7 +1884,6 @@ Return an integer representing the current position of
@end deffn
redirect-port
-@c snarfed from ioext.c:91
@deffn {Scheme Procedure} redirect-port old new
@deffnx {C Function} scm_redirect_port (old, new)
This procedure takes two ports and duplicates the underlying file
@@ -2116,7 +1902,6 @@ revealed counts.
@end deffn
dup->fdes
-@c snarfed from ioext.c:130
@deffn {Scheme Procedure} dup->fdes fd_or_port [fd]
@deffnx {C Function} scm_dup_to_fdes (fd_or_port, fd)
Return a new integer file descriptor referring to the open file
@@ -2125,7 +1910,6 @@ file port or a file descriptor.
@end deffn
dup2
-@c snarfed from ioext.c:177
@deffn {Scheme Procedure} dup2 oldfd newfd
@deffnx {C Function} scm_dup2 (oldfd, newfd)
A simple wrapper for the @code{dup2} system call.
@@ -2139,7 +1923,6 @@ The return value is unspecified.
@end deffn
fileno
-@c snarfed from ioext.c:196
@deffn {Scheme Procedure} fileno port
@deffnx {C Function} scm_fileno (port)
Return the integer file descriptor underlying @var{port}. Does
@@ -2147,7 +1930,6 @@ not change its revealed count.
@end deffn
isatty?
-@c snarfed from ioext.c:216
@deffn {Scheme Procedure} isatty? port
@deffnx {C Function} scm_isatty_p (port)
Return @code{#t} if @var{port} is using a serial non--file
@@ -2155,7 +1937,6 @@ device, otherwise @code{#f}.
@end deffn
fdopen
-@c snarfed from ioext.c:238
@deffn {Scheme Procedure} fdopen fdes modes
@deffnx {C Function} scm_fdopen (fdes, modes)
Return a new port based on the file descriptor @var{fdes}.
@@ -2165,7 +1946,6 @@ same as that accepted by @ref{File Ports, open-file}.
@end deffn
primitive-move->fdes
-@c snarfed from ioext.c:262
@deffn {Scheme Procedure} primitive-move->fdes port fd
@deffnx {C Function} scm_primitive_move_to_fdes (port, fd)
Moves the underlying file descriptor for @var{port} to the integer
@@ -2177,7 +1957,6 @@ required value or @code{#t} if it was moved.
@end deffn
fdes->ports
-@c snarfed from ioext.c:296
@deffn {Scheme Procedure} fdes->ports fd
@deffnx {C Function} scm_fdes_to_ports (fd)
Return a list of existing ports which have @var{fdes} as an
@@ -2186,14 +1965,12 @@ counts.
@end deffn
make-keyword-from-dash-symbol
-@c snarfed from keywords.c:74
@deffn {Scheme Procedure} make-keyword-from-dash-symbol symbol
@deffnx {C Function} scm_make_keyword_from_dash_symbol (symbol)
Make a keyword object from a @var{symbol} that starts with a dash.
@end deffn
keyword?
-@c snarfed from keywords.c:112
@deffn {Scheme Procedure} keyword? obj
@deffnx {C Function} scm_keyword_p (obj)
Return @code{#t} if the argument @var{obj} is a keyword, else
@@ -2201,7 +1978,6 @@ Return @code{#t} if the argument @var{obj} is a keyword, else
@end deffn
keyword-dash-symbol
-@c snarfed from keywords.c:123
@deffn {Scheme Procedure} keyword-dash-symbol keyword
@deffnx {C Function} scm_keyword_dash_symbol (keyword)
Return the dash symbol for @var{keyword}.
@@ -2209,7 +1985,6 @@ This is the inverse of @code{make-keyword-from-dash-symbol}.
@end deffn
list
-@c snarfed from list.c:127
@deffn {Scheme Procedure} list . objs
@deffnx {C Function} scm_list (objs)
Return a list containing @var{objs}, the arguments to
@@ -2217,7 +1992,6 @@ Return a list containing @var{objs}, the arguments to
@end deffn
cons*
-@c snarfed from list.c:142
@deffn {Scheme Procedure} cons* arg . rest
@deffnx {C Function} scm_cons_star (arg, rest)
Like @code{list}, but the last arg provides the tail of the
@@ -2229,28 +2003,24 @@ Schemes and in Common LISP.
@end deffn
null?
-@c snarfed from list.c:166
@deffn {Scheme Procedure} null? x
@deffnx {C Function} scm_null_p (x)
Return @code{#t} iff @var{x} is the empty list, else @code{#f}.
@end deffn
list?
-@c snarfed from list.c:176
@deffn {Scheme Procedure} list? x
@deffnx {C Function} scm_list_p (x)
Return @code{#t} iff @var{x} is a proper list, else @code{#f}.
@end deffn
length
-@c snarfed from list.c:217
@deffn {Scheme Procedure} length lst
@deffnx {C Function} scm_length (lst)
Return the number of elements in list @var{lst}.
@end deffn
append
-@c snarfed from list.c:246
@deffn {Scheme Procedure} append . args
@deffnx {C Function} scm_append (args)
Return a list consisting of the elements the lists passed as
@@ -2271,7 +2041,6 @@ if the last argument is not a proper list.
@end deffn
append!
-@c snarfed from list.c:280
@deffn {Scheme Procedure} append! . lists
@deffnx {C Function} scm_append_x (lists)
A destructive version of @code{append} (@pxref{Pairs and
@@ -2282,7 +2051,6 @@ the mutated list.
@end deffn
last-pair
-@c snarfed from list.c:306
@deffn {Scheme Procedure} last-pair lst
@deffnx {C Function} scm_last_pair (lst)
Return a pointer to the last pair in @var{lst}, signalling an error if
@@ -2290,7 +2058,6 @@ Return a pointer to the last pair in @var{lst}, signalling an error if
@end deffn
reverse
-@c snarfed from list.c:336
@deffn {Scheme Procedure} reverse lst
@deffnx {C Function} scm_reverse (lst)
Return a new list that contains the elements of @var{lst} but
@@ -2298,7 +2065,6 @@ in reverse order.
@end deffn
reverse!
-@c snarfed from list.c:370
@deffn {Scheme Procedure} reverse! lst [new_tail]
@deffnx {C Function} scm_reverse_x (lst, new_tail)
A destructive version of @code{reverse} (@pxref{Pairs and Lists,,,r5rs,
@@ -2315,27 +2081,23 @@ of the modified list is not lost, it is wise to save the return value of
@end deffn
list-ref
-@c snarfed from list.c:396
@deffn {Scheme Procedure} list-ref list k
@deffnx {C Function} scm_list_ref (list, k)
Return the @var{k}th element from @var{list}.
@end deffn
list-set!
-@c snarfed from list.c:420
@deffn {Scheme Procedure} list-set! list k val
@deffnx {C Function} scm_list_set_x (list, k, val)
Set the @var{k}th element of @var{list} to @var{val}.
@end deffn
list-cdr-ref
-@c snarfed from list.c:443
@deffn {Scheme Procedure} list-cdr-ref
implemented by the C function "scm_list_tail"
@end deffn
list-tail
-@c snarfed from list.c:452
@deffn {Scheme Procedure} list-tail lst k
@deffnx {Scheme Procedure} list-cdr-ref lst k
@deffnx {C Function} scm_list_tail (lst, k)
@@ -2348,14 +2110,12 @@ or returning the results of cdring @var{k} times down @var{lst}.
@end deffn
list-cdr-set!
-@c snarfed from list.c:468
@deffn {Scheme Procedure} list-cdr-set! list k val
@deffnx {C Function} scm_list_cdr_set_x (list, k, val)
Set the @var{k}th cdr of @var{list} to @var{val}.
@end deffn
list-head
-@c snarfed from list.c:497
@deffn {Scheme Procedure} list-head lst k
@deffnx {C Function} scm_list_head (lst, k)
Copy the first @var{k} elements from @var{lst} into a new list, and
@@ -2363,14 +2123,12 @@ return it.
@end deffn
list-copy
-@c snarfed from list.c:521
@deffn {Scheme Procedure} list-copy lst
@deffnx {C Function} scm_list_copy (lst)
Return a (newly-created) copy of @var{lst}.
@end deffn
memq
-@c snarfed from list.c:575
@deffn {Scheme Procedure} memq x lst
@deffnx {C Function} scm_memq (x, lst)
Return the first sublist of @var{lst} whose car is @code{eq?}
@@ -2382,7 +2140,6 @@ returned.
@end deffn
memv
-@c snarfed from list.c:591
@deffn {Scheme Procedure} memv x lst
@deffnx {C Function} scm_memv (x, lst)
Return the first sublist of @var{lst} whose car is @code{eqv?}
@@ -2394,7 +2151,6 @@ returned.
@end deffn
member
-@c snarfed from list.c:612
@deffn {Scheme Procedure} member x lst
@deffnx {C Function} scm_member (x, lst)
Return the first sublist of @var{lst} whose car is
@@ -2406,7 +2162,6 @@ empty list) is returned.
@end deffn
delq!
-@c snarfed from list.c:637
@deffn {Scheme Procedure} delq! item lst
@deffnx {Scheme Procedure} delv! item lst
@deffnx {Scheme Procedure} delete! item lst
@@ -2420,7 +2175,6 @@ destructive list functions, these functions cannot modify the binding of
@end deffn
delv!
-@c snarfed from list.c:661
@deffn {Scheme Procedure} delv! item lst
@deffnx {C Function} scm_delv_x (item, lst)
Destructively remove all elements from @var{lst} that are
@@ -2428,7 +2182,6 @@ Destructively remove all elements from @var{lst} that are
@end deffn
delete!
-@c snarfed from list.c:686
@deffn {Scheme Procedure} delete! item lst
@deffnx {C Function} scm_delete_x (item, lst)
Destructively remove all elements from @var{lst} that are
@@ -2436,7 +2189,6 @@ Destructively remove all elements from @var{lst} that are
@end deffn
delq
-@c snarfed from list.c:715
@deffn {Scheme Procedure} delq item lst
@deffnx {C Function} scm_delq (item, lst)
Return a newly-created copy of @var{lst} with elements
@@ -2446,7 +2198,6 @@ Return a newly-created copy of @var{lst} with elements
@end deffn
delv
-@c snarfed from list.c:728
@deffn {Scheme Procedure} delv item lst
@deffnx {C Function} scm_delv (item, lst)
Return a newly-created copy of @var{lst} with elements
@@ -2456,7 +2207,6 @@ Return a newly-created copy of @var{lst} with elements
@end deffn
delete
-@c snarfed from list.c:741
@deffn {Scheme Procedure} delete item lst
@deffnx {C Function} scm_delete (item, lst)
Return a newly-created copy of @var{lst} with elements
@@ -2466,7 +2216,6 @@ against @var{item} with @code{equal?}.
@end deffn
delq1!
-@c snarfed from list.c:754
@deffn {Scheme Procedure} delq1! item lst
@deffnx {C Function} scm_delq1_x (item, lst)
Like @code{delq!}, but only deletes the first occurrence of
@@ -2475,7 +2224,6 @@ Like @code{delq!}, but only deletes the first occurrence of
@end deffn
delv1!
-@c snarfed from list.c:782
@deffn {Scheme Procedure} delv1! item lst
@deffnx {C Function} scm_delv1_x (item, lst)
Like @code{delv!}, but only deletes the first occurrence of
@@ -2484,7 +2232,6 @@ Like @code{delv!}, but only deletes the first occurrence of
@end deffn
delete1!
-@c snarfed from list.c:810
@deffn {Scheme Procedure} delete1! item lst
@deffnx {C Function} scm_delete1_x (item, lst)
Like @code{delete!}, but only deletes the first occurrence of
@@ -2493,7 +2240,6 @@ Like @code{delete!}, but only deletes the first occurrence of
@end deffn
primitive-load
-@c snarfed from load.c:111
@deffn {Scheme Procedure} primitive-load filename
@deffnx {C Function} scm_primitive_load (filename)
Load the file named @var{filename} and evaluate its contents in
@@ -2506,7 +2252,6 @@ documentation for @code{%load-hook} later in this section.
@end deffn
%package-data-dir
-@c snarfed from load.c:151
@deffn {Scheme Procedure} %package-data-dir
@deffnx {C Function} scm_sys_package_data_dir ()
Return the name of the directory where Scheme packages, modules and
@@ -2515,7 +2260,6 @@ libraries are kept. On most Unix systems, this will be
@end deffn
%library-dir
-@c snarfed from load.c:163
@deffn {Scheme Procedure} %library-dir
@deffnx {C Function} scm_sys_library_dir ()
Return the directory where the Guile Scheme library files are installed.
@@ -2523,7 +2267,6 @@ E.g., may return "/usr/share/guile/1.3.5".
@end deffn
%site-dir
-@c snarfed from load.c:175
@deffn {Scheme Procedure} %site-dir
@deffnx {C Function} scm_sys_site_dir ()
Return the directory where the Guile site files are installed.
@@ -2531,7 +2274,6 @@ E.g., may return "/usr/share/guile/site".
@end deffn
parse-path
-@c snarfed from load.c:227
@deffn {Scheme Procedure} parse-path path [tail]
@deffnx {C Function} scm_parse_path (path, tail)
Parse @var{path}, which is expected to be a colon-separated
@@ -2541,7 +2283,6 @@ is returned.
@end deffn
search-path
-@c snarfed from load.c:277
@deffn {Scheme Procedure} search-path path filename [extensions]
@deffnx {C Function} scm_search_path (path, filename, extensions)
Search @var{path} for a directory containing a file named
@@ -2554,7 +2295,6 @@ concatenated with each @var{extension}.
@end deffn
%search-load-path
-@c snarfed from load.c:423
@deffn {Scheme Procedure} %search-load-path filename
@deffnx {C Function} scm_sys_search_load_path (filename)
Search @var{%load-path} for the file named @var{filename},
@@ -2567,7 +2307,6 @@ will try each extension automatically.
@end deffn
primitive-load-path
-@c snarfed from load.c:444
@deffn {Scheme Procedure} primitive-load-path filename
@deffnx {C Function} scm_primitive_load_path (filename)
Search @var{%load-path} for the file named @var{filename} and
@@ -2577,7 +2316,6 @@ an error is signalled.
@end deffn
procedure->syntax
-@c snarfed from macros.c:104
@deffn {Scheme Procedure} procedure->syntax code
@deffnx {C Function} scm_makacro (code)
Return a @dfn{macro} which, when a symbol defined to this value
@@ -2587,15 +2325,12 @@ environment.
@end deffn
procedure->macro
-@c snarfed from macros.c:127
@deffn {Scheme Procedure} procedure->macro code
@deffnx {C Function} scm_makmacro (code)
Return a @dfn{macro} which, when a symbol defined to this value
appears as the first symbol in an expression, evaluates the
result of applying @var{code} to the expression and the
-environment. The value returned from @var{code} which has been
-passed to @code{procedure->memoizing-macro} replaces the form
-passed to @var{code}. For example:
+environment. For example:
@lisp
(define trace
@@ -2607,27 +2342,20 @@ passed to @var{code}. For example:
@end deffn
procedure->memoizing-macro
-@c snarfed from macros.c:150
@deffn {Scheme Procedure} procedure->memoizing-macro code
@deffnx {C Function} scm_makmmacro (code)
Return a @dfn{macro} which, when a symbol defined to this value
appears as the first symbol in an expression, evaluates the
-result of applying @var{proc} to the expression and the
-environment. The value returned from @var{proc} which has been
-passed to @code{procedure->memoizing-macro} replaces the form
-passed to @var{proc}. For example:
-
-@lisp
-(define trace
- (procedure->macro
- (lambda (x env) `(set! ,(cadr x) (tracef ,(cadr x) ',(cadr x))))))
+result of applying @var{code} to the expression and the
+environment.
-(trace @i{foo}) @equiv{} (set! @i{foo} (tracef @i{foo} '@i{foo})).
-@end lisp
+@code{procedure->memoizing-macro} is the same as
+@code{procedure->macro}, except that the expression returned by
+@var{code} replaces the original macro expression in the memoized
+form of the containing code.
@end deffn
macro?
-@c snarfed from macros.c:162
@deffn {Scheme Procedure} macro? obj
@deffnx {C Function} scm_macro_p (obj)
Return @code{#t} if @var{obj} is a regular macro, a memoizing macro or a
@@ -2635,7 +2363,6 @@ syntax transformer.
@end deffn
macro-type
-@c snarfed from macros.c:180
@deffn {Scheme Procedure} macro-type m
@deffnx {C Function} scm_macro_type (m)
Return one of the symbols @code{syntax}, @code{macro} or
@@ -2646,28 +2373,24 @@ returned.
@end deffn
macro-name
-@c snarfed from macros.c:198
@deffn {Scheme Procedure} macro-name m
@deffnx {C Function} scm_macro_name (m)
Return the name of the macro @var{m}.
@end deffn
macro-transformer
-@c snarfed from macros.c:209
@deffn {Scheme Procedure} macro-transformer m
@deffnx {C Function} scm_macro_transformer (m)
Return the transformer of the macro @var{m}.
@end deffn
current-module
-@c snarfed from modules.c:69
@deffn {Scheme Procedure} current-module
@deffnx {C Function} scm_current_module ()
Return the current module.
@end deffn
set-current-module
-@c snarfed from modules.c:81
@deffn {Scheme Procedure} set-current-module module
@deffnx {C Function} scm_set_current_module (module)
Set the current module to @var{module} and return
@@ -2675,7 +2398,6 @@ the previous current module.
@end deffn
interaction-environment
-@c snarfed from modules.c:104
@deffn {Scheme Procedure} interaction-environment
@deffnx {C Function} scm_interaction_environment ()
Return a specifier for the environment that contains
@@ -2686,35 +2408,30 @@ evaluate expressions dynamically typed by the user.
@end deffn
env-module
-@c snarfed from modules.c:271
@deffn {Scheme Procedure} env-module env
@deffnx {C Function} scm_env_module (env)
Return the module of @var{ENV}, a lexical environment.
@end deffn
standard-eval-closure
-@c snarfed from modules.c:348
@deffn {Scheme Procedure} standard-eval-closure module
@deffnx {C Function} scm_standard_eval_closure (module)
Return an eval closure for the module @var{module}.
@end deffn
standard-interface-eval-closure
-@c snarfed from modules.c:359
@deffn {Scheme Procedure} standard-interface-eval-closure module
@deffnx {C Function} scm_standard_interface_eval_closure (module)
Return a interface eval closure for the module @var{module}. Such a closure does not allow new bindings to be added.
@end deffn
%get-pre-modules-obarray
-@c snarfed from modules.c:582
@deffn {Scheme Procedure} %get-pre-modules-obarray
@deffnx {C Function} scm_get_pre_modules_obarray ()
Return the obarray that is used for all new bindings before the module system is booted. The first call to @code{set-current-module} will boot the module system.
@end deffn
exact?
-@c snarfed from numbers.c:101
@deffn {Scheme Procedure} exact? x
@deffnx {C Function} scm_exact_p (x)
Return @code{#t} if @var{x} is an exact number, @code{#f}
@@ -2722,7 +2439,6 @@ otherwise.
@end deffn
odd?
-@c snarfed from numbers.c:118
@deffn {Scheme Procedure} odd? n
@deffnx {C Function} scm_odd_p (n)
Return @code{#t} if @var{n} is an odd number, @code{#f}
@@ -2730,7 +2446,6 @@ otherwise.
@end deffn
even?
-@c snarfed from numbers.c:135
@deffn {Scheme Procedure} even? n
@deffnx {C Function} scm_even_p (n)
Return @code{#t} if @var{n} is an even number, @code{#f}
@@ -2738,7 +2453,6 @@ otherwise.
@end deffn
logand
-@c snarfed from numbers.c:748
@deffn {Scheme Procedure} logand n1 n2
Return the bitwise AND of the integer arguments.
@@ -2750,7 +2464,6 @@ Return the bitwise AND of the integer arguments.
@end deffn
logior
-@c snarfed from numbers.c:834
@deffn {Scheme Procedure} logior n1 n2
Return the bitwise OR of the integer arguments.
@@ -2762,7 +2475,6 @@ Return the bitwise OR of the integer arguments.
@end deffn
logxor
-@c snarfed from numbers.c:921
@deffn {Scheme Procedure} logxor n1 n2
Return the bitwise XOR of the integer arguments. A bit is
set in the result if it is set in an odd number of arguments.
@@ -2775,7 +2487,6 @@ set in the result if it is set in an odd number of arguments.
@end deffn
logtest
-@c snarfed from numbers.c:990
@deffn {Scheme Procedure} logtest j k
@deffnx {C Function} scm_logtest (j, k)
@lisp
@@ -2787,7 +2498,6 @@ set in the result if it is set in an odd number of arguments.
@end deffn
logbit?
-@c snarfed from numbers.c:1047
@deffn {Scheme Procedure} logbit? index j
@deffnx {C Function} scm_logbit_p (index, j)
@lisp
@@ -2802,7 +2512,6 @@ set in the result if it is set in an odd number of arguments.
@end deffn
lognot
-@c snarfed from numbers.c:1096
@deffn {Scheme Procedure} lognot n
@deffnx {C Function} scm_lognot (n)
Return the integer which is the 2s-complement of the integer
@@ -2817,7 +2526,6 @@ argument.
@end deffn
integer-expt
-@c snarfed from numbers.c:1113
@deffn {Scheme Procedure} integer-expt n k
@deffnx {C Function} scm_integer_expt (n, k)
Return @var{n} raised to the non-negative integer exponent
@@ -2832,7 +2540,6 @@ Return @var{n} raised to the non-negative integer exponent
@end deffn
ash
-@c snarfed from numbers.c:1168
@deffn {Scheme Procedure} ash n cnt
@deffnx {C Function} scm_ash (n, cnt)
The function ash performs an arithmetic shift left by @var{cnt}
@@ -2853,7 +2560,6 @@ Formally, the function returns an integer equivalent to
@end deffn
bit-extract
-@c snarfed from numbers.c:1221
@deffn {Scheme Procedure} bit-extract n start end
@deffnx {C Function} scm_bit_extract (n, start, end)
Return the integer composed of the @var{start} (inclusive)
@@ -2869,7 +2575,6 @@ through @var{end} (exclusive) bits of @var{n}. The
@end deffn
logcount
-@c snarfed from numbers.c:1293
@deffn {Scheme Procedure} logcount n
@deffnx {C Function} scm_logcount (n)
Return the number of bits in integer @var{n}. If integer is
@@ -2888,10 +2593,9 @@ representation are counted. If 0, 0 is returned.
@end deffn
integer-length
-@c snarfed from numbers.c:1344
@deffn {Scheme Procedure} integer-length n
@deffnx {C Function} scm_integer_length (n)
-Return the number of bits neccessary to represent @var{n}.
+Return the number of bits necessary to represent @var{n}.
@lisp
(integer-length #b10101010)
@@ -2904,7 +2608,6 @@ Return the number of bits neccessary to represent @var{n}.
@end deffn
number->string
-@c snarfed from numbers.c:2177
@deffn {Scheme Procedure} number->string n [radix]
@deffnx {C Function} scm_number_to_string (n, radix)
Return a string holding the external representation of the
@@ -2913,7 +2616,6 @@ inexact, a radix of 10 will be used.
@end deffn
string->number
-@c snarfed from numbers.c:2812
@deffn {Scheme Procedure} string->number string [radix]
@deffnx {C Function} scm_string_to_number (string, radix)
Return a number of the maximally precise representation
@@ -2927,34 +2629,30 @@ syntactically valid notation for a number, then
@end deffn
number?
-@c snarfed from numbers.c:2881
@deffn {Scheme Procedure} number?
implemented by the C function "scm_number_p"
@end deffn
complex?
-@c snarfed from numbers.c:2893
@deffn {Scheme Procedure} complex? x
@deffnx {C Function} scm_number_p (x)
Return @code{#t} if @var{x} is a complex number, @code{#f}
-else. Note that the sets of real, rational and integer
+otherwise. Note that the sets of real, rational and integer
values form subsets of the set of complex numbers, i. e. the
predicate will also be fulfilled if @var{x} is a real,
rational or integer number.
@end deffn
real?
-@c snarfed from numbers.c:2901
@deffn {Scheme Procedure} real?
implemented by the C function "scm_real_p"
@end deffn
rational?
-@c snarfed from numbers.c:2914
@deffn {Scheme Procedure} rational? x
@deffnx {C Function} scm_real_p (x)
Return @code{#t} if @var{x} is a rational number, @code{#f}
-else. Note that the set of integer values forms a subset of
+otherwise. Note that the set of integer values forms a subset of
the set of rational numbers, i. e. the predicate will also be
fulfilled if @var{x} is an integer number. Real numbers
will also satisfy this predicate, because of their limited
@@ -2962,7 +2660,6 @@ precision.
@end deffn
integer?
-@c snarfed from numbers.c:2935
@deffn {Scheme Procedure} integer? x
@deffnx {C Function} scm_integer_p (x)
Return @code{#t} if @var{x} is an integer number, @code{#f}
@@ -2970,7 +2667,6 @@ else.
@end deffn
inexact?
-@c snarfed from numbers.c:2960
@deffn {Scheme Procedure} inexact? x
@deffnx {C Function} scm_inexact_p (x)
Return @code{#t} if @var{x} is an inexact number, @code{#f}
@@ -2978,7 +2674,6 @@ else.
@end deffn
$expt
-@c snarfed from numbers.c:4084
@deffn {Scheme Procedure} $expt x y
@deffnx {C Function} scm_sys_expt (x, y)
Return @var{x} raised to the power of @var{y}. This
@@ -2986,7 +2681,6 @@ procedure does not accept complex arguments.
@end deffn
$atan2
-@c snarfed from numbers.c:4100
@deffn {Scheme Procedure} $atan2 x y
@deffnx {C Function} scm_sys_atan2 (x, y)
Return the arc tangent of the two arguments @var{x} and
@@ -2997,7 +2691,6 @@ procedure does not accept complex arguments.
@end deffn
make-rectangular
-@c snarfed from numbers.c:4113
@deffn {Scheme Procedure} make-rectangular real imaginary
@deffnx {C Function} scm_make_rectangular (real, imaginary)
Return a complex number constructed of the given @var{real} and
@@ -3005,49 +2698,42 @@ Return a complex number constructed of the given @var{real} and
@end deffn
make-polar
-@c snarfed from numbers.c:4126
@deffn {Scheme Procedure} make-polar x y
@deffnx {C Function} scm_make_polar (x, y)
Return the complex number @var{x} * e^(i * @var{y}).
@end deffn
inexact->exact
-@c snarfed from numbers.c:4261
@deffn {Scheme Procedure} inexact->exact z
@deffnx {C Function} scm_inexact_to_exact (z)
Return an exact number that is numerically closest to @var{z}.
@end deffn
class-of
-@c snarfed from objects.c:86
@deffn {Scheme Procedure} class-of x
@deffnx {C Function} scm_class_of (x)
Return the class of @var{x}.
@end deffn
entity?
-@c snarfed from objects.c:360
@deffn {Scheme Procedure} entity? obj
@deffnx {C Function} scm_entity_p (obj)
Return @code{#t} if @var{obj} is an entity.
@end deffn
operator?
-@c snarfed from objects.c:369
@deffn {Scheme Procedure} operator? obj
@deffnx {C Function} scm_operator_p (obj)
Return @code{#t} if @var{obj} is an operator.
@end deffn
valid-object-procedure?
-@c snarfed from objects.c:385
@deffn {Scheme Procedure} valid-object-procedure? proc
@deffnx {C Function} scm_valid_object_procedure_p (proc)
Return @code{#t} iff @var{proc} is a procedure that can be used with @code{set-object-procedure}. It is always valid to use a closure constructed by @code{lambda}.
@end deffn
set-object-procedure!
-@c snarfed from objects.c:407
@deffn {Scheme Procedure} set-object-procedure! obj proc
@deffnx {C Function} scm_set_object_procedure_x (obj, proc)
Set the object procedure of @var{obj} to @var{proc}.
@@ -3055,7 +2741,6 @@ Set the object procedure of @var{obj} to @var{proc}.
@end deffn
make-class-object
-@c snarfed from objects.c:467
@deffn {Scheme Procedure} make-class-object metaclass layout
@deffnx {C Function} scm_make_class_object (metaclass, layout)
Create a new class object of class @var{metaclass}, with the
@@ -3063,7 +2748,6 @@ slot layout specified by @var{layout}.
@end deffn
make-subclass-object
-@c snarfed from objects.c:482
@deffn {Scheme Procedure} make-subclass-object class layout
@deffnx {C Function} scm_make_subclass_object (class, layout)
Create a subclass object of @var{class}, with the slot layout
@@ -3071,28 +2755,24 @@ specified by @var{layout}.
@end deffn
object-properties
-@c snarfed from objprop.c:59
@deffn {Scheme Procedure} object-properties obj
@deffnx {C Function} scm_object_properties (obj)
Return @var{obj}'s property list.
@end deffn
set-object-properties!
-@c snarfed from objprop.c:69
@deffn {Scheme Procedure} set-object-properties! obj alist
@deffnx {C Function} scm_set_object_properties_x (obj, alist)
Set @var{obj}'s property list to @var{alist}.
@end deffn
object-property
-@c snarfed from objprop.c:80
@deffn {Scheme Procedure} object-property obj key
@deffnx {C Function} scm_object_property (obj, key)
Return the property of @var{obj} with name @var{key}.
@end deffn
set-object-property!
-@c snarfed from objprop.c:92
@deffn {Scheme Procedure} set-object-property! obj key value
@deffnx {C Function} scm_set_object_property_x (obj, key, value)
In @var{obj}'s property list, set the property named @var{key}
@@ -3100,7 +2780,6 @@ to @var{value}.
@end deffn
cons
-@c snarfed from pairs.c:80
@deffn {Scheme Procedure} cons x y
@deffnx {C Function} scm_cons (x, y)
Return a newly allocated pair whose car is @var{x} and whose
@@ -3109,7 +2788,6 @@ sense of @code{eq?}) from every previously existing object.
@end deffn
pair?
-@c snarfed from pairs.c:98
@deffn {Scheme Procedure} pair? x
@deffnx {C Function} scm_pair_p (x)
Return @code{#t} if @var{x} is a pair; otherwise return
@@ -3117,7 +2795,6 @@ Return @code{#t} if @var{x} is a pair; otherwise return
@end deffn
set-car!
-@c snarfed from pairs.c:109
@deffn {Scheme Procedure} set-car! pair value
@deffnx {C Function} scm_set_car_x (pair, value)
Stores @var{value} in the car field of @var{pair}. The value returned
@@ -3125,7 +2802,6 @@ by @code{set-car!} is unspecified.
@end deffn
set-cdr!
-@c snarfed from pairs.c:122
@deffn {Scheme Procedure} set-cdr! pair value
@deffnx {C Function} scm_set_cdr_x (pair, value)
Stores @var{value} in the cdr field of @var{pair}. The value returned
@@ -3133,7 +2809,6 @@ by @code{set-cdr!} is unspecified.
@end deffn
char-ready?
-@c snarfed from ports.c:259
@deffn {Scheme Procedure} char-ready? [port]
@deffnx {C Function} scm_char_ready_p (port)
Return @code{#t} if a character is ready on input @var{port}
@@ -3152,7 +2827,6 @@ interactive port that has no ready characters.}
@end deffn
drain-input
-@c snarfed from ports.c:336
@deffn {Scheme Procedure} drain-input port
@deffnx {C Function} scm_drain_input (port)
This procedure clears a port's input buffers, similar
@@ -3172,7 +2846,6 @@ for further input.
@end deffn
current-input-port
-@c snarfed from ports.c:363
@deffn {Scheme Procedure} current-input-port
@deffnx {C Function} scm_current_input_port ()
Return the current input port. This is the default port used
@@ -3181,7 +2854,6 @@ returns the @dfn{standard input} in Unix and C terminology.
@end deffn
current-output-port
-@c snarfed from ports.c:375
@deffn {Scheme Procedure} current-output-port
@deffnx {C Function} scm_current_output_port ()
Return the current output port. This is the default port used
@@ -3191,7 +2863,6 @@ Unix and C terminology.
@end deffn
current-error-port
-@c snarfed from ports.c:385
@deffn {Scheme Procedure} current-error-port
@deffnx {C Function} scm_current_error_port ()
Return the port to which errors and warnings should be sent (the
@@ -3199,7 +2870,6 @@ Return the port to which errors and warnings should be sent (the
@end deffn
current-load-port
-@c snarfed from ports.c:395
@deffn {Scheme Procedure} current-load-port
@deffnx {C Function} scm_current_load_port ()
Return the current-load-port.
@@ -3207,7 +2877,6 @@ The load port is used internally by @code{primitive-load}.
@end deffn
set-current-input-port
-@c snarfed from ports.c:408
@deffn {Scheme Procedure} set-current-input-port port
@deffnx {Scheme Procedure} set-current-output-port port
@deffnx {Scheme Procedure} set-current-error-port port
@@ -3218,28 +2887,24 @@ so that they use the supplied @var{port} for input or output.
@end deffn
set-current-output-port
-@c snarfed from ports.c:421
@deffn {Scheme Procedure} set-current-output-port port
@deffnx {C Function} scm_set_current_output_port (port)
Set the current default output port to @var{port}.
@end deffn
set-current-error-port
-@c snarfed from ports.c:435
@deffn {Scheme Procedure} set-current-error-port port
@deffnx {C Function} scm_set_current_error_port (port)
Set the current default error port to @var{port}.
@end deffn
port-revealed
-@c snarfed from ports.c:578
@deffn {Scheme Procedure} port-revealed port
@deffnx {C Function} scm_port_revealed (port)
Return the revealed count for @var{port}.
@end deffn
set-port-revealed!
-@c snarfed from ports.c:591
@deffn {Scheme Procedure} set-port-revealed! port rcount
@deffnx {C Function} scm_set_port_revealed_x (port, rcount)
Sets the revealed count for a port to a given value.
@@ -3247,7 +2912,6 @@ The return value is unspecified.
@end deffn
port-mode
-@c snarfed from ports.c:634
@deffn {Scheme Procedure} port-mode port
@deffnx {C Function} scm_port_mode (port)
Return the port modes associated with the open port @var{port}.
@@ -3257,7 +2921,6 @@ used only during port creation are not retained.
@end deffn
close-port
-@c snarfed from ports.c:671
@deffn {Scheme Procedure} close-port port
@deffnx {C Function} scm_close_port (port)
Close the specified port object. Return @code{#t} if it
@@ -3269,7 +2932,6 @@ descriptors.
@end deffn
close-input-port
-@c snarfed from ports.c:699
@deffn {Scheme Procedure} close-input-port port
@deffnx {C Function} scm_close_input_port (port)
Close the specified input port object. The routine has no effect if
@@ -3281,7 +2943,6 @@ which can close file descriptors.
@end deffn
close-output-port
-@c snarfed from ports.c:714
@deffn {Scheme Procedure} close-output-port port
@deffnx {C Function} scm_close_output_port (port)
Close the specified output port object. The routine has no effect if
@@ -3293,7 +2954,6 @@ which can close file descriptors.
@end deffn
port-for-each
-@c snarfed from ports.c:731
@deffn {Scheme Procedure} port-for-each proc
@deffnx {C Function} scm_port_for_each (proc)
Apply @var{proc} to each port in the Guile port table
@@ -3305,7 +2965,6 @@ have no effect as far as @var{port-for-each} is concerned.
@end deffn
input-port?
-@c snarfed from ports.c:772
@deffn {Scheme Procedure} input-port? x
@deffnx {C Function} scm_input_port_p (x)
Return @code{#t} if @var{x} is an input port, otherwise return
@@ -3314,7 +2973,6 @@ Return @code{#t} if @var{x} is an input port, otherwise return
@end deffn
output-port?
-@c snarfed from ports.c:783
@deffn {Scheme Procedure} output-port? x
@deffnx {C Function} scm_output_port_p (x)
Return @code{#t} if @var{x} is an output port, otherwise return
@@ -3323,7 +2981,6 @@ Return @code{#t} if @var{x} is an output port, otherwise return
@end deffn
port?
-@c snarfed from ports.c:795
@deffn {Scheme Procedure} port? x
@deffnx {C Function} scm_port_p (x)
Return a boolean indicating whether @var{x} is a port.
@@ -3332,7 +2989,6 @@ Equivalent to @code{(or (input-port? @var{x}) (output-port?
@end deffn
port-closed?
-@c snarfed from ports.c:805
@deffn {Scheme Procedure} port-closed? port
@deffnx {C Function} scm_port_closed_p (port)
Return @code{#t} if @var{port} is closed or @code{#f} if it is
@@ -3340,7 +2996,6 @@ open.
@end deffn
eof-object?
-@c snarfed from ports.c:816
@deffn {Scheme Procedure} eof-object? x
@deffnx {C Function} scm_eof_object_p (x)
Return @code{#t} if @var{x} is an end-of-file object; otherwise
@@ -3348,7 +3003,6 @@ return @code{#f}.
@end deffn
force-output
-@c snarfed from ports.c:830
@deffn {Scheme Procedure} force-output [port]
@deffnx {C Function} scm_force_output (port)
Flush the specified output port, or the current output port if @var{port}
@@ -3361,7 +3015,6 @@ The return value is unspecified.
@end deffn
flush-all-ports
-@c snarfed from ports.c:848
@deffn {Scheme Procedure} flush-all-ports
@deffnx {C Function} scm_flush_all_ports ()
Equivalent to calling @code{force-output} on
@@ -3369,7 +3022,6 @@ all open output ports. The return value is unspecified.
@end deffn
read-char
-@c snarfed from ports.c:866
@deffn {Scheme Procedure} read-char [port]
@deffnx {C Function} scm_read_char (port)
Return the next character available from @var{port}, updating
@@ -3378,7 +3030,6 @@ characters are available, the end-of-file object is returned.
@end deffn
peek-char
-@c snarfed from ports.c:1192
@deffn {Scheme Procedure} peek-char [port]
@deffnx {C Function} scm_peek_char (port)
Return the next character available from @var{port},
@@ -3396,7 +3047,6 @@ to @code{read-char} would have hung.}
@end deffn
unread-char
-@c snarfed from ports.c:1213
@deffn {Scheme Procedure} unread-char cobj [port]
@deffnx {C Function} scm_unread_char (cobj, port)
Place @var{char} in @var{port} so that it will be read by the
@@ -3406,7 +3056,6 @@ not supplied, the current input port is used.
@end deffn
unread-string
-@c snarfed from ports.c:1236
@deffn {Scheme Procedure} unread-string str port
@deffnx {C Function} scm_unread_string (str, port)
Place the string @var{str} in @var{port} so that its characters will be
@@ -3416,7 +3065,6 @@ unread characters will be read again in last-in first-out order. If
@end deffn
seek
-@c snarfed from ports.c:1275
@deffn {Scheme Procedure} seek fd_port offset whence
@deffnx {C Function} scm_seek (fd_port, offset, whence)
Sets the current position of @var{fd/port} to the integer
@@ -3445,7 +3093,6 @@ that the current position of a port can be obtained using:
@end deffn
truncate-file
-@c snarfed from ports.c:1330
@deffn {Scheme Procedure} truncate-file object [length]
@deffnx {C Function} scm_truncate_file (object, length)
Truncates the object referred to by @var{object} to at most
@@ -3457,21 +3104,18 @@ position. The return value is unspecified.
@end deffn
port-line
-@c snarfed from ports.c:1383
@deffn {Scheme Procedure} port-line port
@deffnx {C Function} scm_port_line (port)
Return the current line number for @var{port}.
@end deffn
set-port-line!
-@c snarfed from ports.c:1394
@deffn {Scheme Procedure} set-port-line! port line
@deffnx {C Function} scm_set_port_line_x (port, line)
Set the current line number for @var{port} to @var{line}.
@end deffn
port-column
-@c snarfed from ports.c:1415
@deffn {Scheme Procedure} port-column port
@deffnx {Scheme Procedure} port-line port
@deffnx {C Function} scm_port_column (port)
@@ -3486,7 +3130,6 @@ what non-programmers will find most natural.)
@end deffn
set-port-column!
-@c snarfed from ports.c:1428
@deffn {Scheme Procedure} set-port-column! port column
@deffnx {Scheme Procedure} set-port-line! port line
@deffnx {C Function} scm_set_port_column_x (port, column)
@@ -3495,7 +3138,6 @@ current input port if none is specified.
@end deffn
port-filename
-@c snarfed from ports.c:1443
@deffn {Scheme Procedure} port-filename port
@deffnx {C Function} scm_port_filename (port)
Return the filename associated with @var{port}. This function returns
@@ -3504,7 +3146,6 @@ when called on the current input, output and error ports respectively.
@end deffn
set-port-filename!
-@c snarfed from ports.c:1457
@deffn {Scheme Procedure} set-port-filename! port filename
@deffnx {C Function} scm_set_port_filename_x (port, filename)
Change the filename associated with @var{port}, using the current input
@@ -3514,17 +3155,15 @@ source of data, but only the value that is returned by
@end deffn
%make-void-port
-@c snarfed from ports.c:1551
@deffn {Scheme Procedure} %make-void-port mode
@deffnx {C Function} scm_sys_make_void_port (mode)
Create and return a new void port. A void port acts like
-/dev/null. The @var{mode} argument
+@file{/dev/null}. The @var{mode} argument
specifies the input/output modes for this port: see the
documentation for @code{open-file} in @ref{File Ports}.
@end deffn
print-options-interface
-@c snarfed from print.c:142
@deffn {Scheme Procedure} print-options-interface [setting]
@deffnx {C Function} scm_print_options (setting)
Option interface for the print options. Instead of using
@@ -3534,7 +3173,6 @@ and @code{print-options}.
@end deffn
simple-format
-@c snarfed from print.c:921
@deffn {Scheme Procedure} simple-format destination message . args
@deffnx {C Function} scm_simple_format (destination, message, args)
Write @var{message} to @var{destination}, defaulting to
@@ -3551,7 +3189,6 @@ containing the formatted text. Does not add a trailing newline.
@end deffn
newline
-@c snarfed from print.c:1008
@deffn {Scheme Procedure} newline [port]
@deffnx {C Function} scm_newline (port)
Send a newline to @var{port}.
@@ -3559,14 +3196,12 @@ If @var{port} is omitted, send to the current output port.
@end deffn
write-char
-@c snarfed from print.c:1023
@deffn {Scheme Procedure} write-char chr [port]
@deffnx {C Function} scm_write_char (chr, port)
Send character @var{chr} to @var{port}.
@end deffn
port-with-print-state
-@c snarfed from print.c:1077
@deffn {Scheme Procedure} port-with-print-state port pstate
@deffnx {C Function} scm_port_with_print_state (port, pstate)
Create a new port which behaves like @var{port}, but with an
@@ -3574,7 +3209,6 @@ included print state @var{pstate}.
@end deffn
get-print-state
-@c snarfed from print.c:1092
@deffn {Scheme Procedure} get-print-state port
@deffnx {C Function} scm_get_print_state (port)
Return the print state of the port @var{port}. If @var{port}
@@ -3582,28 +3216,24 @@ has no associated print state, @code{#f} is returned.
@end deffn
procedure-properties
-@c snarfed from procprop.c:176
@deffn {Scheme Procedure} procedure-properties proc
@deffnx {C Function} scm_procedure_properties (proc)
Return @var{obj}'s property list.
@end deffn
set-procedure-properties!
-@c snarfed from procprop.c:189
@deffn {Scheme Procedure} set-procedure-properties! proc new_val
@deffnx {C Function} scm_set_procedure_properties_x (proc, new_val)
Set @var{obj}'s property list to @var{alist}.
@end deffn
procedure-property
-@c snarfed from procprop.c:202
@deffn {Scheme Procedure} procedure-property p k
@deffnx {C Function} scm_procedure_property (p, k)
Return the property of @var{obj} with name @var{key}.
@end deffn
set-procedure-property!
-@c snarfed from procprop.c:225
@deffn {Scheme Procedure} set-procedure-property! p k v
@deffnx {C Function} scm_set_procedure_property_x (p, k, v)
In @var{obj}'s property list, set the property named @var{key} to
@@ -3611,28 +3241,24 @@ In @var{obj}'s property list, set the property named @var{key} to
@end deffn
procedure?
-@c snarfed from procs.c:186
@deffn {Scheme Procedure} procedure? obj
@deffnx {C Function} scm_procedure_p (obj)
Return @code{#t} if @var{obj} is a procedure.
@end deffn
closure?
-@c snarfed from procs.c:213
@deffn {Scheme Procedure} closure? obj
@deffnx {C Function} scm_closure_p (obj)
Return @code{#t} if @var{obj} is a closure.
@end deffn
thunk?
-@c snarfed from procs.c:222
@deffn {Scheme Procedure} thunk? obj
@deffnx {C Function} scm_thunk_p (obj)
Return @code{#t} if @var{obj} is a thunk.
@end deffn
procedure-documentation
-@c snarfed from procs.c:272
@deffn {Scheme Procedure} procedure-documentation proc
@deffnx {C Function} scm_procedure_documentation (proc)
Return the documentation string associated with @code{proc}. By
@@ -3642,7 +3268,6 @@ documentation for that procedure.
@end deffn
procedure-with-setter?
-@c snarfed from procs.c:308
@deffn {Scheme Procedure} procedure-with-setter? obj
@deffnx {C Function} scm_procedure_with_setter_p (obj)
Return @code{#t} if @var{obj} is a procedure with an
@@ -3650,7 +3275,6 @@ associated setter procedure.
@end deffn
make-procedure-with-setter
-@c snarfed from procs.c:318
@deffn {Scheme Procedure} make-procedure-with-setter procedure setter
@deffnx {C Function} scm_make_procedure_with_setter (procedure, setter)
Create a new procedure which behaves like @var{procedure}, but
@@ -3658,7 +3282,6 @@ with the associated setter @var{setter}.
@end deffn
procedure
-@c snarfed from procs.c:332
@deffn {Scheme Procedure} procedure proc
@deffnx {C Function} scm_procedure (proc)
Return the procedure of @var{proc}, which must be either a
@@ -3666,7 +3289,6 @@ procedure with setter, or an operator struct.
@end deffn
primitive-make-property
-@c snarfed from properties.c:64
@deffn {Scheme Procedure} primitive-make-property not_found_proc
@deffnx {C Function} scm_primitive_make_property (not_found_proc)
Create a @dfn{property token} that can be used with
@@ -3676,7 +3298,6 @@ See @code{primitive-property-ref} for the significance of
@end deffn
primitive-property-ref
-@c snarfed from properties.c:82
@deffn {Scheme Procedure} primitive-property-ref prop obj
@deffnx {C Function} scm_primitive_property_ref (prop, obj)
Return the property @var{prop} of @var{obj}. When no value
@@ -3689,21 +3310,18 @@ default value of @var{prop}.
@end deffn
primitive-property-set!
-@c snarfed from properties.c:113
@deffn {Scheme Procedure} primitive-property-set! prop obj val
@deffnx {C Function} scm_primitive_property_set_x (prop, obj, val)
Associate @var{code} with @var{prop} and @var{obj}.
@end deffn
primitive-property-del!
-@c snarfed from properties.c:134
@deffn {Scheme Procedure} primitive-property-del! prop obj
@deffnx {C Function} scm_primitive_property_del_x (prop, obj)
Remove any value associated with @var{prop} and @var{obj}.
@end deffn
random
-@c snarfed from random.c:376
@deffn {Scheme Procedure} random n [state]
@deffnx {C Function} scm_random (n, state)
Return a number in [0,N).
@@ -3721,21 +3339,18 @@ as a side effect of the random operation.
@end deffn
copy-random-state
-@c snarfed from random.c:399
@deffn {Scheme Procedure} copy-random-state [state]
@deffnx {C Function} scm_copy_random_state (state)
Return a copy of the random state @var{state}.
@end deffn
seed->random-state
-@c snarfed from random.c:411
@deffn {Scheme Procedure} seed->random-state seed
@deffnx {C Function} scm_seed_to_random_state (seed)
Return a new random state using @var{seed}.
@end deffn
random:uniform
-@c snarfed from random.c:425
@deffn {Scheme Procedure} random:uniform [state]
@deffnx {C Function} scm_random_uniform (state)
Return a uniformly distributed inexact real random number in
@@ -3743,7 +3358,6 @@ Return a uniformly distributed inexact real random number in
@end deffn
random:normal
-@c snarfed from random.c:440
@deffn {Scheme Procedure} random:normal [state]
@deffnx {C Function} scm_random_normal (state)
Return an inexact real in a normal distribution. The
@@ -3753,7 +3367,6 @@ normal distribution with mean m and standard deviation d use
@end deffn
random:solid-sphere!
-@c snarfed from random.c:496
@deffn {Scheme Procedure} random:solid-sphere! v [state]
@deffnx {C Function} scm_random_solid_sphere_x (v, state)
Fills vect with inexact real random numbers
@@ -3765,7 +3378,6 @@ The sum of the squares of the numbers is returned.
@end deffn
random:hollow-sphere!
-@c snarfed from random.c:519
@deffn {Scheme Procedure} random:hollow-sphere! v [state]
@deffnx {C Function} scm_random_hollow_sphere_x (v, state)
Fills vect with inexact real random numbers
@@ -3777,7 +3389,6 @@ unit n-sphere.
@end deffn
random:normal-vector!
-@c snarfed from random.c:537
@deffn {Scheme Procedure} random:normal-vector! v [state]
@deffnx {C Function} scm_random_normal_vector_x (v, state)
Fills vect with inexact real random numbers that are
@@ -3786,7 +3397,6 @@ independent and standard normally distributed
@end deffn
random:exp
-@c snarfed from random.c:562
@deffn {Scheme Procedure} random:exp [state]
@deffnx {C Function} scm_random_exp (state)
Return an inexact real in an exponential distribution with mean
@@ -3795,7 +3405,6 @@ Return an inexact real in an exponential distribution with mean
@end deffn
%read-delimited!
-@c snarfed from rdelim.c:78
@deffn {Scheme Procedure} %read-delimited! delims str gobble [port [start [end]]]
@deffnx {C Function} scm_read_delimited_x (delims, str, gobble, port, start, end)
Read characters from @var{port} into @var{str} until one of the
@@ -3816,7 +3425,6 @@ a delimiter, this value is @code{#f}.
@end deffn
%read-line
-@c snarfed from rdelim.c:222
@deffn {Scheme Procedure} %read-line [port]
@deffnx {C Function} scm_read_line (port)
Read a newline-terminated line from @var{port}, allocating storage as
@@ -3828,7 +3436,6 @@ delimiter may be either a newline or the @var{eof-object}; if
@end deffn
write-line
-@c snarfed from rdelim.c:275
@deffn {Scheme Procedure} write-line obj [port]
@deffnx {C Function} scm_write_line (obj, port)
Display @var{obj} and a newline character to @var{port}. If
@@ -3841,16 +3448,14 @@ used. This function is equivalent to:
@end deffn
read-options-interface
-@c snarfed from read.c:82
@deffn {Scheme Procedure} read-options-interface [setting]
@deffnx {C Function} scm_read_options (setting)
Option interface for the read options. Instead of using
this procedure directly, use the procedures @code{read-enable},
-@code{read-disable}, @code{read-set!} and @var{read-options}.
+@code{read-disable}, @code{read-set!} and @code{read-options}.
@end deffn
read
-@c snarfed from read.c:102
@deffn {Scheme Procedure} read [port]
@deffnx {C Function} scm_read (port)
Read an s-expression from the input port @var{port}, or from
@@ -3859,7 +3464,6 @@ Any whitespace before the next token is discarded.
@end deffn
read-hash-extend
-@c snarfed from read.c:769
@deffn {Scheme Procedure} read-hash-extend chr proc
@deffnx {C Function} scm_read_hash_extend (chr, proc)
Install the procedure @var{proc} for reading expressions
@@ -3870,7 +3474,6 @@ returned will be the return value of @code{read}.
@end deffn
call-with-dynamic-root
-@c snarfed from root.c:352
@deffn {Scheme Procedure} call-with-dynamic-root thunk handler
@deffnx {C Function} scm_call_with_dynamic_root (thunk, handler)
Evaluate @code{(thunk)} in a new dynamic context, returning its value.
@@ -3918,7 +3521,6 @@ be under a new dynamic root.)
@end deffn
dynamic-root
-@c snarfed from root.c:365
@deffn {Scheme Procedure} dynamic-root
@deffnx {C Function} scm_dynamic_root ()
Return an object representing the current dynamic root.
@@ -3929,7 +3531,6 @@ in no way depend on this.
@end deffn
read-string!/partial
-@c snarfed from rw.c:121
@deffn {Scheme Procedure} read-string!/partial str [port_or_fdes [start [end]]]
@deffnx {C Function} scm_read_string_x_partial (str, port_or_fdes, start, end)
Read characters from a port or file descriptor into a
@@ -3972,7 +3573,6 @@ end-of-file check.
@end deffn
write-string/partial
-@c snarfed from rw.c:215
@deffn {Scheme Procedure} write-string/partial str [port_or_fdes [start [end]]]
@deffnx {C Function} scm_write_string_partial (str, port_or_fdes, start, end)
Write characters from a string @var{str} to a port or file
@@ -4019,7 +3619,6 @@ return 0 immediately if the request size is 0 bytes.
@end deffn
sigaction
-@c snarfed from scmsigs.c:182
@deffn {Scheme Procedure} sigaction signum [handler [flags]]
@deffnx {C Function} scm_sigaction (signum, handler, flags)
Install or report the signal handler for a specified signal.
@@ -4051,7 +3650,6 @@ structures.
@end deffn
restore-signals
-@c snarfed from scmsigs.c:345
@deffn {Scheme Procedure} restore-signals
@deffnx {C Function} scm_restore_signals ()
Return all signal handlers to the values they had before any call to
@@ -4059,7 +3657,6 @@ Return all signal handlers to the values they had before any call to
@end deffn
alarm
-@c snarfed from scmsigs.c:384
@deffn {Scheme Procedure} alarm i
@deffnx {C Function} scm_alarm (i)
Set a timer to raise a @code{SIGALRM} signal after the specified
@@ -4074,7 +3671,6 @@ no previous alarm, the return value is zero.
@end deffn
setitimer
-@c snarfed from scmsigs.c:414
@deffn {Scheme Procedure} setitimer which_timer interval_seconds interval_microseconds value_seconds value_microseconds
@deffnx {C Function} scm_setitimer (which_timer, interval_seconds, interval_microseconds, value_seconds, value_microseconds)
Set the timer specified by @var{which_timer} according to the given
@@ -4095,7 +3691,6 @@ the seconds and microseconds of the timer @code{it_value}.
@end deffn
getitimer
-@c snarfed from scmsigs.c:455
@deffn {Scheme Procedure} getitimer which_timer
@deffnx {C Function} scm_getitimer (which_timer)
Return information about the timer specified by @var{which_timer}
@@ -4112,7 +3707,6 @@ the seconds and microseconds of the timer @code{it_value}.
@end deffn
pause
-@c snarfed from scmsigs.c:482
@deffn {Scheme Procedure} pause
@deffnx {C Function} scm_pause ()
Pause the current process (thread?) until a signal arrives whose
@@ -4121,7 +3715,6 @@ handler procedure. The return value is unspecified.
@end deffn
sleep
-@c snarfed from scmsigs.c:495
@deffn {Scheme Procedure} sleep i
@deffnx {C Function} scm_sleep (i)
Wait for the given number of seconds (an integer) or until a signal
@@ -4130,7 +3723,6 @@ of seconds remaining otherwise.
@end deffn
usleep
-@c snarfed from scmsigs.c:513
@deffn {Scheme Procedure} usleep i
@deffnx {C Function} scm_usleep (i)
Sleep for I microseconds. @code{usleep} is not available on
@@ -4138,7 +3730,6 @@ all platforms.
@end deffn
raise
-@c snarfed from scmsigs.c:542
@deffn {Scheme Procedure} raise sig
@deffnx {C Function} scm_raise (sig)
Sends a specified signal @var{sig} to the current process, where
@@ -4146,7 +3737,6 @@ Sends a specified signal @var{sig} to the current process, where
@end deffn
system
-@c snarfed from simpos.c:76
@deffn {Scheme Procedure} system [cmd]
@deffnx {C Function} scm_system (cmd)
Execute @var{cmd} using the operating system's "command
@@ -4160,7 +3750,6 @@ indicating whether the command processor is available.
@end deffn
getenv
-@c snarfed from simpos.c:103
@deffn {Scheme Procedure} getenv nam
@deffnx {C Function} scm_getenv (nam)
Looks up the string @var{name} in the current environment. The return
@@ -4169,7 +3758,6 @@ found, in which case the string @code{VALUE} is returned.
@end deffn
primitive-exit
-@c snarfed from simpos.c:118
@deffn {Scheme Procedure} primitive-exit [status]
@deffnx {C Function} scm_primitive_exit (status)
Terminate the current process without unwinding the Scheme stack.
@@ -4178,7 +3766,6 @@ is @var{status} if supplied, otherwise zero.
@end deffn
restricted-vector-sort!
-@c snarfed from sort.c:422
@deffn {Scheme Procedure} restricted-vector-sort! vec less startpos endpos
@deffnx {C Function} scm_restricted_vector_sort_x (vec, less, startpos, endpos)
Sort the vector @var{vec}, using @var{less} for comparing
@@ -4188,7 +3775,6 @@ is not specified.
@end deffn
sorted?
-@c snarfed from sort.c:453
@deffn {Scheme Procedure} sorted? items less
@deffnx {C Function} scm_sorted_p (items, less)
Return @code{#t} iff @var{items} is a list or a vector such that
@@ -4197,7 +3783,6 @@ applied to all elements i - 1 and i
@end deffn
merge
-@c snarfed from sort.c:526
@deffn {Scheme Procedure} merge alist blist less
@deffnx {C Function} scm_merge (alist, blist, less)
Merge two already sorted lists into one.
@@ -4210,7 +3795,6 @@ Note: this does _not_ accept vectors.
@end deffn
merge!
-@c snarfed from sort.c:639
@deffn {Scheme Procedure} merge! alist blist less
@deffnx {C Function} scm_merge_x (alist, blist, less)
Takes two lists @var{alist} and @var{blist} such that
@@ -4223,7 +3807,6 @@ Note: this does _not_ accept vectors.
@end deffn
sort!
-@c snarfed from sort.c:715
@deffn {Scheme Procedure} sort! items less
@deffnx {C Function} scm_sort_x (items, less)
Sort the sequence @var{items}, which may be a list or a
@@ -4234,7 +3817,6 @@ This is not a stable sort.
@end deffn
sort
-@c snarfed from sort.c:749
@deffn {Scheme Procedure} sort items less
@deffnx {C Function} scm_sort (items, less)
Sort the sequence @var{items}, which may be a list or a
@@ -4243,7 +3825,6 @@ elements. This is not a stable sort.
@end deffn
stable-sort!
-@c snarfed from sort.c:845
@deffn {Scheme Procedure} stable-sort! items less
@deffnx {C Function} scm_stable_sort_x (items, less)
Sort the sequence @var{items}, which may be a list or a
@@ -4254,7 +3835,6 @@ This is a stable sort.
@end deffn
stable-sort
-@c snarfed from sort.c:885
@deffn {Scheme Procedure} stable-sort items less
@deffnx {C Function} scm_stable_sort (items, less)
Sort the sequence @var{items}, which may be a list or a
@@ -4263,7 +3843,6 @@ This is a stable sort.
@end deffn
sort-list!
-@c snarfed from sort.c:931
@deffn {Scheme Procedure} sort-list! items less
@deffnx {C Function} scm_sort_list_x (items, less)
Sort the list @var{items}, using @var{less} for comparing the
@@ -4273,7 +3852,6 @@ This is a stable sort.
@end deffn
sort-list
-@c snarfed from sort.c:945
@deffn {Scheme Procedure} sort-list items less
@deffnx {C Function} scm_sort_list (items, less)
Sort the list @var{items}, using @var{less} for comparing the
@@ -4281,14 +3859,12 @@ list elements. This is a stable sort.
@end deffn
source-properties
-@c snarfed from srcprop.c:170
@deffn {Scheme Procedure} source-properties obj
@deffnx {C Function} scm_source_properties (obj)
Return the source property association list of @var{obj}.
@end deffn
set-source-properties!
-@c snarfed from srcprop.c:193
@deffn {Scheme Procedure} set-source-properties! obj plist
@deffnx {C Function} scm_set_source_properties_x (obj, plist)
Install the association list @var{plist} as the source property
@@ -4296,7 +3872,6 @@ list for @var{obj}.
@end deffn
source-property
-@c snarfed from srcprop.c:213
@deffn {Scheme Procedure} source-property obj key
@deffnx {C Function} scm_source_property (obj, key)
Return the source property specified by @var{key} from
@@ -4304,7 +3879,6 @@ Return the source property specified by @var{key} from
@end deffn
set-source-property!
-@c snarfed from srcprop.c:246
@deffn {Scheme Procedure} set-source-property! obj key datum
@deffnx {C Function} scm_set_source_property_x (obj, key, datum)
Set the source property of object @var{obj}, which is specified by
@@ -4312,14 +3886,12 @@ Set the source property of object @var{obj}, which is specified by
@end deffn
stack?
-@c snarfed from stacks.c:411
@deffn {Scheme Procedure} stack? obj
@deffnx {C Function} scm_stack_p (obj)
Return @code{#t} if @var{obj} is a calling stack.
@end deffn
make-stack
-@c snarfed from stacks.c:442
@deffn {Scheme Procedure} make-stack obj . args
@deffnx {C Function} scm_make_stack (obj, args)
Create a new stack. If @var{obj} is @code{#t}, the current
@@ -4353,35 +3925,30 @@ taken as 0.
@end deffn
stack-id
-@c snarfed from stacks.c:534
@deffn {Scheme Procedure} stack-id stack
@deffnx {C Function} scm_stack_id (stack)
Return the identifier given to @var{stack} by @code{start-stack}.
@end deffn
stack-ref
-@c snarfed from stacks.c:575
@deffn {Scheme Procedure} stack-ref stack index
@deffnx {C Function} scm_stack_ref (stack, index)
Return the @var{index}'th frame from @var{stack}.
@end deffn
stack-length
-@c snarfed from stacks.c:591
@deffn {Scheme Procedure} stack-length stack
@deffnx {C Function} scm_stack_length (stack)
Return the length of @var{stack}.
@end deffn
frame?
-@c snarfed from stacks.c:604
@deffn {Scheme Procedure} frame? obj
@deffnx {C Function} scm_frame_p (obj)
Return @code{#t} if @var{obj} is a stack frame.
@end deffn
last-stack-frame
-@c snarfed from stacks.c:615
@deffn {Scheme Procedure} last-stack-frame obj
@deffnx {C Function} scm_last_stack_frame (obj)
Return a stack which consists of a single frame, which is the
@@ -4390,21 +3957,18 @@ debug object or a continuation.
@end deffn
frame-number
-@c snarfed from stacks.c:657
@deffn {Scheme Procedure} frame-number frame
@deffnx {C Function} scm_frame_number (frame)
Return the frame number of @var{frame}.
@end deffn
frame-source
-@c snarfed from stacks.c:667
@deffn {Scheme Procedure} frame-source frame
@deffnx {C Function} scm_frame_source (frame)
Return the source of @var{frame}.
@end deffn
frame-procedure
-@c snarfed from stacks.c:678
@deffn {Scheme Procedure} frame-procedure frame
@deffnx {C Function} scm_frame_procedure (frame)
Return the procedure for @var{frame}, or @code{#f} if no
@@ -4412,14 +3976,12 @@ procedure is associated with @var{frame}.
@end deffn
frame-arguments
-@c snarfed from stacks.c:690
@deffn {Scheme Procedure} frame-arguments frame
@deffnx {C Function} scm_frame_arguments (frame)
Return the arguments of @var{frame}.
@end deffn
frame-previous
-@c snarfed from stacks.c:701
@deffn {Scheme Procedure} frame-previous frame
@deffnx {C Function} scm_frame_previous (frame)
Return the previous frame of @var{frame}, or @code{#f} if
@@ -4427,7 +3989,6 @@ Return the previous frame of @var{frame}, or @code{#f} if
@end deffn
frame-next
-@c snarfed from stacks.c:717
@deffn {Scheme Procedure} frame-next frame
@deffnx {C Function} scm_frame_next (frame)
Return the next frame of @var{frame}, or @code{#f} if
@@ -4435,35 +3996,30 @@ Return the next frame of @var{frame}, or @code{#f} if
@end deffn
frame-real?
-@c snarfed from stacks.c:732
@deffn {Scheme Procedure} frame-real? frame
@deffnx {C Function} scm_frame_real_p (frame)
Return @code{#t} if @var{frame} is a real frame.
@end deffn
frame-procedure?
-@c snarfed from stacks.c:742
@deffn {Scheme Procedure} frame-procedure? frame
@deffnx {C Function} scm_frame_procedure_p (frame)
Return @code{#t} if a procedure is associated with @var{frame}.
@end deffn
frame-evaluating-args?
-@c snarfed from stacks.c:752
@deffn {Scheme Procedure} frame-evaluating-args? frame
@deffnx {C Function} scm_frame_evaluating_args_p (frame)
Return @code{#t} if @var{frame} contains evaluated arguments.
@end deffn
frame-overflow?
-@c snarfed from stacks.c:762
@deffn {Scheme Procedure} frame-overflow? frame
@deffnx {C Function} scm_frame_overflow_p (frame)
Return @code{#t} if @var{frame} is an overflow frame.
@end deffn
get-internal-real-time
-@c snarfed from stime.c:143
@deffn {Scheme Procedure} get-internal-real-time
@deffnx {C Function} scm_get_internal_real_time ()
Return the number of time units since the interpreter was
@@ -4471,7 +4027,6 @@ started.
@end deffn
times
-@c snarfed from stime.c:188
@deffn {Scheme Procedure} times
@deffnx {C Function} scm_times ()
Return an object with information about real and processor
@@ -4498,7 +4053,6 @@ terminated child processes.
@end deffn
get-internal-run-time
-@c snarfed from stime.c:220
@deffn {Scheme Procedure} get-internal-run-time
@deffnx {C Function} scm_get_internal_run_time ()
Return the number of time units of processor time used by the
@@ -4507,7 +4061,6 @@ included but subprocesses are not.
@end deffn
current-time
-@c snarfed from stime.c:230
@deffn {Scheme Procedure} current-time
@deffnx {C Function} scm_current_time ()
Return the number of seconds since 1970-01-01 00:00:00 UTC,
@@ -4515,7 +4068,6 @@ excluding leap seconds.
@end deffn
gettimeofday
-@c snarfed from stime.c:248
@deffn {Scheme Procedure} gettimeofday
@deffnx {C Function} scm_gettimeofday ()
Return a pair containing the number of seconds and microseconds
@@ -4525,7 +4077,6 @@ operating system.
@end deffn
localtime
-@c snarfed from stime.c:347
@deffn {Scheme Procedure} localtime time [zone]
@deffnx {C Function} scm_localtime (time, zone)
Return an object representing the broken down components of
@@ -4536,7 +4087,6 @@ optionally specified by @var{zone} (a string), otherwise the
@end deffn
gmtime
-@c snarfed from stime.c:420
@deffn {Scheme Procedure} gmtime time
@deffnx {C Function} scm_gmtime (time)
Return an object representing the broken down components of
@@ -4545,7 +4095,6 @@ Return an object representing the broken down components of
@end deffn
mktime
-@c snarfed from stime.c:482
@deffn {Scheme Procedure} mktime sbd_time [zone]
@deffnx {C Function} scm_mktime (sbd_time, zone)
@var{bd-time} is an object representing broken down time and @code{zone}
@@ -4559,7 +4108,6 @@ as @var{bd-time} but with normalized values.
@end deffn
tzset
-@c snarfed from stime.c:556
@deffn {Scheme Procedure} tzset
@deffnx {C Function} scm_tzset ()
Initialize the timezone from the TZ environment variable
@@ -4569,7 +4117,6 @@ timezone.
@end deffn
strftime
-@c snarfed from stime.c:573
@deffn {Scheme Procedure} strftime format stime
@deffnx {C Function} scm_strftime (format, stime)
Formats a time specification @var{time} using @var{template}. @var{time}
@@ -4582,7 +4129,6 @@ is the formatted string.
@end deffn
strptime
-@c snarfed from stime.c:670
@deffn {Scheme Procedure} strptime format string
@deffnx {C Function} scm_strptime (format, string)
Performs the reverse action to @code{strftime}, parsing
@@ -4598,20 +4144,17 @@ which were used for the conversion.
@end deffn
string?
-@c snarfed from strings.c:61
@deffn {Scheme Procedure} string? obj
@deffnx {C Function} scm_string_p (obj)
-Return @code{#t} iff @var{obj} is a string, else @code{#f}.
+Return @code{#t} if @var{obj} is a string, else @code{#f}.
@end deffn
list->string
-@c snarfed from strings.c:69
@deffn {Scheme Procedure} list->string
implemented by the C function "scm_string"
@end deffn
string
-@c snarfed from strings.c:75
@deffn {Scheme Procedure} string . chrs
@deffnx {Scheme Procedure} list->string chrs
@deffnx {C Function} scm_string (chrs)
@@ -4620,7 +4163,6 @@ Return a newly allocated string composed of the arguments,
@end deffn
make-string
-@c snarfed from strings.c:209
@deffn {Scheme Procedure} make-string k [chr]
@deffnx {C Function} scm_make_string (k, chr)
Return a newly allocated string of
@@ -4630,14 +4172,12 @@ of the @var{string} are unspecified.
@end deffn
string-length
-@c snarfed from strings.c:242
@deffn {Scheme Procedure} string-length string
@deffnx {C Function} scm_string_length (string)
Return the number of characters in @var{string}.
@end deffn
string-ref
-@c snarfed from strings.c:253
@deffn {Scheme Procedure} string-ref str k
@deffnx {C Function} scm_string_ref (str, k)
Return character @var{k} of @var{str} using zero-origin
@@ -4645,7 +4185,6 @@ indexing. @var{k} must be a valid index of @var{str}.
@end deffn
string-set!
-@c snarfed from strings.c:270
@deffn {Scheme Procedure} string-set! str k chr
@deffnx {C Function} scm_string_set_x (str, k, chr)
Store @var{chr} in element @var{k} of @var{str} and return
@@ -4654,7 +4193,6 @@ an unspecified value. @var{k} must be a valid index of
@end deffn
substring
-@c snarfed from strings.c:289
@deffn {Scheme Procedure} substring str start [end]
@deffnx {C Function} scm_substring (str, start, end)
Return a newly allocated string formed from the characters
@@ -4667,7 +4205,6 @@ exact integers satisfying:
@end deffn
string-append
-@c snarfed from strings.c:315
@deffn {Scheme Procedure} string-append . args
@deffnx {C Function} scm_string_append (args)
Return a newly allocated string whose characters form the
@@ -4675,7 +4212,6 @@ concatenation of the given strings, @var{args}.
@end deffn
string-index
-@c snarfed from strop.c:138
@deffn {Scheme Procedure} string-index str chr [frm [to]]
@deffnx {C Function} scm_string_index (str, chr, frm, to)
Return the index of the first occurrence of @var{chr} in
@@ -4697,7 +4233,6 @@ procedure essentially implements the @code{index} or
@end deffn
string-rindex
-@c snarfed from strop.c:168
@deffn {Scheme Procedure} string-rindex str chr [frm [to]]
@deffnx {C Function} scm_string_rindex (str, chr, frm, to)
Like @code{string-index}, but search from the right of the
@@ -4718,7 +4253,6 @@ the C library.
@end deffn
substring-move!
-@c snarfed from strop.c:188
@deffn {Scheme Procedure} substring-move! str1 start1 end1 str2 start2
@deffnx {C Function} scm_substring_move_x (str1, start1, end1, str2, start2)
Copy the substring of @var{str1} bounded by @var{start1} and @var{end1}
@@ -4727,7 +4261,6 @@ into @var{str2} beginning at position @var{start2}.
@end deffn
substring-fill!
-@c snarfed from strop.c:224
@deffn {Scheme Procedure} substring-fill! str start end fill
@deffnx {C Function} scm_substring_fill_x (str, start, end, fill)
Change every character in @var{str} between @var{start} and
@@ -4742,7 +4275,6 @@ y
@end deffn
string-null?
-@c snarfed from strop.c:249
@deffn {Scheme Procedure} string-null? str
@deffnx {C Function} scm_string_null_p (str)
Return @code{#t} if @var{str}'s length is zero, and
@@ -4755,7 +4287,6 @@ y @result{} "foo"
@end deffn
string->list
-@c snarfed from strop.c:263
@deffn {Scheme Procedure} string->list str
@deffnx {C Function} scm_string_to_list (str)
Return a newly allocated list of the characters that make up
@@ -4765,14 +4296,12 @@ concerned.
@end deffn
string-copy
-@c snarfed from strop.c:292
@deffn {Scheme Procedure} string-copy str
@deffnx {C Function} scm_string_copy (str)
Return a newly allocated copy of the given @var{string}.
@end deffn
string-fill!
-@c snarfed from strop.c:305
@deffn {Scheme Procedure} string-fill! str chr
@deffnx {C Function} scm_string_fill_x (str, chr)
Store @var{char} in every element of the given @var{string} and
@@ -4780,7 +4309,6 @@ return an unspecified value.
@end deffn
string-upcase!
-@c snarfed from strop.c:340
@deffn {Scheme Procedure} string-upcase! str
@deffnx {C Function} scm_string_upcase_x (str)
Destructively upcase every character in @var{str} and return
@@ -4793,7 +4321,6 @@ y @result{} "ARRDEFG"
@end deffn
string-upcase
-@c snarfed from strop.c:353
@deffn {Scheme Procedure} string-upcase str
@deffnx {C Function} scm_string_upcase (str)
Return a freshly allocated string containing the characters of
@@ -4801,7 +4328,6 @@ Return a freshly allocated string containing the characters of
@end deffn
string-downcase!
-@c snarfed from strop.c:385
@deffn {Scheme Procedure} string-downcase! str
@deffnx {C Function} scm_string_downcase_x (str)
Destructively downcase every character in @var{str} and return
@@ -4814,7 +4340,6 @@ y @result{} "arrdefg"
@end deffn
string-downcase
-@c snarfed from strop.c:398
@deffn {Scheme Procedure} string-downcase str
@deffnx {C Function} scm_string_downcase (str)
Return a freshly allocation string containing the characters in
@@ -4822,7 +4347,6 @@ Return a freshly allocation string containing the characters in
@end deffn
string-capitalize!
-@c snarfed from strop.c:443
@deffn {Scheme Procedure} string-capitalize! str
@deffnx {C Function} scm_string_capitalize_x (str)
Upcase the first character of every word in @var{str}
@@ -4836,7 +4360,6 @@ y @result{} "Hello World"
@end deffn
string-capitalize
-@c snarfed from strop.c:457
@deffn {Scheme Procedure} string-capitalize str
@deffnx {C Function} scm_string_capitalize (str)
Return a freshly allocated string with the characters in
@@ -4845,7 +4368,6 @@ capitalized.
@end deffn
string-split
-@c snarfed from strop.c:486
@deffn {Scheme Procedure} string-split str chr
@deffnx {C Function} scm_string_split (str, chr)
Split the string @var{str} into the a list of the substrings delimited
@@ -4869,7 +4391,6 @@ result list.
@end deffn
string-ci->symbol
-@c snarfed from strop.c:521
@deffn {Scheme Procedure} string-ci->symbol str
@deffnx {C Function} scm_string_ci_to_symbol (str)
Return the symbol whose name is @var{str}. @var{str} is
@@ -4878,7 +4399,6 @@ is currently reading symbols case-insensitively.
@end deffn
string=?
-@c snarfed from strorder.c:62
@deffn {Scheme Procedure} string=? s1 s2
Lexicographic equality predicate; return @code{#t} if the two
strings are the same length and contain the same characters in
@@ -4891,7 +4411,6 @@ characters.
@end deffn
string-ci=?
-@c snarfed from strorder.c:97
@deffn {Scheme Procedure} string-ci=? s1 s2
Case-insensitive string equality predicate; return @code{#t} if
the two strings are the same length and their component
@@ -4900,35 +4419,30 @@ return @code{#f}.
@end deffn
string<?
-@c snarfed from strorder.c:154
@deffn {Scheme Procedure} string<? s1 s2
Lexicographic ordering predicate; return @code{#t} if @var{s1}
is lexicographically less than @var{s2}.
@end deffn
string<=?
-@c snarfed from strorder.c:168
@deffn {Scheme Procedure} string<=? s1 s2
Lexicographic ordering predicate; return @code{#t} if @var{s1}
is lexicographically less than or equal to @var{s2}.
@end deffn
string>?
-@c snarfed from strorder.c:182
@deffn {Scheme Procedure} string>? s1 s2
Lexicographic ordering predicate; return @code{#t} if @var{s1}
is lexicographically greater than @var{s2}.
@end deffn
string>=?
-@c snarfed from strorder.c:196
@deffn {Scheme Procedure} string>=? s1 s2
Lexicographic ordering predicate; return @code{#t} if @var{s1}
is lexicographically greater than or equal to @var{s2}.
@end deffn
string-ci<?
-@c snarfed from strorder.c:235
@deffn {Scheme Procedure} string-ci<? s1 s2
Case insensitive lexicographic ordering predicate; return
@code{#t} if @var{s1} is lexicographically less than @var{s2}
@@ -4936,7 +4450,6 @@ regardless of case.
@end deffn
string-ci<=?
-@c snarfed from strorder.c:250
@deffn {Scheme Procedure} string-ci<=? s1 s2
Case insensitive lexicographic ordering predicate; return
@code{#t} if @var{s1} is lexicographically less than or equal
@@ -4944,7 +4457,6 @@ to @var{s2} regardless of case.
@end deffn
string-ci>?
-@c snarfed from strorder.c:265
@deffn {Scheme Procedure} string-ci>? s1 s2
Case insensitive lexicographic ordering predicate; return
@code{#t} if @var{s1} is lexicographically greater than
@@ -4952,7 +4464,6 @@ Case insensitive lexicographic ordering predicate; return
@end deffn
string-ci>=?
-@c snarfed from strorder.c:280
@deffn {Scheme Procedure} string-ci>=? s1 s2
Case insensitive lexicographic ordering predicate; return
@code{#t} if @var{s1} is lexicographically greater than or
@@ -4960,7 +4471,6 @@ equal to @var{s2} regardless of case.
@end deffn
object->string
-@c snarfed from strports.c:321
@deffn {Scheme Procedure} object->string obj [printer]
@deffnx {C Function} scm_object_to_string (obj, printer)
Return a Scheme string obtained by printing @var{obj}.
@@ -4969,7 +4479,6 @@ argument @var{printer} (default: @code{write}).
@end deffn
call-with-output-string
-@c snarfed from strports.c:345
@deffn {Scheme Procedure} call-with-output-string proc
@deffnx {C Function} scm_call_with_output_string (proc)
Calls the one-argument procedure @var{proc} with a newly created output
@@ -4978,7 +4487,6 @@ written into the port is returned.
@end deffn
call-with-input-string
-@c snarfed from strports.c:364
@deffn {Scheme Procedure} call-with-input-string string proc
@deffnx {C Function} scm_call_with_input_string (string, proc)
Calls the one-argument procedure @var{proc} with a newly
@@ -4987,7 +4495,6 @@ read. The value yielded by the @var{proc} is returned.
@end deffn
open-input-string
-@c snarfed from strports.c:377
@deffn {Scheme Procedure} open-input-string str
@deffnx {C Function} scm_open_input_string (str)
Take a string and return an input port that delivers characters
@@ -4997,7 +4504,6 @@ by the garbage collector if it becomes inaccessible.
@end deffn
open-output-string
-@c snarfed from strports.c:391
@deffn {Scheme Procedure} open-output-string
@deffnx {C Function} scm_open_output_string ()
Return an output port that will accumulate characters for
@@ -5008,7 +4514,6 @@ inaccessible.
@end deffn
get-output-string
-@c snarfed from strports.c:408
@deffn {Scheme Procedure} get-output-string port
@deffnx {C Function} scm_get_output_string (port)
Given an output port created by @code{open-output-string},
@@ -5017,7 +4522,6 @@ output to the port so far.
@end deffn
eval-string
-@c snarfed from strports.c:467
@deffn {Scheme Procedure} eval-string string
@deffnx {C Function} scm_eval_string (string)
Evaluate @var{string} as the text representation of a Scheme
@@ -5027,7 +4531,6 @@ procedure @code{interaction-environment}.
@end deffn
make-struct-layout
-@c snarfed from struct.c:77
@deffn {Scheme Procedure} make-struct-layout fields
@deffnx {C Function} scm_make_struct_layout (fields)
Return a new structure layout object.
@@ -5043,7 +4546,6 @@ indicate that the field is a tail-array.
@end deffn
struct?
-@c snarfed from struct.c:244
@deffn {Scheme Procedure} struct? x
@deffnx {C Function} scm_struct_p (x)
Return @code{#t} iff @var{x} is a structure object, else
@@ -5051,14 +4553,12 @@ Return @code{#t} iff @var{x} is a structure object, else
@end deffn
struct-vtable?
-@c snarfed from struct.c:253
@deffn {Scheme Procedure} struct-vtable? x
@deffnx {C Function} scm_struct_vtable_p (x)
Return @code{#t} iff @var{x} is a vtable structure.
@end deffn
make-struct
-@c snarfed from struct.c:434
@deffn {Scheme Procedure} make-struct vtable tail_array_size . init
@deffnx {C Function} scm_make_struct (vtable, tail_array_size, init)
Create a new structure.
@@ -5089,7 +4589,6 @@ For more information, see the documentation for @code{make-vtable-vtable}.
@end deffn
make-vtable-vtable
-@c snarfed from struct.c:519
@deffn {Scheme Procedure} make-vtable-vtable user_fields tail_array_size . init
@deffnx {C Function} scm_make_vtable_vtable (user_fields, tail_array_size, init)
Return a new, self-describing vtable structure.
@@ -5151,7 +4650,6 @@ ball @result{} #<a green ball owned by Nisse>
@end deffn
struct-ref
-@c snarfed from struct.c:560
@deffn {Scheme Procedure} struct-ref handle pos
@deffnx {Scheme Procedure} struct-set! struct n value
@deffnx {C Function} scm_struct_ref (handle, pos)
@@ -5164,7 +4662,6 @@ integer value small enough to fit in one machine word.
@end deffn
struct-set!
-@c snarfed from struct.c:638
@deffn {Scheme Procedure} struct-set! handle pos val
@deffnx {C Function} scm_struct_set_x (handle, pos, val)
Set the slot of the structure @var{handle} with index @var{pos}
@@ -5173,35 +4670,30 @@ to.
@end deffn
struct-vtable
-@c snarfed from struct.c:708
@deffn {Scheme Procedure} struct-vtable handle
@deffnx {C Function} scm_struct_vtable (handle)
Return the vtable structure that describes the type of @var{struct}.
@end deffn
struct-vtable-tag
-@c snarfed from struct.c:719
@deffn {Scheme Procedure} struct-vtable-tag handle
@deffnx {C Function} scm_struct_vtable_tag (handle)
Return the vtable tag of the structure @var{handle}.
@end deffn
struct-vtable-name
-@c snarfed from struct.c:758
@deffn {Scheme Procedure} struct-vtable-name vtable
@deffnx {C Function} scm_struct_vtable_name (vtable)
Return the name of the vtable @var{vtable}.
@end deffn
set-struct-vtable-name!
-@c snarfed from struct.c:768
@deffn {Scheme Procedure} set-struct-vtable-name! vtable name
@deffnx {C Function} scm_set_struct_vtable_name_x (vtable, name)
Set the name of the vtable @var{vtable} to @var{name}.
@end deffn
symbol?
-@c snarfed from symbols.c:164
@deffn {Scheme Procedure} symbol? obj
@deffnx {C Function} scm_symbol_p (obj)
Return @code{#t} if @var{obj} is a symbol, otherwise return
@@ -5209,7 +4701,6 @@ Return @code{#t} if @var{obj} is a symbol, otherwise return
@end deffn
symbol-interned?
-@c snarfed from symbols.c:174
@deffn {Scheme Procedure} symbol-interned? symbol
@deffnx {C Function} scm_symbol_interned_p (symbol)
Return @code{#t} if @var{symbol} is interned, otherwise return
@@ -5217,14 +4708,12 @@ Return @code{#t} if @var{symbol} is interned, otherwise return
@end deffn
make-symbol
-@c snarfed from symbols.c:186
@deffn {Scheme Procedure} make-symbol name
@deffnx {C Function} scm_make_symbol (name)
Return a new uninterned symbol with the name @var{name}. The returned symbol is guaranteed to be unique and future calls to @code{string->symbol} will not return it.
@end deffn
symbol->string
-@c snarfed from symbols.c:222
@deffn {Scheme Procedure} symbol->string s
@deffnx {C Function} scm_symbol_to_string (s)
Return the name of @var{symbol} as a string. If the symbol was
@@ -5253,7 +4742,6 @@ standard case is lower case:
@end deffn
string->symbol
-@c snarfed from symbols.c:255
@deffn {Scheme Procedure} string->symbol string
@deffnx {C Function} scm_string_to_symbol (string)
Return the symbol whose name is @var{string}. This procedure
@@ -5279,7 +4767,6 @@ standard case is lower case:
@end deffn
gensym
-@c snarfed from symbols.c:277
@deffn {Scheme Procedure} gensym [prefix]
@deffnx {C Function} scm_gensym (prefix)
Create a new symbol with a name constructed from a prefix and
@@ -5290,42 +4777,36 @@ resetting the counter.
@end deffn
symbol-hash
-@c snarfed from symbols.c:309
@deffn {Scheme Procedure} symbol-hash symbol
@deffnx {C Function} scm_symbol_hash (symbol)
Return a hash value for @var{symbol}.
@end deffn
symbol-fref
-@c snarfed from symbols.c:319
@deffn {Scheme Procedure} symbol-fref s
@deffnx {C Function} scm_symbol_fref (s)
Return the contents of @var{symbol}'s @dfn{function slot}.
@end deffn
symbol-pref
-@c snarfed from symbols.c:330
@deffn {Scheme Procedure} symbol-pref s
@deffnx {C Function} scm_symbol_pref (s)
Return the @dfn{property list} currently associated with @var{symbol}.
@end deffn
symbol-fset!
-@c snarfed from symbols.c:341
@deffn {Scheme Procedure} symbol-fset! s val
@deffnx {C Function} scm_symbol_fset_x (s, val)
Change the binding of @var{symbol}'s function slot.
@end deffn
symbol-pset!
-@c snarfed from symbols.c:353
@deffn {Scheme Procedure} symbol-pset! s val
@deffnx {C Function} scm_symbol_pset_x (s, val)
Change the binding of @var{symbol}'s property slot.
@end deffn
catch
-@c snarfed from throw.c:534
@deffn {Scheme Procedure} catch key thunk handler
@deffnx {C Function} scm_catch (key, thunk, handler)
Invoke @var{thunk} in the dynamic context of @var{handler} for
@@ -5349,7 +4830,6 @@ match this call to @code{catch}.
@end deffn
lazy-catch
-@c snarfed from throw.c:562
@deffn {Scheme Procedure} lazy-catch key thunk handler
@deffnx {C Function} scm_lazy_catch (key, thunk, handler)
This behaves exactly like @code{catch}, except that it does
@@ -5359,7 +4839,6 @@ it must throw to another catch, or otherwise exit non-locally.
@end deffn
throw
-@c snarfed from throw.c:595
@deffn {Scheme Procedure} throw key . args
@deffnx {C Function} scm_throw (key, args)
Invoke the catch form matching @var{key}, passing @var{args} to the
@@ -5372,7 +4851,6 @@ If there is no handler at all, Guile prints an error and then exits.
@end deffn
values
-@c snarfed from values.c:77
@deffn {Scheme Procedure} values . args
@deffnx {C Function} scm_values (args)
Delivers all of its arguments to its continuation. Except for
@@ -5383,21 +4861,18 @@ were not created by @code{call-with-values} is unspecified.
@end deffn
make-variable
-@c snarfed from variable.c:76
@deffn {Scheme Procedure} make-variable init
@deffnx {C Function} scm_make_variable (init)
Return a variable initialized to value @var{init}.
@end deffn
make-undefined-variable
-@c snarfed from variable.c:86
@deffn {Scheme Procedure} make-undefined-variable
@deffnx {C Function} scm_make_undefined_variable ()
Return a variable that is initially unbound.
@end deffn
variable?
-@c snarfed from variable.c:97
@deffn {Scheme Procedure} variable? obj
@deffnx {C Function} scm_variable_p (obj)
Return @code{#t} iff @var{obj} is a variable object, else
@@ -5405,7 +4880,6 @@ return @code{#f}.
@end deffn
variable-ref
-@c snarfed from variable.c:109
@deffn {Scheme Procedure} variable-ref var
@deffnx {C Function} scm_variable_ref (var)
Dereference @var{var} and return its value.
@@ -5414,7 +4888,6 @@ and @code{make-undefined-variable}.
@end deffn
variable-set!
-@c snarfed from variable.c:125
@deffn {Scheme Procedure} variable-set! var val
@deffnx {C Function} scm_variable_set_x (var, val)
Set the value of the variable @var{var} to @var{val}.
@@ -5423,7 +4896,6 @@ value. Return an unspecified value.
@end deffn
variable-bound?
-@c snarfed from variable.c:137
@deffn {Scheme Procedure} variable-bound? var
@deffnx {C Function} scm_variable_bound_p (var)
Return @code{#t} iff @var{var} is bound to a value.
@@ -5431,7 +4903,6 @@ Throws an error if @var{var} is not a variable object.
@end deffn
vector?
-@c snarfed from vectors.c:59
@deffn {Scheme Procedure} vector? obj
@deffnx {C Function} scm_vector_p (obj)
Return @code{#t} if @var{obj} is a vector, otherwise return
@@ -5439,13 +4910,11 @@ Return @code{#t} if @var{obj} is a vector, otherwise return
@end deffn
list->vector
-@c snarfed from vectors.c:76
@deffn {Scheme Procedure} list->vector
implemented by the C function "scm_vector"
@end deffn
vector
-@c snarfed from vectors.c:93
@deffn {Scheme Procedure} vector . l
@deffnx {Scheme Procedure} list->vector l
@deffnx {C Function} scm_vector (l)
@@ -5458,7 +4927,6 @@ given arguments. Analogous to @code{list}.
@end deffn
make-vector
-@c snarfed from vectors.c:179
@deffn {Scheme Procedure} make-vector k [fill]
@deffnx {C Function} scm_make_vector (k, fill)
Return a newly allocated vector of @var{k} elements. If a
@@ -5468,7 +4936,6 @@ unspecified.
@end deffn
vector->list
-@c snarfed from vectors.c:233
@deffn {Scheme Procedure} vector->list v
@deffnx {C Function} scm_vector_to_list (v)
Return a newly allocated list composed of the elements of @var{v}.
@@ -5480,7 +4947,6 @@ Return a newly allocated list composed of the elements of @var{v}.
@end deffn
vector-fill!
-@c snarfed from vectors.c:250
@deffn {Scheme Procedure} vector-fill! v fill
@deffnx {C Function} scm_vector_fill_x (v, fill)
Store @var{fill} in every position of @var{vector}. The value
@@ -5488,7 +4954,6 @@ returned by @code{vector-fill!} is unspecified.
@end deffn
vector-move-left!
-@c snarfed from vectors.c:283
@deffn {Scheme Procedure} vector-move-left! vec1 start1 end1 vec2 start2
@deffnx {C Function} scm_vector_move_left_x (vec1, start1, end1, vec2, start2)
Copy elements from @var{vec1}, positions @var{start1} to @var{end1},
@@ -5502,7 +4967,6 @@ same vector, @code{vector-move-left!} is usually appropriate when
@end deffn
vector-move-right!
-@c snarfed from vectors.c:312
@deffn {Scheme Procedure} vector-move-right! vec1 start1 end1 vec2 start2
@deffnx {C Function} scm_vector_move_right_x (vec1, start1, end1, vec2, start2)
Copy elements from @var{vec1}, positions @var{start1} to @var{end1},
@@ -5516,7 +4980,6 @@ same vector, @code{vector-move-right!} is usually appropriate when
@end deffn
major-version
-@c snarfed from version.c:59
@deffn {Scheme Procedure} major-version
@deffnx {C Function} scm_major_version ()
Return a string containing Guile's major version number.
@@ -5524,7 +4987,6 @@ E.g., the 1 in "1.6.5".
@end deffn
minor-version
-@c snarfed from version.c:72
@deffn {Scheme Procedure} minor-version
@deffnx {C Function} scm_minor_version ()
Return a string containing Guile's minor version number.
@@ -5532,7 +4994,6 @@ E.g., the 6 in "1.6.5".
@end deffn
micro-version
-@c snarfed from version.c:85
@deffn {Scheme Procedure} micro-version
@deffnx {C Function} scm_micro_version ()
Return a string containing Guile's micro version number.
@@ -5540,7 +5001,6 @@ E.g., the 5 in "1.6.5".
@end deffn
version
-@c snarfed from version.c:107
@deffn {Scheme Procedure} version
@deffnx {Scheme Procedure} major-version
@deffnx {Scheme Procedure} minor-version
@@ -5558,7 +5018,6 @@ or micro version number, respectively.
@end deffn
make-soft-port
-@c snarfed from vports.c:185
@deffn {Scheme Procedure} make-soft-port pv modes
@deffnx {C Function} scm_make_soft_port (pv, modes)
Return a port capable of receiving or delivering characters as
@@ -5605,7 +5064,6 @@ For example:
@end deffn
make-weak-vector
-@c snarfed from weaks.c:116
@deffn {Scheme Procedure} make-weak-vector size [fill]
@deffnx {C Function} scm_make_weak_vector (size, fill)
Return a weak vector with @var{size} elements. If the optional
@@ -5615,13 +5073,11 @@ empty list.
@end deffn
list->weak-vector
-@c snarfed from weaks.c:124
@deffn {Scheme Procedure} list->weak-vector
implemented by the C function "scm_weak_vector"
@end deffn
weak-vector
-@c snarfed from weaks.c:132
@deffn {Scheme Procedure} weak-vector . l
@deffnx {Scheme Procedure} list->weak-vector l
@deffnx {C Function} scm_weak_vector (l)
@@ -5632,7 +5088,6 @@ the same way @code{list->vector} would.
@end deffn
weak-vector?
-@c snarfed from weaks.c:160
@deffn {Scheme Procedure} weak-vector? obj
@deffnx {C Function} scm_weak_vector_p (obj)
Return @code{#t} if @var{obj} is a weak vector. Note that all
@@ -5640,7 +5095,6 @@ weak hashes are also weak vectors.
@end deffn
make-weak-key-hash-table
-@c snarfed from weaks.c:178
@deffn {Scheme Procedure} make-weak-key-hash-table size
@deffnx {Scheme Procedure} make-weak-value-hash-table size
@deffnx {Scheme Procedure} make-doubly-weak-hash-table size
@@ -5654,7 +5108,6 @@ would modify regular hash tables. (@pxref{Hash Tables})
@end deffn
make-weak-value-hash-table
-@c snarfed from weaks.c:189
@deffn {Scheme Procedure} make-weak-value-hash-table size
@deffnx {C Function} scm_make_weak_value_hash_table (size)
Return a hash table with weak values with @var{size} buckets.
@@ -5662,7 +5115,6 @@ Return a hash table with weak values with @var{size} buckets.
@end deffn
make-doubly-weak-hash-table
-@c snarfed from weaks.c:200
@deffn {Scheme Procedure} make-doubly-weak-hash-table size
@deffnx {C Function} scm_make_doubly_weak_hash_table (size)
Return a hash table with weak keys and values with @var{size}
@@ -5670,7 +5122,6 @@ buckets. (@pxref{Hash Tables})
@end deffn
weak-key-hash-table?
-@c snarfed from weaks.c:214
@deffn {Scheme Procedure} weak-key-hash-table? obj
@deffnx {Scheme Procedure} weak-value-hash-table? obj
@deffnx {Scheme Procedure} doubly-weak-hash-table? obj
@@ -5681,21 +5132,18 @@ nor a weak value hash table.
@end deffn
weak-value-hash-table?
-@c snarfed from weaks.c:224
@deffn {Scheme Procedure} weak-value-hash-table? obj
@deffnx {C Function} scm_weak_value_hash_table_p (obj)
Return @code{#t} if @var{obj} is a weak value hash table.
@end deffn
doubly-weak-hash-table?
-@c snarfed from weaks.c:234
@deffn {Scheme Procedure} doubly-weak-hash-table? obj
@deffnx {C Function} scm_doubly_weak_hash_table_p (obj)
Return @code{#t} if @var{obj} is a doubly weak hash table.
@end deffn
regexp?
-@c snarfed from regex-posix.c:137
@deffn {Scheme Procedure} regexp? obj
@deffnx {C Function} scm_regexp_p (obj)
Return @code{#t} if @var{obj} is a compiled regular expression,
@@ -5703,7 +5151,6 @@ or @code{#f} otherwise.
@end deffn
make-regexp
-@c snarfed from regex-posix.c:182
@deffn {Scheme Procedure} make-regexp pat . flags
@deffnx {C Function} scm_make_regexp (pat, flags)
Compile the regular expression described by @var{pat}, and
@@ -5746,7 +5193,6 @@ one which comes last will override the earlier one.
@end deffn
regexp-exec
-@c snarfed from regex-posix.c:243
@deffn {Scheme Procedure} regexp-exec rx str [start [flags]]
@deffnx {C Function} scm_regexp_exec (rx, str, start, flags)
Match the compiled regular expression @var{rx} against
@@ -5771,7 +5217,6 @@ considered the end of a line.
@end deffn
array-fill!
-@c snarfed from ramap.c:462
@deffn {Scheme Procedure} array-fill! ra fill
@deffnx {C Function} scm_array_fill_x (ra, fill)
Store @var{fill} in every element of @var{array}. The value returned
@@ -5779,13 +5224,11 @@ is unspecified.
@end deffn
array-copy-in-order!
-@c snarfed from ramap.c:827
@deffn {Scheme Procedure} array-copy-in-order!
implemented by the C function "scm_array_copy_x"
@end deffn
array-copy!
-@c snarfed from ramap.c:836
@deffn {Scheme Procedure} array-copy! src dst
@deffnx {Scheme Procedure} array-copy-in-order! src dst
@deffnx {C Function} scm_array_copy_x (src, dst)
@@ -5796,13 +5239,11 @@ dimension. The order is unspecified.
@end deffn
array-map-in-order!
-@c snarfed from ramap.c:1510
@deffn {Scheme Procedure} array-map-in-order!
implemented by the C function "scm_array_map_x"
@end deffn
array-map!
-@c snarfed from ramap.c:1521
@deffn {Scheme Procedure} array-map! ra0 proc . lra
@deffnx {Scheme Procedure} array-map-in-order! ra0 proc . lra
@deffnx {C Function} scm_array_map_x (ra0, proc, lra)
@@ -5815,7 +5256,6 @@ unspecified. The order of application is unspecified.
@end deffn
array-for-each
-@c snarfed from ramap.c:1668
@deffn {Scheme Procedure} array-for-each proc ra0 . lra
@deffnx {C Function} scm_array_for_each (proc, ra0, lra)
Apply @var{proc} to each tuple of elements of @var{array0} @dots{}
@@ -5823,7 +5263,6 @@ in row-major order. The value returned is unspecified.
@end deffn
array-index-map!
-@c snarfed from ramap.c:1696
@deffn {Scheme Procedure} array-index-map! ra proc
@deffnx {C Function} scm_array_index_map_x (ra, proc)
Apply @var{proc} to the indices of each element of @var{array} in
@@ -5847,14 +5286,12 @@ Another example:
@end deffn
uniform-vector-length
-@c snarfed from unif.c:250
@deffn {Scheme Procedure} uniform-vector-length v
@deffnx {C Function} scm_uniform_vector_length (v)
Return the number of elements in @var{uve}.
@end deffn
array?
-@c snarfed from unif.c:284
@deffn {Scheme Procedure} array? v [prot]
@deffnx {C Function} scm_array_p (v, prot)
Return @code{#t} if the @var{obj} is an array, and @code{#f} if
@@ -5863,7 +5300,6 @@ and is described elsewhere.
@end deffn
array-rank
-@c snarfed from unif.c:355
@deffn {Scheme Procedure} array-rank ra
@deffnx {C Function} scm_array_rank (ra)
Return the number of dimensions of @var{obj}. If @var{obj} is
@@ -5871,7 +5307,6 @@ not an array, @code{0} is returned.
@end deffn
array-dimensions
-@c snarfed from unif.c:393
@deffn {Scheme Procedure} array-dimensions ra
@deffnx {C Function} scm_array_dimensions (ra)
@code{Array-dimensions} is similar to @code{array-shape} but replaces
@@ -5882,28 +5317,24 @@ elements with a @code{0} minimum with one greater than the maximum. So:
@end deffn
shared-array-root
-@c snarfed from unif.c:440
@deffn {Scheme Procedure} shared-array-root ra
@deffnx {C Function} scm_shared_array_root (ra)
Return the root vector of a shared array.
@end deffn
shared-array-offset
-@c snarfed from unif.c:451
@deffn {Scheme Procedure} shared-array-offset ra
@deffnx {C Function} scm_shared_array_offset (ra)
Return the root vector index of the first element in the array.
@end deffn
shared-array-increments
-@c snarfed from unif.c:462
@deffn {Scheme Procedure} shared-array-increments ra
@deffnx {C Function} scm_shared_array_increments (ra)
For each dimension, return the distance between elements in the root vector.
@end deffn
dimensions->uniform-array
-@c snarfed from unif.c:581
@deffn {Scheme Procedure} dimensions->uniform-array dims prot [fill]
@deffnx {Scheme Procedure} make-uniform-vector length prototype [fill]
@deffnx {C Function} scm_dimensions_to_uniform_array (dims, prot, fill)
@@ -5914,7 +5345,6 @@ fill the array, otherwise @var{prototype} is used.
@end deffn
make-shared-array
-@c snarfed from unif.c:670
@deffn {Scheme Procedure} make-shared-array oldra mapfunc . dims
@deffnx {C Function} scm_make_shared_array (oldra, mapfunc, dims)
@code{make-shared-array} can be used to create shared subarrays of other
@@ -5935,7 +5365,6 @@ it can be otherwise arbitrary. A simple example:
@end deffn
transpose-array
-@c snarfed from unif.c:802
@deffn {Scheme Procedure} transpose-array ra . args
@deffnx {C Function} scm_transpose_array (ra, args)
Return an array sharing contents with @var{array}, but with
@@ -5960,7 +5389,6 @@ have smaller rank than @var{array}.
@end deffn
enclose-array
-@c snarfed from unif.c:911
@deffn {Scheme Procedure} enclose-array ra . axes
@deffnx {C Function} scm_enclose_array (ra, axes)
@var{dim0}, @var{dim1} @dots{} should be nonnegative integers less than
@@ -5987,7 +5415,6 @@ examples:
@end deffn
array-in-bounds?
-@c snarfed from unif.c:995
@deffn {Scheme Procedure} array-in-bounds? v . args
@deffnx {C Function} scm_array_in_bounds_p (v, args)
Return @code{#t} if its arguments would be acceptable to
@@ -5995,13 +5422,11 @@ Return @code{#t} if its arguments would be acceptable to
@end deffn
array-ref
-@c snarfed from unif.c:1074
@deffn {Scheme Procedure} array-ref
implemented by the C function "scm_uniform_vector_ref"
@end deffn
uniform-vector-ref
-@c snarfed from unif.c:1081
@deffn {Scheme Procedure} uniform-vector-ref v args
@deffnx {Scheme Procedure} array-ref v . args
@deffnx {C Function} scm_uniform_vector_ref (v, args)
@@ -6010,13 +5435,11 @@ Return the element at the @code{(index1, index2)} element in
@end deffn
uniform-array-set1!
-@c snarfed from unif.c:1250
@deffn {Scheme Procedure} uniform-array-set1!
implemented by the C function "scm_array_set_x"
@end deffn
array-set!
-@c snarfed from unif.c:1259
@deffn {Scheme Procedure} array-set! v obj . args
@deffnx {Scheme Procedure} uniform-array-set1! v obj args
@deffnx {C Function} scm_array_set_x (v, obj, args)
@@ -6025,7 +5448,6 @@ Set the element at the @code{(index1, index2)} element in @var{array} to
@end deffn
array-contents
-@c snarfed from unif.c:1374
@deffn {Scheme Procedure} array-contents ra [strict]
@deffnx {C Function} scm_array_contents (ra, strict)
If @var{array} may be @dfn{unrolled} into a one dimensional shared array
@@ -6041,7 +5463,6 @@ memory.
@end deffn
uniform-array-read!
-@c snarfed from unif.c:1488
@deffn {Scheme Procedure} uniform-array-read! ra [port_or_fd [start [end]]]
@deffnx {Scheme Procedure} uniform-vector-read! uve [port-or-fdes] [start] [end]
@deffnx {C Function} scm_uniform_array_read_x (ra, port_or_fd, start, end)
@@ -6062,7 +5483,6 @@ returned by @code{(current-input-port)}.
@end deffn
uniform-array-write
-@c snarfed from unif.c:1653
@deffn {Scheme Procedure} uniform-array-write v [port_or_fd [start [end]]]
@deffnx {Scheme Procedure} uniform-vector-write uve [port-or-fdes] [start] [end]
@deffnx {C Function} scm_uniform_array_write (v, port_or_fd, start, end)
@@ -6080,7 +5500,6 @@ omitted, in which case it defaults to the value returned by
@end deffn
bit-count
-@c snarfed from unif.c:1780
@deffn {Scheme Procedure} bit-count b bitvector
@deffnx {C Function} scm_bit_count (b, bitvector)
Return the number of occurrences of the boolean @var{b} in
@@ -6088,7 +5507,6 @@ Return the number of occurrences of the boolean @var{b} in
@end deffn
bit-position
-@c snarfed from unif.c:1819
@deffn {Scheme Procedure} bit-position item v k
@deffnx {C Function} scm_bit_position (item, v, k)
Return the minimum index of an occurrence of @var{bool} in
@@ -6097,7 +5515,6 @@ within the specified range @code{#f} is returned.
@end deffn
bit-set*!
-@c snarfed from unif.c:1887
@deffn {Scheme Procedure} bit-set*! v kv obj
@deffnx {C Function} scm_bit_set_star_x (v, kv, obj)
If uve is a bit-vector @var{bv} and uve must be of the same
@@ -6112,7 +5529,6 @@ of @var{bv} corresponding to the indexes in uve are set to
@end deffn
bit-count*
-@c snarfed from unif.c:1941
@deffn {Scheme Procedure} bit-count* v kv obj
@deffnx {C Function} scm_bit_count_star (v, kv, obj)
Return
@@ -6123,14 +5539,12 @@ Return
@end deffn
bit-invert!
-@c snarfed from unif.c:2005
@deffn {Scheme Procedure} bit-invert! v
@deffnx {C Function} scm_bit_invert_x (v)
Modify @var{bv} by replacing each element with its negation.
@end deffn
array->list
-@c snarfed from unif.c:2084
@deffn {Scheme Procedure} array->list v
@deffnx {C Function} scm_array_to_list (v)
Return a list consisting of all the elements, in order, of
@@ -6138,7 +5552,6 @@ Return a list consisting of all the elements, in order, of
@end deffn
list->uniform-array
-@c snarfed from unif.c:2185
@deffn {Scheme Procedure} list->uniform-array ndim prot lst
@deffnx {Scheme Procedure} list->uniform-vector prot lst
@deffnx {C Function} scm_list_to_uniform_array (ndim, prot, lst)
@@ -6149,7 +5562,6 @@ done.
@end deffn
array-prototype
-@c snarfed from unif.c:2536
@deffn {Scheme Procedure} array-prototype ra
@deffnx {C Function} scm_array_prototype (ra)
Return an object that would produce an array of the same type
@@ -6158,7 +5570,6 @@ as @var{array}, if used as the @var{prototype} for
@end deffn
chown
-@c snarfed from filesys.c:214
@deffn {Scheme Procedure} chown object owner group
@deffnx {C Function} scm_chown (object, owner, group)
Change the ownership and group of the file referred to by @var{object} to
@@ -6176,7 +5587,6 @@ as @code{-1}, then that ID is not changed.
@end deffn
chmod
-@c snarfed from filesys.c:254
@deffn {Scheme Procedure} chmod object mode
@deffnx {C Function} scm_chmod (object, mode)
Changes the permissions of the file referred to by @var{obj}.
@@ -6189,10 +5599,9 @@ The return value is unspecified.
@end deffn
umask
-@c snarfed from filesys.c:287
@deffn {Scheme Procedure} umask [mode]
@deffnx {C Function} scm_umask (mode)
-If @var{mode} is omitted, retuns a decimal number representing the current
+If @var{mode} is omitted, returns a decimal number representing the current
file creation mask. Otherwise the file creation mask is set to
@var{mode} and the previous value is returned.
@@ -6200,7 +5609,6 @@ E.g., @code{(umask #o022)} sets the mask to octal 22, decimal 18.
@end deffn
open-fdes
-@c snarfed from filesys.c:310
@deffn {Scheme Procedure} open-fdes path flags [mode]
@deffnx {C Function} scm_open_fdes (path, flags, mode)
Similar to @code{open} but return a file descriptor instead of
@@ -6208,7 +5616,6 @@ a port.
@end deffn
open
-@c snarfed from filesys.c:352
@deffn {Scheme Procedure} open path flags [mode]
@deffnx {C Function} scm_open (path, flags, mode)
Open the file named by @var{path} for reading and/or writing.
@@ -6241,7 +5648,6 @@ for additional flags.
@end deffn
close
-@c snarfed from filesys.c:390
@deffn {Scheme Procedure} close fd_or_port
@deffnx {C Function} scm_close (fd_or_port)
Similar to close-port (@pxref{Closing, close-port}),
@@ -6252,7 +5658,6 @@ their revealed counts set to zero.
@end deffn
close-fdes
-@c snarfed from filesys.c:418
@deffn {Scheme Procedure} close-fdes fd
@deffnx {C Function} scm_close_fdes (fd)
A simple wrapper for the @code{close} system call.
@@ -6263,7 +5668,6 @@ The return value is unspecified.
@end deffn
stat
-@c snarfed from filesys.c:621
@deffn {Scheme Procedure} stat object
@deffnx {C Function} scm_stat (object)
Return an object containing various information about the file
@@ -6325,7 +5729,6 @@ An integer representing the access permission bits.
@end deffn
link
-@c snarfed from filesys.c:684
@deffn {Scheme Procedure} link oldpath newpath
@deffnx {C Function} scm_link (oldpath, newpath)
Creates a new name @var{newpath} in the file system for the
@@ -6335,7 +5738,6 @@ system.
@end deffn
rename-file
-@c snarfed from filesys.c:705
@deffn {Scheme Procedure} rename-file oldname newname
@deffnx {C Function} scm_rename (oldname, newname)
Renames the file specified by @var{oldname} to @var{newname}.
@@ -6343,14 +5745,12 @@ The return value is unspecified.
@end deffn
delete-file
-@c snarfed from filesys.c:732
@deffn {Scheme Procedure} delete-file str
@deffnx {C Function} scm_delete_file (str)
Deletes (or "unlinks") the file specified by @var{path}.
@end deffn
mkdir
-@c snarfed from filesys.c:750
@deffn {Scheme Procedure} mkdir path [mode]
@deffnx {C Function} scm_mkdir (path, mode)
Create a new directory named by @var{path}. If @var{mode} is omitted
@@ -6360,7 +5760,6 @@ umask. Otherwise they are set to the decimal value specified with
@end deffn
rmdir
-@c snarfed from filesys.c:778
@deffn {Scheme Procedure} rmdir path
@deffnx {C Function} scm_rmdir (path)
Remove the existing directory named by @var{path}. The directory must
@@ -6368,7 +5767,6 @@ be empty for this to succeed. The return value is unspecified.
@end deffn
directory-stream?
-@c snarfed from filesys.c:803
@deffn {Scheme Procedure} directory-stream? obj
@deffnx {C Function} scm_directory_stream_p (obj)
Return a boolean indicating whether @var{object} is a directory
@@ -6376,7 +5774,6 @@ stream as returned by @code{opendir}.
@end deffn
opendir
-@c snarfed from filesys.c:814
@deffn {Scheme Procedure} opendir dirname
@deffnx {C Function} scm_opendir (dirname)
Open the directory specified by @var{path} and return a directory
@@ -6384,7 +5781,6 @@ stream.
@end deffn
readdir
-@c snarfed from filesys.c:831
@deffn {Scheme Procedure} readdir port
@deffnx {C Function} scm_readdir (port)
Return (as a string) the next directory entry from the directory stream
@@ -6393,7 +5789,6 @@ end of file object is returned.
@end deffn
rewinddir
-@c snarfed from filesys.c:854
@deffn {Scheme Procedure} rewinddir port
@deffnx {C Function} scm_rewinddir (port)
Reset the directory port @var{stream} so that the next call to
@@ -6401,7 +5796,6 @@ Reset the directory port @var{stream} so that the next call to
@end deffn
closedir
-@c snarfed from filesys.c:871
@deffn {Scheme Procedure} closedir port
@deffnx {C Function} scm_closedir (port)
Close the directory stream @var{stream}.
@@ -6409,7 +5803,6 @@ The return value is unspecified.
@end deffn
chdir
-@c snarfed from filesys.c:921
@deffn {Scheme Procedure} chdir str
@deffnx {C Function} scm_chdir (str)
Change the current working directory to @var{path}.
@@ -6417,18 +5810,16 @@ The return value is unspecified.
@end deffn
getcwd
-@c snarfed from filesys.c:937
@deffn {Scheme Procedure} getcwd
@deffnx {C Function} scm_getcwd ()
Return the name of the current working directory.
@end deffn
select
-@c snarfed from filesys.c:1133
@deffn {Scheme Procedure} select reads writes excepts [secs [usecs]]
@deffnx {C Function} scm_select (reads, writes, excepts, secs, usecs)
This procedure has a variety of uses: waiting for the ability
-to provide input, accept output, or the existance of
+to provide input, accept output, or the existence of
exceptional conditions on a collection of ports or file
descriptors, or waiting for a timeout to occur.
It also returns if interrupted by a signal.
@@ -6459,7 +5850,6 @@ An additional @code{select!} interface is provided.
@end deffn
fcntl
-@c snarfed from filesys.c:1279
@deffn {Scheme Procedure} fcntl object cmd [value]
@deffnx {C Function} scm_fcntl (object, cmd, value)
Apply @var{command} to the specified file descriptor or the underlying
@@ -6490,7 +5880,6 @@ The value used to indicate the "close on exec" flag with @code{F_GETFL} or
@end deffn
fsync
-@c snarfed from filesys.c:1316
@deffn {Scheme Procedure} fsync object
@deffnx {C Function} scm_fsync (object)
Copies any unwritten data for the specified output file descriptor to disk.
@@ -6500,7 +5889,6 @@ The return value is unspecified.
@end deffn
symlink
-@c snarfed from filesys.c:1343
@deffn {Scheme Procedure} symlink oldpath newpath
@deffnx {C Function} scm_symlink (oldpath, newpath)
Create a symbolic link named @var{path-to} with the value (i.e., pointing to)
@@ -6508,7 +5896,6 @@ Create a symbolic link named @var{path-to} with the value (i.e., pointing to)
@end deffn
readlink
-@c snarfed from filesys.c:1362
@deffn {Scheme Procedure} readlink path
@deffnx {C Function} scm_readlink (path)
Return the value of the symbolic link named by @var{path} (a
@@ -6516,7 +5903,6 @@ string), i.e., the file that the link points to.
@end deffn
lstat
-@c snarfed from filesys.c:1391
@deffn {Scheme Procedure} lstat str
@deffnx {C Function} scm_lstat (str)
Similar to @code{stat}, but does not follow symbolic links, i.e.,
@@ -6525,7 +5911,6 @@ file it points to. @var{path} must be a string.
@end deffn
copy-file
-@c snarfed from filesys.c:1415
@deffn {Scheme Procedure} copy-file oldfile newfile
@deffnx {C Function} scm_copy_file (oldfile, newfile)
Copy the file specified by @var{path-from} to @var{path-to}.
@@ -6533,7 +5918,6 @@ The return value is unspecified.
@end deffn
dirname
-@c snarfed from filesys.c:1460
@deffn {Scheme Procedure} dirname filename
@deffnx {C Function} scm_dirname (filename)
Return the directory name component of the file name
@@ -6542,17 +5926,15 @@ component, @code{.} is returned.
@end deffn
basename
-@c snarfed from filesys.c:1503
@deffn {Scheme Procedure} basename filename [suffix]
@deffnx {C Function} scm_basename (filename, suffix)
Return the base name of the file name @var{filename}. The
base name is the file name without any directory components.
-If @var{suffix} is privided, and is equal to the end of
+If @var{suffix} is provided, and is equal to the end of
@var{basename}, it is removed also.
@end deffn
pipe
-@c snarfed from posix.c:201
@deffn {Scheme Procedure} pipe
@deffnx {C Function} scm_pipe ()
Return a newly created pipe: a pair of ports which are linked
@@ -6571,15 +5953,13 @@ from the input port.
@end deffn
getgroups
-@c snarfed from posix.c:222
@deffn {Scheme Procedure} getgroups
@deffnx {C Function} scm_getgroups ()
Return a vector of integers representing the current
-supplimentary group IDs.
+supplementary group IDs.
@end deffn
getpw
-@c snarfed from posix.c:253
@deffn {Scheme Procedure} getpw [user]
@deffnx {C Function} scm_getpwuid (user)
Look up an entry in the user database. @var{obj} can be an integer,
@@ -6588,7 +5968,6 @@ or getpwent respectively.
@end deffn
setpw
-@c snarfed from posix.c:306
@deffn {Scheme Procedure} setpw [arg]
@deffnx {C Function} scm_setpwent (arg)
If called with a true argument, initialize or reset the password data
@@ -6597,7 +5976,6 @@ stream. Otherwise, close the stream. The @code{setpwent} and
@end deffn
getgr
-@c snarfed from posix.c:325
@deffn {Scheme Procedure} getgr [name]
@deffnx {C Function} scm_getgrgid (name)
Look up an entry in the group database. @var{obj} can be an integer,
@@ -6606,7 +5984,6 @@ or getgrent respectively.
@end deffn
setgr
-@c snarfed from posix.c:365
@deffn {Scheme Procedure} setgr [arg]
@deffnx {C Function} scm_setgrent (arg)
If called with a true argument, initialize or reset the group data
@@ -6615,7 +5992,6 @@ stream. Otherwise, close the stream. The @code{setgrent} and
@end deffn
kill
-@c snarfed from posix.c:401
@deffn {Scheme Procedure} kill pid sig
@deffnx {C Function} scm_kill (pid, sig)
Sends a signal to the specified process or group of processes.
@@ -6648,7 +6024,6 @@ Interrupt signal.
@end deffn
waitpid
-@c snarfed from posix.c:454
@deffn {Scheme Procedure} waitpid pid [options]
@deffnx {C Function} scm_waitpid (pid, options)
This procedure collects status information from a child process which
@@ -6695,7 +6070,6 @@ The integer status value.
@end deffn
status:exit-val
-@c snarfed from posix.c:482
@deffn {Scheme Procedure} status:exit-val status
@deffnx {C Function} scm_status_exit_val (status)
Return the exit status value, as would be set if a process
@@ -6704,7 +6078,6 @@ if any, otherwise @code{#f}.
@end deffn
status:term-sig
-@c snarfed from posix.c:502
@deffn {Scheme Procedure} status:term-sig status
@deffnx {C Function} scm_status_term_sig (status)
Return the signal number which terminated the process, if any,
@@ -6712,7 +6085,6 @@ otherwise @code{#f}.
@end deffn
status:stop-sig
-@c snarfed from posix.c:520
@deffn {Scheme Procedure} status:stop-sig status
@deffnx {C Function} scm_status_stop_sig (status)
Return the signal number which stopped the process, if any,
@@ -6720,7 +6092,6 @@ otherwise @code{#f}.
@end deffn
getppid
-@c snarfed from posix.c:540
@deffn {Scheme Procedure} getppid
@deffnx {C Function} scm_getppid ()
Return an integer representing the process ID of the parent
@@ -6728,21 +6099,18 @@ process.
@end deffn
getuid
-@c snarfed from posix.c:552
@deffn {Scheme Procedure} getuid
@deffnx {C Function} scm_getuid ()
Return an integer representing the current real user ID.
@end deffn
getgid
-@c snarfed from posix.c:563
@deffn {Scheme Procedure} getgid
@deffnx {C Function} scm_getgid ()
Return an integer representing the current real group ID.
@end deffn
geteuid
-@c snarfed from posix.c:577
@deffn {Scheme Procedure} geteuid
@deffnx {C Function} scm_geteuid ()
Return an integer representing the current effective user ID.
@@ -6752,7 +6120,6 @@ system supports effective IDs.
@end deffn
getegid
-@c snarfed from posix.c:594
@deffn {Scheme Procedure} getegid
@deffnx {C Function} scm_getegid ()
Return an integer representing the current effective group ID.
@@ -6762,7 +6129,6 @@ system supports effective IDs.
@end deffn
setuid
-@c snarfed from posix.c:610
@deffn {Scheme Procedure} setuid id
@deffnx {C Function} scm_setuid (id)
Sets both the real and effective user IDs to the integer @var{id}, provided
@@ -6771,7 +6137,6 @@ The return value is unspecified.
@end deffn
setgid
-@c snarfed from posix.c:624
@deffn {Scheme Procedure} setgid id
@deffnx {C Function} scm_setgid (id)
Sets both the real and effective group IDs to the integer @var{id}, provided
@@ -6780,7 +6145,6 @@ The return value is unspecified.
@end deffn
seteuid
-@c snarfed from posix.c:640
@deffn {Scheme Procedure} seteuid id
@deffnx {C Function} scm_seteuid (id)
Sets the effective user ID to the integer @var{id}, provided the process
@@ -6791,7 +6155,6 @@ The return value is unspecified.
@end deffn
setegid
-@c snarfed from posix.c:666
@deffn {Scheme Procedure} setegid id
@deffnx {C Function} scm_setegid (id)
Sets the effective group ID to the integer @var{id}, provided the process
@@ -6802,7 +6165,6 @@ The return value is unspecified.
@end deffn
getpgrp
-@c snarfed from posix.c:690
@deffn {Scheme Procedure} getpgrp
@deffnx {C Function} scm_getpgrp ()
Return an integer representing the current process group ID.
@@ -6810,7 +6172,6 @@ This is the POSIX definition, not BSD.
@end deffn
setpgid
-@c snarfed from posix.c:708
@deffn {Scheme Procedure} setpgid pid pgid
@deffnx {C Function} scm_setpgid (pid, pgid)
Move the process @var{pid} into the process group @var{pgid}. @var{pid} or
@@ -6821,7 +6182,6 @@ The return value is unspecified.
@end deffn
setsid
-@c snarfed from posix.c:727
@deffn {Scheme Procedure} setsid
@deffnx {C Function} scm_setsid ()
Creates a new session. The current process becomes the session leader
@@ -6831,7 +6191,6 @@ The return value is an integer representing the new process group ID.
@end deffn
ttyname
-@c snarfed from posix.c:742
@deffn {Scheme Procedure} ttyname port
@deffnx {C Function} scm_ttyname (port)
Return a string with the name of the serial terminal device
@@ -6839,7 +6198,6 @@ underlying @var{port}.
@end deffn
ctermid
-@c snarfed from posix.c:766
@deffn {Scheme Procedure} ctermid
@deffnx {C Function} scm_ctermid ()
Return a string containing the file name of the controlling
@@ -6847,7 +6205,6 @@ terminal for the current process.
@end deffn
tcgetpgrp
-@c snarfed from posix.c:789
@deffn {Scheme Procedure} tcgetpgrp port
@deffnx {C Function} scm_tcgetpgrp (port)
Return the process group ID of the foreground process group
@@ -6863,7 +6220,6 @@ foreground.
@end deffn
tcsetpgrp
-@c snarfed from posix.c:813
@deffn {Scheme Procedure} tcsetpgrp port pgid
@deffnx {C Function} scm_tcsetpgrp (port, pgid)
Set the foreground process group ID for the terminal used by the file
@@ -6874,12 +6230,11 @@ controlling terminal. The return value is unspecified.
@end deffn
execl
-@c snarfed from posix.c:873
@deffn {Scheme Procedure} execl filename . args
@deffnx {C Function} scm_execl (filename, args)
Executes the file named by @var{path} as a new process image.
The remaining arguments are supplied to the process; from a C program
-they are accessable as the @code{argv} argument to @code{main}.
+they are accessible as the @code{argv} argument to @code{main}.
Conventionally the first @var{arg} is the same as @var{path}.
All arguments must be strings.
@@ -6891,7 +6246,6 @@ call, but we call it @code{execl} because of its Scheme calling interface.
@end deffn
execlp
-@c snarfed from posix.c:893
@deffn {Scheme Procedure} execlp filename . args
@deffnx {C Function} scm_execlp (filename, args)
Similar to @code{execl}, however if
@@ -6904,7 +6258,6 @@ call, but we call it @code{execlp} because of its Scheme calling interface.
@end deffn
execle
-@c snarfed from posix.c:943
@deffn {Scheme Procedure} execle filename env . args
@deffnx {C Function} scm_execle (filename, env, args)
Similar to @code{execl}, but the environment of the new process is
@@ -6916,7 +6269,6 @@ call, but we call it @code{execle} because of its Scheme calling interface.
@end deffn
primitive-fork
-@c snarfed from posix.c:967
@deffn {Scheme Procedure} primitive-fork
@deffnx {C Function} scm_fork ()
Creates a new "child" process by duplicating the current "parent" process.
@@ -6928,7 +6280,6 @@ with the scsh fork.
@end deffn
uname
-@c snarfed from posix.c:987
@deffn {Scheme Procedure} uname
@deffnx {C Function} scm_uname ()
Return an object with some information about the computer
@@ -6936,7 +6287,6 @@ system the program is running on.
@end deffn
environ
-@c snarfed from posix.c:1017
@deffn {Scheme Procedure} environ [env]
@deffnx {C Function} scm_environ (env)
If @var{env} is omitted, return the current environment (in the
@@ -6949,7 +6299,6 @@ then the return value is unspecified.
@end deffn
tmpnam
-@c snarfed from posix.c:1055
@deffn {Scheme Procedure} tmpnam
@deffnx {C Function} scm_tmpnam ()
Return a name in the file system that does not match any
@@ -6960,7 +6309,6 @@ Care should be taken if opening the file, e.g., use the
@end deffn
mkstemp!
-@c snarfed from posix.c:1081
@deffn {Scheme Procedure} mkstemp! tmpl
@deffnx {C Function} scm_mkstemp (tmpl)
Create a new unique file in the file system and returns a new
@@ -6971,7 +6319,6 @@ place to return the name of the temporary file.
@end deffn
utime
-@c snarfed from posix.c:1106
@deffn {Scheme Procedure} utime pathname [actime [modtime]]
@deffnx {C Function} scm_utime (pathname, actime, modtime)
@code{utime} sets the access and modification times for the
@@ -6987,7 +6334,6 @@ modification time to the current time.
@end deffn
access?
-@c snarfed from posix.c:1154
@deffn {Scheme Procedure} access? path how
@deffnx {C Function} scm_access (path, how)
Return @code{#t} if @var{path} corresponds to an existing file
@@ -7016,14 +6362,12 @@ test for existence of the file.
@end deffn
getpid
-@c snarfed from posix.c:1168
@deffn {Scheme Procedure} getpid
@deffnx {C Function} scm_getpid ()
Return an integer representing the current process ID.
@end deffn
putenv
-@c snarfed from posix.c:1185
@deffn {Scheme Procedure} putenv str
@deffnx {C Function} scm_putenv (str)
Modifies the environment of the current process, which is
@@ -7040,7 +6384,6 @@ The return value is unspecified.
@end deffn
setlocale
-@c snarfed from posix.c:1216
@deffn {Scheme Procedure} setlocale category [locale]
@deffnx {C Function} scm_setlocale (category, locale)
If @var{locale} is omitted, return the current value of the
@@ -7051,11 +6394,10 @@ specified locale category as a system-dependent string.
Otherwise the specified locale category is set to the string
@var{locale} and the new value is returned as a
system-dependent string. If @var{locale} is an empty string,
-the locale will be set using envirionment variables.
+the locale will be set using environment variables.
@end deffn
mknod
-@c snarfed from posix.c:1256
@deffn {Scheme Procedure} mknod path type perms dev
@deffnx {C Function} scm_mknod (path, type, perms, dev)
Creates a new special file, such as a file corresponding to a device.
@@ -7076,7 +6418,6 @@ The return value is unspecified.
@end deffn
nice
-@c snarfed from posix.c:1302
@deffn {Scheme Procedure} nice incr
@deffnx {C Function} scm_nice (incr)
Increment the priority of the current process by @var{incr}. A higher
@@ -7085,7 +6426,6 @@ The return value is unspecified.
@end deffn
sync
-@c snarfed from posix.c:1317
@deffn {Scheme Procedure} sync
@deffnx {C Function} scm_sync ()
Flush the operating system disk buffers.
@@ -7093,7 +6433,6 @@ The return value is unspecified.
@end deffn
crypt
-@c snarfed from posix.c:1330
@deffn {Scheme Procedure} crypt key salt
@deffnx {C Function} scm_crypt (key, salt)
Encrypt @var{key} using @var{salt} as the salt value to the
@@ -7101,7 +6440,6 @@ crypt(3) library call.
@end deffn
chroot
-@c snarfed from posix.c:1351
@deffn {Scheme Procedure} chroot path
@deffnx {C Function} scm_chroot (path)
Change the root directory to that specified in @var{path}.
@@ -7112,7 +6450,6 @@ root directory.
@end deffn
getlogin
-@c snarfed from posix.c:1383
@deffn {Scheme Procedure} getlogin
@deffnx {C Function} scm_getlogin ()
Return a string containing the name of the user logged in on
@@ -7121,7 +6458,6 @@ information cannot be obtained.
@end deffn
cuserid
-@c snarfed from posix.c:1401
@deffn {Scheme Procedure} cuserid
@deffnx {C Function} scm_cuserid ()
Return a string containing a user name associated with the
@@ -7130,7 +6466,6 @@ information cannot be obtained.
@end deffn
getpriority
-@c snarfed from posix.c:1426
@deffn {Scheme Procedure} getpriority which who
@deffnx {C Function} scm_getpriority (which, who)
Return the scheduling priority of the process, process group
@@ -7146,7 +6481,6 @@ specified processes.
@end deffn
setpriority
-@c snarfed from posix.c:1460
@deffn {Scheme Procedure} setpriority which who prio
@deffnx {C Function} scm_setpriority (which, who, prio)
Set the scheduling priority of the process, process group
@@ -7165,7 +6499,6 @@ The return value is not specified.
@end deffn
getpass
-@c snarfed from posix.c:1485
@deffn {Scheme Procedure} getpass prompt
@deffnx {C Function} scm_getpass (prompt)
Display @var{prompt} to the standard error output and read
@@ -7178,7 +6511,6 @@ characters is disabled.
@end deffn
flock
-@c snarfed from posix.c:1589
@deffn {Scheme Procedure} flock file operation
@deffnx {C Function} scm_flock (file, operation)
Apply or remove an advisory lock on an open file.
@@ -7197,11 +6529,10 @@ Don't block when locking. May be specified by bitwise OR'ing
it to one of the other operations.
@end table
The return value is not specified. @var{file} may be an open
-file descriptor or an open file descriptior port.
+file descriptor or an open file descriptor port.
@end deffn
sethostname
-@c snarfed from posix.c:1615
@deffn {Scheme Procedure} sethostname name
@deffnx {C Function} scm_sethostname (name)
Set the host name of the current processor to @var{name}. May
@@ -7210,14 +6541,12 @@ specified.
@end deffn
gethostname
-@c snarfed from posix.c:1630
@deffn {Scheme Procedure} gethostname
@deffnx {C Function} scm_gethostname ()
Return the host name of the current processor.
@end deffn
gethost
-@c snarfed from net_db.c:153
@deffn {Scheme Procedure} gethost [host]
@deffnx {Scheme Procedure} gethostbyname hostname
@deffnx {Scheme Procedure} gethostbyaddr address
@@ -7234,7 +6563,6 @@ Unusual conditions may result in errors thrown to the
@end deffn
getnet
-@c snarfed from net_db.c:232
@deffn {Scheme Procedure} getnet [net]
@deffnx {Scheme Procedure} getnetbyname net-name
@deffnx {Scheme Procedure} getnetbyaddr net-number
@@ -7247,7 +6575,6 @@ given.
@end deffn
getproto
-@c snarfed from net_db.c:281
@deffn {Scheme Procedure} getproto [protocol]
@deffnx {Scheme Procedure} getprotobyname name
@deffnx {Scheme Procedure} getprotobynumber number
@@ -7259,7 +6586,6 @@ argument. @code{getproto} will accept either type, behaving like
@end deffn
getserv
-@c snarfed from net_db.c:347
@deffn {Scheme Procedure} getserv [name [protocol]]
@deffnx {Scheme Procedure} getservbyname name protocol
@deffnx {Scheme Procedure} getservbyport port protocol
@@ -7275,7 +6601,6 @@ as its first argument; if given no arguments, it behaves like
@end deffn
sethost
-@c snarfed from net_db.c:384
@deffn {Scheme Procedure} sethost [stayopen]
@deffnx {C Function} scm_sethost (stayopen)
If @var{stayopen} is omitted, this is equivalent to @code{endhostent}.
@@ -7283,7 +6608,6 @@ Otherwise it is equivalent to @code{sethostent stayopen}.
@end deffn
setnet
-@c snarfed from net_db.c:400
@deffn {Scheme Procedure} setnet [stayopen]
@deffnx {C Function} scm_setnet (stayopen)
If @var{stayopen} is omitted, this is equivalent to @code{endnetent}.
@@ -7291,7 +6615,6 @@ Otherwise it is equivalent to @code{setnetent stayopen}.
@end deffn
setproto
-@c snarfed from net_db.c:416
@deffn {Scheme Procedure} setproto [stayopen]
@deffnx {C Function} scm_setproto (stayopen)
If @var{stayopen} is omitted, this is equivalent to @code{endprotoent}.
@@ -7299,7 +6622,6 @@ Otherwise it is equivalent to @code{setprotoent stayopen}.
@end deffn
setserv
-@c snarfed from net_db.c:432
@deffn {Scheme Procedure} setserv [stayopen]
@deffnx {C Function} scm_setserv (stayopen)
If @var{stayopen} is omitted, this is equivalent to @code{endservent}.
@@ -7307,7 +6629,6 @@ Otherwise it is equivalent to @code{setservent stayopen}.
@end deffn
htons
-@c snarfed from socket.c:108
@deffn {Scheme Procedure} htons value
@deffnx {C Function} scm_htons (value)
Convert a 16 bit quantity from host to network byte ordering.
@@ -7316,7 +6637,6 @@ and returned as a new integer.
@end deffn
ntohs
-@c snarfed from socket.c:125
@deffn {Scheme Procedure} ntohs value
@deffnx {C Function} scm_ntohs (value)
Convert a 16 bit quantity from network to host byte ordering.
@@ -7325,7 +6645,6 @@ and returned as a new integer.
@end deffn
htonl
-@c snarfed from socket.c:142
@deffn {Scheme Procedure} htonl value
@deffnx {C Function} scm_htonl (value)
Convert a 32 bit quantity from host to network byte ordering.
@@ -7334,7 +6653,6 @@ and returned as a new integer.
@end deffn
ntohl
-@c snarfed from socket.c:155
@deffn {Scheme Procedure} ntohl value
@deffnx {C Function} scm_ntohl (value)
Convert a 32 bit quantity from network to host byte ordering.
@@ -7343,7 +6661,6 @@ and returned as a new integer.
@end deffn
inet-aton
-@c snarfed from socket.c:175
@deffn {Scheme Procedure} inet-aton address
@deffnx {C Function} scm_inet_aton (address)
Convert an IPv4 Internet address from printable string
@@ -7355,7 +6672,6 @@ Convert an IPv4 Internet address from printable string
@end deffn
inet-ntoa
-@c snarfed from socket.c:194
@deffn {Scheme Procedure} inet-ntoa inetid
@deffnx {C Function} scm_inet_ntoa (inetid)
Convert an IPv4 Internet address to a printable
@@ -7367,7 +6683,6 @@ Convert an IPv4 Internet address to a printable
@end deffn
inet-netof
-@c snarfed from socket.c:214
@deffn {Scheme Procedure} inet-netof address
@deffnx {C Function} scm_inet_netof (address)
Return the network number part of the given IPv4
@@ -7379,7 +6694,6 @@ Internet address. E.g.,
@end deffn
inet-lnaof
-@c snarfed from socket.c:232
@deffn {Scheme Procedure} inet-lnaof address
@deffnx {C Function} scm_lnaof (address)
Return the local-address-with-network part of the given
@@ -7392,7 +6706,6 @@ E.g.,
@end deffn
inet-makeaddr
-@c snarfed from socket.c:250
@deffn {Scheme Procedure} inet-makeaddr net lna
@deffnx {C Function} scm_inet_makeaddr (net, lna)
Make an IPv4 Internet address by combining the network number
@@ -7405,7 +6718,6 @@ Make an IPv4 Internet address by combining the network number
@end deffn
inet-pton
-@c snarfed from socket.c:368
@deffn {Scheme Procedure} inet-pton family address
@deffnx {C Function} scm_inet_pton (family, address)
Convert a string containing a printable network address to
@@ -7421,7 +6733,6 @@ the result is an integer with normal host byte ordering.
@end deffn
inet-ntop
-@c snarfed from socket.c:403
@deffn {Scheme Procedure} inet-ntop family address
@deffnx {C Function} scm_inet_ntop (family, address)
Convert a network address into a printable string.
@@ -7437,7 +6748,6 @@ ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff
@end deffn
socket
-@c snarfed from socket.c:448
@deffn {Scheme Procedure} socket family style proto
@deffnx {C Function} scm_socket (family, style, proto)
Return a new socket port of the type specified by @var{family},
@@ -7456,7 +6766,6 @@ has been connected to another socket.
@end deffn
socketpair
-@c snarfed from socket.c:470
@deffn {Scheme Procedure} socketpair family style proto
@deffnx {C Function} scm_socketpair (family, style, proto)
Return a pair of connected (but unnamed) socket ports of the
@@ -7467,7 +6776,6 @@ family. Zero is likely to be the only meaningful value for
@end deffn
getsockopt
-@c snarfed from socket.c:499
@deffn {Scheme Procedure} getsockopt sock level optname
@deffnx {C Function} scm_getsockopt (sock, level, optname)
Return the value of a particular socket option for the socket
@@ -7482,7 +6790,6 @@ returns a pair of integers.
@end deffn
setsockopt
-@c snarfed from socket.c:567
@deffn {Scheme Procedure} setsockopt sock level optname value
@deffnx {C Function} scm_setsockopt (sock, level, optname, value)
Set the value of a particular socket option for the socket
@@ -7499,11 +6806,10 @@ The return value is unspecified.
@end deffn
shutdown
-@c snarfed from socket.c:671
@deffn {Scheme Procedure} shutdown sock how
@deffnx {C Function} scm_shutdown (sock, how)
Sockets can be closed simply by using @code{close-port}. The
-@code{shutdown} procedure allows reception or tranmission on a
+@code{shutdown} procedure allows reception or transmission on a
connection to be shut down individually, according to the parameter
@var{how}:
@@ -7522,7 +6828,6 @@ The return value is unspecified.
@end deffn
connect
-@c snarfed from socket.c:815
@deffn {Scheme Procedure} connect sock fam address . args
@deffnx {C Function} scm_connect (sock, fam, address, args)
Initiate a connection from a socket using a specified address
@@ -7549,7 +6854,6 @@ The return value is unspecified.
@end deffn
bind
-@c snarfed from socket.c:875
@deffn {Scheme Procedure} bind sock fam address . args
@deffnx {C Function} scm_bind (sock, fam, address, args)
Assign an address to the socket port @var{sock}.
@@ -7598,7 +6902,6 @@ The return value is unspecified.
@end deffn
listen
-@c snarfed from socket.c:909
@deffn {Scheme Procedure} listen sock backlog
@deffnx {C Function} scm_listen (sock, backlog)
Enable @var{sock} to accept connection
@@ -7612,7 +6915,6 @@ The return value is unspecified.
@end deffn
accept
-@c snarfed from socket.c:1014
@deffn {Scheme Procedure} accept sock
@deffnx {C Function} scm_accept (sock)
Accept a connection on a bound, listening socket.
@@ -7632,7 +6934,6 @@ connection and will continue to accept new requests.
@end deffn
getsockname
-@c snarfed from socket.c:1041
@deffn {Scheme Procedure} getsockname sock
@deffnx {C Function} scm_getsockname (sock)
Return the address of @var{sock}, in the same form as the
@@ -7641,7 +6942,6 @@ of a socket in the @code{AF_FILE} namespace cannot be read.
@end deffn
getpeername
-@c snarfed from socket.c:1063
@deffn {Scheme Procedure} getpeername sock
@deffnx {C Function} scm_getpeername (sock)
Return the address that @var{sock}
@@ -7651,7 +6951,6 @@ is connected to, in the same form as the object returned by
@end deffn
recv!
-@c snarfed from socket.c:1098
@deffn {Scheme Procedure} recv! sock buf [flags]
@deffnx {C Function} scm_recv (sock, buf, flags)
Receive data from a socket port.
@@ -7677,7 +6976,6 @@ any unread buffered port data is ignored.
@end deffn
send
-@c snarfed from socket.c:1131
@deffn {Scheme Procedure} send sock message [flags]
@deffnx {C Function} scm_send (sock, message, flags)
Transmit the string @var{message} on a socket port @var{sock}.
@@ -7696,7 +6994,6 @@ any unflushed buffered port data is ignored.
@end deffn
recvfrom!
-@c snarfed from socket.c:1171
@deffn {Scheme Procedure} recvfrom! sock str [flags [start [end]]]
@deffnx {C Function} scm_recvfrom (sock, str, flags, start, end)
Return data from the socket port @var{sock} and also
@@ -7725,7 +7022,6 @@ descriptor: any unread buffered port data is ignored.
@end deffn
sendto
-@c snarfed from socket.c:1229
@deffn {Scheme Procedure} sendto sock message fam address . args_and_flags
@deffnx {C Function} scm_sendto (sock, message, fam, address, args_and_flags)
Transmit the string @var{message} on the socket port
@@ -7749,61 +7045,51 @@ any unflushed buffered port data is ignored.
@end deffn
single-active-thread?
-@c snarfed from threads.c:79
@deffn {Scheme Procedure} single-active-thread?
implemented by the C function "scm_single_thread_p"
@end deffn
yield
-@c snarfed from threads.c:85
@deffn {Scheme Procedure} yield
implemented by the C function "scm_yield"
@end deffn
call-with-new-thread
-@c snarfed from threads.c:90
@deffn {Scheme Procedure} call-with-new-thread
implemented by the C function "scm_call_with_new_thread"
@end deffn
join-thread
-@c snarfed from threads.c:104
@deffn {Scheme Procedure} join-thread
implemented by the C function "scm_join_thread"
@end deffn
make-mutex
-@c snarfed from threads.c:109
@deffn {Scheme Procedure} make-mutex
implemented by the C function "scm_make_mutex"
@end deffn
lock-mutex
-@c snarfed from threads.c:112
@deffn {Scheme Procedure} lock-mutex
implemented by the C function "scm_lock_mutex"
@end deffn
unlock-mutex
-@c snarfed from threads.c:117
@deffn {Scheme Procedure} unlock-mutex
implemented by the C function "scm_unlock_mutex"
@end deffn
make-condition-variable
-@c snarfed from threads.c:123
@deffn {Scheme Procedure} make-condition-variable
implemented by the C function "scm_make_condition_variable"
@end deffn
wait-condition-variable
-@c snarfed from threads.c:125
@deffn {Scheme Procedure} wait-condition-variable
implemented by the C function "scm_wait_condition_variable"
@end deffn
signal-condition-variable
-@c snarfed from threads.c:127
@deffn {Scheme Procedure} signal-condition-variable
implemented by the C function "scm_signal_condition_variable"
@end deffn
diff --git a/doc/ref/ChangeLog b/doc/ref/ChangeLog
index bc58cf4c8..f3302fdb2 100644
--- a/doc/ref/ChangeLog
+++ b/doc/ref/ChangeLog
@@ -1,3 +1,17 @@
+2002-03-15 Neil Jerram <neil@ossau.uklinux.net>
+
+ * scheme-utility.texi (Object Properties): Revamp documentation on
+ object properties.
+
+ * scheme-memory.texi (Weak References): Update reference to Object
+ Properties node.
+
+ * guile.texi: Add macros for describing version information.
+
+ * scheme-data.texi, scheme-debug.texi, scheme-io.texi,
+ scheme-procedures.texi: Automatic updates from snarfed libguile
+ docstrings.
+
2002-03-13 Thien-Thi Nguyen <ttn@giblet.glug.org>
* Makefile.am (guile_toc.html): Look for guile.texi in $(srcdir).
diff --git a/doc/ref/guile.texi b/doc/ref/guile.texi
index d078c465b..58c9530c2 100644
--- a/doc/ref/guile.texi
+++ b/doc/ref/guile.texi
@@ -50,13 +50,40 @@
@include version.texi
+@c Macros for describing version information. I've initially defined
+@c all of these to expand to nothing, but they could perhaps be made to
+@c expand to something like "New in Guile 45!" in future.
+
+@c vnew - indicates the Guile version in which item first appeared.
+@macro vnew{VERSION}
+@end macro
+
+@c vdeprecated - indicates that the item has been deprecated, and the
+@c Guile version in which the deprecation started.
+@macro vdeprecated{VERSION}
+@end macro
+
+@c vgone - a way of tracking items that are no longer here. In this
+@c case, VERSION is the last Guile version in which the item was present.
+@macro vgone{WHAT, VERSION}
+@end macro
+
+@c vchanged - indicates the Guile version in which item's behaviour
+@c significantly changed.
+@macro vchanged{VERSION}
+@end macro
+
+@c vnote - catchall for any additional notes.
+@macro vnote{NOTE}
+@end macro
+
@c @iftex
@c @cropmarks
@c @end iftex
@dircategory The Algorithmic Language Scheme
@direntry
-* Guile Reference: (guile). The Guile reference manual.
+* Guile Reference: (guile). The Guile reference manual.
@end direntry
@setchapternewpage off
@@ -94,7 +121,7 @@ by the Free Software Foundation.
@sp 10
@comment The title is printed in a large font.
@title Guile Reference Manual
-@subtitle $Id: guile.texi,v 1.13 2002-03-08 21:23:36 ttn Exp $
+@subtitle $Id: guile.texi,v 1.14 2002-03-15 14:03:53 ossau Exp $
@subtitle For use with Guile @value{VERSION}
@c AUTHORS
diff --git a/doc/ref/new-docstrings.texi b/doc/ref/new-docstrings.texi
index 169f4c20e..2180561a6 100644
--- a/doc/ref/new-docstrings.texi
+++ b/doc/ref/new-docstrings.texi
@@ -321,7 +321,7 @@ Change the signature of export environment @var{env}.
@deffnx {C Function} scm_sys_compute_slots (class)
Return a list consisting of the names of all slots belonging to
class @var{class}, i. e. the slots of @var{class} and of all of
-its super-classes.
+its superclasses.
@end deffn
@deffn {Scheme Procedure} get-keyword key l default_value
@@ -532,7 +532,7 @@ Return the direct slots of the class @var{obj}.
@deffn {Scheme Procedure} class-direct-supers obj
@deffnx {C Function} scm_class_direct_supers (obj)
-Return the direct super-classes of the class @var{obj}.
+Return the direct superclasses of the class @var{obj}.
@end deffn
@deffn {Scheme Procedure} class-name obj
diff --git a/doc/ref/scheme-data.texi b/doc/ref/scheme-data.texi
index 6404da80f..c9f54b246 100755
--- a/doc/ref/scheme-data.texi
+++ b/doc/ref/scheme-data.texi
@@ -339,7 +339,7 @@ if @var{obj} is an integer number or a rational number.
@deffn {Scheme Procedure} rational? x
@deffnx {C Function} scm_real_p (x)
Return @code{#t} if @var{x} is a rational number, @code{#f}
-else. Note that the set of integer values forms a subset of
+otherwise. Note that the set of integer values forms a subset of
the set of rational numbers, i. e. the predicate will also be
fulfilled if @var{x} is an integer number. Real numbers
will also satisfy this predicate, because of their limited
@@ -379,7 +379,7 @@ properties of inexactness and limited precision as single real numbers.
@deffn {Scheme Procedure} complex? x
@deffnx {C Function} scm_number_p (x)
Return @code{#t} if @var{x} is a complex number, @code{#f}
-else. Note that the sets of real, rational and integer
+otherwise. Note that the sets of real, rational and integer
values form subsets of the set of complex numbers, i. e. the
predicate will also be fulfilled if @var{x} is a real,
rational or integer number.
@@ -1443,7 +1443,7 @@ fulfills some specified property.
@rnindex string?
@deffn {Scheme Procedure} string? obj
@deffnx {C Function} scm_string_p (obj)
-Return @code{#t} iff @var{obj} is a string, else @code{#f}.
+Return @code{#t} if @var{obj} is a string, else @code{#f}.
@end deffn
@deffn {Scheme Procedure} string-null? str
diff --git a/doc/ref/scheme-debug.texi b/doc/ref/scheme-debug.texi
index f939c03be..f3dde5a35 100644
--- a/doc/ref/scheme-debug.texi
+++ b/doc/ref/scheme-debug.texi
@@ -51,7 +51,7 @@ allocated.
@deffnx {C Function} scm_debug_options (setting)
Option interface for the debug options. Instead of using
this procedure directly, use the procedures @code{debug-enable},
-@code{debug-disable}, @code{debug-set!} and @var{debug-options}.
+@code{debug-disable}, @code{debug-set!} and @code{debug-options}.
@end deffn
@deffn {Scheme Procedure} with-traps thunk
diff --git a/doc/ref/scheme-io.texi b/doc/ref/scheme-io.texi
index ee29a1325..3df790051 100644
--- a/doc/ref/scheme-io.texi
+++ b/doc/ref/scheme-io.texi
@@ -890,7 +890,7 @@ always returns the end-of-file object when read from.
@deffn {Scheme Procedure} %make-void-port mode
@deffnx {C Function} scm_sys_make_void_port (mode)
Create and return a new void port. A void port acts like
-/dev/null. The @var{mode} argument
+@file{/dev/null}. The @var{mode} argument
specifies the input/output modes for this port: see the
documentation for @code{open-file} in @ref{File Ports}.
@end deffn
diff --git a/doc/ref/scheme-memory.texi b/doc/ref/scheme-memory.texi
index 9ffb9a341..af0088692 100644
--- a/doc/ref/scheme-memory.texi
+++ b/doc/ref/scheme-memory.texi
@@ -199,8 +199,8 @@ as soon as the value is no longer in use. Entries in a doubly weak hash
disappear when either the key or the value are not used anywhere else
anymore.
-Property lists offer the same kind of functionality as weak key hashes
-in many situations. (@pxref{Property Lists})
+Object properties offer the same kind of functionality as weak key
+hashes in many situations. (@pxref{Object Properties})
Here's an example (a little bit strained perhaps, but one of the
examples is actually used in Guile):
diff --git a/doc/ref/scheme-procedures.texi b/doc/ref/scheme-procedures.texi
index 00fe09efc..8ef23737e 100644
--- a/doc/ref/scheme-procedures.texi
+++ b/doc/ref/scheme-procedures.texi
@@ -738,9 +738,7 @@ environment.
Return a @dfn{macro} which, when a symbol defined to this value
appears as the first symbol in an expression, evaluates the
result of applying @var{code} to the expression and the
-environment. The value returned from @var{code} which has been
-passed to @code{procedure->memoizing-macro} replaces the form
-passed to @var{code}. For example:
+environment. For example:
@lisp
(define trace
diff --git a/doc/ref/scheme-utility.texi b/doc/ref/scheme-utility.texi
index bcec4b881..cc1556c31 100644
--- a/doc/ref/scheme-utility.texi
+++ b/doc/ref/scheme-utility.texi
@@ -10,8 +10,7 @@ applications, they are collected in a @dfn{utility} chapter.
@menu
* Equality:: When are two values `the same'?
-* Property Lists:: Managing meta-information about Scheme objects.
-* Primitive Properties:: A modern interface to object properties.
+* Object Properties:: A modern interface to object properties.
* Sorting:: Sort utility procedures.
* Copying:: Copying deep structures.
* General Conversion:: Converting objects to strings.
@@ -75,48 +74,78 @@ terminate if its arguments are circular data structures.
@end deffn
-@node Property Lists
-@section Property Lists
+@node Object Properties
+@section Object Properties
-Every object in the system can have a @dfn{property list} that may
-be used for information about that object. For example, a
-function may have a property list that includes information about
-the source file in which it is defined.
+It's often useful to associate a piece of additional information with a
+Scheme object even though that object does not have a dedicated slot
+available in which the additional information could be stored. Object
+properties allow you to do just that.
-Property lists are implemented as assq lists (@pxref{Association Lists}).
+An object property is most commonly used to associate one kind of
+additional information with each instance of a class of similar Scheme
+objects. For example, all procedures have a `name' property, which
+stores the name of the variable in which the procedure was stored by a
+@code{define} expression, or @code{#f} if the procedure wasn't created
+by that kind of expression.
-Currently, property lists are implemented differently for procedures and
-closures than for other kinds of objects. Therefore, when manipulating
-a property list associated with a procedure object, use the
-@code{procedure} functions; otherwise, use the @code{object} functions.
+Guile's representation of an object property is a procedure-with-setter
+(@pxref{Procedures with Setters}) that can be used with the generalized
+form of @code{set!} (REFFIXME) to set and retrieve that property for any
+Scheme object. So, setting a property looks like this:
-@deffn {Scheme Procedure} object-properties obj
-@deffnx {C Function} scm_object_properties (obj)
-Return @var{obj}'s property list.
-@end deffn
+@lisp
+(set! (my-property obj1) value-for-obj1)
+(set! (my-property obj2) value-for-obj2)
+@end lisp
-@deffn {Scheme Procedure} set-object-properties! obj alist
-@deffnx {C Function} scm_set_object_properties_x (obj, alist)
-Set @var{obj}'s property list to @var{alist}.
-@end deffn
+@noindent
+And retrieving values of the same property looks like this:
-@deffn {Scheme Procedure} object-property obj key
-@deffnx {C Function} scm_object_property (obj, key)
-Return the property of @var{obj} with name @var{key}.
-@end deffn
+@lisp
+(my-property obj1)
+@result{}
+value-for-obj1
-@deffn {Scheme Procedure} set-object-property! obj key value
-@deffnx {C Function} scm_set_object_property_x (obj, key, value)
-In @var{obj}'s property list, set the property named @var{key}
-to @var{value}.
+(my-property obj2)
+@result{}
+value-for-obj2
+@end lisp
+
+To create an object property in the first place, use the
+@code{make-object-property} procedure:
+
+@lisp
+(define my-property (make-object-property))
+@end lisp
+
+@deffn {Scheme Procedure} make-object-property
+Create and return an object property. An object property is a
+procedure-with-setter that can be called in two ways. @code{(set!
+(@var{property} @var{obj}) @var{val})} sets @var{obj}'s @var{property}
+to @var{val}. @code{(@var{property} @var{obj})} returns the current
+setting of @var{obj}'s @var{property}.
@end deffn
-[Interface bug: there should be a second level of interface in which
-the user provides a "property table" that is possibly private.]
+A single object property created by @code{make-object-property} can
+associate distinct property values with all Scheme values that are
+distinguishable by @code{eq?} (including, for example, integers).
+
+Internally, object properties are implemented using a weak key hash
+table. This means that, as long as a Scheme value with property values
+is protected from garbage collection, its property values are also
+protected. When the Scheme value is collected, its entry in the
+property table is removed and so the (ex-) property values are no longer
+protected by the table.
+
+@menu
+* Property Primitives:: Low level property implementation.
+* Old-fashioned Properties:: An older approach to properties.
+@end menu
-@node Primitive Properties
-@section Primitive Properties
+@node Property Primitives
+@subsection Low Level Property Implementation.
@deffn {Scheme Procedure} primitive-make-property not_found_proc
@deffnx {C Function} scm_primitive_make_property (not_found_proc)
@@ -148,6 +177,41 @@ Remove any value associated with @var{prop} and @var{obj}.
@end deffn
+@node Old-fashioned Properties
+@subsection An Older Approach to Properties
+
+Traditionally, Lisp systems provide a different object property
+interface to that provided by @code{make-object-property}, in which the
+object property that is being set or retrieved is indicated by a symbol.
+
+Guile includes this older kind of interface as well, but it may well be
+removed in a future release, as it is less powerful than
+@code{make-object-property} and so increases the size of the Guile
+library for no benefit. (And it is trivial to write a compatibility
+layer in Scheme.)
+
+@deffn {Scheme Procedure} object-properties obj
+@deffnx {C Function} scm_object_properties (obj)
+Return @var{obj}'s property list.
+@end deffn
+
+@deffn {Scheme Procedure} set-object-properties! obj alist
+@deffnx {C Function} scm_set_object_properties_x (obj, alist)
+Set @var{obj}'s property list to @var{alist}.
+@end deffn
+
+@deffn {Scheme Procedure} object-property obj key
+@deffnx {C Function} scm_object_property (obj, key)
+Return the property of @var{obj} with name @var{key}.
+@end deffn
+
+@deffn {Scheme Procedure} set-object-property! obj key value
+@deffnx {C Function} scm_set_object_property_x (obj, key, value)
+In @var{obj}'s property list, set the property named @var{key}
+to @var{value}.
+@end deffn
+
+
@node Sorting
@section Sorting
@@ -349,13 +413,13 @@ arguments. When the procedures have been added, we can invoke them
using @code{run-hook}.
@lisp
-(add-hook! hook (lambda (x y)
- (display "Foo: ")
- (display (+ x y))
+(add-hook! hook (lambda (x y)
+ (display "Foo: ")
+ (display (+ x y))
(newline)))
-(add-hook! hook (lambda (x y)
- (display "Bar: ")
- (display (* x y))
+(add-hook! hook (lambda (x y)
+ (display "Bar: ")
+ (display (* x y))
(newline)))
(run-hook hook 3 4)
@print{} Bar: 12
@@ -367,14 +431,14 @@ added. This can be changed by providing the optional third argument
on the second call to @code{add-hook!}.
@lisp
-(add-hook! hook (lambda (x y)
- (display "Foo: ")
- (display (+ x y))
+(add-hook! hook (lambda (x y)
+ (display "Foo: ")
+ (display (+ x y))
(newline)))
-(add-hook! hook (lambda (x y)
- (display "Bar: ")
- (display (* x y))
- (newline))
+(add-hook! hook (lambda (x y)
+ (display "Bar: ")
+ (display (* x y))
+ (newline))
#t) ; @r{<- Change here!}
(run-hook hook 3 4)
@print{} Foo: 7
diff --git a/doc/ref/scripts.texi b/doc/ref/scripts.texi
index d8134deee..4a121e5fc 100644
--- a/doc/ref/scripts.texi
+++ b/doc/ref/scripts.texi
@@ -101,6 +101,7 @@ slow down execution. By default, the debugging evaluator is only used
when entering an interactive session. When executing a script with
@code{-s} or @code{-c}, the normal, faster evaluator is used by default.
+@vnew{1.6}
@item --no-debug
Do not use the debugging evaluator, even when entering an interactive
session.