Native Abstractions for Node.js =============================== **A header file filled with macro and utility goodness for making addon development for Node.js easier across versions 0.8, 0.10 and 0.11, and eventually 0.12.** ***Current version: 0.3.2*** *(See [nan.h](https://github.com/rvagg/nan/blob/master/nan.h) for changelog)* [![NPM](https://nodei.co/npm/nan.png?downloads=true&stars=true)](https://nodei.co/npm/nan/) [![NPM](https://nodei.co/npm-dl/nan.png?months=6)](https://nodei.co/npm/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.11/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. * **[Usage](#usage)** * **[Example](#example)** * **[API](#api)** ## Usage Simply add **NAN** as a dependency in the *package.json* of your Node addon: ```js "dependencies": { ... "nan" : "~0.3.1" ... } ``` Pull in the path to **NAN** in your *binding.gyp* so that you can use `#include "nan.h"` in your *.cpp*: ```js "include_dirs" : [ ... "` when compiling your addon. ## Example See **[LevelDOWN](https://github.com/rvagg/node-leveldown/pull/48)** for a full example of **NAN** in use. For a simpler example, see the **[async pi estimation example](https://github.com/rvagg/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**. Compare to the current 0.10 version of this example, found in the [node-addon-examples](https://github.com/rvagg/node-addon-examples/tree/master/9_async_work) repository and also a 0.11 version of the same found [here](https://github.com/kkoopa/node-addon-examples/tree/5c01f58fc993377a567812597e54a83af69686d7/9_async_work). Note that there is no embedded version sniffing going on here and also the async work is made much simpler, see below for details on the `NanAsyncWorker` class. ```c++ // addon.cc #include #include "nan.h" // ... using namespace v8; void InitAll(Handle exports) { exports->Set(NanSymbol("calculateSync"), FunctionTemplate::New(CalculateSync)->GetFunction()); exports->Set(NanSymbol("calculateAsync"), FunctionTemplate::New(CalculateAsync)->GetFunction()); } NODE_MODULE(addon, InitAll) ``` ```c++ // sync.h #include #include "nan.h" NAN_METHOD(CalculateSync); ``` ```c++ // sync.cc #include #include "nan.h" #include "sync.h" // ... using namespace v8; // Simple synchronous access to the `Estimate()` function NAN_METHOD(CalculateSync) { NanScope(); // expect a number as the first argument int points = args[0]->Uint32Value(); double est = Estimate(points); NanReturnValue(Number::New(est)); } ``` ```c++ // async.cc #include #include "nan.h" #include "async.h" // ... using namespace v8; class PiWorker : public NanAsyncWorker { public: PiWorker(NanCallback *callback, int points) : NanAsyncWorker(callback), points(points) {} ~PiWorker() {} // Executed inside the worker-thread. // It is not safe to access V8, or V8 data structures // here, so everything we need for input and output // should go on `this`. void Execute () { estimate = Estimate(points); } // Executed when the async work is complete // this function will be run inside the main event loop // so it is safe to use V8 again void HandleOKCallback () { NanScope(); Local argv[] = { Local::New(Null()) , Number::New(estimate) }; callback->Call(2, argv); }; private: int points; double estimate; }; // Asynchronous access to the `Estimate()` function NAN_METHOD(CalculateAsync) { NanScope(); int points = args[0]->Uint32Value(); NanCallback *callback = new NanCallback(args[1].As()); NanAsyncQueueWorker(new PiWorker(callback, points)); NanReturnUndefined(); } ``` ## API * NAN_METHOD * NAN_GETTER * NAN_SETTER * NAN_PROPERTY_GETTER * NAN_PROPERTY_SETTER * NAN_PROPERTY_ENUMERATOR * NAN_PROPERTY_DELETER * NAN_PROPERTY_QUERY * NAN_WEAK_CALLBACK * NanReturnValue * NanReturnUndefined * NanReturnNull * NanReturnEmptyString * NanScope * NanLocker * NanUnlocker * NanGetInternalFieldPointer * NanSetInternalFieldPointer * NanObjectWrapHandle * NanMakeWeak * NanSymbol * NanGetPointerSafe * NanSetPointerSafe * NanFromV8String * NanBooleanOptionValue * NanUInt32OptionValue * NanThrowError, NanThrowTypeError, NanThrowRangeError, NanThrowError(Handle), NanThrowError(Handle, int) * NanNewBufferHandle(char *, size_t, FreeCallback, void *), NanNewBufferHandle(char *, uint32_t), NanNewBufferHandle(uint32_t) * NanBufferUse(char *, uint32_t) * NanNewContextHandle * NanHasInstance * NanPersistentToLocal * NanDispose * NanAssignPersistent * NanInitPersistent * NanCallback * NanAsyncWorker * NanAsyncQueueWorker ### NAN_METHOD(methodname) Use `NAN_METHOD` to define your V8 accessible methods: ```c++ // .h: class Foo : public node::ObjectWrap { ... static NAN_METHOD(Bar); static NAN_METHOD(Baz); } // .cc: NAN_METHOD(Foo::Bar) { ... } NAN_METHOD(Foo::Baz) { ... } ``` The reason for this macro is because of the method signature change in 0.11: ```c++ // 0.10 and below: Handle name(const Arguments& args) // 0.11 and above void name(const FunctionCallbackInfo& args) ``` The introduction of `FunctionCallbackInfo` brings additional complications: ### NAN_GETTER(methodname) Use `NAN_GETTER` to declare your V8 accessible getters. You get a `Local` `property` and an appropriately typed `args` object that can act like the `args` argument to a `NAN_METHOD` call. You can use `NanReturnNull()`, `NanReturnEmptyString()`, `NanReturnUndefined()` and `NanReturnValue()` in a `NAN_GETTER`. ### NAN_SETTER(methodname) Use `NAN_SETTER` to declare your V8 accessible setters. Same as `NAN_GETTER` but you also get a `Local` `value` object to work with. You can use `NanReturnNull()`, `NanReturnEmptyString()`, `NanReturnUndefined()` and `NanReturnValue()` in a `NAN_SETTER`. ### NAN_PROPERTY_GETTER(cbname) Use `NAN_PROPERTY_GETTER` to declare your V8 accessible property getters. You get a `Local` `property` and an appropriately typed `args` object that can act similar to the `args` argument to a `NAN_METHOD` call. You can use `NanReturnNull()`, `NanReturnEmptyString()`, `NanReturnUndefined()` and `NanReturnValue()` in a `NAN_PROPERTY_GETTER`. ### NAN_PROPERTY_SETTER(cbname) Use `NAN_PROPERTY_SETTER` to declare your V8 accessible property setters. Same as `NAN_PROPERTY_GETTER` but you also get a `Local` `value` object to work with. You can use `NanReturnNull()`, `NanReturnEmptyString()`, `NanReturnUndefined()` and `NanReturnValue()` in a `NAN_PROPERTY_SETTER`. ### NAN_PROPERTY_ENUMERATOR(cbname) Use `NAN_PROPERTY_ENUMERATOR` to declare your V8 accessible property enumerators. You get an appropriately typed `args` object like the `args` argument to a `NAN_PROPERTY_GETTER` call. You can use `NanReturnNull()`, `NanReturnEmptyString()`, `NanReturnUndefined()` and `NanReturnValue()` in a `NAN_PROPERTY_ENUMERATOR`. ### NAN_PROPERTY_DELETER(cbname) Use `NAN_PROPERTY_DELETER` to declare your V8 accessible property deleters. Same as `NAN_PROPERTY_GETTER`. You can use `NanReturnNull()`, `NanReturnEmptyString()`, `NanReturnUndefined()` and `NanReturnValue()` in a `NAN_PROPERTY_DELETER`. ### NAN_PROPERTY_QUERY(cbname) Use `NAN_PROPERTY_QUERY` to declare your V8 accessible property queries. Same as `NAN_PROPERTY_GETTER`. You can use `NanReturnNull()`, `NanReturnEmptyString()`, `NanReturnUndefined()` and `NanReturnValue()` in a `NAN_PROPERTY_QUERY`. ### NAN_WEAK_CALLBACK(type, cbname) Use `NAN_WEAK_CALLBACK` to declare your V8 WeakReference callbacks. There is an object argument accessible through `NAN_WEAK_CALLBACK_OBJECT`. The `type` argument gives the type of the `data` argument, accessible through `NAN_WEAK_CALLBACK_DATA(type)`. ```c++ static NAN_WEAK_CALLBACK(BufferReference*, WeakCheck) { if (NAN_WEAK_CALLBACK_DATA(BufferReference*)->noLongerNeeded_) { delete NAN_WEAK_CALLBACK_DATA(BufferReference*); } else { // Still in use, revive, prevent GC NanMakeWeak(NAN_WEAK_CALLBACK_OBJECT, NAN_WEAK_CALLBACK_DATA(BufferReference*), &WeakCheck); } } ``` ### NanReturnValue(Handle<Value>) Use `NanReturnValue` when you want to return a value from your V8 accessible method: ```c++ NAN_METHOD(Foo::Bar) { ... NanReturnValue(String::New("FooBar!")); } ``` No `return` statement required. ### NanReturnUndefined() Use `NanReturnUndefined` when you don't want to return anything from your V8 accessible method: ```c++ NAN_METHOD(Foo::Baz) { ... NanReturnUndefined(); } ``` ### NanReturnNull() Use `NanReturnNull` when you want to return `Null` from your V8 accessible method: ```c++ NAN_METHOD(Foo::Baz) { ... NanReturnNull(); } ``` ### NanReturnEmptyString() Use `NanReturnEmptyString` when you want to return an empty `String` from your V8 accessible method: ```c++ NAN_METHOD(Foo::Baz) { ... NanReturnEmptyString(); } ``` ### NanScope() The introduction of `isolate` references for many V8 calls in Node 0.11 makes `NanScope()` necessary, use it in place of `HandleScope scope`: ```c++ NAN_METHOD(Foo::Bar) { NanScope(); NanReturnValue(String::New("FooBar!")); } ``` ### NanLocker() The introduction of `isolate` references for many V8 calls in Node 0.11 makes `NanLocker()` necessary, use it in place of `Locker locker`: ```c++ NAN_METHOD(Foo::Bar) { NanLocker(); ... NanUnlocker(); } ``` ### NanUnlocker() The introduction of `isolate` references for many V8 calls in Node 0.11 makes `NanUnlocker()` necessary, use it in place of `Unlocker unlocker`: ```c++ NAN_METHOD(Foo::Bar) { NanLocker(); ... NanUnlocker(); } ``` ### void * NanGetInternalFieldPointer(Handle<Object>, int) Gets a pointer to the internal field with at `index` from a V8 `Object` handle. ```c++ Local obj; ... NanGetInternalFieldPointer(obj, 0); ``` ### void NanSetInternalFieldPointer(Handle<Object>, int, void *) Sets the value of the internal field at `index` on a V8 `Object` handle. ```c++ static Persistent dataWrapperCtor; ... Local wrapper = NanPersistentToLocal(dataWrapperCtor)->NewInstance(); NanSetInternalFieldPointer(wrapper, 0, this); ``` ### Local<Object> NanObjectWrapHandle(Object) When you want to fetch the V8 object handle from a native object you've wrapped with Node's `ObjectWrap`, you should use `NanObjectWrapHandle`: ```c++ NanObjectWrapHandle(iterator)->Get(String::NewSymbol("end")) ``` ### NanMakeWeak(Persistent<T>, parameter, callback) Make a persistent reference weak. ### String NanSymbol(char *) This isn't strictly about compatibility, it's just an easier way to create string symbol objects (i.e. `String::NewSymbol(x)`), for getting and setting object properties, or names of objects. ```c++ bool foo = false; if (obj->Has(NanSymbol("foo"))) foo = optionsObj->Get(NanSymbol("foo"))->BooleanValue() ``` ### Type NanGetPointerSafe(Type *[, Type]) A helper for getting values from optional pointers. If the pointer is `NULL`, the function returns the optional default value, which defaults to `0`. Otherwise, the function returns the value the pointer points to. ```c++ char *plugh(uint32_t *optional) { char res[] = "xyzzy"; uint32_t param = NanGetPointerSafe(optional, 0x1337); switch (param) { ... } NanSetPointerSafe(optional, 0xDEADBEEF); } ``` ### bool NanSetPointerSafe(Type *, Type) A helper for setting optional argument pointers. If the pointer is `NULL`, the function simply return `false`. Otherwise, the value is assigned to the variable the pointer points to. ```c++ const char *plugh(size_t *outputsize) { char res[] = "xyzzy"; if !(NanSetPointerSafe(outputsize, strlen(res) + 1)) { ... } ... } ``` ### char* NanFromV8String(Handle<Value>[, enum Nan::Encoding, size_t *, char *, size_t, int]) When you want to convert a V8 `String` to a `char*` use `NanFromV8String`. It is possible to define an encoding that defaults to `Nan::UTF8` as well as a pointer to a variable that will be assigned the number of bytes in the returned string. It is also possible to supply a buffer and its length to the function in order not to have a new buffer allocated. The final argument allows optionally setting `String::WriteOptions`, which default to `String::HINT_MANY_WRITES_EXPECTED | String::NO_NULL_TERMINATION`. Just remember that you'll end up with an object that you'll need to `delete[]` at some point unless you supply your own buffer: ```c++ size_t count; char* name = NanFromV8String(args[0]); char* decoded = NanFromV8String(args[1], Nan::BASE64, &count, NULL, 0, String::HINT_MANY_WRITES_EXPECTED); char param_copy[count]; memcpy(param_copy, decoded, count); delete[] decoded; ``` ### bool NanBooleanOptionValue(Handle<Value>, Handle<String>[, bool]) When you have an "options" object that you need to fetch properties from, boolean options can be fetched with this pair. They check first if the object exists (`IsEmpty`), then if the object has the given property (`Has`) then they get and convert/coerce the property to a `bool`. The optional last parameter is the *default* value, which is `false` if left off: ```c++ // `foo` is false unless the user supplies a truthy value for it bool foo = NanBooleanOptionValue(optionsObj, NanSymbol("foo")); // `bar` is true unless the user supplies a falsy value for it bool bar = NanBooleanOptionValueDefTrue(optionsObj, NanSymbol("bar"), true); ``` ### uint32_t NanUInt32OptionValue(Handle<Value>, Handle<String>, uint32_t) Similar to `NanBooleanOptionValue`, use `NanUInt32OptionValue` to fetch an integer option from your options object. Can be any kind of JavaScript `Number` and it will be coerced to an unsigned 32-bit integer. Requires all 3 arguments as a default is not optional: ```c++ uint32_t count = NanUInt32OptionValue(optionsObj, NanSymbol("count"), 1024); ``` ### NanThrowError(message), NanThrowTypeError(message), NanThrowRangeError(message), NanThrowError(Local<Value>), NanThrowError(Local<Value>, int) For throwing `Error`, `TypeError` and `RangeError` objects. You should `return` this call: ```c++ return NanThrowError("you must supply a callback argument"); ``` Can also handle any custom object you may want to throw. If used with the error code argument, it will add the supplied error code to the error object as a property called `code`. ### Local<Object> NanNewBufferHandle(char *, uint32_t), Local<Object> NanNewBufferHandle(uint32_t) The `Buffer` API has changed a little in Node 0.11, this helper provides consistent access to `Buffer` creation: ```c++ NanNewBufferHandle((char*)value.data(), value.size()); ``` Can also be used to initialize a `Buffer` with just a `size` argument. Can also be supplied with a `NAN_WEAK_CALLBACK` and a hint for the garbage collector, when dealing with weak references. ### Local<Object> NanBufferUse(char*, uint32_t) `Buffer::New(char*, uint32_t)` prior to 0.11 would make a copy of the data. While it was possible to get around this, it required a shim by passing a callback. So the new API `Buffer::Use(char*, uint32_t)` was introduced to remove needing to use this shim. `NanBufferUse` uses the `char*` passed as the backing data, and will free the memory automatically when the weak callback is called. Keep this in mind, as careless use can lead to "double free or corruption" and other cryptic failures. ### bool NanHasInstance(Persistent<FunctionTemplate>&, Handle<Value>) Can be used to check the type of an object to determine it is of a particular class you have already defined and have a `Persistent` handle for. ### Local<Type> NanPersistentToLocal(Persistent<Type>&) Aside from `FunctionCallbackInfo`, the biggest and most painful change to V8 in Node 0.11 is the many restrictions now placed on `Persistent` handles. They are difficult to assign and difficult to fetch the original value out of. Use `NanPersistentToLocal` to convert a `Persistent` handle back to a `Local` handle. ```c++ Local handle = NanPersistentToLocal(persistentHandle); ``` ### Local<Context> NanNewContextHandle([ExtensionConfiguration*, Handle<ObjectTemplate>, Handle<Value>]) Creates a new `Local` handle. ```c++ Local ftmpl = FunctionTemplate::New(); Local otmpl = ftmpl->InstanceTemplate(); Local ctx = NanNewContextHandle(NULL, otmpl); ``` ### void NanDispose(Persistent<T> &) Use `NanDispose` to dispose a `Persistent` handle. ```c++ NanDispose(persistentHandle); ``` ### NanAssignPersistent(type, handle, object) Use `NanAssignPersistent` to assign a non-`Persistent` handle to a `Persistent` one. You can no longer just declare a `Persistent` handle and assign directly to it later, you have to `Reset` it in Node 0.11, so this makes it easier. In general it is now better to place anything you want to protect from V8's garbage collector as properties of a generic `Object` and then assign that to a `Persistent`. This works in older versions of Node also if you use `NanAssignPersistent`: ```c++ Persistent persistentHandle; ... Local obj = Object::New(); obj->Set(NanSymbol("key"), keyHandle); // where keyHandle might be a Local NanAssignPersistent(Object, persistentHandle, obj) ``` ### NanInitPersistent(type, name, object) User `NanInitPersistent` to declare and initialize a new `Persistent` with the supplied object. The assignment operator for `Persistent` is no longer public in Node 0.11, so this macro makes it easier to declare and initializing a new `Persistent`. See NanAssignPersistent for more information. ```c++ Local obj = Object::New(); obj->Set(NanSymbol("key"), keyHandle); // where keyHandle might be a Local NanInitPersistent(Object, persistentHandle, obj); ``` ### NanCallback Because of the difficulties imposed by the changes to `Persistent` handles in V8 in Node 0.11, creating `Persistent` versions of your `Local` handles is annoyingly tricky. `NanCallback` makes it easier by taking your `Local` handle, making it persistent until the `NanCallback` is deleted and even providing a handy `Call()` method to fetch and execute the callback `Function`. ```c++ Local callbackHandle = callback = args[0].As(); NanCallback *callback = new NanCallback(callbackHandle); // pass `callback` around and it's safe from GC until you: delete callback; ``` You can execute the callback like so: ```c++ // no arguments: callback->Call(0, NULL); // an error argument: Local argv[] = { Exception::Error(String::New("fail!")) }; callback->Call(1, argv); // a success argument: Local argv[] = { Local::New(Null()), String::New("w00t!") }; callback->Call(2, argv); ``` `NanCallback` also has a `Local GetCallback()` method that you can use to fetch a local handle to the underlying callback function if you need it. ### NanAsyncWorker `NanAsyncWorker` is an abstract class that you can subclass to have much of the annoying async queuing and handling taken care of for you. It can even store arbitrary V8 objects for you and have them persist while the async work is in progress. See a rough outline of the implementation: ```c++ class NanAsyncWorker { public: NanAsyncWorker (NanCallback *callback); // Clean up persistent handles and delete the *callback virtual ~NanAsyncWorker (); // Check the `char *errmsg` property and call HandleOKCallback() // or HandleErrorCallback depending on whether it has been set or not virtual void WorkComplete (); // You must implement this to do some async work. If there is an // error then allocate `errmsg` to to a message and the callback will // be passed that string in an Error object virtual void Execute (); protected: // Set this if there is an error, otherwise it's NULL const char *errmsg; // Save a V8 object in a Persistent handle to protect it from GC void SavePersistent(const char *key, Local &obj); // Fetch a stored V8 object (don't call from within `Execute()`) Local GetFromPersistent(const char *key); // Default implementation calls the callback function with no arguments. // Override this to return meaningful data virtual void HandleOKCallback (); // Default implementation calls the callback function with an Error object // wrapping the `errmsg` string virtual void HandleErrorCallback (); }; ``` ### NanAsyncQueueWorker(NanAsyncWorker *) `NanAsyncQueueWorker` will run a `NanAsyncWorker` 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 `NanAsyncWorker`. ### Contributors NAN is only possible due to the excellent work of the following contributors:
Rod VaggGitHub/rvaggTwitter/@rvagg
Benjamin ByholmGitHub/kkoopa
Trevor NorrisGitHub/trevnorrisTwitter/@trevnorris
Licence & copyright ----------------------- Copyright (c) 2013 Rod Vagg & NAN contributors (listed above). Native Abstractions for Node.js is licensed under an MIT +no-false-attribs license. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.