node/lib/readline.js

// Inspiration for this code comes from Salvatore Sanfilippo's linenoise.
// http://github.com/antirez/linenoise
// Reference:
// * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
// * http://www.3waylabs.com/nw/WWW/products/wizcon/vt220.html

var kHistorySize = 30;
var kBufSize = 10 * 1024;

var util = require('util');
var inherits = require('util').inherits;
var EventEmitter = require('events').EventEmitter;
var tty = require('tty');


exports.createInterface = function(output, completer) {
  return new Interface(output, completer);
};

function writeFilter(stream) {
  if (stream._writeFiltered) return;
  stream._writeFiltered = true;
  stream._normalWrite = stream.write;
  stream.write = function(d) {
    var args = Array.prototype.slice.call(arguments);
    if (typeof d == 'string') {
      args[0] = d.replace(/([^\r])\n|^\n/g, '$1\r\n');
    }
    // TODO what about buffers?
    return stream._normalWrite.apply(stream, args);
  }
}

function Interface(output, completer) {
  if (!(this instanceof Interface)) return new Interface(output, completer);
  EventEmitter.call(this);

  this.output = output;
  this.completer = completer;

  this.setPrompt('> ');

  this.enabled = tty.isatty(output.fd);

  if (parseInt(process.env['NODE_NO_READLINE'], 10)) {
    this.enabled = false;
  }

  if (this.enabled) {
    // input refers to stdin

    writeFilter(this.output);
    writeFilter(process.stdout);

    // Current line
    this.line = '';

    // Check process.env.TERM ?
    tty.setRawMode(true);
    this.enabled = true;

    // Cursor position on the line.
    this.cursor = 0;

    this.history = [];
    this.historyIndex = -1;

    exports.columns = tty.getColumns();

    if (process.listeners('SIGWINCH').length === 0) {
      process.on('SIGWINCH', function() {
        exports.columns = tty.getColumns();
      });
    }
  }
}

inherits(Interface, EventEmitter);

Interface.prototype.__defineGetter__('columns', function() {
  return exports.columns;
});

Interface.prototype.setPrompt = function(prompt, length) {
  this._prompt = prompt;
  this._promptLength = length ? length : Buffer.byteLength(prompt);
};


Interface.prototype.prompt = function() {
  if (this.enabled) {
    this.cursor = 0;
    this._refreshLine();
  } else {
    this.output.write(this._prompt);
  }
};


Interface.prototype._addHistory = function() {
  if (this.line.length === 0) return '';

  this.history.unshift(this.line);
  this.line = '';
  this.historyIndex = -1;

  this.cursor = 0;

  // Only store so many
  if (this.history.length > kHistorySize) this.history.pop();

  return this.history[0];
};


Interface.prototype._refreshLine = function() {
  if (this._closed) return;

  // Cursor to left edge.
  this.output.write('\x1b[0G');

  // Write the prompt and the current buffer content.
  this.output.write(this._prompt);
  this.output.write(this.line);

  // Erase to right.
  this.output.write('\x1b[0K');

  // Move cursor to original position.
  this.output.write('\x1b[0G\x1b[' + (this._promptLength + this.cursor) + 'C');
};


Interface.prototype.close = function(d) {
  if (this.enabled) {
    tty.setRawMode(false);
  }
  this.emit('close');
  this._closed = true;
};


Interface.prototype.write = function(d) {
  if (this._closed) return;
  return this.enabled ? this._ttyWrite(d) : this._normalWrite(d);
};


Interface.prototype._normalWrite = function(b) {
  // Very simple implementation right now. Should try to break on
  // new lines.
  this.emit('line', b.toString());
};

Interface.prototype._insertString = function(c) {
  //BUG: Problem when adding tabs with following content.
  //     Perhaps the bug is in _refreshLine(). Not sure.
  //     A hack would be to insert spaces instead of literal '\t'.
  if (this.cursor < this.line.length) {
    var beg = this.line.slice(0, this.cursor);
    var end = this.line.slice(this.cursor, this.line.length);
    this.line = beg + c + end;
    this.cursor += c.length;
    this._refreshLine();
  } else {
    this.line += c;
    this.cursor += c.length;
    this.output.write(c);
  }
};

