Add copyFormatting keybinding arg and array support

src/cascadia/TerminalApp/ActionArgs.cpp

@@ -21,6 +21,8 @@
 
 #include <LibraryResources.h>
 
+using namespace winrt::Microsoft::Terminal::TerminalControl;
+
 namespace winrt::TerminalApp::implementation
 {
     winrt::hstring NewTerminalArgs::GenerateName() const
@@ -62,11 +64,44 @@ namespace winrt::TerminalApp::implementation
 
     winrt::hstring CopyTextArgs::GenerateName() const
     {
+        winrt::hstring singleLineStr;
         if (_SingleLine)
         {
-            return RS_(L"CopyTextAsSingleLineCommandKey");
+            // as a single line
+            singleLineStr = RS_(L"CopyTextAsSingleLineCommandKey");
+        }
+
+        winrt::hstring copyFormatStr;
+        if (_CopyFormatting != nullptr)
+        {
+            if (_CopyFormatting.Value() == CopyFormat::All ||
+                (WI_IsFlagSet(_CopyFormatting.Value(), CopyFormat::HTML) && WI_IsFlagSet(_CopyFormatting.Value(), CopyFormat::RTF)))
+            {
+                // with formatting
+                copyFormatStr = RS_(L"CopyTextFormatAllCommandKey");
+            }
+            else if (_CopyFormatting.Value() == static_cast<CopyFormat>(0))
+            {
+                // without formatting
+                copyFormatStr = RS_(L"CopyTextFormatNoneCommandKey");
+            }
+            else
+            {
+                if (WI_IsFlagSet(_CopyFormatting.Value(), CopyFormat::HTML))
+                {
+                    // html
+                    copyFormatStr = RS_(L"CopyTextFormatHTMLCommandKey");
+                }
+                else if (WI_IsFlagSet(_CopyFormatting.Value(), CopyFormat::RTF))
+                {
+                    // rtf
+                    copyFormatStr = RS_(L"CopyTextFormatRTFCommandKey");
+                }
+            }
         }
-        return RS_(L"CopyTextCommandKey");
+        return winrt::hstring{
+            fmt::format(std::wstring_view(RS_(L"CopyTextCommandKey")), singleLineStr, copyFormatStr)
+        };
     }
 
     winrt::hstring NewTabArgs::GenerateName() const

src/cascadia/TerminalApp/ActionArgs.h

@@ -92,7 +92,7 @@ namespace winrt::TerminalApp::implementation
     {
         CopyTextArgs() = default;
         GETSET_PROPERTY(bool, SingleLine, false);
-        GETSET_PROPERTY(Windows::Foundation::IReference<Microsoft::Terminal::Settings::CopyFormat>, CopyFormatting, nullptr);
+        GETSET_PROPERTY(Windows::Foundation::IReference<Microsoft::Terminal::TerminalControl::CopyFormat>, CopyFormatting, nullptr);
 
         static constexpr std::string_view SingleLineKey{ "singleLine" };
         static constexpr std::string_view CopyFormattingKey{ "copyFormatting" };
@@ -115,6 +115,7 @@ namespace winrt::TerminalApp::implementation
             // LOAD BEARING: Not using make_self here _will_ break you in the future!
             auto args = winrt::make_self<CopyTextArgs>();
             JsonUtils::GetValueForKey(json, SingleLineKey, args->_SingleLine);
+            JsonUtils::GetValueForKey(json, CopyFormattingKey, args->_CopyFormatting);
             return { *args, {} };
         }
     };

src/cascadia/TerminalApp/ActionArgs.idl

@@ -67,7 +67,7 @@ namespace TerminalApp
     [default_interface] runtimeclass CopyTextArgs : IActionArgs
     {
         Boolean SingleLine { get; };
-        Windows.Foundation.IReference<Microsoft.Terminal.Settings.CopyFormat> CopyFormatting { get; };
+        Windows.Foundation.IReference<Microsoft.Terminal.TerminalControl.CopyFormat> CopyFormatting { get; };
     };
 
     [default_interface] runtimeclass NewTabArgs : IActionArgs

