[DMC #2] Add DocumentMarkerList interface and GenericDocumentMarkerListImpl

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

 /*
  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
  *           (C) 2001 Dirk Mueller (mueller@kde.org)
  *           (C) 2006 Alexey Proskuryakov (ap@webkit.org)
  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 Apple Inc. All rights
  * reserved.
  * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved.
  * (http://www.torchmobile.com/)
  * Copyright (C) Research In Motion Limited 2010. All rights reserved.
@@ skipping 22 matching lines @@
 #include "core/dom/SynchronousMutationObserver.h"
 #include "core/editing/iterators/TextIterator.h"
 #include "core/editing/markers/DocumentMarker.h"
 #include "platform/geometry/IntRect.h"
 #include "platform/heap/Handle.h"
 #include "platform/wtf/HashMap.h"
 #include "platform/wtf/Vector.h"
 
 namespace blink {
 
+class DocumentMarkerList;
 class Node;
 class RenderedDocumentMarker;
 class Text;
 
 class MarkerRemoverPredicate final {
  public:
   explicit MarkerRemoverPredicate(const Vector<String>& words);
   bool operator()(const DocumentMarker&, const Text&) const;
 
  private:
@@ skipping 67 matching lines @@
   void ShowMarkers() const;
 #endif
 
   // SynchronousMutationObserver
   void DidUpdateCharacterData(CharacterData*,
                               unsigned offset,
                               unsigned old_length,
                               unsigned new_length) final;
 
  private:
-  void AddMarker(Node*, const DocumentMarker&);
+  void AddMarker(Node*, DocumentMarker*);

[Xiaocheng, 2017/04/20 08:41:34]

Why do we need to change this function?

Can we change it in a different patch?

[rlanday, 2017/04/20 10:03:18]

DocumentMarkerList::AddMarker() needs to take a non-const pointer so we can
modify the DocumentMarker in ShiftMarkers(). The current implementation of
AddMarker() copies the marker (by calling RenderedDocumentMarker::create()
and storing that marker instead) but it is not guaranteed by the interface
that the marker will be copied. So this method also needs to take a non-const
pointer/ref; I changed it to a pointer because my understanding is that the
style guide frowns upon passing non-const refs.

We can change it in a separate patch if you want.

 
-  using MarkerList = HeapVector<Member<RenderedDocumentMarker>>;
-  using MarkerLists =
-      HeapVector<Member<MarkerList>, DocumentMarker::kMarkerTypeIndexesCount>;
+  using MarkerLists = HeapVector<Member<DocumentMarkerList>,
+                                 DocumentMarker::kMarkerTypeIndexesCount>;
   using MarkerMap = HeapHashMap<WeakMember<const Node>, Member<MarkerLists>>;
-  static Member<MarkerList>& ListForType(MarkerLists*,
-                                         DocumentMarker::MarkerType);
+  static Member<DocumentMarkerList>& ListForType(MarkerLists*,
+                                                 DocumentMarker::MarkerType);
   bool PossiblyHasMarkers(DocumentMarker::MarkerTypes);
   void RemoveMarkersFromList(MarkerMap::iterator, DocumentMarker::MarkerTypes);
   void RemoveMarkers(TextIterator&, DocumentMarker::MarkerTypes);
 
   MarkerMap markers_;
   // Provide a quick way to determine whether a particular marker type is absent
   // without going through the map.
   DocumentMarker::MarkerTypes possibly_existing_marker_types_;
   const Member<const Document> document_;
 };
 
 }  // namespace blink
 
 #ifndef NDEBUG
 void showDocumentMarkers(const blink::DocumentMarkerController*);
 #endif
 
 #endif  // DocumentMarkerController_h