suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add examples for syntax/stx

Browse Source
This commit is contained in:
Asumu Takikawa 2013-05-07 11:46:40 -04:00
parent 1c9fe6a83a
commit d16d5f14f3
1 changed files with 56 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
collects/syntax/scribblings/stx.scrbl
View File

@ -1,6 +1,10 @@
#lang scribble/doc
@(require "common.rkt" (for-label syntax/stx))
@(require scribble/eval)
@(define stx-eval (make-base-eval))
@(stx-eval '(require syntax/stx))
@title[#:tag "stx"]{Deconstructing Syntax Objects}
@defmodule[syntax/stx]
@ -10,38 +14,80 @@
Returns @racket[#t] if @racket[v] is either the empty list or a
@tech[#:doc refman]{syntax object} representing the empty list (i.e.,
@racket[syntax-e] on the @tech[#:doc refman]{syntax object} returns
the empty list).}
the empty list).
@examples[#:eval stx-eval
(stx-null? null)
(stx-null? #'())
(stx-null? #'(a))
]}
@defproc[(stx-pair? [v any/c]) boolean?]{
Returns @racket[#t] if @racket[v] is either a pair or a syntax object
representing a pair (see @techlink[#:doc refman]{syntax pair}).}
representing a pair (see @techlink[#:doc refman]{syntax pair}).
@examples[#:eval stx-eval
(stx-pair? (cons #'a #'b))
(stx-pair? #'(a . b))
(stx-pair? #'())
(stx-pair? #'a)
]}
@defproc[(stx-list? [v any/c]) boolean?]{
Returns @racket[#t] if @racket[v] is a list, or if it is a sequence of
pairs leading to a syntax object such that @racket[syntax->list] would
produce a list.}
produce a list.
@examples[#:eval stx-eval
(stx-list? #'(a b c d))
(stx-list? #'((a b) (c d)))
(stx-list? #'(a b (c d)))
(stx-list? (list #'a #'b))
(stx-list? #'a)
]}
@defproc[(stx->list [stx-list stx-list?]) (or/c list? #f)]{
Produces a list by flatting out a trailing syntax object using
@racket[syntax->list].}
@racket[syntax->list].
@examples[#:eval stx-eval
(stx->list #'(a b c d))
(stx->list #'((a b) (c d)))
(stx->list #'(a b (c d)))
(stx->list (list #'a #'b))
(stx->list #'a)
]}
@defproc[(stx-car [v stx-pair?]) any]{
Takes the car of a @techlink[#:doc refman]{syntax pair}.}
Takes the car of a @techlink[#:doc refman]{syntax pair}.
@examples[#:eval stx-eval
(stx-car #'(a b))
(stx-car (list #'a #'b))
]}
@defproc[(stx-cdr [v stx-pair?]) any]{
Takes the cdr of a @techlink[#:doc refman]{syntax pair}.}
Takes the cdr of a @techlink[#:doc refman]{syntax pair}.
@examples[#:eval stx-eval
(stx-cdr #'(a b))
(stx-cdr (list #'a #'b))
]}
@defproc[(stx-map [proc procedure?]
[stxl stx-list?] ...)
list?]{
Equivalent to @racket[(map proc (stx->list stxl) ...)].
}
@examples[#:eval stx-eval
(stx-map (λ (id) (free-identifier=? id #'a)) #'(a b c d))
]}
@defproc[(module-or-top-identifier=? [a-id identifier?]
[b-id identifier?])
@ -59,3 +105,6 @@ example, the @racket[include] macro uses this procedure to recognize
well outside of @racket[module], since the top-level
@racket[build-path] is a distinct variable from the @racketmodname[racket/base] export
(though it's bound to the same procedure, initially).}
@close-eval[stx-eval]