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

#include "FastFrontRemovableArray.h"
#include "nsContentUtils.h"

class nsINode;
template <typename T>
class RefPtr;

namespace mozilla::dom {

// A sorted tree-ordered list of pointers (either raw or RefPtr) to nodes.
template <typename NodePointer, TreeKind K = TreeKind::DOM>
class TreeOrderedArray : public FastFrontRemovableArray<NodePointer, 1> {
  using Base = FastFrontRemovableArray<NodePointer, 1>;

  template <typename T>
  struct RawTypeExtractor {};

  template <typename T>
  struct RawTypeExtractor<T*> {
    using type = T;
  };

  template <typename T>
  struct RawTypeExtractor<RefPtr<T>> {
    using type = T;
  };

  using Node = typename RawTypeExtractor<NodePointer>::type;

 public:
  // Inserts a node into the list, and returns the new index in the array.
  //
  // All the nodes in the list should be in the same subtree, and debug builds
  // assert this.
  //
  // It's also forbidden to call Insert() with the same node multiple times, and
  // it will assert as well.
  //
  // You can provide a potential common ancestor to speed up comparisons, see
  // nsContentUtils::CompareTreePosition. That's only a hint.
  inline size_t Insert(Node&, nsINode* aCommonAncestor = nullptr);
  bool RemoveElement(Node& aNode) { return Base::RemoveElement(&aNode); }
};

}  // namespace mozilla::dom

#endif