Returning NULL from willSendRequest should cancel a load from the memory cache
[WebKit-https.git] / Source / WebCore / loader / TextResourceDecoder.h
1 /*
2     Copyright (C) 1999 Lars Knoll (knoll@mpi-hd.mpg.de)
3     Copyright (C) 2006 Alexey Proskuryakov (ap@nypop.com)
4     Copyright (C) 2006, 2008 Apple Inc. All rights reserved.
5
6     This library is free software; you can redistribute it and/or
7     modify it under the terms of the GNU Library General Public
8     License as published by the Free Software Foundation; either
9     version 2 of the License, or (at your option) any later version.
10
11     This library is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14     Library General Public License for more details.
15
16     You should have received a copy of the GNU Library General Public License
17     along with this library; see the file COPYING.LIB.  If not, write to
18     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19     Boston, MA 02110-1301, USA.
20
21 */
22
23 #ifndef TextResourceDecoder_h
24 #define TextResourceDecoder_h
25
26 #include "TextEncoding.h"
27 #include <wtf/RefCounted.h>
28
29 namespace WebCore {
30
31 class HTMLMetaCharsetParser;
32
33 class TextResourceDecoder : public RefCounted<TextResourceDecoder> {
34 public:
35     enum EncodingSource {
36         DefaultEncoding,
37         AutoDetectedEncoding,
38         EncodingFromXMLHeader,
39         EncodingFromMetaTag,
40         EncodingFromCSSCharset,
41         EncodingFromHTTPHeader,
42         UserChosenEncoding,
43         EncodingFromParentFrame
44     };
45
46     static PassRefPtr<TextResourceDecoder> create(const String& mimeType, const TextEncoding& defaultEncoding = TextEncoding(), bool usesEncodingDetector = false)
47     {
48         return adoptRef(new TextResourceDecoder(mimeType, defaultEncoding, usesEncodingDetector));
49     }
50     ~TextResourceDecoder();
51
52     void setEncoding(const TextEncoding&, EncodingSource);
53     const TextEncoding& encoding() const { return m_encoding; }
54
55     String decode(const char* data, size_t length);
56     String flush();
57
58     void setHintEncoding(const TextResourceDecoder* hintDecoder)
59     {
60         // hintEncoding is for use with autodetection, which should be 
61         // only invoked when hintEncoding comes from auto-detection.
62         if (hintDecoder && hintDecoder->m_source == AutoDetectedEncoding)
63             m_hintEncoding = hintDecoder->encoding().name();
64     }
65    
66     void useLenientXMLDecoding() { m_useLenientXMLDecoding = true; }
67     bool sawError() const { return m_sawError; }
68
69 private:
70     TextResourceDecoder(const String& mimeType, const TextEncoding& defaultEncoding,
71                         bool usesEncodingDetector);
72
73     enum ContentType { PlainText, HTML, XML, CSS }; // PlainText only checks for BOM.
74     static ContentType determineContentType(const String& mimeType);
75     static const TextEncoding& defaultEncoding(ContentType, const TextEncoding& defaultEncoding);
76
77     size_t checkForBOM(const char*, size_t);
78     bool checkForCSSCharset(const char*, size_t, bool& movedDataToBuffer);
79     bool checkForHeadCharset(const char*, size_t, bool& movedDataToBuffer);
80     bool checkForMetaCharset(const char*, size_t);
81     void detectJapaneseEncoding(const char*, size_t);
82     bool shouldAutoDetect() const;
83
84     ContentType m_contentType;
85     TextEncoding m_encoding;
86     OwnPtr<TextCodec> m_codec;
87     EncodingSource m_source;
88     const char* m_hintEncoding;
89     Vector<char> m_buffer;
90     bool m_checkedForBOM;
91     bool m_checkedForCSSCharset;
92     bool m_checkedForHeadCharset;
93     bool m_useLenientXMLDecoding; // Don't stop on XML decoding errors.
94     bool m_sawError;
95     bool m_usesEncodingDetector;
96
97     OwnPtr<HTMLMetaCharsetParser> m_charsetParser;
98 };
99
100 }
101
102 #endif