Add support for displaying the version with wt --version

src/cascadia/TerminalApp/AppCommandlineArgs.cpp

@@ -18,6 +18,22 @@ AppCommandlineArgs::AppCommandlineArgs()
     _resetStateToDefault();
 }
 
+// Method Description:
+// - Set the application name and version string for the application. If the
+//   user calls `wt --version`, we'll display these strings by setting the exit
+//   message (the string returned by GetExitMessage).
+// Arguments:
+// - applicationName: a hstring containing the application name
+// - versionString: a hstring containing the version string
+// Return Value:
+// - <none>
+void AppCommandlineArgs::SetVersionString(const winrt::hstring& applicationName,
+                                          const winrt::hstring& versionString)
+{
+    _applicationName = winrt::to_string(applicationName);
+    _versionString = winrt::to_string(versionString);
+}
+
 // Method Description:
 // - Attempt to parse a given command as a single commandline. If the command
 //   doesn't have a subcommand, we'll try parsing the commandline again, as a
@@ -140,6 +156,11 @@ int AppCommandlineArgs::_handleExit(const CLI::App& command, const CLI::Error& e
     {
         _exitMessage = err.str();
     }
+
+    // We're displaying an error message - we should always exit instead of
+    // actually starting the Terminal.
+    _shouldExitEarly = true;
+
     return result;
 }
 
@@ -151,6 +172,18 @@ int AppCommandlineArgs::_handleExit(const CLI::App& command, const CLI::Error& e
 // - <none>
 void AppCommandlineArgs::_buildParser()
 {
+    auto versionCallback = [this](int64_t /*count*/) {
+        // Set our message to display the application name and the current version.
+        _exitMessage = _applicationName + "\n" + _versionString;
+
+        // Theoretically, we don't need to exit now, since this isn't really an
+        // error case. However, in practice, it feels weird to have `wt -v` open
+        // a new tab, and makes enough sense that `wt -v ; split-pane` (or
+        // whatever) just displays the version and exits.
+        _shouldExitEarly = true;
+    };
+    _app.add_flag_function("-v,--version", versionCallback, RS_A(L"CmdVersionDesc"));
+
     _buildNewTabParser();
     _buildSplitPaneParser();
     _buildFocusTabParser();
@@ -540,6 +573,19 @@ const std::string& AppCommandlineArgs::GetExitMessage()
     return _exitMessage;
 }
 
+// Method Description:
+// - Returns true if we should exit the application before even starting the
+//   window. We might want to do this if we're displaying an error message or
+//   the version string, or if we want to open the settings file.
+// Arguments:
+// - <none>
+// Return Value:
+// - true iff we should exit the application before even starting the window
+bool AppCommandlineArgs::ShouldExitEarly() const noexcept
+{
+    return _shouldExitEarly;
+}
+
 // Method Description:
 // - Ensure that the first command in our list of actions is a NewTab action.
 //   This makes sure that if the user passes a commandline like "wt split-pane

src/cascadia/TerminalApp/AppCommandlineArgs.h

@@ -36,6 +36,9 @@ class TerminalApp::AppCommandlineArgs final
     void ValidateStartupCommands();
     std::deque<winrt::TerminalApp::ActionAndArgs>& GetStartupActions();
     const std::string& GetExitMessage();
+    bool ShouldExitEarly() const noexcept;
+
+    void SetVersionString(const winrt::hstring& applicationName, const winrt::hstring& versionString);
 
 private:
     static const std::wregex _commandDelimiterRegex;
@@ -79,6 +82,9 @@ class TerminalApp::AppCommandlineArgs final
 
     std::deque<winrt::TerminalApp::ActionAndArgs> _startupActions;
     std::string _exitMessage;
+    bool _shouldExitEarly{ false };
+    std::string _applicationName{ "" };
+    std::string _versionString{ "" };
 
     winrt::TerminalApp::NewTerminalArgs _getNewTerminalArgs(NewTerminalSubcommand& subcommand);
     void _addNewTerminalArgs(NewTerminalSubcommand& subcommand);

src/cascadia/TerminalApp/AppLogic.cpp

@@ -880,15 +880,24 @@ namespace winrt::TerminalApp::implementation
         return 0;
     }
 
-    winrt::hstring AppLogic::EarlyExitMessage()
+    winrt::hstring AppLogic::ParseCommandlineMessage()
     {
         if (_root)
         {
-            return _root->EarlyExitMessage();
+            return _root->ParseCommandlineMessage();
         }
         return { L"" };
     }
 
