Refactor DocumentMarkerController

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 "wtf/HashMap.h"
 #include "wtf/Vector.h"
 
 namespace blink {
 
+class CompositionMarkerList;
+class DocumentMarkerList;
+class GrammarMarkerList;
 class Node;
-class RenderedDocumentMarker;
-class Text;
+class SpellingMarkerList;
+class TextMatchMarkerList;
 
 class MarkerRemoverPredicate final {
  public:
   explicit MarkerRemoverPredicate(const Vector<String>& words);
   bool operator()(const DocumentMarker&, const Text&) const;
 
- private:

[Xiaocheng, 2017/03/21 19:12:11]

Irrelevant change.

[rlanday, 2017/03/21 19:49:12]

This is necessary because I'm changing the implementation of removeMarkers(const
MarkerRemoverPredicate&) to pass m_words to a method on SpellCheckMarkerList

   Vector<String> m_words;
 };
 
 class CORE_EXPORT DocumentMarkerController final
     : public GarbageCollected<DocumentMarkerController>,
       public SynchronousMutationObserver {
   WTF_MAKE_NONCOPYABLE(DocumentMarkerController);
   USING_GARBAGE_COLLECTED_MIXIN(DocumentMarkerController);
 
  public:
   explicit DocumentMarkerController(Document&);
 
   void clear();
+  void addMarker(Node*, DocumentMarker*);
   void addMarker(const Position& start,
                  const Position& end,
                  DocumentMarker::MarkerType,
                  const String& description = emptyString);
   void addTextMatchMarker(const EphemeralRange&, bool activeMatch);
   void addCompositionMarker(const Position& start,
                             const Position& end,
                             Color underlineColor,
                             bool thick,
                             Color backgroundColor);
@@ skipping 30 matching lines @@
       Node*,
       DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
   void removeMarkers(const MarkerRemoverPredicate& shouldRemoveMarker);
   void repaintMarkers(
       DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
   // Returns true if markers within a range are found.
   bool setMarkersActive(const EphemeralRange&, bool);
   // Returns true if markers within a range defined by a node, |startOffset| and
   // |endOffset| are found.
   bool setMarkersActive(Node*, unsigned startOffset, unsigned endOffset, bool);
-  bool hasMarkers(Node* node) const { return m_markers.contains(node); }
+  bool hasMarkers(Node*) const;
 
   DocumentMarkerVector markersFor(
       Node*,
       DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
   DocumentMarkerVector markersInRange(const EphemeralRange&,
                                       DocumentMarker::MarkerTypes);
   DocumentMarkerVector markers();
   Vector<IntRect> renderedRectsForMarkers(DocumentMarker::MarkerType);
-  void updateMarkerRenderedRectIfNeeded(const Node&, RenderedDocumentMarker&);
+
   void invalidateRectsForAllMarkers();
-  void invalidateRectsForMarkersInNode(const Node&);
+  void invalidateRectsForMarkersInNode(Node&);
 
   DECLARE_TRACE();
 
 #ifndef NDEBUG
   void showMarkers() const;
 #endif
 
   // SynchronousMutationObserver
   void didUpdateCharacterData(CharacterData*,
                               unsigned offset,
                               unsigned oldLength,
                               unsigned newLength) final;
 
  private:
-  void addMarker(Node*, const DocumentMarker&);
+  template <typename MarkerListType>
+  using MarkerMap = HeapHashMap<WeakMember<Node>, Member<MarkerListType>>;
 
-  using MarkerList = HeapVector<Member<RenderedDocumentMarker>>;
-  using MarkerLists =
-      HeapVector<Member<MarkerList>, DocumentMarker::MarkerTypeIndexesCount>;
-  using MarkerMap = HeapHashMap<WeakMember<const Node>, Member<MarkerLists>>;
-  void mergeOverlapping(MarkerList*, RenderedDocumentMarker*);
-  bool possiblyHasMarkers(DocumentMarker::MarkerTypes);
-  void removeMarkersFromList(MarkerMap::iterator, DocumentMarker::MarkerTypes);
+  template <typename MarkerListType>
+  void addIntoMarkerMap(MarkerMap<MarkerListType>* markerMap,

[Xiaocheng, 2017/03/21 19:12:11]

Hmm... I forgot that templated member functions must be inlined. And the callers
of these functions still look quite lengthy.

A better idea seems to be storing the marker lists simply as
|MarkerMap<DocumentMarkerList>|, and let polymorphism handle everything. Sketch:

MarkerMap<DocumentMarkerList> m_spelling;
MarkerMap<DocumentMarkerList> m_grammar;
...

MarkerMap<DocumentMarkerList>& DMC::markerMapFor(type) {
  switch (type) {
    case DocumentMarker::Spelling:
      return m_spelling;
    case ...
      ...
  }
  NOTREACHED();
}

DMC::addMarker(node, newMarker) {
  ...
  MarkerMap<DMList>& markerMap = markerMapFor(newMarker->type());
  auto it = markerMap.find(...)
  ...
  it->value->insert(newMarker);
}

In this way we don't need to forward declare the subclasses of
DocumentMarkerList, either.

[rlanday, 2017/03/21 19:49:12]

We can try that, but then we'll have to cast the marker lists to call certain
methods

+                        Node* node,
+                        DocumentMarker* newMarker) {
+    auto it = markerMap->find(node);
+    if (it == markerMap->end()) {
+      markerMap->insert(node, new MarkerListType(this));
+      it = markerMap->find(node);
+    }
+    it->value->insert(newMarker);
+  }
+
+  template <typename MarkerListType>
+  void shiftMarkersInNode(MarkerMap<MarkerListType>* markerMap,
+                          CharacterData* node,
+                          unsigned offset,
+                          unsigned oldLength,
+                          unsigned newLength,
+                          bool* didShiftMarker) {
+    auto it = markerMap->find(node);
+    if (it != markerMap->end()) {
+      *didShiftMarker = it->value->shiftMarkers(offset, oldLength, newLength) ||
+                        *didShiftMarker;
+    }
+  }
+
+  template <typename MarkerListType>
+  void removeMarkersInRangeFromNode(MarkerMap<MarkerListType>* markerMap,
+                                    Node* node,
+                                    unsigned startOffset,
+                                    int length,
+                                    RemovePartiallyOverlappingMarkerOrNot
+                                        shouldRemovePartiallyOverlappingMarker,
+                                    bool* docDirty) {
+    auto it = markerMap->find(node);
+    if (it != markerMap->end()) {
+      it->value->removeMarkers(startOffset, length,
+                               shouldRemovePartiallyOverlappingMarker,
+                               docDirty);
+      if (it->value->empty())
+        markerMap->remove(node);
+    }
+  }
+
+  HeapVector<Member<DocumentMarkerList>> getMarkerListsForNode(
+      Node*,
+      DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
   void removeMarkers(TextIterator&,
                      DocumentMarker::MarkerTypes,
                      RemovePartiallyOverlappingMarkerOrNot);
 
-  MarkerMap m_markers;
-  // Provide a quick way to determine whether a particular marker type is absent
-  // without going through the map.
-  DocumentMarker::MarkerTypes m_possiblyExistingMarkerTypes;
+  MarkerMap<SpellingMarkerList> m_spelling;
+  MarkerMap<GrammarMarkerList> m_grammar;
+  MarkerMap<TextMatchMarkerList> m_textMatches;
+  MarkerMap<CompositionMarkerList> m_compositions;
+
   const Member<const Document> m_document;
 };
 
 }  // namespace blink
 
 #ifndef NDEBUG
 void showDocumentMarkers(const blink::DocumentMarkerController*);
 #endif
 
 #endif  // DocumentMarkerController_h