WebCore:
[WebKit-https.git] / WebCore / html / HTMLTokenizer.h
1 /*
2     Copyright (C) 1997 Martin Jones (mjones@kde.org)
3               (C) 1997 Torben Weis (weis@kde.org)
4               (C) 1998 Waldo Bastian (bastian@kde.org)
5               (C) 2001 Dirk Mueller (mueller@kde.org)
6     Copyright (C) 2003, 2004, 2005, 2006 Apple Computer, Inc.
7
8     This library is free software; you can redistribute it and/or
9     modify it under the terms of the GNU Library General Public
10     License as published by the Free Software Foundation; either
11     version 2 of the License, or (at your option) any later version.
12
13     This library is distributed in the hope that it will be useful,
14     but WITHOUT ANY WARRANTY; without even the implied warranty of
15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16     Library General Public License for more details.
17
18     You should have received a copy of the GNU Library General Public License
19     along with this library; see the file COPYING.LIB.  If not, write to
20     the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21     Boston, MA 02111-1307, USA.
22 */
23
24 #ifndef HTMLTokenizer_h
25 #define HTMLTokenizer_h
26
27 #include "DeprecatedPtrQueue.h"
28 #include "NamedMappedAttrMap.h"
29 #include "SegmentedString.h"
30 #include "Timer.h"
31 #include "Tokenizer.h"
32 #include "CachedResourceClient.h"
33 #include <wtf/Vector.h>
34 #include <wtf/OwnPtr.h>
35
36 namespace WebCore {
37
38 class CachedScript;
39 class DocumentFragment;
40 class Document;
41 class HTMLDocument;
42 class HTMLViewSourceDocument;
43 class FrameView;
44 class HTMLParser;
45 class Node;
46
47 /**
48  * @internal
49  * represents one HTML tag. Consists of a numerical id, and the list
50  * of attributes. Can also represent text. In this case the id = 0 and
51  * text contains the text.
52  */
53 class Token {
54 public:
55     Token() : beginTag(true), flat(false), brokenXMLStyle(false), m_sourceInfo(0) { }
56     ~Token() { }
57
58     void addAttribute(Document*, AtomicString& attrName, const AtomicString& v, bool viewSourceMode);
59
60     bool isOpenTag(const QualifiedName& fullName) const { return beginTag && fullName.localName() == tagName; }
61     bool isCloseTag(const QualifiedName& fullName) const { return !beginTag && fullName.localName() == tagName; }
62
63     void reset()
64     {
65         attrs = 0;
66         text = 0;
67         tagName = nullAtom;
68         beginTag = true;
69         flat = false;
70         brokenXMLStyle = false;
71         if (m_sourceInfo)
72             m_sourceInfo->clear();
73     }
74
75     void addViewSourceChar(UChar c) { if (!m_sourceInfo.get()) m_sourceInfo.set(new Vector<UChar>); m_sourceInfo->append(c); }
76
77     RefPtr<NamedMappedAttrMap> attrs;
78     RefPtr<StringImpl> text;
79     AtomicString tagName;
80     bool beginTag;
81     bool flat;
82     bool brokenXMLStyle;
83     OwnPtr<Vector<UChar> > m_sourceInfo;
84 };
85
86 //-----------------------------------------------------------------------------
87
88 class HTMLTokenizer : public Tokenizer, public CachedResourceClient {
89 public:
90     HTMLTokenizer(HTMLDocument*, bool reportErrors);
91     HTMLTokenizer(HTMLViewSourceDocument*);
92     HTMLTokenizer(DocumentFragment*);
93     virtual ~HTMLTokenizer();
94
95     virtual bool write(const SegmentedString&, bool appendData);
96     virtual void finish();
97     virtual void setForceSynchronous(bool force);
98     virtual bool isWaitingForScripts() const;
99     virtual void stopParsing();
100     virtual bool processingData() const;
101     virtual int executingScript() const { return m_executingScript; }
102
103     virtual int lineNumber() const { return lineno; }
104     virtual int columnNumber() const { return 1; }
105
106     int* lineNumberPtr() { return &lineno; }
107
108     bool processingContentWrittenByScript() const { return src.excludeLineNumbers(); }
109     
110     virtual void executeScriptsWaitingForStylesheets();
111
112 private:
113     class State;
114
115     // Where we are in parsing a tag
116     void begin();
117     void end();
118
119     void reset();
120     PassRefPtr<Node> processToken();
121
122     State processListing(SegmentedString, State);
123     State parseComment(SegmentedString&, State);
124     State parseServer(SegmentedString&, State);
125     State parseText(SegmentedString&, State);
126     State parseSpecial(SegmentedString&, State);
127     State parseTag(SegmentedString&, State);
128     State parseEntity(SegmentedString&, UChar*& dest, State, unsigned& _cBufferPos, bool start, bool parsingTag);
129     State parseProcessingInstruction(SegmentedString&, State);
130     State scriptHandler(State);
131     State scriptExecution(const DeprecatedString& script, State, DeprecatedString scriptURL, int baseLine = 0);
132     void setSrc(const SegmentedString&);
133  
134     // check if we have enough space in the buffer.
135     // if not enlarge it
136     inline void checkBuffer(int len = 10)
137     {
138         if ((dest - buffer) > size - len)
139             enlargeBuffer(len);
140     }
141
142     inline void checkScriptBuffer(int len = 10)
143     {
144         if (scriptCodeSize + len >= scriptCodeMaxSize)
145             enlargeScriptBuffer(len);
146     }
147
148     void enlargeBuffer(int len);
149     void enlargeScriptBuffer(int len);
150
151     bool continueProcessing(int& processedCount, double startTime, State&);
152     void timerFired(Timer<HTMLTokenizer>*);
153     void allDataProcessed();
154
155     // from CachedResourceClient
156     void notifyFinished(CachedResource *finishedObj);
157
158     // Internal buffers
159     ///////////////////
160     UChar* buffer;
161     UChar* dest;
162
163     Token currToken;
164
165     // the size of buffer
166     int size;
167
168     // Tokenizer flags
169     //////////////////
170     // are we in quotes within a html tag
171     enum { NoQuote, SingleQuote, DoubleQuote } tquote;
172
173     // Are we in a &... character entity description?
174     enum EntityState {
175         NoEntity = 0,
176         SearchEntity = 1,
177         NumericSearch = 2,
178         Hexadecimal = 3,
179         Decimal = 4,
180         EntityName = 5,
181         SearchSemicolon = 6
182     };
183     unsigned EntityUnicodeValue;
184
185     enum TagState {
186         NoTag = 0,
187         TagName = 1,
188         SearchAttribute = 2,
189         AttributeName = 3,
190         SearchEqual = 4,
191         SearchValue = 5,
192         QuotedValue = 6,
193         Value = 7,
194         SearchEnd = 8
195     };
196
197     class State {
198     public:
199         State() : m_bits(0) { }
200
201         TagState tagState() const { return static_cast<TagState>(m_bits & TagMask); }
202         void setTagState(TagState t) { m_bits = (m_bits & ~TagMask) | t; }
203         EntityState entityState() const { return static_cast<EntityState>((m_bits & EntityMask) >> EntityShift); }
204         void setEntityState(EntityState e) { m_bits = (m_bits & ~EntityMask) | (e << EntityShift); }
205
206         bool inScript() const { return testBit(InScript); }
207         void setInScript(bool v) { setBit(InScript, v); }
208         bool inStyle() const { return testBit(InStyle); }
209         void setInStyle(bool v) { setBit(InStyle, v); }
210         bool inXmp() const { return testBit(InXmp); }
211         void setInXmp(bool v) { setBit(InXmp, v); }
212         bool inTitle() const { return testBit(InTitle); }
213         void setInTitle(bool v) { setBit(InTitle, v); }
214         bool inPlainText() const { return testBit(InPlainText); }
215         void setInPlainText(bool v) { setBit(InPlainText, v); }
216         bool inProcessingInstruction() const { return testBit(InProcessingInstruction); }
217         void setInProcessingInstruction(bool v) { return setBit(InProcessingInstruction, v); }
218         bool inComment() const { return testBit(InComment); }
219         void setInComment(bool v) { setBit(InComment, v); }
220         bool inTextArea() const { return testBit(InTextArea); }
221         void setInTextArea(bool v) { setBit(InTextArea, v); }
222         bool escaped() const { return testBit(Escaped); }
223         void setEscaped(bool v) { setBit(Escaped, v); }
224         bool inServer() const { return testBit(InServer); }
225         void setInServer(bool v) { setBit(InServer, v); }
226         bool skipLF() const { return testBit(SkipLF); }
227         void setSkipLF(bool v) { setBit(SkipLF, v); }
228         bool startTag() const { return testBit(StartTag); }
229         void setStartTag(bool v) { setBit(StartTag, v); }
230         bool discardLF() const { return testBit(DiscardLF); }
231         void setDiscardLF(bool v) { setBit(DiscardLF, v); }
232         bool allowYield() const { return testBit(AllowYield); }
233         void setAllowYield(bool v) { setBit(AllowYield, v); }
234         bool loadingExtScript() const { return testBit(LoadingExtScript); }
235         void setLoadingExtScript(bool v) { setBit(LoadingExtScript, v); }
236         bool forceSynchronous() const { return testBit(ForceSynchronous); }
237         void setForceSynchronous(bool v) { setBit(ForceSynchronous, v); }
238
239         bool inAnySpecial() const { return m_bits & (InScript | InStyle | InXmp | InTextArea | InTitle); }
240         bool hasTagState() const { return m_bits & TagMask; }
241         bool hasEntityState() const { return m_bits & EntityMask; }
242
243         bool needsSpecialWriteHandling() const { return m_bits & (InScript | InStyle | InXmp | InTextArea | InTitle | TagMask | EntityMask | InPlainText | InComment | InServer | InProcessingInstruction | StartTag); }
244
245     private:
246         static const int EntityShift = 4;
247         enum StateBits {
248             TagMask = (1 << 4) - 1,
249             EntityMask = (1 << 7) - (1 << 4),
250             InScript = 1 << 7,
251             InStyle = 1 << 8,
252             // Bit 9 unused
253             InXmp = 1 << 10,
254             InTitle = 1 << 11,
255             InPlainText = 1 << 12,
256             InProcessingInstruction = 1 << 13,
257             InComment = 1 << 14,
258             InTextArea = 1 << 15,
259             Escaped = 1 << 16,
260             InServer = 1 << 17,
261             SkipLF = 1 << 18,
262             StartTag = 1 << 19,
263             DiscardLF = 1 << 20, // FIXME: should clarify difference between skip and discard
264             AllowYield = 1 << 21,
265             LoadingExtScript = 1 << 22,
266             ForceSynchronous = 1 << 23
267         };
268
269         void setBit(StateBits bit, bool value)
270         {
271             if (value)
272                 m_bits |= bit;
273             else
274                 m_bits &= ~bit;
275         }
276         bool testBit(StateBits bit) const { return m_bits & bit; }
277
278         unsigned m_bits;
279     };
280
281     State m_state;
282
283     bool brokenServer;
284
285     // Name of an attribute that we just scanned.
286     AtomicString attrName;
287
288     // Used to store the code of a srcipting sequence
289     UChar* scriptCode;
290     // Size of the script sequenze stored in @ref #scriptCode
291     int scriptCodeSize;
292     // Maximal size that can be stored in @ref #scriptCode
293     int scriptCodeMaxSize;
294     // resync point of script code size
295     int scriptCodeResync;
296
297     // Stores characters if we are scanning for a string like "</script>"
298     UChar searchBuffer[10];
299     // Counts where we are in the string we are scanning for
300     int searchCount;
301     // The string we are searching for
302     const UChar* searchFor;
303     // the stopper string
304     const char* searchStopper;
305     // the stopper len
306     int searchStopperLen;
307     // if no more data is coming, just parse what we have (including ext scripts that
308     // may be still downloading) and finish
309     bool noMoreData;
310     // URL to get source code of script from
311     String scriptSrc;
312     String scriptSrcCharset;
313     // the HTML code we will parse after the external script we are waiting for has loaded
314     SegmentedString pendingSrc;
315
316     // the HTML code we will parse after this particular script has
317     // loaded, but before all pending HTML
318     SegmentedString *currentPrependingSrc;
319
320     // true if we are executing a script while parsing a document. This causes the parsing of
321     // the output of the script to be postponed until after the script has finished executing
322     int m_executingScript;
323     DeprecatedPtrQueue<CachedScript> pendingScripts;
324     RefPtr<Node> scriptNode;
325
326     bool m_requestingScript;
327     bool m_hasScriptsWaitingForStylesheets;
328
329     // if we found one broken comment, there are most likely others as well
330     // store a flag to get rid of the O(n^2) behaviour in such a case.
331     bool brokenComments;
332     // current line number
333     int lineno;
334     // line number at which the current <script> started
335     int scriptStartLineno;
336     int tagStartLineno;
337
338     // The timer for continued processing.
339     Timer<HTMLTokenizer> m_timer;
340
341 // This buffer can hold arbitrarily long user-defined attribute names, such as in EMBED tags.
342 // So any fixed number might be too small, but rather than rewriting all usage of this buffer
343 // we'll just make it large enough to handle all imaginable cases.
344 #define CBUFLEN 1024
345     char cBuffer[CBUFLEN + 2];
346     unsigned int m_cBufferPos;
347
348     SegmentedString src;
349     Document* m_doc;
350     HTMLParser* parser;
351     bool inWrite;
352     bool m_fragment;
353 };
354
355 void parseHTMLDocumentFragment(const String&, DocumentFragment*);
356
357 UChar decodeNamedEntity(const char*);
358
359 } // namespace WebCore
360
361 #endif // HTMLTokenizer_h