Package ghidra.program.database.data

Class ProjectDataTypeManager

java.lang.Object

ghidra.program.database.data.DataTypeManagerDB

ghidra.program.database.data.ProjectDataTypeManager

All Implemented Interfaces:

DataTypeManager, DomainFileBasedDataTypeManager, FileBasedDataTypeManager, ProjectArchiveBasedDataTypeManager

public class ProjectDataTypeManager
extends DataTypeManagerDB
implements ProjectArchiveBasedDataTypeManager

Class for managing data types in a project archive

Field Summary

Fields inherited from class ghidra.program.database.data.DataTypeManagerDB

dataOrganization, dbHandle, defaultListener, sourceArchiveAdapter, universalID

Fields inherited from interface ghidra.program.model.data.DataTypeManager

BAD_DATATYPE_ID, BUILT_IN_ARCHIVE_KEY, BUILT_IN_ARCHIVE_UNIVERSAL_ID, BUILT_IN_DATA_TYPES_NAME, DEFAULT_DATATYPE_ID, LOCAL_ARCHIVE_KEY, LOCAL_ARCHIVE_UNIVERSAL_ID, NULL_DATATYPE_ID

Constructor Summary

Constructors

Constructor	Description
ProjectDataTypeManager(DBHandle handle, int openMode, ErrorHandler errHandler, Lock lock, TaskMonitor monitor)	Constructor

Method Summary

Modifier and Type	Method	Description
void	archiveReady(int openMode, TaskMonitor monitor)
protected void	categoryCreated(Category newCategory)
protected void	categoryMoved(CategoryPath oldPath, Category category)
protected void	categoryRemoved(Category parent, java.lang.String name, long categoryID)
protected void	categoryRenamed(CategoryPath oldPath, Category category)
void	close()	Closes this dataType manager
protected void	dataTypeAdded(DataType newDt, DataType originalDataType)
void	dataTypeChanged(DataType dt)	Notification when data type is changed.
protected void	dataTypeDeleted(long deletedID, DataTypePath deletedDataTypePath)
protected void	dataTypeMoved(DataType dt, DataTypePath oldPath, DataTypePath newPath)
protected void	dataTypeNameChanged(DataType dt, java.lang.String oldName)
protected void	dataTypeReplaced(long existingDtID, DataTypePath existingPath, DataType replacementDt)
protected void	deleteDataTypeIDs(java.util.LinkedList<java.lang.Long> deletedIds, TaskMonitor monitor)
void	endTransaction(int transactionID, boolean commit)	Ends the current transaction
protected void	favoritesChanged(DataType dataType, boolean isFavorite)
void	flushEvents()	Force all pending notification events to be flushed
DomainFile	getDomainFile()
java.lang.String	getDomainFileID()
java.lang.String	getName()	Returns this data type manager's name
java.lang.String	getPath()
Pointer	getPointer(DataType dt)	Returns a default sized pointer to the given datatype.
ArchiveType	getType()	Returns this manager's archive type
protected void	replaceDataTypeIDs(long oldDataTypeID, long newDataTypeID)
void	setDataTypeArchive(DataTypeArchiveDB dtArchive)
void	setName(java.lang.String name)	Sets this data type manager's name
int	startTransaction(java.lang.String description)	Starts a transaction for making changes in this data type manager.

Methods inherited from class ghidra.program.database.data.DataTypeManagerDB

