com.fgm.visibilityScriptingServer.Autocomplete.languages

Class PythonLanguageService

java.lang.Object

com.fgm.visibilityScriptingServer.Autocomplete.languages.PythonLanguageService

All Implemented Interfaces:

ICompletionService

public class PythonLanguageService
extends java.lang.Object
implements ICompletionService

Support class for autocomplete for the web IDE. Loads function calls and descriptions in the array of proposals. Later versions will use reflection as well. Currently unused.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LANGUAGE_NAME The language name.
protected org.apache.log4j.Logger	logger The logger.
protected java.util.HashMap<java.lang.String,java.util.ArrayList<CompletionProposal>>	specialCases The special cases.

Constructor Summary

Constructors

Constructor and Description
PythonLanguageService() Instantiates a new python language service.

Method Summary

Methods

Modifier and Type	Method and Description
CompletionResult	getProposals(java.lang.String document, java.lang.String curSelection) Gets the proposals.
private int	isDeclared(java.lang.String doc, java.lang.String selection) Determines if the selection refers to an object declared somewhere else in the script and returns the line number of the declaration or -1 if not found.
private int	isImport(java.lang.String doc, java.lang.String selection) Determines if the selection refers to either a class or module which is imported and returns the line number of the import.
private boolean	isSpecialCase(java.lang.String declaraction, CompletionResult result) Determines if the variable declaration is a special case existing in the specialCases HashMap and, if so, appends the List of CompletionPropals to the result making it ready to return.
private java.util.ArrayList<CompletionProposal>	parseScriptOutput(ScriptResultObject sro, CompletionResult result) Internal method for parsing the output of the jython script.
private java.lang.String	prepareScript(java.lang.String document, java.lang.String selection, CompletionResult result) Internal method used to prepare the jython script which returns introspection information about the module, class, list, dictionary, or string object.

Methods inherited from class java.lang.Object

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

Field Detail

LANGUAGE_NAME

public static java.lang.String LANGUAGE_NAME

The language name.

logger

protected org.apache.log4j.Logger logger

The logger.

specialCases

protected java.util.HashMap<java.lang.String,java.util.ArrayList<CompletionProposal>> specialCases

The special cases.

Constructor Detail

PythonLanguageService

public PythonLanguageService()

Instantiates a new python language service.

Method Detail

getProposals

public CompletionResult getProposals(java.lang.String document,
                            java.lang.String curSelection)

Description copied from interface: ICompletionService

Gets the proposals.

Specified by:

getProposals in interface ICompletionService

Parameters:

document - the document

curSelection - the cur selection

Returns:

the proposals

prepareScript

private java.lang.String prepareScript(java.lang.String document,
                             java.lang.String selection,
                             CompletionResult result)

Internal method used to prepare the jython script which returns introspection information about the module, class, list, dictionary, or string object. TODO: Pull required information from the provided document

Parameters:

document - the document

selection - the selection

result - the result

Returns:

ready to run jython script

parseScriptOutput

private java.util.ArrayList<CompletionProposal> parseScriptOutput(ScriptResultObject sro,
                                                        CompletionResult result)

Internal method for parsing the output of the jython script.

Parameters:

sro - result of running the jython script

result - the result

Returns:

list of filled in CompletionProposals

isImport

private int isImport(java.lang.String doc,
           java.lang.String selection)

Determines if the selection refers to either a class or module which is imported and returns the line number of the import.

Parameters:

doc - whole script

selection - selected text to run info on

Returns:

line number of import, -1 if not found

isDeclared

private int isDeclared(java.lang.String doc,
             java.lang.String selection)

Determines if the selection refers to an object declared somewhere else in the script and returns the line number of the declaration or -1 if not found.

Parameters:

doc - whole script

selection - selected text to run info on

Returns:

line number of declaration, -1 if not found

isSpecialCase

private boolean isSpecialCase(java.lang.String declaraction,
                    CompletionResult result)

Determines if the variable declaration is a special case existing in the specialCases HashMap and, if so, appends the List of CompletionPropals to the result making it ready to return.

Parameters:

declaraction - python variable declaration

result - the result

Returns:

true if the variable is a special case