org.das2.jythoncompletion

Class JythonCompletionTask

java.lang.Object

org.das2.jythoncompletion.JythonCompletionTask

All Implemented Interfaces:

CompletionTask

public class JythonCompletionTask
extends java.lang.Object
implements CompletionTask

Completions for Jython code. The completion task is created with the editor configured for completions (code and caret position within code), and "query" is called which will fill a CompletionResultSet.

See Also:

JythonCompletionProvider

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	__CLASSTYPE
static java.lang.String	CLIENT_PROPERTY_INTERPRETER_PROVIDER
static java.lang.String	CLIENT_PROPERTY_PWD

Constructor Summary

Constructors

Constructor and Description
JythonCompletionTask(javax.swing.text.JTextComponent t) create the completion task on the text component, using its content and caret position.

Method Summary

Modifier and Type	Method and Description
void	cancel() Called by the code completion infrastructure to cancel the task.
int	doQuery(CompletionContext cc, CompletionResultSet resultSet) perform the completions query.
static java.lang.String	escapeHtml(java.lang.String s)
static javax.swing.ImageIcon	getIconFor(java.lang.Object jm) return an identifying icon for the object, or null.
static int	getImportableCompletions(java.lang.String source, CompletionContext cc, CompletionResultSet result) get completions by looking at importLookup.jy, which is a list of commonly imported codes.
static java.lang.String	getLastLine(java.lang.String script)
static java.util.List<DefaultCompletionItem>	getLocalsCompletions(PythonInterpreter interp, CompletionContext cc) get the list of available names at this point in the code.
static int	getLocalsCompletions(PythonInterpreter interp, CompletionContext cc, CompletionResultSet rs) get the locals completions, populating the result set
static <T extends java.lang.Comparable<T>> void	keySort(java.util.List<T> key, java.util.List<?>... lists) sorts all the lists by the first list.
void	query(CompletionResultSet arg0) Called by the code completion infrastructure to ask the task to do a query and return the results through the given completion listener.
static void	reduceObject(java.util.List<java.lang.String> signatures, java.util.List<java.lang.String> labels, java.util.List<java.lang.String> argss)
void	refresh(CompletionResultSet arg0) Called by the code completion infrastructure to inform the task about changes in the corresponding document.
static java.lang.String	trimLinesToMakeValid(java.lang.String script) introduced to see if we can pop a little code from the end, in case we are within a triple-quoted string.

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_PROPERTY_INTERPRETER_PROVIDER

public static final java.lang.String CLIENT_PROPERTY_INTERPRETER_PROVIDER

See Also:

Constant Field Values

CLIENT_PROPERTY_PWD

public static final java.lang.String CLIENT_PROPERTY_PWD

See Also:

Constant Field Values

__CLASSTYPE

public static final java.lang.String __CLASSTYPE

See Also:

Constant Field Values

Constructor Detail

JythonCompletionTask

public JythonCompletionTask(javax.swing.text.JTextComponent t)

create the completion task on the text component, using its content and caret position.

Parameters:

t - the text component

Method Detail

query

public void query(CompletionResultSet arg0)
           throws PyException

Description copied from interface: CompletionTask

Called by the code completion infrastructure to ask the task to do a query and return the results through the given completion listener.
This method is called only once during the lifetime of the completion task object.

This method is always called in AWT thread but it may reschedule its processing into another thread and fire the given listener once the computing is finished.

Specified by:

query in interface CompletionTask

Parameters:

arg0 - non-null result set to which the results of the query must be added.

Throws:

PyException

doQuery

public int doQuery(CompletionContext cc,
                   CompletionResultSet resultSet)

perform the completions query. This is the heart of Jython completions.

Parameters:

cc -

resultSet -

Returns:

the count

getLastLine

public static java.lang.String getLastLine(java.lang.String script)

trimLinesToMakeValid

public static java.lang.String trimLinesToMakeValid(java.lang.String script)

introduced to see if we can pop a little code from the end, in case we are within a triple-quoted string.

Parameters:

script - the script

Returns:

the script, possibly with a few fewer lines.

See Also:

SimplifyScriptSupport.alligatorParse(java.lang.String)

refresh

public void refresh(CompletionResultSet arg0)

Description copied from interface: CompletionTask

Called by the code completion infrastructure to inform the task about changes in the corresponding document. The task should reflect these changes while creating the query result.
This method can be called multiple times on a single task instance.
Typically it is called AFTER the query() was invoked but it may also be invoked BEFORE the query() in case the user types even before the query() was called by the infrastructure. In such case the resultSet parameter will be null.
It is guaranteed that this method will not be invoked in case the document instance set in the component would change since the last invocation of either the query() or refresh().

This method is always called in AWT thread but it may reschedule its processing into another thread and fire the given listener once the computing is finished.

Specified by:

refresh in interface CompletionTask

Parameters:

arg0 - non-null result set to which the results of the refreshing must be added.
Null result set may be passed in case the query() was not invoked yet and user has typed a character. In this case the provider may hide the completion by using Completion.get().hideAll() if the typed character is inappropriate e.g. ";" for java completion.

cancel

public void cancel()

Description copied from interface: CompletionTask

Called by the code completion infrastructure to cancel the task.
Once the cancel is done on the task no more querying or refreshing is done on it.

This method may potentially be called from any thread.

Specified by:

cancel in interface CompletionTask

getLocalsCompletions

public static int getLocalsCompletions(PythonInterpreter interp,
                                       CompletionContext cc,
                                       CompletionResultSet rs)

get the locals completions, populating the result set

Parameters:

interp - the interpreter

cc - the completion context

rs - the result set object which will contain the completions

Returns:

the number of completions found.

See Also:

#getLocalsCompletions(org.python.util.PythonInterpreter, org.das2.jythoncompletion.CompletionContext)

getImportableCompletions

public static int getImportableCompletions(java.lang.String source,
                                           CompletionContext cc,
                                           CompletionResultSet result)

get completions by looking at importLookup.jy, which is a list of commonly imported codes.

Parameters:

source - the script source.

cc -

result -

Returns:

escapeHtml

public static java.lang.String escapeHtml(java.lang.String s)

keySort

public static <T extends java.lang.Comparable<T>> void keySort(java.util.List<T> key,
                                                               java.util.List<?>... lists)

sorts all the lists by the first list. See http://stackoverflow.com/questions/15400514/syncronized-sorting-between-two-arraylists/24688828#24688828 Note the key list must be repeated for it to be sorted as well!

Type Parameters:

T - the list type

Parameters:

key - the list used to sort

lists - the lists to be sorted, often containing the key as well.

reduceObject

public static void reduceObject(java.util.List<java.lang.String> signatures,
                                java.util.List<java.lang.String> labels,
                                java.util.List<java.lang.String> argss)

getLocalsCompletions

public static java.util.List<DefaultCompletionItem> getLocalsCompletions(PythonInterpreter interp,
                                                                         CompletionContext cc)

get the list of available names at this point in the code.

Parameters:

interp - the interpreter

cc - the completion context

Returns:

the list of completions.

getIconFor

public static javax.swing.ImageIcon getIconFor(java.lang.Object jm)

return an identifying icon for the object, or null.

Parameters:

jm - java.lang.reflect.Method, or PyInteger, etc.

Returns:

the icon or null.