@codingame/monaco-vscode-api 1.78.8 → 1.79.0

package/dist/keybinding.d.ts

@@ -0,0 +1,622 @@
+import { S as ServiceIdentifier } from './instantiation.js';
+import { E as Event } from './event.js';
+import { I as IJSONSchema } from './jsonSchema.js';
+import { C as ContextKeyExpression, b as IContextKeyServiceTarget, I as IContextKeyService } from './contextkey.js';
+
+/**
+ * Virtual Key Codes, the value does not hold any inherent meaning.
+ * Inspired somewhat from https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731(v=vs.85).aspx
+ * But these are "more general", as they should work across browsers & OS`s.
+ */
+declare const enum KeyCode {
+    DependsOnKbLayout = -1,
+    /**
+     * Placed first to cover the 0 value of the enum.
+     */
+    Unknown = 0,
+    Backspace = 1,
+    Tab = 2,
+    Enter = 3,
+    Shift = 4,
+    Ctrl = 5,
+    Alt = 6,
+    PauseBreak = 7,
+    CapsLock = 8,
+    Escape = 9,
+    Space = 10,
+    PageUp = 11,
+    PageDown = 12,
+    End = 13,
+    Home = 14,
+    LeftArrow = 15,
+    UpArrow = 16,
+    RightArrow = 17,
+    DownArrow = 18,
+    Insert = 19,
+    Delete = 20,
+    Digit0 = 21,
+    Digit1 = 22,
+    Digit2 = 23,
+    Digit3 = 24,
+    Digit4 = 25,
+    Digit5 = 26,
+    Digit6 = 27,
+    Digit7 = 28,
+    Digit8 = 29,
+    Digit9 = 30,
+    KeyA = 31,
+    KeyB = 32,
+    KeyC = 33,
+    KeyD = 34,
+    KeyE = 35,
+    KeyF = 36,
+    KeyG = 37,
+    KeyH = 38,
+    KeyI = 39,
+    KeyJ = 40,
+    KeyK = 41,
+    KeyL = 42,
+    KeyM = 43,
+    KeyN = 44,
+    KeyO = 45,
+    KeyP = 46,
+    KeyQ = 47,
+    KeyR = 48,
+    KeyS = 49,
+    KeyT = 50,
+    KeyU = 51,
+    KeyV = 52,
+    KeyW = 53,
+    KeyX = 54,
+    KeyY = 55,
+    KeyZ = 56,
+    Meta = 57,
+    ContextMenu = 58,
+    F1 = 59,
+    F2 = 60,
+    F3 = 61,
+    F4 = 62,
+    F5 = 63,
+    F6 = 64,
+    F7 = 65,
+    F8 = 66,
+    F9 = 67,
+    F10 = 68,
+    F11 = 69,
+    F12 = 70,
+    F13 = 71,
+    F14 = 72,
+    F15 = 73,
+    F16 = 74,
+    F17 = 75,
+    F18 = 76,
+    F19 = 77,
+    F20 = 78,
+    F21 = 79,
+    F22 = 80,
+    F23 = 81,
+    F24 = 82,
+    NumLock = 83,
+    ScrollLock = 84,
+    /**
+     * Used for miscellaneous characters; it can vary by keyboard.
+     * For the US standard keyboard, the ';:' key
+     */
+    Semicolon = 85,
+    /**
+     * For any country/region, the '+' key
+     * For the US standard keyboard, the '=+' key
+     */
+    Equal = 86,
+    /**
+     * For any country/region, the ',' key
+     * For the US standard keyboard, the ',<' key
+     */
+    Comma = 87,
+    /**
+     * For any country/region, the '-' key
+     * For the US standard keyboard, the '-_' key
+     */
+    Minus = 88,
+    /**
+     * For any country/region, the '.' key
+     * For the US standard keyboard, the '.>' key
+     */
+    Period = 89,
+    /**
+     * Used for miscellaneous characters; it can vary by keyboard.
+     * For the US standard keyboard, the '/?' key
+     */
+    Slash = 90,
+    /**
+     * Used for miscellaneous characters; it can vary by keyboard.
+     * For the US standard keyboard, the '`~' key
+     */
+    Backquote = 91,
+    /**
+     * Used for miscellaneous characters; it can vary by keyboard.
+     * For the US standard keyboard, the '[{' key
+     */
+    BracketLeft = 92,
+    /**
+     * Used for miscellaneous characters; it can vary by keyboard.
+     * For the US standard keyboard, the '\|' key
+     */
+    Backslash = 93,
+    /**
+     * Used for miscellaneous characters; it can vary by keyboard.
+     * For the US standard keyboard, the ']}' key
+     */
+    BracketRight = 94,
+    /**
+     * Used for miscellaneous characters; it can vary by keyboard.
+     * For the US standard keyboard, the ''"' key
+     */
+    Quote = 95,
+    /**
+     * Used for miscellaneous characters; it can vary by keyboard.
+     */
+    OEM_8 = 96,
+    /**
+     * Either the angle bracket key or the backslash key on the RT 102-key keyboard.
+     */
+    IntlBackslash = 97,
+    Numpad0 = 98,
+    Numpad1 = 99,
+    Numpad2 = 100,
+    Numpad3 = 101,
+    Numpad4 = 102,
+    Numpad5 = 103,
+    Numpad6 = 104,
+    Numpad7 = 105,
+    Numpad8 = 106,
+    Numpad9 = 107,
+    NumpadMultiply = 108,
+    NumpadAdd = 109,
+    NUMPAD_SEPARATOR = 110,
+    NumpadSubtract = 111,
+    NumpadDecimal = 112,
+    NumpadDivide = 113,
+    /**
+     * Cover all key codes when IME is processing input.
+     */
+    KEY_IN_COMPOSITION = 114,
+    ABNT_C1 = 115,
+    ABNT_C2 = 116,
+    AudioVolumeMute = 117,
+    AudioVolumeUp = 118,
+    AudioVolumeDown = 119,
+    BrowserSearch = 120,
+    BrowserHome = 121,
+    BrowserBack = 122,
+    BrowserForward = 123,
+    MediaTrackNext = 124,
+    MediaTrackPrevious = 125,
+    MediaStop = 126,
+    MediaPlayPause = 127,
+    LaunchMediaPlayer = 128,
+    LaunchMail = 129,
+    LaunchApp2 = 130,
+    /**
+     * VK_CLEAR, 0x0C, CLEAR key
+     */
+    Clear = 131,
+    /**
+     * Placed last to cover the length of the enum.
+     * Please do not depend on this value!
+     */
+    MAX_VALUE = 132
+}
+/**
+ * keyboardEvent.code
+ */
+declare const enum ScanCode {
+    DependsOnKbLayout = -1,
+    None = 0,
+    Hyper = 1,
+    Super = 2,
+    Fn = 3,
+    FnLock = 4,
+    Suspend = 5,
+    Resume = 6,
+    Turbo = 7,
+    Sleep = 8,
+    WakeUp = 9,
+    KeyA = 10,
+    KeyB = 11,
+    KeyC = 12,
+    KeyD = 13,
+    KeyE = 14,
+    KeyF = 15,
+    KeyG = 16,
+    KeyH = 17,
+    KeyI = 18,
+    KeyJ = 19,
+    KeyK = 20,
+    KeyL = 21,
+    KeyM = 22,
+    KeyN = 23,
+    KeyO = 24,
+    KeyP = 25,
+    KeyQ = 26,
+    KeyR = 27,
+    KeyS = 28,
+    KeyT = 29,
+    KeyU = 30,
+    KeyV = 31,
+    KeyW = 32,
+    KeyX = 33,
+    KeyY = 34,
+    KeyZ = 35,
+    Digit1 = 36,
+    Digit2 = 37,
+    Digit3 = 38,
+    Digit4 = 39,
+    Digit5 = 40,
+    Digit6 = 41,
+    Digit7 = 42,
+    Digit8 = 43,
+    Digit9 = 44,
+    Digit0 = 45,
+    Enter = 46,
+    Escape = 47,
+    Backspace = 48,
+    Tab = 49,
+    Space = 50,
+    Minus = 51,
+    Equal = 52,
+    BracketLeft = 53,
+    BracketRight = 54,
+    Backslash = 55,
+    IntlHash = 56,
+    Semicolon = 57,
+    Quote = 58,
+    Backquote = 59,
+    Comma = 60,
+    Period = 61,
+    Slash = 62,
+    CapsLock = 63,
+    F1 = 64,
+    F2 = 65,
+    F3 = 66,
+    F4 = 67,
+    F5 = 68,
+    F6 = 69,
+    F7 = 70,
+    F8 = 71,
+    F9 = 72,
+    F10 = 73,
+    F11 = 74,
+    F12 = 75,
+    PrintScreen = 76,
+    ScrollLock = 77,
+    Pause = 78,
+    Insert = 79,
+    Home = 80,
+    PageUp = 81,
+    Delete = 82,
+    End = 83,
+    PageDown = 84,
+    ArrowRight = 85,
+    ArrowLeft = 86,
+    ArrowDown = 87,
+    ArrowUp = 88,
+    NumLock = 89,
+    NumpadDivide = 90,
+    NumpadMultiply = 91,
+    NumpadSubtract = 92,
+    NumpadAdd = 93,
+    NumpadEnter = 94,
+    Numpad1 = 95,
+    Numpad2 = 96,
+    Numpad3 = 97,
+    Numpad4 = 98,
+    Numpad5 = 99,
+    Numpad6 = 100,
+    Numpad7 = 101,
+    Numpad8 = 102,
+    Numpad9 = 103,
+    Numpad0 = 104,
+    NumpadDecimal = 105,
+    IntlBackslash = 106,
+    ContextMenu = 107,
+    Power = 108,
+    NumpadEqual = 109,
+    F13 = 110,
+    F14 = 111,
+    F15 = 112,
+    F16 = 113,
+    F17 = 114,
+    F18 = 115,
+    F19 = 116,
+    F20 = 117,
+    F21 = 118,
+    F22 = 119,
+    F23 = 120,
+    F24 = 121,
+    Open = 122,
+    Help = 123,
+    Select = 124,
+    Again = 125,
+    Undo = 126,
+    Cut = 127,
+    Copy = 128,
+    Paste = 129,
+    Find = 130,
+    AudioVolumeMute = 131,
+    AudioVolumeUp = 132,
+    AudioVolumeDown = 133,
+    NumpadComma = 134,
+    IntlRo = 135,
+    KanaMode = 136,
+    IntlYen = 137,
+    Convert = 138,
+    NonConvert = 139,
+    Lang1 = 140,
+    Lang2 = 141,
+    Lang3 = 142,
+    Lang4 = 143,
+    Lang5 = 144,
+    Abort = 145,
+    Props = 146,
+    NumpadParenLeft = 147,
+    NumpadParenRight = 148,
+    NumpadBackspace = 149,
+    NumpadMemoryStore = 150,
+    NumpadMemoryRecall = 151,
+    NumpadMemoryClear = 152,
+    NumpadMemoryAdd = 153,
+    NumpadMemorySubtract = 154,
+    NumpadClear = 155,
+    NumpadClearEntry = 156,
+    ControlLeft = 157,
+    ShiftLeft = 158,
+    AltLeft = 159,
+    MetaLeft = 160,
+    ControlRight = 161,
+    ShiftRight = 162,
+    AltRight = 163,
+    MetaRight = 164,
+    BrightnessUp = 165,
+    BrightnessDown = 166,
+    MediaPlay = 167,
+    MediaRecord = 168,
+    MediaFastForward = 169,
+    MediaRewind = 170,
+    MediaTrackNext = 171,
+    MediaTrackPrevious = 172,
+    MediaStop = 173,
+    Eject = 174,
+    MediaPlayPause = 175,
+    MediaSelect = 176,
+    LaunchMail = 177,
+    LaunchApp2 = 178,
+    LaunchApp1 = 179,
+    SelectTask = 180,
+    LaunchScreenSaver = 181,
+    BrowserSearch = 182,
+    BrowserHome = 183,
+    BrowserBack = 184,
+    BrowserForward = 185,
+    BrowserStop = 186,
+    BrowserRefresh = 187,
+    BrowserFavorites = 188,
+    ZoomToggle = 189,
+    MailReply = 190,
+    MailForward = 191,
+    MailSend = 192,
+    MAX_VALUE = 193
+}
+
+interface Modifiers {
+    readonly ctrlKey: boolean;
+    readonly shiftKey: boolean;
+    readonly altKey: boolean;
+    readonly metaKey: boolean;
+}
+/**
+ * Represents a chord which uses the `keyCode` field of keyboard events.
+ * A chord is a combination of keys pressed simultaneously.
+ */
+declare class KeyCodeChord implements Modifiers {
+    readonly ctrlKey: boolean;
+    readonly shiftKey: boolean;
+    readonly altKey: boolean;
+    readonly metaKey: boolean;
+    readonly keyCode: KeyCode;
+    constructor(ctrlKey: boolean, shiftKey: boolean, altKey: boolean, metaKey: boolean, keyCode: KeyCode);
+    equals(other: Chord): boolean;
+    getHashCode(): string;
+    isModifierKey(): boolean;
+    toKeybinding(): Keybinding;
+    /**
+     * Does this keybinding refer to the key code of a modifier and it also has the modifier flag?
+     */
+    isDuplicateModifierCase(): boolean;
+}
+/**
+ * Represents a chord which uses the `code` field of keyboard events.
+ * A chord is a combination of keys pressed simultaneously.
+ */
+declare class ScanCodeChord implements Modifiers {
+    readonly ctrlKey: boolean;
+    readonly shiftKey: boolean;
+    readonly altKey: boolean;
+    readonly metaKey: boolean;
+    readonly scanCode: ScanCode;
+    constructor(ctrlKey: boolean, shiftKey: boolean, altKey: boolean, metaKey: boolean, scanCode: ScanCode);
+    equals(other: Chord): boolean;
+    getHashCode(): string;
+    /**
+     * Does this keybinding refer to the key code of a modifier and it also has the modifier flag?
+     */
+    isDuplicateModifierCase(): boolean;
+}
+type Chord = KeyCodeChord | ScanCodeChord;
+/**
+ * A keybinding is a sequence of chords.
+ */
+declare class Keybinding {
+    readonly chords: Chord[];
+    constructor(chords: Chord[]);
+    getHashCode(): string;
+    equals(other: Keybinding | null): boolean;
+}
+declare class ResolvedChord {
+    readonly ctrlKey: boolean;
+    readonly shiftKey: boolean;
+    readonly altKey: boolean;
+    readonly metaKey: boolean;
+    readonly keyLabel: string | null;
+    readonly keyAriaLabel: string | null;
+    constructor(ctrlKey: boolean, shiftKey: boolean, altKey: boolean, metaKey: boolean, keyLabel: string | null, keyAriaLabel: string | null);
+}
+type SingleModifierChord = 'ctrl' | 'shift' | 'alt' | 'meta';
+/**
+ * A resolved keybinding. Consists of one or multiple chords.
+ */
+declare abstract class ResolvedKeybinding {
+    /**
+     * This prints the binding in a format suitable for displaying in the UI.
+     */
+    abstract getLabel(): string | null;
+    /**
+     * This prints the binding in a format suitable for ARIA.
+     */
+    abstract getAriaLabel(): string | null;
+    /**
+     * This prints the binding in a format suitable for electron's accelerators.
+     * See https://github.com/electron/electron/blob/master/docs/api/accelerator.md
+     */
+    abstract getElectronAccelerator(): string | null;
+    /**
+     * This prints the binding in a format suitable for user settings.
+     */
+    abstract getUserSettingsLabel(): string | null;
+    /**
+     * Is the user settings label reflecting the label?
+     */
+    abstract isWYSIWYG(): boolean;
+    /**
+     * Does the keybinding consist of more than one chord?
+     */
+    abstract hasMultipleChords(): boolean;
+    /**
+     * Returns the chords that comprise of the keybinding.
+     */
+    abstract getChords(): ResolvedChord[];
+    /**
+     * Returns the chords as strings useful for dispatching.
+     * Returns null for modifier only chords.
+     * @example keybinding "Shift" -> null
+     * @example keybinding ("D" with shift == true) -> "shift+D"
+     */
+    abstract getDispatchChords(): (string | null)[];
+    /**
+     * Returns the modifier only chords as strings useful for dispatching.
+     * Returns null for chords that contain more than one modifier or a regular key.
+     * @example keybinding "Shift" -> "shift"
+     * @example keybinding ("D" with shift == true") -> null
+     */
+    abstract getSingleModifierDispatchChords(): (SingleModifierChord | null)[];
+}
+
+declare class ResolvedKeybindingItem {
+    _resolvedKeybindingItemBrand: void;
+    readonly resolvedKeybinding: ResolvedKeybinding | undefined;
+    readonly chords: string[];
+    readonly bubble: boolean;
+    readonly command: string | null;
+    readonly commandArgs: any;
+    readonly when: ContextKeyExpression | undefined;
+    readonly isDefault: boolean;
+    readonly extensionId: string | null;
+    readonly isBuiltinExtension: boolean;
+    constructor(resolvedKeybinding: ResolvedKeybinding | undefined, command: string | null, commandArgs: any, when: ContextKeyExpression | undefined, isDefault: boolean, extensionId: string | null, isBuiltinExtension: boolean);
+}
+
+declare const enum ResultKind {
+    /** No keybinding found this sequence of chords */
+    NoMatchingKb = 0,
+    /** There're several keybindings that have the given sequence of chords as a prefix */
+    MoreChordsNeeded = 1,
+    /** A single keybinding found to be dispatched/invoked */
+    KbFound = 2
+}
+type ResolutionResult = {
+    kind: ResultKind.NoMatchingKb;
+} | {
+    kind: ResultKind.MoreChordsNeeded;
+} | {
+    kind: ResultKind.KbFound;
+    commandId: string | null;
+    commandArgs: any;
+    isBubble: boolean;
+};
+
+interface IUserFriendlyKeybinding {
+    key: string;
+    command: string;
+    args?: any;
+    when?: string;
+}
+interface IKeyboardEvent {
+    readonly _standardKeyboardEventBrand: true;
+    readonly ctrlKey: boolean;
+    readonly shiftKey: boolean;
+    readonly altKey: boolean;
+    readonly metaKey: boolean;
+    readonly altGraphKey: boolean;
+    readonly keyCode: KeyCode;
+    readonly code: string;
+}
+interface KeybindingsSchemaContribution {
+    readonly onDidChange?: Event<void>;
+    getSchemaAdditions(): IJSONSchema[];
+}
+declare const IKeybindingService: ServiceIdentifier<IKeybindingService>;
+interface IKeybindingService {
+    readonly _serviceBrand: undefined;
+    readonly inChordMode: boolean;
+    onDidUpdateKeybindings: Event<void>;
+    /**
+     * Returns none, one or many (depending on keyboard layout)!
+     */
+    resolveKeybinding(keybinding: Keybinding): ResolvedKeybinding[];
+    resolveKeyboardEvent(keyboardEvent: IKeyboardEvent): ResolvedKeybinding;
+    resolveUserBinding(userBinding: string): ResolvedKeybinding[];
+    /**
+     * Resolve and dispatch `keyboardEvent` and invoke the command.
+     */
+    dispatchEvent(e: IKeyboardEvent, target: IContextKeyServiceTarget): boolean;
+    /**
+     * Resolve and dispatch `keyboardEvent`, but do not invoke the command or change inner state.
+     */
+    softDispatch(keyboardEvent: IKeyboardEvent, target: IContextKeyServiceTarget): ResolutionResult | null;
+    dispatchByUserSettingsLabel(userSettingsLabel: string, target: IContextKeyServiceTarget): void;
+    /**
+     * Look up keybindings for a command.
+     * Use `lookupKeybinding` if you are interested in the preferred keybinding.
+     */
+    lookupKeybindings(commandId: string): ResolvedKeybinding[];
+    /**
+     * Look up the preferred (last defined) keybinding for a command.
+     * @returns The preferred keybinding or null if the command is not bound.
+     */
+    lookupKeybinding(commandId: string, context?: IContextKeyService): ResolvedKeybinding | undefined;
+    getDefaultKeybindingsContent(): string;
+    getDefaultKeybindings(): readonly ResolvedKeybindingItem[];
+    getKeybindings(): readonly ResolvedKeybindingItem[];
+    customKeybindingsCount(): number;
+    /**
+     * Will the given key event produce a character that's rendered on screen, e.g. in a
+     * text box. *Note* that the results of this function can be incorrect.
+     */
+    mightProducePrintableCharacter(event: IKeyboardEvent): boolean;
+    registerSchemaContribution(contribution: KeybindingsSchemaContribution): void;
+    toggleLogging(): boolean;
+    _dumpDebugInfo(): string;
+    _dumpDebugInfoJSON(): string;
+}
+
+export { IUserFriendlyKeybinding as I, KeyCode as K, ResolvedKeybinding as R, IKeybindingService as a, KeyCodeChord as b };