LayoutTests:
[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 String;
39 class VisiblePosition;
40
41 Position rangeCompliantEquivalent(const Position&);
42 Position rangeCompliantEquivalent(const VisiblePosition&);
43 int maxDeepOffset(const Node*);
44 bool isAtomicNode(const Node*);
45 bool editingIgnoresContent(const Node*);
46 bool canHaveChildrenForEditing(const Node*);
47 Node* highestEditableRoot(const Position&);
48 VisiblePosition firstEditablePositionAfterPositionInRoot(const Position&, Node*);
49 VisiblePosition lastEditablePositionBeforePositionInRoot(const Position&, Node*);
50 int comparePositions(const Position&, const Position&);
51 Node* lowestEditableAncestor(Node*);
52 bool isContentEditable(Node*);
53 Position nextCandidate(const Position&);
54 Position nextVisuallyDistinctCandidate(const Position&);
55 Position previousCandidate(const Position&);
56 Position previousVisuallyDistinctCandidate(const Position&);
57 bool isEditablePosition(const Position&);
58 bool isRichlyEditablePosition(const Position&);
59 Element* editableRootForPosition(const Position&);
60 bool isBlock(Node*);
61 Node* enclosingBlock(Node*);
62
63 String stringWithRebalancedWhitespace(const String&, bool, bool);
64 const String& nonBreakingSpaceString();
65
66 //------------------------------------------------------------------------------------------
67
68 Position positionBeforeNode(const Node*);
69 Position positionAfterNode(const Node*);
70
71 bool isSpecialElement(const Node*);
72 bool validBlockTag(const String&);
73
74 PassRefPtr<Element> createDefaultParagraphElement(Document*);
75 PassRefPtr<Element> createBreakElement(Document*);
76 PassRefPtr<Element> createOrderedListElement(Document*);
77 PassRefPtr<Element> createUnorderedListElement(Document*);
78 PassRefPtr<Element> createListItemElement(Document*);
79 PassRefPtr<Element> createElement(Document*, const String&);
80
81 bool isTabSpanNode(const Node*);
82 bool isTabSpanTextNode(const Node*);
83 Node* tabSpanNode(const Node*);
84 Position positionBeforeTabSpan(const Position&);
85 PassRefPtr<Element> createTabSpanElement(Document*);
86 PassRefPtr<Element> createTabSpanElement(Document*, PassRefPtr<Node> tabTextNode);
87 PassRefPtr<Element> createTabSpanElement(Document*, const String& tabText);
88
89 bool isNodeRendered(const Node*);
90 bool isMailBlockquote(const Node*);
91 Node* nearestMailBlockquote(const Node*);
92
93 //------------------------------------------------------------------------------------------
94
95 bool isTableStructureNode(const Node*);
96 PassRefPtr<Element> createBlockPlaceholderElement(Document*);
97
98 bool isFirstVisiblePositionInSpecialElement(const Position&);
99 Position positionBeforeContainingSpecialElement(const Position&, Node** containingSpecialElement=0);
100 bool isLastVisiblePositionInSpecialElement(const Position&);
101 Position positionAfterContainingSpecialElement(const Position&, Node** containingSpecialElement=0);
102 Position positionOutsideContainingSpecialElement(const Position&, Node** containingSpecialElement=0);
103
104 Node* enclosingNodeWithTag(Node*, const QualifiedName&);
105 Node* enclosingNodeOfType(Node*, bool (*nodeIsOfType)(Node*));
106 Node* enclosingTableCell(const Position&);
107 Node* enclosingEmptyListItem(const VisiblePosition&);
108 bool isListElement(Node*);
109 Node* enclosingList(Node*);
110 Node* outermostEnclosingList(Node*);
111 Node* enclosingListChild(Node*);
112 Node* highestAncestor(Node*);
113 bool isTableElement(Node*);
114 Position positionAvoidingSpecialElementBoundary(const Position&, bool avoidAnchor = true);
115
116 }
117
118 #endif