Debian Codegraph @

closure-library/closure/goog/testing/fs/filereader.js

raw
1 // Copyright 2011 The Closure Library Authors. All Rights Reserved.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS-IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 /**
16 * @fileoverview Mock FileReader object.
17 *
18 */
19
20 goog.setTestOnly('goog.testing.fs.FileReader');
21 goog.provide('goog.testing.fs.FileReader');
22
23 goog.require('goog.Timer');
24 goog.require('goog.events.EventTarget');
25 goog.require('goog.fs.Error');
26 goog.require('goog.fs.FileReader');
27 goog.require('goog.testing.fs.ProgressEvent');
28
29
30
31 /**
32 * A mock FileReader object. This emits the same events as
33 * {@link goog.fs.FileReader}.
34 *
35 * @constructor
36 * @extends {goog.events.EventTarget}
37 */
38 goog.testing.fs.FileReader = function() {
39 goog.testing.fs.FileReader.base(this, 'constructor');
40
41 /**
42 * The current state of the reader.
43 * @type {goog.fs.FileReader.ReadyState}
44 * @private
45 */
46 this.readyState_ = goog.fs.FileReader.ReadyState.INIT;
47 };
48 goog.inherits(goog.testing.fs.FileReader, goog.events.EventTarget);
49
50
51 /**
52 * The most recent error experienced by this reader.
53 * @type {goog.fs.Error}
54 * @private
55 */
56 goog.testing.fs.FileReader.prototype.error_;
57
58
59 /**
60 * Whether the current operation has been aborted.
61 * @type {boolean}
62 * @private
63 */
64 goog.testing.fs.FileReader.prototype.aborted_ = false;
65
66
67 /**
68 * The blob this reader is reading from.
69 * @type {goog.testing.fs.Blob}
70 * @private
71 */
72 goog.testing.fs.FileReader.prototype.blob_;
73
74
75 /**
76 * The possible return types.
77 * @enum {number}
78 */
79 goog.testing.fs.FileReader.ReturnType = {
80 /**
81 * Used when reading as text.
82 */
83 TEXT: 1,
84
85 /**
86 * Used when reading as binary string.
87 */
88 BINARY_STRING: 2,
89
90 /**
91 * Used when reading as array buffer.
92 */
93 ARRAY_BUFFER: 3,
94
95 /**
96 * Used when reading as data URL.
97 */
98 DATA_URL: 4
99 };
100
101
102 /**
103 * The return type we're reading.
104 * @type {goog.testing.fs.FileReader.ReturnType}
105 * @private
106 */
107 goog.testing.fs.FileReader.returnType_;
108
109
110 /**
111 * @see {goog.fs.FileReader#getReadyState}
112 * @return {goog.fs.FileReader.ReadyState} The current ready state.
113 */
114 goog.testing.fs.FileReader.prototype.getReadyState = function() {
115 return this.readyState_;
116 };
117
118
119 /**
120 * @see {goog.fs.FileReader#getError}
121 * @return {goog.fs.Error} The current error.
122 */
123 goog.testing.fs.FileReader.prototype.getError = function() {
124 return this.error_;
125 };
126
127
128 /**
129 * @see {goog.fs.FileReader#abort}
130 */
131 goog.testing.fs.FileReader.prototype.abort = function() {
132 if (this.readyState_ != goog.fs.FileReader.ReadyState.LOADING) {
133 var msg = 'aborting read';
134 throw new goog.fs.Error({'name': 'InvalidStateError'}, msg);
135 }
136
137 this.aborted_ = true;
138 };
139
140
141 /**
142 * @see {goog.fs.FileReader#getResult}
143 * @return {*} The result of the file read.
144 */
145 goog.testing.fs.FileReader.prototype.getResult = function() {
146 if (this.readyState_ != goog.fs.FileReader.ReadyState.DONE) {
147 return undefined;
148 }
149 if (this.error_) {
150 return undefined;
151 }
152 if (this.returnType_ == goog.testing.fs.FileReader.ReturnType.TEXT) {
153 return this.blob_.toString();
154 } else if (
155 this.returnType_ == goog.testing.fs.FileReader.ReturnType.ARRAY_BUFFER) {
156 return this.blob_.toArrayBuffer();
157 } else if (
158 this.returnType_ == goog.testing.fs.FileReader.ReturnType.BINARY_STRING) {
159 return this.blob_.toString();
160 } else if (
161 this.returnType_ == goog.testing.fs.FileReader.ReturnType.DATA_URL) {
162 return this.blob_.toDataUrl();
163 } else {
164 return undefined;
165 }
166 };
167
168
169 /**
170 * Fires the read events.
171 * @param {!goog.testing.fs.Blob} blob The blob to read from.
172 * @private
173 */
174 goog.testing.fs.FileReader.prototype.read_ = function(blob) {
175 this.blob_ = blob;
176 if (this.readyState_ == goog.fs.FileReader.ReadyState.LOADING) {
177 var msg = 'reading file';
178 throw new goog.fs.Error({'name': 'InvalidStateError'}, msg);
179 }
180
181 this.readyState_ = goog.fs.FileReader.ReadyState.LOADING;
182 goog.Timer.callOnce(function() {
183 if (this.aborted_) {
184 this.abort_(blob.size);
185 return;
186 }
187
188 this.progressEvent_(goog.fs.FileReader.EventType.LOAD_START, 0, blob.size);
189 this.progressEvent_(
190 goog.fs.FileReader.EventType.LOAD, blob.size / 2, blob.size);
191 this.progressEvent_(
192 goog.fs.FileReader.EventType.LOAD, blob.size, blob.size);
193 this.readyState_ = goog.fs.FileReader.ReadyState.DONE;
194 this.progressEvent_(
195 goog.fs.FileReader.EventType.LOAD, blob.size, blob.size);
196 this.progressEvent_(
197 goog.fs.FileReader.EventType.LOAD_END, blob.size, blob.size);
198 }, 0, this);
199 };
200
201
202 /**
203 * @see {goog.fs.FileReader#readAsBinaryString}
204 * @param {!goog.testing.fs.Blob} blob The blob to read.
205 */
206 goog.testing.fs.FileReader.prototype.readAsBinaryString = function(blob) {
207 this.returnType_ = goog.testing.fs.FileReader.ReturnType.BINARY_STRING;
208 this.read_(blob);
209 };
210
211
212 /**
213 * @see {goog.fs.FileReader#readAsArrayBuffer}
214 * @param {!goog.testing.fs.Blob} blob The blob to read.
215 */
216 goog.testing.fs.FileReader.prototype.readAsArrayBuffer = function(blob) {
217 this.returnType_ = goog.testing.fs.FileReader.ReturnType.ARRAY_BUFFER;
218 this.read_(blob);
219 };
220
221
222 /**
223 * @see {goog.fs.FileReader#readAsText}
224 * @param {!goog.testing.fs.Blob} blob The blob to read.
225 * @param {string=} opt_encoding The name of the encoding to use.
226 */
227 goog.testing.fs.FileReader.prototype.readAsText = function(blob, opt_encoding) {
228 this.returnType_ = goog.testing.fs.FileReader.ReturnType.TEXT;
229 this.read_(blob);
230 };
231
232
233 /**
234 * @see {goog.fs.FileReader#readAsDataUrl}
235 * @param {!goog.testing.fs.Blob} blob The blob to read.
236 */
237 goog.testing.fs.FileReader.prototype.readAsDataUrl = function(blob) {
238 this.returnType_ = goog.testing.fs.FileReader.ReturnType.DATA_URL;
239 this.read_(blob);
240 };
241
242
243 /**
244 * Abort the current action and emit appropriate events.
245 *
246 * @param {number} total The total data that was to be processed, in bytes.
247 * @private
248 */
249 goog.testing.fs.FileReader.prototype.abort_ = function(total) {
250 this.error_ = new goog.fs.Error({'name': 'AbortError'}, 'reading file');
251 this.progressEvent_(goog.fs.FileReader.EventType.ERROR, 0, total);
252 this.progressEvent_(goog.fs.FileReader.EventType.ABORT, 0, total);
253 this.readyState_ = goog.fs.FileReader.ReadyState.DONE;
254 this.progressEvent_(goog.fs.FileReader.EventType.LOAD_END, 0, total);
255 this.aborted_ = false;
256 };
257
258
259 /**
260 * Dispatch a progress event.
261 *
262 * @param {goog.fs.FileReader.EventType} type The event type.
263 * @param {number} loaded The number of bytes processed.
264 * @param {number} total The total data that was to be processed, in bytes.
265 * @private
266 */
267 goog.testing.fs.FileReader.prototype.progressEvent_ = function(
268 type, loaded, total) {
269 this.dispatchEvent(new goog.testing.fs.ProgressEvent(type, loaded, total));
270 };