mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
Bug 797639 - Part 0: Clean up transport style. r=jimb
This commit is contained in:
J. Ryan Stinnett
parent
1b19c41bcd
commit
12a46ec85f
@ -36,9 +36,9 @@ Cu.import("resource://gre/modules/NetUtil.jsm");
|
||||
* (However, for intra-process connections, LocalDebuggerTransport, below,
|
||||
* is more efficient than using an nsIPipe pair with DebuggerTransport.)
|
||||
*
|
||||
* @param aInput nsIInputStream
|
||||
* @param input nsIInputStream
|
||||
* The input stream.
|
||||
* @param aOutput nsIAsyncOutputStream
|
||||
* @param output nsIAsyncOutputStream
|
||||
* The output stream.
|
||||
*
|
||||
* Given a DebuggerTransport instance dt:
|
||||
@ -63,10 +63,9 @@ Cu.import("resource://gre/modules/NetUtil.jsm");
|
||||
* ([length]:[packet]). The contents of the JSON packet are specified in
|
||||
* the Remote Debugging Protocol specification.
|
||||
*/
|
||||
function DebuggerTransport(aInput, aOutput)
|
||||
{
|
||||
this._input = aInput;
|
||||
this._output = aOutput;
|
||||
function DebuggerTransport(input, output) {
|
||||
this._input = input;
|
||||
this._output = output;
|
||||
|
||||
this._converter = Cc["@mozilla.org/intl/scriptableunicodeconverter"]
|
||||
.createInstance(Ci.nsIScriptableUnicodeConverter);
|
||||
@ -87,10 +86,10 @@ DebuggerTransport.prototype = {
|
||||
* transmit the entire packet. Packets are transmitted in the order
|
||||
* they are passed to this method.
|
||||
*/
|
||||
send: function DT_send(aPacket) {
|
||||
let data = JSON.stringify(aPacket);
|
||||
send: function(packet) {
|
||||
let data = JSON.stringify(packet);
|
||||
data = this._converter.ConvertFromUnicode(data);
|
||||
data = data.length + ':' + data;
|
||||
data = data.length + ":" + data;
|
||||
this._outgoing += data;
|
||||
this._flushOutgoing();
|
||||
},
|
||||
@ -98,7 +97,7 @@ DebuggerTransport.prototype = {
|
||||
/**
|
||||
* Close the transport.
|
||||
*/
|
||||
close: function DT_close() {
|
||||
close: function() {
|
||||
this._input.close();
|
||||
this._output.close();
|
||||
},
|
||||
@ -106,7 +105,7 @@ DebuggerTransport.prototype = {
|
||||
/**
|
||||
* Flush the outgoing stream.
|
||||
*/
|
||||
_flushOutgoing: function DT_flushOutgoing() {
|
||||
_flushOutgoing: function() {
|
||||
if (this._outgoing.length > 0) {
|
||||
var threadManager = Cc["@mozilla.org/thread-manager;1"].getService();
|
||||
this._output.asyncWait(this, 0, 0, threadManager.currentThread);
|
||||
@ -114,10 +113,10 @@ DebuggerTransport.prototype = {
|
||||
},
|
||||
|
||||
onOutputStreamReady:
|
||||
DevToolsUtils.makeInfallible(function DT_onOutputStreamReady(aStream) {
|
||||
DevToolsUtils.makeInfallible(function(stream) {
|
||||
let written = 0;
|
||||
try {
|
||||
written = aStream.write(this._outgoing, this._outgoing.length);
|
||||
written = stream.write(this._outgoing, this._outgoing.length);
|
||||
} catch(e if e.result == Cr.NS_BASE_STREAM_CLOSED) {
|
||||
dumpn("Connection closed.");
|
||||
this.close();
|
||||
@ -132,7 +131,7 @@ DebuggerTransport.prototype = {
|
||||
* called, we watch for packets on the input stream, and pass them to
|
||||
* this.hook.onPacket.
|
||||
*/
|
||||
ready: function DT_ready() {
|
||||
ready: function() {
|
||||
let pump = Cc["@mozilla.org/network/input-stream-pump;1"]
|
||||
.createInstance(Ci.nsIInputStreamPump);
|
||||
pump.init(this._input, -1, -1, 0, 0, false);
|
||||
@ -141,24 +140,24 @@ DebuggerTransport.prototype = {
|
||||
|
||||
// nsIStreamListener
|
||||
onStartRequest:
|
||||
DevToolsUtils.makeInfallible(function DT_onStartRequest(aRequest, aContext) {},
|
||||
DevToolsUtils.makeInfallible(function(request, context) {},
|
||||
"DebuggerTransport.prototype.onStartRequest"),
|
||||
|
||||
onStopRequest:
|
||||
DevToolsUtils.makeInfallible(function DT_onStopRequest(aRequest, aContext, aStatus) {
|
||||
DevToolsUtils.makeInfallible(function(request, context, status) {
|
||||
this.close();
|
||||
if (this.hooks) {
|
||||
this.hooks.onClosed(aStatus);
|
||||
this.hooks.onClosed(status);
|
||||
this.hooks = null;
|
||||
}
|
||||
}, "DebuggerTransport.prototype.onStopRequest"),
|
||||
|
||||
onDataAvailable:
|
||||
DevToolsUtils.makeInfallible(function DT_onDataAvailable(aRequest, aContext,
|
||||
aStream, aOffset, aCount) {
|
||||
this._incoming += NetUtil.readInputStreamToString(aStream,
|
||||
aStream.available());
|
||||
while (this._processIncoming()) {};
|
||||
DevToolsUtils.makeInfallible(function(request, context, stream,
|
||||
offset, count) {
|
||||
this._incoming += NetUtil.readInputStreamToString(stream,
|
||||
stream.available());
|
||||
while (this._processIncoming()) {}
|
||||
}, "DebuggerTransport.prototype.onDataAvailable"),
|
||||
|
||||
/**
|
||||
@ -168,9 +167,9 @@ DebuggerTransport.prototype = {
|
||||
* handler DebuggerTransport.hooks.onPacket is called with the packet as a
|
||||
* parameter.
|
||||
*/
|
||||
_processIncoming: function DT__processIncoming() {
|
||||
_processIncoming: function() {
|
||||
// Well this is ugly.
|
||||
let sep = this._incoming.indexOf(':');
|
||||
let sep = this._incoming.indexOf(":");
|
||||
if (sep < 0) {
|
||||
// Incoming packet length is too big anyway - drop the connection.
|
||||
if (this._incoming.length > 20) {
|
||||
@ -224,7 +223,7 @@ DebuggerTransport.prototype = {
|
||||
|
||||
return true;
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
exports.DebuggerTransport = DebuggerTransport;
|
||||
|
||||
@ -234,14 +233,13 @@ exports.DebuggerTransport = DebuggerTransport;
|
||||
* DebuggerTransport, but instead of transmitting serialized messages across a
|
||||
* connection it merely calls the packet dispatcher of the other side.
|
||||
*
|
||||
* @param aOther LocalDebuggerTransport
|
||||
* @param other LocalDebuggerTransport
|
||||
* The other endpoint for this debugger connection.
|
||||
*
|
||||
* @see DebuggerTransport
|
||||
*/
|
||||
function LocalDebuggerTransport(aOther)
|
||||
{
|
||||
this.other = aOther;
|
||||
function LocalDebuggerTransport(other) {
|
||||
this.other = other;
|
||||
this.hooks = null;
|
||||
|
||||
/*
|
||||
@ -257,26 +255,26 @@ LocalDebuggerTransport.prototype = {
|
||||
* Transmit a message by directly calling the onPacket handler of the other
|
||||
* endpoint.
|
||||
*/
|
||||
send: function LDT_send(aPacket) {
|
||||
send: function(packet) {
|
||||
let serial = this._serial.count++;
|
||||
if (dumpn.wantLogging) {
|
||||
/* Check 'from' first, as 'echo' packets have both. */
|
||||
if (aPacket.from) {
|
||||
dumpn("Packet " + serial + " sent from " + uneval(aPacket.from));
|
||||
} else if (aPacket.to) {
|
||||
dumpn("Packet " + serial + " sent to " + uneval(aPacket.to));
|
||||
if (packet.from) {
|
||||
dumpn("Packet " + serial + " sent from " + uneval(packet.from));
|
||||
} else if (packet.to) {
|
||||
dumpn("Packet " + serial + " sent to " + uneval(packet.to));
|
||||
}
|
||||
}
|
||||
this._deepFreeze(aPacket);
|
||||
this._deepFreeze(packet);
|
||||
let other = this.other;
|
||||
if (other) {
|
||||
Services.tm.currentThread.dispatch(DevToolsUtils.makeInfallible(function() {
|
||||
Services.tm.currentThread.dispatch(DevToolsUtils.makeInfallible(() => {
|
||||
// Avoid the cost of JSON.stringify() when logging is disabled.
|
||||
if (dumpn.wantLogging) {
|
||||
dumpn("Received packet " + serial + ": " + JSON.stringify(aPacket, null, 2));
|
||||
dumpn("Received packet " + serial + ": " + JSON.stringify(packet, null, 2));
|
||||
}
|
||||
if (other.hooks) {
|
||||
other.hooks.onPacket(aPacket);
|
||||
other.hooks.onPacket(packet);
|
||||
}
|
||||
}, "LocalDebuggerTransport instance's this.other.hooks.onPacket"), 0);
|
||||
}
|
||||
@ -285,7 +283,7 @@ LocalDebuggerTransport.prototype = {
|
||||
/**
|
||||
* Close the transport.
|
||||
*/
|
||||
close: function LDT_close() {
|
||||
close: function() {
|
||||
if (this.other) {
|
||||
// Remove the reference to the other endpoint before calling close(), to
|
||||
// avoid infinite recursion.
|
||||
@ -306,20 +304,20 @@ LocalDebuggerTransport.prototype = {
|
||||
/**
|
||||
* An empty method for emulating the DebuggerTransport API.
|
||||
*/
|
||||
ready: function LDT_ready() {},
|
||||
ready: function() {},
|
||||
|
||||
/**
|
||||
* Helper function that makes an object fully immutable.
|
||||
*/
|
||||
_deepFreeze: function LDT_deepFreeze(aObject) {
|
||||
Object.freeze(aObject);
|
||||
for (let prop in aObject) {
|
||||
_deepFreeze: function(object) {
|
||||
Object.freeze(object);
|
||||
for (let prop in object) {
|
||||
// Freeze the properties that are objects, not on the prototype, and not
|
||||
// already frozen. Note that this might leave an unfrozen reference
|
||||
// somewhere in the object if there is an already frozen object containing
|
||||
// an unfrozen object.
|
||||
if (aObject.hasOwnProperty(prop) && typeof aObject === "object" &&
|
||||
!Object.isFrozen(aObject)) {
|
||||
if (object.hasOwnProperty(prop) && typeof object === "object" &&
|
||||
!Object.isFrozen(object)) {
|
||||
this._deepFreeze(o[prop]);
|
||||
}
|
||||
}
|
||||
@ -332,19 +330,19 @@ exports.LocalDebuggerTransport = LocalDebuggerTransport;
|
||||
* A transport for the debugging protocol that uses nsIMessageSenders to
|
||||
* exchange packets with servers running in child processes.
|
||||
*
|
||||
* In the parent process, |aSender| should be the nsIMessageSender for the
|
||||
* child process. In a child process, |aSender| should be the child process
|
||||
* In the parent process, |sender| should be the nsIMessageSender for the
|
||||
* child process. In a child process, |sender| should be the child process
|
||||
* message manager, which sends packets to the parent.
|
||||
*
|
||||
* aPrefix is a string included in the message names, to distinguish
|
||||
* |prefix| is a string included in the message names, to distinguish
|
||||
* multiple servers running in the same child process.
|
||||
*
|
||||
* This transport exchanges messages named 'debug:<prefix>:packet', where
|
||||
* <prefix> is |aPrefix|, whose data is the protocol packet.
|
||||
* <prefix> is |prefix|, whose data is the protocol packet.
|
||||
*/
|
||||
function ChildDebuggerTransport(aSender, aPrefix) {
|
||||
this._sender = aSender.QueryInterface(Ci.nsIMessageSender);
|
||||
this._messageName = "debug:" + aPrefix + ":packet";
|
||||
function ChildDebuggerTransport(sender, prefix) {
|
||||
this._sender = sender.QueryInterface(Ci.nsIMessageSender);
|
||||
this._messageName = "debug:" + prefix + ":packet";
|
||||
}
|
||||
|
||||
/*
|
||||
|
||||
Loading…
Reference in New Issue
Block a user