10ced026b0af26ec716ec859ac078a411eb0d334
[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 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 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 "TextFlags.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 RenderBlock;
45 class VisiblePosition;
46 class VisibleSelection;
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 = nullptr);
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 Element* enclosingElementWithTag(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 WEBCORE_EXPORT int lastOffsetForEditing(const Node*);
83 int caretMinOffset(const Node*);
84 int caretMaxOffset(const Node*);
85
86 // boolean functions on Node
87
88 bool hasEditableStyle(const Node&, EditableType);
89 bool isEditableNode(const Node&);
90
91 // FIXME: editingIgnoresContent, canHaveChildrenForEditing, and isAtomicNode
92 // should be renamed to reflect its usage.
93
94 // Returns true for nodes that either have no content, or have content that is ignored (skipped over) while editing.
95 // There are no VisiblePositions inside these nodes.
96 inline bool editingIgnoresContent(const Node* node)
97 {
98     return !node->canContainRangeEndPoint();
99 }
100
101 inline bool canHaveChildrenForEditing(const Node* node)
102 {
103     return !node->isTextNode() && node->canContainRangeEndPoint();
104 }
105
106 bool isAtomicNode(const Node*);
107 bool isBlock(const Node*);
108 bool isBlockFlowElement(const Node*);
109 bool isInline(const Node*);
110 bool isSpecialElement(const Node*);
111 bool isTabSpanNode(const Node*);
112 bool isTabSpanTextNode(const Node*);
113 bool isMailBlockquote(const Node*);
114 bool isRenderedTable(const Node*);
115 bool isTableCell(const Node*);
116 bool isEmptyTableCell(const Node*);
117 bool isTableStructureNode(const Node*);
118 bool isListElement(Node*);
119 bool isListItem(const Node*);
120 bool isNodeRendered(const Node*);
121 bool isNodeVisiblyContainedWithin(Node*, const Range*);
122 bool isRenderedAsNonInlineTableImageOrHR(const Node*);
123 bool areIdenticalElements(const Node*, const Node*);
124 bool isNonTableCellHTMLBlockElement(const Node*);
125
126 inline bool positionBeforeOrAfterNodeIsCandidate(Node* node)
127 {
128     return isRenderedTable(node) || editingIgnoresContent(node);
129 }
130
131 WEBCORE_EXPORT TextDirection directionOfEnclosingBlock(const Position&);
132
133 // -------------------------------------------------------------------------
134 // Position
135 // -------------------------------------------------------------------------
136     
137 // Functions returning Position
138     
139 Position nextCandidate(const Position&);
140 Position previousCandidate(const Position&);
141     
142 Position nextVisuallyDistinctCandidate(const Position&);
143 Position previousVisuallyDistinctCandidate(const Position&);
144
145 Position positionOutsideTabSpan(const Position&);
146 Position positionBeforeContainingSpecialElement(const Position&, Node** containingSpecialElement = nullptr);
147 Position positionAfterContainingSpecialElement(const Position&, Node** containingSpecialElement = nullptr);
148 Position positionOutsideContainingSpecialElement(const Position&, Node** containingSpecialElement = nullptr);
149
150 inline Position firstPositionInOrBeforeNode(Node* node)
151 {
152     if (!node)
153         return Position();
154     return editingIgnoresContent(node) ? positionBeforeNode(node) : firstPositionInNode(node);
155 }
156
157 inline Position lastPositionInOrAfterNode(Node* node)
158 {
159     if (!node)
160         return Position();
161     return editingIgnoresContent(node) ? positionAfterNode(node) : lastPositionInNode(node);
162 }
163
164 // comparision functions on Position
165     
166 int comparePositions(const Position&, const Position&);
167
168 // boolean functions on Position
169
170 WEBCORE_EXPORT bool isEditablePosition(const Position&, EditableType = ContentIsEditable);
171 bool isRichlyEditablePosition(const Position&);
172 bool isFirstVisiblePositionInSpecialElement(const Position&);
173 bool isLastVisiblePositionInSpecialElement(const Position&);
174 bool lineBreakExistsAtPosition(const Position&);
175 bool isVisiblyAdjacent(const Position& first, const Position& second);
176 bool isAtUnsplittableElement(const Position&);
177
178 // miscellaneous functions on Position
179
180 unsigned numEnclosingMailBlockquotes(const Position&);
181 void updatePositionForNodeRemoval(Position&, Node&);
182
183 // -------------------------------------------------------------------------
184 // VisiblePosition
185 // -------------------------------------------------------------------------
186     
187 // Functions returning VisiblePosition
188     
189 VisiblePosition firstEditablePositionAfterPositionInRoot(const Position&, Node*);
190 VisiblePosition lastEditablePositionBeforePositionInRoot(const Position&, Node*);
191 VisiblePosition visiblePositionBeforeNode(Node*);
192 VisiblePosition visiblePositionAfterNode(Node*);
193
194 bool lineBreakExistsAtVisiblePosition(const VisiblePosition&);
195     
196 int comparePositions(const VisiblePosition&, const VisiblePosition&);
197
198 int indexForVisiblePosition(const VisiblePosition&, RefPtr<ContainerNode>& scope);
199 int indexForVisiblePosition(Node*, const VisiblePosition&, bool forSelectionPreservation);
200 VisiblePosition visiblePositionForIndex(int index, ContainerNode* scope);
201 VisiblePosition visiblePositionForIndexUsingCharacterIterator(Node*, int index); // FIXME: Why do we need this version?
202
203 // -------------------------------------------------------------------------
204 // HTMLElement
205 // -------------------------------------------------------------------------
206     
207 // Functions returning HTMLElement
208     
209 WEBCORE_EXPORT Ref<HTMLElement> createDefaultParagraphElement(Document&);
210 Ref<HTMLElement> createBreakElement(Document&);
211 PassRefPtr<HTMLElement> createOrderedListElement(Document&);
212 PassRefPtr<HTMLElement> createUnorderedListElement(Document&);
213 PassRefPtr<HTMLElement> createListItemElement(Document&);
214 Ref<HTMLElement> createHTMLElement(Document&, const QualifiedName&);
215 Ref<HTMLElement> createHTMLElement(Document&, const AtomicString&);
216
217 HTMLElement* enclosingList(Node*);
218 HTMLElement* outermostEnclosingList(Node*, Node* rootList = nullptr);
219 Node* enclosingListChild(Node*);
220
221 // -------------------------------------------------------------------------
222 // Element
223 // -------------------------------------------------------------------------
224
225 Ref<Element> createTabSpanElement(Document&);
226 Ref<Element> createTabSpanElement(Document&, PassRefPtr<Node> tabTextNode);
227 Ref<Element> createTabSpanElement(Document&, const String& tabText);
228 Ref<Element> createBlockPlaceholderElement(Document&);
229
230 Element* editableRootForPosition(const Position&, EditableType = ContentIsEditable);
231 Element* unsplittableElementForPosition(const Position&);
232
233 bool canMergeLists(Element* firstList, Element* secondList);
234     
235 // -------------------------------------------------------------------------
236 // VisibleSelection
237 // -------------------------------------------------------------------------
238
239 VisibleSelection selectionForParagraphIteration(const VisibleSelection&);
240
241 Position adjustedSelectionStartForStyleComputation(const VisibleSelection&);
242     
243 // -------------------------------------------------------------------------
244
245 // FIXME: This is only one of many definitions of whitespace, so the name is not specific enough.
246 inline bool isWhitespace(UChar c)
247 {
248     return c == noBreakSpace || c == ' ' || c == '\n' || c == '\t';
249 }
250
251 // FIXME: Can't really answer this question correctly without knowing the white-space mode.
252 inline bool deprecatedIsCollapsibleWhitespace(UChar c)
253 {
254     return c == ' ' || c == '\n';
255 }
256
257 inline bool isAmbiguousBoundaryCharacter(UChar character)
258 {
259     // These are characters that can behave as word boundaries, but can appear within words.
260     // 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.
261     // FIXME: this is required until 6853027 is fixed and text checking can do this for us.
262     return character == '\'' || character == rightSingleQuotationMark || character == hebrewPunctuationGershayim;
263 }
264
265 String stringWithRebalancedWhitespace(const String&, bool startIsStartOfParagraph, bool endIsEndOfParagraph);
266 const String& nonBreakingSpaceString();
267
268 // Miscellaaneous functions that for caret rendering
269
270 RenderBlock* rendererForCaretPainting(Node*);
271 LayoutRect localCaretRectInRendererForCaretPainting(const VisiblePosition&, RenderBlock*&);
272 IntRect absoluteBoundsForLocalCaretRect(RenderBlock* rendererForCaretPainting, const LayoutRect&);
273
274 }
275
276 #endif