0be387813356ec14d6332c5fa0a47efd4afa9c98
[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, EditAction editAction) 
464     : CompositeEditCommand(document),
465       m_selectReplacement(selectReplacement), 
466       m_smartReplace(smartReplace),
467       m_matchStyle(matchStyle),
468       m_documentFragment(fragment),
469       m_forceMergeStart(forceMergeStart),
470       m_editAction(editAction)
471 {
472 }
473
474 ReplaceSelectionCommand::~ReplaceSelectionCommand()
475 {
476 }
477
478 // FIXME: This will soon operate on the fragment after it's been inserted so that it can check renderers and create visible positions.
479 bool ReplaceSelectionCommand::shouldMergeStart(const ReplacementFragment& incomingFragment, const Selection& destinationSelection)
480 {
481     if (m_forceMergeStart)
482         return true;
483         
484     VisiblePosition visibleStart = destinationSelection.visibleStart();
485     Node* startBlock = destinationSelection.start().node()->enclosingBlockFlowElement();
486
487     // <rdar://problem/4013642> Copied quoted word does not paste as a quote if pasted at the start of a line    
488     if (isStartOfParagraph(visibleStart) && isMailBlockquote(incomingFragment.firstChild()))
489         return false;
490     
491     // Don't pull content out of a list item.
492     // FIXMEs: Use an enclosing element getter that uses the render tree once this function is called after the fragment
493     // that's been placed into the document.
494     if (enclosingList(incomingFragment.mergeStartNode()) || enclosingNodeWithTag(incomingFragment.mergeStartNode(), tdTag))
495         return false;
496     
497     // Merge if this is an empty editable subtree, to prevent an extra level of block nesting.
498     if (startBlock == startBlock->rootEditableElement() && isStartOfBlock(visibleStart) && isEndOfBlock(visibleStart))
499         return true;
500     
501     if (!incomingFragment.hasInterchangeNewlineAtStart() && 
502         (!isStartOfParagraph(visibleStart) || !incomingFragment.hasInterchangeNewlineAtEnd() && !incomingFragment.hasMoreThanOneBlock()))
503        return true;
504     
505     return false;
506 }
507
508 bool ReplaceSelectionCommand::shouldMergeEnd(const VisiblePosition& endOfInsertedContent, bool fragmentHadInterchangeNewlineAtEnd, bool selectionEndWasEndOfParagraph)
509 {
510     Node* endNode = endOfInsertedContent.deepEquivalent().node();
511     Node* nextNode = endOfInsertedContent.next().deepEquivalent().node();
512     // FIXME: Unify the naming scheme for these enclosing element getters.
513     return !selectionEndWasEndOfParagraph &&
514            !fragmentHadInterchangeNewlineAtEnd && 
515            isEndOfParagraph(endOfInsertedContent) && 
516            nearestMailBlockquote(endNode) == nearestMailBlockquote(nextNode) &&
517            enclosingListChild(endNode) == enclosingListChild(nextNode) &&
518            enclosingTableCell(endNode) == enclosingTableCell(nextNode) &&
519            !endNode->hasTagName(hrTag);
520 }
521
522 void ReplaceSelectionCommand::doApply()
523 {
524     // collect information about the current selection, prior to deleting the selection
525     Selection selection = endingSelection();
526     ASSERT(selection.isCaretOrRange());
527     ASSERT(selection.start().node());
528     if (selection.isNone() || !selection.start().node())
529         return;
530     
531     if (!selection.isContentRichlyEditable())
532         m_matchStyle = true;
533     
534     Element* currentRoot = selection.rootEditableElement();
535     ReplacementFragment fragment(document(), m_documentFragment.get(), m_matchStyle, currentRoot);
536     
537     if (fragment.type() == EmptyFragment)
538         return;
539     
540     if (m_matchStyle)
541         m_insertionStyle = styleAtPosition(selection.start());
542     
543     VisiblePosition visibleStart(selection.start(), selection.affinity());
544     VisiblePosition visibleEnd(selection.end(), selection.affinity());
545     bool startAtStartOfBlock = isStartOfBlock(visibleStart);
546     Node* startBlock = selection.start().node()->enclosingBlockFlowElement();
547
548     // Whether the first paragraph of the incoming fragment should be merged with content from visibleStart to startOfParagraph(visibleStart).
549     bool mergeStart = shouldMergeStart(fragment, selection);
550     
551     bool endWasEndOfParagraph = isEndOfParagraph(visibleEnd);
552
553     Position startPos = selection.start();
554     
555     // delete the current range selection, or insert paragraph for caret selection, as needed
556     if (selection.isRange()) {
557         // When the end of the selection being pasted into is at the end of a paragraph, and that selection
558         // spans multiple blocks, not merging may leave an empty line.
559         // When the start of the selection being pasted into is at the start of a block, not merging 
560         // will leave hanging block(s).
561         bool mergeBlocksAfterDelete = isEndOfParagraph(visibleEnd) || isStartOfBlock(visibleStart);
562         deleteSelection(false, mergeBlocksAfterDelete, true);
563         updateLayout();
564         visibleStart = endingSelection().visibleStart();
565         if (fragment.hasInterchangeNewlineAtStart()) {
566             if (isEndOfParagraph(visibleStart) && !isStartOfParagraph(visibleStart)) {
567                 if (!isEndOfDocument(visibleStart))
568                     setEndingSelection(visibleStart.next());
569             } else
570                 insertParagraphSeparator();
571         }
572         startPos = endingSelection().start();
573     } 
574     else {
575         ASSERT(selection.isCaret());
576         if (fragment.hasInterchangeNewlineAtStart()) {
577             if (isEndOfParagraph(visibleStart) && !isStartOfParagraph(visibleStart)) {
578                 if (!isEndOfDocument(visibleStart))
579                     setEndingSelection(visibleStart.next());
580             } else 
581                 insertParagraphSeparator();
582         }
583         // We split the current paragraph in two to avoid nesting the blocks from the fragment inside the current block.
584         // For example paste <div>foo</div><div>bar</div><div>baz</div> into <div>x^x</div>, where ^ is the caret.  
585         // As long as the  div styles are the same, visually you'd expect: <div>xbar</div><div>bar</div><div>bazx</div>, 
586         // not <div>xbar<div>bar</div><div>bazx</div></div>
587         // FIXME: If this code is really about preventing block nesting, then the check should be !isEndOfBlock(visibleStart) and we 
588         // should split the block in two, instead of inserting a paragraph separator. In the meantime, it appears that code below 
589         // depends on this split happening when the paste position is not the start or end of a paragraph.
590         if (!isEndOfParagraph(visibleStart) && !isStartOfParagraph(visibleStart)) {
591             insertParagraphSeparator();
592             setEndingSelection(VisiblePosition(endingSelection().start(), VP_DEFAULT_AFFINITY).previous());
593         }
594         startPos = endingSelection().start();
595     }
596     
597     // NOTE: This would be an incorrect usage of downstream() if downstream() were changed to mean the last position after 
598     // 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 
599     // away, there are positions after the br which map to the same visible position as [br, 0]).  
600     Node* endBR = startPos.downstream().node()->hasTagName(brTag) ? startPos.downstream().node() : 0;
601     
602     if (startAtStartOfBlock && startBlock->inDocument())
603         startPos = Position(startBlock, 0);
604
605     // paste into run of tabs splits the tab span
606     startPos = positionOutsideTabSpan(startPos);
607     
608     // paste at start or end of link goes outside of link
609     startPos = positionAvoidingSpecialElementBoundary(startPos);
610
611     Frame *frame = document()->frame();
612     
613     // FIXME: Improve typing style.
614     // See this bug: <rdar://problem/3769899> Implementation of typing style needs improvement
615     frame->clearTypingStyle();
616     setTypingStyle(0);    
617     
618     // done if there is nothing to add
619     if (!fragment.firstChild())
620         return;
621     
622     // 1) Add the first paragraph of the incoming fragment, merging it with the paragraph that contained the 
623     // start of the selection that was pasted into.
624     // 2) Add everything else.
625     // 3) Restore the styles of inserted nodes (since styles were removed during the test insertion).
626     // 4) Do one of the following: a) if there was a br at the end of the fragment, expand it if it collapsed 
627     // because of quirks mode, b) merge the last paragraph of the incoming fragment with the paragraph that contained the 
628     // end of the selection that was pasted into, or c) handle an interchange newline at the end of the 
629     // incoming fragment.
630     // 5) Add spaces for smart replace.
631     // 6) Select the replacement if requested, and match style if requested.
632         
633     // initially, we say the insertion point is the start of selection
634     updateLayout();
635     Position insertionPos = startPos;
636
637     // Add the first paragraph.
638     if (mergeStart) {
639         RefPtr<Node> refNode = fragment.mergeStartNode();
640         if (refNode) {
641             Node *parent = refNode->parentNode();
642             RefPtr<Node> node = refNode->nextSibling();
643             fragment.removeNode(refNode);
644             insertNodeAtAndUpdateNodesInserted(refNode.get(), startPos.node(), startPos.offset());
645             while (node && !fragment.isBlockFlow(node.get())) {
646                 Node *next = node->nextSibling();
647                 fragment.removeNode(node);
648                 insertNodeAfterAndUpdateNodesInserted(node.get(), refNode.get());
649                 refNode = node;
650                 node = next;
651             }
652
653             // remove any ancestors we emptied, except the root itself which cannot be removed
654             while (parent && parent->parentNode() && parent->childNodeCount() == 0) {
655                 Node *nextParent = parent->parentNode();
656                 fragment.removeNode(parent);
657                 parent = nextParent;
658             }
659         }
660         
661         // update insertion point to be at the end of the last block inserted
662         if (m_lastNodeInserted) {
663             updateLayout();
664             insertionPos = Position(m_lastNodeInserted.get(), m_lastNodeInserted->caretMaxOffset());
665         }
666     }
667     
668     // Add everything else.
669     if (fragment.firstChild()) {
670         RefPtr<Node> refNode = fragment.firstChild();
671         RefPtr<Node> node = refNode ? refNode->nextSibling() : 0;
672         Node* insertionBlock = insertionPos.node()->enclosingBlockFlowElement();
673         Node* insertionRoot = insertionPos.node()->rootEditableElement();
674         bool insertionBlockIsRoot = insertionBlock == insertionRoot;
675         VisiblePosition visibleInsertionPos(insertionPos);
676         fragment.removeNode(refNode);
677         // FIXME: The first two cases need to be rethought.  They're about preventing the nesting of 
678         // incoming blocks in the block where the paste is being performed.  But, avoiding nesting doesn't 
679         // always produce the desired visual result, and the decisions are based on isBlockFlow, which 
680         // we're getting rid of.
681         if (!insertionBlockIsRoot && fragment.isBlockFlow(refNode.get()) && isStartOfBlock(visibleInsertionPos) && !m_lastNodeInserted)
682             insertNodeBeforeAndUpdateNodesInserted(refNode.get(), insertionBlock);
683         else if (!insertionBlockIsRoot && fragment.isBlockFlow(refNode.get()) && isEndOfBlock(visibleInsertionPos))
684             insertNodeAfterAndUpdateNodesInserted(refNode.get(), insertionBlock);
685         else if (m_lastNodeInserted && !fragment.isBlockFlow(refNode.get())) {
686             // A non-null m_lastNodeInserted means we've done merging above.  That means everything in the first paragraph 
687             // of the fragment has been merged with everything up to the start of the paragraph where the paste was performed.  
688             // refNode is the first node in the second paragraph of the fragment to paste.  Since it's inline, we can't 
689             // insert it at insertionPos, because it wouldn't end up in its own paragraph.
690
691             // FIXME: Code above does paragraph splitting and so we are assured that visibleInsertionPos is the end of
692             // a paragraph, but the above splitting should eventually be only about preventing nesting.
693             ASSERT(isEndOfParagraph(visibleInsertionPos));
694             VisiblePosition next = visibleInsertionPos.next();
695             if (next.isNull() || next.rootEditableElement() != insertionRoot) {
696                 setEndingSelection(visibleInsertionPos);
697                 insertParagraphSeparator();
698                 next = visibleInsertionPos.next();
699             }
700             
701             Position pos = next.deepEquivalent().downstream();
702             insertNodeAtAndUpdateNodesInserted(refNode.get(), pos.node(), pos.offset());
703         } else {
704             insertNodeAtAndUpdateNodesInserted(refNode.get(), insertionPos.node(), insertionPos.offset());
705         }
706         
707         while (node) {
708             Node* next = node->nextSibling();
709             fragment.removeNode(node);
710             insertNodeAfterAndUpdateNodesInserted(node.get(), refNode.get());
711             refNode = node;
712             node = next;
713         }
714         updateLayout();
715         insertionPos = Position(m_lastNodeInserted.get(), m_lastNodeInserted->caretMaxOffset());
716     }
717     
718     removeEndBRIfNeeded(endBR);
719     
720     // Styles were removed during the test insertion.  Restore them.
721     if (!m_matchStyle)
722         fixupNodeStyles(fragment.nodes(), fragment.renderingInfo());
723         
724     VisiblePosition endOfInsertedContent(Position(m_lastNodeInserted.get(), maxDeepOffset(m_lastNodeInserted.get())));
725     VisiblePosition startOfInsertedContent(Position(m_firstNodeInserted.get(), 0));    
726     
727     Position lastPositionToSelect;
728     
729     if (fragment.hasInterchangeNewlineAtEnd()) {
730         VisiblePosition pos(insertionPos);
731         VisiblePosition next = pos.next();
732             
733         if (endWasEndOfParagraph || !isEndOfParagraph(pos) || next.isNull() || next.rootEditableElement() != currentRoot) {
734             setEndingSelection(insertionPos, DOWNSTREAM);
735             insertParagraphSeparator();
736
737             // Select up to the paragraph separator that was added.
738             lastPositionToSelect = endingSelection().visibleStart().deepEquivalent();
739             updateNodesInserted(lastPositionToSelect.node());
740         } else {
741             // Select up to the beginning of the next paragraph.
742             VisiblePosition next = pos.next();
743             lastPositionToSelect = next.deepEquivalent().downstream();
744         }
745         
746     } else if (m_lastNodeInserted->hasTagName(brTag)) {
747         // We want to honor the last incoming line break, so, if it will collapse away because of quirks mode, 
748         // add an extra one.
749         // FIXME: This will expand a br inside a block: <div><br></div>
750         // FIXME: Should we expand all incoming brs that collapse because of quirks mode?
751         if (!document()->inStrictMode() && isEndOfBlock(VisiblePosition(Position(m_lastNodeInserted.get(), 0))))
752             insertNodeBeforeAndUpdateNodesInserted(createBreakElement(document()).get(), m_lastNodeInserted.get());
753             
754     } else if (shouldMergeEnd(endOfInsertedContent, fragment.hasInterchangeNewlineAtEnd(), endWasEndOfParagraph)) {
755         // Make sure that content after the end of the selection being pasted into is in the same paragraph as the 
756         // last bit of content that was inserted.
757         
758         // Merging two paragraphs will destroy the moved one's block styles.  Always move forward to preserve
759         // the block style of the paragraph already in the document, unless the paragraph to move would include the
760         // what was the start of the selection that was pasted into.
761         bool mergeForward = !inSameParagraph(startOfInsertedContent, endOfInsertedContent);
762         
763         VisiblePosition destination = mergeForward ? endOfInsertedContent.next() : endOfInsertedContent;
764         VisiblePosition startOfParagraphToMove = mergeForward ? startOfParagraph(endOfInsertedContent) : endOfInsertedContent.next();
765
766         moveParagraph(startOfParagraphToMove, endOfParagraph(startOfParagraphToMove), destination);
767         // Merging forward will remove m_lastNodeInserted from the document.
768         // FIXME: Maintain positions for the start and end of inserted content instead of keeping nodes.  The nodes are
769         // only ever used to create positions where inserted content starts/ends.
770         if (mergeForward)
771             m_lastNodeInserted = destination.previous().deepEquivalent().node();
772     }
773     
774     endOfInsertedContent = VisiblePosition(Position(m_lastNodeInserted.get(), maxDeepOffset(m_lastNodeInserted.get())));
775     startOfInsertedContent = VisiblePosition(Position(m_firstNodeInserted.get(), 0));    
776     
777     // Add spaces for smart replace.
778     if (m_smartReplace) {
779         bool needsTrailingSpace = !isEndOfParagraph(endOfInsertedContent) &&
780                                   !frame->isCharacterSmartReplaceExempt(endOfInsertedContent.characterAfter(), false);
781         if (needsTrailingSpace) {
782             if (m_lastNodeInserted->isTextNode()) {
783                 Text *text = static_cast<Text *>(m_lastNodeInserted.get());
784                 insertTextIntoNode(text, text->length(), nonBreakingSpaceString());
785                 insertionPos = Position(text, text->length());
786             } else {
787                 RefPtr<Node> node = document()->createEditingTextNode(nonBreakingSpaceString());
788                 insertNodeAfterAndUpdateNodesInserted(node.get(), m_lastNodeInserted.get());
789                 insertionPos = Position(node.get(), 1);
790             }
791         }
792     
793         bool needsLeadingSpace = !isStartOfParagraph(startOfInsertedContent) &&
794                                  !frame->isCharacterSmartReplaceExempt(startOfInsertedContent.previous().characterAfter(), true);
795         if (needsLeadingSpace) {
796             if (m_firstNodeInserted->isTextNode()) {
797                 Text *text = static_cast<Text *>(m_firstNodeInserted.get());
798                 insertTextIntoNode(text, 0, nonBreakingSpaceString());
799             } else {
800                 RefPtr<Node> node = document()->createEditingTextNode(nonBreakingSpaceString());
801                 // Don't updateNodesInserted.  Doing so would set m_lastNodeInserted to be the node containing the 
802                 // leading space, but m_lastNodeInserted is supposed to mark the end of pasted content.
803                 insertNodeBefore(node.get(), m_firstNodeInserted.get());
804                 // FIXME: Use positions to track the start/end of inserted content.
805                 m_firstNodeInserted = node;
806             }
807         }
808     }
809     
810     completeHTMLReplacement(lastPositionToSelect);
811 }
812
813 void ReplaceSelectionCommand::removeEndBRIfNeeded(Node* endBR)
814 {
815     if (!endBR || !endBR->inDocument())
816         return;
817         
818     VisiblePosition visiblePos(Position(endBR, 0));
819     
820     if (// The br is collapsed away and so is unnecessary.
821         !document()->inStrictMode() && isEndOfBlock(visiblePos) && !isStartOfParagraph(visiblePos) ||
822         // A br that was originally holding a line open should be displaced by inserted content.
823         // A br that was originally acting as a line break should still be acting as a line break, not as a placeholder.
824         isStartOfParagraph(visiblePos) && isEndOfParagraph(visiblePos))
825         removeNodeAndPruneAncestors(endBR);
826 }
827
828 void ReplaceSelectionCommand::completeHTMLReplacement(const Position &lastPositionToSelect)
829 {
830     Position start;
831     Position end;
832
833     if (m_firstNodeInserted && m_firstNodeInserted->inDocument() && m_lastNodeInserted && m_lastNodeInserted->inDocument()) {
834         
835         Node* lastLeaf = m_lastNodeInserted->lastDescendant();
836         Node* firstLeaf = m_firstNodeInserted->firstDescendant();
837         
838         start = Position(firstLeaf, 0);
839         end = Position(lastLeaf, maxDeepOffset(lastLeaf));
840         
841         // FIXME: Should we treat all spaces in incoming content as having been rendered?
842         rebalanceWhitespaceAt(start);
843         rebalanceWhitespaceAt(end);
844
845         if (m_matchStyle) {
846             assert(m_insertionStyle);
847             applyStyle(m_insertionStyle.get(), start, end);
848         }    
849         
850         if (lastPositionToSelect.isNotNull())
851             end = lastPositionToSelect;
852     } else if (lastPositionToSelect.isNotNull())
853         start = end = lastPositionToSelect;
854     else
855         return;
856     
857     if (m_selectReplacement)
858         setEndingSelection(Selection(start, end, SEL_DEFAULT_AFFINITY));
859     else
860         setEndingSelection(end, SEL_DEFAULT_AFFINITY);
861 }
862
863 EditAction ReplaceSelectionCommand::editingAction() const
864 {
865     return m_editAction;
866 }
867
868 void ReplaceSelectionCommand::insertNodeAfterAndUpdateNodesInserted(Node *insertChild, Node *refChild)
869 {
870     insertNodeAfter(insertChild, refChild);
871     updateNodesInserted(insertChild);
872 }
873
874 void ReplaceSelectionCommand::insertNodeAtAndUpdateNodesInserted(Node *insertChild, Node *refChild, int offset)
875 {
876     insertNodeAt(insertChild, refChild, offset);
877     updateNodesInserted(insertChild);
878 }
879
880 void ReplaceSelectionCommand::insertNodeBeforeAndUpdateNodesInserted(Node *insertChild, Node *refChild)
881 {
882     insertNodeBefore(insertChild, refChild);
883     updateNodesInserted(insertChild);
884 }
885
886 void ReplaceSelectionCommand::updateNodesInserted(Node *node)
887 {
888     if (!node)
889         return;
890
891     m_lastTopNodeInserted = node;
892     if (!m_firstNodeInserted)
893         m_firstNodeInserted = node;
894     
895     if (node == m_lastNodeInserted)
896         return;
897     
898     m_lastNodeInserted = node->lastDescendant();
899 }
900
901 } // namespace WebCore