monaco.d.ts 152.0 KB
Newer Older
1
declare module monaco {
2

3 4 5 6 7 8 9 10 11
    interface Thenable<R> {
        /**
         * Attaches callbacks for the resolution and/or rejection of the Promise.
         * @param onfulfilled The callback to execute when the Promise is resolved.
         * @param onrejected The callback to execute when the Promise is rejected.
         * @returns A Promise for the completion of which ever callback is executed.
         */
        then<TResult>(onfulfilled?: (value: R) => TResult | Thenable<TResult>, onrejected?: (reason: any) => TResult | Thenable<TResult>): Thenable<TResult>;
        then<TResult>(onfulfilled?: (value: R) => TResult | Thenable<TResult>, onrejected?: (reason: any) => void): Thenable<TResult>;
12 13
    }

14 15
    export interface IDisposable {
        dispose(): void;
16 17
    }

18 19
    export interface IEvent<T> {
        (listener: (e: T) => any, thisArg?: any): IDisposable;
20 21
    }

A
Alex Dima 已提交
22 23 24
    /**
     * A helper that allows to emit and listen to typed events
     */
25 26 27 28 29
    export class Emitter<T> {
        constructor();
        event: IEvent<T>;
        fire(event?: T): void;
        dispose(): void;
30 31
    }

32 33 34 35 36
    export enum Severity {
        Ignore = 0,
        Info = 1,
        Warning = 2,
        Error = 3,
37 38
    }

39 40


A
Alex Dima 已提交
41 42 43
    /**
     * The value callback to complete a promise
     */
44 45
    export interface TValueCallback<T> {
        (value: T): void;
46 47 48
    }


49 50
    export interface ProgressCallback {
        (progress: any): any;
51 52 53
    }


A
Alex Dima 已提交
54 55 56
    /**
     * A Promise implementation that supports progress and cancelation.
     */
57
    export class Promise<V> {
58

59
        constructor(init: (complete: TValueCallback<V>, error: (err: any) => void, progress: ProgressCallback) => void, oncancel?: any);
60

61 62 63 64 65 66 67 68 69 70 71 72
        public then<U>(success?: (value: V) => Promise<U>, error?: (err: any) => Promise<U>, progress?: ProgressCallback): Promise<U>;
        public then<U>(success?: (value: V) => Promise<U>, error?: (err: any) => Promise<U> | U, progress?: ProgressCallback): Promise<U>;
        public then<U>(success?: (value: V) => Promise<U>, error?: (err: any) => U, progress?: ProgressCallback): Promise<U>;
        public then<U>(success?: (value: V) => Promise<U>, error?: (err: any) => void, progress?: ProgressCallback): Promise<U>;
        public then<U>(success?: (value: V) => Promise<U> | U, error?: (err: any) => Promise<U>, progress?: ProgressCallback): Promise<U>;
        public then<U>(success?: (value: V) => Promise<U> | U, error?: (err: any) => Promise<U> | U, progress?: ProgressCallback): Promise<U>;
        public then<U>(success?: (value: V) => Promise<U> | U, error?: (err: any) => U, progress?: ProgressCallback): Promise<U>;
        public then<U>(success?: (value: V) => Promise<U> | U, error?: (err: any) => void, progress?: ProgressCallback): Promise<U>;
        public then<U>(success?: (value: V) => U, error?: (err: any) => Promise<U>, progress?: ProgressCallback): Promise<U>;
        public then<U>(success?: (value: V) => U, error?: (err: any) => Promise<U> | U, progress?: ProgressCallback): Promise<U>;
        public then<U>(success?: (value: V) => U, error?: (err: any) => U, progress?: ProgressCallback): Promise<U>;
        public then<U>(success?: (value: V) => U, error?: (err: any) => void, progress?: ProgressCallback): Promise<U>;
73

74 75
        public done(success?: (value: V) => void, error?: (err: any) => any, progress?: ProgressCallback): void;
        public cancel(): void;
76

77
        public static as<ValueType>(value: ValueType): Promise<ValueType>;
78
        public static is(value: any): value is Thenable<any>;
79 80 81 82 83
        public static timeout(delay: number): Promise<void>;
        public static join<ValueType>(promises: Promise<ValueType>[]): Promise<ValueType[]>;
        public static join<ValueType>(promises: Thenable<ValueType>[]): Thenable<ValueType[]>;
        public static join<ValueType>(promises: { [n: string]: Promise<ValueType> }): Promise<{ [n: string]: ValueType }>;
        public static any<ValueType>(promises: Promise<ValueType>[]): Promise<{ key: string; value: Promise<ValueType>; }>;
J
Johannes Rieken 已提交
84 85 86 87

        public static wrap<ValueType>(value: Thenable<ValueType>): Promise<ValueType>;
        public static wrap<ValueType>(value: ValueType): Promise<ValueType>;

88
        public static wrapError<ValueType>(error: any): Promise<ValueType>;
89 90
    }

91
    export class CancellationTokenSource {
D
Dirk Baeumer 已提交
92
        readonly token: CancellationToken;
93 94
        cancel(): void;
        dispose(): void;
95 96
    }

97 98 99
    export interface CancellationToken {
        isCancellationRequested: boolean;
        onCancellationRequested: IEvent<any>;
100 101
    }
    /**
102 103 104 105 106 107 108 109 110 111 112 113 114 115
     * Uniform Resource Identifier (Uri) http://tools.ietf.org/html/rfc3986.
     * This class is a simple parser which creates the basic component paths
     * (http://tools.ietf.org/html/rfc3986#section-3) with minimal validation
     * and encoding.
     *
     *       foo://example.com:8042/over/there?name=ferret#nose
     *       \_/   \______________/\_________/ \_________/ \__/
     *        |           |            |            |        |
     *     scheme     authority       path        query   fragment
     *        |   _____________________|__
     *       / \ /                        \
     *       urn:example:animal:ferret:nose
     *
     *
116
     */
117
    export class Uri {
J
Johannes Rieken 已提交
118
        static isUri(thing: any): thing is Uri;
119
        constructor();
120
        /**
121 122
         * scheme is the 'http' part of 'http://www.msft.com/some/path?query#fragment'.
         * The part before the first colon.
123
         */
D
Dirk Baeumer 已提交
124
        readonly scheme: string;
125
        /**
126 127
         * authority is the 'www.msft.com' part of 'http://www.msft.com/some/path?query#fragment'.
         * The part between the first double slashes and the next slash.
128
         */
D
Dirk Baeumer 已提交
129
        readonly authority: string;
130 131 132
        /**
         * path is the '/some/path' part of 'http://www.msft.com/some/path?query#fragment'.
         */
D
Dirk Baeumer 已提交
133
        readonly path: string;
134 135 136
        /**
         * query is the 'query' part of 'http://www.msft.com/some/path?query#fragment'.
         */
D
Dirk Baeumer 已提交
137
        readonly query: string;
138 139 140
        /**
         * fragment is the 'fragment' part of 'http://www.msft.com/some/path?query#fragment'.
         */
D
Dirk Baeumer 已提交
141
        readonly fragment: string;
142 143 144 145 146 147
        /**
         * Returns a string representing the corresponding file system path of this Uri.
         * Will handle UNC paths and normalize windows drive letters to lower-case. Also
         * uses the platform specific path separator. Will *not* validate the path for
         * invalid characters and semantics. Will *not* look at the scheme of this Uri.
         */
D
Dirk Baeumer 已提交
148
        readonly fsPath: string;
149 150 151 152 153 154 155
        with(change: {
            scheme?: string;
            authority?: string;
            path?: string;
            query?: string;
            fragment?: string;
        }): Uri;
156 157
        static parse(value: string): Uri;
        static file(path: string): Uri;
158 159 160 161 162 163 164
        static from(components: {
            scheme?: string;
            authority?: string;
            path?: string;
            query?: string;
            fragment?: string;
        }): Uri;
165 166 167 168 169 170 171 172
        /**
         *
         * @param skipEncoding Do not encode the result, default is `false`
         */
        toString(skipEncoding?: boolean): string;
        toJSON(): any;
        static revive(data: any): Uri;
    }
A
Alex Dima 已提交
173

A
Alex Dima 已提交
174
    /**
175 176 177
     * 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.
A
Alex Dima 已提交
178
     */
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
    export enum KeyCode {
        /**
         * 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,
        KEY_0 = 21,
        KEY_1 = 22,
        KEY_2 = 23,
        KEY_3 = 24,
        KEY_4 = 25,
        KEY_5 = 26,
        KEY_6 = 27,
        KEY_7 = 28,
        KEY_8 = 29,
        KEY_9 = 30,
        KEY_A = 31,
        KEY_B = 32,
        KEY_C = 33,
        KEY_D = 34,
        KEY_E = 35,
        KEY_F = 36,
        KEY_G = 37,
        KEY_H = 38,
        KEY_I = 39,
        KEY_J = 40,
        KEY_K = 41,
        KEY_L = 42,
        KEY_M = 43,
        KEY_N = 44,
        KEY_O = 45,
        KEY_P = 46,
        KEY_Q = 47,
        KEY_R = 48,
        KEY_S = 49,
        KEY_T = 50,
        KEY_U = 51,
        KEY_V = 52,
        KEY_W = 53,
        KEY_X = 54,
        KEY_Y = 55,
        KEY_Z = 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,
        NumLock = 78,
        ScrollLock = 79,
        /**
         * Used for miscellaneous characters; it can vary by keyboard.
         * For the US standard keyboard, the ';:' key
         */
        US_SEMICOLON = 80,
        /**
         * For any country/region, the '+' key
         * For the US standard keyboard, the '=+' key
         */
        US_EQUAL = 81,
        /**
         * For any country/region, the ',' key
         * For the US standard keyboard, the ',<' key
         */
        US_COMMA = 82,
        /**
         * For any country/region, the '-' key
         * For the US standard keyboard, the '-_' key
         */
        US_MINUS = 83,
        /**
         * For any country/region, the '.' key
         * For the US standard keyboard, the '.>' key
         */
        US_DOT = 84,
        /**
         * Used for miscellaneous characters; it can vary by keyboard.
         * For the US standard keyboard, the '/?' key
         */
        US_SLASH = 85,
        /**
         * Used for miscellaneous characters; it can vary by keyboard.
         * For the US standard keyboard, the '`~' key
         */
        US_BACKTICK = 86,
        /**
         * Used for miscellaneous characters; it can vary by keyboard.
         * For the US standard keyboard, the '[{' key
         */
        US_OPEN_SQUARE_BRACKET = 87,
        /**
         * Used for miscellaneous characters; it can vary by keyboard.
         * For the US standard keyboard, the '\|' key
         */
        US_BACKSLASH = 88,
        /**
         * Used for miscellaneous characters; it can vary by keyboard.
         * For the US standard keyboard, the ']}' key
         */
        US_CLOSE_SQUARE_BRACKET = 89,
        /**
         * Used for miscellaneous characters; it can vary by keyboard.
         * For the US standard keyboard, the ''"' key
         */
        US_QUOTE = 90,
        /**
         * Used for miscellaneous characters; it can vary by keyboard.
         */
        OEM_8 = 91,
        /**
         * Either the angle bracket key or the backslash key on the RT 102-key keyboard.
         */
        OEM_102 = 92,
        NUMPAD_0 = 93,
        NUMPAD_1 = 94,
        NUMPAD_2 = 95,
        NUMPAD_3 = 96,
        NUMPAD_4 = 97,
        NUMPAD_5 = 98,
        NUMPAD_6 = 99,
        NUMPAD_7 = 100,
        NUMPAD_8 = 101,
        NUMPAD_9 = 102,
        NUMPAD_MULTIPLY = 103,
        NUMPAD_ADD = 104,
        NUMPAD_SEPARATOR = 105,
        NUMPAD_SUBTRACT = 106,
        NUMPAD_DECIMAL = 107,
        NUMPAD_DIVIDE = 108,
        /**
         * Placed last to cover the length of the enum.
A
Alex Dima 已提交
344
         * Please do not depend on this value!
345 346 347
         */
        MAX_VALUE = 109,
    }
A
Alexandru Dima 已提交
348

349 350 351 352 353 354 355
    export class KeyMod {
        static CtrlCmd: number;
        static Shift: number;
        static Alt: number;
        static WinCtrl: number;
        static chord(firstPart: number, secondPart: number): number;
    }
356 357 358 359 360 361
    /**
     * MarkedString can be used to render human readable text. It is either a markdown string
     * or a code-block that provides a language and a code snippet. Note that
     * markdown strings will be sanitized - that means html will be escaped.
     */
    export type MarkedString = string | {
362 363
        language: string;
        value: string;
364
    };
A
Alex Dima 已提交
365

366
    export interface IKeyboardEvent {
367
        browserEvent: KeyboardEvent;
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
        target: HTMLElement;
        ctrlKey: boolean;
        shiftKey: boolean;
        altKey: boolean;
        metaKey: boolean;
        keyCode: KeyCode;
        asKeybinding(): number;
        equals(keybinding: number): boolean;
        preventDefault(): void;
        stopPropagation(): void;
    }
    export interface IMouseEvent {
        browserEvent: MouseEvent;
        leftButton: boolean;
        middleButton: boolean;
        rightButton: boolean;
        target: HTMLElement;
        detail: number;
        posx: number;
        posy: number;
        ctrlKey: boolean;
        shiftKey: boolean;
        altKey: boolean;
        metaKey: boolean;
        timestamp: number;
        preventDefault(): void;
        stopPropagation(): void;
    }
A
Alex Dima 已提交
396

397 398 399 400 401 402 403 404 405
    export interface IScrollEvent {
        scrollTop: number;
        scrollLeft: number;
        scrollWidth: number;
        scrollHeight: number;
        scrollTopChanged: boolean;
        scrollLeftChanged: boolean;
        scrollWidthChanged: boolean;
        scrollHeightChanged: boolean;
A
Alex Dima 已提交
406
    }
A
Alex Dima 已提交
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467

    /**
     * A position in the editor. This interface is suitable for serialization.
     */
    export interface IPosition {
        /**
         * line number (starts at 1)
         */
        lineNumber: number;
        /**
         * column (the first character in a line is between column 1 and column 2)
         */
        column: number;
    }

    /**
     * A range in the editor. This interface is suitable for serialization.
     */
    export interface IRange {
        /**
         * Line number on which the range starts (starts at 1).
         */
        startLineNumber: number;
        /**
         * Column on which the range starts in line `startLineNumber` (starts at 1).
         */
        startColumn: number;
        /**
         * Line number on which the range ends.
         */
        endLineNumber: number;
        /**
         * Column on which the range ends in line `endLineNumber`.
         */
        endColumn: number;
    }

    /**
     * A selection in the editor.
     * The selection is a range that has an orientation.
     */
    export interface ISelection {
        /**
         * The line number on which the selection has started.
         */
        selectionStartLineNumber: number;
        /**
         * The column on `selectionStartLineNumber` where the selection has started.
         */
        selectionStartColumn: number;
        /**
         * The line number on which the selection has ended.
         */
        positionLineNumber: number;
        /**
         * The column on `positionLineNumber` where the selection has ended.
         */
        positionColumn: number;
    }

