summaryrefslogtreecommitdiff
path: root/doc/ref
diff options
context:
space:
mode:
authorMark H Weaver <mhw@netris.org>2014-01-24 00:21:17 -0500
committerMark H Weaver <mhw@netris.org>2014-01-24 10:50:51 -0500
commit3e2e49650c7360f7bba03219943334e2eabd3d91 (patch)
treee7cc769fee42100bba24a741e37e0df03a0ff1de /doc/ref
parent60617d819d77a1b92ed6c557a0b49b8e9a8e97b9 (diff)
downloadguile-3e2e49650c7360f7bba03219943334e2eabd3d91.tar.gz
Implement SRFI-111 Boxes.
* module/srfi/srfi-111.scm: New file. * module/Makefile.am (SRFI_SOURCES): Add srfi/srfi-111.scm. * test-suite/tests/srfi-111.test: New file. * test-suite/Makefile.am (SCM_TESTS): Add tests/srfi-111.test. * doc/ref/srfi-modules.texi (SRFI-111): New node.
Diffstat (limited to 'doc/ref')
-rw-r--r--doc/ref/srfi-modules.texi25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/ref/srfi-modules.texi b/doc/ref/srfi-modules.texi
index 66d5bd1d9..8845c85b3 100644
--- a/doc/ref/srfi-modules.texi
+++ b/doc/ref/srfi-modules.texi
@@ -59,6 +59,7 @@ get the relevant SRFI documents from the SRFI home page
* SRFI-88:: Keyword objects.
* SRFI-98:: Accessing environment variables.
* SRFI-105:: Curly-infix expressions.
+* SRFI-111:: Boxes.
@end menu
@@ -5181,6 +5182,30 @@ directive @code{#!curly-infix-and-bracket-lists}. For example:
For more information on reader options, @xref{Scheme Read}.
+@node SRFI-111
+@subsection SRFI-111 Boxes.
+@cindex SRFI-111
+
+@uref{http://srfi.schemers.org/srfi-111/srfi-111.html, SRFI-111}
+provides boxes: objects with a single mutable cell.
+
+@deffn {Scheme Procedure} box value
+Return a newly allocated box whose contents is initialized to
+@var{value}.
+@end deffn
+
+@deffn {Scheme Procedure} box? obj
+Return true if @var{obj} is a box, otherwise return false.
+@end deffn
+
+@deffn {Scheme Procedure} unbox box
+Return the current contents of @var{box}.
+@end deffn
+
+@deffn {Scheme Procedure} set-box! box value
+Set the contents of @var{box} to @var{value}.
+@end deffn
+
@c srfi-modules.texi ends here
@c Local Variables: