Use a 1-byte enum class for TextDirection
[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 #pragma once
26
27 #include "FloatRect.h"
28 #include "IntRect.h"
29 #include "RangeBoundaryPoint.h"
30 #include <wtf/Forward.h>
31 #include <wtf/RefCounted.h>
32 #include <wtf/Vector.h>
33
34 namespace WebCore {
35
36 class ContainerNode;
37 class DOMRect;
38 class DOMRectList;
39 class Document;
40 class DocumentFragment;
41 class FloatQuad;
42 class Node;
43 class NodeWithIndex;
44 class RenderText;
45 class SelectionRect;
46 class Text;
47 class VisiblePosition;
48
49 class Range : public RefCounted<Range> {
50 public:
51     WEBCORE_EXPORT static Ref<Range> create(Document&);
52     WEBCORE_EXPORT static Ref<Range> create(Document&, RefPtr<Node>&& startContainer, int startOffset, RefPtr<Node>&& endContainer, int endOffset);
53     WEBCORE_EXPORT static Ref<Range> create(Document&, const Position&, const Position&);
54     WEBCORE_EXPORT static Ref<Range> create(Document&, const VisiblePosition&, const VisiblePosition&);
55     WEBCORE_EXPORT ~Range();
56
57     Document& ownerDocument() const { return m_ownerDocument; }
58
59     Node& startContainer() const { ASSERT(m_start.container()); return *m_start.container(); }
60     unsigned startOffset() const { return m_start.offset(); }
61     Node& endContainer() const { ASSERT(m_end.container()); return *m_end.container(); }
62     unsigned endOffset() const { return m_end.offset(); }
63     bool collapsed() const { return m_start == m_end; }
64
65     Node* commonAncestorContainer() const { return commonAncestorContainer(&startContainer(), &endContainer()); }
66     WEBCORE_EXPORT static Node* commonAncestorContainer(Node* containerA, Node* containerB);
67     WEBCORE_EXPORT ExceptionOr<void> setStart(Ref<Node>&& container, unsigned offset);
68     WEBCORE_EXPORT ExceptionOr<void> setEnd(Ref<Node>&& container, unsigned offset);
69     WEBCORE_EXPORT void collapse(bool toStart);
70     WEBCORE_EXPORT ExceptionOr<bool> isPointInRange(Node& refNode, unsigned offset);
71     WEBCORE_EXPORT ExceptionOr<short> comparePoint(Node& refNode, unsigned offset) const;
72     enum CompareResults { NODE_BEFORE, NODE_AFTER, NODE_BEFORE_AND_AFTER, NODE_INSIDE };
73     WEBCORE_EXPORT ExceptionOr<CompareResults> compareNode(Node& refNode) const;
74     enum CompareHow { START_TO_START, START_TO_END, END_TO_END, END_TO_START };
75     WEBCORE_EXPORT ExceptionOr<short> compareBoundaryPoints(CompareHow, const Range& sourceRange) const;
76     WEBCORE_EXPORT ExceptionOr<short> compareBoundaryPointsForBindings(unsigned short compareHow, const Range& sourceRange) const;
77     static ExceptionOr<short> compareBoundaryPoints(Node* containerA, unsigned offsetA, Node* containerB, unsigned offsetB);
78     static ExceptionOr<short> compareBoundaryPoints(const RangeBoundaryPoint& boundaryA, const RangeBoundaryPoint& boundaryB);
79     WEBCORE_EXPORT bool boundaryPointsValid() const;
80     WEBCORE_EXPORT ExceptionOr<bool> intersectsNode(Node& refNode) const;
81     WEBCORE_EXPORT ExceptionOr<void> deleteContents();
82     WEBCORE_EXPORT ExceptionOr<Ref<DocumentFragment>> extractContents();
83     WEBCORE_EXPORT ExceptionOr<Ref<DocumentFragment>> cloneContents();
84     WEBCORE_EXPORT ExceptionOr<void> insertNode(Ref<Node>&&);
85     WEBCORE_EXPORT String toString() const;
86
87     String toHTML() const;
88     WEBCORE_EXPORT String text() const;
89
90     WEBCORE_EXPORT ExceptionOr<Ref<DocumentFragment>> createContextualFragment(const String& html);
91
92     WEBCORE_EXPORT void detach();
93     WEBCORE_EXPORT Ref<Range> cloneRange() const;
94
95     WEBCORE_EXPORT ExceptionOr<void> setStartAfter(Node&);
96     WEBCORE_EXPORT ExceptionOr<void> setEndBefore(Node&);
97     WEBCORE_EXPORT ExceptionOr<void> setEndAfter(Node&);
98     WEBCORE_EXPORT ExceptionOr<void> selectNode(Node&);
99     WEBCORE_EXPORT ExceptionOr<void> selectNodeContents(Node&);
100     WEBCORE_EXPORT ExceptionOr<void> surroundContents(Node&);
101     WEBCORE_EXPORT ExceptionOr<void> setStartBefore(Node&);
102
103     const Position startPosition() const { return m_start.toPosition(); }
104     const Position endPosition() const { return m_end.toPosition(); }
105     WEBCORE_EXPORT ExceptionOr<void> setStart(const Position&);
106     WEBCORE_EXPORT ExceptionOr<void> setEnd(const Position&);
107
108     WEBCORE_EXPORT Node* firstNode() const;
109     WEBCORE_EXPORT Node* pastLastNode() const;
110
111     ShadowRoot* shadowRoot() const;
112
113     enum RangeInFixedPosition {
114         NotFixedPosition,
115         PartiallyFixedPosition,
116         EntirelyFixedPosition
117     };
118
119     // Not transform-friendly
120     enum class RespectClippingForTextRects { No, Yes };
121     WEBCORE_EXPORT void absoluteTextRects(Vector<IntRect>&, bool useSelectionHeight = false, RangeInFixedPosition* = nullptr, RespectClippingForTextRects = RespectClippingForTextRects::No) const;
122     WEBCORE_EXPORT IntRect absoluteBoundingBox() const;
123
124     // Transform-friendly
125     WEBCORE_EXPORT void absoluteTextQuads(Vector<FloatQuad>&, bool useSelectionHeight = false, RangeInFixedPosition* = nullptr) const;
126     WEBCORE_EXPORT FloatRect absoluteBoundingRect(RespectClippingForTextRects = RespectClippingForTextRects::No) const;
127 #if PLATFORM(IOS)
128     WEBCORE_EXPORT void collectSelectionRects(Vector<SelectionRect>&) const;
129     WEBCORE_EXPORT int collectSelectionRectsWithoutUnionInteriorLines(Vector<SelectionRect>&) const;
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     WEBCORE_EXPORT ExceptionOr<void> expand(const String&);
145
146     Ref<DOMRectList> getClientRects() const;
147     Ref<DOMRect> 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     enum ActionType { Delete, Extract, Clone };
157
158 private:
159     explicit Range(Document&);
160     Range(Document&, Node* startContainer, int startOffset, Node* endContainer, int endOffset);
161
162     void setDocument(Document&);
163     ExceptionOr<Node*> checkNodeWOffset(Node&, unsigned offset) const;
164     ExceptionOr<RefPtr<DocumentFragment>> processContents(ActionType);
165
166     enum class CoordinateSpace { Absolute, Client };
167     Vector<FloatRect> borderAndTextRects(CoordinateSpace, RespectClippingForTextRects = RespectClippingForTextRects::No) const;
168     FloatRect boundingRect(CoordinateSpace, RespectClippingForTextRects = RespectClippingForTextRects::No) const;
169
170     Vector<FloatRect> absoluteRectsForRangeInText(Node*, RenderText&, bool useSelectionHeight, bool& isFixed, RespectClippingForTextRects) const;
171
172     Ref<Document> m_ownerDocument;
173     RangeBoundaryPoint m_start;
174     RangeBoundaryPoint m_end;
175 };
176
177 WEBCORE_EXPORT Ref<Range> rangeOfContents(Node&);
178
179 WEBCORE_EXPORT bool areRangesEqual(const Range*, const Range*);
180 bool rangesOverlap(const Range*, const Range*);
181
182 inline bool documentOrderComparator(const Node* a, const Node* b)
183 {
184     return Range::compareBoundaryPoints(const_cast<Node*>(a), 0, const_cast<Node*>(b), 0).releaseReturnValue() < 0;
185 }
186     
187 WTF::TextStream& operator<<(WTF::TextStream&, const RangeBoundaryPoint&);
188 WTF::TextStream& operator<<(WTF::TextStream&, const Range&);
189
190 } // namespace
191
192 #if ENABLE(TREE_DEBUGGING)
193 // Outside the WebCore namespace for ease of invocation from the debugger.
194 void showTree(const WebCore::Range*);
195 #endif