org.eclipse.cdt.core.model
Interface ILanguage

All Known Implementing Classes:

org.eclipse.cdt.core.dom.parser.AbstractCLikeLanguage, AbstractLanguage, AssemblyLanguage, GCCLanguage, GPPLanguage

public interface ILanguage

Models differences between languages. The interface is not supposed to be implemented directly. Rather than that clients may subclass AbstractLanguage.

Field Summary

static int	OPTION_ADD_COMMENTS Option for getASTTranslationUnit(CodeReader, IScannerInfo, ICodeReaderFactory, IIndex, int, IParserLogService) Instructs the parser to add comment nodes to the ast.
static int	OPTION_IS_SOURCE_UNIT Option for getASTTranslationUnit(CodeReader, IScannerInfo, ICodeReaderFactory, IIndex, int, IParserLogService) Marks the ast as being based on a source-file rather than a header-file.
static int	OPTION_NO_IMAGE_LOCATIONS Option for getASTTranslationUnit(CodeReader, IScannerInfo, ICodeReaderFactory, IIndex, int, IParserLogService) Performance optimization, instructs the parser not to create image-locations.
static int	OPTION_SKIP_FUNCTION_BODIES Option for getASTTranslationUnit(CodeReader, IScannerInfo, ICodeReaderFactory, IIndex, int, IParserLogService) Instructs the parser to skip function and method bodies.

Method Summary

IContributedModelBuilder	createModelBuilder(ITranslationUnit tu) Used to override the default model building behavior for a translation unit.
IASTTranslationUnit	getASTTranslationUnit(org.eclipse.cdt.core.parser.CodeReader reader, org.eclipse.cdt.core.parser.IScannerInfo scanInfo, org.eclipse.cdt.core.dom.ICodeReaderFactory fileCreator, org.eclipse.cdt.core.index.IIndex index, int options, org.eclipse.cdt.core.parser.IParserLogService log) Construct an AST for the source code provided by reader.
IASTTranslationUnit	getASTTranslationUnit(org.eclipse.cdt.core.parser.CodeReader reader, org.eclipse.cdt.core.parser.IScannerInfo scanInfo, org.eclipse.cdt.core.dom.ICodeReaderFactory fileCreator, org.eclipse.cdt.core.index.IIndex index, org.eclipse.cdt.core.parser.IParserLogService log) Construct an AST for the source code provided by reader.
IASTCompletionNode	getCompletionNode(org.eclipse.cdt.core.parser.CodeReader reader, org.eclipse.cdt.core.parser.IScannerInfo scanInfo, org.eclipse.cdt.core.dom.ICodeReaderFactory fileCreator, org.eclipse.cdt.core.index.IIndex index, org.eclipse.cdt.core.parser.IParserLogService log, int offset) Return the AST completion node for the given offset.
String	getId() Return the language id for this language.
int	getLinkageID() Return the id of the linkage this language contributes to.
String	getName()
IASTName[]	getSelectedNames(IASTTranslationUnit ast, int start, int length) Deprecated. use IASTTranslationUnit.getNodeSelector(String), instead.

Field Detail

OPTION_SKIP_FUNCTION_BODIES

static final int OPTION_SKIP_FUNCTION_BODIES

Option for getASTTranslationUnit(CodeReader, IScannerInfo, ICodeReaderFactory, IIndex, int, IParserLogService) Instructs the parser to skip function and method bodies.

See Also:

Constant Field Values

OPTION_ADD_COMMENTS

static final int OPTION_ADD_COMMENTS

Option for getASTTranslationUnit(CodeReader, IScannerInfo, ICodeReaderFactory, IIndex, int, IParserLogService) Instructs the parser to add comment nodes to the ast.

See Also:

Constant Field Values

OPTION_NO_IMAGE_LOCATIONS

static final int OPTION_NO_IMAGE_LOCATIONS

Option for getASTTranslationUnit(CodeReader, IScannerInfo, ICodeReaderFactory, IIndex, int, IParserLogService) Performance optimization, instructs the parser not to create image-locations. When using this option IASTName.getImageLocation() will always return null.

