xref: /aosp_15_r20/external/perfetto/ui/src/public/command.ts (revision 6dbdd20afdafa5e3ca9b8809fa73465d530080dc)
1// Copyright (C) 2024 The Android Open Source Project
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//      http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15import {Hotkey} from '../base/hotkeys';
16
17export interface CommandManager {
18  registerCommand(command: Command): void;
19
20  hasCommand(commandId: string): boolean;
21
22  // eslint-disable-next-line @typescript-eslint/no-explicit-any
23  runCommand(id: string, ...args: any[]): any;
24}
25
26export interface Command {
27  // A unique id for this command.
28  id: string;
29  // A human-friendly name for this command.
30  name: string;
31  // Callback is called when the command is invoked.
32  // eslint-disable-next-line @typescript-eslint/no-explicit-any
33  callback: (...args: any[]) => any;
34  // Default hotkey for this command.
35  // Note: this is just the default and may be changed by the user.
36  // Examples:
37  // - 'P'
38  // - 'Shift+P'
39  // - '!Mod+Shift+P'
40  // See hotkeys.ts for guidance on hotkey syntax.
41  defaultHotkey?: Hotkey;
42}
43