The cl-mustache Reference Manual

Table of Contents

The cl-mustache Reference Manual

This is the cl-mustache Reference Manual, version 0.12.3, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:24:22 2020 GMT+0.

1 Introduction

========
CL-MUSTACHE
========

.. image:: https://travis-ci.org/kanru/cl-mustache.png?branch=master
   :target: https://travis-ci.org/kanru/cl-mustache

Inspired by ctemplate_ and et_, Mustache_ is a
framework-agnostic way to render logic-free views.

As ctemplates says, "It emphasizes separating logic from presentation:
it is impossible to embed application logic in this template language."

CL-MUSTACHE is a Common Lisp implementation of Mustache v1.1.2+λ. Tested with:

 - SBCL 1.0.55
 - CLISP 2.49

CL-MUSTACHE is semantically versioned: http://semver.org.

Documentation
=============

The different Mustache tags are documented at `mustache(5)`_.

Install It
==========

Using quicklisp is recommended.

::

    CL-USER> (ql:quickload "cl-mustache")


Use It
======

Currently accepts context data in alist format, for example:

::

   `((:tag . "string")
     (:array . #(1 2 3 4))
     (:lambda ,(lambda () "world"))
     (:nested . ((:data . t))))

To render the template:

::

    CL-USER> (mustache:render* "Hi {{person}}!" '((:person . "Mom")))
    "Hi Mom!"

Or save the renderer for later use:

::

    CL-USER> (setf view (mustache:compile-template "Hi {{person}}!"))

Or define static renderer function:

::

    CL-USER> (mustache:define view "Hi {{person}}!")
    CL-USER> (view context)

Test It
=======

::

    CL-USR> (ql:quickload "cl-mustache-test")
    CL-USR> (prove:run :cl-mustache-test)

Extend It (Experimental)
========================

Define your tag classes, tag character and render function:

::

    (in-package :mustache)
    (defclass exec-tag (non-standalone-tag)
      ((command :initarg :command :accessor command)))
    (set-mustache-character
      #\$
      (lambda (raw-text arg-text escapep start end)
        (make-instance 'exec-tag :command arg-text)))
    ;; or
    ;; (define-mustache-character #\$
    ;;   (make-instance 'exec-tag :command arg-text))
    (defmethod render-token ((token exec-tag) context template)
       (print-data (run-program-output (command token)) t context))

.. _ctemplate: http://code.google.com/p/google-ctemplate/
.. _et: http://www.ivan.fomichev.name/2008/05/erlang-template-engine-prototype.html
.. _Mustache: http://mustache.github.com/
.. _mustache(5): http://mustache.github.com/mustache.5.html

2 Systems

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

2.1 cl-mustache

Author

Kan-Ru Chen <kanru@kanru.info>

License

MIT/Expat

Description

Mustache Template Renderer

Version

0.12.3

Dependency

uiop

Source

cl-mustache.asd (file)

Components

• packages.lisp (file)
• mustache.lisp (file)
• compat-api-v1.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-mustache.asd

Location

cl-mustache.asd

Systems

cl-mustache (system)

3.1.2 cl-mustache/packages.lisp

Parent

cl-mustache (system)

Location

packages.lisp

Packages

mustache

3.1.3 cl-mustache/mustache.lisp

Dependency

packages.lisp (file)

Parent

cl-mustache (system)

Location

mustache.lisp

Exported Definitions

• *context* (special variable)
• *default-pathname-type* (special variable)
• *escape-tokens* (special variable)
• *load-path* (special variable)
• *output-stream* (special variable)
• compile-template (generic function)
• compile-template (method)
• compile-template (method)
• define (macro)
• make-context (function)
• render (generic function)
• render (method)
• render (method)
• render* (function)
• version (function)

Internal Definitions

• %escape (function)
• %output (function)
• *close-delimiter* (special variable)
• *default-close-delimiter* (special variable)
• *default-open-delimiter* (special variable)
• *default-triple-close-delimiter* (special variable)
• *default-triple-open-delimiter* (special variable)
• *mustache-tag-table* (special variable)
• *open-delimiter* (special variable)
• *real-standard-output* (special variable)
• *triple-close-delimiter* (special variable)
• *triple-open-delimiter* (special variable)
• alist (type)
• ampersand-tag (class)
• beginning-of-line (special variable)
• beginning-of-line (class)
• call-lambda (function)
• can-standalone-tag (class)
• change-delimiter (function)
• close-delimiter (method)
• (setf close-delimiter) (method)
• collect-line (function)
• comment-tag (class)
• context (class)
• context-get (generic function)
• context-get (method)
• context-get (method)
• context-get (method)
• context-get (method)
• context-get (method)
• context-get (method)
• crlf (special variable)
• crlf-newline (special variable)
• crlf-newline (class)
• data (method)
• (setf data) (method)
• define-mustache-character (macro)
• delimiter-tag (class)
• end (method)
• (setf end) (method)
• ensure-context (function)
• escape (function)
• escapep (method)
• falsey (method)
• (setf falsey) (method)
• filename (function)
• find-standalone-tag (function)
• fold-text (function)
• get-mustache-character (function)
• group-sections (function)
• indent (method)
• (setf indent) (method)
• indent (method)
• (setf indent) (method)
• key (function)
• locate-file (function)
• make-context-chain (function)
• make-section-tag (function)
• make-tag (function)
• newline (special variable)
• newline (class)
• newline-char (type)
• newline-char-p (function)
• next (method)
• (setf next) (method)
• non-standalone-tag (class)
• normal-tag (class)
• offset (type)
• open-delimiter (method)
• (setf open-delimiter) (method)
• parse (function)
• parse-key (function)
• partial-tag (class)
• partials (method)
• (setf partials) (method)
• print-data (generic function)
• print-data (method)
• print-data (method)
• print-data (method)
• print-data (method)
• read-newline (function)
• read-partial (function)
• read-tag (function)
• read-text (function)
• read-token (function)
• render-body (function)
• render-token (generic function)
• render-token (method)
• render-token (method)
• render-token (method)
• render-token (method)
• render-token (method)
• render-tokens (function)
• save-hash-table (function)
• scan (function)
• section-end-tag (class)
• section-start-tag (class)
• section-tag (class)
• set-mustache-character (function)
• space-char (type)
• space-char-p (function)
• start (method)
• (setf start) (method)
• string-starts-with-p (function)
• tag (class)
• text (method)
• (setf text) (method)
• text (method)
• (setf text) (method)
• text (class)
• text-char (type)
• text-char-p (function)
• text-token (type)
• token (class)
• tokens (method)
• (setf tokens) (method)
• tokens-standalone-p (function)
• trim-standalone (function)
• whitespace (class)

3.1.4 cl-mustache/compat-api-v1.lisp

Dependency

mustache.lisp (file)

Parent

cl-mustache (system)

Location

compat-api-v1.lisp

Exported Definitions

• *mustache-output* (special variable)
• defmustache (macro)
• mustache-compile (function)
• mustache-context (function)
• mustache-render (function)
• mustache-render-to-stream (function)
• mustache-render-to-string (function)
• mustache-type (function)
• mustache-version (function)

Internal Definitions

• deprecated-name (method)
• deprecated-name-replacement (method)
• deprecated-since (method)
• deprecation-warning (condition)
• make-obsolete (macro)

4 Packages

Packages are listed by definition order.

4.1 mustache

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions

• *context* (special variable)
• *default-pathname-type* (special variable)
• *escape-tokens* (special variable)
• *load-path* (special variable)
• *mustache-output* (special variable)
• *output-stream* (special variable)
• compile-template (generic function)
• compile-template (method)
• compile-template (method)
• define (macro)
• defmustache (macro)
• make-context (function)
• mustache-compile (function)
• mustache-context (function)
• mustache-render (function)
• mustache-render-to-stream (function)
• mustache-render-to-string (function)
• mustache-type (function)
• mustache-version (function)
• render (generic function)
• render (method)
• render (method)
• render* (function)
• version (function)

Internal Definitions

• %escape (function)
• %output (function)
• *close-delimiter* (special variable)
• *default-close-delimiter* (special variable)
• *default-open-delimiter* (special variable)
• *default-triple-close-delimiter* (special variable)
• *default-triple-open-delimiter* (special variable)
• *mustache-tag-table* (special variable)
• *open-delimiter* (special variable)
• *real-standard-output* (special variable)
• *triple-close-delimiter* (special variable)
• *triple-open-delimiter* (special variable)
• alist (type)
• ampersand-tag (class)
• beginning-of-line (special variable)
• beginning-of-line (class)
• call-lambda (function)
• can-standalone-tag (class)
• change-delimiter (function)
• close-delimiter (generic function)
• close-delimiter (method)
• (setf close-delimiter) (method)
• (setf close-delimiter) (generic function)
• collect-line (function)
• comment-tag (class)
• context (class)
• context-get (generic function)
• context-get (method)
• context-get (method)
• context-get (method)
• context-get (method)
• context-get (method)
• context-get (method)
• crlf (special variable)
• crlf-newline (special variable)
• crlf-newline (class)
• data (generic function)
• data (method)
• (setf data) (method)
• (setf data) (generic function)
• define-mustache-character (macro)
• delimiter-tag (class)
• deprecated-name (generic function)
• deprecated-name (method)
• deprecated-name-replacement (generic function)
• deprecated-name-replacement (method)
• deprecated-since (generic function)
• deprecated-since (method)
• deprecation-warning (condition)
• end (generic function)
• end (method)
• (setf end) (method)
• (setf end) (generic function)
• ensure-context (function)
• escape (function)
• escapep (generic function)
• escapep (method)
• falsey (generic function)
• falsey (method)
• (setf falsey) (method)
• (setf falsey) (generic function)
• filename (function)
• find-standalone-tag (function)
• fold-text (function)
• get-mustache-character (function)
• group-sections (function)
• indent (generic function)
• indent (method)
• (setf indent) (method)
• indent (method)
• (setf indent) (method)
• (setf indent) (generic function)
• key (function)
• locate-file (function)
• make-context-chain (function)
• make-obsolete (macro)
• make-section-tag (function)
• make-tag (function)
• newline (special variable)
• newline (class)
• newline-char (type)
• newline-char-p (function)
• next (generic function)
• next (method)
• (setf next) (method)
• (setf next) (generic function)
• non-standalone-tag (class)
• normal-tag (class)
• offset (type)
• open-delimiter (generic function)
• open-delimiter (method)
• (setf open-delimiter) (method)
• (setf open-delimiter) (generic function)
• parse (function)
• parse-key (function)
• partial-tag (class)
• partials (generic function)
• partials (method)
• (setf partials) (method)
• (setf partials) (generic function)
• print-data (generic function)
• print-data (method)
• print-data (method)
• print-data (method)
• print-data (method)
• read-newline (function)
• read-partial (function)
• read-tag (function)
• read-text (function)
• read-token (function)
• render-body (function)
• render-token (generic function)
• render-token (method)
• render-token (method)
• render-token (method)
• render-token (method)
• render-token (method)
• render-tokens (function)
• save-hash-table (function)
• scan (function)
• section-end-tag (class)
• section-start-tag (class)
• section-tag (class)
• set-mustache-character (function)
• space-char (type)
• space-char-p (function)
• start (generic function)
• start (method)
• (setf start) (method)
• (setf start) (generic function)
• string-starts-with-p (function)
• tag (class)
• text (generic function)
• text (method)
• (setf text) (method)
• text (method)
• (setf text) (method)
• (setf text) (generic function)
• text (class)
• text-char (type)
• text-char-p (function)
• text-token (type)
• token (class)
• tokens (generic function)
• tokens (method)
• (setf tokens) (method)
• (setf tokens) (generic function)
• tokens-standalone-p (function)
• trim-standalone (function)
• whitespace (class)

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: *context*

Current context for lambda section

Package

mustache

Source

mustache.lisp (file)

Special Variable: *default-pathname-type*

The default file extension for partials.

Package

mustache

Source

mustache.lisp (file)

Special Variable: *escape-tokens*

Package

mustache

Source

mustache.lisp (file)

Special Variable: *load-path*

A list. The search pathes for partials.

Package

mustache

Source

mustache.lisp (file)

Special Variable: *mustache-output*

Deprecated in favor of MUSTACHE:*OUTPUT-STREAM* since version 0.10.0

Package

mustache

Source

compat-api-v1.lisp (file)

Special Variable: *output-stream*

The default output stream for mustache rendering. Bind this variable before calling mustache-rendering and friends. Default is *standard-output*.

Package

mustache

Source

mustache.lisp (file)

5.1.2 Macros

Macro: define NAME TEMPLATE

Define a named renderer of string TEMPLATE.

Package

mustache

Source

mustache.lisp (file)

Macro: defmustache NAME TEMPLATE

Define a named renderer of string TEMPLATE.

Package

mustache

Source

compat-api-v1.lisp (file)

5.1.3 Functions

Function: make-context &key DATA PARTIALS

Create mustache context from alist DATA.

Package

mustache

Source

mustache.lisp (file)

Function: mustache-compile &rest ARGS

Return a compiled rendering function.

Package

mustache

Source

compat-api-v1.lisp (file)

Function: mustache-context &rest ARGS

Create mustache context from alist DATA.

Package

mustache

Source

compat-api-v1.lisp (file)

Function: mustache-render &rest ARGS

Render TEMPLATE with optional CONTEXT to *OUTPUT-STREAM* or OUTPUT-STREAM

Package

mustache

Source

compat-api-v1.lisp (file)

Function: mustache-render-to-stream STREAM TEMPLATE &optional CONTEXT

Render TEMPLATE with optional CONTEXT to STREAM.

Package

mustache

Source

compat-api-v1.lisp (file)

Function: mustache-render-to-string &rest ARGS

Render TEMPLATE with optional CONTEXT to string.

Package

mustache

Source

compat-api-v1.lisp (file)

Function: mustache-type &rest ARGS

Return the CL-MUSTACHE version.

Package

mustache

Source

compat-api-v1.lisp (file)

Function: mustache-version &rest ARGS

Return the CL-MUSTACHE version.

Package

mustache

Source

compat-api-v1.lisp (file)

Function: render* TEMPLATE &optional CONTEXT

Render TEMPLATE with optional CONTEXT to string.

Package

mustache

Source

mustache.lisp (file)

Function: version ()

Return the CL-MUSTACHE version.

Package

mustache

Source

mustache.lisp (file)

5.1.4 Generic functions

Generic Function: compile-template TEMPLATE

Return a compiled rendering function.

Package

mustache

Source

mustache.lisp (file)

Methods

Method: compile-template (TEMPLATE pathname)

Method: compile-template (TEMPLATE string)

Generic Function: render TEMPLATE &optional CONTEXT OUTPUT-STREAM

Render TEMPLATE with optional CONTEXT to *OUTPUT-STREAM* or OUTPUT-STREAM

Package

mustache

Source

mustache.lisp (file)

Methods

Method: render (TEMPLATE pathname) &optional CONTEXT OUTPUT-STREAM

Method: render (TEMPLATE string) &optional CONTEXT OUTPUT-STREAM

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *close-delimiter*

Package

mustache

Source

mustache.lisp (file)

Special Variable: *default-close-delimiter*

Package

mustache

Source

mustache.lisp (file)

Special Variable: *default-open-delimiter*

Package

mustache

Source

mustache.lisp (file)

Special Variable: *default-triple-close-delimiter*

Package

mustache

Source

mustache.lisp (file)

Special Variable: *default-triple-open-delimiter*

Package

mustache

Source

mustache.lisp (file)

Special Variable: *mustache-tag-table*

Package

mustache

Source

mustache.lisp (file)

Special Variable: *open-delimiter*

Package

mustache

Source

mustache.lisp (file)

Special Variable: *real-standard-output*

Package

mustache

Source

mustache.lisp (file)

Special Variable: *triple-close-delimiter*

Package

mustache

Source

mustache.lisp (file)

Special Variable: *triple-open-delimiter*

Package

mustache

Source

mustache.lisp (file)

Special Variable: beginning-of-line

Package

mustache

Source

mustache.lisp (file)

Special Variable: crlf

Package

mustache

Source

mustache.lisp (file)

Special Variable: crlf-newline

Package

mustache

Source

mustache.lisp (file)

Special Variable: newline

Package

mustache

Source

mustache.lisp (file)

5.2.2 Macros

Macro: define-mustache-character CHAR &body BODY

Package

mustache

Source

mustache.lisp (file)

Macro: make-obsolete OBSOLETE-NAME CURRENT-NAME WHEN

Package

mustache

Source

compat-api-v1.lisp (file)

5.2.3 Functions

Function: %escape STRING

Package

mustache

Source

mustache.lisp (file)

Function: %output ()

Package

mustache

Source

mustache.lisp (file)

Function: call-lambda LAMBDA TEXT CONTEXT

Package

mustache

Source

mustache.lisp (file)

Function: change-delimiter TEXT

Change the mustache tag delimiter according to TEXT. The syntax grammar is:
delimiter-tag = left-d 1*space right-d
left-d = *ALPHANUM
right-d = *ALPHANUM
space = #\Space #\Tab

Package

mustache

Source

mustache.lisp (file)

Function: collect-line TOKENS

Package

mustache

Source

mustache.lisp (file)

Function: ensure-context MAYBE-CONTEXT

Ensure MAYBE-CONTEXT is a valid context. If not then make one.

Package

mustache

Source

mustache.lisp (file)

Function: escape STRING

HTML escape STRING when *escape-tokens* is t.

Package

mustache

Source

mustache.lisp (file)

Function: filename FILENAME

Package

mustache

Source

mustache.lisp (file)

Function: find-standalone-tag TOKENS

Package

mustache

Source

mustache.lisp (file)

Function: fold-text TOKENS

Package

mustache

Source

mustache.lisp (file)

Function: get-mustache-character CHAR

Package

mustache

Source

mustache.lisp (file)

Function: group-sections TOKENS &optional SECTIONS ACC

Package

mustache

Source

mustache.lisp (file)

Function: key TOKEN

Package

mustache

Source

mustache.lisp (file)

Function: locate-file FILENAME

Package

mustache

Source

mustache.lisp (file)

Function: make-context-chain DATA CONTEXT

Package

mustache

Source

mustache.lisp (file)

Function: make-section-tag START-TAG END-TAG TOKENS

Package

mustache

Source

mustache.lisp (file)

Function: make-tag &key STR ESCAPEP START END

Package

mustache

Source

mustache.lisp (file)

Function: newline-char-p CHAR

Package

mustache

Source

mustache.lisp (file)

Function: parse TEMPLATE

Package

mustache

Source

mustache.lisp (file)

Function: parse-key STRING

Package

mustache

Source

mustache.lisp (file)

Function: read-newline STRING START

Package

mustache

Source

mustache.lisp (file)

Function: read-partial FILENAME CONTEXT

Package

mustache

Source

mustache.lisp (file)

Function: read-tag STRING TRIPLEP START END

Package

mustache

Source

mustache.lisp (file)

Function: read-text TYPE STRING START END

Package

mustache

Source

mustache.lisp (file)

Function: read-token STRING START END

Package

mustache

Source

mustache.lisp (file)

Function: render-body TOKENS CONTEXT TEMPLATE

Package

mustache

Source

mustache.lisp (file)

Function: render-tokens TOKENS CONTEXT TEMPLATE

Package

mustache

Source

mustache.lisp (file)

Function: save-hash-table SOURCE

Package

mustache

Source

mustache.lisp (file)

Function: scan STRING &optional START END

Package

mustache

Source

mustache.lisp (file)

Function: set-mustache-character CHAR NEW-FUNCTION

Package

mustache

Source

mustache.lisp (file)

Function: space-char-p CHAR

Package

mustache

Source

mustache.lisp (file)

Function: string-starts-with-p PATTERN STRING START

Package

mustache

Source

mustache.lisp (file)

Function: text-char-p CHAR

Package

mustache

Source

mustache.lisp (file)

Function: tokens-standalone-p TOKENS

Package

mustache

Source

mustache.lisp (file)

Function: trim-standalone TOKENS

Package

mustache

Source

mustache.lisp (file)

5.2.4 Generic functions

Generic Function: close-delimiter OBJECT

Generic Function: (setf close-delimiter) NEW-VALUE OBJECT

Package

mustache

Methods

Method: close-delimiter (SECTION-START-TAG section-start-tag)

automatically generated reader method

Source

mustache.lisp (file)

Method: (setf close-delimiter) NEW-VALUE (SECTION-START-TAG section-start-tag)

automatically generated writer method

Source

mustache.lisp (file)

Generic Function: context-get KEY CONTEXT

Get data from CONTEXT by KEY.

Package

mustache

Source

mustache.lisp (file)

Methods

Method: context-get (KEY list) CONTEXT

Method: context-get (KEY (eql implicit-iterator)) CONTEXT

Method: context-get (KEY string) (CONTEXT context)

Method: context-get (KEY string) (CONTEXT hash-table)

Method: context-get (KEY string) (CONTEXT null)

Method: context-get (KEY string) CONTEXT

Generic Function: data OBJECT

Generic Function: (setf data) NEW-VALUE OBJECT

Package

mustache

Methods

Method: data (CONTEXT context)

automatically generated reader method

Source

mustache.lisp (file)

Method: (setf data) NEW-VALUE (CONTEXT context)

automatically generated writer method

Source

mustache.lisp (file)

Generic Function: deprecated-name CONDITION

Package

mustache

Methods

Method: deprecated-name (CONDITION deprecation-warning)

Source

compat-api-v1.lisp (file)

Generic Function: deprecated-name-replacement CONDITION

Package

mustache

Methods

Method: deprecated-name-replacement (CONDITION deprecation-warning)

Source

compat-api-v1.lisp (file)

Generic Function: deprecated-since CONDITION

Package

mustache

Methods

Method: deprecated-since (CONDITION deprecation-warning)

Source

compat-api-v1.lisp (file)

Generic Function: end OBJECT

Generic Function: (setf end) NEW-VALUE OBJECT

Package

mustache

Methods

Method: end (SECTION-START-TAG section-start-tag)

automatically generated reader method

Source

mustache.lisp (file)

Method: (setf end) NEW-VALUE (SECTION-START-TAG section-start-tag)

automatically generated writer method

Source

mustache.lisp (file)

Generic Function: escapep OBJECT

Package

mustache

Methods

Method: escapep (TAG tag)

automatically generated reader method

Source

mustache.lisp (file)

Generic Function: falsey OBJECT

Generic Function: (setf falsey) NEW-VALUE OBJECT

Package

mustache

Methods

Method: falsey (SECTION-START-TAG section-start-tag)

automatically generated reader method

Source

mustache.lisp (file)

Method: (setf falsey) NEW-VALUE (SECTION-START-TAG section-start-tag)

automatically generated writer method

Source

mustache.lisp (file)

Generic Function: indent OBJECT

Generic Function: (setf indent) NEW-VALUE OBJECT

Package

mustache

Methods

Method: indent (CONTEXT context)

automatically generated reader method

Source

mustache.lisp (file)

Method: (setf indent) NEW-VALUE (CONTEXT context)

automatically generated writer method

Source

mustache.lisp (file)

Method: indent (TAG tag)

automatically generated reader method

Source

mustache.lisp (file)

Method: (setf indent) NEW-VALUE (TAG tag)

automatically generated writer method

Source

mustache.lisp (file)

Generic Function: next OBJECT

Generic Function: (setf next) NEW-VALUE OBJECT

Package

mustache

Methods

Method: next (CONTEXT context)

automatically generated reader method

Source

mustache.lisp (file)

Method: (setf next) NEW-VALUE (CONTEXT context)

automatically generated writer method

Source

mustache.lisp (file)

Generic Function: open-delimiter OBJECT

Generic Function: (setf open-delimiter) NEW-VALUE OBJECT

Package

mustache

Methods

Method: open-delimiter (SECTION-START-TAG section-start-tag)

automatically generated reader method

Source

mustache.lisp (file)

Method: (setf open-delimiter) NEW-VALUE (SECTION-START-TAG section-start-tag)

automatically generated writer method

Source

mustache.lisp (file)

Generic Function: partials OBJECT

Generic Function: (setf partials) NEW-VALUE OBJECT

Package

mustache

Methods

Method: partials (CONTEXT context)

automatically generated reader method

Source

mustache.lisp (file)

Method: (setf partials) NEW-VALUE (CONTEXT context)

automatically generated writer method

Source

mustache.lisp (file)

Generic Function: print-data DATA ESCAPEP CONTEXT

Package

mustache

Source

mustache.lisp (file)

Methods

Method: print-data TOKEN ESCAPEP CONTEXT

Method: print-data (DATA function) ESCAPEP CONTEXT

Method: print-data (DATA symbol) ESCAPEP CONTEXT

Method: print-data (DATA string) ESCAPEP CONTEXT

Generic Function: render-token TOKEN CONTEXT TEMPLATE

Package

mustache

Source

mustache.lisp (file)

Methods

Method: render-token (TOKEN beginning-of-line) CONTEXT (TEMPLATE string)

Method: render-token (TOKEN section-tag) CONTEXT (TEMPLATE string)

Method: render-token (TOKEN partial-tag) CONTEXT (TEMPLATE string)

Method: render-token (TOKEN tag) CONTEXT (TEMPLATE string)

Method: render-token (TOKEN text) CONTEXT (TEMPLATE string)

Generic Function: start OBJECT

Generic Function: (setf start) NEW-VALUE OBJECT

Package

mustache

Methods

Method: start (SECTION-END-TAG section-end-tag)

automatically generated reader method

Source

mustache.lisp (file)

Method: (setf start) NEW-VALUE (SECTION-END-TAG section-end-tag)

automatically generated writer method

Source

mustache.lisp (file)

Generic Function: text OBJECT

Generic Function: (setf text) NEW-VALUE OBJECT

Package

mustache

Methods

Method: text (TAG tag)

automatically generated reader method

Source

mustache.lisp (file)

Method: (setf text) NEW-VALUE (TAG tag)

automatically generated writer method

Source

mustache.lisp (file)

Method: text (TEXT text)

automatically generated reader method

Source

mustache.lisp (file)

Method: (setf text) NEW-VALUE (TEXT text)

automatically generated writer method

Source

mustache.lisp (file)

Generic Function: tokens OBJECT

Generic Function: (setf tokens) NEW-VALUE OBJECT

Package

mustache

Methods

Method: tokens (SECTION-TAG section-tag)

automatically generated reader method

Source

mustache.lisp (file)

Method: (setf tokens) NEW-VALUE (SECTION-TAG section-tag)

automatically generated writer method

Source

mustache.lisp (file)

5.2.5 Conditions

Condition: deprecation-warning ()

Package

mustache

Source

compat-api-v1.lisp (file)

Direct superclasses

style-warning (condition)

Direct methods

• deprecated-since (method)
• deprecated-name-replacement (method)
• deprecated-name (method)

Direct slots

Slot: name

Initargs

:name

Readers

deprecated-name (generic function)

Slot: replacements

Initargs

:replacement

Readers

deprecated-name-replacement (generic function)

Slot: since

Initargs

:since

Readers

deprecated-since (generic function)

5.2.6 Classes

Class: ampersand-tag ()

Package

mustache

Source

mustache.lisp (file)

Direct superclasses

non-standalone-tag (class)

Direct slots

Slot: %escapep

Class: beginning-of-line ()

Package

mustache

Source

mustache.lisp (file)

Direct superclasses

token (class)

Direct methods

render-token (method)

Class: can-standalone-tag ()

Package

mustache

Source

mustache.lisp (file)

Direct superclasses

tag (class)

Direct subclasses

• delimiter-tag (class)
• comment-tag (class)
• partial-tag (class)
• section-start-tag (class)
• section-end-tag (class)

Class: comment-tag ()

Package

mustache

Source

mustache.lisp (file)

Direct superclasses

can-standalone-tag (class)

Class: context ()

Package

mustache

Source

mustache.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• context-get (method)
• next (method)
• next (method)
• partials (method)
• partials (method)
• indent (method)
• indent (method)
• data (method)
• data (method)

Direct slots

Slot: %data

Initargs

:data

Readers

data (generic function)

Writers

(setf data) (generic function)

Slot: %indent

Type

list

Initargs

:indent

Readers

indent (generic function)

Writers

(setf indent) (generic function)

Slot: %partials

Initargs

:partials

Readers

partials (generic function)

Writers

(setf partials) (generic function)

Slot: %next

Type

(or null mustache::context)

Initargs

:next

Readers

next (generic function)

Writers

(setf next) (generic function)

Class: crlf-newline ()

Package

mustache

Source

mustache.lisp (file)

Direct superclasses

newline (class)

Direct slots

Slot: %text

Initform

mustache::crlf

Class: delimiter-tag ()

Package

mustache

Source

mustache.lisp (file)

Direct superclasses

can-standalone-tag (class)

Class: newline ()

Package

mustache

Source

mustache.lisp (file)

Direct superclasses

text (class)

Direct subclasses

crlf-newline (class)

Direct slots

Slot: %text

Initform

" "

Class: non-standalone-tag ()

Package

mustache

Source

mustache.lisp (file)

Direct superclasses

tag (class)

Direct subclasses

• normal-tag (class)
• ampersand-tag (class)

Class: normal-tag ()

Package

mustache

Source

mustache.lisp (file)

Direct superclasses

non-standalone-tag (class)

Class: partial-tag ()

Package

mustache

Source

mustache.lisp (file)

Direct superclasses

can-standalone-tag (class)

Direct methods

render-token (method)

Class: section-end-tag ()

Package

mustache

Source

mustache.lisp (file)

Direct superclasses

can-standalone-tag (class)

Direct subclasses

section-tag (class)

Direct methods

• start (method)
• start (method)

Direct slots

Slot: %start

Type

mustache::offset

Initargs

:start

Initform

0

Readers

start (generic function)

Writers

(setf start) (generic function)

Class: section-start-tag ()

Package

mustache

Source

mustache.lisp (file)

Direct superclasses

can-standalone-tag (class)

Direct subclasses

section-tag (class)

Direct methods

• close-delimiter (method)
• close-delimiter (method)
• open-delimiter (method)
• open-delimiter (method)
• end (method)
• end (method)
• falsey (method)
• falsey (method)

Direct slots

Slot: %falsey

Type

boolean

Initargs

:falsey

Readers

falsey (generic function)

Writers

(setf falsey) (generic function)

Slot: %end

Type

mustache::offset

Initargs

:end

Initform

0

Readers

end (generic function)

Writers

(setf end) (generic function)

Slot: %open-delimiter

Type

string

Initargs

:open-delimiter

Initform

""

Readers

open-delimiter (generic function)

Writers

(setf open-delimiter) (generic function)

Slot: %close-delimiter

Type

string

Initargs

:close-delimiter

Initform

""

Readers

close-delimiter (generic function)

Writers

(setf close-delimiter) (generic function)

Class: section-tag ()

Package

mustache

Source

mustache.lisp (file)

Direct superclasses

• section-end-tag (class)
• section-start-tag (class)

Direct methods

• render-token (method)
• tokens (method)
• tokens (method)

Direct slots

Slot: %tokens

Type

list

Initargs

:tokens

Readers

tokens (generic function)

Writers

(setf tokens) (generic function)

Class: tag ()

Package

mustache

Source

mustache.lisp (file)

Direct superclasses

token (class)

Direct subclasses

• can-standalone-tag (class)
• non-standalone-tag (class)

Direct methods

• render-token (method)
• print-object (method)
• indent (method)
• indent (method)
• escapep (method)
• text (method)
• text (method)

Direct slots

Slot: %text

Type

string

Initargs

:text

Readers

text (generic function)

Writers

(setf text) (generic function)

Slot: %escapep

Type

boolean

Initargs

:escape

Initform

t

Readers

escapep (generic function)

Slot: %indent

Type

list

Initargs

:indent

Readers

indent (generic function)

Writers

(setf indent) (generic function)

Class: text ()

Package

mustache

Source

mustache.lisp (file)

Direct superclasses

token (class)

Direct subclasses

• whitespace (class)
• newline (class)

Direct methods

• render-token (method)
• text (method)
• text (method)

Direct slots

Slot: %text

Type

string

Initargs

:text

Readers

text (generic function)

Writers

(setf text) (generic function)

Class: token ()

Package

mustache

Source

mustache.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• beginning-of-line (class)
• text (class)
• tag (class)

Class: whitespace ()

Package

mustache

Source

mustache.lisp (file)

Direct superclasses

text (class)

5.2.7 Types

Type: alist ()

Package

mustache

Source

mustache.lisp (file)

Type: newline-char ()

Package

mustache

Source

mustache.lisp (file)

Type: offset ()

File or string offset.

Package

mustache

Source

mustache.lisp (file)

Type: space-char ()

Package

mustache

Source

mustache.lisp (file)

Type: text-char ()

Package

mustache

Source

mustache.lisp (file)

Type: text-token ()

Package

mustache

Source

mustache.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions