The djula Reference Manual

Table of Contents

The djula Reference Manual

This is the djula Reference Manual, version 0.2, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Apr 28 11:41:43 2020 GMT+0.

1 Introduction

Djula

Djula is a port of Python's Django template engine to Common Lisp.

Nutshell

Here a small example of a template::

    {% extends "base.html" %}
    {% block title %}Memberlist{% endblock %}
    {% block content %}
      <ul>
      {% for user in users %}
        <li><a href="{{ user.url }}">{{ user.username }}</a></li>
      {% endfor %}
      </ul>
    {% endblock %}

Philosophy

Application logic is for the controller but don't try to make the life for the template designer too hard by giving him too few functionality.

For more information visit the new Djula webpage and documentation.

2 Systems

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

2.1 djula

Maintainers

Eric Sessoms <eric@nubgames.com>
Mariano Montone <marianomontone@gmail.com>

Author

Nick Allen <nallen05@gmail.com>

License

MIT

Description

An implementation of Django templates for Common Lisp.

Version

0.2

Dependencies

• access
• alexandria
• anaphora
• babel
• cl-ppcre
• cl-fad
• split-sequence
• local-time
• closer-mop
• trivial-backtrace
• cl-slice
• cl-locale
• gettext
• parser-combinators
• iterate

Source

djula.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 djula/src

Parent

djula (system)

Location

src/

Components

• compiler.lisp (file)
• conditions.lisp (file)
• filters.lisp (file)
• lexer.lisp (file)
• locale.lisp (file)
• packages.lisp (file)
• parser.lisp (file)
• pipeline.lisp (file)
• specials.lisp (file)
• tags.lisp (file)
• tag.lisp (file)
• template-store.lisp (file)
• translation.lisp (file)
• util.lisp (file)
• variables.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 djula.asd

Location

djula.asd

Systems

djula (system)

4.1.2 djula/src/compiler.lisp

Dependencies

• lexer.lisp (file)
• parser.lisp (file)
• template-store.lisp (file)

Parent

src (module)

Location

src/compiler.lisp

Exported Definitions

• *current-compiler* (special variable)
• compile-template (generic function)
• compile-template (method)
• compile-template (method)
• compile-template* (function)
• compiler (class)
• fragment-compiler (method)
• render-template* (function)
• string (function)
• toplevel-compiler (class)

Internal Definitions

• compile-string (function)
• compile-template-file (method)
• compile-token (function)
• compiled-template (method)
• (setf compiled-template) (method)
• compiled-template (class)
• linked-templates (method)
• (setf linked-templates) (method)
• template-changed (method)
• template-file (method)
• (setf template-file) (method)
• template-file-write-date (method)
• (setf template-file-write-date) (method)

4.1.3 djula/src/conditions.lisp

Dependency

specials.lisp (file)

Parent

src (module)

Location

src/conditions.lisp

Internal Definitions

• render-error-template (function)
• template-error (function)
• template-error (condition)
• template-error* (function)
• template-error-message (method)
• template-error-string (function)
• template-error-string* (function)
• with-template-error (macro)

4.1.4 djula/src/filters.lisp

Dependency

pipeline.lisp (file)

Parent

src (module)

Location

src/filters.lisp

Exported Definitions

• add (function)
• addslashes (function)
• capfirst (function)
• cut (function)
• date (function)
• datetime (function)
• default (function)
• escape (function)
• first (function)
• force-escape (function)
• format (function)
• join (function)
• last (function)
• length (function)
• linebreaks (function)
• linebreaksbr (function)
• lisp (function)
• lower (function)
• replace (function)
• reverse (function)
• safe (function)
• scan (function)
• slice (function)
• sort (function)
• time (function)
• truncatechars (function)
• upper (function)
• urlencode (function)
• with (function)

Internal Definitions

apply-filters (function)

4.1.5 djula/src/lexer.lisp

Dependencies

• pipeline.lisp (file)
• util.lisp (file)

Parent

src (module)

Location

src/lexer.lisp

Exported Definitions

verbatim (function)

Internal Definitions

• get-closing-delimiter (function)
• next-tag (function)
• parse-tag (function)
• parse-template-string (function)
• token-type (function)

4.1.6 djula/src/locale.lisp

Dependency

lexer.lisp (file)

Parent

src (module)

Location

src/locale.lisp

Exported Definitions

• directory-translate-strings (function)
• file-template-translate-strings (function)
• locale-list (function)
• update-caveman-project (function)
• update-locale-list (function)
• update-project (function)

Internal Definitions

• +whitespace+ (constant)
• alter-pathname (function)
• backup-file (function)
• parse-template-string (function)
• string-string-p (function)
• string-translate-strings (function)
• trim-whitespace (function)

4.1.7 djula/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

• djula.unparsed-tag-processors
• djula.filters
• djula.token-compilers
• djula.tag-processors
• djula.locale
• djula
• djula.tag-compilers
• djula.token-processors

4.1.8 djula/src/parser.lisp

Dependency

pipeline.lisp (file)

Parent

src (module)

Location

src/parser.lisp

Exported Definitions

• comment (function)
• string (function)

Internal Definitions

• process-token (function)
• process-tokens (function)

4.1.9 djula/src/pipeline.lisp

Dependency

conditions.lisp (file)

Parent

src (module)

Location

src/pipeline.lisp

Exported Definitions

• def-filter (macro)
• def-tag-compiler (macro)

Internal Definitions

• def-delimited-tag (macro)
• def-tag-processor (macro)
• def-token-compiler (macro)
• def-token-processor (macro)
• def-unparsed-tag-processor (macro)
• find-filter (function)
• find-tag-compiler (function)
• find-tag-processor (function)
• find-token-compiler (function)
• find-token-processor (function)
• find-unparsed-tag-processor (function)

4.1.10 djula/src/specials.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/specials.lisp

Exported Definitions

• *allow-include-roots* (special variable)
• *catch-template-errors-p* (special variable)
• *current-language* (special variable)
• *default-language* (special variable)
• *djula-execute-package* (special variable)
• *elision-string* (special variable)
• *error-template* (special variable)
• *fancy-debug-p* (special variable)
• *fancy-error-template-p* (special variable)
• *verbose-errors-p* (special variable)

