forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkSmartPointerBase.h
134 lines (113 loc) · 3.89 KB
/
vtkSmartPointerBase.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/*=========================================================================
Program: Visualization Toolkit
Module: vtkSmartPointerBase.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkSmartPointerBase
* @brief Non-templated superclass for vtkSmartPointer.
*
* vtkSmartPointerBase holds a pointer to a vtkObjectBase or subclass
* instance and performs one Register/UnRegister pair. This is useful
* for storing VTK objects in STL containers. This class is not
* intended to be used directly. Instead, use the vtkSmartPointer
* class template to automatically perform proper cast operations.
*/
#ifndef vtkSmartPointerBase_h
#define vtkSmartPointerBase_h
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObjectBase.h"
class VTKCOMMONCORE_EXPORT vtkSmartPointerBase
{
public:
/**
* Initialize smart pointer to NULL.
*/
vtkSmartPointerBase();
/**
* Initialize smart pointer to given object.
*/
vtkSmartPointerBase(vtkObjectBase* r);
/**
* Initialize smart pointer with a new reference to the same object
* referenced by given smart pointer.
*/
vtkSmartPointerBase(const vtkSmartPointerBase& r);
/**
* Destroy smart pointer and remove the reference to its object.
*/
~vtkSmartPointerBase();
//@{
/**
* Assign object to reference. This removes any reference to an old
* object.
*/
vtkSmartPointerBase& operator=(vtkObjectBase* r);
vtkSmartPointerBase& operator=(const vtkSmartPointerBase& r);
//@}
/**
* Get the contained pointer.
*/
vtkObjectBase* GetPointer() const
{
// Inline implementation so smart pointer comparisons can be fully
// inlined.
return this->Object;
}
/**
* Report the reference held by the smart pointer to a collector.
*/
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);
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)); \
}
/**
* Compare smart pointer values.
*/
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
/**
* Streaming operator to print smart pointer like regular pointers.
*/
VTKCOMMONCORE_EXPORT ostream& operator << (ostream& os,
const vtkSmartPointerBase& p);
#endif
// VTK-HeaderTest-Exclude: vtkSmartPointerBase.h