es.symbol.js 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325
  1. 'use strict';
  2. var $ = require('../internals/export');
  3. var global = require('../internals/global');
  4. var getBuiltIn = require('../internals/get-built-in');
  5. var apply = require('../internals/function-apply');
  6. var call = require('../internals/function-call');
  7. var uncurryThis = require('../internals/function-uncurry-this');
  8. var IS_PURE = require('../internals/is-pure');
  9. var DESCRIPTORS = require('../internals/descriptors');
  10. var NATIVE_SYMBOL = require('../internals/native-symbol');
  11. var fails = require('../internals/fails');
  12. var hasOwn = require('../internals/has-own-property');
  13. var isArray = require('../internals/is-array');
  14. var isCallable = require('../internals/is-callable');
  15. var isObject = require('../internals/is-object');
  16. var isPrototypeOf = require('../internals/object-is-prototype-of');
  17. var isSymbol = require('../internals/is-symbol');
  18. var anObject = require('../internals/an-object');
  19. var toObject = require('../internals/to-object');
  20. var toIndexedObject = require('../internals/to-indexed-object');
  21. var toPropertyKey = require('../internals/to-property-key');
  22. var $toString = require('../internals/to-string');
  23. var createPropertyDescriptor = require('../internals/create-property-descriptor');
  24. var nativeObjectCreate = require('../internals/object-create');
  25. var objectKeys = require('../internals/object-keys');
  26. var getOwnPropertyNamesModule = require('../internals/object-get-own-property-names');
  27. var getOwnPropertyNamesExternal = require('../internals/object-get-own-property-names-external');
  28. var getOwnPropertySymbolsModule = require('../internals/object-get-own-property-symbols');
  29. var getOwnPropertyDescriptorModule = require('../internals/object-get-own-property-descriptor');
  30. var definePropertyModule = require('../internals/object-define-property');
  31. var definePropertiesModule = require('../internals/object-define-properties');
  32. var propertyIsEnumerableModule = require('../internals/object-property-is-enumerable');
  33. var arraySlice = require('../internals/array-slice');
  34. var redefine = require('../internals/redefine');
  35. var shared = require('../internals/shared');
  36. var sharedKey = require('../internals/shared-key');
  37. var hiddenKeys = require('../internals/hidden-keys');
  38. var uid = require('../internals/uid');
  39. var wellKnownSymbol = require('../internals/well-known-symbol');
  40. var wrappedWellKnownSymbolModule = require('../internals/well-known-symbol-wrapped');
  41. var defineWellKnownSymbol = require('../internals/define-well-known-symbol');
  42. var setToStringTag = require('../internals/set-to-string-tag');
  43. var InternalStateModule = require('../internals/internal-state');
  44. var $forEach = require('../internals/array-iteration').forEach;
  45. var HIDDEN = sharedKey('hidden');
  46. var SYMBOL = 'Symbol';
  47. var PROTOTYPE = 'prototype';
  48. var TO_PRIMITIVE = wellKnownSymbol('toPrimitive');
  49. var setInternalState = InternalStateModule.set;
  50. var getInternalState = InternalStateModule.getterFor(SYMBOL);
  51. var ObjectPrototype = Object[PROTOTYPE];
  52. var $Symbol = global.Symbol;
  53. var SymbolPrototype = $Symbol && $Symbol[PROTOTYPE];
  54. var TypeError = global.TypeError;
  55. var QObject = global.QObject;
  56. var $stringify = getBuiltIn('JSON', 'stringify');
  57. var nativeGetOwnPropertyDescriptor = getOwnPropertyDescriptorModule.f;
  58. var nativeDefineProperty = definePropertyModule.f;
  59. var nativeGetOwnPropertyNames = getOwnPropertyNamesExternal.f;
  60. var nativePropertyIsEnumerable = propertyIsEnumerableModule.f;
  61. var push = uncurryThis([].push);
  62. var AllSymbols = shared('symbols');
  63. var ObjectPrototypeSymbols = shared('op-symbols');
  64. var StringToSymbolRegistry = shared('string-to-symbol-registry');
  65. var SymbolToStringRegistry = shared('symbol-to-string-registry');
  66. var WellKnownSymbolsStore = shared('wks');
  67. // Don't use setters in Qt Script, https://github.com/zloirock/core-js/issues/173
  68. var USE_SETTER = !QObject || !QObject[PROTOTYPE] || !QObject[PROTOTYPE].findChild;
  69. // fallback for old Android, https://code.google.com/p/v8/issues/detail?id=687
  70. var setSymbolDescriptor = DESCRIPTORS && fails(function () {
  71. return nativeObjectCreate(nativeDefineProperty({}, 'a', {
  72. get: function () { return nativeDefineProperty(this, 'a', { value: 7 }).a; }
  73. })).a != 7;
  74. }) ? function (O, P, Attributes) {
  75. var ObjectPrototypeDescriptor = nativeGetOwnPropertyDescriptor(ObjectPrototype, P);
  76. if (ObjectPrototypeDescriptor) delete ObjectPrototype[P];
  77. nativeDefineProperty(O, P, Attributes);
  78. if (ObjectPrototypeDescriptor && O !== ObjectPrototype) {
  79. nativeDefineProperty(ObjectPrototype, P, ObjectPrototypeDescriptor);
  80. }
  81. } : nativeDefineProperty;
  82. var wrap = function (tag, description) {
  83. var symbol = AllSymbols[tag] = nativeObjectCreate(SymbolPrototype);
  84. setInternalState(symbol, {
  85. type: SYMBOL,
  86. tag: tag,
  87. description: description
  88. });
  89. if (!DESCRIPTORS) symbol.description = description;
  90. return symbol;
  91. };
  92. var $defineProperty = function defineProperty(O, P, Attributes) {
  93. if (O === ObjectPrototype) $defineProperty(ObjectPrototypeSymbols, P, Attributes);
  94. anObject(O);
  95. var key = toPropertyKey(P);
  96. anObject(Attributes);
  97. if (hasOwn(AllSymbols, key)) {
  98. if (!Attributes.enumerable) {
  99. if (!hasOwn(O, HIDDEN)) nativeDefineProperty(O, HIDDEN, createPropertyDescriptor(1, {}));
  100. O[HIDDEN][key] = true;
  101. } else {
  102. if (hasOwn(O, HIDDEN) && O[HIDDEN][key]) O[HIDDEN][key] = false;
  103. Attributes = nativeObjectCreate(Attributes, { enumerable: createPropertyDescriptor(0, false) });
  104. } return setSymbolDescriptor(O, key, Attributes);
  105. } return nativeDefineProperty(O, key, Attributes);
  106. };
  107. var $defineProperties = function defineProperties(O, Properties) {
  108. anObject(O);
  109. var properties = toIndexedObject(Properties);
  110. var keys = objectKeys(properties).concat($getOwnPropertySymbols(properties));
  111. $forEach(keys, function (key) {
  112. if (!DESCRIPTORS || call($propertyIsEnumerable, properties, key)) $defineProperty(O, key, properties[key]);
  113. });
  114. return O;
  115. };
  116. var $create = function create(O, Properties) {
  117. return Properties === undefined ? nativeObjectCreate(O) : $defineProperties(nativeObjectCreate(O), Properties);
  118. };
  119. var $propertyIsEnumerable = function propertyIsEnumerable(V) {
  120. var P = toPropertyKey(V);
  121. var enumerable = call(nativePropertyIsEnumerable, this, P);
  122. if (this === ObjectPrototype && hasOwn(AllSymbols, P) && !hasOwn(ObjectPrototypeSymbols, P)) return false;
  123. return enumerable || !hasOwn(this, P) || !hasOwn(AllSymbols, P) || hasOwn(this, HIDDEN) && this[HIDDEN][P]
  124. ? enumerable : true;
  125. };
  126. var $getOwnPropertyDescriptor = function getOwnPropertyDescriptor(O, P) {
  127. var it = toIndexedObject(O);
  128. var key = toPropertyKey(P);
  129. if (it === ObjectPrototype && hasOwn(AllSymbols, key) && !hasOwn(ObjectPrototypeSymbols, key)) return;
  130. var descriptor = nativeGetOwnPropertyDescriptor(it, key);
  131. if (descriptor && hasOwn(AllSymbols, key) && !(hasOwn(it, HIDDEN) && it[HIDDEN][key])) {
  132. descriptor.enumerable = true;
  133. }
  134. return descriptor;
  135. };
  136. var $getOwnPropertyNames = function getOwnPropertyNames(O) {
  137. var names = nativeGetOwnPropertyNames(toIndexedObject(O));
  138. var result = [];
  139. $forEach(names, function (key) {
  140. if (!hasOwn(AllSymbols, key) && !hasOwn(hiddenKeys, key)) push(result, key);
  141. });
  142. return result;
  143. };
  144. var $getOwnPropertySymbols = function getOwnPropertySymbols(O) {
  145. var IS_OBJECT_PROTOTYPE = O === ObjectPrototype;
  146. var names = nativeGetOwnPropertyNames(IS_OBJECT_PROTOTYPE ? ObjectPrototypeSymbols : toIndexedObject(O));
  147. var result = [];
  148. $forEach(names, function (key) {
  149. if (hasOwn(AllSymbols, key) && (!IS_OBJECT_PROTOTYPE || hasOwn(ObjectPrototype, key))) {
  150. push(result, AllSymbols[key]);
  151. }
  152. });
  153. return result;
  154. };
  155. // `Symbol` constructor
  156. // https://tc39.es/ecma262/#sec-symbol-constructor
  157. if (!NATIVE_SYMBOL) {
  158. $Symbol = function Symbol() {
  159. if (isPrototypeOf(SymbolPrototype, this)) throw TypeError('Symbol is not a constructor');
  160. var description = !arguments.length || arguments[0] === undefined ? undefined : $toString(arguments[0]);
  161. var tag = uid(description);
  162. var setter = function (value) {
  163. if (this === ObjectPrototype) call(setter, ObjectPrototypeSymbols, value);
  164. if (hasOwn(this, HIDDEN) && hasOwn(this[HIDDEN], tag)) this[HIDDEN][tag] = false;
  165. setSymbolDescriptor(this, tag, createPropertyDescriptor(1, value));
  166. };
  167. if (DESCRIPTORS && USE_SETTER) setSymbolDescriptor(ObjectPrototype, tag, { configurable: true, set: setter });
  168. return wrap(tag, description);
  169. };
  170. SymbolPrototype = $Symbol[PROTOTYPE];
  171. redefine(SymbolPrototype, 'toString', function toString() {
  172. return getInternalState(this).tag;
  173. });
  174. redefine($Symbol, 'withoutSetter', function (description) {
  175. return wrap(uid(description), description);
  176. });
  177. propertyIsEnumerableModule.f = $propertyIsEnumerable;
  178. definePropertyModule.f = $defineProperty;
  179. definePropertiesModule.f = $defineProperties;
  180. getOwnPropertyDescriptorModule.f = $getOwnPropertyDescriptor;
  181. getOwnPropertyNamesModule.f = getOwnPropertyNamesExternal.f = $getOwnPropertyNames;
  182. getOwnPropertySymbolsModule.f = $getOwnPropertySymbols;
  183. wrappedWellKnownSymbolModule.f = function (name) {
  184. return wrap(wellKnownSymbol(name), name);
  185. };
  186. if (DESCRIPTORS) {
  187. // https://github.com/tc39/proposal-Symbol-description
  188. nativeDefineProperty(SymbolPrototype, 'description', {
  189. configurable: true,
  190. get: function description() {
  191. return getInternalState(this).description;
  192. }
  193. });
  194. if (!IS_PURE) {
  195. redefine(ObjectPrototype, 'propertyIsEnumerable', $propertyIsEnumerable, { unsafe: true });
  196. }
  197. }
  198. }
  199. $({ global: true, wrap: true, forced: !NATIVE_SYMBOL, sham: !NATIVE_SYMBOL }, {
  200. Symbol: $Symbol
  201. });
  202. $forEach(objectKeys(WellKnownSymbolsStore), function (name) {
  203. defineWellKnownSymbol(name);
  204. });
  205. $({ target: SYMBOL, stat: true, forced: !NATIVE_SYMBOL }, {
  206. // `Symbol.for` method
  207. // https://tc39.es/ecma262/#sec-symbol.for
  208. 'for': function (key) {
  209. var string = $toString(key);
  210. if (hasOwn(StringToSymbolRegistry, string)) return StringToSymbolRegistry[string];
  211. var symbol = $Symbol(string);
  212. StringToSymbolRegistry[string] = symbol;
  213. SymbolToStringRegistry[symbol] = string;
  214. return symbol;
  215. },
  216. // `Symbol.keyFor` method
  217. // https://tc39.es/ecma262/#sec-symbol.keyfor
  218. keyFor: function keyFor(sym) {
  219. if (!isSymbol(sym)) throw TypeError(sym + ' is not a symbol');
  220. if (hasOwn(SymbolToStringRegistry, sym)) return SymbolToStringRegistry[sym];
  221. },
  222. useSetter: function () { USE_SETTER = true; },
  223. useSimple: function () { USE_SETTER = false; }
  224. });
  225. $({ target: 'Object', stat: true, forced: !NATIVE_SYMBOL, sham: !DESCRIPTORS }, {
  226. // `Object.create` method
  227. // https://tc39.es/ecma262/#sec-object.create
  228. create: $create,
  229. // `Object.defineProperty` method
  230. // https://tc39.es/ecma262/#sec-object.defineproperty
  231. defineProperty: $defineProperty,
  232. // `Object.defineProperties` method
  233. // https://tc39.es/ecma262/#sec-object.defineproperties
  234. defineProperties: $defineProperties,
  235. // `Object.getOwnPropertyDescriptor` method
  236. // https://tc39.es/ecma262/#sec-object.getownpropertydescriptors
  237. getOwnPropertyDescriptor: $getOwnPropertyDescriptor
  238. });
  239. $({ target: 'Object', stat: true, forced: !NATIVE_SYMBOL }, {
  240. // `Object.getOwnPropertyNames` method
  241. // https://tc39.es/ecma262/#sec-object.getownpropertynames
  242. getOwnPropertyNames: $getOwnPropertyNames,
  243. // `Object.getOwnPropertySymbols` method
  244. // https://tc39.es/ecma262/#sec-object.getownpropertysymbols
  245. getOwnPropertySymbols: $getOwnPropertySymbols
  246. });
  247. // Chrome 38 and 39 `Object.getOwnPropertySymbols` fails on primitives
  248. // https://bugs.chromium.org/p/v8/issues/detail?id=3443
  249. $({ target: 'Object', stat: true, forced: fails(function () { getOwnPropertySymbolsModule.f(1); }) }, {
  250. getOwnPropertySymbols: function getOwnPropertySymbols(it) {
  251. return getOwnPropertySymbolsModule.f(toObject(it));
  252. }
  253. });
  254. // `JSON.stringify` method behavior with symbols
  255. // https://tc39.es/ecma262/#sec-json.stringify
  256. if ($stringify) {
  257. var FORCED_JSON_STRINGIFY = !NATIVE_SYMBOL || fails(function () {
  258. var symbol = $Symbol();
  259. // MS Edge converts symbol values to JSON as {}
  260. return $stringify([symbol]) != '[null]'
  261. // WebKit converts symbol values to JSON as null
  262. || $stringify({ a: symbol }) != '{}'
  263. // V8 throws on boxed symbols
  264. || $stringify(Object(symbol)) != '{}';
  265. });
  266. $({ target: 'JSON', stat: true, forced: FORCED_JSON_STRINGIFY }, {
  267. // eslint-disable-next-line no-unused-vars -- required for `.length`
  268. stringify: function stringify(it, replacer, space) {
  269. var args = arraySlice(arguments);
  270. var $replacer = replacer;
  271. if (!isObject(replacer) && it === undefined || isSymbol(it)) return; // IE8 returns string on undefined
  272. if (!isArray(replacer)) replacer = function (key, value) {
  273. if (isCallable($replacer)) value = call($replacer, this, key, value);
  274. if (!isSymbol(value)) return value;
  275. };
  276. args[1] = replacer;
  277. return apply($stringify, null, args);
  278. }
  279. });
  280. }
  281. // `Symbol.prototype[@@toPrimitive]` method
  282. // https://tc39.es/ecma262/#sec-symbol.prototype-@@toprimitive
  283. if (!SymbolPrototype[TO_PRIMITIVE]) {
  284. var valueOf = SymbolPrototype.valueOf;
  285. // eslint-disable-next-line no-unused-vars -- required for .length
  286. redefine(SymbolPrototype, TO_PRIMITIVE, function (hint) {
  287. // TODO: improve hint logic
  288. return call(valueOf, this);
  289. });
  290. }
  291. // `Symbol.prototype[@@toStringTag]` property
  292. // https://tc39.es/ecma262/#sec-symbol.prototype-@@tostringtag
  293. setToStringTag($Symbol, SYMBOL);
  294. hiddenKeys[HIDDEN] = true;