Package org.fife.ui.rsyntaxtextarea
Class ParserManager
java.lang.Object
org.fife.ui.rsyntaxtextarea.ParserManager
- All Implemented Interfaces:
ActionListener
,PropertyChangeListener
,EventListener
,DocumentListener
,HyperlinkListener
class ParserManager
extends Object
implements DocumentListener, ActionListener, HyperlinkListener, PropertyChangeListener
Manages running a parser object for an
RSyntaxTextArea
.- Version:
- 0.9
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
Mapping of a parser notice to its highlight in the editor. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final boolean
Whether to print debug messages while running parsers.private static final int
The default delay between the last key press and when the document is parsed, in milliseconds.private Position
private Position
private List
<ParserManager.NoticeHighlightPair> Mapping of notices to their highlights in the editor.Painter used to underline errors.private Parser
private static final String
If this system property is set totrue
, debug messages will be printed to stdout to help diagnose parsing issues.private boolean
private RSyntaxTextArea
private Timer
-
Constructor Summary
ConstructorsConstructorDescriptionParserManager
(int delay, RSyntaxTextArea textArea) Constructor.ParserManager
(RSyntaxTextArea textArea) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Called when the timer fires (e.g.void
Adds a parser for the text area.private void
Adds highlights for a list of parser notices.void
Called when the document is modified.private void
private void
clearParserNoticeHighlights
(Parser parser) Removes all parser notice highlights for a specific parser.void
Removes all parsers and any highlights they have created.void
forceReparsing
(int parser) Forces the givenParser
to reparse the content of this text area.int
getDelay()
Returns the delay between the last "concurrent" edit and when the document is reparsed.getParser
(int index) Returns the specified parser.int
Returns the number of registered parsers.Returns a list of the current parser notices for this text area.Returns the tool tip to display for a mouse event at the given location.void
Called when the document is modified.void
Called when the user clicks a hyperlink in aFocusableTip
.void
Called when the document is modified.private boolean
noticeContainsPointInView
(ParserNotice notice, Point p) SinceviewToModel()
returns the closest model position, and the position doesn't necessarily contain the point passed in as an argument, this method checks whether the point is indeed contained in the view rectangle for the specified offset.private boolean
noticeContainsPosition
(ParserNotice notice, int offs) Returns whether a parser notice contains the specified offset.void
Called when a property we're interested in changes.boolean
removeParser
(Parser parser) Removes a parser.private void
removeParserNotices
(Parser parser) Removes all parser notices (and clears highlights in the editor) from a particular parser.private void
Removes any currently stored notices (and the corresponding highlights from the editor) from the same Parser, and in the given line range, as in the results.void
Called when the document is modified.void
Restarts parsing the document.void
setDelay
(int millis) Sets the delay between the last "concurrent" edit and when the document is reparsed.private boolean
shouldRemoveNotice
(ParserNotice notice, ParseResult res) Returns whether a parser notice should be removed, based on a parse result.void
Stops parsing the document.
-
Field Details
-
textArea
-
parsers
-
timer
-
running
private boolean running -
parserForTip
-
firstOffsetModded
-
lastOffsetModded
-
noticeHighlightPairs
Mapping of notices to their highlights in the editor. Can't use a Map since parsers could return twoParserNotice
s that compare equally viaequals()
. Real-world example: The Perl compiler will return 2+ identical error messages if the same error is committed in a single line more than once. -
parserErrorHighlightPainter
Painter used to underline errors. -
PROPERTY_DEBUG_PARSING
If this system property is set totrue
, debug messages will be printed to stdout to help diagnose parsing issues.- See Also:
-
DEBUG_PARSING
private static final boolean DEBUG_PARSINGWhether to print debug messages while running parsers. -
DEFAULT_DELAY_MS
private static final int DEFAULT_DELAY_MSThe default delay between the last key press and when the document is parsed, in milliseconds.- See Also:
-
-
Constructor Details
-
ParserManager
ParserManager(RSyntaxTextArea textArea) Constructor.- Parameters:
textArea
- The text area whose document the parser will be parsing.
-
ParserManager
ParserManager(int delay, RSyntaxTextArea textArea) Constructor.- Parameters:
delay
- The delay between the last key press and when the document is parsed.textArea
- The text area whose document the parser will be parsing.
-
-
Method Details
-
actionPerformed
Called when the timer fires (e.g. it's time to parse the document).- Specified by:
actionPerformed
in interfaceActionListener
- Parameters:
e
- The event.
-
addParser
Adds a parser for the text area.- Parameters:
parser
- The new parser. If this isnull
, nothing happens.- See Also:
-
addParserNoticeHighlights
Adds highlights for a list of parser notices. Any current notices from the same Parser, in the same parsed range, are removed.- Parameters:
res
- The result of a parsing.- See Also:
-
changedUpdate
Called when the document is modified.- Specified by:
changedUpdate
in interfaceDocumentListener
- Parameters:
e
- The document event.
-
clearParserNoticeHighlights
private void clearParserNoticeHighlights() -
clearParserNoticeHighlights
Removes all parser notice highlights for a specific parser.- Parameters:
parser
- The parser whose highlights to remove.
-
clearParsers
public void clearParsers()Removes all parsers and any highlights they have created.- See Also:
-
forceReparsing
public void forceReparsing(int parser) Forces the givenParser
to reparse the content of this text area.This method can be useful when a
Parser
can be configured as to what notices it returns. For example, if a Java language parser can be configured to set whether no serialVersionUID is a warning, error, or ignored, this method can be called after changing the expected notice type to have the document reparsed.- Parameters:
parser
- The index of theParser
to re-run.- See Also:
-
getDelay
public int getDelay()Returns the delay between the last "concurrent" edit and when the document is reparsed.- Returns:
- The delay, in milliseconds.
- See Also:
-
getParser
Returns the specified parser.- Parameters:
index
- The index of the parser.- Returns:
- The parser.
- See Also:
-
getParserCount
public int getParserCount()Returns the number of registered parsers.- Returns:
- The number of registered parsers.
-
getParserNotices
Returns a list of the current parser notices for this text area. This method (like most Swing methods) should only be called on the EDT.- Returns:
- The list of notices. This will be an empty list if there are none.
-
getToolTipText
Returns the tool tip to display for a mouse event at the given location. This method is overridden to give a registered parser a chance to display a tool tip (such as an error description when the mouse is over an error highlight).- Parameters:
e
- The mouse event.- Returns:
- The tool tip to display, and possibly a hyperlink event handler.
-
handleDocumentEvent
Called when the document is modified.- Parameters:
e
- The document event.
-
hyperlinkUpdate
Called when the user clicks a hyperlink in aFocusableTip
.- Specified by:
hyperlinkUpdate
in interfaceHyperlinkListener
- Parameters:
e
- The event.
-
insertUpdate
Called when the document is modified.- Specified by:
insertUpdate
in interfaceDocumentListener
- Parameters:
e
- The document event.
-
noticeContainsPosition
Returns whether a parser notice contains the specified offset.- Parameters:
notice
- The notice.offs
- The offset.- Returns:
- Whether the notice contains the offset.
-
noticeContainsPointInView
SinceviewToModel()
returns the closest model position, and the position doesn't necessarily contain the point passed in as an argument, this method checks whether the point is indeed contained in the view rectangle for the specified offset.- Parameters:
notice
- The parser notice.p
- The point possibly contained in the view range of the parser notice.- Returns:
- Whether the parser notice actually contains the specified point in the view.
-
propertyChange
Called when a property we're interested in changes.- Specified by:
propertyChange
in interfacePropertyChangeListener
- Parameters:
e
- The property change event.
-
removeParser
Removes a parser.- Parameters:
parser
- The parser to remove.- Returns:
- Whether the parser was found.
- See Also:
-
removeParserNotices
Removes all parser notices (and clears highlights in the editor) from a particular parser.- Parameters:
parser
- The parser.
-
removeParserNotices
Removes any currently stored notices (and the corresponding highlights from the editor) from the same Parser, and in the given line range, as in the results.- Parameters:
res
- The results.
-
removeUpdate
Called when the document is modified.- Specified by:
removeUpdate
in interfaceDocumentListener
- Parameters:
e
- The document event.
-
restartParsing
public void restartParsing()Restarts parsing the document.- See Also:
-
setDelay
public void setDelay(int millis) Sets the delay between the last "concurrent" edit and when the document is reparsed.- Parameters:
millis
- The new delay, in milliseconds. This must be greater than0
.- See Also:
-
shouldRemoveNotice
Returns whether a parser notice should be removed, based on a parse result.- Parameters:
notice
- The notice in question.res
- The result.- Returns:
- Whether the notice should be removed.
-
stopParsing
public void stopParsing()Stops parsing the document.- See Also:
-