CTTE: Thread references through markup.h
[WebKit-https.git] / Source / WebCore / editing / MarkupAccumulator.h
1 /*
2  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Apple 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 #ifndef MarkupAccumulator_h
27 #define MarkupAccumulator_h
28
29 #include "markup.h"
30 #include <wtf/HashMap.h>
31 #include <wtf/Vector.h>
32 #include <wtf/text/StringBuilder.h>
33
34 namespace WebCore {
35
36 class Attribute;
37 class DocumentType;
38 class Element;
39 class Node;
40 class Range;
41
42 typedef HashMap<AtomicString, AtomicStringImpl*> Namespaces;
43
44 enum EntityMask {
45     EntityAmp = 0x0001,
46     EntityLt = 0x0002,
47     EntityGt = 0x0004,
48     EntityQuot = 0x0008,
49     EntityNbsp = 0x0010,
50
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 | EntityLt | EntityGt | EntityQuot,
57     EntityMaskInHTMLAttributeValue = EntityMaskInAttributeValue | EntityNbsp,
58 };
59
60 struct EntityDescription {
61     UChar entity;
62     const String& reference;
63     EntityMask mask;
64 };
65
66 // FIXME: Noncopyable?
67 class MarkupAccumulator {
68 public:
69     MarkupAccumulator(Vector<Node*>*, EAbsoluteURLs, const Range* = 0, EFragmentSerialization = HTMLFragmentSerialization);
70     virtual ~MarkupAccumulator();
71
72     String serializeNodes(Node& targetNode, Node* nodeToSkip, EChildrenOnly, Vector<QualifiedName>* tagNamesToSkip = nullptr);
73
74     static void appendCharactersReplacingEntities(StringBuilder&, const String&, unsigned, unsigned, EntityMask);
75
76 protected:
77     static size_t totalLength(const Vector<String>&);
78     size_t length() const { return m_markup.length(); }
79
80     void concatenateMarkup(StringBuilder&);
81
82     virtual void appendString(const String&);
83     virtual void appendEndTag(const Node&);
84     virtual void appendCustomAttributes(StringBuilder&, const Element&, Namespaces*);
85     virtual void appendText(StringBuilder&, const Text&);
86     virtual void appendElement(StringBuilder&, const Element&, Namespaces*);
87
88     void appendStartTag(const Node&, Namespaces* = 0);
89
90     void appendOpenTag(StringBuilder&, const Element&, Namespaces*);
91     void appendCloseTag(StringBuilder&, const Element&);
92
93     void appendStartMarkup(StringBuilder&, const Node&, Namespaces*);
94     void appendEndMarkup(StringBuilder&, const Node&);
95
96     void appendAttributeValue(StringBuilder&, const String&, bool);
97     void appendNodeValue(StringBuilder&, const Node&, const Range*, EntityMask);
98     void appendNamespace(StringBuilder&, const AtomicString& prefix, const AtomicString& namespaceURI, Namespaces&, bool allowEmptyDefaultNS = false);
99     void appendXMLDeclaration(StringBuilder&, const Document&);
100     void appendDocumentType(StringBuilder&, const DocumentType&);
101     void appendProcessingInstruction(StringBuilder&, const String& target, const String& data);
102     void appendAttribute(StringBuilder&, const Element&, const Attribute&, Namespaces*);
103     void appendCDATASection(StringBuilder&, const String&);
104
105     bool shouldAddNamespaceElement(const Element&);
106     bool shouldAddNamespaceAttribute(const Attribute&, Namespaces&);
107     bool shouldSelfClose(const Node&);
108     bool elementCannotHaveEndTag(const Node&);
109     EntityMask entityMaskForText(const Text&) const;
110
111     Vector<Node*>* const m_nodes;
112     const Range* const m_range;
113
114 private:
115     String resolveURLIfNeeded(const Element&, const String&) const;
116     void appendQuotedURLAttributeValue(StringBuilder&, const Element&, const Attribute&);
117     void serializeNodesWithNamespaces(Node& targetNode, Node* nodeToSkip, EChildrenOnly, const Namespaces*, Vector<QualifiedName>* tagNamesToSkip);
118     bool inXMLFragmentSerialization() const { return m_fragmentSerialization == XMLFragmentSerialization; }
119     void generateUniquePrefix(QualifiedName&, const Namespaces&);
120
121     StringBuilder m_markup;
122     const EAbsoluteURLs m_resolveURLsMethod;
123     EFragmentSerialization m_fragmentSerialization;
124     unsigned m_prefixLevel;
125 };
126
127 }
128
129 #endif