org.fife.ui.rsyntaxtextarea.parser.Parser Maven / Gradle / Ivy
/*
* 09/23/2005
*
* Parser.java - An interface for a parser for RSyntaxTextArea.
*
* This library is distributed under a modified BSD license. See the included
* LICENSE file for details.
*/
package org.fife.ui.rsyntaxtextarea.parser;
import java.net.URL;
import org.fife.ui.rsyntaxtextarea.RSyntaxDocument;
/**
* An interface for a parser for content in an
* {@link org.fife.ui.rsyntaxtextarea.RSyntaxTextArea}.
* A Parser returns a list of issues it finds in the text area's
* content, which the text area can flag (e.g. squiggle underline). It can
* also return descriptions of the issues, to be used in tool tips.
*
* To install a Parser, simply call
* {@link org.fife.ui.rsyntaxtextarea.RSyntaxTextArea#addParser(Parser)}.
*
* @author Robert Futrell
* @version 0.5
* @see AbstractParser
*/
public interface Parser {
/**
* Returns the listener for hyperlink events from
* {@link org.fife.ui.rsyntaxtextarea.focusabletip.FocusableTip}s, or
* null if none.
*
* @return The listener.
*/
ExtendedHyperlinkListener getHyperlinkListener();
/**
* Returns the base URL for any images displayed in returned
* {@link ParserNotice} HTML text. Note that if a parser notice's text
* is not HTML, this URL is not used.
*
* @return The URL. This may be null.
*/
URL getImageBase();
/**
* Returns whether this parser is enabled. If this returns
* false, it will not be run.
*
* @return Whether this parser is enabled.
*/
boolean isEnabled();
/**
* Parses input from the specified document.
*
* @param doc The document to parse. This document is in a read lock,
* so it cannot be modified while parsing is occurring.
* @param style The language being rendered, such as
* {@link org.fife.ui.rsyntaxtextarea.SyntaxConstants#SYNTAX_STYLE_JAVA}.
* @return An object describing the section of the document parsed and the
* results. This is guaranteed to be non-null.
*/
ParseResult parse(RSyntaxDocument doc, String style);
}