    /**
468
     * A position in the editor.
A
Alex Dima 已提交
469 470
     */
    export class Position {
A
Alex Dima 已提交
471 472 473
        /**
         * line number (starts at 1)
         */
A
Alex Dima 已提交
474
        lineNumber: number;
A
Alex Dima 已提交
475 476 477
        /**
         * column (the first character in a line is between column 1 and column 2)
         */
A
Alex Dima 已提交
478 479
        column: number;
        constructor(lineNumber: number, column: number);
480 481 482
        /**
         * Test if this position equals other position
         */
A
Alex Dima 已提交
483
        equals(other: IPosition): boolean;
A
Alex Dima 已提交
484 485 486
        /**
         * Test if position `a` equals position `b`
         */
A
Alex Dima 已提交
487
        static equals(a: IPosition, b: IPosition): boolean;
488
        /**
A
Alex Dima 已提交
489 490
         * Test if this position is before other position.
         * If the two positions are equal, the result will be false.
491
         */
A
Alex Dima 已提交
492
        isBefore(other: IPosition): boolean;
A
Alex Dima 已提交
493 494 495 496
        /**
         * Test if position `a` is before position `b`.
         * If the two positions are equal, the result will be false.
         */
A
Alex Dima 已提交
497
        static isBefore(a: IPosition, b: IPosition): boolean;
498
        /**
A
Alex Dima 已提交
499 500
         * Test if this position is before other position.
         * If the two positions are equal, the result will be true.
501
         */
A
Alex Dima 已提交
502
        isBeforeOrEqual(other: IPosition): boolean;
A
Alex Dima 已提交
503 504 505 506
        /**
         * Test if position `a` is before position `b`.
         * If the two positions are equal, the result will be true.
         */
A
Alex Dima 已提交
507
        static isBeforeOrEqual(a: IPosition, b: IPosition): boolean;
508 509 510
        /**
         * Clone this position.
         */
A
Alex Dima 已提交
511
        clone(): Position;
A
Alex Dima 已提交
512 513 514
        /**
         * Convert to a human-readable representation.
         */
A
Alex Dima 已提交
515
        toString(): string;
A
Alex Dima 已提交
516 517 518
        /**
         * Create a `Position` from an `IPosition`.
         */
A
Alex Dima 已提交
519
        static lift(pos: IPosition): Position;
A
Alex Dima 已提交
520 521 522
        /**
         * Test if `obj` is an `IPosition`.
         */
A
Alex Dima 已提交
523 524 525
        static isIPosition(obj: any): obj is IPosition;
    }

526
    /**
A
Alex Dima 已提交
527
     * A range in the editor. (startLineNumber,startColumn) is <= (endLineNumber,endColumn)
528 529
     */
    export class Range {
A
Alex Dima 已提交
530 531 532
        /**
         * Line number on which the range starts (starts at 1).
         */
A
Alex Dima 已提交
533
        startLineNumber: number;
A
Alex Dima 已提交
534 535 536
        /**
         * Column on which the range starts in line `startLineNumber` (starts at 1).
         */
A
Alex Dima 已提交
537
        startColumn: number;
A
Alex Dima 已提交
538 539 540
        /**
         * Line number on which the range ends.
         */
A
Alex Dima 已提交
541
        endLineNumber: number;
A
Alex Dima 已提交
542 543 544
        /**
         * Column on which the range ends in line `endLineNumber`.
         */
A
Alex Dima 已提交
545 546
        endColumn: number;
        constructor(startLineNumber: number, startColumn: number, endLineNumber: number, endColumn: number);
547 548 549
        /**
         * Test if this range is empty.
         */
A
Alex Dima 已提交
550
        isEmpty(): boolean;
A
Alex Dima 已提交
551 552 553 554
        /**
         * Test if `range` is empty.
         */
        static isEmpty(range: IRange): boolean;
555 556 557
        /**
         * Test if position is in this range. If the position is at the edges, will return true.
         */
A
Alex Dima 已提交
558
        containsPosition(position: IPosition): boolean;
A
Alex Dima 已提交
559 560 561 562
        /**
         * Test if `position` is in `range`. If the position is at the edges, will return true.
         */
        static containsPosition(range: IRange, position: IPosition): boolean;
563 564 565
        /**
         * Test if range is in this range. If the range is equal to this range, will return true.
         */
A
Alex Dima 已提交
566
        containsRange(range: IRange): boolean;
567
        /**
A
Alex Dima 已提交
568 569 570 571 572 573
         * Test if `otherRange` is in `range`. If the ranges are equal, will return true.
         */
        static containsRange(range: IRange, otherRange: IRange): boolean;
        /**
         * A reunion of the two ranges.
         * The smallest position will be used as the start point, and the largest one as the end point.
574
         */
A
Alex Dima 已提交
575
        plusRange(range: IRange): Range;
A
Alex Dima 已提交
576 577 578 579 580
        /**
         * A reunion of the two ranges.
         * The smallest position will be used as the start point, and the largest one as the end point.
         */
        static plusRange(a: IRange, b: IRange): Range;
581 582 583
        /**
         * A intersection of the two ranges.
         */
A
Alex Dima 已提交
584
        intersectRanges(range: IRange): Range;
A
Alex Dima 已提交
585 586 587 588
        /**
         * A intersection of the two ranges.
         */
        static intersectRanges(a: IRange, b: IRange): Range;
589 590 591
        /**
         * Test if this range equals other.
         */
A
Alex Dima 已提交
592
        equalsRange(other: IRange): boolean;
A
Alex Dima 已提交
593 594 595 596
        /**
         * Test if range `a` equals `b`.
         */
        static equalsRange(a: IRange, b: IRange): boolean;
597 598 599
        /**
         * Return the end position (which will be after or equal to the start position)
         */
A
Alex Dima 已提交
600
        getEndPosition(): Position;
601 602 603
        /**
         * Return the start position (which will be before or equal to the end position)
         */
A
Alex Dima 已提交
604
        getStartPosition(): Position;
605 606 607
        /**
         * Clone this range.
         */
A
Alex Dima 已提交
608
        cloneRange(): Range;
609 610 611
        /**
         * Transform to a user presentable string representation.
         */
A
Alex Dima 已提交
612
        toString(): string;
613 614 615 616 617 618 619 620
        /**
         * Create a new range using this range's start position, and using endLineNumber and endColumn as the end position.
         */
        setEndPosition(endLineNumber: number, endColumn: number): Range;
        /**
         * Create a new range using this range's end position, and using startLineNumber and startColumn as the start position.
         */
        setStartPosition(startLineNumber: number, startColumn: number): Range;
A
Alex Dima 已提交
621 622 623
        /**
         * Create a new empty range using this range's start position.
         */
A
Alex Dima 已提交
624
        collapseToStart(): Range;
A
Alex Dima 已提交
625 626 627 628 629 630 631
        /**
         * Create a new empty range using this range's start position.
         */
        static collapseToStart(range: IRange): Range;
        /**
         * Create a `Range` from an `IRange`.
         */
632
        static lift(range: IRange): Range;
A
Alex Dima 已提交
633 634 635
        /**
         * Test if `obj` is an `IRange`.
         */
A
Alex Dima 已提交
636
        static isIRange(obj: any): obj is IRange;
A
Alex Dima 已提交
637 638 639
        /**
         * Test if the two ranges are touching in any way.
         */
A
Alex Dima 已提交
640 641 642 643 644 645 646 647 648 649 650
        static areIntersectingOrTouching(a: IRange, b: IRange): boolean;
        /**
         * A function that compares ranges, useful for sorting ranges
         * It will first compare ranges on the startPosition and then on the endPosition
         */
        static compareRangesUsingStarts(a: IRange, b: IRange): number;
        /**
         * A function that compares ranges, useful for sorting ranges
         * It will first compare ranges on the endPosition and then on the startPosition
         */
        static compareRangesUsingEnds(a: IRange, b: IRange): number;
A
Alex Dima 已提交
651 652 653
        /**
         * Test if the range spans multiple lines.
         */
A
Alex Dima 已提交
654 655 656
        static spansMultipleLines(range: IRange): boolean;
    }

657 658
    /**
     * A selection in the editor.
A
Alex Dima 已提交
659
     * The selection is a range that has an orientation.
660 661
     */
    export class Selection extends Range {
A
Alex Dima 已提交
662 663 664
        /**
         * The line number on which the selection has started.
         */
A
Alex Dima 已提交
665
        selectionStartLineNumber: number;
A
Alex Dima 已提交
666 667 668
        /**
         * The column on `selectionStartLineNumber` where the selection has started.
         */
A
Alex Dima 已提交
669
        selectionStartColumn: number;
A
Alex Dima 已提交
670 671 672
        /**
         * The line number on which the selection has ended.
         */
A
Alex Dima 已提交
673
        positionLineNumber: number;
A
Alex Dima 已提交
674 675 676
        /**
         * The column on `positionLineNumber` where the selection has ended.
         */
A
Alex Dima 已提交
677 678
        positionColumn: number;
        constructor(selectionStartLineNumber: number, selectionStartColumn: number, positionLineNumber: number, positionColumn: number);
679 680 681 682
        /**
         * Clone this selection.
         */
        clone(): Selection;
A
Alex Dima 已提交
683 684 685
        /**
         * Transform to a human-readable representation.
         */
A
Alex Dima 已提交
686
        toString(): string;
687 688 689
        /**
         * Test if equals other selection.
         */
A
Alex Dima 已提交
690
        equalsSelection(other: ISelection): boolean;
A
Alex Dima 已提交
691 692 693 694
        /**
         * Test if the two selections are equal.
         */
        static selectionsEqual(a: ISelection, b: ISelection): boolean;
695 696 697
        /**
         * Get directions (LTR or RTL).
         */
A
Alex Dima 已提交
698
        getDirection(): SelectionDirection;
699 700 701 702 703 704 705 706
        /**
         * Create a new selection with a different `positionLineNumber` and `positionColumn`.
         */
        setEndPosition(endLineNumber: number, endColumn: number): Selection;
        /**
         * Create a new selection with a different `selectionStartLineNumber` and `selectionStartColumn`.
         */
        setStartPosition(startLineNumber: number, startColumn: number): Selection;
A
Alex Dima 已提交
707 708 709
        /**
         * Create a `Selection` from an `ISelection`.
         */
710
        static liftSelection(sel: ISelection): Selection;
A
Alex Dima 已提交
711 712 713
        /**
         * `a` equals `b`.
         */
A
Alex Dima 已提交
714
        static selectionsArrEqual(a: ISelection[], b: ISelection[]): boolean;
A
Alex Dima 已提交
715 716 717 718 719 720 721
        /**
         * Test if `obj` is an `ISelection`.
         */
        static isISelection(obj: any): obj is ISelection;
        /**
         * Create with a direction.
         */
722
        static createWithDirection(startLineNumber: number, startColumn: number, endLineNumber: number, endColumn: number, direction: SelectionDirection): Selection;
A
Alex Dima 已提交
723
    }
A
Alex Dima 已提交
724 725 726 727 728 729 730 731 732 733 734 735 736 737

    /**
     * The direction of a selection.
     */
    export enum SelectionDirection {
        /**
         * The selection starts above where it ends.
         */
        LTR = 0,
        /**
         * The selection starts below where it ends.
         */
        RTL = 1,
    }
A
Alex Dima 已提交
738
}
739

A
Alex Dima 已提交
740
declare module monaco.editor {
741 742


A
Alex Dima 已提交
743 744 745 746 747
    /**
     * Create a new editor under `domElement`.
     * `domElement` should be empty (not contain other dom nodes).
     * The editor will read the size of `domElement`.
     */
748
    export function create(domElement: HTMLElement, options?: IEditorConstructionOptions, override?: IEditorOverrideServices): IStandaloneCodeEditor;
749

A
Alex Dima 已提交
750 751 752 753 754
    /**
     * Create a new diff editor under `domElement`.
     * `domElement` should be empty (not contain other dom nodes).
     * The editor will read the size of `domElement`.
     */
755
    export function createDiffEditor(domElement: HTMLElement, options?: IDiffEditorConstructionOptions, override?: IEditorOverrideServices): IStandaloneDiffEditor;
A
Alex Dima 已提交
756 757 758 759 760 761 762 763 764 765 766 767 768 769 770

    export interface IDiffNavigator {
        canNavigate(): boolean;
        next(): void;
        previous(): void;
        dispose(): void;
    }

    export interface IDiffNavigatorOptions {
        followsCaret?: boolean;
        ignoreCharChanges?: boolean;
        alwaysRevealFirst?: boolean;
    }

    export function createDiffNavigator(diffEditor: IStandaloneDiffEditor, opts?: IDiffNavigatorOptions): IDiffNavigator;
771

A
Alex Dima 已提交
772 773 774 775
    /**
     * Create a new editor model.
     * You can specify the language that should be set for this model or let the language be inferred from the `uri`.
     */
A
Alex Dima 已提交
776
    export function createModel(value: string, language?: string, uri?: Uri): IModel;
777

A
Alex Dima 已提交
778 779 780
    /**
     * Change the language for a model.
     */
A
Alex Dima 已提交
781 782
    export function setModelLanguage(model: IModel, language: string): void;

A
Alex Dima 已提交
783 784 785
    /**
     * Set the markers for a model.
     */
A
Alex Dima 已提交
786
    export function setModelMarkers(model: IModel, owner: string, markers: IMarkerData[]): void;
787

A
Alex Dima 已提交
788 789 790
    /**
     * Get the model that has `uri` if it exists.
     */
791 792
    export function getModel(uri: Uri): IModel;

A
Alex Dima 已提交
793 794 795
    /**
     * Get all the created models.
     */
A
Alex Dima 已提交
796 797
    export function getModels(): IModel[];

A
Alex Dima 已提交
798 799 800
    /**
     * Emitted when a model is created.
     */
801 802
    export function onDidCreateModel(listener: (model: IModel) => void): IDisposable;

A
Alex Dima 已提交
803 804 805
    /**
     * Emitted right before a model is disposed.
     */
806 807
    export function onWillDisposeModel(listener: (model: IModel) => void): IDisposable;

A
Alex Dima 已提交
808 809 810
    /**
     * Emitted when a different language is set to a model.
     */
A
Alex Dima 已提交
811
    export function onDidChangeModelLanguage(listener: (e: {
812
        model: IModel;
A
Alex Dima 已提交
813
        oldLanguage: string;
814 815
    }) => void): IDisposable;

816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836
    /**
     * Create a new web worker that has model syncing capabilities built in.
     * Specify an AMD module to load that will `create` an object that will be proxied.
     */
    export function createWebWorker<T>(opts: IWebWorkerOptions): MonacoWebWorker<T>;

    /**
     * Colorize the contents of `domNode` using attribute `data-lang`.
     */
    export function colorizeElement(domNode: HTMLElement, options: IColorizerElementOptions): Promise<void>;

    /**
     * Colorize `text` using language `languageId`.
     */
    export function colorize(text: string, languageId: string, options: IColorizerOptions): Promise<string>;

    /**
     * Colorize a line in a model.
     */
    export function colorizeModelLine(model: IModel, lineNumber: number, tabSize?: number): string;

A
Alex Dima 已提交
837 838 839
    /**
     * A web worker that can provide a proxy to an arbitrary file.
     */
A
Alex Dima 已提交
840
    export interface MonacoWebWorker<T> {
A
Alex Dima 已提交
841 842 843
        /**
         * Terminate the web worker, thus invalidating the returned proxy.
         */
844
        dispose(): void;
A
Alex Dima 已提交
845 846 847
        /**
         * Get a proxy to the arbitrary loaded code.
         */
848
        getProxy(): Promise<T>;
A
Alex Dima 已提交
849 850 851 852
        /**
         * Synchronize (send) the models at `resources` to the web worker,
         * making them available in the monaco.worker.getMirrorModels().
         */
A
Alex Dima 已提交
853
        withSyncedResources(resources: Uri[]): Promise<T>;
854 855 856
    }

    export interface IWebWorkerOptions {
A
Alex Dima 已提交
857 858 859 860
        /**
         * The AMD moduleId to load.
         * It should export a function `create` that should return the exported proxy.
         */
861
        moduleId: string;
862 863 864 865
        /**
         * The data to send over when calling create on the module.
         */
        createData?: any;
A
Alex Dima 已提交
866 867 868 869
        /**
         * A label to be used to identify the web worker for debugging purposes.
         */
        label?: string;
870 871
    }

A
Alex Dima 已提交
872 873 874
    /**
     * The options to create an editor.
     */
875
    export interface IEditorConstructionOptions extends ICodeEditorWidgetCreationOptions {
A
Alex Dima 已提交
876 877 878 879
        /**
         * The initial value of the auto created model in the editor.
         * To not create automatically a model, use `model: null`.
         */
880
        value?: string;
A
Alex Dima 已提交
881 882 883 884
        /**
         * The initial language of the auto created model in the editor.
         * To not create automatically a model, use `model: null`.
         */
A
Alex Dima 已提交
885
        language?: string;
886 887
    }

A
Alex Dima 已提交
888 889 890
    /**
     * The options to create a diff editor.
     */
891 892 893
    export interface IDiffEditorConstructionOptions extends IDiffEditorOptions {
    }

A
Alex Dima 已提交
894 895
    export interface IStandaloneCodeEditor extends ICodeEditor {
        addCommand(keybinding: number, handler: ICommandHandler, context: string): string;
A
Alex Dima 已提交
896
        createContextKey<T>(key: string, defaultValue: T): IContextKey<T>;
A
Alex Dima 已提交
897 898 899 900 901
        addAction(descriptor: IActionDescriptor): void;
    }

    export interface IStandaloneDiffEditor extends IDiffEditor {
        addCommand(keybinding: number, handler: ICommandHandler, context: string): string;
A
Alex Dima 已提交
902
        createContextKey<T>(key: string, defaultValue: T): IContextKey<T>;
A
Alex Dima 已提交
903 904 905 906 907 908
        addAction(descriptor: IActionDescriptor): void;
    }
    export interface ICommandHandler {
        (...args: any[]): void;
    }

A
Alex Dima 已提交
909
    export interface IContextKey<T> {
A
Alex Dima 已提交
910 911
        set(value: T): void;
        reset(): void;
J
Johannes Rieken 已提交
912
        get(): T;
A
Alex Dima 已提交
913 914
    }

915 916 917
    export interface IEditorOverrideServices {
    }

A
Alex Dima 已提交
918 919 920
    /**
     * A structure defining a problem/warning/etc.
     */
921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
    export interface IMarkerData {
        code?: string;
        severity: Severity;
        message: string;
        source?: string;
        startLineNumber: number;
        startColumn: number;
        endLineNumber: number;
        endColumn: number;
    }

    export interface IColorizerOptions {
        tabSize?: number;
    }

