diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 19:33:14 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 19:33:14 +0000 |
commit | 36d22d82aa202bb199967e9512281e9a53db42c9 (patch) | |
tree | 105e8c98ddea1c1e4784a60a5a6410fa416be2de /devtools/shared/specs/string.js | |
parent | Initial commit. (diff) | |
download | firefox-esr-upstream.tar.xz firefox-esr-upstream.zip |
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'devtools/shared/specs/string.js')
-rw-r--r-- | devtools/shared/specs/string.js | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/devtools/shared/specs/string.js b/devtools/shared/specs/string.js new file mode 100644 index 0000000000..89b53c0a95 --- /dev/null +++ b/devtools/shared/specs/string.js @@ -0,0 +1,85 @@ +/* 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 protocol = require("resource://devtools/shared/protocol.js"); +const { Arg, RetVal, generateActorSpec } = protocol; + +const longStringSpec = generateActorSpec({ + typeName: "longstractor", + + methods: { + substring: { + request: { + start: Arg(0), + end: Arg(1), + }, + response: { substring: RetVal() }, + }, + release: { release: true }, + }, +}); + +exports.longStringSpec = longStringSpec; + +/** + * When a caller is expecting a LongString actor but the string is already available on + * client, the SimpleStringFront can be used as it shares the same API as a + * LongStringFront but will not make unnecessary trips to the server. + */ +class SimpleStringFront { + constructor(str) { + this.str = str; + } + + get length() { + return this.str.length; + } + + get initial() { + return this.str; + } + + string() { + return Promise.resolve(this.str); + } + + substring(start, end) { + return Promise.resolve(this.str.substring(start, end)); + } + + release() { + this.str = null; + return Promise.resolve(undefined); + } +} + +exports.SimpleStringFront = SimpleStringFront; + +// The long string actor needs some custom marshalling, because it is sometimes +// returned as a primitive rather than a complete form. + +var stringActorType = protocol.types.getType("longstractor"); +protocol.types.addType("longstring", { + _actor: true, + write: (value, context, detail) => { + if (!(context instanceof protocol.Actor)) { + throw Error("Passing a longstring as an argument isn't supported."); + } + + if (value.short) { + return value.str; + } + return stringActorType.write(value, context, detail); + }, + read: (value, context, detail) => { + if (context instanceof protocol.Actor) { + throw Error("Passing a longstring as an argument isn't supported."); + } + if (typeof value === "string") { + return new SimpleStringFront(value); + } + return stringActorType.read(value, context, detail); + }, +}); |