org.eclipse.cdt.internal.core.pdom

Class PDOM

java.lang.Object

PlatformObject

org.eclipse.cdt.internal.core.pdom.PDOM

All Implemented Interfaces:

IIndexFragment, IPDOM

Direct Known Subclasses:

WritablePDOM

public class PDOM
extends PlatformObject
implements IPDOM

Database for storing semantic information for one project.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PDOM.ChangeEvent
static interface	PDOM.IListener

Field Summary

Fields

Modifier and Type	Field and Description
protected Database	db
static int	END
protected PDOM.ChangeEvent	fEvent
static int	FILE_INDEX
static java.lang.String	FRAGMENT_PROPERTY_VALUE_FORMAT_ID Identifier for PDOM format
static int	INDEX_OF_DEFECTIVE_FILES
static int	INDEX_OF_FILES_WITH_UNRESOLVED_INCLUDES
static int	LINKAGES
static int	PROPERTIES
static int	TAG_INDEX

Fields inherited from interface org.eclipse.cdt.internal.core.index.IIndexFragment

FIND_ALL_OCCURRENCES, FIND_DECLARATIONS, FIND_DECLARATIONS_DEFINITIONS, FIND_DEFINITIONS, FIND_NON_LOCAL_ONLY, FIND_REFERENCES, PROPERTY_FRAGMENT_FORMAT_ID, PROPERTY_FRAGMENT_FORMAT_VERSION, PROPERTY_FRAGMENT_ID, PROPERTY_RESUME_INDEXER, SEARCH_ACROSS_LANGUAGE_BOUNDARIES

Constructor Summary

Constructors

Constructor and Description
PDOM(java.io.File dbPath, IIndexLocationConverter locationConverter, ChunkCache cache, java.util.Map<java.lang.String,IPDOMLinkageFactory> linkageFactoryMappings)
PDOM(java.io.File dbPath, IIndexLocationConverter locationConverter, java.util.Map<java.lang.String,IPDOMLinkageFactory> linkageFactoryMappings)

Method Summary

