Make Global and Profile settings inheritable

.github/actions/spell-check/dictionary/apis.txt

@@ -21,6 +21,7 @@ ICustom
 IDialog
 IDirect
 IExplorer
+IInheritable
 IMap
 IObject
 IStorage

src/cascadia/LocalTests_SettingsModel/DeserializationTests.cpp

@@ -81,6 +81,7 @@ namespace SettingsModelLocalTests
         TEST_METHOD(TestRebindNestedCommand);
 
         TEST_METHOD(TestCopy);
+        TEST_METHOD(TestCloneInheritanceTree);
 
         TEST_CLASS_SETUP(ClassSetup)
         {
@@ -1355,6 +1356,7 @@ namespace SettingsModelLocalTests
         const winrt::guid guid1{ ::Microsoft::Console::Utils::GuidFromString(L"{6239a42c-6666-49a3-80bd-e8fdd045185c}") };
         const winrt::guid guid2{ ::Microsoft::Console::Utils::GuidFromString(L"{2C4DE342-38B7-51CF-B940-2309A097F518}") };
         const winrt::guid fakeGuid{ ::Microsoft::Console::Utils::GuidFromString(L"{FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF}") };
+        const winrt::guid autogeneratedGuid{};
         const std::optional<winrt::guid> badGuid{};
 
         VerifyParseSucceeded(settings0String);
@@ -1366,7 +1368,7 @@ namespace SettingsModelLocalTests
         VERIFY_ARE_EQUAL(guid0, settings->_GetProfileGuidByName(name0));
         VERIFY_ARE_EQUAL(guid1, settings->_GetProfileGuidByName(name1));
         VERIFY_ARE_EQUAL(guid2, settings->_GetProfileGuidByName(name2));
-        VERIFY_ARE_EQUAL(badGuid, settings->_GetProfileGuidByName(name3));
+        VERIFY_ARE_EQUAL(autogeneratedGuid, settings->_GetProfileGuidByName(name3));
         VERIFY_ARE_EQUAL(badGuid, settings->_GetProfileGuidByName(badName));
 
         auto prof0{ settings->FindProfile(guid0) };
@@ -1521,9 +1523,9 @@ namespace SettingsModelLocalTests
         {
             auto settings = winrt::make_self<implementation::CascadiaSettings>(false);
             settings->_ParseJsonString(settings0String, false);
-            VERIFY_IS_TRUE(settings->_userDefaultProfileSettings == Json::Value::null);
+            VERIFY_IS_NULL(settings->_userDefaultProfileSettings);
             settings->_ApplyDefaultsFromUserSettings();
-            VERIFY_IS_FALSE(settings->_userDefaultProfileSettings == Json::Value::null);
+            VERIFY_IS_NOT_NULL(settings->_userDefaultProfileSettings);
             settings->LayerJson(settings->_userSettings);
 
             VERIFY_ARE_EQUAL(guid1String, settings->_globals->UnparsedDefaultProfile());
@@ -1573,9 +1575,9 @@ namespace SettingsModelLocalTests
             VERIFY_ARE_EQUAL(2u, settings->_profiles.Size());
 
             settings->_ParseJsonString(settings0String, false);
-            VERIFY_IS_TRUE(settings->_userDefaultProfileSettings == Json::Value::null);
+            VERIFY_IS_NULL(settings->_userDefaultProfileSettings);
             settings->_ApplyDefaultsFromUserSettings();
-            VERIFY_IS_FALSE(settings->_userDefaultProfileSettings == Json::Value::null);
+            VERIFY_IS_NOT_NULL(settings->_userDefaultProfileSettings);
 
             Log::Comment(NoThrowString().Format(
                 L"Ensure that cmd and powershell don't get their GUIDs overwritten"));
@@ -1692,10 +1694,6 @@ namespace SettingsModelLocalTests
         VERIFY_ARE_EQUAL(L"Terminal.App.UnitTest.1", settings->_profiles.GetAt(1).Source());
         VERIFY_ARE_EQUAL(L"Terminal.App.UnitTest.1", settings->_profiles.GetAt(2).Source());
 
-        VERIFY_IS_TRUE(settings->_profiles.GetAt(0).HasGuid());
-        VERIFY_IS_TRUE(settings->_profiles.GetAt(1).HasGuid());
-        VERIFY_IS_TRUE(settings->_profiles.GetAt(2).HasGuid());
-
         VERIFY_ARE_EQUAL(guid1, settings->_profiles.GetAt(0).Guid());
         VERIFY_ARE_EQUAL(guid1, settings->_profiles.GetAt(1).Guid());
         VERIFY_ARE_EQUAL(guid2, settings->_profiles.GetAt(2).Guid());
@@ -2460,4 +2458,68 @@ namespace SettingsModelLocalTests
         copyImpl->_globals->WordDelimiters(L"changed value");
         VERIFY_ARE_NOT_EQUAL(settings->_globals->WordDelimiters(), copyImpl->_globals->WordDelimiters());
     }
+
+    void DeserializationTests::TestCloneInheritanceTree()
+    {
+        const std::string settingsJson{ R"(
+        {
+            "defaultProfile": "{61c54bbd-1111-5271-96e7-009a87ff44bf}",
+            "profiles":
+            {
+                "defaults": {
+                    "name": "PROFILE DEFAULTS",
+                },
+                "list": [
+                    {
+                        "guid": "{61c54bbd-1111-5271-96e7-009a87ff44bf}",
+                        "name": "CMD"
+                    },
+                    {
+                        "guid": "{61c54bbd-2222-5271-96e7-009a87ff44bf}",
+                        "name": "PowerShell"
+                    },
+                    {
+                        "guid": "{61c54bbd-3333-5271-96e7-009a87ff44bf}"
+                    }
+                ]
+            }
+        })" };
+
+        VerifyParseSucceeded(settingsJson);
+
+        auto settings{ winrt::make_self<implementation::CascadiaSettings>() };
+        settings->_ParseJsonString(settingsJson, false);
+        settings->LayerJson(settings->_userSettings);
+        settings->_ValidateSettings();
+
+        DebugBreak();
+        const auto copy{ settings->Copy() };
+        const auto copyImpl{ winrt::get_self<implementation::CascadiaSettings>(copy) };
+
+        // test globals
+        VERIFY_ARE_EQUAL(settings->_globals->DefaultProfile(), copyImpl->_globals->DefaultProfile());
+
+        // test profiles
+        VERIFY_ARE_EQUAL(settings->_profiles.Size(), copyImpl->_profiles.Size());
+        VERIFY_ARE_EQUAL(settings->_profiles.GetAt(0).Name(), copyImpl->_profiles.GetAt(0).Name());
+        VERIFY_ARE_EQUAL(settings->_profiles.GetAt(1).Name(), copyImpl->_profiles.GetAt(1).Name());
+        VERIFY_ARE_EQUAL(settings->_profiles.GetAt(2).Name(), copyImpl->_profiles.GetAt(2).Name());
+        VERIFY_ARE_EQUAL(settings->_userDefaultProfileSettings->Name(), copyImpl->_userDefaultProfileSettings->Name());
+
+        // Modifying profile.defaults should...
+        VERIFY_ARE_EQUAL(settings->_userDefaultProfileSettings->HasName(), copyImpl->_userDefaultProfileSettings->HasName());
+        copyImpl->_userDefaultProfileSettings->Name(L"changed value");
+
+        // keep the same name for the first two profiles
+        VERIFY_ARE_EQUAL(settings->_profiles.Size(), copyImpl->_profiles.Size());
+        VERIFY_ARE_EQUAL(settings->_profiles.GetAt(0).Name(), copyImpl->_profiles.GetAt(0).Name());
+        VERIFY_ARE_EQUAL(settings->_profiles.GetAt(1).Name(), copyImpl->_profiles.GetAt(1).Name());
+
+        // change the name for the one that inherited it from profile.defaults
+        VERIFY_ARE_NOT_EQUAL(settings->_profiles.GetAt(2).Name(), copyImpl->_profiles.GetAt(2).Name());
+
+        // profile.defaults should be different between the two graphs
+        VERIFY_ARE_NOT_EQUAL(settings->_userDefaultProfileSettings->HasName(), copyImpl->_userDefaultProfileSettings->HasName());
+        VERIFY_ARE_NOT_EQUAL(settings->_userDefaultProfileSettings->Name(), copyImpl->_userDefaultProfileSettings->Name());
+    }
 }

