github.com/CiscoM31/godata@v1.0.10/parser.go

package godata

import (
	"context"
	"errors"
	"fmt"
	"regexp"
	"sort"
	"strconv"
	"strings"
)

const (
	OpAssociationLeft int = iota
	OpAssociationRight
	OpAssociationNone
)

const (
	TokenListExpr = "list"

	// TokenComma is the default separator for function arguments.
	TokenComma      = ","
	TokenOpenParen  = "("
	TokenCloseParen = ")"
)

type Tokenizer struct {
	TokenMatchers  []*TokenMatcher
	IgnoreMatchers []*TokenMatcher
}

type TokenMatcher struct {
	Pattern         string                 // The regular expression matching a ODATA query token, such as literal value, operator or function
	Re              *regexp.Regexp         // The compiled regex
	Token           TokenType              // The token identifier
	CaseInsensitive bool                   // Regex is case-insensitive
	Subst           func(in string) string // A function that substitutes the raw input token with another representation. By default it is the identity.
}

// TokenType is the interface that must be implemented by all token types.
type TokenType interface {
	Value() int
}

type ListExprToken int

func (l ListExprToken) Value() int {
	return (int)(l)
}

func (l ListExprToken) String() string {
	return [...]string{
		"TokenTypeListExpr",
		"TokenTypeArgCount",
	}[l]
}

const (
	// TokenTypeListExpr represents a parent node for a variadic listExpr.
	// "list"
	//   "item1"
	//   "item2"
	//   ...
	TokenTypeListExpr ListExprToken = iota
	// TokenTypeArgCount is used to specify the number of arguments of a function or listExpr
	// This is used to handle variadic functions and listExpr.
	TokenTypeArgCount
)

type Token struct {
	Value string
	Type  TokenType
	// Holds information about the semantic meaning of this token taken from the
	// context of the GoDataService.
	SemanticType      SemanticType
	SemanticReference interface{}
}

func (t *Tokenizer) Add(pattern string, token TokenType) {
	t.AddWithSubstituteFunc(pattern, token, func(in string) string { return in })
}

func (t *Tokenizer) AddWithSubstituteFunc(pattern string, token TokenType, subst func(string) string) {
	matcher := createTokenMatcher(pattern, token, subst)
	t.TokenMatchers = append(t.TokenMatchers, matcher)
}

func createTokenMatcher(pattern string, token TokenType, subst func(string) string) *TokenMatcher {
	rxp := regexp.MustCompile(pattern)
	return &TokenMatcher{
		Pattern:         pattern,
		Re:              rxp,
		Token:           token,
		CaseInsensitive: strings.Contains(pattern, "(?i)"),
		Subst:           subst,
	}
}

func (t *Tokenizer) Ignore(pattern string, token TokenType) {
	rxp := regexp.MustCompile(pattern)
	matcher := &TokenMatcher{
		Pattern:         pattern,
		Re:              rxp,
		Token:           token,
		CaseInsensitive: strings.Contains(pattern, "(?i)"),
		Subst:           func(in string) string { return in },
	}
	t.IgnoreMatchers = append(t.IgnoreMatchers, matcher)
}