Modifier and Type	Method and Description
void	accept(IPDOMVisitor visitor)
void	acquireReadLock() Acquires a read lock.
void	acquireWriteLock(int giveupReadLocks, IProgressMonitor monitor) Acquire a write lock on this PDOM, giving up the specified number of read locks first.
void	acquireWriteLock(IProgressMonitor monitor) Acquire a write lock on this PDOM.
IIndexFragmentBinding	adaptBinding(IBinding binding) Looks for a binding matching the given one.
protected PDOMLinkage	adaptLinkage(ILinkage linkage)
protected IIndexFragmentFile	addFile(int linkageID, IIndexFileLocation location, ISignificantMacros sigMacros)
void	addListener(PDOM.IListener listener)
void	adjustThreadForReadLock(java.util.Map<java.lang.Thread,org.eclipse.cdt.internal.core.pdom.PDOM.DebugLockInfo> lockDebugging)
protected void	clear()
protected void	clearFileIndex()
void	clearResultCache() Clears the result cache.
void	close()
IIndexFragmentFileSet	createFileSet() Creates an empty file set for this fragment
java.lang.String	createKeyForCache(long record, char[] name)
protected PDOMLinkage	createLinkage(int linkageID)
IIndexFragmentBinding	findBinding(IASTName name) Looks for a binding of the given name from the AST.
IIndexFragmentBinding	findBinding(IIndexFragmentName indexName)
IIndexFragmentBinding[]	findBindings(char[][] names, boolean caseSensitive, IndexFilter filter, IProgressMonitor monitor)
IIndexFragmentBinding[]	findBindings(char[][] names, IndexFilter filter, IProgressMonitor monitor) Searches for all bindings with qualified names that seen as an array of simple names equals the given array of names.
IIndexFragmentBinding[]	findBindings(char[] name, boolean filescope, boolean isCaseSensitive, IndexFilter filter, IProgressMonitor monitor)
IIndexFragmentBinding[]	findBindings(char[] name, boolean filescope, IndexFilter filter, IProgressMonitor monitor) Returns all bindings with the given name, accepted by the given filter
IIndexFragmentBinding[]	findBindings(java.util.regex.Pattern[] patterns, boolean isFullyQualified, IndexFilter filter, IProgressMonitor monitor) Searches for all bindings with qualified names that seen as an array of simple names match the given array of patterns.
IIndexBinding[]	findBindings(java.util.regex.Pattern pattern, boolean isFullyQualified, IndexFilter filter, IProgressMonitor monitor)
IIndexFragmentBinding[]	findBindingsForContentAssist(char[] prefix, boolean filescope, IndexFilter filter, IProgressMonitor monitor) Returns all bindings that would be a valid completion for the given text.
IIndexFragmentBinding[]	findBindingsForPrefix(char[] prefix, boolean filescope, boolean caseSensitive, IndexFilter filter, IProgressMonitor monitor)
IIndexFragmentBinding[]	findBindingsForPrefix(char[] prefix, boolean filescope, IndexFilter filter, IProgressMonitor monitor) Returns all bindings with the given prefix, accepted by the given filter
IIndexFragmentInclude[]	findIncludedBy(IIndexFragmentFile file) Returns all include directives that point to the given file.
IIndexFragmentBinding[]	findMacroContainers(char[] prefix, boolean isPrefix, boolean isCaseSensitive, IndexFilter filter, IProgressMonitor monitor)
IIndexFragmentBinding[]	findMacroContainers(java.util.regex.Pattern pattern, IndexFilter filter, IProgressMonitor monitor) Searches for all macro containers (one for macros with the same name) with names that match the given pattern.
IIndexMacro[]	findMacros(char[] prefix, boolean isPrefix, boolean isCaseSensitive, IndexFilter filter, IProgressMonitor monitor) Returns all macros with the given prefix or name, accepted by the given filter
IIndexFragmentName[]	findNames(IBinding binding, int options) Searches for all names that resolve to the given binding.
protected void	flush()
IIndexFragmentFile[]	getAllFiles()
java.lang.Object	getCachedResult(java.lang.Object key) Returns a previously cached object, the cache is cleared at latest when the fragment no longer holds a locks.
long	getCacheHits() Returns cache hits since last reset of counters.
long	getCacheMisses() Returns cache misses since last reset of counters.
Database	getDB()
IRecordIterator	getDeclarationsDefintitionsRecordIterator(IIndexBinding binding)
static int	getDefaultVersion() Returns the version that shall be used when creating new databases.
IIndexFragmentFile[]	getDefectiveFiles()
PDOMFile	getFile(int linkageID, IIndexFileLocation location) Deprecated.
PDOMFile	getFile(int linkageID, IIndexFileLocation location, ISignificantMacros macroDictionary) Returns the file for the given location, linkage, and a set of macro definitions.
PDOMFile	getFile(PDOMLinkage linkage, IIndexFileLocation location, ISignificantMacros macroDictionary)
BTree	getFileIndex()
IIndexFragmentFile[]	getFiles(IIndexFileLocation location) Returns the files in all linkages for the given location.
IIndexFragmentFile[]	getFiles(int linkageID, IIndexFileLocation location) Returns the files for the given location and linkage.
IIndexFragmentFile[]	getFilesWithUnresolvedIncludes()
BTree	getIndexOfDefectiveFiles() Returns the index of files that were read with I/O errors.
BTree	getIndexOfFilesWithUnresolvedIncludes() Returns the index of files containing unresolved includes.
IIndexScope[]	getInlineNamespaces() Returns the global inline namespaces.
long	getLastReadAccess()
long	getLastWriteAccess() Returns the timestamp of the last modification to the index.
PDOMLinkage	getLinkage(int linkageID)
PDOMLinkage[]	getLinkageImpls()
IIndexLinkage[]	getLinkages() Returns the linkages that are contained in this fragment
IIndexLocationConverter	getLocationConverter()
static int	getMaxSupportedVersion()
static int	getMinSupportedVersion()
java.io.File	getPath()
java.lang.String	getProperty(java.lang.String propertyName) Read the named property in this fragment.
PDOMTagIndex	getTagIndex()
boolean	hasLastingDefinition(PDOMBinding binding)
boolean	hasWaitingReaders()
void	insertLinkage(PDOMLinkage linkage)
protected boolean	isCommitted(PDOMMacro name)
protected boolean	isCommitted(PDOMMacroReferenceName name)
protected boolean	isCommitted(PDOMName name)
boolean	isEmpty()
boolean	isFullyInitialized() Returns true if the index fragment is fully initialized.
protected boolean	isPermanentlyReadOnly() Returns whether this PDOM can never be written to.
boolean	isSupportedVersion()
static boolean	isSupportedVersion(int vers)
void	putCachedResult(java.lang.Object key, java.lang.Object result)
java.lang.Object	putCachedResult(java.lang.Object key, java.lang.Object result, boolean replace) Caches an object with the key, the cache must be cleared at latest when the fragment no longer holds a locks.
void	releaseReadLock() Releases a read lock.
void	releaseWriteLock()
void	releaseWriteLock(int establishReadLocks, boolean flush)
void	removeCachedResult(java.lang.Object key)
void	removeListener(PDOM.IListener listener)
void	resetCacheCounters() Resets the counters for cache-hits and cache-misses.
static java.lang.String	versionString(int version)

