Package org.opengrok.indexer.analysis

Class JFlexSymbolMatcher

java.lang.Object

org.opengrok.indexer.analysis.JFlexStateStacker

org.opengrok.indexer.analysis.JFlexSymbolMatcher

All Implemented Interfaces:

JFlexLexer, JFlexStackingLexer, Resettable, ScanningSymbolMatcher, SymbolMatchedPublisher

Direct Known Subclasses:

AdaSymbolTokenizer, AdaXref, AsmSymbolTokenizer, AsmXref, ClojureSymbolTokenizer, ClojureXref, CSharpSymbolTokenizer, CSharpXref, CSymbolTokenizer, CXref, CxxSymbolTokenizer, CxxXref, EiffelSymbolTokenizer, EiffelXref, ErlangSymbolTokenizer, ErlangXref, FortranSymbolTokenizer, FortranXref, GolangSymbolTokenizer, GolangXref, HaskellSymbolTokenizer, HaskellXref, HCLLexer, JavaScriptLexer, JavaSymbolTokenizer, JavaXref, JsonSymbolTokenizer, JsonXref, KotlinSymbolTokenizer, KotlinXref, LispSymbolTokenizer, LispXref, LuaSymbolTokenizer, LuaXref, PascalSymbolTokenizer, PascalXref, PerlSymbolTokenizer, PerlXref, PhpSymbolTokenizer, PhpXref, PlainFullTokenizer, PlainSymbolTokenizer, PlainXref, PLSQLSymbolTokenizer, PLSQLXref, PoshSymbolTokenizer, PoshXref, PythonSymbolTokenizer, PythonXref, RLexer, RubySymbolTokenizer, RubyXref, RustSymbolTokenizer, RustXref, ScalaSymbolTokenizer, ScalaXref, ShSymbolTokenizer, ShXref, SQLSymbolTokenizer, SQLXref, SwiftSymbolTokenizer, SwiftXref, TclSymbolTokenizer, TclXref, TroffFullTokenizer, UuencodeFullTokenizer, UuencodeXref, VBSymbolTokenizer, VBXref, VerilogSymbolTokenizer, VerilogXref, XMLXref, YamlSymbolTokenizer, YamlXref

public abstract class JFlexSymbolMatcher
extends JFlexStateStacker
implements ScanningSymbolMatcher

Represents an abstract base class for subclasses of JFlexStateStacker that can publish as ScanningSymbolMatcher.

Field Summary

Fields inherited from class org.opengrok.indexer.analysis.JFlexStateStacker

lineNumber, stack

Constructor Summary

Constructors

Constructor	Description
JFlexSymbolMatcher()

Method Summary

