fune/devtools/shared/specs/source.js
Nicolas Chevobbe 32aaf870e6 Bug 1677942 - [devtools] Use new syntax for backward compatibility comments. r=jdescottes,devtools-backward-compat-reviewers.
This turns all existing backward compatibility comments (or
comments mentioning a specific Firefox version), into the new
syntax we agreed upon in Bug 1673535.

Differential Revision: https://phabricator.services.mozilla.com/D97395
2020-12-01 10:27:47 +00:00

95 lines
2.4 KiB
JavaScript

/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
"use strict";
const {
Arg,
RetVal,
generateActorSpec,
types,
} = require("devtools/shared/protocol");
const longstringType = types.getType("longstring");
const arraybufferType = types.getType("arraybuffer");
// The sourcedata type needs some custom marshalling, because it is sometimes
// returned as an arraybuffer and sometimes as a longstring.
types.addType("sourcedata", {
write: (value, context, detail) => {
if (value.typeName === "arraybuffer") {
return arraybufferType.write(value, context, detail);
}
return longstringType.write(value, context, detail);
},
read: (value, context, detail) => {
if (value.typeName === "arraybuffer") {
return arraybufferType.read(value, context, detail);
}
return longstringType.read(value, context, detail);
},
});
types.addDictType("sourceposition", {
line: "number",
column: "number",
});
types.addDictType("nullablesourceposition", {
line: "nullable:number",
column: "nullable:number",
});
types.addDictType("breakpointquery", {
start: "nullable:nullablesourceposition",
end: "nullable:nullablesourceposition",
});
types.addDictType("source.onsource", {
contentType: "nullable:string",
source: "nullable:sourcedata",
});
const sourceSpec = generateActorSpec({
typeName: "source",
methods: {
getBreakpointPositions: {
request: {
query: Arg(0, "nullable:breakpointquery"),
},
response: {
positions: RetVal("array:sourceposition"),
},
},
getBreakpointPositionsCompressed: {
request: {
query: Arg(0, "nullable:breakpointquery"),
},
response: {
positions: RetVal("json"),
},
},
getBreakableLines: {
request: {},
response: {
lines: RetVal("json"),
},
},
source: {
request: {},
response: RetVal("source.onsource"),
},
setPausePoints: {
request: {
pausePoints: Arg(0, "json"),
},
},
blackbox: {
request: { range: Arg(0, "nullable:json") },
response: { pausedInSource: RetVal("boolean") },
},
unblackbox: {
request: { range: Arg(0, "nullable:json") },
},
},
});
exports.sourceSpec = sourceSpec;