Internal Definitions

• *accumulated-javascript-strings* (special variable)
• *block-alist* (special variable)
• *current-block* (special variable)
• *current-template* (special variable)
• *eval-lisp-tags* (special variable)
• *linked-templates* (special variable)
• *template-arguments* (special variable)

4.1.11 djula/src/tags.lisp

Dependencies

• tag.lisp (file)
• variables.lisp (file)

Parent

src (module)

Location

src/tags.lisp

Exported Definitions

• almost-parsed-ifequal (function)
• almost-parsed-ifnotequal (function)
• autoescape (function)
• block (function)
• comment (function)
• comment-tag (function)
• cycle (function)
• debug (function)
• emit-js (function)
• endautoescape (function)
• endblock (function)
• endcomment (function)
• endfilter (function)
• endfor (function)
• endif (function)
• endifchanged (function)
• endifequal (function)
• endifnotequal (function)
• endjs-script (function)
• extends (function)
• filter (function)
• firstof (function)
• for (function)
• if (function)
• ifchanged (function)
• ifequal (function)
• ifnotequal (function)
• include (function)
• js (function)
• js-script (function)
• lisp (function)
• parsed-autoescape (function)
• parsed-block (function)
• parsed-filter (function)
• parsed-for (function)
• parsed-if (function)
• parsed-ifchanged (function)
• parsed-ifequal (function)
• parsed-js (function)
• parsed-js-script (function)
• parsed-lisp (function)
• parsed-set (function)
• semi-parsed-filter (function)
• semi-parsed-if (function)
• semi-parsed-ifequal (function)
• semi-parsed-ifnotequal (function)
• semi-parsed-js-script (function)
• set (function)
• set-language (function)
• set-package (function)
• show-language (function)
• ssi (function)
• super (function)
• templatetag (function)

Internal Definitions

• and-bterm (function)
• bliteral (function)
• boolean-comparison (function)
• boolexp-factor (function)
• boolexp-parser (function)
• bterm (function)
• comparison-operator-parser (function)
• compile-boolexp (function)
• compile-logical-statement (function)
• in-list (function)
• iterable-list (function)
• not-bfactor (function)
• or-bterm (function)
• print-debugging-information (function)
• print-fancy-debugging-information (function)
• process-ifequal-args (function)
• remove-first (function)
• split-if-clause (function)
• transform (function)
• with-file-handler (macro)

4.1.12 djula/src/tag.lisp

Dependency

pipeline.lisp (file)

Parent

src (module)

Location

src/tag.lisp

Exported Definitions

• tag (function)
• tag (function)
• unparsed-tag (function)

Internal Definitions

• find-end-tag (function)
• parse-rest-of-tag (function)
• semi-parse-tag (function)

4.1.13 djula/src/template-store.lisp

Dependency

specials.lisp (file)

Parent

src (module)

Location

src/template-store.lisp

Exported Definitions

• *current-store* (special variable)
• add-template-directory (function)
• fetch-template (generic function)
• fetch-template (method)
• fetch-template* (function)
• file-store (class)
• find-template (generic function)
• find-template (method)
• find-template* (function)

Internal Definitions

• search-path (method)
• (setf search-path) (method)
• slurp (function)

4.1.14 djula/src/translation.lisp

Dependencies

• specials.lisp (file)
• pipeline.lisp (file)

Parent

src (module)

Location

src/translation.lisp

Exported Definitions

• *translation-backend* (special variable)
• trans (function)
• trans (function)
• translate (function)
• translation (function)
• unparsed-translation (function)

Internal Definitions

• *gettext-domain* (special variable)
• *untranslated-messages* (special variable)
• *warn-on-untranslated-messages* (special variable)
• backend-translate (generic function)
• backend-translate (method)
• backend-translate (method)
• backend-translate (method)
• backend-translate (method)
• format-translation (function)
• resolve-plist (function)

4.1.15 djula/src/util.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/util.lisp

Exported Definitions

• url-encode (function)
• url-encode-path (function)

Internal Definitions

• accum (macro)
• escape-for-html (function)
• join (function)
• truncate-characters (function)

4.1.16 djula/src/variables.lisp

Dependencies

• specials.lisp (file)
• util.lisp (file)

Parent

src (module)

Location

src/variables.lisp

Exported Definitions

• *auto-escape* (special variable)
• unparsed-variable (function)
• variable (function)

Internal Definitions

• apply-keys/indexes (function)
• escape-string-split (function)
• get-variable (function)
• integer-or-keyword (function)
• parse-filter-string (function)
• parse-variable-clause (function)
• parse-variable-phrase (function)
• resolve-variable-phrase (function)

5 Packages

Packages are listed by definition order.

5.1 djula.unparsed-tag-processors

This package contains the unparsed tag processors.

Source

packages.lisp (file)

Exported Definitions

• filter (function)
• ifequal (function)
• ifnotequal (function)
• js (function)
• lisp (function)
• set (function)
• trans (function)

5.2 djula.filters

This package contains the djula filters. Filters are take as a first argument a string and return a string.

Source

packages.lisp (file)

Exported Definitions

• add (function)
• addslashes (function)
• capfirst (function)
• cut (function)
• date (function)
• datetime (function)
• default (function)
• escape (function)
• first (function)
• force-escape (function)
• format (function)
• join (function)
• last (function)
• length (function)
• linebreaks (function)
• linebreaksbr (function)
• lisp (function)
• lower (function)
• replace (function)
• reverse (function)
• safe (function)
• scan (function)
• slice (function)
• sort (function)
• time (function)
• trans (function)
• truncatechars (function)
• upper (function)
• urlencode (function)
• with (function)

5.3 djula.token-compilers

This package contains the token compilers.

Source

packages.lisp (file)

Exported Definitions

