6b503ba887
## Summary of the Pull Request This adds `ToJson` functions to `Profile`, `GlobalAppSettings`, and `ColorScheme`. They are used in `CascadiaSettings` to completely serialize an instance of the settings model. Thanks to #7923, all of the settings are `std::optional`, and `JsonUtils` only writes out values that are actually populated. `CascadiaSettings::WriteSettingsToDisk` serializes the current settings and writes them to the settings.json. A backup file is created with your old contents. #### Limitations: - all of the color schemes are serialized regardless of them coming from defaults.json or settings.json - keybindings/actions are copied/pasted ## References #1564 - Settings UI TSM Specs (#6904 and #7876) ## PR Checklist * [x] Tests added/passed
107 lines
4.3 KiB
C++
107 lines
4.3 KiB
C++
/*++
|
|
Copyright (c) Microsoft Corporation
|
|
Licensed under the MIT license.
|
|
|
|
Module Name:
|
|
- GlobalAppSettings.h
|
|
|
|
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 "GlobalAppSettings.g.h"
|
|
#include "IInheritable.h"
|
|
|
|
#include "KeyMapping.h"
|
|
#include "Command.h"
|
|
#include "ColorScheme.h"
|
|
|
|
// fwdecl unittest classes
|
|
namespace SettingsModelLocalTests
|
|
{
|
|
class DeserializationTests;
|
|
class ColorSchemeTests;
|
|
};
|
|
|
|
namespace winrt::Microsoft::Terminal::Settings::Model::implementation
|
|
{
|
|
struct GlobalAppSettings : GlobalAppSettingsT<GlobalAppSettings>, IInheritable<GlobalAppSettings>
|
|
{
|
|
public:
|
|
GlobalAppSettings();
|
|
void _FinalizeInheritance() override;
|
|
com_ptr<GlobalAppSettings> Copy() const;
|
|
|
|
Windows::Foundation::Collections::IMapView<hstring, Model::ColorScheme> ColorSchemes() noexcept;
|
|
void AddColorScheme(const Model::ColorScheme& scheme);
|
|
|
|
Model::KeyMapping KeyMap() const noexcept;
|
|
|
|
static com_ptr<GlobalAppSettings> FromJson(const Json::Value& json);
|
|
void LayerJson(const Json::Value& json);
|
|
|
|
Json::Value ToJson() const;
|
|
|
|
std::vector<SettingsLoadWarnings> KeybindingsWarnings() const;
|
|
|
|
Windows::Foundation::Collections::IMapView<hstring, Model::Command> Commands() noexcept;
|
|
|
|
// These are implemented manually to handle the string/GUID exchange
|
|
// by higher layers in the app.
|
|
void DefaultProfile(const guid& defaultProfile) noexcept;
|
|
guid DefaultProfile() const;
|
|
bool HasUnparsedDefaultProfile() const;
|
|
winrt::hstring UnparsedDefaultProfile() const;
|
|
void UnparsedDefaultProfile(const hstring& value);
|
|
void ClearUnparsedDefaultProfile();
|
|
|
|
GETSET_SETTING(int32_t, InitialRows, DEFAULT_ROWS);
|
|
GETSET_SETTING(int32_t, InitialCols, DEFAULT_COLS);
|
|
GETSET_SETTING(bool, AlwaysShowTabs, true);
|
|
GETSET_SETTING(bool, ShowTitleInTitlebar, true);
|
|
GETSET_SETTING(bool, ConfirmCloseAllTabs, true);
|
|
GETSET_SETTING(winrt::Windows::UI::Xaml::ElementTheme, Theme, winrt::Windows::UI::Xaml::ElementTheme::Default);
|
|
GETSET_SETTING(winrt::Microsoft::UI::Xaml::Controls::TabViewWidthMode, TabWidthMode, winrt::Microsoft::UI::Xaml::Controls::TabViewWidthMode::Equal);
|
|
GETSET_SETTING(bool, ShowTabsInTitlebar, true);
|
|
GETSET_SETTING(hstring, WordDelimiters, DEFAULT_WORD_DELIMITERS);
|
|
GETSET_SETTING(bool, CopyOnSelect, false);
|
|
GETSET_SETTING(winrt::Microsoft::Terminal::TerminalControl::CopyFormat, CopyFormatting, 0);
|
|
GETSET_SETTING(bool, WarnAboutLargePaste, true);
|
|
GETSET_SETTING(bool, WarnAboutMultiLinePaste, true);
|
|
GETSET_SETTING(Model::LaunchPosition, InitialPosition, nullptr, nullptr);
|
|
GETSET_SETTING(Model::LaunchMode, LaunchMode, LaunchMode::DefaultMode);
|
|
GETSET_SETTING(bool, SnapToGridOnResize, true);
|
|
GETSET_SETTING(bool, ForceFullRepaintRendering, false);
|
|
GETSET_SETTING(bool, SoftwareRendering, false);
|
|
GETSET_SETTING(bool, ForceVTInput, false);
|
|
GETSET_SETTING(bool, DebugFeaturesEnabled, _getDefaultDebugFeaturesValue());
|
|
GETSET_SETTING(bool, StartOnUserLogin, false);
|
|
GETSET_SETTING(bool, AlwaysOnTop, false);
|
|
GETSET_SETTING(Model::TabSwitcherMode, TabSwitcherMode, Model::TabSwitcherMode::MostRecentlyUsed);
|
|
GETSET_SETTING(bool, DisableAnimations, false);
|
|
|
|
private:
|
|
guid _defaultProfile;
|
|
std::optional<hstring> _UnparsedDefaultProfile{ std::nullopt };
|
|
bool _validDefaultProfile;
|
|
|
|
com_ptr<KeyMapping> _keymap;
|
|
std::vector<SettingsLoadWarnings> _keybindingsWarnings;
|
|
|
|
Windows::Foundation::Collections::IMap<hstring, Model::ColorScheme> _colorSchemes;
|
|
Windows::Foundation::Collections::IMap<hstring, Model::Command> _commands;
|
|
|
|
std::optional<hstring> _getUnparsedDefaultProfileImpl() const;
|
|
static bool _getDefaultDebugFeaturesValue();
|
|
|
|
friend class SettingsModelLocalTests::DeserializationTests;
|
|
friend class SettingsModelLocalTests::ColorSchemeTests;
|
|
};
|
|
}
|