glib/org.gtkkn.extensions.glib.cinterop/MemoryCleaner

MemoryCleaner

object MemoryCleaner(source)

MemoryCleaner manages the cleanup of native memory associated with Proxy objects.

Key Responsibilities

Maintains a cache of all memory addresses associated with Proxy objects (except GObject instances).
Releases native memory automatically when owned Proxy objects are garbage-collected.
Supports different cleanup methods:
Boxed Type Cleanup: Uses g_boxed_free for specific data structures.
Custom Cleanup: Allows specifying a custom cleanup function.
Native Heap Cleanup: Uses nativeHeap.free to free memory allocated on the native heap.
Fallback Cleanup: Uses g_free as a fallback.
Enables transferring ownership of native memory to and from native code.

Ownership Semantics

Owned Memory: Automatically cleaned up when the associated Proxy object is garbage-collected.
Non-Owned Memory: Not automatically cleaned up; must be manually managed or transferred.
Ownership can be managed using takeOwnership and yieldOwnership.

Thread Safety

All operations involving the cache are thread-safe, using a ReentrantLock to ensure synchronization.

Types

NativeFunctionsImpl

object NativeFunctionsImpl : MemoryCleaner.NativeFunctions

Default implementation of native cleanup functions for production use.

Functions

fun free(cPointer: <Error class: unknown class>)

Manually frees the memory associated with the specified address.

fun setBoxedType(proxy: Proxy, boxedType: <Error class: unknown class>, owned: Boolean)

Configures cleanup for a boxed type using g_boxed_free.

fun setFreeFunc(proxy: Proxy, owned: Boolean, freeFunc: (<Error class: unknown class>) -> Unit)

Sets a custom cleanup function for the specified Proxy instance.

fun setNativeHeap(proxy: Proxy, owned: Boolean)

Configures the memory to be freed from the native heap.

fun takeOwnership(proxy: Proxy)

Transfers ownership of the memory to the MemoryCleaner.

fun yieldOwnership(proxy: Proxy)

Yields ownership of the memory, preventing automatic cleanup.