1 /*
2 * Copyright (C) 2005, 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 #include "config.h"
27 #include "InsertLineBreakCommand.h"
28
29 #include "CSSMutableStyleDeclaration.h"
30 #include "Document.h"
31 #include "Frame.h"
32 #include "HTMLElement.h"
33 #include "HTMLNames.h"
34 #include "Range.h"
35 #include "RenderObject.h"
36 #include "Text.h"
37 #include "VisiblePosition.h"
38 #include "htmlediting.h"
39 #include "visible_units.h"
40
41 namespace WebCore {
42
43 using namespace HTMLNames;
44
InsertLineBreakCommand(Document * document)45 InsertLineBreakCommand::InsertLineBreakCommand(Document* document)
46 : CompositeEditCommand(document)
47 {
48 }
49
preservesTypingStyle() const50 bool InsertLineBreakCommand::preservesTypingStyle() const
51 {
52 return true;
53 }
54
insertNodeAfterPosition(Node * node,const Position & pos)55 void InsertLineBreakCommand::insertNodeAfterPosition(Node* node, const Position& pos)
56 {
57 // Insert the BR after the caret position. In the case the
58 // position is a block, do an append. We don't want to insert
59 // the BR *after* the block.
60 Element* cb = pos.node()->enclosingBlockFlowElement();
61 if (cb == pos.node())
62 appendNode(node, cb);
63 else
64 insertNodeAfter(node, pos.node());
65 }
66
insertNodeBeforePosition(Node * node,const Position & pos)67 void InsertLineBreakCommand::insertNodeBeforePosition(Node* node, const Position& pos)
68 {
69 // Insert the BR after the caret position. In the case the
70 // position is a block, do an append. We don't want to insert
71 // the BR *before* the block.
72 Element* cb = pos.node()->enclosingBlockFlowElement();
73 if (cb == pos.node())
74 appendNode(node, cb);
75 else
76 insertNodeBefore(node, pos.node());
77 }
78
79 // Whether we should insert a break element or a '\n'.
shouldUseBreakElement(const Position & insertionPos)80 bool InsertLineBreakCommand::shouldUseBreakElement(const Position& insertionPos)
81 {
82 // An editing position like [input, 0] actually refers to the position before
83 // the input element, and in that case we need to check the input element's
84 // parent's renderer.
85 Position p(rangeCompliantEquivalent(insertionPos));
86 return p.node()->renderer() && !p.node()->renderer()->style()->preserveNewline();
87 }
88
doApply()89 void InsertLineBreakCommand::doApply()
90 {
91 deleteSelection();
92 VisibleSelection selection = endingSelection();
93 if (selection.isNone())
94 return;
95
96 VisiblePosition caret(selection.visibleStart());
97 Position pos(caret.deepEquivalent());
98
99 pos = positionAvoidingSpecialElementBoundary(pos);
100
101 pos = positionOutsideTabSpan(pos);
102
103 RefPtr<Node> nodeToInsert;
104 if (shouldUseBreakElement(pos))
105 nodeToInsert = createBreakElement(document());
106 else
107 nodeToInsert = document()->createTextNode("\n");
108
109 // FIXME: Need to merge text nodes when inserting just after or before text.
110
111 if (isEndOfParagraph(caret) && !lineBreakExistsAtVisiblePosition(caret)) {
112 bool needExtraLineBreak = !pos.node()->hasTagName(hrTag) && !pos.node()->hasTagName(tableTag);
113
114 insertNodeAt(nodeToInsert.get(), pos);
115
116 if (needExtraLineBreak)
117 insertNodeBefore(nodeToInsert->cloneNode(false), nodeToInsert);
118
119 VisiblePosition endingPosition(Position(nodeToInsert.get(), 0));
120 setEndingSelection(VisibleSelection(endingPosition));
121 } else if (pos.deprecatedEditingOffset() <= caretMinOffset(pos.node())) {
122 insertNodeAt(nodeToInsert.get(), pos);
123
124 // Insert an extra br or '\n' if the just inserted one collapsed.
125 if (!isStartOfParagraph(VisiblePosition(Position(nodeToInsert.get(), 0))))
126 insertNodeBefore(nodeToInsert->cloneNode(false).get(), nodeToInsert.get());
127
128 setEndingSelection(VisibleSelection(positionInParentAfterNode(nodeToInsert.get()), DOWNSTREAM));
129 // If we're inserting after all of the rendered text in a text node, or into a non-text node,
130 // a simple insertion is sufficient.
131 } else if (pos.deprecatedEditingOffset() >= caretMaxOffset(pos.node()) || !pos.node()->isTextNode()) {
132 insertNodeAt(nodeToInsert.get(), pos);
133 setEndingSelection(VisibleSelection(positionInParentAfterNode(nodeToInsert.get()), DOWNSTREAM));
134 } else if (pos.node()->isTextNode()) {
135 // Split a text node
136 Text* textNode = static_cast<Text*>(pos.node());
137 splitTextNode(textNode, pos.deprecatedEditingOffset());
138 insertNodeBefore(nodeToInsert, textNode);
139 Position endingPosition = Position(textNode, 0);
140
141 // Handle whitespace that occurs after the split
142 updateLayout();
143 if (!endingPosition.isRenderedCharacter()) {
144 Position positionBeforeTextNode(positionInParentBeforeNode(textNode));
145 // Clear out all whitespace and insert one non-breaking space
146 deleteInsignificantTextDownstream(endingPosition);
147 ASSERT(!textNode->renderer() || textNode->renderer()->style()->collapseWhiteSpace());
148 // Deleting insignificant whitespace will remove textNode if it contains nothing but insignificant whitespace.
149 if (textNode->inDocument())
150 insertTextIntoNode(textNode, 0, nonBreakingSpaceString());
151 else {
152 RefPtr<Text> nbspNode = document()->createTextNode(nonBreakingSpaceString());
153 insertNodeAt(nbspNode.get(), positionBeforeTextNode);
154 endingPosition = Position(nbspNode.get(), 0);
155 }
156 }
157
158 setEndingSelection(VisibleSelection(endingPosition, DOWNSTREAM));
159 }
160
161 // Handle the case where there is a typing style.
162
163 CSSMutableStyleDeclaration* typingStyle = document()->frame()->typingStyle();
164
165 if (typingStyle && typingStyle->length() > 0) {
166 // Apply the typing style to the inserted line break, so that if the selection
167 // leaves and then comes back, new input will have the right style.
168 // FIXME: We shouldn't always apply the typing style to the line break here,
169 // see <rdar://problem/5794462>.
170 applyStyle(typingStyle, firstDeepEditingPositionForNode(nodeToInsert.get()), lastDeepEditingPositionForNode(nodeToInsert.get()));
171 // Even though this applyStyle operates on a Range, it still sets an endingSelection().
172 // It tries to set a VisibleSelection around the content it operated on. So, that VisibleSelection
173 // will either (a) select the line break we inserted, or it will (b) be a caret just
174 // before the line break (if the line break is at the end of a block it isn't selectable).
175 // So, this next call sets the endingSelection() to a caret just after the line break
176 // that we inserted, or just before it if it's at the end of a block.
177 setEndingSelection(endingSelection().visibleEnd());
178 }
179
180 rebalanceWhitespace();
181 }
182
183 }
184