vtkSmartPointerBase.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSmartPointerBase_h
#define vtkSmartPointerBase_h
 
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObjectBase.h"
 
VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONCORE_EXPORT vtkSmartPointerBase
{
public:
  vtkSmartPointerBase() noexcept;
 
  vtkSmartPointerBase(vtkObjectBase* r);
 
  vtkSmartPointerBase(const vtkSmartPointerBase& r);
 
  vtkSmartPointerBase(vtkSmartPointerBase&& r) noexcept
    : Object(r.Object)
  {
    r.Object = nullptr;
  }
 
  ~vtkSmartPointerBase();
 
 
  vtkSmartPointerBase& operator=(vtkObjectBase* r);
  vtkSmartPointerBase& operator=(const vtkSmartPointerBase& r);
 
  vtkObjectBase* GetPointer() const noexcept
  {
    // Inline implementation so smart pointer comparisons can be fully
    // inlined.
    return this->Object;
  }
 
  void Report(vtkGarbageCollector* collector, const char* desc);
 
protected:
  // Initialize smart pointer to given object, but do not increment
  // reference count.  The destructor will still decrement the count.
  // This effectively makes it an auto-ptr.
  class NoReference
  {
  };
  vtkSmartPointerBase(vtkObjectBase* r, const NoReference&);
 
  // Pointer to the actual object.
  vtkObjectBase* Object;
 
private:
  // Internal utility methods.
  void Swap(vtkSmartPointerBase& r) noexcept;
  void Register();
};
 
//----------------------------------------------------------------------------
#define VTK_SMART_POINTER_BASE_DEFINE_OPERATOR(op)                                                 \
  inline bool operator op(const vtkSmartPointerBase& l, const vtkSmartPointerBase& r)              \
  {                                                                                                \
    return (static_cast<void*>(l.GetPointer()) op static_cast<void*>(r.GetPointer()));             \
  }                                                                                                \
  inline bool operator op(vtkObjectBase* l, const vtkSmartPointerBase& r)                          \
  {                                                                                                \
    return (static_cast<void*>(l) op static_cast<void*>(r.GetPointer()));                          \
  }                                                                                                \
  inline bool operator op(const vtkSmartPointerBase& l, vtkObjectBase* r)                          \
  {                                                                                                \
    return (static_cast<void*>(l.GetPointer()) op static_cast<void*>(r));                          \
  }
VTK_SMART_POINTER_BASE_DEFINE_OPERATOR(==)
VTK_SMART_POINTER_BASE_DEFINE_OPERATOR(!=)
VTK_SMART_POINTER_BASE_DEFINE_OPERATOR(<)
VTK_SMART_POINTER_BASE_DEFINE_OPERATOR(<=)
VTK_SMART_POINTER_BASE_DEFINE_OPERATOR(>)
VTK_SMART_POINTER_BASE_DEFINE_OPERATOR(>=)
 
#undef VTK_SMART_POINTER_BASE_DEFINE_OPERATOR
 
VTKCOMMONCORE_EXPORT ostream& operator<<(ostream& os, const vtkSmartPointerBase& p);
 
VTK_ABI_NAMESPACE_END
#endif
// VTK-HeaderTest-Exclude: vtkSmartPointerBase.h