The cl-jsx Reference Manual

Table of Contents

The cl-jsx Reference Manual

This is the cl-jsx Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:18:41 2020 GMT+0.

1 Introduction

CL-JSX

JSX in Common Lisp

Embedded JSX syntax

To enable JSX syntax, evaluate:

(jsx:enable-jsx-syntax)

JSX elements are specified with #<tag></tag>

Example:

(who:with-html-output-to-string (html) 
           (let ((hello "asdf")) 
             #<lala aaa="asd {when nil "false"}" yes={hello}>
             {loop 
             for x from 1 to 10
                 do #<p class="{when t "asdf"}">{hello}</p>}
             </lala>))

Result:

=> "<lala aaa='asd ' yes='asdf'>
             <p class='asdf'>asdf</p><p class='asdf'>asdf</p><p class='asdf'>asdf</p><p class='asdf'>asdf</p><p class='asdf'>asdf</p><p class='asdf'>asdf</p><p class='asdf'>asdf</p><p class='asdf'>asdf</p><p class='asdf'>asdf</p><p class='asdf'>asdf</p>
             </lala>"

At the moment, the rendering is done using CL-WHO, but other backends implementations are also possible:

Macro expansion of JSX above:

(WITH-OUTPUT-TO-STRING (HTML NIL)
  (CL-WHO:WITH-HTML-OUTPUT (HTML NIL :PROLOGUE NIL :INDENT NIL)
    (LET ((HELLO "asdf"))
      (PROGN
       (CL-WHO:HTM
        (:LALA :AAA
         (WITH-OUTPUT-TO-STRING (#:ATTR755)
           (WRITE-STRING "asd " #:ATTR755)
           (LET ((#:ATTRVAL756 (WHEN NIL "false")))
             (WHEN #:ATTRVAL756 (PRINC #:ATTRVAL756 #:ATTR755))))
         :YES HELLO
         (CL-WHO:STR "
             ")
         (CL-WHO:STR
          (LOOP FOR X FROM 1 TO 10
                DO (PROGN
                    (CL-WHO:HTM
                     (:P :CLASS
                      (WITH-OUTPUT-TO-STRING (#:ATTR757)
                        (LET ((#:ATTRVAL758 (WHEN T "asdf")))
                          (WHEN #:ATTRVAL758 (PRINC #:ATTRVAL758 #:ATTR757))))
                      (CL-WHO:STR HELLO)))
                    NIL)))
         (CL-WHO:STR "
             ")))
       NIL))))

2 Systems

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

2.1 cl-jsx

Author

Mariano Montone <marianomontone@gmail.com>

License

MIT

Description

JSX in Common Lisp

Version

0.0.1

Dependencies

• cl-who
• esrap
• named-readtables

Source

cl-jsx.asd (file)

Components

• packages.lisp (file)
• parser.lisp (file)
• who.lisp (file)
• cl-jsx.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-jsx.asd

Location

cl-jsx.asd

Systems

cl-jsx (system)

Packages

cl-jsx-asd

3.1.2 cl-jsx/packages.lisp

Parent

cl-jsx (system)

Location

packages.lisp

Packages

cl-jsx

3.1.3 cl-jsx/parser.lisp

Dependency

packages.lisp (file)

Parent

cl-jsx (system)

Location

parser.lisp

Packages

jsx.parser

Exported Definitions

parse-jsx (function)

Internal Definitions

flatten-content (function)

3.1.4 cl-jsx/who.lisp

Dependency

parser.lisp (file)

Parent

cl-jsx (system)

Location

who.lisp

Packages

jsx.who

Exported Definitions

emit-who (function)

Internal Definitions

• %emit-who (generic function)
• %emit-who (method)
• *spliced-read* (special variable)
• emit-attribute-value (function)
• emit-attributes (function)
• emit-content (function)
• make-keyword (function)
• read-escaped-jsx (function)

3.1.5 cl-jsx/cl-jsx.lisp

Dependency

who.lisp (file)

Parent

cl-jsx (system)

Location

cl-jsx.lisp

Exported Definitions

enable-jsx-syntax (function)

Internal Definitions

• read-jsx (function)
• read-jsx-content (function)
• read-until-close-tag (function)

4 Packages

Packages are listed by definition order.

4.1 cl-jsx-asd

Source

cl-jsx.asd

Use List

• asdf/interface
• common-lisp

4.2 cl-jsx

Source

packages.lisp (file)

Nickname

jsx

Use List

common-lisp

Exported Definitions

enable-jsx-syntax (function)

Internal Definitions

• read-jsx (function)
• read-jsx-content (function)
• read-until-close-tag (function)

4.3 jsx.parser

Source

parser.lisp (file)

Use List

• esrap
• common-lisp

Exported Definitions

parse-jsx (function)

Internal Definitions

flatten-content (function)

4.4 jsx.who

Source

who.lisp (file)

Use List

common-lisp

Exported Definitions

emit-who (function)

Internal Definitions

• %emit-who (generic function)
• %emit-who (method)
• *spliced-read* (special variable)
• emit-attribute-value (function)
• emit-attributes (function)
• emit-content (function)
• make-keyword (function)
• read-escaped-jsx (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: emit-who JSX

Package

jsx.who

Source

who.lisp (file)

Function: enable-jsx-syntax ()

Package

cl-jsx

Source

cl-jsx.lisp (file)

Function: parse-jsx TEXT &rest ARGS &key START END JUNK-ALLOWED RAW

Package

jsx.parser

Source

parser.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *spliced-read*

Package

jsx.who

Source

who.lisp (file)

5.2.2 Functions

Function: emit-attribute-value VALUE

Package

jsx.who

Source

who.lisp (file)

Function: emit-attributes ATTRIBUTES

Package

jsx.who

Source

who.lisp (file)

Function: emit-content CONTENT

Package

jsx.who

Source

who.lisp (file)

Function: flatten-content CONTENT

Package

jsx.parser

Source

parser.lisp (file)

Function: make-keyword STRING

Package

jsx.who

Source

who.lisp (file)

Function: read-escaped-jsx STRING

Package

jsx.who

Source

who.lisp (file)

Function: read-jsx STREAM &key PARSE-OPEN

Package

cl-jsx

Source

cl-jsx.lisp (file)

Function: read-jsx-content STREAM CONTENT &key PARSE-OPEN

Package

cl-jsx

Source

cl-jsx.lisp (file)

Function: read-until-close-tag TAG-NAME STREAM CONTENT

Package

cl-jsx

Source

cl-jsx.lisp (file)

5.2.3 Generic functions

Generic Function: %emit-who ELEMENT-TYPE ELEMENT

Package

jsx.who

Source

who.lisp (file)

Methods

Method: %emit-who (TYPE (eql element)) ELEMENT

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types