98fdf664f76a8c808afca46b0da9ca923b864e54
[WebKit-https.git] / Source / WebCore / editing / htmlediting.h
1 /*
2  * Copyright (C) 2004, 2006, 2008 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef htmlediting_h
27 #define htmlediting_h
28
29 #include "CharacterNames.h"
30 #include "ExceptionCode.h"
31 #include "HTMLNames.h"
32 #include "Position.h"
33 #include <wtf/Forward.h>
34
35 namespace WebCore {
36
37 class Document;
38 class Element;
39 class HTMLElement;
40 class Node;
41 class Position;
42 class Range;
43 class VisiblePosition;
44 class VisibleSelection;
45
46
47 // This file contains a set of helper functions used by the editing commands
48
49 // -------------------------------------------------------------------------
50 // Node
51 // -------------------------------------------------------------------------
52
53 // Functions returning Node
54
55 Node* highestAncestor(Node*);
56 Node* highestEditableRoot(const Position&);
57 Node* highestEnclosingNodeOfType(const Position&, bool (*nodeIsOfType)(const Node*));
58 Node* lowestEditableAncestor(Node*);   
59
60 Node* enclosingBlock(Node*);
61 Node* enclosingTableCell(const Position&);
62 Node* enclosingEmptyListItem(const VisiblePosition&);
63 Node* enclosingAnchorElement(const Position&);
64 Node* enclosingNodeWithTag(const Position&, const QualifiedName&);
65 Node* enclosingNodeOfType(const Position&, bool (*nodeIsOfType)(const Node*), bool onlyReturnEditableNodes = true);
66
67 Node* tabSpanNode(const Node*);
68 Node* nearestMailBlockquote(const Node*);
69 Node* isLastPositionBeforeTable(const VisiblePosition&);
70 Node* isFirstPositionAfterTable(const VisiblePosition&);
71
72 // offset functions on Node
73
74 int lastOffsetForEditing(const Node*);
75 int caretMinOffset(const Node*);
76 int caretMaxOffset(const Node*);
77
78 // boolean functions on Node
79
80 bool editingIgnoresContent(const Node*);
81 bool canHaveChildrenForEditing(const Node*);
82 bool isAtomicNode(const Node*);
83 bool isBlock(const Node*);
84 bool isSpecialElement(const Node*);
85 bool isTabSpanNode(const Node*);
86 bool isTabSpanTextNode(const Node*);
87 bool isMailBlockquote(const Node*);
88 bool isTableElement(Node*);
89 bool isTableCell(const Node*);
90 bool isEmptyTableCell(const Node*);
91 bool isTableStructureNode(const Node*);
92 bool isListElement(Node*);
93 bool isListItem(Node*);
94 bool isNodeRendered(const Node*);
95 bool isNodeVisiblyContainedWithin(Node*, const Range*);
96 bool isRenderedAsNonInlineTableImageOrHR(const Node*);
97 bool isNodeInTextFormControl(Node* node);
98     
99 // -------------------------------------------------------------------------
100 // Position
101 // -------------------------------------------------------------------------
102     
103 // Functions returning Position
104     
105 Position nextCandidate(const Position&);
106 Position previousCandidate(const Position&);
107     
108 Position nextVisuallyDistinctCandidate(const Position&);
109 Position previousVisuallyDistinctCandidate(const Position&);
110
111 Position positionBeforeTabSpan(const Position&);
112 Position positionBeforeContainingSpecialElement(const Position&, Node** containingSpecialElement=0);
113 Position positionAfterContainingSpecialElement(const Position&, Node** containingSpecialElement=0);
114 Position positionOutsideContainingSpecialElement(const Position&, Node** containingSpecialElement=0);
115
116 inline Position firstPositionInOrBeforeNode(Node* node)
117 {
118     return editingIgnoresContent(node) ? positionBeforeNode(node) : firstPositionInNode(node);
119 }
120
121 inline Position lastPositionInOrAfterNode(Node* node)
122 {
123     return editingIgnoresContent(node) ? positionAfterNode(node) : lastPositionInNode(node);
124 }
125
126 // Position creation functions are inline to prevent ref-churn.
127 // Other Position creation functions are in Position.h
128 // but these depend on lastOffsetForEditing which is defined in htmlediting.h.
129
130 // NOTE: first/lastDeepEditingPositionForNode return legacy editing positions (like [img, 0])
131 // for elements which editing ignores.  The rest of the editing code will treat [img, 0]
132 // as "the last position before the img".
133 // New code should use the creation functions in Position.h instead.
134 inline Position firstDeepEditingPositionForNode(Node* anchorNode)
135 {
136     ASSERT(anchorNode);
137     return Position(anchorNode, 0);
138 }
139
140 inline Position lastDeepEditingPositionForNode(Node* anchorNode)
141 {
142     ASSERT(anchorNode);
143     return Position(anchorNode, lastOffsetForEditing(anchorNode));
144 }
145        
146 // comparision functions on Position
147     
148 int comparePositions(const Position&, const Position&);
149
150 // boolean functions on Position
151     
152 bool isEditablePosition(const Position&);
153 bool isRichlyEditablePosition(const Position&);
154 bool isFirstVisiblePositionInSpecialElement(const Position&);
155 bool isLastVisiblePositionInSpecialElement(const Position&);
156 bool lineBreakExistsAtPosition(const Position&);
157 bool isVisiblyAdjacent(const Position& first, const Position& second);
158 bool isAtUnsplittableElement(const Position&);
159
160 // miscellaneous functions on Position
161
162 unsigned numEnclosingMailBlockquotes(const Position&);
163
164 // -------------------------------------------------------------------------
165 // VisiblePosition
166 // -------------------------------------------------------------------------
167     
168 // Functions returning VisiblePosition
169     
170 VisiblePosition firstEditablePositionAfterPositionInRoot(const Position&, Node*);
171 VisiblePosition lastEditablePositionBeforePositionInRoot(const Position&, Node*);
172 VisiblePosition visiblePositionBeforeNode(Node*);
173 VisiblePosition visiblePositionAfterNode(Node*);
174
175 bool lineBreakExistsAtVisiblePosition(const VisiblePosition&);
176     
177 int comparePositions(const VisiblePosition&, const VisiblePosition&);
178 int indexForVisiblePosition(const VisiblePosition&);
179
180 // -------------------------------------------------------------------------
181 // Range
182 // -------------------------------------------------------------------------
183
184 // Functions returning Range
185
186 PassRefPtr<Range> createRange(PassRefPtr<Document>, const VisiblePosition& start, const VisiblePosition& end, ExceptionCode&);
187 PassRefPtr<Range> extendRangeToWrappingNodes(PassRefPtr<Range> rangeToExtend, const Range* maximumRange, const Node* rootNode);
188 PassRefPtr<Range> avoidIntersectionWithNode(const Range*, Node*);
189
190 // -------------------------------------------------------------------------
191 // HTMLElement
192 // -------------------------------------------------------------------------
193     
194 // Functions returning HTMLElement
195     
196 PassRefPtr<HTMLElement> createDefaultParagraphElement(Document*);
197 PassRefPtr<HTMLElement> createBreakElement(Document*);
198 PassRefPtr<HTMLElement> createOrderedListElement(Document*);
199 PassRefPtr<HTMLElement> createUnorderedListElement(Document*);
200 PassRefPtr<HTMLElement> createListItemElement(Document*);
201 PassRefPtr<HTMLElement> createHTMLElement(Document*, const QualifiedName&);
202 PassRefPtr<HTMLElement> createHTMLElement(Document*, const AtomicString&);
203
204 HTMLElement* enclosingList(Node*);
205 HTMLElement* outermostEnclosingList(Node*, Node* rootList = 0);
206 HTMLElement* enclosingListChild(Node*);
207
208 // -------------------------------------------------------------------------
209 // Element
210 // -------------------------------------------------------------------------
211     
212 // Functions returning Element
213     
214 PassRefPtr<Element> createTabSpanElement(Document*);
215 PassRefPtr<Element> createTabSpanElement(Document*, PassRefPtr<Node> tabTextNode);
216 PassRefPtr<Element> createTabSpanElement(Document*, const String& tabText);
217 PassRefPtr<Element> createBlockPlaceholderElement(Document*);
218
219 Element* editableRootForPosition(const Position&);
220 Element* unsplittableElementForPosition(const Position&);
221
222 // Boolean functions on Element
223     
224 bool canMergeLists(Element* firstList, Element* secondList);
225     
226 // -------------------------------------------------------------------------
227 // VisibleSelection
228 // -------------------------------------------------------------------------
229
230 // Functions returning VisibleSelection
231 VisibleSelection avoidIntersectionWithNode(const VisibleSelection&, Node*);
232 VisibleSelection selectionForParagraphIteration(const VisibleSelection&);
233     
234
235 // Miscellaneous functions on Text
236 inline bool isWhitespace(UChar c)
237 {
238     return c == noBreakSpace || c == ' ' || c == '\n' || c == '\t';
239 }
240 String stringWithRebalancedWhitespace(const String&, bool, bool);
241 const String& nonBreakingSpaceString();
242
243 }
244
245 #endif