-
Notifications
You must be signed in to change notification settings - Fork 8.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add ability to save input action from command line #16513
Changes from 14 commits
83e3b8c
dd46338
8bec5ec
eec4f6b
e54b4a4
03f57ac
e0b0477
0ad6296
d4eaec3
50baa7b
addf247
49a74c8
cf56a9a
3f15d6e
2bf8391
f5ceac9
d6873c1
cd13fc3
8377749
452bfce
6c79af0
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -1264,6 +1264,54 @@ namespace winrt::TerminalApp::implementation | |||||
} | ||||||
} | ||||||
|
||||||
void TerminalPage::_HandleSaveTask(const IInspectable& /*sender*/, | ||||||
const ActionEventArgs& args) | ||||||
{ | ||||||
if (Feature_SaveTask::IsEnabled()) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oh also:
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Updated. |
||||||
{ | ||||||
if (args) | ||||||
{ | ||||||
if (const auto& realArgs = args.ActionArgs().try_as<SaveTaskArgs>()) | ||||||
{ | ||||||
if (realArgs.Commandline().empty()) | ||||||
{ | ||||||
if (const auto termControl{ _GetActiveControl() }) | ||||||
{ | ||||||
if (termControl.HasSelection()) | ||||||
{ | ||||||
const auto selections{ termControl.SelectedText(true) }; | ||||||
const auto selection = std::accumulate(selections.begin(), selections.end(), std::wstring()); | ||||||
realArgs.Commandline(selection); | ||||||
} | ||||||
} | ||||||
} | ||||||
|
||||||
try | ||||||
{ | ||||||
winrt::Microsoft::Terminal::Control::KeyChord keyChord = nullptr; | ||||||
if (!realArgs.KeyChord().empty()) | ||||||
{ | ||||||
keyChord = KeyChordSerialization::FromString(winrt::to_hstring(realArgs.KeyChord())); | ||||||
} | ||||||
_settings.GlobalSettings().ActionMap().AddSendInputAction(realArgs.Name(), realArgs.Commandline(), keyChord); | ||||||
_settings.WriteSettingsToDisk(); | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ❌ You might be able to just do a auto saveSettings = [settings=_settings]() -> winrt::fire_and_forget {
co_await winrt::resume_background();
settings.WriteSettingsToDisk();
};
saveSettings(); to basically make a lambda that does the fire_and_forget thing, but then also just call it immediately. I haven't tested it, so I'm sure there's spooky coroutine reasons that's a bad idea, but 🤷 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also now that I'm looking at it, the Settings UI itself saves the settings on the UI thread! Egads! I don't think it's worth blocking you over this if we can't even do it right There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I gave this a try just so I could get a better understanding of how the fire_and_forget stuff works. It looked like it worked, the settings were saved to the file, and I was able to see it switch from the window thread to the background thread in the debugger when it did the write to disk. In the debugger I started getting a AV. Adding a strong ref to settings seemed to prevent that. auto saveSettings = [settings = _settings]() -> winrt::fire_and_forget {
const auto strongSettings = settings;
co_await winrt::resume_background();
strongSettings.WriteSettingsToDisk();
};
saveSettings(); |
||||||
ActionSaved(realArgs.Commandline(), realArgs.Name(), realArgs.KeyChord()); | ||||||
} | ||||||
catch (const winrt::hresult_error& ex) | ||||||
{ | ||||||
auto code = ex.code(); | ||||||
auto message = ex.message(); | ||||||
ActionSaveFailed(message); | ||||||
args.Handled(true); | ||||||
return; | ||||||
} | ||||||
|
||||||
args.Handled(true); | ||||||
} | ||||||
} | ||||||
} | ||||||
} | ||||||
|
||||||
void TerminalPage::_HandleSelectCommand(const IInspectable& /*sender*/, | ||||||
const ActionEventArgs& args) | ||||||
{ | ||||||
|
Original file line number | Diff line number | Diff line change | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
@@ -209,6 +209,7 @@ void AppCommandlineArgs::_buildParser() | |||||||||
_buildMovePaneParser(); | ||||||||||
_buildSwapPaneParser(); | ||||||||||
_buildFocusPaneParser(); | ||||||||||
_buildSaveParser(); | ||||||||||
} | ||||||||||
|
||||||||||
// Method Description: | ||||||||||
|
@@ -537,6 +538,72 @@ void AppCommandlineArgs::_buildFocusPaneParser() | |||||||||
setupSubcommand(_focusPaneShort); | ||||||||||
} | ||||||||||
|
||||||||||
void AppCommandlineArgs::_buildSaveParser() | ||||||||||
{ | ||||||||||
_saveCommand = _app.add_subcommand("x-save", RS_A(L"SaveActionDesc")); | ||||||||||
|
||||||||||
auto setupSubcommand = [this](auto* subcommand) { | ||||||||||
subcommand->add_option("--name,-n", _saveInputName, RS_A(L"SaveActionArgDesc")); | ||||||||||
subcommand->add_option("--keychord,-k", _keyChordOption, RS_A(L"KeyChordArgDesc")); | ||||||||||
subcommand->add_option("command,", _commandline, RS_A(L"CmdCommandArgDesc")); | ||||||||||
subcommand->positionals_at_end(true); | ||||||||||
|
||||||||||
// When ParseCommand is called, if this subcommand was provided, this | ||||||||||
// callback function will be triggered on the same thread. We can be sure | ||||||||||
// that `this` will still be safe - this function just lets us know this | ||||||||||
// command was parsed. | ||||||||||
subcommand->callback([&, this]() { | ||||||||||
// Build the NewTab action from the values we've parsed on the commandline. | ||||||||||
ActionAndArgs saveAction{}; | ||||||||||
saveAction.Action(ShortcutAction::SaveTask); | ||||||||||
// _getNewTerminalArgs MUST be called before parsing any other options, | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. a bit of copypasta here 😅 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Updated to be slightly more generic. // Build the action from the values we've parsed on the commandline. Does this make sense or should I just remove it? |
||||||||||
// as it might clear those options while finding the commandline | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Updated to suggestion inside of commit 2bf8391 |
||||||||||
SaveTaskArgs args{}; | ||||||||||
|
||||||||||
if (!_commandline.empty()) | ||||||||||
{ | ||||||||||
std::ostringstream cmdlineBuffer; | ||||||||||
|
||||||||||
for (const auto& arg : _commandline) | ||||||||||
{ | ||||||||||
if (cmdlineBuffer.tellp() != 0) | ||||||||||
{ | ||||||||||
// If there's already something in here, prepend a space | ||||||||||
cmdlineBuffer << ' '; | ||||||||||
} | ||||||||||
|
||||||||||
if (arg.find(" ") != std::string::npos) | ||||||||||
{ | ||||||||||
cmdlineBuffer << '"' << arg << '"'; | ||||||||||
} | ||||||||||
else | ||||||||||
{ | ||||||||||
cmdlineBuffer << arg; | ||||||||||
} | ||||||||||
} | ||||||||||
|
||||||||||
args.Commandline(winrt::to_hstring(cmdlineBuffer.str())); | ||||||||||
} | ||||||||||
|
||||||||||
if (!_keyChordOption.empty()) | ||||||||||
{ | ||||||||||
args.KeyChord(winrt::to_hstring(_keyChordOption)); | ||||||||||
} | ||||||||||
|
||||||||||
if (!_saveInputName.empty()) | ||||||||||
{ | ||||||||||
winrt::hstring hString = winrt::to_hstring(_saveInputName); | ||||||||||
args.Name(hString); | ||||||||||
} | ||||||||||
|
||||||||||
saveAction.Args(args); | ||||||||||
_startupActions.push_back(saveAction); | ||||||||||
}); | ||||||||||
}; | ||||||||||
|
||||||||||
setupSubcommand(_saveCommand); | ||||||||||
} | ||||||||||
|
||||||||||
// Method Description: | ||||||||||
// - Add the `NewTerminalArgs` parameters to the given subcommand. This enables | ||||||||||
// that subcommand to support all the properties in a NewTerminalArgs. | ||||||||||
|
@@ -710,7 +777,8 @@ bool AppCommandlineArgs::_noCommandsProvided() | |||||||||
*_focusPaneCommand || | ||||||||||
*_focusPaneShort || | ||||||||||
*_newPaneShort.subcommand || | ||||||||||
*_newPaneCommand.subcommand); | ||||||||||
*_newPaneCommand.subcommand || | ||||||||||
*_saveCommand); | ||||||||||
} | ||||||||||
|
||||||||||
// Method Description: | ||||||||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4113,6 +4113,66 @@ namespace winrt::TerminalApp::implementation | |
} | ||
} | ||
|
||
winrt::fire_and_forget TerminalPage::ActionSaved(winrt::hstring input, winrt::hstring name, winrt::hstring keyChord) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why put these two functions here instead of having them next to the related code inside There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. updated |
||
{ | ||
auto weakThis{ get_weak() }; | ||
co_await wil::resume_foreground(Dispatcher()); | ||
if (auto page{ weakThis.get() }) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Does this code get called from a background thread? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. you are right, It was not running on a background thread, before and after the co_await it was on the Window thread. Updated to just use void and removed the co_await. |
||
{ | ||
// If we haven't ever loaded the TeachingTip, then do so now and | ||
// create the toast for it. | ||
if (page->_actionSavedToast == nullptr) | ||
{ | ||
if (auto tip{ page->FindName(L"ActionSavedToast").try_as<MUX::Controls::TeachingTip>() }) | ||
{ | ||
page->_actionSavedToast = std::make_shared<Toast>(tip); | ||
// Make sure to use the weak ref when setting up this | ||
// callback. | ||
tip.Closed({ page->get_weak(), &TerminalPage::_FocusActiveControl }); | ||
} | ||
} | ||
_UpdateTeachingTipTheme(ActionSavedToast().try_as<winrt::Windows::UI::Xaml::FrameworkElement>()); | ||
|
||
SavedActionName(name); | ||
SavedActionKeyChord(keyChord); | ||
SavedActionCommandLine(input); | ||
|
||
if (page->_actionSavedToast != nullptr) | ||
{ | ||
page->_actionSavedToast->Open(); | ||
} | ||
} | ||
} | ||
|
||
winrt::fire_and_forget TerminalPage::ActionSaveFailed(winrt::hstring message) | ||
{ | ||
auto weakThis{ get_weak() }; | ||
co_await wil::resume_foreground(Dispatcher()); | ||
if (auto page{ weakThis.get() }) | ||
{ | ||
// If we haven't ever loaded the TeachingTip, then do so now and | ||
// create the toast for it. | ||
if (page->_actionSaveFailedToast == nullptr) | ||
{ | ||
if (auto tip{ page->FindName(L"ActionSaveFailedToast").try_as<MUX::Controls::TeachingTip>() }) | ||
{ | ||
page->_actionSaveFailedToast = std::make_shared<Toast>(tip); | ||
// Make sure to use the weak ref when setting up this | ||
// callback. | ||
tip.Closed({ page->get_weak(), &TerminalPage::_FocusActiveControl }); | ||
} | ||
} | ||
_UpdateTeachingTipTheme(ActionSaveFailedToast().try_as<winrt::Windows::UI::Xaml::FrameworkElement>()); | ||
|
||
ActionSaveFailedMessage().Text(message); | ||
|
||
if (page->_actionSaveFailedToast != nullptr) | ||
{ | ||
page->_actionSaveFailedToast->Open(); | ||
} | ||
} | ||
} | ||
|
||
// Method Description: | ||
// - Called when an attempt to rename the window has failed. This will open | ||
// the toast displaying a message to the user that the attempt to rename | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,6 +8,7 @@ | |
xmlns:d="http://schemas.microsoft.com/expression/blend/2008" | ||
xmlns:local="using:TerminalApp" | ||
xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" | ||
xmlns:mtu="using:Microsoft.Terminal.UI" | ||
xmlns:mux="using:Microsoft.UI.Xaml.Controls" | ||
Background="Transparent" | ||
mc:Ignorable="d"> | ||
|
@@ -204,5 +205,43 @@ | |
Title="{x:Bind WindowProperties.VirtualWorkingDirectory, Mode=OneWay}" | ||
x:Load="False" | ||
IsLightDismissEnabled="True" /> | ||
|
||
<mux:TeachingTip x:Name="ActionSavedToast" | ||
x:Uid="ActionSavedToast" | ||
Title="Action Saved" | ||
HorizontalAlignment="Stretch" | ||
x:Load="False" | ||
IsLightDismissEnabled="True"> | ||
<mux:TeachingTip.Content> | ||
<StackPanel HorizontalAlignment="Stretch" | ||
Orientation="Vertical"> | ||
<TextBlock x:Name="ActionSavedNameText" | ||
Visibility="{x:Bind mtu:Converters.StringNotEmptyToVisibility(SavedActionName), Mode=OneWay}"> | ||
<Run Text="Name: " /> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝: I think I'm fine with these not being localized, since they're literal params to the action args, and we've got precedent for that in the cmdpal already |
||
<Run Text="{x:Bind SavedActionName, Mode=OneWay}" /> | ||
</TextBlock> | ||
<TextBlock x:Name="ActionSavedKeyChordText" | ||
Visibility="{x:Bind mtu:Converters.StringNotEmptyToVisibility(SavedActionKeyChord), Mode=OneWay}"> | ||
<Run Text="Key Chord: " /> | ||
<Run Text="{x:Bind SavedActionKeyChord, Mode=OneWay}" /> | ||
</TextBlock> | ||
<TextBlock x:Name="ActionSavedCommandLineText" | ||
Visibility="{x:Bind mtu:Converters.StringNotEmptyToVisibility(SavedActionCommandLine), Mode=OneWay}"> | ||
<Run Text="Input: " /> | ||
<Run Text="{x:Bind SavedActionCommandLine, Mode=OneWay}" /> | ||
</TextBlock> | ||
</StackPanel> | ||
</mux:TeachingTip.Content> | ||
</mux:TeachingTip> | ||
<mux:TeachingTip x:Name="ActionSaveFailedToast" | ||
x:Uid="ActionSaveFailedToast" | ||
Title="Action Save Failed" | ||
x:Load="False" | ||
IsLightDismissEnabled="True"> | ||
<mux:TeachingTip.Content> | ||
<TextBlock x:Name="ActionSaveFailedMessage" | ||
Text="" /> | ||
</mux:TeachingTip.Content> | ||
</mux:TeachingTip> | ||
</Grid> | ||
</Page> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO I'd just do an early-return if the feature isn't enabled, but I'm not sure if that messes with the compiler's ability to just optimize the entire rest of the function out
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated to early return. (Is there a way to tell if the compiler will struggle with this?)