[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 17 matching lines @@
 
 #include "core/editing/markers/DocumentMarkerController.h"
 
 #include "core/dom/Node.h"
 #include "core/dom/NodeTraversal.h"
 #include "core/dom/Range.h"
 #include "core/dom/Text.h"
 #include "core/editing/iterators/TextIterator.h"
 #include "core/editing/markers/RenderedDocumentMarker.h"
 #include "core/frame/FrameView.h"
+#include "core/frame/LocalFrame.h"
 #include "core/layout/LayoutObject.h"
 #include <algorithm>
 
 #ifndef NDEBUG
 #include <stdio.h>
 #endif
 
 namespace blink {
 
 MarkerRemoverPredicate::MarkerRemoverPredicate(const Vector<String>& words)
@@ skipping 16 matching lines @@
     case DocumentMarker::Spelling:
       return DocumentMarker::SpellingMarkerIndex;
     case DocumentMarker::Grammar:
       return DocumentMarker::GrammarMarkerIndex;
     case DocumentMarker::TextMatch:
       return DocumentMarker::TextMatchMarkerIndex;
     case DocumentMarker::InvisibleSpellcheck:
       return DocumentMarker::InvisibleSpellcheckMarkerIndex;
     case DocumentMarker::Composition:
       return DocumentMarker::CompositionMarkerIndex;
+    case DocumentMarker::Suggestion:
+      return DocumentMarker::SuggestionMarkerIndex;
+    case DocumentMarker::SuggestionBackgroundHighlight:
+      return DocumentMarker::SuggestionBackgroundHighlightMarkerIndex;
   }
 
   NOTREACHED();
   return DocumentMarker::SpellingMarkerIndex;
 }
 
 }  // namespace
 
 inline bool DocumentMarkerController::possiblyHasMarkers(
     DocumentMarker::MarkerTypes types) {
   return m_possiblyExistingMarkerTypes.intersects(types);
 }
 
 DocumentMarkerController::DocumentMarkerController(const Document& document)
