[Pkg-javascript-commits] [node-bindings] 01/02: Imported Upstream version 1.2.1
Andrew Kelley
andrewrk-guest at moszumanska.debian.org
Sat Jun 28 18:30:06 UTC 2014
This is an automated email from the git hooks/post-receive script.
andrewrk-guest pushed a commit to branch master
in repository node-bindings.
commit cbc11422797712bb814b61689f818184d8b4be73
Author: Andrew Kelley <superjoe30 at gmail.com>
Date: Sat Jun 28 18:23:01 2014 +0000
Imported Upstream version 1.2.1
---
README.md | 97 ++++++++++++++++++++++++++++++++++
bindings.js | 166 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
package.json | 25 +++++++++
3 files changed, 288 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..585cf51
--- /dev/null
+++ b/README.md
@@ -0,0 +1,97 @@
+node-bindings
+=============
+### Helper module for loading your native module's .node file
+
+This is a helper module for authors of Node.js native addon modules.
+It is basically the "swiss army knife" of `require()`ing your native module's
+`.node` file.
+
+Throughout the course of Node's native addon history, addons have ended up being
+compiled in a variety of different places, depending on which build tool and which
+version of node was used. To make matters worse, now the _gyp_ build tool can
+produce either a _Release_ or _Debug_ build, each being built into different
+locations.
+
+This module checks _all_ the possible locations that a native addon would be built
+at, and returns the first one that loads successfully.
+
+
+Installation
+------------
+
+Install with `npm`:
+
+``` bash
+$ npm install bindings
+```
+
+Or add it to the `"dependencies"` section of your _package.json_ file.
+
+
+Example
+-------
+
+`require()`ing the proper bindings file for the current node version, platform
+and architecture is as simple as:
+
+``` js
+var bindings = require('bindings')('binding.node')
+
+// Use your bindings defined in your C files
+bindings.your_c_function()
+```
+
+
+Nice Error Output
+-----------------
+
+When the `.node` file could not be loaded, `node-bindings` throws an Error with
+a nice error message telling you exactly what was tried. You can also check the
+`err.tries` Array property.
+
+```
+Error: Could not load the bindings file. Tried:
+ → /Users/nrajlich/ref/build/binding.node
+ → /Users/nrajlich/ref/build/Debug/binding.node
+ → /Users/nrajlich/ref/build/Release/binding.node
+ → /Users/nrajlich/ref/out/Debug/binding.node
+ → /Users/nrajlich/ref/Debug/binding.node
+ → /Users/nrajlich/ref/out/Release/binding.node
+ → /Users/nrajlich/ref/Release/binding.node
+ → /Users/nrajlich/ref/build/default/binding.node
+ → /Users/nrajlich/ref/compiled/0.8.2/darwin/x64/binding.node
+ at bindings (/Users/nrajlich/ref/node_modules/bindings/bindings.js:84:13)
+ at Object.<anonymous> (/Users/nrajlich/ref/lib/ref.js:5:47)
+ at Module._compile (module.js:449:26)
+ at Object.Module._extensions..js (module.js:467:10)
+ at Module.load (module.js:356:32)
+ at Function.Module._load (module.js:312:12)
+ ...
+```
+
+
+License
+-------
+
+(The MIT License)
+
+Copyright (c) 2012 Nathan Rajlich <nathan at tootallnate.net>
+
+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.
diff --git a/bindings.js b/bindings.js
new file mode 100644
index 0000000..93dcf85
--- /dev/null
+++ b/bindings.js
@@ -0,0 +1,166 @@
+
+/**
+ * Module dependencies.
+ */
+
+var fs = require('fs')
+ , path = require('path')
+ , join = path.join
+ , dirname = path.dirname
+ , exists = fs.existsSync || path.existsSync
+ , defaults = {
+ arrow: process.env.NODE_BINDINGS_ARROW || ' → '
+ , compiled: process.env.NODE_BINDINGS_COMPILED_DIR || 'compiled'
+ , platform: process.platform
+ , arch: process.arch
+ , version: process.versions.node
+ , bindings: 'bindings.node'
+ , try: [
+ // node-gyp's linked version in the "build" dir
+ [ 'module_root', 'build', 'bindings' ]
+ // node-waf and gyp_addon (a.k.a node-gyp)
+ , [ 'module_root', 'build', 'Debug', 'bindings' ]
+ , [ 'module_root', 'build', 'Release', 'bindings' ]
+ // Debug files, for development (legacy behavior, remove for node v0.9)
+ , [ 'module_root', 'out', 'Debug', 'bindings' ]
+ , [ 'module_root', 'Debug', 'bindings' ]
+ // Release files, but manually compiled (legacy behavior, remove for node v0.9)
+ , [ 'module_root', 'out', 'Release', 'bindings' ]
+ , [ 'module_root', 'Release', 'bindings' ]
+ // Legacy from node-waf, node <= 0.4.x
+ , [ 'module_root', 'build', 'default', 'bindings' ]
+ // Production "Release" buildtype binary (meh...)
+ , [ 'module_root', 'compiled', 'version', 'platform', 'arch', 'bindings' ]
+ ]
+ }
+
+/**
+ * The main `bindings()` function loads the compiled bindings for a given module.
+ * It uses V8's Error API to determine the parent filename that this function is
+ * being invoked from, which is then used to find the root directory.
+ */
+
+function bindings (opts) {
+
+ // Argument surgery
+ if (typeof opts == 'string') {
+ opts = { bindings: opts }
+ } else if (!opts) {
+ opts = {}
+ }
+ opts.__proto__ = defaults
+
+ // Get the module root
+ if (!opts.module_root) {
+ opts.module_root = exports.getRoot(exports.getFileName())
+ }
+
+ // Ensure the given bindings name ends with .node
+ if (path.extname(opts.bindings) != '.node') {
+ opts.bindings += '.node'
+ }
+
+ var tries = []
+ , i = 0
+ , l = opts.try.length
+ , n
+ , b
+ , err
+
+ for (; i<l; i++) {
+ n = join.apply(null, opts.try[i].map(function (p) {
+ return opts[p] || p
+ }))
+ tries.push(n)
+ try {
+ b = opts.path ? require.resolve(n) : require(n)
+ if (!opts.path) {
+ b.path = n
+ }
+ return b
+ } catch (e) {
+ if (!/not find/i.test(e.message)) {
+ throw e
+ }
+ }
+ }
+
+ err = new Error('Could not locate the bindings file. Tried:\n'
+ + tries.map(function (a) { return opts.arrow + a }).join('\n'))
+ err.tries = tries
+ throw err
+}
+module.exports = exports = bindings
+
+
+/**
+ * Gets the filename of the JavaScript file that invokes this function.
+ * Used to help find the root directory of a module.
+ * Optionally accepts an filename argument to skip when searching for the invoking filename
+ */
+
+exports.getFileName = function getFileName (calling_file) {
+ var origPST = Error.prepareStackTrace
+ , origSTL = Error.stackTraceLimit
+ , dummy = {}
+ , fileName
+
+ Error.stackTraceLimit = 10
+
+ Error.prepareStackTrace = function (e, st) {
+ for (var i=0, l=st.length; i<l; i++) {
+ fileName = st[i].getFileName()
+ if (fileName !== __filename) {
+ if (calling_file) {
+ if (fileName !== calling_file) {
+ return
+ }
+ } else {
+ return
+ }
+ }
+ }
+ }
+
+ // run the 'prepareStackTrace' function above
+ Error.captureStackTrace(dummy)
+ dummy.stack
+
+ // cleanup
+ Error.prepareStackTrace = origPST
+ Error.stackTraceLimit = origSTL
+
+ return fileName
+}
+
+/**
+ * Gets the root directory of a module, given an arbitrary filename
+ * somewhere in the module tree. The "root directory" is the directory
+ * containing the `package.json` file.
+ *
+ * In: /home/nate/node-native-module/lib/index.js
+ * Out: /home/nate/node-native-module
+ */
+
+exports.getRoot = function getRoot (file) {
+ var dir = dirname(file)
+ , prev
+ while (true) {
+ if (dir === '.') {
+ // Avoids an infinite loop in rare cases, like the REPL
+ dir = process.cwd()
+ }
+ if (exists(join(dir, 'package.json')) || exists(join(dir, 'node_modules'))) {
+ // Found the 'package.json' file or 'node_modules' dir; we're done
+ return dir
+ }
+ if (prev === dir) {
+ // Got to the top
+ throw new Error('Could not find module root given file: "' + file
+ + '". Do you have a `package.json` file? ')
+ }
+ // Try the parent dir next
+ prev = dir
+ dir = join(dir, '..')
+ }
+}
diff --git a/package.json b/package.json
new file mode 100644
index 0000000..f7daf93
--- /dev/null
+++ b/package.json
@@ -0,0 +1,25 @@
+{
+ "name": "bindings",
+ "description": "Helper module for loading your native module's .node file",
+ "keywords": [
+ "native",
+ "addon",
+ "bindings",
+ "gyp",
+ "waf",
+ "c",
+ "c++"
+ ],
+ "version": "1.2.1",
+ "author": "Nathan Rajlich <nathan at tootallnate.net> (http://tootallnate.net)",
+ "repository": {
+ "type": "git",
+ "url": "git://github.com/TooTallNate/node-bindings.git"
+ },
+ "main": "./bindings.js",
+ "bugs": {
+ "url": "https://github.com/TooTallNate/node-bindings/issues"
+ },
+ "homepage": "https://github.com/TooTallNate/node-bindings",
+ "license": "MIT"
+}
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-bindings.git
More information about the Pkg-javascript-commits
mailing list