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
|
/*
* SonarQube
* Copyright (C) 2009-2023 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
import { uniq } from 'lodash';
import { LinearIssueLocation } from '../../../types/types';
export interface TokenModifiers {
isHighlighted?: boolean;
isLocation?: boolean;
isSelected?: boolean;
isUnderlined?: boolean;
}
export interface Token {
className: string;
markers: number[];
modifiers: TokenModifiers;
text: string;
}
const ISSUE_LOCATION_CLASS = 'source-line-code-issue';
export function splitByTokens(code: NodeListOf<ChildNode>, rootClassName = ''): Token[] {
let tokens: Token[] = [];
Array.prototype.forEach.call(code, (node: Element) => {
if (node.nodeType === 1) {
// ELEMENT NODE
const fullClassName = rootClassName ? rootClassName + ' ' + node.className : node.className;
const innerTokens = splitByTokens(node.childNodes, fullClassName);
tokens = tokens.concat(innerTokens);
}
if (node.nodeType === 3 && node.nodeValue) {
// TEXT NODE
tokens.push({ className: rootClassName, markers: [], text: node.nodeValue, modifiers: {} });
}
});
return tokens;
}
export function highlightSymbol(tokens: Token[], symbol: string): Token[] {
const symbolRegExp = new RegExp(`\\b${symbol}\\b`);
return tokens.map((token) =>
symbolRegExp.test(token.className)
? { ...token, className: `${token.className} highlighted` }
: token
);
}
/**
* Intersect two ranges
* @param s1 Start position of the first range
* @param e1 End position of the first range
* @param s2 Start position of the second range
* @param e2 End position of the second range
*/
function intersect(s1: number, e1: number, s2: number, e2: number) {
return { from: Math.max(s1, s2), to: Math.min(e1, e2) };
}
/**
* Get the substring of a string
* @param str A string
* @param from "From" offset
* @param to "To" offset
* @param acc Global offset to eliminate
*/
function part(str: string, from: number, to: number, acc: number): string {
// we do not want negative number as the first argument of `substr`
return from >= acc ? str.substr(from - acc, to - from) : str.substr(0, to - from);
}
/**
* Highlight issue locations in the list of tokens
*/
export function highlightIssueLocations(
tokens: Token[],
issueLocations: LinearIssueLocation[],
modifier: keyof TokenModifiers,
rootClassName: string = ISSUE_LOCATION_CLASS
): Token[] {
issueLocations.forEach((location) => {
const nextTokens: Token[] = [];
let acc = 0;
let markerAdded = location.line !== location.startLine;
tokens.forEach((token) => {
const x = intersect(acc, acc + token.text.length, location.from, location.to);
const p1 = part(token.text, acc, x.from, acc);
const p2 = part(token.text, x.from, x.to, acc);
const p3 = part(token.text, x.to, acc + token.text.length, acc);
if (p1.length) {
nextTokens.push({ ...token, text: p1 });
}
if (p2.length) {
const newClassName =
token.className.indexOf(rootClassName) === -1
? `${token.className} ${rootClassName}`
: token.className;
nextTokens.push({
className: newClassName,
modifiers: {
...token.modifiers,
[modifier]: true,
},
markers:
!markerAdded && location.index != null
? uniq([...token.markers, location.index])
: token.markers,
text: p2,
});
markerAdded = true;
}
if (p3.length) {
nextTokens.push({ ...token, text: p3 });
}
acc += token.text.length;
});
tokens = nextTokens.slice();
});
return tokens;
}
export const getHighlightedTokens = (params: {
code: string | undefined;
highlightedLocationMessage: { index: number; text: string | undefined } | undefined;
highlightedSymbols: string[] | undefined;
issueLocations: LinearIssueLocation[];
secondaryIssueLocations: LinearIssueLocation[];
}) => {
const {
code,
highlightedLocationMessage,
highlightedSymbols,
issueLocations,
secondaryIssueLocations,
} = params;
const container = document.createElement('div');
container.innerHTML = code ?? '';
let tokens = splitByTokens(container.childNodes);
if (highlightedSymbols) {
highlightedSymbols.forEach((symbol) => {
tokens = highlightSymbol(tokens, symbol);
});
}
if (issueLocations.length > 0) {
tokens = highlightIssueLocations(tokens, issueLocations, 'isUnderlined', 'isUnderlined');
}
if (secondaryIssueLocations) {
tokens = highlightIssueLocations(
tokens,
secondaryIssueLocations,
'isLocation',
'issue-location'
);
if (highlightedLocationMessage) {
const location = secondaryIssueLocations.find(
(location) => location.index === highlightedLocationMessage.index
);
if (location) {
tokens = highlightIssueLocations(tokens, [location], 'isSelected', 'selected');
}
}
}
return tokens;
};
|