Methods inherited from class java.lang.Object

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

Field Detail

FRAGMENT_PROPERTY_VALUE_FORMAT_ID

public static final java.lang.String FRAGMENT_PROPERTY_VALUE_FORMAT_ID

Identifier for PDOM format

See Also:

IIndexFragment.PROPERTY_FRAGMENT_FORMAT_ID, Constant Field Values

LINKAGES

public static final int LINKAGES

See Also:

Constant Field Values

FILE_INDEX

public static final int FILE_INDEX

See Also:

Constant Field Values

INDEX_OF_DEFECTIVE_FILES

public static final int INDEX_OF_DEFECTIVE_FILES

See Also:

Constant Field Values

INDEX_OF_FILES_WITH_UNRESOLVED_INCLUDES

public static final int INDEX_OF_FILES_WITH_UNRESOLVED_INCLUDES

See Also:

Constant Field Values

PROPERTIES

public static final int PROPERTIES

See Also:

Constant Field Values

TAG_INDEX

public static final int TAG_INDEX

See Also:

Constant Field Values

END

public static final int END

See Also:

Constant Field Values

db

protected Database db

fEvent

protected PDOM.ChangeEvent fEvent

Constructor Detail

PDOM

public PDOM(java.io.File dbPath,
            IIndexLocationConverter locationConverter,
            java.util.Map<java.lang.String,IPDOMLinkageFactory> linkageFactoryMappings)
     throws CoreException

Throws:

CoreException

PDOM

public PDOM(java.io.File dbPath,
            IIndexLocationConverter locationConverter,
            ChunkCache cache,
            java.util.Map<java.lang.String,IPDOMLinkageFactory> linkageFactoryMappings)
     throws CoreException

Throws:

CoreException

Method Detail

getDefaultVersion

public static int getDefaultVersion()

Returns the version that shall be used when creating new databases.

isSupportedVersion

public static boolean isSupportedVersion(int vers)

getMinSupportedVersion

public static int getMinSupportedVersion()

getMaxSupportedVersion

public static int getMaxSupportedVersion()

versionString

public static java.lang.String versionString(int version)

isPermanentlyReadOnly

protected boolean isPermanentlyReadOnly()

Returns whether this PDOM can never be written to. Writable subclasses should return false.

getLocationConverter

public IIndexLocationConverter getLocationConverter()

isSupportedVersion

public boolean isSupportedVersion()
                           throws CoreException

Throws:

CoreException

createLinkage

protected PDOMLinkage createLinkage(int linkageID)
                             throws CoreException

Throws:

CoreException

getLinkage

public PDOMLinkage getLinkage(int linkageID)
                       throws CoreException

Throws:

CoreException

accept

public void accept(IPDOMVisitor visitor)
            throws CoreException

Throws:

CoreException

addListener

public void addListener(PDOM.IListener listener)

Specified by:

addListener in interface IPDOM

removeListener

public void removeListener(PDOM.IListener listener)

Specified by:

removeListener in interface IPDOM

getDB

public Database getDB()

getFileIndex

public BTree getFileIndex()
                   throws CoreException

Throws:

CoreException

getTagIndex

public PDOMTagIndex getTagIndex()
                         throws CoreException

Throws:

CoreException

getIndexOfDefectiveFiles

public BTree getIndexOfDefectiveFiles()
                               throws CoreException

Returns the index of files that were read with I/O errors.

Throws:

CoreException

getIndexOfFilesWithUnresolvedIncludes

public BTree getIndexOfFilesWithUnresolvedIncludes()
                                            throws CoreException

Returns the index of files containing unresolved includes.

