Further work to improve Object reference accounting in order to plug leaks.

1 files changed, 152 insertions, 60 deletions

diff --git a/tests/oo.test b/tests/oo.test
index a698bac..fbf75b6 100644
--- a/tests/oo.test
+++ b/tests/oo.test
@@ -13,6 +13,13 @@ if {"::tcltest" in [namespace children]} {
     namespace import -force ::tcltest::*
 }
 
+
+# The foundational objects oo::object and oo::class are sensitive to reference
+# counting errors and are deallocated only when an interp is deleted, so in
+# this test suite, interp creation and interp deletion are often used in
+# leaktests in order to leverage this sensitivity.
+
+
 testConstraint memory [llength [info commands memory]]
 if {[testConstraint memory]} {
     proc getbytes {} {
@@ -271,7 +278,21 @@ test oo-1.18 {OO: create object in NS with same name as global cmd} -setup {
     rename test-oo-1.18 {}
     A destroy
 } -result ::C
-test oo-1.18.1 {Bug 75b8433707: memory leak in oo-1.18} -setup {
+test oo-1.18.1 {no memory leak: superclass} -setup {
+} -constraints memory -body {
+
+    leaktest {
+	interp create t
+	t eval {
+	    oo::class create A {
+		superclass oo::class
+	    }
+	}
+	interp delete t
+    }
+} -cleanup {
+} -result 0
+test oo-1.18.2 {Bug 75b8433707: memory leak in oo-1.18} -setup {
     proc test-oo-1.18 {} return
 } -constraints memory -body {
     leaktest {
@@ -284,7 +305,7 @@ test oo-1.18.1 {Bug 75b8433707: memory leak in oo-1.18} -setup {
 } -cleanup {
     rename test-oo-1.18 {}
 } -result 0
-test oo-1.18.2 {Bug 21c144f0f5} -setup {
+test oo-1.18.3 {Bug 21c144f0f5} -setup {
     interp create slave
 } -body {
     slave eval {
@@ -1508,7 +1529,56 @@ test oo-11.5 {OO: cleanup} {
     return done
 } done
 
-test oo-11.6 {
+test oo-11.6.1 {
+    OO: cleanup of when an class is mixed into itself
+} -constraints memory -body {
+    leaktest {
+	interp create interp1
+	oo::class create obj1
+	::oo::define obj1 {self mixin [uplevel 1 {namespace which obj1}]}
+	rename obj1 {}
+	interp delete interp1
+    }
+} -result 0 -cleanup {
+}
+
+test oo-11.6.2 {
+    OO: cleanup ReleaseClassContents() where class is mixed into one of its
+    instances
+} -body {
+    leaktest {
+	interp create interp1
+	interp1 eval {
+	    oo::class create obj1
+	    ::oo::copy obj1 obj2
+	    rename obj2 {}
+	    rename obj1 {}
+	}
+	interp delete interp1
+    }
+} -result 0 -cleanup {
+}
+
+test oo-11.6.3 {
+    OO: cleanup ReleaseClassContents() where class is mixed into one of its
+    instances
+} -body {
+    leaktest {
+	interp create interp1
+	interp1 eval {
+	    oo::class create obj1
+	    ::oo::define obj1 {self mixin [uplevel 1 {namespace which obj1}]}
+
+	    ::oo::copy obj1 obj2
+	    rename obj2 {}
+	    rename obj1 {}
+	}
+	interp delete interp1
+    }
+} -result 0 -cleanup {
+}
+
+test oo-11.6.4 {
     OO: cleanup ReleaseClassContents() where class is mixed into one of its
     instances
 } -body {
@@ -2071,7 +2141,18 @@ test oo-15.12 {OO: object cloning with target NS} -setup {
     Super destroy
     catch {namespace delete ::existing}
 } -result {::existing refers to an existing namespace}
-test oo-15.13 {OO: object cloning with target NS} -setup {
+test oo-15.13.1 {
+    OO: object cloning with target NS
+    Valgrind will report a leak if the reference count of the namespace isn't
+    properly incremented.
+} -setup {
+    oo::class create Cls {}
+} -body {
+    oo::copy Cls Cls2 ::dupens
+    return done
+} -cleanup {
+} -result done 
+test oo-15.13.2 {OO: object cloning with target NS} -setup {
     oo::class create Super
     oo::class create Cls {superclass Super}
 } -body {
@@ -3666,99 +3747,110 @@ test oo-31.2 {Bug 3111059: when objects and coroutines entangle} -setup {
     cls destroy
 } -result {0 {}}
 
-oo::class create SampleSlot {
-    superclass oo::Slot
-    constructor {} {
-	variable contents {a b c} ops {}
-    }
-    method contents {} {variable contents; return $contents}
-    method ops {} {variable ops; return $ops}
-    method Get {} {
-	variable contents
-	variable ops
-	lappend ops [info level] Get
-	return $contents
-    }
-    method Set {lst} {
-	variable contents $lst
-	variable ops
-	lappend ops [info level] Set $lst
-	return
+proc SampleSlotSetup script {
+    set script0 {
+	oo::class create SampleSlot {
+	    superclass oo::Slot
+	    constructor {} {
+		variable contents {a b c} ops {}
+	    }
+	    method contents {} {variable contents; return $contents}
+	    method ops {} {variable ops; return $ops}
+	    method Get {} {
+		variable contents
+		variable ops
+		lappend ops [info level] Get
+		return $contents
+	    }
+	    method Set {lst} {
+		variable contents $lst
+		variable ops
+		lappend ops [info level] Set $lst
+		return
+	    }
+	}
+    }
+    append script0 \n$script
+}
+
+proc SampleSlotCleanup script {
+    set script0 {
+	SampleSlot destroy
     }
+    append script \n$script0
 }
 
-test oo-32.1 {TIP 380: slots - class test} -setup {
+test oo-32.1 {TIP 380: slots - class test} -setup [SampleSlotSetup {
     SampleSlot create sampleSlot
-} -body {
+}] -body {
     list [info level] [sampleSlot contents] [sampleSlot ops]
-} -cleanup {
+} -cleanup [SampleSlotCleanup {
     rename sampleSlot {}
-} -result {0 {a b c} {}}
-test oo-32.2 {TIP 380: slots - class test} -setup {
+}] -result {0 {a b c} {}}
+test oo-32.2 {TIP 380: slots - class test} -setup [SampleSlotSetup {
     SampleSlot create sampleSlot
-} -body {
+}] -body {
     list [info level] [sampleSlot -clear] \
 	[sampleSlot contents] [sampleSlot ops]
-} -cleanup {
+} -cleanup [SampleSlotCleanup {
     rename sampleSlot {}
-} -result {0 {} {} {1 Set {}}}
-test oo-32.3 {TIP 380: slots - class test} -setup {
+}] -result {0 {} {} {1 Set {}}}
+test oo-32.3 {TIP 380: slots - class test} -setup [SampleSlotSetup {
     SampleSlot create sampleSlot
-} -body {
+}] -body {
     list [info level] [sampleSlot -append g h i] \
 	[sampleSlot contents] [sampleSlot ops]
-} -cleanup {
+} -cleanup [SampleSlotCleanup {
     rename sampleSlot {}
-} -result {0 {} {a b c g h i} {1 Get 1 Set {a b c g h i}}}
-test oo-32.4 {TIP 380: slots - class test} -setup {
+}] -result {0 {} {a b c g h i} {1 Get 1 Set {a b c g h i}}}
+test oo-32.4 {TIP 380: slots - class test} -setup [SampleSlotSetup {
     SampleSlot create sampleSlot
-} -body {
+}] -body {
     list [info level] [sampleSlot -set d e f] \
 	[sampleSlot contents] [sampleSlot ops]
-} -cleanup {
+} -cleanup [SampleSlotCleanup {
     rename sampleSlot {}
-} -result {0 {} {d e f} {1 Set {d e f}}}
-test oo-32.5 {TIP 380: slots - class test} -setup {
+}] -result {0 {} {d e f} {1 Set {d e f}}}
+test oo-32.5 {TIP 380: slots - class test} -setup [SampleSlotSetup {
     SampleSlot create sampleSlot
-} -body {
+}] -body {
     list [info level] [sampleSlot -set d e f] [sampleSlot -append g h i] \
 	[sampleSlot contents] [sampleSlot ops]
-} -cleanup {
+} -cleanup [SampleSlotCleanup {
     rename sampleSlot {}
-} -result {0 {} {} {d e f g h i} {1 Set {d e f} 1 Get 1 Set {d e f g h i}}}
+}] -result {0 {} {} {d e f g h i} {1 Set {d e f} 1 Get 1 Set {d e f g h i}}}
 
-test oo-33.1 {TIP 380: slots - defaulting} -setup {
+test oo-33.1 {TIP 380: slots - defaulting} -setup [SampleSlotSetup {
     set s [SampleSlot new]
-} -body {
+}] -body {
     list [$s x y] [$s contents]
-} -cleanup {
+} -cleanup [SampleSlotCleanup {
     rename $s {}
-} -result {{} {a b c x y}}
-test oo-33.2 {TIP 380: slots - defaulting} -setup {
+}] -result {{} {a b c x y}}
+test oo-33.2 {TIP 380: slots - defaulting} -setup [SampleSlotSetup {
     set s [SampleSlot new]
-} -body {
+}] -body {
     list [$s destroy; $s unknown] [$s contents]
-} -cleanup {
+} -cleanup [SampleSlotCleanup {
     rename $s {}
-} -result {{} {a b c destroy unknown}}
-test oo-33.3 {TIP 380: slots - defaulting} -setup {
+}] -result {{} {a b c destroy unknown}}
+test oo-33.3 {TIP 380: slots - defaulting} -setup [SampleSlotSetup {
     set s [SampleSlot new]
-} -body {
+}] -body {
     oo::objdefine $s forward --default-operation  my -set
     list [$s destroy; $s unknown] [$s contents] [$s ops]
-} -cleanup {
+} -cleanup [SampleSlotCleanup {
     rename $s {}
-} -result {{} unknown {1 Set destroy 1 Set unknown}}
-test oo-33.4 {TIP 380: slots - errors} -setup {
+}] -result {{} unknown {1 Set destroy 1 Set unknown}}
+test oo-33.4 {TIP 380: slots - errors} -setup [SampleSlotSetup {
     set s [SampleSlot new]
-} -body {
+}] -body {
     # Method names beginning with "-" are special to slots
     $s -grill q
-} -returnCodes error -cleanup {
+} -returnCodes error -cleanup [SampleSlotCleanup {
     rename $s {}
-} -result {unknown method "-grill": must be -append, -clear, -set, contents or ops}
-
-SampleSlot destroy
+}] -result \
+    {unknown method "-grill": must be -append, -clear, -set, contents or ops}
 
 test oo-34.1 {TIP 380: slots - presence} -setup {
     set obj [oo::object new]