Source/WebCore/dom/DocumentMarkerController.cpp - WebKit - Git at Google

 /*
  * 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-2020 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.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
  * License as published by the Free Software Foundation; either
  * version 2 of the License, or (at your option) any later version.
  *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Library General Public License for more details.
  *
  * You should have received a copy of the GNU Library General Public License
  * along with this library; see the file COPYING.LIB.  If not, write to
  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  *
  */

 #include "config.h"
 #include "DocumentMarkerController.h"

 #include "Chrome.h"
 #include "ChromeClient.h"
 #include "Frame.h"
 #include "NodeTraversal.h"
 #include "Page.h"
 #include "RenderBlockFlow.h"
 #include "RenderLayer.h"
 #include "RenderText.h"
 #include "RenderedDocumentMarker.h"
 #include "TextIterator.h"
 #include <stdio.h>

 namespace WebCore {

 inline bool DocumentMarkerController::possiblyHasMarkers(OptionSet<DocumentMarker::MarkerType> types)
 {
     return m_possiblyExistingMarkerTypes.containsAny(types);
 }

 DocumentMarkerController::DocumentMarkerController(Document& document)
     : m_document(document)
 {
 }

 DocumentMarkerController::~DocumentMarkerController() = default;

 void DocumentMarkerController::detach()
 {
     m_markers.clear();
     m_possiblyExistingMarkerTypes = { };
 }

 auto DocumentMarkerController::collectTextRanges(const SimpleRange& range) -> Vector<TextRange>
 {
     Vector<TextRange> ranges;
     for (TextIterator iterator(range); !iterator.atEnd(); iterator.advance()) {
         auto currentRange = iterator.range();
         ranges.append({ WTFMove(currentRange.start.container), { currentRange.start.offset, currentRange.end.offset } });
     }
     return ranges;
 }

 void DocumentMarkerController::addMarker(const SimpleRange& range, DocumentMarker::MarkerType type, const DocumentMarker::Data& data)
 {
     for (auto& textPiece : collectTextRanges(range))
         addMarker(textPiece.node, { type, textPiece.range, DocumentMarker::Data { data } });
 }

 void DocumentMarkerController::addMarker(Text& node, unsigned startOffset, unsigned length, DocumentMarker::MarkerType type, DocumentMarker::Data&& data)
 {
     addMarker(node, { type, { startOffset, startOffset + length }, WTFMove(data) });
 }

 void DocumentMarkerController::addDraggedContentMarker(const SimpleRange& range)
 {
     // FIXME: Since the marker is already stored in a map keyed by node, we can probably change things around so we don't have to also store the node in the marker.
     for (auto& textPiece : collectTextRanges(range))
         addMarker(textPiece.node, { DocumentMarker::DraggedContent, textPiece.range, RefPtr<Node> { textPiece.node.ptr() } });
 }

 void DocumentMarkerController::removeMarkers(const SimpleRange& range, OptionSet<DocumentMarker::MarkerType> types, RemovePartiallyOverlappingMarker overlapRule)
 {
     filterMarkers(range, nullptr, types, overlapRule);
 }

 void DocumentMarkerController::filterMarkers(const SimpleRange& range, const Function<FilterMarkerResult(const DocumentMarker&)>& filter, OptionSet<DocumentMarker::MarkerType> types, RemovePartiallyOverlappingMarker overlapRule)
 {
     for (auto& textPiece : collectTextRanges(range)) {
         if (!possiblyHasMarkers(types))
             return;
         ASSERT(!m_markers.isEmpty());
         removeMarkers(textPiece.node, textPiece.range, types, filter, overlapRule);
     }
 }

 static void updateRenderedRectsForMarker(RenderedDocumentMarker& marker, Node& node)
 {
     ASSERT(!node.document().view() || !node.document().view()->needsLayout());
     marker.setUnclippedAbsoluteRects(boundingBoxes(RenderObject::absoluteTextQuads(makeSimpleRange(node, marker), RenderObject::BoundingRectBehavior::UseSelectionHeight)));
 }

 void DocumentMarkerController::invalidateRectsForAllMarkers()
 {
     if (!hasMarkers())
         return;

     for (auto& nodeMarkers : m_markers.values()) {
         for (auto& marker : *nodeMarkers)
             marker.invalidate();
     }

     if (Page* page = m_document.page())
         page->chrome().client().didInvalidateDocumentMarkerRects();
 }

 void DocumentMarkerController::invalidateRectsForMarkersInNode(Node& node)
 {
     if (!hasMarkers())
         return;

     auto markers = m_markers.get(&node);
     ASSERT(markers);

     for (auto& marker : *markers)
         marker.invalidate();

     if (Page* page = m_document.page())
         page->chrome().client().didInvalidateDocumentMarkerRects();
 }

 static void updateMainFrameLayoutIfNeeded(Document& document)
 {
     Frame* frame = document.frame();
     if (!frame)
         return;

     FrameView* mainFrameView = frame->mainFrame().view();
     if (!mainFrameView)
         return;

     mainFrameView->updateLayoutAndStyleIfNeededRecursive();
 }

 void DocumentMarkerController::updateRectsForInvalidatedMarkersOfType(DocumentMarker::MarkerType type)
 {
     if (!possiblyHasMarkers(type))
         return;
     ASSERT(!m_markers.isEmpty());

     bool updatedLayout = false;
     for (auto& nodeMarkers : m_markers) {
         for (auto& marker : *nodeMarkers.value) {
             if (marker.type() != type || marker.isValid())
                 continue;
             if (!updatedLayout) {
                 updateMainFrameLayoutIfNeeded(m_document);
                 updatedLayout = true;
             }
             updateRenderedRectsForMarker(marker, *nodeMarkers.key);
         }
     }
 }

 Vector<FloatRect> DocumentMarkerController::renderedRectsForMarkers(DocumentMarker::MarkerType type)
 {
     Vector<FloatRect> result;

     if (!possiblyHasMarkers(type))
         return result;
     ASSERT(!m_markers.isEmpty());

     RefPtr<Frame> frame = m_document.frame();
     if (!frame)
         return result;
     FrameView* frameView = frame->view();
     if (!frameView)
         return result;

     updateRectsForInvalidatedMarkersOfType(type);

     bool isSubframe = !frame->isMainFrame();
     IntRect subframeClipRect;
     if (isSubframe)
         subframeClipRect = frameView->windowToContents(frameView->windowClipRect());

     for (auto& nodeMarkers : m_markers) {
         auto renderer = nodeMarkers.key->renderer();
         FloatRect overflowClipRect;
         if (renderer)
             overflowClipRect = renderer->absoluteClippedOverflowRectForRepaint();
         for (auto& marker : *nodeMarkers.value) {
             if (marker.type() != type)
                 continue;

             auto renderedRects = marker.unclippedAbsoluteRects();

             // Clip document markers by their overflow clip.
             if (renderer) {
                 for (auto& rect : renderedRects)
                     rect.intersect(overflowClipRect);
             }

             // Clip subframe document markers by their frame.
             if (isSubframe) {
                 for (auto& rect : renderedRects)
                     rect.intersect(subframeClipRect);
             }

             for (const auto& rect : renderedRects) {
                 if (!rect.isEmpty())
                     result.append(rect);
             }
         }
     }

     return result;
 }

 static bool shouldInsertAsSeparateMarker(const DocumentMarker& marker)
 {
 #if ENABLE(PLATFORM_DRIVEN_TEXT_CHECKING)
     if (marker.type() == DocumentMarker::PlatformTextChecking)
         return true;
 #endif

 #if PLATFORM(IOS_FAMILY)
     if (marker.type() == DocumentMarker::DictationPhraseWithAlternatives || marker.type() == DocumentMarker::DictationResult)
         return true;
 #endif

     if (marker.type() == DocumentMarker::DraggedContent)
         return is<RenderReplaced>(std::get<RefPtr<Node>>(marker.data())->renderer());

     return false;
 }

 // Markers are stored in order sorted by their start offset.
 // Markers of the same type do not overlap each other.

 void DocumentMarkerController::addMarker(Node& node, DocumentMarker&& newMarker)
 {
     ASSERT(newMarker.endOffset() >= newMarker.startOffset());
     if (newMarker.endOffset() == newMarker.startOffset())
         return;

     m_possiblyExistingMarkerTypes.add(newMarker.type());

     auto& list = m_markers.add(&node, nullptr).iterator->value;

     if (!list) {
         list = makeUnique<Vector<RenderedDocumentMarker>>();
         list->append(RenderedDocumentMarker(WTFMove(newMarker)));
     } else if (shouldInsertAsSeparateMarker(newMarker)) {
         // We don't merge dictation markers.
         size_t i;
         size_t numberOfMarkers = list->size();
         for (i = 0; i < numberOfMarkers; ++i) {
             DocumentMarker marker = list->at(i);
             if (marker.startOffset() > newMarker.startOffset())
                 break;
         }
         list->insert(i, RenderedDocumentMarker(WTFMove(newMarker)));
     } else {
         RenderedDocumentMarker toInsert(WTFMove(newMarker));
         size_t numMarkers = list->size();
         size_t i;
         // Iterate over all markers whose start offset is less than or equal to the new marker's.
         // If one of them is of the same type as the new marker and touches it or intersects with it
         // (there is at most one), remove it and adjust the new marker's start offset to encompass it.
         for (i = 0; i < numMarkers; ++i) {
             DocumentMarker marker = list->at(i);
             if (marker.startOffset() > toInsert.startOffset())
                 break;
             if (marker.type() == toInsert.type() && marker.endOffset() >= toInsert.startOffset()) {
                 toInsert.setStartOffset(marker.startOffset());
                 list->remove(i);
                 numMarkers--;
                 break;
             }
         }
         size_t j = i;
         // Iterate over all markers whose end offset is less than or equal to the new marker's,
         // removing markers of the same type as the new marker which touch it or intersect with it,
         // adjusting the new marker's end offset to cover them if necessary.
         while (j < numMarkers) {
             DocumentMarker marker = list->at(j);
             if (marker.startOffset() > toInsert.endOffset())
                 break;
             if (marker.type() == toInsert.type()) {
                 list->remove(j);
                 if (toInsert.endOffset() <= marker.endOffset()) {
                     toInsert.setEndOffset(marker.endOffset());
                     break;
                 }
                 numMarkers--;
             } else
                 j++;
         }
         // At this point i points to the node before which we want to insert.
         list->insert(i, RenderedDocumentMarker(toInsert));
     }

     if (node.renderer())
         node.renderer()->repaint();

     invalidateRectsForMarkersInNode(node);
 }

 // Copies markers from source to destination, applying the specified shift delta to the copies. The shift is
 // useful if, e.g., the caller has created the destination from a non-prefix substring of the source.
 void DocumentMarkerController::copyMarkers(Node& source, OffsetRange range, Node& destination)
 {
     if (range.start >= range.end)
         return;

     if (!possiblyHasMarkers(DocumentMarker::allMarkers()))
         return;
     ASSERT(!m_markers.isEmpty());

     auto list = m_markers.get(&source);
     if (!list)
         return;

     bool needRepaint = false;
     for (auto& marker : *list) {
         // Stop if we are now past the specified range.
         if (marker.startOffset() >= range.end)
             break;

         // Skip marker that is before the specified range.
         if (marker.endOffset() < range.start)
             continue;

         // Pin the marker to the specified range and apply the shift delta.
         auto copiedMarker = marker;
         if (copiedMarker.startOffset() < range.start)
             copiedMarker.setStartOffset(range.start);
         if (copiedMarker.endOffset() >= range.end)
             copiedMarker.setEndOffset(range.end);

         addMarker(destination, WTFMove(copiedMarker));
         needRepaint = true;
     }

     if (needRepaint) {
         if (auto renderer = destination.renderer())
             renderer->repaint();
     }
 }

 void DocumentMarkerController::removeMarkers(Node& node, OffsetRange range, OptionSet<DocumentMarker::MarkerType> types, const Function<FilterMarkerResult(const DocumentMarker&)>& filter, RemovePartiallyOverlappingMarker overlapRule)
 {
     if (range.start >= range.end)
         return;

     if (!possiblyHasMarkers(types))
         return;
     ASSERT(!m_markers.isEmpty());

     auto list = m_markers.get(&node);
     if (!list)
         return;

     bool needRepaint = false;
     for (size_t i = 0; i < list->size(); ) {
         auto& marker = list->at(i);

         // markers are returned in order, so stop if we are now past the specified range
         if (marker.startOffset() >= range.end)
             break;

         // skip marker that is wrong type or before target
         if (marker.endOffset() <= range.start || !types.contains(marker.type())) {
             i++;
             continue;
         }

         if (filter && filter(marker) == FilterMarkerResult::Keep) {
             i++;
             continue;
         }

         // At this point we know that marker and target intersect in some way.
         needRepaint = true;

         DocumentMarker copiedMarker = marker;
         list->remove(i);
         if (overlapRule == RemovePartiallyOverlappingMarker::Yes)
             continue;

         // Add either of the resulting slices that remain after removing target.
         if (range.start > copiedMarker.startOffset()) {
             auto newLeft = copiedMarker;
             newLeft.setEndOffset(range.start);
             list->insert(i, RenderedDocumentMarker(WTFMove(newLeft)));
             i++;
         }
         if (copiedMarker.endOffset() > range.end) {
             copiedMarker.setStartOffset(range.end);
             list->insert(i, RenderedDocumentMarker(WTFMove(copiedMarker)));
             i++;
         }
     }

     if (list->isEmpty()) {
         m_markers.remove(&node);
         if (m_markers.isEmpty())
             m_possiblyExistingMarkerTypes = { };
     }

     if (needRepaint) {
         if (auto renderer = node.renderer())
             renderer->repaint();
     }
 }

 DocumentMarker* DocumentMarkerController::markerContainingPoint(const LayoutPoint& point, DocumentMarker::MarkerType type)
 {
     if (!possiblyHasMarkers(type))
         return nullptr;
     ASSERT(!m_markers.isEmpty());

     updateRectsForInvalidatedMarkersOfType(type);
     for (auto& nodeMarkers : m_markers.values()) {
         for (auto& marker : *nodeMarkers) {
             if (marker.type() == type && marker.contains(point))
                 return &marker;
         }
     }
     return nullptr;
 }

 Vector<RenderedDocumentMarker*> DocumentMarkerController::markersFor(Node& node, OptionSet<DocumentMarker::MarkerType> types)
 {
     if (!possiblyHasMarkers(types))
         return { };

     Vector<RenderedDocumentMarker*> result;
     auto list = m_markers.get(&node);
     if (!list)
         return result;

     for (auto& marker : *list) {
         if (types.contains(marker.type()))
             result.append(&marker);
     }

     return result;
 }

 void DocumentMarkerController::forEach(const SimpleRange& range, OptionSet<DocumentMarker::MarkerType> types, Function<bool(RenderedDocumentMarker&)> function)
 {
     if (!possiblyHasMarkers(types))
         return;
     ASSERT(!m_markers.isEmpty());

     for (auto& node : intersectingNodes(range)) {
         if (auto list = m_markers.get(&node)) {
             auto offsetRange = characterDataOffsetRange(range, node);
             for (auto& marker : *list) {
                 // Markers are stored in order, so stop if we are now past the specified range.
                 if (marker.startOffset() >= offsetRange.end)
                     break;
                 if (marker.endOffset() > offsetRange.start && types.contains(marker.type())) {
                     if (function(marker))
                         return;
                 }
             }
         }
     }
 }

 Vector<RenderedDocumentMarker*> DocumentMarkerController::markersInRange(const SimpleRange& range, OptionSet<DocumentMarker::MarkerType> types)
 {
     // FIXME: Consider making forEach public and changing callers to use that function instead of this one.
     Vector<RenderedDocumentMarker*> markers;
     forEach(range, types, [&] (RenderedDocumentMarker& marker) {
         markers.append(&marker);
         return false;
     });
     return markers;
 }

 void DocumentMarkerController::removeMarkers(Node& node, OptionSet<DocumentMarker::MarkerType> types)
 {
     if (!possiblyHasMarkers(types))
         return;
     ASSERT(!m_markers.isEmpty());

     auto iterator = m_markers.find(&node);
     if (iterator != m_markers.end())
         removeMarkersFromList(iterator, types);
 }

 void DocumentMarkerController::removeMarkers(OptionSet<DocumentMarker::MarkerType> types)
 {
     if (!possiblyHasMarkers(types))
         return;
     ASSERT(!m_markers.isEmpty());

     for (auto& node : copyToVector(m_markers.keys()))
         removeMarkersFromList(m_markers.find(node), types);
     m_possiblyExistingMarkerTypes.remove(types);
 }

 void DocumentMarkerController::removeMarkersFromList(MarkerMap::iterator iterator, OptionSet<DocumentMarker::MarkerType> types)
 {
     bool needsRepainting = false;
     bool listCanBeRemoved;

     if (types == DocumentMarker::allMarkers()) {
         needsRepainting = true;
         listCanBeRemoved = true;
     } else {
         auto list = iterator->value.get();

         for (size_t i = 0; i != list->size(); ) {
             DocumentMarker marker = list->at(i);

             // skip nodes that are not of the specified type
             if (!types.contains(marker.type())) {
                 ++i;
                 continue;
             }

             // pitch the old marker
             list->remove(i);
             needsRepainting = true;
             // i now is the index of the next marker
         }

         listCanBeRemoved = list->isEmpty();
     }

     if (needsRepainting) {
         if (auto renderer = iterator->key->renderer())
             renderer->repaint();
     }

     if (listCanBeRemoved) {
         m_markers.remove(iterator);
         if (m_markers.isEmpty())
             m_possiblyExistingMarkerTypes = { };
     }
 }

 void DocumentMarkerController::repaintMarkers(OptionSet<DocumentMarker::MarkerType> types)
 {
     if (!possiblyHasMarkers(types))
         return;
     ASSERT(!m_markers.isEmpty());

     for (auto& nodeMarkers : m_markers) {
         for (auto& marker : *nodeMarkers.value) {
             if (types.contains(marker.type())) {
                 if (auto renderer = nodeMarkers.key->renderer())
                     renderer->repaint();
                 break;
             }
         }
     }
 }

 void DocumentMarkerController::shiftMarkers(Node& node, unsigned startOffset, int delta)
 {
     if (!possiblyHasMarkers(DocumentMarker::allMarkers()))
         return;
     ASSERT(!m_markers.isEmpty());

     auto list = m_markers.get(&node);
     if (!list)
         return;

     bool didShiftMarker = false;
     for (size_t i = 0; i != list->size(); ) {
         auto& marker = list->at(i);

 #if PLATFORM(IOS_FAMILY)
         // FIXME: No obvious reason this should be iOS-specific. Remove the #if at some point.
         auto targetStartOffset = clampTo<unsigned>(static_cast<int>(marker.startOffset()) + delta);
         auto targetEndOffset = clampTo<unsigned>(static_cast<int>(marker.endOffset()) + delta);
         if (targetStartOffset >= node.length() || targetEndOffset <= 0) {
             list->remove(i);
             continue;
         }
 #endif

         if (marker.startOffset() >= startOffset) {
             ASSERT((int)marker.startOffset() + delta >= 0);
             marker.shiftOffsets(delta);
             didShiftMarker = true;
         }
 #if PLATFORM(IOS_FAMILY)
         // FIXME: No obvious reason this should be iOS-specific. Remove the #if at some point.
         else if (marker.endOffset() > startOffset) {
             if (targetEndOffset <= marker.startOffset()) {
                 list->remove(i);
                 continue;
             }
             marker.setEndOffset(std::min(targetEndOffset, node.length()));
             didShiftMarker = true;
         }
 #endif

         ++i;
     }

     if (didShiftMarker) {
         invalidateRectsForMarkersInNode(node);
         if (auto renderer = node.renderer())
             renderer->repaint();
     }
 }

 bool DocumentMarkerController::hasMarkers(const SimpleRange& range, OptionSet<DocumentMarker::MarkerType> types)
 {
     bool foundMarker = false;
     forEach(range, types, [&] (RenderedDocumentMarker&) {
         foundMarker = true;
         return true;
     });
     return foundMarker;
 }

 void DocumentMarkerController::clearDescriptionOnMarkersIntersectingRange(const SimpleRange& range, OptionSet<DocumentMarker::MarkerType> types)
 {
     forEach(range, types, [&] (RenderedDocumentMarker& marker) {
         marker.clearData();
         return false;
     });
 }

 void addMarker(const SimpleRange& range, DocumentMarker::MarkerType type, const DocumentMarker::Data& data)
 {
     range.start.document().markers().addMarker(range, type, data);
 }

 void addMarker(Text& node, unsigned startOffset, unsigned length, DocumentMarker::MarkerType type, DocumentMarker::Data&& data)
 {
     node.document().markers().addMarker(node, startOffset, length, type, WTFMove(data));
 }

 void removeMarkers(const SimpleRange& range, OptionSet<DocumentMarker::MarkerType> types, RemovePartiallyOverlappingMarker policy)
 {
     range.start.document().markers().removeMarkers(range, types, policy);
 }

 SimpleRange makeSimpleRange(Node& node, const DocumentMarker& marker)
 {
     unsigned startOffset = marker.startOffset();
     unsigned endOffset = marker.endOffset();
     return { { node, startOffset }, { node, endOffset } };
 }

 #if ENABLE(TREE_DEBUGGING)

 void DocumentMarkerController::showMarkers() const
 {
     fprintf(stderr, "%d nodes have markers:\n", m_markers.size());
     for (auto& nodeMarkers : m_markers) {
         fprintf(stderr, "%p", nodeMarkers.key.get());
         for (auto& marker : *nodeMarkers.value)
             fprintf(stderr, " %d:[%d:%d]", marker.type(), marker.startOffset(), marker.endOffset());
         fputc('\n', stderr);
     }
 }

 #endif

 } // namespace WebCore

 #if ENABLE(TREE_DEBUGGING)

 void showDocumentMarkers(const WebCore::DocumentMarkerController* controller)
 {
     if (controller)
         controller->showMarkers();
 }

 #endif
	/*
	* 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-2020 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.
	*
	* This library is free software; you can redistribute it and/or
	* modify it under the terms of the GNU Library General Public
	* License as published by the Free Software Foundation; either
	* version 2 of the License, or (at your option) any later version.
	*
	* This library is distributed in the hope that it will be useful,
	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	* Library General Public License for more details.
	*
	* You should have received a copy of the GNU Library General Public License
	* along with this library; see the file COPYING.LIB. If not, write to
	* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
	* Boston, MA 02110-1301, USA.
	*
	*/

	#include "config.h"
	#include "DocumentMarkerController.h"

	#include "Chrome.h"
	#include "ChromeClient.h"
	#include "Frame.h"
	#include "NodeTraversal.h"
	#include "Page.h"
	#include "RenderBlockFlow.h"
	#include "RenderLayer.h"
	#include "RenderText.h"
	#include "RenderedDocumentMarker.h"
	#include "TextIterator.h"
	#include <stdio.h>

	namespace WebCore {

	inline bool DocumentMarkerController::possiblyHasMarkers(OptionSet<DocumentMarker::MarkerType> types)
	{
	return m_possiblyExistingMarkerTypes.containsAny(types);
	}

	DocumentMarkerController::DocumentMarkerController(Document& document)
	: m_document(document)
	{
	}

	DocumentMarkerController::~DocumentMarkerController() = default;

	void DocumentMarkerController::detach()
	{
	m_markers.clear();
	m_possiblyExistingMarkerTypes = { };
	}

	auto DocumentMarkerController::collectTextRanges(const SimpleRange& range) -> Vector<TextRange>
	{
	Vector<TextRange> ranges;
	for (TextIterator iterator(range); !iterator.atEnd(); iterator.advance()) {
	auto currentRange = iterator.range();
	ranges.append({ WTFMove(currentRange.start.container), { currentRange.start.offset, currentRange.end.offset } });
	}
	return ranges;
	}

	void DocumentMarkerController::addMarker(const SimpleRange& range, DocumentMarker::MarkerType type, const DocumentMarker::Data& data)
	{
	for (auto& textPiece : collectTextRanges(range))
	addMarker(textPiece.node, { type, textPiece.range, DocumentMarker::Data { data } });
	}

	void DocumentMarkerController::addMarker(Text& node, unsigned startOffset, unsigned length, DocumentMarker::MarkerType type, DocumentMarker::Data&& data)
	{
	addMarker(node, { type, { startOffset, startOffset + length }, WTFMove(data) });
	}

	void DocumentMarkerController::addDraggedContentMarker(const SimpleRange& range)
	{
	// FIXME: Since the marker is already stored in a map keyed by node, we can probably change things around so we don't have to also store the node in the marker.
	for (auto& textPiece : collectTextRanges(range))
	addMarker(textPiece.node, { DocumentMarker::DraggedContent, textPiece.range, RefPtr<Node> { textPiece.node.ptr() } });
	}

	void DocumentMarkerController::removeMarkers(const SimpleRange& range, OptionSet<DocumentMarker::MarkerType> types, RemovePartiallyOverlappingMarker overlapRule)
	{
	filterMarkers(range, nullptr, types, overlapRule);
	}

	void DocumentMarkerController::filterMarkers(const SimpleRange& range, const Function<FilterMarkerResult(const DocumentMarker&)>& filter, OptionSet<DocumentMarker::MarkerType> types, RemovePartiallyOverlappingMarker overlapRule)
	{
	for (auto& textPiece : collectTextRanges(range)) {
	if (!possiblyHasMarkers(types))
	return;
	ASSERT(!m_markers.isEmpty());
	removeMarkers(textPiece.node, textPiece.range, types, filter, overlapRule);
	}
	}

	static void updateRenderedRectsForMarker(RenderedDocumentMarker& marker, Node& node)
	{
	ASSERT(!node.document().view() \|\| !node.document().view()->needsLayout());
	marker.setUnclippedAbsoluteRects(boundingBoxes(RenderObject::absoluteTextQuads(makeSimpleRange(node, marker), RenderObject::BoundingRectBehavior::UseSelectionHeight)));
	}

	void DocumentMarkerController::invalidateRectsForAllMarkers()
	{
	if (!hasMarkers())
	return;

	for (auto& nodeMarkers : m_markers.values()) {
	for (auto& marker : *nodeMarkers)
	marker.invalidate();
	}

	if (Page* page = m_document.page())
	page->chrome().client().didInvalidateDocumentMarkerRects();
	}

	void DocumentMarkerController::invalidateRectsForMarkersInNode(Node& node)
	{
	if (!hasMarkers())
	return;

	auto markers = m_markers.get(&node);
	ASSERT(markers);

	for (auto& marker : *markers)
	marker.invalidate();

	if (Page* page = m_document.page())
	page->chrome().client().didInvalidateDocumentMarkerRects();
	}

	static void updateMainFrameLayoutIfNeeded(Document& document)
	{
	Frame* frame = document.frame();
	if (!frame)
	return;

	FrameView* mainFrameView = frame->mainFrame().view();
	if (!mainFrameView)
	return;

	mainFrameView->updateLayoutAndStyleIfNeededRecursive();
	}

	void DocumentMarkerController::updateRectsForInvalidatedMarkersOfType(DocumentMarker::MarkerType type)
	{
	if (!possiblyHasMarkers(type))
	return;
	ASSERT(!m_markers.isEmpty());

	bool updatedLayout = false;
	for (auto& nodeMarkers : m_markers) {
	for (auto& marker : *nodeMarkers.value) {
	if (marker.type() != type \|\| marker.isValid())
	continue;
	if (!updatedLayout) {
	updateMainFrameLayoutIfNeeded(m_document);
	updatedLayout = true;
	}
	updateRenderedRectsForMarker(marker, *nodeMarkers.key);
	}
	}
	}

	Vector<FloatRect> DocumentMarkerController::renderedRectsForMarkers(DocumentMarker::MarkerType type)
	{
	Vector<FloatRect> result;

	if (!possiblyHasMarkers(type))
	return result;
	ASSERT(!m_markers.isEmpty());

	RefPtr<Frame> frame = m_document.frame();
	if (!frame)
	return result;
	FrameView* frameView = frame->view();
	if (!frameView)
	return result;

	updateRectsForInvalidatedMarkersOfType(type);

	bool isSubframe = !frame->isMainFrame();
	IntRect subframeClipRect;
	if (isSubframe)
	subframeClipRect = frameView->windowToContents(frameView->windowClipRect());

	for (auto& nodeMarkers : m_markers) {
	auto renderer = nodeMarkers.key->renderer();
	FloatRect overflowClipRect;
	if (renderer)
	overflowClipRect = renderer->absoluteClippedOverflowRectForRepaint();
	for (auto& marker : *nodeMarkers.value) {
	if (marker.type() != type)
	continue;

	auto renderedRects = marker.unclippedAbsoluteRects();

	// Clip document markers by their overflow clip.
	if (renderer) {
	for (auto& rect : renderedRects)
	rect.intersect(overflowClipRect);
	}

	// Clip subframe document markers by their frame.
	if (isSubframe) {
	for (auto& rect : renderedRects)
	rect.intersect(subframeClipRect);
	}

	for (const auto& rect : renderedRects) {
	if (!rect.isEmpty())
	result.append(rect);
	}
	}
	}

	return result;
	}

	static bool shouldInsertAsSeparateMarker(const DocumentMarker& marker)
	{
	#if ENABLE(PLATFORM_DRIVEN_TEXT_CHECKING)
	if (marker.type() == DocumentMarker::PlatformTextChecking)
	return true;
	#endif

	#if PLATFORM(IOS_FAMILY)
	if (marker.type() == DocumentMarker::DictationPhraseWithAlternatives \|\| marker.type() == DocumentMarker::DictationResult)
	return true;
	#endif

	if (marker.type() == DocumentMarker::DraggedContent)
	return is<RenderReplaced>(std::get<RefPtr<Node>>(marker.data())->renderer());

	return false;
	}

	// Markers are stored in order sorted by their start offset.
	// Markers of the same type do not overlap each other.

	void DocumentMarkerController::addMarker(Node& node, DocumentMarker&& newMarker)
	{
	ASSERT(newMarker.endOffset() >= newMarker.startOffset());
	if (newMarker.endOffset() == newMarker.startOffset())
	return;

	m_possiblyExistingMarkerTypes.add(newMarker.type());

	auto& list = m_markers.add(&node, nullptr).iterator->value;

	if (!list) {
	list = makeUnique<Vector<RenderedDocumentMarker>>();
	list->append(RenderedDocumentMarker(WTFMove(newMarker)));
	} else if (shouldInsertAsSeparateMarker(newMarker)) {
	// We don't merge dictation markers.
	size_t i;
	size_t numberOfMarkers = list->size();
	for (i = 0; i < numberOfMarkers; ++i) {
	DocumentMarker marker = list->at(i);
	if (marker.startOffset() > newMarker.startOffset())
	break;
	}
	list->insert(i, RenderedDocumentMarker(WTFMove(newMarker)));
	} else {
	RenderedDocumentMarker toInsert(WTFMove(newMarker));
	size_t numMarkers = list->size();
	size_t i;
	// Iterate over all markers whose start offset is less than or equal to the new marker's.
	// If one of them is of the same type as the new marker and touches it or intersects with it
	// (there is at most one), remove it and adjust the new marker's start offset to encompass it.
	for (i = 0; i < numMarkers; ++i) {
	DocumentMarker marker = list->at(i);
	if (marker.startOffset() > toInsert.startOffset())
	break;
	if (marker.type() == toInsert.type() && marker.endOffset() >= toInsert.startOffset()) {
	toInsert.setStartOffset(marker.startOffset());
	list->remove(i);
	numMarkers--;
	break;
	}
	}
	size_t j = i;
	// Iterate over all markers whose end offset is less than or equal to the new marker's,
	// removing markers of the same type as the new marker which touch it or intersect with it,
	// adjusting the new marker's end offset to cover them if necessary.
	while (j < numMarkers) {
	DocumentMarker marker = list->at(j);
	if (marker.startOffset() > toInsert.endOffset())
	break;
	if (marker.type() == toInsert.type()) {
	list->remove(j);
	if (toInsert.endOffset() <= marker.endOffset()) {
	toInsert.setEndOffset(marker.endOffset());
	break;
	}
	numMarkers--;
	} else
	j++;
	}
	// At this point i points to the node before which we want to insert.
	list->insert(i, RenderedDocumentMarker(toInsert));
	}

	if (node.renderer())
	node.renderer()->repaint();

	invalidateRectsForMarkersInNode(node);
	}

	// Copies markers from source to destination, applying the specified shift delta to the copies. The shift is
	// useful if, e.g., the caller has created the destination from a non-prefix substring of the source.
	void DocumentMarkerController::copyMarkers(Node& source, OffsetRange range, Node& destination)
	{
	if (range.start >= range.end)
	return;

	if (!possiblyHasMarkers(DocumentMarker::allMarkers()))
	return;
	ASSERT(!m_markers.isEmpty());

	auto list = m_markers.get(&source);
	if (!list)
	return;

	bool needRepaint = false;
	for (auto& marker : *list) {
	// Stop if we are now past the specified range.
	if (marker.startOffset() >= range.end)
	break;

	// Skip marker that is before the specified range.
	if (marker.endOffset() < range.start)
	continue;

	// Pin the marker to the specified range and apply the shift delta.
	auto copiedMarker = marker;
	if (copiedMarker.startOffset() < range.start)
	copiedMarker.setStartOffset(range.start);
	if (copiedMarker.endOffset() >= range.end)
	copiedMarker.setEndOffset(range.end);

	addMarker(destination, WTFMove(copiedMarker));
	needRepaint = true;
	}

	if (needRepaint) {
	if (auto renderer = destination.renderer())
	renderer->repaint();
	}
	}

	void DocumentMarkerController::removeMarkers(Node& node, OffsetRange range, OptionSet<DocumentMarker::MarkerType> types, const Function<FilterMarkerResult(const DocumentMarker&)>& filter, RemovePartiallyOverlappingMarker overlapRule)
	{
	if (range.start >= range.end)
	return;

	if (!possiblyHasMarkers(types))
	return;
	ASSERT(!m_markers.isEmpty());

	auto list = m_markers.get(&node);
	if (!list)
	return;

	bool needRepaint = false;
	for (size_t i = 0; i < list->size(); ) {
	auto& marker = list->at(i);

	// markers are returned in order, so stop if we are now past the specified range
	if (marker.startOffset() >= range.end)
	break;

	// skip marker that is wrong type or before target
	if (marker.endOffset() <= range.start \|\| !types.contains(marker.type())) {
	i++;
	continue;
	}

	if (filter && filter(marker) == FilterMarkerResult::Keep) {
	i++;
	continue;
	}

	// At this point we know that marker and target intersect in some way.
	needRepaint = true;

	DocumentMarker copiedMarker = marker;
	list->remove(i);
	if (overlapRule == RemovePartiallyOverlappingMarker::Yes)
	continue;

	// Add either of the resulting slices that remain after removing target.
	if (range.start > copiedMarker.startOffset()) {
	auto newLeft = copiedMarker;
	newLeft.setEndOffset(range.start);
	list->insert(i, RenderedDocumentMarker(WTFMove(newLeft)));
	i++;
	}
	if (copiedMarker.endOffset() > range.end) {
	copiedMarker.setStartOffset(range.end);
	list->insert(i, RenderedDocumentMarker(WTFMove(copiedMarker)));
	i++;
	}
	}

	if (list->isEmpty()) {
	m_markers.remove(&node);
	if (m_markers.isEmpty())
	m_possiblyExistingMarkerTypes = { };
	}

	if (needRepaint) {
	if (auto renderer = node.renderer())
	renderer->repaint();
	}
	}

	DocumentMarker* DocumentMarkerController::markerContainingPoint(const LayoutPoint& point, DocumentMarker::MarkerType type)
	{
	if (!possiblyHasMarkers(type))
	return nullptr;
	ASSERT(!m_markers.isEmpty());

	updateRectsForInvalidatedMarkersOfType(type);
	for (auto& nodeMarkers : m_markers.values()) {
	for (auto& marker : *nodeMarkers) {
	if (marker.type() == type && marker.contains(point))
	return &marker;
	}
	}
	return nullptr;
	}

	Vector<RenderedDocumentMarker*> DocumentMarkerController::markersFor(Node& node, OptionSet<DocumentMarker::MarkerType> types)
	{
	if (!possiblyHasMarkers(types))
	return { };

	Vector<RenderedDocumentMarker*> result;
	auto list = m_markers.get(&node);
	if (!list)
	return result;

	for (auto& marker : *list) {
	if (types.contains(marker.type()))
	result.append(&marker);
	}

	return result;
	}

	void DocumentMarkerController::forEach(const SimpleRange& range, OptionSet<DocumentMarker::MarkerType> types, Function<bool(RenderedDocumentMarker&)> function)
	{
	if (!possiblyHasMarkers(types))
	return;
	ASSERT(!m_markers.isEmpty());

	for (auto& node : intersectingNodes(range)) {
	if (auto list = m_markers.get(&node)) {
	auto offsetRange = characterDataOffsetRange(range, node);
	for (auto& marker : *list) {
	// Markers are stored in order, so stop if we are now past the specified range.
	if (marker.startOffset() >= offsetRange.end)
	break;
	if (marker.endOffset() > offsetRange.start && types.contains(marker.type())) {
	if (function(marker))
	return;
	}
	}
	}
	}
	}

	Vector<RenderedDocumentMarker*> DocumentMarkerController::markersInRange(const SimpleRange& range, OptionSet<DocumentMarker::MarkerType> types)
	{
	// FIXME: Consider making forEach public and changing callers to use that function instead of this one.
	Vector<RenderedDocumentMarker*> markers;
	forEach(range, types, [&] (RenderedDocumentMarker& marker) {
	markers.append(&marker);
	return false;
	});
	return markers;
	}

	void DocumentMarkerController::removeMarkers(Node& node, OptionSet<DocumentMarker::MarkerType> types)
	{
	if (!possiblyHasMarkers(types))
	return;
	ASSERT(!m_markers.isEmpty());

	auto iterator = m_markers.find(&node);
	if (iterator != m_markers.end())
	removeMarkersFromList(iterator, types);
	}

	void DocumentMarkerController::removeMarkers(OptionSet<DocumentMarker::MarkerType> types)
	{
	if (!possiblyHasMarkers(types))
	return;
	ASSERT(!m_markers.isEmpty());

	for (auto& node : copyToVector(m_markers.keys()))
	removeMarkersFromList(m_markers.find(node), types);
	m_possiblyExistingMarkerTypes.remove(types);
	}

	void DocumentMarkerController::removeMarkersFromList(MarkerMap::iterator iterator, OptionSet<DocumentMarker::MarkerType> types)
	{
	bool needsRepainting = false;
	bool listCanBeRemoved;

	if (types == DocumentMarker::allMarkers()) {
	needsRepainting = true;
	listCanBeRemoved = true;
	} else {
	auto list = iterator->value.get();

	for (size_t i = 0; i != list->size(); ) {
	DocumentMarker marker = list->at(i);

	// skip nodes that are not of the specified type
	if (!types.contains(marker.type())) {
	++i;
	continue;
	}

	// pitch the old marker
	list->remove(i);
	needsRepainting = true;
	// i now is the index of the next marker
	}

	listCanBeRemoved = list->isEmpty();
	}

	if (needsRepainting) {
	if (auto renderer = iterator->key->renderer())
	renderer->repaint();
	}

	if (listCanBeRemoved) {
	m_markers.remove(iterator);
	if (m_markers.isEmpty())
	m_possiblyExistingMarkerTypes = { };
	}
	}

	void DocumentMarkerController::repaintMarkers(OptionSet<DocumentMarker::MarkerType> types)
	{
	if (!possiblyHasMarkers(types))
	return;
	ASSERT(!m_markers.isEmpty());

	for (auto& nodeMarkers : m_markers) {
	for (auto& marker : *nodeMarkers.value) {
	if (types.contains(marker.type())) {
	if (auto renderer = nodeMarkers.key->renderer())
	renderer->repaint();
	break;
	}
	}
	}
	}

	void DocumentMarkerController::shiftMarkers(Node& node, unsigned startOffset, int delta)
	{
	if (!possiblyHasMarkers(DocumentMarker::allMarkers()))
	return;
	ASSERT(!m_markers.isEmpty());

	auto list = m_markers.get(&node);
	if (!list)
	return;

	bool didShiftMarker = false;
	for (size_t i = 0; i != list->size(); ) {
	auto& marker = list->at(i);

	#if PLATFORM(IOS_FAMILY)
	// FIXME: No obvious reason this should be iOS-specific. Remove the #if at some point.
	auto targetStartOffset = clampTo<unsigned>(static_cast<int>(marker.startOffset()) + delta);
	auto targetEndOffset = clampTo<unsigned>(static_cast<int>(marker.endOffset()) + delta);
	if (targetStartOffset >= node.length() \|\| targetEndOffset <= 0) {
	list->remove(i);
	continue;
	}
	#endif

	if (marker.startOffset() >= startOffset) {
	ASSERT((int)marker.startOffset() + delta >= 0);
	marker.shiftOffsets(delta);
	didShiftMarker = true;
	}
	#if PLATFORM(IOS_FAMILY)
	// FIXME: No obvious reason this should be iOS-specific. Remove the #if at some point.
	else if (marker.endOffset() > startOffset) {
	if (targetEndOffset <= marker.startOffset()) {
	list->remove(i);
	continue;
	}
	marker.setEndOffset(std::min(targetEndOffset, node.length()));
	didShiftMarker = true;
	}
	#endif

	++i;
	}

	if (didShiftMarker) {
	invalidateRectsForMarkersInNode(node);
	if (auto renderer = node.renderer())
	renderer->repaint();
	}
	}

	bool DocumentMarkerController::hasMarkers(const SimpleRange& range, OptionSet<DocumentMarker::MarkerType> types)
	{
	bool foundMarker = false;
	forEach(range, types, [&] (RenderedDocumentMarker&) {
	foundMarker = true;
	return true;
	});
	return foundMarker;
	}

	void DocumentMarkerController::clearDescriptionOnMarkersIntersectingRange(const SimpleRange& range, OptionSet<DocumentMarker::MarkerType> types)
	{
	forEach(range, types, [&] (RenderedDocumentMarker& marker) {
	marker.clearData();
	return false;
	});
	}

	void addMarker(const SimpleRange& range, DocumentMarker::MarkerType type, const DocumentMarker::Data& data)
	{
	range.start.document().markers().addMarker(range, type, data);
	}

	void addMarker(Text& node, unsigned startOffset, unsigned length, DocumentMarker::MarkerType type, DocumentMarker::Data&& data)
	{
	node.document().markers().addMarker(node, startOffset, length, type, WTFMove(data));
	}

	void removeMarkers(const SimpleRange& range, OptionSet<DocumentMarker::MarkerType> types, RemovePartiallyOverlappingMarker policy)
	{
	range.start.document().markers().removeMarkers(range, types, policy);
	}

	SimpleRange makeSimpleRange(Node& node, const DocumentMarker& marker)
	{
	unsigned startOffset = marker.startOffset();
	unsigned endOffset = marker.endOffset();
	return { { node, startOffset }, { node, endOffset } };
	}

	#if ENABLE(TREE_DEBUGGING)

	void DocumentMarkerController::showMarkers() const
	{
	fprintf(stderr, "%d nodes have markers:\n", m_markers.size());
	for (auto& nodeMarkers : m_markers) {
	fprintf(stderr, "%p", nodeMarkers.key.get());
	for (auto& marker : *nodeMarkers.value)
	fprintf(stderr, " %d:[%d:%d]", marker.type(), marker.startOffset(), marker.endOffset());
	fputc('\n', stderr);
	}
	}

	#endif

	} // namespace WebCore

	#if ENABLE(TREE_DEBUGGING)

	void showDocumentMarkers(const WebCore::DocumentMarkerController* controller)
	{
	if (controller)
	controller->showMarkers();
	}

	#endif