debian-forge-composer/vendor/github.com/vmware-labs/yaml-jsonpath/pkg/yamlpath/lexer.go

/*
 * Copyright 2020 VMware, Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

package yamlpath

import (
	"fmt"
	"regexp"
	"strconv"
	"strings"
	"unicode"
	"unicode/utf8"
)

// This lexer was based on Rob Pike's talk "Lexical Scanning in Go" (https://talks.golang.org/2011/lex.slide#1)

type lexemeType int

const (
	lexemeError lexemeType = iota
	lexemeIdentity
	lexemeRoot
	lexemeDotChild
	lexemeUndottedChild
	lexemeBracketChild
	lexemeRecursiveDescent
	lexemeArraySubscript
	lexemeFilterBegin
	lexemeFilterEnd
	lexemeFilterOpenBracket
	lexemeFilterCloseBracket
	lexemeFilterNot
	lexemeFilterAt
	lexemeFilterAnd
	lexemeFilterOr
	lexemeFilterEquality
	lexemeFilterInequality
	lexemeFilterGreaterThan
	lexemeFilterGreaterThanOrEqual
	lexemeFilterLessThanOrEqual
	lexemeFilterLessThan
	lexemeFilterMatchesRegularExpression
	lexemeFilterIntegerLiteral
	lexemeFilterFloatLiteral
	lexemeFilterStringLiteral
	lexemeFilterBooleanLiteral
	lexemeFilterNullLiteral
	lexemeFilterRegularExpressionLiteral
	lexemePropertyName
	lexemeBracketPropertyName
	lexemeArraySubscriptPropertyName
	lexemeRecursiveFilterBegin
	lexemeEOF // lexing complete
)

func (t lexemeType) comparator() comparator {
	switch t {
	case lexemeFilterEquality:
		return equal

	case lexemeFilterInequality:
		return notEqual

	case lexemeFilterGreaterThan:
		return greaterThan

	case lexemeFilterGreaterThanOrEqual:
		return greaterThanOrEqual

	case lexemeFilterLessThan:
		return lessThan

	case lexemeFilterLessThanOrEqual:
		return lessThanOrEqual

	default:
		panic(fmt.Sprintf("invalid comparator %d", t)) // should never happen
	}
}

func (t lexemeType) isComparisonOrMatch() bool {
	switch t {
	case lexemeFilterEquality, lexemeFilterInequality,
		lexemeFilterGreaterThan, lexemeFilterGreaterThanOrEqual,
		lexemeFilterLessThan, lexemeFilterLessThanOrEqual,
		lexemeFilterMatchesRegularExpression:
		return true
	}
	return false
}

// a lexeme is a token returned from the lexer
type lexeme struct {
	typ lexemeType
	val string // original lexeme or error message if typ is lexemeError
}

func (l lexeme) literalValue() typedValue {
	switch l.typ {
	case lexemeFilterIntegerLiteral:
		return typedValue{
			typ: intValueType,
			val: l.val,
		}

	case lexemeFilterFloatLiteral:
		return typedValue{
			typ: floatValueType,
			val: l.val,
		}

	case lexemeFilterStringLiteral:
		return typedValue{
			typ: stringValueType,
			val: l.val[1 : len(l.val)-1],
		}

	case lexemeFilterBooleanLiteral:
		return typedValue{
			typ: booleanValueType,
			val: l.val,
		}

	case lexemeFilterNullLiteral:
		return typedValue{
			typ: nullValueType,
			val: l.val,
		}

	case lexemeFilterRegularExpressionLiteral:
		return typedValue{
			typ: regularExpressionValueType,
			val: sanitiseRegularExpressionLiteral(l.val),
		}

	default:
		return typedValue{
			typ: unknownValueType,
			val: l.val,
		}
	}
}

func sanitiseRegularExpressionLiteral(re string) string {
	return strings.ReplaceAll(re[1:len(re)-1], `\/`, `/`)
}

func (l lexeme) comparator() comparator {
	return l.typ.comparator()
}

// stateFn represents the state of the lexer as a function that returns the next state.
// A nil stateFn indicates lexing is complete.
type stateFn func(*lexer) stateFn

// lexer holds the state of the scanner.
type lexer struct {
	name                  string      // name of the lexer, used only for error reports
	input                 string      // the string being scanned
	start                 int         // start position of this item
	pos                   int         // current position in the input
	width                 int         // width of last rune read from input
	state                 stateFn     // lexer state
	stack                 []stateFn   // lexer stack
	items                 chan lexeme // channel of scanned lexemes
	lastEmittedStart      int         // start position of last scanned lexeme
	lastEmittedLexemeType lexemeType  // type of last emitted lexeme (or lexemEOF if no lexeme has been emitted)
}

// lex creates a new scanner for the input string.
func lex(name, input string) *lexer {
	l := &lexer{
		name:                  name,
		input:                 input,
		state:                 lexPath,
		stack:                 make([]stateFn, 0),
		items:                 make(chan lexeme, 2),
		lastEmittedLexemeType: lexemeEOF,
	}
	return l
}

// push pushes a state function on the stack which will be resumed when parsing terminates.
func (l *lexer) push(state stateFn) {
	l.stack = append(l.stack, state)
}

// pop pops a state function from the stack. If the stack is empty, returns an error function.
func (l *lexer) pop() stateFn {
	if len(l.stack) == 0 {
		return l.errorf("syntax error")
	}
	index := len(l.stack) - 1
	element := l.stack[index]
	l.stack = l.stack[:index]
	return element
}

// empty returns true if and onl if the stack of state functions is empty.
func (l *lexer) emptyStack() bool {
	return len(l.stack) == 0
}

// nextLexeme returns the next item from the input.
func (l *lexer) nextLexeme() lexeme {
	for {
		select {
		case item := <-l.items:
			return item
		default:
			if l.state == nil {
				return lexeme{
					typ: lexemeEOF,
				}
			}
			l.state = l.state(l)
		}
	}
}

const eof rune = -1 // invalid Unicode code point

// next returns the next rune in the input.
func (l *lexer) next() (rune rune) {
	if l.pos >= len(l.input) {
		l.width = 0
		return eof
	}
	rune, l.width = utf8.DecodeRuneInString(l.input[l.pos:])
	l.pos += l.width
	return rune
}

// consume consumes as many runes as there are in the given string
func (l *lexer) consume(s string) {
	for range s {
		l.next()
	}
}

// consumed checks the input to see if it starts with the given token and does
// not start with any of the given exceptions. If so, it consumes the given
// token and returns true. Otherwise, it returns false.
func (l *lexer) consumed(token string, except ...string) bool {
	if l.hasPrefix(token) {
		for _, e := range except {
			if l.hasPrefix(e) {
				return false
			}
		}
		l.consume(token)
		return true
	}
	return false
}

// consumedWhitespaces checks the input to see if, after whitespace is removed, it
// starts with the given tokens. If so, it consumes the given
// tokens and any whitespace and returns true. Otherwise, it returns false.
func (l *lexer) consumedWhitespaced(tokens ...string) bool {
	pos := l.pos
	for _, token := range tokens {
		// skip past whitespace
		for {
			if pos >= len(l.input) {
				return false
			}
			rune, width := utf8.DecodeRuneInString(l.input[pos:])
			if !unicode.IsSpace(rune) {
				break
			}
			pos += width
		}
		if !strings.HasPrefix(l.input[pos:], token) {
			return false
		}
		pos += len(token)
	}
	l.pos = pos
	return true
}

// consumeWhitespace consumes any leading whitespace.
func (l *lexer) consumeWhitespace() {
	pos := l.pos
	for {
		if pos >= len(l.input) {
			break
		}
		rune, width := utf8.DecodeRuneInString(l.input[pos:])
		if !unicode.IsSpace(rune) {
			break
		}
		pos += width
	}
	l.pos = pos
}

// peek returns the next rune in the input but without consuming it.
// it is equivalent to calling next() followed by backup()
func (l *lexer) peek() (rune rune) {
	if l.pos >= len(l.input) {
		l.width = 0
		return eof
	}
	rune, l.width = utf8.DecodeRuneInString(l.input[l.pos:])
	return rune
}

// peeked checks the input to see if it starts with the given token and does
// not start with any of the given exceptions. If so, it returns true.
// Otherwise, it returns false.
func (l *lexer) peeked(token string, except ...string) bool {
	if l.hasPrefix(token) {
		for _, e := range except {
			if l.hasPrefix(e) {
				return false
			}
		}
		return true
	}
	return false
}

// peekedWhitespaces checks the input to see if, after whitespace is removed, it
// starts with the given tokens. If so, it returns true. Otherwise, it returns false.
func (l *lexer) peekedWhitespaced(tokens ...string) bool {
	pos := l.pos
	for _, token := range tokens {
		// skip past whitespace
		for {
			if pos >= len(l.input) {
				return false
			}
			rune, width := utf8.DecodeRuneInString(l.input[pos:])
			if !unicode.IsSpace(rune) {
				break
			}
			pos += width
		}
		if !strings.HasPrefix(l.input[pos:], token) {
			return false
		}
		pos += len(token)
	}
	return true
}

// backup steps back one rune.
// Can be called only once per call of next.
func (l *lexer) backup() {
	l.pos -= l.width
}

// stripWhitespace strips out whitespace
// it should only be called immediately after emitting a lexeme
func (l *lexer) stripWhitespace() {
	// find whitespace
	for {
		nextRune := l.next()
		if !unicode.IsSpace(nextRune) {
			l.backup()
			break
		}
	}
	// strip any whitespace
	l.start = l.pos
}

// emit passes a lexeme back to the client.
func (l *lexer) emit(typ lexemeType) {
	l.items <- lexeme{
		typ: typ,
		val: l.value(),
	}
	l.lastEmittedStart = l.start
	l.start = l.pos
	l.lastEmittedLexemeType = typ
}

// value returns the portion of the current lexeme scanned so far
func (l *lexer) value() string {
	return l.input[l.start:l.pos]
}

// context returns the last emitted lexeme (if any) followed by the portion
// of the current lexeme scanned so far
func (l *lexer) context() string {
	return l.input[l.lastEmittedStart:l.pos]
}

// emitSynthetic passes a lexeme back to the client which wasn't encountered in the input.
// The lexing position is not modified.
func (l *lexer) emitSynthetic(typ lexemeType, val string) {
	l.items <- lexeme{
		typ: typ,
		val: val,
	}
}

func (l *lexer) empty() bool {
	return l.pos >= len(l.input)
}

func (l *lexer) hasPrefix(p string) bool {
	return strings.HasPrefix(l.input[l.pos:], p)
}

// errorf returns an error lexeme with context and terminates the scan
func (l *lexer) errorf(format string, args ...interface{}) stateFn {
	l.items <- lexeme{
		typ: lexemeError,
		val: fmt.Sprintf("%s at position %d, following %q", fmt.Sprintf(format, args...), l.pos, l.context()),
	}
	return nil
}

// rawErrorf returns an error lexeme with no context and terminates the scan
func (l *lexer) rawErrorf(format string, args ...interface{}) stateFn {
	l.items <- lexeme{
		typ: lexemeError,
		val: fmt.Sprintf(format, args...),
	}
	return nil
}

const (
	root                                    string = "$"
	dot                                     string = "."
	leftBracket                             string = "["
	rightBracket                            string = "]"
	bracketQuote                            string = "['"
	bracketDoubleQuote                      string = `["`
	filterBegin                             string = "[?("
	filterEnd                               string = ")]"
	filterOpenBracket                       string = "("
	filterCloseBracket                      string = ")"
	filterNot                               string = "!"
	filterAt                                string = "@"
	filterConjunction                       string = "&&"
	filterDisjunction                       string = "||"
	filterEquality                          string = "=="
	filterInequality                        string = "!="
	filterMatchesRegularExpression          string = "=~"
	filterStringLiteralDelimiter            string = "'"
	filterStringLiteralAlternateDelimiter   string = `"`
	filterRegularExpressionLiteralDelimiter string = "/"
	filterRegularExpressionEscape           string = `\`
	recursiveDescent                        string = ".."
	propertyName                            string = "~"
)

var orderingOperators []orderingOperator

func init() {
	// list the ordering operators in an order suitable for lexing
	orderingOperators = []orderingOperator{
		operatorGreaterThanOrEqual,
		operatorGreaterThan,
		operatorLessThanOrEqual,
		operatorLessThan,
	}
}

func lexPath(l *lexer) stateFn {
	if l.empty() {
		l.emit(lexemeIdentity)
		l.emit(lexemeEOF)
		return nil
	}
	if l.hasPrefix(root) {
		return lexRoot
	}

	// emit implicit root
	l.emitSynthetic(lexemeRoot, root)
	return lexSubPath
}

func lexRoot(l *lexer) stateFn {
	l.pos += len(root)
	l.emit(lexemeRoot)
	return lexSubPath
}

// consumedEscapedString consumes a string with the given string validly escaped using "\" and returns
// true if and only if such a string was consumed.
func consumedEscapedString(l *lexer, quote string) bool {
	for {
		switch {
		case l.peeked(quote): // unescaped quote
			return true
		case l.consumed(`\` + quote):
		case l.consumed(`\\`):
		case l.peeked(`\`):
			l.errorf("unsupported escape sequence inside %s%s", quote, quote)
			return false
		default:
			if l.next() == eof {
				l.errorf("unmatched %s", enquote(quote))
				return false
			}
		}
	}
}

func lexSubPath(l *lexer) stateFn {
	switch {
	case l.hasPrefix(")"):
		return l.pop()

	case l.empty():
		if !l.emptyStack() {
			return l.pop()
		}
		l.emit(lexemeIdentity)
		l.emit(lexemeEOF)
		return nil

	case l.consumed(recursiveDescent):
		childName := false
		for {
			le := l.next()
			if le == '.' || le == '[' || le == eof {
				l.backup()
				break
			}
			childName = true
		}
		if !childName && !l.peeked(leftBracket, bracketQuote, bracketDoubleQuote) {
			return l.errorf("child name or array access or filter missing after recursive descent")
		}
		l.emit(lexemeRecursiveDescent)
		return lexSubPath

	case l.consumed(dot):
		childName := false
		for {
			le := l.next()
			if le == '.' || le == '[' || le == ')' || le == ' ' || le == '&' || le == '|' || le == '=' || le == '!' || le == '>' || le == '<' || le == '~' || le == eof {
				l.backup()
				break
			}
			childName = true
		}
		if !childName {
			return l.errorf("child name missing")
		}
		if l.consumed(propertyName) {
			if l.peek() != eof {
				return l.errorf("property name operator may only be used on last child in path")
			}
			l.emit(lexemePropertyName)
			return lexSubPath
		}

		l.emit(lexemeDotChild)

		return lexOptionalArrayIndex

	case l.peekedWhitespaced("[", "'") || l.peekedWhitespaced("[", `"`): // bracketQuote or bracketDoubleQuote
		l.consumedWhitespaced("[")
		for {
			l.consumeWhitespace()
			quote := string(l.next())

			if !consumedEscapedString(l, quote) {
				return nil
			}
			if !l.consumed(quote) {
				return l.errorf(`missing %s`, enquote(quote))
			}
			if l.consumedWhitespaced(",") {
				if !l.peekedWhitespaced("'") && !l.peekedWhitespaced(`"`) {
					return l.errorf(`missing %s or %s`, enquote("'"), enquote(`"`))
				}
			} else {
				break
			}
		}
		if !l.consumedWhitespaced("]") {
			return l.errorf(`missing "]" or ","`)
		}
		if l.consumed(propertyName) {
			l.emit(lexemeBracketPropertyName)
			if l.peek() != eof {
				return l.errorf("property name operator may only be used on last child in path")
			}
			return lexSubPath
		}

		l.emit(lexemeBracketChild)

		return lexOptionalArrayIndex

	case l.consumed(filterBegin):
		if l.lastEmittedLexemeType == lexemeRecursiveDescent {
			l.emit(lexemeRecursiveFilterBegin)
		} else {
			l.emit(lexemeFilterBegin)
		}
		l.push(lexFilterEnd)
		return lexFilterExprInitial

	case l.peeked(leftBracket):
		return lexOptionalArrayIndex

	case l.lastEmittedLexemeType == lexemeEOF:
		childName := false
		for {
			le := l.next()
			if le == '.' || le == '[' || le == ']' || le == ')' || le == ' ' || le == '&' || le == '|' || le == '=' || le == '!' || le == '>' || le == '<' || le == '~' || le == eof {
				l.backup()
				break
			}
			childName = true
		}
		if !childName {
			return l.errorf("child name missing")
		}
		if l.consumed(propertyName) {
			if l.peek() != eof {
				return l.errorf("property name operator may only be used on last child in path")
			}
			l.emit(lexemePropertyName)
			return lexSubPath
		}
		l.emit(lexemeUndottedChild)

		return lexOptionalArrayIndex

	default:
		return l.errorf("invalid path syntax")
	}
}

func lexOptionalArrayIndex(l *lexer) stateFn {
	if l.consumed(leftBracket, bracketQuote, bracketDoubleQuote, filterBegin) {
		subscript := false
		for {
			if l.consumed(rightBracket) {
				break
			}
			if l.next() == eof {
				return l.errorf("unmatched %s", leftBracket)
			}
			subscript = true
		}
		if !subscript {
			return l.rawErrorf("subscript missing from %s%s before position %d", leftBracket, rightBracket, l.pos)
		}
		if !validateArrayIndex(l) {
			return nil
		}
		if l.consumed(propertyName) {
			if l.peek() != eof {
				return l.errorf("property name operator can only be used on last item in path")
			}
			subscript := l.value()
			index := strings.TrimSuffix(strings.TrimPrefix(subscript, leftBracket), rightBracket+propertyName)
			if index != "*" {
				return l.errorf("property name operator can only be used on map nodes")
			}
			l.emit(lexemeArraySubscriptPropertyName)
			return lexSubPath

		}
		l.emit(lexemeArraySubscript)
	}

	le := l.peek()
	if le == ' ' || le == '&' || le == '|' || le == '=' || le == '!' || le == '>' || le == '<' {
		if l.emptyStack() {
			return l.errorf("invalid character %q", l.peek())
		}
		return l.pop()
	}

	return lexSubPath
}

func enquote(quote string) string {
	switch quote {
	case "'":
		return `"'"`

	case `"`:
		return `'"'`

	default:
		panic(fmt.Sprintf(`enquote called with incorrect argument %q`, quote))
	}
}

func lexFilterExprInitial(l *lexer) stateFn {
	l.stripWhitespace()

	if nextState, present := lexNumericLiteral(l, lexFilterExpr); present {
		return nextState
	}

	if nextState, present := lexStringLiteral(l, lexFilterExpr); present {
		return nextState
	}

	if nextState, present := lexBooleanLiteral(l, lexFilterExpr); present {
		return nextState
	}

	if nextState, present := lexNullLiteral(l, lexFilterExpr); present {
		return nextState
	}

	switch {
	case l.consumed(filterOpenBracket):
		l.emit(lexemeFilterOpenBracket)
		l.push(lexFilterExpr)
		return lexFilterExprInitial

	case l.hasPrefix(filterInequality):
		return l.errorf("missing first operand for binary operator !=")

	case l.consumed(filterNot):
		l.emit(lexemeFilterNot)
		return lexFilterExprInitial

	case l.consumed(filterAt):
		l.emit(lexemeFilterAt)
		if l.peekedWhitespaced("=") || l.peekedWhitespaced("!") || l.peekedWhitespaced(">") || l.peekedWhitespaced("<") {
			return lexFilterExpr
		}
		l.push(lexFilterExpr)
		return lexSubPath

	case l.consumed(root):
		l.emit(lexemeRoot)
		l.push(lexFilterExpr)
		return lexSubPath

	case l.hasPrefix(filterConjunction):
		return l.errorf("missing first operand for binary operator &&")

	case l.hasPrefix(filterDisjunction):
		return l.errorf("missing first operand for binary operator ||")

	case l.hasPrefix(filterEquality):
		return l.errorf("missing first operand for binary operator ==")
	}

	for _, o := range orderingOperators {
		if l.hasPrefix(o.String()) {
			return l.errorf("missing first operand for binary operator %s", o)
		}
	}

	return l.pop()
}

func lexFilterExpr(l *lexer) stateFn {
	l.stripWhitespace()

	switch {
	case l.empty():
		return l.errorf("missing end of filter")

	case l.hasPrefix(filterEnd): // this will be consumed by the popped state function
		return l.pop()

	case l.consumed(filterCloseBracket):
		l.emit(lexemeFilterCloseBracket)
		return l.pop()

	case l.consumed(filterConjunction):
		l.emit(lexemeFilterAnd)
		l.stripWhitespace()
		return lexFilterExprInitial

	case l.consumed(filterDisjunction):
		l.emit(lexemeFilterOr)
		l.stripWhitespace()
		return lexFilterExprInitial

	case l.consumed(filterEquality):
		l.emit(lexemeFilterEquality)
		l.push(lexFilterExpr)
		return lexFilterTerm

	case l.consumed(filterInequality):
		l.emit(lexemeFilterInequality)
		l.push(lexFilterExpr)
		return lexFilterTerm

	case l.hasPrefix(filterMatchesRegularExpression):
		switch l.lastEmittedLexemeType {
		case lexemeFilterStringLiteral, lexemeFilterIntegerLiteral, lexemeFilterFloatLiteral:
			return l.errorf("literal cannot be matched using %s", filterMatchesRegularExpression)
		}
		l.consume(filterMatchesRegularExpression)
		l.emit(lexemeFilterMatchesRegularExpression)

		l.stripWhitespace()
		return lexRegularExpressionLiteral(l, lexFilterExpr)
	}

	for _, o := range orderingOperators {
		if l.hasPrefix(o.String()) {
			return lexComparison(l, o)
		}
	}

	return l.errorf("invalid filter expression")
}

func lexFilterTerm(l *lexer) stateFn {
	l.stripWhitespace()

	if l.consumed(filterAt) {
		l.emit(lexemeFilterAt)

		if l.peekedWhitespaced("|") || l.peekedWhitespaced("&") || l.peekedWhitespaced(")") {
			if l.emptyStack() {
				return l.errorf("invalid character %q", l.peek())
			}
			return l.pop()
		}
		return lexSubPath
	}

	if l.consumed(root) {
		l.emit(lexemeRoot)
		return lexSubPath
	}

	if nextState, present := lexNumericLiteral(l, lexFilterExpr); present {
		return nextState
	}

	if nextState, present := lexStringLiteral(l, lexFilterExpr); present {
		return nextState
	}

	if nextState, present := lexBooleanLiteral(l, lexFilterExpr); present {
		return nextState
	}

	if nextState, present := lexNullLiteral(l, lexFilterExpr); present {
		return nextState
	}

	return l.errorf("invalid filter term")
}

func lexFilterEnd(l *lexer) stateFn {
	if l.hasPrefix(filterEnd) {
		if l.lastEmittedLexemeType == lexemeFilterBegin {
			return l.errorf("missing filter")
		}
		l.consume(filterEnd)
		l.emit(lexemeFilterEnd)
		return lexSubPath
	}

	return l.errorf("invalid filter syntax")
}

func validateArrayIndex(l *lexer) bool {
	subscript := l.value()
	index := strings.TrimSuffix(strings.TrimPrefix(subscript, leftBracket), rightBracket)
	if _, err := slice(index, 0); err != nil {
		l.rawErrorf("invalid array index %s before position %d: %s", subscript, l.pos, err)
		return false
	}
	return true
}

func lexNumericLiteral(l *lexer, nextState stateFn) (stateFn, bool) {
	n := l.peek()
	if n == '.' || n == '-' || (n >= '0' && n <= '9') {
		float := n == '.'
		for {
			l.next()
			n := l.peek()
			if n == '.' || n == 'e' || n == 'E' || n == '-' {
				float = true
				continue
			}
			if !(n >= '0' && n <= '9') {
				break
			}
		}

		if float {
			// validate float
			if _, err := strconv.ParseFloat(l.value(), 64); err != nil {
				err := err.(*strconv.NumError)
				return l.rawErrorf("invalid float literal %q: %s before position %d", err.Num, err, l.pos), true
			}
			l.emit(lexemeFilterFloatLiteral)
			return lexFilterExpr, true
		}
		// validate integer
		if _, err := strconv.Atoi(l.value()); err != nil {
			err := err.(*strconv.NumError)
			return l.rawErrorf("invalid integer literal %q: %s before position %d", err.Num, err, l.pos), true
		}
		l.emit(lexemeFilterIntegerLiteral)
		return lexFilterExpr, true
	}
	return nil, false
}

func lexStringLiteral(l *lexer, nextState stateFn) (stateFn, bool) {
	var quote string
	if l.hasPrefix(filterStringLiteralDelimiter) {
		quote = filterStringLiteralDelimiter
	} else if l.hasPrefix(filterStringLiteralAlternateDelimiter) {
		quote = filterStringLiteralAlternateDelimiter
	}
	if quote != "" {
		pos := l.pos
		context := l.context()
		for {
			if l.next() == eof {
				return l.rawErrorf(`unmatched string delimiter %s at position %d, following %q`, quote, pos, context), true
			}
			if l.hasPrefix(quote) {
				break
			}
		}
		l.next()
		l.emit(lexemeFilterStringLiteral)

		return nextState, true
	}
	return nil, false
}

func lexBooleanLiteral(l *lexer, nextState stateFn) (stateFn, bool) {
	if l.consumedWhitespaced("true") || l.consumedWhitespaced("false") {
		l.emit(lexemeFilterBooleanLiteral)
		return nextState, true
	}
	return nil, false
}

func lexNullLiteral(l *lexer, nextState stateFn) (stateFn, bool) {
	if l.consumedWhitespaced("null") {
		l.emit(lexemeFilterNullLiteral)
		return nextState, true
	}
	return nil, false
}

var comparisonOperatorLexeme map[orderingOperator]lexemeType

func init() {
	comparisonOperatorLexeme = map[orderingOperator]lexemeType{
		operatorGreaterThan:        lexemeFilterGreaterThan,
		operatorGreaterThanOrEqual: lexemeFilterGreaterThanOrEqual,
		operatorLessThan:           lexemeFilterLessThan,
		operatorLessThanOrEqual:    lexemeFilterLessThanOrEqual,
	}
}

func lexComparison(l *lexer, comparisonOperator orderingOperator) stateFn {
	if l.lastEmittedLexemeType == lexemeFilterStringLiteral {
		return l.errorf("strings cannot be compared using %s", comparisonOperator)
	}
	l.consume(comparisonOperator.String())
	l.emit(comparisonOperatorLexeme[comparisonOperator])

	l.stripWhitespace()
	if l.hasPrefix(filterStringLiteralDelimiter) {
		return l.errorf("strings cannot be compared using %s", comparisonOperator)
	}

	l.push(lexFilterExpr)
	return lexFilterTerm
}

func lexRegularExpressionLiteral(l *lexer, nextState stateFn) stateFn {
	if !l.hasPrefix(filterRegularExpressionLiteralDelimiter) {
		return l.errorf("regular expression does not start with %s", filterRegularExpressionLiteralDelimiter)
	}
	pos := l.pos
	context := l.context()
	escape := false
	for {
		if l.next() == eof {
			return l.rawErrorf(`unmatched regular expression delimiter %s at position %d, following %q`, filterRegularExpressionLiteralDelimiter, pos, context)
		}
		if !escape && l.hasPrefix(filterRegularExpressionLiteralDelimiter) {
			break
		}
		if !escape && l.hasPrefix(filterRegularExpressionEscape) {
			escape = true
		} else {
			escape = false
		}
	}
	l.next()
	if _, err := regexp.Compile(sanitiseRegularExpressionLiteral(l.value())); err != nil {
		return l.rawErrorf(`invalid regular expression at position %d, following %q: %s`, pos, context, err)
	}
	l.emit(lexemeFilterRegularExpressionLiteral)

	return nextState
}