▼Unstable
On this page:
wrap-expr/ c
Version: 5.1
  top← prev  up  next → 

41 Contracts for macro subexpressions

Ryan Culpepper <ryanc@racket-lang.org>

This library provides a procedure wrap-expr/c for applying contracts to macro subexpressions.

 (require unstable/wrapc)

This library is unstable; compatibility will not be maintained. See Unstable for more information.

(wrap-expr/c contract-expr    
  expr    
  [#:positive pos-blame    
  #:negative neg-blame    
  #:name expr-name    
  #:macro macro-name    
  #:context context]) → syntax?
  contract-expr : syntax?
  expr : syntax?
  pos-blame : 
(or/c syntax? string? module-path-index?
      'from-macro 'use-site 'unknown)
   = 'use-site
  neg-blame : 
(or/c syntax? string? module-path-index?
      'from-macro 'use-site 'unknown)
   = 'from-macro
  expr-name : (or/c identifier? symbol? string? #f) = #f
  macro-name : (or/c identifier? symbol? string? #f) = #f
  context : (or/c syntax? #f) = (current-syntax-context)
Returns a syntax object representing an expression that applies the contract represented by contract-expr to the value produced by expr.

The contract’s positive blame represents the obligations of the expression being wrapped. The negative blame represents the obligations of the macro imposing the contract—the ultimate caller of wrap-expr/c. By default, the positive blame is taken as the module currently being expanded, and the negative blame is inferred from the definition site of the macro (itself inferred from the context argument). But both blame locations can be overridden.

Positive and negative blame locations are determined from pos-blame and neg-blame, respectively, as follows:

  • If the argument is a string, it is used directly as the blame label.

  • If the argument is syntax, its source location is used to produce the blame label.

  • If the argument is a module path index, its resolved module path is used.

  • If the argument is 'from-macro, the macro is inferred from either the macro-name argument (if macro-name is an identifier) or the context argument, and the module where it is defined is used as the negative blame location. If neither an identifier macro-name nor a context argument is given, the location is "unknown".

  • If the argument is 'same-as-use-site, the module being expanded is used.

  • If the argument is 'unknown, the blame label is "unknown".

The macro-name argument is used to determine the macro’s binding, if it is an identifier. If expr-name is given, macro-name is also included in the contract error message. If macro-name is omitted or #f, but context is a syntax object, then macro-name is determined from context.

If expr-name is not #f, it is used in the contract’s error message to describe the expression the contract is applied to.

The context argument is used, when necessary, to infer the macro name for the negative blame party and the contract error message. The context should be either an identifier or a syntax pair with an identifer in operator position; in either case, that identifier is taken as the macro ultimately requesting the contract wrapping.

Examples:

  > (define-syntax (myparameterize1 stx)
      (syntax-case stx ()
        [(_ ((p v)) body)
         (with-syntax ([cp (wrap-expr/c
                            #'parameter? #'p
                            #:name "the parameter argument"
                            #:context stx)])
           #'(parameterize ((cp v)) body))]))
  > (myparameterize1 ((current-input-port
                       (open-input-string "(1 2 3)")))
      (read))

  '(1 2 3)

  > (myparameterize1 (('whoops 'something))
      'whatever)

  self-contract violation: expected <parameter?>, given:

  'whoops

    contract on

      the parameter argument of myparameterize1

   from top-level, blaming top-level

    contract: parameter?

          at: eval:4.0

  > (module mod racket
      (require (for-syntax unstable/wrapc))
      (define-syntax (app stx)
        (syntax-case stx ()
          [(app f arg)
           (with-syntax ([cf (wrap-expr/c
                              #'(-> number? number?)
                              #'f
                              #:name "the function argument"
                              #:context stx)])
             #'(cf arg))]))
      (provide app))
  > (require 'mod)
  > (app add1 5)

  6

  > (app add1 'apple)

  contract violation: expected <number?>, given: 'apple

    contract on the function argument of app from top-level

  via top-level, blaming (quote mod)

    contract: (-> number? number?)

          at: eval:8.0

  > (app (lambda (x) 'pear) 5)

  self-contract violation: expected <number?>, given: 'pear

    contract on the function argument of app from top-level,

  blaming top-level

    contract: (-> number? number?)

          at: eval:9.0

  top← prev  up  next →