summaryrefslogtreecommitdiffstats
path: root/dom/file/BlobImpl.h
diff options
context:
space:
mode:
Diffstat (limited to 'dom/file/BlobImpl.h')
-rw-r--r--dom/file/BlobImpl.h114
1 files changed, 114 insertions, 0 deletions
diff --git a/dom/file/BlobImpl.h b/dom/file/BlobImpl.h
new file mode 100644
index 0000000000..720c398cdd
--- /dev/null
+++ b/dom/file/BlobImpl.h
@@ -0,0 +1,114 @@
+/* -*- 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_BlobImpl_h
+#define mozilla_dom_BlobImpl_h
+
+#include "nsISupports.h"
+#include "nsString.h"
+
+#define BLOBIMPL_IID \
+ { \
+ 0xbccb3275, 0x6778, 0x4ac5, { \
+ 0xaf, 0x03, 0x90, 0xed, 0x37, 0xad, 0xdf, 0x5d \
+ } \
+ }
+
+class nsIInputStream;
+
+namespace mozilla {
+class ErrorResult;
+
+namespace dom {
+
+class SystemCallerGuarantee;
+template <typename T>
+class Optional;
+
+// This is the abstract class for any File backend. It must be nsISupports
+// because this class must be ref-counted and it has to work with IPC.
+class BlobImpl : public nsISupports {
+ public:
+ NS_DECLARE_STATIC_IID_ACCESSOR(BLOBIMPL_IID)
+ NS_DECL_THREADSAFE_ISUPPORTS
+
+ BlobImpl() = default;
+
+ virtual void GetName(nsAString& aName) const = 0;
+
+ virtual void GetDOMPath(nsAString& aName) const = 0;
+
+ virtual void SetDOMPath(const nsAString& aName) = 0;
+
+ virtual int64_t GetLastModified(ErrorResult& aRv) = 0;
+
+ virtual void GetMozFullPath(nsAString& aName,
+ SystemCallerGuarantee /* unused */,
+ ErrorResult& aRv) = 0;
+
+ virtual void GetMozFullPathInternal(nsAString& aFileName,
+ ErrorResult& aRv) = 0;
+
+ virtual uint64_t GetSize(ErrorResult& aRv) = 0;
+
+ virtual void GetType(nsAString& aType) = 0;
+
+ virtual void GetBlobImplType(nsAString& aBlobImplType) const = 0;
+
+ virtual size_t GetAllocationSize() const = 0;
+ virtual size_t GetAllocationSize(
+ FallibleTArray<BlobImpl*>& aVisitedBlobImpls) const = 0;
+
+ /**
+ * An effectively-unique serial number identifying this instance of FileImpl.
+ *
+ * Implementations should obtain a serial number from
+ * FileImplBase::NextSerialNumber().
+ */
+ virtual uint64_t GetSerialNumber() const = 0;
+
+ already_AddRefed<BlobImpl> Slice(const Optional<int64_t>& aStart,
+ const Optional<int64_t>& aEnd,
+ const nsAString& aContentType,
+ ErrorResult& aRv);
+
+ virtual already_AddRefed<BlobImpl> CreateSlice(uint64_t aStart,
+ uint64_t aLength,
+ const nsAString& aContentType,
+ ErrorResult& aRv) const = 0;
+
+ virtual const nsTArray<RefPtr<BlobImpl>>* GetSubBlobImpls() const = 0;
+
+ virtual void CreateInputStream(nsIInputStream** aStream,
+ ErrorResult& aRv) const = 0;
+
+ virtual int64_t GetFileId() const = 0;
+
+ nsresult GetSendInfo(nsIInputStream** aBody, uint64_t* aContentLength,
+ nsACString& aContentType, nsACString& aCharset);
+
+ virtual void SetLazyData(const nsAString& aName,
+ const nsAString& aContentType, uint64_t aLength,
+ int64_t aLastModifiedDate) = 0;
+
+ virtual bool IsMemoryFile() const = 0;
+
+ virtual bool IsFile() const = 0;
+
+ // Returns true if the BlobImpl is backed by an nsIFile and the underlying
+ // file is a directory.
+ virtual bool IsDirectory() const { return false; }
+
+ protected:
+ virtual ~BlobImpl() = default;
+};
+
+NS_DEFINE_STATIC_IID_ACCESSOR(BlobImpl, BLOBIMPL_IID)
+
+} // namespace dom
+} // namespace mozilla
+
+#endif // mozilla_dom_BlobImpl_h