    export interface IColorizerElementOptions extends IColorizerOptions {
        theme?: string;
        mimeType?: string;
    }
940

941 942 943 944 945
    export enum ScrollbarVisibility {
        Auto = 1,
        Hidden = 2,
        Visible = 3,
    }
A
Alex Dima 已提交
946

947 948 949 950 951 952 953 954 955 956
    export interface IAction extends IDisposable {
        id: string;
        label: string;
        tooltip: string;
        class: string;
        enabled: boolean;
        checked: boolean;
        run(event?: any): Promise<any>;
    }

A
Alex Dima 已提交
957
    /**
958
     * Configuration options for editor scrollbars
A
Alex Dima 已提交
959
     */
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979
    export interface IEditorScrollbarOptions {
        /**
         * The size of arrows (if displayed).
         * Defaults to 11.
         */
        arrowSize?: number;
        /**
         * Render vertical scrollbar.
         * Accepted values: 'auto', 'visible', 'hidden'.
         * Defaults to 'auto'.
         */
        vertical?: string;
        /**
         * Render horizontal scrollbar.
         * Accepted values: 'auto', 'visible', 'hidden'.
         * Defaults to 'auto'.
         */
        horizontal?: string;
        /**
         * Cast horizontal and vertical shadows when the content is scrolled.
980
         * Defaults to true.
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
         */
        useShadows?: boolean;
        /**
         * Render arrows at the top and bottom of the vertical scrollbar.
         * Defaults to false.
         */
        verticalHasArrows?: boolean;
        /**
         * Render arrows at the left and right of the horizontal scrollbar.
         * Defaults to false.
         */
        horizontalHasArrows?: boolean;
        /**
         * Listen to mouse wheel events and react to them by scrolling.
         * Defaults to true.
         */
        handleMouseWheel?: boolean;
        /**
         * Height in pixels for the horizontal scrollbar.
         * Defaults to 10 (px).
         */
        horizontalScrollbarSize?: number;
        /**
         * Width in pixels for the vertical scrollbar.
         * Defaults to 10 (px).
         */
        verticalScrollbarSize?: number;
A
Alex Dima 已提交
1008 1009 1010 1011
        /**
         * Width in pixels for the vertical slider.
         * Defaults to `verticalScrollbarSize`.
         */
1012
        verticalSliderSize?: number;
A
Alex Dima 已提交
1013 1014 1015 1016
        /**
         * Height in pixels for the horizontal slider.
         * Defaults to `horizontalScrollbarSize`.
         */
1017 1018 1019
        horizontalSliderSize?: number;
    }

A
Alex Dima 已提交
1020 1021 1022
    /**
     * Describes how to indent wrapped lines.
     */
1023
    export enum WrappingIndent {
A
Alex Dima 已提交
1024 1025 1026
        /**
         * No indentation => wrapped lines begin at column 1.
         */
1027
        None = 0,
A
Alex Dima 已提交
1028 1029 1030
        /**
         * Same => wrapped lines get the same indentation as the parent.
         */
1031
        Same = 1,
A
Alex Dima 已提交
1032 1033 1034
        /**
         * Indent => wrapped lines get +1 indentation as the parent.
         */
1035 1036
        Indent = 2,
    }
1037

A
Alex Dima 已提交
1038
    /**
1039
     * Configuration options for the editor.
A
Alex Dima 已提交
1040
     */
1041
    export interface IEditorOptions {
A
Alex Dima 已提交
1042 1043 1044 1045
        /**
         * Enable experimental screen reader support.
         * Defaults to `true`.
         */
1046
        experimentalScreenReader?: boolean;
A
Alex Dima 已提交
1047 1048 1049
        /**
         * The aria label for the editor's textarea (when it is focused).
         */
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127
        ariaLabel?: string;
        /**
         * Render vertical lines at the specified columns.
         * Defaults to empty array.
         */
        rulers?: number[];
        /**
         * A string containing the word separators used when doing word navigation.
         * Defaults to `~!@#$%^&*()-=+[{]}\\|;:\'",.<>/?
         */
        wordSeparators?: string;
        /**
         * Enable Linux primary clipboard.
         * Defaults to true.
         */
        selectionClipboard?: boolean;
        /**
         * Control the rendering of line numbers.
         * If it is a function, it will be invoked when rendering a line number and the return value will be rendered.
         * Otherwise, if it is a truey, line numbers will be rendered normally (equivalent of using an identity function).
         * Otherwise, line numbers will not be rendered.
         * Defaults to true.
         */
        lineNumbers?: any;
        /**
         * Should the corresponding line be selected when clicking on the line number?
         * Defaults to true.
         */
        selectOnLineNumbers?: boolean;
        /**
         * Control the width of line numbers, by reserving horizontal space for rendering at least an amount of digits.
         * Defaults to 5.
         */
        lineNumbersMinChars?: number;
        /**
         * Enable the rendering of the glyph margin.
         * Defaults to false.
         */
        glyphMargin?: boolean;
        /**
         * The width reserved for line decorations (in px).
         * Line decorations are placed between line numbers and the editor content.
         * Defaults to 10.
         */
        lineDecorationsWidth?: number;
        /**
         * When revealing the cursor, a virtual padding (px) is added to the cursor, turning it into a rectangle.
         * This virtual padding ensures that the cursor gets revealed before hitting the edge of the viewport.
         * Defaults to 30 (px).
         */
        revealHorizontalRightPadding?: number;
        /**
         * Render the editor selection with rounded borders.
         * Defaults to true.
         */
        roundedSelection?: boolean;
        /**
         * Theme to be used for rendering. Consists of two parts, the UI theme and the syntax theme,
         * separated by a space.
         * The current available UI themes are: 'vs' (default), 'vs-dark', 'hc-black'
         * The syntax themes are contributed. The default is 'default-theme'
         */
        theme?: string;
        /**
         * Should the editor be read only.
         * Defaults to false.
         */
        readOnly?: boolean;
        /**
         * Control the behavior and rendering of the scrollbars.
         */
        scrollbar?: IEditorScrollbarOptions;
        /**
         * The number of vertical lanes the overview ruler should render.
         * Defaults to 2.
         */
        overviewRulerLanes?: number;
        /**
1128
         * Control the cursor animation style, possible values are 'blink', 'smooth', 'phase', 'expand' and 'solid'.
1129 1130 1131
         * Defaults to 'blink'.
         */
        cursorBlinking?: string;
1132 1133 1134 1135 1136
        /**
         * Zoom the font in the editor when using the mouse wheel in combination with holding Ctrl.
         * Defaults to false.
         */
        mouseWheelZoom?: boolean;
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146
        /**
         * Control the cursor style, either 'block' or 'line'.
         * Defaults to 'line'.
         */
        cursorStyle?: string;
        /**
         * Enable font ligatures.
         * Defaults to false.
         */
        fontLigatures?: boolean;
1147 1148 1149 1150 1151
        /**
         * Disable the use of `translate3d`.
         * Defaults to false.
         */
        disableTranslate3d?: boolean;
1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175
        /**
         * Should the cursor be hidden in the overview ruler.
         * Defaults to false.
         */
        hideCursorInOverviewRuler?: boolean;
        /**
         * Enable that scrolling can go one screen size after the last line.
         * Defaults to true.
         */
        scrollBeyondLastLine?: boolean;
        /**
         * Enable that the editor will install an interval to check if its container dom node size has changed.
         * Enabling this might have a severe performance impact.
         * Defaults to false.
         */
        automaticLayout?: boolean;
        /**
         * Control the wrapping strategy of the editor.
         * Using -1 means no wrapping whatsoever.
         * Using 0 means viewport width wrapping (ajusts with the resizing of the editor).
         * Using a positive number means wrapping after a fixed number of characters.
         * Defaults to 300.
         */
        wrappingColumn?: number;
1176
        /**
A
Alex Dima 已提交
1177 1178
         * Control the alternate style of viewport wrapping.
         * When set to true viewport wrapping is used only when the window width is less than the number of columns specified in the wrappingColumn property. Has no effect if wrappingColumn is not a positive number.
1179
         * Defaults to false.
1180
         */
1181
        wordWrap?: boolean;
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223
        /**
         * Control indentation of wrapped lines. Can be: 'none', 'same' or 'indent'.
         * Defaults to 'none'.
         */
        wrappingIndent?: string;
        /**
         * Configure word wrapping characters. A break will be introduced before these characters.
         * Defaults to '{([+'.
         */
        wordWrapBreakBeforeCharacters?: string;
        /**
         * Configure word wrapping characters. A break will be introduced after these characters.
         * Defaults to ' \t})]?|&,;'.
         */
        wordWrapBreakAfterCharacters?: string;
        /**
         * Configure word wrapping characters. A break will be introduced after these characters only if no `wordWrapBreakBeforeCharacters` or `wordWrapBreakAfterCharacters` were found.
         * Defaults to '.'.
         */
        wordWrapBreakObtrusiveCharacters?: string;
        /**
         * Performance guard: Stop rendering a line after x characters.
         * Defaults to 10000 if wrappingColumn is -1. Defaults to -1 if wrappingColumn is >= 0.
         * Use -1 to never stop rendering
         */
        stopRenderingLineAfter?: number;
        /**
         * Enable hover.
         * Defaults to true.
         */
        hover?: boolean;
        /**
         * Enable custom contextmenu.
         * Defaults to true.
         */
        contextmenu?: boolean;
        /**
         * A multiplier to be used on the `deltaX` and `deltaY` of mouse wheel scroll events.
         * Defaults to 1.
         */
        mouseWheelScrollSensitivity?: number;
        /**
P
Phill Campbell 已提交
1224
         * Enable quick suggestions (shadow suggestions)
1225 1226 1227 1228 1229 1230 1231 1232
         * Defaults to true.
         */
        quickSuggestions?: boolean;
        /**
         * Quick suggestions show delay (in ms)
         * Defaults to 500 (ms)
         */
        quickSuggestionsDelay?: number;
1233 1234 1235 1236
        /**
         * Enables parameter hints
         */
        parameterHints?: boolean;
1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261
        /**
         * Render icons in suggestions box.
         * Defaults to true.
         */
        iconsInSuggestions?: boolean;
        /**
         * Enable auto closing brackets.
         * Defaults to true.
         */
        autoClosingBrackets?: boolean;
        /**
         * Enable format on type.
         * Defaults to false.
         */
        formatOnType?: boolean;
        /**
         * Enable the suggestion box to pop-up on trigger characters.
         * Defaults to true.
         */
        suggestOnTriggerCharacters?: boolean;
        /**
         * Accept suggestions on ENTER.
         * Defaults to true.
         */
        acceptSuggestionOnEnter?: boolean;
1262 1263 1264
        /**
         * Enable snippet suggestions. Default to 'true'.
         */
1265
        snippetSuggestions?: 'top' | 'bottom' | 'inline' | 'none';
1266 1267 1268 1269
        /**
         * Enable tab completion. Defaults to 'false'
         */
        tabCompletion?: boolean;
1270 1271 1272 1273
        /**
         * Enable word based suggestions. Defaults to 'true'
         */
        wordBasedSuggestions?: boolean;
1274 1275 1276 1277 1278 1279
        /**
         * Enable selection highlight.
         * Defaults to true.
         */
        selectionHighlight?: boolean;
        /**
1280
         * Show code lens
1281 1282
         * Defaults to true.
         */
1283
        codeLens?: boolean;
1284 1285 1286 1287 1288 1289
        /**
         * Enable code folding
         * Defaults to true.
         */
        folding?: boolean;
        /**
1290 1291
         * Enable rendering of whitespace.
         * Defaults to none.
1292
         */
1293
        renderWhitespace?: 'none' | 'boundary' | 'all';
1294 1295 1296 1297 1298
        /**
         * Enable rendering of control characters.
         * Defaults to false.
         */
        renderControlCharacters?: boolean;
1299 1300
        /**
         * Enable rendering of indent guides.
1301
         * Defaults to false.
1302
         */
1303
        renderIndentGuides?: boolean;
1304 1305 1306 1307 1308
        /**
         * Enable rendering of current line highlight.
         * Defaults to true.
         */
        renderLineHighlight?: boolean;
1309 1310 1311 1312 1313 1314 1315 1316
        /**
         * Inserting and deleting whitespace follows tab stops.
         */
        useTabStops?: boolean;
        /**
         * The font family
         */
        fontFamily?: string;
1317 1318 1319 1320
        /**
         * The font weight
         */
        fontWeight?: 'normal' | 'bold' | 'bolder' | 'lighter' | 'initial' | 'inherit' | '100' | '200' | '300' | '400' | '500' | '600' | '700' | '800' | '900';
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330
        /**
         * The font size
         */
        fontSize?: number;
        /**
         * The line height
         */
        lineHeight?: number;
    }

A
Alex Dima 已提交
1331
    /**
1332
     * Configuration options for the diff editor.
A
Alex Dima 已提交
1333
     */
1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355
    export interface IDiffEditorOptions extends IEditorOptions {
        /**
         * Allow the user to resize the diff editor split view.
         * Defaults to true.
         */
        enableSplitViewResizing?: boolean;
        /**
         * Render the differences in two side-by-side editors.
         * Defaults to true.
         */
        renderSideBySide?: boolean;
        /**
         * Compute the diff by ignoring leading/trailing whitespace
         * Defaults to true.
         */
        ignoreTrimWhitespace?: boolean;
        /**
         * Original model should be editable?
         * Defaults to false.
         */
        originalEditable?: boolean;
    }
A
Alex Dima 已提交
1356

1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
    export class InternalEditorScrollbarOptions {
        _internalEditorScrollbarOptionsBrand: void;
        arrowSize: number;
        vertical: ScrollbarVisibility;
        horizontal: ScrollbarVisibility;
        useShadows: boolean;
        verticalHasArrows: boolean;
        horizontalHasArrows: boolean;
        handleMouseWheel: boolean;
        horizontalScrollbarSize: number;
        horizontalSliderSize: number;
        verticalScrollbarSize: number;
        verticalSliderSize: number;
        mouseWheelScrollSensitivity: number;
    }
A
Alex Dima 已提交
1372

1373 1374
    export class EditorWrappingInfo {
        _editorWrappingInfoBrand: void;
A
Alex Dima 已提交
1375 1376
        isViewportWrapping: boolean;
        wrappingColumn: number;
1377 1378 1379 1380
        wrappingIndent: WrappingIndent;
        wordWrapBreakBeforeCharacters: string;
        wordWrapBreakAfterCharacters: string;
        wordWrapBreakObtrusiveCharacters: string;
1381
    }
A
Alex Dima 已提交
1382

1383 1384
    export class InternalEditorViewOptions {
        _internalEditorViewOptionsBrand: void;
1385 1386
        theme: string;
        canUseTranslate3d: boolean;
A
Alex Dima 已提交
1387 1388 1389 1390 1391 1392 1393 1394 1395
        experimentalScreenReader: boolean;
        rulers: number[];
        ariaLabel: string;
        lineNumbers: any;
        selectOnLineNumbers: boolean;
        glyphMargin: boolean;
        revealHorizontalRightPadding: number;
        roundedSelection: boolean;
        overviewRulerLanes: number;
1396
        cursorBlinking: TextEditorCursorBlinkingStyle;
1397
        mouseWheelZoom: boolean;
1398
        cursorStyle: TextEditorCursorStyle;
A
Alex Dima 已提交
1399 1400
        hideCursorInOverviewRuler: boolean;
        scrollBeyondLastLine: boolean;
1401
        editorClassName: string;
A
Alex Dima 已提交
1402
        stopRenderingLineAfter: number;
1403
        renderWhitespace: 'none' | 'boundary' | 'all';
1404
        renderControlCharacters: boolean;
1405
        renderIndentGuides: boolean;
1406
        renderLineHighlight: boolean;
1407
        scrollbar: InternalEditorScrollbarOptions;
1408
    }
A
Alex Dima 已提交
1409

1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422
    export interface IViewConfigurationChangedEvent {
        theme: boolean;
        canUseTranslate3d: boolean;
        experimentalScreenReader: boolean;
        rulers: boolean;
        ariaLabel: boolean;
        lineNumbers: boolean;
        selectOnLineNumbers: boolean;
        glyphMargin: boolean;
        revealHorizontalRightPadding: boolean;
        roundedSelection: boolean;
        overviewRulerLanes: boolean;
        cursorBlinking: boolean;
1423
        mouseWheelZoom: boolean;
1424 1425 1426 1427 1428 1429
        cursorStyle: boolean;
        hideCursorInOverviewRuler: boolean;
        scrollBeyondLastLine: boolean;
        editorClassName: boolean;
        stopRenderingLineAfter: boolean;
        renderWhitespace: boolean;
1430
        renderControlCharacters: boolean;
1431
        renderIndentGuides: boolean;
1432
        renderLineHighlight: boolean;
1433 1434
        scrollbar: boolean;
    }
A
Alex Dima 已提交
1435

1436
    export class EditorContribOptions {
1437
        selectionClipboard: boolean;
A
Alex Dima 已提交
1438 1439 1440
        hover: boolean;
        contextmenu: boolean;
        quickSuggestions: boolean;
1441
        quickSuggestionsDelay: number;
1442
        parameterHints: boolean;
A
Alex Dima 已提交
1443 1444 1445
        iconsInSuggestions: boolean;
        formatOnType: boolean;
        suggestOnTriggerCharacters: boolean;
1446
        acceptSuggestionOnEnter: boolean;
1447
        snippetSuggestions: 'top' | 'bottom' | 'inline' | 'none';
1448
        tabCompletion: boolean;
1449
        wordBasedSuggestions: boolean;
A
Alex Dima 已提交
1450
        selectionHighlight: boolean;
1451
        codeLens: boolean;
A
Alex Dima 已提交
1452
        folding: boolean;
1453
    }
A
Alex Dima 已提交
1454

1455 1456 1457 1458 1459
    /**
     * Internal configuration options (transformed or computed) for the editor.
     */
    export class InternalEditorOptions {
        _internalEditorOptionsBrand: void;
A
Alex Dima 已提交
1460
        lineHeight: number;
1461 1462 1463 1464 1465 1466 1467 1468 1469 1470
        readOnly: boolean;
        wordSeparators: string;
        autoClosingBrackets: boolean;
        useTabStops: boolean;
        tabFocusMode: boolean;
        layoutInfo: EditorLayoutInfo;
        fontInfo: FontInfo;
        viewInfo: InternalEditorViewOptions;
        wrappingInfo: EditorWrappingInfo;
        contribInfo: EditorContribOptions;
1471
    }
A
Alex Dima 已提交
1472

1473
    /**
1474
     * An event describing that the configuration of the editor has changed.
1475
     */
1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489
    export interface IConfigurationChangedEvent {
        lineHeight: boolean;
        readOnly: boolean;
        wordSeparators: boolean;
        autoClosingBrackets: boolean;
        useTabStops: boolean;
        tabFocusMode: boolean;
        layoutInfo: boolean;
        fontInfo: boolean;
        viewInfo: IViewConfigurationChangedEvent;
        wrappingInfo: boolean;
        contribInfo: boolean;
    }

1490
    /**
1491
     * Vertical Lane in the overview ruler of the editor.
1492
     */
1493 1494 1495 1496 1497 1498 1499
    export enum OverviewRulerLane {
        Left = 1,
        Center = 2,
        Right = 4,
        Full = 7,
    }

1500
    /**
1501
     * Options for rendering a model decoration in the overview ruler.
1502
     */
1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519
    export interface IModelDecorationOverviewRulerOptions {
        /**
         * CSS color to render in the overview ruler.
         * e.g.: rgba(100, 100, 100, 0.5)
         */
        color: string;
        /**
         * CSS color to render in the overview ruler.
         * e.g.: rgba(100, 100, 100, 0.5)
         */
        darkColor: string;
        /**
         * The position in the overview ruler.
         */
        position: OverviewRulerLane;
    }

1520
    /**
1521
     * Options for a model decoration.
1522
     */
1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533
    export interface IModelDecorationOptions {
        /**
         * Customize the growing behaviour of the decoration when typing at the edges of the decoration.
         * Defaults to TrackedRangeStickiness.AlwaysGrowsWhenTypingAtEdges
         */
        stickiness?: TrackedRangeStickiness;
        /**
         * CSS class name describing the decoration.
         */
        className?: string;
        /**
1534
         * Array of MarkedString to render as the decoration message.
1535
         */
1536
        hoverMessage?: MarkedString | MarkedString[];
1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562
        /**
         * Should the decoration expand to encompass a whole line.
         */
        isWholeLine?: boolean;
        /**
         * @deprecated : Use `overviewRuler` instead
         */
        showInOverviewRuler?: string;
        /**
         * If set, render this decoration in the overview ruler.
         */
        overviewRuler?: IModelDecorationOverviewRulerOptions;
        /**
         * If set, the decoration will be rendered in the glyph margin with this CSS class name.
         */
        glyphMarginClassName?: string;
        /**
         * If set, the decoration will be rendered in the lines decorations with this CSS class name.
         */
        linesDecorationsClassName?: string;
        /**
         * If set, the decoration will be rendered inline with the text with this CSS class name.
         * Please use this only for CSS rules that must impact the text. For example, use `className`
         * to have a background color decoration.
         */
        inlineClassName?: string;
1563 1564 1565 1566 1567 1568 1569 1570
        /**
         * If set, the decoration will be rendered before the text with this CSS class name.
         */
        beforeContentClassName?: string;
        /**
         * If set, the decoration will be rendered after the text with this CSS class name.
         */
        afterContentClassName?: string;
1571 1572
    }

1573
    /**
1574
     * New model decorations.
1575
     */
1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586
    export interface IModelDeltaDecoration {
        /**
         * Range that this decoration covers.
         */
        range: IRange;
        /**
         * Options associated with this decoration.
         */
        options: IModelDecorationOptions;
    }

1587
    /**
1588
     * A decoration in the model.
1589
     */
1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601
    export interface IModelDecoration {
        /**
         * Identifier for a decoration.
         */
        id: string;
        /**
         * Identifier for a decoration's owener.
         */
        ownerId: number;
        /**
         * Range that this decoration covers.
         */
1602
        range: Range;
1603 1604 1605 1606 1607 1608
        /**
         * Options associated with this decoration.
         */
        options: IModelDecorationOptions;
    }

1609
    /**
1610
     * Word inside a model.
1611
     */
1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626
    export interface IWordAtPosition {
        /**
         * The word.
         */
        word: string;
        /**
         * The column where the word starts.
         */
        startColumn: number;
        /**
         * The column where the word ends.
         */
        endColumn: number;
    }

1627
    /**
1628
     * End of line character preference.
1629
     */
1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643
    export enum EndOfLinePreference {
        /**
         * Use the end of line character identified in the text buffer.
         */
        TextDefined = 0,
        /**
         * Use line feed (\n) as the end of line character.
         */
        LF = 1,
        /**
         * Use carriage return and line feed (\r\n) as the end of line character.
         */
        CRLF = 2,
    }
1644 1645

    /**
1646
     * The default end of line to use when instantiating models.
1647
     */
1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658
    export enum DefaultEndOfLine {
        /**
         * Use line feed (\n) as the end of line character.
         */
        LF = 1,
        /**
         * Use carriage return and line feed (\r\n) as the end of line character.
         */
        CRLF = 2,
    }

1659
    /**
1660
     * End of line character preference.
1661
     */
1662 1663 1664 1665 1666 1667 1668 1669 1670 1671
    export enum EndOfLineSequence {
        /**
         * Use line feed (\n) as the end of line character.
         */
        LF = 0,
        /**
         * Use carriage return and line feed (\r\n) as the end of line character.
         */
        CRLF = 1,
    }
1672 1673

    /**
1674
     * And identifier for a single edit operation.
1675
     */
1676 1677 1678 1679 1680 1681 1682 1683 1684 1685
    export interface ISingleEditOperationIdentifier {
        /**
         * Identifier major
         */
        major: number;
        /**
         * Identifier minor
         */
        minor: number;
    }
1686 1687

    /**
1688
     * A builder and helper for edit operations for a command.
1689
     */
1690 1691 1692 1693 1694 1695
    export interface IEditOperationBuilder {
        /**
         * Add a new edit operation (a replace operation).
         * @param range The range to replace (delete). May be empty to represent a simple insert.
         * @param text The text to replace with. May be null to represent a simple delete.
         */
1696
        addEditOperation(range: Range, text: string): void;
1697 1698 1699 1700 1701 1702 1703 1704 1705
        /**
         * Track `selection` when applying edit operations.
         * A best effort will be made to not grow/expand the selection.
         * An empty selection will clamp to a nearby character.
         * @param selection The selection to track.
         * @param trackPreviousOnEmpty If set, and the selection is empty, indicates whether the selection
         *           should clamp to the previous or the next character.
         * @return A unique identifer.
         */
1706
        trackSelection(selection: Selection, trackPreviousOnEmpty?: boolean): string;
1707
    }
1708

A
Alex Dima 已提交
1709
    /**
1710
     * A helper for computing cursor state after a command.
A
Alex Dima 已提交
1711
     */
1712 1713 1714 1715 1716 1717 1718 1719 1720 1721
    export interface ICursorStateComputerData {
        /**
         * Get the inverse edit operations of the added edit operations.
         */
        getInverseEditOperations(): IIdentifiedSingleEditOperation[];
        /**
         * Get a previously tracked selection.
         * @param id The unique identifier returned by `trackSelection`.
         * @return The selection.
         */
1722
        getTrackedSelection(id: string): Selection;
1723
    }
1724

A
Alex Dima 已提交
1725
    /**
1726
     * A command that modifies text / cursor state on a model.
A
Alex Dima 已提交
1727
     */
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740
    export interface ICommand {
        /**
         * Get the edit operations needed to execute this command.
         * @param model The model the command will execute on.
         * @param builder A helper to collect the needed edit operations and to track selections.
         */
        getEditOperations(model: ITokenizedModel, builder: IEditOperationBuilder): void;
        /**
         * Compute the cursor state after the edit operations were applied.
         * @param model The model the commad has executed on.
         * @param helper A helper to get inverse edit operations and to get previously tracked selections.
         * @return The cursor state after the command executed.
         */
1741
        computeCursorState(model: ITokenizedModel, helper: ICursorStateComputerData): Selection;
1742 1743
    }

1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763
    /**
     * A single edit operation, that acts as a simple replace.
     * i.e. Replace text at `range` with `text` in model.
     */
    export interface ISingleEditOperation {
        /**
         * The range to replace. This can be empty to emulate a simple insert.
         */
        range: IRange;
        /**
         * The text to replace with. This can be null to emulate a simple delete.
         */
        text: string;
        /**
         * This indicates that this operation has "insert" semantics.
         * i.e. forceMoveMarkers = true => if `range` is collapsed, all markers at the position will be moved.
         */
        forceMoveMarkers?: boolean;
    }

A
Alex Dima 已提交
1764
    /**
1765
     * A single edit operation, that has an identifier.
A
Alex Dima 已提交
1766
     */
1767 1768 1769 1770 1771 1772 1773 1774
    export interface IIdentifiedSingleEditOperation {
        /**
         * An identifier associated with this single edit operation.
         */
        identifier: ISingleEditOperationIdentifier;
        /**
         * The range to replace. This can be empty to emulate a simple insert.
         */
1775
        range: Range;
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790
        /**
         * The text to replace with. This can be null to emulate a simple delete.
         */
        text: string;
        /**
         * This indicates that this operation has "insert" semantics.
         * i.e. forceMoveMarkers = true => if `range` is collapsed, all markers at the position will be moved.
         */
        forceMoveMarkers: boolean;
        /**
         * This indicates that this operation is inserting automatic whitespace
         * that can be removed on next model edit operation if `config.trimAutoWhitespace` is true.
         */
        isAutoWhitespaceEdit?: boolean;
    }
1791

A
Alex Dima 已提交
1792
    /**
1793
     * A callback that can compute the cursor state after applying a series of edit operations.
A
Alex Dima 已提交
1794
     */
1795 1796 1797 1798
    export interface ICursorStateComputer {
        /**
         * A callback that can compute the resulting cursors state after some edit operations have been executed.
         */
1799
        (inverseEditOperations: IIdentifiedSingleEditOperation[]): Selection[];
1800 1801 1802 1803 1804 1805 1806 1807
    }

