From 6d5f4b9bd3bf2f84bb030b023c900954ea4269bf Mon Sep 17 00:00:00 2001
From: David Rose <david@ddrose.com>
Date: Thu, 11 Oct 2001 23:19:47 +0000
Subject: [PATCH] add DelayDelete object

---
 direct/src/distributed/DelayDelete.py       | 33 +++++++++++++++++++++
 direct/src/distributed/DistributedObject.py |  2 ++
 2 files changed, 35 insertions(+)
 create mode 100644 direct/src/distributed/DelayDelete.py

diff --git a/direct/src/distributed/DelayDelete.py b/direct/src/distributed/DelayDelete.py
new file mode 100644
index 0000000000..db75121428
--- /dev/null
+++ b/direct/src/distributed/DelayDelete.py
@@ -0,0 +1,33 @@
+"""DelayDelete module: contains the DelayDelete class"""
+
+class DelayDelete:
+    """
+    The DelayDelete class is a special class whose sole purpose is
+    management of the DistributedObject.delayDelete() counter.
+
+    Normally, a DistributedObject has a delayDelete count of 0.  When
+    we need to bracket a region of code that cannot tolerate a
+    DistributedObject being deleted, we call do.delayDelete(1) to
+    increment the delayDelete count by 1.  While the count is nonzero,
+    the object will not be deleted.  Outside of our critical code, we
+    call do.delayDelete(0) to decrement the delayDelete count and
+    allow the object to be deleted once again.
+
+    Explicit management of this counter is tedious and risky.  This
+    class implicitly manages the counter by incrementing the count in
+    the constructor, and decrementing it in the destructor.  This
+    guarantees that every increment is matched up by a corresponding
+    decrement.
+
+    Thus, to temporarily protect a DistributedObject from deletion,
+    simply create a DelayDelete object.  While the DelayDelete object
+    exists, the DistributedObject will not be deleted; when the
+    DelayDelete object ceases to exist, it may be deleted.
+    """
+
+    def __init__(self, distObj):
+        self.distObj = distObj
+        self.distObj.delayDelete(1)
+
+    def __del__(self):
+        self.distObj.delayDelete(0)
diff --git a/direct/src/distributed/DistributedObject.py b/direct/src/distributed/DistributedObject.py
index 5acd096c40..e08f21d08c 100644
--- a/direct/src/distributed/DistributedObject.py
+++ b/direct/src/distributed/DistributedObject.py
@@ -69,6 +69,8 @@ class DistributedObject(PandaObject):
 
     def delayDelete(self, flag):
         # Flag should be 0 or 1, meaning increment or decrement count
+        # Also see DelayDelete.py
+
         if (flag == 1):
             self.delayDeleteCount += 1
         elif (flag == 0):