|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker
org.fife.ui.rsyntaxtextarea.modes.AbstractMarkupTokenMaker
org.fife.ui.rsyntaxtextarea.modes.HTMLTokenMaker
public class HTMLTokenMaker
Scanner for HTML 5 files.
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:
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.yylex()
on the generated scanner
directly; rather, you should use getTokenList
as you would
with any other TokenMaker
instance.
Field Summary | |
---|---|
static int |
COMMENT
|
protected Token |
currentToken
Used in the creation of the linked list. |
static int |
DTD
|
protected Token |
firstToken
The first token in the returned linked list. |
static int |
INATTR_DOUBLE
|
static int |
INATTR_DOUBLE_SCRIPT
|
static int |
INATTR_SINGLE
|
static int |
INATTR_SINGLE_SCRIPT
|
static int |
INTAG
|
static int |
INTAG_CHECK_TAG_NAME
lexical states |
static int |
INTAG_SCRIPT
|
static int |
INTERNAL_ATTR_DOUBLE
Type specific to XMLTokenMaker denoting a line ending with an unclosed double-quote attribute. |
static int |
INTERNAL_ATTR_DOUBLE_QUOTE_SCRIPT
Token type specifying we're in a double-qouted attribute in a script tag. |
static int |
INTERNAL_ATTR_SINGLE
Type specific to XMLTokenMaker denoting a line ending with an unclosed single-quote attribute. |
static int |
INTERNAL_ATTR_SINGLE_QUOTE_SCRIPT
Token type specifying we're in a single-qouted attribute in a script tag. |
static int |
INTERNAL_IN_JS
Token type specifying we're in JavaScript. |
static int |
INTERNAL_IN_JS_MLC
Token type specifying we're in a JavaScript multiline comment. |
static int |
INTERNAL_INTAG
Token type specific to HTMLTokenMaker; 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 |
INTERNAL_INTAG_SCRIPT
Token type specific to HTMLTokenMaker; this signals that the user has ended a line with an unclosed <script> tag. |
static int |
JAVASCRIPT
|
static int |
JS_MLC
|
static int |
PI
|
protected Token |
previousToken
Used in the creation of the linked list. |
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 |
Constructor Summary | |
---|---|
HTMLTokenMaker()
Constructor. |
|
HTMLTokenMaker(InputStream in)
Creates a new scanner. |
|
HTMLTokenMaker(Reader in)
Creates a new scanner There is also a java.io.InputStream version of this constructor. |
Method Summary | |
---|---|
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(Segment segment,
int start,
int end,
int tokenType,
int startOffset)
Adds the token specified to the current linked list of tokens. |
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. |
Action |
getInsertBreakAction()
Returns an action to handle "insert break" key presses (i.e. |
int |
getLastTokenTypeOnLine(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. |
boolean |
getMarkOccurrencesOfTokenType(int type)
Returns whether tokens of the specified type should have "mark occurrences" enabled for the current programming language. |
boolean |
getShouldIndentNextLineAfter(Token token)
The default implementation returns false always. |
Token |
getTokenList(Segment text,
int initialTokenType,
int startOffset)
Returns the first token in the linked list of tokens generated from text . |
boolean |
isWhitespaceVisible()
Returns whether whitespace is visible. |
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 |
setWhitespaceVisible(boolean visible)
Sets whether tokens are generated that "show" whitespace. |
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(Reader reader)
Resets the scanner to read from a new input stream. |
int |
yystate()
Returns the current lexical state. |
String |
yytext()
Returns the text matched by the current regular expression. |
Methods inherited from class org.fife.ui.rsyntaxtextarea.modes.AbstractMarkupTokenMaker |
---|
getLineCommentStartAndEnd, isMarkupLanguage |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int YYEOF
public static final int INTAG_CHECK_TAG_NAME
public static final int JS_MLC
public static final int INTAG_SCRIPT
public static final int INATTR_DOUBLE_SCRIPT
public static final int INATTR_SINGLE_SCRIPT
public static final int DTD
public static final int INATTR_SINGLE
public static final int INATTR_DOUBLE
public static final int YYINITIAL
public static final int INTAG
public static final int COMMENT
public static final int JAVASCRIPT
public static final int PI
public static final int INTERNAL_ATTR_DOUBLE
public static final int INTERNAL_ATTR_SINGLE
public static final int INTERNAL_INTAG
public static final int INTERNAL_INTAG_SCRIPT
<script>
tag.
public static final int INTERNAL_ATTR_DOUBLE_QUOTE_SCRIPT
public static final int INTERNAL_ATTR_SINGLE_QUOTE_SCRIPT
public static final int INTERNAL_IN_JS
public static final int INTERNAL_IN_JS_MLC
protected Token firstToken
protected Token currentToken
protected Token previousToken
Constructor Detail |
---|
public HTMLTokenMaker()
public HTMLTokenMaker(Reader in)
in
- the java.io.Reader to read input from.public HTMLTokenMaker(InputStream in)
in
- the java.io.Inputstream to read input from.Method Detail |
---|
public void addToken(char[] array, int start, int end, int tokenType, int startOffset)
addToken
in interface 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.public boolean getCompleteCloseTags()
getCompleteCloseTags
in class AbstractMarkupTokenMaker
setCompleteCloseTags(boolean)
public Token getTokenList(Segment text, int initialTokenType, int startOffset)
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.
Token
in a linked list representing
the syntax highlighted text.public static void setCompleteCloseTags(boolean complete)
complete
- Whether closing markup tags are completed.getCompleteCloseTags()
public final void yyreset(Reader reader)
reader
- the new input streampublic final void yyclose() throws IOException
IOException
public final int yystate()
public final void yybegin(int newState)
newState
- the new lexical statepublic final String yytext()
public final char yycharat(int pos)
pos
- the position of the character to fetch.
A value from 0 to yylength()-1.
public final int yylength()
public void yypushback(int number)
number
- the number of characters to be read again.
This number must not be greater than yylength()!public Token yylex() throws IOException
IOException
- if any I/O-Error occurspublic void addNullToken()
addNullToken
in interface TokenMaker
public void addToken(Segment segment, int start, int end, int tokenType, int startOffset)
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.public void addToken(char[] array, int start, int end, int tokenType, int startOffset, boolean hyperlink)
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.public boolean getCurlyBracesDenoteCodeBlocks()
The default implementation returns false
; subclasses can
override this method if necessary.
getCurlyBracesDenoteCodeBlocks
in interface TokenMaker
public Action getInsertBreakAction()
null
. Subclasses
can override.
getInsertBreakAction
in interface TokenMaker
null
.public int getLastTokenTypeOnLine(Segment text, int initialTokenType)
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
in interface 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
).
TokenTypes.NULL
if the line was completed.public boolean getMarkOccurrencesOfTokenType(int type)
TokenTypes.IDENTIFIER
.
Subclasses can override this method to support other token types, such
as TokenTypes.VARIABLE
.
getMarkOccurrencesOfTokenType
in interface TokenMaker
type
- The token type.
public boolean getShouldIndentNextLineAfter(Token token)
false
always. Languages
that wish to better support auto-indentation can override this method.
getShouldIndentNextLineAfter
in interface TokenMaker
token
- The token the previous line ends with.
public boolean isWhitespaceVisible()
isWhitespaceVisible
in interface TokenMaker
TokenMaker.setWhitespaceVisible(boolean)
protected void resetTokenList()
getLastTokenTypeOnLine(Segment, int)
or
TokenMaker.getTokenList(Segment, int, int)
.
public void setWhitespaceVisible(boolean visible)
setWhitespaceVisible
in interface TokenMaker
visible
- Whether whitespace should be visible.TokenMaker.isWhitespaceVisible()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |