forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkWeakPointerBase.h
130 lines (109 loc) · 4.27 KB
/
vtkWeakPointerBase.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
/*=========================================================================
Program: Visualization Toolkit
Module: vtkWeakPointerBase.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 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"
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);
#endif
// VTK-HeaderTest-Exclude: vtkWeakPointerBase.h