1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
2  * vim: set ts=8 sts=2 et sw=2 tw=80:
3  * This Source Code Form is subject to the terms of the Mozilla Public
4  * License, v. 2.0. If a copy of the MPL was not distributed with this
5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
6 
7 #ifndef vm_WellKnownAtom_h
8 #define vm_WellKnownAtom_h
9 
10 #include "mozilla/HashFunctions.h"  // mozilla::HashNumber, mozilla::HashStringKnownLength
11 
12 #include <stdint.h>  // uint32_t
13 
14 #include "js/ProtoKey.h"             // JS_FOR_EACH_PROTOTYPE
15 #include "js/Symbol.h"               // JS_FOR_EACH_WELL_KNOWN_SYMBOL
16 #include "vm/CommonPropertyNames.h"  // FOR_EACH_COMMON_PROPERTYNAME
17 
18 /* Well-known predefined C strings. */
19 #define DECLARE_CONST_CHAR_STR(IDPART, _, TEXT) extern char js_##IDPART##_str[];
20 FOR_EACH_COMMON_PROPERTYNAME(DECLARE_CONST_CHAR_STR)
21 #undef DECLARE_CONST_CHAR_STR
22 
23 #define DECLARE_CONST_CHAR_STR(NAME, _) extern char js_##NAME##_str[];
JS_FOR_EACH_PROTOTYPE(DECLARE_CONST_CHAR_STR)24 JS_FOR_EACH_PROTOTYPE(DECLARE_CONST_CHAR_STR)
25 #undef DECLARE_CONST_CHAR_STR
26 
27 #define DECLARE_CONST_CHAR_STR(NAME) extern char js_##NAME##_str[];
28 JS_FOR_EACH_WELL_KNOWN_SYMBOL(DECLARE_CONST_CHAR_STR)
29 #undef DECLARE_CONST_CHAR_STR
30 
31 namespace js {
32 
33 // An index for well-known atoms.
34 //
35 // GetWellKnownAtom in ParserAtom.cpp relies on the fact that
36 // JSAtomState fields and this enum variants use the same order.
37 enum class WellKnownAtomId : uint32_t {
38 #define ENUM_ENTRY_(_, NAME, _2) NAME,
39   FOR_EACH_COMMON_PROPERTYNAME(ENUM_ENTRY_)
40 #undef ENUM_ENTRY_
41 
42 #define ENUM_ENTRY_(NAME, _) NAME,
43       JS_FOR_EACH_PROTOTYPE(ENUM_ENTRY_)
44 #undef ENUM_ENTRY_
45 
46 #define ENUM_ENTRY_(NAME) NAME,
47           JS_FOR_EACH_WELL_KNOWN_SYMBOL(ENUM_ENTRY_)
48 #undef ENUM_ENTRY_
49 
50               Limit,
51 };
52 
53 struct WellKnownAtomInfo {
54   uint32_t length;
55   mozilla::HashNumber hash;
56   const char* content;
57 };
58 
59 extern WellKnownAtomInfo wellKnownAtomInfos[];
60 
61 inline const WellKnownAtomInfo& GetWellKnownAtomInfo(WellKnownAtomId atomId) {
62   return wellKnownAtomInfos[uint32_t(atomId)];
63 }
64 
65 } /* namespace js */
66 
67 #endif  // vm_WellKnownAtom_h
68