Modifier and Type	Method	Description
void	clearNonSymbolMatchedListener()	Clears any association to a listener.
void	clearSymbolMatchedListener()	Clears any association to a listener.
protected String	getDisjointSpanClassName()	Gets the class name value from the last call to onDisjointSpanChanged(String, long).
protected void	onDisjointSpanChanged(String className, long position)	Raises NonSymbolMatchedListener.disjointSpanChanged(org.opengrok.indexer.analysis.DisjointSpanChangedEvent) for a subscribed listener.
protected void	onEmailAddressMatched(String str, long start)	Raises NonSymbolMatchedListener.linkageMatched(org.opengrok.indexer.analysis.LinkageMatchedEvent) of LinkageType.EMAIL for a subscribed listener.
protected void	onEndOfLineMatched(String str, long start)	Calls JFlexStateStacker.setLineNumber(int) with the sum of JFlexStateStacker.getLineNumber() and the number of LFs in str, and then raises NonSymbolMatchedListener.endOfLineMatched(org.opengrok.indexer.analysis.TextMatchedEvent) for a subscribed listener.
protected void	onFilelikeMatched(String str, long start)	Raises NonSymbolMatchedListener.linkageMatched(org.opengrok.indexer.analysis.LinkageMatchedEvent) of LinkageType.FILELIKE for a subscribed listener.
protected boolean	onFilteredSymbolMatched(String str, long start, Set<String> keywords)	Calls onFilteredSymbolMatched(String, long, Set, boolean) with str, start, keywords, and true.
protected boolean	onFilteredSymbolMatched(String str, long start, Set<String> keywords, boolean caseSensitive)	Raises onKeywordMatched(String, long) if keywords is not null and str is found as a member (in a case-sensitive or case-less search per caseSensitive); otherwise raises onSymbolMatched(String, long).
protected void	onKeywordMatched(String str, long start)	Raises NonSymbolMatchedListener.keywordMatched(org.opengrok.indexer.analysis.TextMatchedEvent) for a subscribed listener.
protected void	onLabelDefMatched(String str, long start)	Raises NonSymbolMatchedListener.linkageMatched(org.opengrok.indexer.analysis.LinkageMatchedEvent) of LinkageType.LABELDEF for a subscribed listener.
protected void	onLabelMatched(String str, long start, String lstr)	Raises NonSymbolMatchedListener.linkageMatched(org.opengrok.indexer.analysis.LinkageMatchedEvent) of LinkageType.LABEL for a subscribed listener.
protected void	onNonSymbolMatched(char c, long start)	Calls onNonSymbolMatched(String, long) with the String.valueOf(char) c and start.
protected void	onNonSymbolMatched(String str, long start)	Raises NonSymbolMatchedListener.nonSymbolMatched(org.opengrok.indexer.analysis.TextMatchedEvent) for a subscribed listener.
protected void	onNonSymbolMatched(String str, EmphasisHint hint, long start)	Raises NonSymbolMatchedListener.nonSymbolMatched(org.opengrok.indexer.analysis.TextMatchedEvent) for a subscribed listener.
protected void	onPathlikeMatched(String str, char sep, boolean canonicalize, long start)	Raises NonSymbolMatchedListener.pathlikeMatched(org.opengrok.indexer.analysis.PathlikeMatchedEvent) for a subscribed listener.
protected void	onQueryTermMatched(String str, long start)	Raises NonSymbolMatchedListener.linkageMatched(org.opengrok.indexer.analysis.LinkageMatchedEvent) of LinkageType.QUERY for a subscribed listener.
protected void	onRefsTermMatched(String str, long start)	Raises NonSymbolMatchedListener.linkageMatched(org.opengrok.indexer.analysis.LinkageMatchedEvent) of LinkageType.REFS for a subscribed listener.
protected void	onScopeChanged(ScopeAction action, String str, long start)	Raises NonSymbolMatchedListener.scopeChanged(org.opengrok.indexer.analysis.ScopeChangedEvent) for a subscribed listener.
protected void	onSourceCodeSeen(long start)	Raises SymbolMatchedListener.sourceCodeSeen(org.opengrok.indexer.analysis.SourceCodeSeenEvent) for all subscribed listeners in turn.
protected void	onSymbolMatched(String str, long start)	Raises SymbolMatchedListener.symbolMatched(org.opengrok.indexer.analysis.SymbolMatchedEvent) for a subscribed listener.
protected void	onUriMatched(String uri, long start)	Calls onUriMatched(String, long, Pattern) with uri, start, and null.
protected void	onUriMatched(String uri, long start, Pattern collateralCapture)	Raises NonSymbolMatchedListener.linkageMatched(org.opengrok.indexer.analysis.LinkageMatchedEvent) of LinkageType.URI for a subscribed listener.
void	setNonSymbolMatchedListener(NonSymbolMatchedListener l)	Associates the specified listener, replacing the former one.
void	setSymbolMatchedListener(SymbolMatchedListener l)	Associates the specified listener, replacing the former one.

Methods inherited from class org.opengrok.indexer.analysis.JFlexStateStacker

clearStack, emptyStack, getLineNumber, getYYEOF, reset, setLineNumber, yyjump, yypop, yypush

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opengrok.indexer.analysis.JFlexLexer

yybegin, yycharat, yyclose, yylength, yylex, yypushback, yyreset, yystate, yytext

Methods inherited from interface org.opengrok.indexer.analysis.JFlexStackingLexer

emptyStack, getLineNumber, getYYCHAR, getYYEOF, yypop, yypush

Methods inherited from interface org.opengrok.indexer.analysis.Resettable

reset

Constructor Details

