1/*
2 * Copyright (C) 2016 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 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
20 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 */
24
25#pragma once
26
27#include "BufferSource.h"
28#include "ExceptionOr.h"
29#include "TextEncoding.h"
30#include <wtf/RefCounted.h>
31#include <wtf/text/WTFString.h>
32
33namespace WebCore {
34
35class TextDecoder : public RefCounted<TextDecoder> {
36public:
37 struct Options {
38 bool fatal { false };
39 bool ignoreBOM { false };
40 };
41 struct DecodeOptions {
42 bool stream { false };
43 };
44
45 static ExceptionOr<Ref<TextDecoder>> create(const String& label, Options);
46
47 String encoding() const;
48 bool fatal() const { return m_options.fatal; }
49 bool ignoreBOM() const { return m_options.ignoreBOM; }
50 ExceptionOr<String> decode(Optional<BufferSource::VariantType>, DecodeOptions);
51
52private:
53 String prependBOMIfNecessary(const String&);
54 void ignoreBOMIfNecessary(const uint8_t*& data, size_t& length);
55 TextDecoder(const char*, Options);
56 TextEncoding m_textEncoding;
57 Options m_options;
58 bool m_hasDecoded { false };
59 Vector<uint8_t> m_buffer;
60};
61
62}
63