12.1 Pattern-Based Syntax Matching

A syntax object matches a pattern as follows:

_

A _ pattern (i.e., an identifier with the same binding as _ and not among the literal-ids) matches any syntax object.

id

An id matches any syntax object when it is not bound to ... or _ and does not have the same binding as any literal-id. The id is further bound as pattern variable for the corresponding fender-expr (if any) and result-expr. A pattern-variable binding is a transformer binding; the pattern variable can be referenced only through forms like syntax. The binding’s value is the syntax object that matched the pattern with a depth marker of 0.

With a stat-pattern, ... is not treated specially. It either matches a literal-id or is bound as a pattern variable.

An id that has the same binding as a literal-id matches a syntax object that is an identifier with the same binding in the sense of free-identifier=?. The match does not introduce any pattern variables.

(pattern ...)

A (pattern ...) pattern matches a syntax object whose datum form (i.e., without lexical information) is a list with as many elements as sub-patterns in the pattern, and where each syntax object that corresponds to an element of the list matches the corresponding sub-pattern.

Any pattern variables bound by the sub-patterns are bound by the complete pattern; the bindings must all be distinct.

(pattern ...+ . np-pattern)

Like the previous kind of pattern, but matches syntax objects that are not necessarily lists; for n sub-patterns before the final np-pattern, the syntax object’s datum must be a pair such that n-1 cdrs produce pairs. The final np-pattern is matched against the syntax object corresponding to the nth cdr (or the datum->syntax coercion of the datum using the nearest enclosing syntax object’s lexical context and source location).

(pattern ... pattern ellipsis pattern ...)

Like the (pattern ...) kind of pattern, but matching a syntax object with any number (zero or more) elements that match the sub-pattern followed by ellipsis in the corresponding position relative to other sub-patterns.

For each pattern variable bound by the sub-pattern followed by ellipsis, the larger pattern binds the same pattern variable to a list of values, one for each element of the syntax object matched to the sub-pattern, with an incremented depth marker. (The sub-pattern itself may contain ellipsis, leading to a pattern variables bound to lists of lists of syntax objects with a depth marker of 2, and so on.)

All patterns forms with ellipsis apply only when ellipsis is not among the literal-ids.

(pattern ... pattern ellipsis pattern ... . np-pattern)

Like the previous kind of pattern, but with a final np-pattern as for (pattern ...+ . np-pattern). The final np-pattern never matches a syntax object whose datum is a pair.

#(pattern ...)

Like a (pattern ...) pattern, but matching a vector syntax object whose elements match the corresponding sub-patterns.

#(pattern ... pattern ellipsis pattern ...)

Like a (pattern ... pattern ellipsis pattern ...) pattern, but matching a vector syntax object whose elements match the corresponding sub-patterns.

#&pattern

Matches a box syntax object whose content matches the pattern.

#s(key-datum pattern ...)

Like a (pattern ...) pattern, but matching a prefab structure syntax object whose fields match the corresponding sub-patterns. The key-datum must correspond to a valid first argument to make-prefab-struct.

#s(key-datum pattern ... pattern ellipsis pattern ...)

Like a (pattern ... pattern ellipsis pattern ...) pattern, but matching a prefab structure syntax object whose elements match the corresponding sub-patterns.

(ellipsis stat-pattern)

Matches the same as stat-pattern, which is like a pattern, but identifiers with the binding ... are treated the same as other ids.

const

A const is any datum that does not match one of the preceding forms; a syntax object matches a const pattern when its datum is equal? to the quoted const.

If stx-expr produces a non-syntax object, then its result is converted to a syntax object using datum->syntax and the lexical context and source location of the stx-expr.

If stx-expr produces a syntax object that is tainted, then any syntax object bound by a pattern are tainted.

In other words, syntax-case is like syntax-case* with an id-compare-expr that produces free-identifier=?.

If any pattern fails to match the corresponding stx-expr, the exn:fail:syntax exception is raised.

A with-syntax form is roughly equivalent to the following syntax-case form:

(syntax-case (list stx-expr ...) ()

[(pattern ...) (let () body ...+)])

However, if any individual stx-expr produces a non-syntax object, then it is converted to one using datum->syntax and the lexical context and source location of the individual stx-expr.

A template produces a single syntax object. A head-template produces a sequence of zero or more syntax objects. A stat-template is like a template, except that ..., ~?, and ~@ are interpreted as constants instead of template forms.

A template produces a syntax object as follows:

id

If id is bound as a pattern variable, then id as a template produces the pattern variable’s match result. Unless the id is a sub-template that is replicated by ellipsis in a larger template, the pattern variable’s value must be a syntax object with a depth marker of 0 (as opposed to a list of matches).

More generally, if the pattern variable’s value has a depth marker n, then it can only appear within a template where it is replicated by at least n ellipsises. In that case, the template will be replicated enough times to use each match result at least once.

If id is not bound as a pattern variable, then id as a template produces (quote-syntax id).

(head-template ...)

Produces a syntax object whose datum is a list, and where the elements of the list correspond to syntax objects produced by the head-templates.

(head-template ... . template)

Like the previous form, but the result is not necessarily a list; instead, the place of the empty list in the resulting syntax object’s datum is taken by the syntax object produced by template.

#(head-template ...)

Like the (head-template ...) form, but producing a syntax object whose datum is a vector instead of a list.

