/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkTreeContainer_h
#define itkTreeContainer_h

#include "itkTreeContainerBase.h"
#include "itkPreOrderTreeIterator.h"

namespace itk
{
/** \class TreeContainer
 *  \brief A tree container.
 *
 * This class derives from the TreeContainerBase class.
 * The class is templated over the type of the elements.
 *
 * \tparam TValue Element type stored at each location in the Tree.
 *
 * \ingroup DataRepresentation
 * \ingroup ITKDeprecated
 */
template <typename TValue>
class ITK_TEMPLATE_EXPORT TreeContainer : public TreeContainerBase<TValue>
{
public:
  /** Standard type alias */
  using Superclass = TreeContainerBase<TValue>;
  using Self = TreeContainer<TValue>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
  using ValueType = TValue;
  using TreeNodeType = TreeNode<ValueType>;

  /** Iterators type alias */
  using IteratorType = TreeIteratorBase<Self>;
  using PreOrderIteratorType = PreOrderTreeIterator<Self>;

  /** Method for creation through the object factory. */
  itkNewMacro(Self);

  /** \see LightObject::GetNameOfClass() */
  itkOverrideGetNameOfClassMacro(TreeContainer);

  /** Constructor with default children count. */
  TreeContainer(int defaultChildrenCount);

  /** Constructor by adding a tree. */
  TreeContainer(TreeContainer<TValue> & tree);

  /** Set the specified element as the root. */
  bool
  SetRoot(const TValue element) override;

  /** Set the specified iterator position as the root. */
  bool
  SetRoot(IteratorType & pos);

  /** Set the specified tree node as the root. */
  bool
  SetRoot(TreeNode<TValue> * node) override;

  /** Return true if the element is in the tree. */
  bool
  Contains(const TValue element) override;

  /** Return the number of elements in the tree. */
  int
  Count() const override;

  /** Return true if the node containing the given element is a leaf of the tree. */
  bool
  IsLeaf(const TValue element) override;

  /** Return true if the node containing the given element is the root. */
  bool
  IsRoot(const TValue element) override;

  /** Clear the tree. */
  bool
  Clear() override;

  /** operator equal. */
  bool
  operator==(TreeContainer<TValue> & tree);

  /** Swap the iterators. */
  bool
  Swap(IteratorType & v, IteratorType & w);

  /** Get the root. */
  const TreeNodeType *
  GetRoot() const override
  {
    return m_Root.GetPointer();
  }

  /** Add a child to a given parent. */
  bool
  Add(const TValue child, const TValue parent);

  /** Get the node corresponding to the given a value. */
  const TreeNodeType *
  GetNode(TValue val) const;

protected:
  TreeContainer();
  ~TreeContainer() override = default;

  typename TreeNodeType::Pointer m_Root{};

  int m_DefaultChildrenCount{};

  void
  PrintSelf(std::ostream & os, Indent indent) const override;
};
} // namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkTreeContainer.hxx"
#endif

#endif