PRE-MERGE #14944 Add support for running the Terminal without _any_ windows

carlos-zamora · carlos-zamora · commit 6a9254ee18e1 · 2023-03-03T12:40:43.000-08:00
diff --git a/src/cascadia/TerminalApp/AppLogic.cpp b/src/cascadia/TerminalApp/AppLogic.cpp
@@ -674,6 +674,16 @@ namespace winrt::TerminalApp::implementation
         return _settings.GlobalSettings().IsolatedMode();
     }
 
+    bool AppLogic::AllowHeadless()
+    {
+        if (!_loadedInitialSettings)
+        {
+            // Load settings if we haven't already
+            ReloadSettings();
+        }
+        return _settings.GlobalSettings().AllowHeadless();
+    }
+
     TerminalApp::TerminalWindow AppLogic::CreateNewWindow()
     {
         if (_settings == nullptr)
diff --git a/src/cascadia/TerminalApp/AppLogic.h b/src/cascadia/TerminalApp/AppLogic.h
@@ -66,6 +66,7 @@ namespace winrt::TerminalApp::implementation
 
         Microsoft::Terminal::Settings::Model::Theme Theme();
         bool IsolatedMode();
+        bool AllowHeadless();
 
         TerminalApp::TerminalWindow CreateNewWindow();
 
diff --git a/src/cascadia/TerminalApp/AppLogic.idl b/src/cascadia/TerminalApp/AppLogic.idl
@@ -45,6 +45,7 @@ namespace TerminalApp
 
         Microsoft.Terminal.Settings.Model.Theme Theme { get; };
         Boolean IsolatedMode { get; };
+        Boolean AllowHeadless { get; };
 
         FindTargetWindowResult FindTargetWindow(String[] args);
 
diff --git a/src/cascadia/TerminalSettingsModel/ActionMap.cpp b/src/cascadia/TerminalSettingsModel/ActionMap.cpp
@@ -898,8 +898,6 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
         // WHILE also making sure that upon re-saving the commands, we don't
         // actually serialize the results of the expansion. I don't think it is.
 
-        auto warnings{ winrt::single_threaded_vector<SettingsLoadWarnings>() };
-
         std::vector<Model::ColorScheme> sortedSchemes;
         sortedSchemes.reserve(schemes.Size());
 
@@ -921,8 +919,7 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
 
         Command::ExpandCommands(copyOfCommands,
                                 profiles,
-                                winrt::param::vector_view<Model::ColorScheme>{ sortedSchemes },
-                                warnings);
+                                winrt::param::vector_view<Model::ColorScheme>{ sortedSchemes });
 
         _ExpandedMapCache = copyOfCommands;
     }
