Class XPath20Parser

Recursive descent parser shared by XPath 1.0+ implementations.

Grammar (simplified): Expr ::= OrExpr OrExpr ::= AndExpr ('or' AndExpr)* AndExpr ::= EqualityExpr ('and' EqualityExpr)* EqualityExpr ::= RelationalExpr (('=' | '!=') RelationalExpr)* RelationalExpr ::= AdditiveExpr (('<' | '>' | '<=' | '>=') AdditiveExpr)* AdditiveExpr ::= MultiplicativeExpr (('+' | '-') MultiplicativeExpr)* MultiplicativeExpr ::= UnaryExpr (('' | 'div' | 'mod') UnaryExpr) UnaryExpr ::= '-'* UnionExpr UnionExpr ::= PathExpr ('|' PathExpr)* PathExpr ::= LocationPath | FilterExpr (('/' | '//') RelativeLocationPath)? FilterExpr ::= PrimaryExpr Predicate* PrimaryExpr ::= VariableReference | '(' Expr ')' | Literal | Number | FunctionCall LocationPath ::= RelativeLocationPath | AbsoluteLocationPath Step ::= AxisSpecifier NodeTest Predicate* | AbbreviatedStep Predicate ::= '[' Expr ']'

Hierarchy (View Summary)

XPathBaseParser
- XPath20Parser
  - XPath30Parser

Constructors

constructor

new XPath20Parser(options?: XPathBaseParserOptions): XPath20Parser
Parameters
- Optionaloptions: XPathBaseParserOptions
Returns XPath20Parser
Overrides XPathBaseParser.constructor
- Defined in parser/parser-20.ts:27

Properties

`Protected`tokens

tokens: XPathToken[] = []

`Protected`current

current: number = 0

`Protected`warningCollector

warningCollector: WarningCollector

Methods

getWarningCollector

getWarningCollector(): WarningCollector
Get the warning collector for this parser. Useful for retrieving warnings after parsing.

Returns WarningCollector
Inherited from XPathBaseParser.getWarningCollector
- Defined in parser/base-parser.ts:106

`Protected`ensureVersionSupport

ensureVersionSupport(
supportedVersions: XPathVersion[],
defaultVersion: XPathVersion,
): void
Enforce the supported XPath versions for a concrete parser.
Parameters
- supportedVersions: XPathVersion[]
- defaultVersion: XPathVersion
Returns void
Inherited from XPathBaseParser.ensureVersionSupport
- Defined in parser/base-parser.ts:113

getOptions

getOptions(): Readonly<XPathBaseParserOptions>
Get the parser options.

Returns Readonly<XPathBaseParserOptions>
Inherited from XPathBaseParser.getOptions
- Defined in parser/base-parser.ts:131

parse

parse(tokens: XPathToken[]): XPathExpression
Parameters
- tokens: XPathToken[]
Returns XPathExpression
Inherited from XPathBaseParser.parse
- Defined in parser/base-parser.ts:135

`Protected`peek

peek(): XPathToken
Returns XPathToken
Inherited from XPathBaseParser.peek
- Defined in parser/base-parser.ts:167

`Protected`peekNext

peekNext(): XPathToken
Returns XPathToken
Inherited from XPathBaseParser.peekNext
- Defined in parser/base-parser.ts:171

`Protected`previous

previous(): XPathToken
Returns XPathToken
Inherited from XPathBaseParser.previous
- Defined in parser/base-parser.ts:175

`Protected`isAtEnd

isAtEnd(): boolean
Returns boolean
Inherited from XPathBaseParser.isAtEnd
- Defined in parser/base-parser.ts:179

`Protected`advance

advance(): XPathToken
Returns XPathToken
Inherited from XPathBaseParser.advance
- Defined in parser/base-parser.ts:183

`Protected`check

check(type: TokenType): boolean
Parameters
- type: TokenType
Returns boolean
Inherited from XPathBaseParser.check
- Defined in parser/base-parser.ts:188

`Protected`checkLexeme

