Merge remote-tracking branch 'origin/GT-3054_new_function_tags_view'

Author: ryanmkurtz

Ghidra/Features/Base/certification.manifest

@@ -400,7 +400,7 @@ src/main/help/help/topics/FunctionTagPlugin/images/DeleteWarning.png||GHIDRA||||
 src/main/help/help/topics/FunctionTagPlugin/images/EditNotAllowedWarning.png||GHIDRA||||END|
 src/main/help/help/topics/FunctionTagPlugin/images/EditTag.png||GHIDRA||||END|
 src/main/help/help/topics/FunctionTagPlugin/images/FilterField.png||GHIDRA||||END|
-src/main/help/help/topics/FunctionTagPlugin/images/FunctionTagPlugin.png||GHIDRA||||END|
+src/main/help/help/topics/FunctionTagPlugin/images/FullWindow.png||GHIDRA||||END|
 src/main/help/help/topics/FunctionTagPlugin/images/InputField.png||GHIDRA||||END|
 src/main/help/help/topics/FunctionWindowPlugin/function_window.htm||GHIDRA||||END|
 src/main/help/help/topics/FunctionWindowPlugin/images/FunctionWindow.png||GHIDRA||||END|

Ghidra/Features/Base/src/main/help/help/topics/FunctionTagPlugin/function_tag_window.htm

@@ -25,43 +25,43 @@ <H1><A name="FunctionTagPlugin"></A> Function Tag Window</H1>
       <TABLE border="0" width="100%">
         <TR>
           <TD width="100%" align="center"><IMG alt="" border="0" src=
-          "images/FunctionTagPlugin.png"></TD>
+          "images/FullWindow.png"></TD>
         </TR>
       </TABLE>
     </CENTER>     
 
     <H2>Window Components</H2>
 
     <BLOCKQUOTE>
-      <P>This window has five distinct sections:</P>
-
       <UL>
-        <LI><B>Available Tags List</B>: Displays all tags that are available to assign to the
-        current function.</LI>
+        <LI><B>All Tags TAble</B>: Displays all tags that are available to assign to the
+        current function, as well as a count of the number of times each tag has been used
+        in the current program.</LI>
 
         <LI><B>Assigned Tags List</B>: Displays all tags that have been assigned to the current
         function.</LI>
+        
+        <LI><B>Function Panel</B>: Displays functions that contain any selected tags. If multiple
+        tags are selected, functions containing ANY of the tags will be displayed.</LI>
 
         <LI>
           <B>Tag Input Field</B>: Allows users to create new tags. Multiple tags may be created at one time.
-
           <P style="margin: 20px;"><IMG alt="" border="0" src="images/InputField.png"></P>
         </LI>
 
         <LI>
           <B>Filter Field</B>: Allows users to filter what is shown in the Available and Assigned tag lists. 
-
           <P style="margin: 20px;"><IMG alt="" border="0" src="images/FilterField.png"></P>
         </LI>
       </UL>
 
       <UL class="noindent">
         <LI><B>Action Buttons</B></LI>
           <UL>
-            <LI><IMG alt="" border="0" src="images/2rightarrow.png"> &nbsp;
+            <LI><IMG alt="" border="0" src="images/2rightarrow.png" width="16" height="16"> &nbsp;
             Assigns the selected tag(s) to the current function</LI>
 
-            <LI><IMG alt="" border="0" src="images/2leftarrow.png"> &nbsp;
+            <LI><IMG alt="" border="0" src="images/2leftarrow.png" width="16" height="16"> &nbsp;
             Removes the selected tag(s) from the current function</LI>
 
             <LI><IMG alt="" border="0" src="Icons.DELETE_ICON"> &nbsp;
@@ -80,7 +80,7 @@ <H3><A name="Create_Tag"></A>Create</H3>
 	    <BLOCKQUOTE>
 	      <P>Tags can be created by using the <I>Tag Input Field</I> described above. Users may enter
 	      multiple tag names delimited by a comma. All newly-created tags will be displayed in the
-	      Available Tags List and are NOT assigned to any function.</P>
+	      Available Tags List but are NOT yet assigned to any function.</P>
 
 	      <P><IMG alt="" border="0" src="../../shared/tip.png">Each tag may have an associated comment that
 	      is visible as a tooltip. This can be assigned after the tag has been created (see <code>edit</code> section below).</P>
@@ -112,14 +112,22 @@ <H3><A name="Edit_Tag"></A>Edit</H3>
 	      <P>If editing is allowed, the following dialog will be shown:</P>
 
 	      <P align="center"><IMG alt="" border="0" src="images/EditTag.png"></P>
