Modernize some aspects of text codecs, eliminate WebKit use of strcasecmp
[WebKit-https.git] / Source / WebCore / platform / text / TextCodec.h
1 /*
2  * Copyright (C) 2004-2017 Apple Inc. All rights reserved.
3  * Copyright (C) 2006 Alexey Proskuryakov <ap@nypop.com>
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #pragma once
28
29 #include <memory>
30 #include <pal/text/UnencodableHandling.h>
31 #include <unicode/umachine.h>
32 #include <wtf/Forward.h>
33 #include <wtf/Noncopyable.h>
34
35 namespace WebCore {
36
37 class TextEncoding;
38
39 using UnencodableReplacementArray = std::array<char, 32>;
40
41 class TextCodec {
42     WTF_MAKE_NONCOPYABLE(TextCodec); WTF_MAKE_FAST_ALLOCATED;
43 public:
44     TextCodec() = default;
45     virtual ~TextCodec() = default;
46
47     virtual String decode(const char*, size_t length, bool flush, bool stopOnError, bool& sawError) = 0;
48     virtual Vector<uint8_t> encode(StringView, UnencodableHandling) = 0;
49
50     // Fills a null-terminated string representation of the given
51     // unencodable character into the given replacement buffer.
52     // The length of the string (not including the null) will be returned.
53     static int getUnencodableReplacement(UChar32, UnencodableHandling, UnencodableReplacementArray&);
54 };
55
56 using EncodingNameRegistrar = void (*)(const char* alias, const char* name);
57
58 using NewTextCodecFunction = WTF::Function<std::unique_ptr<TextCodec>()>;
59 using TextCodecRegistrar = void (*)(const char* name, NewTextCodecFunction&&);
60
61 } // namespace WebCore
62