In OwnedPtrDeleter<T>, store a vptr for a behavior function.
[zcpointer.git] / zcpointer.h
index 06ce70c21c00b859e961382f4405cf9e9322df52..2301ef190e3fda8bca83a74ad1487de78f8476bb 100644 (file)
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+#ifndef ZCPOINTER_ZCPOINTER_H_
+#define ZCPOINTER_ZCPOINTER_H_
+
 #include <limits>
 #include <memory>
 #include <forward_list>
+#include <stdexcept>
+#include <utility>
 
 namespace zc {
 
+class UseAfterFreeError : public std::logic_error {
+ public:
+  using std::logic_error::logic_error;
+};
+
 #if defined(ZCPOINTER_TRACK_REFS) && ZCPOINTER_TRACK_REFS
 
 template <typename T> class ref;
 
 namespace internal {
 
+enum class OwnershipBehavior {
+  DELETE_POINTER,
+  BORROW_POINTER,
+};
+
 template <typename T>
 class OwnedPtrDeleter {
  public:
-  OwnedPtrDeleter() {}
+  OwnedPtrDeleter()
+      : refs_(),
+        finalizer_(&OwnedPtrDeleter<T>::HandleDeletePointer) {}
+
   ~OwnedPtrDeleter() {}
 
-  OwnedPtrDeleter(OwnedPtrDeleter&& other) : refs_(std::move(other.refs_)) {
+  explicit OwnedPtrDeleter(OwnershipBehavior behavior)
+      : refs_(),
+        finalizer_(behavior == OwnershipBehavior::BORROW_POINTER
+                       ? &OwnedPtrDeleter<T>::HandleBorrowPointer
+                       : &OwnedPtrDeleter<T>::HandleDeletePointer) {
+  }
+
+  OwnedPtrDeleter(OwnedPtrDeleter&& other)
+      : refs_(std::move(other.refs_)),
+        finalizer_(other.finalizer_) {
+  }
+
+  void operator=(const OwnedPtrDeleter& o) {
+    refs_ = o.refs_;
+    finalizer_ = o.finalizer_;
   }
 
   void operator()(T* t) const {
     for (auto& ref : refs_) {
       ref->MarkDeleted();
     }
-    delete t;
+    (this->finalizer_)(t);
   }
 
  protected:
@@ -51,11 +83,18 @@ class OwnedPtrDeleter {
     refs_.remove(ref);
   }
 
+  static void HandleDeletePointer(T* t) {
+    delete t;
+  }
+
+  static void HandleBorrowPointer(T* t) {}
+
  private:
+  void (*finalizer_)(T*);
   std::forward_list<ref<T>*> refs_;
 };
 
-void RaiseUseAfterFree(const char* error) __attribute__((noreturn));
+void RaiseUseAfterFree() __attribute__((noreturn));
 
 }  // namespace internal
 
@@ -80,26 +119,33 @@ class owned : public std::unique_ptr<T, internal::OwnedPtrDeleter<T>> {
 template <typename T>
 class ref {
  public:
-  ref() : ptr_(DeletedSentinel()) {}
+  ref() : ptr_(nullptr) {}
+
+  ref(std::nullptr_t) : ref() {}
 
-  explicit ref(owned<T>& o) : ptr_(&o) {
-    ptr_->get_deleter().AddRef(this);
+  explicit ref(owned<T>& o) : ptr_(nullptr) {
+    if (o != nullptr) {
+      ptr_ = &o;
+      ptr_->get_deleter().AddRef(this);
+    }
   }
 
-  ref(const ref<T>& o) {
-    *this = o;
+  ref(const ref<T>& r) {
+    *this = r;
   }
 
   ref<T>& operator=(const ref<T>& o) {
     ptr_ = o.ptr_;
-    if (!IsDeleted()) {
+    if (ptr_ != nullptr && !IsDeleted()) {
       ptr_->get_deleter().AddRef(this);
     }
     return *this;
   }
 
   ~ref() {
-    ptr_->get_deleter().RemoveRef(this);
+    if (ptr_ != nullptr && !IsDeleted()) {
+      ptr_->get_deleter().RemoveRef(this);
+    }
     MarkDeleted();
   }
 
@@ -108,6 +154,22 @@ class ref {
     return ptr_->operator->();
   }
 
+  bool operator==(const ref<T>& r) const {
+    if (ptr_ == nullptr) {
+      return r.ptr_ == nullptr;
+    } else {
+      return ptr_ == r.ptr_ && *ptr_ == *r.ptr_;
+    }
+  }
+
+  bool operator==(std::nullptr_t) const {
+    return ptr_ == nullptr;
+  }
+
+  bool operator!=(const ref<T>& r) const {
+    return !(*this == r);
+  }
+
  protected:
   friend class internal::OwnedPtrDeleter<T>;
 
@@ -118,7 +180,7 @@ class ref {
  private:
   void CheckDeleted() const {
     if (IsDeleted()) {
-      internal::RaiseUseAfterFree("attempt to access deleted pointer");
+      internal::RaiseUseAfterFree();
     }
   }
 
@@ -133,6 +195,21 @@ class ref {
   owned<T>* ptr_;
 };
 
+template <typename T>
+class member : public T {
+ public:
+  using T::T;
+
+  ref<T> operator&() {
+    return ptr_.get();
+  }
+
+ private:
+  owned<T> ptr_ = owned<T>(this,
+                           internal::OwnedPtrDeleter<T>(
+                               internal::OwnershipBehavior::BORROW_POINTER));
+};
+
 #else
 
 template <typename T>
@@ -141,6 +218,11 @@ using owned = std::unique_ptr<T>;
 template <typename T>
 using ref = T*;
 
+template <typename T>
+using member = T;
+
 #endif
 
 }  // namespace zc
+
+#endif  // ZCPOINTER_ZCPOINTER_H_