package parse

import "text/template/parse"

Package parse builds parse trees for templates as defined by text/template and html/template. Clients should use those packages to construct templates rather than this one, which provides shared internal data structures not intended for general use.

Index

Package Files

lex.go node.go parse.go

func IsEmptyTree Uses

❖
func IsEmptyTree(n Node) bool

IsEmptyTree reports whether this tree (node) is empty of everything but space.

func Parse Uses

❖
func Parse(name, text, leftDelim, rightDelim string, funcs ...map[string]interface{}) (map[string]*Tree, error)

Parse returns a map from template name to parse.Tree, created by parsing the templates described in the argument string. The top-level template will be given the specified name. If an error is encountered, parsing stops and an empty map is returned with the error.

type ActionNode Uses

❖
type ActionNode struct {
    NodeType
    Pos

    Line int       // The line number in the input. Deprecated: Kept for compatibility.
    Pipe *PipeNode // The pipeline in the action.
    // contains filtered or unexported fields
}

ActionNode holds an action (something bounded by delimiters). Control actions have their own nodes; ActionNode represents simple ones such as field evaluations and parenthesized pipelines.

func (*ActionNode) Copy Uses

❖
func (a *ActionNode) Copy() Node

func (*ActionNode) String Uses

❖
func (a *ActionNode) String() string

type BoolNode Uses

❖
type BoolNode struct {
    NodeType
    Pos

    True bool // The value of the boolean constant.
    // contains filtered or unexported fields
}

BoolNode holds a boolean constant.

func (*BoolNode) Copy Uses

❖
func (b *BoolNode) Copy() Node

func (*BoolNode) String Uses

❖
func (b *BoolNode) String() string

type BranchNode Uses

❖
type BranchNode struct {
    NodeType
    Pos

    Line     int       // The line number in the input. Deprecated: Kept for compatibility.
    Pipe     *PipeNode // The pipeline to be evaluated.
    List     *ListNode // What to execute if the value is non-empty.
    ElseList *ListNode // What to execute if the value is empty (nil if absent).
    // contains filtered or unexported fields
}

BranchNode is the common representation of if, range, and with.

func (*BranchNode) Copy Uses

❖
func (b *BranchNode) Copy() Node

func (*BranchNode) String Uses

❖
func (b *BranchNode) String() string

type ChainNode Uses

❖
type ChainNode struct {
    NodeType
    Pos

    Node  Node
    Field []string // The identifiers in lexical order.
    // contains filtered or unexported fields
}

ChainNode holds a term followed by a chain of field accesses (identifier starting with '.'). The names may be chained ('.x.y'). The periods are dropped from each ident.

func (*ChainNode) Add Uses

❖
func (c *ChainNode) Add(field string)

Add adds the named field (which should start with a period) to the end of the chain.

func (*ChainNode) Copy Uses

❖
func (c *ChainNode) Copy() Node

func (*ChainNode) String Uses

❖
func (c *ChainNode) String() string

type CommandNode Uses

❖
type CommandNode struct {
    NodeType
    Pos

    Args []Node // Arguments in lexical order: Identifier, field, or constant.
    // contains filtered or unexported fields
}

CommandNode holds a command (a pipeline inside an evaluating action).

func (*CommandNode) Copy Uses

❖
func (c *CommandNode) Copy() Node

func (*CommandNode) String Uses

❖
func (c *CommandNode) String() string

type DotNode Uses

❖
type DotNode struct {
    NodeType
    Pos
    // contains filtered or unexported fields
}

DotNode holds the special identifier '.'.

func (*DotNode) Copy Uses

❖
func (d *DotNode) Copy() Node

func (*DotNode) String Uses

❖
func (d *DotNode) String() string

func (*DotNode) Type Uses

❖
func (d *DotNode) Type() NodeType

type FieldNode Uses

❖
type FieldNode struct {
    NodeType
    Pos

    Ident []string // The identifiers in lexical order.
    // contains filtered or unexported fields
}

FieldNode holds a field (identifier starting with '.'). The names may be chained ('.x.y'). The period is dropped from each ident.

func (*FieldNode) Copy Uses

❖
func (f *FieldNode) Copy() Node

func (*FieldNode) String Uses

❖
func (f *FieldNode) String() string

type IdentifierNode Uses

❖
type IdentifierNode struct {
    NodeType
    Pos

    Ident string // The identifier's name.
    // contains filtered or unexported fields
}

