processing.app.syntax

Class TokenMarkerState

Object

TokenMarkerState

public class TokenMarkerState
extends Object

This class serves only as a workaround to preserve API and should be removed in the next major version. Base TokenMarker which serves as superclass for token markes for various modes is stateful, but single instance was shared between all tabs and Editors. This caused inherent bugs by leaking state between contexts. TokenMarker subclasses now serve two purposes: they keep keyword list and they override markTokensImpl to provide the marking logic. Since each tab and Editor should have it's own token marker state, I extracted most of the fields and associated metods working with them from TokenMarker into this class, and allowed TokenMarker to create instances of this class when requested. The way marking logic is handled is unfortunate, since markTokensImpl is expected to call addToken() of TokenMarker superclass instead of – for example - returning a List of tokens. I worked around this by plugging in TokenMarkerState instance as listener before markTokensImpl is called. This behavior is safe since TokenMarker is always operated from Event Dispatch Thread and no multithreading is involved. This allows having only single instance of TokenMarker in a way it was intended before while keeping state separate for each tab. In the next major version TokenMarker shound be redesigned with following requirements in mind: - Single instance of keyword list and other common data, initialized by Mode - Each tab should have its own instance of TokenMarker containing its state - Support multiple flavors for different doc types - Other modes should provide logic in a way which is compatible with multiple states (pure function? Function object?). Currently state, logic and keywords list are tied together into one TokenMarker instance, which leads to need for this workaround.

Method Summary

Modifier and Type	Method and Description
void	deleteLines(int index, int lines) Informs the token marker that line have been deleted from the document.
int	getLineCount() Returns the number of lines in this token marker.
void	insertLines(int index, int lines) Informs the token marker that lines have been inserted into the document.
boolean	isNextLineRequested() Returns true if the next line should be repainted.
Token	markTokens(Segment line, int lineIndex) A wrapper for the lower-level markTokensImpl method that is called to split a line up into tokens.

Methods inherited from class Object

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

Method Detail

markTokens

public Token markTokens(Segment line,
                        int lineIndex)

A wrapper for the lower-level markTokensImpl method that is called to split a line up into tokens.

Parameters:

line - The line

lineIndex - The line number

insertLines

public void insertLines(int index,
                        int lines)

Informs the token marker that lines have been inserted into the document. This inserts a gap in the lineInfo array.

Parameters:

index - The first line number

lines - The number of lines

deleteLines

public void deleteLines(int index,
                        int lines)

Informs the token marker that line have been deleted from the document. This removes the lines in question from the lineInfo array.

Parameters:

index - The first line number

lines - The number of lines

getLineCount

public int getLineCount()

Returns the number of lines in this token marker.

isNextLineRequested

public boolean isNextLineRequested()

Returns true if the next line should be repainted. This will return true after a line has been tokenized that starts a multiline token that continues onto the next line.