/* 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 nsHtml5OwningUTF16Buffer_h
#define nsHtml5OwningUTF16Buffer_h

#include "nsHtml5UTF16Buffer.h"
#include "mozilla/Span.h"

class nsHtml5OwningUTF16Buffer : public nsHtml5UTF16Buffer {
 public:
  NS_INLINE_DECL_THREADSAFE_REFCOUNTING(nsHtml5OwningUTF16Buffer)

 private:
  /**
   * Passes a buffer and its length to the superclass constructor.
   */
  explicit nsHtml5OwningUTF16Buffer(char16_t* aBuffer);

 public:
  /**
   * Constructor for a parser key placeholder. (No actual buffer.)
   * @param aKey a parser key
   */
  explicit nsHtml5OwningUTF16Buffer(void* aKey);

 protected:
  /**
   * Takes care of releasing the owned buffer.
   */
  ~nsHtml5OwningUTF16Buffer();

 public:
  /**
   * The next buffer in a queue.
   */
  RefPtr<nsHtml5OwningUTF16Buffer> next;

  /**
   * A parser key.
   */
  void* key;

  static already_AddRefed<nsHtml5OwningUTF16Buffer> FalliblyCreate(
      int32_t aLength);

  /**
   * Swap start, end and buffer fields with another object.
   */
  void Swap(nsHtml5OwningUTF16Buffer* aOther);

  /**
   * Return a span from `end` to `aBufferSize`.
   */
  mozilla::Span<char16_t> TailAsSpan(int32_t aBufferSize);

  /**
   * Add the argument to `end`.
   */
  void AdvanceEnd(int32_t aNumberOfCodeUnits);
};

#endif  // nsHtml5OwningUTF16Buffer_h
