Merge branch 'GP-5557_ghidra1_CompositeEditorFixes' into patch

Author: ghidra1

Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/data/DBTraceDataTypeManager.java

@@ -4,9 +4,9 @@
  * 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.
@@ -217,8 +217,8 @@ public void flushEvents() {
 	}
 
 	@Override
-	public void endTransaction(int transactionID, boolean commit) {
-		trace.endTransaction(transactionID, commit);
+	public boolean endTransaction(int transactionID, boolean commit) {
+		return trace.endTransaction(transactionID, commit);
 	}
 
 	@Override

Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/program/DBTraceProgramView.java

@@ -1173,8 +1173,8 @@ public int startTransaction(String description, AbortedTransactionListener liste
 	}
 
 	@Override
-	public void endTransaction(int transactionID, boolean commit) {
-		trace.endTransaction(transactionID, commit);
+	public boolean endTransaction(int transactionID, boolean commit) {
+		return trace.endTransaction(transactionID, commit);
 	}
 
 	@Override

Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/program/DBTraceProgramViewRegisters.java

@@ -4,9 +4,9 @@
  * 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.
@@ -384,8 +384,8 @@ public int startTransaction(String description, AbortedTransactionListener liste
 	}
 
 	@Override
-	public void endTransaction(int transactionID, boolean commit) {
-		view.endTransaction(transactionID, commit);
+	public boolean endTransaction(int transactionID, boolean commit) {
+		return view.endTransaction(transactionID, commit);
 	}
 
 	@Override

Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/compositeeditor/AddBitFieldAction.java

@@ -26,7 +26,7 @@ public class AddBitFieldAction extends CompositeEditorTableAction {
 		"Add a bitfield at the position of a selected component";
 	private static String[] POPUP_PATH = new String[] { ACTION_NAME };
 
-	public AddBitFieldAction(CompositeEditorProvider provider) {
+	public AddBitFieldAction(CompositeEditorProvider<?, ?> provider) {
 		super(provider, ACTION_NAME, GROUP_NAME, POPUP_PATH, null, null);
 		setDescription(DESCRIPTION);
 		if (!(model instanceof CompEditorModel)) {
@@ -46,9 +46,9 @@ public boolean isEnabledForContext(ActionContext context) {
 			return false;
 		}
 		boolean enabled = true;
-		CompEditorModel editorModel = (CompEditorModel) model;
+		CompEditorModel<?> editorModel = (CompEditorModel<?>) model;
 		// Unions do not support non-packed manipulation of bitfields
-		if (!(provider instanceof StructureEditorProvider structProvider) ||
+		if (!(provider instanceof StructureEditorProvider) ||
 			editorModel.isPackingEnabled() || editorModel.getNumSelectedRows() != 1) {
 			enabled = false;
 		}

Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/compositeeditor/ApplyAction.java

@@ -32,7 +32,7 @@ public class ApplyAction extends CompositeEditorTableAction {
 	private final static Icon ICON = new GIcon("icon.plugin.composite.editor.apply");
 	private final static String[] POPUP_PATH = new String[] { "Apply Edits" };
 
-	public ApplyAction(CompositeEditorProvider provider) {
+	public ApplyAction(CompositeEditorProvider<?, ?> provider) {
 		super(provider, ACTION_NAME, GROUP_NAME, POPUP_PATH, null, ICON);
 
 		setDescription("Apply editor changes");

Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/compositeeditor/ArrayAction.java

@@ -38,7 +38,7 @@ public class ArrayAction extends CompositeEditorTableAction {
 	private final static KeyStroke KEY_STROKE = KeyStroke.getKeyStroke(KeyEvent.VK_OPEN_BRACKET, 0);
 	private static String[] POPUP_PATH = new String[] { ACTION_NAME };
 
-	public ArrayAction(CompositeEditorProvider provider) {
+	public ArrayAction(CompositeEditorProvider<?, ?> provider) {
 		super(provider, ACTION_NAME, GROUP_NAME, POPUP_PATH, null, ICON);
 		setDescription(DESCRIPTION);
 		setKeyBindingData(new KeyBindingData(KEY_STROKE));

Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/compositeeditor/ClearAction.java

@@ -33,7 +33,7 @@ public class ClearAction extends CompositeEditorTableAction {
 	private final static String[] POPUP_PATH = new String[] { "Clear" };
 	private final static KeyStroke KEY_STROKE = KeyStroke.getKeyStroke(KeyEvent.VK_C, 0);
 
-	public ClearAction(CompositeEditorProvider provider) {
+	public ClearAction(CompositeEditorProvider<?, ?> provider) {
 		super(provider, ACTION_NAME, GROUP_NAME, POPUP_PATH, null, ICON);
 
 		setDescription("Clear the selected components");

Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/compositeeditor/CompEditorModel.java

@@ -29,15 +29,15 @@
 import ghidra.util.exception.*;
 import ghidra.util.task.TaskMonitor;
 
-public abstract class CompEditorModel extends CompositeEditorModel {
+public abstract class CompEditorModel<T extends Composite> extends CompositeEditorModel<T> {
 
 	private volatile boolean consideringReplacedDataType = false;
 
 	/**
 	 * Creates a model for editing a composite data type.
 	 * @param provider the provider that is using this model for editing.
 	 */
-	CompEditorModel(CompositeEditorProvider provider) {
+	CompEditorModel(CompositeEditorProvider<T, ? extends CompEditorModel<T>> provider) {
 		super(provider);
 	}
 
@@ -54,7 +54,7 @@ public boolean hasChanges() {
 	 * @param dataType the composite data type being edited.
 	 */
 	@Override
-	public void load(Composite dataType) {
+	public void load(T dataType) {
 		super.load(dataType);
 		fixSelection();
 		selectionChanged();
@@ -76,7 +76,7 @@ public boolean apply() throws InvalidDataTypeException {
 		}
 
 		FieldSelection saveSelection = new FieldSelection(selection);
-		Composite originalDt = getOriginalComposite();
+		T originalDt = getOriginalComposite();
 		if (originalDt == null || originalDTM == null) {
 			throw new IllegalStateException(
 				"Can't apply edits without a data type or data type manager.");
@@ -118,7 +118,8 @@ public boolean apply() throws InvalidDataTypeException {
 				load(originalDt);
 			}
 			else {
-				Composite dt = (Composite) originalDTM.resolve(viewComposite, null);
+				@SuppressWarnings("unchecked")
+				T dt = (T) originalDTM.resolve(viewComposite, null);
 				load(dt);
 			}
 			return true;
@@ -376,7 +377,6 @@ protected void deleteComponent(int rowIndex) {
 		int componentOrdinal = convertRowToOrdinal(rowIndex);
 		delete(componentOrdinal);
 		fixSelection();
-		componentEdited();
 		selectionChanged();
 	}
 
@@ -411,8 +411,6 @@ void deleteComponentRange(int startRowIndex, int endRowIndex, TaskMonitor monito
 		}
 		viewDTM.withTransaction("Delete Components", () -> viewComposite.delete(ordinals));
 		fixSelection();
-		componentEdited();
-		notifyCompositeChanged();
 		selectionChanged();
 	}
 
@@ -427,12 +425,7 @@ public void deleteSelectedComponents() throws UsrException {
 
 		int[] selectedComponents = getSelectedComponentRows();
 		int firstRowIndex = !selection.isEmpty() ? selectedComponents[0] : getRowCount();
-		try {
-			delete(selectedComponents);
-		}
-		finally {
-			componentEdited();
-		}
+		delete(selectedComponents);
 		selection.addRange(firstRowIndex, firstRowIndex + 1);
 		fixSelection();
 		selectionChanged();
@@ -532,7 +525,6 @@ public DataTypeComponent insert(int rowIndex, DataType datatype, int length)
 		}
 		DataTypeComponent dtc = insert(rowIndex, datatype, length, null, null);
 		fixSelection();
-		componentEdited();
 		selectionChanged();
 		return dtc;
 	}
@@ -562,7 +554,6 @@ protected void insertComponentMultiple(int rowIndex, DataType dataType, int dtLe
 		checkIsAllowableDataType(dataType);
 		insertMultiple(rowIndex, dataType, dtLen, multiple, monitor);
 		fixSelection();
-		componentEdited();
 		selectionChanged();
 	}
 
@@ -601,7 +592,7 @@ public DataTypeComponent add(int rowIndex, DataType dt) throws UsrException {
 		});
 
 		fixSelection();
-		componentEdited();
+//		componentEdited();
 		selectionChanged();
 		return dtc;
 	}
@@ -637,7 +628,7 @@ public DataTypeComponent add(int rowIndex, DataType dt, int dtLength) throws Usr
 		}
 
 		fixSelection();
-		componentEdited();
+		//componentEdited();
 		selectionChanged();
 		return dtc;
 	}
@@ -753,7 +744,6 @@ public DataTypeComponent replace(int rowIndex, DataType datatype, int length)
 			replace(rowIndex, datatype, newCompSize, oldDtc.getFieldName(), oldDtc.getComment());
 
 		fixSelection();
-		componentEdited();
 		selectionChanged();
 		return dtc;
 	}
@@ -806,7 +796,6 @@ protected DataTypeComponent replaceComponentRange(int startRowIndex, int endRowI
 		}
 		dtc.setComment(oldDtc.getComment());
 		fixSelection();
-		componentEdited();
 		selectionChanged();
 		return dtc;
 	}
@@ -994,7 +983,6 @@ public boolean moveUp() throws NoSuchElementException {
 		int newIndex = startIndex - 1;
 		moved = shiftComponentsUp(startIndex, endIndex);
 		if (moved) {
-			componentEdited();
 			FieldSelection tmpFieldSelection = new FieldSelection();
 			tmpFieldSelection.addRange(newIndex, newIndex + numSelected);
 			setSelection(tmpFieldSelection);
@@ -1018,7 +1006,6 @@ public boolean moveDown() throws NoSuchElementException {
 		int newIndex = startIndex + 1;
 		moved = shiftComponentsDown(startIndex, endIndex);
 		if (moved) {
-			componentEdited();
 			FieldSelection tmpFieldSelection = new FieldSelection();
 			tmpFieldSelection.addRange(newIndex, newIndex + numSelected);
 			setSelection(tmpFieldSelection);
@@ -1038,7 +1025,6 @@ public void duplicateMultiple(int rowIndex, int multiple, TaskMonitor monitor)
 		// Adjust the selection since we added some components. Select last component added.
 		setSelection(new int[] { rowIndex + multiple });
 
-		componentEdited();
 		lastNumDuplicates = multiple;
 	}
 
@@ -1143,9 +1129,7 @@ public int getRowCount() {
 	public void setValueAt(Object aValue, int rowIndex, int modelColumnIndex) {
 		try {
 			settingValueAt = true;
-			if (fieldEdited(aValue, rowIndex, modelColumnIndex)) {
-				componentEdited();
-			}
+			fieldEdited(aValue, rowIndex, modelColumnIndex);
 		}
 		finally {
 			settingValueAt = false;
@@ -1284,7 +1268,7 @@ public void restored(DataTypeManager dataTypeManager) {
 			return;
 		}
 
-		Composite composite = getOriginalComposite();
+		T composite = getOriginalComposite();
 		boolean reload = true;
 		if (hasChanges || !viewComposite.isEquivalent(composite)) {
 			hasChanges = true;
@@ -1323,7 +1307,11 @@ public void restored(DataTypeManager dataTypeManager) {
 	public void dataTypeRemoved(DataTypeManager dtm, DataTypePath path) {
 
 		if (dtm != originalDTM) {
-			return; // Different DTM than the one for this data type.
+			throw new AssertException("Listener only supports original DTM");
+		}
+
+		if (!isLoaded()) {
+			return;
 		}
 
 		DataType dataType = viewDTM.getDataType(path.getCategoryPath(), path.getDataTypeName());
@@ -1380,7 +1368,7 @@ public void dataTypeRemoved(DataTypeManager dtm, DataTypePath path) {
 	public void dataTypeRenamed(DataTypeManager dtm, DataTypePath oldPath, DataTypePath newPath) {
 
 		if (dtm != originalDTM) {
-			return; // Different DTM than the one for this data type.
+			throw new AssertException("Listener only supports original DTM");
 		}
 
 		if (!isLoaded()) {
@@ -1434,7 +1422,11 @@ public void dataTypeRenamed(DataTypeManager dtm, DataTypePath oldPath, DataTypeP
 	public void dataTypeMoved(DataTypeManager dtm, DataTypePath oldPath, DataTypePath newPath) {
 
 		if (dtm != originalDTM) {
-			return; // Different DTM than the one for this data type.
+			throw new AssertException("Listener only supports original DTM");
+		}
+
+		if (!isLoaded()) {
+			return;
 		}
 
 		DataType dt = viewDTM.getDataType(oldPath);
@@ -1468,20 +1460,14 @@ public void dataTypeMoved(DataTypeManager dtm, DataTypePath oldPath, DataTypePat
 	public void dataTypeChanged(DataTypeManager dtm, DataTypePath path) {
 		try {
 
-			if (!isLoaded()) {
-				return;
+			if (dtm != originalDTM) {
+				throw new AssertException("Listener only supports original DTM");
 			}
 
-			if (dtm instanceof CompositeViewerDataTypeManager) {
-				// required to detect settings changes
-				componentEdited();
+			if (!isLoaded()) {
 				return;
 			}
 
-			if (dtm != originalDTM) {
-				return; // Different DTM than the one for this data type.
-			}
-
 			// If we don't currently have any modifications that need applying and
 			// the structure in the editor just changed, then show the changed
 			// structure.
@@ -1566,7 +1552,7 @@ public void dataTypeReplaced(DataTypeManager dtm, DataTypePath oldPath, DataType
 			DataType newDataType) {
 
 		if (dtm != originalDTM) {
-			return; // Different DTM than the one for this data type.
+			throw new AssertException("Listener only supports original DTM");
 		}
 
 		if (!isLoaded()) {
@@ -1723,15 +1709,6 @@ public int getLastNumDuplicates() {
 		return lastNumDuplicates;
 	}
 
-	/**
-	 * Called whenever the data structure's modification state changes.
-	 */
-	void componentEdited() {
-		updateAndCheckChangeState(); // Update the composite's change state information.
-		fireTableDataChanged();
-		componentDataChanged();
-	}
-
 	protected int convertRowToOrdinal(int rowIndex) {
 		return rowIndex;
 	}