Throws:

CoreException

getFile

@Deprecated
public PDOMFile getFile(int linkageID,
                                    IIndexFileLocation location)
                             throws CoreException

Deprecated.

Specified by:

getFile in interface IIndexFragment

Throws:

CoreException

getFile

public PDOMFile getFile(int linkageID,
                        IIndexFileLocation location,
                        ISignificantMacros macroDictionary)
                 throws CoreException

Description copied from interface: IIndexFragment

Returns the file for the given location, linkage, and a set of macro definitions. May return null, if no such file exists. This method may only return files that are actually managed by this fragment. This method returns files without content, also.

Specified by:

getFile in interface IIndexFragment

Parameters:

linkageID - the id of the linkage in which the file has been parsed.

location - the IIndexFileLocation representing the location of the file

Returns:

the file for the location, or null if the file is not present in the index

Throws:

CoreException

getFile

public PDOMFile getFile(PDOMLinkage linkage,
                        IIndexFileLocation location,
                        ISignificantMacros macroDictionary)
                 throws CoreException

Throws:

CoreException

getFiles

public IIndexFragmentFile[] getFiles(int linkageID,
                                     IIndexFileLocation location)
                              throws CoreException

Description copied from interface: IIndexFragment

Returns the files for the given location and linkage. Multiple files are returned when a header file is stored in the index in multiple variants for different sets of macro definitions. This method may only return files that are actually managed by this fragment. This method returns files without content, also.

Specified by:

getFiles in interface IIndexFragment

Parameters:

linkageID - the id of the linkage in which the file has been parsed.

location - the IIndexFileLocation representing the location of the file

Returns:

the files for the location and the linkage.

Throws:

CoreException

getFiles

public IIndexFragmentFile[] getFiles(IIndexFileLocation location)
                              throws CoreException

Description copied from interface: IIndexFragment

Returns the files in all linkages for the given location. This method may only return files that are actually managed by this fragment.

Specified by:

getFiles in interface IIndexFragment

Parameters:

location - the IIndexFileLocation representing the location of the file

Returns:

the file for the location, or null if the file is not present in the index

Throws:

CoreException

getAllFiles

public IIndexFragmentFile[] getAllFiles()
                                 throws CoreException

Specified by:

getAllFiles in interface IIndexFragment

Returns:

an array of all files contained in this index.

Throws:

CoreException

getDefectiveFiles

public IIndexFragmentFile[] getDefectiveFiles()
                                       throws CoreException

Specified by:

getDefectiveFiles in interface IIndexFragment

Returns:

an array of files that were indexed with I/O errors.

Throws:

CoreException

getFilesWithUnresolvedIncludes

public IIndexFragmentFile[] getFilesWithUnresolvedIncludes()
                                                    throws CoreException

Specified by:

getFilesWithUnresolvedIncludes in interface IIndexFragment

Returns:

an array of files containing unresolved includes.

Throws:

CoreException

addFile

protected IIndexFragmentFile addFile(int linkageID,
                                     IIndexFileLocation location,
                                     ISignificantMacros sigMacros)
                              throws CoreException

Throws:

CoreException

clearFileIndex

protected void clearFileIndex()
                       throws CoreException

Throws:

CoreException

clear

protected void clear()
              throws CoreException

Throws:

CoreException

isEmpty

public boolean isEmpty()
                throws CoreException

Throws:

CoreException

findBinding

public IIndexFragmentBinding findBinding(IASTName name)
                                  throws CoreException

Description copied from interface: IIndexFragment

Looks for a binding of the given name from the AST. May return null, if no such binding exists.

Specified by:

findBinding in interface IIndexFragment

Parameters:

name - the name for looking up the binding

Returns:

the binding for the name, or null

Throws:

CoreException

findBindings

public IIndexBinding[] findBindings(java.util.regex.Pattern pattern,
                                    boolean isFullyQualified,
                                    IndexFilter filter,
                                    IProgressMonitor monitor)
                             throws CoreException

Throws:

CoreException

findBindings

public IIndexFragmentBinding[] findBindings(java.util.regex.Pattern[] patterns,
                                            boolean isFullyQualified,
                                            IndexFilter filter,
                                            IProgressMonitor monitor)
                                     throws CoreException

Description copied from interface: IIndexFragment

