js/src/jsprototypes.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  * vim: set ts=8 sts=4 et sw=4 tw=99:
   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 jsprototypes_h
   8 #define jsprototypes_h
   9
  10 /* A higher-order macro for enumerating all JSProtoKey values. */
  11 /*
  12  * Consumers define macros as follows:
  13  * macro(name, code, init, clasp)
  14  *   name:    The canonical name of the class.
  15  *   code:    The enumerator code. There are part of the XDR API, and must not change.
  16  *   init:    Initialization function. These are |extern "C";|, and clients should use
  17  *            |extern "C" {}| as appropriate when using this macro.
  18  *   clasp:   The JSClass for this object, or "dummy" if it doesn't exist.
  19  *
  20  *
  21  * Consumers wishing to iterate over all the JSProtoKey values, can use
  22  * JS_FOR_EACH_PROTOTYPE. However, there are certain values that don't correspond
  23  * to real constructors, like Null or constructors that are disabled via
  24  * preprocessor directives. We still need to include these in the JSProtoKey list
  25  * in order to maintain binary XDR compatibility, but we need to provide a tool
  26  * to handle them differently. JS_FOR_PROTOTYPES fills this niche.
  27  *
  28  * Consumers pass two macros to JS_FOR_PROTOTYPES - |real| and |imaginary|. The
  29  * former is invoked for entries that have real client-exposed constructors, and
  30  * the latter is called for the rest. Consumers that don't care about this
  31  * distinction can simply pass the same macro to both, which is exactly what
  32  * JS_FOR_EACH_PROTOTYPE does.
  33  */
  34
  35 #define CLASP(name)                 (&name##Class)
  36 #define OCLASP(name)                (&name##Object::class_)
  37 #define TYPED_ARRAY_CLASP(type)     (&TypedArrayObject::classes[Scalar::type])
  38 #define ERROR_CLASP(type)           (&ErrorObject::classes[type])
  39 #define SHARED_TYPED_ARRAY_CLASP(type) (&SharedTypedArrayObject::classes[Scalar::type])
  40
  41 #ifdef ENABLE_PARALLEL_JS
  42 #define IF_PJS(real,imaginary) real
  43 #else
  44 #define IF_PJS(real,imaginary) imaginary
  45 #endif
  46
  47 #ifdef EXPOSE_INTL_API
  48 #define IF_INTL(real,imaginary) real
  49 #else
  50 #define IF_INTL(real,imaginary) imaginary
  51 #endif
  52
  53 #ifdef ENABLE_BINARYDATA
  54 #define IF_BDATA(real,imaginary) real
  55 #else
  56 #define IF_BDATA(real,imaginary) imaginary
  57 #endif
  58
  59 #ifdef ENABLE_SHARED_ARRAY_BUFFER
  60 #define IF_SAB(real,imaginary) real
  61 #else
  62 #define IF_SAB(real,imaginary) imaginary
  63 #endif
  64
  65 #ifdef JS_HAS_SYMBOLS
  66 #define IF_SYMBOLS(real,imaginary) real
  67 #else
  68 #define IF_SYMBOLS(real,imaginary) imaginary
  69 #endif
  70
  71 #define JS_FOR_PROTOTYPES(real,imaginary) \
  72     imaginary(Null,              0,     js_InitNullClass,          dummy) \
  73     real(Object,                 1,     js_InitViaClassSpec,       OCLASP(Plain)) \
  74     real(Function,               2,     js_InitViaClassSpec,       &JSFunction::class_) \
  75     real(Array,                  3,     js_InitViaClassSpec,       OCLASP(Array)) \
  76     real(Boolean,                4,     js_InitBooleanClass,       OCLASP(Boolean)) \
  77     real(JSON,                   5,     js_InitJSONClass,          CLASP(JSON)) \
  78     real(Date,                   6,     js_InitViaClassSpec,       OCLASP(Date)) \
  79     real(Math,                   7,     js_InitMathClass,          CLASP(Math)) \
  80     real(Number,                 8,     js_InitNumberClass,        OCLASP(Number)) \
  81     real(String,                 9,     js_InitStringClass,        OCLASP(String)) \
  82     real(RegExp,                10,     js_InitRegExpClass,        OCLASP(RegExp)) \
  83     real(Error,                 11,     js_InitViaClassSpec,       ERROR_CLASP(JSEXN_ERR)) \
  84     real(InternalError,         12,     js_InitViaClassSpec,       ERROR_CLASP(JSEXN_INTERNALERR)) \
  85     real(EvalError,             13,     js_InitViaClassSpec,       ERROR_CLASP(JSEXN_EVALERR)) \
  86     real(RangeError,            14,     js_InitViaClassSpec,       ERROR_CLASP(JSEXN_RANGEERR)) \
  87     real(ReferenceError,        15,     js_InitViaClassSpec,       ERROR_CLASP(JSEXN_REFERENCEERR)) \
  88     real(SyntaxError,           16,     js_InitViaClassSpec,       ERROR_CLASP(JSEXN_SYNTAXERR)) \
  89     real(TypeError,             17,     js_InitViaClassSpec,       ERROR_CLASP(JSEXN_TYPEERR)) \
  90     real(URIError,              18,     js_InitViaClassSpec,       ERROR_CLASP(JSEXN_URIERR)) \
  91     real(Iterator,              19,     js_InitIteratorClasses,    OCLASP(PropertyIterator)) \
  92     real(StopIteration,         20,     js_InitIteratorClasses,    OCLASP(StopIteration)) \
  93     real(ArrayBuffer,           21,     js_InitArrayBufferClass,   &js::ArrayBufferObject::protoClass) \
  94     real(Int8Array,             22,     js_InitViaClassSpec,       TYPED_ARRAY_CLASP(Int8)) \
  95     real(Uint8Array,            23,     js_InitViaClassSpec,       TYPED_ARRAY_CLASP(Uint8)) \
  96     real(Int16Array,            24,     js_InitViaClassSpec,       TYPED_ARRAY_CLASP(Int16)) \
  97     real(Uint16Array,           25,     js_InitViaClassSpec,       TYPED_ARRAY_CLASP(Uint16)) \
  98     real(Int32Array,            26,     js_InitViaClassSpec,       TYPED_ARRAY_CLASP(Int32)) \
  99     real(Uint32Array,           27,     js_InitViaClassSpec,       TYPED_ARRAY_CLASP(Uint32)) \
 100     real(Float32Array,          28,     js_InitViaClassSpec,       TYPED_ARRAY_CLASP(Float32)) \
 101     real(Float64Array,          29,     js_InitViaClassSpec,       TYPED_ARRAY_CLASP(Float64)) \
 102     real(Uint8ClampedArray,     30,     js_InitViaClassSpec,       TYPED_ARRAY_CLASP(Uint8Clamped)) \
 103     real(Proxy,                 31,     js_InitProxyClass,         OCLASP(Proxy)) \
 104     real(WeakMap,               32,     js_InitWeakMapClass,       OCLASP(WeakMap)) \
 105     real(Map,                   33,     js_InitMapClass,           OCLASP(Map)) \
 106     real(Set,                   34,     js_InitSetClass,           OCLASP(Set)) \
 107     real(DataView,              35,     js_InitDataViewClass,      OCLASP(DataView)) \
 108 IF_SYMBOLS(real,imaginary)(Symbol,              36,     js_InitSymbolClass,        &js::SymbolObject::class_) \
 109 IF_SAB(real,imaginary)(SharedArrayBuffer,       37,     js_InitSharedArrayBufferClass, &js::SharedArrayBufferObject::protoClass) \
 110 IF_INTL(real,imaginary) (Intl,                  38,     js_InitIntlClass,          CLASP(Intl)) \
 111 IF_BDATA(real,imaginary)(TypedObject,           39,     js_InitTypedObjectModuleObject,   OCLASP(TypedObjectModule)) \
 112     imaginary(GeneratorFunction,     40,     js_InitIteratorClasses, dummy) \
 113 IF_BDATA(real,imaginary)(SIMD,                  41,     js_InitSIMDClass, OCLASP(SIMD)) \
 114     real(WeakSet,               42,     js_InitWeakSetClass,       OCLASP(WeakSet)) \
 115 IF_SAB(real,imaginary)(SharedInt8Array,         43,     js_InitViaClassSpec,       SHARED_TYPED_ARRAY_CLASP(Int8)) \
 116 IF_SAB(real,imaginary)(SharedUint8Array,        44,     js_InitViaClassSpec,       SHARED_TYPED_ARRAY_CLASP(Uint8)) \
 117 IF_SAB(real,imaginary)(SharedInt16Array,        45,     js_InitViaClassSpec,       SHARED_TYPED_ARRAY_CLASP(Int16)) \
 118 IF_SAB(real,imaginary)(SharedUint16Array,       46,     js_InitViaClassSpec,       SHARED_TYPED_ARRAY_CLASP(Uint16)) \
 119 IF_SAB(real,imaginary)(SharedInt32Array,        47,     js_InitViaClassSpec,       SHARED_TYPED_ARRAY_CLASP(Int32)) \
 120 IF_SAB(real,imaginary)(SharedUint32Array,       48,     js_InitViaClassSpec,       SHARED_TYPED_ARRAY_CLASP(Uint32)) \
 121 IF_SAB(real,imaginary)(SharedFloat32Array,      49,     js_InitViaClassSpec,       SHARED_TYPED_ARRAY_CLASP(Float32)) \
 122 IF_SAB(real,imaginary)(SharedFloat64Array,      50,     js_InitViaClassSpec,       SHARED_TYPED_ARRAY_CLASP(Float64)) \
 123 IF_SAB(real,imaginary)(SharedUint8ClampedArray, 51,     js_InitViaClassSpec,       SHARED_TYPED_ARRAY_CLASP(Uint8Clamped)) \
 124     real(TypedArray,            52,      js_InitViaClassSpec,      &js::TypedArrayObject::sharedTypedArrayPrototypeClass) \
 125 IF_SAB(real,imaginary)(Atomics,                 53,     js_InitAtomicsClass, OCLASP(Atomics)) \
 126
 127 #define JS_FOR_EACH_PROTOTYPE(macro) JS_FOR_PROTOTYPES(macro,macro)
 128
 129 #endif /* jsprototypes_h */