1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: rewrite "addons" docs to use node-gyp

Browse Source 
Closes #3100.
Closes #3101.
This commit is contained in:
Zachary Scott 2012-04-12 20:24:35 -04:00 committed by Nathan Rajlich
parent 1444801374
commit 46acb09ed8
1 changed files with 37 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
doc/api/addons.markdown
View File

@ -60,40 +60,38 @@ The `module_name` needs to match the filename of the final binary (minus the
.node suffix). .node suffix).
The source code needs to be built into `hello.node`, the binary Addon. To The source code needs to be built into `hello.node`, the binary Addon. To
do this we create a file called `wscript` which is python code and looks do this we create a file called `binding.gyp` which describes the configuration
like this: to build your module in a JSON-like format. This file gets compiled by
[node-gyp](https://github.com/TooTallNate/node-gyp).
srcdir = '.' {
blddir = 'build' "targets": [
VERSION = '0.0.1' {
"target_name": "hello",
"sources": [ "hello.cc" ]
}
]
}
def set_options(opt): The next step is to generate the appropriate project build files for the
opt.tool_options('compiler_cxx') current platform. Use `node-gyp configure` for that.
def configure(conf): Now you will have either a `Makefile` (on Unix platforms) or a `vcxproj` file
conf.check_tool('compiler_cxx') (on Windows) in the `build/` directory. Next invoke the `node-gyp build`
conf.check_tool('node_addon') command.
def build(bld): Now you have your compiled `.node` bindings file! The compiled bindings end up
obj = bld.new_task_gen('cxx', 'shlib', 'node_addon') in `build/Release/`.
obj.target = 'hello'
obj.source = 'hello.cc'
Running `node-waf configure build` will create a file
`build/default/hello.node` which is our Addon.
`node-waf` is just [WAF](http://code.google.com/p/waf), the python-based build system. `node-waf` is
provided for the ease of users.
You can now use the binary addon in a Node project `hello.js` by pointing `require` to You can now use the binary addon in a Node project `hello.js` by pointing `require` to
the recently built module: the recently built `hello.node` module:
var addon = require('./build/Release/hello'); var addon = require('./build/Release/hello');
console.log(addon.hello()); // 'world' console.log(addon.hello()); // 'world'
Please see patterns below for further information or Please see patterns below for further information or
<https://github.com/pietern/hiredis-node> for an example in production. <https://github.com/arturadib/node-qt> for an example in production.
## Addon patterns ## Addon patterns
@ -104,29 +102,27 @@ calls, and v8's [Embedder's Guide](http://code.google.com/apis/v8/embed.html)
for an explanation of several concepts used such as handles, scopes, for an explanation of several concepts used such as handles, scopes,
function templates, etc. function templates, etc.
To compile these examples, create the `wscript` file below and run In order to use these examples you need to compile them using `node-gyp`.
`node-waf configure build`: Create the following `binding.gyp` file:
srcdir = '.' {
blddir = 'build' "targets": [
VERSION = '0.0.1' {
"target_name": "addon",
def set_options(opt): "sources": [ "addon.cc" ]
opt.tool_options('compiler_cxx') }
]
def configure(conf): }
conf.check_tool('compiler_cxx')
conf.check_tool('node_addon')
def build(bld):
obj = bld.new_task_gen('cxx', 'shlib', 'node_addon')
obj.target = 'addon'
obj.source = ['addon.cc']
In cases where there is more than one `.cc` file, simply add the file name to the In cases where there is more than one `.cc` file, simply add the file name to the
`obj.source` array, e.g.: `sources` array, e.g.:
obj.source = ['addon.cc', 'myexample.cc'] "sources": ["addon.cc", "myexample.cc"]
Now that you have your `binding.gyp` ready, you can configure and build the
addon:
$ node-gyp configure build
### Function arguments ### Function arguments