See Also:

Constant Field Values

OPTION_IS_SOURCE_UNIT

static final int OPTION_IS_SOURCE_UNIT

Option for getASTTranslationUnit(CodeReader, IScannerInfo, ICodeReaderFactory, IIndex, int, IParserLogService) Marks the ast as being based on a source-file rather than a header-file. This makes a difference when bindings from the AST are used for searching the index, e.g. for static variables.

See Also:

Constant Field Values

Method Detail

getId

String getId()

Return the language id for this language. This is to differentiate languages from each other.

getLinkageID

int getLinkageID()

Return the id of the linkage this language contributes to. This is especially important for languages that write to the index.

Since:

5.0

See Also:

ILinkage

getName

String getName()

Returns:

the human readable name corresponding to this language, suitable for display.

Since:

4.0

getCompletionNode

IASTCompletionNode getCompletionNode(org.eclipse.cdt.core.parser.CodeReader reader,
                                     org.eclipse.cdt.core.parser.IScannerInfo scanInfo,
                                     org.eclipse.cdt.core.dom.ICodeReaderFactory fileCreator,
                                     org.eclipse.cdt.core.index.IIndex index,
                                     org.eclipse.cdt.core.parser.IParserLogService log,
                                     int offset)
                                     throws CoreException

Return the AST completion node for the given offset.

Throws:

CoreException

getSelectedNames

@Deprecated
IASTName[] getSelectedNames(IASTTranslationUnit ast,
                                       int start,
                                       int length)

Deprecated. use IASTTranslationUnit.getNodeSelector(String), instead.

Gather the list of IASTNames that appear the selection with the given start offset and length in the given ITranslationUnit.

createModelBuilder

IContributedModelBuilder createModelBuilder(ITranslationUnit tu)

Used to override the default model building behavior for a translation unit.

Parameters:

tu - the ITranslationUnit to be parsed (non-null)

Returns:

an IModelBuilder, which parses the given translation unit and returns the ICElements of its model, or null to parse using the default CDT model builder

getASTTranslationUnit

IASTTranslationUnit getASTTranslationUnit(org.eclipse.cdt.core.parser.CodeReader reader,
                                          org.eclipse.cdt.core.parser.IScannerInfo scanInfo,
                                          org.eclipse.cdt.core.dom.ICodeReaderFactory fileCreator,
                                          org.eclipse.cdt.core.index.IIndex index,
                                          org.eclipse.cdt.core.parser.IParserLogService log)
                                          throws CoreException

Construct an AST for the source code provided by reader. Fully equivalent to getASTTranslationUnit(reader, scanInfo, fileCreator, index, 0, log)

Parameters:

reader - source code to be parsed.

scanInfo - provides include paths and defined symbols.

fileCreator - factory that provides CodeReaders for files included by the source code being parsed.

index - (optional) index to use to provide support for ambiguity resolution.

log - logger

Returns:

an AST for the source code provided by reader.

Throws:

CoreException

getASTTranslationUnit

IASTTranslationUnit getASTTranslationUnit(org.eclipse.cdt.core.parser.CodeReader reader,
                                          org.eclipse.cdt.core.parser.IScannerInfo scanInfo,
                                          org.eclipse.cdt.core.dom.ICodeReaderFactory fileCreator,
                                          org.eclipse.cdt.core.index.IIndex index,
                                          int options,
                                          org.eclipse.cdt.core.parser.IParserLogService log)
                                          throws CoreException

Construct an AST for the source code provided by reader. As an option you can supply

Parameters:

reader - source code to be parsed.

scanInfo - provides include paths and defined symbols.

fileCreator - factory that provides CodeReaders for files included by the source code being parsed.

index - (optional) index to use to provide support for ambiguity resolution.

options - A combination of OPTION_SKIP_FUNCTION_BODIES, OPTION_ADD_COMMENTS, OPTION_NO_IMAGE_LOCATIONS, OPTION_IS_SOURCE_UNIT, or 0.

log - logger

Returns:

an AST for the source code provided by reader.

Throws:

CoreException