addDataType, addDataTypeManagerListener, addDataTypeToDelete, addInvalidatedListener, associateDataTypeWithArchive, clearAllSettings, clearSetting, clearSettings, contains, containsCategory, createCategory, dbError, deleteAddressRange, disassociate, doSourceArchiveUpdates, findDataType, findDataTypeForID, findDataTypes, findDataTypes, findEnumValueNames, getAllComposites, getAllDataTypes, getAllDataTypes, getAllStructures, getByteSettingsValue, getCategory, getCategory, getCategoryCount, getDataOrganization, getDataType, getDataType, getDataType, getDataType, getDataType, getDataTypeCount, getDataTypes, getDataTypes, getDataTypesContaining, getFavorites, getID, getLastChangeTimeForMyManager, getLocalSourceArchive, getLongSettingsValue, getNames, getPointer, getResolvedID, getRootCategory, getSettings, getSourceArchive, getSourceArchive, getSourceArchives, getStringSettingsValue, getUniqueName, getUniqueName, getUniversalID, getUnusedConflictName, invalidateCache, isChanged, isCreatingDataType, isEmptySetting, isFavorite, isUpdatable, moveAddressRange, remove, removeDataTypeManagerListener, removeInvalidatedListener, removeSourceArchive, replaceDataType, replaceSourceArchive, resolve, resolveSourceArchive, setByteSettingsValue, setFavorite, setLongSettingsValue, setSettings, setStringSettingsValue, sourceArchiveAdded, sourceArchiveChanged, updateID, updateSourceArchiveName, updateSourceArchiveName

Methods inherited from class java.lang.Object

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

Methods inherited from interface ghidra.program.model.data.DataTypeManager

addDataType, addDataTypeManagerListener, addInvalidatedListener, associateDataTypeWithArchive, contains, containsCategory, createCategory, disassociate, findDataType, findDataTypeForID, findDataTypes, findDataTypes, findEnumValueNames, getAllComposites, getAllDataTypes, getAllDataTypes, getAllStructures, getCategory, getCategory, getCategoryCount, getDataOrganization, getDataType, getDataType, getDataType, getDataType, getDataType, getDataTypeCount, getDataTypes, getDataTypesContaining, getFavorites, getID, getLastChangeTimeForMyManager, getLocalSourceArchive, getPointer, getResolvedID, getRootCategory, getSourceArchive, getSourceArchives, getUniqueName, getUniversalID, isFavorite, isUpdatable, remove, removeDataTypeManagerListener, removeInvalidatedListener, removeSourceArchive, replaceDataType, resolve, resolveSourceArchive, setFavorite, updateSourceArchiveName, updateSourceArchiveName

Constructor Detail

ProjectDataTypeManager

public ProjectDataTypeManager(DBHandle handle,
                              int openMode,
                              ErrorHandler errHandler,
                              Lock lock,
                              TaskMonitor monitor)
                       throws CancelledException,
                              VersionException,
                              java.io.IOException

Constructor

Parameters:

handle - open database handle

openMode - the program open mode

errHandler - the database I/O error handler

lock - the program synchronization lock

monitor - the progress monitor

Throws:

CancelledException - if the user cancels an upgrade

VersionException - if the database does not match the expected version.

java.io.IOException - if a database I/O error occurs.

Method Detail

setDataTypeArchive

public void setDataTypeArchive(DataTypeArchiveDB dtArchive)

See Also:

ManagerDB.setProgram(ghidra.program.database.ProgramDB)

getName

public java.lang.String getName()

Description copied from interface: DataTypeManager

Returns this data type manager's name

Specified by:

getName in interface DataTypeManager

Returns:

the name

See Also:

DataTypeManager.getName()

getPointer

public Pointer getPointer(DataType dt)

Description copied from interface: DataTypeManager

Returns a default sized pointer to the given datatype. The pointer size is established dynamically based upon the data organization established by the compiler specification.

Specified by:

getPointer in interface DataTypeManager

Overrides:

getPointer in class DataTypeManagerDB

Parameters:

dt - the pointed to data type

Returns:

the pointer

setName

public void setName(java.lang.String name)
             throws InvalidNameException

Description copied from interface: DataTypeManager

Sets this data type manager's name

Specified by:

setName in interface DataTypeManager

Parameters:

name - the new name

Throws:

InvalidNameException - if the given name is invalid (such as when null or empty)

See Also:

DataTypeManager.setName(java.lang.String)

dataTypeChanged

public void dataTypeChanged(DataType dt)

Description copied from interface: DataTypeManager

Notification when data type is changed.

Specified by:

dataTypeChanged in interface DataTypeManager

Overrides:

dataTypeChanged in class DataTypeManagerDB

Parameters:

dt - data type that is changed

