Package cppclassanalyzer.data.manager

Class ClassTypeInfoManagerDB

java.lang.Object

cppclassanalyzer.data.manager.ClassTypeInfoManagerDB

All Implemented Interfaces:

ClassTypeInfoManager, ProgramClassTypeInfoManager, TypeInfoManager, ErrorHandler, ManagerDB

Direct Known Subclasses:

ItaniumAbiClassTypeInfoManager, VsClassTypeInfoManager

public abstract class ClassTypeInfoManagerDB
extends Object
implements ManagerDB, ProgramClassTypeInfoManager

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ClassTypeInfoManagerDB.RttiRecordWorker

Field Summary

Fields

Modifier and Type	Field	Description
protected ClassTypeInfoManagerService	plugin
protected ProgramDB	program
protected TypeInfoTreeNodeManager	treeNodeManager
protected ClassTypeInfoManagerDB.RttiRecordWorker	worker

Fields inherited from interface cppclassanalyzer.data.ClassTypeInfoManager

INVALID_KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClassTypeInfoManagerDB(ClassTypeInfoManagerService service, ProgramDB program)

Method Summary

Modifier and Type	Method	Description
boolean	containsRecord(AbstractVtableDB vtable)
void	dbError(IOException e)
Address	decodeAddress(long offset)
void	deleteAddressRange(Address startAddr, Address endAddr, TaskMonitor monitor)
long	encodeAddress(Address address)
Icon	getIcon(boolean expanded)	Gets the icon for this manager to be used in the TypeInfoArchiveGTree
String	getName()	Gets the name of this manager
protected static ClassTypeInfoDatabaseTable	getNewClassTable(DBHandle handle)
ProgramDB	getProgram()	Gets the program
TypeInfoTreeNodeManager	getTreeNodeManager()	Gets the TypeInfoTreeNodeManager for this ClassTypeInfoManager
ClassTypeInfoDB	getType(long key)	Gets the ClassTypeInfo for the corresponding database key
ClassTypeInfoDB	getType(Address address)	Gets the ClassTypeInfo at the specified address
ClassTypeInfoDB	getType(Function fun)	Gets the ClassTypeInfo for the corresponding Function
ClassTypeInfoDB	getType(GhidraClass gc)	Gets the ClassTypeInfo for the corresponding GhidraClass
AbstractClassTypeInfoDB	getType(UniversalID id)	Gets the type with a class data type that has the provided id
ClassTypeInfoDB	getType(String name)	Gets the ClassTypeInfo with the specified symbol.
ClassTypeInfoDB	getType(String name, Namespace namespace)	Gets the ClassTypeInfo with the specified name and Namespace
int	getTypeCount()	Gets the number of managed ClassTypeInfos
TypeInfo	getTypeInfo(Address address)	Get the TypeInfo at the address
TypeInfo	getTypeInfo(Address address, boolean resolve)	Gets the Type info at the specified address.
long	getTypeKey(Address address)
Iterable<ClassTypeInfoDB>	getTypes(boolean reverse)	Gets an iterable over all the managed ClassTypeInfos in the specified direction
Stream<ClassTypeInfoDB>	getTypeStream(boolean reverse)	Gets a stream of all the managed ClassTypeInfos in the specified direction
Vtable	getVtable(Address address)	Gets the Vtable at the specified address
int	getVtableCount()	Gets the number of managed Vtables
Iterable<Vtable>	getVtableIterable(boolean reverse)	Gets an iterable over all the managed Vtables in the specified direction
long	getVtableKey(Address address)
Stream<Vtable>	getVtableStream()	Gets a stream of all the managed Vtables
protected abstract ClassTypeInfoManagerDB.RttiRecordWorker	getWorker(ProgramRttiTablePair tables, ProgramRttiCachePair caches)
void	invalidateCache(boolean all)
void	moveAddressRange(Address fromAddr, Address toAddr, long length, TaskMonitor monitor)
void	programReady(int openMode, int currentRevision, TaskMonitor monitor)
AbstractClassTypeInfoDB	resolve(ArchivedClassTypeInfo type)	Returns a ClassTypeInfo that is managed by this ClassTypeInfoManager.
Vtable	resolve(ArchivedGnuVtable vtable)	Returns a Vtable that is managed by this ClassTypeInfoManager.
AbstractClassTypeInfoDB	resolve(ClassTypeInfo type)	Returns a ClassTypeInfo that is managed by this ClassTypeInfoManager.
Vtable	resolve(Vtable vtable)	Returns a Vtable that is managed by this ProgramClassTypeInfoManager.
void	setProgram(ProgramDB program)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ghidra.program.database.ManagerDB