+	    
+	      <P><IMG alt="" border="0" src="../../shared/tip.png">An <i>italicized</i> tag name
+	      indicates that the tag was loaded from an external source and has not yet been
+	      added to the program, making it immutable. As soon as the tag is assigned to a function it becomes
+	      editable. If you delete the tag using the <IMG alt="" border="0" src=
+	      "Icons.DELETE_ICON" width="16" height="16"> icon it will be removed from 
+	      the program and once again be immutable.</P>
+
 	    </BLOCKQUOTE>
 
 	    <H3><A name="Add_Tag_To_Function"></A>Add to Function</H3>
 
 	    <BLOCKQUOTE>
 	      <P>Tags may be added to a function by selecting a set of tags and pressing the <IMG alt=""
 	      border="0" src="images/2rightarrow.png" width="16" height="16"> button. The tags will be
-	      removed from the Available Tags List and added to the Assigned Tags List.</P>
+	      added to the Assigned Tags list, and shown as disabled in the Available Tags list.</P>
 	    </BLOCKQUOTE>
 
 	    <H3><A name="Remove_Tag_From_Function"></A>Remove from Function</H3>
@@ -134,10 +142,12 @@ <H3><A name="Remove_Tag_From_Function"></A>Remove from Function</H3>
     <H2><a name="loading_tags">Loading External Tags</a></H2>
 
     <BLOCKQUOTE>
-      <P>Tags may be loaded on startup from an external source if desired. These will be shown in
-      <FONT color="blue">blue</FONT> and cannot be edited or deleted, with one caveat: once a tag has
-      been assigned to a function it ceases to have any special protections and can be edited/deleted
-      just as any other.</P>
+      <P>Tags may be loaded on startup from an external source if desired. These tags will be shown with 
+      an asterisk (*) after the name and cannot be edited or deleted; with one caveat: once a tag has
+      been assigned to a function it ceases to have any special protections and can be edited
+      like any other. If the tag is ever removed from all functions using the 
+      <IMG alt="" border="0" src="Icons.DELETE_ICON"> button, it will again be present in the 
+      Available Tags list.</P>
 
       <P>To make these available there must be a file named <I>functionTags.xml</I> available on
       the classpath. Edit (or create) this file and add tags as needed. The format is

Ghidra/Features/Base/src/main/help/help/topics/FunctionTagPlugin/images/EditNotAllowedWarning.png

@@ -0,0 +1,127 @@
+/* ###
+ * 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.app.plugin.core.function.tags;
+
+import java.awt.BorderLayout;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import javax.swing.BorderFactory;
+import javax.swing.JLabel;
+import javax.swing.JPanel;
+
+import ghidra.app.services.GoToService;
+import ghidra.framework.plugintool.ComponentProviderAdapter;
+import ghidra.program.model.listing.Function;
+import ghidra.program.model.listing.FunctionTag;
+import ghidra.program.model.listing.Program;
+import ghidra.util.table.GhidraThreadedTablePanel;
+
+/**
+ * Displays all functions that are associated with the selected tag in the
+ * {@link SourceTagsPanel}
+ */
+public class AllFunctionsPanel extends JPanel {
+
+	private FunctionTableModel model;
+	private JLabel titleLabel;
+
+	/**
+	 * Constructor
+	 * 
+	 * @param program the current program
+	 * @param provider the component provider
+	 * @param title the title of the panel
+	 */
+	public AllFunctionsPanel(Program program, ComponentProviderAdapter provider, String title) {
+
+		model = new FunctionTableModel(title, provider.getTool(), program, null);
+		GhidraThreadedTablePanel<Function> tablePanel = new GhidraThreadedTablePanel<>(model);
+		setLayout(new BorderLayout());
+		
+		titleLabel = new JLabel(title);
+		titleLabel.setBorder(BorderFactory.createEmptyBorder(3, 5, 0, 0));
+		
+		add(titleLabel, BorderLayout.NORTH);
+		add(tablePanel, BorderLayout.CENTER);
+		
+		GoToService goToService = provider.getTool().getService(GoToService.class);
+		if (goToService != null) {
+			tablePanel.getTable().installNavigation(goToService, goToService.getDefaultNavigatable());
+		}
+	}
+
+	/**
+	 * Updates the table with whatever is in the {@link #model}
+	 */
+	public void refresh() {
+		model.fireTableDataChanged();
+	}
+
+	/**
+	 * Updates the table with functions containing the selected tags given
+	 * 
+	 * @param selectedTags the selected function tags
+	 */
+	public void refresh(List<FunctionTag> selectedTags) {
+		setSelectedTags(selectedTags);
+	}
+
+	/**
+	 * Stores the current program
+	 * 
+	 * @param program the current program
+	 */
+	public void setProgram(Program program) {
+		model.setProgram(program);
+	}
+
+	/**
+	 * Updates the panel with the set of tags selected by the user. This
+	 * will update the panel title and the contents of the function table.
+	 * 
+	 * @param tags the selected tags
+	 */
+	public void setSelectedTags(List<FunctionTag> tags) {
+		String tagNames = tags.stream()
+							  .map(t -> t.getName())
+							  .collect(Collectors.joining(" or "))
+							  .toString();
+
+		titleLabel.setText("Functions With Tag: " + tagNames);
+		model.setSelectedTags(tags);
+	}
+
+	/**
+	 * Returns the list of functions in the panel
+	 * <p>
+	 * This is only used for testing!
+	 * 
+	 * @return  the list of functions
+	 */
+	public List<Function> getFunctions() {
+		return model.getFunctions();
+	}
+	
+	/**
+	 * Returns the functions table model
+	 * 
+	 * @return the functions table model
+	 */
+	public FunctionTableModel getTableModel() {
+		return model;
+	}
+}

