[ES6] Add support for Symbol.toPrimitive
[WebKit-https.git] / Source / JavaScriptCore / runtime / CommonIdentifiers.h
1 /*
2  *  Copyright (C) 2003, 2007, 2009 Apple Inc. All rights reserved.
3  *
4  *  This library is free software; you can redistribute it and/or
5  *  modify it under the terms of the GNU Library General Public
6  *  License as published by the Free Software Foundation; either
7  *  version 2 of the License, or (at your option) any later version.
8  *
9  *  This library is distributed in the hope that it will be useful,
10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  *  Library General Public License for more details.
13  *
14  *  You should have received a copy of the GNU Library General Public License
15  *  along with this library; see the file COPYING.LIB.  If not, write to
16  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  *  Boston, MA 02110-1301, USA.
18  *
19  */
20
21 #ifndef CommonIdentifiers_h
22 #define CommonIdentifiers_h
23
24 #include "BytecodeIntrinsicRegistry.h"
25 #include "Identifier.h"
26 #include <wtf/Noncopyable.h>
27
28 // MarkedArgumentBuffer of property names, passed to a macro so we can do set them up various
29 // ways without repeating the list.
30 #define JSC_COMMON_IDENTIFIERS_EACH_PROPERTY_NAME(macro) \
31     macro(Array) \
32     macro(ArrayBuffer) \
33     macro(ArrayIterator) \
34     macro(BYTES_PER_ELEMENT) \
35     macro(Boolean) \
36     macro(Collator) \
37     macro(Date) \
38     macro(DateTimeFormat) \
39     macro(Error) \
40     macro(EvalError) \
41     macro(Function) \
42     macro(GeneratorFunction) \
43     macro(Infinity) \
44     macro(Intl) \
45     macro(JSON) \
46     macro(Loader) \
47     macro(Map)\
48     macro(MapIterator)\
49     macro(Math) \
50     macro(NaN) \
51     macro(Number) \
52     macro(NumberFormat) \
53     macro(Object) \
54     macro(Promise) \
55     macro(Proxy) \
56     macro(RangeError) \
57     macro(ReferenceError) \
58     macro(Reflect) \
59     macro(RegExp) \
60     macro(Set)\
61     macro(SetIterator)\
62     macro(String) \
63     macro(Symbol) \
64     macro(SyntaxError) \
65     macro(TypeError) \
66     macro(URIError) \
67     macro(UTC) \
68     macro(WeakMap)\
69     macro(WeakSet)\
70     macro(__defineGetter__) \
71     macro(__defineSetter__) \
72     macro(__lookupGetter__) \
73     macro(__lookupSetter__) \
74     macro(add) \
75     macro(additionalJettisonReason) \
76     macro(anonymous) \
77     macro(arguments) \
78     macro(as) \
79     macro(assign) \
80     macro(back) \
81     macro(bind) \
82     macro(blur) \
83     macro(buffer) \
84     macro(byteLength) \
85     macro(byteOffset) \
86     macro(bytecode) \
87     macro(bytecodeIndex) \
88     macro(bytecodes) \
89     macro(bytecodesID) \
90     macro(calendar) \
91     macro(callee) \
92     macro(caller) \
93     macro(caseFirst) \
94     macro(clear) \
95     macro(close) \
96     macro(closed) \
97     macro(collation) \
98     macro(column) \
99     macro(compilationKind) \
100     macro(compilations) \
101     macro(compile) \
102     macro(configurable) \
103     macro(constructor) \
104     macro(count) \
105     macro(counters) \
106     macro(day) \
107     macro(defineProperty) \
108     macro(description) \
109     macro(descriptions) \
110     macro(displayName) \
111     macro(document) \
112     macro(done) \
113     macro(entries) \
114     macro(enumerable) \
115     macro(era) \
116     macro(eval) \
117     macro(exec) \
118     macro(executionCount) \
119     macro(exitKind) \
120     macro(flags) \
121     macro(focus) \
122     macro(forEach) \
123     macro(formatMatcher) \
124     macro(forward) \
125     macro(frames) \
126     macro(from) \
127     macro(fromCharCode) \
128     macro(get) \
129     macro(global) \
130     macro(go) \
131     macro(has) \
132     macro(hasOwnProperty) \
133     macro(hash) \
134     macro(header) \
135     macro(hour) \
136     macro(hour12) \
137     macro(href) \
138     macro(id) \
139     macro(ignoreCase) \
140     macro(ignorePunctuation) \
141     macro(index) \
142     macro(indexedDB) \
143     macro(inferredName) \
144     macro(input) \
145     macro(instructionCount) \
146     macro(isArray) \
147     macro(isEnabled) \
148     macro(isPrototypeOf) \
149     macro(isView) \
150     macro(isWatchpoint) \
151     macro(jettisonReason) \
152     macro(join) \
153     macro(keys) \
154     macro(lastIndex) \
155     macro(length) \
156     macro(line) \
157     macro(locale) \
158     macro(localeMatcher) \
159     macro(location) \
160     macro(message) \
161     macro(minute) \
162     macro(month) \
163     macro(multiline) \
164     macro(name) \
165     macro(next) \
166     macro(now) \
167     macro(numInlinedCalls) \
168     macro(numInlinedGetByIds) \
169     macro(numInlinedPutByIds) \
170     macro(numberingSystem) \
171     macro(numeric) \
172     macro(of) \
173     macro(opcode) \
174     macro(opener) \
175     macro(origin) \
176     macro(osrExitSites) \
177     macro(osrExits) \
178     macro(parent) \
179     macro(parse) \
180     macro(parseInt) \
181     macro(postMessage) \
182     macro(profiledBytecodes) \
183     macro(propertyIsEnumerable) \
184     macro(prototype) \
185     macro(raw) \
186     macro(reload) \
187     macro(replace) \
188     macro(resolve) \
189     macro(second) \
190     macro(self) \
191     macro(sensitivity) \
192     macro(set) \
193     macro(showModalDialog) \
194     macro(size) \
195     macro(slice) \
196     macro(source) \
197     macro(sourceCode) \
198     macro(sourceURL) \
199     macro(stack) \
200     macro(subarray) \
201     macro(target) \
202     macro(test) \
203     macro(then) \
204     macro(timeZone) \
205     macro(timeZoneName) \
206     macro(toExponential) \
207     macro(toFixed) \
208     macro(toISOString) \
209     macro(toJSON) \
210     macro(toLocaleString) \
211     macro(toPrecision) \
212     macro(toString) \
213     macro(top) \
214     macro(unicode) \
215     macro(usage) \
216     macro(value) \
217     macro(valueOf) \
218     macro(values) \
219     macro(webkit) \
220     macro(webkitIndexedDB) \
221     macro(weekday) \
222     macro(window) \
223     macro(writable) \
224     macro(year)
225
226 #define JSC_COMMON_IDENTIFIERS_EACH_KEYWORD(macro) \
227     macro(break) \
228     macro(case) \
229     macro(catch) \
230     macro(class) \
231     macro(const) \
232     macro(continue) \
233     macro(debugger) \
234     macro(default) \
235     macro(delete) \
236     macro(do) \
237     macro(else) \
238     macro(enum) \
239     macro(export) \
240     macro(extends) \
241     macro(false) \
242     macro(finally) \
243     macro(for) \
244     macro(function) \
245     macro(if) \
246     macro(implements) \
247     macro(import) \
248     macro(in) \
249     macro(instanceof) \
250     macro(interface) \
251     macro(let) \
252     macro(new) \
253     macro(null) \
254     macro(package) \
255     macro(private) \
256     macro(protected) \
257     macro(public) \
258     macro(return) \
259     macro(static) \
260     macro(super) \
261     macro(switch) \
262     macro(this) \
263     macro(throw) \
264     macro(true) \
265     macro(try) \
266     macro(typeof) \
267     macro(undefined) \
268     macro(var) \
269     macro(void) \
270     macro(while) \
271     macro(with) \
272     macro(yield)
273
274 #define JSC_COMMON_PRIVATE_IDENTIFIERS_EACH_WELL_KNOWN_SYMBOL_NOT_IMPLEMENTED_YET(macro)\
275     macro(isConcatSpreadable) \
276     macro(match) \
277     macro(replace) \
278     macro(split) \
279
280 #define JSC_COMMON_PRIVATE_IDENTIFIERS_EACH_WELL_KNOWN_SYMBOL(macro) \
281     macro(hasInstance) \
282     macro(iterator) \
283     macro(search) \
284     macro(species) \
285     macro(toPrimitive) \
286     macro(toStringTag) \
287     macro(unscopables)
288
289 #define JSC_COMMON_PRIVATE_IDENTIFIERS_EACH_PROPERTY_NAME(macro) \
290     JSC_COMMON_BYTECODE_INTRINSIC_FUNCTIONS_EACH_NAME(macro) \
291     JSC_COMMON_BYTECODE_INTRINSIC_CONSTANTS_EACH_NAME(macro) \
292     macro(iteratedObject) \
293     macro(arrayIteratorNextIndex) \
294     macro(arrayIterationKind) \
295     macro(charCodeAt) \
296     macro(iteratedString) \
297     macro(stringIteratorNextIndex) \
298     macro(promise) \
299     macro(fulfillmentHandler) \
300     macro(rejectionHandler) \
301     macro(index) \
302     macro(values) \
303     macro(deferred) \
304     macro(countdownHolder) \
305     macro(Object) \
306     macro(ownEnumerablePropertyKeys) \
307     macro(Number) \
308     macro(Array) \
309     macro(String) \
310     macro(RegExp) \
311     macro(Map) \
312     macro(Promise) \
313     macro(InternalPromise) \
314     macro(abs) \
315     macro(floor) \
316     macro(isFinite) \
317     macro(isNaN) \
318     macro(getPrototypeOf) \
319     macro(getOwnPropertyNames) \
320     macro(RangeError) \
321     macro(TypeError) \
322     macro(typedArrayLength) \
323     macro(typedArraySort) \
324     macro(typedArrayGetOriginalConstructor) \
325     macro(BuiltinLog) \
326     macro(homeObject) \
327     macro(getTemplateObject) \
328     macro(enqueueJob) \
329     macro(handler) \
330     macro(promiseState) \
331     macro(promiseFulfillReactions) \
332     macro(promiseRejectReactions) \
333     macro(promiseResult) \
334     macro(push) \
335     macro(capabilities) \
336     macro(starDefault) \
337     macro(InspectorInstrumentation) \
338     macro(get) \
339     macro(set) \
340     macro(shift) \
341     macro(allocateTypedArray) \
342     macro(Int8Array) \
343     macro(Int16Array) \
344     macro(Int32Array) \
345     macro(Uint8Array) \
346     macro(Uint8ClampedArray) \
347     macro(Uint16Array) \
348     macro(Uint32Array) \
349     macro(Float32Array) \
350     macro(Float64Array) \
351     macro(generator) \
352     macro(generatorNext) \
353     macro(generatorState) \
354     macro(generatorFrame) \
355     macro(generatorValue) \
356     macro(generatorThis) \
357     macro(generatorResumeMode) \
358     macro(Collator) \
359     macro(DateTimeFormat) \
360     macro(NumberFormat) \
361     macro(thisTimeValue) \
362     macro(newTargetLocal) \
363     macro(derivedConstructor) \
364     macro(isBoundFunction) \
365     macro(hasInstanceBoundFunction) \
366     macro(instanceOf) \
367     macro(isSet) \
368     macro(isMap) \
369     macro(SetIterator) \
370     macro(setIteratorNext) \
371     macro(MapIterator) \
372     macro(mapIteratorNext) \
373
374
375 namespace JSC {
376     
377     class BuiltinNames;
378     
379     class CommonIdentifiers {
380         WTF_MAKE_NONCOPYABLE(CommonIdentifiers); WTF_MAKE_FAST_ALLOCATED;
381     private:
382         CommonIdentifiers(VM*);
383         ~CommonIdentifiers();
384         friend class VM;
385         
386     public:
387         const BuiltinNames& builtinNames() const { return *m_builtinNames; }
388         const Identifier nullIdentifier;
389         const Identifier emptyIdentifier;
390         const Identifier underscoreProto;
391         const Identifier thisIdentifier;
392         const Identifier useStrictIdentifier;
393         const Identifier timesIdentifier;
394     private:
395         std::unique_ptr<BuiltinNames> m_builtinNames;
396
397     public:
398         
399 #define JSC_IDENTIFIER_DECLARE_KEYWORD_NAME_GLOBAL(name) const Identifier name##Keyword;
400         JSC_COMMON_IDENTIFIERS_EACH_KEYWORD(JSC_IDENTIFIER_DECLARE_KEYWORD_NAME_GLOBAL)
401 #undef JSC_IDENTIFIER_DECLARE_KEYWORD_NAME_GLOBAL
402         
403 #define JSC_IDENTIFIER_DECLARE_PROPERTY_NAME_GLOBAL(name) const Identifier name;
404         JSC_COMMON_IDENTIFIERS_EACH_PROPERTY_NAME(JSC_IDENTIFIER_DECLARE_PROPERTY_NAME_GLOBAL)
405 #undef JSC_IDENTIFIER_DECLARE_PROPERTY_NAME_GLOBAL
406
407 #define JSC_IDENTIFIER_DECLARE_PRIVATE_PROPERTY_NAME_GLOBAL(name) const Identifier name##PrivateName;
408         JSC_COMMON_PRIVATE_IDENTIFIERS_EACH_PROPERTY_NAME(JSC_IDENTIFIER_DECLARE_PRIVATE_PROPERTY_NAME_GLOBAL)
409 #undef JSC_IDENTIFIER_DECLARE_PRIVATE_PROPERTY_NAME_GLOBAL
410
411 #define JSC_IDENTIFIER_DECLARE_PRIVATE_WELL_KNOWN_SYMBOL_GLOBAL(name) const Identifier name##Symbol;
412         JSC_COMMON_PRIVATE_IDENTIFIERS_EACH_WELL_KNOWN_SYMBOL(JSC_IDENTIFIER_DECLARE_PRIVATE_WELL_KNOWN_SYMBOL_GLOBAL)
413 #undef JSC_IDENTIFIER_DECLARE_PRIVATE_WELL_KNOWN_SYMBOL_GLOBAL
414
415         bool isPrivateName(SymbolImpl& uid) const;
416         bool isPrivateName(UniquedStringImpl& uid) const;
417         bool isPrivateName(const Identifier&) const;
418
419         const Identifier* lookUpPrivateName(const Identifier&) const;
420         Identifier lookUpPublicName(const Identifier&) const;
421
422         // Callers of this method should make sure that identifiers given to this method 
423         // survive the lifetime of CommonIdentifiers and related VM.
424         JS_EXPORT_PRIVATE void appendExternalName(const Identifier& publicName, const Identifier& privateName);
425     };
426
427 } // namespace JSC
428
429 #endif // CommonIdentifiers_h