Class MarkdownTokenMaker
java.lang.Object
org.fife.ui.rsyntaxtextarea.TokenMakerBase
org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker
org.fife.ui.rsyntaxtextarea.modes.AbstractMarkupTokenMaker
org.fife.ui.rsyntaxtextarea.modes.MarkdownTokenMaker
- All Implemented Interfaces:
TokenMaker
Scanner for Markdown files. This is based off of our
HTMLTokenMaker
class, and as such, probably highlights more HTML than it should. Still, it
should be good enough for most use cases.
This implementation was created using
JFlex 1.4.1; however, the generated file
was modified for performance. Memory allocation needs to be almost
completely removed to be competitive with the handwritten lexers (subclasses
of AbstractTokenMaker
), so this class has been modified so that
Strings are never allocated (via yytext()), and the scanner never has to
worry about refilling its buffer (needlessly copying chars around).
We can achieve this because RText always scans exactly 1 line of tokens at a
time, and hands the scanner this line as an array of characters (a Segment
really). Since tokens contain pointers to char arrays instead of Strings
holding their contents, there is no need for allocating new memory for
Strings.The actual algorithm generated for scanning has, of course, not been modified.
If you wish to regenerate this file yourself, keep in mind the following:
- The generated
MarkdownTokenMaker.java
file will contain two definitions of bothzzRefill
andyyreset
. You should hand-delete the second of each definition (the ones generated by the lexer), as these generated methods modify the input buffer, which we'll never have to do. - You should also change the declaration/definition of zzBuffer to NOT be initialized. This is a needless memory allocation for us since we will be pointing the array somewhere else anyway.
- You should NOT call
yylex()
on the generated scanner directly; rather, you should usegetTokenList
as you would with any otherTokenMaker
instance.
- Version:
- 0.9
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
lexical statesprivate static boolean
Whether closing markup tags are automatically completed for Markdown.static final int
static final int
static final int
static final int
static final int
Type specific to XMLTokenMaker denoting a line ending with an unclosed double-quote attribute.static final int
Type specific to XMLTokenMaker denoting a line ending with an unclosed single-quote attribute.static final int
Token type specific to MarkdownTokenMaker; this signals that the user has ended a line with an unclosed "**" bold tag; thus a new line is beginning still inside of the tag.static final int
Token type specific to MarkdownTokenMaker; this signals that the user has ended a line with an unclosed "__" bold tag; thus a new line is beginning still inside of the tag.static final int
Token type specific to MarkdownTokenMaker; this signals that the user has ended a line with an unclosed "***" bold/italic tag; thus a new line is beginning still inside of the tag.static final int
Token type specific to MarkdownTokenMaker; this signals that the user has ended a line with an unclosed "___" bold/italic tag; thus a new line is beginning still inside of the tag.static final int
Token type specific to MarkdownTokenMaker; this signals that the user has ended a line with an unclosed "`" code tag; thus a new line is beginning still inside of the tag.static final int
Token type specific to MarkdownTokenMaker; this signals that the user has ended a line with an unclosed "*" italic tag; thus a new line is beginning still inside of the tag.static final int
Token type specific to MarkdownTokenMaker; this signals that the user has ended a line with an unclosed "_" italic tag; thus a new line is beginning still inside of the tag.static final int
Token type specific to MarkdownTokenMaker; this signals that the user has ended a line with an unclosed "~~" strikethrough section; thus a new line is beginning still inside of the block.static final int
Token type specific to MarkdownTokenMaker; this signals that the user has ended a line with an unclosed "```" code block; thus a new line is beginning still inside of the block.static final int
Token type specific to MarkdownTokenMaker; this signals that the user has ended a line with an unclosed HTML tag; thus a new line is beginning still inside of the tag.static final int
static final int
static final int
static final int
static final int
This character denotes the end of filestatic final int
private static final int[]
Translates DFA states to action switch labels.private static final String
private static final int[]
ZZ_ATTRIBUTE[aState] contains the attributes of stateaState
private static final String
private static final char[]
Translates characters to character classesprivate static final String
Translates characters to character classesprivate static final String[]
private static final int
private static final int
private static final int[]
Translates a state to a row index in the transition tableprivate static final String
private static final int[]
The transition table of the DFAprivate static final String
private static final int
private boolean
zzAtEOF == true invalid input: '<'=> the scanner is at the EOFprivate char[]
this buffer contains the current text to be matched and is the source of the yytext() stringprivate int
the current text position in the bufferprivate int
endRead marks the last character in the buffer, that has been read from inputprivate int
the current lexical stateprivate int
the textposition at the last accepting stateprivate Reader
the input deviceprivate int
startRead marks the beginning of the yytext() string in the bufferprivate int
the current state of the DFAFields inherited from class org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker
offsetShift, s, start
Fields inherited from class org.fife.ui.rsyntaxtextarea.TokenMakerBase
currentToken, firstToken, previousToken
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor.Creates a new scanner.Creates a new scanner There is also a java.io.InputStream version of this constructor. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
addEndToken
(int tokenType) Adds the token specified to the current linked list of tokens as an "end token;" that is, atzzMarkedPos
.void
addToken
(char[] array, int start, int end, int tokenType, int startOffset) Adds the token specified to the current linked list of tokens.private void
addToken
(int tokenType) Adds the token specified to the current linked list of tokens.private void
addToken
(int start, int end, int tokenType) Adds the token specified to the current linked list of tokens.protected OccurrenceMarker
Returns the occurrence marker to use for this token maker.boolean
Sets whether markup close tags should be completed.boolean
getCurlyBracesDenoteCodeBlocks
(int languageIndex) Returns whether this programming language uses curly braces ('{
' and '}
') to denote code blocks.String[]
getLineCommentStartAndEnd
(int languageIndex) Returns the text to place at the beginning and end of a line to "comment" it in this programming language.boolean
getMarkOccurrencesOfTokenType
(int type) ReturnsTokenTypes.MARKUP_TAG_NAME
.getTokenList
(Segment text, int initialTokenType, int startOffset) Returns the first token in the linked list of tokens generated fromtext
.boolean
isIdentifierChar
(int languageIndex, char ch) Overridden to accept letters, digits, underscores, and hyphens.static void
setCompleteCloseTags
(boolean complete) Sets whether markup close tags should be completed.final void
yybegin
(int newState) Enters a new lexical statefinal char
yycharat
(int pos) Returns the character at position pos from the matched text.final void
yyclose()
Closes the input stream.final int
yylength()
Returns the length of the matched text region.yylex()
Resumes scanning until the next regular expression is matched, the end of input is encountered or an I/O-Error occurs.void
yypushback
(int number) Pushes the specified amount of characters back into the input stream.final void
Resets the scanner to read from a new input stream.final int
yystate()
Returns the current lexical state.final String
yytext()
Returns the text matched by the current regular expression.private boolean
zzRefill()
Refills the input buffer.private void
zzScanError
(int errorCode) Reports an error that occured while scanning.private static int[]
private static int
zzUnpackAction
(String packed, int offset, int[] result) private static int[]
private static int
zzUnpackAttribute
(String packed, int offset, int[] result) private static char[]
zzUnpackCMap
(String packed) Unpacks the compressed character translation table.private static int[]
private static int
zzUnpackRowMap
(String packed, int offset, int[] result) private static int[]
private static int
zzUnpackTrans
(String packed, int offset, int[] result) Methods inherited from class org.fife.ui.rsyntaxtextarea.modes.AbstractMarkupTokenMaker
isMarkupLanguage
Methods inherited from class org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker
yybegin
Methods inherited from class org.fife.ui.rsyntaxtextarea.TokenMakerBase
addNullToken, addToken, addToken, getClosestStandardTokenTypeForInternalType, getInsertBreakAction, getLanguageIndex, getLastTokenTypeOnLine, getNoTokensIdentifiedYet, getOccurrenceMarker, getShouldIndentNextLineAfter, resetTokenList, setLanguageIndex
-
Field Details
-
YYEOF
public static final int YYEOFThis character denotes the end of file- See Also:
-
CODE
public static final int CODElexical states- See Also:
-
INTAG_CHECK_TAG_NAME
public static final int INTAG_CHECK_TAG_NAME- See Also:
-
STRIKETHROUGH
public static final int STRIKETHROUGH- See Also:
-
BOLDITALIC2
public static final int BOLDITALIC2- See Also:
-
BOLDITALIC1
public static final int BOLDITALIC1- See Also:
-
ITALIC2
public static final int ITALIC2- See Also:
-
ITALIC1
public static final int ITALIC1- See Also:
-
BOLD2
public static final int BOLD2- See Also:
-
BOLD1
public static final int BOLD1- See Also:
-
SYNTAX_HIGHLIGHTING
public static final int SYNTAX_HIGHLIGHTING- See Also:
-
INATTR_SINGLE
public static final int INATTR_SINGLE- See Also:
-
INATTR_DOUBLE
public static final int INATTR_DOUBLE- See Also:
-
YYINITIAL
public static final int YYINITIAL- See Also:
-
INTAG
public static final int INTAG- See Also:
-
ZZ_CMAP_PACKED
Translates characters to character classes- See Also:
-
ZZ_CMAP
private static final char[] ZZ_CMAPTranslates characters to character classes -
ZZ_ACTION
private static final int[] ZZ_ACTIONTranslates DFA states to action switch labels. -
ZZ_ACTION_PACKED_0
- See Also:
-
ZZ_ROWMAP
private static final int[] ZZ_ROWMAPTranslates a state to a row index in the transition table -
ZZ_ROWMAP_PACKED_0
- See Also:
-
ZZ_TRANS
private static final int[] ZZ_TRANSThe transition table of the DFA -
ZZ_TRANS_PACKED_0
- See Also:
-
ZZ_UNKNOWN_ERROR
private static final int ZZ_UNKNOWN_ERROR- See Also:
-
ZZ_NO_MATCH
private static final int ZZ_NO_MATCH- See Also:
-
ZZ_PUSHBACK_2BIG
private static final int ZZ_PUSHBACK_2BIG- See Also:
-
ZZ_ERROR_MSG
-
ZZ_ATTRIBUTE
private static final int[] ZZ_ATTRIBUTEZZ_ATTRIBUTE[aState] contains the attributes of stateaState
-
ZZ_ATTRIBUTE_PACKED_0
- See Also:
-
zzReader
the input device -
zzState
private int zzStatethe current state of the DFA -
zzLexicalState
private int zzLexicalStatethe current lexical state -
zzBuffer
private char[] zzBufferthis buffer contains the current text to be matched and is the source of the yytext() string -
zzMarkedPos
private int zzMarkedPosthe textposition at the last accepting state -
zzCurrentPos
private int zzCurrentPosthe current text position in the buffer -
zzStartRead
private int zzStartReadstartRead marks the beginning of the yytext() string in the buffer -
zzEndRead
private int zzEndReadendRead marks the last character in the buffer, that has been read from input -
zzAtEOF
private boolean zzAtEOFzzAtEOF == true invalid input: '<'=> the scanner is at the EOF -
INTERNAL_ATTR_DOUBLE
public static final int INTERNAL_ATTR_DOUBLEType specific to XMLTokenMaker denoting a line ending with an unclosed double-quote attribute.- See Also:
-
INTERNAL_ATTR_SINGLE
public static final int INTERNAL_ATTR_SINGLEType specific to XMLTokenMaker denoting a line ending with an unclosed single-quote attribute.- See Also:
-
INTERNAL_INTAG
public static final int INTERNAL_INTAGToken type specific to MarkdownTokenMaker; this signals that the user has ended a line with an unclosed HTML tag; thus a new line is beginning still inside of the tag.- See Also:
-
INTERNAL_IN_BOLDITALIC1
public static final int INTERNAL_IN_BOLDITALIC1Token type specific to MarkdownTokenMaker; this signals that the user has ended a line with an unclosed "***" bold/italic tag; thus a new line is beginning still inside of the tag.- See Also:
-
INTERNAL_IN_BOLDITALIC2
public static final int INTERNAL_IN_BOLDITALIC2Token type specific to MarkdownTokenMaker; this signals that the user has ended a line with an unclosed "___" bold/italic tag; thus a new line is beginning still inside of the tag.- See Also:
-
INTERNAL_IN_BOLD1
public static final int INTERNAL_IN_BOLD1Token type specific to MarkdownTokenMaker; this signals that the user has ended a line with an unclosed "**" bold tag; thus a new line is beginning still inside of the tag.- See Also:
-
INTERNAL_IN_BOLD2
public static final int INTERNAL_IN_BOLD2Token type specific to MarkdownTokenMaker; this signals that the user has ended a line with an unclosed "__" bold tag; thus a new line is beginning still inside of the tag.- See Also:
-
INTERNAL_IN_ITALIC1
public static final int INTERNAL_IN_ITALIC1Token type specific to MarkdownTokenMaker; this signals that the user has ended a line with an unclosed "*" italic tag; thus a new line is beginning still inside of the tag.- See Also:
-
INTERNAL_IN_ITALIC2
public static final int INTERNAL_IN_ITALIC2Token type specific to MarkdownTokenMaker; this signals that the user has ended a line with an unclosed "_" italic tag; thus a new line is beginning still inside of the tag.- See Also:
-
INTERNAL_IN_CODE
public static final int INTERNAL_IN_CODEToken type specific to MarkdownTokenMaker; this signals that the user has ended a line with an unclosed "`" code tag; thus a new line is beginning still inside of the tag.- See Also:
-
INTERNAL_IN_SYNTAX_HIGHLIGHTING
public static final int INTERNAL_IN_SYNTAX_HIGHLIGHTINGToken type specific to MarkdownTokenMaker; this signals that the user has ended a line with an unclosed "```" code block; thus a new line is beginning still inside of the block.- See Also:
-
INTERNAL_IN_STRIKETHROUGH
public static final int INTERNAL_IN_STRIKETHROUGHToken type specific to MarkdownTokenMaker; this signals that the user has ended a line with an unclosed "~~" strikethrough section; thus a new line is beginning still inside of the block.- See Also:
-
completeCloseTags
private static boolean completeCloseTagsWhether closing markup tags are automatically completed for Markdown.
-
-
Constructor Details
-
MarkdownTokenMaker
public MarkdownTokenMaker()Constructor. This must be here because JFlex does not generate a no-parameter constructor. -
MarkdownTokenMaker
Creates a new scanner There is also a java.io.InputStream version of this constructor.- Parameters:
in
- the java.io.Reader to read input from.
-
MarkdownTokenMaker
Creates a new scanner. There is also java.io.Reader version of this constructor.- Parameters:
in
- the java.io.Inputstream to read input from.
-
-
Method Details
-
zzUnpackAction
private static int[] zzUnpackAction() -
zzUnpackAction
-
zzUnpackRowMap
private static int[] zzUnpackRowMap() -
zzUnpackRowMap
-
zzUnpackTrans
private static int[] zzUnpackTrans() -
zzUnpackTrans
-
zzUnpackAttribute
private static int[] zzUnpackAttribute() -
zzUnpackAttribute
-
addEndToken
private void addEndToken(int tokenType) Adds the token specified to the current linked list of tokens as an "end token;" that is, atzzMarkedPos
.- Parameters:
tokenType
- The token's type.
-
addToken
private void addToken(int tokenType) Adds the token specified to the current linked list of tokens.- Parameters:
tokenType
- The token's type.
-
addToken
private void addToken(int start, int end, int tokenType) Adds the token specified to the current linked list of tokens.- Parameters:
tokenType
- The token's type.
-
addToken
public void addToken(char[] array, int start, int end, int tokenType, int startOffset) Adds the token specified to the current linked list of tokens.- Specified by:
addToken
in interfaceTokenMaker
- Overrides:
addToken
in classTokenMakerBase
- Parameters:
array
- The character array.start
- The starting offset in the array.end
- The ending offset in the array.tokenType
- The token's type.startOffset
- The offset in the document at which this token occurs.
-
createOccurrenceMarker
Description copied from class:TokenMakerBase
Returns the occurrence marker to use for this token maker. Subclasses can override to use different implementations.- Overrides:
createOccurrenceMarker
in classTokenMakerBase
- Returns:
- The occurrence marker to use.
-
getCompleteCloseTags
public boolean getCompleteCloseTags()Sets whether markup close tags should be completed. You might not want this to be the case, since some tags in standard HTML aren't usually closed.- Specified by:
getCompleteCloseTags
in classAbstractMarkupTokenMaker
- Returns:
- Whether closing markup tags are completed.
- See Also:
-
getCurlyBracesDenoteCodeBlocks
public boolean getCurlyBracesDenoteCodeBlocks(int languageIndex) Description copied from class:TokenMakerBase
Returns whether this programming language uses curly braces ('{
' and '}
') to denote code blocks. The default implementation returnsfalse
; subclasses can override this method if necessary.- Specified by:
getCurlyBracesDenoteCodeBlocks
in interfaceTokenMaker
- Overrides:
getCurlyBracesDenoteCodeBlocks
in classTokenMakerBase
- Parameters:
languageIndex
- The language index at the offset in question. Since someTokenMaker
s effectively have nested languages (such as JavaScript in HTML), this parameter tells theTokenMaker
what sub-language to look at.- Returns:
- Whether curly braces denote code blocks.
-
getLineCommentStartAndEnd
Description copied from interface:TokenMaker
Returns the text to place at the beginning and end of a line to "comment" it in this programming language.- Specified by:
getLineCommentStartAndEnd
in interfaceTokenMaker
- Overrides:
getLineCommentStartAndEnd
in classAbstractMarkupTokenMaker
- Parameters:
languageIndex
- The language index at the offset in question. Since someTokenMaker
s effectively have nested languages (such as JavaScript in HTML), this parameter tells theTokenMaker
what sub-language to look at.- Returns:
- The start and end strings to add to a line to "comment"
it out. A
null
value for either means there is no string to add for that part. A value ofnull
for the array means this language does not support commenting/uncommenting lines.
-
getMarkOccurrencesOfTokenType
public boolean getMarkOccurrencesOfTokenType(int type) ReturnsTokenTypes.MARKUP_TAG_NAME
.- Specified by:
getMarkOccurrencesOfTokenType
in interfaceTokenMaker
- Overrides:
getMarkOccurrencesOfTokenType
in classTokenMakerBase
- Parameters:
type
- The token type.- Returns:
- Whether tokens of this type should have "mark occurrences" enabled.
-
getTokenList
Returns the first token in the linked list of tokens generated fromtext
. This method must be implemented by subclasses so they can correctly implement syntax highlighting.- Parameters:
text
- The text from which to get tokens.initialTokenType
- The token type we should start with.startOffset
- The offset into the document at whichtext
starts.- Returns:
- The first
Token
in a linked list representing the syntax highlighted text.
-
isIdentifierChar
public boolean isIdentifierChar(int languageIndex, char ch) Overridden to accept letters, digits, underscores, and hyphens.- Specified by:
isIdentifierChar
in interfaceTokenMaker
- Overrides:
isIdentifierChar
in classTokenMakerBase
- Parameters:
languageIndex
- The language index the character was found in.ch
- The character.- Returns:
- Whether the character could be part of an "identifier" token.
-
setCompleteCloseTags
public static void setCompleteCloseTags(boolean complete) Sets whether markup close tags should be completed. You might not want this to be the case, since some tags in standard HTML aren't usually closed.- Parameters:
complete
- Whether closing markup tags are completed.- See Also:
-
zzRefill
private boolean zzRefill()Refills the input buffer.- Returns:
true
if EOF was reached, otherwisefalse
.
-
yyreset
Resets the scanner to read from a new input stream. Does not close the old reader. All internal variables are reset, the old input stream cannot be reused (internal buffer is discarded and lost). Lexical state is set to YY_INITIAL.- Parameters:
reader
- the new input stream
-
zzUnpackCMap
Unpacks the compressed character translation table.- Parameters:
packed
- the packed character translation table- Returns:
- the unpacked character translation table
-
yyclose
Closes the input stream.- Specified by:
yyclose
in classAbstractJFlexTokenMaker
- Throws:
IOException
- If an IO error occurs.
-
yystate
public final int yystate()Returns the current lexical state. -
yybegin
public final void yybegin(int newState) Enters a new lexical state- Specified by:
yybegin
in classAbstractJFlexTokenMaker
- Parameters:
newState
- the new lexical state
-
yytext
Returns the text matched by the current regular expression.- Specified by:
yytext
in classAbstractJFlexTokenMaker
-
yycharat
public final char yycharat(int pos) Returns the character at position pos from the matched text. It is equivalent to yytext().charAt(pos), but faster- Parameters:
pos
- the position of the character to fetch. A value from 0 to yylength()-1.- Returns:
- the character at position pos
-
yylength
public final int yylength()Returns the length of the matched text region. -
zzScanError
private void zzScanError(int errorCode) Reports an error that occured while scanning. In a wellformed scanner (no or only correct usage of yypushback(int) and a match-all fallback rule) this method will only be called with things that "Can't Possibly Happen". If this method is called, something is seriously wrong (e.g. a JFlex bug producing a faulty scanner etc.). Usual syntax/scanner level error handling should be done in error fallback rules.- Parameters:
errorCode
- the code of the errormessage to display
-
yypushback
public void yypushback(int number) Pushes the specified amount of characters back into the input stream. They will be read again by then next call of the scanning method- Parameters:
number
- the number of characters to be read again. This number must not be greater than yylength()!
-
yylex
Resumes scanning until the next regular expression is matched, the end of input is encountered or an I/O-Error occurs.- Returns:
- the next token
- Throws:
IOException
- if any I/O-Error occurs
-