Searches for all bindings with qualified names that seen as an array of simple names match the given array of patterns. In case a binding exists in multiple projects, no duplicate bindings are returned. You can search with an array of patterns that specifies a partial qualification only.

Specified by:

findBindings in interface IIndexFragment

Parameters:

patterns - an array of patterns the names of the qualified name of the bindings have to match.

isFullyQualified - if true, the array of pattern specifies the fully qualified name

filter - a filter that allows for skipping parts of the index

monitor - a monitor to report progress, may be null

Returns:

an array of bindings matching the pattern

Throws:

CoreException

findMacroContainers

public IIndexFragmentBinding[] findMacroContainers(java.util.regex.Pattern pattern,
                                                   IndexFilter filter,
                                                   IProgressMonitor monitor)
                                            throws CoreException

Description copied from interface: IIndexFragment

Searches for all macro containers (one for macros with the same name) with names that match the given pattern. In case a binding exists in multiple projects, no duplicate bindings are returned.

Specified by:

findMacroContainers in interface IIndexFragment

Parameters:

pattern - a pattern the name of the bindings have to match.

filter - a filter that allows for skipping parts of the index

monitor - a monitor to report progress, may be null

Returns:

an array of bindings matching the pattern

Throws:

CoreException

findBindings

public IIndexFragmentBinding[] findBindings(char[][] names,
                                            IndexFilter filter,
                                            IProgressMonitor monitor)
                                     throws CoreException

Description copied from interface: IIndexFragment

Searches for all bindings with qualified names that seen as an array of simple names equals the given array of names.

Specified by:

findBindings in interface IIndexFragment

Parameters:

names - an array of names the qualified name of the bindings have to match.

filter - a filter that allows for skipping parts of the index

monitor - a monitor to report progress, may be null

Returns:

an array of bindings matching the pattern

Throws:

CoreException

findBindings

public IIndexFragmentBinding[] findBindings(char[][] names,
                                            boolean caseSensitive,
                                            IndexFilter filter,
                                            IProgressMonitor monitor)
                                     throws CoreException

Throws:

CoreException

getLinkages

public IIndexLinkage[] getLinkages()

Description copied from interface: IIndexFragment

Returns the linkages that are contained in this fragment

Specified by:

getLinkages in interface IIndexFragment

getLinkageImpls

public PDOMLinkage[] getLinkageImpls()

Specified by:

getLinkageImpls in interface IPDOM

insertLinkage

public void insertLinkage(PDOMLinkage linkage)
                   throws CoreException

Throws:

CoreException

acquireReadLock

public void acquireReadLock()
                     throws java.lang.InterruptedException

Description copied from interface: IIndexFragment

Acquires a read lock.

Specified by:

acquireReadLock in interface IIndexFragment

Throws:

java.lang.InterruptedException

releaseReadLock

public void releaseReadLock()

Description copied from interface: IIndexFragment

Releases a read lock.

Specified by:

releaseReadLock in interface IIndexFragment

acquireWriteLock

public void acquireWriteLock(IProgressMonitor monitor)
                      throws java.lang.InterruptedException

Acquire a write lock on this PDOM. Blocks until any existing read/write locks are released.

Throws:

java.lang.InterruptedException

java.lang.IllegalStateException - if this PDOM is not writable

acquireWriteLock

public void acquireWriteLock(int giveupReadLocks,
                             IProgressMonitor monitor)
                      throws java.lang.InterruptedException

Acquire a write lock on this PDOM, giving up the specified number of read locks first. Blocks until any existing read/write locks are released.

Throws:

java.lang.InterruptedException

java.lang.IllegalStateException - if this PDOM is not writable

releaseWriteLock

public final void releaseWriteLock()

releaseWriteLock

public void releaseWriteLock(int establishReadLocks,
                             boolean flush)

hasWaitingReaders

public boolean hasWaitingReaders()

Specified by:

hasWaitingReaders in interface IIndexFragment

Returns:

true if there are threads waiting for read locks.

getLastWriteAccess

public long getLastWriteAccess()

Description copied from interface: IIndexFragment

Returns the timestamp of the last modification to the index.

Specified by:

getLastWriteAccess in interface IIndexFragment

getLastReadAccess

public long getLastReadAccess()

adaptLinkage

protected PDOMLinkage adaptLinkage(ILinkage linkage)
                            throws CoreException

Throws:

CoreException

adaptBinding

