OSC 8 support for conhost and terminal

src/buffer/out/textBuffer.cpp

@@ -552,47 +552,8 @@ bool TextBuffer::IncrementCircularBuffer(const bool inVtMode)
     // to the logical position 0 in the window (cursor coordinates and all other coordinates).
     _renderTarget.TriggerCircling();
 
-    // First, check the old first row for hyperlink references
-    // If there are any, search the entire buffer for the same reference
-    // If the buffer does not contain the same reference, we can remove that hyperlink from our map
-    // This way, obsolete hyperlink references are cleared from our hyperlink map instead of hanging around
-    std::unordered_set<USHORT> refs;
-    const auto firstAttrRow = _storage.at(_firstRow).GetAttrRow();
-    // Get all the hyperlink references in the row we're erasing
-    for (auto it = firstAttrRow.begin(); it != firstAttrRow.end(); ++it)
-    {
-        if (it->IsHyperlink())
-        {
-            refs.emplace(it->GetHyperlinkId());
-        }
-    }
-    if (!refs.empty())
-    {
-        const auto total = TotalRowCount();
-        // Loop through all the rows in the buffer
-        for (size_t i = 1; i != total; ++i)
-        {
-            const auto attrRow = GetRowByOffset(i).GetAttrRow();
-            for (auto it = attrRow.begin(); it != attrRow.end(); ++it)
-            {
-                if (it->IsHyperlink() && (refs.find(it->GetHyperlinkId()) != refs.end()))
-                {
-                    refs.erase(it->GetHyperlinkId());
-                }
-            }
-            if (refs.empty())
-            {
-                // No more hyperlink references left to search for, terminate early
-                break;
-            }
-        }
-    }
-
-    // Now delete obsolete references from our map
-    for (auto it = refs.begin(); it != refs.end(); ++it)
-    {
-        RemoveHyperlinkFromMap(*it);
-    }
+    // Prune hyperlinks to delete obsolete references
+    _PruneHyperlinks();
 
     // Second, clean out the old "first row" as it will become the "last row" of the buffer after the circle is performed.
     auto fillAttributes = _currentAttributes;
@@ -1228,6 +1189,51 @@ const COORD TextBuffer::_GetWordEndForSelection(const COORD target, const std::w
     return result;
 }
 
+void TextBuffer::_PruneHyperlinks()
+{
+    // First, check the old first row for hyperlink references
+    // If there are any, search the entire buffer for the same reference
+    // If the buffer does not contain the same reference, we can remove that hyperlink from our map
+    // This way, obsolete hyperlink references are cleared from our hyperlink map instead of hanging around
+    std::unordered_set<USHORT> refs;
+    const auto firstAttrRow = _storage.at(_firstRow).GetAttrRow();
+    // Get all the hyperlink references in the row we're erasing
+    for (auto it = firstAttrRow.begin(); it != firstAttrRow.end(); ++it)
+    {
+        if (it->IsHyperlink())
+        {
+            refs.emplace(it->GetHyperlinkId());
+        }
+    }
+    if (!refs.empty())
+    {
+        const auto total = TotalRowCount();
+        // Loop through all the rows in the buffer
+        for (size_t i = 1; i != total; ++i)
+        {
+            const auto attrRow = GetRowByOffset(i).GetAttrRow();
+            for (auto it = attrRow.begin(); it != attrRow.end(); ++it)
+            {
+                if (it->IsHyperlink() && (refs.find(it->GetHyperlinkId()) != refs.end()))
+                {
+                    refs.erase(it->GetHyperlinkId());
+                }
+            }
+            if (refs.empty())
+            {
+                // No more hyperlink references left to search for, terminate early
+                break;
+            }
+        }
+    }
+
+    // Now delete obsolete references from our map
+    for (auto it = refs.begin(); it != refs.end(); ++it)
+    {
+        RemoveHyperlinkFromMap(*it);
+    }
+}
+
 // Method Description:
 // - Update pos to be the position of the first character of the next word. This is used for accessibility
 // Arguments:

src/buffer/out/textBuffer.hpp

@@ -225,6 +225,8 @@ class TextBuffer final
     const COORD _GetWordEndForAccessibility(const COORD target, const std::wstring_view wordDelimiters) const;
     const COORD _GetWordEndForSelection(const COORD target, const std::wstring_view wordDelimiters) const;
 
