Replace WTF::move with WTFMove
[WebKit-https.git] / Source / WebCore / dom / Range.h
1 /*
2  * (C) 1999 Lars Knoll (knoll@kde.org)
3  * (C) 2000 Gunnstein Lye (gunnstein@netcom.no)
4  * (C) 2000 Frederik Holljen (frederik.holljen@hig.no)
5  * (C) 2001 Peter Kelly (pmk@post.com)
6  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  *
23  */
24
25 #ifndef Range_h
26 #define Range_h
27
28 #include "ExceptionCodePlaceholder.h"
29 #include "FloatRect.h"
30 #include "FragmentScriptingPermission.h"
31 #include "IntRect.h"
32 #include "RangeBoundaryPoint.h"
33 #include <wtf/Forward.h>
34 #include <wtf/RefCounted.h>
35 #include <wtf/Vector.h>
36
37 namespace WebCore {
38
39 class ClientRect;
40 class ClientRectList;
41 class ContainerNode;
42 class Document;
43 class DocumentFragment;
44 class FloatQuad;
45 class Node;
46 class NodeWithIndex;
47 class SelectionRect;
48 class Text;
49 class VisiblePosition;
50
51 class Range : public RefCounted<Range> {
52 public:
53     WEBCORE_EXPORT static Ref<Range> create(Document&);
54     WEBCORE_EXPORT static Ref<Range> create(Document&, PassRefPtr<Node> startContainer, int startOffset, PassRefPtr<Node> endContainer, int endOffset);
55     WEBCORE_EXPORT static Ref<Range> create(Document&, const Position&, const Position&);
56     WEBCORE_EXPORT static Ref<Range> create(Document&, const VisiblePosition&, const VisiblePosition&);
57     WEBCORE_EXPORT ~Range();
58
59     Document& ownerDocument() const { return const_cast<Document&>(m_ownerDocument.get()); }
60
61     Node& startContainer() const { ASSERT(m_start.container()); return *m_start.container(); }
62     int startOffset() const { return m_start.offset(); }
63     Node& endContainer() const { ASSERT(m_end.container()); return *m_end.container(); }
64     int endOffset() const { return m_end.offset(); }
65     bool collapsed() const { return m_start == m_end; }
66
67     Node* commonAncestorContainer() const { return commonAncestorContainer(&startContainer(), &endContainer()); }
68     WEBCORE_EXPORT static Node* commonAncestorContainer(Node* containerA, Node* containerB);
69     WEBCORE_EXPORT void setStart(PassRefPtr<Node> container, int offset, ExceptionCode& = ASSERT_NO_EXCEPTION);
70     WEBCORE_EXPORT void setEnd(PassRefPtr<Node> container, int offset, ExceptionCode& = ASSERT_NO_EXCEPTION);
71     WEBCORE_EXPORT void collapse(bool toStart);
72     WEBCORE_EXPORT bool isPointInRange(Node* refNode, int offset, ExceptionCode&);
73     short comparePoint(Node* refNode, int offset, ExceptionCode&) const;
74     enum CompareResults { NODE_BEFORE, NODE_AFTER, NODE_BEFORE_AND_AFTER, NODE_INSIDE };
75     CompareResults compareNode(Node* refNode, ExceptionCode&) const;
76     enum CompareHow { START_TO_START, START_TO_END, END_TO_END, END_TO_START };
77     WEBCORE_EXPORT short compareBoundaryPoints(CompareHow, const Range* sourceRange, ExceptionCode&) const;
78     short compareBoundaryPointsForBindings(unsigned short compareHow, const Range* sourceRange, ExceptionCode&) const;
79     static short compareBoundaryPoints(Node* containerA, int offsetA, Node* containerB, int offsetB, ExceptionCode&);
80     static short compareBoundaryPoints(const RangeBoundaryPoint& boundaryA, const RangeBoundaryPoint& boundaryB, ExceptionCode&);
81     WEBCORE_EXPORT bool boundaryPointsValid() const;
82     bool intersectsNode(Node* refNode, ExceptionCode&) const;
83     void deleteContents(ExceptionCode&);
84     RefPtr<DocumentFragment> extractContents(ExceptionCode&);
85     RefPtr<DocumentFragment> cloneContents(ExceptionCode&);
86     void insertNode(RefPtr<Node>&&, ExceptionCode&);
87     String toString() const;
88
89     String toHTML() const;
90     WEBCORE_EXPORT String text() const;
91
92     RefPtr<DocumentFragment> createContextualFragment(const String& html, ExceptionCode&);
93
94     void detach();
95     WEBCORE_EXPORT Ref<Range> cloneRange() const;
96
97     WEBCORE_EXPORT void setStartAfter(Node*, ExceptionCode& = ASSERT_NO_EXCEPTION);
98     WEBCORE_EXPORT void setEndBefore(Node*, ExceptionCode& = ASSERT_NO_EXCEPTION);
99     WEBCORE_EXPORT void setEndAfter(Node*, ExceptionCode& = ASSERT_NO_EXCEPTION);
100     WEBCORE_EXPORT void selectNode(Node*, ExceptionCode& = ASSERT_NO_EXCEPTION);
101     WEBCORE_EXPORT void selectNodeContents(Node*, ExceptionCode&);
102     void surroundContents(PassRefPtr<Node>, ExceptionCode&);
103     WEBCORE_EXPORT void setStartBefore(Node*, ExceptionCode&);
104
105     const Position startPosition() const { return m_start.toPosition(); }
106     const Position endPosition() const { return m_end.toPosition(); }
107     WEBCORE_EXPORT void setStart(const Position&, ExceptionCode& = ASSERT_NO_EXCEPTION);
108     WEBCORE_EXPORT void setEnd(const Position&, ExceptionCode& = ASSERT_NO_EXCEPTION);
109
110     WEBCORE_EXPORT Node* firstNode() const;
111     WEBCORE_EXPORT Node* pastLastNode() const;
112
113     ShadowRoot* shadowRoot() const;
114
115     enum RangeInFixedPosition {
116         NotFixedPosition,
117         PartiallyFixedPosition,
118         EntirelyFixedPosition
119     };
120
121     // Not transform-friendly
122     WEBCORE_EXPORT void absoluteTextRects(Vector<IntRect>&, bool useSelectionHeight = false, RangeInFixedPosition* = nullptr) const;
123     WEBCORE_EXPORT IntRect absoluteBoundingBox() const;
124
125     // Transform-friendly
126     WEBCORE_EXPORT void absoluteTextQuads(Vector<FloatQuad>&, bool useSelectionHeight = false, RangeInFixedPosition* = nullptr) const;
127     WEBCORE_EXPORT FloatRect absoluteBoundingRect() const;
128 #if PLATFORM(IOS)
129     WEBCORE_EXPORT void collectSelectionRects(Vector<SelectionRect>&);
130 #endif
131
132     void nodeChildrenChanged(ContainerNode&);
133     void nodeChildrenWillBeRemoved(ContainerNode&);
134     void nodeWillBeRemoved(Node&);
135
136     void textInserted(Node*, unsigned offset, unsigned length);
137     void textRemoved(Node*, unsigned offset, unsigned length);
138     void textNodesMerged(NodeWithIndex& oldNode, unsigned offset);
139     void textNodeSplit(Text* oldNode);
140
141     // Expand range to a unit (word or sentence or block or document) boundary.
142     // Please refer to https://bugs.webkit.org/show_bug.cgi?id=27632 comment #5 
143     // for details.
144     void expand(const String&, ExceptionCode&);
145
146     Ref<ClientRectList> getClientRects() const;
147     Ref<ClientRect> getBoundingClientRect() const;
148
149 #if ENABLE(TREE_DEBUGGING)
150     void formatForDebugger(char* buffer, unsigned length) const;
151 #endif
152
153     WEBCORE_EXPORT bool contains(const Range&) const;
154     bool contains(const VisiblePosition&) const;
155
156 private:
157     explicit Range(Document&);
158     Range(Document&, PassRefPtr<Node> startContainer, int startOffset, PassRefPtr<Node> endContainer, int endOffset);
159
160     void setDocument(Document&);
161
162     Node* checkNodeWOffset(Node*, int offset, ExceptionCode&) const;
163
164     enum ActionType { Delete, Extract, Clone };
165     RefPtr<DocumentFragment> processContents(ActionType, ExceptionCode&);
166     static RefPtr<Node> processContentsBetweenOffsets(ActionType, PassRefPtr<DocumentFragment>, Node*, unsigned startOffset, unsigned endOffset, ExceptionCode&);
167     static void processNodes(ActionType, Vector<RefPtr<Node>>&, PassRefPtr<Node> oldContainer, PassRefPtr<Node> newContainer, ExceptionCode&);
168     enum ContentsProcessDirection { ProcessContentsForward, ProcessContentsBackward };
169     static RefPtr<Node> processAncestorsAndTheirSiblings(ActionType, Node* container, ContentsProcessDirection, PassRefPtr<Node> clonedContainer, Node* commonRoot, ExceptionCode&);
170
171     enum class CoordinateSpace { Absolute, Client };
172     void getBorderAndTextQuads(Vector<FloatQuad>&, CoordinateSpace) const;
173     FloatRect boundingRectInternal(CoordinateSpace) const;
174
175     Ref<Document> m_ownerDocument;
176     RangeBoundaryPoint m_start;
177     RangeBoundaryPoint m_end;
178 };
179
180 WEBCORE_EXPORT Ref<Range> rangeOfContents(Node&);
181
182 WEBCORE_EXPORT bool areRangesEqual(const Range*, const Range*);
183 bool rangesOverlap(const Range*, const Range*);
184
185 } // namespace
186
187 #if ENABLE(TREE_DEBUGGING)
188 // Outside the WebCore namespace for ease of invocation from gdb.
189 void showTree(const WebCore::Range*);
190 #endif
191
192 #endif