2 * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
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.
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.
26 #ifndef MarkupAccumulator_h
27 #define MarkupAccumulator_h
29 #include "core/editing/markup.h"
30 #include "wtf/HashMap.h"
31 #include "wtf/Vector.h"
32 #include "wtf/text/StringBuilder.h"
42 typedef HashMap<StringImpl*, StringImpl*> Namespaces;
51 // Non-breaking space needs to be escaped in innerHTML for compatibility reason. See http://trac.webkit.org/changeset/32879
52 // However, we cannot do this in a XML document because it does not have the entity reference defined (See the bug 19215).
53 EntityMaskInCDATA = 0,
54 EntityMaskInPCDATA = EntityAmp | EntityLt | EntityGt,
55 EntityMaskInHTMLPCDATA = EntityMaskInPCDATA | EntityNbsp,
56 EntityMaskInAttributeValue = EntityAmp | EntityQuot | EntityLt | EntityGt,
57 EntityMaskInHTMLAttributeValue = EntityAmp | EntityQuot | EntityNbsp,
60 class MarkupAccumulator {
61 WTF_MAKE_NONCOPYABLE(MarkupAccumulator);
64 MarkupAccumulator(Vector<Node*>*, EAbsoluteURLs, const Range* = 0);
65 virtual ~MarkupAccumulator();
67 String serializeNodes(Node& targetNode, EChildrenOnly, Vector<QualifiedName>* tagNamesToSkip = 0);
69 static void appendComment(StringBuilder&, const String&);
71 static void appendCharactersReplacingEntities(StringBuilder&, const String&, unsigned, unsigned, EntityMask);
74 void appendString(const String&);
75 void appendStartTag(Node&, Namespaces* = 0);
76 virtual void appendEndTag(const Node&);
77 static size_t totalLength(const Vector<String>&);
78 size_t length() const { return m_markup.length(); }
79 void concatenateMarkup(StringBuilder&);
80 void appendAttributeValue(StringBuilder&, const String&, bool);
81 virtual void appendCustomAttributes(StringBuilder&, const Element&, Namespaces*);
82 bool shouldAddNamespaceElement(const Element&);
83 bool shouldAddNamespaceAttribute(const Attribute&, Namespaces&);
84 void appendNamespace(StringBuilder&, const AtomicString& prefix, const AtomicString& namespaceURI, Namespaces&);
85 EntityMask entityMaskForText(const Text&) const;
86 virtual void appendText(StringBuilder&, Text&);
87 void appendXMLDeclaration(StringBuilder&, const Document&);
88 void appendDocumentType(StringBuilder&, const DocumentType&);
89 void appendProcessingInstruction(StringBuilder&, const String& target, const String& data);
90 virtual void appendElement(StringBuilder&, Element&, Namespaces*);
91 void appendOpenTag(StringBuilder&, const Element&, Namespaces*);
92 void appendCloseTag(StringBuilder&, const Element&);
93 void appendAttribute(StringBuilder&, const Element&, const Attribute&, Namespaces*);
94 void appendCDATASection(StringBuilder&, const String&);
95 void appendStartMarkup(StringBuilder&, Node&, Namespaces*);
96 bool shouldSelfClose(const Node&);
97 bool elementCannotHaveEndTag(const Node&);
98 void appendEndMarkup(StringBuilder&, const Node&);
100 Vector<Node*>* const m_nodes;
101 const Range* const m_range;
104 String resolveURLIfNeeded(const Element&, const String&) const;
105 void appendQuotedURLAttributeValue(StringBuilder&, const Element&, const Attribute&);
106 void serializeNodesWithNamespaces(Node& targetNode, EChildrenOnly, const Namespaces*, Vector<QualifiedName>* tagNamesToSkip);
108 StringBuilder m_markup;
109 const EAbsoluteURLs m_resolveURLsMethod;