Add DocumentMarkerList in preparation for DocumentMarkerController refactor

third_party/WebKit/Source/core/editing/markers/DocumentMarkerListTest.cpp

+// Copyright 2017 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#include "core/editing/markers/DocumentMarkerList.h"
+
+#include "platform/heap/Handle.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+namespace blink {
+
+class DocumentMarkerListForTesting : public DocumentMarkerList {
+ public:
+  DocumentMarkerListForTesting() {}
+
+  DocumentMarker::MarkerType allowedMarkerType() const final {
+    return DocumentMarker::Composition;
+  }
+
+ protected:
+  bool markerListIsSorted() const final { return false; }
+};
+
+class SortedDocumentMarkerListForTesting : public DocumentMarkerList {
+ public:
+  SortedDocumentMarkerListForTesting() {}
+
+  DocumentMarker::MarkerType allowedMarkerType() const final {
+    return DocumentMarker::Composition;
+  }
+
+ protected:
+  bool markerListIsSorted() const final { return true; }
+};
+
+class DocumentMarkerListTest : public ::testing::Test {
+ protected:
+  DocumentMarkerListTest()
+      : m_markerList(new DocumentMarkerListForTesting()),
+        m_sortedMarkerList(new SortedDocumentMarkerListForTesting()) {}
+
+  DocumentMarker* createMarker(unsigned startOffset, unsigned endOffset) {
+    return new DocumentMarker(startOffset, endOffset, Color::black, false,
+                              Color::black);
+  }
+
+  Persistent<DocumentMarkerListForTesting> m_markerList;
+  Persistent<SortedDocumentMarkerListForTesting> m_sortedMarkerList;
+};
+
+TEST_F(DocumentMarkerListTest,
+       RemoveMarkersSortedDoRemovePartiallyOverlappingNoOpRemoval) {
+  m_sortedMarkerList->add(createMarker(0, 5));
+
+  EXPECT_EQ(DocumentMarkerList::DidRemoveMarkerOrNot::DidNotRemoveMarker,
+            m_sortedMarkerList->removeMarkers(100, 100, true));
+  EXPECT_EQ(1u, m_sortedMarkerList->size());
+
+  EXPECT_EQ(0u, m_sortedMarkerList->at(0)->startOffset());
+  EXPECT_EQ(5u, m_sortedMarkerList->at(0)->endOffset());
+}
+
+TEST_F(DocumentMarkerListTest,
+       RemoveMarkersSortedDoRemovePartiallyOverlappingPartialIntersection) {
+  m_sortedMarkerList->add(createMarker(0, 5));
+  m_sortedMarkerList->add(createMarker(10, 15));
+  m_sortedMarkerList->add(createMarker(20, 25));
+
+  EXPECT_EQ(DocumentMarkerList::DidRemoveMarkerOrNot::DidRemoveMarker,
+            m_sortedMarkerList->removeMarkers(10, 2, true));
+
+  EXPECT_EQ(2u, m_sortedMarkerList->size());
+
+  EXPECT_EQ(0u, m_sortedMarkerList->at(0)->startOffset());
+  EXPECT_EQ(5u, m_sortedMarkerList->at(0)->endOffset());
+
+  EXPECT_EQ(20u, m_sortedMarkerList->at(1)->startOffset());
+  EXPECT_EQ(25u, m_sortedMarkerList->at(1)->endOffset());
+}
+
+TEST_F(
+    DocumentMarkerListTest,
+    RemoveMarkersSortedDoRemovePartiallyOverlappingDoublePartialIntersection) {
+  m_sortedMarkerList->add(createMarker(0, 5));
+  m_sortedMarkerList->add(createMarker(10, 15));
+  m_sortedMarkerList->add(createMarker(20, 25));
+  m_sortedMarkerList->add(createMarker(30, 35));
+
+  EXPECT_EQ(DocumentMarkerList::DidRemoveMarkerOrNot::DidRemoveMarker,
+            m_sortedMarkerList->removeMarkers(13, 9, true));
+
+  EXPECT_EQ(2u, m_sortedMarkerList->size());
+
+  EXPECT_EQ(0u, m_sortedMarkerList->at(0)->startOffset());
+  EXPECT_EQ(5u, m_sortedMarkerList->at(0)->endOffset());
+
+  EXPECT_EQ(30u, m_sortedMarkerList->at(1)->startOffset());
+  EXPECT_EQ(35u, m_sortedMarkerList->at(1)->endOffset());
+}
+
+TEST_F(DocumentMarkerListTest,
+       RemoveMarkersUnsortedDoRemovePartiallyOverlappingNoOpRemoval) {
+  m_markerList->add(createMarker(0, 5));
+
+  EXPECT_EQ(DocumentMarkerList::DidRemoveMarkerOrNot::DidNotRemoveMarker,
+            m_markerList->removeMarkers(100, 100, true));
+  EXPECT_EQ(1u, m_markerList->size());
+
+  EXPECT_EQ(0u, m_markerList->at(0)->startOffset());
+  EXPECT_EQ(5u, m_markerList->at(0)->endOffset());
+}
+
+TEST_F(DocumentMarkerListTest,
+       RemoveMarkersUnsortedDoRemovePartiallyOverlappingPartialIntersection) {
+  m_markerList->add(createMarker(20, 25));
+  m_markerList->add(createMarker(10, 15));
+  m_markerList->add(createMarker(0, 5));
+
+  EXPECT_EQ(DocumentMarkerList::DidRemoveMarkerOrNot::DidRemoveMarker,
+            m_markerList->removeMarkers(10, 2, true));
+
+  EXPECT_EQ(2u, m_markerList->size());
+
+  EXPECT_EQ(20u, m_markerList->at(0)->startOffset());
+  EXPECT_EQ(25u, m_markerList->at(0)->endOffset());
+
+  EXPECT_EQ(0u, m_markerList->at(1)->startOffset());
+  EXPECT_EQ(5u, m_markerList->at(1)->endOffset());
+}
+
+TEST_F(
+    DocumentMarkerListTest,
+    RemoveMarkersUnsortedDoRemovePartiallyOverlappingDoublePartialIntersection) {
+  m_markerList->add(createMarker(30, 35));
+  m_markerList->add(createMarker(20, 25));
+  m_markerList->add(createMarker(10, 15));
+  m_markerList->add(createMarker(0, 5));
+
+  EXPECT_EQ(DocumentMarkerList::DidRemoveMarkerOrNot::DidRemoveMarker,
+            m_markerList->removeMarkers(13, 9, true));
+
+  EXPECT_EQ(2u, m_markerList->size());
+
+  EXPECT_EQ(30u, m_markerList->at(0)->startOffset());
+  EXPECT_EQ(35u, m_markerList->at(0)->endOffset());
+
+  EXPECT_EQ(0u, m_markerList->at(1)->startOffset());
+  EXPECT_EQ(5u, m_markerList->at(1)->endOffset());
+}
+
+TEST_F(DocumentMarkerListTest,
+       RemoveMarkersSortedDontRemovePartiallyOverlappingNoOpRemoval) {
+  m_sortedMarkerList->add(createMarker(0, 5));
+
+  // test no-op remove
+  EXPECT_EQ(DocumentMarkerList::DidRemoveMarkerOrNot::DidNotRemoveMarker,
+            m_sortedMarkerList->removeMarkers(100, 100, false));
+  EXPECT_EQ(1u, m_sortedMarkerList->size());
+
+  EXPECT_EQ(0u, m_sortedMarkerList->at(0)->startOffset());
+  EXPECT_EQ(5u, m_sortedMarkerList->at(0)->endOffset());
+}
+
+TEST_F(
+    DocumentMarkerListTest,
+    RemoveMarkersSortedDontRemovePartiallyOverlappingRemoveBeginningOfMarker) {
+  m_sortedMarkerList->add(createMarker(0, 5));
+  m_sortedMarkerList->add(createMarker(10, 15));
+  m_sortedMarkerList->add(createMarker(20, 25));
+
+  EXPECT_EQ(DocumentMarkerList::DidRemoveMarkerOrNot::DidRemoveMarker,
+            m_sortedMarkerList->removeMarkers(10, 2, false));
+  EXPECT_EQ(3u, m_sortedMarkerList->size());
+
+  EXPECT_EQ(0u, m_sortedMarkerList->at(0)->startOffset());
+  EXPECT_EQ(5u, m_sortedMarkerList->at(0)->endOffset());
+
+  EXPECT_EQ(12u, m_sortedMarkerList->at(1)->startOffset());
+  EXPECT_EQ(15u, m_sortedMarkerList->at(1)->endOffset());
+
+  EXPECT_EQ(20u, m_sortedMarkerList->at(2)->startOffset());
+  EXPECT_EQ(25u, m_sortedMarkerList->at(2)->endOffset());
+}
+
+TEST_F(DocumentMarkerListTest,
+       RemoveMarkersSortedDontRemovePartiallyOverlappingRemoveEndOfMarker) {
+  m_sortedMarkerList->add(createMarker(0, 5));
+  m_sortedMarkerList->add(createMarker(10, 15));
+  m_sortedMarkerList->add(createMarker(20, 25));
+
+  EXPECT_EQ(DocumentMarkerList::DidRemoveMarkerOrNot::DidRemoveMarker,
+            m_sortedMarkerList->removeMarkers(13, 2, false));
+  EXPECT_EQ(3u, m_sortedMarkerList->size());
+
+  EXPECT_EQ(0u, m_sortedMarkerList->at(0)->startOffset());
+  EXPECT_EQ(5u, m_sortedMarkerList->at(0)->endOffset());
+
+  EXPECT_EQ(10u, m_sortedMarkerList->at(1)->startOffset());
+  EXPECT_EQ(13u, m_sortedMarkerList->at(1)->endOffset());
+
+  EXPECT_EQ(20u, m_sortedMarkerList->at(2)->startOffset());
+  EXPECT_EQ(25u, m_sortedMarkerList->at(2)->endOffset());
+}
+
+TEST_F(DocumentMarkerListTest,
+       RemoveMarkersSortedDontRemovePartiallyOverlappingRemoveMiddleOfMarker) {
+  m_sortedMarkerList->add(createMarker(0, 5));
+  m_sortedMarkerList->add(createMarker(10, 15));
+  m_sortedMarkerList->add(createMarker(20, 25));
+
+  EXPECT_EQ(DocumentMarkerList::DidRemoveMarkerOrNot::DidRemoveMarker,
+            m_sortedMarkerList->removeMarkers(11, 3, false));
+  EXPECT_EQ(4u, m_sortedMarkerList->size());
+
+  EXPECT_EQ(0u, m_sortedMarkerList->at(0)->startOffset());
+  EXPECT_EQ(5u, m_sortedMarkerList->at(0)->endOffset());
+
+  EXPECT_EQ(10u, m_sortedMarkerList->at(1)->startOffset());
+  EXPECT_EQ(11u, m_sortedMarkerList->at(1)->endOffset());
+
+  EXPECT_EQ(14u, m_sortedMarkerList->at(2)->startOffset());
+  EXPECT_EQ(15u, m_sortedMarkerList->at(2)->endOffset());
+
+  EXPECT_EQ(20u, m_sortedMarkerList->at(3)->startOffset());
+  EXPECT_EQ(25u, m_sortedMarkerList->at(3)->endOffset());
+}
+
+TEST_F(DocumentMarkerListTest,
+       RemoveMarkersSortedDontRemovePartiallyOverlappingRemoveEntireMarker) {
+  m_sortedMarkerList->add(createMarker(0, 5));
+  m_sortedMarkerList->add(createMarker(10, 15));
+  m_sortedMarkerList->add(createMarker(20, 25));
+
+  EXPECT_EQ(DocumentMarkerList::DidRemoveMarkerOrNot::DidRemoveMarker,
+            m_sortedMarkerList->removeMarkers(10, 5, false));
+  EXPECT_EQ(2u, m_sortedMarkerList->size());
+
+  EXPECT_EQ(0u, m_sortedMarkerList->at(0)->startOffset());
+  EXPECT_EQ(5u, m_sortedMarkerList->at(0)->endOffset());
+
+  EXPECT_EQ(20u, m_sortedMarkerList->at(1)->startOffset());
+  EXPECT_EQ(25u, m_sortedMarkerList->at(1)->endOffset());
+}
+
+TEST_F(DocumentMarkerListTest,
+       RemoveMarkersUnsortedDontRemovePartiallyOverlappingNoOpRemoval) {
+  m_markerList->add(createMarker(0, 5));
+
+  // test no-op remove
+  EXPECT_EQ(DocumentMarkerList::DidRemoveMarkerOrNot::DidNotRemoveMarker,
+            m_markerList->removeMarkers(100, 100, false));
+  EXPECT_EQ(1u, m_markerList->size());
+
+  EXPECT_EQ(0u, m_markerList->at(0)->startOffset());
+  EXPECT_EQ(5u, m_markerList->at(0)->endOffset());
+}
+
+TEST_F(
+    DocumentMarkerListTest,
+    RemoveMarkersUnsortedDontRemovePartiallyOverlappingRemoveBeginningOfMarker) {
+  m_markerList->add(createMarker(20, 25));
+  m_markerList->add(createMarker(10, 15));
+  m_markerList->add(createMarker(0, 5));
+
+  EXPECT_EQ(DocumentMarkerList::DidRemoveMarkerOrNot::DidRemoveMarker,
+            m_markerList->removeMarkers(10, 2, false));
+  EXPECT_EQ(3u, m_markerList->size());
+
+  EXPECT_EQ(20u, m_markerList->at(0)->startOffset());
+  EXPECT_EQ(25u, m_markerList->at(0)->endOffset());
+
+  EXPECT_EQ(12u, m_markerList->at(1)->startOffset());
+  EXPECT_EQ(15u, m_markerList->at(1)->endOffset());
+
+  EXPECT_EQ(0u, m_markerList->at(2)->startOffset());
+  EXPECT_EQ(5u, m_markerList->at(2)->endOffset());
+}
+
+TEST_F(DocumentMarkerListTest,
+       RemoveMarkersUnsortedDontRemovePartiallyOverlappingRemoveEndOfMarker) {
+  m_markerList->add(createMarker(20, 25));
+  m_markerList->add(createMarker(10, 15));
+  m_markerList->add(createMarker(0, 5));
+
+  EXPECT_EQ(DocumentMarkerList::DidRemoveMarkerOrNot::DidRemoveMarker,
+            m_markerList->removeMarkers(13, 2, false));
+  EXPECT_EQ(3u, m_markerList->size());
+
+  EXPECT_EQ(20u, m_markerList->at(0)->startOffset());
+  EXPECT_EQ(25u, m_markerList->at(0)->endOffset());
+
+  EXPECT_EQ(10u, m_markerList->at(1)->startOffset());
+  EXPECT_EQ(13u, m_markerList->at(1)->endOffset());
+
+  EXPECT_EQ(0u, m_markerList->at(2)->startOffset());
+  EXPECT_EQ(5u, m_markerList->at(2)->endOffset());
+}
+
+TEST_F(
+    DocumentMarkerListTest,
+    RemoveMarkersUnsortedDontRemovePartiallyOverlappingRemoveMiddleOfMarker) {
+  m_markerList->add(createMarker(20, 25));
+  m_markerList->add(createMarker(10, 15));
+  m_markerList->add(createMarker(0, 5));
+
+  EXPECT_EQ(DocumentMarkerList::DidRemoveMarkerOrNot::DidRemoveMarker,
+            m_markerList->removeMarkers(11, 3, false));
+  EXPECT_EQ(4u, m_markerList->size());
+
+  EXPECT_EQ(20u, m_markerList->at(0)->startOffset());
+  EXPECT_EQ(25u, m_markerList->at(0)->endOffset());
+
+  EXPECT_EQ(10u, m_markerList->at(1)->startOffset());
+  EXPECT_EQ(11u, m_markerList->at(1)->endOffset());
+
+  EXPECT_EQ(14u, m_markerList->at(2)->startOffset());
+  EXPECT_EQ(15u, m_markerList->at(2)->endOffset());
+
+  EXPECT_EQ(0u, m_markerList->at(3)->startOffset());
+  EXPECT_EQ(5u, m_markerList->at(3)->endOffset());
+}
+
+TEST_F(DocumentMarkerListTest,
+       RemoveMarkersUnsortedDontRemovePartiallyOverlappingRemoveEntireMarker) {
+  m_markerList->add(createMarker(20, 25));
+  m_markerList->add(createMarker(10, 15));
+  m_markerList->add(createMarker(0, 5));
+
+  EXPECT_EQ(DocumentMarkerList::DidRemoveMarkerOrNot::DidRemoveMarker,
+            m_markerList->removeMarkers(10, 5, false));
+  EXPECT_EQ(2u, m_markerList->size());
+
+  EXPECT_EQ(20u, m_markerList->at(0)->startOffset());
+  EXPECT_EQ(25u, m_markerList->at(0)->endOffset());
+
+  EXPECT_EQ(0u, m_markerList->at(1)->startOffset());
+  EXPECT_EQ(5u, m_markerList->at(1)->endOffset());
+}
+
+TEST_F(DocumentMarkerListTest, ShiftMarkersNoChange) {
+  m_markerList->add(createMarker(0, 5));
+
+  EXPECT_EQ(DocumentMarkerList::DidShiftMarkerOrNot::DidNotShiftMarker,
+            m_markerList->shiftMarkers(10, 0, 5));
+  EXPECT_EQ(1u, m_markerList->size());
+
+  EXPECT_EQ(0u, m_markerList->at(0)->startOffset());
+  EXPECT_EQ(5u, m_markerList->at(0)->endOffset());
+}
+
+TEST_F(DocumentMarkerListTest, ShiftMarkersMarkerShifted) {
+  m_markerList->add(createMarker(0, 5));
+
+  EXPECT_EQ(DocumentMarkerList::DidShiftMarkerOrNot::DidShiftMarker,
+            m_markerList->shiftMarkers(0, 0, 5));
+  EXPECT_EQ(1u, m_markerList->size());
+
+  EXPECT_EQ(5u, m_markerList->at(0)->startOffset());
+  EXPECT_EQ(10u, m_markerList->at(0)->endOffset());
+}
+
+TEST_F(DocumentMarkerListTest, ShiftMarkersMarkerRemoved) {
+  m_markerList->add(createMarker(0, 5));
+
+  EXPECT_EQ(DocumentMarkerList::DidShiftMarkerOrNot::DidShiftMarker,
+            m_markerList->shiftMarkers(0, 5, 0));
+  EXPECT_EQ(0u, m_markerList->size());
+}
+
+TEST_F(DocumentMarkerListTest, CopyMarkersNoOp) {
+  m_markerList->add(createMarker(0, 1));
+
+  DocumentMarkerListForTesting* dstList = new DocumentMarkerListForTesting();
+  EXPECT_EQ(DocumentMarkerList::DidCopyMarkerOrNot::DidNotCopyMarker,
+            m_markerList->copyMarkers(2, 4, dstList, -1));
+
+  EXPECT_EQ(0u, dstList->size());
+}
+
+TEST_F(DocumentMarkerListTest, CopyMarkersNonEmpty) {
+  m_markerList->add(createMarker(1, 2));
+  m_markerList->add(createMarker(3, 4));
+  m_markerList->add(createMarker(5, 6));
+  m_markerList->add(createMarker(7, 8));
+
+  DocumentMarkerListForTesting* dstList = new DocumentMarkerListForTesting();
+
+  // Copy all markers that intersect the range 2 through 5, i.e. the first three
+  EXPECT_EQ(DocumentMarkerList::DidCopyMarkerOrNot::DidCopyMarker,
+            m_markerList->copyMarkers(2, 4, dstList, -1));
+
+  EXPECT_EQ(3u, dstList->size());
+
+  // Markers are clamped to the range 2 through 5, so the first and third
+  // markers are now length 0
+  // TODO(rlanday): should we change this behavior to remove the zero-length
+  // markers?
+  EXPECT_EQ(1u, dstList->at(0)->startOffset());
+  EXPECT_EQ(1u, dstList->at(0)->endOffset());
+
+  EXPECT_EQ(2u, dstList->at(1)->startOffset());
+  EXPECT_EQ(3u, dstList->at(1)->endOffset());
+
+  EXPECT_EQ(4u, dstList->at(2)->startOffset());
+  EXPECT_EQ(4u, dstList->at(2)->endOffset());
+}
+
+}  // namespace blink