You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

145 lines
4.6 KiB

n-api: add support for abi stable module API Add support for abi stable module API (N-API) as "Experimental feature". The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag "--napi-modules". Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in "src/node_api.h" and "src/node_api_types.h". This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra <arunesh.chandra@microsoft.com> Author: Gabriel Schulhof <gabriel.schulhof@intel.com> Author: Hitesh Kanwathirtha <hiteshk@microsoft.com> Author: Ian Halliday <ianhall@microsoft.com> Author: Jason Ginchereau <jasongin@microsoft.com> Author: Michael Dawson <michael_dawson@ca.ibm.com> Author: Sampson Gao <sampsong@ca.ibm.com> Author: Taylor Woll <taylor.woll@microsoft.com> PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
8 years ago
#include <stdlib.h>
#include <string.h>
#include <node_api.h>
#include "../common.h"
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
static const char theText[] =
"Lorem ipsum dolor sit amet, consectetur adipiscing elit.";
static int deleterCallCount = 0;
static void deleteTheText(napi_env env, void* data, void* finalize_hint) {
NAPI_ASSERT_RETURN_VOID(env, data != NULL && strcmp(data, theText) == 0, "invalid data");
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
(void)finalize_hint;
free(data);
deleterCallCount++;
}
static void noopDeleter(napi_env env, void* data, void* finalize_hint) {
NAPI_ASSERT_RETURN_VOID(env, data != NULL && strcmp(data, theText) == 0, "invalid data");
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
(void)finalize_hint;
deleterCallCount++;
}
napi_value newBuffer(napi_env env, napi_callback_info info) {
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
napi_value theBuffer;
char* theCopy;
const unsigned int kBufferSize = sizeof(theText);
NAPI_CALL(env,
napi_create_buffer(
env,
sizeof(theText),
(void**)(&theCopy),
&theBuffer));
NAPI_ASSERT(env, theCopy, "Failed to copy static text for newBuffer");
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
memcpy(theCopy, theText, kBufferSize);
return theBuffer;
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
}
napi_value newExternalBuffer(napi_env env, napi_callback_info info) {
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
napi_value theBuffer;
char* theCopy = strdup(theText);
NAPI_ASSERT(env, theCopy, "Failed to copy static text for newExternalBuffer");
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
NAPI_CALL(env,
napi_create_external_buffer(
env,
sizeof(theText),
theCopy,
deleteTheText,
NULL, // finalize_hint
&theBuffer));
return theBuffer;
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
}
napi_value getDeleterCallCount(napi_env env, napi_callback_info info) {
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
napi_value callCount;
NAPI_CALL(env, napi_create_number(env, deleterCallCount, &callCount));
return callCount;
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
}
napi_value copyBuffer(napi_env env, napi_callback_info info) {
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
napi_value theBuffer;
NAPI_CALL(env, napi_create_buffer_copy(
env, sizeof(theText), theText, NULL, &theBuffer));
return theBuffer;
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
}
napi_value bufferHasInstance(napi_env env, napi_callback_info info) {
size_t argc = 1;
napi_value args[1];
NAPI_CALL(env, napi_get_cb_info(env, info, &argc, args, NULL, NULL));
NAPI_ASSERT(env, argc == 1, "Wrong number of arguments");
napi_value theBuffer = args[0];
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
bool hasInstance;
napi_valuetype theType;
NAPI_CALL(env, napi_typeof(env, theBuffer, &theType));
NAPI_ASSERT(env,
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
theType == napi_object,
"bufferHasInstance: instance is not an object");
NAPI_CALL(env, napi_is_buffer(env, theBuffer, &hasInstance));
NAPI_ASSERT(env, hasInstance, "bufferHasInstance: instance is not a buffer");
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
napi_value returnValue;
NAPI_CALL(env, napi_get_boolean(env, hasInstance, &returnValue));
return returnValue;
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
}
napi_value bufferInfo(napi_env env, napi_callback_info info) {
size_t argc = 1;
napi_value args[1];
NAPI_CALL(env, napi_get_cb_info(env, info, &argc, args, NULL, NULL));
NAPI_ASSERT(env, argc == 1, "Wrong number of arguments");
napi_value theBuffer = args[0];
char *bufferData;
napi_value returnValue;
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
size_t bufferLength;
NAPI_CALL(env,
napi_get_buffer_info(
env,
theBuffer,
(void**)(&bufferData),
&bufferLength));
NAPI_CALL(env, napi_get_boolean(env,
!strcmp(bufferData, theText) && bufferLength == sizeof(theText),
&returnValue));
return returnValue;
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
}
napi_value staticBuffer(napi_env env, napi_callback_info info) {
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
napi_value theBuffer;
NAPI_CALL(
env,
napi_create_external_buffer(env,
sizeof(theText),
(void*)theText,
noopDeleter,
NULL, // finalize_hint
&theBuffer));
return theBuffer;
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
}
void Init(napi_env env, napi_value exports, napi_value module, void* priv) {
napi_value theValue;
NAPI_CALL_RETURN_VOID(env,
napi_create_string_utf8(env, theText, sizeof(theText), &theValue));
NAPI_CALL_RETURN_VOID(env,
napi_set_named_property(env, exports, "theText", theValue));
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
napi_property_descriptor methods[] = {
DECLARE_NAPI_PROPERTY("newBuffer", newBuffer),
DECLARE_NAPI_PROPERTY("newExternalBuffer", newExternalBuffer),
DECLARE_NAPI_PROPERTY("getDeleterCallCount", getDeleterCallCount),
DECLARE_NAPI_PROPERTY("copyBuffer", copyBuffer),
DECLARE_NAPI_PROPERTY("bufferHasInstance", bufferHasInstance),
DECLARE_NAPI_PROPERTY("bufferInfo", bufferInfo),
DECLARE_NAPI_PROPERTY("staticBuffer", staticBuffer),
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
};
NAPI_CALL_RETURN_VOID(env, napi_define_properties(
env, exports, sizeof(methods) / sizeof(methods[0]), methods));
n-api: add support for abi stable module API Add support for abi stable module API (N-API) as &#34;Experimental feature&#34;. The goal of this API is to provide a stable Node API for native module developers. N-API aims to provide ABI compatibility guarantees across different Node versions and also across different Node VMs - allowing N-API enabled native modules to just work across different versions and flavors of Node.js without recompilation. A more detailed introduction is provided in: https://github.com/nodejs/node-eps/blob/master/005-ABI-Stable-Module-API.md and https://github.com/nodejs/abi-stable-node/blob/doc/VM%20Summit.pdf. The feature, during its experimental state, will be guarded by a runtime flag &#34;--napi-modules&#34;. Only when this flag is added to the command line will N-API modules along with regular non N-API modules be supported. The API is defined by the methods in &#34;src/node_api.h&#34; and &#34;src/node_api_types.h&#34;. This is the best starting point to review the API surface. More documentation will follow. In addition to the implementation of the API using V8, which is included in this PR, the API has also been validated against chakracore and that port is available in https://github.com/nodejs/abi-stable-node/tree/api-prototype-chakracore-8.x. The current plan is to provide N-API support in versions 8.X and 6.X directly. For older versions, such as 4.X or pre N-API versions of 6.X, we plan to create an external npm module to provide a migration path that will allow modules targeting older Node.js versions to use the API, albeit without getting the advantage of not having to recompile. In addition, we also plan an external npm package with C++ sugar to simplify the use of the API. The sugar will be in-line only and will only use the exported N-API methods but is not part of the N-API itself. The current version is in: https://github.com/nodejs/node-api. This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the api-prototype-8.x branch with the following contributors in alphabetical order: Author: Arunesh Chandra &lt;arunesh.chandra@microsoft.com&gt; Author: Gabriel Schulhof &lt;gabriel.schulhof@intel.com&gt; Author: Hitesh Kanwathirtha &lt;hiteshk@microsoft.com&gt; Author: Ian Halliday &lt;ianhall@microsoft.com&gt; Author: Jason Ginchereau &lt;jasongin@microsoft.com&gt; Author: Michael Dawson &lt;michael_dawson@ca.ibm.com&gt; Author: Sampson Gao &lt;sampsong@ca.ibm.com&gt; Author: Taylor Woll &lt;taylor.woll@microsoft.com&gt; PR-URL: https://github.com/nodejs/node/pull/11975 Reviewed-By: Anna Henningsen &lt;anna@addaleax.net&gt; Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt;
8 years ago
}
NAPI_MODULE(addon, Init)