dispose

Methods inherited from interface cppclassanalyzer.data.ProgramClassTypeInfoManager

addListener, getTypes, getTypeStream, getVtables, removeListener

Methods inherited from interface cppclassanalyzer.data.TypeInfoManager

isTypeInfo

Field Details

plugin

protected final ClassTypeInfoManagerService plugin

program

protected final ProgramDB program

worker

protected final ClassTypeInfoManagerDB.RttiRecordWorker worker

treeNodeManager

protected final TypeInfoTreeNodeManager treeNodeManager

Constructor Details

ClassTypeInfoManagerDB

protected ClassTypeInfoManagerDB(ClassTypeInfoManagerService service,
ProgramDB program)

Method Details

getWorker

protected abstract ClassTypeInfoManagerDB.RttiRecordWorker getWorker(ProgramRttiTablePair tables,
ProgramRttiCachePair caches)

getNewClassTable

protected static ClassTypeInfoDatabaseTable getNewClassTable(DBHandle handle)
                                                      throws IOException

Throws:

IOException

getName

public final String getName()

Description copied from interface: ClassTypeInfoManager

Gets the name of this manager

Specified by:

getName in interface ClassTypeInfoManager

Returns:

the managers name

getIcon

public Icon getIcon(boolean expanded)

Description copied from interface: ClassTypeInfoManager

Gets the icon for this manager to be used in the TypeInfoArchiveGTree

Specified by:

getIcon in interface ClassTypeInfoManager

Parameters:

expanded - true if the manager tree node is expanded

Returns:

the icon to be used in the tree

getTypeKey

public final long getTypeKey(Address address)

getVtableKey

public final long getVtableKey(Address address)

decodeAddress

public final Address decodeAddress(long offset)

encodeAddress

public final long encodeAddress(Address address)

containsRecord

public final boolean containsRecord(AbstractVtableDB vtable)

getProgram

public final ProgramDB getProgram()

Description copied from interface: ProgramClassTypeInfoManager

Gets the program

Specified by:

getProgram in interface ProgramClassTypeInfoManager

Returns:

the program

setProgram

public final void setProgram(ProgramDB program)

Specified by:

setProgram in interface ManagerDB

programReady

public void programReady(int openMode,
int currentRevision,
TaskMonitor monitor)
                  throws IOException,
CancelledException

Specified by:

programReady in interface ManagerDB

Throws:

IOException

CancelledException

invalidateCache

public final void invalidateCache(boolean all)

Specified by:

invalidateCache in interface ManagerDB

deleteAddressRange

public void deleteAddressRange(Address startAddr,
Address endAddr,
TaskMonitor monitor)
                        throws CancelledException

Specified by:

deleteAddressRange in interface ManagerDB

Throws:

CancelledException

moveAddressRange

public void moveAddressRange(Address fromAddr,
Address toAddr,
long length,
TaskMonitor monitor)
                      throws AddressOverflowException,
CancelledException

Specified by:

moveAddressRange in interface ManagerDB

Throws:

AddressOverflowException

CancelledException

getType

public ClassTypeInfoDB getType(Address address)

