/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */

/* vim: set ts=8 sts=2 et sw=2 tw=80: */

/* This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this file,

 * You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_dom_textdecoder_h_

#define mozilla_dom_textdecoder_h_

#include "mozilla/dom/NonRefcountedDOMObject.h"

#include "mozilla/dom/TextDecoderBinding.h"

#include "mozilla/dom/TypedArray.h"

#include "nsAutoPtr.h"

#include "mozilla/Encoding.h"

namespace mozilla {

class ErrorResult;

namespace dom {

class ArrayBufferViewOrArrayBuffer;

class TextDecoder final

  : public NonRefcountedDOMObject

{

public:

  // The WebIDL constructor.

  static TextDecoder*

  Constructor(const GlobalObject& aGlobal,

              const nsAString& aEncoding,

              const TextDecoderOptions& aOptions,

              ErrorResult& aRv)

  {

    nsAutoPtr<TextDecoder> txtDecoder(new TextDecoder());

    txtDecoder->Init(aEncoding, aOptions, aRv);

    if (aRv.Failed()) {

      return nullptr;

    }

    return txtDecoder.forget();

  }

  TextDecoder()

    : mFatal(false)

    , mIgnoreBOM(false)

  {

    MOZ_COUNT_CTOR(TextDecoder);

  }

  ~TextDecoder()

  {

    MOZ_COUNT_DTOR(TextDecoder);

  }

  bool WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto, JS::MutableHandle<JSObject*> aReflector)

  {

    return TextDecoder_Binding::Wrap(aCx, this, aGivenProto, aReflector);

  }

  /**

   * Validates provided label and throws an exception if invalid label.

   *

   * @param aLabel       The encoding label (case insensitive) provided.

   * @param aOptions     The TextDecoderOptions to use.

   * @return aRv         EncodingError exception else null.

   */

  void Init(const nsAString& aLabel, const TextDecoderOptions& aOptions,

            ErrorResult& aRv);

  /**

   * Performs initialization with a Gecko-canonical encoding name (as opposed

   * to a label.)

   *

   * @param aEncoding    An Encoding object

   * @param aOptions     The TextDecoderOptions to use.

   */

  void InitWithEncoding(NotNull<const Encoding*> aEncoding,

                        const TextDecoderOptions& aOptions);

  /**

   * Return the encoding name.

   *

   * @param aEncoding, current encoding.

   */

  void GetEncoding(nsAString& aEncoding);

  /**

   * Decodes incoming byte stream of characters in charset indicated by

   * encoding.

   *

   * The encoding algorithm state is reset if aOptions.mStream is not set.

   *

   * If the fatal flag is set then a decoding error will throw EncodingError.

   * Else the decoder will return a decoded string with replacement

   * character(s) for unidentified character(s).

   *

   * @param      aView, incoming byte stream of characters to be decoded to

   *                    to UTF-16 code points.

   * @param      aOptions, indicates if streaming or not.

   * @param      aOutDecodedString, decoded string of UTF-16 code points.

   * @param      aRv, error result.

   */

  void Decode(mozilla::Span<const uint8_t> aInput,

              const bool aStream,

              nsAString& aOutDecodedString,

              ErrorResult& aRv);

  void Decode(const Optional<ArrayBufferViewOrArrayBuffer>& aBuffer,

              const TextDecodeOptions& aOptions,

              nsAString& aOutDecodedString,

              ErrorResult& aRv);

  bool Fatal() const {

    return mFatal;

  }

  bool IgnoreBOM() const {

    return mIgnoreBOM;

  }

private:

  nsCString mEncoding;

  mozilla::UniquePtr<mozilla::Decoder> mDecoder;

  bool mFatal;

  bool mIgnoreBOM;

};

} // namespace dom

} // namespace mozilla

#endif // mozilla_dom_textdecoder_h_