org.fife.rsta.ac.c

Class CCompletionProvider

java.lang.Object

org.fife.ui.autocomplete.CompletionProviderBase

org.fife.ui.autocomplete.LanguageAwareCompletionProvider

org.fife.rsta.ac.c.CCompletionProvider

All Implemented Interfaces:

org.fife.ui.autocomplete.CompletionProvider, org.fife.ui.rtextarea.ToolTipSupplier

Direct Known Subclasses:

PerlCompletionProvider, ShellCompletionProvider

public class CCompletionProvider
extends org.fife.ui.autocomplete.LanguageAwareCompletionProvider

A completion provider for the C programming language. It provides code completion support and parameter assistance for the C Standard Library. This information is read from an XML file.

Field Summary

Fields inherited from class org.fife.ui.autocomplete.CompletionProviderBase

EMPTY_STRING

Constructor Summary

Constructors

Constructor and Description
CCompletionProvider() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addShorthandCompletions(org.fife.ui.autocomplete.DefaultCompletionProvider codeCP) Adds shorthand completions to the code completion provider.
protected org.fife.ui.autocomplete.CompletionProvider	createCodeCompletionProvider() Returns the provider to use when editing code.
protected org.fife.ui.autocomplete.CompletionProvider	createCommentCompletionProvider() Returns the provider to use when in a comment.
protected org.fife.ui.autocomplete.CompletionProvider	createStringCompletionProvider() Returns the completion provider to use when the caret is in a string.
protected java.lang.String	getXmlResource() Returns the name of the XML resource to load (on classpath or a file).
protected void	loadCodeCompletionsFromXml(org.fife.ui.autocomplete.DefaultCompletionProvider cp) Called from createCodeCompletionProvider() to actually load the completions from XML.

Methods inherited from class org.fife.ui.autocomplete.LanguageAwareCompletionProvider

clearParameterizedCompletionParams, getAlreadyEnteredText, getCommentCompletionProvider, getCompletionsAt, getCompletionsImpl, getDefaultCompletionProvider, getDocCommentCompletionProvider, getParameterizedCompletions, getParameterListEnd, getParameterListSeparator, getParameterListStart, getStringCompletionProvider, getToolTipText, isAutoActivateOkay, setCommentCompletionProvider, setDefaultCompletionProvider, setDocCommentCompletionProvider, setParameterizedCompletionParams, setStringCompletionProvider

Methods inherited from class org.fife.ui.autocomplete.CompletionProviderBase

getCompletions, getListCellRenderer, getParameterChoicesProvider, getParent, setAutoActivationRules, setListCellRenderer, setParameterChoicesProvider, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

CCompletionProvider

public CCompletionProvider()

Constructor.

Method Detail

addShorthandCompletions

protected void addShorthandCompletions(org.fife.ui.autocomplete.DefaultCompletionProvider codeCP)

Adds shorthand completions to the code completion provider.

Parameters:

codeCP - The code completion provider.

createCodeCompletionProvider

protected org.fife.ui.autocomplete.CompletionProvider createCodeCompletionProvider()

Returns the provider to use when editing code.

Returns:

The provider.

See Also:

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

createCommentCompletionProvider

protected org.fife.ui.autocomplete.CompletionProvider createCommentCompletionProvider()

Returns the provider to use when in a comment.

Returns:

The provider.

See Also:

createCodeCompletionProvider(), createStringCompletionProvider()

createStringCompletionProvider

protected org.fife.ui.autocomplete.CompletionProvider createStringCompletionProvider()

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

Returns:

The provider.

See Also:

createCodeCompletionProvider(), createCommentCompletionProvider()

getXmlResource

protected java.lang.String getXmlResource()

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

Returns:

The resource to load.

loadCodeCompletionsFromXml

protected void loadCodeCompletionsFromXml(org.fife.ui.autocomplete.DefaultCompletionProvider cp)

Called from createCodeCompletionProvider() to actually load the completions from XML. Subclasses that override that method will want to call this one.

Parameters:

cp - The code completion provider.