yetangitu/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2025-10-04 10:19:23 +02:00
Code Issues Releases Wiki Activity

GT-2869 - Key Bindings - review fixes

Browse source
This commit is contained in:
dragonmacher 2019-06-06 18:59:27 -04:00
parent 43fa7e3f92
commit 2de5c40cd6
23 changed files with 142 additions and 455 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/PluginConfigurationModel.java
View file

@ -218,7 +218,7 @@ public class PluginConfigurationModel {
return Collections.emptySet();
}
return KeyBindingUtils.getKeyBindingActions(tool, pluginDescription.getName());
return KeyBindingUtils.getKeyBindingActionsForOwner(tool, pluginDescription.getName());
}
/**

4
Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/PluginTool.java
View file

@ -33,7 +33,7 @@ import org.jdom.Element;
import docking.*;
import docking.action.*;
import docking.actions.DockingToolActionManager;
import docking.actions.ToolActions;
import docking.framework.AboutDialog;
import docking.framework.ApplicationInformationDisplayFactory;
import docking.framework.SplashScreen;
@ -158,7 +158,7 @@ public abstract class PluginTool extends AbstractDockingTool
eventMgr = new EventManager(this);
serviceMgr = new ServiceManager();
installServices();
actionMgr = new DockingToolActionManager(this, winMgr);
actionMgr = new ToolActions(this, winMgr);
pluginMgr = new PluginManager(this, serviceMgr);
dialogMgr = new DialogManager(this);
initActions();

2
Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/dialog/KeyBindingsPanel.java
View file

@ -171,7 +171,7 @@ public class KeyBindingsPanel extends JPanel {
originalValues = new HashMap<>();
String longestName = "";
actionsByFullName = KeyBindingUtils.getAllKeyBindingActions(tool);
actionsByFullName = KeyBindingUtils.getAllKeyBindingActionsByFullName(tool);
Set<Entry<String, DockingActionIf>> entries = actionsByFullName.entrySet();
for (Entry<String, DockingActionIf> entry : entries) {

299
Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/mgr/ProjectActionManager.java
View file

@ -1,299 +0,0 @@
/* ###
* 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.framework.plugintool.mgr;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.util.*;
import javax.swing.KeyStroke;
import docking.*;
import docking.action.*;
import docking.tool.util.DockingToolConstants;
import ghidra.framework.options.OptionType;
import ghidra.framework.options.Options;
import ghidra.framework.plugintool.PluginTool;
import ghidra.util.exception.AssertException;
/**
* Helper class to manage plugin actions for the tool.
*/
public class ProjectActionManager implements PropertyChangeListener {
private DockingWindowManager winMgr;
private DockingWindowManagerActionUpdater winMgrActionUpdater;
// TODO
// TODO
// TODO does this class need the shared action concept (probably not)
// TODO
// TODO
private Map<String, List<DockingActionIf>> actionMap;
private Options keyBindingOptions;
private PluginTool tool;
/**
* Construct an ActionManager
* @param tool plugin tool using this ActionManager
* @param winMgr manager of the "Docking" arrangement
* of a set of components and actions in the tool
*/
public ProjectActionManager(PluginTool tool, DockingWindowManager winMgr) {
this.tool = tool;
this.winMgr = winMgr;
this.winMgrActionUpdater = new DockingWindowManagerActionUpdater(winMgr);
actionMap = new HashMap<>();
keyBindingOptions = tool.getOptions(DockingToolConstants.KEY_BINDINGS);
}
public void dispose() {
actionMap.clear();
}
private void addActionToMap(DockingActionIf action) {
String name = action.getFullName();
List<DockingActionIf> actionList = actionMap.get(name);
if (actionList == null) {
List<DockingActionIf> newList = new ArrayList<>();
newList.add(action);
actionMap.put(name, newList);
}
else {
actionList.add(action);
}
}
private void removeActionFromMap(DockingActionIf action) {
String name = action.getFullName();
List<DockingActionIf> actionList = actionMap.get(name);
if (actionList == null) {
return;
}
if (actionList.remove(action) && actionList.isEmpty()) {
actionMap.remove(name);
}
}
/**
* Adds the action to the tool.
* @param action the action to be added.
*/
public synchronized void addToolAction(DockingActionIf action) {
action.addPropertyChangeListener(this);
addActionToMap(action);
if (action.isKeyBindingManaged()) {
KeyStroke ks = action.getKeyBinding();
keyBindingOptions.registerOption(action.getFullName(), OptionType.KEYSTROKE_TYPE, ks,
null, null);
KeyStroke newKs = keyBindingOptions.getKeyStroke(action.getFullName(), ks);
if (ks != newKs) {
action.setUnvalidatedKeyBindingData(new KeyBindingData(newKs));
}
}
winMgrActionUpdater.addToolAction(action);
}
/**
* Removes the given action from the tool
* @param action the action to be removed.
*/
public synchronized void removeToolAction(DockingActionIf action) {
action.removePropertyChangeListener(this);
removeActionFromMap(action);
winMgrActionUpdater.removeToolAction(action);
}
/**
* Remove all actions that have the given owner.
* @param owner owner of the actions to remove
*/
public synchronized void removeToolActions(String owner) {
List<DockingActionIf> actions = getActions(owner);
for (DockingActionIf action : actions) {
removeToolAction(action);
}
}
/**
* Add an action that works specifically with a component provider.
* @param provider provider associated with the action
* @param action local action to the provider
*/
public synchronized void addLocalAction(ComponentProvider provider, DockingActionIf action) {
checkForAlreadyAddedAction(provider, action);
action.addPropertyChangeListener(this);
addActionToMap(action);
if (action.isKeyBindingManaged()) {
KeyStroke ks = action.getKeyBinding();
keyBindingOptions.registerOption(action.getFullName(), OptionType.KEYSTROKE_TYPE, ks,
null, null);
KeyStroke newKs = keyBindingOptions.getKeyStroke(action.getFullName(), ks);
if (ks != newKs) {
action.setUnvalidatedKeyBindingData(new KeyBindingData(newKs));
}
}
winMgrActionUpdater.addLocalAction(provider, action);
}
private void checkForAlreadyAddedAction(ComponentProvider provider, DockingActionIf action) {
String name = action.getFullName();
List<DockingActionIf> actionList = actionMap.get(name);
if (actionList == null) {
return;
}
if (actionList.contains(action)) {
throw new AssertException("Cannot add the same action more than once. Provider " +
provider.getName() + " - action: " + name);
}
}
/**
* Remove an action that works specifically with a component provider.
* @param provider provider associated with the action
* @param action local action to the provider
*/
public synchronized void removeProviderAction(ComponentProvider provider,
DockingActionIf action) {
action.removePropertyChangeListener(this);
removeActionFromMap(action);
winMgr.removeProviderAction(provider, action);
}
// TODO delete me
/**
* Get all actions that have the action name which includes the action owner's name.
*
* @param fullName full name for the action, e.g., "My Action (My Plugin)"
* @return list of actions; empty if no action exists with the given name
*/
public List<DockingActionIf> getDockingActionsByFullActionName(String fullName) {
List<DockingActionIf> list = actionMap.get(fullName);
if (list == null) {
return new ArrayList<>();
}
return new ArrayList<>(list);
}
/**
* Returns a list of actions whose owner matches the given owner or all actions if the given
* owner is null.
* <p>
* This method will only return a single instance of any named action, even if multiple
* actions have been registered with the same name.
* <p>
* Note: Actions with the same name are assumed to be different instances of the same action.
*
* @param owner The of the action, or null to get all actions
* @return a list of deduped actions.
*/
private List<DockingActionIf> getUniqueActionList(String owner) {
List<DockingActionIf> matchingActionList = new ArrayList<>();
for (List<DockingActionIf> actionList : actionMap.values()) {
// we only want *one* instance of duplicate actions
DockingActionIf action = actionList.get(0);
if (owner == null || action.getOwner().equals(owner)) {
matchingActionList.add(action);
}
}
return matchingActionList;
}
/**
* Get all actions for the given owner.
* @param owner owner of the actions
* @return array of actions; zero length array is returned if no
* action exists with the given name
*/
public synchronized List<DockingActionIf> getActions(String owner) {
List<DockingActionIf> list = getUniqueActionList(owner);
return list;
}
/**
* Get a list of all actions in the tool.
* @return list of PluginAction objects
*/
public List<DockingActionIf> getAllActions() {
return getUniqueActionList(null);
}
/**
* Get the keybindings for each action so that they are still registered
* as being used; otherwise the options will be removed because they
* are noted as not being used.
*
*/
public synchronized void restoreKeyBindings() {
keyBindingOptions = tool.getOptions(DockingToolConstants.KEY_BINDINGS);
List<DockingActionIf> actions = getAllActions();
for (DockingActionIf action : actions) {
if (!action.isKeyBindingManaged()) {
continue;
}
KeyStroke ks = action.getKeyBinding();
KeyStroke newKs = keyBindingOptions.getKeyStroke(action.getFullName(), ks);
if (ks != newKs) {
action.setUnvalidatedKeyBindingData(new KeyBindingData(newKs));
}
}
}
/**
* Get the actions for the given provider and remove them from the
* actionMap; call the window manager to remove the provider.
* @param provider provider to be removed
*/
public void removeComponent(ComponentProvider provider) {
Iterator<DockingActionIf> iterator = winMgr.getComponentActions(provider);
while (iterator.hasNext()) {
DockingActionIf action = iterator.next();
String name = action.getFullName();
List<DockingActionIf> actionList = actionMap.get(name);
if (actionList != null && actionList.remove(action) && actionList.isEmpty()) {
actionMap.remove(name);
}
}
winMgr.removeComponent(provider);
}
@Override
public void propertyChange(PropertyChangeEvent evt) {
if (evt.getPropertyName().equals(DockingActionIf.KEYBINDING_DATA_PROPERTY)) {
DockingAction action = (DockingAction) evt.getSource();
if (!action.isKeyBindingManaged()) {
tool.setConfigChanged(true);
return;
}
KeyBindingData keyBindingData = (KeyBindingData) evt.getNewValue();
KeyStroke newKeyStroke = keyBindingData.getKeyBinding();
Options opt = tool.getOptions(DockingToolConstants.KEY_BINDINGS);
KeyStroke optKeyStroke = opt.getKeyStroke(action.getFullName(), null);
if (newKeyStroke == null) {
opt.removeOption(action.getFullName());
}
else if (!newKeyStroke.equals(optKeyStroke)) {
opt.setKeyStroke(action.getFullName(), newKeyStroke);
tool.setConfigChanged(true);
}
}
}
}