com.fr.design.gui.syntax.ui.rsyntaxtextarea.modes

类 BBCodeTokenMaker

java.lang.Object

com.fr.design.gui.syntax.ui.rsyntaxtextarea.AbstractJFlexTokenMaker

com.fr.design.gui.syntax.ui.rsyntaxtextarea.modes.AbstractMarkupTokenMaker

com.fr.design.gui.syntax.ui.rsyntaxtextarea.modes.BBCodeTokenMaker

所有已实现的接口:

TokenMaker

public class BBCodeTokenMaker
extends AbstractMarkupTokenMaker

Scanner for BBCode. 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 BBCodeTokenMaker.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.

版本:

0.7

作者:

Robert Futrell

字段概要

字段

限定符和类型	字段和说明
protected TokenImpl	currentToken Used in the creation of the linked list.
protected TokenImpl	firstToken The first token in the returned linked list.
static int	INTAG lexical states
static int	INTERNAL_INTAG Token type specific to BBCodeTokenMaker; this signals that the user has ended a line with an unclosed tag; thus a new line is beginning still inside of the tag.
protected TokenImpl	previousToken Used in the creation of the linked list.
static int	YYEOF This character denotes the end of file
static int	YYINITIAL

从类继承的字段 com.fr.design.gui.syntax.ui.rsyntaxtextarea.AbstractJFlexTokenMaker

offsetShift, s, start

构造器概要

构造器

构造器和说明
BBCodeTokenMaker() Constructor.
BBCodeTokenMaker(java.io.InputStream in) Creates a new scanner.
BBCodeTokenMaker(java.io.Reader in) Creates a new scanner There is also a java.io.InputStream version of this constructor.

方法概要

方法

