Package ghidra.program.database

Class ProjectDataTypeManager

java.lang.Object

ghidra.program.database.data.DataTypeManagerDB

ghidra.program.model.data.StandAloneDataTypeManager

ghidra.program.database.ProjectDataTypeManager

All Implemented Interfaces:

DataTypeManager, DomainFileBasedDataTypeManager, FileBasedDataTypeManager, ProjectArchiveBasedDataTypeManager, Closeable, AutoCloseable

public class ProjectDataTypeManager
extends StandAloneDataTypeManager
implements ProjectArchiveBasedDataTypeManager

Class for managing data types in a project archive NOTE: default data organization is used.

Nested Class Summary

Nested classes/interfaces inherited from class ghidra.program.model.data.StandAloneDataTypeManager

StandAloneDataTypeManager.ArchiveWarning, StandAloneDataTypeManager.ArchiveWarningLevel, StandAloneDataTypeManager.LanguageUpdateOption

Field Summary

Fields inherited from class ghidra.program.model.data.StandAloneDataTypeManager

name

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

addrMap, dbHandle, DEFAULT_CALLING_CONVENTION_ID, defaultListener, errHandler, lock, readOnlyMode, sourceArchiveAdapter, tablePrefix, universalID, UNKNOWN_CALLING_CONVENTION_ID

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

Method Summary

Modifier and Type	Method	Description
void	archiveReady(OpenMode openMode, TaskMonitor monitor)
boolean	canRedo()	Determine if there is a transaction previously undone (see StandAloneDataTypeManager.undo()) that can be redone (see StandAloneDataTypeManager.redo()).
boolean	canUndo()	Determine if there is a previous transaction that can be reverted/undone (see StandAloneDataTypeManager.undo()).
protected void	categoryCreated(Category newCategory)
protected void	categoryMoved(CategoryPath oldPath, Category category)
protected void	categoryRemoved(Category parent, String categoryName, long categoryID)
protected void	categoryRenamed(CategoryPath oldPath, Category category)
void	clearProgramArchitecture(TaskMonitor monitor)	Clear the program architecture setting and all architecture-specific data from this archive.
void	clearUndo()	Clear undo/redo stack.
void	close()	Closes this dataType manager
protected void	dataTypeAdded(DataType newDt, DataType originalDataType)
void	dataTypeChanged(DataType dt, boolean isAutoChange)	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, String oldName)
protected void	dataTypeReplaced(long existingDtID, DataTypePath existingPath, DataType replacementDt)
protected void	deleteDataTypesUsed(Set<Long> deletedIds)	Allow extensions to perform any neccessary fixups for all datatype removals listed.
boolean	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
List<String>	getAllRedoNames()	Get all transaction names that are available within the StandAloneDataTypeManager.redo() stack.
List<String>	getAllUndoNames()	Get all transaction names that are available within the StandAloneDataTypeManager.undo() stack.
DomainFile	getDomainFile()
String	getDomainFileID()
String	getName()	Returns this data type manager's name
String	getPath()	Get the path name associated with the storage of this stand alone datatype manager.
String	getRedoName()	Get the transaction name that is available for StandAloneDataTypeManager.redo() (see StandAloneDataTypeManager.canRedo()).
ArchiveType	getType()	Returns this manager's archive type
String	getUndoName()	Get the transaction name that is available for StandAloneDataTypeManager.undo() (see StandAloneDataTypeManager.canUndo()).
protected void	initTransactionState()
Transaction	openTransaction(String description)	Open new transaction.
void	redo()
protected void	replaceDataTypesUsed(Map<Long,Long> dataTypeReplacementMap)	Allow extensions to perform any neccessary fixups to address all datatype replacements.
void	setName(String name)	Sets this data type manager's name
void	setProgramArchitecture(Language language, CompilerSpecID compilerSpecId, StandAloneDataTypeManager.LanguageUpdateOption updateOption, TaskMonitor monitor)	Establish the program architecture for this datatype manager.
int	startTransaction(String description)	Starts a transaction for making changes in this data type manager.
void	undo()

Methods inherited from class ghidra.program.model.data.StandAloneDataTypeManager

finalize, getProgramArchitectureSummary, getTransactionCount, getWarning, getWarningDetail, getWarningMessage, handleDataOrganizationChange, initializeOtherAdapters, isArchitectureChangeAllowed, isProgramArchitectureMissing, isProgramArchitectureUpgradeRequired, logWarning, setImmutable, setProgramArchitecture

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

