1/*
2 * Copyright (C) 2004, 2006, 2007, 2008, 2009 Apple Inc. 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 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef TextEncoding_h
27#define TextEncoding_h
28
29#include "wtf/Forward.h"
30#include "wtf/WTFExport.h"
31#include "wtf/text/TextCodec.h"
32#include "wtf/unicode/Unicode.h"
33
34namespace WTF {
35
36class WTF_EXPORT TextEncoding {
37public:
38    TextEncoding() : m_name(0) { }
39    TextEncoding(const char* name);
40    TextEncoding(const String& name);
41
42    bool isValid() const { return m_name; }
43    const char* name() const { return m_name; }
44    bool usesVisualOrdering() const;
45    const TextEncoding& closestByteBasedEquivalent() const;
46    const TextEncoding& encodingForFormSubmission() const;
47
48    String decode(const char* str, size_t length) const
49    {
50        bool ignored;
51        return decode(str, length, false, ignored);
52    }
53    String decode(const char*, size_t length, bool stopOnError, bool& sawError) const;
54
55    // Encodes the string, but does *not* normalize first.
56    CString encode(const String&, UnencodableHandling) const;
57
58    // Applies Unicode NFC normalization, then encodes the normalized string.
59    CString normalizeAndEncode(const String&, UnencodableHandling) const;
60
61private:
62    bool isNonByteBasedEncoding() const;
63    bool isUTF7Encoding() const;
64
65    const char* m_name;
66};
67
68inline bool operator==(const TextEncoding& a, const TextEncoding& b) { return a.name() == b.name(); }
69inline bool operator!=(const TextEncoding& a, const TextEncoding& b) { return a.name() != b.name(); }
70
71WTF_EXPORT const TextEncoding& ASCIIEncoding();
72WTF_EXPORT const TextEncoding& Latin1Encoding();
73WTF_EXPORT const TextEncoding& UTF16BigEndianEncoding();
74WTF_EXPORT const TextEncoding& UTF16LittleEndianEncoding();
75WTF_EXPORT const TextEncoding& UTF32BigEndianEncoding();
76WTF_EXPORT const TextEncoding& UTF32LittleEndianEncoding();
77WTF_EXPORT const TextEncoding& UTF8Encoding();
78WTF_EXPORT const TextEncoding& WindowsLatin1Encoding();
79
80} // namespace WTF
81
82using WTF::ASCIIEncoding;
83using WTF::Latin1Encoding;
84using WTF::UTF16BigEndianEncoding;
85using WTF::UTF16LittleEndianEncoding;
86using WTF::UTF32BigEndianEncoding;
87using WTF::UTF32LittleEndianEncoding;
88using WTF::UTF8Encoding;
89using WTF::WindowsLatin1Encoding;
90
91#endif // TextEncoding_h
92