Interface.prototype._tabComplete = function() {
  var self = this;

  var rv = this.completer(self.line.slice(0, self.cursor));
  var completions = rv[0],
      completeOn = rv[1];  // the text that was completed
  if (completions && completions.length) {
    // Apply/show completions.
    if (completions.length === 1) {
      self._insertString(completions[0].slice(completeOn.length));
      self._refreshLine();
    } else {
      self.output.write('\r\n');
      var width = completions.reduce(function(a, b) {
        return a.length > b.length ? a : b;
      }).length + 2;  // 2 space padding
      var maxColumns = Math.floor(this.columns / width) || 1;

      function handleGroup(group) {
        if (group.length == 0) {
          return;
        }
        var minRows = Math.ceil(group.length / maxColumns);
        for (var row = 0; row < minRows; row++) {
          for (var col = 0; col < maxColumns; col++) {
            var idx = row * maxColumns + col;
            if (idx >= group.length) {
              break;
            }
            var item = group[idx];
            self.output.write(item);
            if (col < maxColumns - 1) {
              for (var s = 0, itemLen = item.length; s < width - itemLen; s++) {
                self.output.write(' ');
              }
            }
          }
          self.output.write('\r\n');
        }
        self.output.write('\r\n');
      }

      var group = [], c;
      for (var i = 0, compLen = completions.length; i < compLen; i++) {
        c = completions[i];
        if (c === '') {
          handleGroup(group);
          group = [];
        } else {
          group.push(c);
        }
      }
      handleGroup(group);

      // If there is a common prefix to all matches, then apply that
      // portion.
      var f = completions.filter(function(e) { if (e) return e; });
      var prefix = commonPrefix(f);
      if (prefix.length > completeOn.length) {
        self._insertString(prefix.slice(completeOn.length));
      }

      self._refreshLine();
    }
  }
};

function commonPrefix(strings) {
  if (!strings || strings.length == 0) {
    return '';
  }
  var sorted = strings.slice().sort();
  var min = sorted[0];
  var max = sorted[sorted.length - 1];
  for (var i = 0, len = min.length; i < len; i++) {
    if (min[i] != max[i]) {
      return min.slice(0, i);
    }
  }
  return min;
}

Interface.prototype._historyNext = function() {
  if (this.historyIndex > 0) {
    this.historyIndex--;
    this.line = this.history[this.historyIndex];
    this.cursor = this.line.length; // set cursor to end of line.
    this._refreshLine();

  } else if (this.historyIndex === 0) {
    this.historyIndex = -1;
    this.cursor = 0;
    this.line = '';
    this._refreshLine();
  }
};

Interface.prototype._historyPrev = function() {
  if (this.historyIndex + 1 < this.history.length) {
    this.historyIndex++;
    this.line = this.history[this.historyIndex];
    this.cursor = this.line.length; // set cursor to end of line.

    this._refreshLine();
  }
};