public IIndexFragmentBinding adaptBinding(IBinding binding)
                                   throws CoreException

Description copied from interface: IIndexFragment

Looks for a binding matching the given one. May return null, if no such binding exists. The binding may belong to an AST or another index fragment.

Specified by:

adaptBinding in interface IIndexFragment

Parameters:

binding - the binding to look for.

Returns:

the binding, or null

Throws:

CoreException

findBinding

public IIndexFragmentBinding findBinding(IIndexFragmentName indexName)
                                  throws CoreException

Throws:

CoreException

findNames

public IIndexFragmentName[] findNames(IBinding binding,
                                      int options)
                               throws CoreException

Description copied from interface: IIndexFragment

Searches for all names that resolve to the given binding. You can limit the result to references, declarations or definitions, or a combination of those.

Specified by:

findNames in interface IIndexFragment

Parameters:

binding - a binding for which names are searched for

options - a combination of IIndexFragment.FIND_DECLARATIONS, IIndexFragment.FIND_DEFINITIONS, IIndexFragment.FIND_REFERENCES and IIndexFragment.FIND_NON_LOCAL_ONLY

Returns:

an array of names

Throws:

CoreException

getDeclarationsDefintitionsRecordIterator

public IRecordIterator getDeclarationsDefintitionsRecordIterator(IIndexBinding binding)
                                                          throws CoreException

Throws:

CoreException

isCommitted

protected boolean isCommitted(PDOMName name)
                       throws CoreException

Throws:

CoreException

isCommitted

protected boolean isCommitted(PDOMMacro name)
                       throws CoreException

Throws:

CoreException

isCommitted

protected boolean isCommitted(PDOMMacroReferenceName name)
                       throws CoreException

Throws:

CoreException

findIncludedBy

public IIndexFragmentInclude[] findIncludedBy(IIndexFragmentFile file)
                                       throws CoreException

Description copied from interface: IIndexFragment

Returns all include directives that point to the given file. The input file may belong to another fragment. All of the include directives returned must belong to files managed by this fragment.

Specified by:

findIncludedBy in interface IIndexFragment

Parameters:

file - a file to search for includes pointing to it

Returns:

an array of include directives managed by this fragment

Throws:

CoreException

getPath

public java.io.File getPath()

findBindingsForPrefix

public IIndexFragmentBinding[] findBindingsForPrefix(char[] prefix,
                                                     boolean filescope,
                                                     IndexFilter filter,
                                                     IProgressMonitor monitor)
                                              throws CoreException

Description copied from interface: IIndexFragment

Returns all bindings with the given prefix, accepted by the given filter

Specified by:

findBindingsForPrefix in interface IIndexFragment

monitor - to report progress, may be null

Throws:

CoreException

findBindingsForPrefix

public IIndexFragmentBinding[] findBindingsForPrefix(char[] prefix,
                                                     boolean filescope,
                                                     boolean caseSensitive,
                                                     IndexFilter filter,
                                                     IProgressMonitor monitor)
                                              throws CoreException

Throws:

CoreException

findBindingsForContentAssist

public IIndexFragmentBinding[] findBindingsForContentAssist(char[] prefix,
                                                            boolean filescope,
                                                            IndexFilter filter,
                                                            IProgressMonitor monitor)
                                                     throws CoreException

Description copied from interface: IIndexFragment

Returns all bindings that would be a valid completion for the given text.

Specified by:

findBindingsForContentAssist in interface IIndexFragment

monitor - to report progress, may be null

Throws:

CoreException

findBindings

public IIndexFragmentBinding[] findBindings(char[] name,
                                            boolean filescope,
                                            IndexFilter filter,
                                            IProgressMonitor monitor)
                                     throws CoreException

Description copied from interface: IIndexFragment

Returns all bindings with the given name, accepted by the given filter

Specified by:

findBindings in interface IIndexFragment

monitor - to report progress, may be null

Throws:

CoreException

findBindings

public IIndexFragmentBinding[] findBindings(char[] name,
                                            boolean filescope,
                                            boolean isCaseSensitive,
                                            IndexFilter filter,
                                            IProgressMonitor monitor)
                                     throws CoreException

Throws:

CoreException

findMacroContainers

public IIndexFragmentBinding[] findMacroContainers(char[] prefix,
                                                   boolean isPrefix,
                                                   boolean isCaseSensitive,
                                                   IndexFilter filter,
                                                   IProgressMonitor monitor)
                                            throws CoreException

