9eb9bc9235
<!-- Enter a brief description/summary of your PR here. What does it fix/what does it change/how was it tested (even manually, if necessary)? --> ## Summary of the Pull Request Add functionality to move a pane to another tab. If the tab index is greater than the number of current tabs a new tab will be created with the pane as its root. Similarly, if the last pane on a tab is moved to another tab, the original tab will be closed. This is largely complete, but I know that I'm messing around with things that I am unfamiliar with, and would like to avoid footguns where possible. <!-- Other than the issue solved, is this relevant to any other issues/existing PRs? --> ## References #4587 <!-- Please review the items on the PR checklist before submitting--> ## PR Checklist * [x] Closes #7075 * [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA * [ ] Tests added/passed * [x] Documentation updated. If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/terminal) and link it here: #xxx * [x] Schema updated. * [ ] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx <!-- Provide a more detailed description of the PR, other things fixed or any additional comments/features here --> ## Detailed Description of the Pull Request / Additional comments Things done: - Moving a pane to a new tab appears to work. Moving a pane to an existing tab mostly works. Moving a pane back to its original tab appears to work. - Set up {Attach,Detach}Pane methods to add or remove a pane from a pane. Detach is slightly different than Close in that we want to persist the tree structure and terminal controls. - Add `Detached` event on a pane that can be subscribed to to remove other event handlers if desired. - Added simple WalkTree abstraction for one-off recursion use cases that calls a provided function on each pane in order (and optionally terminates early). - Fixed an in-prod bug with closing panes. Specifically, if you have a tree (1; 2 3) and close the 1 pane, then 3 will lose its borders because of these lines clearing the border on both children https://github.com/microsoft/terminal/blob/main/src/cascadia/TerminalApp/Pane.cpp#L1197-L1201 . To do: - Right now I have `TerminalTab` as a friend class of `Pane` so I can access some extra properties in my `WalkTree` callbacks, but there is probably a better choice for the abstraction boundary. Next Steps: - In a future PR Drag & Drop handlers could be added that utilize the Attach/Detach infrastructure to provide a better UI. - Similarly once this is working, it should be possible to convert an entire tab into a pane on an existing tab (Tab::DetachRoot on original tab followed by Tab::AttachPane on the target tab). - Its been 10 years, I just really want to use concepts already. <!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well --> ## Validation Steps Performed Manual testing by creating pane(s), and moving them between tabs and creating new tabs and destroying tabs by moving the last remaining pane.
149 lines
5.2 KiB
C++
149 lines
5.2 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
#pragma once
|
|
|
|
#include "Commandline.h"
|
|
|
|
#ifdef UNIT_TESTING
|
|
// fwdecl unittest classes
|
|
namespace TerminalAppLocalTests
|
|
{
|
|
class CommandlineTest;
|
|
};
|
|
#endif
|
|
|
|
namespace TerminalApp
|
|
{
|
|
class AppCommandlineArgs;
|
|
};
|
|
|
|
class TerminalApp::AppCommandlineArgs final
|
|
{
|
|
public:
|
|
static constexpr std::string_view NixHelpFlag{ "-?" };
|
|
static constexpr std::string_view WindowsHelpFlag{ "/?" };
|
|
static constexpr std::wstring_view PlaceholderExeName{ L"wt.exe" };
|
|
|
|
AppCommandlineArgs();
|
|
~AppCommandlineArgs() = default;
|
|
|
|
int ParseCommand(const Commandline& command);
|
|
int ParseArgs(winrt::array_view<const winrt::hstring>& args);
|
|
|
|
static std::vector<Commandline> BuildCommands(const std::vector<const wchar_t*>& args);
|
|
static std::vector<Commandline> BuildCommands(winrt::array_view<const winrt::hstring>& args);
|
|
|
|
void ValidateStartupCommands();
|
|
std::vector<winrt::Microsoft::Terminal::Settings::Model::ActionAndArgs>& GetStartupActions();
|
|
bool IsHandoffListener() const noexcept;
|
|
const std::string& GetExitMessage();
|
|
bool ShouldExitEarly() const noexcept;
|
|
|
|
std::optional<winrt::Microsoft::Terminal::Settings::Model::LaunchMode> GetLaunchMode() const noexcept;
|
|
|
|
int ParseArgs(const winrt::Microsoft::Terminal::Settings::Model::ExecuteCommandlineArgs& args);
|
|
void DisableHelpInExitMessage();
|
|
void FullResetState();
|
|
|
|
std::string_view GetTargetWindow() const noexcept;
|
|
|
|
private:
|
|
static const std::wregex _commandDelimiterRegex;
|
|
|
|
CLI::App _app{ "wt - the Windows Terminal" };
|
|
|
|
// This is a helper struct to encapsulate all the options for a subcommand
|
|
// that produces a NewTerminalArgs.
|
|
struct NewTerminalSubcommand
|
|
{
|
|
CLI::App* subcommand;
|
|
CLI::Option* commandlineOption;
|
|
CLI::Option* profileNameOption;
|
|
CLI::Option* startingDirectoryOption;
|
|
CLI::Option* titleOption;
|
|
CLI::Option* tabColorOption;
|
|
CLI::Option* suppressApplicationTitleOption;
|
|
CLI::Option* colorSchemeOption;
|
|
};
|
|
|
|
struct NewPaneSubcommand : public NewTerminalSubcommand
|
|
{
|
|
CLI::Option* _horizontalOption;
|
|
CLI::Option* _verticalOption;
|
|
CLI::Option* _duplicateOption;
|
|
};
|
|
|
|
// --- Subcommands ---
|
|
NewTerminalSubcommand _newTabCommand;
|
|
NewTerminalSubcommand _newTabShort;
|
|
NewPaneSubcommand _newPaneCommand;
|
|
NewPaneSubcommand _newPaneShort;
|
|
CLI::App* _focusTabCommand;
|
|
CLI::App* _focusTabShort;
|
|
CLI::App* _moveFocusCommand;
|
|
CLI::App* _moveFocusShort;
|
|
CLI::App* _movePaneCommand;
|
|
CLI::App* _movePaneShort;
|
|
CLI::App* _swapPaneCommand;
|
|
CLI::App* _focusPaneCommand;
|
|
CLI::App* _focusPaneShort;
|
|
|
|
// Are you adding a new sub-command? Make sure to update _noCommandsProvided!
|
|
|
|
std::string _profileName;
|
|
std::string _startingDirectory;
|
|
std::string _startingTitle;
|
|
std::string _startingTabColor;
|
|
std::string _startingColorScheme;
|
|
bool _suppressApplicationTitle{ false };
|
|
|
|
winrt::Microsoft::Terminal::Settings::Model::FocusDirection _moveFocusDirection{ winrt::Microsoft::Terminal::Settings::Model::FocusDirection::None };
|
|
winrt::Microsoft::Terminal::Settings::Model::FocusDirection _swapPaneDirection{ winrt::Microsoft::Terminal::Settings::Model::FocusDirection::None };
|
|
|
|
// _commandline will contain the command line with which we'll be spawning a new terminal
|
|
std::vector<std::string> _commandline;
|
|
|
|
bool _splitVertical{ false };
|
|
bool _splitHorizontal{ false };
|
|
bool _splitDuplicate{ false };
|
|
float _splitPaneSize{ 0.5f };
|
|
|
|
int _movePaneTabIndex{ -1 };
|
|
int _focusTabIndex{ -1 };
|
|
bool _focusNextTab{ false };
|
|
bool _focusPrevTab{ false };
|
|
|
|
int _focusPaneTarget{ -1 };
|
|
// Are you adding more args here? Make sure to reset them in _resetStateToDefault
|
|
|
|
const Commandline* _currentCommandline{ nullptr };
|
|
std::optional<winrt::Microsoft::Terminal::Settings::Model::LaunchMode> _launchMode{ std::nullopt };
|
|
bool _isHandoffListener{ false };
|
|
std::vector<winrt::Microsoft::Terminal::Settings::Model::ActionAndArgs> _startupActions;
|
|
std::string _exitMessage;
|
|
bool _shouldExitEarly{ false };
|
|
|
|
std::string _windowTarget{};
|
|
// Are you adding more args or attributes here? If they are not reset in _resetStateToDefault, make sure to reset them in FullResetState
|
|
|
|
winrt::Microsoft::Terminal::Settings::Model::NewTerminalArgs _getNewTerminalArgs(NewTerminalSubcommand& subcommand);
|
|
void _addNewTerminalArgs(NewTerminalSubcommand& subcommand);
|
|
void _buildParser();
|
|
void _buildNewTabParser();
|
|
void _buildSplitPaneParser();
|
|
void _buildFocusTabParser();
|
|
void _buildMoveFocusParser();
|
|
void _buildMovePaneParser();
|
|
void _buildSwapPaneParser();
|
|
void _buildFocusPaneParser();
|
|
bool _noCommandsProvided();
|
|
void _resetStateToDefault();
|
|
int _handleExit(const CLI::App& command, const CLI::Error& e);
|
|
|
|
static void _addCommandsForArg(std::vector<Commandline>& commands, std::wstring_view arg);
|
|
|
|
#ifdef UNIT_TESTING
|
|
friend class TerminalAppLocalTests::CommandlineTest;
|
|
#endif
|
|
};
|