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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
/*
* Copyright (C) 2000 Peter Kelly (pmk@post.com)
* Copyright (C) 2005, 2006 Apple Computer, Inc.
* Copyright (C) 2007 Samuel Weinig (sam@webkit.org)
* Copyright (C) 2010 Google, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*/
#ifndef THIRD_PARTY_BLINK_RENDERER_CORE_DOM_DOCUMENT_PARSER_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_DOM_DOCUMENT_PARSER_H_
#include <memory>
#include "base/containers/span.h"
#include "base/functional/callback.h"
#include "third_party/blink/renderer/core/core_export.h"
#include "third_party/blink/renderer/core/dom/document_encoding_data.h"
#include "third_party/blink/renderer/platform/bindings/name_client.h"
#include "third_party/blink/renderer/platform/heap/collection_support/heap_hash_set.h"
#include "third_party/blink/renderer/platform/heap/garbage_collected.h"
#include "third_party/blink/renderer/platform/wtf/forward.h"
#include "third_party/blink/renderer/platform/wtf/functional.h"
namespace blink {
class Document;
class DocumentParserClient;
class ScriptableDocumentParser;
class TextResourceDecoder;
class CORE_EXPORT DocumentParser : public GarbageCollected<DocumentParser>,
public NameClient {
public:
~DocumentParser() override;
virtual void Trace(Visitor*) const;
const char* NameInHeapSnapshot() const override { return "DocumentParser"; }
virtual ScriptableDocumentParser* AsScriptableDocumentParser() {
return nullptr;
}
// http://www.whatwg.org/specs/web-apps/current-work/#insertion-point
virtual bool HasInsertionPoint() { return true; }
// insert is used by document.write.
virtual void insert(const String&) = 0;
// The below functions are used by DocumentWriter (the loader).
virtual void AppendBytes(base::span<const uint8_t> bytes) = 0;
virtual bool NeedsDecoder() const { return false; }
virtual void SetDecoder(std::unique_ptr<TextResourceDecoder>);
virtual void SetHasAppendedData() {}
virtual void AppendDecodedData(const String& data,
const DocumentEncodingData& encoding_data) {}
using BackgroundScanCallback =
WTF::CrossThreadRepeatingFunction<void(const String&)>;
virtual BackgroundScanCallback TakeBackgroundScanCallback() {
return BackgroundScanCallback();
}
// FIXME: append() should be private, but DocumentLoader and DOMPatchSupport
// uses it for now.
virtual void Append(const String&) = 0;
virtual void Finish() = 0;
// GetDocument() returns null after detach() is called.
Document* GetDocument() const {
return document_.Get();
}
bool IsParsing() const { return state_ == kParsingState; }
bool IsStopping() const { return state_ == kStoppingState; }
ALWAYS_INLINE bool IsStopped() const { return state_ >= kStoppedState; }
bool IsDetached() const { return state_ == kDetachedState; }
// prepareToStop() is used when the EOF token is encountered and parsing is to
// be stopped normally.
virtual void PrepareToStopParsing();
// stopParsing() is used when a load is canceled/stopped.
// stopParsing() is currently different from detach(), but shouldn't be.
// It should NOT be ok to call any methods on DocumentParser after either
// detach() or stopParsing() but right now only detach() will ASSERT.
virtual void StopParsing();
// Document is expected to detach the parser before releasing its ref.
// After detach, document_ is cleared. The parser will unwind its
// callstacks, but not produce any more nodes.
// It is impossible for the parser to touch the rest of Blink Core after
// detach is called.
// Oilpan: We don't need to call detach when a Document is destructed.
virtual void Detach();
// Notifies the parser that the document element is available. Used by
// HTMLDocumentParser to dispatch preloads.
virtual void DocumentElementAvailable() {}
// Notifies the parser that any data which was added when preloading can now
// be parsed.
virtual void CommitPreloadedData() {}
// Notifies the parser that this is a good time to send requests for any
// preloads that may be pending.
virtual void FlushPendingPreloads() {}
void SetDocumentWasLoadedAsPartOfNavigation() {
document_was_loaded_as_part_of_navigation_ = true;
}
bool DocumentWasLoadedAsPartOfNavigation() const {
return document_was_loaded_as_part_of_navigation_;
}
void SetIsPreloading(bool is_preloading) { is_preloading_ = is_preloading; }
bool IsPreloading() const { return is_preloading_; }
void AddClient(DocumentParserClient*);
void RemoveClient(DocumentParserClient*);
protected:
explicit DocumentParser(Document*);
private:
enum ParserState {
kParsingState,
kStoppingState,
kStoppedState,
kDetachedState
};
ParserState state_;
bool document_was_loaded_as_part_of_navigation_;
bool is_preloading_ = false;
// Every DocumentParser needs a pointer back to the document.
// document_ will be 0 after the parser is stopped.
Member<Document> document_;
HeapHashSet<WeakMember<DocumentParserClient>> clients_;
};
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_CORE_DOM_DOCUMENT_PARSER_H_
|
