org.fife.ui.rsyntaxtextarea.modes

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

public class MarkdownTokenMaker
extends AbstractMarkupTokenMaker

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 both zzRefill and yyreset. 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 use getTokenList as you would with any other TokenMaker instance.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOLD1
static int	BOLD2
static int	BOLDITALIC1
static int	BOLDITALIC2
static int	CODE lexical states
static int	INATTR_DOUBLE
static int	INATTR_SINGLE
static int	INTAG
static int	INTAG_CHECK_TAG_NAME
static int	INTERNAL_ATTR_DOUBLE Type specific to XMLTokenMaker denoting a line ending with an unclosed double-quote attribute.
static int	INTERNAL_ATTR_SINGLE Type specific to XMLTokenMaker denoting a line ending with an unclosed single-quote attribute.
static int	INTERNAL_IN_BOLD1 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 int	INTERNAL_IN_BOLD2 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 int	INTERNAL_IN_BOLDITALIC1 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 int	INTERNAL_IN_BOLDITALIC2 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 int	INTERNAL_IN_CODE 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 int	INTERNAL_IN_ITALIC1 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 int	INTERNAL_IN_ITALIC2 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 int	INTERNAL_IN_STRIKETHROUGH 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 int	INTERNAL_IN_SYNTAX_HIGHLIGHTING 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 int	INTERNAL_INTAG 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 int	ITALIC1
static int	ITALIC2
static int	STRIKETHROUGH
static int	SYNTAX_HIGHLIGHTING
static int	YYEOF This character denotes the end of file
static int	YYINITIAL

Fields 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

Constructors

Constructor and Description
MarkdownTokenMaker() Constructor.
MarkdownTokenMaker(java.io.InputStream in) Creates a new scanner.
MarkdownTokenMaker(java.io.Reader in) Creates a new scanner There is also a java.io.InputStream version of this constructor.

Method Summary

Modifier and Type	Method and Description
void	addToken(char[] array, int start, int end, int tokenType, int startOffset) Adds the token specified to the current linked list of tokens.
protected OccurrenceMarker	createOccurrenceMarker() Returns the occurrence marker to use for this token maker.
boolean	getCompleteCloseTags() 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.
java.lang.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) Returns TokenTypes.MARKUP_TAG_NAME.
Token	getTokenList(javax.swing.text.Segment text, int initialTokenType, int startOffset) Returns the first token in the linked list of tokens generated from text.
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.
void	yybegin(int newState) Enters a new lexical state
char	yycharat(int pos) Returns the character at position pos from the matched text.
void	yyclose() Closes the input stream.
int	yylength() Returns the length of the matched text region.
Token	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.
void	yyreset(java.io.Reader reader) Resets the scanner to read from a new input stream.
int	yystate() Returns the current lexical state.
java.lang.String	yytext() Returns the text matched by the current regular expression.

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

Methods inherited from class java.lang.Object

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

Field Detail

YYEOF

public static final int YYEOF

This character denotes the end of file

See Also:

Constant Field Values

CODE

public static final int CODE

lexical states

See Also:

Constant Field Values

INTAG_CHECK_TAG_NAME

public static final int INTAG_CHECK_TAG_NAME

See Also:

Constant Field Values

STRIKETHROUGH

public static final int STRIKETHROUGH

See Also:

Constant Field Values

BOLDITALIC2

public static final int BOLDITALIC2

See Also:

Constant Field Values

BOLDITALIC1

public static final int BOLDITALIC1

See Also:

Constant Field Values

ITALIC2

public static final int ITALIC2

See Also:

Constant Field Values

ITALIC1

public static final int ITALIC1

See Also:

Constant Field Values

BOLD2

public static final int BOLD2

See Also:

Constant Field Values

BOLD1

public static final int BOLD1

See Also:

Constant Field Values

SYNTAX_HIGHLIGHTING

public static final int SYNTAX_HIGHLIGHTING

See Also:

Constant Field Values

INATTR_SINGLE

public static final int INATTR_SINGLE

See Also:

Constant Field Values

INATTR_DOUBLE

public static final int INATTR_DOUBLE

See Also:

Constant Field Values

YYINITIAL

public static final int YYINITIAL

See Also:

Constant Field Values

INTAG

public static final int INTAG

See Also:

Constant Field Values

INTERNAL_ATTR_DOUBLE

public static final int INTERNAL_ATTR_DOUBLE

Type specific to XMLTokenMaker denoting a line ending with an unclosed double-quote attribute.

