Add multi window layout saving

- Monarch will now gather and save all window layouts on a timer
- When loading, the first window/monarch will create a new window for each saved layout

src/cascadia/Remoting/GetWindowLayoutArgs.cpp

@@ -0,0 +1,5 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+#include "pch.h"
+#include "GetWindowLayoutArgs.h"
+#include "GetWindowLayoutArgs.g.cpp"

src/cascadia/Remoting/GetWindowLayoutArgs.h

@@ -0,0 +1,32 @@
+/*++
+Copyright (c) Microsoft Corporation
+Licensed under the MIT license.
+
+Class Name:
+- GetWindowLayoutArgs.h
+
+Abstract:
+- This is a helper class for getting the window layout from a peasant.
+  Depending on if we are running on the monarch or on a peasant we might need
+  to switch what thread we are executing on. This gives us the option of
+  either returning the json result synchronously, or as a promise.
+--*/
+
+#pragma once
+
+#include "GetWindowLayoutArgs.g.h"
+#include "../cascadia/inc/cppwinrt_utils.h"
+
+namespace winrt::Microsoft::Terminal::Remoting::implementation
+{
+    struct GetWindowLayoutArgs : public GetWindowLayoutArgsT<GetWindowLayoutArgs>
+    {
+        WINRT_PROPERTY(winrt::hstring, WindowLayoutJson, L"");
+        WINRT_PROPERTY(winrt::Windows::Foundation::IAsyncOperation<winrt::hstring>, WindowLayoutJsonAsync, nullptr)
+    };
+}
+
+namespace winrt::Microsoft::Terminal::Remoting::factory_implementation
+{
+    BASIC_FACTORY(GetWindowLayoutArgs);
+}

src/cascadia/Remoting/Microsoft.Terminal.RemotingLib.vcxproj

@@ -12,7 +12,6 @@
   </PropertyGroup>
   <Import Project="..\..\..\common.openconsole.props" Condition="'$(OpenConsoleDir)'==''" />
   <Import Project="$(OpenConsoleDir)src\cppwinrt.build.pre.props" />
-
   <!-- ========================= Headers ======================== -->
   <ItemGroup>
     <ClInclude Include="Monarch.h">
@@ -36,6 +35,9 @@
     <ClInclude Include="WindowActivatedArgs.h">
       <DependentUpon>Peasant.idl</DependentUpon>
     </ClInclude>
+    <ClInclude Include="GetWindowLayoutArgs.h">
+      <DependentUpon>Peasant.idl</DependentUpon>
+    </ClInclude>
     <ClInclude Include="pch.h" />
     <ClInclude Include="MonarchFactory.h" />
     <ClInclude Include="Peasant.h">
@@ -71,6 +73,9 @@
     <ClCompile Include="WindowActivatedArgs.cpp">
       <DependentUpon>Peasant.idl</DependentUpon>
     </ClCompile>
+    <ClCompile Include="GetWindowLayoutArgs.cpp">
+      <DependentUpon>Peasant.idl</DependentUpon>
+    </ClCompile>
     <ClCompile Include="pch.cpp">
       <PrecompiledHeader>Create</PrecompiledHeader>
     </ClCompile>
@@ -128,6 +133,5 @@
   </ItemDefinitionGroup>
   <!-- ========================= Globals ======================== -->
   <Import Project="$(OpenConsoleDir)src\cppwinrt.build.post.props" />
-
   <Import Project="$(SolutionDir)build\rules\CollectWildcardResources.targets" />
-</Project>
+</Project>

src/cascadia/Remoting/Monarch.cpp

@@ -897,4 +897,29 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
         };
         _forAllPeasantsIgnoringTheDead(callback, onError);
     }
+
+    // Method Description:
+    // - Ask all peasants to return their window layout as json
+    // Arguments:
+    // - <none>
+    // Return Value:
+    // - The collection of window layouts from each peasant.
+    Windows::Foundation::Collections::IVector<winrt::hstring> Monarch::GetAllWindowLayouts()
+    {
+        auto vec = winrt::single_threaded_vector<winrt::hstring>();
+        auto callback = [&](auto&& p, auto&& /*id*/) {
+            auto layout = p.GetWindowLayout();
+            vec.Append(layout);
+        };
+        auto onError = [](auto&& id) {
+            TraceLoggingWrite(g_hRemotingProvider,
+                              "Monarch_GetAllWindowLayouts_Failed",
+                              TraceLoggingInt64(id, "peasantID", "The ID of the peasant which we could not get a window layout from"),
+                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                              TraceLoggingKeyword(TIL_KEYWORD_TRACE));
+        };
+        _forAllPeasantsIgnoringTheDead(callback, onError);
+
+        return vec;
+    }
 }

src/cascadia/Remoting/Monarch.h

@@ -57,6 +57,7 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
 
         void SummonAllWindows();
         Windows::Foundation::Collections::IMapView<uint64_t, winrt::hstring> GetPeasantNames();
+        Windows::Foundation::Collections::IVector<winrt::hstring> GetAllWindowLayouts();
 
         TYPED_EVENT(FindTargetWindowRequested, winrt::Windows::Foundation::IInspectable, winrt::Microsoft::Terminal::Remoting::FindTargetWindowArgs);
         TYPED_EVENT(ShowTrayIconRequested, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable);

src/cascadia/Remoting/Monarch.idl

@@ -31,7 +31,6 @@ namespace Microsoft.Terminal.Remoting
         Windows.Foundation.IReference<UInt64> WindowID;
     }
 
-
     [default_interface] runtimeclass Monarch {
         Monarch();
 
@@ -45,6 +44,7 @@ namespace Microsoft.Terminal.Remoting
 
         void SummonAllWindows();
         Windows.Foundation.Collections.IMapView<UInt64, String> GetPeasantNames { get; };
+        Windows.Foundation.Collections.IVector<String> GetAllWindowLayouts();
 
         event Windows.Foundation.TypedEventHandler<Object, FindTargetWindowArgs> FindTargetWindowRequested;
         event Windows.Foundation.TypedEventHandler<Object, Object> ShowTrayIconRequested;

src/cascadia/Remoting/Peasant.cpp

@@ -5,6 +5,7 @@
 #include "Peasant.h"
 #include "CommandlineArgs.h"
 #include "SummonWindowBehavior.h"
+#include "GetWindowLayoutArgs.h"
 #include "Peasant.g.cpp"
 #include "../../types/inc/utils.hpp"
 
@@ -257,4 +258,24 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
                           TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
                           TraceLoggingKeyword(TIL_KEYWORD_TRACE));
     }
+
+    // Method Description:
+    // - Request and return the window layout from the current TerminalPage
+    // Arguments:
+    // - <none>
+    // Return Value:
+    // - the window layout as a json string
+    hstring Peasant::GetWindowLayout()
+    {
+        auto args = winrt::make_self<implementation::GetWindowLayoutArgs>();
+        _GetWindowLayoutRequestedHandlers(nullptr, *args);
+        if (const auto op = args->WindowLayoutJsonAsync())
+        {
+            // This will fail if called on the UI thread, so the monarch should
+            // never set WindowLayoutJsonAsync.
+            auto str = op.get();
+            return str;
+        }
+        return args->WindowLayoutJson();
+    }
 }

src/cascadia/Remoting/Peasant.h

@@ -34,6 +34,9 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
         winrt::Microsoft::Terminal::Remoting::WindowActivatedArgs GetLastActivatedArgs();
 
         winrt::Microsoft::Terminal::Remoting::CommandlineArgs InitialArgs();
+
+        winrt::hstring GetWindowLayout();
+
         WINRT_PROPERTY(winrt::hstring, WindowName);
 
         TYPED_EVENT(WindowActivated, winrt::Windows::Foundation::IInspectable, winrt::Microsoft::Terminal::Remoting::WindowActivatedArgs);
@@ -44,6 +47,7 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
         TYPED_EVENT(SummonRequested, winrt::Windows::Foundation::IInspectable, winrt::Microsoft::Terminal::Remoting::SummonWindowBehavior);
         TYPED_EVENT(ShowTrayIconRequested, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable);
         TYPED_EVENT(HideTrayIconRequested, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable);
+        TYPED_EVENT(GetWindowLayoutRequested, winrt::Windows::Foundation::IInspectable, winrt::Microsoft::Terminal::Remoting::GetWindowLayoutArgs);
 
     private:
         Peasant(const uint64_t testPID);

src/cascadia/Remoting/Peasant.idl

@@ -30,6 +30,11 @@ namespace Microsoft.Terminal.Remoting
         Windows.Foundation.DateTime ActivatedTime { get; };
     };
 
+	[default_interface] runtimeclass GetWindowLayoutArgs {
+        GetWindowLayoutArgs();
+        String WindowLayoutJson;
+        Windows.Foundation.IAsyncOperation<String> WindowLayoutJsonAsync;
+	}
 
     enum MonitorBehavior
     {
@@ -66,6 +71,7 @@ namespace Microsoft.Terminal.Remoting
         void Summon(SummonWindowBehavior behavior);
         void RequestShowTrayIcon();
         void RequestHideTrayIcon();
+        String GetWindowLayout();
 
         event Windows.Foundation.TypedEventHandler<Object, WindowActivatedArgs> WindowActivated;
         event Windows.Foundation.TypedEventHandler<Object, CommandlineArgs> ExecuteCommandlineRequested;
@@ -75,6 +81,7 @@ namespace Microsoft.Terminal.Remoting
         event Windows.Foundation.TypedEventHandler<Object, SummonWindowBehavior> SummonRequested;
         event Windows.Foundation.TypedEventHandler<Object, Object> ShowTrayIconRequested;
         event Windows.Foundation.TypedEventHandler<Object, Object> HideTrayIconRequested;
+        event Windows.Foundation.TypedEventHandler<Object, GetWindowLayoutArgs> GetWindowLayoutRequested;
     };
 
     [default_interface] runtimeclass Peasant : IPeasant