checkLexeme(lexeme: string): boolean
Parameters
- lexeme: string
Returns boolean
Inherited from XPathBaseParser.checkLexeme
- Defined in parser/base-parser.ts:193

`Protected`match

match(...types: TokenType[]): boolean
Parameters
- ...types: TokenType[]
Returns boolean
Inherited from XPathBaseParser.match
- Defined in parser/base-parser.ts:198

`Protected`consume

consume(type: TokenType, message: string): XPathToken
Parameters
- type: TokenType
- message: string
Returns XPathToken
Inherited from XPathBaseParser.consume
- Defined in parser/base-parser.ts:208

`Protected`parseOrExpr

parseOrExpr(): XPathExpression
Returns XPathExpression
Inherited from XPathBaseParser.parseOrExpr
- Defined in parser/base-parser.ts:219

`Protected`parseAndExpr

parseAndExpr(): XPathExpression
Returns XPathExpression
Inherited from XPathBaseParser.parseAndExpr
- Defined in parser/base-parser.ts:231

`Protected`parseEqualityExpr

parseEqualityExpr(): XPathExpression
Returns XPathExpression
Inherited from XPathBaseParser.parseEqualityExpr
- Defined in parser/base-parser.ts:243

`Protected`parseRelationalExpr

parseRelationalExpr(): XPathExpression
Returns XPathExpression
Inherited from XPathBaseParser.parseRelationalExpr
- Defined in parser/base-parser.ts:255

`Protected`parseMultiplicativeExpr

parseMultiplicativeExpr(): XPathExpression
Returns XPathExpression
Inherited from XPathBaseParser.parseMultiplicativeExpr
- Defined in parser/base-parser.ts:281

`Protected`parseUnaryExpr

parseUnaryExpr(): XPathExpression
Returns XPathExpression
Inherited from XPathBaseParser.parseUnaryExpr
- Defined in parser/base-parser.ts:303

`Protected`parsePathExpr

parsePathExpr(): XPathExpression
Returns XPathExpression
Inherited from XPathBaseParser.parsePathExpr
- Defined in parser/base-parser.ts:325

`Protected`isStepStart

isStepStart(): boolean
Returns boolean
Inherited from XPathBaseParser.isStepStart
- Defined in parser/base-parser.ts:359

`Protected`parseLocationPath

parseLocationPath(): XPathExpression
Returns XPathExpression
Inherited from XPathBaseParser.parseLocationPath
- Defined in parser/base-parser.ts:416

`Protected`parseRelativeLocationPath

parseRelativeLocationPath(): XPathStep[]
Returns XPathStep[]
Inherited from XPathBaseParser.parseRelativeLocationPath
- Defined in parser/base-parser.ts:443

`Protected`parseStep

parseStep(): XPathStep
Returns XPathStep
Inherited from XPathBaseParser.parseStep
- Defined in parser/base-parser.ts:464

`Protected`parseNodeTest

parseNodeTest(): NodeTest
Returns NodeTest
Inherited from XPathBaseParser.parseNodeTest
- Defined in parser/base-parser.ts:505

`Protected`parsePredicates

parsePredicates(): XPathExpression[]
Returns XPathExpression[]
Inherited from XPathBaseParser.parsePredicates
- Defined in parser/base-parser.ts:622

`Protected`parseFilterExpr

parseFilterExpr(): XPathExpression
Returns XPathExpression
Inherited from XPathBaseParser.parseFilterExpr
- Defined in parser/base-parser.ts:636

`Protected`parseFunctionCall

parseFunctionCall(): XPathExpression
Returns XPathExpression
Inherited from XPathBaseParser.parseFunctionCall
- Defined in parser/base-parser.ts:695

`Protected`parseExpr

parseExpr(): XPathExpression
Returns XPathExpression
Overrides XPathBaseParser.parseExpr
- Defined in parser/parser-20.ts:34

`Protected`parseUnionExpr

