Split LayoutTypes.h to improve compile time
[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 "LayoutTypes.h"
33 #include <wtf/HashMap.h>
34 #include <wtf/Vector.h>
35
36 namespace WebCore {
37
38 class Node;
39 class Range;
40 class RenderedDocumentMarker;
41
42 class DocumentMarkerController {
43     WTF_MAKE_NONCOPYABLE(DocumentMarkerController); WTF_MAKE_FAST_ALLOCATED;
44 public:
45
46     DocumentMarkerController();
47     ~DocumentMarkerController() { detach(); }
48
49     void detach();
50     void addMarker(Range*, DocumentMarker::MarkerType);
51     void addMarker(Range*, DocumentMarker::MarkerType, const String& description);
52     void addMarkerToNode(Node*, unsigned startOffset, unsigned length, DocumentMarker::MarkerType);
53     void addMarkerToNode(Node*, unsigned startOffset, unsigned length, DocumentMarker::MarkerType, PassRefPtr<DocumentMarkerDetails>);
54     void addTextMatchMarker(const Range*, bool activeMatch);
55
56     void copyMarkers(Node* srcNode, unsigned startOffset, int length, Node* dstNode, int delta);
57     bool hasMarkers(Range*, DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
58
59     // When a marker partially overlaps with range, if removePartiallyOverlappingMarkers is true, we completely
60     // remove the marker. If the argument is false, we will adjust the span of the marker so that it retains
61     // the portion that is outside of the range.
62     enum RemovePartiallyOverlappingMarkerOrNot { DoNotRemovePartiallyOverlappingMarker, RemovePartiallyOverlappingMarker };
63     void removeMarkers(Range*, DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers(), RemovePartiallyOverlappingMarkerOrNot = DoNotRemovePartiallyOverlappingMarker);
64     void removeMarkers(Node*, unsigned startOffset, int length, DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers(),  RemovePartiallyOverlappingMarkerOrNot = DoNotRemovePartiallyOverlappingMarker);
65
66     void removeMarkers(DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
67     void removeMarkers(Node*, DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
68     void repaintMarkers(DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
69     void invalidateRenderedRectsForMarkersInRect(const LayoutRect&);
70     void shiftMarkers(Node*, unsigned startOffset, int delta);
71     void setMarkersActive(Range*, bool);
72     void setMarkersActive(Node*, unsigned startOffset, unsigned endOffset, bool);
73
74     DocumentMarker* markerContainingPoint(const LayoutPoint&, DocumentMarker::MarkerType);
75     Vector<DocumentMarker*> markersFor(Node*, DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
76     Vector<DocumentMarker*> markersInRange(Range*, DocumentMarker::MarkerTypes);
77     Vector<DocumentMarker> markersForNode(Node*);
78     Vector<IntRect> renderedRectsForMarkers(DocumentMarker::MarkerType);
79     void clearDescriptionOnMarkersIntersectingRange(Range*, DocumentMarker::MarkerTypes);
80
81 #ifndef NDEBUG
82     void showMarkers() const;
83 #endif
84
85 private:
86     void addMarker(Node*, const DocumentMarker&);
87
88     typedef Vector<RenderedDocumentMarker> MarkerList;
89     typedef HashMap<RefPtr<Node>, MarkerList*> MarkerMap;
90     bool possiblyHasMarkers(DocumentMarker::MarkerTypes);
91     void removeMarkersFromList(Node*, MarkerList*, DocumentMarker::MarkerTypes);
92
93     MarkerMap m_markers;
94     // Provide a quick way to determine whether a particular marker type is absent without going through the map.
95     DocumentMarker::MarkerTypes m_possiblyExistingMarkerTypes;
96 };
97
98 } // namespace WebCore
99
100 #ifndef NDEBUG
101 void showDocumentMarkers(const WebCore::DocumentMarkerController*);
102 #endif
103
104 #endif // DocumentMarkerController_h