Module jEdit

Package org.gjt.sp.jedit.syntax

Class ParserRule

java.lang.Object

org.gjt.sp.jedit.syntax.ParserRule

public class ParserRule
extends Object

A parser rule.

Version:

$Id: ParserRule.java 25244 2020-04-15 15:14:49Z kpouer $

Author:

mike dillon, Slava Pestov

Field Summary

Fields

Modifier and Type	Field	Description
final int	action
static final int	ACTION_HINTS
static final int	AT_LINE_START
static final int	AT_WHITESPACE_END
static final int	AT_WORD_START
ParserRuleSet	delegate
final char[]	end
static final int	END_REGEXP
final int	endPosMatch
final Pattern	endRegexp
static final int	EOL_SPAN
final ParserRule	escapeRule	escapeRule is the rule-specific sequence used to escape other characters while the rule is in effect.
static final int	IS_ESCAPE
static final int	MAJOR_ACTIONS
static final int	MARK_FOLLOWING
static final int	MARK_PREVIOUS
static final byte	MATCH_TYPE_CONTEXT
static final byte	MATCH_TYPE_RULE
final byte	matchType	matchType is the type of the token for the matched region.
static final int	NO_LINE_BREAK
static final int	NO_WORD_BREAK
static final int	REGEXP
static final int	SEQ
static final int	SPAN
final char[]	start
final int	startPosMatch
final Pattern	startRegexp
final byte	token
final char[]	upHashChar	The upHashChar should be a String but it is stored in an array making iterations much faster
final char[]	upHashChars

Method Summary

Modifier and Type	Method	Description
static ParserRule	createEOLSpanRule(int posMatch, String seq, ParserRuleSet delegate, byte id, byte matchType)
static ParserRule	createEscapeRule(String seq)
static ParserRule	createMarkFollowingRule(int posMatch, String seq, byte id, byte matchType)
static ParserRule	createMarkPreviousRule(int posMatch, String seq, byte id, byte matchType)
static ParserRule	createRegexpEOLSpanRule(int posMatch, char[] hashChars, String seq, ParserRuleSet delegate, byte id, byte matchType, boolean ignoreCase)
static ParserRule	createRegexpEOLSpanRule(String hashChar, int posMatch, String seq, ParserRuleSet delegate, byte id, byte matchType, boolean ignoreCase)
static ParserRule	createRegexpSequenceRule(int posMatch, char[] hashChars, String seq, ParserRuleSet delegate, byte id, boolean ignoreCase)
static ParserRule	createRegexpSequenceRule(String hashChar, int posMatch, String seq, ParserRuleSet delegate, byte id, boolean ignoreCase)
static ParserRule	createRegexpSpanRule(int startPosMatch, char[] hashChars, String start, int endPosMatch, String end, ParserRuleSet delegate, byte id, byte matchType, boolean noLineBreak, boolean noWordBreak, boolean ignoreCase, String escape, boolean endRegexp)
static ParserRule	createRegexpSpanRule(String hashChar, int startPosMatch, String start, int endPosMatch, String end, ParserRuleSet delegate, byte id, byte matchType, boolean noLineBreak, boolean noWordBreak, boolean ignoreCase, String escape, boolean endRegexp)
static ParserRule	createSequenceRule(int posMatch, String seq, ParserRuleSet delegate, byte id)
static ParserRule	createSpanRule(int startPosMatch, String start, int endPosMatch, String end, ParserRuleSet delegate, byte id, byte matchType, boolean noLineBreak, boolean noWordBreak, String escape)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

MAJOR_ACTIONS

public static final int MAJOR_ACTIONS

See Also:

• Constant Field Values

SEQ

public static final int SEQ

See Also:

• Constant Field Values

SPAN

public static final int SPAN

See Also:

• Constant Field Values

MARK_PREVIOUS

public static final int MARK_PREVIOUS

See Also:

• Constant Field Values

MARK_FOLLOWING

public static final int MARK_FOLLOWING

See Also:

• Constant Field Values

EOL_SPAN

public static final int EOL_SPAN

See Also:

• Constant Field Values

ACTION_HINTS

public static final int ACTION_HINTS

See Also:

• Constant Field Values

NO_LINE_BREAK

public static final int NO_LINE_BREAK

See Also:

• Constant Field Values

NO_WORD_BREAK

public static final int NO_WORD_BREAK

See Also:

• Constant Field Values

IS_ESCAPE

public static final int IS_ESCAPE

See Also:

• Constant Field Values

REGEXP

public static final int REGEXP

See Also:

• Constant Field Values

END_REGEXP

public static final int END_REGEXP

See Also:

• Constant Field Values

MATCH_TYPE_CONTEXT

public static final byte MATCH_TYPE_CONTEXT

See Also:

• Constant Field Values

MATCH_TYPE_RULE

public static final byte MATCH_TYPE_RULE

See Also:

• Constant Field Values

AT_LINE_START

public static final int AT_LINE_START

See Also:

• Constant Field Values

AT_WHITESPACE_END

public static final int AT_WHITESPACE_END

See Also:

• Constant Field Values

AT_WORD_START

public static final int AT_WORD_START

See Also:

• Constant Field Values

upHashChar

public final char[] upHashChar

The upHashChar should be a String but it is stored in an array making iterations much faster

upHashChars

public final char[] upHashChars

startPosMatch

public final int startPosMatch

start

public final char[] start

startRegexp

public final Pattern startRegexp

endPosMatch

public final int endPosMatch

end

public final char[] end

endRegexp

public final Pattern endRegexp

action

public final int action

token

public final byte token

matchType

public final byte matchType

matchType is the type of the token for the matched region. Special values are: MATCH_TYPE_CONTEXT = default token for the context, MATCH_TYPE_RULE = same token as the rule itself.

Since:

jEdit 4.3pre10

escapeRule

public final ParserRule escapeRule

escapeRule is the rule-specific sequence used to escape other characters while the rule is in effect. If this character is non-zero, the character following the escape char will be skipped during parsing, and highlighted with the rule's token.

Since:

jEdit 4.3pre12

delegate

public ParserRuleSet delegate

Method Details

createSequenceRule

public static ParserRule createSequenceRule(int posMatch,
 String seq,
 ParserRuleSet delegate,
 byte id)

createRegexpSequenceRule

public static ParserRule createRegexpSequenceRule(String hashChar,
 int posMatch,
 String seq,
 ParserRuleSet delegate,
 byte id,
 boolean ignoreCase)
                                           throws PatternSyntaxException

Throws:

PatternSyntaxException

createRegexpSequenceRule

public static ParserRule createRegexpSequenceRule(int posMatch,
 char[] hashChars,
 String seq,
 ParserRuleSet delegate,
 byte id,
 boolean ignoreCase)
                                           throws PatternSyntaxException

Throws:

PatternSyntaxException

createSpanRule

public static ParserRule createSpanRule(int startPosMatch,
 String start,
 int endPosMatch,
 String end,
 ParserRuleSet delegate,
 byte id,
 byte matchType,
 boolean noLineBreak,
 boolean noWordBreak,
 String escape)

createRegexpSpanRule

public static ParserRule createRegexpSpanRule(String hashChar,
 int startPosMatch,
 String start,
 int endPosMatch,
 String end,
 ParserRuleSet delegate,
 byte id,
 byte matchType,
 boolean noLineBreak,
 boolean noWordBreak,
 boolean ignoreCase,
 String escape,
 boolean endRegexp)
                                       throws PatternSyntaxException

Throws:

PatternSyntaxException

createRegexpSpanRule

public static ParserRule createRegexpSpanRule(int startPosMatch,
 char[] hashChars,
 String start,
 int endPosMatch,
 String end,
 ParserRuleSet delegate,
 byte id,
 byte matchType,
 boolean noLineBreak,
 boolean noWordBreak,
 boolean ignoreCase,
 String escape,
 boolean endRegexp)
                                       throws PatternSyntaxException

Throws:

PatternSyntaxException

createEOLSpanRule

public static ParserRule createEOLSpanRule(int posMatch,
 String seq,
 ParserRuleSet delegate,
 byte id,
 byte matchType)

createRegexpEOLSpanRule

public static ParserRule createRegexpEOLSpanRule(String hashChar,
 int posMatch,
 String seq,
 ParserRuleSet delegate,
 byte id,
 byte matchType,
 boolean ignoreCase)
                                          throws PatternSyntaxException

Throws:

PatternSyntaxException

createRegexpEOLSpanRule

public static ParserRule createRegexpEOLSpanRule(int posMatch,
 char[] hashChars,
 String seq,
 ParserRuleSet delegate,
 byte id,
 byte matchType,
 boolean ignoreCase)
                                          throws PatternSyntaxException

Throws:

PatternSyntaxException

createMarkFollowingRule

public static ParserRule createMarkFollowingRule(int posMatch,
 String seq,
 byte id,
 byte matchType)

createMarkPreviousRule

public static ParserRule createMarkPreviousRule(int posMatch,
 String seq,
 byte id,
 byte matchType)

createEscapeRule

public static ParserRule createEscapeRule(String seq)

toString

public String toString()

Overrides:

toString in class Object