dataTypeAdded

protected void dataTypeAdded(DataType newDt,
                             DataType originalDataType)

Overrides:

dataTypeAdded in class DataTypeManagerDB

dataTypeReplaced

protected void dataTypeReplaced(long existingDtID,
                                DataTypePath existingPath,
                                DataType replacementDt)

Overrides:

dataTypeReplaced in class DataTypeManagerDB

dataTypeDeleted

protected void dataTypeDeleted(long deletedID,
                               DataTypePath deletedDataTypePath)

Overrides:

dataTypeDeleted in class DataTypeManagerDB

dataTypeMoved

protected void dataTypeMoved(DataType dt,
                             DataTypePath oldPath,
                             DataTypePath newPath)

Overrides:

dataTypeMoved in class DataTypeManagerDB

dataTypeNameChanged

protected void dataTypeNameChanged(DataType dt,
                                   java.lang.String oldName)

Overrides:

dataTypeNameChanged in class DataTypeManagerDB

categoryCreated

protected void categoryCreated(Category newCategory)

Overrides:

categoryCreated in class DataTypeManagerDB

categoryRenamed

protected void categoryRenamed(CategoryPath oldPath,
                               Category category)

Overrides:

categoryRenamed in class DataTypeManagerDB

categoryRemoved

protected void categoryRemoved(Category parent,
                               java.lang.String name,
                               long categoryID)

Overrides:

categoryRemoved in class DataTypeManagerDB

categoryMoved

protected void categoryMoved(CategoryPath oldPath,
                             Category category)

Overrides:

categoryMoved in class DataTypeManagerDB

favoritesChanged

protected void favoritesChanged(DataType dataType,
                                boolean isFavorite)

Overrides:

favoritesChanged in class DataTypeManagerDB

replaceDataTypeIDs

protected void replaceDataTypeIDs(long oldDataTypeID,
                                  long newDataTypeID)

Specified by:

replaceDataTypeIDs in class DataTypeManagerDB

deleteDataTypeIDs

protected void deleteDataTypeIDs(java.util.LinkedList<java.lang.Long> deletedIds,
                                 TaskMonitor monitor)
                          throws CancelledException

Specified by:

deleteDataTypeIDs in class DataTypeManagerDB

Throws:

CancelledException

startTransaction

public int startTransaction(java.lang.String description)

Description copied from interface: DataTypeManager

Starts a transaction for making changes in this data type manager.

Specified by:

startTransaction in interface DataTypeManager

Parameters:

description - a short description of the changes to be made.

Returns:

the transaction ID

See Also:

DataTypeManager.startTransaction(java.lang.String)

flushEvents

public void flushEvents()

Description copied from interface: DataTypeManager

Force all pending notification events to be flushed

Specified by:

flushEvents in interface DataTypeManager

endTransaction

public void endTransaction(int transactionID,
                           boolean commit)

Description copied from interface: DataTypeManager

Ends the current transaction

Specified by:

endTransaction in interface DataTypeManager

Parameters:

transactionID - id of the transaction to end

commit - true if changes are committed, false if changes in transaction are revoked

See Also:

DataTypeManager.endTransaction(int, boolean)

close

public void close()

Description copied from interface: DataTypeManager

Closes this dataType manager

Specified by:

close in interface DataTypeManager

See Also:

DataTypeManager.close()

getDomainFile

public DomainFile getDomainFile()

Specified by:

getDomainFile in interface DomainFileBasedDataTypeManager

getDomainFileID

public java.lang.String getDomainFileID()

Specified by:

getDomainFileID in class DataTypeManagerDB

getPath

public java.lang.String getPath()

Specified by:

getPath in interface FileBasedDataTypeManager

Specified by:

getPath in class DataTypeManagerDB

getType

public ArchiveType getType()

Description copied from interface: DataTypeManager

Returns this manager's archive type

Specified by:

getType in interface DataTypeManager

Returns:

the type

archiveReady

public void archiveReady(int openMode,
                         TaskMonitor monitor)
                  throws CancelledException

Throws:

CancelledException