    export interface ITextModelResolvedOptions {
        tabSize: number;
        insertSpaces: boolean;
        defaultEOL: DefaultEndOfLine;
        trimAutoWhitespace: boolean;
    }
A
Alex Dima 已提交
1808

1809 1810 1811 1812 1813
    export interface ITextModelUpdateOptions {
        tabSize?: number;
        insertSpaces?: boolean;
        trimAutoWhitespace?: boolean;
    }
1814

1815 1816 1817 1818 1819
    export interface IModelOptionsChangedEvent {
        tabSize: boolean;
        insertSpaces: boolean;
        trimAutoWhitespace: boolean;
    }
1820

A
Alex Dima 已提交
1821
    /**
1822
     * A textual read-only model.
A
Alex Dima 已提交
1823
     */
1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841
    export interface ITextModel {
        getOptions(): ITextModelResolvedOptions;
        /**
         * Get the current version id of the model.
         * Anytime a change happens to the model (even undo/redo),
         * the version id is incremented.
         */
        getVersionId(): number;
        /**
         * Get the alternative version id of the model.
         * This alternative version id is not always incremented,
         * it will return the same values in the case of undo-redo.
         */
        getAlternativeVersionId(): number;
        /**
         * Replace the entire text buffer value contained in this model.
         */
        setValue(newValue: string): void;
A
Alex Dima 已提交
1842 1843 1844 1845
        /**
         * Replace the entire text buffer value contained in this model.
         */
        setValueFromRawText(newValue: IRawText): void;
1846 1847 1848 1849 1850 1851 1852
        /**
         * Get the text stored in this model.
         * @param eol The end of line character preference. Defaults to `EndOfLinePreference.TextDefined`.
         * @param preserverBOM Preserve a BOM character if it was detected when the model was constructed.
         * @return The text.
         */
        getValue(eol?: EndOfLinePreference, preserveBOM?: boolean): string;
A
Alex Dima 已提交
1853 1854 1855
        /**
         * Get the length of the text stored in this model.
         */
1856
        getValueLength(eol?: EndOfLinePreference, preserveBOM?: boolean): number;
A
Alex Dima 已提交
1857 1858 1859
        /**
         * Get the raw text stored in this model.
         */
1860
        toRawText(): IRawText;
A
Alex Dima 已提交
1861 1862 1863
        /**
         * Check if the raw text stored in this model equals another raw text.
         */
1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890
        equals(other: IRawText): boolean;
        /**
         * Get the text in a certain range.
         * @param range The range describing what text to get.
         * @param eol The end of line character preference. This will only be used for multiline ranges. Defaults to `EndOfLinePreference.TextDefined`.
         * @return The text.
         */
        getValueInRange(range: IRange, eol?: EndOfLinePreference): string;
        /**
         * Get the length of text in a certain range.
         * @param range The range describing what text length to get.
         * @return The text length.
         */
        getValueLengthInRange(range: IRange): number;
        /**
         * Get the number of lines in the model.
         */
        getLineCount(): number;
        /**
         * Get the text for a certain line.
         */
        getLineContent(lineNumber: number): string;
        /**
         * Get the text for all lines.
         */
        getLinesContent(): string[];
        /**
A
Alex Dima 已提交
1891
         * Get the end of line sequence predominantly used in the text buffer.
1892 1893 1894
         * @return EOL char sequence (e.g.: '\n' or '\r\n').
         */
        getEOL(): string;
A
Alex Dima 已提交
1895 1896 1897
        /**
         * Change the end of line sequence used in the text buffer.
         */
1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919
        setEOL(eol: EndOfLineSequence): void;
        /**
         * Get the minimum legal column for line at `lineNumber`
         */
        getLineMinColumn(lineNumber: number): number;
        /**
         * Get the maximum legal column for line at `lineNumber`
         */
        getLineMaxColumn(lineNumber: number): number;
        /**
         * Returns the column before the first non whitespace character for line at `lineNumber`.
         * Returns 0 if line is empty or contains only whitespace.
         */
        getLineFirstNonWhitespaceColumn(lineNumber: number): number;
        /**
         * Returns the column after the last non whitespace character for line at `lineNumber`.
         * Returns 0 if line is empty or contains only whitespace.
         */
        getLineLastNonWhitespaceColumn(lineNumber: number): number;
        /**
         * Create a valid position,
         */
A
Alex Dima 已提交
1920
        validatePosition(position: IPosition): Position;
1921 1922 1923 1924 1925 1926 1927 1928 1929 1930
        /**
         * Advances the given position by the given offest (negative offsets are also accepted)
         * and returns it as a new valid position.
         *
         * If the offset and position are such that their combination goes beyond the beginning or
         * end of the model, throws an exception.
         *
         * If the ofsset is such that the new position would be in the middle of a multi-byte
         * line terminator, throws an exception.
         */
A
Alex Dima 已提交
1931
        modifyPosition(position: IPosition, offset: number): Position;
1932 1933 1934
        /**
         * Create a valid range.
         */
1935
        validateRange(range: IRange): Range;
A
Alex Dima 已提交
1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951
        /**
         * Converts the position to a zero-based offset.
         *
         * The position will be [adjusted](#TextDocument.validatePosition).
         *
         * @param position A position.
         * @return A valid zero-based offset.
         */
        getOffsetAt(position: IPosition): number;
        /**
         * Converts a zero-based offset to a position.
         *
         * @param offset A zero-based offset.
         * @return A valid [position](#Position).
         */
        getPositionAt(offset: number): Position;
1952 1953 1954
        /**
         * Get a range covering the entire model
         */
1955
        getFullModelRange(): Range;
1956 1957 1958 1959
        /**
         * Returns iff the model was disposed or not.
         */
        isDisposed(): boolean;
A
Alex Dima 已提交
1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001
        /**
         * Search the model.
         * @param searchString The string used to search. If it is a regular expression, set `isRegex` to true.
         * @param searchOnlyEditableRange Limit the searching to only search inside the editable range of the model.
         * @param isRegex Used to indicate that `searchString` is a regular expression.
         * @param matchCase Force the matching to match lower/upper case exactly.
         * @param wholeWord Force the matching to match entire words only.
         * @param limitResultCount Limit the number of results
         * @return The ranges where the matches are. It is empty if not matches have been found.
         */
        findMatches(searchString: string, searchOnlyEditableRange: boolean, isRegex: boolean, matchCase: boolean, wholeWord: boolean, limitResultCount?: number): Range[];
        /**
         * Search the model.
         * @param searchString The string used to search. If it is a regular expression, set `isRegex` to true.
         * @param searchScope Limit the searching to only search inside this range.
         * @param isRegex Used to indicate that `searchString` is a regular expression.
         * @param matchCase Force the matching to match lower/upper case exactly.
         * @param wholeWord Force the matching to match entire words only.
         * @param limitResultCount Limit the number of results
         * @return The ranges where the matches are. It is empty if no matches have been found.
         */
        findMatches(searchString: string, searchScope: IRange, isRegex: boolean, matchCase: boolean, wholeWord: boolean, limitResultCount?: number): Range[];
        /**
         * Search the model for the next match. Loops to the beginning of the model if needed.
         * @param searchString The string used to search. If it is a regular expression, set `isRegex` to true.
         * @param searchStart Start the searching at the specified position.
         * @param isRegex Used to indicate that `searchString` is a regular expression.
         * @param matchCase Force the matching to match lower/upper case exactly.
         * @param wholeWord Force the matching to match entire words only.
         * @return The range where the next match is. It is null if no next match has been found.
         */
        findNextMatch(searchString: string, searchStart: IPosition, isRegex: boolean, matchCase: boolean, wholeWord: boolean): Range;
        /**
         * Search the model for the previous match. Loops to the end of the model if needed.
         * @param searchString The string used to search. If it is a regular expression, set `isRegex` to true.
         * @param searchStart Start the searching at the specified position.
         * @param isRegex Used to indicate that `searchString` is a regular expression.
         * @param matchCase Force the matching to match lower/upper case exactly.
         * @param wholeWord Force the matching to match entire words only.
         * @return The range where the previous match is. It is null if no previous match has been found.
         */
        findPreviousMatch(searchString: string, searchStart: IPosition, isRegex: boolean, matchCase: boolean, wholeWord: boolean): Range;
2002
    }
A
Alex Dima 已提交
2003

2004 2005 2006 2007 2008
    export interface IReadOnlyModel extends ITextModel {
        /**
         * Gets the resource associated with this editor model.
         */
        uri: Uri;
A
Alex Dima 已提交
2009 2010 2011
        /**
         * Get the language associated with this model.
         */
2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027
        getModeId(): string;
        /**
         * Get the word under or besides `position`.
         * @param position The position to look for a word.
         * @param skipSyntaxTokens Ignore syntax tokens, as identified by the mode.
         * @return The word under or besides `position`. Might be null.
         */
        getWordAtPosition(position: IPosition): IWordAtPosition;
        /**
         * Get the word under or besides `position` trimmed to `position`.column
         * @param position The position to look for a word.
         * @param skipSyntaxTokens Ignore syntax tokens, as identified by the mode.
         * @return The word under or besides `position`. Will never be null.
         */
        getWordUntilPosition(position: IPosition): IWordAtPosition;
    }
A
Alex Dima 已提交
2028 2029

    /**
2030
     * A model that is tokenized.
A
Alex Dima 已提交
2031
     */
2032 2033 2034 2035
    export interface ITokenizedModel extends ITextModel {
        /**
         * Get the current language mode associated with the model.
         */
2036
        getMode(): languages.IMode;
A
Alex Dima 已提交
2037 2038 2039 2040
        /**
         * Get the language associated with this model.
         */
        getModeId(): string;
2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055
        /**
         * Get the word under or besides `position`.
         * @param position The position to look for a word.
         * @param skipSyntaxTokens Ignore syntax tokens, as identified by the mode.
         * @return The word under or besides `position`. Might be null.
         */
        getWordAtPosition(position: IPosition): IWordAtPosition;
        /**
         * Get the word under or besides `position` trimmed to `position`.column
         * @param position The position to look for a word.
         * @param skipSyntaxTokens Ignore syntax tokens, as identified by the mode.
         * @return The word under or besides `position`. Will never be null.
         */
        getWordUntilPosition(position: IPosition): IWordAtPosition;
    }
2056

A
Alex Dima 已提交
2057
    /**
2058
     * A model that can track markers.
A
Alex Dima 已提交
2059
     */
2060 2061 2062
    export interface ITextModelWithMarkers extends ITextModel {
    }

A
Alex Dima 已提交
2063 2064 2065
    /**
     * Describes the behaviour of decorations when typing/editing near their edges.
     */
2066 2067 2068 2069 2070 2071
    export enum TrackedRangeStickiness {
        AlwaysGrowsWhenTypingAtEdges = 0,
        NeverGrowsWhenTypingAtEdges = 1,
        GrowsOnlyWhenTypingBefore = 2,
        GrowsOnlyWhenTypingAfter = 3,
    }
2072 2073

    /**
2074
     * A model that can track ranges.
2075
     */
2076 2077
    export interface ITextModelWithTrackedRanges extends ITextModel {
    }
2078 2079

    /**
2080
     * A model that can have decorations.
2081
     */
2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104
    export interface ITextModelWithDecorations {
        /**
         * Perform a minimum ammount of operations, in order to transform the decorations
         * identified by `oldDecorations` to the decorations described by `newDecorations`
         * and returns the new identifiers associated with the resulting decorations.
         *
         * @param oldDecorations Array containing previous decorations identifiers.
         * @param newDecorations Array describing what decorations should result after the call.
         * @param ownerId Identifies the editor id in which these decorations should appear. If no `ownerId` is provided, the decorations will appear in all editors that attach this model.
         * @return An array containing the new decorations identifiers.
         */
        deltaDecorations(oldDecorations: string[], newDecorations: IModelDeltaDecoration[], ownerId?: number): string[];
        /**
         * Get the options associated with a decoration.
         * @param id The decoration id.
         * @return The decoration options or null if the decoration was not found.
         */
        getDecorationOptions(id: string): IModelDecorationOptions;
        /**
         * Get the range associated with a decoration.
         * @param id The decoration id.
         * @return The decoration range or null if the decoration was not found.
         */
2105
        getDecorationRange(id: string): Range;
2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138
        /**
         * Gets all the decorations for the line `lineNumber` as an array.
         * @param lineNumber The line number
         * @param ownerId If set, it will ignore decorations belonging to other owners.
         * @param filterOutValidation If set, it will ignore decorations specific to validation (i.e. warnings, errors).
         * @return An array with the decorations
         */
        getLineDecorations(lineNumber: number, ownerId?: number, filterOutValidation?: boolean): IModelDecoration[];
        /**
         * Gets all the decorations for the lines between `startLineNumber` and `endLineNumber` as an array.
         * @param startLineNumber The start line number
         * @param endLineNumber The end line number
         * @param ownerId If set, it will ignore decorations belonging to other owners.
         * @param filterOutValidation If set, it will ignore decorations specific to validation (i.e. warnings, errors).
         * @return An array with the decorations
         */
        getLinesDecorations(startLineNumber: number, endLineNumber: number, ownerId?: number, filterOutValidation?: boolean): IModelDecoration[];
        /**
         * Gets all the deocorations in a range as an array. Only `startLineNumber` and `endLineNumber` from `range` are used for filtering.
         * So for now it returns all the decorations on the same line as `range`.
         * @param range The range to search in
         * @param ownerId If set, it will ignore decorations belonging to other owners.
         * @param filterOutValidation If set, it will ignore decorations specific to validation (i.e. warnings, errors).
         * @return An array with the decorations
         */
        getDecorationsInRange(range: IRange, ownerId?: number, filterOutValidation?: boolean): IModelDecoration[];
        /**
         * Gets all the decorations as an array.
         * @param ownerId If set, it will ignore decorations belonging to other owners.
         * @param filterOutValidation If set, it will ignore decorations specific to validation (i.e. warnings, errors).
         */
        getAllDecorations(ownerId?: number, filterOutValidation?: boolean): IModelDecoration[];
    }
A
Alex Dima 已提交
2139

2140
    /**
2141
     * An editable text model.
2142
     */
2143
    export interface IEditableTextModel extends ITextModelWithMarkers {
A
Alex Dima 已提交
2144 2145 2146
        /**
         * Normalize a string containing whitespace according to indentation rules (converts to spaces or to tabs).
         */
2147
        normalizeIndentation(str: string): string;
A
Alex Dima 已提交
2148 2149 2150
        /**
         * Get what is considered to be one indent (e.g. a tab character or 4 spaces, etc.).
         */
2151
        getOneIndent(): string;
A
Alex Dima 已提交
2152 2153 2154
        /**
         * Change the options of this model.
         */
2155
        updateOptions(newOpts: ITextModelUpdateOptions): void;
A
Alex Dima 已提交
2156 2157 2158
        /**
         * Detect the indentation options for this model from its content.
         */
2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173
        detectIndentation(defaultInsertSpaces: boolean, defaultTabSize: number): void;
        /**
         * Push a stack element onto the undo stack. This acts as an undo/redo point.
         * The idea is to use `pushEditOperations` to edit the model and then to
         * `pushStackElement` to create an undo/redo stop point.
         */
        pushStackElement(): void;
        /**
         * Push edit operations, basically editing the model. This is the preferred way
         * of editing the model. The edit operations will land on the undo stack.
         * @param beforeCursorState The cursor state before the edit operaions. This cursor state will be returned when `undo` or `redo` are invoked.
         * @param editOperations The edit operations.
         * @param cursorStateComputer A callback that can compute the resulting cursors state after the edit operations have been executed.
         * @return The cursor state returned by the `cursorStateComputer`.
         */
2174
        pushEditOperations(beforeCursorState: Selection[], editOperations: IIdentifiedSingleEditOperation[], cursorStateComputer: ICursorStateComputer): Selection[];
2175 2176 2177 2178 2179 2180 2181 2182 2183
        /**
         * Edit the model without adding the edits to the undo stack.
         * This can have dire consequences on the undo stack! See @pushEditOperations for the preferred way.
         * @param operations The edit operations.
         * @return The inverse edit operations, that, when applied, will bring the model back to the previous state.
         */
        applyEdits(operations: IIdentifiedSingleEditOperation[]): IIdentifiedSingleEditOperation[];
    }

2184
    /**
2185
     * A model.
2186
     */
A
Alex Dima 已提交
2187
    export interface IModel extends IReadOnlyModel, IEditableTextModel, ITextModelWithMarkers, ITokenizedModel, ITextModelWithTrackedRanges, ITextModelWithDecorations, IEditorModel {
A
Alex Dima 已提交
2188 2189 2190
        /**
         * An event emitted when the contents of the model have changed.
         */
A
Alex Dima 已提交
2191
        onDidChangeContent(listener: (e: IModelContentChangedEvent2) => void): IDisposable;
A
Alex Dima 已提交
2192 2193 2194
        /**
         * An event emitted when decorations of the model have changed.
         */
A
Alex Dima 已提交
2195
        onDidChangeDecorations(listener: (e: IModelDecorationsChangedEvent) => void): IDisposable;
A
Alex Dima 已提交
2196 2197 2198
        /**
         * An event emitted when the model options have changed.
         */
A
Alex Dima 已提交
2199
        onDidChangeOptions(listener: (e: IModelOptionsChangedEvent) => void): IDisposable;
A
Alex Dima 已提交
2200 2201 2202
        /**
         * An event emitted when the language associated with the model has changed.
         */
A
Alex Dima 已提交
2203
        onDidChangeMode(listener: (e: IModelModeChangedEvent) => void): IDisposable;
A
Alex Dima 已提交
2204 2205 2206
        /**
         * An event emitted right before disposing the model.
         */
A
Alex Dima 已提交
2207
        onWillDispose(listener: () => void): IDisposable;
2208 2209 2210 2211 2212 2213 2214 2215
        /**
         * A unique identifier associated with this model.
         */
        id: string;
        /**
         * Destroy this model. This will unbind the model from the mode
         * and make all necessary clean-up to release this object to the GC.
         */
2216
        dispose(): void;
2217
    }
A
Alex Dima 已提交
2218

2219
    /**
2220
     * An event describing that the current mode associated with a model has changed.
2221
     */
2222 2223 2224 2225
    export interface IModelModeChangedEvent {
        /**
         * Previous mode
         */
2226
        oldMode: languages.IMode;
2227 2228 2229
        /**
         * New mode
         */
2230
        newMode: languages.IMode;
2231 2232
    }

2233
    /**
2234
     * An event describing a change in the text of a model.
2235
     */
2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266
    export interface IModelContentChangedEvent2 {
        /**
         * The range that got replaced.
         */
        range: IRange;
        /**
         * The length of the range that got replaced.
         */
        rangeLength: number;
        /**
         * The new text for the range.
         */
        text: string;
        /**
         * The (new) end-of-line character.
         */
        eol: string;
        /**
         * The new version id the model has transitioned to.
         */
        versionId: number;
        /**
         * Flag that indicates that this event was generated while undoing.
         */
        isUndoing: boolean;
        /**
         * Flag that indicates that this event was generated while redoing.
         */
        isRedoing: boolean;
    }

A
Alex Dima 已提交
2267 2268 2269
    /**
     * The raw text backing a model.
     */
2270
    export interface IRawText {
A
Alex Dima 已提交
2271 2272 2273
        /**
         * The entire text length.
         */
2274
        length: number;
A
Alex Dima 已提交
2275 2276 2277
        /**
         * The text split into lines.
         */
2278
        lines: string[];
A
Alex Dima 已提交
2279 2280 2281
        /**
         * The BOM (leading character sequence of the file).
         */
2282
        BOM: string;
A
Alex Dima 已提交
2283 2284 2285
        /**
         * The end of line sequence.
         */
2286
        EOL: string;
A
Alex Dima 已提交
2287 2288 2289
        /**
         * The options associated with this text.
         */
2290 2291 2292
        options: ITextModelResolvedOptions;
    }

2293
    /**
2294
     * Decoration data associated with a model decorations changed event.
2295
     */
2296
    export interface IModelDecorationsChangedEventDecorationData {
A
Alex Dima 已提交
2297 2298 2299
        /**
         * The id of the decoration.
         */
2300
        id: string;
A
Alex Dima 已提交
2301 2302 2303
        /**
         * The owner id of the decoration.
         */
2304
        ownerId: number;
A
Alex Dima 已提交
2305 2306 2307
        /**
         * The range of the decoration.
         */
2308
        range: IRange;
A
Alex Dima 已提交
2309 2310 2311
        /**
         * A flag describing if this is a problem decoration (e.g. warning/error).
         */
2312
        isForValidation: boolean;
A
Alex Dima 已提交
2313 2314 2315
        /**
         * The options for this decoration.
         */
2316 2317 2318
        options: IModelDecorationOptions;
    }

2319
    /**
2320
     * An event describing that model decorations have changed.
2321
     */
2322 2323 2324 2325 2326 2327
    export interface IModelDecorationsChangedEvent {
        /**
         * A summary with ids of decorations that have changed.
         */
        ids: string[];
        /**
A
Alex Dima 已提交
2328
         * Lists of details for added or changed decorations.
2329 2330
         */
        addedOrChangedDecorations: IModelDecorationsChangedEventDecorationData[];
A
Alex Dima 已提交
2331 2332 2333
        /**
         * List of ids for removed decorations.
         */
2334
        removedDecorations: string[];
A
Alex Dima 已提交
2335 2336 2337
        /**
         * Details regarding old options.
         */
2338 2339 2340
        oldOptions: {
            [decorationId: string]: IModelDecorationOptions;
        };
A
Alex Dima 已提交
2341 2342 2343
        /**
         * Details regarding old ranges.
         */
2344 2345 2346 2347 2348
        oldRanges: {
            [decorationId: string]: IRange;
        };
    }

2349
    /**
2350
     * An event describing that a range of lines has been tokenized
2351
     */
2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362
    export interface IModelTokensChangedEvent {
        /**
         * The start of the range (inclusive)
         */
        fromLineNumber: number;
        /**
         * The end of the range (inclusive)
         */
        toLineNumber: number;
    }

A
Alex Dima 已提交
2363 2364 2365
    /**
     * Describes the reason the cursor has changed its position.
     */
2366
    export enum CursorChangeReason {
A
Alex Dima 已提交
2367 2368 2369
        /**
         * Unknown or not set.
         */
2370
        NotSet = 0,
A
Alex Dima 已提交
2371 2372 2373
        /**
         * A `model.setValue()` was called.
         */
2374
        ContentFlush = 1,
A
Alex Dima 已提交
2375 2376 2377
        /**
         * The `model` has been changed outside of this cursor and the cursor recovers its position from associated markers.
         */
2378
        RecoverFromMarkers = 2,
A
Alex Dima 已提交
2379 2380 2381
        /**
         * There was an explicit user gesture.
         */
2382
        Explicit = 3,
A
Alex Dima 已提交
2383 2384 2385
        /**
         * There was a Paste.
         */
2386
        Paste = 4,
A
Alex Dima 已提交
2387 2388 2389
        /**
         * There was an Undo.
         */
2390
        Undo = 5,
A
Alex Dima 已提交
2391 2392 2393
        /**
         * There was a Redo.
         */
2394 2395 2396
        Redo = 6,
    }

2397
    /**
2398
     * An event describing that the cursor position has changed.
2399
     */
2400 2401 2402 2403
    export interface ICursorPositionChangedEvent {
        /**
         * Primary cursor's position.
         */
A
Alex Dima 已提交
2404
        position: Position;
2405 2406 2407
        /**
         * Primary cursor's view position
         */
A
Alex Dima 已提交
2408
        viewPosition: Position;
2409 2410 2411
        /**
         * Secondary cursors' position.
         */
A
Alex Dima 已提交
2412
        secondaryPositions: Position[];
2413 2414 2415
        /**
         * Secondary cursors' view position.
         */
A
Alex Dima 已提交
2416
        secondaryViewPositions: Position[];
2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430
        /**
         * Reason.
         */
        reason: CursorChangeReason;
        /**
         * Source of the call that caused the event.
         */
        source: string;
        /**
         * Is the primary cursor in the editable range?
         */
        isInEditableRange: boolean;
    }

2431
    /**
2432
     * An event describing that the cursor selection has changed.
2433
     */
2434 2435 2436 2437
    export interface ICursorSelectionChangedEvent {
        /**
         * The primary selection.
         */
2438
        selection: Selection;
2439 2440 2441
        /**
         * The primary selection in view coordinates.
         */
2442
        viewSelection: Selection;
2443 2444 2445
        /**
         * The secondary selections.
         */
2446
        secondarySelections: Selection[];
2447 2448 2449
        /**
         * The secondary selections in view coordinates.
         */
2450
        secondaryViewSelections: Selection[];
2451 2452 2453 2454 2455 2456 2457 2458 2459 2460
        /**
         * Source of the call that caused the event.
         */
        source: string;
        /**
         * Reason.
         */
        reason: CursorChangeReason;
    }

A
Alex Dima 已提交
2461 2462 2463
    /**
     * An event describing that an editor has had its model reset (i.e. `editor.setModel()`).
     */
2464
    export interface IModelChangedEvent {
A
Alex Dima 已提交
2465 2466 2467 2468 2469 2470 2471 2472
        /**
         * The `uri` of the previous model or null.
         */
        oldModelUrl: Uri;
        /**
         * The `uri` of the new model or null.
         */
        newModelUrl: Uri;
2473 2474
    }

2475
    /**
2476
     * A description for the overview ruler position.
2477
     */
2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497
    export class OverviewRulerPosition {
        _overviewRulerPositionBrand: void;
        /**
         * Width of the overview ruler
         */
        width: number;
        /**
         * Height of the overview ruler
         */
        height: number;
        /**
         * Top position for the overview ruler
         */
        top: number;
        /**
         * Right position for the overview ruler
         */
        right: number;
    }

2498
    /**
2499
     * The internal layout details of the editor.
2500
     */
2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572
    export class EditorLayoutInfo {
        _editorLayoutInfoBrand: void;
        /**
         * Full editor width.
         */
        width: number;
        /**
         * Full editor height.
         */
        height: number;
        /**
         * Left position for the glyph margin.
         */
        glyphMarginLeft: number;
        /**
         * The width of the glyph margin.
         */
        glyphMarginWidth: number;
        /**
         * The height of the glyph margin.
         */
        glyphMarginHeight: number;
        /**
         * Left position for the line numbers.
         */
        lineNumbersLeft: number;
        /**
         * The width of the line numbers.
         */
        lineNumbersWidth: number;
        /**
         * The height of the line numbers.
         */
        lineNumbersHeight: number;
        /**
         * Left position for the line decorations.
         */
        decorationsLeft: number;
        /**
         * The width of the line decorations.
         */
        decorationsWidth: number;
        /**
         * The height of the line decorations.
         */
        decorationsHeight: number;
        /**
         * Left position for the content (actual text)
         */
        contentLeft: number;
        /**
         * The width of the content (actual text)
         */
        contentWidth: number;
        /**
         * The height of the content (actual height)
         */
        contentHeight: number;
        /**
         * The width of the vertical scrollbar.
         */
        verticalScrollbarWidth: number;
        /**
         * The height of the horizontal scrollbar.
         */
        horizontalScrollbarHeight: number;
        /**
         * The position of the overview ruler.
         */
        overviewRuler: OverviewRulerPosition;
    }

2573
    /**
2574
     * Options for creating the editor.
2575
     */
2576
    export interface ICodeEditorWidgetCreationOptions extends IEditorOptions {
A
Alex Dima 已提交
2577 2578 2579
        /**
         * The initial model associated with this code editor.
         */
2580 2581 2582
        model?: IModel;
    }

2583
    /**
2584
     * An editor model.
2585
     */
2586 2587 2588
    export interface IEditorModel {
    }

2589
    /**
2590
     * An editor view state.
2591
     */
2592 2593 2594 2595 2596 2597 2598
    export interface IEditorViewState {
    }

