The cl-fxml Reference Manual

Table of Contents

The cl-fxml Reference Manual

This is the cl-fxml Reference Manual, version 1.2.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 14:47:59 2021 GMT+0.

1 Introduction

Installation

(ql:quickload "cl-fxml")

Usage

For template code interleaved with normal code including top-level forms use:

(named-readtables:in-readtable cl-fxml:syntax)

or wrap you normal code interleaving template code with with-xml:

(cl-fxml:with-xml
  ((:p)
    "Paragraph number one.))

The variable cl-fxml:*new-line-after-opening* controls whether to make a newline after > of the opening tags.

Examples

((:html)
  ((:head)
    ((:title) "Html example"))
  ((:body)
    ((:a :href "#") "Lorem ipsum dolor sit amet")))

Output redirection to string:

(let ((str (make-array '(0) :element-type 'base-char :fill-pointer 0 :adjustable t)))
  (with-output-to-string (*standard-output* str)
    ((:html)
      ((:head)
        ((:title) "Html example"))
      ((:body)
        ((:a :href "#") "Lorem ipsum dolor sit amet"))))
  str)

Interleaving code:

(let ((x 25))
  ((:root :x x 'attribute-without-value)
    (loop for i below 10
          do ((:element :index i)
               (format t "~:r" i)))))

A template in a variable:

(defvar *x* '((:element :x x) "Test"))

((:root 'blah)
  (eval `(cl-fxml:with-xml
           (let ((x 123))
             ,*x*))))

Comment:

((:!-- "This is a comment."))

For lower case use the standard symbol character escaping (e.g. :|RootElement|):

((:|RootElement| '|Blah|)
  ((:|Test|)
    "Content"))

CDATA:

((:![CDATA[ "Raw data with symbols < >"))

Billion laughs attack:

((:?xml :version "1.0"))
((:!doctype 'lolz "["
  ((:!entity "lol0" (format nil "~s" "lol")))
  ((:!element 'lolz "(#PCDATA)"))
  (loop for i from 1 below 10
    do ((:!entity (format nil "lol~a" i)
                  (format nil "~s"
                          (apply #'concatenate 'string
                                 (loop repeat 10
                                   collect (format nil "&lol~a;" (1- i))))))))
  "]"))
((:lolz)
  "&lol9;")

TODO

• [x] comments <!-- ... -->
• [x] escaping <![CDATA[ ... ]]>, ampersand escape sequences
• [ ] in-place computation of tags and attributes, seems hard to do
• [ ] hook for transforming values which aren't tags, we're now accepting strings (perhaps using multiple values for distinguishing nil caused by tags from other values)

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-fxml

Author

Goheeca <goheeca@gmail.com>

License

MIT

Description

cl-fxml: Common Lisp - Finally eXtended Markup Language.

Version

1.2.1

Dependencies

• agnostic-lizard
• named-readtables

Source

cl-fxml.asd (file)

Component

cl-fxml.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 cl-fxml.asd

Location

cl-fxml.asd

Systems

cl-fxml (system)

3.1.2 cl-fxml/cl-fxml.lisp

Parent

cl-fxml (system)

Location

cl-fxml.lisp

Packages

cl-fxml

Exported Definitions

• *indent-size* (special variable)
• *new-line-after-opening* (special variable)
• with-xml (macro)

Internal Definitions

• *extended-readtable* (special variable)
• *indentation* (special variable)
• process-xml (function)
• setup (function)
• walk-xml (function)
• xml-p (function)

4 Packages

Packages are listed by definition order.

4.1 cl-fxml

Source

cl-fxml.lisp (file)

Use List

• editor-hints.named-readtables
• agnostic-lizard
• common-lisp

Exported Definitions

• *indent-size* (special variable)
• *new-line-after-opening* (special variable)
• with-xml (macro)

Internal Definitions

• *extended-readtable* (special variable)
• *indentation* (special variable)
• process-xml (function)
• setup (function)
• walk-xml (function)
• xml-p (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *indent-size*

Package

cl-fxml

Source

cl-fxml.lisp (file)

Special Variable: *new-line-after-opening*

Package

cl-fxml

Source

cl-fxml.lisp (file)

5.1.2 Macros

Macro: with-xml &body BODY

Package

cl-fxml

Source

cl-fxml.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *extended-readtable*

Package

cl-fxml

Source

cl-fxml.lisp (file)

Special Variable: *indentation*

Package

cl-fxml

Source

cl-fxml.lisp (file)

5.2.2 Functions

Function: process-xml FORM WALKER

Package

cl-fxml

Source

cl-fxml.lisp (file)

Function: setup &optional RT

Package

cl-fxml

Source

cl-fxml.lisp (file)

Function: walk-xml FORMS ENV

Package

cl-fxml

Source

cl-fxml.lisp (file)

Function: xml-p FORM

Package

cl-fxml

Source

cl-fxml.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types