diff --git a/src/cascadia/TerminalSettingsModel/Command.cpp b/src/cascadia/TerminalSettingsModel/Command.cpp
@@ -480,8 +480,7 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
     // - <none>
     void Command::ExpandCommands(IMap<winrt::hstring, Model::Command> commands,
                                  IVectorView<Model::Profile> profiles,
-                                 IVectorView<Model::ColorScheme> schemes,
-                                 IVector<SettingsLoadWarnings> warnings)
+                                 IVectorView<Model::ColorScheme> schemes)
     {
         std::vector<winrt::hstring> commandsToRemove;
         std::vector<Model::Command> commandsToAdd;
@@ -491,7 +490,7 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
         {
             auto cmd{ get_self<implementation::Command>(nameAndCmd.Value()) };
 
-            auto newCommands = _expandCommand(cmd, profiles, schemes, warnings);
+            auto newCommands = _expandCommand(cmd, profiles, schemes);
             if (newCommands.size() > 0)
             {
                 commandsToRemove.push_back(nameAndCmd.Key());
@@ -529,21 +528,18 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
     // Arguments:
     // - expandable: the Command to potentially turn into more commands
     // - profiles: A list of all the profiles that this command should be expanded on.
-    // - warnings: If there were any warnings during parsing, they'll be
-    //   appended to this vector.
     // Return Value:
     // - and empty vector if the command wasn't expandable, otherwise a list of
     //   the newly-created commands.
     std::vector<Model::Command> Command::_expandCommand(Command* const expandable,
                                                         IVectorView<Model::Profile> profiles,
-                                                        IVectorView<Model::ColorScheme> schemes,
-                                                        IVector<SettingsLoadWarnings>& warnings)
+                                                        IVectorView<Model::ColorScheme> schemes)
     {
         std::vector<Model::Command> newCommands;
 
         if (expandable->HasNestedCommands())
         {
-            ExpandCommands(expandable->_subcommands, profiles, schemes, warnings);
+            ExpandCommands(expandable->_subcommands, profiles, schemes);
         }
 
         if (expandable->_IterateOn == ExpandCommandType::None)
@@ -564,18 +560,19 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
             const auto actualDataEnd = newJsonString.data() + newJsonString.size();
             if (!reader->parse(actualDataStart, actualDataEnd, &newJsonValue, &errs))
             {
-                warnings.Append(SettingsLoadWarnings::FailedToParseCommandJson);
                 // If we encounter a re-parsing error, just stop processing the rest of the commands.
                 return false;
             }
 
             // Pass the new json back though FromJson, to get the new expanded value.
-            std::vector<SettingsLoadWarnings> newWarnings;
-            if (auto newCmd{ Command::FromJson(newJsonValue, newWarnings) })
+            // FromJson requires that we pass in a vector to hang on to the
+            // warnings, but ultimately, we don't care about warnings during
+            // expansion.
+            std::vector<SettingsLoadWarnings> unused;
+            if (auto newCmd{ Command::FromJson(newJsonValue, unused) })
             {
                 newCommands.push_back(*newCmd);
             }
-            std::for_each(newWarnings.begin(), newWarnings.end(), [warnings](auto& warn) { warnings.Append(warn); });
             return true;
         };
 
diff --git a/src/cascadia/TerminalSettingsModel/Command.h b/src/cascadia/TerminalSettingsModel/Command.h
@@ -43,8 +43,7 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
 
         static void ExpandCommands(Windows::Foundation::Collections::IMap<winrt::hstring, Model::Command> commands,
                                    Windows::Foundation::Collections::IVectorView<Model::Profile> profiles,
-                                   Windows::Foundation::Collections::IVectorView<Model::ColorScheme> schemes,
-                                   Windows::Foundation::Collections::IVector<SettingsLoadWarnings> warnings);
+                                   Windows::Foundation::Collections::IVectorView<Model::ColorScheme> schemes);
 
         static std::vector<SettingsLoadWarnings> LayerJson(Windows::Foundation::Collections::IMap<winrt::hstring, Model::Command>& commands,
                                                            const Json::Value& json);
@@ -80,8 +79,7 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
 
         static std::vector<Model::Command> _expandCommand(Command* const expandable,
                                                           Windows::Foundation::Collections::IVectorView<Model::Profile> profiles,
-                                                          Windows::Foundation::Collections::IVectorView<Model::ColorScheme> schemes,
-                                                          Windows::Foundation::Collections::IVector<SettingsLoadWarnings>& warnings);
+                                                          Windows::Foundation::Collections::IVectorView<Model::ColorScheme> schemes);
         friend class SettingsModelLocalTests::DeserializationTests;
         friend class SettingsModelLocalTests::CommandTests;
     };
diff --git a/src/cascadia/TerminalSettingsModel/Command.idl b/src/cascadia/TerminalSettingsModel/Command.idl
@@ -48,7 +48,6 @@ namespace Microsoft.Terminal.Settings.Model
 
         static void ExpandCommands(Windows.Foundation.Collections.IMap<String, Command> commands,
                                    Windows.Foundation.Collections.IVectorView<Profile> profiles,
-                                   Windows.Foundation.Collections.IVectorView<ColorScheme> schemes,
-                                   Windows.Foundation.Collections.IVector<SettingsLoadWarnings> warnings);
+                                   Windows.Foundation.Collections.IVectorView<ColorScheme> schemes);
     }
 }
