fc8fff17db
<!-- 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 This PR adds a new boolean global setting, startOnUserLogin, along with associated AppLogic to request enabling or disabling of the StartupTask. Added UAP5 extensions to AppX manifests. <!-- Other than the issue solved, is this relevant to any other issues/existing PRs? --> ## References #2189 <!-- Please review the items on the PR checklist before submitting--> ## PR Checklist * [x] Closes #2189 * [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA * [x] Tests added/passed * [x] Requires documentation to be updated * [x] 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: #2189 <!-- 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 Please note, I'm a non-practicing C++ developer, there are a number of things I wasn't sure how to handle in the appropriate fashion, mostly around error handling and what probably looks like an incredibly naive (and messy) way to implement the async co_await behavior. Error handling-wise, I found (don't ask me how!) that if you somehow mismatch the startup task's ID between the manifest and the call to `StartupTask::GetAsync(hstring taskId)`, you'll get a very opaque WinRT exception that boils down to a generic invalid argument message. This isn't likely to happen in the wild, but worth mentioning... I had enough trouble getting myself familiarized with the project, environment, and C++/WinRT in general didn't want to try to tackle adding tests for this quite yet since (as I mentioned) I don't really know what I'm doing. I'm happy to give it a try with perhaps a bit of assistance in getting started 😃 Further work in this area of the application outside of this immediate PR might need to include adding an additional setting to contain launch args that the startup task can pass to the app so that users can specify a non-default profile to launch on start, window position (e.g., #653). <!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well --> ## Validation Steps Performed ✔️ Default settings: Given the user does not have the `startOnUserLogin` setting in their profile.json, When the default settings are opened (via alt+click on Settings), Then the global settings should contain the `"startOnUserLogin": false` token ✔️ Applying setting on application launch Given the `startOnUserLogin` is `true` and the `Windows Terminal` startup task is `disabled` and the application is not running When the application is launched Then the `Windows Terminal` entry in the user's Startup list should be `enabled` ✔️ Applying setting on settings change Given the `startOnUserLogin` is `true` and the `Windows Terminal` startup task is `enabled` and the application is running When the `startOnUserLogin` setting is changed to `false` and the settings file is saved to disk Then the `Windows Terminal` startup task entry should be `disabled` ✔️ Setting is ignored when user has manually disabled startup Given the `startOnUserLogin` is `true` and the application is not running and the `Windows Terminal` startup task has been set to `disabled` via user action When the application is launched Then the startup task should remain disabled and the application should not throw an exception #### note: Task Manager does not seem to re-scan startup task states after launch; the Settings -> Apps -> Startup page also requires closing or moving away to refresh the status of entries
113 lines
4.5 KiB
C++
113 lines
4.5 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#pragma once
|
|
|
|
#include "AppLogic.g.h"
|
|
|
|
#include "Tab.h"
|
|
#include "CascadiaSettings.h"
|
|
#include "TerminalPage.h"
|
|
#include "../../cascadia/inc/cppwinrt_utils.h"
|
|
|
|
namespace winrt::TerminalApp::implementation
|
|
{
|
|
struct AppLogic : AppLogicT<AppLogic>
|
|
{
|
|
public:
|
|
static AppLogic* Current() noexcept;
|
|
|
|
AppLogic();
|
|
~AppLogic() = default;
|
|
|
|
void Create();
|
|
bool IsUwp() const noexcept;
|
|
void RunAsUwp();
|
|
bool IsElevated() const noexcept;
|
|
void LoadSettings();
|
|
[[nodiscard]] std::shared_ptr<::TerminalApp::CascadiaSettings> GetSettings() const noexcept;
|
|
|
|
int32_t SetStartupCommandline(array_view<const winrt::hstring> actions);
|
|
winrt::hstring ParseCommandlineMessage();
|
|
bool ShouldExitEarly();
|
|
|
|
winrt::hstring ApplicationDisplayName() const;
|
|
winrt::hstring ApplicationVersion() const;
|
|
|
|
Windows::Foundation::Point GetLaunchDimensions(uint32_t dpi);
|
|
winrt::Windows::Foundation::Point GetLaunchInitialPositions(int32_t defaultInitialX, int32_t defaultInitialY);
|
|
winrt::Windows::UI::Xaml::ElementTheme GetRequestedTheme();
|
|
LaunchMode GetLaunchMode();
|
|
bool GetShowTabsInTitlebar();
|
|
float CalcSnappedDimension(const bool widthOrHeight, const float dimension) const;
|
|
|
|
Windows::UI::Xaml::UIElement GetRoot() noexcept;
|
|
|
|
hstring Title();
|
|
void TitlebarClicked();
|
|
bool OnF7Pressed();
|
|
|
|
void WindowCloseButtonClicked();
|
|
|
|
// -------------------------------- WinRT Events ---------------------------------
|
|
DECLARE_EVENT_WITH_TYPED_EVENT_HANDLER(RequestedThemeChanged, _requestedThemeChangedHandlers, winrt::Windows::Foundation::IInspectable, winrt::Windows::UI::Xaml::ElementTheme);
|
|
|
|
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 };
|
|
|
|
std::shared_ptr<::TerminalApp::CascadiaSettings> _settings{ nullptr };
|
|
|
|
HRESULT _settingsLoadedResult;
|
|
winrt::hstring _settingsLoadExceptionText{};
|
|
|
|
bool _loadedInitialSettings;
|
|
|
|
wil::unique_folder_change_reader_nothrow _reader;
|
|
|
|
std::shared_mutex _dialogLock;
|
|
|
|
std::atomic<bool> _settingsReloadQueued{ false };
|
|
|
|
fire_and_forget _ShowDialog(const winrt::Windows::Foundation::IInspectable& sender, winrt::Windows::UI::Xaml::Controls::ContentDialog dialog);
|
|
void _ShowLoadErrorsDialog(const winrt::hstring& titleKey, const winrt::hstring& contentKey, HRESULT settingsLoadedResult);
|
|
void _ShowLoadWarningsDialog();
|
|
|
|
fire_and_forget _LoadErrorsDialogRoutine();
|
|
fire_and_forget _ShowLoadWarningsDialogRoutine();
|
|
fire_and_forget _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 _ApplyTheme(const Windows::UI::Xaml::ElementTheme& newTheme);
|
|
|
|
// 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(ToggleFullscreen, winrt::Windows::Foundation::IInspectable, winrt::TerminalApp::ToggleFullscreenEventArgs, _root, ToggleFullscreen);
|
|
};
|
|
}
|
|
|
|
namespace winrt::TerminalApp::factory_implementation
|
|
{
|
|
struct AppLogic : AppLogicT<AppLogic, implementation::AppLogic>
|
|
{
|
|
};
|
|
}
|