9ed776bf3e
## Summary of the Pull Request
This looks like a big diff, but there's a bunch of existing code that
just got moved around, and there's a cool new Utils template.
The tests all pass, and this passed manual validation. I tried weird
things like "making a profile named `{ }`"
(w/ enough spaces to look like a guid), and yeah it doesn't let you
specify that one as a name, but _why would you do that?!_
Okay, this pull request abstracts the conversion of a profile name into
an optional profile guid out of the "New Terminal Tab Args" handler and
into a common space for all of CascadiaSettings to use.
It also cleans up the conversion of indices and names into optional
GUIDs and turns _those_ into further helpers.
It also introduces a cool new template for running value_or multiple
times on a chain of optionals. CoalesceOptionals is a "choose first,
with fallback" for N>1 optionals.
On top of all this, I've built support for an "unparsed default GUID":
we load the user's defaultProfile as a string, and as part of settings
validation we unpack that string using the helpers outlined above.
## References
Couples well with #5690.
## PR Checklist
* [x] Incidentally fixes #2876
* [x] Core Contributor
* [x] Tests added/passed
* [x] Requires documentation to be updated (done)
* [x] I've discussed this with core contributors already
## Validation Steps Performed
Added additional test collateral to make sure that this works.
151 lines
5.2 KiB
C++
151 lines
5.2 KiB
C++
/*++
|
|
Copyright (c) Microsoft Corporation
|
|
Licensed under the MIT license.
|
|
|
|
Module Name:
|
|
- CascadiaSettings.hpp
|
|
|
|
Abstract:
|
|
- This class encapsulates all of the settings that are global to the app, and
|
|
not a part of any particular profile.
|
|
|
|
Author(s):
|
|
- Mike Griese - March 2019
|
|
|
|
--*/
|
|
#pragma once
|
|
#include "AppKeyBindings.h"
|
|
#include "ColorScheme.h"
|
|
|
|
// fwdecl unittest classes
|
|
namespace TerminalAppLocalTests
|
|
{
|
|
class SettingsTests;
|
|
class ColorSchemeTests;
|
|
};
|
|
|
|
namespace TerminalApp
|
|
{
|
|
class GlobalAppSettings;
|
|
};
|
|
|
|
class TerminalApp::GlobalAppSettings final
|
|
{
|
|
public:
|
|
GlobalAppSettings();
|
|
~GlobalAppSettings();
|
|
|
|
std::unordered_map<std::wstring, ColorScheme>& GetColorSchemes() noexcept;
|
|
const std::unordered_map<std::wstring, ColorScheme>& GetColorSchemes() const noexcept;
|
|
void AddColorScheme(ColorScheme scheme);
|
|
|
|
void SetDefaultProfile(const GUID defaultProfile) noexcept;
|
|
GUID GetDefaultProfile() const;
|
|
std::wstring GetUnparsedDefaultProfile() const;
|
|
|
|
winrt::TerminalApp::AppKeyBindings GetKeybindings() const noexcept;
|
|
|
|
bool GetAlwaysShowTabs() const noexcept;
|
|
void SetAlwaysShowTabs(const bool showTabs) noexcept;
|
|
|
|
bool GetShowTitleInTitlebar() const noexcept;
|
|
void SetShowTitleInTitlebar(const bool showTitleInTitlebar) noexcept;
|
|
|
|
bool GetConfirmCloseAllTabs() const noexcept;
|
|
void SetConfirmCloseAllTabs(const bool confirmCloseAllTabs) noexcept;
|
|
|
|
winrt::Windows::UI::Xaml::ElementTheme GetTheme() const noexcept;
|
|
void SetTheme(const winrt::Windows::UI::Xaml::ElementTheme requestedTheme) noexcept;
|
|
|
|
winrt::Microsoft::UI::Xaml::Controls::TabViewWidthMode GetTabWidthMode() const noexcept;
|
|
void SetTabWidthMode(const winrt::Microsoft::UI::Xaml::Controls::TabViewWidthMode tabWidthMode);
|
|
|
|
bool GetShowTabsInTitlebar() const noexcept;
|
|
void SetShowTabsInTitlebar(const bool showTabsInTitlebar) noexcept;
|
|
|
|
std::wstring GetWordDelimiters() const noexcept;
|
|
void SetWordDelimiters(const std::wstring wordDelimiters) noexcept;
|
|
|
|
bool GetCopyOnSelect() const noexcept;
|
|
void SetCopyOnSelect(const bool copyOnSelect) noexcept;
|
|
|
|
bool GetCopyFormatting() const noexcept;
|
|
|
|
std::optional<int32_t> GetInitialX() const noexcept;
|
|
|
|
std::optional<int32_t> GetInitialY() const noexcept;
|
|
|
|
winrt::TerminalApp::LaunchMode GetLaunchMode() const noexcept;
|
|
void SetLaunchMode(const winrt::TerminalApp::LaunchMode launchMode);
|
|
|
|
bool GetForceFullRepaintRendering() noexcept;
|
|
bool GetSoftwareRendering() noexcept;
|
|
|
|
bool DebugFeaturesEnabled() const noexcept;
|
|
|
|
static GlobalAppSettings FromJson(const Json::Value& json);
|
|
void LayerJson(const Json::Value& json);
|
|
|
|
void ApplyToSettings(winrt::Microsoft::Terminal::Settings::TerminalSettings& settings) const noexcept;
|
|
|
|
std::vector<TerminalApp::SettingsLoadWarnings> GetKeybindingsWarnings() const;
|
|
|
|
GETSET_PROPERTY(bool, SnapToGridOnResize, true);
|
|
|
|
GETSET_PROPERTY(bool, StartOnUserLogin, false);
|
|
|
|
private:
|
|
std::optional<std::wstring> _unparsedDefaultProfile;
|
|
GUID _defaultProfile;
|
|
winrt::com_ptr<winrt::TerminalApp::implementation::AppKeyBindings> _keybindings;
|
|
std::vector<::TerminalApp::SettingsLoadWarnings> _keybindingsWarnings;
|
|
|
|
std::unordered_map<std::wstring, ColorScheme> _colorSchemes;
|
|
|
|
int32_t _initialRows;
|
|
int32_t _initialCols;
|
|
|
|
int32_t _rowsToScroll;
|
|
|
|
std::optional<int32_t> _initialX;
|
|
std::optional<int32_t> _initialY;
|
|
|
|
bool _showStatusline;
|
|
bool _alwaysShowTabs;
|
|
bool _showTitleInTitlebar;
|
|
bool _confirmCloseAllTabs;
|
|
|
|
bool _showTabsInTitlebar;
|
|
std::wstring _wordDelimiters;
|
|
bool _copyOnSelect;
|
|
bool _copyFormatting;
|
|
winrt::Windows::UI::Xaml::ElementTheme _theme;
|
|
winrt::Microsoft::UI::Xaml::Controls::TabViewWidthMode _tabWidthMode;
|
|
|
|
winrt::TerminalApp::LaunchMode _launchMode;
|
|
|
|
bool _softwareRendering;
|
|
bool _forceFullRepaintRendering;
|
|
|
|
bool _debugFeatures;
|
|
|
|
static winrt::Windows::UI::Xaml::ElementTheme _ParseTheme(const std::wstring& themeString) noexcept;
|
|
static std::wstring_view _SerializeTheme(const winrt::Windows::UI::Xaml::ElementTheme theme) noexcept;
|
|
|
|
static std::wstring_view _SerializeTabWidthMode(const winrt::Microsoft::UI::Xaml::Controls::TabViewWidthMode tabWidthMode) noexcept;
|
|
static winrt::Microsoft::UI::Xaml::Controls::TabViewWidthMode _ParseTabWidthMode(const std::wstring& tabWidthModeString) noexcept;
|
|
|
|
static void _ParseInitialPosition(const std::wstring& initialPosition,
|
|
std::optional<int32_t>& initialX,
|
|
std::optional<int32_t>& initialY) noexcept;
|
|
|
|
static std::string _SerializeInitialPosition(const std::optional<int32_t>& initialX,
|
|
const std::optional<int32_t>& initialY) noexcept;
|
|
|
|
static std::wstring_view _SerializeLaunchMode(const winrt::TerminalApp::LaunchMode launchMode) noexcept;
|
|
static winrt::TerminalApp::LaunchMode _ParseLaunchMode(const std::wstring& launchModeString) noexcept;
|
|
|
|
friend class TerminalAppLocalTests::SettingsTests;
|
|
friend class TerminalAppLocalTests::ColorSchemeTests;
|
|
};
|