diff --git a/src/cascadia/TerminalSettingsModel/GlobalAppSettings.idl b/src/cascadia/TerminalSettingsModel/GlobalAppSettings.idl
@@ -98,6 +98,7 @@ namespace Microsoft.Terminal.Settings.Model
         INHERITABLE_SETTING(IVector<NewTabMenuEntry>, NewTabMenu);
         INHERITABLE_SETTING(Boolean, EnableColorSelection);
         INHERITABLE_SETTING(Boolean, IsolatedMode);
+        INHERITABLE_SETTING(Boolean, AllowHeadless);
 
         Windows.Foundation.Collections.IMapView<String, ColorScheme> ColorSchemes();
         void AddColorScheme(ColorScheme scheme);
diff --git a/src/cascadia/TerminalSettingsModel/MTSMSettings.h b/src/cascadia/TerminalSettingsModel/MTSMSettings.h
@@ -63,6 +63,7 @@ Author(s):
     X(bool, TrimPaste, "trimPaste", true)                                                                                                                                                             \
     X(bool, EnableColorSelection, "experimental.enableColorSelection", false)                                                                                                                         \
     X(winrt::Windows::Foundation::Collections::IVector<Model::NewTabMenuEntry>, NewTabMenu, "newTabMenu", winrt::single_threaded_vector<Model::NewTabMenuEntry>({ Model::RemainingProfilesEntry{} })) \
+    X(bool, AllowHeadless, "compatibility.allowHeadless", true)                                                                                                                                       \
     X(bool, IsolatedMode, "compatibility.isolatedMode", false)
 
 #define MTSM_PROFILE_SETTINGS(X)                                                                                                                               \
diff --git a/src/cascadia/WindowsTerminal/WindowEmperor.cpp b/src/cascadia/WindowsTerminal/WindowEmperor.cpp
@@ -151,7 +151,11 @@ void WindowEmperor::CreateNewWindowThread(Remoting::WindowRequestedArgs args, co
                        }),
                        _windows.end());
 
-        if (_windows.size() == 0)
+        // When we run out of windows, exit our process if and only if:
+        // * We're not allowed to run headless OR
+        // * we've explicitly been told to "quit", which should fully exit the Terminal.
+        if (_windows.size() == 0 &&
+            (_quitting || !_app.Logic().AllowHeadless()))
         {
             _close();
         }
@@ -232,6 +236,8 @@ void WindowEmperor::_numberOfWindowsChanged(const winrt::Windows::Foundation::II
 void WindowEmperor::_quitAllRequested(const winrt::Windows::Foundation::IInspectable&,
                                       const winrt::Microsoft::Terminal::Remoting::QuitAllRequestedArgs& args)
 {
+    _quitting = true;
+
     // Make sure that the current timer is destroyed so that it doesn't attempt
     // to run while we are in the middle of quitting.
     if (_getWindowLayoutThrottler.has_value())
diff --git a/src/cascadia/WindowsTerminal/WindowEmperor.h b/src/cascadia/WindowsTerminal/WindowEmperor.h
@@ -49,6 +49,7 @@ class WindowEmperor
     std::vector<winrt::Microsoft::Terminal::Settings::Model::GlobalSummonArgs> _hotkeys;
 
     std::unique_ptr<NotificationIcon> _notificationIcon;
+    bool _quitting{ false };
 
     void _becomeMonarch();
     void _numberOfWindowsChanged(const winrt::Windows::Foundation::IInspectable&, const winrt::Windows::Foundation::IInspectable&);

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,6 @@ namespace Microsoft.Terminal.Settings.Model`
`48`	`48`
`49`	`49`	`static void ExpandCommands(Windows.Foundation.Collections.IMap<String, Command> commands,`
`50`	`50`	`Windows.Foundation.Collections.IVectorView<Profile> profiles,`
`51`		`- Windows.Foundation.Collections.IVectorView<ColorScheme> schemes,`
`52`		`- Windows.Foundation.Collections.IVector<SettingsLoadWarnings> warnings);`
	`51`	`+ Windows.Foundation.Collections.IVectorView<ColorScheme> schemes);`
`53`	`52`	`}`
`54`	`53`	`}`