npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

macro-inferno

v0.2.3

Published

A header library with various helpers for native node.js addon development.

Downloads

67

Readme

macro-inferno

A header library with various helpers for native node.js addon development built on top of NAN. Write one-liners for typechecking and converting arguments, unpacking and packing v8::Arrays, unwrapping and wrapping objects and property getters.

Collapse complex statements into one-liners and avoid writing the same stuff over and over again in each function that your module exposes. Converting JS objects, wrapping and unwrapping instances, packing and unpacking arrays, type checking... , all this can be done using macro-inferno macros, which avoids repetitive and unreadable code and saves you a lot of time that you would spend copy and pasting.

Why? - Write one-liners instead of massive statements

Typechecked conversions:

If you care about displaying meaningful error messages to the user of your API, you may end up writing code like this ...

NAN_METHOD(aClass::aMethodName) {
  // make sure argument 0 is a string
  if (info.Length() < 1 || !info[0]->IsString()) {
    return Nan::ThrowError(Nan::New(
      "aMethodName - expected arg 0 to be of type: STRING"
    ).ToLocalChecked());
  }
  std::string arg0 = std::string(*Nan::Utf8String(info[0]->ToString()));

  // make sure argument 1 is a number if it was passed
  // otherwise assign a default value
  double arg1;
  if (info.Length() > 1) {
    if (!info[1]->IsNumber()) {
      return Nan::ThrowError(Nan::New(
        "aMethodName - expected arg 0 to be of type: NUMBER"
      ).ToLocalChecked());
    }
    arg1 = info[1]->NumberValue();
  } else {
    arg1 = 0.1;
  }
}

Simply write 3 lines of code instead:

NAN_METHOD(aClass::aMethodName) {
  FF_METHOD_CONTEXT("aMethodName");
  FF_ARG_STRING(0, std::string arg0);
  FF_ARG_NUMBER_IFDEF(1, double arg1, 0.1);
}

Typechecked conversion of arrays:

Unpacking arrays to std::vector ...

NAN_METHOD(aClass::aMethodName) {
  if (info.Length() < 1 || !info[0]->IsArray) {
    return Nan::ThrowError(Nan::New(
      "aMethodName - expected arg 0 to be of type: ARRAY"
    ).ToLocalChecked());
  }
  v8::Local<v8::Array> arr = v8::Local<v8::Array>::Cast(info[0]);

  std::vector<int> intVec;
  for (int i = 0; i < arr->Length(); i++) {
    v8::Local<v8::Value> val = arr->Get(i);
    if (!val->IsInt32()) {
      return Nan::ThrowError(Nan::New(
        "expected array element to be of type: INT, at index: " + std::to_string(i)
      ).ToLocalChecked());
    }
    vec.push_back(info[0]->Int32Value());
  }
}

Simply write:

NAN_METHOD(aClass::aMethodName) {
  FF_METHOD_CONTEXT("aMethodName");
  FF_ARG_UNPACK_INT_ARRAY(0, intVec);
}

Documentation

Shortcuts

FF_OBJ obj = FF_NEW_OBJ();
v8::Local<v8::Object> obj = Nan::New<v8::Object>();

FF_ARR arr = FF_NEW_ARRAY(10);
v8::Local<v8::Array> arr = Nan::New<v8::Array>(10);

FF_VAL val;
v8::Local<v8::Value> val;

std::string str = FF_NEW_STRING("foo");
std::string str = Nan::New("foo").ToLocalChecked();

FF_RETURN(val);
info.GetReturnValue().Set(val);

bool hasProperty = FF_HAS(obj, "aProperty");
bool hasProperty = Nan::HasOwnProperty(obj, Nan::New("aProperty").ToLocalChecked()).FromJust();

Convert and typecheck native types

Required arguments:

Cast argument n to native type or throw a meaningful type error.

/* FF_ARG_type(arg number, variable declaration) */

FF_ARG_BOOL(0, bool aBool);
FF_ARG_NUMBER(1, double aNumber);
FF_ARG_UINT(2, uint anUint);
FF_ARG_INT(3, int anInt);
FF_ARG_STRING(4, std::string aString);
FF_ARG_ARRAY(5, FF_ARR anArray);
FF_ARG_OBJ(6, FF_OBJ anObject);

For example:

NAN_METHOD(aClass::aMethodName) {
  FF_METHOD_CONTEXT("aMethodName");
  FF_ARG_NUMBER(0, double arg);
}

invoked like this:

// will not throw
module.aMethodName(0.1);
module.aMethodName(1);
module.aMethodName(-1);

// will throw: aMethodName - expected arg 0 to be of type: NUMBER
module.aMethodName(undefined);
module.aMethodName(null);
module.aMethodName(true);
module.aMethodName('aString');
module.aMethodName([]);
module.aMethodName({});

Optional arguments:

If defined, cast argument n to native type or throw a meaningful type error, else initialize with default value.

/* FF_ARG_type(arg number, variable declaration, default value) */

FF_ARG_BOOL_IFDEF(0, bool aBool, true);
FF_ARG_NUMBER_IFDEF(1, double aNumber, 0.1);
FF_ARG_UINT_IFDEF(2, uint anUint, 1);
FF_ARG_INT_IFDEF(3, int anInt, -1);
FF_ARG_STRING_IFDEF(4, std::string aString, "foo");
FF_ARG_ARRAY_IFDEF(5, FF_ARR anArray, FF_NEW_ARRAY(0));
FF_ARG_OBJ_IFDEF(6, FF_OBJ anObject, FF_NEW_OBJECT())

For example:

NAN_METHOD(aClass::aMethodName) {
  FF_METHOD_CONTEXT("aMethodName");
  FF_ARG_NUMBER(0, double arg0);
  FF_ARG_NUMBER_IFDEF(1, double arg1, 0.1);
}

invoked like this:

// will not throw
module.aMethodName(0.1, 1);
module.aMethodName(0.1, -1);
module.aMethodName(0.1, 0.1);

// will not throw and set arg 1 to the default value
module.aMethodName(0.1);

// will throw: aMethodName - expected arg 1 to be of type: NUMBER
module.aMethodName(0.1, undefined);
module.aMethodName(0.1, null);
module.aMethodName(0.1, true);
module.aMethodName(0.1, 'aString');
module.aMethodName(0.1, []);
module.aMethodName(0.1, {});

Typechecked conversion between arrays and std::vectors

// unpack v8::Local<v8::Array> to std::vector<double> vec
FF_ARR someArray = ...
FF_UNPACK_NUMBER_ARRAY(vec, someArray);

// convert numberVec to a v8::Local<v8::Array>
std::vector<double> numberVec = ...
FF_PACK_ARRAY(theNumberArray, numberVec);

// convert stringVec to a v8::Local<v8::Array>
std::vector<std::string> stringVec = ...
FF_PACK_STRING_ARRAY(theStringArray, stringVec);