Compare commits

..

No commits in common. 'master' and 'dev-fixit' have entirely different histories.

@ -1,43 +0,0 @@
name: CI
on: [push, pull_request]
jobs:
run:
name: "Build using Racket '${{ matrix.racket-version }}' (${{ matrix.racket-variant }})"
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
racket-version: ["6.6", "6.7", "6.8", "6.9", "6.10.1", "6.11", "6.12", "7.0", "7.1", "7.2", "7.3", "7.4", "7.5", "7.6", "7.7", "7.8", "7.9", "current"]
racket-variant: ["BC", "CS"]
# CS builds are only provided for versions 7.4 and up so avoid
# running the job for prior versions.
exclude:
- {racket-version: "6.6", racket-variant: "CS"}
- {racket-version: "6.7", racket-variant: "CS"}
- {racket-version: "6.8", racket-variant: "CS"}
- {racket-version: "6.9", racket-variant: "CS"}
- {racket-version: "6.10.1", racket-variant: "CS"}
- {racket-version: "6.11", racket-variant: "CS"}
- {racket-version: "6.12", racket-variant: "CS"}
- {racket-version: "7.0", racket-variant: "CS"}
- {racket-version: "7.1", racket-variant: "CS"}
- {racket-version: "7.2", racket-variant: "CS"}
- {racket-version: "7.3", racket-variant: "CS"}
steps:
- name: Checkout
uses: actions/checkout@master
- uses: Bogdanp/setup-racket@v0.11
with:
distribution: 'full'
version: ${{ matrix.racket-version }}
variant: ${{ matrix.racket-variant }}
- name: Install Txexpr and its dependencies
run: raco pkg install --auto --batch
- name: Run the tests
run: xvfb-run raco test -j 4 -p txexpr

2
.gitignore vendored

@ -1,7 +1,5 @@
# for Racket # for Racket
compiled/ compiled/
doc/
*~
# for Mac OS X # for Mac OS X
.DS_Store .DS_Store

@ -0,0 +1,37 @@
# adapted from
# https://github.com/greghendershott/travis-racket/blob/master/.travis.yml
# Thanks Greg!
language: c
sudo: false
env:
global:
- RACKET_DIR=~/racket
matrix:
- RACKET_VERSION=6.0
- RACKET_VERSION=6.1
- RACKET_VERSION=6.2
- RACKET_VERSION=6.3
- RACKET_VERSION=6.4
- RACKET_VERSION=HEAD
# You may want to test against certain versions of Racket, without
# having them count against the overall success/failure.
matrix:
allow_failures:
# - env: RACKET_VERSION=HEAD
# Fast finish: Overall build result is determined as soon as any of
# its rows have failed, or, all of its rows that aren't allowed to
# fail have succeeded.
fast_finish: true
before_install:
- git clone https://github.com/mbutterick/travis-racket.git
- cat travis-racket/install-racket.sh | bash # pipe to bash not sh!
- export PATH="${RACKET_DIR}/bin:${PATH}" #install-racket.sh can't set for us
script:
- cd .. # Travis did a cd into the dir. Back up, for the next:
- raco pkg install --deps search-auto --link txexpr
- raco test -p txexpr

@ -0,0 +1,165 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.
"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.
A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".
The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.
The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.
1. Exception to Section 3 of the GNU GPL.
You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.
2. Conveying Modified Versions.
If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:
a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or
b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.
3. Object Code Incorporating Material from Library Header Files.
The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:
a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the object code with a copy of the GNU GPL and this license
document.
4. Combined Works.
You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:
a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.
c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.
d) Do one of the following:
0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.
1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.
e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)
5. Combined Libraries.
You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:
a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.
b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.
6. Revised Versions of the GNU Lesser General Public License.
The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.
If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.

@ -1,9 +0,0 @@
MIT License for txexpr
© 2014-2019 Matthew Butterick
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

