1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
/* -*- 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_idbfilehandle_h__
#define mozilla_dom_idbfilehandle_h__
#include "IDBFileRequest.h"
#include "js/TypeDecls.h"
#include "mozilla/Attributes.h"
#include "mozilla/dom/FileModeBinding.h"
#include "mozilla/dom/TypedArray.h"
#include "mozilla/DOMEventTargetHelper.h"
#include "nsCycleCollectionParticipant.h"
#include "nsIRunnable.h"
#include "nsWeakReference.h"
namespace mozilla::dom {
class Blob;
class FileRequestData;
class FileRequestParams;
struct IDBFileMetadataParameters;
class IDBFileRequest;
class IDBMutableFile;
class StringOrArrayBufferOrArrayBufferViewOrBlob;
namespace indexedDB {
class BackgroundFileHandleChild;
}
class IDBFileHandle final : public DOMEventTargetHelper,
public nsIRunnable,
public nsSupportsWeakReference {
public:
enum ReadyState { INITIAL = 0, LOADING, FINISHING, DONE };
private:
RefPtr<IDBMutableFile> mMutableFile;
indexedDB::BackgroundFileHandleChild* mBackgroundActor;
uint64_t mLocation;
uint32_t mPendingRequestCount;
ReadyState mReadyState;
FileMode mMode;
bool mAborted;
bool mCreating;
#ifdef DEBUG
bool mSentFinishOrAbort;
bool mFiredCompleteOrAbort;
#endif
public:
[[nodiscard]] static RefPtr<IDBFileHandle> Create(
IDBMutableFile* aMutableFile, FileMode aMode);
static IDBFileHandle* GetCurrent();
void AssertIsOnOwningThread() const
#ifdef DEBUG
;
#else
{
}
#endif
void SetBackgroundActor(indexedDB::BackgroundFileHandleChild* aActor);
void ClearBackgroundActor() {
AssertIsOnOwningThread();
mBackgroundActor = nullptr;
}
void StartRequest(IDBFileRequest* aFileRequest,
const FileRequestParams& aParams);
void OnNewRequest();
void OnRequestFinished(bool aActorDestroyedNormally);
void FireCompleteOrAbortEvents(bool aAborted);
bool IsOpen() const;
bool IsFinishingOrDone() const {
AssertIsOnOwningThread();
return mReadyState == FINISHING || mReadyState == DONE;
}
bool IsDone() const {
AssertIsOnOwningThread();
return mReadyState == DONE;
}
bool IsAborted() const {
AssertIsOnOwningThread();
return mAborted;
}
void Abort();
// WebIDL
IDBMutableFile* GetMutableFile() const {
AssertIsOnOwningThread();
return mMutableFile;
}
IDBMutableFile* GetFileHandle() const {
AssertIsOnOwningThread();
return GetMutableFile();
}
FileMode Mode() const {
AssertIsOnOwningThread();
return mMode;
}
bool Active() const {
AssertIsOnOwningThread();
return IsOpen();
}
Nullable<uint64_t> GetLocation() const {
AssertIsOnOwningThread();
if (mLocation == UINT64_MAX) {
return Nullable<uint64_t>();
}
return Nullable<uint64_t>(mLocation);
}
void SetLocation(const Nullable<uint64_t>& aLocation) {
AssertIsOnOwningThread();
// Null means the end-of-file.
if (aLocation.IsNull()) {
mLocation = UINT64_MAX;
} else {
mLocation = aLocation.Value();
}
}
[[nodiscard]] RefPtr<IDBFileRequest> GetMetadata(
const IDBFileMetadataParameters& aParameters, ErrorResult& aRv);
[[nodiscard]] RefPtr<IDBFileRequest> ReadAsArrayBuffer(uint64_t aSize,
ErrorResult& aRv) {
AssertIsOnOwningThread();
return Read(aSize, false, VoidString(), aRv);
}
[[nodiscard]] RefPtr<IDBFileRequest> ReadAsText(uint64_t aSize,
const nsAString& aEncoding,
ErrorResult& aRv) {
AssertIsOnOwningThread();
return Read(aSize, true, aEncoding, aRv);
}
[[nodiscard]] RefPtr<IDBFileRequest> Write(
const StringOrArrayBufferOrArrayBufferViewOrBlob& aValue,
ErrorResult& aRv) {
AssertIsOnOwningThread();
return WriteOrAppend(aValue, false, aRv);
}
[[nodiscard]] RefPtr<IDBFileRequest> Append(
const StringOrArrayBufferOrArrayBufferViewOrBlob& aValue,
ErrorResult& aRv) {
AssertIsOnOwningThread();
return WriteOrAppend(aValue, true, aRv);
}
[[nodiscard]] RefPtr<IDBFileRequest> Truncate(const Optional<uint64_t>& aSize,
ErrorResult& aRv);
[[nodiscard]] RefPtr<IDBFileRequest> Flush(ErrorResult& aRv);
void Abort(ErrorResult& aRv);
IMPL_EVENT_HANDLER(complete)
IMPL_EVENT_HANDLER(abort)
IMPL_EVENT_HANDLER(error)
NS_DECL_ISUPPORTS_INHERITED
NS_DECL_NSIRUNNABLE
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(IDBFileHandle, DOMEventTargetHelper)
// EventTarget
void GetEventTargetParent(EventChainPreVisitor& aVisitor) override;
// WrapperCache
virtual JSObject* WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) override;
private:
IDBFileHandle(IDBMutableFile* aMutableFile, FileMode aMode);
~IDBFileHandle();
bool CheckState(ErrorResult& aRv) const;
bool CheckStateAndArgumentsForRead(uint64_t aSize, ErrorResult& aRv);
bool CheckStateForWrite(ErrorResult& aRv);
bool CheckStateForWriteOrAppend(bool aAppend, ErrorResult& aRv);
bool CheckWindow();
[[nodiscard]] RefPtr<IDBFileRequest> Read(uint64_t aSize, bool aHasEncoding,
const nsAString& aEncoding,
ErrorResult& aRv);
[[nodiscard]] RefPtr<IDBFileRequest> WriteOrAppend(
const StringOrArrayBufferOrArrayBufferViewOrBlob& aValue, bool aAppend,
ErrorResult& aRv);
[[nodiscard]] RefPtr<IDBFileRequest> WriteOrAppend(const nsAString& aValue,
bool aAppend,
ErrorResult& aRv);
[[nodiscard]] RefPtr<IDBFileRequest> WriteOrAppend(const ArrayBuffer& aValue,
bool aAppend,
ErrorResult& aRv);
[[nodiscard]] RefPtr<IDBFileRequest> WriteOrAppend(
const ArrayBufferView& aValue, bool aAppend, ErrorResult& aRv);
[[nodiscard]] RefPtr<IDBFileRequest> WriteOrAppend(Blob& aValue, bool aAppend,
ErrorResult& aRv);
[[nodiscard]] RefPtr<IDBFileRequest> WriteInternal(
const FileRequestData& aData, uint64_t aDataLength, bool aAppend,
ErrorResult& aRv);
void SendFinish();
void SendAbort();
};
} // namespace mozilla::dom
#endif // mozilla_dom_idbfilehandle_h__
|