// handle a write from the tty
Interface.prototype._ttyWrite = function(b) {
  switch (b[0]) {
    /* ctrl+c */
    case 3:
      //process.kill(process.pid, "SIGINT");
      if (this.listeners('SIGINT').length) {
        this.emit('SIGINT');
      } else {
        // default behavior, end the readline
        this.close();
      }
      break;

    case 4: // control-d, delete right or EOF
      if (this.cursor === 0 && this.line.length === 0) {
        this.close();
      } else if (this.cursor < this.line.length) {
        this.line = this.line.slice(0, this.cursor) +
                    this.line.slice(this.cursor + 1, this.line.length);

        this._refreshLine();
      }
      break;

    case 13:    /* enter */
      var line = this._addHistory();
      this.output.write('\r\n');
      this.emit('line', line);
      break;

    case 127:   /* backspace */
    case 8:     /* ctrl+h */
      if (this.cursor > 0 && this.line.length > 0) {
        this.line = this.line.slice(0, this.cursor - 1) +
                    this.line.slice(this.cursor, this.line.length);

        this.cursor--;
        this._refreshLine();
      }
      break;

    case 21: /* Ctrl+u, delete the whole line. */
      this.cursor = 0;
      this.line = '';
      this._refreshLine();
      break;

    case 11: /* Ctrl+k, delete from current to end of line. */
      this.line = this.line.slice(0, this.cursor);
      this._refreshLine();
      break;

    case 1: /* Ctrl+a, go to the start of the line */
      this.cursor = 0;
      this._refreshLine();
      break;

    case 5: /* ctrl+e, go to the end of the line */
      this.cursor = this.line.length;
      this._refreshLine();
      break;

    case 2: // control-b, back one character
      if (this.cursor > 0) {
        this.cursor--;
        this._refreshLine();
      }
      break;

    case 6: // control-f, forward one character
      if (this.cursor != this.line.length) {
        this.cursor++;
        this._refreshLine();
      }
      break;

    case 14: // control-n, next history item
      this._historyNext();
      break;

    case 23: // control-w, delete backwards to a word boundary
      if (this.cursor !== 0) {
        var leading = this.line.slice(0, this.cursor);
        var match = leading.match(/\s?((\W+|\w+)\s*)$/);
        leading = leading.slice(0, leading.length - match[1].length);
        this.line = leading + this.line.slice(this.cursor, this.line.length);
        this.cursor = leading.length;
        this._refreshLine();
      }
      break;

    case 9: // tab, completion
      if (this.completer) {
        this._tabComplete();
      }
      break;

    case 16: // control-p, previous history item
      this._historyPrev();
      break;

    case 26:    /* ctrl+z */
      process.kill(process.pid, 'SIGTSTP');
      return;

    case 27:    /* escape sequence */
      var next_word, next_non_word, previous_word, previous_non_word;

      if (b[1] === 98 && this.cursor > 0) {
        // meta-b - backward word
        previous_word = this.line.slice(0, this.cursor)
              .split('').reverse().join('')
              .search(/\w/);
        if (previous_word !== -1) {
          previous_non_word = this.line.slice(0, this.cursor - previous_word)
              .split('').reverse().join('')
              .search(/\W/);
          if (previous_non_word !== -1) {
            this.cursor -= previous_word + previous_non_word;
            this._refreshLine();
            break;
          }
        }
        this.cursor = 0;
        this._refreshLine();

      } else if (b[1] === 102 && this.cursor < this.line.length) {
        // meta-f - forward word
        next_word = this.line.slice(this.cursor, this.line.length).search(/\w/);
        if (next_word !== -1) {
          next_non_word = this.line.slice(this.cursor + next_word,
                                          this.line.length).search(/\W/);
          if (next_non_word !== -1) {
            this.cursor += next_word + next_non_word;
            this._refreshLine();
            break;
          }
        }
        this.cursor = this.line.length;
        this._refreshLine();

      } else if (b[1] === 100 && this.cursor < this.line.length) {
        // meta-d delete forward word
        next_word = this.line.slice(this.cursor, this.line.length).search(/\w/);
        if (next_word !== -1) {
          next_non_word = this.line.slice(this.cursor + next_word,
                                          this.line.length).search(/\W/);
          if (next_non_word !== -1) {
            this.line = this.line.slice(this.cursor +
                                        next_word +
                                        next_non_word);
            this.cursor = 0;
            this._refreshLine();
            break;
          }
        }
        this.line = '';
        this.cursor = 0;
        this._refreshLine();

      } else if (b[1] === 91 && b[2] === 68) {
        // left arrow
        if (this.cursor > 0) {
          this.cursor--;
          this.output.write('\x1b[0D');
        }

      } else if (b[1] === 91 && b[2] === 67) {
        // right arrow
        if (this.cursor != this.line.length) {
          this.cursor++;
          this.output.write('\x1b[0C');
        }

      } else if ((b[1] === 91 && b[2] === 72) ||
                 (b[1] === 79 && b[2] === 72) ||
                 (b[1] === 91 && b[2] === 55) ||
                 (b[1] === 91 && b[2] === 49 && (b[3] && b[3] === 126))) {
        // home
        this.cursor = 0;
        this._refreshLine();
      } else if ((b[1] === 91 && b[2] === 70) ||
                 (b[1] === 79 && b[2] === 70) ||
                 (b[1] === 91 && b[2] === 56) ||
                 (b[1] === 91 && b[2] === 52 && (b[3] && b[3] === 126))) {
        // end
        this.cursor = this.line.length;
        this._refreshLine();

      } else if (b[1] === 91 && b[2] === 65) {
        // up arrow
        this._historyPrev();

      } else if (b[1] === 91 && b[2] === 66) {
        // down arrow
        this._historyNext();

      } else if (b[1] === 91 && b[2] === 51 && this.cursor < this.line.length) {
        // delete right
        this.line = this.line.slice(0, this.cursor) +
                    this.line.slice(this.cursor + 1, this.line.length);
        this._refreshLine();

      }
      break;

    default:
      var c = b.toString('utf8');
      var lines = c.split(/\r\n|\n|\r/);
      for (var i = 0, len = lines.length; i < len; i++) {
        if (i > 0) {
          this._ttyWrite(new Buffer([13]));
        }
        this._insertString(lines[i]);
      }
      break;
  }
};

exports.Interface = Interface;