Source/WebCore: WebCore part of <rdar://problem/9281695> Add text search API for...
[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 "IntRect.h"
31 #include "Node.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 NodeWithIndex;
46 class Text;
47
48 class Range : public RefCounted<Range> {
49 public:
50     static PassRefPtr<Range> create(PassRefPtr<Document>);
51     static PassRefPtr<Range> create(PassRefPtr<Document>, PassRefPtr<Node> startContainer, int startOffset, PassRefPtr<Node> endContainer, int endOffset);
52     static PassRefPtr<Range> create(PassRefPtr<Document>, const Position&, const Position&);
53     ~Range();
54
55     Document* ownerDocument() const { return m_ownerDocument.get(); }
56     Node* startContainer() const { return m_start.container(); }
57     int startOffset() const { return m_start.offset(); }
58     Node* endContainer() const { return m_end.container(); }
59     int endOffset() const { return m_end.offset(); }
60
61     Node* startContainer(ExceptionCode&) const;
62     int startOffset(ExceptionCode&) const;
63     Node* endContainer(ExceptionCode&) const;
64     int endOffset(ExceptionCode&) const;
65     bool collapsed(ExceptionCode& = ASSERT_NO_EXCEPTION) const;
66
67     Node* commonAncestorContainer(ExceptionCode&) const;
68     static Node* commonAncestorContainer(Node* containerA, Node* containerB);
69     void setStart(PassRefPtr<Node> container, int offset, ExceptionCode& = ASSERT_NO_EXCEPTION);
70     void setEnd(PassRefPtr<Node> container, int offset, ExceptionCode& = ASSERT_NO_EXCEPTION);
71     void collapse(bool toStart, ExceptionCode&);
72     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     short compareBoundaryPoints(CompareHow, const Range* sourceRange, ExceptionCode&) const;
78     static short compareBoundaryPoints(Node* containerA, int offsetA, Node* containerB, int offsetB, ExceptionCode&);
79     static short compareBoundaryPoints(const RangeBoundaryPoint& boundaryA, const RangeBoundaryPoint& boundaryB, ExceptionCode&);
80     bool boundaryPointsValid() const;
81     bool intersectsNode(Node* refNode, ExceptionCode&);
82     void deleteContents(ExceptionCode&);
83     PassRefPtr<DocumentFragment> extractContents(ExceptionCode&);
84     PassRefPtr<DocumentFragment> cloneContents(ExceptionCode&);
85     void insertNode(PassRefPtr<Node>, ExceptionCode&);
86     String toString(ExceptionCode&) const;
87
88     String toHTML() const;
89     String text() const;
90
91     PassRefPtr<DocumentFragment> createContextualFragment(const String& html, ExceptionCode&) const;
92
93     void detach(ExceptionCode&);
94     PassRefPtr<Range> cloneRange(ExceptionCode&) const;
95
96     void setStartAfter(Node*, ExceptionCode& = ASSERT_NO_EXCEPTION);
97     void setEndBefore(Node*, ExceptionCode& = ASSERT_NO_EXCEPTION);
98     void setEndAfter(Node*, ExceptionCode& = ASSERT_NO_EXCEPTION);
99     void selectNode(Node*, ExceptionCode& = ASSERT_NO_EXCEPTION);
100     void selectNodeContents(Node*, ExceptionCode&);
101     void surroundContents(PassRefPtr<Node>, ExceptionCode&);
102     void setStartBefore(Node*, ExceptionCode&);
103
104     const Position startPosition() const { return m_start.toPosition(); }
105     const Position endPosition() const { return m_end.toPosition(); }
106     void setStart(const Position&, ExceptionCode& = ASSERT_NO_EXCEPTION);
107     void setEnd(const Position&, ExceptionCode& = ASSERT_NO_EXCEPTION);
108
109     Node* firstNode() const;
110     Node* pastLastNode() const;
111
112     Position editingStartPosition() const;
113
114     Node* shadowTreeRootNode() const;
115
116     IntRect boundingBox();
117     
118     enum RangeInFixedPosition {
119         NotFixedPosition,
120         PartiallyFixedPosition,
121         EntirelyFixedPosition
122     };
123     
124     // Not transform-friendly
125     void textRects(Vector<IntRect>&, bool useSelectionHeight = false, RangeInFixedPosition* = 0);
126     // Transform-friendly
127     void textQuads(Vector<FloatQuad>&, bool useSelectionHeight = false, RangeInFixedPosition* = 0) const;
128     void getBorderAndTextQuads(Vector<FloatQuad>&) const;
129     FloatRect boundingRect() const;
130
131     void nodeChildrenChanged(ContainerNode*);
132     void nodeChildrenWillBeRemoved(ContainerNode*);
133     void nodeWillBeRemoved(Node*);
134
135     void textInserted(Node*, unsigned offset, unsigned length);
136     void textRemoved(Node*, unsigned offset, unsigned length);
137     void textNodesMerged(NodeWithIndex& oldNode, unsigned offset);
138     void textNodeSplit(Text* oldNode);
139
140     // Expand range to a unit (word or sentence or block or document) boundary.
141     // Please refer to https://bugs.webkit.org/show_bug.cgi?id=27632 comment #5 
142     // for details.
143     void expand(const String&, ExceptionCode&);
144
145     PassRefPtr<ClientRectList> getClientRects() const;
146     PassRefPtr<ClientRect> getBoundingClientRect() const;
147
148 #ifndef NDEBUG
149     void formatForDebugger(char* buffer, unsigned length) const;
150 #endif
151
152 private:
153     Range(PassRefPtr<Document>);
154     Range(PassRefPtr<Document>, PassRefPtr<Node> startContainer, int startOffset, PassRefPtr<Node> endContainer, int endOffset);
155
156     void setDocument(Document*);
157
158     Node* checkNodeWOffset(Node*, int offset, ExceptionCode&) const;
159     void checkNodeBA(Node*, ExceptionCode&) const;
160     void checkDeleteExtract(ExceptionCode&);
161     bool containedByReadOnly() const;
162     int maxStartOffset() const;
163     int maxEndOffset() const;
164
165     enum ActionType { DELETE_CONTENTS, EXTRACT_CONTENTS, CLONE_CONTENTS };
166     PassRefPtr<DocumentFragment> processContents(ActionType, ExceptionCode&);
167     static PassRefPtr<Node> processContentsBetweenOffsets(ActionType, PassRefPtr<DocumentFragment>, Node*, unsigned startOffset, unsigned endOffset, ExceptionCode&);
168     static void processNodes(ActionType, Vector<RefPtr<Node> >&, PassRefPtr<Node> oldContainer, PassRefPtr<Node> newContainer, ExceptionCode&);
169     enum ContentsProcessDirection { ProcessContentsForward, ProcessContentsBackward };
170     static PassRefPtr<Node> processAncestorsAndTheirSiblings(ActionType, Node* container, ContentsProcessDirection, PassRefPtr<Node> clonedContainer, Node* commonRoot, ExceptionCode&);
171
172     RefPtr<Document> m_ownerDocument;
173     RangeBoundaryPoint m_start;
174     RangeBoundaryPoint m_end;
175 };
176
177 PassRefPtr<Range> rangeOfContents(Node*);
178
179 bool areRangesEqual(const Range*, const Range*);
180
181 } // namespace
182
183 #ifndef NDEBUG
184 // Outside the WebCore namespace for ease of invocation from gdb.
185 void showTree(const WebCore::Range*);
186 #endif
187
188 #endif