1 files changed, 55 insertions, 0 deletions
diff --git a/addons/gut/orphan_counter.gd b/addons/gut/orphan_counter.gd
new file mode 100644
index 0000000..cbfbea4
--- /dev/null
+++ b/addons/gut/orphan_counter.gd
@@ -0,0 +1,55 @@
+# ##############################################################################
+#(G)odot (U)nit (T)est class
+#
+# ##############################################################################
+# The MIT License (MIT)
+# =====================
+#
+# Copyright (c) 2020 Tom "Butch" Wesley
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# ##############################################################################
+# This is a utility for tracking changes in the orphan count.  Each time
+# add_counter is called it adds/resets the value in the dictionary to the
+# current number of orphans.  Each call to get_counter will return the change
+# in orphans since add_counter was last called.
+# ##############################################################################
+var _counters = {}
+
+func orphan_count():
+	return Performance.get_monitor(Performance.OBJECT_ORPHAN_NODE_COUNT)
+
+func add_counter(name):
+	_counters[name] = orphan_count()
+
+# Returns the number of orphans created since add_counter was last called for
+# the name.  Returns -1 to avoid blowing up with an invalid name but still
+# be somewhat visible that we've done something wrong.
+func get_counter(name):
+	return orphan_count() - _counters[name] if _counters.has(name) else -1
+
+func print_orphans(name, lgr):
+	var count = get_counter(name)
+
+	if(count > 0):
+		var o = 'orphan'
+		if(count > 1):
+			o = 'orphans'
+		lgr.orphan(str(count, ' new ', o, '(', name, ').'))