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 
35 namespace WebCore {
36 
37 class Document;
38 class Frame;
39 class SecurityOrigin;
40 class TextResourceDecoder;
41 
42 class DocumentWriter {
43     WTF_MAKE_NONCOPYABLE(DocumentWriter);
44 public:
45     DocumentWriter(Frame*);
46 
47     // This is only called by ScriptController::executeIfJavaScriptURL
48     // and always contains the result of evaluating a javascript: url.
49     void replaceDocument(const String&);
50 
51     void begin();
52     void begin(const KURL&, bool dispatchWindowObjectAvailable = true, SecurityOrigin* forcedSecurityOrigin = 0);
53     void addData(const char* string, int length = -1, bool flush = false);
54     void end();
55     void endIfNotLoadingMainResource();
56 
setFrame(Frame * frame)57     void setFrame(Frame* frame) { m_frame = frame; }
58 
59     String encoding() const;
60     void setEncoding(const String& encoding, bool userChosen);
61 
62     // FIXME: It's really unforunate to need to expose this piece of state.
63     // I suspect a better design is to disentangle user-provided encodings,
64     // default encodings, and the decoding we're currently using.
65     String deprecatedFrameEncoding() const;
66 
mimeType()67     const String& mimeType() const { return m_mimeType; }
setMIMEType(const String & type)68     void setMIMEType(const String& type) { m_mimeType = type; }
69 
70     void setDecoder(TextResourceDecoder*);
71 
72     // Exposed for DoucmentParser::appendBytes
73     TextResourceDecoder* createDecoderIfNeeded();
74     void reportDataReceived();
75 
76     void setDocumentWasLoadedAsPartOfNavigation();
77 
78 private:
79     PassRefPtr<Document> createDocument(const KURL&);
80     void clear();
81 
82     Frame* m_frame;
83 
84     bool m_receivedData;
85     String m_mimeType;
86 
87     bool m_encodingWasChosenByUser;
88     String m_encoding;
89     RefPtr<TextResourceDecoder> m_decoder;
90 };
91 
92 } // namespace WebCore
93 
94 #endif // DocumentWriter_h
95