Package org.sonarsource.analyzer.commons.regex

Class RegexParser

java.lang.Object

org.sonarsource.analyzer.commons.regex.RegexParser

public class RegexParser
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	RegexParser.EscapedSequenceDataHolder
protected static interface	RegexParser.GroupConstructor
protected static interface	RegexParser.TreeConstructor<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected FlagSet	activeFlags
protected List<BackReferenceTree>	backReferences
protected Map<String,CapturingGroupTree>	capturingGroups
protected RegexLexer	characters
protected List<SyntaxError>	errors
protected int	groupNumber
protected RegexSource	source

Constructor Summary

Constructors

Constructor	Description
RegexParser(RegexSource source, FlagSet initialFlags)

Method Summary

Modifier and Type	Method	Description
protected CharacterRangeTree	characterRange(CharacterTree startCharacter, CharacterTree endCharacter)
protected CharacterTree	characterTree(SourceCharacter character)
protected BackReferenceTree	collect(BackReferenceTree backReference)
protected static <T extends RegexSyntaxElement> T	combineTrees(List<T> elements, RegexParser.TreeConstructor<T> treeConstructor)
ReferenceConditionTree	conditionGroupReference(RegexSource source, IndexRange range, CharacterTree plus, RegexTree inner, FlagSet activeFlags)
protected void	error(String message)
protected void	expected(String expectedToken)
protected void	expected(String expectedToken, String actual)
protected void	expected(String expectedToken, RegexSyntaxElement actual)
protected GroupTree	finishGroup(boolean previousFreeSpacingMode, SourceCharacter openingParen, RegexParser.GroupConstructor groupConstructor)
protected GroupTree	finishGroup(SourceCharacter openingParen, RegexParser.GroupConstructor groupConstructor)
protected CapturingGroupTree	index(CapturingGroupTree capturingGroup)
protected static boolean	isAsciiDigit(int c)
protected static boolean	isHexDigit(int c)
protected static boolean	isOctalDigit(int c)
protected boolean	isPlainTextCharacter(int c)
protected RegexParser.GroupConstructor	newCapturingGroup(String name)
protected RegexParser.GroupConstructor	newNamedCapturingGroup(int namePrefixLength, char nameDelimiter)
RegexParseResult	parse()
protected RegexTree	parseBoundary(SourceCharacter backslash)
protected CharacterClassTree	parseCharacterClass()
protected CharacterClassElementTree	parseCharacterClassElement(boolean isAtBeginning)
protected CharacterClassElementTree	parseCharacterClassIntersection()
protected CharacterClassElementTree	parseCharacterClassUnion(boolean isAtBeginning)
protected CharacterClassElementTree	parseCharacterRange(CharacterTree startCharacter)
protected RegexTree	parseControlSequence(SourceCharacter backslash)
protected RegexTree	parseDisjunction()
protected RegexTree	parseEscapedCharacterClass(SourceCharacter backslash)
protected RegexTree	parseEscapedProperty(SourceCharacter backslash)
protected RegexTree	parseEscapedSequence(char opener, char closer, String expected, Function<RegexParser.EscapedSequenceDataHolder,RegexTree> builder)
protected RegexTree	parseEscapeSequence()
protected int	parseFixedAmountOfHexDigits(int amount)
protected static Integer	parseFlag(char ch)
protected FlagSet	parseFlags()
protected GroupTree	parseGroup()
protected String	parseGroupName(char nameDelimiter)
protected int	parseHexDigit()
protected RegexTree	parseHexEscape(SourceCharacter backslash)
protected RegexToken	parseInteger()
protected RegexTree	parseNamedBackReference(SourceCharacter backslash)
protected RegexTree	parseNamedBackReference(SourceCharacter backslash, char opener, char closer)
protected RegexTree	parseNamedUnicodeCharacter(SourceCharacter backslash)
protected GroupTree	parseNonCapturingGroup(SourceCharacter openingParen)
protected RegexTree	parseNumericalBackReference(SourceCharacter backslash)	Parses a numerical back reference greedily, taking as many numbers as it can.
protected RegexTree	parseOctalEscape(SourceCharacter backslash)
protected PosixCharacterClassElementTree	parsePosixCharacterClass()
protected RegexTree	parsePrimaryExpression()
protected Quantifier	parseQuantifier()
protected RegexTree	parseRepetition()
protected RegexTree	parseSequence()
protected RegexTree	parseUnicodeEscape(SourceCharacter backslash)
protected CharacterTree	readCharacter()
protected static char	simpleEscapeToCharacter(char escapeCharacter)
protected boolean	supportsAnyOfFeatures(RegexFeature... features)

Methods inherited from class java.lang.Object

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

Field Detail

source

protected final RegexSource source

characters

protected final RegexLexer characters

activeFlags

protected FlagSet activeFlags

backReferences

protected final List<BackReferenceTree> backReferences

capturingGroups

protected final Map<String,CapturingGroupTree> capturingGroups

errors

protected final List<SyntaxError> errors

groupNumber

protected int groupNumber

Constructor Detail

RegexParser

public RegexParser(RegexSource source,
                   FlagSet initialFlags)

Method Detail

parse

public RegexParseResult parse()

parseDisjunction

protected RegexTree parseDisjunction()

parseSequence

