Switch branches/tags
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
155 lines (120 sloc) 4.4 KB

This is now completely deprecated; use the (Node.JS maintained) NAN.

They have far more documentation, support for Node.JS 0.12, much nicer syntax and a handy porting guide. It's heavier than V8U though.

Sugar for your Node C++ addons

Have you ever written a C/C++ addon for Node.JS?
If you have, you probably are tired of writing so much code for just having the skeleton of it.
Sure, the V8 syntax is very verbose and repetitive.

With V8U, that will change.
V8U has a special emphasis on speed, simplicity and flexibility.
In fact, it's just a set of macros to kill the repetitive writing.

V8U is quite fast, and will make your modules safer without you notice.

Note: if you come from CCV8 (now called v8-juice) or are worried
about performace, be sure to checkout this wiki page to
know which one to use.

Enough talking, show me code!

Here we have a simple module which exposes one class Hello, with one method, world.
It takes one string as argument, and just returns it untouched:

> Hello = require('./simpleaddon').Hello;
[Function: Hello]
> hello = new Hello();
>'the cat!')
'the cat!'

Without V8U

class Hello : public node::ObjectWrap {
  //The constructor
  static Handle<Value> NewInstance(const v8::Arguments& args) {
    v8::HandleScope scope;
    if (!args.IsConstructCall())
      return v8::ThrowException(v8::Exception::Error(v8::String::New("Not called as constructor!")));
    Hello* instance = new Hello;
    return args.This();

  //The world() method
  static Handle<Value> World(const v8::Arguments& args) {
    v8::HandleScope scope;
    if (!args[0]->IsString())
      return v8::ThrowException(v8::Exception::TypeError(v8::String::New("Arg must be a string!")));
    return scope.Close(args[0]);

extern "C" {
  static void initHello(Handle<Object> target) {
    v8::HandleScope scope;
    v8::Local<v8::FunctionTemplate> protL = v8::FunctionTemplate::New(Hello::NewInstance);
    v8::Persistent<v8::FunctionTemplate> prot = v8::Persistent<v8::FunctionTemplate>::New(protL);
    NODE_SET_PROTOTYPE_METHOD(prot, "world", Hello::World);
    target->Set(v8::String::NewSymbol("Hello"), prot->GetFunction());
  NODE_MODULE(simpleaddon, initHello);

With V8U

class Hello : public ObjectWrap {
  //The constructor
  V8_CTOR() {
    V8_WRAP(new Hello);
  } V8_CTOR_END()

  //The world() method
  static V8_CB(World) {
    if (!args[0]->IsString()) V8_THROW(v8u::TypeErr("Arg must be a string!"));
  } V8_CB_END()
  NODE_DEF_TYPE("Hello") {
    V8_DEF_CB("world", World);

} NODE_DEF_MAIN_END(simpleaddon)

And that's just scratching the surface of what V8U provides.
What's more, V8U cares about exception wrapping, persistent handles, and other things for you!

How to use

To use V8U, simply copy v8u.hpp into your project.
Then include it:

#include "v8u.hpp"

Be sure to do this in your binding.gyp.

Now, let the fun begin!
See the tutorial to get started.

The Version class

Also included is the version.hpp file, which exposes the Version type. It's a very simple class which stores three integers: the major, minor, and patch (also called revision) versions.

It can represent any semantic version (Node's version, your package's NPM version, ...) and you can easily initialize it from the C++ side.

To use it, copy your version.hpp along with v8u.hpp and do things like:

#include "version.hpp"

  // Initialize Version class
  // Put my version
    (new v8u::Version(2,9,1))->Wrapped()
} NODE_DEF_MAIN_END(mymodule)

Results in:

> require("mymodule")
{ Version: [Function: Version],
  myversion: <Version 2.9.1> }

See it in action!