ab6ba9bdbb
<!-- 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 Adds ability for app to change system context menu <!-- Please review the items on the PR checklist before submitting--> ## PR Checklist * [x] Closes #9666 * [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA * [ ] Tests added/passed * [ ] Documentation updated. If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/terminal) and link it here: #xxx * [ ] 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 <!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well --> ## Validation Steps Performed
218 lines
10 KiB
C++
218 lines
10 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#pragma once
|
|
|
|
#include "AppLogic.g.h"
|
|
#include "FindTargetWindowResult.g.h"
|
|
#include "SystemMenuChangeArgs.g.h"
|
|
#include "Jumplist.h"
|
|
#include "LanguageProfileNotifier.h"
|
|
#include "TerminalPage.h"
|
|
|
|
#include <inc/cppwinrt_utils.h>
|
|
#include <ThrottledFunc.h>
|
|
|
|
#ifdef UNIT_TESTING
|
|
// fwdecl unittest classes
|
|
namespace TerminalAppLocalTests
|
|
{
|
|
class CommandlineTest;
|
|
};
|
|
#endif
|
|
|
|
namespace winrt::TerminalApp::implementation
|
|
{
|
|
struct FindTargetWindowResult : FindTargetWindowResultT<FindTargetWindowResult>
|
|
{
|
|
WINRT_PROPERTY(int32_t, WindowId, -1);
|
|
WINRT_PROPERTY(winrt::hstring, WindowName, L"");
|
|
|
|
public:
|
|
FindTargetWindowResult(const int32_t id, const winrt::hstring& name) :
|
|
_WindowId{ id }, _WindowName{ name } {};
|
|
|
|
FindTargetWindowResult(const int32_t id) :
|
|
FindTargetWindowResult(id, L""){};
|
|
};
|
|
|
|
struct SystemMenuChangeArgs : SystemMenuChangeArgsT<SystemMenuChangeArgs>
|
|
{
|
|
WINRT_PROPERTY(winrt::hstring, Name, L"");
|
|
WINRT_PROPERTY(SystemMenuChangeAction, Action, SystemMenuChangeAction::Add);
|
|
WINRT_PROPERTY(SystemMenuItemHandler, Handler, nullptr);
|
|
|
|
public:
|
|
SystemMenuChangeArgs(const winrt::hstring& name, SystemMenuChangeAction action, SystemMenuItemHandler handler = nullptr) :
|
|
_Name{ name }, _Action{ action }, _Handler{ handler } {};
|
|
};
|
|
|
|
struct AppLogic : AppLogicT<AppLogic, IInitializeWithWindow>
|
|
{
|
|
public:
|
|
static AppLogic* Current() noexcept;
|
|
static const Microsoft::Terminal::Settings::Model::CascadiaSettings CurrentAppSettings();
|
|
|
|
AppLogic();
|
|
~AppLogic() = default;
|
|
|
|
STDMETHODIMP Initialize(HWND hwnd);
|
|
|
|
void Create();
|
|
bool IsUwp() const noexcept;
|
|
void RunAsUwp();
|
|
bool IsElevated() const noexcept;
|
|
void LoadSettings();
|
|
[[nodiscard]] Microsoft::Terminal::Settings::Model::CascadiaSettings GetSettings() const noexcept;
|
|
|
|
void Quit();
|
|
|
|
bool HasCommandlineArguments() const noexcept;
|
|
bool HasSettingsStartupActions() const noexcept;
|
|
int32_t SetStartupCommandline(array_view<const winrt::hstring> actions);
|
|
int32_t ExecuteCommandline(array_view<const winrt::hstring> actions, const winrt::hstring& cwd);
|
|
TerminalApp::FindTargetWindowResult FindTargetWindow(array_view<const winrt::hstring> actions);
|
|
winrt::hstring ParseCommandlineMessage();
|
|
bool ShouldExitEarly();
|
|
|
|
bool FocusMode() const;
|
|
bool Fullscreen() const;
|
|
bool AlwaysOnTop() const;
|
|
|
|
bool ShouldUsePersistedLayout();
|
|
hstring GetWindowLayoutJson(Microsoft::Terminal::Settings::Model::LaunchPosition position);
|
|
void SaveWindowLayoutJsons(const Windows::Foundation::Collections::IVector<hstring>& layouts);
|
|
void IdentifyWindow();
|
|
void RenameFailed();
|
|
winrt::hstring WindowName();
|
|
void WindowName(const winrt::hstring& name);
|
|
uint64_t WindowId();
|
|
void WindowId(const uint64_t& id);
|
|
void SetPersistedLayoutIdx(const uint32_t idx);
|
|
void SetNumberOfOpenWindows(const uint64_t num);
|
|
bool IsQuakeWindow() const noexcept;
|
|
|
|
Windows::Foundation::Size GetLaunchDimensions(uint32_t dpi);
|
|
bool CenterOnLaunch();
|
|
TerminalApp::InitialPosition GetInitialPosition(int64_t defaultInitialX, int64_t defaultInitialY);
|
|
winrt::Windows::UI::Xaml::ElementTheme GetRequestedTheme();
|
|
Microsoft::Terminal::Settings::Model::LaunchMode GetLaunchMode();
|
|
bool GetShowTabsInTitlebar();
|
|
bool GetInitialAlwaysOnTop();
|
|
float CalcSnappedDimension(const bool widthOrHeight, const float dimension) const;
|
|
|
|
Windows::UI::Xaml::UIElement GetRoot() noexcept;
|
|
|
|
void SetInboundListener();
|
|
|
|
hstring Title();
|
|
void TitlebarClicked();
|
|
bool OnDirectKeyEvent(const uint32_t vkey, const uint8_t scanCode, const bool down);
|
|
|
|
void CloseWindow(Microsoft::Terminal::Settings::Model::LaunchPosition position);
|
|
|
|
winrt::TerminalApp::TaskbarState TaskbarState();
|
|
|
|
bool GetMinimizeToNotificationArea();
|
|
bool GetAlwaysShowNotificationIcon();
|
|
bool GetShowTitleInTitlebar();
|
|
|
|
winrt::Windows::Foundation::IAsyncOperation<winrt::Windows::UI::Xaml::Controls::ContentDialogResult> ShowDialog(winrt::Windows::UI::Xaml::Controls::ContentDialog dialog);
|
|
void DismissDialog();
|
|
|
|
Windows::Foundation::Collections::IMapView<Microsoft::Terminal::Control::KeyChord, Microsoft::Terminal::Settings::Model::Command> GlobalHotkeys();
|
|
|
|
// -------------------------------- WinRT Events ---------------------------------
|
|
TYPED_EVENT(RequestedThemeChanged, winrt::Windows::Foundation::IInspectable, winrt::Windows::UI::Xaml::ElementTheme);
|
|
TYPED_EVENT(SettingsChanged, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable);
|
|
TYPED_EVENT(SystemMenuChangeRequested, winrt::Windows::Foundation::IInspectable, winrt::TerminalApp::SystemMenuChangeArgs);
|
|
|
|
private:
|
|
bool _isUwp{ false };
|
|
bool _isElevated{ false };
|
|
|
|
// If you add controls here, but forget to null them either here or in
|
|
// the ctor, you're going to have a bad time. It'll mysteriously fail to
|
|
// activate the AppLogic.
|
|
// ALSO: If you add any UIElements as roots here, make sure they're
|
|
// updated in _ApplyTheme. The root currently is _root.
|
|
winrt::com_ptr<TerminalPage> _root{ nullptr };
|
|
Microsoft::Terminal::Settings::Model::CascadiaSettings _settings{ nullptr };
|
|
|
|
winrt::hstring _settingsLoadExceptionText;
|
|
HRESULT _settingsLoadedResult = S_OK;
|
|
bool _loadedInitialSettings = false;
|
|
|
|
uint64_t _numOpenWindows{ 0 };
|
|
|
|
std::shared_mutex _dialogLock;
|
|
winrt::Windows::UI::Xaml::Controls::ContentDialog _dialog;
|
|
|
|
::TerminalApp::AppCommandlineArgs _appArgs;
|
|
::TerminalApp::AppCommandlineArgs _settingsAppArgs;
|
|
|
|
std::shared_ptr<ThrottledFuncTrailing<>> _reloadSettings;
|
|
til::throttled_func_trailing<> _reloadState;
|
|
|
|
// These fields invoke _reloadSettings and must be destroyed before _reloadSettings.
|
|
// (C++ destroys members in reverse-declaration-order.)
|
|
winrt::com_ptr<LanguageProfileNotifier> _languageProfileNotifier;
|
|
wil::unique_folder_change_reader_nothrow _reader;
|
|
|
|
static TerminalApp::FindTargetWindowResult _doFindTargetWindow(winrt::array_view<const hstring> args,
|
|
const Microsoft::Terminal::Settings::Model::WindowingMode& windowingBehavior);
|
|
|
|
void _ShowLoadErrorsDialog(const winrt::hstring& titleKey, const winrt::hstring& contentKey, HRESULT settingsLoadedResult);
|
|
void _ShowLoadWarningsDialog();
|
|
bool _IsKeyboardServiceEnabled();
|
|
|
|
void _ApplyLanguageSettingChange() noexcept;
|
|
void _RefreshThemeRoutine();
|
|
fire_and_forget _ApplyStartupTaskStateChange();
|
|
|
|
void _OnLoaded(const IInspectable& sender, const Windows::UI::Xaml::RoutedEventArgs& eventArgs);
|
|
|
|
[[nodiscard]] HRESULT _TryLoadSettings() noexcept;
|
|
void _RegisterSettingsChange();
|
|
fire_and_forget _DispatchReloadSettings();
|
|
void _ReloadSettings();
|
|
void _OpenSettingsUI();
|
|
|
|
void _ApplyTheme(const Windows::UI::Xaml::ElementTheme& newTheme);
|
|
|
|
bool _hasCommandLineArguments{ false };
|
|
bool _hasSettingsStartupActions{ false };
|
|
std::vector<Microsoft::Terminal::Settings::Model::SettingsLoadWarnings> _warnings;
|
|
|
|
// These are events that are handled by the TerminalPage, but are
|
|
// exposed through the AppLogic. This macro is used to forward the event
|
|
// directly to them.
|
|
FORWARDED_TYPED_EVENT(SetTitleBarContent, winrt::Windows::Foundation::IInspectable, winrt::Windows::UI::Xaml::UIElement, _root, SetTitleBarContent);
|
|
FORWARDED_TYPED_EVENT(TitleChanged, winrt::Windows::Foundation::IInspectable, winrt::hstring, _root, TitleChanged);
|
|
FORWARDED_TYPED_EVENT(LastTabClosed, winrt::Windows::Foundation::IInspectable, winrt::TerminalApp::LastTabClosedEventArgs, _root, LastTabClosed);
|
|
FORWARDED_TYPED_EVENT(FocusModeChanged, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable, _root, FocusModeChanged);
|
|
FORWARDED_TYPED_EVENT(FullscreenChanged, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable, _root, FullscreenChanged);
|
|
FORWARDED_TYPED_EVENT(AlwaysOnTopChanged, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable, _root, AlwaysOnTopChanged);
|
|
FORWARDED_TYPED_EVENT(RaiseVisualBell, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable, _root, RaiseVisualBell);
|
|
FORWARDED_TYPED_EVENT(SetTaskbarProgress, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable, _root, SetTaskbarProgress);
|
|
FORWARDED_TYPED_EVENT(IdentifyWindowsRequested, Windows::Foundation::IInspectable, Windows::Foundation::IInspectable, _root, IdentifyWindowsRequested);
|
|
FORWARDED_TYPED_EVENT(RenameWindowRequested, Windows::Foundation::IInspectable, winrt::TerminalApp::RenameWindowRequestedArgs, _root, RenameWindowRequested);
|
|
FORWARDED_TYPED_EVENT(IsQuakeWindowChanged, Windows::Foundation::IInspectable, Windows::Foundation::IInspectable, _root, IsQuakeWindowChanged);
|
|
FORWARDED_TYPED_EVENT(SummonWindowRequested, Windows::Foundation::IInspectable, Windows::Foundation::IInspectable, _root, SummonWindowRequested);
|
|
FORWARDED_TYPED_EVENT(CloseRequested, Windows::Foundation::IInspectable, Windows::Foundation::IInspectable, _root, CloseRequested);
|
|
FORWARDED_TYPED_EVENT(OpenSystemMenu, Windows::Foundation::IInspectable, Windows::Foundation::IInspectable, _root, OpenSystemMenu);
|
|
FORWARDED_TYPED_EVENT(QuitRequested, Windows::Foundation::IInspectable, Windows::Foundation::IInspectable, _root, QuitRequested);
|
|
|
|
#ifdef UNIT_TESTING
|
|
friend class TerminalAppLocalTests::CommandlineTest;
|
|
#endif
|
|
};
|
|
}
|
|
|
|
namespace winrt::TerminalApp::factory_implementation
|
|
{
|
|
struct AppLogic : AppLogicT<AppLogic, implementation::AppLogic>
|
|
{
|
|
};
|
|
}
|