org.eclipse.cdt.internal.core.index

Class IndexBasedFileContentProvider

java.lang.Object

org.eclipse.cdt.core.parser.IncludeFileContentProvider

org.eclipse.cdt.internal.core.parser.scanner.InternalFileContentProvider

org.eclipse.cdt.internal.core.index.IndexBasedFileContentProvider

public final class IndexBasedFileContentProvider
extends InternalFileContentProvider

Code reader factory, that fakes code readers for header files already stored in the index.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.cdt.internal.core.parser.scanner.InternalFileContentProvider

InternalFileContentProvider.DependsOnOutdatedFileException

Constructor Summary

Constructors

Constructor and Description
IndexBasedFileContentProvider(IIndex index, ASTFilePathResolver pathResolver, int linkage, IncludeFileContentProvider fallbackFactory)
IndexBasedFileContentProvider(IIndex index, ASTFilePathResolver pathResolver, int linkage, IncludeFileContentProvider fallbackFactory, AbstractIndexerTask relatedIndexerTask)

Method Summary

Modifier and Type	Method and Description
IIndexFile[]	findIndexFiles(InternalFileContent fc)
InternalFileContent	getContentForContextToHeaderGap(java.lang.String path, IMacroDictionary macroDictionary) Returns a file-content object of kind InternalFileContent.InclusionKind.FOUND_IN_INDEX, representing the content from the context of the given file up to where the file actually gets included, or null if this cannot be done.
InternalFileContent	getContentForInclusion(IIndexFileLocation ifl, java.lang.String astPath) Called only when used as a delegate of the index file content provider.
InternalFileContent	getContentForInclusion(java.lang.String path, IMacroDictionary macroDictionary) Creates an InclusionContent object for the given location.
java.lang.String	getContextPath() Returns the path of the context of null, if there is no context.
boolean	getInclusionExists(java.lang.String path) Checks whether the specified inclusion exists.
IFileNomination	isIncludedWithPragmaOnceSemantics(java.lang.String filePath) Returns whether the given file has been included with pragma once semantics.
void	reportPragmaOnceSemantics(java.lang.String filePath, IFileNomination nom) Reports detection of pragma once semantics.
void	resetForTranslationUnit()
IIndexFile	selectIndexFile(IMacroDictionary macroDictionary, IIndexFileLocation ifl)
void	setContextToHeaderGap(IIndexFile[] ctxToHeader)
void	setFileSizeLimit(long limit)
void	setHeadersToIndexAllVersions(java.util.Set<java.lang.String> headers)
void	setIndexAllHeaderVersions(boolean indexAllHeaderVersions)
void	setLinkage(int linkageID)
boolean	shouldIndexAllHeaderVersions(java.lang.String fileName) Returns whether or not the header file should be indexed for all versions
java.util.List<java.lang.String>	toPathList(java.util.Collection<IIndexFileLocation> newPragmaOnce)

Methods inherited from class org.eclipse.cdt.internal.core.parser.scanner.InternalFileContentProvider

addLoadedVersions, getIncludeHeuristics, getLoadedVersions, setIncludeResolutionHeuristics

Methods inherited from class org.eclipse.cdt.core.parser.IncludeFileContentProvider

adapt, getEmptyFilesProvider, getSavedFilesProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexBasedFileContentProvider

public IndexBasedFileContentProvider(IIndex index,
                                     ASTFilePathResolver pathResolver,
                                     int linkage,
                                     IncludeFileContentProvider fallbackFactory)

IndexBasedFileContentProvider

public IndexBasedFileContentProvider(IIndex index,
                                     ASTFilePathResolver pathResolver,
                                     int linkage,
                                     IncludeFileContentProvider fallbackFactory,
                                     AbstractIndexerTask relatedIndexerTask)

Method Detail

setContextToHeaderGap

public void setContextToHeaderGap(IIndexFile[] ctxToHeader)

setFileSizeLimit

public void setFileSizeLimit(long limit)

setLinkage

public void setLinkage(int linkageID)

resetForTranslationUnit

public void resetForTranslationUnit()

Overrides:

resetForTranslationUnit in class InternalFileContentProvider

reportPragmaOnceSemantics

public void reportPragmaOnceSemantics(java.lang.String filePath,
                                      IFileNomination nom)

Reports detection of pragma once semantics.

Overrides:

reportPragmaOnceSemantics in class InternalFileContentProvider

isIncludedWithPragmaOnceSemantics

public IFileNomination isIncludedWithPragmaOnceSemantics(java.lang.String filePath)

Returns whether the given file has been included with pragma once semantics.

Overrides:

isIncludedWithPragmaOnceSemantics in class InternalFileContentProvider

getInclusionExists

public boolean getInclusionExists(java.lang.String path)

Description copied from class: InternalFileContentProvider

Checks whether the specified inclusion exists.

Overrides:

getInclusionExists in class InternalFileContentProvider

getContentForInclusion

public InternalFileContent getContentForInclusion(java.lang.String path,
                                                  IMacroDictionary macroDictionary)

Description copied from class: InternalFileContentProvider

Creates an InclusionContent object for the given location.

Specified by:

getContentForInclusion in class InternalFileContentProvider

Parameters:

path - the absolute location of the file.

macroDictionary - macros defined at the inclusion point.

Returns:

Returns an inclusion content, or null if the location does not exist.

See Also:

InternalFileContent

toPathList

public java.util.List<java.lang.String> toPathList(java.util.Collection<IIndexFileLocation> newPragmaOnce)

selectIndexFile

public IIndexFile selectIndexFile(IMacroDictionary macroDictionary,
                                  IIndexFileLocation ifl)
                           throws CoreException

Throws:

CoreException

getContentForInclusion

public InternalFileContent getContentForInclusion(IIndexFileLocation ifl,
                                                  java.lang.String astPath)

Description copied from class: InternalFileContentProvider

Called only when used as a delegate of the index file content provider.

Specified by:

getContentForInclusion in class InternalFileContentProvider

getContentForContextToHeaderGap

public InternalFileContent getContentForContextToHeaderGap(java.lang.String path,
                                                           IMacroDictionary macroDictionary)
                                                    throws InternalFileContentProvider.DependsOnOutdatedFileException

Description copied from class: InternalFileContentProvider

Returns a file-content object of kind InternalFileContent.InclusionKind.FOUND_IN_INDEX, representing the content from the context of the given file up to where the file actually gets included, or null if this cannot be done.

Overrides:

getContentForContextToHeaderGap in class InternalFileContentProvider

Parameters:

path - the absolute location of the file.

macroDictionary - macros defined at the inclusion point.

Throws:

InternalFileContentProvider.DependsOnOutdatedFileException

findIndexFiles

public IIndexFile[] findIndexFiles(InternalFileContent fc)
                            throws CoreException

Throws:

CoreException

getContextPath

public java.lang.String getContextPath()

Description copied from class: InternalFileContentProvider

Returns the path of the context of null, if there is no context.

Overrides:

getContextPath in class InternalFileContentProvider

setHeadersToIndexAllVersions

public void setHeadersToIndexAllVersions(java.util.Set<java.lang.String> headers)

setIndexAllHeaderVersions

public void setIndexAllHeaderVersions(boolean indexAllHeaderVersions)

shouldIndexAllHeaderVersions

public boolean shouldIndexAllHeaderVersions(java.lang.String fileName)

Description copied from class: InternalFileContentProvider

Returns whether or not the header file should be indexed for all versions

Overrides:

shouldIndexAllHeaderVersions in class InternalFileContentProvider