pkgs/objective_c/lib/src/autorelease.dart

// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

import 'runtime_bindings_generated.dart';

/// Creates an Objective-C autorelease pool, runs [function], then releases the
/// pool.
///
/// ```
/// while (longRunningCondiditon) {
///   // When writing ObjC interop code inside a long running loop, it's a good
///   // idea to use an autorelease pool to clean up autoreleased references.
///   autoReleasePool(() {
///     // Interacting with most ObjC APIs autoreleases a lot of internal refs.
///     final someObjCObject = fooObjCApi.loadNextObject();
///     someObjCObject.greet('Hello'.toNSString());
///     barObjCApi.sendObject(someObjCObject);
///   });
/// }
/// ```
///
/// This is analogous to the Objective-C `@autoreleasepool` block:
/// ```
/// while (longRunningCondiditon) {
///   @autoreleasepool {
///     SomeObjCObject *someObjCObject = [fooObjCApi loadNextObject];
///     [someObjCObject greet:@"Hello"];
///     [barObjCApi sendObject:someObjCObject];
///   }
/// }
/// ```
///
/// [function] is executed synchronously. Do not try to pass an async function
/// here (the [Future] it returns will not be awaited). Objective-C autorelease
/// pools form a strict stack, and allowing async execution gaps inside the pool
/// scope could easily break this nesting, so async functions are not supported.
T autoReleasePool<T>(T Function() function) {
  final pool = autoreleasePoolPush();
  try {
    return function();
  } finally {
    autoreleasePoolPop(pool);
  }
}