org.fife.rsta.ac.js

Class JavaScriptParser

java.lang.Object

AbstractParser

org.fife.rsta.ac.js.JavaScriptParser

public class JavaScriptParser
extends AbstractParser

Parses JavaScript code in an RSyntaxTextArea.

Like all RSTA Parsers, a JavaScriptParser instance is notified when the RSTA's text content changes. After a small delay, it will parse the content as JS code, building an AST and looking for any errors. When parsing is complete, a property change event of type PROPERTY_AST is fired. Listeners can check the new value of the property for the AstRoot built that represents the source code in the text area.

This parser cannot be shared amongst multiple instances of RSyntaxTextArea.

Please keep in mind that this class is a work-in-progress!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavaScriptParser.JSErrorReporter Error reporter for Rhino-based parsing.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_AST The property change event that's fired when the document is re-parsed.

Constructor Summary

Constructors

Constructor and Description
JavaScriptParser(JavaScriptLanguageSupport langSupport, RSyntaxTextArea textArea) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.lang.String prop, java.beans.PropertyChangeListener l) Registers a property change listener on this parser.
static org.mozilla.javascript.CompilerEnvirons	createCompilerEnvironment(org.mozilla.javascript.ErrorReporter errorHandler, JavaScriptLanguageSupport langSupport) Creates options for Rhino based off of the user's preferences.
org.mozilla.javascript.ast.AstRoot	getAstRoot() Returns the AST, or null if the editor's content has not yet been parsed.
int	getJsHintIndent()
java.io.File	getJsHintRCFile(RSyntaxTextArea textArea) Returns the location of the .jshintrc file to use if using JsHint as your error parser.
VariableResolver	getVariablesAndFunctions()
ParseResult	parse(RSyntaxDocument doc, java.lang.String style)
void	removePropertyChangeListener(java.lang.String prop, java.beans.PropertyChangeListener l) Removes a property change listener from this parser.
void	setVariablesAndFunctions(VariableResolver variableResolver)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_AST

public static final java.lang.String PROPERTY_AST

The property change event that's fired when the document is re-parsed. Applications can listen for this property change and update themselves accordingly. The "new" value of this property will be an instance of org.mozilla.javascript.ast.AstRoot.

See Also:

Constant Field Values

Constructor Detail

JavaScriptParser

public JavaScriptParser(JavaScriptLanguageSupport langSupport,
                        RSyntaxTextArea textArea)

Constructor.

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String prop,
                                      java.beans.PropertyChangeListener l)

Registers a property change listener on this parser. You'll probably want to listen for changes to PROPERTY_AST.

Parameters:

prop - The property to listen for changes in.

l - The listener to add.

See Also:

removePropertyChangeListener(String, PropertyChangeListener)

createCompilerEnvironment

public static org.mozilla.javascript.CompilerEnvirons createCompilerEnvironment(org.mozilla.javascript.ErrorReporter errorHandler,
                                                                                JavaScriptLanguageSupport langSupport)

Creates options for Rhino based off of the user's preferences.

Parameters:

errorHandler - The container for errors found while parsing.

Returns:

The properties for the JS compiler to use.

getAstRoot

public org.mozilla.javascript.ast.AstRoot getAstRoot()

Returns the AST, or null if the editor's content has not yet been parsed.

Returns:

The AST, or null.

getJsHintIndent

public int getJsHintIndent()

getJsHintRCFile

public java.io.File getJsHintRCFile(RSyntaxTextArea textArea)

Returns the location of the .jshintrc file to use if using JsHint as your error parser. This property is ignored if #getErrorParser() does not return JsErrorParser.JSHINT.

Parameters:

textArea - The text component.

Returns:

The .jshintrc file, or null if none; in that case, the JsHint defaults will be used.

See Also:

#setJsHintRCFile(File), #setErrorParser(JsErrorParser)

parse

public ParseResult parse(RSyntaxDocument doc,
                         java.lang.String style)

setVariablesAndFunctions

public void setVariablesAndFunctions(VariableResolver variableResolver)

getVariablesAndFunctions

public VariableResolver getVariablesAndFunctions()

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String prop,
                                         java.beans.PropertyChangeListener l)

Removes a property change listener from this parser.

Parameters:

prop - The property that was being listened to.

l - The listener to remove.

See Also:

addPropertyChangeListener(String, PropertyChangeListener)