Merge remote-tracking branch 'origin/GT-3222-dragonmacher-dt-history-issue'

Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/FileDataTypeManager.java

@@ -31,8 +31,8 @@ import ghidra.util.task.TaskMonitorAdapter;
  * DataTypeManager for a file. Can import categories from a file, or export
  * categories to a packed database.
  */
-public class FileDataTypeManager extends StandAloneDataTypeManager implements
-		FileArchiveBasedDataTypeManager {
+public class FileDataTypeManager extends StandAloneDataTypeManager
+		implements FileArchiveBasedDataTypeManager {
 
 	public final static String EXTENSION = "gdt"; // Ghidra Data Types
 	/**
@@ -108,16 +108,15 @@ public class FileDataTypeManager extends StandAloneDataTypeManager implements
 	 * @param outputFilename filename for output
 	 * @param databaseId new databaseId
 	 */
-	public void saveAs(File saveFile, UniversalID newUniversalId) throws DuplicateFileException,
-			IOException {
+	public void saveAs(File saveFile, UniversalID newUniversalId)
+			throws DuplicateFileException, IOException {
 		ResourceFile resourceSaveFile = new ResourceFile(saveFile);
 // TODO: this should really be a package method and not public!
 		validateFilename(resourceSaveFile);
 		try {
 			universalID = newUniversalId;
-			packedDB =
-				((PackedDBHandle) dbHandle).saveAs("DTArchive", saveFile.getParentFile(),
-					saveFile.getName(), newUniversalId.getValue(), TaskMonitorAdapter.DUMMY_MONITOR);
+			packedDB = ((PackedDBHandle) dbHandle).saveAs("DTArchive", saveFile.getParentFile(),
+				saveFile.getName(), newUniversalId.getValue(), TaskMonitorAdapter.DUMMY_MONITOR);
 			file = resourceSaveFile;
 			updateRootCategoryName(resourceSaveFile, getRootCategory());
 		}
@@ -134,9 +133,8 @@ public class FileDataTypeManager extends StandAloneDataTypeManager implements
 		ResourceFile resourceSaveFile = new ResourceFile(saveFile);
 		validateFilename(resourceSaveFile);
 		try {
-			packedDB =
-				((PackedDBHandle) dbHandle).saveAs("DTArchive", saveFile.getParentFile(),
-					saveFile.getName(), TaskMonitorAdapter.DUMMY_MONITOR);
+			packedDB = ((PackedDBHandle) dbHandle).saveAs("DTArchive", saveFile.getParentFile(),
+				saveFile.getName(), TaskMonitorAdapter.DUMMY_MONITOR);
 			file = resourceSaveFile;
 			updateRootCategoryName(resourceSaveFile, getRootCategory());
 		}
@@ -268,4 +266,8 @@ public class FileDataTypeManager extends StandAloneDataTypeManager implements
 		return ArchiveType.FILE;
 	}
 
+	@Override
+	public String toString() {
+		return getClass().getSimpleName() + " - " + getName();
+	}
 }

Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/program/model/data/TestDoubleDataType.java

@@ -0,0 +1,288 @@
+/* ###
+ * IP: GHIDRA
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package ghidra.program.model.data;
+
+import java.net.URL;
+
+import ghidra.app.plugin.core.datamgr.archive.SourceArchive;
+import ghidra.docking.settings.Settings;
+import ghidra.docking.settings.SettingsDefinition;
+import ghidra.program.model.mem.MemBuffer;
+import ghidra.util.*;
+import ghidra.util.exception.DuplicateNameException;
+
+/**
+ * A stub of the {@link DataType} interface.  This can be used to supply a test values 
+ * or to spy on system internals by overriding methods as needed.
+ */
+public class TestDoubleDataType implements DataType {
+
+	private UniversalID id;
+	private String name;
+
+	public TestDoubleDataType(String name) {
+		this.name = name;
+		this.id = UniversalIdGenerator.nextID();
+	}
+
+	@Override
+	public String toString() {
+		return name;
+	}
+
+	@Override
+	public boolean isDynamicallySized() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public boolean isNotYetDefined() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public SettingsDefinition[] getSettingsDefinitions() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public Settings getDefaultSettings() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public DataType clone(DataTypeManager dtm) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public DataType copy(DataTypeManager dtm) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public CategoryPath getCategoryPath() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public DataTypePath getDataTypePath() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void setCategoryPath(CategoryPath path) throws DuplicateNameException {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public DataTypeManager getDataTypeManager() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public String getDisplayName() {
+		return "Test double data type '" + getName() + "'";
+	}
+
+	@Override
+	public String getName() {
+		return name;
+	}
+
+	@Override
+	public String getPathName() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void setName(String name) throws InvalidNameException, DuplicateNameException {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void setNameAndCategory(CategoryPath path, String name)
+			throws InvalidNameException, DuplicateNameException {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public String getMnemonic(Settings settings) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public int getLength() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public String getDescription() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void setDescription(String description) throws UnsupportedOperationException {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public URL getDocs() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public Object getValue(MemBuffer buf, Settings settings, int length) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public Class<?> getValueClass(Settings settings) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public String getDefaultLabelPrefix() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public String getDefaultAbbreviatedLabelPrefix() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public String getDefaultLabelPrefix(MemBuffer buf, Settings settings, int len,
+			DataTypeDisplayOptions options) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public String getDefaultOffcutLabelPrefix(MemBuffer buf, Settings settings, int len,
+			DataTypeDisplayOptions options, int offcutOffset) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public String getRepresentation(MemBuffer buf, Settings settings, int length) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public boolean isDeleted() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public boolean isEquivalent(DataType dt) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void dataTypeSizeChanged(DataType dt) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void dataTypeDeleted(DataType dt) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void dataTypeReplaced(DataType oldDt, DataType newDt) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void setDefaultSettings(Settings settings) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void addParent(DataType dt) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void removeParent(DataType dt) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void dataTypeNameChanged(DataType dt, String oldName) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public DataType[] getParents() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public int getAlignment() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public boolean dependsOn(DataType dt) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public SourceArchive getSourceArchive() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void setSourceArchive(SourceArchive archive) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public long getLastChangeTime() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public long getLastChangeTimeInSourceArchive() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public UniversalID getUniversalID() {
+		return id;
+	}
+
+	@Override
+	public void replaceWith(DataType dataType) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void setLastChangeTime(long lastChangeTime) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void setLastChangeTimeInSourceArchive(long lastChangeTimeInSourceArchive) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public DataOrganization getDataOrganization() {
+		throw new UnsupportedOperationException();
+	}
+}

Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/program/model/data/TestDoubleDataTypeManager.java

@@ -0,0 +1,342 @@
+/* ###
+ * IP: GHIDRA
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package ghidra.program.model.data;
+
+import java.util.*;
+
+import ghidra.app.plugin.core.datamgr.archive.SourceArchive;
+import ghidra.util.*;
+import ghidra.util.task.TaskMonitor;
+
+/**
+ * A stub of the {@link DataTypeManager} interface.  This can be used to supply a test values 
+ * or to spy on system internals by overriding methods as needed.
+ */
+public class TestDoubleDataTypeManager implements DataTypeManager {
+
+	private UniversalID id;
+
+	public TestDoubleDataTypeManager() {
+		this.id = UniversalIdGenerator.nextID();
+	}
+
+	@Override
+	public UniversalID getUniversalID() {
+		return id;
+	}
+
+	@Override
+	public boolean containsCategory(CategoryPath path) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public String getUniqueName(CategoryPath path, String baseName) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public DataType resolve(DataType dataType, DataTypeConflictHandler handler) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public DataType addDataType(DataType dataType, DataTypeConflictHandler handler) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public Iterator<DataType> getAllDataTypes() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void getAllDataTypes(List<DataType> list) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public Iterator<Structure> getAllStructures() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public Iterator<Composite> getAllComposites() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void findDataTypes(String name, List<DataType> list) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void findDataTypes(String name, List<DataType> list, boolean caseSensitive,
+			TaskMonitor monitor) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public DataType replaceDataType(DataType existingDt, DataType replacementDt,
+			boolean updateCategoryPath) throws DataTypeDependencyException {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public DataType getDataType(String dataTypePath) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public DataType findDataType(String dataTypePath) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public DataType getDataType(DataTypePath dataTypePath) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public long getResolvedID(DataType dt) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public long getID(DataType dt) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public DataType getDataType(long dataTypeID) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public Category getCategory(long categoryID) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public Category getCategory(CategoryPath path) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void dataTypeChanged(DataType dataType) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void addDataTypeManagerListener(DataTypeManagerChangeListener l) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void removeDataTypeManagerListener(DataTypeManagerChangeListener l) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void addInvalidatedListener(InvalidatedListener listener) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void removeInvalidatedListener(InvalidatedListener listener) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public boolean remove(DataType dataType, TaskMonitor monitor) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public boolean contains(DataType dataType) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public Category createCategory(CategoryPath path) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public DataType getDataType(CategoryPath path, String name) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public String getName() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void setName(String name) throws InvalidNameException {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public int startTransaction(String description) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public boolean isUpdatable() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void endTransaction(int transactionID, boolean commit) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void flushEvents() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void close() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public Pointer getPointer(DataType datatype) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public Pointer getPointer(DataType datatype, int size) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public Category getRootCategory() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public boolean isFavorite(DataType datatype) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void setFavorite(DataType datatype, boolean isFavorite) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public List<DataType> getFavorites() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public int getCategoryCount() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public int getDataTypeCount(boolean includePointersAndArrays) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void findEnumValueNames(long value, Set<String> enumValueNames) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public DataType getDataType(SourceArchive sourceArchive, UniversalID datatypeID) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public DataType findDataTypeForID(UniversalID datatypeID) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public long getLastChangeTimeForMyManager() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public SourceArchive getSourceArchive(UniversalID sourceID) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public ArchiveType getType() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public List<DataType> getDataTypes(SourceArchive sourceArchive) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public SourceArchive getLocalSourceArchive() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void associateDataTypeWithArchive(DataType datatype, SourceArchive archive) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void disassociate(DataType datatype) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public boolean updateSourceArchiveName(String archiveFileID, String name) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public boolean updateSourceArchiveName(UniversalID sourceID, String name) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public DataOrganization getDataOrganization() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public List<SourceArchive> getSourceArchives() {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public void removeSourceArchive(SourceArchive sourceArchive) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public SourceArchive resolveSourceArchive(SourceArchive sourceArchive) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public Set<DataType> getDataTypesContaining(DataType dataType) {
+		throw new UnsupportedOperationException();
+	}
+}