diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:22:09 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:22:09 +0000 |
commit | 43a97878ce14b72f0981164f87f2e35e14151312 (patch) | |
tree | 620249daf56c0258faa40cbdcf9cfba06de2a846 /dom/streams/UnderlyingSinkCallbackHelpers.h | |
parent | Initial commit. (diff) | |
download | firefox-43a97878ce14b72f0981164f87f2e35e14151312.tar.xz firefox-43a97878ce14b72f0981164f87f2e35e14151312.zip |
Adding upstream version 110.0.1.upstream/110.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'dom/streams/UnderlyingSinkCallbackHelpers.h')
-rw-r--r-- | dom/streams/UnderlyingSinkCallbackHelpers.h | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/dom/streams/UnderlyingSinkCallbackHelpers.h b/dom/streams/UnderlyingSinkCallbackHelpers.h new file mode 100644 index 0000000000..e17554229f --- /dev/null +++ b/dom/streams/UnderlyingSinkCallbackHelpers.h @@ -0,0 +1,118 @@ +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* vim:set ts=2 sw=2 sts=2 et cindent: */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +#ifndef mozilla_dom_UnderlyingSinkCallbackHelpers_h +#define mozilla_dom_UnderlyingSinkCallbackHelpers_h + +#include "mozilla/HoldDropJSObjects.h" +#include "mozilla/dom/Promise.h" +#include "mozilla/dom/UnderlyingSinkBinding.h" +#include "nsCycleCollectionParticipant.h" +#include "nsISupports.h" +#include "nsISupportsImpl.h" + +/* + * See the comment in UnderlyingSourceCallbackHelpers.h! + * + * A native implementation of these callbacks is however currently not required. + */ +namespace mozilla::dom { + +class WritableStreamDefaultController; + +class UnderlyingSinkAlgorithmsBase : public nsISupports { + public: + NS_DECL_CYCLE_COLLECTING_ISUPPORTS + NS_DECL_CYCLE_COLLECTION_CLASS(UnderlyingSinkAlgorithmsBase) + + MOZ_CAN_RUN_SCRIPT virtual void StartCallback( + JSContext* aCx, WritableStreamDefaultController& aController, + JS::MutableHandle<JS::Value> aRetVal, ErrorResult& aRv) = 0; + + MOZ_CAN_RUN_SCRIPT virtual already_AddRefed<Promise> WriteCallback( + JSContext* aCx, JS::Handle<JS::Value> aChunk, + WritableStreamDefaultController& aController, ErrorResult& aRv) = 0; + + MOZ_CAN_RUN_SCRIPT virtual already_AddRefed<Promise> CloseCallback( + JSContext* aCx, ErrorResult& aRv) = 0; + + MOZ_CAN_RUN_SCRIPT virtual already_AddRefed<Promise> AbortCallback( + JSContext* aCx, const Optional<JS::Handle<JS::Value>>& aReason, + ErrorResult& aRv) = 0; + + // Implement this when you need to release underlying resources immediately + // from closed/errored(aborted) streams, without waiting for GC. + virtual void ReleaseObjects() {} + + protected: + virtual ~UnderlyingSinkAlgorithmsBase() = default; +}; + +// https://streams.spec.whatwg.org/#set-up-writable-stream-default-controller-from-underlying-sink +class UnderlyingSinkAlgorithms final : public UnderlyingSinkAlgorithmsBase { + public: + NS_DECL_ISUPPORTS_INHERITED + NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_INHERITED( + UnderlyingSinkAlgorithms, UnderlyingSinkAlgorithmsBase) + + UnderlyingSinkAlgorithms(nsIGlobalObject* aGlobal, + JS::Handle<JSObject*> aUnderlyingSink, + UnderlyingSink& aUnderlyingSinkDict) + : mGlobal(aGlobal), mUnderlyingSink(aUnderlyingSink) { + // Step 6. (implicit Step 2.) + if (aUnderlyingSinkDict.mStart.WasPassed()) { + mStartCallback = aUnderlyingSinkDict.mStart.Value(); + } + + // Step 7. (implicit Step 3.) + if (aUnderlyingSinkDict.mWrite.WasPassed()) { + mWriteCallback = aUnderlyingSinkDict.mWrite.Value(); + } + + // Step 8. (implicit Step 4.) + if (aUnderlyingSinkDict.mClose.WasPassed()) { + mCloseCallback = aUnderlyingSinkDict.mClose.Value(); + } + + // Step 9. (implicit Step 5.) + if (aUnderlyingSinkDict.mAbort.WasPassed()) { + mAbortCallback = aUnderlyingSinkDict.mAbort.Value(); + } + + mozilla::HoldJSObjects(this); + }; + + MOZ_CAN_RUN_SCRIPT void StartCallback( + JSContext* aCx, WritableStreamDefaultController& aController, + JS::MutableHandle<JS::Value> aRetVal, ErrorResult& aRv) override; + + MOZ_CAN_RUN_SCRIPT already_AddRefed<Promise> WriteCallback( + JSContext* aCx, JS::Handle<JS::Value> aChunk, + WritableStreamDefaultController& aController, ErrorResult& aRv) override; + + MOZ_CAN_RUN_SCRIPT already_AddRefed<Promise> CloseCallback( + JSContext* aCx, ErrorResult& aRv) override; + + MOZ_CAN_RUN_SCRIPT already_AddRefed<Promise> AbortCallback( + JSContext* aCx, const Optional<JS::Handle<JS::Value>>& aReason, + ErrorResult& aRv) override; + + protected: + ~UnderlyingSinkAlgorithms() override { mozilla::DropJSObjects(this); } + + private: + // Virtually const, but are cycle collected + nsCOMPtr<nsIGlobalObject> mGlobal; + JS::Heap<JSObject*> mUnderlyingSink; + MOZ_KNOWN_LIVE RefPtr<UnderlyingSinkStartCallback> mStartCallback; + MOZ_KNOWN_LIVE RefPtr<UnderlyingSinkWriteCallback> mWriteCallback; + MOZ_KNOWN_LIVE RefPtr<UnderlyingSinkCloseCallback> mCloseCallback; + MOZ_KNOWN_LIVE RefPtr<UnderlyingSinkAbortCallback> mAbortCallback; +}; + +} // namespace mozilla::dom + +#endif |