nnu

nnu - Node.js Native Utilities

Some useful utilities for writing node.js native module.

Usage

Simply add NAN and NNU as a dependency in the package.json of your Node addon:

npm install --save nan nnu

Pull in the path to NAN and NNU in your binding.gyp so that you can use #include <nan.h> in your .cpp files:

"include_dirs" : [ 
    "<!(node -e \"require('nan')\")", 
    "<!(node -e \"require('nnu')\")"
]

Example

• nnu::setPrivate & nnu::getPrivate
• nnu::ClassWrap

#include <iostream>
#include <nnu.h>
 
// nnu::ClassWrap will simplify the way you write a class. 
class SampleClass : public nnu::ClassWrap<SampleClass> {
public:
    static const char * const CLASS_NAME;
 
    // Static member *cotr* is *required* 
    static NAN_METHOD(ctor) {
        int v = 0;
        if (info.Length() > 0) {
            v = info[0]->Int32Value();
        }
 
        SampleClass *sc = new SampleClass(v);
        sc->Wrap(info.This());
 
        nnu::setPrivate(info.This(), "_priv_2_", 2);
        nnu::setPrivate(info.This(), "_priv_3_", sc);
 
        info.GetReturnValue().Set(info.This());
    }
 
    // Static member *setupMember*  is *required* 
    static void setupMember(v8::Local<v8::FunctionTemplate>& tpl) {
        // Use wrapFunction to wrap member function as static. 
        Nan::SetPrototypeMethod(tpl, "printPriv", wrapFunction<&SampleClass::printPriv>);
        Nan::SetPrototypeMethod(tpl, "getVal", wrapFunction<&SampleClass::getVal>);
        Nan::SetPrototypeMethod(tpl, "incVal", wrapFunction<&SampleClass::incVal>);
        Nan::SetPrototypeMethod(tpl, "clone", wrapFunction<&SampleClass::clone>);
    }
 
private:
    SampleClass() : _val(0) { }
 
    // You can now write member function instead of static, ObjectWrap::Unwrap is no longer needed. 
    NAN_METHOD(printPriv) {
        int priv1 = nnu::getPrivate<int>(info.This(), "_priv_2_");
        std::cout << "priv1: " << priv1 << std::endl;
 
        SampleClass *priv2 = nnu::getPrivate<SampleClass*>(info.This(), "_priv_3_");
        std::cout << "priv2: " << priv2 << " should be equal to " << this << std::endl;
    }
 
    NAN_METHOD(getVal) {
        info.GetReturnValue().Set(Nan::New(_val));
    }
 
    NAN_METHOD(incVal) {
        _val++; 
        info.GetReturnValue().Set(info.This());
    }
 
    NAN_METHOD(clone) {
        v8::Local<v8::Value> args[] = { Nan::New(_val) };
        v8::Local<v8::Object> ret = SampleClass::newInstance(1, args);
        info.GetReturnValue().Set(ret);
    }
 
private:
    int _val;
};
 
const char * const SampleClass::CLASS_NAME = "SampleClass";
 
// newInstance() 
// or 
// newInstance(int argc, v8::Local<v8::Value> argv[]) 
NAN_METHOD(newSample) {
    info.GetReturnValue().Set(SampleClass::newInstance());
}
 
NAN_MODULE_INIT(InitAll) {
    SampleClass::setup(target);
 
    NAN_EXPORT(target, newSample);
}
 
NODE_MODULE(nnu_example, InitAll);