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
|
/*
* 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 DocumentParser_h
#define DocumentParser_h
#include "platform/heap/Handle.h"
#include "wtf/Forward.h"
#include "wtf/RefCounted.h"
namespace WebCore {
class Document;
class DocumentWriter;
class SegmentedString;
class ScriptableDocumentParser;
class TextResourceDecoder;
class DocumentParser : public RefCountedWillBeGarbageCollectedFinalized<DocumentParser> {
public:
virtual ~DocumentParser();
virtual void trace(Visitor*);
virtual ScriptableDocumentParser* asScriptableDocumentParser() { return 0; }
// 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 SegmentedString&) = 0;
// The below functions are used by DocumentWriter (the loader).
virtual void appendBytes(const char* bytes, size_t length) = 0;
virtual void flush() = 0;
virtual bool needsDecoder() const { return false; }
virtual void setDecoder(PassOwnPtr<TextResourceDecoder>);
virtual TextResourceDecoder* decoder();
virtual void setHasAppendedData() { }
// pinToMainThread also makes append() not yield before completion of that chunk.
virtual void pinToMainThread() { }
// FIXME: append() should be private, but DocumentWriter::replaceDocument uses it for now.
// FIXME: This really should take a PassOwnPtr to signify that it expects to take
// ownership of the buffer. The parser expects the PassRefPtr to hold the only ref of the StringImpl.
virtual void append(PassRefPtr<StringImpl>) = 0;
virtual void finish() = 0;
// FIXME: processingData() is only used by DocumentLoader::isLoadingInAPISense
// and is very unclear as to what it actually means. The LegacyHTMLDocumentParser
// used to implement it.
virtual bool processingData() const { return false; }
// document() will return 0 after detach() is called.
Document* document() const { ASSERT(m_document); return m_document; }
bool isParsing() const { return m_state == ParsingState; }
bool isStopping() const { return m_state == StoppingState; }
bool isStopped() const { return m_state >= StoppedState; }
bool isDetached() const { return m_state == DetachedState; }
// FIXME: Is this necessary? Does XMLDocumentParserLibxml2 really need to set this?
virtual void startParsing();
// 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, m_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 WebCore after
// detach is called.
// Oilpan: We don't need to call detach when a Document is destructed.
virtual void detach();
void setDocumentWasLoadedAsPartOfNavigation() { m_documentWasLoadedAsPartOfNavigation = true; }
bool documentWasLoadedAsPartOfNavigation() const { return m_documentWasLoadedAsPartOfNavigation; }
// FIXME: The names are not very accurate :(
virtual void suspendScheduledTasks();
virtual void resumeScheduledTasks();
protected:
explicit DocumentParser(Document*);
private:
enum ParserState {
ParsingState,
StoppingState,
StoppedState,
DetachedState
};
ParserState m_state;
bool m_documentWasLoadedAsPartOfNavigation;
// Every DocumentParser needs a pointer back to the document.
// m_document will be 0 after the parser is stopped.
RawPtrWillBeMember<Document> m_document;
};
} // namespace WebCore
#endif // DocumentParser_h
|