    export interface IDimension {
        width: number;
        height: number;
    }
A
Alex Dima 已提交
2599

2600
    /**
2601
     * A (serializable) state of the cursors.
2602
     */
2603 2604 2605 2606 2607 2608
    export interface ICursorState {
        inSelectionMode: boolean;
        selectionStart: IPosition;
        position: IPosition;
    }

2609
    /**
2610
     * A (serializable) state of the view.
2611
     */
2612 2613 2614 2615 2616
    export interface IViewState {
        scrollTop: number;
        scrollTopWithoutViewZones: number;
        scrollLeft: number;
    }
A
Alex Dima 已提交
2617

2618
    /**
2619
     * A (serializable) state of the code editor.
2620
     */
2621 2622 2623 2624 2625 2626 2627 2628
    export interface ICodeEditorViewState extends IEditorViewState {
        cursorState: ICursorState[];
        viewState: IViewState;
        contributionsState: {
            [id: string]: any;
        };
    }

2629
    /**
2630
     * Type of hit element with the mouse in the editor.
2631
     */
2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686
    export enum MouseTargetType {
        /**
         * Mouse is on top of an unknown element.
         */
        UNKNOWN = 0,
        /**
         * Mouse is on top of the textarea used for input.
         */
        TEXTAREA = 1,
        /**
         * Mouse is on top of the glyph margin
         */
        GUTTER_GLYPH_MARGIN = 2,
        /**
         * Mouse is on top of the line numbers
         */
        GUTTER_LINE_NUMBERS = 3,
        /**
         * Mouse is on top of the line decorations
         */
        GUTTER_LINE_DECORATIONS = 4,
        /**
         * Mouse is on top of the whitespace left in the gutter by a view zone.
         */
        GUTTER_VIEW_ZONE = 5,
        /**
         * Mouse is on top of text in the content.
         */
        CONTENT_TEXT = 6,
        /**
         * Mouse is on top of empty space in the content (e.g. after line text or below last line)
         */
        CONTENT_EMPTY = 7,
        /**
         * Mouse is on top of a view zone in the content.
         */
        CONTENT_VIEW_ZONE = 8,
        /**
         * Mouse is on top of a content widget.
         */
        CONTENT_WIDGET = 9,
        /**
         * Mouse is on top of the decorations overview ruler.
         */
        OVERVIEW_RULER = 10,
        /**
         * Mouse is on top of a scrollbar.
         */
        SCROLLBAR = 11,
        /**
         * Mouse is on top of an overlay widget.
         */
        OVERLAY_WIDGET = 12,
    }

A
Alex Dima 已提交
2687
    /**
2688
     * A model for the diff editor.
A
Alex Dima 已提交
2689
     */
2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700
    export interface IDiffEditorModel extends IEditorModel {
        /**
         * Original model.
         */
        original: IModel;
        /**
         * Modified model.
         */
        modified: IModel;
    }

A
Alex Dima 已提交
2701
    /**
2702
     * (Serializable) View state for the diff editor.
A
Alex Dima 已提交
2703
     */
2704 2705 2706 2707 2708
    export interface IDiffEditorViewState extends IEditorViewState {
        original: ICodeEditorViewState;
        modified: ICodeEditorViewState;
    }

A
Alex Dima 已提交
2709
    /**
2710
     * A change
A
Alex Dima 已提交
2711
     */
2712 2713 2714 2715 2716 2717 2718
    export interface IChange {
        originalStartLineNumber: number;
        originalEndLineNumber: number;
        modifiedStartLineNumber: number;
        modifiedEndLineNumber: number;
    }

A
Alex Dima 已提交
2719
    /**
2720
     * A character level change.
A
Alex Dima 已提交
2721
     */
2722 2723 2724 2725 2726 2727 2728
    export interface ICharChange extends IChange {
        originalStartColumn: number;
        originalEndColumn: number;
        modifiedStartColumn: number;
        modifiedEndColumn: number;
    }

A
Alex Dima 已提交
2729
    /**
2730
     * A line change
A
Alex Dima 已提交
2731
     */
2732 2733 2734 2735 2736 2737 2738
    export interface ILineChange extends IChange {
        charChanges: ICharChange[];
    }

    export class BareFontInfo {
        _bareFontInfoBrand: void;
        fontFamily: string;
2739
        fontWeight: string;
2740 2741 2742
        fontSize: number;
        lineHeight: number;
    }
A
Alex Dima 已提交
2743

2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755
    export class FontInfo extends BareFontInfo {
        _editorStylingBrand: void;
        typicalHalfwidthCharacterWidth: number;
        typicalFullwidthCharacterWidth: number;
        spaceWidth: number;
        maxDigitWidth: number;
    }

    export interface INewScrollPosition {
        scrollLeft?: number;
        scrollTop?: number;
    }
A
Alex Dima 已提交
2756

A
Alex Dima 已提交
2757
    /**
2758
     * Description of an action contribution
A
Alex Dima 已提交
2759
     */
2760 2761
    export interface IActionDescriptor {
        /**
2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772
         * An unique identifier of the contributed action.
         */
        id: string;
        /**
         * A label of the action that will be presented to the user.
         */
        label: string;
        /**
         * An array of keybindings for the action.
         */
        keybindings?: number[];
A
Alex Dima 已提交
2773 2774 2775
        /**
         * The keybinding rule.
         */
2776 2777 2778 2779 2780 2781 2782 2783
        keybindingContext?: string;
        /**
         * Method that will be executed when the action is triggered.
         * @param editor The editor instance is passed in as a convinience
         */
        run: (editor: ICommonCodeEditor) => Promise<void>;
    }

A
Alex Dima 已提交
2784 2785 2786 2787
    export interface IEditorAction {
        id: string;
        label: string;
        alias: string;
A
Alex Dima 已提交
2788
        isSupported(): boolean;
A
Alex Dima 已提交
2789 2790 2791
        run(): Promise<void>;
    }

2792 2793 2794 2795
    /**
     * An editor.
     */
    export interface IEditor {
A
Alex Dima 已提交
2796 2797 2798
        /**
         * An event emitted when the content of the current model has changed.
         */
2799
        onDidChangeModelContent(listener: (e: IModelContentChangedEvent2) => void): IDisposable;
A
Alex Dima 已提交
2800 2801 2802
        /**
         * An event emitted when the language of the current model has changed.
         */
2803
        onDidChangeModelMode(listener: (e: IModelModeChangedEvent) => void): IDisposable;
A
Alex Dima 已提交
2804 2805 2806
        /**
         * An event emitted when the options of the current model has changed.
         */
2807
        onDidChangeModelOptions(listener: (e: IModelOptionsChangedEvent) => void): IDisposable;
A
Alex Dima 已提交
2808 2809 2810
        /**
         * An event emitted when the configuration of the editor has changed. (e.g. `editor.updateOptions()`)
         */
2811
        onDidChangeConfiguration(listener: (e: IConfigurationChangedEvent) => void): IDisposable;
A
Alex Dima 已提交
2812 2813 2814
        /**
         * An event emitted when the cursor position has changed.
         */
2815
        onDidChangeCursorPosition(listener: (e: ICursorPositionChangedEvent) => void): IDisposable;
A
Alex Dima 已提交
2816 2817 2818
        /**
         * An event emitted when the cursor selection has changed.
         */
2819
        onDidChangeCursorSelection(listener: (e: ICursorSelectionChangedEvent) => void): IDisposable;
A
Alex Dima 已提交
2820 2821 2822
        /**
         * An event emitted when the editor has been disposed.
         */
2823
        onDidDispose(listener: () => void): IDisposable;
A
Alex Dima 已提交
2824 2825 2826
        /**
         * Dispose the editor.
         */
2827
        dispose(): void;
A
Alex Dima 已提交
2828 2829 2830
        /**
         * Get a unique id for this editor instance.
         */
2831 2832
        getId(): string;
        /**
A
Alex Dima 已提交
2833
         * Get the editor type. Please see `EditorType`.
2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860
         * This is to avoid an instanceof check
         */
        getEditorType(): string;
        /**
         * Update the editor's options after the editor has been created.
         */
        updateOptions(newOptions: IEditorOptions): void;
        /**
         * Instructs the editor to remeasure its container. This method should
         * be called when the container of the editor gets resized.
         */
        layout(dimension?: IDimension): void;
        /**
         * Brings browser focus to the editor text
         */
        focus(): void;
        /**
         * Returns true if this editor has keyboard focus (e.g. cursor is blinking).
         */
        isFocused(): boolean;
        /**
         * Add a new action to this editor.
         */
        addAction(descriptor: IActionDescriptor): void;
        /**
         * Returns all actions associated with this editor.
         */
A
Alex Dima 已提交
2861
        getActions(): IEditorAction[];
2862 2863 2864
        /**
         * Returns all actions associated with this editor.
         */
A
Alex Dima 已提交
2865
        getSupportedActions(): IEditorAction[];
2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923
        /**
         * Saves current view state of the editor in a serializable object.
         */
        saveViewState(): IEditorViewState;
        /**
         * Restores the view state of the editor from a serializable object generated by `saveViewState`.
         */
        restoreViewState(state: IEditorViewState): void;
        /**
         * Given a position, returns a column number that takes tab-widths into account.
         */
        getVisibleColumnFromPosition(position: IPosition): number;
        /**
         * Returns the primary position of the cursor.
         */
        getPosition(): Position;
        /**
         * Set the primary position of the cursor. This will remove any secondary cursors.
         * @param position New primary cursor's position
         */
        setPosition(position: IPosition): void;
        /**
         * Scroll vertically as necessary and reveal a line.
         */
        revealLine(lineNumber: number): void;
        /**
         * Scroll vertically as necessary and reveal a line centered vertically.
         */
        revealLineInCenter(lineNumber: number): void;
        /**
         * Scroll vertically as necessary and reveal a line centered vertically only if it lies outside the viewport.
         */
        revealLineInCenterIfOutsideViewport(lineNumber: number): void;
        /**
         * Scroll vertically or horizontally as necessary and reveal a position.
         */
        revealPosition(position: IPosition): void;
        /**
         * Scroll vertically or horizontally as necessary and reveal a position centered vertically.
         */
        revealPositionInCenter(position: IPosition): void;
        /**
         * Scroll vertically or horizontally as necessary and reveal a position centered vertically only if it lies outside the viewport.
         */
        revealPositionInCenterIfOutsideViewport(position: IPosition): void;
        /**
         * Returns the primary selection of the editor.
         */
        getSelection(): Selection;
        /**
         * Returns all the selections of the editor.
         */
        getSelections(): Selection[];
        /**
         * Set the primary selection of the editor. This will remove any secondary cursors.
         * @param selection The new selection
         */
        setSelection(selection: IRange): void;
A
Alex Dima 已提交
2924 2925 2926 2927
        /**
         * Set the primary selection of the editor. This will remove any secondary cursors.
         * @param selection The new selection
         */
2928
        setSelection(selection: Range): void;
A
Alex Dima 已提交
2929 2930 2931 2932
        /**
         * Set the primary selection of the editor. This will remove any secondary cursors.
         * @param selection The new selection
         */
2933
        setSelection(selection: ISelection): void;
A
Alex Dima 已提交
2934 2935 2936 2937
        /**
         * Set the primary selection of the editor. This will remove any secondary cursors.
         * @param selection The new selection
         */
2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012
        setSelection(selection: Selection): void;
        /**
         * Set the selections for all the cursors of the editor.
         * Cursors will be removed or added, as necessary.
         */
        setSelections(selections: ISelection[]): void;
        /**
         * Scroll vertically as necessary and reveal lines.
         */
        revealLines(startLineNumber: number, endLineNumber: number): void;
        /**
         * Scroll vertically as necessary and reveal lines centered vertically.
         */
        revealLinesInCenter(lineNumber: number, endLineNumber: number): void;
        /**
         * Scroll vertically as necessary and reveal lines centered vertically only if it lies outside the viewport.
         */
        revealLinesInCenterIfOutsideViewport(lineNumber: number, endLineNumber: number): void;
        /**
         * Scroll vertically or horizontally as necessary and reveal a range.
         */
        revealRange(range: IRange): void;
        /**
         * Scroll vertically or horizontally as necessary and reveal a range centered vertically.
         */
        revealRangeInCenter(range: IRange): void;
        /**
         * Scroll vertically or horizontally as necessary and reveal a range centered vertically only if it lies outside the viewport.
         */
        revealRangeInCenterIfOutsideViewport(range: IRange): void;
        /**
         * Directly trigger a handler or an editor action.
         * @param source The source of the call.
         * @param handlerId The id of the handler or the id of a contribution.
         * @param payload Extra data to be sent to the handler.
         */
        trigger(source: string, handlerId: string, payload: any): void;
        /**
         * Gets the current model attached to this editor.
         */
        getModel(): IEditorModel;
        /**
         * Sets the current model attached to this editor.
         * If the previous model was created by the editor via the value key in the options
         * literal object, it will be destroyed. Otherwise, if the previous model was set
         * via setModel, or the model key in the options literal object, the previous model
         * will not be destroyed.
         * It is safe to call setModel(null) to simply detach the current model from the editor.
         */
        setModel(model: IEditorModel): void;
    }

