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