src/cascadia/LocalTests_SettingsModel/ProfileTests.cpp

@@ -132,39 +132,41 @@ namespace SettingsModelLocalTests
 
         Log::Comment(NoThrowString().Format(
             L"Layering profile1 on top of profile0"));
-        profile0->LayerJson(profile1Json);
+        auto profile1{ profile0->CreateChild() };
+        profile1->LayerJson(profile1Json);
 
-        VERIFY_IS_NOT_NULL(profile0->Foreground());
-        VERIFY_ARE_EQUAL(til::color(2, 2, 2), til::color{ profile0->Foreground().Value() });
+        VERIFY_IS_NOT_NULL(profile1->Foreground());
+        VERIFY_ARE_EQUAL(til::color(2, 2, 2), til::color{ profile1->Foreground().Value() });
 
-        VERIFY_IS_NOT_NULL(profile0->Background());
-        VERIFY_ARE_EQUAL(til::color(1, 1, 1), til::color{ profile0->Background().Value() });
+        VERIFY_IS_NOT_NULL(profile1->Background());
+        VERIFY_ARE_EQUAL(til::color(1, 1, 1), til::color{ profile1->Background().Value() });
 
-        VERIFY_IS_NOT_NULL(profile0->Background());
-        VERIFY_ARE_EQUAL(til::color(1, 1, 1), til::color{ profile0->Background().Value() });
+        VERIFY_IS_NOT_NULL(profile1->Background());
+        VERIFY_ARE_EQUAL(til::color(1, 1, 1), til::color{ profile1->Background().Value() });
 
