OSC 8 support for conhost and terminal

src/buffer/out/TextAttribute.cpp

@@ -112,6 +112,17 @@ std::pair<COLORREF, COLORREF> TextAttribute::CalculateRgbColors(const gsl::span<
     return { fg, bg };
 }
 
+// Method description:
+// - Tells us whether the text is a hyperlink or not
+// Return value:
+// - True if it is a hyperlink, false otherwise
+bool TextAttribute::IsHyperlink() const noexcept
+{
+    // All non-hyperlink text have a default hyperlinkId of 0 while
+    // all hyperlink text have a non-zero hyperlinkId
+    return _hyperlinkId != 0;
+}
+
 TextColor TextAttribute::GetForeground() const noexcept
 {
     return _foreground;
@@ -122,6 +133,15 @@ TextColor TextAttribute::GetBackground() const noexcept
     return _background;
 }
 
+// Method description:
+// - Retrieves the hyperlink ID of the text
+// Return value:
+// - The hyperlink ID
+SHORT TextAttribute::GetHyperlinkId() const noexcept
+{
+    return _hyperlinkId;
+}
+
 void TextAttribute::SetForeground(const TextColor foreground) noexcept
 {
     _foreground = foreground;
@@ -174,6 +194,15 @@ void TextAttribute::SetColor(const COLORREF rgbColor, const bool fIsForeground)
     }
 }
 
