The talcl Reference Manual

Table of Contents

The talcl Reference Manual

This is the talcl Reference Manual, version 0.2, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 12:20:48 2020 GMT+0.

1 Introduction

TALCL: A libary that implements the TAL template language for common lisp

This library is a significant branch of the TAL implementation found in arnesi / ucw

Examples

See the examples directory for runable lisp code and tal templates.

Primary Goals

Flexibility, Debugability, and Consistency !

• To make working with templates (particularly XML/HTML) simple and support designer type folks working on them. Support the goal of non-lispers contributing to projects

• To be more flexible, easier to use, easier to debug, and with more helpful error messages than the original TAL from arnesi and ucw. TAL now has a single execution environment (the common lisp env) rather than its own private tal environment. It accomplishes this by runtime binding using progv. (IE: Most template variables are declared special. however due to package locks, anything that is in package :cl will not be declared, and thus produce warnings, but will still work correctly.)

• Easier to debug (again), it was very difficult to deduce what was wrong in most other template libraries, and I wanted to easily tell what part of the file was broken.

• Runtime information about what handlers and variables are available in the environment, can be accessed <tal:print-handlers> <tal:describe-handlers>, <tal:print-env>

• can easily include "bodies" that are passed as parameters to subtemplates See: examples/window.tal

• integrate well with cxml dom & our buildnode library. We want to be able to embed template content into our dom document in an efficient manner. Currently these are stored as processing instructions in the dom, and in serialization we play out the sax events we buffered when processing the template

• Tal tags can just be functions in common lisp that return cxml:dom snippets (see: buildnode)

• Lisp functions can just return direct stream writes / strings to the output document using <tal:content-as-is> - bypasses all validation careful!

• Plain text template support -> <tal:tal> stuff </tal:tal> renders as just the text (can be the whole template).

Changes From Arnesi / UCW tal

• Available without loading arnesi, yaclml, or ucw

• A single environment (tal environment is used only to pass values as parameters); TAL processing occurs in the standard common lisp runtime. TAL package determines what is currently available.

• Fixed inconsistencies about "$var" in non tal tags vs "var" in tal tags. $var should now work everywhere whether or not the tag or attribute is tal.

• More consistancy in evaluation rules

• More handlers, all handlers have tests

• tal:def handler for defining new sub templates

• output

• tal expression strings work in the body of a tag as well as attributes

• $$ escapes to a single $ sign

• $ evaluates one expression

• $var and ${var} returns the value of the var

• $(some-fn var) - calls some-fn with the value of var in the current package / env and splices the return into the doc

• ${nil} doesnt print anything

• DOM nodes and lists / vectors of dom-nodes can be spliced into the template EG: <span>$some-dom-content</span> will correctly put the dom content into the template

TAL Handlers

TAL handlers are tags / attributes that tal processes in a special way.

Handler Descriptions

These are the descriptions of each of the tal handlers that are available. This output was generated by the <tal:describe-handlers /> tag

NET.COMMON-LISP.PROJECT.BESE.TAL.CORE::DESCRIBE-HANDLERS
  [symbol]

DESCRIBE-HANDLERS names a compiled function:
  Lambda-list: (TAG)
  Derived type: (FUNCTION (T) *)
  Documentation:
    TAG-HANDLER: Describes (in an comment), all tags and attribute handlers that are known
       (in *tal-attribute-handlers* or *tal-tag-handlers*)
  Source file: /home/ACCELERATION/russ/lisp/talcl/src/handlers.lisp

NET.COMMON-LISP.PROJECT.BESE.TAL.CORE::DESCRIBE-HANDLER
  [symbol]

DESCRIBE-HANDLER names a compiled function:
  Lambda-list: (TAG)
  Derived type: (FUNCTION (T) *)
  Documentation:
    TAG-HANDLER: Describes (in an comment) the tag or attribute handler named by the
    attribute tal:name
  Source file: /home/ACCELERATION/russ/lisp/talcl/src/handlers.lisp

NET.COMMON-LISP.PROJECT.BESE.TAL.CORE::PRINT-HANDLERS
  [symbol]

PRINT-HANDLERS names a compiled function:
  Lambda-list: (TAG)
  Derived type: (FUNCTION (T) (VALUES CONS &OPTIONAL))
  Documentation:
    TAG-HANDLER: Lists (in a comment) the tag and attribute handlers
    that are currently registered.
  Source file: /home/ACCELERATION/russ/lisp/talcl/src/handlers.lisp

NET.COMMON-LISP.PROJECT.BESE.TAL.CORE::PRINT-ENV
  [symbol]

PRINT-ENV names a compiled function:
  Lambda-list: (TAG)
  Derived type: (FUNCTION (T) *)
  Documentation:
    TAG-HANDLER: prints as a comment information about the
    tal-environment where this tag was encountered
  Source file: /home/ACCELERATION/russ/lisp/talcl/src/handlers.lisp

NET.COMMON-LISP.PROJECT.BESE.TAL.CORE:DEF
  [symbol]