    /**
     * An editor contribution that gets created every time a new editor gets created and gets disposed when the editor gets disposed.
     */
    export interface IEditorContribution {
        /**
         * Get a unique identifier for this contribution.
         */
        getId(): string;
        /**
         * Dispose this contribution.
         */
        dispose(): void;
        /**
         * Store view state.
         */
        saveViewState?(): any;
        /**
         * Restore view state.
         */
        restoreViewState?(state: any): void;
    }

    export interface ICommonCodeEditor extends IEditor {
A
Alex Dima 已提交
3013 3014 3015
        /**
         * An event emitted when the model of this editor has changed (e.g. `editor.setModel()`).
         */
3016
        onDidChangeModel(listener: (e: IModelChangedEvent) => void): IDisposable;
A
Alex Dima 已提交
3017 3018 3019
        /**
         * An event emitted when the decorations of the current model have changed.
         */
3020
        onDidChangeModelDecorations(listener: (e: IModelDecorationsChangedEvent) => void): IDisposable;
A
Alex Dima 已提交
3021 3022 3023
        /**
         * An event emitted when the text inside this editor gained focus (i.e. cursor blinking).
         */
3024
        onDidFocusEditorText(listener: () => void): IDisposable;
A
Alex Dima 已提交
3025 3026 3027
        /**
         * An event emitted when the text inside this editor lost focus.
         */
3028
        onDidBlurEditorText(listener: () => void): IDisposable;
A
Alex Dima 已提交
3029 3030 3031
        /**
         * An event emitted when the text inside this editor or an editor widget gained focus.
         */
3032
        onDidFocusEditor(listener: () => void): IDisposable;
A
Alex Dima 已提交
3033 3034 3035
        /**
         * An event emitted when the text inside this editor or an editor widget lost focus.
         */
3036 3037 3038 3039 3040 3041 3042 3043 3044 3045
        onDidBlurEditor(listener: () => void): IDisposable;
        /**
         * Returns true if this editor or one of its widgets has keyboard focus.
         */
        hasWidgetFocus(): boolean;
        /**
         * Get a contribution of this editor.
         * @id Unique identifier of the contribution.
         * @return The contribution or null if contribution not found.
         */
A
Alex Dima 已提交
3046
        getContribution<T extends IEditorContribution>(id: string): T;
3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073
        /**
         * Type the getModel() of IEditor.
         */
        getModel(): IModel;
        /**
         * Returns the current editor's configuration
         */
        getConfiguration(): InternalEditorOptions;
        /**
         * Get value of the current model attached to this editor.
         * @see IModel.getValue
         */
        getValue(options?: {
            preserveBOM: boolean;
            lineEnding: string;
        }): string;
        /**
         * Set the value of the current model attached to this editor.
         * @see IModel.setValue
         */
        setValue(newValue: string): void;
        /**
         * Get the scrollWidth of the editor's viewport.
         */
        getScrollWidth(): number;
        /**
         * Get the scrollLeft of the editor's viewport.
3074
         */
3075
        getScrollLeft(): number;
3076
        /**
3077
         * Get the scrollHeight of the editor's viewport.
3078
         */
3079
        getScrollHeight(): number;
3080
        /**
3081
         * Get the scrollTop of the editor's viewport.
3082
         */
3083
        getScrollTop(): number;
3084
        /**
3085
         * Change the scrollLeft of the editor's viewport.
3086
         */
3087
        setScrollLeft(newScrollLeft: number): void;
3088
        /**
3089
         * Change the scrollTop of the editor's viewport.
3090
         */
3091
        setScrollTop(newScrollTop: number): void;
3092
        /**
3093
         * Change the scroll position of the editor's viewport.
3094
         */
3095
        setScrollPosition(position: INewScrollPosition): void;
3096
        /**
3097 3098 3099
         * Get an action that is a contribution to this editor.
         * @id Unique identifier of the contribution.
         * @return The action or null if action not found.
3100
         */
A
Alex Dima 已提交
3101
        getAction(id: string): IEditorAction;
3102
        /**
3103 3104 3105
         * Execute a command on the editor.
         * @param source The source of the call.
         * @param command The command to execute
3106
         */
3107
        executeCommand(source: string, command: ICommand): void;
3108 3109 3110 3111
        /**
         * Push an "undo stop" in the undo-redo stack.
         */
        pushUndoStop(): boolean;
3112
        /**
3113 3114 3115
         * Execute a command on the editor.
         * @param source The source of the call.
         * @param command The command to execute
3116
         */
3117
        executeEdits(source: string, edits: IIdentifiedSingleEditOperation[]): boolean;
3118
        /**
3119 3120 3121
         * Execute multiple (concommitent) commands on the editor.
         * @param source The source of the call.
         * @param command The commands to execute
3122
         */
3123
        executeCommands(source: string, commands: ICommand[]): void;
3124
        /**
3125
         * Get all the decorations on a line (filtering out decorations from other editors).
3126
         */
3127
        getLineDecorations(lineNumber: number): IModelDecoration[];
3128
        /**
3129 3130
         * All decorations added through this call will get the ownerId of this editor.
         * @see IModel.deltaDecorations
3131
         */
3132
        deltaDecorations(oldDecorations: string[], newDecorations: IModelDeltaDecoration[]): string[];
3133
        /**
3134
         * Get the layout info for the editor.
3135
         */
3136 3137 3138 3139
        getLayoutInfo(): EditorLayoutInfo;
    }

    export interface ICommonDiffEditor extends IEditor {
A
Alex Dima 已提交
3140 3141 3142
        /**
         * An event emitted when the diff information computed by this diff editor has been updated.
         */
3143
        onDidUpdateDiff(listener: () => void): IDisposable;
3144
        /**
3145
         * Type the getModel() of IEditor.
3146
         */
3147
        getModel(): IDiffEditorModel;
A
Alex Dima 已提交
3148 3149 3150
        /**
         * Get the `original` editor.
         */
3151
        getOriginalEditor(): ICommonCodeEditor;
A
Alex Dima 已提交
3152 3153 3154
        /**
         * Get the `modified` editor.
         */
3155
        getModifiedEditor(): ICommonCodeEditor;
A
Alex Dima 已提交
3156 3157 3158
        /**
         * Get the computed diff information.
         */
3159
        getLineChanges(): ILineChange[];
3160
        /**
3161
         * @see ICodeEditor.getValue
3162
         */
3163 3164 3165 3166 3167 3168
        getValue(options?: {
            preserveBOM: boolean;
            lineEnding: string;
        }): string;
    }

A
Alex Dima 已提交
3169 3170 3171
    /**
     * The type of the `IEditor`.
     */
3172 3173 3174 3175 3176
    export var EditorType: {
        ICodeEditor: string;
        IDiffEditor: string;
    };

3177
    /**
3178
     * Positions in the view for cursor move command.
3179
     */
3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192
    export const CursorMovePosition: {
        Left: string;
        Right: string;
        Up: string;
        Down: string;
        WrappedLineStart: string;
        WrappedLineFirstNonWhitespaceCharacter: string;
        WrappedLineColumnCenter: string;
        WrappedLineEnd: string;
        WrappedLineLastNonWhitespaceCharacter: string;
        ViewPortTop: string;
        ViewPortCenter: string;
        ViewPortBottom: string;
3193
        ViewPortIfOutside: string;
3194 3195 3196 3197 3198 3199
    };

    /**
     * Units for Cursor move 'by' argument
     */
    export const CursorMoveByUnit: {
3200 3201 3202 3203
        Line: string;
        WrappedLine: string;
        Character: string;
        HalfLine: string;
3204 3205
    };

3206 3207 3208 3209 3210
    /**
     * Arguments for Cursor move command
     */
    export interface CursorMoveArguments {
        to: string;
3211 3212
        select?: boolean;
        by?: string;
3213
        value?: number;
3214 3215
    }

3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228
    /**
     * Directions in the view for editor scroll command.
     */
    export const EditorScrollDirection: {
        Up: string;
        Down: string;
    };

    /**
     * Units for editor scroll 'by' argument
     */
    export const EditorScrollByUnit: {
        Line: string;
3229
        WrappedLine: string;
3230
        Page: string;
3231
        HalfPage: string;
3232 3233 3234 3235 3236 3237 3238 3239 3240
    };

    /**
     * Arguments for editor scroll command
     */
    export interface EditorScrollArguments {
        to: string;
        by?: string;
        value?: number;
3241
        revealCursor?: boolean;
3242 3243
    }

3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260
    /**
     * Arguments for reveal line command
     */
    export interface RevealLineArguments {
        lineNumber?: number;
        at?: string;
    }

    /**
     * Values for reveal line 'at' argument
     */
    export const RevealLineAtArgument: {
        Top: string;
        Center: string;
        Bottom: string;
    };

A
Alex Dima 已提交
3261 3262 3263
    /**
     * Built-in commands.
     */
3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305
    export var Handler: {
        ExecuteCommand: string;
        ExecuteCommands: string;
        CursorLeft: string;
        CursorLeftSelect: string;
        CursorWordLeft: string;
        CursorWordStartLeft: string;
        CursorWordEndLeft: string;
        CursorWordLeftSelect: string;
        CursorWordStartLeftSelect: string;
        CursorWordEndLeftSelect: string;
        CursorRight: string;
        CursorRightSelect: string;
        CursorWordRight: string;
        CursorWordStartRight: string;
        CursorWordEndRight: string;
        CursorWordRightSelect: string;
        CursorWordStartRightSelect: string;
        CursorWordEndRightSelect: string;
        CursorUp: string;
        CursorUpSelect: string;
        CursorDown: string;
        CursorDownSelect: string;
        CursorPageUp: string;
        CursorPageUpSelect: string;
        CursorPageDown: string;
        CursorPageDownSelect: string;
        CursorHome: string;
        CursorHomeSelect: string;
        CursorEnd: string;
        CursorEndSelect: string;
        ExpandLineSelection: string;
        CursorTop: string;
        CursorTopSelect: string;
        CursorBottom: string;
        CursorBottomSelect: string;
        CursorColumnSelectLeft: string;
        CursorColumnSelectRight: string;
        CursorColumnSelectUp: string;
        CursorColumnSelectPageUp: string;
        CursorColumnSelectDown: string;
        CursorColumnSelectPageDown: string;
3306
        CursorMove: string;
3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317
        AddCursorDown: string;
        AddCursorUp: string;
        CursorUndo: string;
        MoveTo: string;
        MoveToSelect: string;
        ColumnSelect: string;
        CreateCursor: string;
        LastCursorMoveToSelect: string;
        JumpToBracket: string;
        Type: string;
        ReplacePreviousChar: string;
3318 3319
        CompositionStart: string;
        CompositionEnd: string;
3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349
        Paste: string;
        Tab: string;
        Indent: string;
        Outdent: string;
        DeleteLeft: string;
        DeleteRight: string;
        DeleteWordLeft: string;
        DeleteWordStartLeft: string;
        DeleteWordEndLeft: string;
        DeleteWordRight: string;
        DeleteWordStartRight: string;
        DeleteWordEndRight: string;
        DeleteAllLeft: string;
        DeleteAllRight: string;
        RemoveSecondaryCursors: string;
        CancelSelection: string;
        Cut: string;
        Undo: string;
        Redo: string;
        WordSelect: string;
        WordSelectDrag: string;
        LastCursorWordSelect: string;
        LineSelect: string;
        LineSelectDrag: string;
        LastCursorLineSelect: string;
        LastCursorLineSelectDrag: string;
        LineInsertBefore: string;
        LineInsertAfter: string;
        LineBreakInsert: string;
        SelectAll: string;
3350
        EditorScroll: string;
3351 3352 3353 3354
        ScrollLineUp: string;
        ScrollLineDown: string;
        ScrollPageUp: string;
        ScrollPageDown: string;
3355
        RevealLine: string;
3356 3357
    };

A
Alex Dima 已提交
3358 3359 3360
    /**
     * The style in which the editor's cursor should be rendered.
     */
3361
    export enum TextEditorCursorStyle {
A
Alex Dima 已提交
3362 3363 3364
        /**
         * As a vertical line (sitting between two characters).
         */
3365
        Line = 1,
A
Alex Dima 已提交
3366 3367 3368
        /**
         * As a block (sitting on top of a character).
         */
3369
        Block = 2,
A
Alex Dima 已提交
3370 3371 3372
        /**
         * As a horizontal line (sitting under a character).
         */
3373 3374 3375
        Underline = 3,
    }

3376 3377 3378 3379
    /**
     * The kind of animation in which the editor's cursor should be rendered.
     */
    export enum TextEditorCursorBlinkingStyle {
3380 3381 3382 3383
        /**
         * Hidden
         */
        Hidden = 0,
3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405
        /**
         * Blinking
         */
        Blink = 1,
        /**
         * Blinking with smooth fading
         */
        Smooth = 2,
        /**
         * Blinking with prolonged filled state and smooth fading
         */
        Phase = 3,
        /**
         * Expand collapse animation on the y axis
         */
        Expand = 4,
        /**
         * No-Blinking
         */
        Solid = 5,
    }

3406 3407 3408 3409 3410
    /**
     * A view zone is a full horizontal rectangle that 'pushes' text down.
     * The editor reserves space for view zones when rendering.
     */
    export interface IViewZone {
3411
        /**
3412 3413
         * The line number after which this zone should appear.
         * Use 0 to place a view zone before the first line number.
3414
         */
3415
        afterLineNumber: number;
3416
        /**
3417 3418
         * The column after which this zone should appear.
         * If not set, the maxLineColumn of `afterLineNumber` will be used.
3419
         */
3420
        afterColumn?: number;
3421
        /**
3422 3423 3424
         * Suppress mouse down events.
         * If set, the editor will attach a mouse down listener to the view zone and .preventDefault on it.
         * Defaults to false
3425
         */
3426
        suppressMouseDown?: boolean;
3427
        /**
3428 3429 3430
         * The height in lines of the view zone.
         * If specified, `heightInPx` will be used instead of this.
         * If neither `heightInPx` nor `heightInLines` is specified, a default of `heightInLines` = 1 will be chosen.
3431
         */
3432
        heightInLines?: number;
3433
        /**
3434 3435 3436
         * The height in px of the view zone.
         * If this is set, the editor will give preference to it rather than `heightInLines` above.
         * If neither `heightInPx` nor `heightInLines` is specified, a default of `heightInLines` = 1 will be chosen.
3437
         */
3438
        heightInPx?: number;
3439
        /**
3440
         * The dom node of the view zone
3441
         */
3442
        domNode: HTMLElement;
3443
        /**
3444 3445 3446 3447 3448
         * Callback which gives the relative top of the view zone as it appears (taking scrolling into account).
         */
        onDomNodeTop?: (top: number) => void;
        /**
         * Callback which gives the height in pixels of the view zone.
3449
         */
3450 3451 3452 3453 3454 3455 3456
        onComputedHeight?: (height: number) => void;
    }

    /**
     * An accessor that allows for zones to be added or removed.
     */
    export interface IViewZoneChangeAccessor {
3457
        /**
3458 3459 3460
         * Create a new view zone.
         * @param zone Zone to create
         * @return A unique identifier to the view zone.
3461
         */
3462
        addZone(zone: IViewZone): number;
3463
        /**
3464 3465
         * Remove a zone
         * @param id A unique identifier to the view zone, as returned by the `addZone` call.
3466
         */
3467
        removeZone(id: number): void;
3468
        /**
3469 3470
         * Change a zone's position.
         * The editor will rescan the `afterLineNumber` and `afterColumn` properties of a view zone.
3471
         */
3472 3473 3474 3475 3476 3477 3478
        layoutZone(id: number): void;
    }

    /**
     * A positioning preference for rendering content widgets.
     */
    export enum ContentWidgetPositionPreference {
3479
        /**
3480
         * Place the content widget exactly at a position
3481
         */
3482
        EXACT = 0,
3483
        /**
3484
         * Place the content widget above a position
3485
         */
3486
        ABOVE = 1,
3487
        /**
3488
         * Place the content widget below a position
3489
         */
3490 3491 3492 3493 3494 3495 3496
        BELOW = 2,
    }

    /**
     * A position for rendering content widgets.
     */
    export interface IContentWidgetPosition {
3497
        /**
3498 3499
         * Desired position for the content widget.
         * `preference` will also affect the placement.
3500
         */
3501
        position: IPosition;
3502
        /**
3503
         * Placement preference for position, in order of preference.
3504
         */
3505 3506 3507 3508 3509 3510 3511
        preference: ContentWidgetPositionPreference[];
    }

    /**
     * A content widget renders inline with the text and can be easily placed 'near' an editor position.
     */
    export interface IContentWidget {
3512
        /**
3513
         * Render this content widget in a location where it could overflow the editor's view dom node.
3514
         */
3515
        allowEditorOverflow?: boolean;
3516
        suppressMouseDown?: boolean;
3517
        /**
3518
         * Get a unique identifier of the content widget.
3519
         */
3520
        getId(): string;
3521
        /**
3522
         * Get the dom node of the content widget.
3523
         */
3524
        getDomNode(): HTMLElement;
3525
        /**
3526 3527
         * Get the placement of the content widget.
         * If null is returned, the content widget will be placed off screen.
3528
         */
3529 3530 3531 3532 3533 3534 3535
        getPosition(): IContentWidgetPosition;
    }

    /**
     * A positioning preference for rendering overlay widgets.
     */
    export enum OverlayWidgetPositionPreference {
3536
        /**
3537
         * Position the overlay widget in the top right corner
3538
         */
3539
        TOP_RIGHT_CORNER = 0,
3540
        /**
3541
         * Position the overlay widget in the bottom right corner
3542
         */
3543
        BOTTOM_RIGHT_CORNER = 1,
3544
        /**
3545
         * Position the overlay widget in the top center
3546
         */
3547
        TOP_CENTER = 2,
3548
    }
A
Alex Dima 已提交
3549 3550

    /**
3551
     * A position for rendering overlay widgets.
A
Alex Dima 已提交
3552
     */
3553
    export interface IOverlayWidgetPosition {
3554
        /**
3555
         * The position preference for the overlay widget.
3556
         */
3557 3558 3559 3560 3561 3562 3563
        preference: OverlayWidgetPositionPreference;
    }

    /**
     * An overlay widgets renders on top of the text.
     */
    export interface IOverlayWidget {
3564
        /**
3565
         * Get a unique identifier of the overlay widget.
3566
         */
3567
        getId(): string;
3568
        /**
3569
         * Get the dom node of the overlay widget.
3570
         */
3571
        getDomNode(): HTMLElement;
3572
        /**
3573 3574
         * Get the placement of the overlay widget.
         * If null is returned, the overlay widget is responsible to place itself.
3575
         */
3576
        getPosition(): IOverlayWidgetPosition;
3577
    }
A
Alex Dima 已提交
3578

3579 3580 3581 3582
    /**
     * Target hit with the mouse in the editor.
     */
    export interface IMouseTarget {
3583
        /**
3584
         * The target element
3585
         */
3586
        element: Element;
3587
        /**
3588
         * The target type
3589
         */
3590
        type: MouseTargetType;
3591
        /**
3592
         * The 'approximate' editor position
3593
         */
3594
        position: Position;
3595
        /**
3596
         * Desired mouse column (e.g. when position.column gets clamped to text length -- clicking after text on a line).
3597
         */
3598
        mouseColumn: number;
3599
        /**
3600
         * The 'approximate' editor range
3601
         */
3602
        range: Range;
3603
        /**
3604
         * Some extra detail.
3605
         */
3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620
        detail: any;
    }

    /**
     * A mouse event originating from the editor.
     */
    export interface IEditorMouseEvent {
        event: IMouseEvent;
        target: IMouseTarget;
    }