IdentifierNode holds an identifier.

func NewIdentifier Uses

❖
func NewIdentifier(ident string) *IdentifierNode

NewIdentifier returns a new IdentifierNode with the given identifier name.

func (*IdentifierNode) Copy Uses

❖
func (i *IdentifierNode) Copy() Node

func (*IdentifierNode) SetPos Uses

❖
func (i *IdentifierNode) SetPos(pos Pos) *IdentifierNode

SetPos sets the position. NewIdentifier is a public method so we can't modify its signature. Chained for convenience. TODO: fix one day?

func (*IdentifierNode) SetTree Uses

❖
func (i *IdentifierNode) SetTree(t *Tree) *IdentifierNode

SetTree sets the parent tree for the node. NewIdentifier is a public method so we can't modify its signature. Chained for convenience. TODO: fix one day?

func (*IdentifierNode) String Uses

❖
func (i *IdentifierNode) String() string

type IfNode Uses

❖
type IfNode struct {
    BranchNode
}

IfNode represents an {{if}} action and its commands.

func (*IfNode) Copy Uses

❖
func (i *IfNode) Copy() Node

type ListNode Uses

❖
type ListNode struct {
    NodeType
    Pos

    Nodes []Node // The element nodes in lexical order.
    // contains filtered or unexported fields
}

ListNode holds a sequence of nodes.

func (*ListNode) Copy Uses

❖
func (l *ListNode) Copy() Node

func (*ListNode) CopyList Uses

❖
func (l *ListNode) CopyList() *ListNode

func (*ListNode) String Uses

❖
func (l *ListNode) String() string

type NilNode Uses

❖
type NilNode struct {
    NodeType
    Pos
    // contains filtered or unexported fields
}

NilNode holds the special identifier 'nil' representing an untyped nil constant.

func (*NilNode) Copy Uses

❖
func (n *NilNode) Copy() Node

func (*NilNode) String Uses

❖
func (n *NilNode) String() string

func (*NilNode) Type Uses

❖
func (n *NilNode) Type() NodeType

type Node Uses

❖
type Node interface {
    Type() NodeType
    String() string
    // Copy does a deep copy of the Node and all its components.
    // To avoid type assertions, some XxxNodes also have specialized
    // CopyXxx methods that return *XxxNode.
    Copy() Node
    Position() Pos // byte position of start of node in full original input string
    // contains filtered or unexported methods
}

A Node is an element in the parse tree. The interface is trivial. The interface contains an unexported method so that only types local to this package can satisfy it.

type NodeType Uses

❖
type NodeType int

NodeType identifies the type of a parse tree node.

❖
const (
    NodeText    NodeType = iota // Plain text.
    NodeAction                  // A non-control action such as a field evaluation.
    NodeBool                    // A boolean constant.
    NodeChain                   // A sequence of field accesses.
    NodeCommand                 // An element of a pipeline.
    NodeDot                     // The cursor, dot.

    NodeField      // A field or method name.
    NodeIdentifier // An identifier; always a function name.
    NodeIf         // An if action.
    NodeList       // A list of Nodes.
    NodeNil        // An untyped nil constant.
    NodeNumber     // A numerical constant.
    NodePipe       // A pipeline of commands.
    NodeRange      // A range action.
    NodeString     // A string constant.
    NodeTemplate   // A template invocation action.
    NodeVariable   // A $ variable.
    NodeWith       // A with action.
)

func (NodeType) Type Uses

❖
func (t NodeType) Type() NodeType

Type returns itself and provides an easy default implementation for embedding in a Node. Embedded in all non-trivial Nodes.

type NumberNode Uses

❖
type NumberNode struct {
    NodeType
    Pos

    IsInt      bool       // Number has an integral value.
    IsUint     bool       // Number has an unsigned integral value.
    IsFloat    bool       // Number has a floating-point value.
    IsComplex  bool       // Number is complex.
    Int64      int64      // The signed integer value.
    Uint64     uint64     // The unsigned integer value.
    Float64    float64    // The floating-point value.
    Complex128 complex128 // The complex value.
    Text       string     // The original textual representation from the input.
    // contains filtered or unexported fields
}

NumberNode holds a number: signed or unsigned integer, float, or complex. The value is parsed and stored under all the types that can represent the value. This simulates in a small amount of code the behavior of Go's ideal constants.

func (*NumberNode) Copy Uses

