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

Merge pull request #191 from jackfirth/190-examples

Browse Source 
Use scribble-example
This commit is contained in:
Jack Firth 2015-08-27 15:25:03 -07:00
commit b5ab927e6e
39 changed files with 74 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
info.rkt
View File

@ -23,6 +23,7 @@
'("cover" '("cover"
"rackunit-lib" "rackunit-lib"
"racket-doc" "racket-doc"
"jack-scribble-example"
"doc-coverage")) "doc-coverage"))

4
lens/applicable.scrbl
View File

@ -13,7 +13,7 @@ but enables the use of @italic{applicable lenses}. Applicable lenses
may be used directly as getter functions, removing the need to use may be used directly as getter functions, removing the need to use
@racket[lens-view]. @racket[lens-view].
@lenses-applicable-examples[ @lens-applicable-examples[
(require lens/applicable) (require lens/applicable)
(first-lens '(a b c)) (first-lens '(a b c))
(map first-lens '((1 2 3) (a b c) (100 200 300))) (map first-lens '((1 2 3) (a b c) (100 200 300)))
@ -21,7 +21,7 @@ may be used directly as getter functions, removing the need to use
Attempting to use non-applicable lenses as functions is an error. Attempting to use non-applicable lenses as functions is an error.
@lenses-examples[ @lens-examples[
(require lens) (require lens)
(first-lens '(a b c)) (first-lens '(a b c))
] ]

4
lens/private/base/base.scrbl
View File

@ -16,7 +16,7 @@
@racket[view/c]. The getter must accept a target and return the @racket[view/c]. The getter must accept a target and return the
lens's view. The setter must accept a target and a new view, and lens's view. The setter must accept a target and a new view, and
return a new target with its view replaced with the new view. return a new target with its view replaced with the new view.
@lenses-examples[ @lens-examples[
(define (set-first lst v) (define (set-first lst v)
(list* v (rest lst))) (list* v (rest lst)))
(set-first '(1 2 3) 'a) (set-first '(1 2 3) 'a)
@ -33,7 +33,7 @@
the target's view to the new view. The context is conceptually the target's view to the new view. The context is conceptually
a function representing the "hole" formed by abstracting the view a function representing the "hole" formed by abstracting the view
of the target. of the target.
@lenses-examples[ @lens-examples[
(let-lens (view context) first-lens '(1 2 3) (let-lens (view context) first-lens '(1 2 3)
(printf "View is ~a\n" view) (printf "View is ~a\n" view)
(context 'a)) (context 'a))

4
lens/private/base/transform.scrbl
View File

@ -15,7 +15,7 @@
to @racket[transformer], then setting the view of @racket[target] to @racket[transformer], then setting the view of @racket[target]
to the return value of calling @racket[transformer] with the old to the return value of calling @racket[transformer] with the old
view. view.
@lenses-examples[ @lens-examples[
(lens-transform first-lens '(1 2 3) number->string) (lens-transform first-lens '(1 2 3) number->string)
]} ]}
@ -24,7 +24,7 @@
Like @racket[lens-transform], except that it can take multiple Like @racket[lens-transform], except that it can take multiple
lenses-transformer pairs in the same way as @racket[lens-set*] lenses-transformer pairs in the same way as @racket[lens-set*]
and later transformations overwrite earlier ones in the same way. and later transformations overwrite earlier ones in the same way.
@lenses-examples[ @lens-examples[
(lens-transform/list '(1 2 3 4 5) (lens-transform/list '(1 2 3 4 5)
first-lens number->string first-lens number->string
third-lens (λ (x) (* 100 x))) third-lens (λ (x) (* 100 x)))

8
lens/private/base/view-set.scrbl
View File

@ -8,21 +8,21 @@
@defproc[(lens-view [lens lens?] [target target/c]) view/c]{ @defproc[(lens-view [lens lens?] [target target/c]) view/c]{
Extracts the view of @racket[target] with @racket[lens]. Extracts the view of @racket[target] with @racket[lens].
Essentially a getter function. Essentially a getter function.
@lenses-examples[ @lens-examples[
(lens-view first-lens '(1 2 3)) (lens-view first-lens '(1 2 3))
]} ]}
@defproc[(lens-set [lens lens?] [target target/c] [new-view view/c]) target/c]{ @defproc[(lens-set [lens lens?] [target target/c] [new-view view/c]) target/c]{
Sets the view of @racket[target] to @racket[new-view] using Sets the view of @racket[target] to @racket[new-view] using
@racket[lens]. Essentially a setter function. @racket[lens]. Essentially a setter function.
@lenses-examples[ @lens-examples[
(lens-set first-lens '(1 2 3) 'a) (lens-set first-lens '(1 2 3) 'a)
]} ]}
@defproc[(lens-view/list [target target/c] [lens lens?] ...) view/c]{ @defproc[(lens-view/list [target target/c] [lens lens?] ...) view/c]{
Like @racket[lens-view], except that it takes multiple lenses and Like @racket[lens-view], except that it takes multiple lenses and
returns a list of views. returns a list of views.
@lenses-examples[ @lens-examples[
(lens-view/list '(a b c d e f g) (lens-view/list '(a b c d e f g)
first-lens fourth-lens fifth-lens) first-lens fourth-lens fifth-lens)
]} ]}
@ -31,7 +31,7 @@
Like @racket[lens-set], except that it can take multiple Like @racket[lens-set], except that it can take multiple
lenses-value pairs. If the view of two of the lenses overlap, the lenses-value pairs. If the view of two of the lenses overlap, the
later views overwrite the earlier ones. later views overwrite the earlier ones.
@lenses-examples[ @lens-examples[
(lens-set/list '(1 2 3 4 5) (lens-set/list '(1 2 3 4 5)
first-lens 10 first-lens 10
third-lens 300) third-lens 300)

4
lens/private/compound/compose.scrbl
View File

@ -10,7 +10,7 @@
lens's target is viewed through. Each successive lens "zooms in" lens's target is viewed through. Each successive lens "zooms in"
to a more detailed view. When called with no arguments, @racket[lens-compose] to a more detailed view. When called with no arguments, @racket[lens-compose]
produces the identity lens. produces the identity lens.
@lenses-examples[ @lens-examples[
(define first-of-second-lens (lens-compose first-lens second-lens)) (define first-of-second-lens (lens-compose first-lens second-lens))
(lens-view first-of-second-lens '((1 a) (2 b) (3 c))) (lens-view first-of-second-lens '((1 a) (2 b) (3 c)))
(lens-set first-of-second-lens '((1 a) (2 b) (3 c)) 200) (lens-set first-of-second-lens '((1 a) (2 b) (3 c)) 200)
@ -22,7 +22,7 @@
@racket[(lens-compose lens identity-lens)] and @racket[(lens-compose lens identity-lens)] and
@racket[(lens-compose identity-lens lens)] are equivalent to @racket[(lens-compose identity-lens lens)] are equivalent to
@racket[lens]. @racket[lens].
@lenses-examples[ @lens-examples[
(lens-view identity-lens 4) (lens-view identity-lens 4)
(lens-set identity-lens 4 'a) (lens-set identity-lens 4 'a)
]} ]}

2
lens/private/compound/join-hash.scrbl
View File

@ -9,7 +9,7 @@
as the hash keys. In the same manner as @racket[lens-join/list], as the hash keys. In the same manner as @racket[lens-join/list],
if lenses share views later lenses take precedence when if lenses share views later lenses take precedence when
setting. setting.
@lenses-examples[ @lens-examples[
(define a-b-lens (lens-join/hash 'a first-lens (define a-b-lens (lens-join/hash 'a first-lens
'b third-lens)) 'b third-lens))
(lens-view a-b-lens '(1 2 3)) (lens-view a-b-lens '(1 2 3))

2
lens/private/compound/join-list.scrbl
View File

@ -8,7 +8,7 @@
be used to view and set a list of values in a single be used to view and set a list of values in a single
target. If any of the lenses share views, then when target. If any of the lenses share views, then when
setting the later lenses override the earlier ones. setting the later lenses override the earlier ones.
@lenses-examples[ @lens-examples[
(define first-third-fifth-lens (define first-third-fifth-lens
(lens-join/list first-lens (lens-join/list first-lens
third-lens third-lens

2
lens/private/compound/join-string.scrbl
View File

@ -6,7 +6,7 @@
@defproc[(lens-join/string [lens lens?] ...) lens?]{ @defproc[(lens-join/string [lens lens?] ...) lens?]{
Like @racket[lens-join/list], except the view is a string, not a list. Like @racket[lens-join/list], except the view is a string, not a list.
Each @racket[lens] argument must return a @racket[char?] as a view. Each @racket[lens] argument must return a @racket[char?] as a view.
@lenses-examples[ @lens-examples[
(define string-first-third-fifth-lens (define string-first-third-fifth-lens
(lens-join/string first-lens (lens-join/string first-lens
third-lens third-lens

2
lens/private/compound/join-vector.scrbl
View File

@ -5,7 +5,7 @@
@defproc[(lens-join/vector [lens lens?] ...) lens?]{ @defproc[(lens-join/vector [lens lens?] ...) lens?]{
Like @racket[lens-join/list], except the view is a vector, not a list. Like @racket[lens-join/list], except the view is a vector, not a list.
@lenses-examples[ @lens-examples[
(define vector-first-third-fifth-lens (define vector-first-third-fifth-lens
(lens-join/vector first-lens (lens-join/vector first-lens
third-lens third-lens

2
lens/private/compound/thrush.scrbl
View File

@ -7,7 +7,7 @@
Like @racket[lens-compose], but each @racket[lens] is combined in the Like @racket[lens-compose], but each @racket[lens] is combined in the
opposite order. That is, the first @racket[lens] is the first opposite order. That is, the first @racket[lens] is the first
@racket[lens] that the compound lens’s target is viewed through. @racket[lens] that the compound lens’s target is viewed through.
@lenses-examples[ @lens-examples[
(define first-of-second-lens (lens-thrush second-lens first-lens)) (define first-of-second-lens (lens-thrush second-lens first-lens))
(lens-view first-of-second-lens '((1 a) (2 b) (3 c))) (lens-view first-of-second-lens '((1 a) (2 b) (3 c)))
(lens-set first-of-second-lens '((1 a) (2 b) (3 c)) 200) (lens-set first-of-second-lens '((1 a) (2 b) (3 c)) 200)

2
lens/private/dict.scrbl
View File

@ -7,7 +7,7 @@
@defproc[(dict-ref-lens [key any/c]) lens?]{ @defproc[(dict-ref-lens [key any/c]) lens?]{
Returns a lens for viewing the value mapped to @racket[key] in a dict. Returns a lens for viewing the value mapped to @racket[key] in a dict.
@lenses-examples[ @lens-examples[
(define dict '((a . 1) (b . 2) (c . 3))) (define dict '((a . 1) (b . 2) (c . 3)))
(lens-view (dict-ref-lens 'a) dict) (lens-view (dict-ref-lens 'a) dict)
(lens-set (dict-ref-lens 'a) dict 100) (lens-set (dict-ref-lens 'a) dict 100)

42
lens/private/doc-util/lenses-examples.rkt
View File

@ -1,43 +1,21 @@
#lang racket #lang sweet-exp racket
(provide lenses-examples provide lens-examples
lenses-applicable-examples lens-applicable-examples
lenses-unstable-examples lens-unstable-examples
define-persistant-lenses-unstable-examples) persistent-lens-unstable-examples
(require scribble/eval require scribble-example
racket/splicing)
(define-syntax-rule (define-examples-form id require-spec ...) (define-examples-form lens-examples
(begin
(define (eval-factory)
(define base-eval (make-base-eval))
(base-eval '(require require-spec)) ...
base-eval)
(define-syntax-rule (id datum (... ...))
(examples #:eval (eval-factory) datum (... ...)))))
(define-syntax-rule (define-examples/persistance-syntax id require-spec ...)
(begin
(define (eval-factory)
(define base-eval (make-base-eval))
(base-eval '(require require-spec)) ...
base-eval)
(define-syntax-rule (id examples-id)
(begin
(splicing-let ([the-eval (eval-factory)])
(define-syntax-rule (examples-id datum (... (... ...)))
(examples #:eval the-eval datum (... (... ...)))))))))
(define-examples-form lenses-examples
lens racket/list racket/vector racket/stream racket/set) lens racket/list racket/vector racket/stream racket/set)
(define-examples-form lenses-applicable-examples (define-examples-form lens-applicable-examples
lens/applicable racket/list racket/vector racket/stream racket/set) lens/applicable racket/list racket/vector racket/stream racket/set)
(define-examples-form lenses-unstable-examples (define-examples-form lens-unstable-examples
lens unstable/lens racket/list racket/vector racket/stream racket/set) lens unstable/lens racket/list racket/vector racket/stream racket/set)
(define-examples/persistance-syntax define-persistant-lenses-unstable-examples (define-persistent-examples-form persistent-lens-unstable-examples
lens unstable/lens racket/list racket/vector racket/stream racket/set) lens unstable/lens racket/list racket/vector racket/stream racket/set)

2
lens/private/hash/nested.scrbl
View File

@ -7,7 +7,7 @@
Contructs a lens that targets hashes with nested hashes Contructs a lens that targets hashes with nested hashes
as values and views the value obtained by using each as values and views the value obtained by using each
@racket[key] in order. @racket[key] in order.
@lenses-examples[ @lens-examples[
(define foo-bar-lens (hash-ref-nested-lens 'foo 'bar)) (define foo-bar-lens (hash-ref-nested-lens 'foo 'bar))
(lens-view foo-bar-lens (hash 'foo (hash 'bar 1))) (lens-view foo-bar-lens (hash 'foo (hash 'bar 1)))
(lens-set foo-bar-lens (hash 'foo (hash 'bar 1)) 1000) (lens-set foo-bar-lens (hash 'foo (hash 'bar 1)) 1000)

2
lens/private/hash/pick.scrbl
View File

@ -7,7 +7,7 @@
Creates a lens that views a subset of the target hash-table with the given Creates a lens that views a subset of the target hash-table with the given
@racket[key]s. The view, is another hash-table with only the given keys and @racket[key]s. The view, is another hash-table with only the given keys and
their corrosponding values in the target hash-table. their corrosponding values in the target hash-table.
@lenses-examples[ @lens-examples[
(lens-view (hash-pick-lens 'a 'c) (hash 'a 1 'b 2 'c 3)) (lens-view (hash-pick-lens 'a 'c) (hash 'a 1 'b 2 'c 3))
(lens-set (hash-pick-lens 'a 'c) (hash 'a 1 'b 2 'c 3) (hash 'a 4 'c 5)) (lens-set (hash-pick-lens 'a 'c) (hash 'a 1 'b 2 'c 3) (hash 'a 4 'c 5))
]} ]}

2
lens/private/hash/ref.scrbl
View File

@ -6,7 +6,7 @@
@defproc[(hash-ref-lens [key any/c]) lens?]{ @defproc[(hash-ref-lens [key any/c]) lens?]{
Constructs a lens that targets hashes and views the value Constructs a lens that targets hashes and views the value
of @racket[key]. of @racket[key].
@lenses-examples[ @lens-examples[
(define foo-lens (hash-ref-lens 'foo)) (define foo-lens (hash-ref-lens 'foo))
(lens-view foo-lens (hash 'foo 10 'bar 20)) (lens-view foo-lens (hash 'foo 10 'bar 20))
(lens-set foo-lens (hash 'foo 10 'bar 20) 1000) (lens-set foo-lens (hash 'foo 10 'bar 20) 1000)

4
lens/private/list/assoc.scrbl
View File

@ -11,7 +11,7 @@
Specifically, for a given association list the returned Specifically, for a given association list the returned
lens examines the second value of the first pair that lens examines the second value of the first pair that
has a key that is @racket[key-equal?] to @racket[key]. has a key that is @racket[key-equal?] to @racket[key].
@lenses-examples[ @lens-examples[
(define assoc-a-lens (assoc-lens 'a)) (define assoc-a-lens (assoc-lens 'a))
(define some-assoc-list '((a . 1) (b . 2) (c . 3))) (define some-assoc-list '((a . 1) (b . 2) (c . 3)))
(lens-view assoc-a-lens some-assoc-list) (lens-view assoc-a-lens some-assoc-list)
@ -21,7 +21,7 @@
The @racket[key-equal?] procedure is useful for The @racket[key-equal?] procedure is useful for
datatypes that have their own definition of datatypes that have their own definition of
equality, such as strings. equality, such as strings.
@lenses-examples[ @lens-examples[
(define assoc-foo-lens (assoc-lens "foo" #:is-equal? string=?)) (define assoc-foo-lens (assoc-lens "foo" #:is-equal? string=?))
(lens-view assoc-foo-lens '(("bar" . 1) ("foo" . 2) ("baz" . 3))) (lens-view assoc-foo-lens '(("bar" . 1) ("foo" . 2) ("baz" . 3)))
]} ]}

4
lens/private/list/car-cdr.scrbl
View File

@ -7,7 +7,7 @@
@deflenses[(car-lens cdr-lens)]{ @deflenses[(car-lens cdr-lens)]{
Lenses for examining the @racket[car] and @racket[cdr] of Lenses for examining the @racket[car] and @racket[cdr] of
a pair. a pair.
@lenses-examples[ @lens-examples[
(lens-view car-lens '(a . b)) (lens-view car-lens '(a . b))
(lens-view cdr-lens '(a . b)) (lens-view cdr-lens '(a . b))
]} ]}
@ -33,7 +33,7 @@
ddaa ddad ddda dddd)]{ ddaa ddad ddda dddd)]{
Lenses for accessing nested pairs. Each lens's view is the Lenses for accessing nested pairs. Each lens's view is the
equivalently named pair-accessor function. equivalently named pair-accessor function.
@lenses-examples[ @lens-examples[
(cdaddr '(9 8 (6 5 4 3 2 1) 7)) (cdaddr '(9 8 (6 5 4 3 2 1) 7))
(lens-view cdaddr-lens '(9 8 (6 5 4 3 2 1) 7)) (lens-view cdaddr-lens '(9 8 (6 5 4 3 2 1) 7))
(lens-transform cdaddr-lens '(9 8 (6 5 4 3 2 1) 7) list->vector) (lens-transform cdaddr-lens '(9 8 (6 5 4 3 2 1) 7) list->vector)

4
lens/private/list/list-ref-take-drop.scrbl
View File

@ -10,7 +10,7 @@
lens?]{ lens?]{
Returns a lens for viewing the @racket[n]th item of a list, Returns a lens for viewing the @racket[n]th item of a list,
with indexing starting from zero. with indexing starting from zero.
@lenses-examples[ @lens-examples[
(lens-view (list-ref-lens 3) '(a b c d e f g h)) (lens-view (list-ref-lens 3) '(a b c d e f g h))
(lens-set (list-ref-lens 1) '(a b c d e f g h) 'FOO) (lens-set (list-ref-lens 1) '(a b c d e f g h) 'FOO)
]} ]}
@ -27,7 +27,7 @@
tenth-lens)]{ tenth-lens)]{
Lenses for examiniming specific items of lists. Shorthands Lenses for examiniming specific items of lists. Shorthands
for the common use cases of @racket[list-ref-lens]. for the common use cases of @racket[list-ref-lens].
@lenses-examples[ @lens-examples[
(lens-view third-lens '(a b c d)) (lens-view third-lens '(a b c d))
(lens-view (lens-compose second-lens fourth-lens) (lens-view (lens-compose second-lens fourth-lens)
'((a 1) (b 2) (c 3) (d 4))) '((a 1) (b 2) (c 3) (d 4)))

4
lens/private/list/multi.scrbl
View File

@ -6,7 +6,7 @@
@defproc[(list-ref-nested-lens [index exact-nonnegative-integer?] ...) lens?]{ @defproc[(list-ref-nested-lens [index exact-nonnegative-integer?] ...) lens?]{
Constructs a lens that views into a tree made from nested lists. Constructs a lens that views into a tree made from nested lists.
Indexing starts from zero in the same was as @racket[list-ref-lens]. Indexing starts from zero in the same was as @racket[list-ref-lens].
@lenses-examples[ @lens-examples[
(define first-of-second-lens (list-ref-nested-lens 1 0)) (define first-of-second-lens (list-ref-nested-lens 1 0))
(lens-view first-of-second-lens '(1 (a b c) 2 3)) (lens-view first-of-second-lens '(1 (a b c) 2 3))
(lens-set first-of-second-lens '(1 (a b c) 2 3) 'foo) (lens-set first-of-second-lens '(1 (a b c) 2 3) 'foo)
@ -15,7 +15,7 @@
@defproc[(list-refs-lens [index exact-nonnegative-integer?] ...) lens?]{ @defproc[(list-refs-lens [index exact-nonnegative-integer?] ...) lens?]{
Constructs a lens that views each @racket[index] item in a list. Constructs a lens that views each @racket[index] item in a list.
Indexing starts from zero in the same was as @racket[list-ref-lens]. Indexing starts from zero in the same was as @racket[list-ref-lens].
@lenses-examples[ @lens-examples[
(define 1-5-6-lens (list-refs-lens 1 5 6)) (define 1-5-6-lens (list-refs-lens 1 5 6))
(lens-view 1-5-6-lens '(a b c d e f g)) (lens-view 1-5-6-lens '(a b c d e f g))
(lens-set 1-5-6-lens '(a b c d e f g) '(1 2 3)) (lens-set 1-5-6-lens '(a b c d e f g) '(1 2 3))

6
lens/private/stream.scrbl
View File

@ -7,21 +7,21 @@
@defthing[stream-first-lens lens?]{ @defthing[stream-first-lens lens?]{
A lens for viewing the first element of a stream. A lens for viewing the first element of a stream.
@lenses-examples[ @lens-examples[
(lens-view stream-first-lens (stream 1 2 3)) (lens-view stream-first-lens (stream 1 2 3))
(stream->list (lens-set stream-first-lens (stream 1 2 3) 'a)) (stream->list (lens-set stream-first-lens (stream 1 2 3) 'a))
]} ]}
@defthing[stream-rest-lens lens?]{ @defthing[stream-rest-lens lens?]{
A lens for viewing the rest of a stream after the first element. A lens for viewing the rest of a stream after the first element.
@lenses-examples[ @lens-examples[
(stream->list (lens-view stream-rest-lens (stream 1 2 3))) (stream->list (lens-view stream-rest-lens (stream 1 2 3)))
(stream->list (lens-set stream-rest-lens (stream 1 2 3) (stream 200 300 400 500))) (stream->list (lens-set stream-rest-lens (stream 1 2 3) (stream 200 300 400 500)))
]} ]}
@defproc[(stream-ref-lens [i exact-nonnegative-integer?]) lens?]{ @defproc[(stream-ref-lens [i exact-nonnegative-integer?]) lens?]{
A lens for viewing the @racket[i]th element of a stream. A lens for viewing the @racket[i]th element of a stream.
@lenses-examples[ @lens-examples[
(lens-view (stream-ref-lens 2) (stream 1 2 3 4 5 6)) (lens-view (stream-ref-lens 2) (stream 1 2 3 4 5 6))
(stream->list (lens-set (stream-ref-lens 2) (stream 1 2 3 4 5 6) 'a)) (stream->list (lens-set (stream-ref-lens 2) (stream 1 2 3 4 5 6) 'a))
]} ]}

4
lens/private/string.scrbl
View File

@ -6,7 +6,7 @@
@defproc[(string-ref-lens [i exact-nonnegative-integer?]) lens?]{ @defproc[(string-ref-lens [i exact-nonnegative-integer?]) lens?]{
Returns a lens for viewing the @racket[i]th character of a string. Returns a lens for viewing the @racket[i]th character of a string.
@lenses-examples[ @lens-examples[
(lens-view (string-ref-lens 2) "abcdef") (lens-view (string-ref-lens 2) "abcdef")
(lens-set (string-ref-lens 2) "abcdef" #\C) (lens-set (string-ref-lens 2) "abcdef" #\C)
]} ]}
@ -14,7 +14,7 @@ Returns a lens for viewing the @racket[i]th character of a string.
@defproc[(string-pick-lens [i exact-nonnegative-integer?]) lens?]{ @defproc[(string-pick-lens [i exact-nonnegative-integer?]) lens?]{
Like @racket[list-refs-lens], but for strings. Like @racket[list-refs-lens], but for strings.
Equivalent to @racket[(lens-join/string (string-ref-lens i) ...)]. Equivalent to @racket[(lens-join/string (string-ref-lens i) ...)].
@lenses-examples[ @lens-examples[
(define 1-5-6-lens (string-pick-lens 1 5 6)) (define 1-5-6-lens (string-pick-lens 1 5 6))
(lens-view 1-5-6-lens "abcdefg") (lens-view 1-5-6-lens "abcdefg")
(lens-set 1-5-6-lens "abcdefg" "BFG") (lens-set 1-5-6-lens "abcdefg" "BFG")

2
lens/private/struct/field.scrbl
View File

@ -6,7 +6,7 @@
@defform[(struct-lens struct-id field-id)]{ @defform[(struct-lens struct-id field-id)]{
Returns a lens for viewing the @racket[field-id] field of Returns a lens for viewing the @racket[field-id] field of
a @racket[struct-id] instance. a @racket[struct-id] instance.
@lenses-examples[ @lens-examples[
(struct foo (a b c) #:transparent) (struct foo (a b c) #:transparent)
(lens-view (struct-lens foo a) (foo 1 2 3)) (lens-view (struct-lens foo a) (foo 1 2 3))
(lens-set (struct-lens foo a) (foo 1 2 3) 100) (lens-set (struct-lens foo a) (foo 1 2 3) 100)

4
lens/private/struct/struct.scrbl
View File

@ -5,7 +5,7 @@
@defform[(define-struct-lenses struct-id)]{ @defform[(define-struct-lenses struct-id)]{
Given a @racket[struct-id], defines a lens for each of its fields. Given a @racket[struct-id], defines a lens for each of its fields.
@lenses-examples[ @lens-examples[
(struct foo (a b c) #:transparent) (struct foo (a b c) #:transparent)
(define-struct-lenses foo) (define-struct-lenses foo)
(lens-view foo-a-lens (foo 1 2 3)) (lens-view foo-a-lens (foo 1 2 3))
@ -14,7 +14,7 @@
@defform[(struct/lens struct-id (field-spec ...) struct-option ...)]{ @defform[(struct/lens struct-id (field-spec ...) struct-option ...)]{
Equivalent to @racket[struct] and @racket[define-struct-lenses] combined. Equivalent to @racket[struct] and @racket[define-struct-lenses] combined.
@lenses-examples[ @lens-examples[
(struct/lens foo (a b c) #:transparent) (struct/lens foo (a b c) #:transparent)
(lens-view foo-a-lens (foo 1 2 3)) (lens-view foo-a-lens (foo 1 2 3))
(lens-set foo-a-lens (foo 1 2 3) 100) (lens-set foo-a-lens (foo 1 2 3) 100)

2
lens/private/vector/nested.scrbl
View File

@ -6,7 +6,7 @@
@defproc[(vector-ref-nested-lens [i exact-nonnegative-integer?] ...) lens?]{ @defproc[(vector-ref-nested-lens [i exact-nonnegative-integer?] ...) lens?]{
Like @racket[list-ref-nested-lens], but for vectors. Like @racket[list-ref-nested-lens], but for vectors.
Equivalent to @racket[(lens-thrush (vector-ref-lens i) ...)]. Equivalent to @racket[(lens-thrush (vector-ref-lens i) ...)].
@lenses-examples[ @lens-examples[
(lens-view (vector-ref-nested-lens 2 1) #(a b #(s i) d)) (lens-view (vector-ref-nested-lens 2 1) #(a b #(s i) d))
(lens-set (vector-ref-nested-lens 2 1) #(a b #(s i) d) "eye") (lens-set (vector-ref-nested-lens 2 1) #(a b #(s i) d) "eye")
]} ]}

2
lens/private/vector/pick.scrbl
View File

@ -6,7 +6,7 @@
@defproc[(vector-pick-lens [i exact-nonnegative-integer?] ...) lens?]{ @defproc[(vector-pick-lens [i exact-nonnegative-integer?] ...) lens?]{
Like @racket[list-refs-lens], but for vectors. Like @racket[list-refs-lens], but for vectors.
Equivalent to @racket[(lens-join/vector (vector-ref-lens i) ...)]. Equivalent to @racket[(lens-join/vector (vector-ref-lens i) ...)].
@lenses-examples[ @lens-examples[
(define 1-5-6-lens (vector-pick-lens 1 5 6)) (define 1-5-6-lens (vector-pick-lens 1 5 6))
(lens-view 1-5-6-lens #(a b c d e f g)) (lens-view 1-5-6-lens #(a b c d e f g))
(lens-set 1-5-6-lens #(a b c d e f g) #(1 2 3)) (lens-set 1-5-6-lens #(a b c d e f g) #(1 2 3))

2
lens/private/vector/ref.scrbl
View File

@ -5,7 +5,7 @@
@defproc[(vector-ref-lens [i exact-nonnegative-integer?]) lens?]{ @defproc[(vector-ref-lens [i exact-nonnegative-integer?]) lens?]{
Returns a lens that views an element of a vector. Returns a lens that views an element of a vector.
@lenses-examples[ @lens-examples[
(lens-view (vector-ref-lens 2) #(a b c d)) (lens-view (vector-ref-lens 2) #(a b c d))
(lens-set (vector-ref-lens 2) #(a b c d) "sea") (lens-set (vector-ref-lens 2) #(a b c d) "sea")
]} ]}

6
unstable/lens/arrow.scrbl
View File

@ -16,7 +16,7 @@ switched, so that the @racket[target] comes first and the
@racket[(lens-view (lens-thrush lens ...) target)], but can be more @racket[(lens-view (lens-thrush lens ...) target)], but can be more
efficient. efficient.
The function @racket[lens-view~>] is provided as a shorter version. The function @racket[lens-view~>] is provided as a shorter version.
@lenses-unstable-examples[ @lens-unstable-examples[
(lens-view/thrush '(a b ((c d) e f) g) third-lens first-lens second-lens) (lens-view/thrush '(a b ((c d) e f) g) third-lens first-lens second-lens)
(lens-view~> '(a b ((c d) e f) g) third-lens first-lens second-lens) (lens-view~> '(a b ((c d) e f) g) third-lens first-lens second-lens)
]} ]}
@ -28,7 +28,7 @@ which again are combined into a nested lens.
@racket[(lens-set/thrush target lens ... #:-> new-view)] is equivalent @racket[(lens-set/thrush target lens ... #:-> new-view)] is equivalent
to @racket[(lens-set (lens-thrush lens ...) target new-view)], and to @racket[(lens-set (lens-thrush lens ...) target new-view)], and
@racket[lens-set~>] is the shorter version. @racket[lens-set~>] is the shorter version.
@lenses-unstable-examples[ @lens-unstable-examples[
(lens-set/thrush '(a b ((c d) e f) g) third-lens first-lens second-lens #:-> "sea") (lens-set/thrush '(a b ((c d) e f) g) third-lens first-lens second-lens #:-> "sea")
(lens-set~> '(a b ((c d) e f) g) third-lens first-lens second-lens #:-> "sea") (lens-set~> '(a b ((c d) e f) g) third-lens first-lens second-lens #:-> "sea")
]} ]}
@ -45,7 +45,7 @@ just like @racket[lens-set/thrush].
equivalent to equivalent to
@racket[(lens-transform (lens-thrush lens ...) target transformer)], @racket[(lens-transform (lens-thrush lens ...) target transformer)],
and @racket[lens-transform~>] is the shorter verison. and @racket[lens-transform~>] is the shorter verison.
@lenses-unstable-examples[ @lens-unstable-examples[
(lens-transform/thrush '(a b ((c d) e f) g) third-lens first-lens second-lens #:-> symbol->string) (lens-transform/thrush '(a b ((c d) e f) g) third-lens first-lens second-lens #:-> symbol->string)
(lens-transform~> '(a b ((c d) e f) g) third-lens first-lens second-lens #:-> symbol->string) (lens-transform~> '(a b ((c d) e f) g) third-lens first-lens second-lens #:-> symbol->string)
]} ]}

6
unstable/lens/if.scrbl
View File

@ -13,7 +13,7 @@
Creates a lens that uses @racket[lens1] when the target satisfies Creates a lens that uses @racket[lens1] when the target satisfies
@racket[pred], and uses @racket[lens2] when the target doesn't satisfy @racket[pred], and uses @racket[lens2] when the target doesn't satisfy
@racket[pred]. @racket[pred].
@lenses-unstable-examples[ @lens-unstable-examples[
(define if-lens (lens-if list? first-lens (vector-ref-lens 0))) (define if-lens (lens-if list? first-lens (vector-ref-lens 0)))
(lens-view if-lens '(1 2 3)) (lens-view if-lens '(1 2 3))
(lens-view if-lens '#(1 2 3)) (lens-view if-lens '#(1 2 3))
@ -27,7 +27,7 @@ Creates a lens that uses @racket[lens1] when the target satisfies
Like @racket[lens-if], but based on @racket[cond] instead of Like @racket[lens-if], but based on @racket[cond] instead of
@racket[if]. It creates a lens that uses the first lens if the target matches the first @racket[if]. It creates a lens that uses the first lens if the target matches the first
predicate, the second lens if the target matches the second predicate, and so on. predicate, the second lens if the target matches the second predicate, and so on.
@lenses-unstable-examples[ @lens-unstable-examples[
(define cond-lens (lens-cond [list? first-lens] (define cond-lens (lens-cond [list? first-lens]
[vector? (vector-ref-lens 0)] [vector? (vector-ref-lens 0)]
[string? (string-ref-lens 0)])) [string? (string-ref-lens 0)]))
@ -45,7 +45,7 @@ matching the target against each @racket[pat] with @racket[match].
It creates a lens that uses the first lens if the target matches the It creates a lens that uses the first lens if the target matches the
first @racket[pat], the second lens if it matches the second first @racket[pat], the second lens if it matches the second
@racket[pat], and so on. @racket[pat], and so on.
@lenses-unstable-examples[ @lens-unstable-examples[
(define lens (lens-match [(list a) first-lens] (define lens (lens-match [(list a) first-lens]
[(list a b) second-lens])) [(list a b) second-lens]))
(lens-view lens '(1)) (lens-view lens '(1))

2
unstable/lens/isomorphism.scrbl
View File

@ -17,7 +17,7 @@ So for instance a @racket[symbol->string-lens] could be defined with:
(define symbol->string-lens (define symbol->string-lens
(make-isomorphism-lens symbol->string string->symbol)) (make-isomorphism-lens symbol->string string->symbol))
] ]
@lenses-unstable-examples[ @lens-unstable-examples[
(lens-view symbol->string-lens 'something) (lens-view symbol->string-lens 'something)
(lens-transform symbol->string-lens 'something (λ (s) (string-append "make-" s))) (lens-transform symbol->string-lens 'something (λ (s) (string-append "make-" s)))
]} ]}

4
unstable/lens/mapper.scrbl
View File

@ -8,7 +8,7 @@
@defproc[(mapper-lens [lens lens?]) lens?]{ @defproc[(mapper-lens [lens lens?]) lens?]{
Creates a lens that maps @racket[lens] over a target list. Creates a lens that maps @racket[lens] over a target list.
@lenses-unstable-examples[ @lens-unstable-examples[
(lens-view (mapper-lens first-lens) '((a b) (c d) (e f))) (lens-view (mapper-lens first-lens) '((a b) (c d) (e f)))
(lens-set (mapper-lens first-lens) '((a b) (c d) (e f)) '(1 2 3)) (lens-set (mapper-lens first-lens) '((a b) (c d) (e f)) '(1 2 3))
(lens-transform (mapper-lens first-lens) '((a b) (c d) (e f)) (λ (xs) (map symbol->string xs))) (lens-transform (mapper-lens first-lens) '((a b) (c d) (e f)) (λ (xs) (map symbol->string xs)))
@ -16,7 +16,7 @@ Creates a lens that maps @racket[lens] over a target list.
@defproc[(vector-mapper-lens [lens lens?]) lens?]{ @defproc[(vector-mapper-lens [lens lens?]) lens?]{
Creates a lens that maps @racket[lens] over a target vector with @racket[vector-map]. Creates a lens that maps @racket[lens] over a target vector with @racket[vector-map].
@lenses-unstable-examples[ @lens-unstable-examples[
(lens-view (vector-mapper-lens first-lens) '#((a b) (c d) (e f))) (lens-view (vector-mapper-lens first-lens) '#((a b) (c d) (e f)))
(lens-set (vector-mapper-lens first-lens) '#((a b) (c d) (e f)) '#(1 2 3)) (lens-set (vector-mapper-lens first-lens) '#((a b) (c d) (e f)) '#(1 2 3))
(lens-transform (vector-mapper-lens first-lens) '#((a b) (c d) (e f)) (lens-transform (vector-mapper-lens first-lens) '#((a b) (c d) (e f))

2
unstable/lens/match.scrbl
View File

@ -10,7 +10,7 @@ Creates a lens for viewing the @racket[id] within the @racket[pattern].
The @racket[replacement] expression should be an expression such that The @racket[replacement] expression should be an expression such that
@racket[(match target [pattern replacement])] produces a value equivalent to @racket[(match target [pattern replacement])] produces a value equivalent to
@racket[target], and should use @racket[id] as the view. @racket[target], and should use @racket[id] as the view.
@lenses-unstable-examples[ @lens-unstable-examples[
(define car-lens (match-lens a (cons a b) (cons a b))) (define car-lens (match-lens a (cons a b) (cons a b)))
(define cdr-lens (match-lens b (cons a b) (cons a b))) (define cdr-lens (match-lens b (cons a b) (cons a b)))
(define third-lens (match-lens c (list a b c d ...) (list* a b c d))) (define third-lens (match-lens c (list a b c d ...) (list* a b c d)))

4
unstable/lens/set-filterer.scrbl
View File

@ -8,14 +8,14 @@
@defproc[(set-filterer-lens [pred (-> any/c any/c)]) (lens/c functional-set? functional-set?)]{ @defproc[(set-filterer-lens [pred (-> any/c any/c)]) (lens/c functional-set? functional-set?)]{
Creates a lens that filters a set by the predicate @racket[pred]. Creates a lens that filters a set by the predicate @racket[pred].
@lenses-unstable-examples[ @lens-unstable-examples[
(lens-view (set-filterer-lens number?) (set 1 'a 2 'b 'c 3 'd 'e)) (lens-view (set-filterer-lens number?) (set 1 'a 2 'b 'c 3 'd 'e))
(lens-set (set-filterer-lens number?) (set 1 'a 2 'b 'c 3 'd 'e) (set 4 5 6 7)) (lens-set (set-filterer-lens number?) (set 1 'a 2 'b 'c 3 'd 'e) (set 4 5 6 7))
] ]
Lists are also sets, so @racket[set-filterer-lens] works for lists too, but it Lists are also sets, so @racket[set-filterer-lens] works for lists too, but it
does not preserve ordering. It follows the lens laws only if you compare using does not preserve ordering. It follows the lens laws only if you compare using
@racket[set=?], not @racket[equal?]. @racket[set=?], not @racket[equal?].
@lenses-unstable-examples[ @lens-unstable-examples[
(lens-view (set-filterer-lens number?) '(a 1 2 3)) ; will be '(1 2 3) (lens-view (set-filterer-lens number?) '(a 1 2 3)) ; will be '(1 2 3)
(lens-set (set-filterer-lens number?) '(a 1 2 3) '(1 2 3)) ; will be '(3 2 1 a) (lens-set (set-filterer-lens number?) '(a 1 2 3) '(1 2 3)) ; will be '(3 2 1 a)
(code:comment "this breaks the lens laws according to equal?") (code:comment "this breaks the lens laws according to equal?")

4
unstable/lens/string-split.scrbl
View File

@ -9,7 +9,7 @@
@defproc[(string-split-lens [sep (or/c string? char? regexp?)]) lens?]{ @defproc[(string-split-lens [sep (or/c string? char? regexp?)]) lens?]{
Creates a lens that splits a string into multiple pieces like Creates a lens that splits a string into multiple pieces like
@racket[regexp-split] or @racket[string-split]. @racket[regexp-split] or @racket[string-split].
@lenses-unstable-examples[ @lens-unstable-examples[
(lens-view (string-split-lens ",") "a,b,c") (lens-view (string-split-lens ",") "a,b,c")
(lens-set (string-split-lens ",") "a,b,c" '("1" "2" "3")) (lens-set (string-split-lens ",") "a,b,c" '("1" "2" "3"))
] ]
@ -18,7 +18,7 @@ when viewing a target that either starts or ends with something matching
@racket[sep], the view will include empty strings as the first or last element, @racket[sep], the view will include empty strings as the first or last element,
which is consistant with @racket[regexp-split] or @racket[string-split] with which is consistant with @racket[regexp-split] or @racket[string-split] with
@racket[#:trim? #f]. This is also more useful when using @racket[lens-set]. @racket[#:trim? #f]. This is also more useful when using @racket[lens-set].
@lenses-unstable-examples[ @lens-unstable-examples[
(lens-view (string-split-lens ",") ",b,c") (lens-view (string-split-lens ",") ",b,c")
(lens-set (string-split-lens ",") ",b,c" '("a" "b" "c")) (lens-set (string-split-lens ",") ",b,c" '("a" "b" "c"))
(lens-view (string-split-lens ",") "a,b,c,") (lens-view (string-split-lens ",") "a,b,c,")

4
unstable/lens/struct-join.scrbl
View File

@ -12,7 +12,7 @@
Like @racket[lens-join/list], except that the views of the given Like @racket[lens-join/list], except that the views of the given
lenses are put in an instance of the @racket[struct-id] struct instead lenses are put in an instance of the @racket[struct-id] struct instead
of in a list. of in a list.
@lenses-unstable-examples[ @lens-unstable-examples[
(struct foo (a b) #:transparent) (struct foo (a b) #:transparent)
(define lens (lens-join/struct foo first-lens third-lens)) (define lens (lens-join/struct foo first-lens third-lens))
(lens-view lens '(1 2 3)) (lens-view lens '(1 2 3))
@ -21,7 +21,7 @@ of in a list.
Struct fields in a @racket[lens-join/struct] form can also be Struct fields in a @racket[lens-join/struct] form can also be
specified by keywords, in any order, and even with some fields specied specified by keywords, in any order, and even with some fields specied
by position and some by keywords: by position and some by keywords:
@lenses-unstable-examples[ @lens-unstable-examples[
(struct foo (a b) #:transparent) (struct foo (a b) #:transparent)
(lens-view (lens-join/struct foo first-lens third-lens) '(1 2 3)) (lens-view (lens-join/struct foo first-lens third-lens) '(1 2 3))
(lens-view (lens-join/struct foo #:a first-lens #:b third-lens) '(1 2 3)) (lens-view (lens-join/struct foo #:a first-lens #:b third-lens) '(1 2 3))

4
unstable/lens/struct-nested.scrbl
View File

@ -6,7 +6,7 @@
@defmodule[unstable/lens/struct-nested] @defmodule[unstable/lens/struct-nested]
@(define-persistant-lenses-unstable-examples struct-nested-examples) @(persistent-lens-unstable-examples struct-nested-examples)
@defform[#:id struct-nested-lens @defform[#:id struct-nested-lens
(struct-nested-lens [struct-id field-id] ...)]{ (struct-nested-lens [struct-id field-id] ...)]{
@ -36,7 +36,7 @@
(lens-set game-player-health-lens the-game 20) (lens-set game-player-health-lens the-game 20)
]} ]}
@(define-persistant-lenses-unstable-examples struct-nested*-examples) @(persistent-lens-unstable-examples struct-nested*-examples)
@defform[#:id struct-nested-lens* @defform[#:id struct-nested-lens*
(struct-nested-lens* struct-id both-id ... field-id)]{ (struct-nested-lens* struct-id both-id ... field-id)]{

2
unstable/lens/sublist.scrbl
View File

@ -7,7 +7,7 @@
@defmodule[unstable/lens/sublist] @defmodule[unstable/lens/sublist]
@defproc[(sublist-lens [i exact-nonnegative-integer?] [j exact-nonnegative-integer?]) lens?]{ @defproc[(sublist-lens [i exact-nonnegative-integer?] [j exact-nonnegative-integer?]) lens?]{
@lenses-unstable-examples[ @lens-unstable-examples[
(lens-view (sublist-lens 1 4) '(0 1 2 3 4 5)) (lens-view (sublist-lens 1 4) '(0 1 2 3 4 5))
(lens-set (sublist-lens 1 4) '(0 1 2 3 4 5) '(a b c)) (lens-set (sublist-lens 1 4) '(0 1 2 3 4 5) '(a b c))
]} ]}

6
unstable/lens/syntax.scrbl
View File

@ -11,7 +11,7 @@
Constructs a lens that parses a syntax object and returns Constructs a lens that parses a syntax object and returns
a piece of that syntax object as determined by where a piece of that syntax object as determined by where
@racket[target-id] appears in @racket[structure]. @racket[target-id] appears in @racket[structure].
@lenses-unstable-examples[ @lens-unstable-examples[
(define first-of-second-stx-lens (define first-of-second-stx-lens
(syntax-lens A (syntax-lens A
(_ (A _ ...) _ ...))) (_ (A _ ...) _ ...)))
@ -28,7 +28,7 @@
and views a syntax object containing all the terms in the and views a syntax object containing all the terms in the
target syntax that appear after @racket[kw] but before any target syntax that appear after @racket[kw] but before any
other keyword. other keyword.
@lenses-unstable-examples[ @lens-unstable-examples[
(define foo-kw-seq-lens (syntax-keyword-seq-lens '#:foo)) (define foo-kw-seq-lens (syntax-keyword-seq-lens '#:foo))
(lens-view foo-kw-seq-lens #'(a #:foo c d #:bar f)) (lens-view foo-kw-seq-lens #'(a #:foo c d #:bar f))
(lens-set foo-kw-seq-lens #'(a #:foo c d #:bar f) #'(1 2 3 4 5 6)) (lens-set foo-kw-seq-lens #'(a #:foo c d #:bar f) #'(1 2 3 4 5 6))
@ -39,7 +39,7 @@
object or immediately followed by another keyword, then viewing object or immediately followed by another keyword, then viewing
produces the empty list syntax object @racket[#'()]. In the case produces the empty list syntax object @racket[#'()]. In the case
where @racket[kw] is not present, setting is a no-op. where @racket[kw] is not present, setting is a no-op.
@lenses-unstable-examples[ @lens-unstable-examples[
(define foo-kw-seq-lens (syntax-keyword-seq-lens '#:foo)) (define foo-kw-seq-lens (syntax-keyword-seq-lens '#:foo))
(lens-view foo-kw-seq-lens #'(a b f g)) (lens-view foo-kw-seq-lens #'(a b f g))
(lens-view foo-kw-seq-lens #'(a #:foo #:bar f)) (lens-view foo-kw-seq-lens #'(a #:foo #:bar f))

2
unstable/lens/view-set.scrbl
View File

@ -7,7 +7,7 @@
@defproc[(lens-set-all [target any/c] [new-view any/c] [lens lens?] ...) any/c]{ @defproc[(lens-set-all [target any/c] [new-view any/c] [lens lens?] ...) any/c]{
Sets the view of @racket[target] through each @racket[lens] to @racket[new--view] Sets the view of @racket[target] through each @racket[lens] to @racket[new--view]
@lenses-unstable-examples[ @lens-unstable-examples[
(lens-set-all '(1 2 3 4 5) 'a (lens-set-all '(1 2 3 4 5) 'a
first-lens first-lens
third-lens third-lens