• parsed-autoescape (function)
• parsed-block (function)
• parsed-filter (function)
• parsed-for (function)
• parsed-if (function)
• parsed-ifchanged (function)
• parsed-ifequal (function)
• parsed-js (function)
• parsed-js-script (function)
• parsed-lisp (function)
• parsed-set (function)
• string (function)
• tag (function)
• translation (function)
• variable (function)
• verbatim (function)

5.4 djula.tag-processors

This package contains the tag processors.

Source

packages.lisp (file)

Exported Definitions

• autoescape (function)
• block (function)
• comment (function)
• extends (function)
• for (function)
• if (function)
• ifchanged (function)
• js-script (function)
• semi-parsed-filter (function)
• semi-parsed-ifequal (function)
• semi-parsed-ifnotequal (function)

5.5 djula.locale

This package contains code to generate cl-locale dictionary files.

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions

• directory-translate-strings (function)
• file-template-translate-strings (function)
• locale-list (function)
• update-caveman-project (function)
• update-locale-list (function)
• update-project (function)

Internal Definitions

• +whitespace+ (constant)
• alter-pathname (function)
• backup-file (function)
• parse-template-string (function)
• string-string-p (function)
• string-translate-strings (function)
• trim-whitespace (function)

5.6 djula

Source

packages.lisp (file)

Use List

• parser-combinators
• common-lisp
• anaphora
• alexandria
• iterate

Exported Definitions

• *allow-include-roots* (special variable)
• *auto-escape* (special variable)
• *catch-template-errors-p* (special variable)
• *current-compiler* (special variable)
• *current-language* (special variable)
• *current-store* (special variable)
• *default-language* (special variable)
• *djula-execute-package* (special variable)
• *elision-string* (special variable)
• *error-template* (special variable)
• *fancy-debug-p* (special variable)
• *fancy-error-template-p* (special variable)
• *translation-backend* (special variable)
• *verbose-errors-p* (special variable)
• add-template-directory (function)
• compile-template (generic function)
• compile-template (method)
• compile-template (method)
• compile-template* (function)
• compiler (class)
• def-filter (macro)
• def-tag-compiler (macro)
• fetch-template (generic function)
• fetch-template (method)
• fetch-template* (function)
• file-store (class)
• find-template (generic function)
• find-template (method)
• find-template* (function)
• fragment-compiler (generic function)
• fragment-compiler (method)
• render-template* (function)
• toplevel-compiler (class)
• translate (function)
• url-encode (function)
• url-encode-path (function)

Internal Definitions

• *accumulated-javascript-strings* (special variable)
• *block-alist* (special variable)
• *current-block* (special variable)
• *current-template* (special variable)
• *eval-lisp-tags* (special variable)
• *gettext-domain* (special variable)
• *linked-templates* (special variable)
• *template-arguments* (special variable)
• *untranslated-messages* (special variable)
• *warn-on-untranslated-messages* (special variable)
• accum (macro)
• and-bterm (function)
• apply-filters (function)
• apply-keys/indexes (function)
• backend-translate (generic function)
• backend-translate (method)
• backend-translate (method)
• backend-translate (method)
• backend-translate (method)
• bliteral (function)
• boolean-comparison (function)
• boolexp-factor (function)
• boolexp-parser (function)
• bterm (function)
• comparison-operator-parser (function)
• compile-boolexp (function)
• compile-logical-statement (function)
• compile-string (function)
• compile-template-file (generic function)
• compile-template-file (method)
• compile-token (function)
• compiled-template (generic function)
• compiled-template (method)
• (setf compiled-template) (method)
• (setf compiled-template) (generic function)
• compiled-template (class)
• def-delimited-tag (macro)
• def-tag-processor (macro)
• def-token-compiler (macro)
• def-token-processor (macro)
• def-unparsed-tag-processor (macro)
• escape-for-html (function)
• escape-string-split (function)
• find-end-tag (function)
• find-filter (function)
• find-tag-compiler (function)
• find-tag-processor (function)
• find-token-compiler (function)
• find-token-processor (function)
• find-unparsed-tag-processor (function)
• format-translation (function)
• get-closing-delimiter (function)
• get-variable (function)
• in-list (function)
• integer-or-keyword (function)
• iterable-list (function)
• join (function)
• linked-templates (generic function)
• linked-templates (method)
• (setf linked-templates) (method)
• (setf linked-templates) (generic function)
• next-tag (function)
• not-bfactor (function)
• or-bterm (function)
• parse-filter-string (function)
• parse-rest-of-tag (function)
• parse-tag (function)
• parse-template-string (function)
• parse-variable-clause (function)
• parse-variable-phrase (function)
• print-debugging-information (function)
• print-fancy-debugging-information (function)
• process-ifequal-args (function)
• process-token (function)
• process-tokens (function)
• remove-first (function)
• render-error-template (function)
• resolve-plist (function)
• resolve-variable-phrase (function)
• search-path (generic function)
• search-path (method)
• (setf search-path) (method)
• (setf search-path) (generic function)
• semi-parse-tag (function)
• slurp (function)
• split-if-clause (function)
• template-changed (generic function)
• template-changed (method)
• template-error (function)
• template-error (condition)
• template-error* (function)
• template-error-message (generic function)
• template-error-message (method)
• template-error-string (function)
• template-error-string* (function)
• template-file (generic function)
• template-file (method)
• (setf template-file) (method)
• (setf template-file) (generic function)
• template-file-write-date (generic function)
• template-file-write-date (method)
• (setf template-file-write-date) (method)
• (setf template-file-write-date) (generic function)
• token-type (function)
• transform (function)
• truncate-characters (function)
• with-file-handler (macro)
• with-template-error (macro)

5.7 djula.tag-compilers

This package contains the tag compilers.

Source

packages.lisp (file)

Exported Definitions

• cycle (function)
• debug (function)
• emit-js (function)
• endautoescape (function)
• endblock (function)
• endcomment (function)
• endfilter (function)
• endfor (function)
• endif (function)
• endifchanged (function)
• endifequal (function)
• endifnotequal (function)
• endjs-script (function)
• firstof (function)
• include (function)
• set-language (function)
• set-package (function)
• show-language (function)
• ssi (function)
• super (function)
• templatetag (function)