+// Method description:
+// - Sets the hyperlink ID of the text
+// Arguments:
+// - id - the id we wish to set
+void TextAttribute::SetHyperlinkId(SHORT id) noexcept
+{
+    _hyperlinkId = id;
+}
+
 bool TextAttribute::IsLeadingByte() const noexcept
 {
     return WI_IsFlagSet(_wAttrLegacy, COMMON_LVB_LEADING_BYTE);

src/buffer/out/TextAttribute.hpp

@@ -36,15 +36,17 @@ class TextAttribute final
         _wAttrLegacy{ 0 },
         _foreground{},
         _background{},
-        _extendedAttrs{ ExtendedAttributes::Normal }
+        _extendedAttrs{ ExtendedAttributes::Normal },
+        _hyperlinkId{ 0 }
     {
     }
 
     explicit constexpr TextAttribute(const WORD wLegacyAttr) noexcept :
         _wAttrLegacy{ gsl::narrow_cast<WORD>(wLegacyAttr & META_ATTRS) },
         _foreground{ s_LegacyIndexOrDefault(wLegacyAttr & FG_ATTRS, s_legacyDefaultForeground) },
         _background{ s_LegacyIndexOrDefault((wLegacyAttr & BG_ATTRS) >> 4, s_legacyDefaultBackground) },
-        _extendedAttrs{ ExtendedAttributes::Normal }
+        _extendedAttrs{ ExtendedAttributes::Normal },
+        _hyperlinkId{ 0 }
     {
         // If we're given lead/trailing byte information with the legacy color, strip it.
         WI_ClearAllFlags(_wAttrLegacy, COMMON_LVB_SBCSDBCS);
@@ -55,7 +57,8 @@ class TextAttribute final
         _wAttrLegacy{ 0 },
         _foreground{ rgbForeground },
         _background{ rgbBackground },
-        _extendedAttrs{ ExtendedAttributes::Normal }
+        _extendedAttrs{ ExtendedAttributes::Normal },
+        _hyperlinkId{ 0 }
     {
     }
 
@@ -110,8 +113,11 @@ class TextAttribute final
 
     ExtendedAttributes GetExtendedAttributes() const noexcept;
 
+    bool IsHyperlink() const noexcept;
+
     TextColor GetForeground() const noexcept;
     TextColor GetBackground() const noexcept;
+    SHORT GetHyperlinkId() const noexcept;
     void SetForeground(const TextColor foreground) noexcept;
     void SetBackground(const TextColor background) noexcept;
     void SetForeground(const COLORREF rgbForeground) noexcept;
@@ -121,6 +127,7 @@ class TextAttribute final
     void SetIndexedForeground256(const BYTE fgIndex) noexcept;
     void SetIndexedBackground256(const BYTE bgIndex) noexcept;
     void SetColor(const COLORREF rgbColor, const bool fIsForeground) noexcept;
+    void SetHyperlinkId(SHORT id) noexcept;
 
     void SetDefaultForeground() noexcept;
     void SetDefaultBackground() noexcept;
@@ -167,6 +174,8 @@ class TextAttribute final
     TextColor _background;
     ExtendedAttributes _extendedAttrs;
 
+    SHORT _hyperlinkId;
+
 #ifdef UNIT_TESTING
     friend class TextBufferTests;
     friend class TextAttributeTests;
@@ -180,7 +189,7 @@ class TextAttribute final
 // 4 for _foreground
 // 4 for _background
 // 1 for _extendedAttrs
-static_assert(sizeof(TextAttribute) <= 11 * sizeof(BYTE), "We should only need 11B for an entire TextColor. Any more than that is just waste");
+static_assert(sizeof(TextAttribute) <= 13 * sizeof(BYTE), "We should only need 13B for an entire TextAttribute. We may need to increment this in the future as we add additional attributes");
 
 enum class TextAttributeBehavior
 {

src/buffer/out/textBuffer.cpp

@@ -34,7 +34,8 @@ TextBuffer::TextBuffer(const COORD screenBufferSize,
     _storage{},
     _unicodeStorage{},
     _renderTarget{ renderTarget },
-    _size{}
+    _size{},
+    _curHyperlinkId{ 1 }
 {
     // initialize ROWs
     for (size_t i = 0; i < static_cast<size_t>(screenBufferSize.Y); ++i)
@@ -2207,3 +2208,34 @@ HRESULT TextBuffer::Reflow(TextBuffer& oldBuffer,
 
     return hr;
 }
+
+// Method Description:
+// - Adds a hyperlink to our hyperlink table
+// Arguments:
+// - The hyperlink URI
+void TextBuffer::AddHyperlinkToMap(std::wstring uri) noexcept
+{
+    _hyperlinkMap.insert(std::pair<SHORT, std::wstring>(_curHyperlinkId, uri));
+    _curHyperlinkId++;
+}
+
+// Method Description:
+// - Retrieves the next hyperlink ID to use - this is needed for setting
+//   the hyperlink ID in text attributes
+// Return Value:
+// - the SHORT hyperlink ID
+SHORT TextBuffer::GetCurHyperlinkId() const noexcept
+{
+    return _curHyperlinkId;
+}
+
+// Method Description:
+// - Retrieves the URI associated with a particular hyperlink ID
+// Arguments:
+// - The hyperlink ID
+// Return Value:
+// - The URI
+std::wstring TextBuffer::GetHyperlinkUriFromId(SHORT id) const noexcept
+{
+    return _hyperlinkMap.at(id);
+}

src/buffer/out/textBuffer.hpp

@@ -141,6 +141,10 @@ class TextBuffer final
 
     const std::vector<SMALL_RECT> GetTextRects(COORD start, COORD end, bool blockSelection = false) const;
 
+    void AddHyperlinkToMap(std::wstring uri) noexcept;
+    SHORT GetCurHyperlinkId() const noexcept;
+    std::wstring GetHyperlinkUriFromId(SHORT id) const noexcept;
+
     class TextAndColor
     {
     public:
@@ -188,6 +192,9 @@ class TextBuffer final
     // storage location for glyphs that can't fit into the buffer normally
     UnicodeStorage _unicodeStorage;
 
+    SHORT _curHyperlinkId;
+    std::map<SHORT, std::wstring> _hyperlinkMap;
+
     void _RefreshRowIDs(std::optional<SHORT> newRowWidth);
 
     Microsoft::Console::Render::IRenderTarget& _renderTarget;

src/cascadia/TerminalControl/TermControl.cpp

@@ -1064,6 +1064,7 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
             // macro directly with a VirtualKeyModifiers
             const auto altEnabled = WI_IsFlagSet(modifiers, static_cast<uint32_t>(VirtualKeyModifiers::Menu));
             const auto shiftEnabled = WI_IsFlagSet(modifiers, static_cast<uint32_t>(VirtualKeyModifiers::Shift));
+            const auto ctrlEnabled = WI_IsFlagSet(modifiers, static_cast<uint32_t>(VirtualKeyModifiers::Control));
 
             if (_CanSendVTMouseInput())
             {
@@ -1110,6 +1111,11 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
                     _terminal->SetSelectionEnd(terminalPosition, mode);
                     _selectionNeedsToBeCopied = true;
                 }
+                if (ctrlEnabled && mode == ::Terminal::SelectionExpansionMode::Cell)
+                {
+                    // Control+Click: if the text selected is a hyperlink, open the link
+                    _terminal->OpenHyperlink(terminalPosition);
+                }
                 else if (mode == ::Terminal::SelectionExpansionMode::Cell)
                 {
                     // Single Click: reset the selection and begin a new one

src/cascadia/TerminalControl/TerminalControl.vcxproj

@@ -130,7 +130,7 @@
 
   <ItemDefinitionGroup>
     <Link>
-      <AdditionalDependencies>dwrite.lib;dxgi.lib;d2d1.lib;d3d11.lib;shcore.lib;winmm.lib;pathcch.lib;propsys.lib;uiautomationcore.lib;Shlwapi.lib;ntdll.lib;user32.lib;kernel32.lib;%(AdditionalDependencies)</AdditionalDependencies>
+      <AdditionalDependencies>dwrite.lib;dxgi.lib;d2d1.lib;d3d11.lib;shcore.lib;winmm.lib;pathcch.lib;propsys.lib;uiautomationcore.lib;Shlwapi.lib;ntdll.lib;user32.lib;kernel32.lib;shell32.lib;%(AdditionalDependencies)</AdditionalDependencies>
     </Link>
     <ClCompile>
       <AdditionalIncludeDirectories>$(OpenConsoleDir)src\cascadia\inc;$(OpenConsoleDir)src\types\inc;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>

src/cascadia/TerminalControl/pch.h

@@ -50,4 +50,6 @@
 TRACELOGGING_DECLARE_PROVIDER(g_hTerminalControlProvider);
 #include <telemetry/ProjectTelemetry.h>
 
+#include <shellapi.h>
+
 #include "til.h"

src/cascadia/TerminalCore/ITerminalApi.hpp

@@ -59,6 +59,8 @@ namespace Microsoft::Terminal::Core
 
         virtual bool CopyToClipboard(std::wstring_view content) noexcept = 0;
 
+        virtual bool AddHyperlink(std::wstring uri) noexcept = 0;
+
     protected:
         ITerminalApi() = default;
     };

src/cascadia/TerminalCore/Terminal.hpp

@@ -111,6 +111,8 @@ class Microsoft::Terminal::Core::Terminal final :
     bool IsVtInputEnabled() const noexcept override;
 
     bool CopyToClipboard(std::wstring_view content) noexcept override;
+
+    bool AddHyperlink(std::wstring uri) noexcept override;
 #pragma endregion
 
 #pragma region ITerminalInput
@@ -152,6 +154,7 @@ class Microsoft::Terminal::Core::Terminal final :
     bool IsScreenReversed() const noexcept override;
     const std::vector<Microsoft::Console::Render::RenderOverlay> GetOverlays() const noexcept override;
     const bool IsGridLineDrawingAllowed() noexcept override;
+    const std::wstring GetHyperlinkUri(SHORT id) const noexcept override;
 #pragma endregion
 
 #pragma region IUiaData
@@ -188,6 +191,7 @@ class Microsoft::Terminal::Core::Terminal final :
     void SetSelectionAnchor(const COORD position);
     void SetSelectionEnd(const COORD position, std::optional<SelectionExpansionMode> newExpansionMode = std::nullopt);
     void SetBlockSelection(const bool isEnabled) noexcept;
+    void OpenHyperlink(const COORD position);
 
     const TextBuffer::TextAndColor RetrieveSelectedTextFromBuffer(bool trimTrailingWhitespace) const;
 #pragma endregion

src/cascadia/TerminalCore/TerminalApi.cpp

@@ -560,3 +560,34 @@ try
     return true;
 }
 CATCH_LOG_RETURN_FALSE()
+
+// Method Description:
+// - Updates the buffer's current text attributes depending on whether we are
+//   starting/ending a hyperlink
+// Arguments:
+// - The hyperlink URI
+// Return Value:
+// - true
+bool Terminal::AddHyperlink(std::wstring uri) noexcept
+{
+    auto attr = _buffer->GetCurrentAttributes();
+    if (uri.empty())
+    {
+        // URI is empty, this means we are ending a hyperlink
+        attr.SetBold(false); // for now we manually set the bold/underline text attributes;
+        attr.SetUnderlined(false); // at some point we should just change text rendering directly
+        attr.SetHyperlinkId(0); // based on whether the hyperlink id is non-zero
+        _buffer->SetCurrentAttributes(attr);
+    }
+    else
+    {
+        // URI is non-empty, this means we are starting a hyperlink
+        attr.SetBold(true);
+        attr.SetUnderlined(true);
+        attr.SetHyperlinkId(_buffer->GetCurHyperlinkId());
+        _buffer->SetCurrentAttributes(attr);
+        _buffer->AddHyperlinkToMap(uri);
+    }
+    return true;
+    ;
+}

src/cascadia/TerminalCore/TerminalDispatch.cpp

@@ -371,6 +371,17 @@ bool TerminalDispatch::ResetPrivateModes(const gsl::span<const DispatchTypes::Pr
     return _SetResetPrivateModes(params, false);
 }
 
+// Method Description:
+// - Start or end a hyperlink
+// Arguments:
+// - The hyperlink URI
+// Return Value:
+// - true
+bool TerminalDispatch::AddHyperlink(const std::wstring uri)
+{
+    return _terminalApi.AddHyperlink(uri);
+}
+
 // Routine Description:
 // - Generalized handler for the setting/resetting of DECSET/DECRST parameters.
 //     All params in the rgParams will attempt to be executed, even if one

src/cascadia/TerminalCore/TerminalDispatch.hpp

@@ -63,6 +63,8 @@ class TerminalDispatch : public Microsoft::Console::VirtualTerminal::TermDispatc
     bool SetPrivateModes(const gsl::span<const ::Microsoft::Console::VirtualTerminal::DispatchTypes::PrivateModeParams> /*params*/) noexcept override; // DECSET
     bool ResetPrivateModes(const gsl::span<const ::Microsoft::Console::VirtualTerminal::DispatchTypes::PrivateModeParams> /*params*/) noexcept override; // DECRST
 
+    bool AddHyperlink(const std::wstring uri) override;
+
 private:
     ::Microsoft::Terminal::Core::ITerminalApi& _terminalApi;
 

src/cascadia/TerminalCore/TerminalSelection.cpp

@@ -286,3 +286,17 @@ void Terminal::ColorSelection(const COORD, const COORD, const TextAttribute)
 {
     THROW_HR(E_NOTIMPL);
 }
+
+// Method Description:
+// - If the clicked text is a hyperlink, open it
+// Arguments:
+// - The position of the clicked text
+void Terminal::OpenHyperlink(const COORD position)
+{
+    auto attr = _buffer->GetCellDataAt(_ConvertToBufferCell(position))->TextAttr();
+    if (attr.IsHyperlink())
+    {
+        auto uri = _buffer->GetHyperlinkUriFromId(attr.GetHyperlinkId());
+        ShellExecute(nullptr, L"open", uri.c_str(), nullptr, nullptr, SW_SHOWNORMAL);
+    }
+}

src/cascadia/TerminalCore/terminalrenderdata.cpp

@@ -121,6 +121,11 @@ const bool Terminal::IsGridLineDrawingAllowed() noexcept
     return true;
 }
 
+const std::wstring Microsoft::Terminal::Core::Terminal::GetHyperlinkUri(SHORT id) const noexcept
+{
+    return _buffer->GetHyperlinkUriFromId(id);
+}
+
 std::vector<Microsoft::Console::Types::Viewport> Terminal::GetSelectionRects() noexcept
 try
 {

src/host/outputStream.cpp

@@ -770,3 +770,33 @@ bool ConhostInternalGetSet::PrivateIsVtInputEnabled() const
 {
     return _io.GetActiveInputBuffer()->IsInVirtualTerminalInputMode();
 }
+
+// Method Description:
+// - Updates the buffer's current text attributes depending on whether we are
+//   starting/ending a hyperlink
+// Arguments:
+// - The hyperlink URI
+// Return Value:
+// - true
+bool ConhostInternalGetSet::PrivateAddHyperlink(const std::wstring uri) const
+{
+    auto attr = _io.GetActiveOutputBuffer().GetAttributes();
+    if (uri.empty())
+    {
+        // URI is empty, this means we are ending a hyperlink
+        attr.SetBold(false); // for now we manually set the bold/underline text attributes;
+        attr.SetUnderlined(false); // at some point we should just change text rendering directly
+        attr.SetHyperlinkId(0); // based on whether the hyperlink id is non-zero
+        _io.GetActiveOutputBuffer().SetAttributes(attr);
+    }
+    else
+    {
+        // URI is non-empty, this means we are starting a hyperlink
+        attr.SetBold(true);
+        attr.SetUnderlined(true);
+        attr.SetHyperlinkId(_io.GetActiveOutputBuffer().GetCurHyperlinkId());
+        _io.GetActiveOutputBuffer().SetAttributes(attr);
+        _io.GetActiveOutputBuffer().AddHyperlinkToMap(uri);
+    }
+    return true;
+}

src/host/outputStream.hpp

@@ -145,6 +145,8 @@ class ConhostInternalGetSet final : public Microsoft::Console::VirtualTerminal::
 
     bool PrivateIsVtInputEnabled() const override;
 
+    bool PrivateAddHyperlink(const std::wstring uri) const override;
+
 private:
     Microsoft::Console::IIoProvider& _io;
 };