Function

Summary

Adds a function to perform a special action during garbage collection.

Package

hcl

Signature

add-special-free-action function => function-list

Arguments

function

A symbol naming a function of one argument.

Values

function-list

A list of the functions currently called to perform special actions, including the one just added.

Description

When some objects are garbage collected, you may require a "special action" to be performed as well. add-special-free-action adds the function function to perform the special action. Note that the function is applied to all objects flagged for special-free-action, so the function function should check for the object's type, so that it only affects relevant objects.

The functions flag-special-free-action and flag-not-special-free-action flag and unflag objects for action.

Example

(add-special-free-action 'free-my-app)

See also

remove-special-free-action
flag-special-free-action
flag-not-special-free-action