diff --git a/doc/maint/guile.texi b/doc/maint/guile.texi index 84a4c1c8f..fa8125594 100644 --- a/doc/maint/guile.texi +++ b/doc/maint/guile.texi @@ -1,5 +1,6 @@ acons +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -9,6 +10,7 @@ function is @emph{not} destructive; @var{alist} is not modified. @end deffn sloppy-assq +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -16,6 +18,7 @@ Recommended only for use in Guile internals. @end deffn sloppy-assv +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -23,6 +26,7 @@ Recommended only for use in Guile internals. @end deffn sloppy-assoc +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -30,6 +34,7 @@ Recommended only for use in Guile internals. @end deffn assq +@c snarfed from /home/ghouston/guile/guile-core/libguile/alist.c:136 @deffn {Scheme Procedure} assq key alist @deffnx {Scheme Procedure} assv key alist @deffnx {Scheme Procedure} assoc key alist @@ -44,18 +49,21 @@ return the entire alist entry found (i.e. both the key and the value). @end deffn assv +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/alist.c:222 @deffn {Scheme Procedure} assq-ref alist key @deffnx {Scheme Procedure} assv-ref alist key @deffnx {Scheme Procedure} assoc-ref alist key @@ -73,18 +81,21 @@ where @var{associator} is one of @code{assq}, @code{assv} or @code{assoc}. @end deffn assv-ref +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -100,18 +111,21 @@ association list. @end deffn assv-set! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/alist.c:345 @deffn {Scheme Procedure} assq-remove! alist key @deffnx {Scheme Procedure} assv-remove! alist key @deffnx {Scheme Procedure} assoc-remove! alist key @@ -121,18 +135,21 @@ the resulting alist. @end deffn assv-remove! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -141,6 +158,7 @@ process synchronization. @end deffn try-arbiter +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -148,6 +166,7 @@ was unlocked. Otherwise, return @code{#f}. @end deffn release-arbiter +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -155,12 +174,14 @@ arbiter was locked. Otherwise, return @code{#f}. @end deffn async +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -168,24 +189,28 @@ add it to the system's list of active async objects. @end deffn async-mark +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/async.c:385 @deffn {Scheme Procedure} noop . args @deffnx {C Function} scm_noop (args) Do nothing. When called without arguments, return @code{#f}, @@ -193,18 +218,21 @@ otherwise return the first argument. @end deffn unmask-signals +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/backtrace.c:264 @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}. @@ -217,6 +245,7 @@ ignored. @end deffn display-application +@c snarfed from /home/ghouston/guile/guile-core/libguile/backtrace.c:400 @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 @@ -225,6 +254,7 @@ output. @end deffn display-backtrace +@c snarfed from /home/ghouston/guile/guile-core/libguile/backtrace.c:711 @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} @@ -235,6 +265,7 @@ which means that default values will be used. @end deffn backtrace +@c snarfed from /home/ghouston/guile/guile-core/libguile/backtrace.c:734 @deffn {Scheme Procedure} backtrace @deffnx {C Function} scm_backtrace () Display a backtrace of the stack saved by the last error @@ -242,83 +273,97 @@ to the current output port. @end deffn not +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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}. @@ -326,6 +371,7 @@ Alphabetic means the same thing as the isalpha C library function. @end deffn char-numeric? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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}. @@ -333,6 +379,7 @@ Numeric means the same thing as the isdigit C library function. @end deffn char-whitespace? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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}. @@ -340,6 +387,7 @@ Whitespace means the same thing as the isspace C library function. @end deffn char-upper-case? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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}. @@ -347,6 +395,7 @@ Uppercase means the same thing as the isupper C library function. @end deffn char-lower-case? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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}. @@ -354,6 +403,7 @@ Lowercase means the same thing as the islower C library function. @end deffn char-is-both? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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}. @@ -362,6 +412,7 @@ C library functions. @end deffn char->integer +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -369,24 +420,28 @@ ASCII sequence. @end deffn integer->char +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -395,48 +450,56 @@ this procedure directly, use the procedures @code{debug-enable}, @end deffn with-traps +@c snarfed from /home/ghouston/guile/guile-core/libguile/debug.c:122 @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 /home/ghouston/guile/guile-core/libguile/debug.c:164 @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 /home/ghouston/guile/guile-core/libguile/debug.c:328 @deffn {Scheme Procedure} unmemoize m @deffnx {C Function} scm_unmemoize (m) Unmemoize the memoized expression @var{m}, @end deffn memoized-environment +@c snarfed from /home/ghouston/guile/guile-core/libguile/debug.c:338 @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 /home/ghouston/guile/guile-core/libguile/debug.c:348 @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 /home/ghouston/guile/guile-core/libguile/debug.c:374 @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 /home/ghouston/guile/guile-core/libguile/debug.c:407 @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 /home/ghouston/guile/guile-core/libguile/debug.c:439 @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, @@ -446,51 +509,64 @@ is implicit). @end deffn debug-object? +@c snarfed from /home/ghouston/guile/guile-core/libguile/debug.c:526 @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 /home/ghouston/guile/guile-core/libguile/dynl.c:212 @deffn {Scheme Procedure} dynamic-link filename @deffnx {C Function} scm_dynamic_link (filename) -Open the dynamic library called @var{filename}. A library -handle representing the opened library is returned; this handle -should be used as the @var{dobj} argument to the following -functions. +Find the shared object (shared library) denoted by +@var{filename} and link it into the running Guile +application. The returned +scheme object is a ``handle'' for the library which can +be passed to @code{dynamic-func}, @code{dynamic-call} etc. + +Searching for object files is system dependent. Normally, +if @var{filename} does have an explicit directory it will +be searched for in locations +such as @file{/usr/lib} and @file{/usr/local/lib}. @end deffn dynamic-object? +@c snarfed from /home/ghouston/guile/guile-core/libguile/dynl.c:227 @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} -otherwise. +Return @code{#t} if @var{obj} is a dynamic object handle, +or @code{#f} otherwise. @end deffn dynamic-unlink +@c snarfed from /home/ghouston/guile/guile-core/libguile/dynl.c:241 @deffn {Scheme Procedure} dynamic-unlink dobj @deffnx {C Function} scm_dynamic_unlink (dobj) -Unlink the indicated object file from the application. The -argument @var{dobj} must have been obtained by a call to -@code{dynamic-link}. After @code{dynamic-unlink} has been -called on @var{dobj}, its content is no longer accessible. +Unlink a dynamic object from the application, if possible. The +object must have been linked by @code{dynamic-link}, with +@var{dobj} the corresponding handle. After this procedure +is called, the handle can no longer be used to access the +object. @end deffn dynamic-func +@c snarfed from /home/ghouston/guile/guile-core/libguile/dynl.c:266 @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 -indicated by the string @var{name} and return some Scheme -handle that can later be used with @code{dynamic-call} to -actually call the function. +Return a ``handle'' for the function @var{name} in the +shared object referred to by @var{dobj}. The handle +can be passed to @code{dynamic-call} to actually +call the function. -Regardless whether your C compiler prepends an underscore @samp{_} to -the global names in a program, you should @strong{not} include this -underscore in @var{function}. Guile knows whether the underscore is -needed or not and will add it when necessary. +Regardless whether your C compiler prepends an underscore +@samp{_} to the global names in a program, you should +@strong{not} include this underscore in @var{name} +since it will be added automatically when necessary. @end deffn dynamic-call +@c snarfed from /home/ghouston/guile/guile-core/libguile/dynl.c:308 @deffn {Scheme Procedure} dynamic-call func dobj @deffnx {C Function} scm_dynamic_call (func, dobj) Call a C function in a dynamic object. Two styles of @@ -515,6 +591,7 @@ and its return value is ignored. @end deffn dynamic-args-call +@c snarfed from /home/ghouston/guile/guile-core/libguile/dynl.c:363 @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}, @@ -533,6 +610,7 @@ converted to a Scheme number and returned from the call to @end deffn dynamic-wind +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -586,6 +664,7 @@ a-cont @end deffn environment? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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} @@ -593,6 +672,7 @@ otherwise. @end deffn environment-bound? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -600,6 +680,7 @@ Return @code{#t} if @var{sym} is bound in @var{env}, or @end deffn environment-ref +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -608,6 +689,7 @@ Return the value of the location bound to @var{sym} in @end deffn environment-fold +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -644,6 +726,7 @@ using environment-fold: @end deffn environment-define +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -656,6 +739,7 @@ immutable, signal an @code{environment:immutable-binding} error. @end deffn environment-undefine +@c snarfed from /home/ghouston/guile/guile-core/libguile/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} @@ -666,6 +750,7 @@ immutable, signal an @code{environment:immutable-binding} error. @end deffn environment-set! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -678,6 +763,7 @@ to an immutable location, signal an @end deffn environment-cell +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -695,6 +781,7 @@ re-bound to a new value cell, or becomes undefined. @end deffn environment-observe +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -706,6 +793,7 @@ token is unspecified. @end deffn environment-observe-weak +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -717,6 +805,7 @@ list of observing procedures. @end deffn environment-unobserve +@c snarfed from /home/ghouston/guile/guile-core/libguile/environments.c:454 @deffn {Scheme Procedure} environment-unobserve token @deffnx {C Function} scm_environment_unobserve (token) Cancel the observation request which returned the value @@ -728,6 +817,7 @@ bindings change. @end deffn make-leaf-environment +@c snarfed from /home/ghouston/guile/guile-core/libguile/environments.c:1031 @deffn {Scheme Procedure} make-leaf-environment @deffnx {C Function} scm_make_leaf_environment () Create a new leaf environment, containing no bindings. @@ -736,6 +826,7 @@ will be mutable. @end deffn leaf-environment? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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} @@ -743,6 +834,7 @@ otherwise. @end deffn make-eval-environment +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -769,6 +861,7 @@ In typical use, @var{local} will be a finite environment, and @end deffn eval-environment? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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} @@ -776,30 +869,35 @@ otherwise. @end deffn eval-environment-local +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -830,6 +928,7 @@ if one of its imported environments changes. @end deffn import-environment? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -837,6 +936,7 @@ Return @code{#t} if object is an import environment, or @end deffn import-environment-imports +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -844,6 +944,7 @@ environment @var{env}. @end deffn import-environment-set-imports! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -851,6 +952,7 @@ Change @var{env}'s list of imported environments to @end deffn make-export-environment +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -900,6 +1002,7 @@ if the bindings in private change. @end deffn export-environment? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -907,30 +1010,35 @@ Return @code{#t} if object is an export environment, or @end deffn export-environment-private +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -939,6 +1047,7 @@ capable of discerning distinctions finer than those detectable by @end deffn eqv? +@c snarfed from /home/ghouston/guile/guile-core/libguile/eq.c:85 @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 @@ -948,6 +1057,7 @@ and inexact numbers. @end deffn equal? +@c snarfed from /home/ghouston/guile/guile-core/libguile/eq.c:138 @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, @@ -958,6 +1068,7 @@ terminate if its arguments are circular data structures. @end deffn scm-error +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -976,6 +1087,7 @@ it will usually be @code{#f}. @end deffn strerror +@c snarfed from /home/ghouston/guile/guile-core/libguile/error.c:168 @deffn {Scheme Procedure} strerror err @deffnx {C Function} scm_strerror (err) Return the Unix error message corresponding to @var{err}, which @@ -983,6 +1095,7 @@ must be an integer value. @end deffn apply:nconc2last +@c snarfed from /home/ghouston/guile/guile-core/libguile/eval.c:3409 @deffn {Scheme Procedure} apply:nconc2last lst @deffnx {C Function} scm_nconc2last (lst) Given a list (@var{arg1} @dots{} @var{args}), this function @@ -995,6 +1108,7 @@ destroys its argument, so use with care. @end deffn force +@c snarfed from /home/ghouston/guile/guile-core/libguile/eval.c:3945 @deffn {Scheme Procedure} force x @deffnx {C Function} scm_force (x) If the promise @var{x} has not been computed yet, compute and @@ -1003,6 +1117,7 @@ value. @end deffn promise? +@c snarfed from /home/ghouston/guile/guile-core/libguile/eval.c:3968 @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 @@ -1010,6 +1125,7 @@ Return true if @var{obj} is a promise, i.e. a delayed computation @end deffn cons-source +@c snarfed from /home/ghouston/guile/guile-core/libguile/eval.c:3980 @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}. @@ -1018,6 +1134,7 @@ with the new pair. @end deffn copy-tree +@c snarfed from /home/ghouston/guile/guile-core/libguile/eval.c:4000 @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 @@ -1028,6 +1145,7 @@ any other object. @end deffn primitive-eval +@c snarfed from /home/ghouston/guile/guile-core/libguile/eval.c:4093 @deffn {Scheme Procedure} primitive-eval exp @deffnx {C Function} scm_primitive_eval (exp) Evaluate @var{exp} in the top-level environment specified by @@ -1035,6 +1153,7 @@ the current module. @end deffn eval +@c snarfed from /home/ghouston/guile/guile-core/libguile/eval.c:4162 @deffn {Scheme Procedure} eval exp module @deffnx {C Function} scm_eval (exp, module) Evaluate @var{exp}, a list representing a Scheme expression, @@ -1045,6 +1164,7 @@ is reset to its previous value when @var{eval} returns. @end deffn eval-options-interface +@c snarfed from /home/ghouston/guile/guile-core/libguile/eval.c:1747 @deffn {Scheme Procedure} eval-options-interface [setting] @deffnx {C Function} scm_eval_options_interface (setting) Option interface for the evaluation options. Instead of using @@ -1053,23 +1173,27 @@ this procedure directly, use the procedures @code{eval-enable}, @end deffn evaluator-traps-interface +@c snarfed from /home/ghouston/guile/guile-core/libguile/eval.c:1764 @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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/evalext.c:144 @deffn {Scheme Procedure} map-in-order implemented by the C function "scm_map" @end deffn load-extension +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -1109,6 +1233,7 @@ well. For example, @end deffn program-arguments +@c snarfed from /home/ghouston/guile/guile-core/libguile/feature.c:77 @deffn {Scheme Procedure} program-arguments @deffnx {Scheme Procedure} command-line @deffnx {C Function} scm_program_arguments () @@ -1119,6 +1244,7 @@ options like @code{-e} and @code{-l}. @end deffn make-fluid +@c snarfed from /home/ghouston/guile/guile-core/libguile/fluids.c:124 @deffn {Scheme Procedure} make-fluid @deffnx {C Function} scm_make_fluid () Return a newly created fluid. @@ -1131,6 +1257,7 @@ in its own dynamic root, you can use fluids for thread local storage. @end deffn fluid? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1138,6 +1265,7 @@ Return @code{#t} iff @var{obj} is a fluid; otherwise, return @end deffn fluid-ref +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1146,12 +1274,14 @@ dynamic root. If @var{fluid} has not been set, then return @end deffn fluid-set! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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}. @@ -1161,6 +1291,7 @@ one after another. @var{thunk} must be a procedure with no argument. @end deffn setvbuf +@c snarfed from /home/ghouston/guile/guile-core/libguile/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: @@ -1176,12 +1307,14 @@ If @var{size} is omitted, a default size will be used. @end deffn file-port? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -1224,6 +1357,7 @@ requested, @code{open-file} throws an exception. @end deffn gc-stats +@c snarfed from /home/ghouston/guile/guile-core/libguile/gc.c:735 @deffn {Scheme Procedure} gc-stats @deffnx {C Function} scm_gc_stats () Return an association list of statistics about Guile's current @@ -1231,6 +1365,7 @@ use of storage. @end deffn object-address +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1238,6 +1373,7 @@ returned by this function for @var{obj} @end deffn gc +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1245,6 +1381,7 @@ no longer accessible. @end deffn %compute-slots +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1253,6 +1390,7 @@ its superclasses. @end deffn get-keyword +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1264,6 +1402,7 @@ If @var{l} does not hold a value for @var{key}, the value @end deffn %initialize-object +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1271,126 +1410,147 @@ Initialize the object @var{obj} with the given arguments @end deffn %prep-layout! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/goops.c:916 @deffn {Scheme Procedure} method-generic-function obj @deffnx {C Function} scm_method_generic_function (obj) Return the generic function for the method @var{obj}. @end deffn method-specializers +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/goops.c:971 @deffn {Scheme Procedure} make-unbound @deffnx {C Function} scm_make_unbound () Return the unbound value. @end deffn unbound? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -1398,6 +1558,7 @@ Return @var{value} if it is bound, and invoke the @end deffn @@assert-bound-ref +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1405,12 +1566,14 @@ the value from @var{obj}. @end deffn %fast-slot-ref +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -1418,30 +1581,35 @@ Set the slot with index @var{index} in @var{obj} to @end deffn slot-ref-using-class +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -1449,12 +1617,14 @@ Return the value from @var{obj}'s slot with the name @end deffn slot-set! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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} @@ -1462,12 +1632,14 @@ is bound. @end deffn slot-exists? +@c snarfed from /home/ghouston/guile/guile-core/libguile/goops.c:1278 @deffn {Scheme Procedure} slot-exists? obj slot_name -@deffnx {C Function} scm_slots_exists_p (obj, slot_name) +@deffnx {C Function} scm_slot_exists_p (obj, slot_name) Return @code{#t} if @var{obj} has a slot named @var{slot_name}. @end deffn %allocate-instance +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1475,54 +1647,63 @@ from the arguments @var{initargs}. @end deffn %set-object-setter! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/goops.c:1649 @deffn {Scheme Procedure} primitive-generic-generic subr @deffnx {C Function} scm_primitive_generic_generic (subr) @end deffn make +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1530,18 +1711,21 @@ all necessary initialization information. @end deffn find-method +@c snarfed from /home/ghouston/guile/guile-core/libguile/goops.c:2103 @deffn {Scheme Procedure} find-method . l @deffnx {C Function} scm_find_method (l) @end deffn %method-more-specific? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/goops.c:2648 @deffn {Scheme Procedure} %goops-loaded @deffnx {C Function} scm_sys_goops_loaded () Announce that GOOPS is loaded and perform initialization @@ -1549,6 +1733,7 @@ on the C level which depends on the loaded GOOPS modules. @end deffn make-guardian +@c snarfed from /home/ghouston/guile/guile-core/libguile/guardians.c:330 @deffn {Scheme Procedure} make-guardian [greedy_p] @deffnx {C Function} scm_make_guardian (greedy_p) Create a new guardian. @@ -1579,18 +1764,21 @@ paper still (mostly) accurately describes the interface). @end deffn guardian-destroyed? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -1599,6 +1787,7 @@ objects guarded by @var{guardian}. @end deffn hashq +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1614,6 +1803,7 @@ different values, since @code{foo} will be garbage collected. @end deffn hashv +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1629,6 +1819,7 @@ different values, since @code{foo} will be garbage collected. @end deffn hash +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1638,6 +1829,7 @@ integer in the range 0 to @var{size} - 1. @end deffn hashq-get-handle +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1647,6 +1839,7 @@ Uses @code{eq?} for equality testing. @end deffn hashq-create-handle! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -1655,6 +1848,7 @@ associates @var{key} with @var{init}. @end deffn hashq-ref +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1664,6 +1858,7 @@ is supplied). Uses @code{eq?} for equality testing. @end deffn hashq-set! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1671,6 +1866,7 @@ store @var{value} there. Uses @code{eq?} for equality testing. @end deffn hashq-remove! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1678,6 +1874,7 @@ Remove @var{key} (and any value associated with it) from @end deffn hashv-get-handle +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1687,6 +1884,7 @@ Uses @code{eqv?} for equality testing. @end deffn hashv-create-handle! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -1695,6 +1893,7 @@ associates @var{key} with @var{init}. @end deffn hashv-ref +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1704,6 +1903,7 @@ is supplied). Uses @code{eqv?} for equality testing. @end deffn hashv-set! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1711,6 +1911,7 @@ store @var{value} there. Uses @code{eqv?} for equality testing. @end deffn hashv-remove! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1718,6 +1919,7 @@ Remove @var{key} (and any value associated with it) from @end deffn hash-get-handle +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1727,6 +1929,7 @@ Uses @code{equal?} for equality testing. @end deffn hash-create-handle! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -1735,6 +1938,7 @@ associates @var{key} with @var{init}. @end deffn hash-ref +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1744,6 +1948,7 @@ is supplied). Uses @code{equal?} for equality testing. @end deffn hash-set! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1752,6 +1957,7 @@ testing. @end deffn hash-remove! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1759,6 +1965,7 @@ Remove @var{key} (and any value associated with it) from @end deffn hashx-get-handle +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1770,6 +1977,7 @@ table size. @code{assoc} must be an associator function, like @end deffn hashx-create-handle! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1781,6 +1989,7 @@ table size. @code{assoc} must be an associator function, like @end deffn hashx-ref +@c snarfed from /home/ghouston/guile/guile-core/libguile/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} @@ -1795,6 +2004,7 @@ equivalent to @code{hashx-ref hashq assq table key}. @end deffn hashx-set! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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!} @@ -1809,6 +2019,7 @@ equivalent to @code{hashx-set! hashq assq table key}. @end deffn hash-fold +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -1822,6 +2033,7 @@ table into an a-list of key-value pairs. @end deffn make-hook +@c snarfed from /home/ghouston/guile/guile-core/libguile/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}. @@ -1830,12 +2042,14 @@ object to be used with the other hook procedures. @end deffn hook? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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} @@ -1843,6 +2057,7 @@ otherwise. @end deffn add-hook! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1852,6 +2067,7 @@ procedure is not specified. @end deffn remove-hook! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1859,6 +2075,7 @@ return value of this procedure is not specified. @end deffn reset-hook! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1866,6 +2083,7 @@ value of this procedure is not specified. @end deffn run-hook +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1874,12 +2092,14 @@ last. The return value of this procedure is not specified. @end deffn hook->list +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/ioext.c:73 @deffn {Scheme Procedure} ftell fd_port @deffnx {C Function} scm_ftell (fd_port) Return an integer representing the current position of @@ -1891,6 +2111,7 @@ Return an integer representing the current position of @end deffn redirect-port +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1909,6 +2130,7 @@ revealed counts. @end deffn dup->fdes +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1917,6 +2139,7 @@ file port or a file descriptor. @end deffn dup2 +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -1930,6 +2153,7 @@ The return value is unspecified. @end deffn fileno +@c snarfed from /home/ghouston/guile/guile-core/libguile/ioext.c:196 @deffn {Scheme Procedure} fileno port @deffnx {C Function} scm_fileno (port) Return the integer file descriptor underlying @var{port}. Does @@ -1937,6 +2161,7 @@ not change its revealed count. @end deffn isatty? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1944,6 +2169,7 @@ device, otherwise @code{#f}. @end deffn fdopen +@c snarfed from /home/ghouston/guile/guile-core/libguile/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}. @@ -1953,6 +2179,7 @@ same as that accepted by @ref{File Ports, open-file}. @end deffn primitive-move->fdes +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1964,6 +2191,7 @@ required value or @code{#t} if it was moved. @end deffn fdes->ports +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -1972,12 +2200,14 @@ counts. @end deffn make-keyword-from-dash-symbol +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -1985,6 +2215,7 @@ Return @code{#t} if the argument @var{obj} is a keyword, else @end deffn keyword-dash-symbol +@c snarfed from /home/ghouston/guile/guile-core/libguile/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}. @@ -1992,6 +2223,7 @@ This is the inverse of @code{make-keyword-from-dash-symbol}. @end deffn list +@c snarfed from /home/ghouston/guile/guile-core/libguile/list.c:127 @deffn {Scheme Procedure} list . objs @deffnx {C Function} scm_list (objs) Return a list containing @var{objs}, the arguments to @@ -1999,6 +2231,7 @@ Return a list containing @var{objs}, the arguments to @end deffn cons* +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2010,24 +2243,28 @@ Schemes and in Common LISP. @end deffn null? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -2048,6 +2285,7 @@ if the last argument is not a proper list. @end deffn append! +@c snarfed from /home/ghouston/guile/guile-core/libguile/list.c:280 @deffn {Scheme Procedure} append! . lists @deffnx {C Function} scm_append_x (lists) A destructive version of @code{append} (@pxref{Pairs and @@ -2058,6 +2296,7 @@ the mutated list. @end deffn last-pair +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2065,6 +2304,7 @@ Return a pointer to the last pair in @var{lst}, signalling an error if @end deffn reverse +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2072,6 +2312,7 @@ in reverse order. @end deffn reverse! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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, @@ -2088,23 +2329,27 @@ of the modified list is not lost, it is wise to save the return value of @end deffn list-ref +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/list.c:443 @deffn {Scheme Procedure} list-cdr-ref implemented by the C function "scm_list_tail" @end deffn list-tail +@c snarfed from /home/ghouston/guile/guile-core/libguile/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) @@ -2117,12 +2362,14 @@ or returning the results of cdring @var{k} times down @var{lst}. @end deffn list-cdr-set! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -2130,12 +2377,14 @@ return it. @end deffn list-copy +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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?} @@ -2147,6 +2396,7 @@ returned. @end deffn memv +@c snarfed from /home/ghouston/guile/guile-core/libguile/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?} @@ -2158,6 +2408,7 @@ returned. @end deffn member +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2169,6 +2420,7 @@ empty list) is returned. @end deffn delq! +@c snarfed from /home/ghouston/guile/guile-core/libguile/list.c:637 @deffn {Scheme Procedure} delq! item lst @deffnx {Scheme Procedure} delv! item lst @deffnx {Scheme Procedure} delete! item lst @@ -2182,6 +2434,7 @@ destructive list functions, these functions cannot modify the binding of @end deffn delv! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2189,6 +2442,7 @@ Destructively remove all elements from @var{lst} that are @end deffn delete! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2196,6 +2450,7 @@ Destructively remove all elements from @var{lst} that are @end deffn delq +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2205,6 +2460,7 @@ Return a newly-created copy of @var{lst} with elements @end deffn delv +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2214,6 +2470,7 @@ Return a newly-created copy of @var{lst} with elements @end deffn delete +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2223,6 +2480,7 @@ against @var{item} with @code{equal?}. @end deffn delq1! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2231,6 +2489,7 @@ Like @code{delq!}, but only deletes the first occurrence of @end deffn delv1! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2239,6 +2498,7 @@ Like @code{delv!}, but only deletes the first occurrence of @end deffn delete1! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2247,6 +2507,7 @@ Like @code{delete!}, but only deletes the first occurrence of @end deffn primitive-load +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2259,6 +2520,7 @@ documentation for @code{%load-hook} later in this section. @end deffn %package-data-dir +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2267,6 +2529,7 @@ libraries are kept. On most Unix systems, this will be @end deffn %library-dir +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -2274,6 +2537,7 @@ E.g., may return "/usr/share/guile/1.3.5". @end deffn %site-dir +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -2281,6 +2545,7 @@ E.g., may return "/usr/share/guile/site". @end deffn parse-path +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2290,6 +2555,7 @@ is returned. @end deffn search-path +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2302,6 +2568,7 @@ concatenated with each @var{extension}. @end deffn %search-load-path +@c snarfed from /home/ghouston/guile/guile-core/libguile/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}, @@ -2314,6 +2581,7 @@ will try each extension automatically. @end deffn primitive-load-path +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2323,6 +2591,7 @@ an error is signalled. @end deffn procedure->syntax +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2332,6 +2601,7 @@ environment. @end deffn procedure->macro +@c snarfed from /home/ghouston/guile/guile-core/libguile/macros.c:125 @deffn {Scheme Procedure} procedure->macro code @deffnx {C Function} scm_makmacro (code) Return a @dfn{macro} which, when a symbol defined to this value @@ -2349,6 +2619,7 @@ environment. For example: @end deffn procedure->memoizing-macro +@c snarfed from /home/ghouston/guile/guile-core/libguile/macros.c:143 @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 @@ -2363,6 +2634,7 @@ form of the containing code. @end deffn macro? +@c snarfed from /home/ghouston/guile/guile-core/libguile/macros.c:155 @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 @@ -2370,6 +2642,7 @@ syntax transformer. @end deffn macro-type +@c snarfed from /home/ghouston/guile/guile-core/libguile/macros.c:173 @deffn {Scheme Procedure} macro-type m @deffnx {C Function} scm_macro_type (m) Return one of the symbols @code{syntax}, @code{macro} or @@ -2380,24 +2653,28 @@ returned. @end deffn macro-name +@c snarfed from /home/ghouston/guile/guile-core/libguile/macros.c:191 @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 /home/ghouston/guile/guile-core/libguile/macros.c:202 @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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -2405,6 +2682,7 @@ the previous current module. @end deffn interaction-environment +@c snarfed from /home/ghouston/guile/guile-core/libguile/modules.c:104 @deffn {Scheme Procedure} interaction-environment @deffnx {C Function} scm_interaction_environment () Return a specifier for the environment that contains @@ -2415,30 +2693,35 @@ evaluate expressions dynamically typed by the user. @end deffn env-module +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/numbers.c:106 @deffn {Scheme Procedure} exact? x @deffnx {C Function} scm_exact_p (x) Return @code{#t} if @var{x} is an exact number, @code{#f} @@ -2446,6 +2729,7 @@ otherwise. @end deffn odd? +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:123 @deffn {Scheme Procedure} odd? n @deffnx {C Function} scm_odd_p (n) Return @code{#t} if @var{n} is an odd number, @code{#f} @@ -2453,13 +2737,45 @@ otherwise. @end deffn even? +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:142 @deffn {Scheme Procedure} even? n @deffnx {C Function} scm_even_p (n) Return @code{#t} if @var{n} is an even number, @code{#f} otherwise. @end deffn + inf? +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:184 +@deffn {Scheme Procedure} inf? n +@deffnx {C Function} scm_inf_p (n) +Return @code{#t} if @var{n} is infinite, @code{#f} +otherwise. +@end deffn + + nan? +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:201 +@deffn {Scheme Procedure} nan? n +@deffnx {C Function} scm_nan_p (n) +Return @code{#t} if @var{n} is a NaN, @code{#f} +otherwise. +@end deffn + + inf +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:263 +@deffn {Scheme Procedure} inf +@deffnx {C Function} scm_inf () +Return Inf. +@end deffn + + nan +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:278 +@deffn {Scheme Procedure} nan +@deffnx {C Function} scm_nan () +Return NaN. +@end deffn + logand +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:891 @deffn {Scheme Procedure} logand n1 n2 Return the bitwise AND of the integer arguments. @@ -2471,6 +2787,7 @@ Return the bitwise AND of the integer arguments. @end deffn logior +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:972 @deffn {Scheme Procedure} logior n1 n2 Return the bitwise OR of the integer arguments. @@ -2482,6 +2799,7 @@ Return the bitwise OR of the integer arguments. @end deffn logxor +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:1054 @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. @@ -2494,6 +2812,7 @@ set in the result if it is set in an odd number of arguments. @end deffn logtest +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:1118 @deffn {Scheme Procedure} logtest j k @deffnx {C Function} scm_logtest (j, k) @lisp @@ -2505,6 +2824,7 @@ set in the result if it is set in an odd number of arguments. @end deffn logbit? +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:1175 @deffn {Scheme Procedure} logbit? index j @deffnx {C Function} scm_logbit_p (index, j) @lisp @@ -2519,6 +2839,7 @@ set in the result if it is set in an odd number of arguments. @end deffn lognot +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:1224 @deffn {Scheme Procedure} lognot n @deffnx {C Function} scm_lognot (n) Return the integer which is the 2s-complement of the integer @@ -2533,6 +2854,7 @@ argument. @end deffn integer-expt +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:1241 @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 @@ -2547,6 +2869,7 @@ Return @var{n} raised to the non-negative integer exponent @end deffn ash +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:1296 @deffn {Scheme Procedure} ash n cnt @deffnx {C Function} scm_ash (n, cnt) The function ash performs an arithmetic shift left by @var{cnt} @@ -2567,6 +2890,7 @@ Formally, the function returns an integer equivalent to @end deffn bit-extract +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:1349 @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) @@ -2582,6 +2906,7 @@ through @var{end} (exclusive) bits of @var{n}. The @end deffn logcount +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:1421 @deffn {Scheme Procedure} logcount n @deffnx {C Function} scm_logcount (n) Return the number of bits in integer @var{n}. If integer is @@ -2600,6 +2925,7 @@ representation are counted. If 0, 0 is returned. @end deffn integer-length +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:1472 @deffn {Scheme Procedure} integer-length n @deffnx {C Function} scm_integer_length (n) Return the number of bits necessary to represent @var{n}. @@ -2615,6 +2941,7 @@ Return the number of bits necessary to represent @var{n}. @end deffn number->string +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:2330 @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 @@ -2623,6 +2950,7 @@ inexact, a radix of 10 will be used. @end deffn string->number +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:2989 @deffn {Scheme Procedure} string->number string [radix] @deffnx {C Function} scm_string_to_number (string, radix) Return a number of the maximally precise representation @@ -2636,11 +2964,13 @@ syntactically valid notation for a number, then @end deffn number? +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:3058 @deffn {Scheme Procedure} number? implemented by the C function "scm_number_p" @end deffn complex? +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:3070 @deffn {Scheme Procedure} complex? x @deffnx {C Function} scm_number_p (x) Return @code{#t} if @var{x} is a complex number, @code{#f} @@ -2651,11 +2981,13 @@ rational or integer number. @end deffn real? +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:3078 @deffn {Scheme Procedure} real? implemented by the C function "scm_real_p" @end deffn rational? +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:3091 @deffn {Scheme Procedure} rational? x @deffnx {C Function} scm_real_p (x) Return @code{#t} if @var{x} is a rational number, @code{#f} @@ -2667,6 +2999,7 @@ precision. @end deffn integer? +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:3112 @deffn {Scheme Procedure} integer? x @deffnx {C Function} scm_integer_p (x) Return @code{#t} if @var{x} is an integer number, @code{#f} @@ -2674,6 +3007,7 @@ else. @end deffn inexact? +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:3137 @deffn {Scheme Procedure} inexact? x @deffnx {C Function} scm_inexact_p (x) Return @code{#t} if @var{x} is an inexact number, @code{#f} @@ -2681,6 +3015,7 @@ else. @end deffn $expt +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:4297 @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 @@ -2688,6 +3023,7 @@ procedure does not accept complex arguments. @end deffn $atan2 +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:4313 @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 @@ -2698,6 +3034,7 @@ procedure does not accept complex arguments. @end deffn make-rectangular +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:4326 @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 @@ -2705,42 +3042,49 @@ Return a complex number constructed of the given @var{real} and @end deffn make-polar +@c snarfed from /home/ghouston/guile/guile-core/libguile/numbers.c:4339 @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 /home/ghouston/guile/guile-core/libguile/numbers.c:4474 @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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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}. @@ -2748,6 +3092,7 @@ Set the object procedure of @var{obj} to @var{proc}. @end deffn make-class-object +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2755,6 +3100,7 @@ slot layout specified by @var{layout}. @end deffn make-subclass-object +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2762,24 +3108,28 @@ specified by @var{layout}. @end deffn object-properties +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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} @@ -2787,6 +3137,7 @@ to @var{value}. @end deffn cons +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2795,6 +3146,7 @@ sense of @code{eq?}) from every previously existing object. @end deffn pair? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2802,6 +3154,7 @@ Return @code{#t} if @var{x} is a pair; otherwise return @end deffn set-car! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2809,6 +3162,7 @@ by @code{set-car!} is unspecified. @end deffn set-cdr! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2816,6 +3170,7 @@ by @code{set-cdr!} is unspecified. @end deffn char-ready? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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} @@ -2834,6 +3189,7 @@ interactive port that has no ready characters.} @end deffn drain-input +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2853,6 +3209,7 @@ for further input. @end deffn current-input-port +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2861,6 +3218,7 @@ returns the @dfn{standard input} in Unix and C terminology. @end deffn current-output-port +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2870,6 +3228,7 @@ Unix and C terminology. @end deffn current-error-port +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2877,6 +3236,7 @@ Return the port to which errors and warnings should be sent (the @end deffn current-load-port +@c snarfed from /home/ghouston/guile/guile-core/libguile/ports.c:395 @deffn {Scheme Procedure} current-load-port @deffnx {C Function} scm_current_load_port () Return the current-load-port. @@ -2884,6 +3244,7 @@ The load port is used internally by @code{primitive-load}. @end deffn set-current-input-port +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2894,24 +3255,28 @@ so that they use the supplied @var{port} for input or output. @end deffn set-current-output-port +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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. @@ -2919,6 +3284,7 @@ The return value is unspecified. @end deffn port-mode +@c snarfed from /home/ghouston/guile/guile-core/libguile/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}. @@ -2928,6 +3294,7 @@ used only during port creation are not retained. @end deffn close-port +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2939,6 +3306,7 @@ descriptors. @end deffn close-input-port +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2950,6 +3318,7 @@ which can close file descriptors. @end deffn close-output-port +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2961,6 +3330,7 @@ which can close file descriptors. @end deffn port-for-each +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2972,6 +3342,7 @@ have no effect as far as @var{port-for-each} is concerned. @end deffn input-port? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2980,6 +3351,7 @@ Return @code{#t} if @var{x} is an input port, otherwise return @end deffn output-port? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -2988,6 +3360,7 @@ Return @code{#t} if @var{x} is an output port, otherwise return @end deffn port? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -2996,6 +3369,7 @@ Equivalent to @code{(or (input-port? @var{x}) (output-port? @end deffn port-closed? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3003,6 +3377,7 @@ open. @end deffn eof-object? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3010,6 +3385,7 @@ return @code{#f}. @end deffn force-output +@c snarfed from /home/ghouston/guile/guile-core/libguile/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} @@ -3022,6 +3398,7 @@ The return value is unspecified. @end deffn flush-all-ports +@c snarfed from /home/ghouston/guile/guile-core/libguile/ports.c:848 @deffn {Scheme Procedure} flush-all-ports @deffnx {C Function} scm_flush_all_ports () Equivalent to calling @code{force-output} on @@ -3029,6 +3406,7 @@ all open output ports. The return value is unspecified. @end deffn read-char +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3037,6 +3415,7 @@ characters are available, the end-of-file object is returned. @end deffn peek-char +@c snarfed from /home/ghouston/guile/guile-core/libguile/ports.c:1192 @deffn {Scheme Procedure} peek-char [port] @deffnx {C Function} scm_peek_char (port) Return the next character available from @var{port}, @@ -3054,6 +3433,7 @@ to @code{read-char} would have hung.} @end deffn unread-char +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3063,6 +3443,7 @@ not supplied, the current input port is used. @end deffn unread-string +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3072,6 +3453,7 @@ unread characters will be read again in last-in first-out order. If @end deffn seek +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3100,6 +3482,7 @@ that the current position of a port can be obtained using: @end deffn truncate-file +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3111,18 +3494,21 @@ position. The return value is unspecified. @end deffn port-line +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/ports.c:1415 @deffn {Scheme Procedure} port-column port @deffnx {Scheme Procedure} port-line port @deffnx {C Function} scm_port_column (port) @@ -3137,6 +3523,7 @@ what non-programmers will find most natural.) @end deffn set-port-column! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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) @@ -3145,6 +3532,7 @@ current input port if none is specified. @end deffn port-filename +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3153,6 +3541,7 @@ when called on the current input, output and error ports respectively. @end deffn set-port-filename! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3162,6 +3551,7 @@ source of data, but only the value that is returned by @end deffn %make-void-port +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3171,6 +3561,7 @@ documentation for @code{open-file} in @ref{File Ports}. @end deffn print-options-interface +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3180,6 +3571,7 @@ and @code{print-options}. @end deffn simple-format +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3196,6 +3588,7 @@ containing the formatted text. Does not add a trailing newline. @end deffn newline +@c snarfed from /home/ghouston/guile/guile-core/libguile/print.c:1009 @deffn {Scheme Procedure} newline [port] @deffnx {C Function} scm_newline (port) Send a newline to @var{port}. @@ -3203,12 +3596,14 @@ If @var{port} is omitted, send to the current output port. @end deffn write-char +@c snarfed from /home/ghouston/guile/guile-core/libguile/print.c:1024 @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 /home/ghouston/guile/guile-core/libguile/print.c:1078 @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 @@ -3216,6 +3611,7 @@ included print state @var{pstate}. @end deffn get-print-state +@c snarfed from /home/ghouston/guile/guile-core/libguile/print.c:1093 @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} @@ -3223,24 +3619,28 @@ has no associated print state, @code{#f} is returned. @end deffn procedure-properties +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -3248,24 +3648,28 @@ In @var{obj}'s property list, set the property named @var{key} to @end deffn procedure? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -3275,6 +3679,7 @@ documentation for that procedure. @end deffn procedure-with-setter? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3282,6 +3687,7 @@ associated setter procedure. @end deffn make-procedure-with-setter +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3289,6 +3695,7 @@ with the associated setter @var{setter}. @end deffn procedure +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3296,6 +3703,7 @@ procedure with setter, or an operator struct. @end deffn primitive-make-property +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3305,6 +3713,7 @@ See @code{primitive-property-ref} for the significance of @end deffn primitive-property-ref +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3317,18 +3726,21 @@ default value of @var{prop}. @end deffn primitive-property-set! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/random.c:376 @deffn {Scheme Procedure} random n [state] @deffnx {C Function} scm_random (n, state) Return a number in [0,N). @@ -3346,18 +3758,21 @@ as a side effect of the random operation. @end deffn copy-random-state +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -3365,6 +3780,7 @@ Return a uniformly distributed inexact real random number in @end deffn random:normal +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3374,6 +3790,7 @@ normal distribution with mean m and standard deviation d use @end deffn random:solid-sphere! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3385,6 +3802,7 @@ The sum of the squares of the numbers is returned. @end deffn random:hollow-sphere! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3396,6 +3814,7 @@ unit n-sphere. @end deffn random:normal-vector! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3404,6 +3823,7 @@ independent and standard normally distributed @end deffn random:exp +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3412,6 +3832,7 @@ Return an inexact real in an exponential distribution with mean @end deffn %read-delimited! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3432,6 +3853,7 @@ a delimiter, this value is @code{#f}. @end deffn %read-line +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3443,6 +3865,7 @@ delimiter may be either a newline or the @var{eof-object}; if @end deffn write-line +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3455,6 +3878,7 @@ used. This function is equivalent to: @end deffn read-options-interface +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3463,6 +3887,7 @@ this procedure directly, use the procedures @code{read-enable}, @end deffn read +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3471,6 +3896,7 @@ Any whitespace before the next token is discarded. @end deffn read-hash-extend +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3481,6 +3907,7 @@ returned will be the return value of @code{read}. @end deffn call-with-dynamic-root +@c snarfed from /home/ghouston/guile/guile-core/libguile/root.c:346 @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. @@ -3528,6 +3955,7 @@ be under a new dynamic root.) @end deffn dynamic-root +@c snarfed from /home/ghouston/guile/guile-core/libguile/root.c:359 @deffn {Scheme Procedure} dynamic-root @deffnx {C Function} scm_dynamic_root () Return an object representing the current dynamic root. @@ -3538,6 +3966,7 @@ in no way depend on this. @end deffn read-string!/partial +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3580,6 +4009,7 @@ end-of-file check. @end deffn write-string/partial +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3626,6 +4056,7 @@ return 0 immediately if the request size is 0 bytes. @end deffn sigaction +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -3657,6 +4088,7 @@ structures. @end deffn restore-signals +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3664,6 +4096,7 @@ Return all signal handlers to the values they had before any call to @end deffn alarm +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3678,6 +4111,7 @@ no previous alarm, the return value is zero. @end deffn setitimer +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3698,6 +4132,7 @@ the seconds and microseconds of the timer @code{it_value}. @end deffn getitimer +@c snarfed from /home/ghouston/guile/guile-core/libguile/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} @@ -3714,6 +4149,7 @@ the seconds and microseconds of the timer @code{it_value}. @end deffn pause +@c snarfed from /home/ghouston/guile/guile-core/libguile/scmsigs.c:482 @deffn {Scheme Procedure} pause @deffnx {C Function} scm_pause () Pause the current process (thread?) until a signal arrives whose @@ -3722,6 +4158,7 @@ handler procedure. The return value is unspecified. @end deffn sleep +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3730,6 +4167,7 @@ of seconds remaining otherwise. @end deffn usleep +@c snarfed from /home/ghouston/guile/guile-core/libguile/scmsigs.c:513 @deffn {Scheme Procedure} usleep i @deffnx {C Function} scm_usleep (i) Sleep for I microseconds. @code{usleep} is not available on @@ -3737,6 +4175,7 @@ all platforms. @end deffn raise +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3744,6 +4183,7 @@ Sends a specified signal @var{sig} to the current process, where @end deffn system +@c snarfed from /home/ghouston/guile/guile-core/libguile/simpos.c:76 @deffn {Scheme Procedure} system [cmd] @deffnx {C Function} scm_system (cmd) Execute @var{cmd} using the operating system's "command @@ -3757,6 +4197,7 @@ indicating whether the command processor is available. @end deffn getenv +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3765,6 +4206,7 @@ found, in which case the string @code{VALUE} is returned. @end deffn primitive-exit +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -3773,6 +4215,7 @@ is @var{status} if supplied, otherwise zero. @end deffn restricted-vector-sort! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3782,6 +4225,7 @@ is not specified. @end deffn sorted? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3790,6 +4234,7 @@ applied to all elements i - 1 and i @end deffn merge +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -3802,6 +4247,7 @@ Note: this does _not_ accept vectors. @end deffn merge! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3814,6 +4260,7 @@ Note: this does _not_ accept vectors. @end deffn sort! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3824,6 +4271,7 @@ This is not a stable sort. @end deffn sort +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3832,6 +4280,7 @@ elements. This is not a stable sort. @end deffn stable-sort! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3842,6 +4291,7 @@ This is a stable sort. @end deffn stable-sort +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3850,6 +4300,7 @@ This is a stable sort. @end deffn sort-list! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3859,6 +4310,7 @@ This is a stable sort. @end deffn sort-list +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -3866,12 +4318,14 @@ list elements. This is a stable sort. @end deffn source-properties +@c snarfed from /home/ghouston/guile/guile-core/libguile/srcprop.c:178 @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 /home/ghouston/guile/guile-core/libguile/srcprop.c:199 @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 @@ -3879,6 +4333,7 @@ list for @var{obj}. @end deffn source-property +@c snarfed from /home/ghouston/guile/guile-core/libguile/srcprop.c:217 @deffn {Scheme Procedure} source-property obj key @deffnx {C Function} scm_source_property (obj, key) Return the source property specified by @var{key} from @@ -3886,6 +4341,7 @@ Return the source property specified by @var{key} from @end deffn set-source-property! +@c snarfed from /home/ghouston/guile/guile-core/libguile/srcprop.c:248 @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 @@ -3893,12 +4349,14 @@ Set the source property of object @var{obj}, which is specified by @end deffn stack? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -3932,30 +4390,35 @@ taken as 0. @end deffn stack-id +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -3964,18 +4427,21 @@ debug object or a continuation. @end deffn frame-number +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -3983,12 +4449,14 @@ procedure is associated with @var{frame}. @end deffn frame-arguments +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -3996,6 +4464,7 @@ Return the previous frame of @var{frame}, or @code{#f} if @end deffn frame-next +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4003,30 +4472,35 @@ Return the next frame of @var{frame}, or @code{#f} if @end deffn frame-real? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -4034,6 +4508,7 @@ started. @end deffn times +@c snarfed from /home/ghouston/guile/guile-core/libguile/stime.c:188 @deffn {Scheme Procedure} times @deffnx {C Function} scm_times () Return an object with information about real and processor @@ -4060,6 +4535,7 @@ terminated child processes. @end deffn get-internal-run-time +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4068,6 +4544,7 @@ included but subprocesses are not. @end deffn current-time +@c snarfed from /home/ghouston/guile/guile-core/libguile/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, @@ -4075,6 +4552,7 @@ excluding leap seconds. @end deffn gettimeofday +@c snarfed from /home/ghouston/guile/guile-core/libguile/stime.c:248 @deffn {Scheme Procedure} gettimeofday @deffnx {C Function} scm_gettimeofday () Return a pair containing the number of seconds and microseconds @@ -4084,6 +4562,7 @@ operating system. @end deffn localtime +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4094,6 +4573,7 @@ optionally specified by @var{zone} (a string), otherwise the @end deffn gmtime +@c snarfed from /home/ghouston/guile/guile-core/libguile/stime.c:420 @deffn {Scheme Procedure} gmtime time @deffnx {C Function} scm_gmtime (time) Return an object representing the broken down components of @@ -4102,6 +4582,7 @@ Return an object representing the broken down components of @end deffn mktime +@c snarfed from /home/ghouston/guile/guile-core/libguile/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} @@ -4115,6 +4596,7 @@ as @var{bd-time} but with normalized values. @end deffn tzset +@c snarfed from /home/ghouston/guile/guile-core/libguile/stime.c:556 @deffn {Scheme Procedure} tzset @deffnx {C Function} scm_tzset () Initialize the timezone from the TZ environment variable @@ -4124,6 +4606,7 @@ timezone. @end deffn strftime +@c snarfed from /home/ghouston/guile/guile-core/libguile/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} @@ -4136,6 +4619,7 @@ is the formatted string. @end deffn strptime +@c snarfed from /home/ghouston/guile/guile-core/libguile/stime.c:670 @deffn {Scheme Procedure} strptime format string @deffnx {C Function} scm_strptime (format, string) Performs the reverse action to @code{strftime}, parsing @@ -4151,17 +4635,20 @@ which were used for the conversion. @end deffn string? +@c snarfed from /home/ghouston/guile/guile-core/libguile/strings.c:61 @deffn {Scheme Procedure} string? obj @deffnx {C Function} scm_string_p (obj) Return @code{#t} if @var{obj} is a string, else @code{#f}. @end deffn list->string +@c snarfed from /home/ghouston/guile/guile-core/libguile/strings.c:69 @deffn {Scheme Procedure} list->string implemented by the C function "scm_string" @end deffn string +@c snarfed from /home/ghouston/guile/guile-core/libguile/strings.c:75 @deffn {Scheme Procedure} string . chrs @deffnx {Scheme Procedure} list->string chrs @deffnx {C Function} scm_string (chrs) @@ -4170,6 +4657,7 @@ Return a newly allocated string composed of the arguments, @end deffn make-string +@c snarfed from /home/ghouston/guile/guile-core/libguile/strings.c:209 @deffn {Scheme Procedure} make-string k [chr] @deffnx {C Function} scm_make_string (k, chr) Return a newly allocated string of @@ -4179,12 +4667,14 @@ of the @var{string} are unspecified. @end deffn string-length +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -4192,6 +4682,7 @@ indexing. @var{k} must be a valid index of @var{str}. @end deffn string-set! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4200,6 +4691,7 @@ an unspecified value. @var{k} must be a valid index of @end deffn substring +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4212,6 +4704,7 @@ exact integers satisfying: @end deffn string-append +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4219,6 +4712,7 @@ concatenation of the given strings, @var{args}. @end deffn string-index +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4240,6 +4734,7 @@ procedure essentially implements the @code{index} or @end deffn string-rindex +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4260,6 +4755,7 @@ the C library. @end deffn substring-move! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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} @@ -4268,6 +4764,7 @@ into @var{str2} beginning at position @var{start2}. @end deffn substring-fill! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4282,6 +4779,7 @@ y @end deffn string-null? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4294,6 +4792,7 @@ y @result{} "foo" @end deffn string->list +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4303,12 +4802,14 @@ concerned. @end deffn string-copy +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -4316,6 +4817,7 @@ return an unspecified value. @end deffn string-upcase! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4328,6 +4830,7 @@ y @result{} "ARRDEFG" @end deffn string-upcase +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4335,6 +4838,7 @@ Return a freshly allocated string containing the characters of @end deffn string-downcase! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4347,6 +4851,7 @@ y @result{} "arrdefg" @end deffn string-downcase +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4354,6 +4859,7 @@ Return a freshly allocation string containing the characters in @end deffn string-capitalize! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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} @@ -4367,6 +4873,7 @@ y @result{} "Hello World" @end deffn string-capitalize +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4375,6 +4882,7 @@ capitalized. @end deffn string-split +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4398,6 +4906,7 @@ result list. @end deffn string-ci->symbol +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4406,6 +4915,7 @@ is currently reading symbols case-insensitively. @end deffn string=? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4418,6 +4928,7 @@ characters. @end deffn string-ci=? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4426,30 +4937,35 @@ return @code{#f}. @end deffn string? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -4471,6 +4989,7 @@ Case insensitive lexicographic ordering predicate; return @end deffn string-ci>=? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4478,6 +4997,7 @@ equal to @var{s2} regardless of case. @end deffn object->string +@c snarfed from /home/ghouston/guile/guile-core/libguile/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}. @@ -4486,6 +5006,7 @@ argument @var{printer} (default: @code{write}). @end deffn call-with-output-string +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4494,6 +5015,7 @@ written into the port is returned. @end deffn call-with-input-string +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4502,6 +5024,7 @@ read. The value yielded by the @var{proc} is returned. @end deffn open-input-string +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4511,6 +5034,7 @@ by the garbage collector if it becomes inaccessible. @end deffn open-output-string +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4521,6 +5045,7 @@ inaccessible. @end deffn get-output-string +@c snarfed from /home/ghouston/guile/guile-core/libguile/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}, @@ -4529,6 +5054,7 @@ output to the port so far. @end deffn eval-string +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4538,6 +5064,7 @@ procedure @code{interaction-environment}. @end deffn make-struct-layout +@c snarfed from /home/ghouston/guile/guile-core/libguile/struct.c:77 @deffn {Scheme Procedure} make-struct-layout fields @deffnx {C Function} scm_make_struct_layout (fields) Return a new structure layout object. @@ -4553,6 +5080,7 @@ indicate that the field is a tail-array. @end deffn struct? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4560,12 +5088,14 @@ Return @code{#t} iff @var{x} is a structure object, else @end deffn struct-vtable? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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. @@ -4596,6 +5126,7 @@ For more information, see the documentation for @code{make-vtable-vtable}. @end deffn make-vtable-vtable +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -4657,6 +5188,7 @@ ball @result{} # @end deffn struct-ref +@c snarfed from /home/ghouston/guile/guile-core/libguile/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) @@ -4669,6 +5201,7 @@ integer value small enough to fit in one machine word. @end deffn struct-set! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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} @@ -4677,30 +5210,35 @@ to. @end deffn struct-vtable +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -4708,6 +5246,7 @@ Return @code{#t} if @var{obj} is a symbol, otherwise return @end deffn symbol-interned? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4715,12 +5254,14 @@ Return @code{#t} if @var{symbol} is interned, otherwise return @end deffn make-symbol +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -4749,6 +5290,7 @@ standard case is lower case: @end deffn string->symbol +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4774,6 +5316,7 @@ standard case is lower case: @end deffn gensym +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4784,36 +5327,42 @@ resetting the counter. @end deffn symbol-hash +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -4837,6 +5386,7 @@ match this call to @code{catch}. @end deffn lazy-catch +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4846,6 +5396,7 @@ it must throw to another catch, or otherwise exit non-locally. @end deffn throw +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4858,6 +5409,7 @@ If there is no handler at all, Guile prints an error and then exits. @end deffn values +@c snarfed from /home/ghouston/guile/guile-core/libguile/values.c:77 @deffn {Scheme Procedure} values . args @deffnx {C Function} scm_values (args) Delivers all of its arguments to its continuation. Except for @@ -4868,18 +5420,21 @@ were not created by @code{call-with-values} is unspecified. @end deffn make-variable +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -4887,6 +5442,7 @@ return @code{#f}. @end deffn variable-ref +@c snarfed from /home/ghouston/guile/guile-core/libguile/variable.c:109 @deffn {Scheme Procedure} variable-ref var @deffnx {C Function} scm_variable_ref (var) Dereference @var{var} and return its value. @@ -4895,6 +5451,7 @@ and @code{make-undefined-variable}. @end deffn variable-set! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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}. @@ -4903,6 +5460,7 @@ value. Return an unspecified value. @end deffn variable-bound? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -4910,6 +5468,7 @@ Throws an error if @var{var} is not a variable object. @end deffn vector? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4917,11 +5476,13 @@ Return @code{#t} if @var{obj} is a vector, otherwise return @end deffn list->vector +@c snarfed from /home/ghouston/guile/guile-core/libguile/vectors.c:76 @deffn {Scheme Procedure} list->vector implemented by the C function "scm_vector" @end deffn vector +@c snarfed from /home/ghouston/guile/guile-core/libguile/vectors.c:93 @deffn {Scheme Procedure} vector . l @deffnx {Scheme Procedure} list->vector l @deffnx {C Function} scm_vector (l) @@ -4934,6 +5495,7 @@ given arguments. Analogous to @code{list}. @end deffn make-vector +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4943,6 +5505,7 @@ unspecified. @end deffn vector->list +@c snarfed from /home/ghouston/guile/guile-core/libguile/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}. @@ -4954,6 +5517,7 @@ Return a newly allocated list composed of the elements of @var{v}. @end deffn vector-fill! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -4961,6 +5525,7 @@ returned by @code{vector-fill!} is unspecified. @end deffn vector-move-left! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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}, @@ -4974,6 +5539,7 @@ same vector, @code{vector-move-left!} is usually appropriate when @end deffn vector-move-right! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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}, @@ -4987,6 +5553,7 @@ same vector, @code{vector-move-right!} is usually appropriate when @end deffn major-version +@c snarfed from /home/ghouston/guile/guile-core/libguile/version.c:59 @deffn {Scheme Procedure} major-version @deffnx {C Function} scm_major_version () Return a string containing Guile's major version number. @@ -4994,6 +5561,7 @@ E.g., the 1 in "1.6.5". @end deffn minor-version +@c snarfed from /home/ghouston/guile/guile-core/libguile/version.c:72 @deffn {Scheme Procedure} minor-version @deffnx {C Function} scm_minor_version () Return a string containing Guile's minor version number. @@ -5001,6 +5569,7 @@ E.g., the 6 in "1.6.5". @end deffn micro-version +@c snarfed from /home/ghouston/guile/guile-core/libguile/version.c:85 @deffn {Scheme Procedure} micro-version @deffnx {C Function} scm_micro_version () Return a string containing Guile's micro version number. @@ -5008,6 +5577,7 @@ E.g., the 5 in "1.6.5". @end deffn version +@c snarfed from /home/ghouston/guile/guile-core/libguile/version.c:107 @deffn {Scheme Procedure} version @deffnx {Scheme Procedure} major-version @deffnx {Scheme Procedure} minor-version @@ -5025,6 +5595,7 @@ or micro version number, respectively. @end deffn make-soft-port +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5071,6 +5642,7 @@ For example: @end deffn make-weak-vector +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5080,11 +5652,13 @@ empty list. @end deffn list->weak-vector +@c snarfed from /home/ghouston/guile/guile-core/libguile/weaks.c:124 @deffn {Scheme Procedure} list->weak-vector implemented by the C function "scm_weak_vector" @end deffn weak-vector +@c snarfed from /home/ghouston/guile/guile-core/libguile/weaks.c:132 @deffn {Scheme Procedure} weak-vector . l @deffnx {Scheme Procedure} list->weak-vector l @deffnx {C Function} scm_weak_vector (l) @@ -5095,6 +5669,7 @@ the same way @code{list->vector} would. @end deffn weak-vector? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5102,6 +5677,7 @@ weak hashes are also weak vectors. @end deffn make-weak-key-hash-table +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5115,6 +5691,7 @@ would modify regular hash tables. (@pxref{Hash Tables}) @end deffn make-weak-value-hash-table +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -5122,6 +5699,7 @@ Return a hash table with weak values with @var{size} buckets. @end deffn make-doubly-weak-hash-table +@c snarfed from /home/ghouston/guile/guile-core/libguile/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} @@ -5129,6 +5707,7 @@ buckets. (@pxref{Hash Tables}) @end deffn weak-key-hash-table? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5139,91 +5718,21 @@ nor a weak value hash table. @end deffn weak-value-hash-table? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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? -@deffn {Scheme Procedure} regexp? obj -@deffnx {C Function} scm_regexp_p (obj) -Return @code{#t} if @var{obj} is a compiled regular expression, -or @code{#f} otherwise. -@end deffn - - make-regexp -@deffn {Scheme Procedure} make-regexp pat . flags -@deffnx {C Function} scm_make_regexp (pat, flags) -Compile the regular expression described by @var{pat}, and -return the compiled regexp structure. If @var{pat} does not -describe a legal regular expression, @code{make-regexp} throws -a @code{regular-expression-syntax} error. - -The @var{flags} arguments change the behavior of the compiled -regular expression. The following flags may be supplied: - -@table @code -@item regexp/icase -Consider uppercase and lowercase letters to be the same when -matching. -@item regexp/newline -If a newline appears in the target string, then permit the -@samp{^} and @samp{$} operators to match immediately after or -immediately before the newline, respectively. Also, the -@samp{.} and @samp{[^...]} operators will never match a newline -character. The intent of this flag is to treat the target -string as a buffer containing many lines of text, and the -regular expression as a pattern that may match a single one of -those lines. -@item regexp/basic -Compile a basic (``obsolete'') regexp instead of the extended -(``modern'') regexps that are the default. Basic regexps do -not consider @samp{|}, @samp{+} or @samp{?} to be special -characters, and require the @samp{@{...@}} and @samp{(...)} -metacharacters to be backslash-escaped (@pxref{Backslash -Escapes}). There are several other differences between basic -and extended regular expressions, but these are the most -significant. -@item regexp/extended -Compile an extended regular expression rather than a basic -regexp. This is the default behavior; this flag will not -usually be needed. If a call to @code{make-regexp} includes -both @code{regexp/basic} and @code{regexp/extended} flags, the -one which comes last will override the earlier one. -@end table -@end deffn - - regexp-exec -@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 -@code{str}. If the optional integer @var{start} argument is -provided, begin matching from that position in the string. -Return a match structure describing the results of the match, -or @code{#f} if no match could be found. - -The @var{flags} arguments change the matching behavior. -The following flags may be supplied: - -@table @code -@item regexp/notbol -Operator @samp{^} always fails (unless @code{regexp/newline} -is used). Use this when the beginning of the string should -not be considered the beginning of a line. -@item regexp/noteol -Operator @samp{$} always fails (unless @code{regexp/newline} -is used). Use this when the end of the string should not be -considered the end of a line. -@end table -@end deffn - array-fill! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5231,11 +5740,13 @@ is unspecified. @end deffn array-copy-in-order! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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) @@ -5246,11 +5757,13 @@ dimension. The order is unspecified. @end deffn array-map-in-order! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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) @@ -5263,6 +5776,7 @@ unspecified. The order of application is unspecified. @end deffn array-for-each +@c snarfed from /home/ghouston/guile/guile-core/libguile/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{} @@ -5270,6 +5784,7 @@ in row-major order. The value returned is unspecified. @end deffn array-index-map! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5293,12 +5808,14 @@ Another example: @end deffn uniform-vector-length +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -5307,6 +5824,7 @@ and is described elsewhere. @end deffn array-rank +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5314,6 +5832,7 @@ not an array, @code{0} is returned. @end deffn array-dimensions +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5324,24 +5843,28 @@ elements with a @code{0} minimum with one greater than the maximum. So: @end deffn shared-array-root +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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) @@ -5352,6 +5875,7 @@ fill the array, otherwise @var{prototype} is used. @end deffn make-shared-array +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5372,6 +5896,7 @@ it can be otherwise arbitrary. A simple example: @end deffn transpose-array +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5396,6 +5921,7 @@ have smaller rank than @var{array}. @end deffn enclose-array +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5422,6 +5948,7 @@ examples: @end deffn array-in-bounds? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5429,11 +5956,13 @@ Return @code{#t} if its arguments would be acceptable to @end deffn array-ref +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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) @@ -5442,11 +5971,13 @@ Return the element at the @code{(index1, index2)} element in @end deffn uniform-array-set1! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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) @@ -5455,6 +5986,7 @@ Set the element at the @code{(index1, index2)} element in @var{array} to @end deffn array-contents +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5470,6 +6002,7 @@ memory. @end deffn uniform-array-read! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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) @@ -5490,6 +6023,7 @@ returned by @code{(current-input-port)}. @end deffn uniform-array-write +@c snarfed from /home/ghouston/guile/guile-core/libguile/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) @@ -5507,6 +6041,7 @@ omitted, in which case it defaults to the value returned by @end deffn bit-count +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5514,6 +6049,7 @@ Return the number of occurrences of the boolean @var{b} in @end deffn bit-position +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5522,6 +6058,7 @@ within the specified range @code{#f} is returned. @end deffn bit-set*! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5536,6 +6073,7 @@ of @var{bv} corresponding to the indexes in uve are set to @end deffn bit-count* +@c snarfed from /home/ghouston/guile/guile-core/libguile/unif.c:1941 @deffn {Scheme Procedure} bit-count* v kv obj @deffnx {C Function} scm_bit_count_star (v, kv, obj) Return @@ -5546,12 +6084,14 @@ Return @end deffn bit-invert! +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -5559,6 +6099,7 @@ Return a list consisting of all the elements, in order, of @end deffn list->uniform-array +@c snarfed from /home/ghouston/guile/guile-core/libguile/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) @@ -5569,6 +6110,7 @@ done. @end deffn array-prototype +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5577,6 +6119,7 @@ as @var{array}, if used as the @var{prototype} for @end deffn chown +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5594,6 +6137,7 @@ as @code{-1}, then that ID is not changed. @end deffn chmod +@c snarfed from /home/ghouston/guile/guile-core/libguile/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}. @@ -5606,6 +6150,7 @@ The return value is unspecified. @end deffn umask +@c snarfed from /home/ghouston/guile/guile-core/libguile/filesys.c:287 @deffn {Scheme Procedure} umask [mode] @deffnx {C Function} scm_umask (mode) If @var{mode} is omitted, returns a decimal number representing the current @@ -5616,6 +6161,7 @@ E.g., @code{(umask #o022)} sets the mask to octal 22, decimal 18. @end deffn open-fdes +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5623,6 +6169,7 @@ a port. @end deffn open +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -5655,6 +6202,7 @@ for additional flags. @end deffn close +@c snarfed from /home/ghouston/guile/guile-core/libguile/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}), @@ -5665,6 +6213,7 @@ their revealed counts set to zero. @end deffn close-fdes +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -5675,6 +6224,7 @@ The return value is unspecified. @end deffn stat +@c snarfed from /home/ghouston/guile/guile-core/libguile/filesys.c:621 @deffn {Scheme Procedure} stat object @deffnx {C Function} scm_stat (object) Return an object containing various information about the file @@ -5736,6 +6286,7 @@ An integer representing the access permission bits. @end deffn link +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5745,6 +6296,7 @@ system. @end deffn rename-file +@c snarfed from /home/ghouston/guile/guile-core/libguile/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}. @@ -5752,12 +6304,14 @@ The return value is unspecified. @end deffn delete-file +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -5767,6 +6321,7 @@ umask. Otherwise they are set to the decimal value specified with @end deffn rmdir +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5774,6 +6329,7 @@ be empty for this to succeed. The return value is unspecified. @end deffn directory-stream? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5781,6 +6337,7 @@ stream as returned by @code{opendir}. @end deffn opendir +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5788,6 +6345,7 @@ stream. @end deffn readdir +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5796,6 +6354,7 @@ end of file object is returned. @end deffn rewinddir +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5803,6 +6362,7 @@ Reset the directory port @var{stream} so that the next call to @end deffn closedir +@c snarfed from /home/ghouston/guile/guile-core/libguile/filesys.c:871 @deffn {Scheme Procedure} closedir port @deffnx {C Function} scm_closedir (port) Close the directory stream @var{stream}. @@ -5810,6 +6370,7 @@ The return value is unspecified. @end deffn chdir +@c snarfed from /home/ghouston/guile/guile-core/libguile/filesys.c:921 @deffn {Scheme Procedure} chdir str @deffnx {C Function} scm_chdir (str) Change the current working directory to @var{path}. @@ -5817,12 +6378,14 @@ The return value is unspecified. @end deffn getcwd +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 @@ -5857,6 +6420,7 @@ An additional @code{select!} interface is provided. @end deffn fcntl +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5887,6 +6451,7 @@ The value used to indicate the "close on exec" flag with @code{F_GETFL} or @end deffn fsync +@c snarfed from /home/ghouston/guile/guile-core/libguile/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. @@ -5896,6 +6461,7 @@ The return value is unspecified. @end deffn symlink +@c snarfed from /home/ghouston/guile/guile-core/libguile/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) @@ -5903,6 +6469,7 @@ Create a symbolic link named @var{path-to} with the value (i.e., pointing to) @end deffn readlink +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5910,6 +6477,7 @@ string), i.e., the file that the link points to. @end deffn lstat +@c snarfed from /home/ghouston/guile/guile-core/libguile/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., @@ -5918,6 +6486,7 @@ file it points to. @var{path} must be a string. @end deffn copy-file +@c snarfed from /home/ghouston/guile/guile-core/libguile/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}. @@ -5925,6 +6494,7 @@ The return value is unspecified. @end deffn dirname +@c snarfed from /home/ghouston/guile/guile-core/libguile/filesys.c:1460 @deffn {Scheme Procedure} dirname filename @deffnx {C Function} scm_dirname (filename) Return the directory name component of the file name @@ -5933,6 +6503,7 @@ component, @code{.} is returned. @end deffn basename +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 @@ -5942,6 +6513,7 @@ If @var{suffix} is provided, and is equal to the end of @end deffn pipe +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:202 @deffn {Scheme Procedure} pipe @deffnx {C Function} scm_pipe () Return a newly created pipe: a pair of ports which are linked @@ -5960,6 +6532,7 @@ from the input port. @end deffn getgroups +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:223 @deffn {Scheme Procedure} getgroups @deffnx {C Function} scm_getgroups () Return a vector of integers representing the current @@ -5967,6 +6540,7 @@ supplementary group IDs. @end deffn getpw +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:254 @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, @@ -5975,6 +6549,7 @@ or getpwent respectively. @end deffn setpw +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:307 @deffn {Scheme Procedure} setpw [arg] @deffnx {C Function} scm_setpwent (arg) If called with a true argument, initialize or reset the password data @@ -5983,6 +6558,7 @@ stream. Otherwise, close the stream. The @code{setpwent} and @end deffn getgr +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:326 @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, @@ -5991,6 +6567,7 @@ or getgrent respectively. @end deffn setgr +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:366 @deffn {Scheme Procedure} setgr [arg] @deffnx {C Function} scm_setgrent (arg) If called with a true argument, initialize or reset the group data @@ -5999,6 +6576,7 @@ stream. Otherwise, close the stream. The @code{setgrent} and @end deffn kill +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:402 @deffn {Scheme Procedure} kill pid sig @deffnx {C Function} scm_kill (pid, sig) Sends a signal to the specified process or group of processes. @@ -6031,6 +6609,7 @@ Interrupt signal. @end deffn waitpid +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:455 @deffn {Scheme Procedure} waitpid pid [options] @deffnx {C Function} scm_waitpid (pid, options) This procedure collects status information from a child process which @@ -6077,6 +6656,7 @@ The integer status value. @end deffn status:exit-val +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:483 @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 @@ -6085,6 +6665,7 @@ if any, otherwise @code{#f}. @end deffn status:term-sig +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:503 @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, @@ -6092,6 +6673,7 @@ otherwise @code{#f}. @end deffn status:stop-sig +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:521 @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, @@ -6099,6 +6681,7 @@ otherwise @code{#f}. @end deffn getppid +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:541 @deffn {Scheme Procedure} getppid @deffnx {C Function} scm_getppid () Return an integer representing the process ID of the parent @@ -6106,18 +6689,21 @@ process. @end deffn getuid +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:553 @deffn {Scheme Procedure} getuid @deffnx {C Function} scm_getuid () Return an integer representing the current real user ID. @end deffn getgid +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:564 @deffn {Scheme Procedure} getgid @deffnx {C Function} scm_getgid () Return an integer representing the current real group ID. @end deffn geteuid +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:578 @deffn {Scheme Procedure} geteuid @deffnx {C Function} scm_geteuid () Return an integer representing the current effective user ID. @@ -6127,6 +6713,7 @@ system supports effective IDs. @end deffn getegid +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:595 @deffn {Scheme Procedure} getegid @deffnx {C Function} scm_getegid () Return an integer representing the current effective group ID. @@ -6136,6 +6723,7 @@ system supports effective IDs. @end deffn setuid +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:611 @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 @@ -6144,6 +6732,7 @@ The return value is unspecified. @end deffn setgid +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:625 @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 @@ -6152,6 +6741,7 @@ The return value is unspecified. @end deffn seteuid +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:641 @deffn {Scheme Procedure} seteuid id @deffnx {C Function} scm_seteuid (id) Sets the effective user ID to the integer @var{id}, provided the process @@ -6162,6 +6752,7 @@ The return value is unspecified. @end deffn setegid +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:667 @deffn {Scheme Procedure} setegid id @deffnx {C Function} scm_setegid (id) Sets the effective group ID to the integer @var{id}, provided the process @@ -6172,6 +6763,7 @@ The return value is unspecified. @end deffn getpgrp +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:691 @deffn {Scheme Procedure} getpgrp @deffnx {C Function} scm_getpgrp () Return an integer representing the current process group ID. @@ -6179,6 +6771,7 @@ This is the POSIX definition, not BSD. @end deffn setpgid +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:709 @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 @@ -6189,6 +6782,7 @@ The return value is unspecified. @end deffn setsid +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:728 @deffn {Scheme Procedure} setsid @deffnx {C Function} scm_setsid () Creates a new session. The current process becomes the session leader @@ -6198,6 +6792,7 @@ The return value is an integer representing the new process group ID. @end deffn ttyname +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:743 @deffn {Scheme Procedure} ttyname port @deffnx {C Function} scm_ttyname (port) Return a string with the name of the serial terminal device @@ -6205,6 +6800,7 @@ underlying @var{port}. @end deffn ctermid +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:767 @deffn {Scheme Procedure} ctermid @deffnx {C Function} scm_ctermid () Return a string containing the file name of the controlling @@ -6212,6 +6808,7 @@ terminal for the current process. @end deffn tcgetpgrp +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:790 @deffn {Scheme Procedure} tcgetpgrp port @deffnx {C Function} scm_tcgetpgrp (port) Return the process group ID of the foreground process group @@ -6227,6 +6824,7 @@ foreground. @end deffn tcsetpgrp +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:814 @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 @@ -6237,6 +6835,7 @@ controlling terminal. The return value is unspecified. @end deffn execl +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:869 @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. @@ -6253,6 +6852,7 @@ call, but we call it @code{execl} because of its Scheme calling interface. @end deffn execlp +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:889 @deffn {Scheme Procedure} execlp filename . args @deffnx {C Function} scm_execlp (filename, args) Similar to @code{execl}, however if @@ -6265,6 +6865,7 @@ call, but we call it @code{execlp} because of its Scheme calling interface. @end deffn execle +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:939 @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 @@ -6276,6 +6877,7 @@ call, but we call it @code{execle} because of its Scheme calling interface. @end deffn primitive-fork +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:963 @deffn {Scheme Procedure} primitive-fork @deffnx {C Function} scm_fork () Creates a new "child" process by duplicating the current "parent" process. @@ -6287,6 +6889,7 @@ with the scsh fork. @end deffn uname +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:983 @deffn {Scheme Procedure} uname @deffnx {C Function} scm_uname () Return an object with some information about the computer @@ -6294,6 +6897,7 @@ system the program is running on. @end deffn environ +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1013 @deffn {Scheme Procedure} environ [env] @deffnx {C Function} scm_environ (env) If @var{env} is omitted, return the current environment (in the @@ -6306,6 +6910,7 @@ then the return value is unspecified. @end deffn tmpnam +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1051 @deffn {Scheme Procedure} tmpnam @deffnx {C Function} scm_tmpnam () Return a name in the file system that does not match any @@ -6316,6 +6921,7 @@ Care should be taken if opening the file, e.g., use the @end deffn mkstemp! +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1077 @deffn {Scheme Procedure} mkstemp! tmpl @deffnx {C Function} scm_mkstemp (tmpl) Create a new unique file in the file system and returns a new @@ -6326,6 +6932,7 @@ place to return the name of the temporary file. @end deffn utime +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1102 @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 @@ -6341,6 +6948,7 @@ modification time to the current time. @end deffn access? +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1150 @deffn {Scheme Procedure} access? path how @deffnx {C Function} scm_access (path, how) Return @code{#t} if @var{path} corresponds to an existing file @@ -6369,12 +6977,14 @@ test for existence of the file. @end deffn getpid +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1164 @deffn {Scheme Procedure} getpid @deffnx {C Function} scm_getpid () Return an integer representing the current process ID. @end deffn putenv +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1181 @deffn {Scheme Procedure} putenv str @deffnx {C Function} scm_putenv (str) Modifies the environment of the current process, which is @@ -6391,6 +7001,7 @@ The return value is unspecified. @end deffn setlocale +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1223 @deffn {Scheme Procedure} setlocale category [locale] @deffnx {C Function} scm_setlocale (category, locale) If @var{locale} is omitted, return the current value of the @@ -6405,6 +7016,7 @@ the locale will be set using environment variables. @end deffn mknod +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1263 @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. @@ -6425,6 +7037,7 @@ The return value is unspecified. @end deffn nice +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1309 @deffn {Scheme Procedure} nice incr @deffnx {C Function} scm_nice (incr) Increment the priority of the current process by @var{incr}. A higher @@ -6433,6 +7046,7 @@ The return value is unspecified. @end deffn sync +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1324 @deffn {Scheme Procedure} sync @deffnx {C Function} scm_sync () Flush the operating system disk buffers. @@ -6440,6 +7054,7 @@ The return value is unspecified. @end deffn crypt +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1337 @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 @@ -6447,6 +7062,7 @@ crypt(3) library call. @end deffn chroot +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1358 @deffn {Scheme Procedure} chroot path @deffnx {C Function} scm_chroot (path) Change the root directory to that specified in @var{path}. @@ -6457,6 +7073,7 @@ root directory. @end deffn getlogin +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1390 @deffn {Scheme Procedure} getlogin @deffnx {C Function} scm_getlogin () Return a string containing the name of the user logged in on @@ -6465,6 +7082,7 @@ information cannot be obtained. @end deffn cuserid +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1408 @deffn {Scheme Procedure} cuserid @deffnx {C Function} scm_cuserid () Return a string containing a user name associated with the @@ -6473,6 +7091,7 @@ information cannot be obtained. @end deffn getpriority +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1433 @deffn {Scheme Procedure} getpriority which who @deffnx {C Function} scm_getpriority (which, who) Return the scheduling priority of the process, process group @@ -6488,6 +7107,7 @@ specified processes. @end deffn setpriority +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1467 @deffn {Scheme Procedure} setpriority which who prio @deffnx {C Function} scm_setpriority (which, who, prio) Set the scheduling priority of the process, process group @@ -6506,6 +7126,7 @@ The return value is not specified. @end deffn getpass +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1492 @deffn {Scheme Procedure} getpass prompt @deffnx {C Function} scm_getpass (prompt) Display @var{prompt} to the standard error output and read @@ -6518,6 +7139,7 @@ characters is disabled. @end deffn flock +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1596 @deffn {Scheme Procedure} flock file operation @deffnx {C Function} scm_flock (file, operation) Apply or remove an advisory lock on an open file. @@ -6540,6 +7162,7 @@ file descriptor or an open file descriptor port. @end deffn sethostname +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1622 @deffn {Scheme Procedure} sethostname name @deffnx {C Function} scm_sethostname (name) Set the host name of the current processor to @var{name}. May @@ -6548,12 +7171,14 @@ specified. @end deffn gethostname +@c snarfed from /home/ghouston/guile/guile-core/libguile/posix.c:1637 @deffn {Scheme Procedure} gethostname @deffnx {C Function} scm_gethostname () Return the host name of the current processor. @end deffn gethost +@c snarfed from /home/ghouston/guile/guile-core/libguile/net_db.c:154 @deffn {Scheme Procedure} gethost [host] @deffnx {Scheme Procedure} gethostbyname hostname @deffnx {Scheme Procedure} gethostbyaddr address @@ -6570,6 +7195,7 @@ Unusual conditions may result in errors thrown to the @end deffn getnet +@c snarfed from /home/ghouston/guile/guile-core/libguile/net_db.c:233 @deffn {Scheme Procedure} getnet [net] @deffnx {Scheme Procedure} getnetbyname net-name @deffnx {Scheme Procedure} getnetbyaddr net-number @@ -6582,6 +7208,7 @@ given. @end deffn getproto +@c snarfed from /home/ghouston/guile/guile-core/libguile/net_db.c:282 @deffn {Scheme Procedure} getproto [protocol] @deffnx {Scheme Procedure} getprotobyname name @deffnx {Scheme Procedure} getprotobynumber number @@ -6593,6 +7220,7 @@ argument. @code{getproto} will accept either type, behaving like @end deffn getserv +@c snarfed from /home/ghouston/guile/guile-core/libguile/net_db.c:348 @deffn {Scheme Procedure} getserv [name [protocol]] @deffnx {Scheme Procedure} getservbyname name protocol @deffnx {Scheme Procedure} getservbyport port protocol @@ -6608,6 +7236,7 @@ as its first argument; if given no arguments, it behaves like @end deffn sethost +@c snarfed from /home/ghouston/guile/guile-core/libguile/net_db.c:385 @deffn {Scheme Procedure} sethost [stayopen] @deffnx {C Function} scm_sethost (stayopen) If @var{stayopen} is omitted, this is equivalent to @code{endhostent}. @@ -6615,6 +7244,7 @@ Otherwise it is equivalent to @code{sethostent stayopen}. @end deffn setnet +@c snarfed from /home/ghouston/guile/guile-core/libguile/net_db.c:401 @deffn {Scheme Procedure} setnet [stayopen] @deffnx {C Function} scm_setnet (stayopen) If @var{stayopen} is omitted, this is equivalent to @code{endnetent}. @@ -6622,6 +7252,7 @@ Otherwise it is equivalent to @code{setnetent stayopen}. @end deffn setproto +@c snarfed from /home/ghouston/guile/guile-core/libguile/net_db.c:417 @deffn {Scheme Procedure} setproto [stayopen] @deffnx {C Function} scm_setproto (stayopen) If @var{stayopen} is omitted, this is equivalent to @code{endprotoent}. @@ -6629,6 +7260,7 @@ Otherwise it is equivalent to @code{setprotoent stayopen}. @end deffn setserv +@c snarfed from /home/ghouston/guile/guile-core/libguile/net_db.c:433 @deffn {Scheme Procedure} setserv [stayopen] @deffnx {C Function} scm_setserv (stayopen) If @var{stayopen} is omitted, this is equivalent to @code{endservent}. @@ -6636,6 +7268,7 @@ Otherwise it is equivalent to @code{setservent stayopen}. @end deffn htons +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:109 @deffn {Scheme Procedure} htons value @deffnx {C Function} scm_htons (value) Convert a 16 bit quantity from host to network byte ordering. @@ -6644,6 +7277,7 @@ and returned as a new integer. @end deffn ntohs +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:126 @deffn {Scheme Procedure} ntohs value @deffnx {C Function} scm_ntohs (value) Convert a 16 bit quantity from network to host byte ordering. @@ -6652,6 +7286,7 @@ and returned as a new integer. @end deffn htonl +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:143 @deffn {Scheme Procedure} htonl value @deffnx {C Function} scm_htonl (value) Convert a 32 bit quantity from host to network byte ordering. @@ -6660,6 +7295,7 @@ and returned as a new integer. @end deffn ntohl +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:156 @deffn {Scheme Procedure} ntohl value @deffnx {C Function} scm_ntohl (value) Convert a 32 bit quantity from network to host byte ordering. @@ -6668,6 +7304,7 @@ and returned as a new integer. @end deffn inet-aton +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:176 @deffn {Scheme Procedure} inet-aton address @deffnx {C Function} scm_inet_aton (address) Convert an IPv4 Internet address from printable string @@ -6679,6 +7316,7 @@ Convert an IPv4 Internet address from printable string @end deffn inet-ntoa +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:195 @deffn {Scheme Procedure} inet-ntoa inetid @deffnx {C Function} scm_inet_ntoa (inetid) Convert an IPv4 Internet address to a printable @@ -6690,6 +7328,7 @@ Convert an IPv4 Internet address to a printable @end deffn inet-netof +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:215 @deffn {Scheme Procedure} inet-netof address @deffnx {C Function} scm_inet_netof (address) Return the network number part of the given IPv4 @@ -6701,6 +7340,7 @@ Internet address. E.g., @end deffn inet-lnaof +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:233 @deffn {Scheme Procedure} inet-lnaof address @deffnx {C Function} scm_lnaof (address) Return the local-address-with-network part of the given @@ -6713,6 +7353,7 @@ E.g., @end deffn inet-makeaddr +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:251 @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 @@ -6725,6 +7366,7 @@ Make an IPv4 Internet address by combining the network number @end deffn inet-pton +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:369 @deffn {Scheme Procedure} inet-pton family address @deffnx {C Function} scm_inet_pton (family, address) Convert a string containing a printable network address to @@ -6740,6 +7382,7 @@ the result is an integer with normal host byte ordering. @end deffn inet-ntop +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:404 @deffn {Scheme Procedure} inet-ntop family address @deffnx {C Function} scm_inet_ntop (family, address) Convert a network address into a printable string. @@ -6755,6 +7398,7 @@ ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff @end deffn socket +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:449 @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}, @@ -6773,6 +7417,7 @@ has been connected to another socket. @end deffn socketpair +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:471 @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 @@ -6783,6 +7428,7 @@ family. Zero is likely to be the only meaningful value for @end deffn getsockopt +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:500 @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 @@ -6797,6 +7443,7 @@ returns a pair of integers. @end deffn setsockopt +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:568 @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 @@ -6813,6 +7460,7 @@ The return value is unspecified. @end deffn shutdown +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:672 @deffn {Scheme Procedure} shutdown sock how @deffnx {C Function} scm_shutdown (sock, how) Sockets can be closed simply by using @code{close-port}. The @@ -6835,6 +7483,7 @@ The return value is unspecified. @end deffn connect +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:816 @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 @@ -6861,6 +7510,7 @@ The return value is unspecified. @end deffn bind +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:876 @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}. @@ -6909,6 +7559,7 @@ The return value is unspecified. @end deffn listen +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:910 @deffn {Scheme Procedure} listen sock backlog @deffnx {C Function} scm_listen (sock, backlog) Enable @var{sock} to accept connection @@ -6922,6 +7573,7 @@ The return value is unspecified. @end deffn accept +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:1015 @deffn {Scheme Procedure} accept sock @deffnx {C Function} scm_accept (sock) Accept a connection on a bound, listening socket. @@ -6941,6 +7593,7 @@ connection and will continue to accept new requests. @end deffn getsockname +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:1042 @deffn {Scheme Procedure} getsockname sock @deffnx {C Function} scm_getsockname (sock) Return the address of @var{sock}, in the same form as the @@ -6949,6 +7602,7 @@ of a socket in the @code{AF_FILE} namespace cannot be read. @end deffn getpeername +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:1064 @deffn {Scheme Procedure} getpeername sock @deffnx {C Function} scm_getpeername (sock) Return the address that @var{sock} @@ -6958,6 +7612,7 @@ is connected to, in the same form as the object returned by @end deffn recv! +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:1099 @deffn {Scheme Procedure} recv! sock buf [flags] @deffnx {C Function} scm_recv (sock, buf, flags) Receive data from a socket port. @@ -6983,6 +7638,7 @@ any unread buffered port data is ignored. @end deffn send +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:1132 @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}. @@ -7001,6 +7657,7 @@ any unflushed buffered port data is ignored. @end deffn recvfrom! +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:1172 @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 @@ -7029,6 +7686,7 @@ descriptor: any unread buffered port data is ignored. @end deffn sendto +@c snarfed from /home/ghouston/guile/guile-core/libguile/socket.c:1230 @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 @@ -7051,52 +7709,138 @@ file descriptor: any unflushed buffered port data is ignored. @end deffn + regexp? +@c snarfed from /home/ghouston/guile/guile-core/libguile/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, +or @code{#f} otherwise. +@end deffn + + make-regexp +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 +return the compiled regexp structure. If @var{pat} does not +describe a legal regular expression, @code{make-regexp} throws +a @code{regular-expression-syntax} error. + +The @var{flags} arguments change the behavior of the compiled +regular expression. The following flags may be supplied: + +@table @code +@item regexp/icase +Consider uppercase and lowercase letters to be the same when +matching. +@item regexp/newline +If a newline appears in the target string, then permit the +@samp{^} and @samp{$} operators to match immediately after or +immediately before the newline, respectively. Also, the +@samp{.} and @samp{[^...]} operators will never match a newline +character. The intent of this flag is to treat the target +string as a buffer containing many lines of text, and the +regular expression as a pattern that may match a single one of +those lines. +@item regexp/basic +Compile a basic (``obsolete'') regexp instead of the extended +(``modern'') regexps that are the default. Basic regexps do +not consider @samp{|}, @samp{+} or @samp{?} to be special +characters, and require the @samp{@{...@}} and @samp{(...)} +metacharacters to be backslash-escaped (@pxref{Backslash +Escapes}). There are several other differences between basic +and extended regular expressions, but these are the most +significant. +@item regexp/extended +Compile an extended regular expression rather than a basic +regexp. This is the default behavior; this flag will not +usually be needed. If a call to @code{make-regexp} includes +both @code{regexp/basic} and @code{regexp/extended} flags, the +one which comes last will override the earlier one. +@end table +@end deffn + + regexp-exec +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 +@code{str}. If the optional integer @var{start} argument is +provided, begin matching from that position in the string. +Return a match structure describing the results of the match, +or @code{#f} if no match could be found. + +The @var{flags} arguments change the matching behavior. +The following flags may be supplied: + +@table @code +@item regexp/notbol +Operator @samp{^} always fails (unless @code{regexp/newline} +is used). Use this when the beginning of the string should +not be considered the beginning of a line. +@item regexp/noteol +Operator @samp{$} always fails (unless @code{regexp/newline} +is used). Use this when the end of the string should not be +considered the end of a line. +@end table +@end deffn + single-active-thread? +@c snarfed from /home/ghouston/guile/guile-core/libguile/threads.c:79 @deffn {Scheme Procedure} single-active-thread? implemented by the C function "scm_single_thread_p" @end deffn yield +@c snarfed from /home/ghouston/guile/guile-core/libguile/threads.c:85 @deffn {Scheme Procedure} yield implemented by the C function "scm_yield" @end deffn call-with-new-thread +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/threads.c:104 @deffn {Scheme Procedure} join-thread implemented by the C function "scm_join_thread" @end deffn make-mutex +@c snarfed from /home/ghouston/guile/guile-core/libguile/threads.c:109 @deffn {Scheme Procedure} make-mutex implemented by the C function "scm_make_mutex" @end deffn lock-mutex +@c snarfed from /home/ghouston/guile/guile-core/libguile/threads.c:112 @deffn {Scheme Procedure} lock-mutex implemented by the C function "scm_lock_mutex" @end deffn unlock-mutex +@c snarfed from /home/ghouston/guile/guile-core/libguile/threads.c:117 @deffn {Scheme Procedure} unlock-mutex implemented by the C function "scm_unlock_mutex" @end deffn make-condition-variable +@c snarfed from /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 /home/ghouston/guile/guile-core/libguile/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 c1c39a46e..01d698795 100644 --- a/doc/ref/ChangeLog +++ b/doc/ref/ChangeLog @@ -1,3 +1,9 @@ +2002-07-10 Gary Houston + + * scheme-modules.texi (Compiled Code Modules): Removed description + of scm_register_module_xxx, which no longer exists. A description + of current techniques is needed. + 2002-05-09 Marius Vollmer * scheme-data.texi (Numbers): Added description of the new values diff --git a/doc/ref/scheme-modules.texi b/doc/ref/scheme-modules.texi index 032330973..9e3ddf894 100644 --- a/doc/ref/scheme-modules.texi +++ b/doc/ref/scheme-modules.texi @@ -76,8 +76,7 @@ module system. In 1996 Tom Lord implemented a full-featured module system for Guile which allows loading Scheme source files into a private name space. This system has -been in available since Guile version 1.4. -@c fixme: Actually, was it available before? 1.4 seems a bit late... +been in available since at least Guile version 1.1. For Guile version 1.5.0 and later, the system has been improved to have better integration from C code, more fine-grained user control over interfaces, and @@ -500,44 +499,46 @@ When using the low level procedures to do your dynamic linking, you have complete control over which library is loaded when and what gets done with it. -@deffn {Scheme Procedure} dynamic-link library -@deffnx {C Function} scm_dynamic_link (library) -Find the shared library denoted by @var{library} (a string) and link it -into the running Guile application. When everything works out, return a -Scheme object suitable for representing the linked object file. -Otherwise an error is thrown. How object files are searched is system -dependent. +@deffn {Scheme Procedure} dynamic-link filename +@deffnx {C Function} scm_dynamic_link (filename) +Find the shared object (shared library) denoted by +@var{filename} and link it into the running Guile +application. The returned +scheme object is a ``handle'' for the library which can +be passed to @code{dynamic-func}, @code{dynamic-call} etc. -Normally, @var{library} is just the name of some shared library file -that will be searched for in the places where shared libraries usually -reside, such as in @file{/usr/lib} and @file{/usr/local/lib}. +Searching for object files is system dependent. Normally, +if @var{filename} does have an explicit directory it will +be searched for in locations +such as @file{/usr/lib} and @file{/usr/local/lib}. @end deffn @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} -otherwise. +Return @code{#t} if @var{obj} is a dynamic object handle, +or @code{#f} otherwise. @end deffn @deffn {Scheme Procedure} dynamic-unlink dobj @deffnx {C Function} scm_dynamic_unlink (dobj) -Unlink the indicated object file from the application. The -argument @var{dobj} must have been obtained by a call to -@code{dynamic-link}. After @code{dynamic-unlink} has been -called on @var{dobj}, its content is no longer accessible. +Unlink a dynamic object from the application, if possible. The +object must have been linked by @code{dynamic-link}, with +@var{dobj} the corresponding handle. After this procedure +is called, the handle can no longer be used to access the +object. @end deffn @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 -indicated by the string @var{name} and return some Scheme -handle that can later be used with @code{dynamic-call} to -actually call the function. +Return a ``handle'' for the function @var{name} in the +shared object referred to by @var{dobj}. The handle +can be passed to @code{dynamic-call} to actually +call the function. -Regardless whether your C compiler prepends an underscore @samp{_} to -the global names in a program, you should @strong{not} include this -underscore in @var{function}. Guile knows whether the underscore is -needed or not and will add it when necessary. +Regardless whether your C compiler prepends an underscore +@samp{_} to the global names in a program, you should +@strong{not} include this underscore in @var{name} +since it will be added automatically when necessary. @end deffn @deffn {Scheme Procedure} dynamic-call func dobj @@ -583,7 +584,7 @@ converted to a Scheme number and returned from the call to When dynamic linking is disabled or not supported on your system, the above functions throw errors, but they are still available. -Here is a small example that works on GNU/Linux: +Here is a small example that may work on GNU/Linux: @smallexample (define libc-obj (dynamic-link "libc.so")) @@ -657,43 +658,6 @@ this current module. Therefore, all we need to do is to make sure that the right module is current when calling @code{gh_new_procedure} for our new primitives. -Unfortunately, there is not yet an easy way to access the module system -from C, so we are better off with a more indirect approach. Instead of -adding our primitives at initialization time we merely register with -Guile that we are ready to provide the contents of a certain module, -should it ever be needed. - -@deftypefun void scm_register_module_xxx (char *@var{name}, void (*@var{initfunc})(void)) -Register with Guile that @var{initfunc} will provide the contents of the -module @var{name}. - -The function @var{initfunc} should perform the usual initialization -actions for your new primitives, like calling @code{gh_new_procedure} or -including the file produced by the snarfer. When @var{initfunc} is -called, the current module is a newly created module with a name as -indicated by @var{name}. Each definition that is added to it will be -automatically exported. - -The string @var{name} indicates the hierarchical name of the new module. -It should consist of the individual components of the module name -separated by single spaces. That is, the Scheme module name @code{(foo -bar)}, which is a list, should be written as @code{"foo bar"} for the -@var{name} parameter. - -You can call @code{scm_register_module_xxx} at any time, even before -Guile has been initialized. This might be useful when you want to put -the call to it in some initialization code that is magically called -before main, like constructors for global C++ objects. - -An example for @code{scm_register_module_xxx} appears in the next section. -@end deftypefun - -Now, instead of calling the initialization function at program startup, -you should simply call @code{scm_register_module_xxx} and pass it the -initialization function. When the named module is later requested by -Scheme code with @code{use-modules} for example, Guile will notice that -it knows how to create this module and will call the initialization -function at the right time in the right context. @node Dynamic Linking and Compiled Code Modules @subsection Dynamic Linking and Compiled Code Modules @@ -774,49 +738,32 @@ Fun, isn't it? But we are only half way there. This is what As you can see, @code{j0} is contained in the root module, where all the other Guile primitives like @code{display}, etc live. In general, a primitive is put into whatever module is the @dfn{current module} at -the time @code{gh_new_procedure} is called. To put @code{j0} into its -own module named @samp{(math bessel)}, we need to make a call to -@code{scm_register_module_xxx}. Additionally, to have Guile perform -the dynamic linking automatically, we need to put @file{libbessel.so} -into a place where Guile can find it. The call to -@code{scm_register_module_xxx} should be contained in a specially -named @dfn{module init function}. Guile knows about this special name -and will call that function automatically after having linked in the -shared library. For our example, we add the following code to -@file{bessel.c}: +the time @code{gh_new_procedure} is called. + +A compiled module should have a specially named @dfn{module init +function}. Guile knows about this special name and will call that +function automatically after having linked in the shared library. For +our example, we add the following code to @file{bessel.c}: @smallexample void scm_init_math_bessel_module () @{ - scm_register_module_xxx ("math bessel", init_math_bessel); + /* contents currently unavailable. */ @} @end smallexample The general pattern for the name of a module init function is: @samp{scm_init_}, followed by the name of the module where the individual hierarchical components are concatenated with underscores, -followed by @samp{_module}. It should call -@code{scm_register_module_xxx} with the correct module name and the -appropriate initialization function. When that initialization function -will be called, a newly created module with the right name will be the -@emph{current module} so that all definitions that the initialization -functions makes will end up in the correct module. +followed by @samp{_module}. After @file{libbessel.so} has been rebuild, we need to place the shared -library into the right place. When Guile tries to autoload the -@samp{(math bessel)} module, it looks not only for a file called -@file{math/bessel.scm} in its @code{%load-path}, but also for -@file{math/libbessel.so}. So all we need to do is to create a directory -called @file{math} somewhere in Guile's @code{%load-path} and place -@file{libbessel.so} there. Normally, the current directory @file{.} is -in the @code{%load-path}, so we just use that for this example. +library into the right place. + +Once the module has been correctly installed, it should be possible to +use it like this: @smallexample -% mkdir maths -% cd maths -% ln -s ../libbessel.so . -% cd .. -% guile guile> (use-modules (math bessel)) guile> (j0 2) 0.223890779141236 @@ -826,18 +773,6 @@ guile> (apropos 'j0) That's it! -Note that we used a symlink to make @file{libbessel.so} appear in the -right spot. This is probably not a bad idea in general. The -directories that the @file{%load-path} normally contains are supposed to -contain only architecture independent files. They are not really the -right place for a shared library. You might want to install the -libraries somewhere below @samp{exec_prefix} and then symlink to them -from the architecture independent directory. This will at least work on -heterogenous systems where the architecture dependent stuff resides in -the same place on all machines (which seems like a good idea to me -anyway). - - @node Variables @section Variables @tpindex Variables