// TokenizeBytes takes the input byte array and returns an array of tokens.
// Return an empty array if there are no tokens.
func (t *Tokenizer) TokenizeBytes(ctx context.Context, target []byte) ([]*Token, error) {
	result := make([]*Token, 0)
	match := true // false when no match is found
	for len(target) > 0 && match {
		match = false
		ignore := false
		var tokens [][]byte
		var m *TokenMatcher
		for _, m = range t.TokenMatchers {
			tokens = m.Re.FindSubmatch(target)
			if len(tokens) > 0 {
				match = true
				break
			}
		}
		if len(tokens) == 0 {
			for _, m = range t.IgnoreMatchers {
				tokens = m.Re.FindSubmatch(target)
				if len(tokens) > 0 {
					ignore = true
					break
				}
			}
		}
		if len(tokens) > 0 {
			match = true
			var parsed Token
			var token []byte
			// If the regex includes a named group and the name of that group is "token"
			// then the value of the token is set to the subgroup. Other characters are
			// not consumed by the tokenization process.
			// For example, the regex:
			//    ^(?P<token>(eq|ne|gt|ge|lt|le|and|or|not|has|in))\\s
			// has a group named 'token' and the group is followed by a mandatory space character.
			// If the input data is `Name eq 'Bob'`, the token is correctly set to 'eq' and
			// the space after eq is not consumed, because the space character itself is supposed
			// to be the next token.
			//
			// If Token.Value needs to be a sub-regex but the entire token needs to be consumed,
			// use 'subtoken'
			//    ^(duration)?'(?P<subtoken>[0-9])'
			l := 0
			if idx := m.Re.SubexpIndex("token"); idx > 0 {
				token = tokens[idx]
				l = len(token)
			} else if idx := m.Re.SubexpIndex("subtoken"); idx > 0 {
				token = tokens[idx]
				l = len(tokens[0])
			} else {
				token = tokens[0]
				l = len(token)
			}
			target = target[l:] // remove the token from the input
			if !ignore {
				var v string
				if m.CaseInsensitive {
					// In ODATA 4.0.1, operators and functions are case insensitive.
					v = strings.ToLower(string(token))
				} else {
					v = string(token)
				}
				parsed = Token{
					Value: m.Subst(v),
					Type:  m.Token,
				}
				result = append(result, &parsed)
			}
		}
	}

	if len(target) > 0 && !match {
		return result, BadRequestError(fmt.Sprintf("Token '%s' is invalid", string(target)))
	}
	if len(result) < 1 {
		return result, BadRequestError("Empty query parameter")
	}
	return result, nil
}

func (t *Tokenizer) Tokenize(ctx context.Context, target string) ([]*Token, error) {
	return t.TokenizeBytes(ctx, []byte(target))
}

type TokenHandler func(token *Token, stack tokenStack) error

type Parser struct {
	// Map from string inputs to operator types
	Operators map[string]*Operator
	// Map from string inputs to function types
	Functions map[string]*Function

	LiteralToken TokenType
}

type Operator struct {
	Token string
	// Whether the operator is left/right/or not associative.
	// Determines how operators of the same precedence are grouped in the absence of parentheses.
	Association int
	// The number of operands this operator operates on
	Operands int
	// Rank of precedence. A higher value indicates higher precedence.
	Precedence int
	// Determine if the operands should be interpreted as a ListExpr or parenExpr according
	// to ODATA ABNF grammar.
	// This is only used when a listExpr has zero or one items.
	// When a listExpr has 2 or more items, there is no ambiguity between listExpr and parenExpr.
	// For example:
	//    2 + (3) ==> the right operand is a parenExpr.
	//    City IN ('Seattle', 'Atlanta') ==> the right operand is unambiguously a listExpr.
	//    City IN ('Seattle') ==> the right operand should be a listExpr.
	PreferListExpr bool
}

func (o *Operator) WithListExprPreference(v bool) *Operator {
	o.PreferListExpr = v
	return o
}

type Function struct {
	Token  string // The function token
	Params []int  // The number of parameters this function accepts
	ReturnsBool bool // Indicates if the function has a boolean return value
}

type ParseNode struct {
	Token    *Token
	Parent   *ParseNode
	Children []*ParseNode
}

func (p *ParseNode) String() string {
	var sb strings.Builder
	var treePrinter func(n *ParseNode, sb *strings.Builder, level int, idx *int)

	treePrinter = func(n *ParseNode, s *strings.Builder, level int, idx *int) {
		if n == nil || n.Token == nil {
			s.WriteRune('\n')
			return
		}
		s.WriteString(fmt.Sprintf("[%2d][%2d]", *idx, n.Token.Type))
		*idx += 1
		s.WriteString(strings.Repeat("  ", level))
		s.WriteString(n.Token.Value)
		s.WriteRune('\n')
		for _, v := range n.Children {
			treePrinter(v, s, level+1, idx)
		}
	}
	idx := 0
	treePrinter(p, &sb, 0, &idx)
	return sb.String()
}

func EmptyParser() *Parser {
	return &Parser{
		Operators:    make(map[string]*Operator),
		Functions:    make(map[string]*Function),
		LiteralToken: nil,
	}
}

func (p *Parser) WithLiteralToken(token TokenType) *Parser {
	p.LiteralToken = token
	return p
}

