Class NodePattern

Pattern for matching node envelopes.

Corresponds to the Rust NodePattern enum in node_pattern.rs

Implements

Matcher

Index

Accessors

Methods

any interval fromInterval withSubject subjectPattern assertionPatterns pathsWithCaptures paths matches compile isComplex toString equals hashCode

Accessors

patternType

get patternType(): NodePatternType
Gets the pattern type.

Returns NodePatternType
- Defined in envelope-pattern/src/pattern/structure/node-pattern.ts:78

Methods

`Static`any

any(): NodePattern
Creates a new NodePattern that matches any node.

Returns NodePattern
- Defined in envelope-pattern/src/pattern/structure/node-pattern.ts:49

`Static`interval

interval(min: number, max?: number): NodePattern
Creates a new NodePattern that matches a node with the specified count of assertions.
Parameters
- min: number
- Optionalmax: number
Returns NodePattern
- Defined in envelope-pattern/src/pattern/structure/node-pattern.ts:56

`Static`fromInterval

fromInterval(interval: Interval): NodePattern
Creates a new NodePattern from an Interval.
Parameters
- interval: Interval
Returns NodePattern
- Defined in envelope-pattern/src/pattern/structure/node-pattern.ts:64

`Static`withSubject

withSubject(subjectPattern: Pattern): NodePattern
Creates a new NodePattern with a subject pattern constraint.
Parameters
- subjectPattern: Pattern
Returns NodePattern
- Defined in envelope-pattern/src/pattern/structure/node-pattern.ts:71

subjectPattern

subjectPattern(): Pattern | undefined
Gets the subject pattern if this is a WithSubject type, undefined otherwise.

Returns Pattern | undefined
- Defined in envelope-pattern/src/pattern/structure/node-pattern.ts:85

assertionPatterns

assertionPatterns(): Pattern[]
Gets the assertion patterns (empty array if none).

Returns Pattern[]
- Defined in envelope-pattern/src/pattern/structure/node-pattern.ts:92

pathsWithCaptures

pathsWithCaptures(haystack: Envelope): [Path[], Map<string, Path[]>]
Return all matching paths along with any named captures.
Parameters
- haystack: Envelope
Returns [Path[], Map<string, Path[]>]
Implementation of Matcher.pathsWithCaptures
- Defined in envelope-pattern/src/pattern/structure/node-pattern.ts:97

paths

paths(haystack: Envelope): Path[]
Return only the matching paths, discarding any captures.
Parameters
- haystack: Envelope
Returns Path[]
Implementation of Matcher.paths
- Defined in envelope-pattern/src/pattern/structure/node-pattern.ts:121

matches

matches(haystack: Envelope): boolean
Returns true if the pattern matches the haystack.
Parameters
- haystack: Envelope
Returns boolean
Implementation of Matcher.matches
- Defined in envelope-pattern/src/pattern/structure/node-pattern.ts:125

compile

compile(code: Instr[], literals: Pattern[], captures: string[]): void
Compile this pattern to bytecode.
Parameters
- code: Instr[]
- literals: Pattern[]
- captures: string[]
Returns void
Implementation of Matcher.compile
- Defined in envelope-pattern/src/pattern/structure/node-pattern.ts:129

isComplex

isComplex(): boolean
Returns true if the Display of the matcher is complex, i.e. contains nested patterns or other complex structures that require its text rendering to be surrounded by grouping parentheses.

Returns boolean
Implementation of Matcher.isComplex
- Defined in envelope-pattern/src/pattern/structure/node-pattern.ts:136

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in envelope-pattern/src/pattern/structure/node-pattern.ts:140

equals

equals(other: NodePattern): boolean
Equality comparison.
Parameters
- other: NodePattern
Returns boolean
- Defined in envelope-pattern/src/pattern/structure/node-pattern.ts:154

hashCode

hashCode(): number
Hash code for use in Maps/Sets.

Returns number
- Defined in envelope-pattern/src/pattern/structure/node-pattern.ts:177