The json-template Reference Manual

Table of Contents

The json-template Reference Manual

This is the json-template Reference Manual, version 0.1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Feb 19 19:48:43 2020 GMT+0.

1 Introduction

JSON Template for Common Lisp

Summary

An implementation of JSON Template in Common Lisp.

Implementation Features

• No dependencies
• Portable Common Lisp (tested on SBCL, Clozure CL, ECL, XCL, ABCL)
• HTML and URI escaping through the use of formatters
• Apache license

Missing Things

• Literals (like {.space} and {.meta-left}/{.meta-right})
• Multiple-argument formatters
• Options (like changing the meta character or the default formatter)
• Some kind of compilation for efficiency

Examples

JSON-TEMPLATE> (defparameter *tmpl* (parse-template-string "
<h1>{title|html}</h1>
{.section people}
<ul>
{.repeated section @}
  <li>{name} ({age} years)</li>
{.end}
</ul>
{.or}
<p>No one's registered.</p>
{.end}"))
*TMPL*

JSON-TEMPLATE> (expand-template *tmpl*
                                '(:title "<Registered People>"
                                  :people ((:name "Nathalie" :age 24)
                                           (:name "Heinrich" :age 28)
                                           (:name "Hans"     :age 25))))
"
<h1>&#60;Registered People&#62;</h1>
<ul>
  <li>Nathalie (24 years)</li>
  <li>Heinrich (28 years)</li>
  <li>Hans (25 years)</li>
</ul>
"

JSON-TEMPLATE> (expand-template *tmpl*
                                '(:title "<Registered People>"
                                  :people ()))
"
<h1>&#60;Registered People&#62;</h1>
<p>No one's registered.</p>
"

2 Systems

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

2.1 json-template

Author

Matthias Andreas Benkard

License

Apache License, version 2.0

Description

An implementation of a subset of the JSON Template language.

Version

0.1.0

Source

json-template.asd (file)

Components

• json-template.lisp (file)
• formatters.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 json-template.asd

Location

json-template.asd

Systems

json-template (system)

3.1.2 json-template/json-template.lisp

Parent

json-template (system)

Location

json-template.lisp

Packages

json-template

Exported Definitions

• expand-template (function)
• parse-template-string (function)

Internal Definitions

• +not-found+ (constant)
• expand-template-to-stream (function)
• expand-things-to-stream (function)
• getcontext (function)
• listify-key (function)
• lookup-context (function)
• parse-directive (function)
• parse-raw-tokens (function)
• parse-token (function)
• parse-tokens (function)
• parse-variable (function)
• template (class)
• template-things (method)
• (setf template-things) (method)
• tokenize-template-string (function)

3.1.3 json-template/formatters.lisp

Dependency

json-template.lisp (file)

Parent

json-template (system)

Location

formatters.lisp

Exported Definitions

*template-formatters* (special variable)

Internal Definitions

• escape-for-uri (function)
• make-escaper (function)

4 Packages

Packages are listed by definition order.

4.1 json-template

Source

json-template.lisp (file)

Use List

common-lisp

Exported Definitions

• *template-formatters* (special variable)
• expand-template (function)
• parse-template-string (function)

Internal Definitions

• +not-found+ (constant)
• escape-for-uri (function)
• expand-template-to-stream (function)
• expand-things-to-stream (function)
• getcontext (function)
• listify-key (function)
• lookup-context (function)
• make-escaper (function)
• parse-directive (function)
• parse-raw-tokens (function)
• parse-token (function)
• parse-tokens (function)
• parse-variable (function)
• template (class)
• template-things (generic function)
• template-things (method)
• (setf template-things) (method)
• (setf template-things) (generic function)
• tokenize-template-string (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: *template-formatters*

Package

json-template

Source

formatters.lisp (file)

5.1.2 Functions

Function: expand-template TEMPLATE CONTEXT

Package

json-template

Source

json-template.lisp (file)

Function: parse-template-string STRING

Package

json-template

Source

json-template.lisp (file)

5.2 Internal definitions

5.2.1 Constants

Constant: +not-found+

Package

json-template

Source

json-template.lisp (file)

5.2.2 Functions

Function: escape-for-uri STRING

Package

json-template

Source

formatters.lisp (file)

Function: expand-template-to-stream TEMPLATE CONTEXTS STREAM

Package

json-template

Source

json-template.lisp (file)

Function: expand-things-to-stream TEMPLATE CONTEXTS STREAM

Package

json-template

Source

json-template.lisp (file)

Function: getcontext CONTEXT KEY &aux RESULT

Package

json-template

Source

json-template.lisp (file)

Function: listify-key KEY &optional START

Package

json-template

Source

json-template.lisp (file)

Function: lookup-context CONTEXTS KEY

Package

json-template

Source

json-template.lisp (file)

Function: make-escaper REPLACEMENTS

Package

json-template

Source

formatters.lisp (file)

Function: parse-directive STRING

Package

json-template

Source

json-template.lisp (file)

Function: parse-raw-tokens TOKENS

Package

json-template

Source

json-template.lisp (file)

Function: parse-token TOKEN

Package

json-template

Source

json-template.lisp (file)

Function: parse-tokens TOKENS

Package

json-template

Source

json-template.lisp (file)

Function: parse-variable STRING

Package

json-template

Source

json-template.lisp (file)

Function: tokenize-template-string STRING

Package

json-template

Source

json-template.lisp (file)

5.2.3 Generic functions

Generic Function: template-things OBJECT

Generic Function: (setf template-things) NEW-VALUE OBJECT

Package

json-template

Methods

Method: template-things (TEMPLATE template)

automatically generated reader method

Source

json-template.lisp (file)

Method: (setf template-things) NEW-VALUE (TEMPLATE template)

automatically generated writer method

Source

json-template.lisp (file)

5.2.4 Classes

Class: template ()

Package

json-template

Source

json-template.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• template-things (method)
• template-things (method)

Direct slots

Slot: things

Initargs

:things

Readers

template-things (generic function)

Writers

(setf template-things) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types