See Also:

Constant Field Values

INTERNAL_ATTR_SINGLE

public static final int INTERNAL_ATTR_SINGLE

Type specific to XMLTokenMaker denoting a line ending with an unclosed single-quote attribute.

See Also:

Constant Field Values

INTERNAL_INTAG

public static final int INTERNAL_INTAG

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.

See Also:

Constant Field Values

INTERNAL_IN_BOLDITALIC1

public static final int INTERNAL_IN_BOLDITALIC1

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.

See Also:

Constant Field Values

INTERNAL_IN_BOLDITALIC2

public static final int INTERNAL_IN_BOLDITALIC2

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.

See Also:

Constant Field Values

INTERNAL_IN_BOLD1

public static final int INTERNAL_IN_BOLD1

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.

See Also:

Constant Field Values

INTERNAL_IN_BOLD2

public static final int INTERNAL_IN_BOLD2

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.

See Also:

Constant Field Values

INTERNAL_IN_ITALIC1

public static final int INTERNAL_IN_ITALIC1

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.

See Also:

Constant Field Values

INTERNAL_IN_ITALIC2

public static final int INTERNAL_IN_ITALIC2

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.

See Also:

Constant Field Values

INTERNAL_IN_CODE

public static final int INTERNAL_IN_CODE

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.

See Also:

Constant Field Values

INTERNAL_IN_SYNTAX_HIGHLIGHTING

public static final int INTERNAL_IN_SYNTAX_HIGHLIGHTING

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.

See Also:

Constant Field Values

INTERNAL_IN_STRIKETHROUGH

public static final int INTERNAL_IN_STRIKETHROUGH

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.

See Also:

Constant Field Values

Constructor Detail

MarkdownTokenMaker

public MarkdownTokenMaker()

Constructor. This must be here because JFlex does not generate a no-parameter constructor.

MarkdownTokenMaker

public MarkdownTokenMaker(java.io.Reader in)

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

public MarkdownTokenMaker(java.io.InputStream in)

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 Detail

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 interface TokenMaker

Overrides:

addToken in class TokenMakerBase

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

protected OccurrenceMarker 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 class TokenMakerBase

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 class AbstractMarkupTokenMaker

Returns:

Whether closing markup tags are completed.

See Also:

setCompleteCloseTags(boolean)

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 returns false; subclasses can override this method if necessary.

Specified by:

getCurlyBracesDenoteCodeBlocks in interface TokenMaker

Overrides:

getCurlyBracesDenoteCodeBlocks in class TokenMakerBase

Parameters:

languageIndex - The language index at the offset in question. Since some TokenMakers effectively have nested languages (such as JavaScript in HTML), this parameter tells the TokenMaker what sub-language to look at.

Returns:

Whether curly braces denote code blocks.

getLineCommentStartAndEnd

public java.lang.String[] getLineCommentStartAndEnd(int languageIndex)

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 interface TokenMaker

Overrides:

getLineCommentStartAndEnd in class AbstractMarkupTokenMaker

Parameters:

languageIndex - The language index at the offset in question. Since some TokenMakers effectively have nested languages (such as JavaScript in HTML), this parameter tells the TokenMaker 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 of null for the array means this language does not support commenting/uncommenting lines.

getMarkOccurrencesOfTokenType

public boolean getMarkOccurrencesOfTokenType(int type)

Returns TokenTypes.MARKUP_TAG_NAME.

Specified by:

getMarkOccurrencesOfTokenType in interface TokenMaker

Overrides:

getMarkOccurrencesOfTokenType in class TokenMakerBase

Parameters:

type - The token type.

Returns:

Whether tokens of this type should have "mark occurrences" enabled.

getTokenList

public Token getTokenList(javax.swing.text.Segment text,
                          int initialTokenType,
                          int startOffset)

Returns the first token in the linked list of tokens generated from text. 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 which text 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 interface TokenMaker

Overrides:

isIdentifierChar in class TokenMakerBase

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:

getCompleteCloseTags()

yyreset

public final void yyreset(java.io.Reader reader)

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

yyclose

public final void yyclose()
                   throws java.io.IOException

Closes the input stream.

Throws:

java.io.IOException

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 class AbstractJFlexTokenMaker

Parameters:

newState - the new lexical state

yytext

public final java.lang.String yytext()

Returns the text matched by the current regular expression.

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.

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

public Token yylex()
            throws java.io.IOException

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:

java.io.IOException - if any I/O-Error occurs