[WIP] Add support for Android SuggestionSpans when editing text

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

 /*
  * 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 15 matching lines @@
  *
  */
 
 #include "core/editing/markers/DocumentMarkerController.h"
 
 #include <algorithm>
 #include "core/dom/Node.h"
 #include "core/dom/NodeTraversal.h"
 #include "core/dom/Range.h"
 #include "core/dom/Text.h"
+#include "core/editing/FrameSelection.h"
 #include "core/editing/iterators/TextIterator.h"
 #include "core/editing/markers/CompositionMarker.h"
 #include "core/editing/markers/CompositionMarkerList.h"
 #include "core/editing/markers/DocumentMarkerList.h"
 #include "core/editing/markers/EditingMarkerList.h"
 #include "core/editing/markers/SpellCheckMarker.h"
 #include "core/editing/markers/SpellCheckMarkerList.h"
+#include "core/editing/markers/SuggestionHighlightMarker.h"
+#include "core/editing/markers/SuggestionHighlightMarkerList.h"
+#include "core/editing/markers/SuggestionMarkerList.h"
 #include "core/editing/markers/TextMatchMarkerList.h"
 #include "core/frame/FrameView.h"
+#include "core/frame/LocalFrame.h"
 #include "core/layout/LayoutObject.h"
 
 #ifndef NDEBUG
 #include <stdio.h>
 #endif
 
 namespace blink {
 
 DocumentMarkerController::DocumentMarkerController(Document& document)
     : m_document(&document) {
   setContext(&document);
 }
 
 void DocumentMarkerController::clear() {
   for (DocumentMarker::MarkerType type : DocumentMarker::AllMarkers()) {
     MarkerMap& markerMap = markerMapForType(type);
     markerMap.clear();
   }
+
+  // Don't reset m_nextSuggestionMarkerID so if anything is still holding
+  // onto an old ID, it won't get confused by new markers
 }
 
 void DocumentMarkerController::addGrammarOrSpellingMarker(
     const EphemeralRange& range,
     DocumentMarker::MarkerType type,
     const String& description) {
   DCHECK(!m_document->needsLayoutTreeUpdate());
   DCHECK(type == DocumentMarker::Grammar || type == DocumentMarker::Spelling)
       << type;
   // Use a TextIterator to visit the potentially multiple nodes the range
@@ skipping 43 matching lines @@
 
   for (TextIterator markedText(range.startPosition(), range.endPosition());
        !markedText.atEnd(); markedText.advance()) {
     addMarker(markedText.currentContainer(),
               new CompositionMarker(markedText.startOffsetInCurrentContainer(),
                                     markedText.endOffsetInCurrentContainer(),
                                     underlineColor, thick, backgroundColor));
   }
 }
 
+void DocumentMarkerController::addSuggestionMarker(const EphemeralRange& range,
+                                                   Color underlineColor,
+                                                   bool thick,
+                                                   Color backgroundColor,
+                                                   const Vector<String>& suggestions) {
+  DCHECK(!m_document->needsLayoutTreeUpdate());
+
+  for (TextIterator markedText(range.startPosition(), range.endPosition());
+       !markedText.atEnd(); markedText.advance()) {
+    addMarker(markedText.currentContainer(),
+              new SuggestionMarker(
+                  markedText.startOffsetInCurrentContainer(),
+                  markedText.endOffsetInCurrentContainer(), underlineColor,
+                  thick, backgroundColor, suggestions, m_nextSuggestionMarkerID++));
+  }
+}
+
+void DocumentMarkerController::addSuggestionHighlightMarker(
+    const EphemeralRange& range,
+    Color underlineColor,
+    bool thick,
+    Color backgroundColor) {
+  DCHECK(!m_document->needsLayoutTreeUpdate());
+
+  for (TextIterator markedText(range.startPosition(), range.endPosition());
+       !markedText.atEnd(); markedText.advance()) {
+    addMarker(markedText.currentContainer(),
+              new SuggestionHighlightMarker(
+                                 markedText.startOffsetInCurrentContainer(),
+                                 markedText.endOffsetInCurrentContainer(),
+                                 underlineColor,
+                                 thick, backgroundColor));
+  }
+}
+
 void DocumentMarkerController::prepareForDestruction() {
   clear();
 }
 
 void DocumentMarkerController::removeMarkers(
     const EphemeralRange& range,
     DocumentMarker::MarkerTypes markerTypes,
     RemovePartiallyOverlappingMarkerOrNot
         shouldRemovePartiallyOverlappingMarker) {
   DCHECK(!m_document->needsLayoutTreeUpdate());
@@ skipping 69 matching lines @@
         PaintInvalidationDocumentMarkerChange);
   }
 }
 
 void DocumentMarkerController::removeMarkers(
     Node* node,
     unsigned startOffset,
     int length,
     DocumentMarker::MarkerTypes markerTypes,
     RemovePartiallyOverlappingMarkerOrNot
-        shouldRemovePartiallyOverlappingMarker) {
+    shouldRemovePartiallyOverlappingMarker) {
   if (length <= 0)
     return;
 
   bool docDirty = false;
   for (DocumentMarker::MarkerType type : markerTypes) {
     MarkerMap& markerMap = markerMapForType(type);
     auto it = markerMap.find(node);
     if (it != markerMap.end()) {
       docDirty =
           (it->value->removeMarkers(startOffset, length,
@@ skipping 34 matching lines @@
       it->value->appendMarkersToInputList(&result);
   }
 
   std::sort(result.begin(), result.end(), compareByStart);
   return result;
 }
 
 DocumentMarkerVector DocumentMarkerController::markersInRange(
     const EphemeralRange& range,
     DocumentMarker::MarkerTypes markerTypes) {
+  return markersInRangeInternal(range, markerTypes, false);
+}
 
+DocumentMarkerVector DocumentMarkerController::markersInRangeInclusive(
+    const EphemeralRange& range,
+    DocumentMarker::MarkerTypes markerTypes) {
+  return markersInRangeInternal(range, markerTypes, true);
+}
+
+DocumentMarkerVector DocumentMarkerController::markersInRangeInternal(
+    const EphemeralRange& range,
+    DocumentMarker::MarkerTypes markerTypes,
+    bool includeSpansTouchingEndpoints) {
   DocumentMarkerVector foundMarkers;
 
   Node* startContainer = range.startPosition().computeContainerNode();
-  DCHECK(startContainer);
+  if (!startContainer)
+    return DocumentMarkerVector();
+
   unsigned startOffset = static_cast<unsigned>(
       range.startPosition().computeOffsetInContainerNode());
+
   Node* endContainer = range.endPosition().computeContainerNode();
-  DCHECK(endContainer);
+  if (!endContainer)
+    return DocumentMarkerVector();
+
   unsigned endOffset =
       static_cast<unsigned>(range.endPosition().computeOffsetInContainerNode());
 
   for (Node& node : range.nodes()) {
     for (DocumentMarker* marker : markersFor(&node)) {
       if (!markerTypes.contains(marker->type()))
         continue;
-      if (node == startContainer && marker->endOffset() <= startOffset)
-        continue;
-      if (node == endContainer && marker->startOffset() >= endOffset)
-        continue;
+      if (node == startContainer) {
+        if (marker->endOffset() < startOffset ||
+            (marker->endOffset() == startOffset &&
+             !includeSpansTouchingEndpoints))
+          continue;
+      }
+      if (node == endContainer) {
+        if (marker->startOffset() > endOffset ||
+            (marker->startOffset() == endOffset &&
+             !includeSpansTouchingEndpoints))
+          continue;
+      }
       foundMarkers.push_back(marker);
     }
   }
   return foundMarkers;
 }
 
 Vector<IntRect> DocumentMarkerController::renderedRectsForTextMatchMarkers() {
   Vector<IntRect> result;
   for (auto nodeIterator = m_textMatches.begin();
        nodeIterator != m_textMatches.end(); ++nodeIterator) {
@@ skipping 31 matching lines @@
   for (auto& nodeMarkers : m_textMatches)
     invalidateRectsForTextMatchMarkersInNode(*nodeMarkers.key);
 }
 
 DEFINE_TRACE(DocumentMarkerController) {
   visitor->trace(m_spelling);
   visitor->trace(m_grammar);
   visitor->trace(m_textMatches);
   visitor->trace(m_compositions);
   visitor->trace(m_document);
+  visitor->trace(m_suggestions);
+  visitor->trace(m_suggestionHighlights);
   SynchronousMutationObserver::trace(visitor);
 }
 
 void DocumentMarkerController::removeMarkers(
     Node* node,
     DocumentMarker::MarkerTypes markerTypes) {
   for (DocumentMarker::MarkerType type : markerTypes) {
     MarkerMap& markerMap = markerMapForType(type);
     markerMap.erase(node);
   }
@@ skipping 11 matching lines @@
     const Vector<String>& words) {
   for (auto& nodeMarkers : m_spelling) {
     const Node& node = *nodeMarkers.key;
     if (!node.isTextNode())
       continue;
     toSpellCheckMarkerList(nodeMarkers.value.get())
         ->removeMarkersForWords(static_cast<const Text&>(node).data(), words);
   }
 }
 
+void DocumentMarkerController::removeMarkersForWordsAffectedByEditing(
+    DocumentMarker::MarkerTypes markerTypes,
+    bool doNotRemoveIfSelectionAtWordBoundary) {
+  LOG(INFO) << "removeMarkersForWordsAffectedByEditing: " << doNotRemoveIfSelectionAtWordBoundary;
+  LOG(INFO) << "clearing suggestion markers: " << markerTypes.contains(DocumentMarker::Suggestion);
+  DCHECK(m_document->frame()->selection().isAvailable());
+  TRACE_EVENT0(
+      "blink",
+      "DocumentMarkerController::removeMarkersForWordsAffectedByEditing");
+
+  Document* document = m_document->frame()->document();
+  DCHECK(document);
+
+  // TODO(xiaochengh): The use of updateStyleAndLayoutIgnorePendingStylesheets
+  // needs to be audited.  See http://crbug.com/590369 for more details.
+  document->updateStyleAndLayoutIgnorePendingStylesheets();
+
+  // We want to remove the markers from a word if an editing command will change
+  // the word. This can happen in one of several scenarios:
+  // 1. Insert in the middle of a word.
+  // 2. Appending non whitespace at the beginning of word.
+  // 3. Appending non whitespace at the end of word.
+  // Note that, appending only whitespaces at the beginning or end of word won't
+  // change the word, so we don't need to remove the markers on that word. Of
+  // course, if current selection is a range, we potentially will edit two words
+  // that fall on the boundaries of selection, and remove words between the
+  // selection boundaries.
+  VisiblePosition startOfSelection = m_document->frame()
+                                         ->selection()
+                                         .computeVisibleSelectionInDOMTree()
+                                         .visibleStart();
+  VisiblePosition endOfSelection = m_document->frame()
+                                       ->selection()
+                                       .computeVisibleSelectionInDOMTree()
+                                       .visibleEnd();
+  if (startOfSelection.isNull())
+    return;
+  // First word is the word that ends after or on the start of selection.
+  VisiblePosition startOfFirstWord =
+      startOfWord(startOfSelection, LeftWordIfOnBoundary);
+  VisiblePosition endOfFirstWord =
+      endOfWord(startOfSelection, LeftWordIfOnBoundary);
+  // Last word is the word that begins before or on the end of selection
+  VisiblePosition startOfLastWord =
+      startOfWord(endOfSelection, RightWordIfOnBoundary);
+  VisiblePosition endOfLastWord =
+      endOfWord(endOfSelection, RightWordIfOnBoundary);
+
+  if (startOfFirstWord.isNull()) {
+    startOfFirstWord = startOfWord(startOfSelection, RightWordIfOnBoundary);
+    endOfFirstWord = endOfWord(startOfSelection, RightWordIfOnBoundary);
+  }
+
+  if (endOfLastWord.isNull()) {
+    startOfLastWord = startOfWord(endOfSelection, LeftWordIfOnBoundary);
+    endOfLastWord = endOfWord(endOfSelection, LeftWordIfOnBoundary);
+  }
+
+  // If doNotRemoveIfSelectionAtWordBoundary is true, and first word ends at the
+  // start of selection, we choose next word as the first word.
+  if (doNotRemoveIfSelectionAtWordBoundary &&
+      endOfFirstWord.deepEquivalent() == startOfSelection.deepEquivalent()) {
+    startOfFirstWord = nextWordPosition(startOfFirstWord);
+    endOfFirstWord = endOfWord(startOfFirstWord, RightWordIfOnBoundary);
+    if (startOfFirstWord.deepEquivalent() == endOfSelection.deepEquivalent())
+      return;
+  }
+
+  // If doNotRemoveIfSelectionAtWordBoundary is true, and last word begins at
+  // the end of selection, we choose previous word as the last word.
+  if (doNotRemoveIfSelectionAtWordBoundary &&
+      startOfLastWord.deepEquivalent() == endOfSelection.deepEquivalent()) {
+    startOfLastWord = previousWordPosition(startOfLastWord);
+    endOfLastWord = endOfWord(startOfLastWord, RightWordIfOnBoundary);
+    if (endOfLastWord.deepEquivalent() == startOfSelection.deepEquivalent())
+      return;
+  }
+
+  if (startOfFirstWord.isNull() || endOfFirstWord.isNull() ||
+      startOfLastWord.isNull() || endOfLastWord.isNull())
+    return;
+
+  const Position& removeMarkerStart = startOfFirstWord.deepEquivalent();
+  const Position& removeMarkerEnd = endOfLastWord.deepEquivalent();
+  if (removeMarkerStart > removeMarkerEnd) {
+    // editing/inserting/insert-br-008.html and more reach here.
+    // TODO(yosin): To avoid |DCHECK(removeMarkerStart <= removeMarkerEnd)|
+    // in |EphemeralRange| constructor, we have this if-statement. Once we
+    // fix |startOfWord()| and |endOfWord()|, we should remove this
+    // if-statement.
+    return;
+  }
+
+  // Now we remove markers on everything between startOfFirstWord and
+  // endOfLastWord. However, if an autocorrection change a single word to
+  // multiple words, we want to remove correction mark from all the resulted
+  // words even we only edit one of them. For example, assuming autocorrection
+  // changes "avantgarde" to "avant garde", we will have CorrectionIndicator
+  // marker on both words and on the whitespace between them. If we then edit
+  // garde, we would like to remove the marker from word "avant" and whitespace
+  // as well. So we need to get the continous range of of marker that contains
+  // the word in question, and remove marker on that whole range.
+  const EphemeralRange wordRange(removeMarkerStart, removeMarkerEnd);
+  document->markers().removeMarkers(
+      wordRange, markerTypes,
+      DocumentMarkerController::RemovePartiallyOverlappingMarker);
+}
+
 void DocumentMarkerController::repaintMarkers(
     DocumentMarker::MarkerTypes markerTypes) {
   HeapHashSet<Member<Node>> nodesToRepaint;
   for (DocumentMarker::MarkerType type : markerTypes) {
     MarkerMap& markerMap = markerMapForType(type);
     for (auto& nodeMarkers : markerMap) {
       if (!nodeMarkers.value->empty())
         nodesToRepaint.insert(nodeMarkers.key.get());
     }
   }
@@ skipping 120 matching lines @@
     DocumentMarker::MarkerType type) {
   switch (type) {
     case DocumentMarker::Spelling:
       return new SpellCheckMarkerList(DocumentMarker::Spelling);
     case DocumentMarker::Grammar:
       return new SpellCheckMarkerList(DocumentMarker::Grammar);
     case DocumentMarker::TextMatch:
       return new TextMatchMarkerList();
     case DocumentMarker::Composition:
       return new CompositionMarkerList();
+    case DocumentMarker::Suggestion:
+      return new SuggestionMarkerList();
+    case DocumentMarker::SuggestionHighlight:
+      return new SuggestionHighlightMarkerList();
     default:
       // MSVC thinks this method doesn't handle all enum values even though it
       // does. So we have to return something for the default case to avoid a
       // C4715 warning.
       UNREACHABLE();
       return nullptr;
   }
 }
 
 HeapVector<Member<DocumentMarkerList>>
@@ skipping 24 matching lines @@
     DocumentMarker::MarkerType type) const {
   switch (type) {
     case DocumentMarker::Spelling:
       return m_spelling;
     case DocumentMarker::Grammar:
       return m_grammar;
     case DocumentMarker::TextMatch:
       return m_textMatches;
     case DocumentMarker::Composition:
       return m_compositions;
+    case DocumentMarker::Suggestion:
+      return m_suggestions;
+    case DocumentMarker::SuggestionHighlight:
+      return m_suggestionHighlights;
     default:
       // MSVC thinks this method doesn't handle all enum values even though it
       // does. So we have to return something for the default case to avoid a
       // C4715 warning.
       UNREACHABLE();
       return m_spelling;
   }
 }
 
 void DocumentMarkerController::removeMarkers(
     TextIterator& markedText,
     DocumentMarker::MarkerTypes markerTypes,
     RemovePartiallyOverlappingMarkerOrNot
         shouldRemovePartiallyOverlappingMarker) {
   for (; !markedText.atEnd(); markedText.advance()) {
+    LOG(INFO) << "removing markers from " << markedText.currentContainer() << " from offsets " << markedText.startOffsetInCurrentContainer() << " to " << markedText.endOffsetInCurrentContainer();
     int startOffset = markedText.startOffsetInCurrentContainer();
     int endOffset = markedText.endOffsetInCurrentContainer();
     removeMarkers(markedText.currentContainer(), startOffset,
                   endOffset - startOffset, markerTypes,
                   shouldRemovePartiallyOverlappingMarker);
   }
 }
 
 // SynchronousMutationObserver
 void DocumentMarkerController::didUpdateCharacterData(CharacterData* node,
@@ skipping 24 matching lines @@
 }
 
 }  // namespace blink
 
 #ifndef NDEBUG
 void showDocumentMarkers(const blink::DocumentMarkerController* controller) {
   if (controller)
     controller->showMarkers();
 }
 #endif