org.eclipse.cdt.core.dom.parser

Class AbstractCLikeLanguage

java.lang.Object

AbstractLanguage

org.eclipse.cdt.core.dom.parser.AbstractCLikeLanguage

Direct Known Subclasses:

GCCLanguage, GPPLanguage

public abstract class AbstractCLikeLanguage
extends AbstractLanguage

This class provides a skeletal implementation of the ILanguage interface for the DOM parser framework. This class uses the template method pattern, derived classes need only implement getScannerExtensionConfiguration(IScannerInfo info), getParserLanguage() and createParser(IScanner scanner, ParserMode parserMode, IParserLogService logService, IIndex index).

Since:

5.0

See Also:

AbstractScannerExtensionConfiguration

Constructor Summary

Constructors

Constructor and Description
AbstractCLikeLanguage()

Method Summary

Modifier and Type	Method and Description
IContributedModelBuilder	createModelBuilder(ITranslationUnit tu)
protected ISourceCodeParser	createParser(IScanner scanner, IParserLogService log, IIndex index, boolean forCompletion, int options) Creates the parser.
protected ISourceCodeParser	createParser(IScanner scanner, IParserLogService log, IIndex index, boolean forCompletion, int options, IParserSettings settings) Create the parser with additional settings.
protected abstract ISourceCodeParser	createParser(IScanner scanner, ParserMode parserMode, IParserLogService logService, IIndex index)
protected ISourceCodeParser	createParser(IScanner scanner, ParserMode parserMode, IParserLogService logService, IIndex index, int options, IParserSettings settings)
protected IScanner	createScanner(CodeReader reader, IScannerInfo scanInfo, ICodeReaderFactory fileCreator, IParserLogService log) Deprecated. Replaced by createScanner(FileContent, IScannerInfo, IncludeFileContentProvider, IParserLogService)
protected IScanner	createScanner(FileContent content, IScannerInfo scanInfo, IncludeFileContentProvider fcp, IParserLogService log) Create the scanner to be used with the parser.
<T> T	getAdapter(java.lang.Class<T> adapter)
IASTTranslationUnit	getASTTranslationUnit(CodeReader reader, IScannerInfo scanInfo, ICodeReaderFactory codeReaderFactory, IIndex index, int options, IParserLogService log) Deprecated.
IASTTranslationUnit	getASTTranslationUnit(CodeReader reader, IScannerInfo scanInfo, ICodeReaderFactory fileCreator, IIndex index, IParserLogService log) Deprecated.
IASTTranslationUnit	getASTTranslationUnit(FileContent reader, IScannerInfo scanInfo, IncludeFileContentProvider fileCreator, IIndex index, int options, IParserLogService log)
java.lang.String[]	getBuiltinTypes()
IASTCompletionNode	getCompletionNode(CodeReader reader, IScannerInfo scanInfo, ICodeReaderFactory fileCreator, IIndex index, IParserLogService log, int offset) Deprecated.
IASTCompletionNode	getCompletionNode(FileContent reader, IScannerInfo scanInfo, IncludeFileContentProvider fileCreator, IIndex index, IParserLogService log, int offset)
java.lang.String[]	getKeywords()
protected abstract ParserLanguage	getParserLanguage()
java.lang.String[]	getPreprocessorKeywords()
protected IScannerExtensionConfiguration	getScannerExtensionConfiguration() Deprecated. Do not override this method. Override getScannerExtensionConfiguration(IScannerInfo) instead.
protected IScannerExtensionConfiguration	getScannerExtensionConfiguration(IScannerInfo info)
IASTName[]	getSelectedNames(IASTTranslationUnit ast, int start, int length) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCLikeLanguage

public AbstractCLikeLanguage()

Method Detail

getScannerExtensionConfiguration

@Deprecated
protected IScannerExtensionConfiguration getScannerExtensionConfiguration()

Deprecated. Do not override this method. Override getScannerExtensionConfiguration(IScannerInfo) instead.

getScannerExtensionConfiguration

protected IScannerExtensionConfiguration getScannerExtensionConfiguration(IScannerInfo info)

Returns:

the scanner extension configuration for this language. May not return null.

Since:

5.4

createParser

protected abstract ISourceCodeParser createParser(IScanner scanner,
                                                  ParserMode parserMode,
                                                  IParserLogService logService,
                                                  IIndex index)