JFlexSymbolMatcher

public JFlexSymbolMatcher()

Method Details

setSymbolMatchedListener

public void setSymbolMatchedListener(SymbolMatchedListener l)

Associates the specified listener, replacing the former one.

Specified by:

setSymbolMatchedListener in interface SymbolMatchedPublisher

Parameters:

l - defined instance

clearSymbolMatchedListener

public void clearSymbolMatchedListener()

Clears any association to a listener.

Specified by:

clearSymbolMatchedListener in interface SymbolMatchedPublisher

setNonSymbolMatchedListener

public void setNonSymbolMatchedListener(NonSymbolMatchedListener l)

Associates the specified listener, replacing the former one.

Specified by:

setNonSymbolMatchedListener in interface SymbolMatchedPublisher

Parameters:

l - defined instance

clearNonSymbolMatchedListener

public void clearNonSymbolMatchedListener()

Clears any association to a listener.

Specified by:

clearNonSymbolMatchedListener in interface SymbolMatchedPublisher

getDisjointSpanClassName

protected String getDisjointSpanClassName()

Gets the class name value from the last call to onDisjointSpanChanged(String, long).

Returns:

a defined value or null

onSymbolMatched

protected void onSymbolMatched(String str,
 long start)

Raises SymbolMatchedListener.symbolMatched(org.opengrok.indexer.analysis.SymbolMatchedEvent) for a subscribed listener.

Parameters:

str - the symbol string

start - the symbol start position

onSourceCodeSeen

protected void onSourceCodeSeen(long start)

Raises SymbolMatchedListener.sourceCodeSeen(org.opengrok.indexer.analysis.SourceCodeSeenEvent) for all subscribed listeners in turn.

Parameters:

start - the source code start position

onNonSymbolMatched

protected void onNonSymbolMatched(char c,
 long start)

Calls onNonSymbolMatched(String, long) with the String.valueOf(char) c and start.

Parameters:

c - the text character

start - the text start position

onNonSymbolMatched

protected void onNonSymbolMatched(String str,
 long start)

Raises NonSymbolMatchedListener.nonSymbolMatched(org.opengrok.indexer.analysis.TextMatchedEvent) for a subscribed listener.

Parameters:

str - the text string

start - the text start position

onNonSymbolMatched

protected void onNonSymbolMatched(String str,
 EmphasisHint hint,
 long start)

Raises NonSymbolMatchedListener.nonSymbolMatched(org.opengrok.indexer.analysis.TextMatchedEvent) for a subscribed listener.

Parameters:

str - the text string

hint - the text hint

start - the text start position

onKeywordMatched

protected void onKeywordMatched(String str,
 long start)

Raises NonSymbolMatchedListener.keywordMatched(org.opengrok.indexer.analysis.TextMatchedEvent) for a subscribed listener.

Parameters:

str - the text string

start - the text start position

onEndOfLineMatched

protected void onEndOfLineMatched(String str,
 long start)

Calls JFlexStateStacker.setLineNumber(int) with the sum of JFlexStateStacker.getLineNumber() and the number of LFs in str, and then raises NonSymbolMatchedListener.endOfLineMatched(org.opengrok.indexer.analysis.TextMatchedEvent) for a subscribed listener.

Parameters:

str - the text string

start - the text start position

onDisjointSpanChanged

protected void onDisjointSpanChanged(String className,
 long position)

Raises NonSymbolMatchedListener.disjointSpanChanged(org.opengrok.indexer.analysis.DisjointSpanChangedEvent) for a subscribed listener.

Parameters:

className - the text string

position - the text position

onUriMatched

protected void onUriMatched(String uri,
 long start)

Calls onUriMatched(String, long, Pattern) with uri, start, and null.

Parameters:

uri - the URI string

start - the URI start position

onUriMatched

protected void onUriMatched(String uri,
 long start,
 Pattern collateralCapture)

Raises NonSymbolMatchedListener.linkageMatched(org.opengrok.indexer.analysis.LinkageMatchedEvent) of LinkageType.URI for a subscribed listener.

