using legal interval tree implementation

oss/interval_tree/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Erik Garrison
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

oss/interval_tree/MAINTAINER_README.md

@@ -0,0 +1,17 @@
+### Notes for Future Maintainers
+
+This was originally imported by @miniksa in January 2020.
+
+The provenance information (where it came from and which commit) is stored in the file `cgmanifest.json` in the same directory as this readme.
+Please update the provenance information in that file when ingesting an updated version of the dependent library.
+That provenance file is automatically read and inventoried by Microsoft systems to ensure compliance with appropiate governance standards.
+
+## What should be done to update this in the future?
+
+1. Go to ekg/intervaltreerepository on GitHub.
+2. Take the file IntervalTree.h wholesale and drop it into the directory here.
+3. Don't change anything about it.
+4. Validate that the license in the root of the repository didn't change and update it if so. It is sitting in the same directory as this readme. 
+   If it changed dramatically, ensure that it is still compatible with our license scheme. Also update the NOTICE file in the root of our repository to declare the third-party usage.
+5. Submit the pull.
+

oss/interval_tree/cgmanifest.json

@@ -0,0 +1,13 @@
+{"Registrations":[ 
+    {
+      "component": { 
+       "type": "git",
+        "git": {
+          "repositoryUrl": "https://github.com/ekg/intervaltree",
+          "commitHash": "b90527f9e6d51cd36ecbb50429e4524d3a418ea5"
+        }
+       }
+    }
+ ],
+ "Version": 1
+}

src/buffer/out/textBuffer.cpp

@@ -2375,15 +2375,11 @@ const size_t TextBuffer::AddPatternRecognizer(const std::string_view regexString
 // - The firstRow to start searching from
 // - The lastRow to search
 // Return value:
-// - A vector containing 3-element tuples where
-//      tuple<0>: ID of the pattern
-//      tuple<1>: start coordinate of the pattern
-//      tuple<2>: end coordinate of the pattern
-
-til::IntervalTree::ITNode* TextBuffer::UpdatePatterns(const size_t firstRow, const size_t lastRow) const
+// - An interval tree containing the patterns found
+interval_tree::IntervalTree<size_t, size_t> TextBuffer::UpdatePatterns(const size_t firstRow, const size_t lastRow) const
 {
-    til::IntervalTree tree;
-    til::IntervalTree::ITNode* result = NULL;
+    typedef interval_tree::IntervalTree<size_t, size_t> ITree;
+    ITree::interval_vector intervals;
 
     std::wstring concatAll;
     const auto rowSize = GetRowByOffset(0).size();
@@ -2421,18 +2417,13 @@ til::IntervalTree::ITNode* TextBuffer::UpdatePatterns(const size_t firstRow, con
             const auto end = start + i->str().size();
             lenUpToThis = end;
 
-            // store the locations as (col, row) coordinates
-            // NOTE: these are VIEWPORT coordinates, not buffer coordinates
+            // store the intervals
+            // NOTE: these intervals are relative to the VIEWPORT not the buffer
             // Keeping these as viewport coordinates for now because its the renderer
             // that actually uses these coordinates and the renderer works in viewport coords
-            const auto startRow = gsl::narrow<SHORT>(start / rowSize);
-            const auto startCol = gsl::narrow<SHORT>(start % rowSize);
-            const auto endRow = gsl::narrow<SHORT>(end / rowSize);
-            const auto endCol = gsl::narrow<SHORT>(end % rowSize);
-            const COORD startCoord{ startCol, startRow };
-            const COORD endCoord{ endCol, endRow };
-            result = tree.insert(result, til::IntervalTree::Interval{ startCoord, endCoord }, idAndPattern.first);
+            intervals.push_back(ITree::interval(start, end, idAndPattern.first));
         }
     }
+    ITree result(std::move(intervals));
     return result;
 }

src/buffer/out/textBuffer.hpp

@@ -183,7 +183,7 @@ class TextBuffer final
                           std::optional<std::reference_wrapper<PositionInformation>> positionInfo);
 
     const size_t AddPatternRecognizer(const std::string_view regexString);
-    til::IntervalTree::ITNode* UpdatePatterns(const size_t firstRow, const size_t lastRow) const;
+    interval_tree::IntervalTree<size_t, size_t> UpdatePatterns(const size_t firstRow, const size_t lastRow) const;
 
 private:
     void _UpdateSize();

src/cascadia/TerminalCore/Terminal.cpp

@@ -424,20 +424,30 @@ std::wstring Terminal::GetHyperlinkAtPosition(const COORD position)
         return uri;
     }
     // also look through our known pattern locations
-    const auto found = _tree.overlapSearch(_patternsAndLocations, til::IntervalTree::Interval{ position, position });
-    if (found != NULL && found->patternId == _hyperlinkPatternId)
+    const auto absLoc = (_buffer->GetRowByOffset(0).size() * position.Y) + position.X;
+    const auto results = _patternIntervalTree.findOverlapping(absLoc + 1, absLoc);
+    if (results.size() > 0)
     {
-        const auto start = found->i->low;
-        const auto end = found->i->high;
-        std::wstring uri;
-
-        const auto startIter = _buffer->GetCellDataAt(_ConvertToBufferCell(start));
-        const auto endIter = _buffer->GetCellDataAt(_ConvertToBufferCell(end));
-        for (auto iter = startIter; iter != endIter; ++iter)
+        const auto rowSize = _buffer->GetRowByOffset(0).size();
+        for (auto result : results)
         {
-            uri += iter->Chars();
+            if (result.value == _hyperlinkPatternId)
+            {
+                const auto start = results.at(0).start;
+                const auto end = results.at(0).stop;
+                COORD startCoord{ gsl::narrow<SHORT>(start % rowSize), gsl::narrow<SHORT>(start / rowSize) };
+                COORD endCoord{ gsl::narrow<SHORT>(end % rowSize), gsl::narrow<SHORT>(end / rowSize) };
+                std::wstring uri;
+
+                const auto startIter = _buffer->GetCellDataAt(_ConvertToBufferCell(startCoord));
+                const auto endIter = _buffer->GetCellDataAt(_ConvertToBufferCell(endCoord));
+                for (auto iter = startIter; iter != endIter; ++iter)
+                {
+                    uri += iter->Chars();
+                }
+                return uri;
+            }
         }
-        return uri;
     }
     return {};
 }
