Module

tuck/ast

src/tuck/ast.pooka

A template, understood: the shape the parser builds and the renderer walks.

A template is a list of nodes: text, values to print, and the tags that choose, repeat or borrow other templates. Inside tags live expressions: names, paths into them, literals, comparisons and filters.

API reference

class

Expr

src/tuck/ast.pooka:16
class Expr

A value to compute.

class

Literal

src/tuck/ast.pooka:20
class Literal(value: Json) is Expr

A value written in the template: a string, a number, true, false or nil.

field

value

src/tuck/ast.pooka:20
value: Json
INFERRED$package/pooka_json/pooka/json.Json
constructor

new

src/tuck/ast.pooka:20
INFERREDfn($package/pooka_json/pooka/json.Json) -> tuck/ast.Literal
class

Variable

src/tuck/ast.pooka:23
class Variable(name: String, at: Pos) is Expr

A name looked up in the data, or a loop variable: user.

field

name

src/tuck/ast.pooka:23
name: String
INFERREDString
field

at

src/tuck/ast.pooka:23
at: Pos
constructor

new

src/tuck/ast.pooka:23
INFERREDfn(String, tuck/error.Pos) -> tuck/ast.Variable
class

Field

src/tuck/ast.pooka:26
class Field(target: Expr, name: String, at: Pos) is Expr

A field of an object: user.name.

field

target

src/tuck/ast.pooka:26
target: Expr
field

name

src/tuck/ast.pooka:26
name: String
INFERREDString
field

at

src/tuck/ast.pooka:26
at: Pos
constructor

new

src/tuck/ast.pooka:26
class

Item

src/tuck/ast.pooka:29
class Item(target: Expr, key: Expr, at: Pos) is Expr

A list position or an object key: posts[0], scores["ada"].

field

target

src/tuck/ast.pooka:29
target: Expr
field

key

src/tuck/ast.pooka:29
key: Expr
field

at

src/tuck/ast.pooka:29
at: Pos
constructor

new

src/tuck/ast.pooka:29
class

Filtered

src/tuck/ast.pooka:32
class Filtered(target: Expr, name: String, arguments: List(Expr), at: Pos) is Expr

A value passed through a filter: name | upper, items | join(", ").

field

target

src/tuck/ast.pooka:32
target: Expr
field

name

src/tuck/ast.pooka:32
name: String
INFERREDString
field

arguments

src/tuck/ast.pooka:32
arguments: List(Expr)
INFERREDList(tuck/ast.Expr)
field

at

src/tuck/ast.pooka:32
at: Pos
constructor

new

src/tuck/ast.pooka:32
class

Negated

src/tuck/ast.pooka:35
class Negated(operand: Expr) is Expr

not value

field

operand

src/tuck/ast.pooka:35
operand: Expr
constructor

new

src/tuck/ast.pooka:35
class

Both

src/tuck/ast.pooka:38
class Both(left: Expr, right: Expr) is Expr

left and right

field

left

src/tuck/ast.pooka:38
left: Expr
field

right

src/tuck/ast.pooka:38
right: Expr
constructor

new

src/tuck/ast.pooka:38
class

Either

src/tuck/ast.pooka:41
class Either(left: Expr, right: Expr) is Expr

left or right

field

left

src/tuck/ast.pooka:41
left: Expr
field

right

src/tuck/ast.pooka:41
right: Expr
constructor

new

src/tuck/ast.pooka:41
class

Compared

src/tuck/ast.pooka:44
class Compared(operator: String, left: Expr, right: Expr, at: Pos) is Expr

==, !=, <, <=, >, >= or in.

field

operator

src/tuck/ast.pooka:44
operator: String
INFERREDString
field

left

src/tuck/ast.pooka:44
left: Expr
field

right

src/tuck/ast.pooka:44
right: Expr
field

at

src/tuck/ast.pooka:44
at: Pos
constructor

new

src/tuck/ast.pooka:44
class

Node

src/tuck/ast.pooka:47
class Node

A part of a template.

class

Text

src/tuck/ast.pooka:50
class Text(value: String) is Node

Text, printed as it is.

field

value

src/tuck/ast.pooka:50
value: String
INFERREDString
constructor

new

src/tuck/ast.pooka:50
INFERREDfn(String) -> tuck/ast.Text
class

Print

src/tuck/ast.pooka:53
class Print(value: Expr, at: Pos) is Node

{{ value }}

field

value

src/tuck/ast.pooka:53
value: Expr
field

at

src/tuck/ast.pooka:53
at: Pos
constructor

new

src/tuck/ast.pooka:53
class

Branches

