org.fife.rsta.ac.js

Class SourceCompletionProvider

java.lang.Object

DefaultCompletionProvider

org.fife.rsta.ac.js.SourceCompletionProvider

public class SourceCompletionProvider
extends DefaultCompletionProvider

Completion provider for JavaScript source code (not comments or strings).

Constructor Summary

Constructors

Constructor and Description
SourceCompletionProvider(boolean xmlSupported)
SourceCompletionProvider(java.lang.String javaScriptEngine, boolean xmlSupported)

Method Summary

Modifier and Type	Method and Description
void	debugCodeBlock(CodeBlock block, int tab)
JavaScriptVariableDeclaration	findDeclaration(java.lang.String name) Convenience method to call variable resolver
JavaScriptVariableDeclaration	findNonLocalDeclaration(java.lang.String name) Convenience method to call variable resolver for non local variables i.e does NOT try to resolve name to any local variables (just pre-processed or system)
java.lang.String	getAlreadyEnteredText(javax.swing.text.JTextComponent comp)
java.util.List<Completion>	getCompletionsAt(javax.swing.text.JTextComponent tc, java.awt.Point p)
protected java.util.List<Completion>	getCompletionsImpl(javax.swing.text.JTextComponent comp)
JarManager	getJarManager()
JavaScriptEngine	getJavaScriptEngine()
JavaScriptTypesFactory	getJavaScriptTypesFactory()
JavaScriptLanguageSupport	getLanguageSupport()
PreProcessingScripts	getPreProcessingScripts()
java.lang.String	getSelf() returns the Base class for the source completion provider.
SourceLocation	getSourceLocForClass(java.lang.String className)
TypeDeclarationFactory	getTypesFactory()
VariableResolver	getVariableResolver()
protected boolean	isValidChar(char ch)
boolean	isXMLSupported()
protected CodeBlock	iterateAstRoot(org.mozilla.javascript.ast.AstRoot root, java.util.Set<Completion> set, java.lang.String entered, int dot, TypeDeclarationOptions options) Iterates through AstRoot to extract all code blocks, functions, variables etc....
void	parseDocument(int dot)
protected void	recursivelyAddLocalVars(java.util.Set<Completion> completions, CodeBlock block, int dot, java.lang.String text, boolean findMatch, boolean isPreprocessing) Iterate though the CodeBlock and extract all variables within scope
TypeDeclaration	resolveTypeDeclation(java.lang.String name) Convenience method to call variable resolver
TypeDeclaration	resolveTypeFromFunctionNode(org.mozilla.javascript.ast.AstNode functionNode) Get the source of the node and try to resolve function node:
void	setJarManager(JarManager jarManager) The jar manager is used to parse the JS API for function completions
void	setJavaScriptEngine(JavaScriptEngine engine)
void	setJavaScriptTypesFactory(JavaScriptTypesFactory factory)
void	setPreProcessingScripts(PreProcessingScripts preProcessing)
void	setSelf(java.lang.String self)
void	setShorthandCache(ShorthandCompletionCache shorthandCache) Set template completion cache for source completion provider
void	setTypeDeclationOptions(TypeDeclarationOptions typeDeclarationOptions) Set type declaration options for parser
void	setXMLSupported(boolean xmlSupported)

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceCompletionProvider

public SourceCompletionProvider(boolean xmlSupported)

SourceCompletionProvider

public SourceCompletionProvider(java.lang.String javaScriptEngine,
                                boolean xmlSupported)

Method Detail

setShorthandCache

public void setShorthandCache(ShorthandCompletionCache shorthandCache)

Set template completion cache for source completion provider

Parameters:

templateCache -

getCompletionsAt

public java.util.List<Completion> getCompletionsAt(javax.swing.text.JTextComponent tc,
                                                   java.awt.Point p)

getCompletionsImpl

protected java.util.List<Completion> getCompletionsImpl(javax.swing.text.JTextComponent comp)

getSelf