// DefineOperator adds an operator to the language.
// Provide the token, the expected number of arguments,
// whether the operator is left, right, or not associative, and a precedence.
func (p *Parser) DefineOperator(token string, operands, assoc, precedence int) *Operator {
	op := &Operator{
		Token:       token,
		Association: assoc,
		Operands:    operands,
		Precedence:  precedence,
	}
	p.Operators[token] = op
	return op
}

// DefineFunction adds a function to the language.
// - params is the number of parameters this function accepts
// - returnsBool indicates if the function has a boolean return value
func (p *Parser) DefineFunction(token string, params []int, returnsBool bool) *Function {
	sort.Sort(sort.Reverse(sort.IntSlice(params)))
	f := &Function{token, params, returnsBool}
	p.Functions[token] = f
	return f
}

// CustomFunctionInput serves as input to function DefineCustomFunctions()
type CustomFunctionInput struct {
	Name      string // case-insensitive function name
	NumParams []int  // number of allowed parameters
	ReturnsBool bool // indicates if the function has a boolean return value
}

// DefineCustomFunctions introduces additional function names to be considered as legal function
// names while parsing. The function names must be different from all canonical functions and
// operators defined in the odata specification.
//
// See https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_Functions
func DefineCustomFunctions(functions []CustomFunctionInput) error {
	var funcNames []string
	for _, v := range functions {
		name := strings.ToLower(v.Name)

		if GlobalExpressionParser.Functions[name] != nil {
			return fmt.Errorf("custom function '%s' may not override odata canonical function", name)
		} else if GlobalExpressionParser.Operators[name] != nil {
			return fmt.Errorf("custom function '%s' may not override odata operator", name)
		}

		GlobalExpressionParser.DefineFunction(name, v.NumParams, v.ReturnsBool)
		funcNames = append(funcNames, name)
	}

	// create a regex that performs a case-insensitive match of any one of the provided function names
	pattern := fmt.Sprintf("(?i)^(?P<token>(%s))[\\s(]", strings.Join(funcNames, "|"))
	matcher := createTokenMatcher(pattern, ExpressionTokenFunc, func(in string) string { return in })

	// The tokenizer has a list of matcher expressions which are evaluated in order while parsing
	// with the first matching rule being applied. The matcher for custom functions is inserted
	// immediately following the matcher for functions defined in the Odata specification (identified
	// by finding rule with type ExpressionTokenFunc). Because the rules are applied in order based
	// on specificity, inserting at this location ensures the custom function rule has similar
	// precedence as functioned defined the Odata specification.
	list := GlobalExpressionTokenizer.TokenMatchers
	for i, v := range GlobalExpressionTokenizer.TokenMatchers {
		if v.Token == ExpressionTokenFunc {
			list = append(list[:i+1], list[i:]...)
			list[i] = matcher
			GlobalExpressionTokenizer.TokenMatchers = list
			return nil
		}
	}

	// This is a godata package bug. The tokenizer should define matches for the token
	// type ExpressionTokenFunc for functions defined in the Odata specification.
	// Such as substring and tolower.
	return errors.New("godata parser is missing function matchers")
}

func (p *Parser) isFunction(token *Token) bool {
	_, ok := p.Functions[token.Value]
	return ok
}

func (p *Parser) isOperator(token *Token) bool {
	_, ok := p.Operators[token.Value]
	return ok
}

// isBooleanExpression returns True when the expression token 't' has a resulting boolean value
func (p *Parser) isBooleanExpression(t *Token) bool {
	switch t.Type {
	case ExpressionTokenBoolean:
		// Valid boolean expression
	case ExpressionTokenLogical:
		// eq|ne|gt|ge|lt|le|and|or|not|has|in
		// Valid boolean expression
	case ExpressionTokenFunc:
		// Depends on function return type
		f := p.Functions[t.Value]
		if !f.ReturnsBool {
			return false
		}
	case ExpressionTokenLambdaNav:
		// Lambda Navigation.
		// Valid boolean expression
	default:
		return false
	}
	return true
}

