From: Arun Isaac <arunisaac@systemreboot.net>
To: 30144@debbugs.gnu.org
Subject: bug#30144: [PATCH 1/1] doc: Document (ice-9 match) macros.
Date: Fri, 23 Mar 2018 19:52:04 +0530 [thread overview]
Message-ID: <20180323142204.23420-2-arunisaac@systemreboot.net> (raw)
In-Reply-To: <20180323142204.23420-1-arunisaac@systemreboot.net>
* doc/ref/match.texi: Document match-lambda, match-lambda*, match-let,
match-let* and match-letrec.
---
doc/ref/match.texi | 92 ++++++++++++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 90 insertions(+), 2 deletions(-)
diff --git a/doc/ref/match.texi b/doc/ref/match.texi
index 12e3814ae..0fc5105d1 100644
--- a/doc/ref/match.texi
+++ b/doc/ref/match.texi
@@ -213,8 +213,96 @@ any @var{person} whose second slot is a promise that evaluates to a
one-element list containing a @var{person} whose first slot is
@code{"Bob"}.
-Please refer to the @code{ice-9/match.upstream.scm} file in your Guile
-installation for more details.
+The @code{(ice-9 match)} module also provides the following convenient
+syntactic sugar macros wrapping around @code{match}.
+
+@deffn {Scheme Syntax} match-lambda exp clause1 clause2 @dots{}
+Create a procedure of one argument that matches its argument against
+each clause, and returns the result of evaluating the corresponding
+expressions.
+
+@example
+(match-lambda clause1 clause2 @dots{})
+@equiv{}
+(lambda (arg) (match arg clause1 clause2 @dots{}))
+@end example
+@end deffn
+
+@example
+((match-lambda
+ (('hello (who))
+ who))
+ '(hello (world)))
+@result{} world
+@end example
+
+@deffn {Scheme Syntax} match-lambda* exp clause1 clause2 @dots{}
+Create a procedure of any number of arguments that matches its argument
+list against each clause, and returns the result of evaluating the
+corresponding expressions.
+
+@example
+(match-lambda* clause1 clause2 @dots{})
+@equiv{}
+(lambda args (match args clause1 clause2 @dots{}))
+@end example
+@end deffn
+
+@example
+((match-lambda*
+ (('hello (who))
+ who))
+ 'hello '(world))
+@result{} world
+@end example
+
+@deffn {Scheme Syntax} match-let ((pattern expression) @dots{}) body
+Match each pattern to the corresponding expression, and evaluate the
+body with all matched variables in scope. Raise an error if any of the
+expressions fail to match. @code{match-let} is analogous to named let
+and can also be used for recursive functions which match on their
+arguments as in @code{match-lambda*}.
+
+@example
+(match-let (((x y) (list 1 2))
+ ((a b) (list 3 4)))
+ (list a b x y))
+@result{}
+(3 4 1 2)
+@end example
+@end deffn
+
+@deffn {Scheme Syntax} match-let variable ((pattern init) @dots{}) body
+Similar to @code{match-let}, but analogously to @dfn{named let}, locally
+bind VARIABLE to a new procedure which accepts as many arguments as
+there are INIT expressions. The procedure is initially applied to the
+results of evaluating the INIT expressions. When called, the procedure
+matches each argument against the corresponding PATTERN, and returns the
+result(s) of evaluating the BODY expressions. @xref{while do,
+Iteration}, for more on @dfn{named let}.
+@end deffn
+
+@deffn {Scheme Syntax} match-let* ((variable expression) @dots{}) body
+Similar to @code{match-let}, but analogously to @code{let*}, match and
+bind the variables in sequence, with preceding match variables in scope.
+
+@example
+(match-let* (((x y) (list 1 2))
+ ((a b) (list x 4)))
+ (list a b x y))
+@equiv{}
+(match-let (((x y) (list 1 2)))
+ (match-let (((a b) (list x 4)))
+ (list a b x y)))
+@result{}
+(1 4 1 2)
+@end example
+@end deffn
+
+@deffn {Scheme Syntax} match-letrec ((variable expression) @dots{}) body
+Similar to @code{match-let}, but analogously to @code{letrec}, match and
+bind the variables with all match variables in scope.
+@end deffn
Guile also comes with a pattern matcher specifically tailored to SXML
trees, @xref{sxml-match}.
--
2.15.1
next prev parent reply other threads:[~2018-03-23 14:22 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-01-17 12:25 bug#30144: [PATCH] doc: Document (ice-9 match) macros Arun Isaac
2018-01-21 16:16 ` Mark H Weaver
2018-01-21 18:14 ` Arun Isaac
2018-02-21 22:22 ` Ludovic Courtès
2018-03-16 4:05 ` Mark H Weaver
2018-03-16 4:33 ` Mark H Weaver
2018-03-16 23:27 ` Arun Isaac
2018-03-20 0:32 ` Mark H Weaver
2018-03-23 14:22 ` bug#30144: [PATCH 0/1] " Arun Isaac
2018-03-23 14:22 ` Arun Isaac [this message]
2018-06-18 12:08 ` bug#30144: [PATCH 1/1] doc: " Ludovic Courtès
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/guile/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180323142204.23420-2-arunisaac@systemreboot.net \
--to=arunisaac@systemreboot.net \
--cc=30144@debbugs.gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).