5.8 djula.token-processors

Contains the token processors

Source

packages.lisp (file)

Exported Definitions

• almost-parsed-ifequal (function)
• almost-parsed-ifnotequal (function)
• comment (function)
• comment-tag (function)
• semi-parsed-if (function)
• semi-parsed-js-script (function)
• string (function)
• tag (function)
• unparsed-tag (function)
• unparsed-translation (function)
• unparsed-variable (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *allow-include-roots*

Package

djula

Source

specials.lisp (file)

Special Variable: *auto-escape*

Package

djula

Source

variables.lisp (file)

Special Variable: *catch-template-errors-p*

When enabled, caught errors during the rendering of the template are written to the output instead of being handled by the lisp listener

Package

djula

Source

specials.lisp (file)

Special Variable: *current-compiler*

Package

djula

Source

compiler.lisp (file)

Special Variable: *current-language*

Package

djula

Source

specials.lisp (file)

Special Variable: *current-store*

The currently in-use template store. Defaults to a FILE-STORE.

Package

djula

Source

template-store.lisp (file)

Special Variable: *default-language*

Package

djula

Source

specials.lisp (file)

Special Variable: *djula-execute-package*

Package

djula

Source

specials.lisp (file)

Special Variable: *elision-string*

The string to be used by ‘truncatechars’ at the end of truncated strings.

Package

djula

Source

specials.lisp (file)

Special Variable: *error-template*

The error template used by ‘render-error-template’.

Package

djula

Source

specials.lisp (file)

Special Variable: *fancy-debug-p*

When enabled, displays fancy html based debugging information for the {% debug %} tag

Package

djula

Source

specials.lisp (file)

Special Variable: *fancy-error-template-p*

When enabled, show a fancy template when an error ocurrs

Package

djula

Source

specials.lisp (file)

Special Variable: *translation-backend*

The translation backend. One of :locale, :gettext

Package

djula

Source

translation.lisp (file)

Special Variable: *verbose-errors-p*

When enabled, errors are displayed more verbosely. Good for debugging

Package

djula

Source

specials.lisp (file)

6.1.2 Macros

Macro: def-filter NAME ARGS &body BODY

Package

djula

Source

pipeline.lisp (file)

Macro: def-tag-compiler NAME ARGS &body BODY

Package

djula

Source

pipeline.lisp (file)

6.1.3 Functions

Function: add IT N

Package

djula.filters

Source

filters.lisp (file)

Function: add-template-directory DIRECTORY &optional TEMPLATE-STORE

Adds DIRECTORY to the search path of the TEMPLATE-STORE

Package

djula

Source

template-store.lisp (file)

Function: addslashes IT

Package

djula.filters

Source

filters.lisp (file)

Function: almost-parsed-ifequal &rest ARG-LIST0

Package

djula.token-processors

Source

tags.lisp (file)

Function: almost-parsed-ifnotequal &rest ARG-LIST0

Package

djula.token-processors

Source

tags.lisp (file)

Function: autoescape &rest ARG-LIST0

Package

djula.tag-processors

Source

tags.lisp (file)

Function: block &rest ARG-LIST0

Package

djula.tag-processors

Source

tags.lisp (file)

Function: capfirst IT

Package

djula.filters

Source

filters.lisp (file)

Function: comment &rest ARG-LIST0

Package

djula.tag-processors

Source

tags.lisp (file)

Function: comment &rest ARG-LIST0

:COMMENT tokens are removed by PROCESS-TOKENS

Package

djula.token-processors

Source

parser.lisp (file)

Function: comment-tag &rest ARG-LIST0

Package

djula.token-processors

Source

tags.lisp (file)

Function: compile-template* NAME

Compiles template NAME with compiler in *CURRENT-COMPILER*

Package

djula

Source

compiler.lisp (file)

Function: cut IT CHARSTRING

Package

djula.filters

Source

filters.lisp (file)

Function: cycle &rest ARG-LIST0

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: date IT &optional FORMAT

Package

djula.filters

Source

filters.lisp (file)

Function: datetime IT &optional FORMAT

Package

djula.filters

Source

filters.lisp (file)

Function: debug &rest ARG-LIST0

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: default IT DEFAULT

Package

djula.filters

Source

filters.lisp (file)

Function: directory-translate-strings DIR &key RECURSE

given a directory of djula html template files find all the strings to be translated

Package

djula.locale

Source

locale.lisp (file)

Function: emit-js &rest ARG-LIST0

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: endautoescape &rest ARG-LIST18

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: endblock &rest ARG-LIST18

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: endcomment &rest ARG-LIST18

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: endfilter &rest ARG-LIST18

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: endfor &rest ARG-LIST18

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: endif &rest ARG-LIST18

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: endifchanged &rest ARG-LIST18

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: endifequal &rest ARG-LIST18

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: endifnotequal &rest ARG-LIST18

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: endjs-script &rest ARG-LIST18

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: escape IT

Package

djula.filters

Source

filters.lisp (file)

Function: extends &rest ARG-LIST0

Package

djula.tag-processors

Source

tags.lisp (file)

Function: fetch-template* KEY

Return the text of a template fetched from the *CURRENT-STORE*.

Package

djula

Source

template-store.lisp (file)

Function: file-template-translate-strings FILE

given a djula html template file, find all the strings to be translated

Package

djula.locale

Source

locale.lisp (file)

Function: filter &rest ARG-LIST0

Package

djula.unparsed-tag-processors

Source

tags.lisp (file)

Function: find-template* NAME &optional ERROR-P

Package

djula

Source

template-store.lisp (file)

Function: first IT

Package

djula.filters

Source

filters.lisp (file)

Function: firstof &rest ARG-LIST0

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: for &rest ARG-LIST0

Package

djula.tag-processors

Source

tags.lisp (file)

Function: force-escape IT

Package

djula.filters

Source

filters.lisp (file)

Function: format IT FMT

Package

djula.filters

Source

filters.lisp (file)

Function: if &rest ARG-LIST0

Package

djula.tag-processors

Source

tags.lisp (file)

Function: ifchanged &rest ARG-LIST0

Package

djula.tag-processors

Source

tags.lisp (file)

Function: ifequal &rest ARG-LIST0

Package

djula.unparsed-tag-processors

Source

tags.lisp (file)

Function: ifnotequal &rest ARG-LIST0

Package

djula.unparsed-tag-processors

Source

tags.lisp (file)

Function: include &rest ARG-LIST0

when compiled, :INCLUDE tags first compile the template pointed to by ‘PATH’ then they compile into a function that simply calls this function with *TEMPLATE-ARGUMENTS*

‘PARAMETERS’ should have the form (:param1 value1 :param2 value2 ...). If given, they are prepended to *TEMPLATE-ARGUMENTS*

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: join IT SEP

Package

djula.filters

Source

filters.lisp (file)

Function: js &rest ARG-LIST0

Package

djula.unparsed-tag-processors

Source

tags.lisp (file)

Function: js-script &rest ARG-LIST0

Package

djula.tag-processors

Source

tags.lisp (file)

Function: last IT

Package

djula.filters

Source

filters.lisp (file)

Function: length IT

Package

djula.filters

Source

filters.lisp (file)

Function: linebreaks IT

Package

djula.filters

Source

filters.lisp (file)

Function: linebreaksbr IT

Package

djula.filters

Source

filters.lisp (file)

Function: lisp &rest ARG-LIST0

Package

djula.unparsed-tag-processors

Source

tags.lisp (file)

Function: lisp IT &optional LISP-STRING

Package

djula.filters

Source

filters.lisp (file)

Function: locale-list MESSAGE-FILE TRANSLATE-STRINGS

return an augmented dictionary of a cl-locale message file with the translate strings. Does not update the file.

Package

djula.locale

Source

locale.lisp (file)

Function: lower IT

Package

djula.filters

Source

filters.lisp (file)

Function: parsed-autoescape &rest ARG-LIST0

Package

djula.token-compilers

Source

tags.lisp (file)

Function: parsed-block &rest ARG-LIST0

Package

djula.token-compilers

Source

tags.lisp (file)

Function: parsed-filter &rest ARG-LIST0

Package

djula.token-compilers

Source

tags.lisp (file)

Function: parsed-for &rest ARG-LIST0

Package

djula.token-compilers

Source

tags.lisp (file)

Function: parsed-if &rest ARG-LIST0

:PARSED-IF tags are compiled into a function that executes the {% if %} clause

Package

djula.token-compilers

Source

tags.lisp (file)

Function: parsed-ifchanged &rest ARG-LIST0

Package

djula.token-compilers

Source

tags.lisp (file)

Function: parsed-ifequal &rest ARG-LIST0

Package

djula.token-compilers

Source

tags.lisp (file)

Function: parsed-js &rest ARG-LIST0

Package

djula.token-compilers

Source

tags.lisp (file)

Function: parsed-js-script &rest ARG-LIST0

Package

djula.token-compilers

Source

tags.lisp (file)

Function: parsed-lisp &rest ARG-LIST0

Package

djula.token-compilers

Source

tags.lisp (file)

Function: parsed-set &rest ARG-LIST0

Package

djula.token-compilers

Source

tags.lisp (file)

Function: render-template* TEMPLATE &optional STREAM &rest *TEMPLATE-ARGUMENTS*

Render TEMPLATE into STREAM passing *TEMPLATE-ARGUMENTS*

Package

djula

Source

compiler.lisp (file)

Function: replace IT REGEX

Package

djula.filters

Source

filters.lisp (file)

Function: reverse IT

Package

djula.filters

Source

filters.lisp (file)

Function: safe IT

Package

djula.filters

Source

filters.lisp (file)

Function: scan IT REGEX

Package

djula.filters

Source

filters.lisp (file)

Function: semi-parsed-filter &rest ARG-LIST0

Package

djula.tag-processors

Source

tags.lisp (file)

Function: semi-parsed-if &rest ARG-LIST0

:SEMI-PARSED-IF tags are parsed into :PARSED-IF tags. a :PARSED-IF tag looks more ike a traditional IF statement [a test, an "if" branch, and an "else" branch], so :SEMI-PARSED-IF has to look for the :ELSE token to split up ‘CLAUSE’

Package

djula.token-processors

Source

tags.lisp (file)

Function: semi-parsed-ifequal &rest ARG-LIST0

Package

djula.tag-processors

Source

tags.lisp (file)

Function: semi-parsed-ifnotequal &rest ARG-LIST0

Package

djula.tag-processors

Source

tags.lisp (file)

Function: semi-parsed-js-script &rest ARG-LIST0

Package

djula.token-processors

Source

tags.lisp (file)

Function: set &rest ARG-LIST0

Package

djula.unparsed-tag-processors

Source

tags.lisp (file)

Function: set-language &rest ARG-LIST0

:SET-LANGUAGE tags are compiled into a function that set *CURRENT-LANGUAGE* to the keyword version of ‘NAME’ [or NIL if ‘NAME’ is not supplied]

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: set-package &rest ARG-LIST0

:SET-PACKAGE tags are compiled into a function that set *DJULA-EXECUTE-PACKAGE* to the the package value of find package on the keyword ‘PACKAGE-NAME’ or the package ‘common-lisp-user’ if the package for ‘PACKAGE-NAME’ is not found. This is useful to determine the package in which :LISP tags are executed

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: show-language &rest ARG-LIST0

:SHOW-LANGUAGE tags are compiled into a function that just shows the values of *CURRENT-LANGUAGE* or *DEFAULT-LANGUAGE* if there is no current language

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: slice IT &rest SLICES

Package

djula.filters

Source

filters.lisp (file)

Function: sort IT &optional PREDICATE KEY

Package

djula.filters

Source

filters.lisp (file)

Function: ssi &rest ARG-LIST0

if ‘PATH’ lives in a folder reckognized by *ALLOW-INCLUDE-ROOTS*, then :SSI tags compile into a function that return the contents of the file pointed to
by the template-path ‘PATH’. If ‘PARSE’ is T then the function renders ‘PATH’ as a template.

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: string &rest ARG-LIST0

:STRING tokens compile into a function that simply returns the string

Package

djula.token-compilers

Source

compiler.lisp (file)

Function: string &rest ARG-LIST0

adjacent :STRING tokens are concatenated together by PROCESS-TOKENS as a small optimization

Package

djula.token-processors

Source

parser.lisp (file)

Function: super &rest ARG-LIST0

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: tag &rest ARG-LIST0

Package

djula.token-compilers

Source

tag.lisp (file)

Function: tag &rest ARG-LIST0

:TAG tokens are sometimes parsed into some other tokens by PROCESS-TOKENS

Package

djula.token-processors

Source

tag.lisp (file)

Function: templatetag &rest ARG-LIST0

:SHOW-FILE tags compile into a function that return the html-escaped contents of the file pointed to by the template-path ‘PATH’

Package

djula.tag-compilers

Source

tags.lisp (file)

Function: time IT &optional FORMAT

Package

djula.filters

Source

filters.lisp (file)

Function: trans &rest ARG-LIST0

Package

djula.unparsed-tag-processors

Source

translation.lisp (file)

Function: trans IT &rest ARGS

Package

djula.filters

Source

translation.lisp (file)

Function: translate STRING &optional ARGS LANGUAGE BACKEND

Package

djula

Source

translation.lisp (file)

Function: translation &rest ARG-LIST0

Package

djula.token-compilers

Source

translation.lisp (file)

Function: truncatechars IT N

Package

djula.filters

Source

filters.lisp (file)

Function: unparsed-tag &rest ARG-LIST0

Package

djula.token-processors

Source

tag.lisp (file)

Function: unparsed-translation &rest ARG-LIST0

Package

djula.token-processors

Source

translation.lisp (file)

Function: unparsed-variable &rest ARG-LIST0

:PARSED-VARIABLE tokens are parsed into :VARIABLE tokens by PROCESS-TOKENS

Package

djula.token-processors

Source

variables.lisp (file)

Function: update-caveman-project PROJECT

update the cl-locale dictionary files with the djula translate strings. Project should coincide with project (asdf) name of the caveman project. This assumes the project uses the standard caveman2 directory structure. It does not depend on any caveman source code and
caveman or your project need not be loaded.

Package

djula.locale

Source

locale.lisp (file)

Function: update-locale-list MESSAGE-FILE TRANSLATE-STRINGS

update a cl-locale message file with the list of translate strings

Package

djula.locale

Source

locale.lisp (file)

Function: update-project TEMPLATE-DIR LOCALE-DIR

update a djula project informing the template directory and the directory of subdirectories holding the cl-locale dictionary files

Package

djula.locale

Source

locale.lisp (file)

Function: upper IT

Package

djula.filters

Source

filters.lisp (file)

Function: url-encode STRING

URL-encodes a string using the external format EXTERNAL-FORMAT.

Package

djula

Source

util.lisp (file)

Function: url-encode-path PATH

Package

djula

Source

util.lisp (file)

Function: urlencode IT

Package

djula.filters

Source

filters.lisp (file)

Function: variable &rest ARG-LIST0

Package

djula.token-compilers

Source

variables.lisp (file)

Function: verbatim &rest ARG-LIST0

Package

djula.token-compilers

Source

lexer.lisp (file)

Function: with IT REPLACE

Package

djula.filters

Source

filters.lisp (file)

6.1.4 Generic functions

Generic Function: compile-template COMPILER NAME &optional ERROR-P

Provides a hook to customize template compilation.

Package

djula

Source

compiler.lisp (file)

Methods

Method: compile-template (COMPILER toplevel-compiler) NAME &optional ERROR-P

Method: compile-template (COMPILER compiler) NAME &optional ERROR-P

Generic Function: fetch-template STORE KEY

Return the text of the template identified by the given key.

Package

djula

Source

template-store.lisp (file)

Methods

Method: fetch-template (STORE file-store) NAME

Generic Function: find-template STORE NAME &optional ERROR-P

Return a hashable key that uniquely identifies the named template.

Package

djula

Source

template-store.lisp (file)

Methods

Method: find-template (STORE file-store) NAME &optional ERROR-P

Generic Function: fragment-compiler OBJECT

Package

djula

Methods

Method: fragment-compiler (TOPLEVEL-COMPILER toplevel-compiler)

automatically generated reader method

Source

compiler.lisp (file)

6.1.5 Classes

Class: compiler ()

Package

djula

Source

compiler.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

toplevel-compiler (class)

Direct methods

compile-template (method)

Class: file-store ()

Searches for template files on disk according to the given search path.

Package

djula

Source

template-store.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• fetch-template (method)
• find-template (method)
• search-path (method)
• search-path (method)

Direct slots

Slot: current-path

The location of the most-recently fetched template.

Type

(or null string pathname)

Slot: search-path

User-provided list of template locations.

Type

list

Initargs

:search-path

Readers

search-path (generic function)

Writers

(setf search-path) (generic function)

Class: toplevel-compiler ()

Package

djula

Source

compiler.lisp (file)

Direct superclasses

compiler (class)

Direct methods

• compile-template (method)
• fragment-compiler (method)

Direct slots

Slot: fragment-compiler

Initargs

:fragment-compiler

Initform

(make-instance (quote djula:compiler))

Readers

fragment-compiler (generic function)

6.2 Internal definitions

6.2.1 Constants

Constant: +whitespace+

Whitespace characters.

Package

djula.locale

Source

locale.lisp (file)

6.2.2 Special variables

Special Variable: *accumulated-javascript-strings*

Package

djula

Source

specials.lisp (file)

Special Variable: *block-alist*

Package

djula

Source

specials.lisp (file)

Special Variable: *current-block*

Package

djula

Source

specials.lisp (file)

Special Variable: *current-template*

Package

djula

Source

specials.lisp (file)

Special Variable: *eval-lisp-tags*

Package

djula

Source

specials.lisp (file)

Special Variable: *gettext-domain*

Package

djula

Source

translation.lisp (file)

Special Variable: *linked-templates*

Package

djula

Source

specials.lisp (file)

Special Variable: *template-arguments*

Package

djula

Source

specials.lisp (file)

Special Variable: *untranslated-messages*

Package

djula

Source

translation.lisp (file)

Special Variable: *warn-on-untranslated-messages*

Package

djula

Source

translation.lisp (file)

6.2.3 Macros

Macro: accum ACCFN &body BODY

Package

djula

Source

util.lisp (file)

Macro: def-delimited-tag STARTTAG ENDTAG DELIMITED-NAME

Package

djula

Source

pipeline.lisp (file)

Macro: def-tag-processor NAME ARGS REST-VAR &body BODY

Package

djula

Source

pipeline.lisp (file)

Macro: def-token-compiler NAME ARGS &body BODY

Package

djula

Source

pipeline.lisp (file)

Macro: def-token-processor NAME ARGS REST-VAR &body BODY

Package

djula

Source

pipeline.lisp (file)

Macro: def-unparsed-tag-processor NAME ARGS REST-VAR &body BODY

Package

djula

Source

pipeline.lisp (file)

Macro: with-file-handler (STRING-VAR TEMPLATE-PATH) &body BODY

evaluates ‘BODY’ with ‘STRING-VAR’ bound to a string representing the contents of the file pointed to be the template-path ‘TEMPLATE-PATH’, returning it’s results. if there is an error while binding ‘STRING-VAR’ and *CATCH-TEMPLATE-ERRORS-P* is T then it returns a function that is suitable output for the body of a DEF-TOKEN-COMPILER form that returns some debugging info.

Package

djula

Source

tags.lisp (file)

Macro: with-template-error RECOVERY-FORM &body BODY

Package

djula

Source

conditions.lisp (file)

6.2.4 Functions

Function: alter-pathname PATHNAME &rest OPTIONS

alter pathname as specified in the options

Package

djula.locale

Source

locale.lisp (file)

Function: and-bterm BOOLEXP

Package

djula

Source

tags.lisp (file)

Function: apply-filters VALUE FILTERS

Package

djula

Source

filters.lisp (file)

Function: apply-keys/indexes THING KEYS/INDEXES

Package

djula

Source

variables.lisp (file)

Function: backup-file FILE

backup the file by copying it from filename.ext to filename-n.ext where n is the next available number.

Package

djula.locale

Source

locale.lisp (file)

Function: bliteral ()

Package

djula

Source

tags.lisp (file)

Function: boolean-comparison ()

Package

djula

Source

tags.lisp (file)

Function: boolexp-factor BOOLEXP

Package

djula

Source

tags.lisp (file)

Function: boolexp-parser ()

Package

djula

Source

tags.lisp (file)

Function: bterm BOOLEXP

Package

djula

Source

tags.lisp (file)

Function: comparison-operator-parser ()

Package

djula

Source

tags.lisp (file)

Function: compile-boolexp BEXP

Package

djula

Source

tags.lisp (file)

Function: compile-logical-statement STATEMENT

takes a "logical statement" like you would give {% if %} that has been parsed
into a list of keywords [eg: ’(:not :foo) or ’(:foo :and :baz) or
‘(:foo.bar :or :list.1)] and turns them into a thunk predicate for dispatching the conditional branching of the {% if %} tag. when called, the function returns two values:

1. the value returned by resolving the phrase
2. an error message string if something went wrong [ie, an invalid variable]. [note: if return value 2 is present, then its probably not safe to consider return value 1 useful]

Package

djula

Source

tags.lisp (file)

Function: compile-string STRING

Package

djula

Source

compiler.lisp (file)

Function: compile-token TOKEN

Package

djula

Source

compiler.lisp (file)

Function: escape-for-html STRING

Escapes the characters #\<, #\>, #\’, #\", and #\& for HTML output.

Package

djula

Source

util.lisp (file)

Function: escape-string-split CHAR STRING &optional ESCAPE QUOTES

Package

djula

Source

variables.lisp (file)

Function: find-end-tag TAG-NAME TOKENS

returns NIL if a :TAG token with the name ‘TAG-NAME’ can’t be found in ‘TOKENS’. Otherwise returns three values:

1. a list of all the tokens up to that token
2. a list of all tokens after that token
3. T, indicating that ‘TAG-NAME’ was found

Package

djula

Source

tag.lisp (file)

Function: find-filter NAME

Return the filter by the name of NAME.

Package

djula

Source

pipeline.lisp (file)

Function: find-tag-compiler NAME

Return the tag compiler by the name of NAME.

Package

djula

Source

pipeline.lisp (file)

Function: find-tag-processor NAME

Return the tag processor by the name of NAME.

Package

djula

Source

pipeline.lisp (file)

Function: find-token-compiler NAME

Return the token processor by the name of NAME.

Package

djula

Source

pipeline.lisp (file)

Function: find-token-processor NAME

Return the token processor by the name of NAME.

Package

djula

Source

pipeline.lisp (file)

Function: find-unparsed-tag-processor TAG-NAME

Return the unparsed tag processor by the name of TAG-NAME.

Package

djula

Source

pipeline.lisp (file)

Function: format-translation STRING &rest ARGS

Package

djula

Source

translation.lisp (file)

Function: get-closing-delimiter TYPE

Return the string that closes the corresponding token TYPE.

Package

djula

Source

lexer.lisp (file)

Function: get-variable NAME

takes a variable ‘NAME’ and returns:
1. the value of ‘NAME’
2. any error string generated by the lookup (if there is an error string then the lookup was unsuccessful)

Package

djula

Source

variables.lisp (file)

Function: in-list PARSER

Package

djula

Source

tags.lisp (file)

Function: integer-or-keyword STRING

If the STRING is an integer return an integer, otherwise return STRING as a keyword.

Package

djula

Source

variables.lisp (file)

Function: iterable-list ITERABLE

Package

djula

Source

tags.lisp (file)

Function: join SEPARATOR LIST

Join the strings in LIST, using SEPARATOR in between the elements.

Similar to Python’s str.join

Package

djula

Source

util.lisp (file)

Function: next-tag STRING START

Return the position of the start of next tag in STRING starting from START.

Package

djula

Source

lexer.lisp (file)

Function: not-bfactor BOOLEXP

Package

djula

Source

tags.lisp (file)

Function: or-bterm BOOLEXP

Package

djula

Source

tags.lisp (file)

Function: parse-filter-string STRING

Package

djula

Source

variables.lisp (file)

Function: parse-rest-of-tag STRING START

Package

djula

Source

tag.lisp (file)

Function: parse-tag STRING CURRENT-POSITION

Return the lexer token and the index where the tag ended.

Package

djula

Source

lexer.lisp (file)

Function: parse-template-string STRING

Package

djula.locale

Source

locale.lisp (file)

Function: parse-template-string TEMPLATE

Transform the TEMPLATE into a list of lexer tokens

Package

djula

Source

lexer.lisp (file)

Function: parse-variable-clause UNPARSED-STRING

Package

djula

Source

variables.lisp (file)

Function: parse-variable-phrase STRING

Package

djula

Source

variables.lisp (file)

Function: print-debugging-information OUT

Package

djula

Source

tags.lisp (file)

Function: print-fancy-debugging-information STREAM

Package

djula

Source

tags.lisp (file)

Function: process-ifequal-args UNPARSED-STRING

Package

djula

Source

tags.lisp (file)

Function: process-token TOKEN REST-TOKEN-LIST

Package

djula

Source

parser.lisp (file)

Function: process-tokens TOKENS

Package

djula

Source

parser.lisp (file)

Function: remove-first ITEM SEQUENCE &key TEST KEY

Removes the first ocurrence of item in sequence

Package

djula

Source

tags.lisp (file)

Function: render-error-template ERROR BACKTRACE &optional TEMPLATE STREAM

Render the *ERROR-TEMPLATE* with the ERROR, the BACKTRACE and the TEMPLATE where the error ocurred.

Package

djula

Source

conditions.lisp (file)

Function: resolve-plist PLIST

Package

djula

Source

translation.lisp (file)

Function: resolve-variable-phrase LIST

takes a list starting wise a variable and ending with 0 or more keys or indexes [this is a direct translation from the dot (.) syntax] and returns two values:

1. the result [looking up the var and applying index/keys]
2. an error string if something went wrond [note: if there is an error string then the result probably shouldn’t be considered useful.

Package

djula

Source

variables.lisp (file)

Function: semi-parse-tag STRING

Package

djula

Source

tag.lisp (file)

Function: slurp PATHNAME

Package

djula

Source

template-store.lisp (file)

Function: split-if-clause CLAUSE-TOKENS

returns two values:

1. all clause tokens that appear _before_ the first :ELSE token 2. all clause tokens that appear _after_ the first :ELSE token

Package

djula

Source

tags.lisp (file)

Function: string-string-p S

test if s is a string that contains a string representation

Package

djula.locale

Source

locale.lisp (file)

Function: string-translate-strings STRING

given a djula html template string, find all the substrings to be translated

Package

djula.locale

Source

locale.lisp (file)

Function: template-error MSG &rest ARGS

Package

djula

Source

conditions.lisp (file)

Function: template-error* ERROR MSG &rest ARGS

Package

djula

Source

conditions.lisp (file)

Function: template-error-string FMT &rest ARGS

Package

djula

Source

conditions.lisp (file)

Function: template-error-string* ERROR FMT &rest ARGS

Package

djula

Source

conditions.lisp (file)

Function: token-type CHAR

Return the token-type for CHAR.

Package

djula

Source

lexer.lisp (file)

Function: transform TRANSFORM

Parser: transform and return the result, when the transformation applies (not null)

Package

djula

Source

tags.lisp (file)

Function: trim-whitespace STRING

STRING without whitespace at ends.

Package

djula.locale

Source

locale.lisp (file)

Function: truncate-characters STRING MAX-LENGTH &optional ELISION-STRING

If the STRING is larger than MAX-LENGTH, truncate it and append the ELISION-STRING so that the total length is MAX-LENGTH. Otherwise return the STRING unmodified. If the truncation is impossible to accomplish, return nil.

Package

djula

Source

util.lisp (file)

6.2.5 Generic functions

Generic Function: backend-translate BACKEND STRING LANGUAGE &rest ARGS

Package

djula

Source

translation.lisp (file)

Methods

Method: backend-translate (BACKEND (eql gettext)) STRING LANGUAGE &rest ARGS

Method: backend-translate (BACKEND (eql locale)) STRING LANGUAGE &rest ARGS

Method: backend-translate (BACKEND null) STRING LANGUAGE &rest ARGS

Method: backend-translate BACKEND STRING LANGUAGE &rest ARGS

Generic Function: compile-template-file COMPILED-TEMPLATE

Package

djula

Methods

Method: compile-template-file (COMPILED-TEMPLATE compiled-template)

Source

compiler.lisp (file)

Generic Function: compiled-template OBJECT

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

Package

djula

Methods

Method: compiled-template (COMPILED-TEMPLATE compiled-template)

Method: (setf compiled-template) NEW-VALUE (COMPILED-TEMPLATE compiled-template)

The compiled template (a closure)

Source

compiler.lisp (file)

Generic Function: linked-templates OBJECT

Generic Function: (setf linked-templates) NEW-VALUE OBJECT

Package

djula

Methods

Method: linked-templates (COMPILED-TEMPLATE compiled-template)

Method: (setf linked-templates) NEW-VALUE (COMPILED-TEMPLATE compiled-template)

Extends for Include files.

Source

compiler.lisp (file)

Generic Function: search-path OBJECT

Generic Function: (setf search-path) NEW-VALUE OBJECT

Package

djula

Methods

Method: search-path (FILE-STORE file-store)

Method: (setf search-path) NEW-VALUE (FILE-STORE file-store)

User-provided list of template locations.

Source

template-store.lisp (file)

Generic Function: template-changed COMPILED-TEMPLATE

Package

djula

Methods

Method: template-changed (COMPILED-TEMPLATE compiled-template)

Source

compiler.lisp (file)