// InfixToPostfix parses the input string of tokens using the given definitions of operators
// and functions.
// Everything else is assumed to be a literal.
// Uses the Shunting-Yard algorithm.
//
// Infix notation for variadic functions and operators: f ( a, b, c, d )
// Postfix notation with wall notation:                 | a b c d f
// Postfix notation with count notation:                a b c d 4 f
func (p *Parser) InfixToPostfix(ctx context.Context, tokens []*Token) (*tokenQueue, error) {
	queue := tokenQueue{} // output queue in postfix
	stack := tokenStack{} // Operator stack

	previousTokenIsLiteral := false
	var previousToken *Token = nil

	incrementListArgCount := func(token *Token) {
		if !stack.Empty() {
			if previousToken != nil && previousToken.Value == TokenOpenParen {
				stack.Head.listArgCount++
			} else if stack.Head.Token.Value == TokenOpenParen {
				stack.Head.listArgCount++
			}
		}
	}
	cfg, hasComplianceConfig := ctx.Value(odataCompliance).(OdataComplianceConfig)
	if !hasComplianceConfig {
		// Strict ODATA compliance by default.
		cfg = ComplianceStrict
	}
	for len(tokens) > 0 {
		token := tokens[0]
		tokens = tokens[1:]
		switch {
		case p.isFunction(token):
			previousTokenIsLiteral = false
			if len(tokens) == 0 || tokens[0].Value != TokenOpenParen {
				// A function token must be followed by open parenthesis token.
				return nil, BadRequestError(fmt.Sprintf("Function '%s' must be followed by '('", token.Value))
			}
			incrementListArgCount(token)
			// push functions onto the stack
			stack.Push(token)
		case p.isOperator(token):
			previousTokenIsLiteral = false
			// push operators onto stack according to precedence
			o1 := p.Operators[token.Value]
			if !stack.Empty() {
				for o2, ok := p.Operators[stack.Peek().Value]; ok &&
					((o1.Association == OpAssociationLeft && o1.Precedence <= o2.Precedence) ||
						(o1.Association == OpAssociationRight && o1.Precedence < o2.Precedence)); {
					queue.Enqueue(stack.Pop())

					if stack.Empty() {
						break
					}
					o2, ok = p.Operators[stack.Peek().Value]
				}
			}
			if o1.Operands == 1 { // not, -
				incrementListArgCount(token)
			}
			stack.Push(token)
		case token.Value == TokenOpenParen:
			previousTokenIsLiteral = false
			// In OData, the parenthesis tokens can be used:
			// - As a parenExpr to set explicit precedence order, such as "(a + 2) x b"
			//   These precedence tokens are removed while parsing the OData query.
			// - As a listExpr for multi-value sets, such as "City in ('San Jose', 'Chicago', 'Dallas')"
			//   The list tokens are retained while parsing the OData query.
			//   ABNF grammar:
			//   listExpr  = OPEN BWS commonExpr BWS *( COMMA BWS commonExpr BWS ) CLOSE
			incrementListArgCount(token)
			// Push open parens onto the stack
			stack.Push(token)
		case token.Value == TokenCloseParen:
			previousTokenIsLiteral = false
			if previousToken != nil && previousToken.Value == TokenComma {
				if cfg&ComplianceIgnoreInvalidComma == 0 {
					return nil, fmt.Errorf("invalid token sequence: %s %s", previousToken.Value, token.Value)
				}
			}
			// if we find a close paren, pop things off the stack
			for !stack.Empty() {
				if stack.Peek().Value == TokenOpenParen {
					break
				} else {
					queue.Enqueue(stack.Pop())
				}
			}
			if stack.Empty() {
				// there was an error parsing
				return nil, BadRequestError("Parse error. Mismatched parenthesis.")
			}

			// Determine if the parenthesis delimiters are:
			// - A listExpr, possibly an empty list or single element.
			//   Note a listExpr may be on the left-side or right-side of operators,
			//   or it may be a list of function arguments.
			// - A parenExpr, which is used as a precedence delimiter.
			//
			// (1, 2, 3) is a listExpr, there is no ambiguity.
			// (1) matches both listExpr or parenExpr.
			// parenExpr takes precedence over listExpr.
			//
			// For example:
			//   1 IN (1, 2)  ==> parenthesis is used to create a list of two elements.
			//   Tags(Key='Environment')/Value ==> variadic list of arguments in property navigation.
			//   (1) + (2)    ==> parenthesis is a precedence delimiter, i.e. parenExpr.

			// Get the argument count associated with the open paren.
			// Examples:
			// (a, b, c) is a listExpr with three arguments.
			// (arg1='abc',arg2=123) is a listExpr with two arguments.
			argCount := stack.getArgCount()
			// pop off open paren
			stack.Pop()

			isListExpr := false
			popTokenFromStack := false

			if !stack.Empty() {
				// Peek the token at the head of the stack.
				if _, ok := p.Functions[stack.Peek().Value]; ok {
					// The token is a function followed by a parenthesized expression.
					// e.g. `func(a1, a2, a3)`
					// ==> The parenthesized expression is a list expression.
					popTokenFromStack = true
					isListExpr = true
				} else if o1, ok := p.Operators[stack.Peek().Value]; ok {
					// The token is an operator followed by a parenthesized expression.
					if o1.PreferListExpr {
						// The expression is the right operand of an operator that has a preference for listExpr vs parenExpr.
						isListExpr = true
					}
				} else {
					if stack.Peek().Type == p.LiteralToken {
						// The token is a odata identifier followed by a parenthesized expression.
						// E.g. `Product(a1=abc)`:
						// ==> The parenthesized expression is a list expression.
						isListExpr = true
						popTokenFromStack = true
					}
				}
			}
			if argCount > 1 {
				isListExpr = true
			}
			// When a listExpr contains a single item, it is ambiguous whether it is a listExpr or parenExpr.
			// For example:
			// (1) add (2) ==> there is no list involved. There are superfluous parenthesis.
			// (1, 2) in ( ('a', 'b', 'c'), (1, 2) ):
			//    This is true because the LHS list (1, 2) is contained in the RHS list.
			// The following expressions are not the same:
			//   (1) in ( ('a', 'b', 'c'), (2), 1 )
			//       ==> false because the LHS does not contain the LHS list (1).
			//           or should (1) be simplified to the integer 1, which is contained in the RHS?
			//   1 in ( ('a', 'b', 'c'), (2), 1 )
			//       ==> true. The number 1 is contained in the RHS list.
			if isListExpr {
				// The open parenthesis was a delimiter for a listExpr.
				// Add a token indicating the number of arguments in the list.
				queue.Enqueue(&Token{
					Value: strconv.Itoa(argCount),
					Type:  TokenTypeArgCount,
				})
				// Enqueue a 'list' token if we are processing a ListExpr.
				queue.Enqueue(&Token{
					Value: TokenListExpr,
					Type:  TokenTypeListExpr,
				})
			}
			// if next token is a function or nav collection segment, move it to the queue
			if popTokenFromStack {
				queue.Enqueue(stack.Pop())
			}
		case token.Value == TokenComma:
			previousTokenIsLiteral = false
			if previousToken != nil {
				switch previousToken.Value {
				case TokenComma, TokenOpenParen:
					return nil, fmt.Errorf("invalid token sequence: %s %s", previousToken.Value, token.Value)
				}
			}
			// Function argument separator (",")
			// Comma may be used as:
			// 1. Separator of function parameters,
			// 2. Separator for listExpr such as "City IN ('Seattle', 'San Francisco')"
			//
			// Pop off stack until we see a TokenOpenParen
			for !stack.Empty() && stack.Peek().Value != TokenOpenParen {
				// This happens when the previous function argument is an expression composed
				// of multiple tokens, as opposed to a single token. For example:
				//     max(sin( 5 mul pi ) add 3, sin( 5 ))
				queue.Enqueue(stack.Pop())
			}
			if stack.Empty() {
				// there was an error parsing. The top of the stack must be open parenthesis
				return nil, BadRequestError("Parse error")
			}
			if stack.Peek().Value != TokenOpenParen {
				panic("unexpected token")
			}

		default:
			if previousTokenIsLiteral {
				return nil, fmt.Errorf("invalid token sequence: %s %s", previousToken.Value, token.Value)
			}
			if token.Type == p.LiteralToken && len(tokens) > 0 && tokens[0].Value == TokenOpenParen {
				// Literal followed by parenthesis ==> property collection navigation
				// push property segment onto the stack
				stack.Push(token)
			} else {
				// Token is a literal, number, string... -- put it in the queue
				queue.Enqueue(token)
			}
			incrementListArgCount(token)
			previousTokenIsLiteral = true
		}
		previousToken = token
	}

	// pop off the remaining operators onto the queue
	for !stack.Empty() {
		if stack.Peek().Value == TokenOpenParen || stack.Peek().Value == TokenCloseParen {
			return nil, BadRequestError("parse error. Mismatched parenthesis.")
		}
		queue.Enqueue(stack.Pop())
	}
	return &queue, nil
}