public java.lang.String getSelf()

returns the Base class for the source completion provider. This is represented by a class name or ECMA lookup name e.g set to 'Global' for server side or 'Window' for client JavaScript support

Returns:

base class for the completion provider

getAlreadyEnteredText

public java.lang.String getAlreadyEnteredText(javax.swing.text.JTextComponent comp)

iterateAstRoot

protected CodeBlock iterateAstRoot(org.mozilla.javascript.ast.AstRoot root,
                                   java.util.Set<Completion> set,
                                   java.lang.String entered,
                                   int dot,
                                   TypeDeclarationOptions options)

Iterates through AstRoot to extract all code blocks, functions, variables etc.... e.g functions, if statements, variables

Parameters:

root - AstRoot to iterate

set - add add completions to set (functions only TODO remove this and do elsewhere)

entered - already entered text

dot - position in code

preProcessingMode - flag to state whether the parsing is before the RSTA parsing

Returns:

resolveTypeDeclation

public TypeDeclaration resolveTypeDeclation(java.lang.String name)

Convenience method to call variable resolver

Parameters:

name -

Returns:

findDeclaration

public JavaScriptVariableDeclaration findDeclaration(java.lang.String name)

Convenience method to call variable resolver

Parameters:

name -

Returns:

JavaScript variable declaration

findNonLocalDeclaration

public JavaScriptVariableDeclaration findNonLocalDeclaration(java.lang.String name)

Convenience method to call variable resolver for non local variables i.e does NOT try to resolve name to any local variables (just pre-processed or system)

Parameters:

name -

Returns:

JavaScript variable declaration

resolveTypeFromFunctionNode

public TypeDeclaration resolveTypeFromFunctionNode(org.mozilla.javascript.ast.AstNode functionNode)

Get the source of the node and try to resolve function node:

Parameters:

functionNode -

Returns:

a.toString().getCharAt(1); returns String TypeDeclaration

setJavaScriptTypesFactory

public void setJavaScriptTypesFactory(JavaScriptTypesFactory factory)

getJavaScriptTypesFactory

public JavaScriptTypesFactory getJavaScriptTypesFactory()

recursivelyAddLocalVars

protected void recursivelyAddLocalVars(java.util.Set<Completion> completions,
                                       CodeBlock block,
                                       int dot,
                                       java.lang.String text,
                                       boolean findMatch,
                                       boolean isPreprocessing)

Iterate though the CodeBlock and extract all variables within scope

Parameters:

completions -

block -

dot -

text -

findMatch -

isValidChar

protected boolean isValidChar(char ch)

setJarManager

public void setJarManager(JarManager jarManager)

The jar manager is used to parse the JS API for function completions

Parameters:

jarManager -

getJarManager

public JarManager getJarManager()

getVariableResolver

public VariableResolver getVariableResolver()

getLanguageSupport

public JavaScriptLanguageSupport getLanguageSupport()

setPreProcessingScripts

public void setPreProcessingScripts(PreProcessingScripts preProcessing)

getPreProcessingScripts

public PreProcessingScripts getPreProcessingScripts()

getJavaScriptEngine

public JavaScriptEngine getJavaScriptEngine()

setJavaScriptEngine

public void setJavaScriptEngine(JavaScriptEngine engine)

getSourceLocForClass

public SourceLocation getSourceLocForClass(java.lang.String className)

isXMLSupported

public boolean isXMLSupported()

setXMLSupported

public void setXMLSupported(boolean xmlSupported)

setSelf

public void setSelf(java.lang.String self)

parseDocument

public void parseDocument(int dot)

getTypesFactory

public TypeDeclarationFactory getTypesFactory()

setTypeDeclationOptions

public void setTypeDeclationOptions(TypeDeclarationOptions typeDeclarationOptions)

Set type declaration options for parser

Parameters:

typeDeclarationOptions -

debugCodeBlock

public void debugCodeBlock(CodeBlock block,
                           int tab)