Add support for running the terminal core as a content process

.github/actions/spelling/allow/apis.txt

@@ -17,6 +17,7 @@ CLASSNOTAVAILABLE
 cmdletbinding
 COLORPROPERTY
 colspan
+combase
 COMDLG
 commandlinetoargv
 comparand

scratch/ScratchIslandApp/SampleApp/MyPage.cpp

@@ -3,9 +3,11 @@
 
 #include "pch.h"
 #include "MyPage.h"
+#include "MySettings.h"
 #include <LibraryResources.h>
 #include "MyPage.g.cpp"
-#include "MySettings.h"
+#include "..\..\..\src\cascadia\UnitTests_Control\MockControlSettings.h"
+#include "..\..\..\src\types\inc\utils.hpp"
 
 using namespace std::chrono_literals;
 using namespace winrt::Microsoft::Terminal;
@@ -26,7 +28,7 @@ namespace winrt::SampleApp::implementation
 
     void MyPage::Create()
     {
-        auto settings = winrt::make_self<implementation::MySettings>();
+        auto settings = winrt::make_self<MySettings>();
 
         auto connectionSettings{ TerminalConnection::ConptyConnection::CreateSettings(L"cmd.exe /k echo This TermControl is hosted in-proc...",
                                                                                       winrt::hstring{},
@@ -44,6 +46,216 @@ namespace winrt::SampleApp::implementation
         Control::TermControl control{ *settings, *settings, conn };
 
         InProcContent().Children().Append(control);
+
+        // Once the control loads (and not before that), write some text for debugging:
+        control.Initialized([conn](auto&&, auto&&) {
+            conn.WriteInput(L"This TermControl is hosted in-proc...");
+        });
+    }
+
+    static wil::unique_process_information _createHostClassProcess(const winrt::guid& g)
+    {
+        auto guidStr{ ::Microsoft::Console::Utils::GuidToString(g) };
+
+        // Create an event that the content process will use to signal it is
+        // ready to go. We won't need the event after this function, so the
+        // unique_event will clean up our handle when we leave this scope. The
+        // ContentProcess is responsible for cleaning up its own handle.
+        wil::unique_event ev{ CreateEvent(nullptr, true, false, L"contentProcessStarted") };
+        // Make sure to mark this handle as inheritable! Even with
+        // bInheritHandles=true, this is only inherited when it's explicitly
+        // allowed to be.
+        SetHandleInformation(ev.get(), HANDLE_FLAG_INHERIT, 1);
+
+        // god bless, fmt::format will format a HANDLE like `0xa80`
+        std::wstring commandline{
+            fmt::format(L"WindowsTerminal.exe --content {} --signal {}", guidStr, ev.get())
+        };
+
+        STARTUPINFO siOne{ 0 };
+        siOne.cb = sizeof(STARTUPINFOW);
+        wil::unique_process_information piOne;
+        auto succeeded = CreateProcessW(
+            nullptr,
+            commandline.data(),
+            nullptr, // lpProcessAttributes
+            nullptr, // lpThreadAttributes
+            true, // bInheritHandles
+            CREATE_UNICODE_ENVIRONMENT, // dwCreationFlags
+            nullptr, // lpEnvironment
+            nullptr, // startingDirectory
+            &siOne, // lpStartupInfo
+            &piOne // lpProcessInformation
+        );
+        THROW_IF_WIN32_BOOL_FALSE(succeeded);
+
+        // Wait for the child process to signal that they're ready.
+        WaitForSingleObject(ev.get(), INFINITE);
+
+        return std::move(piOne);
+    }
+
+    winrt::fire_and_forget MyPage::_writeToLog(std::wstring_view str)
+    {
+        winrt::hstring copy{ str };
+        // Switch back to the UI thread.
+        co_await resume_foreground(Dispatcher());
+        winrt::WUX::Controls::TextBlock block;
+        block.Text(copy);
+        Log().Children().Append(block);
+    }
+
+    winrt::fire_and_forget MyPage::CreateClicked(const IInspectable& sender,
+                                                 const WUX::Input::TappedRoutedEventArgs& eventArgs)
+    {
+        auto guidString = GuidInput().Text();
+
+        // Capture calling context.
+        winrt::apartment_context ui_thread;
+
+        auto canConvert = guidString.size() == 38 &&
+                          guidString.front() == '{' &&
+                          guidString.back() == '}';
+        bool tryingToAttach = false;
+        winrt::guid contentGuid{ ::Microsoft::Console::Utils::CreateGuid() };
+
+        if (canConvert)
+        {
+            GUID result{};
+            if (SUCCEEDED(IIDFromString(guidString.c_str(), &result)))
+            {
+                contentGuid = result;
+                tryingToAttach = true;
+            }
+        }
+        _writeToLog(tryingToAttach ? L"Attaching to existing content process" : L"Creating new content process");
+
+        co_await winrt::resume_background();
+        if (!tryingToAttach)
+        {
+            // Spawn a wt.exe, with the guid on the commandline
+            piContentProcess = std::move(_createHostClassProcess(contentGuid));
+        }
+
+        // THIS MUST TAKE PLACE AFTER _createHostClassProcess.
+        // * If we're creating a new OOP control, _createHostClassProcess will
+        //   spawn the process that will actually host the ContentProcess
+        //   object.
+        // * If we're attaching, then that process already exists.
+        Control::ContentProcess content{ nullptr };
+        try
+        {
+            content = create_instance<Control::ContentProcess>(contentGuid, CLSCTX_LOCAL_SERVER);
+        }
+        catch (winrt::hresult_error hr)
+        {
+            _writeToLog(L"CreateInstance the ContentProcess object");
+            _writeToLog(fmt::format(L"    HR ({}): {}", hr.code(), hr.message().c_str()));
+            co_return; // be sure to co_return or we'll fall through to the part where we clear the log
+        }
+
+        if (content == nullptr)
+        {
+            _writeToLog(L"Failed to connect to the ContentProcess object. It may not have been started fast enough.");
+            co_return; // be sure to co_return or we'll fall through to the part where we clear the log
+        }
+
+        TerminalConnection::ConnectionInformation connectInfo{ nullptr };
+        Control::IControlSettings settings{ *winrt::make_self<implementation::MySettings>() };
+
+        // When creating a terminal for the first time, pass it a connection
+        // info
+        //
+        // otherwise, when attaching to an existing one, just pass null, because
+        // we don't need the connection info.
+        if (!tryingToAttach)
+        {
+            auto connectionSettings{ TerminalConnection::ConptyConnection::CreateSettings(L"cmd.exe /k echo This TermControl is hosted out-of-proc...",
+                                                                                          winrt::hstring{},
+                                                                                          L"",
+                                                                                          nullptr,
+                                                                                          32,
+                                                                                          80,
+                                                                                          winrt::guid()) };
+
+            // "Microsoft.Terminal.TerminalConnection.ConptyConnection"
+            winrt::hstring myClass{ winrt::name_of<TerminalConnection::ConptyConnection>() };
+            connectInfo = TerminalConnection::ConnectionInformation(myClass, connectionSettings);
+
+            if (!content.Initialize(settings, settings, connectInfo))
+            {
+                _writeToLog(L"Failed to Initialize the ContentProcess object.");
+                co_return; // be sure to co_return or we'll fall through to the part where we clear the log
+            }
+        }
+        else
+        {
+            // If we're attaching, we don't really need to do anything special.
+        }
+
+        // Switch back to the UI thread.
+        co_await ui_thread;
+
+        // Create the XAML control that will be attached to the content process.
+        // We're not passing in a connection, because the contentGuid will be used instead.
+        Control::TermControl control{ contentGuid, settings, settings, nullptr };
+        auto weakControl = winrt::make_weak(control);
+        control.RaiseNotice([this](auto&&, auto& args) {
+            _writeToLog(L"Content process died, probably.");
+            _writeToLog(args.Message());
+            OutOfProcContent().Children().Clear();
+            GuidInput().Text(L"");
+            if (piContentProcess.hProcess)
+            {
+                piContentProcess.reset();
+            }
+        });
+        control.ConnectionStateChanged([this, weakControl](auto&&, auto&) {
+            if (auto strongControl{ weakControl.get() })
+            {
+                const auto newConnectionState = strongControl.ConnectionState();
+                if (newConnectionState == TerminalConnection::ConnectionState::Closed)
+                {
+                    _writeToLog(L"Connection was closed");
+                    OutOfProcContent().Children().Clear();
+                    GuidInput().Text(L"");
+                    if (piContentProcess.hProcess)
+                    {
+                        piContentProcess.reset();
+                    }
+                }
+            }
+        });
+
+        Log().Children().Clear();
+        OutOfProcContent().Children().Append(control);
+
+        if (!tryingToAttach)
+        {
+            auto guidStr{ ::Microsoft::Console::Utils::GuidToString(contentGuid) };
+            GuidInput().Text(guidStr);
+        }
+    }
+
+    void MyPage::CloseClicked(const IInspectable& /*sender*/,
+                              const WUX::Input::TappedRoutedEventArgs& /*eventArgs*/)
+    {
+        OutOfProcContent().Children().Clear();
+        GuidInput().Text(L"");
+        if (piContentProcess.hProcess)
+        {
+            piContentProcess.reset();
+        }
+    }
+
+    void MyPage::KillClicked(const IInspectable& /*sender*/,
+                             const WUX::Input::TappedRoutedEventArgs& /*eventArgs*/)
+    {
+        if (piContentProcess.hProcess)
+        {
+            TerminateProcess(piContentProcess.hProcess, (UINT)-1);
+            piContentProcess.reset();
+        }
     }
 
     // Method Description:

scratch/ScratchIslandApp/SampleApp/MyPage.h

@@ -14,11 +14,18 @@ namespace winrt::SampleApp::implementation
         MyPage();
 
         void Create();
-
         hstring Title();
 
+        winrt::fire_and_forget CreateClicked(const IInspectable& sender, const Windows::UI::Xaml::Input::TappedRoutedEventArgs& eventArgs);
+        void CloseClicked(const IInspectable& sender, const Windows::UI::Xaml::Input::TappedRoutedEventArgs& eventArgs);
+        void KillClicked(const IInspectable& sender, const Windows::UI::Xaml::Input::TappedRoutedEventArgs& eventArgs);
+
     private:
         friend struct MyPageT<MyPage>; // for Xaml to bind events
+
+        wil::unique_process_information piContentProcess;
+
+        winrt::fire_and_forget _writeToLog(std::wstring_view str);
     };
 }
 

scratch/ScratchIslandApp/SampleApp/MyPage.xaml

@@ -23,9 +23,23 @@
             <TextBox x:Name="GuidInput"
                      Width="400"
                      PlaceholderText="{}{guid here}" />
-            <Button Grid.Row="0">
+            <Button x:Name="CreateOutOfProcControl"
+                    Grid.Row="0"
+                    Tapped="CreateClicked">
                 Create
             </Button>
+            <Button x:Name="CloseOutOfProcControl"
+                    Grid.Row="0"
+                    Margin="4,0,0,0"
+                    Tapped="CloseClicked">
+                Close
+            </Button>
+            <Button x:Name="KillOutOfProcControl"
+                    Grid.Row="0"
+                    Margin="4,0,0,0"
+                    Tapped="KillClicked">
+                Kill
+            </Button>
 
         </StackPanel>
 
@@ -46,14 +60,26 @@
                   VerticalAlignment="Stretch"
                   Background="#ff0000" />
 
-            <Grid x:Name="OutOfProcContent"
-                  Grid.Column="1"
-                  Padding="16"
+            <Grid Grid.Column="1"
                   HorizontalAlignment="Stretch"
-                  VerticalAlignment="Stretch"
-                  Background="#0000ff" />
+                  VerticalAlignment="Stretch">
+
+                <Grid.RowDefinitions>
+                    <RowDefinition Height="Auto" />
+                    <RowDefinition Height="*" />
+                </Grid.RowDefinitions>
 
+                <StackPanel x:Name="Log"
+                            Grid.Row="0"
+                            Orientation="Vertical" />
 
+                <Grid x:Name="OutOfProcContent"
+                      Grid.Row="1"
+                      Padding="16"
+                      HorizontalAlignment="Stretch"
+                      VerticalAlignment="Stretch"
+                      Background="#0000ff" />
+            </Grid>
 
         </Grid>
 

scratch/ScratchIslandApp/SampleApp/SampleAppLib.vcxproj

@@ -17,9 +17,15 @@
     <DisableEmbeddedXbf>false</DisableEmbeddedXbf>
     <XamlComponentResourceLocation>nested</XamlComponentResourceLocation>
   </PropertyGroup>
+
+  <PropertyGroup Label="NuGet Dependencies">
+    <TerminalCppWinrt>true</TerminalCppWinrt>
+    <TerminalXamlApplicationToolkit>true</TerminalXamlApplicationToolkit>
+  </PropertyGroup>
   <Import Project="..\..\..\common.openconsole.props" Condition="'$(OpenConsoleDir)'==''" />
+  <Import Project="$(OpenConsoleDir)src\common.nugetversions.props" />
   <Import Project="$(OpenConsoleDir)src\cppwinrt.build.pre.props" />
-  <Import Project="..\..\..\packages\Microsoft.Toolkit.Win32.UI.XamlApplication.6.1.3\build\native\Microsoft.Toolkit.Win32.UI.XamlApplication.props" Condition="Exists('..\..\..\packages\Microsoft.Toolkit.Win32.UI.XamlApplication.6.1.3\build\native\Microsoft.Toolkit.Win32.UI.XamlApplication.props')" />
+
   <ItemDefinitionGroup>
 
     <ClCompile>
@@ -147,14 +153,15 @@
   <!-- ========================= Globals ======================== -->
   <Import Project="$(OpenConsoleDir)src\cppwinrt.build.post.props" />
 
-  <Import Project="..\..\..\packages\Microsoft.UI.Xaml.2.7.1\build\native\Microsoft.UI.Xaml.targets" Condition="Exists('..\..\..\packages\Microsoft.UI.Xaml.2.7.1\build\native\Microsoft.UI.Xaml.targets')" />
-  <Import Project="..\..\..\packages\Microsoft.Toolkit.Win32.UI.XamlApplication.6.1.3\build\native\Microsoft.Toolkit.Win32.UI.XamlApplication.targets" Condition="Exists('..\..\..\packages\Microsoft.Toolkit.Win32.UI.XamlApplication.6.1.3\build\native\Microsoft.Toolkit.Win32.UI.XamlApplication.targets')" />
+  <!-- This -must- go after cppwinrt.build.post.props because that includes many VS-provided props including appcontainer.common.props, which stomps on what cppwinrt.targets did. -->
+  <Import Project="$(OpenConsoleDir)src\common.nugetversions.targets" />
+
+  <Import Project="$(OpenConsoleDir)packages\Microsoft.UI.Xaml.2.7.1\build\native\Microsoft.UI.Xaml.targets" Condition="Exists('$(OpenConsoleDir)packages\Microsoft.UI.Xaml.2.7.1\build\native\Microsoft.UI.Xaml.targets')" />
   <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
     <PropertyGroup>
       <ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them.  For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
     </PropertyGroup>
-    <Error Condition="!Exists('$(OpenConsoleDir)\packages\Microsoft.UI.Xaml.2.7.1\build\native\Microsoft.UI.Xaml.targets')" Text="$([System.String]::Format('$(ErrorText)', '$(OpenConsoleDir)\packages\Microsoft.UI.Xaml.2.7.1\build\native\Microsoft.UI.Xaml.targets'))" />
-    <Error Condition="!Exists('$(OpenConsoleDir)\packages\Microsoft.Toolkit.Win32.UI.XamlApplication.6.1.3\build\native\Microsoft.Toolkit.Win32.UI.XamlApplication.targets')" Text="$([System.String]::Format('$(ErrorText)', '$(OpenConsoleDir)\packages\Microsoft.Toolkit.Win32.UI.XamlApplication.6.1.3\build\native\Microsoft.Toolkit.Win32.UI.XamlApplication.targets'))" />
+    <Error Condition="!Exists('$(OpenConsoleDir)packages\Microsoft.UI.Xaml.2.7.1\build\native\Microsoft.UI.Xaml.targets')" Text="$([System.String]::Format('$(ErrorText)', '$(OpenConsoleDir)\packages\Microsoft.UI.Xaml.2.7.1\build\native\Microsoft.UI.Xaml.targets'))" />
   </Target>
 
   <!--

