ab5a8d701d
This commit introduces a basic ApplicationState class, without being used for anything yet to aid reviewers. At a later point actual usages of this new class may be added separately. ## References This commit is an initial step towards implementing #8324. ## PR Checklist * [x] I work here * [x] Tests added/passed ## Validation Steps Performed * Creating a `state.json` with `{"generatedProfiles":["{53e75ed9-2b63-4118-856d-0510c4f6b97e}"]}` updates the ApplicationState, as observed through a debugger ✔️ * Deleting the "generatedProfiles" field sets the corresponding field back to nullopt ✔️
185 lines
7.6 KiB
C++
185 lines
7.6 KiB
C++
/*++
|
|
Copyright (c) Microsoft Corporation
|
|
Licensed under the MIT license.
|
|
|
|
Module Name:
|
|
- CascadiaSettings.h
|
|
|
|
Abstract:
|
|
- This class acts as the container for all app settings. It's composed of two
|
|
parts: Globals, which are app-wide settings, and Profiles, which contain
|
|
a set of settings that apply to a single instance of the terminal.
|
|
Also contains the logic for serializing and deserializing this object.
|
|
|
|
Author(s):
|
|
- Mike Griese - March 2019
|
|
|
|
--*/
|
|
#pragma once
|
|
|
|
#include "CascadiaSettings.g.h"
|
|
|
|
#include "GlobalAppSettings.h"
|
|
#include "TerminalWarnings.h"
|
|
#include "IDynamicProfileGenerator.h"
|
|
|
|
#include "Profile.h"
|
|
#include "ColorScheme.h"
|
|
|
|
// fwdecl unittest classes
|
|
namespace SettingsModelLocalTests
|
|
{
|
|
class SerializationTests;
|
|
class DeserializationTests;
|
|
class ProfileTests;
|
|
class ColorSchemeTests;
|
|
class KeyBindingsTests;
|
|
};
|
|
namespace TerminalAppUnitTests
|
|
{
|
|
class DynamicProfileTests;
|
|
class JsonTests;
|
|
};
|
|
|
|
namespace Microsoft::Terminal::Settings::Model
|
|
{
|
|
class SettingsTypedDeserializationException;
|
|
};
|
|
|
|
class Microsoft::Terminal::Settings::Model::SettingsTypedDeserializationException final : public std::runtime_error
|
|
{
|
|
public:
|
|
SettingsTypedDeserializationException(const std::string_view description) :
|
|
runtime_error(description.data()) {}
|
|
};
|
|
|
|
namespace winrt::Microsoft::Terminal::Settings::Model::implementation
|
|
{
|
|
struct CascadiaSettings : CascadiaSettingsT<CascadiaSettings>
|
|
{
|
|
public:
|
|
CascadiaSettings();
|
|
explicit CascadiaSettings(const bool addDynamicProfiles);
|
|
CascadiaSettings(hstring json);
|
|
Model::CascadiaSettings Copy() const;
|
|
|
|
static Model::CascadiaSettings LoadDefaults();
|
|
static Model::CascadiaSettings LoadAll();
|
|
static Model::CascadiaSettings LoadUniversal();
|
|
|
|
Model::GlobalAppSettings GlobalSettings() const;
|
|
Windows::Foundation::Collections::IObservableVector<Model::Profile> AllProfiles() const noexcept;
|
|
Windows::Foundation::Collections::IObservableVector<Model::Profile> ActiveProfiles() const noexcept;
|
|
Model::ActionMap ActionMap() const noexcept;
|
|
|
|
static com_ptr<CascadiaSettings> FromJson(const Json::Value& json);
|
|
void LayerJson(const Json::Value& json);
|
|
|
|
void WriteSettingsToDisk() const;
|
|
Json::Value ToJson() const;
|
|
|
|
static hstring SettingsPath();
|
|
static hstring DefaultSettingsPath();
|
|
Model::Profile ProfileDefaults() const;
|
|
|
|
static winrt::hstring ApplicationDisplayName();
|
|
static winrt::hstring ApplicationVersion();
|
|
|
|
Model::Profile CreateNewProfile();
|
|
Model::Profile FindProfile(guid profileGuid) const noexcept;
|
|
Model::ColorScheme GetColorSchemeForProfile(const guid profileGuid) const;
|
|
void UpdateColorSchemeReferences(const hstring oldName, const hstring newName);
|
|
|
|
Windows::Foundation::Collections::IVectorView<SettingsLoadWarnings> Warnings();
|
|
void ClearWarnings();
|
|
void AppendWarning(SettingsLoadWarnings warning);
|
|
Windows::Foundation::IReference<SettingsLoadErrors> GetLoadingError();
|
|
hstring GetSerializationErrorMessage();
|
|
|
|
winrt::guid GetProfileForArgs(const Model::NewTerminalArgs& newTerminalArgs) const;
|
|
|
|
Model::Profile DuplicateProfile(Model::Profile source);
|
|
void RefreshDefaultTerminals();
|
|
|
|
static bool IsDefaultTerminalAvailable() noexcept;
|
|
Windows::Foundation::Collections::IObservableVector<Model::DefaultTerminal> DefaultTerminals() const noexcept;
|
|
Model::DefaultTerminal CurrentDefaultTerminal() const noexcept;
|
|
void CurrentDefaultTerminal(Model::DefaultTerminal terminal);
|
|
|
|
private:
|
|
com_ptr<GlobalAppSettings> _globals;
|
|
Windows::Foundation::Collections::IObservableVector<Model::Profile> _allProfiles;
|
|
Windows::Foundation::Collections::IObservableVector<Model::Profile> _activeProfiles;
|
|
Windows::Foundation::Collections::IVector<Model::SettingsLoadWarnings> _warnings;
|
|
Windows::Foundation::IReference<SettingsLoadErrors> _loadError;
|
|
hstring _deserializationErrorMessage;
|
|
|
|
Windows::Foundation::Collections::IObservableVector<Model::DefaultTerminal> _defaultTerminals;
|
|
Model::DefaultTerminal _currentDefaultTerminal;
|
|
|
|
std::vector<std::unique_ptr<::Microsoft::Terminal::Settings::Model::IDynamicProfileGenerator>> _profileGenerators;
|
|
|
|
std::string _userSettingsString;
|
|
Json::Value _userSettings;
|
|
Json::Value _defaultSettings;
|
|
winrt::com_ptr<Profile> _userDefaultProfileSettings{ nullptr };
|
|
|
|
void _LayerOrCreateProfile(const Json::Value& profileJson);
|
|
winrt::com_ptr<implementation::Profile> _FindMatchingProfile(const Json::Value& profileJson);
|
|
std::optional<uint32_t> _FindMatchingProfileIndex(const Json::Value& profileJson);
|
|
void _LayerOrCreateColorScheme(const Json::Value& schemeJson);
|
|
Json::Value _ParseUtf8JsonString(std::string_view fileData);
|
|
|
|
winrt::com_ptr<implementation::ColorScheme> _FindMatchingColorScheme(const Json::Value& schemeJson);
|
|
void _ParseJsonString(std::string_view fileData, const bool isDefaultSettings);
|
|
static const Json::Value& _GetProfilesJsonObject(const Json::Value& json);
|
|
static const Json::Value& _GetDisabledProfileSourcesJsonObject(const Json::Value& json);
|
|
bool _PrependSchemaDirective();
|
|
bool _AppendDynamicProfilesToUserSettings();
|
|
std::string _ApplyFirstRunChangesToSettingsTemplate(std::string_view settingsTemplate) const;
|
|
void _CopyProfileInheritanceTree(com_ptr<CascadiaSettings>& cloneSettings) const;
|
|
|
|
void _ApplyDefaultsFromUserSettings();
|
|
|
|
void _LoadDynamicProfiles();
|
|
void _LoadFragmentExtensions();
|
|
void _ApplyJsonStubsHelper(const std::wstring_view directory, const std::unordered_set<std::wstring>& ignoredNamespaces);
|
|
std::unordered_set<std::string> _AccumulateJsonFilesInDirectory(const std::wstring_view directory);
|
|
void _ParseAndLayerFragmentFiles(const std::unordered_set<std::string> files, const winrt::hstring source);
|
|
|
|
static const std::filesystem::path& _SettingsPath();
|
|
static std::optional<std::string> _ReadUserSettings();
|
|
|
|
std::optional<guid> _GetProfileGuidByName(const hstring) const;
|
|
std::optional<guid> _GetProfileGuidByIndex(std::optional<int> index) const;
|
|
|
|
void _ValidateSettings();
|
|
void _ValidateProfilesExist();
|
|
void _ValidateDefaultProfileExists();
|
|
void _ValidateNoDuplicateProfiles();
|
|
void _ResolveDefaultProfile();
|
|
void _ReorderProfilesToMatchUserSettingsOrder();
|
|
void _UpdateActiveProfiles();
|
|
void _ValidateAllSchemesExist();
|
|
void _ValidateMediaResources();
|
|
void _ValidateKeybindings();
|
|
void _ValidateColorSchemesInCommands();
|
|
void _ValidateNoGlobalsKey();
|
|
|
|
bool _HasInvalidColorScheme(const Model::Command& command);
|
|
|
|
friend class SettingsModelLocalTests::SerializationTests;
|
|
friend class SettingsModelLocalTests::DeserializationTests;
|
|
friend class SettingsModelLocalTests::ProfileTests;
|
|
friend class SettingsModelLocalTests::ColorSchemeTests;
|
|
friend class SettingsModelLocalTests::KeyBindingsTests;
|
|
friend class TerminalAppUnitTests::DynamicProfileTests;
|
|
friend class TerminalAppUnitTests::JsonTests;
|
|
};
|
|
}
|
|
|
|
namespace winrt::Microsoft::Terminal::Settings::Model::factory_implementation
|
|
{
|
|
BASIC_FACTORY(CascadiaSettings);
|
|
}
|