com.oracle.truffle.regex.tregex.parser.ast

Class CharacterClass

java.lang.Object

com.oracle.truffle.regex.tregex.parser.ast.RegexASTNode

com.oracle.truffle.regex.tregex.parser.ast.Term

com.oracle.truffle.regex.tregex.parser.ast.QuantifiableTerm

com.oracle.truffle.regex.tregex.parser.ast.CharacterClass

All Implemented Interfaces:

AbstractState<Term,ASTTransition>, JsonConvertible

public class CharacterClass
extends QuantifiableTerm

A Term that matches characters belonging to a specified set of characters.

Corresponds to the right-hand sides PatternCharacter, . and CharacterClass of the goal symbol Atom and the right-hand sides CharacterClassEscape and CharacterEscape of the goal symbol AtomEscape in the ECMAScript RegExp syntax.

Note that CharacterClass nodes and the CodePointSets that they rely on can only match characters from the Basic Multilingual Plane (and whose code point fits into 16-bit integers). Any term which matches characters outside of the Basic Multilingual Plane is expanded by RegexParser into a more complex expression which matches the individual code units that would make up the UTF-16 encoding of those characters.

Method Summary

Modifier and Type	Method and Description
void	addLookBehindEntry(RegexAST ast, LookBehindAssertion lookBehindEntry)
CharacterClass	copy(RegexAST ast, boolean recursive) Copy this node, in one of the following ways: if recursive is true, recursively copy this subtree.
boolean	equalsSemantic(RegexASTNode obj, boolean ignoreQuantifier)
void	extractSingleChar(char[] literal, char[] mask, int i)
void	extractSingleChar(CharArrayBuffer literal, CharArrayBuffer mask)
CodePointSet	getCharSet() Returns the CodePointSet representing the set of characters that can be matched by this CharacterClass.
Set<LookBehindAssertion>	getLookBehindEntries() Returns the (fixed-length) look-behind assertions whose first characters can match the same character as this node.
Sequence	getParent() Gets the syntactic parent of this AST node.
boolean	hasLookBehindEntries()
boolean	isUnrollingCandidate() Returns true iff the parser should try to unroll this term's quantifier.
void	setCharSet(CodePointSet charSet)
void	setWasSingleChar()
void	setWasSingleChar(boolean value)
JsonValue	toJson()
String	toString()
boolean	wasSingleChar()

Methods inherited from class com.oracle.truffle.regex.tregex.parser.ast.QuantifiableTerm

equalsSemantic, getQuantifier, getSubTreeParent, hasNotUnrolledQuantifier, hasQuantifier, quantifierToString, setQuantifier

Methods inherited from class com.oracle.truffle.regex.tregex.parser.ast.Term

getSeqIndex, setSeqIndex

Methods inherited from class com.oracle.truffle.regex.tregex.parser.ast.RegexASTNode

asBackReference, asCharacterClass, asGroup, asLookAheadAssertion, asLookAroundAssertion, asLookBehindAssertion, asMatchFound, asPositionAssertion, asQuantifiableTerm, asSequence, astNodeId, endsWithDollar, getFlags, getId, getMaxPath, getMinPath, hasBackReferences, hasCaptureGroups, hasCaret, hasDollar, hasEmptyGuard, hasLookAheads, hasLookBehinds, hasLoops, hasQuantifiers, idInitialized, incMaxPath, incMaxPath, incMinPath, incMinPath, isBackReference, isCaret, isCharacterClass, isDead, isDollar, isExpandedQuantifier, isFlagSet, isGroup, isInLookAheadAssertion, isInLookBehindAssertion, isLookAheadAssertion, isLookAroundAssertion, isLookBehindAssertion, isMatchFound, isPositionAssertion, isPrefix, isQuantifiableTerm, isRoot, isSequence, isSubtreeRoot, markAsDead, setDead, setEmptyGuard, setEndsWithDollar, setEndsWithDollar, setExpandedQuantifier, setFlag, setFlag, setFlags, setHasBackReferences, setHasCaptureGroups, setHasCaret, setHasCaret, setHasDollar, setHasDollar, setHasLookAheads, setHasLookBehinds, setHasLoops, setHasLoops, setHasQuantifiers, setId, setMaxPath, setMinPath, setParent, setPrefix, setStartsWithCaret, setStartsWithCaret, startsWithCaret, toJson, toStringWithID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.oracle.truffle.regex.tregex.automaton.AbstractState

getId

Method Detail

copy

public CharacterClass copy(RegexAST ast,
                           boolean recursive)

Description copied from class: RegexASTNode

Copy this node, in one of the following ways:

• if recursive is true, recursively copy this subtree. This method should be used instead of CopyVisitor if the copying process is required to be thread-safe.
• else, copy this node only, without any child nodes.

In both cases, the ID and minPath of the copied nodes is left unset.

Specified by:

copy in class QuantifiableTerm

Parameters:

ast - RegexAST the new nodes should belong to.

Returns:

A shallow or deep copy of this node.

getParent

public Sequence getParent()

Description copied from class: RegexASTNode

Gets the syntactic parent of this AST node.

Overrides:

getParent in class RegexASTNode

getCharSet

public CodePointSet getCharSet()

Returns the CodePointSet representing the set of characters that can be matched by this CharacterClass.

setCharSet

public void setCharSet(CodePointSet charSet)

wasSingleChar

public boolean wasSingleChar()

setWasSingleChar

public void setWasSingleChar()

setWasSingleChar

public void setWasSingleChar(boolean value)

isUnrollingCandidate

public boolean isUnrollingCandidate()

Description copied from class: QuantifiableTerm

Returns true iff the parser should try to unroll this term's quantifier.

Specified by:

isUnrollingCandidate in class QuantifiableTerm

addLookBehindEntry

public void addLookBehindEntry(RegexAST ast,
                               LookBehindAssertion lookBehindEntry)

hasLookBehindEntries

public boolean hasLookBehindEntries()

getLookBehindEntries

public Set<LookBehindAssertion> getLookBehindEntries()

Returns the (fixed-length) look-behind assertions whose first characters can match the same character as this node. Note that the set contains the Group bodies of the LookBehindAssertion nodes, not the LookBehindAssertion nodes themselves.

extractSingleChar

public void extractSingleChar(CharArrayBuffer literal,
                              CharArrayBuffer mask)

extractSingleChar

public void extractSingleChar(char[] literal,
                              char[] mask,
                              int i)

equalsSemantic

public boolean equalsSemantic(RegexASTNode obj,
                              boolean ignoreQuantifier)

Specified by:

equalsSemantic in class QuantifiableTerm

toString

public String toString()

Overrides:

toString in class Object

toJson

public JsonValue toJson()