204d4785c5c82e346896994b12d11dd581817c3f
[WebKit-https.git] / Source / WebCore / platform / text / TextEncoding.h
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 #pragma once
27
28 #include "TextCodec.h"
29 #include <wtf/Forward.h>
30
31 namespace WebCore {
32
33 class TextEncoding {
34 public:
35     TextEncoding() = default;
36     WEBCORE_EXPORT TextEncoding(const char* name);
37     WEBCORE_EXPORT TextEncoding(const String& name);
38
39     bool isValid() const { return m_name; }
40     const char* name() const { return m_name; }
41     WEBCORE_EXPORT const char* domName() const; // name exposed via DOM
42     bool usesVisualOrdering() const;
43     bool isJapanese() const;
44
45     const TextEncoding& closestByteBasedEquivalent() const;
46     const TextEncoding& encodingForFormSubmission() const;
47
48     WEBCORE_EXPORT String decode(const char*, size_t length, bool stopOnError, bool& sawError) const;
49     String decode(const char*, size_t length) const;
50     CString encode(StringView, UnencodableHandling) const;
51
52     UChar backslashAsCurrencySymbol() const;
53     bool isByteBasedEncoding() const { return !isNonByteBasedEncoding(); }
54
55 private:
56     bool isNonByteBasedEncoding() const;
57     bool isUTF7Encoding() const;
58
59     const char* m_name { nullptr };
60     UChar m_backslashAsCurrencySymbol;
61 };
62
63 inline bool operator==(const TextEncoding& a, const TextEncoding& b) { return a.name() == b.name(); }
64 inline bool operator!=(const TextEncoding& a, const TextEncoding& b) { return a.name() != b.name(); }
65
66 const TextEncoding& ASCIIEncoding();
67 const TextEncoding& Latin1Encoding();
68 const TextEncoding& UTF16BigEndianEncoding();
69 const TextEncoding& UTF16LittleEndianEncoding();
70 const TextEncoding& UTF32BigEndianEncoding();
71 const TextEncoding& UTF32LittleEndianEncoding();
72 WEBCORE_EXPORT const TextEncoding& UTF8Encoding();
73 WEBCORE_EXPORT const TextEncoding& WindowsLatin1Encoding();
74
75 inline String TextEncoding::decode(const char* characters, size_t length) const
76 {
77     bool ignored;
78     return decode(characters, length, false, ignored);
79 }
80
81 } // namespace WebCore