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
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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/. */
/* Property and element API. */
#ifndef js_PropertyAndElement_h
#define js_PropertyAndElement_h
#include <stddef.h> // size_t
#include <stdint.h> // uint32_t
#include "jstypes.h" // JS_PUBLIC_API
#include "js/CallArgs.h" // JSNative
#include "js/GCVector.h" // JS::GCVector
#include "js/Id.h" // jsid
#include "js/RootingAPI.h" // JS::Handle, JS::MutableHandle
struct JSContext;
class JSFunction;
class JSObject;
class JSString;
namespace JS {
class ObjectOpResult;
class JS_PUBLIC_API PropertyDescriptor;
using IdVector = JS::GCVector<jsid>;
} /* namespace JS */
/**
* Define a property on obj.
*
* This function uses JS::ObjectOpResult to indicate conditions that ES6
* specifies as non-error failures. This is inconvenient at best, so use this
* function only if you are implementing a proxy handler's defineProperty()
* method. For all other purposes, use one of the many DefineProperty functions
* below that throw an exception in all failure cases.
*
* Implements: ES6 [[DefineOwnProperty]] internal method.
*/
extern JS_PUBLIC_API bool JS_DefinePropertyById(
JSContext* cx, JS::Handle<JSObject*> obj, JS::Handle<jsid> id,
JS::Handle<JS::PropertyDescriptor> desc, JS::ObjectOpResult& result);
/**
* Define a property on obj, throwing a TypeError if the attempt fails.
* This is the C++ equivalent of `Object.defineProperty(obj, id, desc)`.
*/
extern JS_PUBLIC_API bool JS_DefinePropertyById(
JSContext* cx, JS::Handle<JSObject*> obj, JS::Handle<jsid> id,
JS::Handle<JS::PropertyDescriptor> desc);
extern JS_PUBLIC_API bool JS_DefinePropertyById(JSContext* cx,
JS::Handle<JSObject*> obj,
JS::Handle<jsid> id,
JS::Handle<JS::Value> value,
unsigned attrs);
extern JS_PUBLIC_API bool JS_DefinePropertyById(
JSContext* cx, JS::Handle<JSObject*> obj, JS::Handle<jsid> id,
JSNative getter, JSNative setter, unsigned attrs);
extern JS_PUBLIC_API bool JS_DefinePropertyById(
JSContext* cx, JS::Handle<JSObject*> obj, JS::Handle<jsid> id,
JS::Handle<JSObject*> getter, JS::Handle<JSObject*> setter, unsigned attrs);
extern JS_PUBLIC_API bool JS_DefinePropertyById(JSContext* cx,
JS::Handle<JSObject*> obj,
JS::Handle<jsid> id,
JS::Handle<JSObject*> value,
unsigned attrs);
extern JS_PUBLIC_API bool JS_DefinePropertyById(JSContext* cx,
JS::Handle<JSObject*> obj,
JS::Handle<jsid> id,
JS::Handle<JSString*> value,
unsigned attrs);
extern JS_PUBLIC_API bool JS_DefinePropertyById(JSContext* cx,
JS::Handle<JSObject*> obj,
JS::Handle<jsid> id,
int32_t value, unsigned attrs);
extern JS_PUBLIC_API bool JS_DefinePropertyById(JSContext* cx,
JS::Handle<JSObject*> obj,
JS::Handle<jsid> id,
uint32_t value, unsigned attrs);
extern JS_PUBLIC_API bool JS_DefinePropertyById(JSContext* cx,
JS::Handle<JSObject*> obj,
JS::Handle<jsid> id,
double value, unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char* name,
JS::Handle<JS::Value> value,
unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char* name, JSNative getter,
JSNative setter, unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineProperty(
JSContext* cx, JS::Handle<JSObject*> obj, const char* name,
JS::Handle<JSObject*> getter, JS::Handle<JSObject*> setter, unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char* name,
JS::Handle<JSObject*> value,
unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char* name,
JS::Handle<JSString*> value,
unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char* name, int32_t value,
unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char* name, uint32_t value,
unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char* name, double value,
unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineUCProperty(
JSContext* cx, JS::Handle<JSObject*> obj, const char16_t* name,
size_t namelen, JS::Handle<JS::PropertyDescriptor> desc,
JS::ObjectOpResult& result);
extern JS_PUBLIC_API bool JS_DefineUCProperty(
JSContext* cx, JS::Handle<JSObject*> obj, const char16_t* name,
size_t namelen, JS::Handle<JS::PropertyDescriptor> desc);
extern JS_PUBLIC_API bool JS_DefineUCProperty(
JSContext* cx, JS::Handle<JSObject*> obj, const char16_t* name,
size_t namelen, JS::Handle<JS::Value> value, unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineUCProperty(
JSContext* cx, JS::Handle<JSObject*> obj, const char16_t* name,
size_t namelen, JS::Handle<JSObject*> getter, JS::Handle<JSObject*> setter,
unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineUCProperty(
JSContext* cx, JS::Handle<JSObject*> obj, const char16_t* name,
size_t namelen, JS::Handle<JSObject*> value, unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineUCProperty(
JSContext* cx, JS::Handle<JSObject*> obj, const char16_t* name,
size_t namelen, JS::Handle<JSString*> value, unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineUCProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char16_t* name,
size_t namelen, int32_t value,
unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineUCProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char16_t* name,
size_t namelen, uint32_t value,
unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineUCProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char16_t* name,
size_t namelen, double value,
unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineElement(JSContext* cx,
JS::Handle<JSObject*> obj,
uint32_t index,
JS::Handle<JS::Value> value,
unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineElement(
JSContext* cx, JS::Handle<JSObject*> obj, uint32_t index,
JS::Handle<JSObject*> getter, JS::Handle<JSObject*> setter, unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineElement(JSContext* cx,
JS::Handle<JSObject*> obj,
uint32_t index,
JS::Handle<JSObject*> value,
unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineElement(JSContext* cx,
JS::Handle<JSObject*> obj,
uint32_t index,
JS::Handle<JSString*> value,
unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineElement(JSContext* cx,
JS::Handle<JSObject*> obj,
uint32_t index, int32_t value,
unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineElement(JSContext* cx,
JS::Handle<JSObject*> obj,
uint32_t index, uint32_t value,
unsigned attrs);
extern JS_PUBLIC_API bool JS_DefineElement(JSContext* cx,
JS::Handle<JSObject*> obj,
uint32_t index, double value,
unsigned attrs);
/**
* Compute the expression `id in obj`.
*
* If obj has an own or inherited property obj[id], set *foundp = true and
* return true. If not, set *foundp = false and return true. On error, return
* false with an exception pending.
*
* Implements: ES6 [[Has]] internal method.
*/
extern JS_PUBLIC_API bool JS_HasPropertyById(JSContext* cx,
JS::Handle<JSObject*> obj,
JS::Handle<jsid> id, bool* foundp);
extern JS_PUBLIC_API bool JS_HasProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char* name, bool* foundp);
extern JS_PUBLIC_API bool JS_HasUCProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char16_t* name, size_t namelen,
bool* vp);
extern JS_PUBLIC_API bool JS_HasElement(JSContext* cx,
JS::Handle<JSObject*> obj,
uint32_t index, bool* foundp);
/**
* Determine whether obj has an own property with the key `id`.
*
* Implements: ES6 7.3.11 HasOwnProperty(O, P).
*/
extern JS_PUBLIC_API bool JS_HasOwnPropertyById(JSContext* cx,
JS::Handle<JSObject*> obj,
JS::Handle<jsid> id,
bool* foundp);
extern JS_PUBLIC_API bool JS_HasOwnProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char* name, bool* foundp);
/**
* Get the value of the property `obj[id]`, or undefined if no such property
* exists. This is the C++ equivalent of `vp = Reflect.get(obj, id, receiver)`.
*
* Most callers don't need the `receiver` argument. Consider using
* JS_GetProperty instead. (But if you're implementing a proxy handler's set()
* method, it's often correct to call this function and pass the receiver
* through.)
*
* Implements: ES6 [[Get]] internal method.
*/
extern JS_PUBLIC_API bool JS_ForwardGetPropertyTo(
JSContext* cx, JS::Handle<JSObject*> obj, JS::Handle<jsid> id,
JS::Handle<JS::Value> receiver, JS::MutableHandleValue vp);
extern JS_PUBLIC_API bool JS_ForwardGetElementTo(JSContext* cx,
JS::Handle<JSObject*> obj,
uint32_t index,
JS::Handle<JSObject*> receiver,
JS::MutableHandleValue vp);
/**
* Get the value of the property `obj[id]`, or undefined if no such property
* exists. The result is stored in vp.
*
* Implements: ES6 7.3.1 Get(O, P).
*/
extern JS_PUBLIC_API bool JS_GetPropertyById(JSContext* cx,
JS::Handle<JSObject*> obj,
JS::Handle<jsid> id,
JS::MutableHandleValue vp);
extern JS_PUBLIC_API bool JS_GetProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char* name,
JS::MutableHandleValue vp);
extern JS_PUBLIC_API bool JS_GetUCProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char16_t* name, size_t namelen,
JS::MutableHandleValue vp);
extern JS_PUBLIC_API bool JS_GetElement(JSContext* cx,
JS::Handle<JSObject*> obj,
uint32_t index,
JS::MutableHandleValue vp);
/**
* Perform the same property assignment as `Reflect.set(obj, id, v, receiver)`.
*
* This function has a `receiver` argument that most callers don't need.
* Consider using JS_SetProperty instead.
*
* Implements: ES6 [[Set]] internal method.
*/
extern JS_PUBLIC_API bool JS_ForwardSetPropertyTo(
JSContext* cx, JS::Handle<JSObject*> obj, JS::Handle<jsid> id,
JS::Handle<JS::Value> v, JS::Handle<JS::Value> receiver,
JS::ObjectOpResult& result);
/**
* Perform the assignment `obj[id] = v`.
*
* This function performs non-strict assignment, so if the property is
* read-only, nothing happens and no error is thrown.
*/
extern JS_PUBLIC_API bool JS_SetPropertyById(JSContext* cx,
JS::Handle<JSObject*> obj,
JS::Handle<jsid> id,
JS::Handle<JS::Value> v);
extern JS_PUBLIC_API bool JS_SetProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char* name,
JS::Handle<JS::Value> v);
extern JS_PUBLIC_API bool JS_SetUCProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char16_t* name, size_t namelen,
JS::Handle<JS::Value> v);
extern JS_PUBLIC_API bool JS_SetElement(JSContext* cx,
JS::Handle<JSObject*> obj,
uint32_t index,
JS::Handle<JS::Value> v);
extern JS_PUBLIC_API bool JS_SetElement(JSContext* cx,
JS::Handle<JSObject*> obj,
uint32_t index,
JS::Handle<JSObject*> v);
extern JS_PUBLIC_API bool JS_SetElement(JSContext* cx,
JS::Handle<JSObject*> obj,
uint32_t index,
JS::Handle<JSString*> v);
extern JS_PUBLIC_API bool JS_SetElement(JSContext* cx,
JS::Handle<JSObject*> obj,
uint32_t index, int32_t v);
extern JS_PUBLIC_API bool JS_SetElement(JSContext* cx,
JS::Handle<JSObject*> obj,
uint32_t index, uint32_t v);
extern JS_PUBLIC_API bool JS_SetElement(JSContext* cx,
JS::Handle<JSObject*> obj,
uint32_t index, double v);
/**
* Delete a property. This is the C++ equivalent of
* `result = Reflect.deleteProperty(obj, id)`.
*
* This function has a `result` out parameter that most callers don't need.
* Unless you can pass through an ObjectOpResult provided by your caller, it's
* probably best to use the JS_DeletePropertyById signature with just 3
* arguments.
*
* Implements: ES6 [[Delete]] internal method.
*/
extern JS_PUBLIC_API bool JS_DeletePropertyById(JSContext* cx,
JS::Handle<JSObject*> obj,
JS::Handle<jsid> id,
JS::ObjectOpResult& result);
extern JS_PUBLIC_API bool JS_DeleteProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char* name,
JS::ObjectOpResult& result);
extern JS_PUBLIC_API bool JS_DeleteUCProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char16_t* name,
size_t namelen,
JS::ObjectOpResult& result);
extern JS_PUBLIC_API bool JS_DeleteElement(JSContext* cx,
JS::Handle<JSObject*> obj,
uint32_t index,
JS::ObjectOpResult& result);
/**
* Delete a property, ignoring strict failures. This is the C++ equivalent of
* the JS `delete obj[id]` in non-strict mode code.
*/
extern JS_PUBLIC_API bool JS_DeletePropertyById(JSContext* cx,
JS::Handle<JSObject*> obj,
jsid id);
extern JS_PUBLIC_API bool JS_DeleteProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char* name);
extern JS_PUBLIC_API bool JS_DeleteElement(JSContext* cx,
JS::Handle<JSObject*> obj,
uint32_t index);
/**
* Get an array of the non-symbol enumerable properties of obj.
* This function is roughly equivalent to:
*
* var result = [];
* for (key in obj) {
* result.push(key);
* }
* return result;
*
* This is the closest thing we currently have to the ES6 [[Enumerate]]
* internal method.
*
* The array of ids returned by JS_Enumerate must be rooted to protect its
* contents from garbage collection. Use JS::Rooted<JS::IdVector>.
*/
extern JS_PUBLIC_API bool JS_Enumerate(JSContext* cx, JS::Handle<JSObject*> obj,
JS::MutableHandle<JS::IdVector> props);
/*** Other property-defining functions **************************************/
extern JS_PUBLIC_API JSObject* JS_DefineObject(JSContext* cx,
JS::Handle<JSObject*> obj,
const char* name,
const JSClass* clasp = nullptr,
unsigned attrs = 0);
extern JS_PUBLIC_API bool JS_DefineProperties(JSContext* cx,
JS::Handle<JSObject*> obj,
const JSPropertySpec* ps);
/* * */
extern JS_PUBLIC_API bool JS_AlreadyHasOwnPropertyById(
JSContext* cx, JS::Handle<JSObject*> obj, JS::Handle<jsid> id,
bool* foundp);
extern JS_PUBLIC_API bool JS_AlreadyHasOwnProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char* name,
bool* foundp);
extern JS_PUBLIC_API bool JS_AlreadyHasOwnUCProperty(JSContext* cx,
JS::Handle<JSObject*> obj,
const char16_t* name,
size_t namelen,
bool* foundp);
extern JS_PUBLIC_API bool JS_AlreadyHasOwnElement(JSContext* cx,
JS::Handle<JSObject*> obj,
uint32_t index, bool* foundp);
extern JS_PUBLIC_API bool JS_DefineFunctions(JSContext* cx,
JS::Handle<JSObject*> obj,
const JSFunctionSpec* fs);
extern JS_PUBLIC_API JSFunction* JS_DefineFunction(
JSContext* cx, JS::Handle<JSObject*> obj, const char* name, JSNative call,
unsigned nargs, unsigned attrs);
extern JS_PUBLIC_API JSFunction* JS_DefineUCFunction(
JSContext* cx, JS::Handle<JSObject*> obj, const char16_t* name,
size_t namelen, JSNative call, unsigned nargs, unsigned attrs);
extern JS_PUBLIC_API JSFunction* JS_DefineFunctionById(
JSContext* cx, JS::Handle<JSObject*> obj, JS::Handle<jsid> id,
JSNative call, unsigned nargs, unsigned attrs);
#endif /* js_PropertyAndElement_h */
|
