Refactor ActionMap and Command to use ActionIDs #17162
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
PankajBhojwani
commented
Apr 30, 2024
| { | ||
| if (cmd.ActionAndArgs().Action() != ShortcutAction::Invalid) | ||
| // Only populate AvailableActions with actions that haven't been visited already. | ||
| const auto actionID = Hash(cmd.ActionAndArgs()); |
There was a problem hiding this comment.
Unfortunately we still have to use InternalActionID to populate the available action dropdown in the SUI since we don't have a Terminal.<> id for every configuration of each shortcut action and its args
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
This comment has been minimized.
This comment has been minimized.
4 tasks
lhecker
reviewed
May 17, 2024
Comment on lines
+128
to
+133
| auto toJson = [&keybindingsList](const KeyChord kc, const winrt::hstring cmdID) { | ||
| Json::Value keyIDPair{ Json::ValueType::objectValue }; | ||
| JsonUtils::SetValueForKey(keyIDPair, KeysKey, kc); | ||
| JsonUtils::SetValueForKey(keyIDPair, IDKey, cmdID); | ||
| keybindingsList.append(keyIDPair); | ||
| }; |
| { | ||
| warnings.push_back(SettingsLoadWarnings::TooManyKeysForChord); | ||
| } | ||
| else |
There was a problem hiding this comment.
Early-return and unnest the rest?
| { | ||
| Control::KeyChord keys{ nullptr }; | ||
| winrt::hstring idJson; | ||
| if (JsonUtils::GetValueForKey(json, KeysKey, keys)) |
| _KeyMap.insert_or_assign(keys, idJson); | ||
|
|
||
| // make sure the command registers these keys | ||
| if (!idJson.empty()) |
| else | ||
| { | ||
| // this is not a command block, so it is a keybinding block | ||
| _AddKeyBindingHelper(jsonBlock, warnings); |
There was a problem hiding this comment.
If you invert the if condition, you can flip the branches and use continue here. It would still make sense that way IMO, because it would read "if it has no commands and no actions, then add an error and continue".
| const auto parentActions{ parent->_GetCumulativeActions() }; | ||
| cumulativeActions.reserve(cumulativeActions.size() + parentActions.size()); | ||
| cumulativeActions.insert(cumulativeActions.end(), parentActions.begin(), parentActions.end()); | ||
| if (actionMap.find(cmdID) == actionMap.end()) |
| } | ||
|
|
||
| return cumulativeActions; | ||
| for (const auto parent : _parents) |
|
|
||
| for (const auto& [keys, cmd] : keyBindingsMap) | ||
| for (const auto [keys, cmdID] : accumulatedKeybindingsMap) |
Comment on lines
+579
to
586
| if (cmd.ActionAndArgs().Action() == ShortcutAction::Invalid) | ||
| { | ||
| // Update inner Command with new key chord | ||
| auto oldCmdImpl{ get_self<Command>(oldCmd) }; | ||
| oldCmdImpl->RegisterKey(keys); | ||
| _KeyMap.insert_or_assign(keys, L""); | ||
| } | ||
|
|
||
| // Additive operation: | ||
| // Register the new key chord with maskingCmd (an existing _maskingAction entry) | ||
| // Example: | ||
| // parent: { "command": "copy", "keys": "ctrl+c" } --> register "ctrl+c" to parent._ActionMap (different branch in a different layer) | ||
| // current: { "command": "copy", "keys": "ctrl+shift+c" } --> also register "ctrl+shift+c" to the same Command (maskingCmd) | ||
| if (maskingCmd) | ||
| else | ||
| { | ||
| // Update inner Command with new key chord | ||
| auto maskingCmdImpl{ get_self<Command>(maskingCmd) }; | ||
| maskingCmdImpl->RegisterKey(keys); | ||
| _KeyMap.insert_or_assign(keys, cmd.ID()); | ||
| } |
There was a problem hiding this comment.
This could be something like
hstring id;
if (cmd.ActionAndArgs().Action() == ShortcutAction::Invalid)
{
id = cmd.ID();
}
_KeyMap.insert_or_assign(keys, id);or
const auto action = cmd.ActionAndArgs().Action();
const auto id = action == ShortcutAction::Invalid ? hstring{} : cmd.ID();
_KeyMap.insert_or_assign(keys, id);I'm not sure I understand why we want to store an empty string in the map for invalid actions though. Shouldn't we want to remove the key entirely?
Comment on lines
+629
to
+637
| if (const auto cmdID = keyIDPair->second; !cmdID.empty()) | ||
| { | ||
| return cmdID; | ||
| } | ||
| else | ||
| { | ||
| // the keychord is defined in this layer, but points to an empty string - explicitly unbound | ||
| return L""; | ||
| } |
There was a problem hiding this comment.
That's basically the same as just return keyIDPair->second.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of the Pull Request
As outlined in #16816, refactor
ActionMapto use the new action IDs added in #16904Detailed description of the pull request
See the spec!
Validation steps performed
References and Relevant Issues
#16816
PR Checklist