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 21 matching lines @@
 #include "core/CoreExport.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 GrammarMarkerList;
 class Node;
-class RenderedDocumentMarker;
-class Text;
-
-class MarkerRemoverPredicate final {
- public:
-  explicit MarkerRemoverPredicate(const Vector<String>& words);
-  bool operator()(const DocumentMarker&, const Text&) const;
-
- private:
-  Vector<String> m_words;
-};
+class RenderedTextMatchMarker;
+class SpellingMarkerList;
+class TextMatchMarkerList;
 
 class CORE_EXPORT DocumentMarkerController final
-    : public GarbageCollected<DocumentMarkerController> {
+    : public GarbageCollectedFinalized<DocumentMarkerController> {
   WTF_MAKE_NONCOPYABLE(DocumentMarkerController);
 
  public:
   explicit DocumentMarkerController(const 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);
 
   void copyMarkers(Node* srcNode,
                    unsigned startOffset,
                    int length,
                    Node* dstNode,
                    int delta);
 
   void prepareForDestruction();
   // When a marker partially overlaps with range, if
   // removePartiallyOverlappingMarkers is true, we completely remove the marker.
   // If the argument is false, we will adjust the span of the marker so that it
   // retains the portion that is outside of the range.
   enum RemovePartiallyOverlappingMarkerOrNot {
     DoNotRemovePartiallyOverlappingMarker,
     RemovePartiallyOverlappingMarker
   };
   void removeMarkers(const EphemeralRange&,
                      DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers(),
                      RemovePartiallyOverlappingMarkerOrNot =
                          DoNotRemovePartiallyOverlappingMarker);

[rlanday, 2017/02/28 00:53:51]

It appears that the RemovePartiallyOverlappingMarker param is only ever set for
spellcheck markers:
https://cs.chromium.org/chromium/src/third_party/WebKit/Source/core/editing/s...

So we may be able to remove this param, at the cost of either re-implementing
removeMarkers() in SpellcheckMarkerList, or hard-coding a check based on the
marker type

[Xiaocheng, 2017/03/01 22:24:48]

It's good if we can get rid of such a parameter.

In fact, the removal of stale spelling markers (namely,
SpellChecker::updateMarkersForWordsBlablabla) has been a performance bottleneck
for a long time.

If seems that we can get rid of that function, and simply maintain existing
markers as a SynchronousMutationObserver...

   void removeMarkers(Node*,
-                     unsigned startOffset,
+                     int startOffset,

[rlanday, 2017/02/28 00:53:51]

I thought about switching all the instances of unsigned ints in
DocumentMarker-related code over to signed ints (just because I think unsigned
ints are generally a bad idea, they don't enforce that values passed in are
non-negative, they just cause the values to overflow instead), but I ended up
punting on that; this change got left in though, how do we feel about this?

[Xiaocheng, 2017/03/01 22:24:48]

Let's discuss in crbug.com/696831

                      int length,
                      DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers(),
                      RemovePartiallyOverlappingMarkerOrNot =
                          DoNotRemovePartiallyOverlappingMarker);
 
   void removeMarkers(
       DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
   void removeMarkers(
       Node*,
       DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
-  void removeMarkers(const MarkerRemoverPredicate& shouldRemoveMarker);
+  void removeSpellingMarkersForWords(const Vector<String>& words);
   void repaintMarkers(
       DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
   void shiftMarkers(Node*, unsigned startOffset, int delta);
   // Returns true if markers within a range are found.
-  bool setMarkersActive(const EphemeralRange&, bool);
+  bool setTextMatchMarkersActive(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 setTextMatchMarkersActive(Node*,
+                                 unsigned startOffset,
+                                 unsigned endOffset,
+                                 bool);
+  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&);
+  Vector<IntRect> renderedRectsForTextMatchMarkers();
+  void updateTextMatchMarkerRenderedRectIfNeeded(const Node&,
+                                                 RenderedTextMatchMarker&);
+  void invalidateRectsForAllTextMatchMarkers();
+  void invalidateRectsForTextMatchMarkersInNode(Node&);
 
   DECLARE_TRACE();
 
 #ifndef NDEBUG
   void showMarkers() const;
 #endif
 
  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);
+  MarkerMap<SpellingMarkerList> m_spelling;
+  MarkerMap<GrammarMarkerList> m_grammar;
+  MarkerMap<TextMatchMarkerList> m_textMatches;
+  MarkerMap<CompositionMarkerList> m_compositions;
+
   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;
   const Member<const Document> m_document;
 };
 
 }  // namespace blink
 
 #ifndef NDEBUG
 void showDocumentMarkers(const blink::DocumentMarkerController*);
 #endif
 
 #endif  // DocumentMarkerController_h