DEF names a compiled function:
  Lambda-list: (TAG)
  Derived type: (FUNCTION (T) (VALUES NULL &OPTIONAL))
  Documentation:
    TAG-HANDLER: creates an inline sub-template available for the duration
    of the templates execution.
    
    The template should be named by the tal:name attribute or by
    tal:name-expression if it should be evaluated.
    
    
    Example:
       <tal:def tal:name='deffed-template'>
           <div>
             <span tal:when='$selected'>*</span>
             <span tal:content='$label'</span>
           </div>
       </tal>
    
    tal:def can also be used to create string constants when used with tal:type=\"string\"
    
    Example:
       <tal:def tal:name='deffed-string' tal:type='string'>This is my string</tal>
    
      results in a let binding (deffed-string \"This is my string\")
    

  Source file: /home/ACCELERATION/russ/lisp/talcl/src/handlers.lisp

NET.COMMON-LISP.PROJECT.BESE.TAL.CORE:INCLUDE
  [symbol]

INCLUDE names a compiled function:
  Lambda-list: (TAG)
  Derived type: (FUNCTION (T) *)
  Documentation:
    TAG-HANDLER: includes another template at this point in the file.
    The template should be named by the tal:name attribute or by
    tal:name-expression if it should be evaluated.
    
    The path to the referenced template should be relative to the location
    of the template it is included in.
      
    The environment can be extended by including attributes in the
    parameter namespace, or immediate children in the parameter namespace.
    
    Example:
       <tal:include tal:name-expression='$tal-name' param:foo='foo' />
       <tal:include tal:name='other-template.tal' param:foo='foo'>
         <param:contents>
           <div>
             <span tal:when='$selected'>*</span>
             <span tal:content='$label'</span>
           </div>
         </param:contents>
       </tal>
    
    The template other-template.tal will be evaluated with the additional
    parameters of 'foo' and 'contents'.

  Source file: /home/ACCELERATION/russ/lisp/talcl/src/handlers.lisp

NET.COMMON-LISP.PROJECT.BESE.TAL.CORE:LOOP
  [symbol]

LOOP names a compiled function:
  Lambda-list: (TAG)
  Derived type: (FUNCTION (T) *)
  Documentation:
    TAG-HANDLER: Loop across a list and repeat the children. On each
      iteration the environment is extended with the value
    
      tal:list should evaluate to a list
      tal:constant-list is parsed as a comma separated string
    
      <tal:loop tal:var='class' tal:list='$efficiencies'>
        <label class='map-control-item'>
          <img class='marker-icon ${$class}' />
          <span class='text' tal:content='$class'/>
          <input type='checkbox' name='filter-efficiency' item-type='${$class}' />
        </label>
      </tal:loop>
    
    assuming that $efficiencies resolves to the list {foo,bar}.
        <label class='map-control-item'>
          <img class='marker-icon foo' />
          <span class='text' tal:content='foo'/>
          <input type='checkbox' name='filter-efficiency' item-type='foo' />
        </label>
        <label class='map-control-item'>
          <img class='marker-icon bar' />
          <span class='text' tal:content='bar'/>
          <input type='checkbox' name='filter-efficiency' item-type='bar' />
        </label>

  Source file: /home/ACCELERATION/russ/lisp/talcl/src/handlers.lisp

NET.COMMON-LISP.PROJECT.BESE.TAL.CORE::LISP
  [symbol]

LISP names a compiled function:
  Lambda-list: (TAG)
  Derived type: (FUNCTION (T) *)
  Documentation:
    TAG-HANDLER: evaluate the body of the tag as lisp code.
  Source file: /home/ACCELERATION/russ/lisp/talcl/src/handlers.lisp

NET.COMMON-LISP.PROJECT.BESE.TAL.CORE::WITHOUT-READER
  [symbol]

WITHOUT-READER names a compiled function:
  Lambda-list: (TAG)
  Derived type: (FUNCTION (T) *)
  Source file: /home/ACCELERATION/russ/lisp/talcl/src/handlers.lisp

NET.COMMON-LISP.PROJECT.BESE.TAL.CORE:TAL
  [symbol]

TAL names a compiled function:
  Lambda-list: (TAG)
  Derived type: (FUNCTION (T) *)
  Source file: /home/ACCELERATION/russ/lisp/talcl/src/handlers.lisp

NET.COMMON-LISP.PROJECT.BESE.TAL.CORE:IN-PACKAGE
  [symbol]

IN-PACKAGE names a compiled function:
  Lambda-list: (TAG)
  Derived type: (FUNCTION (T) *)
  Documentation:
    ATTRIBUTE-HANDLER: sets the package in which lisp evaluation
    happens.
  Source file: /home/ACCELERATION/russ/lisp/talcl/src/handlers.lisp

NET.COMMON-LISP.PROJECT.BESE.TAL.CORE::LET
  [symbol]

LET names a compiled function:
  Lambda-list: (TAG)
  Derived type: (FUNCTION (T) *)
  Documentation:
    ATTRUBTE-HANDLER: Extend environment with a given list of bindings,
    as for LET form.
    
    Example:
    <div tal:let='foo 3'><div tal:content='$foo'/></div>
    
    Goes to: <div><div>3</div></div>

  Source file: /home/ACCELERATION/russ/lisp/talcl/src/handlers.lisp

NET.COMMON-LISP.PROJECT.BESE.TAL.CORE::UNLESS
  [symbol]

UNLESS names a compiled function:
  Lambda-list: (TAG)
  Derived type: (FUNCTION (T) *)
  Documentation:
    ATTRIBUTE-HANDLER: Causes this tag to only appear when
    the evaluated value of the attribute is nil.

  Source file: /home/ACCELERATION/russ/lisp/talcl/src/handlers.lisp

NET.COMMON-LISP.PROJECT.BESE.TAL.CORE:WHEN
  [symbol]

WHEN names a compiled function:
  Lambda-list: (TAG)
  Derived type: (FUNCTION (T) *)
  Documentation:
    ATTRIBUTE-HANDLER: Causes this tag to only appear when
    the evaluated value of the attribute is not nil.

  Source file: /home/ACCELERATION/russ/lisp/talcl/src/handlers.lisp

NET.COMMON-LISP.PROJECT.BESE.TAL.CORE:REPLACE
  [symbol]

REPLACE names a compiled function:
  Lambda-list: (TAG)
  Derived type: (FUNCTION (T) *)
  Documentation:
    ATTRIBUTE-HANDLER: Replaces the content of the tag with the
    evaluated value of the attribute. Whether the content is escaped
    depends upon the sibling attribute 'tal:escape-html
    
    Example:
    <div tal:replace='$foo' class='jack'/>
    
    Gets output as:
      |Whatever was in $foo|

  Source file: /home/ACCELERATION/russ/lisp/talcl/src/handlers.lisp

NET.COMMON-LISP.PROJECT.BESE.TAL.CORE::CONTENT-AS-IS
  [symbol]

CONTENT-AS-IS names a compiled function:
  Lambda-list: (TAG)
  Derived type: (FUNCTION (T) *)
  Documentation:
    ATTRIBUTE-HANDLER:
    Replaces the content of the tag with the evaluated value of the
    attribute. This tag does not escape the content.
    
    Example:
    <div tal:content-as-is='$foo' class='jack'/>
    Gets output as
    <div class='jack'>
      |Whatever was in $foo|
    </div>

  Source file: /home/ACCELERATION/russ/lisp/talcl/src/handlers.lisp

NET.COMMON-LISP.PROJECT.BESE.TAL.CORE:CONTENT
  [symbol]

CONTENT names a compiled function:
  Lambda-list: (TAG)
  Derived type: (FUNCTION (T) *)
  Documentation:
    ATTRIBUTE-HANDLER:
    Replaces the content of the tag with the evaluated value of the
    attribute. This tag escapes its content to be html-safe.
    
    Example:
    <div tal:content='$foo' class='jack'/>
    Gets output as
    <div class='jack'>
      |Whatever was in $foo|
    </div>

  Source file: /home/ACCELERATION/russ/lisp/talcl/src/handlers.lisp

NET.COMMON-LISP.PROJECT.BESE.TAL.CORE::TALABLE-STRINGS
  [symbol]

TALABLE-STRINGS names a compiled function:
  Lambda-list: (TAG)
  Derived type: (FUNCTION (T) *)
  Source file: /home/ACCELERATION/russ/lisp/talcl/src/handlers.lisp

Authors

• Acceleration.net - Donate
• Russ Tyndall
• Nathan Bird
• Ryan Davis

;; Copyright (C) 2011 Acceleration.net, Russ Tyndall
;;   email: bobbysmith007@gmail.com
;;
;; Copyright (c) 2002-2006, Edward Marco Baringer
;; All rights reserved.
;;
;; Redistribution and use in source and binary forms, with or without
;; modification, are permitted provided that the following conditions are
;; met:
;;
;; - Redistributions of source code must retain the above copyright
;; notice, this list of conditions and the following disclaimer.
;;
;; - Redistributions in binary form must reproduce the above copyright
;; notice, this list of conditions and the following disclaimer in the
;; documentation and/or other materials provided with the distribution.
;;
;; - Neither the name of Edward Marco Baringer, nor BESE, nor the names
;; of its contributors may be used to endorse or promote products derived
;; from this software without specific prior written permission.

;; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
;; "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
;; LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
;; A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
;; OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
;; SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
;; LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
;; DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
;; THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
;; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
;; OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

2 Systems

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

2.1 talcl

License

BSD

Description

TAL in CL

Version

0.2

Dependencies

• buildnode
• cxml
• iterate
• alexandria
• symbol-munger
• cl-ppcre

Source

talcl.asd (file)

Component

src (module)

3 Modules

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

3.1 talcl/src

Parent

talcl (system)

Location

src/

Components

• packages.lisp (file)
• tal-environment.lisp (file)
• sax-buffer.lisp (file)
• compile.lisp (file)
• dom.lisp (file)
• generator.lisp (file)
• handlers.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 talcl.asd

Location

talcl.asd

Systems

talcl (system)

Packages

talcl.system

4.1.2 talcl/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

• net.acceleration.talcl
• net.common-lisp.project.bese.tal.include-params
• net.common-lisp.project.bese.tal.core

4.1.3 talcl/src/tal-environment.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/tal-environment.lisp

Exported Definitions

• call-template-with-tal-environment (function)
• find-file-in-directories (function)
• run-template (function)
• run-template-fn (function)
• tal-env (function)

Internal Definitions

• %call-template-with-tal-environment (function)
• *tal-env* (special variable)
• *tal-generator* (special variable)
• *tal-truename* (special variable)
• aif (macro)
• awhen (macro)
• buffered-template-call (function)
• dos-safe-read-line (function)
• eliminate-..-in-path (function)
• if-bind (macro)
• read-string-from-file (function)
• read-tal-file-into-string (function)
• rebinding (macro)
• starts-with (function)
• when-bind (macro)
• with-input-from-file (macro)
• with-tal-compilation-unit (macro)
• with-this-sink (macro)
• with-unique-names (macro)

4.1.4 talcl/src/sax-buffer.lisp

Dependency

tal-environment.lisp (file)

Parent

src (module)

Location

src/sax-buffer.lisp

Internal Definitions

• buffer (method)
• (setf buffer) (method)
• buffering (method)
• (setf buffering) (method)
• buffering-sink (class)
• clear-buffer (generic function)
• clear-buffer (method)
• extended-xmls-builder (class)
• flushing (method)
• (setf flushing) (method)
• make-extended-xmls-builder (function)
• start-buffering (generic function)
• start-buffering (method)
• stop-buffering-and-flush (generic function)
• stop-buffering-and-flush (method)

4.1.5 talcl/src/compile.lisp

Dependency

sax-buffer.lisp (file)

Parent

src (module)

Location

src/compile.lisp

Exported Definitions

• *uri-to-package* (special variable)
• compile-tal-file (function)
• compile-tal-string (function)
• def-attribute-handler (macro)
• def-tag-handler (macro)
• destructure-tag (macro)
• make-interner (function)
• pull-attrib-val! (function)
• read-tal-expression-from-string (function)
• tal-runtime-condition (condition)
• transform-lxml-form (function)
• transform-lxml-tree (function)
• with-missing-value-handler (macro)

Internal Definitions

• $⎵tal⎵reader (function)
• %buffer-output-till-success (function)
• %in-common-lisp (function)
• *default-missing-template-value* (special variable)
• *expression-package* (special variable)
• *name-being-compiled* (special variable)
• *rely-on-warnings-for-variables* (special variable)
• *string-being-compiled* (special variable)
• *tal-attribute-handlers* (special variable)
• *tal-defs* (special variable)
• *tal-tag-handlers* (special variable)
• *talable-strings* (special variable)
• call-lambda-with-default-missing-value (function)
• call-lambda-with-unbound-variable-restarts (function)
• compile-tal-parse-tree-to-lambda (function)
• compile-tal-string-to-lambda (function)
• error-tal-expression-eof (function)
• find-expression-line/col-number (function)
• find-handler-named (function)
• find-missing-template-variables (function)
• find-missing-template-variables-from-unbound-variable-errors (function)
• find-missing-template-variables-from-warnings (function)
• format-args (method)
• (setf format-args) (method)
• format-args (method)
• (setf format-args) (method)
• format-control (method)
• (setf format-control) (method)
• format-control (method)
• (setf format-control) (method)
• gather-attrib-forms (function)
• interner (class)
• ns-test (method)
• (setf ns-test) (method)
• original-condition (method)
• (setf original-condition) (method)
• original-error (method)
• (setf original-error) (method)
• parse-tal-attribute-value (function)
• parse-tal-body-content (function)
• parse-talable-string (function)
• specified-attribute* (function)
• tal-compilation-condition (condition)
• tal-compilation-error (condition)
• tal-compilation-warning (condition)
• tal-error (function)
• tal-re-error (function)
• tal-re-warn (function)
• tal-runtime-error (function)
• tal-runtime-error (condition)
• tal-unexpected-eof-compilation-error (condition)
• tal-warn (function)
• template (method)
• (setf template) (method)
• template (method)
• (setf template) (method)
• transform-lxml-form-in-scope (function)
• transform-lxml-regular-tag (function)
• transform-lxml-tree-in-scope (function)
• uri-to-package (method)
• (setf uri-to-package) (method)

4.1.6 talcl/src/dom.lisp

Dependency

compile.lisp (file)

Parent

src (module)

Location

src/dom.lisp

Exported Definitions

• document-to-stream (function)
• document-to-string (function)
• make-template-processing-sink (function)
• tal-processing-instruction (function)
• tal-template-content (function)
• template-processing-sink (class)

Internal Definitions

• dom-walk-helper (function)
• make-output-sink (function)
• template-node (class)

4.1.7 talcl/src/generator.lisp

Dependency

dom.lisp (file)

Parent

src (module)

Location

src/generator.lisp

Exported Definitions

• caching-file-system-generator (class)
• file-system-generator (class)
• load-tal (generic function)
• load-tal (method)
• load-tal (method)
• load-tal (method)
• root-directories (method)
• (setf root-directories) (method)
• tal-generator (class)
• template-truename (generic function)
• template-truename (method)

Internal Definitions

• %get-tal-template-fn (function)
• *log* (special variable)
• *tal-templates* (special variable)
• cache (method)
• (setf cache) (method)
• copy-tal-template (function)
• log-fn (method)
• (setf log-fn) (method)
• make-tal-template (function)
• tal-log (function)
• tal-template (structure)
• tal-template-p (function)
• tal-template.file-name (function)
• (setf tal-template.file-name) (function)
• tal-template.function (function)
• (setf tal-template.function) (function)
• tal-template.last-load-time (function)
• (setf tal-template.last-load-time) (function)

4.1.8 talcl/src/handlers.lisp

Dependency

generator.lisp (file)

Parent

src (module)

Location

src/handlers.lisp

Exported Definitions

• content (function)
• def (function)
• in-package (function)
• include (function)
• loop (function)
• replace (function)
• tal (function)
• when (function)

Internal Definitions

• %emit-tagged-content (compiler macro)
• %emit-tagged-content (generic function)
• %emit-tagged-content (method)
• %eval (function)
• content-as-is (function)
• describe-handler (function)
• describe-handlers (function)
• intern-tal-string (function)
• let (function)
• lisp (function)
• plist-attrs (function)
• print-env (function)
• print-handlers (function)
• talable-strings (function)
• unless (function)
• without-reader (function)

5 Packages

Packages are listed by definition order.

5.1 talcl.system

Source

talcl.asd

Use List

• asdf/interface
• common-lisp

5.2 net.acceleration.talcl

Source

packages.lisp (file)

Nickname

talcl

Use List

• iterate
• common-lisp

Exported Definitions

• *uri-to-package* (special variable)
• caching-file-system-generator (class)
• call-template-with-tal-environment (function)
• compile-tal-file (function)
• compile-tal-string (function)
• def-attribute-handler (macro)
• def-tag-handler (macro)
• destructure-tag (macro)
• document-to-stream (function)
• document-to-string (function)
• file-system-generator (class)
• find-file-in-directories (function)
• load-tal (generic function)
• load-tal (method)
• load-tal (method)
• load-tal (method)
• make-interner (function)
• make-template-processing-sink (function)
• pull-attrib-val! (function)
• read-tal-expression-from-string (function)
• root-directories (generic function)
• root-directories (method)
• (setf root-directories) (method)
• (setf root-directories) (generic function)
• run-template (function)
• run-template-fn (function)
• tal-env (function)
• tal-generator (class)
• tal-processing-instruction (function)
• tal-runtime-condition (condition)
• tal-template-content (function)
• template-processing-sink (class)
• template-truename (generic function)
• template-truename (method)
• transform-lxml-form (function)
• transform-lxml-tree (function)
• with-missing-value-handler (macro)

Internal Definitions

• $⎵tal⎵reader (function)
• %buffer-output-till-success (function)
• %call-template-with-tal-environment (function)
• %emit-tagged-content (compiler macro)
• %emit-tagged-content (generic function)
• %emit-tagged-content (method)
• %eval (function)
• %get-tal-template-fn (function)
• %in-common-lisp (function)
• *default-missing-template-value* (special variable)
• *expression-package* (special variable)
• *log* (special variable)
• *name-being-compiled* (special variable)
• *rely-on-warnings-for-variables* (special variable)
• *string-being-compiled* (special variable)
• *tal-attribute-handlers* (special variable)
• *tal-defs* (special variable)
• *tal-env* (special variable)
• *tal-generator* (special variable)
• *tal-tag-handlers* (special variable)
• *tal-templates* (special variable)
• *tal-truename* (special variable)
• *talable-strings* (special variable)
• aif (macro)
• awhen (macro)
• buffer (generic function)
• buffer (method)
• (setf buffer) (method)
• (setf buffer) (generic function)
• buffered-template-call (function)
• buffering (generic function)
• buffering (method)
• (setf buffering) (method)
• (setf buffering) (generic function)
• buffering-sink (class)
• cache (generic function)
• cache (method)
• (setf cache) (method)
• (setf cache) (generic function)
• call-lambda-with-default-missing-value (function)
• call-lambda-with-unbound-variable-restarts (function)
• clear-buffer (generic function)
• clear-buffer (method)
• compile-tal-parse-tree-to-lambda (function)
• compile-tal-string-to-lambda (function)
• copy-tal-template (function)
• dom-walk-helper (function)
• dos-safe-read-line (function)
• eliminate-..-in-path (function)
• error-tal-expression-eof (function)
• extended-xmls-builder (class)
• find-expression-line/col-number (function)
• find-handler-named (function)
• find-missing-template-variables (function)
• find-missing-template-variables-from-unbound-variable-errors (function)
• find-missing-template-variables-from-warnings (function)
• flushing (generic function)
• flushing (method)
• (setf flushing) (method)
• (setf flushing) (generic function)
• format-args (generic function)
• format-args (method)
• (setf format-args) (method)
• format-args (method)
• (setf format-args) (method)
• (setf format-args) (generic function)
• format-control (generic function)
• format-control (method)
• (setf format-control) (method)
• format-control (method)
• (setf format-control) (method)
• (setf format-control) (generic function)
• gather-attrib-forms (function)
• if-bind (macro)
• intern-tal-string (function)
• interner (class)
• log-fn (generic function)
• log-fn (method)
• (setf log-fn) (method)
• (setf log-fn) (generic function)
• make-extended-xmls-builder (function)
• make-output-sink (function)
• make-tal-template (function)
• ns-test (generic function)
• ns-test (method)
• (setf ns-test) (method)
• (setf ns-test) (generic function)
• original-condition (generic function)
• original-condition (method)
• (setf original-condition) (method)
• (setf original-condition) (generic function)
• original-error (generic function)
• original-error (method)
• (setf original-error) (method)
• (setf original-error) (generic function)
• parse-tal-attribute-value (function)
• parse-tal-body-content (function)
• parse-talable-string (function)
• read-string-from-file (function)
• read-tal-file-into-string (function)
• rebinding (macro)
• specified-attribute* (function)
• start-buffering (generic function)
• start-buffering (method)
• starts-with (function)
• stop-buffering-and-flush (generic function)
• stop-buffering-and-flush (method)
• tal-compilation-condition (condition)
• tal-compilation-error (condition)
• tal-compilation-warning (condition)
• tal-error (function)
• tal-log (function)
• tal-re-error (function)
• tal-re-warn (function)
• tal-runtime-error (function)
• tal-runtime-error (condition)
• tal-template (structure)
• tal-template-p (function)
• tal-template.file-name (function)
• (setf tal-template.file-name) (function)
• tal-template.function (function)
• (setf tal-template.function) (function)
• tal-template.last-load-time (function)
• (setf tal-template.last-load-time) (function)
• tal-unexpected-eof-compilation-error (condition)
• tal-warn (function)
• template (generic function)
• template (method)
• (setf template) (method)
• template (method)
• (setf template) (method)
• (setf template) (generic function)
• template-node (class)
• transform-lxml-form-in-scope (function)
• transform-lxml-regular-tag (function)
• transform-lxml-tree-in-scope (function)
• uri-to-package (generic function)
• uri-to-package (method)
• (setf uri-to-package) (method)
• (setf uri-to-package) (generic function)
• when-bind (macro)
• with-input-from-file (macro)
• with-tal-compilation-unit (macro)
• with-this-sink (macro)
• with-unique-names (macro)

5.3 net.common-lisp.project.bese.tal.include-params

Source

packages.lisp (file)

Nickname

tal.include-params

5.4 net.common-lisp.project.bese.tal.core

An HTML template authoring library.

Source

packages.lisp (file)

Nickname

tal

Exported Definitions

• content (function)
• def (function)
• in-package (function)
• include (function)
• loop (function)
• replace (function)
• tal (function)
• when (function)

Internal Definitions

• content-as-is (function)
• describe-handler (function)
• describe-handlers (function)
• let (function)
• lisp (function)
• plist-attrs (function)
• print-env (function)
• print-handlers (function)
• talable-strings (function)
• unless (function)
• without-reader (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: *uri-to-package*

Default mapping of xmlns to packages.

Package

net.acceleration.talcl

Source

compile.lisp (file)

6.1.2 Macros

Macro: def-attribute-handler ATTRIBUTE (TAG) &body BODY

Defines a new attribute handler name ATTRIBUTE.

Package

net.acceleration.talcl

Source

compile.lisp (file)

Macro: def-tag-handler TAG-NAME (TAG) &body BODY

Defines a new tag handlec named TAG-NAME.

Package

net.acceleration.talcl

Source

compile.lisp (file)

Macro: destructure-tag (TAG &rest VARS) &body BODY

Binds tag-name tag-attributes and tag-body

Package

net.acceleration.talcl

Source

compile.lisp (file)

Macro: with-missing-value-handler ((&optional NAME) &body HANDLER-BODY) &body BODY

Provides error handler that will handle filling unbound variable
references with a value

handler can be (() ... body ) or ((name) ... body)
the return value of handler will be the value inserted in place of the missing value If you provide name, it will be bound to the name of the unbound variable for the duration of the handler

see call-lambda-with-default-missing-value for an example of use

Package

net.acceleration.talcl

Source

compile.lisp (file)

6.1.3 Functions

Function: call-template-with-tal-environment GENERATOR TEMPLATE ENV

This will call a template with all the tal-environment variables bound into the lisp dynamic environment.

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Function: compile-tal-file PATHNAME &optional EXPRESSION-PACKAGE &aux FN

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: compile-tal-string STRING &optional EXPRESSION-PACKAGE &aux WARNINGS

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: content TAG

ATTRIBUTE-HANDLER:
Replaces the content of the tag with the evaluated value of the attribute. This tag escapes its content to be html-safe.

Example:
<div tal:content=’$foo’ class=’jack’/>
Gets output as
<div class=’jack’>
|Whatever was in $foo|
</div>

Package

net.common-lisp.project.bese.tal.core

Source

handlers.lisp (file)

Function: def TAG

TAG-HANDLER: creates an inline sub-template available for the duration
of the templates execution.

The template should be named by the tal:name attribute or by
tal:name-expression if it should be evaluated.

Example:
<tal:def tal:name=’deffed-template’>
<div>
<span tal:when=’$selected’>*</span>
<span tal:content=’$label’</span>
</div>
</tal>

tal:def can also be used to create string constants when used with tal:type="string"

Example:
<tal:def tal:name=’deffed-string’ tal:type=’string’>This is my string</tal>

results in a let binding (deffed-string "This is my string")

Package

net.common-lisp.project.bese.tal.core

Source

handlers.lisp (file)

Function: document-to-stream DOC STREAM

Package

net.acceleration.talcl

Source

dom.lisp (file)

Function: document-to-string DOC

Package

net.acceleration.talcl

Source

dom.lisp (file)

Function: find-file-in-directories NAME ROOT-DIRECTORIES

Find the given name in a list of directories

For security if the roots are absolute, ensure that the resulting file is actually contained in those directories
i.e. prevent escaping the bounds via ../../../

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Function: in-package TAG

ATTRIBUTE-HANDLER: sets the package in which lisp evaluation happens.

Package

net.common-lisp.project.bese.tal.core

Source

handlers.lisp (file)

Function: include TAG

TAG-HANDLER: includes another template at this point in the file. The template should be named by the tal:name attribute or by tal:name-expression if it should be evaluated.

The path to the referenced template should be relative to the location of the template it is included in.

The environment can be extended by including attributes in the parameter namespace, or immediate children in the parameter namespace.

Example:
<tal:include tal:name-expression=’$tal-name’ param:foo=’foo’ /> <tal:include tal:name=’other-template.tal’ param:foo=’foo’> <param:contents>
<div>
<span tal:when=’$selected’>*</span>
<span tal:content=’$label’</span>
</div>
</param:contents>
</tal>

The template other-template.tal will be evaluated with the additional parameters of ’foo’ and ’contents’.

Package

net.common-lisp.project.bese.tal.core

Source

handlers.lisp (file)

Function: loop TAG

TAG-HANDLER: Loop across a list and repeat the children. On each
iteration the environment is extended with the value

tal:list should evaluate to a list
tal:constant-list is parsed as a comma separated string

<tal:loop tal:var=’class’ tal:list=’$efficiencies’>
<label class=’map-control-item’>
<img class=’marker-icon ${$class}’ />
<span class=’text’ tal:content=’$class’/>
<input type=’checkbox’ name=’filter-efficiency’ item-type=’${$class}’ /> </label>
</tal:loop>

assuming that $efficiencies resolves to the list {foo,bar}.
<label class=’map-control-item’>
<img class=’marker-icon foo’ />
<span class=’text’ tal:content=’foo’/>
<input type=’checkbox’ name=’filter-efficiency’ item-type=’foo’ /> </label>
<label class=’map-control-item’>
<img class=’marker-icon bar’ />
<span class=’text’ tal:content=’bar’/>
<input type=’checkbox’ name=’filter-efficiency’ item-type=’bar’ /> </label>

Package

net.common-lisp.project.bese.tal.core

Source

handlers.lisp (file)

Function: make-interner URI-TO-PACKAGE CHAINED-HANDLER

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: make-template-processing-sink &rest HANDLERS

Package

net.acceleration.talcl

Source

dom.lisp (file)

Function: pull-attrib-val! TAG KEY

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: read-tal-expression-from-string EXPRESSION &optional IMPLICIT-PROGN-P

Reads a single form from the string EXPRESSION using the TAL expression read table.

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: replace TAG

ATTRIBUTE-HANDLER: Replaces the content of the tag with the evaluated value of the attribute. Whether the content is escaped depends upon the sibling attribute ’tal:escape-html

Example:
<div tal:replace=’$foo’ class=’jack’/>

Gets output as:
|Whatever was in $foo|

Package

net.common-lisp.project.bese.tal.core

Source

handlers.lisp (file)

Function: run-template GENERATOR TEMPLATE ENV

Runs a tal template returning the string produced

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Function: run-template-fn FN ENV

Runs a tal template returning the string produced

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Function: tal TAG

Package

net.common-lisp.project.bese.tal.core

Source

handlers.lisp (file)

Function: tal-env &rest PAIRS

Creates a fresh tal environment from the plist PAIRS.

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Function: tal-processing-instruction GENERATOR TEMPLATE-NAME ENV

Make a tal-processing-instruction. It’s a dom node that when processed will insert the template in the sax stream.

The template content will never be part of the dom, which saves two changes of representation. This is about 3 times faster than tal-template-content.

Package

net.acceleration.talcl

Source

dom.lisp (file)

Function: tal-template-content GENERATOR TEMPLATE-NAME ENV &optional NODE

Serialize a template into the document as children of the node passed in

This is about 3 times slower than the tal-processing-instruction

Package

net.acceleration.talcl

Source

dom.lisp (file)

Function: transform-lxml-form FORM

Transforms the lxml tree FORM into common lisp code (a series of calls to tag macros).

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: transform-lxml-tree TREE

Given a tree representing some LXML code with TAL attributes returns the yaclml tag using code for generating the HTML. Destructivly modifies TREE.

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: when TAG

ATTRIBUTE-HANDLER: Causes this tag to only appear when the evaluated value of the attribute is not nil.

Package

net.common-lisp.project.bese.tal.core

Source

handlers.lisp (file)

6.1.4 Generic functions

Generic Function: load-tal GENERATOR NAME

Package

net.acceleration.talcl

Source

generator.lisp (file)

Methods

Method: load-tal (GENERATOR caching-file-system-generator) NAME &aux *LOG*

Method: load-tal (GENERATOR file-system-generator) (NAME pathname) &aux *LOG*

Method: load-tal (GENERATOR file-system-generator) (NAME string) &aux *LOG*

Generic Function: root-directories OBJECT

Generic Function: (setf root-directories) NEW-VALUE OBJECT

Package

net.acceleration.talcl

Methods

Method: root-directories (FILE-SYSTEM-GENERATOR file-system-generator)

automatically generated reader method

Source

generator.lisp (file)

Method: (setf root-directories) NEW-VALUE (FILE-SYSTEM-GENERATOR file-system-generator)

automatically generated writer method

Source

generator.lisp (file)

Generic Function: template-truename GENERATOR NAME

Package

net.acceleration.talcl

Source

generator.lisp (file)

Methods

Method: template-truename (GENERATOR file-system-generator) NAME &aux *LOG*

6.1.5 Conditions

Condition: tal-runtime-condition ()

Package

net.acceleration.talcl

Source

compile.lisp (file)

Direct superclasses

simple-condition (condition)

Direct subclasses

tal-runtime-error (condition)

Direct methods

• template (method)
• template (method)
• original-error (method)
• original-error (method)
• format-args (method)
• format-args (method)
• format-control (method)
• format-control (method)

Direct slots

Slot: format-control

Initargs

:format-control

Initform

(quote nil)

Readers

format-control (generic function)

Writers

(setf format-control) (generic function)

Slot: format-args

Initargs

:format-args

Initform

(quote nil)

Readers

format-args (generic function)

Writers

(setf format-args) (generic function)

Slot: original-error

Initargs

:original-error

Initform

(quote nil)

Readers

original-error (generic function)

Writers

(setf original-error) (generic function)

Slot: template

Initargs

:template

Initform

(quote net.acceleration.talcl::*name-being-compiled*)

Readers

template (generic function)

Writers

(setf template) (generic function)

6.1.6 Classes

Class: caching-file-system-generator ()

Similar to a file-system-generator it generates out
of some root directories, however it keeps a cache of the compiled lisp functions. The function you get back from it checks the file’s date-modified and automatically recompiles at need.

Package

net.acceleration.talcl

Source

generator.lisp (file)

Direct superclasses

file-system-generator (class)

Direct methods

• load-tal (method)
• cache (method)
• cache (method)

Direct slots

Slot: cache

Initform

(make-hash-table :test (quote equal))

Readers

cache (generic function)

Writers

(setf cache) (generic function)

Class: file-system-generator ()

When given a list of root directories it will search for templates in those directories.

Package

net.acceleration.talcl

Source

generator.lisp (file)

Direct superclasses

tal-generator (class)

Direct subclasses

caching-file-system-generator (class)

Direct methods

• load-tal (method)
• load-tal (method)
• template-truename (method)
• root-directories (method)
• root-directories (method)

Direct slots

Slot: root-directories

Type

list

Initargs

:root-directories

Readers

root-directories (generic function)

Writers

(setf root-directories) (generic function)

Class: tal-generator ()

Package

net.acceleration.talcl

Source

generator.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

file-system-generator (class)

Direct methods

• log-fn (method)
• log-fn (method)

Direct slots

Slot: log-fn

A log-fn that accepts a string and writes it to the log

Initargs

:log-fn

Readers

log-fn (generic function)

Writers

(setf log-fn) (generic function)

Class: template-processing-sink ()

Package

net.acceleration.talcl

Source

dom.lisp (file)

Direct superclasses

broadcast-handler (class)

Direct methods

• processing-instruction (method)
• sink-omit-xml-declaration-p (method)
• sink-omit-xml-declaration-p (method)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *default-missing-template-value*

Package

net.acceleration.talcl

Source

compile.lisp (file)

Special Variable: *expression-package*

The value of *PACKAGE* when tal attribute expressions and for looking up symbols in the environment.

Package

net.acceleration.talcl

Source

compile.lisp (file)

Special Variable: *log*

A log-fn that accepts a string and writes it to the log

Package

net.acceleration.talcl

Source

generator.lisp (file)

Special Variable: *name-being-compiled*

Package

net.acceleration.talcl

Source

compile.lisp (file)

Special Variable: *rely-on-warnings-for-variables*

Package

net.acceleration.talcl

Source

compile.lisp (file)

Special Variable: *string-being-compiled*

Package

net.acceleration.talcl

Source

compile.lisp (file)

Special Variable: *tal-attribute-handlers*

Package

net.acceleration.talcl

Source

compile.lisp (file)

Special Variable: *tal-defs*

Package

net.acceleration.talcl

Source

compile.lisp (file)

Special Variable: *tal-env*

When calling a function with then environment, we progv the variables in This is a separate plist style binding of variables that can be accessed or used during debugging

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Special Variable: *tal-generator*

The generator to be used during compilation.

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Special Variable: *tal-tag-handlers*

Package

net.acceleration.talcl

Source

compile.lisp (file)

Special Variable: *tal-templates*

Package

net.acceleration.talcl

Source

generator.lisp (file)

Special Variable: *tal-truename*

The truename of the tal file being compiled.

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Special Variable: *talable-strings*

Whether or not to treat regular attributes and contents as talable strings.

Package

net.acceleration.talcl

Source

compile.lisp (file)

6.2.2 Macros

Macro: aif TEST THEN &optional ELSE

Just like IF-BIND but the var is always IT.

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Macro: awhen TEST &body BODY

Just like when expect the symbol IT will be bound to the result of TEST in BODY.

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Macro: if-bind VAR TEST &body THEN/ELSE

Anaphoric IF control structure.

VAR (a symbol) will be bound to the primary value of TEST. If TEST returns a true value then THEN will be executed, otherwise ELSE will be executed.

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Macro: rebinding BINDINGS &body BODY

Bind each var in BINDINGS to a gensym, bind the gensym to
var’s value via a let, return BODY’s value wrapped in this let.

Evaluates a series of forms in the lexical environment that is formed by adding the binding of each VAR to a fresh, uninterned symbol, and the binding of that fresh, uninterned symbol to VAR’s original value, i.e., its value in the current lexical environment.

The uninterned symbol is created as if by a call to GENSYM with the string denoted by PREFIX - or, if PREFIX is not supplied, the string denoted by VAR - as argument.

The forms are evaluated in order, and the values of all but the last are discarded (that is, the body is an implicit PROGN).

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Macro: when-bind VAR TEST &body BODY

Just like when except VAR will be bound to the result of TEST in BODY.

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Macro: with-input-from-file (STREAM-NAME FILE-NAME &rest ARGS &key DIRECTION EXTERNAL-FORMAT &allow-other-keys) &body BODY

Evaluate BODY with STREAM-NAME bound to an input-stream from file FILE-NAME. ARGS is passed directly to open.

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Macro: with-tal-compilation-unit PATHNAME &body BODY

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Macro: with-this-sink (SINK) &body BODY

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Macro: with-unique-names (&rest BINDINGS) &body BODY

Evaluate BODY with BINDINGS bound to fresh unique symbols.

Syntax: WITH-UNIQUE-NAMES ( [ var | (var x) ]* ) declaration* form*

Executes a series of forms with each VAR bound to a fresh, uninterned symbol. The uninterned symbol is as if returned by a call to GENSYM with the string denoted by X - or, if X is not supplied, the string denoted by VAR - as argument.

The variable bindings created are lexical unless special declarations are specified. The scopes of the name bindings and declarations do not include the Xs.

The forms are evaluated in order, and the values of all but the last are discarded (that is, the body is an implicit PROGN).

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

6.2.3 Compiler macros

Compiler Macro: %emit-tagged-content VALUE &optional ESCAPE

Package

net.acceleration.talcl

Source

handlers.lisp (file)

6.2.4 Functions

Function: $⎵tal⎵reader STREAM CHAR

The $ char reader for tal expressions.
This just tries to smooth over inconsistancies encountered by using $var-name in tal:foo attributes and regular foo attributes

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: %buffer-output-till-success BODY-FN

A function that buffers sax events in body till we are sure that body will execute completely and correctly. Mostly used while providing missing template values

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: %call-template-with-tal-environment TAL-FN ENV

This will call a template-fn with all the tal-environment variables bound into the lisp dynamic environment.

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Function: %eval TAG

Package

net.acceleration.talcl

Source

handlers.lisp (file)

Function: %get-tal-template-fn FILE-NAME GENERATOR &aux *LOG*

Package

net.acceleration.talcl

Source

generator.lisp (file)

Function: %in-common-lisp S

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: buffered-template-call TEMPLATE-FUNCTION ENV

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Function: call-lambda-with-default-missing-value LAMBDA

If you encounter an unbound template variable and we have a *default-missing-template-value*, invoke the set-value restart with that default

see also: call-lambda-with-default-missing-value which sets up the restart

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: call-lambda-with-unbound-variable-restarts LAMBDA

When you enconter an unbound variable while executing a template function, provide a restart to bind that variable so that the template can be executed

see also: call-lambda-with-default-missing-value
which will invoke this restart with *default-missing-template-value* if there is one

see also: with-missing-value-handler which shortcuts the rather tedious handler-bind for this into a bare minimum handler

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: compile-tal-parse-tree-to-lambda PARSE-TREE &optional EXPRESSION-PACKAGE TREE-OR-FORMS?

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: compile-tal-string-to-lambda STRING &key EXPRESSION-PACKAGE DECLARE-UNBOUND-VARIABLES-SPECIAL?

Returns the source code for the tal function form the tal text STRING.

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: content-as-is TAG

ATTRIBUTE-HANDLER:
Replaces the content of the tag with the evaluated value of the attribute. This tag does not escape the content.

Example:
<div tal:content-as-is=’$foo’ class=’jack’/>
Gets output as
<div class=’jack’>
|Whatever was in $foo|
</div>

Package

net.common-lisp.project.bese.tal.core

Source

handlers.lisp (file)

Function: copy-tal-template INSTANCE

Package

net.acceleration.talcl

Source

generator.lisp (file)

Function: describe-handler TAG

TAG-HANDLER: Describes (in an comment) the tag or attribute handler named by the attribute tal:name

Package

net.common-lisp.project.bese.tal.core

Source

handlers.lisp (file)

Function: describe-handlers TAG

TAG-HANDLER: Describes (in an comment), all tags and attribute handlers that are known (in *tal-attribute-handlers* or *tal-tag-handlers*)

Package

net.common-lisp.project.bese.tal.core

Source

handlers.lisp (file)

Function: dom-walk-helper TREE

Package

net.acceleration.talcl

Source

dom.lisp (file)

Function: dos-safe-read-line STREAM &optional EOF-ERROR-P EOF-VALUE RECURSIVE-P

readline that can read unix or dos lines

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Function: eliminate-..-in-path NAME

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Function: error-tal-expression-eof EXPRESSION &optional ERROR

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: find-expression-line/col-number EXPR

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: find-handler-named NAME

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: find-missing-template-variables LAMBDA-FORM &key RELY-ON-WARNINGS?

If you set rely-on-warnings, MAKE sure your warnings are correctly listed below

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: find-missing-template-variables-from-unbound-variable-errors LAMBDA-FORM

Find all the missing variables from their unbound-variable errors

loop compiling each time till we get no more of these errors each time we add a new key arg defaulting to a value from the base environment

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: find-missing-template-variables-from-warnings LAMBDA-FORM &aux UNBOUND-VARS

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: gather-attrib-forms ATTRIBUTES

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: intern-tal-string S

Package

net.acceleration.talcl

Source

handlers.lisp (file)

Function: let TAG

ATTRUBTE-HANDLER: Extend environment with a given list of bindings, as for LET* form.

Example:
<div tal:let=’foo 3’><div tal:content=’$foo’/></div>

Goes to: <div><div>3</div></div>

Package

net.common-lisp.project.bese.tal.core

Source

handlers.lisp (file)

Function: lisp TAG

TAG-HANDLER: evaluate the body of the tag as lisp code.

Package

net.common-lisp.project.bese.tal.core

Source

handlers.lisp (file)

Function: make-extended-xmls-builder &key INCLUDE-DEFAULT-VALUES INCLUDE-NAMESPACE-URI

Make a XMLS style builder. When ’include-namespace-uri is true a modified XMLS tree is generated that includes the element namespace URI rather than the qualified name prefix and also includes the namespace URI for attributes.

Package

net.acceleration.talcl

Source

sax-buffer.lisp (file)

Function: make-output-sink STREAM &key CANONICAL INDENTATION CHAR-P

Package

net.acceleration.talcl

Source

dom.lisp (file)

Function: make-tal-template &key (LAST-LOAD-TIME LAST-LOAD-TIME) (FILE-NAME FILE-NAME) (FUNCTION FUNCTION)

Package

net.acceleration.talcl

Source

generator.lisp (file)

Function: parse-tal-attribute-value VALUE-STRING

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: parse-tal-body-content VALUE-STRING

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: parse-talable-string VALUE-STRING

Parser a TAL attribute expression, returns a form for building the expression at run time.

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: plist-attrs TAG

Convert a plist returned from the value of this attribute into attributes on this tag.

Package

net.common-lisp.project.bese.tal.core

Source

handlers.lisp (file)

Function: print-env TAG

TAG-HANDLER: prints as a comment information about the tal-environment where this tag was encountered

Package

net.common-lisp.project.bese.tal.core

Source

handlers.lisp (file)

Function: print-handlers TAG

TAG-HANDLER: Lists (in a comment) the tag and attribute handlers that are currently registered.

Package

net.common-lisp.project.bese.tal.core

Source

handlers.lisp (file)

Function: read-string-from-file PATHNAME &key BUFFER-SIZE ELEMENT-TYPE EXTERNAL-FORMAT

Return the contents of PATHNAME as a fresh string.

The file specified by PATHNAME will be read one ELEMENT-TYPE element at a time, the EXTERNAL-FORMAT and ELEMENT-TYPEs must be compatible.

The EXTERNAL-FORMAT parameter will be passed to ENCODING-KEYWORD-TO-NATIVE, see ENCODING-KEYWORD-TO-NATIVE to possible values.

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Function: read-tal-file-into-string PATHNAME

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Function: specified-attribute* PREFIX LNAME VALUE &optional QNAME

A copy of cxml:attribute* that sets specified-p correctly
TODO: cxml:attribute* should probably set this by default or
accept it as an optional arg. Push this upstream

@arg[prefix]{Namespace prefix, a string.}
@arg[lname]{Local name, a string.}
@arg[value]{Any value understood by @fun{unparse-attribute}, in particular strings.}
@return{undocumented}

Collects an attribute for the start tag that is currently being written.

This function may only be called during the extent of a use of @fun{with-element} or @fun{with-element*}, and only before the first child node has been written.

An attribute for the current element is recorded using the namespace prefix and local name specified by arguments. @var{prefix} is resolved to a namespace URI using the bindings established by @fun{with-namespace}, and that namespace URI is used for the attribute.

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: starts-with SEQUENCE PREFIX &key TEST RETURN-SUFFIX

Test whether the first elements of SEQUENCE are the same (as per TEST) as the elements of PREFIX.

If RETURN-SUFFIX is T the functions returns, as a second value, a displaced array pointing to the sequence after PREFIX.

Package

net.acceleration.talcl

Source

tal-environment.lisp (file)

Function: tal-error MESSAGE &rest ARGS

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: tal-log MESSAGE &rest ARGS

Package

net.acceleration.talcl

Source

generator.lisp (file)

Function: tal-re-error C &optional MESSAGE &rest ARGS

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: tal-re-warn C &optional MESSAGE &rest ARGS

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: tal-runtime-error ORIGINAL-ERROR MESSAGE &rest ARGS

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: tal-template-p OBJECT

Package

net.acceleration.talcl

Source

generator.lisp (file)

Function: tal-template.file-name INSTANCE

Function: (setf tal-template.file-name) VALUE INSTANCE

Package

net.acceleration.talcl

Source

generator.lisp (file)

Function: tal-template.function INSTANCE

Function: (setf tal-template.function) VALUE INSTANCE

Package

net.acceleration.talcl

Source

generator.lisp (file)

Function: tal-template.last-load-time INSTANCE

Function: (setf tal-template.last-load-time) VALUE INSTANCE

Package

net.acceleration.talcl

Source

generator.lisp (file)

Function: tal-warn MESSAGE &rest ARGS

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: talable-strings TAG

Package

net.common-lisp.project.bese.tal.core

Source

handlers.lisp (file)

Function: transform-lxml-form-in-scope FORM

Creates a new scope (ie: for def) and processes a form inside it

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: transform-lxml-regular-tag TAG-NAME ATTRIBUTES BODY

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: transform-lxml-tree-in-scope TREE

Creates a new scope (ie: for def) and processes a tree of children inside it

Package

net.acceleration.talcl

Source

compile.lisp (file)

Function: unless TAG

ATTRIBUTE-HANDLER: Causes this tag to only appear when the evaluated value of the attribute is nil.

Package

net.common-lisp.project.bese.tal.core

Source

handlers.lisp (file)

Function: without-reader TAG

Package

net.common-lisp.project.bese.tal.core

Source

handlers.lisp (file)

6.2.5 Generic functions

Generic Function: %emit-tagged-content VALUE &optional ESCAPE

Package

net.acceleration.talcl

Source

handlers.lisp (file)

Methods

Method: %emit-tagged-content VALUE &optional ESCAPE

Generic Function: buffer OBJECT

Generic Function: (setf buffer) NEW-VALUE OBJECT

Package

net.acceleration.talcl

Methods

Method: buffer (BUFFERING-SINK buffering-sink)

Method: (setf buffer) NEW-VALUE (BUFFERING-SINK buffering-sink)

The events buffered so far

Source

sax-buffer.lisp (file)

Generic Function: buffering OBJECT

Generic Function: (setf buffering) NEW-VALUE OBJECT

Package

net.acceleration.talcl

Methods

Method: buffering (BUFFERING-SINK buffering-sink)

Method: (setf buffering) NEW-VALUE (BUFFERING-SINK buffering-sink)

Is this currently buffering

Source

sax-buffer.lisp (file)

Generic Function: cache OBJECT

Generic Function: (setf cache) NEW-VALUE OBJECT

Package

net.acceleration.talcl

Methods

Method: cache (CACHING-FILE-SYSTEM-GENERATOR caching-file-system-generator)

automatically generated reader method

Source

generator.lisp (file)

Method: (setf cache) NEW-VALUE (CACHING-FILE-SYSTEM-GENERATOR caching-file-system-generator)

automatically generated writer method

Source

generator.lisp (file)

Generic Function: clear-buffer SINK

Package

net.acceleration.talcl

Source

sax-buffer.lisp (file)

Methods

Method: clear-buffer (O buffering-sink)

Generic Function: flushing OBJECT

Generic Function: (setf flushing) NEW-VALUE OBJECT

Package

net.acceleration.talcl

Methods

Method: flushing (BUFFERING-SINK buffering-sink)

Method: (setf flushing) NEW-VALUE (BUFFERING-SINK buffering-sink)

Is this currently flushing

Source

sax-buffer.lisp (file)

Generic Function: format-args CONDITION

Generic Function: (setf format-args) NEW-VALUE CONDITION

Package

net.acceleration.talcl

Methods

Method: format-args (CONDITION tal-runtime-condition)

Method: (setf format-args) NEW-VALUE (CONDITION tal-runtime-condition)

Source

compile.lisp (file)

Method: format-args (CONDITION tal-compilation-condition)

Method: (setf format-args) NEW-VALUE (CONDITION tal-compilation-condition)

Source

compile.lisp (file)

Generic Function: format-control CONDITION

Generic Function: (setf format-control) NEW-VALUE CONDITION

Package

net.acceleration.talcl

Methods

Method: format-control (CONDITION tal-runtime-condition)

Method: (setf format-control) NEW-VALUE (CONDITION tal-runtime-condition)

Source

compile.lisp (file)

Method: format-control (CONDITION tal-compilation-condition)

Method: (setf format-control) NEW-VALUE (CONDITION tal-compilation-condition)

Source

compile.lisp (file)

Generic Function: log-fn OBJECT

Generic Function: (setf log-fn) NEW-VALUE OBJECT

Package

net.acceleration.talcl

Methods

Method: log-fn (TAL-GENERATOR tal-generator)

Method: (setf log-fn) NEW-VALUE (TAL-GENERATOR tal-generator)

A log-fn that accepts a string and writes it to the log

Source

generator.lisp (file)

Generic Function: ns-test OBJECT

Generic Function: (setf ns-test) NEW-VALUE OBJECT

Package

net.acceleration.talcl

Methods

Method: ns-test (INTERNER interner)

automatically generated reader method

Source

compile.lisp (file)

Method: (setf ns-test) NEW-VALUE (INTERNER interner)

automatically generated writer method

Source

compile.lisp (file)

Generic Function: original-condition CONDITION

Generic Function: (setf original-condition) NEW-VALUE CONDITION

Package

net.acceleration.talcl

Methods

Method: original-condition (CONDITION tal-compilation-condition)

Method: (setf original-condition) NEW-VALUE (CONDITION tal-compilation-condition)

Source

compile.lisp (file)

Generic Function: original-error CONDITION

Generic Function: (setf original-error) NEW-VALUE CONDITION

Package

net.acceleration.talcl

Methods

Method: original-error (CONDITION tal-runtime-condition)

Method: (setf original-error) NEW-VALUE (CONDITION tal-runtime-condition)

Source

compile.lisp (file)

Generic Function: start-buffering SINK

Package

net.acceleration.talcl

Source

sax-buffer.lisp (file)

Methods

Method: start-buffering (O buffering-sink)

Generic Function: stop-buffering-and-flush BUFFER &optional OUTPUT-SINK

Package

net.acceleration.talcl

Source

sax-buffer.lisp (file)

Methods

Method: stop-buffering-and-flush (O buffering-sink) &optional OUTPUT-SINK

Generic Function: template CONDITION

Generic Function: (setf template) NEW-VALUE CONDITION

Package

net.acceleration.talcl

Methods

Method: template (CONDITION tal-runtime-condition)

Method: (setf template) NEW-VALUE (CONDITION tal-runtime-condition)

Source

compile.lisp (file)

Method: template (CONDITION tal-compilation-condition)

Method: (setf template) NEW-VALUE (CONDITION tal-compilation-condition)

Source

compile.lisp (file)

Generic Function: uri-to-package OBJECT

Generic Function: (setf uri-to-package) NEW-VALUE OBJECT

Package

net.acceleration.talcl

Methods

Method: uri-to-package (INTERNER interner)

automatically generated reader method

Source

compile.lisp (file)

Method: (setf uri-to-package) NEW-VALUE (INTERNER interner)

automatically generated writer method

Source

compile.lisp (file)

6.2.6 Conditions

Condition: tal-compilation-condition ()

Package

net.acceleration.talcl

Source

compile.lisp (file)

Direct superclasses

simple-condition (condition)

Direct subclasses

• tal-compilation-warning (condition)
• tal-compilation-error (condition)

Direct methods

• template (method)
• template (method)
• original-condition (method)
• original-condition (method)
• format-args (method)
• format-args (method)
• format-control (method)
• format-control (method)

Direct slots

Slot: format-control

Initargs

:format-control

Initform

(quote nil)

Readers

format-control (generic function)

Writers

(setf format-control) (generic function)

Slot: format-args

Initargs

:format-args

Initform

(quote nil)

Readers

format-args (generic function)

Writers

(setf format-args) (generic function)

Slot: original-condition

Initargs

:original-condition

Initform

(quote nil)

Readers

original-condition (generic function)

Writers

(setf original-condition) (generic function)

Slot: template

Initargs

:template

Initform

(quote net.acceleration.talcl::*name-being-compiled*)

Readers

template (generic function)

Writers

(setf template) (generic function)

Condition: tal-compilation-error ()

Package

net.acceleration.talcl

Source

compile.lisp (file)

Direct superclasses

• error (condition)
• tal-compilation-condition (condition)

Direct subclasses

tal-unexpected-eof-compilation-error (condition)

Condition: tal-compilation-warning ()

Package

net.acceleration.talcl

Source

compile.lisp (file)

Direct superclasses

• warning (condition)
• tal-compilation-condition (condition)

Condition: tal-runtime-error ()

Package

net.acceleration.talcl

Source

compile.lisp (file)

Direct superclasses

• error (condition)
• tal-runtime-condition (condition)

Condition: tal-unexpected-eof-compilation-error ()

Package

net.acceleration.talcl

Source

compile.lisp (file)

Direct superclasses

• error (condition)
• tal-compilation-error (condition)

6.2.7 Structures

Structure: tal-template ()

Package

net.acceleration.talcl

Source

generator.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: last-load-time

Readers

tal-template.last-load-time (function)

Writers

(setf tal-template.last-load-time) (function)

Slot: file-name

Readers

tal-template.file-name (function)

Writers

(setf tal-template.file-name) (function)

Slot: function

Readers

tal-template.function (function)

Writers

(setf tal-template.function) (function)

6.2.8 Classes

Class: buffering-sink ()

Package

net.acceleration.talcl

Source

sax-buffer.lisp (file)

Direct superclasses

broadcast-handler (class)

Direct methods

• dtd (method)
• entity-resolver (method)
• attribute-declaration (method)
• element-declaration (method)
• notation-declaration (method)
• internal-entity-declaration (method)
• external-entity-declaration (method)
• unparsed-entity-declaration (method)
• end-internal-subset (method)
• start-internal-subset (method)
• end-dtd (method)
• start-dtd (method)
• end-cdata (method)
• start-cdata (method)
• comment (method)
• end-document (method)
• end-element (method)
• end-prefix-mapping (method)
• processing-instruction (method)
• unescaped (method)
• characters (method)
• start-prefix-mapping (method)
• start-element (method)
• start-document (method)
• clear-buffer (method)
• stop-buffering-and-flush (method)
• start-buffering (method)
• buffer (method)
• buffer (method)
• flushing (method)
• flushing (method)
• buffering (method)
• buffering (method)

Direct slots

Slot: buffering

Is this currently buffering

Initargs

:buffering

Readers

buffering (generic function)

Writers

(setf buffering) (generic function)

Slot: flushing

Is this currently flushing

Initargs

:flushing

Readers

flushing (generic function)

Writers

(setf flushing) (generic function)

Slot: buffer

The events buffered so far

Initargs

:buffer

Readers

buffer (generic function)

Writers

(setf buffer) (generic function)

Class: extended-xmls-builder ()

an xmls builder that includes comments as (:comment () comment-text) nodes

Package

net.acceleration.talcl

Source

sax-buffer.lisp (file)

Direct superclasses

xmls-builder (class)

Direct methods

comment (method)

Class: interner ()

Package

net.acceleration.talcl

Source

compile.lisp (file)

Direct superclasses

broadcast-handler (class)

Direct methods

• start-element (method)
• ns-test (method)
• ns-test (method)
• uri-to-package (method)
• uri-to-package (method)

Direct slots

Slot: uri-to-package

Initargs

:uri-to-package

Readers

uri-to-package (generic function)

Writers

(setf uri-to-package) (generic function)

Slot: ns-test

Initargs

:ns-test

Initform

(function string=)

Readers

ns-test (generic function)

Writers

(setf ns-test) (generic function)

Class: template-node ()

Package

net.acceleration.talcl

Source

dom.lisp (file)

Direct superclasses

processing-instruction (class)

Direct methods

• node-name (method)
• node-name (method)

Direct slots

Slot: node-name

Initargs

:node-name

Initform

"template-node"

Readers

node-name (generic function)

Writers

(setf node-name) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions