Files
vim-netbeans-server/lib/client.js

338 lines
10 KiB
JavaScript

var Transform = require("stream").Transform;
var EventEmitter = require("events").EventEmitter;
/**
* A Transform Stream implementation that output full VNB protocol messages
*
* @constructor
* @this {VNBMessageParser}
*/
function VNBMessageTransform(opts) {
"use strict";
Transform.call(this,opts);
var buffer;
/**
* Transform stream Write implementation
* @param {string} data Upstream data already converted as string
* @param {string} encoding String encoding (should be utf8, but should be checked upward)
* @param {function} callback Downstream Stream receiving only full VNB messages
**/
this._transform = function(data, encoding, callback) {
var endpos = data.indexOf("\n");
if (endpos > -1) {
if (buffer !== undefined) {
this.push(buffer);
buffer = undefined;
}
if (endpos > 0) {
this.push(data.substr(0, endpos));
}
callback();
if (endpos < data.length - 1) {
buffer = data.substr(endpos + 1);
}
}
else {
buffer = buffer.concat(data);
}
};
/**
* Flush still data. Remaining data is lost since it can only be an incomplete message
* @param {function} callback Callback to call when data has been flushed
**/
this._flush = function (callback) {
buffer = undefined;
callback();
};
}
/**
* Authentication callback
* @callback authenticationCallback
* @param {string} password Password given by the authenticating client
* @return {bool} Result of the authentication
*/
/**
* VNB Client implementation (communication from vim to the netbeans server)
* @constructor
* @this {VNBMessageClient}
* @param {Socket} socket Incomming stream
* @param {authenticationCallback} authentication Callback function called when the AUTH message is received
*/
function VNBClient(socket, authentication) {
"use strict";
EventEmitter.call(this);
var self = this;
var callbacks = new Map();
var currentSeqno = 0;
var connected = false;
//TODO check if this is needed
socket.setEncoding("utf8");
var messageTransform = new VNBMessageTransform();
messageTransform.on("data",function (message) {
//The first message must be an authentication one
if (message.startsWith("AUTH ") && authentication(message.substring(message.indexOf(" ") + 1))) {
connected = true;
messageTransform.removeAllListeners("data");
messageTransform.on("data", function(message) {
try {
var iName = 0; //Index of the name separator in case of an Event
var iSeqno = 0; //Index of the seqno separator in case of an Event
//Header of the message
for (var i = 0 ; i < message.length && message[i] !== " "; ++i) {
if (message[i] === ":") {
iName = i;
}
else if (message[i] === "=") {
iSeqno = i;
}
}
var isEvent = false;
var args = [];
var seqno = 0;
if (iName > 0 && iSeqno > 0) {
isEvent = true;
args.push("event");
args.push(Number.parseInt(message.substr(0, iName), 10));
args.push(message.substring(iName + 1, iSeqno));
//args.push(Number.parseInt(message.substring(iSeqno + 1, i), 10));
}
else if (iName === 0 && iSeqno === 0) {
seqno = Number.parseInt(message.substr(0, i), 10);
}
else {
throw "Unknown message type";
}
var argStartOffset = ++i;
//Arguments of the message
for ( ; i < message.length ; ++i) {
if (message[i] === "\"" || message[i] === "!") {
var parsedString = "";
i += 1;
while (i < message.length && message[i] !== "\"") {
if (message[i] === "\\") {
i += 1;
if (i < message.length) {
throw "Unfinished string in message";
}
else {
switch (message[i]) {
case "n" :
parsedString += "\n";
break;
case "\\" :
parsedString += "\\";
break;
case "\"" :
parsedString += "\"";
break;
case "r" :
parsedString += "\r";
break;
case "t" :
parsedString += "\t";
break;
default :
throw "Invalid escaped character in string";
}
}
}
else {
parsedString += message[i];
}
++i;
}
args.push(parsedString);
i += 1;
}
else {
while (i < message.length && message[i] !== " ") {
i += 1;
}
if (i - argStartOffset === 1 && (message[i] === "T" || message[i] === "F")) {
args.push(message[i] === "T");
}
else {
var argument = message.substr(argStartOffset, i);
if (Number.NaN(argument)) {
if (argument.contains("/")) {
args.push(argument.split("/"));
}
else {
args.push(argument);
}
}
else {
args.push(Number.parseInt(argument));
}
}
}
}
if (isEvent) {
//Emit the event
self.emit(...args);
}
else if (callbacks.has(seqno)) {
callbacks.get(seqno)(...args);
callbacks.delete(seqno);
}
else {
throw "Received reply to unknown function call";
}
}
catch (ex) {
self.emit("error", ex.message);
}
});
}
else {
//TODO send a message to client ?
socket.end();
}
});
messageTransform.on("error", function (error) {
});
messageTransform.on("end",function () {
});
messageTransform.on("close", function () {
});
/**
* @function sendCommand
* Send a command message
* @param {string} name Name of the command
* @param {number} buffer Name of the buffer
* @param {...string} arguments Parameters of the command
*/
function sendCommand(name, buffer) {
let seqno = currentSeqno;
currentSeqno += 1;
var data = buffer + ":" + name + ":" + seqno;
for (var i = 2 ; i < arguments.length ; ++i) {
data += " " + arguments[i];
}
data += "\n";
socket.write(data);
}
/**
* @function callFunction
* Send a function message
* @param {string} name Name of the function
* @param {number} buffer ID of the buffer
* @param {...string} arguments Parameters of the function. Use the string, bool, color and position function
* of the method to convert javascript types to string
* @param {function} callback Callback function called with reply value
* */
function callFunction (name, buffer) {
let seqno = currentSeqno;
currentSeqno += 1;
var lastArg = arguments.length - 1;
//If the function is called with a callback (wich should always be the case)
//add the calback to the map so it's fired when the reply is received
if (typeof(arguments[lastArg]) === "function") {
callbacks[currentSeqno] = arguments[lastArg];
lastArg -= 1;
}
var data = buffer + ":" + name + "/" + seqno;
for (var i = 2 ; i < lastArg ; ++i) {
data += " " + arguments[i];
}
data += "\n";
socket.write(data);
}
socket.pipe(messageTransform);
/* GLOBAL COMMANDS */
var startAtomic = function () {
};
var endAtomic = function() {
};
var raise = function () {
};
var setExitDelay = function (secondes) {
};
var specialKeys = function () {
};
var create = function() {
};
var editFile = function (pathName){
};
/* GLOBAL FUNCTIONS */
var saveAndExit = function (callback) {
};
var getModified = function (callback) {
};
}
VNBClient.prototype = EventEmitter;