VTK
vtkSmartPointerBase.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkSmartPointerBase.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
26 #ifndef vtkSmartPointerBase_h
27 #define vtkSmartPointerBase_h
28 
29 #include "vtkCommonCoreModule.h" // For export macro
30 #include "vtkObjectBase.h"
31 
32 class VTKCOMMONCORE_EXPORT vtkSmartPointerBase
33 {
34 public:
39 
44 
50 
55 
57 
61  vtkSmartPointerBase& operator=(vtkObjectBase* r);
62  vtkSmartPointerBase& operator=(const vtkSmartPointerBase& r);
64 
69  {
70  // Inline implementation so smart pointer comparisons can be fully
71  // inlined.
72  return this->Object;
73  }
74 
78  void Report(vtkGarbageCollector* collector, const char* desc);
79 
80 protected:
81 
82  // Initialize smart pointer to given object, but do not increment
83  // reference count. The destructor will still decrement the count.
84  // This effectively makes it an auto-ptr.
85  class NoReference {};
87 
88  // Pointer to the actual object.
90 
91 private:
92  // Internal utility methods.
93  void Swap(vtkSmartPointerBase& r);
94  void Register();
95 };
96 
97 //----------------------------------------------------------------------------
98 #define VTK_SMART_POINTER_BASE_DEFINE_OPERATOR(op) \
99  inline bool \
100  operator op (const vtkSmartPointerBase& l, const vtkSmartPointerBase& r) \
101  { \
102  return (static_cast<void*>(l.GetPointer()) op \
103  static_cast<void*>(r.GetPointer())); \
104  } \
105  inline bool \
106  operator op (vtkObjectBase* l, const vtkSmartPointerBase& r) \
107  { \
108  return (static_cast<void*>(l) op static_cast<void*>(r.GetPointer())); \
109  } \
110  inline bool \
111  operator op (const vtkSmartPointerBase& l, vtkObjectBase* r) \
112  { \
113  return (static_cast<void*>(l.GetPointer()) op static_cast<void*>(r)); \
114  }
115 
124 
125 #undef VTK_SMART_POINTER_BASE_DEFINE_OPERATOR
126 
130 VTKCOMMONCORE_EXPORT ostream& operator << (ostream& os,
131  const vtkSmartPointerBase& p);
132 
133 #endif
134 // VTK-HeaderTest-Exclude: vtkSmartPointerBase.h
#define VTK_SMART_POINTER_BASE_DEFINE_OPERATOR(op)
Detect and break reference loops.
vtkObjectBase * GetPointer() const
Get the contained pointer.
abstract base class for most VTK objects
Definition: vtkObjectBase.h:65
Non-templated superclass for vtkSmartPointer.
vtkObjectBase * Object
VTKCOMMONCORE_EXPORT ostream & operator<<(ostream &os, const vtkSmartPointerBase &p)
Compare smart pointer values.