// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
 * @class   vtkWeakPointerBase
 * @brief   Non-templated superclass for vtkWeakPointer.
 *
 * vtkWeakPointerBase holds a pointer to a vtkObjectBase or subclass
 * instance, but it never affects the reference count of the vtkObjectBase. However,
 * when the vtkObjectBase referred to is destroyed, the pointer gets initialized to
 * nullptr, thus avoid dangling references.
 */

#ifndef vtkWeakPointerBase_h
#define vtkWeakPointerBase_h

#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObjectBase.h"

VTK_ABI_NAMESPACE_BEGIN
class vtkObjectBaseToWeakPointerBaseFriendship;

class VTKCOMMONCORE_EXPORT vtkWeakPointerBase
{
public:
  /**
   * Initialize smart pointer to nullptr.
   */
  vtkWeakPointerBase() noexcept
    : Object(nullptr)
  {
  }

  /**
   * Initialize smart pointer to given object.
   */
  vtkWeakPointerBase(vtkObjectBase* r);

  /**
   * Copy r's data object into the new weak pointer.
   */
  vtkWeakPointerBase(const vtkWeakPointerBase& r);

  /**
   * Move r's object into the new weak pointer, setting r to nullptr.
   */
  vtkWeakPointerBase(vtkWeakPointerBase&& r) noexcept;

  /**
   * Destroy smart pointer.
   */
  ~vtkWeakPointerBase();

  ///@{
  /**
   * Assign object to reference.  This removes any reference to an old
   * object.
   */
  vtkWeakPointerBase& operator=(vtkObjectBase* r);
  vtkWeakPointerBase& operator=(const vtkWeakPointerBase& r);
  vtkWeakPointerBase& operator=(vtkWeakPointerBase&& r) noexcept;
  ///@}

  /**
   * Get the contained pointer.
   */
  vtkObjectBase* GetPointer() const
  {
    // Inline implementation so smart pointer comparisons can be fully
    // inlined.
    return this->Object;
  }

private:
  friend class vtkObjectBaseToWeakPointerBaseFriendship;

protected:
  // Initialize weak pointer to given object.
  class NoReference
  {
  };
  vtkWeakPointerBase(vtkObjectBase* r, const NoReference&);

  // Pointer to the actual object.
  vtkObjectBase* Object;
};

//----------------------------------------------------------------------------
#define VTK_WEAK_POINTER_BASE_DEFINE_OPERATOR(op)                                                  \
  inline bool operator op(const vtkWeakPointerBase& l, const vtkWeakPointerBase& r)                \
  {                                                                                                \
    return (static_cast<void*>(l.GetPointer()) op static_cast<void*>(r.GetPointer()));             \
  }                                                                                                \
  inline bool operator op(vtkObjectBase* l, const vtkWeakPointerBase& r)                           \
  {                                                                                                \
    return (static_cast<void*>(l) op static_cast<void*>(r.GetPointer()));                          \
  }                                                                                                \
  inline bool operator op(const vtkWeakPointerBase& l, vtkObjectBase* r)                           \
  {                                                                                                \
    return (static_cast<void*>(l.GetPointer()) op static_cast<void*>(r));                          \
  }
/**
 * Compare smart pointer values.
 */
VTK_WEAK_POINTER_BASE_DEFINE_OPERATOR(==)
VTK_WEAK_POINTER_BASE_DEFINE_OPERATOR(!=)
VTK_WEAK_POINTER_BASE_DEFINE_OPERATOR(<)
VTK_WEAK_POINTER_BASE_DEFINE_OPERATOR(<=)
VTK_WEAK_POINTER_BASE_DEFINE_OPERATOR(>)
VTK_WEAK_POINTER_BASE_DEFINE_OPERATOR(>=)

#undef VTK_WEAK_POINTER_BASE_DEFINE_OPERATOR

/**
 * Streaming operator to print smart pointer like regular pointers.
 */
VTKCOMMONCORE_EXPORT ostream& operator<<(ostream& os, const vtkWeakPointerBase& p);

VTK_ABI_NAMESPACE_END
#endif
// VTK-HeaderTest-Exclude: vtkWeakPointerBase.h
