1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { Event } from 'vs/base/common/event';
import { IPosition } from 'vs/editor/common/core/position';
import { IRange, Range } from 'vs/editor/common/core/range';
export interface IBracketPairsTextModelPart {
/**
* Is fired when bracket pairs change, either due to a text or a settings change.
*/
onDidChange: Event<void>;
/**
* Gets all bracket pairs that intersect the given position.
* The result is sorted by the start position.
*/
getBracketPairsInRange(range: IRange): BracketPairInfo[];
/**
* Gets all bracket pairs that intersect the given position.
* The result is sorted by the start position.
*/
getBracketPairsInRangeWithMinIndentation(range: IRange): BracketPairWithMinIndentationInfo[];
getBracketsInRange(range: IRange): BracketInfo[];
/**
* Find the matching bracket of `request` up, counting brackets.
* @param request The bracket we're searching for
* @param position The position at which to start the search.
* @return The range of the matching bracket, or null if the bracket match was not found.
*/
findMatchingBracketUp(bracket: string, position: IPosition, maxDuration?: number): Range | null;
/**
* Find the first bracket in the model before `position`.
* @param position The position at which to start the search.
* @return The info for the first bracket before `position`, or null if there are no more brackets before `positions`.
*/
findPrevBracket(position: IPosition): IFoundBracket | null;
/**
* Find the first bracket in the model after `position`.
* @param position The position at which to start the search.
* @return The info for the first bracket after `position`, or null if there are no more brackets after `positions`.
*/
findNextBracket(position: IPosition): IFoundBracket | null;
/**
* Find the enclosing brackets that contain `position`.
* @param position The position at which to start the search.
*/
findEnclosingBrackets(position: IPosition, maxDuration?: number): [Range, Range] | null;
/**
* Given a `position`, if the position is on top or near a bracket,
* find the matching bracket of that bracket and return the ranges of both brackets.
* @param position The position at which to look for a bracket.
*/
matchBracket(position: IPosition, maxDuration?: number): [Range, Range] | null;
}
export interface IFoundBracket {
range: Range;
open: string[];
close: string[];
isOpen: boolean;
}
export class BracketInfo {
constructor(
public readonly range: Range,
/** 0-based level */
public readonly nestingLevel: number,
public readonly nestingLevelOfEqualBracketType: number,
public readonly isInvalid: boolean,
) { }
}
export class BracketPairInfo {
constructor(
public readonly range: Range,
public readonly openingBracketRange: Range,
public readonly closingBracketRange: Range | undefined,
/** 0-based */
public readonly nestingLevel: number,
public readonly nestingLevelOfEqualBracketType: number,
) { }
}
export class BracketPairWithMinIndentationInfo extends BracketPairInfo {
constructor(
range: Range,
openingBracketRange: Range,
closingBracketRange: Range | undefined,
/**
* 0-based
*/
nestingLevel: number,
nestingLevelOfEqualBracketType: number,
/**
* -1 if not requested, otherwise the size of the minimum indentation in the bracket pair in terms of visible columns.
*/
public readonly minVisibleColumnIndentation: number,
) {
super(range, openingBracketRange, closingBracketRange, nestingLevel, nestingLevelOfEqualBracketType);
}
}
|
