8dd317313b
If we find that the settings file doesn't exist, or is empty, then let's quick delete the state file as well. If the user does have a state file, and not a settings, then they probably tried to reset their settings. It might have data in it that was only relevant for a previous iteration of the settings file. If we don't, we'll load the old state and ignore all dynamic profiles (for example)! We'll remove all of the data in the `ApplicationState` object and reset it to the defaults. This will delete the state file! That's the sure-fire way to make sure the data doesn't come back. If we leave it untouched, then when we go to write the file back out, we'll first re-read it's contents and try to overlay our new state. However, nullopts won't remove keys from the JSON, so we'll end up with the original state in the file. * [x] Closes #11119 * [x] Tested on a cold launch of the Terminal with an existing `state.json` and an empty `settings.json` * [x] Tested a hot-reload of deleting the `settings.json`
94 lines
3.7 KiB
C++
94 lines
3.7 KiB
C++
/*++
|
|
Copyright (c) Microsoft Corporation
|
|
Licensed under the MIT license.
|
|
|
|
Module Name:
|
|
- ApplicationState.h
|
|
|
|
Abstract:
|
|
- If the CascadiaSettings class were AppData, then this class would be LocalAppData.
|
|
Put anything in here that you wouldn't want to be stored next to user-editable settings.
|
|
- Modify ApplicationState.idl and MTSM_APPLICATION_STATE_FIELDS to add new fields.
|
|
--*/
|
|
#pragma once
|
|
|
|
#include "ApplicationState.g.h"
|
|
#include "WindowLayout.g.h"
|
|
|
|
#include <inc/cppwinrt_utils.h>
|
|
#include <til/mutex.h>
|
|
#include <til/throttled_func.h>
|
|
#include "FileUtils.h"
|
|
#include <JsonUtils.h>
|
|
|
|
// This macro generates all getters and setters for ApplicationState.
|
|
// It provides X with the following arguments:
|
|
// (type, function name, JSON key, ...variadic construction arguments)
|
|
namespace winrt::Microsoft::Terminal::Settings::Model::implementation
|
|
{
|
|
#define MTSM_APPLICATION_STATE_FIELDS(X) \
|
|
X(std::unordered_set<winrt::guid>, GeneratedProfiles, "generatedProfiles") \
|
|
X(Windows::Foundation::Collections::IVector<Model::WindowLayout>, PersistedWindowLayouts, "persistedWindowLayouts") \
|
|
X(Windows::Foundation::Collections::IVector<hstring>, RecentCommands, "recentCommands") \
|
|
X(Windows::Foundation::Collections::IVector<winrt::Microsoft::Terminal::Settings::Model::InfoBarMessage>, DismissedMessages, "dismissedMessages")
|
|
|
|
struct WindowLayout : WindowLayoutT<WindowLayout>
|
|
{
|
|
static winrt::hstring ToJson(const Model::WindowLayout& layout);
|
|
static Model::WindowLayout FromJson(const winrt::hstring& json);
|
|
|
|
WINRT_PROPERTY(Windows::Foundation::Collections::IVector<Model::ActionAndArgs>, TabLayout, nullptr);
|
|
WINRT_PROPERTY(winrt::Windows::Foundation::IReference<Model::LaunchPosition>, InitialPosition, nullptr);
|
|
WINRT_PROPERTY(winrt::Windows::Foundation::IReference<winrt::Windows::Foundation::Size>, InitialSize, nullptr);
|
|
|
|
friend ::Microsoft::Terminal::Settings::Model::JsonUtils::ConversionTrait<Model::WindowLayout>;
|
|
};
|
|
|
|
struct ApplicationState : ApplicationStateT<ApplicationState>
|
|
{
|
|
static Microsoft::Terminal::Settings::Model::ApplicationState SharedInstance();
|
|
|
|
ApplicationState(std::filesystem::path path) noexcept;
|
|
~ApplicationState();
|
|
|
|
// Methods
|
|
void Reload() const noexcept;
|
|
void Reset() noexcept;
|
|
|
|
// General getters/setters
|
|
winrt::hstring FilePath() const noexcept;
|
|
|
|
// State getters/setters
|
|
#define MTSM_APPLICATION_STATE_GEN(type, name, key, ...) \
|
|
type name() const noexcept; \
|
|
void name(const type& value) noexcept;
|
|
MTSM_APPLICATION_STATE_FIELDS(MTSM_APPLICATION_STATE_GEN)
|
|
#undef MTSM_APPLICATION_STATE_GEN
|
|
|
|
private:
|
|
struct state_t
|
|
{
|
|
#define MTSM_APPLICATION_STATE_GEN(type, name, key, ...) \
|
|
std::optional<type> name{ __VA_ARGS__ }; \
|
|
bool name##Changed = false;
|
|
|
|
MTSM_APPLICATION_STATE_FIELDS(MTSM_APPLICATION_STATE_GEN)
|
|
#undef MTSM_APPLICATION_STATE_GEN
|
|
};
|
|
|
|
Json::Value _getRoot(const winrt::Microsoft::Terminal::Settings::Model::locked_hfile& file) const noexcept;
|
|
void _write() noexcept;
|
|
void _read() const noexcept;
|
|
|
|
std::filesystem::path _path;
|
|
til::shared_mutex<state_t> _state;
|
|
til::throttled_func_trailing<> _throttler;
|
|
};
|
|
}
|
|
|
|
namespace winrt::Microsoft::Terminal::Settings::Model::factory_implementation
|
|
{
|
|
BASIC_FACTORY(WindowLayout)
|
|
BASIC_FACTORY(ApplicationState);
|
|
}
|