ES6: Implement RegExp.prototype[@@search].
[WebKit-https.git] / Source / JavaScriptCore / runtime / CommonIdentifiers.h
1 /*
2  *  Copyright (C) 2003, 2007, 2009, 2016 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(AnimationTimeline) \
32     macro(Array) \
33     macro(ArrayBuffer) \
34     macro(ArrayIterator) \
35     macro(Audio) \
36     macro(BYTES_PER_ELEMENT) \
37     macro(Boolean) \
38     macro(Collator) \
39     macro(Date) \
40     macro(DateTimeFormat) \
41     macro(DocumentTimeline) \
42     macro(Error) \
43     macro(EvalError) \
44     macro(Function) \
45     macro(Gamepad) \
46     macro(GamepadButton) \
47     macro(GamepadEvent) \
48     macro(GeneratorFunction) \
49     macro(Headers) \
50     macro(HTMLAudioElement) \
51     macro(HTMLSlotElement) \
52     macro(IDBCursor) \
53     macro(IDBCursorWithValue) \
54     macro(IDBDatabase) \
55     macro(IDBFactory) \
56     macro(IDBIndex) \
57     macro(IDBKeyRange) \
58     macro(IDBObjectStore) \
59     macro(IDBOpenDBRequest) \
60     macro(IDBRequest) \
61     macro(IDBTransaction) \
62     macro(IDBVersionChangeEvent) \
63     macro(Infinity) \
64     macro(Intl) \
65     macro(JSON) \
66     macro(Loader) \
67     macro(Map)\
68     macro(MapIterator)\
69     macro(Math) \
70     macro(NaN) \
71     macro(Number) \
72     macro(NumberFormat) \
73     macro(Object) \
74     macro(Promise) \
75     macro(Proxy) \
76     macro(RangeError) \
77     macro(ReferenceError) \
78     macro(Reflect) \
79     macro(RegExp) \
80     macro(Response) \
81     macro(Request) \
82     macro(Set)\
83     macro(SetIterator)\
84     macro(ShadowRoot) \
85     macro(String) \
86     macro(Symbol) \
87     macro(SyntaxError) \
88     macro(TypeError) \
89     macro(URIError) \
90     macro(UTC) \
91     macro(WeakMap)\
92     macro(WeakSet)\
93     macro(WebGL2RenderingContext) \
94     macro(WebGLVertexArrayObject) \
95     macro(WebSocket) \
96     macro(__defineGetter__) \
97     macro(__defineSetter__) \
98     macro(__lookupGetter__) \
99     macro(__lookupSetter__) \
100     macro(add) \
101     macro(additionalJettisonReason) \
102     macro(anonymous) \
103     macro(arguments) \
104     macro(as) \
105     macro(assign) \
106     macro(back) \
107     macro(bind) \
108     macro(blur) \
109     macro(buffer) \
110     macro(byteLength) \
111     macro(byteOffset) \
112     macro(bytecode) \
113     macro(bytecodeIndex) \
114     macro(bytecodes) \
115     macro(bytecodesID) \
116     macro(calendar) \
117     macro(callee) \
118     macro(caller) \
119     macro(caseFirst) \
120     macro(clear) \
121     macro(close) \
122     macro(closed) \
123     macro(collation) \
124     macro(column) \
125     macro(compilationKind) \
126     macro(compilations) \
127     macro(compile) \
128     macro(configurable) \
129     macro(constructor) \
130     macro(count) \
131     macro(counters) \
132     macro(day) \
133     macro(defineProperty) \
134     macro(description) \
135     macro(descriptions) \
136     macro(displayName) \
137     macro(document) \
138     macro(done) \
139     macro(entries) \
140     macro(enumerable) \
141     macro(era) \
142     macro(eval) \
143     macro(exec) \
144     macro(executionCount) \
145     macro(exitKind) \
146     macro(fetch) \
147     macro(flags) \
148     macro(focus) \
149     macro(forEach) \
150     macro(formatMatcher) \
151     macro(forward) \
152     macro(frames) \
153     macro(from) \
154     macro(fromCharCode) \
155     macro(get) \
156     macro(global) \
157     macro(go) \
158     macro(has) \
159     macro(hasOwnProperty) \
160     macro(hash) \
161     macro(header) \
162     macro(hour) \
163     macro(hour12) \
164     macro(href) \
165     macro(id) \
166     macro(ignoreCase) \
167     macro(ignorePunctuation) \
168     macro(index) \
169     macro(indexedDB) \
170     macro(inferredName) \
171     macro(input) \
172     macro(instructionCount) \
173     macro(isArray) \
174     macro(isEnabled) \
175     macro(isPrototypeOf) \
176     macro(isView) \
177     macro(isWatchpoint) \
178     macro(jettisonReason) \
179     macro(join) \
180     macro(keys) \
181     macro(lastIndex) \
182     macro(length) \
183     macro(line) \
184     macro(locale) \
185     macro(localeMatcher) \
186     macro(location) \
187     macro(message) \
188     macro(minute) \
189     macro(month) \
190     macro(multiline) \
191     macro(name) \
192     macro(next) \
193     macro(now) \
194     macro(numInlinedCalls) \
195     macro(numInlinedGetByIds) \
196     macro(numInlinedPutByIds) \
197     macro(numberingSystem) \
198     macro(numeric) \
199     macro(of) \
200     macro(opcode) \
201     macro(opener) \
202     macro(origin) \
203     macro(osrExitSites) \
204     macro(osrExits) \
205     macro(parent) \
206     macro(parse) \
207     macro(parseInt) \
208     macro(postMessage) \
209     macro(profiledBytecodes) \
210     macro(propertyIsEnumerable) \
211     macro(prototype) \
212     macro(raw) \
213     macro(reload) \
214     macro(replace) \
215     macro(resolve) \
216     macro(second) \
217     macro(self) \
218     macro(sensitivity) \
219     macro(set) \
220     macro(showModalDialog) \
221     macro(size) \
222     macro(slice) \
223     macro(source) \
224     macro(sourceCode) \
225     macro(sourceURL) \
226     macro(stack) \
227     macro(sticky) \
228     macro(subarray) \
229     macro(target) \
230     macro(test) \
231     macro(then) \
232     macro(timeZone) \
233     macro(timeZoneName) \
234     macro(toExponential) \
235     macro(toFixed) \
236     macro(toISOString) \
237     macro(toJSON) \
238     macro(toLocaleString) \
239     macro(toPrecision) \
240     macro(toString) \
241     macro(top) \
242     macro(unicode) \
243     macro(usage) \
244     macro(value) \
245     macro(valueOf) \
246     macro(values) \
247     macro(webkit) \
248     macro(webkitIDBCursor) \
249     macro(webkitIDBDatabase) \
250     macro(webkitIDBFactory) \
251     macro(webkitIDBIndex) \
252     macro(webkitIDBKeyRange) \
253     macro(webkitIDBObjectStore) \
254     macro(webkitIDBRequest) \
255     macro(webkitIDBTransaction) \
256     macro(webkitIndexedDB) \
257     macro(weekday) \
258     macro(window) \
259     macro(writable) \
260     macro(year)
261
262 #define JSC_COMMON_IDENTIFIERS_EACH_KEYWORD(macro) \
263     macro(break) \
264     macro(case) \
265     macro(catch) \
266     macro(class) \
267     macro(const) \
268     macro(continue) \
269     macro(debugger) \
270     macro(default) \
271     macro(delete) \
272     macro(do) \
273     macro(else) \
274     macro(enum) \
275     macro(export) \
276     macro(extends) \
277     macro(false) \
278     macro(finally) \
279     macro(for) \
280     macro(function) \
281     macro(if) \
282     macro(implements) \
283     macro(import) \
284     macro(in) \
285     macro(instanceof) \
286     macro(interface) \
287     macro(let) \
288     macro(new) \
289     macro(null) \
290     macro(package) \
291     macro(private) \
292     macro(protected) \
293     macro(public) \
294     macro(return) \
295     macro(static) \
296     macro(super) \
297     macro(switch) \
298     macro(this) \
299     macro(throw) \
300     macro(true) \
301     macro(try) \
302     macro(typeof) \
303     macro(undefined) \
304     macro(var) \
305     macro(void) \
306     macro(while) \
307     macro(with) \
308     macro(yield)
309
310 #define JSC_COMMON_PRIVATE_IDENTIFIERS_EACH_WELL_KNOWN_SYMBOL_NOT_IMPLEMENTED_YET(macro)\
311     macro(replace) \
312
313 #define JSC_COMMON_PRIVATE_IDENTIFIERS_EACH_WELL_KNOWN_SYMBOL(macro) \
314     macro(hasInstance) \
315     macro(isConcatSpreadable) \
316     macro(iterator) \
317     macro(match) \
318     macro(search) \
319     macro(species) \
320     macro(split) \
321     macro(toPrimitive) \
322     macro(toStringTag) \
323     macro(unscopables)
324
325 #define JSC_COMMON_PRIVATE_IDENTIFIERS_EACH_PROPERTY_NAME(macro) \
326     JSC_COMMON_BYTECODE_INTRINSIC_FUNCTIONS_EACH_NAME(macro) \
327     JSC_COMMON_BYTECODE_INTRINSIC_CONSTANTS_EACH_NAME(macro) \
328     macro(iteratedObject) \
329     macro(arrayIteratorNextIndex) \
330     macro(arrayIterationKind) \
331     macro(charCodeAt) \
332     macro(iteratedString) \
333     macro(stringIteratorNextIndex) \
334     macro(promise) \
335     macro(fulfillmentHandler) \
336     macro(rejectionHandler) \
337     macro(index) \
338     macro(values) \
339     macro(deferred) \
340     macro(countdownHolder) \
341     macro(Object) \
342     macro(ownEnumerablePropertyKeys) \
343     macro(Number) \
344     macro(Array) \
345     macro(String) \
346     macro(RegExp) \
347     macro(Map) \
348     macro(Promise) \
349     macro(Reflect) \
350     macro(InternalPromise) \
351     macro(abs) \
352     macro(floor) \
353     macro(trunc) \
354     macro(isFinite) \
355     macro(isNaN) \
356     macro(create) \
357     macro(defineProperty) \
358     macro(getPrototypeOf) \
359     macro(getOwnPropertyDescriptor) \
360     macro(getOwnPropertyNames) \
361     macro(ownKeys) \
362     macro(Error) \
363     macro(RangeError) \
364     macro(TypeError) \
365     macro(typedArrayLength) \
366     macro(typedArraySort) \
367     macro(typedArrayGetOriginalConstructor) \
368     macro(BuiltinLog) \
369     macro(homeObject) \
370     macro(getTemplateObject) \
371     macro(enqueueJob) \
372     macro(handler) \
373     macro(promiseState) \
374     macro(promiseFulfillReactions) \
375     macro(promiseRejectReactions) \
376     macro(promiseResult) \
377     macro(push) \
378     macro(repeatCharacter) \
379     macro(capabilities) \
380     macro(starDefault) \
381     macro(InspectorInstrumentation) \
382     macro(get) \
383     macro(set) \
384     macro(shift) \
385     macro(allocateTypedArray) \
386     macro(Int8Array) \
387     macro(Int16Array) \
388     macro(Int32Array) \
389     macro(Uint8Array) \
390     macro(Uint8ClampedArray) \
391     macro(Uint16Array) \
392     macro(Uint32Array) \
393     macro(Float32Array) \
394     macro(Float64Array) \
395     macro(exec) \
396     macro(generator) \
397     macro(generatorNext) \
398     macro(generatorState) \
399     macro(generatorFrame) \
400     macro(generatorValue) \
401     macro(generatorThis) \
402     macro(generatorResumeMode) \
403     macro(Collator) \
404     macro(DateTimeFormat) \
405     macro(NumberFormat) \
406     macro(intlSubstituteValue) \
407     macro(thisTimeValue) \
408     macro(newTargetLocal) \
409     macro(derivedConstructor) \
410     macro(isBoundFunction) \
411     macro(hasInstanceBoundFunction) \
412     macro(instanceOf) \
413     macro(isArray) \
414     macro(isJSArray) \
415     macro(isArrayConstructor) \
416     macro(isConstructor) \
417     macro(isRegExpObject) \
418     macro(concatMemcpy) \
419     macro(appendMemcpy) \
420     macro(predictFinalLengthFromArgumunts) \
421     macro(print) \
422     macro(isSet) \
423     macro(isMap) \
424     macro(regExpCreate) \
425     macro(SetIterator) \
426     macro(setIteratorNext) \
427     macro(MapIterator) \
428     macro(mapIteratorNext) \
429     macro(regExpProtoFlagsGetter) \
430     macro(regExpProtoGlobalGetter) \
431     macro(regExpProtoIgnoreCaseGetter) \
432     macro(regExpProtoMultilineGetter) \
433     macro(regExpProtoSourceGetter) \
434     macro(regExpProtoStickyGetter) \
435     macro(regExpProtoUnicodeGetter) \
436     macro(regExpSearchFast) \
437     macro(regExpSplitFast) \
438     macro(stringIncludesInternal) \
439     macro(stringSplitFast) \
440     macro(stringSubstrInternal) \
441
442 namespace JSC {
443     
444     class BuiltinNames;
445     
446     class CommonIdentifiers {
447         WTF_MAKE_NONCOPYABLE(CommonIdentifiers); WTF_MAKE_FAST_ALLOCATED;
448     private:
449         CommonIdentifiers(VM*);
450         ~CommonIdentifiers();
451         friend class VM;
452         
453     public:
454         const BuiltinNames& builtinNames() const { return *m_builtinNames; }
455         const Identifier nullIdentifier;
456         const Identifier emptyIdentifier;
457         const Identifier underscoreProto;
458         const Identifier thisIdentifier;
459         const Identifier useStrictIdentifier;
460         const Identifier timesIdentifier;
461     private:
462         std::unique_ptr<BuiltinNames> m_builtinNames;
463
464     public:
465         
466 #define JSC_IDENTIFIER_DECLARE_KEYWORD_NAME_GLOBAL(name) const Identifier name##Keyword;
467         JSC_COMMON_IDENTIFIERS_EACH_KEYWORD(JSC_IDENTIFIER_DECLARE_KEYWORD_NAME_GLOBAL)
468 #undef JSC_IDENTIFIER_DECLARE_KEYWORD_NAME_GLOBAL
469         
470 #define JSC_IDENTIFIER_DECLARE_PROPERTY_NAME_GLOBAL(name) const Identifier name;
471         JSC_COMMON_IDENTIFIERS_EACH_PROPERTY_NAME(JSC_IDENTIFIER_DECLARE_PROPERTY_NAME_GLOBAL)
472 #undef JSC_IDENTIFIER_DECLARE_PROPERTY_NAME_GLOBAL
473
474 #define JSC_IDENTIFIER_DECLARE_PRIVATE_PROPERTY_NAME_GLOBAL(name) const Identifier name##PrivateName;
475         JSC_COMMON_PRIVATE_IDENTIFIERS_EACH_PROPERTY_NAME(JSC_IDENTIFIER_DECLARE_PRIVATE_PROPERTY_NAME_GLOBAL)
476 #undef JSC_IDENTIFIER_DECLARE_PRIVATE_PROPERTY_NAME_GLOBAL
477
478 #define JSC_IDENTIFIER_DECLARE_PRIVATE_WELL_KNOWN_SYMBOL_GLOBAL(name) const Identifier name##Symbol;
479         JSC_COMMON_PRIVATE_IDENTIFIERS_EACH_WELL_KNOWN_SYMBOL(JSC_IDENTIFIER_DECLARE_PRIVATE_WELL_KNOWN_SYMBOL_GLOBAL)
480 #undef JSC_IDENTIFIER_DECLARE_PRIVATE_WELL_KNOWN_SYMBOL_GLOBAL
481
482         bool isPrivateName(SymbolImpl& uid) const;
483         bool isPrivateName(UniquedStringImpl& uid) const;
484         bool isPrivateName(const Identifier&) const;
485
486         const Identifier* lookUpPrivateName(const Identifier&) const;
487         Identifier lookUpPublicName(const Identifier&) const;
488
489         // Callers of this method should make sure that identifiers given to this method 
490         // survive the lifetime of CommonIdentifiers and related VM.
491         JS_EXPORT_PRIVATE void appendExternalName(const Identifier& publicName, const Identifier& privateName);
492     };
493
494 } // namespace JSC
495
496 #endif // CommonIdentifiers_h