parseUnionExpr(): XPathExpression
Returns XPathExpression
Overrides XPathBaseParser.parseUnionExpr
- Defined in parser/parser-20.ts:46

`Protected`parsePrimaryExpr

parsePrimaryExpr(): XPathExpression
Returns XPathExpression
Overrides XPathBaseParser.parsePrimaryExpr
- Defined in parser/parser-20.ts:57

`Protected`parseSequenceType

parseSequenceType(): SequenceType
Returns SequenceType
- Defined in parser/parser-20.ts:178

`Protected`parseAdditiveExpr

parseAdditiveExpr(): XPathExpression
Override parseAdditiveExpr to insert range expression (to) parsing. Precedence: AdditiveExpr -> RangeExpr -> MultiplicativeExpr

Returns XPathExpression
Overrides XPathBaseParser.parseAdditiveExpr
- Defined in parser/parser-20.ts:261

`Protected`parseRangeExpr

parseRangeExpr(): XPathExpression
Parse range expression (to). Syntax: expr to expr Returns a sequence of consecutive integers from start to end.

Returns XPathExpression
- Defined in parser/parser-20.ts:278

Class XPath20Parser

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns XPath20Parser

Properties

Protectedtokens

Protectedcurrent

Protected Optionalextensions

Protectedoptions

ProtectedstaticContext

ProtectedwarningCollector

Methods

getWarningCollector

Returns WarningCollector

ProtectedensureVersionSupport

Parameters

Returns void

getOptions

Returns Readonly<XPathBaseParserOptions>

parse

Parameters

Returns XPathExpression

Protectedpeek

Returns XPathToken

ProtectedpeekNext

Returns XPathToken

Protectedprevious

Returns XPathToken

ProtectedisAtEnd

Returns boolean

Protectedadvance

Returns XPathToken

Protectedcheck

Parameters

Returns boolean

ProtectedcheckLexeme

Parameters

Returns boolean

Protectedmatch

Parameters

Returns boolean

Protectedconsume

Parameters

Returns XPathToken

ProtectedparseOrExpr

Returns XPathExpression

ProtectedparseAndExpr

Returns XPathExpression

ProtectedparseEqualityExpr

Returns XPathExpression

ProtectedparseRelationalExpr

Returns XPathExpression

ProtectedparseMultiplicativeExpr

Returns XPathExpression

ProtectedparseUnaryExpr

Returns XPathExpression

ProtectedparsePathExpr

Returns XPathExpression

ProtectedisStepStart

Returns boolean

ProtectedparseLocationPath

Returns XPathExpression

ProtectedparseRelativeLocationPath

Returns XPathStep[]

ProtectedparseStep

Returns XPathStep

ProtectedparseNodeTest

Returns NodeTest

ProtectedparsePredicates

Returns XPathExpression[]

ProtectedparseFilterExpr

Returns XPathExpression

ProtectedparseFunctionCall

Returns XPathExpression

`Protected`tokens

`Protected`current

`Protected` `Optional`extensions

`Protected`options

`Protected`staticContext

`Protected`warningCollector

`Protected`ensureVersionSupport

`Protected`peek

`Protected`peekNext

`Protected`previous

`Protected`isAtEnd

`Protected`advance

`Protected`check

`Protected`checkLexeme

`Protected`match

`Protected`consume

`Protected`parseOrExpr

`Protected`parseAndExpr

`Protected`parseEqualityExpr

`Protected`parseRelationalExpr

`Protected`parseMultiplicativeExpr

`Protected`parseUnaryExpr

`Protected`parsePathExpr

`Protected`isStepStart

`Protected`parseLocationPath

`Protected`parseRelativeLocationPath

`Protected`parseStep

`Protected`parseNodeTest

`Protected`parsePredicates

`Protected`parseFilterExpr

`Protected`parseFunctionCall

`Protected`parseExpr

`Protected`parseUnionExpr

`Protected`parsePrimaryExpr

`Protected`parseSequenceType

`Protected`parseAdditiveExpr

`Protected`parseRangeExpr