From 2aa3dbade171a5c2a4c7708d9185cc4741623450 Mon Sep 17 00:00:00 2001 From: Matthew Butterick Date: Mon, 4 May 2020 11:45:33 -0700 Subject: [PATCH] move br/macro to separate package --- beautiful-racket-lib/br/define.rkt | 231 +---------------- beautiful-racket-lib/info.rkt | 1 + beautiful-racket-macro/br/macro.rkt | 245 ++++++++++++++++++ .../br/private/generate-literals.rkt | 0 .../br/private/syntax-flatten.rkt | 0 .../br/syntax.rkt | 6 +- beautiful-racket-macro/info.rkt | 11 + beautiful-racket/br/scribblings/br.scrbl | 17 +- 8 files changed, 278 insertions(+), 233 deletions(-) create mode 100644 beautiful-racket-macro/br/macro.rkt rename {beautiful-racket-lib => beautiful-racket-macro}/br/private/generate-literals.rkt (100%) rename {beautiful-racket-lib => beautiful-racket-macro}/br/private/syntax-flatten.rkt (100%) rename {beautiful-racket-lib => beautiful-racket-macro}/br/syntax.rkt (97%) create mode 100644 beautiful-racket-macro/info.rkt diff --git a/beautiful-racket-lib/br/define.rkt b/beautiful-racket-lib/br/define.rkt index fcc90ae..7b32326 100644 --- a/beautiful-racket-lib/br/define.rkt +++ b/beautiful-racket-lib/br/define.rkt @@ -1,19 +1,6 @@ #lang racket/base -(require racket/function - (for-syntax racket/base - syntax/parse - br/private/generate-literals - syntax/define)) -(provide (all-defined-out) - (for-syntax with-shared-id)) - -(module+ test (require rackunit)) - -(begin-for-syntax - ;; expose the caller context within br:define macros with syntax parameter - (require (for-syntax racket/base) racket/stxparam) - (provide caller-stx) - (define-syntax-parameter caller-stx (λ(stx) (error 'caller-stx-not-parameterized)))) +(require (for-syntax racket/base syntax/parse) br/macro) +(provide (all-defined-out) (all-from-out br/macro)) (define-syntax (define-cases stx) (syntax-parse stx @@ -29,217 +16,3 @@ 'define-cases "no matching case for calling pattern" (syntax->datum stx))])) - - -(module+ test - (define-cases f - [(_ arg) (add1 arg)] - [(_ arg1 arg2) (+ arg1 arg2)] - [(_ . any) 'boing]) - (check-equal? (f 42) 43) - (check-equal? (f 42 5) 47) - (check-equal? (f 42 5 'zonk) 'boing) - - (define-cases f-one-arg - [(_ arg) (add1 arg)]) - (check-exn exn:fail:contract:arity? (λ _ (f-one-arg 1 2 3)))) - - -(define-syntax-rule (debug-define-macro (ID . PAT-ARGS) BODY) - (define-macro (ID . PAT-ARGS) - #`(begin - (for-each displayln - (list - (format "input pattern = #'~a" '#,'(ID . PAT-ARGS)) - (format "output pattern = #'~a" (cadr '#,'BODY)) - (format "invoked as = ~a" (syntax->datum #'(ID . PAT-ARGS))) - (format "expanded as = ~a" '#,(syntax->datum BODY)) - (format "evaluated as = ~a" #,BODY))) - #,BODY))) - - -(module+ test - (require racket/port) - (parameterize ([current-output-port (open-output-nowhere)]) - (check-equal? (let () - (debug-define-macro (foo X Y Z) - #'(apply + (list X Y Z))) - (foo 1 2 3)) 6) - (check-equal? (let () - (debug-define-macro (foo X ...) #'(apply * (list X ...))) - (foo 10 11 12)) 1320))) - - -(begin-for-syntax - (begin-for-syntax - (require (for-syntax racket/base)) - (define-syntax-rule (make-shared-syntax-macro caller-stx) - #'(syntax-rules stx - [(_ form) - #'(datum->syntax caller-stx (if (syntax? form) - (syntax-e form) - form))])))) - -(module+ test - (define-macro (dirty-maker ARG) - (with-syntax ([dirty-bar (datum->syntax caller-stx 'dirty-bar)]) - #'(define dirty-bar (* ARG 2)))) - (dirty-maker 42) - (check-equal? dirty-bar 84)) - - -(begin-for-syntax - (define-syntax-rule (with-shared-id (id ...) . body) - (with-syntax ([id (datum->syntax caller-stx 'id)] ...) - . body))) - - -;; `syntax-parse` classes shared by `define-macro` and `define-macro-cases` -(begin-for-syntax - (require syntax/parse) - - (define-syntax-class syntaxed-id - #:literals (syntax quasisyntax) - #:description "id in syntaxed form" - (pattern ([~or syntax quasisyntax] name:id))) - - (define-syntax-class syntaxed-thing - #:literals (syntax quasisyntax) - #:description "some datum in syntaxed form" - (pattern ([~or syntax quasisyntax] thing:expr))) - - (define-syntax-class else-clause - #:literals (else) - (pattern [else . body:expr])) - - (define-syntax-class transformer-func - #:literals (lambda λ) - (pattern ([~or lambda λ] (arg:id) . body:expr)))) - - -(define-syntax (define-macro stx) - (syntax-parse stx - [(_ id:id stxed-id:syntaxed-id) - #'(define-syntax id (make-rename-transformer stxed-id))] - [(_ id:id func:transformer-func) - #'(define-syntax id func)] - [(_ id:id func-id:id) - #'(define-syntax id func-id)] - [(_ id:id stxed-thing:syntaxed-thing) - #'(define-macro id (λ (stx) stxed-thing))] - [(_ (id:id . patargs:expr) . body:expr) - (with-syntax ([id (syntax-property #'id 'caller 'define-macro)]) - #'(define-macro-cases id [(id . patargs) (begin . body)]))] - [else (raise-syntax-error - 'define-macro - "no matching case for calling pattern" - (syntax->datum stx))])) - - -(define-syntax (define-macro-cases stx) - (define (error-source stx) (or (syntax-property stx 'caller) 'define-macro-cases)) - (syntax-parse stx - [(_ id:id) - (raise-syntax-error (error-source #'id) "no cases given" (syntax->datum #'id))] - [(_ id:id leading-pat:expr ... else-pat:else-clause trailing-pat0:expr trailing-pat:expr ...) - (raise-syntax-error (error-source #'id) "`else` clause must be last" (syntax->datum #'id))] - [(_ id:id (pat:expr . result-exprs:expr) ... else-clause:else-clause) - (unless (ellipses-follow-wildcards-or-subpatterns? #'(pat ...)) - (raise-syntax-error (error-source #'id) "ellipsis in pattern can only appear after wildcard or subpattern" (syntax->datum stx))) - (with-syntax ([(PAT ...) (map (λ (x) (literalize-pat x #'~literal)) (syntax->list #'(pat ...)))]) - #'(define-macro id - (λ (stx) - (define result - (syntax-parameterize ([caller-stx (make-rename-transformer #'stx)]) - (syntax-parse (syntax-case stx () [any #'any]) - [PAT . result-exprs] ... - else-clause))) - (if (syntax? result) - result - (datum->syntax #'id result)))))] - [(_ id:id pat-clause:expr ...) ; macro without `else` clause will reach this branch - #'(define-macro-cases id - pat-clause ... - [else (raise-syntax-error - 'id - "no matching case for calling pattern" - (syntax->datum caller-stx))])] - [else (raise-syntax-error - (error-source #'id) - "no matching case for calling pattern" - (syntax->datum stx))])) - - -(module+ test - (define-macro plus (λ (stx) #'+)) - (check-equal? (plus 42) +) - (define-macro plusser #'plus) - (check-equal? (plusser 42) +) - (check-equal? plusser +) - (define-macro (times [nested ARG]) #`(* ARG ARG)) - (check-equal? (times [nested 10]) 100) - (define-macro timeser #'times) - (check-equal? (timeser [nested 12]) 144) - (define-macro fortytwo #`42) - (check-equal? fortytwo 42) - (check-equal? (let () - (define-macro (foo X) - (with-syntax ([zam #'+]) - #'(zam X X))) (foo 42)) 84) - (begin - (define-macro (redefine ID) #'(define ID 42)) - (redefine zoombar) - (check-equal? zoombar 42)) - - ;; use caller-stx parameter to introduce identifier unhygienically - (define-macro (zam ARG1 ARG2 ARG3) - (with-syntax ([dz (datum->syntax caller-stx 'dirty-zam)]) - #`(define dz 'got-dirty-zam))) - - (zam 'this 'that 42) - (check-equal? dirty-zam 'got-dirty-zam) - - (define-macro (add X) #'(+ X X)) - (check-equal? (add 5) 10) - (define-macro (add-b 9X) #'(+ 9X 9X)) - (check-equal? (add-b 5) 10) - (define-macro-cases add-again [(_ X) #'(+ X X)]) - (check-equal? (add-again 5) 10) - (define-macro-cases add-3rd [(_ X) #'(+ X X)]) - (check-equal? (add-3rd 5) 10) - (define-macro add-4th #'add-3rd) - (check-equal? (add-4th 5) 10) - (define foo-val 'got-foo-val) - (define (foo-func) 'got-foo-func) - (define-macro-cases op - [(_ "+") #''got-plus] - [(_ ARG) #''got-something-else] - [(_) #'(foo-func)] - [_ #'foo-val]) - - (check-equal? (op "+") 'got-plus) - (check-equal? (op 42) 'got-something-else) - (check-equal? (op) 'got-foo-func) - (check-equal? op 'got-foo-val) - - (define-macro-cases elseop - [(_ ARG) #''got-arg] - [else #''got-else]) - - (check-equal? (elseop "+") 'got-arg) - (check-equal? (elseop "+" 42) 'got-else) - - (check-exn exn:fail:syntax? (λ () (expand-once #'(define-macro-cases no-cases)))) - - (check-exn exn:fail:syntax? (λ () (expand-once #'(define-macro-cases badelseop - [else #''got-else] - [(_ _arg) #''got-arg])))) - - (define-macro-cases no-else-macro - [(_ ARG) #''got-arg]) - (check-exn exn:fail:syntax? (λ _ (expand-once #'(no-else-macro 'arg1 'arg2))))) - -(define-macro (define-unhygienic-macro (ID PAT ...) BODY ... STX-OBJECT) - #'(define-macro (ID PAT ...) - BODY ... - (datum->syntax caller-stx (syntax->datum STX-OBJECT)))) diff --git a/beautiful-racket-lib/info.rkt b/beautiful-racket-lib/info.rkt index ac76ad2..7dded3b 100644 --- a/beautiful-racket-lib/info.rkt +++ b/beautiful-racket-lib/info.rkt @@ -7,6 +7,7 @@ ;; base v6.7 dependency needs to be called 6.6.0.900 ;; due to strange little bug in `raco pkg install` (define deps '(["base" #:version "6.6.0.900"] + "beautiful-racket-macro" "at-exp-lib" "sugar" "debug" diff --git a/beautiful-racket-macro/br/macro.rkt b/beautiful-racket-macro/br/macro.rkt new file mode 100644 index 0000000..95902c0 --- /dev/null +++ b/beautiful-racket-macro/br/macro.rkt @@ -0,0 +1,245 @@ +#lang racket/base +(require racket/function + (for-syntax racket/base + syntax/parse + "private/generate-literals.rkt" + syntax/define)) +(provide (all-defined-out) + (for-syntax with-shared-id)) + +(module+ test (require rackunit)) + +(begin-for-syntax + ;; expose the caller context within br:define macros with syntax parameter + (require (for-syntax racket/base) racket/stxparam) + (provide caller-stx) + (define-syntax-parameter caller-stx (λ(stx) (error 'caller-stx-not-parameterized)))) + +(define-syntax (define-cases stx) + (syntax-parse stx + #:literals (syntax) + [(_ id:id) + (raise-syntax-error 'define-cases "no cases given" (syntax->datum #'id))] + [(_ id:id [(_ . pat-args:expr) . body:expr] ...) + #'(define id + (case-lambda + [pat-args . body] ... + [rest-pat (apply raise-arity-error 'id (normalize-arity (map length '(pat-args ...))) rest-pat)]))] + [else (raise-syntax-error + 'define-cases + "no matching case for calling pattern" + (syntax->datum stx))])) + + +(module+ test + (define-cases f + [(_ arg) (add1 arg)] + [(_ arg1 arg2) (+ arg1 arg2)] + [(_ . any) 'boing]) + (check-equal? (f 42) 43) + (check-equal? (f 42 5) 47) + (check-equal? (f 42 5 'zonk) 'boing) + + (define-cases f-one-arg + [(_ arg) (add1 arg)]) + (check-exn exn:fail:contract:arity? (λ _ (f-one-arg 1 2 3)))) + + +(define-syntax-rule (debug-define-macro (ID . PAT-ARGS) BODY) + (define-macro (ID . PAT-ARGS) + #`(begin + (for-each displayln + (list + (format "input pattern = #'~a" '#,'(ID . PAT-ARGS)) + (format "output pattern = #'~a" (cadr '#,'BODY)) + (format "invoked as = ~a" (syntax->datum #'(ID . PAT-ARGS))) + (format "expanded as = ~a" '#,(syntax->datum BODY)) + (format "evaluated as = ~a" #,BODY))) + #,BODY))) + + +(module+ test + (require racket/port) + (parameterize ([current-output-port (open-output-nowhere)]) + (check-equal? (let () + (debug-define-macro (foo X Y Z) + #'(apply + (list X Y Z))) + (foo 1 2 3)) 6) + (check-equal? (let () + (debug-define-macro (foo X ...) #'(apply * (list X ...))) + (foo 10 11 12)) 1320))) + + +(begin-for-syntax + (begin-for-syntax + (require (for-syntax racket/base)) + (define-syntax-rule (make-shared-syntax-macro caller-stx) + #'(syntax-rules stx + [(_ form) + #'(datum->syntax caller-stx (if (syntax? form) + (syntax-e form) + form))])))) + +(module+ test + (define-macro (dirty-maker ARG) + (with-syntax ([dirty-bar (datum->syntax caller-stx 'dirty-bar)]) + #'(define dirty-bar (* ARG 2)))) + (dirty-maker 42) + (check-equal? dirty-bar 84)) + + +(begin-for-syntax + (define-syntax-rule (with-shared-id (id ...) . body) + (with-syntax ([id (datum->syntax caller-stx 'id)] ...) + . body))) + + +;; `syntax-parse` classes shared by `define-macro` and `define-macro-cases` +(begin-for-syntax + (require syntax/parse) + + (define-syntax-class syntaxed-id + #:literals (syntax quasisyntax) + #:description "id in syntaxed form" + (pattern ([~or syntax quasisyntax] name:id))) + + (define-syntax-class syntaxed-thing + #:literals (syntax quasisyntax) + #:description "some datum in syntaxed form" + (pattern ([~or syntax quasisyntax] thing:expr))) + + (define-syntax-class else-clause + #:literals (else) + (pattern [else . body:expr])) + + (define-syntax-class transformer-func + #:literals (lambda λ) + (pattern ([~or lambda λ] (arg:id) . body:expr)))) + + +(define-syntax (define-macro stx) + (syntax-parse stx + [(_ id:id stxed-id:syntaxed-id) + #'(define-syntax id (make-rename-transformer stxed-id))] + [(_ id:id func:transformer-func) + #'(define-syntax id func)] + [(_ id:id func-id:id) + #'(define-syntax id func-id)] + [(_ id:id stxed-thing:syntaxed-thing) + #'(define-macro id (λ (stx) stxed-thing))] + [(_ (id:id . patargs:expr) . body:expr) + (with-syntax ([id (syntax-property #'id 'caller 'define-macro)]) + #'(define-macro-cases id [(id . patargs) (begin . body)]))] + [else (raise-syntax-error + 'define-macro + "no matching case for calling pattern" + (syntax->datum stx))])) + + +(define-syntax (define-macro-cases stx) + (define (error-source stx) (or (syntax-property stx 'caller) 'define-macro-cases)) + (syntax-parse stx + [(_ id:id) + (raise-syntax-error (error-source #'id) "no cases given" (syntax->datum #'id))] + [(_ id:id leading-pat:expr ... else-pat:else-clause trailing-pat0:expr trailing-pat:expr ...) + (raise-syntax-error (error-source #'id) "`else` clause must be last" (syntax->datum #'id))] + [(_ id:id (pat:expr . result-exprs:expr) ... else-clause:else-clause) + (unless (ellipses-follow-wildcards-or-subpatterns? #'(pat ...)) + (raise-syntax-error (error-source #'id) "ellipsis in pattern can only appear after wildcard or subpattern" (syntax->datum stx))) + (with-syntax ([(PAT ...) (map (λ (x) (literalize-pat x #'~literal)) (syntax->list #'(pat ...)))]) + #'(define-macro id + (λ (stx) + (define result + (syntax-parameterize ([caller-stx (make-rename-transformer #'stx)]) + (syntax-parse (syntax-case stx () [any #'any]) + [PAT . result-exprs] ... + else-clause))) + (if (syntax? result) + result + (datum->syntax #'id result)))))] + [(_ id:id pat-clause:expr ...) ; macro without `else` clause will reach this branch + #'(define-macro-cases id + pat-clause ... + [else (raise-syntax-error + 'id + "no matching case for calling pattern" + (syntax->datum caller-stx))])] + [else (raise-syntax-error + (error-source #'id) + "no matching case for calling pattern" + (syntax->datum stx))])) + + +(module+ test + (define-macro plus (λ (stx) #'+)) + (check-equal? (plus 42) +) + (define-macro plusser #'plus) + (check-equal? (plusser 42) +) + (check-equal? plusser +) + (define-macro (times [nested ARG]) #`(* ARG ARG)) + (check-equal? (times [nested 10]) 100) + (define-macro timeser #'times) + (check-equal? (timeser [nested 12]) 144) + (define-macro fortytwo #`42) + (check-equal? fortytwo 42) + (check-equal? (let () + (define-macro (foo X) + (with-syntax ([zam #'+]) + #'(zam X X))) (foo 42)) 84) + (begin + (define-macro (redefine ID) #'(define ID 42)) + (redefine zoombar) + (check-equal? zoombar 42)) + + ;; use caller-stx parameter to introduce identifier unhygienically + (define-macro (zam ARG1 ARG2 ARG3) + (with-syntax ([dz (datum->syntax caller-stx 'dirty-zam)]) + #`(define dz 'got-dirty-zam))) + + (zam 'this 'that 42) + (check-equal? dirty-zam 'got-dirty-zam) + + (define-macro (add X) #'(+ X X)) + (check-equal? (add 5) 10) + (define-macro (add-b 9X) #'(+ 9X 9X)) + (check-equal? (add-b 5) 10) + (define-macro-cases add-again [(_ X) #'(+ X X)]) + (check-equal? (add-again 5) 10) + (define-macro-cases add-3rd [(_ X) #'(+ X X)]) + (check-equal? (add-3rd 5) 10) + (define-macro add-4th #'add-3rd) + (check-equal? (add-4th 5) 10) + (define foo-val 'got-foo-val) + (define (foo-func) 'got-foo-func) + (define-macro-cases op + [(_ "+") #''got-plus] + [(_ ARG) #''got-something-else] + [(_) #'(foo-func)] + [_ #'foo-val]) + + (check-equal? (op "+") 'got-plus) + (check-equal? (op 42) 'got-something-else) + (check-equal? (op) 'got-foo-func) + (check-equal? op 'got-foo-val) + + (define-macro-cases elseop + [(_ ARG) #''got-arg] + [else #''got-else]) + + (check-equal? (elseop "+") 'got-arg) + (check-equal? (elseop "+" 42) 'got-else) + + (check-exn exn:fail:syntax? (λ () (expand-once #'(define-macro-cases no-cases)))) + + (check-exn exn:fail:syntax? (λ () (expand-once #'(define-macro-cases badelseop + [else #''got-else] + [(_ _arg) #''got-arg])))) + + (define-macro-cases no-else-macro + [(_ ARG) #''got-arg]) + (check-exn exn:fail:syntax? (λ _ (expand-once #'(no-else-macro 'arg1 'arg2))))) + +(define-macro (define-unhygienic-macro (ID PAT ...) BODY ... STX-OBJECT) + #'(define-macro (ID PAT ...) + BODY ... + (datum->syntax caller-stx (syntax->datum STX-OBJECT)))) diff --git a/beautiful-racket-lib/br/private/generate-literals.rkt b/beautiful-racket-macro/br/private/generate-literals.rkt similarity index 100% rename from beautiful-racket-lib/br/private/generate-literals.rkt rename to beautiful-racket-macro/br/private/generate-literals.rkt diff --git a/beautiful-racket-lib/br/private/syntax-flatten.rkt b/beautiful-racket-macro/br/private/syntax-flatten.rkt similarity index 100% rename from beautiful-racket-lib/br/private/syntax-flatten.rkt rename to beautiful-racket-macro/br/private/syntax-flatten.rkt diff --git a/beautiful-racket-lib/br/syntax.rkt b/beautiful-racket-macro/br/syntax.rkt similarity index 97% rename from beautiful-racket-lib/br/syntax.rkt rename to beautiful-racket-macro/br/syntax.rkt index 2ed4264..ff964d3 100644 --- a/beautiful-racket-lib/br/syntax.rkt +++ b/beautiful-racket-macro/br/syntax.rkt @@ -1,7 +1,7 @@ #lang racket/base (require (for-syntax racket/base - br/private/generate-literals) + "private/generate-literals.rkt") racket/list racket/match racket/syntax @@ -9,8 +9,8 @@ syntax/stx syntax/strip-context syntax/parse - br/define - br/private/syntax-flatten) + "macro.rkt" + "private/syntax-flatten.rkt") (provide (all-defined-out) syntax-flatten stx-map diff --git a/beautiful-racket-macro/info.rkt b/beautiful-racket-macro/info.rkt new file mode 100644 index 0000000..db1add2 --- /dev/null +++ b/beautiful-racket-macro/info.rkt @@ -0,0 +1,11 @@ +#lang info + +(define collection 'multi) + +(define version "1.5") + +;; base v6.7 dependency needs to be called 6.6.0.900 +;; due to strange little bug in `raco pkg install` +(define deps '(["base" #:version "6.6.0.900"])) + +(define build-deps '("rackunit-lib")) diff --git a/beautiful-racket/br/scribblings/br.scrbl b/beautiful-racket/br/scribblings/br.scrbl index 14e1668..4f65218 100644 --- a/beautiful-racket/br/scribblings/br.scrbl +++ b/beautiful-racket/br/scribblings/br.scrbl @@ -19,6 +19,13 @@ This library provides the @tt{#lang br} teaching language used in the book, as w This library is designed to smooth over some of the small idiosyncrasies and inconsistencies in Racket, so that those new to Racket are more likely to say ``ah, that makes sense'' rather than ``huh? what?'' +@section{Installation} + +If you want all the code & documentation, install the package @racket[beautiful-racket]. + +If you just want the code modules (for instance, for use as a dependency in another project) install the package @racket[beautiful-racket-lib]. + +If you just want the @racketmodname[br/macro] and @racketmodname[br/syntax] modules, install the package @racket[beautiful-racket-macro]. @section{Conditionals} @@ -170,6 +177,8 @@ A variant of @racket[report] for use with @secref["stx-obj" #:doc '(lib "scribbl @defmodule[br/define] +@margin-note{This module also exports the bindings from @racketmodname[br/macro].} + @defform[ (define-cases id [pat body ...+] ...+) @@ -199,6 +208,12 @@ Define a function that behaves differently depending on how many arguments are s ] +@section{Macro} + +@defmodule[br/macro #:packages ("beautiful-racket-lib" "beautiful-racket-macro")] + + + @defform*[ #:literals (syntax lambda stx) [ @@ -386,7 +401,7 @@ Like @racket[define-macro], but moves @racket[result-expr] into the lexical cont @section{Syntax} -@defmodule[br/syntax] +@defmodule[br/syntax #:packages ("beautiful-racket-lib" "beautiful-racket-macro")] @defform[(with-pattern ([pattern stx-expr] ...) body ...+)]{ Bind pattern variables within each @racket[pattern] by matching the pattern to its respective @racket[stx-expr]. These pattern variables can be used in later pattern–expression clauses, or in @racket[body]. Uses the same pattern conventions as @racket[define-macro] (i.e., wildcard variables must be in @tt{CAPS}; everything else is treated as a literal).