WebCore:
[WebKit-https.git] / WebCore / editing / ReplaceSelectionCommand.cpp
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 "ReplaceSelectionCommand.h"
28
29 #include "ApplyStyleCommand.h"
30 #include "BeforeTextInsertedEvent.h"
31 #include "CSSComputedStyleDeclaration.h"
32 #include "CSSPropertyNames.h"
33 #include "CSSValueKeywords.h"
34 #include "Document.h"
35 #include "DocumentFragment.h"
36 #include "EditingText.h"
37 #include "EventNames.h"
38 #include "Element.h"
39 #include "Frame.h"
40 #include "HTMLElement.h"
41 #include "HTMLInterchange.h"
42 #include "HTMLInputElement.h"
43 #include "HTMLNames.h"
44 #include "SelectionController.h"
45 #include "SmartReplace.h"
46 #include "TextIterator.h"
47 #include "htmlediting.h"
48 #include "markup.h"
49 #include "visible_units.h"
50
51 namespace WebCore {
52
53 using namespace EventNames;
54 using namespace HTMLNames;
55
56 static bool isInterchangeNewlineNode(const Node *node)
57 {
58     static String interchangeNewlineClassString(AppleInterchangeNewline);
59     return node && node->hasTagName(brTag) && 
60            static_cast<const Element *>(node)->getAttribute(classAttr) == interchangeNewlineClassString;
61 }
62
63 static bool isInterchangeConvertedSpaceSpan(const Node *node)
64 {
65     static String convertedSpaceSpanClassString(AppleConvertedSpace);
66     return node->isHTMLElement() && 
67            static_cast<const HTMLElement *>(node)->getAttribute(classAttr) == convertedSpaceSpanClassString;
68 }
69
70 ReplacementFragment::ReplacementFragment(Document* document, DocumentFragment* fragment, bool matchStyle, const Selection& selection)
71     : m_document(document),
72       m_fragment(fragment),
73       m_matchStyle(matchStyle), 
74       m_hasInterchangeNewlineAtStart(false), 
75       m_hasInterchangeNewlineAtEnd(false)
76 {
77     if (!m_document)
78         return;
79     if (!m_fragment)
80         return;
81     if (!m_fragment->firstChild())
82         return;
83     
84     Element* editableRoot = selection.rootEditableElement();
85     ASSERT(editableRoot);
86     if (!editableRoot)
87         return;
88     
89     Node* shadowAncestorNode = editableRoot->shadowAncestorNode();
90     
91     if (!editableRoot->getHTMLEventListener(webkitBeforeTextInsertedEvent) &&
92         // FIXME: Remove these checks once textareas and textfields actually register an event handler.
93         !(shadowAncestorNode && shadowAncestorNode->renderer() && shadowAncestorNode->renderer()->isTextField()) &&
94         !(shadowAncestorNode && shadowAncestorNode->renderer() && shadowAncestorNode->renderer()->isTextArea()) &&
95         editableRoot->isContentRichlyEditable()) {
96         removeInterchangeNodes(m_fragment->firstChild());
97         return;
98     }
99
100     Node* styleNode = selection.base().node();
101     RefPtr<Node> holder = insertFragmentForTestRendering(styleNode);
102     
103     RefPtr<Range> range = Selection::selectionFromContentsOfNode(holder.get()).toRange();
104     String text = plainText(range.get());
105     // Give the root a chance to change the text.
106     RefPtr<BeforeTextInsertedEvent> evt = new BeforeTextInsertedEvent(text);
107     ExceptionCode ec = 0;
108     editableRoot->dispatchEvent(evt, ec, true);
109     ASSERT(ec == 0);
110     if (text != evt->text() || !editableRoot->isContentRichlyEditable()) {
111         restoreTestRenderingNodesToFragment(holder.get());
112         removeNode(holder);
113
114         m_fragment = createFragmentFromText(selection.toRange().get(), evt->text());
115         if (!m_fragment->firstChild())
116             return;
117         holder = insertFragmentForTestRendering(styleNode);
118     }
119     
120     removeInterchangeNodes(holder->firstChild());
121     
122     removeUnrenderedNodes(holder.get());
123     restoreTestRenderingNodesToFragment(holder.get());
124     removeNode(holder);
125 }
126
127 bool ReplacementFragment::isEmpty() const
128 {
129     return (!m_fragment || !m_fragment->firstChild()) && !m_hasInterchangeNewlineAtStart && !m_hasInterchangeNewlineAtEnd;
130 }
131
132 Node *ReplacementFragment::firstChild() const 
133
134     return m_fragment ? m_fragment->firstChild() : 0; 
135 }
136
137 Node *ReplacementFragment::lastChild() const 
138
139     return m_fragment ? m_fragment->lastChild() : 0; 
140 }
141
142 void ReplacementFragment::removeNodePreservingChildren(Node *node)
143 {
144     if (!node)
145         return;
146
147     while (RefPtr<Node> n = node->firstChild()) {
148         removeNode(n);
149         insertNodeBefore(n.get(), node);
150     }
151     removeNode(node);
152 }
153
154 void ReplacementFragment::removeNode(PassRefPtr<Node> node)
155 {
156     if (!node)
157         return;
158     
159     Node *parent = node->parentNode();
160     if (!parent)
161         return;
162     
163     ExceptionCode ec = 0;
164     parent->removeChild(node.get(), ec);
165     ASSERT(ec == 0);
166 }
167
168 void ReplacementFragment::insertNodeBefore(Node *node, Node *refNode)
169 {
170     if (!node || !refNode)
171         return;
172         
173     Node *parent = refNode->parentNode();
174     if (!parent)
175         return;
176         
177     ExceptionCode ec = 0;
178     parent->insertBefore(node, refNode, ec);
179     ASSERT(ec == 0);
180 }
181
182 PassRefPtr<Node> ReplacementFragment::insertFragmentForTestRendering(Node* context)
183 {
184     Node* body = m_document->body();
185     if (!body)
186         return 0;
187
188     RefPtr<StyledElement> holder = static_pointer_cast<StyledElement>(createDefaultParagraphElement(m_document.get()));
189     
190     ExceptionCode ec = 0;
191
192     // Copy the whitespace style from the context onto this element.
193     Node* n = context;
194     while (n && !n->isElementNode())
195         n = n->parentNode();
196     if (n) {
197         RefPtr<CSSComputedStyleDeclaration> contextStyle = new CSSComputedStyleDeclaration(static_cast<Element*>(n));
198         CSSStyleDeclaration* style = holder->style();
199         style->setProperty(CSS_PROP_WHITE_SPACE, contextStyle->getPropertyValue(CSS_PROP_WHITE_SPACE), false, ec);
200         ASSERT(ec == 0);
201     }
202     
203     holder->appendChild(m_fragment, ec);
204     ASSERT(ec == 0);
205     
206     body->appendChild(holder.get(), ec);
207     ASSERT(ec == 0);
208     
209     m_document->updateLayoutIgnorePendingStylesheets();
210     
211     return holder.release();
212 }
213
214 void ReplacementFragment::restoreTestRenderingNodesToFragment(Node *holder)
215 {
216     if (!holder)
217         return;
218     
219     ExceptionCode ec = 0;
220     while (RefPtr<Node> node = holder->firstChild()) {
221         holder->removeChild(node.get(), ec);
222         ASSERT(ec == 0);
223         m_fragment->appendChild(node.get(), ec);
224         ASSERT(ec == 0);
225     }
226 }
227
228 void ReplacementFragment::removeUnrenderedNodes(Node* holder)
229 {
230     Vector<Node*> unrendered;
231
232     for (Node* node = holder->firstChild(); node; node = node->traverseNextNode(holder))
233         if (!isNodeRendered(node) && !isTableStructureNode(node))
234             unrendered.append(node);
235
236     size_t n = unrendered.size();
237     for (size_t i = 0; i < n; ++i)
238         removeNode(unrendered[i]);
239 }
240
241 void ReplacementFragment::removeInterchangeNodes(Node* startNode)
242 {
243     Node* node = startNode;
244     Node* newlineAtStartNode = 0;
245     Node* newlineAtEndNode = 0;
246     while (node) {
247         Node *next = node->traverseNextNode();
248         if (isInterchangeNewlineNode(node)) {
249             if (next || node == startNode) {
250                 m_hasInterchangeNewlineAtStart = true;
251                 newlineAtStartNode = node;
252             }
253             else {
254                 m_hasInterchangeNewlineAtEnd = true;
255                 newlineAtEndNode = node;
256             }
257         }
258         else if (isInterchangeConvertedSpaceSpan(node)) {
259             RefPtr<Node> n = 0;
260             while ((n = node->firstChild())) {
261                 removeNode(n);
262                 insertNodeBefore(n.get(), node);
263             }
264             removeNode(node);
265             if (n)
266                 next = n->traverseNextNode();
267         }
268         node = next;
269     }
270
271     if (newlineAtStartNode)
272         removeNode(newlineAtStartNode);
273     if (newlineAtEndNode)
274         removeNode(newlineAtEndNode);
275 }
276
277 ReplaceSelectionCommand::ReplaceSelectionCommand(Document* document, PassRefPtr<DocumentFragment> fragment,
278         bool selectReplacement, bool smartReplace, bool matchStyle, bool preventNesting, bool movingParagraph,
279         EditAction editAction) 
280     : CompositeEditCommand(document),
281       m_selectReplacement(selectReplacement), 
282       m_smartReplace(smartReplace),
283       m_matchStyle(matchStyle),
284       m_documentFragment(fragment),
285       m_preventNesting(preventNesting),
286       m_movingParagraph(movingParagraph),
287       m_editAction(editAction)
288 {
289 }
290
291 bool ReplaceSelectionCommand::shouldMergeStart(bool selectionStartWasStartOfParagraph, bool fragmentHasInterchangeNewlineAtStart)
292 {
293     VisiblePosition startOfInsertedContent(positionAtStartOfInsertedContent());
294     VisiblePosition prev = startOfInsertedContent.previous(true);
295     if (prev.isNull())
296         return false;
297         
298     return !selectionStartWasStartOfParagraph && 
299            !fragmentHasInterchangeNewlineAtStart &&
300            isStartOfParagraph(startOfInsertedContent) && 
301            !startOfInsertedContent.deepEquivalent().node()->hasTagName(brTag) &&
302            shouldMerge(startOfInsertedContent, prev);
303 }
304
305 bool ReplaceSelectionCommand::shouldMergeEnd(bool selectionEndWasEndOfParagraph)
306 {
307     VisiblePosition endOfInsertedContent(positionAtEndOfInsertedContent());
308     VisiblePosition next = endOfInsertedContent.next(true);
309     if (next.isNull())
310         return false;
311
312     return !selectionEndWasEndOfParagraph &&
313            isEndOfParagraph(endOfInsertedContent) && 
314            !endOfInsertedContent.deepEquivalent().node()->hasTagName(brTag) &&
315            shouldMerge(endOfInsertedContent, next);
316 }
317
318 static bool isMailPasteAsQuotationNode(Node* node)
319 {
320     return node && node->hasTagName(blockquoteTag) && node->isElementNode() && static_cast<Element*>(node)->getAttribute(classAttr) == ApplePasteAsQuotation;
321 }
322
323 // Virtual method used so that ReplaceSelectionCommand can update the node's it tracks.
324 void ReplaceSelectionCommand::removeNodePreservingChildren(Node* node)
325 {
326     if (m_firstNodeInserted == node)
327         m_firstNodeInserted = node->traverseNextNode();
328     if (m_lastLeafInserted == node)
329         m_lastLeafInserted = node->lastChild() ? node->lastChild() : node->traverseNextSibling();
330     CompositeEditCommand::removeNodePreservingChildren(node);
331 }
332
333 bool ReplaceSelectionCommand::shouldMerge(const VisiblePosition& from, const VisiblePosition& to)
334 {
335     if (from.isNull() || to.isNull())
336         return false;
337         
338     Node* fromNode = from.deepEquivalent().node();
339     Node* toNode = to.deepEquivalent().node();
340     Node* fromNodeBlock = enclosingBlock(fromNode);
341     return !enclosingNodeOfType(fromNode, &isMailPasteAsQuotationNode) &&
342            fromNodeBlock && (!fromNodeBlock->hasTagName(blockquoteTag) || isMailBlockquote(fromNodeBlock))  &&
343            enclosingListChild(fromNode) == enclosingListChild(toNode) &&
344            enclosingTableCell(from.deepEquivalent()) == enclosingTableCell(from.deepEquivalent()) &&
345            // Don't merge to or from a position before or after a block because it would
346            // be a no-op and cause infinite recursion.
347            !isBlock(fromNode) && !isBlock(toNode);
348 }
349
350 // Style rules that match just inserted elements could change their appearance, like
351 // a div inserted into a document with div { display:inline; }.
352 void ReplaceSelectionCommand::negateStyleRulesThatAffectAppearance()
353 {
354     for (RefPtr<Node> node = m_firstNodeInserted.get(); node; node = node->traverseNextNode()) {
355         // FIXME: <rdar://problem/5371536> Style rules that match pasted content can change it's appearance
356         if (isStyleSpan(node.get())) {
357             HTMLElement* e = static_cast<HTMLElement*>(node.get());
358             // There are other styles that style rules can give to style spans,
359             // but these are the two important ones because they'll prevent
360             // inserted content from appearing in the right paragraph.
361             if (isBlock(e))
362                 e->getInlineStyleDecl()->setProperty(CSS_PROP_DISPLAY, CSS_VAL_INLINE);
363             if (e->renderer() && e->renderer()->style()->floating() != FNONE)
364                 e->getInlineStyleDecl()->setProperty(CSS_PROP_FLOAT, CSS_VAL_NONE);
365         }
366         if (node == m_lastLeafInserted)
367             break;
368     }
369 }
370
371 void ReplaceSelectionCommand::removeRedundantStyles(Node* mailBlockquoteEnclosingSelectionStart)
372 {
373     // There's usually a top level style span that holds the document's default style, push it down.
374     Node* node = m_firstNodeInserted.get();
375     if (isStyleSpan(node) && mailBlockquoteEnclosingSelectionStart) {
376         // Calculate the document default style.
377         RefPtr<CSSMutableStyleDeclaration> blockquoteStyle = Position(mailBlockquoteEnclosingSelectionStart, 0).computedStyle()->copyInheritableProperties();
378         RefPtr<CSSMutableStyleDeclaration> spanStyle = static_cast<HTMLElement*>(node)->inlineStyleDecl();
379         spanStyle->merge(blockquoteStyle.get());  
380     }
381     
382     // Compute and save the non-redundant styles for all HTML elements.
383     // Don't do any mutation here, because that would cause the diffs to trigger layouts.
384     Vector<RefPtr<CSSMutableStyleDeclaration> > styles;
385     Vector<RefPtr<HTMLElement> > elements;
386     for (node = m_firstNodeInserted.get(); node; node = node->traverseNextNode()) {
387         if (node->isHTMLElement() && isStyleSpan(node)) {
388             elements.append(static_cast<HTMLElement*>(node));
389             
390             RefPtr<CSSMutableStyleDeclaration> parentStyle = computedStyle(node->parentNode())->copyInheritableProperties();
391             RefPtr<CSSMutableStyleDeclaration> style = computedStyle(node)->copyInheritableProperties();
392             parentStyle->diff(style.get());
393             
394             styles.append(style.release());
395         }
396         if (node == m_lastLeafInserted)
397             break;
398     }
399     
400     size_t count = styles.size();
401     for (size_t i = 0; i < count; ++i) {
402         HTMLElement* element = elements[i].get();
403
404         // Handle case where the element was already removed by earlier processing.
405         // It's possible this no longer occurs, but it did happen in an earlier version
406         // that processed elements in a less-determistic order, and I can't prove it
407         // does not occur.
408         if (!element->inDocument())
409             continue;
410
411         // Remove empty style spans.
412         if (isStyleSpan(element) && !element->hasChildNodes()) {
413             if (m_firstNodeInserted == m_lastLeafInserted && m_firstNodeInserted == element)
414                 m_firstNodeInserted = 0;
415             if (m_firstNodeInserted == element)
416                 m_firstNodeInserted = element->traverseNextSibling();
417             if (m_lastLeafInserted == element)
418                 m_lastLeafInserted = element->traverseNextSibling();
419             removeNodeAndPruneAncestors(element);
420             continue;
421         }
422
423         // Remove redundant style tags and style spans.
424         CSSMutableStyleDeclaration* style = styles[i].get();
425         if (style->length() == 0
426                 && (isStyleSpan(element)
427                     || element->hasTagName(bTag)
428                     || element->hasTagName(fontTag)
429                     || element->hasTagName(iTag)
430                     || element->hasTagName(uTag))) {
431             removeNodePreservingChildren(element);
432             continue;
433         }
434
435         // Clear redundant styles from elements.
436         CSSMutableStyleDeclaration* inlineStyleDecl = element->inlineStyleDecl();
437         if (inlineStyleDecl) {
438             CSSComputedStyleDeclaration::removeComputedInheritablePropertiesFrom(inlineStyleDecl);
439             inlineStyleDecl->merge(style, true);
440             setNodeAttribute(element, styleAttr, inlineStyleDecl->cssText());
441         }
442     }
443 }
444
445 void ReplaceSelectionCommand::handlePasteAsQuotationNode()
446 {
447     Node* node = m_firstNodeInserted.get();
448     if (isMailPasteAsQuotationNode(node))
449         static_cast<Element*>(node)->setAttribute(classAttr, "");
450 }
451
452 VisiblePosition ReplaceSelectionCommand::positionAtEndOfInsertedContent()
453 {
454     Node* lastNode = m_lastLeafInserted.get();
455     Node* enclosingSelect = enclosingNodeWithTag(lastNode, selectTag);
456     if (enclosingSelect)
457         lastNode = enclosingSelect;
458     return VisiblePosition(Position(lastNode, maxDeepOffset(lastNode)));
459 }
460
461 VisiblePosition ReplaceSelectionCommand::positionAtStartOfInsertedContent()
462 {
463     // Return the inserted content's first VisiblePosition.
464     return VisiblePosition(nextCandidate(positionBeforeNode(m_firstNodeInserted.get())));
465 }
466
467 void ReplaceSelectionCommand::doApply()
468 {
469     Selection selection = endingSelection();
470     ASSERT(selection.isCaretOrRange());
471     ASSERT(selection.start().node());
472     if (selection.isNone() || !selection.start().node())
473         return;
474     
475     bool selectionIsPlainText = !selection.isContentRichlyEditable();
476     if (selectionIsPlainText)
477         m_matchStyle = true;
478     
479     Element* currentRoot = selection.rootEditableElement();
480     ReplacementFragment fragment(document(), m_documentFragment.get(), m_matchStyle, selection);
481     
482     if (m_matchStyle)
483         m_insertionStyle = styleAtPosition(selection.start());
484     
485     VisiblePosition visibleStart = selection.visibleStart();
486     VisiblePosition visibleEnd = selection.visibleEnd();
487     
488     bool selectionEndWasEndOfParagraph = isEndOfParagraph(visibleEnd);
489     bool selectionStartWasStartOfParagraph = isStartOfParagraph(visibleStart);
490     Node* mailBlockquoteEnclosingSelectionStart = nearestMailBlockquote(visibleStart.deepEquivalent().node());
491     
492     Node* startBlock = enclosingBlock(visibleStart.deepEquivalent().node());
493     
494     if (selectionStartWasStartOfParagraph && selectionEndWasEndOfParagraph ||
495         startBlock == currentRoot ||
496         startBlock && startBlock->renderer() && startBlock->renderer()->isListItem() ||
497         selectionIsPlainText)
498         m_preventNesting = false;
499     
500     Position insertionPos = selection.start();
501     
502     if (selection.isRange()) {
503         // When the end of the selection being pasted into is at the end of a paragraph, and that selection
504         // spans multiple blocks, not merging may leave an empty line.
505         // When the start of the selection being pasted into is at the start of a block, not merging 
506         // will leave hanging block(s).
507         bool mergeBlocksAfterDelete = isEndOfParagraph(visibleEnd) || isStartOfBlock(visibleStart);
508         // FIXME: We should only expand to include fully selected special elements if we are copying a 
509         // selection and pasting it on top of itself.
510         deleteSelection(false, mergeBlocksAfterDelete, true, false);
511         visibleStart = endingSelection().visibleStart();
512         if (fragment.hasInterchangeNewlineAtStart()) {
513             if (isEndOfParagraph(visibleStart) && !isStartOfParagraph(visibleStart)) {
514                 if (!isEndOfDocument(visibleStart))
515                     setEndingSelection(visibleStart.next());
516             } else
517                 insertParagraphSeparator();
518         }
519         insertionPos = endingSelection().start();
520     } else {
521         ASSERT(selection.isCaret());
522         if (fragment.hasInterchangeNewlineAtStart()) {
523             VisiblePosition next = visibleStart.next(true);
524             if (isEndOfParagraph(visibleStart) && !isStartOfParagraph(visibleStart) && next.isNotNull())
525                 setEndingSelection(next);
526             else 
527                 insertParagraphSeparator();
528         }
529         // We split the current paragraph in two to avoid nesting the blocks from the fragment inside the current block.
530         // For example paste <div>foo</div><div>bar</div><div>baz</div> into <div>x^x</div>, where ^ is the caret.  
531         // As long as the  div styles are the same, visually you'd expect: <div>xbar</div><div>bar</div><div>bazx</div>, 
532         // not <div>xbar<div>bar</div><div>bazx</div></div>
533         if (m_preventNesting && !isEndOfParagraph(visibleStart) && !isStartOfParagraph(visibleStart)) {
534             insertParagraphSeparator();
535             setEndingSelection(endingSelection().visibleStart().previous());
536         }
537         insertionPos = endingSelection().start();
538     }
539     
540     // Inserting content could cause whitespace to collapse, e.g. inserting <div>foo</div> into hello^ world.
541     prepareWhitespaceAtPositionForSplit(insertionPos);
542     
543     // NOTE: This would be an incorrect usage of downstream() if downstream() were changed to mean the last position after 
544     // p that maps to the same visible position as p (since in the case where a br is at the end of a block and collapsed 
545     // away, there are positions after the br which map to the same visible position as [br, 0]).  
546     Node* endBR = insertionPos.downstream().node()->hasTagName(brTag) ? insertionPos.downstream().node() : 0;
547     
548     startBlock = enclosingBlock(insertionPos.node());
549     
550     // Adjust insertionPos to prevent nesting.
551     if (m_preventNesting && startBlock) {
552         ASSERT(startBlock != currentRoot);
553         VisiblePosition visibleInsertionPos(insertionPos);
554         if (isEndOfBlock(visibleInsertionPos) && !(isStartOfBlock(visibleInsertionPos) && fragment.hasInterchangeNewlineAtEnd()))
555             insertionPos = positionAfterNode(startBlock);
556         else if (isStartOfBlock(visibleInsertionPos))
557             insertionPos = positionBeforeNode(startBlock);
558     }
559
560     // Paste into run of tabs splits the tab span.
561     insertionPos = positionOutsideTabSpan(insertionPos);
562     
563     // Paste at start or end of link goes outside of link.
564     insertionPos = positionAvoidingSpecialElementBoundary(insertionPos);
565
566     Frame *frame = document()->frame();
567     
568     // FIXME: Improve typing style.
569     // See this bug: <rdar://problem/3769899> Implementation of typing style needs improvement
570     frame->clearTypingStyle();
571     setTypingStyle(0);    
572     
573     // Remove the top level style span if its unnecessary before inserting it into the document, its faster.
574     RefPtr<CSSMutableStyleDeclaration> styleAtInsertionPos = insertionPos.computedStyle()->copyInheritableProperties();
575     if (isStyleSpan(fragment.firstChild())) {
576         Node* styleSpan = fragment.firstChild();
577         String styleText = static_cast<Element*>(styleSpan)->getAttribute(styleAttr);
578         if (styleText == styleAtInsertionPos->cssText())
579             fragment.removeNodePreservingChildren(styleSpan);
580     }
581     
582     // We're finished if there is nothing to add.
583     if (fragment.isEmpty() || !fragment.firstChild())
584         return;
585     
586     // 1) Insert the content.
587     // 2) Remove redundant styles and style tags, this inner <b> for example: <b>foo <b>bar</b> baz</b>.
588     // 3) Merge the start of the added content with the content before the position being pasted into.
589     // 4) Do one of the following: a) expand the last br if the fragment ends with one and it collapsed,
590     // b) merge the last paragraph of the incoming fragment with the paragraph that contained the 
591     // end of the selection that was pasted into, or c) handle an interchange newline at the end of the 
592     // incoming fragment.
593     // 5) Add spaces for smart replace.
594     // 6) Select the replacement if requested, and match style if requested.
595     
596     VisiblePosition startOfInsertedContent, endOfInsertedContent;
597     
598     RefPtr<Node> refNode = fragment.firstChild();
599     RefPtr<Node> node = refNode->nextSibling();
600     
601     fragment.removeNode(refNode);
602     insertNodeAtAndUpdateNodesInserted(refNode.get(), insertionPos);
603     
604     while (node) {
605         Node* next = node->nextSibling();
606         fragment.removeNode(node);
607         insertNodeAfterAndUpdateNodesInserted(node.get(), refNode.get());
608         refNode = node;
609         node = next;
610     }
611     
612     negateStyleRulesThatAffectAppearance();
613     
614     removeRedundantStyles(mailBlockquoteEnclosingSelectionStart);
615     
616     if (!m_firstNodeInserted)
617         return;
618     
619     endOfInsertedContent = positionAtEndOfInsertedContent();
620     startOfInsertedContent = positionAtStartOfInsertedContent();
621     
622     // We inserted before the startBlock to prevent nesting, and the content before the startBlock wasn't in its own block and
623     // didn't have a br after it, so the inserted content ended up in the same paragraph.
624     if (startBlock && insertionPos.node() == startBlock->parentNode() && (unsigned)insertionPos.offset() < startBlock->nodeIndex() && !isStartOfParagraph(startOfInsertedContent))
625         insertNodeAt(createBreakElement(document()).get(), startOfInsertedContent.deepEquivalent());
626     
627     Position lastPositionToSelect;
628     
629     bool interchangeNewlineAtEnd = fragment.hasInterchangeNewlineAtEnd();
630
631     if (shouldRemoveEndBR(endBR))
632         removeNodeAndPruneAncestors(endBR);
633         
634     if (shouldMergeStart(selectionStartWasStartOfParagraph, fragment.hasInterchangeNewlineAtStart())) {
635         // Bail to avoid infinite recursion.
636         if (m_movingParagraph) {
637             ASSERT_NOT_REACHED();
638             return;
639         }
640         VisiblePosition destination = startOfInsertedContent.previous();
641         VisiblePosition startOfParagraphToMove = startOfInsertedContent;
642         
643         // FIXME: Maintain positions for the start and end of inserted content instead of keeping nodes.  The nodes are
644         // only ever used to create positions where inserted content starts/ends.
645         moveParagraph(startOfParagraphToMove, endOfParagraph(startOfParagraphToMove), destination);
646         m_firstNodeInserted = endingSelection().visibleStart().deepEquivalent().downstream().node();
647         if (!m_lastLeafInserted->inDocument())
648             m_lastLeafInserted = endingSelection().visibleEnd().deepEquivalent().upstream().node();
649     }
650             
651     endOfInsertedContent = positionAtEndOfInsertedContent();
652     startOfInsertedContent = positionAtStartOfInsertedContent();
653     
654     if (interchangeNewlineAtEnd) {
655         VisiblePosition next = endOfInsertedContent.next(true);
656
657         if (selectionEndWasEndOfParagraph || !isEndOfParagraph(endOfInsertedContent) || next.isNull()) {
658             if (!isStartOfParagraph(endOfInsertedContent)) {
659                 setEndingSelection(endOfInsertedContent);
660                 // Use a default paragraph element (a plain div) for the empty paragraph, using the last paragraph
661                 // block's style seems to annoy users.
662                 insertParagraphSeparator(true);
663
664                 // Select up to the paragraph separator that was added.
665                 lastPositionToSelect = endingSelection().visibleStart().deepEquivalent();
666                 updateNodesInserted(lastPositionToSelect.node());
667             }
668         } else {
669             // Select up to the beginning of the next paragraph.
670             lastPositionToSelect = next.deepEquivalent().downstream();
671         }
672             
673     } else if (shouldMergeEnd(selectionEndWasEndOfParagraph)) {
674         // Bail to avoid infinite recursion.
675         if (m_movingParagraph) {
676             ASSERT_NOT_REACHED();
677             return;
678         }
679         // Merging two paragraphs will destroy the moved one's block styles.  Always move forward to preserve
680         // the block style of the paragraph already in the document, unless the paragraph to move would include the
681         // what was the start of the selection that was pasted into.
682         bool mergeForward = !inSameParagraph(startOfInsertedContent, endOfInsertedContent) || isStartOfParagraph(startOfInsertedContent);
683         
684         VisiblePosition destination = mergeForward ? endOfInsertedContent.next() : endOfInsertedContent;
685         VisiblePosition startOfParagraphToMove = mergeForward ? startOfParagraph(endOfInsertedContent) : endOfInsertedContent.next();
686
687         moveParagraph(startOfParagraphToMove, endOfParagraph(startOfParagraphToMove), destination);
688         // Merging forward will remove m_lastLeafInserted from the document.
689         // FIXME: Maintain positions for the start and end of inserted content instead of keeping nodes.  The nodes are
690         // only ever used to create positions where inserted content starts/ends.
691         if (mergeForward) {
692             m_lastLeafInserted = destination.previous().deepEquivalent().node();
693             if (!m_firstNodeInserted->inDocument())
694                 m_firstNodeInserted = endingSelection().visibleStart().deepEquivalent().node();
695         }
696     }
697     
698     handlePasteAsQuotationNode();
699     
700     endOfInsertedContent = positionAtEndOfInsertedContent();
701     startOfInsertedContent = positionAtStartOfInsertedContent();
702     
703     // Add spaces for smart replace.
704     if (m_smartReplace && currentRoot) {
705         // Disable smart replace for password fields.
706         Node* start = currentRoot->shadowAncestorNode();
707         if (start->hasTagName(inputTag) && static_cast<HTMLInputElement*>(start)->inputType() == HTMLInputElement::PASSWORD)
708             m_smartReplace = false;
709     }
710     if (m_smartReplace) {
711         bool needsTrailingSpace = !isEndOfParagraph(endOfInsertedContent) &&
712                                   !isCharacterSmartReplaceExempt(endOfInsertedContent.characterAfter(), false);
713         if (needsTrailingSpace) {
714             RenderObject* renderer = m_lastLeafInserted->renderer();
715             bool collapseWhiteSpace = !renderer || renderer->style()->collapseWhiteSpace();
716             Node* endNode = positionAtEndOfInsertedContent().deepEquivalent().upstream().node();
717             if (endNode->isTextNode()) {
718                 Text* text = static_cast<Text*>(endNode);
719                 insertTextIntoNode(text, text->length(), collapseWhiteSpace ? nonBreakingSpaceString() : " ");
720             } else {
721                 RefPtr<Node> node = document()->createEditingTextNode(collapseWhiteSpace ? nonBreakingSpaceString() : " ");
722                 insertNodeAfterAndUpdateNodesInserted(node.get(), endNode);
723             }
724         }
725     
726         bool needsLeadingSpace = !isStartOfParagraph(startOfInsertedContent) &&
727                                  !isCharacterSmartReplaceExempt(startOfInsertedContent.previous().characterAfter(), true);
728         if (needsLeadingSpace) {
729             RenderObject* renderer = m_lastLeafInserted->renderer();
730             bool collapseWhiteSpace = !renderer || renderer->style()->collapseWhiteSpace();
731             Node* startNode = positionAtStartOfInsertedContent().deepEquivalent().downstream().node();
732             if (startNode->isTextNode()) {
733                 Text* text = static_cast<Text*>(startNode);
734                 insertTextIntoNode(text, 0, collapseWhiteSpace ? nonBreakingSpaceString() : " ");
735             } else {
736                 RefPtr<Node> node = document()->createEditingTextNode(collapseWhiteSpace ? nonBreakingSpaceString() : " ");
737                 // Don't updateNodesInserted.  Doing so would set m_lastLeafInserted to be the node containing the 
738                 // leading space, but m_lastLeafInserted is supposed to mark the end of pasted content.
739                 insertNodeBefore(node.get(), startNode);
740                 // FIXME: Use positions to track the start/end of inserted content.
741                 m_firstNodeInserted = node;
742             }
743         }
744     }
745     
746     completeHTMLReplacement(lastPositionToSelect);
747 }
748
749 bool ReplaceSelectionCommand::shouldRemoveEndBR(Node* endBR)
750 {
751     if (!endBR || !endBR->inDocument())
752         return false;
753         
754     VisiblePosition visiblePos(Position(endBR, 0));
755     
756     return
757         // The br is collapsed away and so is unnecessary.
758         !document()->inStrictMode() && isEndOfBlock(visiblePos) && !isStartOfParagraph(visiblePos) ||
759         // A br that was originally holding a line open should be displaced by inserted content or turned into a line break.
760         // A br that was originally acting as a line break should still be acting as a line break, not as a placeholder.
761         isStartOfParagraph(visiblePos) && isEndOfParagraph(visiblePos);
762 }
763
764 void ReplaceSelectionCommand::completeHTMLReplacement(const Position &lastPositionToSelect)
765 {
766     Position start;
767     Position end;
768
769     // FIXME: This should never not be the case.
770     if (m_firstNodeInserted && m_firstNodeInserted->inDocument() && m_lastLeafInserted && m_lastLeafInserted->inDocument()) {
771         
772         start = positionAtStartOfInsertedContent().deepEquivalent();
773         end = positionAtEndOfInsertedContent().deepEquivalent();
774         
775         // FIXME (11475): Remove this and require that the creator of the fragment to use nbsps.
776         rebalanceWhitespaceAt(start);
777         rebalanceWhitespaceAt(end);
778
779         if (m_matchStyle) {
780             ASSERT(m_insertionStyle);
781             applyStyle(m_insertionStyle.get(), start, end);
782         }    
783         
784         if (lastPositionToSelect.isNotNull())
785             end = lastPositionToSelect;
786     } else if (lastPositionToSelect.isNotNull())
787         start = end = lastPositionToSelect;
788     else
789         return;
790     
791     if (m_selectReplacement)
792         setEndingSelection(Selection(start, end, SEL_DEFAULT_AFFINITY));
793     else
794         setEndingSelection(Selection(end, SEL_DEFAULT_AFFINITY));
795 }
796
797 EditAction ReplaceSelectionCommand::editingAction() const
798 {
799     return m_editAction;
800 }
801
802 void ReplaceSelectionCommand::insertNodeAfterAndUpdateNodesInserted(Node *insertChild, Node *refChild)
803 {
804     insertNodeAfter(insertChild, refChild);
805     updateNodesInserted(insertChild);
806 }
807
808 void ReplaceSelectionCommand::insertNodeAtAndUpdateNodesInserted(Node *insertChild, const Position& p)
809 {
810     insertNodeAt(insertChild, p);
811     updateNodesInserted(insertChild);
812 }
813
814 void ReplaceSelectionCommand::insertNodeBeforeAndUpdateNodesInserted(Node *insertChild, Node *refChild)
815 {
816     insertNodeBefore(insertChild, refChild);
817     updateNodesInserted(insertChild);
818 }
819
820 void ReplaceSelectionCommand::updateNodesInserted(Node *node)
821 {
822     if (!node)
823         return;
824
825     if (!m_firstNodeInserted)
826         m_firstNodeInserted = node;
827     
828     if (node == m_lastLeafInserted)
829         return;
830     
831     m_lastLeafInserted = node->lastDescendant();
832 }
833
834 } // namespace WebCore