All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
refBase.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef TF_REFBASE_H
25 #define TF_REFBASE_H
26 
29 
30 #include "pxr/pxr.h"
31 
32 #include "pxr/base/tf/diagnostic.h"
33 #include "pxr/base/tf/refCount.h"
34 #include "pxr/base/tf/api.h"
35 
36 PXR_NAMESPACE_OPEN_SCOPE
37 
38 template <class T> class TfRefPtr;
39 template <class T> class TfWeakPtr;
40 
72 class TfRefBase {
73 public:
74 
75  typedef void (*UniqueChangedFuncPtr)(TfRefBase const *, bool);
76  struct UniqueChangedListener {
77  void (*lock)();
78  UniqueChangedFuncPtr func;
79  void (*unlock)();
80  };
81 
82  TfRefBase() : _shouldInvokeUniqueChangedListener(false) { }
83 
85  size_t GetCurrentCount() const {
86  return GetRefCount().Get();
87  }
88 
90  bool IsUnique() const {
91  return GetRefCount().Get() == 1;
92  }
93 
94  const TfRefCount& GetRefCount() const {
95  return _refCount;
96  }
97 
98  void SetShouldInvokeUniqueChangedListener(bool shouldCall) {
99  _shouldInvokeUniqueChangedListener = shouldCall;
100  }
101 
102  TF_API static void SetUniqueChangedListener(UniqueChangedListener listener);
103 
104 protected:
105  /*
106  * Prohibit deletion through a TfRefBase pointer.
107  */
108  TF_API virtual ~TfRefBase();
109 
110 private:
111  TfRefCount _refCount;
112  bool _shouldInvokeUniqueChangedListener;
113 
114  static UniqueChangedListener _uniqueChangedListener;
115  template <typename T> friend class TfRefPtr;
116  friend struct Tf_RefPtr_UniqueChangedCounter;
117  friend struct Tf_RefPtr_Counter;
118 
119  template <typename T> friend TfRefPtr<T>
121 };
122 
132 class TfSimpleRefBase : public TfRefBase {
133 public:
134  TF_API virtual ~TfSimpleRefBase();
135 };
136 
137 PXR_NAMESPACE_CLOSE_SCOPE
138 
139 #endif // TF_REFBASE_H
int Get() const
Returns counter&#39;s value.
Definition: refCount.h:85
friend TfRefPtr< T > TfCreateRefPtrFromProtectedWeakPtr(TfWeakPtr< T > const &)
Thread-safe creation of a Tf ref pointer from a Tf weak pointer.
Definition: weakPtr.h:262
Reference counter class.
Definition: refCount.h:71
size_t GetCurrentCount() const
Return the current reference count of this object.
Definition: refBase.h:85
Pointer storage with deletion detection.
Definition: hash.h:44
Enable a concrete base class for use with TfRefPtr.
Definition: refBase.h:72
Enable a concrete base class for use with TfRefPtr that inhibits the &quot;unique changed&quot; facility of TfR...
Definition: refBase.h:132
bool IsUnique() const
Return true if only one TfRefPtr points to this object.
Definition: refBase.h:90
Reference-counted smart pointer utility class.
Definition: hash.h:45