+Functions can be open or closed in the listing display. When closed, all the instructions + that make up that function are hidden from view in the listing display. Each consecutive + range of instructions in a function are replaced with a "collapsed code" line to indicate + that some code is hidden and which function the hidden code belongs to. On the function + signature line, there is an open/close control (+/-) that can be used to open or close + a function.
+The open/close state for functions is persisted across sessions. Also, navigating to + an address in the body of a closed function will cause that function to be opened.
+Actions for Opening/Closing a Function
+++In addition to the control widget in the display, there are also several actions + that can be used to control the open/close state of a single function or all functions. +
+ +
The display of parameters and local variables for a function can be toggled on or off. Normally, these are displayed just below the function signature, but they can be turned off to conserve screen space. There is an open/close control (+/-) - on the first parameter/variable line that can be used to toggle them on or off. + on the first parameter/variable line that can be used to toggle them on or off. Note that + unlike the open/close state for functions, the open/close state for variables is not + persistent across sessions for a program. The default state of whether or not to + display variables is a tool state is persisted for the tool, not individual programs.diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/codebrowser/CodeViewerProvider.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/codebrowser/CodeViewerProvider.java index 0bce2b4696..618e11c03c 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/codebrowser/CodeViewerProvider.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/codebrowser/CodeViewerProvider.java @@ -131,6 +131,7 @@ public class CodeViewerProvider extends NavigatableComponentProviderAdapter private MultiListingLayoutModel multiModel; private ToggleDockingAction toggleVariablesAction; + private ToggleDockingAction toggleFunctionsAction; public CodeViewerProvider(CodeBrowserPluginInterface plugin, FormatManager formatMgr, boolean isConnected) { @@ -481,24 +482,49 @@ public class CodeViewerProvider extends NavigatableComponentProviderAdapter action = new GotoNextFunctionAction(tool, plugin.getName()); tool.addAction(action); + new ActionBuilder("Open All Functions", plugin.getName()) + .popupMenuPath("Function", "Open All Functions") + .popupMenuGroup("Visibility", "1") + .helpLocation(new HelpLocation("CodeBrowserPlugin", "Open_All_Functions")) + .withContext(ProgramLocationActionContext.class) + .onAction(c -> showAllFunctions(true)) + .buildAndInstallLocal(this); + new ActionBuilder("Close All Functions", plugin.getName()) + .popupMenuPath("Function", "Close All Functions") + .popupMenuGroup("Visibility", "2") + .helpLocation(new HelpLocation("CodeBrowserPlugin", "Close_All_Functions")) + .withContext(ProgramLocationActionContext.class) + .onAction(c -> showAllFunctions(false)) + .buildAndInstallLocal(this); + new ActionBuilder("Toggle Open Function", plugin.getName()) + .popupMenuPath("Function", "Open/Close Function") + .popupMenuGroup("Visibility", "3") + .helpLocation(new HelpLocation("CodeBrowserPlugin", "Toggle_Function")) + .keyBinding("SPACE") + .withContext(ProgramLocationActionContext.class) + .validWhen(this::isInCollapsableCodeArea) + .enabledWhen(this::isInCollapsableCodeArea) + .onAction(c -> toggleShowFunction(c)) + .buildAndInstallLocal(this); + toggleVariablesAction = - new ToggleActionBuilder("Show All Function Variables", plugin.getName()) - .popupMenuPath("Function", "Show/Hide All Variables") - .popupMenuGroup("Variables") + new ToggleActionBuilder("Show Function Variables By Default", plugin.getName()) + .popupMenuPath("Function", "Show Variables By Default") + .popupMenuGroup("Visibility", "5") .helpLocation(new HelpLocation("CodeBrowserPlugin", "Show_All_Variables")) .selected(true) .withContext(ProgramLocationActionContext.class) .onAction(c -> showVariablesForAllFunctions(toggleVariablesAction.isSelected())) .buildAndInstallLocal(this); - new ActionBuilder("Toggle Show Function Variables", plugin.getName()) + new ActionBuilder("Show/Hide Function Variables", plugin.getName()) .popupMenuPath("Function", "Show/Hide Variables") - .popupMenuGroup("Variables") + .popupMenuGroup("Visibility", "4") .helpLocation(new HelpLocation("CodeBrowserPlugin", "Show_Variables")) .keyBinding("SPACE") .withContext(ProgramLocationActionContext.class) - .validWhen(this::isInFunctionArea) - .enabledWhen(this::isInFunctionArea) + .validWhen(this::isInFunctionVariablesArea) + .enabledWhen(this::isInFunctionVariablesArea) .onAction(c -> toggleShowVariables(c.getAddress())) .buildAndInstallLocal(this); @@ -506,10 +532,49 @@ public class CodeViewerProvider extends NavigatableComponentProviderAdapter } + private void showAllFunctions(boolean selected) { + ListingModel model = listingPanel.getListingModel(); + model.setAllFunctionsOpen(selected); + } + + private void toggleShowFunction(ProgramLocationActionContext context) { + Address cuAddress = context.getAddress(); + Function function = program.getListing().getFunctionContaining(cuAddress); + if (function == null) { + return; + } + ListingModel model = listingPanel.getListingModel(); + Address functionAddress = function.getEntryPoint(); + boolean open = model.isFunctionOpen(functionAddress); + + model.setFunctionOpen(functionAddress, !open); + if (context.getLocation() instanceof FunctionSignatureFieldLocation) { + // no need to move cursor + return; + } + if (!open) { + setLocation(new ProgramLocation(program, cuAddress)); + } + else { + // We have to use the CollapsedCodeLocation in this case, any other goto to + // an address that is collapse will open it up, which we don't want since + // we just closed it. Also, we need to correct to the start of the range since + // that is the address that will have the CollapsedField + Address corrected = adjustToStartOfContainingRange(function, cuAddress); + setLocation(new CollapsedCodeLocation(program, corrected)); + } + } + + private Address adjustToStartOfContainingRange(Function function, Address cuAddress) { + AddressSetView body = function.getBody(); + AddressRange range = body.getRangeContaining(cuAddress); + return range == null ? function.getEntryPoint() : range.getMinAddress(); + } + private void toggleShowVariables(Address address) { ListingModel model = listingPanel.getListingModel(); boolean open = model.areFunctionVariablesOpen(address); - model.setAllFunctionVariablesOpen(!open); + model.setFunctionVariablesOpen(address, !open); setLocation(new VariablesOpenCloseLocation(program, address)); } @@ -518,12 +583,28 @@ public class CodeViewerProvider extends NavigatableComponentProviderAdapter model.setAllFunctionVariablesOpen(selected); } - private boolean isInFunctionArea(ProgramLocationActionContext context) { + private boolean isInFunctionVariablesArea(ProgramLocationActionContext context) { ProgramLocation location = context.getLocation(); - return location instanceof FunctionLocation || + return location instanceof VariableLocation || location instanceof VariablesOpenCloseLocation; } + private boolean isInCollapsableCodeArea(ProgramLocationActionContext context) { + ProgramLocation location = context.getLocation(); + + // this allows the code collapse to be toggled on instructions in the body of a function, + // but we have to exclude the variable locations so as to not interfere with the + // open/close variables action which also is mapped toActions for Opening/Closing Function Variables Display
In addition to the control widget in the display, there are also several actions that can be used to control the display of function variables.
-
- Show/Hide All Variables - This toggle +
- Show/Hide Variables - This action toggles + the display of the variables section for a function. If they are showing, they will be + hidden and if they hare hidden, they will be shown. The default keybinding is +
+Spaceso if you are on a function or variable, pressing the space bar will + toggle the display state.- Show Variables By Default - This toggle action can be used to globally control whether or not function variables are displayed. Individual functions can still be toggled on or off, but this sets the default for all functions.
-- Show/Hide Variables - This action toggles - the display of the variables. If they are showing, this will turn them off. And if they - are not showing, this action will turn them on. The default keybinding is -
+Spaceso if you are on a function or variable, pressing the space bar will - toggle the display state.
CollapsedCodeLocation is program location generated when the cursor is on a field
+ * representing code from a collapsed function.
+ */
+public class CollapsedCodeLocation extends ProgramLocation {
+
+ /**
+ * Create a new DividerLocation.
+ *
+ * @param program the program of the location
+ * @param addr address of bookmark
+ * by its hierarchy names; this parameter may be null
+ */
+ public CollapsedCodeLocation(Program program, Address addr) {
+ super(program, addr, addr, null, null, 0, 0, 0);
+ }
+
+ /**
+ * Default constructor needed for restoring
+ * a program location from XML
+ */
+ public CollapsedCodeLocation() {
+ }
+
+}
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/FunctionOpenCloseLocation.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/FunctionOpenCloseLocation.java
new file mode 100644
index 0000000000..f2eb641a7c
--- /dev/null
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/FunctionOpenCloseLocation.java
@@ -0,0 +1,41 @@
+/* ###
+ * 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.util;
+
+import ghidra.program.model.address.Address;
+import ghidra.program.model.listing.Program;
+
+/**
+ * ProgramLocation that represents the cursor being on the function's open/close widget
+ */
+public class FunctionOpenCloseLocation extends CodeUnitLocation {
+ /**
+ * Constructor
+ *
+ * @param program the program of the location
+ * @param addr address of the location
+ */
+ public FunctionOpenCloseLocation(Program program, Address addr) {
+ super(program, addr, null, 0, 0, 0);
+ }
+
+ /**
+ * Required constructor for serialization
+ */
+ public FunctionOpenCloseLocation() {
+
+ }
+}