@ -1,5 +1,5 @@
## txexpr ![Build Status](https://github.com/mbutterick/txexpr/workflows/CI/badge.svg) txexpr [![Build Status](https://travis-ci.org/mbutterick/txexpr.svg)](https://travis-ci.org/mbutterick/txexpr)
---------------
Convenience functions for working with HTML-style tagged X-expressions in Racket 6.0+. Convenience functions for working with HTML-style tagged X-expressions in Racket 6.0+.
@ -16,12 +16,3 @@ In safe mode (with contracts):
(require (submod txexpr safe)) (require (submod txexpr safe))
Full docs are installed with the package. You can also [read the docs here](http://pkg-build.racket-lang.org/doc/txexpr). Full docs are installed with the package. You can also [read the docs here](http://pkg-build.racket-lang.org/doc/txexpr).
## License
MIT
## Project status
Complete. I will maintain the code but no major updates are planned. Certain aspects of the API and implementation could be better, because much of this code was originally written during a more naive era of personal Racketeering. Still, it gets the job done, and I personally lack enthusiasm for diving back in.

@ -0,0 +1,349 @@
#lang racket/base
(require sugar/define sugar/coerce sugar/list racket/string racket/list racket/match xml rackunit)
(provide cdata? cdata valid-char? xexpr->string xexpr?) ; from xml
(provide empty) ; from racket/list
;; Section 2.2 of XML 1.1
;; (XML 1.0 is slightly different and more restrictive)
;; make private version of my-valid-char to get consistent results with Racket 6.0
(define (my-valid-char? i)
(and (exact-nonnegative-integer? i)
(or (<= #x1 i #xD7FF)
(<= #xE000 i #xFFFD)
(<= #x10000 i #x10FFFF))))
(define (my-xexpr? x)
(or (txexpr? x) (xexpr? x) (my-valid-char? x)))
(define+provide+safe (txexpr? x #:short-only? [short-only #f])
predicate/c
(define short-sym 'short)
(and (pair? x)
(txexpr-tag? (car x))
(let ([result (or (and (empty? (cdr x)) short-sym)
;; separate the my-xexpr? tail match from the rest.
;; as a recursive operation, it's potentially time-consuming.
(and (andmap my-xexpr? (cddr x))
(match (cadr x)
[(list (? txexpr-attr?) ...) #t]
[(? my-xexpr?) short-sym]
[else #f])))])
(and result (if short-only
(eq? result short-sym)
#t)))))
(define+provide+safe (txexpr-short? x)
predicate/c
(txexpr? x #:short-only? #t))
(define+provide+safe (txexpr-tag? x)
predicate/c
(symbol? x))
(define+provide+safe (txexpr-tags? x)
predicate/c
(and (list? x) (andmap txexpr-tag? x)))
(define+provide+safe (txexpr-attr? x)
predicate/c
(match x
[(list (? symbol?) (? string?)) #t]
[else #f]))
(define+provide+safe (txexpr-element? x)
predicate/c
(my-xexpr? x))
(define+provide+safe (txexpr-attr-key? x)
predicate/c
(symbol? x))
(define+provide+safe (can-be-txexpr-attr-key? x)
predicate/c
(or (symbol? x) (string? x)))
(define+provide+safe (txexpr-attr-value? x)
predicate/c
(string? x))
(define+provide+safe (can-be-txexpr-attr-value? x)
predicate/c
(or (symbol? x) (string? x)))
(define-syntax-rule (define-plural plural-id pred)
(define+provide+safe (plural-id x)
predicate/c
(and (list? x) (andmap pred x))))
(define-plural txexpr-attrs? txexpr-attr?)
(define-plural txexpr-elements? txexpr-element?)
(define-plural txexpr-attr-values? txexpr-attr-value?)
(define-plural list-of-can-be-txexpr-attrs? can-be-txexpr-attrs?)
(define+provide+safe (can-be-txexpr-attrs? x)
predicate/c
(ormap (λ(test) (test x)) (list txexpr-attr?
txexpr-attrs?
can-be-txexpr-attr-key?
can-be-txexpr-attr-value?)))
(define (validate-txexpr-attrs x #:context [txexpr-context #f])
(define (make-reason)
(if (not (list? x))
(format "because ~v is not a list" x)
(let ([bad-attrs (filter (λ(i) (not (txexpr-attr? i))) x)])
(format "because ~a ~a" (string-join (map (λ(ba) (format "~v" ba)) bad-attrs) " and ")
(if (> (length bad-attrs) 1)
"are not valid attributes"
"is not in the form '(symbol \"string\")")))))
(cond
[(and (list? x) (> (length x) 0) (andmap txexpr-attr? x)) x]
[else (error (string-append "validate-txexpr-attrs: "
(if txexpr-context (format "in ~v, " txexpr-context) "")
(format "~v is not a valid list of attributes ~a" x
(make-reason))))]))
(define (validate-txexpr-element x #:context [txexpr-context #f])
(cond
[(or (string? x) (txexpr? x) (symbol? x)
(valid-char? x) (cdata? x)) x]
[else (error (string-append "validate-txexpr-element: "
(if txexpr-context (format "in ~v, " txexpr-context) "")
(format "~v is not a valid element (must be txexpr, string, symbol, XML char, or cdata)" x)))]))
;; is it a named x-expression?
;; todo: rewrite this recurively so errors can be pinpointed (for debugging)
(define+provide+safe (validate-txexpr x)
(any/c . -> . txexpr?)
(define-syntax-rule (validate-txexpr-attrs-with-context e)
(validate-txexpr-attrs e #:context x))
(define-syntax-rule (validate-txexpr-element-with-context e)
(validate-txexpr-element e #:context x))
(cond
[(txexpr-short? x) x]
[(txexpr? x) (and
(validate-txexpr-attrs-with-context (get-attrs x))
(andmap (λ(e) (validate-txexpr-element-with-context e)) (get-elements x)) x)]
[(and (list? x) (symbol? (car x)))
(and
(andmap (λ(e) (validate-txexpr-element-with-context e)) (get-elements x))
(validate-txexpr-attrs-with-context (get-attrs x)))]
[(list? x) (error 'validate-txexpr (format "~v is a list but it doesn't start with a symbol" x))]
[else (error 'validate-txexpr (format "~v: not an X-expression" x))]))
(define+provide+safe (txexpr tag [attrs null] [elements null])
((symbol?) (txexpr-attrs? txexpr-elements?) . ->* . txexpr?)
(define result (cons tag (append (if (empty? attrs) empty (list attrs)) elements)))
(if (txexpr? result)
result
(error 'txexpr
(cond
[(not (txexpr-tag? tag))
(format "This is not a txexpr-tag: ~v" tag)]
[(not (txexpr-attrs? attrs))
(format "This is not a list of txexpr-attrs: ~v" attrs)]
[(not (txexpr-elements? elements))
(format "This is not a list of txexpr-elements: ~v" elements)]
[else ""]))))
(define make-txexpr txexpr) ; for backward compatability
(provide+safe make-txexpr)
(define+provide+safe (txexpr->values x)
(txexpr? . -> . (values symbol? txexpr-attrs? txexpr-elements?))
(if (txexpr-short? x)
(values (car x) '() (cdr x))
(values (car x) (cadr x) (cddr x))))
(define+provide+safe (txexpr->list x)
(txexpr? . -> . list?)
(define-values (tag attrs content) (txexpr->values x))
(list tag attrs content))
;; convenience functions to retrieve only one part of txexpr
(define+provide+safe (get-tag x)
(txexpr? . -> . txexpr-tag?)
(car x))
(define+provide+safe (get-attrs x)
(txexpr? . -> . txexpr-attrs?)
(define-values (tag attrs content) (txexpr->values x))
attrs)
(define+provide+safe (get-elements x)
(txexpr? . -> . txexpr-elements?)
(define-values (tag attrs elements) (txexpr->values x))
elements)
;; helpers. we are getting a string or symbol
(define+provide+safe (->txexpr-attr-key x)
(can-be-txexpr-attr-key? . -> . txexpr-attr-key?)
(->symbol x))
(define+provide+safe (->txexpr-attr-value x)
(can-be-txexpr-attr-value? . -> . txexpr-attr-value?)
(->string x))
(define identity (λ (x) x))
(define+provide+safe (attrs->hash #:hash-style? [hash-style-priority #f] . items-in)
(() (#:hash-style? boolean?) #:rest (listof can-be-txexpr-attrs?) . ->* . hash-eq?)
;; can be liberal with input because they're all just nested key/value pairs
;; but still need this function to make sure that 'foo and "foo" are treated as the same hash key
(define items (flatten items-in))
(unless (even? (length items))
(raise-argument-error 'attrs->hash "even number of arguments" items-in))
;; hasheq loop will overwrite earlier values with later.
;; but earlier attributes need priority (see https://www.w3.org/TR/xml/#attdecls)
;; thus reverse the pairs.
;; priority-inverted will defeat this assumption, and allow later attributes to overwrite earlier.
(for/hasheq ([sublist (in-list ((if hash-style-priority
identity
reverse) (slice-at items 2)))])
(let ([key (->txexpr-attr-key (first sublist))]
[value (->txexpr-attr-value (second sublist))])
(values key value))))
(define+provide+safe (hash->attrs attr-hash)
(hash? . -> . txexpr-attrs?)
(map flatten (hash->list attr-hash)))
(define+provide+safe (attrs-have-key? x key)
((or/c txexpr-attrs? txexpr?) can-be-txexpr-attr-key? . -> . boolean?)
(define attrs (if (txexpr-attrs? x) x (get-attrs x)))
(and (assq (->txexpr-attr-key key) attrs) #t))
(define+provide+safe (attr-set tx key value)
(txexpr? can-be-txexpr-attr-key? can-be-txexpr-attr-value? . -> . txexpr?)
(attr-set* tx key value))
(define+provide+safe (attr-set* tx . kvs)
((txexpr?) #:rest (listof (or/c can-be-txexpr-attr-key? can-be-txexpr-attr-value?)) . ->* . txexpr?)
;; unlike others, this uses hash operations to guarantee that your attr-set
;; is the only one remaining.
(unless (even? (length kvs))
(raise-argument-error 'attr-set* "even number of arguments" kvs))
(define new-attrs
(hash->attrs
(apply hash-set* (attrs->hash (get-attrs tx))
(append-map (λ(sublist)
(list (->txexpr-attr-key (first sublist))
(->txexpr-attr-value (second sublist)))) (slice-at kvs 2)))))
(txexpr (get-tag tx) new-attrs (get-elements tx)))
(define+provide+safe (attr-join tx key value)
(txexpr? can-be-txexpr-attr-key? can-be-txexpr-attr-value? . -> . txexpr?)
(define starting-values (string-split (if (attrs-have-key? tx key)
(attr-ref tx key)
"")))
(attr-set tx key (string-join `(,@starting-values ,value) " ")))
(define+provide+safe (attr-ref tx key [failure-result (λ _ (raise (make-exn:fail:contract (format "attr-ref: no value found for key ~v" key) (current-continuation-marks))))])
((txexpr? can-be-txexpr-attr-key?) (any/c) . ->* . any)
(define result (assq (->txexpr-attr-key key) (get-attrs tx)))
(if result
(second result)
(if (procedure? failure-result)
(failure-result)
failure-result)))
(define+provide+safe (remove-attrs x)
(txexpr? . -> . txexpr?)
(let loop ([x x])
(if (txexpr? x)
(let-values ([(tag attr elements) (txexpr->values x)])
(txexpr tag null (map loop elements)))
x)))
(define+provide+safe (map-elements proc x)
(procedure? txexpr? . -> . txexpr?)
(proc (if (txexpr? x)
(let-values ([(tag attr elements) (txexpr->values x)])
(txexpr tag attr (map (λ(e)(map-elements proc e)) elements)))
x)))
;; function to split tag out of txexpr
(define deleted-signal (gensym))
(define+provide+safe (splitf-txexpr tx pred [proc (λ(x) deleted-signal)])
((txexpr? procedure?) (procedure?) . ->* . (values txexpr? txexpr-elements?))
(define matches null)
(define (do-extraction x)
(cond
[(pred x) (begin ; store matched item and return processed value
(set! matches (cons x matches))
(proc x))]
[(txexpr? x) (let-values([(tag attr elements) (txexpr->values x)])
(txexpr tag attr (filter (λ(e) (not (equal? e deleted-signal)))
(map do-extraction elements))))]
[else x]))
(define tx-extracted (do-extraction tx)) ;; do this first to fill matches
(unless (txexpr? tx-extracted)
(error 'splitf-txexpr "Bad input"))
(values tx-extracted (reverse matches)))
(define+provide+safe (findf*-txexpr tx pred)
(txexpr? procedure? . -> . (or/c #f txexpr-elements?))
(define-values (_ matches) (splitf-txexpr tx pred))
(and (pair? matches) matches))
(define+provide+safe (findf-txexpr tx pred)
(txexpr? procedure? . -> . (or/c #f txexpr-element?))
(define matches (findf*-txexpr tx pred))
(and matches (car matches)))
(define+provide+safe (xexpr->html x)
(xexpr? . -> . string?)
(define (->cdata x)
(cond
[(cdata? x) x]
; don't use "![CDATA[...]]" wrapper in HTML, it's not consistent with the spec
[(string? x) (cdata #f #f x)]
[else x]))
(xexpr->string (let loop ([x x])
(cond
[(txexpr? x) (if (member (get-tag x) '(script style))
(txexpr (get-tag x) (get-attrs x)
(map ->cdata (get-elements x)))
(txexpr (get-tag x) (get-attrs x)
(map loop (get-elements x))))]
[else x]))))

@ -1,16 +1,5 @@
#lang racket/base #lang racket/base
(require sugar/define racket/match "base.rkt" rackunit) (require sugar/define "base.rkt" rackunit)
(define (stringify-attr attr)
(match attr
[(list key val) (string-append (symbol->string key) val)]))
(define (sort-attrs x)
(match x
[(? txexpr?)
(let-values ([(tag attr elements) (txexpr->values x)])
(txexpr tag (sort attr #:key stringify-attr #:cache-keys? #t string<?) (map sort-attrs elements)))]
[_ x]))
(define (txexprs-equal? tx1 tx2) (define (txexprs-equal? tx1 tx2)
;; txexprs are deemed equal if they differ only in the ordering of attributes. ;; txexprs are deemed equal if they differ only in the ordering of attributes.
@ -21,11 +10,21 @@
;; so the whole attr is converted into a single string for sorting, which lets the attr value act as a tiebreaker. ;; so the whole attr is converted into a single string for sorting, which lets the attr value act as a tiebreaker.
;; it doesn't matter that this sort may not be correct (in the sense of a desirable ordering) ;; it doesn't matter that this sort may not be correct (in the sense of a desirable ordering)
;; it just needs to be stable (e.g., a certain set of attrs will always sort the same way) ;; it just needs to be stable (e.g., a certain set of attrs will always sort the same way)
(equal? (sort-attrs tx1) (sort-attrs tx2))) (letrec ([stringify-attr (λ(attr) (string-append (symbol->string (car attr)) (cadr attr)))]
[sort-attrs (λ(x)
(if (txexpr? x)
(let-values ([(tag attr elements) (txexpr->values x)])
(txexpr tag (sort attr #:key stringify-attr #:cache-keys? #t string<?) (map sort-attrs elements)))
x))])
(equal? (sort-attrs tx1) (sort-attrs tx2))))
(define+provide+safe (attrs-equal? x1 x2) (define+provide+safe (attrs-equal? x1 x2)
((or/c txexpr-attrs? txexpr?) (or/c txexpr-attrs? txexpr?) . -> . boolean?) ((or/c txexpr-attrs? txexpr?) (or/c txexpr-attrs? txexpr?) . -> . boolean?)
(apply txexprs-equal? (map (λ (x) `(_ ,(if (txexpr-attrs? x) x (get-attrs x)))) (list x1 x2)))) (define attrs-tx1 (if (txexpr-attrs? x1) x1 (get-attrs x1)))
(define attrs-tx2 (if (txexpr-attrs? x2) x2 (get-attrs x2)))
(txexprs-equal? `(div ,attrs-tx1) `(div ,attrs-tx2)))
(provide+safe check-txexprs-equal?) (provide+safe check-txexprs-equal?)
(define-simple-check (check-txexprs-equal? tx1 tx2) (define-simple-check (check-txexprs-equal? tx1 tx2)

@ -1,6 +1,8 @@
#lang info #lang info
(define version "0.2") (define version "0.2")
(define collection 'multi) (define collection "txexpr")
(define deps '("base" ["sugar" #:version "0.2"] "rackunit-lib")) (define deps '("base" ["sugar" #:version "0.2"] "rackunit-lib"))
(define update-implies '("sugar")) (define update-implies '("sugar"))
(define build-deps '("scribble-lib" "racket-doc" "rackunit-doc")) (define build-deps '("scribble-lib" "racket-doc" "rackunit-doc"))
(define scribblings '(("scribblings/txexpr.scrbl" ())))
(define compile-omit-paths '("tests.rkt"))

@ -0,0 +1,13 @@
#lang racket/base
(define-syntax-rule (r+p modname ...)
(begin
(begin
(require modname)
(provide (all-from-out modname))
(module+ safe
(require (submod modname safe))
(provide (all-from-out (submod modname safe))))) ...))
(r+p "base.rkt"
"check.rkt")

@ -3,11 +3,10 @@
@; for documentation purposes, use the xexpr? from xml. @; for documentation purposes, use the xexpr? from xml.
@; the one in txexpr is just to patch over an issue with @; the one in txexpr is just to patch over an issue with
@; `valid-char?` in Racket 6. @; `valid-char?` in Racket 6.
@(require scribble/eval @(require scribble/eval (for-label racket txexpr xml rackunit))
(for-label racket txexpr txexpr/stx xml rackunit))
@(define my-eval (make-base-eval)) @(define my-eval (make-base-eval))
@(my-eval `(require racket/match txexpr xml rackunit)) @(my-eval `(require txexpr xml rackunit))
@title{txexpr: Tagged X-expressions} @title{txexpr: Tagged X-expressions}
@ -195,7 +194,7 @@ Predicate for functions that handle @racket[_txexpr-attrs]. Covers values that a
(validate-txexpr (validate-txexpr
[possible-txexpr any/c]) [possible-txexpr any/c])
txexpr?] txexpr?]
Like @racket[txexpr?], but raise a descriptive error pinpointing the first problem encountered if @racket[_possible-txexpr] is invalid, and otherwise return @racket[_possible-txexpr] itself. Like @racket[txexpr?], but raise a descriptive error if @racket[_possible-txexpr] is invalid, and otherwise return @racket[_possible-txexpr] itself.
@examples[#:eval my-eval @examples[#:eval my-eval
(validate-txexpr 'root) (validate-txexpr 'root)
@ -204,8 +203,6 @@ Like @racket[txexpr?], but raise a descriptive error pinpointing the first probl
(validate-txexpr '(root ((id "top")(class "42")))) (validate-txexpr '(root ((id "top")(class "42"))))
(validate-txexpr '(root ((id "top")(class "42")) ("hi"))) (validate-txexpr '(root ((id "top")(class "42")) ("hi")))
(validate-txexpr '(root ((id "top")(class "42")) "hi")) (validate-txexpr '(root ((id "top")(class "42")) "hi"))
(validate-txexpr '(root (p "Hello " (span [[class "inner"]] (1 2 3)))))
(validate-txexpr `(root (p "Look out" (span ,(void)) (1 2 3))))
] ]
@ -231,41 +228,6 @@ Assemble a @racket[_txexpr] from its parts. If you don't have attributes, but yo
(get-attrs tx) (get-elements tx)) (get-attrs tx) (get-elements tx))
] ]
The @racket[txexpr] form can also be used as a match pattern:
@examples[#:eval my-eval
(match '(div)
[(txexpr tag attrs elems)
(values tag attrs elems)])
(match '(div "Hello" (p "World"))
[(txexpr tag attrs elems)
(values tag attrs elems)])
(match '(div "Hello" (p "World"))
[(txexpr 'div attrs1 (list elems1 ... (txexpr 'p attrs2 elems2)))
(values attrs1 elems1 attrs2 elems2)])
(match '(div ((id "top")) "Hello" (p "World"))
[(txexpr 'div attrs1 (list elems1 ... (txexpr 'p attrs2 elems2)))
(values attrs1 elems1 attrs2 elems2)])
]
@defproc[
(txexpr*
[tag txexpr-tag?]
[attrs txexpr-attrs? @empty]
[element txexpr-element?] ...)
txexpr?]
Like @racket[txexpr], but takes an indefinite number of @racket[_element] arguments, which together are treated as the list of elements for the resulting @racket[_txexpr]. A notational convenience.
@examples[#:eval my-eval
(txexpr* 'div)
(txexpr* 'div '() "Hello" '(p "World"))
(txexpr* 'div '((id "top")))
(txexpr* 'div '((id "top")) "Hello" '(p "World"))
(define tx '(div ((id "top")) "Hello" (p "World")))
(apply txexpr* (get-tag tx)
(get-attrs tx) (get-elements tx))
]
@deftogether[( @deftogether[(
@defproc[ @defproc[
@ -374,24 +336,19 @@ Return @racket[#t] if @racket[_attrs] and @racket[_other-attrs] contain the same
@defproc[ @defproc[
(attr-ref (attr-ref
[attrs (or/c txexpr-attrs? txexpr?)] [tx txexpr?]
[key can-be-txexpr-attr-key?] [key can-be-txexpr-attr-key?]
[failure-result any/c (λ _ (raise (make-exn:fail:contract ....))) [failure-result any/c (λ _ (raise (make-exn:fail:contract ....)))
]) ])
any] any]
Given a @racket[_key], return the corresponding @racket[_value] from @racket[_attrs]. By default, asking for a nonexistent key produces an error. But if a value or procedure is provided as the @racket[_failure-result], evaluate and return that instead. Given a @racket[_key], return the corresponding @racket[_value] from the attributes of a @racket[_txexpr]. By default, asking for a nonexistent key produces an error. But if a value or procedure is provided as the @racket[_failure-result], evaluate and return that instead.
@examples[#:eval my-eval @examples[#:eval my-eval
(define tx '(div ((id "top")(class "red")) "Hello" (p "World")))
(attr-ref tx 'class) (attr-ref tx 'class)
(attr-ref tx 'id) (attr-ref tx 'id)
(attr-ref tx 'nonexistent-key) (attr-ref tx 'nonexistent-key)
(attr-ref tx 'nonexistent-key "forty-two") (attr-ref tx 'nonexistent-key "forty-two")
(attr-ref tx 'nonexistent-key (λ _ (* 6 7))) (attr-ref tx 'nonexistent-key (λ _ (* 6 7)))
(define attrs '((id "top")(class "red")))
(attr-ref attrs 'class)
(attr-ref attrs 'id)
(attr-ref attrs 'nonexistent-key)
] ]
@deftogether[( @deftogether[(
@ -411,7 +368,7 @@ txexpr?]
[value can-be-txexpr-attr-value?] ... ... ) [value can-be-txexpr-attr-value?] ... ... )
txexpr?] txexpr?]
)] )]
Set the value of attribute @racket[_key] to @racket[_value] in @racket[_txexpr]. Return the updated @racket[_txexpr]. Duplicate attributes, if they exist, are resolved using @racket[attrs->hash]. @racket[attr-set] only accepts one key and one value; @racket[attr-set*] accepts any number. Set the value of attribute @racket[_key] to @racket[_value] in @racket[_txexpr]. Return the updated @racket[_txexpr]. Duplicate attributes, if they exist, are resolved using @racket[attr->hash]. @racket[attr-set] only accepts one key and one value; @racket[attr-set*] accepts any number.
@examples[#:eval my-eval @examples[#:eval my-eval
(define tx '(div ((class "red")(id "top")) "Hello" (p "World"))) (define tx '(div ((class "red")(id "top")) "Hello" (p "World")))
@ -480,7 +437,7 @@ In practice, most @racket[_txexpr-element]s are strings. But it's unwise to pass
(splitf-txexpr (splitf-txexpr
[tx txexpr?] [tx txexpr?]
[pred procedure?] [pred procedure?]
[replace-proc procedure? (λ (x) #f)]) [replace-proc procedure? (λ(x) null)])
(values txexpr? (listof txexpr-element?))] (values txexpr? (listof txexpr-element?))]
Recursively descend through @racket[_txexpr] and extract all elements that match @racket[_pred]. Returns two values: a @racket[_txexpr] with the matching elements removed, and the list of matching elements. Sort of esoteric, but I've needed it more than once, so here it is. Recursively descend through @racket[_txexpr] and extract all elements that match @racket[_pred]. Returns two values: a @racket[_txexpr] with the matching elements removed, and the list of matching elements. Sort of esoteric, but I've needed it more than once, so here it is.
@ -576,110 +533,6 @@ If ordering of attributes is relevant to your test, then just use @racket[check-
] ]
@section{Syntax Versions of X-expressions}
@(define stx-eval (make-base-eval))
@(stx-eval `(require txexpr txexpr/stx xml rackunit))
@defmodule[txexpr/stx]{
This module provides functions for destructuring TX-expressions
that might be wrapped in syntax objects.
}
@defproc[(stx-xexpr? [v any/c]) boolean?]{
A predicate for X-expressions that might be wrapped in syntax
(or have parts of them wrapped in syntax). It returns
@racket[#true] for values that would become normal X-expressions
with @racket[(syntax->datum (datum->syntax #f v))].
@examples[#:eval stx-eval
(stx-xexpr? "A leaf on the wind")
(stx-xexpr? #'"A leaf in a bin")
(stx-xexpr? '(div ((id "top")) "Hello" (p "World")))
(stx-xexpr? #'(div ((id "top")) "Hello" (p "World")))
(stx-xexpr? `(div ((id ,#'"top")) "Hello" ,#'(p "World")))
]}
@defproc[(stx-txexpr? [v any/c]) boolean?]{
A predicate for Tagged X-expressions that might be wrapped in
syntax. It returns @racket[#true] for values that become one
of these with @racket[(syntax->datum (datum->syntax #f v))]:
@racketgrammar*[
#:literals (list)
[txexpr (list tag attrs xexpr ...)
(list tag xexpr ...)]
]
@examples[#:eval stx-eval
(stx-txexpr? "A block at the top")
(stx-txexpr? '(div ((id "top")) "A block beneath a" (p "tag")))
(stx-txexpr? #'(div ((id "top")) "A block beneath a" (p "tag")))
(stx-txexpr? #'(div "A block beneath a" (p "tag")))
]}
@deftogether[[
@defproc[(stx-txexpr-tag? [v any/c]) boolean?]
@defproc[(stx-txexpr-attrs? [v any/c]) boolean?]
]]{
Predicates for sub-parts of TX-expressions that might be wrapped
in syntax. There return @racket[#true] for values that become
@racket[txexpr-tag?]s or @racket[txexpr-attrs?]s when unwrapped
with @racket[(syntax->datum (datum->syntax #f v))].
@examples[#:eval stx-eval
(stx-txexpr-tag? 'div)
(stx-txexpr-tag? #'div)
(stx-txexpr-tag? 'analogous)
(stx-txexpr-tag? #'analogous)
(stx-txexpr-attrs? '())
(stx-txexpr-attrs? #'())
(stx-txexpr-attrs? '((id "top") (style "color: blue")))
(stx-txexpr-attrs? #'((id "top") (style "color: blue")))
(stx-txexpr-attrs? `((id "top") (style ,#'"color: blue")))
]}
@deftogether[[
@defproc[(stx-txexpr-tag [tx stx-txexpr?]) stx-txexpr-tag?]
@defproc[(stx-txexpr-attrs [tx stx-txexpr?]) stx-txexpr-attrs?]
@defproc[(stx-txexpr-elements [tx stx-txexpr?]) (listof stx-txexpr?)]
]]{
Accessor functions for the tag, attributes, and elements of a
txexpr that might be wrapped in syntax. Note that these functions
work whether the input is wrapped in syntax or not, and that
the results may or may not be wrapped in syntax, depending on
whether the input was wrapped.
@examples[#:eval stx-eval
(define tx1 '(div ((id "top")) "Hello" (p "World")))
(define tx2 #'(div ((id "top")) "Hello" (p "World")))
(stx-txexpr-tag tx1)
(stx-txexpr-tag tx2)
(stx-txexpr-attrs tx1)
(stx-txexpr-attrs tx2)
(stx-txexpr-elements tx1)
(stx-txexpr-elements tx2)
]}
@deftogether[[
@defproc[(stx-txexpr->values [tx stx-txexpr?])
(values stx-txexpr-tag? stx-txexpr-attrs? (listof stx-txexpr?))]
@defproc[(stx-txexpr->list [tx stx-txexpr?])
(list/c stx-txexpr-tag? stx-txexpr-attrs? (listof stx-txexpr?))]
]]{
These functions break up a TX-expression into its components.
@racket[stx-txexpr->values] returns them as three values, and
@racket[stx-txexpr->list] returns them as a three-element list.
@examples[#:eval stx-eval
(stx-txexpr->values '(div))
(stx-txexpr->list '(div))
(stx-txexpr->values #'(div))
(stx-txexpr->values #'(div "Hello" (p "World")))
(stx-txexpr->values #'(div ((id "top")) "Hello" (p "World")))
(stx-txexpr->values `(div ((id "top")) "Hello" ,#'(p "World")))
]}
@section{License & source code} @section{License & source code}
This module is licensed under the LGPL. This module is licensed under the LGPL.

@ -1,22 +1,27 @@
#lang racket/base #lang racket/base
(require (for-syntax racket/base racket/syntax syntax/strip-context)) (require (for-syntax racket/base racket/syntax))
;; use a separate test file to avoid cycle in loading ;; use a separate test file to avoid cycle in loading
(define-syntax (test-safe-and-unsafe stx) (define-syntax (test-safe-and-unsafe stx)
(syntax-case stx () (syntax-case stx ()
[(_ . exprs) [(_ exprs ...)
(with-syntax ([module-without-contracts (generate-temporary)] (with-syntax ([sym (syntax-e (generate-temporary))]
[module-with-contracts (generate-temporary)]) [sym2 (syntax-e (generate-temporary))])
(replace-context stx (datum->syntax stx `(begin
#'(begin (module ,(syntax->datum #'sym) racket
(module module-without-contracts racket (require rackunit "main.rkt")
(require rackunit "../main.rkt" "check-values.rkt") (define-syntax (values->list stx)
. exprs) (syntax-case stx ()
(require 'module-without-contracts) [(_ values-expr) #'(call-with-values (λ () values-expr) list)]))
(module module-with-contracts racket ,@(syntax->datum #'(exprs ...)))
(require rackunit (submod "../main.rkt" safe) "check-values.rkt") (require ',(syntax->datum #'sym))
. exprs) (module ,(syntax->datum #'sym2) racket
(require 'module-with-contracts))))])) (require rackunit (submod "main.rkt" safe))
(define-syntax (values->list stx)
(syntax-case stx ()
[(_ values-expr) #'(call-with-values (λ () values-expr) list)]))
,@(syntax->datum #'(exprs ...)))
(require ',(syntax->datum #'sym2))) stx))]))
(test-safe-and-unsafe (test-safe-and-unsafe
@ -66,85 +71,12 @@
(check-not-exn (λ _ (validate-txexpr '(p)))) (check-not-exn (λ _ (validate-txexpr '(p))))
(check-not-exn (λ _ (validate-txexpr '(p "foo" "bar")))) (check-not-exn (λ _ (validate-txexpr '(p "foo" "bar"))))
(check-not-exn (λ _ (validate-txexpr '(p ((key "value")) "foo" "bar")))) (check-not-exn (λ _ (validate-txexpr '(p ((key "value")) "foo" "bar"))))
(check-not-exn (λ _ (validate-txexpr '(p () "foo" "bar"))))
(check-not-exn (λ _ (validate-txexpr '(p 123)))) ; content is a valid-char (check-not-exn (λ _ (validate-txexpr '(p 123)))) ; content is a valid-char
(check-exn exn:fail? (λ _ (validate-txexpr "foo"))) ; not a list with symbol (check-exn exn:fail? (λ _ (validate-txexpr "foo"))) ; not a list with symbol
(check-exn exn:fail? (λ _ (validate-txexpr '(p "foo" "bar" ((key "value")))))) ; malformed (check-exn exn:fail? (λ _ (validate-txexpr '(p "foo" "bar" ((key "value")))))) ; malformed
(check-exn exn:fail? (λ _ (validate-txexpr '("p" "foo" "bar")))) ; no name (check-exn exn:fail? (λ _ (validate-txexpr '("p" "foo" "bar")))) ; no name
(check-exn exn:fail? (λ _ (validate-txexpr '(root ((id "top")(class 42)))))) ; malformed attrs (check-exn exn:fail? (λ _ (validate-txexpr '(root ((id "top")(class 42)))))) ; malformed attrs
(check-exn exn:fail? (λ _ (validate-txexpr `(root ,(void))))) ; invalid element type
(define-syntax (check-validate-exn-msg stx)
(syntax-case stx ()
[(_ tx) (syntax/loc stx (check-validate-exn-msg tx ""))]
[(_ tx msg)
(syntax/loc stx
(check-equal? (with-handlers ([exn:fail:contract? (λ (e) (exn-message e))])
(validate-txexpr tx)) msg))]))
;; Root element not a list
(check-validate-exn-msg
"foo"
"validate-txexpr: contract violation\n expected: tagged X-expression\n given: \"foo\"")
;; No name
(check-validate-exn-msg
'("p" "foo" "bar")
"validate-txexpr: tag must be a symbol\n tag: \"p\"\n in: '(\"p\" \"foo\" \"bar\")")
;; Invalid element
(check-validate-exn-msg
'(p "foo" "bar" ((key "value")))
"validate-txexpr: element not a valid element (= txexpr, string, symbol, XML char, cdata, or comment)\n element: '((key \"value\"))\n in: '(p \"foo\" \"bar\" ((key \"value\")))")
;; Malformed attribute list
(check-validate-exn-msg
'(p ((key "val") "foo" "bar") "hi")
"validate-txexpr: attribute is not a list of the form '(symbol \"string\")\n attribute: \"foo\"\n in: '(p ((key \"val\") \"foo\" \"bar\") \"hi\")")
;; Invalid attribute key
(check-validate-exn-msg
'(root ((id "top") (class 42)))
"validate-txexpr: attribute value is not a string\n attribute value: 42\n in: '(root ((id \"top\") (class 42)))")
;; Invalid attribute value
(check-validate-exn-msg
'(root ((id "top") ("class" 42)))
"validate-txexpr: attribute key is not a symbol\n attribute key: \"class\"\n in: '(root ((id \"top\") (\"class\" 42)))")
;; Invalid element type
(check-validate-exn-msg
`(root ,(void))
"validate-txexpr: element not a valid element (= txexpr, string, symbol, XML char, cdata, or comment)\n element: #<void>\n in: '(root #<void>)")
;; (Deeply nested) No name: error should pinpoint element in 'div txexpr
(check-validate-exn-msg
'(fine-outer [[type "valid"]] (div (br) ("p" "foo" "bar")))
"validate-txexpr: element not a valid element (= txexpr, string, symbol, XML char, cdata, or comment)\n element: '(\"p\" \"foo\" \"bar\")\n in: '(div (br) (\"p\" \"foo\" \"bar\"))")
;; (Deeply nested) Invalid element: error should pinpoint element in 'p txexpr
(check-validate-exn-msg
'(fine-outer [[type "valid"]] (div (br) (p "foo" "bar" ((key "value")))))
"validate-txexpr: element not a valid element (= txexpr, string, symbol, XML char, cdata, or comment)\n element: '((key \"value\"))\n in: '(p \"foo\" \"bar\" ((key \"value\")))")
;; (Deeply nested) Malformed attribute list: error should pinpoint attr in 'p txexpr
(check-validate-exn-msg
'(fine-outer [[type "valid"]] (div (br) (p ((key "val") "foo" "bar") "hi")))
"validate-txexpr: attribute is not a list of the form '(symbol \"string\")\n attribute: \"foo\"\n in: '(p ((key \"val\") \"foo\" \"bar\") \"hi\")")
;; (Deeply nested) Invalid attribute key: error should pinpoint attr key in 'p txexpr
(check-validate-exn-msg
'(fine-outer [[type "valid"]] (div (br) (p ((id "top") (class 42)))))
"validate-txexpr: attribute value is not a string\n attribute value: 42\n in: '(p ((id \"top\") (class 42)))")
;; (Deeply nested) Invalid attribute value: error should pinpoint attr val in 'p txexpr
(check-validate-exn-msg
'(fine-outer [[type "valid"]] (div (br) (p ((id "top") ("class" 42)))))
"validate-txexpr: attribute key is not a symbol\n attribute key: \"class\"\n in: '(p ((id \"top\") (\"class\" 42)))")
;; (Deeply nested) Invalid element type: error should pinpoint element in 'p txexpr
(check-validate-exn-msg
`(fine-outer [[type "valid"]] (div (br) (p ,(void))))
"validate-txexpr: element not a valid element (= txexpr, string, symbol, XML char, cdata, or comment)\n element: #<void>\n in: '(p #<void>)")
(check-txexprs-equal? (make-txexpr 'p) '(p)) (check-txexprs-equal? (make-txexpr 'p) '(p))
(check-txexprs-equal? (make-txexpr 'p '((key "value"))) '(p ((key "value")))) (check-txexprs-equal? (make-txexpr 'p '((key "value"))) '(p ((key "value"))))
@ -158,20 +90,14 @@
(check-txexprs-equal? (txexpr 'p '((key "value")) (list "foo" "bar")) (check-txexprs-equal? (txexpr 'p '((key "value")) (list "foo" "bar"))
'(p ((key "value")) "foo" "bar")) '(p ((key "value")) "foo" "bar"))
(check-txexprs-equal? (txexpr* 'p) '(p)) (check-equal? (values->list (txexpr->values '(p)))
(check-txexprs-equal? (txexpr* 'p '((key "value"))) '(p ((key "value")))) (values->list (values 'p null null)))
(check-txexprs-equal? (txexpr* 'p null "foo" "bar") '(p "foo" "bar")) (check-equal? (values->list (txexpr->values '(p "foo")))
(check-txexprs-equal? (txexpr* 'p '((key "value")) "foo" "bar") (values->list (values 'p null '("foo"))))
'(p ((key "value")) "foo" "bar")) (check-equal? (values->list (txexpr->values '(p ((key "value")))))
(values->list (values 'p '((key "value")) null)))
(check-values=? (txexpr->values '(p)) (check-equal? (values->list (txexpr->values '(p ((key "value")) "foo")))
(values 'p null null)) (values->list (values 'p '((key "value")) '("foo"))))
(check-values=? (txexpr->values '(p "foo"))
(values 'p null '("foo")))
(check-values=? (txexpr->values '(p ((key "value"))))
(values 'p '((key "value")) null))
(check-values=? (txexpr->values '(p ((key "value")) "foo"))
(values 'p '((key "value")) '("foo")))
(check-equal? (values->list (txexpr->values '(p))) (check-equal? (values->list (txexpr->values '(p)))
(txexpr->list '(p))) (txexpr->list '(p)))
@ -182,19 +108,6 @@
(check-equal? (values->list (txexpr->values '(p ((key "value")) "foo"))) (check-equal? (values->list (txexpr->values '(p ((key "value")) "foo")))
(txexpr->list '(p ((key "value")) "foo"))) (txexpr->list '(p ((key "value")) "foo")))
;; testing the match expander success
(check-match '(p ((key "value")) "leaf")
(txexpr 'p `((key ,val)) (list "leaf"))
(string=? val "value"))
;; testing the match expander failure
(check-false (match '(p ((key "value")) "something")
[(txexpr 'p _ (list "else")) #true]
[_ #false]))
(check-false (match "foo"
[(txexpr _ _ _) #true]
[_ #false]))
(check-equal? (get-tag '(p ((key "value"))"foo" "bar" (em "square"))) 'p) (check-equal? (get-tag '(p ((key "value"))"foo" "bar" (em "square"))) 'p)
(check-equal? (get-attrs '(p ((key "value"))"foo" "bar" (em "square"))) '((key "value"))) (check-equal? (get-attrs '(p ((key "value"))"foo" "bar" (em "square"))) '((key "value")))
(check-equal? (get-elements '(p ((key "value"))"foo" "bar" (em "square"))) (check-equal? (get-elements '(p ((key "value"))"foo" "bar" (em "square")))
@ -203,11 +116,9 @@
(check-equal? (->txexpr-attr-key "foo") 'foo) (check-equal? (->txexpr-attr-key "foo") 'foo)
(check-equal? (->txexpr-attr-key 'foo) 'foo) (check-equal? (->txexpr-attr-key 'foo) 'foo)
(check-equal? (->txexpr-attr-key (string->path "foo")) 'foo)
(check-equal? (->txexpr-attr-value "foo") "foo") (check-equal? (->txexpr-attr-value "foo") "foo")
(check-equal? (->txexpr-attr-value 'foo) "foo") (check-equal? (->txexpr-attr-value 'foo) "foo")
(check-equal? (->txexpr-attr-value (string->path "foo")) "foo")
(check-equal? (attrs->hash '((foo "bar"))) '#hasheq((foo . "bar"))) (check-equal? (attrs->hash '((foo "bar"))) '#hasheq((foo . "bar")))
(check-equal? (attrs->hash '((foo "bar") (foo "fraw"))) '#hasheq((foo . "bar"))) (check-equal? (attrs->hash '((foo "bar") (foo "fraw"))) '#hasheq((foo . "bar")))
@ -216,25 +127,19 @@
(check-equal? (attrs->hash '((foo "bar")) '(foo "fraw") 'foo "dog") '#hasheq((foo . "bar"))) (check-equal? (attrs->hash '((foo "bar")) '(foo "fraw") 'foo "dog") '#hasheq((foo . "bar")))
(check-exn exn:fail:contract? (λ _ (attrs->hash 'foo "bar" 'zam))) (check-exn exn:fail:contract? (λ _ (attrs->hash 'foo "bar" 'zam)))
(check-equal? (sort (hash->attrs '#hash((foo . "bar")(hee . "haw"))) string<? #:key cadr) (check-equal? (apply set (hash->attrs '#hash((foo . "bar")(hee . "haw"))))
(sort '((foo "bar")(hee "haw")) string<? #:key second)) (apply set '((foo "bar")(hee "haw"))))
(check-equal? (attr-ref '(p ((foo "bar"))) 'foo) "bar") (check-equal? (attr-ref '(p ((foo "bar"))) 'foo) "bar")
(check-exn exn:fail? (λ _ (attr-ref '(p ((foo "bar"))) 'zam))) (check-exn exn:fail? (λ _ (attr-ref '(p ((foo "bar"))) 'zam)))
(check-equal? (attr-ref '(p ((foo "bar"))) 'zam 42) 42) (check-equal? (attr-ref '(p ((foo "bar"))) 'zam 42) 42)
(check-equal? (attr-ref '(p ((foo "bar"))) 'zam (λ _ (* 6 7))) 42) (check-equal? (attr-ref '(p ((foo "bar"))) 'zam (λ _ (* 6 7))) 42)
(check-equal? (attr-ref '((foo "bar")) 'foo) "bar")
(check-exn exn:fail? (λ _ (attr-ref '((foo "bar")) 'zam)))
(check-equal? (attr-ref '((foo "bar")) 'zam 42) 42)
(check-equal? (attr-ref '((foo "bar")) 'zam (λ _ (* 6 7))) 42)
(check-txexprs-equal? (attr-set '(p ((foo "bar"))) 'foo "fraw") '(p ((foo "fraw")))) (check-txexprs-equal? (attr-set '(p ((foo "bar"))) 'foo "fraw") '(p ((foo "fraw"))))
(check-txexprs-equal? (attr-set* '(p ((foo "bar"))) 'foo "fraw") '(p ((foo "fraw")))) (check-txexprs-equal? (attr-set* '(p ((foo "bar"))) 'foo "fraw") '(p ((foo "fraw"))))
(check-true (let ([result (attr-set* '(p ((foo "bar"))) 'foo "fraw" 'zim 'zam)]) (check-true (let ([result (attr-set* '(p ((foo "bar"))) 'foo "fraw" 'zim 'zam)])
(and (member '(foo "fraw") (get-attrs result)) (and (member '(foo "fraw") (get-attrs result))
(member '(zim "zam") (get-attrs result)) #t))) (member '(zim "zam") (get-attrs result)) #t)))
(check-txexprs-equal? (attr-join '(p ((foo "bar"))) 'foo "zam") '(p ((foo "bar zam")))) (check-txexprs-equal? (attr-join '(p ((foo "bar"))) 'foo "zam") '(p ((foo "bar zam"))))
(check-txexprs-equal? (attr-join '(tx ((foo "bar")) baz (p bin)) 'key 'val)
'(tx ((foo "bar") (key "val")) baz (p bin)))
(check-true (let ([result (attr-join '(p ((foo "bar"))) 'zim "zam")]) (check-true (let ([result (attr-join '(p ((foo "bar"))) 'zim "zam")])
(and (member '(foo "bar") (get-attrs result)) (and (member '(foo "bar") (get-attrs result))
(member '(zim "zam") (get-attrs result)) #t))) (member '(zim "zam") (get-attrs result)) #t)))
@ -308,19 +213,4 @@
(check-false (findf-txexpr split-this-tx false-pred)) (check-false (findf-txexpr split-this-tx false-pred))
(check-equal? (xexpr->html '(root (script "3 > 2") "Why is 3 > 2?")) (check-equal? (xexpr->html '(root (script "3 > 2") "Why is 3 > 2?"))
"<root><script>3 > 2</script>Why is 3 &gt; 2?</root>") "<root><script>3 > 2</script>Why is 3 &gt; 2?</root>"))
(check-equal? (xexpr->html '(root (div "<![CDATA[3 > 2]]>") "Why is 3 > 2?"))
"<root><div><![CDATA[3 > 2]]></div>Why is 3 &gt; 2?</root>")
;; comment
(check-equal? (xexpr->html '(root "<!-- comment -->" "Why is 3 > 2?"))
"<root><!-- comment -->Why is 3 &gt; 2?</root>")
;; malformed comment: merged with next string
(check-equal? (xexpr->html '(root "<!-- comment -->Why is 3 > 2?"))
"<root>&lt;!-- comment --&gt;Why is 3 &gt; 2?</root>")
;; malformed comment: missing double hyphen at end
(check-equal? (xexpr->html '(root "<!-- comment ->" "Why is 3 > 2?"))
"<root>&lt;!-- comment -&gt;Why is 3 &gt; 2?</root>"))

@ -1,328 +0,0 @@
#lang racket/base
(require racket/match sugar/define sugar/list sugar/coerce
racket/string racket/list
xml
"private/define-provide-safe-match.rkt"
(for-syntax racket/base syntax/parse))
(provide cdata? cdata valid-char? xexpr->string xexpr? comment comment?) ; from xml
(provide empty) ; from racket/list
;; Section 2.2 of XML 1.1
;; (XML 1.0 is slightly different and more restrictive)
;; make private version of my-valid-char to get consistent results with Racket 6.0
(define (my-valid-char? i)
(and (exact-nonnegative-integer? i)
(or (<= #x1 i #xD7FF)
(<= #xE000 i #xFFFD)
(<= #x10000 i #x10FFFF))))
(define (my-xexpr? x)
(or (my-valid-char? x) (xexpr? x) (txexpr? x)))
(define+provide+safe (txexpr? x [allow-long #t])
predicate/c
(match x
[(cons (? txexpr-tag?) rest)
(=> resume)
(let loop ([rest rest])
(match rest
[(list (? my-xexpr?) ...) #true]
[(list (? txexpr-attrs?) elems ...) #:when allow-long (loop elems)]
[_ (resume)]))]
[_ #false]))
(define+provide+safe (txexpr-short? x)
predicate/c
(txexpr? x #false))
(define+provide+safe (txexpr-tag? x)
predicate/c
(symbol? x))
(define+provide+safe (txexpr-attr? x)
predicate/c
(match x
[(list (? txexpr-attr-key?) (? txexpr-attr-value?)) #true]
[_ #false]))
(define+provide+safe (txexpr-element? x)
predicate/c
(my-xexpr? x))
(define+provide+safe (txexpr-attr-key? x)
predicate/c
(symbol? x))
(define+provide+safe (can-be-txexpr-attr-key? x)
predicate/c
(symbolish? x))
(define+provide+safe (txexpr-attr-value? x)
predicate/c
(string? x))
(define+provide+safe (can-be-txexpr-attr-value? x)
predicate/c
(stringish? x))
(define-syntax-rule (define-plural plural-id pred)
(define+provide+safe (plural-id x)
predicate/c
(match x
[(list (? pred) (... ...)) #true]
[_ #false])))
(define-plural txexpr-tags? txexpr-tag?)
(define-plural txexpr-attrs? txexpr-attr?)
(define-plural txexpr-elements? txexpr-element?)
(define-plural txexpr-attr-values? txexpr-attr-value?)
(define-plural list-of-can-be-txexpr-attrs? can-be-txexpr-attrs?)
(define+provide+safe (can-be-txexpr-attrs? x)
predicate/c
(or (can-be-txexpr-attr-key? x)
(can-be-txexpr-attr-value? x)
(txexpr-attr? x)
(txexpr-attrs? x)))
(define (validate-txexpr-attrs tx)
(andmap
(lambda (attr)
(unless (and (list? attr) (eq? 2 (length attr)))
(txexpr-error "attribute" "is not a list of the form '(symbol \"string\")" attr tx))
(unless (symbol? (first attr))
(txexpr-error "attribute key" "is not a symbol" (first attr) tx))
(unless (string? (second attr))
(txexpr-error "attribute value" "is not a string" (second attr) tx))
#t)
(second tx)))
(define (validate-txexpr-elements elems tx)
(andmap
(lambda (e)
(cond
[(or (string? e) (symbol? e) (my-valid-char? e) (cdata? e) (comment? e)) #t]
[(and (list? e) (symbol? (first e)))
(validate-txexpr e)]
[else (txexpr-error "element" "not a valid element (= txexpr, string, symbol, XML char, cdata, or comment)" e tx)]))
elems))
(define (txexpr-error noun has-problem bad tx)
(raise-arguments-error 'validate-txexpr (format "~a ~a" noun has-problem) noun bad "in" tx))
;; is it a named x-expression?
;; Restricting to primitive predicates allows for more specific (helpful) errors
(define+provide+safe (validate-txexpr x)
(any/c . -> . txexpr?)
(unless (list? x) (raise-argument-error 'validate-txexpr "tagged X-expression" x))
(match x
[(list* tag _) #:when (not (symbol? tag))
(txexpr-error "tag" "must be a symbol" tag x)]
[(list* tag (or (? null?) (list (? list?) _ ...)) elems)
(and (validate-txexpr-attrs x) (validate-txexpr-elements elems x) x)]
[(list* tag elems) (and (validate-txexpr-elements elems x) x)]))
(define (txexpr-unsafe tag attrs elements)
(cons tag (match attrs
[(== empty) elements]
[_ (cons attrs elements)])))
(define (txexpr-base func-name tag attrs elements)
(unless (txexpr-tag? tag)
(raise-argument-error func-name "txexpr-tag?" tag))
(unless (txexpr-attrs? attrs)
(raise-argument-error func-name "txexpr-attrs?" attrs))
(unless (txexpr-elements? elements)
(raise-argument-error func-name "txexpr-elements?" elements))
(txexpr-unsafe tag attrs elements))
(define+provide+safe+match (txexpr tag [attrs null] [elements null])
((txexpr-tag?) (txexpr-attrs? txexpr-elements?) . ->* . txexpr?)
(txexpr-base 'txexpr tag attrs elements)
#:match-expander
(syntax-parser
[(_ tag-pat:expr
{~optional attrs-pat:expr #:defaults ([attrs-pat #'_])}
{~optional elements-pat:expr #:defaults ([elements-pat #'_])})
#'(? txexpr? (app txexpr->values tag-pat attrs-pat elements-pat))]))
(define+provide+safe (txexpr* tag [attrs null] . elements)
((txexpr-tag?) (txexpr-attrs?) #:rest txexpr-elements? . ->* . txexpr?)
(txexpr-base 'txexpr* tag attrs elements))
(define make-txexpr txexpr) ; for backward compatability
(provide+safe make-txexpr)
(define+provide+safe (txexpr->values x)
(txexpr? . -> . (values txexpr-tag? txexpr-attrs? txexpr-elements?))
(match x
[(? txexpr-short?) (values (car x) '() (cdr x))]
[_ (values (car x) (cadr x) (cddr x))]))
(define+provide+safe (txexpr->list x)
(txexpr? . -> . list?)
(call-with-values (λ () (txexpr->values x)) list))
;; convenience functions to retrieve only one part of txexpr
(define+provide+safe (get-tag x)
(txexpr? . -> . txexpr-tag?)
(car x))
(define+provide+safe (get-attrs x)
(txexpr? . -> . txexpr-attrs?)
(define-values (tag attrs elements) (txexpr->values x))
attrs)
(define+provide+safe (get-elements x)
(txexpr? . -> . txexpr-elements?)
(define-values (tag attrs elements) (txexpr->values x))
elements)
;; helpers. we are getting a string or symbol
(define+provide+safe (->txexpr-attr-key x)
(can-be-txexpr-attr-key? . -> . txexpr-attr-key?)
(unless (can-be-txexpr-attr-key? x)
(raise-argument-error '->txexpr-attr-key "can-be-txexpr-attr-key?" x))
(->symbol x))
(define+provide+safe (->txexpr-attr-value x)
(can-be-txexpr-attr-value? . -> . txexpr-attr-value?)
(unless (can-be-txexpr-attr-value? x)
(raise-argument-error '->txexpr-attr-value "can-be-txexpr-attr-value?" x))
(->string x))
(define (sublist->attr sublist)
(match sublist
[(list key value) (list (->txexpr-attr-key key) (->txexpr-attr-value value))]))
(define+provide+safe (attrs->hash #:hash-style? [hash-style-priority #f] . items-in)
(() (#:hash-style? boolean?) #:rest (listof can-be-txexpr-attrs?) . ->* . hash-eq?)
;; can be liberal with input because they're all just nested key/value pairs
;; but still need this function to make sure that 'foo and "foo" are treated as the same hash key
(define items (flatten items-in))
(unless (even? (length items))
(raise-argument-error 'attrs->hash "argument list of even length" (length items-in)))
;; hasheq loop will overwrite earlier values with later.
;; but earlier attributes need priority (see https://www.w3.org/TR/xml/#attdecls)
;; thus reverse the pairs.
;; priority-inverted will defeat this assumption, and allow later attributes to overwrite earlier.
(for/hasheq ([sublist (in-list ((if hash-style-priority
values
reverse) (slice-at items 2)))])
(apply values (sublist->attr sublist))))
(define+provide+safe (hash->attrs attr-hash)
(hash? . -> . txexpr-attrs?)
(match (hash->list attr-hash)
[(list (cons ks vs) ...) (map list ks vs)]))
(define+provide+safe (attrs-have-key? x key)
((or/c txexpr-attrs? txexpr?) can-be-txexpr-attr-key? . -> . boolean?)
(match x
[(? txexpr? tx) (and (attr-ref tx key #false) #true)]
[_ (attrs-have-key? (txexpr-unsafe '_ x null) key)]))
(define+provide+safe (attr-set tx key value)
(txexpr? can-be-txexpr-attr-key? can-be-txexpr-attr-value? . -> . txexpr?)
(attr-set* tx key value))
(define+provide+safe (attr-set* tx . kvs)
((txexpr?) #:rest (listof (or/c can-be-txexpr-attr-key? can-be-txexpr-attr-value?)) . ->* . txexpr?)
;; unlike others, this uses hash operations to guarantee that your attr-set
;; is the only one remaining.
(unless (even? (length kvs))
(raise-argument-error 'attr-set* "even number of arguments" kvs))
(define new-attrs (hash->attrs
(apply hash-set* (attrs->hash (get-attrs tx))
(append-map sublist->attr (slice-at kvs 2)))))
(txexpr-base 'attr-set* (get-tag tx) new-attrs (get-elements tx)))
(define+provide+safe (attr-join tx key value)
(txexpr? can-be-txexpr-attr-key? can-be-txexpr-attr-value? . -> . txexpr?)
(define starting-values (string-split (attr-ref tx key "")))
(attr-set tx key (string-join (append starting-values (list (->txexpr-attr-value value))) " ")))
(define no-failure-result (gensym)) ; failure-result might be #false
(define+provide+safe (attr-ref attrs-arg key [failure-result no-failure-result])
(((or/c txexpr? txexpr-attrs?) can-be-txexpr-attr-key?) (any/c) . ->* . any)
(match (assq (->txexpr-attr-key key) (match attrs-arg
[(? txexpr? tx) (get-attrs tx)]
[attrs attrs]))
[(list _ value) value]
[_ (match failure-result
[(? procedure?) (failure-result)]
[(== no-failure-result) (raise-argument-error 'attr-ref "key that exists in attr list" key)]
[_ failure-result])]))
(define+provide+safe (remove-attrs x)
(txexpr? . -> . txexpr?)
(let loop ([x x])
(if (txexpr? x)
(let-values ([(tag attrs elements) (txexpr->values x)])
(txexpr-unsafe tag null (map loop elements)))
x)))
(define+provide+safe (map-elements proc x)
(procedure? txexpr? . -> . txexpr?)
(let loop ([x x])
(proc (if (txexpr? x)
(let-values ([(tag attrs elements) (txexpr->values x)])
(txexpr-unsafe tag attrs (map loop elements)))
x))))
;; function to split tag out of txexpr
(define+provide+safe (splitf-txexpr tx pred [proc (λ (x) #f)])
((txexpr? procedure?) (procedure?) . ->* . (values txexpr? txexpr-elements?))
(unless (txexpr? tx)
(raise-argument-error 'splitf-txexpr "txexpr?" tx))
(define matches null)
(define (extract! x)
(match x
[(? pred)
(set! matches (cons x matches))
(proc x)]
[(? txexpr?) (let-values ([(tag attrs elements) (txexpr->values x)])
(txexpr-unsafe tag attrs (filter values (map extract! elements))))]
[_ x]))
(define tx-extracted (extract! tx)) ;; do this first to fill matches
(values tx-extracted (reverse matches)))
(define+provide+safe (findf*-txexpr tx pred)
(txexpr? procedure? . -> . (or/c #f txexpr-elements?))
(match/values (splitf-txexpr tx pred)
[(_ (? pair? matches)) matches]
[(_ _) #false]))
(define+provide+safe (findf-txexpr tx pred)
(txexpr? procedure? . -> . (or/c #f txexpr-element?))
(match (findf*-txexpr tx pred)
[(cons match _) match]
[_ #false]))
;; don't use "![CDATA[...]]" wrapper in HTML, it's not consistent with the spec
(define (->cdata x) (if (string? x) (cdata #f #f x) x))
;; but treat CDATA strings correctly anyhow, because that's friendly
(define (cdata-string? x)
(and (string? x) (regexp-match #rx"^<!\\[CDATA\\[.*\\]\\]>$" x) #true))
(define comment-pattern #rx"^<!--(.*?)-->$")
(define (string->comment x)
(match (regexp-match comment-pattern x)
[(list _ comment-payload) (comment comment-payload)]
[_ #false]))
(define+provide+safe (xexpr->html x)
(xexpr? . -> . string?)
(xexpr->string
(let loop ([x x])
(cond
[(txexpr? x)
(define-values (tag attrs elements) (txexpr->values x))
(define proc (if (memq tag '(script style)) ->cdata loop))
;; a little faster than `txexpr` since we know the pieces are valid
(txexpr-unsafe tag attrs (map proc elements))]
[(cdata-string? x) (->cdata x)]
[(and (string? x) (string->comment x))]
[else x]))))

@ -1,4 +0,0 @@
#lang info
(define scribblings '(("scribblings/txexpr.scrbl" ())))
(define compile-omit-paths '("test/tests.rkt"))

@ -1,14 +0,0 @@
#lang racket/base
(define-syntax-rule (r+p MODNAME ...)
(begin
(begin
(require MODNAME)
(provide (all-from-out MODNAME))
(module+ safe
(require (submod MODNAME safe))
(provide (all-from-out (submod MODNAME safe))))) ...))
(r+p "base.rkt"
"stx.rkt"
"check.rkt")

@ -1,43 +0,0 @@
#lang racket/base
(provide txexpr?/recur
txexpr->values/attrs?)
(require racket/list)
;; A [TXcontainer T A E] is one of:
;; - (List* T A (Listof E))
;; - (Lxst* T (Listof E))
;; Where A and E are disjoint.
;; txexpr?/recur :
;; Any
;; [Any -> Bool : T]
;; [Any -> Bool : #:+ (and A (! E)) #:- (! A)]
;; [Any -> Bool : #:+ (and E (! A)) #:- (! E)]
;; ->
;; Bool
;; : [TXcontainer T A E]
;; the attrs? predicate and the element? predicate should be disjoint
(define (txexpr?/recur v tag? attrs? element?)
(and (list? v)
(not (empty? v))
(tag? (first v))
(cond [(and (not (empty? (rest v)))
(attrs? (second v)))
(andmap element? (rest (rest v)))]
[else
(andmap element? (rest v))])))
;; txexpr->values/attrs? :
;; [TXcontainer T A E]
;; [Any -> Bool : #:+ (and A (! E)) #:- (! A)]
;; ->
;; (values T A (Listof E))
(define (txexpr->values/attrs? tx attrs?)
(cond [(and (not (empty? (rest tx)))
(attrs? (second tx)))
(values (first tx) (second tx) (rest (rest tx)))]
[else
(values (first tx) '() (rest tx))]))

@ -1,82 +0,0 @@
#lang racket/base
(provide define+provide+safe+match)
(require racket/match
(for-syntax racket/base
racket/syntax
syntax/parse
syntax/stx
version/utils))
;; (define+provide+safe+match name-id
;; contract-expr
;; value-expr
;; #:match-expander
;; match-transformer-expr)
;;
;; (define+provide+safe+match (head . args)
;; contract-expr
;; value-body-expr
;; ...+
;; #:match-expander
;; match-transformer-expr)
(begin-for-syntax
;; Identifier -> [Syntax -> Syntax]
(define ((variable-like-transformer id) stx)
(cond
[(identifier? stx)
; id, but with the source location of stx
(datum->syntax id (syntax-e id) stx id)]
[(stx-pair? stx)
(datum->syntax stx (cons id (stx-cdr stx)) stx stx)])))
(define-syntax define+provide+safe+match
(λ (stx)
(syntax-parse stx
[(d (head . args)
contract:expr
value-body:expr ...+
#:match-expander match-transformer:expr)
#:with fn-expr (syntax/loc stx (λ args value-body ...))
(syntax/loc stx
(d head contract fn-expr #:match-expander match-transformer))]
[(_ name:id
contract:expr
value:expr
#:match-expander match-transformer:expr)
#:with internal-name (generate-temporary #'name)
#:with contract-name (generate-temporary #'name)
#:with make-name-match-transformer (generate-temporary #'name)
#:with [name-for-blame ...]
(cond [(version<=? "6.8" (version)) #'[#:name-for-blame name]]
[else #'[]])
#'(begin
(define internal-name (let ([name value]) name))
(begin-for-syntax
(define (make-name-match-transformer name)
(with-syntax ([name name]) match-transformer)))
(define-match-expander name
(make-name-match-transformer (quote-syntax internal-name))
(variable-like-transformer (quote-syntax internal-name)))
(provide name)
(module+ safe
(require racket/contract/base)
(define-module-boundary-contract contract-name internal-name contract
name-for-blame ...)
(define-match-expander name
(make-name-match-transformer (quote-syntax contract-name))
(variable-like-transformer (quote-syntax contract-name)))
(provide name)))])))

@ -1,129 +0,0 @@
#lang racket/base
(provide stx-xexpr?
stx-txexpr?
stx-txexpr-tag?
stx-txexpr-attrs?
stx-txexpr->values
stx-txexpr->list
stx-txexpr-tag
stx-txexpr-attrs
stx-txexpr-elements)
(require syntax/stx
xml
"base.rkt"
"private/container.rkt")
;; ---------------------------------------------------------
;; Data Definitions
;; A [Stx E] is one of:
;; - (Syntaxof E)
;; - E
;; A StxXexpr is a [Stx XexprE]
;; A StxTXexpr is a [Stx TXexprE]
;; A StxTag is a [Stx Symbol]
;; A StxAttrs is a (StxListof (StxList [Stx Symbol] [Stx String]))
;; A StxElements is a (StxListof StxXexpr)
;; A XexprE is one of:
;; - String
;; - TXexprE
;; - Symbol ; for example 'nbsp representing `&nbsp;`
;; - ValidChar ; for example #x20 representing `&#x20;`
;; - CData ; an instance of the `cdata` structure type from `xml`
;; - Misc ; an instance of the `comment` or `p-i` structure types
;; A TXexprE is one of:
;; - (list* StxTag StxAttrs StxElements)
;; - (list* StxTag StxElements)
;; The types `StxAttrs` and `StxXexpr` are disjoint, as they
;; need to be for this to be unambiguous.
;; ---------------------------------------------------------
;; Predicates
;; Any -> Bool
(define (stx-xexpr? v)
(stx-xexpr?/recur v stx-xexpr?))
;; Any -> Bool
(define (stx-txexpr? v)
(stx-txexpr?/recur v stx-xexpr?))
;; Any [Any -> Bool] -> Bool
(define (stx-xexpr?/recur v rec)
(cond
[(syntax? v) (stx-xexpr?/recur (syntax-e v) rec)]
[(pair? v) (stx-txexpr?/recur v rec)]
[else (xexpr?/recur v rec)]))
;; Any [Any -> Bool] -> Bool
;; the `rec` predicate should not overlap with `txexpr-attrs?`
(define (xexpr?/recur v rec)
(cond
[(pair? v) (txexpr?/recur v txexpr-tag? txexpr-attrs? rec)]
[(string? v) #true]
[(symbol? v) #true]
[(integer? v) (valid-char? v)]
[(cdata? v) #true]
[(comment? v) #true]
[(p-i? v) #true]
[else #false]))
;; Any [Any -> Bool] -> Bool
;; the `rec` predicate should not overlap with
;; `stx-txexpr-attrs?`
(define (stx-txexpr?/recur v rec)
;; Even if it's not stx, the cdr or cddr might be syntax.
;; This flattens it so that the cdd...r is always a pair or empty.
(define lst (stx->list v))
(and lst (txexpr?/recur lst stx-txexpr-tag? stx-txexpr-attrs? rec)))
;; Any -> Bool
(define (stx-txexpr-tag? v)
(cond
[(syntax? v) (txexpr-tag? (syntax-e v))]
[else (txexpr-tag? v)]))
;; Any -> Bool
(define (stx-txexpr-attrs? v)
(txexpr-attrs? (syntax->datum (datum->syntax #f v))))
;; ---------------------------------------------------------
;; Accessors
;; StxTxexpr -> (values StxTag StxAttrs StxElements)
(define (stx-txexpr->values v)
(txexpr->values/attrs? (stx->list v) stx-txexpr-attrs?))
;; StxTxexpr -> (List StxTag StxAttrs StxElements)
(define (stx-txexpr->list v)
(define-values [tag attrs elements] (stx-txexpr->values v))
(list tag attrs elements))
;; StxTxexpr -> StxTag
(define (stx-txexpr-tag v)
(define-values [tag attrs elements] (stx-txexpr->values v))
tag)
;; StxTxexpr -> StxAttrs
(define (stx-txexpr-attrs v)
(define-values [tag attrs elements] (stx-txexpr->values v))
attrs)
;; StxTxexpr -> StxElements
(define (stx-txexpr-elements v)
(define-values [tag attrs elements] (stx-txexpr->values v))
elements)
;; ---------------------------------------------------------
(module+ safe
(provide (all-defined-out)))

@ -1,63 +0,0 @@
#lang racket/base
(provide values->list
check-values=?
check/values)
(require rackunit
(for-syntax racket/base))
;; Takes an expression producing an unknown number of values
;; and wraps them all in a list.
(define-syntax-rule (values->list values-expr)
(call-with-values (λ () values-expr) list))
;; Checks that two expressions (each producing an unknown
;; number of values until evaluated) produce the same number
;; of values, and that the values are equal.
(define-syntax check-values=?
(lambda (stx)
(syntax-case stx []
[(_ actual-expr expected-expr)
(syntax/loc stx
(check/values check-equal? actual-expr expected-expr))])))
(define-syntax check/values
(lambda (stx)
(syntax-case stx []
[(_ check-form actual-expr expected-expr)
(syntax/loc stx
(check-form (vs actual-expr) (vs expected-expr)))])))
;; Takes an expression producing an unknown number of values
;; and wraps them in a "fake-values" structure that can be
;; compared with other fake-values structures for equality,
;; and can be printed to look like a call to `values`.
(define-syntax-rule (vs values-expr)
(fake-values (values->list values-expr)))
;; if make-constructor-style-printer from racket/struct exists,
;; this is it, and otherwise this is a cheap immitation.
(define make-constructor-style-printer
(with-handlers ([exn:fail:filesystem?
(λ (e)
(λ (get-head get-elems)
(λ (v out mode)
(define head (get-head v))
(define elems (get-elems v))
(fprintf out "(~a" head)
(for ([elem elems])
(fprintf out " ~v" elem))
(fprintf out ")"))))])
(dynamic-require 'racket/struct 'make-constructor-style-printer)))
(struct fake-values [list]
#:transparent
#:methods gen:custom-write
[(define write-proc
(make-constructor-style-printer
(lambda (self) 'values)
(lambda (self) (fake-values-list self))))])

@ -1,16 +0,0 @@
#lang racket/base
(require (submod "../main.rkt" safe))
(module+ test
(require rackunit))
(module+ test
(check-exn (regexp (string-append
"txexpr.*: contract violation\n"
" *expected: txexpr-tag\\?\n"
" *given: 4\n"
" *in: the 1st argument.*"
" *blaming: .*test/contract-tests.rkt"))
(λ () (txexpr 4)))
)

@ -1,115 +0,0 @@
#lang racket/base
(require rackunit "../stx.rkt" "check-values.rkt"
(for-syntax racket/base))
;; Works on fully wrapped, non-wrapped, and partially
;; wrapped values, and it checks that the the inputs
;; are wrapped in all the same places. It checks scopes,
;; but it does not check source location.
(define-binary-check (check-stx=? stx=? actual expected))
(define (stx=? a b)
(cond
[(and (identifier? a) (identifier? b))
(bound-identifier=? a b)]
[(and (syntax? a) (syntax? b))
(and (bound-identifier=? (datum->syntax a '||) (datum->syntax b '||))
(stx=? (syntax-e a) (syntax-e b)))]
[else
(equal?/recur a b stx=?)]))
(define-syntax check-values-stx=?
(lambda (stx)
(syntax-case stx []
[(_ actual-expr expected-expr)
(syntax/loc stx
(check/values check-stx=? actual-expr expected-expr))])))
;; ---------------------------------------------------------
;; Predicates
(check-pred stx-xexpr? "A leaf on a string")
(check-pred stx-xexpr? #'"A leaf in syntax")
(check-pred stx-xexpr? #'(div))
(check-pred stx-xexpr? #'(div ((id "top")) "Hello" (p "World")))
(check-pred stx-xexpr? `(div ((id ,#'"top")) "Hello" ,#'(p "World")))
(check-false (stx-txexpr? "A leaf without a tag"))
(check-pred stx-txexpr? '(div))
(check-pred stx-txexpr? #'(div))
(check-pred stx-txexpr? #'(div ((id "top")) "Hello" (p "World")))
(check-pred stx-txexpr? `(div ((id ,#'"top")) "Hello" ,#'(p "World")))
(check-pred stx-txexpr-tag? 'div)
(check-pred stx-txexpr-tag? #'div)
(check-pred stx-txexpr-tag? 'this-is-something-else)
(check-pred stx-txexpr-tag? #'this-is-something-else)
(check-pred stx-txexpr-attrs? '())
(check-pred stx-txexpr-attrs? #'())
(check-pred stx-txexpr-attrs? '((id "top") (style "color: blue")))
(check-pred stx-txexpr-attrs? #'((id "top") (style "color: blue")))
(check-pred stx-txexpr-attrs? `((id "top") (style ,#'"color: blue")))
;; ---------------------------------------------------------
;; Accessors
(check-values-stx=? (stx-txexpr->values '(p))
(values 'p null null))
(check-values-stx=? (stx-txexpr->values '(p "foo"))
(values 'p null '("foo")))
(check-values-stx=? (stx-txexpr->values '(p ((key "value"))))
(values 'p '((key "value")) null))
(check-values-stx=? (stx-txexpr->values '(p ((key "value")) "foo"))
(values 'p '((key "value")) '("foo")))
(check-values-stx=? (stx-txexpr->values #'(p))
(values #'p null null))
(check-values-stx=? (stx-txexpr->values #'(p "foo"))
(values #'p null (list #'"foo")))
(check-values-stx=? (stx-txexpr->values #'(p ((key "value"))))
(values #'p #'((key "value")) null))
(check-values-stx=? (stx-txexpr->values #'(p ((key "value")) "foo"))
(values #'p #'((key "value")) (list #'"foo")))
(check-values-stx=? (stx-txexpr->values `(,#'p))
(values #'p null null))
(check-values-stx=? (stx-txexpr->values `(p ,#'"foo"))
(values 'p null (list #'"foo")))
(check-values-stx=? (stx-txexpr->values `(p ((,#'key "value")) . ,#'("foo")))
(values 'p `((,#'key "value")) (list #'"foo")))
(check-stx=? (stx-txexpr-tag '(p ((key "value"))"foo" (em "square")))
'p)
(check-stx=? (stx-txexpr-tag #'(p ((key "value"))"foo" (em "square")))
#'p)
(check-stx=? (stx-txexpr-attrs '(p ((key "value"))"foo" "bar" (em "square")))
'((key "value")))
(check-stx=? (stx-txexpr-attrs #'(p ((key "value"))"foo" "bar" (em "square")))
#'((key "value")))
(check-stx=? (stx-txexpr-attrs '(p "foo" "bar" (em "square")))
'())
(check-stx=? (stx-txexpr-attrs #'(p "foo" "bar" (em "square")))
'())
(check-stx=? (stx-txexpr-elements '(p "foo" "bar" (em "square")))
'("foo" "bar" (em "square")))
(check-stx=? (stx-txexpr-elements #'(p "foo" "bar" (em "square")))
(list #'"foo" #'"bar" #'(em "square")))
(check-stx=? (stx-txexpr-elements '(p ((k "v"))"foo" "bar" (em "square")))
'("foo" "bar" (em "square")))
(check-stx=? (stx-txexpr-elements #'(p ((k "v"))"foo" "bar" (em "square")))
(list #'"foo" #'"bar" #'(em "square")))
(check-stx=? (stx-txexpr-elements #'(p ((k "v"))"foo" . ("bar" (em "square"))))
(list #'"foo" #'"bar" #'(em "square")))
(check-stx=? (stx-txexpr-elements `(p ((k "v"))"foo" .,#'("bar" (em "square"))))
(list "foo" #'"bar" #'(em "square")))
;; ---------------------------------------------------------
Loading…
Cancel
Save