Bug 1858509 add thread-safety annotations around MediaSourceDemuxer::mMonitor r=alwu
[gecko.git] / widget / nsTransferable.h
blobf79e8e69e85c315d65ec10c96ec05a71e945ec6d
1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* This Source Code Form is subject to the terms of the Mozilla Public
3 * License, v. 2.0. If a copy of the MPL was not distributed with this
4 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
6 #ifndef nsTransferable_h__
7 #define nsTransferable_h__
9 #include "nsICookieJarSettings.h"
10 #include "nsIFormatConverter.h"
11 #include "nsITransferable.h"
12 #include "nsCOMPtr.h"
13 #include "nsString.h"
14 #include "nsTArray.h"
15 #include "nsIPrincipal.h"
16 #include "nsIReferrerInfo.h"
17 #include "prio.h"
18 #include "mozilla/Maybe.h"
20 class nsIMutableArray;
23 // DataStruct
25 // Holds a flavor (a mime type) that describes the data and the associated data.
27 struct DataStruct {
28 explicit DataStruct(const char* aFlavor)
29 : mCacheFD(nullptr), mFlavor(aFlavor) {}
30 DataStruct(DataStruct&& aRHS);
31 ~DataStruct();
33 const nsCString& GetFlavor() const { return mFlavor; }
34 void SetData(nsISupports* aData, bool aIsPrivateData);
35 void GetData(nsISupports** aData);
36 bool IsDataAvailable() const { return mData || mCacheFD; }
38 protected:
39 enum {
40 // The size of data over which we write the data to disk rather than
41 // keep it around in memory.
42 kLargeDatasetSize = 1000000 // 1 million bytes
45 nsresult WriteCache(void* aData, uint32_t aDataLen);
46 nsresult ReadCache(nsISupports** aData);
48 // mData OR mCacheFD should be used, not both.
49 nsCOMPtr<nsISupports> mData; // OWNER - some varient of primitive wrapper
50 PRFileDesc* mCacheFD;
51 const nsCString mFlavor;
53 private:
54 DataStruct(const DataStruct&) = delete;
55 DataStruct& operator=(const DataStruct&) = delete;
58 /**
59 * XP Transferable wrapper
62 class nsTransferable : public nsITransferable {
63 public:
64 nsTransferable();
66 // nsISupports
67 NS_DECL_ISUPPORTS
68 NS_DECL_NSITRANSFERABLE
70 protected:
71 virtual ~nsTransferable();
73 // Get flavors w/out converter
74 void GetTransferDataFlavors(nsTArray<nsCString>& aFlavors);
76 // Find index for data with the matching flavor in mDataArray.
77 mozilla::Maybe<size_t> FindDataFlavor(const char* aFlavor);
79 nsTArray<DataStruct> mDataArray;
80 nsCOMPtr<nsIFormatConverter> mFormatConv;
81 bool mPrivateData;
82 nsCOMPtr<nsIPrincipal> mRequestingPrincipal;
83 nsContentPolicyType mContentPolicyType;
84 nsCOMPtr<nsICookieJarSettings> mCookieJarSettings;
85 nsCOMPtr<nsIReferrerInfo> mReferrerInfo;
86 #if DEBUG
87 bool mInitialized;
88 #endif
91 #endif // nsTransferable_h__