src/tuck/ast.pooka:56
class Branches(choices: List(#(Expr, List(Node))), otherwise: List(Node)) is Node

{% if %}, any {% elif %}s, and an optional {% else %}.

field

choices

src/tuck/ast.pooka:56
choices: List(#(Expr, List(Node)))
INFERREDList(#(tuck/ast.Expr, List(tuck/ast.Node)))
field

otherwise

src/tuck/ast.pooka:56
otherwise: List(Node)
INFERREDList(tuck/ast.Node)
constructor

new

src/tuck/ast.pooka:56
INFERREDfn(List(#(tuck/ast.Expr, List(tuck/ast.Node))), List(tuck/ast.Node)) -> tuck/ast.Branches
class

Loop

src/tuck/ast.pooka:60
class Loop(
  key: Option(String),
  name: String,
  items: Expr,
  body: List(Node),
  empty: List(Node),
  at: Pos
) is Node

{% for name in items %} or {% for key, name in object %}, with an optional {% else %} for when there is nothing to repeat.

field

key

src/tuck/ast.pooka:61
key: Option(String)
INFERREDOption(String)
field

name

src/tuck/ast.pooka:62
name: String
INFERREDString
field

items

src/tuck/ast.pooka:63
items: Expr
field

body

src/tuck/ast.pooka:64
body: List(Node)
INFERREDList(tuck/ast.Node)
field

empty

src/tuck/ast.pooka:65
empty: List(Node)
INFERREDList(tuck/ast.Node)
field

at

src/tuck/ast.pooka:66
at: Pos
constructor

new

src/tuck/ast.pooka:61
INFERREDfn(Option(String), String, tuck/ast.Expr, List(tuck/ast.Node), List(tuck/ast.Node), tuck/error.Pos) -> tuck/ast.Loop
class

Include

src/tuck/ast.pooka:70
class Include(
  name: String,
  bindings: List(#(String, Expr)),
  only: Bool,
  at: Pos
) is Node

{% include "name" %}

field

name

src/tuck/ast.pooka:71
name: String
INFERREDString
field

bindings

src/tuck/ast.pooka:72
bindings: List(#(String, Expr))
INFERREDList(#(String, tuck/ast.Expr))
field

only

src/tuck/ast.pooka:73
only: Bool
INFERREDBool
field

at

src/tuck/ast.pooka:74
at: Pos
constructor

new

src/tuck/ast.pooka:71
INFERREDfn(String, List(#(String, tuck/ast.Expr)), Bool, tuck/error.Pos) -> tuck/ast.Include
class

Block

src/tuck/ast.pooka:78
class Block(name: String, body: List(Node), at: Pos) is Node

{% block name %} … {% endblock %}

field

name

src/tuck/ast.pooka:78
name: String
INFERREDString
field

body

src/tuck/ast.pooka:78
body: List(Node)
INFERREDList(tuck/ast.Node)
field

at

src/tuck/ast.pooka:78
at: Pos
constructor

new

src/tuck/ast.pooka:78
INFERREDfn(String, List(tuck/ast.Node), tuck/error.Pos) -> tuck/ast.Block
class

Extends

src/tuck/ast.pooka:82
class Extends(name: String, at: Pos) is Node

{% extends "name" %} while it is being read. A finished Document holds it as extends instead.

field

name

src/tuck/ast.pooka:82
name: String
INFERREDString
field

at

src/tuck/ast.pooka:82
at: Pos
constructor

new

src/tuck/ast.pooka:82
INFERREDfn(String, tuck/error.Pos) -> tuck/ast.Extends
class

Document

src/tuck/ast.pooka:85
class Document(extends: Option(#(String, Pos)), nodes: List(Node))

A whole template: the template it extends, if any, and its nodes.

field

extends

src/tuck/ast.pooka:85
extends: Option(#(String, Pos))
INFERREDOption(#(String, tuck/error.Pos))
field

nodes

src/tuck/ast.pooka:85
nodes: List(Node)
INFERREDList(tuck/ast.Node)
constructor

new

src/tuck/ast.pooka:85
INFERREDfn(Option(#(String, tuck/error.Pos)), List(tuck/ast.Node)) -> tuck/ast.Document
class

Call

src/tuck/ast.pooka:88
class Call(name: String, arguments: List(Expr), at: Pos) is Expr

An explicit registered call, including a dotted namespace such as time.now.

field

name

src/tuck/ast.pooka:88
name: String
INFERREDString
field

arguments

src/tuck/ast.pooka:88
arguments: List(Expr)
INFERREDList(tuck/ast.Expr)
field

at

src/tuck/ast.pooka:88
at: Pos
constructor

new

src/tuck/ast.pooka:88
INFERREDfn(String, List(tuck/ast.Expr), tuck/error.Pos) -> tuck/ast.Call
class

Set

src/tuck/ast.pooka:91
class Set(name: String, value: Expr, at: Pos) is Node

Bind a name for following nodes in the current lexical scope.

field

name

src/tuck/ast.pooka:91
name: String
INFERREDString
field

value

src/tuck/ast.pooka:91
value: Expr
field

at

src/tuck/ast.pooka:91
at: Pos
constructor

new

src/tuck/ast.pooka:91
INFERREDfn(String, tuck/ast.Expr, tuck/error.Pos) -> tuck/ast.Set
class

With

src/tuck/ast.pooka:94
class With(bindings: List(#(String, Expr)), body: List(Node), at: Pos) is Node

A lexical scope whose bindings are evaluated in the enclosing scope.

field

bindings

src/tuck/ast.pooka:94
bindings: List(#(String, Expr))
INFERREDList(#(String, tuck/ast.Expr))
field

body

src/tuck/ast.pooka:94
body: List(Node)
INFERREDList(tuck/ast.Node)
field

at

src/tuck/ast.pooka:94
at: Pos
constructor

new

src/tuck/ast.pooka:94
INFERREDfn(List(#(String, tuck/ast.Expr)), List(tuck/ast.Node), tuck/error.Pos) -> tuck/ast.With