DocumentWriter.h revision cad810f21b803229eb11403f9209855525a25d57 
1/*
2 * Copyright (C) 2010. Adam Barth. 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 *
8 * 1.  Redistributions of source code must retain the above copyright
9 *     notice, this list of conditions and the following disclaimer.
10 * 2.  Redistributions in binary form must reproduce the above copyright
11 *     notice, this list of conditions and the following disclaimer in the
12 *     documentation and/or other materials provided with the distribution.
13 * 3.  Neither the name of Adam Barth. ("Adam Barth") nor the names of
14 *     its contributors may be used to endorse or promote products derived
15 *     from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#ifndef DocumentWriter_h
30#define DocumentWriter_h
31
32#include "KURL.h"
33#include "PlatformString.h"
34
35namespace WebCore {
36
37class Document;
38class Frame;
39class SecurityOrigin;
40class TextResourceDecoder;
41
42class DocumentWriter : public Noncopyable {
43public:
44    DocumentWriter(Frame*);
45
46    // This is only called by ScriptController::executeIfJavaScriptURL
47    // and always contains the result of evaluating a javascript: url.
48    void replaceDocument(const String&);
49
50    void begin();
51    void begin(const KURL&, bool dispatchWindowObjectAvailable = true, SecurityOrigin* forcedSecurityOrigin = 0);
52    void addData(const char* string, int length = -1, bool flush = false);
53    void end();
54    void endIfNotLoadingMainResource();
55    void clear();
56
57    String encoding() const;
58    void setEncoding(const String& encoding, bool userChosen);
59
60    // FIXME: It's really unforunate to need to expose this piece of state.
61    // I suspect a better design is to disentangle user-provided encodings,
62    // default encodings, and the decoding we're currently using.
63    String deprecatedFrameEncoding() const;
64
65    const String& mimeType() const { return m_mimeType; }
66    void setMIMEType(const String& type) { m_mimeType = type; }
67
68    void setDecoder(TextResourceDecoder*);
69
70    // Exposed for DoucmentParser::appendBytes
71    TextResourceDecoder* createDecoderIfNeeded();
72    void reportDataReceived();
73
74    void setDocumentWasLoadedAsPartOfNavigation();
75
76private:
77    PassRefPtr<Document> createDocument(const KURL&);
78
79    Frame* m_frame;
80
81    bool m_receivedData;
82    String m_mimeType;
83
84    bool m_encodingWasChosenByUser;
85    String m_encoding;
86    RefPtr<TextResourceDecoder> m_decoder;
87};
88
89} // namespace WebCore
90
91#endif // DocumentWriter_h
92