限定符和类型	方法和说明
void	addNullToken() Adds a null token to the end of the current linked list of tokens.
void	addToken(char[] array, int start, int end, int tokenType, int startOffset) Adds the token specified to the current linked list of tokens.
void	addToken(char[] array, int start, int end, int tokenType, int startOffset, boolean hyperlink) Adds the token specified to the current linked list of tokens.
void	addToken(javax.swing.text.Segment segment, 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.
int	getClosestStandardTokenTypeForInternalType(int type) Returns the closest "standard" token type for a given "internal" token type (e.g. one whose value is < 0).
boolean	getCompleteCloseTags() Sets whether markup close tags should be completed.
boolean	getCurlyBracesDenoteCodeBlocks() Returns whether this programming language uses curly braces ('{' and '}') to denote code blocks.
javax.swing.Action	getInsertBreakAction() Returns an action to handle "insert break" key presses (i.e.
int	getLastTokenTypeOnLine(javax.swing.text.Segment text, int initialTokenType) Returns the last token on this line's type if the token is "unfinished", or TokenTypes.NULL if it was finished.
java.lang.String[]	getLineCommentStartAndEnd() Returns null since BBCode has no comments.
boolean	getMarkOccurrencesOfTokenType(int type) Returns whether tokens of the specified type should have "mark occurrences" enabled for the current programming language.
OccurrenceMarker	getOccurrenceMarker() Returns the object in charge of marking all occurrences of the token at the current caret position, if it is a relevant token.
boolean	getShouldIndentNextLineAfter(Token token) The default implementation returns false always.
Token	getTokenList(javax.swing.text.Segment text, int initialTokenType, int startOffset) Returns the first token in the linked list of tokens generated from text.
protected void	resetTokenList() Deletes the linked list of tokens so we can begin anew.
static void	setCompleteCloseTags(boolean complete) Sets whether markup close tags should be completed.
void	setLanguageIndex(int languageIndex) Sets the language index to assign to tokens moving forward.
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.

从类继承的方法 com.fr.design.gui.syntax.ui.rsyntaxtextarea.modes.AbstractMarkupTokenMaker

isMarkupLanguage

从类继承的方法 com.fr.design.gui.syntax.ui.rsyntaxtextarea.AbstractJFlexTokenMaker

yybegin

从类继承的方法 java.lang.Object

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

字段详细资料

YYEOF

public static final int YYEOF

This character denotes the end of file

另请参阅:

常量字段值

INTAG

public static final int INTAG

lexical states

另请参阅:

常量字段值

YYINITIAL

public static final int YYINITIAL

另请参阅:

常量字段值

INTERNAL_INTAG

public static final int INTERNAL_INTAG

Token type specific to BBCodeTokenMaker; this signals that the user has ended a line with an unclosed tag; thus a new line is beginning still inside of the tag.

另请参阅:

常量字段值

firstToken

protected TokenImpl firstToken

The first token in the returned linked list.

currentToken

protected TokenImpl currentToken

Used in the creation of the linked list.

previousToken

protected TokenImpl previousToken

Used in the creation of the linked list.

构造器详细资料

BBCodeTokenMaker

public BBCodeTokenMaker()

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

BBCodeTokenMaker

public BBCodeTokenMaker(java.io.Reader in)

Creates a new scanner There is also a java.io.InputStream version of this constructor.

参数:

in - the java.io.Reader to read input from.

BBCodeTokenMaker

public BBCodeTokenMaker(java.io.InputStream in)

Creates a new scanner. There is also java.io.Reader version of this constructor.

参数:

in - the java.io.Inputstream to read input from.

方法详细资料

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.

指定者:

addToken 在接口中 TokenMaker

参数:

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.

getCompleteCloseTags

public boolean getCompleteCloseTags()

Sets whether markup close tags should be completed. The default value for BBCode is true.

指定者:

getCompleteCloseTags 在类中 AbstractMarkupTokenMaker

返回:

Whether closing markup tags are completed.

另请参阅:

setCompleteCloseTags(boolean)

getLineCommentStartAndEnd

public java.lang.String[] getLineCommentStartAndEnd()

Returns null since BBCode has no comments.

指定者:

getLineCommentStartAndEnd 在接口中 TokenMaker

覆盖:

getLineCommentStartAndEnd 在类中 AbstractMarkupTokenMaker

返回:

null always.

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.

参数:

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.

返回:

The first Token in a linked list representing the syntax highlighted text.

setCompleteCloseTags

public static void setCompleteCloseTags(boolean complete)

Sets whether markup close tags should be completed.

参数:

complete - Whether closing markup tags are completed.

另请参阅:

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.

参数:

reader - the new input stream

yyclose

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

Closes the input stream.

抛出:

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

指定者:

yybegin 在类中 AbstractJFlexTokenMaker

参数:

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

参数:

pos - the position of the character to fetch. A value from 0 to yylength()-1.

返回:

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

参数:

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.

返回:

the next token

抛出:

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

addNullToken

public void addNullToken()

Adds a null token to the end of the current linked list of tokens. This should be put at the end of the linked list whenever the last token on the current line is NOT a multi-line token.

指定者:

addNullToken 在接口中 TokenMaker

addToken

public void addToken(javax.swing.text.Segment segment,
            int start,
            int end,
            int tokenType,
            int startOffset)

Adds the token specified to the current linked list of tokens.

参数:

segment - Segment to get text from.

start - Start offset in segment of token.

end - End offset in segment of token.

tokenType - The token's type.

startOffset - The offset in the document at which this token occurs.

addToken

public void addToken(char[] array,
            int start,
            int end,
            int tokenType,
            int startOffset,
            boolean hyperlink)

Adds the token specified to the current linked list of tokens.

参数:

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.

hyperlink - Whether this token is a hyperlink.

createOccurrenceMarker

protected OccurrenceMarker createOccurrenceMarker()

Returns the occurrence marker to use for this token maker. Subclasses can override to use different implementations.

返回:

The occurrence marker to use.

getClosestStandardTokenTypeForInternalType

public int getClosestStandardTokenTypeForInternalType(int type)

Returns the closest "standard" token type for a given "internal" token type (e.g. one whose value is < 0).

The default implementation returns type always, which denotes that a mapping from internal token types to standard token types is not defined; subclasses can override.

指定者:

getClosestStandardTokenTypeForInternalType 在接口中 TokenMaker

参数:

type - The token type.

返回:

The closest "standard" token type.

getCurlyBracesDenoteCodeBlocks

public boolean getCurlyBracesDenoteCodeBlocks()

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.

指定者:

getCurlyBracesDenoteCodeBlocks 在接口中 TokenMaker

返回:

Whether curly braces denote code blocks.

getInsertBreakAction

public javax.swing.Action getInsertBreakAction()

Returns an action to handle "insert break" key presses (i.e. Enter). The default implementation returns null. Subclasses can override.

指定者:

getInsertBreakAction 在接口中 TokenMaker

返回:

The default implementation always returns null.

getLastTokenTypeOnLine

public int getLastTokenTypeOnLine(javax.swing.text.Segment text,
                         int initialTokenType)

Returns the last token on this line's type if the token is "unfinished", or TokenTypes.NULL if it was finished. For example, if C-style syntax highlighting is being implemented, and text contained a line of code that contained the beginning of a comment but no end-comment marker ("*\/"), then this method would return TokenTypes.COMMENT_MULTILINE for that line. This is useful for doing syntax highlighting.

指定者:

getLastTokenTypeOnLine 在接口中 TokenMaker

参数:

text - The line of tokens to examine.

initialTokenType - The token type to start with (i.e., the value of getLastTokenTypeOnLine for the line before text).

返回:

The last token on this line's type, or TokenTypes.NULL if the line was completed.

getMarkOccurrencesOfTokenType

public boolean getMarkOccurrencesOfTokenType(int type)

Returns whether tokens of the specified type should have "mark occurrences" enabled for the current programming language. The default implementation returns true if type is TokenTypes.IDENTIFIER. Subclasses can override this method to support other token types, such as TokenTypes.VARIABLE.

指定者:

getMarkOccurrencesOfTokenType 在接口中 TokenMaker

参数:

type - The token type.

返回:

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

getOccurrenceMarker

public OccurrenceMarker getOccurrenceMarker()

Returns the object in charge of marking all occurrences of the token at the current caret position, if it is a relevant token. If null is returned, a default OccurrenceMarker is used.

指定者:

getOccurrenceMarker 在接口中 TokenMaker

返回:

The occurrence marker for this language, or null for none.

getShouldIndentNextLineAfter

public boolean getShouldIndentNextLineAfter(Token token)

The default implementation returns false always. Languages that wish to better support auto-indentation can override this method.

指定者:

getShouldIndentNextLineAfter 在接口中 TokenMaker

参数:

token - The token the previous line ends with.

返回:

Whether the next line should be indented.

resetTokenList

protected void resetTokenList()

Deletes the linked list of tokens so we can begin anew. This should never have to be called by the programmer, as it is automatically called whenever the user calls getLastTokenTypeOnLine(Segment, int) or TokenMaker.getTokenList(Segment, int, int).

setLanguageIndex

public void setLanguageIndex(int languageIndex)

Sets the language index to assign to tokens moving forward. This property is used to designate tokens as being in "secondary" languages (such as CSS or JavaScript in HTML).

参数:

languageIndex - The new language index. A value of 0 denotes the "main" language, any positive value denotes a specific secondary language. Negative values will be treated as 0.