    /**
     * A rich code editor.
     */
    export interface ICodeEditor extends ICommonCodeEditor {
A
Alex Dima 已提交
3621 3622 3623
        /**
         * An event emitted on a "mouseup".
         */
3624
        onMouseUp(listener: (e: IEditorMouseEvent) => void): IDisposable;
A
Alex Dima 已提交
3625 3626 3627
        /**
         * An event emitted on a "mousedown".
         */
3628
        onMouseDown(listener: (e: IEditorMouseEvent) => void): IDisposable;
A
Alex Dima 已提交
3629 3630 3631
        /**
         * An event emitted on a "contextmenu".
         */
3632
        onContextMenu(listener: (e: IEditorMouseEvent) => void): IDisposable;
A
Alex Dima 已提交
3633 3634 3635
        /**
         * An event emitted on a "mousemove".
         */
3636
        onMouseMove(listener: (e: IEditorMouseEvent) => void): IDisposable;
A
Alex Dima 已提交
3637 3638 3639
        /**
         * An event emitted on a "mouseleave".
         */
3640
        onMouseLeave(listener: (e: IEditorMouseEvent) => void): IDisposable;
A
Alex Dima 已提交
3641 3642 3643
        /**
         * An event emitted on a "keyup".
         */
3644
        onKeyUp(listener: (e: IKeyboardEvent) => void): IDisposable;
A
Alex Dima 已提交
3645 3646 3647
        /**
         * An event emitted on a "keydown".
         */
3648
        onKeyDown(listener: (e: IKeyboardEvent) => void): IDisposable;
A
Alex Dima 已提交
3649 3650 3651
        /**
         * An event emitted when the layout of the editor has changed.
         */
3652
        onDidLayoutChange(listener: (e: EditorLayoutInfo) => void): IDisposable;
A
Alex Dima 已提交
3653 3654 3655
        /**
         * An event emitted when the scroll in the editor has changed.
         */
3656
        onDidScrollChange(listener: (e: IScrollEvent) => void): IDisposable;
3657
        /**
3658
         * Returns the editor's dom node
3659
         */
3660
        getDomNode(): HTMLElement;
3661
        /**
3662
         * Add a content widget. Widgets must have unique ids, otherwise they will be overwritten.
3663
         */
3664
        addContentWidget(widget: IContentWidget): void;
3665
        /**
3666 3667
         * Layout/Reposition a content widget. This is a ping to the editor to call widget.getPosition()
         * and update appropiately.
3668
         */
3669
        layoutContentWidget(widget: IContentWidget): void;
3670
        /**
3671
         * Remove a content widget.
3672
         */
3673
        removeContentWidget(widget: IContentWidget): void;
3674
        /**
3675
         * Add an overlay widget. Widgets must have unique ids, otherwise they will be overwritten.
3676
         */
3677
        addOverlayWidget(widget: IOverlayWidget): void;
3678
        /**
3679 3680
         * Layout/Reposition an overlay widget. This is a ping to the editor to call widget.getPosition()
         * and update appropiately.
3681
         */
3682
        layoutOverlayWidget(widget: IOverlayWidget): void;
3683
        /**
3684
         * Remove an overlay widget.
3685
         */
3686
        removeOverlayWidget(widget: IOverlayWidget): void;
3687
        /**
3688
         * Change the view zones. View zones are lost when a new model is attached to the editor.
3689
         */
3690
        changeViewZones(callback: (accessor: IViewZoneChangeAccessor) => void): void;
3691
        /**
3692
         * Returns the range that is currently centered in the view port.
3693
         */
3694
        getCenteredRangeInViewport(): Range;
3695
        /**
3696 3697 3698 3699 3700 3701 3702
         * Get the horizontal position (left offset) for the column w.r.t to the beginning of the line.
         * This method works only if the line `lineNumber` is currently rendered (in the editor's viewport).
         * Use this method with caution.
         */
        getOffsetForColumn(lineNumber: number, column: number): number;
        /**
         * Force an editor render now.
3703
         */
3704
        render(): void;
3705
        /**
3706
         * Get the vertical position (top offset) for the line w.r.t. to the first line.
3707
         */
3708
        getTopForLineNumber(lineNumber: number): number;
3709
        /**
3710
         * Get the vertical position (top offset) for the position w.r.t. to the first line.
3711
         */
3712
        getTopForPosition(lineNumber: number, column: number): number;
3713
        /**
3714 3715 3716 3717 3718
         * Get the visible position for `position`.
         * The result position takes scrolling into account and is relative to the top left corner of the editor.
         * Explanation 1: the results of this method will change for the same `position` if the user scrolls the editor.
         * Explanation 2: the results of this method will not change if the container of the editor gets repositioned.
         * Warning: the results of this method are innacurate for positions that are outside the current editor viewport.
3719
         */
3720 3721 3722 3723 3724
        getScrolledVisiblePosition(position: IPosition): {
            top: number;
            left: number;
            height: number;
        };
3725
        /**
3726
         * Apply the same font settings as the editor to `target`.
3727
         */
3728
        applyFontInfo(target: HTMLElement): void;
3729
    }
3730

3731 3732 3733 3734
    /**
     * A rich diff editor.
     */
    export interface IDiffEditor extends ICommonDiffEditor {
3735
        /**
3736
         * @see ICodeEditor.getDomNode
3737
         */
3738
        getDomNode(): HTMLElement;
3739
    }
3740
}
A
Alex Dima 已提交
3741

3742
declare module monaco.languages {
A
Alex Dima 已提交
3743 3744


A
Alex Dima 已提交
3745 3746 3747
    /**
     * Register information about a new language.
     */
A
Alex Dima 已提交
3748 3749
    export function register(language: ILanguageExtensionPoint): void;

A
Alex Dima 已提交
3750 3751 3752
    /**
     * Get the information of all the registered languages.
     */
A
Alex Dima 已提交
3753 3754
    export function getLanguages(): ILanguageExtensionPoint[];

A
Alex Dima 已提交
3755 3756 3757
    /**
     * An event emitted when a language is first time needed (e.g. a model has it set).
     */
A
Alex Dima 已提交
3758 3759
    export function onLanguage(languageId: string, callback: () => void): IDisposable;

A
Alex Dima 已提交
3760 3761 3762 3763
    /**
     * Set the editing configuration for a language.
     */
    export function setLanguageConfiguration(languageId: string, configuration: LanguageConfiguration): IDisposable;
3764

A
Alex Dima 已提交
3765 3766 3767 3768
    /**
     * Set the tokens provider for a language (manual implementation).
     */
    export function setTokensProvider(languageId: string, provider: TokensProvider): IDisposable;
3769

A
Alex Dima 已提交
3770 3771 3772
    /**
     * Set the tokens provider for a language (monarch implementation).
     */
3773 3774
    export function setMonarchTokensProvider(languageId: string, languageDef: IMonarchLanguage): IDisposable;

A
Alex Dima 已提交
3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838
    /**
     * Register a reference provider (used by e.g. reference search).
     */
    export function registerReferenceProvider(languageId: string, provider: ReferenceProvider): IDisposable;

    /**
     * Register a rename provider (used by e.g. rename symbol).
     */
    export function registerRenameProvider(languageId: string, provider: RenameProvider): IDisposable;

    /**
     * Register a signature help provider (used by e.g. paremeter hints).
     */
    export function registerSignatureHelpProvider(languageId: string, provider: SignatureHelpProvider): IDisposable;

    /**
     * Register a hover provider (used by e.g. editor hover).
     */
    export function registerHoverProvider(languageId: string, provider: HoverProvider): IDisposable;

    /**
     * Register a document symbol provider (used by e.g. outline).
     */
    export function registerDocumentSymbolProvider(languageId: string, provider: DocumentSymbolProvider): IDisposable;

    /**
     * Register a document highlight provider (used by e.g. highlight occurences).
     */
    export function registerDocumentHighlightProvider(languageId: string, provider: DocumentHighlightProvider): IDisposable;

    /**
     * Register a definition provider (used by e.g. go to definition).
     */
    export function registerDefinitionProvider(languageId: string, provider: DefinitionProvider): IDisposable;

    /**
     * Register a code lens provider (used by e.g. inline code lenses).
     */
    export function registerCodeLensProvider(languageId: string, provider: CodeLensProvider): IDisposable;

    /**
     * Register a code action provider (used by e.g. quick fix).
     */
    export function registerCodeActionProvider(languageId: string, provider: CodeActionProvider): IDisposable;

    /**
     * Register a formatter that can handle only entire models.
     */
    export function registerDocumentFormattingEditProvider(languageId: string, provider: DocumentFormattingEditProvider): IDisposable;

    /**
     * Register a formatter that can handle a range inside a model.
     */
    export function registerDocumentRangeFormattingEditProvider(languageId: string, provider: DocumentRangeFormattingEditProvider): IDisposable;

    /**
     * Register a formatter than can do formatting as the user types.
     */
    export function registerOnTypeFormattingEditProvider(languageId: string, provider: OnTypeFormattingEditProvider): IDisposable;

    /**
     * Register a link provider that can find links in text.
     */
    export function registerLinkProvider(languageId: string, provider: LinkProvider): IDisposable;
3839

A
Alex Dima 已提交
3840 3841 3842 3843
    /**
     * Register a completion item provider (use by e.g. suggestions).
     */
    export function registerCompletionItemProvider(languageId: string, provider: CompletionItemProvider): IDisposable;
3844

3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868
    /**
     * Contains additional diagnostic information about the context in which
     * a [code action](#CodeActionProvider.provideCodeActions) is run.
     */
    export interface CodeActionContext {
        /**
         * An array of diagnostics.
         *
         * @readonly
         */
        markers: editor.IMarkerData[];
    }

    /**
     * The code action interface defines the contract between extensions and
     * the [light bulb](https://code.visualstudio.com/docs/editor/editingevolved#_code-action) feature.
     */
    export interface CodeActionProvider {
        /**
         * Provide commands for the given document and range.
         */
        provideCodeActions(model: editor.IReadOnlyModel, range: Range, context: CodeActionContext, token: CancellationToken): CodeAction[] | Thenable<CodeAction[]>;
    }

A
Alex Dima 已提交
3869 3870 3871
    /**
     * Completion item kinds.
     */
3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892
    export enum CompletionItemKind {
        Text = 0,
        Method = 1,
        Function = 2,
        Constructor = 3,
        Field = 4,
        Variable = 5,
        Class = 6,
        Interface = 7,
        Module = 8,
        Property = 9,
        Unit = 10,
        Value = 11,
        Enum = 12,
        Keyword = 13,
        Snippet = 14,
        Color = 15,
        File = 16,
        Reference = 17,
    }

A
Alex Dima 已提交
3893 3894 3895 3896
    /**
     * A completion item represents a text snippet that is
     * proposed to complete text that is being typed.
     */
3897
    export interface CompletionItem {
A
Alex Dima 已提交
3898 3899 3900 3901 3902
        /**
         * The label of this completion item. By default
         * this is also the text that is inserted when selecting
         * this completion.
         */
3903
        label: string;
A
Alex Dima 已提交
3904 3905 3906 3907
        /**
         * The kind of this completion item. Based on the kind
         * an icon is chosen by the editor.
         */
3908
        kind: CompletionItemKind;
A
Alex Dima 已提交
3909 3910 3911 3912
        /**
         * A human-readable string with additional information
         * about this item, like type or symbol information.
         */
3913
        detail?: string;
A
Alex Dima 已提交
3914 3915 3916
        /**
         * A human-readable string that represents a doc-comment.
         */
3917
        documentation?: string;
A
Alex Dima 已提交
3918 3919 3920 3921 3922
        /**
         * A string that should be used when comparing this item
         * with other items. When `falsy` the [label](#CompletionItem.label)
         * is used.
         */
3923
        sortText?: string;
A
Alex Dima 已提交
3924 3925 3926 3927 3928
        /**
         * A string that should be used when filtering a set of
         * completion items. When `falsy` the [label](#CompletionItem.label)
         * is used.
         */
3929
        filterText?: string;
A
Alex Dima 已提交
3930 3931 3932 3933 3934
        /**
         * A string that should be inserted in a document when selecting
         * this completion. When `falsy` the [label](#CompletionItem.label)
         * is used.
         */
3935
        insertText?: string;
A
Alex Dima 已提交
3936 3937 3938 3939 3940 3941 3942 3943
        /**
         * An [edit](#TextEdit) which is applied to a document when selecting
         * this completion. When an edit is provided the value of
         * [insertText](#CompletionItem.insertText) is ignored.
         *
         * The [range](#Range) of the edit must be single-line and one the same
         * line completions where [requested](#CompletionItemProvider.provideCompletionItems) at.
         */
3944 3945 3946
        textEdit?: editor.ISingleEditOperation;
    }

A
Alex Dima 已提交
3947 3948 3949 3950
    /**
     * Represents a collection of [completion items](#CompletionItem) to be presented
     * in the editor.
     */
3951
    export interface CompletionList {
A
Alex Dima 已提交
3952 3953 3954 3955
        /**
         * This list it not complete. Further typing should result in recomputing
         * this list.
         */
3956
        isIncomplete?: boolean;
A
Alex Dima 已提交
3957 3958 3959
        /**
         * The completion items.
         */
3960 3961 3962
        items: CompletionItem[];
    }

A
Alex Dima 已提交
3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973
    /**
     * The completion item provider interface defines the contract between extensions and
     * the [IntelliSense](https://code.visualstudio.com/docs/editor/editingevolved#_intellisense).
     *
     * When computing *complete* completion items is expensive, providers can optionally implement
     * the `resolveCompletionItem`-function. In that case it is enough to return completion
     * items with a [label](#CompletionItem.label) from the
     * [provideCompletionItems](#CompletionItemProvider.provideCompletionItems)-function. Subsequently,
     * when a completion item is shown in the UI and gains focus this provider is asked to resolve
     * the item, like adding [doc-comment](#CompletionItem.documentation) or [details](#CompletionItem.detail).
     */
3974 3975
    export interface CompletionItemProvider {
        triggerCharacters?: string[];
A
Alex Dima 已提交
3976 3977 3978
        /**
         * Provide completion items for the given position and document.
         */
3979
        provideCompletionItems(model: editor.IReadOnlyModel, position: Position, token: CancellationToken): CompletionItem[] | Thenable<CompletionItem[]> | CompletionList | Thenable<CompletionList>;
A
Alex Dima 已提交
3980 3981 3982 3983 3984 3985
        /**
         * Given a completion item fill in more data, like [doc-comment](#CompletionItem.documentation)
         * or [details](#CompletionItem.detail).
         *
         * The editor will only resolve a completion item once.
         */
3986 3987 3988
        resolveCompletionItem?(item: CompletionItem, token: CancellationToken): CompletionItem | Thenable<CompletionItem>;
    }

A
Alex Dima 已提交
3989 3990 3991
    /**
     * Describes how comments for a language work.
     */
3992
    export interface CommentRule {
A
Alex Dima 已提交
3993 3994 3995
        /**
         * The line comment token, like `// this is a comment`
         */
3996
        lineComment?: string;
A
Alex Dima 已提交
3997 3998 3999
        /**
         * The block comment character pair, like `/* block comment *&#47;`
         */
4000 4001 4002
        blockComment?: CharacterPair;
    }

A
Alex Dima 已提交
4003
    /**
B
Benjamin Pasero 已提交
4004 4005
     * The language configuration interface defines the contract between extensions and
     * various editor features, like automatic bracket insertion, automatic indentation etc.
A
Alex Dima 已提交
4006 4007 4008 4009 4010
     */
    export interface LanguageConfiguration {
        /**
         * The language's comment settings.
         */
4011
        comments?: CommentRule;
A
Alex Dima 已提交
4012 4013 4014 4015
        /**
         * The language's brackets.
         * This configuration implicitly affects pressing Enter around these brackets.
         */
4016
        brackets?: CharacterPair[];
A
Alex Dima 已提交
4017 4018 4019 4020 4021 4022 4023
        /**
         * The language's word definition.
         * If the language supports Unicode identifiers (e.g. JavaScript), it is preferable
         * to provide a word definition that uses exclusion of known separators.
         * e.g.: A regex that matches anything except known separators (and dot is allowed to occur in a floating point number):
         *   /(-?\d*\.\d\w*)|([^\`\~\!\@\#\%\^\&\*\(\)\-\=\+\[\{\]\}\\\|\;\:\'\"\,\.\<\>\/\?\s]+)/g
         */
4024
        wordPattern?: RegExp;
A
Alex Dima 已提交
4025 4026 4027 4028 4029
        /**
         * The language's indentation settings.
         */
        indentationRules?: IndentationRule;
        /**
A
Alex Dima 已提交
4030 4031
         * The language's rules to be evaluated when pressing Enter.
         */
A
Alex Dima 已提交
4032 4033 4034 4035 4036
        onEnterRules?: OnEnterRule[];
        /**
         * The language's auto closing pairs. The 'close' character is automatically inserted with the
         * 'open' character is typed. If not set, the configured brackets will be used.
         */
4037
        autoClosingPairs?: IAutoClosingPairConditional[];
A
Alex Dima 已提交
4038 4039 4040 4041 4042
        /**
         * The language's surrounding pairs. When the 'open' character is typed on a selection, the
         * selected string is surrounded by the open and close characters. If not set, the autoclosing pairs
         * settings will be used.
         */
4043
        surroundingPairs?: IAutoClosingPair[];
A
Alex Dima 已提交
4044 4045 4046 4047 4048
        /**
         * **Deprecated** Do not use.
         *
         * @deprecated Will be replaced by a better API soon.
         */
4049 4050 4051
        __electricCharacterSupport?: IBracketElectricCharacterContribution;
    }

A
Alex Dima 已提交
4052 4053 4054 4055 4056 4057 4058
    /**
     * Describes indentation rules for a language.
     */
    export interface IndentationRule {
        /**
         * If a line matches this pattern, then all the lines after it should be unindendented once (until another rule matches).
         */
4059
        decreaseIndentPattern: RegExp;
A
Alex Dima 已提交
4060 4061 4062
        /**
         * If a line matches this pattern, then all the lines after it should be indented once (until another rule matches).
         */
4063
        increaseIndentPattern: RegExp;
A
Alex Dima 已提交
4064 4065 4066
        /**
         * If a line matches this pattern, then **only the next line** after it should be indented once.
         */
4067
        indentNextLinePattern?: RegExp;
A
Alex Dima 已提交
4068 4069 4070
        /**
         * If a line matches this pattern, then its indentation should not be changed and it should not be evaluated against the other rules.
         */
4071 4072 4073
        unIndentedLinePattern?: RegExp;
    }

A
Alex Dima 已提交
4074 4075 4076 4077 4078 4079 4080
    /**
     * Describes a rule to be evaluated when pressing Enter.
     */
    export interface OnEnterRule {
        /**
         * This rule will only execute if the text before the cursor matches this regular expression.
         */
4081
        beforeText: RegExp;
A
Alex Dima 已提交
4082 4083 4084
        /**
         * This rule will only execute if the text after the cursor matches this regular expression.
         */
4085
        afterText?: RegExp;
A
Alex Dima 已提交
4086 4087 4088 4089
        /**
         * The action to execute.
         */
        action: EnterAction;
4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106
    }

    export interface IBracketElectricCharacterContribution {
        docComment?: IDocComment;
        embeddedElectricCharacters?: string[];
    }

    /**
     * Definition of documentation comments (e.g. Javadoc/JSdoc)
     */
    export interface IDocComment {
        scope: string;
        open: string;
        lineStart: string;
        close?: string;
    }

A
Alex Dima 已提交
4107 4108 4109
    /**
     * A mode. Will soon be obsolete.
     */
4110 4111 4112 4113
    export interface IMode {
        getId(): string;
    }

A
Alex Dima 已提交
4114 4115 4116
    /**
     * A token. Only supports a single scope, but will soon support a scope array.
     */
4117 4118 4119 4120 4121
    export interface IToken {
        startIndex: number;
        scopes: string | string[];
    }

A
Alex Dima 已提交
4122 4123 4124
    /**
     * The result of a line tokenization.
     */
4125
    export interface ILineTokens {
A
Alex Dima 已提交
4126 4127 4128
        /**
         * The list of tokens on the line.
         */
4129
        tokens: IToken[];
A
Alex Dima 已提交
4130 4131 4132 4133
        /**
         * The tokenization end state.
         * A pointer will be held to this and the object should not be modified by the tokenizer after the pointer is returned.
         */
4134
        endState: IState;
A
Alex Dima 已提交
4135 4136 4137
        /**
         * An optional promise to force the model to retokenize this line (e.g. missing information at the point of tokenization)
         */
4138 4139 4140
        retokenize?: Promise<void>;
    }

A
Alex Dima 已提交
4141 4142 4143 4144 4145
    /**
     * The state of the tokenizer between two lines.
     * It is useful to store flags such as in multiline comment, etc.
     * The model will clone the previous line's state and pass it in to tokenize the next line.
     */
4146 4147 4148 4149 4150
    export interface IState {
        clone(): IState;
        equals(other: IState): boolean;
    }

A
Alex Dima 已提交
4151 4152 4153
    /**
     * A "manual" provider of tokens.
     */
4154
    export interface TokensProvider {
A
Alex Dima 已提交
4155 4156 4157
        /**
         * The initial state of a language. Will be the state passed in to tokenize the first line.
         */
4158
        getInitialState(): IState;
A
Alex Dima 已提交
4159 4160 4161
        /**
         * Tokenize a line given the state at the beginning of the line.
         */
4162
        tokenize(line: string, state: IState): ILineTokens;
4163
    }
A
Alex Dima 已提交
4164 4165

