4a6a39271c86e0016969dffdc0cd34cf9141d891
[WebKit-https.git] / WebCore / editing / htmlediting.h
1 /*
2  * Copyright (C) 2004, 2006 Apple Computer, 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 <wtf/Forward.h>
30 #include "HTMLNames.h"
31
32 namespace WebCore {
33
34 class Document;
35 class Element;
36 class Node;
37 class Position;
38 class Range;
39 class Selection;
40 class String;
41 class VisiblePosition;
42
43 Position rangeCompliantEquivalent(const Position&);
44 Position rangeCompliantEquivalent(const VisiblePosition&);
45 int maxDeepOffset(const Node*);
46 bool isAtomicNode(const Node*);
47 bool editingIgnoresContent(const Node*);
48 bool canHaveChildrenForEditing(const Node*);
49 Node* highestEditableRoot(const Position&);
50 VisiblePosition firstEditablePositionAfterPositionInRoot(const Position&, Node*);
51 VisiblePosition lastEditablePositionBeforePositionInRoot(const Position&, Node*);
52 int comparePositions(const Position&, const Position&);
53 Node* lowestEditableAncestor(Node*);
54 bool isContentEditable(const Node*);
55 Position nextCandidate(const Position&);
56 Position nextVisuallyDistinctCandidate(const Position&);
57 Position previousCandidate(const Position&);
58 Position previousVisuallyDistinctCandidate(const Position&);
59 bool isEditablePosition(const Position&);
60 bool isRichlyEditablePosition(const Position&);
61 Element* editableRootForPosition(const Position&);
62 bool isBlock(const Node*);
63 Node* enclosingBlock(Node*);
64
65 String stringWithRebalancedWhitespace(const String&, bool, bool);
66 const String& nonBreakingSpaceString();
67
68 //------------------------------------------------------------------------------------------
69
70 Position positionBeforeNode(const Node*);
71 Position positionAfterNode(const Node*);
72
73 PassRefPtr<Range> avoidIntersectionWithNode(const Range*, Node*);
74 Selection avoidIntersectionWithNode(const Selection&, Node*);
75
76 bool isSpecialElement(const Node*);
77 bool validBlockTag(const String&);
78
79 PassRefPtr<Element> createDefaultParagraphElement(Document*);
80 PassRefPtr<Element> createBreakElement(Document*);
81 PassRefPtr<Element> createOrderedListElement(Document*);
82 PassRefPtr<Element> createUnorderedListElement(Document*);
83 PassRefPtr<Element> createListItemElement(Document*);
84 PassRefPtr<Element> createElement(Document*, const String&);
85
86 bool isTabSpanNode(const Node*);
87 bool isTabSpanTextNode(const Node*);
88 Node* tabSpanNode(const Node*);
89 Position positionBeforeTabSpan(const Position&);
90 PassRefPtr<Element> createTabSpanElement(Document*);
91 PassRefPtr<Element> createTabSpanElement(Document*, PassRefPtr<Node> tabTextNode);
92 PassRefPtr<Element> createTabSpanElement(Document*, const String& tabText);
93
94 bool isNodeRendered(const Node*);
95 bool isMailBlockquote(const Node*);
96 Node* nearestMailBlockquote(const Node*);
97 unsigned numEnclosingMailBlockquotes(const Position&);
98 int caretMinOffset(const Node*);
99 int caretMaxOffset(const Node*);
100
101 //------------------------------------------------------------------------------------------
102
103 bool isTableStructureNode(const Node*);
104 PassRefPtr<Element> createBlockPlaceholderElement(Document*);
105
106 bool isFirstVisiblePositionInSpecialElement(const Position&);
107 Position positionBeforeContainingSpecialElement(const Position&, Node** containingSpecialElement=0);
108 bool isLastVisiblePositionInSpecialElement(const Position&);
109 Position positionAfterContainingSpecialElement(const Position&, Node** containingSpecialElement=0);
110 Position positionOutsideContainingSpecialElement(const Position&, Node** containingSpecialElement=0);
111 Node* isLastPositionBeforeTable(const VisiblePosition&);
112 Node* isFirstPositionAfterTable(const VisiblePosition&);
113
114 Node* enclosingNodeWithTag(const Position&, const QualifiedName&);
115 Node* enclosingNodeOfType(const Position&, bool (*nodeIsOfType)(const Node*), bool onlyReturnEditableNodes = true);
116 Node* enclosingTableCell(const Position&);
117 Node* enclosingEmptyListItem(const VisiblePosition&);
118 Node* enclosingAnchorElement(const Position&);
119 bool isListElement(Node*);
120 Node* enclosingList(Node*);
121 Node* outermostEnclosingList(Node*);
122 Node* enclosingListChild(Node*);
123 Node* highestAncestor(Node*);
124 bool isTableElement(Node*);
125 bool isTableCell(const Node*);
126
127 bool lineBreakExistsAtPosition(const VisiblePosition&);
128
129 Selection selectionForParagraphIteration(const Selection&);
130
131 int indexForVisiblePosition(VisiblePosition&);
132
133 }
134
135 #endif