with-autorelease-pool Macro

Summary

Evaluates forms in the scope of a temporary autorelease pool.

Package

objc

Signature

with-autorelease-pool (option*) form* => values

Arguments

Values

Description

The macro with-autorelease-pool creates a new autorelease pool and evaluates each form in sequence. The pool is released at the end, even if a non-local exit is performed by forms. An autorelease pool is provided automatically for the main thread when running CAPI with Cocoa, but other threads need to allocate one if they call Objective-C methods that use autorelease.

option must be empty.

Examples

The "description" method returns an autoreleased NSString, so to make this function safe for use anywhere, the with-autorelease-pool macro is used:

(defun object-description (object)
  (with-autorelease-pool ()
    (invoke-into 'string object "description")))

See also

autorelease
make-autorelease-pool