#&template

Produces a syntax object whose datum is a box holding the syntax object produced by template.

#s(key-datum head-template ...)

Like the (head-template ...) form, but producing a syntax object whose datum is a prefab structure instead of a list. The key-datum must correspond to a valid first argument of make-prefab-struct.

(~? template1 template2)

Produces the result of template1 if template1 has no pattern variables with “missing values”; otherwise, produces the result of template2.

A pattern variable bound by syntax-case never has a missing value, but pattern variables bound by syntax-parse (for example, ~or or ~optional patterns) can.

Examples:

> (syntax-parse #'(m 1 2 3)     [(_ (~optional (~seq #:op op:expr)) arg:expr ...)      #'((~? op +) arg ...)])

#<syntax:eval:3:0 (+ 1 2 3)>

> (syntax-parse #'(m #:op max 1 2 3)     [(_ (~optional (~seq #:op op:expr)) arg:expr ...)      #'((~? op +) arg ...)])

#<syntax:eval:4:0 (max 1 2 3)>

(ellipsis stat-template)

Produces the same result as stat-template, which is like a template, but ..., ~?, and ~@ are treated like an id (with no pattern binding).

const

A const template is any form that does not match the preceding cases, and it produces the result (quote-syntax const).

A head-template produces a sequence of syntax objects; that sequence is “inlined” into the result of the enclosing template. The result of a head-template is defined as follows:

template

Produces one syntax object, according to the rules for template above.

head-template ellipsis ...+

Generates a sequence of syntax objects by “mapping” the head-template over the values of its pattern variables. The number of iterations depends on the values of the pattern variables referenced within the sub-template.

To be more precise: Let outer be inner followed by one ellipsis. A pattern variable is an iteration pattern variable for outer if occurs at a depth equal to its depth marker. There must be at least one; otherwise, an error is raised. If there are multiple iteration variables, then all of their values must be lists of the same length. The result for outer is produced by mapping the inner template over the iteration pattern variable values and decreasing their effective depth markers by 1 within inner. The outer result is formed by appending the inner results.

Consequently, if a pattern variable occurs at a depth greater than its depth marker, it is used as an iteration pattern variable for the innermost ellipses but not the outermost. A pattern variable must not occur at a depth less than its depth marker; otherwise, an error is raised.

syntax (~@ . template)

Produces the sequence of elements in the syntax list produced by template. If template does not produce a proper syntax list, an exception is raised.

Examples:

> (with-syntax ([(key ...) #'('a 'b 'c)]                 [(val ...) #'(1 2 3)])     #'(hash (~@ key val) ...))

#<syntax:eval:2:0 (hash (quote a) 1 (quote b) 2 (quote c) 3)>

> (with-syntax ([xs #'(2 3 4)])     #'(list 1 (~@ . xs) 5))

#<syntax:eval:3:0 (list 1 2 3 4 5)>

syntax (~? head-template1 head-template2)

Produces the result of head-template1 if none of its pattern variables have “missing values”; otherwise produces the result of head-template2.

(~? head-template)

Produces the result of head-template if none of its pattern variables have “missing values”; otherwise produces nothing.

Equivalent to (~? head-template (~@)).

A (syntax template) form is normally abbreviated as #'template; see also Reading Quotes. If template contains no pattern variables, then #'template is equivalent to (quote-syntax template).

Changed in version 6.90.0.25 of package base: Added ~@ and ~?.

The expr must produce a syntax object (or syntax list) to be substituted in place of the unsyntax or unsyntax-splicing form within the quasiquoting template, just like unquote and unquote-splicing within quasiquote, except that a hash table value position is not an escape position for quasisyntax. (If the escaped expression does not generate a syntax object, it is converted to one in the same way as for the right-hand side of with-syntax.) Nested quasisyntaxes introduce quasiquoting layers in the same way as nested quasiquotes.

Also analogous to quasiquote, the reader converts #` to quasisyntax, #, to unsyntax, and #,@ to unsyntax-splicing. See also Reading Quotes.

Only the source location of the immediate result—the “outermost” syntax object—is adjusted. The source location is not adjusted if both the source and position of loc-expr are #f. The source location is adjusted only if the resulting syntax object comes from the template itself rather than the value of a syntax pattern variable. For example, if x is a syntax pattern variable, then (syntax/loc loc-expr x) does not use the location of loc-expr.

Changed in version 6.90.0.25 of package base: Previously, syntax/loc did not enforce the contract on loc-expr if template was just a pattern variable.
Changed in version 8.2.0.6: Allows loc-expr to be any source location value that datum->syntax accepts.

Changed in version 8.2.0.6 of package base: Allows loc-expr to be any source location value that datum->syntax accepts.

(lambda (stx)

(syntax-case stx (literal-id ...)

[(generated-id . pattern) (syntax-protect #'template)]  ...))

where each generated-id binds no identifier in the corresponding template.

(make-set!-transformer

(lambda (stx)

(syntax-case stx (literal-id ...)

[pattern (syntax-protect #'template)]  ...)))

(define-syntax id

(syntax-rules ()

[(id . pattern) template]))

but with syntax errors potentially phrased in terms of pattern.

Added in version 6.90.0.25 of package base.

The syntax-pattern-variable? procedure is provided for-syntax by racket/base.