Repository navigation
Expand file tree
/
Copy pathmap.js
More file actions
568 lines (510 loc) · 16 KB
/
Copy pathmap.js
File metadata and controls
568 lines (510 loc) · 16 KB
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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc. All rights reserved.
// https://protobuf.dev/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
/**
* @fileoverview
*/
// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc. All rights reserved.
// https://protobuf.dev/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
/**
* @fileoverview
*/
goog.module('jspb.Map');
goog.module.declareLegacyNamespace();
const asserts = goog.require('jspb.asserts');
const BinaryReader = goog.requireType('jspb.BinaryReader');
/**
* Constructs a new Map. A Map is a container that is used to implement map
* fields on message objects. It closely follows the ES6 Map API; however,
* it is distinct because we do not want to depend on external polyfills or
* on ES6 itself.
*
* This constructor should only be called from generated message code. It is not
* intended for general use by library consumers.
*
* @template K, V
*
* @param {!Array<!Array<?>>} arr
*
* @param {?function(new:V, ?=)=} opt_valueCtor
* The constructor for type V, if type V is a message type.
*
* @constructor
* @struct
*/
const Map = function (arr, opt_valueCtor) {
/** @const @private */
this.arr_ = arr;
/** @const @private */
this.valueCtor_ = opt_valueCtor;
/** @type {!Object<string, !Entry_<K,V>>} @private */
this.map_ = {};
/**
* Is `this.arr_ updated with respect to `this.map_`?
* @type {boolean}
* @export
*/
this.arrClean = true;
if (this.arr_.length > 0) {
this.loadFromArray_();
}
};
/**
* @param {K} key The entry's key.
* @param {V=} opt_value The entry's value wrapper.
* @constructor
* @struct
* @template K, V
* @private
*/
const Entry_ = function (key, opt_value) {
/** @const {K} */
this.key = key;
// The JSPB-serializable value. For primitive types this will be of type V.
// For message types it will be an array.
/** @type {V} */
this.value = opt_value;
// Only used for submessage values.
/** @type {V} */
this.valueWrapper = undefined;
};
/**
* Load initial content from underlying array.
* @private
*/
Map.prototype.loadFromArray_ = function () {
for (var i = 0; i < this.arr_.length; i++) {
var record = this.arr_[i];
var key = record[0];
var value = record[1];
this.map_[key.toString()] = new Entry_(key, value);
}
this.arrClean = true;
};
/**
* Synchronize content to underlying array, if needed, and return it.
* @return {!Array<!Array<!Object>>}
* @export
*/
Map.prototype.toArray = function () {
if (this.arrClean) {
if (this.valueCtor_) {
// We need to recursively sync maps in submessages to their arrays.
var m = this.map_;
for (var p in m) {
if (Object.prototype.hasOwnProperty.call(m, p)) {
var valueWrapper = /** @type {?jspb.Message} */ (m[p].valueWrapper);
if (valueWrapper) {
valueWrapper.toArray();
}
}
}
}
} else {
// Delete all elements.
this.arr_.length = 0;
var strKeys = this.stringKeys_();
// Output keys in deterministic (sorted) order.
strKeys.sort();
for (var i = 0; i < strKeys.length; i++) {
var entry = this.map_[strKeys[i]];
var valueWrapper = /** @type {?jspb.Message} */ (entry.valueWrapper);
if (valueWrapper) {
valueWrapper.toArray();
}
this.arr_.push([entry.key, entry.value]);
}
this.arrClean = true;
}
return this.arr_;
};
/**
* Returns the map formatted as an array of key-value pairs, suitable for the
* toObject() form of a message.
*
* @param {boolean=} includeInstance Whether to include the JSPB instance for
* transitional soy proto support: http://goto/soy-param-migration
* @param {function((boolean|undefined),V):!Object=} valueToObject
* The static toObject() method, if V is a message type.
* @return {!Array<!Array<!Object>>}
* @export
*/
Map.prototype.toObject = function (includeInstance, valueToObject) {
var rawArray = this.toArray();
var entries = [];
for (var i = 0; i < rawArray.length; i++) {
var entry = this.map_[rawArray[i][0].toString()];
this.wrapEntry_(entry);
var valueWrapper = /** @type {V|undefined} */ (entry.valueWrapper);
if (valueWrapper) {
asserts.assert(valueToObject);
entries.push([entry.key, valueToObject(includeInstance, valueWrapper)]);
} else {
entries.push([entry.key, entry.value]);
}
}
return entries;
};
/**
* Returns a Map from the given array of key-value pairs when the values are of
* message type. The values in the array must match the format returned by their
* message type's toObject() method.
*
* @template K, V
* @param {!Array<!Array<!Object>>} entries
* @param {function(new:V,?=)} valueCtor
* The constructor for type V.
* @param {function(!Object):V} valueFromObject
* The fromObject function for type V.
* @return {!Map<K, V>}
* @export
*/
Map.fromObject = function (entries, valueCtor, valueFromObject) {
var result = new Map([], valueCtor);
for (var i = 0; i < entries.length; i++) {
var key = entries[i][0];
var value = valueFromObject(entries[i][1]);
result.set(key, value);
}
return result;
};
/**
* Helper: an IteratorIterable over an array.
* @template T
* @param {!Array<T>} arr the array
* @implements {IteratorIterable<T>}
* @constructor @struct
* @private
*/
const ArrayIteratorIterable_ = function (arr) {
/** @type {number} @private */
this.idx_ = 0;
/** @const @private */
this.arr_ = arr;
};
/** @override @final */
ArrayIteratorIterable_.prototype.next = function () {
if (this.idx_ < this.arr_.length) {
return { done: false, value: this.arr_[this.idx_++] };
} else {
return { done: true, value: undefined };
}
};
if (typeof (Symbol) != 'undefined') {
/** @override */
ArrayIteratorIterable_.prototype[Symbol.iterator] = function () {
return this;
};
}
/**
* Returns the map's length (number of key/value pairs).
* @return {number}
* @export
*/
Map.prototype.getLength = function () {
return this.stringKeys_().length;
};
/**
* Clears the map.
* @export
*/
Map.prototype.clear = function () {
this.map_ = {};
this.arrClean = false;
};
/**
* Deletes a particular key from the map.
* N.B.: differs in name from ES6 Map's `delete` because IE8 does not support
* reserved words as property names.
* @this {Map}
* @param {K} key
* @return {boolean} Whether any entry with this key was deleted.
* @export
*/
Map.prototype.del = function (key) {
var keyValue = key.toString();
var hadKey = this.map_.hasOwnProperty(keyValue);
delete this.map_[keyValue];
this.arrClean = false;
return hadKey;
};
/**
* Returns an array of [key, value] pairs in the map.
*
* This is redundant compared to the plain entries() method, but we provide this
* to help out Angular 1.x users. Still evaluating whether this is the best
* option.
*
* @return {!Array<!Array<K|V>>}
* @export
*/
Map.prototype.getEntryList = function () {
var entries = [];
var strKeys = this.stringKeys_();
strKeys.sort();
for (var i = 0; i < strKeys.length; i++) {
var entry = this.map_[strKeys[i]];
entries.push([entry.key, entry.value]);
}
return entries;
};
/**
* Returns an iterator-iterable over [key, value] pairs in the map.
* Closure compiler sadly doesn't support tuples, ie. Iterator<[K,V]>.
* @return {!IteratorIterable<!Array<K|V>>} The iterator-iterable.
* @export
*/
Map.prototype.entries = function () {
var entries = [];
var strKeys = this.stringKeys_();
strKeys.sort();
for (var i = 0; i < strKeys.length; i++) {
var entry = this.map_[strKeys[i]];
entries.push([entry.key, this.wrapEntry_(entry)]);
}
return new ArrayIteratorIterable_(entries);
};
/**
* Returns an iterator-iterable over keys in the map.
* @return {!IteratorIterable<K>} The iterator-iterable.
* @export
*/
Map.prototype.keys = function () {
var keys = [];
var strKeys = this.stringKeys_();
strKeys.sort();
for (var i = 0; i < strKeys.length; i++) {
var entry = this.map_[strKeys[i]];
keys.push(entry.key);
}
return new ArrayIteratorIterable_(keys);
};
/**
* Returns an iterator-iterable over values in the map.
* @return {!IteratorIterable<V>} The iterator-iterable.
* @export
*/
Map.prototype.values = function () {
var values = [];
var strKeys = this.stringKeys_();
strKeys.sort();
for (var i = 0; i < strKeys.length; i++) {
var entry = this.map_[strKeys[i]];
values.push(this.wrapEntry_(entry));
}
return new ArrayIteratorIterable_(values);
};
/**
* Iterates over entries in the map, calling a function on each.
* @template T
* @param {function(this:T, V, K, ?Map<K, V>)} cb
* @param {T=} opt_thisArg
* @export
*/
Map.prototype.forEach = function (cb, opt_thisArg) {
var strKeys = this.stringKeys_();
strKeys.sort();
for (var i = 0; i < strKeys.length; i++) {
var entry = this.map_[strKeys[i]];
cb.call(opt_thisArg, this.wrapEntry_(entry), entry.key, this);
}
};
/**
* Sets a key in the map to the given value.
* @param {K} key The key
* @param {V} value The value
* @return {!Map<K,V>}
* @export
*/
Map.prototype.set = function (key, value) {
var entry = new Entry_(key);
if (this.valueCtor_) {
entry.valueWrapper = value;
// .toArray() on a message returns a reference to the underlying array
// rather than a copy.
entry.value = value.toArray();
} else {
entry.value = value;
}
this.map_[key.toString()] = entry;
this.arrClean = false;
return this;
};
/**
* Helper: lazily construct a wrapper around an entry, if needed, and return the
* user-visible type.
* @param {!Entry_<K,V>} entry
* @return {V}
* @private
*/
Map.prototype.wrapEntry_ = function (entry) {
if (this.valueCtor_) {
if (!entry.valueWrapper) {
entry.valueWrapper = new this.valueCtor_(entry.value);
}
return /** @type {V} */ (entry.valueWrapper);
} else {
return entry.value;
}
};
/**
* Gets the value corresponding to a key in the map.
* @param {K} key
* @return {V|undefined} The value, or `undefined` if key not present
* @export
*/
Map.prototype.get = function (key) {
var keyValue = key.toString();
var entry = this.map_[keyValue];
if (entry) {
return this.wrapEntry_(entry);
} else {
return undefined;
}
};
/**
* Determines whether the given key is present in the map.
* @param {K} key
* @return {boolean} `true` if the key is present
* @export
*/
Map.prototype.has = function (key) {
var keyValue = key.toString();
return (keyValue in this.map_);
};
/**
* Read one key/value message from the given BinaryReader. Compatible as the
* `reader` callback parameter to jspb.BinaryReader.readMessage, to be called
* when a key/value pair submessage is encountered. If the Key is undefined,
* we should default it to 0.
* @template K, V
* @param {!Map} map
* @param {!BinaryReader} reader
* @param {function(this:BinaryReader):K} keyReaderFn
* The method on BinaryReader that reads type K from the stream.
*
* @param {function(this:BinaryReader):V|
* function(this:BinaryReader,V,
* function(V,!BinaryReader))} valueReaderFn
* The method on BinaryReader that reads type V from the stream. May be
* readMessage, in which case the second callback arg form is used.
*
* @param {?function(V,!BinaryReader)=} opt_valueReaderCallback
* The BinaryReader parsing callback for type V, if V is a message type
*
* @param {K=} opt_defaultKey
* The default value for the type of map keys. Accepting map entries with
* unset keys is required for maps to be backwards compatible with the
* repeated message representation described here: goo.gl/zuoLAC
*
* @param {V=} opt_defaultValue
* The default value for the type of map values. Accepting map entries with
* unset values is required for maps to be backwards compatible with the
* repeated message representation described here: goo.gl/zuoLAC
* @export
*
*/
Map.deserializeBinary = function (map, reader, keyReaderFn, valueReaderFn,
opt_valueReaderCallback, opt_defaultKey,
opt_defaultValue) {
var key = opt_defaultKey;
var value = opt_defaultValue;
while (reader.nextField()) {
if (reader.isEndGroup()) {
break;
}
var field = reader.getFieldNumber();
if (field == 1) {
// Key.
key = keyReaderFn.call(reader);
} else if (field == 2) {
// Value.
if (map.valueCtor_) {
asserts.assert(opt_valueReaderCallback);
if (!value) {
// Old generator still doesn't provide default value message.
// Need this for backward compatibility.
value = new map.valueCtor_();
}
valueReaderFn.call(reader, value, opt_valueReaderCallback);
} else {
value =
(/** @type {function(this:BinaryReader):?} */ (valueReaderFn))
.call(reader);
}
}
}
asserts.assert(key != undefined);
asserts.assert(value != undefined);
map.set(key, value);
};
/**
* Helper: compute the list of all stringified keys in the underlying Object
* map.
* @return {!Array<string>}
* @private
*/
Map.prototype.stringKeys_ = function () {
var m = this.map_;
var ret = [];
for (var p in m) {
if (Object.prototype.hasOwnProperty.call(m, p)) {
ret.push(p);
}
}
return ret;
};
exports = Map;