Merge branch 'GP-4270_dragonmacher'

Author: ryanmkurtz

Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/DecompilerDisposer.java

@@ -1,6 +1,5 @@
 /* ###
  * IP: GHIDRA
- * REVIEWED: YES
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,11 +15,11 @@
  */
 package ghidra.app.decompiler;
 
+import java.io.*;
+
 import generic.concurrent.*;
 import ghidra.util.task.TaskMonitor;
 
-import java.io.*;
-
 public class DecompilerDisposer {
 	private static String THREAD_POOL_NAME = "Decompiler Disposer";
 	private static ConcurrentQ<AbstractDisposable, AbstractDisposable> queue;
@@ -38,7 +37,7 @@ private DecompilerDisposer() {
 	/**
 	 * Disposes the given Process and related streams from a background thread.  This is necessary
 	 * due to a low-probability deadlock that occurs in the JVM.
-	 * 
+	 *
 	 * @param process The process to destroy.
 	 * @param ouputStream The output stream to close
 	 * @param inputStream The input stream to close
@@ -54,23 +53,24 @@ public static void dispose(Process process, OutputStream ouputStream, InputStrea
 	 * <p>
 	 * Note:<br>
 	 * A class to handle the rare case where the {@link DecompInterface}'s
-	 * synchronized methods are blocking 
+	 * synchronized methods are blocking
 	 * while a decompile operation has died and maintained the lock.  In that scenario, calling
-	 * dispose on this class will eventually try to enter a synchronized method that will 
+	 * dispose on this class will eventually try to enter a synchronized method that will
 	 * remain blocked forever.
 	 * <p>
-	 * I examined the uses of dispose() on the {@link DecompInterface} and 
+	 * I examined the uses of dispose() on the {@link DecompInterface} and
 	 * determined that calling dispose() is a
 	 * final operation, which means that you don't have to wait.  Further, after calling
 	 * dispose() on this class, you should no longer use it.
+	 * @param decompiler the decompiler
 	 */
 	public static void dispose(DecompInterface decompiler) {
 		DecompInterfaceDisposable disposable = new DecompInterfaceDisposable(decompiler);
 		queue.add(disposable);
 	}
 
-	private static class DisposeCallback implements
-			QCallback<AbstractDisposable, AbstractDisposable> {
+	private static class DisposeCallback
+			implements QCallback<AbstractDisposable, AbstractDisposable> {
 		@Override
 		public AbstractDisposable process(AbstractDisposable disposable, TaskMonitor monitor) {
 			disposable.dispose();
@@ -87,7 +87,8 @@ private static class RuntimeProcessDisposable extends AbstractDisposable {
 		private OutputStream ouputStream;
 		private InputStream inputStream;
 
-		RuntimeProcessDisposable(Process process, OutputStream ouputStream, InputStream inputStream) {
+		RuntimeProcessDisposable(Process process, OutputStream ouputStream,
+				InputStream inputStream) {
 			this.process = process;
 			this.ouputStream = ouputStream;
 			this.inputStream = inputStream;

Ghidra/Framework/Docking/src/main/java/docking/PopupMenuContext.java

@@ -20,8 +20,10 @@
 import java.awt.event.MouseEvent;
 import java.util.Objects;
 
+import generic.json.Json;
+
 /**
- * A class that holds information used to show a popup menu 
+ * A class that holds information used to show a popup menu
  */
 public class PopupMenuContext {
 
@@ -58,4 +60,9 @@ public Object getSource() {
 		}
 		return component;
 	}
+
+	@Override
+	public String toString() {
+		return Json.toString(this);
+	}
 }

Ghidra/Framework/Docking/src/main/java/docking/widgets/DefaultDropDownSelectionDataModel.java

@@ -74,10 +74,10 @@ public List<T> getMatchingData(String searchText) {
 
 	@Override
 	public int getIndexOfFirstMatchingEntry(List<T> list, String text) {
-		// The data are sorted such that lower-case is before upper-case and smaller length 
-		// matches come before longer matches.  If we ever find a case-sensitive exact match, 
-		// use that. Otherwise, keep looking for a case-insensitive exact match.  The 
-		// case-insensitive match is preferred over a non-matching item.  Once we get to a 
+		// The data are sorted such that lower-case is before upper-case and smaller length
+		// matches come before longer matches.  If we ever find a case-sensitive exact match,
+		// use that. Otherwise, keep looking for a case-insensitive exact match.  The
+		// case-insensitive match is preferred over a non-matching item.  Once we get to a
 		// non-matching item, we can quit.
 		int lastPreferredMatchIndex = -1;
 		for (int i = 0; i < list.size(); i++) {
@@ -118,7 +118,7 @@ public String getDisplayText(T value) {
 
 //==================================================================================================
 // Inner Classes
-//==================================================================================================	
+//==================================================================================================
 
 	private class ObjectStringComparator implements Comparator<Object> {
 		Comparator<String> stringComparator = new CaseInsensitiveDuplicateStringComparator();

Ghidra/Framework/Docking/src/main/java/docking/widgets/ListSelectionDialog.java

@@ -33,7 +33,6 @@ public class ListSelectionDialog<T> extends DialogComponentProvider {
 
 	private DropDownSelectionTextField<T> field;
 	protected boolean cancelled;
-	private RowObjectTableModel<T> userTableModel;
 	private DataToStringConverter<T> searchConverter;
 	private DataToStringConverter<T> descriptionConverter;
 	private List<T> data;
@@ -61,8 +60,12 @@ public ListSelectionDialog(String title, String label, List<T> data,
 		this.data = data;
 		this.searchConverter = searchConverter;
 		this.descriptionConverter = descriptionConverter;
+
+		// Use a separate list for the drop down widget, since it needs to sort its data and we do
+		// not want to change the client data sort.
+		List<T> dropDownData = new ArrayList<>(data);
 		DefaultDropDownSelectionDataModel<T> model = new DefaultDropDownSelectionDataModel<>(
-			new ArrayList<>(data), searchConverter, descriptionConverter) {
+			dropDownData, searchConverter, descriptionConverter) {
 
 			// overridden to return all data for an empty search; this lets the down-arrow
 			// show the full list
@@ -151,14 +154,18 @@ protected void browse() {
 	}
 
 	private RowObjectTableModel<T> getTableModel() {
-		if (userTableModel != null) {
-			return userTableModel;
-		}
-
-		return new DefaultTableModel();
+		return new DefaultTableModel(data);
 	}
 
 	private class DefaultTableModel extends AbstractGTableModel<T> {
+
+		private List<T> modelData;
+
+		DefaultTableModel(List<T> modelData) {
+			// copy the data so that a call to dispose() will not clear the data in the outer class
+			this.modelData = new ArrayList<>(modelData);
+		}
+
 		@Override
 		public String getColumnName(int columnIndex) {
 			if (columnIndex == 0) {
@@ -184,7 +191,7 @@ public boolean isCellEditable(int rowIndex, int columnIndex) {
 
 		@Override
 		public List<T> getModelData() {
-			return data;
+			return modelData;
 		}
 
 		@Override

Ghidra/Framework/Docking/src/main/java/docking/widgets/table/AbstractDynamicTableColumn.java

@@ -29,8 +29,6 @@
  * determines the appropriate cell object for use by the table column this field represents. It can
  * then return the appropriate object to display in the table cell for the indicated row object.
  *
- * Implementations of this interface must provide a public default constructor.
- * 
  * @param <ROW_TYPE> The row object class supported by this column
  * @param <COLUMN_TYPE> The column object class supported by this column
  * @param <DATA_SOURCE> The object class type that will be passed to see
@@ -95,8 +93,8 @@ public Comparator<COLUMN_TYPE> getComparator(DynamicColumnTableModel<?> model,
 	public Class<COLUMN_TYPE> getColumnClass() {
 		@SuppressWarnings("rawtypes")
 		Class<? extends AbstractDynamicTableColumn> implementationClass = getClass();
-		List<Class<?>> typeArguments = ReflectionUtilities.getTypeArguments(
-			AbstractDynamicTableColumn.class, implementationClass);
+		List<Class<?>> typeArguments = ReflectionUtilities
+				.getTypeArguments(AbstractDynamicTableColumn.class, implementationClass);
 		return (Class<COLUMN_TYPE>) typeArguments.get(1);
 	}
 
@@ -106,8 +104,8 @@ public Class<COLUMN_TYPE> getColumnClass() {
 	public Class<ROW_TYPE> getSupportedRowType() {
 		@SuppressWarnings("rawtypes")
 		Class<? extends AbstractDynamicTableColumn> implementationClass = getClass();
-		List<Class<?>> typeArguments = ReflectionUtilities.getTypeArguments(
-			AbstractDynamicTableColumn.class, implementationClass);
+		List<Class<?>> typeArguments = ReflectionUtilities
+				.getTypeArguments(AbstractDynamicTableColumn.class, implementationClass);
 		return (Class<ROW_TYPE>) typeArguments.get(0);
 	}
 
@@ -193,7 +191,7 @@ public final int hashCode() {
 		return getIdentifier().hashCode();
 	}
 
-	// Note: this method is here because the default 'identifier' must be lazy loaded, as 
+	// Note: this method is here because the default 'identifier' must be lazy loaded, as
 	//       at construction time not all the variables needed are available.
 	private String getIdentifier() {
 		/*
@@ -202,7 +200,7 @@ private String getIdentifier() {
 		 		-The case where 2 different column classes share the same column header value
 		 		-The case where a single column class is used repeatedly, with a different
 		 		 column header value each time
-		
+
 		 	Thus, to be unique, we need to combine both the class name and the column header
 		 	value.  The only time this may be an issue is if the column header value changes
 		 	dynamically--not sure if this actually happens anywhere in our system.  If it did,

Ghidra/Framework/Docking/src/main/java/docking/widgets/table/AbstractDynamicTableColumnStub.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.
@@ -20,14 +20,18 @@
 
 /**
  * This class is meant to be used by DynamicTableColumn implementations that do not care about
- * the DATA_SOURCE parameter of DynamicTableColumn.  This class will stub the default 
+ * the DATA_SOURCE parameter of DynamicTableColumn.  This class will stub the default
  * {@link #getValue(Object, Settings, Object, ServiceProvider)} method and
  * call a version of the method that does not have the DATA_SOURCE parameter.
+ * <p>
+ * Subclasses are not discoverable.  To create discoverable columns for the framework, you must
+ * extends {@link DynamicTableColumnExtensionPoint}.
+ *
  * @param <ROW_TYPE> the row type
  * @param <COLUMN_TYPE> the column type
  */
-public abstract class AbstractDynamicTableColumnStub<ROW_TYPE, COLUMN_TYPE> extends
-		AbstractDynamicTableColumn<ROW_TYPE, COLUMN_TYPE, Object> {
+public abstract class AbstractDynamicTableColumnStub<ROW_TYPE, COLUMN_TYPE>
+		extends AbstractDynamicTableColumn<ROW_TYPE, COLUMN_TYPE, Object> {
 
 	@Override
 	public COLUMN_TYPE getValue(ROW_TYPE rowObject, Settings settings, Object data,

Ghidra/Framework/Docking/src/main/java/docking/widgets/table/AnyObjectTableModel.java

@@ -156,7 +156,7 @@ private static char maybeToUpperCase(char c, boolean shouldBeUpper) {
 	}
 
 	private class MethodColumn extends AbstractDynamicTableColumn<T, Object, Object> {
-		private String name;
+		private String methodName;
 		private Method method;
 		private Class<?> returnType;
 
@@ -166,7 +166,7 @@ public MethodColumn(Class<T> dataClass, String methodName) {
 				init(m);
 			}
 			catch (NoSuchMethodException | SecurityException e) {
-				name = "No method: " + methodName;
+				this.methodName = "No method: " + methodName;
 			}
 		}
 
@@ -181,12 +181,12 @@ public String getColumnDescription() {
 
 		private void init(Method m) {
 			this.method = m;
-			name = method.getName();
-			if (name.startsWith("get")) {
-				name = name.substring(3);
+			methodName = method.getName();
+			if (methodName.startsWith("get")) {
+				methodName = methodName.substring(3);
 			}
 
-			name = fromCamelCase(name);
+			methodName = fromCamelCase(methodName);
 			returnType = method.getReturnType();
 		}
 
@@ -198,15 +198,15 @@ public Class<Object> getColumnClass() {
 
 		@Override
 		public String getColumnName() {
-			return name;
+			return methodName;
 		}
 
 		@Override
 		public Object getValue(T rowObject, Settings settings, Object dataSource,
 				ServiceProvider sp) throws IllegalArgumentException {
 			if (method == null) {
-				Msg.error(this,
-					"No method '" + name + "' on class" + rowObject.getClass().getSimpleName());
+				Msg.error(this, "No method '" + methodName + "' on class " +
+					rowObject.getClass().getSimpleName());
 				return null;
 			}
 			try {

Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GFilterTable.java

@@ -76,7 +76,6 @@ private void addTableSelectionListener(GTable gTable) {
 	}
 
 	private void buildThreadedTable() {
-		@SuppressWarnings("unchecked")
 		GThreadedTablePanel<ROW_OBJECT> tablePanel =
 			createThreadedTablePanel((ThreadedTableModel<ROW_OBJECT, ?>) model);
 		table = tablePanel.getTable();

Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableWidget.java

@@ -168,6 +168,20 @@ public int getSelectedRowCount() {
 		return table.getSelectedRowCount();
 	}
 
+	/**
+	 * Sets the selection mode of this table.
+	 *
+	 * @param mode the mode
+	 * @see ListSelectionModel#setSelectionMode(int)
+	 */
+	public void setSelectionMode(int mode) {
+		table.getSelectionModel().setSelectionMode(mode);
+	}
+
+	public int getSelectionMode() {
+		return table.getSelectionModel().getSelectionMode();
+	}
+
 	public void addSelectionListener(ObjectSelectedListener<T> l) {
 		gFilterTable.addSelectionListener(l);
 	}