Description copied from interface: ProgramClassTypeInfoManager

Gets the ClassTypeInfo at the specified address

Specified by:

getType in interface ProgramClassTypeInfoManager

Parameters:

address - the address of the ClassTypeInfo

Returns:

the ClassTypeInfo or null if invalid

getVtable

public Vtable getVtable(Address address)

Description copied from interface: ProgramClassTypeInfoManager

Gets the Vtable at the specified address

Specified by:

getVtable in interface ProgramClassTypeInfoManager

Parameters:

address - the address of the vtable

Returns:

the vtable at the address or null if none is present

getType

public ClassTypeInfoDB getType(GhidraClass gc)

Description copied from interface: ClassTypeInfoManager

Gets the ClassTypeInfo for the corresponding GhidraClass

Specified by:

getType in interface ClassTypeInfoManager

Parameters:

gc - the GhidraClass

Returns:

the ClassTypeInfo or null if it doesn't exist

getType

public ClassTypeInfoDB getType(Function fun)

Description copied from interface: ClassTypeInfoManager

Gets the ClassTypeInfo for the corresponding Function

Specified by:

getType in interface ClassTypeInfoManager

Parameters:

fun - the function

Returns:

the ClassTypeInfo or null if it doesn't exist

getType

public ClassTypeInfoDB getType(String name)

Description copied from interface: ClassTypeInfoManager

Gets the ClassTypeInfo with the specified symbol. The supplied symbol should be mangled.

Specified by:

getType in interface ClassTypeInfoManager

Parameters:

name - the mangled symbol name

Returns:

the ClassTypeInfo or null if it doesn't exist

getType

public ClassTypeInfoDB getType(String name,
Namespace namespace)

Description copied from interface: ClassTypeInfoManager

Gets the ClassTypeInfo with the specified name and Namespace

Specified by:

getType in interface ClassTypeInfoManager

Parameters:

name - the type's name

namespace - the type's namespace

Returns:

the ClassTypeInfo or null if it doesn't exist

resolve

public AbstractClassTypeInfoDB resolve(ClassTypeInfo type)

Description copied from interface: ClassTypeInfoManager

Returns a ClassTypeInfo that is managed by this ClassTypeInfoManager. If one does not currently exist a new one is created.

Specified by:

resolve in interface ClassTypeInfoManager

Parameters:

type - the type to resolve

Returns:

the equivalent type managed by this ClassTypeInfoManager

resolve

public Vtable resolve(Vtable vtable)

Description copied from interface: ProgramClassTypeInfoManager

Returns a Vtable that is managed by this ProgramClassTypeInfoManager. If one does not currently exist a new one is created.

Specified by:

resolve in interface ProgramClassTypeInfoManager

Parameters:

vtable - the vtable to resolve

Returns:

the equivalent vtable managed by this ProgramClassTypeInfoManager

resolve

public AbstractClassTypeInfoDB resolve(ArchivedClassTypeInfo type)

Description copied from interface: ProgramClassTypeInfoManager

Returns a ClassTypeInfo that is managed by this ClassTypeInfoManager. If the ArchivedClassTypeInfo hasn't already been resolved the type will be created and all required data will be added to the program.

Specified by:

resolve in interface ProgramClassTypeInfoManager

Parameters:

type - the type to resolve

Returns:

the equivalent type managed by this ClassTypeInfoManager

resolve

public Vtable resolve(ArchivedGnuVtable vtable)

Description copied from interface: ProgramClassTypeInfoManager

Returns a Vtable that is managed by this ClassTypeInfoManager. If the ArchivedGnuVtable hasn't already been resolved the vtable will be created and all required data will be added to the program.

Specified by:

resolve in interface ProgramClassTypeInfoManager

Parameters:

vtable - the vtable to resolve

Returns:

the equivalent vtable managed by this ClassTypeInfoManager

getTypeCount

public int getTypeCount()