-        VERIFY_ARE_EQUAL(L"profile1", profile0->Name());
+        VERIFY_ARE_EQUAL(L"profile1", profile1->Name());
 
-        VERIFY_IS_FALSE(profile0->StartingDirectory().empty());
-        VERIFY_ARE_EQUAL(L"C:/", profile0->StartingDirectory());
+        VERIFY_IS_FALSE(profile1->StartingDirectory().empty());
+        VERIFY_ARE_EQUAL(L"C:/", profile1->StartingDirectory());
 
         Log::Comment(NoThrowString().Format(
             L"Layering profile2 on top of (profile0+profile1)"));
-        profile0->LayerJson(profile2Json);
+        auto profile2{ profile1->CreateChild() };
+        profile2->LayerJson(profile2Json);
 
-        VERIFY_IS_NOT_NULL(profile0->Foreground());
-        VERIFY_ARE_EQUAL(til::color(3, 3, 3), til::color{ profile0->Foreground().Value() });
+        VERIFY_IS_NOT_NULL(profile2->Foreground());
+        VERIFY_ARE_EQUAL(til::color(3, 3, 3), til::color{ profile2->Foreground().Value() });
 
-        VERIFY_IS_NOT_NULL(profile0->Background());
-        VERIFY_ARE_EQUAL(til::color(1, 1, 1), til::color{ profile0->Background().Value() });
+        VERIFY_IS_NOT_NULL(profile2->Background());
+        VERIFY_ARE_EQUAL(til::color(1, 1, 1), til::color{ profile2->Background().Value() });
 
-        VERIFY_IS_NOT_NULL(profile0->SelectionBackground());
-        VERIFY_ARE_EQUAL(til::color(2, 2, 2), til::color{ profile0->SelectionBackground().Value() });
+        VERIFY_IS_NOT_NULL(profile2->SelectionBackground());
+        VERIFY_ARE_EQUAL(til::color(2, 2, 2), til::color{ profile2->SelectionBackground().Value() });
 