Throws:

CoreException

findMacros

public IIndexMacro[] findMacros(char[] prefix,
                                boolean isPrefix,
                                boolean isCaseSensitive,
                                IndexFilter filter,
                                IProgressMonitor monitor)
                         throws CoreException

Description copied from interface: IIndexFragment

Returns all macros with the given prefix or name, accepted by the given filter

Specified by:

findMacros in interface IIndexFragment

monitor - to report progress, may be null

Throws:

CoreException

getProperty

public java.lang.String getProperty(java.lang.String propertyName)
                             throws CoreException

Description copied from interface: IIndexFragment

Read the named property in this fragment. All fragments are expected to return a non-null value for

• PROPERTY_FRAGMENT_ID
• PROPERTY_FRAGMENT_FORMAT_ID
• PROPERTY_FRAGMENT_FORMAT_VERSION

Specified by:

getProperty in interface IIndexFragment

Parameters:

propertyName - a case-sensitive identifier for a property, or null

Returns:

the value associated with the key, or null if either no such property is set, or the specified key was null

Throws:

CoreException

See Also:

IIndexFragment.PROPERTY_FRAGMENT_ID, IIndexFragment.PROPERTY_FRAGMENT_FORMAT_ID, IIndexFragment.PROPERTY_FRAGMENT_FORMAT_VERSION

close

public void close()
           throws CoreException

Throws:

CoreException

clearResultCache

public void clearResultCache()

Description copied from interface: IIndexFragment

Clears the result cache.

Specified by:

clearResultCache in interface IIndexFragment

getCacheHits

public long getCacheHits()

Description copied from interface: IIndexFragment

Returns cache hits since last reset of counters.

Specified by:

getCacheHits in interface IIndexFragment

getCacheMisses

public long getCacheMisses()

Description copied from interface: IIndexFragment

Returns cache misses since last reset of counters.

Specified by:

getCacheMisses in interface IIndexFragment

resetCacheCounters

public void resetCacheCounters()

Description copied from interface: IIndexFragment

Resets the counters for cache-hits and cache-misses.

Specified by:

resetCacheCounters in interface IIndexFragment

flush

protected void flush()
              throws CoreException

Throws:

CoreException

getCachedResult

public java.lang.Object getCachedResult(java.lang.Object key)

Description copied from interface: IIndexFragment

Returns a previously cached object, the cache is cleared at latest when the fragment no longer holds a locks.

Specified by:

getCachedResult in interface IIndexFragment

putCachedResult

public void putCachedResult(java.lang.Object key,
                            java.lang.Object result)

putCachedResult

public java.lang.Object putCachedResult(java.lang.Object key,
                                        java.lang.Object result,
                                        boolean replace)

Description copied from interface: IIndexFragment

Caches an object with the key, the cache must be cleared at latest when the fragment no longer holds a locks.

Specified by:

putCachedResult in interface IIndexFragment

replace - if false an existing entry will not be replaced.

Returns:

the value that is actually stored.

removeCachedResult

public void removeCachedResult(java.lang.Object key)

createKeyForCache

public java.lang.String createKeyForCache(long record,
                                          char[] name)

hasLastingDefinition

public boolean hasLastingDefinition(PDOMBinding binding)
                             throws CoreException

Throws:

CoreException

createFileSet

public IIndexFragmentFileSet createFileSet()

Description copied from interface: IIndexFragment

Creates an empty file set for this fragment

Specified by:

createFileSet in interface IIndexFragment

adjustThreadForReadLock

public void adjustThreadForReadLock(java.util.Map<java.lang.Thread,org.eclipse.cdt.internal.core.pdom.PDOM.DebugLockInfo> lockDebugging)

getInlineNamespaces

public IIndexScope[] getInlineNamespaces()
                                  throws CoreException

Description copied from interface: IIndexFragment

Returns the global inline namespaces.

Specified by:

getInlineNamespaces in interface IIndexFragment

Throws:

CoreException

isFullyInitialized

public boolean isFullyInitialized()

Description copied from interface: IIndexFragment

Returns true if the index fragment is fully initialized. An fragment may not be fully initialized during Eclipse startup, or soon after adding a new project to the workspace.

Specified by:

isFullyInitialized in interface IIndexFragment