Live texturing
This commit is contained in:
maqu14
@@ -0,0 +1,135 @@
|
||||
/*
|
||||
* Copyright (c) 2013 Adobe Systems Incorporated. All rights reserved.
|
||||
*
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
|
||||
(function () {
|
||||
"use strict";
|
||||
var start = 0;
|
||||
var zmq = require('zmq');
|
||||
var publisher = zmq.socket('pub');
|
||||
|
||||
publisher.bind('tcp://*:5555', function (err) {
|
||||
if (err) {
|
||||
console.log(err);
|
||||
}
|
||||
else {
|
||||
console.log("5555");
|
||||
}
|
||||
});
|
||||
|
||||
|
||||
|
||||
process.on('SIGINT', function () {
|
||||
publisher.close();
|
||||
});
|
||||
|
||||
|
||||
var PLUGIN_ID = require("./package.json").name,
|
||||
MENU_ID = "TeamFisk plugins",
|
||||
MENU_LABEL = "$$$/JavaScripts/Generator/TeamFisk plugins/Menu=Live Texturing RAMDisk";
|
||||
|
||||
var _generator = null;
|
||||
|
||||
// Initialize script here
|
||||
function init(generator, config) {
|
||||
_generator = generator;
|
||||
_generator.addMenuItem(MENU_ID, MENU_LABEL, true, false)
|
||||
.then(
|
||||
function () {
|
||||
console.log("Menu created", MENU_ID);
|
||||
}, function () {
|
||||
console.error("Menu creation failed", MENU_ID);
|
||||
}
|
||||
);
|
||||
|
||||
_generator.onPhotoshopEvent("imageChanged", handleImageChanged);
|
||||
}
|
||||
|
||||
var lastSent = 0;
|
||||
var isSaving = false;
|
||||
function handleImageChanged(document) {
|
||||
|
||||
var start = new Date().getTime();
|
||||
if (start - lastSent > 350 && !isSaving) {
|
||||
isSaving = true;
|
||||
//console.log("DOC: " + document.id);
|
||||
_generator.getDocumentInfo(document.id).then(
|
||||
function (document) {
|
||||
// console.log(new Date().getTime() / 1000);
|
||||
// console.log(stringify(document.timeStamp));
|
||||
//console.log("HELLO 1");
|
||||
//lastSent = document.timeStamp
|
||||
// console.log(stringify(document));
|
||||
//console.log("Received complete document:", stringify(document));
|
||||
//var str = 'var options = new PNGSaveOptions(); app.activeDocument.saveAs (new File("D:/HejHej.png"),options, false);';
|
||||
var str = 'app.activeDocument.save()';
|
||||
|
||||
_generator.evaluateJSXString(str).then(function () {
|
||||
isSaving = false;
|
||||
//console.log("Save succes");
|
||||
var size = (4 + document.file.length + 1);
|
||||
var message = new Buffer(size);
|
||||
|
||||
var offset = 0;
|
||||
|
||||
//console.log("document.file.length: " + document.file.length);
|
||||
//console.log("document.fileName: " + document.file);
|
||||
|
||||
message.writeInt32LE(document.file.length + 1, offset);
|
||||
|
||||
offset += 4;
|
||||
|
||||
var fileName = document.file.replace(/\\/g, "/");
|
||||
message.write(fileName, offset, fileName.length, 'utf8');
|
||||
offset += fileName.length;
|
||||
message.writeUInt8(0, offset); //Null byte
|
||||
offset += 1;
|
||||
|
||||
publisher.send(message);
|
||||
|
||||
var asd = new Date().getTime();
|
||||
var time = asd - start;
|
||||
//console.log(time);
|
||||
lastSent = new Date().getTime();
|
||||
//console.log("LastSent: " + lastSent);
|
||||
|
||||
},
|
||||
function () {
|
||||
console.log("Save Failure");
|
||||
isSaving = false;
|
||||
}).done();
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
function stringify(object) {
|
||||
try {
|
||||
return JSON.stringify(object, null, " ");
|
||||
} catch (e) {
|
||||
console.error(e);
|
||||
}
|
||||
return String(object);
|
||||
}
|
||||
|
||||
//Declare entery function in the script
|
||||
exports.init = init;
|
||||
}());
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
root = true
|
||||
|
||||
[*]
|
||||
end_of_line = lf
|
||||
charset = utf-8
|
||||
trim_trailing_whitespace = true
|
||||
|
||||
[*.js]
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
|
||||
[*.cc]
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
*.swp
|
||||
*.swo
|
||||
*.o
|
||||
build
|
||||
*.lock*
|
||||
binding.node
|
||||
examples/stress-test-client
|
||||
node_modules
|
||||
Makefile.gyp
|
||||
binding.Makefile
|
||||
binding.target.gyp.mk
|
||||
gyp-mac-tool
|
||||
out/
|
||||
+37
@@ -0,0 +1,37 @@
|
||||
addons:
|
||||
apt:
|
||||
sources:
|
||||
- ubuntu-toolchain-r-test
|
||||
packages:
|
||||
- g++-4.8
|
||||
env:
|
||||
- ZMQ="git://github.com/zeromq/zeromq2-x.git"
|
||||
- ZMQ="git://github.com/zeromq/zeromq3-x.git -b v3.1.0"
|
||||
- ZMQ="git://github.com/zeromq/zeromq3-x.git -b v3.2.5"
|
||||
- ZMQ="git://github.com/zeromq/zeromq4-x.git -b v4.0.5" SODIUM="git://github.com/jedisct1/libsodium.git -b 0.4.5"
|
||||
before_install:
|
||||
- export CXX=g++-4.8
|
||||
- sudo apt-get install uuid-dev
|
||||
- '[ -z "$SODIUM" ] || git clone --depth 1 $SODIUM libsodium'
|
||||
- '[ -z "$SODIUM" ] || cd libsodium'
|
||||
- '[ -z "$SODIUM" ] || ./autogen.sh'
|
||||
- '[ -z "$SODIUM" ] || ./configure'
|
||||
- '[ -z "$SODIUM" ] || make'
|
||||
- '[ -z "$SODIUM" ] || sudo make install'
|
||||
- '[ -z "$SODIUM" ] || cd ..'
|
||||
- git clone --depth 1 $ZMQ zmqlib
|
||||
- cd zmqlib
|
||||
- ./autogen.sh
|
||||
- ./configure
|
||||
- make
|
||||
- sudo make install
|
||||
- sudo /sbin/ldconfig
|
||||
- cd ..
|
||||
language: node_js
|
||||
node_js:
|
||||
- "0.8"
|
||||
- "0.10"
|
||||
- "0.12"
|
||||
- "4"
|
||||
- "5"
|
||||
script: travis_retry npm test
|
||||
+154
@@ -0,0 +1,154 @@
|
||||
2.14.0 / 2015-11-20
|
||||
===================
|
||||
|
||||
* A socket.read() method was added to retrieve messages while paused [sshutovskyi]
|
||||
* socket.send() now takes a callback as 3rd argument which is called once the message is sent [ronkorving]
|
||||
* Now tested on Node.js 0.8, 0.10, 0.12, 4 and 5 [ronkorving]
|
||||
|
||||
2.13.0 / 2015-08-26
|
||||
===================
|
||||
|
||||
* io.js 3.x compatible [kkoopa]
|
||||
* corrections to type casting operations [kkoopa]
|
||||
* "make clean" now also removes node_modules [reqshark]
|
||||
|
||||
2.12.0 / 2015-07-10
|
||||
===================
|
||||
|
||||
* Massive improvements to monitoring code, with new documentation and tests [ValYouW]
|
||||
* Improved documentation [reqshark]
|
||||
* Updated bindings from ~1.1.1 to ~1.2.1 [reqshark]
|
||||
* Test suite improvements [reqshark]
|
||||
* Updated the Windows bundle to ZeroMQ 4.0.4 [kkoopa]
|
||||
* License attribute added to package.json [pdehaan]
|
||||
|
||||
2.11.1 / 2015-05-21
|
||||
===================
|
||||
|
||||
* io.js 2.x compatible [transcranial]
|
||||
* replaced asserts with proper exceptions [reqshark]
|
||||
|
||||
2.11.0 / 2015-03-31
|
||||
===================
|
||||
|
||||
* Added pause() and resume() APIs on sockets to allow backpressure [philip1986]
|
||||
* Elegant handling of EINTR return codes [hurricaneLTG]
|
||||
* Small performance improvements in send() and internal flush methods [ronkorving]
|
||||
* Updated test suite to cover io.js and Node 0.12 (removed 0.11) [ronkorving]
|
||||
* Added "make perf" for easy benchmarking [ronkorving]
|
||||
|
||||
2.10.0 / 2015-01-22
|
||||
===================
|
||||
|
||||
* Added ZMQ_STREAM socket type [reqshark]
|
||||
* Update NAN to io.js compatible 1.5.0 [kkoopa]
|
||||
* Hitting open file descriptor limit now throws an error during zmq.socket() [briansorahan]
|
||||
* More reliable benchmarking [maxired]
|
||||
|
||||
2.9.0 / 2015-01-05
|
||||
==================
|
||||
|
||||
* More unit tests [bluebery and reqshark]
|
||||
* More reliable testing [f34rdotcom and kkoopa]
|
||||
* Improved ReadMe [dminkovsky and skibz]
|
||||
* Support for zmq_proxy sockets [reqshark]
|
||||
* Removed "docs" and related deps in favor of ReadMe [reqshark]
|
||||
|
||||
2.8.0 / 2014-08-27
|
||||
==================
|
||||
|
||||
* Fixed: monitor API would keep CPU busy at 100% [f34rdotcom]
|
||||
* Fixed: an exception during flush could render a socket unusable [ronkorving]
|
||||
* Fixed: Travis changed behavior and broke our tests [ronkorving]
|
||||
* Code cleanup [kkoopa and ronkorving]
|
||||
* Removed legacy nextTick event emission during flush [utvara and ronkorving]
|
||||
* Context API added: setMaxThreads, getMaxThreads, setMaxSockets, getMaxSockets [yoneal]
|
||||
* Changed unit test suite to Mocha [skeggse and yoneal]
|
||||
* NAN updated to ~1.3.0 [kkoopa]
|
||||
|
||||
2.7.0 / 2014-04-24
|
||||
==================
|
||||
|
||||
* Fixed memory leak when closing socket [rasky]
|
||||
* Fixed high water mark [soplwang, kkoopa]
|
||||
* Added socket opts for zeromq 4.x security mechanisms [msealand]
|
||||
* Use MakeCallback [kkoopa]
|
||||
* Remove useless setImmediate [kkoopa]
|
||||
* Use `zmq_msg_send` for ZMQ >= 4.0 [kkoopa]
|
||||
* Expose the Socket class as zmq.Socket [tcr]
|
||||
|
||||
2.6.0 / 2014-01-23
|
||||
==================
|
||||
|
||||
* Monitor support [f34rdotcom, dr-fozzy]
|
||||
* Unbind support [kkoopa]
|
||||
* Node 0.11.9 compatibility [kkoopa]
|
||||
* Support for ZMQ 4 [atrniv]
|
||||
* Fixed memory leak [utvara]
|
||||
* OSX Homebrew support [jwalton]
|
||||
* Fix unit tests [ryanlelek]
|
||||
|
||||
2.5.1 / 2013-08-28
|
||||
==================
|
||||
|
||||
* Regression fix for IPC socket bind failure [christopherobin]
|
||||
|
||||
2.5.0 / 2013-08-20
|
||||
==================
|
||||
|
||||
* Added testing against Node.js v0.11 [AlexeyKupershtokh]
|
||||
* Add support for Joyent SmartMachines [JonGretar]
|
||||
* Use pkg-config on OS X too [blalor]
|
||||
* Patch for Node 0.11.3 [kkoopa]
|
||||
* Fix for bind / connect / send problem [kkoopa]
|
||||
* Fixed multiple bugs in perf tests and changed them to push/pull [ronkorving]
|
||||
* Add definitions for building on openbsd & freebsd [Minjung]
|
||||
|
||||
2.4.0 / 2013-04-09
|
||||
==================
|
||||
|
||||
* added: Windows support [mscdex]
|
||||
* added: support for all options ever [AlexeyKupershtokh]
|
||||
* fixed: prevent zeromq sockets from being destroyed by GC [AlexeyKupershtokh]
|
||||
|
||||
2.3.0 / 2013-03-15
|
||||
==================
|
||||
|
||||
* added: xpub/xsub socket types [xla]
|
||||
* added: support for zmq_disconnect [matehat]
|
||||
* added: LAST_ENDPOINT socket option [ronkorving]
|
||||
* added: local/remote_lat local/remote_thr perf test [wavded]
|
||||
* fixed: tests improved [qubyte, jeremybarnes, ronkorving]
|
||||
* fixed: Node v0.9.4+ compatibility [mscdex]
|
||||
* fixed: SNDHWM and RCVHWM options were given the wrong type [freehaha]
|
||||
* removed: waf support [mscdex]
|
||||
|
||||
2.2.0 / 2012-10-17
|
||||
==================
|
||||
|
||||
* add support for pkg-config
|
||||
* add libzmq 3.x support [aaudis]
|
||||
* fix: prevent GC happening too soon for connect/bindSync
|
||||
|
||||
2.1.0 / 2012-06-29
|
||||
==================
|
||||
|
||||
* fix require() for 0.8.0
|
||||
* change: use uv_poll in place of IOWatcher
|
||||
* remove stupid engines field
|
||||
|
||||
2.0.3 / 2012-03-14
|
||||
==================
|
||||
|
||||
* Removed -Wall (libuv unused vars caused the build to fail...)
|
||||
|
||||
2.0.2 / 2012-02-16
|
||||
==================
|
||||
|
||||
* Added back `.createSocket()` for BC. Closes #86
|
||||
|
||||
2.0.1 / 2012-01-26
|
||||
==================
|
||||
|
||||
* Added `.zmqVersion` [patricklucas]
|
||||
* Fixed multipart support [joshrtay]
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
Copyright (c) 2011 TJ Holowaychuk
|
||||
Copyright (c) 2010, 2011 Justin Tulloss
|
||||
|
||||
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.
|
||||
+18
@@ -0,0 +1,18 @@
|
||||
|
||||
build/Release/binding.node: binding.cc binding.gyp
|
||||
npm install
|
||||
|
||||
test:
|
||||
npm test
|
||||
|
||||
clean:
|
||||
rm -fr build node_modules
|
||||
|
||||
distclean:
|
||||
node-gyp clean
|
||||
|
||||
perf:
|
||||
node perf/local_lat.js tcp://127.0.0.1:5555 1 100000& node perf/remote_lat.js tcp://127.0.0.1:5555 1 100000
|
||||
node perf/local_thr.js tcp://127.0.0.1:5556 1 100000& node perf/remote_thr.js tcp://127.0.0.1:5556 1 100000
|
||||
|
||||
.PHONY: test clean distclean perf
|
||||
+224
@@ -0,0 +1,224 @@
|
||||
# zmq [](https://travis-ci.org/JustinTulloss/zeromq.node) [](https://ci.appveyor.com/project/reqshark/zeromq-node)
|
||||
|
||||
[ØMQ](http://www.zeromq.org/) bindings for node.js.
|
||||
|
||||
## Installation
|
||||
|
||||
### on Windows:
|
||||
First install [Visual Studio](https://www.visualstudio.com/) and either
|
||||
[Node.js](https://nodejs.org/download/) or [io.js](https://iojs.org/dist/latest/).
|
||||
|
||||
Ensure you're building zmq from a conservative location on disk, one without
|
||||
unusual characters or spaces, for example somewhere like: `C:\sources\myproject`.
|
||||
|
||||
Installing the ZeroMQ library is optional and not required on Windows. We
|
||||
recommend running `npm install` and node executable commands from a
|
||||
[github for windows](https://windows.github.com/) shell or similar environment.
|
||||
|
||||
### installing on Unix/POSIX (and osx):
|
||||
|
||||
First install `pkg-config` and the [ZeroMQ library](http://www.zeromq.org/intro:get-the-software).
|
||||
|
||||
This module is compatible with ZeroMQ versions 2, 3 and 4. The installation
|
||||
process varies by platform, but headers are mandatory. Most Linux distributions
|
||||
provide these headers with `-devel` packages like `zeromq-devel` or
|
||||
`zeromq3-devel`. Homebrew for OS X provides versions 4 and 3 with packages
|
||||
`zeromq` and `zeromq3`, respectively. A
|
||||
[Chris Lea PPA](https://launchpad.net/~chris-lea/+archive/ubuntu/zeromq)
|
||||
is available for Debian-like users who want a version newer than currently
|
||||
provided by their distribution. Windows is supported but not actively
|
||||
maintained.
|
||||
|
||||
Note: For zap support with versions >=4 you need to have libzmq built and linked
|
||||
against libsodium. Check the [Travis configuration](.travis.yml) for a list of what is tested
|
||||
and therefore known to work.
|
||||
|
||||
#### with your platform-specifics taken care of, install and use this module:
|
||||
|
||||
$ npm install zmq
|
||||
|
||||
## Examples
|
||||
|
||||
### Push/Pull
|
||||
|
||||
```js
|
||||
// producer.js
|
||||
var zmq = require('zmq')
|
||||
, sock = zmq.socket('push');
|
||||
|
||||
sock.bindSync('tcp://127.0.0.1:3000');
|
||||
console.log('Producer bound to port 3000');
|
||||
|
||||
setInterval(function(){
|
||||
console.log('sending work');
|
||||
sock.send('some work');
|
||||
}, 500);
|
||||
```
|
||||
|
||||
```js
|
||||
// worker.js
|
||||
var zmq = require('zmq')
|
||||
, sock = zmq.socket('pull');
|
||||
|
||||
sock.connect('tcp://127.0.0.1:3000');
|
||||
console.log('Worker connected to port 3000');
|
||||
|
||||
sock.on('message', function(msg){
|
||||
console.log('work: %s', msg.toString());
|
||||
});
|
||||
```
|
||||
|
||||
### Pub/Sub
|
||||
|
||||
```js
|
||||
// pubber.js
|
||||
var zmq = require('zmq')
|
||||
, sock = zmq.socket('pub');
|
||||
|
||||
sock.bindSync('tcp://127.0.0.1:3000');
|
||||
console.log('Publisher bound to port 3000');
|
||||
|
||||
setInterval(function(){
|
||||
console.log('sending a multipart message envelope');
|
||||
sock.send(['kitty cats', 'meow!']);
|
||||
}, 500);
|
||||
```
|
||||
|
||||
```js
|
||||
// subber.js
|
||||
var zmq = require('zmq')
|
||||
, sock = zmq.socket('sub');
|
||||
|
||||
sock.connect('tcp://127.0.0.1:3000');
|
||||
sock.subscribe('kitty cats');
|
||||
console.log('Subscriber connected to port 3000');
|
||||
|
||||
sock.on('message', function(topic, message) {
|
||||
console.log('received a message related to:', topic, 'containing message:', message);
|
||||
});
|
||||
```
|
||||
## Monitoring
|
||||
|
||||
You can get socket state changes events by calling to the `monitor` function.
|
||||
The supported events are (see ZMQ [docs](http://api.zeromq.org/4-2:zmq-socket-monitor) for full description):
|
||||
* connect - ZMQ_EVENT_CONNECTED
|
||||
* connect_delay - ZMQ_EVENT_CONNECT_DELAYED
|
||||
* connect_retry - ZMQ_EVENT_CONNECT_RETRIED
|
||||
* listen - ZMQ_EVENT_LISTENING
|
||||
* bind_error - ZMQ_EVENT_BIND_FAILED
|
||||
* accept - ZMQ_EVENT_ACCEPTED
|
||||
* accept_error - ZMQ_EVENT_ACCEPT_FAILED
|
||||
* close - ZMQ_EVENT_CLOSED
|
||||
* close_error - ZMQ_EVENT_CLOSE_FAILED
|
||||
* disconnect - ZMQ_EVENT_DISCONNECTED
|
||||
|
||||
All events get 2 arguments:
|
||||
* fd - The file descriptor of the underlying socket (if available)
|
||||
* endpoint - The underlying socket endpoint
|
||||
|
||||
A special `monitor_error` event will be raised when there was an error in the monitoring process, after this event no more
|
||||
monitoring events will be sent, you can try and call `monitor` again to restart the monitoring process.
|
||||
|
||||
### monitor(interval, numOfEvents)
|
||||
Will create an inproc PAIR socket where zmq will publish socket state changes events, the events from this socket will
|
||||
be read every `interval` (defaults to 10ms).
|
||||
By default only 1 message will be read every interval, this can be configured by using the `numOfEvents` parameter,
|
||||
where passing 0 will read all available messages per interval.
|
||||
|
||||
### unmonitor()
|
||||
Stop the monitoring process
|
||||
|
||||
### example
|
||||
|
||||
```js
|
||||
// Create a socket
|
||||
var zmq = require('zmq');
|
||||
socket = zmq.socket('req');
|
||||
|
||||
// Register to monitoring events
|
||||
socket.on('connect', function(fd, ep) {console.log('connect, endpoint:', ep);});
|
||||
socket.on('connect_delay', function(fd, ep) {console.log('connect_delay, endpoint:', ep);});
|
||||
socket.on('connect_retry', function(fd, ep) {console.log('connect_retry, endpoint:', ep);});
|
||||
socket.on('listen', function(fd, ep) {console.log('listen, endpoint:', ep);});
|
||||
socket.on('bind_error', function(fd, ep) {console.log('bind_error, endpoint:', ep);});
|
||||
socket.on('accept', function(fd, ep) {console.log('accept, endpoint:', ep);});
|
||||
socket.on('accept_error', function(fd, ep) {console.log('accept_error, endpoint:', ep);});
|
||||
socket.on('close', function(fd, ep) {console.log('close, endpoint:', ep);});
|
||||
socket.on('close_error', function(fd, ep) {console.log('close_error, endpoint:', ep);});
|
||||
socket.on('disconnect', function(fd, ep) {console.log('disconnect, endpoint:', ep);});
|
||||
|
||||
// Handle monitor error
|
||||
socket.on('monitor_error', function(err) {
|
||||
console.log('Error in monitoring: %s, will restart monitoring in 5 seconds', err);
|
||||
setTimeout(function() { socket.monitor(500, 0); }, 5000);
|
||||
});
|
||||
|
||||
// Call monitor, check for events every 500ms and get all available events.
|
||||
console.log('Start monitoring...');
|
||||
socket.monitor(500, 0);
|
||||
socket.connect('tcp://127.0.0.1:1234');
|
||||
|
||||
setTimeout(function() {
|
||||
console.log('Stop the monitoring...');
|
||||
socket.unmonitor();
|
||||
}, 20000);
|
||||
|
||||
```
|
||||
|
||||
## Running tests
|
||||
|
||||
#### Install dev deps:
|
||||
```sh
|
||||
$ git clone https://github.com/JustinTulloss/zeromq.node.git zmq && cd zmq
|
||||
$ npm i
|
||||
```
|
||||
#### Build:
|
||||
```sh
|
||||
# on unix:
|
||||
$ make
|
||||
|
||||
# building on windows:
|
||||
> npm i
|
||||
```
|
||||
#### Test:
|
||||
```sh
|
||||
# on unix:
|
||||
$ make test
|
||||
|
||||
# testing on windows:
|
||||
> npm t
|
||||
```
|
||||
## Running benchmarks
|
||||
|
||||
Benchmarks are available in the `perf` directory, and have been implemented
|
||||
according to the zmq documentation:
|
||||
[How to run performance tests](http://www.zeromq.org/results:perf-howto)
|
||||
|
||||
In the following examples, the arguments are respectively:
|
||||
- the host to connect to/bind on
|
||||
- message size (in bytes)
|
||||
- message count
|
||||
|
||||
You can run a latency benchmark by running these two commands in two separate
|
||||
shells:
|
||||
|
||||
```sh
|
||||
node ./local_lat.js tcp://127.0.0.1:5555 1 100000
|
||||
```
|
||||
|
||||
```sh
|
||||
node ./remote_lat.js tcp://127.0.0.1:5555 1 100000
|
||||
```
|
||||
|
||||
And you can run throughput tests by running these two commands in two
|
||||
separate shells:
|
||||
|
||||
```sh
|
||||
node ./local_thr.js tcp://127.0.0.1:5555 1 100000
|
||||
```
|
||||
|
||||
```sh
|
||||
node ./remote_thr.js tcp://127.0.0.1:5555 1 100000
|
||||
```
|
||||
|
||||
Running `make perf` will run the commands listed above.
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
environment:
|
||||
matrix:
|
||||
- nodejs_version: "0.10"
|
||||
- nodejs_version: "0.12"
|
||||
- nodejs_version: "2"
|
||||
|
||||
#platform:
|
||||
# - x86
|
||||
# - x64
|
||||
|
||||
install:
|
||||
- ps: Install-Product node $env:nodejs_version #$env:platform
|
||||
- npm install
|
||||
|
||||
test_script:
|
||||
- node --version
|
||||
- npm --version
|
||||
- npm test
|
||||
|
||||
build: off
|
||||
|
||||
matrix:
|
||||
allow_failures:
|
||||
- nodejs_version: "2"
|
||||
+1393
File diff suppressed because it is too large
Load Diff
+76
@@ -0,0 +1,76 @@
|
||||
{
|
||||
'targets': [
|
||||
{
|
||||
'target_name': 'zmq',
|
||||
'sources': [ 'binding.cc' ],
|
||||
'include_dirs' : [
|
||||
"<!(node -e \"require('nan')\")"
|
||||
],
|
||||
'conditions': [
|
||||
['OS=="win"', {
|
||||
'win_delay_load_hook': 'true',
|
||||
'include_dirs': ['windows/include'],
|
||||
'link_settings': {
|
||||
'libraries': [
|
||||
'Delayimp.lib',
|
||||
],
|
||||
'conditions': [
|
||||
['target_arch=="ia32"', {
|
||||
'libraries': [
|
||||
'<(PRODUCT_DIR)/../../windows/lib/x86/libzmq-v100-mt-4_0_4.lib',
|
||||
]
|
||||
},{
|
||||
'libraries': [
|
||||
'<(PRODUCT_DIR)/../../windows/lib/x64/libzmq-v100-mt-4_0_4.lib',
|
||||
]
|
||||
}]
|
||||
],
|
||||
},
|
||||
'msvs_settings': {
|
||||
'VCLinkerTool': {
|
||||
'DelayLoadDLLs': ['libzmq-v100-mt-4_0_4.dll']
|
||||
}
|
||||
},
|
||||
}, {
|
||||
'libraries': ['-lzmq'],
|
||||
'cflags!': ['-fno-exceptions'],
|
||||
'cflags_cc!': ['-fno-exceptions'],
|
||||
}],
|
||||
['OS=="mac" or OS=="solaris"', {
|
||||
'xcode_settings': {
|
||||
'GCC_ENABLE_CPP_EXCEPTIONS': 'YES'
|
||||
},
|
||||
# add macports include & lib dirs, homebrew include & lib dirs
|
||||
'include_dirs': [
|
||||
'<!@(pkg-config libzmq --cflags-only-I | sed s/-I//g)',
|
||||
'/opt/local/include',
|
||||
'/usr/local/include',
|
||||
],
|
||||
'libraries': [
|
||||
'<!@(pkg-config libzmq --libs)',
|
||||
'-L/opt/local/lib',
|
||||
'-L/usr/local/lib',
|
||||
]
|
||||
}],
|
||||
['OS=="openbsd" or OS=="freebsd"', {
|
||||
'include_dirs': [
|
||||
'<!@(pkg-config libzmq --cflags-only-I | sed s/-I//g)',
|
||||
'/usr/local/include',
|
||||
],
|
||||
'libraries': [
|
||||
'<!@(pkg-config libzmq --libs)',
|
||||
'-L/usr/local/lib',
|
||||
]
|
||||
}],
|
||||
['OS=="linux"', {
|
||||
'cflags': [
|
||||
'<!(pkg-config libzmq --cflags 2>/dev/null || echo "")',
|
||||
],
|
||||
'libraries': [
|
||||
'<!(pkg-config libzmq --libs 2>/dev/null || echo "")',
|
||||
],
|
||||
}],
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
+54
@@ -0,0 +1,54 @@
|
||||
/*
|
||||
*
|
||||
* One client two servers (round roobin)
|
||||
*
|
||||
*/
|
||||
|
||||
var cluster = require('cluster')
|
||||
, zmq = require('../')
|
||||
, port = 'tcp://127.0.0.1:12345';
|
||||
|
||||
if (cluster.isMaster) {
|
||||
for (var i = 0; i < 2; i++) cluster.fork();
|
||||
|
||||
cluster.on('death', function(worker) {
|
||||
console.log('worker ' + worker.pid + ' died');
|
||||
});
|
||||
|
||||
//dealer = client
|
||||
|
||||
var socket = zmq.socket('dealer');
|
||||
|
||||
socket.identity = 'client' + process.pid;
|
||||
|
||||
socket.bind(port, function(err) {
|
||||
if (err) throw err;
|
||||
console.log('bound!');
|
||||
|
||||
setInterval(function() {
|
||||
var value = Math.floor(Math.random()*100);
|
||||
|
||||
console.log(socket.identity + ': asking ' + value);
|
||||
socket.send(value);
|
||||
}, 100);
|
||||
|
||||
|
||||
socket.on('message', function(data) {
|
||||
console.log(socket.identity + ': answer data ' + data);
|
||||
});
|
||||
});
|
||||
} else {
|
||||
//router = server
|
||||
|
||||
var socket = zmq.socket('router');
|
||||
|
||||
socket.identity = 'server' + process.pid;
|
||||
|
||||
socket.connect(port);
|
||||
console.log('connected!');
|
||||
|
||||
socket.on('message', function(envelope, data) {
|
||||
console.log(socket.identity + ': received ' + envelope + ' - ' + data.toString());
|
||||
socket.send([envelope, data * 2]);
|
||||
});
|
||||
}
|
||||
+69
@@ -0,0 +1,69 @@
|
||||
/*
|
||||
*
|
||||
* Forwarder device
|
||||
*
|
||||
*/
|
||||
|
||||
var zmq = require('../../')
|
||||
, frontPort = 'tcp://127.0.0.1:12345'
|
||||
, backPort = 'tcp://127.0.0.1:12346';
|
||||
|
||||
function createClient (port) {
|
||||
var socket = zmq.socket('pub');
|
||||
|
||||
socket.identity = 'client' + process.pid;
|
||||
|
||||
socket.connect(port);
|
||||
console.log('client connected!');
|
||||
|
||||
setInterval(function() {
|
||||
var value = Math.floor(Math.random()*100);
|
||||
|
||||
console.log(socket.identity + ': broadcasting ' + value);
|
||||
socket.send(value);
|
||||
}, 100);
|
||||
};
|
||||
|
||||
function createWorker (port) {
|
||||
var socket = zmq.socket('sub');
|
||||
|
||||
socket.identity = 'worker' + process.pid;
|
||||
|
||||
socket.subscribe('');
|
||||
socket.on('message', function(data) {
|
||||
console.log(socket.identity + ': got ' + data.toString());
|
||||
});
|
||||
|
||||
socket.connect(port, function(err) {
|
||||
if (err) throw err;
|
||||
console.log('worker connected!');
|
||||
});
|
||||
};
|
||||
|
||||
function createForwarderDevice(frontPort, backPort) {
|
||||
var frontSocket = zmq.socket('sub'),
|
||||
backSocket = zmq.socket('pub');
|
||||
|
||||
frontSocket.identity = 'sub' + process.pid;
|
||||
backSocket.identity = 'pub' + process.pid;
|
||||
|
||||
frontSocket.subscribe('');
|
||||
frontSocket.bind(frontPort, function (err) {
|
||||
console.log('bound', frontPort);
|
||||
});
|
||||
|
||||
frontSocket.on('message', function() {
|
||||
//pass to back
|
||||
console.log('forwarder: recasting', arguments[0].toString());
|
||||
backSocket.send(Array.prototype.slice.call(arguments));
|
||||
});
|
||||
|
||||
backSocket.bind(backPort, function (err) {
|
||||
console.log('bound', backPort);
|
||||
});
|
||||
}
|
||||
|
||||
createForwarderDevice(frontPort, backPort);
|
||||
|
||||
createClient(frontPort);
|
||||
createWorker(backPort);
|
||||
+78
@@ -0,0 +1,78 @@
|
||||
/*
|
||||
*
|
||||
* Queue device
|
||||
*
|
||||
*/
|
||||
|
||||
var zmq = require('../../')
|
||||
, frontPort = 'tcp://127.0.0.1:12345'
|
||||
, backPort = 'tcp://127.0.0.1:12346';
|
||||
|
||||
function createClient (port) {
|
||||
var socket = zmq.socket('req');
|
||||
|
||||
socket.identity = 'client' + process.pid;
|
||||
|
||||
socket.on('message', function(data) {
|
||||
console.log(socket.identity + ': answer data ' + data);
|
||||
});
|
||||
|
||||
socket.connect(port);
|
||||
console.log('client connected!');
|
||||
|
||||
setInterval(function() {
|
||||
var value = Math.floor(Math.random()*100);
|
||||
|
||||
console.log(socket.identity + ': asking ' + value);
|
||||
socket.send(value);
|
||||
}, 100);
|
||||
};
|
||||
|
||||
function createServer (port) {
|
||||
var socket = zmq.socket('rep');
|
||||
|
||||
socket.identity = 'server' + process.pid;
|
||||
|
||||
socket.on('message', function(data) {
|
||||
console.log(socket.identity + ': received ' + data.toString());
|
||||
socket.send(data * 2);
|
||||
});
|
||||
|
||||
socket.connect(port, function(err) {
|
||||
if (err) throw err;
|
||||
console.log('server connected!');
|
||||
});
|
||||
};
|
||||
|
||||
function createQueueDevice(frontPort, backPort) {
|
||||
var frontSocket = zmq.socket('router'),
|
||||
backSocket = zmq.socket('dealer');
|
||||
|
||||
frontSocket.identity = 'router' + process.pid;
|
||||
backSocket.identity = 'dealer' + process.pid;
|
||||
|
||||
frontSocket.bind(frontPort, function (err) {
|
||||
console.log('bound', frontPort);
|
||||
});
|
||||
|
||||
frontSocket.on('message', function() {
|
||||
//pass to back
|
||||
console.log('router: sending to server', arguments[0].toString(), arguments[2].toString());
|
||||
backSocket.send(Array.prototype.slice.call(arguments));
|
||||
});
|
||||
|
||||
backSocket.bind(backPort, function (err) {
|
||||
console.log('bound', backPort);
|
||||
});
|
||||
|
||||
backSocket.on('message', function() {
|
||||
//pass to front
|
||||
console.log('dealer: sending to client', arguments[0].toString(), arguments[2].toString());
|
||||
frontSocket.send(Array.prototype.slice.call(arguments));
|
||||
});
|
||||
}
|
||||
|
||||
createQueueDevice(frontPort, backPort);
|
||||
|
||||
createClient(frontPort);
|
||||
createServer(backPort);
|
||||
+67
@@ -0,0 +1,67 @@
|
||||
/*
|
||||
*
|
||||
* Forwarder device
|
||||
*
|
||||
*/
|
||||
|
||||
var zmq = require('../../')
|
||||
, frontPort = 'tcp://127.0.0.1:12345'
|
||||
, backPort = 'tcp://127.0.0.1:12346';
|
||||
|
||||
function createClient (port) {
|
||||
var socket = zmq.socket('push');
|
||||
|
||||
socket.identity = 'client' + process.pid;
|
||||
|
||||
socket.connect(port);
|
||||
console.log('client connected!');
|
||||
|
||||
setInterval(function() {
|
||||
var value = Math.floor(Math.random()*100);
|
||||
|
||||
console.log(socket.identity + ': pushing ' + value);
|
||||
socket.send(value);
|
||||
}, 100);
|
||||
};
|
||||
|
||||
function createWorker (port) {
|
||||
var socket = zmq.socket('pull');
|
||||
|
||||
socket.identity = 'worker' + process.pid;
|
||||
|
||||
socket.on('message', function(data) {
|
||||
console.log(socket.identity + ': pulled ' + data.toString());
|
||||
});
|
||||
|
||||
socket.connect(port, function(err) {
|
||||
if (err) throw err;
|
||||
console.log('worker connected!');
|
||||
});
|
||||
};
|
||||
|
||||
function createStreamerDevice(frontPort, backPort) {
|
||||
var frontSocket = zmq.socket('pull'),
|
||||
backSocket = zmq.socket('push');
|
||||
|
||||
frontSocket.identity = 'sub' + process.pid;
|
||||
backSocket.identity = 'pub' + process.pid;
|
||||
|
||||
frontSocket.bind(frontPort, function (err) {
|
||||
console.log('bound', frontPort);
|
||||
});
|
||||
|
||||
frontSocket.on('message', function() {
|
||||
//pass to back
|
||||
console.log('forwarder: sending downstream', arguments[0].toString());
|
||||
backSocket.send(Array.prototype.slice.call(arguments));
|
||||
});
|
||||
|
||||
backSocket.bind(backPort, function (err) {
|
||||
console.log('bound', backPort);
|
||||
});
|
||||
}
|
||||
|
||||
createStreamerDevice(frontPort, backPort);
|
||||
|
||||
createClient(frontPort);
|
||||
createWorker(backPort);
|
||||
+55
@@ -0,0 +1,55 @@
|
||||
/*
|
||||
*
|
||||
* Publisher subscriber pattern
|
||||
*
|
||||
*/
|
||||
|
||||
var cluster = require('cluster')
|
||||
, zmq = require('../')
|
||||
, port = 'tcp://127.0.0.1:12345';
|
||||
|
||||
if (cluster.isMaster) {
|
||||
for (var i = 0; i < 2; i++) cluster.fork();
|
||||
|
||||
cluster.on('death', function(worker) {
|
||||
console.log('worker ' + worker.pid + ' died');
|
||||
});
|
||||
|
||||
//publisher = send only
|
||||
|
||||
var socket = zmq.socket('pub');
|
||||
|
||||
socket.identity = 'publisher' + process.pid;
|
||||
|
||||
var stocks = ['AAPL', 'GOOG', 'YHOO', 'MSFT', 'INTC'];
|
||||
|
||||
socket.bind(port, function(err) {
|
||||
if (err) throw err;
|
||||
console.log('bound!');
|
||||
|
||||
setInterval(function() {
|
||||
var symbol = stocks[Math.floor(Math.random()*stocks.length)]
|
||||
, value = Math.random()*1000;
|
||||
|
||||
console.log(socket.identity + ': sent ' + symbol + ' ' + value);
|
||||
socket.send(symbol + ' ' + value);
|
||||
}, 100);
|
||||
});
|
||||
} else {
|
||||
//subscriber = receive only
|
||||
|
||||
var socket = zmq.socket('sub');
|
||||
|
||||
socket.identity = 'subscriber' + process.pid;
|
||||
|
||||
socket.connect(port);
|
||||
|
||||
socket.subscribe('AAPL');
|
||||
socket.subscribe('GOOG');
|
||||
|
||||
console.log('connected!');
|
||||
|
||||
socket.on('message', function(data) {
|
||||
console.log(socket.identity + ': received data ' + data.toString());
|
||||
});
|
||||
}
|
||||
+48
@@ -0,0 +1,48 @@
|
||||
/*
|
||||
*
|
||||
* Pipeline
|
||||
*
|
||||
*/
|
||||
|
||||
var cluster = require('cluster')
|
||||
, zmq = require('../')
|
||||
, port = 'tcp://127.0.0.1:12345';
|
||||
|
||||
if (cluster.isMaster) {
|
||||
for (var i = 0; i < 2; i++) cluster.fork();
|
||||
|
||||
cluster.on('death', function(worker) {
|
||||
console.log('worker ' + worker.pid + ' died');
|
||||
});
|
||||
|
||||
//push = upstream
|
||||
|
||||
var socket = zmq.socket('push');
|
||||
|
||||
socket.identity = 'upstream' + process.pid;
|
||||
|
||||
socket.bind(port, function(err) {
|
||||
if (err) throw err;
|
||||
console.log('bound!');
|
||||
|
||||
setInterval(function() {
|
||||
var date = new Date();
|
||||
|
||||
console.log(socket.identity + ': sending data ' + date.toString());
|
||||
socket.send(date.toString());
|
||||
}, 500);
|
||||
});
|
||||
} else {
|
||||
//pull = downstream
|
||||
|
||||
var socket = zmq.socket('pull');
|
||||
|
||||
socket.identity = 'downstream' + process.pid;
|
||||
|
||||
socket.connect(port);
|
||||
console.log('connected!');
|
||||
|
||||
socket.on('message', function(data) {
|
||||
console.log(socket.identity + ': received data ' + data.toString());
|
||||
});
|
||||
}
|
||||
+53
@@ -0,0 +1,53 @@
|
||||
/*
|
||||
*
|
||||
* One responseder two requesters
|
||||
*
|
||||
*/
|
||||
|
||||
var cluster = require('cluster')
|
||||
, zmq = require('../')
|
||||
, port = 'tcp://127.0.0.1:12345';
|
||||
|
||||
if (cluster.isMaster) {
|
||||
for (var i = 0; i < 2; i++) cluster.fork();
|
||||
|
||||
cluster.on('death', function(worker) {
|
||||
console.log('worker ' + worker.pid + ' died');
|
||||
});
|
||||
|
||||
//responseder = server
|
||||
|
||||
var socket = zmq.socket('rep');
|
||||
|
||||
socket.identity = 'server' + process.pid;
|
||||
|
||||
socket.bind(port, function(err) {
|
||||
if (err) throw err;
|
||||
console.log('bound!');
|
||||
|
||||
socket.on('message', function(data) {
|
||||
console.log(socket.identity + ': received ' + data.toString());
|
||||
socket.send(2 * data);
|
||||
});
|
||||
});
|
||||
} else {
|
||||
//requester = client
|
||||
|
||||
var socket = zmq.socket('req');
|
||||
|
||||
socket.identity = 'client' + process.pid;
|
||||
|
||||
socket.connect(port);
|
||||
console.log('connected!');
|
||||
|
||||
setInterval(function() {
|
||||
var value = Math.floor(Math.random()*100);
|
||||
|
||||
socket.send(value);
|
||||
console.log(socket.identity + ': asking ' + value);
|
||||
}, 100);
|
||||
|
||||
socket.on('message', function(data) {
|
||||
console.log(socket.identity + ': answer data ' + data);
|
||||
});
|
||||
}
|
||||
+57
@@ -0,0 +1,57 @@
|
||||
/*
|
||||
*
|
||||
* One requester two responders (round robin)
|
||||
*
|
||||
*/
|
||||
|
||||
var cluster = require('cluster')
|
||||
, zeromq = require('../')
|
||||
, port = 'tcp://127.0.0.1:12345';
|
||||
|
||||
if (cluster.isMaster) {
|
||||
//Fork servers.
|
||||
for (var i = 0; i < 2; i++) {
|
||||
cluster.fork();
|
||||
}
|
||||
|
||||
cluster.on('death', function(worker) {
|
||||
console.log('worker ' + worker.pid + ' died');
|
||||
});
|
||||
|
||||
//requester = client
|
||||
|
||||
var socket = zeromq.socket('req');
|
||||
|
||||
socket.identity = 'client' + process.pid;
|
||||
|
||||
socket.bind(port, function(err) {
|
||||
if (err) throw err;
|
||||
console.log('bound!');
|
||||
|
||||
setInterval(function() {
|
||||
var value = Math.floor(Math.random()*100);
|
||||
|
||||
console.log(socket.identity + ': asking ' + value);
|
||||
socket.send(value);
|
||||
}, 100);
|
||||
|
||||
|
||||
socket.on('message', function(data) {
|
||||
console.log(socket.identity + ': answer data ' + data);
|
||||
});
|
||||
});
|
||||
} else {
|
||||
//responder = server
|
||||
|
||||
var socket = zeromq.socket('rep');
|
||||
|
||||
socket.identity = 'server' + process.pid;
|
||||
|
||||
socket.connect(port);
|
||||
console.log('connected!');
|
||||
|
||||
socket.on('message', function(data) {
|
||||
console.log(socket.identity + ': received ' + data.toString());
|
||||
socket.send(data * 2);
|
||||
});
|
||||
}
|
||||
+53
@@ -0,0 +1,53 @@
|
||||
/*
|
||||
*
|
||||
* One server two clients
|
||||
*
|
||||
*/
|
||||
|
||||
var cluster = require('cluster')
|
||||
, zeromq = require('../')
|
||||
, port = 'tcp://127.0.0.1:12345';
|
||||
|
||||
if (cluster.isMaster) {
|
||||
for (var i = 0; i < 2; i++) cluster.fork();
|
||||
|
||||
cluster.on('death', function(worker) {
|
||||
console.log('worker ' + worker.pid + ' died');
|
||||
});
|
||||
|
||||
//router = server
|
||||
|
||||
var socket = zeromq.socket('router');
|
||||
|
||||
socket.identity = 'server' + process.pid;
|
||||
|
||||
socket.bind(port, function(err) {
|
||||
if (err) throw err;
|
||||
console.log('bound!');
|
||||
|
||||
socket.on('message', function(envelope, data) {
|
||||
console.log(socket.identity + ': received ' + envelope + ' - ' + data.toString());
|
||||
socket.send([envelope, data * 2]);
|
||||
});
|
||||
});
|
||||
} else {
|
||||
//dealer = client
|
||||
|
||||
var socket = zeromq.socket('dealer');
|
||||
|
||||
socket.identity = 'client' + process.pid;
|
||||
|
||||
socket.connect(port);
|
||||
console.log('connected!');
|
||||
|
||||
setInterval(function() {
|
||||
var value = Math.floor(Math.random()*100);
|
||||
|
||||
socket.send(value);
|
||||
console.log(socket.identity + ': asking ' + value);
|
||||
}, 100);
|
||||
|
||||
socket.on('message', function(data) {
|
||||
console.log(socket.identity + ': answer data ' + data);
|
||||
});
|
||||
}
|
||||
+17
@@ -0,0 +1,17 @@
|
||||
|
||||
/**
|
||||
* One server two clients
|
||||
*/
|
||||
|
||||
var cluster = require('cluster')
|
||||
, zmq = require('../')
|
||||
, port = 'tcp://127.0.0.1:12345';
|
||||
|
||||
if (cluster.isMaster) {
|
||||
for (var i = 0; i < 2; i++) cluster.fork();
|
||||
|
||||
|
||||
} else {
|
||||
var sock = zmq.socket('dealer');
|
||||
sock.connect(port);
|
||||
}
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
|
||||
var zmq = require('../../')
|
||||
, sock = zmq.socket('push');
|
||||
|
||||
sock.bindSync('tcp://127.0.0.1:3000');
|
||||
console.log('Producer bound to port 3000');
|
||||
|
||||
setInterval(function(){
|
||||
console.log('sending work');
|
||||
sock.send('some work');
|
||||
}, 500);
|
||||
+10
@@ -0,0 +1,10 @@
|
||||
|
||||
var zmq = require('../../')
|
||||
, sock = zmq.socket('pull');
|
||||
|
||||
sock.connect('tcp://127.0.0.1:3000');
|
||||
console.log('Worker connected to port 3000');
|
||||
|
||||
sock.on('message', function(msg){
|
||||
console.log('work: %s', msg.toString());
|
||||
});
|
||||
+2
@@ -0,0 +1,2 @@
|
||||
|
||||
module.exports = require('./lib');
|
||||
+97
@@ -0,0 +1,97 @@
|
||||
node-bindings
|
||||
=============
|
||||
### Helper module for loading your native module's .node file
|
||||
|
||||
This is a helper module for authors of Node.js native addon modules.
|
||||
It is basically the "swiss army knife" of `require()`ing your native module's
|
||||
`.node` file.
|
||||
|
||||
Throughout the course of Node's native addon history, addons have ended up being
|
||||
compiled in a variety of different places, depending on which build tool and which
|
||||
version of node was used. To make matters worse, now the _gyp_ build tool can
|
||||
produce either a _Release_ or _Debug_ build, each being built into different
|
||||
locations.
|
||||
|
||||
This module checks _all_ the possible locations that a native addon would be built
|
||||
at, and returns the first one that loads successfully.
|
||||
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
Install with `npm`:
|
||||
|
||||
``` bash
|
||||
$ npm install bindings
|
||||
```
|
||||
|
||||
Or add it to the `"dependencies"` section of your _package.json_ file.
|
||||
|
||||
|
||||
Example
|
||||
-------
|
||||
|
||||
`require()`ing the proper bindings file for the current node version, platform
|
||||
and architecture is as simple as:
|
||||
|
||||
``` js
|
||||
var bindings = require('bindings')('binding.node')
|
||||
|
||||
// Use your bindings defined in your C files
|
||||
bindings.your_c_function()
|
||||
```
|
||||
|
||||
|
||||
Nice Error Output
|
||||
-----------------
|
||||
|
||||
When the `.node` file could not be loaded, `node-bindings` throws an Error with
|
||||
a nice error message telling you exactly what was tried. You can also check the
|
||||
`err.tries` Array property.
|
||||
|
||||
```
|
||||
Error: Could not load the bindings file. Tried:
|
||||
→ /Users/nrajlich/ref/build/binding.node
|
||||
→ /Users/nrajlich/ref/build/Debug/binding.node
|
||||
→ /Users/nrajlich/ref/build/Release/binding.node
|
||||
→ /Users/nrajlich/ref/out/Debug/binding.node
|
||||
→ /Users/nrajlich/ref/Debug/binding.node
|
||||
→ /Users/nrajlich/ref/out/Release/binding.node
|
||||
→ /Users/nrajlich/ref/Release/binding.node
|
||||
→ /Users/nrajlich/ref/build/default/binding.node
|
||||
→ /Users/nrajlich/ref/compiled/0.8.2/darwin/x64/binding.node
|
||||
at bindings (/Users/nrajlich/ref/node_modules/bindings/bindings.js:84:13)
|
||||
at Object.<anonymous> (/Users/nrajlich/ref/lib/ref.js:5:47)
|
||||
at Module._compile (module.js:449:26)
|
||||
at Object.Module._extensions..js (module.js:467:10)
|
||||
at Module.load (module.js:356:32)
|
||||
at Function.Module._load (module.js:312:12)
|
||||
...
|
||||
```
|
||||
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
(The MIT License)
|
||||
|
||||
Copyright (c) 2012 Nathan Rajlich <nathan@tootallnate.net>
|
||||
|
||||
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.
|
||||
+166
@@ -0,0 +1,166 @@
|
||||
|
||||
/**
|
||||
* Module dependencies.
|
||||
*/
|
||||
|
||||
var fs = require('fs')
|
||||
, path = require('path')
|
||||
, join = path.join
|
||||
, dirname = path.dirname
|
||||
, exists = fs.existsSync || path.existsSync
|
||||
, defaults = {
|
||||
arrow: process.env.NODE_BINDINGS_ARROW || ' → '
|
||||
, compiled: process.env.NODE_BINDINGS_COMPILED_DIR || 'compiled'
|
||||
, platform: process.platform
|
||||
, arch: process.arch
|
||||
, version: process.versions.node
|
||||
, bindings: 'bindings.node'
|
||||
, try: [
|
||||
// node-gyp's linked version in the "build" dir
|
||||
[ 'module_root', 'build', 'bindings' ]
|
||||
// node-waf and gyp_addon (a.k.a node-gyp)
|
||||
, [ 'module_root', 'build', 'Debug', 'bindings' ]
|
||||
, [ 'module_root', 'build', 'Release', 'bindings' ]
|
||||
// Debug files, for development (legacy behavior, remove for node v0.9)
|
||||
, [ 'module_root', 'out', 'Debug', 'bindings' ]
|
||||
, [ 'module_root', 'Debug', 'bindings' ]
|
||||
// Release files, but manually compiled (legacy behavior, remove for node v0.9)
|
||||
, [ 'module_root', 'out', 'Release', 'bindings' ]
|
||||
, [ 'module_root', 'Release', 'bindings' ]
|
||||
// Legacy from node-waf, node <= 0.4.x
|
||||
, [ 'module_root', 'build', 'default', 'bindings' ]
|
||||
// Production "Release" buildtype binary (meh...)
|
||||
, [ 'module_root', 'compiled', 'version', 'platform', 'arch', 'bindings' ]
|
||||
]
|
||||
}
|
||||
|
||||
/**
|
||||
* The main `bindings()` function loads the compiled bindings for a given module.
|
||||
* It uses V8's Error API to determine the parent filename that this function is
|
||||
* being invoked from, which is then used to find the root directory.
|
||||
*/
|
||||
|
||||
function bindings (opts) {
|
||||
|
||||
// Argument surgery
|
||||
if (typeof opts == 'string') {
|
||||
opts = { bindings: opts }
|
||||
} else if (!opts) {
|
||||
opts = {}
|
||||
}
|
||||
opts.__proto__ = defaults
|
||||
|
||||
// Get the module root
|
||||
if (!opts.module_root) {
|
||||
opts.module_root = exports.getRoot(exports.getFileName())
|
||||
}
|
||||
|
||||
// Ensure the given bindings name ends with .node
|
||||
if (path.extname(opts.bindings) != '.node') {
|
||||
opts.bindings += '.node'
|
||||
}
|
||||
|
||||
var tries = []
|
||||
, i = 0
|
||||
, l = opts.try.length
|
||||
, n
|
||||
, b
|
||||
, err
|
||||
|
||||
for (; i<l; i++) {
|
||||
n = join.apply(null, opts.try[i].map(function (p) {
|
||||
return opts[p] || p
|
||||
}))
|
||||
tries.push(n)
|
||||
try {
|
||||
b = opts.path ? require.resolve(n) : require(n)
|
||||
if (!opts.path) {
|
||||
b.path = n
|
||||
}
|
||||
return b
|
||||
} catch (e) {
|
||||
if (!/not find/i.test(e.message)) {
|
||||
throw e
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
err = new Error('Could not locate the bindings file. Tried:\n'
|
||||
+ tries.map(function (a) { return opts.arrow + a }).join('\n'))
|
||||
err.tries = tries
|
||||
throw err
|
||||
}
|
||||
module.exports = exports = bindings
|
||||
|
||||
|
||||
/**
|
||||
* Gets the filename of the JavaScript file that invokes this function.
|
||||
* Used to help find the root directory of a module.
|
||||
* Optionally accepts an filename argument to skip when searching for the invoking filename
|
||||
*/
|
||||
|
||||
exports.getFileName = function getFileName (calling_file) {
|
||||
var origPST = Error.prepareStackTrace
|
||||
, origSTL = Error.stackTraceLimit
|
||||
, dummy = {}
|
||||
, fileName
|
||||
|
||||
Error.stackTraceLimit = 10
|
||||
|
||||
Error.prepareStackTrace = function (e, st) {
|
||||
for (var i=0, l=st.length; i<l; i++) {
|
||||
fileName = st[i].getFileName()
|
||||
if (fileName !== __filename) {
|
||||
if (calling_file) {
|
||||
if (fileName !== calling_file) {
|
||||
return
|
||||
}
|
||||
} else {
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// run the 'prepareStackTrace' function above
|
||||
Error.captureStackTrace(dummy)
|
||||
dummy.stack
|
||||
|
||||
// cleanup
|
||||
Error.prepareStackTrace = origPST
|
||||
Error.stackTraceLimit = origSTL
|
||||
|
||||
return fileName
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the root directory of a module, given an arbitrary filename
|
||||
* somewhere in the module tree. The "root directory" is the directory
|
||||
* containing the `package.json` file.
|
||||
*
|
||||
* In: /home/nate/node-native-module/lib/index.js
|
||||
* Out: /home/nate/node-native-module
|
||||
*/
|
||||
|
||||
exports.getRoot = function getRoot (file) {
|
||||
var dir = dirname(file)
|
||||
, prev
|
||||
while (true) {
|
||||
if (dir === '.') {
|
||||
// Avoids an infinite loop in rare cases, like the REPL
|
||||
dir = process.cwd()
|
||||
}
|
||||
if (exists(join(dir, 'package.json')) || exists(join(dir, 'node_modules'))) {
|
||||
// Found the 'package.json' file or 'node_modules' dir; we're done
|
||||
return dir
|
||||
}
|
||||
if (prev === dir) {
|
||||
// Got to the top
|
||||
throw new Error('Could not find module root given file: "' + file
|
||||
+ '". Do you have a `package.json` file? ')
|
||||
}
|
||||
// Try the parent dir next
|
||||
prev = dir
|
||||
dir = join(dir, '..')
|
||||
}
|
||||
}
|
||||
+56
@@ -0,0 +1,56 @@
|
||||
{
|
||||
"name": "bindings",
|
||||
"description": "Helper module for loading your native module's .node file",
|
||||
"keywords": [
|
||||
"native",
|
||||
"addon",
|
||||
"bindings",
|
||||
"gyp",
|
||||
"waf",
|
||||
"c",
|
||||
"c++"
|
||||
],
|
||||
"version": "1.2.1",
|
||||
"author": {
|
||||
"name": "Nathan Rajlich",
|
||||
"email": "nathan@tootallnate.net",
|
||||
"url": "http://tootallnate.net"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git://github.com/TooTallNate/node-bindings.git"
|
||||
},
|
||||
"main": "./bindings.js",
|
||||
"bugs": {
|
||||
"url": "https://github.com/TooTallNate/node-bindings/issues"
|
||||
},
|
||||
"homepage": "https://github.com/TooTallNate/node-bindings",
|
||||
"license": "MIT",
|
||||
"gitHead": "e404152ee27f8478ccbc7122ee051246e8e5ec02",
|
||||
"_id": "bindings@1.2.1",
|
||||
"scripts": {},
|
||||
"_shasum": "14ad6113812d2d37d72e67b4cacb4bb726505f11",
|
||||
"_from": "bindings@>=1.2.1 <1.3.0",
|
||||
"_npmVersion": "1.4.14",
|
||||
"_npmUser": {
|
||||
"name": "tootallnate",
|
||||
"email": "nathan@tootallnate.net"
|
||||
},
|
||||
"maintainers": [
|
||||
{
|
||||
"name": "TooTallNate",
|
||||
"email": "nathan@tootallnate.net"
|
||||
},
|
||||
{
|
||||
"name": "tootallnate",
|
||||
"email": "nathan@tootallnate.net"
|
||||
}
|
||||
],
|
||||
"dist": {
|
||||
"shasum": "14ad6113812d2d37d72e67b4cacb4bb726505f11",
|
||||
"tarball": "http://registry.npmjs.org/bindings/-/bindings-1.2.1.tgz"
|
||||
},
|
||||
"directories": {},
|
||||
"_resolved": "https://registry.npmjs.org/bindings/-/bindings-1.2.1.tgz",
|
||||
"readme": "ERROR: No README data found!"
|
||||
}
|
||||
+30
@@ -0,0 +1,30 @@
|
||||
## DNT config file
|
||||
## see https://github.com/rvagg/dnt
|
||||
|
||||
NODE_VERSIONS="\
|
||||
master \
|
||||
v0.11.13 \
|
||||
v0.10.30 \
|
||||
v0.10.29 \
|
||||
v0.10.28 \
|
||||
v0.10.26 \
|
||||
v0.10.25 \
|
||||
v0.10.24 \
|
||||
v0.10.23 \
|
||||
v0.10.22 \
|
||||
v0.10.21 \
|
||||
v0.10.20 \
|
||||
v0.10.19 \
|
||||
v0.8.28 \
|
||||
v0.8.27 \
|
||||
v0.8.26 \
|
||||
v0.8.24 \
|
||||
"
|
||||
OUTPUT_PREFIX="nan-"
|
||||
TEST_CMD=" \
|
||||
cd /dnt/ && \
|
||||
npm install && \
|
||||
node_modules/.bin/node-gyp --nodedir /usr/src/node/ rebuild --directory test && \
|
||||
node_modules/.bin/tap --gc test/js/*-test.js \
|
||||
"
|
||||
|
||||
+374
@@ -0,0 +1,374 @@
|
||||
# NAN ChangeLog
|
||||
|
||||
**Version 2.0.9: current Node 4.0.0, Node 12: 0.12.7, Node 10: 0.10.40, iojs: 3.2.0**
|
||||
|
||||
### 2.0.9 Sep 8 2015
|
||||
|
||||
- Bugfix: EscapableHandleScope in Nan::NewBuffer for Node 0.8 and 0.10 b1654d7
|
||||
|
||||
### 2.0.8 Aug 28 2015
|
||||
|
||||
- Work around duplicate linking bug in clang 11902da
|
||||
|
||||
### 2.0.7 Aug 26 2015
|
||||
|
||||
- Build: Repackage
|
||||
|
||||
### 2.0.6 Aug 26 2015
|
||||
|
||||
- Bugfix: Properly handle null callback in FunctionTemplate factory 6e99cb1
|
||||
- Bugfix: Remove unused static std::map instances 525bddc
|
||||
- Bugfix: Make better use of maybe versions of APIs bfba85b
|
||||
- Bugfix: Fix shadowing issues with handle in ObjectWrap 0a9072d
|
||||
|
||||
### 2.0.5 Aug 10 2015
|
||||
|
||||
- Bugfix: Reimplement weak callback in ObjectWrap 98d38c1
|
||||
- Bugfix: Make sure callback classes are not assignable, copyable or movable 81f9b1d
|
||||
|
||||
### 2.0.4 Aug 6 2015
|
||||
|
||||
- Build: Repackage
|
||||
|
||||
### 2.0.3 Aug 6 2015
|
||||
|
||||
- Bugfix: Don't use clang++ / g++ syntax extension. 231450e
|
||||
|
||||
### 2.0.2 Aug 6 2015
|
||||
|
||||
- Build: Repackage
|
||||
|
||||
### 2.0.1 Aug 6 2015
|
||||
|
||||
- Bugfix: Add workaround for missing REPLACE_INVALID_UTF8 60d6687
|
||||
- Bugfix: Reimplement ObjectWrap from scratch to prevent memory leaks 6484601
|
||||
- Bugfix: Fix Persistent leak in FunctionCallbackInfo and PropertyCallbackInfo 641ef5f
|
||||
- Bugfix: Add missing overload for Nan::NewInstance that takes argc/argv 29450ed
|
||||
|
||||
### 2.0.0 Jul 31 2015
|
||||
|
||||
- Change: Renamed identifiers with leading underscores b5932b4
|
||||
- Change: Replaced NanObjectWrapHandle with class NanObjectWrap 464f1e1
|
||||
- Change: Replace NanScope and NanEscpableScope macros with classes 47751c4
|
||||
- Change: Rename NanNewBufferHandle to NanNewBuffer 6745f99
|
||||
- Change: Rename NanBufferUse to NanNewBuffer 3e8b0a5
|
||||
- Change: Rename NanNewBuffer to NanCopyBuffer d6af78d
|
||||
- Change: Remove Nan prefix from all names 72d1f67
|
||||
- Change: Update Buffer API for new upstream changes d5d3291
|
||||
- Change: Rename Scope and EscapableScope to HandleScope and EscapableHandleScope 21a7a6a
|
||||
- Change: Get rid of Handles e6c0daf
|
||||
- Feature: Support io.js 3 with V8 4.4
|
||||
- Feature: Introduce NanPersistent 7fed696
|
||||
- Feature: Introduce NanGlobal 4408da1
|
||||
- Feature: Added NanTryCatch 10f1ca4
|
||||
- Feature: Update for V8 v4.3 4b6404a
|
||||
- Feature: Introduce NanNewOneByteString c543d32
|
||||
- Feature: Introduce namespace Nan 67ed1b1
|
||||
- Removal: Remove NanLocker and NanUnlocker dd6e401
|
||||
- Removal: Remove string converters, except NanUtf8String, which now follows the node implementation b5d00a9
|
||||
- Removal: Remove NanReturn* macros d90a25c
|
||||
- Removal: Remove HasInstance e8f84fe
|
||||
|
||||
|
||||
### 1.9.0 Jul 31 2015
|
||||
|
||||
- Feature: Added `NanFatalException` 81d4a2c
|
||||
- Feature: Added more error types 4265f06
|
||||
- Feature: Added dereference and function call operators to NanCallback c4b2ed0
|
||||
- Feature: Added indexed GetFromPersistent and SaveToPersistent edd510c
|
||||
- Feature: Added more overloads of SaveToPersistent and GetFromPersistent 8b1cef6
|
||||
- Feature: Added NanErrnoException dd87d9e
|
||||
- Correctness: Prevent assign, copy, and move for classes that do not support it 1f55c59, 4b808cb, c96d9b2, fba4a29, 3357130
|
||||
- Deprecation: Deprecate `NanGetPointerSafe` and `NanSetPointerSafe` 81d4a2c
|
||||
- Deprecation: Deprecate `NanBooleanOptionValue` and `NanUInt32OptionValue` 0ad254b
|
||||
|
||||
### 1.8.4 Apr 26 2015
|
||||
|
||||
- Build: Repackage
|
||||
|
||||
### 1.8.3 Apr 26 2015
|
||||
|
||||
- Bugfix: Include missing header 1af8648
|
||||
|
||||
### 1.8.2 Apr 23 2015
|
||||
|
||||
- Build: Repackage
|
||||
|
||||
### 1.8.1 Apr 23 2015
|
||||
|
||||
- Bugfix: NanObjectWrapHandle should take a pointer 155f1d3
|
||||
|
||||
### 1.8.0 Apr 23 2015
|
||||
|
||||
- Feature: Allow primitives with NanReturnValue 2e4475e
|
||||
- Feature: Added comparison operators to NanCallback 55b075e
|
||||
- Feature: Backport thread local storage 15bb7fa
|
||||
- Removal: Remove support for signatures with arguments 8a2069d
|
||||
- Correcteness: Replaced NanObjectWrapHandle macro with function 0bc6d59
|
||||
|
||||
### 1.7.0 Feb 28 2015
|
||||
|
||||
- Feature: Made NanCallback::Call accept optional target 8d54da7
|
||||
- Feature: Support atom-shell 0.21 0b7f1bb
|
||||
|
||||
### 1.6.2 Feb 6 2015
|
||||
|
||||
- Bugfix: NanEncode: fix argument type for node::Encode on io.js 2be8639
|
||||
|
||||
### 1.6.1 Jan 23 2015
|
||||
|
||||
- Build: version bump
|
||||
|
||||
### 1.5.3 Jan 23 2015
|
||||
|
||||
- Build: repackage
|
||||
|
||||
### 1.6.0 Jan 23 2015
|
||||
|
||||
- Deprecated `NanNewContextHandle` in favor of `NanNew<Context>` 49259af
|
||||
- Support utility functions moved in newer v8 versions (Node 0.11.15, io.js 1.0) a0aa179
|
||||
- Added `NanEncode`, `NanDecodeBytes` and `NanDecodeWrite` 75e6fb9
|
||||
|
||||
### 1.5.2 Jan 23 2015
|
||||
|
||||
- Bugfix: Fix non-inline definition build error with clang++ 21d96a1, 60fadd4
|
||||
- Bugfix: Readded missing String constructors 18d828f
|
||||
- Bugfix: Add overload handling NanNew<FunctionTemplate>(..) 5ef813b
|
||||
- Bugfix: Fix uv_work_cb versioning 997e4ae
|
||||
- Bugfix: Add function factory and test 4eca89c
|
||||
- Bugfix: Add object template factory and test cdcb951
|
||||
- Correctness: Lifted an io.js related typedef c9490be
|
||||
- Correctness: Make explicit downcasts of String lengths 00074e6
|
||||
- Windows: Limit the scope of disabled warning C4530 83d7deb
|
||||
|
||||
### 1.5.1 Jan 15 2015
|
||||
|
||||
- Build: version bump
|
||||
|
||||
### 1.4.3 Jan 15 2015
|
||||
|
||||
- Build: version bump
|
||||
|
||||
### 1.4.2 Jan 15 2015
|
||||
|
||||
- Feature: Support io.js 0dbc5e8
|
||||
|
||||
### 1.5.0 Jan 14 2015
|
||||
|
||||
- Feature: Support io.js b003843
|
||||
- Correctness: Improved NanNew internals 9cd4f6a
|
||||
- Feature: Implement progress to NanAsyncWorker 8d6a160
|
||||
|
||||
### 1.4.1 Nov 8 2014
|
||||
|
||||
- Bugfix: Handle DEBUG definition correctly
|
||||
- Bugfix: Accept int as Boolean
|
||||
|
||||
### 1.4.0 Nov 1 2014
|
||||
|
||||
- Feature: Added NAN_GC_CALLBACK 6a5c245
|
||||
- Performance: Removed unnecessary local handle creation 18a7243, 41fe2f8
|
||||
- Correctness: Added constness to references in NanHasInstance 02c61cd
|
||||
- Warnings: Fixed spurious warnings from -Wundef and -Wshadow, 541b122, 99d8cb6
|
||||
- Windoze: Shut Visual Studio up when compiling 8d558c1
|
||||
- License: Switch to plain MIT from custom hacked MIT license 11de983
|
||||
- Build: Added test target to Makefile e232e46
|
||||
- Performance: Removed superfluous scope in NanAsyncWorker f4b7821
|
||||
- Sugar/Feature: Added NanReturnThis() and NanReturnHolder() shorthands 237a5ff, d697208
|
||||
- Feature: Added suitable overload of NanNew for v8::Integer::NewFromUnsigned b27b450
|
||||
|
||||
### 1.3.0 Aug 2 2014
|
||||
|
||||
- Added NanNew<v8::String, std::string>(std::string)
|
||||
- Added NanNew<v8::String, std::string&>(std::string&)
|
||||
- Added NanAsciiString helper class
|
||||
- Added NanUtf8String helper class
|
||||
- Added NanUcs2String helper class
|
||||
- Deprecated NanRawString()
|
||||
- Deprecated NanCString()
|
||||
- Added NanGetIsolateData(v8::Isolate *isolate)
|
||||
- Added NanMakeCallback(v8::Handle<v8::Object> target, v8::Handle<v8::Function> func, int argc, v8::Handle<v8::Value>* argv)
|
||||
- Added NanMakeCallback(v8::Handle<v8::Object> target, v8::Handle<v8::String> symbol, int argc, v8::Handle<v8::Value>* argv)
|
||||
- Added NanMakeCallback(v8::Handle<v8::Object> target, const char* method, int argc, v8::Handle<v8::Value>* argv)
|
||||
- Added NanSetTemplate(v8::Handle<v8::Template> templ, v8::Handle<v8::String> name , v8::Handle<v8::Data> value, v8::PropertyAttribute attributes)
|
||||
- Added NanSetPrototypeTemplate(v8::Local<v8::FunctionTemplate> templ, v8::Handle<v8::String> name, v8::Handle<v8::Data> value, v8::PropertyAttribute attributes)
|
||||
- Added NanSetInstanceTemplate(v8::Local<v8::FunctionTemplate> templ, const char *name, v8::Handle<v8::Data> value)
|
||||
- Added NanSetInstanceTemplate(v8::Local<v8::FunctionTemplate> templ, v8::Handle<v8::String> name, v8::Handle<v8::Data> value, v8::PropertyAttribute attributes)
|
||||
|
||||
### 1.2.0 Jun 5 2014
|
||||
|
||||
- Add NanSetPrototypeTemplate
|
||||
- Changed NAN_WEAK_CALLBACK internals, switched _NanWeakCallbackData to class,
|
||||
introduced _NanWeakCallbackDispatcher
|
||||
- Removed -Wno-unused-local-typedefs from test builds
|
||||
- Made test builds Windows compatible ('Sleep()')
|
||||
|
||||
### 1.1.2 May 28 2014
|
||||
|
||||
- Release to fix more stuff-ups in 1.1.1
|
||||
|
||||
### 1.1.1 May 28 2014
|
||||
|
||||
- Release to fix version mismatch in nan.h and lack of changelog entry for 1.1.0
|
||||
|
||||
### 1.1.0 May 25 2014
|
||||
|
||||
- Remove nan_isolate, use v8::Isolate::GetCurrent() internally instead
|
||||
- Additional explicit overloads for NanNew(): (char*,int), (uint8_t*[,int]),
|
||||
(uint16_t*[,int), double, int, unsigned int, bool, v8::String::ExternalStringResource*,
|
||||
v8::String::ExternalAsciiStringResource*
|
||||
- Deprecate NanSymbol()
|
||||
- Added SetErrorMessage() and ErrorMessage() to NanAsyncWorker
|
||||
|
||||
### 1.0.0 May 4 2014
|
||||
|
||||
- Heavy API changes for V8 3.25 / Node 0.11.13
|
||||
- Use cpplint.py
|
||||
- Removed NanInitPersistent
|
||||
- Removed NanPersistentToLocal
|
||||
- Removed NanFromV8String
|
||||
- Removed NanMakeWeak
|
||||
- Removed NanNewLocal
|
||||
- Removed NAN_WEAK_CALLBACK_OBJECT
|
||||
- Removed NAN_WEAK_CALLBACK_DATA
|
||||
- Introduce NanNew, replaces NanNewLocal, NanPersistentToLocal, adds many overloaded typed versions
|
||||
- Introduce NanUndefined, NanNull, NanTrue and NanFalse
|
||||
- Introduce NanEscapableScope and NanEscapeScope
|
||||
- Introduce NanMakeWeakPersistent (requires a special callback to work on both old and new node)
|
||||
- Introduce NanMakeCallback for node::MakeCallback
|
||||
- Introduce NanSetTemplate
|
||||
- Introduce NanGetCurrentContext
|
||||
- Introduce NanCompileScript and NanRunScript
|
||||
- Introduce NanAdjustExternalMemory
|
||||
- Introduce NanAddGCEpilogueCallback, NanAddGCPrologueCallback, NanRemoveGCEpilogueCallback, NanRemoveGCPrologueCallback
|
||||
- Introduce NanGetHeapStatistics
|
||||
- Rename NanAsyncWorker#SavePersistent() to SaveToPersistent()
|
||||
|
||||
### 0.8.0 Jan 9 2014
|
||||
|
||||
- NanDispose -> NanDisposePersistent, deprecate NanDispose
|
||||
- Extract _NAN_*_RETURN_TYPE, pull up NAN_*()
|
||||
|
||||
### 0.7.1 Jan 9 2014
|
||||
|
||||
- Fixes to work against debug builds of Node
|
||||
- Safer NanPersistentToLocal (avoid reinterpret_cast)
|
||||
- Speed up common NanRawString case by only extracting flattened string when necessary
|
||||
|
||||
### 0.7.0 Dec 17 2013
|
||||
|
||||
- New no-arg form of NanCallback() constructor.
|
||||
- NanCallback#Call takes Handle rather than Local
|
||||
- Removed deprecated NanCallback#Run method, use NanCallback#Call instead
|
||||
- Split off _NAN_*_ARGS_TYPE from _NAN_*_ARGS
|
||||
- Restore (unofficial) Node 0.6 compatibility at NanCallback#Call()
|
||||
- Introduce NanRawString() for char* (or appropriate void*) from v8::String
|
||||
(replacement for NanFromV8String)
|
||||
- Introduce NanCString() for null-terminated char* from v8::String
|
||||
|
||||
### 0.6.0 Nov 21 2013
|
||||
|
||||
- Introduce NanNewLocal<T>(v8::Handle<T> value) for use in place of
|
||||
v8::Local<T>::New(...) since v8 started requiring isolate in Node 0.11.9
|
||||
|
||||
### 0.5.2 Nov 16 2013
|
||||
|
||||
- Convert SavePersistent and GetFromPersistent in NanAsyncWorker from protected and public
|
||||
|
||||
### 0.5.1 Nov 12 2013
|
||||
|
||||
- Use node::MakeCallback() instead of direct v8::Function::Call()
|
||||
|
||||
### 0.5.0 Nov 11 2013
|
||||
|
||||
- Added @TooTallNate as collaborator
|
||||
- New, much simpler, "include_dirs" for binding.gyp
|
||||
- Added full range of NAN_INDEX_* macros to match NAN_PROPERTY_* macros
|
||||
|
||||
### 0.4.4 Nov 2 2013
|
||||
|
||||
- Isolate argument from v8::Persistent::MakeWeak removed for 0.11.8+
|
||||
|
||||
### 0.4.3 Nov 2 2013
|
||||
|
||||
- Include node_object_wrap.h, removed from node.h for Node 0.11.8.
|
||||
|
||||
### 0.4.2 Nov 2 2013
|
||||
|
||||
- Handle deprecation of v8::Persistent::Dispose(v8::Isolate* isolate)) for
|
||||
Node 0.11.8 release.
|
||||
|
||||
### 0.4.1 Sep 16 2013
|
||||
|
||||
- Added explicit `#include <uv.h>` as it was removed from node.h for v0.11.8
|
||||
|
||||
### 0.4.0 Sep 2 2013
|
||||
|
||||
- Added NAN_INLINE and NAN_DEPRECATED and made use of them
|
||||
- Added NanError, NanTypeError and NanRangeError
|
||||
- Cleaned up code
|
||||
|
||||
### 0.3.2 Aug 30 2013
|
||||
|
||||
- Fix missing scope declaration in GetFromPersistent() and SaveToPersistent
|
||||
in NanAsyncWorker
|
||||
|
||||
### 0.3.1 Aug 20 2013
|
||||
|
||||
- fix "not all control paths return a value" compile warning on some platforms
|
||||
|
||||
### 0.3.0 Aug 19 2013
|
||||
|
||||
- Made NAN work with NPM
|
||||
- Lots of fixes to NanFromV8String, pulling in features from new Node core
|
||||
- Changed node::encoding to Nan::Encoding in NanFromV8String to unify the API
|
||||
- Added optional error number argument for NanThrowError()
|
||||
- Added NanInitPersistent()
|
||||
- Added NanReturnNull() and NanReturnEmptyString()
|
||||
- Added NanLocker and NanUnlocker
|
||||
- Added missing scopes
|
||||
- Made sure to clear disposed Persistent handles
|
||||
- Changed NanAsyncWorker to allocate error messages on the heap
|
||||
- Changed NanThrowError(Local<Value>) to NanThrowError(Handle<Value>)
|
||||
- Fixed leak in NanAsyncWorker when errmsg is used
|
||||
|
||||
### 0.2.2 Aug 5 2013
|
||||
|
||||
- Fixed usage of undefined variable with node::BASE64 in NanFromV8String()
|
||||
|
||||
### 0.2.1 Aug 5 2013
|
||||
|
||||
- Fixed 0.8 breakage, node::BUFFER encoding type not available in 0.8 for
|
||||
NanFromV8String()
|
||||
|
||||
### 0.2.0 Aug 5 2013
|
||||
|
||||
- Added NAN_PROPERTY_GETTER, NAN_PROPERTY_SETTER, NAN_PROPERTY_ENUMERATOR,
|
||||
NAN_PROPERTY_DELETER, NAN_PROPERTY_QUERY
|
||||
- Extracted _NAN_METHOD_ARGS, _NAN_GETTER_ARGS, _NAN_SETTER_ARGS,
|
||||
_NAN_PROPERTY_GETTER_ARGS, _NAN_PROPERTY_SETTER_ARGS,
|
||||
_NAN_PROPERTY_ENUMERATOR_ARGS, _NAN_PROPERTY_DELETER_ARGS,
|
||||
_NAN_PROPERTY_QUERY_ARGS
|
||||
- Added NanGetInternalFieldPointer, NanSetInternalFieldPointer
|
||||
- Added NAN_WEAK_CALLBACK, NAN_WEAK_CALLBACK_OBJECT,
|
||||
NAN_WEAK_CALLBACK_DATA, NanMakeWeak
|
||||
- Renamed THROW_ERROR to _NAN_THROW_ERROR
|
||||
- Added NanNewBufferHandle(char*, size_t, node::smalloc::FreeCallback, void*)
|
||||
- Added NanBufferUse(char*, uint32_t)
|
||||
- Added NanNewContextHandle(v8::ExtensionConfiguration*,
|
||||
v8::Handle<v8::ObjectTemplate>, v8::Handle<v8::Value>)
|
||||
- Fixed broken NanCallback#GetFunction()
|
||||
- Added optional encoding and size arguments to NanFromV8String()
|
||||
- Added NanGetPointerSafe() and NanSetPointerSafe()
|
||||
- Added initial test suite (to be expanded)
|
||||
- Allow NanUInt32OptionValue to convert any Number object
|
||||
|
||||
### 0.1.0 Jul 21 2013
|
||||
|
||||
- Added `NAN_GETTER`, `NAN_SETTER`
|
||||
- Added `NanThrowError` with single Local<Value> argument
|
||||
- Added `NanNewBufferHandle` with single uint32_t argument
|
||||
- Added `NanHasInstance(Persistent<FunctionTemplate>&, Handle<Value>)`
|
||||
- Added `Local<Function> NanCallback#GetFunction()`
|
||||
- Added `NanCallback#Call(int, Local<Value>[])`
|
||||
- Deprecated `NanCallback#Run(int, Local<Value>[])` in favour of Call
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
The MIT License (MIT)
|
||||
=====================
|
||||
|
||||
Copyright (c) 2015 NAN contributors
|
||||
-----------------------------------
|
||||
|
||||
*NAN contributors listed at <https://github.com/nodejs/nan#contributors>*
|
||||
|
||||
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.
|
||||
+367
@@ -0,0 +1,367 @@
|
||||
Native Abstractions for Node.js
|
||||
===============================
|
||||
|
||||
**A header file filled with macro and utility goodness for making add-on development for Node.js easier across versions 0.8, 0.10 and 0.12 as well as io.js.**
|
||||
|
||||
***Current version: 2.0.9***
|
||||
|
||||
*(See [CHANGELOG.md](https://github.com/nodejs/nan/blob/master/CHANGELOG.md) for complete ChangeLog)*
|
||||
|
||||
[](https://nodei.co/npm/nan/) [](https://nodei.co/npm/nan/)
|
||||
|
||||
[](http://travis-ci.org/nodejs/nan)
|
||||
[](https://ci.appveyor.com/project/RodVagg/nan)
|
||||
|
||||
Thanks to the crazy changes in V8 (and some in Node core), keeping native addons compiling happily across versions, particularly 0.10 to 0.12, is a minor nightmare. The goal of this project is to store all logic necessary to develop native Node.js addons without having to inspect `NODE_MODULE_VERSION` and get yourself into a macro-tangle.
|
||||
|
||||
This project also contains some helper utilities that make addon development a bit more pleasant.
|
||||
|
||||
* **[News & Updates](#news)**
|
||||
* **[Usage](#usage)**
|
||||
* **[Example](#example)**
|
||||
* **[API](#api)**
|
||||
* **[Tests](#tests)**
|
||||
* **[Governance & Contributing](#governance)**
|
||||
|
||||
<a name="news"></a>
|
||||
## News & Updates
|
||||
|
||||
<a name="usage"></a>
|
||||
## Usage
|
||||
|
||||
Simply add **NAN** as a dependency in the *package.json* of your Node addon:
|
||||
|
||||
``` bash
|
||||
$ npm install --save nan
|
||||
```
|
||||
|
||||
Pull in the path to **NAN** in your *binding.gyp* so that you can use `#include <nan.h>` in your *.cpp* files:
|
||||
|
||||
``` python
|
||||
"include_dirs" : [
|
||||
"<!(node -e \"require('nan')\")"
|
||||
]
|
||||
```
|
||||
|
||||
This works like a `-I<path-to-NAN>` when compiling your addon.
|
||||
|
||||
<a name="example"></a>
|
||||
## Example
|
||||
|
||||
Just getting started with Nan? Refer to a [quick-start **Nan** Boilerplate](https://github.com/fcanas/node-native-boilerplate) for a ready-to-go project that utilizes basic Nan functionality.
|
||||
|
||||
For a simpler example, see the **[async pi estimation example](https://github.com/nodejs/nan/tree/master/examples/async_pi_estimate)** in the examples directory for full code and an explanation of what this Monte Carlo Pi estimation example does. Below are just some parts of the full example that illustrate the use of **NAN**.
|
||||
|
||||
For another example, see **[nan-example-eol](https://github.com/CodeCharmLtd/nan-example-eol)**. It shows newline detection implemented as a native addon.
|
||||
|
||||
<a name="api"></a>
|
||||
## API
|
||||
|
||||
Additional to the NAN documentation below, please consult:
|
||||
|
||||
* [The V8 Getting Started Guide](https://developers.google.com/v8/get_started)
|
||||
* [The V8 Embedders Guide](https://developers.google.com/v8/embed)
|
||||
* [V8 API Documentation](http://v8docs.nodesource.com/)
|
||||
|
||||
<!-- START API -->
|
||||
|
||||
### JavaScript-accessible methods
|
||||
|
||||
A _template_ is a blueprint for JavaScript functions and objects in a context. You can use a template to wrap C++ functions and data structures within JavaScript objects so that they can be manipulated from JavaScript. See the V8 Embedders Guide section on [Templates](https://developers.google.com/v8/embed#templates) for further information.
|
||||
|
||||
In order to expose functionality to JavaScript via a template, you must provide it to V8 in a form that it understands. Across the versions of V8 supported by NAN, JavaScript-accessible method signatures vary widely, NAN fully abstracts method declaration and provides you with an interface that is similar to the most recent V8 API but is backward-compatible with older versions that still use the now-deceased `v8::Argument` type.
|
||||
|
||||
* **Method argument types**
|
||||
- <a href="doc/methods.md#api_nan_function_callback_info"><b><code>Nan::FunctionCallbackInfo</code></b></a>
|
||||
- <a href="doc/methods.md#api_nan_property_callback_info"><b><code>Nan::PropertyCallbackInfo</code></b></a>
|
||||
- <a href="doc/methods.md#api_nan_return_value"><b><code>Nan::ReturnValue</code></b></a>
|
||||
* **Method declarations**
|
||||
- <a href="doc/methods.md#api_nan_method"><b>Method declaration</b></a>
|
||||
- <a href="doc/methods.md#api_nan_getter"><b>Getter declaration</b></a>
|
||||
- <a href="doc/methods.md#api_nan_setter"><b>Setter declaration</b></a>
|
||||
- <a href="doc/methods.md#api_nan_property_getter"><b>Property getter declaration</b></a>
|
||||
- <a href="doc/methods.md#api_nan_property_setter"><b>Property setter declaration</b></a>
|
||||
- <a href="doc/methods.md#api_nan_property_enumerator"><b>Property enumerator declaration</b></a>
|
||||
- <a href="doc/methods.md#api_nan_property_deleter"><b>Property deleter declaration</b></a>
|
||||
- <a href="doc/methods.md#api_nan_property_query"><b>Property query declaration</b></a>
|
||||
- <a href="doc/methods.md#api_nan_index_getter"><b>Index getter declaration</b></a>
|
||||
- <a href="doc/methods.md#api_nan_index_setter"><b>Index setter declaration</b></a>
|
||||
- <a href="doc/methods.md#api_nan_index_enumerator"><b>Index enumerator declaration</b></a>
|
||||
- <a href="doc/methods.md#api_nan_index_deleter"><b>Index deleter declaration</b></a>
|
||||
- <a href="doc/methods.md#api_nan_index_query"><b>Index query declaration</b></a>
|
||||
* Method and template helpers
|
||||
- <a href="doc/methods.md#api_nan_set_method"><b><code>Nan::SetMethod()</code></b></a>
|
||||
- <a href="doc/methods.md#api_nan_set_named_property_handler"><b><code>Nan::SetNamedPropertyHandler()</code></b></a>
|
||||
- <a href="doc/methods.md#api_nan_set_indexed_property_handler"><b><code>Nan::SetIndexedPropertyHandler()</code></b></a>
|
||||
- <a href="doc/methods.md#api_nan_set_prototype_method"><b><code>Nan::SetPrototypeMethod()</code></b></a>
|
||||
- <a href="doc/methods.md#api_nan_set_template"><b><code>Nan::SetTemplate()</code></b></a>
|
||||
- <a href="doc/methods.md#api_nan_set_prototype_template"><b><code>Nan::SetPrototypeTemplate()</code></b></a>
|
||||
- <a href="doc/methods.md#api_nan_set_instance_template"><b><code>Nan::SetInstanceTemplate()</code></b></a>
|
||||
|
||||
### Scopes
|
||||
|
||||
A _local handle_ is a pointer to an object. All V8 objects are accessed using handles, they are necessary because of the way the V8 garbage collector works.
|
||||
|
||||
A handle scope can be thought of as a container for any number of handles. When you've finished with your handles, instead of deleting each one individually you can simply delete their scope.
|
||||
|
||||
The creation of `HandleScope` objects is different across the supported versions of V8. Therefore, NAN provides its own implementations that can be used safely across these.
|
||||
|
||||
- <a href="doc/scopes.md#api_nan_handle_scope"><b><code>Nan::HandleScope</code></b></a>
|
||||
- <a href="doc/scopes.md#api_nan_escapable_handle_scope"><b><code>Nan::EscapableHandleScope</code></b></a>
|
||||
|
||||
Also see the V8 Embedders Guide section on [Handles and Garbage Collection](https://developers.google.com/v8/embed#handles).
|
||||
|
||||
### Persistent references
|
||||
|
||||
An object reference that is independent of any `HandleScope` is a _persistent_ reference. Where a `Local` handle only lives as long as the `HandleScope` in which it was allocated, a `Persistent` handle remains valid until it is explicitly disposed.
|
||||
|
||||
Due to the evolution of the V8 API, it is necessary for NAN to provide a wrapper implementation of the `Persistent` classes to supply compatibility across the V8 versions supported.
|
||||
|
||||
- <a href="doc/persistent.md#api_nan_persistent_base"><b><code>Nan::PersistentBase & v8::PersistentBase</code></b></a>
|
||||
- <a href="doc/persistent.md#api_nan_non_copyable_persistent_traits"><b><code>Nan::NonCopyablePersistentTraits & v8::NonCopyablePersistentTraits</code></b></a>
|
||||
- <a href="doc/persistent.md#api_nan_copyable_persistent_traits"><b><code>Nan::CopyablePersistentTraits & v8::CopyablePersistentTraits</code></b></a>
|
||||
- <a href="doc/persistent.md#api_nan_persistent"><b><code>Nan::Persistent</code></b></a>
|
||||
- <a href="doc/persistent.md#api_nan_global"><b><code>Nan::Global</code></b></a>
|
||||
- <a href="doc/persistent.md#api_nan_weak_callback_info"><b><code>Nan::WeakCallbackInfo</code></b></a>
|
||||
- <a href="doc/persistent.md#api_nan_weak_callback_type"><b><code>Nan::WeakCallbackType</code></b></a>
|
||||
|
||||
Also see the V8 Embedders Guide section on [Handles and Garbage Collection](https://developers.google.com/v8/embed#handles).
|
||||
|
||||
### New
|
||||
|
||||
NAN provides a `Nan::New()` helper for the creation of new JavaScript objects in a way that's compatible across the supported versions of V8.
|
||||
|
||||
- <a href="doc/new.md#api_nan_new"><b><code>Nan::New()</code></b></a>
|
||||
- <a href="doc/new.md#api_nan_undefined"><b><code>Nan::Undefined()</code></b></a>
|
||||
- <a href="doc/new.md#api_nan_null"><b><code>Nan::Null()</code></b></a>
|
||||
- <a href="doc/new.md#api_nan_true"><b><code>Nan::True()</code></b></a>
|
||||
- <a href="doc/new.md#api_nan_false"><b><code>Nan::False()</code></b></a>
|
||||
- <a href="doc/new.md#api_nan_empty_string"><b><code>Nan::EmptyString()</code></b></a>
|
||||
|
||||
|
||||
### Converters
|
||||
|
||||
NAN contains functions that convert `v8::Value`s to other `v8::Value` types and native types. Since type conversion is not guaranteed to succeed, they return `Nan::Maybe` types. These converters can be used in place of `value->ToX()` and `value->XValue()` (where `X` is one of the types, e.g. `Boolean`) in a way that provides a consistent interface across V8 versions. Newer versions of V8 use the new `v8::Maybe` and `v8::MaybeLocal` types for these conversions, older versions don't have this functionality so it is provided by NAN.
|
||||
|
||||
- <a href="doc/converters.md#api_nan_to"><b><code>Nan::To()</code></b></a>
|
||||
|
||||
### Maybe Types
|
||||
|
||||
The `Nan::MaybeLocal` and `Nan::Maybe` types are monads that encapsulate `v8::Local` handles that _may be empty_.
|
||||
|
||||
* **Maybe Types**
|
||||
- <a href="doc/maybe_types.md#api_nan_maybe_local"><b><code>Nan::MaybeLocal</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_maybe"><b><code>Nan::Maybe</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_nothing"><b><code>Nan::Nothing</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_just"><b><code>Nan::Just</code></b></a>
|
||||
* **Maybe Helpers**
|
||||
- <a href="doc/maybe_types.md#api_nan_to_detail_string"><b><code>Nan::ToDetailString()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_to_array_index"><b><code>Nan::ToArrayIndex()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_equals"><b><code>Nan::Equals()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_new_instance"><b><code>Nan::NewInstance()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_get_function"><b><code>Nan::GetFunction()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_set"><b><code>Nan::Set()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_force_set"><b><code>Nan::ForceSet()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_get"><b><code>Nan::Get()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_get_property_attribute"><b><code>Nan::GetPropertyAttributes()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_has"><b><code>Nan::Has()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_delete"><b><code>Nan::Delete()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_get_property_names"><b><code>Nan::GetPropertyNames()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_get_own_property_names"><b><code>Nan::GetOwnPropertyNames()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_set_prototype"><b><code>Nan::SetPrototype()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_object_proto_to_string"><b><code>Nan::ObjectProtoToString()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_has_own_property"><b><code>Nan::HasOwnProperty()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_has_real_named_property"><b><code>Nan::HasRealNamedProperty()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_has_real_indexed_property"><b><code>Nan::HasRealIndexedProperty()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_has_real_named_callback_property"><b><code>Nan::HasRealNamedCallbackProperty()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_get_real_named_property_in_prototype_chain"><b><code>Nan::GetRealNamedPropertyInPrototypeChain()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_get_real_named_property"><b><code>Nan::GetRealNamedProperty()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_call_as_function"><b><code>Nan::CallAsFunction()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_call_as_constructor"><b><code>Nan::CallAsConstructor()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_get_source_line"><b><code>Nan::GetSourceLine()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_get_line_number"><b><code>Nan::GetLineNumber()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_get_start_column"><b><code>Nan::GetStartColumn()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_get_end_column"><b><code>Nan::GetEndColumn()</code></b></a>
|
||||
- <a href="doc/maybe_types.md#api_nan_clone_element_at"><b><code>Nan::CloneElementAt()</code></b></a>
|
||||
|
||||
### Script
|
||||
|
||||
NAN provides a `v8::Script` helpers as the API has changed over the supported versions of V8.
|
||||
|
||||
- <a href="doc/script.md#api_nan_compile_script"><b><code>Nan::CompileScript()</code></b></a>
|
||||
- <a href="doc/script.md#api_nan_run_script"><b><code>Nan::RunScript()</code></b></a>
|
||||
|
||||
|
||||
### Errors
|
||||
|
||||
NAN includes helpers for creating, throwing and catching Errors as much of this functionality varies across the supported versions of V8 and must be abstracted.
|
||||
|
||||
Note that an Error object is simply a specialized form of `v8::Value`.
|
||||
|
||||
Also consult the V8 Embedders Guide section on [Exceptions](https://developers.google.com/v8/embed#exceptions) for more information.
|
||||
|
||||
- <a href="doc/errors.md#api_nan_error"><b><code>Nan::Error()</code></b></a>
|
||||
- <a href="doc/errors.md#api_nan_range_error"><b><code>Nan::RangeError()</code></b></a>
|
||||
- <a href="doc/errors.md#api_nan_reference_error"><b><code>Nan::ReferenceError()</code></b></a>
|
||||
- <a href="doc/errors.md#api_nan_syntax_error"><b><code>Nan::SyntaxError()</code></b></a>
|
||||
- <a href="doc/errors.md#api_nan_type_error"><b><code>Nan::TypeError()</code></b></a>
|
||||
- <a href="doc/errors.md#api_nan_throw_error"><b><code>Nan::ThrowError()</code></b></a>
|
||||
- <a href="doc/errors.md#api_nan_throw_range_error"><b><code>Nan::ThrowRangeError()</code></b></a>
|
||||
- <a href="doc/errors.md#api_nan_throw_reference_error"><b><code>Nan::ThrowReferenceError()</code></b></a>
|
||||
- <a href="doc/errors.md#api_nan_throw_syntax_error"><b><code>Nan::ThrowSyntaxError()</code></b></a>
|
||||
- <a href="doc/errors.md#api_nan_throw_type_error"><b><code>Nan::ThrowTypeError()</code></b></a>
|
||||
- <a href="doc/errors.md#api_nan_fatal_exception"><b><code>Nan::FatalException()</code></b></a>
|
||||
- <a href="doc/errors.md#api_nan_errno_exception"><b><code>Nan::ErrnoException()</code></b></a>
|
||||
- <a href="doc/errors.md#api_nan_try_catch"><b><code>Nan::TryCatch</code></b></a>
|
||||
|
||||
|
||||
### Buffers
|
||||
|
||||
NAN's `node::Buffer` helpers exist as the API has changed across supported Node versions. Use these methods to ensure compatibility.
|
||||
|
||||
- <a href="doc/buffers.md#api_nan_new_buffer"><b><code>Nan::NewBuffer()</code></b></a>
|
||||
- <a href="doc/buffers.md#api_nan_copy_buffer"><b><code>Nan::CopyBuffer()</code></b></a>
|
||||
- <a href="doc/buffers.md#api_nan_free_callback"><b><code>Nan::FreeCallback()</code></b></a>
|
||||
|
||||
### Nan::Callback
|
||||
|
||||
`Nan::Callback` makes it easier to use `v8::Function` handles as callbacks. A class that wraps a `v8::Function` handle, protecting it from garbage collection and making it particularly useful for storage and use across asynchronous execution.
|
||||
|
||||
- <a href="doc/callback.md#api_nan_callback"><b><code>Nan::Callback</code></b></a>
|
||||
|
||||
### Asynchronous work helpers
|
||||
|
||||
`Nan::AsyncWorker` and `Nan::AsyncProgressWorker` are helper classes that make working with asynchronous code easier.
|
||||
|
||||
- <a href="doc/asyncworker.md#api_nan_async_worker"><b><code>Nan::AsyncWorker</code></b></a>
|
||||
- <a href="doc/asyncworker.md#api_nan_async_progress_worker"><b><code>Nan::AsyncProgressWorker</code></b></a>
|
||||
- <a href="doc/asyncworker.md#api_nan_async_queue_worker"><b><code>Nan::AsyncQueueWorker</code></b></a>
|
||||
|
||||
### Strings & Bytes
|
||||
|
||||
Miscellaneous string & byte encoding and decoding functionality provided for compatibility across supported versions of V8 and Node. Implemented by NAN to ensure that all encoding types are supported, even for older versions of Node where they are missing.
|
||||
|
||||
- <a href="doc/string_bytes.md#api_nan_encoding"><b><code>Nan::Encoding</code></b></a>
|
||||
- <a href="doc/string_bytes.md#api_nan_encode"><b><code>Nan::Encode()</code></b></a>
|
||||
- <a href="doc/string_bytes.md#api_nan_decode_bytes"><b><code>Nan::DecodeBytes()</code></b></a>
|
||||
- <a href="doc/string_bytes.md#api_nan_decode_write"><b><code>Nan::DecodeWrite()</code></b></a>
|
||||
|
||||
|
||||
### V8 internals
|
||||
|
||||
The hooks to access V8 internals—including GC and statistics—are different across the supported versions of V8, therefore NAN provides its own hooks that call the appropriate V8 methods.
|
||||
|
||||
- <a href="doc/v8_internals.md#api_nan_gc_callback"><b><code>NAN_GC_CALLBACK()</code></b></a>
|
||||
- <a href="doc/v8_internals.md#api_nan_add_gc_epilogue_callback"><b><code>Nan::AddGCEpilogueCallback()</code></b></a>
|
||||
- <a href="doc/v8_internals.md#api_nan_remove_gc_epilogue_callback"><b><code>Nan::RemoveGCEpilogueCallback()</code></b></a>
|
||||
- <a href="doc/v8_internals.md#api_nan_add_gc_prologue_callback"><b><code>Nan::AddGCPrologueCallback()</code></b></a>
|
||||
- <a href="doc/v8_internals.md#api_nan_remove_gc_prologue_callback"><b><code>Nan::RemoveGCPrologueCallback()</code></b></a>
|
||||
- <a href="doc/v8_internals.md#api_nan_get_heap_statistics"><b><code>Nan::GetHeapStatistics()</code></b></a>
|
||||
- <a href="doc/v8_internals.md#api_nan_set_counter_function"><b><code>Nan::SetCounterFunction()</code></b></a>
|
||||
- <a href="doc/v8_internals.md#api_nan_set_create_histogram_function"><b><code>Nan::SetCreateHistogramFunction()</code></b></a>
|
||||
- <a href="doc/v8_internals.md#api_nan_set_add_histogram_sample_function"><b><code>Nan::SetAddHistogramSampleFunction()</code></b></a>
|
||||
- <a href="doc/v8_internals.md#api_nan_idle_notification"><b><code>Nan::IdleNotification()</code></b></a>
|
||||
- <a href="doc/v8_internals.md#api_nan_low_memory_notification"><b><code>Nan::LowMemoryNotification()</code></b></a>
|
||||
- <a href="doc/v8_internals.md#api_nan_context_disposed_notification"><b><code>Nan::ContextDisposedNotification()</code></b></a>
|
||||
- <a href="doc/v8_internals.md#api_nan_get_internal_field_pointer"><b><code>Nan::GetInternalFieldPointer()</code></b></a>
|
||||
- <a href="doc/v8_internals.md#api_nan_set_internal_field_pointer"><b><code>Nan::SetInternalFieldPointer()</code></b></a>
|
||||
- <a href="doc/v8_internals.md#api_nan_adjust_external_memory"><b><code>Nan::AdjustExternalMemory()</code></b></a>
|
||||
|
||||
|
||||
### Miscellaneous V8 Helpers
|
||||
|
||||
- <a href="doc/v8_misc.md#api_nan_utf8_string"><b><code>Nan::Utf8String</code></b></a>
|
||||
- <a href="doc/v8_misc.md#api_nan_get_current_context"><b><code>Nan::GetCurrentContext()</code></b></a>
|
||||
- <a href="doc/v8_misc.md#api_nan_set_isolate_data"><b><code>Nan::SetIsolateData()</code></b></a>
|
||||
- <a href="doc/v8_misc.md#api_nan_get_isolate_data"><b><code>Nan::GetIsolateData()</code></b></a>
|
||||
|
||||
|
||||
### Miscellaneous Node Helpers
|
||||
|
||||
- <a href="doc/node_misc.md#api_nan_make_callback"><b><code>Nan::MakeCallback()</code></b></a>
|
||||
- <a href="doc/node_misc.md#api_nan_object_wrap"><b><code>Nan::ObjectWrap</code></b></a>
|
||||
- <a href="doc/node_misc.md#api_nan_module_init"><b><code>NAN_MODULE_INIT()</code></b></a>
|
||||
- <a href="doc/node_misc.md#api_nan_export"><b><code>Nan::Export()</code></b></a>
|
||||
|
||||
<!-- END API -->
|
||||
|
||||
|
||||
<a name="tests"></a>
|
||||
### Tests
|
||||
|
||||
To run the NAN tests do:
|
||||
|
||||
``` sh
|
||||
npm install
|
||||
npm run-script rebuild-tests
|
||||
npm test
|
||||
```
|
||||
|
||||
Or just:
|
||||
|
||||
``` sh
|
||||
npm install
|
||||
make test
|
||||
```
|
||||
|
||||
<a name="governance"></a>
|
||||
## Governance & Contributing
|
||||
|
||||
NAN is governed by the [io.js](https://iojs.org/) Addon API Working Group
|
||||
|
||||
### Addon API Working Group (WG)
|
||||
|
||||
The NAN project is jointly governed by a Working Group which is responsible for high-level guidance of the project.
|
||||
|
||||
Members of the WG are also known as Collaborators, there is no distinction between the two, unlike other io.js projects.
|
||||
|
||||
The WG has final authority over this project including:
|
||||
|
||||
* Technical direction
|
||||
* Project governance and process (including this policy)
|
||||
* Contribution policy
|
||||
* GitHub repository hosting
|
||||
* Maintaining the list of additional Collaborators
|
||||
|
||||
For the current list of WG members, see the project [README.md](./README.md#collaborators).
|
||||
|
||||
Individuals making significant and valuable contributions are made members of the WG and given commit-access to the project. These individuals are identified by the WG and their addition to the WG is discussed via GitHub and requires unanimous consensus amongst those WG members participating in the discussion with a quorum of 50% of WG members required for acceptance of the vote.
|
||||
|
||||
_Note:_ If you make a significant contribution and are not considered for commit-access log an issue or contact a WG member directly.
|
||||
|
||||
For the current list of WG members / Collaborators, see the project [README.md](./README.md#collaborators).
|
||||
|
||||
### Consensus Seeking Process
|
||||
|
||||
The WG follows a [Consensus Seeking](http://en.wikipedia.org/wiki/Consensus-seeking_decision-making) decision making model.
|
||||
|
||||
Modifications of the contents of the NAN repository are made on a collaborative basis. Anybody with a GitHub account may propose a modification via pull request and it will be considered by the WG. All pull requests must be reviewed and accepted by a WG member with sufficient expertise who is able to take full responsibility for the change. In the case of pull requests proposed by an existing WG member, an additional WG member is required for sign-off. Consensus should be sought if additional WG members participate and there is disagreement around a particular modification.
|
||||
|
||||
If a change proposal cannot reach a consensus, a WG member can call for a vote amongst the members of the WG. Simple majority wins.
|
||||
|
||||
### Developer's Certificate of Origin 1.0
|
||||
|
||||
By making a contribution to this project, I certify that:
|
||||
|
||||
* (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
|
||||
* (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
|
||||
* (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
|
||||
|
||||
<a name="collaborators"></a>
|
||||
### WG Members / Collaborators
|
||||
|
||||
<table><tbody>
|
||||
<tr><th align="left">Rod Vagg</th><td><a href="https://github.com/rvagg">GitHub/rvagg</a></td><td><a href="http://twitter.com/rvagg">Twitter/@rvagg</a></td></tr>
|
||||
<tr><th align="left">Benjamin Byholm</th><td><a href="https://github.com/kkoopa/">GitHub/kkoopa</a></td><td>-</td></tr>
|
||||
<tr><th align="left">Trevor Norris</th><td><a href="https://github.com/trevnorris">GitHub/trevnorris</a></td><td><a href="http://twitter.com/trevnorris">Twitter/@trevnorris</a></td></tr>
|
||||
<tr><th align="left">Nathan Rajlich</th><td><a href="https://github.com/TooTallNate">GitHub/TooTallNate</a></td><td><a href="http://twitter.com/TooTallNate">Twitter/@TooTallNate</a></td></tr>
|
||||
<tr><th align="left">Brett Lawson</th><td><a href="https://github.com/brett19">GitHub/brett19</a></td><td><a href="http://twitter.com/brett19x">Twitter/@brett19x</a></td></tr>
|
||||
<tr><th align="left">Ben Noordhuis</th><td><a href="https://github.com/bnoordhuis">GitHub/bnoordhuis</a></td><td><a href="http://twitter.com/bnoordhuis">Twitter/@bnoordhuis</a></td></tr>
|
||||
<tr><th align="left">David Siegel</th><td><a href="https://github.com/agnat">GitHub/agnat</a></td><td>-</td></tr>
|
||||
</tbody></table>
|
||||
|
||||
## Licence & copyright
|
||||
|
||||
Copyright (c) 2015 NAN WG Members / Collaborators (listed above).
|
||||
|
||||
Native Abstractions for Node.js is licensed under an MIT license. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.
|
||||
+38
@@ -0,0 +1,38 @@
|
||||
# http://www.appveyor.com/docs/appveyor-yml
|
||||
|
||||
# Test against these versions of Io.js and Node.js.
|
||||
environment:
|
||||
matrix:
|
||||
# node.js
|
||||
- nodejs_version: "0.8"
|
||||
- nodejs_version: "0.10"
|
||||
- nodejs_version: "0.12"
|
||||
# io.js
|
||||
- nodejs_version: "1"
|
||||
- nodejs_version: "2"
|
||||
- nodejs_version: "3"
|
||||
|
||||
# Install scripts. (runs after repo cloning)
|
||||
install:
|
||||
# Get the latest stable version of Node 0.STABLE.latest
|
||||
- ps: if($env:nodejs_version -eq "0.8") {Install-Product node $env:nodejs_version}
|
||||
- ps: if($env:nodejs_version -ne "0.8") {Update-NodeJsInstallation (Get-NodeJsLatestBuild $env:nodejs_version)}
|
||||
- IF %nodejs_version% LSS 1 npm -g install npm
|
||||
- IF %nodejs_version% LSS 1 set PATH=%APPDATA%\npm;%PATH%
|
||||
# Typical npm stuff.
|
||||
- npm install
|
||||
- IF %nodejs_version% EQU 0.8 (node node_modules\node-gyp\bin\node-gyp.js rebuild --msvs_version=2013 --directory test) ELSE (npm run rebuild-tests)
|
||||
|
||||
# Post-install test scripts.
|
||||
test_script:
|
||||
# Output useful info for debugging.
|
||||
- node --version
|
||||
- npm --version
|
||||
# run tests
|
||||
- IF %nodejs_version% LSS 1 (npm test) ELSE (iojs node_modules\tap\bin\tap.js --gc test/js/*-test.js)
|
||||
|
||||
# Don't actually build.
|
||||
build: off
|
||||
|
||||
# Set build version format here instead of in the admin panel.
|
||||
version: "{build}"
|
||||
+38
@@ -0,0 +1,38 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
files=" \
|
||||
methods.md \
|
||||
scopes.md \
|
||||
persistent.md \
|
||||
new.md \
|
||||
converters.md \
|
||||
maybe_types.md \
|
||||
script.md \
|
||||
errors.md \
|
||||
buffers.md \
|
||||
callback.md \
|
||||
asyncworker.md \
|
||||
string_bytes.md \
|
||||
v8_internals.md \
|
||||
v8_misc.md \
|
||||
node_misc.md \
|
||||
"
|
||||
|
||||
__dirname=$(dirname "${BASH_SOURCE[0]}")
|
||||
head=$(perl -e 'while (<>) { if (!$en){print;} if ($_=~/<!-- START/){$en=1} };' $__dirname/../README.md)
|
||||
tail=$(perl -e 'while (<>) { if ($_=~/<!-- END/){$st=1} if ($st){print;} };' $__dirname/../README.md)
|
||||
apidocs=$(for f in $files; do
|
||||
perl -pe '
|
||||
last if /^<a name/;
|
||||
$_ =~ s/^## /### /;
|
||||
$_ =~ s/<a href="#/<a href="doc\/'$f'#/;
|
||||
' $__dirname/$f;
|
||||
done)
|
||||
|
||||
cat > $__dirname/../README.md << EOF
|
||||
$head
|
||||
|
||||
$apidocs
|
||||
|
||||
$tail
|
||||
EOF
|
||||
+97
@@ -0,0 +1,97 @@
|
||||
## Asynchronous work helpers
|
||||
|
||||
`Nan::AsyncWorker` and `Nan::AsyncProgressWorker` are helper classes that make working with asynchronous code easier.
|
||||
|
||||
- <a href="#api_nan_async_worker"><b><code>Nan::AsyncWorker</code></b></a>
|
||||
- <a href="#api_nan_async_progress_worker"><b><code>Nan::AsyncProgressWorker</code></b></a>
|
||||
- <a href="#api_nan_async_queue_worker"><b><code>Nan::AsyncQueueWorker</code></b></a>
|
||||
|
||||
<a name="api_nan_async_worker"></a>
|
||||
### Nan::AsyncWorker
|
||||
|
||||
`Nan::AsyncWorker` is an _abstract_ class that you can subclass to have much of the annoying asynchronous queuing and handling taken care of for you. It can even store arbitrary V8 objects for you and have them persist while the asynchronous work is in progress.
|
||||
|
||||
Definition:
|
||||
|
||||
```c++
|
||||
class AsyncWorker {
|
||||
public:
|
||||
explicit AsyncWorker(Callback *callback_);
|
||||
|
||||
virtual ~AsyncWorker();
|
||||
|
||||
virtual void WorkComplete();
|
||||
|
||||
void SaveToPersistent(const char *key, const v8::Local<v8::Value> &value);
|
||||
|
||||
void SaveToPersistent(const v8::Local<v8::String> &key,
|
||||
const v8::Local<v8::Value> &value);
|
||||
|
||||
void SaveToPersistent(uint32_t index,
|
||||
const v8::Local<v8::Value> &value);
|
||||
|
||||
v8::Local<v8::Value> GetFromPersistent(const char *key) const;
|
||||
|
||||
v8::Local<v8::Value> GetFromPersistent(const v8::Local<v8::String> &key) const;
|
||||
|
||||
v8::Local<v8::Value> GetFromPersistent(uint32_t index) const;
|
||||
|
||||
virtual void Execute() = 0;
|
||||
|
||||
uv_work_t request;
|
||||
|
||||
virtual void Destroy();
|
||||
|
||||
protected:
|
||||
Persistent<v8::Object> persistentHandle;
|
||||
|
||||
Callback *callback;
|
||||
|
||||
virtual void HandleOKCallback();
|
||||
|
||||
virtual void HandleErrorCallback();
|
||||
|
||||
void SetErrorMessage(const char *msg);
|
||||
|
||||
const char* ErrorMessage();
|
||||
};
|
||||
```
|
||||
|
||||
<a name="api_nan_async_progress_worker"></a>
|
||||
### Nan::AsyncProgressWorker
|
||||
|
||||
`Nan::AsyncProgressWorker` is an _abstract_ class that extends `Nan::AsyncWorker` and adds additional progress reporting callbacks that can be used during the asynchronous work execution to provide progress data back to JavaScript.
|
||||
|
||||
Definition:
|
||||
|
||||
```c++
|
||||
class AsyncProgressWorker : public AsyncWorker {
|
||||
public:
|
||||
explicit AsyncProgressWorker(Callback *callback_);
|
||||
|
||||
virtual ~AsyncProgressWorker();
|
||||
|
||||
void WorkProgress();
|
||||
|
||||
class ExecutionProgress {
|
||||
public:
|
||||
void Send(const char* data, size_t size) const;
|
||||
};
|
||||
|
||||
virtual void Execute(const ExecutionProgress& progress) = 0;
|
||||
|
||||
virtual void HandleProgressCallback(const char *data, size_t size) = 0;
|
||||
|
||||
virtual void Destroy();
|
||||
```
|
||||
|
||||
<a name="api_nan_async_queue_worker"></a>
|
||||
### Nan::AsyncQueueWorker
|
||||
|
||||
`Nan::AsyncQueueWorker` will run a `Nan::AsyncWorker` asynchronously via libuv. Both the `execute` and `after_work` steps are taken care of for you. Most of the logic for this is embedded in `Nan::AsyncWorker`.
|
||||
|
||||
Definition:
|
||||
|
||||
```c++
|
||||
void AsyncQueueWorker(AsyncWorker *);
|
||||
```
|
||||
+54
@@ -0,0 +1,54 @@
|
||||
## Buffers
|
||||
|
||||
NAN's `node::Buffer` helpers exist as the API has changed across supported Node versions. Use these methods to ensure compatibility.
|
||||
|
||||
- <a href="#api_nan_new_buffer"><b><code>Nan::NewBuffer()</code></b></a>
|
||||
- <a href="#api_nan_copy_buffer"><b><code>Nan::CopyBuffer()</code></b></a>
|
||||
- <a href="#api_nan_free_callback"><b><code>Nan::FreeCallback()</code></b></a>
|
||||
|
||||
<a name="api_nan_new_buffer"></a>
|
||||
### Nan::NewBuffer()
|
||||
|
||||
Allocate a new `node::Buffer` object with the specified size and optional data. Calls `node::Buffer::New()`.
|
||||
|
||||
Note that when creating a `Buffer` using `Nan::NewBuffer()` and an existing `char*`, it is assumed that the ownership of the pointer is being transferred to the new `Buffer` for management.
|
||||
When a `node::Buffer` instance is garbage collected and a `FreeCallback` has not been specified, `data` will be disposed of via a call to `free()`.
|
||||
You _must not_ free the memory space manually once you have created a `Buffer` in this way.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::MaybeLocal<v8::Object> Nan::NewBuffer(uint32_t size)
|
||||
Nan::MaybeLocal<v8::Object> Nan::NewBuffer(char* data, uint32_t size)
|
||||
Nan::MaybeLocal<v8::Object> Nan::NewBuffer(char *data,
|
||||
size_t length,
|
||||
Nan::FreeCallback callback,
|
||||
void *hint)
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_copy_buffer"></a>
|
||||
### Nan::CopyBuffer()
|
||||
|
||||
Similar to [`Nan::NewBuffer()`](#api_nan_new_buffer) except that an implicit memcpy will occur within Node. Calls `node::Buffer::Copy()`.
|
||||
|
||||
Management of the `char*` is left to the user, you should manually free the memory space if necessary as the new `Buffer` will have its own copy.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::MaybeLocal<v8::Object> Nan::CopyBuffer(const char *data, uint32_t size)
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_free_callback"></a>
|
||||
### Nan::FreeCallback()
|
||||
|
||||
A free callback that can be provided to [`Nan::NewBuffer()`](#api_nan_new_buffer).
|
||||
The supplied callback will be invoked when the `Buffer` undergoes garbage collection.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
typedef void (*FreeCallback)(char *data, void *hint);
|
||||
```
|
||||
+52
@@ -0,0 +1,52 @@
|
||||
## Nan::Callback
|
||||
|
||||
`Nan::Callback` makes it easier to use `v8::Function` handles as callbacks. A class that wraps a `v8::Function` handle, protecting it from garbage collection and making it particularly useful for storage and use across asynchronous execution.
|
||||
|
||||
- <a href="#api_nan_callback"><b><code>Nan::Callback</code></b></a>
|
||||
|
||||
<a name="api_nan_callback"></a>
|
||||
### Nan::Callback
|
||||
|
||||
```c++
|
||||
class Callback {
|
||||
public:
|
||||
Callback();
|
||||
|
||||
explicit Callback(const v8::Local<v8::Function> &fn);
|
||||
|
||||
~Callback();
|
||||
|
||||
bool operator==(const Callback &other) const;
|
||||
|
||||
bool operator!=(const Callback &other) const;
|
||||
|
||||
v8::Local<v8::Function> operator*() const;
|
||||
|
||||
v8::Local<v8::Value> operator()(v8::Local<v8::Object> target,
|
||||
int argc = 0,
|
||||
v8::Local<v8::Value> argv[] = 0) const;
|
||||
|
||||
v8::Local<v8::Value> operator()(int argc = 0,
|
||||
v8::Local<v8::Value> argv[] = 0) const;
|
||||
|
||||
void SetFunction(const v8::Local<v8::Function> &fn);
|
||||
|
||||
v8::Local<v8::Function> GetFunction() const;
|
||||
|
||||
bool IsEmpty() const;
|
||||
|
||||
v8::Local<v8::Value> Call(v8::Local<v8::Object> target,
|
||||
int argc,
|
||||
v8::Local<v8::Value> argv[]) const;
|
||||
|
||||
v8::Local<v8::Value> Call(int argc, v8::Local<v8::Value> argv[]) const;
|
||||
};
|
||||
```
|
||||
|
||||
Example usage:
|
||||
|
||||
```c++
|
||||
v8::Local<v8::Function> function;
|
||||
Nan::Callback callback(function);
|
||||
callback->Call(0, 0);
|
||||
```
|
||||
+41
@@ -0,0 +1,41 @@
|
||||
## Converters
|
||||
|
||||
NAN contains functions that convert `v8::Value`s to other `v8::Value` types and native types. Since type conversion is not guaranteed to succeed, they return `Nan::Maybe` types. These converters can be used in place of `value->ToX()` and `value->XValue()` (where `X` is one of the types, e.g. `Boolean`) in a way that provides a consistent interface across V8 versions. Newer versions of V8 use the new `v8::Maybe` and `v8::MaybeLocal` types for these conversions, older versions don't have this functionality so it is provided by NAN.
|
||||
|
||||
- <a href="#api_nan_to"><b><code>Nan::To()</code></b></a>
|
||||
|
||||
<a name="api_nan_to"></a>
|
||||
### Nan::To()
|
||||
|
||||
Converts a `v8::Local<v8::Value>` to a different subtype of `v8::Value` or to a native data type. Returns a `Nan::MaybeLocal<>` or a `Nan::Maybe<>` accordingly.
|
||||
|
||||
See [maybe_types.md](./maybe_types.md) for more information on `Nan::Maybe` types.
|
||||
|
||||
Signatures:
|
||||
|
||||
```c++
|
||||
// V8 types
|
||||
Nan::MaybeLocal<v8::Boolean> Nan::To<v8::Boolean>(v8::Local<v8::Value> val);
|
||||
Nan::MaybeLocal<v8::Int32> Nan::To<v8::Int32>(v8::Local<v8::Value> val);
|
||||
Nan::MaybeLocal<v8::Integer> Nan::To<v8::Integer>(v8::Local<v8::Value> val);
|
||||
Nan::MaybeLocal<v8::Object> Nan::To<v8::Object>(v8::Local<v8::Value> val);
|
||||
Nan::MaybeLocal<v8::Number> Nan::To<v8::Number>(v8::Local<v8::Value> val);
|
||||
Nan::MaybeLocal<v8::String> Nan::To<v8::String>(v8::Local<v8::Value> val);
|
||||
Nan::MaybeLocal<v8::Uint32> Nan::To<v8::Uint32>(v8::Local<v8::Value> val);
|
||||
|
||||
// Native types
|
||||
Nan::Maybe<bool> Nan::To<bool>(v8::Local<v8::Value> val);
|
||||
Nan::Maybe<double> Nan::To<double>(v8::Local<v8::Value> val);
|
||||
Nan::Maybe<int32_t> Nan::To<int32_t>(v8::Local<v8::Value> val);
|
||||
Nan::Maybe<int64_t> Nan::To<int64_t>(v8::Local<v8::Value> val);
|
||||
Nan::Maybe<uint32_t> Nan::To<uint32_t>(v8::Local<v8::Value> val);
|
||||
```
|
||||
|
||||
### Example
|
||||
|
||||
```c++
|
||||
v8::Local<v8::Value> val;
|
||||
Nan::MaybeLocal<v8::String> str = Nan::To<v8::String>(val);
|
||||
Nan::Maybe<double> d = Nan::To<double>(val);
|
||||
```
|
||||
|
||||
+226
@@ -0,0 +1,226 @@
|
||||
## Errors
|
||||
|
||||
NAN includes helpers for creating, throwing and catching Errors as much of this functionality varies across the supported versions of V8 and must be abstracted.
|
||||
|
||||
Note that an Error object is simply a specialized form of `v8::Value`.
|
||||
|
||||
Also consult the V8 Embedders Guide section on [Exceptions](https://developers.google.com/v8/embed#exceptions) for more information.
|
||||
|
||||
- <a href="#api_nan_error"><b><code>Nan::Error()</code></b></a>
|
||||
- <a href="#api_nan_range_error"><b><code>Nan::RangeError()</code></b></a>
|
||||
- <a href="#api_nan_reference_error"><b><code>Nan::ReferenceError()</code></b></a>
|
||||
- <a href="#api_nan_syntax_error"><b><code>Nan::SyntaxError()</code></b></a>
|
||||
- <a href="#api_nan_type_error"><b><code>Nan::TypeError()</code></b></a>
|
||||
- <a href="#api_nan_throw_error"><b><code>Nan::ThrowError()</code></b></a>
|
||||
- <a href="#api_nan_throw_range_error"><b><code>Nan::ThrowRangeError()</code></b></a>
|
||||
- <a href="#api_nan_throw_reference_error"><b><code>Nan::ThrowReferenceError()</code></b></a>
|
||||
- <a href="#api_nan_throw_syntax_error"><b><code>Nan::ThrowSyntaxError()</code></b></a>
|
||||
- <a href="#api_nan_throw_type_error"><b><code>Nan::ThrowTypeError()</code></b></a>
|
||||
- <a href="#api_nan_fatal_exception"><b><code>Nan::FatalException()</code></b></a>
|
||||
- <a href="#api_nan_errno_exception"><b><code>Nan::ErrnoException()</code></b></a>
|
||||
- <a href="#api_nan_try_catch"><b><code>Nan::TryCatch</code></b></a>
|
||||
|
||||
|
||||
<a name="api_nan_error"></a>
|
||||
### Nan::Error()
|
||||
|
||||
Create a new Error object using the [v8::Exception](https://v8docs.nodesource.com/io.js-3.0/da/d6a/classv8_1_1_exception.html) class in a way that is compatible across the supported versions of V8.
|
||||
|
||||
Note that an Error object is simply a specialized form of `v8::Value`.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
v8::Local<v8::Value> Nan::Error(const char *msg);
|
||||
v8::Local<v8::Value> Nan::Error(v8::Local<v8::String> msg);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_range_error"></a>
|
||||
### Nan::RangeError()
|
||||
|
||||
Create a new RangeError object using the [v8::Exception](https://v8docs.nodesource.com/io.js-3.0/da/d6a/classv8_1_1_exception.html) class in a way that is compatible across the supported versions of V8.
|
||||
|
||||
Note that an RangeError object is simply a specialized form of `v8::Value`.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
v8::Local<v8::Value> Nan::RangeError(const char *msg);
|
||||
v8::Local<v8::Value> Nan::RangeError(v8::Local<v8::String> msg);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_reference_error"></a>
|
||||
### Nan::ReferenceError()
|
||||
|
||||
Create a new ReferenceError object using the [v8::Exception](https://v8docs.nodesource.com/io.js-3.0/da/d6a/classv8_1_1_exception.html) class in a way that is compatible across the supported versions of V8.
|
||||
|
||||
Note that an ReferenceError object is simply a specialized form of `v8::Value`.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
v8::Local<v8::Value> Nan::ReferenceError(const char *msg);
|
||||
v8::Local<v8::Value> Nan::ReferenceError(v8::Local<v8::String> msg);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_syntax_error"></a>
|
||||
### Nan::SyntaxError()
|
||||
|
||||
Create a new SyntaxError object using the [v8::Exception](https://v8docs.nodesource.com/io.js-3.0/da/d6a/classv8_1_1_exception.html) class in a way that is compatible across the supported versions of V8.
|
||||
|
||||
Note that an SyntaxError object is simply a specialized form of `v8::Value`.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
v8::Local<v8::Value> Nan::SyntaxError(const char *msg);
|
||||
v8::Local<v8::Value> Nan::SyntaxError(v8::Local<v8::String> msg);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_type_error"></a>
|
||||
### Nan::TypeError()
|
||||
|
||||
Create a new TypeError object using the [v8::Exception](https://v8docs.nodesource.com/io.js-3.0/da/d6a/classv8_1_1_exception.html) class in a way that is compatible across the supported versions of V8.
|
||||
|
||||
Note that an TypeError object is simply a specialized form of `v8::Value`.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
v8::Local<v8::Value> Nan::TypeError(const char *msg);
|
||||
v8::Local<v8::Value> Nan::TypeError(v8::Local<v8::String> msg);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_throw_error"></a>
|
||||
### Nan::ThrowError()
|
||||
|
||||
Throw an Error object (a specialized `v8::Value` as above) in the current context. If a `msg` is provided, a new Error object will be created.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::ThrowError(const char *msg);
|
||||
void Nan::ThrowError(v8::Local<v8::String> msg);
|
||||
void Nan::ThrowError(v8::Local<v8::Value> error);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_throw_range_error"></a>
|
||||
### Nan::ThrowRangeError()
|
||||
|
||||
Throw an RangeError object (a specialized `v8::Value` as above) in the current context. If a `msg` is provided, a new RangeError object will be created.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::ThrowRangeError(const char *msg);
|
||||
void Nan::ThrowRangeError(v8::Local<v8::String> msg);
|
||||
void Nan::ThrowRangeError(v8::Local<v8::Value> error);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_throw_reference_error"></a>
|
||||
### Nan::ThrowReferenceError()
|
||||
|
||||
Throw an ReferenceError object (a specialized `v8::Value` as above) in the current context. If a `msg` is provided, a new ReferenceError object will be created.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::ThrowReferenceError(const char *msg);
|
||||
void Nan::ThrowReferenceError(v8::Local<v8::String> msg);
|
||||
void Nan::ThrowReferenceError(v8::Local<v8::Value> error);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_throw_syntax_error"></a>
|
||||
### Nan::ThrowSyntaxError()
|
||||
|
||||
Throw an SyntaxError object (a specialized `v8::Value` as above) in the current context. If a `msg` is provided, a new SyntaxError object will be created.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::ThrowSyntaxError(const char *msg);
|
||||
void Nan::ThrowSyntaxError(v8::Local<v8::String> msg);
|
||||
void Nan::ThrowSyntaxError(v8::Local<v8::Value> error);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_throw_type_error"></a>
|
||||
### Nan::ThrowTypeError()
|
||||
|
||||
Throw an TypeError object (a specialized `v8::Value` as above) in the current context. If a `msg` is provided, a new TypeError object will be created.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::ThrowTypeError(const char *msg);
|
||||
void Nan::ThrowTypeError(v8::Local<v8::String> msg);
|
||||
void Nan::ThrowTypeError(v8::Local<v8::Value> error);
|
||||
```
|
||||
|
||||
<a name="api_nan_fatal_exception"></a>
|
||||
### Nan::FatalException()
|
||||
|
||||
Replaces `node::FatalException()` which has a different API across supported versions of Node. For use with [`Nan::TryCatch`](#api_nan_try_catch).
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::FatalException(const Nan::TryCatch& try_catch);
|
||||
```
|
||||
|
||||
<a name="api_nan_errno_exception"></a>
|
||||
### Nan::ErrnoException()
|
||||
|
||||
Replaces `node::ErrnoException()` which has a different API across supported versions of Node.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
v8::Local<v8::Value> Nan::ErrnoException(int errorno,
|
||||
const char* syscall = NULL,
|
||||
const char* message = NULL,
|
||||
const char* path = NULL);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_try_catch"></a>
|
||||
### Nan::TryCatch
|
||||
|
||||
A simple wrapper around [`v8::TryCatch`](https://v8docs.nodesource.com/io.js-3.0/d4/dc6/classv8_1_1_try_catch.html) compatible with all supported versions of V8. Can be used as a direct replacement in most cases. See also [`Nan::FatalException()`](#api_nan_fatal_exception) for an internal use compatible with `node::FatalException`.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
class Nan::TryCatch {
|
||||
public:
|
||||
Nan::TryCatch();
|
||||
|
||||
bool HasCaught() const;
|
||||
|
||||
bool CanContinue() const;
|
||||
|
||||
v8::Local<v8::Value> ReThrow();
|
||||
|
||||
v8::Local<v8::Value> Exception() const;
|
||||
|
||||
// Nan::MaybeLocal for older versions of V8
|
||||
v8::MaybeLocal<v8::Value> StackTrace() const;
|
||||
|
||||
v8::Local<v8::Message> Message() const;
|
||||
|
||||
void Reset();
|
||||
|
||||
void SetVerbose(bool value);
|
||||
|
||||
void SetCaptureMessage(bool value);
|
||||
};
|
||||
```
|
||||
|
||||
+480
@@ -0,0 +1,480 @@
|
||||
## Maybe Types
|
||||
|
||||
The `Nan::MaybeLocal` and `Nan::Maybe` types are monads that encapsulate `v8::Local` handles that _may be empty_.
|
||||
|
||||
* **Maybe Types**
|
||||
- <a href="#api_nan_maybe_local"><b><code>Nan::MaybeLocal</code></b></a>
|
||||
- <a href="#api_nan_maybe"><b><code>Nan::Maybe</code></b></a>
|
||||
- <a href="#api_nan_nothing"><b><code>Nan::Nothing</code></b></a>
|
||||
- <a href="#api_nan_just"><b><code>Nan::Just</code></b></a>
|
||||
* **Maybe Helpers**
|
||||
- <a href="#api_nan_to_detail_string"><b><code>Nan::ToDetailString()</code></b></a>
|
||||
- <a href="#api_nan_to_array_index"><b><code>Nan::ToArrayIndex()</code></b></a>
|
||||
- <a href="#api_nan_equals"><b><code>Nan::Equals()</code></b></a>
|
||||
- <a href="#api_nan_new_instance"><b><code>Nan::NewInstance()</code></b></a>
|
||||
- <a href="#api_nan_get_function"><b><code>Nan::GetFunction()</code></b></a>
|
||||
- <a href="#api_nan_set"><b><code>Nan::Set()</code></b></a>
|
||||
- <a href="#api_nan_force_set"><b><code>Nan::ForceSet()</code></b></a>
|
||||
- <a href="#api_nan_get"><b><code>Nan::Get()</code></b></a>
|
||||
- <a href="#api_nan_get_property_attribute"><b><code>Nan::GetPropertyAttributes()</code></b></a>
|
||||
- <a href="#api_nan_has"><b><code>Nan::Has()</code></b></a>
|
||||
- <a href="#api_nan_delete"><b><code>Nan::Delete()</code></b></a>
|
||||
- <a href="#api_nan_get_property_names"><b><code>Nan::GetPropertyNames()</code></b></a>
|
||||
- <a href="#api_nan_get_own_property_names"><b><code>Nan::GetOwnPropertyNames()</code></b></a>
|
||||
- <a href="#api_nan_set_prototype"><b><code>Nan::SetPrototype()</code></b></a>
|
||||
- <a href="#api_nan_object_proto_to_string"><b><code>Nan::ObjectProtoToString()</code></b></a>
|
||||
- <a href="#api_nan_has_own_property"><b><code>Nan::HasOwnProperty()</code></b></a>
|
||||
- <a href="#api_nan_has_real_named_property"><b><code>Nan::HasRealNamedProperty()</code></b></a>
|
||||
- <a href="#api_nan_has_real_indexed_property"><b><code>Nan::HasRealIndexedProperty()</code></b></a>
|
||||
- <a href="#api_nan_has_real_named_callback_property"><b><code>Nan::HasRealNamedCallbackProperty()</code></b></a>
|
||||
- <a href="#api_nan_get_real_named_property_in_prototype_chain"><b><code>Nan::GetRealNamedPropertyInPrototypeChain()</code></b></a>
|
||||
- <a href="#api_nan_get_real_named_property"><b><code>Nan::GetRealNamedProperty()</code></b></a>
|
||||
- <a href="#api_nan_call_as_function"><b><code>Nan::CallAsFunction()</code></b></a>
|
||||
- <a href="#api_nan_call_as_constructor"><b><code>Nan::CallAsConstructor()</code></b></a>
|
||||
- <a href="#api_nan_get_source_line"><b><code>Nan::GetSourceLine()</code></b></a>
|
||||
- <a href="#api_nan_get_line_number"><b><code>Nan::GetLineNumber()</code></b></a>
|
||||
- <a href="#api_nan_get_start_column"><b><code>Nan::GetStartColumn()</code></b></a>
|
||||
- <a href="#api_nan_get_end_column"><b><code>Nan::GetEndColumn()</code></b></a>
|
||||
- <a href="#api_nan_clone_element_at"><b><code>Nan::CloneElementAt()</code></b></a>
|
||||
|
||||
<a name="api_nan_maybe_local"></a>
|
||||
### Nan::MaybeLocal
|
||||
|
||||
A `Nan::MaybeLocal<T>` is a wrapper around [`v8::Local<T>`](https://v8docs.nodesource.com/io.js-3.0/de/deb/classv8_1_1_local.html) that enforces a check that determines whether the `v8::Local<T>` is empty before it can be used.
|
||||
|
||||
If an API method returns a `Nan::MaybeLocal`, 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, or because a `v8::TerminateExecution` exception was thrown. In that case, an empty `Nan::MaybeLocal` is returned.
|
||||
|
||||
Definition:
|
||||
|
||||
```c++
|
||||
template<typename T> class Nan::MaybeLocal {
|
||||
public:
|
||||
MaybeLocal();
|
||||
|
||||
template<typename S> MaybeLocal(v8::Local<S> that);
|
||||
|
||||
bool IsEmpty() const;
|
||||
|
||||
template<typename S> bool ToLocal(v8::Local<S> *out);
|
||||
|
||||
// Will crash if the MaybeLocal<> is empty.
|
||||
v8::Local<T> ToLocalChecked();
|
||||
|
||||
template<typename S> v8::Local<S> FromMaybe(v8::Local<S> default_value) const;
|
||||
};
|
||||
```
|
||||
|
||||
See the documentation for [`v8::MaybeLocal`](https://v8docs.nodesource.com/io.js-3.0/d8/d7d/classv8_1_1_maybe_local.html) for further details.
|
||||
|
||||
<a name="api_nan_maybe"></a>
|
||||
### Nan::Maybe
|
||||
|
||||
A simple `Nan::Maybe` type, representing an object which may or may not have a value, see https://hackage.haskell.org/package/base/docs/Data-Maybe.html.
|
||||
|
||||
If an API method returns a `Nan::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, or because a `v8::TerminateExecution` exception was thrown. In that case, a "Nothing" value is returned.
|
||||
|
||||
Definition:
|
||||
|
||||
```c++
|
||||
template<typename T> class Nan::Maybe {
|
||||
public:
|
||||
bool IsNothing() const;
|
||||
bool IsJust() const;
|
||||
|
||||
// Will crash if the Maybe<> is nothing.
|
||||
T FromJust();
|
||||
|
||||
T FromMaybe(const T& default_value);
|
||||
|
||||
bool operator==(const Maybe &other);
|
||||
|
||||
bool operator!=(const Maybe &other);
|
||||
};
|
||||
```
|
||||
|
||||
See the documentation for [`v8::Maybe`](https://v8docs.nodesource.com/io.js-3.0/d9/d4b/classv8_1_1_maybe.html) for further details.
|
||||
|
||||
<a name="api_nan_nothing"></a>
|
||||
### Nan::Nothing
|
||||
|
||||
Construct an empty `Nan::Maybe` type representing _nothing_.
|
||||
|
||||
```c++
|
||||
template<typename T> Nan::Maybe<T> Nan::Nothing();
|
||||
```
|
||||
|
||||
<a name="api_nan_just"></a>
|
||||
### Nan::Just
|
||||
|
||||
Construct a `Nan::Maybe` type representing _just_ a value.
|
||||
|
||||
```c++
|
||||
template<typename T> Nan::Maybe<T> Nan::Just(const T &t);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_to_detail_string"></a>
|
||||
### Nan::ToDetailString()
|
||||
|
||||
A helper method for calling [`v8::Value#ToDetailString()`](https://v8docs.nodesource.com/io.js-3.0/dc/d0a/classv8_1_1_value.html#a2f9770296dc2c8d274bc8cc0dca243e5) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::MaybeLocal<v8::String> Nan::ToDetailString(v8::Local<v8::Value> val);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_to_array_index"></a>
|
||||
### Nan::ToArrayIndex()
|
||||
|
||||
A helper method for calling [`v8::Value#ToArrayIndex()`](https://v8docs.nodesource.com/io.js-3.0/dc/d0a/classv8_1_1_value.html#acc5bbef3c805ec458470c0fcd6f13493) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::MaybeLocal<v8::Uint32> Nan::ToArrayIndex(v8::Local<v8::Value> val);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_equals"></a>
|
||||
### Nan::Equals()
|
||||
|
||||
A helper method for calling [`v8::Value#Equals()`](https://v8docs.nodesource.com/io.js-3.0/dc/d0a/classv8_1_1_value.html#a0d9616ab2de899d4e3047c30a10c9285) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::Maybe<bool> Nan::Equals(v8::Local<v8::Value> a, v8::Local<v8::Value>(b));
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_new_instance"></a>
|
||||
### Nan::NewInstance()
|
||||
|
||||
A helper method for calling [`v8::Function#NewInstance()`](https://v8docs.nodesource.com/io.js-3.0/d5/d54/classv8_1_1_function.html#a691b13f7a553069732cbacf5ac8c62ec) and [`v8::ObjectTemplate#NewInstance()`](https://v8docs.nodesource.com/io.js-3.0/db/d5f/classv8_1_1_object_template.html#ad605a7543cfbc5dab54cdb0883d14ae4) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::MaybeLocal<v8::Object> Nan::NewInstance(v8::Local<v8::Function> h);
|
||||
Nan::MaybeLocal<v8::Object> Nan::NewInstance(v8::Local<v8::Function> h, int argc, v8::Local<v8::Value> argv[]);
|
||||
Nan::MaybeLocal<v8::Object> Nan::NewInstance(v8::Local<v8::ObjectTemplate> h);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_get_function"></a>
|
||||
### Nan::GetFunction()
|
||||
|
||||
A helper method for calling [`v8::FunctionTemplate#GetFunction()`](https://v8docs.nodesource.com/io.js-3.0/d8/d83/classv8_1_1_function_template.html#a56d904662a86eca78da37d9bb0ed3705) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::MaybeLocal<v8::Function> Nan::GetFunction(v8::Local<v8::FunctionTemplate> t);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_set"></a>
|
||||
### Nan::Set()
|
||||
|
||||
A helper method for calling [`v8::Object#Set()`](https://v8docs.nodesource.com/io.js-3.0/db/d85/classv8_1_1_object.html#a67604ea3734f170c66026064ea808f20) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::Maybe<bool> Nan::Set(v8::Local<v8::Object> obj,
|
||||
v8::Local<v8::Value> key,
|
||||
v8::Local<v8::Value> value)
|
||||
Nan::Maybe<bool> Nan::Set(v8::Local<v8::Object> obj,
|
||||
uint32_t index,
|
||||
v8::Local<v8::Value> value);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_force_set"></a>
|
||||
### Nan::ForceSet()
|
||||
|
||||
A helper method for calling [`v8::Object#ForceSet()`](https://v8docs.nodesource.com/io.js-3.0/db/d85/classv8_1_1_object.html#a796b7b682896fb64bf1872747734e836) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::Maybe<bool> Nan::ForceSet(v8::Local<v8::Object> obj,
|
||||
v8::Local<v8::Value> key,
|
||||
v8::Local<v8::Value> value,
|
||||
v8::PropertyAttribute attribs = v8::None);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_get"></a>
|
||||
### Nan::Get()
|
||||
|
||||
A helper method for calling [`v8::Object#Get()`](https://v8docs.nodesource.com/io.js-3.0/db/d85/classv8_1_1_object.html#a2565f03e736694f6b1e1cf22a0b4eac2) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::MaybeLocal<v8::Value> Nan::Get(v8::Local<v8::Object> obj,
|
||||
v8::Local<v8::Value> key);
|
||||
Nan::MaybeLocal<v8::Value> Nan::Get(v8::Local<v8::Object> obj, uint32_t index);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_get_property_attribute"></a>
|
||||
### Nan::GetPropertyAttributes()
|
||||
|
||||
A helper method for calling [`v8::Object#GetPropertyAttributes()`](https://v8docs.nodesource.com/io.js-3.0/db/d85/classv8_1_1_object.html#a9b898894da3d1db2714fd9325a54fe57) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::Maybe<v8::PropertyAttribute> Nan::GetPropertyAttributes(
|
||||
v8::Local<v8::Object> obj,
|
||||
v8::Local<v8::Value> key);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_has"></a>
|
||||
### Nan::Has()
|
||||
|
||||
A helper method for calling [`v8::Object#Has()`](https://v8docs.nodesource.com/io.js-3.0/db/d85/classv8_1_1_object.html#ab3c3d89ea7c2f9afd08965bd7299a41d) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::Maybe<bool> Nan::Has(v8::Local<v8::Object> obj, v8::Local<v8::String> key);
|
||||
Nan::Maybe<bool> Nan::Has(v8::Local<v8::Object> obj, uint32_t index);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_delete"></a>
|
||||
### Nan::Delete()
|
||||
|
||||
A helper method for calling [`v8::Object#Delete()`](https://v8docs.nodesource.com/io.js-3.0/db/d85/classv8_1_1_object.html#a2fa0f5a592582434ed1ceceff7d891ef) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::Maybe<bool> Nan::Delete(v8::Local<v8::Object> obj,
|
||||
v8::Local<v8::String> key);
|
||||
Nan::Maybe<bool> Nan::Delete(v8::Local<v8::Object> obj, uint32_t index);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_get_property_names"></a>
|
||||
### Nan::GetPropertyNames()
|
||||
|
||||
A helper method for calling [`v8::Object#GetPropertyNames()`](https://v8docs.nodesource.com/io.js-3.0/db/d85/classv8_1_1_object.html#aced885270cfd2c956367b5eedc7fbfe8) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::MaybeLocal<v8::Array> Nan::GetPropertyNames(v8::Local<v8::Object> obj);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_get_own_property_names"></a>
|
||||
### Nan::GetOwnPropertyNames()
|
||||
|
||||
A helper method for calling [`v8::Object#GetOwnPropertyNames()`](https://v8docs.nodesource.com/io.js-3.0/db/d85/classv8_1_1_object.html#a79a6e4d66049b9aa648ed4dfdb23e6eb) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::MaybeLocal<v8::Array> Nan::GetOwnPropertyNames(v8::Local<v8::Object> obj);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_set_prototype"></a>
|
||||
### Nan::SetPrototype()
|
||||
|
||||
A helper method for calling [`v8::Object#SetPrototype()`](https://v8docs.nodesource.com/io.js-3.0/db/d85/classv8_1_1_object.html#a442706b22fceda6e6d1f632122a9a9f4) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::Maybe<bool> Nan::SetPrototype(v8::Local<v8::Object> obj,
|
||||
v8::Local<v8::Value> prototype);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_object_proto_to_string"></a>
|
||||
### Nan::ObjectProtoToString()
|
||||
|
||||
A helper method for calling [`v8::Object#ObjectProtoToString()`](https://v8docs.nodesource.com/io.js-3.0/db/d85/classv8_1_1_object.html#ab7a92b4dcf822bef72f6c0ac6fea1f0b) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::MaybeLocal<v8::String> Nan::ObjectProtoToString(v8::Local<v8::Object> obj);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_has_own_property"></a>
|
||||
### Nan::HasOwnProperty()
|
||||
|
||||
A helper method for calling [`v8::Object#HasOwnProperty()`](https://v8docs.nodesource.com/io.js-3.0/db/d85/classv8_1_1_object.html#ab7b7245442ca6de1e1c145ea3fd653ff) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::Maybe<bool> Nan::HasOwnProperty(v8::Local<v8::Object> obj,
|
||||
v8::Local<v8::String> key);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_has_real_named_property"></a>
|
||||
### Nan::HasRealNamedProperty()
|
||||
|
||||
A helper method for calling [`v8::Object#HasRealNamedProperty()`](https://v8docs.nodesource.com/io.js-3.0/db/d85/classv8_1_1_object.html#ad8b80a59c9eb3c1e6c3cd6c84571f767) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::Maybe<bool> Nan::HasRealNamedProperty(v8::Local<v8::Object> obj,
|
||||
v8::Local<v8::String> key);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_has_real_indexed_property"></a>
|
||||
### Nan::HasRealIndexedProperty()
|
||||
|
||||
A helper method for calling [`v8::Object#HasRealIndexedProperty()`](https://v8docs.nodesource.com/io.js-3.0/db/d85/classv8_1_1_object.html#af94fc1135a5e74a2193fb72c3a1b9855) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::Maybe<bool> Nan::HasRealIndexedProperty(v8::Local<v8::Object> obj,
|
||||
uint32_t index);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_has_real_named_callback_property"></a>
|
||||
### Nan::HasRealNamedCallbackProperty()
|
||||
|
||||
A helper method for calling [`v8::Object#HasRealNamedCallbackProperty()`](https://v8docs.nodesource.com/io.js-3.0/db/d85/classv8_1_1_object.html#af743b7ea132b89f84d34d164d0668811) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::Maybe<bool> Nan::HasRealNamedCallbackProperty(
|
||||
v8::Local<v8::Object> obj,
|
||||
v8::Local<v8::String> key);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_get_real_named_property_in_prototype_chain"></a>
|
||||
### Nan::GetRealNamedPropertyInPrototypeChain()
|
||||
|
||||
A helper method for calling [`v8::Object#GetRealNamedPropertyInPrototypeChain()`](https://v8docs.nodesource.com/io.js-3.0/db/d85/classv8_1_1_object.html#a8700b1862e6b4783716964ba4d5e6172) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::MaybeLocal<v8::Value> Nan::GetRealNamedPropertyInPrototypeChain(
|
||||
v8::Local<v8::Object> obj,
|
||||
v8::Local<v8::String> key);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_get_real_named_property"></a>
|
||||
### Nan::GetRealNamedProperty()
|
||||
|
||||
A helper method for calling [`v8::Object#GetRealNamedProperty()`](https://v8docs.nodesource.com/io.js-3.0/db/d85/classv8_1_1_object.html#a84471a824576a5994fdd0ffcbf99ccc0) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::MaybeLocal<v8::Value> Nan::GetRealNamedProperty(v8::Local<v8::Object> obj,
|
||||
v8::Local<v8::String> key);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_call_as_function"></a>
|
||||
### Nan::CallAsFunction()
|
||||
|
||||
A helper method for calling [`v8::Object#CallAsFunction()`](https://v8docs.nodesource.com/io.js-3.0/db/d85/classv8_1_1_object.html#a9ef18be634e79b4f0cdffa1667a29f58) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::MaybeLocal<v8::Value> Nan::CallAsFunction(v8::Local<v8::Object> obj,
|
||||
v8::Local<v8::Object> recv,
|
||||
int argc,
|
||||
v8::Local<v8::Value> argv[]);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_call_as_constructor"></a>
|
||||
### Nan::CallAsConstructor()
|
||||
|
||||
A helper method for calling [`v8::Object#CallAsConstructor()`](https://v8docs.nodesource.com/io.js-3.0/db/d85/classv8_1_1_object.html#a50d571de50d0b0dfb28795619d07a01b) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::MaybeLocal<v8::Value> Nan::CallAsConstructor(v8::Local<v8::Object> obj,
|
||||
int argc,
|
||||
v8::Local<v8::Value> argv[]);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_get_source_line"></a>
|
||||
### Nan::GetSourceLine()
|
||||
|
||||
A helper method for calling [`v8::Message#GetSourceLine()`](https://v8docs.nodesource.com/io.js-3.0/d9/d28/classv8_1_1_message.html#a849f7a6c41549d83d8159825efccd23a) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::MaybeLocal<v8::String> Nan::GetSourceLine(v8::Local<v8::Message> msg);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_get_line_number"></a>
|
||||
### Nan::GetLineNumber()
|
||||
|
||||
A helper method for calling [`v8::Message#GetLineNumber()`](https://v8docs.nodesource.com/io.js-3.0/d9/d28/classv8_1_1_message.html#adbe46c10a88a6565f2732a2d2adf99b9) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::Maybe<int> Nan::GetLineNumber(v8::Local<v8::Message> msg);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_get_start_column"></a>
|
||||
### Nan::GetStartColumn()
|
||||
|
||||
A helper method for calling [`v8::Message#GetStartColumn()`](https://v8docs.nodesource.com/io.js-3.0/d9/d28/classv8_1_1_message.html#a60ede616ba3822d712e44c7a74487ba6) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::Maybe<int> Nan::GetStartColumn(v8::Local<v8::Message> msg);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_get_end_column"></a>
|
||||
### Nan::GetEndColumn()
|
||||
|
||||
A helper method for calling [`v8::Message#GetEndColumn()`](https://v8docs.nodesource.com/io.js-3.0/d9/d28/classv8_1_1_message.html#aaa004cf19e529da980bc19fcb76d93be) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::Maybe<int> Nan::GetEndColumn(v8::Local<v8::Message> msg);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_clone_element_at"></a>
|
||||
### Nan::CloneElementAt()
|
||||
|
||||
A helper method for calling [`v8::Array#CloneElementAt()`](https://v8docs.nodesource.com/io.js-3.0/d3/d32/classv8_1_1_array.html#a1d3a878d4c1c7cae974dd50a1639245e) in a way compatible across supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::MaybeLocal<v8::Object> Nan::CloneElementAt(v8::Local<v8::Array> array, uint32_t index);
|
||||
```
|
||||
+624
@@ -0,0 +1,624 @@
|
||||
## JavaScript-accessible methods
|
||||
|
||||
A _template_ is a blueprint for JavaScript functions and objects in a context. You can use a template to wrap C++ functions and data structures within JavaScript objects so that they can be manipulated from JavaScript. See the V8 Embedders Guide section on [Templates](https://developers.google.com/v8/embed#templates) for further information.
|
||||
|
||||
In order to expose functionality to JavaScript via a template, you must provide it to V8 in a form that it understands. Across the versions of V8 supported by NAN, JavaScript-accessible method signatures vary widely, NAN fully abstracts method declaration and provides you with an interface that is similar to the most recent V8 API but is backward-compatible with older versions that still use the now-deceased `v8::Argument` type.
|
||||
|
||||
* **Method argument types**
|
||||
- <a href="#api_nan_function_callback_info"><b><code>Nan::FunctionCallbackInfo</code></b></a>
|
||||
- <a href="#api_nan_property_callback_info"><b><code>Nan::PropertyCallbackInfo</code></b></a>
|
||||
- <a href="#api_nan_return_value"><b><code>Nan::ReturnValue</code></b></a>
|
||||
* **Method declarations**
|
||||
- <a href="#api_nan_method"><b>Method declaration</b></a>
|
||||
- <a href="#api_nan_getter"><b>Getter declaration</b></a>
|
||||
- <a href="#api_nan_setter"><b>Setter declaration</b></a>
|
||||
- <a href="#api_nan_property_getter"><b>Property getter declaration</b></a>
|
||||
- <a href="#api_nan_property_setter"><b>Property setter declaration</b></a>
|
||||
- <a href="#api_nan_property_enumerator"><b>Property enumerator declaration</b></a>
|
||||
- <a href="#api_nan_property_deleter"><b>Property deleter declaration</b></a>
|
||||
- <a href="#api_nan_property_query"><b>Property query declaration</b></a>
|
||||
- <a href="#api_nan_index_getter"><b>Index getter declaration</b></a>
|
||||
- <a href="#api_nan_index_setter"><b>Index setter declaration</b></a>
|
||||
- <a href="#api_nan_index_enumerator"><b>Index enumerator declaration</b></a>
|
||||
- <a href="#api_nan_index_deleter"><b>Index deleter declaration</b></a>
|
||||
- <a href="#api_nan_index_query"><b>Index query declaration</b></a>
|
||||
* Method and template helpers
|
||||
- <a href="#api_nan_set_method"><b><code>Nan::SetMethod()</code></b></a>
|
||||
- <a href="#api_nan_set_named_property_handler"><b><code>Nan::SetNamedPropertyHandler()</code></b></a>
|
||||
- <a href="#api_nan_set_indexed_property_handler"><b><code>Nan::SetIndexedPropertyHandler()</code></b></a>
|
||||
- <a href="#api_nan_set_prototype_method"><b><code>Nan::SetPrototypeMethod()</code></b></a>
|
||||
- <a href="#api_nan_set_template"><b><code>Nan::SetTemplate()</code></b></a>
|
||||
- <a href="#api_nan_set_prototype_template"><b><code>Nan::SetPrototypeTemplate()</code></b></a>
|
||||
- <a href="#api_nan_set_instance_template"><b><code>Nan::SetInstanceTemplate()</code></b></a>
|
||||
|
||||
<a name="api_nan_function_callback_info"></a>
|
||||
### Nan::FunctionCallbackInfo
|
||||
|
||||
`Nan::FunctionCallbackInfo` should be used in place of [`v8::FunctionCallbackInfo`](https://v8docs.nodesource.com/io.js-3.0/dd/d0d/classv8_1_1_function_callback_info.html), even with older versions of Node where `v8::FunctionCallbackInfo` does not exist.
|
||||
|
||||
Definition:
|
||||
|
||||
```c++
|
||||
template<typename T> class FunctionCallbackInfo {
|
||||
public:
|
||||
ReturnValue<T> GetReturnValue() const;
|
||||
v8::Local<v8::Function> Callee();
|
||||
v8::Local<v8::Value> Data();
|
||||
v8::Local<v8::Object> Holder();
|
||||
bool IsConstructCall();
|
||||
int Length() const;
|
||||
v8::Local<v8::Value> operator[](int i) const;
|
||||
v8::Local<v8::Object> This() const;
|
||||
v8::Isolate *GetIsolate() const;
|
||||
};
|
||||
```
|
||||
|
||||
See the [`v8::FunctionCallbackInfo`](https://v8docs.nodesource.com/io.js-3.0/dd/d0d/classv8_1_1_function_callback_info.html) documentation for usage details on these. See [`Nan::ReturnValue`](#api_nan_return_value) for further information on how to set a return value from methods.
|
||||
|
||||
<a name="api_nan_property_callback_info"></a>
|
||||
### Nan::PropertyCallbackInfo
|
||||
|
||||
`Nan::PropertyCallbackInfo` should be used in place of [`v8::PropertyCallbackInfo`](https://v8docs.nodesource.com/io.js-3.0/d7/dc5/classv8_1_1_property_callback_info.html), even with older versions of Node where `v8::PropertyCallbackInfo` does not exist.
|
||||
|
||||
Definition:
|
||||
|
||||
```c++
|
||||
template<typename T> class PropertyCallbackInfo : public PropertyCallbackInfoBase<T> {
|
||||
public:
|
||||
ReturnValue<T> GetReturnValue() const;
|
||||
v8::Isolate* GetIsolate() const;
|
||||
v8::Local<v8::Value> Data() const;
|
||||
v8::Local<v8::Object> This() const;
|
||||
v8::Local<v8::Object> Holder() const;
|
||||
};
|
||||
```
|
||||
|
||||
See the [`v8::PropertyCallbackInfo](https://v8docs.nodesource.com/io.js-3.0/d7/dc5/classv8_1_1_property_callback_info.html) documentation for usage details on these. See [`Nan::ReturnValue`](#api_nan_return_value) for further information on how to set a return value from property accessor methods.
|
||||
|
||||
<a name="api_nan_return_value"></a>
|
||||
### Nan::ReturnValue
|
||||
|
||||
`Nan::ReturnValue` is used in place of [`v8::ReturnValue`](https://v8docs.nodesource.com/io.js-3.0/da/da7/classv8_1_1_return_value.html) on both [`Nan::FunctionCallbackInfo`](#api_nan_function_callback_info) and [`Nan::PropertyCallbackInfo`](#api_nan_property_callback_info) as the return type of `GetReturnValue()`.
|
||||
|
||||
Example usage:
|
||||
|
||||
```c++
|
||||
void EmptyArray(const Nan::FunctionCallbackInfo<v8::Value>& info) {
|
||||
info.GetReturnValue().Set(Nan::New<v8::Array>());
|
||||
}
|
||||
```
|
||||
|
||||
Definition:
|
||||
|
||||
```c++
|
||||
template<typename T> class ReturnValue {
|
||||
public:
|
||||
// Handle setters
|
||||
template <typename S> void Set(const v8::Local<S> &handle);
|
||||
template <typename S> void Set(const Nan::Global<S> &handle);
|
||||
|
||||
// Fast primitive setters
|
||||
void Set(bool value);
|
||||
void Set(double i);
|
||||
void Set(int32_t i);
|
||||
void Set(uint32_t i);
|
||||
|
||||
// Fast JS primitive setters
|
||||
void SetNull();
|
||||
void SetUndefined();
|
||||
void SetEmptyString();
|
||||
|
||||
// Convenience getter for isolate
|
||||
v8::Isolate *GetIsolate() const;
|
||||
};
|
||||
```
|
||||
|
||||
See the documentation on [`v8::ReturnValue`](https://v8docs.nodesource.com/io.js-3.0/da/da7/classv8_1_1_return_value.html) for further information on this.
|
||||
|
||||
<a name="api_nan_method"></a>
|
||||
### Method declaration
|
||||
|
||||
JavaScript-accessible methods should be declared with the following signature to form a `Nan::FunctionCallback`:
|
||||
|
||||
```c++
|
||||
typedef void(*FunctionCallback)(const FunctionCallbackInfo<v8::Value>&);
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```c++
|
||||
void MethodName(const Nan::FunctionCallbackInfo<v8::Value>& info) {
|
||||
...
|
||||
}
|
||||
|
||||
You do not need to declare a new `HandleScope` within a method as one is implicitly created for you.
|
||||
|
||||
**Example usage**
|
||||
|
||||
```c++
|
||||
// .h:
|
||||
class Foo : public Nan::ObjectWrap {
|
||||
...
|
||||
|
||||
static void Bar(const Nan::FunctionCallbackInfo<v8::Value>& info);
|
||||
static void Baz(const Nan::FunctionCallbackInfo<v8::Value>& info);
|
||||
}
|
||||
|
||||
|
||||
// .cc:
|
||||
void Foo::Bar(const Nan::FunctionCallbackInfo<v8::Value>& info) {
|
||||
...
|
||||
}
|
||||
|
||||
void Foo::Baz(const Nan::FunctionCallbackInfo<v8::Value>& info) {
|
||||
...
|
||||
}
|
||||
```
|
||||
|
||||
A helper macro `NAN_METHOD(methodname)` exists, compatible with NAN v1 method declarations.
|
||||
|
||||
**Example usage with `NAN_METHOD(methodname)`**
|
||||
|
||||
```c++
|
||||
// .h:
|
||||
class Foo : public Nan::ObjectWrap {
|
||||
...
|
||||
|
||||
static NAN_METHOD(Bar);
|
||||
static NAN_METHOD(Baz);
|
||||
}
|
||||
|
||||
|
||||
// .cc:
|
||||
NAN_METHOD(Foo::Bar) {
|
||||
...
|
||||
}
|
||||
|
||||
NAN_METHOD(Foo::Baz) {
|
||||
...
|
||||
}
|
||||
```
|
||||
|
||||
Use [`Nan::SetPrototypeMethod`](#api_nan_set_prototype_method) to attach a method to a JavaScript function prototype or [`Nan::SetMethod`](#api_nan_set_method) to attach a method directly on a JavaScript object.
|
||||
|
||||
<a name="api_nan_getter"></a>
|
||||
### Getter declaration
|
||||
|
||||
JavaScript-accessible getters should be declared with the following signature to form a `Nan::GetterCallback`:
|
||||
|
||||
```c++
|
||||
typedef void(*GetterCallback)(v8::Local<v8::String>,
|
||||
const PropertyCallbackInfo<v8::Value>&);
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```c++
|
||||
void GetterName(v8::Local<v8::String> property,
|
||||
const Nan::PropertyCallbackInfo<v8::Value>& info) {
|
||||
...
|
||||
}
|
||||
```
|
||||
|
||||
You do not need to declare a new `HandleScope` within a getter as one is implicitly created for you.
|
||||
|
||||
A helper macro `NAN_GETTER(methodname)` exists, compatible with NAN v1 method declarations.
|
||||
|
||||
Also see the V8 Embedders Guide documentation on [Accessors](https://developers.google.com/v8/embed#accesssors).
|
||||
|
||||
<a name="api_nan_setter"></a>
|
||||
### Setter declaration
|
||||
|
||||
JavaScript-accessible setters should be declared with the following signature to form a <b><code>Nan::SetterCallback</code></b>:
|
||||
|
||||
```c++
|
||||
typedef void(*SetterCallback)(v8::Local<v8::String>,
|
||||
v8::Local<v8::Value>,
|
||||
const PropertyCallbackInfo<void>&);
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```c++
|
||||
void SetterName(v8::Local<v8::String> property,
|
||||
v8::Local<v8::Value> value,
|
||||
const Nan::PropertyCallbackInfo<v8::Value>& info) {
|
||||
...
|
||||
}
|
||||
```
|
||||
|
||||
You do not need to declare a new `HandleScope` within a setter as one is implicitly created for you.
|
||||
|
||||
A helper macro `NAN_SETTER(methodname)` exists, compatible with NAN v1 method declarations.
|
||||
|
||||
Also see the V8 Embedders Guide documentation on [Accessors](https://developers.google.com/v8/embed#accesssors).
|
||||
|
||||
<a name="api_nan_property_getter"></a>
|
||||
### Property getter declaration
|
||||
|
||||
JavaScript-accessible property getters should be declared with the following signature to form a <b><code>Nan::PropertyGetterCallback</code></b>:
|
||||
|
||||
```c++
|
||||
typedef void(*PropertyGetterCallback)(v8::Local<v8::String>,
|
||||
const PropertyCallbackInfo<v8::Value>&);
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```c++
|
||||
void PropertyGetterName(v8::Local<v8::String> property,
|
||||
const Nan::PropertyCallbackInfo<v8::Value>& info) {
|
||||
...
|
||||
}
|
||||
```
|
||||
|
||||
You do not need to declare a new `HandleScope` within a property getter as one is implicitly created for you.
|
||||
|
||||
A helper macro `NAN_PROPERTY_GETTER(methodname)` exists, compatible with NAN v1 method declarations.
|
||||
|
||||
Also see the V8 Embedders Guide documentation on named property [Interceptors](https://developers.google.com/v8/embed#interceptors).
|
||||
|
||||
<a name="api_nan_property_setter"></a>
|
||||
### Property setter declaration
|
||||
|
||||
JavaScript-accessible property setters should be declared with the following signature to form a <b><code>Nan::PropertySetterCallback</code></b>:
|
||||
|
||||
```c++
|
||||
typedef void(*PropertySetterCallback)(v8::Local<v8::String>,
|
||||
v8::Local<v8::Value>,
|
||||
const PropertyCallbackInfo<v8::Value>&);
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```c++
|
||||
void PropertySetterName(v8::Local<v8::String> property,
|
||||
v8::Local<v8::Value> value,
|
||||
const Nan::PropertyCallbackInfo<v8::Value>& info);
|
||||
```
|
||||
|
||||
You do not need to declare a new `HandleScope` within a property setter as one is implicitly created for you.
|
||||
|
||||
A helper macro `NAN_PROPERTY_SETTER(methodname)` exists, compatible with NAN v1 method declarations.
|
||||
|
||||
Also see the V8 Embedders Guide documentation on named property [Interceptors](https://developers.google.com/v8/embed#interceptors).
|
||||
|
||||
<a name="api_nan_property_enumerator"></a>
|
||||
### Property enumerator declaration
|
||||
|
||||
JavaScript-accessible property enumerators should be declared with the following signature to form a <b><code>Nan::PropertyEnumeratorCallback</code></b>:
|
||||
|
||||
```c++
|
||||
typedef void(*PropertyEnumeratorCallback)(const PropertyCallbackInfo<v8::Array>&);
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```c++
|
||||
void PropertyEnumeratorName(const Nan::PropertyCallbackInfo<v8::Array>& info);
|
||||
```
|
||||
|
||||
You do not need to declare a new `HandleScope` within a property enumerator as one is implicitly created for you.
|
||||
|
||||
A helper macro `NAN_PROPERTY_ENUMERATOR(methodname)` exists, compatible with NAN v1 method declarations.
|
||||
|
||||
Also see the V8 Embedders Guide documentation on named property [Interceptors](https://developers.google.com/v8/embed#interceptors).
|
||||
|
||||
<a name="api_nan_property_deleter"></a>
|
||||
### Property deleter declaration
|
||||
|
||||
JavaScript-accessible property deleters should be declared with the following signature to form a <b><code>Nan::PropertyDeleterCallback</code></b>:
|
||||
|
||||
```c++
|
||||
typedef void(*PropertyDeleterCallback)(v8::Local<v8::String>,
|
||||
const PropertyCallbackInfo<v8::Boolean>&);
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```c++
|
||||
void PropertyDeleterName(v8::Local<v8::String> property,
|
||||
const Nan::PropertyCallbackInfo<v8::Boolean>& info);
|
||||
```
|
||||
|
||||
You do not need to declare a new `HandleScope` within a property deleter as one is implicitly created for you.
|
||||
|
||||
A helper macro `NAN_PROPERTY_DELETER(methodname)` exists, compatible with NAN v1 method declarations.
|
||||
|
||||
Also see the V8 Embedders Guide documentation on named property [Interceptors](https://developers.google.com/v8/embed#interceptors).
|
||||
|
||||
<a name="api_nan_property_query"></a>
|
||||
### Property query declaration
|
||||
|
||||
JavaScript-accessible property query methods should be declared with the following signature to form a <b><code>Nan::PropertyQueryCallback</code></b>:
|
||||
|
||||
```c++
|
||||
typedef void(*PropertyQueryCallback)(v8::Local<v8::String>,
|
||||
const PropertyCallbackInfo<v8::Integer>&);
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```c++
|
||||
void PropertyQueryName(v8::Local<v8::String> property,
|
||||
const Nan::PropertyCallbackInfo<v8::Integer>& info);
|
||||
```
|
||||
|
||||
You do not need to declare a new `HandleScope` within a property query method as one is implicitly created for you.
|
||||
|
||||
A helper macro `NAN_PROPERTY_QUERY(methodname)` exists, compatible with NAN v1 method declarations.
|
||||
|
||||
Also see the V8 Embedders Guide documentation on named property [Interceptors](https://developers.google.com/v8/embed#interceptors).
|
||||
|
||||
<a name="api_nan_index_getter"></a>
|
||||
### Index getter declaration
|
||||
|
||||
JavaScript-accessible index getter methods should be declared with the following signature to form a <b><code>Nan::IndexGetterCallback</code></b>:
|
||||
|
||||
```c++
|
||||
typedef void(*IndexGetterCallback)(uint32_t,
|
||||
const PropertyCallbackInfo<v8::Value>&);
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```c++
|
||||
void IndexGetterName(uint32_t index, const PropertyCallbackInfo<v8::Value>& info);
|
||||
```
|
||||
|
||||
You do not need to declare a new `HandleScope` within a index getter as one is implicitly created for you.
|
||||
|
||||
A helper macro `NAN_INDEX_GETTER(methodname)` exists, compatible with NAN v1 method declarations.
|
||||
|
||||
Also see the V8 Embedders Guide documentation on indexed property [Interceptors](https://developers.google.com/v8/embed#interceptors).
|
||||
|
||||
<a name="api_nan_index_setter"></a>
|
||||
### Index setter declaration
|
||||
|
||||
JavaScript-accessible index setter methods should be declared with the following signature to form a <b><code>Nan::IndexSetterCallback</code></b>:
|
||||
|
||||
```c++
|
||||
typedef void(*IndexSetterCallback)(uint32_t,
|
||||
v8::Local<v8::Value>,
|
||||
const PropertyCallbackInfo<v8::Value>&);
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```c++
|
||||
void IndexSetterName(uint32_t index,
|
||||
v8::Local<v8::Value> value,
|
||||
const PropertyCallbackInfo<v8::Value>& info);
|
||||
```
|
||||
|
||||
You do not need to declare a new `HandleScope` within a index setter as one is implicitly created for you.
|
||||
|
||||
A helper macro `NAN_INDEX_SETTER(methodname)` exists, compatible with NAN v1 method declarations.
|
||||
|
||||
Also see the V8 Embedders Guide documentation on indexed property [Interceptors](https://developers.google.com/v8/embed#interceptors).
|
||||
|
||||
<a name="api_nan_index_enumerator"></a>
|
||||
### Index enumerator declaration
|
||||
|
||||
JavaScript-accessible index enumerator methods should be declared with the following signature to form a <b><code>Nan::IndexEnumeratorCallback</code></b>:
|
||||
|
||||
```c++
|
||||
typedef void(*IndexEnumeratorCallback)(const PropertyCallbackInfo<v8::Array>&);
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```c++
|
||||
void IndexEnumeratorName(const PropertyCallbackInfo<v8::Array>& info);
|
||||
```
|
||||
|
||||
You do not need to declare a new `HandleScope` within a index enumerator as one is implicitly created for you.
|
||||
|
||||
A helper macro `NAN_INDEX_ENUMERATOR(methodname)` exists, compatible with NAN v1 method declarations.
|
||||
|
||||
Also see the V8 Embedders Guide documentation on indexed property [Interceptors](https://developers.google.com/v8/embed#interceptors).
|
||||
|
||||
<a name="api_nan_index_deleter"></a>
|
||||
### Index deleter declaration
|
||||
|
||||
JavaScript-accessible index deleter methods should be declared with the following signature to form a <b><code>Nan::IndexDeleterCallback</code></b>:
|
||||
|
||||
```c++
|
||||
typedef void(*IndexDeleterCallback)(uint32_t,
|
||||
const PropertyCallbackInfo<v8::Boolean>&);
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```c++
|
||||
void IndexDeleterName(uint32_t index, const PropertyCallbackInfo<v8::Boolean>& info);
|
||||
```
|
||||
|
||||
You do not need to declare a new `HandleScope` within a index deleter as one is implicitly created for you.
|
||||
|
||||
A helper macro `NAN_INDEX_DELETER(methodname)` exists, compatible with NAN v1 method declarations.
|
||||
|
||||
Also see the V8 Embedders Guide documentation on indexed property [Interceptors](https://developers.google.com/v8/embed#interceptors).
|
||||
|
||||
<a name="api_nan_index_query"></a>
|
||||
### Index query declaration
|
||||
|
||||
JavaScript-accessible index query methods should be declared with the following signature to form a <b><code>Nan::IndexQueryCallback</code></b>:
|
||||
|
||||
```c++
|
||||
typedef void(*IndexQueryCallback)(uint32_t,
|
||||
const PropertyCallbackInfo<v8::Integer>&);
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```c++
|
||||
void IndexQueryName(uint32_t index, const PropertyCallbackInfo<v8::Integer>& info);
|
||||
```
|
||||
|
||||
You do not need to declare a new `HandleScope` within a index query method as one is implicitly created for you.
|
||||
|
||||
A helper macro `NAN_INDEX_QUERY(methodname)` exists, compatible with NAN v1 method declarations.
|
||||
|
||||
Also see the V8 Embedders Guide documentation on indexed property [Interceptors](https://developers.google.com/v8/embed#interceptors).
|
||||
|
||||
<a name="api_nan_set_method"></a>
|
||||
### Nan::SetMethod()
|
||||
|
||||
Sets a method with a given name directly on a JavaScript object where the method has the `Nan::FunctionCallback` signature (see <a href="#api_nan_method">Method declaration</a>).
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
template<typename T> void Nan::SetMethod(const T &recv,
|
||||
const char *name,
|
||||
Nan::FunctionCallback callback)
|
||||
```
|
||||
|
||||
<a name="api_nan_set_prototype_method"></a>
|
||||
### Nan::SetPrototypeMethod()
|
||||
|
||||
Sets a method with a given name on a `FunctionTemplate`'s prototype where the method has the `Nan::FunctionCallback` signature (see <a href="#api_nan_method">Method declaration</a>).
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::SetPrototypeMethod(v8::Local<v8::FunctionTemplate> recv,
|
||||
const char* name,
|
||||
Nan::FunctionCallback callback)
|
||||
```
|
||||
|
||||
<a name="api_nan_set_accessor"></a>
|
||||
### Nan::SetAccessor()
|
||||
|
||||
Sets getters and setters for a property with a given name on an `ObjectTemplate` or a plain `Object`. Accepts getters with the `Nan::GetterCallback` signature (see <a href="#api_nan_getter">Getter declaration</a>) and setters with the `Nan::SetterCallback` signature (see <a href="#api_nan_setter">Setter declaration</a>).
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void SetAccessor(v8::Local<v8::ObjectTemplate> tpl,
|
||||
v8::Local<v8::String> name,
|
||||
Nan::GetterCallback getter,
|
||||
Nan::SetterCallback setter = 0,
|
||||
v8::Local<v8::Value> data = v8::Local<v8::Value>(),
|
||||
v8::AccessControl settings = v8::DEFAULT,
|
||||
v8::PropertyAttribute attribute = v8::None,
|
||||
imp::Sig signature = imp::Sig())
|
||||
bool SetAccessor(v8::Local<v8::Object> obj,
|
||||
v8::Local<v8::String> name,
|
||||
Nan::GetterCallback getter,
|
||||
Nan::SetterCallback setter = 0,
|
||||
v8::Local<v8::Value> data = v8::Local<v8::Value>(),
|
||||
v8::AccessControl settings = v8::DEFAULT,
|
||||
v8::PropertyAttribute attribute = v8::None)
|
||||
```
|
||||
|
||||
See the V8 [`ObjectTemplate#SetAccessor()`](https://v8docs.nodesource.com/io.js-3.0/db/d5f/classv8_1_1_object_template.html#aa90691622f01269c6a11391d372ca0c5) and [`Object#SetAccessor()`](https://v8docs.nodesource.com/io.js-3.0/db/d85/classv8_1_1_object.html#a3f9dee085f5ec346465f1dc924325043) for further information about how to use `Nan::SetAccessor()`.
|
||||
|
||||
<a name="api_nan_set_named_property_handler"></a>
|
||||
### Nan::SetNamedPropertyHandler()
|
||||
|
||||
Sets named property getters, setters, query, deleter and enumerator methods on an `ObjectTemplate`. Accepts:
|
||||
|
||||
* Property getters with the `Nan::PropertyGetterCallback` signature (see <a href="#api_nan_property_getter">Property getter declaration</a>)
|
||||
* Property setters with the `Nan::PropertySetterCallback` signature (see <a href="#api_nan_property_setter">Property setter declaration</a>)
|
||||
* Property query methods with the `Nan::PropertyQueryCallback` signature (see <a href="#api_nan_property_query">Property query declaration</a>)
|
||||
* Property deleters with the `Nan::PropertyDeleterCallback` signature (see <a href="#api_nan_property_deleter">Property deleter declaration</a>)
|
||||
* Property enumerators with the `Nan::PropertyEnumeratorCallback` signature (see <a href="#api_nan_property_enumerator">Property enumerator declaration</a>)
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void SetNamedPropertyHandler(v8::Local<v8::ObjectTemplate> tpl,
|
||||
Nan::PropertyGetterCallback getter,
|
||||
Nan::PropertySetterCallback setter = 0,
|
||||
Nan::PropertyQueryCallback query = 0,
|
||||
Nan::PropertyDeleterCallback deleter = 0,
|
||||
Nan::PropertyEnumeratorCallback enumerator = 0,
|
||||
v8::Local<v8::Value> data = v8::Local<v8::Value>())
|
||||
```
|
||||
|
||||
See the V8 [`ObjectTemplate#SetNamedPropertyHandler()`](https://v8docs.nodesource.com/io.js-3.0/db/d5f/classv8_1_1_object_template.html#a34d1cc45b642cd131706663801aadd76) for further information about how to use `Nan::SetNamedPropertyHandler()`.
|
||||
|
||||
<a name="api_nan_set_indexed_property_handler"></a>
|
||||
### Nan::SetIndexedPropertyHandler()
|
||||
|
||||
Sets indexed property getters, setters, query, deleter and enumerator methods on an `ObjectTemplate`. Accepts:
|
||||
|
||||
* Indexed property getters with the `Nan::IndexGetterCallback` signature (see <a href="#api_nan_index_getter">Index getter declaration</a>)
|
||||
* Indexed property setters with the `Nan::IndexSetterCallback` signature (see <a href="#api_nan_index_setter">Index setter declaration</a>)
|
||||
* Indexed property query methods with the `Nan::IndexQueryCallback` signature (see <a href="#api_nan_index_query">Index query declaration</a>)
|
||||
* Indexed property deleters with the `Nan::IndexDeleterCallback` signature (see <a href="#api_nan_index_deleter">Index deleter declaration</a>)
|
||||
* Indexed property enumerators with the `Nan::IndexEnumeratorCallback` signature (see <a href="#api_nan_index_enumerator">Index enumerator declaration</a>)
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void SetIndexedPropertyHandler(v8::Local<v8::ObjectTemplate> tpl,
|
||||
Nan::IndexGetterCallback getter,
|
||||
Nan::IndexSetterCallback setter = 0,
|
||||
Nan::IndexQueryCallback query = 0,
|
||||
Nan::IndexDeleterCallback deleter = 0,
|
||||
Nan::IndexEnumeratorCallback enumerator = 0,
|
||||
v8::Local<v8::Value> data = v8::Local<v8::Value>())
|
||||
```
|
||||
|
||||
See the V8 [`ObjectTemplate#SetIndexedPropertyHandler()`](https://v8docs.nodesource.com/io.js-3.0/db/d5f/classv8_1_1_object_template.html#ac0234cbede45d51778bb5f6a32a9e125) for further information about how to use `Nan::SetIndexedPropertyHandler()`.
|
||||
|
||||
<a name="api_nan_set_template"></a>
|
||||
### Nan::SetTemplate()
|
||||
|
||||
Adds properties on an `Object`'s or `Function`'s template.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::SetTemplate(v8::Local<v8::Template> templ,
|
||||
const char *name,
|
||||
v8::Local<v8::Data> value)
|
||||
void Nan::SetTemplate(v8::Local<v8::Template> templ,
|
||||
v8::Local<v8::String> name,
|
||||
v8::Local<v8::Data> value,
|
||||
v8::PropertyAttribute attributes)
|
||||
```
|
||||
|
||||
Calls the `Template`'s [`Set()`](https://v8docs.nodesource.com/io.js-3.0/db/df7/classv8_1_1_template.html#a2db6a56597bf23c59659c0659e564ddf).
|
||||
|
||||
<a name="api_nan_set_prototype_template"></a>
|
||||
### Nan::SetPrototypeTemplate()
|
||||
|
||||
Adds properties on an `Object`'s or `Function`'s prototype template.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::SetPrototypeTemplate(v8::Local<v8::FunctionTemplate> templ,
|
||||
const char *name,
|
||||
v8::Local<v8::Data> value)
|
||||
void Nan::SetPrototypeTemplate(v8::Local<v8::FunctionTemplate> templ,
|
||||
v8::Local<v8::String> name,
|
||||
v8::Local<v8::Data> value,
|
||||
v8::PropertyAttribute attributes)
|
||||
```
|
||||
|
||||
Calls the `FunctionTemplate`'s _PrototypeTemplate's_ [`Set()`](https://v8docs.nodesource.com/io.js-3.0/db/df7/classv8_1_1_template.html#a2db6a56597bf23c59659c0659e564ddf).
|
||||
|
||||
<a name="api_nan_set_instance_template"></a>
|
||||
### Nan::SetInstanceTemplate()
|
||||
|
||||
Use to add instance properties on `FunctionTemplate`'s.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::SetInstanceTemplate(v8::Local<v8::FunctionTemplate> templ,
|
||||
const char *name,
|
||||
v8::Local<v8::Data> value)
|
||||
void Nan::SetInstanceTemplate(v8::Local<v8::FunctionTemplate> templ,
|
||||
v8::Local<v8::String> name,
|
||||
v8::Local<v8::Data> value,
|
||||
v8::PropertyAttribute attributes)
|
||||
```
|
||||
|
||||
Calls the `FunctionTemplate`'s _InstanceTemplate's_ [`Set()`](https://v8docs.nodesource.com/io.js-3.0/db/df7/classv8_1_1_template.html#a2db6a56597bf23c59659c0659e564ddf).
|
||||
|
||||
+141
@@ -0,0 +1,141 @@
|
||||
## New
|
||||
|
||||
NAN provides a `Nan::New()` helper for the creation of new JavaScript objects in a way that's compatible across the supported versions of V8.
|
||||
|
||||
- <a href="#api_nan_new"><b><code>Nan::New()</code></b></a>
|
||||
- <a href="#api_nan_undefined"><b><code>Nan::Undefined()</code></b></a>
|
||||
- <a href="#api_nan_null"><b><code>Nan::Null()</code></b></a>
|
||||
- <a href="#api_nan_true"><b><code>Nan::True()</code></b></a>
|
||||
- <a href="#api_nan_false"><b><code>Nan::False()</code></b></a>
|
||||
- <a href="#api_nan_empty_string"><b><code>Nan::EmptyString()</code></b></a>
|
||||
|
||||
|
||||
<a name="api_nan_new"></a>
|
||||
### Nan::New()
|
||||
|
||||
`Nan::New()` should be used to instantiate new JavaScript objects.
|
||||
|
||||
Refer to the specific V8 type in the [V8 documentation](https://v8docs.nodesource.com/io.js-3.0/d1/d83/classv8_1_1_data.html) for information on the types of arguments required for instantiation.
|
||||
|
||||
Signatures:
|
||||
|
||||
Return types are mostly omitted from the signatures for simplicity. In most cases the type will be contained within a `v8::Local<T>`. The following types will be contained within a `Nan::MaybeLocal<T>`: `v8::String`, `v8::Date`, `v8::RegExp`, `v8::Script`, `v8::UnboundScript`.
|
||||
|
||||
Empty objects:
|
||||
|
||||
```c++
|
||||
Nan::New<T>();
|
||||
```
|
||||
|
||||
Generic single and multiple-argument:
|
||||
|
||||
```c++
|
||||
Nan::New<T>(A0 arg0);
|
||||
Nan::New<T>(A0 arg0, A1 arg1);
|
||||
Nan::New<T>(A0 arg0, A1 arg1, A2 arg2);
|
||||
Nan::New<T>(A0 arg0, A1 arg1, A2 arg2, A3 arg3);
|
||||
```
|
||||
|
||||
For creating `v8::FunctionTemplate` and `v8::Function` objects:
|
||||
|
||||
_The definition of `Nan::FunctionCallback` can be found in the [Method declaration](./methods.md#api_nan_method) documentation._
|
||||
|
||||
```c++
|
||||
Nan::New<T>(Nan::FunctionCallback callback,
|
||||
v8::Local<v8::Value> data = v8::Local<v8::Value>());
|
||||
Nan::New<T>(Nan::FunctionCallback callback,
|
||||
v8::Local<v8::Value> data = v8::Local<v8::Value>(),
|
||||
A2 a2 = A2());
|
||||
```
|
||||
|
||||
Native types:
|
||||
|
||||
```c++
|
||||
v8::Local<v8::Boolean> Nan::New<T>(bool value);
|
||||
v8::Local<v8::Int32> Nan::New<T>(int32_t value);
|
||||
v8::Local<v8::Uint32> Nan::New<T>(uint32_t value);
|
||||
v8::Local<v8::Number> Nan::New<T>(double value);
|
||||
v8::Local<v8::String> Nan::New<T>(std::string const& value);
|
||||
v8::Local<v8::String> Nan::New<T>(const char * value, int length);
|
||||
v8::Local<v8::String> Nan::New<T>(const char * value);
|
||||
v8::Local<v8::String> Nan::New<T>(const uint16_t * value);
|
||||
```
|
||||
|
||||
Specialized types:
|
||||
|
||||
```c++
|
||||
v8::Local<v8::String> Nan::New<T>(v8::String::ExternalStringResource * value);
|
||||
v8::Local<v8::String> Nan::New<T>(Nan::ExternalOneByteStringResource * value);
|
||||
v8::Local<v8::RegExp> Nan::New<T>(v8::Local<v8::String> pattern, v8::RegExp::Flags flags);
|
||||
```
|
||||
|
||||
Note that `Nan::ExternalOneByteStringResource` maps to [`v8::String::ExternalOneByteStringResource`](https://v8docs.nodesource.com/io.js-3.0/d9/db3/classv8_1_1_string_1_1_external_one_byte_string_resource.html), and `v8::String::ExternalAsciiStringResource` in older versions of V8.
|
||||
|
||||
|
||||
<a name="api_nan_undefined"></a>
|
||||
### Nan::Undefined()
|
||||
|
||||
A helper method to reference the `v8::Undefined` object in a way that is compatible across all supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
v8::Local<v8::Primitive> Nan::Undefined()
|
||||
```
|
||||
|
||||
<a name="api_nan_null"></a>
|
||||
### Nan::Null()
|
||||
|
||||
A helper method to reference the `v8::Null` object in a way that is compatible across all supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
v8::Local<v8::Primitive> Nan::Null()
|
||||
```
|
||||
|
||||
<a name="api_nan_true"></a>
|
||||
### Nan::True()
|
||||
|
||||
A helper method to reference the `v8::Boolean` object representing the `true` value in a way that is compatible across all supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
v8::Local<v8::Boolean> Nan::True()
|
||||
```
|
||||
|
||||
<a name="api_nan_false"></a>
|
||||
### Nan::False()
|
||||
|
||||
A helper method to reference the `v8::Boolean` object representing the `false` value in a way that is compatible across all supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
v8::Local<v8::Boolean> Nan::False()
|
||||
```
|
||||
|
||||
<a name="api_nan_empty_string"></a>
|
||||
### Nan::EmptyString()
|
||||
|
||||
Call [`v8::String::Empty`](https://v8docs.nodesource.com/io.js-3.0/d2/db3/classv8_1_1_string.html#a7c1bc8886115d7ee46f1d571dd6ebc6d) to reference the empty string in a way that is compatible across all supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
v8::Local<v8::String> Nan::EmptyString()
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_new_one_byte_string"></a>
|
||||
### Nan::NewOneByteString()
|
||||
|
||||
An implementation of [`v8::String::NewFromOneByte()`](https://v8docs.nodesource.com/io.js-3.0/d2/db3/classv8_1_1_string.html#a5264d50b96d2c896ce525a734dc10f09) provided for consistent availability and API across supported versions of V8. Allocates a new string from Latin-1 data.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::MaybeLocal<v8::String> Nan::NewOneByteString(const uint8_t * value,
|
||||
int length = -1)
|
||||
```
|
||||
+114
@@ -0,0 +1,114 @@
|
||||
## Miscellaneous Node Helpers
|
||||
|
||||
- <a href="#api_nan_make_callback"><b><code>Nan::MakeCallback()</code></b></a>
|
||||
- <a href="#api_nan_object_wrap"><b><code>Nan::ObjectWrap</code></b></a>
|
||||
- <a href="#api_nan_module_init"><b><code>NAN_MODULE_INIT()</code></b></a>
|
||||
- <a href="#api_nan_export"><b><code>Nan::Export()</code></b></a>
|
||||
|
||||
|
||||
<a name="api_nan_make_callback"></a>
|
||||
### Nan::MakeCallback()
|
||||
|
||||
Wrappers around `node::MakeCallback()` providing a consistent API across all supported versions of Node.
|
||||
|
||||
Use `MakeCallback()` rather than using `v8::Function#Call()` directly in order to properly process internal Node functionality including domains, async hooks, the microtask queue, and other debugging functionality.
|
||||
|
||||
Signatures:
|
||||
|
||||
```c++
|
||||
v8::Local<v8::Value> Nan::MakeCallback(v8::Local<v8::Object> target,
|
||||
v8::Local<v8::Function> func,
|
||||
int argc,
|
||||
v8::Local<v8::Value>* argv);
|
||||
v8::Local<v8::Value> Nan::MakeCallback(v8::Local<v8::Object> target,
|
||||
v8::Local<v8::String> symbol,
|
||||
int argc,
|
||||
v8::Local<v8::Value>* argv);
|
||||
v8::Local<v8::Value> Nan::MakeCallback(v8::Local<v8::Object> target,
|
||||
const char* method,
|
||||
int argc,
|
||||
v8::Local<v8::Value>* argv);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_object_wrap"></a>
|
||||
### Nan::ObjectWrap()
|
||||
|
||||
A reimplementation of `node::ObjectWrap` that adds some API not present in older versions of Node. Should be preferred over `node::ObjectWrap` in all cases for consistency.
|
||||
|
||||
See the Node documentation on [Wrapping C++ Objects](https://nodejs.org/api/addons.html#addons_wrapping_c_objects) for more details.
|
||||
|
||||
Definition:
|
||||
|
||||
```c++
|
||||
class ObjectWrap {
|
||||
public:
|
||||
ObjectWrap();
|
||||
|
||||
virtual ~ObjectWrap();
|
||||
|
||||
template <class T>
|
||||
static inline T* Unwrap(v8::Local<v8::Object> handle);
|
||||
|
||||
inline v8::Local<v8::Object> handle();
|
||||
|
||||
inline Nan::Persistent<v8::Object>& persistent();
|
||||
|
||||
protected:
|
||||
inline void Wrap(v8::Local<v8::Object> handle);
|
||||
|
||||
inline void MakeWeak();
|
||||
|
||||
/* Ref() marks the object as being attached to an event loop.
|
||||
* Refed objects will not be garbage collected, even if
|
||||
* all references are lost.
|
||||
*/
|
||||
virtual void Ref();
|
||||
|
||||
/* Unref() marks an object as detached from the event loop. This is its
|
||||
* default state. When an object with a "weak" reference changes from
|
||||
* attached to detached state it will be freed. Be careful not to access
|
||||
* the object after making this call as it might be gone!
|
||||
* (A "weak reference" means an object that only has a
|
||||
* persistant handle.)
|
||||
*
|
||||
* DO NOT CALL THIS FROM DESTRUCTOR
|
||||
*/
|
||||
virtual void Unref();
|
||||
|
||||
int refs_; // ro
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_module_init"></a>
|
||||
### NAN_MODULE_INIT()
|
||||
|
||||
Used to define the entry point function to a Node add-on. Creates a function with a given `name` that receives a `target` object representing the equivalent of the JavaScript `exports` object.
|
||||
|
||||
See example below.
|
||||
|
||||
<a name="api_nan_export"></a>
|
||||
### Nan::Export()
|
||||
|
||||
A simple helper to register a `v8::FunctionTemplate` from a JavaScript-accessible method (see [Methods](./methods.md)) as a property on an object. Can be used in a way similar to assigning properties to `module.exports` in JavaScript.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Export(v8::Local<v8::Object> target, const char *name, Nan::FunctionCallback f)
|
||||
```
|
||||
|
||||
Also available as the shortcut `NAN_EXPORT` macro.
|
||||
|
||||
Example:
|
||||
|
||||
```c++
|
||||
NAN_METHOD(Foo) {
|
||||
...
|
||||
}
|
||||
|
||||
NAN_MODULE_INIT(Init) {
|
||||
NAN_EXPORT(target, Foo);
|
||||
}
|
||||
```
|
||||
+292
@@ -0,0 +1,292 @@
|
||||
## Persistent references
|
||||
|
||||
An object reference that is independent of any `HandleScope` is a _persistent_ reference. Where a `Local` handle only lives as long as the `HandleScope` in which it was allocated, a `Persistent` handle remains valid until it is explicitly disposed.
|
||||
|
||||
Due to the evolution of the V8 API, it is necessary for NAN to provide a wrapper implementation of the `Persistent` classes to supply compatibility across the V8 versions supported.
|
||||
|
||||
- <a href="#api_nan_persistent_base"><b><code>Nan::PersistentBase & v8::PersistentBase</code></b></a>
|
||||
- <a href="#api_nan_non_copyable_persistent_traits"><b><code>Nan::NonCopyablePersistentTraits & v8::NonCopyablePersistentTraits</code></b></a>
|
||||
- <a href="#api_nan_copyable_persistent_traits"><b><code>Nan::CopyablePersistentTraits & v8::CopyablePersistentTraits</code></b></a>
|
||||
- <a href="#api_nan_persistent"><b><code>Nan::Persistent</code></b></a>
|
||||
- <a href="#api_nan_global"><b><code>Nan::Global</code></b></a>
|
||||
- <a href="#api_nan_weak_callback_info"><b><code>Nan::WeakCallbackInfo</code></b></a>
|
||||
- <a href="#api_nan_weak_callback_type"><b><code>Nan::WeakCallbackType</code></b></a>
|
||||
|
||||
Also see the V8 Embedders Guide section on [Handles and Garbage Collection](https://developers.google.com/v8/embed#handles).
|
||||
|
||||
<a name="api_nan_persistent_base"></a>
|
||||
### Nan::PersistentBase & v8::PersistentBase
|
||||
|
||||
A persistent handle contains a reference to a storage cell in V8 which holds an object value and which is updated by the garbage collector whenever the object is moved. A new storage cell can be created using the constructor or `Nan::PersistentBase::Reset()`. Existing handles can be disposed using an argument-less `Nan::PersistentBase::Reset()`.
|
||||
|
||||
Definition:
|
||||
|
||||
_(note: this is implemented as `Nan::PersistentBase` for older versions of V8 and the native `v8::PersistentBase` is used for newer versions of V8)_
|
||||
|
||||
```c++
|
||||
template<typename T> class PersistentBase {
|
||||
public:
|
||||
/**
|
||||
* If non-empty, destroy the underlying storage cell
|
||||
*/
|
||||
void Reset();
|
||||
|
||||
/**
|
||||
* If non-empty, destroy the underlying storage cell and create a new one with
|
||||
* the contents of another if it is also non-empty
|
||||
*/
|
||||
template<typename S> void Reset(const v8::Local<S> &other);
|
||||
|
||||
/**
|
||||
* If non-empty, destroy the underlying storage cell and create a new one with
|
||||
* the contents of another if it is also non-empty
|
||||
*/
|
||||
template<typename S> void Reset(const PersistentBase<S> &other);
|
||||
|
||||
/**
|
||||
* If non-empty, destroy the underlying storage cell
|
||||
* IsEmpty() will return true after this call.
|
||||
*/
|
||||
bool IsEmpty();
|
||||
|
||||
void Empty();
|
||||
|
||||
template<typename S> bool operator==(const PersistentBase<S> &that);
|
||||
|
||||
template<typename S> bool operator==(const v8::Local<S> &that);
|
||||
|
||||
template<typename S> bool operator!=(const PersistentBase<S> &that);
|
||||
|
||||
template<typename S> bool operator!=(const v8::Local<S> &that);
|
||||
|
||||
/**
|
||||
* Install a finalization callback on this object.
|
||||
* NOTE: There is no guarantee as to *when* or even *if* the callback is
|
||||
* invoked. The invocation is performed solely on a best effort basis.
|
||||
* As always, GC-based finalization should *not* be relied upon for any
|
||||
* critical form of resource management! At the moment you can either
|
||||
* specify a parameter for the callback or the location of two internal
|
||||
* fields in the dying object.
|
||||
*/
|
||||
template<typename P>
|
||||
void SetWeak(P *parameter,
|
||||
typename WeakCallbackInfo<P>::Callback callback,
|
||||
WeakCallbackType type);
|
||||
|
||||
void ClearWeak();
|
||||
|
||||
/**
|
||||
* Marks the reference to this object independent. Garbage collector is free
|
||||
* to ignore any object groups containing this object. Weak callback for an
|
||||
* independent handle should not assume that it will be preceded by a global
|
||||
* GC prologue callback or followed by a global GC epilogue callback.
|
||||
*/
|
||||
void MarkIndependent() const;
|
||||
|
||||
bool IsIndependent() const;
|
||||
|
||||
/** Checks if the handle holds the only reference to an object. */
|
||||
bool IsNearDeath() const;
|
||||
|
||||
/** Returns true if the handle's reference is weak. */
|
||||
bool IsWeak() const
|
||||
};
|
||||
```
|
||||
|
||||
See the V8 documentation for [`PersistentBase`](https://v8docs.nodesource.com/io.js-3.0/d4/dca/classv8_1_1_persistent_base.html) for further information.
|
||||
|
||||
<a name="api_nan_non_copyable_persistent_traits"></a>
|
||||
### Nan::NonCopyablePersistentTraits & v8::NonCopyablePersistentTraits
|
||||
|
||||
Default traits for `Nan::Persistent`. This class does not allow use of the a copy constructor or assignment operator. At present `kResetInDestructor` is not set, but that will change in a future version.
|
||||
|
||||
Definition:
|
||||
|
||||
_(note: this is implemented as `Nan::NonCopyablePersistentTraits` for older versions of V8 and the native `v8::NonCopyablePersistentTraits` is used for newer versions of V8)_
|
||||
|
||||
```c++
|
||||
template<typename T> class NonCopyablePersistentTraits {
|
||||
public:
|
||||
typedef Persistent<T, NonCopyablePersistentTraits<T> > NonCopyablePersistent;
|
||||
|
||||
static const bool kResetInDestructor = false;
|
||||
|
||||
template<typename S, typename M>
|
||||
static void Copy(const Persistent<S, M> &source,
|
||||
NonCopyablePersistent *dest);
|
||||
|
||||
template<typename O> static void Uncompilable();
|
||||
};
|
||||
```
|
||||
|
||||
See the V8 documentation for [`NonCopyablePersistentTraits`](https://v8docs.nodesource.com/io.js-3.0/de/d73/classv8_1_1_non_copyable_persistent_traits.html) for further information.
|
||||
|
||||
<a name="api_nan_copyable_persistent_traits"></a>
|
||||
### Nan::CopyablePersistentTraits & v8::CopyablePersistentTraits
|
||||
|
||||
A helper class of traits to allow copying and assignment of `Persistent`. This will clone the contents of storage cell, but not any of the flags, etc..
|
||||
|
||||
Definition:
|
||||
|
||||
_(note: this is implemented as `Nan::CopyablePersistentTraits` for older versions of V8 and the native `v8::NonCopyablePersistentTraits` is used for newer versions of V8)_
|
||||
|
||||
```c++
|
||||
template<typename T>
|
||||
class CopyablePersistentTraits {
|
||||
public:
|
||||
typedef Persistent<T, CopyablePersistentTraits<T> > CopyablePersistent;
|
||||
|
||||
static const bool kResetInDestructor = true;
|
||||
|
||||
template<typename S, typename M>
|
||||
static void Copy(const Persistent<S, M> &source,
|
||||
CopyablePersistent *dest);
|
||||
};
|
||||
```
|
||||
|
||||
See the V8 documentation for [`CopyablePersistentTraits`](https://v8docs.nodesource.com/io.js-3.0/da/d5c/structv8_1_1_copyable_persistent_traits.html) for further information.
|
||||
|
||||
<a name="api_nan_persistent"></a>
|
||||
### Nan::Persistent
|
||||
|
||||
A type of `PersistentBase` which allows copy and assignment. Copy, assignment and destructor behavior is controlled by the traits class `M`.
|
||||
|
||||
Definition:
|
||||
|
||||
```c++
|
||||
template<typename T, typename M = NonCopyablePersistentTraits<T> >
|
||||
class Persistent;
|
||||
|
||||
template<typename T, typename M> class Persistent : public PersistentBase<T> {
|
||||
public:
|
||||
/**
|
||||
* A Persistent with no storage cell.
|
||||
*/
|
||||
Persistent();
|
||||
|
||||
/**
|
||||
* Construct a Persistent from a v8::Local. When the v8::Local is non-empty, a
|
||||
* new storage cell is created pointing to the same object, and no flags are
|
||||
* set.
|
||||
*/
|
||||
template<typename S> Persistent(v8::Local<S> that);
|
||||
|
||||
/**
|
||||
* Construct a Persistent from a Persistent. When the Persistent is non-empty,
|
||||
* a new storage cell is created pointing to the same object, and no flags are
|
||||
* set.
|
||||
*/
|
||||
Persistent(const Persistent &that);
|
||||
|
||||
/**
|
||||
* The copy constructors and assignment operator create a Persistent exactly
|
||||
* as the Persistent constructor, but the Copy function from the traits class
|
||||
* is called, allowing the setting of flags based on the copied Persistent.
|
||||
*/
|
||||
Persistent &operator=(const Persistent &that);
|
||||
|
||||
template <typename S, typename M2>
|
||||
Persistent &operator=(const Persistent<S, M2> &that);
|
||||
|
||||
/**
|
||||
* The destructor will dispose the Persistent based on the kResetInDestructor
|
||||
* flags in the traits class. Since not calling dispose can result in a
|
||||
* memory leak, it is recommended to always set this flag.
|
||||
*/
|
||||
~Persistent();
|
||||
};
|
||||
```
|
||||
|
||||
See the V8 documentation for [`Persistent`](https://v8docs.nodesource.com/io.js-3.0/d2/d78/classv8_1_1_persistent.html) for further information.
|
||||
|
||||
<a name="api_nan_global"></a>
|
||||
### Nan::Global
|
||||
|
||||
A type of `PersistentBase` which has move semantics.
|
||||
|
||||
```c++
|
||||
template<typename T> class Global : public PersistentBase<T> {
|
||||
public:
|
||||
/**
|
||||
* A Global with no storage cell.
|
||||
*/
|
||||
Global();
|
||||
|
||||
/**
|
||||
* Construct a Global from a v8::Local. When the v8::Local is non-empty, a new
|
||||
* storage cell is created pointing to the same object, and no flags are set.
|
||||
*/
|
||||
template<typename S> Global(v8::Local<S> that);
|
||||
/**
|
||||
* Construct a Global from a PersistentBase. When the Persistent is non-empty,
|
||||
* a new storage cell is created pointing to the same object, and no flags are
|
||||
* set.
|
||||
*/
|
||||
template<typename S> Global(const PersistentBase<S> &that);
|
||||
|
||||
/**
|
||||
* Pass allows returning globals from functions, etc.
|
||||
*/
|
||||
Global Pass();
|
||||
};
|
||||
```
|
||||
|
||||
See the V8 documentation for [`Global`](https://v8docs.nodesource.com/io.js-3.0/d5/d40/classv8_1_1_global.html) for further information.
|
||||
|
||||
<a name="api_nan_weak_callback_type"></a>
|
||||
### Nan::WeakCallbackType
|
||||
|
||||
<a name="api_nan_weak_callback_info"></a>
|
||||
### Nan::WeakCallbackInfo
|
||||
|
||||
`Nan::WeakCallbackInfo` is used as an argument when setting a persistent reference as weak. You may need to free any external resources attached to the object. It is a mirror of `v8:WeakCallbackInfo` as found in newer versions of V8.
|
||||
|
||||
Definition:
|
||||
|
||||
```c++
|
||||
template<typename T> class WeakCallbackInfo {
|
||||
public:
|
||||
typedef void (*Callback)(const WeakCallbackInfo<T>& data);
|
||||
|
||||
v8::Isolate *GetIsolate() const;
|
||||
|
||||
/**
|
||||
* Get the parameter that was associated with the weak handle.
|
||||
*/
|
||||
T *GetParameter() const;
|
||||
|
||||
/**
|
||||
* Get pointer from internal field, index can be 0 or 1.
|
||||
*/
|
||||
void *GetInternalField(int index) const;
|
||||
};
|
||||
```
|
||||
|
||||
Example usage:
|
||||
|
||||
```c++
|
||||
void weakCallback(const WeakCallbackInfo<int> &data) {
|
||||
int *parameter = data.GetParameter();
|
||||
delete parameter;
|
||||
}
|
||||
|
||||
Persistent<v8::Object> obj;
|
||||
int *data = new int(0);
|
||||
obj.SetWeak(data, callback, WeakCallbackType::kParameter);
|
||||
```
|
||||
|
||||
See the V8 documentation for [`WeakCallbackInfo`](https://v8docs.nodesource.com/io.js-3.0/d8/d06/classv8_1_1_weak_callback_info.html) for further information.
|
||||
|
||||
<a name="api_nan_weak_callback_type"></a>
|
||||
### Nan::WeakCallbackType
|
||||
|
||||
Represents the type of a weak callback.
|
||||
A weak callback of type `kParameter` makes the supplied parameter to `Nan::PersistentBase::SetWeak` available through `WeakCallbackInfo::GetParameter`.
|
||||
A weak callback of type `kInternalFields` uses up to two internal fields at indices 0 and 1 on the `Nan::PersistentBase<v8::Object>` being made weak.
|
||||
Note that only `v8::Object`s and derivatives can have internal fields.
|
||||
|
||||
Definition:
|
||||
|
||||
```c++
|
||||
enum class WeakCallbackType { kParameter, kInternalFields };
|
||||
```
|
||||
+73
@@ -0,0 +1,73 @@
|
||||
## Scopes
|
||||
|
||||
A _local handle_ is a pointer to an object. All V8 objects are accessed using handles, they are necessary because of the way the V8 garbage collector works.
|
||||
|
||||
A handle scope can be thought of as a container for any number of handles. When you've finished with your handles, instead of deleting each one individually you can simply delete their scope.
|
||||
|
||||
The creation of `HandleScope` objects is different across the supported versions of V8. Therefore, NAN provides its own implementations that can be used safely across these.
|
||||
|
||||
- <a href="#api_nan_handle_scope"><b><code>Nan::HandleScope</code></b></a>
|
||||
- <a href="#api_nan_escapable_handle_scope"><b><code>Nan::EscapableHandleScope</code></b></a>
|
||||
|
||||
Also see the V8 Embedders Guide section on [Handles and Garbage Collection](https://developers.google.com/v8/embed#handles).
|
||||
|
||||
<a name="api_nan_handle_scope"></a>
|
||||
### Nan::HandleScope
|
||||
|
||||
A simple wrapper around [`v8::HandleScope`](https://v8docs.nodesource.com/io.js-3.0/d3/d95/classv8_1_1_handle_scope.html).
|
||||
|
||||
Definition:
|
||||
|
||||
```c++
|
||||
class Nan::HandleScope {
|
||||
public:
|
||||
Nan::HandleScope();
|
||||
static int NumberOfHandles();
|
||||
};
|
||||
```
|
||||
|
||||
Allocate a new `Nan::HandleScope` whenever you are creating new V8 JavaScript objects. Note that an implicit `HandleScope` is created for you on JavaScript-accessible methods so you do not need to insert one yourself.
|
||||
|
||||
Example:
|
||||
|
||||
```c++
|
||||
// new object is created, it needs a new scope:
|
||||
void Pointless() {
|
||||
Nan::HandleScope scope;
|
||||
v8::Local<v8::Object> obj = Nan::New<v8::Object>();
|
||||
}
|
||||
|
||||
// JavaScript-accessible method already has a HandleScope
|
||||
NAN_METHOD(Pointless2) {
|
||||
v8::Local<v8::Object> obj = Nan::New<v8::Object>();
|
||||
}
|
||||
```
|
||||
|
||||
<a name="api_nan_escapable_handle_scope"></a>
|
||||
### Nan::EscapableHandleScope
|
||||
|
||||
Similar to [`Nan::HandleScope`](#api_nan_handle_scope) but should be used in cases where a function needs to return a V8 JavaScript type that has been created within it.
|
||||
|
||||
Definition:
|
||||
|
||||
```c++
|
||||
class Nan::EscapableHandleScope {
|
||||
public:
|
||||
Nan::EscapableHandleScope();
|
||||
static int NumberOfHandles();
|
||||
template<typename T> v8::Local<T> Escape(v8::Local<T> value);
|
||||
}
|
||||
```
|
||||
|
||||
Use `Escape(value)` to return the object.
|
||||
|
||||
Example:
|
||||
|
||||
```c++
|
||||
v8::Local<v8::Object> EmptyObj() {
|
||||
Nan::EscapableHandleScope scope;
|
||||
v8::Local<v8::Object> obj = Nan::New<v8::Object>();
|
||||
return scope.Escape(obj);
|
||||
}
|
||||
```
|
||||
|
||||
+38
@@ -0,0 +1,38 @@
|
||||
## Script
|
||||
|
||||
NAN provides a `v8::Script` helpers as the API has changed over the supported versions of V8.
|
||||
|
||||
- <a href="#api_nan_compile_script"><b><code>Nan::CompileScript()</code></b></a>
|
||||
- <a href="#api_nan_run_script"><b><code>Nan::RunScript()</code></b></a>
|
||||
|
||||
|
||||
<a name="api_nan_compile_script"></a>
|
||||
### Nan::CompileScript()
|
||||
|
||||
A wrapper around [`v8::Script::Compile()`](https://v8docs.nodesource.com/io.js-3.0/da/da5/classv8_1_1_script_compiler.html#a93f5072a0db55d881b969e9fc98e564b).
|
||||
|
||||
Note that `Nan::BoundScript` is an alias for `v8::Script`.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::MaybeLocal<Nan::BoundScript> Nan::CompileScript(
|
||||
v8::Local<v8::String> s,
|
||||
const v8::ScriptOrigin& origin);
|
||||
Nan::MaybeLocal<Nan::BoundScript> Nan::CompileScript(v8::Local<v8::String> s);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_run_script"></a>
|
||||
### Nan::RunScript()
|
||||
|
||||
Calls `script->Run()` or `script->BindToCurrentContext()->Run(Nan::GetCurrentContext())`.
|
||||
|
||||
Note that `Nan::BoundScript` is an alias for `v8::Script` and `Nan::UnboundScript` is an alias for `v8::UnboundScript` where available and `v8::Script` on older versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
Nan::MaybeLocal<v8::Value> Nan::RunScript(v8::Local<Nan::UnboundScript> script)
|
||||
Nan::MaybeLocal<v8::Value> Nan::RunScript(v8::Local<Nan::BoundScript> script)
|
||||
```
|
||||
+62
@@ -0,0 +1,62 @@
|
||||
## Strings & Bytes
|
||||
|
||||
Miscellaneous string & byte encoding and decoding functionality provided for compatibility across supported versions of V8 and Node. Implemented by NAN to ensure that all encoding types are supported, even for older versions of Node where they are missing.
|
||||
|
||||
- <a href="#api_nan_encoding"><b><code>Nan::Encoding</code></b></a>
|
||||
- <a href="#api_nan_encode"><b><code>Nan::Encode()</code></b></a>
|
||||
- <a href="#api_nan_decode_bytes"><b><code>Nan::DecodeBytes()</code></b></a>
|
||||
- <a href="#api_nan_decode_write"><b><code>Nan::DecodeWrite()</code></b></a>
|
||||
|
||||
|
||||
<a name="api_nan_encoding"></a>
|
||||
### Nan::Encoding
|
||||
|
||||
An enum representing the supported encoding types. A copy of `node::encoding` that is consistent across versions of Node.
|
||||
|
||||
Definition:
|
||||
|
||||
```c++
|
||||
enum Nan::Encoding { ASCII, UTF8, BASE64, UCS2, BINARY, HEX, BUFFER }
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_encode"></a>
|
||||
### Nan::Encode()
|
||||
|
||||
A wrapper around `node::Encode()` that provides a consistent implementation across supported versions of Node.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
v8::Local<v8::Value> Nan::Encode(const void *buf,
|
||||
size_t len,
|
||||
enum Nan::Encoding encoding = BINARY);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_decode_bytes"></a>
|
||||
### Nan::DecodeBytes()
|
||||
|
||||
A wrapper around `node::DecodeBytes()` that provides a consistent implementation across supported versions of Node.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
ssize_t Nan::DecodeBytes(v8::Local<v8::Value> val,
|
||||
enum Nan::Encoding encoding = BINARY);
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_decode_write"></a>
|
||||
### Nan::DecodeWrite()
|
||||
|
||||
A wrapper around `node::DecodeWrite()` that provides a consistent implementation across supported versions of Node.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
ssize_t Nan::DecodeWrite(char *buf,
|
||||
size_t len,
|
||||
v8::Local<v8::Value> val,
|
||||
enum Nan::Encoding encoding = BINARY);
|
||||
```
|
||||
+199
@@ -0,0 +1,199 @@
|
||||
## V8 internals
|
||||
|
||||
The hooks to access V8 internals—including GC and statistics—are different across the supported versions of V8, therefore NAN provides its own hooks that call the appropriate V8 methods.
|
||||
|
||||
- <a href="#api_nan_gc_callback"><b><code>NAN_GC_CALLBACK()</code></b></a>
|
||||
- <a href="#api_nan_add_gc_epilogue_callback"><b><code>Nan::AddGCEpilogueCallback()</code></b></a>
|
||||
- <a href="#api_nan_remove_gc_epilogue_callback"><b><code>Nan::RemoveGCEpilogueCallback()</code></b></a>
|
||||
- <a href="#api_nan_add_gc_prologue_callback"><b><code>Nan::AddGCPrologueCallback()</code></b></a>
|
||||
- <a href="#api_nan_remove_gc_prologue_callback"><b><code>Nan::RemoveGCPrologueCallback()</code></b></a>
|
||||
- <a href="#api_nan_get_heap_statistics"><b><code>Nan::GetHeapStatistics()</code></b></a>
|
||||
- <a href="#api_nan_set_counter_function"><b><code>Nan::SetCounterFunction()</code></b></a>
|
||||
- <a href="#api_nan_set_create_histogram_function"><b><code>Nan::SetCreateHistogramFunction()</code></b></a>
|
||||
- <a href="#api_nan_set_add_histogram_sample_function"><b><code>Nan::SetAddHistogramSampleFunction()</code></b></a>
|
||||
- <a href="#api_nan_idle_notification"><b><code>Nan::IdleNotification()</code></b></a>
|
||||
- <a href="#api_nan_low_memory_notification"><b><code>Nan::LowMemoryNotification()</code></b></a>
|
||||
- <a href="#api_nan_context_disposed_notification"><b><code>Nan::ContextDisposedNotification()</code></b></a>
|
||||
- <a href="#api_nan_get_internal_field_pointer"><b><code>Nan::GetInternalFieldPointer()</code></b></a>
|
||||
- <a href="#api_nan_set_internal_field_pointer"><b><code>Nan::SetInternalFieldPointer()</code></b></a>
|
||||
- <a href="#api_nan_adjust_external_memory"><b><code>Nan::AdjustExternalMemory()</code></b></a>
|
||||
|
||||
|
||||
<a name="api_nan_gc_callback"></a>
|
||||
### NAN_GC_CALLBACK(callbackname)
|
||||
|
||||
Use `NAN_GC_CALLBACK` to declare your callbacks for `Nan::AddGCPrologueCallback()` and `Nan::AddGCEpilogueCallback()`. Your new method receives the arguments `v8::GCType type` and `v8::GCCallbackFlags flags`.
|
||||
|
||||
```c++
|
||||
static Nan::Persistent<Function> callback;
|
||||
|
||||
NAN_GC_CALLBACK(gcPrologueCallback) {
|
||||
v8::Local<Value> argv[] = { Nan::New("prologue").ToLocalChecked() };
|
||||
Nan::MakeCallback(Nan::GetCurrentContext()->Global(), Nan::New(callback), 1, argv);
|
||||
}
|
||||
|
||||
NAN_METHOD(Hook) {
|
||||
callback.Reset(args[0].As<Function>());
|
||||
Nan::AddGCPrologueCallback(gcPrologueCallback);
|
||||
info.GetReturnValue().Set(info.Holder());
|
||||
}
|
||||
```
|
||||
|
||||
<a name="api_nan_add_gc_epilogue_callback"></a>
|
||||
### Nan::AddGCEpilogueCallback()
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::AddGCEpilogueCallback(v8::Isolate::GCEpilogueCallback callback, v8::GCType gc_type_filter = v8::kGCTypeAll)
|
||||
```
|
||||
|
||||
Calls V8's [`AddGCEpilogueCallback()`](https://v8docs.nodesource.com/io.js-3.0/d5/dda/classv8_1_1_isolate.html#a90d1860babc76059c62514b422f56960).
|
||||
|
||||
<a name="api_nan_remove_gc_epilogue_callback"></a>
|
||||
### Nan::RemoveGCEpilogueCallback()
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::RemoveGCEpilogueCallback(v8::Isolate::GCEpilogueCallback callback)
|
||||
```
|
||||
|
||||
Calls V8's [`RemoveGCEpilogueCallback()`](https://v8docs.nodesource.com/io.js-3.0/d5/dda/classv8_1_1_isolate.html#a05c60859fd4b8e96bfcd451281ed6c7c).
|
||||
|
||||
<a name="api_nan_add_gc_prologue_callback"></a>
|
||||
### Nan::AddGCPrologueCallback()
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::AddGCPrologueCallback(v8::Isolate::GCPrologueCallback, v8::GCType gc_type_filter callback)
|
||||
```
|
||||
|
||||
Calls V8's [`AddGCPrologueCallback()`](https://v8docs.nodesource.com/io.js-3.0/d5/dda/classv8_1_1_isolate.html#ab4b87b8f9f8e5bf95eba4009357e001f).
|
||||
|
||||
<a name="api_nan_remove_gc_prologue_callback"></a>
|
||||
### Nan::RemoveGCPrologueCallback()
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::RemoveGCPrologueCallback(v8::Isolate::GCPrologueCallback callback)
|
||||
```
|
||||
|
||||
Calls V8's [`RemoveGCEpilogueCallback()`](https://v8docs.nodesource.com/io.js-3.0/d5/dda/classv8_1_1_isolate.html#a9f6c51932811593f81ff30b949124186).
|
||||
|
||||
<a name="api_nan_get_heap_statistics"></a>
|
||||
### Nan::GetHeapStatistics()
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::GetHeapStatistics(v8::HeapStatistics *heap_statistics)
|
||||
```
|
||||
|
||||
Calls V8's [`GetHeapStatistics()`](https://v8docs.nodesource.com/io.js-3.0/d5/dda/classv8_1_1_isolate.html#a5593ac74687b713095c38987e5950b34).
|
||||
|
||||
<a name="api_nan_set_counter_function"></a>
|
||||
### Nan::SetCounterFunction()
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::SetCounterFunction(v8::CounterLookupCallback cb)
|
||||
```
|
||||
|
||||
Calls V8's [`SetCounterFunction()`](https://v8docs.nodesource.com/io.js-3.0/d5/dda/classv8_1_1_isolate.html#a045d7754e62fa0ec72ae6c259b29af94).
|
||||
|
||||
<a name="api_nan_set_create_histogram_function"></a>
|
||||
### Nan::SetCreateHistogramFunction()
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::SetCreateHistogramFunction(v8::CreateHistogramCallback cb)
|
||||
```
|
||||
|
||||
Calls V8's [`SetCreateHistogramFunction()`](https://v8docs.nodesource.com/io.js-3.0/d5/dda/classv8_1_1_isolate.html#a542d67e85089cb3f92aadf032f99e732).
|
||||
|
||||
<a name="api_nan_set_add_histogram_sample_function"></a>
|
||||
### Nan::SetAddHistogramSampleFunction()
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::SetAddHistogramSampleFunction(v8::AddHistogramSampleCallback cb)
|
||||
```
|
||||
|
||||
Calls V8's [`SetAddHistogramSampleFunction()`](https://v8docs.nodesource.com/io.js-3.0/d5/dda/classv8_1_1_isolate.html#aeb420b690bc2c216882d6fdd00ddd3ea).
|
||||
|
||||
<a name="api_nan_idle_notification"></a>
|
||||
### Nan::IdleNotification()
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::IdleNotification(v8::HeapStatistics *heap_statistics)
|
||||
```
|
||||
|
||||
Calls V8's [`IdleNotification()` or `IdleNotificationDeadline()`](https://v8docs.nodesource.com/io.js-3.0/d5/dda/classv8_1_1_isolate.html#ad6a2a02657f5425ad460060652a5a118) depending on V8 version.
|
||||
|
||||
<a name="api_nan_low_memory_notification"></a>
|
||||
### Nan::LowMemoryNotification()
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::LowMemoryNotification()
|
||||
```
|
||||
|
||||
Calls V8's [`IdleNotification()`](https://v8docs.nodesource.com/io.js-3.0/d5/dda/classv8_1_1_isolate.html#a24647f61d6b41f69668094bdcd6ea91f).
|
||||
|
||||
<a name="api_nan_context_disposed_notification"></a>
|
||||
### Nan::ContextDisposedNotification()
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::ContextDisposedNotification()
|
||||
```
|
||||
|
||||
Calls V8's [`ContextDisposedNotification()`](https://v8docs.nodesource.com/io.js-3.0/d5/dda/classv8_1_1_isolate.html#ad7f5dc559866343fe6cd8db1f134d48b).
|
||||
|
||||
<a name="api_nan_get_internal_field_pointer"></a>
|
||||
### Nan::GetInternalFieldPointer()
|
||||
|
||||
Gets a pointer to the internal field with at `index` from a V8 `Object` handle.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void* Nan::GetInternalFieldPointer(v8::Local<v8::Object> object, int index)
|
||||
```
|
||||
|
||||
Calls the Object's [`GetAlignedPointerFromInternalField()` or `GetPointerFromInternalField()`](https://v8docs.nodesource.com/io.js-3.0/db/d85/classv8_1_1_object.html#ab3c57184263cf29963ef0017bec82281) depending on the version of V8.
|
||||
|
||||
<a name="api_nan_set_internal_field_pointer"></a>
|
||||
### Nan::SetInternalFieldPointer()
|
||||
|
||||
Sets the value of the internal field at `index` on a V8 `Object` handle.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::SetInternalFieldPointer(v8::Local<v8::Object> object, int index, void* value)
|
||||
```
|
||||
|
||||
Calls the Object's [`SetAlignedPointerInInternalField()` or `SetPointerInInternalField()`](https://v8docs.nodesource.com/io.js-3.0/d5/dda/classv8_1_1_isolate.html#ad7f5dc559866343fe6cd8db1f134d48b) depending on the version of V8.
|
||||
|
||||
<a name="api_nan_adjust_external_memory"></a>
|
||||
### Nan::AdjustExternalMemory()
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
int Nan::AdjustExternalMemory(int bytesChange)
|
||||
```
|
||||
|
||||
Calls V8's [`AdjustAmountOfExternalAllocatedMemory()` or `AdjustAmountOfExternalAllocatedMemory()`](https://v8docs.nodesource.com/io.js-3.0/d5/dda/classv8_1_1_isolate.html#ae1a59cac60409d3922582c4af675473e) depending on the version of V8.
|
||||
|
||||
+63
@@ -0,0 +1,63 @@
|
||||
## Miscellaneous V8 Helpers
|
||||
|
||||
- <a href="#api_nan_utf8_string"><b><code>Nan::Utf8String</code></b></a>
|
||||
- <a href="#api_nan_get_current_context"><b><code>Nan::GetCurrentContext()</code></b></a>
|
||||
- <a href="#api_nan_set_isolate_data"><b><code>Nan::SetIsolateData()</code></b></a>
|
||||
- <a href="#api_nan_get_isolate_data"><b><code>Nan::GetIsolateData()</code></b></a>
|
||||
|
||||
|
||||
<a name="api_nan_utf8_string"></a>
|
||||
### Nan::Utf8String
|
||||
|
||||
Converts an object to a UTF-8-encoded character array. If conversion to a string fails (e.g. due to an exception in the toString() method of the object) then the length() method returns 0 and the * operator returns NULL. The underlying memory used for this object is managed by the object.
|
||||
|
||||
An implementation of [`v8::String::Utf8Value`](https://v8docs.nodesource.com/io.js-3.0/d4/d1b/classv8_1_1_string_1_1_utf8_value.html) that is consistent across all supported versions of V8.
|
||||
|
||||
Definition:
|
||||
|
||||
```c++
|
||||
class Nan::Utf8String {
|
||||
public:
|
||||
Nan::Utf8String(v8::Local<v8::Value> from);
|
||||
|
||||
int length() const;
|
||||
|
||||
char* operator*();
|
||||
const char* operator*() const;
|
||||
};
|
||||
```
|
||||
|
||||
<a name="api_nan_get_current_context"></a>
|
||||
### Nan::GetCurrentContext()
|
||||
|
||||
A call to [`v8::Isolate::GetCurrent()->GetCurrentContext()`](https://v8docs.nodesource.com/io.js-3.0/d5/dda/classv8_1_1_isolate.html#a81c7a1ed7001ae2a65e89107f75fd053) that works across all supported versions of V8.
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
v8::Local<v8::Context> Nan::GetCurrentContext()
|
||||
```
|
||||
|
||||
<a name="api_nan_set_isolate_data"></a>
|
||||
### Nan::SetIsolateData()
|
||||
|
||||
A helper to provide a consistent API to [`v8::Isolate#SetData()`](https://v8docs.nodesource.com/io.js-3.0/d5/dda/classv8_1_1_isolate.html#a7acadfe7965997e9c386a05f098fbe36).
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
void Nan::SetIsolateData(v8::Isolate *isolate, T *data)
|
||||
```
|
||||
|
||||
|
||||
<a name="api_nan_get_isolate_data"></a>
|
||||
### Nan::GetIsolateData()
|
||||
|
||||
A helper to provide a consistent API to [`v8::Isolate#GetData()`](https://v8docs.nodesource.com/io.js-3.0/d5/dda/classv8_1_1_isolate.html#aabd223436bc1100a787dadaa024c6257).
|
||||
|
||||
Signature:
|
||||
|
||||
```c++
|
||||
T *Nan::GetIsolateData(v8::Isolate *isolate)
|
||||
```
|
||||
|
||||
+1
@@ -0,0 +1 @@
|
||||
console.log(require('path').relative('.', __dirname));
|
||||
+2136
File diff suppressed because it is too large
Load Diff
+88
@@ -0,0 +1,88 @@
|
||||
/*********************************************************************
|
||||
* NAN - Native Abstractions for Node.js
|
||||
*
|
||||
* Copyright (c) 2015 NAN contributors
|
||||
*
|
||||
* MIT License <https://github.com/nodejs/nan/blob/master/LICENSE.md>
|
||||
********************************************************************/
|
||||
|
||||
#ifndef NAN_CALLBACKS_H_
|
||||
#define NAN_CALLBACKS_H_
|
||||
|
||||
template<typename T> class FunctionCallbackInfo;
|
||||
template<typename T> class PropertyCallbackInfo;
|
||||
template<typename T> class Global;
|
||||
|
||||
typedef void(*FunctionCallback)(const FunctionCallbackInfo<v8::Value>&);
|
||||
typedef void(*GetterCallback)
|
||||
(v8::Local<v8::String>, const PropertyCallbackInfo<v8::Value>&);
|
||||
typedef void(*SetterCallback)(
|
||||
v8::Local<v8::String>,
|
||||
v8::Local<v8::Value>,
|
||||
const PropertyCallbackInfo<void>&);
|
||||
typedef void(*PropertyGetterCallback)(
|
||||
v8::Local<v8::String>,
|
||||
const PropertyCallbackInfo<v8::Value>&);
|
||||
typedef void(*PropertySetterCallback)(
|
||||
v8::Local<v8::String>,
|
||||
v8::Local<v8::Value>,
|
||||
const PropertyCallbackInfo<v8::Value>&);
|
||||
typedef void(*PropertyEnumeratorCallback)
|
||||
(const PropertyCallbackInfo<v8::Array>&);
|
||||
typedef void(*PropertyDeleterCallback)(
|
||||
v8::Local<v8::String>,
|
||||
const PropertyCallbackInfo<v8::Boolean>&);
|
||||
typedef void(*PropertyQueryCallback)(
|
||||
v8::Local<v8::String>,
|
||||
const PropertyCallbackInfo<v8::Integer>&);
|
||||
typedef void(*IndexGetterCallback)(
|
||||
uint32_t,
|
||||
const PropertyCallbackInfo<v8::Value>&);
|
||||
typedef void(*IndexSetterCallback)(
|
||||
uint32_t,
|
||||
v8::Local<v8::Value>,
|
||||
const PropertyCallbackInfo<v8::Value>&);
|
||||
typedef void(*IndexEnumeratorCallback)
|
||||
(const PropertyCallbackInfo<v8::Array>&);
|
||||
typedef void(*IndexDeleterCallback)(
|
||||
uint32_t,
|
||||
const PropertyCallbackInfo<v8::Boolean>&);
|
||||
typedef void(*IndexQueryCallback)(
|
||||
uint32_t,
|
||||
const PropertyCallbackInfo<v8::Integer>&);
|
||||
|
||||
namespace imp {
|
||||
typedef v8::Local<v8::AccessorSignature> Sig;
|
||||
|
||||
static const int kDataIndex = 0;
|
||||
|
||||
static const int kFunctionIndex = 1;
|
||||
static const int kFunctionFieldCount = 2;
|
||||
|
||||
static const int kGetterIndex = 1;
|
||||
static const int kSetterIndex = 2;
|
||||
static const int kAccessorFieldCount = 3;
|
||||
|
||||
static const int kPropertyGetterIndex = 1;
|
||||
static const int kPropertySetterIndex = 2;
|
||||
static const int kPropertyEnumeratorIndex = 3;
|
||||
static const int kPropertyDeleterIndex = 4;
|
||||
static const int kPropertyQueryIndex = 5;
|
||||
static const int kPropertyFieldCount = 6;
|
||||
|
||||
static const int kIndexPropertyGetterIndex = 1;
|
||||
static const int kIndexPropertySetterIndex = 2;
|
||||
static const int kIndexPropertyEnumeratorIndex = 3;
|
||||
static const int kIndexPropertyDeleterIndex = 4;
|
||||
static const int kIndexPropertyQueryIndex = 5;
|
||||
static const int kIndexPropertyFieldCount = 6;
|
||||
|
||||
} // end of namespace imp
|
||||
|
||||
#if NODE_MODULE_VERSION > NODE_0_10_MODULE_VERSION
|
||||
# include "nan_callbacks_12_inl.h" // NOLINT(build/include)
|
||||
#else
|
||||
# include "nan_callbacks_pre_12_inl.h" // NOLINT(build/include)
|
||||
#endif
|
||||
|
||||
#endif // NAN_CALLBACKS_H_
|
||||
+512
@@ -0,0 +1,512 @@
|
||||
/*********************************************************************
|
||||
* NAN - Native Abstractions for Node.js
|
||||
*
|
||||
* Copyright (c) 2015 NAN contributors
|
||||
*
|
||||
* MIT License <https://github.com/nodejs/nan/blob/master/LICENSE.md>
|
||||
********************************************************************/
|
||||
|
||||
#ifndef NAN_CALLBACKS_12_INL_H_
|
||||
#define NAN_CALLBACKS_12_INL_H_
|
||||
|
||||
template<typename T>
|
||||
class ReturnValue {
|
||||
v8::ReturnValue<T> value_;
|
||||
|
||||
public:
|
||||
template <class S>
|
||||
explicit inline ReturnValue(const v8::ReturnValue<S> &value) :
|
||||
value_(value) {}
|
||||
template <class S>
|
||||
explicit inline ReturnValue(const ReturnValue<S>& that)
|
||||
: value_(that.value_) {
|
||||
TYPE_CHECK(T, S);
|
||||
}
|
||||
|
||||
// Handle setters
|
||||
template <typename S> inline void Set(const v8::Local<S> &handle) {
|
||||
TYPE_CHECK(T, S);
|
||||
value_.Set(handle);
|
||||
}
|
||||
|
||||
template <typename S> inline void Set(const Global<S> &handle) {
|
||||
TYPE_CHECK(T, S);
|
||||
#if defined(V8_MAJOR_VERSION) && (V8_MAJOR_VERSION > 4 || \
|
||||
(V8_MAJOR_VERSION == 4 && defined(V8_MINOR_VERSION) && \
|
||||
(V8_MINOR_VERSION > 5 || (V8_MINOR_VERSION == 5 && \
|
||||
defined(V8_BUILD_NUMBER) && V8_BUILD_NUMBER >= 8))))
|
||||
value_.Set(handle);
|
||||
#else
|
||||
value_.Set(*reinterpret_cast<const v8::Persistent<S>*>(&handle));
|
||||
const_cast<Global<S> &>(handle).Reset();
|
||||
#endif
|
||||
}
|
||||
|
||||
// Fast primitive setters
|
||||
inline void Set(bool value) {
|
||||
TYPE_CHECK(T, v8::Boolean);
|
||||
value_.Set(value);
|
||||
}
|
||||
|
||||
inline void Set(double i) {
|
||||
TYPE_CHECK(T, v8::Number);
|
||||
value_.Set(i);
|
||||
}
|
||||
|
||||
inline void Set(int32_t i) {
|
||||
TYPE_CHECK(T, v8::Integer);
|
||||
value_.Set(i);
|
||||
}
|
||||
|
||||
inline void Set(uint32_t i) {
|
||||
TYPE_CHECK(T, v8::Integer);
|
||||
value_.Set(i);
|
||||
}
|
||||
|
||||
// Fast JS primitive setters
|
||||
inline void SetNull() {
|
||||
TYPE_CHECK(T, v8::Primitive);
|
||||
value_.SetNull();
|
||||
}
|
||||
|
||||
inline void SetUndefined() {
|
||||
TYPE_CHECK(T, v8::Primitive);
|
||||
value_.SetUndefined();
|
||||
}
|
||||
|
||||
inline void SetEmptyString() {
|
||||
TYPE_CHECK(T, v8::String);
|
||||
value_.SetEmptyString();
|
||||
}
|
||||
|
||||
// Convenience getter for isolate
|
||||
inline v8::Isolate *GetIsolate() const {
|
||||
return value_.GetIsolate();
|
||||
}
|
||||
|
||||
// Pointer setter: Uncompilable to prevent inadvertent misuse.
|
||||
template<typename S>
|
||||
inline void Set(S *whatever) { TYPE_CHECK(S*, v8::Primitive); }
|
||||
};
|
||||
|
||||
template<typename T>
|
||||
class FunctionCallbackInfo {
|
||||
const v8::FunctionCallbackInfo<T> &info_;
|
||||
const v8::Local<v8::Value> data_;
|
||||
|
||||
public:
|
||||
explicit inline FunctionCallbackInfo(
|
||||
const v8::FunctionCallbackInfo<T> &info
|
||||
, v8::Local<v8::Value> data) :
|
||||
info_(info)
|
||||
, data_(data) {}
|
||||
|
||||
inline ReturnValue<T> GetReturnValue() const {
|
||||
return ReturnValue<T>(info_.GetReturnValue());
|
||||
}
|
||||
|
||||
inline v8::Local<v8::Function> Callee() const { return info_.Callee(); }
|
||||
inline v8::Local<v8::Value> Data() const { return data_; }
|
||||
inline v8::Local<v8::Object> Holder() const { return info_.Holder(); }
|
||||
inline bool IsConstructCall() const { return info_.IsConstructCall(); }
|
||||
inline int Length() const { return info_.Length(); }
|
||||
inline v8::Local<v8::Value> operator[](int i) const { return info_[i]; }
|
||||
inline v8::Local<v8::Object> This() const { return info_.This(); }
|
||||
inline v8::Isolate *GetIsolate() const { return info_.GetIsolate(); }
|
||||
|
||||
|
||||
protected:
|
||||
static const int kHolderIndex = 0;
|
||||
static const int kIsolateIndex = 1;
|
||||
static const int kReturnValueDefaultValueIndex = 2;
|
||||
static const int kReturnValueIndex = 3;
|
||||
static const int kDataIndex = 4;
|
||||
static const int kCalleeIndex = 5;
|
||||
static const int kContextSaveIndex = 6;
|
||||
static const int kArgsLength = 7;
|
||||
|
||||
private:
|
||||
NAN_DISALLOW_ASSIGN_COPY_MOVE(FunctionCallbackInfo)
|
||||
};
|
||||
|
||||
template<typename T>
|
||||
class PropertyCallbackInfo {
|
||||
const v8::PropertyCallbackInfo<T> &info_;
|
||||
const v8::Local<v8::Value> data_;
|
||||
|
||||
public:
|
||||
explicit inline PropertyCallbackInfo(
|
||||
const v8::PropertyCallbackInfo<T> &info
|
||||
, const v8::Local<v8::Value> &data) :
|
||||
info_(info)
|
||||
, data_(data) {}
|
||||
|
||||
inline v8::Isolate* GetIsolate() const { return info_.GetIsolate(); }
|
||||
inline v8::Local<v8::Value> Data() const { return data_; }
|
||||
inline v8::Local<v8::Object> This() const { return info_.This(); }
|
||||
inline v8::Local<v8::Object> Holder() const { return info_.Holder(); }
|
||||
inline ReturnValue<T> GetReturnValue() const {
|
||||
return ReturnValue<T>(info_.GetReturnValue());
|
||||
}
|
||||
|
||||
protected:
|
||||
static const int kHolderIndex = 0;
|
||||
static const int kIsolateIndex = 1;
|
||||
static const int kReturnValueDefaultValueIndex = 2;
|
||||
static const int kReturnValueIndex = 3;
|
||||
static const int kDataIndex = 4;
|
||||
static const int kThisIndex = 5;
|
||||
static const int kArgsLength = 6;
|
||||
|
||||
private:
|
||||
NAN_DISALLOW_ASSIGN_COPY_MOVE(PropertyCallbackInfo)
|
||||
};
|
||||
|
||||
namespace imp {
|
||||
static
|
||||
void FunctionCallbackWrapper(const v8::FunctionCallbackInfo<v8::Value> &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
FunctionCallback callback = reinterpret_cast<FunctionCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kFunctionIndex).As<v8::External>()->Value()));
|
||||
FunctionCallbackInfo<v8::Value>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
callback(cbinfo);
|
||||
}
|
||||
|
||||
typedef void (*NativeFunction)(const v8::FunctionCallbackInfo<v8::Value> &);
|
||||
|
||||
#if NODE_MODULE_VERSION > NODE_0_12_MODULE_VERSION
|
||||
static
|
||||
void GetterCallbackWrapper(
|
||||
v8::Local<v8::Name> property
|
||||
, const v8::PropertyCallbackInfo<v8::Value> &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Value>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
GetterCallback callback = reinterpret_cast<GetterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kGetterIndex).As<v8::External>()->Value()));
|
||||
callback(property.As<v8::String>(), cbinfo);
|
||||
}
|
||||
|
||||
typedef void (*NativeGetter)
|
||||
(v8::Local<v8::Name>, const v8::PropertyCallbackInfo<v8::Value> &);
|
||||
|
||||
static
|
||||
void SetterCallbackWrapper(
|
||||
v8::Local<v8::Name> property
|
||||
, v8::Local<v8::Value> value
|
||||
, const v8::PropertyCallbackInfo<void> &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<void>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
SetterCallback callback = reinterpret_cast<SetterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kSetterIndex).As<v8::External>()->Value()));
|
||||
callback(property.As<v8::String>(), value, cbinfo);
|
||||
}
|
||||
|
||||
typedef void (*NativeSetter)(
|
||||
v8::Local<v8::Name>
|
||||
, v8::Local<v8::Value>
|
||||
, const v8::PropertyCallbackInfo<void> &);
|
||||
#else
|
||||
static
|
||||
void GetterCallbackWrapper(
|
||||
v8::Local<v8::String> property
|
||||
, const v8::PropertyCallbackInfo<v8::Value> &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Value>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
GetterCallback callback = reinterpret_cast<GetterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kGetterIndex).As<v8::External>()->Value()));
|
||||
callback(property, cbinfo);
|
||||
}
|
||||
|
||||
typedef void (*NativeGetter)
|
||||
(v8::Local<v8::String>, const v8::PropertyCallbackInfo<v8::Value> &);
|
||||
|
||||
static
|
||||
void SetterCallbackWrapper(
|
||||
v8::Local<v8::String> property
|
||||
, v8::Local<v8::Value> value
|
||||
, const v8::PropertyCallbackInfo<void> &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<void>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
SetterCallback callback = reinterpret_cast<SetterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kSetterIndex).As<v8::External>()->Value()));
|
||||
callback(property, value, cbinfo);
|
||||
}
|
||||
|
||||
typedef void (*NativeSetter)(
|
||||
v8::Local<v8::String>
|
||||
, v8::Local<v8::Value>
|
||||
, const v8::PropertyCallbackInfo<void> &);
|
||||
#endif
|
||||
|
||||
#if NODE_MODULE_VERSION > NODE_0_12_MODULE_VERSION
|
||||
static
|
||||
void PropertyGetterCallbackWrapper(
|
||||
v8::Local<v8::Name> property
|
||||
, const v8::PropertyCallbackInfo<v8::Value> &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Value>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
PropertyGetterCallback callback = reinterpret_cast<PropertyGetterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kPropertyGetterIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(property.As<v8::String>(), cbinfo);
|
||||
}
|
||||
|
||||
typedef void (*NativePropertyGetter)
|
||||
(v8::Local<v8::Name>, const v8::PropertyCallbackInfo<v8::Value> &);
|
||||
|
||||
static
|
||||
void PropertySetterCallbackWrapper(
|
||||
v8::Local<v8::Name> property
|
||||
, v8::Local<v8::Value> value
|
||||
, const v8::PropertyCallbackInfo<v8::Value> &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Value>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
PropertySetterCallback callback = reinterpret_cast<PropertySetterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kPropertySetterIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(property.As<v8::String>(), value, cbinfo);
|
||||
}
|
||||
|
||||
typedef void (*NativePropertySetter)(
|
||||
v8::Local<v8::Name>
|
||||
, v8::Local<v8::Value>
|
||||
, const v8::PropertyCallbackInfo<v8::Value> &);
|
||||
|
||||
static
|
||||
void PropertyEnumeratorCallbackWrapper(
|
||||
const v8::PropertyCallbackInfo<v8::Array> &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Array>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
PropertyEnumeratorCallback callback =
|
||||
reinterpret_cast<PropertyEnumeratorCallback>(reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kPropertyEnumeratorIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(cbinfo);
|
||||
}
|
||||
|
||||
typedef void (*NativePropertyEnumerator)
|
||||
(const v8::PropertyCallbackInfo<v8::Array> &);
|
||||
|
||||
static
|
||||
void PropertyDeleterCallbackWrapper(
|
||||
v8::Local<v8::Name> property
|
||||
, const v8::PropertyCallbackInfo<v8::Boolean> &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Boolean>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
PropertyDeleterCallback callback = reinterpret_cast<PropertyDeleterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kPropertyDeleterIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(property.As<v8::String>(), cbinfo);
|
||||
}
|
||||
|
||||
typedef void (NativePropertyDeleter)
|
||||
(v8::Local<v8::Name>, const v8::PropertyCallbackInfo<v8::Boolean> &);
|
||||
|
||||
static
|
||||
void PropertyQueryCallbackWrapper(
|
||||
v8::Local<v8::Name> property
|
||||
, const v8::PropertyCallbackInfo<v8::Integer> &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Integer>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
PropertyQueryCallback callback = reinterpret_cast<PropertyQueryCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kPropertyQueryIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(property.As<v8::String>(), cbinfo);
|
||||
}
|
||||
|
||||
typedef void (*NativePropertyQuery)
|
||||
(v8::Local<v8::Name>, const v8::PropertyCallbackInfo<v8::Integer> &);
|
||||
#else
|
||||
static
|
||||
void PropertyGetterCallbackWrapper(
|
||||
v8::Local<v8::String> property
|
||||
, const v8::PropertyCallbackInfo<v8::Value> &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Value>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
PropertyGetterCallback callback = reinterpret_cast<PropertyGetterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kPropertyGetterIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(property, cbinfo);
|
||||
}
|
||||
|
||||
typedef void (*NativePropertyGetter)
|
||||
(v8::Local<v8::String>, const v8::PropertyCallbackInfo<v8::Value> &);
|
||||
|
||||
static
|
||||
void PropertySetterCallbackWrapper(
|
||||
v8::Local<v8::String> property
|
||||
, v8::Local<v8::Value> value
|
||||
, const v8::PropertyCallbackInfo<v8::Value> &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Value>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
PropertySetterCallback callback = reinterpret_cast<PropertySetterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kPropertySetterIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(property, value, cbinfo);
|
||||
}
|
||||
|
||||
typedef void (*NativePropertySetter)(
|
||||
v8::Local<v8::String>
|
||||
, v8::Local<v8::Value>
|
||||
, const v8::PropertyCallbackInfo<v8::Value> &);
|
||||
|
||||
static
|
||||
void PropertyEnumeratorCallbackWrapper(
|
||||
const v8::PropertyCallbackInfo<v8::Array> &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Array>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
PropertyEnumeratorCallback callback =
|
||||
reinterpret_cast<PropertyEnumeratorCallback>(reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kPropertyEnumeratorIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(cbinfo);
|
||||
}
|
||||
|
||||
typedef void (*NativePropertyEnumerator)
|
||||
(const v8::PropertyCallbackInfo<v8::Array> &);
|
||||
|
||||
static
|
||||
void PropertyDeleterCallbackWrapper(
|
||||
v8::Local<v8::String> property
|
||||
, const v8::PropertyCallbackInfo<v8::Boolean> &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Boolean>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
PropertyDeleterCallback callback = reinterpret_cast<PropertyDeleterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kPropertyDeleterIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(property, cbinfo);
|
||||
}
|
||||
|
||||
typedef void (NativePropertyDeleter)
|
||||
(v8::Local<v8::String>, const v8::PropertyCallbackInfo<v8::Boolean> &);
|
||||
|
||||
static
|
||||
void PropertyQueryCallbackWrapper(
|
||||
v8::Local<v8::String> property
|
||||
, const v8::PropertyCallbackInfo<v8::Integer> &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Integer>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
PropertyQueryCallback callback = reinterpret_cast<PropertyQueryCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kPropertyQueryIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(property, cbinfo);
|
||||
}
|
||||
|
||||
typedef void (*NativePropertyQuery)
|
||||
(v8::Local<v8::String>, const v8::PropertyCallbackInfo<v8::Integer> &);
|
||||
#endif
|
||||
|
||||
static
|
||||
void IndexGetterCallbackWrapper(
|
||||
uint32_t index, const v8::PropertyCallbackInfo<v8::Value> &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Value>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
IndexGetterCallback callback = reinterpret_cast<IndexGetterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kIndexPropertyGetterIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(index, cbinfo);
|
||||
}
|
||||
|
||||
typedef void (*NativeIndexGetter)
|
||||
(uint32_t, const v8::PropertyCallbackInfo<v8::Value> &);
|
||||
|
||||
static
|
||||
void IndexSetterCallbackWrapper(
|
||||
uint32_t index
|
||||
, v8::Local<v8::Value> value
|
||||
, const v8::PropertyCallbackInfo<v8::Value> &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Value>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
IndexSetterCallback callback = reinterpret_cast<IndexSetterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kIndexPropertySetterIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(index, value, cbinfo);
|
||||
}
|
||||
|
||||
typedef void (*NativeIndexSetter)(
|
||||
uint32_t
|
||||
, v8::Local<v8::Value>
|
||||
, const v8::PropertyCallbackInfo<v8::Value> &);
|
||||
|
||||
static
|
||||
void IndexEnumeratorCallbackWrapper(
|
||||
const v8::PropertyCallbackInfo<v8::Array> &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Array>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
IndexEnumeratorCallback callback = reinterpret_cast<IndexEnumeratorCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(
|
||||
kIndexPropertyEnumeratorIndex).As<v8::External>()->Value()));
|
||||
callback(cbinfo);
|
||||
}
|
||||
|
||||
typedef void (*NativeIndexEnumerator)
|
||||
(const v8::PropertyCallbackInfo<v8::Array> &);
|
||||
|
||||
static
|
||||
void IndexDeleterCallbackWrapper(
|
||||
uint32_t index, const v8::PropertyCallbackInfo<v8::Boolean> &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Boolean>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
IndexDeleterCallback callback = reinterpret_cast<IndexDeleterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kIndexPropertyDeleterIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(index, cbinfo);
|
||||
}
|
||||
|
||||
typedef void (*NativeIndexDeleter)
|
||||
(uint32_t, const v8::PropertyCallbackInfo<v8::Boolean> &);
|
||||
|
||||
static
|
||||
void IndexQueryCallbackWrapper(
|
||||
uint32_t index, const v8::PropertyCallbackInfo<v8::Integer> &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Integer>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
IndexQueryCallback callback = reinterpret_cast<IndexQueryCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kIndexPropertyQueryIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(index, cbinfo);
|
||||
}
|
||||
|
||||
typedef void (*NativeIndexQuery)
|
||||
(uint32_t, const v8::PropertyCallbackInfo<v8::Integer> &);
|
||||
} // end of namespace imp
|
||||
|
||||
#endif // NAN_CALLBACKS_12_INL_H_
|
||||
+506
@@ -0,0 +1,506 @@
|
||||
/*********************************************************************
|
||||
* NAN - Native Abstractions for Node.js
|
||||
*
|
||||
* Copyright (c) 2015 NAN contributors
|
||||
*
|
||||
* MIT License <https://github.com/nodejs/nan/blob/master/LICENSE.md>
|
||||
********************************************************************/
|
||||
|
||||
#ifndef NAN_CALLBACKS_PRE_12_INL_H_
|
||||
#define NAN_CALLBACKS_PRE_12_INL_H_
|
||||
|
||||
namespace imp {
|
||||
template<typename T> class ReturnValueImp;
|
||||
} // end of namespace imp
|
||||
|
||||
template<typename T>
|
||||
class ReturnValue {
|
||||
v8::Isolate *isolate_;
|
||||
v8::Persistent<T> *value_;
|
||||
friend class imp::ReturnValueImp<T>;
|
||||
|
||||
public:
|
||||
template <class S>
|
||||
explicit inline ReturnValue(v8::Isolate *isolate, v8::Persistent<S> *p) :
|
||||
isolate_(isolate), value_(p) {}
|
||||
template <class S>
|
||||
explicit inline ReturnValue(const ReturnValue<S>& that)
|
||||
: isolate_(that.isolate_), value_(that.value_) {
|
||||
TYPE_CHECK(T, S);
|
||||
}
|
||||
|
||||
// Handle setters
|
||||
template <typename S> inline void Set(const v8::Local<S> &handle) {
|
||||
TYPE_CHECK(T, S);
|
||||
value_->Dispose();
|
||||
*value_ = v8::Persistent<T>::New(handle);
|
||||
}
|
||||
|
||||
template <typename S> inline void Set(const Global<S> &handle) {
|
||||
TYPE_CHECK(T, S);
|
||||
value_->Dispose();
|
||||
*value_ = v8::Persistent<T>::New(handle.persistent);
|
||||
const_cast<Global<S> &>(handle).Reset();
|
||||
}
|
||||
|
||||
// Fast primitive setters
|
||||
inline void Set(bool value) {
|
||||
TYPE_CHECK(T, v8::Boolean);
|
||||
value_->Dispose();
|
||||
*value_ = v8::Persistent<T>::New(v8::Boolean::New(value));
|
||||
}
|
||||
|
||||
inline void Set(double i) {
|
||||
TYPE_CHECK(T, v8::Number);
|
||||
value_->Dispose();
|
||||
*value_ = v8::Persistent<T>::New(v8::Number::New(i));
|
||||
}
|
||||
|
||||
inline void Set(int32_t i) {
|
||||
TYPE_CHECK(T, v8::Integer);
|
||||
value_->Dispose();
|
||||
*value_ = v8::Persistent<T>::New(v8::Int32::New(i));
|
||||
}
|
||||
|
||||
inline void Set(uint32_t i) {
|
||||
TYPE_CHECK(T, v8::Integer);
|
||||
value_->Dispose();
|
||||
*value_ = v8::Persistent<T>::New(v8::Uint32::New(i));
|
||||
}
|
||||
|
||||
// Fast JS primitive setters
|
||||
inline void SetNull() {
|
||||
TYPE_CHECK(T, v8::Primitive);
|
||||
value_->Dispose();
|
||||
*value_ = v8::Persistent<T>::New(v8::Null());
|
||||
}
|
||||
|
||||
inline void SetUndefined() {
|
||||
TYPE_CHECK(T, v8::Primitive);
|
||||
value_->Dispose();
|
||||
*value_ = v8::Persistent<T>::New(v8::Undefined());
|
||||
}
|
||||
|
||||
inline void SetEmptyString() {
|
||||
TYPE_CHECK(T, v8::String);
|
||||
value_->Dispose();
|
||||
*value_ = v8::Persistent<T>::New(v8::String::Empty());
|
||||
}
|
||||
|
||||
// Convenience getter for isolate
|
||||
inline v8::Isolate *GetIsolate() const {
|
||||
return isolate_;
|
||||
}
|
||||
|
||||
// Pointer setter: Uncompilable to prevent inadvertent misuse.
|
||||
template<typename S>
|
||||
inline void Set(S *whatever) { TYPE_CHECK(S*, v8::Primitive); }
|
||||
};
|
||||
|
||||
template<typename T>
|
||||
class FunctionCallbackInfo {
|
||||
const v8::Arguments &args_;
|
||||
v8::Local<v8::Value> data_;
|
||||
ReturnValue<T> return_value_;
|
||||
v8::Persistent<T> retval_;
|
||||
|
||||
public:
|
||||
explicit inline FunctionCallbackInfo(
|
||||
const v8::Arguments &args
|
||||
, v8::Local<v8::Value> data) :
|
||||
args_(args)
|
||||
, data_(data)
|
||||
, return_value_(args.GetIsolate(), &retval_)
|
||||
, retval_(v8::Persistent<T>::New(v8::Undefined())) {}
|
||||
|
||||
inline ~FunctionCallbackInfo() {
|
||||
retval_.Dispose();
|
||||
retval_.Clear();
|
||||
}
|
||||
|
||||
inline ReturnValue<T> GetReturnValue() const {
|
||||
return ReturnValue<T>(return_value_);
|
||||
}
|
||||
|
||||
inline v8::Local<v8::Function> Callee() const { return args_.Callee(); }
|
||||
inline v8::Local<v8::Value> Data() const { return data_; }
|
||||
inline v8::Local<v8::Object> Holder() const { return args_.Holder(); }
|
||||
inline bool IsConstructCall() const { return args_.IsConstructCall(); }
|
||||
inline int Length() const { return args_.Length(); }
|
||||
inline v8::Local<v8::Value> operator[](int i) const { return args_[i]; }
|
||||
inline v8::Local<v8::Object> This() const { return args_.This(); }
|
||||
inline v8::Isolate *GetIsolate() const { return args_.GetIsolate(); }
|
||||
|
||||
|
||||
protected:
|
||||
static const int kHolderIndex = 0;
|
||||
static const int kIsolateIndex = 1;
|
||||
static const int kReturnValueDefaultValueIndex = 2;
|
||||
static const int kReturnValueIndex = 3;
|
||||
static const int kDataIndex = 4;
|
||||
static const int kCalleeIndex = 5;
|
||||
static const int kContextSaveIndex = 6;
|
||||
static const int kArgsLength = 7;
|
||||
|
||||
private:
|
||||
NAN_DISALLOW_ASSIGN_COPY_MOVE(FunctionCallbackInfo)
|
||||
};
|
||||
|
||||
template<typename T>
|
||||
class PropertyCallbackInfoBase {
|
||||
const v8::AccessorInfo &info_;
|
||||
const v8::Local<v8::Value> &data_;
|
||||
|
||||
public:
|
||||
explicit inline PropertyCallbackInfoBase(
|
||||
const v8::AccessorInfo &info
|
||||
, const v8::Local<v8::Value> &data) :
|
||||
info_(info)
|
||||
, data_(data) {}
|
||||
|
||||
inline v8::Isolate* GetIsolate() const { return info_.GetIsolate(); }
|
||||
inline v8::Local<v8::Value> Data() const { return data_; }
|
||||
inline v8::Local<v8::Object> This() const { return info_.This(); }
|
||||
inline v8::Local<v8::Object> Holder() const { return info_.Holder(); }
|
||||
|
||||
protected:
|
||||
static const int kHolderIndex = 0;
|
||||
static const int kIsolateIndex = 1;
|
||||
static const int kReturnValueDefaultValueIndex = 2;
|
||||
static const int kReturnValueIndex = 3;
|
||||
static const int kDataIndex = 4;
|
||||
static const int kThisIndex = 5;
|
||||
static const int kArgsLength = 6;
|
||||
|
||||
private:
|
||||
NAN_DISALLOW_ASSIGN_COPY_MOVE(PropertyCallbackInfoBase)
|
||||
};
|
||||
|
||||
template<typename T>
|
||||
class PropertyCallbackInfo : public PropertyCallbackInfoBase<T> {
|
||||
ReturnValue<T> return_value_;
|
||||
v8::Persistent<T> retval_;
|
||||
|
||||
public:
|
||||
explicit inline PropertyCallbackInfo(
|
||||
const v8::AccessorInfo &info
|
||||
, const v8::Local<v8::Value> &data) :
|
||||
PropertyCallbackInfoBase<T>(info, data)
|
||||
, return_value_(info.GetIsolate(), &retval_)
|
||||
, retval_(v8::Persistent<T>::New(v8::Undefined())) {}
|
||||
|
||||
inline ~PropertyCallbackInfo() {
|
||||
retval_.Dispose();
|
||||
retval_.Clear();
|
||||
}
|
||||
|
||||
inline ReturnValue<T> GetReturnValue() const { return return_value_; }
|
||||
};
|
||||
|
||||
template<>
|
||||
class PropertyCallbackInfo<v8::Array> :
|
||||
public PropertyCallbackInfoBase<v8::Array> {
|
||||
ReturnValue<v8::Array> return_value_;
|
||||
v8::Persistent<v8::Array> retval_;
|
||||
|
||||
public:
|
||||
explicit inline PropertyCallbackInfo(
|
||||
const v8::AccessorInfo &info
|
||||
, const v8::Local<v8::Value> &data) :
|
||||
PropertyCallbackInfoBase<v8::Array>(info, data)
|
||||
, return_value_(info.GetIsolate(), &retval_)
|
||||
, retval_(v8::Persistent<v8::Array>::New(v8::Local<v8::Array>())) {}
|
||||
|
||||
inline ~PropertyCallbackInfo() {
|
||||
retval_.Dispose();
|
||||
retval_.Clear();
|
||||
}
|
||||
|
||||
inline ReturnValue<v8::Array> GetReturnValue() const {
|
||||
return return_value_;
|
||||
}
|
||||
};
|
||||
|
||||
template<>
|
||||
class PropertyCallbackInfo<v8::Boolean> :
|
||||
public PropertyCallbackInfoBase<v8::Boolean> {
|
||||
ReturnValue<v8::Boolean> return_value_;
|
||||
v8::Persistent<v8::Boolean> retval_;
|
||||
|
||||
public:
|
||||
explicit inline PropertyCallbackInfo(
|
||||
const v8::AccessorInfo &info
|
||||
, const v8::Local<v8::Value> &data) :
|
||||
PropertyCallbackInfoBase<v8::Boolean>(info, data)
|
||||
, return_value_(info.GetIsolate(), &retval_)
|
||||
, retval_(v8::Persistent<v8::Boolean>::New(v8::Local<v8::Boolean>())) {}
|
||||
|
||||
inline ~PropertyCallbackInfo() {
|
||||
retval_.Dispose();
|
||||
retval_.Clear();
|
||||
}
|
||||
|
||||
inline ReturnValue<v8::Boolean> GetReturnValue() const {
|
||||
return return_value_;
|
||||
}
|
||||
};
|
||||
|
||||
template<>
|
||||
class PropertyCallbackInfo<v8::Integer> :
|
||||
public PropertyCallbackInfoBase<v8::Integer> {
|
||||
ReturnValue<v8::Integer> return_value_;
|
||||
v8::Persistent<v8::Integer> retval_;
|
||||
|
||||
public:
|
||||
explicit inline PropertyCallbackInfo(
|
||||
const v8::AccessorInfo &info
|
||||
, const v8::Local<v8::Value> &data) :
|
||||
PropertyCallbackInfoBase<v8::Integer>(info, data)
|
||||
, return_value_(info.GetIsolate(), &retval_)
|
||||
, retval_(v8::Persistent<v8::Integer>::New(v8::Local<v8::Integer>())) {}
|
||||
|
||||
inline ~PropertyCallbackInfo() {
|
||||
retval_.Dispose();
|
||||
retval_.Clear();
|
||||
}
|
||||
|
||||
inline ReturnValue<v8::Integer> GetReturnValue() const {
|
||||
return return_value_;
|
||||
}
|
||||
};
|
||||
|
||||
namespace imp {
|
||||
template<typename T>
|
||||
class ReturnValueImp : public ReturnValue<T> {
|
||||
public:
|
||||
explicit ReturnValueImp(ReturnValue<T> that) :
|
||||
ReturnValue<T>(that) {}
|
||||
NAN_INLINE v8::Handle<T> Value() {
|
||||
return *ReturnValue<T>::value_;
|
||||
}
|
||||
};
|
||||
|
||||
static
|
||||
v8::Handle<v8::Value> FunctionCallbackWrapper(const v8::Arguments &args) {
|
||||
v8::Local<v8::Object> obj = args.Data().As<v8::Object>();
|
||||
FunctionCallback callback = reinterpret_cast<FunctionCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kFunctionIndex).As<v8::External>()->Value()));
|
||||
FunctionCallbackInfo<v8::Value>
|
||||
cbinfo(args, obj->GetInternalField(kDataIndex));
|
||||
callback(cbinfo);
|
||||
return ReturnValueImp<v8::Value>(cbinfo.GetReturnValue()).Value();
|
||||
}
|
||||
|
||||
typedef v8::Handle<v8::Value> (*NativeFunction)(const v8::Arguments &);
|
||||
|
||||
static
|
||||
v8::Handle<v8::Value> GetterCallbackWrapper(
|
||||
v8::Local<v8::String> property, const v8::AccessorInfo &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Value>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
GetterCallback callback = reinterpret_cast<GetterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kGetterIndex).As<v8::External>()->Value()));
|
||||
callback(property, cbinfo);
|
||||
return ReturnValueImp<v8::Value>(cbinfo.GetReturnValue()).Value();
|
||||
}
|
||||
|
||||
typedef v8::Handle<v8::Value> (*NativeGetter)
|
||||
(v8::Local<v8::String>, const v8::AccessorInfo &);
|
||||
|
||||
static
|
||||
void SetterCallbackWrapper(
|
||||
v8::Local<v8::String> property
|
||||
, v8::Local<v8::Value> value
|
||||
, const v8::AccessorInfo &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<void>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
SetterCallback callback = reinterpret_cast<SetterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kSetterIndex).As<v8::External>()->Value()));
|
||||
callback(property, value, cbinfo);
|
||||
}
|
||||
|
||||
typedef void (*NativeSetter)
|
||||
(v8::Local<v8::String>, v8::Local<v8::Value>, const v8::AccessorInfo &);
|
||||
|
||||
static
|
||||
v8::Handle<v8::Value> PropertyGetterCallbackWrapper(
|
||||
v8::Local<v8::String> property, const v8::AccessorInfo &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Value>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
PropertyGetterCallback callback = reinterpret_cast<PropertyGetterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kPropertyGetterIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(property, cbinfo);
|
||||
return ReturnValueImp<v8::Value>(cbinfo.GetReturnValue()).Value();
|
||||
}
|
||||
|
||||
typedef v8::Handle<v8::Value> (*NativePropertyGetter)
|
||||
(v8::Local<v8::String>, const v8::AccessorInfo &);
|
||||
|
||||
static
|
||||
v8::Handle<v8::Value> PropertySetterCallbackWrapper(
|
||||
v8::Local<v8::String> property
|
||||
, v8::Local<v8::Value> value
|
||||
, const v8::AccessorInfo &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Value>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
PropertySetterCallback callback = reinterpret_cast<PropertySetterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kPropertySetterIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(property, value, cbinfo);
|
||||
return ReturnValueImp<v8::Value>(cbinfo.GetReturnValue()).Value();
|
||||
}
|
||||
|
||||
typedef v8::Handle<v8::Value> (*NativePropertySetter)
|
||||
(v8::Local<v8::String>, v8::Local<v8::Value>, const v8::AccessorInfo &);
|
||||
|
||||
static
|
||||
v8::Handle<v8::Array> PropertyEnumeratorCallbackWrapper(
|
||||
const v8::AccessorInfo &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Array>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
PropertyEnumeratorCallback callback =
|
||||
reinterpret_cast<PropertyEnumeratorCallback>(reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kPropertyEnumeratorIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(cbinfo);
|
||||
return ReturnValueImp<v8::Array>(cbinfo.GetReturnValue()).Value();
|
||||
}
|
||||
|
||||
typedef v8::Handle<v8::Array> (*NativePropertyEnumerator)
|
||||
(const v8::AccessorInfo &);
|
||||
|
||||
static
|
||||
v8::Handle<v8::Boolean> PropertyDeleterCallbackWrapper(
|
||||
v8::Local<v8::String> property
|
||||
, const v8::AccessorInfo &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Boolean>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
PropertyDeleterCallback callback = reinterpret_cast<PropertyDeleterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kPropertyDeleterIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(property, cbinfo);
|
||||
return ReturnValueImp<v8::Boolean>(cbinfo.GetReturnValue()).Value();
|
||||
}
|
||||
|
||||
typedef v8::Handle<v8::Boolean> (NativePropertyDeleter)
|
||||
(v8::Local<v8::String>, const v8::AccessorInfo &);
|
||||
|
||||
static
|
||||
v8::Handle<v8::Integer> PropertyQueryCallbackWrapper(
|
||||
v8::Local<v8::String> property, const v8::AccessorInfo &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Integer>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
PropertyQueryCallback callback = reinterpret_cast<PropertyQueryCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kPropertyQueryIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(property, cbinfo);
|
||||
return ReturnValueImp<v8::Integer>(cbinfo.GetReturnValue()).Value();
|
||||
}
|
||||
|
||||
typedef v8::Handle<v8::Integer> (*NativePropertyQuery)
|
||||
(v8::Local<v8::String>, const v8::AccessorInfo &);
|
||||
|
||||
static
|
||||
v8::Handle<v8::Value> IndexGetterCallbackWrapper(
|
||||
uint32_t index, const v8::AccessorInfo &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Value>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
IndexGetterCallback callback = reinterpret_cast<IndexGetterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kIndexPropertyGetterIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(index, cbinfo);
|
||||
return ReturnValueImp<v8::Value>(cbinfo.GetReturnValue()).Value();
|
||||
}
|
||||
|
||||
typedef v8::Handle<v8::Value> (*NativeIndexGetter)
|
||||
(uint32_t, const v8::AccessorInfo &);
|
||||
|
||||
static
|
||||
v8::Handle<v8::Value> IndexSetterCallbackWrapper(
|
||||
uint32_t index
|
||||
, v8::Local<v8::Value> value
|
||||
, const v8::AccessorInfo &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Value>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
IndexSetterCallback callback = reinterpret_cast<IndexSetterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kIndexPropertySetterIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(index, value, cbinfo);
|
||||
return ReturnValueImp<v8::Value>(cbinfo.GetReturnValue()).Value();
|
||||
}
|
||||
|
||||
typedef v8::Handle<v8::Value> (*NativeIndexSetter)
|
||||
(uint32_t, v8::Local<v8::Value>, const v8::AccessorInfo &);
|
||||
|
||||
static
|
||||
v8::Handle<v8::Array> IndexEnumeratorCallbackWrapper(
|
||||
const v8::AccessorInfo &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Array>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
IndexEnumeratorCallback callback = reinterpret_cast<IndexEnumeratorCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kIndexPropertyEnumeratorIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(cbinfo);
|
||||
return ReturnValueImp<v8::Array>(cbinfo.GetReturnValue()).Value();
|
||||
}
|
||||
|
||||
typedef v8::Handle<v8::Array> (*NativeIndexEnumerator)
|
||||
(const v8::AccessorInfo &);
|
||||
|
||||
static
|
||||
v8::Handle<v8::Boolean> IndexDeleterCallbackWrapper(
|
||||
uint32_t index, const v8::AccessorInfo &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Boolean>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
IndexDeleterCallback callback = reinterpret_cast<IndexDeleterCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kIndexPropertyDeleterIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(index, cbinfo);
|
||||
return ReturnValueImp<v8::Boolean>(cbinfo.GetReturnValue()).Value();
|
||||
}
|
||||
|
||||
typedef v8::Handle<v8::Boolean> (*NativeIndexDeleter)
|
||||
(uint32_t, const v8::AccessorInfo &);
|
||||
|
||||
static
|
||||
v8::Handle<v8::Integer> IndexQueryCallbackWrapper(
|
||||
uint32_t index, const v8::AccessorInfo &info) {
|
||||
v8::Local<v8::Object> obj = info.Data().As<v8::Object>();
|
||||
PropertyCallbackInfo<v8::Integer>
|
||||
cbinfo(info, obj->GetInternalField(kDataIndex));
|
||||
IndexQueryCallback callback = reinterpret_cast<IndexQueryCallback>(
|
||||
reinterpret_cast<intptr_t>(
|
||||
obj->GetInternalField(kIndexPropertyQueryIndex)
|
||||
.As<v8::External>()->Value()));
|
||||
callback(index, cbinfo);
|
||||
return ReturnValueImp<v8::Integer>(cbinfo.GetReturnValue()).Value();
|
||||
}
|
||||
|
||||
typedef v8::Handle<v8::Integer> (*NativeIndexQuery)
|
||||
(uint32_t, const v8::AccessorInfo &);
|
||||
} // end of namespace imp
|
||||
|
||||
#endif // NAN_CALLBACKS_PRE_12_INL_H_
|
||||
+64
@@ -0,0 +1,64 @@
|
||||
/*********************************************************************
|
||||
* NAN - Native Abstractions for Node.js
|
||||
*
|
||||
* Copyright (c) 2015 NAN contributors
|
||||
*
|
||||
* MIT License <https://github.com/nodejs/nan/blob/master/LICENSE.md>
|
||||
********************************************************************/
|
||||
|
||||
#ifndef NAN_CONVERTERS_H_
|
||||
#define NAN_CONVERTERS_H_
|
||||
|
||||
namespace imp {
|
||||
template<typename T> struct ToFactoryBase {
|
||||
typedef MaybeLocal<T> return_t;
|
||||
};
|
||||
template<typename T> struct ValueFactoryBase { typedef Maybe<T> return_t; };
|
||||
|
||||
template<typename T> struct ToFactory;
|
||||
|
||||
#define X(TYPE) \
|
||||
template<> \
|
||||
struct ToFactory<v8::TYPE> : ToFactoryBase<v8::TYPE> { \
|
||||
static inline return_t convert(v8::Local<v8::Value> val); \
|
||||
};
|
||||
|
||||
X(Boolean)
|
||||
X(Number)
|
||||
X(String)
|
||||
X(Object)
|
||||
X(Integer)
|
||||
X(Uint32)
|
||||
X(Int32)
|
||||
|
||||
#undef X
|
||||
|
||||
#define X(TYPE) \
|
||||
template<> \
|
||||
struct ToFactory<TYPE> : ValueFactoryBase<TYPE> { \
|
||||
static inline return_t convert(v8::Local<v8::Value> val); \
|
||||
};
|
||||
|
||||
X(bool)
|
||||
X(double)
|
||||
X(int64_t)
|
||||
X(uint32_t)
|
||||
X(int32_t)
|
||||
|
||||
#undef X
|
||||
} // end of namespace imp
|
||||
|
||||
template<typename T>
|
||||
NAN_INLINE
|
||||
typename imp::ToFactory<T>::return_t To(v8::Local<v8::Value> val) {
|
||||
return imp::ToFactory<T>::convert(val);
|
||||
}
|
||||
|
||||
#if defined(V8_MAJOR_VERSION) && (V8_MAJOR_VERSION > 4 || \
|
||||
(V8_MAJOR_VERSION == 4 && defined(V8_MINOR_VERSION) && V8_MINOR_VERSION >= 3))
|
||||
# include "nan_converters_43_inl.h"
|
||||
#else
|
||||
# include "nan_converters_pre_43_inl.h"
|
||||
#endif
|
||||
|
||||
#endif // NAN_CONVERTERS_H_
|
||||
+42
@@ -0,0 +1,42 @@
|
||||
/*********************************************************************
|
||||
* NAN - Native Abstractions for Node.js
|
||||
*
|
||||
* Copyright (c) 2015 NAN contributors
|
||||
*
|
||||
* MIT License <https://github.com/nodejs/nan/blob/master/LICENSE.md>
|
||||
********************************************************************/
|
||||
|
||||
#ifndef NAN_CONVERTERS_43_INL_H_
|
||||
#define NAN_CONVERTERS_43_INL_H_
|
||||
|
||||
#define X(TYPE) \
|
||||
imp::ToFactory<v8::TYPE>::return_t \
|
||||
imp::ToFactory<v8::TYPE>::convert(v8::Local<v8::Value> val) { \
|
||||
return val->To ## TYPE(GetCurrentContext()); \
|
||||
}
|
||||
|
||||
X(Boolean)
|
||||
X(Number)
|
||||
X(String)
|
||||
X(Object)
|
||||
X(Integer)
|
||||
X(Uint32)
|
||||
X(Int32)
|
||||
|
||||
#undef X
|
||||
|
||||
#define X(TYPE, NAME) \
|
||||
imp::ToFactory<TYPE>::return_t \
|
||||
imp::ToFactory<TYPE>::convert(v8::Local<v8::Value> val) { \
|
||||
return val->NAME ## Value(GetCurrentContext()); \
|
||||
}
|
||||
|
||||
X(bool, Boolean)
|
||||
X(double, Number)
|
||||
X(int64_t, Integer)
|
||||
X(uint32_t, Uint32)
|
||||
X(int32_t, Int32)
|
||||
|
||||
#undef X
|
||||
|
||||
#endif // NAN_CONVERTERS_43_INL_H_
|
||||
Generated
Vendored
+42
@@ -0,0 +1,42 @@
|
||||
/*********************************************************************
|
||||
* NAN - Native Abstractions for Node.js
|
||||
*
|
||||
* Copyright (c) 2015 NAN contributors
|
||||
*
|
||||
* MIT License <https://github.com/nodejs/nan/blob/master/LICENSE.md>
|
||||
********************************************************************/
|
||||
|
||||
#ifndef NAN_CONVERTERS_PRE_43_INL_H_
|
||||
#define NAN_CONVERTERS_PRE_43_INL_H_
|
||||
|
||||
#define X(TYPE) \
|
||||
imp::ToFactory<v8::TYPE>::return_t \
|
||||
imp::ToFactory<v8::TYPE>::convert(v8::Local<v8::Value> val) { \
|
||||
return MaybeLocal<v8::TYPE>(val->To ## TYPE()); \
|
||||
}
|
||||
|
||||
X(Boolean)
|
||||
X(Number)
|
||||
X(String)
|
||||
X(Object)
|
||||
X(Integer)
|
||||
X(Uint32)
|
||||
X(Int32)
|
||||
|
||||
#undef X
|
||||
|
||||
#define X(TYPE, NAME) \
|
||||
imp::ToFactory<TYPE>::return_t \
|
||||
imp::ToFactory<TYPE>::convert(v8::Local<v8::Value> val) { \
|
||||
return Just<TYPE>(val->NAME ##Value()); \
|
||||
}
|
||||
|
||||
X(bool, Boolean)
|
||||
X(double, Number)
|
||||
X(int64_t, Integer)
|
||||
X(uint32_t, Uint32)
|
||||
X(int32_t, Int32)
|
||||
|
||||
#undef X
|
||||
|
||||
#endif // NAN_CONVERTERS_PRE_43_INL_H_
|
||||
Generated
Vendored
+399
@@ -0,0 +1,399 @@
|
||||
/*********************************************************************
|
||||
* NAN - Native Abstractions for Node.js
|
||||
*
|
||||
* Copyright (c) 2015 NAN contributors
|
||||
*
|
||||
* MIT License <https://github.com/nodejs/nan/blob/master/LICENSE.md>
|
||||
********************************************************************/
|
||||
|
||||
#ifndef NAN_IMPLEMENTATION_12_INL_H_
|
||||
#define NAN_IMPLEMENTATION_12_INL_H_
|
||||
//==============================================================================
|
||||
// node v0.11 implementation
|
||||
//==============================================================================
|
||||
|
||||
namespace imp {
|
||||
|
||||
//=== Array ====================================================================
|
||||
|
||||
Factory<v8::Array>::return_t
|
||||
Factory<v8::Array>::New() {
|
||||
return v8::Array::New(v8::Isolate::GetCurrent());
|
||||
}
|
||||
|
||||
Factory<v8::Array>::return_t
|
||||
Factory<v8::Array>::New(int length) {
|
||||
return v8::Array::New(v8::Isolate::GetCurrent(), length);
|
||||
}
|
||||
|
||||
//=== Boolean ==================================================================
|
||||
|
||||
Factory<v8::Boolean>::return_t
|
||||
Factory<v8::Boolean>::New(bool value) {
|
||||
return v8::Boolean::New(v8::Isolate::GetCurrent(), value);
|
||||
}
|
||||
|
||||
//=== Boolean Object ===========================================================
|
||||
|
||||
Factory<v8::BooleanObject>::return_t
|
||||
Factory<v8::BooleanObject>::New(bool value) {
|
||||
return v8::BooleanObject::New(value).As<v8::BooleanObject>();
|
||||
}
|
||||
|
||||
//=== Context ==================================================================
|
||||
|
||||
Factory<v8::Context>::return_t
|
||||
Factory<v8::Context>::New( v8::ExtensionConfiguration* extensions
|
||||
, v8::Local<v8::ObjectTemplate> tmpl
|
||||
, v8::Local<v8::Value> obj) {
|
||||
return v8::Context::New(v8::Isolate::GetCurrent(), extensions, tmpl, obj);
|
||||
}
|
||||
|
||||
//=== Date =====================================================================
|
||||
|
||||
#if defined(V8_MAJOR_VERSION) && (V8_MAJOR_VERSION > 4 || \
|
||||
(V8_MAJOR_VERSION == 4 && defined(V8_MINOR_VERSION) && V8_MINOR_VERSION >= 3))
|
||||
Factory<v8::Date>::return_t
|
||||
Factory<v8::Date>::New(double value) {
|
||||
v8::Local<v8::Date> ret;
|
||||
if (v8::Date::New(GetCurrentContext(), value).
|
||||
ToLocal(reinterpret_cast<v8::Local<v8::Value>*>(&ret))) {
|
||||
return v8::MaybeLocal<v8::Date>(ret);
|
||||
} else {
|
||||
return v8::MaybeLocal<v8::Date>(ret);
|
||||
}
|
||||
}
|
||||
#else
|
||||
Factory<v8::Date>::return_t
|
||||
Factory<v8::Date>::New(double value) {
|
||||
return Factory<v8::Date>::return_t(
|
||||
v8::Date::New(v8::Isolate::GetCurrent(), value).As<v8::Date>());
|
||||
}
|
||||
#endif
|
||||
|
||||
//=== External =================================================================
|
||||
|
||||
Factory<v8::External>::return_t
|
||||
Factory<v8::External>::New(void * value) {
|
||||
return v8::External::New(v8::Isolate::GetCurrent(), value);
|
||||
}
|
||||
|
||||
//=== Function =================================================================
|
||||
|
||||
Factory<v8::Function>::return_t
|
||||
Factory<v8::Function>::New( FunctionCallback callback
|
||||
, v8::Local<v8::Value> data) {
|
||||
v8::Isolate *isolate = v8::Isolate::GetCurrent();
|
||||
v8::EscapableHandleScope scope(isolate);
|
||||
v8::Local<v8::ObjectTemplate> tpl = v8::ObjectTemplate::New(isolate);
|
||||
tpl->SetInternalFieldCount(imp::kFunctionFieldCount);
|
||||
v8::Local<v8::Object> obj = NewInstance(tpl).ToLocalChecked();
|
||||
|
||||
obj->SetInternalField(
|
||||
imp::kFunctionIndex
|
||||
, v8::External::New(isolate, reinterpret_cast<void *>(callback)));
|
||||
|
||||
v8::Local<v8::Value> val = v8::Local<v8::Value>::New(isolate, data);
|
||||
|
||||
if (!val.IsEmpty()) {
|
||||
obj->SetInternalField(imp::kDataIndex, val);
|
||||
}
|
||||
|
||||
return scope.Escape(v8::Function::New( isolate
|
||||
, imp::FunctionCallbackWrapper
|
||||
, obj));
|
||||
}
|
||||
|
||||
//=== Function Template ========================================================
|
||||
|
||||
Factory<v8::FunctionTemplate>::return_t
|
||||
Factory<v8::FunctionTemplate>::New( FunctionCallback callback
|
||||
, v8::Local<v8::Value> data
|
||||
, v8::Local<v8::Signature> signature) {
|
||||
v8::Isolate *isolate = v8::Isolate::GetCurrent();
|
||||
if (callback) {
|
||||
v8::EscapableHandleScope scope(isolate);
|
||||
v8::Local<v8::ObjectTemplate> tpl = v8::ObjectTemplate::New(isolate);
|
||||
tpl->SetInternalFieldCount(imp::kFunctionFieldCount);
|
||||
v8::Local<v8::Object> obj = NewInstance(tpl).ToLocalChecked();
|
||||
|
||||
obj->SetInternalField(
|
||||
imp::kFunctionIndex
|
||||
, v8::External::New(isolate, reinterpret_cast<void *>(callback)));
|
||||
v8::Local<v8::Value> val = v8::Local<v8::Value>::New(isolate, data);
|
||||
|
||||
if (!val.IsEmpty()) {
|
||||
obj->SetInternalField(imp::kDataIndex, val);
|
||||
}
|
||||
|
||||
return scope.Escape(v8::FunctionTemplate::New( isolate
|
||||
, imp::FunctionCallbackWrapper
|
||||
, obj
|
||||
, signature));
|
||||
} else {
|
||||
return v8::FunctionTemplate::New(isolate, 0, data, signature);
|
||||
}
|
||||
}
|
||||
|
||||
//=== Number ===================================================================
|
||||
|
||||
Factory<v8::Number>::return_t
|
||||
Factory<v8::Number>::New(double value) {
|
||||
return v8::Number::New(v8::Isolate::GetCurrent(), value);
|
||||
}
|
||||
|
||||
//=== Number Object ============================================================
|
||||
|
||||
Factory<v8::NumberObject>::return_t
|
||||
Factory<v8::NumberObject>::New(double value) {
|
||||
return v8::NumberObject::New( v8::Isolate::GetCurrent()
|
||||
, value).As<v8::NumberObject>();
|
||||
}
|
||||
|
||||
//=== Integer, Int32 and Uint32 ================================================
|
||||
|
||||
template <typename T>
|
||||
typename IntegerFactory<T>::return_t
|
||||
IntegerFactory<T>::New(int32_t value) {
|
||||
return To<T>(T::New(v8::Isolate::GetCurrent(), value));
|
||||
}
|
||||
|
||||
template <typename T>
|
||||
typename IntegerFactory<T>::return_t
|
||||
IntegerFactory<T>::New(uint32_t value) {
|
||||
return To<T>(T::NewFromUnsigned(v8::Isolate::GetCurrent(), value));
|
||||
}
|
||||
|
||||
Factory<v8::Uint32>::return_t
|
||||
Factory<v8::Uint32>::New(int32_t value) {
|
||||
return To<v8::Uint32>(
|
||||
v8::Uint32::NewFromUnsigned(v8::Isolate::GetCurrent(), value));
|
||||
}
|
||||
|
||||
Factory<v8::Uint32>::return_t
|
||||
Factory<v8::Uint32>::New(uint32_t value) {
|
||||
return To<v8::Uint32>(
|
||||
v8::Uint32::NewFromUnsigned(v8::Isolate::GetCurrent(), value));
|
||||
}
|
||||
|
||||
//=== Object ===================================================================
|
||||
|
||||
Factory<v8::Object>::return_t
|
||||
Factory<v8::Object>::New() {
|
||||
return v8::Object::New(v8::Isolate::GetCurrent());
|
||||
}
|
||||
|
||||
//=== Object Template ==========================================================
|
||||
|
||||
Factory<v8::ObjectTemplate>::return_t
|
||||
Factory<v8::ObjectTemplate>::New() {
|
||||
return v8::ObjectTemplate::New(v8::Isolate::GetCurrent());
|
||||
}
|
||||
|
||||
//=== RegExp ===================================================================
|
||||
|
||||
#if defined(V8_MAJOR_VERSION) && (V8_MAJOR_VERSION > 4 || \
|
||||
(V8_MAJOR_VERSION == 4 && defined(V8_MINOR_VERSION) && V8_MINOR_VERSION >= 3))
|
||||
Factory<v8::RegExp>::return_t
|
||||
Factory<v8::RegExp>::New(
|
||||
v8::Local<v8::String> pattern
|
||||
, v8::RegExp::Flags flags) {
|
||||
return v8::RegExp::New(GetCurrentContext(), pattern, flags);
|
||||
}
|
||||
#else
|
||||
Factory<v8::RegExp>::return_t
|
||||
Factory<v8::RegExp>::New(
|
||||
v8::Local<v8::String> pattern
|
||||
, v8::RegExp::Flags flags) {
|
||||
return Factory<v8::RegExp>::return_t(v8::RegExp::New(pattern, flags));
|
||||
}
|
||||
#endif
|
||||
|
||||
//=== Script ===================================================================
|
||||
|
||||
#if defined(V8_MAJOR_VERSION) && (V8_MAJOR_VERSION > 4 || \
|
||||
(V8_MAJOR_VERSION == 4 && defined(V8_MINOR_VERSION) && V8_MINOR_VERSION >= 3))
|
||||
Factory<v8::Script>::return_t
|
||||
Factory<v8::Script>::New( v8::Local<v8::String> source) {
|
||||
v8::ScriptCompiler::Source src(source);
|
||||
return v8::ScriptCompiler::Compile(GetCurrentContext(), &src);
|
||||
}
|
||||
|
||||
Factory<v8::Script>::return_t
|
||||
Factory<v8::Script>::New( v8::Local<v8::String> source
|
||||
, v8::ScriptOrigin const& origin) {
|
||||
v8::ScriptCompiler::Source src(source, origin);
|
||||
return v8::ScriptCompiler::Compile(GetCurrentContext(), &src);
|
||||
}
|
||||
#else
|
||||
Factory<v8::Script>::return_t
|
||||
Factory<v8::Script>::New( v8::Local<v8::String> source) {
|
||||
v8::ScriptCompiler::Source src(source);
|
||||
return Factory<v8::Script>::return_t(
|
||||
v8::ScriptCompiler::Compile(v8::Isolate::GetCurrent(), &src));
|
||||
}
|
||||
|
||||
Factory<v8::Script>::return_t
|
||||
Factory<v8::Script>::New( v8::Local<v8::String> source
|
||||
, v8::ScriptOrigin const& origin) {
|
||||
v8::ScriptCompiler::Source src(source, origin);
|
||||
return Factory<v8::Script>::return_t(
|
||||
v8::ScriptCompiler::Compile(v8::Isolate::GetCurrent(), &src));
|
||||
}
|
||||
#endif
|
||||
|
||||
//=== Signature ================================================================
|
||||
|
||||
Factory<v8::Signature>::return_t
|
||||
Factory<v8::Signature>::New(Factory<v8::Signature>::FTH receiver) {
|
||||
return v8::Signature::New(v8::Isolate::GetCurrent(), receiver);
|
||||
}
|
||||
|
||||
//=== String ===================================================================
|
||||
|
||||
Factory<v8::String>::return_t
|
||||
Factory<v8::String>::New() {
|
||||
return Factory<v8::String>::return_t(
|
||||
v8::String::Empty(v8::Isolate::GetCurrent()));
|
||||
}
|
||||
|
||||
#if defined(V8_MAJOR_VERSION) && (V8_MAJOR_VERSION > 4 || \
|
||||
(V8_MAJOR_VERSION == 4 && defined(V8_MINOR_VERSION) && V8_MINOR_VERSION >= 3))
|
||||
Factory<v8::String>::return_t
|
||||
Factory<v8::String>::New(const char * value, int length) {
|
||||
return v8::String::NewFromUtf8(
|
||||
v8::Isolate::GetCurrent(), value, v8::NewStringType::kNormal, length);
|
||||
}
|
||||
|
||||
Factory<v8::String>::return_t
|
||||
Factory<v8::String>::New(std::string const& value) {
|
||||
assert(value.size() <= INT_MAX && "string too long");
|
||||
return v8::String::NewFromUtf8(v8::Isolate::GetCurrent(),
|
||||
value.data(), v8::NewStringType::kNormal, static_cast<int>(value.size()));
|
||||
}
|
||||
|
||||
Factory<v8::String>::return_t
|
||||
Factory<v8::String>::New(const uint16_t * value, int length) {
|
||||
return v8::String::NewFromTwoByte(v8::Isolate::GetCurrent(), value,
|
||||
v8::NewStringType::kNormal, length);
|
||||
}
|
||||
|
||||
Factory<v8::String>::return_t
|
||||
Factory<v8::String>::New(v8::String::ExternalStringResource * value) {
|
||||
return v8::String::NewExternalTwoByte(v8::Isolate::GetCurrent(), value);
|
||||
}
|
||||
|
||||
Factory<v8::String>::return_t
|
||||
Factory<v8::String>::New(ExternalOneByteStringResource * value) {
|
||||
return v8::String::NewExternalOneByte(v8::Isolate::GetCurrent(), value);
|
||||
}
|
||||
#else
|
||||
Factory<v8::String>::return_t
|
||||
Factory<v8::String>::New(const char * value, int length) {
|
||||
return Factory<v8::String>::return_t(
|
||||
v8::String::NewFromUtf8(
|
||||
v8::Isolate::GetCurrent()
|
||||
, value
|
||||
, v8::String::kNormalString
|
||||
, length));
|
||||
}
|
||||
|
||||
Factory<v8::String>::return_t
|
||||
Factory<v8::String>::New(
|
||||
std::string const& value) /* NOLINT(build/include_what_you_use) */ {
|
||||
assert(value.size() <= INT_MAX && "string too long");
|
||||
return Factory<v8::String>::return_t(
|
||||
v8::String::NewFromUtf8(
|
||||
v8::Isolate::GetCurrent()
|
||||
, value.data()
|
||||
, v8::String::kNormalString
|
||||
, static_cast<int>(value.size())));
|
||||
}
|
||||
|
||||
Factory<v8::String>::return_t
|
||||
Factory<v8::String>::New(const uint16_t * value, int length) {
|
||||
return Factory<v8::String>::return_t(
|
||||
v8::String::NewFromTwoByte(
|
||||
v8::Isolate::GetCurrent()
|
||||
, value
|
||||
, v8::String::kNormalString
|
||||
, length));
|
||||
}
|
||||
|
||||
Factory<v8::String>::return_t
|
||||
Factory<v8::String>::New(v8::String::ExternalStringResource * value) {
|
||||
return Factory<v8::String>::return_t(
|
||||
v8::String::NewExternal(v8::Isolate::GetCurrent(), value));
|
||||
}
|
||||
|
||||
Factory<v8::String>::return_t
|
||||
Factory<v8::String>::New(ExternalOneByteStringResource * value) {
|
||||
return Factory<v8::String>::return_t(
|
||||
v8::String::NewExternal(v8::Isolate::GetCurrent(), value));
|
||||
}
|
||||
#endif
|
||||
|
||||
//=== String Object ============================================================
|
||||
|
||||
Factory<v8::StringObject>::return_t
|
||||
Factory<v8::StringObject>::New(v8::Local<v8::String> value) {
|
||||
return v8::StringObject::New(value).As<v8::StringObject>();
|
||||
}
|
||||
|
||||
//=== Unbound Script ===========================================================
|
||||
|
||||
#if defined(V8_MAJOR_VERSION) && (V8_MAJOR_VERSION > 4 || \
|
||||
(V8_MAJOR_VERSION == 4 && defined(V8_MINOR_VERSION) && V8_MINOR_VERSION >= 3))
|
||||
Factory<v8::UnboundScript>::return_t
|
||||
Factory<v8::UnboundScript>::New(v8::Local<v8::String> source) {
|
||||
v8::ScriptCompiler::Source src(source);
|
||||
return v8::ScriptCompiler::CompileUnboundScript(
|
||||
v8::Isolate::GetCurrent(), &src);
|
||||
}
|
||||
|
||||
Factory<v8::UnboundScript>::return_t
|
||||
Factory<v8::UnboundScript>::New( v8::Local<v8::String> source
|
||||
, v8::ScriptOrigin const& origin) {
|
||||
v8::ScriptCompiler::Source src(source, origin);
|
||||
return v8::ScriptCompiler::CompileUnboundScript(
|
||||
v8::Isolate::GetCurrent(), &src);
|
||||
}
|
||||
#else
|
||||
Factory<v8::UnboundScript>::return_t
|
||||
Factory<v8::UnboundScript>::New(v8::Local<v8::String> source) {
|
||||
v8::ScriptCompiler::Source src(source);
|
||||
return Factory<v8::UnboundScript>::return_t(
|
||||
v8::ScriptCompiler::CompileUnbound(v8::Isolate::GetCurrent(), &src));
|
||||
}
|
||||
|
||||
Factory<v8::UnboundScript>::return_t
|
||||
Factory<v8::UnboundScript>::New( v8::Local<v8::String> source
|
||||
, v8::ScriptOrigin const& origin) {
|
||||
v8::ScriptCompiler::Source src(source, origin);
|
||||
return Factory<v8::UnboundScript>::return_t(
|
||||
v8::ScriptCompiler::CompileUnbound(v8::Isolate::GetCurrent(), &src));
|
||||
}
|
||||
#endif
|
||||
|
||||
} // end of namespace imp
|
||||
|
||||
//=== Presistents and Handles ==================================================
|
||||
|
||||
#if NODE_MODULE_VERSION < IOJS_3_0_MODULE_VERSION
|
||||
template <typename T>
|
||||
inline v8::Local<T> New(v8::Handle<T> h) {
|
||||
return v8::Local<T>::New(v8::Isolate::GetCurrent(), h);
|
||||
}
|
||||
#endif
|
||||
|
||||
template <typename T, typename M>
|
||||
inline v8::Local<T> New(v8::Persistent<T, M> const& p) {
|
||||
return v8::Local<T>::New(v8::Isolate::GetCurrent(), p);
|
||||
}
|
||||
|
||||
template <typename T, typename M>
|
||||
inline v8::Local<T> New(Persistent<T, M> const& p) {
|
||||
return v8::Local<T>::New(v8::Isolate::GetCurrent(), p);
|
||||
}
|
||||
|
||||
#endif // NAN_IMPLEMENTATION_12_INL_H_
|
||||
Generated
Vendored
+259
@@ -0,0 +1,259 @@
|
||||
/*********************************************************************
|
||||
* NAN - Native Abstractions for Node.js
|
||||
*
|
||||
* Copyright (c) 2015 NAN contributors
|
||||
*
|
||||
* MIT License <https://github.com/nodejs/nan/blob/master/LICENSE.md>
|
||||
********************************************************************/
|
||||
|
||||
#ifndef NAN_IMPLEMENTATION_PRE_12_INL_H_
|
||||
#define NAN_IMPLEMENTATION_PRE_12_INL_H_
|
||||
|
||||
//==============================================================================
|
||||
// node v0.10 implementation
|
||||
//==============================================================================
|
||||
|
||||
namespace imp {
|
||||
|
||||
//=== Array ====================================================================
|
||||
|
||||
Factory<v8::Array>::return_t
|
||||
Factory<v8::Array>::New() {
|
||||
return v8::Array::New();
|
||||
}
|
||||
|
||||
Factory<v8::Array>::return_t
|
||||
Factory<v8::Array>::New(int length) {
|
||||
return v8::Array::New(length);
|
||||
}
|
||||
|
||||
//=== Boolean ==================================================================
|
||||
|
||||
Factory<v8::Boolean>::return_t
|
||||
Factory<v8::Boolean>::New(bool value) {
|
||||
return v8::Boolean::New(value)->ToBoolean();
|
||||
}
|
||||
|
||||
//=== Boolean Object ===========================================================
|
||||
|
||||
Factory<v8::BooleanObject>::return_t
|
||||
Factory<v8::BooleanObject>::New(bool value) {
|
||||
return v8::BooleanObject::New(value).As<v8::BooleanObject>();
|
||||
}
|
||||
|
||||
//=== Context ==================================================================
|
||||
|
||||
Factory<v8::Context>::return_t
|
||||
Factory<v8::Context>::New( v8::ExtensionConfiguration* extensions
|
||||
, v8::Local<v8::ObjectTemplate> tmpl
|
||||
, v8::Local<v8::Value> obj) {
|
||||
v8::Persistent<v8::Context> ctx = v8::Context::New(extensions, tmpl, obj);
|
||||
v8::Local<v8::Context> lctx = v8::Local<v8::Context>::New(ctx);
|
||||
ctx.Dispose();
|
||||
return lctx;
|
||||
}
|
||||
|
||||
//=== Date =====================================================================
|
||||
|
||||
Factory<v8::Date>::return_t
|
||||
Factory<v8::Date>::New(double value) {
|
||||
return Factory<v8::Date>::return_t(v8::Date::New(value).As<v8::Date>());
|
||||
}
|
||||
|
||||
//=== External =================================================================
|
||||
|
||||
Factory<v8::External>::return_t
|
||||
Factory<v8::External>::New(void * value) {
|
||||
return v8::External::New(value);
|
||||
}
|
||||
|
||||
//=== Function =================================================================
|
||||
|
||||
Factory<v8::Function>::return_t
|
||||
Factory<v8::Function>::New( FunctionCallback callback
|
||||
, v8::Local<v8::Value> data) {
|
||||
return Factory<v8::FunctionTemplate>::New( callback
|
||||
, data
|
||||
, v8::Local<v8::Signature>()
|
||||
)->GetFunction();
|
||||
}
|
||||
|
||||
|
||||
//=== FunctionTemplate =========================================================
|
||||
|
||||
Factory<v8::FunctionTemplate>::return_t
|
||||
Factory<v8::FunctionTemplate>::New( FunctionCallback callback
|
||||
, v8::Local<v8::Value> data
|
||||
, v8::Local<v8::Signature> signature) {
|
||||
if (callback) {
|
||||
v8::HandleScope scope;
|
||||
|
||||
v8::Local<v8::ObjectTemplate> tpl = v8::ObjectTemplate::New();
|
||||
tpl->SetInternalFieldCount(imp::kFunctionFieldCount);
|
||||
v8::Local<v8::Object> obj = tpl->NewInstance();
|
||||
|
||||
obj->SetInternalField(
|
||||
imp::kFunctionIndex
|
||||
, v8::External::New(reinterpret_cast<void *>(callback)));
|
||||
|
||||
v8::Local<v8::Value> val = v8::Local<v8::Value>::New(data);
|
||||
|
||||
if (!val.IsEmpty()) {
|
||||
obj->SetInternalField(imp::kDataIndex, val);
|
||||
}
|
||||
|
||||
// Note(agnat): Emulate length argument here. Unfortunately, I couldn't find
|
||||
// a way. Have at it though...
|
||||
return scope.Close(
|
||||
v8::FunctionTemplate::New(imp::FunctionCallbackWrapper
|
||||
, obj
|
||||
, signature));
|
||||
} else {
|
||||
return v8::FunctionTemplate::New(0, data, signature);
|
||||
}
|
||||
}
|
||||
|
||||
//=== Number ===================================================================
|
||||
|
||||
Factory<v8::Number>::return_t
|
||||
Factory<v8::Number>::New(double value) {
|
||||
return v8::Number::New(value);
|
||||
}
|
||||
|
||||
//=== Number Object ============================================================
|
||||
|
||||
Factory<v8::NumberObject>::return_t
|
||||
Factory<v8::NumberObject>::New(double value) {
|
||||
return v8::NumberObject::New(value).As<v8::NumberObject>();
|
||||
}
|
||||
|
||||
//=== Integer, Int32 and Uint32 ================================================
|
||||
|
||||
template <typename T>
|
||||
typename IntegerFactory<T>::return_t
|
||||
IntegerFactory<T>::New(int32_t value) {
|
||||
return To<T>(T::New(value));
|
||||
}
|
||||
|
||||
template <typename T>
|
||||
typename IntegerFactory<T>::return_t
|
||||
IntegerFactory<T>::New(uint32_t value) {
|
||||
return To<T>(T::NewFromUnsigned(value));
|
||||
}
|
||||
|
||||
Factory<v8::Uint32>::return_t
|
||||
Factory<v8::Uint32>::New(int32_t value) {
|
||||
return To<v8::Uint32>(v8::Uint32::NewFromUnsigned(value));
|
||||
}
|
||||
|
||||
Factory<v8::Uint32>::return_t
|
||||
Factory<v8::Uint32>::New(uint32_t value) {
|
||||
return To<v8::Uint32>(v8::Uint32::NewFromUnsigned(value));
|
||||
}
|
||||
|
||||
|
||||
//=== Object ===================================================================
|
||||
|
||||
Factory<v8::Object>::return_t
|
||||
Factory<v8::Object>::New() {
|
||||
return v8::Object::New();
|
||||
}
|
||||
|
||||
//=== Object Template ==========================================================
|
||||
|
||||
Factory<v8::ObjectTemplate>::return_t
|
||||
Factory<v8::ObjectTemplate>::New() {
|
||||
return v8::ObjectTemplate::New();
|
||||
}
|
||||
|
||||
//=== RegExp ===================================================================
|
||||
|
||||
Factory<v8::RegExp>::return_t
|
||||
Factory<v8::RegExp>::New(
|
||||
v8::Local<v8::String> pattern
|
||||
, v8::RegExp::Flags flags) {
|
||||
return Factory<v8::RegExp>::return_t(v8::RegExp::New(pattern, flags));
|
||||
}
|
||||
|
||||
//=== Script ===================================================================
|
||||
|
||||
Factory<v8::Script>::return_t
|
||||
Factory<v8::Script>::New( v8::Local<v8::String> source) {
|
||||
return Factory<v8::Script>::return_t(v8::Script::New(source));
|
||||
}
|
||||
Factory<v8::Script>::return_t
|
||||
Factory<v8::Script>::New( v8::Local<v8::String> source
|
||||
, v8::ScriptOrigin const& origin) {
|
||||
return Factory<v8::Script>::return_t(
|
||||
v8::Script::New(source, const_cast<v8::ScriptOrigin*>(&origin)));
|
||||
}
|
||||
|
||||
//=== Signature ================================================================
|
||||
|
||||
Factory<v8::Signature>::return_t
|
||||
Factory<v8::Signature>::New(Factory<v8::Signature>::FTH receiver) {
|
||||
return v8::Signature::New(receiver);
|
||||
}
|
||||
|
||||
//=== String ===================================================================
|
||||
|
||||
Factory<v8::String>::return_t
|
||||
Factory<v8::String>::New() {
|
||||
return Factory<v8::String>::return_t(v8::String::Empty());
|
||||
}
|
||||
|
||||
Factory<v8::String>::return_t
|
||||
Factory<v8::String>::New(const char * value, int length) {
|
||||
return Factory<v8::String>::return_t(v8::String::New(value, length));
|
||||
}
|
||||
|
||||
Factory<v8::String>::return_t
|
||||
Factory<v8::String>::New(
|
||||
std::string const& value) /* NOLINT(build/include_what_you_use) */ {
|
||||
assert(value.size() <= INT_MAX && "string too long");
|
||||
return Factory<v8::String>::return_t(
|
||||
v8::String::New( value.data(), static_cast<int>(value.size())));
|
||||
}
|
||||
|
||||
Factory<v8::String>::return_t
|
||||
Factory<v8::String>::New(const uint16_t * value, int length) {
|
||||
return Factory<v8::String>::return_t(v8::String::New(value, length));
|
||||
}
|
||||
|
||||
Factory<v8::String>::return_t
|
||||
Factory<v8::String>::New(v8::String::ExternalStringResource * value) {
|
||||
return Factory<v8::String>::return_t(v8::String::NewExternal(value));
|
||||
}
|
||||
|
||||
Factory<v8::String>::return_t
|
||||
Factory<v8::String>::New(v8::String::ExternalAsciiStringResource * value) {
|
||||
return Factory<v8::String>::return_t(v8::String::NewExternal(value));
|
||||
}
|
||||
|
||||
//=== String Object ============================================================
|
||||
|
||||
Factory<v8::StringObject>::return_t
|
||||
Factory<v8::StringObject>::New(v8::Local<v8::String> value) {
|
||||
return v8::StringObject::New(value).As<v8::StringObject>();
|
||||
}
|
||||
|
||||
} // end of namespace imp
|
||||
|
||||
//=== Presistents and Handles ==================================================
|
||||
|
||||
template <typename T>
|
||||
inline v8::Local<T> New(v8::Handle<T> h) {
|
||||
return v8::Local<T>::New(h);
|
||||
}
|
||||
|
||||
template <typename T>
|
||||
inline v8::Local<T> New(v8::Persistent<T> const& p) {
|
||||
return v8::Local<T>::New(p);
|
||||
}
|
||||
|
||||
template <typename T, typename M>
|
||||
inline v8::Local<T> New(Persistent<T, M> const& p) {
|
||||
return v8::Local<T>::New(p.persistent);
|
||||
}
|
||||
|
||||
#endif // NAN_IMPLEMENTATION_PRE_12_INL_H_
|
||||
+224
@@ -0,0 +1,224 @@
|
||||
/*********************************************************************
|
||||
* NAN - Native Abstractions for Node.js
|
||||
*
|
||||
* Copyright (c) 2015 NAN contributors
|
||||
*
|
||||
* MIT License <https://github.com/nodejs/nan/blob/master/LICENSE.md>
|
||||
********************************************************************/
|
||||
|
||||
#ifndef NAN_MAYBE_43_INL_H_
|
||||
#define NAN_MAYBE_43_INL_H_
|
||||
|
||||
template<typename T>
|
||||
using MaybeLocal = v8::MaybeLocal<T>;
|
||||
|
||||
template<typename T>
|
||||
using Maybe = v8::Maybe<T>;
|
||||
|
||||
template<typename T>
|
||||
NAN_INLINE Maybe<T> Nothing() {
|
||||
return v8::Nothing<T>();
|
||||
}
|
||||
|
||||
template<typename T>
|
||||
NAN_INLINE Maybe<T> Just(const T& t) {
|
||||
return v8::Just<T>(t);
|
||||
}
|
||||
|
||||
v8::Local<v8::Context> GetCurrentContext();
|
||||
|
||||
NAN_INLINE
|
||||
MaybeLocal<v8::String> ToDetailString(v8::Local<v8::Value> val) {
|
||||
return val->ToDetailString(GetCurrentContext());
|
||||
}
|
||||
|
||||
NAN_INLINE
|
||||
MaybeLocal<v8::Uint32> ToArrayIndex(v8::Local<v8::Value> val) {
|
||||
return val->ToArrayIndex(GetCurrentContext());
|
||||
}
|
||||
|
||||
NAN_INLINE
|
||||
Maybe<bool> Equals(v8::Local<v8::Value> a, v8::Local<v8::Value>(b)) {
|
||||
return a->Equals(GetCurrentContext(), b);
|
||||
}
|
||||
|
||||
NAN_INLINE
|
||||
MaybeLocal<v8::Object> NewInstance(v8::Local<v8::Function> h) {
|
||||
return MaybeLocal<v8::Object>(h->NewInstance(GetCurrentContext()));
|
||||
}
|
||||
|
||||
NAN_INLINE
|
||||
MaybeLocal<v8::Object> NewInstance(
|
||||
v8::Local<v8::Function> h
|
||||
, int argc
|
||||
, v8::Local<v8::Value> argv[]) {
|
||||
return MaybeLocal<v8::Object>(h->NewInstance(GetCurrentContext(),
|
||||
argc, argv));
|
||||
}
|
||||
|
||||
NAN_INLINE
|
||||
MaybeLocal<v8::Object> NewInstance(v8::Local<v8::ObjectTemplate> h) {
|
||||
return MaybeLocal<v8::Object>(h->NewInstance(GetCurrentContext()));
|
||||
}
|
||||
|
||||
|
||||
NAN_INLINE MaybeLocal<v8::Function> GetFunction(
|
||||
v8::Local<v8::FunctionTemplate> t) {
|
||||
return t->GetFunction(GetCurrentContext());
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> Set(
|
||||
v8::Local<v8::Object> obj
|
||||
, v8::Local<v8::Value> key
|
||||
, v8::Local<v8::Value> value) {
|
||||
return obj->Set(GetCurrentContext(), key, value);
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> Set(
|
||||
v8::Local<v8::Object> obj
|
||||
, uint32_t index
|
||||
, v8::Local<v8::Value> value) {
|
||||
return obj->Set(GetCurrentContext(), index, value);
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> ForceSet(
|
||||
v8::Local<v8::Object> obj
|
||||
, v8::Local<v8::Value> key
|
||||
, v8::Local<v8::Value> value
|
||||
, v8::PropertyAttribute attribs = v8::None) {
|
||||
return obj->ForceSet(GetCurrentContext(), key, value, attribs);
|
||||
}
|
||||
|
||||
NAN_INLINE MaybeLocal<v8::Value> Get(
|
||||
v8::Local<v8::Object> obj
|
||||
, v8::Local<v8::Value> key) {
|
||||
return obj->Get(GetCurrentContext(), key);
|
||||
}
|
||||
|
||||
NAN_INLINE
|
||||
MaybeLocal<v8::Value> Get(v8::Local<v8::Object> obj, uint32_t index) {
|
||||
return obj->Get(GetCurrentContext(), index);
|
||||
}
|
||||
|
||||
NAN_INLINE v8::PropertyAttribute GetPropertyAttributes(
|
||||
v8::Local<v8::Object> obj
|
||||
, v8::Local<v8::Value> key) {
|
||||
return obj->GetPropertyAttributes(GetCurrentContext(), key).FromJust();
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> Has(
|
||||
v8::Local<v8::Object> obj
|
||||
, v8::Local<v8::String> key) {
|
||||
return obj->Has(GetCurrentContext(), key);
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> Has(v8::Local<v8::Object> obj, uint32_t index) {
|
||||
return obj->Has(GetCurrentContext(), index);
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> Delete(
|
||||
v8::Local<v8::Object> obj
|
||||
, v8::Local<v8::String> key) {
|
||||
return obj->Delete(GetCurrentContext(), key);
|
||||
}
|
||||
|
||||
NAN_INLINE
|
||||
Maybe<bool> Delete(v8::Local<v8::Object> obj, uint32_t index) {
|
||||
return obj->Delete(GetCurrentContext(), index);
|
||||
}
|
||||
|
||||
NAN_INLINE
|
||||
MaybeLocal<v8::Array> GetPropertyNames(v8::Local<v8::Object> obj) {
|
||||
return obj->GetPropertyNames(GetCurrentContext());
|
||||
}
|
||||
|
||||
NAN_INLINE
|
||||
MaybeLocal<v8::Array> GetOwnPropertyNames(v8::Local<v8::Object> obj) {
|
||||
return obj->GetOwnPropertyNames(GetCurrentContext());
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> SetPrototype(
|
||||
v8::Local<v8::Object> obj
|
||||
, v8::Local<v8::Value> prototype) {
|
||||
return obj->SetPrototype(GetCurrentContext(), prototype);
|
||||
}
|
||||
|
||||
NAN_INLINE MaybeLocal<v8::String> ObjectProtoToString(
|
||||
v8::Local<v8::Object> obj) {
|
||||
return obj->ObjectProtoToString(GetCurrentContext());
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> HasOwnProperty(
|
||||
v8::Local<v8::Object> obj
|
||||
, v8::Local<v8::String> key) {
|
||||
return obj->HasOwnProperty(GetCurrentContext(), key);
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> HasRealNamedProperty(
|
||||
v8::Local<v8::Object> obj
|
||||
, v8::Local<v8::String> key) {
|
||||
return obj->HasRealNamedProperty(GetCurrentContext(), key);
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> HasRealIndexedProperty(
|
||||
v8::Local<v8::Object> obj
|
||||
, uint32_t index) {
|
||||
return obj->HasRealIndexedProperty(GetCurrentContext(), index);
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> HasRealNamedCallbackProperty(
|
||||
v8::Local<v8::Object> obj
|
||||
, v8::Local<v8::String> key) {
|
||||
return obj->HasRealNamedCallbackProperty(GetCurrentContext(), key);
|
||||
}
|
||||
|
||||
NAN_INLINE MaybeLocal<v8::Value> GetRealNamedPropertyInPrototypeChain(
|
||||
v8::Local<v8::Object> obj
|
||||
, v8::Local<v8::String> key) {
|
||||
return obj->GetRealNamedPropertyInPrototypeChain(GetCurrentContext(), key);
|
||||
}
|
||||
|
||||
NAN_INLINE MaybeLocal<v8::Value> GetRealNamedProperty(
|
||||
v8::Local<v8::Object> obj
|
||||
, v8::Local<v8::String> key) {
|
||||
return obj->GetRealNamedProperty(GetCurrentContext(), key);
|
||||
}
|
||||
|
||||
NAN_INLINE MaybeLocal<v8::Value> CallAsFunction(
|
||||
v8::Local<v8::Object> obj
|
||||
, v8::Local<v8::Object> recv
|
||||
, int argc
|
||||
, v8::Local<v8::Value> argv[]) {
|
||||
return obj->CallAsFunction(GetCurrentContext(), recv, argc, argv);
|
||||
}
|
||||
|
||||
NAN_INLINE MaybeLocal<v8::Value> CallAsConstructor(
|
||||
v8::Local<v8::Object> obj
|
||||
, int argc, v8::Local<v8::Value> argv[]) {
|
||||
return obj->CallAsConstructor(GetCurrentContext(), argc, argv);
|
||||
}
|
||||
|
||||
NAN_INLINE
|
||||
MaybeLocal<v8::String> GetSourceLine(v8::Local<v8::Message> msg) {
|
||||
return msg->GetSourceLine(GetCurrentContext());
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<int> GetLineNumber(v8::Local<v8::Message> msg) {
|
||||
return msg->GetLineNumber(GetCurrentContext());
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<int> GetStartColumn(v8::Local<v8::Message> msg) {
|
||||
return msg->GetStartColumn(GetCurrentContext());
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<int> GetEndColumn(v8::Local<v8::Message> msg) {
|
||||
return msg->GetEndColumn(GetCurrentContext());
|
||||
}
|
||||
|
||||
NAN_INLINE MaybeLocal<v8::Object> CloneElementAt(
|
||||
v8::Local<v8::Array> array
|
||||
, uint32_t index) {
|
||||
return array->CloneElementAt(GetCurrentContext(), index);
|
||||
}
|
||||
|
||||
#endif // NAN_MAYBE_43_INL_H_
|
||||
+295
@@ -0,0 +1,295 @@
|
||||
/*********************************************************************
|
||||
* NAN - Native Abstractions for Node.js
|
||||
*
|
||||
* Copyright (c) 2015 NAN contributors
|
||||
*
|
||||
* MIT License <https://github.com/nodejs/nan/blob/master/LICENSE.md>
|
||||
********************************************************************/
|
||||
|
||||
#ifndef NAN_MAYBE_PRE_43_INL_H_
|
||||
#define NAN_MAYBE_PRE_43_INL_H_
|
||||
|
||||
template<typename T>
|
||||
class MaybeLocal {
|
||||
public:
|
||||
NAN_INLINE MaybeLocal() : val_(v8::Local<T>()) {}
|
||||
|
||||
template<typename S>
|
||||
# if NODE_MODULE_VERSION >= NODE_0_12_MODULE_VERSION
|
||||
NAN_INLINE MaybeLocal(v8::Local<S> that) : val_(that) {}
|
||||
# else
|
||||
NAN_INLINE MaybeLocal(v8::Local<S> that) :
|
||||
val_(*reinterpret_cast<v8::Local<T>*>(&that)) {}
|
||||
# endif
|
||||
|
||||
NAN_INLINE bool IsEmpty() const { return val_.IsEmpty(); }
|
||||
|
||||
template<typename S>
|
||||
NAN_INLINE bool ToLocal(v8::Local<S> *out) const {
|
||||
*out = val_;
|
||||
return !IsEmpty();
|
||||
}
|
||||
|
||||
NAN_INLINE v8::Local<T> ToLocalChecked() const {
|
||||
#if defined(V8_ENABLE_CHECKS)
|
||||
assert(!IsEmpty() && "ToLocalChecked is Empty");
|
||||
#endif // V8_ENABLE_CHECKS
|
||||
return val_;
|
||||
}
|
||||
|
||||
template<typename S>
|
||||
NAN_INLINE v8::Local<S> FromMaybe(v8::Local<S> default_value) const {
|
||||
return IsEmpty() ? default_value : val_;
|
||||
}
|
||||
|
||||
private:
|
||||
v8::Local<T> val_;
|
||||
};
|
||||
|
||||
template<typename T>
|
||||
class Maybe {
|
||||
public:
|
||||
NAN_INLINE bool IsNothing() const { return !has_value_; }
|
||||
NAN_INLINE bool IsJust() const { return has_value_; }
|
||||
|
||||
NAN_INLINE T FromJust() const {
|
||||
#if defined(V8_ENABLE_CHECKS)
|
||||
assert(IsJust() && "FromJust is Nothing");
|
||||
#endif // V8_ENABLE_CHECKS
|
||||
return value_;
|
||||
}
|
||||
|
||||
NAN_INLINE T FromMaybe(const T& default_value) const {
|
||||
return has_value_ ? value_ : default_value;
|
||||
}
|
||||
|
||||
NAN_INLINE bool operator==(const Maybe &other) const {
|
||||
return (IsJust() == other.IsJust()) &&
|
||||
(!IsJust() || FromJust() == other.FromJust());
|
||||
}
|
||||
|
||||
NAN_INLINE bool operator!=(const Maybe &other) const {
|
||||
return !operator==(other);
|
||||
}
|
||||
|
||||
private:
|
||||
Maybe() : has_value_(false) {}
|
||||
explicit Maybe(const T& t) : has_value_(true), value_(t) {}
|
||||
bool has_value_;
|
||||
T value_;
|
||||
|
||||
template<typename U>
|
||||
friend Maybe<U> Nothing();
|
||||
template<typename U>
|
||||
friend Maybe<U> Just(const U& u);
|
||||
};
|
||||
|
||||
template<typename T>
|
||||
inline Maybe<T> Nothing() {
|
||||
return Maybe<T>();
|
||||
}
|
||||
|
||||
template<typename T>
|
||||
inline Maybe<T> Just(const T& t) {
|
||||
return Maybe<T>(t);
|
||||
}
|
||||
|
||||
NAN_INLINE
|
||||
MaybeLocal<v8::String> ToDetailString(v8::Handle<v8::Value> val) {
|
||||
return MaybeLocal<v8::String>(val->ToDetailString());
|
||||
}
|
||||
|
||||
NAN_INLINE
|
||||
MaybeLocal<v8::Uint32> ToArrayIndex(v8::Handle<v8::Value> val) {
|
||||
return MaybeLocal<v8::Uint32>(val->ToArrayIndex());
|
||||
}
|
||||
|
||||
NAN_INLINE
|
||||
Maybe<bool> Equals(v8::Handle<v8::Value> a, v8::Handle<v8::Value>(b)) {
|
||||
return Just<bool>(a->Equals(b));
|
||||
}
|
||||
|
||||
NAN_INLINE
|
||||
MaybeLocal<v8::Object> NewInstance(v8::Handle<v8::Function> h) {
|
||||
return MaybeLocal<v8::Object>(h->NewInstance());
|
||||
}
|
||||
|
||||
NAN_INLINE
|
||||
MaybeLocal<v8::Object> NewInstance(
|
||||
v8::Local<v8::Function> h
|
||||
, int argc
|
||||
, v8::Local<v8::Value> argv[]) {
|
||||
return MaybeLocal<v8::Object>(h->NewInstance(argc, argv));
|
||||
}
|
||||
|
||||
NAN_INLINE
|
||||
MaybeLocal<v8::Object> NewInstance(v8::Handle<v8::ObjectTemplate> h) {
|
||||
return MaybeLocal<v8::Object>(h->NewInstance());
|
||||
}
|
||||
|
||||
NAN_INLINE
|
||||
MaybeLocal<v8::Function> GetFunction(v8::Handle<v8::FunctionTemplate> t) {
|
||||
return MaybeLocal<v8::Function>(t->GetFunction());
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> Set(
|
||||
v8::Handle<v8::Object> obj
|
||||
, v8::Handle<v8::Value> key
|
||||
, v8::Handle<v8::Value> value) {
|
||||
return Just<bool>(obj->Set(key, value));
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> Set(
|
||||
v8::Handle<v8::Object> obj
|
||||
, uint32_t index
|
||||
, v8::Handle<v8::Value> value) {
|
||||
return Just<bool>(obj->Set(index, value));
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> ForceSet(
|
||||
v8::Handle<v8::Object> obj
|
||||
, v8::Handle<v8::Value> key
|
||||
, v8::Handle<v8::Value> value
|
||||
, v8::PropertyAttribute attribs = v8::None) {
|
||||
return Just<bool>(obj->ForceSet(key, value, attribs));
|
||||
}
|
||||
|
||||
NAN_INLINE MaybeLocal<v8::Value> Get(
|
||||
v8::Handle<v8::Object> obj
|
||||
, v8::Handle<v8::Value> key) {
|
||||
return MaybeLocal<v8::Value>(obj->Get(key));
|
||||
}
|
||||
|
||||
NAN_INLINE MaybeLocal<v8::Value> Get(
|
||||
v8::Handle<v8::Object> obj
|
||||
, uint32_t index) {
|
||||
return MaybeLocal<v8::Value>(obj->Get(index));
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<v8::PropertyAttribute> GetPropertyAttributes(
|
||||
v8::Handle<v8::Object> obj
|
||||
, v8::Handle<v8::Value> key) {
|
||||
return Just<v8::PropertyAttribute>(obj->GetPropertyAttributes(key));
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> Has(
|
||||
v8::Handle<v8::Object> obj
|
||||
, v8::Handle<v8::String> key) {
|
||||
return Just<bool>(obj->Has(key));
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> Has(
|
||||
v8::Handle<v8::Object> obj
|
||||
, uint32_t index) {
|
||||
return Just<bool>(obj->Has(index));
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> Delete(
|
||||
v8::Handle<v8::Object> obj
|
||||
, v8::Handle<v8::String> key) {
|
||||
return Just<bool>(obj->Delete(key));
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> Delete(
|
||||
v8::Handle<v8::Object> obj
|
||||
, uint32_t index) {
|
||||
return Just<bool>(obj->Delete(index));
|
||||
}
|
||||
|
||||
NAN_INLINE
|
||||
MaybeLocal<v8::Array> GetPropertyNames(v8::Handle<v8::Object> obj) {
|
||||
return MaybeLocal<v8::Array>(obj->GetPropertyNames());
|
||||
}
|
||||
|
||||
NAN_INLINE
|
||||
MaybeLocal<v8::Array> GetOwnPropertyNames(v8::Handle<v8::Object> obj) {
|
||||
return MaybeLocal<v8::Array>(obj->GetOwnPropertyNames());
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> SetPrototype(
|
||||
v8::Handle<v8::Object> obj
|
||||
, v8::Handle<v8::Value> prototype) {
|
||||
return Just<bool>(obj->SetPrototype(prototype));
|
||||
}
|
||||
|
||||
NAN_INLINE MaybeLocal<v8::String> ObjectProtoToString(
|
||||
v8::Handle<v8::Object> obj) {
|
||||
return MaybeLocal<v8::String>(obj->ObjectProtoToString());
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> HasOwnProperty(
|
||||
v8::Handle<v8::Object> obj
|
||||
, v8::Handle<v8::String> key) {
|
||||
return Just<bool>(obj->HasOwnProperty(key));
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> HasRealNamedProperty(
|
||||
v8::Handle<v8::Object> obj
|
||||
, v8::Handle<v8::String> key) {
|
||||
return Just<bool>(obj->HasRealNamedProperty(key));
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> HasRealIndexedProperty(
|
||||
v8::Handle<v8::Object> obj
|
||||
, uint32_t index) {
|
||||
return Just<bool>(obj->HasRealIndexedProperty(index));
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<bool> HasRealNamedCallbackProperty(
|
||||
v8::Handle<v8::Object> obj
|
||||
, v8::Handle<v8::String> key) {
|
||||
return Just<bool>(obj->HasRealNamedCallbackProperty(key));
|
||||
}
|
||||
|
||||
NAN_INLINE MaybeLocal<v8::Value> GetRealNamedPropertyInPrototypeChain(
|
||||
v8::Handle<v8::Object> obj
|
||||
, v8::Handle<v8::String> key) {
|
||||
return MaybeLocal<v8::Value>(
|
||||
obj->GetRealNamedPropertyInPrototypeChain(key));
|
||||
}
|
||||
|
||||
NAN_INLINE MaybeLocal<v8::Value> GetRealNamedProperty(
|
||||
v8::Handle<v8::Object> obj
|
||||
, v8::Handle<v8::String> key) {
|
||||
return MaybeLocal<v8::Value>(obj->GetRealNamedProperty(key));
|
||||
}
|
||||
|
||||
NAN_INLINE MaybeLocal<v8::Value> CallAsFunction(
|
||||
v8::Handle<v8::Object> obj
|
||||
, v8::Handle<v8::Object> recv
|
||||
, int argc
|
||||
, v8::Handle<v8::Value> argv[]) {
|
||||
return MaybeLocal<v8::Value>(obj->CallAsFunction(recv, argc, argv));
|
||||
}
|
||||
|
||||
NAN_INLINE MaybeLocal<v8::Value> CallAsConstructor(
|
||||
v8::Handle<v8::Object> obj
|
||||
, int argc
|
||||
, v8::Local<v8::Value> argv[]) {
|
||||
return MaybeLocal<v8::Value>(obj->CallAsConstructor(argc, argv));
|
||||
}
|
||||
|
||||
NAN_INLINE
|
||||
MaybeLocal<v8::String> GetSourceLine(v8::Handle<v8::Message> msg) {
|
||||
return MaybeLocal<v8::String>(msg->GetSourceLine());
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<int> GetLineNumber(v8::Handle<v8::Message> msg) {
|
||||
return Just<int>(msg->GetLineNumber());
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<int> GetStartColumn(v8::Handle<v8::Message> msg) {
|
||||
return Just<int>(msg->GetStartColumn());
|
||||
}
|
||||
|
||||
NAN_INLINE Maybe<int> GetEndColumn(v8::Handle<v8::Message> msg) {
|
||||
return Just<int>(msg->GetEndColumn());
|
||||
}
|
||||
|
||||
NAN_INLINE MaybeLocal<v8::Object> CloneElementAt(
|
||||
v8::Handle<v8::Array> array
|
||||
, uint32_t index) {
|
||||
return MaybeLocal<v8::Object>(array->CloneElementAt(index));
|
||||
}
|
||||
|
||||
#endif // NAN_MAYBE_PRE_43_INL_H_
|
||||
+332
@@ -0,0 +1,332 @@
|
||||
/*********************************************************************
|
||||
* NAN - Native Abstractions for Node.js
|
||||
*
|
||||
* Copyright (c) 2015 NAN contributors
|
||||
*
|
||||
* MIT License <https://github.com/nodejs/nan/blob/master/LICENSE.md>
|
||||
********************************************************************/
|
||||
|
||||
#ifndef NAN_NEW_H_
|
||||
#define NAN_NEW_H_
|
||||
|
||||
namespace imp { // scnr
|
||||
|
||||
// TODO(agnat): Generalize
|
||||
template <typename T> v8::Local<T> To(v8::Local<v8::Integer> i);
|
||||
|
||||
template <>
|
||||
inline
|
||||
v8::Local<v8::Integer>
|
||||
To<v8::Integer>(v8::Local<v8::Integer> i) {
|
||||
return Nan::To<v8::Integer>(i).ToLocalChecked();
|
||||
}
|
||||
|
||||
template <>
|
||||
inline
|
||||
v8::Local<v8::Int32>
|
||||
To<v8::Int32>(v8::Local<v8::Integer> i) {
|
||||
return Nan::To<v8::Int32>(i).ToLocalChecked();
|
||||
}
|
||||
|
||||
template <>
|
||||
inline
|
||||
v8::Local<v8::Uint32>
|
||||
To<v8::Uint32>(v8::Local<v8::Integer> i) {
|
||||
return Nan::To<v8::Uint32>(i).ToLocalChecked();
|
||||
}
|
||||
|
||||
template <typename T> struct FactoryBase {
|
||||
typedef v8::Local<T> return_t;
|
||||
};
|
||||
|
||||
template <typename T> struct MaybeFactoryBase {
|
||||
typedef MaybeLocal<T> return_t;
|
||||
};
|
||||
|
||||
template <typename T> struct Factory;
|
||||
|
||||
template <>
|
||||
struct Factory<v8::Array> : FactoryBase<v8::Array> {
|
||||
static inline return_t New();
|
||||
static inline return_t New(int length);
|
||||
};
|
||||
|
||||
template <>
|
||||
struct Factory<v8::Boolean> : FactoryBase<v8::Boolean> {
|
||||
static inline return_t New(bool value);
|
||||
};
|
||||
|
||||
template <>
|
||||
struct Factory<v8::BooleanObject> : FactoryBase<v8::BooleanObject> {
|
||||
static inline return_t New(bool value);
|
||||
};
|
||||
|
||||
template <>
|
||||
struct Factory<v8::Context> : FactoryBase<v8::Context> {
|
||||
static inline
|
||||
return_t
|
||||
New( v8::ExtensionConfiguration* extensions = NULL
|
||||
, v8::Local<v8::ObjectTemplate> tmpl = v8::Local<v8::ObjectTemplate>()
|
||||
, v8::Local<v8::Value> obj = v8::Local<v8::Value>());
|
||||
};
|
||||
|
||||
template <>
|
||||
struct Factory<v8::Date> : MaybeFactoryBase<v8::Date> {
|
||||
static inline return_t New(double value);
|
||||
};
|
||||
|
||||
template <>
|
||||
struct Factory<v8::External> : FactoryBase<v8::External> {
|
||||
static inline return_t New(void *value);
|
||||
};
|
||||
|
||||
template <>
|
||||
struct Factory<v8::Function> : FactoryBase<v8::Function> {
|
||||
static inline
|
||||
return_t
|
||||
New( FunctionCallback callback
|
||||
, v8::Local<v8::Value> data = v8::Local<v8::Value>());
|
||||
};
|
||||
|
||||
template <>
|
||||
struct Factory<v8::FunctionTemplate> : FactoryBase<v8::FunctionTemplate> {
|
||||
static inline
|
||||
return_t
|
||||
New( FunctionCallback callback = NULL
|
||||
, v8::Local<v8::Value> data = v8::Local<v8::Value>()
|
||||
, v8::Local<v8::Signature> signature = v8::Local<v8::Signature>());
|
||||
};
|
||||
|
||||
template <>
|
||||
struct Factory<v8::Number> : FactoryBase<v8::Number> {
|
||||
static inline return_t New(double value);
|
||||
};
|
||||
|
||||
template <>
|
||||
struct Factory<v8::NumberObject> : FactoryBase<v8::NumberObject> {
|
||||
static inline return_t New(double value);
|
||||
};
|
||||
|
||||
template <typename T>
|
||||
struct IntegerFactory : FactoryBase<T> {
|
||||
typedef typename FactoryBase<T>::return_t return_t;
|
||||
static inline return_t New(int32_t value);
|
||||
static inline return_t New(uint32_t value);
|
||||
};
|
||||
|
||||
template <>
|
||||
struct Factory<v8::Integer> : IntegerFactory<v8::Integer> {};
|
||||
|
||||
template <>
|
||||
struct Factory<v8::Int32> : IntegerFactory<v8::Int32> {};
|
||||
|
||||
template <>
|
||||
struct Factory<v8::Uint32> : FactoryBase<v8::Uint32> {
|
||||
static inline return_t New(int32_t value);
|
||||
static inline return_t New(uint32_t value);
|
||||
};
|
||||
|
||||
template <>
|
||||
struct Factory<v8::Object> : FactoryBase<v8::Object> {
|
||||
static inline return_t New();
|
||||
};
|
||||
|
||||
template <>
|
||||
struct Factory<v8::ObjectTemplate> : FactoryBase<v8::ObjectTemplate> {
|
||||
static inline return_t New();
|
||||
};
|
||||
|
||||
template <>
|
||||
struct Factory<v8::RegExp> : MaybeFactoryBase<v8::RegExp> {
|
||||
static inline return_t New(
|
||||
v8::Local<v8::String> pattern, v8::RegExp::Flags flags);
|
||||
};
|
||||
|
||||
template <>
|
||||
struct Factory<v8::Script> : MaybeFactoryBase<v8::Script> {
|
||||
static inline return_t New( v8::Local<v8::String> source);
|
||||
static inline return_t New( v8::Local<v8::String> source
|
||||
, v8::ScriptOrigin const& origin);
|
||||
};
|
||||
|
||||
template <>
|
||||
struct Factory<v8::Signature> : FactoryBase<v8::Signature> {
|
||||
typedef v8::Local<v8::FunctionTemplate> FTH;
|
||||
static inline return_t New(FTH receiver = FTH());
|
||||
};
|
||||
|
||||
template <>
|
||||
struct Factory<v8::String> : MaybeFactoryBase<v8::String> {
|
||||
static inline return_t New();
|
||||
static inline return_t New(const char *value, int length = -1);
|
||||
static inline return_t New(const uint16_t *value, int length = -1);
|
||||
static inline return_t New(std::string const& value);
|
||||
|
||||
static inline return_t New(v8::String::ExternalStringResource * value);
|
||||
static inline return_t New(ExternalOneByteStringResource * value);
|
||||
};
|
||||
|
||||
template <>
|
||||
struct Factory<v8::StringObject> : FactoryBase<v8::StringObject> {
|
||||
static inline return_t New(v8::Local<v8::String> value);
|
||||
};
|
||||
|
||||
} // end of namespace imp
|
||||
|
||||
#if (NODE_MODULE_VERSION >= 12)
|
||||
|
||||
namespace imp {
|
||||
|
||||
template <>
|
||||
struct Factory<v8::UnboundScript> : MaybeFactoryBase<v8::UnboundScript> {
|
||||
static inline return_t New( v8::Local<v8::String> source);
|
||||
static inline return_t New( v8::Local<v8::String> source
|
||||
, v8::ScriptOrigin const& origin);
|
||||
};
|
||||
|
||||
} // end of namespace imp
|
||||
|
||||
# include "nan_implementation_12_inl.h"
|
||||
|
||||
#else // NODE_MODULE_VERSION >= 12
|
||||
|
||||
# include "nan_implementation_pre_12_inl.h"
|
||||
|
||||
#endif
|
||||
|
||||
//=== API ======================================================================
|
||||
|
||||
template <typename T>
|
||||
typename imp::Factory<T>::return_t
|
||||
New() {
|
||||
return imp::Factory<T>::New();
|
||||
}
|
||||
|
||||
template <typename T, typename A0>
|
||||
typename imp::Factory<T>::return_t
|
||||
New(A0 arg0) {
|
||||
return imp::Factory<T>::New(arg0);
|
||||
}
|
||||
|
||||
template <typename T, typename A0, typename A1>
|
||||
typename imp::Factory<T>::return_t
|
||||
New(A0 arg0, A1 arg1) {
|
||||
return imp::Factory<T>::New(arg0, arg1);
|
||||
}
|
||||
|
||||
template <typename T, typename A0, typename A1, typename A2>
|
||||
typename imp::Factory<T>::return_t
|
||||
New(A0 arg0, A1 arg1, A2 arg2) {
|
||||
return imp::Factory<T>::New(arg0, arg1, arg2);
|
||||
}
|
||||
|
||||
template <typename T, typename A0, typename A1, typename A2, typename A3>
|
||||
typename imp::Factory<T>::return_t
|
||||
New(A0 arg0, A1 arg1, A2 arg2, A3 arg3) {
|
||||
return imp::Factory<T>::New(arg0, arg1, arg2, arg3);
|
||||
}
|
||||
|
||||
// Note(agnat): When passing overloaded function pointers to template functions
|
||||
// as generic arguments the compiler needs help in picking the right overload.
|
||||
// These two functions handle New<Function> and New<FunctionTemplate> with
|
||||
// all argument variations.
|
||||
|
||||
// v8::Function and v8::FunctionTemplate with one or two arguments
|
||||
template <typename T>
|
||||
typename imp::Factory<T>::return_t
|
||||
New( FunctionCallback callback
|
||||
, v8::Local<v8::Value> data = v8::Local<v8::Value>()) {
|
||||
return imp::Factory<T>::New(callback, data);
|
||||
}
|
||||
|
||||
// v8::Function and v8::FunctionTemplate with three arguments
|
||||
template <typename T, typename A2>
|
||||
typename imp::Factory<T>::return_t
|
||||
New( FunctionCallback callback
|
||||
, v8::Local<v8::Value> data = v8::Local<v8::Value>()
|
||||
, A2 a2 = A2()) {
|
||||
return imp::Factory<T>::New(callback, data, a2);
|
||||
}
|
||||
|
||||
// Convenience
|
||||
|
||||
#if NODE_MODULE_VERSION < IOJS_3_0_MODULE_VERSION
|
||||
template <typename T> inline v8::Local<T> New(v8::Handle<T> h);
|
||||
#endif
|
||||
|
||||
#if NODE_MODULE_VERSION > NODE_0_10_MODULE_VERSION
|
||||
template <typename T, typename M>
|
||||
inline v8::Local<T> New(v8::Persistent<T, M> const& p);
|
||||
#else
|
||||
template <typename T> inline v8::Local<T> New(v8::Persistent<T> const& p);
|
||||
#endif
|
||||
template <typename T, typename M>
|
||||
inline v8::Local<T> New(Persistent<T, M> const& p);
|
||||
|
||||
inline
|
||||
imp::Factory<v8::Boolean>::return_t
|
||||
New(bool value) {
|
||||
return New<v8::Boolean>(value);
|
||||
}
|
||||
|
||||
inline
|
||||
imp::Factory<v8::Int32>::return_t
|
||||
New(int32_t value) {
|
||||
return New<v8::Int32>(value);
|
||||
}
|
||||
|
||||
inline
|
||||
imp::Factory<v8::Uint32>::return_t
|
||||
New(uint32_t value) {
|
||||
return New<v8::Uint32>(value);
|
||||
}
|
||||
|
||||
inline
|
||||
imp::Factory<v8::Number>::return_t
|
||||
New(double value) {
|
||||
return New<v8::Number>(value);
|
||||
}
|
||||
|
||||
inline
|
||||
imp::Factory<v8::String>::return_t
|
||||
New(std::string const& value) { // NOLINT(build/include_what_you_use)
|
||||
return New<v8::String>(value);
|
||||
}
|
||||
|
||||
inline
|
||||
imp::Factory<v8::String>::return_t
|
||||
New(const char * value, int length) {
|
||||
return New<v8::String>(value, length);
|
||||
}
|
||||
|
||||
inline
|
||||
imp::Factory<v8::String>::return_t
|
||||
New(const char * value) {
|
||||
return New<v8::String>(value);
|
||||
}
|
||||
|
||||
inline
|
||||
imp::Factory<v8::String>::return_t
|
||||
New(const uint16_t * value) {
|
||||
return New<v8::String>(value);
|
||||
}
|
||||
|
||||
inline
|
||||
imp::Factory<v8::String>::return_t
|
||||
New(v8::String::ExternalStringResource * value) {
|
||||
return New<v8::String>(value);
|
||||
}
|
||||
|
||||
inline
|
||||
imp::Factory<v8::String>::return_t
|
||||
New(ExternalOneByteStringResource * value) {
|
||||
return New<v8::String>(value);
|
||||
}
|
||||
|
||||
inline
|
||||
imp::Factory<v8::RegExp>::return_t
|
||||
New(v8::Local<v8::String> pattern, v8::RegExp::Flags flags) {
|
||||
return New<v8::RegExp>(pattern, flags);
|
||||
}
|
||||
|
||||
#endif // NAN_NEW_H_
|
||||
+155
@@ -0,0 +1,155 @@
|
||||
/*********************************************************************
|
||||
* NAN - Native Abstractions for Node.js
|
||||
*
|
||||
* Copyright (c) 2015 NAN contributors
|
||||
*
|
||||
* MIT License <https://github.com/nodejs/nan/blob/master/LICENSE.md>
|
||||
********************************************************************/
|
||||
|
||||
#ifndef NAN_OBJECT_WRAP_H_
|
||||
#define NAN_OBJECT_WRAP_H_
|
||||
|
||||
class ObjectWrap {
|
||||
public:
|
||||
ObjectWrap() {
|
||||
refs_ = 0;
|
||||
}
|
||||
|
||||
|
||||
virtual ~ObjectWrap() {
|
||||
if (persistent().IsEmpty()) {
|
||||
return;
|
||||
}
|
||||
|
||||
assert(persistent().IsNearDeath());
|
||||
persistent().ClearWeak();
|
||||
persistent().Reset();
|
||||
}
|
||||
|
||||
|
||||
template <class T>
|
||||
static inline T* Unwrap(v8::Local<v8::Object> object) {
|
||||
assert(!object.IsEmpty());
|
||||
assert(object->InternalFieldCount() > 0);
|
||||
// Cast to ObjectWrap before casting to T. A direct cast from void
|
||||
// to T won't work right when T has more than one base class.
|
||||
void* ptr = GetInternalFieldPointer(object, 0);
|
||||
ObjectWrap* wrap = static_cast<ObjectWrap*>(ptr);
|
||||
return static_cast<T*>(wrap);
|
||||
}
|
||||
|
||||
|
||||
inline v8::Local<v8::Object> handle() {
|
||||
return New(persistent());
|
||||
}
|
||||
|
||||
|
||||
inline Persistent<v8::Object>& persistent() {
|
||||
return handle_;
|
||||
}
|
||||
|
||||
|
||||
protected:
|
||||
inline void Wrap(v8::Local<v8::Object> object) {
|
||||
assert(persistent().IsEmpty());
|
||||
assert(object->InternalFieldCount() > 0);
|
||||
SetInternalFieldPointer(object, 0, this);
|
||||
persistent().Reset(object);
|
||||
MakeWeak();
|
||||
}
|
||||
|
||||
#if defined(V8_MAJOR_VERSION) && (V8_MAJOR_VERSION > 4 || \
|
||||
(V8_MAJOR_VERSION == 4 && defined(V8_MINOR_VERSION) && V8_MINOR_VERSION >= 3))
|
||||
|
||||
inline void MakeWeak() {
|
||||
persistent().v8::PersistentBase<v8::Object>::SetWeak(
|
||||
this, WeakCallback, v8::WeakCallbackType::kParameter);
|
||||
persistent().MarkIndependent();
|
||||
}
|
||||
|
||||
#elif NODE_MODULE_VERSION > NODE_0_10_MODULE_VERSION
|
||||
|
||||
inline void MakeWeak() {
|
||||
persistent().v8::PersistentBase<v8::Object>::SetWeak(this, WeakCallback);
|
||||
persistent().MarkIndependent();
|
||||
}
|
||||
|
||||
#else
|
||||
|
||||
inline void MakeWeak() {
|
||||
persistent().persistent.MakeWeak(this, WeakCallback);
|
||||
persistent().MarkIndependent();
|
||||
}
|
||||
|
||||
#endif
|
||||
|
||||
/* Ref() marks the object as being attached to an event loop.
|
||||
* Refed objects will not be garbage collected, even if
|
||||
* all references are lost.
|
||||
*/
|
||||
virtual void Ref() {
|
||||
assert(!persistent().IsEmpty());
|
||||
persistent().ClearWeak();
|
||||
refs_++;
|
||||
}
|
||||
|
||||
/* Unref() marks an object as detached from the event loop. This is its
|
||||
* default state. When an object with a "weak" reference changes from
|
||||
* attached to detached state it will be freed. Be careful not to access
|
||||
* the object after making this call as it might be gone!
|
||||
* (A "weak reference" means an object that only has a
|
||||
* persistant handle.)
|
||||
*
|
||||
* DO NOT CALL THIS FROM DESTRUCTOR
|
||||
*/
|
||||
virtual void Unref() {
|
||||
assert(!persistent().IsEmpty());
|
||||
assert(!persistent().IsWeak());
|
||||
assert(refs_ > 0);
|
||||
if (--refs_ == 0)
|
||||
MakeWeak();
|
||||
}
|
||||
|
||||
int refs_; // ro
|
||||
|
||||
private:
|
||||
NAN_DISALLOW_ASSIGN_COPY_MOVE(ObjectWrap)
|
||||
#if defined(V8_MAJOR_VERSION) && (V8_MAJOR_VERSION > 4 || \
|
||||
(V8_MAJOR_VERSION == 4 && defined(V8_MINOR_VERSION) && V8_MINOR_VERSION >= 3))
|
||||
|
||||
static void
|
||||
WeakCallback(v8::WeakCallbackInfo<ObjectWrap> const& info) {
|
||||
ObjectWrap* wrap = info.GetParameter();
|
||||
assert(wrap->refs_ == 0);
|
||||
assert(wrap->handle_.IsNearDeath());
|
||||
wrap->handle_.Reset();
|
||||
delete wrap;
|
||||
}
|
||||
|
||||
#elif NODE_MODULE_VERSION > NODE_0_10_MODULE_VERSION
|
||||
|
||||
static void
|
||||
WeakCallback(v8::WeakCallbackData<v8::Object, ObjectWrap> const& data) {
|
||||
ObjectWrap* wrap = data.GetParameter();
|
||||
assert(wrap->refs_ == 0);
|
||||
assert(wrap->handle_.IsNearDeath());
|
||||
wrap->handle_.Reset();
|
||||
delete wrap;
|
||||
}
|
||||
|
||||
#else
|
||||
|
||||
static void WeakCallback(v8::Persistent<v8::Value> value, void *data) {
|
||||
ObjectWrap *wrap = static_cast<ObjectWrap*>(data);
|
||||
assert(wrap->refs_ == 0);
|
||||
assert(wrap->handle_.IsNearDeath());
|
||||
wrap->handle_.Reset();
|
||||
delete wrap;
|
||||
}
|
||||
|
||||
#endif
|
||||
Persistent<v8::Object> handle_;
|
||||
};
|
||||
|
||||
|
||||
#endif // NAN_OBJECT_WRAP_H_
|
||||
+129
@@ -0,0 +1,129 @@
|
||||
/*********************************************************************
|
||||
* NAN - Native Abstractions for Node.js
|
||||
*
|
||||
* Copyright (c) 2015 NAN contributors
|
||||
*
|
||||
* MIT License <https://github.com/nodejs/nan/blob/master/LICENSE.md>
|
||||
********************************************************************/
|
||||
|
||||
#ifndef NAN_PERSISTENT_12_INL_H_
|
||||
#define NAN_PERSISTENT_12_INL_H_
|
||||
|
||||
template<typename T, typename M> class Persistent :
|
||||
public v8::Persistent<T, M> {
|
||||
public:
|
||||
NAN_INLINE Persistent() : v8::Persistent<T, M>() {}
|
||||
|
||||
template<typename S> NAN_INLINE Persistent(v8::Local<S> that) :
|
||||
v8::Persistent<T, M>(v8::Isolate::GetCurrent(), that) {}
|
||||
|
||||
template<typename S, typename M2>
|
||||
NAN_INLINE Persistent(const v8::Persistent<S, M2> &that) :
|
||||
v8::Persistent<T, M2>(v8::Isolate::GetCurrent(), that) {}
|
||||
|
||||
NAN_INLINE void Reset() { v8::PersistentBase<T>::Reset(); }
|
||||
|
||||
template <typename S>
|
||||
NAN_INLINE void Reset(const v8::Local<S> &other) {
|
||||
v8::PersistentBase<T>::Reset(v8::Isolate::GetCurrent(), other);
|
||||
}
|
||||
|
||||
template <typename S>
|
||||
NAN_INLINE void Reset(const v8::PersistentBase<S> &other) {
|
||||
v8::PersistentBase<T>::Reset(v8::Isolate::GetCurrent(), other);
|
||||
}
|
||||
|
||||
template<typename P>
|
||||
NAN_INLINE void SetWeak(
|
||||
P *parameter
|
||||
, typename WeakCallbackInfo<P>::Callback callback
|
||||
, WeakCallbackType type);
|
||||
|
||||
private:
|
||||
NAN_INLINE T *operator*() const { return *PersistentBase<T>::persistent; }
|
||||
|
||||
template<typename S, typename M2>
|
||||
NAN_INLINE void Copy(const Persistent<S, M2> &that) {
|
||||
TYPE_CHECK(T, S);
|
||||
|
||||
this->Reset();
|
||||
|
||||
if (!that.IsEmpty()) {
|
||||
this->Reset(that);
|
||||
M::Copy(that, this);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
#if defined(V8_MAJOR_VERSION) && (V8_MAJOR_VERSION > 4 || \
|
||||
(V8_MAJOR_VERSION == 4 && defined(V8_MINOR_VERSION) && V8_MINOR_VERSION >= 3))
|
||||
template<typename T>
|
||||
class Global : public v8::Global<T> {
|
||||
public:
|
||||
NAN_INLINE Global() : v8::Global<T>() {}
|
||||
|
||||
template<typename S> NAN_INLINE Global(v8::Local<S> that) :
|
||||
v8::Global<T>(v8::Isolate::GetCurrent(), that) {}
|
||||
|
||||
template<typename S>
|
||||
NAN_INLINE Global(const v8::PersistentBase<S> &that) :
|
||||
v8::Global<S>(v8::Isolate::GetCurrent(), that) {}
|
||||
|
||||
NAN_INLINE void Reset() { v8::PersistentBase<T>::Reset(); }
|
||||
|
||||
template <typename S>
|
||||
NAN_INLINE void Reset(const v8::Local<S> &other) {
|
||||
v8::PersistentBase<T>::Reset(v8::Isolate::GetCurrent(), other);
|
||||
}
|
||||
|
||||
template <typename S>
|
||||
NAN_INLINE void Reset(const v8::PersistentBase<S> &other) {
|
||||
v8::PersistentBase<T>::Reset(v8::Isolate::GetCurrent(), other);
|
||||
}
|
||||
|
||||
template<typename P>
|
||||
NAN_INLINE void SetWeak(
|
||||
P *parameter
|
||||
, typename WeakCallbackInfo<P>::Callback callback
|
||||
, WeakCallbackType type) {
|
||||
reinterpret_cast<Persistent<T>*>(this)->SetWeak(
|
||||
parameter, callback, type);
|
||||
}
|
||||
};
|
||||
#else
|
||||
template<typename T>
|
||||
class Global : public v8::UniquePersistent<T> {
|
||||
public:
|
||||
NAN_INLINE Global() : v8::UniquePersistent<T>() {}
|
||||
|
||||
template<typename S> NAN_INLINE Global(v8::Local<S> that) :
|
||||
v8::UniquePersistent<T>(v8::Isolate::GetCurrent(), that) {}
|
||||
|
||||
template<typename S>
|
||||
NAN_INLINE Global(const v8::PersistentBase<S> &that) :
|
||||
v8::UniquePersistent<S>(v8::Isolate::GetCurrent(), that) {}
|
||||
|
||||
NAN_INLINE void Reset() { v8::PersistentBase<T>::Reset(); }
|
||||
|
||||
template <typename S>
|
||||
NAN_INLINE void Reset(const v8::Local<S> &other) {
|
||||
v8::PersistentBase<T>::Reset(v8::Isolate::GetCurrent(), other);
|
||||
}
|
||||
|
||||
template <typename S>
|
||||
NAN_INLINE void Reset(const v8::PersistentBase<S> &other) {
|
||||
v8::PersistentBase<T>::Reset(v8::Isolate::GetCurrent(), other);
|
||||
}
|
||||
|
||||
template<typename P>
|
||||
NAN_INLINE void SetWeak(
|
||||
P *parameter
|
||||
, typename WeakCallbackInfo<P>::Callback callback
|
||||
, WeakCallbackType type) {
|
||||
reinterpret_cast<Persistent<T>*>(this)->SetWeak(
|
||||
parameter, callback, type);
|
||||
}
|
||||
};
|
||||
#endif
|
||||
|
||||
#endif // NAN_PERSISTENT_12_INL_H_
|
||||
Generated
Vendored
+238
@@ -0,0 +1,238 @@
|
||||
/*********************************************************************
|
||||
* NAN - Native Abstractions for Node.js
|
||||
*
|
||||
* Copyright (c) 2015 NAN contributors
|
||||
*
|
||||
* MIT License <https://github.com/nodejs/nan/blob/master/LICENSE.md>
|
||||
********************************************************************/
|
||||
|
||||
#ifndef NAN_PERSISTENT_PRE_12_INL_H_
|
||||
#define NAN_PERSISTENT_PRE_12_INL_H_
|
||||
|
||||
template<typename T>
|
||||
class PersistentBase {
|
||||
v8::Persistent<T> persistent;
|
||||
template<typename U, typename M>
|
||||
friend v8::Local<U> New(const Persistent<U, M> &p);
|
||||
template<typename S> friend class ReturnValue;
|
||||
|
||||
public:
|
||||
NAN_INLINE PersistentBase() :
|
||||
persistent() {}
|
||||
|
||||
NAN_INLINE void Reset() {
|
||||
persistent.Dispose();
|
||||
persistent.Clear();
|
||||
}
|
||||
|
||||
template<typename S>
|
||||
NAN_INLINE void Reset(const v8::Local<S> &other) {
|
||||
TYPE_CHECK(T, S);
|
||||
|
||||
if (!persistent.IsEmpty()) {
|
||||
persistent.Dispose();
|
||||
}
|
||||
|
||||
if (other.IsEmpty()) {
|
||||
persistent.Clear();
|
||||
} else {
|
||||
persistent = v8::Persistent<T>::New(other);
|
||||
}
|
||||
}
|
||||
|
||||
template<typename S>
|
||||
NAN_INLINE void Reset(const PersistentBase<S> &other) {
|
||||
TYPE_CHECK(T, S);
|
||||
|
||||
if (!persistent.IsEmpty()) {
|
||||
persistent.Dispose();
|
||||
}
|
||||
|
||||
if (other.IsEmpty()) {
|
||||
persistent.Clear();
|
||||
} else {
|
||||
persistent = v8::Persistent<T>::New(other.persistent);
|
||||
}
|
||||
}
|
||||
|
||||
NAN_INLINE bool IsEmpty() const { return persistent.IsEmpty(); }
|
||||
|
||||
NAN_INLINE void Empty() { persistent.Clear(); }
|
||||
|
||||
template<typename S>
|
||||
NAN_INLINE bool operator==(const PersistentBase<S> &that) {
|
||||
return this->persistent == that.persistent;
|
||||
}
|
||||
|
||||
template<typename S>
|
||||
NAN_INLINE bool operator==(const v8::Local<S> &that) {
|
||||
return this->persistent == that;
|
||||
}
|
||||
|
||||
template<typename S>
|
||||
NAN_INLINE bool operator!=(const PersistentBase<S> &that) {
|
||||
return !operator==(that);
|
||||
}
|
||||
|
||||
template<typename S>
|
||||
NAN_INLINE bool operator!=(const v8::Local<S> &that) {
|
||||
return !operator==(that);
|
||||
}
|
||||
|
||||
template<typename P>
|
||||
NAN_INLINE void SetWeak(
|
||||
P *parameter
|
||||
, typename WeakCallbackInfo<P>::Callback callback
|
||||
, WeakCallbackType type);
|
||||
|
||||
NAN_INLINE void ClearWeak() { persistent.ClearWeak(); }
|
||||
|
||||
NAN_INLINE void MarkIndependent() { persistent.MarkIndependent(); }
|
||||
|
||||
NAN_INLINE bool IsIndependent() const { return persistent.IsIndependent(); }
|
||||
|
||||
NAN_INLINE bool IsNearDeath() const { return persistent.IsNearDeath(); }
|
||||
|
||||
NAN_INLINE bool IsWeak() const { return persistent.IsWeak(); }
|
||||
|
||||
private:
|
||||
NAN_INLINE explicit PersistentBase(v8::Persistent<T> that) :
|
||||
persistent(that) { }
|
||||
NAN_INLINE explicit PersistentBase(T *val) : persistent(val) {}
|
||||
template<typename S, typename M> friend class Persistent;
|
||||
template<typename S> friend class Global;
|
||||
friend class ObjectWrap;
|
||||
};
|
||||
|
||||
template<typename T>
|
||||
class NonCopyablePersistentTraits {
|
||||
public:
|
||||
typedef Persistent<T, NonCopyablePersistentTraits<T> >
|
||||
NonCopyablePersistent;
|
||||
static const bool kResetInDestructor = false;
|
||||
template<typename S, typename M>
|
||||
NAN_INLINE static void Copy(const Persistent<S, M> &source,
|
||||
NonCopyablePersistent *dest) {
|
||||
Uncompilable<v8::Object>();
|
||||
}
|
||||
|
||||
template<typename O> NAN_INLINE static void Uncompilable() {
|
||||
TYPE_CHECK(O, v8::Primitive);
|
||||
}
|
||||
};
|
||||
|
||||
template<typename T>
|
||||
struct CopyablePersistentTraits {
|
||||
typedef Persistent<T, CopyablePersistentTraits<T> > CopyablePersistent;
|
||||
static const bool kResetInDestructor = true;
|
||||
template<typename S, typename M>
|
||||
static NAN_INLINE void Copy(const Persistent<S, M> &source,
|
||||
CopyablePersistent *dest) {}
|
||||
};
|
||||
|
||||
template<typename T, typename M> class Persistent :
|
||||
public PersistentBase<T> {
|
||||
public:
|
||||
NAN_INLINE Persistent() {}
|
||||
|
||||
template<typename S> NAN_INLINE Persistent(v8::Handle<S> that)
|
||||
: PersistentBase<T>(v8::Persistent<T>::New(that)) {
|
||||
TYPE_CHECK(T, S);
|
||||
}
|
||||
|
||||
NAN_INLINE Persistent(const Persistent &that) : PersistentBase<T>() {
|
||||
Copy(that);
|
||||
}
|
||||
|
||||
template<typename S, typename M2>
|
||||
NAN_INLINE Persistent(const Persistent<S, M2> &that) :
|
||||
PersistentBase<T>() {
|
||||
Copy(that);
|
||||
}
|
||||
|
||||
NAN_INLINE Persistent &operator=(const Persistent &that) {
|
||||
Copy(that);
|
||||
return *this;
|
||||
}
|
||||
|
||||
template <class S, class M2>
|
||||
NAN_INLINE Persistent &operator=(const Persistent<S, M2> &that) {
|
||||
Copy(that);
|
||||
return *this;
|
||||
}
|
||||
|
||||
NAN_INLINE ~Persistent() {
|
||||
if (M::kResetInDestructor) this->Reset();
|
||||
}
|
||||
|
||||
private:
|
||||
NAN_INLINE T *operator*() const { return *PersistentBase<T>::persistent; }
|
||||
|
||||
template<typename S, typename M2>
|
||||
NAN_INLINE void Copy(const Persistent<S, M2> &that) {
|
||||
TYPE_CHECK(T, S);
|
||||
|
||||
this->Reset();
|
||||
|
||||
if (!that.IsEmpty()) {
|
||||
this->persistent = v8::Persistent<T>::New(that.persistent);
|
||||
M::Copy(that, this);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
template<typename T>
|
||||
class Global : public PersistentBase<T> {
|
||||
struct RValue {
|
||||
NAN_INLINE explicit RValue(Global* obj) : object(obj) {}
|
||||
Global* object;
|
||||
};
|
||||
|
||||
public:
|
||||
NAN_INLINE Global() : PersistentBase<T>(0) { }
|
||||
|
||||
template <typename S>
|
||||
NAN_INLINE Global(v8::Local<S> that)
|
||||
: PersistentBase<T>(v8::Persistent<T>::New(that)) {
|
||||
TYPE_CHECK(T, S);
|
||||
}
|
||||
|
||||
template <typename S>
|
||||
NAN_INLINE Global(const PersistentBase<S> &that)
|
||||
: PersistentBase<T>(that) {
|
||||
TYPE_CHECK(T, S);
|
||||
}
|
||||
/**
|
||||
* Move constructor.
|
||||
*/
|
||||
NAN_INLINE Global(RValue rvalue)
|
||||
: PersistentBase<T>(rvalue.object.persistent) {
|
||||
rvalue.object->Reset();
|
||||
}
|
||||
NAN_INLINE ~Global() { this->Reset(); }
|
||||
/**
|
||||
* Move via assignment.
|
||||
*/
|
||||
template<typename S>
|
||||
NAN_INLINE Global &operator=(Global<S> rhs) {
|
||||
TYPE_CHECK(T, S);
|
||||
this->Reset(rhs.persistent);
|
||||
rhs.Reset();
|
||||
return *this;
|
||||
}
|
||||
/**
|
||||
* Cast operator for moves.
|
||||
*/
|
||||
NAN_INLINE operator RValue() { return RValue(this); }
|
||||
/**
|
||||
* Pass allows returning uniques from functions, etc.
|
||||
*/
|
||||
Global Pass() { return Global(RValue(this)); }
|
||||
|
||||
private:
|
||||
Global(Global &);
|
||||
void operator=(Global &);
|
||||
template<typename S> friend class ReturnValue;
|
||||
};
|
||||
|
||||
#endif // NAN_PERSISTENT_PRE_12_INL_H_
|
||||
+305
@@ -0,0 +1,305 @@
|
||||
// Copyright Joyent, Inc. and other Node contributors.
|
||||
//
|
||||
// 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.
|
||||
|
||||
#ifndef NAN_STRING_BYTES_H_
|
||||
#define NAN_STRING_BYTES_H_
|
||||
|
||||
// Decodes a v8::Local<v8::String> or Buffer to a raw char*
|
||||
|
||||
namespace imp {
|
||||
|
||||
using v8::Local;
|
||||
using v8::Object;
|
||||
using v8::String;
|
||||
using v8::Value;
|
||||
|
||||
|
||||
//// Base 64 ////
|
||||
|
||||
#define base64_encoded_size(size) ((size + 2 - ((size + 2) % 3)) / 3 * 4)
|
||||
|
||||
|
||||
|
||||
//// HEX ////
|
||||
|
||||
static bool contains_non_ascii_slow(const char* buf, size_t len) {
|
||||
for (size_t i = 0; i < len; ++i) {
|
||||
if (buf[i] & 0x80) return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
|
||||
static bool contains_non_ascii(const char* src, size_t len) {
|
||||
if (len < 16) {
|
||||
return contains_non_ascii_slow(src, len);
|
||||
}
|
||||
|
||||
const unsigned bytes_per_word = sizeof(void*);
|
||||
const unsigned align_mask = bytes_per_word - 1;
|
||||
const unsigned unaligned = reinterpret_cast<uintptr_t>(src) & align_mask;
|
||||
|
||||
if (unaligned > 0) {
|
||||
const unsigned n = bytes_per_word - unaligned;
|
||||
if (contains_non_ascii_slow(src, n)) return true;
|
||||
src += n;
|
||||
len -= n;
|
||||
}
|
||||
|
||||
|
||||
#if defined(__x86_64__) || defined(_WIN64)
|
||||
const uintptr_t mask = 0x8080808080808080ll;
|
||||
#else
|
||||
const uintptr_t mask = 0x80808080l;
|
||||
#endif
|
||||
|
||||
const uintptr_t* srcw = reinterpret_cast<const uintptr_t*>(src);
|
||||
|
||||
for (size_t i = 0, n = len / bytes_per_word; i < n; ++i) {
|
||||
if (srcw[i] & mask) return true;
|
||||
}
|
||||
|
||||
const unsigned remainder = len & align_mask;
|
||||
if (remainder > 0) {
|
||||
const size_t offset = len - remainder;
|
||||
if (contains_non_ascii_slow(src + offset, remainder)) return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
|
||||
static void force_ascii_slow(const char* src, char* dst, size_t len) {
|
||||
for (size_t i = 0; i < len; ++i) {
|
||||
dst[i] = src[i] & 0x7f;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
static void force_ascii(const char* src, char* dst, size_t len) {
|
||||
if (len < 16) {
|
||||
force_ascii_slow(src, dst, len);
|
||||
return;
|
||||
}
|
||||
|
||||
const unsigned bytes_per_word = sizeof(void*);
|
||||
const unsigned align_mask = bytes_per_word - 1;
|
||||
const unsigned src_unalign = reinterpret_cast<uintptr_t>(src) & align_mask;
|
||||
const unsigned dst_unalign = reinterpret_cast<uintptr_t>(dst) & align_mask;
|
||||
|
||||
if (src_unalign > 0) {
|
||||
if (src_unalign == dst_unalign) {
|
||||
const unsigned unalign = bytes_per_word - src_unalign;
|
||||
force_ascii_slow(src, dst, unalign);
|
||||
src += unalign;
|
||||
dst += unalign;
|
||||
len -= src_unalign;
|
||||
} else {
|
||||
force_ascii_slow(src, dst, len);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
#if defined(__x86_64__) || defined(_WIN64)
|
||||
const uintptr_t mask = ~0x8080808080808080ll;
|
||||
#else
|
||||
const uintptr_t mask = ~0x80808080l;
|
||||
#endif
|
||||
|
||||
const uintptr_t* srcw = reinterpret_cast<const uintptr_t*>(src);
|
||||
uintptr_t* dstw = reinterpret_cast<uintptr_t*>(dst);
|
||||
|
||||
for (size_t i = 0, n = len / bytes_per_word; i < n; ++i) {
|
||||
dstw[i] = srcw[i] & mask;
|
||||
}
|
||||
|
||||
const unsigned remainder = len & align_mask;
|
||||
if (remainder > 0) {
|
||||
const size_t offset = len - remainder;
|
||||
force_ascii_slow(src + offset, dst + offset, remainder);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
static size_t base64_encode(const char* src,
|
||||
size_t slen,
|
||||
char* dst,
|
||||
size_t dlen) {
|
||||
// We know how much we'll write, just make sure that there's space.
|
||||
assert(dlen >= base64_encoded_size(slen) &&
|
||||
"not enough space provided for base64 encode");
|
||||
|
||||
dlen = base64_encoded_size(slen);
|
||||
|
||||
unsigned a;
|
||||
unsigned b;
|
||||
unsigned c;
|
||||
unsigned i;
|
||||
unsigned k;
|
||||
unsigned n;
|
||||
|
||||
static const char table[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
|
||||
"abcdefghijklmnopqrstuvwxyz"
|
||||
"0123456789+/";
|
||||
|
||||
i = 0;
|
||||
k = 0;
|
||||
n = slen / 3 * 3;
|
||||
|
||||
while (i < n) {
|
||||
a = src[i + 0] & 0xff;
|
||||
b = src[i + 1] & 0xff;
|
||||
c = src[i + 2] & 0xff;
|
||||
|
||||
dst[k + 0] = table[a >> 2];
|
||||
dst[k + 1] = table[((a & 3) << 4) | (b >> 4)];
|
||||
dst[k + 2] = table[((b & 0x0f) << 2) | (c >> 6)];
|
||||
dst[k + 3] = table[c & 0x3f];
|
||||
|
||||
i += 3;
|
||||
k += 4;
|
||||
}
|
||||
|
||||
if (n != slen) {
|
||||
switch (slen - n) {
|
||||
case 1:
|
||||
a = src[i + 0] & 0xff;
|
||||
dst[k + 0] = table[a >> 2];
|
||||
dst[k + 1] = table[(a & 3) << 4];
|
||||
dst[k + 2] = '=';
|
||||
dst[k + 3] = '=';
|
||||
break;
|
||||
|
||||
case 2:
|
||||
a = src[i + 0] & 0xff;
|
||||
b = src[i + 1] & 0xff;
|
||||
dst[k + 0] = table[a >> 2];
|
||||
dst[k + 1] = table[((a & 3) << 4) | (b >> 4)];
|
||||
dst[k + 2] = table[(b & 0x0f) << 2];
|
||||
dst[k + 3] = '=';
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return dlen;
|
||||
}
|
||||
|
||||
|
||||
static size_t hex_encode(const char* src, size_t slen, char* dst, size_t dlen) {
|
||||
// We know how much we'll write, just make sure that there's space.
|
||||
assert(dlen >= slen * 2 &&
|
||||
"not enough space provided for hex encode");
|
||||
|
||||
dlen = slen * 2;
|
||||
for (uint32_t i = 0, k = 0; k < dlen; i += 1, k += 2) {
|
||||
static const char hex[] = "0123456789abcdef";
|
||||
uint8_t val = static_cast<uint8_t>(src[i]);
|
||||
dst[k + 0] = hex[val >> 4];
|
||||
dst[k + 1] = hex[val & 15];
|
||||
}
|
||||
|
||||
return dlen;
|
||||
}
|
||||
|
||||
|
||||
|
||||
static Local<Value> Encode(const char* buf,
|
||||
size_t buflen,
|
||||
enum Encoding encoding) {
|
||||
assert(buflen <= node::Buffer::kMaxLength);
|
||||
if (!buflen && encoding != BUFFER)
|
||||
return New("").ToLocalChecked();
|
||||
|
||||
Local<String> val;
|
||||
switch (encoding) {
|
||||
case BUFFER:
|
||||
return CopyBuffer(buf, buflen).ToLocalChecked();
|
||||
|
||||
case ASCII:
|
||||
if (contains_non_ascii(buf, buflen)) {
|
||||
char* out = new char[buflen];
|
||||
force_ascii(buf, out, buflen);
|
||||
val = New<String>(out, buflen).ToLocalChecked();
|
||||
delete[] out;
|
||||
} else {
|
||||
val = New<String>(buf, buflen).ToLocalChecked();
|
||||
}
|
||||
break;
|
||||
|
||||
case UTF8:
|
||||
val = New<String>(buf, buflen).ToLocalChecked();
|
||||
break;
|
||||
|
||||
case BINARY: {
|
||||
// TODO(isaacs) use ExternalTwoByteString?
|
||||
const unsigned char *cbuf = reinterpret_cast<const unsigned char*>(buf);
|
||||
uint16_t * twobytebuf = new uint16_t[buflen];
|
||||
for (size_t i = 0; i < buflen; i++) {
|
||||
// XXX is the following line platform independent?
|
||||
twobytebuf[i] = cbuf[i];
|
||||
}
|
||||
val = New<String>(twobytebuf, buflen).ToLocalChecked();
|
||||
delete[] twobytebuf;
|
||||
break;
|
||||
}
|
||||
|
||||
case BASE64: {
|
||||
size_t dlen = base64_encoded_size(buflen);
|
||||
char* dst = new char[dlen];
|
||||
|
||||
size_t written = base64_encode(buf, buflen, dst, dlen);
|
||||
assert(written == dlen);
|
||||
|
||||
val = New<String>(dst, dlen).ToLocalChecked();
|
||||
delete[] dst;
|
||||
break;
|
||||
}
|
||||
|
||||
case UCS2: {
|
||||
const uint16_t* data = reinterpret_cast<const uint16_t*>(buf);
|
||||
val = New<String>(data, buflen / 2).ToLocalChecked();
|
||||
break;
|
||||
}
|
||||
|
||||
case HEX: {
|
||||
size_t dlen = buflen * 2;
|
||||
char* dst = new char[dlen];
|
||||
size_t written = hex_encode(buf, buflen, dst, dlen);
|
||||
assert(written == dlen);
|
||||
|
||||
val = New<String>(dst, dlen).ToLocalChecked();
|
||||
delete[] dst;
|
||||
break;
|
||||
}
|
||||
|
||||
default:
|
||||
assert(0 && "unknown encoding");
|
||||
break;
|
||||
}
|
||||
|
||||
return val;
|
||||
}
|
||||
|
||||
#undef base64_encoded_size
|
||||
|
||||
} // end of namespace imp
|
||||
|
||||
#endif // NAN_STRING_BYTES_H_
|
||||
+422
@@ -0,0 +1,422 @@
|
||||
/*********************************************************************
|
||||
* NAN - Native Abstractions for Node.js
|
||||
*
|
||||
* Copyright (c) 2015 NAN contributors
|
||||
*
|
||||
* MIT License <https://github.com/nodejs/nan/blob/master/LICENSE.md>
|
||||
********************************************************************/
|
||||
|
||||
#ifndef NAN_WEAK_H_
|
||||
#define NAN_WEAK_H_
|
||||
|
||||
static const int kInternalFieldsInWeakCallback = 2;
|
||||
static const int kNoInternalFieldIndex = -1;
|
||||
|
||||
#if defined(V8_MAJOR_VERSION) && (V8_MAJOR_VERSION > 4 || \
|
||||
(V8_MAJOR_VERSION == 4 && defined(V8_MINOR_VERSION) && V8_MINOR_VERSION >= 3))
|
||||
# define NAN_WEAK_PARAMETER_CALLBACK_DATA_TYPE_ \
|
||||
v8::WeakCallbackInfo<WeakCallbackInfo<T> > const&
|
||||
# define NAN_WEAK_TWOFIELD_CALLBACK_DATA_TYPE_ \
|
||||
NAN_WEAK_PARAMETER_CALLBACK_DATA_TYPE_
|
||||
# define NAN_WEAK_PARAMETER_CALLBACK_SIG_ NAN_WEAK_PARAMETER_CALLBACK_DATA_TYPE_
|
||||
# define NAN_WEAK_TWOFIELD_CALLBACK_SIG_ NAN_WEAK_TWOFIELD_CALLBACK_DATA_TYPE_
|
||||
#elif NODE_MODULE_VERSION > IOJS_1_1_MODULE_VERSION
|
||||
# define NAN_WEAK_PARAMETER_CALLBACK_DATA_TYPE_ \
|
||||
v8::PhantomCallbackData<WeakCallbackInfo<T> > const&
|
||||
# define NAN_WEAK_TWOFIELD_CALLBACK_DATA_TYPE_ \
|
||||
NAN_WEAK_PARAMETER_CALLBACK_DATA_TYPE_
|
||||
# define NAN_WEAK_PARAMETER_CALLBACK_SIG_ NAN_WEAK_PARAMETER_CALLBACK_DATA_TYPE_
|
||||
# define NAN_WEAK_TWOFIELD_CALLBACK_SIG_ NAN_WEAK_TWOFIELD_CALLBACK_DATA_TYPE_
|
||||
#elif NODE_MODULE_VERSION > NODE_0_12_MODULE_VERSION
|
||||
# define NAN_WEAK_PARAMETER_CALLBACK_DATA_TYPE_ \
|
||||
v8::PhantomCallbackData<WeakCallbackInfo<T> > const&
|
||||
# define NAN_WEAK_TWOFIELD_CALLBACK_DATA_TYPE_ \
|
||||
v8::InternalFieldsCallbackData<WeakCallbackInfo<T>, void> const&
|
||||
# define NAN_WEAK_PARAMETER_CALLBACK_SIG_ NAN_WEAK_PARAMETER_CALLBACK_DATA_TYPE_
|
||||
# define NAN_WEAK_TWOFIELD_CALLBACK_SIG_ NAN_WEAK_TWOFIELD_CALLBACK_DATA_TYPE_
|
||||
#elif NODE_MODULE_VERSION > NODE_0_10_MODULE_VERSION
|
||||
# define NAN_WEAK_CALLBACK_DATA_TYPE_ \
|
||||
v8::WeakCallbackData<S, WeakCallbackInfo<T> > const&
|
||||
# define NAN_WEAK_CALLBACK_SIG_ NAN_WEAK_CALLBACK_DATA_TYPE_
|
||||
#else
|
||||
# define NAN_WEAK_CALLBACK_DATA_TYPE_ void *
|
||||
# define NAN_WEAK_CALLBACK_SIG_ \
|
||||
v8::Persistent<v8::Value>, NAN_WEAK_CALLBACK_DATA_TYPE_
|
||||
#endif
|
||||
|
||||
template<typename T>
|
||||
class WeakCallbackInfo {
|
||||
public:
|
||||
typedef void (*Callback)(const WeakCallbackInfo<T>& data);
|
||||
WeakCallbackInfo(
|
||||
Persistent<v8::Value> *persistent
|
||||
, Callback callback
|
||||
, void *parameter
|
||||
, void *field1 = 0
|
||||
, void *field2 = 0) :
|
||||
callback_(callback), isolate_(0), parameter_(parameter) {
|
||||
std::memcpy(&persistent_, persistent, sizeof (v8::Persistent<v8::Value>));
|
||||
internal_fields_[0] = field1;
|
||||
internal_fields_[1] = field2;
|
||||
}
|
||||
NAN_INLINE v8::Isolate *GetIsolate() const { return isolate_; }
|
||||
NAN_INLINE T *GetParameter() const { return static_cast<T*>(parameter_); }
|
||||
NAN_INLINE void *GetInternalField(int index) const {
|
||||
assert((index == 0 || index == 1) && "internal field index out of bounds");
|
||||
if (index == 0) {
|
||||
return internal_fields_[0];
|
||||
} else {
|
||||
return internal_fields_[1];
|
||||
}
|
||||
}
|
||||
|
||||
private:
|
||||
NAN_DISALLOW_ASSIGN_COPY_MOVE(WeakCallbackInfo)
|
||||
Callback callback_;
|
||||
v8::Isolate *isolate_;
|
||||
void *parameter_;
|
||||
void *internal_fields_[kInternalFieldsInWeakCallback];
|
||||
v8::Persistent<v8::Value> persistent_;
|
||||
template<typename S, typename M> friend class Persistent;
|
||||
template<typename S> friend class PersistentBase;
|
||||
#if NODE_MODULE_VERSION <= NODE_0_12_MODULE_VERSION
|
||||
# if NODE_MODULE_VERSION > NODE_0_10_MODULE_VERSION
|
||||
template<typename S>
|
||||
static void invoke(NAN_WEAK_CALLBACK_SIG_ data);
|
||||
template<typename S>
|
||||
static WeakCallbackInfo *unwrap(NAN_WEAK_CALLBACK_DATA_TYPE_ data);
|
||||
# else
|
||||
static void invoke(NAN_WEAK_CALLBACK_SIG_ data);
|
||||
static WeakCallbackInfo *unwrap(NAN_WEAK_CALLBACK_DATA_TYPE_ data);
|
||||
# endif
|
||||
#else
|
||||
static void invokeparameter(NAN_WEAK_PARAMETER_CALLBACK_SIG_ data);
|
||||
static void invoketwofield(NAN_WEAK_TWOFIELD_CALLBACK_SIG_ data);
|
||||
static WeakCallbackInfo *unwrapparameter(
|
||||
NAN_WEAK_PARAMETER_CALLBACK_DATA_TYPE_ data);
|
||||
static WeakCallbackInfo *unwraptwofield(
|
||||
NAN_WEAK_TWOFIELD_CALLBACK_DATA_TYPE_ data);
|
||||
#endif
|
||||
};
|
||||
|
||||
|
||||
#if defined(V8_MAJOR_VERSION) && (V8_MAJOR_VERSION > 4 || \
|
||||
(V8_MAJOR_VERSION == 4 && defined(V8_MINOR_VERSION) && V8_MINOR_VERSION >= 3))
|
||||
|
||||
template<typename T>
|
||||
void
|
||||
WeakCallbackInfo<T>::invokeparameter(NAN_WEAK_PARAMETER_CALLBACK_SIG_ data) {
|
||||
WeakCallbackInfo<T> *cbinfo = unwrapparameter(data);
|
||||
if (data.IsFirstPass()) {
|
||||
cbinfo->persistent_.Reset();
|
||||
data.SetSecondPassCallback(invokeparameter);
|
||||
} else {
|
||||
cbinfo->callback_(*cbinfo);
|
||||
delete cbinfo;
|
||||
}
|
||||
}
|
||||
|
||||
template<typename T>
|
||||
void
|
||||
WeakCallbackInfo<T>::invoketwofield(NAN_WEAK_TWOFIELD_CALLBACK_SIG_ data) {
|
||||
WeakCallbackInfo<T> *cbinfo = unwraptwofield(data);
|
||||
if (data.IsFirstPass()) {
|
||||
cbinfo->persistent_.Reset();
|
||||
data.SetSecondPassCallback(invoketwofield);
|
||||
} else {
|
||||
cbinfo->callback_(*cbinfo);
|
||||
delete cbinfo;
|
||||
}
|
||||
}
|
||||
|
||||
template<typename T>
|
||||
WeakCallbackInfo<T> *WeakCallbackInfo<T>::unwrapparameter(
|
||||
NAN_WEAK_PARAMETER_CALLBACK_DATA_TYPE_ data) {
|
||||
WeakCallbackInfo<T> *cbinfo =
|
||||
static_cast<WeakCallbackInfo<T>*>(data.GetParameter());
|
||||
cbinfo->isolate_ = data.GetIsolate();
|
||||
return cbinfo;
|
||||
}
|
||||
|
||||
template<typename T>
|
||||
WeakCallbackInfo<T> *WeakCallbackInfo<T>::unwraptwofield(
|
||||
NAN_WEAK_TWOFIELD_CALLBACK_DATA_TYPE_ data) {
|
||||
WeakCallbackInfo<T> *cbinfo =
|
||||
static_cast<WeakCallbackInfo<T>*>(data.GetInternalField(0));
|
||||
cbinfo->isolate_ = data.GetIsolate();
|
||||
return cbinfo;
|
||||
}
|
||||
|
||||
#undef NAN_WEAK_PARAMETER_CALLBACK_SIG_
|
||||
#undef NAN_WEAK_TWOFIELD_CALLBACK_SIG_
|
||||
#undef NAN_WEAK_PARAMETER_CALLBACK_DATA_TYPE_
|
||||
#undef NAN_WEAK_TWOFIELD_CALLBACK_DATA_TYPE_
|
||||
# elif NODE_MODULE_VERSION > NODE_0_12_MODULE_VERSION
|
||||
|
||||
template<typename T>
|
||||
void
|
||||
WeakCallbackInfo<T>::invokeparameter(NAN_WEAK_PARAMETER_CALLBACK_SIG_ data) {
|
||||
WeakCallbackInfo<T> *cbinfo = unwrapparameter(data);
|
||||
cbinfo->persistent_.Reset();
|
||||
cbinfo->callback_(*cbinfo);
|
||||
delete cbinfo;
|
||||
}
|
||||
|
||||
template<typename T>
|
||||
void
|
||||
WeakCallbackInfo<T>::invoketwofield(NAN_WEAK_TWOFIELD_CALLBACK_SIG_ data) {
|
||||
WeakCallbackInfo<T> *cbinfo = unwraptwofield(data);
|
||||
cbinfo->persistent_.Reset();
|
||||
cbinfo->callback_(*cbinfo);
|
||||
delete cbinfo;
|
||||
}
|
||||
|
||||
template<typename T>
|
||||
WeakCallbackInfo<T> *WeakCallbackInfo<T>::unwrapparameter(
|
||||
NAN_WEAK_PARAMETER_CALLBACK_DATA_TYPE_ data) {
|
||||
WeakCallbackInfo<T> *cbinfo =
|
||||
static_cast<WeakCallbackInfo<T>*>(data.GetParameter());
|
||||
cbinfo->isolate_ = data.GetIsolate();
|
||||
return cbinfo;
|
||||
}
|
||||
|
||||
template<typename T>
|
||||
WeakCallbackInfo<T> *WeakCallbackInfo<T>::unwraptwofield(
|
||||
NAN_WEAK_TWOFIELD_CALLBACK_DATA_TYPE_ data) {
|
||||
WeakCallbackInfo<T> *cbinfo =
|
||||
static_cast<WeakCallbackInfo<T>*>(data.GetInternalField1());
|
||||
cbinfo->isolate_ = data.GetIsolate();
|
||||
return cbinfo;
|
||||
}
|
||||
|
||||
#undef NAN_WEAK_PARAMETER_CALLBACK_SIG_
|
||||
#undef NAN_WEAK_TWOFIELD_CALLBACK_SIG_
|
||||
#undef NAN_WEAK_PARAMETER_CALLBACK_DATA_TYPE_
|
||||
#undef NAN_WEAK_TWOFIELD_CALLBACK_DATA_TYPE_
|
||||
#elif NODE_MODULE_VERSION > NODE_0_10_MODULE_VERSION
|
||||
|
||||
template<typename T>
|
||||
template<typename S>
|
||||
void WeakCallbackInfo<T>::invoke(NAN_WEAK_CALLBACK_SIG_ data) {
|
||||
WeakCallbackInfo<T> *cbinfo = unwrap(data);
|
||||
cbinfo->persistent_.Reset();
|
||||
cbinfo->callback_(*cbinfo);
|
||||
delete cbinfo;
|
||||
}
|
||||
|
||||
template<typename T>
|
||||
template<typename S>
|
||||
WeakCallbackInfo<T> *WeakCallbackInfo<T>::unwrap(
|
||||
NAN_WEAK_CALLBACK_DATA_TYPE_ data) {
|
||||
void *parameter = data.GetParameter();
|
||||
WeakCallbackInfo<T> *cbinfo =
|
||||
static_cast<WeakCallbackInfo<T>*>(parameter);
|
||||
cbinfo->isolate_ = data.GetIsolate();
|
||||
return cbinfo;
|
||||
}
|
||||
|
||||
#undef NAN_WEAK_CALLBACK_SIG_
|
||||
#undef NAN_WEAK_CALLBACK_DATA_TYPE_
|
||||
#else
|
||||
|
||||
template<typename T>
|
||||
void WeakCallbackInfo<T>::invoke(NAN_WEAK_CALLBACK_SIG_ data) {
|
||||
WeakCallbackInfo<T> *cbinfo = unwrap(data);
|
||||
cbinfo->persistent_.Dispose();
|
||||
cbinfo->persistent_.Clear();
|
||||
cbinfo->callback_(*cbinfo);
|
||||
delete cbinfo;
|
||||
}
|
||||
|
||||
template<typename T>
|
||||
WeakCallbackInfo<T> *WeakCallbackInfo<T>::unwrap(
|
||||
NAN_WEAK_CALLBACK_DATA_TYPE_ data) {
|
||||
WeakCallbackInfo<T> *cbinfo =
|
||||
static_cast<WeakCallbackInfo<T>*>(data);
|
||||
cbinfo->isolate_ = v8::Isolate::GetCurrent();
|
||||
return cbinfo;
|
||||
}
|
||||
|
||||
#undef NAN_WEAK_CALLBACK_SIG_
|
||||
#undef NAN_WEAK_CALLBACK_DATA_TYPE_
|
||||
#endif
|
||||
|
||||
#if defined(V8_MAJOR_VERSION) && (V8_MAJOR_VERSION > 4 || \
|
||||
(V8_MAJOR_VERSION == 4 && defined(V8_MINOR_VERSION) && V8_MINOR_VERSION >= 3))
|
||||
template<typename T, typename M>
|
||||
template<typename P>
|
||||
NAN_INLINE void Persistent<T, M>::SetWeak(
|
||||
P *parameter
|
||||
, typename WeakCallbackInfo<P>::Callback callback
|
||||
, WeakCallbackType type) {
|
||||
WeakCallbackInfo<P> *wcbd;
|
||||
if (type == WeakCallbackType::kParameter) {
|
||||
wcbd = new WeakCallbackInfo<P>(
|
||||
reinterpret_cast<Persistent<v8::Value>*>(this)
|
||||
, callback
|
||||
, parameter);
|
||||
v8::PersistentBase<T>::SetWeak(
|
||||
wcbd
|
||||
, WeakCallbackInfo<P>::invokeparameter
|
||||
, type);
|
||||
} else {
|
||||
v8::Local<T>* self = reinterpret_cast<v8::Local<T>*>(this);
|
||||
assert((*self)->IsObject());
|
||||
int count = (*self)->InternalFieldCount();
|
||||
void *internal_fields[kInternalFieldsInWeakCallback] = {0, 0};
|
||||
for (int i = 0; i < count && i < kInternalFieldsInWeakCallback; i++) {
|
||||
internal_fields[i] = (*self)->GetAlignedPointerFromInternalField(i);
|
||||
}
|
||||
wcbd = new WeakCallbackInfo<P>(
|
||||
reinterpret_cast<Persistent<v8::Value>*>(this)
|
||||
, callback
|
||||
, 0
|
||||
, internal_fields[0]
|
||||
, internal_fields[1]);
|
||||
(*self)->SetAlignedPointerInInternalField(0, wcbd);
|
||||
v8::PersistentBase<T>::SetWeak(
|
||||
static_cast<WeakCallbackInfo<P>*>(0)
|
||||
, WeakCallbackInfo<P>::invoketwofield
|
||||
, type);
|
||||
}
|
||||
}
|
||||
#elif NODE_MODULE_VERSION > IOJS_1_1_MODULE_VERSION
|
||||
template<typename T, typename M>
|
||||
template<typename P>
|
||||
NAN_INLINE void Persistent<T, M>::SetWeak(
|
||||
P *parameter
|
||||
, typename WeakCallbackInfo<P>::Callback callback
|
||||
, WeakCallbackType type) {
|
||||
WeakCallbackInfo<P> *wcbd;
|
||||
if (type == WeakCallbackType::kParameter) {
|
||||
wcbd = new WeakCallbackInfo<P>(
|
||||
reinterpret_cast<Persistent<v8::Value>*>(this)
|
||||
, callback
|
||||
, parameter);
|
||||
v8::PersistentBase<T>::SetPhantom(
|
||||
wcbd
|
||||
, WeakCallbackInfo<P>::invokeparameter);
|
||||
} else {
|
||||
v8::Local<T>* self = reinterpret_cast<v8::Local<T>*>(this);
|
||||
assert((*self)->IsObject());
|
||||
int count = (*self)->InternalFieldCount();
|
||||
void *internal_fields[kInternalFieldsInWeakCallback] = {0, 0};
|
||||
for (int i = 0; i < count && i < kInternalFieldsInWeakCallback; i++) {
|
||||
internal_fields[i] = (*self)->GetAlignedPointerFromInternalField(i);
|
||||
}
|
||||
wcbd = new WeakCallbackInfo<P>(
|
||||
reinterpret_cast<Persistent<v8::Value>*>(this)
|
||||
, callback
|
||||
, 0
|
||||
, internal_fields[0]
|
||||
, internal_fields[1]);
|
||||
(*self)->SetAlignedPointerInInternalField(0, wcbd);
|
||||
v8::PersistentBase<T>::SetPhantom(
|
||||
static_cast<WeakCallbackInfo<P>*>(0)
|
||||
, WeakCallbackInfo<P>::invoketwofield
|
||||
, 0
|
||||
, count > 1 ? 1 : kNoInternalFieldIndex);
|
||||
}
|
||||
}
|
||||
#elif NODE_MODULE_VERSION > NODE_0_12_MODULE_VERSION
|
||||
template<typename T, typename M>
|
||||
template<typename P>
|
||||
NAN_INLINE void Persistent<T, M>::SetWeak(
|
||||
P *parameter
|
||||
, typename WeakCallbackInfo<P>::Callback callback
|
||||
, WeakCallbackType type) {
|
||||
WeakCallbackInfo<P> *wcbd;
|
||||
if (type == WeakCallbackType::kParameter) {
|
||||
wcbd = new WeakCallbackInfo<P>(
|
||||
reinterpret_cast<Persistent<v8::Value>*>(this)
|
||||
, callback
|
||||
, parameter);
|
||||
v8::PersistentBase<T>::SetPhantom(
|
||||
wcbd
|
||||
, WeakCallbackInfo<P>::invokeparameter);
|
||||
} else {
|
||||
v8::Local<T>* self = reinterpret_cast<v8::Local<T>*>(this);
|
||||
assert((*self)->IsObject());
|
||||
int count = (*self)->InternalFieldCount();
|
||||
void *internal_fields[kInternalFieldsInWeakCallback] = {0, 0};
|
||||
for (int i = 0; i < count && i < kInternalFieldsInWeakCallback; i++) {
|
||||
internal_fields[i] = (*self)->GetAlignedPointerFromInternalField(i);
|
||||
}
|
||||
wcbd = new WeakCallbackInfo<P>(
|
||||
reinterpret_cast<Persistent<v8::Value>*>(this)
|
||||
, callback
|
||||
, 0
|
||||
, internal_fields[0]
|
||||
, internal_fields[1]);
|
||||
(*self)->SetAlignedPointerInInternalField(0, wcbd);
|
||||
v8::PersistentBase<T>::SetPhantom(
|
||||
WeakCallbackInfo<P>::invoketwofield
|
||||
, 0
|
||||
, count > 1 ? 1 : kNoInternalFieldIndex);
|
||||
}
|
||||
}
|
||||
#elif NODE_MODULE_VERSION > NODE_0_10_MODULE_VERSION
|
||||
template<typename T, typename M>
|
||||
template<typename P>
|
||||
NAN_INLINE void Persistent<T, M>::SetWeak(
|
||||
P *parameter
|
||||
, typename WeakCallbackInfo<P>::Callback callback
|
||||
, WeakCallbackType type) {
|
||||
WeakCallbackInfo<P> *wcbd;
|
||||
if (type == WeakCallbackType::kParameter) {
|
||||
wcbd = new WeakCallbackInfo<P>(
|
||||
reinterpret_cast<Persistent<v8::Value>*>(this)
|
||||
, callback
|
||||
, parameter);
|
||||
v8::PersistentBase<T>::SetWeak(wcbd, WeakCallbackInfo<P>::invoke);
|
||||
} else {
|
||||
v8::Local<T>* self = reinterpret_cast<v8::Local<T>*>(this);
|
||||
assert((*self)->IsObject());
|
||||
int count = (*self)->InternalFieldCount();
|
||||
void *internal_fields[kInternalFieldsInWeakCallback] = {0, 0};
|
||||
for (int i = 0; i < count && i < kInternalFieldsInWeakCallback; i++) {
|
||||
internal_fields[i] = (*self)->GetAlignedPointerFromInternalField(i);
|
||||
}
|
||||
wcbd = new WeakCallbackInfo<P>(
|
||||
reinterpret_cast<Persistent<v8::Value>*>(this)
|
||||
, callback
|
||||
, 0
|
||||
, internal_fields[0]
|
||||
, internal_fields[1]);
|
||||
v8::PersistentBase<T>::SetWeak(wcbd, WeakCallbackInfo<P>::invoke);
|
||||
}
|
||||
}
|
||||
#else
|
||||
template<typename T>
|
||||
template<typename P>
|
||||
NAN_INLINE void PersistentBase<T>::SetWeak(
|
||||
P *parameter
|
||||
, typename WeakCallbackInfo<P>::Callback callback
|
||||
, WeakCallbackType type) {
|
||||
WeakCallbackInfo<P> *wcbd;
|
||||
if (type == WeakCallbackType::kParameter) {
|
||||
wcbd = new WeakCallbackInfo<P>(
|
||||
reinterpret_cast<Persistent<v8::Value>*>(this)
|
||||
, callback
|
||||
, parameter);
|
||||
persistent.MakeWeak(wcbd, WeakCallbackInfo<P>::invoke);
|
||||
} else {
|
||||
v8::Local<T>* self = reinterpret_cast<v8::Local<T>*>(this);
|
||||
assert((*self)->IsObject());
|
||||
int count = (*self)->InternalFieldCount();
|
||||
void *internal_fields[kInternalFieldsInWeakCallback] = {0, 0};
|
||||
for (int i = 0; i < count && i < kInternalFieldsInWeakCallback; i++) {
|
||||
internal_fields[i] = (*self)->GetPointerFromInternalField(i);
|
||||
}
|
||||
wcbd = new WeakCallbackInfo<P>(
|
||||
reinterpret_cast<Persistent<v8::Value>*>(this)
|
||||
, callback
|
||||
, 0
|
||||
, internal_fields[0]
|
||||
, internal_fields[1]);
|
||||
persistent.MakeWeak(wcbd, WeakCallbackInfo<P>::invoke);
|
||||
}
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif // NAN_WEAK_H_
|
||||
+92
@@ -0,0 +1,92 @@
|
||||
{
|
||||
"name": "nan",
|
||||
"version": "2.0.9",
|
||||
"description": "Native Abstractions for Node.js: C++ header for Node 0.8 -> 4 compatibility",
|
||||
"main": "include_dirs.js",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git://github.com/nodejs/nan.git"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "tap --gc test/js/*-test.js",
|
||||
"rebuild-tests": "pangyp rebuild --msvs_version=2013 --directory test",
|
||||
"docs": "doc/.build.sh"
|
||||
},
|
||||
"contributors": [
|
||||
{
|
||||
"name": "Rod Vagg",
|
||||
"email": "r@va.gg",
|
||||
"url": "https://github.com/rvagg"
|
||||
},
|
||||
{
|
||||
"name": "Benjamin Byholm",
|
||||
"email": "bbyholm@abo.fi",
|
||||
"url": "https://github.com/kkoopa/"
|
||||
},
|
||||
{
|
||||
"name": "Trevor Norris",
|
||||
"email": "trev.norris@gmail.com",
|
||||
"url": "https://github.com/trevnorris"
|
||||
},
|
||||
{
|
||||
"name": "Nathan Rajlich",
|
||||
"email": "nathan@tootallnate.net",
|
||||
"url": "https://github.com/TooTallNate"
|
||||
},
|
||||
{
|
||||
"name": "Brett Lawson",
|
||||
"email": "brett19@gmail.com",
|
||||
"url": "https://github.com/brett19"
|
||||
},
|
||||
{
|
||||
"name": "Ben Noordhuis",
|
||||
"email": "info@bnoordhuis.nl",
|
||||
"url": "https://github.com/bnoordhuis"
|
||||
},
|
||||
{
|
||||
"name": "David Siegel",
|
||||
"email": "david@artcom.de",
|
||||
"url": "https://github.com/agnat"
|
||||
}
|
||||
],
|
||||
"devDependencies": {
|
||||
"bindings": "~1.2.1",
|
||||
"commander": "^2.8.1",
|
||||
"glob": "^5.0.14",
|
||||
"node-gyp": "~2.0.2",
|
||||
"pangyp": "~2.2.0",
|
||||
"tap": "~0.7.1",
|
||||
"xtend": "~4.0.0"
|
||||
},
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/nodejs/nan/issues"
|
||||
},
|
||||
"homepage": "https://github.com/nodejs/nan#readme",
|
||||
"_id": "nan@2.0.9",
|
||||
"_shasum": "d02a770f46778842cceb94e17cab31ffc7234a05",
|
||||
"_resolved": "https://registry.npmjs.org/nan/-/nan-2.0.9.tgz",
|
||||
"_from": "nan@>=2.0.0 <2.1.0",
|
||||
"_npmVersion": "2.14.2",
|
||||
"_nodeVersion": "4.0.0",
|
||||
"_npmUser": {
|
||||
"name": "kkoopa",
|
||||
"email": "bbyholm@abo.fi"
|
||||
},
|
||||
"maintainers": [
|
||||
{
|
||||
"name": "rvagg",
|
||||
"email": "rod@vagg.org"
|
||||
},
|
||||
{
|
||||
"name": "kkoopa",
|
||||
"email": "bbyholm@abo.fi"
|
||||
}
|
||||
],
|
||||
"dist": {
|
||||
"shasum": "d02a770f46778842cceb94e17cab31ffc7234a05",
|
||||
"tarball": "http://registry.npmjs.org/nan/-/nan-2.0.9.tgz"
|
||||
},
|
||||
"directories": {},
|
||||
"readme": "ERROR: No README data found!"
|
||||
}
|
||||
+412
@@ -0,0 +1,412 @@
|
||||
#!/usr/bin/env node
|
||||
/*********************************************************************
|
||||
* NAN - Native Abstractions for Node.js
|
||||
*
|
||||
* Copyright (c) 2015 NAN contributors
|
||||
*
|
||||
* MIT License <https://github.com/nodejs/nan/blob/master/LICENSE.md>
|
||||
********************************************************************/
|
||||
|
||||
var commander = require('commander'),
|
||||
fs = require('fs'),
|
||||
glob = require('glob'),
|
||||
groups = [],
|
||||
total = 0,
|
||||
warning1 = '/* ERROR: Rewrite using Buffer */\n',
|
||||
warning2 = '\\/\\* ERROR\\: Rewrite using Buffer \\*\\/\\n',
|
||||
length,
|
||||
i;
|
||||
|
||||
fs.readFile('package.json', 'utf8', function (err, data) {
|
||||
if (err) {
|
||||
throw err;
|
||||
}
|
||||
|
||||
commander
|
||||
.version(JSON.parse(data).version)
|
||||
.usage('[options] <file ...>')
|
||||
.parse(process.argv);
|
||||
|
||||
if (!process.argv.slice(2).length) {
|
||||
commander.outputHelp();
|
||||
}
|
||||
});
|
||||
|
||||
/* construct strings representing regular expressions
|
||||
each expression contains a unique group allowing for identification of the match
|
||||
the index of this key group, relative to the regular expression in question,
|
||||
is indicated by the first array member */
|
||||
|
||||
/* simple substistutions, key group is the entire match, 0 */
|
||||
groups.push([0, [
|
||||
'_NAN_',
|
||||
'NODE_SET_METHOD',
|
||||
'NODE_SET_PROTOTYPE_METHOD',
|
||||
'NanAsciiString',
|
||||
'NanEscapeScope',
|
||||
'NanReturnValue',
|
||||
'NanUcs2String'].join('|')]);
|
||||
|
||||
/* substitutions of parameterless macros, key group is 1 */
|
||||
groups.push([1, ['(', [
|
||||
'NanEscapableScope',
|
||||
'NanReturnNull',
|
||||
'NanReturnUndefined',
|
||||
'NanScope'].join('|'), ')\\(\\)'].join('')]);
|
||||
|
||||
/* replace TryCatch with NanTryCatch once, gobbling possible namespace, key group 2 */
|
||||
groups.push([2, '(?:(?:v8\\:\\:)?|(Nan)?)(TryCatch)']);
|
||||
|
||||
/* NanNew("string") will likely not fail a ToLocalChecked(), key group 1 */
|
||||
groups.push([1, ['(NanNew)', '(\\("[^\\"]*"[^\\)]*\\))(?!\\.ToLocalChecked\\(\\))'].join('')]);
|
||||
|
||||
/* Removed v8 APIs, warn that the code needs rewriting using node::Buffer, key group 2 */
|
||||
groups.push([2, ['(', warning2, ')?', '^.*?(', [
|
||||
'GetIndexedPropertiesExternalArrayDataLength',
|
||||
'GetIndexedPropertiesExternalArrayData',
|
||||
'GetIndexedPropertiesExternalArrayDataType',
|
||||
'GetIndexedPropertiesPixelData',
|
||||
'GetIndexedPropertiesPixelDataLength',
|
||||
'HasIndexedPropertiesInExternalArrayData',
|
||||
'HasIndexedPropertiesInPixelData',
|
||||
'SetIndexedPropertiesToExternalArrayData',
|
||||
'SetIndexedPropertiesToPixelData'].join('|'), ')'].join('')]);
|
||||
|
||||
/* No need for NanScope in V8-exposed methods, key group 2 */
|
||||
groups.push([2, ['((', [
|
||||
'NAN_METHOD',
|
||||
'NAN_GETTER',
|
||||
'NAN_SETTER',
|
||||
'NAN_PROPERTY_GETTER',
|
||||
'NAN_PROPERTY_SETTER',
|
||||
'NAN_PROPERTY_ENUMERATOR',
|
||||
'NAN_PROPERTY_DELETER',
|
||||
'NAN_PROPERTY_QUERY',
|
||||
'NAN_INDEX_GETTER',
|
||||
'NAN_INDEX_SETTER',
|
||||
'NAN_INDEX_ENUMERATOR',
|
||||
'NAN_INDEX_DELETER',
|
||||
'NAN_INDEX_QUERY'].join('|'), ')\\([^\\)]*\\)\\s*\\{)\\s*NanScope\\(\\)\\s*;'].join('')]);
|
||||
|
||||
/* v8::Value::ToXXXXXXX returns v8::MaybeLocal<T>, key group 3 */
|
||||
groups.push([3, ['([\\s\\(\\)])([^\\s\\(\\)]+)->(', [
|
||||
'Boolean',
|
||||
'Number',
|
||||
'String',
|
||||
'Object',
|
||||
'Integer',
|
||||
'Uint32',
|
||||
'Int32'].join('|'), ')\\('].join('')]);
|
||||
|
||||
/* v8::Value::XXXXXXXValue returns v8::Maybe<T>, key group 3 */
|
||||
groups.push([3, ['([\\s\\(\\)])([^\\s\\(\\)]+)->((?:', [
|
||||
'Boolean',
|
||||
'Number',
|
||||
'Integer',
|
||||
'Uint32',
|
||||
'Int32'].join('|'), ')Value)\\('].join('')]);
|
||||
|
||||
/* NAN_WEAK_CALLBACK macro was removed, write out callback definition, key group 1 */
|
||||
groups.push([1, '(NAN_WEAK_CALLBACK)\\(([^\\s\\)]+)\\)']);
|
||||
|
||||
/* node::ObjectWrap and v8::Persistent have been replaced with Nan implementations, key group 1 */
|
||||
groups.push([1, ['(', [
|
||||
'NanDisposePersistent',
|
||||
'NanObjectWrapHandle'].join('|'), ')\\s*\\(\\s*([^\\s\\)]+)'].join('')]);
|
||||
|
||||
/* Since NanPersistent there is no need for NanMakeWeakPersistent, key group 1 */
|
||||
groups.push([1, '(NanMakeWeakPersistent)\\s*\\(\\s*([^\\s,]+)\\s*,\\s*']);
|
||||
|
||||
/* Many methods of v8::Object and others now return v8::MaybeLocal<T>, key group 3 */
|
||||
groups.push([3, ['([\\s])([^\\s]+)->(', [
|
||||
'GetEndColumn',
|
||||
'GetFunction',
|
||||
'GetLineNumber',
|
||||
'NewInstance',
|
||||
'GetPropertyNames',
|
||||
'GetOwnPropertyNames',
|
||||
'GetSourceLine',
|
||||
'GetStartColumn',
|
||||
'ObjectProtoToString',
|
||||
'ToArrayIndex',
|
||||
'ToDetailString',
|
||||
'CallAsConstructor',
|
||||
'CallAsFunction',
|
||||
'CloneElementAt',
|
||||
'Delete',
|
||||
'ForceSet',
|
||||
'Get',
|
||||
'GetPropertyAttributes',
|
||||
'GetRealNamedProperty',
|
||||
'GetRealNamedPropertyInPrototypeChain',
|
||||
'Has',
|
||||
'HasOwnProperty',
|
||||
'HasRealIndexedProperty',
|
||||
'HasRealNamedCallbackProperty',
|
||||
'HasRealNamedProperty',
|
||||
'Set',
|
||||
'SetAccessor',
|
||||
'SetIndexedPropertyHandler',
|
||||
'SetNamedPropertyHandler',
|
||||
'SetPrototype'].join('|'), ')\\('].join('')]);
|
||||
|
||||
/* You should get an error if any of these fail anyways,
|
||||
or handle the error better, it is indicated either way, key group 2 */
|
||||
groups.push([2, ['NanNew(<(?:v8\\:\\:)?(', ['Date', 'String', 'RegExp'].join('|'), ')>)(\\([^\\)]*\\))(?!\\.ToLocalChecked\\(\\))'].join('')]);
|
||||
|
||||
/* v8::Value::Equals now returns a v8::Maybe, key group 3 */
|
||||
groups.push([3, '([\\s\\(\\)])([^\\s\\(\\)]+)->(Equals)\\(([^\\s\\)]+)']);
|
||||
|
||||
/* NanPersistent makes this unnecessary, key group 1 */
|
||||
groups.push([1, '(NanAssignPersistent)(?:<v8\\:\\:[^>]+>)?\\(([^,]+),\\s*']);
|
||||
|
||||
/* args has been renamed to info, key group 2 */
|
||||
groups.push([2, '(\\W)(args)(\\W)'])
|
||||
|
||||
/* node::ObjectWrap was replaced with NanObjectWrap, key group 2 */
|
||||
groups.push([2, '(\\W)(?:node\\:\\:)?(ObjectWrap)(\\W)']);
|
||||
|
||||
/* v8::Persistent was replaced with NanPersistent, key group 2 */
|
||||
groups.push([2, '(\\W)(?:v8\\:\\:)?(Persistent)(\\W)']);
|
||||
|
||||
/* counts the number of capturing groups in a well-formed regular expression,
|
||||
ignoring non-capturing groups and escaped parentheses */
|
||||
function groupcount(s) {
|
||||
var positive = s.match(/\((?!\?)/g),
|
||||
negative = s.match(/\\\(/g);
|
||||
return (positive ? positive.length : 0) - (negative ? negative.length : 0);
|
||||
}
|
||||
|
||||
/* compute the absolute position of each key group in the joined master RegExp */
|
||||
for (i = 1, length = groups.length; i < length; i++) {
|
||||
total += groupcount(groups[i - 1][1]);
|
||||
groups[i][0] += total;
|
||||
}
|
||||
|
||||
/* create the master RegExp, whis is the union of all the groups' expressions */
|
||||
master = new RegExp(groups.map(function (a) { return a[1]; }).join('|'), 'gm');
|
||||
|
||||
/* replacement function for String.replace, receives 21 arguments */
|
||||
function replace() {
|
||||
/* simple expressions */
|
||||
switch (arguments[groups[0][0]]) {
|
||||
case '_NAN_':
|
||||
return 'NAN_';
|
||||
case 'NODE_SET_METHOD':
|
||||
return 'NanSetMethod';
|
||||
case 'NODE_SET_PROTOTYPE_METHOD':
|
||||
return 'NanSetPrototypeMethod';
|
||||
case 'NanAsciiString':
|
||||
return 'NanUtf8String';
|
||||
case 'NanEscapeScope':
|
||||
return 'scope.Escape';
|
||||
case 'NanReturnNull':
|
||||
return 'info.GetReturnValue().SetNull';
|
||||
case 'NanReturnValue':
|
||||
return 'info.GetReturnValue().Set';
|
||||
case 'NanUcs2String':
|
||||
return 'v8::String::Value';
|
||||
default:
|
||||
}
|
||||
|
||||
/* macros without arguments */
|
||||
switch (arguments[groups[1][0]]) {
|
||||
case 'NanEscapableScope':
|
||||
return 'NanEscapableScope scope'
|
||||
case 'NanReturnUndefined':
|
||||
return 'return';
|
||||
case 'NanScope':
|
||||
return 'NanScope scope';
|
||||
default:
|
||||
}
|
||||
|
||||
/* TryCatch, emulate negative backref */
|
||||
if (arguments[groups[2][0]] === 'TryCatch') {
|
||||
return arguments[groups[2][0] - 1] ? arguments[0] : 'NanTryCatch';
|
||||
}
|
||||
|
||||
/* NanNew("foo") --> NanNew("foo").ToLocalChecked() */
|
||||
if (arguments[groups[3][0]] === 'NanNew') {
|
||||
return [arguments[0], '.ToLocalChecked()'].join('');
|
||||
}
|
||||
|
||||
/* insert warning for removed functions as comment on new line above */
|
||||
switch (arguments[groups[4][0]]) {
|
||||
case 'GetIndexedPropertiesExternalArrayData':
|
||||
case 'GetIndexedPropertiesExternalArrayDataLength':
|
||||
case 'GetIndexedPropertiesExternalArrayDataType':
|
||||
case 'GetIndexedPropertiesPixelData':
|
||||
case 'GetIndexedPropertiesPixelDataLength':
|
||||
case 'HasIndexedPropertiesInExternalArrayData':
|
||||
case 'HasIndexedPropertiesInPixelData':
|
||||
case 'SetIndexedPropertiesToExternalArrayData':
|
||||
case 'SetIndexedPropertiesToPixelData':
|
||||
return arguments[groups[4][0] - 1] ? arguments[0] : [warning1, arguments[0]].join('');
|
||||
default:
|
||||
}
|
||||
|
||||
/* remove unnecessary NanScope() */
|
||||
switch (arguments[groups[5][0]]) {
|
||||
case 'NAN_GETTER':
|
||||
case 'NAN_METHOD':
|
||||
case 'NAN_SETTER':
|
||||
case 'NAN_INDEX_DELETER':
|
||||
case 'NAN_INDEX_ENUMERATOR':
|
||||
case 'NAN_INDEX_GETTER':
|
||||
case 'NAN_INDEX_QUERY':
|
||||
case 'NAN_INDEX_SETTER':
|
||||
case 'NAN_PROPERTY_DELETER':
|
||||
case 'NAN_PROPERTY_ENUMERATOR':
|
||||
case 'NAN_PROPERTY_GETTER':
|
||||
case 'NAN_PROPERTY_QUERY':
|
||||
case 'NAN_PROPERTY_SETTER':
|
||||
return arguments[groups[5][0] - 1];
|
||||
default:
|
||||
}
|
||||
|
||||
/* Value converstion */
|
||||
switch (arguments[groups[6][0]]) {
|
||||
case 'Boolean':
|
||||
case 'Int32':
|
||||
case 'Integer':
|
||||
case 'Number':
|
||||
case 'Object':
|
||||
case 'String':
|
||||
case 'Uint32':
|
||||
return [arguments[groups[6][0] - 2], 'NanTo<v8::', arguments[groups[6][0]], '>(', arguments[groups[6][0] - 1]].join('');
|
||||
default:
|
||||
}
|
||||
|
||||
/* other value conversion */
|
||||
switch (arguments[groups[7][0]]) {
|
||||
case 'BooleanValue':
|
||||
return [arguments[groups[7][0] - 2], 'NanTo<bool>(', arguments[groups[7][0] - 1]].join('');
|
||||
case 'Int32Value':
|
||||
return [arguments[groups[7][0] - 2], 'NanTo<int32_t>(', arguments[groups[7][0] - 1]].join('');
|
||||
case 'IntegerValue':
|
||||
return [arguments[groups[7][0] - 2], 'NanTo<int64_t>(', arguments[groups[7][0] - 1]].join('');
|
||||
case 'Uint32Value':
|
||||
return [arguments[groups[7][0] - 2], 'NanTo<uint32_t>(', arguments[groups[7][0] - 1]].join('');
|
||||
default:
|
||||
}
|
||||
|
||||
/* NAN_WEAK_CALLBACK */
|
||||
if (arguments[groups[8][0]] === 'NAN_WEAK_CALLBACK') {
|
||||
return ['template<typename T>\nvoid ',
|
||||
arguments[groups[8][0] + 1], '(const NanWeakCallbackInfo<T> &data)'].join('');
|
||||
}
|
||||
|
||||
/* use methods on NAN classes instead */
|
||||
switch (arguments[groups[9][0]]) {
|
||||
case 'NanDisposePersistent':
|
||||
return [arguments[groups[9][0] + 1], '.Reset('].join('');
|
||||
case 'NanObjectWrapHandle':
|
||||
return [arguments[groups[9][0] + 1], '->handle('].join('');
|
||||
default:
|
||||
}
|
||||
|
||||
/* use method on NanPersistent instead */
|
||||
if (arguments[groups[10][0]] === 'NanMakeWeakPersistent') {
|
||||
return arguments[groups[10][0] + 1] + '.SetWeak(';
|
||||
}
|
||||
|
||||
/* These return Maybes, the upper ones take no arguments */
|
||||
switch (arguments[groups[11][0]]) {
|
||||
case 'GetEndColumn':
|
||||
case 'GetFunction':
|
||||
case 'GetLineNumber':
|
||||
case 'GetOwnPropertyNames':
|
||||
case 'GetPropertyNames':
|
||||
case 'GetSourceLine':
|
||||
case 'GetStartColumn':
|
||||
case 'NewInstance':
|
||||
case 'ObjectProtoToString':
|
||||
case 'ToArrayIndex':
|
||||
case 'ToDetailString':
|
||||
return [arguments[groups[11][0] - 2], 'Nan', arguments[groups[11][0]], '(', arguments[groups[11][0] - 1]].join('');
|
||||
case 'CallAsConstructor':
|
||||
case 'CallAsFunction':
|
||||
case 'CloneElementAt':
|
||||
case 'Delete':
|
||||
case 'ForceSet':
|
||||
case 'Get':
|
||||
case 'GetPropertyAttributes':
|
||||
case 'GetRealNamedProperty':
|
||||
case 'GetRealNamedPropertyInPrototypeChain':
|
||||
case 'Has':
|
||||
case 'HasOwnProperty':
|
||||
case 'HasRealIndexedProperty':
|
||||
case 'HasRealNamedCallbackProperty':
|
||||
case 'HasRealNamedProperty':
|
||||
case 'Set':
|
||||
case 'SetAccessor':
|
||||
case 'SetIndexedPropertyHandler':
|
||||
case 'SetNamedPropertyHandler':
|
||||
case 'SetPrototype':
|
||||
return [arguments[groups[11][0] - 2], 'Nan', arguments[groups[11][0]], '(', arguments[groups[11][0] - 1], ', '].join('');
|
||||
default:
|
||||
}
|
||||
|
||||
/* Automatic ToLocalChecked(), take it or leave it */
|
||||
switch (arguments[groups[12][0]]) {
|
||||
case 'Date':
|
||||
case 'String':
|
||||
case 'RegExp':
|
||||
return ['NanNew', arguments[groups[12][0] - 1], arguments[groups[12][0] + 1], '.ToLocalChecked()'].join('');
|
||||
default:
|
||||
}
|
||||
|
||||
/* NanEquals is now required for uniformity */
|
||||
if (arguments[groups[13][0]] === 'Equals') {
|
||||
return [arguments[groups[13][0] - 1], 'NanEquals(', arguments[groups[13][0] - 1], ', ', arguments[groups[13][0] + 1]].join('');
|
||||
}
|
||||
|
||||
/* use method on replacement class instead */
|
||||
if (arguments[groups[14][0]] === 'NanAssignPersistent') {
|
||||
return [arguments[groups[14][0] + 1], '.Reset('].join('');
|
||||
}
|
||||
|
||||
/* args --> info */
|
||||
if (arguments[groups[15][0]] === 'args') {
|
||||
return [arguments[groups[15][0] - 1], 'info', arguments[groups[15][0] + 1]].join('');
|
||||
}
|
||||
|
||||
/* ObjectWrap --> NanObjectWrap */
|
||||
if (arguments[groups[16][0]] === 'ObjectWrap') {
|
||||
return [arguments[groups[16][0] - 1], 'NanObjectWrap', arguments[groups[16][0] + 1]].join('');
|
||||
}
|
||||
|
||||
/* Persistent --> NanPersistent */
|
||||
if (arguments[groups[17][0]] === 'Persistent') {
|
||||
return [arguments[groups[17][0] - 1], 'NanPersistent', arguments[groups[17][0] + 1]].join('');
|
||||
}
|
||||
|
||||
/* This should not happen. A switch is probably missing a case if it does. */
|
||||
throw 'Unhandled match: ' + arguments[0];
|
||||
}
|
||||
|
||||
/* reads a file, runs replacement and writes it back */
|
||||
function processFile(file) {
|
||||
fs.readFile(file, {encoding: 'utf8'}, function (err, data) {
|
||||
if (err) {
|
||||
throw err;
|
||||
}
|
||||
|
||||
/* run replacement twice, might need more runs */
|
||||
fs.writeFile(file, data.replace(master, replace).replace(master, replace), function (err) {
|
||||
if (err) {
|
||||
throw err;
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/* process file names from command line and process the identified files */
|
||||
for (i = 2, length = process.argv.length; i < length; i++) {
|
||||
glob(process.argv[i], function (err, matches) {
|
||||
if (err) {
|
||||
throw err;
|
||||
}
|
||||
matches.forEach(processFile);
|
||||
});
|
||||
}
|
||||
+14
@@ -0,0 +1,14 @@
|
||||
1to2 naively converts source code files from NAN 1 to NAN 2. There will be erroneous conversions,
|
||||
false positives and missed opportunities. The input files are rewritten in place. Make sure that
|
||||
you have backups. You will have to manually review the changes afterwards and do some touchups.
|
||||
|
||||
```sh
|
||||
$ tools/1to2.js
|
||||
|
||||
Usage: 1to2 [options] <file ...>
|
||||
|
||||
Options:
|
||||
|
||||
-h, --help output usage information
|
||||
-V, --version output the version number
|
||||
```
|
||||
+19
@@ -0,0 +1,19 @@
|
||||
{
|
||||
"name": "1to2",
|
||||
"version": "1.0.0",
|
||||
"description": "NAN 1 -> 2 Migration Script",
|
||||
"main": "1to2.js",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git://github.com/nodejs/nan.git"
|
||||
},
|
||||
"contributors": [
|
||||
"Benjamin Byholm <bbyholm@abo.fi> (https://github.com/kkoopa/)",
|
||||
"Mathias Küsel (https://github.com/mathiask88/)"
|
||||
],
|
||||
"dependencies": {
|
||||
"glob": "~5.0.10",
|
||||
"commander": "~2.8.1"
|
||||
},
|
||||
"license": "MIT"
|
||||
}
|
||||
+230
@@ -0,0 +1,230 @@
|
||||
{
|
||||
"_args": [
|
||||
[
|
||||
"zmq",
|
||||
"C:\\Users\\kamisama\\Downloads\\plugins\\LiveTexturing"
|
||||
]
|
||||
],
|
||||
"_from": "zmq@*",
|
||||
"_id": "zmq@2.14.0",
|
||||
"_inCache": true,
|
||||
"_installable": true,
|
||||
"_location": "/zmq",
|
||||
"_npmUser": {
|
||||
"email": "ron@ronkorving.nl",
|
||||
"name": "ronkorving"
|
||||
},
|
||||
"_npmVersion": "1.4.28",
|
||||
"_phantomChildren": {},
|
||||
"_requested": {
|
||||
"name": "zmq",
|
||||
"raw": "zmq",
|
||||
"rawSpec": "",
|
||||
"scope": null,
|
||||
"spec": "*",
|
||||
"type": "range"
|
||||
},
|
||||
"_requiredBy": [
|
||||
"#USER"
|
||||
],
|
||||
"_resolved": "https://registry.npmjs.org/zmq/-/zmq-2.14.0.tgz",
|
||||
"_shasum": "86e7ba8814363c98655553325d214daaa52fc8a4",
|
||||
"_shrinkwrap": null,
|
||||
"_spec": "zmq",
|
||||
"_where": "C:\\Users\\kamisama\\Downloads\\plugins\\LiveTexturing",
|
||||
"author": {
|
||||
"email": "justin.tulloss@gmail.com",
|
||||
"name": "Justin Tulloss",
|
||||
"url": "http://justin.harmonize.fm"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/JustinTulloss/zeromq.node/issues"
|
||||
},
|
||||
"contributors": [
|
||||
{
|
||||
"name": "Alexander Simmerl",
|
||||
"url": "https://github.com/xla"
|
||||
},
|
||||
{
|
||||
"name": "Justin Tulloss",
|
||||
"email": "justin.tulloss@gmail.com",
|
||||
"url": "http://justin.harmonize.fm"
|
||||
},
|
||||
{
|
||||
"name": "Mike Castleman",
|
||||
"email": "m@mlcastle.net",
|
||||
"url": "http://mlcastle.net/"
|
||||
},
|
||||
{
|
||||
"name": "Matt Crocker"
|
||||
},
|
||||
{
|
||||
"name": "Jeremy Barnes",
|
||||
"email": "jeremy@barneso.com",
|
||||
"url": "http://www.barneso.com/"
|
||||
},
|
||||
{
|
||||
"name": "Rick",
|
||||
"email": "technoweenie@gmail.com",
|
||||
"url": "http://techno-weenie.net/"
|
||||
},
|
||||
{
|
||||
"name": "Corey Jewett",
|
||||
"url": "http://syntheticplayground.com/"
|
||||
},
|
||||
{
|
||||
"name": "Micheil Smith",
|
||||
"email": "micheil@brandedcode.com",
|
||||
"url": "http://brandedcode.com/"
|
||||
},
|
||||
{
|
||||
"name": "TJ Holowaychuk",
|
||||
"email": "tj@vision-media.ca",
|
||||
"url": "http://tjholowaychuk.com/"
|
||||
},
|
||||
{
|
||||
"name": "Ron Korving",
|
||||
"url": "https://github.com/ronkorving"
|
||||
},
|
||||
{
|
||||
"name": "Mark Everitt",
|
||||
"url": "http://qubyte.dyndns.org/"
|
||||
},
|
||||
{
|
||||
"name": "Aldis Andrejevs",
|
||||
"url": "https://github.com/aaudis"
|
||||
},
|
||||
{
|
||||
"name": "Iskren Ivov Chernev",
|
||||
"email": "iskren.chernev@gmail.com"
|
||||
},
|
||||
{
|
||||
"name": "Seth Fitzsimmons"
|
||||
},
|
||||
{
|
||||
"name": "Patrick Lucas"
|
||||
},
|
||||
{
|
||||
"name": "Stéphan Kochen",
|
||||
"email": "stephan@kochen.nl",
|
||||
"url": "http://stephan.kochen.nl/"
|
||||
},
|
||||
{
|
||||
"name": "Ian Babrou"
|
||||
},
|
||||
{
|
||||
"name": "Niall O'Higgins"
|
||||
},
|
||||
{
|
||||
"name": "Brian White",
|
||||
"url": "https://github.com/mscdex"
|
||||
},
|
||||
{
|
||||
"name": "Mathieu D'Amours",
|
||||
"url": "https://github.com/matehat"
|
||||
},
|
||||
{
|
||||
"name": "Joshua Gourneau"
|
||||
},
|
||||
{
|
||||
"name": "Yaroslav Shirokov"
|
||||
},
|
||||
{
|
||||
"name": "Marc Harter",
|
||||
"url": "https://github.com/wavded"
|
||||
},
|
||||
{
|
||||
"name": "John Sun",
|
||||
"url": "https://github.com/freehaha"
|
||||
},
|
||||
{
|
||||
"name": "Alexey Kupershtokh",
|
||||
"email": "alexey.kupershtokh@gmail.com"
|
||||
},
|
||||
{
|
||||
"name": "Jon Gretar Borgthorsson",
|
||||
"url": "https://github.com/JonGretar"
|
||||
},
|
||||
{
|
||||
"name": "Brian Lalor",
|
||||
"url": "https://github.com/blalor"
|
||||
},
|
||||
{
|
||||
"name": "Benjamin Byholm",
|
||||
"url": "https://github.com/kkoopa"
|
||||
},
|
||||
{
|
||||
"name": "Alejandro",
|
||||
"url": "https://github.com/Minjung"
|
||||
},
|
||||
{
|
||||
"name": "Eli Skeggs",
|
||||
"email": "skeggse@gmail.com",
|
||||
"url": "https://github.com/skeggse"
|
||||
},
|
||||
{
|
||||
"name": "Bent Cardan",
|
||||
"email": "bent@nothingsatisfies.com",
|
||||
"url": "https://github.com/reqshark"
|
||||
}
|
||||
],
|
||||
"dependencies": {
|
||||
"bindings": "~1.2.1",
|
||||
"nan": "~2.0.0"
|
||||
},
|
||||
"description": "Bindings for node.js and io.js to ZeroMQ",
|
||||
"devDependencies": {
|
||||
"mocha": "~1.13.0",
|
||||
"semver": "~4.1.1",
|
||||
"should": "2.1.x"
|
||||
},
|
||||
"directories": {},
|
||||
"dist": {
|
||||
"shasum": "86e7ba8814363c98655553325d214daaa52fc8a4",
|
||||
"tarball": "http://registry.npmjs.org/zmq/-/zmq-2.14.0.tgz"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=0.8"
|
||||
},
|
||||
"gitHead": "59338450cc2e20d442b4a282e9a53b8a5f3152b7",
|
||||
"gypfile": true,
|
||||
"homepage": "https://github.com/JustinTulloss/zeromq.node",
|
||||
"keywords": [
|
||||
"0mq",
|
||||
"addon",
|
||||
"binding",
|
||||
"libzmq",
|
||||
"native",
|
||||
"zeromq",
|
||||
"zmq",
|
||||
"ømq"
|
||||
],
|
||||
"license": "MIT",
|
||||
"main": "index",
|
||||
"maintainers": [
|
||||
{
|
||||
"name": "justin",
|
||||
"email": "justin.tulloss@gmail.com"
|
||||
},
|
||||
{
|
||||
"name": "tjholowaychuk",
|
||||
"email": "tj@vision-media.ca"
|
||||
},
|
||||
{
|
||||
"name": "ronkorving",
|
||||
"email": "ron@ronkorving.nl"
|
||||
}
|
||||
],
|
||||
"name": "zmq",
|
||||
"optionalDependencies": {},
|
||||
"readme": "ERROR: No README data found!",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+ssh://git@github.com/JustinTulloss/zeromq.node.git"
|
||||
},
|
||||
"scripts": {
|
||||
"install": "node-gyp rebuild",
|
||||
"test": "mocha --expose-gc --slow 2000 --timeout 600000"
|
||||
},
|
||||
"version": "2.14.0"
|
||||
}
|
||||
+25
@@ -0,0 +1,25 @@
|
||||
var zmq = require('../');
|
||||
var assert = require('assert');
|
||||
|
||||
if (process.argv.length != 5) {
|
||||
console.log('usage: local_lat <bind-to> <message-size> <roundtrip-count>');
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
var bind_to = process.argv[2];
|
||||
var message_size = Number(process.argv[3]);
|
||||
var roundtrip_count = Number(process.argv[4]);
|
||||
var counter = 0;
|
||||
|
||||
var rep = zmq.socket('rep');
|
||||
rep.bindSync(bind_to);
|
||||
|
||||
rep.on('message', function (data) {
|
||||
assert.equal(data.length, message_size, 'message-size did not match');
|
||||
rep.send(data);
|
||||
if (++counter === roundtrip_count){
|
||||
setTimeout( function(){
|
||||
rep.close();
|
||||
}, 1000);
|
||||
}
|
||||
})
|
||||
+41
@@ -0,0 +1,41 @@
|
||||
var zmq = require('../');
|
||||
var assert = require('assert');
|
||||
|
||||
if (process.argv.length != 5) {
|
||||
console.log('usage: local_thr <bind-to> <message-size> <message-count>');
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
var bind_to = process.argv[2];
|
||||
var message_size = Number(process.argv[3]);
|
||||
var message_count = Number(process.argv[4]);
|
||||
var counter = 0;
|
||||
|
||||
var sock = zmq.socket('pull');
|
||||
sock.bindSync(bind_to);
|
||||
|
||||
var timer;
|
||||
|
||||
sock.on('message', function (data) {
|
||||
if (!timer) {
|
||||
console.log('started receiving');
|
||||
timer = process.hrtime();
|
||||
}
|
||||
|
||||
assert.equal(data.length, message_size, 'message-size did not match');
|
||||
if (++counter === message_count) finish();
|
||||
})
|
||||
|
||||
function finish(){
|
||||
var endtime = process.hrtime(timer);
|
||||
var sec = endtime[0] + (endtime[1]/1000000000);
|
||||
var throughput = message_count / sec;
|
||||
var megabits = (throughput * message_size * 8) / 1000000;
|
||||
|
||||
console.log('message size: %d [B]', message_size);
|
||||
console.log('message count: %d', message_count);
|
||||
console.log('mean throughput: %d [msg/s]', throughput.toFixed(0));
|
||||
console.log('mean throughput: %d [Mbit/s]', megabits.toFixed(0));
|
||||
console.log('overall time: %d secs and %d nanoseconds', endtime[0], endtime[1]);
|
||||
sock.close();
|
||||
}
|
||||
+52
@@ -0,0 +1,52 @@
|
||||
var zmq = require('../');
|
||||
var assert = require('assert');
|
||||
|
||||
if (process.argv.length != 5) {
|
||||
console.log('usage: remote_lat <connect-to> <message-size> <roundtrip-count>');
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
var connect_to = process.argv[2];
|
||||
var message_size = Number(process.argv[3]);
|
||||
var roundtrip_count = Number(process.argv[4]);
|
||||
var message = new Buffer(message_size);
|
||||
message.fill('h');
|
||||
|
||||
var recvCounter = 0;
|
||||
|
||||
var req = zmq.socket('req');
|
||||
req.connect(connect_to);
|
||||
|
||||
var timer;
|
||||
|
||||
req.on('message', function (data) {
|
||||
if (!timer) {
|
||||
console.log('started receiving');
|
||||
timer = process.hrtime();
|
||||
}
|
||||
|
||||
assert.equal(data.length, message_size, 'message-size did not match');
|
||||
|
||||
if (++recvCounter === roundtrip_count) {
|
||||
finish();
|
||||
} else {
|
||||
send();
|
||||
}
|
||||
});
|
||||
|
||||
function finish() {
|
||||
var duration = process.hrtime(timer);
|
||||
var millis = duration[0] * 1000 + duration[1] / 1000000;
|
||||
|
||||
console.log('message size: %d [B]', message_size);
|
||||
console.log('roundtrip count: %d', roundtrip_count);
|
||||
console.log('mean latency: %d [msecs]', millis / (roundtrip_count * 2));
|
||||
console.log('overall time: %d secs and %d nanoseconds', duration[0], duration[1]);
|
||||
req.close()
|
||||
}
|
||||
|
||||
function send() {
|
||||
req.send(message);
|
||||
}
|
||||
|
||||
send()
|
||||
+37
@@ -0,0 +1,37 @@
|
||||
var zmq = require('../')
|
||||
var assert = require('assert')
|
||||
|
||||
if (process.argv.length != 5) {
|
||||
console.log('usage: remote_thr <bind-to> <message-size> <message-count>')
|
||||
process.exit(1)
|
||||
}
|
||||
|
||||
var connect_to = process.argv[2]
|
||||
var message_size = Number(process.argv[3])
|
||||
var message_count = Number(process.argv[4])
|
||||
var message = new Buffer(message_size)
|
||||
message.fill('h')
|
||||
|
||||
var counter = 0
|
||||
|
||||
var sock = zmq.socket('push')
|
||||
//sock.setsockopt(zmq.ZMQ_SNDHWM, message_count);
|
||||
sock.connect(connect_to)
|
||||
|
||||
function send(){
|
||||
for (var i = 0; i < message_count; i++) {
|
||||
sock.send(message)
|
||||
}
|
||||
|
||||
// all messages may not be received by local_thr if closed immediately
|
||||
setTimeout(function () {
|
||||
sock.close()
|
||||
}, 1000);
|
||||
}
|
||||
|
||||
// because of what seems to be a bug in node-zmq, we would lose messages
|
||||
// if we start sending immediately after calling connect(), so to make this
|
||||
// benchmark behave well, we wait a bit...
|
||||
|
||||
setTimeout(send, 1000);
|
||||
|
||||
+32
@@ -0,0 +1,32 @@
|
||||
var zmq = require('..')
|
||||
, should = require('should')
|
||||
, semver = require('semver')
|
||||
|
||||
describe('context', function() {
|
||||
|
||||
it('should support setting max io threads', function(done) {
|
||||
// 3.2 and above.
|
||||
if (!semver.gte(zmq.version, '3.2.0')) {
|
||||
done();
|
||||
return console.warn('Test requires libzmq >= 3.2.0');
|
||||
}
|
||||
zmq.Context.setMaxThreads(3);
|
||||
zmq.Context.getMaxThreads().should.equal(3);
|
||||
zmq.Context.setMaxThreads(1);
|
||||
done();
|
||||
});
|
||||
|
||||
it('should support setting max number of sockets', function(done) {
|
||||
// 3.2 and above.
|
||||
if (!semver.gte(zmq.version, '3.2.0')) {
|
||||
done();
|
||||
return console.warn('Test requires libzmq >= 3.2.0');
|
||||
}
|
||||
var currMaxSockets = zmq.Context.getMaxSockets();
|
||||
zmq.Context.setMaxSockets(256);
|
||||
zmq.Context.getMaxSockets().should.equal(256);
|
||||
zmq.Context.setMaxSockets(currMaxSockets);
|
||||
done();
|
||||
});
|
||||
|
||||
});
|
||||
+132
@@ -0,0 +1,132 @@
|
||||
|
||||
var zmq = require('..')
|
||||
, should = require('should')
|
||||
, semver = require('semver');
|
||||
|
||||
describe('exports', function(){
|
||||
it('should export a valid version', function(){
|
||||
semver.valid(zmq.version).should.be.ok;
|
||||
});
|
||||
|
||||
it('should generate valid curve keypair', function(done) {
|
||||
if (!semver.gte(zmq.version,'4.0.0') || require('os').platform() == 'win32'){
|
||||
done();
|
||||
return console.warn('Test requires libzmq >= 4 compiled with libsodium');
|
||||
}
|
||||
var curve = zmq.curveKeypair();
|
||||
should.exist(curve);
|
||||
should.exist(curve.public);
|
||||
should.exist(curve.secret);
|
||||
curve.public.length.should.equal(40);
|
||||
curve.secret.length.should.equal(40);
|
||||
done();
|
||||
});
|
||||
|
||||
it('should export socket types and options', function(){
|
||||
// All versions.
|
||||
var constants = [
|
||||
'PUB',
|
||||
'SUB',
|
||||
'REQ',
|
||||
'XREQ',
|
||||
'REP',
|
||||
'XREP',
|
||||
'DEALER',
|
||||
'ROUTER',
|
||||
'PUSH',
|
||||
'PULL',
|
||||
'PAIR',
|
||||
'AFFINITY',
|
||||
'IDENTITY',
|
||||
'SUBSCRIBE',
|
||||
'UNSUBSCRIBE',
|
||||
'RCVTIMEO',
|
||||
'SNDTIMEO',
|
||||
'RATE',
|
||||
'RECOVERY_IVL',
|
||||
'SNDBUF',
|
||||
'RCVBUF',
|
||||
'RCVMORE',
|
||||
'FD',
|
||||
'EVENTS',
|
||||
'TYPE',
|
||||
'LINGER',
|
||||
'RECONNECT_IVL',
|
||||
'RECONNECT_IVL_MAX',
|
||||
'BACKLOG',
|
||||
'POLLIN',
|
||||
'POLLOUT',
|
||||
'POLLERR',
|
||||
'SNDMORE'
|
||||
];
|
||||
|
||||
// 2.x only.
|
||||
if (semver.satisfies(zmq.version, '2.x')) {
|
||||
constants.concat([
|
||||
'HWM',
|
||||
'SWAP',
|
||||
'MCAST_LOOP',
|
||||
'ZMQ_RECOVERY_IVL_MSEC',
|
||||
'NOBLOCK'
|
||||
]);
|
||||
}
|
||||
|
||||
// 3.0 and above.
|
||||
if (semver.gte(zmq.version, '3.0.0')) {
|
||||
constants.concat([
|
||||
'XPUB',
|
||||
'XSUB',
|
||||
'SNDHWM',
|
||||
'RCVHWM',
|
||||
'MAXMSGSIZE',
|
||||
'ZMQ_MULTICAST_HOPS',
|
||||
'TCP_KEEPALIVE',
|
||||
'TCP_KEEPALIVE_CNT',
|
||||
'TCP_KEEPALIVE_IDLE',
|
||||
'TCP_KEEPALIVE_INTVL'
|
||||
]);
|
||||
}
|
||||
|
||||
// 3.2 and above.
|
||||
if (semver.gte(zmq.version, '3.2.0')) {
|
||||
constants.concat([
|
||||
'IPV4ONLY',
|
||||
'DELAY_ATTACH_ON_CONNECT',
|
||||
'ROUTER_MANDATORY',
|
||||
'XPUB_VERBOSE',
|
||||
'TCP_KEEPALIVE',
|
||||
'TCP_KEEPALIVE_IDLE',
|
||||
'TCP_KEEPALIVE_CNT',
|
||||
'TCP_KEEPALIVE_INTVL',
|
||||
'TCP_ACCEPT_FILTER',
|
||||
'LAST_ENDPOINT'
|
||||
]);
|
||||
}
|
||||
|
||||
// 3.3 and above.
|
||||
if (semver.gte(zmq.version, '3.3.0')) {
|
||||
constants.concat([
|
||||
'ROUTER_RAW'
|
||||
]);
|
||||
}
|
||||
|
||||
constants.forEach(function(typeOrProp){
|
||||
zmq['ZMQ_' + typeOrProp].should.be.a.Number;
|
||||
});
|
||||
});
|
||||
|
||||
it('should export states', function(){
|
||||
['STATE_READY', 'STATE_BUSY', 'STATE_CLOSED'].forEach(function(state){
|
||||
zmq[state].should.be.a.Number;
|
||||
});
|
||||
});
|
||||
|
||||
it('should export constructors', function(){
|
||||
zmq.Context.should.be.a.Function;
|
||||
zmq.Socket.should.be.a.Function;
|
||||
});
|
||||
|
||||
it('should export methods', function(){
|
||||
zmq.socket.should.be.a.Function;
|
||||
});
|
||||
});
|
||||
+52
@@ -0,0 +1,52 @@
|
||||
|
||||
var zmq = require('..')
|
||||
, should = require('should');
|
||||
|
||||
it('should cooperate with gc', function(done){
|
||||
var a = zmq.socket('dealer')
|
||||
, b = zmq.socket('dealer');
|
||||
|
||||
/**
|
||||
* We create 2 dealer sockets.
|
||||
* One of them (`a`) is not referenced explicitly after the main loop
|
||||
* finishes so it's a pretender for garbage collection.
|
||||
* This test performs gc() explicitly and then tries to send a message
|
||||
* to a dealer socket that could be destroyed and collected.
|
||||
* If a message is delivered, than everything is ok. Otherwise the guard
|
||||
* timeout will make the test fail.
|
||||
*/
|
||||
a.on('message', function(msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('hello');
|
||||
this.close();
|
||||
b.close();
|
||||
clearTimeout(timeout);
|
||||
done();
|
||||
});
|
||||
|
||||
var bound = false;
|
||||
|
||||
a.bind('tcp://127.0.0.1:5555', function(e){
|
||||
if (e) {
|
||||
clearInterval(interval);
|
||||
done(e);
|
||||
} else {
|
||||
bound = true;
|
||||
}
|
||||
});
|
||||
|
||||
var interval = setInterval(function(){
|
||||
gc();
|
||||
if (bound) {
|
||||
clearInterval(interval);
|
||||
b.connect('tcp://127.0.0.1:5555');
|
||||
b.send('hello');
|
||||
}
|
||||
}, 100);
|
||||
|
||||
// guard against hanging
|
||||
var timeout = setTimeout(function(){
|
||||
clearInterval(interval);
|
||||
done(new Error('timeout of 5000ms exceeded (bound: ' + bound + ')'));
|
||||
}, 15000);
|
||||
});
|
||||
+1
@@ -0,0 +1 @@
|
||||
--reporter spec
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
var zmq = require('..')
|
||||
, should = require('should')
|
||||
, semver = require('semver');
|
||||
|
||||
describe('socket.events', function(){
|
||||
|
||||
it('should support events', function(done){
|
||||
var rep = zmq.socket('rep')
|
||||
, req = zmq.socket('req');
|
||||
|
||||
rep.on('message', function(msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('hello');
|
||||
rep.send('world');
|
||||
});
|
||||
|
||||
rep.bind('inproc://stuff');
|
||||
|
||||
rep.on('bind', function(){
|
||||
req.connect('inproc://stuff');
|
||||
req.send('hello');
|
||||
req.on('message', function(msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('world');
|
||||
req.close();
|
||||
rep.close();
|
||||
done();
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
+60
@@ -0,0 +1,60 @@
|
||||
|
||||
var zmq = require('..')
|
||||
, should = require('should')
|
||||
, semver = require('semver');
|
||||
|
||||
describe('socket', function(){
|
||||
var sock;
|
||||
|
||||
it('should alias socket', function(){
|
||||
zmq.createSocket.should.equal(zmq.socket);
|
||||
});
|
||||
|
||||
it('should include type and close', function(){
|
||||
sock = zmq.socket('req');
|
||||
sock.type.should.equal('req');
|
||||
sock.close.should.be.a.Function;
|
||||
});
|
||||
|
||||
it('should use socketopt', function(){
|
||||
sock.getsockopt(zmq.ZMQ_BACKLOG).should.not.equal(75);
|
||||
sock.setsockopt(zmq.ZMQ_BACKLOG, 75).should.equal(sock);
|
||||
sock.getsockopt(zmq.ZMQ_BACKLOG).should.equal(75);
|
||||
sock.setsockopt(zmq.ZMQ_BACKLOG, 100);
|
||||
});
|
||||
|
||||
it('should use socketopt with sugar', function(){
|
||||
sock.getsockopt('backlog').should.not.equal(75);
|
||||
sock.setsockopt('backlog', 75).should.equal(sock);
|
||||
sock.getsockopt('backlog').should.equal(75);
|
||||
|
||||
sock.backlog.should.be.a.Number;
|
||||
sock.backlog.should.not.equal(50);
|
||||
sock.backlog = 50;
|
||||
sock.backlog.should.equal(50);
|
||||
});
|
||||
|
||||
it('should close', function(){
|
||||
sock.close();
|
||||
});
|
||||
|
||||
it('should support options', function(){
|
||||
sock = zmq.socket('req', { backlog: 30 });
|
||||
sock.backlog.should.equal(30);
|
||||
sock.close();
|
||||
});
|
||||
|
||||
it('should throw a javascript error if it hits the system file descriptor limit', function() {
|
||||
var i, socks = [], numSocks = 10000;
|
||||
function hitlimit() {
|
||||
for (i = 0; i < numSocks; i++) {
|
||||
socks.push(zmq.socket('router'));
|
||||
}
|
||||
}
|
||||
hitlimit.should['throw'];
|
||||
for (i = 0; i < socks.length; i++) {
|
||||
socks[i].close();
|
||||
}
|
||||
});
|
||||
|
||||
});
|
||||
+141
@@ -0,0 +1,141 @@
|
||||
var zmq = require('..')
|
||||
, should = require('should')
|
||||
, semver = require('semver');
|
||||
|
||||
describe('socket.messages', function(){
|
||||
var push, pull;
|
||||
|
||||
beforeEach(function(){
|
||||
push = zmq.socket('push');
|
||||
pull = zmq.socket('pull');
|
||||
});
|
||||
|
||||
it('should support messages', function(done){
|
||||
var n = 0;
|
||||
|
||||
pull.on('message', function(msg){
|
||||
msg = msg.toString();
|
||||
switch (n++) {
|
||||
case 0:
|
||||
msg.should.equal('string');
|
||||
break;
|
||||
case 1:
|
||||
msg.should.equal('15.99');
|
||||
break;
|
||||
case 2:
|
||||
msg.should.equal('buffer');
|
||||
push.close();
|
||||
pull.close();
|
||||
done();
|
||||
break;
|
||||
}
|
||||
});
|
||||
|
||||
pull.bind('inproc://stuff_ssm', function(){
|
||||
push.connect('inproc://stuff_ssm');
|
||||
push.send('string');
|
||||
push.send(15.99);
|
||||
push.send(new Buffer('buffer'));
|
||||
});
|
||||
});
|
||||
|
||||
it('should support multipart messages', function(done){
|
||||
pull.on('message', function(msg1, msg2, msg3){
|
||||
msg1.toString().should.equal('string');
|
||||
msg2.toString().should.equal('15.99');
|
||||
msg3.toString().should.equal('buffer');
|
||||
push.close();
|
||||
pull.close();
|
||||
done();
|
||||
});
|
||||
|
||||
pull.bind('inproc://stuff_ssmm', function(){
|
||||
push.connect('inproc://stuff_ssmm');
|
||||
push.send(['string', 15.99, new Buffer('buffer')]);
|
||||
});
|
||||
});
|
||||
|
||||
it('should support sndmore', function(done){
|
||||
pull.on('message', function(a, b, c, d, e){
|
||||
a.toString().should.equal('tobi');
|
||||
b.toString().should.equal('loki');
|
||||
c.toString().should.equal('jane');
|
||||
d.toString().should.equal('luna');
|
||||
e.toString().should.equal('manny');
|
||||
push.close();
|
||||
pull.close();
|
||||
done();
|
||||
});
|
||||
|
||||
pull.bind('inproc://stuff_sss', function(){
|
||||
push.connect('inproc://stuff_sss');
|
||||
push.send(['tobi', 'loki'], zmq.ZMQ_SNDMORE);
|
||||
push.send(['jane', 'luna'], zmq.ZMQ_SNDMORE);
|
||||
push.send('manny');
|
||||
});
|
||||
});
|
||||
|
||||
it('should handle late connect', function(done){
|
||||
var n = 0;
|
||||
|
||||
pull.on('message', function(msg){
|
||||
msg = msg.toString();
|
||||
switch (n++) {
|
||||
case 0:
|
||||
msg.should.equal('string');
|
||||
break;
|
||||
case 1:
|
||||
msg.should.equal('15.99');
|
||||
break;
|
||||
case 2:
|
||||
msg.should.equal('buffer');
|
||||
push.close();
|
||||
pull.close();
|
||||
done();
|
||||
break;
|
||||
}
|
||||
});
|
||||
|
||||
if (semver.satisfies(zmq.version, '>=3.x')) {
|
||||
push.setsockopt(zmq.ZMQ_SNDHWM, 1);
|
||||
pull.setsockopt(zmq.ZMQ_RCVHWM, 1);
|
||||
} else if (semver.satisfies(zmq.version, '2.x')) {
|
||||
push.setsockopt(zmq.ZMQ_HWM, 1);
|
||||
pull.setsockopt(zmq.ZMQ_HWM, 1);
|
||||
}
|
||||
|
||||
push.bind('tcp://127.0.0.1:12345', function () {
|
||||
push.send('string');
|
||||
push.send(15.99);
|
||||
push.send(new Buffer('buffer'));
|
||||
pull.connect('tcp://127.0.0.1:12345');
|
||||
});
|
||||
});
|
||||
|
||||
it('should call send() callbacks', function(done){
|
||||
var received = 0;
|
||||
var callbacks = 0;
|
||||
|
||||
function cb() {
|
||||
callbacks += 1;
|
||||
}
|
||||
|
||||
pull.on('message', function () {
|
||||
received += 1;
|
||||
|
||||
if (received === 4) {
|
||||
callbacks.should.equal(received);
|
||||
done();
|
||||
}
|
||||
});
|
||||
|
||||
pull.bind('inproc://stuff_ssmm', function(){
|
||||
push.connect('inproc://stuff_ssmm');
|
||||
|
||||
push.send('hello', null, cb);
|
||||
push.send('hello', null, cb);
|
||||
push.send('hello', null, cb);
|
||||
push.send(['hello', 'world'], null, cb);
|
||||
});
|
||||
});
|
||||
});
|
||||
+104
@@ -0,0 +1,104 @@
|
||||
var zmq = require('..')
|
||||
, should = require('should')
|
||||
, semver = require('semver');
|
||||
|
||||
describe('socket.monitor', function() {
|
||||
if (!zmq.ZMQ_CAN_MONITOR) {
|
||||
console.log("monitoring not enabled skipping test");
|
||||
return;
|
||||
}
|
||||
|
||||
it('should be able to monitor the socket', function(done) {
|
||||
var rep = zmq.socket('rep')
|
||||
, req = zmq.socket('req')
|
||||
, events = [];
|
||||
|
||||
rep.on('message', function(msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('hello');
|
||||
rep.send('world');
|
||||
});
|
||||
|
||||
var testedEvents = ['listen', 'accept', 'disconnect', 'close'];
|
||||
testedEvents.forEach(function(e) {
|
||||
rep.on(e, function(event_value, event_endpoint_addr) {
|
||||
// Test the endpoint addr arg
|
||||
event_endpoint_addr.toString().should.equal('tcp://127.0.0.1:5423');
|
||||
|
||||
// If this is a disconnect event we can now close the rep socket
|
||||
if (e === 'disconnect') {
|
||||
rep.close();
|
||||
}
|
||||
|
||||
testedEvents.pop();
|
||||
if (testedEvents.length === 0) {
|
||||
rep.unmonitor();
|
||||
done();
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// enable monitoring for this socket
|
||||
rep.monitor();
|
||||
|
||||
rep.bind('tcp://127.0.0.1:5423');
|
||||
|
||||
rep.on('bind', function(){
|
||||
req.connect('tcp://127.0.0.1:5423');
|
||||
req.send('hello');
|
||||
req.on('message', function(msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('world');
|
||||
req.close();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
it('should use default interval and numOfEvents', function(done) {
|
||||
var req = zmq.socket('req');
|
||||
req.setsockopt(zmq.ZMQ_RECONNECT_IVL, 5); // We want a quick connect retry from zmq
|
||||
|
||||
// We will try to connect to a non-existing server, zmq will issue events: "connect_retry", "close", "connect_retry"
|
||||
// The connect_retry will be issued immediately after the close event, so we will measure the time between the close
|
||||
// event and connect_retry event, those should >= 10 (this will tell us that we are reading 1 event at a time from
|
||||
// the monitor socket).
|
||||
|
||||
var closeTime;
|
||||
req.on('close', function() {
|
||||
closeTime = Date.now();
|
||||
});
|
||||
|
||||
req.on('connect_retry', function() {
|
||||
var diff = Date.now() - closeTime;
|
||||
req.unmonitor();
|
||||
req.close();
|
||||
diff.should.be.within(10, 20);
|
||||
done();
|
||||
});
|
||||
|
||||
req.monitor();
|
||||
req.connect('tcp://127.0.0.1:5423');
|
||||
});
|
||||
|
||||
it('should read multiple events on monitor interval', function(done) {
|
||||
var req = zmq.socket('req');
|
||||
req.setsockopt(zmq.ZMQ_RECONNECT_IVL, 5);
|
||||
var closeTime;
|
||||
req.on('close', function() {
|
||||
closeTime = Date.now();
|
||||
});
|
||||
|
||||
req.on('connect_retry', function() {
|
||||
var diff = Date.now() - closeTime;
|
||||
req.unmonitor();
|
||||
req.close();
|
||||
diff.should.be.within(0, 5);
|
||||
done();
|
||||
});
|
||||
|
||||
// This should read all available messages from the queue, and we expect that "close" and "connect_retry" will be
|
||||
// read on the same interval (for further details see the comment in the previous test)
|
||||
req.monitor(10, 0);
|
||||
req.connect('tcp://127.0.0.1:5423');
|
||||
});
|
||||
});
|
||||
+46
@@ -0,0 +1,46 @@
|
||||
var zmq = require('..')
|
||||
, should = require('should')
|
||||
, semver = require('semver');
|
||||
|
||||
describe('socket.pair', function(){
|
||||
|
||||
it('should support pair-pair', function (done){
|
||||
var pairB = zmq.socket('pair')
|
||||
, pairC = zmq.socket('pair');
|
||||
|
||||
var n = 0;
|
||||
pairB.on('message', function (msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
switch (n++) {
|
||||
case 0:
|
||||
msg.toString().should.equal('foo');
|
||||
break;
|
||||
case 1:
|
||||
msg.toString().should.equal('bar');
|
||||
break;
|
||||
case 2:
|
||||
msg.toString().should.equal('baz');
|
||||
pairB.close();
|
||||
pairC.close();
|
||||
done();
|
||||
break;
|
||||
}
|
||||
});
|
||||
|
||||
pairC.on('message', function (msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('barnacle');
|
||||
})
|
||||
|
||||
var addr = "inproc://stuff";
|
||||
|
||||
pairB.bind(addr, function(){
|
||||
pairC.connect(addr);
|
||||
pairB.send('barnacle');
|
||||
pairC.send('foo');
|
||||
pairC.send('bar');
|
||||
pairC.send('baz');
|
||||
});
|
||||
});
|
||||
|
||||
});
|
||||
+92
@@ -0,0 +1,92 @@
|
||||
var zmq = require('..')
|
||||
, should = require('should')
|
||||
, semver = require('semver');
|
||||
|
||||
describe('socket.pub-sub', function(){
|
||||
var pub, sub;
|
||||
|
||||
beforeEach(function() {
|
||||
pub = zmq.socket('pub');
|
||||
sub = zmq.socket('sub');
|
||||
});
|
||||
|
||||
it('should support pub-sub', function(done){
|
||||
var n = 0;
|
||||
|
||||
sub.subscribe('');
|
||||
sub.on('message', function(msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
switch (n++) {
|
||||
case 0:
|
||||
msg.toString().should.equal('foo');
|
||||
break;
|
||||
case 1:
|
||||
msg.toString().should.equal('bar');
|
||||
break;
|
||||
case 2:
|
||||
msg.toString().should.equal('baz');
|
||||
sub.close();
|
||||
pub.close();
|
||||
done();
|
||||
break;
|
||||
}
|
||||
});
|
||||
|
||||
var addr = "inproc://stuff_ssps";
|
||||
|
||||
sub.bind(addr, function(){
|
||||
pub.connect(addr);
|
||||
|
||||
// The connect is asynchronous, and messages published to a non-
|
||||
// connected socket are silently dropped. That means that there is
|
||||
// a race between connecting and sending the first message which
|
||||
// causes this test to hang, especially when running on Linux. Even an
|
||||
// inproc:// socket seems to be asynchronous. So instead of
|
||||
// sending straight away, we wait 100ms for the connection to be
|
||||
// established before we start the send. This fixes the observed
|
||||
// hang.
|
||||
|
||||
setTimeout(function() {
|
||||
pub.send('foo');
|
||||
pub.send('bar');
|
||||
pub.send('baz');
|
||||
}, 100.0);
|
||||
});
|
||||
});
|
||||
|
||||
it('should support pub-sub filter', function(done){
|
||||
var n = 0;
|
||||
|
||||
sub.subscribe('js');
|
||||
sub.subscribe('luna');
|
||||
|
||||
sub.on('message', function(msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
switch (n++) {
|
||||
case 0:
|
||||
msg.toString().should.equal('js is cool');
|
||||
break;
|
||||
case 1:
|
||||
msg.toString().should.equal('luna is cool too');
|
||||
sub.close();
|
||||
pub.close();
|
||||
done();
|
||||
break;
|
||||
}
|
||||
});
|
||||
|
||||
sub.bind('inproc://stuff_sspsf', function(){
|
||||
pub.connect('inproc://stuff_sspsf');
|
||||
|
||||
// See comments on pub-sub test.
|
||||
|
||||
setTimeout(function() {
|
||||
pub.send('js is cool');
|
||||
pub.send('ruby is meh');
|
||||
pub.send('py is pretty cool');
|
||||
pub.send('luna is cool too');
|
||||
}, 100.0);
|
||||
});
|
||||
});
|
||||
|
||||
});
|
||||
+152
@@ -0,0 +1,152 @@
|
||||
var zmq = require('..')
|
||||
, should = require('should')
|
||||
, semver = require('semver');
|
||||
|
||||
describe('socket.push-pull', function(){
|
||||
|
||||
it('should support push-pull', function(done){
|
||||
var push = zmq.socket('push')
|
||||
, pull = zmq.socket('pull');
|
||||
|
||||
var n = 0;
|
||||
pull.on('message', function(msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
switch (n++) {
|
||||
case 0:
|
||||
msg.toString().should.equal('foo');
|
||||
break;
|
||||
case 1:
|
||||
msg.toString().should.equal('bar');
|
||||
break;
|
||||
case 2:
|
||||
msg.toString().should.equal('baz');
|
||||
pull.close();
|
||||
push.close();
|
||||
done();
|
||||
break;
|
||||
}
|
||||
});
|
||||
|
||||
var addr = "inproc://stuff";
|
||||
|
||||
pull.bind(addr, function(){
|
||||
push.connect(addr);
|
||||
|
||||
push.send('foo');
|
||||
push.send('bar');
|
||||
push.send('baz');
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
it('should not emit messages after pause()', function(done){
|
||||
var push = zmq.socket('push')
|
||||
, pull = zmq.socket('pull');
|
||||
|
||||
var n = 0;
|
||||
|
||||
pull.on('message', function(msg){
|
||||
if(n++ === 0) {
|
||||
msg.toString().should.equal('foo');
|
||||
}
|
||||
else{
|
||||
should.not.exist(msg);
|
||||
}
|
||||
});
|
||||
|
||||
var addr = "inproc://pause_stuff";
|
||||
|
||||
pull.bind(addr, function(){
|
||||
push.connect(addr);
|
||||
|
||||
push.send('foo');
|
||||
pull.pause()
|
||||
push.send('bar');
|
||||
push.send('baz');
|
||||
});
|
||||
|
||||
setTimeout(function (){
|
||||
pull.close();
|
||||
push.close();
|
||||
done();
|
||||
}, 100);
|
||||
});
|
||||
|
||||
it('should be able to read messages after pause()', function(done){
|
||||
var push = zmq.socket('push')
|
||||
, pull = zmq.socket('pull');
|
||||
|
||||
var addr = "inproc://pause_stuff";
|
||||
|
||||
var messages = ['bar', 'foo'];
|
||||
pull.bind(addr, function(){
|
||||
push.connect(addr);
|
||||
|
||||
pull.pause()
|
||||
messages.forEach(function(message){
|
||||
push.send(message);
|
||||
});
|
||||
|
||||
messages.forEach(function(message){
|
||||
pull.read().toString().should.eql(message);
|
||||
});
|
||||
});
|
||||
|
||||
setTimeout(function (){
|
||||
pull.close();
|
||||
push.close();
|
||||
done();
|
||||
}, 100);
|
||||
});
|
||||
|
||||
|
||||
it('should emit messages after resume()', function(done){
|
||||
var push = zmq.socket('push')
|
||||
, pull = zmq.socket('pull');
|
||||
|
||||
var n = 0;
|
||||
|
||||
function checkNoMessages(msg){
|
||||
should.not.exist(msg);
|
||||
}
|
||||
|
||||
function checkMessages(msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
switch (n++) {
|
||||
case 0:
|
||||
msg.toString().should.equal('foo');
|
||||
break;
|
||||
case 1:
|
||||
msg.toString().should.equal('bar');
|
||||
break;
|
||||
case 2:
|
||||
msg.toString().should.equal('baz');
|
||||
pull.close();
|
||||
push.close();
|
||||
done();
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
pull.on('message', checkNoMessages)
|
||||
|
||||
var addr = "inproc://resume_stuff";
|
||||
|
||||
pull.bind(addr, function(){
|
||||
push.connect(addr);
|
||||
pull.pause()
|
||||
|
||||
push.send('foo');
|
||||
push.send('bar');
|
||||
push.send('baz');
|
||||
|
||||
setTimeout(function (){
|
||||
pull.removeListener('message', checkNoMessages)
|
||||
pull.on('message', checkMessages)
|
||||
pull.resume()
|
||||
}, 100)
|
||||
|
||||
});
|
||||
|
||||
});
|
||||
});
|
||||
+58
@@ -0,0 +1,58 @@
|
||||
var zmq = require('..')
|
||||
, should = require('should')
|
||||
, semver = require('semver');
|
||||
|
||||
describe('socket.req-rep', function(){
|
||||
it('should support req-rep', function(done){
|
||||
var rep = zmq.socket('rep')
|
||||
, req = zmq.socket('req');
|
||||
|
||||
rep.on('message', function(msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('hello');
|
||||
rep.send('world');
|
||||
});
|
||||
|
||||
rep.bind('inproc://stuff', function(){
|
||||
req.connect('inproc://stuff');
|
||||
req.send('hello');
|
||||
req.on('message', function(msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('world');
|
||||
rep.close();
|
||||
req.close();
|
||||
done();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
it('should support multiple', function(done){
|
||||
var n = 5;
|
||||
|
||||
for (var i = 0; i < n; i++) {
|
||||
(function(n){
|
||||
var rep = zmq.socket('rep')
|
||||
, req = zmq.socket('req');
|
||||
|
||||
rep.on('message', function(msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('hello');
|
||||
rep.send('world');
|
||||
});
|
||||
|
||||
rep.bind('inproc://' + n, function(){
|
||||
req.connect('inproc://' + n);
|
||||
req.send('hello');
|
||||
req.on('message', function(msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('world');
|
||||
req.close();
|
||||
rep.close();
|
||||
if (!--n) done();
|
||||
});
|
||||
});
|
||||
})(i);
|
||||
}
|
||||
});
|
||||
|
||||
});
|
||||
+73
@@ -0,0 +1,73 @@
|
||||
var zmq = require('..')
|
||||
, should = require('should')
|
||||
, semver = require('semver');
|
||||
|
||||
describe('socket.router', function(){
|
||||
it('should handle the unroutable', function(done){
|
||||
var complete = 0;
|
||||
|
||||
if (!semver.gte(zmq.version, '3.2.0')) {
|
||||
done();
|
||||
return console.warn('Test requires libzmq >= 3.2.0');
|
||||
}
|
||||
|
||||
if (semver.eq(zmq.version, '3.2.1')) {
|
||||
done();
|
||||
return console.warn('ZMQ_ROUTER_MANDATORY is broken in libzmq = 3.2.1');
|
||||
}
|
||||
|
||||
var envelope = '12384982398293';
|
||||
var errMsg = 'No route to host';
|
||||
if (require('os').platform() == 'win32') errMsg = 'Unknown error';
|
||||
|
||||
// should emit an error event on unroutable msgs if mandatory = 1 and error handler is set
|
||||
|
||||
(function(){
|
||||
var sock = zmq.socket('router');
|
||||
sock.on('error', function(err){
|
||||
err.message.should.equal(errMsg);
|
||||
sock.close();
|
||||
if (++complete === 2) done();
|
||||
});
|
||||
|
||||
sock.setsockopt(zmq.ZMQ_ROUTER_MANDATORY, 1);
|
||||
|
||||
sock.send([envelope, '']);
|
||||
})();
|
||||
|
||||
// should throw an error on unroutable msgs if mandatory = 1 and no error handler is set
|
||||
|
||||
(function(){
|
||||
var sock = zmq.socket('router');
|
||||
|
||||
sock.setsockopt(zmq.ZMQ_ROUTER_MANDATORY, 1);
|
||||
|
||||
(function(){
|
||||
sock.send([envelope, '']);
|
||||
}).should.throw(errMsg);
|
||||
|
||||
(function(){
|
||||
sock.send([envelope, '']);
|
||||
}).should.throw(errMsg);
|
||||
|
||||
(function(){
|
||||
sock.send([envelope, '']);
|
||||
}).should.throw(errMsg);
|
||||
|
||||
sock.close();
|
||||
})();
|
||||
|
||||
// should silently ignore unroutable msgs if mandatory = 0
|
||||
|
||||
(function(){
|
||||
var sock = zmq.socket('router');
|
||||
|
||||
(function(){
|
||||
sock.send([envelope, '']);
|
||||
sock.close();
|
||||
}).should.not.throw(errMsg);
|
||||
})();
|
||||
if (++complete === 2) done();
|
||||
});
|
||||
|
||||
});
|
||||
+73
@@ -0,0 +1,73 @@
|
||||
var zmq = require('..')
|
||||
, http = require('http')
|
||||
, should = require('should')
|
||||
, semver = require('semver');
|
||||
|
||||
describe('socket.stream', function(){
|
||||
|
||||
it('should support a streaming socket', function (done){
|
||||
|
||||
//socket stream type API after libzmq4+, target > 4.0.0
|
||||
if (semver.gte(zmq.version, '4.0.0')) {
|
||||
|
||||
var stream = zmq.socket('stream');
|
||||
stream.on('message', function (id,msg){
|
||||
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
|
||||
var raw_header = String(msg).split('\r\n');
|
||||
var method = raw_header[0].split(' ')[0];
|
||||
method.should.equal('GET');
|
||||
|
||||
//finding an HTTP GET method, prepare HTTP response for TCP socket
|
||||
var httpProtocolString = 'HTTP/1.0 200 OK\r\n' //status code
|
||||
+ 'Content-Type: text/html\r\n' //headers
|
||||
+ '\r\n'
|
||||
+ '<!DOCTYPE html>' //response body
|
||||
+ '<head>' //make it xml, json, html or something else
|
||||
+ '<meta charset="UTF-8">'
|
||||
+ '</head>'
|
||||
+ '<body>'
|
||||
+'<p>derpin over protocols</p>'
|
||||
+ '</body>'
|
||||
+'</html>'
|
||||
|
||||
//zmq streaming prefixed by envelope's routing identifier
|
||||
stream.send([id,httpProtocolString]);
|
||||
});
|
||||
|
||||
var addr = '127.0.0.1:5513';
|
||||
stream.bind('tcp://'+addr, function(){
|
||||
//send non-peer request to zmq, like an http GET method with URI path
|
||||
http.get('http://'+addr+'/aRandomRequestPath', function (httpMsg){
|
||||
|
||||
//msg should now be a node readable stream as the good lord intended
|
||||
if (semver.gte(process.versions.node, '0.11.0')){
|
||||
httpMsg.socket._readableState.reading.should.be.false
|
||||
} else {
|
||||
if(semver.gte(process.versions.node, '0.10.0')){
|
||||
httpMsg.socket._readableState.reading.should.be.true
|
||||
}
|
||||
}
|
||||
|
||||
//conventional node streams emit data events to process zmq stream response
|
||||
httpMsg.on('data',function (msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
String(msg).should.equal('<!DOCTYPE html><head><meta charset="UTF-8"></head>'
|
||||
+'<body>'
|
||||
+'<p>derpin over protocols</p>'
|
||||
+'</body>'
|
||||
+'</html>');
|
||||
done();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
} else {
|
||||
|
||||
done();
|
||||
return console.warn('stream socket type in libzmq v4+');
|
||||
|
||||
}
|
||||
});
|
||||
});
|
||||
+53
@@ -0,0 +1,53 @@
|
||||
var zmq = require('..')
|
||||
, should = require('should')
|
||||
, semver = require('semver');
|
||||
|
||||
describe('socket.unbind', function(){
|
||||
|
||||
it('should be able to unbind', function(done){
|
||||
if (!zmq.ZMQ_CAN_UNBIND) {
|
||||
done();
|
||||
return;
|
||||
}
|
||||
var a = zmq.socket('dealer')
|
||||
, b = zmq.socket('dealer')
|
||||
, c = zmq.socket('dealer');
|
||||
|
||||
var message_count = 0;
|
||||
a.bind('tcp://127.0.0.1:5420', function (err) {
|
||||
if (err) throw err;
|
||||
a.bind('tcp://127.0.0.1:5421', function (err) {
|
||||
if (err) throw err;
|
||||
b.connect('tcp://127.0.0.1:5420');
|
||||
b.send('Hello from b.');
|
||||
c.connect('tcp://127.0.0.1:5421');
|
||||
c.send('Hello from c.');
|
||||
});
|
||||
});
|
||||
|
||||
a.on('unbind', function(addr) {
|
||||
if (addr === 'tcp://127.0.0.1:5420') {
|
||||
b.send('Error from b.');
|
||||
c.send('Messsage from c.');
|
||||
setTimeout(function () {
|
||||
c.send('Final message from c.');
|
||||
}, 100);
|
||||
}
|
||||
});
|
||||
|
||||
a.on('message', function(msg) {
|
||||
message_count++;
|
||||
if (msg.toString() === 'Hello from b.') {
|
||||
a.unbind('tcp://127.0.0.1:5420');
|
||||
} else if (msg.toString() === 'Final message from c.') {
|
||||
message_count.should.equal(4);
|
||||
a.close();
|
||||
b.close();
|
||||
c.close();
|
||||
done();
|
||||
} else if (msg.toString() === 'Error from b.') {
|
||||
throw Error('b should have been unbound');
|
||||
}
|
||||
});
|
||||
});
|
||||
});
|
||||
+88
@@ -0,0 +1,88 @@
|
||||
var zmq = require('..')
|
||||
, should = require('should')
|
||||
, semver = require('semver');
|
||||
|
||||
describe('socket.xpub-xsub', function () {
|
||||
it('should support pub-sub tracing and filtering', function (done) {
|
||||
if (!semver.gte(zmq.version, '3.1.0')) {
|
||||
done();
|
||||
return console.warn('Test requires libzmq >= 3.1.0');
|
||||
}
|
||||
|
||||
var n = 0;
|
||||
var m = 0;
|
||||
var pub = zmq.socket('pub');
|
||||
var sub = zmq.socket('sub');
|
||||
var xpub = zmq.socket('xpub');
|
||||
var xsub = zmq.socket('xsub');
|
||||
|
||||
pub.bindSync('tcp://*:5556');
|
||||
xsub.connect('tcp://127.0.0.1:5556');
|
||||
xpub.bindSync('tcp://*:5555');
|
||||
sub.connect('tcp://127.0.0.1:5555');
|
||||
|
||||
xsub.on('message', function (msg) {
|
||||
xpub.send(msg); // Forward message using the xpub so subscribers can receive it
|
||||
});
|
||||
|
||||
xpub.on('message', function (msg) {
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
|
||||
var type = msg[0] === 0 ? 'unsubscribe' : 'subscribe';
|
||||
var channel = msg.slice(1).toString();
|
||||
|
||||
switch (type) {
|
||||
case 'subscribe':
|
||||
switch (m++) {
|
||||
case 0:
|
||||
channel.should.equal('js');
|
||||
break;
|
||||
case 1:
|
||||
channel.should.equal('luna');
|
||||
break;
|
||||
}
|
||||
break;
|
||||
case 'unsubscribe':
|
||||
switch (m++) {
|
||||
case 2:
|
||||
channel.should.equal('luna');
|
||||
sub.close();
|
||||
pub.close();
|
||||
xsub.close();
|
||||
xpub.close();
|
||||
done();
|
||||
break;
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
xsub.send(msg); // Forward message using the xsub so the publisher knows it has a subscriber
|
||||
});
|
||||
|
||||
sub.on('message', function (msg) {
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
switch (n++) {
|
||||
case 0:
|
||||
msg.toString().should.equal('js is cool');
|
||||
break;
|
||||
case 1:
|
||||
msg.toString().should.equal('luna is cool too');
|
||||
break;
|
||||
}
|
||||
});
|
||||
|
||||
sub.subscribe('js');
|
||||
sub.subscribe('luna');
|
||||
|
||||
setTimeout(function () {
|
||||
pub.send('js is cool');
|
||||
pub.send('ruby is meh');
|
||||
pub.send('py is pretty cool');
|
||||
pub.send('luna is cool too');
|
||||
}, 100.0);
|
||||
|
||||
setTimeout(function () {
|
||||
sub.unsubscribe('luna');
|
||||
}, 300);
|
||||
});
|
||||
});
|
||||
+132
@@ -0,0 +1,132 @@
|
||||
var zmq = require('..')
|
||||
, should = require('should')
|
||||
, semver = require('semver');
|
||||
|
||||
describe('socket.zap', function(){
|
||||
|
||||
var zap = require('./zap')
|
||||
, zapSocket, rep, req, count = 0;
|
||||
|
||||
beforeEach(function(){
|
||||
count++;
|
||||
zapSocket = zap.start(count);
|
||||
rep = zmq.socket('rep');
|
||||
req = zmq.socket('req');
|
||||
});
|
||||
|
||||
afterEach(function(){
|
||||
req.close();
|
||||
rep.close();
|
||||
zapSocket.close();
|
||||
});
|
||||
|
||||
it('should support curve', function(done){
|
||||
var port = 'tcp://127.0.0.1:12347';
|
||||
if (!semver.gte(zmq.version, '4.0.0')) {
|
||||
done();
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
rep.curve_server = 0;
|
||||
} catch(e) {
|
||||
console.log("libsodium seems to be missing; skipping curve test");
|
||||
done();
|
||||
return;
|
||||
}
|
||||
|
||||
var serverPublicKey = new Buffer('7f188e5244b02bf497b86de417515cf4d4053ce4eb977aee91a55354655ec33a', 'hex')
|
||||
, serverPrivateKey = new Buffer('1f5d3873472f95e11f4723d858aaf0919ab1fb402cb3097742c606e61dd0d7d8', 'hex')
|
||||
, clientPublicKey = new Buffer('ea1cc8bd7c8af65497d43fc21dbec6560c5e7b61bcfdcbd2b0dfacf0b4c38d45', 'hex')
|
||||
, clientPrivateKey = new Buffer('83f99afacfab052406e5f421612568034e85f4c8182a1c92671e83dca669d31d', 'hex');
|
||||
|
||||
rep.on('message', function(msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('hello');
|
||||
rep.send('world');
|
||||
});
|
||||
|
||||
rep.zap_domain = "test";
|
||||
rep.curve_server = 1;
|
||||
rep.curve_secretkey = serverPrivateKey;
|
||||
rep.mechanism.should.eql(2);
|
||||
|
||||
rep.bind(port, function(){
|
||||
req.curve_serverkey = serverPublicKey;
|
||||
req.curve_publickey = clientPublicKey;
|
||||
req.curve_secretkey = clientPrivateKey;
|
||||
req.mechanism.should.eql(2);
|
||||
|
||||
req.connect(port);
|
||||
req.send('hello');
|
||||
req.on('message', function(msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('world');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
});
|
||||
|
||||
it('should supoort null', function(done){
|
||||
var port = 'tcp://127.0.0.1:12345';
|
||||
if (!semver.gte(zmq.version, '4.0.0')) {
|
||||
done();
|
||||
return;
|
||||
}
|
||||
|
||||
rep.on('message', function(msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('hello');
|
||||
rep.send('world');
|
||||
});
|
||||
|
||||
rep.zap_domain = "test";
|
||||
rep.mechanism.should.eql(0);
|
||||
|
||||
rep.bind(port, function(){
|
||||
req.mechanism.should.eql(0);
|
||||
req.connect(port);
|
||||
req.send('hello');
|
||||
req.on('message', function(msg){
|
||||
console.log('here')
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('world');
|
||||
done();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
it('should supoort plain', function(done){
|
||||
var port = 'tcp://127.0.0.1:12346';
|
||||
if (!semver.gte(zmq.version, '4.0.0')) {
|
||||
done();
|
||||
return;
|
||||
}
|
||||
|
||||
rep.on('message', function(msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('hello');
|
||||
rep.send('world');
|
||||
});
|
||||
|
||||
rep.zap_domain = "test";
|
||||
rep.plain_server = 1;
|
||||
rep.mechanism.should.eql(1);
|
||||
|
||||
rep.bind(port, function(){
|
||||
req.plain_username = "user";
|
||||
req.plain_password = "pass";
|
||||
req.mechanism.should.eql(1);
|
||||
|
||||
req.connect(port);
|
||||
req.send('hello');
|
||||
req.on('message', function(msg){
|
||||
console.log('here')
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('world');
|
||||
done();
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
+46
@@ -0,0 +1,46 @@
|
||||
// This is mainly for testing that the security mechanisms themselves are working
|
||||
// not the ZAP protocol itself. As long as the request is valid, this will
|
||||
// authenticate it.
|
||||
|
||||
var zmq = require('../');
|
||||
|
||||
module.exports.start = function(count) {
|
||||
var zap = zmq.socket('router');
|
||||
zap.on('message', function() {
|
||||
var data = Array.prototype.slice.call(arguments);
|
||||
|
||||
if (!data || !data.length) throw new Error("Invalid ZAP request");
|
||||
|
||||
var returnPath = [],
|
||||
frame = data.shift();
|
||||
while (frame && (frame.length != 0)) {
|
||||
returnPath.push(frame);
|
||||
frame = data.shift();
|
||||
}
|
||||
returnPath.push(frame);
|
||||
|
||||
if (data.length < 6) throw new Error("Invalid ZAP request");
|
||||
|
||||
var zapReq = {
|
||||
version: data.shift(),
|
||||
requestId: data.shift(),
|
||||
domain: new Buffer(data.shift()).toString('utf8'),
|
||||
address: new Buffer(data.shift()).toString('utf8'),
|
||||
identity: new Buffer(data.shift()).toString('utf8'),
|
||||
mechanism: new Buffer(data.shift()).toString('utf8'),
|
||||
credentials: data.slice(0)
|
||||
};
|
||||
|
||||
zap.send(returnPath.concat([
|
||||
zapReq.version,
|
||||
zapReq.requestId,
|
||||
new Buffer("200", "utf8"),
|
||||
new Buffer("OK", "utf8"),
|
||||
new Buffer(0),
|
||||
new Buffer(0)
|
||||
]));
|
||||
});
|
||||
|
||||
zap.bindSync("inproc://zeromq.zap.01."+count);
|
||||
return zap;
|
||||
}
|
||||
+10
@@ -0,0 +1,10 @@
|
||||
|
||||
var zmq = require('..')
|
||||
, should = require('should');
|
||||
|
||||
describe('proxy', function() {
|
||||
it('should be a function off the module namespace', function (done) {
|
||||
zmq.proxy.should.be.a.Function;
|
||||
done();
|
||||
});
|
||||
});
|
||||
+95
@@ -0,0 +1,95 @@
|
||||
var zmq = require('..')
|
||||
, should = require('should')
|
||||
, semver = require('semver');
|
||||
|
||||
var addr = 'tcp://127.0.0.1'
|
||||
, frontendAddr = addr+':5501'
|
||||
, backendAddr = addr+':5502'
|
||||
, captureAddr = addr+':5503';
|
||||
|
||||
describe('proxy.push-pull', function() {
|
||||
|
||||
it('should proxy push-pull connected to pull-push',function (done) {
|
||||
|
||||
var frontend = zmq.socket('pull');
|
||||
var backend = zmq.socket('push');
|
||||
|
||||
var pull = zmq.socket('pull');
|
||||
var push = zmq.socket('push');
|
||||
|
||||
frontend.bindSync(frontendAddr);
|
||||
backend.bindSync(backendAddr);
|
||||
|
||||
push.connect(frontendAddr);
|
||||
pull.connect(backendAddr);
|
||||
|
||||
pull.on('message',function (msg) {
|
||||
|
||||
frontend.close();
|
||||
backend.close();
|
||||
push.close();
|
||||
pull.close();
|
||||
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('foo');
|
||||
done();
|
||||
});
|
||||
|
||||
setTimeout(function() {
|
||||
push.send('foo');
|
||||
}, 100.0);
|
||||
|
||||
zmq.proxy(frontend,backend);
|
||||
|
||||
});
|
||||
|
||||
it('should proxy pull-push connected to push-pull with capture',function (done) {
|
||||
|
||||
var frontend = zmq.socket('push');
|
||||
var backend = zmq.socket('pull');
|
||||
|
||||
var capture = zmq.socket('pub');
|
||||
var capSub = zmq.socket('sub');
|
||||
|
||||
var pull = zmq.socket('pull');
|
||||
var push = zmq.socket('push');
|
||||
|
||||
frontend.bindSync(frontendAddr);
|
||||
backend.bindSync(backendAddr);
|
||||
capture.bindSync(captureAddr);
|
||||
|
||||
pull.connect(frontendAddr);
|
||||
push.connect(backendAddr);
|
||||
capSub.connect(captureAddr);
|
||||
|
||||
pull.on('message',function (msg) {
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('foo');
|
||||
console.log(msg.toString());
|
||||
});
|
||||
|
||||
capSub.subscribe('');
|
||||
capSub.on('message',function (msg) {
|
||||
capture.close();
|
||||
capSub.close();
|
||||
|
||||
setTimeout(function() {
|
||||
frontend.close();
|
||||
backend.close();
|
||||
push.close();
|
||||
pull.close();
|
||||
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('foo');
|
||||
done();
|
||||
},100.0);
|
||||
});
|
||||
|
||||
setTimeout(function() {
|
||||
push.send('foo');
|
||||
}, 100.0);
|
||||
|
||||
zmq.proxy(frontend,backend,capture);
|
||||
|
||||
});
|
||||
});
|
||||
+97
@@ -0,0 +1,97 @@
|
||||
var zmq = require('..')
|
||||
, should = require('should')
|
||||
, semver = require('semver');
|
||||
|
||||
var addr = 'tcp://127.0.0.1'
|
||||
, frontendAddr = addr+':5504'
|
||||
, backendAddr = addr+':5505'
|
||||
, captureAddr = addr+':5506';
|
||||
|
||||
describe('proxy.router-dealer', function() {
|
||||
|
||||
it('should proxy req-rep connected over router-dealer', function (done){
|
||||
|
||||
var frontend = zmq.socket('router');
|
||||
var backend = zmq.socket('dealer');
|
||||
|
||||
var rep = zmq.socket('rep');
|
||||
var req = zmq.socket('req');
|
||||
|
||||
frontend.bindSync(frontendAddr);
|
||||
backend.bindSync(backendAddr);
|
||||
|
||||
req.connect(frontendAddr);
|
||||
rep.connect(backendAddr);
|
||||
|
||||
req.on('message',function(msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('foo bar');
|
||||
frontend.close();
|
||||
backend.close();
|
||||
req.close();
|
||||
rep.close();
|
||||
done();
|
||||
});
|
||||
|
||||
rep.on('message', function (msg) {
|
||||
rep.send(msg+' bar');
|
||||
});
|
||||
|
||||
setTimeout(function() {
|
||||
req.send('foo');
|
||||
}, 100.0);
|
||||
|
||||
zmq.proxy(frontend,backend);
|
||||
|
||||
});
|
||||
|
||||
it('should proxy rep-req connections with capture', function (done){
|
||||
|
||||
var frontend = zmq.socket('router');
|
||||
var backend = zmq.socket('dealer');
|
||||
|
||||
var rep = zmq.socket('rep');
|
||||
var req = zmq.socket('req');
|
||||
|
||||
var capture = zmq.socket('pub');
|
||||
var capSub = zmq.socket('sub');
|
||||
|
||||
frontend.bindSync(frontendAddr);
|
||||
backend.bindSync(backendAddr);
|
||||
capture.bindSync(captureAddr);
|
||||
|
||||
req.connect(frontendAddr);
|
||||
rep.connect(backendAddr);
|
||||
capSub.connect(captureAddr);
|
||||
capSub.subscribe('');
|
||||
|
||||
req.on('message',function (msg) {
|
||||
req.close();
|
||||
rep.close();
|
||||
console.log(msg.toString());
|
||||
});
|
||||
|
||||
rep.on('message', function (msg) {
|
||||
rep.send(msg+' bar');
|
||||
});
|
||||
|
||||
capSub.on('message',function (msg) {
|
||||
backend.close();
|
||||
frontend.close();
|
||||
capture.close();
|
||||
capSub.close();
|
||||
setTimeout(function() {
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('foo bar');
|
||||
done();
|
||||
},100.0)
|
||||
});
|
||||
|
||||
setTimeout(function() {
|
||||
req.send('foo');
|
||||
},200.0)
|
||||
|
||||
zmq.proxy(frontend,backend,capture);
|
||||
|
||||
});
|
||||
});
|
||||
+155
@@ -0,0 +1,155 @@
|
||||
var zmq = require('..')
|
||||
, should = require('should')
|
||||
, semver = require('semver');
|
||||
|
||||
var addr = 'tcp://127.0.0.1'
|
||||
, frontendAddr = addr+':5507'
|
||||
, backendAddr = addr+':5508'
|
||||
, captureAddr = addr+':5509';
|
||||
|
||||
var version = semver.gte(zmq.version, '3.1.0');
|
||||
|
||||
describe('proxy.xpub-xsub', function() {
|
||||
|
||||
it('should proxy pub-sub connected to xpub-xsub', function (done) {
|
||||
if (!version) {
|
||||
done();
|
||||
return console.warn('Test requires libzmq >= 3.1.0');
|
||||
}
|
||||
|
||||
var frontend = zmq.socket('xpub');
|
||||
var backend = zmq.socket('xsub');
|
||||
|
||||
var sub = zmq.socket('sub');
|
||||
var pub = zmq.socket('pub');
|
||||
|
||||
sub.subscribe('');
|
||||
sub.on('message',function (msg) {
|
||||
|
||||
frontend.close();
|
||||
backend.close();
|
||||
sub.close();
|
||||
pub.close();
|
||||
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('foo');
|
||||
|
||||
done();
|
||||
});
|
||||
|
||||
frontend.bind(frontendAddr,function() {
|
||||
backend.bind(backendAddr,function() {
|
||||
|
||||
sub.connect(frontendAddr);
|
||||
pub.connect(backendAddr);
|
||||
|
||||
setTimeout(function() {
|
||||
pub.send('foo');
|
||||
}, 200.0);
|
||||
|
||||
zmq.proxy(frontend,backend);
|
||||
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
it('should proxy connections with capture', function (done) {
|
||||
if (!version) {
|
||||
done();
|
||||
return console.warn('Test requires libzmq >= 3.1.0');
|
||||
}
|
||||
|
||||
var frontend = zmq.socket('xpub');
|
||||
var backend = zmq.socket('xsub');
|
||||
|
||||
var capture = zmq.socket('pub');
|
||||
var capSub = zmq.socket('sub');
|
||||
|
||||
var sub = zmq.socket('sub');
|
||||
var pub = zmq.socket('pub');
|
||||
|
||||
sub.subscribe('');
|
||||
sub.on('message', function (msg) {
|
||||
|
||||
sub.close();
|
||||
pub.close();
|
||||
backend.close();
|
||||
frontend.close();
|
||||
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('foo');
|
||||
|
||||
console.log(msg.toString());
|
||||
|
||||
});
|
||||
|
||||
capSub.subscribe('');
|
||||
capSub.on('message',function (msg) {
|
||||
|
||||
capture.close();
|
||||
capSub.close();
|
||||
|
||||
setTimeout(function(){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('foo');
|
||||
done();
|
||||
},100.0);
|
||||
});
|
||||
|
||||
capture.bind(captureAddr,function() {
|
||||
frontend.bind(frontendAddr,function() {
|
||||
backend.bind(backendAddr,function() {
|
||||
|
||||
pub.connect(backendAddr);
|
||||
sub.connect(frontendAddr);
|
||||
capSub.connect(captureAddr);
|
||||
|
||||
setTimeout(function () {
|
||||
pub.send('foo');
|
||||
}, 200.0);
|
||||
|
||||
zmq.proxy(frontend,backend,capture);
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
it('should throw an error if the order is wrong', function (done) {
|
||||
if (!version) {
|
||||
done();
|
||||
return console.warn('Test requires libzmq >= 3.1.0');
|
||||
}
|
||||
|
||||
var frontend = zmq.socket('xpub');
|
||||
var backend = zmq.socket('xsub');
|
||||
|
||||
var sub = zmq.socket('sub');
|
||||
var pub = zmq.socket('pub');
|
||||
|
||||
frontend.bindSync(frontendAddr);
|
||||
backend.bindSync(backendAddr);
|
||||
|
||||
sub.connect(frontendAddr);
|
||||
pub.connect(backendAddr);
|
||||
|
||||
try{
|
||||
|
||||
zmq.proxy(backend,frontend);
|
||||
|
||||
} catch(e){
|
||||
|
||||
e.message.should.equal('wrong socket order to proxy');
|
||||
|
||||
} finally{
|
||||
frontend.close();
|
||||
backend.close();
|
||||
pub.close();
|
||||
sub.close();
|
||||
|
||||
//allow time for TCP sockets to close
|
||||
setTimeout(function(){
|
||||
done();
|
||||
},200)
|
||||
}
|
||||
})
|
||||
});
|
||||
+52
@@ -0,0 +1,52 @@
|
||||
var zmq = require('..')
|
||||
, should = require('should')
|
||||
, semver = require('semver');
|
||||
|
||||
var addr = 'tcp://127.0.0.1'
|
||||
, frontendAddr = addr+':5510'
|
||||
, backendAddr = addr+':5511'
|
||||
, captureAddr = addr+':5512';
|
||||
|
||||
//since its for libzmq2, we target versions < 3.0.0
|
||||
var version = semver.lte(zmq.version, '3.0.0');
|
||||
|
||||
describe('proxy.xrep-xreq', function() {
|
||||
it('should proxy req-rep connected to xrep-xreq', function (done) {
|
||||
if (!version) {
|
||||
done();
|
||||
return console.warn('Test requires libzmq v2');
|
||||
}
|
||||
|
||||
var frontend = zmq.socket('xrep');
|
||||
var backend = zmq.socket('xreq');
|
||||
|
||||
var req = zmq.socket('req');
|
||||
var rep = zmq.socket('rep');
|
||||
|
||||
frontend.bindSync(frontendAddr);
|
||||
backend.bindSync(backendAddr);
|
||||
|
||||
req.connect(frontendAddr);
|
||||
rep.connect(backendAddr);
|
||||
|
||||
req.on('message',function(msg){
|
||||
msg.should.be.an.instanceof(Buffer);
|
||||
msg.toString().should.equal('foo bar');
|
||||
frontend.close();
|
||||
backend.close();
|
||||
req.close();
|
||||
rep.close();
|
||||
done();
|
||||
});
|
||||
|
||||
rep.on('message', function (msg) {
|
||||
rep.send(msg+' bar');
|
||||
});
|
||||
|
||||
setTimeout(function() {
|
||||
req.send('foo');
|
||||
}, 100.0);
|
||||
|
||||
zmq.proxy(frontend,backend);
|
||||
});
|
||||
});
|
||||
+416
@@ -0,0 +1,416 @@
|
||||
/*
|
||||
Copyright (c) 2007-2013 Contributors as noted in the AUTHORS file
|
||||
|
||||
This file is part of 0MQ.
|
||||
|
||||
0MQ is free software; you can redistribute it and/or modify it under
|
||||
the terms of the GNU Lesser General Public License as published by
|
||||
the Free Software Foundation; either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
0MQ is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
*************************************************************************
|
||||
NOTE to contributors. This file comprises the principal public contract
|
||||
for ZeroMQ API users (along with zmq_utils.h). Any change to this file
|
||||
supplied in a stable release SHOULD not break existing applications.
|
||||
In practice this means that the value of constants must not change, and
|
||||
that old values may not be reused for new constants.
|
||||
*************************************************************************
|
||||
*/
|
||||
|
||||
#ifndef __ZMQ_H_INCLUDED__
|
||||
#define __ZMQ_H_INCLUDED__
|
||||
|
||||
/* Version macros for compile-time API version detection */
|
||||
#define ZMQ_VERSION_MAJOR 4
|
||||
#define ZMQ_VERSION_MINOR 0
|
||||
#define ZMQ_VERSION_PATCH 4
|
||||
|
||||
#define ZMQ_MAKE_VERSION(major, minor, patch) \
|
||||
((major) * 10000 + (minor) * 100 + (patch))
|
||||
#define ZMQ_VERSION \
|
||||
ZMQ_MAKE_VERSION(ZMQ_VERSION_MAJOR, ZMQ_VERSION_MINOR, ZMQ_VERSION_PATCH)
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#if !defined _WIN32_WCE
|
||||
#include <errno.h>
|
||||
#endif
|
||||
#include <stddef.h>
|
||||
#include <stdio.h>
|
||||
#if defined _WIN32
|
||||
#include <winsock2.h>
|
||||
#endif
|
||||
|
||||
/* Handle DSO symbol visibility */
|
||||
#if defined _WIN32
|
||||
# if defined ZMQ_STATIC
|
||||
# define ZMQ_EXPORT
|
||||
# elif defined DLL_EXPORT
|
||||
# define ZMQ_EXPORT __declspec(dllexport)
|
||||
# else
|
||||
# define ZMQ_EXPORT __declspec(dllimport)
|
||||
# endif
|
||||
#else
|
||||
# if defined __SUNPRO_C || defined __SUNPRO_CC
|
||||
# define ZMQ_EXPORT __global
|
||||
# elif (defined __GNUC__ && __GNUC__ >= 4) || defined __INTEL_COMPILER
|
||||
# define ZMQ_EXPORT __attribute__ ((visibility("default")))
|
||||
# else
|
||||
# define ZMQ_EXPORT
|
||||
# endif
|
||||
#endif
|
||||
|
||||
/* Define integer types needed for event interface */
|
||||
#if defined ZMQ_HAVE_SOLARIS || defined ZMQ_HAVE_OPENVMS
|
||||
# include <inttypes.h>
|
||||
#elif defined _MSC_VER && _MSC_VER < 1600
|
||||
# ifndef int32_t
|
||||
typedef __int32 int32_t;
|
||||
# endif
|
||||
# ifndef uint16_t
|
||||
typedef unsigned __int16 uint16_t;
|
||||
# endif
|
||||
# ifndef uint8_t
|
||||
typedef unsigned __int8 uint8_t;
|
||||
# endif
|
||||
#else
|
||||
# include <stdint.h>
|
||||
#endif
|
||||
|
||||
|
||||
/******************************************************************************/
|
||||
/* 0MQ errors. */
|
||||
/******************************************************************************/
|
||||
|
||||
/* A number random enough not to collide with different errno ranges on */
|
||||
/* different OSes. The assumption is that error_t is at least 32-bit type. */
|
||||
#define ZMQ_HAUSNUMERO 156384712
|
||||
|
||||
/* On Windows platform some of the standard POSIX errnos are not defined. */
|
||||
#ifndef ENOTSUP
|
||||
#define ENOTSUP (ZMQ_HAUSNUMERO + 1)
|
||||
#endif
|
||||
#ifndef EPROTONOSUPPORT
|
||||
#define EPROTONOSUPPORT (ZMQ_HAUSNUMERO + 2)
|
||||
#endif
|
||||
#ifndef ENOBUFS
|
||||
#define ENOBUFS (ZMQ_HAUSNUMERO + 3)
|
||||
#endif
|
||||
#ifndef ENETDOWN
|
||||
#define ENETDOWN (ZMQ_HAUSNUMERO + 4)
|
||||
#endif
|
||||
#ifndef EADDRINUSE
|
||||
#define EADDRINUSE (ZMQ_HAUSNUMERO + 5)
|
||||
#endif
|
||||
#ifndef EADDRNOTAVAIL
|
||||
#define EADDRNOTAVAIL (ZMQ_HAUSNUMERO + 6)
|
||||
#endif
|
||||
#ifndef ECONNREFUSED
|
||||
#define ECONNREFUSED (ZMQ_HAUSNUMERO + 7)
|
||||
#endif
|
||||
#ifndef EINPROGRESS
|
||||
#define EINPROGRESS (ZMQ_HAUSNUMERO + 8)
|
||||
#endif
|
||||
#ifndef ENOTSOCK
|
||||
#define ENOTSOCK (ZMQ_HAUSNUMERO + 9)
|
||||
#endif
|
||||
#ifndef EMSGSIZE
|
||||
#define EMSGSIZE (ZMQ_HAUSNUMERO + 10)
|
||||
#endif
|
||||
#ifndef EAFNOSUPPORT
|
||||
#define EAFNOSUPPORT (ZMQ_HAUSNUMERO + 11)
|
||||
#endif
|
||||
#ifndef ENETUNREACH
|
||||
#define ENETUNREACH (ZMQ_HAUSNUMERO + 12)
|
||||
#endif
|
||||
#ifndef ECONNABORTED
|
||||
#define ECONNABORTED (ZMQ_HAUSNUMERO + 13)
|
||||
#endif
|
||||
#ifndef ECONNRESET
|
||||
#define ECONNRESET (ZMQ_HAUSNUMERO + 14)
|
||||
#endif
|
||||
#ifndef ENOTCONN
|
||||
#define ENOTCONN (ZMQ_HAUSNUMERO + 15)
|
||||
#endif
|
||||
#ifndef ETIMEDOUT
|
||||
#define ETIMEDOUT (ZMQ_HAUSNUMERO + 16)
|
||||
#endif
|
||||
#ifndef EHOSTUNREACH
|
||||
#define EHOSTUNREACH (ZMQ_HAUSNUMERO + 17)
|
||||
#endif
|
||||
#ifndef ENETRESET
|
||||
#define ENETRESET (ZMQ_HAUSNUMERO + 18)
|
||||
#endif
|
||||
|
||||
/* Native 0MQ error codes. */
|
||||
#define EFSM (ZMQ_HAUSNUMERO + 51)
|
||||
#define ENOCOMPATPROTO (ZMQ_HAUSNUMERO + 52)
|
||||
#define ETERM (ZMQ_HAUSNUMERO + 53)
|
||||
#define EMTHREAD (ZMQ_HAUSNUMERO + 54)
|
||||
|
||||
/* Run-time API version detection */
|
||||
ZMQ_EXPORT void zmq_version (int *major, int *minor, int *patch);
|
||||
|
||||
/* This function retrieves the errno as it is known to 0MQ library. The goal */
|
||||
/* of this function is to make the code 100% portable, including where 0MQ */
|
||||
/* compiled with certain CRT library (on Windows) is linked to an */
|
||||
/* application that uses different CRT library. */
|
||||
ZMQ_EXPORT int zmq_errno (void);
|
||||
|
||||
/* Resolves system errors and 0MQ errors to human-readable string. */
|
||||
ZMQ_EXPORT const char *zmq_strerror (int errnum);
|
||||
|
||||
/******************************************************************************/
|
||||
/* 0MQ infrastructure (a.k.a. context) initialisation & termination. */
|
||||
/******************************************************************************/
|
||||
|
||||
/* New API */
|
||||
/* Context options */
|
||||
#define ZMQ_IO_THREADS 1
|
||||
#define ZMQ_MAX_SOCKETS 2
|
||||
|
||||
/* Default for new contexts */
|
||||
#define ZMQ_IO_THREADS_DFLT 1
|
||||
#define ZMQ_MAX_SOCKETS_DFLT 1023
|
||||
|
||||
ZMQ_EXPORT void *zmq_ctx_new (void);
|
||||
ZMQ_EXPORT int zmq_ctx_term (void *context);
|
||||
ZMQ_EXPORT int zmq_ctx_shutdown (void *ctx_);
|
||||
ZMQ_EXPORT int zmq_ctx_set (void *context, int option, int optval);
|
||||
ZMQ_EXPORT int zmq_ctx_get (void *context, int option);
|
||||
|
||||
/* Old (legacy) API */
|
||||
ZMQ_EXPORT void *zmq_init (int io_threads);
|
||||
ZMQ_EXPORT int zmq_term (void *context);
|
||||
ZMQ_EXPORT int zmq_ctx_destroy (void *context);
|
||||
|
||||
|
||||
/******************************************************************************/
|
||||
/* 0MQ message definition. */
|
||||
/******************************************************************************/
|
||||
|
||||
typedef struct zmq_msg_t {unsigned char _ [32];} zmq_msg_t;
|
||||
|
||||
typedef void (zmq_free_fn) (void *data, void *hint);
|
||||
|
||||
ZMQ_EXPORT int zmq_msg_init (zmq_msg_t *msg);
|
||||
ZMQ_EXPORT int zmq_msg_init_size (zmq_msg_t *msg, size_t size);
|
||||
ZMQ_EXPORT int zmq_msg_init_data (zmq_msg_t *msg, void *data,
|
||||
size_t size, zmq_free_fn *ffn, void *hint);
|
||||
ZMQ_EXPORT int zmq_msg_send (zmq_msg_t *msg, void *s, int flags);
|
||||
ZMQ_EXPORT int zmq_msg_recv (zmq_msg_t *msg, void *s, int flags);
|
||||
ZMQ_EXPORT int zmq_msg_close (zmq_msg_t *msg);
|
||||
ZMQ_EXPORT int zmq_msg_move (zmq_msg_t *dest, zmq_msg_t *src);
|
||||
ZMQ_EXPORT int zmq_msg_copy (zmq_msg_t *dest, zmq_msg_t *src);
|
||||
ZMQ_EXPORT void *zmq_msg_data (zmq_msg_t *msg);
|
||||
ZMQ_EXPORT size_t zmq_msg_size (zmq_msg_t *msg);
|
||||
ZMQ_EXPORT int zmq_msg_more (zmq_msg_t *msg);
|
||||
ZMQ_EXPORT int zmq_msg_get (zmq_msg_t *msg, int option);
|
||||
ZMQ_EXPORT int zmq_msg_set (zmq_msg_t *msg, int option, int optval);
|
||||
|
||||
|
||||
/******************************************************************************/
|
||||
/* 0MQ socket definition. */
|
||||
/******************************************************************************/
|
||||
|
||||
/* Socket types. */
|
||||
#define ZMQ_PAIR 0
|
||||
#define ZMQ_PUB 1
|
||||
#define ZMQ_SUB 2
|
||||
#define ZMQ_REQ 3
|
||||
#define ZMQ_REP 4
|
||||
#define ZMQ_DEALER 5
|
||||
#define ZMQ_ROUTER 6
|
||||
#define ZMQ_PULL 7
|
||||
#define ZMQ_PUSH 8
|
||||
#define ZMQ_XPUB 9
|
||||
#define ZMQ_XSUB 10
|
||||
#define ZMQ_STREAM 11
|
||||
|
||||
/* Deprecated aliases */
|
||||
#define ZMQ_XREQ ZMQ_DEALER
|
||||
#define ZMQ_XREP ZMQ_ROUTER
|
||||
|
||||
/* Socket options. */
|
||||
#define ZMQ_AFFINITY 4
|
||||
#define ZMQ_IDENTITY 5
|
||||
#define ZMQ_SUBSCRIBE 6
|
||||
#define ZMQ_UNSUBSCRIBE 7
|
||||
#define ZMQ_RATE 8
|
||||
#define ZMQ_RECOVERY_IVL 9
|
||||
#define ZMQ_SNDBUF 11
|
||||
#define ZMQ_RCVBUF 12
|
||||
#define ZMQ_RCVMORE 13
|
||||
#define ZMQ_FD 14
|
||||
#define ZMQ_EVENTS 15
|
||||
#define ZMQ_TYPE 16
|
||||
#define ZMQ_LINGER 17
|
||||
#define ZMQ_RECONNECT_IVL 18
|
||||
#define ZMQ_BACKLOG 19
|
||||
#define ZMQ_RECONNECT_IVL_MAX 21
|
||||
#define ZMQ_MAXMSGSIZE 22
|
||||
#define ZMQ_SNDHWM 23
|
||||
#define ZMQ_RCVHWM 24
|
||||
#define ZMQ_MULTICAST_HOPS 25
|
||||
#define ZMQ_RCVTIMEO 27
|
||||
#define ZMQ_SNDTIMEO 28
|
||||
#define ZMQ_LAST_ENDPOINT 32
|
||||
#define ZMQ_ROUTER_MANDATORY 33
|
||||
#define ZMQ_TCP_KEEPALIVE 34
|
||||
#define ZMQ_TCP_KEEPALIVE_CNT 35
|
||||
#define ZMQ_TCP_KEEPALIVE_IDLE 36
|
||||
#define ZMQ_TCP_KEEPALIVE_INTVL 37
|
||||
#define ZMQ_TCP_ACCEPT_FILTER 38
|
||||
#define ZMQ_IMMEDIATE 39
|
||||
#define ZMQ_XPUB_VERBOSE 40
|
||||
#define ZMQ_ROUTER_RAW 41
|
||||
#define ZMQ_IPV6 42
|
||||
#define ZMQ_MECHANISM 43
|
||||
#define ZMQ_PLAIN_SERVER 44
|
||||
#define ZMQ_PLAIN_USERNAME 45
|
||||
#define ZMQ_PLAIN_PASSWORD 46
|
||||
#define ZMQ_CURVE_SERVER 47
|
||||
#define ZMQ_CURVE_PUBLICKEY 48
|
||||
#define ZMQ_CURVE_SECRETKEY 49
|
||||
#define ZMQ_CURVE_SERVERKEY 50
|
||||
#define ZMQ_PROBE_ROUTER 51
|
||||
#define ZMQ_REQ_CORRELATE 52
|
||||
#define ZMQ_REQ_RELAXED 53
|
||||
#define ZMQ_CONFLATE 54
|
||||
#define ZMQ_ZAP_DOMAIN 55
|
||||
|
||||
/* Message options */
|
||||
#define ZMQ_MORE 1
|
||||
|
||||
/* Send/recv options. */
|
||||
#define ZMQ_DONTWAIT 1
|
||||
#define ZMQ_SNDMORE 2
|
||||
|
||||
/* Security mechanisms */
|
||||
#define ZMQ_NULL 0
|
||||
#define ZMQ_PLAIN 1
|
||||
#define ZMQ_CURVE 2
|
||||
|
||||
/* Deprecated options and aliases */
|
||||
#define ZMQ_IPV4ONLY 31
|
||||
#define ZMQ_DELAY_ATTACH_ON_CONNECT ZMQ_IMMEDIATE
|
||||
#define ZMQ_NOBLOCK ZMQ_DONTWAIT
|
||||
#define ZMQ_FAIL_UNROUTABLE ZMQ_ROUTER_MANDATORY
|
||||
#define ZMQ_ROUTER_BEHAVIOR ZMQ_ROUTER_MANDATORY
|
||||
|
||||
/******************************************************************************/
|
||||
/* 0MQ socket events and monitoring */
|
||||
/******************************************************************************/
|
||||
|
||||
/* Socket transport events (tcp and ipc only) */
|
||||
#define ZMQ_EVENT_CONNECTED 1
|
||||
#define ZMQ_EVENT_CONNECT_DELAYED 2
|
||||
#define ZMQ_EVENT_CONNECT_RETRIED 4
|
||||
|
||||
#define ZMQ_EVENT_LISTENING 8
|
||||
#define ZMQ_EVENT_BIND_FAILED 16
|
||||
|
||||
#define ZMQ_EVENT_ACCEPTED 32
|
||||
#define ZMQ_EVENT_ACCEPT_FAILED 64
|
||||
|
||||
#define ZMQ_EVENT_CLOSED 128
|
||||
#define ZMQ_EVENT_CLOSE_FAILED 256
|
||||
#define ZMQ_EVENT_DISCONNECTED 512
|
||||
#define ZMQ_EVENT_MONITOR_STOPPED 1024
|
||||
|
||||
#define ZMQ_EVENT_ALL ( ZMQ_EVENT_CONNECTED | ZMQ_EVENT_CONNECT_DELAYED | \
|
||||
ZMQ_EVENT_CONNECT_RETRIED | ZMQ_EVENT_LISTENING | \
|
||||
ZMQ_EVENT_BIND_FAILED | ZMQ_EVENT_ACCEPTED | \
|
||||
ZMQ_EVENT_ACCEPT_FAILED | ZMQ_EVENT_CLOSED | \
|
||||
ZMQ_EVENT_CLOSE_FAILED | ZMQ_EVENT_DISCONNECTED | \
|
||||
ZMQ_EVENT_MONITOR_STOPPED)
|
||||
|
||||
/* Socket event data */
|
||||
typedef struct {
|
||||
uint16_t event; // id of the event as bitfield
|
||||
int32_t value ; // value is either error code, fd or reconnect interval
|
||||
} zmq_event_t;
|
||||
|
||||
ZMQ_EXPORT void *zmq_socket (void *, int type);
|
||||
ZMQ_EXPORT int zmq_close (void *s);
|
||||
ZMQ_EXPORT int zmq_setsockopt (void *s, int option, const void *optval,
|
||||
size_t optvallen);
|
||||
ZMQ_EXPORT int zmq_getsockopt (void *s, int option, void *optval,
|
||||
size_t *optvallen);
|
||||
ZMQ_EXPORT int zmq_bind (void *s, const char *addr);
|
||||
ZMQ_EXPORT int zmq_connect (void *s, const char *addr);
|
||||
ZMQ_EXPORT int zmq_unbind (void *s, const char *addr);
|
||||
ZMQ_EXPORT int zmq_disconnect (void *s, const char *addr);
|
||||
ZMQ_EXPORT int zmq_send (void *s, const void *buf, size_t len, int flags);
|
||||
ZMQ_EXPORT int zmq_send_const (void *s, const void *buf, size_t len, int flags);
|
||||
ZMQ_EXPORT int zmq_recv (void *s, void *buf, size_t len, int flags);
|
||||
ZMQ_EXPORT int zmq_socket_monitor (void *s, const char *addr, int events);
|
||||
|
||||
ZMQ_EXPORT int zmq_sendmsg (void *s, zmq_msg_t *msg, int flags);
|
||||
ZMQ_EXPORT int zmq_recvmsg (void *s, zmq_msg_t *msg, int flags);
|
||||
|
||||
/* Experimental */
|
||||
struct iovec;
|
||||
|
||||
ZMQ_EXPORT int zmq_sendiov (void *s, struct iovec *iov, size_t count, int flags);
|
||||
ZMQ_EXPORT int zmq_recviov (void *s, struct iovec *iov, size_t *count, int flags);
|
||||
|
||||
/******************************************************************************/
|
||||
/* I/O multiplexing. */
|
||||
/******************************************************************************/
|
||||
|
||||
#define ZMQ_POLLIN 1
|
||||
#define ZMQ_POLLOUT 2
|
||||
#define ZMQ_POLLERR 4
|
||||
|
||||
typedef struct
|
||||
{
|
||||
void *socket;
|
||||
#if defined _WIN32
|
||||
SOCKET fd;
|
||||
#else
|
||||
int fd;
|
||||
#endif
|
||||
short events;
|
||||
short revents;
|
||||
} zmq_pollitem_t;
|
||||
|
||||
#define ZMQ_POLLITEMS_DFLT 16
|
||||
|
||||
ZMQ_EXPORT int zmq_poll (zmq_pollitem_t *items, int nitems, long timeout);
|
||||
|
||||
/* Built-in message proxy (3-way) */
|
||||
|
||||
ZMQ_EXPORT int zmq_proxy (void *frontend, void *backend, void *capture);
|
||||
|
||||
/* Encode a binary key as printable text using ZMQ RFC 32 */
|
||||
ZMQ_EXPORT char *zmq_z85_encode (char *dest, uint8_t *data, size_t size);
|
||||
|
||||
/* Encode a binary key from printable text per ZMQ RFC 32 */
|
||||
ZMQ_EXPORT uint8_t *zmq_z85_decode (uint8_t *dest, char *string);
|
||||
|
||||
/* Deprecated aliases */
|
||||
#define ZMQ_STREAMER 1
|
||||
#define ZMQ_FORWARDER 2
|
||||
#define ZMQ_QUEUE 3
|
||||
/* Deprecated method */
|
||||
ZMQ_EXPORT int zmq_device (int type, void *frontend, void *backend);
|
||||
|
||||
#undef ZMQ_EXPORT
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
+105
@@ -0,0 +1,105 @@
|
||||
/*
|
||||
Copyright (c) 2007-2013 Contributors as noted in the AUTHORS file
|
||||
|
||||
This file is part of 0MQ.
|
||||
|
||||
0MQ is free software; you can redistribute it and/or modify it under
|
||||
the terms of the GNU Lesser General Public License as published by
|
||||
the Free Software Foundation; either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
0MQ is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#ifndef __ZMQ_UTILS_H_INCLUDED__
|
||||
#define __ZMQ_UTILS_H_INCLUDED__
|
||||
|
||||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
#include <stdlib.h>
|
||||
|
||||
/* Define integer types needed for event interface */
|
||||
#if defined ZMQ_HAVE_SOLARIS || defined ZMQ_HAVE_OPENVMS
|
||||
# include <inttypes.h>
|
||||
#elif defined _MSC_VER && _MSC_VER < 1600
|
||||
# ifndef int32_t
|
||||
typedef __int32 int32_t;
|
||||
# endif
|
||||
# ifndef uint16_t
|
||||
typedef unsigned __int16 uint16_t;
|
||||
# endif
|
||||
#else
|
||||
# include <stdint.h>
|
||||
#endif
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/* Handle DSO symbol visibility */
|
||||
#if defined _WIN32
|
||||
# if defined ZMQ_STATIC
|
||||
# define ZMQ_EXPORT
|
||||
# elif defined DLL_EXPORT
|
||||
# define ZMQ_EXPORT __declspec(dllexport)
|
||||
# else
|
||||
# define ZMQ_EXPORT __declspec(dllimport)
|
||||
# endif
|
||||
#else
|
||||
# if defined __SUNPRO_C || defined __SUNPRO_CC
|
||||
# define ZMQ_EXPORT __global
|
||||
# elif (defined __GNUC__ && __GNUC__ >= 4) || defined __INTEL_COMPILER
|
||||
# define ZMQ_EXPORT __attribute__ ((visibility("default")))
|
||||
# else
|
||||
# define ZMQ_EXPORT
|
||||
# endif
|
||||
#endif
|
||||
|
||||
/* These functions are documented by man pages */
|
||||
|
||||
/* Encode data with Z85 encoding. Returns encoded data */
|
||||
ZMQ_EXPORT char *zmq_z85_encode (char *dest, uint8_t *data, size_t size);
|
||||
|
||||
/* Decode data with Z85 encoding. Returns decoded data */
|
||||
ZMQ_EXPORT uint8_t *zmq_z85_decode (uint8_t *dest, char *string);
|
||||
|
||||
/* Generate z85-encoded public and private keypair with libsodium. */
|
||||
/* Returns 0 on success. */
|
||||
ZMQ_EXPORT int zmq_curve_keypair (char *z85_public_key, char *z85_secret_key);
|
||||
|
||||
typedef void (zmq_thread_fn) (void*);
|
||||
|
||||
/* These functions are not documented by man pages */
|
||||
|
||||
/* Helper functions are used by perf tests so that they don't have to care */
|
||||
/* about minutiae of time-related functions on different OS platforms. */
|
||||
|
||||
/* Starts the stopwatch. Returns the handle to the watch. */
|
||||
ZMQ_EXPORT void *zmq_stopwatch_start (void);
|
||||
|
||||
/* Stops the stopwatch. Returns the number of microseconds elapsed since */
|
||||
/* the stopwatch was started. */
|
||||
ZMQ_EXPORT unsigned long zmq_stopwatch_stop (void *watch_);
|
||||
|
||||
/* Sleeps for specified number of seconds. */
|
||||
ZMQ_EXPORT void zmq_sleep (int seconds_);
|
||||
|
||||
/* Start a thread. Returns a handle to the thread. */
|
||||
ZMQ_EXPORT void *zmq_threadstart (zmq_thread_fn* func, void* arg);
|
||||
|
||||
/* Wait for thread to complete then free up resources. */
|
||||
ZMQ_EXPORT void zmq_threadclose (void* thread);
|
||||
|
||||
#undef ZMQ_EXPORT
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user