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 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 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 "TextCodec.h"
30#include <wtf/Forward.h>
31
32namespace WebCore {
33
34    class TextEncoding {
35    public:
36        TextEncoding() : m_name(0) { }
37        TextEncoding(const char* name);
38        TextEncoding(const String& name);
39
40        bool isValid() const { return m_name; }
41        const char* name() const { return m_name; }
42        const char* domName() const; // name exposed via DOM
43        bool usesVisualOrdering() const;
44        bool isJapanese() const;
45
46        PassRefPtr<StringImpl> displayString(PassRefPtr<StringImpl> str) const
47        {
48            if (m_backslashAsCurrencySymbol == '\\' || !str)
49                return str;
50            return str->replace('\\', m_backslashAsCurrencySymbol);
51        }
52        template <typename CharacterType>
53        void displayBuffer(CharacterType* characters, unsigned len) const
54        {
55            if (m_backslashAsCurrencySymbol == '\\')
56                return;
57            for (unsigned i = 0; i < len; ++i) {
58                if (characters[i] == '\\')
59                    characters[i] = m_backslashAsCurrencySymbol;
60            }
61        }
62
63        const TextEncoding& closestByteBasedEquivalent() const;
64        const TextEncoding& encodingForFormSubmission() const;
65
66        String decode(const char* str, size_t length) const
67        {
68            bool ignored;
69            return decode(str, length, false, ignored);
70        }
71        String decode(const char*, size_t length, bool stopOnError, bool& sawError) const;
72        CString encode(StringView, UnencodableHandling) const;
73
74        UChar backslashAsCurrencySymbol() const;
75
76    private:
77        bool isNonByteBasedEncoding() const;
78        bool isUTF7Encoding() const;
79
80        const char* m_name;
81        UChar m_backslashAsCurrencySymbol;
82    };
83
84    inline bool operator==(const TextEncoding& a, const TextEncoding& b) { return a.name() == b.name(); }
85    inline bool operator!=(const TextEncoding& a, const TextEncoding& b) { return a.name() != b.name(); }
86
87    const TextEncoding& ASCIIEncoding();
88    const TextEncoding& Latin1Encoding();
89    const TextEncoding& UTF16BigEndianEncoding();
90    const TextEncoding& UTF16LittleEndianEncoding();
91    const TextEncoding& UTF32BigEndianEncoding();
92    const TextEncoding& UTF32LittleEndianEncoding();
93    const TextEncoding& UTF8Encoding();
94    const TextEncoding& WindowsLatin1Encoding();
95
96} // namespace WebCore
97
98#endif // TextEncoding_h
99