❖
func (n *NumberNode) Copy() Node

func (*NumberNode) String Uses

❖
func (n *NumberNode) String() string

type PipeNode Uses

❖
type PipeNode struct {
    NodeType
    Pos

    Line int             // The line number in the input. Deprecated: Kept for compatibility.
    Decl []*VariableNode // Variable declarations in lexical order.
    Cmds []*CommandNode  // The commands in lexical order.
    // contains filtered or unexported fields
}

PipeNode holds a pipeline with optional declaration

func (*PipeNode) Copy Uses

❖
func (p *PipeNode) Copy() Node

func (*PipeNode) CopyPipe Uses

❖
func (p *PipeNode) CopyPipe() *PipeNode

func (*PipeNode) String Uses

❖
func (p *PipeNode) String() string

type Pos Uses

❖
type Pos int

Pos represents a byte position in the original input text from which this template was parsed.

func (Pos) Position Uses

❖
func (p Pos) Position() Pos

type RangeNode Uses

❖
type RangeNode struct {
    BranchNode
}

RangeNode represents a {{range}} action and its commands.

func (*RangeNode) Copy Uses

❖
func (r *RangeNode) Copy() Node

type StringNode Uses

❖
type StringNode struct {
    NodeType
    Pos

    Quoted string // The original text of the string, with quotes.
    Text   string // The string, after quote processing.
    // contains filtered or unexported fields
}

StringNode holds a string constant. The value has been "unquoted".

func (*StringNode) Copy Uses

❖
func (s *StringNode) Copy() Node

func (*StringNode) String Uses

❖
func (s *StringNode) String() string

type TemplateNode Uses

❖
type TemplateNode struct {
    NodeType
    Pos

    Line int       // The line number in the input. Deprecated: Kept for compatibility.
    Name string    // The name of the template (unquoted).
    Pipe *PipeNode // The command to evaluate as dot for the template.
    // contains filtered or unexported fields
}

TemplateNode represents a {{template}} action.

func (*TemplateNode) Copy Uses

❖
func (t *TemplateNode) Copy() Node

func (*TemplateNode) String Uses

❖
func (t *TemplateNode) String() string

type TextNode Uses

❖
type TextNode struct {
    NodeType
    Pos

    Text []byte // The text; may span newlines.
    // contains filtered or unexported fields
}

TextNode holds plain text.

func (*TextNode) Copy Uses

❖
func (t *TextNode) Copy() Node

func (*TextNode) String Uses

❖
func (t *TextNode) String() string

type Tree Uses

❖
type Tree struct {
    Name      string    // name of the template represented by the tree.
    ParseName string    // name of the top-level template during parsing, for error messages.
    Root      *ListNode // top-level root of the tree.
    // contains filtered or unexported fields
}

Tree is the representation of a single parsed template.

func New Uses

❖
func New(name string, funcs ...map[string]interface{}) *Tree

New allocates a new parse tree with the given name.

func (*Tree) Copy Uses

❖
func (t *Tree) Copy() *Tree

Copy returns a copy of the Tree. Any parsing state is discarded.

func (*Tree) ErrorContext Uses

❖
func (t *Tree) ErrorContext(n Node) (location, context string)

ErrorContext returns a textual representation of the location of the node in the input text. The receiver is only used when the node does not have a pointer to the tree inside, which can occur in old code.

func (*Tree) Parse Uses

❖
func (t *Tree) Parse(text, leftDelim, rightDelim string, treeSet map[string]*Tree, funcs ...map[string]interface{}) (tree *Tree, err error)

Parse parses the template definition string to construct a representation of the template for execution. If either action delimiter string is empty, the default ("{{" or "}}") is used. Embedded template definitions are added to the treeSet map.

type VariableNode Uses

❖
type VariableNode struct {
    NodeType
    Pos

    Ident []string // Variable name and fields in lexical order.
    // contains filtered or unexported fields
}

VariableNode holds a list of variable names, possibly with chained field accesses. The dollar sign is part of the (first) name.

func (*VariableNode) Copy Uses

❖
func (v *VariableNode) Copy() Node

func (*VariableNode) String Uses

❖
func (v *VariableNode) String() string

type WithNode Uses

❖
type WithNode struct {
    BranchNode
}

WithNode represents a {{with}} action and its commands.

func (*WithNode) Copy Uses

❖
func (w *WithNode) Copy() Node