net.sourceforge.squirrel_sql.plugins.syntax.rsyntax
Class SquirrelTokenMakerBase

java.lang.Object
  org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker
      net.sourceforge.squirrel_sql.plugins.syntax.rsyntax.SquirrelTokenMakerBase

All Implemented Interfaces:

org.fife.ui.rsyntaxtextarea.TokenMaker

Direct Known Subclasses:

SquirrelTokenMarker

public class SquirrelTokenMakerBase
extends org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker

This class generates tokens representing a text stream as SQL.

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 SQLTokenMaker.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.

Version:

0.5

Author:

Robert Futrell

Field Summary

static int	CHAR
protected org.fife.ui.rsyntaxtextarea.Token	currentToken
protected org.fife.ui.rsyntaxtextarea.Token	firstToken
static int	MLC
protected org.fife.ui.rsyntaxtextarea.Token	previousToken
static int	STRING lexical states
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

SquirrelTokenMakerBase()
Constructor.

SquirrelTokenMakerBase(InputStream in)
Creates a new scanner.

SquirrelTokenMakerBase(Reader in)
Creates a new scanner There is also a java.io.InputStream version of this constructor.

Method Summary

void	addNullToken()
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[] arg0, int arg1, int arg2, int arg3, int arg4, boolean arg5)
void	addToken(Segment arg0, int arg1, int arg2, int arg3, int arg4)
boolean	getCurlyBracesDenoteCodeBlocks()
int	getLastTokenTypeOnLine(Segment arg0, int arg1)
String[]	getLineCommentStartAndEnd() Returns the text to place at the beginning and end of a line to "comment" it in a this programming language.
boolean	getMarkOccurrencesOfTokenType(int arg0)
boolean	getShouldIndentNextLineAfter(org.fife.ui.rsyntaxtextarea.Token arg0)
org.fife.ui.rsyntaxtextarea.Token	getTokenList(Segment text, int initialTokenType, int startOffset) Returns the first token in the linked list of tokens generated from text.
boolean	isMarkupLanguage()
protected void	resetTokenList()
void	setWhitespaceVisible(boolean arg0, org.fife.ui.rsyntaxtextarea.RSyntaxTextArea arg1)
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.
org.fife.ui.rsyntaxtextarea.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 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

STRING

public static final int STRING

lexical states

See Also:

Constant Field Values

YYINITIAL

public static final int YYINITIAL

See Also:

Constant Field Values

MLC

public static final int MLC

See Also:

Constant Field Values

CHAR

public static final int CHAR

See Also:

Constant Field Values

firstToken

protected org.fife.ui.rsyntaxtextarea.Token firstToken

currentToken

protected org.fife.ui.rsyntaxtextarea.Token currentToken

previousToken

protected org.fife.ui.rsyntaxtextarea.Token previousToken

Constructor Detail

SquirrelTokenMakerBase

public SquirrelTokenMakerBase()

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

SquirrelTokenMakerBase

public SquirrelTokenMakerBase(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.

SquirrelTokenMakerBase

public SquirrelTokenMakerBase(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 org.fife.ui.rsyntaxtextarea.TokenMaker

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.

getLineCommentStartAndEnd

public String[] getLineCommentStartAndEnd()

Returns the text to place at the beginning and end of a line to "comment" it in a this programming language.

Specified by:

getLineCommentStartAndEnd in interface org.fife.ui.rsyntaxtextarea.TokenMaker

Returns:

The start and end strings to add to a line to "comment" it out.

getTokenList

public org.fife.ui.rsyntaxtextarea.Token getTokenList(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.

yyreset

public final void yyreset(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 IOException

Closes the input stream.

Throws:

IOException

yystate

public final int yystate()

Returns the current lexical state.

yybegin

public final void yybegin(int newState)

Enters a new lexical state

Parameters:

newState - the new lexical state

yytext

public final 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 org.fife.ui.rsyntaxtextarea.Token yylex()
                                        throws 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:

IOException - if any I/O-Error occurs

addNullToken

public void addNullToken()

Specified by:

addNullToken in interface org.fife.ui.rsyntaxtextarea.TokenMaker

addToken

public void addToken(Segment arg0,
                     int arg1,
                     int arg2,
                     int arg3,
                     int arg4)

addToken

public void addToken(char[] arg0,
                     int arg1,
                     int arg2,
                     int arg3,
                     int arg4,
                     boolean arg5)

getCurlyBracesDenoteCodeBlocks

public boolean getCurlyBracesDenoteCodeBlocks()

Specified by:

getCurlyBracesDenoteCodeBlocks in interface org.fife.ui.rsyntaxtextarea.TokenMaker

getLastTokenTypeOnLine

public int getLastTokenTypeOnLine(Segment arg0,
                                  int arg1)

Specified by:

getLastTokenTypeOnLine in interface org.fife.ui.rsyntaxtextarea.TokenMaker

getMarkOccurrencesOfTokenType

public boolean getMarkOccurrencesOfTokenType(int arg0)

Specified by:

getMarkOccurrencesOfTokenType in interface org.fife.ui.rsyntaxtextarea.TokenMaker

getShouldIndentNextLineAfter

public boolean getShouldIndentNextLineAfter(org.fife.ui.rsyntaxtextarea.Token arg0)

Specified by:

getShouldIndentNextLineAfter in interface org.fife.ui.rsyntaxtextarea.TokenMaker

isMarkupLanguage

public boolean isMarkupLanguage()

Specified by:

isMarkupLanguage in interface org.fife.ui.rsyntaxtextarea.TokenMaker

resetTokenList

protected void resetTokenList()

setWhitespaceVisible

public void setWhitespaceVisible(boolean arg0,
                                 org.fife.ui.rsyntaxtextarea.RSyntaxTextArea arg1)

Specified by:

setWhitespaceVisible in interface org.fife.ui.rsyntaxtextarea.TokenMaker