scratch/ScratchIslandApp/SampleApp/dll/SampleApp.vcxproj

@@ -11,9 +11,13 @@
     <!-- sets a bunch of Windows Universal properties -->
     <OpenConsoleUniversalApp>true</OpenConsoleUniversalApp>
   </PropertyGroup>
+  <PropertyGroup Label="NuGet Dependencies">
+    <TerminalCppWinrt>true</TerminalCppWinrt>
+    <TerminalXamlApplicationToolkit>true</TerminalXamlApplicationToolkit>
+  </PropertyGroup>
   <Import Project="..\..\..\..\common.openconsole.props" Condition="'$(OpenConsoleDir)'==''" />
+  <Import Project="$(OpenConsoleDir)src\common.nugetversions.props" />
   <Import Project="$(OpenConsoleDir)src\cppwinrt.build.pre.props" />
-  <Import Project="$(OpenConsoleDir)packages\Microsoft.Toolkit.Win32.UI.XamlApplication.6.1.3\build\native\Microsoft.Toolkit.Win32.UI.XamlApplication.props" Condition="Exists('$(OpenConsoleDir)packages\Microsoft.Toolkit.Win32.UI.XamlApplication.6.1.3\build\native\Microsoft.Toolkit.Win32.UI.XamlApplication.props')" />
   <!-- ========================= XAML files ======================== -->
   <ItemGroup>
     <!-- DON'T PUT XAML FILES HERE! Put them in SampleAppLib.vcxproj -->
@@ -81,13 +85,11 @@
 
 
   <Import Project="$(OpenConsoleDir)packages\Microsoft.UI.Xaml.2.7.1\build\native\Microsoft.UI.Xaml.targets" Condition="Exists('$(OpenConsoleDir)packages\Microsoft.UI.Xaml.2.7.1\build\native\Microsoft.UI.Xaml.targets')" />
-  <Import Project="$(OpenConsoleDir)packages\Microsoft.Toolkit.Win32.UI.XamlApplication.6.1.3\build\native\Microsoft.Toolkit.Win32.UI.XamlApplication.targets" Condition="Exists('$(OpenConsoleDir)packages\Microsoft.Toolkit.Win32.UI.XamlApplication.6.1.3\build\native\Microsoft.Toolkit.Win32.UI.XamlApplication.targets')" />
   <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
     <PropertyGroup>
       <ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them.  For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
     </PropertyGroup>
     <Error Condition="!Exists('$(OpenConsoleDir)\packages\Microsoft.UI.Xaml.2.7.1\build\native\Microsoft.UI.Xaml.targets')" Text="$([System.String]::Format('$(ErrorText)', '$(OpenConsoleDir)\packages\Microsoft.UI.Xaml.2.7.1\build\native\Microsoft.UI.Xaml.targets'))" />
-    <Error Condition="!Exists('$(OpenConsoleDir)\packages\Microsoft.Toolkit.Win32.UI.XamlApplication.6.1.3\build\native\Microsoft.Toolkit.Win32.UI.XamlApplication.targets')" Text="$([System.String]::Format('$(ErrorText)', '$(OpenConsoleDir)\packages\Microsoft.Toolkit.Win32.UI.XamlApplication.6.1.3\build\native\Microsoft.Toolkit.Win32.UI.XamlApplication.targets'))" />
   </Target>
 
   <ItemDefinitionGroup>
@@ -102,4 +104,7 @@
     </Link>
   </ItemDefinitionGroup>
   <Import Project="$(OpenConsoleDir)src\cppwinrt.build.post.props" />
+
+  <!-- This -must- go after cppwinrt.build.post.props because that includes many VS-provided props including appcontainer.common.props, which stomps on what cppwinrt.targets did. -->
+  <Import Project="$(OpenConsoleDir)src\common.nugetversions.targets" />
 </Project>