js/src/jsapi-tests/testSymbol.cpp
author Bogdan Szekely <bszekely@mozilla.com>
Tue, 28 Jun 2022 12:15:14 +0300
changeset 622283 3a227a2156b9e38e50c2205803c429e698f16de9
parent 448947 6f3709b3878117466168c40affa7bca0b60cf75b
permissions -rw-r--r--
Merge autoland to mozilla-central. a=merge

/* 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/. */

#include "js/Symbol.h"
#include "jsapi-tests/tests.h"

BEGIN_TEST(testSymbol_New) {
  using namespace JS;

  RootedString desc(cx, nullptr);
  RootedSymbol sym1(cx);
  CHECK(sym1 = NewSymbol(cx, desc));
  CHECK_NULL(GetSymbolDescription(sym1));
  RootedValue v(cx, SymbolValue(sym1));
  CHECK_EQUAL(JS_TypeOfValue(cx, v), JSTYPE_SYMBOL);

  RootedSymbol sym2(cx);
  CHECK(sym2 = NewSymbol(cx, desc));
  CHECK(sym1 != sym2);

  CHECK(desc = JS_NewStringCopyZ(cx, "ponies"));
  CHECK(sym2 = NewSymbol(cx, desc));
  CHECK_SAME(StringValue(GetSymbolDescription(sym2)), StringValue(desc));

  return true;
}
END_TEST(testSymbol_New)

BEGIN_TEST(testSymbol_GetSymbolFor) {
  using namespace JS;

  RootedString desc(cx, JS_NewStringCopyZ(cx, "ponies"));
  CHECK(desc);
  RootedSymbol sym1(cx);
  CHECK(sym1 = GetSymbolFor(cx, desc));
  CHECK_SAME(StringValue(GetSymbolDescription(sym1)), StringValue(desc));

  // Calling JS::GetSymbolFor again with the same arguments produces the
  // same Symbol.
  RootedSymbol sym2(cx);
  CHECK(sym2 = GetSymbolFor(cx, desc));
  CHECK_EQUAL(sym1, sym2);

  // Passing a new but equal string also produces the same Symbol.
  CHECK(desc = JS_NewStringCopyZ(cx, "ponies"));
  CHECK(sym2 = GetSymbolFor(cx, desc));
  CHECK_EQUAL(sym1, sym2);

  // But SymbolNew always produces a new distinct Symbol.
  CHECK(sym2 = NewSymbol(cx, desc));
  CHECK(sym2 != sym1);

  return true;
}
END_TEST(testSymbol_GetSymbolFor)

BEGIN_TEST(testSymbol_GetWellKnownSymbol) {
  using namespace JS;

  Rooted<Symbol*> sym1(cx);
  CHECK(sym1 = GetWellKnownSymbol(cx, SymbolCode::iterator));
  RootedValue v(cx);
  EVAL("Symbol.iterator", &v);
  CHECK_SAME(v, SymbolValue(sym1));

  // The description of a well-known symbol is as specified.
  RootedString desc(cx);
  CHECK(desc = JS_NewStringCopyZ(cx, "Symbol.iterator"));
  CHECK_SAME(StringValue(GetSymbolDescription(sym1)), StringValue(desc));

  // GetSymbolFor never returns a well-known symbol.
  Rooted<Symbol*> sym2(cx);
  CHECK(sym2 = GetSymbolFor(cx, desc));
  CHECK(sym2 != sym1);

  return true;
}
END_TEST(testSymbol_GetWellKnownSymbol)