addDataType, addDataTypeManagerListener, addDataTypes, addDataTypeToDelete, addDataTypeToReplace, addInvalidatedListener, allowsDefaultBuiltInSettings, allowsDefaultComponentSettings, associateDataTypeWithArchive, compilerSpecChanged, contains, containsCategory, createCategory, dataTypeSettingsChanged, dbError, dedupeAllConflicts, dedupeConflicts, disassociate, dispose, doSourceArchiveUpdates, findDataType, findDataTypeForID, findDataTypes, findDataTypes, findEnumValueNames, fixupComposites, getAddressMap, getAllComposites, getAllDataTypes, getAllDataTypes, getAllFunctionDefinitions, getAllStructures, getCallingConvention, getCallingConventionID, getCallingConventionName, getCategory, getCategory, getCategoryCount, getChildIds, getDataMap, getDataOrganization, getDataType, getDataType, getDataType, getDataType, getDataType, getDataTypeCount, getDataTypes, getDataTypes, getDataTypesContaining, getDefaultCallingConvention, getDefinedCallingConventionNames, getFavorites, getID, getKnownCallingConventionNames, getLastChangeTimeForMyManager, getLocalSourceArchive, getPointer, getPointer, getProgramArchitecture, getProgramArchitectureSummary, getResolvedID, getRootCategory, getSourceArchive, getSourceArchive, getSourceArchives, getUniqueName, getUniversalID, getUnusedConflictName, getUnusedConflictName, getVariableStorageManager, hasDataOrganizationChange, hasParent, invalidateCache, isChanged, isCreatingDataType, isFavorite, isTransactionActive, isUpdatable, migrateOldFlexArrayComponentsIfRequired, notifyRestored, readDataOrganization, remove, removeDataTypeManagerListener, removeInvalidatedListener, removeParentChildRecord, removeSourceArchive, replaceDataType, replaceSourceArchive, resolve, resolveSourceArchive, saveDataOrganization, setFavorite, sourceArchiveAdded, sourceArchiveChanged, updateID, updateLastChangeTime, updateSourceArchiveName, updateSourceArchiveName

Methods inherited from class java.lang.Object

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

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

addDataType, addDataTypeManagerListener, addDataTypes, addInvalidatedListener, allowsDefaultBuiltInSettings, allowsDefaultComponentSettings, associateDataTypeWithArchive, contains, containsCategory, createCategory, disassociate, findDataType, findDataTypeForID, findDataTypes, findDataTypes, findEnumValueNames, getAddressMap, getAllComposites, getAllDataTypes, getAllDataTypes, getAllFunctionDefinitions, getAllStructures, getCallingConvention, getCategory, getCategory, getCategoryCount, getDataOrganization, getDataType, getDataType, getDataType, getDataType, getDataType, getDataTypeCount, getDataTypes, getDataTypesContaining, getDefaultCallingConvention, getDefinedCallingConventionNames, getFavorites, getID, getKnownCallingConventionNames, getLastChangeTimeForMyManager, getLocalSourceArchive, getPointer, getPointer, getProgramArchitecture, getProgramArchitectureSummary, getResolvedID, getRootCategory, getSourceArchive, getSourceArchives, getUniqueName, getUniversalID, isFavorite, isUpdatable, remove, removeDataTypeManagerListener, removeInvalidatedListener, removeSourceArchive, replaceDataType, resolve, resolveSourceArchive, setFavorite, updateSourceArchiveName, updateSourceArchiveName, withTransaction, withTransaction

Method Details

getName

public String getName()

Description copied from interface: DataTypeManager

Returns this data type manager's name

Specified by:

getName in interface DataTypeManager

Overrides:

getName in class StandAloneDataTypeManager

Returns:

the name

setName

public void setName(String name)
             throws InvalidNameException

Description copied from interface: DataTypeManager

Sets this data type manager's name

Specified by:

setName in interface DataTypeManager

Overrides:

setName in class StandAloneDataTypeManager

Parameters:

name - the new name

Throws:

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

clearProgramArchitecture

public void clearProgramArchitecture(TaskMonitor monitor)
                              throws CancelledException,
IOException,
LockException

Description copied from class: StandAloneDataTypeManager

Clear the program architecture setting and all architecture-specific data from this archive. Archive will revert to using the default DataOrganization. Archive must be open for update for this method to be used.

Overrides:

clearProgramArchitecture in class StandAloneDataTypeManager

Parameters:

