Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The cl-jsx Reference Manual

This is the cl-jsx Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 12:18:20 2023 GMT+0.

Next: Systems, Previous: The cl-jsx Reference Manual, Up: The cl-jsx Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The cl-jsx Reference Manual [Contents][Index]

2 Systems

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

cl-jsx

Previous: Systems, Up: Systems [Contents][Index]

2.1 `cl-jsx`

JSX in Common Lisp

Author

Mariano Montone <marianomontone@gmail.com>

License

MIT

Version

0.0.1

Dependencies

cl-who (system).
esrap (system).
named-readtables (system).

Source

cl-jsx.asd.

Child Components

packages.lisp (file).
parser.lisp (file).
who.lisp (file).
cl-jsx.lisp (file).

Next: Packages, Previous: Systems, Up: The cl-jsx Reference Manual [Contents][Index]

3 Files

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

Lisp

Previous: Files, Up: Files [Contents][Index]

Next: cl-jsx/packages.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `cl-jsx/cl-jsx.asd`

Source: cl-jsx.asd.
Parent Component: cl-jsx (system).
ASDF Systems: cl-jsx.
Packages: cl-jsx-asd.

Next: cl-jsx/parser.lisp, Previous: cl-jsx/cl-jsx.asd, Up: Lisp [Contents][Index]

3.1.2 `cl-jsx/packages.lisp`

Source: cl-jsx.asd.
Parent Component: cl-jsx (system).
Packages: cl-jsx.

Next: cl-jsx/who.lisp, Previous: cl-jsx/packages.lisp, Up: Lisp [Contents][Index]

3.1.3 `cl-jsx/parser.lisp`

Dependency: packages.lisp (file).
Source: cl-jsx.asd.
Parent Component: cl-jsx (system).
Packages: jsx.parser.
Public Interface: parse-jsx (function).
Internals: flatten-content (function).

Next: cl-jsx/cl-jsx.lisp, Previous: cl-jsx/parser.lisp, Up: Lisp [Contents][Index]

3.1.4 `cl-jsx/who.lisp`

Dependency

parser.lisp (file).

Source

cl-jsx.asd.

Parent Component

cl-jsx (system).

Packages

jsx.who.

Public Interface

emit-who (function).

Internals

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

Previous: cl-jsx/who.lisp, Up: Lisp [Contents][Index]

3.1.5 `cl-jsx/cl-jsx.lisp`

Dependency

who.lisp (file).

Source

cl-jsx.asd.

Parent Component

cl-jsx (system).

Public Interface

enable-jsx-syntax (function).

Internals

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

Next: Definitions, Previous: Files, Up: The cl-jsx Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

jsx.parser
cl-jsx
jsx.who
cl-jsx-asd

Next: cl-jsx, Previous: Packages, Up: Packages [Contents][Index]

4.1 `jsx.parser`

Source

parser.lisp.

Use List

common-lisp.
esrap.

Public Interface

parse-jsx (function).

Internals

flatten-content (function).

Next: jsx.who, Previous: jsx.parser, Up: Packages [Contents][Index]

4.2 `cl-jsx`

Source

packages.lisp.

Nickname

jsx

Use List

common-lisp.

Public Interface

enable-jsx-syntax (function).

Internals

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

Next: cl-jsx-asd, Previous: cl-jsx, Up: Packages [Contents][Index]

4.3 `jsx.who`

Source

who.lisp.

Use List

common-lisp.

Public Interface

emit-who (function).

Internals

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

Previous: jsx.who, Up: Packages [Contents][Index]

4.4 `cl-jsx-asd`

Source

cl-jsx.asd.

Use List

asdf/interface.
common-lisp.

Next: Indexes, Previous: Packages, Up: The cl-jsx Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

5.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Ordinary functions

Function: emit-who (jsx) ¶

Package: jsx.who.
Source: who.lisp.

Function: enable-jsx-syntax () ¶

Package: cl-jsx.
Source: cl-jsx.lisp.

Function: parse-jsx (text &rest args &key start end junk-allowed raw) ¶

Package: jsx.parser.
Source: parser.lisp.

Previous: Public Interface, Up: Definitions [Contents][Index]

5.2 Internals

Special variables
Ordinary functions
Generic functions

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Special variables

Special Variable: *spliced-read* ¶

Package: jsx.who.
Source: who.lisp.

Next: Generic functions, Previous: Special variables, Up: Internals [Contents][Index]

5.2.2 Ordinary functions

Function: emit-attribute-value (value) ¶

Package: jsx.who.
Source: who.lisp.

Function: emit-attributes (attributes) ¶

Package: jsx.who.
Source: who.lisp.

Function: emit-content (content) ¶

Package: jsx.who.
Source: who.lisp.

Function: flatten-content (content) ¶

Package: jsx.parser.
Source: parser.lisp.

Function: make-keyword (string) ¶

Package: jsx.who.
Source: who.lisp.

