LayoutTests:
[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 "Document.h"
34 #include "DocumentFragment.h"
35 #include "EditingText.h"
36 #include "Element.h"
37 #include "Frame.h"
38 #include "HTMLElement.h"
39 #include "HTMLInterchange.h"
40 #include "HTMLNames.h"
41 #include "SelectionController.h"
42 #include "TextIterator.h"
43 #include "htmlediting.h"
44 #include "markup.h"
45 #include "visible_units.h"
46
47 namespace WebCore {
48
49 using namespace HTMLNames;
50
51 ReplacementFragment::ReplacementFragment(Document *document, DocumentFragment *fragment, bool matchStyle, Element* editableRoot)
52     : m_document(document),
53       m_fragment(fragment),
54       m_matchStyle(matchStyle), 
55       m_hasInterchangeNewlineAtStart(false), 
56       m_hasInterchangeNewlineAtEnd(false), 
57       m_hasMoreThanOneBlock(false)
58 {
59     if (!m_document)
60         return;
61
62     if (!m_fragment) {
63         m_type = EmptyFragment;
64         return;
65     }
66
67     Node* firstChild = m_fragment->firstChild();
68     Node* lastChild = m_fragment->lastChild();
69
70     if (!firstChild) {
71         m_type = EmptyFragment;
72         return;
73     }
74     
75     m_type = firstChild == lastChild && firstChild->isTextNode() ? SingleTextNodeFragment : TreeFragment;
76     
77     ASSERT(editableRoot);
78     if (!editableRoot)
79         return;
80             
81     RefPtr<Node> holder = insertFragmentForTestRendering();
82     
83     RefPtr<Range> range = Selection::selectionFromContentsOfNode(holder.get()).toRange();
84     String text = plainText(range.get());
85     // Give the root a chance to change the text.
86     RefPtr<BeforeTextInsertedEvent> evt = new BeforeTextInsertedEvent(text);
87     ExceptionCode ec = 0;
88     editableRoot->dispatchEvent(evt, ec, true);
89     ASSERT(ec == 0);
90     if (text != evt->text() || !editableRoot->isContentRichlyEditable()) {
91         // If the root is in plain-text mode, and white-space shouldn't be collapsed, then contruct a fragment that contains one text node
92         if (!editableRoot->isContentRichlyEditable() && editableRoot->renderer() && !editableRoot->renderer()->style()->collapseWhiteSpace()) {
93             RefPtr<DocumentFragment> fragment = document->createDocumentFragment();
94             fragment->appendChild(document->createTextNode(evt->text()), ec);
95             ASSERT(ec == 0);
96             m_fragment = fragment;
97         } else
98             m_fragment = createFragmentFromText(document, evt->text().deprecatedString());
99         firstChild = m_fragment->firstChild();
100         lastChild = m_fragment->firstChild();
101         
102         removeNode(holder);
103         holder = insertFragmentForTestRendering();
104     }
105     
106     Node *node = firstChild;
107     Node *newlineAtStartNode = 0;
108     Node *newlineAtEndNode = 0;
109     while (node) {
110         Node *next = node->traverseNextNode();
111         if (isInterchangeNewlineNode(node)) {
112             if (next || node == firstChild) {
113                 m_hasInterchangeNewlineAtStart = true;
114                 newlineAtStartNode = node;
115             }
116             else {
117                 m_hasInterchangeNewlineAtEnd = true;
118                 newlineAtEndNode = node;
119             }
120         }
121         else if (isInterchangeConvertedSpaceSpan(node)) {
122             RefPtr<Node> n = 0;
123             while ((n = node->firstChild())) {
124                 removeNode(n);
125                 insertNodeBefore(n.get(), node);
126             }
127             removeNode(node);
128             if (n)
129                 next = n->traverseNextNode();
130         }
131         node = next;
132     }
133
134     if (newlineAtStartNode)
135         removeNode(newlineAtStartNode);
136     if (newlineAtEndNode)
137         removeNode(newlineAtEndNode);
138     
139     saveRenderingInfo(holder.get());
140     removeUnrenderedNodes(holder.get());
141     m_hasMoreThanOneBlock = renderedBlocks(holder.get()) > 1;
142     restoreTestRenderingNodesToFragment(holder.get());
143     removeNode(holder);
144     removeStyleNodes();
145 }
146
147 ReplacementFragment::~ReplacementFragment()
148 {
149 }
150
151 Node *ReplacementFragment::firstChild() const 
152
153     return m_fragment->firstChild(); 
154 }
155
156 Node *ReplacementFragment::lastChild() const 
157
158     return m_fragment->lastChild(); 
159 }
160
161 static bool isMailPasteAsQuotationNode(const Node *node)
162 {
163     return node && static_cast<const Element *>(node)->getAttribute("class") == ApplePasteAsQuotation;
164 }
165
166 Node *ReplacementFragment::mergeStartNode() const
167 {
168     Node *node = m_fragment->firstChild();
169     while (node && isBlockFlow(node) && !isMailPasteAsQuotationNode(node))
170         node = node->traverseNextNode();
171     return node;
172 }
173
174 bool ReplacementFragment::isInterchangeNewlineNode(const Node *node)
175 {
176     static String interchangeNewlineClassString(AppleInterchangeNewline);
177     return node && node->hasTagName(brTag) && 
178            static_cast<const Element *>(node)->getAttribute(classAttr) == interchangeNewlineClassString;
179 }
180
181 bool ReplacementFragment::isInterchangeConvertedSpaceSpan(const Node *node)
182 {
183     static String convertedSpaceSpanClassString(AppleConvertedSpace);
184     return node->isHTMLElement() && 
185            static_cast<const HTMLElement *>(node)->getAttribute(classAttr) == convertedSpaceSpanClassString;
186 }
187
188 Node *ReplacementFragment::enclosingBlock(Node *node) const
189 {
190     while (node && !isBlockFlow(node))
191         node = node->parentNode();    
192     return node ? node : m_fragment.get();
193 }
194
195 void ReplacementFragment::removeNodePreservingChildren(Node *node)
196 {
197     if (!node)
198         return;
199
200     while (RefPtr<Node> n = node->firstChild()) {
201         removeNode(n);
202         insertNodeBefore(n.get(), node);
203     }
204     removeNode(node);
205 }
206
207 void ReplacementFragment::removeNode(PassRefPtr<Node> node)
208 {
209     if (!node)
210         return;
211     
212     Node *parent = node->parentNode();
213     if (!parent)
214         return;
215     
216     ExceptionCode ec = 0;
217     parent->removeChild(node.get(), ec);
218     ASSERT(ec == 0);
219 }
220
221 void ReplacementFragment::insertNodeBefore(Node *node, Node *refNode)
222 {
223     if (!node || !refNode)
224         return;
225         
226     Node *parent = refNode->parentNode();
227     if (!parent)
228         return;
229         
230     ExceptionCode ec = 0;
231     parent->insertBefore(node, refNode, ec);
232     ASSERT(ec == 0);
233 }
234
235 PassRefPtr<Node> ReplacementFragment::insertFragmentForTestRendering()
236 {
237     Node *body = m_document->body();
238     if (!body)
239         return 0;
240
241     RefPtr<Node> holder = createDefaultParagraphElement(m_document.get());
242     
243     ExceptionCode ec = 0;
244     holder->appendChild(m_fragment, ec);
245     ASSERT(ec == 0);
246     
247     body->appendChild(holder.get(), ec);
248     ASSERT(ec == 0);
249     
250     m_document->updateLayoutIgnorePendingStylesheets();
251     
252     return holder.release();
253 }
254
255 void ReplacementFragment::restoreTestRenderingNodesToFragment(Node *holder)
256 {
257     if (!holder)
258         return;
259     
260     ExceptionCode ec = 0;
261     while (RefPtr<Node> node = holder->firstChild()) {
262         holder->removeChild(node.get(), ec);
263         ASSERT(ec == 0);
264         m_fragment->appendChild(node.get(), ec);
265         ASSERT(ec == 0);
266     }
267 }
268
269 bool ReplacementFragment::isBlockFlow(Node* node) const
270 {
271     RefPtr<RenderingInfo> info = m_renderingInfo.get(node);
272     ASSERT(info);
273     if (!info)
274         return false;
275     
276     return info->isBlockFlow();
277 }
278
279 static String &matchNearestBlockquoteColorString()
280 {
281     static String matchNearestBlockquoteColorString = "match";
282     return matchNearestBlockquoteColorString;
283 }
284
285 void ReplaceSelectionCommand::fixupNodeStyles(const NodeVector& nodes, const RenderingInfoMap& renderingInfo)
286 {
287     // This function uses the mapped "desired style" to apply the additional style needed, if any,
288     // to make the node have the desired style.
289
290     updateLayout();
291     
292     NodeVector::const_iterator e = nodes.end();
293     for (NodeVector::const_iterator it = nodes.begin(); it != e; ++it) {
294         Node *node = (*it).get();
295         RefPtr<RenderingInfo> info = renderingInfo.get(node);
296         ASSERT(info);
297         if (!info)
298             continue;
299         CSSMutableStyleDeclaration *desiredStyle = info->style();
300         ASSERT(desiredStyle);
301
302         if (!node->inDocument())
303             continue;
304
305         // The desiredStyle declaration tells what style this node wants to be.
306         // Compare that to the style that it is right now in the document.
307         Position pos(node, 0);
308         RefPtr<CSSComputedStyleDeclaration> currentStyle = pos.computedStyle();
309
310         // Check for the special "match nearest blockquote color" property and resolve to the correct
311         // color if necessary.
312         String matchColorCheck = desiredStyle->getPropertyValue(CSS_PROP__WEBKIT_MATCH_NEAREST_MAIL_BLOCKQUOTE_COLOR);
313         if (matchColorCheck == matchNearestBlockquoteColorString()) {
314             Node *blockquote = nearestMailBlockquote(node);
315             Position pos(blockquote ? blockquote : node->document()->documentElement(), 0);
316             RefPtr<CSSComputedStyleDeclaration> style = pos.computedStyle();
317             String desiredColor = desiredStyle->getPropertyValue(CSS_PROP_COLOR);
318             String nearestColor = style->getPropertyValue(CSS_PROP_COLOR);
319             if (desiredColor != nearestColor)
320                 desiredStyle->setProperty(CSS_PROP_COLOR, nearestColor);
321         }
322         desiredStyle->removeProperty(CSS_PROP__WEBKIT_MATCH_NEAREST_MAIL_BLOCKQUOTE_COLOR);
323
324         currentStyle->diff(desiredStyle);
325         
326         // Only add in block properties if the node is at the start of a 
327         // paragraph. This matches AppKit.
328         if (!isStartOfParagraph(VisiblePosition(pos, DOWNSTREAM)))
329             desiredStyle->removeBlockProperties();
330         
331         // If the desiredStyle is non-zero length, that means the current style differs
332         // from the desired by the styles remaining in the desiredStyle declaration.
333         if (desiredStyle->length() > 0)
334             applyStyle(desiredStyle, Position(node, 0), Position(node, maxDeepOffset(node)));
335     }
336 }
337
338 static PassRefPtr<CSSMutableStyleDeclaration> styleForNode(Node *node)
339 {
340     if (!node || !node->inDocument())
341         return 0;
342         
343     RefPtr<CSSComputedStyleDeclaration> computedStyle = Position(node, 0).computedStyle();
344     RefPtr<CSSMutableStyleDeclaration> style = computedStyle->copyInheritableProperties();
345
346     // In either of the color-matching tests below, set the color to a pseudo-color that will
347     // make the content take on the color of the nearest-enclosing blockquote (if any) after
348     // being pasted in.
349     if (Node *blockquote = nearestMailBlockquote(node)) {
350         RefPtr<CSSComputedStyleDeclaration> blockquoteStyle = Position(blockquote, 0).computedStyle();
351         bool match = (blockquoteStyle->getPropertyValue(CSS_PROP_COLOR) == style->getPropertyValue(CSS_PROP_COLOR));
352         if (match) {
353             style->setProperty(CSS_PROP__WEBKIT_MATCH_NEAREST_MAIL_BLOCKQUOTE_COLOR, matchNearestBlockquoteColorString());
354             return style.release();
355         }
356     }
357     Node *documentElement = node->document()->documentElement();
358     RefPtr<CSSComputedStyleDeclaration> documentStyle = Position(documentElement, 0).computedStyle();
359     bool match = (documentStyle->getPropertyValue(CSS_PROP_COLOR) == style->getPropertyValue(CSS_PROP_COLOR));
360     if (match)
361         style->setProperty(CSS_PROP__WEBKIT_MATCH_NEAREST_MAIL_BLOCKQUOTE_COLOR, matchNearestBlockquoteColorString());
362         
363     return style.release();
364 }
365
366 void ReplacementFragment::saveRenderingInfo(Node *holder)
367 {
368     m_document->updateLayoutIgnorePendingStylesheets();
369     
370     if (m_matchStyle) {
371         // No style restoration will be done, so we don't need to save styles or keep a node vector.
372         for (Node *node = holder->firstChild(); node; node = node->traverseNextNode(holder))
373             m_renderingInfo.add(node, new RenderingInfo(0, node->isBlockFlow()));
374     } else {
375         for (Node *node = holder->firstChild(); node; node = node->traverseNextNode(holder)) {
376             m_renderingInfo.add(node, new RenderingInfo(styleForNode(node), node->isBlockFlow()));
377             m_nodes.append(node);
378         }
379     }
380 }
381
382 void ReplacementFragment::removeUnrenderedNodes(Node *holder)
383 {
384     DeprecatedPtrList<Node> unrendered;
385
386     for (Node *node = holder->firstChild(); node; node = node->traverseNextNode(holder)) {
387         if (!isNodeRendered(node) && !isTableStructureNode(node))
388             unrendered.append(node);
389     }
390
391     for (DeprecatedPtrListIterator<Node> it(unrendered); it.current(); ++it)
392         removeNode(it.current());
393 }
394
395 // FIXME: This counts two blocks for <span><div>foo</div></span>.  Get rid of uses of hasMoreThanOneBlock so that we can get rid of this function.
396 int ReplacementFragment::renderedBlocks(Node *holder)
397 {
398     int count = 0;
399     Node *prev = 0;
400     for (Node *node = holder->firstChild(); node; node = node->traverseNextNode(holder)) {
401         if (node->isBlockFlow()) {
402             if (!prev) {
403                 count++;
404                 prev = node;
405             }
406         } else {
407             Node *block = node->enclosingBlockFlowElement();
408             if (block != prev) {
409                 count++;
410                 prev = block;
411             }
412         }
413     }
414     
415     return count;
416 }
417
418 void ReplacementFragment::removeStyleNodes()
419 {
420     // Since style information has been computed and cached away in
421     // computeStylesUsingTestRendering(), these style nodes can be removed, since
422     // the correct styles will be added back in fixupNodeStyles().
423     Node *node = m_fragment->firstChild();
424     while (node) {
425         Node *next = node->traverseNextNode();
426         // This list of tags change the appearance of content
427         // in ways we can add back on later with CSS, if necessary.
428         //  FIXME: This list is incomplete
429         if (node->hasTagName(bTag) || 
430             node->hasTagName(bigTag) || 
431             node->hasTagName(centerTag) || 
432             node->hasTagName(fontTag) || 
433             node->hasTagName(iTag) || 
434             node->hasTagName(sTag) || 
435             node->hasTagName(smallTag) || 
436             node->hasTagName(strikeTag) || 
437             node->hasTagName(subTag) || 
438             node->hasTagName(supTag) || 
439             node->hasTagName(ttTag) || 
440             node->hasTagName(uTag) || 
441             isStyleSpan(node)) {
442             removeNodePreservingChildren(node);
443         }
444         // need to skip tab span because fixupNodeStyles() is not called
445         // when replace is matching style
446         else if (node->isHTMLElement() && !isTabSpanNode(node)) {
447             HTMLElement *elem = static_cast<HTMLElement *>(node);
448             CSSMutableStyleDeclaration *inlineStyleDecl = elem->inlineStyleDecl();
449             if (inlineStyleDecl) {
450                 inlineStyleDecl->removeBlockProperties();
451                 inlineStyleDecl->removeInheritableProperties();
452             }
453         }
454         node = next;
455     }
456 }
457
458 RenderingInfo::RenderingInfo(PassRefPtr<CSSMutableStyleDeclaration> style, bool isBlockFlow = false)
459     : m_style(style), m_isBlockFlow(isBlockFlow)
460 {
461 }
462
463 ReplaceSelectionCommand::ReplaceSelectionCommand(Document *document, DocumentFragment *fragment, bool selectReplacement, bool smartReplace, bool matchStyle, bool forceMergeStart) 
464     : CompositeEditCommand(document),
465       m_selectReplacement(selectReplacement), 
466       m_smartReplace(smartReplace),
467       m_matchStyle(matchStyle),
468       m_documentFragment(fragment),
469       m_forceMergeStart(forceMergeStart)
470 {
471 }
472
473 ReplaceSelectionCommand::~ReplaceSelectionCommand()
474 {
475 }
476
477 // FIXME: This will soon operate on the fragment after it's been inserted so that it can check renderers and create visible positions.
478 bool ReplaceSelectionCommand::shouldMergeStart(const ReplacementFragment& incomingFragment, const Selection& destinationSelection)
479 {
480     if (m_forceMergeStart)
481         return true;
482         
483     VisiblePosition visibleStart = destinationSelection.visibleStart();
484     Node* startBlock = destinationSelection.start().node()->enclosingBlockFlowElement();
485
486     // <rdar://problem/4013642> Copied quoted word does not paste as a quote if pasted at the start of a line    
487     if (isStartOfParagraph(visibleStart) && isMailBlockquote(incomingFragment.firstChild()))
488         return false;
489     
490     // Don't pull content out of a list item.
491     // FIXMEs: Don't pull content out of a table cell either.
492     if (enclosingList(incomingFragment.mergeStartNode()))
493         return false;
494     
495     // Merge if this is an empty editable subtree, to prevent an extra level of block nesting.
496     if (startBlock == startBlock->rootEditableElement() && isStartOfBlock(visibleStart) && isEndOfBlock(visibleStart))
497         return true;
498     
499     if (!incomingFragment.hasInterchangeNewlineAtStart() && 
500         (!isStartOfParagraph(visibleStart) || !incomingFragment.hasInterchangeNewlineAtEnd() && !incomingFragment.hasMoreThanOneBlock()))
501        return true;
502     
503     return false;
504 }
505
506 bool ReplaceSelectionCommand::shouldMergeEnd(const VisiblePosition& endOfInsertedContent, bool fragmentHadInterchangeNewlineAtEnd, bool selectionEndWasEndOfParagraph)
507 {
508     Node* endNode = endOfInsertedContent.deepEquivalent().node();
509     Node* nextNode = endOfInsertedContent.next().deepEquivalent().node();
510     // FIXME: Unify the naming scheme for these enclosing element getters.
511     return !selectionEndWasEndOfParagraph &&
512            !fragmentHadInterchangeNewlineAtEnd && 
513            isEndOfParagraph(endOfInsertedContent) && 
514            nearestMailBlockquote(endNode) == nearestMailBlockquote(nextNode) &&
515            enclosingListChild(endNode) == enclosingListChild(nextNode) &&
516            enclosingTableCell(endNode) == enclosingTableCell(nextNode) &&
517            !endNode->hasTagName(hrTag);
518 }
519
520 void ReplaceSelectionCommand::doApply()
521 {
522     // collect information about the current selection, prior to deleting the selection
523     Selection selection = endingSelection();
524     ASSERT(selection.isCaretOrRange());
525     ASSERT(selection.start().node());
526     if (selection.isNone() || !selection.start().node())
527         return;
528     
529     if (!selection.isContentRichlyEditable())
530         m_matchStyle = true;
531     
532     Element* currentRoot = selection.rootEditableElement();
533     ReplacementFragment fragment(document(), m_documentFragment.get(), m_matchStyle, currentRoot);
534     
535     if (fragment.type() == EmptyFragment)
536         return;
537     
538     if (m_matchStyle)
539         m_insertionStyle = styleAtPosition(selection.start());
540     
541     VisiblePosition visibleStart(selection.start(), selection.affinity());
542     VisiblePosition visibleEnd(selection.end(), selection.affinity());
543     bool startAtStartOfBlock = isStartOfBlock(visibleStart);
544     Node* startBlock = selection.start().node()->enclosingBlockFlowElement();
545
546     // Whether the first paragraph of the incoming fragment should be merged with content from visibleStart to startOfParagraph(visibleStart).
547     bool mergeStart = shouldMergeStart(fragment, selection);
548     
549     bool endWasEndOfParagraph = isEndOfParagraph(visibleEnd);
550
551     Position startPos = selection.start();
552     
553     // delete the current range selection, or insert paragraph for caret selection, as needed
554     if (selection.isRange()) {
555         // When the end of the selection to delete is at the end of a paragraph, and the selection
556         // to delete spans multiple blocks, not merging will leave an empty line containing the
557         // end of the selection to delete.
558         bool mergeBlocksAfterDelete = !fragment.hasInterchangeNewlineAtEnd() && !fragment.hasInterchangeNewlineAtStart() && isEndOfParagraph(visibleEnd);
559         deleteSelection(false, mergeBlocksAfterDelete);
560         updateLayout();
561         visibleStart = endingSelection().visibleStart();
562         if (fragment.hasInterchangeNewlineAtStart()) {
563             if (isEndOfParagraph(visibleStart) && !isStartOfParagraph(visibleStart)) {
564                 if (!isEndOfDocument(visibleStart))
565                     setEndingSelection(visibleStart.next());
566             } else
567                 insertParagraphSeparator();
568         }
569         startPos = endingSelection().start();
570     } 
571     else {
572         ASSERT(selection.isCaret());
573         if (fragment.hasInterchangeNewlineAtStart()) {
574             if (isEndOfParagraph(visibleStart) && !isStartOfParagraph(visibleStart)) {
575                 if (!isEndOfDocument(visibleStart))
576                     setEndingSelection(visibleStart.next());
577             } else 
578                 insertParagraphSeparator();
579         }
580         // We split the current paragraph in two to avoid nesting the blocks from the fragment inside the current block.
581         // For example paste <div>foo</div><div>bar</div><div>baz</div> into <div>x^x</div>, where ^ is the caret.  
582         // As long as the  div styles are the same, visually you'd expect: <div>xbar</div><div>bar</div><div>bazx</div>, 
583         // not <div>xbar<div>bar</div><div>bazx</div></div>
584         // FIXME: If this code is really about preventing block nesting, then the check should be !isEndOfBlock(visibleStart) and we 
585         // should split the block in two, instead of inserting a paragraph separator. In the meantime, it appears that code below 
586         // depends on this split happening when the paste position is not the start or end of a paragraph.
587         if (!isEndOfParagraph(visibleStart) && !isStartOfParagraph(visibleStart)) {
588             insertParagraphSeparator();
589             setEndingSelection(VisiblePosition(endingSelection().start(), VP_DEFAULT_AFFINITY).previous());
590         }
591         startPos = endingSelection().start();
592     }
593     
594     // NOTE: This would be an incorrect usage of downstream() if downstream() were changed to mean the last position after 
595     // 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 
596     // away, there are positions after the br which map to the same visible position as [br, 0]).  
597     Node* endBR = startPos.downstream().node()->hasTagName(brTag) ? startPos.downstream().node() : 0;
598     
599     if (startAtStartOfBlock && startBlock->inDocument())
600         startPos = Position(startBlock, 0);
601
602     // paste into run of tabs splits the tab span
603     startPos = positionOutsideTabSpan(startPos);
604     
605     // paste at start or end of link goes outside of link
606     startPos = positionAvoidingSpecialElementBoundary(startPos);
607
608     Frame *frame = document()->frame();
609     
610     // FIXME: Improve typing style.
611     // See this bug: <rdar://problem/3769899> Implementation of typing style needs improvement
612     frame->clearTypingStyle();
613     setTypingStyle(0);    
614     
615     // done if there is nothing to add
616     if (!fragment.firstChild())
617         return;
618     
619     // 1) Add the first paragraph of the incoming fragment, merging it with the paragraph that contained the 
620     // start of the selection that was pasted into.
621     // 2) Add everything else.
622     // 3) Restore the styles of inserted nodes (since styles were removed during the test insertion).
623     // 4) Do one of the following: a) if there was a br at the end of the fragment, expand it if it collapsed 
624     // because of quirks mode, b) merge the last paragraph of the incoming fragment with the paragraph that contained the 
625     // end of the selection that was pasted into, or c) handle an interchange newline at the end of the 
626     // incoming fragment.
627     // 5) Add spaces for smart replace.
628     // 6) Select the replacement if requested, and match style if requested.
629         
630     // initially, we say the insertion point is the start of selection
631     updateLayout();
632     Position insertionPos = startPos;
633
634     // Add the first paragraph.
635     if (mergeStart) {
636         RefPtr<Node> refNode = fragment.mergeStartNode();
637         if (refNode) {
638             Node *parent = refNode->parentNode();
639             RefPtr<Node> node = refNode->nextSibling();
640             fragment.removeNode(refNode);
641             insertNodeAtAndUpdateNodesInserted(refNode.get(), startPos.node(), startPos.offset());
642             while (node && !fragment.isBlockFlow(node.get())) {
643                 Node *next = node->nextSibling();
644                 fragment.removeNode(node);
645                 insertNodeAfterAndUpdateNodesInserted(node.get(), refNode.get());
646                 refNode = node;
647                 node = next;
648             }
649
650             // remove any ancestors we emptied, except the root itself which cannot be removed
651             while (parent && parent->parentNode() && parent->childNodeCount() == 0) {
652                 Node *nextParent = parent->parentNode();
653                 fragment.removeNode(parent);
654                 parent = nextParent;
655             }
656         }
657         
658         // update insertion point to be at the end of the last block inserted
659         if (m_lastNodeInserted) {
660             updateLayout();
661             insertionPos = Position(m_lastNodeInserted.get(), m_lastNodeInserted->caretMaxOffset());
662         }
663     }
664     
665     // Add everything else.
666     if (fragment.firstChild()) {
667         RefPtr<Node> refNode = fragment.firstChild();
668         RefPtr<Node> node = refNode ? refNode->nextSibling() : 0;
669         Node* insertionBlock = insertionPos.node()->enclosingBlockFlowElement();
670         Node* insertionRoot = insertionPos.node()->rootEditableElement();
671         bool insertionBlockIsRoot = insertionBlock == insertionRoot;
672         VisiblePosition visibleInsertionPos(insertionPos);
673         fragment.removeNode(refNode);
674         // FIXME: The first two cases need to be rethought.  They're about preventing the nesting of 
675         // incoming blocks in the block where the paste is being performed.  But, avoiding nesting doesn't 
676         // always produce the desired visual result, and the decisions are based on isBlockFlow, which 
677         // we're getting rid of.
678         if (!insertionBlockIsRoot && fragment.isBlockFlow(refNode.get()) && isStartOfBlock(visibleInsertionPos) && !m_lastNodeInserted)
679             insertNodeBeforeAndUpdateNodesInserted(refNode.get(), insertionBlock);
680         else if (!insertionBlockIsRoot && fragment.isBlockFlow(refNode.get()) && isEndOfBlock(visibleInsertionPos))
681             insertNodeAfterAndUpdateNodesInserted(refNode.get(), insertionBlock);
682         else if (m_lastNodeInserted && !fragment.isBlockFlow(refNode.get())) {
683             // A non-null m_lastNodeInserted means we've done merging above.  That means everything in the first paragraph 
684             // of the fragment has been merged with everything up to the start of the paragraph where the paste was performed.  
685             // refNode is the first node in the second paragraph of the fragment to paste.  Since it's inline, we can't 
686             // insert it at insertionPos, because it wouldn't end up in its own paragraph.
687
688             // FIXME: Code above does paragraph splitting and so we are assured that visibleInsertionPos is the end of
689             // a paragraph, but the above splitting should eventually be only about preventing nesting.
690             ASSERT(isEndOfParagraph(visibleInsertionPos));
691             VisiblePosition next = visibleInsertionPos.next();
692             if (next.isNull() || next.rootEditableElement() != insertionRoot) {
693                 setEndingSelection(visibleInsertionPos);
694                 insertParagraphSeparator();
695                 next = visibleInsertionPos.next();
696             }
697             
698             Position pos = next.deepEquivalent().downstream();
699             insertNodeAtAndUpdateNodesInserted(refNode.get(), pos.node(), pos.offset());
700         } else {
701             insertNodeAtAndUpdateNodesInserted(refNode.get(), insertionPos.node(), insertionPos.offset());
702         }
703         
704         while (node) {
705             Node* next = node->nextSibling();
706             fragment.removeNode(node);
707             insertNodeAfterAndUpdateNodesInserted(node.get(), refNode.get());
708             refNode = node;
709             node = next;
710         }
711         updateLayout();
712         insertionPos = Position(m_lastNodeInserted.get(), m_lastNodeInserted->caretMaxOffset());
713     }
714     
715     removeEndBRIfNeeded(endBR);
716     
717     // Styles were removed during the test insertion.  Restore them.
718     if (!m_matchStyle)
719         fixupNodeStyles(fragment.nodes(), fragment.renderingInfo());
720         
721     VisiblePosition endOfInsertedContent(Position(m_lastNodeInserted.get(), maxDeepOffset(m_lastNodeInserted.get())));
722     VisiblePosition startOfInsertedContent(Position(m_firstNodeInserted.get(), 0));    
723     
724     Position lastPositionToSelect;
725     
726     if (fragment.hasInterchangeNewlineAtEnd()) {
727         VisiblePosition pos(insertionPos);
728         VisiblePosition next = pos.next();
729             
730         if (endWasEndOfParagraph || !isEndOfParagraph(pos) || next.isNull() || next.rootEditableElement() != currentRoot) {
731             setEndingSelection(insertionPos, DOWNSTREAM);
732             insertParagraphSeparator();
733             next = pos.next();
734
735             // Select up to the paragraph separator that was added.
736             lastPositionToSelect = next.deepEquivalent().downstream();
737             updateNodesInserted(lastPositionToSelect.node());
738         } else {
739             // Select up to the beginning of the next paragraph.
740             VisiblePosition next = pos.next();
741             lastPositionToSelect = next.deepEquivalent().downstream();
742         }
743         
744     } else if (m_lastNodeInserted->hasTagName(brTag)) {
745         // We want to honor the last incoming line break, so, if it will collapse away because of quirks mode, 
746         // add an extra one.
747         // FIXME: This will expand a br inside a block: <div><br></div>
748         // FIXME: Should we expand all incoming brs that collapse because of quirks mode?
749         if (!document()->inStrictMode() && isEndOfBlock(VisiblePosition(Position(m_lastNodeInserted.get(), 0))))
750             insertNodeBeforeAndUpdateNodesInserted(createBreakElement(document()).get(), m_lastNodeInserted.get());
751             
752     } else if (shouldMergeEnd(endOfInsertedContent, fragment.hasInterchangeNewlineAtEnd(), endWasEndOfParagraph)) {
753         // Make sure that content after the end of the selection being pasted into is in the same paragraph as the 
754         // last bit of content that was inserted.
755         
756         // Merging two paragraphs will destroy the moved one's block styles.  Always move forward to preserve
757         // the block style of the paragraph already in the document, unless the paragraph to move would include the
758         // what was the start of the selection that was pasted into.
759         bool mergeForward = !inSameParagraph(startOfInsertedContent, endOfInsertedContent);
760         
761         VisiblePosition destination = mergeForward ? endOfInsertedContent.next() : endOfInsertedContent;
762         VisiblePosition startOfParagraphToMove = mergeForward ? startOfParagraph(endOfInsertedContent) : endOfInsertedContent.next();
763
764         moveParagraph(startOfParagraphToMove, endOfParagraph(startOfParagraphToMove), destination);
765         // Merging forward will remove m_lastNodeInserted from the document.
766         // FIXME: Maintain positions for the start and end of inserted content instead of keeping nodes.  The nodes are
767         // only ever used to create positions where inserted content starts/ends.
768         if (mergeForward)
769             m_lastNodeInserted = destination.previous().deepEquivalent().node();
770     }
771     
772     endOfInsertedContent = VisiblePosition(Position(m_lastNodeInserted.get(), maxDeepOffset(m_lastNodeInserted.get())));
773     startOfInsertedContent = VisiblePosition(Position(m_firstNodeInserted.get(), 0));    
774     
775     // Add spaces for smart replace.
776     if (m_smartReplace) {
777         bool needsTrailingSpace = !isEndOfParagraph(endOfInsertedContent) &&
778                                   !frame->isCharacterSmartReplaceExempt(endOfInsertedContent.characterAfter(), false);
779         if (needsTrailingSpace) {
780             if (m_lastNodeInserted->isTextNode()) {
781                 Text *text = static_cast<Text *>(m_lastNodeInserted.get());
782                 insertTextIntoNode(text, text->length(), nonBreakingSpaceString());
783                 insertionPos = Position(text, text->length());
784             } else {
785                 RefPtr<Node> node = document()->createEditingTextNode(nonBreakingSpaceString());
786                 insertNodeAfterAndUpdateNodesInserted(node.get(), m_lastNodeInserted.get());
787                 insertionPos = Position(node.get(), 1);
788             }
789         }
790     
791         bool needsLeadingSpace = !isStartOfParagraph(startOfInsertedContent) &&
792                                  !frame->isCharacterSmartReplaceExempt(startOfInsertedContent.previous().characterAfter(), true);
793         if (needsLeadingSpace) {
794             if (m_firstNodeInserted->isTextNode()) {
795                 Text *text = static_cast<Text *>(m_firstNodeInserted.get());
796                 insertTextIntoNode(text, 0, nonBreakingSpaceString());
797             } else {
798                 RefPtr<Node> node = document()->createEditingTextNode(nonBreakingSpaceString());
799                 // Don't updateNodesInserted.  Doing so would set m_lastNodeInserted to be the node containing the 
800                 // leading space, but m_lastNodeInserted is supposed to mark the end of pasted content.
801                 insertNodeBefore(node.get(), m_firstNodeInserted.get());
802                 // FIXME: Use positions to track the start/end of inserted content.
803                 m_firstNodeInserted = node;
804             }
805         }
806     }
807     
808     completeHTMLReplacement(lastPositionToSelect);
809 }
810
811 void ReplaceSelectionCommand::removeEndBRIfNeeded(Node* endBR)
812 {
813     if (!endBR || !endBR->inDocument())
814         return;
815         
816     VisiblePosition visiblePos(Position(endBR, 0));
817     
818     if (// The br is collapsed away and so is unnecessary.
819         !document()->inStrictMode() && isEndOfBlock(visiblePos) && !isStartOfParagraph(visiblePos) ||
820         // A br that was originally holding a line open should be displaced by inserted content.
821         // A br that was originally acting as a line break should still be acting as a line break, not as a placeholder.
822         isStartOfParagraph(visiblePos) && isEndOfParagraph(visiblePos))
823         removeNodeAndPruneAncestors(endBR);
824 }
825
826 void ReplaceSelectionCommand::completeHTMLReplacement(const Position &lastPositionToSelect)
827 {
828     Position start;
829     Position end;
830
831     if (m_firstNodeInserted && m_firstNodeInserted->inDocument() && m_lastNodeInserted && m_lastNodeInserted->inDocument()) {
832         // Find the last leaf.
833         Node *lastLeaf = m_lastNodeInserted.get();
834         while (1) {
835             Node *nextChild = lastLeaf->lastChild();
836             if (!nextChild)
837                 break;
838             lastLeaf = nextChild;
839         }
840     
841         // Find the first leaf.
842         Node *firstLeaf = m_firstNodeInserted.get();
843         while (1) {
844             Node *nextChild = firstLeaf->firstChild();
845             if (!nextChild)
846                 break;
847             firstLeaf = nextChild;
848         }
849         
850         // Call updateLayout so caretMinOffset and caretMaxOffset return correct values.
851         updateLayout();
852         start = Position(firstLeaf, firstLeaf->caretMinOffset());
853         end = Position(lastLeaf, lastLeaf->caretMaxOffset());
854
855         if (m_matchStyle) {
856             assert(m_insertionStyle);
857             applyStyle(m_insertionStyle.get(), start, end);
858         }    
859         
860         if (lastPositionToSelect.isNotNull())
861             end = lastPositionToSelect;
862     } else if (lastPositionToSelect.isNotNull())
863         start = end = lastPositionToSelect;
864     else
865         return;
866     
867     if (m_selectReplacement)
868         setEndingSelection(Selection(start, end, SEL_DEFAULT_AFFINITY));
869     else
870         setEndingSelection(end, SEL_DEFAULT_AFFINITY);
871     
872     rebalanceWhitespace();
873 }
874
875 EditAction ReplaceSelectionCommand::editingAction() const
876 {
877     return EditActionPaste;
878 }
879
880 void ReplaceSelectionCommand::insertNodeAfterAndUpdateNodesInserted(Node *insertChild, Node *refChild)
881 {
882     insertNodeAfter(insertChild, refChild);
883     updateNodesInserted(insertChild);
884 }
885
886 void ReplaceSelectionCommand::insertNodeAtAndUpdateNodesInserted(Node *insertChild, Node *refChild, int offset)
887 {
888     insertNodeAt(insertChild, refChild, offset);
889     updateNodesInserted(insertChild);
890 }
891
892 void ReplaceSelectionCommand::insertNodeBeforeAndUpdateNodesInserted(Node *insertChild, Node *refChild)
893 {
894     insertNodeBefore(insertChild, refChild);
895     updateNodesInserted(insertChild);
896 }
897
898 void ReplaceSelectionCommand::updateNodesInserted(Node *node)
899 {
900     if (!node)
901         return;
902
903     m_lastTopNodeInserted = node;
904     if (!m_firstNodeInserted)
905         m_firstNodeInserted = node;
906     
907     if (node == m_lastNodeInserted)
908         return;
909     
910     m_lastNodeInserted = node->lastDescendant();
911 }
912
913 } // namespace WebCore