// PostfixToTree converts a Postfix token queue to a parse tree
func (p *Parser) PostfixToTree(ctx context.Context, queue *tokenQueue) (*ParseNode, error) {
	stack := &nodeStack{}
	currNode := &ParseNode{}

	if queue == nil {
		return nil, errors.New("input queue is nil")
	}
	t := queue.Head
	for t != nil {
		t = t.Next
	}
	// Function to process a list with a variable number of arguments.
	processVariadicArgs := func(parent *ParseNode) (int, error) {

		// Pop off the count of list arguments.
		if stack.Empty() {
			return 0, fmt.Errorf("no argCount token found, stack is empty")
		}
		n := stack.Pop()
		if n.Token.Type != TokenTypeArgCount {
			return 0, fmt.Errorf("expected arg count token, got '%v'", n.Token.Type)
		}
		argCount, err := strconv.Atoi(n.Token.Value)
		if err != nil {
			return 0, err
		}
		for i := 0; i < argCount; i++ {
			if stack.Empty() {
				return 0, fmt.Errorf("missing argument found. '%s'", parent.Token.Value)
			}
			c := stack.Pop()
			// Attach the operand to its parent node which represents the function/operator
			c.Parent = parent
			// prepend children so they get added in the right order
			parent.Children = append([]*ParseNode{c}, parent.Children...)
		}
		return argCount, nil
	}
	for !queue.Empty() {
		// push the token onto the stack as a tree node
		currToken := queue.Dequeue()
		currNode = &ParseNode{currToken, nil, make([]*ParseNode, 0)}
		stack.Push(currNode)

		stackHeadToken := stack.Peek().Token
		switch {
		case p.isFunction(stackHeadToken):
			// The top of the stack is a function, pop off the function.
			node := stack.Pop()

			// Pop off the list expression.
			if stack.Empty() {
				return nil, fmt.Errorf("no list expression token found, stack is empty")
			}
			n := stack.Pop()
			if n.Token.Type != TokenTypeListExpr {
				return nil, fmt.Errorf("expected list expression token, got '%v'", n.Token.Type)
			}

			if node.Token.Type == ExpressionTokenCase {
				// Create argument pairs for case() statement by translating flat list into pairs
				if len(n.Children)%2 != 0 {
					return nil, fmt.Errorf("expected even number of comma-separated arguments to case statement")
				}
				for i:=0; i<len(n.Children); i+=2 {
					if !p.isBooleanExpression(n.Children[i].Token) {
						return nil, fmt.Errorf("expected boolean expression in case statement")
					}
					c := &ParseNode{
						Token:    &Token{Type: ExpressionTokenCasePair},
						Parent:   node,
						Children: []*ParseNode{n.Children[i],n.Children[i+1]},
					}
					node.Children = append(node.Children, c)
				}
			} else {
				// Collapse function arguments as direct children of function node
				for _, c := range n.Children {
					c.Parent = node
				}
				node.Children = n.Children
			}

			// Some functions, e.g. substring, can take a variable number of arguments. Enforce legal number of arguments
			foundMatch := false
			f := p.Functions[node.Token.Value]
			for _, expectedArgCount := range f.Params {
				if len(node.Children) == expectedArgCount {
					foundMatch = true
					break
				}
			}
			if !foundMatch {
				return nil, fmt.Errorf("invalid number of arguments for function '%s'. Got %d argument. Expected: %v",
					node.Token.Value, len(node.Children), f.Params)
			}
			stack.Push(node)
		case p.isOperator(stackHeadToken):
			// if the top of the stack is an operator
			node := stack.Pop()
			o := p.Operators[node.Token.Value]
			// pop off operands
			for i := 0; i < o.Operands; i++ {
				if stack.Empty() {
					return nil, fmt.Errorf("insufficient number of operands for operator '%s'", node.Token.Value)
				}
				// prepend children so they get added in the right order
				c := stack.Pop()
				c.Parent = node
				node.Children = append([]*ParseNode{c}, node.Children...)
			}
			stack.Push(node)
		case TokenTypeListExpr == stackHeadToken.Type:
			// ListExpr: List of items
			// Pop off the list expression.
			node := stack.Pop()
			if _, err := processVariadicArgs(node); err != nil {
				return nil, err
			}
			stack.Push(node)
		case p.LiteralToken == stackHeadToken.Type:
			// Pop off the property literal.
			node := stack.Pop()

			if !stack.Empty() && stack.Peek().Token.Type == TokenTypeListExpr {
				// Pop off the list expression.
				n := stack.Pop()
				for _, c := range n.Children {
					c.Parent = node
				}
				node.Children = n.Children
			}
			stack.Push(node)
		}
	}
	// If all tokens have been processed, the stack should have zero or one element.
	if stack.Head != nil && stack.Head.Prev != nil {
		return nil, errors.New("invalid expression")
	}
	return currNode, nil
}