-    : m_possiblyExistingMarkerTypes(0), m_document(&document) {}
+    : m_possiblyExistingMarkerTypes(0),
+      m_document(&document),
+      m_nextSuggestionMarkerID(0) {}
 
 void DocumentMarkerController::clear() {
   m_markers.clear();
   m_possiblyExistingMarkerTypes = 0;
+  m_nextSuggestionMarkerID = 0;
 }
 
 void DocumentMarkerController::addMarker(const Position& start,
                                          const Position& end,
                                          DocumentMarker::MarkerType type,
                                          const String& description,
                                          uint32_t hash) {
   // Use a TextIterator to visit the potentially multiple nodes the range
   // covers.
   for (TextIterator markedText(start, end); !markedText.atEnd();
@@ skipping 14 matching lines @@
   for (TextIterator markedText(range.startPosition(), range.endPosition());
        !markedText.atEnd(); markedText.advance())
     addMarker(
         markedText.currentContainer(),
         DocumentMarker(markedText.startOffsetInCurrentContainer(),
                        markedText.endOffsetInCurrentContainer(), activeMatch));
   // Don't invalidate tickmarks here. TextFinder invalidates tickmarks using a
   // throttling algorithm. crbug.com/6819.
 }
 
-void DocumentMarkerController::addCompositionMarker(const Position& start,
-                                                    const Position& end,
-                                                    Color underlineColor,
-                                                    bool thick,
-                                                    Color backgroundColor) {
+void DocumentMarkerController::addCompositionMarker(
+    const Position& start,
+    const Position& end,
+    Color underlineColor,
+    bool thick,
+    Color backgroundColor,
+    const std::vector<std::string>& suggestions) {

[esprehn, 2017/01/31 22:41:35]

ditto

[rlanday, 2017/01/31 23:30:09]

Ok

+  DCHECK(!m_document->needsLayoutTreeUpdate());
+  for (TextIterator markedText(start, end); !markedText.atEnd();
+       markedText.advance()) {
+    addMarker(markedText.currentContainer(),
+              DocumentMarker(markedText.startOffsetInCurrentContainer(),
+                             markedText.endOffsetInCurrentContainer(),
+                             underlineColor, thick, backgroundColor,
+                             suggestions, m_nextSuggestionMarkerID++));
+  }
+}
+
+void DocumentMarkerController::addSuggestionBackgroundHighlightMarker(
+    const Position& start,
+    const Position& end,
+    Color underlineColor,
+    bool thick,
+    Color backgroundColor) {
   DCHECK(!m_document->needsLayoutTreeUpdate());
 
   for (TextIterator markedText(start, end); !markedText.atEnd();
-       markedText.advance())
+       markedText.advance()) {
     addMarker(markedText.currentContainer(),
-              DocumentMarker(markedText.startOffsetInCurrentContainer(),
+              DocumentMarker(DocumentMarker::SuggestionBackgroundHighlight,
+                             markedText.startOffsetInCurrentContainer(),
                              markedText.endOffsetInCurrentContainer(),
                              underlineColor, thick, backgroundColor));
+  }
 }
 
 void DocumentMarkerController::prepareForDestruction() {
   clear();
 }
 
 void DocumentMarkerController::removeMarkers(
     TextIterator& markedText,
     DocumentMarker::MarkerTypes markerTypes,
     RemovePartiallyOverlappingMarkerOrNot
         shouldRemovePartiallyOverlappingMarker) {
   for (; !markedText.atEnd(); markedText.advance()) {
     if (!possiblyHasMarkers(markerTypes))
       return;
     DCHECK(!m_markers.isEmpty());
 
     int startOffset = markedText.startOffsetInCurrentContainer();
     int endOffset = markedText.endOffsetInCurrentContainer();
+
     removeMarkers(markedText.currentContainer(), startOffset,
                   endOffset - startOffset, markerTypes,
                   shouldRemovePartiallyOverlappingMarker);
   }
 }
 
 void DocumentMarkerController::removeMarkers(
     const EphemeralRange& range,
     DocumentMarker::MarkerTypes markerTypes,
     RemovePartiallyOverlappingMarkerOrNot
         shouldRemovePartiallyOverlappingMarker) {
   DCHECK(!m_document->needsLayoutTreeUpdate());
 
   TextIterator markedText(range.startPosition(), range.endPosition());
   DocumentMarkerController::removeMarkers(
       markedText, markerTypes, shouldRemovePartiallyOverlappingMarker);
 }
 
 static bool startsFurther(const Member<RenderedDocumentMarker>& lhv,
                           const DocumentMarker* rhv) {
   return lhv->startOffset() < rhv->startOffset();
 }
 
-static bool startsAfter(const Member<RenderedDocumentMarker>& marker,
-                        size_t startOffset) {
-  return marker->startOffset() < startOffset;
-}
-
 static bool compareByStart(const Member<DocumentMarker>& lhv,
                            const Member<DocumentMarker>& rhv) {
   return lhv->startOffset() < rhv->startOffset();
 }
 
 static bool doesNotOverlap(const Member<RenderedDocumentMarker>& lhv,
                            const DocumentMarker* rhv) {
   return lhv->endOffset() < rhv->startOffset();
 }
 
@@ skipping 46 matching lines @@
     markers->at(markerListIndex) = new MarkerList;
   }
 
   Member<MarkerList>& list = markers->at(markerListIndex);
   RenderedDocumentMarker* newRenderedMarker =
       RenderedDocumentMarker::create(newMarker);
   if (list->isEmpty() || list->back()->endOffset() < newMarker.startOffset()) {
     list->push_back(newRenderedMarker);
   } else {
     if (newMarker.type() != DocumentMarker::TextMatch &&
-        newMarker.type() != DocumentMarker::Composition) {
+        newMarker.type() != DocumentMarker::Composition &&
+        newMarker.type() != DocumentMarker::Suggestion) {
       mergeOverlapping(list.get(), newRenderedMarker);
     } else {
       MarkerList::iterator pos = std::lower_bound(list->begin(), list->end(),
                                                   &newMarker, startsFurther);
       list->insert(pos - list->begin(), newRenderedMarker);
     }
   }
 
   // repaint the affected node
   if (node->layoutObject())
@@ skipping 78 matching lines @@
     unsigned startOffset,
     int length,
     DocumentMarker::MarkerTypes markerTypes,
     RemovePartiallyOverlappingMarkerOrNot
         shouldRemovePartiallyOverlappingMarker) {
   if (length <= 0)
     return;
 
   if (!possiblyHasMarkers(markerTypes))
     return;
+
   DCHECK(!(m_markers.isEmpty()));
 
   MarkerLists* markers = m_markers.get(node);
   if (!markers)
     return;
 
   bool docDirty = false;
   size_t emptyListsCount = 0;
   for (size_t markerListIndex = 0;
        markerListIndex < DocumentMarker::MarkerTypeIndexesCount;
@@ skipping 101 matching lines @@
         result.push_back(list->at(j).get());
     }
   }
   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) {
   if (!possiblyHasMarkers(markerTypes))
     return DocumentMarkerVector();
 
   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::renderedRectsForMarkers(
     DocumentMarker::MarkerType markerType) {
   Vector<IntRect> result;
 
@@ skipping 130 matching lines @@
   unsigned size = nodesWithMarkers.size();
   for (unsigned i = 0; i < size; ++i) {
     MarkerMap::iterator iterator = m_markers.find(nodesWithMarkers[i]);
     if (iterator != m_markers.end())
       removeMarkersFromList(iterator, markerTypes);
   }
 
   m_possiblyExistingMarkerTypes.remove(markerTypes);
 }
 
+void DocumentMarkerController::removeSuggestionMarkersByID(
+    const Vector<int>& idsToRemove) {
+  for (auto& nodeMarkers : m_markers) {
+    MarkerLists& markers = *nodeMarkers.value;
+    Member<MarkerList>& suggestionMarkerList =
+        markers[DocumentMarker::SuggestionMarkerIndex];
+    if (!suggestionMarkerList)
+      continue;
+    bool removedMarkers = false;
+    for (size_t j = suggestionMarkerList->size(); j > 0; --j) {
+      if (idsToRemove.contains(
+              suggestionMarkerList->at(j - 1)->suggestionMarkerID())) {
+        suggestionMarkerList->remove(j - 1);
+        removedMarkers = true;
+      }
+    }
+  }
+}
+
+void DocumentMarkerController::removeMarkersForWordsAffectedByEditing(
+    DocumentMarker::MarkerTypes markerTypes,
+    bool doNotRemoveIfSelectionAtWordBoundary) {
+  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().selection().visibleStart();
+  VisiblePosition endOfSelection =
+      m_document->frame()->selection().selection().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::removeMarkersFromList(
     MarkerMap::iterator iterator,
     DocumentMarker::MarkerTypes markerTypes) {
   bool needsRepainting = false;
   bool nodeCanBeRemoved;
 
   size_t emptyListsCount = 0;
   if (markerTypes == DocumentMarker::AllMarkers()) {
     needsRepainting = true;
     nodeCanBeRemoved = true;
@@ skipping 60 matching lines @@
       // cause the node to be redrawn
       if (LayoutObject* layoutObject = node->layoutObject()) {
         layoutObject->setShouldDoFullPaintInvalidation();
         break;
       }
     }
   }
 }
 
 void DocumentMarkerController::shiftMarkers(Node* node,
-                                            unsigned startOffset,
-                                            int delta) {
+                                            int startOffset,
+                                            int prevLength,
+                                            int newLength) {
+  DCHECK_GE(startOffset, 0);
+  DCHECK_GE(prevLength, 0);
+  DCHECK_GE(newLength, 0);
+
   if (!possiblyHasMarkers(DocumentMarker::AllMarkers()))
     return;
   DCHECK(!m_markers.isEmpty());
 
   MarkerLists* markers = m_markers.get(node);
   if (!markers)
     return;
 
   bool didShiftMarker = false;
   for (size_t markerListIndex = 0;
        markerListIndex < DocumentMarker::MarkerTypeIndexesCount;
        ++markerListIndex) {
     Member<MarkerList>& list = (*markers)[markerListIndex];
     if (!list)
       continue;
-    MarkerList::iterator startPos =
-        std::lower_bound(list->begin(), list->end(), startOffset, startsAfter);
-    for (MarkerList::iterator marker = startPos; marker != list->end();
+
+    // algorithm from https://dom.spec.whatwg.org/#concept-cd-replace

[rlanday, 2017/01/31 19:50:22]

This is fancy logic that lets you replace part of the text spanned by a
DocumentMarker and have the marker track it properly...it requires two changes
above where I changed replace to be "insert, then delete" instead of "delete,
then insert" because that's the only way we can get the new text to still be in
the marked range.

+    for (MarkerList::iterator marker = list->begin(); marker != list->end();
          ++marker) {
-#if DCHECK_IS_ON()
-      int startOffset = (*marker)->startOffset();
-      DCHECK_GE(startOffset + delta, 0);
-#endif
-      (*marker)->shiftOffsets(delta);
+      if ((*marker)->startOffset() > (unsigned)startOffset) {
+        if ((*marker)->startOffset() <= (unsigned)(startOffset + prevLength)) {
+          // Marker start was in the replaced text. Move to beginning of new
+          // text
+          (*marker)->setStartOffset(startOffset);
+        } else {
+          // Marker start was after the replaced text. Shift by length
+          // difference
+          unsigned oldStartOffset = (*marker)->startOffset();
+          (*marker)->setStartOffset(oldStartOffset + newLength - prevLength);
+        }
+      }
+
+      if ((*marker)->endOffset() > (unsigned)startOffset) {
+        if ((*marker)->endOffset() <= (unsigned)(startOffset + prevLength)) {
+          // Marker end was in the replaced text. Move to beginning of new text
+          (*marker)->setEndOffset(startOffset);
+        } else {
+          // Marker end was after the replaced text. Shift by length difference
+          unsigned oldEndOffset = (*marker)->endOffset();
+          (*marker)->setEndOffset(oldEndOffset + newLength - prevLength);
+        }
+      }
+
       didShiftMarker = true;
     }
   }
 
   if (didShiftMarker) {
     invalidateRectsForMarkersInNode(*node);
     // repaint the affected node
     if (node->layoutObject())
       node->layoutObject()->setShouldDoFullPaintInvalidation();
   }
@@ skipping 89 matching lines @@
 #endif
 
 }  // namespace blink
 
 #ifndef NDEBUG
 void showDocumentMarkers(const blink::DocumentMarkerController* controller) {
   if (controller)
     controller->showMarkers();
 }
 #endif