Range constructors should take a Document&.
[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 "EditingBoundary.h"
30 #include "Position.h"
31 #include "TextDirection.h"
32 #include <wtf/Forward.h>
33 #include <wtf/unicode/CharacterNames.h>
34
35 namespace WebCore {
36
37 class Document;
38 class Element;
39 class HTMLElement;
40 class HTMLTextFormControlElement;
41 class Node;
42 class Position;
43 class Range;
44 class VisiblePosition;
45 class VisibleSelection;
46
47
48 // This file contains a set of helper functions used by the editing commands
49
50 // -------------------------------------------------------------------------
51 // Node
52 // -------------------------------------------------------------------------
53
54 // Functions returning Node
55
56 Node* highestAncestor(Node*);
57 Node* highestEditableRoot(const Position&, EditableType = ContentIsEditable);
58
59 Node* highestEnclosingNodeOfType(const Position&, bool (*nodeIsOfType)(const Node*),
60     EditingBoundaryCrossingRule = CannotCrossEditingBoundary, Node* stayWithin = 0);
61 Node* highestNodeToRemoveInPruning(Node*);
62 Node* lowestEditableAncestor(Node*);
63
64 Element* deprecatedEnclosingBlockFlowElement(Node*); // Use enclosingBlock instead.
65 Element* enclosingBlock(Node*, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
66 Node* enclosingTableCell(const Position&);
67 Node* enclosingEmptyListItem(const VisiblePosition&);
68 Element* enclosingAnchorElement(const Position&);
69 Node* enclosingNodeWithTag(const Position&, const QualifiedName&);
70 Node* enclosingNodeOfType(const Position&, bool (*nodeIsOfType)(const Node*), EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
71
72 Node* tabSpanNode(const Node*);
73 Node* isLastPositionBeforeTable(const VisiblePosition&);
74 Node* isFirstPositionAfterTable(const VisiblePosition&);
75
76 // These two deliver leaf nodes as if the whole DOM tree were a linear chain of its leaf nodes.
77 Node* nextLeafNode(const Node*);
78 Node* previousLeafNode(const Node*);
79
80 // offset functions on Node
81
82 int lastOffsetForEditing(const Node*);
83 int caretMinOffset(const Node*);
84 int caretMaxOffset(const Node*);
85
86 // boolean functions on Node
87
88 // FIXME: editingIgnoresContent, canHaveChildrenForEditing, and isAtomicNode
89 // should be renamed to reflect its usage.
90
91 // Returns true for nodes that either have no content, or have content that is ignored (skipped over) while editing.
92 // There are no VisiblePositions inside these nodes.
93 inline bool editingIgnoresContent(const Node* node)
94 {
95     return !node->canContainRangeEndPoint();
96 }
97
98 inline bool canHaveChildrenForEditing(const Node* node)
99 {
100     return !node->isTextNode() && node->canContainRangeEndPoint();
101 }
102
103 bool isAtomicNode(const Node*);
104 bool isBlock(const Node*);
105 bool isBlockFlowElement(const Node*);
106 bool isInline(const Node*);
107 bool isSpecialElement(const Node*);
108 bool isTabSpanNode(const Node*);
109 bool isTabSpanTextNode(const Node*);
110 bool isMailBlockquote(const Node*);
111 bool isTableElement(Node*);
112 bool isTableCell(const Node*);
113 bool isEmptyTableCell(const Node*);
114 bool isTableStructureNode(const Node*);
115 bool isListElement(Node*);
116 bool isListItem(const Node*);
117 bool isNodeRendered(const Node*);
118 bool isNodeVisiblyContainedWithin(Node*, const Range*);
119 bool isRenderedAsNonInlineTableImageOrHR(const Node*);
120 bool areIdenticalElements(const Node*, const Node*);
121 bool isNonTableCellHTMLBlockElement(const Node*);
122
123 TextDirection directionOfEnclosingBlock(const Position&);
124
125 // -------------------------------------------------------------------------
126 // Position
127 // -------------------------------------------------------------------------
128     
129 // Functions returning Position
130     
131 Position nextCandidate(const Position&);
132 Position previousCandidate(const Position&);
133     
134 Position nextVisuallyDistinctCandidate(const Position&);
135 Position previousVisuallyDistinctCandidate(const Position&);
136
137 Position positionOutsideTabSpan(const Position&);
138 Position positionBeforeContainingSpecialElement(const Position&, Node** containingSpecialElement = 0);
139 Position positionAfterContainingSpecialElement(const Position&, Node** containingSpecialElement = 0);
140 Position positionOutsideContainingSpecialElement(const Position&, Node** containingSpecialElement = 0);
141
142 inline Position firstPositionInOrBeforeNode(Node* node)
143 {
144     if (!node)
145         return Position();
146     return editingIgnoresContent(node) ? positionBeforeNode(node) : firstPositionInNode(node);
147 }
148
149 inline Position lastPositionInOrAfterNode(Node* node)
150 {
151     if (!node)
152         return Position();
153     return editingIgnoresContent(node) ? positionAfterNode(node) : lastPositionInNode(node);
154 }
155
156 // comparision functions on Position
157     
158 int comparePositions(const Position&, const Position&);
159
160 // boolean functions on Position
161
162 enum EUpdateStyle { UpdateStyle, DoNotUpdateStyle };
163 bool isEditablePosition(const Position&, EditableType = ContentIsEditable, EUpdateStyle = UpdateStyle);
164 bool isRichlyEditablePosition(const Position&, EditableType = ContentIsEditable);
165 bool isFirstVisiblePositionInSpecialElement(const Position&);
166 bool isLastVisiblePositionInSpecialElement(const Position&);
167 bool lineBreakExistsAtPosition(const Position&);
168 bool isVisiblyAdjacent(const Position& first, const Position& second);
169 bool isAtUnsplittableElement(const Position&);
170
171 // miscellaneous functions on Position
172
173 unsigned numEnclosingMailBlockquotes(const Position&);
174 void updatePositionForNodeRemoval(Position&, Node*);
175
176 // -------------------------------------------------------------------------
177 // VisiblePosition
178 // -------------------------------------------------------------------------
179     
180 // Functions returning VisiblePosition
181     
182 VisiblePosition firstEditablePositionAfterPositionInRoot(const Position&, Node*);
183 VisiblePosition lastEditablePositionBeforePositionInRoot(const Position&, Node*);
184 VisiblePosition visiblePositionBeforeNode(Node*);
185 VisiblePosition visiblePositionAfterNode(Node*);
186
187 bool lineBreakExistsAtVisiblePosition(const VisiblePosition&);
188     
189 int comparePositions(const VisiblePosition&, const VisiblePosition&);
190
191 int indexForVisiblePosition(const VisiblePosition&, RefPtr<ContainerNode>& scope);
192 int indexForVisiblePosition(Node*, const VisiblePosition&, bool forSelectionPreservation);
193 VisiblePosition visiblePositionForIndex(int index, ContainerNode* scope);
194 VisiblePosition visiblePositionForIndexUsingCharacterIterator(Node*, int index); // FIXME: Why do we need this version?
195
196 // -------------------------------------------------------------------------
197 // HTMLElement
198 // -------------------------------------------------------------------------
199     
200 // Functions returning HTMLElement
201     
202 PassRefPtr<HTMLElement> createDefaultParagraphElement(Document&);
203 PassRefPtr<HTMLElement> createBreakElement(Document&);
204 PassRefPtr<HTMLElement> createOrderedListElement(Document&);
205 PassRefPtr<HTMLElement> createUnorderedListElement(Document&);
206 PassRefPtr<HTMLElement> createListItemElement(Document&);
207 PassRefPtr<HTMLElement> createHTMLElement(Document&, const QualifiedName&);
208 PassRefPtr<HTMLElement> createHTMLElement(Document&, const AtomicString&);
209
210 HTMLElement* enclosingList(Node*);
211 HTMLElement* outermostEnclosingList(Node*, Node* rootList = 0);
212 Node* enclosingListChild(Node*);
213
214 // -------------------------------------------------------------------------
215 // Element
216 // -------------------------------------------------------------------------
217     
218 // Functions returning Element
219     
220 PassRefPtr<Element> createTabSpanElement(Document&);
221 PassRefPtr<Element> createTabSpanElement(Document&, PassRefPtr<Node> tabTextNode);
222 PassRefPtr<Element> createTabSpanElement(Document&, const String& tabText);
223 PassRefPtr<Element> createBlockPlaceholderElement(Document&);
224
225 Element* editableRootForPosition(const Position&, EditableType = ContentIsEditable);
226 Element* unsplittableElementForPosition(const Position&);
227
228 // Boolean functions on Element
229     
230 bool canMergeLists(Element* firstList, Element* secondList);
231     
232 // -------------------------------------------------------------------------
233 // VisibleSelection
234 // -------------------------------------------------------------------------
235
236 // Functions returning VisibleSelection
237 VisibleSelection selectionForParagraphIteration(const VisibleSelection&);
238
239 Position adjustedSelectionStartForStyleComputation(const VisibleSelection&);
240     
241
242 // Miscellaneous functions on Text
243 inline bool isWhitespace(UChar c)
244 {
245     return c == noBreakSpace || c == ' ' || c == '\n' || c == '\t';
246 }
247
248 inline bool isAmbiguousBoundaryCharacter(UChar character)
249 {
250     // These are characters that can behave as word boundaries, but can appear within words.
251     // If they are just typed, i.e. if they are immediately followed by a caret, we want to delay text checking until the next character has been typed.
252     // FIXME: this is required until 6853027 is fixed and text checking can do this for us.
253     return character == '\'' || character == rightSingleQuotationMark || character == hebrewPunctuationGershayim;
254 }
255
256 String stringWithRebalancedWhitespace(const String&, bool startIsStartOfParagraph, bool endIsEndOfParagraph);
257 const String& nonBreakingSpaceString();
258
259 }
260
261 #endif