time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

cli (4823B)


      1 #!/usr/bin/env node
      2 
      3 /**
      4 * @license Apache-2.0
      5 *
      6 * Copyright (c) 2018 The Stdlib Authors.
      7 *
      8 * Licensed under the Apache License, Version 2.0 (the "License");
      9 * you may not use this file except in compliance with the License.
     10 * You may obtain a copy of the License at
     11 *
     12 *    http://www.apache.org/licenses/LICENSE-2.0
     13 *
     14 * Unless required by applicable law or agreed to in writing, software
     15 * distributed under the License is distributed on an "AS IS" BASIS,
     16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     17 * See the License for the specific language governing permissions and
     18 * limitations under the License.
     19 */
     20 
     21 'use strict';
     22 
     23 // MODULES //
     24 
     25 var proc = require( 'process' );
     26 var resolve = require( 'path' ).resolve;
     27 var readFileSync = require( '@stdlib/fs/read-file' ).sync;
     28 var writeFileSync = require( '@stdlib/fs/write-file' ).sync;
     29 var CLI = require( '@stdlib/cli/ctor' );
     30 var stdout = require( '@stdlib/streams/node/stdout' );
     31 var cwd = require( '@stdlib/process/cwd' );
     32 var Uint8Array = require( '@stdlib/array/uint8' );
     33 var Uint32Array = require( '@stdlib/array/uint32' );
     34 var isUint8Array = require( '@stdlib/assert/is-uint8array' );
     35 var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
     36 var gcopy = require( '@stdlib/blas/base/gcopy' );
     37 var array2buffer = require( '@stdlib/buffer/from-array' );
     38 var randomStream = require( './../lib' );
     39 var DEFAULTS = require( './../lib/defaults.json' );
     40 
     41 
     42 // VARIABLES //
     43 
     44 var ctors = {
     45 	'box-muller': Uint32Array,
     46 	'improved-ziggurat': Uint32Array
     47 };
     48 
     49 
     50 // FUNCTIONS //
     51 
     52 /**
     53 * Callback invoked once a source stream ends.
     54 *
     55 * @private
     56 */
     57 function onEnd() {
     58 	// Append a trailing newline in accordance with standard POSIX behavior:
     59 	console.log( '' ); // eslint-disable-line no-console
     60 }
     61 
     62 /**
     63 * Attempts to load a PRNG state.
     64 *
     65 * @private
     66 * @param {string} filepath - absolute path to file containing PRNG state
     67 * @param {string} name - PRNG name
     68 * @returns {(Uint32Array|Int32Array|Error)} PRNG state or an error
     69 */
     70 function loadState( filepath, name ) {
     71 	var state;
     72 	var ctor;
     73 	var len;
     74 
     75 	state = readFileSync( filepath );
     76 	if ( state instanceof Error ) {
     77 		return state;
     78 	}
     79 	len = state.length;
     80 
     81 	// For older Node.js environments, convert the `Buffer` to a `Uint8Array`...
     82 	if ( !isUint8Array( state ) ) {
     83 		state = gcopy( len, state, 1, new Uint8Array( len ), 1 );
     84 	}
     85 	// Create a PRNG state array "view":
     86 	ctor = ctors[ name ];
     87 	len /= ctor.BYTES_PER_ELEMENT;
     88 	if ( !isInteger( len ) ) {
     89 		return new RangeError( 'invalid option. `state` has an invalid length.' );
     90 	}
     91 	return new ctor( state.buffer, state.byteOffset, len );
     92 }
     93 
     94 
     95 // MAIN //
     96 
     97 /**
     98 * Main execution sequence.
     99 *
    100 * @private
    101 * @returns {void}
    102 */
    103 function main() {
    104 	var stream;
    105 	var flags;
    106 	var opts;
    107 	var cli;
    108 	var dir;
    109 	var i;
    110 
    111 	// Create a command-line interface:
    112 	cli = new CLI({
    113 		'pkg': require( './../package.json' ),
    114 		'options': require( './../etc/cli_opts.json' ),
    115 		'help': readFileSync( resolve( __dirname, '..', 'docs', 'usage.txt' ), {
    116 			'encoding': 'utf8'
    117 		})
    118 	});
    119 
    120 	// Get any provided command-line options:
    121 	flags = cli.flags();
    122 	if ( flags.help || flags.version ) {
    123 		return;
    124 	}
    125 
    126 	// Get the current working directory:
    127 	dir = cwd();
    128 
    129 	opts = {};
    130 	if ( flags.iter ) {
    131 		opts.iter = parseInt( flags.iter, 10 );
    132 	}
    133 	if ( flags.sep ) {
    134 		opts.sep = flags.sep;
    135 	}
    136 	if ( flags.name ) {
    137 		opts.name = flags.name;
    138 	}
    139 	if ( flags.state ) {
    140 		opts.state = loadState( resolve( dir, flags.state ), opts.name || DEFAULTS.name ); // eslint-disable-line max-len
    141 		if ( opts.state instanceof Error ) {
    142 			return onError( opts.state );
    143 		}
    144 	} else if ( flags.seed ) {
    145 		opts.seed = flags.seed.split( ',' );
    146 		for ( i = 0; i < opts.seed.length; i++ ) {
    147 			opts.seed[ i ] = parseInt( opts.seed[ i ], 10 );
    148 		}
    149 	}
    150 	if ( flags.snapshot ) {
    151 		proc.on( 'exit', onExit );
    152 	}
    153 
    154 	// Create a source stream and pipe to `stdout`:
    155 	stream = randomStream( opts );
    156 	stream.on( 'end', onEnd );
    157 
    158 	stream.pipe( stdout );
    159 
    160 	/**
    161 	* Callback invoked upon exiting the process.
    162 	*
    163 	* @private
    164 	* @param {integer} code - exit code
    165 	*/
    166 	function onExit( code ) {
    167 		var state;
    168 		var err;
    169 
    170 		// Get the current PRNG state:
    171 		state = stream.state;
    172 
    173 		// Create a byte array "view":
    174 		state = new Uint8Array( state.buffer, state.byteOffset, stream.byteLength ); // eslint-disable-line max-len
    175 
    176 		// Convert the byte array to a `Buffer` (with support for older Node.js environments):
    177 		state = array2buffer( state );
    178 
    179 		// Attempt to write the state to file:
    180 		err = writeFileSync( resolve( dir, flags.snapshot ), state );
    181 		if ( err ) {
    182 			onError( err, code || 1 );
    183 		}
    184 	}
    185 
    186 	/**
    187 	* Callback invoked upon encountering an error.
    188 	*
    189 	* @private
    190 	* @param {Error} error - error
    191 	* @param {integer} [code] - exit code
    192 	*/
    193 	function onError( error, code ) {
    194 		cli.error( error, code || 1 );
    195 	}
    196 }
    197 
    198 main();