src/third_party/WebKit/Source/modules/encoding/TextDecoder.h

   1 /*
   2  * Copyright (C) 2013 Google 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 are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef TextDecoder_h
  32 #define TextDecoder_h
  33
  34 #include "bindings/core/v8/ScriptWrappable.h"
  35 #include "modules/encoding/TextDecodeOptions.h"
  36 #include "modules/encoding/TextDecoderOptions.h"
  37 #include "platform/heap/Handle.h"
  38 #include "wtf/text/TextCodec.h"
  39 #include "wtf/text/TextEncoding.h"
  40 #include "wtf/text/WTFString.h"
  41
  42 namespace blink {
  43
  44 class DOMArrayBufferView;
  45 class ExceptionState;
  46
  47 class TextDecoder final : public GarbageCollectedFinalized<TextDecoder>, public ScriptWrappable {
  48     DEFINE_WRAPPERTYPEINFO();
  49 public:
  50     static TextDecoder* create(const String& label, const TextDecoderOptions&, ExceptionState&);
  51     ~TextDecoder();
  52
  53     // Implement the IDL
  54     String encoding() const;
  55     bool fatal() const { return m_fatal; }
  56     bool ignoreBOM() const { return m_ignoreBOM; }
  57     String decode(DOMArrayBufferView*, const TextDecodeOptions&, ExceptionState&);
  58     String decode(ExceptionState&);
  59
  60     void trace(Visitor*) { }
  61
  62 private:
  63     TextDecoder(const WTF::TextEncoding&, bool fatal, bool ignoreBOM);
  64
  65     WTF::TextEncoding m_encoding;
  66     OwnPtr<WTF::TextCodec> m_codec;
  67     bool m_fatal;
  68     bool m_ignoreBOM;
  69     bool m_bomSeen;
  70 };
  71
  72 } // namespace blink
  73
  74 #endif // TextDecoder_h