[DMC #2] Add DocumentMarkerList interface and GenericDocumentMarkerListImpl

third_party/WebKit/Source/core/editing/markers/DocumentMarkerList.h

Index: third_party/WebKit/Source/core/editing/markers/DocumentMarkerList.h
diff --git a/third_party/WebKit/Source/core/editing/markers/DocumentMarkerList.h b/third_party/WebKit/Source/core/editing/markers/DocumentMarkerList.h
new file mode 100644
index 0000000000000000000000000000000000000000..0ec98740b7a903df0f465477a0d413361b4e3cf6
--- /dev/null
+++ b/third_party/WebKit/Source/core/editing/markers/DocumentMarkerList.h
@@ -0,0 +1,62 @@
+// 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.
+
+#ifndef DocumentMarkerList_h
+#define DocumentMarkerList_h
+
+#include "core/CoreExport.h"
+#include "platform/heap/Handle.h"
+
+namespace blink {
+
+class DocumentMarker;
+class RenderedDocumentMarker;
+
+// This is an interface implemented by classes that DocumentMarkerController
+// uses to store DocumentMarkers. Different implementations can be written
+// to handle different MarkerTypes (e.g. to provide more optimized handling of
+// MarkerTypes with different insertion/retrieval patterns, or to provide
+// different behavior for certain MarkerTypes).
+class CORE_EXPORT DocumentMarkerList
+    : public GarbageCollectedFinalized<DocumentMarkerList> {
+ public:
+  virtual ~DocumentMarkerList();
+
+  virtual bool IsEmpty() const = 0;
+
+  virtual void Add(DocumentMarker*) = 0;
+  virtual void Clear() = 0;
+
+  virtual const HeapVector<Member<RenderedDocumentMarker>>& GetMarkers()
+      const = 0;
+
+  // Returns true if at least one marker is copied, false otherwise
+  virtual bool MoveMarkers(int length, DocumentMarkerList* dst_list) = 0;
+
+  // Returns true if at least one marker is removed, false otherwise
+  virtual bool RemoveMarkers(unsigned start_offset, int length) = 0;
+
+  // Returns true if a marker was removed, false otherwise.
+  // TODO(rlanday): remove this method from this interface once we have a
+  // Spelling/Grammar-specific marker list impl to put this on
+  virtual bool RemoveMarkersUnderWords(const String& node_text,
+                                       const Vector<String>& words) = 0;
+
+  // Returns true if at least one marker is shifted or removed, false otherwise
+  virtual bool ShiftMarkers(unsigned offset,
+                            unsigned old_length,
+                            unsigned new_length) = 0;
+
+  DEFINE_INLINE_VIRTUAL_TRACE() {}
+
+ protected:
+  DocumentMarkerList();
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(DocumentMarkerList);
+};
+
+}  // namespace blink
+
+#endif  // DocumentMarkerList_h