First, the end of uri is possibly trimmed (with a corresponding call to JFlexLexer.yypushback(int)) based on the result of StringUtils.countURIEndingPushback(java.lang.String) and optionally StringUtils.countPushback(java.lang.String, java.util.regex.Pattern) if collateralCapture is not null.

If the pushback count is equal to the length of url, then it is simply written -- and nothing is pushed back -- in order to avoid a never-ending yylex() loop.

Parameters:

uri - the URI string

start - the URI start position

collateralCapture - optional pattern to indicate characters which may have been captured as valid URI characters but in a particular context should mark the start of a pushback

onFilelikeMatched

protected void onFilelikeMatched(String str,
 long start)

Raises NonSymbolMatchedListener.linkageMatched(org.opengrok.indexer.analysis.LinkageMatchedEvent) of LinkageType.FILELIKE for a subscribed listener.

Parameters:

str - the text string

start - the text start position

onPathlikeMatched

protected void onPathlikeMatched(String str,
 char sep,
 boolean canonicalize,
 long start)

Raises NonSymbolMatchedListener.pathlikeMatched(org.opengrok.indexer.analysis.PathlikeMatchedEvent) for a subscribed listener.

Parameters:

str - the path text string

sep - the path separator

canonicalize - a value indicating whether the path should be canonicalized

start - the text start position

onEmailAddressMatched

protected void onEmailAddressMatched(String str,
 long start)

Raises NonSymbolMatchedListener.linkageMatched(org.opengrok.indexer.analysis.LinkageMatchedEvent) of LinkageType.EMAIL for a subscribed listener.

Parameters:

str - the text string

start - the text start position

onLabelMatched

protected void onLabelMatched(String str,
 long start,
 String lstr)

Raises NonSymbolMatchedListener.linkageMatched(org.opengrok.indexer.analysis.LinkageMatchedEvent) of LinkageType.LABEL for a subscribed listener.

Parameters:

str - the text string (literal capture)

start - the text start position

lstr - the text link string

onLabelDefMatched

protected void onLabelDefMatched(String str,
 long start)

Raises NonSymbolMatchedListener.linkageMatched(org.opengrok.indexer.analysis.LinkageMatchedEvent) of LinkageType.LABELDEF for a subscribed listener.

Parameters:

str - the text string (literal capture)

start - the text start position

onQueryTermMatched

protected void onQueryTermMatched(String str,
 long start)

Raises NonSymbolMatchedListener.linkageMatched(org.opengrok.indexer.analysis.LinkageMatchedEvent) of LinkageType.QUERY for a subscribed listener.

Parameters:

str - the text string

start - the text start position

onRefsTermMatched

protected void onRefsTermMatched(String str,
 long start)

Raises NonSymbolMatchedListener.linkageMatched(org.opengrok.indexer.analysis.LinkageMatchedEvent) of LinkageType.REFS for a subscribed listener.

Parameters:

str - the text string

start - the text start position

onScopeChanged

protected void onScopeChanged(ScopeAction action,
 String str,
 long start)

Raises NonSymbolMatchedListener.scopeChanged(org.opengrok.indexer.analysis.ScopeChangedEvent) for a subscribed listener.

Parameters:

action - the scope change action

str - the text string

start - the text start position

onFilteredSymbolMatched

protected boolean onFilteredSymbolMatched(String str,
 long start,
 Set<String> keywords)

Calls onFilteredSymbolMatched(String, long, Set, boolean) with str, start, keywords, and true.

Parameters:

str - the text string

start - the text start position

keywords - an optional set to search for str as a member to indicate a keyword

Returns:

true if the str was not in keywords or if keywords was null

onFilteredSymbolMatched

protected boolean onFilteredSymbolMatched(String str,
 long start,
 Set<String> keywords,
 boolean caseSensitive)

Raises onKeywordMatched(String, long) if keywords is not null and str is found as a member (in a case-sensitive or case-less search per caseSensitive); otherwise raises onSymbolMatched(String, long).

Parameters:

str - the text string

start - the text start position

keywords - an optional set to search for str as a member to indicate a keyword

caseSensitive - a value indicating if keywords should be searched for str as-is (true) or if the lower-case equivalent of str should be used (false).

Returns:

true if the str was not in keywords or if keywords was null