Text.Ginger.AST

Implements Ginger's Abstract Syntax Tree.

Documentation

type VarName = Text

A context variable name.

data Template

Top-level data structure, representing a fully parsed template.

Constructors

Template

Fields

• templateBody :: Statement
• templateBlocks :: HashMap VarName Block
• templateParent :: Maybe Template

Instances

Show Template

Methods

showsPrec :: Int -> Template -> ShowS

show :: Template -> String

showList :: [Template] -> ShowS

Optimizable Template

Methods

optimize :: Template -> Template

data Macro

A macro definition ( {% macro %} )

Constructors

Macro

Fields

• macroArgs :: [VarName]
• macroBody :: Statement

Instances

Show Macro

Methods

showsPrec :: Int -> Macro -> ShowS

show :: Macro -> String

showList :: [Macro] -> ShowS

Optimizable Macro

Methods

optimize :: Macro -> Macro

data Block

A block definition ( {% block %} )

Constructors

Block

Fields

• blockBody :: Statement

Instances

Show Block

Methods

showsPrec :: Int -> Block -> ShowS

show :: Block -> String

showList :: [Block] -> ShowS

Optimizable Block

Methods

optimize :: Block -> Block

data Statement

Ginger statements.

Constructors

MultiS [Statement]

A sequence of multiple statements

ScopedS Statement

Run wrapped statement in a local scope

IndentS Expression Statement

Establish an indented context around the wrapped statement

LiteralS Html

Literal output (anything outside of any tag)

InterpolationS Expression

{{ expression }}

ExpressionS Expression

Evaluate expression

IfS Expression Statement Statement

{% if expression %}statement{% else %}statement{% endif %}

SwitchS Expression [(Expression, Statement)] Statement

{% switch expression %}{% case expression %}statement{% endcase %}...{% default %}statement{% enddefault %}{% endswitch %}

ForS (Maybe VarName) VarName Expression Statement

{% for index, varname in expression %}statement{% endfor %}

SetVarS VarName Expression

{% set varname = expr %}

DefMacroS VarName Macro

{% macro varname %}statements{% endmacro %}

BlockRefS VarName

PreprocessedIncludeS Template

{% include "template" %}

NullS

The do-nothing statement (NOP)

Instances

Show Statement

Methods

showsPrec :: Int -> Statement -> ShowS

show :: Statement -> String

showList :: [Statement] -> ShowS

Optimizable Statement

Methods

optimize :: Statement -> Statement

data Expression

Expressions, building blocks for the expression minilanguage.

Constructors

StringLiteralE Text

String literal expression: "foobar"

NumberLiteralE Scientific

Numeric literal expression: 123.4

BoolLiteralE Bool

Boolean literal expression: true

NullLiteralE

Literal null

VarE VarName

Variable reference: foobar

ListE [Expression]

List construct: [ expr, expr, expr ]

ObjectE [(Expression, Expression)]

Object construct: { expr: expr, expr: expr, ... }

MemberLookupE Expression Expression

foo[bar] (also dot access)

CallE Expression [(Maybe Text, Expression)]

foo(bar=baz, quux)

LambdaE [Text] Expression

(foo, bar) -> expr

TernaryE Expression Expression Expression

expr ? expr : expr

DoE Statement

do { statement; }

Instances

Show Expression

Methods

showsPrec :: Int -> Expression -> ShowS

show :: Expression -> String

showList :: [Expression] -> ShowS

Optimizable Expression

Methods

optimize :: Expression -> Expression