protected RegexTree parseSequence()

parseRepetition

@CheckForNull
protected RegexTree parseRepetition()

parseQuantifier

@CheckForNull
protected Quantifier parseQuantifier()

parseInteger

@CheckForNull
protected RegexToken parseInteger()

parsePrimaryExpression

@CheckForNull
protected RegexTree parsePrimaryExpression()

readCharacter

protected CharacterTree readCharacter()

parseGroup

protected GroupTree parseGroup()

newNamedCapturingGroup

protected RegexParser.GroupConstructor newNamedCapturingGroup(int namePrefixLength,
                                                              char nameDelimiter)

newCapturingGroup

protected RegexParser.GroupConstructor newCapturingGroup(@Nullable
                                                         String name)

parseGroupName

protected String parseGroupName(char nameDelimiter)

parseNonCapturingGroup

protected GroupTree parseNonCapturingGroup(SourceCharacter openingParen)

conditionGroupReference

public ReferenceConditionTree conditionGroupReference(RegexSource source,
                                                      IndexRange range,
                                                      @Nullable
                                                      CharacterTree plus,
                                                      RegexTree inner,
                                                      FlagSet activeFlags)

parseFlags

protected FlagSet parseFlags()

parseFlag

@CheckForNull
protected static Integer parseFlag(char ch)

finishGroup

protected GroupTree finishGroup(SourceCharacter openingParen,
                                RegexParser.GroupConstructor groupConstructor)

finishGroup

protected GroupTree finishGroup(boolean previousFreeSpacingMode,
                                SourceCharacter openingParen,
                                RegexParser.GroupConstructor groupConstructor)

parseEscapeSequence

protected RegexTree parseEscapeSequence()

parseNamedUnicodeCharacter

protected RegexTree parseNamedUnicodeCharacter(SourceCharacter backslash)

parseControlSequence

protected RegexTree parseControlSequence(SourceCharacter backslash)

simpleEscapeToCharacter

protected static char simpleEscapeToCharacter(char escapeCharacter)

parseUnicodeEscape

protected RegexTree parseUnicodeEscape(SourceCharacter backslash)

parseHexEscape

protected RegexTree parseHexEscape(SourceCharacter backslash)

parseFixedAmountOfHexDigits

protected int parseFixedAmountOfHexDigits(int amount)

parseHexDigit

protected int parseHexDigit()

parseEscapedCharacterClass

protected RegexTree parseEscapedCharacterClass(SourceCharacter backslash)

parseEscapedProperty

protected RegexTree parseEscapedProperty(SourceCharacter backslash)

parseNamedBackReference

protected RegexTree parseNamedBackReference(SourceCharacter backslash)

parseNamedBackReference

protected RegexTree parseNamedBackReference(SourceCharacter backslash,
                                            char opener,
                                            char closer)

collect

protected BackReferenceTree collect(BackReferenceTree backReference)

index

protected CapturingGroupTree index(CapturingGroupTree capturingGroup)

parseEscapedSequence

protected RegexTree parseEscapedSequence(char opener,
                                         char closer,
                                         String expected,
                                         Function<RegexParser.EscapedSequenceDataHolder,RegexTree> builder)

parseNumericalBackReference

protected RegexTree parseNumericalBackReference(SourceCharacter backslash)

Parses a numerical back reference greedily, taking as many numbers as it can. The first digit is always treated as a back reference, but multi digit numbers are only treated as a back reference if at least that many back references exist at this point in the regex. See Pattern.ref(int refNum)

parseOctalEscape

protected RegexTree parseOctalEscape(SourceCharacter backslash)

parseBoundary

protected RegexTree parseBoundary(SourceCharacter backslash)

parseCharacterClass

protected CharacterClassTree parseCharacterClass()

parseCharacterClassIntersection

protected CharacterClassElementTree parseCharacterClassIntersection()

parseCharacterClassUnion

protected CharacterClassElementTree parseCharacterClassUnion(boolean isAtBeginning)

parseCharacterClassElement

@CheckForNull
protected CharacterClassElementTree parseCharacterClassElement(boolean isAtBeginning)

parsePosixCharacterClass

@CheckForNull
protected PosixCharacterClassElementTree parsePosixCharacterClass()

parseCharacterRange

protected CharacterClassElementTree parseCharacterRange(CharacterTree startCharacter)

characterTree

protected CharacterTree characterTree(SourceCharacter character)

characterRange

protected CharacterRangeTree characterRange(CharacterTree startCharacter,
                                            CharacterTree endCharacter)

expected

protected void expected(String expectedToken,
                        String actual)

expected

protected void expected(String expectedToken,
                        RegexSyntaxElement actual)

expected

protected void expected(String expectedToken)

error

protected void error(String message)

supportsAnyOfFeatures

protected boolean supportsAnyOfFeatures(RegexFeature... features)

combineTrees

protected static <T extends RegexSyntaxElement> T combineTrees(List<T> elements,
                                                               RegexParser.TreeConstructor<T> treeConstructor)

isAsciiDigit

protected static boolean isAsciiDigit(int c)

isOctalDigit

protected static boolean isOctalDigit(int c)

isHexDigit

protected static boolean isHexDigit(int c)

isPlainTextCharacter

protected boolean isPlainTextCharacter(int c)