-        VERIFY_ARE_EQUAL(L"profile2", profile0->Name());
+        VERIFY_ARE_EQUAL(L"profile2", profile2->Name());
 
-        VERIFY_IS_FALSE(profile0->StartingDirectory().empty());
-        VERIFY_ARE_EQUAL(L"C:/", profile0->StartingDirectory());
+        VERIFY_IS_FALSE(profile2->StartingDirectory().empty());
+        VERIFY_ARE_EQUAL(L"C:/", profile2->StartingDirectory());
     }
 
     void ProfileTests::LayerProfileIcon()

src/cascadia/TerminalApp/TerminalSettings.cpp

@@ -94,10 +94,7 @@ namespace winrt::TerminalApp::implementation
 
         _Commandline = profile.Commandline();
 
-        if (!profile.StartingDirectory().empty())
-        {
-            _StartingDirectory = profile.EvaluatedStartingDirectory();
-        }
+        _StartingDirectory = profile.EvaluatedStartingDirectory();
 
         // GH#2373: Use the tabTitle as the starting title if it exists, otherwise
         // use the profile name

src/cascadia/TerminalSettingsModel/ActionAndArgs.cpp

@@ -244,7 +244,7 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
     {
         auto copy{ winrt::make_self<ActionAndArgs>() };
         copy->_Action = _Action;
-        copy->_Args = _Args.Copy();
+        copy->_Args = _Args ? _Args.Copy() : IActionArgs{ nullptr };
         return copy;
     }
 

src/cascadia/TerminalSettingsModel/CascadiaSettings.cpp

@@ -71,11 +71,6 @@ winrt::Microsoft::Terminal::Settings::Model::CascadiaSettings CascadiaSettings::
     // dynamic profile generators added by default
     auto settings{ winrt::make_self<CascadiaSettings>() };
     settings->_globals = _globals->Copy();
-    for (const auto profile : _profiles)
-    {
-        auto profImpl{ winrt::get_self<Profile>(profile) };
-        settings->_profiles.Append(*profImpl->Copy());
-    }
     for (auto warning : _warnings)
     {
         settings->_warnings.Append(warning);
@@ -86,6 +81,26 @@ winrt::Microsoft::Terminal::Settings::Model::CascadiaSettings CascadiaSettings::
     settings->_userSettings = _userSettings;
     settings->_defaultSettings = _defaultSettings;
     settings->_userDefaultProfileSettings = _userDefaultProfileSettings;
+
+    // Our profiles inheritance graph doesn't have a formal root.
+    // However, if we create a dummy Profile, and set _profiles as the parent,
+    //  we now have a root. So we'll do just that, and
+    auto dummyRootSource{ winrt::make_self<Profile>() };
+    for (auto profile : _profiles)
+    {
+        winrt::com_ptr<Profile> profileImpl;
+        profileImpl.copy_from(winrt::get_self<Profile>(profile));
+        dummyRootSource->InsertParent(profileImpl);
+    }
+    auto dummyRootClone{ winrt::make_self<Profile>() };
+    Profile::CloneInheritanceGraph(dummyRootSource, dummyRootClone);
+
+    auto cloneParents{ dummyRootClone->ExportParents() };
+    for (auto profile : cloneParents)
+    {
+        settings->_profiles.Append(*profile);
+    }
+
     return *settings;
 }
 

src/cascadia/TerminalSettingsModel/CascadiaSettings.h

@@ -100,10 +100,11 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
         std::string _userSettingsString;
         Json::Value _userSettings;
         Json::Value _defaultSettings;
-        Json::Value _userDefaultProfileSettings{ Json::Value::null };
+        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);
         winrt::com_ptr<implementation::ColorScheme> _FindMatchingColorScheme(const Json::Value& schemeJson);
         void _ParseJsonString(std::string_view fileData, const bool isDefaultSettings);