bare-tty 3.2.4 → 3.3.0

package/README.md

@@ -3,7 +3,7 @@
 Native TTY streams for JavaScript.
 
 ```
-npm install bare-tty
+npm i bare-tty
 ```
 
 ## Usage

package/binding.c

@@ -22,7 +22,7 @@ typedef struct {
 } bare_tty_t;
 
 static void
-on_write (uv_write_t *req, int status) {
+bare_tty__on_write (uv_write_t *req, int status) {
   int err;
 
   bare_tty_t *tty = (bare_tty_t *) req->data;
@@ -66,7 +66,7 @@ on_write (uv_write_t *req, int status) {
 }
 
 static void
-on_read (uv_stream_t *stream, ssize_t nread, const uv_buf_t *buf) {
+bare_tty__on_read (uv_stream_t *stream, ssize_t nread, const uv_buf_t *buf) {
   if (nread == UV_EOF) nread = 0;
   else if (nread == 0) return;
 
@@ -119,7 +119,7 @@ on_read (uv_stream_t *stream, ssize_t nread, const uv_buf_t *buf) {
 }
 
 static void
-on_close (uv_handle_t *handle) {
+bare_tty__on_close (uv_handle_t *handle) {
   int err;
 
   bare_tty_t *tty = (bare_tty_t *) handle;
@@ -157,7 +157,7 @@ on_close (uv_handle_t *handle) {
 }
 
 static void
-on_alloc (uv_handle_t *handle, size_t suggested_size, uv_buf_t *buf) {
+bare_tty__on_alloc (uv_handle_t *handle, size_t suggested_size, uv_buf_t *buf) {
   bare_tty_t *tty = (bare_tty_t *) handle;
 
   *buf = tty->read;
@@ -258,7 +258,7 @@ bare_tty_writev (js_env_t *env, js_callback_info_t *info) {
 
   req->data = tty;
 
-  err = uv_write(req, (uv_stream_t *) &tty->handle, bufs, bufs_len, on_write);
+  err = uv_write(req, (uv_stream_t *) &tty->handle, bufs, bufs_len, bare_tty__on_write);
 
   free(bufs);
 
@@ -286,7 +286,7 @@ bare_tty_resume (js_env_t *env, js_callback_info_t *info) {
   err = js_get_arraybuffer_info(env, argv[0], (void **) &tty, NULL);
   assert(err == 0);
 
-  err = uv_read_start((uv_stream_t *) &tty->handle, on_alloc, on_read);
+  err = uv_read_start((uv_stream_t *) &tty->handle, bare_tty__on_alloc, bare_tty__on_read);
 
   if (err < 0) {
     js_throw_error(env, uv_err_name(err), uv_strerror(err));
@@ -344,7 +344,7 @@ bare_tty_close (js_env_t *env, js_callback_info_t *info) {
   // close an output stream.
   (void) err;
 
-  uv_close((uv_handle_t *) &tty->handle, on_close);
+  uv_close((uv_handle_t *) &tty->handle, bare_tty__on_close);
 
   return NULL;
 }
@@ -448,66 +448,45 @@ bare_tty_is_tty (js_env_t *env, js_callback_info_t *info) {
 }
 
 static js_value_t *
-init (js_env_t *env, js_value_t *exports) {
-  {
-    js_value_t *fn;
-    js_create_function(env, "init", -1, bare_tty_init, NULL, &fn);
-    js_set_named_property(env, exports, "init", fn);
-  }
-  {
-    js_value_t *fn;
-    js_create_function(env, "writev", -1, bare_tty_writev, NULL, &fn);
-    js_set_named_property(env, exports, "writev", fn);
-  }
-  {
-    js_value_t *fn;
-    js_create_function(env, "resume", -1, bare_tty_resume, NULL, &fn);
-    js_set_named_property(env, exports, "resume", fn);
-  }
-  {
-    js_value_t *fn;
-    js_create_function(env, "pause", -1, bare_tty_pause, NULL, &fn);
-    js_set_named_property(env, exports, "pause", fn);
-  }
-  {
-    js_value_t *fn;
-    js_create_function(env, "close", -1, bare_tty_close, NULL, &fn);
-    js_set_named_property(env, exports, "close", fn);
-  }
-  {
-    js_value_t *fn;
-    js_create_function(env, "setMode", -1, bare_tty_set_mode, NULL, &fn);
-    js_set_named_property(env, exports, "setMode", fn);
-  }
-  {
-    js_value_t *fn;
-    js_create_function(env, "getWindowSize", -1, bare_tty_get_window_size, NULL, &fn);
-    js_set_named_property(env, exports, "getWindowSize", fn);
-  }
-  {
-    js_value_t *fn;
-    js_create_function(env, "isTTY", -1, bare_tty_is_tty, NULL, &fn);
-    js_set_named_property(env, exports, "isTTY", fn);
-  }
-  {
-    js_value_t *val;
-    js_create_uint32(env, UV_TTY_MODE_NORMAL, &val);
-    js_set_named_property(env, exports, "MODE_NORMAL", val);
+bare_tty_exports (js_env_t *env, js_value_t *exports) {
+  int err;
+
+#define V(name, fn) \
+  { \
+    js_value_t *val; \
+    err = js_create_function(env, name, -1, fn, NULL, &val); \
+    assert(err == 0); \
+    err = js_set_named_property(env, exports, name, val); \
+    assert(err == 0); \
   }
-  {
-    js_value_t *val;
-    js_create_uint32(env, UV_TTY_MODE_RAW, &val);
-    js_set_named_property(env, exports, "MODE_RAW", val);
+
+  V("init", bare_tty_init)
+  V("writev", bare_tty_writev)
+  V("resume", bare_tty_resume)
+  V("pause", bare_tty_pause)
+  V("close", bare_tty_close)
+  V("setMode", bare_tty_set_mode)
+  V("getWindowSize", bare_tty_get_window_size)
+  V("isTTY", bare_tty_is_tty)
+#undef V
+
+#define V(name, n) \
+  { \
+    js_value_t *val; \
+    err = js_create_uint32(env, n, &val); \
+    assert(err == 0); \
+    err = js_set_named_property(env, exports, name, val); \
+    assert(err == 0); \
   }
+
+  V("MODE_NORMAL", UV_TTY_MODE_NORMAL)
+  V("MODE_RAW", UV_TTY_MODE_RAW)
 #ifndef _WIN32
-  {
-    js_value_t *val;
-    js_create_uint32(env, UV_TTY_MODE_IO, &val);
-    js_set_named_property(env, exports, "MODE_IO", val);
-  }
+  V("MODE_IO", UV_TTY_MODE_IO)
 #endif
+#undef V
 
   return exports;
 }
 
-BARE_MODULE(bare_tty, init)
+BARE_MODULE(bare_tty, bare_tty_exports)

package/index.js

@@ -1,24 +1,25 @@
 /* global Bare */
 const { Readable, Writable } = require('streamx')
 const binding = require('./binding')
+const constants = require('./lib/constants')
 
-const DEFAULT_READ_BUFFER = 65536
+const defaultReadBufferSize = 65536
 
 exports.ReadStream = class TTYReadStream extends Readable {
   constructor (fd, opts = {}) {
     super()
 
     const {
-      readBufferSize = DEFAULT_READ_BUFFER,
+      readBufferSize = defaultReadBufferSize,
       allowHalfOpen = true
     } = opts
 
-    this._pendingDestroy = null
+    this._state = 0
 
-    this._reading = false
-    this._closing = false
     this._allowHalfOpen = allowHalfOpen
 
+    this._pendingDestroy = null
+
     this._buffer = Buffer.alloc(readBufferSize)
 
     this._handle = binding.init(fd, this._buffer, this,
@@ -39,27 +40,28 @@ exports.ReadStream = class TTYReadStream extends Readable {
   }
 
   setRawMode (mode) {
-    this.setMode(mode ? constants.MODE_RAW : constants.MODE_NORMAL)
+    this.setMode(mode ? constants.mode.RAW : constants.mode.NORMAL)
   }
 
   _read (cb) {
-    if (!this._reading) {
-      this._reading = true
+    if ((this._state & constants.state.READING) === 0) {
+      this._state |= constants.state.READING
       binding.resume(this._handle)
     }
+
     cb(null)
   }
 
   _predestroy () {
-    if (this._closing) return
-    this._closing = true
+    if (this._state & constants.state.CLOSING) return
+    this._state |= constants.state.CLOSING
     binding.close(this._handle)
     TTYReadStream._streams.delete(this)
   }
 
   _destroy (cb) {
-    if (this._closing) return cb(null)
-    this._closing = true
+    if (this._state & constants.state.CLOSING) return cb(null)
+    this._state |= constants.state.CLOSING
     this._pendingDestroy = cb
     binding.close(this._handle)
     TTYReadStream._streams.delete(this)
@@ -88,7 +90,7 @@ exports.ReadStream = class TTYReadStream extends Readable {
     copy.set(this._buffer.subarray(0, read))
 
     if (this.push(copy) === false && this.destroying === false) {
-      this._reading = false
+      this._state &= ~constants.state.READING
       binding.pause(this._handle)
     }
   }
@@ -105,11 +107,11 @@ exports.WriteStream = class TTYWriteStream extends Writable {
   constructor (fd, opts = {}) {
     super({ mapWritable })
 
+    this._state = 0
+
     this._pendingWrite = null
     this._pendingDestroy = null
 
-    this._closing = false
-
     this._handle = binding.init(fd, empty, this,
       this._onwrite,
       noop,
@@ -133,15 +135,15 @@ exports.WriteStream = class TTYWriteStream extends Writable {
   }
 
   _predestroy () {
-    if (this._closing) return
-    this._closing = true
+    if (this._state & constants.state.CLOSING) return
+    this._state |= constants.state.CLOSING
     binding.close(this._handle)
     TTYWriteStream._streams.delete(this)
   }
 
   _destroy (cb) {
-    if (this._closing) return cb(null)
-    this._closing = true
+    if (this._state & constants.state.CLOSING) return cb(null)
+    this._state |= constants.state.CLOSING
     this._pendingDestroy = cb
     binding.close(this._handle)
     TTYWriteStream._streams.delete(this)
@@ -165,27 +167,6 @@ exports.WriteStream = class TTYWriteStream extends Writable {
     this._continueWrite(err)
   }
 
-  _onread (err, read) {
-    if (err) {
-      this.destroy(err)
-      return
-    }
-
-    if (read === 0) {
-      this.push(null)
-      if (this._allowHalfOpen === false) this.end()
-      return
-    }
-
-    const copy = Buffer.allocUnsafe(read)
-    copy.set(this._buffer.subarray(0, read))
-
-    if (this.push(copy) === false && this.destroying === false) {
-      this._reading = false
-      binding.pause(this._handle)
-    }
-  }
-
   _onclose () {
     this._handle = null
     this._continueDestroy()
@@ -194,13 +175,9 @@ exports.WriteStream = class TTYWriteStream extends Writable {
   static _streams = new Set()
 }
 
-exports.isTTY = binding.isTTY
+exports.constants = constants
 
-const constants = exports.constants = {
-  MODE_NORMAL: binding.MODE_NORMAL,
-  MODE_RAW: binding.MODE_RAW,
-  MODE_IO: binding.MODE_IO || 0
-}
+exports.isTTY = binding.isTTY
 
 Bare
   .on('exit', () => {

package/lib/constants.js

@@ -0,0 +1,21 @@
+const binding = require('../binding')
+
+module.exports = exports = {
+  mode: {
+    NORMAL: binding.MODE_NORMAL,
+    RAW: binding.MODE_RAW,
+    IO: binding.MODE_IO || 0
+  },
+
+  state: {
+    READING: 0x1,
+    CLOSING: 0x2
+  }
+}
+
+/** @deprecated Use `mode.NORMAL` */
+exports.MODE_NORMAL = exports.mode.NORMAL
+/** @deprecated Use `mode.RAW` */
+exports.MODE_RAW = exports.mode.RAW
+/** @deprecated Use `mode.IO` */
+exports.MODE_IO = exports.mode.IO

package/package.json

@@ -1,13 +1,18 @@
 {
   "name": "bare-tty",
-  "version": "3.2.4",
+  "version": "3.3.0",
   "description": "Native TTY streams for JavaScript",
-  "main": "index.js",
+  "exports": {
+    ".": "./index.js",
+    "./package": "./package.json",
+    "./constants": "./lib/constants.js"
+  },
   "files": [
     "index.js",
     "binding.c",
     "binding.js",
     "CMakeLists.txt",
+    "lib",
     "prebuilds"
   ],
   "addon": true,