liquid/render/parser.go

package render

import (
	"fmt"
	"strings"

	"github.com/osteele/liquid/expression"
)

// A ParseError is a parse error during the template parsing.
type ParseError string

func (e ParseError) Error() string { return string(e) }

func parseErrorf(format string, a ...interface{}) ParseError {
	return ParseError(fmt.Sprintf(format, a...))
}

// Parse parses a source template. It returns an AST root, that can be evaluated.
func (s Config) Parse(source string) (ASTNode, error) {
	tokens := Scan(source, "")
	return s.parseChunks(tokens)
}

// Parse creates an AST from a sequence of Chunks.
func (s Config) parseChunks(chunks []Chunk) (ASTNode, error) { // nolint: gocyclo
	// a stack of control tag state, for matching nested {%if}{%endif%} etc.
	type frame struct {
		syntax BlockSyntax
		node   *ASTBlock
		ap     *[]ASTNode
	}
	var (
		g         = s.Grammar()
		root      = &ASTSeq{}      // root of AST; will be returned
		ap        = &root.Children // newly-constructed nodes are appended here
		sd        BlockSyntax      // current block syntax definition
		bn        *ASTBlock        // current block node
		stack     []frame          // stack of blocks
		rawTag    *ASTRaw          // current raw tag
		inComment = false
		inRaw     = false
	)
	for _, c := range chunks {
		switch {
		// The parser needs to know about comment and raw, because tags inside
		// needn't match each other e.g. {%comment%}{%if%}{%endcomment%}
		// TODO is this true?
		case inComment:
			if c.Type == TagChunkType && c.Name == "endcomment" {
				inComment = false
			}
		case inRaw:
			if c.Type == TagChunkType && c.Name == "endraw" {
				inRaw = false
			} else {
				rawTag.slices = append(rawTag.slices, c.Source)
			}
		case c.Type == ObjChunkType:
			expr, err := expression.Parse(c.Args)
			if err != nil {
				return nil, err
			}
			*ap = append(*ap, &ASTObject{c, expr})
		case c.Type == TextChunkType:
			*ap = append(*ap, &ASTText{Chunk: c})
		case c.Type == TagChunkType:
			if cs, ok := g.BlockSyntax(c.Name); ok {
				switch {
				case c.Name == "comment":
					inComment = true
				case c.Name == "raw":
					inRaw = true
					rawTag = &ASTRaw{}
					*ap = append(*ap, rawTag)
				case cs.RequiresParent() && (sd == nil || !cs.CanHaveParent(sd)):
					suffix := ""
					if sd != nil {
						suffix = "; immediate parent is " + sd.TagName()
					}
					return nil, parseErrorf("%s not inside %s%s", c.Name, strings.Join(cs.ParentTags(), " or "), suffix)
				case cs.IsBlockStart():
					push := func() {
						stack = append(stack, frame{syntax: sd, node: bn, ap: ap})
						sd, bn = cs, &ASTBlock{Chunk: c, syntax: cs}
						*ap = append(*ap, bn)
					}
					push()
					ap = &bn.Body
				case cs.IsBranch():
					n := &ASTBlock{Chunk: c, syntax: cs}
					bn.Branches = append(bn.Branches, n)
					ap = &n.Body
				case cs.IsBlockEnd():
					pop := func() {
						f := stack[len(stack)-1]
						stack = stack[:len(stack)-1]
						sd, bn, ap = f.syntax, f.node, f.ap
					}
					pop()
				default:
					panic("unexpected block type")
				}
			} else if td, ok := s.FindTagDefinition(c.Name); ok {
				f, err := td(c.Args)
				if err != nil {
					return nil, err
				}
				*ap = append(*ap, &ASTFunctional{c, f})
			} else {
				return nil, parseErrorf("unknown tag: %s", c.Name)
			}
		}
	}
	if bn != nil {
		return nil, parseErrorf("unterminated %s tag at %s", bn.Name, bn.SourceInfo)
	}
	if err := s.evaluateBuilders(root); err != nil {
		return nil, err
	}
	if len(root.Children) == 1 {
		return root.Children[0], nil
	}
	return root, nil
}

// nolint: gocyclo
func (s Config) evaluateBuilders(n ASTNode) error {
	switch n := n.(type) {
	case *ASTBlock:
		for _, child := range n.Body {
			if err := s.evaluateBuilders(child); err != nil {
				return err
			}
		}
		for _, branch := range n.Branches {
			if err := s.evaluateBuilders(branch); err != nil {
				return err
			}
		}
		cd, ok := s.findBlockDef(n.Name)
		if ok && cd.parser != nil {
			renderer, err := cd.parser(*n)
			if err != nil {
				return err
			}
			n.renderer = renderer
		}
	case *ASTSeq:
		for _, child := range n.Children {
			if error := s.evaluateBuilders(child); error != nil {
				return error
			}
		}
	}
	return nil
}