@@ -1057,7 +1067,7 @@ bool Terminal::IsCursorBlinkingAllowed() const noexcept
 //   region changes (for example by text entering the buffer or scrolling)
 void Microsoft::Terminal::Core::Terminal::UpdatePatterns() noexcept
 {
-    _patternsAndLocations = _buffer->UpdatePatterns(_VisibleStartIndex(), _VisibleEndIndex());
+    _patternIntervalTree = _buffer->UpdatePatterns(_VisibleStartIndex(), _VisibleEndIndex());
 }
 
 const std::optional<til::color> Terminal::GetTabColor() const noexcept

src/cascadia/TerminalCore/Terminal.hpp

@@ -233,8 +233,6 @@ class Microsoft::Terminal::Core::Terminal final :
     bool _suppressApplicationTitle;
 
     size_t _hyperlinkPatternId;
-    til::IntervalTree _tree;
-    til::IntervalTree::ITNode* _patternsAndLocations;
 
 #pragma region Text Selection
     // a selection is represented as a range between two COORDs (start and end)
@@ -277,6 +275,8 @@ class Microsoft::Terminal::Core::Terminal final :
     //      underneath them, while others would prefer to anchor it in place.
     //      Either way, we should make this behavior controlled by a setting.
 
+    interval_tree::IntervalTree<size_t, size_t> _patternIntervalTree;
+
     // Since virtual keys are non-zero, you assume that this field is empty/invalid if it is.
     struct KeyEventCodes
     {

src/cascadia/TerminalCore/terminalrenderdata.cpp

@@ -139,12 +139,18 @@ const std::wstring Microsoft::Terminal::Core::Terminal::GetHyperlinkCustomId(uin
 // - The pattern ID of the location
 const size_t Microsoft::Terminal::Core::Terminal::GetPatternId(const COORD location) const noexcept
 {
-    const auto found = _tree.overlapSearch(_patternsAndLocations, til::IntervalTree::Interval{ location, location });
-    if (found != NULL)
+    // Convert the location into its 1-d location because the interval tree stores locations that way
+    const auto absLoc = (_buffer->GetRowByOffset(0).size() * location.Y) + location.X;
+    const auto results = _patternIntervalTree.findOverlapping(absLoc + 1, absLoc);
+    if (results.size() == 0)
     {
-        return found->patternId;
+        return 0;
+    }
+    else
+    {
+        // At some point, this should be updated to return a vector of IDs
+        return results.at(0).value;
     }
-    return 0;
 }
 
 std::vector<Microsoft::Console::Types::Viewport> Terminal::GetSelectionRects() noexcept

src/common.build.pre.props

@@ -83,7 +83,7 @@
       <PrecompiledHeaderFile>precomp.h</PrecompiledHeaderFile>
       <ProgramDataBaseFileName>$(IntDir)$(TargetName).pdb</ProgramDataBaseFileName>
       <DebugInformationFormat>ProgramDatabase</DebugInformationFormat>
-      <AdditionalIncludeDirectories>$(SolutionDir)\src\inc;$(SolutionDir)\dep;$(SolutionDir)\dep\Console;$(SolutionDir)\dep\Win32K;$(SolutionDir)\dep\gsl\include;$(SolutionDir)\dep\wil\include;$(SolutionDir)\oss\chromium;$(SolutionDir)\oss\fmt\include;$(SolutionDir)\oss\dynamic_bitset;$(SolutionDir)\oss\libpopcnt;%(AdditionalIncludeDirectories);</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>$(SolutionDir)\src\inc;$(SolutionDir)\dep;$(SolutionDir)\dep\Console;$(SolutionDir)\dep\Win32K;$(SolutionDir)\dep\gsl\include;$(SolutionDir)\dep\wil\include;$(SolutionDir)\oss\chromium;$(SolutionDir)\oss\fmt\include;$(SolutionDir)\oss\dynamic_bitset;$(SolutionDir)\oss\libpopcnt;$(SolutionDir)\oss\interval_tree;%(AdditionalIncludeDirectories);</AdditionalIncludeDirectories>
       <MultiProcessorCompilation>true</MultiProcessorCompilation>
       <MinimalRebuild>false</MinimalRebuild>
       <RuntimeTypeInfo>false</RuntimeTypeInfo>

src/inc/LibraryIncludes.h

@@ -93,6 +93,9 @@
 // {fmt}, a C++20-compatible formatting library
 #include <fmt/format.h>
 
+#define USE_INTERVAL_TREE_NAMESPACE
+#include <IntervalTree.h>
+
 // SAL
 #include <sal.h>
 

src/inc/til.h

@@ -18,7 +18,6 @@
 #include "til/spsc.h"
 #include "til/coalesce.h"
 #include "til/replace.h"
-#include "til/interval_tree.h"
 
 namespace til // Terminal Implementation Library. Also: "Today I Learned"
 {