add `define-tag-function`

scribblings/programming-pollen.scrbl

@@ -177,15 +177,14 @@ Be careful if you're working with integers and X-expressions — a raw integer i
 
 @subsection{Parsing attributes}
 
-Detecting attributes in an argument list can be tricky because a) the tag may or may not have attributes, b) those attributes may be in standard or abbreviated syntax. For this reason, Pollen provides a @racket[split-attributes] function (in the @racket[pollen/tag] library) that you can use in custom tag functions to separate the attributes and elements:
+Detecting attributes in an argument list can be tricky because a) the tag may or may not have attributes, b) those attributes may be in standard or abbreviated syntax. For this reason, Pollen provides a @racket[define-tag-function] macro (in the @racket[pollen/tag] library) that you can use in custom tag functions to separate the attributes and elements:
 
 @fileblock["article.html.pm" @codeblock{
 #lang pollen
 
 ◊(require pollen/tag)
 
-◊(define (em . parts) 
+◊(define-tag-function (em attributes elements) 
-  (define-values (attributes elements) (split-attributes parts))
   `(extra ,attributes (big ,@"@"elements)))
 
 I want to attend ◊em[#:key "value"]{RacketCon}.}]

scribblings/tag.scrbl

@@ -58,18 +58,16 @@ Note that while default tag functions are typically used to generate tagged X-ex
 
 
 
-@defproc[
+@defform[
-(split-attributes
+(define-tag-function
-[parts list?])
+(tag-id attr-id elem-id) body ...)]
-(values txexpr-attrs? txexpr-elements?)]
+Helper function for making custom tag functions. Handles parsing chores, including conversion of keyword arguments into attributes (described in @racket[make-default-tag-function]), and parses other attributes and elements normally.
-Helper function for custom tag functions. Take a rest argument that possibly includes tag attributes plus elements, and split it into attributes and elements. If there are no attributes, that return value will be the empty list. Properly parses the abbreviated Pollen syntax for attributes (described in @racket[make-default-tag-function]).
 
 @examples[
 (require pollen/tag)
-(define (tag . parts) 
+(define-tag-function (tag-name attrs elems) 
-  (define-values (attrs elements) (split-attributes parts))
+  `(new-name ,(cons '(zim "zam") attrs) ,@elems))
-  (values attrs elements))
+(tag-name "Hello world")
-(tag "Hello world")
+(tag-name '((key "value")) "Hello world")
-(tag '((key "value")) "Hello world")
+(tag-name #:key "value" "Hello world")
-(tag #:key "value" "Hello world")
 ]

tag.rkt

@@ -1,4 +1,5 @@
-#lang racket/base
+#lang pollen/mode racket/base
+(require (for-syntax racket/base))
 (require txexpr sugar/define racket/string racket/match)
 
 
@@ -10,7 +11,7 @@
      (define (make-one-tag id)
        (make-keyword-procedure
         (λ (inner-kws inner-kw-args . attrs+xs)
-
+          
           ;; Three possible sources of attrs:
           ;; 1) normal attrs, in a list at the front of the args
           ;; 2) colon args, using special 'key: "value" syntax, also at the front of the args
@@ -48,6 +49,10 @@
        (procedure-rename tag-proc tag-proc-name)))))
 
 
+;; deprecated since `define-tag-function`.
+;; Does not and cannot handle keywords correctly (for attributes)
+;; because it wants a function arity like (proc . parts),
+;; which converts keywords into positional arguments.
 (define/contract+provide (split-attributes parts)
   (list? . -> . (values txexpr-attrs? txexpr-elements?))
   (define dummy-tag (gensym))
@@ -59,14 +64,48 @@
 (module+ test
   (require rackunit)
   (define outerdiv (make-default-tag-function 'div #:class "outer" #:style "outer"))
-  (check-equal? (outerdiv "foo") '(div ((class "outer") (style "outer")) "foo"))
+  (check-txexprs-equal? (outerdiv "foo") '(div ((class "outer") (style "outer")) "foo"))
-  (check-equal? (outerdiv) '(div ((class "outer") (style "outer"))))
+  (check-txexprs-equal? (outerdiv) '(div ((class "outer") (style "outer"))))
-  (check-equal? (outerdiv #:class "inner") '(div ((class "outer") (style "outer") (class "inner"))))
+  (check-txexprs-equal? (outerdiv #:class "inner") '(div ((class "outer") (style "outer") (class "inner"))))
-  (check-equal? (outerdiv #:class "inner" "foo") '(div ((class "outer") (style "outer") (class "inner")) "foo"))
+  (check-txexprs-equal? (outerdiv #:class "inner" "foo") '(div ((class "outer") (style "outer") (class "inner")) "foo"))
-  ;; `make-keyword-procedure` sorts keyword arguments alphabetically, so 'field' ends up before 'id'
+  (check-txexprs-equal? (outerdiv #:field "greens" #:id "shazbot" "foo") '(div ((class "outer") (style "outer") (field "greens") (id "shazbot")) "foo"))
-  (check-equal? (outerdiv #:id "shazbot" #:field "greens" "foo") '(div ((class "outer") (style "outer") (field "greens") (id "shazbot")) "foo"))
+  (check-txexprs-equal? (outerdiv 'id: "shazbot" "foo") '(div ((class "outer") (style "outer") (id "shazbot")) "foo"))
-  (check-equal? (outerdiv 'id: "shazbot" "foo") '(div ((class "outer") (style "outer") (id "shazbot")) "foo"))
+  (check-txexprs-equal? (outerdiv '((id "shazbot")) "foo") '(div ((class "outer") (style "outer") (id "shazbot")) "foo"))
-  (check-equal? (outerdiv '((id "shazbot")) "foo") '(div ((class "outer") (style "outer") (id "shazbot")) "foo"))
+  (check-txexprs-equal? (outerdiv 'id: "shazbot" 'class: "inner" "foo") '(div ((class "outer") (style "outer") (id "shazbot") (class "inner")) "foo"))
-  (check-equal? (outerdiv 'id: "shazbot" 'class: "inner" "foo") '(div ((class "outer") (style "outer") (id "shazbot") (class "inner")) "foo"))
   ;; (outerdiv 'id: "shazbot" '((class "inner")) "foo") won't work because colon attrs supplant conventional attrs (docs concur)
-  (check-equal? (outerdiv 'id: "shazbot" #:class "inner" "foo") '(div ((class "outer") (style "outer") (class "inner") (id "shazbot")) "foo")))
+  (check-txexprs-equal? (outerdiv 'id: "shazbot" #:class "inner" "foo") '(div ((class "outer") (style "outer") (class "inner") (id "shazbot")) "foo")))
+
+
+(provide define-tag-function)
+(define-syntax (define-tag-function stx)
+  (syntax-case stx (λ)
+    [(_ (ID ARG ...) EXPR ...)
+     #'(define-tag-function ID (λ (ARG ...) EXPR ...))]
+    [(_ ID (λ (ATTRS ELEMS) EXPR0 EXPR ...))
+     #'(define ID
+         (make-keyword-procedure
+          (λ (kws kwargs . args)
+            (define tx-proc (keyword-apply make-default-tag-function kws kwargs (list 'ID)))
+            (define tx (apply tx-proc args))
+            (define-values (_ ATTRS ELEMS) (txexpr->values tx))
+            EXPR0 EXPR ...)))]
+    [(_ ID (λ (ATTRS ELEMS)))
+     (raise-syntax-error 'define-tag-function (format "bad syntax (no expressions for procedure body) in ~a" (syntax->datum stx)))]
+    [(_ ID (λ (ARG ...) EXPR ...)) (raise-syntax-error 'define-tag-function (format "bad syntax (arity must be exactly 2 positional arguments) in ~a" (cadr (syntax->datum stx))))]))
+
+
+(module+ test
+  (require rackunit)
+   (define foo2 (make-default-tag-function 'foo))
+  
+  (define-tag-function (foo attrs elems)
+    `(foo ,(reverse attrs) ,@elems))
+  (check-txexprs-equal? ◊foo[#:zim "zam"]{hello}  ◊foo2[#:zim "zam"]{hello})
+  (check-txexprs-equal? ◊foo[#:ding "dong" '((zim "zam"))]{hello}  ◊foo2[#:ding "dong" '((zim "zam"))]{hello})
+  (check-txexprs-equal? ◊foo['zim: "zam" #:ding "dong" ]{hello} ◊foo2['zim: "zam" #:ding "dong" ]{hello})
+
+ (define-tag-function foolam (λ (attrs elems)
+    `(foo ,(reverse attrs) ,@elems)))
+  (check-txexprs-equal? ◊foolam[#:zim "zam"]{hello}  ◊foo2[#:zim "zam"]{hello})
+  (check-txexprs-equal? ◊foolam[#:ding "dong" '((zim "zam"))]{hello}  ◊foo2[#:ding "dong" '((zim "zam"))]{hello})
+  (check-txexprs-equal? ◊foolam['zim: "zam" #:ding "dong" ]{hello} ◊foo2['zim: "zam" #:ding "dong" ]{hello}))