tcl

node-tcl

Node.js Tcl bindings to execute Tcl commands using a native Tcl Interpreter.

Installation

Prerequisites : You will need to have tcl-dev packages installed on your system (e.g. sudo apt-get install tcl-dev) for the Node.js native addon to link to along with a c++11 compatible compiler (e.g. g++ v4.8).

$ npm install --save tcl

Usage

You can execute any Tcl command supported by the Tcl shell (tchsh) and you can even load native Tcl modeles (load module.so), source scripts (source filename.tcl) and source Tcl libraries (package require name).

Note : Asynchronous commands (cmd and eval) are executed usng a dedicated worker thread using a new Tcl Interpreter instance and comes with the overhead of creating and destroying a Tcl Interpreter for each call. But these executions are parallel and useful for batched tasks.

var tcl = require( 'tcl' );

// synchronous commands
console.log( tcl.version() );
console.log( tcl.cmdSync( 'info tclversion' ) );
console.log( tcl.evalSync( 'info tclversion' ) );


// asynchronous commands (parallelly executed in decated threads)
tcl.cmd( 'info tclversion', function ( err, result ) {
	console.log( result.data() );
} );

tcl.eval( 'info commands', function ( err, result ) {
	console.log( result.toArray() );
} );


// queued asynchronous commands (executed in a shared thread)
tcl.queue( 'set x 0' );
tcl.queue( 'incr $x', function ( err, result ) {
	console.log( result );
} );

var Tcl = require( 'tcl' ).Tcl;
var tcl = new Tcl();

console.log( tcl.version() );

API Documentation

JSDoc generated API documentation can be found at http://nukedzn.github.io/node-tcl/docs/.

Contributing

Contributions are welcome through GitHub pull requests (using fork & pull model).