type tokenStack struct {
	Head *tokenStackNode
	Size int
}

type tokenStackNode struct {
	Token        *Token          // The token value.
	Prev         *tokenStackNode // The previous node in the stack.
	listArgCount int             // The number of arguments in a listExpr.
}

func (s *tokenStack) Push(t *Token) {
	node := tokenStackNode{Token: t, Prev: s.Head}
	s.Head = &node
	s.Size++
}

func (s *tokenStack) Pop() *Token {
	node := s.Head
	s.Head = node.Prev
	s.Size--
	return node.Token
}

// Peek returns the token at head of the stack.
// The stack is not modified.
// A panic occurs if the stack is empty.
func (s *tokenStack) Peek() *Token {
	return s.Head.Token
}

func (s *tokenStack) Empty() bool {
	return s.Head == nil
}

func (s *tokenStack) getArgCount() int {
	return s.Head.listArgCount
}

func (s *tokenStack) String() string {
	output := ""
	currNode := s.Head
	for currNode != nil {
		output = currNode.Token.Value + " " + output
		currNode = currNode.Prev
	}
	return output
}

type tokenQueue struct {
	Head *tokenQueueNode
	Tail *tokenQueueNode
}

type tokenQueueNode struct {
	Token *Token
	Prev  *tokenQueueNode
	Next  *tokenQueueNode
}