Function: read-escaped-jsx (string) ¶

Package: jsx.who.
Source: who.lisp.

Function: read-jsx (stream &key parse-open) ¶

Package: cl-jsx.
Source: cl-jsx.lisp.

Function: read-jsx-content (stream content &key parse-open) ¶

Package: cl-jsx.
Source: cl-jsx.lisp.

Function: read-until-close-tag (tag-name stream content) ¶

Package: cl-jsx.
Source: cl-jsx.lisp.

Previous: Ordinary functions, Up: Internals [Contents][Index]

5.2.3 Generic functions

Generic Function: %emit-who (element-type element) ¶

Package

jsx.who.

Source

who.lisp.

Methods

Method: %emit-who ((type (eql :element)) element) ¶

Previous: Definitions, Up: The cl-jsx Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	% E F G M P R

	Index Entry	Section

%
	`%emit-who`:	Private generic functions
	`%emit-who`:	Private generic functions

E
	`emit-attribute-value`:	Private ordinary functions
	`emit-attributes`:	Private ordinary functions
	`emit-content`:	Private ordinary functions
	`emit-who`:	Public ordinary functions
	`enable-jsx-syntax`:	Public ordinary functions

F
	`flatten-content`:	Private ordinary functions
	`Function, emit-attribute-value`:	Private ordinary functions
	`Function, emit-attributes`:	Private ordinary functions
	`Function, emit-content`:	Private ordinary functions
	`Function, emit-who`:	Public ordinary functions
	`Function, enable-jsx-syntax`:	Public ordinary functions
	`Function, flatten-content`:	Private ordinary functions
	`Function, make-keyword`:	Private ordinary functions
	`Function, parse-jsx`:	Public ordinary functions
	`Function, read-escaped-jsx`:	Private ordinary functions
	`Function, read-jsx`:	Private ordinary functions
	`Function, read-jsx-content`:	Private ordinary functions
	`Function, read-until-close-tag`:	Private ordinary functions

G
	`Generic Function, %emit-who`:	Private generic functions

M
	`make-keyword`:	Private ordinary functions
	`Method, %emit-who`:	Private generic functions

P
	`parse-jsx`:	Public ordinary functions

R
	`read-escaped-jsx`:	Private ordinary functions
	`read-jsx`:	Private ordinary functions
	`read-jsx-content`:	Private ordinary functions
	`read-until-close-tag`:	Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* S

	Index Entry	Section

*
	`spliced-read`:	Private special variables

S
	`Special Variable, spliced-read`:	Private special variables

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	C F J P S W

	Index Entry	Section

C
	`cl-jsx`:	The cl-jsx system
	`cl-jsx`:	The cl-jsx package
	`cl-jsx-asd`:	The cl-jsx-asd package
	`cl-jsx.asd`:	The cl-jsx/cl-jsx․asd file
	`cl-jsx.lisp`:	The cl-jsx/cl-jsx․lisp file

F
	`File, cl-jsx.asd`:	The cl-jsx/cl-jsx․asd file
	`File, cl-jsx.lisp`:	The cl-jsx/cl-jsx․lisp file
	`File, packages.lisp`:	The cl-jsx/packages․lisp file
	`File, parser.lisp`:	The cl-jsx/parser․lisp file
	`File, who.lisp`:	The cl-jsx/who․lisp file

J
	`jsx.parser`:	The jsx․parser package
	`jsx.who`:	The jsx․who package

P
	`Package, cl-jsx`:	The cl-jsx package
	`Package, cl-jsx-asd`:	The cl-jsx-asd package
	`Package, jsx.parser`:	The jsx․parser package
	`Package, jsx.who`:	The jsx․who package
	`packages.lisp`:	The cl-jsx/packages․lisp file
	`parser.lisp`:	The cl-jsx/parser․lisp file

S
	`System, cl-jsx`:	The cl-jsx system

W
	`who.lisp`:	The cl-jsx/who․lisp file

The cl-jsx Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-jsx

3 Files

3.1 Lisp

3.1.1 cl-jsx/cl-jsx.asd

3.1.2 cl-jsx/packages.lisp

3.1.3 cl-jsx/parser.lisp

3.1.4 cl-jsx/who.lisp

3.1.5 cl-jsx/cl-jsx.lisp

4 Packages

4.1 jsx.parser

4.2 cl-jsx

4.3 jsx.who

4.4 cl-jsx-asd

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.2 Internals

5.2.1 Special variables

5.2.2 Ordinary functions

5.2.3 Generic functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-jsx`

3.1.1 `cl-jsx/cl-jsx.asd`

3.1.2 `cl-jsx/packages.lisp`

3.1.3 `cl-jsx/parser.lisp`

3.1.4 `cl-jsx/who.lisp`

3.1.5 `cl-jsx/cl-jsx.lisp`

4.1 `jsx.parser`

4.2 `cl-jsx`

4.3 `jsx.who`

4.4 `cl-jsx-asd`