summaryrefslogtreecommitdiffstats
path: root/devtools/shared/specs/source.js
blob: f3f650115018cab6693535201258c8ff22270be4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
/* 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;