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         m_fragment = createFragmentFromText(document, evt->text().deprecatedString());
92         firstChild = m_fragment->firstChild();
93         lastChild = m_fragment->firstChild();
94         
95         removeNode(holder);
96         holder = insertFragmentForTestRendering();
97     }
98     
99     Node *node = firstChild;
100     Node *newlineAtStartNode = 0;
101     Node *newlineAtEndNode = 0;
102     while (node) {
103         Node *next = node->traverseNextNode();
104         if (isInterchangeNewlineNode(node)) {
105             if (next || node == firstChild) {
106                 m_hasInterchangeNewlineAtStart = true;
107                 newlineAtStartNode = node;
108             }
109             else {
110                 m_hasInterchangeNewlineAtEnd = true;
111                 newlineAtEndNode = node;
112             }
113         }
114         else if (isInterchangeConvertedSpaceSpan(node)) {
115             RefPtr<Node> n = 0;
116             while ((n = node->firstChild())) {
117                 removeNode(n);
118                 insertNodeBefore(n.get(), node);
119             }
120             removeNode(node);
121             if (n)
122                 next = n->traverseNextNode();
123         }
124         node = next;
125     }
126
127     if (newlineAtStartNode)
128         removeNode(newlineAtStartNode);
129     if (newlineAtEndNode)
130         removeNode(newlineAtEndNode);
131     
132     saveRenderingInfo(holder.get());
133     removeUnrenderedNodes(holder.get());
134     m_hasMoreThanOneBlock = renderedBlocks(holder.get()) > 1;
135     restoreTestRenderingNodesToFragment(holder.get());
136     removeNode(holder);
137     removeStyleNodes();
138 }
139
140 ReplacementFragment::~ReplacementFragment()
141 {
142 }
143
144 Node *ReplacementFragment::firstChild() const 
145
146     return m_fragment->firstChild(); 
147 }
148
149 Node *ReplacementFragment::lastChild() const 
150
151     return m_fragment->lastChild(); 
152 }
153
154 static bool isMailPasteAsQuotationNode(const Node *node)
155 {
156     return node && static_cast<const Element *>(node)->getAttribute("class") == ApplePasteAsQuotation;
157 }
158
159 Node *ReplacementFragment::mergeStartNode() const
160 {
161     Node *node = m_fragment->firstChild();
162     while (node && isBlockFlow(node) && !isMailPasteAsQuotationNode(node))
163         node = node->traverseNextNode();
164     return node;
165 }
166
167 bool ReplacementFragment::isInterchangeNewlineNode(const Node *node)
168 {
169     static String interchangeNewlineClassString(AppleInterchangeNewline);
170     return node && node->hasTagName(brTag) && 
171            static_cast<const Element *>(node)->getAttribute(classAttr) == interchangeNewlineClassString;
172 }
173
174 bool ReplacementFragment::isInterchangeConvertedSpaceSpan(const Node *node)
175 {
176     static String convertedSpaceSpanClassString(AppleConvertedSpace);
177     return node->isHTMLElement() && 
178            static_cast<const HTMLElement *>(node)->getAttribute(classAttr) == convertedSpaceSpanClassString;
179 }
180
181 Node *ReplacementFragment::enclosingBlock(Node *node) const
182 {
183     while (node && !isBlockFlow(node))
184         node = node->parentNode();    
185     return node ? node : m_fragment.get();
186 }
187
188 void ReplacementFragment::removeNodePreservingChildren(Node *node)
189 {
190     if (!node)
191         return;
192
193     while (RefPtr<Node> n = node->firstChild()) {
194         removeNode(n);
195         insertNodeBefore(n.get(), node);
196     }
197     removeNode(node);
198 }
199
200 void ReplacementFragment::removeNode(PassRefPtr<Node> node)
201 {
202     if (!node)
203         return;
204     
205     Node *parent = node->parentNode();
206     if (!parent)
207         return;
208     
209     ExceptionCode ec = 0;
210     parent->removeChild(node.get(), ec);
211     ASSERT(ec == 0);
212 }
213
214 void ReplacementFragment::insertNodeBefore(Node *node, Node *refNode)
215 {
216     if (!node || !refNode)
217         return;
218         
219     Node *parent = refNode->parentNode();
220     if (!parent)
221         return;
222         
223     ExceptionCode ec = 0;
224     parent->insertBefore(node, refNode, ec);
225     ASSERT(ec == 0);
226 }
227
228 PassRefPtr<Node> ReplacementFragment::insertFragmentForTestRendering()
229 {
230     Node *body = m_document->body();
231     if (!body)
232         return 0;
233
234     RefPtr<Node> holder = createDefaultParagraphElement(m_document.get());
235     
236     ExceptionCode ec = 0;
237     holder->appendChild(m_fragment, ec);
238     ASSERT(ec == 0);
239     
240     body->appendChild(holder.get(), ec);
241     ASSERT(ec == 0);
242     
243     m_document->updateLayoutIgnorePendingStylesheets();
244     
245     return holder.release();
246 }
247
248 void ReplacementFragment::restoreTestRenderingNodesToFragment(Node *holder)
249 {
250     if (!holder)
251         return;
252     
253     ExceptionCode ec = 0;
254     while (RefPtr<Node> node = holder->firstChild()) {
255         holder->removeChild(node.get(), ec);
256         ASSERT(ec == 0);
257         m_fragment->appendChild(node.get(), ec);
258         ASSERT(ec == 0);
259     }
260 }
261
262 bool ReplacementFragment::isBlockFlow(Node* node) const
263 {
264     RefPtr<RenderingInfo> info = m_renderingInfo.get(node);
265     ASSERT(info);
266     if (!info)
267         return false;
268     
269     return info->isBlockFlow();
270 }
271
272 static String &matchNearestBlockquoteColorString()
273 {
274     static String matchNearestBlockquoteColorString = "match";
275     return matchNearestBlockquoteColorString;
276 }
277
278 void ReplaceSelectionCommand::fixupNodeStyles(const NodeVector& nodes, const RenderingInfoMap& renderingInfo)
279 {
280     // This function uses the mapped "desired style" to apply the additional style needed, if any,
281     // to make the node have the desired style.
282
283     updateLayout();
284     
285     NodeVector::const_iterator e = nodes.end();
286     for (NodeVector::const_iterator it = nodes.begin(); it != e; ++it) {
287         Node *node = (*it).get();
288         RefPtr<RenderingInfo> info = renderingInfo.get(node);
289         ASSERT(info);
290         if (!info)
291             continue;
292         CSSMutableStyleDeclaration *desiredStyle = info->style();
293         ASSERT(desiredStyle);
294
295         if (!node->inDocument())
296             continue;
297
298         // The desiredStyle declaration tells what style this node wants to be.
299         // Compare that to the style that it is right now in the document.
300         Position pos(node, 0);
301         RefPtr<CSSComputedStyleDeclaration> currentStyle = pos.computedStyle();
302
303         // Check for the special "match nearest blockquote color" property and resolve to the correct
304         // color if necessary.
305         String matchColorCheck = desiredStyle->getPropertyValue(CSS_PROP__KHTML_MATCH_NEAREST_MAIL_BLOCKQUOTE_COLOR);
306         if (matchColorCheck == matchNearestBlockquoteColorString()) {
307             Node *blockquote = nearestMailBlockquote(node);
308             Position pos(blockquote ? blockquote : node->document()->documentElement(), 0);
309             RefPtr<CSSComputedStyleDeclaration> style = pos.computedStyle();
310             String desiredColor = desiredStyle->getPropertyValue(CSS_PROP_COLOR);
311             String nearestColor = style->getPropertyValue(CSS_PROP_COLOR);
312             if (desiredColor != nearestColor)
313                 desiredStyle->setProperty(CSS_PROP_COLOR, nearestColor);
314         }
315         desiredStyle->removeProperty(CSS_PROP__KHTML_MATCH_NEAREST_MAIL_BLOCKQUOTE_COLOR);
316
317         currentStyle->diff(desiredStyle);
318         
319         // Only add in block properties if the node is at the start of a 
320         // paragraph. This matches AppKit.
321         if (!isStartOfParagraph(VisiblePosition(pos, DOWNSTREAM)))
322             desiredStyle->removeBlockProperties();
323         
324         // If the desiredStyle is non-zero length, that means the current style differs
325         // from the desired by the styles remaining in the desiredStyle declaration.
326         if (desiredStyle->length() > 0)
327             applyStyle(desiredStyle, Position(node, 0), Position(node, maxDeepOffset(node)));
328     }
329 }
330
331 static PassRefPtr<CSSMutableStyleDeclaration> styleForNode(Node *node)
332 {
333     if (!node || !node->inDocument())
334         return 0;
335         
336     RefPtr<CSSComputedStyleDeclaration> computedStyle = Position(node, 0).computedStyle();
337     RefPtr<CSSMutableStyleDeclaration> style = computedStyle->copyInheritableProperties();
338
339     // In either of the color-matching tests below, set the color to a pseudo-color that will
340     // make the content take on the color of the nearest-enclosing blockquote (if any) after
341     // being pasted in.
342     if (Node *blockquote = nearestMailBlockquote(node)) {
343         RefPtr<CSSComputedStyleDeclaration> blockquoteStyle = Position(blockquote, 0).computedStyle();
344         bool match = (blockquoteStyle->getPropertyValue(CSS_PROP_COLOR) == style->getPropertyValue(CSS_PROP_COLOR));
345         if (match) {
346             style->setProperty(CSS_PROP__KHTML_MATCH_NEAREST_MAIL_BLOCKQUOTE_COLOR, matchNearestBlockquoteColorString());
347             return style.release();
348         }
349     }
350     Node *documentElement = node->document()->documentElement();
351     RefPtr<CSSComputedStyleDeclaration> documentStyle = Position(documentElement, 0).computedStyle();
352     bool match = (documentStyle->getPropertyValue(CSS_PROP_COLOR) == style->getPropertyValue(CSS_PROP_COLOR));
353     if (match)
354         style->setProperty(CSS_PROP__KHTML_MATCH_NEAREST_MAIL_BLOCKQUOTE_COLOR, matchNearestBlockquoteColorString());
355         
356     return style.release();
357 }
358
359 void ReplacementFragment::saveRenderingInfo(Node *holder)
360 {
361     m_document->updateLayoutIgnorePendingStylesheets();
362     
363     if (m_matchStyle) {
364         // No style restoration will be done, so we don't need to save styles or keep a node vector.
365         for (Node *node = holder->firstChild(); node; node = node->traverseNextNode(holder))
366             m_renderingInfo.add(node, new RenderingInfo(0, node->isBlockFlow()));
367     } else {
368         for (Node *node = holder->firstChild(); node; node = node->traverseNextNode(holder)) {
369             m_renderingInfo.add(node, new RenderingInfo(styleForNode(node), node->isBlockFlow()));
370             m_nodes.append(node);
371         }
372     }
373 }
374
375 void ReplacementFragment::removeUnrenderedNodes(Node *holder)
376 {
377     DeprecatedPtrList<Node> unrendered;
378
379     for (Node *node = holder->firstChild(); node; node = node->traverseNextNode(holder)) {
380         if (!isNodeRendered(node) && !isTableStructureNode(node))
381             unrendered.append(node);
382     }
383
384     for (DeprecatedPtrListIterator<Node> it(unrendered); it.current(); ++it)
385         removeNode(it.current());
386 }
387
388 int ReplacementFragment::renderedBlocks(Node *holder)
389 {
390     int count = 0;
391     Node *prev = 0;
392     for (Node *node = holder->firstChild(); node; node = node->traverseNextNode(holder)) {
393         if (node->isBlockFlow()) {
394             if (!prev) {
395                 count++;
396                 prev = node;
397             }
398         } else {
399             Node *block = node->enclosingBlockFlowElement();
400             if (block != prev) {
401                 count++;
402                 prev = block;
403             }
404         }
405     }
406     
407     return count;
408 }
409
410 void ReplacementFragment::removeStyleNodes()
411 {
412     // Since style information has been computed and cached away in
413     // computeStylesUsingTestRendering(), these style nodes can be removed, since
414     // the correct styles will be added back in fixupNodeStyles().
415     Node *node = m_fragment->firstChild();
416     while (node) {
417         Node *next = node->traverseNextNode();
418         // This list of tags change the appearance of content
419         // in ways we can add back on later with CSS, if necessary.
420         //  FIXME: This list is incomplete
421         if (node->hasTagName(bTag) || 
422             node->hasTagName(bigTag) || 
423             node->hasTagName(centerTag) || 
424             node->hasTagName(fontTag) || 
425             node->hasTagName(iTag) || 
426             node->hasTagName(sTag) || 
427             node->hasTagName(smallTag) || 
428             node->hasTagName(strikeTag) || 
429             node->hasTagName(subTag) || 
430             node->hasTagName(supTag) || 
431             node->hasTagName(ttTag) || 
432             node->hasTagName(uTag) || 
433             isStyleSpan(node)) {
434             removeNodePreservingChildren(node);
435         }
436         // need to skip tab span because fixupNodeStyles() is not called
437         // when replace is matching style
438         else if (node->isHTMLElement() && !isTabSpanNode(node)) {
439             HTMLElement *elem = static_cast<HTMLElement *>(node);
440             CSSMutableStyleDeclaration *inlineStyleDecl = elem->inlineStyleDecl();
441             if (inlineStyleDecl) {
442                 inlineStyleDecl->removeBlockProperties();
443                 inlineStyleDecl->removeInheritableProperties();
444             }
445         }
446         node = next;
447     }
448 }
449
450 RenderingInfo::RenderingInfo(PassRefPtr<CSSMutableStyleDeclaration> style, bool isBlockFlow = false)
451     : m_style(style), m_isBlockFlow(isBlockFlow)
452 {
453 }
454
455 ReplaceSelectionCommand::ReplaceSelectionCommand(Document *document, DocumentFragment *fragment, bool selectReplacement, bool smartReplace, bool matchStyle) 
456     : CompositeEditCommand(document),
457       m_selectReplacement(selectReplacement), 
458       m_smartReplace(smartReplace),
459       m_matchStyle(matchStyle),
460       m_documentFragment(fragment)
461 {
462 }
463
464 ReplaceSelectionCommand::~ReplaceSelectionCommand()
465 {
466 }
467
468 void ReplaceSelectionCommand::doApply()
469 {
470     // collect information about the current selection, prior to deleting the selection
471     Selection selection = endingSelection();
472     ASSERT(selection.isCaretOrRange());
473     
474     if (!selection.isContentRichlyEditable())
475         m_matchStyle = true;
476     
477     ReplacementFragment fragment(document(), m_documentFragment.get(), m_matchStyle, selection.rootEditableElement());
478     
479     if (fragment.type() == EmptyFragment)
480         return;
481     
482     if (m_matchStyle)
483         m_insertionStyle = styleAtPosition(selection.start());
484     
485     VisiblePosition visibleStart(selection.start(), selection.affinity());
486     VisiblePosition visibleEnd(selection.end(), selection.affinity());
487     bool startAtStartOfBlock = isStartOfBlock(visibleStart);
488     bool startAtEndOfBlock = isEndOfBlock(visibleStart);
489     Node *startBlock = selection.start().node()->enclosingBlockFlowElement();
490     Node *endBlock = selection.end().node()->enclosingBlockFlowElement();
491
492     // decide whether to later merge content into the startBlock
493     bool mergeStart = false;
494     if (startBlock == startBlock->rootEditableElement() && startAtStartOfBlock && startAtEndOfBlock) {
495         // empty editable subtree, need to mergeStart so that fragment ends up
496         // merged into the editable subtree rather than adding more levels of block nesting
497         mergeStart = true;
498     } else {
499         // merge if current selection starts inside a paragraph, or there is only one block and no interchange newline to add
500         mergeStart = !fragment.hasInterchangeNewlineAtStart() && 
501             (!isStartOfParagraph(visibleStart) || (!fragment.hasInterchangeNewlineAtEnd() && !fragment.hasMoreThanOneBlock()));
502         
503         // This is a workaround for this bug:
504         // <rdar://problem/4013642> Copied quoted word does not paste as a quote if pasted at the start of a line
505         // We need more powerful logic in this whole mergeStart code for this case to come out right without
506         // breaking other cases.
507         if (isStartOfParagraph(visibleStart) && isMailBlockquote(fragment.firstChild()))
508             mergeStart = false;
509         
510         // prevent first list item from getting merged into target, thereby pulled out of list
511         // NOTE: ideally, we'd check for "first visible position in list" here,
512         // but we cannot.  Fragments do not have any visible positions.  Instead, we
513         // assume that the mergeStartNode() contains the first visible content to paste.
514         // Any better ideas?
515         if (mergeStart) {
516             for (Node *n = fragment.mergeStartNode(); n; n = n->parentNode()) {
517                 if (isListElement(n)) {
518                     mergeStart = false;
519                     break;
520                 }
521             }
522         }
523     }
524     
525     // decide whether to later append nodes to the end
526     Node *beyondEndNode = 0;
527     if (!isEndOfParagraph(visibleEnd) && !fragment.hasInterchangeNewlineAtEnd() &&
528        (startBlock != endBlock || fragment.hasMoreThanOneBlock()))
529         beyondEndNode = selection.end().downstream().node();
530
531     Position startPos = selection.start();
532     
533     // delete the current range selection, or insert paragraph for caret selection, as needed
534     if (selection.isRange()) {
535         bool mergeBlocksAfterDelete = !(fragment.hasInterchangeNewlineAtStart() || fragment.hasInterchangeNewlineAtEnd() || fragment.hasMoreThanOneBlock());
536         deleteSelection(false, mergeBlocksAfterDelete);
537         updateLayout();
538         visibleStart = VisiblePosition(endingSelection().start(), VP_DEFAULT_AFFINITY);
539         if (fragment.hasInterchangeNewlineAtStart()) {
540             if (isEndOfParagraph(visibleStart) && !isStartOfParagraph(visibleStart)) {
541                 if (!isEndOfDocument(visibleStart))
542                     setEndingSelection(visibleStart.next());
543             } else {
544                 insertParagraphSeparator();
545                 setEndingSelection(VisiblePosition(endingSelection().start(), VP_DEFAULT_AFFINITY));
546             }
547         }
548         startPos = endingSelection().start();
549     } 
550     else {
551         ASSERT(selection.isCaret());
552         if (fragment.hasInterchangeNewlineAtStart()) {
553             if (isEndOfParagraph(visibleStart) && !isStartOfParagraph(visibleStart)) {
554                 if (!isEndOfDocument(visibleStart))
555                     setEndingSelection(visibleStart.next());
556             } else {
557                 insertParagraphSeparator();
558                 setEndingSelection(VisiblePosition(endingSelection().start(), VP_DEFAULT_AFFINITY));
559             }
560         }
561         // We split the current paragraph in two to avoid nesting the blocks from the fragment inside the current block.
562         // For example paste <div>foo</div><div>bar</div><div>baz</div> into <div>x^x</div>, where ^ is the caret.  
563         // As long as the  div styles are the same, visually you'd expect: <div>xbar</div><div>bar</div><div>bazx</div>, 
564         // not <div>xbar<div>bar</div><div>bazx</div></div>
565         // FIXME: If this code is really about preventing block nesting, then the check should be !isEndOfBlock(visibleStart) and we 
566         // should split the block in two, instead of inserting a paragraph separator. In the meantime, it appears that code below 
567         // depends on this split happening when the paste position is not the start or end of a paragraph.
568         if (fragment.hasMoreThanOneBlock() && !isEndOfParagraph(visibleStart) && !isStartOfParagraph(visibleStart)) {
569             insertParagraphSeparator();
570             setEndingSelection(VisiblePosition(endingSelection().start(), VP_DEFAULT_AFFINITY).previous());
571         }
572         startPos = endingSelection().start();
573     }
574
575     if (startAtStartOfBlock && startBlock->inDocument())
576         startPos = Position(startBlock, 0);
577
578     // paste into run of tabs splits the tab span
579     startPos = positionOutsideTabSpan(startPos);
580     
581     // paste at start or end of link goes outside of link
582     startPos = positionAvoidingSpecialElementBoundary(startPos);
583
584     Frame *frame = document()->frame();
585     
586     // FIXME: Improve typing style.
587     // See this bug: <rdar://problem/3769899> Implementation of typing style needs improvement
588     frame->clearTypingStyle();
589     setTypingStyle(0);    
590     
591     // done if there is nothing to add
592     if (!fragment.firstChild())
593         return;
594     
595     // check for a line placeholder, and store it away for possible removal later.
596     Node *block = startPos.node()->enclosingBlockFlowElement();
597     Node *linePlaceholder = findBlockPlaceholder(block);
598     if (!linePlaceholder) {
599         Position downstream = startPos.downstream();
600         // NOTE: the check for brTag offset 0 could be false negative after
601         // positionAvoidingSpecialElementBoundary() because "downstream" is
602         // now a "second deepest position"
603         downstream = positionAvoidingSpecialElementBoundary(downstream);
604         if (downstream.node()->hasTagName(brTag) && downstream.offset() == 0 && 
605             fragment.hasInterchangeNewlineAtEnd() &&
606             isStartOfParagraph(VisiblePosition(downstream, VP_DEFAULT_AFFINITY)))
607             linePlaceholder = downstream.node();
608     }
609     
610     // check whether to "smart replace" needs to add leading and/or trailing space
611     bool addLeadingSpace = false;
612     bool addTrailingSpace = false;
613     // FIXME: We need the affinity for startPos and endPos, but Position::downstream
614     // and Position::upstream do not give it
615     if (m_smartReplace) {
616         VisiblePosition visiblePos = VisiblePosition(startPos, VP_DEFAULT_AFFINITY);
617         assert(visiblePos.isNotNull());
618         addLeadingSpace = startPos.leadingWhitespacePosition(VP_DEFAULT_AFFINITY, true).isNull() && !isStartOfParagraph(visiblePos);
619         if (addLeadingSpace) {
620             QChar previousChar = visiblePos.previous().character();
621             if (!previousChar.isNull()) {
622                 addLeadingSpace = !frame->isCharacterSmartReplaceExempt(previousChar, true);
623             }
624         }
625         addTrailingSpace = startPos.trailingWhitespacePosition(VP_DEFAULT_AFFINITY, true).isNull() && !isEndOfParagraph(visiblePos);
626         if (addTrailingSpace) {
627             QChar thisChar = visiblePos.character();
628             if (!thisChar.isNull()) {
629                 addTrailingSpace = !frame->isCharacterSmartReplaceExempt(thisChar, false);
630             }
631         }
632     }
633     
634     // There are five steps to adding the content: merge blocks at start, add remaining blocks,
635     // add "smart replace" space, handle trailing newline, clean up.
636     
637     // initially, we say the insertion point is the start of selection
638     updateLayout();
639     Position insertionPos = startPos;
640
641     // step 1: merge content into the start block
642     if (mergeStart) {
643         RefPtr<Node> refNode = fragment.mergeStartNode();
644         if (refNode) {
645             Node *parent = refNode->parentNode();
646             RefPtr<Node> node = refNode->nextSibling();
647             fragment.removeNode(refNode);
648             insertNodeAtAndUpdateNodesInserted(refNode.get(), startPos.node(), startPos.offset());
649             while (node && !fragment.isBlockFlow(node.get())) {
650                 Node *next = node->nextSibling();
651                 fragment.removeNode(node);
652                 insertNodeAfterAndUpdateNodesInserted(node.get(), refNode.get());
653                 refNode = node;
654                 node = next;
655             }
656
657             // remove any ancestors we emptied, except the root itself which cannot be removed
658             while (parent && parent->parentNode() && parent->childNodeCount() == 0) {
659                 Node *nextParent = parent->parentNode();
660                 fragment.removeNode(parent);
661                 parent = nextParent;
662             }
663         }
664         
665         // update insertion point to be at the end of the last block inserted
666         if (m_lastNodeInserted) {
667             updateLayout();
668             insertionPos = Position(m_lastNodeInserted.get(), m_lastNodeInserted->caretMaxOffset());
669         }
670     }
671     
672     // step 2 : merge everything remaining in the fragment
673     if (fragment.firstChild()) {
674         RefPtr<Node> refNode = fragment.firstChild();
675         RefPtr<Node> node = refNode ? refNode->nextSibling() : 0;
676         Node *insertionBlock = insertionPos.node()->enclosingBlockFlowElement();
677         Node* insertionRoot = insertionPos.node()->rootEditableElement();
678         bool insertionBlockIsRoot = insertionBlock == insertionRoot;
679         VisiblePosition visibleInsertionPos(insertionPos, DOWNSTREAM);
680         fragment.removeNode(refNode);
681         if (!insertionBlockIsRoot && fragment.isBlockFlow(refNode.get()) && isStartOfBlock(visibleInsertionPos))
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.deepEquivalent().node()->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     // step 3 : handle "smart replace" whitespace
719     if (addTrailingSpace && m_lastNodeInserted) {
720         updateLayout();
721         Position pos(m_lastNodeInserted.get(), m_lastNodeInserted->caretMaxOffset());
722         bool needsTrailingSpace = pos.trailingWhitespacePosition(VP_DEFAULT_AFFINITY, true).isNull();
723         if (needsTrailingSpace) {
724             if (m_lastNodeInserted->isTextNode()) {
725                 Text *text = static_cast<Text *>(m_lastNodeInserted.get());
726                 insertTextIntoNode(text, text->length(), nonBreakingSpaceString());
727                 insertionPos = Position(text, text->length());
728             }
729             else {
730                 RefPtr<Node> node = document()->createEditingTextNode(nonBreakingSpaceString());
731                 insertNodeAfterAndUpdateNodesInserted(node.get(), m_lastNodeInserted.get());
732                 insertionPos = Position(node.get(), 1);
733             }
734         }
735     }
736
737     if (addLeadingSpace && m_firstNodeInserted) {
738         updateLayout();
739         Position pos(m_firstNodeInserted.get(), 0);
740         bool needsLeadingSpace = pos.leadingWhitespacePosition(VP_DEFAULT_AFFINITY, true).isNull();
741         if (needsLeadingSpace) {
742             if (m_firstNodeInserted->isTextNode()) {
743                 Text *text = static_cast<Text *>(m_firstNodeInserted.get());
744                 insertTextIntoNode(text, 0, nonBreakingSpaceString());
745             } else {
746                 RefPtr<Node> node = document()->createEditingTextNode(nonBreakingSpaceString());
747                 insertNodeBeforeAndUpdateNodesInserted(node.get(), m_firstNodeInserted.get());
748             }
749         }
750     }
751     
752     Position lastPositionToSelect;
753
754     // step 4 : handle trailing newline
755     if (fragment.hasInterchangeNewlineAtEnd()) {
756         removeLinePlaceholderIfNeeded(linePlaceholder);
757
758         if (!m_lastNodeInserted) {
759             lastPositionToSelect = endingSelection().end().downstream();
760         }
761         else {
762             bool insertParagraph = false;
763             VisiblePosition pos(insertionPos, VP_DEFAULT_AFFINITY);
764             
765             if (startBlock == endBlock && !fragment.isBlockFlow(m_lastTopNodeInserted.get())) {
766                 insertParagraph = true;
767             } else {
768                 // Handle end-of-document case.
769                 updateLayout();
770                 if (isEndOfDocument(pos))
771                     insertParagraph = true;
772             }
773             if (insertParagraph) {
774                 setEndingSelection(insertionPos, DOWNSTREAM);
775                 insertParagraphSeparator();
776                 VisiblePosition next = pos.next();
777
778                 // Select up to the paragraph separator that was added.
779                 lastPositionToSelect = next.deepEquivalent().downstream();
780                 updateNodesInserted(lastPositionToSelect.node());
781             } else {
782                 // Select up to the preexising paragraph separator.
783                 VisiblePosition next = pos.next();
784                 lastPositionToSelect = next.deepEquivalent().downstream();
785             }
786         }
787     } else {
788         if (m_lastNodeInserted && m_lastNodeInserted->hasTagName(brTag) && !document()->inStrictMode()) {
789             updateLayout();
790             VisiblePosition pos(Position(m_lastNodeInserted.get(), 1), DOWNSTREAM);
791             if (isEndOfBlock(pos)) {
792                 Node *next = m_lastNodeInserted->traverseNextNode();
793                 bool hasTrailingBR = next && next->hasTagName(brTag) && m_lastNodeInserted->enclosingBlockFlowElement() == next->enclosingBlockFlowElement();
794                 if (!hasTrailingBR) {
795                     // Insert an "extra" BR at the end of the block. 
796                     insertNodeBefore(createBreakElement(document()).get(), m_lastNodeInserted.get());
797                 }
798             }
799         }
800         
801         if (beyondEndNode) {
802             VisiblePosition startOfParagraphToMove(Position(beyondEndNode, 0));
803             VisiblePosition endOfParagraphToMove = endOfParagraph(startOfParagraphToMove);
804             VisiblePosition destination(Position(m_lastNodeInserted->parentNode(), m_lastNodeInserted->nodeIndex() + 1));
805             moveParagraph(startOfParagraphToMove, endOfParagraphToMove, destination);
806         }
807     }
808     
809     if (!m_matchStyle)
810         fixupNodeStyles(fragment.nodes(), fragment.renderingInfo());
811     completeHTMLReplacement(lastPositionToSelect);
812     
813     // step 5 : mop up
814     removeLinePlaceholderIfNeeded(linePlaceholder);
815 }
816
817 void ReplaceSelectionCommand::removeLinePlaceholderIfNeeded(Node *linePlaceholder)
818 {
819     if (!linePlaceholder)
820         return;
821         
822     updateLayout();
823     if (linePlaceholder->inDocument()) {
824         VisiblePosition placeholderPos(linePlaceholder, linePlaceholder->renderer()->caretMinOffset(), DOWNSTREAM);
825         if (placeholderPos.next().isNull() ||
826             !(isStartOfParagraph(placeholderPos) && isEndOfParagraph(placeholderPos))) {
827             
828             removeNodeAndPruneAncestors(linePlaceholder);
829         }
830     }
831 }
832
833 void ReplaceSelectionCommand::completeHTMLReplacement(const Position &lastPositionToSelect)
834 {
835     Position start;
836     Position end;
837
838     if (m_firstNodeInserted && m_firstNodeInserted->inDocument() && m_lastNodeInserted && m_lastNodeInserted->inDocument()) {
839         // Find the last leaf.
840         Node *lastLeaf = m_lastNodeInserted.get();
841         while (1) {
842             Node *nextChild = lastLeaf->lastChild();
843             if (!nextChild)
844                 break;
845             lastLeaf = nextChild;
846         }
847     
848         // Find the first leaf.
849         Node *firstLeaf = m_firstNodeInserted.get();
850         while (1) {
851             Node *nextChild = firstLeaf->firstChild();
852             if (!nextChild)
853                 break;
854             firstLeaf = nextChild;
855         }
856         
857         // Call updateLayout so caretMinOffset and caretMaxOffset return correct values.
858         updateLayout();
859         start = Position(firstLeaf, firstLeaf->caretMinOffset());
860         end = Position(lastLeaf, lastLeaf->caretMaxOffset());
861
862         if (m_matchStyle) {
863             assert(m_insertionStyle);
864             applyStyle(m_insertionStyle.get(), start, end);
865         }    
866         
867         if (lastPositionToSelect.isNotNull())
868             end = lastPositionToSelect;
869     } else if (lastPositionToSelect.isNotNull())
870         start = end = lastPositionToSelect;
871     else
872         return;
873     
874     if (m_selectReplacement)
875         setEndingSelection(Selection(start, end, SEL_DEFAULT_AFFINITY));
876     else
877         setEndingSelection(end, SEL_DEFAULT_AFFINITY);
878     
879     rebalanceWhitespace();
880 }
881
882 EditAction ReplaceSelectionCommand::editingAction() const
883 {
884     return EditActionPaste;
885 }
886
887 void ReplaceSelectionCommand::insertNodeAfterAndUpdateNodesInserted(Node *insertChild, Node *refChild)
888 {
889     insertNodeAfter(insertChild, refChild);
890     updateNodesInserted(insertChild);
891 }
892
893 void ReplaceSelectionCommand::insertNodeAtAndUpdateNodesInserted(Node *insertChild, Node *refChild, int offset)
894 {
895     insertNodeAt(insertChild, refChild, offset);
896     updateNodesInserted(insertChild);
897 }
898
899 void ReplaceSelectionCommand::insertNodeBeforeAndUpdateNodesInserted(Node *insertChild, Node *refChild)
900 {
901     insertNodeBefore(insertChild, refChild);
902     updateNodesInserted(insertChild);
903 }
904
905 void ReplaceSelectionCommand::updateNodesInserted(Node *node)
906 {
907     if (!node)
908         return;
909
910     m_lastTopNodeInserted = node;
911     if (!m_firstNodeInserted)
912         m_firstNodeInserted = node;
913     
914     if (node == m_lastNodeInserted)
915         return;
916     
917     m_lastNodeInserted = node->lastDescendant();
918 }
919
920 } // namespace WebCore