monitor - task monitor

Throws:

CancelledException - if task cancelled. If thrown, this data type manager is no longer stable and should be closed without saving.

IOException - if IO error occurs

LockException - failure if exclusive access is required

setProgramArchitecture

public void setProgramArchitecture(Language language,
 CompilerSpecID compilerSpecId,
 StandAloneDataTypeManager.LanguageUpdateOption updateOption,
 TaskMonitor monitor)
                            throws CompilerSpecNotFoundException,
LanguageNotFoundException,
IOException,
LockException,
javax.help.UnsupportedOperationException,
IncompatibleLanguageException,
CancelledException

Description copied from class: StandAloneDataTypeManager

Establish the program architecture for this datatype manager. The current setting can be determined from DataTypeManagerDB.getProgramArchitecture(). Archive must be open for update for this method to be used.

Overrides:

setProgramArchitecture in class StandAloneDataTypeManager

Parameters:

language - language

compilerSpecId - compiler specification ID defined by the language.

updateOption - indicates how variable storage data should be transitioned. If StandAloneDataTypeManager.isProgramArchitectureMissing() is true and StandAloneDataTypeManager.LanguageUpdateOption.TRANSLATE specified, the translator will be based on whatever language version can be found. In this situation it may be best to force a StandAloneDataTypeManager.LanguageUpdateOption.CLEAR.

monitor - task monitor (cancel not permitted to avoid corrupt state)

Throws:

CompilerSpecNotFoundException - if invalid compilerSpecId specified for language

LanguageNotFoundException - if current language is not found (if required for data transition)

IOException - if IO error occurs

LockException - failure if exclusive access is required

javax.help.UnsupportedOperationException - if architecture change is not permitted

IncompatibleLanguageException - if translation requested but not possible due to incompatible language architectures

CancelledException - if task cancelled. If thrown, this data type manager is no longer stable and should be closed without saving.

dataTypeChanged

public void dataTypeChanged(DataType dt,
 boolean isAutoChange)

Description copied from class: DataTypeManagerDB

Notification when data type is changed.

Overrides:

dataTypeChanged in class DataTypeManagerDB

Parameters:

dt - data type that is changed

isAutoChange - true if change was an automatic change in response to another datatype's change (e.g., size, alignment).

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,
 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,
 String categoryName,
 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

replaceDataTypesUsed

protected void replaceDataTypesUsed(Map<Long,Long> dataTypeReplacementMap)

Description copied from class: DataTypeManagerDB

Allow extensions to perform any neccessary fixups to address all datatype replacements.

Overrides:

replaceDataTypesUsed in class StandAloneDataTypeManager

Parameters:

dataTypeReplacementMap - map of datatype replacements (oldID maps to replacementID).

deleteDataTypesUsed

protected void deleteDataTypesUsed(Set<Long> deletedIds)

Description copied from class: DataTypeManagerDB

Allow extensions to perform any neccessary fixups for all datatype removals listed.

Overrides:

deleteDataTypesUsed in class StandAloneDataTypeManager

Parameters:

deletedIds - list of IDs for all datatypes which are getting removed.

initTransactionState

protected void initTransactionState()

Overrides:

initTransactionState in class StandAloneDataTypeManager

openTransaction

public Transaction openTransaction(String description)
                            throws IllegalStateException

Description copied from interface: DataTypeManager

Open new transaction. This should generally be done with a try-with-resources block:

 try (Transaction tx = dtm.openTransaction(description)) {
        // ... Do something
 }
 

Specified by:

openTransaction in interface DataTypeManager

Overrides:

openTransaction in class StandAloneDataTypeManager

Parameters:

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

Returns:

transaction object

Throws:

IllegalStateException - if this DataTypeManager has already been closed.

startTransaction

public int startTransaction(String description)

Description copied from interface: DataTypeManager

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

Specified by:

startTransaction in interface DataTypeManager

Overrides:

startTransaction in class StandAloneDataTypeManager

Parameters:

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

Returns:

the transaction ID

endTransaction

public boolean endTransaction(int transactionID,
 boolean commit)

Description copied from interface: DataTypeManager

Ends the current transaction.

NOTE: If multiple transactions are outstanding the full transaction will not be ended until all transactions have been ended. If any of the transactions indicate a false for commit the transaction will ultimately be rolled-back when the final transaction is ended.