+    void _PruneHyperlinks();
+
 #ifdef UNIT_TESTING
     friend class TextBufferTests;
     friend class UiaTextRangeTests;

src/cascadia/TerminalControl/TermControl.cpp

@@ -1128,7 +1128,7 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
                     _terminal->SetSelectionEnd(terminalPosition, mode);
                     _selectionNeedsToBeCopied = true;
                 }
-                if (ctrlEnabled && mode == ::Terminal::SelectionExpansionMode::Cell)
+                if (ctrlEnabled && multiClickMapper == 1)
                 {
                     // Control+Click: if the text selected is a hyperlink, open the link
                     const auto uri = _terminal->GetHyperlink(terminalPosition);
@@ -2853,11 +2853,18 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
     // - The uri
     void TermControl::_HyperlinkHandler(std::wstring uri)
     {
-        auto parsed = winrt::Windows::Foundation::Uri(uri);
-        if (parsed.SchemeName() == L"http" || parsed.SchemeName() == L"https")
+        try
+        {
+            auto parsed = winrt::Windows::Foundation::Uri(uri);
+            if (parsed.SchemeName() == L"http" || parsed.SchemeName() == L"https")
+            {
+                auto hyperlinkArgs = winrt::make_self<OpenHyperlinkEventArgs>(winrt::hstring(uri));
+                _openHyperlinkHandlers(*this, *hyperlinkArgs);
+            }
+        }
+        catch (...)
         {
-            auto hyperlinkArgs = winrt::make_self<OpenHyperlinkEventArgs>(winrt::hstring(uri));
-            _openHyperlinkHandlers(*this, *hyperlinkArgs);
+            LOG_HR(wil::ResultFromCaughtException());
         }
     }
 

src/cascadia/TerminalCore/Terminal.cpp

@@ -406,6 +406,21 @@ bool Terminal::IsTrackingMouseInput() const noexcept
     return _terminalInput->IsTrackingMouseInput();
 }
 
+// Method Description:
+// - If the clicked text is a hyperlink, open it
+// Arguments:
+// - The position of the clicked text
+std::wstring Terminal::GetHyperlink(const COORD position)
+{
+    auto attr = _buffer->GetCellDataAt(_ConvertToBufferCell(position))->TextAttr();
+    if (attr.IsHyperlink())
+    {
+        auto uri = _buffer->GetHyperlinkUriFromId(attr.GetHyperlinkId());
+        return uri;
+    }
+    return L"";
+}
+
 // Method Description:
 // - Send this particular (non-character) key event to the terminal.
 // - The terminal will translate the key and the modifiers pressed into the

src/cascadia/TerminalCore/Terminal.hpp

@@ -127,6 +127,8 @@ class Microsoft::Terminal::Core::Terminal final :
 
     void TrySnapOnInput() override;
     bool IsTrackingMouseInput() const noexcept;
+
+    std::wstring GetHyperlink(const COORD position);
 #pragma endregion
 
 #pragma region IBaseData(base to IRenderData and IUiaData)
@@ -194,7 +196,6 @@ 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;
-    std::wstring GetHyperlink(const COORD position);
 
     const TextBuffer::TextAndColor RetrieveSelectedTextFromBuffer(bool trimTrailingWhitespace) const;
 #pragma endregion

src/cascadia/TerminalCore/TerminalSelection.cpp

@@ -286,18 +286,3 @@ 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
-std::wstring Terminal::GetHyperlink(const COORD position)
-{
-    auto attr = _buffer->GetCellDataAt(_ConvertToBufferCell(position))->TextAttr();
-    if (attr.IsHyperlink())
-    {
-        auto uri = _buffer->GetHyperlinkUriFromId(attr.GetHyperlinkId());
-        return uri;
-    }
-    return L"";
-}

src/host/getset.cpp

@@ -1562,6 +1562,27 @@ void DoSrvSetCursorColor(SCREEN_INFORMATION& screenInfo,
     screenInfo.GetActiveBuffer().GetTextBuffer().GetCursor().SetColor(cursorColor);
 }
 
