Add DocumentMarkerList in preparation for DocumentMarkerController refactor

third_party/WebKit/Source/core/editing/markers/DocumentMarkerList.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"
+
+namespace blink {
+
+DocumentMarkerList::DocumentMarkerList() {}
+
+bool DocumentMarkerList::isEditingMarkerList() const {
+  return false;
+}
+
+bool DocumentMarkerList::isSpellCheckMarkerList() const {
+  return false;
+}
+
+void DocumentMarkerList::add(DocumentMarker* marker) {
+  m_markers.push_back(marker);
+}
+
+void DocumentMarkerList::clear() {
+  m_markers.clear();
+}
+
+void DocumentMarkerList::appendMarkersToInputList(
+    DocumentMarkerVector* list) const {
+  for (Member<DocumentMarker> marker : m_markers) {
+    list->push_back(marker);
+  }
+}
+
+// TODO(rlanday): this method leaves pointers to the same DocumentMarkers in the

[Xiaocheng, 2017/03/29 19:41:43]

nit: Let's put this note in the header file. TODOs in .cpp files are easily
forgotten eventually...

+// source and destination lists (and shifts their offsets if delta != 0), this
+// should probably be cleaned up eventually to not do that
+DocumentMarkerList::DidCopyMarkerOrNot DocumentMarkerList::copyMarkers(
+    unsigned startOffset,
+    int length,
+    DocumentMarkerList* dstList,
+    int delta) const {
+  DidCopyMarkerOrNot didCopyMarker = DidCopyMarkerOrNot::DidNotCopyMarker;
+  unsigned endOffset = startOffset + length - 1;
+
+  for (Member<DocumentMarker> marker : m_markers) {
+    // pin the marker to the specified range and apply the shift delta
+    if (marker->endOffset() >= startOffset &&
+        marker->startOffset() <= endOffset) {
+      didCopyMarker = DidCopyMarkerOrNot::DidCopyMarker;
+      if (marker->startOffset() < startOffset)
+        marker->setStartOffset(startOffset);
+      if (marker->endOffset() > endOffset)
+        marker->setEndOffset(endOffset);
+      marker->shiftOffsets(delta);
+
+      dstList->add(marker);
+    }
+  }
+
+  return didCopyMarker;
+}
+
+DocumentMarkerList::DidRemoveMarkerOrNot DocumentMarkerList::removeMarkers(
+    unsigned startOffset,
+    int length,
+    bool shouldRemovePartiallyOverlappingMarkers) {
+  unsigned endOffset = startOffset + length;
+  HeapVector<Member<DocumentMarker>> newMarkerList;
+  DidRemoveMarkerOrNot didRemoveMarker =
+      DidRemoveMarkerOrNot::DidNotRemoveMarker;
+
+  for (Member<DocumentMarker> marker : m_markers) {
+    if (marker->endOffset() <= startOffset) {
+      newMarkerList.push_back(marker);
+      continue;
+    }
+
+    if (marker->startOffset() >= endOffset) {
+      newMarkerList.push_back(marker);
+      continue;
+    }
+
+    didRemoveMarker = DidRemoveMarkerOrNot::DidRemoveMarker;
+
+    if (shouldRemovePartiallyOverlappingMarkers) {
+      // Stop here. Don't add resulting slices back.
+      continue;
+    }
+
+    // add either of the resulting slices that are left after removing target
+    if (startOffset > marker->startOffset()) {
+      DocumentMarker* newLeft = new DocumentMarker(*marker);
+      newLeft->setEndOffset(startOffset);
+      newMarkerList.push_back(newLeft);
+    }
+
+    if (marker->endOffset() > endOffset) {
+      DocumentMarker* newRight = new DocumentMarker(*marker);
+      newRight->setStartOffset(endOffset);
+      newMarkerList.push_back(newRight);
+    }
+  }
+
+  swap(m_markers, newMarkerList);
+

[Xiaocheng, 2017/03/29 19:41:43]

nit: Remove the extra blank line.

+  return didRemoveMarker;
+}
+
+DocumentMarkerList::DidShiftMarkerOrNot DocumentMarkerList::shiftMarkers(
+    unsigned offset,
+    unsigned oldLength,
+    unsigned newLength) {
+  HeapVector<Member<DocumentMarker>> newMarkerList;
+  DocumentMarkerList::DidShiftMarkerOrNot didShift =
+      DidShiftMarkerOrNot::DidNotShiftMarker;
+  for (Member<DocumentMarker> marker : m_markers) {
+    DocumentMarker::ShiftMarkerResult result =
+        marker->getShiftedMarkerPosition(offset, oldLength, newLength);
+
+    if (result.shouldRemoveMarker) {
+      didShift = DidShiftMarkerOrNot::DidShiftMarker;

[Xiaocheng, 2017/03/29 19:41:43]

nit: We prefer the early-continue style:

if (result.shouldRemoveMarker) {
  didShift = ...
  continue;
}

...

+    } else {
+      if (result.newStartOffset != marker->startOffset() ||
+          result.newEndOffset != marker->endOffset()) {
+        marker->setStartOffset(result.newStartOffset);
+        marker->setEndOffset(result.newEndOffset);
+
+        didShift = DidShiftMarkerOrNot::DidShiftMarker;
+      }
+      newMarkerList.push_back(marker);
+    }
+  }
+
+  swap(m_markers, newMarkerList);
+

[Xiaocheng, 2017/03/29 19:41:43]

nit: Remove the extra blank line.

+  return didShift;
+}
+
+HeapVector<Member<DocumentMarker>>::iterator
+DocumentMarkerList::getPosOfFirstMarkerNotEndingBefore(size_t startOffset) {
+  DCHECK(markerListIsSorted());
+  return std::upper_bound(
+      m_markers.begin(), m_markers.end(), startOffset,
+      [](size_t startOffset, const Member<DocumentMarker>& rhv) -> bool {
+        return startOffset < rhv->endOffset();
+      });
+}
+
+DEFINE_TRACE(DocumentMarkerList) {
+  visitor->trace(m_markers);
+}
+
+}  // namespace blink