NOTE: Use of rollback (commit=false should be avoided unless absolutely neccessary since it will incur overhead to revert changes and may rollback multiple concurrent transactions if they exist.

NOTE: If this manager is part of a larger DomainObject its transactions may become entangled with other transactions at a higher level. In such cases, use of the DomainObject transaction interface is preferred. The return value from this method cannot be relied on in such cases.

Specified by:

endTransaction in interface DataTypeManager

Overrides:

endTransaction in class StandAloneDataTypeManager

Parameters:

transactionID - id of the transaction to end

commit - true if changes are committed, false if changes in transaction should be rolled back.

Returns:

true if this invocation was the final transaction and all changes were comitted.

undo

public void undo()

Overrides:

undo in class StandAloneDataTypeManager

redo

public void redo()

Overrides:

redo in class StandAloneDataTypeManager

clearUndo

public void clearUndo()

Description copied from class: StandAloneDataTypeManager

Clear undo/redo stack.
NOTE: It is important that this always be invoked following any save operation that compacts the checkpoints within the database BufferMgr.

Overrides:

clearUndo in class StandAloneDataTypeManager

canRedo

public boolean canRedo()

Description copied from class: StandAloneDataTypeManager

Determine if there is a transaction previously undone (see StandAloneDataTypeManager.undo()) that can be redone (see StandAloneDataTypeManager.redo()).

Overrides:

canRedo in class StandAloneDataTypeManager

Returns:

true if there is a transaction previously undone that can be redone, else false

canUndo

public boolean canUndo()

Description copied from class: StandAloneDataTypeManager

Determine if there is a previous transaction that can be reverted/undone (see StandAloneDataTypeManager.undo()).

Overrides:

canUndo in class StandAloneDataTypeManager

Returns:

true if there is a previous transaction that can be reverted/undone, else false.

getRedoName

public String getRedoName()

Description copied from class: StandAloneDataTypeManager

Get the transaction name that is available for StandAloneDataTypeManager.redo() (see StandAloneDataTypeManager.canRedo()).

Overrides:

getRedoName in class StandAloneDataTypeManager

Returns:

transaction name that is available for StandAloneDataTypeManager.redo() or empty String.

getUndoName

public String getUndoName()

Description copied from class: StandAloneDataTypeManager

Get the transaction name that is available for StandAloneDataTypeManager.undo() (see StandAloneDataTypeManager.canUndo()).

Overrides:

getUndoName in class StandAloneDataTypeManager

Returns:

transaction name that is available for StandAloneDataTypeManager.undo() or empty String.

getAllUndoNames

public List<String> getAllUndoNames()

Description copied from class: StandAloneDataTypeManager

Get all transaction names that are available within the StandAloneDataTypeManager.undo() stack.

Overrides:

getAllUndoNames in class StandAloneDataTypeManager

Returns:

all transaction names that are available within the StandAloneDataTypeManager.undo() stack.

getAllRedoNames

public List<String> getAllRedoNames()

Description copied from class: StandAloneDataTypeManager

Get all transaction names that are available within the StandAloneDataTypeManager.redo() stack.

Overrides:

getAllRedoNames in class StandAloneDataTypeManager

Returns:

all transaction names that are available within the StandAloneDataTypeManager.redo() stack.

flushEvents

public void flushEvents()

Description copied from interface: DataTypeManager

Force all pending notification events to be flushed

Specified by:

flushEvents in interface DataTypeManager

Overrides:

flushEvents in class StandAloneDataTypeManager

getDomainFile

public DomainFile getDomainFile()

Specified by:

getDomainFile in interface DomainFileBasedDataTypeManager

getDomainFileID

public String getDomainFileID()

Overrides:

getDomainFileID in class StandAloneDataTypeManager

getPath

public String getPath()

Description copied from class: StandAloneDataTypeManager

Get the path name associated with the storage of this stand alone datatype manager.

Specified by:

getPath in interface FileBasedDataTypeManager

Overrides:

getPath in class StandAloneDataTypeManager

Returns:

path name or null if not applicable

getType

public ArchiveType getType()

Description copied from interface: DataTypeManager

Returns this manager's archive type

Specified by:

getType in interface DataTypeManager

Overrides:

getType in class StandAloneDataTypeManager

Returns:

the type

archiveReady

public void archiveReady(OpenMode openMode,
 TaskMonitor monitor)
                  throws IOException,
CancelledException

Throws:

IOException

CancelledException

close

public void close()

Description copied from interface: DataTypeManager

Closes this dataType manager

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface DataTypeManager

Overrides:

close in class StandAloneDataTypeManager