summaryrefslogtreecommitdiffstats
path: root/dom/events/DataTransferItem.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /dom/events/DataTransferItem.h
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esr
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'dom/events/DataTransferItem.h')
-rw-r--r--dom/events/DataTransferItem.h137
1 files changed, 137 insertions, 0 deletions
diff --git a/dom/events/DataTransferItem.h b/dom/events/DataTransferItem.h
new file mode 100644
index 0000000000..3978aaa7a9
--- /dev/null
+++ b/dom/events/DataTransferItem.h
@@ -0,0 +1,137 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
+/* 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_DataTransferItem_h
+#define mozilla_dom_DataTransferItem_h
+
+#include "mozilla/dom/DataTransfer.h"
+#include "mozilla/dom/DOMString.h"
+#include "mozilla/dom/File.h"
+
+namespace mozilla {
+class ErrorResult;
+
+namespace dom {
+
+class DataTransfer;
+class FileSystemEntry;
+class FunctionStringCallback;
+
+class DataTransferItem final : public nsISupports, public nsWrapperCache {
+ public:
+ NS_DECL_CYCLE_COLLECTING_ISUPPORTS
+ NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(DataTransferItem);
+
+ public:
+ // The spec only talks about the "file" and "string" kinds. Due to the Moz*
+ // APIs, it is possible to attach any type to a DataTransferItem, meaning that
+ // we can have other kinds then just FILE and STRING. These others are simply
+ // marked as "other" and can only be produced throug the Moz* APIs.
+ enum eKind {
+ KIND_FILE,
+ KIND_STRING,
+ KIND_OTHER,
+ };
+
+ DataTransferItem(DataTransfer* aDataTransfer, const nsAString& aType,
+ eKind aKind = KIND_OTHER)
+ : mIndex(0),
+ mChromeOnly(false),
+ mKind(aKind),
+ mType(aType),
+ mDataTransfer(aDataTransfer) {
+ MOZ_ASSERT(mDataTransfer, "Must be associated with a DataTransfer");
+ }
+
+ already_AddRefed<DataTransferItem> Clone(DataTransfer* aDataTransfer) const;
+
+ virtual JSObject* WrapObject(JSContext* aCx,
+ JS::Handle<JSObject*> aGivenProto) override;
+
+ void GetAsString(FunctionStringCallback* aCallback,
+ nsIPrincipal& aSubjectPrincipal, ErrorResult& aRv);
+
+ void GetKind(nsAString& aKind) const {
+ switch (mKind) {
+ case KIND_FILE:
+ aKind = u"file"_ns;
+ return;
+ case KIND_STRING:
+ aKind = u"string"_ns;
+ return;
+ default:
+ aKind = u"other"_ns;
+ return;
+ }
+ }
+
+ void GetInternalType(nsAString& aType) const { aType = mType; }
+ bool IsInternalType(const nsAString& aType) const { return aType == mType; }
+
+ void GetType(nsAString& aType);
+
+ eKind Kind() const { return mKind; }
+
+ already_AddRefed<File> GetAsFile(nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aRv);
+
+ already_AddRefed<FileSystemEntry> GetAsEntry(nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aRv);
+
+ DataTransfer* GetParentObject() const { return mDataTransfer; }
+
+ nsIPrincipal* Principal() const { return mPrincipal; }
+ void SetPrincipal(nsIPrincipal* aPrincipal) { mPrincipal = aPrincipal; }
+
+ // @return cached data, if available.
+ // otherwise: if available, `mDataTransfer`'s transferable data.
+ // otherwise the data is retrieved from the clipboard (for
+ // paste events) or the drag session.
+ already_AddRefed<nsIVariant> DataNoSecurityCheck();
+ // Data may return null if the clipboard state has changed since the type was
+ // detected.
+ already_AddRefed<nsIVariant> Data(nsIPrincipal* aPrincipal, ErrorResult& aRv);
+
+ // Note: This can modify the mKind. Callers of this method must let the
+ // relevant DataTransfer know, because its types list can change as a result.
+ void SetData(nsIVariant* aData);
+
+ uint32_t Index() const { return mIndex; }
+ void SetIndex(uint32_t aIndex) { mIndex = aIndex; }
+ void FillInExternalData();
+
+ bool ChromeOnly() const { return mChromeOnly; }
+ void SetChromeOnly(bool aChromeOnly) { mChromeOnly = aChromeOnly; }
+
+ static eKind KindFromData(nsIVariant* aData);
+
+ private:
+ ~DataTransferItem() = default;
+ already_AddRefed<File> CreateFileFromInputStream(nsIInputStream* aStream);
+ already_AddRefed<File> CreateFileFromInputStream(
+ nsIInputStream* aStream, const char* aFileNameKey,
+ const nsAString& aContentType);
+
+ already_AddRefed<nsIGlobalObject> GetGlobalFromDataTransfer();
+
+ // The index in the 2d mIndexedItems array
+ uint32_t mIndex;
+
+ bool mChromeOnly;
+ eKind mKind;
+ const nsString mType;
+ nsCOMPtr<nsIVariant> mData;
+ nsCOMPtr<nsIPrincipal> mPrincipal;
+ RefPtr<DataTransfer> mDataTransfer;
+
+ // File cache for nsIFile application/x-moz-file entries.
+ RefPtr<File> mCachedFile;
+};
+
+} // namespace dom
+} // namespace mozilla
+
+#endif /* mozilla_dom_DataTransferItem_h */