org.eclipse.cdt.internal.core.pdom.indexer

Class ProjectIndexerInputAdapter

java.lang.Object

org.eclipse.cdt.internal.core.pdom.ASTFilePathResolver

org.eclipse.cdt.internal.core.pdom.IndexerInputAdapter

org.eclipse.cdt.internal.core.pdom.indexer.ProjectIndexerInputAdapter

public class ProjectIndexerInputAdapter
extends IndexerInputAdapter

Provides information about translation-units.

Since:

5.0

Constructor Summary

Constructors

Constructor and Description
ProjectIndexerInputAdapter(ICProject cproject)
ProjectIndexerInputAdapter(ICProject cproject, boolean useCache)

Method Summary

Modifier and Type	Method and Description
boolean	canBePartOfSDK(IIndexFileLocation ifl) Tests whether the file in the index is allowed to be part of an SDK.
boolean	doesIncludeFileExist(java.lang.String includePath) Check for existence of an inclusion as computed by the preprocessor.
java.lang.String	getASTPath(IIndexFileLocation ifl) Convert an index file location to the path as it will be stored in the AST.
IScannerInfo	getBuildConfiguration(int linkageID, java.lang.Object tu) Obtains the scanner configuration for the input file.
FileContent	getCodeReader(java.lang.Object tuo) Returns a code reader for the given input file.
java.lang.String	getEncoding(IIndexFileLocation ifl) Returns the encoding for the file.
long	getFileSize(IIndexFileLocation ifl) Returns the size of the file in bytes, or 0 if the file does not exist.
long	getFileSize(java.lang.String astFilePath) Returns the size of the file in bytes, or -1 if it cannot be determined
int	getIndexingPriority(IIndexFileLocation ifl) Returns the priority of indexing a file.
java.lang.Object	getInputFile(IIndexFileLocation location) Returns an object representing an input file for the given index location, or null, if it does not exist.
AbstractLanguage[]	getLanguages(java.lang.Object tuo, AbstractIndexerTask.UnusedHeaderStrategy strategy) Obtains the languages the input file should be parsed with.
long	getLastModified(IIndexFileLocation ifl) Return the last modification date for the file denoted by the index location.
boolean	isCaseInsensitiveFileSystem() Returns whether the file-system is case insensitive.
boolean	isFileBuildConfigured(java.lang.Object tuo) Tests whether the input file is part of the build.
boolean	isIndexedOnlyIfIncluded(java.lang.Object tu) Returns whether the given translation unit is not indexed unless it gets included.
boolean	isIndexedUnconditionally(IIndexFileLocation ifl) Checks whether the given file should be indexed unconditionally.
boolean	isSource(java.lang.String filename) Answers whether this file is considered to be a source file (vs.
boolean	isSourceUnit(java.lang.Object tuo) Tests whether the input file is a source unit.
IIndexFileLocation	resolveASTPath(java.lang.String astPath) Resolve a path as stored in the AST.
IIndexFileLocation	resolveFile(java.lang.Object tuo) Create an index location for the given input file.
IIndexFileLocation	resolveIncludeFile(java.lang.String includePath) Resolve a path for an inclusion as computed by the preprocessor.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectIndexerInputAdapter

public ProjectIndexerInputAdapter(ICProject cproject)

ProjectIndexerInputAdapter

public ProjectIndexerInputAdapter(ICProject cproject,
                                  boolean useCache)

Method Detail

isCaseInsensitiveFileSystem

public boolean isCaseInsensitiveFileSystem()

Description copied from class: ASTFilePathResolver

Returns whether the file-system is case insensitive.

Specified by:

isCaseInsensitiveFileSystem in class ASTFilePathResolver

resolveASTPath

public IIndexFileLocation resolveASTPath(java.lang.String astPath)

Description copied from class: ASTFilePathResolver

Resolve a path as stored in the AST.

Specified by:

resolveASTPath in class ASTFilePathResolver

Returns:

an index file location.

resolveIncludeFile

public IIndexFileLocation resolveIncludeFile(java.lang.String includePath)

Description copied from class: ASTFilePathResolver

Resolve a path for an inclusion as computed by the preprocessor. Check for existence and return null if the file does not exist.

Specified by:

resolveIncludeFile in class ASTFilePathResolver

Returns:

an index file location or null if the file does not exist.

doesIncludeFileExist

public boolean doesIncludeFileExist(java.lang.String includePath)

Description copied from class: ASTFilePathResolver

Check for existence of an inclusion as computed by the preprocessor.

Specified by:

doesIncludeFileExist in class ASTFilePathResolver

getFileSize

public long getFileSize(java.lang.String astFilePath)

Description copied from class: ASTFilePathResolver

Returns the size of the file in bytes, or -1 if it cannot be determined

Specified by:

getFileSize in class ASTFilePathResolver

getASTPath

public java.lang.String getASTPath(IIndexFileLocation ifl)

Description copied from class: ASTFilePathResolver

Convert an index file location to the path as it will be stored in the AST.

Specified by:

getASTPath in class ASTFilePathResolver

getBuildConfiguration

public IScannerInfo getBuildConfiguration(int linkageID,
                                          java.lang.Object tu)

Description copied from class: IndexerInputAdapter

Obtains the scanner configuration for the input file.

Specified by:

getBuildConfiguration in class IndexerInputAdapter

getLastModified

public long getLastModified(IIndexFileLocation ifl)

Description copied from class: IndexerInputAdapter

Return the last modification date for the file denoted by the index location.

Specified by:

getLastModified in class IndexerInputAdapter

getFileSize

public long getFileSize(IIndexFileLocation ifl)

Description copied from class: IndexerInputAdapter

Returns the size of the file in bytes, or 0 if the file does not exist.

Specified by:

getFileSize in class IndexerInputAdapter

getEncoding

public java.lang.String getEncoding(IIndexFileLocation ifl)

Description copied from class: IndexerInputAdapter

Returns the encoding for the file.

Specified by:

getEncoding in class IndexerInputAdapter

getLanguages

public AbstractLanguage[] getLanguages(java.lang.Object tuo,
                                       AbstractIndexerTask.UnusedHeaderStrategy strategy)

Description copied from class: IndexerInputAdapter

Obtains the languages the input file should be parsed with.

Specified by:

getLanguages in class IndexerInputAdapter

isFileBuildConfigured

public boolean isFileBuildConfigured(java.lang.Object tuo)

Description copied from class: IndexerInputAdapter

Tests whether the input file is part of the build.

Specified by:

isFileBuildConfigured in class IndexerInputAdapter

isIndexedOnlyIfIncluded

public boolean isIndexedOnlyIfIncluded(java.lang.Object tu)

Description copied from class: IndexerInputAdapter

Returns whether the given translation unit is not indexed unless it gets included. This applies to files that are outside of a source root.

Specified by:

isIndexedOnlyIfIncluded in class IndexerInputAdapter

isIndexedUnconditionally

public boolean isIndexedUnconditionally(IIndexFileLocation ifl)

Description copied from class: IndexerInputAdapter

Checks whether the given file should be indexed unconditionally.

Specified by:

isIndexedUnconditionally in class IndexerInputAdapter

Parameters:

ifl - the location of the file

Returns:

true if the file should be indexed unconditionally

getIndexingPriority

public int getIndexingPriority(IIndexFileLocation ifl)

Description copied from class: IndexerInputAdapter

Returns the priority of indexing a file. The priority is a nonnegative number. A larger number means a higher priority causing the file to be indexed ahead of files with lower priorities.

Specified by:

getIndexingPriority in class IndexerInputAdapter

Parameters:

ifl - the location of the file

Returns:

true the indexing priority

isSourceUnit

public boolean isSourceUnit(java.lang.Object tuo)

Description copied from class: IndexerInputAdapter

Tests whether the input file is a source unit.

Specified by:

isSourceUnit in class IndexerInputAdapter

isSource

public boolean isSource(java.lang.String filename)

Description copied from class: ASTFilePathResolver

Answers whether this file is considered to be a source file (vs. a header file).

Specified by:

isSource in class ASTFilePathResolver

resolveFile

public IIndexFileLocation resolveFile(java.lang.Object tuo)

Description copied from class: IndexerInputAdapter

Create an index location for the given input file.

Specified by:

resolveFile in class IndexerInputAdapter

canBePartOfSDK

public boolean canBePartOfSDK(IIndexFileLocation ifl)

Description copied from class: IndexerInputAdapter

Tests whether the file in the index is allowed to be part of an SDK. If not it will be indexed.

Specified by:

canBePartOfSDK in class IndexerInputAdapter

getInputFile

public java.lang.Object getInputFile(IIndexFileLocation location)

Description copied from class: IndexerInputAdapter

Returns an object representing an input file for the given index location, or null, if it does not exist.

Specified by:

getInputFile in class IndexerInputAdapter

getCodeReader

public FileContent getCodeReader(java.lang.Object tuo)

Description copied from class: IndexerInputAdapter

Returns a code reader for the given input file.

Specified by:

getCodeReader in class IndexerInputAdapter