+    bool AppLogic::ShouldExitEarly()
+    {
+        if (_root)
+        {
+            return _root->ShouldExitEarly();
+        }
+        return false;
+    }
+
     winrt::hstring AppLogic::ApplicationDisplayName() const
     {
         try

src/cascadia/TerminalApp/AppLogic.h

@@ -28,7 +28,8 @@ namespace winrt::TerminalApp::implementation
         [[nodiscard]] std::shared_ptr<::TerminalApp::CascadiaSettings> GetSettings() const noexcept;
 
         int32_t SetStartupCommandline(array_view<const winrt::hstring> actions);
-        winrt::hstring EarlyExitMessage();
+        winrt::hstring ParseCommandlineMessage();
+        bool ShouldExitEarly();
 
         winrt::hstring ApplicationDisplayName() const;
         winrt::hstring ApplicationVersion() const;

src/cascadia/TerminalApp/AppLogic.idl

@@ -13,7 +13,8 @@ namespace TerminalApp
         MaximizedMode,
     };
 
-    [default_interface] runtimeclass AppLogic: IF7Listener {
+    [default_interface] runtimeclass AppLogic : IF7Listener
+    {
         AppLogic();
 
         // For your own sanity, it's better to do setup outside the ctor.
@@ -28,7 +29,8 @@ namespace TerminalApp
         Boolean IsElevated();
 
         Int32 SetStartupCommandline(String[] commands);
-        String EarlyExitMessage { get; };
+        String ParseCommandlineMessage { get; };
+        Boolean ShouldExitEarly { get; };
 
         void LoadSettings();
         Windows.UI.Xaml.UIElement GetRoot();

src/cascadia/TerminalApp/Resources/en-US/Resources.resw

@@ -1,17 +1,17 @@
 <?xml version="1.0" encoding="utf-8"?>
 <root>
-  <!-- 
-    Microsoft ResX Schema 
-    
+  <!--
+    Microsoft ResX Schema
+
     Version 2.0
-    
-    The primary goals of this format is to allow a simple XML format 
-    that is mostly human readable. The generation and parsing of the 
-    various data types are done through the TypeConverter classes 
+
+    The primary goals of this format is to allow a simple XML format
+    that is mostly human readable. The generation and parsing of the
+    various data types are done through the TypeConverter classes
     associated with the data types.
-    
+
     Example:
-    
+
     ... ado.net/XML headers & schema ...
     <resheader name="resmimetype">text/microsoft-resx</resheader>
     <resheader name="version">2.0</resheader>
@@ -26,36 +26,36 @@
         <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
         <comment>This is a comment</comment>
     </data>
-                
-    There are any number of "resheader" rows that contain simple 
+
+    There are any number of "resheader" rows that contain simple
     name/value pairs.
-    
-    Each data row contains a name, and value. The row also contains a 
-    type or mimetype. Type corresponds to a .NET class that support 
-    text/value conversion through the TypeConverter architecture. 
-    Classes that don't support this are serialized and stored with the 
+
+    Each data row contains a name, and value. The row also contains a
+    type or mimetype. Type corresponds to a .NET class that support
+    text/value conversion through the TypeConverter architecture.
+    Classes that don't support this are serialized and stored with the
     mimetype set.
-    
-    The mimetype is used for serialized objects, and tells the 
-    ResXResourceReader how to depersist the object. This is currently not 
+
+    The mimetype is used for serialized objects, and tells the
+    ResXResourceReader how to depersist the object. This is currently not
     extensible. For a given mimetype the value must be set accordingly:
-    
-    Note - application/x-microsoft.net.object.binary.base64 is the format 
-    that the ResXResourceWriter will generate, however the reader can 
+
+    Note - application/x-microsoft.net.object.binary.base64 is the format
+    that the ResXResourceWriter will generate, however the reader can
     read any of the formats listed below.
-    
+
     mimetype: application/x-microsoft.net.object.binary.base64
-    value   : The object must be serialized with 
+    value   : The object must be serialized with
             : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
             : and then encoded with base64 encoding.
-    
+
     mimetype: application/x-microsoft.net.object.soap.base64
-    value   : The object must be serialized with 
+    value   : The object must be serialized with
             : System.Runtime.Serialization.Formatters.Soap.SoapFormatter
             : and then encoded with base64 encoding.
 
     mimetype: application/x-microsoft.net.object.bytearray.base64
-    value   : The object must be serialized into a byte array 
+    value   : The object must be serialized into a byte array
             : using a System.ComponentModel.TypeConverter
             : and then encoded with base64 encoding.
     -->
@@ -221,6 +221,9 @@
     <value>Open in the given directory instead of the profile's set "startingDirectory"</value>
     <comment>{Locked="\"startingDirectory\""}</comment>
   </data>
+  <data name="CmdVersionDesc" xml:space="preserve">
+    <value>Display the application version</value>
+  </data>
   <data name="NewTabSplitButton.[using:Windows.UI.Xaml.Automation]AutomationProperties.HelpText" xml:space="preserve">
     <value>Press the button to open a new terminal tab with your default profile. Open the flyout to select which profile you want to open.</value>
   </data>

src/cascadia/TerminalApp/TerminalPage.cpp

@@ -1631,6 +1631,8 @@ namespace winrt::TerminalApp::implementation
     //   or 0. (see TerminalPage::_ParseArgs)
     int32_t TerminalPage::SetStartupCommandline(winrt::array_view<const hstring> args)
     {
+        _appArgs.SetVersionString(ApplicationDisplayName(), ApplicationVersion());
+
         return _ParseArgs(args);
     }
 
@@ -1732,16 +1734,31 @@ namespace winrt::TerminalApp::implementation
     //   message. If there were no errors, this message will be blank.
     // - If the user requested help on any command (using --help), this will
     //   contain the help message.
+    // - If the user requested the version number (using --version), this will
+    //   contain the version string.
     // Arguments:
     // - <none>
     // Return Value:
     // - the help text or error message for the provided commandline, if one
     //   exists, otherwise the empty string.
-    winrt::hstring TerminalPage::EarlyExitMessage()
+    winrt::hstring TerminalPage::ParseCommandlineMessage()
     {
         return winrt::to_hstring(_appArgs.GetExitMessage());
     }
 
+    // Method Description:
+    // - Returns true if we should exit the application before even starting the
+    //   window. We might want to do this if we're displaying an error message or
+    //   the version string, or if we want to open the settings file.
+    // Arguments:
+    // - <none>
+    // Return Value:
+    // - true iff we should exit the application before even starting the window
+    bool TerminalPage::ShouldExitEarly()
+    {
+        return _appArgs.ShouldExitEarly();
+    }
+
     // Method Description:
     // - Returns a com_ptr to the implementation type of the tab at the given index
     // Arguments:

src/cascadia/TerminalApp/TerminalPage.h

@@ -48,7 +48,8 @@ namespace winrt::TerminalApp::implementation
         void CloseWindow();
 
         int32_t SetStartupCommandline(winrt::array_view<const hstring> args);
-        winrt::hstring EarlyExitMessage();
+        winrt::hstring ParseCommandlineMessage();
+        bool ShouldExitEarly();
 
         // -------------------------------- WinRT Events ---------------------------------
         DECLARE_EVENT_WITH_TYPED_EVENT_HANDLER(TitleChanged, _titleChangeHandlers, winrt::Windows::Foundation::IInspectable, winrt::hstring);

src/cascadia/TerminalApp/TerminalPage.idl

@@ -11,7 +11,8 @@ namespace TerminalApp
         TerminalPage();
 
         Int32 SetStartupCommandline(String[] commands);
-        String EarlyExitMessage { get; };
+        String ParseCommandlineMessage { get; };
+        Boolean ShouldExitEarly { get; };
 
         // XAML bound properties
         String ApplicationDisplayName { get; };

src/cascadia/WindowsTerminal/AppHost.cpp

@@ -102,7 +102,7 @@ void AppHost::_HandleCommandlineArgs()
             }
 
             const auto result = _logic.SetStartupCommandline({ args });
-            const auto message = _logic.EarlyExitMessage();
+            const auto message = _logic.ParseCommandlineMessage();
             if (!message.empty())
             {
                 const auto displayHelp = result == 0;
@@ -115,7 +115,10 @@ void AppHost::_HandleCommandlineArgs()
                             GetStringResource(messageTitle).data(),
                             MB_OK | messageIcon);
 
-                ExitProcess(result);
+                if (_logic.ShouldExitEarly())
+                {
+                    ExitProcess(result);
+                }
             }
         }
     }