1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
/*
* Copyright (C) 2004-2024 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "CSSSerializationContext.h"
#include "CSSStyleSheet.h"
#include "Element.h"
#include "markup.h"
#include <wtf/HashMap.h>
#include <wtf/text/StringBuilder.h>
namespace WebCore {
class Attribute;
class DocumentType;
class Element;
class LocalFrame;
class Node;
class Range;
class ShadowRoot;
typedef UncheckedKeyHashMap<AtomString, AtomStringImpl*> Namespaces;
enum class EntityMask : uint8_t {
Amp = 1 << 0,
Lt = 1 << 1,
Gt = 1 << 2,
Quot = 1 << 3,
Nbsp = 1 << 4,
Tab = 1 << 5,
LineFeed = 1 << 6,
CarriageReturn = 1 << 7,
// Non-breaking space needs to be escaped in innerHTML for compatibility reason. See http://trac.webkit.org/changeset/32879
// However, we cannot do this in a XML document because it does not have the entity reference defined (See the bug 19215).
};
constexpr OptionSet<EntityMask> EntityMaskInCDATA = { };
constexpr OptionSet<EntityMask> EntityMaskInPCDATA = { EntityMask::Amp, EntityMask::Lt, EntityMask::Gt };
constexpr auto EntityMaskInHTMLPCDATA = EntityMaskInPCDATA | EntityMask::Nbsp;
constexpr OptionSet<EntityMask> EntityMaskInAttributeValue = { EntityMask::Amp, EntityMask::Lt, EntityMask::Gt,
EntityMask::Quot, EntityMask::Tab, EntityMask::LineFeed, EntityMask::CarriageReturn };
constexpr auto EntityMaskInHTMLAttributeValue = { EntityMask::Amp, EntityMask::Quot, EntityMask::Nbsp };
class MarkupAccumulator {
WTF_MAKE_NONCOPYABLE(MarkupAccumulator);
public:
MarkupAccumulator(Vector<Ref<Node>>*, ResolveURLs, SerializationSyntax, SerializeShadowRoots = SerializeShadowRoots::Explicit, Vector<Ref<ShadowRoot>>&& explicitShadowRoots = { }, const Vector<MarkupExclusionRule>& exclusionRules = { });
virtual ~MarkupAccumulator();
String serializeNodes(Node& targetNode, SerializedNodes);
static void appendCharactersReplacingEntities(StringBuilder&, const String&, unsigned, unsigned, OptionSet<EntityMask>);
void enableURLReplacement(UncheckedKeyHashMap<String, String>&& replacementURLStrings, UncheckedKeyHashMap<Ref<CSSStyleSheet>, String>&& replacementURLStringsForCSSStyleSheet);
protected:
unsigned length() const { return m_markup.length(); }
bool containsOnlyASCII() const { return m_markup.containsOnlyASCII(); }
StringBuilder takeMarkup();
template<typename ...StringTypes> void append(StringTypes&&... strings) { m_markup.append(std::forward<StringTypes>(strings)...); }
void startAppendingNode(const Node&, Namespaces* = nullptr);
void endAppendingNode(const Node&);
virtual void appendStartTag(StringBuilder&, const Element&, Namespaces*);
virtual void appendEndTag(StringBuilder&, const Element&);
virtual void appendCustomAttributes(StringBuilder&, const Element&, Namespaces*);
virtual void appendText(StringBuilder&, const Text&);
virtual bool appendContentsForNode(StringBuilder& result, const Node&);
void appendOpenTag(StringBuilder&, const Element&, Namespaces*);
void appendCloseTag(StringBuilder&, const Element&);
void appendNonElementNode(StringBuilder&, const Node&, Namespaces*);
static void appendAttributeValue(StringBuilder&, const String&, bool isSerializingHTML);
bool appendAttribute(StringBuilder&, const Element&, const Attribute&, Namespaces*);
OptionSet<EntityMask> entityMaskForText(const Text&) const;
Vector<Ref<Node>>* const m_nodes;
private:
void appendNamespace(StringBuilder&, const AtomString& prefix, const AtomString& namespaceURI, Namespaces&, bool allowEmptyDefaultNS = false);
enum class IsCreatedByURLReplacement : bool { No, Yes };
std::pair<String, IsCreatedByURLReplacement> resolveURLIfNeeded(const Element&, const String&) const;
bool shouldIncludeShadowRoots() const;
bool includeShadowRoot(const ShadowRoot&) const;
void serializeNodesWithNamespaces(Node& targetNode, SerializedNodes, const Namespaces*);
bool inXMLFragmentSerialization() const { return m_serializationSyntax == SerializationSyntax::XML; }
void generateUniquePrefix(QualifiedName&, const Namespaces&);
QualifiedName xmlAttributeSerialization(const Attribute&, Namespaces*);
LocalFrame* frameForAttributeReplacement(const Element&) const;
Attribute replaceAttributeIfNecessary(const Element&, const Attribute&);
bool appendURLAttributeForReplacementIfNecessary(StringBuilder&, const Element&, Namespaces*);
const ShadowRoot* suitableShadowRoot(const Node&);
bool shouldExcludeElement(const Element&);
void appendStartTagWithURLReplacement(StringBuilder&, const Element&, Namespaces*);
StringBuilder m_markup;
const ResolveURLs m_resolveURLs;
const SerializationSyntax m_serializationSyntax;
unsigned m_prefixLevel { 0 };
SerializeShadowRoots m_serializeShadowRoots;
Vector<Ref<ShadowRoot>> m_explicitShadowRoots;
Vector<MarkupExclusionRule> m_exclusionRules;
std::optional<CSS::SerializationContext> m_serializationContext;
};
inline void MarkupAccumulator::endAppendingNode(const Node& node)
{
if (RefPtr element = dynamicDowncast<Element>(node))
appendEndTag(m_markup, *element);
else if (suitableShadowRoot(node))
m_markup.append("</template>"_s);
}
} // namespace WebCore
|