src/cascadia/Remoting/WindowManager.cpp

@@ -319,6 +319,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
             }
         }
 
+        _peasant.GetWindowLayoutRequested({ get_weak(), &WindowManager::_GetWindowLayoutRequestedHandlers });
+
         TraceLoggingWrite(g_hRemotingProvider,
                           "WindowManager_CreateOurPeasant",
                           TraceLoggingUInt64(_peasant.GetID(), "peasantID", "The ID of our new peasant"),
@@ -591,4 +593,12 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
         return false;
     }
 
+    Windows::Foundation::Collections::IVector<winrt::hstring> WindowManager::GetAllWindowLayouts()
+    {
+        if (_monarch)
+        {
+            return _monarch.GetAllWindowLayouts();
+        }
+        return nullptr;
+    }
 }

src/cascadia/Remoting/WindowManager.h

@@ -48,13 +48,15 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
         void RequestShowTrayIcon();
         void RequestHideTrayIcon();
         bool DoesQuakeWindowExist();
+        Windows::Foundation::Collections::IVector<winrt::hstring> GetAllWindowLayouts();
 
         TYPED_EVENT(FindTargetWindowRequested, winrt::Windows::Foundation::IInspectable, winrt::Microsoft::Terminal::Remoting::FindTargetWindowArgs);
         TYPED_EVENT(BecameMonarch, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable);
         TYPED_EVENT(WindowCreated, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable);
         TYPED_EVENT(WindowClosed, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable);
         TYPED_EVENT(ShowTrayIconRequested, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable);
         TYPED_EVENT(HideTrayIconRequested, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable);
+        TYPED_EVENT(GetWindowLayoutRequested, winrt::Windows::Foundation::IInspectable, winrt::Microsoft::Terminal::Remoting::GetWindowLayoutArgs);
 
     private:
         bool _shouldCreateWindow{ false };

src/cascadia/Remoting/WindowManager.idl

@@ -16,6 +16,8 @@ namespace Microsoft.Terminal.Remoting
         void SummonAllWindows();
         void RequestShowTrayIcon();
         void RequestHideTrayIcon();
+        Windows.Foundation.Collections.IVector<String> GetAllWindowLayouts();
+
         UInt64 GetNumberOfPeasants();
         Boolean DoesQuakeWindowExist();
         Windows.Foundation.Collections.IMapView<UInt64, String> GetPeasantNames();
@@ -25,5 +27,6 @@ namespace Microsoft.Terminal.Remoting
         event Windows.Foundation.TypedEventHandler<Object, Object> WindowClosed;
         event Windows.Foundation.TypedEventHandler<Object, Object> ShowTrayIconRequested;
         event Windows.Foundation.TypedEventHandler<Object, Object> HideTrayIconRequested;
+        event Windows.Foundation.TypedEventHandler<Object, GetWindowLayoutArgs> GetWindowLayoutRequested;
     };
 }

src/cascadia/TerminalApp/AppCommandlineArgs.cpp

@@ -187,6 +187,10 @@ void AppCommandlineArgs::_buildParser()
                     _windowTarget,
                     RS_A(L"CmdWindowTargetArgDesc"));
 
+    _app.add_option("-s,--saved",
+                    _loadPersistedLayoutIdx,
+                    RS_A(L"CmdSavedLayoutArgDesc"));
+
     // Subcommands
     _buildNewTabParser();
     _buildSplitPaneParser();
@@ -908,6 +912,12 @@ void AppCommandlineArgs::ValidateStartupCommands()
         }
     }
 }
+std::optional<uint32_t> AppCommandlineArgs::GetPersistedLayoutIdx() const noexcept
+{
+    return _loadPersistedLayoutIdx >= 0 ?
+               std::optional{ static_cast<uint32_t>(_loadPersistedLayoutIdx) } :
+               std::nullopt;
+}
 
 std::optional<winrt::Microsoft::Terminal::Settings::Model::LaunchMode> AppCommandlineArgs::GetLaunchMode() const noexcept
 {

src/cascadia/TerminalApp/AppCommandlineArgs.h

@@ -39,6 +39,7 @@ class TerminalApp::AppCommandlineArgs final
     const std::string& GetExitMessage();
     bool ShouldExitEarly() const noexcept;
 
+    std::optional<uint32_t> GetPersistedLayoutIdx() const noexcept;
     std::optional<winrt::Microsoft::Terminal::Settings::Model::LaunchMode> GetLaunchMode() const noexcept;
 
     int ParseArgs(const winrt::Microsoft::Terminal::Settings::Model::ExecuteCommandlineArgs& args);
@@ -123,6 +124,7 @@ class TerminalApp::AppCommandlineArgs final
     std::string _exitMessage;
     bool _shouldExitEarly{ false };
 
+    int _loadPersistedLayoutIdx{};
     std::string _windowTarget{};
     // Are you adding more args or attributes here? If they are not reset in _resetStateToDefault, make sure to reset them in FullResetState