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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
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
|
/**
* @license
* Copyright 2016 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import {GrAnnotation} from '../gr-diff-highlight/gr-annotation';
import {GrDiffLine, GrDiffLineType} from '../gr-diff/gr-diff-line';
import {strToClassName} from '../../../utils/dom-util';
import {Side} from '../../../constants/constants';
import {CommentRange} from '../../../types/common';
import {DiffLayer, DiffLayerListener} from '../../../types/types';
import {isLongCommentRange} from '../gr-diff/gr-diff-utils';
/**
* Enhanced CommentRange by UI state. Interface for incoming ranges set from the
* outside.
*
* TODO(TS): Unify with what is used in gr-diff when these objects are created.
*/
export interface CommentRangeLayer {
side: Side;
range: CommentRange;
// New drafts don't have a rootId.
rootId?: string;
}
/** Can be used for array functions like `some()`. */
function equals(a: CommentRangeLayer) {
return (b: CommentRangeLayer) => id(a) === id(b);
}
function id(r: CommentRangeLayer): string {
if (r.rootId) return r.rootId;
return `${r.side}-${r.range.start_line}-${r.range.start_character}-${r.range.end_line}-${r.range.end_character}`;
}
/**
* This class breaks down all comment ranges into individual line segment
* highlights.
*/
interface CommentRangeLineLayer {
longRange: boolean;
id: string;
// start char (0-based)
start: number;
// end char (0-based)
end: number;
}
type LinesMap = {
[line in number]: CommentRangeLineLayer[];
};
type RangesMap = {
[side in Side]: LinesMap;
};
const RANGE_BASE_ONLY = 'style-scope gr-diff range';
const RANGE_HIGHLIGHT = 'style-scope gr-diff range rangeHighlight';
// Note that there is also `rangeHoverHighlight` being set by GrDiffHighlight.
export class GrRangedCommentLayer implements DiffLayer {
private knownRanges: CommentRangeLayer[] = [];
private listeners: DiffLayerListener[] = [];
private rangesMap: RangesMap = {left: {}, right: {}};
/**
* Layer method to add annotations to a line.
*
* @param el The DIV.contentText element to apply the annotation to.
*/
annotate(el: HTMLElement, _: HTMLElement, line: GrDiffLine) {
let ranges: CommentRangeLineLayer[] = [];
if (
line.type === GrDiffLineType.REMOVE ||
(line.type === GrDiffLineType.BOTH &&
el.getAttribute('data-side') !== Side.RIGHT)
) {
ranges = this.getRangesForLine(line, Side.LEFT);
}
if (
line.type === GrDiffLineType.ADD ||
(line.type === GrDiffLineType.BOTH &&
el.getAttribute('data-side') !== Side.LEFT)
) {
ranges = this.getRangesForLine(line, Side.RIGHT);
}
for (const range of ranges) {
GrAnnotation.annotateElement(
el,
range.start,
range.end - range.start,
(range.longRange ? RANGE_BASE_ONLY : RANGE_HIGHLIGHT) +
` ${strToClassName(range.id)}`
);
}
}
/**
* Register a listener for layer updates.
*/
addListener(listener: DiffLayerListener) {
this.listeners.push(listener);
}
removeListener(listener: DiffLayerListener) {
this.listeners = this.listeners.filter(f => f !== listener);
}
/**
* Notify Layer listeners of changes to annotations.
*/
private notifyUpdateRange(start: number, end: number, side: Side) {
for (const listener of this.listeners) {
listener(start, end, side);
}
}
updateRanges(newRanges: CommentRangeLayer[]) {
for (const newRange of newRanges) {
if (this.knownRanges.some(equals(newRange))) continue;
this.addRange(newRange);
}
for (const knownRange of this.knownRanges) {
if (newRanges.some(equals(knownRange))) continue;
this.removeRange(knownRange);
}
this.knownRanges = [...newRanges];
}
private addRange(commentRange: CommentRangeLayer) {
const {side, range} = commentRange;
const longRange = isLongCommentRange(range);
this.updateRangesMap({
side,
range,
operation: (forLine, startChar, endChar) => {
forLine.push({
start: startChar,
end: endChar,
id: id(commentRange),
longRange,
});
},
});
}
private removeRange(commentRange: CommentRangeLayer) {
const {side, range} = commentRange;
this.updateRangesMap({
side,
range,
operation: forLine => {
const index = forLine.findIndex(
lineRange => id(commentRange) === lineRange.id
);
if (index > -1) forLine.splice(index, 1);
},
});
}
private updateRangesMap(options: {
side: Side;
range: CommentRange;
operation: (
forLine: CommentRangeLineLayer[],
start: number,
end: number
) => void;
}) {
const {side, range, operation} = options;
const forSide = this.rangesMap[side] || (this.rangesMap[side] = {});
for (let line = range.start_line; line <= range.end_line; line++) {
const forLine = forSide[line] || (forSide[line] = []);
const start = line === range.start_line ? range.start_character : 0;
const end = line === range.end_line ? range.end_character : -1;
operation(forLine, start, end);
}
this.notifyUpdateRange(range.start_line, range.end_line, side);
}
// visible for testing
getRangesForLine(line: GrDiffLine, side: Side): CommentRangeLineLayer[] {
const lineNum = side === Side.LEFT ? line.beforeNumber : line.afterNumber;
if (lineNum === 'FILE' || lineNum === 'LOST') return [];
const ranges: CommentRangeLineLayer[] = this.rangesMap[side][lineNum] || [];
return ranges.map(range => {
// Make a copy, so that the normalization below does not mess with
// our map.
range = {...range};
range.end = range.end === -1 ? line.text.length : range.end;
// Normalize invalid ranges where the start is after the end but the
// start still makes sense. Set the end to the end of the line.
// @see Issue 5744
if (range.start >= range.end && range.start < line.text.length) {
range.end = line.text.length;
}
return range;
});
}
}
|
