summaryrefslogtreecommitdiffstats
path: root/devtools/shared/specs/gcli.js
blob: 2e0768bc8f951b55d4a83245b1034a79d059dd44 (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
/* 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 } = require("devtools/shared/protocol");

const gcliSpec = generateActorSpec({
  typeName: "gcli",

  events: {
    "commands-changed": {
      type: "commandsChanged"
    }
  },

  methods: {
    _testOnlyAddItemsByModule: {
      request: {
        customProps: Arg(0, "array:string")
      }
    },
    _testOnlyRemoveItemsByModule: {
      request: {
        customProps: Arg(0, "array:string")
      }
    },
    specs: {
      request: {
        customProps: Arg(0, "nullable:array:string")
      },
      response: {
        value: RetVal("array:json")
      }
    },
    execute: {
      request: {
        // The command string
        typed: Arg(0, "string")
      },
      response: RetVal("json")
    },
    state: {
      request: {
        // The command string
        typed: Arg(0, "string"),
        // Cursor start position
        start: Arg(1, "number"),
        // The prediction offset (# times UP/DOWN pressed)
        rank: Arg(2, "number")
      },
      response: RetVal("json")
    },
    parseType: {
      request: {
        // The command string
        typed: Arg(0, "string"),
        // The name of the parameter to parse
        paramName: Arg(1, "string")
      },
      response: RetVal("json")
    },
    nudgeType: {
      request: {
        // The command string
        typed: Arg(0, "string"),
        // +1/-1 for increment / decrement
        by: Arg(1, "number"),
        // The name of the parameter to parse
        paramName: Arg(2, "string")
      },
      response: RetVal("string")
    },
    getSelectionLookup: {
      request: {
        // The command containing the parameter in question
        commandName: Arg(0, "string"),
        // The name of the parameter
        paramName: Arg(1, "string"),
      },
      response: RetVal("json")
    }
  }
});

exports.gcliSpec = gcliSpec;