createParser

protected ISourceCodeParser createParser(IScanner scanner,
                                         ParserMode parserMode,
                                         IParserLogService logService,
                                         IIndex index,
                                         int options,
                                         IParserSettings settings)

Since:

5.6

getParserLanguage

protected abstract ParserLanguage getParserLanguage()

Returns:

The ParserLanguage value corresponding to the language supported.

getASTTranslationUnit

@Deprecated
public IASTTranslationUnit getASTTranslationUnit(CodeReader reader,
                                                             IScannerInfo scanInfo,
                                                             ICodeReaderFactory fileCreator,
                                                             IIndex index,
                                                             IParserLogService log)
                                                      throws CoreException

Deprecated.

Throws:

CoreException

getASTTranslationUnit

@Deprecated
public IASTTranslationUnit getASTTranslationUnit(CodeReader reader,
                                                             IScannerInfo scanInfo,
                                                             ICodeReaderFactory codeReaderFactory,
                                                             IIndex index,
                                                             int options,
                                                             IParserLogService log)
                                                      throws CoreException

Deprecated.

Throws:

CoreException

getASTTranslationUnit

public IASTTranslationUnit getASTTranslationUnit(FileContent reader,
                                                 IScannerInfo scanInfo,
                                                 IncludeFileContentProvider fileCreator,
                                                 IIndex index,
                                                 int options,
                                                 IParserLogService log)
                                          throws CoreException

Throws:

CoreException

getCompletionNode

@Deprecated
public IASTCompletionNode getCompletionNode(CodeReader reader,
                                                        IScannerInfo scanInfo,
                                                        ICodeReaderFactory fileCreator,
                                                        IIndex index,
                                                        IParserLogService log,
                                                        int offset)
                                                 throws CoreException

Deprecated.

Throws:

CoreException

getCompletionNode

public IASTCompletionNode getCompletionNode(FileContent reader,
                                            IScannerInfo scanInfo,
                                            IncludeFileContentProvider fileCreator,
                                            IIndex index,
                                            IParserLogService log,
                                            int offset)
                                     throws CoreException

Throws:

CoreException

createParser

protected ISourceCodeParser createParser(IScanner scanner,
                                         IParserLogService log,
                                         IIndex index,
                                         boolean forCompletion,
                                         int options)

Creates the parser.

Parameters:

scanner - the IScanner to get tokens from

log - the parser log service

index - the index to help resolve bindings

forCompletion - whether the parser is used for code completion

options - for valid options see AbstractLanguage#getASTTranslationUnit(FileContent, IScannerInfo, IncludeFileContentProvider, IIndex, int, IParserLogService)

Returns:

an instance of ISourceCodeParser

createParser

protected ISourceCodeParser createParser(IScanner scanner,
                                         IParserLogService log,
                                         IIndex index,
                                         boolean forCompletion,
                                         int options,
                                         IParserSettings settings)

Create the parser with additional settings.

Parameters:

scanner - the IScanner to get tokens from

log - the parser log service

index - the index to help resolve bindings

forCompletion - whether the parser is used for code completion

options - for valid options see AbstractLanguage#getASTTranslationUnit(FileContent, IScannerInfo, IncludeFileContentProvider, IIndex, int, IParserLogService)

settings - for the parser

Returns:

an instance of ISourceCodeParser

Since:

5.6

createScanner

@Deprecated
protected IScanner createScanner(CodeReader reader,
                                             IScannerInfo scanInfo,
                                             ICodeReaderFactory fileCreator,
                                             IParserLogService log)

Deprecated. Replaced by createScanner(FileContent, IScannerInfo, IncludeFileContentProvider, IParserLogService)

createScanner

protected IScanner createScanner(FileContent content,
                                 IScannerInfo scanInfo,
                                 IncludeFileContentProvider fcp,
                                 IParserLogService log)

Create the scanner to be used with the parser.

Since:

5.2

getSelectedNames

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

Deprecated.

createModelBuilder

public IContributedModelBuilder createModelBuilder(ITranslationUnit tu)

getAdapter

public <T> T getAdapter(java.lang.Class<T> adapter)

getBuiltinTypes

public java.lang.String[] getBuiltinTypes()

getKeywords

public java.lang.String[] getKeywords()

getPreprocessorKeywords

public java.lang.String[] getPreprocessorKeywords()