feat: Passwordless cross-device authentication

- Arkitektur: docs/auth/passwordless-architecture.md
- Backend: iom/quixzoom-auth-service/ (FastAPI + Redis)
- Webb: quixzoom-market-pages/se/login/ (QR-kod + polling)
- App: iom/quixzoom-app/src/features/auth/ (push + deep links)

Flöde: QR-kod → app-godkännande → webb-inloggad
This commit is contained in:
Bernt
2026-07-07 07:11:50 +00:00
parent 4aa984ad74
commit 6989a98d75
61843 changed files with 5491611 additions and 872231 deletions
+9
View File
@@ -0,0 +1,9 @@
The MIT License (MIT)
Copyright (c) 2017 [Node.js API collaborators](https://github.com/nodejs/node-addon-api#collaborators)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+319
View File
@@ -0,0 +1,319 @@
NOTE: The default branch has been renamed!
master is now named main
If you have a local clone, you can update it by running:
```shell
git branch -m master main
git fetch origin
git branch -u origin/main main
```
# **node-addon-api module**
This module contains **header-only C++ wrapper classes** which simplify
the use of the C based [Node-API](https://nodejs.org/dist/latest/docs/api/n-api.html)
provided by Node.js when using C++. It provides a C++ object model
and exception handling semantics with low overhead.
There are three options for implementing addons: Node-API, nan, or direct
use of internal V8, libuv, and Node.js libraries. Unless there is a need for
direct access to functionality that is not exposed by Node-API as outlined
in [C/C++ addons](https://nodejs.org/dist/latest/docs/api/addons.html)
in Node.js core, use Node-API. Refer to
[C/C++ addons with Node-API](https://nodejs.org/dist/latest/docs/api/n-api.html)
for more information on Node-API.
Node-API is an ABI stable C interface provided by Node.js for building native
addons. It is independent of the underlying JavaScript runtime (e.g. V8 or ChakraCore)
and is maintained as part of Node.js itself. It is intended to insulate
native addons from changes in the underlying JavaScript engine and allow
modules compiled for one version to run on later versions of Node.js without
recompilation.
The `node-addon-api` module, which is not part of Node.js, preserves the benefits
of the Node-API as it consists only of inline code that depends only on the stable API
provided by Node-API. As such, modules built against one version of Node.js
using node-addon-api should run without having to be rebuilt with newer versions
of Node.js.
It is important to remember that *other* Node.js interfaces such as
`libuv` (included in a project via `#include <uv.h>`) are not ABI-stable across
Node.js major versions. Thus, an addon must use Node-API and/or `node-addon-api`
exclusively and build against a version of Node.js that includes an
implementation of Node-API (meaning an active LTS version of Node.js) in
order to benefit from ABI stability across Node.js major versions. Node.js
provides an [ABI stability guide][] containing a detailed explanation of ABI
stability in general, and the Node-API ABI stability guarantee in particular.
As new APIs are added to Node-API, node-addon-api must be updated to provide
wrappers for those new APIs. For this reason, node-addon-api provides
methods that allow callers to obtain the underlying Node-API handles so
direct calls to Node-API and the use of the objects/methods provided by
node-addon-api can be used together. For example, in order to be able
to use an API for which the node-addon-api does not yet provide a wrapper.
APIs exposed by node-addon-api are generally used to create and
manipulate JavaScript values. Concepts and operations generally map
to ideas specified in the **ECMA262 Language Specification**.
The [Node-API Resource](https://nodejs.github.io/node-addon-examples/) offers an
excellent orientation and tips for developers just getting started with Node-API
and node-addon-api.
- **[Setup](#setup)**
- **[API Documentation](#api)**
- **[Examples](#examples)**
- **[Tests](#tests)**
- **[More resource and info about native Addons](#resources)**
- **[Badges](#badges)**
- **[Code of Conduct](CODE_OF_CONDUCT.md)**
- **[Contributors](#contributors)**
- **[License](#license)**
## **Current version: 7.1.1**
(See [CHANGELOG.md](CHANGELOG.md) for complete Changelog)
[![NPM](https://nodei.co/npm/node-addon-api.png?downloads=true&downloadRank=true)](https://nodei.co/npm/node-addon-api/) [![NPM](https://nodei.co/npm-dl/node-addon-api.png?months=6&height=1)](https://nodei.co/npm/node-addon-api/)
<a name="setup"></a>
node-addon-api is based on [Node-API](https://nodejs.org/api/n-api.html) and supports using different Node-API versions.
This allows addons built with it to run with Node.js versions which support the targeted Node-API version.
**However** the node-addon-api support model is to support only the active LTS Node.js versions. This means that
every year there will be a new major which drops support for the Node.js LTS version which has gone out of service.
The oldest Node.js version supported by the current version of node-addon-api is Node.js 16.x.
## Setup
- [Installation and usage](doc/setup.md)
- [node-gyp](doc/node-gyp.md)
- [cmake-js](doc/cmake-js.md)
- [Conversion tool](doc/conversion-tool.md)
- [Checker tool](doc/checker-tool.md)
- [Generator](doc/generator.md)
- [Prebuild tools](doc/prebuild_tools.md)
<a name="api"></a>
### **API Documentation**
The following is the documentation for node-addon-api.
- [Full Class Hierarchy](doc/hierarchy.md)
- [Addon Structure](doc/addon.md)
- Data Types:
- [Env](doc/env.md)
- [CallbackInfo](doc/callbackinfo.md)
- [Reference](doc/reference.md)
- [Value](doc/value.md)
- [Name](doc/name.md)
- [Symbol](doc/symbol.md)
- [String](doc/string.md)
- [Number](doc/number.md)
- [Date](doc/date.md)
- [BigInt](doc/bigint.md)
- [Boolean](doc/boolean.md)
- [External](doc/external.md)
- [Object](doc/object.md)
- [Array](doc/array.md)
- [ObjectReference](doc/object_reference.md)
- [PropertyDescriptor](doc/property_descriptor.md)
- [Function](doc/function.md)
- [FunctionReference](doc/function_reference.md)
- [ObjectWrap](doc/object_wrap.md)
- [ClassPropertyDescriptor](doc/class_property_descriptor.md)
- [Buffer](doc/buffer.md)
- [ArrayBuffer](doc/array_buffer.md)
- [TypedArray](doc/typed_array.md)
- [TypedArrayOf](doc/typed_array_of.md)
- [DataView](doc/dataview.md)
- [Error Handling](doc/error_handling.md)
- [Error](doc/error.md)
- [TypeError](doc/type_error.md)
- [RangeError](doc/range_error.md)
- [SyntaxError](doc/syntax_error.md)
- [Object Lifetime Management](doc/object_lifetime_management.md)
- [HandleScope](doc/handle_scope.md)
- [EscapableHandleScope](doc/escapable_handle_scope.md)
- [Memory Management](doc/memory_management.md)
- [Async Operations](doc/async_operations.md)
- [AsyncWorker](doc/async_worker.md)
- [AsyncContext](doc/async_context.md)
- [AsyncWorker Variants](doc/async_worker_variants.md)
- [Thread-safe Functions](doc/threadsafe.md)
- [ThreadSafeFunction](doc/threadsafe_function.md)
- [TypedThreadSafeFunction](doc/typed_threadsafe_function.md)
- [Promises](doc/promises.md)
- [Version management](doc/version_management.md)
<a name="examples"></a>
### **Examples**
Are you new to **node-addon-api**? Take a look at our **[examples](https://github.com/nodejs/node-addon-examples)**
- **[Hello World](https://github.com/nodejs/node-addon-examples/tree/main/src/1-getting-started/1_hello_world)**
- **[Pass arguments to a function](https://github.com/nodejs/node-addon-examples/tree/main/src/1-getting-started/2_function_arguments/node-addon-api)**
- **[Callbacks](https://github.com/nodejs/node-addon-examples/tree/main/src/1-getting-started/3_callbacks/node-addon-api)**
- **[Object factory](https://github.com/nodejs/node-addon-examples/tree/main/src/1-getting-started/4_object_factory/node-addon-api)**
- **[Function factory](https://github.com/nodejs/node-addon-examples/tree/main/src/1-getting-started/5_function_factory/node-addon-api)**
- **[Wrapping C++ Object](https://github.com/nodejs/node-addon-examples/tree/main/src/1-getting-started/6_object_wrap/node-addon-api)**
- **[Factory of wrapped object](https://github.com/nodejs/node-addon-examples/tree/main/src/1-getting-started/7_factory_wrap/node-addon-api)**
- **[Passing wrapped object around](https://github.com/nodejs/node-addon-examples/tree/main/src/2-js-to-native-conversion/8_passing_wrapped/node-addon-api)**
<a name="tests"></a>
### **Tests**
To run the **node-addon-api** tests do:
```
npm install
npm test
```
To avoid testing the deprecated portions of the API run
```
npm install
npm test --disable-deprecated
```
To run the tests targeting a specific version of Node-API run
```
npm install
export NAPI_VERSION=X
npm test --NAPI_VERSION=X
```
where X is the version of Node-API you want to target.
To run a specific unit test, filter conditions are available
**Example:**
compile and run only tests on objectwrap.cc and objectwrap.js
```
npm run unit --filter=objectwrap
```
Multiple unit tests cane be selected with wildcards
**Example:**
compile and run all test files ending with "reference" -> function_reference.cc, object_reference.cc, reference.cc
```
npm run unit --filter=*reference
```
Multiple filter conditions can be joined to broaden the test selection
**Example:**
compile and run all tests under folders threadsafe_function and typed_threadsafe_function and also the objectwrap.cc file
npm run unit --filter='*function objectwrap'
### **Debug**
To run the **node-addon-api** tests with `--debug` option:
```
npm run-script dev
```
If you want a faster build, you might use the following option:
```
npm run-script dev:incremental
```
Take a look and get inspired by our **[test suite](https://github.com/nodejs/node-addon-api/tree/HEAD/test)**
### **Benchmarks**
You can run the available benchmarks using the following command:
```
npm run-script benchmark
```
See [benchmark/README.md](benchmark/README.md) for more details about running and adding benchmarks.
<a name="resources"></a>
### **More resource and info about native Addons**
- **[C++ Addons](https://nodejs.org/dist/latest/docs/api/addons.html)**
- **[Node-API](https://nodejs.org/dist/latest/docs/api/n-api.html)**
- **[Node-API - Next Generation Node API for Native Modules](https://youtu.be/-Oniup60Afs)**
- **[How We Migrated Realm JavaScript From NAN to Node-API](https://developer.mongodb.com/article/realm-javascript-nan-to-n-api)**
As node-addon-api's core mission is to expose the plain C Node-API as C++
wrappers, tools that facilitate n-api/node-addon-api providing more
convenient patterns for developing a Node.js add-on with n-api/node-addon-api
can be published to NPM as standalone packages. It is also recommended to tag
such packages with `node-addon-api` to provide more visibility to the community.
Quick links to NPM searches: [keywords:node-addon-api](https://www.npmjs.com/search?q=keywords%3Anode-addon-api).
<a name="other-bindings"></a>
### **Other bindings**
- **[napi-rs](https://napi.rs)** - (`Rust`)
<a name="badges"></a>
### **Badges**
The use of badges is recommended to indicate the minimum version of Node-API
required for the module. This helps to determine which Node.js major versions are
supported. Addon maintainers can consult the [Node-API support matrix][] to determine
which Node.js versions provide a given Node-API version. The following badges are
available:
![Node-API v1 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v1%20Badge.svg)
![Node-API v2 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v2%20Badge.svg)
![Node-API v3 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v3%20Badge.svg)
![Node-API v4 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v4%20Badge.svg)
![Node-API v5 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v5%20Badge.svg)
![Node-API v6 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v6%20Badge.svg)
![Node-API v7 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v7%20Badge.svg)
![Node-API v8 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v8%20Badge.svg)
![Node-API v9 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v9%20Badge.svg)
![Node-API Experimental Version Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20Experimental%20Version%20Badge.svg)
## **Contributing**
We love contributions from the community to **node-addon-api**!
See [CONTRIBUTING.md](CONTRIBUTING.md) for more details on our philosophy around extending this module.
<a name="contributors"></a>
## Team members
### Active
| Name | GitHub Link |
| ------------------- | ----------------------------------------------------- |
| Anna Henningsen | [addaleax](https://github.com/addaleax) |
| Chengzhong Wu | [legendecas](https://github.com/legendecas) |
| Jack Xia | [JckXia](https://github.com/JckXia) |
| Kevin Eady | [KevinEady](https://github.com/KevinEady) |
| Michael Dawson | [mhdawson](https://github.com/mhdawson) |
| Nicola Del Gobbo | [NickNaso](https://github.com/NickNaso) |
| Vladimir Morozov | [vmoroz](https://github.com/vmoroz) |
### Emeritus
| Name | GitHub Link |
| ------------------- | ----------------------------------------------------- |
| Arunesh Chandra | [aruneshchandra](https://github.com/aruneshchandra) |
| Benjamin Byholm | [kkoopa](https://github.com/kkoopa) |
| Gabriel Schulhof | [gabrielschulhof](https://github.com/gabrielschulhof) |
| Hitesh Kanwathirtha | [digitalinfinity](https://github.com/digitalinfinity) |
| Jason Ginchereau | [jasongin](https://github.com/jasongin) |
| Jim Schlight | [jschlight](https://github.com/jschlight) |
| Sampson Gao | [sampsongao](https://github.com/sampsongao) |
| Taylor Woll | [boingoing](https://github.com/boingoing) |
<a name="license"></a>
Licensed under [MIT](./LICENSE.md)
[ABI stability guide]: https://nodejs.org/en/docs/guides/abi-stability/
[Node-API support matrix]: https://nodejs.org/dist/latest/docs/api/n-api.html#n_api_n_api_version_matrix
+20
View File
@@ -0,0 +1,20 @@
{
'variables': {
'NAPI_VERSION%': "<!(node -p \"process.env.NAPI_VERSION || process.versions.napi\")",
'disable_deprecated': "<!(node -p \"process.env['npm_config_disable_deprecated']\")"
},
'conditions': [
['NAPI_VERSION!=""', { 'defines': ['NAPI_VERSION=<@(NAPI_VERSION)'] } ],
['disable_deprecated=="true"', {
'defines': ['NODE_ADDON_API_DISABLE_DEPRECATED']
}],
['OS=="mac"', {
'cflags+': ['-fvisibility=hidden'],
'xcode_settings': {
'OTHER_CFLAGS': ['-fvisibility=hidden']
}
}]
],
'cflags': [ '-Werror', '-Wall', '-Wextra', '-Wpedantic', '-Wunused-parameter' ],
'cflags_cc': [ '-Werror', '-Wall', '-Wextra', '-Wpedantic', '-Wunused-parameter' ]
}
+25
View File
@@ -0,0 +1,25 @@
{
'defines': [ 'NAPI_CPP_EXCEPTIONS' ],
'cflags!': [ '-fno-exceptions' ],
'cflags_cc!': [ '-fno-exceptions' ],
'conditions': [
["OS=='win'", {
"defines": [
"_HAS_EXCEPTIONS=1"
],
"msvs_settings": {
"VCCLCompilerTool": {
"ExceptionHandling": 1,
'EnablePREfast': 'true',
},
},
}],
["OS=='mac'", {
'xcode_settings': {
'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
'CLANG_CXX_LIBRARY': 'libc++',
'MACOSX_DEPLOYMENT_TARGET': '10.7',
},
}],
],
}
+12
View File
@@ -0,0 +1,12 @@
const path = require('path');
const includeDir = path.relative('.', __dirname);
module.exports = {
include: `"${__dirname}"`, // deprecated, can be removed as part of 4.0.0
include_dir: includeDir,
gyp: path.join(includeDir, 'node_api.gyp:nothing'), // deprecated.
targets: path.join(includeDir, 'node_addon_api.gyp'),
isNodeApiBuiltin: true,
needsFlag: false
};
+186
View File
@@ -0,0 +1,186 @@
#ifndef SRC_NAPI_INL_DEPRECATED_H_
#define SRC_NAPI_INL_DEPRECATED_H_
////////////////////////////////////////////////////////////////////////////////
// PropertyDescriptor class
////////////////////////////////////////////////////////////////////////////////
template <typename Getter>
inline PropertyDescriptor PropertyDescriptor::Accessor(
const char* utf8name,
Getter getter,
napi_property_attributes attributes,
void* /*data*/) {
using CbData = details::CallbackData<Getter, Napi::Value>;
// TODO: Delete when the function is destroyed
auto callbackData = new CbData({getter, nullptr});
return PropertyDescriptor({utf8name,
nullptr,
nullptr,
CbData::Wrapper,
nullptr,
nullptr,
attributes,
callbackData});
}
template <typename Getter>
inline PropertyDescriptor PropertyDescriptor::Accessor(
const std::string& utf8name,
Getter getter,
napi_property_attributes attributes,
void* data) {
return Accessor(utf8name.c_str(), getter, attributes, data);
}
template <typename Getter>
inline PropertyDescriptor PropertyDescriptor::Accessor(
napi_value name,
Getter getter,
napi_property_attributes attributes,
void* /*data*/) {
using CbData = details::CallbackData<Getter, Napi::Value>;
// TODO: Delete when the function is destroyed
auto callbackData = new CbData({getter, nullptr});
return PropertyDescriptor({nullptr,
name,
nullptr,
CbData::Wrapper,
nullptr,
nullptr,
attributes,
callbackData});
}
template <typename Getter>
inline PropertyDescriptor PropertyDescriptor::Accessor(
Name name, Getter getter, napi_property_attributes attributes, void* data) {
napi_value nameValue = name;
return PropertyDescriptor::Accessor(nameValue, getter, attributes, data);
}
template <typename Getter, typename Setter>
inline PropertyDescriptor PropertyDescriptor::Accessor(
const char* utf8name,
Getter getter,
Setter setter,
napi_property_attributes attributes,
void* /*data*/) {
using CbData = details::AccessorCallbackData<Getter, Setter>;
// TODO: Delete when the function is destroyed
auto callbackData = new CbData({getter, setter, nullptr});
return PropertyDescriptor({utf8name,
nullptr,
nullptr,
CbData::GetterWrapper,
CbData::SetterWrapper,
nullptr,
attributes,
callbackData});
}
template <typename Getter, typename Setter>
inline PropertyDescriptor PropertyDescriptor::Accessor(
const std::string& utf8name,
Getter getter,
Setter setter,
napi_property_attributes attributes,
void* data) {
return Accessor(utf8name.c_str(), getter, setter, attributes, data);
}
template <typename Getter, typename Setter>
inline PropertyDescriptor PropertyDescriptor::Accessor(
napi_value name,
Getter getter,
Setter setter,
napi_property_attributes attributes,
void* /*data*/) {
using CbData = details::AccessorCallbackData<Getter, Setter>;
// TODO: Delete when the function is destroyed
auto callbackData = new CbData({getter, setter, nullptr});
return PropertyDescriptor({nullptr,
name,
nullptr,
CbData::GetterWrapper,
CbData::SetterWrapper,
nullptr,
attributes,
callbackData});
}
template <typename Getter, typename Setter>
inline PropertyDescriptor PropertyDescriptor::Accessor(
Name name,
Getter getter,
Setter setter,
napi_property_attributes attributes,
void* data) {
napi_value nameValue = name;
return PropertyDescriptor::Accessor(
nameValue, getter, setter, attributes, data);
}
template <typename Callable>
inline PropertyDescriptor PropertyDescriptor::Function(
const char* utf8name,
Callable cb,
napi_property_attributes attributes,
void* /*data*/) {
using ReturnType = decltype(cb(CallbackInfo(nullptr, nullptr)));
using CbData = details::CallbackData<Callable, ReturnType>;
// TODO: Delete when the function is destroyed
auto callbackData = new CbData({cb, nullptr});
return PropertyDescriptor({utf8name,
nullptr,
CbData::Wrapper,
nullptr,
nullptr,
nullptr,
attributes,
callbackData});
}
template <typename Callable>
inline PropertyDescriptor PropertyDescriptor::Function(
const std::string& utf8name,
Callable cb,
napi_property_attributes attributes,
void* data) {
return Function(utf8name.c_str(), cb, attributes, data);
}
template <typename Callable>
inline PropertyDescriptor PropertyDescriptor::Function(
napi_value name,
Callable cb,
napi_property_attributes attributes,
void* /*data*/) {
using ReturnType = decltype(cb(CallbackInfo(nullptr, nullptr)));
using CbData = details::CallbackData<Callable, ReturnType>;
// TODO: Delete when the function is destroyed
auto callbackData = new CbData({cb, nullptr});
return PropertyDescriptor({nullptr,
name,
CbData::Wrapper,
nullptr,
nullptr,
nullptr,
attributes,
callbackData});
}
template <typename Callable>
inline PropertyDescriptor PropertyDescriptor::Function(
Name name, Callable cb, napi_property_attributes attributes, void* data) {
napi_value nameValue = name;
return PropertyDescriptor::Function(nameValue, cb, attributes, data);
}
#endif // !SRC_NAPI_INL_DEPRECATED_H_
+6607
View File
@@ -0,0 +1,6607 @@
#ifndef SRC_NAPI_INL_H_
#define SRC_NAPI_INL_H_
////////////////////////////////////////////////////////////////////////////////
// Node-API C++ Wrapper Classes
//
// Inline header-only implementations for "Node-API" ABI-stable C APIs for
// Node.js.
////////////////////////////////////////////////////////////////////////////////
// Note: Do not include this file directly! Include "napi.h" instead.
#include <algorithm>
#include <cstring>
#if NAPI_HAS_THREADS
#include <mutex>
#endif // NAPI_HAS_THREADS
#include <type_traits>
#include <utility>
namespace Napi {
#ifdef NAPI_CPP_CUSTOM_NAMESPACE
namespace NAPI_CPP_CUSTOM_NAMESPACE {
#endif
// Helpers to handle functions exposed from C++ and internal constants.
namespace details {
// New napi_status constants not yet available in all supported versions of
// Node.js releases. Only necessary when they are used in napi.h and napi-inl.h.
constexpr int napi_no_external_buffers_allowed = 22;
template <typename FreeType>
inline void default_finalizer(napi_env /*env*/, void* data, void* /*hint*/) {
delete static_cast<FreeType*>(data);
}
// Attach a data item to an object and delete it when the object gets
// garbage-collected.
// TODO: Replace this code with `napi_add_finalizer()` whenever it becomes
// available on all supported versions of Node.js.
template <typename FreeType,
napi_finalize finalizer = default_finalizer<FreeType>>
inline napi_status AttachData(napi_env env,
napi_value obj,
FreeType* data,
void* hint = nullptr) {
napi_status status;
#if (NAPI_VERSION < 5)
napi_value symbol, external;
status = napi_create_symbol(env, nullptr, &symbol);
if (status == napi_ok) {
status = napi_create_external(env, data, finalizer, hint, &external);
if (status == napi_ok) {
napi_property_descriptor desc = {nullptr,
symbol,
nullptr,
nullptr,
nullptr,
external,
napi_default,
nullptr};
status = napi_define_properties(env, obj, 1, &desc);
}
}
#else // NAPI_VERSION >= 5
status = napi_add_finalizer(env, obj, data, finalizer, hint, nullptr);
#endif
return status;
}
// For use in JS to C++ callback wrappers to catch any Napi::Error exceptions
// and rethrow them as JavaScript exceptions before returning from the callback.
template <typename Callable>
inline napi_value WrapCallback(Callable callback) {
#ifdef NAPI_CPP_EXCEPTIONS
try {
return callback();
} catch (const Error& e) {
e.ThrowAsJavaScriptException();
return nullptr;
}
#else // NAPI_CPP_EXCEPTIONS
// When C++ exceptions are disabled, errors are immediately thrown as JS
// exceptions, so there is no need to catch and rethrow them here.
return callback();
#endif // NAPI_CPP_EXCEPTIONS
}
// For use in JS to C++ void callback wrappers to catch any Napi::Error
// exceptions and rethrow them as JavaScript exceptions before returning from
// the callback.
template <typename Callable>
inline void WrapVoidCallback(Callable callback) {
#ifdef NAPI_CPP_EXCEPTIONS
try {
callback();
} catch (const Error& e) {
e.ThrowAsJavaScriptException();
}
#else // NAPI_CPP_EXCEPTIONS
// When C++ exceptions are disabled, errors are immediately thrown as JS
// exceptions, so there is no need to catch and rethrow them here.
callback();
#endif // NAPI_CPP_EXCEPTIONS
}
template <typename Callable, typename Return>
struct CallbackData {
static inline napi_value Wrapper(napi_env env, napi_callback_info info) {
return details::WrapCallback([&] {
CallbackInfo callbackInfo(env, info);
CallbackData* callbackData =
static_cast<CallbackData*>(callbackInfo.Data());
callbackInfo.SetData(callbackData->data);
return callbackData->callback(callbackInfo);
});
}
Callable callback;
void* data;
};
template <typename Callable>
struct CallbackData<Callable, void> {
static inline napi_value Wrapper(napi_env env, napi_callback_info info) {
return details::WrapCallback([&] {
CallbackInfo callbackInfo(env, info);
CallbackData* callbackData =
static_cast<CallbackData*>(callbackInfo.Data());
callbackInfo.SetData(callbackData->data);
callbackData->callback(callbackInfo);
return nullptr;
});
}
Callable callback;
void* data;
};
template <void (*Callback)(const CallbackInfo& info)>
napi_value TemplatedVoidCallback(napi_env env,
napi_callback_info info) NAPI_NOEXCEPT {
return details::WrapCallback([&] {
CallbackInfo cbInfo(env, info);
Callback(cbInfo);
return nullptr;
});
}
template <Napi::Value (*Callback)(const CallbackInfo& info)>
napi_value TemplatedCallback(napi_env env,
napi_callback_info info) NAPI_NOEXCEPT {
return details::WrapCallback([&] {
CallbackInfo cbInfo(env, info);
return Callback(cbInfo);
});
}
template <typename T,
Napi::Value (T::*UnwrapCallback)(const CallbackInfo& info)>
napi_value TemplatedInstanceCallback(napi_env env,
napi_callback_info info) NAPI_NOEXCEPT {
return details::WrapCallback([&] {
CallbackInfo cbInfo(env, info);
T* instance = T::Unwrap(cbInfo.This().As<Object>());
return instance ? (instance->*UnwrapCallback)(cbInfo) : Napi::Value();
});
}
template <typename T, void (T::*UnwrapCallback)(const CallbackInfo& info)>
napi_value TemplatedInstanceVoidCallback(napi_env env, napi_callback_info info)
NAPI_NOEXCEPT {
return details::WrapCallback([&] {
CallbackInfo cbInfo(env, info);
T* instance = T::Unwrap(cbInfo.This().As<Object>());
if (instance) (instance->*UnwrapCallback)(cbInfo);
return nullptr;
});
}
template <typename T, typename Finalizer, typename Hint = void>
struct FinalizeData {
static inline void Wrapper(napi_env env,
void* data,
void* finalizeHint) NAPI_NOEXCEPT {
WrapVoidCallback([&] {
FinalizeData* finalizeData = static_cast<FinalizeData*>(finalizeHint);
finalizeData->callback(Env(env), static_cast<T*>(data));
delete finalizeData;
});
}
static inline void WrapperWithHint(napi_env env,
void* data,
void* finalizeHint) NAPI_NOEXCEPT {
WrapVoidCallback([&] {
FinalizeData* finalizeData = static_cast<FinalizeData*>(finalizeHint);
finalizeData->callback(
Env(env), static_cast<T*>(data), finalizeData->hint);
delete finalizeData;
});
}
Finalizer callback;
Hint* hint;
};
#if (NAPI_VERSION > 3 && NAPI_HAS_THREADS)
template <typename ContextType = void,
typename Finalizer = std::function<void(Env, void*, ContextType*)>,
typename FinalizerDataType = void>
struct ThreadSafeFinalize {
static inline void Wrapper(napi_env env,
void* rawFinalizeData,
void* /* rawContext */) {
if (rawFinalizeData == nullptr) return;
ThreadSafeFinalize* finalizeData =
static_cast<ThreadSafeFinalize*>(rawFinalizeData);
finalizeData->callback(Env(env));
delete finalizeData;
}
static inline void FinalizeWrapperWithData(napi_env env,
void* rawFinalizeData,
void* /* rawContext */) {
if (rawFinalizeData == nullptr) return;
ThreadSafeFinalize* finalizeData =
static_cast<ThreadSafeFinalize*>(rawFinalizeData);
finalizeData->callback(Env(env), finalizeData->data);
delete finalizeData;
}
static inline void FinalizeWrapperWithContext(napi_env env,
void* rawFinalizeData,
void* rawContext) {
if (rawFinalizeData == nullptr) return;
ThreadSafeFinalize* finalizeData =
static_cast<ThreadSafeFinalize*>(rawFinalizeData);
finalizeData->callback(Env(env), static_cast<ContextType*>(rawContext));
delete finalizeData;
}
static inline void FinalizeFinalizeWrapperWithDataAndContext(
napi_env env, void* rawFinalizeData, void* rawContext) {
if (rawFinalizeData == nullptr) return;
ThreadSafeFinalize* finalizeData =
static_cast<ThreadSafeFinalize*>(rawFinalizeData);
finalizeData->callback(
Env(env), finalizeData->data, static_cast<ContextType*>(rawContext));
delete finalizeData;
}
FinalizerDataType* data;
Finalizer callback;
};
template <typename ContextType, typename DataType, typename CallJs, CallJs call>
inline typename std::enable_if<call != static_cast<CallJs>(nullptr)>::type
CallJsWrapper(napi_env env, napi_value jsCallback, void* context, void* data) {
details::WrapVoidCallback([&]() {
call(env,
Function(env, jsCallback),
static_cast<ContextType*>(context),
static_cast<DataType*>(data));
});
}
template <typename ContextType, typename DataType, typename CallJs, CallJs call>
inline typename std::enable_if<call == static_cast<CallJs>(nullptr)>::type
CallJsWrapper(napi_env env,
napi_value jsCallback,
void* /*context*/,
void* /*data*/) {
details::WrapVoidCallback([&]() {
if (jsCallback != nullptr) {
Function(env, jsCallback).Call(0, nullptr);
}
});
}
#if NAPI_VERSION > 4
template <typename CallbackType, typename TSFN>
napi_value DefaultCallbackWrapper(napi_env /*env*/, std::nullptr_t /*cb*/) {
return nullptr;
}
template <typename CallbackType, typename TSFN>
napi_value DefaultCallbackWrapper(napi_env /*env*/, Napi::Function cb) {
return cb;
}
#else
template <typename CallbackType, typename TSFN>
napi_value DefaultCallbackWrapper(napi_env env, Napi::Function cb) {
if (cb.IsEmpty()) {
return TSFN::EmptyFunctionFactory(env);
}
return cb;
}
#endif // NAPI_VERSION > 4
#endif // NAPI_VERSION > 3 && NAPI_HAS_THREADS
template <typename Getter, typename Setter>
struct AccessorCallbackData {
static inline napi_value GetterWrapper(napi_env env,
napi_callback_info info) {
return details::WrapCallback([&] {
CallbackInfo callbackInfo(env, info);
AccessorCallbackData* callbackData =
static_cast<AccessorCallbackData*>(callbackInfo.Data());
callbackInfo.SetData(callbackData->data);
return callbackData->getterCallback(callbackInfo);
});
}
static inline napi_value SetterWrapper(napi_env env,
napi_callback_info info) {
return details::WrapCallback([&] {
CallbackInfo callbackInfo(env, info);
AccessorCallbackData* callbackData =
static_cast<AccessorCallbackData*>(callbackInfo.Data());
callbackInfo.SetData(callbackData->data);
callbackData->setterCallback(callbackInfo);
return nullptr;
});
}
Getter getterCallback;
Setter setterCallback;
void* data;
};
} // namespace details
#ifndef NODE_ADDON_API_DISABLE_DEPRECATED
#include "napi-inl.deprecated.h"
#endif // !NODE_ADDON_API_DISABLE_DEPRECATED
////////////////////////////////////////////////////////////////////////////////
// Module registration
////////////////////////////////////////////////////////////////////////////////
// Register an add-on based on an initializer function.
#define NODE_API_MODULE(modname, regfunc) \
static napi_value __napi_##regfunc(napi_env env, napi_value exports) { \
return Napi::RegisterModule(env, exports, regfunc); \
} \
NAPI_MODULE(modname, __napi_##regfunc)
// Register an add-on based on a subclass of `Addon<T>` with a custom Node.js
// module name.
#define NODE_API_NAMED_ADDON(modname, classname) \
static napi_value __napi_##classname(napi_env env, napi_value exports) { \
return Napi::RegisterModule(env, exports, &classname::Init); \
} \
NAPI_MODULE(modname, __napi_##classname)
// Register an add-on based on a subclass of `Addon<T>` with the Node.js module
// name given by node-gyp from the `target_name` in binding.gyp.
#define NODE_API_ADDON(classname) \
NODE_API_NAMED_ADDON(NODE_GYP_MODULE_NAME, classname)
// Adapt the NAPI_MODULE registration function:
// - Wrap the arguments in NAPI wrappers.
// - Catch any NAPI errors and rethrow as JS exceptions.
inline napi_value RegisterModule(napi_env env,
napi_value exports,
ModuleRegisterCallback registerCallback) {
return details::WrapCallback([&] {
return napi_value(
registerCallback(Napi::Env(env), Napi::Object(env, exports)));
});
}
////////////////////////////////////////////////////////////////////////////////
// Maybe class
////////////////////////////////////////////////////////////////////////////////
template <class T>
bool Maybe<T>::IsNothing() const {
return !_has_value;
}
template <class T>
bool Maybe<T>::IsJust() const {
return _has_value;
}
template <class T>
void Maybe<T>::Check() const {
NAPI_CHECK(IsJust(), "Napi::Maybe::Check", "Maybe value is Nothing.");
}
template <class T>
T Maybe<T>::Unwrap() const {
NAPI_CHECK(IsJust(), "Napi::Maybe::Unwrap", "Maybe value is Nothing.");
return _value;
}
template <class T>
T Maybe<T>::UnwrapOr(const T& default_value) const {
return _has_value ? _value : default_value;
}
template <class T>
bool Maybe<T>::UnwrapTo(T* out) const {
if (IsJust()) {
*out = _value;
return true;
};
return false;
}
template <class T>
bool Maybe<T>::operator==(const Maybe& other) const {
return (IsJust() == other.IsJust()) &&
(!IsJust() || Unwrap() == other.Unwrap());
}
template <class T>
bool Maybe<T>::operator!=(const Maybe& other) const {
return !operator==(other);
}
template <class T>
Maybe<T>::Maybe() : _has_value(false) {}
template <class T>
Maybe<T>::Maybe(const T& t) : _has_value(true), _value(t) {}
template <class T>
inline Maybe<T> Nothing() {
return Maybe<T>();
}
template <class T>
inline Maybe<T> Just(const T& t) {
return Maybe<T>(t);
}
////////////////////////////////////////////////////////////////////////////////
// Env class
////////////////////////////////////////////////////////////////////////////////
inline Env::Env(napi_env env) : _env(env) {}
inline Env::operator napi_env() const {
return _env;
}
inline Object Env::Global() const {
napi_value value;
napi_status status = napi_get_global(*this, &value);
NAPI_THROW_IF_FAILED(*this, status, Object());
return Object(*this, value);
}
inline Value Env::Undefined() const {
napi_value value;
napi_status status = napi_get_undefined(*this, &value);
NAPI_THROW_IF_FAILED(*this, status, Value());
return Value(*this, value);
}
inline Value Env::Null() const {
napi_value value;
napi_status status = napi_get_null(*this, &value);
NAPI_THROW_IF_FAILED(*this, status, Value());
return Value(*this, value);
}
inline bool Env::IsExceptionPending() const {
bool result;
napi_status status = napi_is_exception_pending(_env, &result);
if (status != napi_ok)
result = false; // Checking for a pending exception shouldn't throw.
return result;
}
inline Error Env::GetAndClearPendingException() const {
napi_value value;
napi_status status = napi_get_and_clear_last_exception(_env, &value);
if (status != napi_ok) {
// Don't throw another exception when failing to get the exception!
return Error();
}
return Error(_env, value);
}
inline MaybeOrValue<Value> Env::RunScript(const char* utf8script) const {
String script = String::New(_env, utf8script);
return RunScript(script);
}
inline MaybeOrValue<Value> Env::RunScript(const std::string& utf8script) const {
return RunScript(utf8script.c_str());
}
inline MaybeOrValue<Value> Env::RunScript(String script) const {
napi_value result;
napi_status status = napi_run_script(_env, script, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(
_env, status, Napi::Value(_env, result), Napi::Value);
}
#if NAPI_VERSION > 2
template <typename Hook, typename Arg>
void Env::CleanupHook<Hook, Arg>::Wrapper(void* data) NAPI_NOEXCEPT {
auto* cleanupData =
static_cast<typename Napi::Env::CleanupHook<Hook, Arg>::CleanupData*>(
data);
cleanupData->hook();
delete cleanupData;
}
template <typename Hook, typename Arg>
void Env::CleanupHook<Hook, Arg>::WrapperWithArg(void* data) NAPI_NOEXCEPT {
auto* cleanupData =
static_cast<typename Napi::Env::CleanupHook<Hook, Arg>::CleanupData*>(
data);
cleanupData->hook(static_cast<Arg*>(cleanupData->arg));
delete cleanupData;
}
#endif // NAPI_VERSION > 2
#if NAPI_VERSION > 5
template <typename T, Env::Finalizer<T> fini>
inline void Env::SetInstanceData(T* data) const {
napi_status status = napi_set_instance_data(
_env,
data,
[](napi_env env, void* data, void*) { fini(env, static_cast<T*>(data)); },
nullptr);
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
template <typename DataType,
typename HintType,
Napi::Env::FinalizerWithHint<DataType, HintType> fini>
inline void Env::SetInstanceData(DataType* data, HintType* hint) const {
napi_status status = napi_set_instance_data(
_env,
data,
[](napi_env env, void* data, void* hint) {
fini(env, static_cast<DataType*>(data), static_cast<HintType*>(hint));
},
hint);
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
template <typename T>
inline T* Env::GetInstanceData() const {
void* data = nullptr;
napi_status status = napi_get_instance_data(_env, &data);
NAPI_THROW_IF_FAILED(_env, status, nullptr);
return static_cast<T*>(data);
}
template <typename T>
void Env::DefaultFini(Env, T* data) {
delete data;
}
template <typename DataType, typename HintType>
void Env::DefaultFiniWithHint(Env, DataType* data, HintType*) {
delete data;
}
#endif // NAPI_VERSION > 5
#if NAPI_VERSION > 8
inline const char* Env::GetModuleFileName() const {
const char* result;
napi_status status = node_api_get_module_file_name(_env, &result);
NAPI_THROW_IF_FAILED(*this, status, nullptr);
return result;
}
#endif // NAPI_VERSION > 8
////////////////////////////////////////////////////////////////////////////////
// Value class
////////////////////////////////////////////////////////////////////////////////
inline Value::Value() : _env(nullptr), _value(nullptr) {}
inline Value::Value(napi_env env, napi_value value)
: _env(env), _value(value) {}
inline Value::operator napi_value() const {
return _value;
}
inline bool Value::operator==(const Value& other) const {
return StrictEquals(other);
}
inline bool Value::operator!=(const Value& other) const {
return !this->operator==(other);
}
inline bool Value::StrictEquals(const Value& other) const {
bool result;
napi_status status = napi_strict_equals(_env, *this, other, &result);
NAPI_THROW_IF_FAILED(_env, status, false);
return result;
}
inline Napi::Env Value::Env() const {
return Napi::Env(_env);
}
inline bool Value::IsEmpty() const {
return _value == nullptr;
}
inline napi_valuetype Value::Type() const {
if (IsEmpty()) {
return napi_undefined;
}
napi_valuetype type;
napi_status status = napi_typeof(_env, _value, &type);
NAPI_THROW_IF_FAILED(_env, status, napi_undefined);
return type;
}
inline bool Value::IsUndefined() const {
return Type() == napi_undefined;
}
inline bool Value::IsNull() const {
return Type() == napi_null;
}
inline bool Value::IsBoolean() const {
return Type() == napi_boolean;
}
inline bool Value::IsNumber() const {
return Type() == napi_number;
}
#if NAPI_VERSION > 5
inline bool Value::IsBigInt() const {
return Type() == napi_bigint;
}
#endif // NAPI_VERSION > 5
#if (NAPI_VERSION > 4)
inline bool Value::IsDate() const {
if (IsEmpty()) {
return false;
}
bool result;
napi_status status = napi_is_date(_env, _value, &result);
NAPI_THROW_IF_FAILED(_env, status, false);
return result;
}
#endif
inline bool Value::IsString() const {
return Type() == napi_string;
}
inline bool Value::IsSymbol() const {
return Type() == napi_symbol;
}
inline bool Value::IsArray() const {
if (IsEmpty()) {
return false;
}
bool result;
napi_status status = napi_is_array(_env, _value, &result);
NAPI_THROW_IF_FAILED(_env, status, false);
return result;
}
inline bool Value::IsArrayBuffer() const {
if (IsEmpty()) {
return false;
}
bool result;
napi_status status = napi_is_arraybuffer(_env, _value, &result);
NAPI_THROW_IF_FAILED(_env, status, false);
return result;
}
inline bool Value::IsTypedArray() const {
if (IsEmpty()) {
return false;
}
bool result;
napi_status status = napi_is_typedarray(_env, _value, &result);
NAPI_THROW_IF_FAILED(_env, status, false);
return result;
}
inline bool Value::IsObject() const {
return Type() == napi_object || IsFunction();
}
inline bool Value::IsFunction() const {
return Type() == napi_function;
}
inline bool Value::IsPromise() const {
if (IsEmpty()) {
return false;
}
bool result;
napi_status status = napi_is_promise(_env, _value, &result);
NAPI_THROW_IF_FAILED(_env, status, false);
return result;
}
inline bool Value::IsDataView() const {
if (IsEmpty()) {
return false;
}
bool result;
napi_status status = napi_is_dataview(_env, _value, &result);
NAPI_THROW_IF_FAILED(_env, status, false);
return result;
}
inline bool Value::IsBuffer() const {
if (IsEmpty()) {
return false;
}
bool result;
napi_status status = napi_is_buffer(_env, _value, &result);
NAPI_THROW_IF_FAILED(_env, status, false);
return result;
}
inline bool Value::IsExternal() const {
return Type() == napi_external;
}
template <typename T>
inline T Value::As() const {
#ifdef NODE_ADDON_API_ENABLE_TYPE_CHECK_ON_AS
T::CheckCast(_env, _value);
#endif
return T(_env, _value);
}
inline MaybeOrValue<Boolean> Value::ToBoolean() const {
napi_value result;
napi_status status = napi_coerce_to_bool(_env, _value, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(
_env, status, Napi::Boolean(_env, result), Napi::Boolean);
}
inline MaybeOrValue<Number> Value::ToNumber() const {
napi_value result;
napi_status status = napi_coerce_to_number(_env, _value, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(
_env, status, Napi::Number(_env, result), Napi::Number);
}
inline MaybeOrValue<String> Value::ToString() const {
napi_value result;
napi_status status = napi_coerce_to_string(_env, _value, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(
_env, status, Napi::String(_env, result), Napi::String);
}
inline MaybeOrValue<Object> Value::ToObject() const {
napi_value result;
napi_status status = napi_coerce_to_object(_env, _value, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(
_env, status, Napi::Object(_env, result), Napi::Object);
}
////////////////////////////////////////////////////////////////////////////////
// Boolean class
////////////////////////////////////////////////////////////////////////////////
inline Boolean Boolean::New(napi_env env, bool val) {
napi_value value;
napi_status status = napi_get_boolean(env, val, &value);
NAPI_THROW_IF_FAILED(env, status, Boolean());
return Boolean(env, value);
}
inline void Boolean::CheckCast(napi_env env, napi_value value) {
NAPI_CHECK(value != nullptr, "Boolean::CheckCast", "empty value");
napi_valuetype type;
napi_status status = napi_typeof(env, value, &type);
NAPI_CHECK(status == napi_ok, "Boolean::CheckCast", "napi_typeof failed");
NAPI_CHECK(
type == napi_boolean, "Boolean::CheckCast", "value is not napi_boolean");
}
inline Boolean::Boolean() : Napi::Value() {}
inline Boolean::Boolean(napi_env env, napi_value value)
: Napi::Value(env, value) {}
inline Boolean::operator bool() const {
return Value();
}
inline bool Boolean::Value() const {
bool result;
napi_status status = napi_get_value_bool(_env, _value, &result);
NAPI_THROW_IF_FAILED(_env, status, false);
return result;
}
////////////////////////////////////////////////////////////////////////////////
// Number class
////////////////////////////////////////////////////////////////////////////////
inline Number Number::New(napi_env env, double val) {
napi_value value;
napi_status status = napi_create_double(env, val, &value);
NAPI_THROW_IF_FAILED(env, status, Number());
return Number(env, value);
}
inline void Number::CheckCast(napi_env env, napi_value value) {
NAPI_CHECK(value != nullptr, "Number::CheckCast", "empty value");
napi_valuetype type;
napi_status status = napi_typeof(env, value, &type);
NAPI_CHECK(status == napi_ok, "Number::CheckCast", "napi_typeof failed");
NAPI_CHECK(
type == napi_number, "Number::CheckCast", "value is not napi_number");
}
inline Number::Number() : Value() {}
inline Number::Number(napi_env env, napi_value value) : Value(env, value) {}
inline Number::operator int32_t() const {
return Int32Value();
}
inline Number::operator uint32_t() const {
return Uint32Value();
}
inline Number::operator int64_t() const {
return Int64Value();
}
inline Number::operator float() const {
return FloatValue();
}
inline Number::operator double() const {
return DoubleValue();
}
inline int32_t Number::Int32Value() const {
int32_t result;
napi_status status = napi_get_value_int32(_env, _value, &result);
NAPI_THROW_IF_FAILED(_env, status, 0);
return result;
}
inline uint32_t Number::Uint32Value() const {
uint32_t result;
napi_status status = napi_get_value_uint32(_env, _value, &result);
NAPI_THROW_IF_FAILED(_env, status, 0);
return result;
}
inline int64_t Number::Int64Value() const {
int64_t result;
napi_status status = napi_get_value_int64(_env, _value, &result);
NAPI_THROW_IF_FAILED(_env, status, 0);
return result;
}
inline float Number::FloatValue() const {
return static_cast<float>(DoubleValue());
}
inline double Number::DoubleValue() const {
double result;
napi_status status = napi_get_value_double(_env, _value, &result);
NAPI_THROW_IF_FAILED(_env, status, 0);
return result;
}
#if NAPI_VERSION > 5
////////////////////////////////////////////////////////////////////////////////
// BigInt Class
////////////////////////////////////////////////////////////////////////////////
inline BigInt BigInt::New(napi_env env, int64_t val) {
napi_value value;
napi_status status = napi_create_bigint_int64(env, val, &value);
NAPI_THROW_IF_FAILED(env, status, BigInt());
return BigInt(env, value);
}
inline BigInt BigInt::New(napi_env env, uint64_t val) {
napi_value value;
napi_status status = napi_create_bigint_uint64(env, val, &value);
NAPI_THROW_IF_FAILED(env, status, BigInt());
return BigInt(env, value);
}
inline BigInt BigInt::New(napi_env env,
int sign_bit,
size_t word_count,
const uint64_t* words) {
napi_value value;
napi_status status =
napi_create_bigint_words(env, sign_bit, word_count, words, &value);
NAPI_THROW_IF_FAILED(env, status, BigInt());
return BigInt(env, value);
}
inline void BigInt::CheckCast(napi_env env, napi_value value) {
NAPI_CHECK(value != nullptr, "BigInt::CheckCast", "empty value");
napi_valuetype type;
napi_status status = napi_typeof(env, value, &type);
NAPI_CHECK(status == napi_ok, "BigInt::CheckCast", "napi_typeof failed");
NAPI_CHECK(
type == napi_bigint, "BigInt::CheckCast", "value is not napi_bigint");
}
inline BigInt::BigInt() : Value() {}
inline BigInt::BigInt(napi_env env, napi_value value) : Value(env, value) {}
inline int64_t BigInt::Int64Value(bool* lossless) const {
int64_t result;
napi_status status =
napi_get_value_bigint_int64(_env, _value, &result, lossless);
NAPI_THROW_IF_FAILED(_env, status, 0);
return result;
}
inline uint64_t BigInt::Uint64Value(bool* lossless) const {
uint64_t result;
napi_status status =
napi_get_value_bigint_uint64(_env, _value, &result, lossless);
NAPI_THROW_IF_FAILED(_env, status, 0);
return result;
}
inline size_t BigInt::WordCount() const {
size_t word_count;
napi_status status =
napi_get_value_bigint_words(_env, _value, nullptr, &word_count, nullptr);
NAPI_THROW_IF_FAILED(_env, status, 0);
return word_count;
}
inline void BigInt::ToWords(int* sign_bit,
size_t* word_count,
uint64_t* words) {
napi_status status =
napi_get_value_bigint_words(_env, _value, sign_bit, word_count, words);
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
#endif // NAPI_VERSION > 5
#if (NAPI_VERSION > 4)
////////////////////////////////////////////////////////////////////////////////
// Date Class
////////////////////////////////////////////////////////////////////////////////
inline Date Date::New(napi_env env, double val) {
napi_value value;
napi_status status = napi_create_date(env, val, &value);
NAPI_THROW_IF_FAILED(env, status, Date());
return Date(env, value);
}
inline void Date::CheckCast(napi_env env, napi_value value) {
NAPI_CHECK(value != nullptr, "Date::CheckCast", "empty value");
bool result;
napi_status status = napi_is_date(env, value, &result);
NAPI_CHECK(status == napi_ok, "Date::CheckCast", "napi_is_date failed");
NAPI_CHECK(result, "Date::CheckCast", "value is not date");
}
inline Date::Date() : Value() {}
inline Date::Date(napi_env env, napi_value value) : Value(env, value) {}
inline Date::operator double() const {
return ValueOf();
}
inline double Date::ValueOf() const {
double result;
napi_status status = napi_get_date_value(_env, _value, &result);
NAPI_THROW_IF_FAILED(_env, status, 0);
return result;
}
#endif
////////////////////////////////////////////////////////////////////////////////
// Name class
////////////////////////////////////////////////////////////////////////////////
inline void Name::CheckCast(napi_env env, napi_value value) {
NAPI_CHECK(value != nullptr, "Name::CheckCast", "empty value");
napi_valuetype type;
napi_status status = napi_typeof(env, value, &type);
NAPI_CHECK(status == napi_ok, "Name::CheckCast", "napi_typeof failed");
NAPI_CHECK(type == napi_string || type == napi_symbol,
"Name::CheckCast",
"value is not napi_string or napi_symbol");
}
inline Name::Name() : Value() {}
inline Name::Name(napi_env env, napi_value value) : Value(env, value) {}
////////////////////////////////////////////////////////////////////////////////
// String class
////////////////////////////////////////////////////////////////////////////////
inline String String::New(napi_env env, const std::string& val) {
return String::New(env, val.c_str(), val.size());
}
inline String String::New(napi_env env, const std::u16string& val) {
return String::New(env, val.c_str(), val.size());
}
inline String String::New(napi_env env, const char* val) {
// TODO(@gabrielschulhof) Remove if-statement when core's error handling is
// available in all supported versions.
if (val == nullptr) {
// Throw an error that looks like it came from core.
NAPI_THROW_IF_FAILED(env, napi_invalid_arg, String());
}
napi_value value;
napi_status status =
napi_create_string_utf8(env, val, std::strlen(val), &value);
NAPI_THROW_IF_FAILED(env, status, String());
return String(env, value);
}
inline String String::New(napi_env env, const char16_t* val) {
napi_value value;
// TODO(@gabrielschulhof) Remove if-statement when core's error handling is
// available in all supported versions.
if (val == nullptr) {
// Throw an error that looks like it came from core.
NAPI_THROW_IF_FAILED(env, napi_invalid_arg, String());
}
napi_status status =
napi_create_string_utf16(env, val, std::u16string(val).size(), &value);
NAPI_THROW_IF_FAILED(env, status, String());
return String(env, value);
}
inline String String::New(napi_env env, const char* val, size_t length) {
napi_value value;
napi_status status = napi_create_string_utf8(env, val, length, &value);
NAPI_THROW_IF_FAILED(env, status, String());
return String(env, value);
}
inline String String::New(napi_env env, const char16_t* val, size_t length) {
napi_value value;
napi_status status = napi_create_string_utf16(env, val, length, &value);
NAPI_THROW_IF_FAILED(env, status, String());
return String(env, value);
}
inline void String::CheckCast(napi_env env, napi_value value) {
NAPI_CHECK(value != nullptr, "String::CheckCast", "empty value");
napi_valuetype type;
napi_status status = napi_typeof(env, value, &type);
NAPI_CHECK(status == napi_ok, "String::CheckCast", "napi_typeof failed");
NAPI_CHECK(
type == napi_string, "String::CheckCast", "value is not napi_string");
}
inline String::String() : Name() {}
inline String::String(napi_env env, napi_value value) : Name(env, value) {}
inline String::operator std::string() const {
return Utf8Value();
}
inline String::operator std::u16string() const {
return Utf16Value();
}
inline std::string String::Utf8Value() const {
size_t length;
napi_status status =
napi_get_value_string_utf8(_env, _value, nullptr, 0, &length);
NAPI_THROW_IF_FAILED(_env, status, "");
std::string value;
value.reserve(length + 1);
value.resize(length);
status = napi_get_value_string_utf8(
_env, _value, &value[0], value.capacity(), nullptr);
NAPI_THROW_IF_FAILED(_env, status, "");
return value;
}
inline std::u16string String::Utf16Value() const {
size_t length;
napi_status status =
napi_get_value_string_utf16(_env, _value, nullptr, 0, &length);
NAPI_THROW_IF_FAILED(_env, status, NAPI_WIDE_TEXT(""));
std::u16string value;
value.reserve(length + 1);
value.resize(length);
status = napi_get_value_string_utf16(
_env, _value, &value[0], value.capacity(), nullptr);
NAPI_THROW_IF_FAILED(_env, status, NAPI_WIDE_TEXT(""));
return value;
}
////////////////////////////////////////////////////////////////////////////////
// Symbol class
////////////////////////////////////////////////////////////////////////////////
inline Symbol Symbol::New(napi_env env, const char* description) {
napi_value descriptionValue = description != nullptr
? String::New(env, description)
: static_cast<napi_value>(nullptr);
return Symbol::New(env, descriptionValue);
}
inline Symbol Symbol::New(napi_env env, const std::string& description) {
napi_value descriptionValue = String::New(env, description);
return Symbol::New(env, descriptionValue);
}
inline Symbol Symbol::New(napi_env env, String description) {
napi_value descriptionValue = description;
return Symbol::New(env, descriptionValue);
}
inline Symbol Symbol::New(napi_env env, napi_value description) {
napi_value value;
napi_status status = napi_create_symbol(env, description, &value);
NAPI_THROW_IF_FAILED(env, status, Symbol());
return Symbol(env, value);
}
inline MaybeOrValue<Symbol> Symbol::WellKnown(napi_env env,
const std::string& name) {
#if defined(NODE_ADDON_API_ENABLE_MAYBE)
Value symbol_obj;
Value symbol_value;
if (Napi::Env(env).Global().Get("Symbol").UnwrapTo(&symbol_obj) &&
symbol_obj.As<Object>().Get(name).UnwrapTo(&symbol_value)) {
return Just<Symbol>(symbol_value.As<Symbol>());
}
return Nothing<Symbol>();
#else
return Napi::Env(env)
.Global()
.Get("Symbol")
.As<Object>()
.Get(name)
.As<Symbol>();
#endif
}
inline MaybeOrValue<Symbol> Symbol::For(napi_env env,
const std::string& description) {
napi_value descriptionValue = String::New(env, description);
return Symbol::For(env, descriptionValue);
}
inline MaybeOrValue<Symbol> Symbol::For(napi_env env, const char* description) {
napi_value descriptionValue = String::New(env, description);
return Symbol::For(env, descriptionValue);
}
inline MaybeOrValue<Symbol> Symbol::For(napi_env env, String description) {
return Symbol::For(env, static_cast<napi_value>(description));
}
inline MaybeOrValue<Symbol> Symbol::For(napi_env env, napi_value description) {
#if defined(NODE_ADDON_API_ENABLE_MAYBE)
Value symbol_obj;
Value symbol_for_value;
Value symbol_value;
if (Napi::Env(env).Global().Get("Symbol").UnwrapTo(&symbol_obj) &&
symbol_obj.As<Object>().Get("for").UnwrapTo(&symbol_for_value) &&
symbol_for_value.As<Function>()
.Call(symbol_obj, {description})
.UnwrapTo(&symbol_value)) {
return Just<Symbol>(symbol_value.As<Symbol>());
}
return Nothing<Symbol>();
#else
Object symbol_obj = Napi::Env(env).Global().Get("Symbol").As<Object>();
return symbol_obj.Get("for")
.As<Function>()
.Call(symbol_obj, {description})
.As<Symbol>();
#endif
}
inline void Symbol::CheckCast(napi_env env, napi_value value) {
NAPI_CHECK(value != nullptr, "Symbol::CheckCast", "empty value");
napi_valuetype type;
napi_status status = napi_typeof(env, value, &type);
NAPI_CHECK(status == napi_ok, "Symbol::CheckCast", "napi_typeof failed");
NAPI_CHECK(
type == napi_symbol, "Symbol::CheckCast", "value is not napi_symbol");
}
inline Symbol::Symbol() : Name() {}
inline Symbol::Symbol(napi_env env, napi_value value) : Name(env, value) {}
////////////////////////////////////////////////////////////////////////////////
// Automagic value creation
////////////////////////////////////////////////////////////////////////////////
namespace details {
template <typename T>
struct vf_number {
static Number From(napi_env env, T value) {
return Number::New(env, static_cast<double>(value));
}
};
template <>
struct vf_number<bool> {
static Boolean From(napi_env env, bool value) {
return Boolean::New(env, value);
}
};
struct vf_utf8_charp {
static String From(napi_env env, const char* value) {
return String::New(env, value);
}
};
struct vf_utf16_charp {
static String From(napi_env env, const char16_t* value) {
return String::New(env, value);
}
};
struct vf_utf8_string {
static String From(napi_env env, const std::string& value) {
return String::New(env, value);
}
};
struct vf_utf16_string {
static String From(napi_env env, const std::u16string& value) {
return String::New(env, value);
}
};
template <typename T>
struct vf_fallback {
static Value From(napi_env env, const T& value) { return Value(env, value); }
};
template <typename...>
struct disjunction : std::false_type {};
template <typename B>
struct disjunction<B> : B {};
template <typename B, typename... Bs>
struct disjunction<B, Bs...>
: std::conditional<bool(B::value), B, disjunction<Bs...>>::type {};
template <typename T>
struct can_make_string
: disjunction<typename std::is_convertible<T, const char*>::type,
typename std::is_convertible<T, const char16_t*>::type,
typename std::is_convertible<T, std::string>::type,
typename std::is_convertible<T, std::u16string>::type> {};
} // namespace details
template <typename T>
Value Value::From(napi_env env, const T& value) {
using Helper = typename std::conditional<
std::is_integral<T>::value || std::is_floating_point<T>::value,
details::vf_number<T>,
typename std::conditional<details::can_make_string<T>::value,
String,
details::vf_fallback<T>>::type>::type;
return Helper::From(env, value);
}
template <typename T>
String String::From(napi_env env, const T& value) {
struct Dummy {};
using Helper = typename std::conditional<
std::is_convertible<T, const char*>::value,
details::vf_utf8_charp,
typename std::conditional<
std::is_convertible<T, const char16_t*>::value,
details::vf_utf16_charp,
typename std::conditional<
std::is_convertible<T, std::string>::value,
details::vf_utf8_string,
typename std::conditional<
std::is_convertible<T, std::u16string>::value,
details::vf_utf16_string,
Dummy>::type>::type>::type>::type;
return Helper::From(env, value);
}
////////////////////////////////////////////////////////////////////////////////
// TypeTaggable class
////////////////////////////////////////////////////////////////////////////////
inline TypeTaggable::TypeTaggable() : Value() {}
inline TypeTaggable::TypeTaggable(napi_env _env, napi_value _value)
: Value(_env, _value) {}
#if NAPI_VERSION >= 8
inline void TypeTaggable::TypeTag(const napi_type_tag* type_tag) const {
napi_status status = napi_type_tag_object(_env, _value, type_tag);
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
inline bool TypeTaggable::CheckTypeTag(const napi_type_tag* type_tag) const {
bool result;
napi_status status =
napi_check_object_type_tag(_env, _value, type_tag, &result);
NAPI_THROW_IF_FAILED(_env, status, false);
return result;
}
#endif // NAPI_VERSION >= 8
////////////////////////////////////////////////////////////////////////////////
// Object class
////////////////////////////////////////////////////////////////////////////////
template <typename Key>
inline Object::PropertyLValue<Key>::operator Value() const {
MaybeOrValue<Value> val = Object(_env, _object).Get(_key);
#ifdef NODE_ADDON_API_ENABLE_MAYBE
return val.Unwrap();
#else
return val;
#endif
}
template <typename Key>
template <typename ValueType>
inline Object::PropertyLValue<Key>& Object::PropertyLValue<Key>::operator=(
ValueType value) {
#ifdef NODE_ADDON_API_ENABLE_MAYBE
MaybeOrValue<bool> result =
#endif
Object(_env, _object).Set(_key, value);
#ifdef NODE_ADDON_API_ENABLE_MAYBE
result.Unwrap();
#endif
return *this;
}
template <typename Key>
inline Object::PropertyLValue<Key>::PropertyLValue(Object object, Key key)
: _env(object.Env()), _object(object), _key(key) {}
inline Object Object::New(napi_env env) {
napi_value value;
napi_status status = napi_create_object(env, &value);
NAPI_THROW_IF_FAILED(env, status, Object());
return Object(env, value);
}
inline void Object::CheckCast(napi_env env, napi_value value) {
NAPI_CHECK(value != nullptr, "Object::CheckCast", "empty value");
napi_valuetype type;
napi_status status = napi_typeof(env, value, &type);
NAPI_CHECK(status == napi_ok, "Object::CheckCast", "napi_typeof failed");
NAPI_CHECK(
type == napi_object, "Object::CheckCast", "value is not napi_object");
}
inline Object::Object() : TypeTaggable() {}
inline Object::Object(napi_env env, napi_value value)
: TypeTaggable(env, value) {}
inline Object::PropertyLValue<std::string> Object::operator[](
const char* utf8name) {
return PropertyLValue<std::string>(*this, utf8name);
}
inline Object::PropertyLValue<std::string> Object::operator[](
const std::string& utf8name) {
return PropertyLValue<std::string>(*this, utf8name);
}
inline Object::PropertyLValue<uint32_t> Object::operator[](uint32_t index) {
return PropertyLValue<uint32_t>(*this, index);
}
inline Object::PropertyLValue<Value> Object::operator[](Value index) const {
return PropertyLValue<Value>(*this, index);
}
inline MaybeOrValue<Value> Object::operator[](const char* utf8name) const {
return Get(utf8name);
}
inline MaybeOrValue<Value> Object::operator[](
const std::string& utf8name) const {
return Get(utf8name);
}
inline MaybeOrValue<Value> Object::operator[](uint32_t index) const {
return Get(index);
}
inline MaybeOrValue<bool> Object::Has(napi_value key) const {
bool result;
napi_status status = napi_has_property(_env, _value, key, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, result, bool);
}
inline MaybeOrValue<bool> Object::Has(Value key) const {
bool result;
napi_status status = napi_has_property(_env, _value, key, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, result, bool);
}
inline MaybeOrValue<bool> Object::Has(const char* utf8name) const {
bool result;
napi_status status = napi_has_named_property(_env, _value, utf8name, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, result, bool);
}
inline MaybeOrValue<bool> Object::Has(const std::string& utf8name) const {
return Has(utf8name.c_str());
}
inline MaybeOrValue<bool> Object::HasOwnProperty(napi_value key) const {
bool result;
napi_status status = napi_has_own_property(_env, _value, key, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, result, bool);
}
inline MaybeOrValue<bool> Object::HasOwnProperty(Value key) const {
bool result;
napi_status status = napi_has_own_property(_env, _value, key, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, result, bool);
}
inline MaybeOrValue<bool> Object::HasOwnProperty(const char* utf8name) const {
napi_value key;
napi_status status =
napi_create_string_utf8(_env, utf8name, std::strlen(utf8name), &key);
NAPI_MAYBE_THROW_IF_FAILED(_env, status, bool);
return HasOwnProperty(key);
}
inline MaybeOrValue<bool> Object::HasOwnProperty(
const std::string& utf8name) const {
return HasOwnProperty(utf8name.c_str());
}
inline MaybeOrValue<Value> Object::Get(napi_value key) const {
napi_value result;
napi_status status = napi_get_property(_env, _value, key, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, Value(_env, result), Value);
}
inline MaybeOrValue<Value> Object::Get(Value key) const {
napi_value result;
napi_status status = napi_get_property(_env, _value, key, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, Value(_env, result), Value);
}
inline MaybeOrValue<Value> Object::Get(const char* utf8name) const {
napi_value result;
napi_status status = napi_get_named_property(_env, _value, utf8name, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, Value(_env, result), Value);
}
inline MaybeOrValue<Value> Object::Get(const std::string& utf8name) const {
return Get(utf8name.c_str());
}
template <typename ValueType>
inline MaybeOrValue<bool> Object::Set(napi_value key,
const ValueType& value) const {
napi_status status =
napi_set_property(_env, _value, key, Value::From(_env, value));
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, status == napi_ok, bool);
}
template <typename ValueType>
inline MaybeOrValue<bool> Object::Set(Value key, const ValueType& value) const {
napi_status status =
napi_set_property(_env, _value, key, Value::From(_env, value));
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, status == napi_ok, bool);
}
template <typename ValueType>
inline MaybeOrValue<bool> Object::Set(const char* utf8name,
const ValueType& value) const {
napi_status status =
napi_set_named_property(_env, _value, utf8name, Value::From(_env, value));
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, status == napi_ok, bool);
}
template <typename ValueType>
inline MaybeOrValue<bool> Object::Set(const std::string& utf8name,
const ValueType& value) const {
return Set(utf8name.c_str(), value);
}
inline MaybeOrValue<bool> Object::Delete(napi_value key) const {
bool result;
napi_status status = napi_delete_property(_env, _value, key, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, result, bool);
}
inline MaybeOrValue<bool> Object::Delete(Value key) const {
bool result;
napi_status status = napi_delete_property(_env, _value, key, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, result, bool);
}
inline MaybeOrValue<bool> Object::Delete(const char* utf8name) const {
return Delete(String::New(_env, utf8name));
}
inline MaybeOrValue<bool> Object::Delete(const std::string& utf8name) const {
return Delete(String::New(_env, utf8name));
}
inline MaybeOrValue<bool> Object::Has(uint32_t index) const {
bool result;
napi_status status = napi_has_element(_env, _value, index, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, result, bool);
}
inline MaybeOrValue<Value> Object::Get(uint32_t index) const {
napi_value value;
napi_status status = napi_get_element(_env, _value, index, &value);
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, Value(_env, value), Value);
}
template <typename ValueType>
inline MaybeOrValue<bool> Object::Set(uint32_t index,
const ValueType& value) const {
napi_status status =
napi_set_element(_env, _value, index, Value::From(_env, value));
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, status == napi_ok, bool);
}
inline MaybeOrValue<bool> Object::Delete(uint32_t index) const {
bool result;
napi_status status = napi_delete_element(_env, _value, index, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, result, bool);
}
inline MaybeOrValue<Array> Object::GetPropertyNames() const {
napi_value result;
napi_status status = napi_get_property_names(_env, _value, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, Array(_env, result), Array);
}
inline MaybeOrValue<bool> Object::DefineProperty(
const PropertyDescriptor& property) const {
napi_status status = napi_define_properties(
_env,
_value,
1,
reinterpret_cast<const napi_property_descriptor*>(&property));
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, status == napi_ok, bool);
}
inline MaybeOrValue<bool> Object::DefineProperties(
const std::initializer_list<PropertyDescriptor>& properties) const {
napi_status status = napi_define_properties(
_env,
_value,
properties.size(),
reinterpret_cast<const napi_property_descriptor*>(properties.begin()));
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, status == napi_ok, bool);
}
inline MaybeOrValue<bool> Object::DefineProperties(
const std::vector<PropertyDescriptor>& properties) const {
napi_status status = napi_define_properties(
_env,
_value,
properties.size(),
reinterpret_cast<const napi_property_descriptor*>(properties.data()));
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, status == napi_ok, bool);
}
inline MaybeOrValue<bool> Object::InstanceOf(
const Function& constructor) const {
bool result;
napi_status status = napi_instanceof(_env, _value, constructor, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, result, bool);
}
template <typename Finalizer, typename T>
inline void Object::AddFinalizer(Finalizer finalizeCallback, T* data) const {
details::FinalizeData<T, Finalizer>* finalizeData =
new details::FinalizeData<T, Finalizer>(
{std::move(finalizeCallback), nullptr});
napi_status status =
details::AttachData<T, details::FinalizeData<T, Finalizer>::Wrapper>(
_env, *this, data, finalizeData);
if (status != napi_ok) {
delete finalizeData;
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
}
template <typename Finalizer, typename T, typename Hint>
inline void Object::AddFinalizer(Finalizer finalizeCallback,
T* data,
Hint* finalizeHint) const {
details::FinalizeData<T, Finalizer, Hint>* finalizeData =
new details::FinalizeData<T, Finalizer, Hint>(
{std::move(finalizeCallback), finalizeHint});
napi_status status = details::
AttachData<T, details::FinalizeData<T, Finalizer, Hint>::WrapperWithHint>(
_env, *this, data, finalizeData);
if (status != napi_ok) {
delete finalizeData;
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
}
#ifdef NAPI_CPP_EXCEPTIONS
inline Object::const_iterator::const_iterator(const Object* object,
const Type type) {
_object = object;
_keys = object->GetPropertyNames();
_index = type == Type::BEGIN ? 0 : _keys.Length();
}
inline Object::const_iterator Napi::Object::begin() const {
const_iterator it(this, Object::const_iterator::Type::BEGIN);
return it;
}
inline Object::const_iterator Napi::Object::end() const {
const_iterator it(this, Object::const_iterator::Type::END);
return it;
}
inline Object::const_iterator& Object::const_iterator::operator++() {
++_index;
return *this;
}
inline bool Object::const_iterator::operator==(
const const_iterator& other) const {
return _index == other._index;
}
inline bool Object::const_iterator::operator!=(
const const_iterator& other) const {
return _index != other._index;
}
inline const std::pair<Value, Object::PropertyLValue<Value>>
Object::const_iterator::operator*() const {
const Value key = _keys[_index];
const PropertyLValue<Value> value = (*_object)[key];
return {key, value};
}
inline Object::iterator::iterator(Object* object, const Type type) {
_object = object;
_keys = object->GetPropertyNames();
_index = type == Type::BEGIN ? 0 : _keys.Length();
}
inline Object::iterator Napi::Object::begin() {
iterator it(this, Object::iterator::Type::BEGIN);
return it;
}
inline Object::iterator Napi::Object::end() {
iterator it(this, Object::iterator::Type::END);
return it;
}
inline Object::iterator& Object::iterator::operator++() {
++_index;
return *this;
}
inline bool Object::iterator::operator==(const iterator& other) const {
return _index == other._index;
}
inline bool Object::iterator::operator!=(const iterator& other) const {
return _index != other._index;
}
inline std::pair<Value, Object::PropertyLValue<Value>>
Object::iterator::operator*() {
Value key = _keys[_index];
PropertyLValue<Value> value = (*_object)[key];
return {key, value};
}
#endif // NAPI_CPP_EXCEPTIONS
#if NAPI_VERSION >= 8
inline MaybeOrValue<bool> Object::Freeze() const {
napi_status status = napi_object_freeze(_env, _value);
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, status == napi_ok, bool);
}
inline MaybeOrValue<bool> Object::Seal() const {
napi_status status = napi_object_seal(_env, _value);
NAPI_RETURN_OR_THROW_IF_FAILED(_env, status, status == napi_ok, bool);
}
#endif // NAPI_VERSION >= 8
////////////////////////////////////////////////////////////////////////////////
// External class
////////////////////////////////////////////////////////////////////////////////
template <typename T>
inline External<T> External<T>::New(napi_env env, T* data) {
napi_value value;
napi_status status =
napi_create_external(env, data, nullptr, nullptr, &value);
NAPI_THROW_IF_FAILED(env, status, External());
return External(env, value);
}
template <typename T>
template <typename Finalizer>
inline External<T> External<T>::New(napi_env env,
T* data,
Finalizer finalizeCallback) {
napi_value value;
details::FinalizeData<T, Finalizer>* finalizeData =
new details::FinalizeData<T, Finalizer>(
{std::move(finalizeCallback), nullptr});
napi_status status =
napi_create_external(env,
data,
details::FinalizeData<T, Finalizer>::Wrapper,
finalizeData,
&value);
if (status != napi_ok) {
delete finalizeData;
NAPI_THROW_IF_FAILED(env, status, External());
}
return External(env, value);
}
template <typename T>
template <typename Finalizer, typename Hint>
inline External<T> External<T>::New(napi_env env,
T* data,
Finalizer finalizeCallback,
Hint* finalizeHint) {
napi_value value;
details::FinalizeData<T, Finalizer, Hint>* finalizeData =
new details::FinalizeData<T, Finalizer, Hint>(
{std::move(finalizeCallback), finalizeHint});
napi_status status = napi_create_external(
env,
data,
details::FinalizeData<T, Finalizer, Hint>::WrapperWithHint,
finalizeData,
&value);
if (status != napi_ok) {
delete finalizeData;
NAPI_THROW_IF_FAILED(env, status, External());
}
return External(env, value);
}
template <typename T>
inline void External<T>::CheckCast(napi_env env, napi_value value) {
NAPI_CHECK(value != nullptr, "External::CheckCast", "empty value");
napi_valuetype type;
napi_status status = napi_typeof(env, value, &type);
NAPI_CHECK(status == napi_ok, "External::CheckCast", "napi_typeof failed");
NAPI_CHECK(type == napi_external,
"External::CheckCast",
"value is not napi_external");
}
template <typename T>
inline External<T>::External() : TypeTaggable() {}
template <typename T>
inline External<T>::External(napi_env env, napi_value value)
: TypeTaggable(env, value) {}
template <typename T>
inline T* External<T>::Data() const {
void* data;
napi_status status = napi_get_value_external(_env, _value, &data);
NAPI_THROW_IF_FAILED(_env, status, nullptr);
return reinterpret_cast<T*>(data);
}
////////////////////////////////////////////////////////////////////////////////
// Array class
////////////////////////////////////////////////////////////////////////////////
inline Array Array::New(napi_env env) {
napi_value value;
napi_status status = napi_create_array(env, &value);
NAPI_THROW_IF_FAILED(env, status, Array());
return Array(env, value);
}
inline Array Array::New(napi_env env, size_t length) {
napi_value value;
napi_status status = napi_create_array_with_length(env, length, &value);
NAPI_THROW_IF_FAILED(env, status, Array());
return Array(env, value);
}
inline void Array::CheckCast(napi_env env, napi_value value) {
NAPI_CHECK(value != nullptr, "Array::CheckCast", "empty value");
bool result;
napi_status status = napi_is_array(env, value, &result);
NAPI_CHECK(status == napi_ok, "Array::CheckCast", "napi_is_array failed");
NAPI_CHECK(result, "Array::CheckCast", "value is not array");
}
inline Array::Array() : Object() {}
inline Array::Array(napi_env env, napi_value value) : Object(env, value) {}
inline uint32_t Array::Length() const {
uint32_t result;
napi_status status = napi_get_array_length(_env, _value, &result);
NAPI_THROW_IF_FAILED(_env, status, 0);
return result;
}
////////////////////////////////////////////////////////////////////////////////
// ArrayBuffer class
////////////////////////////////////////////////////////////////////////////////
inline ArrayBuffer ArrayBuffer::New(napi_env env, size_t byteLength) {
napi_value value;
void* data;
napi_status status = napi_create_arraybuffer(env, byteLength, &data, &value);
NAPI_THROW_IF_FAILED(env, status, ArrayBuffer());
return ArrayBuffer(env, value);
}
#ifndef NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
inline ArrayBuffer ArrayBuffer::New(napi_env env,
void* externalData,
size_t byteLength) {
napi_value value;
napi_status status = napi_create_external_arraybuffer(
env, externalData, byteLength, nullptr, nullptr, &value);
NAPI_THROW_IF_FAILED(env, status, ArrayBuffer());
return ArrayBuffer(env, value);
}
template <typename Finalizer>
inline ArrayBuffer ArrayBuffer::New(napi_env env,
void* externalData,
size_t byteLength,
Finalizer finalizeCallback) {
napi_value value;
details::FinalizeData<void, Finalizer>* finalizeData =
new details::FinalizeData<void, Finalizer>(
{std::move(finalizeCallback), nullptr});
napi_status status = napi_create_external_arraybuffer(
env,
externalData,
byteLength,
details::FinalizeData<void, Finalizer>::Wrapper,
finalizeData,
&value);
if (status != napi_ok) {
delete finalizeData;
NAPI_THROW_IF_FAILED(env, status, ArrayBuffer());
}
return ArrayBuffer(env, value);
}
template <typename Finalizer, typename Hint>
inline ArrayBuffer ArrayBuffer::New(napi_env env,
void* externalData,
size_t byteLength,
Finalizer finalizeCallback,
Hint* finalizeHint) {
napi_value value;
details::FinalizeData<void, Finalizer, Hint>* finalizeData =
new details::FinalizeData<void, Finalizer, Hint>(
{std::move(finalizeCallback), finalizeHint});
napi_status status = napi_create_external_arraybuffer(
env,
externalData,
byteLength,
details::FinalizeData<void, Finalizer, Hint>::WrapperWithHint,
finalizeData,
&value);
if (status != napi_ok) {
delete finalizeData;
NAPI_THROW_IF_FAILED(env, status, ArrayBuffer());
}
return ArrayBuffer(env, value);
}
#endif // NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
inline void ArrayBuffer::CheckCast(napi_env env, napi_value value) {
NAPI_CHECK(value != nullptr, "ArrayBuffer::CheckCast", "empty value");
bool result;
napi_status status = napi_is_arraybuffer(env, value, &result);
NAPI_CHECK(status == napi_ok,
"ArrayBuffer::CheckCast",
"napi_is_arraybuffer failed");
NAPI_CHECK(result, "ArrayBuffer::CheckCast", "value is not arraybuffer");
}
inline ArrayBuffer::ArrayBuffer() : Object() {}
inline ArrayBuffer::ArrayBuffer(napi_env env, napi_value value)
: Object(env, value) {}
inline void* ArrayBuffer::Data() {
void* data;
napi_status status = napi_get_arraybuffer_info(_env, _value, &data, nullptr);
NAPI_THROW_IF_FAILED(_env, status, nullptr);
return data;
}
inline size_t ArrayBuffer::ByteLength() {
size_t length;
napi_status status =
napi_get_arraybuffer_info(_env, _value, nullptr, &length);
NAPI_THROW_IF_FAILED(_env, status, 0);
return length;
}
#if NAPI_VERSION >= 7
inline bool ArrayBuffer::IsDetached() const {
bool detached;
napi_status status = napi_is_detached_arraybuffer(_env, _value, &detached);
NAPI_THROW_IF_FAILED(_env, status, false);
return detached;
}
inline void ArrayBuffer::Detach() {
napi_status status = napi_detach_arraybuffer(_env, _value);
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
#endif // NAPI_VERSION >= 7
////////////////////////////////////////////////////////////////////////////////
// DataView class
////////////////////////////////////////////////////////////////////////////////
inline DataView DataView::New(napi_env env, Napi::ArrayBuffer arrayBuffer) {
return New(env, arrayBuffer, 0, arrayBuffer.ByteLength());
}
inline DataView DataView::New(napi_env env,
Napi::ArrayBuffer arrayBuffer,
size_t byteOffset) {
if (byteOffset > arrayBuffer.ByteLength()) {
NAPI_THROW(RangeError::New(
env, "Start offset is outside the bounds of the buffer"),
DataView());
}
return New(
env, arrayBuffer, byteOffset, arrayBuffer.ByteLength() - byteOffset);
}
inline DataView DataView::New(napi_env env,
Napi::ArrayBuffer arrayBuffer,
size_t byteOffset,
size_t byteLength) {
if (byteOffset + byteLength > arrayBuffer.ByteLength()) {
NAPI_THROW(RangeError::New(env, "Invalid DataView length"), DataView());
}
napi_value value;
napi_status status =
napi_create_dataview(env, byteLength, arrayBuffer, byteOffset, &value);
NAPI_THROW_IF_FAILED(env, status, DataView());
return DataView(env, value);
}
inline void DataView::CheckCast(napi_env env, napi_value value) {
NAPI_CHECK(value != nullptr, "DataView::CheckCast", "empty value");
bool result;
napi_status status = napi_is_dataview(env, value, &result);
NAPI_CHECK(
status == napi_ok, "DataView::CheckCast", "napi_is_dataview failed");
NAPI_CHECK(result, "DataView::CheckCast", "value is not dataview");
}
inline DataView::DataView() : Object() {}
inline DataView::DataView(napi_env env, napi_value value) : Object(env, value) {
napi_status status = napi_get_dataview_info(_env,
_value /* dataView */,
&_length /* byteLength */,
&_data /* data */,
nullptr /* arrayBuffer */,
nullptr /* byteOffset */);
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
inline Napi::ArrayBuffer DataView::ArrayBuffer() const {
napi_value arrayBuffer;
napi_status status = napi_get_dataview_info(_env,
_value /* dataView */,
nullptr /* byteLength */,
nullptr /* data */,
&arrayBuffer /* arrayBuffer */,
nullptr /* byteOffset */);
NAPI_THROW_IF_FAILED(_env, status, Napi::ArrayBuffer());
return Napi::ArrayBuffer(_env, arrayBuffer);
}
inline size_t DataView::ByteOffset() const {
size_t byteOffset;
napi_status status = napi_get_dataview_info(_env,
_value /* dataView */,
nullptr /* byteLength */,
nullptr /* data */,
nullptr /* arrayBuffer */,
&byteOffset /* byteOffset */);
NAPI_THROW_IF_FAILED(_env, status, 0);
return byteOffset;
}
inline size_t DataView::ByteLength() const {
return _length;
}
inline void* DataView::Data() const {
return _data;
}
inline float DataView::GetFloat32(size_t byteOffset) const {
return ReadData<float>(byteOffset);
}
inline double DataView::GetFloat64(size_t byteOffset) const {
return ReadData<double>(byteOffset);
}
inline int8_t DataView::GetInt8(size_t byteOffset) const {
return ReadData<int8_t>(byteOffset);
}
inline int16_t DataView::GetInt16(size_t byteOffset) const {
return ReadData<int16_t>(byteOffset);
}
inline int32_t DataView::GetInt32(size_t byteOffset) const {
return ReadData<int32_t>(byteOffset);
}
inline uint8_t DataView::GetUint8(size_t byteOffset) const {
return ReadData<uint8_t>(byteOffset);
}
inline uint16_t DataView::GetUint16(size_t byteOffset) const {
return ReadData<uint16_t>(byteOffset);
}
inline uint32_t DataView::GetUint32(size_t byteOffset) const {
return ReadData<uint32_t>(byteOffset);
}
inline void DataView::SetFloat32(size_t byteOffset, float value) const {
WriteData<float>(byteOffset, value);
}
inline void DataView::SetFloat64(size_t byteOffset, double value) const {
WriteData<double>(byteOffset, value);
}
inline void DataView::SetInt8(size_t byteOffset, int8_t value) const {
WriteData<int8_t>(byteOffset, value);
}
inline void DataView::SetInt16(size_t byteOffset, int16_t value) const {
WriteData<int16_t>(byteOffset, value);
}
inline void DataView::SetInt32(size_t byteOffset, int32_t value) const {
WriteData<int32_t>(byteOffset, value);
}
inline void DataView::SetUint8(size_t byteOffset, uint8_t value) const {
WriteData<uint8_t>(byteOffset, value);
}
inline void DataView::SetUint16(size_t byteOffset, uint16_t value) const {
WriteData<uint16_t>(byteOffset, value);
}
inline void DataView::SetUint32(size_t byteOffset, uint32_t value) const {
WriteData<uint32_t>(byteOffset, value);
}
template <typename T>
inline T DataView::ReadData(size_t byteOffset) const {
if (byteOffset + sizeof(T) > _length ||
byteOffset + sizeof(T) < byteOffset) { // overflow
NAPI_THROW(
RangeError::New(_env, "Offset is outside the bounds of the DataView"),
0);
}
return *reinterpret_cast<T*>(static_cast<uint8_t*>(_data) + byteOffset);
}
template <typename T>
inline void DataView::WriteData(size_t byteOffset, T value) const {
if (byteOffset + sizeof(T) > _length ||
byteOffset + sizeof(T) < byteOffset) { // overflow
NAPI_THROW_VOID(
RangeError::New(_env, "Offset is outside the bounds of the DataView"));
}
*reinterpret_cast<T*>(static_cast<uint8_t*>(_data) + byteOffset) = value;
}
////////////////////////////////////////////////////////////////////////////////
// TypedArray class
////////////////////////////////////////////////////////////////////////////////
inline void TypedArray::CheckCast(napi_env env, napi_value value) {
NAPI_CHECK(value != nullptr, "TypedArray::CheckCast", "empty value");
bool result;
napi_status status = napi_is_typedarray(env, value, &result);
NAPI_CHECK(
status == napi_ok, "TypedArray::CheckCast", "napi_is_typedarray failed");
NAPI_CHECK(result, "TypedArray::CheckCast", "value is not typedarray");
}
inline TypedArray::TypedArray()
: Object(), _type(napi_typedarray_type::napi_int8_array), _length(0) {}
inline TypedArray::TypedArray(napi_env env, napi_value value)
: Object(env, value),
_type(napi_typedarray_type::napi_int8_array),
_length(0) {
if (value != nullptr) {
napi_status status =
napi_get_typedarray_info(_env,
_value,
&const_cast<TypedArray*>(this)->_type,
&const_cast<TypedArray*>(this)->_length,
nullptr,
nullptr,
nullptr);
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
}
inline TypedArray::TypedArray(napi_env env,
napi_value value,
napi_typedarray_type type,
size_t length)
: Object(env, value), _type(type), _length(length) {}
inline napi_typedarray_type TypedArray::TypedArrayType() const {
return _type;
}
inline uint8_t TypedArray::ElementSize() const {
switch (_type) {
case napi_int8_array:
case napi_uint8_array:
case napi_uint8_clamped_array:
return 1;
case napi_int16_array:
case napi_uint16_array:
return 2;
case napi_int32_array:
case napi_uint32_array:
case napi_float32_array:
return 4;
case napi_float64_array:
#if (NAPI_VERSION > 5)
case napi_bigint64_array:
case napi_biguint64_array:
#endif // (NAPI_VERSION > 5)
return 8;
default:
return 0;
}
}
inline size_t TypedArray::ElementLength() const {
return _length;
}
inline size_t TypedArray::ByteOffset() const {
size_t byteOffset;
napi_status status = napi_get_typedarray_info(
_env, _value, nullptr, nullptr, nullptr, nullptr, &byteOffset);
NAPI_THROW_IF_FAILED(_env, status, 0);
return byteOffset;
}
inline size_t TypedArray::ByteLength() const {
return ElementSize() * ElementLength();
}
inline Napi::ArrayBuffer TypedArray::ArrayBuffer() const {
napi_value arrayBuffer;
napi_status status = napi_get_typedarray_info(
_env, _value, nullptr, nullptr, nullptr, &arrayBuffer, nullptr);
NAPI_THROW_IF_FAILED(_env, status, Napi::ArrayBuffer());
return Napi::ArrayBuffer(_env, arrayBuffer);
}
////////////////////////////////////////////////////////////////////////////////
// TypedArrayOf<T> class
////////////////////////////////////////////////////////////////////////////////
template <typename T>
inline void TypedArrayOf<T>::CheckCast(napi_env env, napi_value value) {
TypedArray::CheckCast(env, value);
napi_typedarray_type type;
napi_status status = napi_get_typedarray_info(
env, value, &type, nullptr, nullptr, nullptr, nullptr);
NAPI_CHECK(status == napi_ok,
"TypedArrayOf::CheckCast",
"napi_is_typedarray failed");
NAPI_CHECK(
(type == TypedArrayTypeForPrimitiveType<T>() ||
(type == napi_uint8_clamped_array && std::is_same<T, uint8_t>::value)),
"TypedArrayOf::CheckCast",
"Array type must match the template parameter. (Uint8 arrays may "
"optionally have the \"clamped\" array type.)");
}
template <typename T>
inline TypedArrayOf<T> TypedArrayOf<T>::New(napi_env env,
size_t elementLength,
napi_typedarray_type type) {
Napi::ArrayBuffer arrayBuffer =
Napi::ArrayBuffer::New(env, elementLength * sizeof(T));
return New(env, elementLength, arrayBuffer, 0, type);
}
template <typename T>
inline TypedArrayOf<T> TypedArrayOf<T>::New(napi_env env,
size_t elementLength,
Napi::ArrayBuffer arrayBuffer,
size_t bufferOffset,
napi_typedarray_type type) {
napi_value value;
napi_status status = napi_create_typedarray(
env, type, elementLength, arrayBuffer, bufferOffset, &value);
NAPI_THROW_IF_FAILED(env, status, TypedArrayOf<T>());
return TypedArrayOf<T>(
env,
value,
type,
elementLength,
reinterpret_cast<T*>(reinterpret_cast<uint8_t*>(arrayBuffer.Data()) +
bufferOffset));
}
template <typename T>
inline TypedArrayOf<T>::TypedArrayOf() : TypedArray(), _data(nullptr) {}
template <typename T>
inline TypedArrayOf<T>::TypedArrayOf(napi_env env, napi_value value)
: TypedArray(env, value), _data(nullptr) {
napi_status status = napi_ok;
if (value != nullptr) {
void* data = nullptr;
status = napi_get_typedarray_info(
_env, _value, &_type, &_length, &data, nullptr, nullptr);
_data = static_cast<T*>(data);
} else {
_type = TypedArrayTypeForPrimitiveType<T>();
_length = 0;
}
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
template <typename T>
inline TypedArrayOf<T>::TypedArrayOf(napi_env env,
napi_value value,
napi_typedarray_type type,
size_t length,
T* data)
: TypedArray(env, value, type, length), _data(data) {
if (!(type == TypedArrayTypeForPrimitiveType<T>() ||
(type == napi_uint8_clamped_array &&
std::is_same<T, uint8_t>::value))) {
NAPI_THROW_VOID(TypeError::New(
env,
"Array type must match the template parameter. "
"(Uint8 arrays may optionally have the \"clamped\" array type.)"));
}
}
template <typename T>
inline T& TypedArrayOf<T>::operator[](size_t index) {
return _data[index];
}
template <typename T>
inline const T& TypedArrayOf<T>::operator[](size_t index) const {
return _data[index];
}
template <typename T>
inline T* TypedArrayOf<T>::Data() {
return _data;
}
template <typename T>
inline const T* TypedArrayOf<T>::Data() const {
return _data;
}
////////////////////////////////////////////////////////////////////////////////
// Function class
////////////////////////////////////////////////////////////////////////////////
template <typename CbData>
inline napi_status CreateFunction(napi_env env,
const char* utf8name,
napi_callback cb,
CbData* data,
napi_value* result) {
napi_status status =
napi_create_function(env, utf8name, NAPI_AUTO_LENGTH, cb, data, result);
if (status == napi_ok) {
status = Napi::details::AttachData(env, *result, data);
}
return status;
}
template <Function::VoidCallback cb>
inline Function Function::New(napi_env env, const char* utf8name, void* data) {
napi_value result = nullptr;
napi_status status = napi_create_function(env,
utf8name,
NAPI_AUTO_LENGTH,
details::TemplatedVoidCallback<cb>,
data,
&result);
NAPI_THROW_IF_FAILED(env, status, Function());
return Function(env, result);
}
template <Function::Callback cb>
inline Function Function::New(napi_env env, const char* utf8name, void* data) {
napi_value result = nullptr;
napi_status status = napi_create_function(env,
utf8name,
NAPI_AUTO_LENGTH,
details::TemplatedCallback<cb>,
data,
&result);
NAPI_THROW_IF_FAILED(env, status, Function());
return Function(env, result);
}
template <Function::VoidCallback cb>
inline Function Function::New(napi_env env,
const std::string& utf8name,
void* data) {
return Function::New<cb>(env, utf8name.c_str(), data);
}
template <Function::Callback cb>
inline Function Function::New(napi_env env,
const std::string& utf8name,
void* data) {
return Function::New<cb>(env, utf8name.c_str(), data);
}
template <typename Callable>
inline Function Function::New(napi_env env,
Callable cb,
const char* utf8name,
void* data) {
using ReturnType = decltype(cb(CallbackInfo(nullptr, nullptr)));
using CbData = details::CallbackData<Callable, ReturnType>;
auto callbackData = new CbData{std::move(cb), data};
napi_value value;
napi_status status =
CreateFunction(env, utf8name, CbData::Wrapper, callbackData, &value);
if (status != napi_ok) {
delete callbackData;
NAPI_THROW_IF_FAILED(env, status, Function());
}
return Function(env, value);
}
template <typename Callable>
inline Function Function::New(napi_env env,
Callable cb,
const std::string& utf8name,
void* data) {
return New(env, cb, utf8name.c_str(), data);
}
inline void Function::CheckCast(napi_env env, napi_value value) {
NAPI_CHECK(value != nullptr, "Function::CheckCast", "empty value");
napi_valuetype type;
napi_status status = napi_typeof(env, value, &type);
NAPI_CHECK(status == napi_ok, "Function::CheckCast", "napi_typeof failed");
NAPI_CHECK(type == napi_function,
"Function::CheckCast",
"value is not napi_function");
}
inline Function::Function() : Object() {}
inline Function::Function(napi_env env, napi_value value)
: Object(env, value) {}
inline MaybeOrValue<Value> Function::operator()(
const std::initializer_list<napi_value>& args) const {
return Call(Env().Undefined(), args);
}
inline MaybeOrValue<Value> Function::Call(
const std::initializer_list<napi_value>& args) const {
return Call(Env().Undefined(), args);
}
inline MaybeOrValue<Value> Function::Call(
const std::vector<napi_value>& args) const {
return Call(Env().Undefined(), args);
}
inline MaybeOrValue<Value> Function::Call(
const std::vector<Value>& args) const {
return Call(Env().Undefined(), args);
}
inline MaybeOrValue<Value> Function::Call(size_t argc,
const napi_value* args) const {
return Call(Env().Undefined(), argc, args);
}
inline MaybeOrValue<Value> Function::Call(
napi_value recv, const std::initializer_list<napi_value>& args) const {
return Call(recv, args.size(), args.begin());
}
inline MaybeOrValue<Value> Function::Call(
napi_value recv, const std::vector<napi_value>& args) const {
return Call(recv, args.size(), args.data());
}
inline MaybeOrValue<Value> Function::Call(
napi_value recv, const std::vector<Value>& args) const {
const size_t argc = args.size();
const size_t stackArgsCount = 6;
napi_value stackArgs[stackArgsCount];
std::vector<napi_value> heapArgs;
napi_value* argv;
if (argc <= stackArgsCount) {
argv = stackArgs;
} else {
heapArgs.resize(argc);
argv = heapArgs.data();
}
for (size_t index = 0; index < argc; index++) {
argv[index] = static_cast<napi_value>(args[index]);
}
return Call(recv, argc, argv);
}
inline MaybeOrValue<Value> Function::Call(napi_value recv,
size_t argc,
const napi_value* args) const {
napi_value result;
napi_status status =
napi_call_function(_env, recv, _value, argc, args, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(
_env, status, Napi::Value(_env, result), Napi::Value);
}
inline MaybeOrValue<Value> Function::MakeCallback(
napi_value recv,
const std::initializer_list<napi_value>& args,
napi_async_context context) const {
return MakeCallback(recv, args.size(), args.begin(), context);
}
inline MaybeOrValue<Value> Function::MakeCallback(
napi_value recv,
const std::vector<napi_value>& args,
napi_async_context context) const {
return MakeCallback(recv, args.size(), args.data(), context);
}
inline MaybeOrValue<Value> Function::MakeCallback(
napi_value recv,
size_t argc,
const napi_value* args,
napi_async_context context) const {
napi_value result;
napi_status status =
napi_make_callback(_env, context, recv, _value, argc, args, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(
_env, status, Napi::Value(_env, result), Napi::Value);
}
inline MaybeOrValue<Object> Function::New(
const std::initializer_list<napi_value>& args) const {
return New(args.size(), args.begin());
}
inline MaybeOrValue<Object> Function::New(
const std::vector<napi_value>& args) const {
return New(args.size(), args.data());
}
inline MaybeOrValue<Object> Function::New(size_t argc,
const napi_value* args) const {
napi_value result;
napi_status status = napi_new_instance(_env, _value, argc, args, &result);
NAPI_RETURN_OR_THROW_IF_FAILED(
_env, status, Napi::Object(_env, result), Napi::Object);
}
////////////////////////////////////////////////////////////////////////////////
// Promise class
////////////////////////////////////////////////////////////////////////////////
inline Promise::Deferred Promise::Deferred::New(napi_env env) {
return Promise::Deferred(env);
}
inline Promise::Deferred::Deferred(napi_env env) : _env(env) {
napi_status status = napi_create_promise(_env, &_deferred, &_promise);
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
inline Promise Promise::Deferred::Promise() const {
return Napi::Promise(_env, _promise);
}
inline Napi::Env Promise::Deferred::Env() const {
return Napi::Env(_env);
}
inline void Promise::Deferred::Resolve(napi_value value) const {
napi_status status = napi_resolve_deferred(_env, _deferred, value);
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
inline void Promise::Deferred::Reject(napi_value value) const {
napi_status status = napi_reject_deferred(_env, _deferred, value);
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
inline void Promise::CheckCast(napi_env env, napi_value value) {
NAPI_CHECK(value != nullptr, "Promise::CheckCast", "empty value");
bool result;
napi_status status = napi_is_promise(env, value, &result);
NAPI_CHECK(status == napi_ok, "Promise::CheckCast", "napi_is_promise failed");
NAPI_CHECK(result, "Promise::CheckCast", "value is not promise");
}
inline Promise::Promise(napi_env env, napi_value value) : Object(env, value) {}
////////////////////////////////////////////////////////////////////////////////
// Buffer<T> class
////////////////////////////////////////////////////////////////////////////////
template <typename T>
inline Buffer<T> Buffer<T>::New(napi_env env, size_t length) {
napi_value value;
void* data;
napi_status status =
napi_create_buffer(env, length * sizeof(T), &data, &value);
NAPI_THROW_IF_FAILED(env, status, Buffer<T>());
return Buffer(env, value);
}
#ifndef NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
template <typename T>
inline Buffer<T> Buffer<T>::New(napi_env env, T* data, size_t length) {
napi_value value;
napi_status status = napi_create_external_buffer(
env, length * sizeof(T), data, nullptr, nullptr, &value);
NAPI_THROW_IF_FAILED(env, status, Buffer<T>());
return Buffer(env, value);
}
template <typename T>
template <typename Finalizer>
inline Buffer<T> Buffer<T>::New(napi_env env,
T* data,
size_t length,
Finalizer finalizeCallback) {
napi_value value;
details::FinalizeData<T, Finalizer>* finalizeData =
new details::FinalizeData<T, Finalizer>(
{std::move(finalizeCallback), nullptr});
napi_status status =
napi_create_external_buffer(env,
length * sizeof(T),
data,
details::FinalizeData<T, Finalizer>::Wrapper,
finalizeData,
&value);
if (status != napi_ok) {
delete finalizeData;
NAPI_THROW_IF_FAILED(env, status, Buffer());
}
return Buffer(env, value);
}
template <typename T>
template <typename Finalizer, typename Hint>
inline Buffer<T> Buffer<T>::New(napi_env env,
T* data,
size_t length,
Finalizer finalizeCallback,
Hint* finalizeHint) {
napi_value value;
details::FinalizeData<T, Finalizer, Hint>* finalizeData =
new details::FinalizeData<T, Finalizer, Hint>(
{std::move(finalizeCallback), finalizeHint});
napi_status status = napi_create_external_buffer(
env,
length * sizeof(T),
data,
details::FinalizeData<T, Finalizer, Hint>::WrapperWithHint,
finalizeData,
&value);
if (status != napi_ok) {
delete finalizeData;
NAPI_THROW_IF_FAILED(env, status, Buffer());
}
return Buffer(env, value);
}
#endif // NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
template <typename T>
inline Buffer<T> Buffer<T>::NewOrCopy(napi_env env, T* data, size_t length) {
#ifndef NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
napi_value value;
napi_status status = napi_create_external_buffer(
env, length * sizeof(T), data, nullptr, nullptr, &value);
if (status == details::napi_no_external_buffers_allowed) {
#endif // NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
// If we can't create an external buffer, we'll just copy the data.
return Buffer<T>::Copy(env, data, length);
#ifndef NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
}
NAPI_THROW_IF_FAILED(env, status, Buffer<T>());
return Buffer(env, value);
#endif // NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
}
template <typename T>
template <typename Finalizer>
inline Buffer<T> Buffer<T>::NewOrCopy(napi_env env,
T* data,
size_t length,
Finalizer finalizeCallback) {
details::FinalizeData<T, Finalizer>* finalizeData =
new details::FinalizeData<T, Finalizer>(
{std::move(finalizeCallback), nullptr});
#ifndef NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
napi_value value;
napi_status status =
napi_create_external_buffer(env,
length * sizeof(T),
data,
details::FinalizeData<T, Finalizer>::Wrapper,
finalizeData,
&value);
if (status == details::napi_no_external_buffers_allowed) {
#endif // NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
// If we can't create an external buffer, we'll just copy the data.
Buffer<T> ret = Buffer<T>::Copy(env, data, length);
details::FinalizeData<T, Finalizer>::Wrapper(env, data, finalizeData);
return ret;
#ifndef NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
}
if (status != napi_ok) {
delete finalizeData;
NAPI_THROW_IF_FAILED(env, status, Buffer());
}
return Buffer(env, value);
#endif // NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
}
template <typename T>
template <typename Finalizer, typename Hint>
inline Buffer<T> Buffer<T>::NewOrCopy(napi_env env,
T* data,
size_t length,
Finalizer finalizeCallback,
Hint* finalizeHint) {
details::FinalizeData<T, Finalizer, Hint>* finalizeData =
new details::FinalizeData<T, Finalizer, Hint>(
{std::move(finalizeCallback), finalizeHint});
#ifndef NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
napi_value value;
napi_status status = napi_create_external_buffer(
env,
length * sizeof(T),
data,
details::FinalizeData<T, Finalizer, Hint>::WrapperWithHint,
finalizeData,
&value);
if (status == details::napi_no_external_buffers_allowed) {
#endif
// If we can't create an external buffer, we'll just copy the data.
Buffer<T> ret = Buffer<T>::Copy(env, data, length);
details::FinalizeData<T, Finalizer, Hint>::WrapperWithHint(
env, data, finalizeData);
return ret;
#ifndef NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
}
if (status != napi_ok) {
delete finalizeData;
NAPI_THROW_IF_FAILED(env, status, Buffer());
}
return Buffer(env, value);
#endif
}
template <typename T>
inline Buffer<T> Buffer<T>::Copy(napi_env env, const T* data, size_t length) {
napi_value value;
napi_status status =
napi_create_buffer_copy(env, length * sizeof(T), data, nullptr, &value);
NAPI_THROW_IF_FAILED(env, status, Buffer<T>());
return Buffer<T>(env, value);
}
template <typename T>
inline void Buffer<T>::CheckCast(napi_env env, napi_value value) {
NAPI_CHECK(value != nullptr, "Buffer::CheckCast", "empty value");
bool result;
napi_status status = napi_is_buffer(env, value, &result);
NAPI_CHECK(status == napi_ok, "Buffer::CheckCast", "napi_is_buffer failed");
NAPI_CHECK(result, "Buffer::CheckCast", "value is not buffer");
}
template <typename T>
inline Buffer<T>::Buffer() : Uint8Array() {}
template <typename T>
inline Buffer<T>::Buffer(napi_env env, napi_value value)
: Uint8Array(env, value) {}
template <typename T>
inline size_t Buffer<T>::Length() const {
return ByteLength() / sizeof(T);
}
template <typename T>
inline T* Buffer<T>::Data() const {
return reinterpret_cast<T*>(const_cast<uint8_t*>(Uint8Array::Data()));
}
////////////////////////////////////////////////////////////////////////////////
// Error class
////////////////////////////////////////////////////////////////////////////////
inline Error Error::New(napi_env env) {
napi_status status;
napi_value error = nullptr;
bool is_exception_pending;
napi_extended_error_info last_error_info_copy;
{
// We must retrieve the last error info before doing anything else because
// doing anything else will replace the last error info.
const napi_extended_error_info* last_error_info;
status = napi_get_last_error_info(env, &last_error_info);
NAPI_FATAL_IF_FAILED(status, "Error::New", "napi_get_last_error_info");
// All fields of the `napi_extended_error_info` structure gets reset in
// subsequent Node-API function calls on the same `env`. This includes a
// call to `napi_is_exception_pending()`. So here it is necessary to make a
// copy of the information as the `error_code` field is used later on.
memcpy(&last_error_info_copy,
last_error_info,
sizeof(napi_extended_error_info));
}
status = napi_is_exception_pending(env, &is_exception_pending);
NAPI_FATAL_IF_FAILED(status, "Error::New", "napi_is_exception_pending");
// A pending exception takes precedence over any internal error status.
if (is_exception_pending) {
status = napi_get_and_clear_last_exception(env, &error);
NAPI_FATAL_IF_FAILED(
status, "Error::New", "napi_get_and_clear_last_exception");
} else {
const char* error_message = last_error_info_copy.error_message != nullptr
? last_error_info_copy.error_message
: "Error in native callback";
napi_value message;
status = napi_create_string_utf8(
env, error_message, std::strlen(error_message), &message);
NAPI_FATAL_IF_FAILED(status, "Error::New", "napi_create_string_utf8");
switch (last_error_info_copy.error_code) {
case napi_object_expected:
case napi_string_expected:
case napi_boolean_expected:
case napi_number_expected:
status = napi_create_type_error(env, nullptr, message, &error);
break;
default:
status = napi_create_error(env, nullptr, message, &error);
break;
}
NAPI_FATAL_IF_FAILED(status, "Error::New", "napi_create_error");
}
return Error(env, error);
}
inline Error Error::New(napi_env env, const char* message) {
return Error::New<Error>(
env, message, std::strlen(message), napi_create_error);
}
inline Error Error::New(napi_env env, const std::string& message) {
return Error::New<Error>(
env, message.c_str(), message.size(), napi_create_error);
}
inline NAPI_NO_RETURN void Error::Fatal(const char* location,
const char* message) {
napi_fatal_error(location, NAPI_AUTO_LENGTH, message, NAPI_AUTO_LENGTH);
}
inline Error::Error() : ObjectReference() {}
inline Error::Error(napi_env env, napi_value value)
: ObjectReference(env, nullptr) {
if (value != nullptr) {
// Attempting to create a reference on the error object.
// If it's not a Object/Function/Symbol, this call will return an error
// status.
napi_status status = napi_create_reference(env, value, 1, &_ref);
if (status != napi_ok) {
napi_value wrappedErrorObj;
// Create an error object
status = napi_create_object(env, &wrappedErrorObj);
NAPI_FATAL_IF_FAILED(status, "Error::Error", "napi_create_object");
// property flag that we attach to show the error object is wrapped
napi_property_descriptor wrapObjFlag = {
ERROR_WRAP_VALUE(), // Unique GUID identifier since Symbol isn't a
// viable option
nullptr,
nullptr,
nullptr,
nullptr,
Value::From(env, value),
napi_enumerable,
nullptr};
status = napi_define_properties(env, wrappedErrorObj, 1, &wrapObjFlag);
#ifdef NODE_API_SWALLOW_UNTHROWABLE_EXCEPTIONS
if (status == napi_pending_exception) {
// Test if the pending exception was reported because the environment is
// shutting down. We assume that a status of napi_pending_exception
// coupled with the absence of an actual pending exception means that
// the environment is shutting down. If so, we replace the
// napi_pending_exception status with napi_ok.
bool is_exception_pending = false;
status = napi_is_exception_pending(env, &is_exception_pending);
if (status == napi_ok && !is_exception_pending) {
status = napi_ok;
} else {
status = napi_pending_exception;
}
}
#endif // NODE_API_SWALLOW_UNTHROWABLE_EXCEPTIONS
NAPI_FATAL_IF_FAILED(status, "Error::Error", "napi_define_properties");
// Create a reference on the newly wrapped object
status = napi_create_reference(env, wrappedErrorObj, 1, &_ref);
}
// Avoid infinite recursion in the failure case.
NAPI_FATAL_IF_FAILED(status, "Error::Error", "napi_create_reference");
}
}
inline Object Error::Value() const {
if (_ref == nullptr) {
return Object(_env, nullptr);
}
napi_value refValue;
napi_status status = napi_get_reference_value(_env, _ref, &refValue);
NAPI_THROW_IF_FAILED(_env, status, Object());
napi_valuetype type;
status = napi_typeof(_env, refValue, &type);
NAPI_THROW_IF_FAILED(_env, status, Object());
// If refValue isn't a symbol, then we proceed to whether the refValue has the
// wrapped error flag
if (type != napi_symbol) {
// We are checking if the object is wrapped
bool isWrappedObject = false;
status = napi_has_property(_env,
refValue,
String::From(_env, ERROR_WRAP_VALUE()),
&isWrappedObject);
// Don't care about status
if (isWrappedObject) {
napi_value unwrappedValue;
status = napi_get_property(_env,
refValue,
String::From(_env, ERROR_WRAP_VALUE()),
&unwrappedValue);
NAPI_THROW_IF_FAILED(_env, status, Object());
return Object(_env, unwrappedValue);
}
}
return Object(_env, refValue);
}
inline Error::Error(Error&& other) : ObjectReference(std::move(other)) {}
inline Error& Error::operator=(Error&& other) {
static_cast<Reference<Object>*>(this)->operator=(std::move(other));
return *this;
}
inline Error::Error(const Error& other) : ObjectReference(other) {}
inline Error& Error::operator=(const Error& other) {
Reset();
_env = other.Env();
HandleScope scope(_env);
napi_value value = other.Value();
if (value != nullptr) {
napi_status status = napi_create_reference(_env, value, 1, &_ref);
NAPI_THROW_IF_FAILED(_env, status, *this);
}
return *this;
}
inline const std::string& Error::Message() const NAPI_NOEXCEPT {
if (_message.size() == 0 && _env != nullptr) {
#ifdef NAPI_CPP_EXCEPTIONS
try {
_message = Get("message").As<String>();
} catch (...) {
// Catch all errors here, to include e.g. a std::bad_alloc from
// the std::string::operator=, because this method may not throw.
}
#else // NAPI_CPP_EXCEPTIONS
#if defined(NODE_ADDON_API_ENABLE_MAYBE)
Napi::Value message_val;
if (Get("message").UnwrapTo(&message_val)) {
_message = message_val.As<String>();
}
#else
_message = Get("message").As<String>();
#endif
#endif // NAPI_CPP_EXCEPTIONS
}
return _message;
}
// we created an object on the &_ref
inline void Error::ThrowAsJavaScriptException() const {
HandleScope scope(_env);
if (!IsEmpty()) {
#ifdef NODE_API_SWALLOW_UNTHROWABLE_EXCEPTIONS
bool pendingException = false;
// check if there is already a pending exception. If so don't try to throw a
// new one as that is not allowed/possible
napi_status status = napi_is_exception_pending(_env, &pendingException);
if ((status != napi_ok) ||
((status == napi_ok) && (pendingException == false))) {
// We intentionally don't use `NAPI_THROW_*` macros here to ensure
// that there is no possible recursion as `ThrowAsJavaScriptException`
// is part of `NAPI_THROW_*` macro definition for noexcept.
status = napi_throw(_env, Value());
if (status == napi_pending_exception) {
// The environment must be terminating as we checked earlier and there
// was no pending exception. In this case continuing will result
// in a fatal error and there is nothing the author has done incorrectly
// in their code that is worth flagging through a fatal error
return;
}
} else {
status = napi_pending_exception;
}
#else
// We intentionally don't use `NAPI_THROW_*` macros here to ensure
// that there is no possible recursion as `ThrowAsJavaScriptException`
// is part of `NAPI_THROW_*` macro definition for noexcept.
napi_status status = napi_throw(_env, Value());
#endif
#ifdef NAPI_CPP_EXCEPTIONS
if (status != napi_ok) {
throw Error::New(_env);
}
#else // NAPI_CPP_EXCEPTIONS
NAPI_FATAL_IF_FAILED(
status, "Error::ThrowAsJavaScriptException", "napi_throw");
#endif // NAPI_CPP_EXCEPTIONS
}
}
#ifdef NAPI_CPP_EXCEPTIONS
inline const char* Error::what() const NAPI_NOEXCEPT {
return Message().c_str();
}
#endif // NAPI_CPP_EXCEPTIONS
inline const char* Error::ERROR_WRAP_VALUE() NAPI_NOEXCEPT {
return "4bda9e7e-4913-4dbc-95de-891cbf66598e-errorVal";
}
template <typename TError>
inline TError Error::New(napi_env env,
const char* message,
size_t length,
create_error_fn create_error) {
napi_value str;
napi_status status = napi_create_string_utf8(env, message, length, &str);
NAPI_THROW_IF_FAILED(env, status, TError());
napi_value error;
status = create_error(env, nullptr, str, &error);
NAPI_THROW_IF_FAILED(env, status, TError());
return TError(env, error);
}
inline TypeError TypeError::New(napi_env env, const char* message) {
return Error::New<TypeError>(
env, message, std::strlen(message), napi_create_type_error);
}
inline TypeError TypeError::New(napi_env env, const std::string& message) {
return Error::New<TypeError>(
env, message.c_str(), message.size(), napi_create_type_error);
}
inline TypeError::TypeError() : Error() {}
inline TypeError::TypeError(napi_env env, napi_value value)
: Error(env, value) {}
inline RangeError RangeError::New(napi_env env, const char* message) {
return Error::New<RangeError>(
env, message, std::strlen(message), napi_create_range_error);
}
inline RangeError RangeError::New(napi_env env, const std::string& message) {
return Error::New<RangeError>(
env, message.c_str(), message.size(), napi_create_range_error);
}
inline RangeError::RangeError() : Error() {}
inline RangeError::RangeError(napi_env env, napi_value value)
: Error(env, value) {}
#if NAPI_VERSION > 8
inline SyntaxError SyntaxError::New(napi_env env, const char* message) {
return Error::New<SyntaxError>(
env, message, std::strlen(message), node_api_create_syntax_error);
}
inline SyntaxError SyntaxError::New(napi_env env, const std::string& message) {
return Error::New<SyntaxError>(
env, message.c_str(), message.size(), node_api_create_syntax_error);
}
inline SyntaxError::SyntaxError() : Error() {}
inline SyntaxError::SyntaxError(napi_env env, napi_value value)
: Error(env, value) {}
#endif // NAPI_VERSION > 8
////////////////////////////////////////////////////////////////////////////////
// Reference<T> class
////////////////////////////////////////////////////////////////////////////////
template <typename T>
inline Reference<T> Reference<T>::New(const T& value,
uint32_t initialRefcount) {
napi_env env = value.Env();
napi_value val = value;
if (val == nullptr) {
return Reference<T>(env, nullptr);
}
napi_ref ref;
napi_status status = napi_create_reference(env, value, initialRefcount, &ref);
NAPI_THROW_IF_FAILED(env, status, Reference<T>());
return Reference<T>(env, ref);
}
template <typename T>
inline Reference<T>::Reference()
: _env(nullptr), _ref(nullptr), _suppressDestruct(false) {}
template <typename T>
inline Reference<T>::Reference(napi_env env, napi_ref ref)
: _env(env), _ref(ref), _suppressDestruct(false) {}
template <typename T>
inline Reference<T>::~Reference() {
if (_ref != nullptr) {
if (!_suppressDestruct) {
napi_delete_reference(_env, _ref);
}
_ref = nullptr;
}
}
template <typename T>
inline Reference<T>::Reference(Reference<T>&& other)
: _env(other._env),
_ref(other._ref),
_suppressDestruct(other._suppressDestruct) {
other._env = nullptr;
other._ref = nullptr;
other._suppressDestruct = false;
}
template <typename T>
inline Reference<T>& Reference<T>::operator=(Reference<T>&& other) {
Reset();
_env = other._env;
_ref = other._ref;
_suppressDestruct = other._suppressDestruct;
other._env = nullptr;
other._ref = nullptr;
other._suppressDestruct = false;
return *this;
}
template <typename T>
inline Reference<T>::Reference(const Reference<T>& other)
: _env(other._env), _ref(nullptr), _suppressDestruct(false) {
HandleScope scope(_env);
napi_value value = other.Value();
if (value != nullptr) {
// Copying is a limited scenario (currently only used for Error object) and
// always creates a strong reference to the given value even if the incoming
// reference is weak.
napi_status status = napi_create_reference(_env, value, 1, &_ref);
NAPI_FATAL_IF_FAILED(
status, "Reference<T>::Reference", "napi_create_reference");
}
}
template <typename T>
inline Reference<T>::operator napi_ref() const {
return _ref;
}
template <typename T>
inline bool Reference<T>::operator==(const Reference<T>& other) const {
HandleScope scope(_env);
return this->Value().StrictEquals(other.Value());
}
template <typename T>
inline bool Reference<T>::operator!=(const Reference<T>& other) const {
return !this->operator==(other);
}
template <typename T>
inline Napi::Env Reference<T>::Env() const {
return Napi::Env(_env);
}
template <typename T>
inline bool Reference<T>::IsEmpty() const {
return _ref == nullptr;
}
template <typename T>
inline T Reference<T>::Value() const {
if (_ref == nullptr) {
return T(_env, nullptr);
}
napi_value value;
napi_status status = napi_get_reference_value(_env, _ref, &value);
NAPI_THROW_IF_FAILED(_env, status, T());
return T(_env, value);
}
template <typename T>
inline uint32_t Reference<T>::Ref() const {
uint32_t result;
napi_status status = napi_reference_ref(_env, _ref, &result);
NAPI_THROW_IF_FAILED(_env, status, 0);
return result;
}
template <typename T>
inline uint32_t Reference<T>::Unref() const {
uint32_t result;
napi_status status = napi_reference_unref(_env, _ref, &result);
NAPI_THROW_IF_FAILED(_env, status, 0);
return result;
}
template <typename T>
inline void Reference<T>::Reset() {
if (_ref != nullptr) {
napi_status status = napi_delete_reference(_env, _ref);
NAPI_THROW_IF_FAILED_VOID(_env, status);
_ref = nullptr;
}
}
template <typename T>
inline void Reference<T>::Reset(const T& value, uint32_t refcount) {
Reset();
_env = value.Env();
napi_value val = value;
if (val != nullptr) {
napi_status status = napi_create_reference(_env, value, refcount, &_ref);
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
}
template <typename T>
inline void Reference<T>::SuppressDestruct() {
_suppressDestruct = true;
}
template <typename T>
inline Reference<T> Weak(T value) {
return Reference<T>::New(value, 0);
}
inline ObjectReference Weak(Object value) {
return Reference<Object>::New(value, 0);
}
inline FunctionReference Weak(Function value) {
return Reference<Function>::New(value, 0);
}
template <typename T>
inline Reference<T> Persistent(T value) {
return Reference<T>::New(value, 1);
}
inline ObjectReference Persistent(Object value) {
return Reference<Object>::New(value, 1);
}
inline FunctionReference Persistent(Function value) {
return Reference<Function>::New(value, 1);
}
////////////////////////////////////////////////////////////////////////////////
// ObjectReference class
////////////////////////////////////////////////////////////////////////////////
inline ObjectReference::ObjectReference() : Reference<Object>() {}
inline ObjectReference::ObjectReference(napi_env env, napi_ref ref)
: Reference<Object>(env, ref) {}
inline ObjectReference::ObjectReference(Reference<Object>&& other)
: Reference<Object>(std::move(other)) {}
inline ObjectReference& ObjectReference::operator=(Reference<Object>&& other) {
static_cast<Reference<Object>*>(this)->operator=(std::move(other));
return *this;
}
inline ObjectReference::ObjectReference(ObjectReference&& other)
: Reference<Object>(std::move(other)) {}
inline ObjectReference& ObjectReference::operator=(ObjectReference&& other) {
static_cast<Reference<Object>*>(this)->operator=(std::move(other));
return *this;
}
inline ObjectReference::ObjectReference(const ObjectReference& other)
: Reference<Object>(other) {}
inline MaybeOrValue<Napi::Value> ObjectReference::Get(
const char* utf8name) const {
EscapableHandleScope scope(_env);
MaybeOrValue<Napi::Value> result = Value().Get(utf8name);
#ifdef NODE_ADDON_API_ENABLE_MAYBE
if (result.IsJust()) {
return Just(scope.Escape(result.Unwrap()));
}
return result;
#else
if (scope.Env().IsExceptionPending()) {
return Value();
}
return scope.Escape(result);
#endif
}
inline MaybeOrValue<Napi::Value> ObjectReference::Get(
const std::string& utf8name) const {
EscapableHandleScope scope(_env);
MaybeOrValue<Napi::Value> result = Value().Get(utf8name);
#ifdef NODE_ADDON_API_ENABLE_MAYBE
if (result.IsJust()) {
return Just(scope.Escape(result.Unwrap()));
}
return result;
#else
if (scope.Env().IsExceptionPending()) {
return Value();
}
return scope.Escape(result);
#endif
}
inline MaybeOrValue<bool> ObjectReference::Set(const char* utf8name,
napi_value value) const {
HandleScope scope(_env);
return Value().Set(utf8name, value);
}
inline MaybeOrValue<bool> ObjectReference::Set(const char* utf8name,
Napi::Value value) const {
HandleScope scope(_env);
return Value().Set(utf8name, value);
}
inline MaybeOrValue<bool> ObjectReference::Set(const char* utf8name,
const char* utf8value) const {
HandleScope scope(_env);
return Value().Set(utf8name, utf8value);
}
inline MaybeOrValue<bool> ObjectReference::Set(const char* utf8name,
bool boolValue) const {
HandleScope scope(_env);
return Value().Set(utf8name, boolValue);
}
inline MaybeOrValue<bool> ObjectReference::Set(const char* utf8name,
double numberValue) const {
HandleScope scope(_env);
return Value().Set(utf8name, numberValue);
}
inline MaybeOrValue<bool> ObjectReference::Set(const std::string& utf8name,
napi_value value) const {
HandleScope scope(_env);
return Value().Set(utf8name, value);
}
inline MaybeOrValue<bool> ObjectReference::Set(const std::string& utf8name,
Napi::Value value) const {
HandleScope scope(_env);
return Value().Set(utf8name, value);
}
inline MaybeOrValue<bool> ObjectReference::Set(const std::string& utf8name,
std::string& utf8value) const {
HandleScope scope(_env);
return Value().Set(utf8name, utf8value);
}
inline MaybeOrValue<bool> ObjectReference::Set(const std::string& utf8name,
bool boolValue) const {
HandleScope scope(_env);
return Value().Set(utf8name, boolValue);
}
inline MaybeOrValue<bool> ObjectReference::Set(const std::string& utf8name,
double numberValue) const {
HandleScope scope(_env);
return Value().Set(utf8name, numberValue);
}
inline MaybeOrValue<Napi::Value> ObjectReference::Get(uint32_t index) const {
EscapableHandleScope scope(_env);
MaybeOrValue<Napi::Value> result = Value().Get(index);
#ifdef NODE_ADDON_API_ENABLE_MAYBE
if (result.IsJust()) {
return Just(scope.Escape(result.Unwrap()));
}
return result;
#else
if (scope.Env().IsExceptionPending()) {
return Value();
}
return scope.Escape(result);
#endif
}
inline MaybeOrValue<bool> ObjectReference::Set(uint32_t index,
napi_value value) const {
HandleScope scope(_env);
return Value().Set(index, value);
}
inline MaybeOrValue<bool> ObjectReference::Set(uint32_t index,
Napi::Value value) const {
HandleScope scope(_env);
return Value().Set(index, value);
}
inline MaybeOrValue<bool> ObjectReference::Set(uint32_t index,
const char* utf8value) const {
HandleScope scope(_env);
return Value().Set(index, utf8value);
}
inline MaybeOrValue<bool> ObjectReference::Set(
uint32_t index, const std::string& utf8value) const {
HandleScope scope(_env);
return Value().Set(index, utf8value);
}
inline MaybeOrValue<bool> ObjectReference::Set(uint32_t index,
bool boolValue) const {
HandleScope scope(_env);
return Value().Set(index, boolValue);
}
inline MaybeOrValue<bool> ObjectReference::Set(uint32_t index,
double numberValue) const {
HandleScope scope(_env);
return Value().Set(index, numberValue);
}
////////////////////////////////////////////////////////////////////////////////
// FunctionReference class
////////////////////////////////////////////////////////////////////////////////
inline FunctionReference::FunctionReference() : Reference<Function>() {}
inline FunctionReference::FunctionReference(napi_env env, napi_ref ref)
: Reference<Function>(env, ref) {}
inline FunctionReference::FunctionReference(Reference<Function>&& other)
: Reference<Function>(std::move(other)) {}
inline FunctionReference& FunctionReference::operator=(
Reference<Function>&& other) {
static_cast<Reference<Function>*>(this)->operator=(std::move(other));
return *this;
}
inline FunctionReference::FunctionReference(FunctionReference&& other)
: Reference<Function>(std::move(other)) {}
inline FunctionReference& FunctionReference::operator=(
FunctionReference&& other) {
static_cast<Reference<Function>*>(this)->operator=(std::move(other));
return *this;
}
inline MaybeOrValue<Napi::Value> FunctionReference::operator()(
const std::initializer_list<napi_value>& args) const {
EscapableHandleScope scope(_env);
MaybeOrValue<Napi::Value> result = Value()(args);
#ifdef NODE_ADDON_API_ENABLE_MAYBE
if (result.IsJust()) {
return Just(scope.Escape(result.Unwrap()));
}
return result;
#else
if (scope.Env().IsExceptionPending()) {
return Value();
}
return scope.Escape(result);
#endif
}
inline MaybeOrValue<Napi::Value> FunctionReference::Call(
const std::initializer_list<napi_value>& args) const {
EscapableHandleScope scope(_env);
MaybeOrValue<Napi::Value> result = Value().Call(args);
#ifdef NODE_ADDON_API_ENABLE_MAYBE
if (result.IsJust()) {
return Just(scope.Escape(result.Unwrap()));
}
return result;
#else
if (scope.Env().IsExceptionPending()) {
return Value();
}
return scope.Escape(result);
#endif
}
inline MaybeOrValue<Napi::Value> FunctionReference::Call(
const std::vector<napi_value>& args) const {
EscapableHandleScope scope(_env);
MaybeOrValue<Napi::Value> result = Value().Call(args);
#ifdef NODE_ADDON_API_ENABLE_MAYBE
if (result.IsJust()) {
return Just(scope.Escape(result.Unwrap()));
}
return result;
#else
if (scope.Env().IsExceptionPending()) {
return Value();
}
return scope.Escape(result);
#endif
}
inline MaybeOrValue<Napi::Value> FunctionReference::Call(
napi_value recv, const std::initializer_list<napi_value>& args) const {
EscapableHandleScope scope(_env);
MaybeOrValue<Napi::Value> result = Value().Call(recv, args);
#ifdef NODE_ADDON_API_ENABLE_MAYBE
if (result.IsJust()) {
return Just(scope.Escape(result.Unwrap()));
}
return result;
#else
if (scope.Env().IsExceptionPending()) {
return Value();
}
return scope.Escape(result);
#endif
}
inline MaybeOrValue<Napi::Value> FunctionReference::Call(
napi_value recv, const std::vector<napi_value>& args) const {
EscapableHandleScope scope(_env);
MaybeOrValue<Napi::Value> result = Value().Call(recv, args);
#ifdef NODE_ADDON_API_ENABLE_MAYBE
if (result.IsJust()) {
return Just(scope.Escape(result.Unwrap()));
}
return result;
#else
if (scope.Env().IsExceptionPending()) {
return Value();
}
return scope.Escape(result);
#endif
}
inline MaybeOrValue<Napi::Value> FunctionReference::Call(
napi_value recv, size_t argc, const napi_value* args) const {
EscapableHandleScope scope(_env);
MaybeOrValue<Napi::Value> result = Value().Call(recv, argc, args);
#ifdef NODE_ADDON_API_ENABLE_MAYBE
if (result.IsJust()) {
return Just(scope.Escape(result.Unwrap()));
}
return result;
#else
if (scope.Env().IsExceptionPending()) {
return Value();
}
return scope.Escape(result);
#endif
}
inline MaybeOrValue<Napi::Value> FunctionReference::MakeCallback(
napi_value recv,
const std::initializer_list<napi_value>& args,
napi_async_context context) const {
EscapableHandleScope scope(_env);
MaybeOrValue<Napi::Value> result = Value().MakeCallback(recv, args, context);
#ifdef NODE_ADDON_API_ENABLE_MAYBE
if (result.IsJust()) {
return Just(scope.Escape(result.Unwrap()));
}
return result;
#else
if (scope.Env().IsExceptionPending()) {
return Value();
}
return scope.Escape(result);
#endif
}
inline MaybeOrValue<Napi::Value> FunctionReference::MakeCallback(
napi_value recv,
const std::vector<napi_value>& args,
napi_async_context context) const {
EscapableHandleScope scope(_env);
MaybeOrValue<Napi::Value> result = Value().MakeCallback(recv, args, context);
#ifdef NODE_ADDON_API_ENABLE_MAYBE
if (result.IsJust()) {
return Just(scope.Escape(result.Unwrap()));
}
return result;
#else
if (scope.Env().IsExceptionPending()) {
return Value();
}
return scope.Escape(result);
#endif
}
inline MaybeOrValue<Napi::Value> FunctionReference::MakeCallback(
napi_value recv,
size_t argc,
const napi_value* args,
napi_async_context context) const {
EscapableHandleScope scope(_env);
MaybeOrValue<Napi::Value> result =
Value().MakeCallback(recv, argc, args, context);
#ifdef NODE_ADDON_API_ENABLE_MAYBE
if (result.IsJust()) {
return Just(scope.Escape(result.Unwrap()));
}
return result;
#else
if (scope.Env().IsExceptionPending()) {
return Value();
}
return scope.Escape(result);
#endif
}
inline MaybeOrValue<Object> FunctionReference::New(
const std::initializer_list<napi_value>& args) const {
EscapableHandleScope scope(_env);
MaybeOrValue<Object> result = Value().New(args);
#ifdef NODE_ADDON_API_ENABLE_MAYBE
if (result.IsJust()) {
return Just(scope.Escape(result.Unwrap()).As<Object>());
}
return result;
#else
if (scope.Env().IsExceptionPending()) {
return Object();
}
return scope.Escape(result).As<Object>();
#endif
}
inline MaybeOrValue<Object> FunctionReference::New(
const std::vector<napi_value>& args) const {
EscapableHandleScope scope(_env);
MaybeOrValue<Object> result = Value().New(args);
#ifdef NODE_ADDON_API_ENABLE_MAYBE
if (result.IsJust()) {
return Just(scope.Escape(result.Unwrap()).As<Object>());
}
return result;
#else
if (scope.Env().IsExceptionPending()) {
return Object();
}
return scope.Escape(result).As<Object>();
#endif
}
////////////////////////////////////////////////////////////////////////////////
// CallbackInfo class
////////////////////////////////////////////////////////////////////////////////
inline CallbackInfo::CallbackInfo(napi_env env, napi_callback_info info)
: _env(env),
_info(info),
_this(nullptr),
_dynamicArgs(nullptr),
_data(nullptr) {
_argc = _staticArgCount;
_argv = _staticArgs;
napi_status status =
napi_get_cb_info(env, info, &_argc, _argv, &_this, &_data);
NAPI_THROW_IF_FAILED_VOID(_env, status);
if (_argc > _staticArgCount) {
// Use either a fixed-size array (on the stack) or a dynamically-allocated
// array (on the heap) depending on the number of args.
_dynamicArgs = new napi_value[_argc];
_argv = _dynamicArgs;
status = napi_get_cb_info(env, info, &_argc, _argv, nullptr, nullptr);
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
}
inline CallbackInfo::~CallbackInfo() {
if (_dynamicArgs != nullptr) {
delete[] _dynamicArgs;
}
}
inline CallbackInfo::operator napi_callback_info() const {
return _info;
}
inline Value CallbackInfo::NewTarget() const {
napi_value newTarget;
napi_status status = napi_get_new_target(_env, _info, &newTarget);
NAPI_THROW_IF_FAILED(_env, status, Value());
return Value(_env, newTarget);
}
inline bool CallbackInfo::IsConstructCall() const {
return !NewTarget().IsEmpty();
}
inline Napi::Env CallbackInfo::Env() const {
return Napi::Env(_env);
}
inline size_t CallbackInfo::Length() const {
return _argc;
}
inline const Value CallbackInfo::operator[](size_t index) const {
return index < _argc ? Value(_env, _argv[index]) : Env().Undefined();
}
inline Value CallbackInfo::This() const {
if (_this == nullptr) {
return Env().Undefined();
}
return Object(_env, _this);
}
inline void* CallbackInfo::Data() const {
return _data;
}
inline void CallbackInfo::SetData(void* data) {
_data = data;
}
////////////////////////////////////////////////////////////////////////////////
// PropertyDescriptor class
////////////////////////////////////////////////////////////////////////////////
template <typename PropertyDescriptor::GetterCallback Getter>
PropertyDescriptor PropertyDescriptor::Accessor(
const char* utf8name, napi_property_attributes attributes, void* data) {
napi_property_descriptor desc = napi_property_descriptor();
desc.utf8name = utf8name;
desc.getter = details::TemplatedCallback<Getter>;
desc.attributes = attributes;
desc.data = data;
return desc;
}
template <typename PropertyDescriptor::GetterCallback Getter>
PropertyDescriptor PropertyDescriptor::Accessor(
const std::string& utf8name,
napi_property_attributes attributes,
void* data) {
return Accessor<Getter>(utf8name.c_str(), attributes, data);
}
template <typename PropertyDescriptor::GetterCallback Getter>
PropertyDescriptor PropertyDescriptor::Accessor(
Name name, napi_property_attributes attributes, void* data) {
napi_property_descriptor desc = napi_property_descriptor();
desc.name = name;
desc.getter = details::TemplatedCallback<Getter>;
desc.attributes = attributes;
desc.data = data;
return desc;
}
template <typename PropertyDescriptor::GetterCallback Getter,
typename PropertyDescriptor::SetterCallback Setter>
PropertyDescriptor PropertyDescriptor::Accessor(
const char* utf8name, napi_property_attributes attributes, void* data) {
napi_property_descriptor desc = napi_property_descriptor();
desc.utf8name = utf8name;
desc.getter = details::TemplatedCallback<Getter>;
desc.setter = details::TemplatedVoidCallback<Setter>;
desc.attributes = attributes;
desc.data = data;
return desc;
}
template <typename PropertyDescriptor::GetterCallback Getter,
typename PropertyDescriptor::SetterCallback Setter>
PropertyDescriptor PropertyDescriptor::Accessor(
const std::string& utf8name,
napi_property_attributes attributes,
void* data) {
return Accessor<Getter, Setter>(utf8name.c_str(), attributes, data);
}
template <typename PropertyDescriptor::GetterCallback Getter,
typename PropertyDescriptor::SetterCallback Setter>
PropertyDescriptor PropertyDescriptor::Accessor(
Name name, napi_property_attributes attributes, void* data) {
napi_property_descriptor desc = napi_property_descriptor();
desc.name = name;
desc.getter = details::TemplatedCallback<Getter>;
desc.setter = details::TemplatedVoidCallback<Setter>;
desc.attributes = attributes;
desc.data = data;
return desc;
}
template <typename Getter>
inline PropertyDescriptor PropertyDescriptor::Accessor(
Napi::Env env,
Napi::Object object,
const char* utf8name,
Getter getter,
napi_property_attributes attributes,
void* data) {
using CbData = details::CallbackData<Getter, Napi::Value>;
auto callbackData = new CbData({getter, data});
napi_status status = AttachData(env, object, callbackData);
if (status != napi_ok) {
delete callbackData;
NAPI_THROW_IF_FAILED(env, status, napi_property_descriptor());
}
return PropertyDescriptor({utf8name,
nullptr,
nullptr,
CbData::Wrapper,
nullptr,
nullptr,
attributes,
callbackData});
}
template <typename Getter>
inline PropertyDescriptor PropertyDescriptor::Accessor(
Napi::Env env,
Napi::Object object,
const std::string& utf8name,
Getter getter,
napi_property_attributes attributes,
void* data) {
return Accessor(env, object, utf8name.c_str(), getter, attributes, data);
}
template <typename Getter>
inline PropertyDescriptor PropertyDescriptor::Accessor(
Napi::Env env,
Napi::Object object,
Name name,
Getter getter,
napi_property_attributes attributes,
void* data) {
using CbData = details::CallbackData<Getter, Napi::Value>;
auto callbackData = new CbData({getter, data});
napi_status status = AttachData(env, object, callbackData);
if (status != napi_ok) {
delete callbackData;
NAPI_THROW_IF_FAILED(env, status, napi_property_descriptor());
}
return PropertyDescriptor({nullptr,
name,
nullptr,
CbData::Wrapper,
nullptr,
nullptr,
attributes,
callbackData});
}
template <typename Getter, typename Setter>
inline PropertyDescriptor PropertyDescriptor::Accessor(
Napi::Env env,
Napi::Object object,
const char* utf8name,
Getter getter,
Setter setter,
napi_property_attributes attributes,
void* data) {
using CbData = details::AccessorCallbackData<Getter, Setter>;
auto callbackData = new CbData({getter, setter, data});
napi_status status = AttachData(env, object, callbackData);
if (status != napi_ok) {
delete callbackData;
NAPI_THROW_IF_FAILED(env, status, napi_property_descriptor());
}
return PropertyDescriptor({utf8name,
nullptr,
nullptr,
CbData::GetterWrapper,
CbData::SetterWrapper,
nullptr,
attributes,
callbackData});
}
template <typename Getter, typename Setter>
inline PropertyDescriptor PropertyDescriptor::Accessor(
Napi::Env env,
Napi::Object object,
const std::string& utf8name,
Getter getter,
Setter setter,
napi_property_attributes attributes,
void* data) {
return Accessor(
env, object, utf8name.c_str(), getter, setter, attributes, data);
}
template <typename Getter, typename Setter>
inline PropertyDescriptor PropertyDescriptor::Accessor(
Napi::Env env,
Napi::Object object,
Name name,
Getter getter,
Setter setter,
napi_property_attributes attributes,
void* data) {
using CbData = details::AccessorCallbackData<Getter, Setter>;
auto callbackData = new CbData({getter, setter, data});
napi_status status = AttachData(env, object, callbackData);
if (status != napi_ok) {
delete callbackData;
NAPI_THROW_IF_FAILED(env, status, napi_property_descriptor());
}
return PropertyDescriptor({nullptr,
name,
nullptr,
CbData::GetterWrapper,
CbData::SetterWrapper,
nullptr,
attributes,
callbackData});
}
template <typename Callable>
inline PropertyDescriptor PropertyDescriptor::Function(
Napi::Env env,
Napi::Object /*object*/,
const char* utf8name,
Callable cb,
napi_property_attributes attributes,
void* data) {
return PropertyDescriptor({utf8name,
nullptr,
nullptr,
nullptr,
nullptr,
Napi::Function::New(env, cb, utf8name, data),
attributes,
nullptr});
}
template <typename Callable>
inline PropertyDescriptor PropertyDescriptor::Function(
Napi::Env env,
Napi::Object object,
const std::string& utf8name,
Callable cb,
napi_property_attributes attributes,
void* data) {
return Function(env, object, utf8name.c_str(), cb, attributes, data);
}
template <typename Callable>
inline PropertyDescriptor PropertyDescriptor::Function(
Napi::Env env,
Napi::Object /*object*/,
Name name,
Callable cb,
napi_property_attributes attributes,
void* data) {
return PropertyDescriptor({nullptr,
name,
nullptr,
nullptr,
nullptr,
Napi::Function::New(env, cb, nullptr, data),
attributes,
nullptr});
}
inline PropertyDescriptor PropertyDescriptor::Value(
const char* utf8name,
napi_value value,
napi_property_attributes attributes) {
return PropertyDescriptor({utf8name,
nullptr,
nullptr,
nullptr,
nullptr,
value,
attributes,
nullptr});
}
inline PropertyDescriptor PropertyDescriptor::Value(
const std::string& utf8name,
napi_value value,
napi_property_attributes attributes) {
return Value(utf8name.c_str(), value, attributes);
}
inline PropertyDescriptor PropertyDescriptor::Value(
napi_value name, napi_value value, napi_property_attributes attributes) {
return PropertyDescriptor(
{nullptr, name, nullptr, nullptr, nullptr, value, attributes, nullptr});
}
inline PropertyDescriptor PropertyDescriptor::Value(
Name name, Napi::Value value, napi_property_attributes attributes) {
napi_value nameValue = name;
napi_value valueValue = value;
return PropertyDescriptor::Value(nameValue, valueValue, attributes);
}
inline PropertyDescriptor::PropertyDescriptor(napi_property_descriptor desc)
: _desc(desc) {}
inline PropertyDescriptor::operator napi_property_descriptor&() {
return _desc;
}
inline PropertyDescriptor::operator const napi_property_descriptor&() const {
return _desc;
}
////////////////////////////////////////////////////////////////////////////////
// InstanceWrap<T> class
////////////////////////////////////////////////////////////////////////////////
template <typename T>
inline void InstanceWrap<T>::AttachPropData(
napi_env env, napi_value value, const napi_property_descriptor* prop) {
napi_status status;
if (!(prop->attributes & napi_static)) {
if (prop->method == T::InstanceVoidMethodCallbackWrapper) {
status = Napi::details::AttachData(
env, value, static_cast<InstanceVoidMethodCallbackData*>(prop->data));
NAPI_THROW_IF_FAILED_VOID(env, status);
} else if (prop->method == T::InstanceMethodCallbackWrapper) {
status = Napi::details::AttachData(
env, value, static_cast<InstanceMethodCallbackData*>(prop->data));
NAPI_THROW_IF_FAILED_VOID(env, status);
} else if (prop->getter == T::InstanceGetterCallbackWrapper ||
prop->setter == T::InstanceSetterCallbackWrapper) {
status = Napi::details::AttachData(
env, value, static_cast<InstanceAccessorCallbackData*>(prop->data));
NAPI_THROW_IF_FAILED_VOID(env, status);
}
}
}
template <typename T>
inline ClassPropertyDescriptor<T> InstanceWrap<T>::InstanceMethod(
const char* utf8name,
InstanceVoidMethodCallback method,
napi_property_attributes attributes,
void* data) {
InstanceVoidMethodCallbackData* callbackData =
new InstanceVoidMethodCallbackData({method, data});
napi_property_descriptor desc = napi_property_descriptor();
desc.utf8name = utf8name;
desc.method = T::InstanceVoidMethodCallbackWrapper;
desc.data = callbackData;
desc.attributes = attributes;
return desc;
}
template <typename T>
inline ClassPropertyDescriptor<T> InstanceWrap<T>::InstanceMethod(
const char* utf8name,
InstanceMethodCallback method,
napi_property_attributes attributes,
void* data) {
InstanceMethodCallbackData* callbackData =
new InstanceMethodCallbackData({method, data});
napi_property_descriptor desc = napi_property_descriptor();
desc.utf8name = utf8name;
desc.method = T::InstanceMethodCallbackWrapper;
desc.data = callbackData;
desc.attributes = attributes;
return desc;
}
template <typename T>
inline ClassPropertyDescriptor<T> InstanceWrap<T>::InstanceMethod(
Symbol name,
InstanceVoidMethodCallback method,
napi_property_attributes attributes,
void* data) {
InstanceVoidMethodCallbackData* callbackData =
new InstanceVoidMethodCallbackData({method, data});
napi_property_descriptor desc = napi_property_descriptor();
desc.name = name;
desc.method = T::InstanceVoidMethodCallbackWrapper;
desc.data = callbackData;
desc.attributes = attributes;
return desc;
}
template <typename T>
inline ClassPropertyDescriptor<T> InstanceWrap<T>::InstanceMethod(
Symbol name,
InstanceMethodCallback method,
napi_property_attributes attributes,
void* data) {
InstanceMethodCallbackData* callbackData =
new InstanceMethodCallbackData({method, data});
napi_property_descriptor desc = napi_property_descriptor();
desc.name = name;
desc.method = T::InstanceMethodCallbackWrapper;
desc.data = callbackData;
desc.attributes = attributes;
return desc;
}
template <typename T>
template <typename InstanceWrap<T>::InstanceVoidMethodCallback method>
inline ClassPropertyDescriptor<T> InstanceWrap<T>::InstanceMethod(
const char* utf8name, napi_property_attributes attributes, void* data) {
napi_property_descriptor desc = napi_property_descriptor();
desc.utf8name = utf8name;
desc.method = details::TemplatedInstanceVoidCallback<T, method>;
desc.data = data;
desc.attributes = attributes;
return desc;
}
template <typename T>
template <typename InstanceWrap<T>::InstanceMethodCallback method>
inline ClassPropertyDescriptor<T> InstanceWrap<T>::InstanceMethod(
const char* utf8name, napi_property_attributes attributes, void* data) {
napi_property_descriptor desc = napi_property_descriptor();
desc.utf8name = utf8name;
desc.method = details::TemplatedInstanceCallback<T, method>;
desc.data = data;
desc.attributes = attributes;
return desc;
}
template <typename T>
template <typename InstanceWrap<T>::InstanceVoidMethodCallback method>
inline ClassPropertyDescriptor<T> InstanceWrap<T>::InstanceMethod(
Symbol name, napi_property_attributes attributes, void* data) {
napi_property_descriptor desc = napi_property_descriptor();
desc.name = name;
desc.method = details::TemplatedInstanceVoidCallback<T, method>;
desc.data = data;
desc.attributes = attributes;
return desc;
}
template <typename T>
template <typename InstanceWrap<T>::InstanceMethodCallback method>
inline ClassPropertyDescriptor<T> InstanceWrap<T>::InstanceMethod(
Symbol name, napi_property_attributes attributes, void* data) {
napi_property_descriptor desc = napi_property_descriptor();
desc.name = name;
desc.method = details::TemplatedInstanceCallback<T, method>;
desc.data = data;
desc.attributes = attributes;
return desc;
}
template <typename T>
inline ClassPropertyDescriptor<T> InstanceWrap<T>::InstanceAccessor(
const char* utf8name,
InstanceGetterCallback getter,
InstanceSetterCallback setter,
napi_property_attributes attributes,
void* data) {
InstanceAccessorCallbackData* callbackData =
new InstanceAccessorCallbackData({getter, setter, data});
napi_property_descriptor desc = napi_property_descriptor();
desc.utf8name = utf8name;
desc.getter = getter != nullptr ? T::InstanceGetterCallbackWrapper : nullptr;
desc.setter = setter != nullptr ? T::InstanceSetterCallbackWrapper : nullptr;
desc.data = callbackData;
desc.attributes = attributes;
return desc;
}
template <typename T>
inline ClassPropertyDescriptor<T> InstanceWrap<T>::InstanceAccessor(
Symbol name,
InstanceGetterCallback getter,
InstanceSetterCallback setter,
napi_property_attributes attributes,
void* data) {
InstanceAccessorCallbackData* callbackData =
new InstanceAccessorCallbackData({getter, setter, data});
napi_property_descriptor desc = napi_property_descriptor();
desc.name = name;
desc.getter = getter != nullptr ? T::InstanceGetterCallbackWrapper : nullptr;
desc.setter = setter != nullptr ? T::InstanceSetterCallbackWrapper : nullptr;
desc.data = callbackData;
desc.attributes = attributes;
return desc;
}
template <typename T>
template <typename InstanceWrap<T>::InstanceGetterCallback getter,
typename InstanceWrap<T>::InstanceSetterCallback setter>
inline ClassPropertyDescriptor<T> InstanceWrap<T>::InstanceAccessor(
const char* utf8name, napi_property_attributes attributes, void* data) {
napi_property_descriptor desc = napi_property_descriptor();
desc.utf8name = utf8name;
desc.getter = details::TemplatedInstanceCallback<T, getter>;
desc.setter = This::WrapSetter(This::SetterTag<setter>());
desc.data = data;
desc.attributes = attributes;
return desc;
}
template <typename T>
template <typename InstanceWrap<T>::InstanceGetterCallback getter,
typename InstanceWrap<T>::InstanceSetterCallback setter>
inline ClassPropertyDescriptor<T> InstanceWrap<T>::InstanceAccessor(
Symbol name, napi_property_attributes attributes, void* data) {
napi_property_descriptor desc = napi_property_descriptor();
desc.name = name;
desc.getter = details::TemplatedInstanceCallback<T, getter>;
desc.setter = This::WrapSetter(This::SetterTag<setter>());
desc.data = data;
desc.attributes = attributes;
return desc;
}
template <typename T>
inline ClassPropertyDescriptor<T> InstanceWrap<T>::InstanceValue(
const char* utf8name,
Napi::Value value,
napi_property_attributes attributes) {
napi_property_descriptor desc = napi_property_descriptor();
desc.utf8name = utf8name;
desc.value = value;
desc.attributes = attributes;
return desc;
}
template <typename T>
inline ClassPropertyDescriptor<T> InstanceWrap<T>::InstanceValue(
Symbol name, Napi::Value value, napi_property_attributes attributes) {
napi_property_descriptor desc = napi_property_descriptor();
desc.name = name;
desc.value = value;
desc.attributes = attributes;
return desc;
}
template <typename T>
inline napi_value InstanceWrap<T>::InstanceVoidMethodCallbackWrapper(
napi_env env, napi_callback_info info) {
return details::WrapCallback([&] {
CallbackInfo callbackInfo(env, info);
InstanceVoidMethodCallbackData* callbackData =
reinterpret_cast<InstanceVoidMethodCallbackData*>(callbackInfo.Data());
callbackInfo.SetData(callbackData->data);
T* instance = T::Unwrap(callbackInfo.This().As<Object>());
auto cb = callbackData->callback;
if (instance) (instance->*cb)(callbackInfo);
return nullptr;
});
}
template <typename T>
inline napi_value InstanceWrap<T>::InstanceMethodCallbackWrapper(
napi_env env, napi_callback_info info) {
return details::WrapCallback([&] {
CallbackInfo callbackInfo(env, info);
InstanceMethodCallbackData* callbackData =
reinterpret_cast<InstanceMethodCallbackData*>(callbackInfo.Data());
callbackInfo.SetData(callbackData->data);
T* instance = T::Unwrap(callbackInfo.This().As<Object>());
auto cb = callbackData->callback;
return instance ? (instance->*cb)(callbackInfo) : Napi::Value();
});
}
template <typename T>
inline napi_value InstanceWrap<T>::InstanceGetterCallbackWrapper(
napi_env env, napi_callback_info info) {
return details::WrapCallback([&] {
CallbackInfo callbackInfo(env, info);
InstanceAccessorCallbackData* callbackData =
reinterpret_cast<InstanceAccessorCallbackData*>(callbackInfo.Data());
callbackInfo.SetData(callbackData->data);
T* instance = T::Unwrap(callbackInfo.This().As<Object>());
auto cb = callbackData->getterCallback;
return instance ? (instance->*cb)(callbackInfo) : Napi::Value();
});
}
template <typename T>
inline napi_value InstanceWrap<T>::InstanceSetterCallbackWrapper(
napi_env env, napi_callback_info info) {
return details::WrapCallback([&] {
CallbackInfo callbackInfo(env, info);
InstanceAccessorCallbackData* callbackData =
reinterpret_cast<InstanceAccessorCallbackData*>(callbackInfo.Data());
callbackInfo.SetData(callbackData->data);
T* instance = T::Unwrap(callbackInfo.This().As<Object>());
auto cb = callbackData->setterCallback;
if (instance) (instance->*cb)(callbackInfo, callbackInfo[0]);
return nullptr;
});
}
template <typename T>
template <typename InstanceWrap<T>::InstanceSetterCallback method>
inline napi_value InstanceWrap<T>::WrappedMethod(
napi_env env, napi_callback_info info) NAPI_NOEXCEPT {
return details::WrapCallback([&] {
const CallbackInfo cbInfo(env, info);
T* instance = T::Unwrap(cbInfo.This().As<Object>());
if (instance) (instance->*method)(cbInfo, cbInfo[0]);
return nullptr;
});
}
////////////////////////////////////////////////////////////////////////////////
// ObjectWrap<T> class
////////////////////////////////////////////////////////////////////////////////
template <typename T>
inline ObjectWrap<T>::ObjectWrap(const Napi::CallbackInfo& callbackInfo) {
napi_env env = callbackInfo.Env();
napi_value wrapper = callbackInfo.This();
napi_status status;
napi_ref ref;
T* instance = static_cast<T*>(this);
status = napi_wrap(env, wrapper, instance, FinalizeCallback, nullptr, &ref);
NAPI_THROW_IF_FAILED_VOID(env, status);
Reference<Object>* instanceRef = instance;
*instanceRef = Reference<Object>(env, ref);
}
template <typename T>
inline ObjectWrap<T>::~ObjectWrap() {
// If the JS object still exists at this point, remove the finalizer added
// through `napi_wrap()`.
if (!IsEmpty()) {
Object object = Value();
// It is not valid to call `napi_remove_wrap()` with an empty `object`.
// This happens e.g. during garbage collection.
if (!object.IsEmpty() && _construction_failed) {
napi_remove_wrap(Env(), object, nullptr);
}
}
}
template <typename T>
inline T* ObjectWrap<T>::Unwrap(Object wrapper) {
void* unwrapped;
napi_status status = napi_unwrap(wrapper.Env(), wrapper, &unwrapped);
NAPI_THROW_IF_FAILED(wrapper.Env(), status, nullptr);
return static_cast<T*>(unwrapped);
}
template <typename T>
inline Function ObjectWrap<T>::DefineClass(
Napi::Env env,
const char* utf8name,
const size_t props_count,
const napi_property_descriptor* descriptors,
void* data) {
napi_status status;
std::vector<napi_property_descriptor> props(props_count);
// We copy the descriptors to a local array because before defining the class
// we must replace static method property descriptors with value property
// descriptors such that the value is a function-valued `napi_value` created
// with `CreateFunction()`.
//
// This replacement could be made for instance methods as well, but V8 aborts
// if we do that, because it expects methods defined on the prototype template
// to have `FunctionTemplate`s.
for (size_t index = 0; index < props_count; index++) {
props[index] = descriptors[index];
napi_property_descriptor* prop = &props[index];
if (prop->method == T::StaticMethodCallbackWrapper) {
status =
CreateFunction(env,
utf8name,
prop->method,
static_cast<StaticMethodCallbackData*>(prop->data),
&(prop->value));
NAPI_THROW_IF_FAILED(env, status, Function());
prop->method = nullptr;
prop->data = nullptr;
} else if (prop->method == T::StaticVoidMethodCallbackWrapper) {
status =
CreateFunction(env,
utf8name,
prop->method,
static_cast<StaticVoidMethodCallbackData*>(prop->data),
&(prop->value));
NAPI_THROW_IF_FAILED(env, status, Function());
prop->method = nullptr;
prop->data = nullptr;
}
}
napi_value value;
status = napi_define_class(env,
utf8name,
NAPI_AUTO_LENGTH,
T::ConstructorCallbackWrapper,
data,
props_count,
props.data(),
&value);
NAPI_THROW_IF_FAILED(env, status, Function());
// After defining the class we iterate once more over the property descriptors
// and attach the data associated with accessors and instance methods to the
// newly created JavaScript class.
for (size_t idx = 0; idx < props_count; idx++) {
const napi_property_descriptor* prop = &props[idx];
if (prop->getter == T::StaticGetterCallbackWrapper ||
prop->setter == T::StaticSetterCallbackWrapper) {
status = Napi::details::AttachData(
env, value, static_cast<StaticAccessorCallbackData*>(prop->data));
NAPI_THROW_IF_FAILED(env, status, Function());
} else {
// InstanceWrap<T>::AttachPropData is responsible for attaching the data
// of instance methods and accessors.
T::AttachPropData(env, value, prop);
}
}
return Function(env, value);
}
template <typename T>
inline Function ObjectWrap<T>::DefineClass(
Napi::Env env,
const char* utf8name,
const std::initializer_list<ClassPropertyDescriptor<T>>& properties,
void* data) {
return DefineClass(
env,
utf8name,
properties.size(),
reinterpret_cast<const napi_property_descriptor*>(properties.begin()),
data);
}
template <typename T>
inline Function ObjectWrap<T>::DefineClass(
Napi::Env env,
const char* utf8name,
const std::vector<ClassPropertyDescriptor<T>>& properties,
void* data) {
return DefineClass(
env,
utf8name,
properties.size(),
reinterpret_cast<const napi_property_descriptor*>(properties.data()),
data);
}
template <typename T>
inline ClassPropertyDescriptor<T> ObjectWrap<T>::StaticMethod(
const char* utf8name,
StaticVoidMethodCallback method,
napi_property_attributes attributes,
void* data) {
StaticVoidMethodCallbackData* callbackData =
new StaticVoidMethodCallbackData({method, data});
napi_property_descriptor desc = napi_property_descriptor();
desc.utf8name = utf8name;
desc.method = T::StaticVoidMethodCallbackWrapper;
desc.data = callbackData;
desc.attributes =
static_cast<napi_property_attributes>(attributes | napi_static);
return desc;
}
template <typename T>
inline ClassPropertyDescriptor<T> ObjectWrap<T>::StaticMethod(
const char* utf8name,
StaticMethodCallback method,
napi_property_attributes attributes,
void* data) {
StaticMethodCallbackData* callbackData =
new StaticMethodCallbackData({method, data});
napi_property_descriptor desc = napi_property_descriptor();
desc.utf8name = utf8name;
desc.method = T::StaticMethodCallbackWrapper;
desc.data = callbackData;
desc.attributes =
static_cast<napi_property_attributes>(attributes | napi_static);
return desc;
}
template <typename T>
inline ClassPropertyDescriptor<T> ObjectWrap<T>::StaticMethod(
Symbol name,
StaticVoidMethodCallback method,
napi_property_attributes attributes,
void* data) {
StaticVoidMethodCallbackData* callbackData =
new StaticVoidMethodCallbackData({method, data});
napi_property_descriptor desc = napi_property_descriptor();
desc.name = name;
desc.method = T::StaticVoidMethodCallbackWrapper;
desc.data = callbackData;
desc.attributes =
static_cast<napi_property_attributes>(attributes | napi_static);
return desc;
}
template <typename T>
inline ClassPropertyDescriptor<T> ObjectWrap<T>::StaticMethod(
Symbol name,
StaticMethodCallback method,
napi_property_attributes attributes,
void* data) {
StaticMethodCallbackData* callbackData =
new StaticMethodCallbackData({method, data});
napi_property_descriptor desc = napi_property_descriptor();
desc.name = name;
desc.method = T::StaticMethodCallbackWrapper;
desc.data = callbackData;
desc.attributes =
static_cast<napi_property_attributes>(attributes | napi_static);
return desc;
}
template <typename T>
template <typename ObjectWrap<T>::StaticVoidMethodCallback method>
inline ClassPropertyDescriptor<T> ObjectWrap<T>::StaticMethod(
const char* utf8name, napi_property_attributes attributes, void* data) {
napi_property_descriptor desc = napi_property_descriptor();
desc.utf8name = utf8name;
desc.method = details::TemplatedVoidCallback<method>;
desc.data = data;
desc.attributes =
static_cast<napi_property_attributes>(attributes | napi_static);
return desc;
}
template <typename T>
template <typename ObjectWrap<T>::StaticVoidMethodCallback method>
inline ClassPropertyDescriptor<T> ObjectWrap<T>::StaticMethod(
Symbol name, napi_property_attributes attributes, void* data) {
napi_property_descriptor desc = napi_property_descriptor();
desc.name = name;
desc.method = details::TemplatedVoidCallback<method>;
desc.data = data;
desc.attributes =
static_cast<napi_property_attributes>(attributes | napi_static);
return desc;
}
template <typename T>
template <typename ObjectWrap<T>::StaticMethodCallback method>
inline ClassPropertyDescriptor<T> ObjectWrap<T>::StaticMethod(
const char* utf8name, napi_property_attributes attributes, void* data) {
napi_property_descriptor desc = napi_property_descriptor();
desc.utf8name = utf8name;
desc.method = details::TemplatedCallback<method>;
desc.data = data;
desc.attributes =
static_cast<napi_property_attributes>(attributes | napi_static);
return desc;
}
template <typename T>
template <typename ObjectWrap<T>::StaticMethodCallback method>
inline ClassPropertyDescriptor<T> ObjectWrap<T>::StaticMethod(
Symbol name, napi_property_attributes attributes, void* data) {
napi_property_descriptor desc = napi_property_descriptor();
desc.name = name;
desc.method = details::TemplatedCallback<method>;
desc.data = data;
desc.attributes =
static_cast<napi_property_attributes>(attributes | napi_static);
return desc;
}
template <typename T>
inline ClassPropertyDescriptor<T> ObjectWrap<T>::StaticAccessor(
const char* utf8name,
StaticGetterCallback getter,
StaticSetterCallback setter,
napi_property_attributes attributes,
void* data) {
StaticAccessorCallbackData* callbackData =
new StaticAccessorCallbackData({getter, setter, data});
napi_property_descriptor desc = napi_property_descriptor();
desc.utf8name = utf8name;
desc.getter = getter != nullptr ? T::StaticGetterCallbackWrapper : nullptr;
desc.setter = setter != nullptr ? T::StaticSetterCallbackWrapper : nullptr;
desc.data = callbackData;
desc.attributes =
static_cast<napi_property_attributes>(attributes | napi_static);
return desc;
}
template <typename T>
inline ClassPropertyDescriptor<T> ObjectWrap<T>::StaticAccessor(
Symbol name,
StaticGetterCallback getter,
StaticSetterCallback setter,
napi_property_attributes attributes,
void* data) {
StaticAccessorCallbackData* callbackData =
new StaticAccessorCallbackData({getter, setter, data});
napi_property_descriptor desc = napi_property_descriptor();
desc.name = name;
desc.getter = getter != nullptr ? T::StaticGetterCallbackWrapper : nullptr;
desc.setter = setter != nullptr ? T::StaticSetterCallbackWrapper : nullptr;
desc.data = callbackData;
desc.attributes =
static_cast<napi_property_attributes>(attributes | napi_static);
return desc;
}
template <typename T>
template <typename ObjectWrap<T>::StaticGetterCallback getter,
typename ObjectWrap<T>::StaticSetterCallback setter>
inline ClassPropertyDescriptor<T> ObjectWrap<T>::StaticAccessor(
const char* utf8name, napi_property_attributes attributes, void* data) {
napi_property_descriptor desc = napi_property_descriptor();
desc.utf8name = utf8name;
desc.getter = details::TemplatedCallback<getter>;
desc.setter = This::WrapStaticSetter(This::StaticSetterTag<setter>());
desc.data = data;
desc.attributes =
static_cast<napi_property_attributes>(attributes | napi_static);
return desc;
}
template <typename T>
template <typename ObjectWrap<T>::StaticGetterCallback getter,
typename ObjectWrap<T>::StaticSetterCallback setter>
inline ClassPropertyDescriptor<T> ObjectWrap<T>::StaticAccessor(
Symbol name, napi_property_attributes attributes, void* data) {
napi_property_descriptor desc = napi_property_descriptor();
desc.name = name;
desc.getter = details::TemplatedCallback<getter>;
desc.setter = This::WrapStaticSetter(This::StaticSetterTag<setter>());
desc.data = data;
desc.attributes =
static_cast<napi_property_attributes>(attributes | napi_static);
return desc;
}
template <typename T>
inline ClassPropertyDescriptor<T> ObjectWrap<T>::StaticValue(
const char* utf8name,
Napi::Value value,
napi_property_attributes attributes) {
napi_property_descriptor desc = napi_property_descriptor();
desc.utf8name = utf8name;
desc.value = value;
desc.attributes =
static_cast<napi_property_attributes>(attributes | napi_static);
return desc;
}
template <typename T>
inline ClassPropertyDescriptor<T> ObjectWrap<T>::StaticValue(
Symbol name, Napi::Value value, napi_property_attributes attributes) {
napi_property_descriptor desc = napi_property_descriptor();
desc.name = name;
desc.value = value;
desc.attributes =
static_cast<napi_property_attributes>(attributes | napi_static);
return desc;
}
template <typename T>
inline Value ObjectWrap<T>::OnCalledAsFunction(
const Napi::CallbackInfo& callbackInfo) {
NAPI_THROW(
TypeError::New(callbackInfo.Env(),
"Class constructors cannot be invoked without 'new'"),
Napi::Value());
}
template <typename T>
inline void ObjectWrap<T>::Finalize(Napi::Env /*env*/) {}
template <typename T>
inline napi_value ObjectWrap<T>::ConstructorCallbackWrapper(
napi_env env, napi_callback_info info) {
napi_value new_target;
napi_status status = napi_get_new_target(env, info, &new_target);
if (status != napi_ok) return nullptr;
bool isConstructCall = (new_target != nullptr);
if (!isConstructCall) {
return details::WrapCallback(
[&] { return T::OnCalledAsFunction(CallbackInfo(env, info)); });
}
napi_value wrapper = details::WrapCallback([&] {
CallbackInfo callbackInfo(env, info);
T* instance = new T(callbackInfo);
#ifdef NAPI_CPP_EXCEPTIONS
instance->_construction_failed = false;
#else
if (callbackInfo.Env().IsExceptionPending()) {
// We need to clear the exception so that removing the wrap might work.
Error e = callbackInfo.Env().GetAndClearPendingException();
delete instance;
e.ThrowAsJavaScriptException();
} else {
instance->_construction_failed = false;
}
#endif // NAPI_CPP_EXCEPTIONS
return callbackInfo.This();
});
return wrapper;
}
template <typename T>
inline napi_value ObjectWrap<T>::StaticVoidMethodCallbackWrapper(
napi_env env, napi_callback_info info) {
return details::WrapCallback([&] {
CallbackInfo callbackInfo(env, info);
StaticVoidMethodCallbackData* callbackData =
reinterpret_cast<StaticVoidMethodCallbackData*>(callbackInfo.Data());
callbackInfo.SetData(callbackData->data);
callbackData->callback(callbackInfo);
return nullptr;
});
}
template <typename T>
inline napi_value ObjectWrap<T>::StaticMethodCallbackWrapper(
napi_env env, napi_callback_info info) {
return details::WrapCallback([&] {
CallbackInfo callbackInfo(env, info);
StaticMethodCallbackData* callbackData =
reinterpret_cast<StaticMethodCallbackData*>(callbackInfo.Data());
callbackInfo.SetData(callbackData->data);
return callbackData->callback(callbackInfo);
});
}
template <typename T>
inline napi_value ObjectWrap<T>::StaticGetterCallbackWrapper(
napi_env env, napi_callback_info info) {
return details::WrapCallback([&] {
CallbackInfo callbackInfo(env, info);
StaticAccessorCallbackData* callbackData =
reinterpret_cast<StaticAccessorCallbackData*>(callbackInfo.Data());
callbackInfo.SetData(callbackData->data);
return callbackData->getterCallback(callbackInfo);
});
}
template <typename T>
inline napi_value ObjectWrap<T>::StaticSetterCallbackWrapper(
napi_env env, napi_callback_info info) {
return details::WrapCallback([&] {
CallbackInfo callbackInfo(env, info);
StaticAccessorCallbackData* callbackData =
reinterpret_cast<StaticAccessorCallbackData*>(callbackInfo.Data());
callbackInfo.SetData(callbackData->data);
callbackData->setterCallback(callbackInfo, callbackInfo[0]);
return nullptr;
});
}
template <typename T>
inline void ObjectWrap<T>::FinalizeCallback(napi_env env,
void* data,
void* /*hint*/) {
HandleScope scope(env);
T* instance = static_cast<T*>(data);
instance->Finalize(Napi::Env(env));
delete instance;
}
template <typename T>
template <typename ObjectWrap<T>::StaticSetterCallback method>
inline napi_value ObjectWrap<T>::WrappedMethod(
napi_env env, napi_callback_info info) NAPI_NOEXCEPT {
return details::WrapCallback([&] {
const CallbackInfo cbInfo(env, info);
method(cbInfo, cbInfo[0]);
return nullptr;
});
}
////////////////////////////////////////////////////////////////////////////////
// HandleScope class
////////////////////////////////////////////////////////////////////////////////
inline HandleScope::HandleScope(napi_env env, napi_handle_scope scope)
: _env(env), _scope(scope) {}
inline HandleScope::HandleScope(Napi::Env env) : _env(env) {
napi_status status = napi_open_handle_scope(_env, &_scope);
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
inline HandleScope::~HandleScope() {
napi_status status = napi_close_handle_scope(_env, _scope);
NAPI_FATAL_IF_FAILED(
status, "HandleScope::~HandleScope", "napi_close_handle_scope");
}
inline HandleScope::operator napi_handle_scope() const {
return _scope;
}
inline Napi::Env HandleScope::Env() const {
return Napi::Env(_env);
}
////////////////////////////////////////////////////////////////////////////////
// EscapableHandleScope class
////////////////////////////////////////////////////////////////////////////////
inline EscapableHandleScope::EscapableHandleScope(
napi_env env, napi_escapable_handle_scope scope)
: _env(env), _scope(scope) {}
inline EscapableHandleScope::EscapableHandleScope(Napi::Env env) : _env(env) {
napi_status status = napi_open_escapable_handle_scope(_env, &_scope);
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
inline EscapableHandleScope::~EscapableHandleScope() {
napi_status status = napi_close_escapable_handle_scope(_env, _scope);
NAPI_FATAL_IF_FAILED(status,
"EscapableHandleScope::~EscapableHandleScope",
"napi_close_escapable_handle_scope");
}
inline EscapableHandleScope::operator napi_escapable_handle_scope() const {
return _scope;
}
inline Napi::Env EscapableHandleScope::Env() const {
return Napi::Env(_env);
}
inline Value EscapableHandleScope::Escape(napi_value escapee) {
napi_value result;
napi_status status = napi_escape_handle(_env, _scope, escapee, &result);
NAPI_THROW_IF_FAILED(_env, status, Value());
return Value(_env, result);
}
#if (NAPI_VERSION > 2)
////////////////////////////////////////////////////////////////////////////////
// CallbackScope class
////////////////////////////////////////////////////////////////////////////////
inline CallbackScope::CallbackScope(napi_env env, napi_callback_scope scope)
: _env(env), _scope(scope) {}
inline CallbackScope::CallbackScope(napi_env env, napi_async_context context)
: _env(env) {
napi_status status =
napi_open_callback_scope(_env, Object::New(env), context, &_scope);
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
inline CallbackScope::~CallbackScope() {
napi_status status = napi_close_callback_scope(_env, _scope);
NAPI_FATAL_IF_FAILED(
status, "CallbackScope::~CallbackScope", "napi_close_callback_scope");
}
inline CallbackScope::operator napi_callback_scope() const {
return _scope;
}
inline Napi::Env CallbackScope::Env() const {
return Napi::Env(_env);
}
#endif
////////////////////////////////////////////////////////////////////////////////
// AsyncContext class
////////////////////////////////////////////////////////////////////////////////
inline AsyncContext::AsyncContext(napi_env env, const char* resource_name)
: AsyncContext(env, resource_name, Object::New(env)) {}
inline AsyncContext::AsyncContext(napi_env env,
const char* resource_name,
const Object& resource)
: _env(env), _context(nullptr) {
napi_value resource_id;
napi_status status = napi_create_string_utf8(
_env, resource_name, NAPI_AUTO_LENGTH, &resource_id);
NAPI_THROW_IF_FAILED_VOID(_env, status);
status = napi_async_init(_env, resource, resource_id, &_context);
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
inline AsyncContext::~AsyncContext() {
if (_context != nullptr) {
napi_async_destroy(_env, _context);
_context = nullptr;
}
}
inline AsyncContext::AsyncContext(AsyncContext&& other) {
_env = other._env;
other._env = nullptr;
_context = other._context;
other._context = nullptr;
}
inline AsyncContext& AsyncContext::operator=(AsyncContext&& other) {
_env = other._env;
other._env = nullptr;
_context = other._context;
other._context = nullptr;
return *this;
}
inline AsyncContext::operator napi_async_context() const {
return _context;
}
inline Napi::Env AsyncContext::Env() const {
return Napi::Env(_env);
}
////////////////////////////////////////////////////////////////////////////////
// AsyncWorker class
////////////////////////////////////////////////////////////////////////////////
#if NAPI_HAS_THREADS
inline AsyncWorker::AsyncWorker(const Function& callback)
: AsyncWorker(callback, "generic") {}
inline AsyncWorker::AsyncWorker(const Function& callback,
const char* resource_name)
: AsyncWorker(callback, resource_name, Object::New(callback.Env())) {}
inline AsyncWorker::AsyncWorker(const Function& callback,
const char* resource_name,
const Object& resource)
: AsyncWorker(
Object::New(callback.Env()), callback, resource_name, resource) {}
inline AsyncWorker::AsyncWorker(const Object& receiver,
const Function& callback)
: AsyncWorker(receiver, callback, "generic") {}
inline AsyncWorker::AsyncWorker(const Object& receiver,
const Function& callback,
const char* resource_name)
: AsyncWorker(
receiver, callback, resource_name, Object::New(callback.Env())) {}
inline AsyncWorker::AsyncWorker(const Object& receiver,
const Function& callback,
const char* resource_name,
const Object& resource)
: _env(callback.Env()),
_receiver(Napi::Persistent(receiver)),
_callback(Napi::Persistent(callback)),
_suppress_destruct(false) {
napi_value resource_id;
napi_status status = napi_create_string_latin1(
_env, resource_name, NAPI_AUTO_LENGTH, &resource_id);
NAPI_THROW_IF_FAILED_VOID(_env, status);
status = napi_create_async_work(_env,
resource,
resource_id,
OnAsyncWorkExecute,
OnAsyncWorkComplete,
this,
&_work);
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
inline AsyncWorker::AsyncWorker(Napi::Env env) : AsyncWorker(env, "generic") {}
inline AsyncWorker::AsyncWorker(Napi::Env env, const char* resource_name)
: AsyncWorker(env, resource_name, Object::New(env)) {}
inline AsyncWorker::AsyncWorker(Napi::Env env,
const char* resource_name,
const Object& resource)
: _env(env), _receiver(), _callback(), _suppress_destruct(false) {
napi_value resource_id;
napi_status status = napi_create_string_latin1(
_env, resource_name, NAPI_AUTO_LENGTH, &resource_id);
NAPI_THROW_IF_FAILED_VOID(_env, status);
status = napi_create_async_work(_env,
resource,
resource_id,
OnAsyncWorkExecute,
OnAsyncWorkComplete,
this,
&_work);
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
inline AsyncWorker::~AsyncWorker() {
if (_work != nullptr) {
napi_delete_async_work(_env, _work);
_work = nullptr;
}
}
inline void AsyncWorker::Destroy() {
delete this;
}
inline AsyncWorker::operator napi_async_work() const {
return _work;
}
inline Napi::Env AsyncWorker::Env() const {
return Napi::Env(_env);
}
inline void AsyncWorker::Queue() {
napi_status status = napi_queue_async_work(_env, _work);
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
inline void AsyncWorker::Cancel() {
napi_status status = napi_cancel_async_work(_env, _work);
NAPI_THROW_IF_FAILED_VOID(_env, status);
}
inline ObjectReference& AsyncWorker::Receiver() {
return _receiver;
}
inline FunctionReference& AsyncWorker::Callback() {
return _callback;
}
inline void AsyncWorker::SuppressDestruct() {
_suppress_destruct = true;
}
inline void AsyncWorker::OnOK() {
if (!_callback.IsEmpty()) {
_callback.Call(_receiver.Value(), GetResult(_callback.Env()));
}
}
inline void AsyncWorker::OnError(const Error& e) {
if (!_callback.IsEmpty()) {
_callback.Call(_receiver.Value(),
std::initializer_list<napi_value>{e.Value()});
}
}
inline void AsyncWorker::SetError(const std::string& error) {
_error = error;
}
inline std::vector<napi_value> AsyncWorker::GetResult(Napi::Env /*env*/) {
return {};
}
// The OnAsyncWorkExecute method receives an napi_env argument. However, do NOT
// use it within this method, as it does not run on the JavaScript thread and
// must not run any method that would cause JavaScript to run. In practice,
// this means that almost any use of napi_env will be incorrect.
inline void AsyncWorker::OnAsyncWorkExecute(napi_env env, void* asyncworker) {
AsyncWorker* self = static_cast<AsyncWorker*>(asyncworker);
self->OnExecute(env);
}
// The OnExecute method receives an napi_env argument. However, do NOT
// use it within this method, as it does not run on the JavaScript thread and
// must not run any method that would cause JavaScript to run. In practice,
// this means that almost any use of napi_env will be incorrect.
inline void AsyncWorker::OnExecute(Napi::Env /*DO_NOT_USE*/) {
#ifdef NAPI_CPP_EXCEPTIONS
try {
Execute();
} catch (const std::exception& e) {
SetError(e.what());
}
#else // NAPI_CPP_EXCEPTIONS
Execute();
#endif // NAPI_CPP_EXCEPTIONS
}
inline void AsyncWorker::OnAsyncWorkComplete(napi_env env,
napi_status status,
void* asyncworker) {
AsyncWorker* self = static_cast<AsyncWorker*>(asyncworker);
self->OnWorkComplete(env, status);
}
inline void AsyncWorker::OnWorkComplete(Napi::Env /*env*/, napi_status status) {
if (status != napi_cancelled) {
HandleScope scope(_env);
details::WrapCallback([&] {
if (_error.size() == 0) {
OnOK();
} else {
OnError(Error::New(_env, _error));
}
return nullptr;
});
}
if (!_suppress_destruct) {
Destroy();
}
}
#endif // NAPI_HAS_THREADS
#if (NAPI_VERSION > 3 && NAPI_HAS_THREADS)
////////////////////////////////////////////////////////////////////////////////
// TypedThreadSafeFunction<ContextType,DataType,CallJs> class
////////////////////////////////////////////////////////////////////////////////
// Starting with NAPI 5, the JavaScript function `func` parameter of
// `napi_create_threadsafe_function` is optional.
#if NAPI_VERSION > 4
// static, with Callback [missing] Resource [missing] Finalizer [missing]
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
template <typename ResourceString>
inline TypedThreadSafeFunction<ContextType, DataType, CallJs>
TypedThreadSafeFunction<ContextType, DataType, CallJs>::New(
napi_env env,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context) {
TypedThreadSafeFunction<ContextType, DataType, CallJs> tsfn;
napi_status status =
napi_create_threadsafe_function(env,
nullptr,
nullptr,
String::From(env, resourceName),
maxQueueSize,
initialThreadCount,
nullptr,
nullptr,
context,
CallJsInternal,
&tsfn._tsfn);
if (status != napi_ok) {
NAPI_THROW_IF_FAILED(
env, status, TypedThreadSafeFunction<ContextType, DataType, CallJs>());
}
return tsfn;
}
// static, with Callback [missing] Resource [passed] Finalizer [missing]
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
template <typename ResourceString>
inline TypedThreadSafeFunction<ContextType, DataType, CallJs>
TypedThreadSafeFunction<ContextType, DataType, CallJs>::New(
napi_env env,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context) {
TypedThreadSafeFunction<ContextType, DataType, CallJs> tsfn;
napi_status status =
napi_create_threadsafe_function(env,
nullptr,
resource,
String::From(env, resourceName),
maxQueueSize,
initialThreadCount,
nullptr,
nullptr,
context,
CallJsInternal,
&tsfn._tsfn);
if (status != napi_ok) {
NAPI_THROW_IF_FAILED(
env, status, TypedThreadSafeFunction<ContextType, DataType, CallJs>());
}
return tsfn;
}
// static, with Callback [missing] Resource [missing] Finalizer [passed]
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
template <typename ResourceString,
typename Finalizer,
typename FinalizerDataType>
inline TypedThreadSafeFunction<ContextType, DataType, CallJs>
TypedThreadSafeFunction<ContextType, DataType, CallJs>::New(
napi_env env,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context,
Finalizer finalizeCallback,
FinalizerDataType* data) {
TypedThreadSafeFunction<ContextType, DataType, CallJs> tsfn;
auto* finalizeData = new details::
ThreadSafeFinalize<ContextType, Finalizer, FinalizerDataType>(
{data, finalizeCallback});
napi_status status = napi_create_threadsafe_function(
env,
nullptr,
nullptr,
String::From(env, resourceName),
maxQueueSize,
initialThreadCount,
finalizeData,
details::ThreadSafeFinalize<ContextType, Finalizer, FinalizerDataType>::
FinalizeFinalizeWrapperWithDataAndContext,
context,
CallJsInternal,
&tsfn._tsfn);
if (status != napi_ok) {
delete finalizeData;
NAPI_THROW_IF_FAILED(
env, status, TypedThreadSafeFunction<ContextType, DataType, CallJs>());
}
return tsfn;
}
// static, with Callback [missing] Resource [passed] Finalizer [passed]
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
template <typename ResourceString,
typename Finalizer,
typename FinalizerDataType>
inline TypedThreadSafeFunction<ContextType, DataType, CallJs>
TypedThreadSafeFunction<ContextType, DataType, CallJs>::New(
napi_env env,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context,
Finalizer finalizeCallback,
FinalizerDataType* data) {
TypedThreadSafeFunction<ContextType, DataType, CallJs> tsfn;
auto* finalizeData = new details::
ThreadSafeFinalize<ContextType, Finalizer, FinalizerDataType>(
{data, finalizeCallback});
napi_status status = napi_create_threadsafe_function(
env,
nullptr,
resource,
String::From(env, resourceName),
maxQueueSize,
initialThreadCount,
finalizeData,
details::ThreadSafeFinalize<ContextType, Finalizer, FinalizerDataType>::
FinalizeFinalizeWrapperWithDataAndContext,
context,
CallJsInternal,
&tsfn._tsfn);
if (status != napi_ok) {
delete finalizeData;
NAPI_THROW_IF_FAILED(
env, status, TypedThreadSafeFunction<ContextType, DataType, CallJs>());
}
return tsfn;
}
#endif
// static, with Callback [passed] Resource [missing] Finalizer [missing]
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
template <typename ResourceString>
inline TypedThreadSafeFunction<ContextType, DataType, CallJs>
TypedThreadSafeFunction<ContextType, DataType, CallJs>::New(
napi_env env,
const Function& callback,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context) {
TypedThreadSafeFunction<ContextType, DataType, CallJs> tsfn;
napi_status status =
napi_create_threadsafe_function(env,
callback,
nullptr,
String::From(env, resourceName),
maxQueueSize,
initialThreadCount,
nullptr,
nullptr,
context,
CallJsInternal,
&tsfn._tsfn);
if (status != napi_ok) {
NAPI_THROW_IF_FAILED(
env, status, TypedThreadSafeFunction<ContextType, DataType, CallJs>());
}
return tsfn;
}
// static, with Callback [passed] Resource [passed] Finalizer [missing]
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
template <typename ResourceString>
inline TypedThreadSafeFunction<ContextType, DataType, CallJs>
TypedThreadSafeFunction<ContextType, DataType, CallJs>::New(
napi_env env,
const Function& callback,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context) {
TypedThreadSafeFunction<ContextType, DataType, CallJs> tsfn;
napi_status status =
napi_create_threadsafe_function(env,
callback,
resource,
String::From(env, resourceName),
maxQueueSize,
initialThreadCount,
nullptr,
nullptr,
context,
CallJsInternal,
&tsfn._tsfn);
if (status != napi_ok) {
NAPI_THROW_IF_FAILED(
env, status, TypedThreadSafeFunction<ContextType, DataType, CallJs>());
}
return tsfn;
}
// static, with Callback [passed] Resource [missing] Finalizer [passed]
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
template <typename ResourceString,
typename Finalizer,
typename FinalizerDataType>
inline TypedThreadSafeFunction<ContextType, DataType, CallJs>
TypedThreadSafeFunction<ContextType, DataType, CallJs>::New(
napi_env env,
const Function& callback,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context,
Finalizer finalizeCallback,
FinalizerDataType* data) {
TypedThreadSafeFunction<ContextType, DataType, CallJs> tsfn;
auto* finalizeData = new details::
ThreadSafeFinalize<ContextType, Finalizer, FinalizerDataType>(
{data, finalizeCallback});
napi_status status = napi_create_threadsafe_function(
env,
callback,
nullptr,
String::From(env, resourceName),
maxQueueSize,
initialThreadCount,
finalizeData,
details::ThreadSafeFinalize<ContextType, Finalizer, FinalizerDataType>::
FinalizeFinalizeWrapperWithDataAndContext,
context,
CallJsInternal,
&tsfn._tsfn);
if (status != napi_ok) {
delete finalizeData;
NAPI_THROW_IF_FAILED(
env, status, TypedThreadSafeFunction<ContextType, DataType, CallJs>());
}
return tsfn;
}
// static, with: Callback [passed] Resource [passed] Finalizer [passed]
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
template <typename CallbackType,
typename ResourceString,
typename Finalizer,
typename FinalizerDataType>
inline TypedThreadSafeFunction<ContextType, DataType, CallJs>
TypedThreadSafeFunction<ContextType, DataType, CallJs>::New(
napi_env env,
CallbackType callback,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context,
Finalizer finalizeCallback,
FinalizerDataType* data) {
TypedThreadSafeFunction<ContextType, DataType, CallJs> tsfn;
auto* finalizeData = new details::
ThreadSafeFinalize<ContextType, Finalizer, FinalizerDataType>(
{data, finalizeCallback});
napi_status status = napi_create_threadsafe_function(
env,
details::DefaultCallbackWrapper<
CallbackType,
TypedThreadSafeFunction<ContextType, DataType, CallJs>>(env,
callback),
resource,
String::From(env, resourceName),
maxQueueSize,
initialThreadCount,
finalizeData,
details::ThreadSafeFinalize<ContextType, Finalizer, FinalizerDataType>::
FinalizeFinalizeWrapperWithDataAndContext,
context,
CallJsInternal,
&tsfn._tsfn);
if (status != napi_ok) {
delete finalizeData;
NAPI_THROW_IF_FAILED(
env, status, TypedThreadSafeFunction<ContextType, DataType, CallJs>());
}
return tsfn;
}
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
inline TypedThreadSafeFunction<ContextType, DataType, CallJs>::
TypedThreadSafeFunction()
: _tsfn() {}
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
inline TypedThreadSafeFunction<ContextType, DataType, CallJs>::
TypedThreadSafeFunction(napi_threadsafe_function tsfn)
: _tsfn(tsfn) {}
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
inline TypedThreadSafeFunction<ContextType, DataType, CallJs>::
operator napi_threadsafe_function() const {
return _tsfn;
}
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
inline napi_status
TypedThreadSafeFunction<ContextType, DataType, CallJs>::BlockingCall(
DataType* data) const {
return napi_call_threadsafe_function(_tsfn, data, napi_tsfn_blocking);
}
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
inline napi_status
TypedThreadSafeFunction<ContextType, DataType, CallJs>::NonBlockingCall(
DataType* data) const {
return napi_call_threadsafe_function(_tsfn, data, napi_tsfn_nonblocking);
}
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
inline void TypedThreadSafeFunction<ContextType, DataType, CallJs>::Ref(
napi_env env) const {
if (_tsfn != nullptr) {
napi_status status = napi_ref_threadsafe_function(env, _tsfn);
NAPI_THROW_IF_FAILED_VOID(env, status);
}
}
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
inline void TypedThreadSafeFunction<ContextType, DataType, CallJs>::Unref(
napi_env env) const {
if (_tsfn != nullptr) {
napi_status status = napi_unref_threadsafe_function(env, _tsfn);
NAPI_THROW_IF_FAILED_VOID(env, status);
}
}
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
inline napi_status
TypedThreadSafeFunction<ContextType, DataType, CallJs>::Acquire() const {
return napi_acquire_threadsafe_function(_tsfn);
}
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
inline napi_status
TypedThreadSafeFunction<ContextType, DataType, CallJs>::Release() const {
return napi_release_threadsafe_function(_tsfn, napi_tsfn_release);
}
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
inline napi_status
TypedThreadSafeFunction<ContextType, DataType, CallJs>::Abort() const {
return napi_release_threadsafe_function(_tsfn, napi_tsfn_abort);
}
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
inline ContextType*
TypedThreadSafeFunction<ContextType, DataType, CallJs>::GetContext() const {
void* context;
napi_status status = napi_get_threadsafe_function_context(_tsfn, &context);
NAPI_FATAL_IF_FAILED(status,
"TypedThreadSafeFunction::GetContext",
"napi_get_threadsafe_function_context");
return static_cast<ContextType*>(context);
}
// static
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
void TypedThreadSafeFunction<ContextType, DataType, CallJs>::CallJsInternal(
napi_env env, napi_value jsCallback, void* context, void* data) {
details::CallJsWrapper<ContextType, DataType, decltype(CallJs), CallJs>(
env, jsCallback, context, data);
}
#if NAPI_VERSION == 4
// static
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
Napi::Function
TypedThreadSafeFunction<ContextType, DataType, CallJs>::EmptyFunctionFactory(
Napi::Env env) {
return Napi::Function::New(env, [](const CallbackInfo& cb) {});
}
// static
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
Napi::Function
TypedThreadSafeFunction<ContextType, DataType, CallJs>::FunctionOrEmpty(
Napi::Env env, Napi::Function& callback) {
if (callback.IsEmpty()) {
return EmptyFunctionFactory(env);
}
return callback;
}
#else
// static
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
std::nullptr_t
TypedThreadSafeFunction<ContextType, DataType, CallJs>::EmptyFunctionFactory(
Napi::Env /*env*/) {
return nullptr;
}
// static
template <typename ContextType,
typename DataType,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*)>
Napi::Function
TypedThreadSafeFunction<ContextType, DataType, CallJs>::FunctionOrEmpty(
Napi::Env /*env*/, Napi::Function& callback) {
return callback;
}
#endif
////////////////////////////////////////////////////////////////////////////////
// ThreadSafeFunction class
////////////////////////////////////////////////////////////////////////////////
// static
template <typename ResourceString>
inline ThreadSafeFunction ThreadSafeFunction::New(napi_env env,
const Function& callback,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount) {
return New(
env, callback, Object(), resourceName, maxQueueSize, initialThreadCount);
}
// static
template <typename ResourceString, typename ContextType>
inline ThreadSafeFunction ThreadSafeFunction::New(napi_env env,
const Function& callback,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context) {
return New(env,
callback,
Object(),
resourceName,
maxQueueSize,
initialThreadCount,
context);
}
// static
template <typename ResourceString, typename Finalizer>
inline ThreadSafeFunction ThreadSafeFunction::New(napi_env env,
const Function& callback,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
Finalizer finalizeCallback) {
return New(env,
callback,
Object(),
resourceName,
maxQueueSize,
initialThreadCount,
finalizeCallback);
}
// static
template <typename ResourceString,
typename Finalizer,
typename FinalizerDataType>
inline ThreadSafeFunction ThreadSafeFunction::New(napi_env env,
const Function& callback,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
Finalizer finalizeCallback,
FinalizerDataType* data) {
return New(env,
callback,
Object(),
resourceName,
maxQueueSize,
initialThreadCount,
finalizeCallback,
data);
}
// static
template <typename ResourceString, typename ContextType, typename Finalizer>
inline ThreadSafeFunction ThreadSafeFunction::New(napi_env env,
const Function& callback,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context,
Finalizer finalizeCallback) {
return New(env,
callback,
Object(),
resourceName,
maxQueueSize,
initialThreadCount,
context,
finalizeCallback);
}
// static
template <typename ResourceString,
typename ContextType,
typename Finalizer,
typename FinalizerDataType>
inline ThreadSafeFunction ThreadSafeFunction::New(napi_env env,
const Function& callback,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context,
Finalizer finalizeCallback,
FinalizerDataType* data) {
return New(env,
callback,
Object(),
resourceName,
maxQueueSize,
initialThreadCount,
context,
finalizeCallback,
data);
}
// static
template <typename ResourceString>
inline ThreadSafeFunction ThreadSafeFunction::New(napi_env env,
const Function& callback,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount) {
return New(env,
callback,
resource,
resourceName,
maxQueueSize,
initialThreadCount,
static_cast<void*>(nullptr) /* context */);
}
// static
template <typename ResourceString, typename ContextType>
inline ThreadSafeFunction ThreadSafeFunction::New(napi_env env,
const Function& callback,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context) {
return New(env,
callback,
resource,
resourceName,
maxQueueSize,
initialThreadCount,
context,
[](Env, ContextType*) {} /* empty finalizer */);
}
// static
template <typename ResourceString, typename Finalizer>
inline ThreadSafeFunction ThreadSafeFunction::New(napi_env env,
const Function& callback,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
Finalizer finalizeCallback) {
return New(env,
callback,
resource,
resourceName,
maxQueueSize,
initialThreadCount,
static_cast<void*>(nullptr) /* context */,
finalizeCallback,
static_cast<void*>(nullptr) /* data */,
details::ThreadSafeFinalize<void, Finalizer>::Wrapper);
}
// static
template <typename ResourceString,
typename Finalizer,
typename FinalizerDataType>
inline ThreadSafeFunction ThreadSafeFunction::New(napi_env env,
const Function& callback,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
Finalizer finalizeCallback,
FinalizerDataType* data) {
return New(env,
callback,
resource,
resourceName,
maxQueueSize,
initialThreadCount,
static_cast<void*>(nullptr) /* context */,
finalizeCallback,
data,
details::ThreadSafeFinalize<void, Finalizer, FinalizerDataType>::
FinalizeWrapperWithData);
}
// static
template <typename ResourceString, typename ContextType, typename Finalizer>
inline ThreadSafeFunction ThreadSafeFunction::New(napi_env env,
const Function& callback,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context,
Finalizer finalizeCallback) {
return New(
env,
callback,
resource,
resourceName,
maxQueueSize,
initialThreadCount,
context,
finalizeCallback,
static_cast<void*>(nullptr) /* data */,
details::ThreadSafeFinalize<ContextType,
Finalizer>::FinalizeWrapperWithContext);
}
// static
template <typename ResourceString,
typename ContextType,
typename Finalizer,
typename FinalizerDataType>
inline ThreadSafeFunction ThreadSafeFunction::New(napi_env env,
const Function& callback,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context,
Finalizer finalizeCallback,
FinalizerDataType* data) {
return New(
env,
callback,
resource,
resourceName,
maxQueueSize,
initialThreadCount,
context,
finalizeCallback,
data,
details::ThreadSafeFinalize<ContextType, Finalizer, FinalizerDataType>::
FinalizeFinalizeWrapperWithDataAndContext);
}
inline ThreadSafeFunction::ThreadSafeFunction() : _tsfn() {}
inline ThreadSafeFunction::ThreadSafeFunction(napi_threadsafe_function tsfn)
: _tsfn(tsfn) {}
inline ThreadSafeFunction::operator napi_threadsafe_function() const {
return _tsfn;
}
inline napi_status ThreadSafeFunction::BlockingCall() const {
return CallInternal(nullptr, napi_tsfn_blocking);
}
template <>
inline napi_status ThreadSafeFunction::BlockingCall(void* data) const {
return napi_call_threadsafe_function(_tsfn, data, napi_tsfn_blocking);
}
template <typename Callback>
inline napi_status ThreadSafeFunction::BlockingCall(Callback callback) const {
return CallInternal(new CallbackWrapper(callback), napi_tsfn_blocking);
}
template <typename DataType, typename Callback>
inline napi_status ThreadSafeFunction::BlockingCall(DataType* data,
Callback callback) const {
auto wrapper = [data, callback](Env env, Function jsCallback) {
callback(env, jsCallback, data);
};
return CallInternal(new CallbackWrapper(wrapper), napi_tsfn_blocking);
}
inline napi_status ThreadSafeFunction::NonBlockingCall() const {
return CallInternal(nullptr, napi_tsfn_nonblocking);
}
template <>
inline napi_status ThreadSafeFunction::NonBlockingCall(void* data) const {
return napi_call_threadsafe_function(_tsfn, data, napi_tsfn_nonblocking);
}
template <typename Callback>
inline napi_status ThreadSafeFunction::NonBlockingCall(
Callback callback) const {
return CallInternal(new CallbackWrapper(callback), napi_tsfn_nonblocking);
}
template <typename DataType, typename Callback>
inline napi_status ThreadSafeFunction::NonBlockingCall(
DataType* data, Callback callback) const {
auto wrapper = [data, callback](Env env, Function jsCallback) {
callback(env, jsCallback, data);
};
return CallInternal(new CallbackWrapper(wrapper), napi_tsfn_nonblocking);
}
inline void ThreadSafeFunction::Ref(napi_env env) const {
if (_tsfn != nullptr) {
napi_status status = napi_ref_threadsafe_function(env, _tsfn);
NAPI_THROW_IF_FAILED_VOID(env, status);
}
}
inline void ThreadSafeFunction::Unref(napi_env env) const {
if (_tsfn != nullptr) {
napi_status status = napi_unref_threadsafe_function(env, _tsfn);
NAPI_THROW_IF_FAILED_VOID(env, status);
}
}
inline napi_status ThreadSafeFunction::Acquire() const {
return napi_acquire_threadsafe_function(_tsfn);
}
inline napi_status ThreadSafeFunction::Release() const {
return napi_release_threadsafe_function(_tsfn, napi_tsfn_release);
}
inline napi_status ThreadSafeFunction::Abort() const {
return napi_release_threadsafe_function(_tsfn, napi_tsfn_abort);
}
inline ThreadSafeFunction::ConvertibleContext ThreadSafeFunction::GetContext()
const {
void* context;
napi_status status = napi_get_threadsafe_function_context(_tsfn, &context);
NAPI_FATAL_IF_FAILED(status,
"ThreadSafeFunction::GetContext",
"napi_get_threadsafe_function_context");
return ConvertibleContext({context});
}
// static
template <typename ResourceString,
typename ContextType,
typename Finalizer,
typename FinalizerDataType>
inline ThreadSafeFunction ThreadSafeFunction::New(napi_env env,
const Function& callback,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context,
Finalizer finalizeCallback,
FinalizerDataType* data,
napi_finalize wrapper) {
static_assert(details::can_make_string<ResourceString>::value ||
std::is_convertible<ResourceString, napi_value>::value,
"Resource name should be convertible to the string type");
ThreadSafeFunction tsfn;
auto* finalizeData = new details::
ThreadSafeFinalize<ContextType, Finalizer, FinalizerDataType>(
{data, finalizeCallback});
napi_status status =
napi_create_threadsafe_function(env,
callback,
resource,
Value::From(env, resourceName),
maxQueueSize,
initialThreadCount,
finalizeData,
wrapper,
context,
CallJS,
&tsfn._tsfn);
if (status != napi_ok) {
delete finalizeData;
NAPI_THROW_IF_FAILED(env, status, ThreadSafeFunction());
}
return tsfn;
}
inline napi_status ThreadSafeFunction::CallInternal(
CallbackWrapper* callbackWrapper,
napi_threadsafe_function_call_mode mode) const {
napi_status status =
napi_call_threadsafe_function(_tsfn, callbackWrapper, mode);
if (status != napi_ok && callbackWrapper != nullptr) {
delete callbackWrapper;
}
return status;
}
// static
inline void ThreadSafeFunction::CallJS(napi_env env,
napi_value jsCallback,
void* /* context */,
void* data) {
if (env == nullptr && jsCallback == nullptr) {
return;
}
details::WrapVoidCallback([&]() {
if (data != nullptr) {
auto* callbackWrapper = static_cast<CallbackWrapper*>(data);
(*callbackWrapper)(env, Function(env, jsCallback));
delete callbackWrapper;
} else if (jsCallback != nullptr) {
Function(env, jsCallback).Call({});
}
});
}
////////////////////////////////////////////////////////////////////////////////
// Async Progress Worker Base class
////////////////////////////////////////////////////////////////////////////////
template <typename DataType>
inline AsyncProgressWorkerBase<DataType>::AsyncProgressWorkerBase(
const Object& receiver,
const Function& callback,
const char* resource_name,
const Object& resource,
size_t queue_size)
: AsyncWorker(receiver, callback, resource_name, resource) {
// Fill all possible arguments to work around ambiguous
// ThreadSafeFunction::New signatures.
_tsfn = ThreadSafeFunction::New(callback.Env(),
callback,
resource,
resource_name,
queue_size,
/** initialThreadCount */ 1,
/** context */ this,
OnThreadSafeFunctionFinalize,
/** finalizeData */ this);
}
#if NAPI_VERSION > 4
template <typename DataType>
inline AsyncProgressWorkerBase<DataType>::AsyncProgressWorkerBase(
Napi::Env env,
const char* resource_name,
const Object& resource,
size_t queue_size)
: AsyncWorker(env, resource_name, resource) {
// TODO: Once the changes to make the callback optional for threadsafe
// functions are available on all versions we can remove the dummy Function
// here.
Function callback;
// Fill all possible arguments to work around ambiguous
// ThreadSafeFunction::New signatures.
_tsfn = ThreadSafeFunction::New(env,
callback,
resource,
resource_name,
queue_size,
/** initialThreadCount */ 1,
/** context */ this,
OnThreadSafeFunctionFinalize,
/** finalizeData */ this);
}
#endif
template <typename DataType>
inline AsyncProgressWorkerBase<DataType>::~AsyncProgressWorkerBase() {
// Abort pending tsfn call.
// Don't send progress events after we've already completed.
// It's ok to call ThreadSafeFunction::Abort and ThreadSafeFunction::Release
// duplicated.
_tsfn.Abort();
}
template <typename DataType>
inline void AsyncProgressWorkerBase<DataType>::OnAsyncWorkProgress(
Napi::Env /* env */, Napi::Function /* jsCallback */, void* data) {
ThreadSafeData* tsd = static_cast<ThreadSafeData*>(data);
tsd->asyncprogressworker()->OnWorkProgress(tsd->data());
delete tsd;
}
template <typename DataType>
inline napi_status AsyncProgressWorkerBase<DataType>::NonBlockingCall(
DataType* data) {
auto tsd = new AsyncProgressWorkerBase::ThreadSafeData(this, data);
auto ret = _tsfn.NonBlockingCall(tsd, OnAsyncWorkProgress);
if (ret != napi_ok) {
delete tsd;
}
return ret;
}
template <typename DataType>
inline void AsyncProgressWorkerBase<DataType>::OnWorkComplete(
Napi::Env /* env */, napi_status status) {
_work_completed = true;
_complete_status = status;
_tsfn.Release();
}
template <typename DataType>
inline void AsyncProgressWorkerBase<DataType>::OnThreadSafeFunctionFinalize(
Napi::Env env, void* /* data */, AsyncProgressWorkerBase* context) {
if (context->_work_completed) {
context->AsyncWorker::OnWorkComplete(env, context->_complete_status);
}
}
////////////////////////////////////////////////////////////////////////////////
// Async Progress Worker class
////////////////////////////////////////////////////////////////////////////////
template <class T>
inline AsyncProgressWorker<T>::AsyncProgressWorker(const Function& callback)
: AsyncProgressWorker(callback, "generic") {}
template <class T>
inline AsyncProgressWorker<T>::AsyncProgressWorker(const Function& callback,
const char* resource_name)
: AsyncProgressWorker(
callback, resource_name, Object::New(callback.Env())) {}
template <class T>
inline AsyncProgressWorker<T>::AsyncProgressWorker(const Function& callback,
const char* resource_name,
const Object& resource)
: AsyncProgressWorker(
Object::New(callback.Env()), callback, resource_name, resource) {}
template <class T>
inline AsyncProgressWorker<T>::AsyncProgressWorker(const Object& receiver,
const Function& callback)
: AsyncProgressWorker(receiver, callback, "generic") {}
template <class T>
inline AsyncProgressWorker<T>::AsyncProgressWorker(const Object& receiver,
const Function& callback,
const char* resource_name)
: AsyncProgressWorker(
receiver, callback, resource_name, Object::New(callback.Env())) {}
template <class T>
inline AsyncProgressWorker<T>::AsyncProgressWorker(const Object& receiver,
const Function& callback,
const char* resource_name,
const Object& resource)
: AsyncProgressWorkerBase(receiver, callback, resource_name, resource),
_asyncdata(nullptr),
_asyncsize(0),
_signaled(false) {}
#if NAPI_VERSION > 4
template <class T>
inline AsyncProgressWorker<T>::AsyncProgressWorker(Napi::Env env)
: AsyncProgressWorker(env, "generic") {}
template <class T>
inline AsyncProgressWorker<T>::AsyncProgressWorker(Napi::Env env,
const char* resource_name)
: AsyncProgressWorker(env, resource_name, Object::New(env)) {}
template <class T>
inline AsyncProgressWorker<T>::AsyncProgressWorker(Napi::Env env,
const char* resource_name,
const Object& resource)
: AsyncProgressWorkerBase(env, resource_name, resource),
_asyncdata(nullptr),
_asyncsize(0) {}
#endif
template <class T>
inline AsyncProgressWorker<T>::~AsyncProgressWorker() {
{
std::lock_guard<std::mutex> lock(this->_mutex);
_asyncdata = nullptr;
_asyncsize = 0;
}
}
template <class T>
inline void AsyncProgressWorker<T>::Execute() {
ExecutionProgress progress(this);
Execute(progress);
}
template <class T>
inline void AsyncProgressWorker<T>::OnWorkProgress(void*) {
T* data;
size_t size;
bool signaled;
{
std::lock_guard<std::mutex> lock(this->_mutex);
data = this->_asyncdata;
size = this->_asyncsize;
signaled = this->_signaled;
this->_asyncdata = nullptr;
this->_asyncsize = 0;
this->_signaled = false;
}
/**
* The callback of ThreadSafeFunction is not been invoked immediately on the
* callback of uv_async_t (uv io poll), rather the callback of TSFN is
* invoked on the right next uv idle callback. There are chances that during
* the deferring the signal of uv_async_t is been sent again, i.e. potential
* not coalesced two calls of the TSFN callback.
*/
if (data == nullptr && !signaled) {
return;
}
this->OnProgress(data, size);
delete[] data;
}
template <class T>
inline void AsyncProgressWorker<T>::SendProgress_(const T* data, size_t count) {
T* new_data = new T[count];
std::copy(data, data + count, new_data);
T* old_data;
{
std::lock_guard<std::mutex> lock(this->_mutex);
old_data = _asyncdata;
_asyncdata = new_data;
_asyncsize = count;
_signaled = false;
}
this->NonBlockingCall(nullptr);
delete[] old_data;
}
template <class T>
inline void AsyncProgressWorker<T>::Signal() {
{
std::lock_guard<std::mutex> lock(this->_mutex);
_signaled = true;
}
this->NonBlockingCall(static_cast<T*>(nullptr));
}
template <class T>
inline void AsyncProgressWorker<T>::ExecutionProgress::Signal() const {
this->_worker->Signal();
}
template <class T>
inline void AsyncProgressWorker<T>::ExecutionProgress::Send(
const T* data, size_t count) const {
_worker->SendProgress_(data, count);
}
////////////////////////////////////////////////////////////////////////////////
// Async Progress Queue Worker class
////////////////////////////////////////////////////////////////////////////////
template <class T>
inline AsyncProgressQueueWorker<T>::AsyncProgressQueueWorker(
const Function& callback)
: AsyncProgressQueueWorker(callback, "generic") {}
template <class T>
inline AsyncProgressQueueWorker<T>::AsyncProgressQueueWorker(
const Function& callback, const char* resource_name)
: AsyncProgressQueueWorker(
callback, resource_name, Object::New(callback.Env())) {}
template <class T>
inline AsyncProgressQueueWorker<T>::AsyncProgressQueueWorker(
const Function& callback, const char* resource_name, const Object& resource)
: AsyncProgressQueueWorker(
Object::New(callback.Env()), callback, resource_name, resource) {}
template <class T>
inline AsyncProgressQueueWorker<T>::AsyncProgressQueueWorker(
const Object& receiver, const Function& callback)
: AsyncProgressQueueWorker(receiver, callback, "generic") {}
template <class T>
inline AsyncProgressQueueWorker<T>::AsyncProgressQueueWorker(
const Object& receiver, const Function& callback, const char* resource_name)
: AsyncProgressQueueWorker(
receiver, callback, resource_name, Object::New(callback.Env())) {}
template <class T>
inline AsyncProgressQueueWorker<T>::AsyncProgressQueueWorker(
const Object& receiver,
const Function& callback,
const char* resource_name,
const Object& resource)
: AsyncProgressWorkerBase<std::pair<T*, size_t>>(
receiver,
callback,
resource_name,
resource,
/** unlimited queue size */ 0) {}
#if NAPI_VERSION > 4
template <class T>
inline AsyncProgressQueueWorker<T>::AsyncProgressQueueWorker(Napi::Env env)
: AsyncProgressQueueWorker(env, "generic") {}
template <class T>
inline AsyncProgressQueueWorker<T>::AsyncProgressQueueWorker(
Napi::Env env, const char* resource_name)
: AsyncProgressQueueWorker(env, resource_name, Object::New(env)) {}
template <class T>
inline AsyncProgressQueueWorker<T>::AsyncProgressQueueWorker(
Napi::Env env, const char* resource_name, const Object& resource)
: AsyncProgressWorkerBase<std::pair<T*, size_t>>(
env, resource_name, resource, /** unlimited queue size */ 0) {}
#endif
template <class T>
inline void AsyncProgressQueueWorker<T>::Execute() {
ExecutionProgress progress(this);
Execute(progress);
}
template <class T>
inline void AsyncProgressQueueWorker<T>::OnWorkProgress(
std::pair<T*, size_t>* datapair) {
if (datapair == nullptr) {
return;
}
T* data = datapair->first;
size_t size = datapair->second;
this->OnProgress(data, size);
delete datapair;
delete[] data;
}
template <class T>
inline void AsyncProgressQueueWorker<T>::SendProgress_(const T* data,
size_t count) {
T* new_data = new T[count];
std::copy(data, data + count, new_data);
auto pair = new std::pair<T*, size_t>(new_data, count);
this->NonBlockingCall(pair);
}
template <class T>
inline void AsyncProgressQueueWorker<T>::Signal() const {
this->SendProgress_(static_cast<T*>(nullptr), 0);
}
template <class T>
inline void AsyncProgressQueueWorker<T>::OnWorkComplete(Napi::Env env,
napi_status status) {
// Draining queued items in TSFN.
AsyncProgressWorkerBase<std::pair<T*, size_t>>::OnWorkComplete(env, status);
}
template <class T>
inline void AsyncProgressQueueWorker<T>::ExecutionProgress::Signal() const {
_worker->SendProgress_(static_cast<T*>(nullptr), 0);
}
template <class T>
inline void AsyncProgressQueueWorker<T>::ExecutionProgress::Send(
const T* data, size_t count) const {
_worker->SendProgress_(data, count);
}
#endif // NAPI_VERSION > 3 && NAPI_HAS_THREADS
////////////////////////////////////////////////////////////////////////////////
// Memory Management class
////////////////////////////////////////////////////////////////////////////////
inline int64_t MemoryManagement::AdjustExternalMemory(Env env,
int64_t change_in_bytes) {
int64_t result;
napi_status status =
napi_adjust_external_memory(env, change_in_bytes, &result);
NAPI_THROW_IF_FAILED(env, status, 0);
return result;
}
////////////////////////////////////////////////////////////////////////////////
// Version Management class
////////////////////////////////////////////////////////////////////////////////
inline uint32_t VersionManagement::GetNapiVersion(Env env) {
uint32_t result;
napi_status status = napi_get_version(env, &result);
NAPI_THROW_IF_FAILED(env, status, 0);
return result;
}
inline const napi_node_version* VersionManagement::GetNodeVersion(Env env) {
const napi_node_version* result;
napi_status status = napi_get_node_version(env, &result);
NAPI_THROW_IF_FAILED(env, status, 0);
return result;
}
#if NAPI_VERSION > 5
////////////////////////////////////////////////////////////////////////////////
// Addon<T> class
////////////////////////////////////////////////////////////////////////////////
template <typename T>
inline Object Addon<T>::Init(Env env, Object exports) {
T* addon = new T(env, exports);
env.SetInstanceData(addon);
return addon->entry_point_;
}
template <typename T>
inline T* Addon<T>::Unwrap(Object wrapper) {
return wrapper.Env().GetInstanceData<T>();
}
template <typename T>
inline void Addon<T>::DefineAddon(
Object exports, const std::initializer_list<AddonProp>& props) {
DefineProperties(exports, props);
entry_point_ = exports;
}
template <typename T>
inline Napi::Object Addon<T>::DefineProperties(
Object object, const std::initializer_list<AddonProp>& props) {
const napi_property_descriptor* properties =
reinterpret_cast<const napi_property_descriptor*>(props.begin());
size_t size = props.size();
napi_status status =
napi_define_properties(object.Env(), object, size, properties);
NAPI_THROW_IF_FAILED(object.Env(), status, object);
for (size_t idx = 0; idx < size; idx++)
T::AttachPropData(object.Env(), object, &properties[idx]);
return object;
}
#endif // NAPI_VERSION > 5
#if NAPI_VERSION > 2
template <typename Hook, typename Arg>
Env::CleanupHook<Hook, Arg> Env::AddCleanupHook(Hook hook, Arg* arg) {
return CleanupHook<Hook, Arg>(*this, hook, arg);
}
template <typename Hook>
Env::CleanupHook<Hook> Env::AddCleanupHook(Hook hook) {
return CleanupHook<Hook>(*this, hook);
}
template <typename Hook, typename Arg>
Env::CleanupHook<Hook, Arg>::CleanupHook() {
data = nullptr;
}
template <typename Hook, typename Arg>
Env::CleanupHook<Hook, Arg>::CleanupHook(Napi::Env env, Hook hook)
: wrapper(Env::CleanupHook<Hook, Arg>::Wrapper) {
data = new CleanupData{std::move(hook), nullptr};
napi_status status = napi_add_env_cleanup_hook(env, wrapper, data);
if (status != napi_ok) {
delete data;
data = nullptr;
}
}
template <typename Hook, typename Arg>
Env::CleanupHook<Hook, Arg>::CleanupHook(Napi::Env env, Hook hook, Arg* arg)
: wrapper(Env::CleanupHook<Hook, Arg>::WrapperWithArg) {
data = new CleanupData{std::move(hook), arg};
napi_status status = napi_add_env_cleanup_hook(env, wrapper, data);
if (status != napi_ok) {
delete data;
data = nullptr;
}
}
template <class Hook, class Arg>
bool Env::CleanupHook<Hook, Arg>::Remove(Env env) {
napi_status status = napi_remove_env_cleanup_hook(env, wrapper, data);
delete data;
data = nullptr;
return status == napi_ok;
}
template <class Hook, class Arg>
bool Env::CleanupHook<Hook, Arg>::IsEmpty() const {
return data == nullptr;
}
#endif // NAPI_VERSION > 2
#ifdef NAPI_CPP_CUSTOM_NAMESPACE
} // namespace NAPI_CPP_CUSTOM_NAMESPACE
#endif
} // namespace Napi
#endif // SRC_NAPI_INL_H_
+3201
View File
@@ -0,0 +1,3201 @@
#ifndef SRC_NAPI_H_
#define SRC_NAPI_H_
#ifndef NAPI_HAS_THREADS
#if !defined(__wasm__) || (defined(__EMSCRIPTEN_PTHREADS__) || \
(defined(__wasi__) && defined(_REENTRANT)))
#define NAPI_HAS_THREADS 1
#else
#define NAPI_HAS_THREADS 0
#endif
#endif
#include <node_api.h>
#include <functional>
#include <initializer_list>
#include <memory>
#if NAPI_HAS_THREADS
#include <mutex>
#endif // NAPI_HAS_THREADS
#include <string>
#include <vector>
// VS2015 RTM has bugs with constexpr, so require min of VS2015 Update 3 (known
// good version)
#if !defined(_MSC_VER) || _MSC_FULL_VER >= 190024210
#define NAPI_HAS_CONSTEXPR 1
#endif
// VS2013 does not support char16_t literal strings, so we'll work around it
// using wchar_t strings and casting them. This is safe as long as the character
// sizes are the same.
#if defined(_MSC_VER) && _MSC_VER <= 1800
static_assert(sizeof(char16_t) == sizeof(wchar_t),
"Size mismatch between char16_t and wchar_t");
#define NAPI_WIDE_TEXT(x) reinterpret_cast<char16_t*>(L##x)
#else
#define NAPI_WIDE_TEXT(x) u##x
#endif
// If C++ exceptions are not explicitly enabled or disabled, enable them
// if exceptions were enabled in the compiler settings.
#if !defined(NAPI_CPP_EXCEPTIONS) && !defined(NAPI_DISABLE_CPP_EXCEPTIONS)
#if defined(_CPPUNWIND) || defined(__EXCEPTIONS)
#define NAPI_CPP_EXCEPTIONS
#else
#error Exception support not detected. \
Define either NAPI_CPP_EXCEPTIONS or NAPI_DISABLE_CPP_EXCEPTIONS.
#endif
#endif
// If C++ NAPI_CPP_EXCEPTIONS are enabled, NODE_ADDON_API_ENABLE_MAYBE should
// not be set
#if defined(NAPI_CPP_EXCEPTIONS) && defined(NODE_ADDON_API_ENABLE_MAYBE)
#error NODE_ADDON_API_ENABLE_MAYBE should not be set when \
NAPI_CPP_EXCEPTIONS is defined.
#endif
#ifdef _NOEXCEPT
#define NAPI_NOEXCEPT _NOEXCEPT
#else
#define NAPI_NOEXCEPT noexcept
#endif
#ifdef NAPI_CPP_EXCEPTIONS
// When C++ exceptions are enabled, Errors are thrown directly. There is no need
// to return anything after the throw statements. The variadic parameter is an
// optional return value that is ignored.
// We need _VOID versions of the macros to avoid warnings resulting from
// leaving the NAPI_THROW_* `...` argument empty.
#define NAPI_THROW(e, ...) throw e
#define NAPI_THROW_VOID(e) throw e
#define NAPI_THROW_IF_FAILED(env, status, ...) \
if ((status) != napi_ok) throw Napi::Error::New(env);
#define NAPI_THROW_IF_FAILED_VOID(env, status) \
if ((status) != napi_ok) throw Napi::Error::New(env);
#else // NAPI_CPP_EXCEPTIONS
// When C++ exceptions are disabled, Errors are thrown as JavaScript exceptions,
// which are pending until the callback returns to JS. The variadic parameter
// is an optional return value; usually it is an empty result.
// We need _VOID versions of the macros to avoid warnings resulting from
// leaving the NAPI_THROW_* `...` argument empty.
#define NAPI_THROW(e, ...) \
do { \
(e).ThrowAsJavaScriptException(); \
return __VA_ARGS__; \
} while (0)
#define NAPI_THROW_VOID(e) \
do { \
(e).ThrowAsJavaScriptException(); \
return; \
} while (0)
#define NAPI_THROW_IF_FAILED(env, status, ...) \
if ((status) != napi_ok) { \
Napi::Error::New(env).ThrowAsJavaScriptException(); \
return __VA_ARGS__; \
}
#define NAPI_THROW_IF_FAILED_VOID(env, status) \
if ((status) != napi_ok) { \
Napi::Error::New(env).ThrowAsJavaScriptException(); \
return; \
}
#endif // NAPI_CPP_EXCEPTIONS
#ifdef NODE_ADDON_API_ENABLE_MAYBE
#define NAPI_MAYBE_THROW_IF_FAILED(env, status, type) \
NAPI_THROW_IF_FAILED(env, status, Napi::Nothing<type>())
#define NAPI_RETURN_OR_THROW_IF_FAILED(env, status, result, type) \
NAPI_MAYBE_THROW_IF_FAILED(env, status, type); \
return Napi::Just<type>(result);
#else
#define NAPI_MAYBE_THROW_IF_FAILED(env, status, type) \
NAPI_THROW_IF_FAILED(env, status, type())
#define NAPI_RETURN_OR_THROW_IF_FAILED(env, status, result, type) \
NAPI_MAYBE_THROW_IF_FAILED(env, status, type); \
return result;
#endif
#define NAPI_DISALLOW_ASSIGN(CLASS) void operator=(const CLASS&) = delete;
#define NAPI_DISALLOW_COPY(CLASS) CLASS(const CLASS&) = delete;
#define NAPI_DISALLOW_ASSIGN_COPY(CLASS) \
NAPI_DISALLOW_ASSIGN(CLASS) \
NAPI_DISALLOW_COPY(CLASS)
#define NAPI_CHECK(condition, location, message) \
do { \
if (!(condition)) { \
Napi::Error::Fatal((location), (message)); \
} \
} while (0)
#define NAPI_FATAL_IF_FAILED(status, location, message) \
NAPI_CHECK((status) == napi_ok, location, message)
////////////////////////////////////////////////////////////////////////////////
/// Node-API C++ Wrapper Classes
///
/// These classes wrap the "Node-API" ABI-stable C APIs for Node.js, providing a
/// C++ object model and C++ exception-handling semantics with low overhead.
/// The wrappers are all header-only so that they do not affect the ABI.
////////////////////////////////////////////////////////////////////////////////
namespace Napi {
#ifdef NAPI_CPP_CUSTOM_NAMESPACE
// NAPI_CPP_CUSTOM_NAMESPACE can be #define'd per-addon to avoid symbol
// conflicts between different instances of node-addon-api
// First dummy definition of the namespace to make sure that Napi::(name) still
// refers to the right things inside this file.
namespace NAPI_CPP_CUSTOM_NAMESPACE {}
using namespace NAPI_CPP_CUSTOM_NAMESPACE;
namespace NAPI_CPP_CUSTOM_NAMESPACE {
#endif
// Forward declarations
class Env;
class Value;
class Boolean;
class Number;
#if NAPI_VERSION > 5
class BigInt;
#endif // NAPI_VERSION > 5
#if (NAPI_VERSION > 4)
class Date;
#endif
class String;
class Object;
class Array;
class ArrayBuffer;
class Function;
class Error;
class PropertyDescriptor;
class CallbackInfo;
class TypedArray;
template <typename T>
class TypedArrayOf;
using Int8Array =
TypedArrayOf<int8_t>; ///< Typed-array of signed 8-bit integers
using Uint8Array =
TypedArrayOf<uint8_t>; ///< Typed-array of unsigned 8-bit integers
using Int16Array =
TypedArrayOf<int16_t>; ///< Typed-array of signed 16-bit integers
using Uint16Array =
TypedArrayOf<uint16_t>; ///< Typed-array of unsigned 16-bit integers
using Int32Array =
TypedArrayOf<int32_t>; ///< Typed-array of signed 32-bit integers
using Uint32Array =
TypedArrayOf<uint32_t>; ///< Typed-array of unsigned 32-bit integers
using Float32Array =
TypedArrayOf<float>; ///< Typed-array of 32-bit floating-point values
using Float64Array =
TypedArrayOf<double>; ///< Typed-array of 64-bit floating-point values
#if NAPI_VERSION > 5
using BigInt64Array =
TypedArrayOf<int64_t>; ///< Typed array of signed 64-bit integers
using BigUint64Array =
TypedArrayOf<uint64_t>; ///< Typed array of unsigned 64-bit integers
#endif // NAPI_VERSION > 5
/// Defines the signature of a Node-API C++ module's registration callback
/// (init) function.
using ModuleRegisterCallback = Object (*)(Env env, Object exports);
class MemoryManagement;
/// A simple Maybe type, representing an object which may or may not have a
/// value.
///
/// If an API method returns a Maybe<>, the API method can potentially fail
/// either because an exception is thrown, or because an exception is pending,
/// e.g. because a previous API call threw an exception that hasn't been
/// caught yet. In that case, a "Nothing" value is returned.
template <class T>
class Maybe {
public:
bool IsNothing() const;
bool IsJust() const;
/// Short-hand for Unwrap(), which doesn't return a value. Could be used
/// where the actual value of the Maybe is not needed like Object::Set.
/// If this Maybe is nothing (empty), node-addon-api will crash the
/// process.
void Check() const;
/// Return the value of type T contained in the Maybe. If this Maybe is
/// nothing (empty), node-addon-api will crash the process.
T Unwrap() const;
/// Return the value of type T contained in the Maybe, or using a default
/// value if this Maybe is nothing (empty).
T UnwrapOr(const T& default_value) const;
/// Converts this Maybe to a value of type T in the out. If this Maybe is
/// nothing (empty), `false` is returned and `out` is left untouched.
bool UnwrapTo(T* out) const;
bool operator==(const Maybe& other) const;
bool operator!=(const Maybe& other) const;
private:
Maybe();
explicit Maybe(const T& t);
bool _has_value;
T _value;
template <class U>
friend Maybe<U> Nothing();
template <class U>
friend Maybe<U> Just(const U& u);
};
template <class T>
inline Maybe<T> Nothing();
template <class T>
inline Maybe<T> Just(const T& t);
#if defined(NODE_ADDON_API_ENABLE_MAYBE)
template <typename T>
using MaybeOrValue = Maybe<T>;
#else
template <typename T>
using MaybeOrValue = T;
#endif
/// Environment for Node-API values and operations.
///
/// All Node-API values and operations must be associated with an environment.
/// An environment instance is always provided to callback functions; that
/// environment must then be used for any creation of Node-API values or other
/// Node-API operations within the callback. (Many methods infer the
/// environment from the `this` instance that the method is called on.)
///
/// In the future, multiple environments per process may be supported,
/// although current implementations only support one environment per process.
///
/// In the V8 JavaScript engine, a Node-API environment approximately
/// corresponds to an Isolate.
class Env {
private:
napi_env _env;
#if NAPI_VERSION > 5
template <typename T>
static void DefaultFini(Env, T* data);
template <typename DataType, typename HintType>
static void DefaultFiniWithHint(Env, DataType* data, HintType* hint);
#endif // NAPI_VERSION > 5
public:
Env(napi_env env);
operator napi_env() const;
Object Global() const;
Value Undefined() const;
Value Null() const;
bool IsExceptionPending() const;
Error GetAndClearPendingException() const;
MaybeOrValue<Value> RunScript(const char* utf8script) const;
MaybeOrValue<Value> RunScript(const std::string& utf8script) const;
MaybeOrValue<Value> RunScript(String script) const;
#if NAPI_VERSION > 2
template <typename Hook, typename Arg = void>
class CleanupHook;
template <typename Hook>
CleanupHook<Hook> AddCleanupHook(Hook hook);
template <typename Hook, typename Arg>
CleanupHook<Hook, Arg> AddCleanupHook(Hook hook, Arg* arg);
#endif // NAPI_VERSION > 2
#if NAPI_VERSION > 5
template <typename T>
T* GetInstanceData() const;
template <typename T>
using Finalizer = void (*)(Env, T*);
template <typename T, Finalizer<T> fini = Env::DefaultFini<T>>
void SetInstanceData(T* data) const;
template <typename DataType, typename HintType>
using FinalizerWithHint = void (*)(Env, DataType*, HintType*);
template <typename DataType,
typename HintType,
FinalizerWithHint<DataType, HintType> fini =
Env::DefaultFiniWithHint<DataType, HintType>>
void SetInstanceData(DataType* data, HintType* hint) const;
#endif // NAPI_VERSION > 5
#if NAPI_VERSION > 2
template <typename Hook, typename Arg>
class CleanupHook {
public:
CleanupHook();
CleanupHook(Env env, Hook hook, Arg* arg);
CleanupHook(Env env, Hook hook);
bool Remove(Env env);
bool IsEmpty() const;
private:
static inline void Wrapper(void* data) NAPI_NOEXCEPT;
static inline void WrapperWithArg(void* data) NAPI_NOEXCEPT;
void (*wrapper)(void* arg);
struct CleanupData {
Hook hook;
Arg* arg;
} * data;
};
#endif // NAPI_VERSION > 2
#if NAPI_VERSION > 8
const char* GetModuleFileName() const;
#endif // NAPI_VERSION > 8
};
/// A JavaScript value of unknown type.
///
/// For type-specific operations, convert to one of the Value subclasses using a
/// `To*` or `As()` method. The `To*` methods do type coercion; the `As()`
/// method does not.
///
/// Napi::Value value = ...
/// if (!value.IsString()) throw Napi::TypeError::New(env, "Invalid
/// arg..."); Napi::String str = value.As<Napi::String>(); // Cast to a
/// string value
///
/// Napi::Value anotherValue = ...
/// bool isTruthy = anotherValue.ToBoolean(); // Coerce to a boolean value
class Value {
public:
Value(); ///< Creates a new _empty_ Value instance.
Value(napi_env env,
napi_value value); ///< Wraps a Node-API value primitive.
/// Creates a JS value from a C++ primitive.
///
/// `value` may be any of:
/// - bool
/// - Any integer type
/// - Any floating point type
/// - const char* (encoded using UTF-8, null-terminated)
/// - const char16_t* (encoded using UTF-16-LE, null-terminated)
/// - std::string (encoded using UTF-8)
/// - std::u16string
/// - napi::Value
/// - napi_value
template <typename T>
static Value From(napi_env env, const T& value);
/// Converts to a Node-API value primitive.
///
/// If the instance is _empty_, this returns `nullptr`.
operator napi_value() const;
/// Tests if this value strictly equals another value.
bool operator==(const Value& other) const;
/// Tests if this value does not strictly equal another value.
bool operator!=(const Value& other) const;
/// Tests if this value strictly equals another value.
bool StrictEquals(const Value& other) const;
/// Gets the environment the value is associated with.
Napi::Env Env() const;
/// Checks if the value is empty (uninitialized).
///
/// An empty value is invalid, and most attempts to perform an operation on an
/// empty value will result in an exception. Note an empty value is distinct
/// from JavaScript `null` or `undefined`, which are valid values.
///
/// When C++ exceptions are disabled at compile time, a method with a `Value`
/// return type may return an empty value to indicate a pending exception. So
/// when not using C++ exceptions, callers should check whether the value is
/// empty before attempting to use it.
bool IsEmpty() const;
napi_valuetype Type() const; ///< Gets the type of the value.
bool IsUndefined()
const; ///< Tests if a value is an undefined JavaScript value.
bool IsNull() const; ///< Tests if a value is a null JavaScript value.
bool IsBoolean() const; ///< Tests if a value is a JavaScript boolean.
bool IsNumber() const; ///< Tests if a value is a JavaScript number.
#if NAPI_VERSION > 5
bool IsBigInt() const; ///< Tests if a value is a JavaScript bigint.
#endif // NAPI_VERSION > 5
#if (NAPI_VERSION > 4)
bool IsDate() const; ///< Tests if a value is a JavaScript date.
#endif
bool IsString() const; ///< Tests if a value is a JavaScript string.
bool IsSymbol() const; ///< Tests if a value is a JavaScript symbol.
bool IsArray() const; ///< Tests if a value is a JavaScript array.
bool IsArrayBuffer()
const; ///< Tests if a value is a JavaScript array buffer.
bool IsTypedArray() const; ///< Tests if a value is a JavaScript typed array.
bool IsObject() const; ///< Tests if a value is a JavaScript object.
bool IsFunction() const; ///< Tests if a value is a JavaScript function.
bool IsPromise() const; ///< Tests if a value is a JavaScript promise.
bool IsDataView() const; ///< Tests if a value is a JavaScript data view.
bool IsBuffer() const; ///< Tests if a value is a Node buffer.
bool IsExternal() const; ///< Tests if a value is a pointer to external data.
/// Casts to another type of `Napi::Value`, when the actual type is known or
/// assumed.
///
/// This conversion does NOT coerce the type. Calling any methods
/// inappropriate for the actual value type will throw `Napi::Error`.
///
/// If `NODE_ADDON_API_ENABLE_TYPE_CHECK_ON_AS` is defined, this method
/// asserts that the actual type is the expected type.
template <typename T>
T As() const;
MaybeOrValue<Boolean> ToBoolean()
const; ///< Coerces a value to a JavaScript boolean.
MaybeOrValue<Number> ToNumber()
const; ///< Coerces a value to a JavaScript number.
MaybeOrValue<String> ToString()
const; ///< Coerces a value to a JavaScript string.
MaybeOrValue<Object> ToObject()
const; ///< Coerces a value to a JavaScript object.
protected:
/// !cond INTERNAL
napi_env _env;
napi_value _value;
/// !endcond
};
/// A JavaScript boolean value.
class Boolean : public Value {
public:
static Boolean New(napi_env env, ///< Node-API environment
bool value ///< Boolean value
);
static void CheckCast(napi_env env, napi_value value);
Boolean(); ///< Creates a new _empty_ Boolean instance.
Boolean(napi_env env,
napi_value value); ///< Wraps a Node-API value primitive.
operator bool() const; ///< Converts a Boolean value to a boolean primitive.
bool Value() const; ///< Converts a Boolean value to a boolean primitive.
};
/// A JavaScript number value.
class Number : public Value {
public:
static Number New(napi_env env, ///< Node-API environment
double value ///< Number value
);
static void CheckCast(napi_env env, napi_value value);
Number(); ///< Creates a new _empty_ Number instance.
Number(napi_env env,
napi_value value); ///< Wraps a Node-API value primitive.
operator int32_t()
const; ///< Converts a Number value to a 32-bit signed integer value.
operator uint32_t()
const; ///< Converts a Number value to a 32-bit unsigned integer value.
operator int64_t()
const; ///< Converts a Number value to a 64-bit signed integer value.
operator float()
const; ///< Converts a Number value to a 32-bit floating-point value.
operator double()
const; ///< Converts a Number value to a 64-bit floating-point value.
int32_t Int32Value()
const; ///< Converts a Number value to a 32-bit signed integer value.
uint32_t Uint32Value()
const; ///< Converts a Number value to a 32-bit unsigned integer value.
int64_t Int64Value()
const; ///< Converts a Number value to a 64-bit signed integer value.
float FloatValue()
const; ///< Converts a Number value to a 32-bit floating-point value.
double DoubleValue()
const; ///< Converts a Number value to a 64-bit floating-point value.
};
#if NAPI_VERSION > 5
/// A JavaScript bigint value.
class BigInt : public Value {
public:
static BigInt New(napi_env env, ///< Node-API environment
int64_t value ///< Number value
);
static BigInt New(napi_env env, ///< Node-API environment
uint64_t value ///< Number value
);
/// Creates a new BigInt object using a specified sign bit and a
/// specified list of digits/words.
/// The resulting number is calculated as:
/// (-1)^sign_bit * (words[0] * (2^64)^0 + words[1] * (2^64)^1 + ...)
static BigInt New(napi_env env, ///< Node-API environment
int sign_bit, ///< Sign bit. 1 if negative.
size_t word_count, ///< Number of words in array
const uint64_t* words ///< Array of words
);
static void CheckCast(napi_env env, napi_value value);
BigInt(); ///< Creates a new _empty_ BigInt instance.
BigInt(napi_env env,
napi_value value); ///< Wraps a Node-API value primitive.
int64_t Int64Value(bool* lossless)
const; ///< Converts a BigInt value to a 64-bit signed integer value.
uint64_t Uint64Value(bool* lossless)
const; ///< Converts a BigInt value to a 64-bit unsigned integer value.
size_t WordCount() const; ///< The number of 64-bit words needed to store
///< the result of ToWords().
/// Writes the contents of this BigInt to a specified memory location.
/// `sign_bit` must be provided and will be set to 1 if this BigInt is
/// negative.
/// `*word_count` has to be initialized to the length of the `words` array.
/// Upon return, it will be set to the actual number of words that would
/// be needed to store this BigInt (i.e. the return value of `WordCount()`).
void ToWords(int* sign_bit, size_t* word_count, uint64_t* words);
};
#endif // NAPI_VERSION > 5
#if (NAPI_VERSION > 4)
/// A JavaScript date value.
class Date : public Value {
public:
/// Creates a new Date value from a double primitive.
static Date New(napi_env env, ///< Node-API environment
double value ///< Number value
);
static void CheckCast(napi_env env, napi_value value);
Date(); ///< Creates a new _empty_ Date instance.
Date(napi_env env, napi_value value); ///< Wraps a Node-API value primitive.
operator double() const; ///< Converts a Date value to double primitive
double ValueOf() const; ///< Converts a Date value to a double primitive.
};
#endif
/// A JavaScript string or symbol value (that can be used as a property name).
class Name : public Value {
public:
static void CheckCast(napi_env env, napi_value value);
Name(); ///< Creates a new _empty_ Name instance.
Name(napi_env env,
napi_value value); ///< Wraps a Node-API value primitive.
};
/// A JavaScript string value.
class String : public Name {
public:
/// Creates a new String value from a UTF-8 encoded C++ string.
static String New(napi_env env, ///< Node-API environment
const std::string& value ///< UTF-8 encoded C++ string
);
/// Creates a new String value from a UTF-16 encoded C++ string.
static String New(napi_env env, ///< Node-API environment
const std::u16string& value ///< UTF-16 encoded C++ string
);
/// Creates a new String value from a UTF-8 encoded C string.
static String New(
napi_env env, ///< Node-API environment
const char* value ///< UTF-8 encoded null-terminated C string
);
/// Creates a new String value from a UTF-16 encoded C string.
static String New(
napi_env env, ///< Node-API environment
const char16_t* value ///< UTF-16 encoded null-terminated C string
);
/// Creates a new String value from a UTF-8 encoded C string with specified
/// length.
static String New(napi_env env, ///< Node-API environment
const char* value, ///< UTF-8 encoded C string (not
///< necessarily null-terminated)
size_t length ///< length of the string in bytes
);
/// Creates a new String value from a UTF-16 encoded C string with specified
/// length.
static String New(
napi_env env, ///< Node-API environment
const char16_t* value, ///< UTF-16 encoded C string (not necessarily
///< null-terminated)
size_t length ///< Length of the string in 2-byte code units
);
/// Creates a new String based on the original object's type.
///
/// `value` may be any of:
/// - const char* (encoded using UTF-8, null-terminated)
/// - const char16_t* (encoded using UTF-16-LE, null-terminated)
/// - std::string (encoded using UTF-8)
/// - std::u16string
template <typename T>
static String From(napi_env env, const T& value);
static void CheckCast(napi_env env, napi_value value);
String(); ///< Creates a new _empty_ String instance.
String(napi_env env,
napi_value value); ///< Wraps a Node-API value primitive.
operator std::string()
const; ///< Converts a String value to a UTF-8 encoded C++ string.
operator std::u16string()
const; ///< Converts a String value to a UTF-16 encoded C++ string.
std::string Utf8Value()
const; ///< Converts a String value to a UTF-8 encoded C++ string.
std::u16string Utf16Value()
const; ///< Converts a String value to a UTF-16 encoded C++ string.
};
/// A JavaScript symbol value.
class Symbol : public Name {
public:
/// Creates a new Symbol value with an optional description.
static Symbol New(
napi_env env, ///< Node-API environment
const char* description =
nullptr ///< Optional UTF-8 encoded null-terminated C string
/// describing the symbol
);
/// Creates a new Symbol value with a description.
static Symbol New(
napi_env env, ///< Node-API environment
const std::string&
description ///< UTF-8 encoded C++ string describing the symbol
);
/// Creates a new Symbol value with a description.
static Symbol New(napi_env env, ///< Node-API environment
String description ///< String value describing the symbol
);
/// Creates a new Symbol value with a description.
static Symbol New(
napi_env env, ///< Node-API environment
napi_value description ///< String value describing the symbol
);
/// Get a public Symbol (e.g. Symbol.iterator).
static MaybeOrValue<Symbol> WellKnown(napi_env, const std::string& name);
// Create a symbol in the global registry, UTF-8 Encoded cpp string
static MaybeOrValue<Symbol> For(napi_env env, const std::string& description);
// Create a symbol in the global registry, C style string (null terminated)
static MaybeOrValue<Symbol> For(napi_env env, const char* description);
// Create a symbol in the global registry, String value describing the symbol
static MaybeOrValue<Symbol> For(napi_env env, String description);
// Create a symbol in the global registry, napi_value describing the symbol
static MaybeOrValue<Symbol> For(napi_env env, napi_value description);
static void CheckCast(napi_env env, napi_value value);
Symbol(); ///< Creates a new _empty_ Symbol instance.
Symbol(napi_env env,
napi_value value); ///< Wraps a Node-API value primitive.
};
class TypeTaggable : public Value {
public:
#if NAPI_VERSION >= 8
void TypeTag(const napi_type_tag* type_tag) const;
bool CheckTypeTag(const napi_type_tag* type_tag) const;
#endif // NAPI_VERSION >= 8
protected:
TypeTaggable();
TypeTaggable(napi_env env, napi_value value);
};
/// A JavaScript object value.
class Object : public TypeTaggable {
public:
/// Enables property and element assignments using indexing syntax.
///
/// This is a convenient helper to get and set object properties. As
/// getting and setting object properties may throw with JavaScript
/// exceptions, it is notable that these operations may fail.
/// When NODE_ADDON_API_ENABLE_MAYBE is defined, the process will abort
/// on JavaScript exceptions.
///
/// Example:
///
/// Napi::Value propertyValue = object1['A'];
/// object2['A'] = propertyValue;
/// Napi::Value elementValue = array[0];
/// array[1] = elementValue;
template <typename Key>
class PropertyLValue {
public:
/// Converts an L-value to a value.
operator Value() const;
/// Assigns a value to the property. The type of value can be
/// anything supported by `Object::Set`.
template <typename ValueType>
PropertyLValue& operator=(ValueType value);
private:
PropertyLValue() = delete;
PropertyLValue(Object object, Key key);
napi_env _env;
napi_value _object;
Key _key;
friend class Napi::Object;
};
/// Creates a new Object value.
static Object New(napi_env env ///< Node-API environment
);
static void CheckCast(napi_env env, napi_value value);
Object(); ///< Creates a new _empty_ Object instance.
Object(napi_env env,
napi_value value); ///< Wraps a Node-API value primitive.
/// Gets or sets a named property.
PropertyLValue<std::string> operator[](
const char* utf8name ///< UTF-8 encoded null-terminated property name
);
/// Gets or sets a named property.
PropertyLValue<std::string> operator[](
const std::string& utf8name ///< UTF-8 encoded property name
);
/// Gets or sets an indexed property or array element.
PropertyLValue<uint32_t> operator[](
uint32_t index /// Property / element index
);
/// Gets or sets an indexed property or array element.
PropertyLValue<Value> operator[](Value index /// Property / element index
) const;
/// Gets a named property.
MaybeOrValue<Value> operator[](
const char* utf8name ///< UTF-8 encoded null-terminated property name
) const;
/// Gets a named property.
MaybeOrValue<Value> operator[](
const std::string& utf8name ///< UTF-8 encoded property name
) const;
/// Gets an indexed property or array element.
MaybeOrValue<Value> operator[](uint32_t index ///< Property / element index
) const;
/// Checks whether a property is present.
MaybeOrValue<bool> Has(napi_value key ///< Property key primitive
) const;
/// Checks whether a property is present.
MaybeOrValue<bool> Has(Value key ///< Property key
) const;
/// Checks whether a named property is present.
MaybeOrValue<bool> Has(
const char* utf8name ///< UTF-8 encoded null-terminated property name
) const;
/// Checks whether a named property is present.
MaybeOrValue<bool> Has(
const std::string& utf8name ///< UTF-8 encoded property name
) const;
/// Checks whether a own property is present.
MaybeOrValue<bool> HasOwnProperty(napi_value key ///< Property key primitive
) const;
/// Checks whether a own property is present.
MaybeOrValue<bool> HasOwnProperty(Value key ///< Property key
) const;
/// Checks whether a own property is present.
MaybeOrValue<bool> HasOwnProperty(
const char* utf8name ///< UTF-8 encoded null-terminated property name
) const;
/// Checks whether a own property is present.
MaybeOrValue<bool> HasOwnProperty(
const std::string& utf8name ///< UTF-8 encoded property name
) const;
/// Gets a property.
MaybeOrValue<Value> Get(napi_value key ///< Property key primitive
) const;
/// Gets a property.
MaybeOrValue<Value> Get(Value key ///< Property key
) const;
/// Gets a named property.
MaybeOrValue<Value> Get(
const char* utf8name ///< UTF-8 encoded null-terminated property name
) const;
/// Gets a named property.
MaybeOrValue<Value> Get(
const std::string& utf8name ///< UTF-8 encoded property name
) const;
/// Sets a property.
template <typename ValueType>
MaybeOrValue<bool> Set(napi_value key, ///< Property key primitive
const ValueType& value ///< Property value primitive
) const;
/// Sets a property.
template <typename ValueType>
MaybeOrValue<bool> Set(Value key, ///< Property key
const ValueType& value ///< Property value
) const;
/// Sets a named property.
template <typename ValueType>
MaybeOrValue<bool> Set(
const char* utf8name, ///< UTF-8 encoded null-terminated property name
const ValueType& value) const;
/// Sets a named property.
template <typename ValueType>
MaybeOrValue<bool> Set(
const std::string& utf8name, ///< UTF-8 encoded property name
const ValueType& value ///< Property value primitive
) const;
/// Delete property.
MaybeOrValue<bool> Delete(napi_value key ///< Property key primitive
) const;
/// Delete property.
MaybeOrValue<bool> Delete(Value key ///< Property key
) const;
/// Delete property.
MaybeOrValue<bool> Delete(
const char* utf8name ///< UTF-8 encoded null-terminated property name
) const;
/// Delete property.
MaybeOrValue<bool> Delete(
const std::string& utf8name ///< UTF-8 encoded property name
) const;
/// Checks whether an indexed property is present.
MaybeOrValue<bool> Has(uint32_t index ///< Property / element index
) const;
/// Gets an indexed property or array element.
MaybeOrValue<Value> Get(uint32_t index ///< Property / element index
) const;
/// Sets an indexed property or array element.
template <typename ValueType>
MaybeOrValue<bool> Set(uint32_t index, ///< Property / element index
const ValueType& value ///< Property value primitive
) const;
/// Deletes an indexed property or array element.
MaybeOrValue<bool> Delete(uint32_t index ///< Property / element index
) const;
/// This operation can fail in case of Proxy.[[OwnPropertyKeys]] and
/// Proxy.[[GetOwnProperty]] calling into JavaScript. See:
/// -
/// https://tc39.es/ecma262/#sec-proxy-object-internal-methods-and-internal-slots-ownpropertykeys
/// -
/// https://tc39.es/ecma262/#sec-proxy-object-internal-methods-and-internal-slots-getownproperty-p
MaybeOrValue<Array> GetPropertyNames() const; ///< Get all property names
/// Defines a property on the object.
///
/// This operation can fail in case of Proxy.[[DefineOwnProperty]] calling
/// into JavaScript. See
/// https://tc39.es/ecma262/#sec-proxy-object-internal-methods-and-internal-slots-defineownproperty-p-desc
MaybeOrValue<bool> DefineProperty(
const PropertyDescriptor&
property ///< Descriptor for the property to be defined
) const;
/// Defines properties on the object.
///
/// This operation can fail in case of Proxy.[[DefineOwnProperty]] calling
/// into JavaScript. See
/// https://tc39.es/ecma262/#sec-proxy-object-internal-methods-and-internal-slots-defineownproperty-p-desc
MaybeOrValue<bool> DefineProperties(
const std::initializer_list<PropertyDescriptor>& properties
///< List of descriptors for the properties to be defined
) const;
/// Defines properties on the object.
///
/// This operation can fail in case of Proxy.[[DefineOwnProperty]] calling
/// into JavaScript. See
/// https://tc39.es/ecma262/#sec-proxy-object-internal-methods-and-internal-slots-defineownproperty-p-desc
MaybeOrValue<bool> DefineProperties(
const std::vector<PropertyDescriptor>& properties
///< Vector of descriptors for the properties to be defined
) const;
/// Checks if an object is an instance created by a constructor function.
///
/// This is equivalent to the JavaScript `instanceof` operator.
///
/// This operation can fail in case of Proxy.[[GetPrototypeOf]] calling into
/// JavaScript.
/// See
/// https://tc39.es/ecma262/#sec-proxy-object-internal-methods-and-internal-slots-getprototypeof
MaybeOrValue<bool> InstanceOf(
const Function& constructor ///< Constructor function
) const;
template <typename Finalizer, typename T>
inline void AddFinalizer(Finalizer finalizeCallback, T* data) const;
template <typename Finalizer, typename T, typename Hint>
inline void AddFinalizer(Finalizer finalizeCallback,
T* data,
Hint* finalizeHint) const;
#ifdef NAPI_CPP_EXCEPTIONS
class const_iterator;
inline const_iterator begin() const;
inline const_iterator end() const;
class iterator;
inline iterator begin();
inline iterator end();
#endif // NAPI_CPP_EXCEPTIONS
#if NAPI_VERSION >= 8
/// This operation can fail in case of Proxy.[[GetPrototypeOf]] calling into
/// JavaScript.
/// See
/// https://tc39.es/ecma262/#sec-proxy-object-internal-methods-and-internal-slots-getprototypeof
MaybeOrValue<bool> Freeze() const;
/// This operation can fail in case of Proxy.[[GetPrototypeOf]] calling into
/// JavaScript.
/// See
/// https://tc39.es/ecma262/#sec-proxy-object-internal-methods-and-internal-slots-getprototypeof
MaybeOrValue<bool> Seal() const;
#endif // NAPI_VERSION >= 8
};
template <typename T>
class External : public TypeTaggable {
public:
static External New(napi_env env, T* data);
// Finalizer must implement `void operator()(Env env, T* data)`.
template <typename Finalizer>
static External New(napi_env env, T* data, Finalizer finalizeCallback);
// Finalizer must implement `void operator()(Env env, T* data, Hint* hint)`.
template <typename Finalizer, typename Hint>
static External New(napi_env env,
T* data,
Finalizer finalizeCallback,
Hint* finalizeHint);
static void CheckCast(napi_env env, napi_value value);
External();
External(napi_env env, napi_value value);
T* Data() const;
};
class Array : public Object {
public:
static Array New(napi_env env);
static Array New(napi_env env, size_t length);
static void CheckCast(napi_env env, napi_value value);
Array();
Array(napi_env env, napi_value value);
uint32_t Length() const;
};
#ifdef NAPI_CPP_EXCEPTIONS
class Object::const_iterator {
private:
enum class Type { BEGIN, END };
inline const_iterator(const Object* object, const Type type);
public:
inline const_iterator& operator++();
inline bool operator==(const const_iterator& other) const;
inline bool operator!=(const const_iterator& other) const;
inline const std::pair<Value, Object::PropertyLValue<Value>> operator*()
const;
private:
const Napi::Object* _object;
Array _keys;
uint32_t _index;
friend class Object;
};
class Object::iterator {
private:
enum class Type { BEGIN, END };
inline iterator(Object* object, const Type type);
public:
inline iterator& operator++();
inline bool operator==(const iterator& other) const;
inline bool operator!=(const iterator& other) const;
inline std::pair<Value, Object::PropertyLValue<Value>> operator*();
private:
Napi::Object* _object;
Array _keys;
uint32_t _index;
friend class Object;
};
#endif // NAPI_CPP_EXCEPTIONS
/// A JavaScript array buffer value.
class ArrayBuffer : public Object {
public:
/// Creates a new ArrayBuffer instance over a new automatically-allocated
/// buffer.
static ArrayBuffer New(
napi_env env, ///< Node-API environment
size_t byteLength ///< Length of the buffer to be allocated, in bytes
);
#ifndef NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
/// Creates a new ArrayBuffer instance, using an external buffer with
/// specified byte length.
static ArrayBuffer New(
napi_env env, ///< Node-API environment
void* externalData, ///< Pointer to the external buffer to be used by
///< the array
size_t byteLength ///< Length of the external buffer to be used by the
///< array, in bytes
);
/// Creates a new ArrayBuffer instance, using an external buffer with
/// specified byte length.
template <typename Finalizer>
static ArrayBuffer New(
napi_env env, ///< Node-API environment
void* externalData, ///< Pointer to the external buffer to be used by
///< the array
size_t byteLength, ///< Length of the external buffer to be used by the
///< array,
/// in bytes
Finalizer finalizeCallback ///< Function to be called when the array
///< buffer is destroyed;
/// must implement `void operator()(Env env,
/// void* externalData)`
);
/// Creates a new ArrayBuffer instance, using an external buffer with
/// specified byte length.
template <typename Finalizer, typename Hint>
static ArrayBuffer New(
napi_env env, ///< Node-API environment
void* externalData, ///< Pointer to the external buffer to be used by
///< the array
size_t byteLength, ///< Length of the external buffer to be used by the
///< array,
/// in bytes
Finalizer finalizeCallback, ///< Function to be called when the array
///< buffer is destroyed;
/// must implement `void operator()(Env
/// env, void* externalData, Hint* hint)`
Hint* finalizeHint ///< Hint (second parameter) to be passed to the
///< finalize callback
);
#endif // NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
static void CheckCast(napi_env env, napi_value value);
ArrayBuffer(); ///< Creates a new _empty_ ArrayBuffer instance.
ArrayBuffer(napi_env env,
napi_value value); ///< Wraps a Node-API value primitive.
void* Data(); ///< Gets a pointer to the data buffer.
size_t ByteLength(); ///< Gets the length of the array buffer in bytes.
#if NAPI_VERSION >= 7
bool IsDetached() const;
void Detach();
#endif // NAPI_VERSION >= 7
};
/// A JavaScript typed-array value with unknown array type.
///
/// For type-specific operations, cast to a `TypedArrayOf<T>` instance using the
/// `As()` method:
///
/// Napi::TypedArray array = ...
/// if (t.TypedArrayType() == napi_int32_array) {
/// Napi::Int32Array int32Array = t.As<Napi::Int32Array>();
/// }
class TypedArray : public Object {
public:
static void CheckCast(napi_env env, napi_value value);
TypedArray(); ///< Creates a new _empty_ TypedArray instance.
TypedArray(napi_env env,
napi_value value); ///< Wraps a Node-API value primitive.
napi_typedarray_type TypedArrayType()
const; ///< Gets the type of this typed-array.
Napi::ArrayBuffer ArrayBuffer() const; ///< Gets the backing array buffer.
uint8_t ElementSize()
const; ///< Gets the size in bytes of one element in the array.
size_t ElementLength() const; ///< Gets the number of elements in the array.
size_t ByteOffset()
const; ///< Gets the offset into the buffer where the array starts.
size_t ByteLength() const; ///< Gets the length of the array in bytes.
protected:
/// !cond INTERNAL
napi_typedarray_type _type;
size_t _length;
TypedArray(napi_env env,
napi_value value,
napi_typedarray_type type,
size_t length);
template <typename T>
static
#if defined(NAPI_HAS_CONSTEXPR)
constexpr
#endif
napi_typedarray_type
TypedArrayTypeForPrimitiveType() {
return std::is_same<T, int8_t>::value ? napi_int8_array
: std::is_same<T, uint8_t>::value ? napi_uint8_array
: std::is_same<T, int16_t>::value ? napi_int16_array
: std::is_same<T, uint16_t>::value ? napi_uint16_array
: std::is_same<T, int32_t>::value ? napi_int32_array
: std::is_same<T, uint32_t>::value ? napi_uint32_array
: std::is_same<T, float>::value ? napi_float32_array
: std::is_same<T, double>::value ? napi_float64_array
#if NAPI_VERSION > 5
: std::is_same<T, int64_t>::value ? napi_bigint64_array
: std::is_same<T, uint64_t>::value ? napi_biguint64_array
#endif // NAPI_VERSION > 5
: napi_int8_array;
}
/// !endcond
};
/// A JavaScript typed-array value with known array type.
///
/// Note while it is possible to create and access Uint8 "clamped" arrays using
/// this class, the _clamping_ behavior is only applied in JavaScript.
template <typename T>
class TypedArrayOf : public TypedArray {
public:
/// Creates a new TypedArray instance over a new automatically-allocated array
/// buffer.
///
/// The array type parameter can normally be omitted (because it is inferred
/// from the template parameter T), except when creating a "clamped" array:
///
/// Uint8Array::New(env, length, napi_uint8_clamped_array)
static TypedArrayOf New(
napi_env env, ///< Node-API environment
size_t elementLength, ///< Length of the created array, as a number of
///< elements
#if defined(NAPI_HAS_CONSTEXPR)
napi_typedarray_type type =
TypedArray::TypedArrayTypeForPrimitiveType<T>()
#else
napi_typedarray_type type
#endif
///< Type of array, if different from the default array type for the
///< template parameter T.
);
/// Creates a new TypedArray instance over a provided array buffer.
///
/// The array type parameter can normally be omitted (because it is inferred
/// from the template parameter T), except when creating a "clamped" array:
///
/// Uint8Array::New(env, length, buffer, 0, napi_uint8_clamped_array)
static TypedArrayOf New(
napi_env env, ///< Node-API environment
size_t elementLength, ///< Length of the created array, as a number of
///< elements
Napi::ArrayBuffer arrayBuffer, ///< Backing array buffer instance to use
size_t bufferOffset, ///< Offset into the array buffer where the
///< typed-array starts
#if defined(NAPI_HAS_CONSTEXPR)
napi_typedarray_type type =
TypedArray::TypedArrayTypeForPrimitiveType<T>()
#else
napi_typedarray_type type
#endif
///< Type of array, if different from the default array type for the
///< template parameter T.
);
static void CheckCast(napi_env env, napi_value value);
TypedArrayOf(); ///< Creates a new _empty_ TypedArrayOf instance.
TypedArrayOf(napi_env env,
napi_value value); ///< Wraps a Node-API value primitive.
T& operator[](size_t index); ///< Gets or sets an element in the array.
const T& operator[](size_t index) const; ///< Gets an element in the array.
/// Gets a pointer to the array's backing buffer.
///
/// This is not necessarily the same as the `ArrayBuffer::Data()` pointer,
/// because the typed-array may have a non-zero `ByteOffset()` into the
/// `ArrayBuffer`.
T* Data();
/// Gets a pointer to the array's backing buffer.
///
/// This is not necessarily the same as the `ArrayBuffer::Data()` pointer,
/// because the typed-array may have a non-zero `ByteOffset()` into the
/// `ArrayBuffer`.
const T* Data() const;
private:
T* _data;
TypedArrayOf(napi_env env,
napi_value value,
napi_typedarray_type type,
size_t length,
T* data);
};
/// The DataView provides a low-level interface for reading/writing multiple
/// number types in an ArrayBuffer irrespective of the platform's endianness.
class DataView : public Object {
public:
static DataView New(napi_env env, Napi::ArrayBuffer arrayBuffer);
static DataView New(napi_env env,
Napi::ArrayBuffer arrayBuffer,
size_t byteOffset);
static DataView New(napi_env env,
Napi::ArrayBuffer arrayBuffer,
size_t byteOffset,
size_t byteLength);
static void CheckCast(napi_env env, napi_value value);
DataView(); ///< Creates a new _empty_ DataView instance.
DataView(napi_env env,
napi_value value); ///< Wraps a Node-API value primitive.
Napi::ArrayBuffer ArrayBuffer() const; ///< Gets the backing array buffer.
size_t ByteOffset()
const; ///< Gets the offset into the buffer where the array starts.
size_t ByteLength() const; ///< Gets the length of the array in bytes.
void* Data() const;
float GetFloat32(size_t byteOffset) const;
double GetFloat64(size_t byteOffset) const;
int8_t GetInt8(size_t byteOffset) const;
int16_t GetInt16(size_t byteOffset) const;
int32_t GetInt32(size_t byteOffset) const;
uint8_t GetUint8(size_t byteOffset) const;
uint16_t GetUint16(size_t byteOffset) const;
uint32_t GetUint32(size_t byteOffset) const;
void SetFloat32(size_t byteOffset, float value) const;
void SetFloat64(size_t byteOffset, double value) const;
void SetInt8(size_t byteOffset, int8_t value) const;
void SetInt16(size_t byteOffset, int16_t value) const;
void SetInt32(size_t byteOffset, int32_t value) const;
void SetUint8(size_t byteOffset, uint8_t value) const;
void SetUint16(size_t byteOffset, uint16_t value) const;
void SetUint32(size_t byteOffset, uint32_t value) const;
private:
template <typename T>
T ReadData(size_t byteOffset) const;
template <typename T>
void WriteData(size_t byteOffset, T value) const;
void* _data;
size_t _length;
};
class Function : public Object {
public:
using VoidCallback = void (*)(const CallbackInfo& info);
using Callback = Value (*)(const CallbackInfo& info);
template <VoidCallback cb>
static Function New(napi_env env,
const char* utf8name = nullptr,
void* data = nullptr);
template <Callback cb>
static Function New(napi_env env,
const char* utf8name = nullptr,
void* data = nullptr);
template <VoidCallback cb>
static Function New(napi_env env,
const std::string& utf8name,
void* data = nullptr);
template <Callback cb>
static Function New(napi_env env,
const std::string& utf8name,
void* data = nullptr);
/// Callable must implement operator() accepting a const CallbackInfo&
/// and return either void or Value.
template <typename Callable>
static Function New(napi_env env,
Callable cb,
const char* utf8name = nullptr,
void* data = nullptr);
/// Callable must implement operator() accepting a const CallbackInfo&
/// and return either void or Value.
template <typename Callable>
static Function New(napi_env env,
Callable cb,
const std::string& utf8name,
void* data = nullptr);
static void CheckCast(napi_env env, napi_value value);
Function();
Function(napi_env env, napi_value value);
MaybeOrValue<Value> operator()(
const std::initializer_list<napi_value>& args) const;
MaybeOrValue<Value> Call(const std::initializer_list<napi_value>& args) const;
MaybeOrValue<Value> Call(const std::vector<napi_value>& args) const;
MaybeOrValue<Value> Call(const std::vector<Value>& args) const;
MaybeOrValue<Value> Call(size_t argc, const napi_value* args) const;
MaybeOrValue<Value> Call(napi_value recv,
const std::initializer_list<napi_value>& args) const;
MaybeOrValue<Value> Call(napi_value recv,
const std::vector<napi_value>& args) const;
MaybeOrValue<Value> Call(napi_value recv,
const std::vector<Value>& args) const;
MaybeOrValue<Value> Call(napi_value recv,
size_t argc,
const napi_value* args) const;
MaybeOrValue<Value> MakeCallback(
napi_value recv,
const std::initializer_list<napi_value>& args,
napi_async_context context = nullptr) const;
MaybeOrValue<Value> MakeCallback(napi_value recv,
const std::vector<napi_value>& args,
napi_async_context context = nullptr) const;
MaybeOrValue<Value> MakeCallback(napi_value recv,
size_t argc,
const napi_value* args,
napi_async_context context = nullptr) const;
MaybeOrValue<Object> New(const std::initializer_list<napi_value>& args) const;
MaybeOrValue<Object> New(const std::vector<napi_value>& args) const;
MaybeOrValue<Object> New(size_t argc, const napi_value* args) const;
};
class Promise : public Object {
public:
class Deferred {
public:
static Deferred New(napi_env env);
Deferred(napi_env env);
Napi::Promise Promise() const;
Napi::Env Env() const;
void Resolve(napi_value value) const;
void Reject(napi_value value) const;
private:
napi_env _env;
napi_deferred _deferred;
napi_value _promise;
};
static void CheckCast(napi_env env, napi_value value);
Promise(napi_env env, napi_value value);
};
template <typename T>
class Buffer : public Uint8Array {
public:
static Buffer<T> New(napi_env env, size_t length);
#ifndef NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
static Buffer<T> New(napi_env env, T* data, size_t length);
// Finalizer must implement `void operator()(Env env, T* data)`.
template <typename Finalizer>
static Buffer<T> New(napi_env env,
T* data,
size_t length,
Finalizer finalizeCallback);
// Finalizer must implement `void operator()(Env env, T* data, Hint* hint)`.
template <typename Finalizer, typename Hint>
static Buffer<T> New(napi_env env,
T* data,
size_t length,
Finalizer finalizeCallback,
Hint* finalizeHint);
#endif // NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
static Buffer<T> NewOrCopy(napi_env env, T* data, size_t length);
// Finalizer must implement `void operator()(Env env, T* data)`.
template <typename Finalizer>
static Buffer<T> NewOrCopy(napi_env env,
T* data,
size_t length,
Finalizer finalizeCallback);
// Finalizer must implement `void operator()(Env env, T* data, Hint* hint)`.
template <typename Finalizer, typename Hint>
static Buffer<T> NewOrCopy(napi_env env,
T* data,
size_t length,
Finalizer finalizeCallback,
Hint* finalizeHint);
static Buffer<T> Copy(napi_env env, const T* data, size_t length);
static void CheckCast(napi_env env, napi_value value);
Buffer();
Buffer(napi_env env, napi_value value);
size_t Length() const;
T* Data() const;
private:
};
/// Holds a counted reference to a value; initially a weak reference unless
/// otherwise specified, may be changed to/from a strong reference by adjusting
/// the refcount.
///
/// The referenced value is not immediately destroyed when the reference count
/// is zero; it is merely then eligible for garbage-collection if there are no
/// other references to the value.
template <typename T>
class Reference {
public:
static Reference<T> New(const T& value, uint32_t initialRefcount = 0);
Reference();
Reference(napi_env env, napi_ref ref);
~Reference();
// A reference can be moved but cannot be copied.
Reference(Reference<T>&& other);
Reference<T>& operator=(Reference<T>&& other);
NAPI_DISALLOW_ASSIGN(Reference<T>)
operator napi_ref() const;
bool operator==(const Reference<T>& other) const;
bool operator!=(const Reference<T>& other) const;
Napi::Env Env() const;
bool IsEmpty() const;
// Note when getting the value of a Reference it is usually correct to do so
// within a HandleScope so that the value handle gets cleaned up efficiently.
T Value() const;
uint32_t Ref() const;
uint32_t Unref() const;
void Reset();
void Reset(const T& value, uint32_t refcount = 0);
// Call this on a reference that is declared as static data, to prevent its
// destructor from running at program shutdown time, which would attempt to
// reset the reference when the environment is no longer valid. Avoid using
// this if at all possible. If you do need to use static data, MAKE SURE to
// warn your users that your addon is NOT threadsafe.
void SuppressDestruct();
protected:
Reference(const Reference<T>&);
/// !cond INTERNAL
napi_env _env;
napi_ref _ref;
/// !endcond
private:
bool _suppressDestruct;
};
class ObjectReference : public Reference<Object> {
public:
ObjectReference();
ObjectReference(napi_env env, napi_ref ref);
// A reference can be moved but cannot be copied.
ObjectReference(Reference<Object>&& other);
ObjectReference& operator=(Reference<Object>&& other);
ObjectReference(ObjectReference&& other);
ObjectReference& operator=(ObjectReference&& other);
NAPI_DISALLOW_ASSIGN(ObjectReference)
MaybeOrValue<Napi::Value> Get(const char* utf8name) const;
MaybeOrValue<Napi::Value> Get(const std::string& utf8name) const;
MaybeOrValue<bool> Set(const char* utf8name, napi_value value) const;
MaybeOrValue<bool> Set(const char* utf8name, Napi::Value value) const;
MaybeOrValue<bool> Set(const char* utf8name, const char* utf8value) const;
MaybeOrValue<bool> Set(const char* utf8name, bool boolValue) const;
MaybeOrValue<bool> Set(const char* utf8name, double numberValue) const;
MaybeOrValue<bool> Set(const std::string& utf8name, napi_value value) const;
MaybeOrValue<bool> Set(const std::string& utf8name, Napi::Value value) const;
MaybeOrValue<bool> Set(const std::string& utf8name,
std::string& utf8value) const;
MaybeOrValue<bool> Set(const std::string& utf8name, bool boolValue) const;
MaybeOrValue<bool> Set(const std::string& utf8name, double numberValue) const;
MaybeOrValue<Napi::Value> Get(uint32_t index) const;
MaybeOrValue<bool> Set(uint32_t index, const napi_value value) const;
MaybeOrValue<bool> Set(uint32_t index, const Napi::Value value) const;
MaybeOrValue<bool> Set(uint32_t index, const char* utf8value) const;
MaybeOrValue<bool> Set(uint32_t index, const std::string& utf8value) const;
MaybeOrValue<bool> Set(uint32_t index, bool boolValue) const;
MaybeOrValue<bool> Set(uint32_t index, double numberValue) const;
protected:
ObjectReference(const ObjectReference&);
};
class FunctionReference : public Reference<Function> {
public:
FunctionReference();
FunctionReference(napi_env env, napi_ref ref);
// A reference can be moved but cannot be copied.
FunctionReference(Reference<Function>&& other);
FunctionReference& operator=(Reference<Function>&& other);
FunctionReference(FunctionReference&& other);
FunctionReference& operator=(FunctionReference&& other);
NAPI_DISALLOW_ASSIGN_COPY(FunctionReference)
MaybeOrValue<Napi::Value> operator()(
const std::initializer_list<napi_value>& args) const;
MaybeOrValue<Napi::Value> Call(
const std::initializer_list<napi_value>& args) const;
MaybeOrValue<Napi::Value> Call(const std::vector<napi_value>& args) const;
MaybeOrValue<Napi::Value> Call(
napi_value recv, const std::initializer_list<napi_value>& args) const;
MaybeOrValue<Napi::Value> Call(napi_value recv,
const std::vector<napi_value>& args) const;
MaybeOrValue<Napi::Value> Call(napi_value recv,
size_t argc,
const napi_value* args) const;
MaybeOrValue<Napi::Value> MakeCallback(
napi_value recv,
const std::initializer_list<napi_value>& args,
napi_async_context context = nullptr) const;
MaybeOrValue<Napi::Value> MakeCallback(
napi_value recv,
const std::vector<napi_value>& args,
napi_async_context context = nullptr) const;
MaybeOrValue<Napi::Value> MakeCallback(
napi_value recv,
size_t argc,
const napi_value* args,
napi_async_context context = nullptr) const;
MaybeOrValue<Object> New(const std::initializer_list<napi_value>& args) const;
MaybeOrValue<Object> New(const std::vector<napi_value>& args) const;
};
// Shortcuts to creating a new reference with inferred type and refcount = 0.
template <typename T>
Reference<T> Weak(T value);
ObjectReference Weak(Object value);
FunctionReference Weak(Function value);
// Shortcuts to creating a new reference with inferred type and refcount = 1.
template <typename T>
Reference<T> Persistent(T value);
ObjectReference Persistent(Object value);
FunctionReference Persistent(Function value);
/// A persistent reference to a JavaScript error object. Use of this class
/// depends somewhat on whether C++ exceptions are enabled at compile time.
///
/// ### Handling Errors With C++ Exceptions
///
/// If C++ exceptions are enabled, then the `Error` class extends
/// `std::exception` and enables integrated error-handling for C++ exceptions
/// and JavaScript exceptions.
///
/// If a Node-API call fails without executing any JavaScript code (for
/// example due to an invalid argument), then the Node-API wrapper
/// automatically converts and throws the error as a C++ exception of type
/// `Napi::Error`. Or if a JavaScript function called by C++ code via Node-API
/// throws a JavaScript exception, then the Node-API wrapper automatically
/// converts and throws it as a C++ exception of type `Napi::Error`.
///
/// If a C++ exception of type `Napi::Error` escapes from a Node-API C++
/// callback, then the Node-API wrapper automatically converts and throws it
/// as a JavaScript exception. Therefore, catching a C++ exception of type
/// `Napi::Error` prevents a JavaScript exception from being thrown.
///
/// #### Example 1A - Throwing a C++ exception:
///
/// Napi::Env env = ...
/// throw Napi::Error::New(env, "Example exception");
///
/// Following C++ statements will not be executed. The exception will bubble
/// up as a C++ exception of type `Napi::Error`, until it is either caught
/// while still in C++, or else automatically propataged as a JavaScript
/// exception when the callback returns to JavaScript.
///
/// #### Example 2A - Propagating a Node-API C++ exception:
///
/// Napi::Function jsFunctionThatThrows = someObj.As<Napi::Function>();
/// Napi::Value result = jsFunctionThatThrows({ arg1, arg2 });
///
/// Following C++ statements will not be executed. The exception will bubble
/// up as a C++ exception of type `Napi::Error`, until it is either caught
/// while still in C++, or else automatically propagated as a JavaScript
/// exception when the callback returns to JavaScript.
///
/// #### Example 3A - Handling a Node-API C++ exception:
///
/// Napi::Function jsFunctionThatThrows = someObj.As<Napi::Function>();
/// Napi::Value result;
/// try {
/// result = jsFunctionThatThrows({ arg1, arg2 });
/// } catch (const Napi::Error& e) {
/// cerr << "Caught JavaScript exception: " + e.what();
/// }
///
/// Since the exception was caught here, it will not be propagated as a
/// JavaScript exception.
///
/// ### Handling Errors Without C++ Exceptions
///
/// If C++ exceptions are disabled (by defining `NAPI_DISABLE_CPP_EXCEPTIONS`)
/// then this class does not extend `std::exception`, and APIs in the `Napi`
/// namespace do not throw C++ exceptions when they fail. Instead, they raise
/// _pending_ JavaScript exceptions and return _empty_ `Value`s. Calling code
/// should check `Value::IsEmpty()` before attempting to use a returned value,
/// and may use methods on the `Env` class to check for, get, and clear a
/// pending JavaScript exception. If the pending exception is not cleared, it
/// will be thrown when the native callback returns to JavaScript.
///
/// #### Example 1B - Throwing a JS exception
///
/// Napi::Env env = ...
/// Napi::Error::New(env, "Example
/// exception").ThrowAsJavaScriptException(); return;
///
/// After throwing a JS exception, the code should generally return
/// immediately from the native callback, after performing any necessary
/// cleanup.
///
/// #### Example 2B - Propagating a Node-API JS exception:
///
/// Napi::Function jsFunctionThatThrows = someObj.As<Napi::Function>();
/// Napi::Value result = jsFunctionThatThrows({ arg1, arg2 });
/// if (result.IsEmpty()) return;
///
/// An empty value result from a Node-API call indicates an error occurred,
/// and a JavaScript exception is pending. To let the exception propagate, the
/// code should generally return immediately from the native callback, after
/// performing any necessary cleanup.
///
/// #### Example 3B - Handling a Node-API JS exception:
///
/// Napi::Function jsFunctionThatThrows = someObj.As<Napi::Function>();
/// Napi::Value result = jsFunctionThatThrows({ arg1, arg2 });
/// if (result.IsEmpty()) {
/// Napi::Error e = env.GetAndClearPendingException();
/// cerr << "Caught JavaScript exception: " + e.Message();
/// }
///
/// Since the exception was cleared here, it will not be propagated as a
/// JavaScript exception after the native callback returns.
class Error : public ObjectReference
#ifdef NAPI_CPP_EXCEPTIONS
,
public std::exception
#endif // NAPI_CPP_EXCEPTIONS
{
public:
static Error New(napi_env env);
static Error New(napi_env env, const char* message);
static Error New(napi_env env, const std::string& message);
static NAPI_NO_RETURN void Fatal(const char* location, const char* message);
Error();
Error(napi_env env, napi_value value);
// An error can be moved or copied.
Error(Error&& other);
Error& operator=(Error&& other);
Error(const Error&);
Error& operator=(const Error&);
const std::string& Message() const NAPI_NOEXCEPT;
void ThrowAsJavaScriptException() const;
Object Value() const;
#ifdef NAPI_CPP_EXCEPTIONS
const char* what() const NAPI_NOEXCEPT override;
#endif // NAPI_CPP_EXCEPTIONS
protected:
/// !cond INTERNAL
using create_error_fn = napi_status (*)(napi_env envb,
napi_value code,
napi_value msg,
napi_value* result);
template <typename TError>
static TError New(napi_env env,
const char* message,
size_t length,
create_error_fn create_error);
/// !endcond
private:
static inline const char* ERROR_WRAP_VALUE() NAPI_NOEXCEPT;
mutable std::string _message;
};
class TypeError : public Error {
public:
static TypeError New(napi_env env, const char* message);
static TypeError New(napi_env env, const std::string& message);
TypeError();
TypeError(napi_env env, napi_value value);
};
class RangeError : public Error {
public:
static RangeError New(napi_env env, const char* message);
static RangeError New(napi_env env, const std::string& message);
RangeError();
RangeError(napi_env env, napi_value value);
};
#if NAPI_VERSION > 8
class SyntaxError : public Error {
public:
static SyntaxError New(napi_env env, const char* message);
static SyntaxError New(napi_env env, const std::string& message);
SyntaxError();
SyntaxError(napi_env env, napi_value value);
};
#endif // NAPI_VERSION > 8
class CallbackInfo {
public:
CallbackInfo(napi_env env, napi_callback_info info);
~CallbackInfo();
// Disallow copying to prevent multiple free of _dynamicArgs
NAPI_DISALLOW_ASSIGN_COPY(CallbackInfo)
Napi::Env Env() const;
Value NewTarget() const;
bool IsConstructCall() const;
size_t Length() const;
const Value operator[](size_t index) const;
Value This() const;
void* Data() const;
void SetData(void* data);
explicit operator napi_callback_info() const;
private:
const size_t _staticArgCount = 6;
napi_env _env;
napi_callback_info _info;
napi_value _this;
size_t _argc;
napi_value* _argv;
napi_value _staticArgs[6];
napi_value* _dynamicArgs;
void* _data;
};
class PropertyDescriptor {
public:
using GetterCallback = Napi::Value (*)(const Napi::CallbackInfo& info);
using SetterCallback = void (*)(const Napi::CallbackInfo& info);
#ifndef NODE_ADDON_API_DISABLE_DEPRECATED
template <typename Getter>
static PropertyDescriptor Accessor(
const char* utf8name,
Getter getter,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <typename Getter>
static PropertyDescriptor Accessor(
const std::string& utf8name,
Getter getter,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <typename Getter>
static PropertyDescriptor Accessor(
napi_value name,
Getter getter,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <typename Getter>
static PropertyDescriptor Accessor(
Name name,
Getter getter,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <typename Getter, typename Setter>
static PropertyDescriptor Accessor(
const char* utf8name,
Getter getter,
Setter setter,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <typename Getter, typename Setter>
static PropertyDescriptor Accessor(
const std::string& utf8name,
Getter getter,
Setter setter,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <typename Getter, typename Setter>
static PropertyDescriptor Accessor(
napi_value name,
Getter getter,
Setter setter,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <typename Getter, typename Setter>
static PropertyDescriptor Accessor(
Name name,
Getter getter,
Setter setter,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <typename Callable>
static PropertyDescriptor Function(
const char* utf8name,
Callable cb,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <typename Callable>
static PropertyDescriptor Function(
const std::string& utf8name,
Callable cb,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <typename Callable>
static PropertyDescriptor Function(
napi_value name,
Callable cb,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <typename Callable>
static PropertyDescriptor Function(
Name name,
Callable cb,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
#endif // !NODE_ADDON_API_DISABLE_DEPRECATED
template <GetterCallback Getter>
static PropertyDescriptor Accessor(
const char* utf8name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <GetterCallback Getter>
static PropertyDescriptor Accessor(
const std::string& utf8name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <GetterCallback Getter>
static PropertyDescriptor Accessor(
Name name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <GetterCallback Getter, SetterCallback Setter>
static PropertyDescriptor Accessor(
const char* utf8name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <GetterCallback Getter, SetterCallback Setter>
static PropertyDescriptor Accessor(
const std::string& utf8name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <GetterCallback Getter, SetterCallback Setter>
static PropertyDescriptor Accessor(
Name name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <typename Getter>
static PropertyDescriptor Accessor(
Napi::Env env,
Napi::Object object,
const char* utf8name,
Getter getter,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <typename Getter>
static PropertyDescriptor Accessor(
Napi::Env env,
Napi::Object object,
const std::string& utf8name,
Getter getter,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <typename Getter>
static PropertyDescriptor Accessor(
Napi::Env env,
Napi::Object object,
Name name,
Getter getter,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <typename Getter, typename Setter>
static PropertyDescriptor Accessor(
Napi::Env env,
Napi::Object object,
const char* utf8name,
Getter getter,
Setter setter,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <typename Getter, typename Setter>
static PropertyDescriptor Accessor(
Napi::Env env,
Napi::Object object,
const std::string& utf8name,
Getter getter,
Setter setter,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <typename Getter, typename Setter>
static PropertyDescriptor Accessor(
Napi::Env env,
Napi::Object object,
Name name,
Getter getter,
Setter setter,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <typename Callable>
static PropertyDescriptor Function(
Napi::Env env,
Napi::Object object,
const char* utf8name,
Callable cb,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <typename Callable>
static PropertyDescriptor Function(
Napi::Env env,
Napi::Object object,
const std::string& utf8name,
Callable cb,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <typename Callable>
static PropertyDescriptor Function(
Napi::Env env,
Napi::Object object,
Name name,
Callable cb,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
static PropertyDescriptor Value(
const char* utf8name,
napi_value value,
napi_property_attributes attributes = napi_default);
static PropertyDescriptor Value(
const std::string& utf8name,
napi_value value,
napi_property_attributes attributes = napi_default);
static PropertyDescriptor Value(
napi_value name,
napi_value value,
napi_property_attributes attributes = napi_default);
static PropertyDescriptor Value(
Name name,
Napi::Value value,
napi_property_attributes attributes = napi_default);
PropertyDescriptor(napi_property_descriptor desc);
operator napi_property_descriptor&();
operator const napi_property_descriptor&() const;
private:
napi_property_descriptor _desc;
};
/// Property descriptor for use with `ObjectWrap::DefineClass()`.
///
/// This is different from the standalone `PropertyDescriptor` because it is
/// specific to each `ObjectWrap<T>` subclass. This prevents using descriptors
/// from a different class when defining a new class (preventing the callbacks
/// from having incorrect `this` pointers).
template <typename T>
class ClassPropertyDescriptor {
public:
ClassPropertyDescriptor(napi_property_descriptor desc) : _desc(desc) {}
operator napi_property_descriptor&() { return _desc; }
operator const napi_property_descriptor&() const { return _desc; }
private:
napi_property_descriptor _desc;
};
template <typename T, typename TCallback>
struct MethodCallbackData {
TCallback callback;
void* data;
};
template <typename T, typename TGetterCallback, typename TSetterCallback>
struct AccessorCallbackData {
TGetterCallback getterCallback;
TSetterCallback setterCallback;
void* data;
};
template <typename T>
class InstanceWrap {
public:
using InstanceVoidMethodCallback = void (T::*)(const CallbackInfo& info);
using InstanceMethodCallback = Napi::Value (T::*)(const CallbackInfo& info);
using InstanceGetterCallback = Napi::Value (T::*)(const CallbackInfo& info);
using InstanceSetterCallback = void (T::*)(const CallbackInfo& info,
const Napi::Value& value);
using PropertyDescriptor = ClassPropertyDescriptor<T>;
static PropertyDescriptor InstanceMethod(
const char* utf8name,
InstanceVoidMethodCallback method,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
static PropertyDescriptor InstanceMethod(
const char* utf8name,
InstanceMethodCallback method,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
static PropertyDescriptor InstanceMethod(
Symbol name,
InstanceVoidMethodCallback method,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
static PropertyDescriptor InstanceMethod(
Symbol name,
InstanceMethodCallback method,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <InstanceVoidMethodCallback method>
static PropertyDescriptor InstanceMethod(
const char* utf8name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <InstanceMethodCallback method>
static PropertyDescriptor InstanceMethod(
const char* utf8name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <InstanceVoidMethodCallback method>
static PropertyDescriptor InstanceMethod(
Symbol name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <InstanceMethodCallback method>
static PropertyDescriptor InstanceMethod(
Symbol name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
static PropertyDescriptor InstanceAccessor(
const char* utf8name,
InstanceGetterCallback getter,
InstanceSetterCallback setter,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
static PropertyDescriptor InstanceAccessor(
Symbol name,
InstanceGetterCallback getter,
InstanceSetterCallback setter,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <InstanceGetterCallback getter,
InstanceSetterCallback setter = nullptr>
static PropertyDescriptor InstanceAccessor(
const char* utf8name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <InstanceGetterCallback getter,
InstanceSetterCallback setter = nullptr>
static PropertyDescriptor InstanceAccessor(
Symbol name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
static PropertyDescriptor InstanceValue(
const char* utf8name,
Napi::Value value,
napi_property_attributes attributes = napi_default);
static PropertyDescriptor InstanceValue(
Symbol name,
Napi::Value value,
napi_property_attributes attributes = napi_default);
protected:
static void AttachPropData(napi_env env,
napi_value value,
const napi_property_descriptor* prop);
private:
using This = InstanceWrap<T>;
using InstanceVoidMethodCallbackData =
MethodCallbackData<T, InstanceVoidMethodCallback>;
using InstanceMethodCallbackData =
MethodCallbackData<T, InstanceMethodCallback>;
using InstanceAccessorCallbackData =
AccessorCallbackData<T, InstanceGetterCallback, InstanceSetterCallback>;
static napi_value InstanceVoidMethodCallbackWrapper(napi_env env,
napi_callback_info info);
static napi_value InstanceMethodCallbackWrapper(napi_env env,
napi_callback_info info);
static napi_value InstanceGetterCallbackWrapper(napi_env env,
napi_callback_info info);
static napi_value InstanceSetterCallbackWrapper(napi_env env,
napi_callback_info info);
template <InstanceSetterCallback method>
static napi_value WrappedMethod(napi_env env,
napi_callback_info info) NAPI_NOEXCEPT;
template <InstanceSetterCallback setter>
struct SetterTag {};
template <InstanceSetterCallback setter>
static napi_callback WrapSetter(SetterTag<setter>) NAPI_NOEXCEPT {
return &This::WrappedMethod<setter>;
}
static napi_callback WrapSetter(SetterTag<nullptr>) NAPI_NOEXCEPT {
return nullptr;
}
};
/// Base class to be extended by C++ classes exposed to JavaScript; each C++
/// class instance gets "wrapped" by a JavaScript object that is managed by this
/// class.
///
/// At initialization time, the `DefineClass()` method must be used to
/// hook up the accessor and method callbacks. It takes a list of
/// property descriptors, which can be constructed via the various
/// static methods on the base class.
///
/// #### Example:
///
/// class Example: public Napi::ObjectWrap<Example> {
/// public:
/// static void Initialize(Napi::Env& env, Napi::Object& target) {
/// Napi::Function constructor = DefineClass(env, "Example", {
/// InstanceAccessor<&Example::GetSomething,
/// &Example::SetSomething>("value"),
/// InstanceMethod<&Example::DoSomething>("doSomething"),
/// });
/// target.Set("Example", constructor);
/// }
///
/// Example(const Napi::CallbackInfo& info); // Constructor
/// Napi::Value GetSomething(const Napi::CallbackInfo& info);
/// void SetSomething(const Napi::CallbackInfo& info, const Napi::Value&
/// value); Napi::Value DoSomething(const Napi::CallbackInfo& info);
/// }
template <typename T>
class ObjectWrap : public InstanceWrap<T>, public Reference<Object> {
public:
ObjectWrap(const CallbackInfo& callbackInfo);
virtual ~ObjectWrap();
static T* Unwrap(Object wrapper);
// Methods exposed to JavaScript must conform to one of these callback
// signatures.
using StaticVoidMethodCallback = void (*)(const CallbackInfo& info);
using StaticMethodCallback = Napi::Value (*)(const CallbackInfo& info);
using StaticGetterCallback = Napi::Value (*)(const CallbackInfo& info);
using StaticSetterCallback = void (*)(const CallbackInfo& info,
const Napi::Value& value);
using PropertyDescriptor = ClassPropertyDescriptor<T>;
static Function DefineClass(
Napi::Env env,
const char* utf8name,
const std::initializer_list<PropertyDescriptor>& properties,
void* data = nullptr);
static Function DefineClass(Napi::Env env,
const char* utf8name,
const std::vector<PropertyDescriptor>& properties,
void* data = nullptr);
static PropertyDescriptor StaticMethod(
const char* utf8name,
StaticVoidMethodCallback method,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
static PropertyDescriptor StaticMethod(
const char* utf8name,
StaticMethodCallback method,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
static PropertyDescriptor StaticMethod(
Symbol name,
StaticVoidMethodCallback method,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
static PropertyDescriptor StaticMethod(
Symbol name,
StaticMethodCallback method,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <StaticVoidMethodCallback method>
static PropertyDescriptor StaticMethod(
const char* utf8name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <StaticVoidMethodCallback method>
static PropertyDescriptor StaticMethod(
Symbol name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <StaticMethodCallback method>
static PropertyDescriptor StaticMethod(
const char* utf8name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <StaticMethodCallback method>
static PropertyDescriptor StaticMethod(
Symbol name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
static PropertyDescriptor StaticAccessor(
const char* utf8name,
StaticGetterCallback getter,
StaticSetterCallback setter,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
static PropertyDescriptor StaticAccessor(
Symbol name,
StaticGetterCallback getter,
StaticSetterCallback setter,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <StaticGetterCallback getter, StaticSetterCallback setter = nullptr>
static PropertyDescriptor StaticAccessor(
const char* utf8name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
template <StaticGetterCallback getter, StaticSetterCallback setter = nullptr>
static PropertyDescriptor StaticAccessor(
Symbol name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
static PropertyDescriptor StaticValue(
const char* utf8name,
Napi::Value value,
napi_property_attributes attributes = napi_default);
static PropertyDescriptor StaticValue(
Symbol name,
Napi::Value value,
napi_property_attributes attributes = napi_default);
static Napi::Value OnCalledAsFunction(const Napi::CallbackInfo& callbackInfo);
virtual void Finalize(Napi::Env env);
private:
using This = ObjectWrap<T>;
static napi_value ConstructorCallbackWrapper(napi_env env,
napi_callback_info info);
static napi_value StaticVoidMethodCallbackWrapper(napi_env env,
napi_callback_info info);
static napi_value StaticMethodCallbackWrapper(napi_env env,
napi_callback_info info);
static napi_value StaticGetterCallbackWrapper(napi_env env,
napi_callback_info info);
static napi_value StaticSetterCallbackWrapper(napi_env env,
napi_callback_info info);
static void FinalizeCallback(napi_env env, void* data, void* hint);
static Function DefineClass(Napi::Env env,
const char* utf8name,
const size_t props_count,
const napi_property_descriptor* props,
void* data = nullptr);
using StaticVoidMethodCallbackData =
MethodCallbackData<T, StaticVoidMethodCallback>;
using StaticMethodCallbackData = MethodCallbackData<T, StaticMethodCallback>;
using StaticAccessorCallbackData =
AccessorCallbackData<T, StaticGetterCallback, StaticSetterCallback>;
template <StaticSetterCallback method>
static napi_value WrappedMethod(napi_env env,
napi_callback_info info) NAPI_NOEXCEPT;
template <StaticSetterCallback setter>
struct StaticSetterTag {};
template <StaticSetterCallback setter>
static napi_callback WrapStaticSetter(StaticSetterTag<setter>) NAPI_NOEXCEPT {
return &This::WrappedMethod<setter>;
}
static napi_callback WrapStaticSetter(StaticSetterTag<nullptr>)
NAPI_NOEXCEPT {
return nullptr;
}
bool _construction_failed = true;
};
class HandleScope {
public:
HandleScope(napi_env env, napi_handle_scope scope);
explicit HandleScope(Napi::Env env);
~HandleScope();
// Disallow copying to prevent double close of napi_handle_scope
NAPI_DISALLOW_ASSIGN_COPY(HandleScope)
operator napi_handle_scope() const;
Napi::Env Env() const;
private:
napi_env _env;
napi_handle_scope _scope;
};
class EscapableHandleScope {
public:
EscapableHandleScope(napi_env env, napi_escapable_handle_scope scope);
explicit EscapableHandleScope(Napi::Env env);
~EscapableHandleScope();
// Disallow copying to prevent double close of napi_escapable_handle_scope
NAPI_DISALLOW_ASSIGN_COPY(EscapableHandleScope)
operator napi_escapable_handle_scope() const;
Napi::Env Env() const;
Value Escape(napi_value escapee);
private:
napi_env _env;
napi_escapable_handle_scope _scope;
};
#if (NAPI_VERSION > 2)
class CallbackScope {
public:
CallbackScope(napi_env env, napi_callback_scope scope);
CallbackScope(napi_env env, napi_async_context context);
virtual ~CallbackScope();
// Disallow copying to prevent double close of napi_callback_scope
NAPI_DISALLOW_ASSIGN_COPY(CallbackScope)
operator napi_callback_scope() const;
Napi::Env Env() const;
private:
napi_env _env;
napi_callback_scope _scope;
};
#endif
class AsyncContext {
public:
explicit AsyncContext(napi_env env, const char* resource_name);
explicit AsyncContext(napi_env env,
const char* resource_name,
const Object& resource);
virtual ~AsyncContext();
AsyncContext(AsyncContext&& other);
AsyncContext& operator=(AsyncContext&& other);
NAPI_DISALLOW_ASSIGN_COPY(AsyncContext)
operator napi_async_context() const;
Napi::Env Env() const;
private:
napi_env _env;
napi_async_context _context;
};
#if NAPI_HAS_THREADS
class AsyncWorker {
public:
virtual ~AsyncWorker();
NAPI_DISALLOW_ASSIGN_COPY(AsyncWorker)
operator napi_async_work() const;
Napi::Env Env() const;
void Queue();
void Cancel();
void SuppressDestruct();
ObjectReference& Receiver();
FunctionReference& Callback();
virtual void OnExecute(Napi::Env env);
virtual void OnWorkComplete(Napi::Env env, napi_status status);
protected:
explicit AsyncWorker(const Function& callback);
explicit AsyncWorker(const Function& callback, const char* resource_name);
explicit AsyncWorker(const Function& callback,
const char* resource_name,
const Object& resource);
explicit AsyncWorker(const Object& receiver, const Function& callback);
explicit AsyncWorker(const Object& receiver,
const Function& callback,
const char* resource_name);
explicit AsyncWorker(const Object& receiver,
const Function& callback,
const char* resource_name,
const Object& resource);
explicit AsyncWorker(Napi::Env env);
explicit AsyncWorker(Napi::Env env, const char* resource_name);
explicit AsyncWorker(Napi::Env env,
const char* resource_name,
const Object& resource);
virtual void Execute() = 0;
virtual void OnOK();
virtual void OnError(const Error& e);
virtual void Destroy();
virtual std::vector<napi_value> GetResult(Napi::Env env);
void SetError(const std::string& error);
private:
static inline void OnAsyncWorkExecute(napi_env env, void* asyncworker);
static inline void OnAsyncWorkComplete(napi_env env,
napi_status status,
void* asyncworker);
napi_env _env;
napi_async_work _work;
ObjectReference _receiver;
FunctionReference _callback;
std::string _error;
bool _suppress_destruct;
};
#endif // NAPI_HAS_THREADS
#if (NAPI_VERSION > 3 && NAPI_HAS_THREADS)
class ThreadSafeFunction {
public:
// This API may only be called from the main thread.
template <typename ResourceString>
static ThreadSafeFunction New(napi_env env,
const Function& callback,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount);
// This API may only be called from the main thread.
template <typename ResourceString, typename ContextType>
static ThreadSafeFunction New(napi_env env,
const Function& callback,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context);
// This API may only be called from the main thread.
template <typename ResourceString, typename Finalizer>
static ThreadSafeFunction New(napi_env env,
const Function& callback,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
Finalizer finalizeCallback);
// This API may only be called from the main thread.
template <typename ResourceString,
typename Finalizer,
typename FinalizerDataType>
static ThreadSafeFunction New(napi_env env,
const Function& callback,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
Finalizer finalizeCallback,
FinalizerDataType* data);
// This API may only be called from the main thread.
template <typename ResourceString, typename ContextType, typename Finalizer>
static ThreadSafeFunction New(napi_env env,
const Function& callback,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context,
Finalizer finalizeCallback);
// This API may only be called from the main thread.
template <typename ResourceString,
typename ContextType,
typename Finalizer,
typename FinalizerDataType>
static ThreadSafeFunction New(napi_env env,
const Function& callback,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context,
Finalizer finalizeCallback,
FinalizerDataType* data);
// This API may only be called from the main thread.
template <typename ResourceString>
static ThreadSafeFunction New(napi_env env,
const Function& callback,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount);
// This API may only be called from the main thread.
template <typename ResourceString, typename ContextType>
static ThreadSafeFunction New(napi_env env,
const Function& callback,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context);
// This API may only be called from the main thread.
template <typename ResourceString, typename Finalizer>
static ThreadSafeFunction New(napi_env env,
const Function& callback,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
Finalizer finalizeCallback);
// This API may only be called from the main thread.
template <typename ResourceString,
typename Finalizer,
typename FinalizerDataType>
static ThreadSafeFunction New(napi_env env,
const Function& callback,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
Finalizer finalizeCallback,
FinalizerDataType* data);
// This API may only be called from the main thread.
template <typename ResourceString, typename ContextType, typename Finalizer>
static ThreadSafeFunction New(napi_env env,
const Function& callback,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context,
Finalizer finalizeCallback);
// This API may only be called from the main thread.
template <typename ResourceString,
typename ContextType,
typename Finalizer,
typename FinalizerDataType>
static ThreadSafeFunction New(napi_env env,
const Function& callback,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context,
Finalizer finalizeCallback,
FinalizerDataType* data);
ThreadSafeFunction();
ThreadSafeFunction(napi_threadsafe_function tsFunctionValue);
operator napi_threadsafe_function() const;
// This API may be called from any thread.
napi_status BlockingCall() const;
// This API may be called from any thread.
template <typename Callback>
napi_status BlockingCall(Callback callback) const;
// This API may be called from any thread.
template <typename DataType, typename Callback>
napi_status BlockingCall(DataType* data, Callback callback) const;
// This API may be called from any thread.
napi_status NonBlockingCall() const;
// This API may be called from any thread.
template <typename Callback>
napi_status NonBlockingCall(Callback callback) const;
// This API may be called from any thread.
template <typename DataType, typename Callback>
napi_status NonBlockingCall(DataType* data, Callback callback) const;
// This API may only be called from the main thread.
void Ref(napi_env env) const;
// This API may only be called from the main thread.
void Unref(napi_env env) const;
// This API may be called from any thread.
napi_status Acquire() const;
// This API may be called from any thread.
napi_status Release() const;
// This API may be called from any thread.
napi_status Abort() const;
struct ConvertibleContext {
template <class T>
operator T*() {
return static_cast<T*>(context);
}
void* context;
};
// This API may be called from any thread.
ConvertibleContext GetContext() const;
private:
using CallbackWrapper = std::function<void(Napi::Env, Napi::Function)>;
template <typename ResourceString,
typename ContextType,
typename Finalizer,
typename FinalizerDataType>
static ThreadSafeFunction New(napi_env env,
const Function& callback,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context,
Finalizer finalizeCallback,
FinalizerDataType* data,
napi_finalize wrapper);
napi_status CallInternal(CallbackWrapper* callbackWrapper,
napi_threadsafe_function_call_mode mode) const;
static void CallJS(napi_env env,
napi_value jsCallback,
void* context,
void* data);
napi_threadsafe_function _tsfn;
};
// A TypedThreadSafeFunction by default has no context (nullptr) and can
// accept any type (void) to its CallJs.
template <typename ContextType = std::nullptr_t,
typename DataType = void,
void (*CallJs)(Napi::Env, Napi::Function, ContextType*, DataType*) =
nullptr>
class TypedThreadSafeFunction {
public:
// This API may only be called from the main thread.
// Helper function that returns nullptr if running Node-API 5+, otherwise a
// non-empty, no-op Function. This provides the ability to specify at
// compile-time a callback parameter to `New` that safely does no action
// when targeting _any_ Node-API version.
#if NAPI_VERSION > 4
static std::nullptr_t EmptyFunctionFactory(Napi::Env env);
#else
static Napi::Function EmptyFunctionFactory(Napi::Env env);
#endif
static Napi::Function FunctionOrEmpty(Napi::Env env,
Napi::Function& callback);
#if NAPI_VERSION > 4
// This API may only be called from the main thread.
// Creates a new threadsafe function with:
// Callback [missing] Resource [missing] Finalizer [missing]
template <typename ResourceString>
static TypedThreadSafeFunction<ContextType, DataType, CallJs> New(
napi_env env,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context = nullptr);
// This API may only be called from the main thread.
// Creates a new threadsafe function with:
// Callback [missing] Resource [passed] Finalizer [missing]
template <typename ResourceString>
static TypedThreadSafeFunction<ContextType, DataType, CallJs> New(
napi_env env,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context = nullptr);
// This API may only be called from the main thread.
// Creates a new threadsafe function with:
// Callback [missing] Resource [missing] Finalizer [passed]
template <typename ResourceString,
typename Finalizer,
typename FinalizerDataType = void>
static TypedThreadSafeFunction<ContextType, DataType, CallJs> New(
napi_env env,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context,
Finalizer finalizeCallback,
FinalizerDataType* data = nullptr);
// This API may only be called from the main thread.
// Creates a new threadsafe function with:
// Callback [missing] Resource [passed] Finalizer [passed]
template <typename ResourceString,
typename Finalizer,
typename FinalizerDataType = void>
static TypedThreadSafeFunction<ContextType, DataType, CallJs> New(
napi_env env,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context,
Finalizer finalizeCallback,
FinalizerDataType* data = nullptr);
#endif
// This API may only be called from the main thread.
// Creates a new threadsafe function with:
// Callback [passed] Resource [missing] Finalizer [missing]
template <typename ResourceString>
static TypedThreadSafeFunction<ContextType, DataType, CallJs> New(
napi_env env,
const Function& callback,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context = nullptr);
// This API may only be called from the main thread.
// Creates a new threadsafe function with:
// Callback [passed] Resource [passed] Finalizer [missing]
template <typename ResourceString>
static TypedThreadSafeFunction<ContextType, DataType, CallJs> New(
napi_env env,
const Function& callback,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context = nullptr);
// This API may only be called from the main thread.
// Creates a new threadsafe function with:
// Callback [passed] Resource [missing] Finalizer [passed]
template <typename ResourceString,
typename Finalizer,
typename FinalizerDataType = void>
static TypedThreadSafeFunction<ContextType, DataType, CallJs> New(
napi_env env,
const Function& callback,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context,
Finalizer finalizeCallback,
FinalizerDataType* data = nullptr);
// This API may only be called from the main thread.
// Creates a new threadsafe function with:
// Callback [passed] Resource [passed] Finalizer [passed]
template <typename CallbackType,
typename ResourceString,
typename Finalizer,
typename FinalizerDataType>
static TypedThreadSafeFunction<ContextType, DataType, CallJs> New(
napi_env env,
CallbackType callback,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context,
Finalizer finalizeCallback,
FinalizerDataType* data = nullptr);
TypedThreadSafeFunction();
TypedThreadSafeFunction(napi_threadsafe_function tsFunctionValue);
operator napi_threadsafe_function() const;
// This API may be called from any thread.
napi_status BlockingCall(DataType* data = nullptr) const;
// This API may be called from any thread.
napi_status NonBlockingCall(DataType* data = nullptr) const;
// This API may only be called from the main thread.
void Ref(napi_env env) const;
// This API may only be called from the main thread.
void Unref(napi_env env) const;
// This API may be called from any thread.
napi_status Acquire() const;
// This API may be called from any thread.
napi_status Release() const;
// This API may be called from any thread.
napi_status Abort() const;
// This API may be called from any thread.
ContextType* GetContext() const;
private:
template <typename ResourceString,
typename Finalizer,
typename FinalizerDataType>
static TypedThreadSafeFunction<ContextType, DataType, CallJs> New(
napi_env env,
const Function& callback,
const Object& resource,
ResourceString resourceName,
size_t maxQueueSize,
size_t initialThreadCount,
ContextType* context,
Finalizer finalizeCallback,
FinalizerDataType* data,
napi_finalize wrapper);
static void CallJsInternal(napi_env env,
napi_value jsCallback,
void* context,
void* data);
protected:
napi_threadsafe_function _tsfn;
};
template <typename DataType>
class AsyncProgressWorkerBase : public AsyncWorker {
public:
virtual void OnWorkProgress(DataType* data) = 0;
class ThreadSafeData {
public:
ThreadSafeData(AsyncProgressWorkerBase* asyncprogressworker, DataType* data)
: _asyncprogressworker(asyncprogressworker), _data(data) {}
AsyncProgressWorkerBase* asyncprogressworker() {
return _asyncprogressworker;
};
DataType* data() { return _data; };
private:
AsyncProgressWorkerBase* _asyncprogressworker;
DataType* _data;
};
void OnWorkComplete(Napi::Env env, napi_status status) override;
protected:
explicit AsyncProgressWorkerBase(const Object& receiver,
const Function& callback,
const char* resource_name,
const Object& resource,
size_t queue_size = 1);
virtual ~AsyncProgressWorkerBase();
// Optional callback of Napi::ThreadSafeFunction only available after
// NAPI_VERSION 4. Refs: https://github.com/nodejs/node/pull/27791
#if NAPI_VERSION > 4
explicit AsyncProgressWorkerBase(Napi::Env env,
const char* resource_name,
const Object& resource,
size_t queue_size = 1);
#endif
static inline void OnAsyncWorkProgress(Napi::Env env,
Napi::Function jsCallback,
void* data);
napi_status NonBlockingCall(DataType* data);
private:
ThreadSafeFunction _tsfn;
bool _work_completed = false;
napi_status _complete_status;
static inline void OnThreadSafeFunctionFinalize(
Napi::Env env, void* data, AsyncProgressWorkerBase* context);
};
template <class T>
class AsyncProgressWorker : public AsyncProgressWorkerBase<void> {
public:
virtual ~AsyncProgressWorker();
class ExecutionProgress {
friend class AsyncProgressWorker;
public:
void Signal() const;
void Send(const T* data, size_t count) const;
private:
explicit ExecutionProgress(AsyncProgressWorker* worker) : _worker(worker) {}
AsyncProgressWorker* const _worker;
};
void OnWorkProgress(void*) override;
protected:
explicit AsyncProgressWorker(const Function& callback);
explicit AsyncProgressWorker(const Function& callback,
const char* resource_name);
explicit AsyncProgressWorker(const Function& callback,
const char* resource_name,
const Object& resource);
explicit AsyncProgressWorker(const Object& receiver,
const Function& callback);
explicit AsyncProgressWorker(const Object& receiver,
const Function& callback,
const char* resource_name);
explicit AsyncProgressWorker(const Object& receiver,
const Function& callback,
const char* resource_name,
const Object& resource);
// Optional callback of Napi::ThreadSafeFunction only available after
// NAPI_VERSION 4. Refs: https://github.com/nodejs/node/pull/27791
#if NAPI_VERSION > 4
explicit AsyncProgressWorker(Napi::Env env);
explicit AsyncProgressWorker(Napi::Env env, const char* resource_name);
explicit AsyncProgressWorker(Napi::Env env,
const char* resource_name,
const Object& resource);
#endif
virtual void Execute(const ExecutionProgress& progress) = 0;
virtual void OnProgress(const T* data, size_t count) = 0;
private:
void Execute() override;
void Signal();
void SendProgress_(const T* data, size_t count);
std::mutex _mutex;
T* _asyncdata;
size_t _asyncsize;
bool _signaled;
};
template <class T>
class AsyncProgressQueueWorker
: public AsyncProgressWorkerBase<std::pair<T*, size_t>> {
public:
virtual ~AsyncProgressQueueWorker(){};
class ExecutionProgress {
friend class AsyncProgressQueueWorker;
public:
void Signal() const;
void Send(const T* data, size_t count) const;
private:
explicit ExecutionProgress(AsyncProgressQueueWorker* worker)
: _worker(worker) {}
AsyncProgressQueueWorker* const _worker;
};
void OnWorkComplete(Napi::Env env, napi_status status) override;
void OnWorkProgress(std::pair<T*, size_t>*) override;
protected:
explicit AsyncProgressQueueWorker(const Function& callback);
explicit AsyncProgressQueueWorker(const Function& callback,
const char* resource_name);
explicit AsyncProgressQueueWorker(const Function& callback,
const char* resource_name,
const Object& resource);
explicit AsyncProgressQueueWorker(const Object& receiver,
const Function& callback);
explicit AsyncProgressQueueWorker(const Object& receiver,
const Function& callback,
const char* resource_name);
explicit AsyncProgressQueueWorker(const Object& receiver,
const Function& callback,
const char* resource_name,
const Object& resource);
// Optional callback of Napi::ThreadSafeFunction only available after
// NAPI_VERSION 4. Refs: https://github.com/nodejs/node/pull/27791
#if NAPI_VERSION > 4
explicit AsyncProgressQueueWorker(Napi::Env env);
explicit AsyncProgressQueueWorker(Napi::Env env, const char* resource_name);
explicit AsyncProgressQueueWorker(Napi::Env env,
const char* resource_name,
const Object& resource);
#endif
virtual void Execute(const ExecutionProgress& progress) = 0;
virtual void OnProgress(const T* data, size_t count) = 0;
private:
void Execute() override;
void Signal() const;
void SendProgress_(const T* data, size_t count);
};
#endif // NAPI_VERSION > 3 && NAPI_HAS_THREADS
// Memory management.
class MemoryManagement {
public:
static int64_t AdjustExternalMemory(Env env, int64_t change_in_bytes);
};
// Version management
class VersionManagement {
public:
static uint32_t GetNapiVersion(Env env);
static const napi_node_version* GetNodeVersion(Env env);
};
#if NAPI_VERSION > 5
template <typename T>
class Addon : public InstanceWrap<T> {
public:
static inline Object Init(Env env, Object exports);
static T* Unwrap(Object wrapper);
protected:
using AddonProp = ClassPropertyDescriptor<T>;
void DefineAddon(Object exports,
const std::initializer_list<AddonProp>& props);
Napi::Object DefineProperties(Object object,
const std::initializer_list<AddonProp>& props);
private:
Object entry_point_;
};
#endif // NAPI_VERSION > 5
#ifdef NAPI_CPP_CUSTOM_NAMESPACE
} // namespace NAPI_CPP_CUSTOM_NAMESPACE
#endif
} // namespace Napi
// Inline implementations of all the above class methods are included here.
#include "napi-inl.h"
#endif // SRC_NAPI_H_
+32
View File
@@ -0,0 +1,32 @@
{
'targets': [
{
'target_name': 'node_addon_api',
'type': 'none',
'sources': [ 'napi.h', 'napi-inl.h' ],
'direct_dependent_settings': {
'include_dirs': [ '.' ],
'includes': ['noexcept.gypi'],
}
},
{
'target_name': 'node_addon_api_except',
'type': 'none',
'sources': [ 'napi.h', 'napi-inl.h' ],
'direct_dependent_settings': {
'include_dirs': [ '.' ],
'includes': ['except.gypi'],
}
},
{
'target_name': 'node_addon_api_maybe',
'type': 'none',
'sources': [ 'napi.h', 'napi-inl.h' ],
'direct_dependent_settings': {
'include_dirs': [ '.' ],
'includes': ['noexcept.gypi'],
'defines': ['NODE_ADDON_API_ENABLE_MAYBE']
}
},
]
}
+9
View File
@@ -0,0 +1,9 @@
{
'targets': [
{
'target_name': 'nothing',
'type': 'static_library',
'sources': [ 'nothing.c' ]
}
]
}
+26
View File
@@ -0,0 +1,26 @@
{
'defines': [ 'NAPI_DISABLE_CPP_EXCEPTIONS' ],
'cflags': [ '-fno-exceptions' ],
'cflags_cc': [ '-fno-exceptions' ],
'conditions': [
["OS=='win'", {
# _HAS_EXCEPTIONS is already defined and set to 0 in common.gypi
#"defines": [
# "_HAS_EXCEPTIONS=0"
#],
"msvs_settings": {
"VCCLCompilerTool": {
'ExceptionHandling': 0,
'EnablePREfast': 'true',
},
},
}],
["OS=='mac'", {
'xcode_settings': {
'CLANG_CXX_LIBRARY': 'libc++',
'MACOSX_DEPLOYMENT_TARGET': '10.7',
'GCC_ENABLE_CPP_EXCEPTIONS': 'NO',
},
}],
],
}
View File
+21
View File
@@ -0,0 +1,21 @@
{
"versions": [
{
"version": "*",
"target": {
"node": "active"
},
"response": {
"type": "time-permitting",
"paid": false,
"contact": {
"name": "node-addon-api team",
"url": "https://github.com/nodejs/node-addon-api/issues"
}
},
"backing": [ { "project": "https://github.com/nodejs" },
{ "foundation": "https://openjsf.org/" }
]
}
]
}
+480
View File
@@ -0,0 +1,480 @@
{
"bugs": {
"url": "https://github.com/nodejs/node-addon-api/issues"
},
"contributors": [
{
"name": "Abhishek Kumar Singh",
"url": "https://github.com/abhi11210646"
},
{
"name": "Alba Mendez",
"url": "https://github.com/jmendeth"
},
{
"name": "Alexander Floh",
"url": "https://github.com/alexanderfloh"
},
{
"name": "Ammar Faizi",
"url": "https://github.com/ammarfaizi2"
},
{
"name": "András Timár, Dr",
"url": "https://github.com/timarandras"
},
{
"name": "Andrew Petersen",
"url": "https://github.com/kirbysayshi"
},
{
"name": "Anisha Rohra",
"url": "https://github.com/anisha-rohra"
},
{
"name": "Anna Henningsen",
"url": "https://github.com/addaleax"
},
{
"name": "Arnaud Botella",
"url": "https://github.com/BotellaA"
},
{
"name": "Arunesh Chandra",
"url": "https://github.com/aruneshchandra"
},
{
"name": "Azlan Mukhtar",
"url": "https://github.com/azlan"
},
{
"name": "Ben Berman",
"url": "https://github.com/rivertam"
},
{
"name": "Benjamin Byholm",
"url": "https://github.com/kkoopa"
},
{
"name": "Bill Gallafent",
"url": "https://github.com/gallafent"
},
{
"name": "blagoev",
"url": "https://github.com/blagoev"
},
{
"name": "Bruce A. MacNaughton",
"url": "https://github.com/bmacnaughton"
},
{
"name": "Cory Mickelson",
"url": "https://github.com/corymickelson"
},
{
"name": "Daniel Bevenius",
"url": "https://github.com/danbev"
},
{
"name": "Dante Calderón",
"url": "https://github.com/dantehemerson"
},
{
"name": "Darshan Sen",
"url": "https://github.com/RaisinTen"
},
{
"name": "David Halls",
"url": "https://github.com/davedoesdev"
},
{
"name": "Deepak Rajamohan",
"url": "https://github.com/deepakrkris"
},
{
"name": "Dmitry Ashkadov",
"url": "https://github.com/dmitryash"
},
{
"name": "Dongjin Na",
"url": "https://github.com/nadongguri"
},
{
"name": "Doni Rubiagatra",
"url": "https://github.com/rubiagatra"
},
{
"name": "Eric Bickle",
"url": "https://github.com/ebickle"
},
{
"name": "extremeheat",
"url": "https://github.com/extremeheat"
},
{
"name": "Feng Yu",
"url": "https://github.com/F3n67u"
},
{
"name": "Ferdinand Holzer",
"url": "https://github.com/fholzer"
},
{
"name": "Gabriel Schulhof",
"url": "https://github.com/gabrielschulhof"
},
{
"name": "Guenter Sandner",
"url": "https://github.com/gms1"
},
{
"name": "Gus Caplan",
"url": "https://github.com/devsnek"
},
{
"name": "Helio Frota",
"url": "https://github.com/helio-frota"
},
{
"name": "Hitesh Kanwathirtha",
"url": "https://github.com/digitalinfinity"
},
{
"name": "ikokostya",
"url": "https://github.com/ikokostya"
},
{
"name": "Jack Xia",
"url": "https://github.com/JckXia"
},
{
"name": "Jake Barnes",
"url": "https://github.com/DuBistKomisch"
},
{
"name": "Jake Yoon",
"url": "https://github.com/yjaeseok"
},
{
"name": "Jason Ginchereau",
"url": "https://github.com/jasongin"
},
{
"name": "Jenny",
"url": "https://github.com/egg-bread"
},
{
"name": "Jeroen Janssen",
"url": "https://github.com/japj"
},
{
"name": "Jim Schlight",
"url": "https://github.com/jschlight"
},
{
"name": "Jinho Bang",
"url": "https://github.com/romandev"
},
{
"name": "José Expósito",
"url": "https://github.com/JoseExposito"
},
{
"name": "joshgarde",
"url": "https://github.com/joshgarde"
},
{
"name": "Julian Mesa",
"url": "https://github.com/julianmesa-gitkraken"
},
{
"name": "Kasumi Hanazuki",
"url": "https://github.com/hanazuki"
},
{
"name": "Kelvin",
"url": "https://github.com/kelvinhammond"
},
{
"name": "Kevin Eady",
"url": "https://github.com/KevinEady"
},
{
"name": "Kévin VOYER",
"url": "https://github.com/kecsou"
},
{
"name": "kidneysolo",
"url": "https://github.com/kidneysolo"
},
{
"name": "Koki Nishihara",
"url": "https://github.com/Nishikoh"
},
{
"name": "Konstantin Tarkus",
"url": "https://github.com/koistya"
},
{
"name": "Kyle Farnung",
"url": "https://github.com/kfarnung"
},
{
"name": "Kyle Kovacs",
"url": "https://github.com/nullromo"
},
{
"name": "legendecas",
"url": "https://github.com/legendecas"
},
{
"name": "LongYinan",
"url": "https://github.com/Brooooooklyn"
},
{
"name": "Lovell Fuller",
"url": "https://github.com/lovell"
},
{
"name": "Luciano Martorella",
"url": "https://github.com/lmartorella"
},
{
"name": "mastergberry",
"url": "https://github.com/mastergberry"
},
{
"name": "Mathias Küsel",
"url": "https://github.com/mathiask88"
},
{
"name": "Mathias Stearn",
"url": "https://github.com/RedBeard0531"
},
{
"name": "Matteo Collina",
"url": "https://github.com/mcollina"
},
{
"name": "Michael Dawson",
"url": "https://github.com/mhdawson"
},
{
"name": "Michael Price",
"url": "https://github.com/mikepricedev"
},
{
"name": "Michele Campus",
"url": "https://github.com/kYroL01"
},
{
"name": "Mikhail Cheshkov",
"url": "https://github.com/mcheshkov"
},
{
"name": "nempoBu4",
"url": "https://github.com/nempoBu4"
},
{
"name": "Nicola Del Gobbo",
"url": "https://github.com/NickNaso"
},
{
"name": "Nick Soggin",
"url": "https://github.com/iSkore"
},
{
"name": "Nikolai Vavilov",
"url": "https://github.com/seishun"
},
{
"name": "Nurbol Alpysbayev",
"url": "https://github.com/anurbol"
},
{
"name": "pacop",
"url": "https://github.com/pacop"
},
{
"name": "Peter Šándor",
"url": "https://github.com/petersandor"
},
{
"name": "Philipp Renoth",
"url": "https://github.com/DaAitch"
},
{
"name": "rgerd",
"url": "https://github.com/rgerd"
},
{
"name": "Richard Lau",
"url": "https://github.com/richardlau"
},
{
"name": "Rolf Timmermans",
"url": "https://github.com/rolftimmermans"
},
{
"name": "Ross Weir",
"url": "https://github.com/ross-weir"
},
{
"name": "Ryuichi Okumura",
"url": "https://github.com/okuryu"
},
{
"name": "Saint Gabriel",
"url": "https://github.com/chineduG"
},
{
"name": "Sampson Gao",
"url": "https://github.com/sampsongao"
},
{
"name": "Sam Roberts",
"url": "https://github.com/sam-github"
},
{
"name": "strager",
"url": "https://github.com/strager"
},
{
"name": "Taylor Woll",
"url": "https://github.com/boingoing"
},
{
"name": "Thomas Gentilhomme",
"url": "https://github.com/fraxken"
},
{
"name": "Tim Rach",
"url": "https://github.com/timrach"
},
{
"name": "Tobias Nießen",
"url": "https://github.com/tniessen"
},
{
"name": "todoroff",
"url": "https://github.com/todoroff"
},
{
"name": "Toyo Li",
"url": "https://github.com/toyobayashi"
},
{
"name": "Tux3",
"url": "https://github.com/tux3"
},
{
"name": "Vlad Velmisov",
"url": "https://github.com/Velmisov"
},
{
"name": "Vladimir Morozov",
"url": "https://github.com/vmoroz"
},
{
"name": "WenheLI",
"url": "https://github.com/WenheLI"
},
{
"name": "Xuguang Mei",
"url": "https://github.com/meixg"
},
{
"name": "Yohei Kishimoto",
"url": "https://github.com/morokosi"
},
{
"name": "Yulong Wang",
"url": "https://github.com/fs-eire"
},
{
"name": "Ziqiu Zhao",
"url": "https://github.com/ZzqiZQute"
},
{
"name": "Feng Yu",
"url": "https://github.com/F3n67u"
},
{
"name": "wanlu wang",
"url": "https://github.com/wanlu"
},
{
"name": "Caleb Hearon",
"url": "https://github.com/chearon"
},
{
"name": "Marx",
"url": "https://github.com/MarxJiao"
},
{
"name": "Ömer AKGÜL",
"url": "https://github.com/tuhalf"
}
],
"description": "Node.js API (Node-API)",
"devDependencies": {
"benchmark": "^2.1.4",
"bindings": "^1.5.0",
"clang-format": "^1.4.0",
"eslint": "^7.32.0",
"eslint-config-semistandard": "^16.0.0",
"eslint-config-standard": "^16.0.3",
"eslint-plugin-import": "^2.24.2",
"eslint-plugin-node": "^11.1.0",
"eslint-plugin-promise": "^5.1.0",
"fs-extra": "^11.1.1",
"path": "^0.12.7",
"pre-commit": "^1.2.2",
"safe-buffer": "^5.1.1"
},
"directories": {},
"gypfile": false,
"homepage": "https://github.com/nodejs/node-addon-api",
"keywords": [
"n-api",
"napi",
"addon",
"native",
"bindings",
"c",
"c++",
"nan",
"node-addon-api"
],
"license": "MIT",
"main": "index.js",
"name": "node-addon-api",
"readme": "README.md",
"repository": {
"type": "git",
"url": "git://github.com/nodejs/node-addon-api.git"
},
"files": [
"*.{c,h,gyp,gypi}",
"package-support.json",
"tools/"
],
"scripts": {
"prebenchmark": "node-gyp rebuild -C benchmark",
"benchmark": "node benchmark",
"pretest": "node-gyp rebuild -C test",
"test": "node test",
"test:debug": "node-gyp rebuild -C test --debug && NODE_API_BUILD_CONFIG=Debug node ./test/index.js",
"predev": "node-gyp rebuild -C test --debug",
"dev": "node test",
"predev:incremental": "node-gyp configure build -C test --debug",
"dev:incremental": "node test",
"doc": "doxygen doc/Doxyfile",
"lint": "node tools/eslint-format && node tools/clang-format",
"lint:fix": "node tools/clang-format --fix && node tools/eslint-format --fix"
},
"pre-commit": "lint",
"version": "7.1.1",
"support": true
}
+73
View File
@@ -0,0 +1,73 @@
# Tools
## clang-format
The clang-format checking tools is designed to check changed lines of code compared to given git-refs.
## Migration Script
The migration tool is designed to reduce repetitive work in the migration process. However, the script is not aiming to convert every thing for you. There are usually some small fixes and major reconstruction required.
### How To Use
To run the conversion script, first make sure you have the latest `node-addon-api` in your `node_modules` directory.
```
npm install node-addon-api
```
Then run the script passing your project directory
```
node ./node_modules/node-addon-api/tools/conversion.js ./
```
After finish, recompile and debug things that are missed by the script.
### Quick Fixes
Here is the list of things that can be fixed easily.
1. Change your methods' return value to void if it doesn't return value to JavaScript.
2. Use `.` to access attribute or to invoke member function in Napi::Object instead of `->`.
3. `Napi::New(env, value);` to `Napi::[Type]::New(env, value);
### Major Reconstructions
The implementation of `Napi::ObjectWrap` is significantly different from NAN's. `Napi::ObjectWrap` takes a pointer to the wrapped object and creates a reference to the wrapped object inside ObjectWrap constructor. `Napi::ObjectWrap` also associates wrapped object's instance methods to Javascript module instead of static methods like NAN.
So if you use Nan::ObjectWrap in your module, you will need to execute the following steps.
1. Convert your [ClassName]::New function to a constructor function that takes a `Napi::CallbackInfo`. Declare it as
```
[ClassName](const Napi::CallbackInfo& info);
```
and define it as
```
[ClassName]::[ClassName](const Napi::CallbackInfo& info) : Napi::ObjectWrap<[ClassName]>(info){
...
}
```
This way, the `Napi::ObjectWrap` constructor will be invoked after the object has been instantiated and `Napi::ObjectWrap` can use the `this` pointer to create a reference to the wrapped object.
2. Move your original constructor code into the new constructor. Delete your original constructor.
3. In your class initialization function, associate native methods in the following way.
```
Napi::FunctionReference constructor;
void [ClassName]::Init(Napi::Env env, Napi::Object exports, Napi::Object module) {
Napi::HandleScope scope(env);
Napi::Function ctor = DefineClass(env, "Canvas", {
InstanceMethod<&[ClassName]::Func1>("Func1"),
InstanceMethod<&[ClassName]::Func2>("Func2"),
InstanceAccessor<&[ClassName]::ValueGetter>("Value"),
StaticMethod<&[ClassName]::StaticMethod>("MethodName"),
InstanceValue("Value", Napi::[Type]::New(env, value)),
});
constructor = Napi::Persistent(ctor);
constructor .SuppressDestruct();
exports.Set("[ClassName]", ctor);
}
```
4. In function where you need to Unwrap the ObjectWrap in NAN like `[ClassName]* native = Nan::ObjectWrap::Unwrap<[ClassName]>(info.This());`, use `this` pointer directly as the unwrapped object as each ObjectWrap instance is associated with a unique object instance.
If you still find issues after following this guide, please leave us an issue describing your problem and we will try to resolve it.
+99
View File
@@ -0,0 +1,99 @@
'use strict';
// Descend into a directory structure and, for each file matching *.node, output
// based on the imports found in the file whether it's an N-API module or not.
const fs = require('fs');
const path = require('path');
// Read the output of the command, break it into lines, and use the reducer to
// decide whether the file is an N-API module or not.
function checkFile (file, command, argv, reducer) {
const child = require('child_process').spawn(command, argv, {
stdio: ['inherit', 'pipe', 'inherit']
});
let leftover = '';
let isNapi;
child.stdout.on('data', (chunk) => {
if (isNapi === undefined) {
chunk = (leftover + chunk.toString()).split(/[\r\n]+/);
leftover = chunk.pop();
isNapi = chunk.reduce(reducer, isNapi);
if (isNapi !== undefined) {
child.kill();
}
}
});
child.on('close', (code, signal) => {
if ((code === null && signal !== null) || (code !== 0)) {
console.log(
command + ' exited with code: ' + code + ' and signal: ' + signal);
} else {
// Green if it's a N-API module, red otherwise.
console.log(
'\x1b[' + (isNapi ? '42' : '41') + 'm' +
(isNapi ? ' N-API' : 'Not N-API') +
'\x1b[0m: ' + file);
}
});
}
// Use nm -a to list symbols.
function checkFileUNIX (file) {
checkFile(file, 'nm', ['-a', file], (soFar, line) => {
if (soFar === undefined) {
line = line.match(/([0-9a-f]*)? ([a-zA-Z]) (.*$)/);
if (line[2] === 'U') {
if (/^napi/.test(line[3])) {
soFar = true;
}
}
}
return soFar;
});
}
// Use dumpbin /imports to list symbols.
function checkFileWin32 (file) {
checkFile(file, 'dumpbin', ['/imports', file], (soFar, line) => {
if (soFar === undefined) {
line = line.match(/([0-9a-f]*)? +([a-zA-Z0-9]) (.*$)/);
if (line && /^napi/.test(line[line.length - 1])) {
soFar = true;
}
}
return soFar;
});
}
// Descend into a directory structure and pass each file ending in '.node' to
// one of the above checks, depending on the OS.
function recurse (top) {
fs.readdir(top, (error, items) => {
if (error) {
throw new Error('error reading directory ' + top + ': ' + error);
}
items.forEach((item) => {
item = path.join(top, item);
fs.stat(item, ((item) => (error, stats) => {
if (error) {
throw new Error('error about ' + item + ': ' + error);
}
if (stats.isDirectory()) {
recurse(item);
} else if (/[.]node$/.test(item) &&
// Explicitly ignore files called 'nothing.node' because they are
// artefacts of node-addon-api having identified a version of
// Node.js that ships with a correct implementation of N-API.
path.basename(item) !== 'nothing.node') {
process.platform === 'win32'
? checkFileWin32(item)
: checkFileUNIX(item);
}
})(item));
});
});
}
// Start with the directory given on the command line or the current directory
// if nothing was given.
recurse(process.argv.length > 3 ? process.argv[2] : '.');
+71
View File
@@ -0,0 +1,71 @@
#!/usr/bin/env node
const spawn = require('child_process').spawnSync;
const path = require('path');
const filesToCheck = ['*.h', '*.cc'];
const FORMAT_START = process.env.FORMAT_START || 'main';
function main (args) {
let fix = false;
while (args.length > 0) {
switch (args[0]) {
case '-f':
case '--fix':
fix = true;
break;
default:
}
args.shift();
}
const clangFormatPath = path.dirname(require.resolve('clang-format'));
const binary = process.platform === 'win32'
? 'node_modules\\.bin\\clang-format.cmd'
: 'node_modules/.bin/clang-format';
const options = ['--binary=' + binary, '--style=file'];
if (fix) {
options.push(FORMAT_START);
} else {
options.push('--diff', FORMAT_START);
}
const gitClangFormatPath = path.join(clangFormatPath, 'bin/git-clang-format');
const result = spawn(
'python',
[gitClangFormatPath, ...options, '--', ...filesToCheck],
{ encoding: 'utf-8' }
);
if (result.stderr) {
console.error('Error running git-clang-format:', result.stderr);
return 2;
}
const clangFormatOutput = result.stdout.trim();
// Bail fast if in fix mode.
if (fix) {
console.log(clangFormatOutput);
return 0;
}
// Detect if there is any complains from clang-format
if (
clangFormatOutput !== '' &&
clangFormatOutput !== 'no modified files to format' &&
clangFormatOutput !== 'clang-format did not modify any files'
) {
console.error(clangFormatOutput);
const fixCmd = 'npm run lint:fix';
console.error(`
ERROR: please run "${fixCmd}" to format changes in your commit
Note that when running the command locally, please keep your local
main branch and working branch up to date with nodejs/node-addon-api
to exclude un-related complains.
Or you can run "env FORMAT_START=upstream/main ${fixCmd}".`);
return 1;
}
}
if (require.main === module) {
process.exitCode = main(process.argv.slice(2));
}
+301
View File
@@ -0,0 +1,301 @@
#! /usr/bin/env node
'use strict';
const fs = require('fs');
const path = require('path');
const args = process.argv.slice(2);
const dir = args[0];
if (!dir) {
console.log('Usage: node ' + path.basename(__filename) + ' <target-dir>');
process.exit(1);
}
const NodeApiVersion = require('../package.json').version;
const disable = args[1];
let ConfigFileOperations;
if (disable !== '--disable' && dir !== '--disable') {
ConfigFileOperations = {
'package.json': [
[/([ ]*)"dependencies": {/g, '$1"dependencies": {\n$1 "node-addon-api": "' + NodeApiVersion + '",'],
[/[ ]*"nan": *"[^"]+"(,|)[\n\r]/g, '']
],
'binding.gyp': [
[/([ ]*)'include_dirs': \[/g, '$1\'include_dirs\': [\n$1 \'<!(node -p "require(\\\'node-addon-api\\\').include_dir")\','],
[/([ ]*)"include_dirs": \[/g, '$1"include_dirs": [\n$1 "<!(node -p \\"require(\'node-addon-api\').include_dir\\")",'],
[/[ ]*("|')<!\(node -e ("|'|\\"|\\')require\(("|'|\\"|\\')nan("|'|\\"|\\')\)("|'|\\"|\\')\)("|')(,|)[\r\n]/g, ''],
[/([ ]*)("|')target_name("|'): ("|')(.+?)("|'),/g, '$1$2target_name$2: $4$5$6,\n $2cflags!$2: [ $2-fno-exceptions$2 ],\n $2cflags_cc!$2: [ $2-fno-exceptions$2 ],\n $2xcode_settings$2: { $2GCC_ENABLE_CPP_EXCEPTIONS$2: $2YES$2,\n $2CLANG_CXX_LIBRARY$2: $2libc++$2,\n $2MACOSX_DEPLOYMENT_TARGET$2: $210.7$2,\n },\n $2msvs_settings$2: {\n $2VCCLCompilerTool$2: { $2ExceptionHandling$2: 1 },\n },']
]
};
} else {
ConfigFileOperations = {
'package.json': [
[/([ ]*)"dependencies": {/g, '$1"dependencies": {\n$1 "node-addon-api": "' + NodeApiVersion + '",'],
[/[ ]*"nan": *"[^"]+"(,|)[\n\r]/g, '']
],
'binding.gyp': [
[/([ ]*)'include_dirs': \[/g, '$1\'include_dirs\': [\n$1 \'<!(node -p "require(\\\'node-addon-api\\\').include_dir")\','],
[/([ ]*)"include_dirs": \[/g, '$1"include_dirs": [\n$1 "<!(node -p \'require(\\"node-addon-api\\").include_dir\')",'],
[/[ ]*("|')<!\(node -e ("|'|\\"|\\')require\(("|'|\\"|\\')nan("|'|\\"|\\')\)("|'|\\"|\\')\)("|')(,|)[\r\n]/g, ''],
[/([ ]*)("|')target_name("|'): ("|')(.+?)("|'),/g, '$1$2target_name$2: $4$5$6,\n $2cflags!$2: [ $2-fno-exceptions$2 ],\n $2cflags_cc!$2: [ $2-fno-exceptions$2 ],\n $2defines$2: [ $2NAPI_DISABLE_CPP_EXCEPTIONS$2 ],\n $2conditions$2: [\n [\'OS=="win"\', { $2defines$2: [ $2_HAS_EXCEPTIONS=1$2 ] }]\n ]']
]
};
}
const SourceFileOperations = [
[/Nan::SetMethod\(target,[\s]*"(.*)"[\s]*,[\s]*([^)]+)\)/g, 'exports.Set(Napi::String::New(env, "$1"), Napi::Function::New(env, $2))'],
[/v8::Local<v8::FunctionTemplate>\s+(\w+)\s*=\s*Nan::New<FunctionTemplate>\([\w\d:]+\);(?:\w+->Reset\(\1\))?\s+\1->SetClassName\(Nan::String::New\("(\w+)"\)\);/g, 'Napi::Function $1 = DefineClass(env, "$2", {'],
[/Local<FunctionTemplate>\s+(\w+)\s*=\s*Nan::New<FunctionTemplate>\([\w\d:]+\);\s+(\w+)\.Reset\((\1)\);\s+\1->SetClassName\((Nan::String::New|Nan::New<(v8::)*String>)\("(.+?)"\)\);/g, 'Napi::Function $1 = DefineClass(env, "$6", {'],
[/Local<FunctionTemplate>\s+(\w+)\s*=\s*Nan::New<FunctionTemplate>\([\w\d:]+\);(?:\w+->Reset\(\1\))?\s+\1->SetClassName\(Nan::String::New\("(\w+)"\)\);/g, 'Napi::Function $1 = DefineClass(env, "$2", {'],
[/Nan::New<v8::FunctionTemplate>\(([\w\d:]+)\)->GetFunction\(\)/g, 'Napi::Function::New(env, $1)'],
[/Nan::New<FunctionTemplate>\(([\w\d:]+)\)->GetFunction()/g, 'Napi::Function::New(env, $1);'],
[/Nan::New<v8::FunctionTemplate>\(([\w\d:]+)\)/g, 'Napi::Function::New(env, $1)'],
[/Nan::New<FunctionTemplate>\(([\w\d:]+)\)/g, 'Napi::Function::New(env, $1)'],
// FunctionTemplate to FunctionReference
[/Nan::Persistent<(v8::)*FunctionTemplate>/g, 'Napi::FunctionReference'],
[/Nan::Persistent<(v8::)*Function>/g, 'Napi::FunctionReference'],
[/v8::Local<v8::FunctionTemplate>/g, 'Napi::FunctionReference'],
[/Local<FunctionTemplate>/g, 'Napi::FunctionReference'],
[/v8::FunctionTemplate/g, 'Napi::FunctionReference'],
[/FunctionTemplate/g, 'Napi::FunctionReference'],
[/([ ]*)Nan::SetPrototypeMethod\(\w+, "(\w+)", (\w+)\);/g, '$1InstanceMethod("$2", &$3),'],
[/([ ]*)(?:\w+\.Reset\(\w+\);\s+)?\(target\)\.Set\("(\w+)",\s*Nan::GetFunction\((\w+)\)\);/gm,
'});\n\n' +
'$1constructor = Napi::Persistent($3);\n' +
'$1constructor.SuppressDestruct();\n' +
'$1target.Set("$2", $3);'],
// TODO: Other attribute combinations
[/static_cast<PropertyAttribute>\(ReadOnly\s*\|\s*DontDelete\)/gm,
'static_cast<napi_property_attributes>(napi_enumerable | napi_configurable)'],
[/([\w\d:<>]+?)::Cast\((.+?)\)/g, '$2.As<$1>()'],
[/\*Nan::Utf8String\(([^)]+)\)/g, '$1->As<Napi::String>().Utf8Value().c_str()'],
[/Nan::Utf8String +(\w+)\(([^)]+)\)/g, 'std::string $1 = $2.As<Napi::String>()'],
[/Nan::Utf8String/g, 'std::string'],
[/v8::String::Utf8Value (.+?)\((.+?)\)/g, 'Napi::String $1(env, $2)'],
[/String::Utf8Value (.+?)\((.+?)\)/g, 'Napi::String $1(env, $2)'],
[/\.length\(\)/g, '.Length()'],
[/Nan::MakeCallback\(([^,]+),[\s\\]+([^,]+),/gm, '$2.MakeCallback($1,'],
[/class\s+(\w+)\s*:\s*public\s+Nan::ObjectWrap/g, 'class $1 : public Napi::ObjectWrap<$1>'],
[/(\w+)\(([^)]*)\)\s*:\s*Nan::ObjectWrap\(\)\s*(,)?/gm, '$1($2) : Napi::ObjectWrap<$1>()$3'],
// HandleOKCallback to OnOK
[/HandleOKCallback/g, 'OnOK'],
// HandleErrorCallback to OnError
[/HandleErrorCallback/g, 'OnError'],
// ex. .As<Function>() to .As<Napi::Object>()
[/\.As<v8::(Value|Boolean|String|Number|Object|Array|Symbol|External|Function)>\(\)/g, '.As<Napi::$1>()'],
[/\.As<(Value|Boolean|String|Number|Object|Array|Symbol|External|Function)>\(\)/g, '.As<Napi::$1>()'],
// ex. Nan::New<Number>(info[0]) to Napi::Number::New(info[0])
[/Nan::New<(v8::)*Integer>\((.+?)\)/g, 'Napi::Number::New(env, $2)'],
[/Nan::New\(([0-9.]+)\)/g, 'Napi::Number::New(env, $1)'],
[/Nan::New<(v8::)*String>\("(.+?)"\)/g, 'Napi::String::New(env, "$2")'],
[/Nan::New\("(.+?)"\)/g, 'Napi::String::New(env, "$1")'],
[/Nan::New<(v8::)*(.+?)>\(\)/g, 'Napi::$2::New(env)'],
[/Nan::New<(.+?)>\(\)/g, 'Napi::$1::New(env)'],
[/Nan::New<(v8::)*(.+?)>\(/g, 'Napi::$2::New(env, '],
[/Nan::New<(.+?)>\(/g, 'Napi::$1::New(env, '],
[/Nan::NewBuffer\(/g, 'Napi::Buffer<char>::New(env, '],
// TODO: Properly handle this
[/Nan::New\(/g, 'Napi::New(env, '],
[/\.IsInt32\(\)/g, '.IsNumber()'],
[/->IsInt32\(\)/g, '.IsNumber()'],
[/(.+?)->BooleanValue\(\)/g, '$1.As<Napi::Boolean>().Value()'],
[/(.+?)->Int32Value\(\)/g, '$1.As<Napi::Number>().Int32Value()'],
[/(.+?)->Uint32Value\(\)/g, '$1.As<Napi::Number>().Uint32Value()'],
[/(.+?)->IntegerValue\(\)/g, '$1.As<Napi::Number>().Int64Value()'],
[/(.+?)->NumberValue\(\)/g, '$1.As<Napi::Number>().DoubleValue()'],
// ex. Nan::To<bool>(info[0]) to info[0].Value()
[/Nan::To<v8::(Boolean|String|Number|Object|Array|Symbol|Function)>\((.+?)\)/g, '$2.To<Napi::$1>()'],
[/Nan::To<(Boolean|String|Number|Object|Array|Symbol|Function)>\((.+?)\)/g, '$2.To<Napi::$1>()'],
// ex. Nan::To<bool>(info[0]) to info[0].As<Napi::Boolean>().Value()
[/Nan::To<bool>\((.+?)\)/g, '$1.As<Napi::Boolean>().Value()'],
// ex. Nan::To<int>(info[0]) to info[0].As<Napi::Number>().Int32Value()
[/Nan::To<int>\((.+?)\)/g, '$1.As<Napi::Number>().Int32Value()'],
// ex. Nan::To<int32_t>(info[0]) to info[0].As<Napi::Number>().Int32Value()
[/Nan::To<int32_t>\((.+?)\)/g, '$1.As<Napi::Number>().Int32Value()'],
// ex. Nan::To<uint32_t>(info[0]) to info[0].As<Napi::Number>().Uint32Value()
[/Nan::To<uint32_t>\((.+?)\)/g, '$1.As<Napi::Number>().Uint32Value()'],
// ex. Nan::To<int64_t>(info[0]) to info[0].As<Napi::Number>().Int64Value()
[/Nan::To<int64_t>\((.+?)\)/g, '$1.As<Napi::Number>().Int64Value()'],
// ex. Nan::To<float>(info[0]) to info[0].As<Napi::Number>().FloatValue()
[/Nan::To<float>\((.+?)\)/g, '$1.As<Napi::Number>().FloatValue()'],
// ex. Nan::To<double>(info[0]) to info[0].As<Napi::Number>().DoubleValue()
[/Nan::To<double>\((.+?)\)/g, '$1.As<Napi::Number>().DoubleValue()'],
[/Nan::New\((\w+)\)->HasInstance\((\w+)\)/g, '$2.InstanceOf($1.Value())'],
[/Nan::Has\(([^,]+),\s*/gm, '($1).Has('],
[/\.Has\([\s|\\]*Nan::New<(v8::)*String>\(([^)]+)\)\)/gm, '.Has($1)'],
[/\.Has\([\s|\\]*Nan::New\(([^)]+)\)\)/gm, '.Has($1)'],
[/Nan::Get\(([^,]+),\s*/gm, '($1).Get('],
[/\.Get\([\s|\\]*Nan::New<(v8::)*String>\(([^)]+)\)\)/gm, '.Get($1)'],
[/\.Get\([\s|\\]*Nan::New\(([^)]+)\)\)/gm, '.Get($1)'],
[/Nan::Set\(([^,]+),\s*/gm, '($1).Set('],
[/\.Set\([\s|\\]*Nan::New<(v8::)*String>\(([^)]+)\)\s*,/gm, '.Set($1,'],
[/\.Set\([\s|\\]*Nan::New\(([^)]+)\)\s*,/gm, '.Set($1,'],
// ex. node::Buffer::HasInstance(info[0]) to info[0].IsBuffer()
[/node::Buffer::HasInstance\((.+?)\)/g, '$1.IsBuffer()'],
// ex. node::Buffer::Length(info[0]) to info[0].Length()
[/node::Buffer::Length\((.+?)\)/g, '$1.As<Napi::Buffer<char>>().Length()'],
// ex. node::Buffer::Data(info[0]) to info[0].Data()
[/node::Buffer::Data\((.+?)\)/g, '$1.As<Napi::Buffer<char>>().Data()'],
[/Nan::CopyBuffer\(/g, 'Napi::Buffer::Copy(env, '],
// Nan::AsyncQueueWorker(worker)
[/Nan::AsyncQueueWorker\((.+)\);/g, '$1.Queue();'],
[/Nan::(Undefined|Null|True|False)\(\)/g, 'env.$1()'],
// Nan::ThrowError(error) to Napi::Error::New(env, error).ThrowAsJavaScriptException()
[/([ ]*)return Nan::Throw(\w*?)Error\((.+?)\);/g, '$1Napi::$2Error::New(env, $3).ThrowAsJavaScriptException();\n$1return env.Null();'],
[/Nan::Throw(\w*?)Error\((.+?)\);\n(\s*)return;/g, 'Napi::$1Error::New(env, $2).ThrowAsJavaScriptException();\n$3return env.Null();'],
[/Nan::Throw(\w*?)Error\((.+?)\);/g, 'Napi::$1Error::New(env, $2).ThrowAsJavaScriptException();\n'],
// Nan::RangeError(error) to Napi::RangeError::New(env, error)
[/Nan::(\w*?)Error\((.+)\)/g, 'Napi::$1Error::New(env, $2)'],
[/Nan::Set\((.+?),\n* *(.+?),\n* *(.+?),\n* *(.+?)\)/g, '$1.Set($2, $3, $4)'],
[/Nan::(Escapable)?HandleScope\s+(\w+)\s*;/g, 'Napi::$1HandleScope $2(env);'],
[/Nan::(Escapable)?HandleScope/g, 'Napi::$1HandleScope'],
[/Nan::ForceSet\(([^,]+), ?/g, '$1->DefineProperty('],
[/\.ForceSet\(Napi::String::New\(env, "(\w+)"\),\s*?/g, '.DefineProperty("$1", '],
// [ /Nan::GetPropertyNames\(([^,]+)\)/, '$1->GetPropertyNames()' ],
[/Nan::Equals\(([^,]+),/g, '$1.StrictEquals('],
[/(.+)->Set\(/g, '$1.Set('],
[/Nan::Callback/g, 'Napi::FunctionReference'],
[/Nan::Persistent<Object>/g, 'Napi::ObjectReference'],
[/Nan::ADDON_REGISTER_FUNCTION_ARGS_TYPE target/g, 'Napi::Env& env, Napi::Object& target'],
[/(\w+)\*\s+(\w+)\s*=\s*Nan::ObjectWrap::Unwrap<\w+>\(info\.This\(\)\);/g, '$1* $2 = this;'],
[/Nan::ObjectWrap::Unwrap<(\w+)>\((.*)\);/g, '$2.Unwrap<$1>();'],
[/Nan::NAN_METHOD_RETURN_TYPE/g, 'void'],
[/NAN_INLINE/g, 'inline'],
[/Nan::NAN_METHOD_ARGS_TYPE/g, 'const Napi::CallbackInfo&'],
[/NAN_METHOD\(([\w\d:]+?)\)/g, 'Napi::Value $1(const Napi::CallbackInfo& info)'],
[/static\s*NAN_GETTER\(([\w\d:]+?)\)/g, 'Napi::Value $1(const Napi::CallbackInfo& info)'],
[/NAN_GETTER\(([\w\d:]+?)\)/g, 'Napi::Value $1(const Napi::CallbackInfo& info)'],
[/static\s*NAN_SETTER\(([\w\d:]+?)\)/g, 'void $1(const Napi::CallbackInfo& info, const Napi::Value& value)'],
[/NAN_SETTER\(([\w\d:]+?)\)/g, 'void $1(const Napi::CallbackInfo& info, const Napi::Value& value)'],
[/void Init\((v8::)*Local<(v8::)*Object> exports\)/g, 'Napi::Object Init(Napi::Env env, Napi::Object exports)'],
[/NAN_MODULE_INIT\(([\w\d:]+?)\);/g, 'Napi::Object $1(Napi::Env env, Napi::Object exports);'],
[/NAN_MODULE_INIT\(([\w\d:]+?)\)/g, 'Napi::Object $1(Napi::Env env, Napi::Object exports)'],
[/::(Init(?:ialize)?)\(target\)/g, '::$1(env, target, module)'],
[/constructor_template/g, 'constructor'],
[/Nan::FunctionCallbackInfo<(v8::)?Value>[ ]*& [ ]*info\)[ ]*{\n*([ ]*)/gm, 'Napi::CallbackInfo& info) {\n$2Napi::Env env = info.Env();\n$2'],
[/Nan::FunctionCallbackInfo<(v8::)*Value>\s*&\s*info\);/g, 'Napi::CallbackInfo& info);'],
[/Nan::FunctionCallbackInfo<(v8::)*Value>\s*&/g, 'Napi::CallbackInfo&'],
[/Buffer::HasInstance\(([^)]+)\)/g, '$1.IsBuffer()'],
[/info\[(\d+)\]->/g, 'info[$1].'],
[/info\[([\w\d]+)\]->/g, 'info[$1].'],
[/info\.This\(\)->/g, 'info.This().'],
[/->Is(Object|String|Int32|Number)\(\)/g, '.Is$1()'],
[/info.GetReturnValue\(\).SetUndefined\(\)/g, 'return env.Undefined()'],
[/info\.GetReturnValue\(\)\.Set\(((\n|.)+?)\);/g, 'return $1;'],
// ex. Local<Value> to Napi::Value
[/v8::Local<v8::(Value|Boolean|String|Number|Object|Array|Symbol|External|Function)>/g, 'Napi::$1'],
[/Local<(Value|Boolean|String|Number|Object|Array|Symbol|External|Function)>/g, 'Napi::$1'],
// Declare an env in helper functions that take a Napi::Value
[/(\w+)\(Napi::Value (\w+)(,\s*[^()]+)?\)\s*{\n*([ ]*)/gm, '$1(Napi::Value $2$3) {\n$4Napi::Env env = $2.Env();\n$4'],
// delete #include <node.h> and/or <v8.h>
[/#include +(<|")(?:node|nan).h("|>)/g, '#include $1napi.h$2\n#include $1uv.h$2'],
// NODE_MODULE to NODE_API_MODULE
[/NODE_MODULE/g, 'NODE_API_MODULE'],
[/Nan::/g, 'Napi::'],
[/nan.h/g, 'napi.h'],
// delete .FromJust()
[/\.FromJust\(\)/g, ''],
// delete .ToLocalCheck()
[/\.ToLocalChecked\(\)/g, ''],
[/^.*->SetInternalFieldCount\(.*$/gm, ''],
// replace using node; and/or using v8; to using Napi;
[/using (node|v8);/g, 'using Napi;'],
[/using namespace (node|Nan|v8);/g, 'using namespace Napi;'],
// delete using v8::Local;
[/using v8::Local;\n/g, ''],
// replace using v8::XXX; with using Napi::XXX
[/using v8::([A-Za-z]+);/g, 'using Napi::$1;']
];
const paths = listFiles(dir);
paths.forEach(function (dirEntry) {
const filename = dirEntry.split('\\').pop().split('/').pop();
// Check whether the file is a source file or a config file
// then execute function accordingly
const sourcePattern = /.+\.h|.+\.cc|.+\.cpp/;
if (sourcePattern.test(filename)) {
convertFile(dirEntry, SourceFileOperations);
} else if (ConfigFileOperations[filename] != null) {
convertFile(dirEntry, ConfigFileOperations[filename]);
}
});
function listFiles (dir, filelist) {
const files = fs.readdirSync(dir);
filelist = filelist || [];
files.forEach(function (file) {
if (file === 'node_modules') {
return;
}
if (fs.statSync(path.join(dir, file)).isDirectory()) {
filelist = listFiles(path.join(dir, file), filelist);
} else {
filelist.push(path.join(dir, file));
}
});
return filelist;
}
function convert (content, operations) {
for (let i = 0; i < operations.length; i++) {
const operation = operations[i];
content = content.replace(operation[0], operation[1]);
}
return content;
}
function convertFile (fileName, operations) {
fs.readFile(fileName, 'utf-8', function (err, file) {
if (err) throw err;
file = convert(file, operations);
fs.writeFile(fileName, file, function (err) {
if (err) throw err;
});
});
}
+79
View File
@@ -0,0 +1,79 @@
#!/usr/bin/env node
const spawn = require('child_process').spawnSync;
const filesToCheck = '*.js';
const FORMAT_START = process.env.FORMAT_START || 'main';
const IS_WIN = process.platform === 'win32';
const ESLINT_PATH = IS_WIN ? 'node_modules\\.bin\\eslint.cmd' : 'node_modules/.bin/eslint';
function main (args) {
let fix = false;
while (args.length > 0) {
switch (args[0]) {
case '-f':
case '--fix':
fix = true;
break;
default:
}
args.shift();
}
// Check js files that change on unstaged file
const fileUnStaged = spawn(
'git',
['diff', '--name-only', '--diff-filter=d', FORMAT_START, filesToCheck],
{
encoding: 'utf-8'
}
);
// Check js files that change on staged file
const fileStaged = spawn(
'git',
['diff', '--name-only', '--cached', '--diff-filter=d', FORMAT_START, filesToCheck],
{
encoding: 'utf-8'
}
);
const options = [
...fileStaged.stdout.split('\n').filter((f) => f !== ''),
...fileUnStaged.stdout.split('\n').filter((f) => f !== '')
];
if (fix) {
options.push('--fix');
}
const result = spawn(ESLINT_PATH, [...options], {
encoding: 'utf-8'
});
if (result.error && result.error.errno === 'ENOENT') {
console.error('Eslint not found! Eslint is supposed to be found at ', ESLINT_PATH);
return 2;
}
if (result.status === 1) {
console.error('Eslint error:', result.stdout);
const fixCmd = 'npm run lint:fix';
console.error(`ERROR: please run "${fixCmd}" to format changes in your commit
Note that when running the command locally, please keep your local
main branch and working branch up to date with nodejs/node-addon-api
to exclude un-related complains.
Or you can run "env FORMAT_START=upstream/main ${fixCmd}".
Also fix JS files by yourself if necessary.`);
return 1;
}
if (result.stderr) {
console.error('Error running eslint:', result.stderr);
return 2;
}
}
if (require.main === module) {
process.exitCode = main(process.argv.slice(2));
}