File Explorer

1#ifndef SRC_JS_NATIVE_API_TYPES_H_2#define SRC_JS_NATIVE_API_TYPES_H_3 4// Use INT_MAX, this should only be consumed by the pre-processor anyway.5#define NAPI_VERSION_EXPERIMENTAL 21474836476#ifndef NAPI_VERSION7#ifdef NAPI_EXPERIMENTAL8#define NAPI_VERSION NAPI_VERSION_EXPERIMENTAL9#else10// The baseline version for Node-API.11// NAPI_VERSION controls which version is used by default when compiling12// a native addon. If the addon developer wants to use functions from a13// newer Node-API version not yet available in all LTS versions, they can14// set NAPI_VERSION to explicitly depend on that version.15#define NAPI_VERSION 816#endif17#endif18 19// This file needs to be compatible with C compilers.20// This is a public include file, and these includes have essentially21// become part of its API.22#include <stddef.h>  // NOLINT(modernize-deprecated-headers)23#include <stdint.h>  // NOLINT(modernize-deprecated-headers)24 25#if !defined __cplusplus || (defined(_MSC_VER) && _MSC_VER < 1900)26typedef uint16_t char16_t;27#endif28 29#ifndef NAPI_CDECL30#ifdef _WIN3231#define NAPI_CDECL __cdecl32#else33#define NAPI_CDECL34#endif35#endif36 37// JSVM API types are all opaque pointers for ABI stability38// typedef undefined structs instead of void* for compile time type safety39typedef struct napi_env__* napi_env;40 41// We need to mark APIs which can be called during garbage collection (GC),42// meaning that they do not affect the state of the JS engine, and can43// therefore be called synchronously from a finalizer that itself runs44// synchronously during GC. Such APIs can receive either a `napi_env` or a45// `node_api_basic_env` as their first parameter, because we should be able to46// also call them during normal, non-garbage-collecting operations, whereas47// APIs that affect the state of the JS engine can only receive a `napi_env` as48// their first parameter, because we must not call them during GC. In lieu of49// inheritance, we use the properties of the const qualifier to accomplish50// this, because both a const and a non-const value can be passed to an API51// expecting a const value, but only a non-const value can be passed to an API52// expecting a non-const value.53//54// In conjunction with appropriate CFLAGS to warn us if we're passing a const55// (basic) environment into an API that expects a non-const environment, and56// the definition of basic finalizer function pointer types below, which57// receive a basic environment as their first parameter, and can thus only call58// basic APIs (unless the user explicitly casts the environment), we achieve59// the ability to ensure at compile time that we do not call APIs that affect60// the state of the JS engine from a synchronous (basic) finalizer.61#if !defined(NAPI_EXPERIMENTAL) ||                                             \62    (defined(NAPI_EXPERIMENTAL) &&                                             \63     (defined(NODE_API_EXPERIMENTAL_NOGC_ENV_OPT_OUT) ||                       \64      defined(NODE_API_EXPERIMENTAL_BASIC_ENV_OPT_OUT)))65typedef struct napi_env__* node_api_nogc_env;66#else67typedef const struct napi_env__* node_api_nogc_env;68#endif69typedef node_api_nogc_env node_api_basic_env;70 71typedef struct napi_value__* napi_value;72typedef struct napi_ref__* napi_ref;73typedef struct napi_handle_scope__* napi_handle_scope;74typedef struct napi_escapable_handle_scope__* napi_escapable_handle_scope;75typedef struct napi_callback_info__* napi_callback_info;76typedef struct napi_deferred__* napi_deferred;77 78typedef enum {79  napi_default = 0,80  napi_writable = 1 << 0,81  napi_enumerable = 1 << 1,82  napi_configurable = 1 << 2,83 84  // Used with napi_define_class to distinguish static properties85  // from instance properties. Ignored by napi_define_properties.86  napi_static = 1 << 10,87 88#if NAPI_VERSION >= 889  // Default for class methods.90  napi_default_method = napi_writable | napi_configurable,91 92  // Default for object properties, like in JS obj[prop].93  napi_default_jsproperty = napi_writable | napi_enumerable | napi_configurable,94#endif  // NAPI_VERSION >= 895} napi_property_attributes;96 97typedef enum {98  // ES6 types (corresponds to typeof)99  napi_undefined,100  napi_null,101  napi_boolean,102  napi_number,103  napi_string,104  napi_symbol,105  napi_object,106  napi_function,107  napi_external,108  napi_bigint,109} napi_valuetype;110 111typedef enum {112  napi_int8_array,113  napi_uint8_array,114  napi_uint8_clamped_array,115  napi_int16_array,116  napi_uint16_array,117  napi_int32_array,118  napi_uint32_array,119  napi_float32_array,120  napi_float64_array,121  napi_bigint64_array,122  napi_biguint64_array,123#define NODE_API_HAS_FLOAT16_ARRAY124  napi_float16_array,125} napi_typedarray_type;126 127typedef enum {128  napi_ok,129  napi_invalid_arg,130  napi_object_expected,131  napi_string_expected,132  napi_name_expected,133  napi_function_expected,134  napi_number_expected,135  napi_boolean_expected,136  napi_array_expected,137  napi_generic_failure,138  napi_pending_exception,139  napi_cancelled,140  napi_escape_called_twice,141  napi_handle_scope_mismatch,142  napi_callback_scope_mismatch,143  napi_queue_full,144  napi_closing,145  napi_bigint_expected,146  napi_date_expected,147  napi_arraybuffer_expected,148  napi_detachable_arraybuffer_expected,149  napi_would_deadlock,  // unused150  napi_no_external_buffers_allowed,151  napi_cannot_run_js,152} napi_status;153// Note: when adding a new enum value to `napi_status`, please also update154//   * `const int last_status` in the definition of `napi_get_last_error_info()'155//     in file js_native_api_v8.cc.156//   * `const char* error_messages[]` in file js_native_api_v8.cc with a brief157//     message explaining the error.158//   * the definition of `napi_status` in doc/api/n-api.md to reflect the newly159//     added value(s).160 161typedef napi_value(NAPI_CDECL* napi_callback)(napi_env env,162                                              napi_callback_info info);163typedef void(NAPI_CDECL* napi_finalize)(napi_env env,164                                        void* finalize_data,165                                        void* finalize_hint);166 167#if !defined(NAPI_EXPERIMENTAL) ||                                             \168    (defined(NAPI_EXPERIMENTAL) &&                                             \169     (defined(NODE_API_EXPERIMENTAL_NOGC_ENV_OPT_OUT) ||                       \170      defined(NODE_API_EXPERIMENTAL_BASIC_ENV_OPT_OUT)))171typedef napi_finalize node_api_nogc_finalize;172#else173typedef void(NAPI_CDECL* node_api_nogc_finalize)(node_api_nogc_env env,174                                                 void* finalize_data,175                                                 void* finalize_hint);176#endif177typedef node_api_nogc_finalize node_api_basic_finalize;178 179typedef struct {180  // One of utf8name or name should be NULL.181  const char* utf8name;182  napi_value name;183 184  napi_callback method;185  napi_callback getter;186  napi_callback setter;187  napi_value value;188 189  napi_property_attributes attributes;190  void* data;191} napi_property_descriptor;192 193typedef struct {194  const char* error_message;195  void* engine_reserved;196  uint32_t engine_error_code;197  napi_status error_code;198} napi_extended_error_info;199 200#if NAPI_VERSION >= 6201typedef enum {202  napi_key_include_prototypes,203  napi_key_own_only204} napi_key_collection_mode;205 206typedef enum {207  napi_key_all_properties = 0,208  napi_key_writable = 1,209  napi_key_enumerable = 1 << 1,210  napi_key_configurable = 1 << 2,211  napi_key_skip_strings = 1 << 3,212  napi_key_skip_symbols = 1 << 4213} napi_key_filter;214 215typedef enum {216  napi_key_keep_numbers,217  napi_key_numbers_to_strings218} napi_key_conversion;219#endif  // NAPI_VERSION >= 6220 221#if NAPI_VERSION >= 8222typedef struct {223  uint64_t lower;224  uint64_t upper;225} napi_type_tag;226#endif  // NAPI_VERSION >= 8227 228#endif  // SRC_JS_NATIVE_API_TYPES_H_229