// asmdef Version Defines, enabled when com.unity.addressables is imported. #if UNITASK_ADDRESSABLE_SUPPORT using Cysharp.Threading.Tasks.Internal; using System; using System.Runtime.CompilerServices; using System.Runtime.ExceptionServices; using System.Threading; using UnityEngine.AddressableAssets; using UnityEngine.ResourceManagement.AsyncOperations; namespace Cysharp.Threading.Tasks { public static class AddressablesAsyncExtensions { #region AsyncOperationHandle public static UniTask.Awaiter GetAwaiter(this AsyncOperationHandle handle) { return ToUniTask(handle).GetAwaiter(); } public static UniTask WithCancellation(this AsyncOperationHandle handle, CancellationToken cancellationToken, bool cancelImmediately = false, bool autoReleaseWhenCanceled = false) { return ToUniTask(handle, cancellationToken: cancellationToken, cancelImmediately: cancelImmediately, autoReleaseWhenCanceled: autoReleaseWhenCanceled); } public static UniTask ToUniTask(this AsyncOperationHandle handle, IProgress progress = null, PlayerLoopTiming timing = PlayerLoopTiming.Update, CancellationToken cancellationToken = default(CancellationToken), bool cancelImmediately = false, bool autoReleaseWhenCanceled = false) { if (cancellationToken.IsCancellationRequested) return UniTask.FromCanceled(cancellationToken); if (!handle.IsValid()) { // autoReleaseHandle:true handle is invalid(immediately internal handle == null) so return completed. return UniTask.CompletedTask; } if (handle.IsDone) { if (handle.Status == AsyncOperationStatus.Failed) { return UniTask.FromException(handle.OperationException); } return UniTask.CompletedTask; } return new UniTask(AsyncOperationHandleConfiguredSource.Create(handle, timing, progress, cancellationToken, cancelImmediately, autoReleaseWhenCanceled, out var token), token); } public struct AsyncOperationHandleAwaiter : ICriticalNotifyCompletion { AsyncOperationHandle handle; Action continuationAction; public AsyncOperationHandleAwaiter(AsyncOperationHandle handle) { this.handle = handle; this.continuationAction = null; } public bool IsCompleted => handle.IsDone; public void GetResult() { if (continuationAction != null) { handle.Completed -= continuationAction; continuationAction = null; } if (handle.Status == AsyncOperationStatus.Failed) { var e = handle.OperationException; handle = default; ExceptionDispatchInfo.Capture(e).Throw(); } var result = handle.Result; handle = default; } public void OnCompleted(Action continuation) { UnsafeOnCompleted(continuation); } public void UnsafeOnCompleted(Action continuation) { Error.ThrowWhenContinuationIsAlreadyRegistered(continuationAction); continuationAction = PooledDelegate.Create(continuation); handle.Completed += continuationAction; } } sealed class AsyncOperationHandleConfiguredSource : IUniTaskSource, IPlayerLoopItem, ITaskPoolNode { static TaskPool pool; AsyncOperationHandleConfiguredSource nextNode; public ref AsyncOperationHandleConfiguredSource NextNode => ref nextNode; static AsyncOperationHandleConfiguredSource() { TaskPool.RegisterSizeGetter(typeof(AsyncOperationHandleConfiguredSource), () => pool.Size); } readonly Action completedCallback; AsyncOperationHandle handle; CancellationToken cancellationToken; CancellationTokenRegistration cancellationTokenRegistration; IProgress progress; bool autoReleaseWhenCanceled; bool cancelImmediately; bool completed; UniTaskCompletionSourceCore core; AsyncOperationHandleConfiguredSource() { completedCallback = HandleCompleted; } public static IUniTaskSource Create(AsyncOperationHandle handle, PlayerLoopTiming timing, IProgress progress, CancellationToken cancellationToken, bool cancelImmediately, bool autoReleaseWhenCanceled, out short token) { if (cancellationToken.IsCancellationRequested) { return AutoResetUniTaskCompletionSource.CreateFromCanceled(cancellationToken, out token); } if (!pool.TryPop(out var result)) { result = new AsyncOperationHandleConfiguredSource(); } result.handle = handle; result.progress = progress; result.cancellationToken = cancellationToken; result.cancelImmediately = cancelImmediately; result.autoReleaseWhenCanceled = autoReleaseWhenCanceled; result.completed = false; if (cancelImmediately && cancellationToken.CanBeCanceled) { result.cancellationTokenRegistration = cancellationToken.RegisterWithoutCaptureExecutionContext(state => { var promise = (AsyncOperationHandleConfiguredSource)state; if (promise.autoReleaseWhenCanceled && promise.handle.IsValid()) { Addressables.Release(promise.handle); } promise.core.TrySetCanceled(promise.cancellationToken); }, result); } TaskTracker.TrackActiveTask(result, 3); PlayerLoopHelper.AddAction(timing, result); handle.Completed += result.completedCallback; token = result.core.Version; return result; } void HandleCompleted(AsyncOperationHandle _) { if (handle.IsValid()) { handle.Completed -= completedCallback; } if (completed) { return; } completed = true; if (cancellationToken.IsCancellationRequested) { if (autoReleaseWhenCanceled && handle.IsValid()) { Addressables.Release(handle); } core.TrySetCanceled(cancellationToken); } else if (handle.Status == AsyncOperationStatus.Failed) { core.TrySetException(handle.OperationException); } else { core.TrySetResult(AsyncUnit.Default); } } public void GetResult(short token) { try { core.GetResult(token); } finally { if (!(cancelImmediately && cancellationToken.IsCancellationRequested)) { TryReturn(); } } } public UniTaskStatus GetStatus(short token) { return core.GetStatus(token); } public UniTaskStatus UnsafeGetStatus() { return core.UnsafeGetStatus(); } public void OnCompleted(Action continuation, object state, short token) { core.OnCompleted(continuation, state, token); } public bool MoveNext() { if (completed) { return false; } if (cancellationToken.IsCancellationRequested) { completed = true; if (autoReleaseWhenCanceled && handle.IsValid()) { Addressables.Release(handle); } core.TrySetCanceled(cancellationToken); return false; } if (progress != null && handle.IsValid()) { progress.Report(handle.PercentComplete); } return true; } bool TryReturn() { TaskTracker.RemoveTracking(this); core.Reset(); handle = default; progress = default; cancellationToken = default; cancellationTokenRegistration.Dispose(); return pool.TryPush(this); } } #endregion #region AsyncOperationHandle_T public static UniTask.Awaiter GetAwaiter(this AsyncOperationHandle handle) { return ToUniTask(handle).GetAwaiter(); } public static UniTask WithCancellation(this AsyncOperationHandle handle, CancellationToken cancellationToken, bool cancelImmediately = false, bool autoReleaseWhenCanceled = false) { return ToUniTask(handle, cancellationToken: cancellationToken, cancelImmediately: cancelImmediately, autoReleaseWhenCanceled: autoReleaseWhenCanceled); } public static UniTask ToUniTask(this AsyncOperationHandle handle, IProgress progress = null, PlayerLoopTiming timing = PlayerLoopTiming.Update, CancellationToken cancellationToken = default(CancellationToken), bool cancelImmediately = false, bool autoReleaseWhenCanceled = false) { if (cancellationToken.IsCancellationRequested) return UniTask.FromCanceled(cancellationToken); if (!handle.IsValid()) { throw new Exception("Attempting to use an invalid operation handle"); } if (handle.IsDone) { if (handle.Status == AsyncOperationStatus.Failed) { return UniTask.FromException(handle.OperationException); } return UniTask.FromResult(handle.Result); } return new UniTask(AsyncOperationHandleConfiguredSource.Create(handle, timing, progress, cancellationToken, cancelImmediately, autoReleaseWhenCanceled, out var token), token); } sealed class AsyncOperationHandleConfiguredSource : IUniTaskSource, IPlayerLoopItem, ITaskPoolNode> { static TaskPool> pool; AsyncOperationHandleConfiguredSource nextNode; public ref AsyncOperationHandleConfiguredSource NextNode => ref nextNode; static AsyncOperationHandleConfiguredSource() { TaskPool.RegisterSizeGetter(typeof(AsyncOperationHandleConfiguredSource), () => pool.Size); } readonly Action> completedCallback; AsyncOperationHandle handle; CancellationToken cancellationToken; CancellationTokenRegistration cancellationTokenRegistration; IProgress progress; bool autoReleaseWhenCanceled; bool cancelImmediately; bool completed; UniTaskCompletionSourceCore core; AsyncOperationHandleConfiguredSource() { completedCallback = HandleCompleted; } public static IUniTaskSource Create(AsyncOperationHandle handle, PlayerLoopTiming timing, IProgress progress, CancellationToken cancellationToken, bool cancelImmediately, bool autoReleaseWhenCanceled, out short token) { if (cancellationToken.IsCancellationRequested) { return AutoResetUniTaskCompletionSource.CreateFromCanceled(cancellationToken, out token); } if (!pool.TryPop(out var result)) { result = new AsyncOperationHandleConfiguredSource(); } result.handle = handle; result.cancellationToken = cancellationToken; result.completed = false; result.progress = progress; result.autoReleaseWhenCanceled = autoReleaseWhenCanceled; result.cancelImmediately = cancelImmediately; if (cancelImmediately && cancellationToken.CanBeCanceled) { result.cancellationTokenRegistration = cancellationToken.RegisterWithoutCaptureExecutionContext(state => { var promise = (AsyncOperationHandleConfiguredSource)state; if (promise.autoReleaseWhenCanceled && promise.handle.IsValid()) { Addressables.Release(promise.handle); } promise.core.TrySetCanceled(promise.cancellationToken); }, result); } TaskTracker.TrackActiveTask(result, 3); PlayerLoopHelper.AddAction(timing, result); handle.Completed += result.completedCallback; token = result.core.Version; return result; } void HandleCompleted(AsyncOperationHandle argHandle) { if (handle.IsValid()) { handle.Completed -= completedCallback; } if (completed) { return; } completed = true; if (cancellationToken.IsCancellationRequested) { if (autoReleaseWhenCanceled && handle.IsValid()) { Addressables.Release(handle); } core.TrySetCanceled(cancellationToken); } else if (argHandle.Status == AsyncOperationStatus.Failed) { core.TrySetException(argHandle.OperationException); } else { core.TrySetResult(argHandle.Result); } } public T GetResult(short token) { try { return core.GetResult(token); } finally { if (!(cancelImmediately && cancellationToken.IsCancellationRequested)) TryReturn(); } } void IUniTaskSource.GetResult(short token) { GetResult(token); } public UniTaskStatus GetStatus(short token) { return core.GetStatus(token); } public UniTaskStatus UnsafeGetStatus() { return core.UnsafeGetStatus(); } public void OnCompleted(Action continuation, object state, short token) { core.OnCompleted(continuation, state, token); } public bool MoveNext() { if (completed) { return false; } if (cancellationToken.IsCancellationRequested) { completed = true; if (autoReleaseWhenCanceled && handle.IsValid()) { Addressables.Release(handle); } core.TrySetCanceled(cancellationToken); return false; } if (progress != null && handle.IsValid()) { progress.Report(handle.PercentComplete); } return true; } bool TryReturn() { TaskTracker.RemoveTracking(this); core.Reset(); handle = default; progress = default; cancellationToken = default; cancellationTokenRegistration.Dispose(); return pool.TryPush(this); } } #endregion } } #endif