org.fife.rsta.ac.perl

Class PerlCompletionProvider

java.lang.Object

LanguageAwareCompletionProvider

org.fife.rsta.ac.c.CCompletionProvider

org.fife.rsta.ac.perl.PerlCompletionProvider

public class PerlCompletionProvider
extends CCompletionProvider

A completion provider for Perl. It provides:

• Auto-completion for standard Perl 5.10 functions (read from an XML file).
• Crude auto-completion for variables. Only variables in scope at the current caret position are suggested, but there may still be issues with variable types, etc.

To toggle whether parameter assistance wraps your parameters in parens, use the setUseParensWithFunctions(boolean) method.

Constructor Summary

Constructors

Constructor and Description
PerlCompletionProvider()

Method Summary

Modifier and Type	Method and Description
protected void	addShorthandCompletions(DefaultCompletionProvider codeCP) Adds shorthand completions to the code completion provider.
protected CompletionProvider	createCodeCompletionProvider() Returns the provider to use when editing code.
protected CompletionProvider	createStringCompletionProvider() Returns the completion provider to use when the caret is in a string.
protected java.util.List<Completion>	getCompletionsImpl(javax.swing.text.JTextComponent comp)
char	getParameterListEnd() Overridden to return the null char (meaning "no end character") if the user doesn't want to use parens around their functions.
char	getParameterListStart() Overridden to return the null char (meaning "no start character") if the user doesn't want to use parens around their functions.
boolean	getUseParensWithFunctions() Returns whether the user wants to use parens around parameters to functions.
protected java.lang.String	getXmlResource() Returns the name of the XML resource to load (on classpath or a file).
void	setUseParensWithFunctions(boolean use) Sets whether the user wants to use parens around parameters to functions.

Methods inherited from class org.fife.rsta.ac.c.CCompletionProvider

createCommentCompletionProvider, loadCodeCompletionsFromXml

Methods inherited from class java.lang.Object

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

Constructor Detail

PerlCompletionProvider

public PerlCompletionProvider()

Method Detail

addShorthandCompletions

protected void addShorthandCompletions(DefaultCompletionProvider codeCP)

Adds shorthand completions to the code completion provider.

Overrides:

addShorthandCompletions in class CCompletionProvider

Parameters:

codeCP - The code completion provider.

createCodeCompletionProvider

protected CompletionProvider createCodeCompletionProvider()

Returns the provider to use when editing code.

Overrides:

createCodeCompletionProvider in class CCompletionProvider

Returns:

The provider.

See Also:

CCompletionProvider.createCommentCompletionProvider(), CCompletionProvider.createStringCompletionProvider(), CCompletionProvider.loadCodeCompletionsFromXml(DefaultCompletionProvider), CCompletionProvider.addShorthandCompletions(DefaultCompletionProvider)

createStringCompletionProvider

protected CompletionProvider createStringCompletionProvider()

Returns the completion provider to use when the caret is in a string.

Overrides:

createStringCompletionProvider in class CCompletionProvider

Returns:

The provider.

See Also:

CCompletionProvider.createCodeCompletionProvider(), CCompletionProvider.createCommentCompletionProvider()

getCompletionsImpl

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

getParameterListEnd

public char getParameterListEnd()

Overridden to return the null char (meaning "no end character") if the user doesn't want to use parens around their functions.

Returns:

The end character for parameters list, or the null char if none.

See Also:

getUseParensWithFunctions()

getParameterListStart

public char getParameterListStart()

Overridden to return the null char (meaning "no start character") if the user doesn't want to use parens around their functions.

Returns:

The start character for parameters list, or the null char if none.

See Also:

getUseParensWithFunctions()

getUseParensWithFunctions

public boolean getUseParensWithFunctions()

Returns whether the user wants to use parens around parameters to functions.

Returns:

Whether to use parens around parameters to functions.

See Also:

setUseParensWithFunctions(boolean)

getXmlResource

protected java.lang.String getXmlResource()

Returns the name of the XML resource to load (on classpath or a file).

Overrides:

getXmlResource in class CCompletionProvider

Returns:

The resource to load.

setUseParensWithFunctions

public void setUseParensWithFunctions(boolean use)

Sets whether the user wants to use parens around parameters to functions.

Parameters:

use - Whether to use parens around parameters to functions.

See Also:

getUseParensWithFunctions()