Replace WTF::move with WTFMove
[WebKit-https.git] / Source / WebCore / dom / DocumentMarkerController.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Dirk Mueller (mueller@kde.org)
5  *           (C) 2006 Alexey Proskuryakov (ap@webkit.org)
6  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
7  * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
8  * Copyright (C) Research In Motion Limited 2010. All rights reserved.
9  *
10  * This library is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Library General Public
12  * License as published by the Free Software Foundation; either
13  * version 2 of the License, or (at your option) any later version.
14  *
15  * This library is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Library General Public License for more details.
19  *
20  * You should have received a copy of the GNU Library General Public License
21  * along with this library; see the file COPYING.LIB.  If not, write to
22  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23  * Boston, MA 02110-1301, USA.
24  *
25  */
26
27 #ifndef DocumentMarkerController_h
28 #define DocumentMarkerController_h
29
30 #include "DocumentMarker.h"
31 #include "IntRect.h"
32 #include <memory>
33 #include <wtf/HashMap.h>
34 #include <wtf/Vector.h>
35
36 namespace WebCore {
37
38 class Document;
39 class LayoutPoint;
40 class LayoutRect;
41 class Node;
42 class Range;
43 class RenderedDocumentMarker;
44
45 class DocumentMarkerController {
46     WTF_MAKE_NONCOPYABLE(DocumentMarkerController); WTF_MAKE_FAST_ALLOCATED;
47 public:
48
49     DocumentMarkerController(Document&);
50     ~DocumentMarkerController();
51
52     void detach();
53     void addMarker(Range*, DocumentMarker::MarkerType);
54     void addMarker(Range*, DocumentMarker::MarkerType, const String& description);
55     void addMarkerToNode(Node*, unsigned startOffset, unsigned length, DocumentMarker::MarkerType);
56     void addMarkerToNode(Node*, unsigned startOffset, unsigned length, DocumentMarker::MarkerType, PassRefPtr<DocumentMarkerDetails>);
57     WEBCORE_EXPORT void addTextMatchMarker(const Range*, bool activeMatch);
58 #if PLATFORM(IOS)
59     void addMarker(Range*, DocumentMarker::MarkerType, const String& description, const Vector<String>& interpretations, const RetainPtr<id>& metadata);
60     void addDictationPhraseWithAlternativesMarker(Range*, const Vector<String>& interpretations);
61     void addDictationResultMarker(Range*, const RetainPtr<id>& metadata);
62 #endif
63
64     void copyMarkers(Node* srcNode, unsigned startOffset, int length, Node* dstNode, int delta);
65     bool hasMarkers() const
66     {
67         ASSERT(m_markers.isEmpty() == !m_possiblyExistingMarkerTypes.intersects(DocumentMarker::AllMarkers()));
68         return !m_markers.isEmpty();
69     }
70     bool hasMarkers(Range*, DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
71
72     // When a marker partially overlaps with range, if removePartiallyOverlappingMarkers is true, we completely
73     // remove the marker. If the argument is false, we will adjust the span of the marker so that it retains
74     // the portion that is outside of the range.
75     enum RemovePartiallyOverlappingMarkerOrNot { DoNotRemovePartiallyOverlappingMarker, RemovePartiallyOverlappingMarker };
76     void removeMarkers(Range*, DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers(), RemovePartiallyOverlappingMarkerOrNot = DoNotRemovePartiallyOverlappingMarker);
77     void removeMarkers(Node*, unsigned startOffset, int length, DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers(),  RemovePartiallyOverlappingMarkerOrNot = DoNotRemovePartiallyOverlappingMarker);
78
79     WEBCORE_EXPORT void removeMarkers(DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
80     void removeMarkers(Node*, DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
81     void repaintMarkers(DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
82     void shiftMarkers(Node*, unsigned startOffset, int delta);
83     void setMarkersActive(Range*, bool);
84     void setMarkersActive(Node*, unsigned startOffset, unsigned endOffset, bool);
85
86     WEBCORE_EXPORT Vector<RenderedDocumentMarker*> markersFor(Node*, DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
87     WEBCORE_EXPORT Vector<RenderedDocumentMarker*> markersInRange(Range*, DocumentMarker::MarkerTypes);
88     void clearDescriptionOnMarkersIntersectingRange(Range*, DocumentMarker::MarkerTypes);
89
90     WEBCORE_EXPORT void updateRectsForInvalidatedMarkersOfType(DocumentMarker::MarkerType);
91
92     void invalidateRectsForAllMarkers();
93     void invalidateRectsForMarkersInNode(Node&);
94
95     DocumentMarker* markerContainingPoint(const LayoutPoint&, DocumentMarker::MarkerType);
96     WEBCORE_EXPORT Vector<FloatRect> renderedRectsForMarkers(DocumentMarker::MarkerType);
97
98 #if ENABLE(TREE_DEBUGGING)
99     void showMarkers() const;
100 #endif
101
102 private:
103     void addMarker(Node*, const DocumentMarker&);
104
105     typedef Vector<RenderedDocumentMarker> MarkerList;
106     typedef HashMap<RefPtr<Node>, std::unique_ptr<MarkerList>> MarkerMap;
107     bool possiblyHasMarkers(DocumentMarker::MarkerTypes);
108     void removeMarkersFromList(MarkerMap::iterator, DocumentMarker::MarkerTypes);
109
110     MarkerMap m_markers;
111     // Provide a quick way to determine whether a particular marker type is absent without going through the map.
112     DocumentMarker::MarkerTypes m_possiblyExistingMarkerTypes { 0 };
113     Document& m_document;
114 };
115
116 } // namespace WebCore
117
118 #if ENABLE(TREE_DEBUGGING)
119 void showDocumentMarkers(const WebCore::DocumentMarkerController*);
120 #endif
121
122 #endif // DocumentMarkerController_h