jyapayne/godot-nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Break reference cycle in NimGodotObject

Browse source
This commit is contained in:
Ruslan Mustakov 2020-06-05 16:53:34 +07:00
commit 3f46e3c648
2 changed files with 12 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
godot.nimble
View file

@ -1,4 +1,4 @@
version = "0.7.28" version = "0.8.0"
author = "Xored Software, Inc." author = "Xored Software, Inc."
description = "Godot Engine bindings" description = "Godot Engine bindings"
license = "MIT" license = "MIT"

14
godot/nim/godotnim.nim
View file

@ -31,7 +31,7 @@ type
## The base type all Godot types inherit from. ## The base type all Godot types inherit from.
## Manages lifecycle of the wrapped ``GodotObject``. ## Manages lifecycle of the wrapped ``GodotObject``.
godotObject: ptr GodotObject godotObject: ptr GodotObject
linkedObject: NimGodotObject linkedObjectPtr: pointer
## Wrapper around native object that is the container of the Nim "script" ## Wrapper around native object that is the container of the Nim "script"
## This is needed for `of` checks and `as` conversions to work as ## This is needed for `of` checks and `as` conversions to work as
## expected. For example, Nim type may inherit from ``Spatial``, but the ## expected. For example, Nim type may inherit from ``Spatial``, but the
@ -39,6 +39,8 @@ type
## ``Particles`` is valid, but Nim type system is not aware of that. ## ``Particles`` is valid, but Nim type system is not aware of that.
## This works in both directions - for linked native object this ## This works in both directions - for linked native object this
## reference points to Nim object. ## reference points to Nim object.
## This is stored as a raw pointer to avoid reference cycles and therefore
## improve GC performance.
isRef*: bool isRef*: bool
isFinalized: bool isFinalized: bool
isNative: bool isNative: bool
@ -185,6 +187,9 @@ proc deinit*(obj: NimGodotObject) =
obj.godotObject.deinit() obj.godotObject.deinit()
obj.godotObject = nil obj.godotObject = nil
proc linkedObject(obj: NimGodotObject): NimGodotObject {.inline.} =
cast[NimGodotObject](obj.linkedObjectPtr)
proc nimGodotObjectFinalizer*[T: NimGodotObject](obj: T) = proc nimGodotObjectFinalizer*[T: NimGodotObject](obj: T) =
if obj.godotObject.isNil or obj.isNative: return if obj.godotObject.isNil or obj.isNative: return
# important to set it before so that ``unreference`` is aware # important to set it before so that ``unreference`` is aware
@ -465,14 +470,17 @@ proc setGodotObject*(nimObj: NimGodotObject, obj: ptr GodotObject) {.inline.} =
proc setNativeObject*(nimObj: NimGodotObject, proc setNativeObject*(nimObj: NimGodotObject,
nativeObj: NimGodotObject) {.inline.} = nativeObj: NimGodotObject) {.inline.} =
## Used from Godot constructor produced by ``gdobj`` macro. Do not call. ## Used from Godot constructor produced by ``gdobj`` macro. Do not call.
nimObj.linkedObject = nativeObj GC_ref(nativeObj)
nativeObj.linkedObject = nimObj nimObj.linkedObjectPtr = cast[pointer](nativeObj)
nativeObj.linkedObjectPtr = cast[pointer](nimObj)
nativeObj.isNative = true nativeObj.isNative = true
proc removeGodotObject*(nimObj: NimGodotObject) {.inline.} = proc removeGodotObject*(nimObj: NimGodotObject) {.inline.} =
## Used from Godot destructor produced by ``gdobj`` macro. Do not call. ## Used from Godot destructor produced by ``gdobj`` macro. Do not call.
GC_unref(nimObj.linkedObject)
nimObj.godotObject = nil nimObj.godotObject = nil
nimObj.linkedObject.godotObject = nil nimObj.linkedObject.godotObject = nil
nimObj.linkedObjectPtr = nil
proc `==`*(self, other: NimGodotObject): bool {.inline.} = proc `==`*(self, other: NimGodotObject): bool {.inline.} =
## Compares objects by referential equality. ## Compares objects by referential equality.