Description copied from interface: ClassTypeInfoManager

Gets the number of managed ClassTypeInfos

Specified by:

getTypeCount in interface ClassTypeInfoManager

Returns:

the number of managed ClassTypeInfos

getVtableCount

public int getVtableCount()

Description copied from interface: ProgramClassTypeInfoManager

Gets the number of managed Vtables

Specified by:

getVtableCount in interface ProgramClassTypeInfoManager

Returns:

the number of managed Vtables

getTypes

public Iterable<ClassTypeInfoDB> getTypes(boolean reverse)

Description copied from interface: ProgramClassTypeInfoManager

Gets an iterable over all the managed ClassTypeInfos in the specified direction

Specified by:

getTypes in interface ProgramClassTypeInfoManager

Parameters:

reverse - true if the types should be provided in reverse

Returns:

an iterable over all the managed ClassTypeInfos

getVtableIterable

public Iterable<Vtable> getVtableIterable(boolean reverse)

Description copied from interface: ProgramClassTypeInfoManager

Gets an iterable over all the managed Vtables in the specified direction

Specified by:

getVtableIterable in interface ProgramClassTypeInfoManager

Parameters:

reverse - true if the Vtables should be provided in reverse

Returns:

an iterable over all the managed Vtables

getTypeStream

public Stream<ClassTypeInfoDB> getTypeStream(boolean reverse)

Description copied from interface: ProgramClassTypeInfoManager

Gets a stream of all the managed ClassTypeInfos in the specified direction

Specified by:

getTypeStream in interface ProgramClassTypeInfoManager

Parameters:

reverse - true if the types should be provided in reverse

Returns:

a stream of all the managed ClassTypeInfos

getVtableStream

public Stream<Vtable> getVtableStream()

Description copied from interface: ProgramClassTypeInfoManager

Gets a stream of all the managed Vtables

Specified by:

getVtableStream in interface ProgramClassTypeInfoManager

Returns:

a stream of all the managed Vtables

getTypeInfo

public TypeInfo getTypeInfo(Address address)

Description copied from interface: TypeInfoManager

Get the TypeInfo at the address

Specified by:

getTypeInfo in interface TypeInfoManager

Parameters:

address - the address of the TypeInfo

Returns:

the TypeInfo at the specified address or null if none exists.

getTypeInfo

public TypeInfo getTypeInfo(Address address,
boolean resolve)

Description copied from interface: ProgramClassTypeInfoManager

Gets the Type info at the specified address. If the TypeInfo is a ClassTypeInfo it can be resolved if requested.

Specified by:

getTypeInfo in interface ProgramClassTypeInfoManager

Parameters:

address - the address of the TypeInfo

resolve - true to resolve the TypeInfo if it happens to be a ClassTypeInfo

Returns:

the TypeInfo at the address

getTreeNodeManager

public TypeInfoTreeNodeManager getTreeNodeManager()

Description copied from interface: ClassTypeInfoManager

Gets the TypeInfoTreeNodeManager for this ClassTypeInfoManager

Specified by:

getTreeNodeManager in interface ClassTypeInfoManager

Returns:

this manager's TypeInfoTreeNodeManager

dbError

public void dbError(IOException e)

Specified by:

dbError in interface ErrorHandler

getType

public ClassTypeInfoDB getType(long key)

Description copied from interface: ClassTypeInfoManager

Gets the ClassTypeInfo for the corresponding database key

Specified by:

getType in interface ClassTypeInfoManager

Parameters:

key - the database key

Returns:

the ClassTypeInfo or null if it doesn't exist

getType

public AbstractClassTypeInfoDB getType(UniversalID id)

Description copied from interface: ProgramClassTypeInfoManager

Gets the type with a class data type that has the provided id

Specified by:

getType in interface ProgramClassTypeInfoManager

Parameters:

id - the universal id

Returns:

the type with the corresponding data type id or null