Module

tuck/lexer

src/tuck/lexer.pooka

Reading a template is mostly waiting for a curly brace.

The lexer walks the source one character at a time. Outside tags it collects plain text; inside {{ … }} and {% … %} it reads names, strings, numbers and symbols. {# … #} comments disappear, and {% raw %} … {% endraw %} becomes text exactly as written.

A - just inside a delimiter, as in {%- or -}}, trims the whitespace on that side of the tag, so a template can stay readable without scattering blank lines through its output.

API reference

class

Token

src/tuck/lexer.pooka:23
class Token

One piece of a template.

class

Text

src/tuck/lexer.pooka:26
class Text(value: String) is Token

Text outside any tag, printed as it is.

field

value

src/tuck/lexer.pooka:26
value: String
INFERREDString
constructor

new

src/tuck/lexer.pooka:26
INFERREDfn(String) -> tuck/lexer.Text
class

OpenPrint

src/tuck/lexer.pooka:29
class OpenPrint(trim: Bool) is Token

{{, or {{- when trim is set.

field

trim

src/tuck/lexer.pooka:29
trim: Bool
INFERREDBool
constructor

new

src/tuck/lexer.pooka:29
INFERREDfn(Bool) -> tuck/lexer.OpenPrint
class

ClosePrint

src/tuck/lexer.pooka:32
class ClosePrint(trim: Bool) is Token

}}, or -}} when trim is set.

field

trim

src/tuck/lexer.pooka:32
trim: Bool
INFERREDBool
constructor

new

src/tuck/lexer.pooka:32
INFERREDfn(Bool) -> tuck/lexer.ClosePrint
class

OpenTag

src/tuck/lexer.pooka:35
class OpenTag(trim: Bool) is Token

{%, or {%- when trim is set.

field

trim

src/tuck/lexer.pooka:35
trim: Bool
INFERREDBool
constructor

new

src/tuck/lexer.pooka:35
INFERREDfn(Bool) -> tuck/lexer.OpenTag
class

CloseTag

src/tuck/lexer.pooka:38
class CloseTag(trim: Bool) is Token

%}, or -%} when trim is set.

field

trim

src/tuck/lexer.pooka:38
trim: Bool
INFERREDBool
constructor

new

src/tuck/lexer.pooka:38
INFERREDfn(Bool) -> tuck/lexer.CloseTag
class

Name

src/tuck/lexer.pooka:41
class Name(value: String) is Token

A name, such as user, if or upper.

field

value

src/tuck/lexer.pooka:41
value: String
INFERREDString
constructor

new

src/tuck/lexer.pooka:41
INFERREDfn(String) -> tuck/lexer.Name
class

Str

src/tuck/lexer.pooka:44
class Str(value: String) is Token

A quoted string, with its escapes already read.

field

value

src/tuck/lexer.pooka:44
value: String
INFERREDString
constructor

new

src/tuck/lexer.pooka:44
INFERREDfn(String) -> tuck/lexer.Str
class

Integer

src/tuck/lexer.pooka:47
class Integer(value: Int) is Token

A whole number.

field

value

src/tuck/lexer.pooka:47
value: Int
INFERREDInt
constructor

new

src/tuck/lexer.pooka:47
INFERREDfn(Int) -> tuck/lexer.Integer
class

Decimal

src/tuck/lexer.pooka:50
class Decimal(value: Float) is Token

A number with a decimal point.

field

value

src/tuck/lexer.pooka:50
value: Float
INFERREDFloat
constructor

new

src/tuck/lexer.pooka:50
INFERREDfn(Float) -> tuck/lexer.Decimal
class

Symbol

src/tuck/lexer.pooka:54
class Symbol(value: String) is Token

Punctuation and operators: . , | ( ) [ ] = == != < <= > >=.

field

value

src/tuck/lexer.pooka:54
value: String
INFERREDString
constructor

new

src/tuck/lexer.pooka:54
INFERREDfn(String) -> tuck/lexer.Symbol
class

Lexeme

src/tuck/lexer.pooka:57
class Lexeme(token: Token, at: Pos)

A token and where it starts.

field

token

src/tuck/lexer.pooka:57
token: Token
field

at

src/tuck/lexer.pooka:57
at: Pos
constructor

new

src/tuck/lexer.pooka:57
function

lex

src/tuck/lexer.pooka:67
lex(template: String, source: String) -> Result(List(Lexeme), TuckError)
INFERREDfn(String, String) -> Result(List(tuck/lexer.Lexeme), tuck/error.TuckError)

Read a template into lexemes, or say where it stops making sense.

Pooka
import tuck/lexer

let assert Ok(lexemes) = lexer.lex("page", "Hi {{ name }}")
assert list.length(lexemes) == 4