    /**
4166 4167
     * A hover represents additional information for a symbol or word. Hovers are
     * rendered in a tooltip-like widget.
A
Alex Dima 已提交
4168
     */
4169
    export interface Hover {
4170
        /**
4171
         * The contents of this hover.
4172
         */
4173
        contents: MarkedString[];
4174
        /**
4175 4176 4177
         * The range to which this hover applies. When missing, the
         * editor will use the range at the current position or the
         * current position itself.
4178
         */
4179 4180 4181
        range: IRange;
    }

A
Alex Dima 已提交
4182 4183 4184 4185
    /**
     * The hover provider interface defines the contract between extensions and
     * the [hover](https://code.visualstudio.com/docs/editor/editingevolved#_hover)-feature.
     */
4186
    export interface HoverProvider {
A
Alex Dima 已提交
4187 4188 4189 4190 4191
        /**
         * Provide a hover for the given position and document. Multiple hovers at the same
         * position will be merged by the editor. A hover can have a range which defaults
         * to the word range at the position when omitted.
         */
4192
        provideHover(model: editor.IReadOnlyModel, position: Position, token: CancellationToken): Hover | Thenable<Hover>;
4193
    }
4194

A
Alex Dima 已提交
4195
    /**
4196
     * Interface used to quick fix typing errors while accesing member fields.
A
Alex Dima 已提交
4197
     */
A
Alex Dima 已提交
4198 4199
    export interface CodeAction {
        command: Command;
4200 4201 4202
        score: number;
    }

A
Alex Dima 已提交
4203 4204 4205 4206
    /**
     * Represents a parameter of a callable-signature. A parameter can
     * have a label and a doc-comment.
     */
4207
    export interface ParameterInformation {
A
Alex Dima 已提交
4208 4209 4210 4211
        /**
         * The label of this signature. Will be shown in
         * the UI.
         */
4212
        label: string;
A
Alex Dima 已提交
4213 4214 4215 4216
        /**
         * The human-readable doc-comment of this signature. Will be shown
         * in the UI but can be omitted.
         */
4217 4218 4219
        documentation: string;
    }

A
Alex Dima 已提交
4220 4221 4222 4223 4224
    /**
     * Represents the signature of something callable. A signature
     * can have a label, like a function-name, a doc-comment, and
     * a set of parameters.
     */
4225
    export interface SignatureInformation {
A
Alex Dima 已提交
4226 4227 4228 4229
        /**
         * The label of this signature. Will be shown in
         * the UI.
         */
4230
        label: string;
A
Alex Dima 已提交
4231 4232 4233 4234
        /**
         * The human-readable doc-comment of this signature. Will be shown
         * in the UI but can be omitted.
         */
4235
        documentation: string;
A
Alex Dima 已提交
4236 4237 4238
        /**
         * The parameters of this signature.
         */
4239 4240 4241
        parameters: ParameterInformation[];
    }

A
Alex Dima 已提交
4242 4243 4244 4245 4246
    /**
     * Signature help represents the signature of something
     * callable. There can be multiple signatures but only one
     * active and only one active parameter.
     */
4247
    export interface SignatureHelp {
A
Alex Dima 已提交
4248 4249 4250
        /**
         * One or more signatures.
         */
4251
        signatures: SignatureInformation[];
A
Alex Dima 已提交
4252 4253 4254
        /**
         * The active signature.
         */
4255
        activeSignature: number;
A
Alex Dima 已提交
4256 4257 4258
        /**
         * The active parameter of the active signature.
         */
4259 4260 4261
        activeParameter: number;
    }

A
Alex Dima 已提交
4262 4263 4264 4265
    /**
     * The signature help provider interface defines the contract between extensions and
     * the [parameter hints](https://code.visualstudio.com/docs/editor/editingevolved#_parameter-hints)-feature.
     */
4266 4267
    export interface SignatureHelpProvider {
        signatureHelpTriggerCharacters: string[];
A
Alex Dima 已提交
4268 4269 4270
        /**
         * Provide help for the signature at the given position and document.
         */
4271 4272 4273
        provideSignatureHelp(model: editor.IReadOnlyModel, position: Position, token: CancellationToken): SignatureHelp | Thenable<SignatureHelp>;
    }

A
Alex Dima 已提交
4274 4275 4276
    /**
     * A document highlight kind.
     */
4277
    export enum DocumentHighlightKind {
A
Alex Dima 已提交
4278 4279 4280
        /**
         * A textual occurrence.
         */
4281
        Text = 0,
A
Alex Dima 已提交
4282 4283 4284
        /**
         * Read-access of a symbol, like reading a variable.
         */
4285
        Read = 1,
A
Alex Dima 已提交
4286 4287 4288
        /**
         * Write-access of a symbol, like writing to a variable.
         */
4289 4290 4291
        Write = 2,
    }

A
Alex Dima 已提交
4292 4293 4294 4295 4296
    /**
     * A document highlight is a range inside a text document which deserves
     * special attention. Usually a document highlight is visualized by changing
     * the background color of its range.
     */
4297
    export interface DocumentHighlight {
A
Alex Dima 已提交
4298 4299 4300
        /**
         * The range this highlight applies to.
         */
4301
        range: IRange;
A
Alex Dima 已提交
4302 4303 4304
        /**
         * The highlight kind, default is [text](#DocumentHighlightKind.Text).
         */
4305 4306 4307
        kind: DocumentHighlightKind;
    }

A
Alex Dima 已提交
4308 4309 4310 4311
    /**
     * The document highlight provider interface defines the contract between extensions and
     * the word-highlight-feature.
     */
4312
    export interface DocumentHighlightProvider {
A
Alex Dima 已提交
4313 4314 4315 4316
        /**
         * Provide a set of document highlights, like all occurrences of a variable or
         * all exit-points of a function.
         */
4317 4318 4319
        provideDocumentHighlights(model: editor.IReadOnlyModel, position: Position, token: CancellationToken): DocumentHighlight[] | Thenable<DocumentHighlight[]>;
    }

A
Alex Dima 已提交
4320 4321 4322 4323
    /**
     * Value-object that contains additional information when
     * requesting references.
     */
4324
    export interface ReferenceContext {
A
Alex Dima 已提交
4325 4326 4327
        /**
         * Include the declaration of the current symbol.
         */
4328 4329 4330
        includeDeclaration: boolean;
    }

A
Alex Dima 已提交
4331 4332 4333 4334
    /**
     * The reference provider interface defines the contract between extensions and
     * the [find references](https://code.visualstudio.com/docs/editor/editingevolved#_peek)-feature.
     */
4335
    export interface ReferenceProvider {
A
Alex Dima 已提交
4336 4337 4338
        /**
         * Provide a set of project-wide references for the given position and document.
         */
4339 4340 4341
        provideReferences(model: editor.IReadOnlyModel, position: Position, context: ReferenceContext, token: CancellationToken): Location[] | Thenable<Location[]>;
    }

A
Alex Dima 已提交
4342 4343 4344 4345
    /**
     * Represents a location inside a resource, such as a line
     * inside a text file.
     */
A
Alex Dima 已提交
4346
    export interface Location {
A
Alex Dima 已提交
4347 4348 4349
        /**
         * The resource identifier of this location.
         */
4350
        uri: Uri;
A
Alex Dima 已提交
4351 4352 4353
        /**
         * The document range of this locations.
         */
4354 4355 4356
        range: IRange;
    }

A
Alex Dima 已提交
4357 4358 4359 4360 4361
    /**
     * The definition of a symbol represented as one or many [locations](#Location).
     * For most programming languages there is only one location at which a symbol is
     * defined.
     */
4362 4363
    export type Definition = Location | Location[];

A
Alex Dima 已提交
4364 4365 4366 4367 4368
    /**
     * The definition provider interface defines the contract between extensions and
     * the [go to definition](https://code.visualstudio.com/docs/editor/editingevolved#_go-to-definition)
     * and peek definition features.
     */
4369
    export interface DefinitionProvider {
A
Alex Dima 已提交
4370 4371 4372
        /**
         * Provide the definition of the symbol at the given position and document.
         */
4373 4374 4375
        provideDefinition(model: editor.IReadOnlyModel, position: Position, token: CancellationToken): Definition | Thenable<Definition>;
    }

A
Alex Dima 已提交
4376 4377 4378
    /**
     * A symbol kind.
     */
4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402
    export enum SymbolKind {
        File = 0,
        Module = 1,
        Namespace = 2,
        Package = 3,
        Class = 4,
        Method = 5,
        Property = 6,
        Field = 7,
        Constructor = 8,
        Enum = 9,
        Interface = 10,
        Function = 11,
        Variable = 12,
        Constant = 13,
        String = 14,
        Number = 15,
        Boolean = 16,
        Array = 17,
        Object = 18,
        Key = 19,
        Null = 20,
    }

A
Alex Dima 已提交
4403 4404 4405 4406
    /**
     * Represents information about programming constructs like variables, classes,
     * interfaces etc.
     */
4407
    export interface SymbolInformation {
A
Alex Dima 已提交
4408 4409 4410
        /**
         * The name of this symbol.
         */
4411
        name: string;
A
Alex Dima 已提交
4412 4413 4414
        /**
         * The name of the symbol containing this symbol.
         */
4415
        containerName?: string;
A
Alex Dima 已提交
4416 4417 4418
        /**
         * The kind of this symbol.
         */
4419
        kind: SymbolKind;
A
Alex Dima 已提交
4420 4421 4422
        /**
         * The location of this symbol.
         */
4423 4424 4425
        location: Location;
    }

A
Alex Dima 已提交
4426 4427 4428 4429
    /**
     * The document symbol provider interface defines the contract between extensions and
     * the [go to symbol](https://code.visualstudio.com/docs/editor/editingevolved#_goto-symbol)-feature.
     */
4430
    export interface DocumentSymbolProvider {
A
Alex Dima 已提交
4431 4432 4433
        /**
         * Provide symbol information for the given document.
         */
4434
        provideDocumentSymbols(model: editor.IReadOnlyModel, token: CancellationToken): SymbolInformation[] | Thenable<SymbolInformation[]>;
4435
    }
4436

A
Alex Dima 已提交
4437
    /**
4438
     * Interface used to format a model
A
Alex Dima 已提交
4439
     */
A
Alex Dima 已提交
4440 4441 4442 4443
    export interface FormattingOptions {
        /**
         * Size of a tab in spaces.
         */
4444
        tabSize: number;
A
Alex Dima 已提交
4445 4446 4447
        /**
         * Prefer spaces over tabs.
         */
4448 4449 4450
        insertSpaces: boolean;
    }

A
Alex Dima 已提交
4451 4452 4453 4454
    /**
     * The document formatting provider interface defines the contract between extensions and
     * the formatting-feature.
     */
4455
    export interface DocumentFormattingEditProvider {
A
Alex Dima 已提交
4456 4457 4458 4459
        /**
         * Provide formatting edits for a whole document.
         */
        provideDocumentFormattingEdits(model: editor.IReadOnlyModel, options: FormattingOptions, token: CancellationToken): editor.ISingleEditOperation[] | Thenable<editor.ISingleEditOperation[]>;
4460 4461
    }

A
Alex Dima 已提交
4462 4463 4464 4465
    /**
     * The document formatting provider interface defines the contract between extensions and
     * the formatting-feature.
     */
4466
    export interface DocumentRangeFormattingEditProvider {
A
Alex Dima 已提交
4467 4468 4469 4470 4471 4472 4473 4474
        /**
         * Provide formatting edits for a range in a document.
         *
         * The given range is a hint and providers can decide to format a smaller
         * or larger range. Often this is done by adjusting the start and end
         * of the range to full syntax nodes.
         */
        provideDocumentRangeFormattingEdits(model: editor.IReadOnlyModel, range: Range, options: FormattingOptions, token: CancellationToken): editor.ISingleEditOperation[] | Thenable<editor.ISingleEditOperation[]>;
4475 4476
    }

A
Alex Dima 已提交
4477 4478 4479 4480
    /**
     * The document formatting provider interface defines the contract between extensions and
     * the formatting-feature.
     */
4481 4482
    export interface OnTypeFormattingEditProvider {
        autoFormatTriggerCharacters: string[];
A
Alex Dima 已提交
4483 4484 4485 4486 4487 4488 4489 4490
        /**
         * Provide formatting edits after a character has been typed.
         *
         * The given position and character should hint to the provider
         * what range the position to expand to, like find the matching `{`
         * when `}` has been entered.
         */
        provideOnTypeFormattingEdits(model: editor.IReadOnlyModel, position: Position, ch: string, options: FormattingOptions, token: CancellationToken): editor.ISingleEditOperation[] | Thenable<editor.ISingleEditOperation[]>;
4491 4492
    }

A
Alex Dima 已提交
4493 4494 4495
    /**
     * A link inside the editor.
     */
4496 4497 4498 4499 4500
    export interface ILink {
        range: IRange;
        url: string;
    }

A
Alex Dima 已提交
4501 4502 4503
    /**
     * A provider of links.
     */
4504 4505
    export interface LinkProvider {
        provideLinks(model: editor.IReadOnlyModel, token: CancellationToken): ILink[] | Thenable<ILink[]>;
4506
        resolveLink?: (link: ILink, token: CancellationToken) => ILink | Thenable<ILink>;
4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517
    }

    export interface IResourceEdit {
        resource: Uri;
        range: IRange;
        newText: string;
    }

    export interface WorkspaceEdit {
        edits: IResourceEdit[];
        rejectReason?: string;
4518 4519
    }

4520 4521
    export interface RenameProvider {
        provideRenameEdits(model: editor.IReadOnlyModel, position: Position, newName: string, token: CancellationToken): WorkspaceEdit | Thenable<WorkspaceEdit>;
4522
    }
4523

A
Alex Dima 已提交
4524
    export interface Command {
4525 4526 4527
        id: string;
        title: string;
        arguments?: any[];
4528 4529
    }

4530 4531 4532
    export interface ICodeLensSymbol {
        range: IRange;
        id?: string;
A
Alex Dima 已提交
4533
        command?: Command;
4534 4535
    }

4536 4537 4538
    export interface CodeLensProvider {
        provideCodeLenses(model: editor.IReadOnlyModel, token: CancellationToken): ICodeLensSymbol[] | Thenable<ICodeLensSymbol[]>;
        resolveCodeLens?(model: editor.IReadOnlyModel, codeLens: ICodeLensSymbol, token: CancellationToken): ICodeLensSymbol | Thenable<ICodeLensSymbol>;
4539 4540
    }

A
Alex Dima 已提交
4541 4542 4543 4544
    /**
     * A tuple of two characters, like a pair of
     * opening and closing brackets.
     */
4545 4546 4547 4548
    export type CharacterPair = [string, string];

    export interface IAutoClosingPairConditional extends IAutoClosingPair {
        notIn?: string[];
4549 4550
    }

A
Alex Dima 已提交
4551 4552 4553
    /**
     * Describes what to do with the indentation when pressing Enter.
     */
4554
    export enum IndentAction {
A
Alex Dima 已提交
4555 4556 4557
        /**
         * Insert new line and copy the previous line's indentation.
         */
4558
        None = 0,
A
Alex Dima 已提交
4559 4560 4561
        /**
         * Insert new line and indent once (relative to the previous line's indentation).
         */
4562
        Indent = 1,
A
Alex Dima 已提交
4563 4564 4565 4566 4567
        /**
         * Insert two new lines:
         *  - the first one indented which will hold the cursor
         *  - the second one at the same indentation level
         */
4568
        IndentOutdent = 2,
A
Alex Dima 已提交
4569 4570 4571
        /**
         * Insert new line and outdent once (relative to the previous line's indentation).
         */
4572
        Outdent = 3,
4573 4574
    }

A
Alex Dima 已提交
4575
    /**
A
Alex Dima 已提交
4576
     * Describes what to do when pressing Enter.
A
Alex Dima 已提交
4577
     */
A
Alex Dima 已提交
4578 4579 4580 4581
    export interface EnterAction {
        /**
         * Describe what to do with the indentation.
         */
4582
        indentAction: IndentAction;
A
Alex Dima 已提交
4583 4584 4585
        /**
         * Describes text to be appended after the new line and after the indentation.
         */
4586
        appendText?: string;
A
Alex Dima 已提交
4587 4588 4589
        /**
         * Describes the number of characters to remove from the new line's indentation.
         */
4590
        removeText?: number;
4591
    }
A
Alex Dima 已提交
4592

4593 4594 4595
    export interface IAutoClosingPair {
        open: string;
        close: string;
4596
    }
4597

4598 4599 4600 4601 4602 4603 4604 4605 4606 4607
    export interface ILanguageExtensionPoint {
        id: string;
        extensions?: string[];
        filenames?: string[];
        filenamePatterns?: string[];
        firstLine?: string;
        aliases?: string[];
        mimetypes?: string[];
        configuration?: string;
    }
4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720
    /**
     * A Monarch language definition
     */
    export interface IMonarchLanguage {
        /**
         * map from string to ILanguageRule[]
         */
        tokenizer: {
            [name: string]: IMonarchLanguageRule[];
        };
        /**
         * is the language case insensitive?
         */
        ignoreCase?: boolean;
        /**
         * if no match in the tokenizer assign this token class (default 'source')
         */
        defaultToken?: string;
        /**
         * for example [['{','}','delimiter.curly']]
         */
        brackets?: IMonarchLanguageBracket[];
        /**
         * start symbol in the tokenizer (by default the first entry is used)
         */
        start?: string;
        /**
         * attach this to every token class (by default '.' + name)
         */
        tokenPostfix: string;
    }

    /**
     * A rule is either a regular expression and an action
     * 		shorthands: [reg,act] == { regex: reg, action: act}
     *		and       : [reg,act,nxt] == { regex: reg, action: act{ next: nxt }}
     */
    export interface IMonarchLanguageRule {
        /**
         * match tokens
         */
        regex?: string | RegExp;
        /**
         * action to take on match
         */
        action?: IMonarchLanguageAction;
        /**
         * or an include rule. include all rules from the included state
         */
        include?: string;
    }

    /**
     * An action is either an array of actions...
     * ... or a case statement with guards...
     * ... or a basic action with a token value.
     */
    export interface IMonarchLanguageAction {
        /**
         * array of actions for each parenthesized match group
         */
        group?: IMonarchLanguageAction[];
        /**
         * map from string to ILanguageAction
         */
        cases?: Object;
        /**
         * token class (ie. css class) (or "@brackets" or "@rematch")
         */
        token?: string;
        /**
         * the next state to push, or "@push", "@pop", "@popall"
         */
        next?: string;
        /**
         * switch to this state
         */
        switchTo?: string;
        /**
         * go back n characters in the stream
         */
        goBack?: number;
        /**
         * @open or @close
         */
        bracket?: string;
        /**
         * switch to embedded language (useing the mimetype) or get out using "@pop"
         */
        nextEmbedded?: string;
        /**
         * log a message to the browser console window
         */
        log?: string;
    }

    /**
     * This interface can be shortened as an array, ie. ['{','}','delimiter.curly']
     */
    export interface IMonarchLanguageBracket {
        /**
         * open bracket
         */
        open: string;
        /**
         * closeing bracket
         */
        close: string;
        /**
         * token class
         */
        token: string;
    }
4721 4722 4723 4724 4725

}

declare module monaco.worker {

4726

4727 4728 4729
    export interface IMirrorModel {
        uri: Uri;
        version: number;
4730
        getValue(): string;
4731
    }
4732

4733 4734 4735 4736 4737 4738
    export interface IWorkerContext {
        /**
         * Get all available mirror models in this worker.
         */
        getMirrorModels(): IMirrorModel[];
    }
4739

4740
}