+void DoSrvAddHyperlink(SCREEN_INFORMATION& screenInfo,
+                       const std::wstring_view uri,
+                       const std::wstring_view params)
+{
+    auto attr = screenInfo.GetAttributes();
+    if (uri.empty())
+    {
+        // URI is empty, this means we are ending a hyperlink
+        attr.SetHyperlinkId(0);
+        screenInfo.GetTextBuffer().SetCurrentAttributes(attr);
+    }
+    else
+    {
+        // URI is non-empty, this means we are starting a hyperlink
+        USHORT id = screenInfo.GetTextBuffer().GetHyperlinkId(params);
+        attr.SetHyperlinkId(id);
+        screenInfo.GetTextBuffer().SetCurrentAttributes(attr);
+        screenInfo.GetTextBuffer().AddHyperlinkToMap(uri, id);
+    }
+}
+
 // Routine Description:
 // - A private API call for forcing the renderer to repaint the screen. If the
 //      input screen buffer is not the active one, then just do nothing. We only

src/host/getset.h

@@ -49,6 +49,10 @@ void DoSrvSetCursorStyle(SCREEN_INFORMATION& screenInfo,
 void DoSrvSetCursorColor(SCREEN_INFORMATION& screenInfo,
                          const COLORREF cursorColor);
 
+void DoSrvAddHyperlink(SCREEN_INFORMATION& screenInfo,
+                       const std::wstring_view uri,
+                       const std::wstring_view params);
+
 void DoSrvPrivateRefreshWindow(const SCREEN_INFORMATION& screenInfo);
 
 [[nodiscard]] HRESULT DoSrvSetConsoleOutputCodePage(const unsigned int codepage);

src/host/outputStream.cpp

@@ -780,20 +780,6 @@ bool ConhostInternalGetSet::PrivateIsVtInputEnabled() const
 // - true
 bool ConhostInternalGetSet::PrivateAddHyperlink(const std::wstring_view uri, const std::wstring_view params) const
 {
-    auto attr = _io.GetActiveOutputBuffer().GetAttributes();
-    if (uri.empty())
-    {
-        // URI is empty, this means we are ending a hyperlink
-        attr.SetHyperlinkId(0);
-        _io.GetActiveOutputBuffer().GetTextBuffer().SetCurrentAttributes(attr);
-    }
-    else
-    {
-        // URI is non-empty, this means we are starting a hyperlink
-        USHORT id = _io.GetActiveOutputBuffer().GetTextBuffer().GetHyperlinkId(params);
-        attr.SetHyperlinkId(id);
-        _io.GetActiveOutputBuffer().GetTextBuffer().SetCurrentAttributes(attr);
-        _io.GetActiveOutputBuffer().GetTextBuffer().AddHyperlinkToMap(uri, id);
-    }
+    DoSrvAddHyperlink(_io.GetActiveOutputBuffer(), uri, params);
     return true;
 }

src/renderer/vt/VtSequences.cpp

@@ -463,7 +463,7 @@ using namespace Microsoft::Console::Render;
 // - The hyperlink URI
 // Return Value:
 // - S_OK if we succeeded, else an appropriate HRESULT for failing to allocate or write.
-[[nodiscard]] HRESULT VtEngine::_SetHyperlink(std::wstring uri, USHORT id) noexcept
+[[nodiscard]] HRESULT VtEngine::_SetHyperlink(const std::wstring& uri, const USHORT& id) noexcept
 {
     if (uri.empty())
     {

src/renderer/vt/vtrenderer.hpp

@@ -195,7 +195,7 @@ namespace Microsoft::Console::Render
         [[nodiscard]] HRESULT _SetInvisible(const bool isInvisible) noexcept;
         [[nodiscard]] HRESULT _SetCrossedOut(const bool isCrossedOut) noexcept;
         [[nodiscard]] HRESULT _SetReverseVideo(const bool isReversed) noexcept;
-        [[nodiscard]] HRESULT _SetHyperlink(const std::wstring uri, USHORT id) noexcept;
+        [[nodiscard]] HRESULT _SetHyperlink(const std::wstring& uri, const USHORT& id) noexcept;
 
         [[nodiscard]] HRESULT _RequestCursor() noexcept;