/* * Copyright (C) 2017-2022 Apple Inc. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF * THE POSSIBILITY OF SUCH DAMAGE. */ #pragma once #include "ContextDestructionObserver.h" #include "EventTarget.h" // #include "JSDOMPromiseDeferred.h" #include "JSValueInWrappedObject.h" #include #include #include #include namespace WebCore { class AbortAlgorithm; class ScriptExecutionContext; class AbortSignal final : public RefCounted, public EventTargetWithInlineData, private ContextDestructionObserver { WTF_MAKE_ISO_ALLOCATED_EXPORT(AbortSignal, WEBCORE_EXPORT); public: static Ref create(ScriptExecutionContext*); WEBCORE_EXPORT ~AbortSignal(); using NativeCallbackTuple = std::tuple; static Ref abort(JSDOMGlobalObject&, ScriptExecutionContext&, JSC::JSValue reason); static Ref timeout(ScriptExecutionContext&, uint64_t milliseconds); static bool whenSignalAborted(AbortSignal&, Ref&&); void signalAbort(JSC::JSValue reason); void signalFollow(AbortSignal&); bool aborted() const { return m_aborted; } JSValue reason() const { return m_reason.get(); } bool hasActiveTimeoutTimer() const { return m_hasActiveTimeoutTimer; } bool hasAbortEventListener() const { return m_hasAbortEventListener; } using RefCounted::deref; using RefCounted::ref; using Algorithm = Function; void addAlgorithm(Algorithm&& algorithm) { m_algorithms.append(WTFMove(algorithm)); } void cleanNativeBindings(void* ref); void addNativeCallback(NativeCallbackTuple callback) { m_native_callbacks.append(callback); } bool isFollowingSignal() const { return !!m_followingSignal; } void throwIfAborted(JSC::JSGlobalObject&); private: enum class Aborted : bool { No, Yes }; explicit AbortSignal(ScriptExecutionContext*, Aborted = Aborted::No, JSC::JSValue reason = JSC::jsUndefined()); void setHasActiveTimeoutTimer(bool hasActiveTimeoutTimer) { m_hasActiveTimeoutTimer = hasActiveTimeoutTimer; } // EventTarget. EventTargetInterface eventTargetInterface() const final { return AbortSignalEventTargetInterfaceType; } ScriptExecutionContext* scriptExecutionContext() const final { return ContextDestructionObserver::scriptExecutionContext(); } void refEventTarget() final { ref(); } void derefEventTarget() final { deref(); } void eventListenersDidChange() final; bool m_aborted { false }; Vector m_algorithms; Vector m_native_callbacks; WeakPtr m_followingSignal; JSC::Strong m_reason; bool m_hasActiveTimeoutTimer { false }; bool m_hasAbortEventListener { false }; }; }