src/cascadia/TerminalApp/GlobalAppSettings.h

@@ -68,7 +68,7 @@ class TerminalApp::GlobalAppSettings final
     GETSET_PROPERTY(bool, ShowTabsInTitlebar, true);
     GETSET_PROPERTY(std::wstring, WordDelimiters); // default value set in constructor
     GETSET_PROPERTY(bool, CopyOnSelect, false);
-    GETSET_PROPERTY(winrt::Microsoft::Terminal::Settings::CopyFormat, CopyFormatting, winrt::Microsoft::Terminal::Settings::CopyFormat::Plain);
+    GETSET_PROPERTY(winrt::Microsoft::Terminal::TerminalControl::CopyFormat, CopyFormatting, 0);
     GETSET_PROPERTY(bool, WarnAboutLargePaste, true);
     GETSET_PROPERTY(bool, WarnAboutMultiLinePaste, true);
     GETSET_PROPERTY(LaunchPosition, InitialPosition);

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.
     -->
@@ -204,12 +204,12 @@
     <value>Warnings were found while parsing your keybindings:</value>
   </data>
   <data name="TooManyKeysForChord" xml:space="preserve">
-    <value>&#x2022; Found a keybinding with too many strings for the "keys" array. There should only be one string value in the "keys" array.</value>
-    <comment>{Locked="\"keys\"","&#x2022;"} This glyph is a bullet, used in a bulleted list.</comment>
+    <value>• Found a keybinding with too many strings for the "keys" array. There should only be one string value in the "keys" array.</value>
+    <comment>{Locked="\"keys\"","•"} This glyph is a bullet, used in a bulleted list.</comment>
   </data>
   <data name="MissingRequiredParameter" xml:space="preserve">
-    <value>&#x2022; Found a keybinding that was missing a required parameter value. This keybinding will be ignored.</value>
-    <comment>{Locked="&#x2022;"} This glyph is a bullet, used in a bulleted list.</comment>
+    <value>• Found a keybinding that was missing a required parameter value. This keybinding will be ignored.</value>
+    <comment>{Locked="•"} This glyph is a bullet, used in a bulleted list.</comment>
   </data>
   <data name="LegacyGlobalsProperty" xml:space="preserve">
     <value>The "globals" property is deprecated - your settings might need updating. </value>
@@ -480,10 +480,11 @@
     <value>Split pane vertically</value>
   </data>
   <data name="CopyTextCommandKey" xml:space="preserve">
-    <value>Copy text</value>
+    <value>Copy text {0} {1}</value>
+    <comment>{0} will be replaced with SingleLine value. {1} will be replaced with formats</comment>
   </data>
   <data name="CopyTextAsSingleLineCommandKey" xml:space="preserve">
-    <value>Copy text as a single line</value>
+    <value>as a single line</value>
   </data>
   <data name="PasteTextCommandKey" xml:space="preserve">
     <value>Paste</value>
@@ -603,4 +604,16 @@
   <data name="DarkGrayColorButton.[using:Windows.UI.Xaml.Controls]ToolTipService.ToolTip" xml:space="preserve">
     <value>Dark Gray</value>
   </data>
-</root>
+  <data name="CopyTextFormatAllCommandKey" xml:space="preserve">
+    <value>with formatting</value>
+  </data>
+  <data name="CopyTextFormatHTMLCommandKey" xml:space="preserve">
+    <value>with HTML data</value>
+  </data>
+  <data name="CopyTextFormatNoneCommandKey" xml:space="preserve">
+    <value>without formatting</value>
+  </data>
+  <data name="CopyTextFormatRTFCommandKey" xml:space="preserve">
+    <value>with RTF data</value>
+  </data>
+</root>

