CTTE: Thread references through markup.h
[WebKit-https.git] / Source / WebCore / editing / markup.cpp
1 /*
2  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2013 Apple Inc. All rights reserved.
3  * Copyright (C) 2008, 2009, 2010, 2011 Google Inc. All rights reserved.
4  * Copyright (C) 2011 Igalia S.L.
5  * Copyright (C) 2011 Motorola Mobility. All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
20  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
23  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
24  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
27  */
28
29 #include "config.h"
30 #include "markup.h"
31
32 #include "CDATASection.h"
33 #include "CSSPrimitiveValue.h"
34 #include "CSSPropertyNames.h"
35 #include "CSSValue.h"
36 #include "CSSValueKeywords.h"
37 #include "ChildListMutationScope.h"
38 #include "DocumentFragment.h"
39 #include "DocumentType.h"
40 #include "Editor.h"
41 #include "ElementIterator.h"
42 #include "ExceptionCode.h"
43 #include "ExceptionCodePlaceholder.h"
44 #include "Frame.h"
45 #include "HTMLBodyElement.h"
46 #include "HTMLElement.h"
47 #include "HTMLNames.h"
48 #include "HTMLTableElement.h"
49 #include "HTMLTextAreaElement.h"
50 #include "HTMLTextFormControlElement.h"
51 #include "URL.h"
52 #include "MarkupAccumulator.h"
53 #include "Range.h"
54 #include "RenderBlock.h"
55 #include "StylePropertySet.h"
56 #include "TextIterator.h"
57 #include "VisibleSelection.h"
58 #include "VisibleUnits.h"
59 #include "htmlediting.h"
60 #include <wtf/StdLibExtras.h>
61 #include <wtf/text/StringBuilder.h>
62
63 #if ENABLE(DELETION_UI)
64 #include "DeleteButtonController.h"
65 #endif
66
67 using namespace std;
68
69 namespace WebCore {
70
71 using namespace HTMLNames;
72
73 static bool propertyMissingOrEqualToNone(StylePropertySet*, CSSPropertyID);
74
75 class AttributeChange {
76 public:
77     AttributeChange()
78         : m_name(nullAtom, nullAtom, nullAtom)
79     {
80     }
81
82     AttributeChange(PassRefPtr<Element> element, const QualifiedName& name, const String& value)
83         : m_element(element), m_name(name), m_value(value)
84     {
85     }
86
87     void apply()
88     {
89         m_element->setAttribute(m_name, m_value);
90     }
91
92 private:
93     RefPtr<Element> m_element;
94     QualifiedName m_name;
95     String m_value;
96 };
97
98 static void completeURLs(DocumentFragment* fragment, const String& baseURL)
99 {
100     Vector<AttributeChange> changes;
101
102     URL parsedBaseURL(ParsedURLString, baseURL);
103
104     for (auto element = elementDescendants(fragment).begin(), end = elementDescendants(fragment).end(); element != end; ++element) {
105         if (!element->hasAttributes())
106             continue;
107         unsigned length = element->attributeCount();
108         for (unsigned i = 0; i < length; i++) {
109             const Attribute& attribute = element->attributeAt(i);
110             if (element->isURLAttribute(attribute) && !attribute.value().isEmpty())
111                 changes.append(AttributeChange(&*element, attribute.name(), URL(parsedBaseURL, attribute.value()).string()));
112         }
113     }
114
115     size_t numChanges = changes.size();
116     for (size_t i = 0; i < numChanges; ++i)
117         changes[i].apply();
118 }
119     
120 class StyledMarkupAccumulator final : public MarkupAccumulator {
121 public:
122     enum RangeFullySelectsNode { DoesFullySelectNode, DoesNotFullySelectNode };
123
124     StyledMarkupAccumulator(Vector<Node*>* nodes, EAbsoluteURLs, EAnnotateForInterchange, const Range*, Node* highestNodeToBeSerialized = 0);
125
126     Node* serializeNodes(Node* startNode, Node* pastEnd);
127     void wrapWithNode(Node&, bool convertBlocksToInlines = false, RangeFullySelectsNode = DoesFullySelectNode);
128     void wrapWithStyleNode(StylePropertySet*, Document&, bool isBlock = false);
129     String takeResults();
130
131     using MarkupAccumulator::appendString;
132
133 private:
134     void appendStyleNodeOpenTag(StringBuilder&, StylePropertySet*, Document&, bool isBlock = false);
135     const String& styleNodeCloseTag(bool isBlock = false);
136
137     String renderedText(const Node&, const Range*);
138     String stringValueForRange(const Node&, const Range*);
139
140     void appendElement(StringBuilder& out, const Element&, bool addDisplayInline, RangeFullySelectsNode);
141
142     virtual void appendText(StringBuilder& out, const Text&) override;
143     virtual void appendElement(StringBuilder& out, const Element& element, Namespaces*) override
144     {
145         appendElement(out, element, false, DoesFullySelectNode);
146     }
147
148     enum NodeTraversalMode { EmitString, DoNotEmitString };
149     Node* traverseNodesForSerialization(Node* startNode, Node* pastEnd, NodeTraversalMode);
150
151     bool shouldAnnotate()
152     {
153         return m_shouldAnnotate == AnnotateForInterchange;
154     }
155
156     bool shouldApplyWrappingStyle(const Node& node) const
157     {
158         return m_highestNodeToBeSerialized && m_highestNodeToBeSerialized->parentNode() == node.parentNode() && m_wrappingStyle && m_wrappingStyle->style();
159     }
160
161     Vector<String> m_reversedPrecedingMarkup;
162     const EAnnotateForInterchange m_shouldAnnotate;
163     Node* m_highestNodeToBeSerialized;
164     RefPtr<EditingStyle> m_wrappingStyle;
165 };
166
167 inline StyledMarkupAccumulator::StyledMarkupAccumulator(Vector<Node*>* nodes, EAbsoluteURLs shouldResolveURLs, EAnnotateForInterchange shouldAnnotate,
168     const Range* range, Node* highestNodeToBeSerialized)
169     : MarkupAccumulator(nodes, shouldResolveURLs, range)
170     , m_shouldAnnotate(shouldAnnotate)
171     , m_highestNodeToBeSerialized(highestNodeToBeSerialized)
172 {
173 }
174
175 void StyledMarkupAccumulator::wrapWithNode(Node& node, bool convertBlocksToInlines, RangeFullySelectsNode rangeFullySelectsNode)
176 {
177     StringBuilder markup;
178     if (node.isElementNode())
179         appendElement(markup, toElement(node), convertBlocksToInlines && isBlock(&node), rangeFullySelectsNode);
180     else
181         appendStartMarkup(markup, node, 0);
182     m_reversedPrecedingMarkup.append(markup.toString());
183     appendEndTag(node);
184     if (m_nodes)
185         m_nodes->append(&node);
186 }
187
188 void StyledMarkupAccumulator::wrapWithStyleNode(StylePropertySet* style, Document& document, bool isBlock)
189 {
190     StringBuilder openTag;
191     appendStyleNodeOpenTag(openTag, style, document, isBlock);
192     m_reversedPrecedingMarkup.append(openTag.toString());
193     appendString(styleNodeCloseTag(isBlock));
194 }
195
196 void StyledMarkupAccumulator::appendStyleNodeOpenTag(StringBuilder& out, StylePropertySet* style, Document& document, bool isBlock)
197 {
198     // wrappingStyleForSerialization should have removed -webkit-text-decorations-in-effect
199     ASSERT(propertyMissingOrEqualToNone(style, CSSPropertyWebkitTextDecorationsInEffect));
200     if (isBlock)
201         out.appendLiteral("<div style=\"");
202     else
203         out.appendLiteral("<span style=\"");
204     appendAttributeValue(out, style->asText(), document.isHTMLDocument());
205     out.appendLiteral("\">");
206 }
207
208 const String& StyledMarkupAccumulator::styleNodeCloseTag(bool isBlock)
209 {
210     DEFINE_STATIC_LOCAL(const String, divClose, (ASCIILiteral("</div>")));
211     DEFINE_STATIC_LOCAL(const String, styleSpanClose, (ASCIILiteral("</span>")));
212     return isBlock ? divClose : styleSpanClose;
213 }
214
215 String StyledMarkupAccumulator::takeResults()
216 {
217     StringBuilder result;
218     result.reserveCapacity(totalLength(m_reversedPrecedingMarkup) + length());
219
220     for (size_t i = m_reversedPrecedingMarkup.size(); i > 0; --i)
221         result.append(m_reversedPrecedingMarkup[i - 1]);
222
223     concatenateMarkup(result);
224
225     // We remove '\0' characters because they are not visibly rendered to the user.
226     return result.toString().replaceWithLiteral('\0', "");
227 }
228
229 void StyledMarkupAccumulator::appendText(StringBuilder& out, const Text& text)
230 {    
231     const bool parentIsTextarea = text.parentElement() && isHTMLTextAreaElement(text.parentElement());
232     const bool wrappingSpan = shouldApplyWrappingStyle(text) && !parentIsTextarea;
233     if (wrappingSpan) {
234         RefPtr<EditingStyle> wrappingStyle = m_wrappingStyle->copy();
235         // FIXME: <rdar://problem/5371536> Style rules that match pasted content can change it's appearance
236         // Make sure spans are inline style in paste side e.g. span { display: block }.
237         wrappingStyle->forceInline();
238         // FIXME: Should this be included in forceInline?
239         wrappingStyle->style()->setProperty(CSSPropertyFloat, CSSValueNone);
240
241         appendStyleNodeOpenTag(out, wrappingStyle->style(), text.document());
242     }
243
244     if (!shouldAnnotate() || parentIsTextarea)
245         MarkupAccumulator::appendText(out, text);
246     else {
247         const bool useRenderedText = !enclosingNodeWithTag(firstPositionInNode(const_cast<Text*>(&text)), selectTag);
248         String content = useRenderedText ? renderedText(text, m_range) : stringValueForRange(text, m_range);
249         StringBuilder buffer;
250         appendCharactersReplacingEntities(buffer, content, 0, content.length(), EntityMaskInPCDATA);
251         out.append(convertHTMLTextToInterchangeFormat(buffer.toString(), &text));
252     }
253
254     if (wrappingSpan)
255         out.append(styleNodeCloseTag());
256 }
257     
258 String StyledMarkupAccumulator::renderedText(const Node& node, const Range* range)
259 {
260     if (!node.isTextNode())
261         return String();
262
263     const Text& textNode = toText(node);
264     unsigned startOffset = 0;
265     unsigned endOffset = textNode.length();
266
267     if (range && &node == range->startContainer())
268         startOffset = range->startOffset();
269     if (range && &node == range->endContainer())
270         endOffset = range->endOffset();
271
272     Position start = createLegacyEditingPosition(const_cast<Node*>(&node), startOffset);
273     Position end = createLegacyEditingPosition(const_cast<Node*>(&node), endOffset);
274     return plainText(Range::create(&node.document(), start, end).get());
275 }
276
277 String StyledMarkupAccumulator::stringValueForRange(const Node& node, const Range* range)
278 {
279     if (!range)
280         return node.nodeValue();
281
282     String nodeValue = node.nodeValue();
283     if (&node == range->endContainer())
284         nodeValue.truncate(range->endOffset());
285     if (&node == range->startContainer())
286         nodeValue.remove(0, range->startOffset());
287     return nodeValue;
288 }
289
290 void StyledMarkupAccumulator::appendElement(StringBuilder& out, const Element& element, bool addDisplayInline, RangeFullySelectsNode rangeFullySelectsNode)
291 {
292     const bool documentIsHTML = element.document().isHTMLDocument();
293     appendOpenTag(out, element, 0);
294
295     const unsigned length = element.hasAttributes() ? element.attributeCount() : 0;
296     const bool shouldAnnotateOrForceInline = element.isHTMLElement() && (shouldAnnotate() || addDisplayInline);
297     const bool shouldOverrideStyleAttr = shouldAnnotateOrForceInline || shouldApplyWrappingStyle(element);
298     for (unsigned i = 0; i < length; ++i) {
299         const Attribute& attribute = element.attributeAt(i);
300         // We'll handle the style attribute separately, below.
301         if (attribute.name() == styleAttr && shouldOverrideStyleAttr)
302             continue;
303         appendAttribute(out, element, attribute, 0);
304     }
305
306     if (shouldOverrideStyleAttr) {
307         RefPtr<EditingStyle> newInlineStyle;
308
309         if (shouldApplyWrappingStyle(element)) {
310             newInlineStyle = m_wrappingStyle->copy();
311             newInlineStyle->removePropertiesInElementDefaultStyle(const_cast<Element*>(&element));
312             newInlineStyle->removeStyleConflictingWithStyleOfNode(const_cast<Element*>(&element));
313         } else
314             newInlineStyle = EditingStyle::create();
315
316         if (element.isStyledElement() && toStyledElement(element).inlineStyle())
317             newInlineStyle->overrideWithStyle(toStyledElement(element).inlineStyle());
318
319         if (shouldAnnotateOrForceInline) {
320             if (shouldAnnotate())
321                 newInlineStyle->mergeStyleFromRulesForSerialization(toHTMLElement(const_cast<Element*>(&element)));
322
323             if (addDisplayInline)
324                 newInlineStyle->forceInline();
325
326             // If the node is not fully selected by the range, then we don't want to keep styles that affect its relationship to the nodes around it
327             // only the ones that affect it and the nodes within it.
328             if (rangeFullySelectsNode == DoesNotFullySelectNode && newInlineStyle->style())
329                 newInlineStyle->style()->removeProperty(CSSPropertyFloat);
330         }
331
332         if (!newInlineStyle->isEmpty()) {
333             out.appendLiteral(" style=\"");
334             appendAttributeValue(out, newInlineStyle->style()->asText(), documentIsHTML);
335             out.append('\"');
336         }
337     }
338
339     appendCloseTag(out, element);
340 }
341
342 Node* StyledMarkupAccumulator::serializeNodes(Node* startNode, Node* pastEnd)
343 {
344     if (!m_highestNodeToBeSerialized) {
345         Node* lastClosed = traverseNodesForSerialization(startNode, pastEnd, DoNotEmitString);
346         m_highestNodeToBeSerialized = lastClosed;
347     }
348
349     if (m_highestNodeToBeSerialized && m_highestNodeToBeSerialized->parentNode())
350         m_wrappingStyle = EditingStyle::wrappingStyleForSerialization(m_highestNodeToBeSerialized->parentNode(), shouldAnnotate());
351
352     return traverseNodesForSerialization(startNode, pastEnd, EmitString);
353 }
354
355 Node* StyledMarkupAccumulator::traverseNodesForSerialization(Node* startNode, Node* pastEnd, NodeTraversalMode traversalMode)
356 {
357     const bool shouldEmit = traversalMode == EmitString;
358     Vector<Node*> ancestorsToClose;
359     Node* next;
360     Node* lastClosed = 0;
361     for (Node* n = startNode; n != pastEnd; n = next) {
362         // According to <rdar://problem/5730668>, it is possible for n to blow
363         // past pastEnd and become null here. This shouldn't be possible.
364         // This null check will prevent crashes (but create too much markup)
365         // and the ASSERT will hopefully lead us to understanding the problem.
366         ASSERT(n);
367         if (!n)
368             break;
369         
370         next = NodeTraversal::next(n);
371         bool openedTag = false;
372
373         if (isBlock(n) && canHaveChildrenForEditing(n) && next == pastEnd)
374             // Don't write out empty block containers that aren't fully selected.
375             continue;
376
377         if (!n->renderer() && !enclosingNodeWithTag(firstPositionInOrBeforeNode(n), selectTag)) {
378             next = NodeTraversal::nextSkippingChildren(n);
379             // Don't skip over pastEnd.
380             if (pastEnd && pastEnd->isDescendantOf(n))
381                 next = pastEnd;
382         } else {
383             // Add the node to the markup if we're not skipping the descendants
384             if (shouldEmit)
385                 appendStartTag(*n);
386
387             // If node has no children, close the tag now.
388             if (!n->childNodeCount()) {
389                 if (shouldEmit)
390                     appendEndTag(*n);
391                 lastClosed = n;
392             } else {
393                 openedTag = true;
394                 ancestorsToClose.append(n);
395             }
396         }
397
398         // If we didn't insert open tag and there's no more siblings or we're at the end of the traversal, take care of ancestors.
399         // FIXME: What happens if we just inserted open tag and reached the end?
400         if (!openedTag && (!n->nextSibling() || next == pastEnd)) {
401             // Close up the ancestors.
402             while (!ancestorsToClose.isEmpty()) {
403                 Node* ancestor = ancestorsToClose.last();
404                 if (next != pastEnd && next->isDescendantOf(ancestor))
405                     break;
406                 // Not at the end of the range, close ancestors up to sibling of next node.
407                 if (shouldEmit)
408                     appendEndTag(*ancestor);
409                 lastClosed = ancestor;
410                 ancestorsToClose.removeLast();
411             }
412
413             // Surround the currently accumulated markup with markup for ancestors we never opened as we leave the subtree(s) rooted at those ancestors.
414             ContainerNode* nextParent = next ? next->parentNode() : 0;
415             if (next != pastEnd && n != nextParent) {
416                 Node* lastAncestorClosedOrSelf = n->isDescendantOf(lastClosed) ? lastClosed : n;
417                 for (ContainerNode* parent = lastAncestorClosedOrSelf->parentNode(); parent && parent != nextParent; parent = parent->parentNode()) {
418                     // All ancestors that aren't in the ancestorsToClose list should either be a) unrendered:
419                     if (!parent->renderer())
420                         continue;
421                     // or b) ancestors that we never encountered during a pre-order traversal starting at startNode:
422                     ASSERT(startNode->isDescendantOf(parent));
423                     if (shouldEmit)
424                         wrapWithNode(*parent);
425                     lastClosed = parent;
426                 }
427             }
428         }
429     }
430
431     return lastClosed;
432 }
433
434 static bool isHTMLBlockElement(const Node* node)
435 {
436     return node->hasTagName(tdTag)
437         || node->hasTagName(thTag)
438         || isNonTableCellHTMLBlockElement(node);
439 }
440
441 static Node* ancestorToRetainStructureAndAppearanceForBlock(Node* commonAncestorBlock)
442 {
443     if (!commonAncestorBlock)
444         return 0;
445
446     if (commonAncestorBlock->hasTagName(tbodyTag) || commonAncestorBlock->hasTagName(trTag)) {
447         ContainerNode* table = commonAncestorBlock->parentNode();
448         while (table && !isHTMLTableElement(table))
449             table = table->parentNode();
450
451         return table;
452     }
453
454     if (isNonTableCellHTMLBlockElement(commonAncestorBlock))
455         return commonAncestorBlock;
456
457     return 0;
458 }
459
460 static inline Node* ancestorToRetainStructureAndAppearance(Node* commonAncestor)
461 {
462     return ancestorToRetainStructureAndAppearanceForBlock(enclosingBlock(commonAncestor));
463 }
464
465 static inline Node* ancestorToRetainStructureAndAppearanceWithNoRenderer(Node* commonAncestor)
466 {
467     Node* commonAncestorBlock = enclosingNodeOfType(firstPositionInOrBeforeNode(commonAncestor), isHTMLBlockElement);
468     return ancestorToRetainStructureAndAppearanceForBlock(commonAncestorBlock);
469 }
470
471 static bool propertyMissingOrEqualToNone(StylePropertySet* style, CSSPropertyID propertyID)
472 {
473     if (!style)
474         return false;
475     RefPtr<CSSValue> value = style->getPropertyCSSValue(propertyID);
476     if (!value)
477         return true;
478     if (!value->isPrimitiveValue())
479         return false;
480     return toCSSPrimitiveValue(value.get())->getValueID() == CSSValueNone;
481 }
482
483 static bool needInterchangeNewlineAfter(const VisiblePosition& v)
484 {
485     VisiblePosition next = v.next();
486     Node* upstreamNode = next.deepEquivalent().upstream().deprecatedNode();
487     Node* downstreamNode = v.deepEquivalent().downstream().deprecatedNode();
488     // Add an interchange newline if a paragraph break is selected and a br won't already be added to the markup to represent it.
489     return isEndOfParagraph(v) && isStartOfParagraph(next) && !(upstreamNode->hasTagName(brTag) && upstreamNode == downstreamNode);
490 }
491
492 static PassRefPtr<EditingStyle> styleFromMatchedRulesAndInlineDecl(const Node* node)
493 {
494     if (!node->isHTMLElement())
495         return 0;
496
497     // FIXME: Having to const_cast here is ugly, but it is quite a bit of work to untangle
498     // the non-const-ness of styleFromMatchedRulesForElement.
499     HTMLElement* element = const_cast<HTMLElement*>(static_cast<const HTMLElement*>(node));
500     RefPtr<EditingStyle> style = EditingStyle::create(element->inlineStyle());
501     style->mergeStyleFromRules(element);
502     return style.release();
503 }
504
505 static bool isElementPresentational(const Node* node)
506 {
507     return node->hasTagName(uTag) || node->hasTagName(sTag) || node->hasTagName(strikeTag)
508         || node->hasTagName(iTag) || node->hasTagName(emTag) || node->hasTagName(bTag) || node->hasTagName(strongTag);
509 }
510
511 static Node* highestAncestorToWrapMarkup(const Range* range, EAnnotateForInterchange shouldAnnotate)
512 {
513     Node* commonAncestor = range->commonAncestorContainer(IGNORE_EXCEPTION);
514     ASSERT(commonAncestor);
515     Node* specialCommonAncestor = 0;
516     if (shouldAnnotate == AnnotateForInterchange) {
517         // Include ancestors that aren't completely inside the range but are required to retain 
518         // the structure and appearance of the copied markup.
519         specialCommonAncestor = ancestorToRetainStructureAndAppearance(commonAncestor);
520
521         if (Node* parentListNode = enclosingNodeOfType(firstPositionInOrBeforeNode(range->firstNode()), isListItem)) {
522             if (WebCore::areRangesEqual(VisibleSelection::selectionFromContentsOfNode(parentListNode).toNormalizedRange().get(), range)) {
523                 specialCommonAncestor = parentListNode->parentNode();
524                 while (specialCommonAncestor && !isListElement(specialCommonAncestor))
525                     specialCommonAncestor = specialCommonAncestor->parentNode();
526             }
527         }
528
529         // Retain the Mail quote level by including all ancestor mail block quotes.
530         if (Node* highestMailBlockquote = highestEnclosingNodeOfType(firstPositionInOrBeforeNode(range->firstNode()), isMailBlockquote, CanCrossEditingBoundary))
531             specialCommonAncestor = highestMailBlockquote;
532     }
533
534     Node* checkAncestor = specialCommonAncestor ? specialCommonAncestor : commonAncestor;
535     if (checkAncestor->renderer() && checkAncestor->renderer()->containingBlock()) {
536         Node* newSpecialCommonAncestor = highestEnclosingNodeOfType(firstPositionInNode(checkAncestor), &isElementPresentational, CanCrossEditingBoundary, checkAncestor->renderer()->containingBlock()->element());
537         if (newSpecialCommonAncestor)
538             specialCommonAncestor = newSpecialCommonAncestor;
539     }
540
541     // If a single tab is selected, commonAncestor will be a text node inside a tab span.
542     // If two or more tabs are selected, commonAncestor will be the tab span.
543     // In either case, if there is a specialCommonAncestor already, it will necessarily be above 
544     // any tab span that needs to be included.
545     if (!specialCommonAncestor && isTabSpanTextNode(commonAncestor))
546         specialCommonAncestor = commonAncestor->parentNode();
547     if (!specialCommonAncestor && isTabSpanNode(commonAncestor))
548         specialCommonAncestor = commonAncestor;
549
550     if (Node *enclosingAnchor = enclosingNodeWithTag(firstPositionInNode(specialCommonAncestor ? specialCommonAncestor : commonAncestor), aTag))
551         specialCommonAncestor = enclosingAnchor;
552
553     return specialCommonAncestor;
554 }
555
556 // FIXME: Shouldn't we omit style info when annotate == DoNotAnnotateForInterchange? 
557 // FIXME: At least, annotation and style info should probably not be included in range.markupString()
558 static String createMarkupInternal(Document& document, const Range& range, const Range& updatedRange, Vector<Node*>* nodes,
559     EAnnotateForInterchange shouldAnnotate, bool convertBlocksToInlines, EAbsoluteURLs shouldResolveURLs)
560 {
561     DEFINE_STATIC_LOCAL(const String, interchangeNewlineString, (ASCIILiteral("<br class=\"" AppleInterchangeNewline "\">")));
562
563     bool collapsed = updatedRange.collapsed(ASSERT_NO_EXCEPTION);
564     if (collapsed)
565         return emptyString();
566     Node* commonAncestor = updatedRange.commonAncestorContainer(ASSERT_NO_EXCEPTION);
567     if (!commonAncestor)
568         return emptyString();
569
570     document.updateLayoutIgnorePendingStylesheets();
571
572     Node* body = enclosingNodeWithTag(firstPositionInNode(commonAncestor), bodyTag);
573     Node* fullySelectedRoot = 0;
574     // FIXME: Do this for all fully selected blocks, not just the body.
575     if (body && areRangesEqual(VisibleSelection::selectionFromContentsOfNode(body).toNormalizedRange().get(), &range))
576         fullySelectedRoot = body;
577     Node* specialCommonAncestor = highestAncestorToWrapMarkup(&updatedRange, shouldAnnotate);
578
579     StyledMarkupAccumulator accumulator(nodes, shouldResolveURLs, shouldAnnotate, &updatedRange, specialCommonAncestor);
580     Node* pastEnd = updatedRange.pastLastNode();
581
582     Node* startNode = updatedRange.firstNode();
583     VisiblePosition visibleStart(updatedRange.startPosition(), VP_DEFAULT_AFFINITY);
584     VisiblePosition visibleEnd(updatedRange.endPosition(), VP_DEFAULT_AFFINITY);
585     if (shouldAnnotate == AnnotateForInterchange && needInterchangeNewlineAfter(visibleStart)) {
586         if (visibleStart == visibleEnd.previous())
587             return interchangeNewlineString;
588
589         accumulator.appendString(interchangeNewlineString);
590         startNode = visibleStart.next().deepEquivalent().deprecatedNode();
591
592         if (pastEnd && Range::compareBoundaryPoints(startNode, 0, pastEnd, 0, ASSERT_NO_EXCEPTION) >= 0)
593             return interchangeNewlineString;
594     }
595
596     Node* lastClosed = accumulator.serializeNodes(startNode, pastEnd);
597
598     if (specialCommonAncestor && lastClosed) {
599         // Also include all of the ancestors of lastClosed up to this special ancestor.
600         for (ContainerNode* ancestor = lastClosed->parentNode(); ancestor; ancestor = ancestor->parentNode()) {
601             if (ancestor == fullySelectedRoot && !convertBlocksToInlines) {
602                 RefPtr<EditingStyle> fullySelectedRootStyle = styleFromMatchedRulesAndInlineDecl(fullySelectedRoot);
603
604                 // Bring the background attribute over, but not as an attribute because a background attribute on a div
605                 // appears to have no effect.
606                 if ((!fullySelectedRootStyle || !fullySelectedRootStyle->style() || !fullySelectedRootStyle->style()->getPropertyCSSValue(CSSPropertyBackgroundImage))
607                     && toElement(fullySelectedRoot)->hasAttribute(backgroundAttr))
608                     fullySelectedRootStyle->style()->setProperty(CSSPropertyBackgroundImage, "url('" + toElement(fullySelectedRoot)->getAttribute(backgroundAttr) + "')");
609
610                 if (fullySelectedRootStyle->style()) {
611                     // Reset the CSS properties to avoid an assertion error in addStyleMarkup().
612                     // This assertion is caused at least when we select all text of a <body> element whose
613                     // 'text-decoration' property is "inherit", and copy it.
614                     if (!propertyMissingOrEqualToNone(fullySelectedRootStyle->style(), CSSPropertyTextDecoration))
615                         fullySelectedRootStyle->style()->setProperty(CSSPropertyTextDecoration, CSSValueNone);
616                     if (!propertyMissingOrEqualToNone(fullySelectedRootStyle->style(), CSSPropertyWebkitTextDecorationsInEffect))
617                         fullySelectedRootStyle->style()->setProperty(CSSPropertyWebkitTextDecorationsInEffect, CSSValueNone);
618                     accumulator.wrapWithStyleNode(fullySelectedRootStyle->style(), document, true);
619                 }
620             } else {
621                 // Since this node and all the other ancestors are not in the selection we want to set RangeFullySelectsNode to DoesNotFullySelectNode
622                 // so that styles that affect the exterior of the node are not included.
623                 accumulator.wrapWithNode(*ancestor, convertBlocksToInlines, StyledMarkupAccumulator::DoesNotFullySelectNode);
624             }
625             if (nodes)
626                 nodes->append(ancestor);
627             
628             lastClosed = ancestor;
629             
630             if (ancestor == specialCommonAncestor)
631                 break;
632         }
633     }
634
635     // FIXME: The interchange newline should be placed in the block that it's in, not after all of the content, unconditionally.
636     if (shouldAnnotate == AnnotateForInterchange && needInterchangeNewlineAfter(visibleEnd.previous()))
637         accumulator.appendString(interchangeNewlineString);
638
639     return accumulator.takeResults();
640 }
641
642 String createMarkup(const Range& range, Vector<Node*>* nodes, EAnnotateForInterchange shouldAnnotate, bool convertBlocksToInlines, EAbsoluteURLs shouldResolveURLs)
643 {
644     Document& document = range.ownerDocument();
645     const Range* updatedRange = &range;
646
647 #if ENABLE(DELETION_UI)
648     // Disable the delete button so it's elements are not serialized into the markup,
649     // but make sure neither endpoint is inside the delete user interface.
650     Frame* frame = document.frame();
651     DeleteButtonControllerDisableScope deleteButtonControllerDisableScope(frame);
652
653     RefPtr<Range> updatedRangeRef;
654     if (frame) {
655         updatedRangeRef = frame->editor().avoidIntersectionWithDeleteButtonController(&range);
656         updatedRange = updatedRangeRef.get();
657         if (!updatedRange)
658             return emptyString();
659     }
660 #endif
661
662     return createMarkupInternal(document, range, *updatedRange, nodes, shouldAnnotate, convertBlocksToInlines, shouldResolveURLs);
663 }
664
665 PassRefPtr<DocumentFragment> createFragmentFromMarkup(Document& document, const String& markup, const String& baseURL, ParserContentPolicy parserContentPolicy)
666 {
667     // We use a fake body element here to trick the HTML parser to using the InBody insertion mode.
668     RefPtr<HTMLBodyElement> fakeBody = HTMLBodyElement::create(document);
669     RefPtr<DocumentFragment> fragment = DocumentFragment::create(document);
670
671     fragment->parseHTML(markup, fakeBody.get(), parserContentPolicy);
672
673     if (!baseURL.isEmpty() && baseURL != blankURL() && baseURL != document.baseURL())
674         completeURLs(fragment.get(), baseURL);
675
676     return fragment.release();
677 }
678
679 String createMarkup(const Node& node, EChildrenOnly childrenOnly, Vector<Node*>* nodes, EAbsoluteURLs shouldResolveURLs, Vector<QualifiedName>* tagNamesToSkip, EFragmentSerialization fragmentSerialization)
680 {
681     HTMLElement* deleteButtonContainerElement = 0;
682 #if ENABLE(DELETION_UI)
683     if (Frame* frame = node.document().frame()) {
684         deleteButtonContainerElement = frame->editor().deleteButtonController().containerElement();
685         if (node.isDescendantOf(deleteButtonContainerElement))
686             return emptyString();
687     }
688 #endif
689
690     MarkupAccumulator accumulator(nodes, shouldResolveURLs, 0, fragmentSerialization);
691     return accumulator.serializeNodes(const_cast<Node&>(node), deleteButtonContainerElement, childrenOnly, tagNamesToSkip);
692 }
693
694 static void fillContainerFromString(ContainerNode* paragraph, const String& string)
695 {
696     Document& document = paragraph->document();
697
698     if (string.isEmpty()) {
699         paragraph->appendChild(createBlockPlaceholderElement(document), ASSERT_NO_EXCEPTION);
700         return;
701     }
702
703     ASSERT(string.find('\n') == notFound);
704
705     Vector<String> tabList;
706     string.split('\t', true, tabList);
707     String tabText = emptyString();
708     bool first = true;
709     size_t numEntries = tabList.size();
710     for (size_t i = 0; i < numEntries; ++i) {
711         const String& s = tabList[i];
712
713         // append the non-tab textual part
714         if (!s.isEmpty()) {
715             if (!tabText.isEmpty()) {
716                 paragraph->appendChild(createTabSpanElement(document, tabText), ASSERT_NO_EXCEPTION);
717                 tabText = emptyString();
718             }
719             RefPtr<Node> textNode = document.createTextNode(stringWithRebalancedWhitespace(s, first, i + 1 == numEntries));
720             paragraph->appendChild(textNode.release(), ASSERT_NO_EXCEPTION);
721         }
722
723         // there is a tab after every entry, except the last entry
724         // (if the last character is a tab, the list gets an extra empty entry)
725         if (i + 1 != numEntries)
726             tabText.append('\t');
727         else if (!tabText.isEmpty())
728             paragraph->appendChild(createTabSpanElement(document, tabText), ASSERT_NO_EXCEPTION);
729
730         first = false;
731     }
732 }
733
734 bool isPlainTextMarkup(Node *node)
735 {
736     if (!node->isElementNode() || !node->hasTagName(divTag) || toElement(node)->hasAttributes())
737         return false;
738     
739     if (node->childNodeCount() == 1 && (node->firstChild()->isTextNode() || (node->firstChild()->firstChild())))
740         return true;
741     
742     return (node->childNodeCount() == 2 && isTabSpanTextNode(node->firstChild()->firstChild()) && node->firstChild()->nextSibling()->isTextNode());
743 }
744
745 static bool contextPreservesNewline(const Range& context)
746 {
747     VisiblePosition position(context.startPosition());
748     Node* container = position.deepEquivalent().containerNode();
749     if (!container || !container->renderer())
750         return false;
751
752     return container->renderer()->style()->preserveNewline();
753 }
754
755 PassRefPtr<DocumentFragment> createFragmentFromText(Range* context, const String& text)
756 {
757     if (!context)
758         return 0;
759
760     Document& document = context->ownerDocument();
761     RefPtr<DocumentFragment> fragment = document.createDocumentFragment();
762     
763     if (text.isEmpty())
764         return fragment.release();
765
766     String string = text;
767     string.replace("\r\n", "\n");
768     string.replace('\r', '\n');
769
770     if (contextPreservesNewline(*context)) {
771         fragment->appendChild(document.createTextNode(string), ASSERT_NO_EXCEPTION);
772         if (string.endsWith('\n')) {
773             RefPtr<Element> element = createBreakElement(document);
774             element->setAttribute(classAttr, AppleInterchangeNewline);            
775             fragment->appendChild(element.release(), ASSERT_NO_EXCEPTION);
776         }
777         return fragment.release();
778     }
779
780     // A string with no newlines gets added inline, rather than being put into a paragraph.
781     if (string.find('\n') == notFound) {
782         fillContainerFromString(fragment.get(), string);
783         return fragment.release();
784     }
785
786     // Break string into paragraphs. Extra line breaks turn into empty paragraphs.
787     Node* blockNode = enclosingBlock(context->firstNode());
788     Element* block = toElement(blockNode);
789     bool useClonesOfEnclosingBlock = blockNode
790         && blockNode->isElementNode()
791         && !block->hasTagName(bodyTag)
792         && !block->hasTagName(htmlTag)
793         && block != editableRootForPosition(context->startPosition());
794     bool useLineBreak = enclosingTextFormControl(context->startPosition());
795
796     Vector<String> list;
797     string.split('\n', true, list); // true gets us empty strings in the list
798     size_t numLines = list.size();
799     for (size_t i = 0; i < numLines; ++i) {
800         const String& s = list[i];
801
802         RefPtr<Element> element;
803         if (s.isEmpty() && i + 1 == numLines) {
804             // For last line, use the "magic BR" rather than a P.
805             element = createBreakElement(document);
806             element->setAttribute(classAttr, AppleInterchangeNewline);
807         } else if (useLineBreak) {
808             element = createBreakElement(document);
809             fillContainerFromString(fragment.get(), s);
810         } else {
811             if (useClonesOfEnclosingBlock)
812                 element = block->cloneElementWithoutChildren();
813             else
814                 element = createDefaultParagraphElement(document);
815             fillContainerFromString(element.get(), s);
816         }
817         fragment->appendChild(element.release(), ASSERT_NO_EXCEPTION);
818     }
819     return fragment.release();
820 }
821
822 String documentTypeString(const Document& document)
823 {
824     DocumentType* documentType = document.doctype();
825     if (!documentType)
826         return emptyString();
827     return createMarkup(*documentType);
828 }
829
830 String createFullMarkup(const Node& node)
831 {
832     // FIXME: This is never "for interchange". Is that right?
833     String markupString = createMarkup(node, IncludeNode, 0);
834
835     Node::NodeType nodeType = node.nodeType();
836     if (nodeType != Node::DOCUMENT_NODE && nodeType != Node::DOCUMENT_TYPE_NODE)
837         markupString = documentTypeString(node.document()) + markupString;
838
839     return markupString;
840 }
841
842 String createFullMarkup(const Range& range)
843 {
844     Node* node = range.startContainer();
845     if (!node)
846         return String();
847
848     // FIXME: This is always "for interchange". Is that right?
849     return documentTypeString(node->document()) + createMarkup(range, 0, AnnotateForInterchange);
850 }
851
852 String urlToMarkup(const URL& url, const String& title)
853 {
854     StringBuilder markup;
855     markup.append("<a href=\"");
856     markup.append(url.string());
857     markup.append("\">");
858     MarkupAccumulator::appendCharactersReplacingEntities(markup, title, 0, title.length(), EntityMaskInPCDATA);
859     markup.append("</a>");
860     return markup.toString();
861 }
862
863 PassRefPtr<DocumentFragment> createFragmentForInnerOuterHTML(const String& markup, Element* contextElement, ParserContentPolicy parserContentPolicy, ExceptionCode& ec)
864 {
865     Document* document = &contextElement->document();
866 #if ENABLE(TEMPLATE_ELEMENT)
867     if (contextElement->hasTagName(templateTag))
868         document = document->ensureTemplateDocument();
869 #endif
870     RefPtr<DocumentFragment> fragment = DocumentFragment::create(*document);
871
872     if (document->isHTMLDocument()) {
873         fragment->parseHTML(markup, contextElement, parserContentPolicy);
874         return fragment;
875     }
876
877     bool wasValid = fragment->parseXML(markup, contextElement, parserContentPolicy);
878     if (!wasValid) {
879         ec = SYNTAX_ERR;
880         return 0;
881     }
882     return fragment.release();
883 }
884
885 PassRefPtr<DocumentFragment> createFragmentForTransformToFragment(const String& sourceString, const String& sourceMIMEType, Document* outputDoc)
886 {
887     RefPtr<DocumentFragment> fragment = outputDoc->createDocumentFragment();
888     
889     if (sourceMIMEType == "text/html") {
890         // As far as I can tell, there isn't a spec for how transformToFragment is supposed to work.
891         // Based on the documentation I can find, it looks like we want to start parsing the fragment in the InBody insertion mode.
892         // Unfortunately, that's an implementation detail of the parser.
893         // We achieve that effect here by passing in a fake body element as context for the fragment.
894         RefPtr<HTMLBodyElement> fakeBody = HTMLBodyElement::create(*outputDoc);
895         fragment->parseHTML(sourceString, fakeBody.get());
896     } else if (sourceMIMEType == "text/plain")
897         fragment->parserAppendChild(Text::create(*outputDoc, sourceString));
898     else {
899         bool successfulParse = fragment->parseXML(sourceString, 0);
900         if (!successfulParse)
901             return 0;
902     }
903     
904     // FIXME: Do we need to mess with URLs here?
905     
906     return fragment.release();
907 }
908
909 static inline void removeElementPreservingChildren(PassRefPtr<DocumentFragment> fragment, HTMLElement* element)
910 {
911     RefPtr<Node> nextChild;
912     for (RefPtr<Node> child = element->firstChild(); child; child = nextChild) {
913         nextChild = child->nextSibling();
914         element->removeChild(child.get(), ASSERT_NO_EXCEPTION);
915         fragment->insertBefore(child, element, ASSERT_NO_EXCEPTION);
916     }
917     fragment->removeChild(element, ASSERT_NO_EXCEPTION);
918 }
919
920 PassRefPtr<DocumentFragment> createContextualFragment(const String& markup, HTMLElement* element, ParserContentPolicy parserContentPolicy, ExceptionCode& ec)
921 {
922     ASSERT(element);
923     if (element->ieForbidsInsertHTML()) {
924         ec = NOT_SUPPORTED_ERR;
925         return 0;
926     }
927
928     if (element->hasLocalName(colTag) || element->hasLocalName(colgroupTag) || element->hasLocalName(framesetTag)
929         || element->hasLocalName(headTag) || element->hasLocalName(styleTag) || element->hasLocalName(titleTag)) {
930         ec = NOT_SUPPORTED_ERR;
931         return 0;
932     }
933
934     RefPtr<DocumentFragment> fragment = createFragmentForInnerOuterHTML(markup, element, parserContentPolicy, ec);
935     if (!fragment)
936         return 0;
937
938     // We need to pop <html> and <body> elements and remove <head> to
939     // accommodate folks passing complete HTML documents to make the
940     // child of an element.
941
942     RefPtr<HTMLElement> nextElement;
943     for (RefPtr<HTMLElement> element = Traversal<HTMLElement>::firstWithin(fragment.get()); element; element = nextElement) {
944         nextElement = Traversal<HTMLElement>::nextSibling(element.get());
945         if (element->hasTagName(htmlTag) || element->hasTagName(headTag) || element->hasTagName(bodyTag)) {
946             if (HTMLElement* firstChild = Traversal<HTMLElement>::firstChild(element.get()))
947                 nextElement = firstChild;
948             removeElementPreservingChildren(fragment, element.get());
949         }
950     }
951     return fragment.release();
952 }
953
954 static inline bool hasOneChild(ContainerNode* node)
955 {
956     Node* firstChild = node->firstChild();
957     return firstChild && !firstChild->nextSibling();
958 }
959
960 static inline bool hasOneTextChild(ContainerNode* node)
961 {
962     return hasOneChild(node) && node->firstChild()->isTextNode();
963 }
964
965 void replaceChildrenWithFragment(ContainerNode& container, PassRefPtr<DocumentFragment> fragment, ExceptionCode& ec)
966 {
967     Ref<ContainerNode> containerNode(container);
968     ChildListMutationScope mutation(containerNode.get());
969
970     if (!fragment->firstChild()) {
971         containerNode->removeChildren();
972         return;
973     }
974
975     if (hasOneTextChild(&containerNode.get()) && hasOneTextChild(fragment.get())) {
976         toText(containerNode->firstChild())->setData(toText(fragment->firstChild())->data(), ec);
977         return;
978     }
979
980     if (hasOneChild(&containerNode.get())) {
981         containerNode->replaceChild(fragment, containerNode->firstChild(), ec);
982         return;
983     }
984
985     containerNode->removeChildren();
986     containerNode->appendChild(fragment, ec);
987 }
988
989 void replaceChildrenWithText(ContainerNode& container, const String& text, ExceptionCode& ec)
990 {
991     Ref<ContainerNode> containerNode(container);
992     ChildListMutationScope mutation(containerNode.get());
993
994     if (hasOneTextChild(&containerNode.get())) {
995         toText(containerNode->firstChild())->setData(text, ec);
996         return;
997     }
998
999     RefPtr<Text> textNode = Text::create(containerNode->document(), text);
1000
1001     if (hasOneChild(&containerNode.get())) {
1002         containerNode->replaceChild(textNode.release(), containerNode->firstChild(), ec);
1003         return;
1004     }
1005
1006     containerNode->removeChildren();
1007     containerNode->appendChild(textNode.release(), ec);
1008 }
1009
1010 }