// Enqueue adds the specified token at the tail of the queue.
func (q *tokenQueue) Enqueue(t *Token) {
	node := tokenQueueNode{t, q.Tail, nil}
	//fmt.Println(t.Value)

	if q.Tail == nil {
		q.Head = &node
	} else {
		q.Tail.Next = &node
	}

	q.Tail = &node
}

// Dequeue removes the token at the head of the queue and returns the token.
func (q *tokenQueue) Dequeue() *Token {
	node := q.Head
	if node.Next != nil {
		node.Next.Prev = nil
	}
	q.Head = node.Next
	if q.Head == nil {
		q.Tail = nil
	}
	return node.Token
}

func (q *tokenQueue) Empty() bool {
	return q.Head == nil && q.Tail == nil
}

func (q *tokenQueue) String() string {
	var sb strings.Builder
	node := q.Head
	for node != nil {
		sb.WriteString(fmt.Sprintf("%s[%v]", node.Token.Value, node.Token.Type))
		node = node.Next
		if node != nil {
			sb.WriteRune(' ')
		}
	}
	return sb.String()
}

func (q *tokenQueue) GetValue() string {
	var sb strings.Builder
	node := q.Head
	for node != nil {
		sb.WriteString(node.Token.Value)
		node = node.Next
	}
	return sb.String()
}

type nodeStack struct {
	Head *nodeStackNode
}

type nodeStackNode struct {
	ParseNode *ParseNode
	Prev      *nodeStackNode
}

func (s *nodeStack) Push(n *ParseNode) {
	node := nodeStackNode{ParseNode: n, Prev: s.Head}
	s.Head = &node
}

func (s *nodeStack) Pop() *ParseNode {
	node := s.Head
	s.Head = node.Prev
	return node.ParseNode
}

func (s *nodeStack) Peek() *ParseNode {
	return s.Head.ParseNode
}

func (s *nodeStack) Empty() bool {
	return s.Head == nil
}

func (s *nodeStack) String() string {
	var sb strings.Builder
	currNode := s.Head
	for currNode != nil {
		sb.WriteRune(' ')
		sb.WriteString(currNode.ParseNode.Token.Value)
		currNode = currNode.Prev
	}
	return sb.String()
}