src/cascadia/TerminalApp/TerminalPage.cpp

@@ -1604,11 +1604,8 @@ namespace winrt::TerminalApp::implementation
                                _settings->GlobalSettings().CopyFormatting() :
                                copiedData.Formats().Value();
 
-        if (WI_IsFlagSet(copyFormats, CopyFormat::Plain))
-        {
-            // copy text to dataPack
-            dataPack.SetText(copiedData.Text());
-        }
+        // copy text to dataPack
+        dataPack.SetText(copiedData.Text());
 
         if (WI_IsFlagSet(copyFormats, CopyFormat::HTML))
         {
@@ -1717,7 +1714,7 @@ namespace winrt::TerminalApp::implementation
     // - formats: dictate which formats need to be copied
     // Return Value:
     // - true iff we we able to copy text (if a selection was active)
-    bool TerminalPage::_CopyText(const bool singleLine, const Windows::Foundation::IReference<Settings::CopyFormat>& formats)
+    bool TerminalPage::_CopyText(const bool singleLine, const Windows::Foundation::IReference<CopyFormat>& formats)
     {
         const auto control = _GetActiveControl();
         return control.CopySelectionToClipboard(singleLine, formats);

src/cascadia/TerminalApp/TerminalPage.h

@@ -165,7 +165,7 @@ namespace winrt::TerminalApp::implementation
         winrt::fire_and_forget _CopyToClipboardHandler(const IInspectable sender, const winrt::Microsoft::Terminal::TerminalControl::CopyToClipboardEventArgs copiedData);
         winrt::fire_and_forget _PasteFromClipboardHandler(const IInspectable sender,
                                                           const Microsoft::Terminal::TerminalControl::PasteFromClipboardEventArgs eventArgs);
-        bool _CopyText(const bool singleLine, const Windows::Foundation::IReference<Microsoft::Terminal::Settings::CopyFormat>& formats);
+        bool _CopyText(const bool singleLine, const Windows::Foundation::IReference<Microsoft::Terminal::TerminalControl::CopyFormat>& formats);
         void _PasteText();
 
         fire_and_forget _LaunchSettings(const winrt::TerminalApp::SettingsTarget target);

src/cascadia/TerminalApp/TerminalSettings.idl

@@ -3,15 +3,6 @@
 
 namespace TerminalApp
 {
-    // Each CopyFormat value should be a flag in a bitfield
-    enum CopyFormat
-    {
-        Plain = 0x1,
-        HTML = 0x2,
-        RTF = 0x4,
-        All = 0xffffffff
-    };
-
     // Class Description:
     // TerminalSettings encapsulates all settings that control the
     //      TermControl's behavior. In these settings there is both the entirety

src/cascadia/TerminalApp/TerminalSettingsSerializationHelpers.h

@@ -180,13 +180,11 @@ JSON_ENUM_MAPPER(::winrt::Microsoft::UI::Xaml::Controls::TabViewWidthMode)
     };
 };
 
-DEFINE_ENUM_FLAG_OPERATORS(::winrt::Microsoft::Terminal::Settings::CopyFormat);
-
-JSON_FLAG_MAPPER(::winrt::Microsoft::Terminal::Settings::CopyFormat)
+JSON_FLAG_MAPPER(::winrt::Microsoft::Terminal::TerminalControl::CopyFormat)
 {
     JSON_MAPPINGS(5) = {
         pair_type{ "none", AllClear },
-        pair_type{ "plain", ValueType::Plain },
+        pair_type{ "plain", AllClear },
         pair_type{ "html", ValueType::HTML },
         pair_type{ "rtf", ValueType::RTF },
         pair_type{ "all", AllSet },
@@ -196,7 +194,7 @@ JSON_FLAG_MAPPER(::winrt::Microsoft::Terminal::Settings::CopyFormat)
     {
         if (json.isBool())
         {
-            return json.asBool() ? AllSet : ValueType::Plain;
+            return json.asBool() ? AllSet : AllClear;
         }
         return BaseFlagMapper::FromJson(json);
     }

src/cascadia/TerminalControl/TermControl.cpp

@@ -34,7 +34,7 @@ constexpr const auto ScrollBarUpdateInterval = std::chrono::milliseconds(8);
 // The minimum delay between updating the TSF input control.
 constexpr const auto TsfRedrawInterval = std::chrono::milliseconds(100);
 
-DEFINE_ENUM_FLAG_OPERATORS(CopyFormat);
+DEFINE_ENUM_FLAG_OPERATORS(winrt::Microsoft::Terminal::TerminalControl::CopyFormat);
 
 namespace winrt::Microsoft::Terminal::TerminalControl::implementation
 {

src/cascadia/TerminalControl/TermControl.h

@@ -26,9 +26,9 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
             _text(text),
             _html(),
             _rtf(),
-            _formats(Settings::CopyFormat::Plain) {}
+            _formats(static_cast<CopyFormat>(0)) {}
 
-        CopyToClipboardEventArgs(hstring text, hstring html, hstring rtf, Windows::Foundation::IReference<Settings::CopyFormat> formats) :
+        CopyToClipboardEventArgs(hstring text, hstring html, hstring rtf, Windows::Foundation::IReference<CopyFormat> formats) :
             _text(text),
             _html(html),
             _rtf(rtf),
@@ -37,13 +37,13 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
         hstring Text() { return _text; };
         hstring Html() { return _html; };
         hstring Rtf() { return _rtf; };
-        Windows::Foundation::IReference<Settings::CopyFormat> Formats() { return _formats; };
+        Windows::Foundation::IReference<CopyFormat> Formats() { return _formats; };
 
     private:
         hstring _text;
         hstring _html;
         hstring _rtf;
-        Windows::Foundation::IReference<Settings::CopyFormat> _formats;
+        Windows::Foundation::IReference<CopyFormat> _formats;
     };
 
     struct PasteFromClipboardEventArgs :
@@ -71,7 +71,7 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
         hstring Title();
         hstring GetProfileName() const;
 
-        bool CopySelectionToClipboard(bool singleLine, const Windows::Foundation::IReference<Settings::CopyFormat>& formats);
+        bool CopySelectionToClipboard(bool singleLine, const Windows::Foundation::IReference<CopyFormat>& formats);
         void PasteTextFromClipboard();
         void Close();
         Windows::Foundation::Size CharacterDimensions() const;

src/cascadia/TerminalControl/TermControl.idl

@@ -19,12 +19,20 @@ namespace Microsoft.Terminal.TerminalControl
         Boolean OnDirectKeyEvent(UInt32 vkey, Boolean down);
     }
 
+    [flags]
+    enum CopyFormat
+    {
+        HTML = 0x1,
+        RTF = 0x2,
+        All = 0xffffffff
+    };
+
     runtimeclass CopyToClipboardEventArgs
     {
         String Text { get; };
         String Html { get; };
         String Rtf { get; };
-        Windows.Foundation.IReference<Microsoft.Terminal.Settings.CopyFormat> Formats { get; };
+        Windows.Foundation.IReference<CopyFormat> Formats { get; };
     }
 
     runtimeclass PasteFromClipboardEventArgs
@@ -53,7 +61,7 @@ namespace Microsoft.Terminal.TerminalControl
 
         String Title { get; };
 
-        Boolean CopySelectionToClipboard(Boolean singleLine, Windows.Foundation.IReference<Microsoft.Terminal.Settings.CopyFormat> formats);
+        Boolean CopySelectionToClipboard(Boolean singleLine, Windows.Foundation.IReference<CopyFormat> formats);
         void PasteTextFromClipboard();
         void Close();
         Windows.Foundation.Size CharacterDimensions { get; };