next | previous | forward | backward | up | top | index | toc | Macaulay2 website
ForeignFunctions :: registerFinalizer(ForeignObject,Function)

registerFinalizer(ForeignObject,Function) -- register a finalizer for a foreign object

Synopsis

Description

If a foreign pointer object corresponds to memory that was not allocated by the GC garbage collector, then a function to properly deallocate this memory when the Pointer object that stores this pointer is garbage collected should be called. The function should take a single argument, a foreign object, typically of type voidstar, which corresponds to the memory to deallocate.

i1 : malloc = foreignFunction("malloc", voidstar, ulong)

o1 = malloc

o1 : ForeignFunction
i2 : free = foreignFunction("free", void, voidstar)

o2 = free

o2 : ForeignFunction
i3 : finalizer = x -> (print("freeing memory at " | net x); free x)

o3 = finalizer

o3 : FunctionClosure
i4 : for i to 9 do (x := malloc 8; registerFinalizer(x, finalizer))
i5 : collectGarbage()
freeing memory at 0x7fafa804f600
freeing memory at 0x7fafa804f5c0
freeing memory at 0x7fafa8048a00
freeing memory at 0x7fafa804f850
freeing memory at 0x7fafa804f5a0
freeing memory at 0x7fafa80489e0
freeing memory at 0x7fafa804fef0
freeing memory at 0x7fafa804f830
freeing memory at 0x7fafa804fe30

Ways to use this method: