mnm

mnm

Make Node Module is a build tool for making native node.js modules.

Installation

$ npm install mnm

Quick Examples

var builder = new Builder();

builder.appendUnique('CXXFLAGS', ['-fno-builtin']);
builder.appendIncludeDir('src/');
builder.appendSourceDir('./src');
builder.target = "mynativemodule_bindings";

builder.run();

Realworld Examples

• node-java - A node.js to Java bridge.
• node-shark - Wrapper around libwireshark providing network packet dissection.
• node-oracle - node.js driver to connect with an oracle database.

Index

command line arguments

• -v - Verbose
• -Wall - Show Warnings

builder

• appendLinkerLibrary
• appendLinkerSearchDir
• appendIncludeDir
• appendUnique
• appendSourceDir
• appendSource
• compile
• link
• compileAndLink
• run

API Documentation

## command line ### verbose -v or --verbose

Prints the command lines being executed along with other verbose output.

### -Wall or --showWarnings

Adds the -Wall flag to the compile and prints all compiler warnings.

## builder ### builder.appendLinkerLibrary(libname)

Adds a library to the linker.

Arguments

• libname - The name of the library to add. This string should not contain the lib prefix or the extension.

Example

builder.appendLinkerLibrary('ssl');

### builder.appendLinkerSearchDir(dir)

Adds a library to the linker search path.

Arguments

• dir - The directory to add to the search path.

Example

builder.appendLinkerSearchDir('/usr/local/lib');

### builder.appendIncludeDir(dir)

Adds a path to the list of include search directories.

Arguments

• dir - The directory to add to the search path.

Example

builder.builder_appendIncludeDir('/src');

### builder.appendUnique(flagGroup, flags)

Adds a flag or flags to a flag group.

Arguments

• flagGroup - The flag group to add the flags to. This should be LINKFLAGS or CXXFLAGS.
• flags - A single string or array of strings to add to the group.

Example

builder.appendUnique('CXXFLAGS', '-Wall');
builder.appendUnique('CXXFLAGS', ['-Idir1', '-Idir2']);

### builder.appendSourceDir(dir)

Adds a source code directory to the list of compilable items. All files with the extensions cpp, c, cxx will be added to the compile step.

Arguments

• dir - The path to the directory containing the source files.

Example

builder.appendSourceDir('./src');

### builder.appendSource(fileName)

Adds a single source file to the list of compilable items.

Arguments

• fileName - The name of the file to compile.

Example

builder.appendSource('./src/myModule.cpp');

### builder.compile([callback])

Performs the compile.

Arguments

• callback (optional) - An optional callback to be called when the compile is complete.

Example

builder.compile();

### builder.link([callback])

Performs the link.

Arguments

• callback (optional) - An optional callback to be called when the link is complete.

Example

builder.link();

### builder.compileAndLink([callback])

Performs the compile and link.

Arguments

• callback (optional) - An optional callback to be called when the compile and link is complete.

Example

builder.compileAndLink();

### builder.run([options], [callback])

Run the builder. If no options are specified will use command line arguments to determine what to do.

Arguments

• options (optional) - An object containing the following options
• verbose - true to be verbose
• showWarnings - true to show all compiler warnings
• action - set to one of the following actions
• build - compile and link the project
• compile - just perform the compile step.
• link - just perform the link step.
• callback (optional) - An optional callback to be called when the run is complete.

Example

builder.compileAndLink();

License

(The MIT License)

Copyright (c) 2012 Near Infinity Corporation

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.