This PR represents the start of the work on Cascading User + default settings, #754. Cascading settings will be done in two parts: * [ ] Layered Default+User settings (this PR) * [ ] Dynamic Profile Generation (#2603). Until _both_ are done, _neither are going in. The dynamic profiles PR will target this PR when it's ready, but will go in as a separate commit into master. This PR covers adding one primary feature: the settings are now in two separate files: * a static `defaults.json` that ships with the package (the "default settings") * a `profiles.json` with the user's customizations (the "user settings) User settings are _layered_ upon the settings in the defaults settings. ## References Other things that might be related here: * #1378 - This seems like it's definitely fixed. The default keybindings are _much_ cleaner, and without the save-on-load behavior, the user's keybindings will be left in a good state * #1398 - This might have honestly been solved by #2475 ## PR Checklist * [x] Closes #754 * [x] Closes #1378 * [x] Closes #2566 * [x] I work here * [x] Tests added/passed * [x] Requires documentation to be updated - it **ABSOLUTELY DOES** ## Detailed Description of the Pull Request / Additional comments 1. We start by taking all of the `FromJson` functions in Profile, ColorScheme, Globals, etc, and converting them to `LayerJson` methods. These are effectively the same, with the change that instead of building a new object, they are simply layering the values on top of `this` object. 2. Next, we add tests for layering properties like that. 3. Now, we add a `defaults.json` to the package. This is the file the users can refer to as our default settings. 4. We then take that `defaults.json` and stamp it into an auto generated `.h` file, so we can use it's data without having to worry about reading it from disk. 5. We then change the `LoadAll` function in `CascadiaSettings`. Now, the function does two loads - one from the defaults, and then a second load from the `profiles.json` file, layering the settings from each source upon the previous values. 6. If the `profiles.json` file doesn't exist, we'll create it from a hardcoded `userDefaults.json`, which is stamped in similar to how `defaults.json` is. 7. We also add support for _unbinding_ keybindings that might exist in the `defaults.json`, but the user doesn't want to be bound to anything. 8. We add support for _hiding_ a profile, which is useful if a user doesn't want one of the default profiles to appear in the list of profiles. ## TODO: * [x] Still need to make Alt+Click work on the settings button * [x] Need to write some user documentation on how the new settings model works * [x] Fix the pair of tests I broke (re: Duplicate profiles) <hr> * Create profiles by layering them * Update test to layer multiple times on the same profile * Add support for layering an array of profiles, but break a couple tests * Add a defaults.json to the package * Layer colorschemes * Moves tests into individual classes * adds support for layering a colorscheme on top of another * Layer an array of color schemes * oh no, this was missed with #2481 must have committed without staging this change, uh oh. Not like those tests actually work so nbd * Layer keybindings * Read settings from defaults.json + profiles.json, layer appropriately This is like 80% of #754. Needs tests. * Add tests for keybindings * add support to unbind a key with `null` or `"unbound"` or `"garbage"` * Layer or clear optional properties * Add a helper to get an optional variable for a bunch of different types In the end, I think we need to ask _was this worth it_ * Do this with the stretch mode too * Add back in the GUID check for profiles * Add some tests for global settings layering * M A D W I T H P O W E R Add a MsBuild target to auto-generate a header with the defaults.json as a string in the file. That way, we can _always_ load the defaults. Literally impossible to not. * When the user's profile.json doesn't exist, create it from a template * Re-order profiles to match the order set in the user's profiles.json * Add tests for re-ordering profiles to match user ordering * Add support for hiding profiles using `"hidden": true` * Use the hardcoded defaults.json for the exception->"use defaults" case * Somehow I messed up the git submodules? * woo documentation * Fix a Terminal.App.Unit.Tests failure * signed/unsigned is hard * Use Alt+Settings button to open the default settings * Missed a signed/unsigned * Some very preliminary PR feedback * More PR feedback Use the wil helper for the exe path Move jsonutils into their own file kill some dead code * Add templates to these bois * remove some code for generating defaults, reorder defaults.json a tad * Make guid a std::optional * Large block of PR feedback * Remove some dead code * add some comments * tag some todos * stl is love, stl is life * add `-noprofile` * Fix the crash that dustin found * -Encoding ASCII * Set a profile's default scheme to Campbell * Fix the tests I regressed * Update UsingJsonSetting.md to reflect that changes from these PRs * Change how GenerateGuidForProfile works * Make AppKeyBindings do its own serialization * Remove leftover dead code from the previous commit * Fix up an enormous number of PR nits * Fix a typo; Update the defaults to match #2378 * Tiny nits * Some typos, PR nits * Fix this broken defaults case
283 lines
8.5 KiB
C++
283 lines
8.5 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#include "pch.h"
|
|
#include "GlobalAppSettings.h"
|
|
#include "../../types/inc/Utils.hpp"
|
|
#include "../../inc/DefaultSettings.h"
|
|
#include "Utils.h"
|
|
#include "JsonUtils.h"
|
|
|
|
using namespace TerminalApp;
|
|
using namespace winrt::Microsoft::Terminal::Settings;
|
|
using namespace winrt::TerminalApp;
|
|
using namespace winrt::Windows::Data::Json;
|
|
using namespace winrt::Windows::UI::Xaml;
|
|
using namespace ::Microsoft::Console;
|
|
|
|
static constexpr std::string_view KeybindingsKey{ "keybindings" };
|
|
static constexpr std::string_view DefaultProfileKey{ "defaultProfile" };
|
|
static constexpr std::string_view AlwaysShowTabsKey{ "alwaysShowTabs" };
|
|
static constexpr std::string_view InitialRowsKey{ "initialRows" };
|
|
static constexpr std::string_view InitialColsKey{ "initialCols" };
|
|
static constexpr std::string_view ShowTitleInTitlebarKey{ "showTerminalTitleInTitlebar" };
|
|
static constexpr std::string_view RequestedThemeKey{ "requestedTheme" };
|
|
static constexpr std::string_view ShowTabsInTitlebarKey{ "showTabsInTitlebar" };
|
|
static constexpr std::string_view WordDelimitersKey{ "wordDelimiters" };
|
|
static constexpr std::string_view CopyOnSelectKey{ "copyOnSelect" };
|
|
|
|
static constexpr std::wstring_view LightThemeValue{ L"light" };
|
|
static constexpr std::wstring_view DarkThemeValue{ L"dark" };
|
|
static constexpr std::wstring_view SystemThemeValue{ L"system" };
|
|
|
|
GlobalAppSettings::GlobalAppSettings() :
|
|
_keybindings{ winrt::make_self<winrt::TerminalApp::implementation::AppKeyBindings>() },
|
|
_colorSchemes{},
|
|
_defaultProfile{},
|
|
_alwaysShowTabs{ true },
|
|
_initialRows{ DEFAULT_ROWS },
|
|
_initialCols{ DEFAULT_COLS },
|
|
_showTitleInTitlebar{ true },
|
|
_showTabsInTitlebar{ true },
|
|
_requestedTheme{ ElementTheme::Default },
|
|
_wordDelimiters{ DEFAULT_WORD_DELIMITERS },
|
|
_copyOnSelect{ false }
|
|
{
|
|
}
|
|
|
|
GlobalAppSettings::~GlobalAppSettings()
|
|
{
|
|
}
|
|
|
|
const std::vector<ColorScheme>& GlobalAppSettings::GetColorSchemes() const noexcept
|
|
{
|
|
return _colorSchemes;
|
|
}
|
|
|
|
std::vector<ColorScheme>& GlobalAppSettings::GetColorSchemes() noexcept
|
|
{
|
|
return _colorSchemes;
|
|
}
|
|
|
|
void GlobalAppSettings::SetDefaultProfile(const GUID defaultProfile) noexcept
|
|
{
|
|
_defaultProfile = defaultProfile;
|
|
}
|
|
|
|
GUID GlobalAppSettings::GetDefaultProfile() const noexcept
|
|
{
|
|
return _defaultProfile;
|
|
}
|
|
|
|
AppKeyBindings GlobalAppSettings::GetKeybindings() const noexcept
|
|
{
|
|
return *_keybindings;
|
|
}
|
|
|
|
bool GlobalAppSettings::GetAlwaysShowTabs() const noexcept
|
|
{
|
|
return _alwaysShowTabs;
|
|
}
|
|
|
|
void GlobalAppSettings::SetAlwaysShowTabs(const bool showTabs) noexcept
|
|
{
|
|
_alwaysShowTabs = showTabs;
|
|
}
|
|
|
|
bool GlobalAppSettings::GetShowTitleInTitlebar() const noexcept
|
|
{
|
|
return _showTitleInTitlebar;
|
|
}
|
|
|
|
void GlobalAppSettings::SetShowTitleInTitlebar(const bool showTitleInTitlebar) noexcept
|
|
{
|
|
_showTitleInTitlebar = showTitleInTitlebar;
|
|
}
|
|
|
|
ElementTheme GlobalAppSettings::GetRequestedTheme() const noexcept
|
|
{
|
|
return _requestedTheme;
|
|
}
|
|
|
|
void GlobalAppSettings::SetRequestedTheme(const ElementTheme requestedTheme) noexcept
|
|
{
|
|
_requestedTheme = requestedTheme;
|
|
}
|
|
|
|
std::wstring GlobalAppSettings::GetWordDelimiters() const noexcept
|
|
{
|
|
return _wordDelimiters;
|
|
}
|
|
|
|
void GlobalAppSettings::SetWordDelimiters(const std::wstring wordDelimiters) noexcept
|
|
{
|
|
_wordDelimiters = wordDelimiters;
|
|
}
|
|
|
|
bool GlobalAppSettings::GetCopyOnSelect() const noexcept
|
|
{
|
|
return _copyOnSelect;
|
|
}
|
|
|
|
void GlobalAppSettings::SetCopyOnSelect(const bool copyOnSelect) noexcept
|
|
{
|
|
_copyOnSelect = copyOnSelect;
|
|
}
|
|
|
|
#pragma region ExperimentalSettings
|
|
bool GlobalAppSettings::GetShowTabsInTitlebar() const noexcept
|
|
{
|
|
return _showTabsInTitlebar;
|
|
}
|
|
|
|
void GlobalAppSettings::SetShowTabsInTitlebar(const bool showTabsInTitlebar) noexcept
|
|
{
|
|
_showTabsInTitlebar = showTabsInTitlebar;
|
|
}
|
|
#pragma endregion
|
|
|
|
// Method Description:
|
|
// - Applies appropriate settings from the globals into the given TerminalSettings.
|
|
// Arguments:
|
|
// - settings: a TerminalSettings object to add global property values to.
|
|
// Return Value:
|
|
// - <none>
|
|
void GlobalAppSettings::ApplyToSettings(TerminalSettings& settings) const noexcept
|
|
{
|
|
settings.KeyBindings(GetKeybindings());
|
|
settings.InitialRows(_initialRows);
|
|
settings.InitialCols(_initialCols);
|
|
settings.WordDelimiters(_wordDelimiters);
|
|
settings.CopyOnSelect(_copyOnSelect);
|
|
}
|
|
|
|
// Method Description:
|
|
// - Serialize this object to a JsonObject.
|
|
// Arguments:
|
|
// - <none>
|
|
// Return Value:
|
|
// - a JsonObject which is an equivalent serialization of this object.
|
|
Json::Value GlobalAppSettings::ToJson() const
|
|
{
|
|
Json::Value jsonObject;
|
|
|
|
jsonObject[JsonKey(DefaultProfileKey)] = winrt::to_string(Utils::GuidToString(_defaultProfile));
|
|
jsonObject[JsonKey(InitialRowsKey)] = _initialRows;
|
|
jsonObject[JsonKey(InitialColsKey)] = _initialCols;
|
|
jsonObject[JsonKey(AlwaysShowTabsKey)] = _alwaysShowTabs;
|
|
jsonObject[JsonKey(ShowTitleInTitlebarKey)] = _showTitleInTitlebar;
|
|
jsonObject[JsonKey(ShowTabsInTitlebarKey)] = _showTabsInTitlebar;
|
|
jsonObject[JsonKey(WordDelimitersKey)] = winrt::to_string(_wordDelimiters);
|
|
jsonObject[JsonKey(CopyOnSelectKey)] = _copyOnSelect;
|
|
jsonObject[JsonKey(RequestedThemeKey)] = winrt::to_string(_SerializeTheme(_requestedTheme));
|
|
jsonObject[JsonKey(KeybindingsKey)] = _keybindings->ToJson();
|
|
|
|
return jsonObject;
|
|
}
|
|
|
|
// Method Description:
|
|
// - Create a new instance of this class from a serialized JsonObject.
|
|
// Arguments:
|
|
// - json: an object which should be a serialization of a GlobalAppSettings object.
|
|
// Return Value:
|
|
// - a new GlobalAppSettings instance created from the values in `json`
|
|
GlobalAppSettings GlobalAppSettings::FromJson(const Json::Value& json)
|
|
{
|
|
GlobalAppSettings result;
|
|
result.LayerJson(json);
|
|
return result;
|
|
}
|
|
|
|
void GlobalAppSettings::LayerJson(const Json::Value& json)
|
|
{
|
|
if (auto defaultProfile{ json[JsonKey(DefaultProfileKey)] })
|
|
{
|
|
auto guid = Utils::GuidFromString(GetWstringFromJson(defaultProfile));
|
|
_defaultProfile = guid;
|
|
}
|
|
|
|
if (auto alwaysShowTabs{ json[JsonKey(AlwaysShowTabsKey)] })
|
|
{
|
|
_alwaysShowTabs = alwaysShowTabs.asBool();
|
|
}
|
|
if (auto initialRows{ json[JsonKey(InitialRowsKey)] })
|
|
{
|
|
_initialRows = initialRows.asInt();
|
|
}
|
|
if (auto initialCols{ json[JsonKey(InitialColsKey)] })
|
|
{
|
|
_initialCols = initialCols.asInt();
|
|
}
|
|
|
|
if (auto showTitleInTitlebar{ json[JsonKey(ShowTitleInTitlebarKey)] })
|
|
{
|
|
_showTitleInTitlebar = showTitleInTitlebar.asBool();
|
|
}
|
|
|
|
if (auto showTabsInTitlebar{ json[JsonKey(ShowTabsInTitlebarKey)] })
|
|
{
|
|
_showTabsInTitlebar = showTabsInTitlebar.asBool();
|
|
}
|
|
|
|
if (auto wordDelimiters{ json[JsonKey(WordDelimitersKey)] })
|
|
{
|
|
_wordDelimiters = GetWstringFromJson(wordDelimiters);
|
|
}
|
|
|
|
if (auto copyOnSelect{ json[JsonKey(CopyOnSelectKey)] })
|
|
{
|
|
_copyOnSelect = copyOnSelect.asBool();
|
|
}
|
|
|
|
if (auto requestedTheme{ json[JsonKey(RequestedThemeKey)] })
|
|
{
|
|
_requestedTheme = _ParseTheme(GetWstringFromJson(requestedTheme));
|
|
}
|
|
|
|
if (auto keybindings{ json[JsonKey(KeybindingsKey)] })
|
|
{
|
|
_keybindings->LayerJson(keybindings);
|
|
}
|
|
}
|
|
|
|
// Method Description:
|
|
// - Helper function for converting a user-specified cursor style corresponding
|
|
// CursorStyle enum value
|
|
// Arguments:
|
|
// - themeString: The string value from the settings file to parse
|
|
// Return Value:
|
|
// - The corresponding enum value which maps to the string provided by the user
|
|
ElementTheme GlobalAppSettings::_ParseTheme(const std::wstring& themeString) noexcept
|
|
{
|
|
if (themeString == LightThemeValue)
|
|
{
|
|
return ElementTheme::Light;
|
|
}
|
|
else if (themeString == DarkThemeValue)
|
|
{
|
|
return ElementTheme::Dark;
|
|
}
|
|
// default behavior for invalid data or SystemThemeValue
|
|
return ElementTheme::Default;
|
|
}
|
|
|
|
// Method Description:
|
|
// - Helper function for converting a CursorStyle to its corresponding string
|
|
// value.
|
|
// Arguments:
|
|
// - theme: The enum value to convert to a string.
|
|
// Return Value:
|
|
// - The string value for the given CursorStyle
|
|
std::wstring_view GlobalAppSettings::_SerializeTheme(const ElementTheme theme) noexcept
|
|
{
|
|
switch (theme)
|
|
{
|
|
case ElementTheme::Light:
|
|
return LightThemeValue;
|
|
case ElementTheme::Dark:
|
|
return DarkThemeValue;
|
|
default:
|
|
return SystemThemeValue;
|
|
}
|
|
}
|