Ghidra/Features/Base/src/main/help/help/topics/FunctionTagPlugin/images/FilterField.png

@@ -0,0 +1,120 @@
+/* ###
+ * 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.app.plugin.core.function.tags;
+
+import java.util.List;
+
+import docking.widgets.table.DiscoverableTableUtils;
+import docking.widgets.table.TableColumnDescriptor;
+import ghidra.framework.plugintool.ServiceProvider;
+import ghidra.program.model.address.Address;
+import ghidra.program.model.listing.*;
+import ghidra.util.datastruct.Accumulator;
+import ghidra.util.exception.CancelledException;
+import ghidra.util.table.AddressBasedTableModel;
+import ghidra.util.table.field.*;
+import ghidra.util.task.TaskMonitor;
+
+/**
+ * The data model that backs the {@link AllFunctionsPanel}. This displays a list
+ * of functions that have function tags matching a provided set. Note that
+ * a function will be displayed as long as it has AT LEAST ONE of the tags
+ * in the set.
+ */
+class FunctionTableModel extends AddressBasedTableModel<Function> {
+
+	// The function tags to display functions for
+	private List<FunctionTag> tags;
+
+	/**
+	 * Constructor
+	 * 
+	 * @param title the title of the model
+	 * @param serviceProvider the service provider
+	 * @param program the current program
+	 * @param monitor the task monitor
+	 */
+	public FunctionTableModel(String title, ServiceProvider serviceProvider, Program program,
+			TaskMonitor monitor) {
+		super(title, serviceProvider, program, monitor);
+	}
+
+	@Override
+	public Address getAddress(int row) {
+		Function rowObject = getRowObject(row);
+		return rowObject.getEntryPoint();
+	}
+
+	@Override
+	protected TableColumnDescriptor<Function> createTableColumnDescriptor() {
+		TableColumnDescriptor<Function> descriptor = new TableColumnDescriptor<>();
+
+		descriptor.addVisibleColumn(
+			DiscoverableTableUtils.adaptColumForModel(this, new LabelTableColumn()));
+		descriptor.addVisibleColumn(
+			DiscoverableTableUtils.adaptColumForModel(this, new AddressTableColumn()), 1, true);
+		descriptor.addVisibleColumn(
+			DiscoverableTableUtils.adaptColumForModel(this, new FunctionTagTableColumn()));
+
+		return descriptor;
+	}
+
+	@Override
+	protected void doLoad(Accumulator<Function> accumulator, TaskMonitor monitor)
+			throws CancelledException {
+		
+		if (program == null) {
+			return;
+		}
+		if (tags == null) {
+			return;
+		}
+
+		// Loop over all functions in the program, filtering out those that do not
+		// do not contain at least one of the tags in the provided set.
+		FunctionIterator iter = program.getFunctionManager().getFunctions(true);
+		monitor.initialize(program.getFunctionManager().getFunctionCount());
+		while (iter.hasNext()) {
+			monitor.incrementProgress(1);
+			monitor.checkCanceled();
+			Function f = iter.next();
+			boolean hasTag = f.getTags().stream().anyMatch(t -> tags.contains(t));
+			if (hasTag) {
+				accumulator.add(f);
+			}
+		}
+	}
+
+	/**
+	 * Sets the tags associated with this model. This causes a reload of
+	 * the function table
+	 * 
+	 * @param tags the selected tags
+	 */
+	public void setSelectedTags(List<FunctionTag> tags) {
+		this.tags = tags;
+		reload();
+	}
+
+	/**
+	 * Returns the list of functions in the table
+	 * 
+	 * @return the contents of the table
+	 */
+	public List<Function> getFunctions() {
+		return getAllData();
+	}
+}