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
|
/*
* SonarQube
* Copyright (C) 2009-2017 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.
*/
// @flow
import escapeHtml from 'escape-html';
import type { LinearIssueLocation } from './indexing';
export type Token = { className: string, text: string };
export type Tokens = Array<Token>;
const ISSUE_LOCATION_CLASS = 'source-line-code-issue';
export const splitByTokens = (code: string, rootClassName: string = ''): Tokens => {
const container = document.createElement('div');
let tokens = [];
container.innerHTML = code;
[].forEach.call(container.childNodes, node => {
if (node.nodeType === 1) {
// ELEMENT NODE
const fullClassName = rootClassName ? rootClassName + ' ' + node.className : node.className;
const innerTokens = splitByTokens(node.innerHTML, fullClassName);
tokens = tokens.concat(innerTokens);
}
if (node.nodeType === 3) {
// TEXT NODE
tokens.push({ className: rootClassName, text: node.nodeValue });
}
});
return tokens;
};
export const highlightSymbol = (tokens: Tokens, symbol: string): Tokens => {
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
*/
const intersect = (
s1: number,
e1: number,
s2: number,
e2: number
): { from: number, to: 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
*/
const 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 const highlightIssueLocations = (
tokens: Tokens,
issueLocations: Array<LinearIssueLocation>,
rootClassName: string = ISSUE_LOCATION_CLASS
): Tokens => {
issueLocations.forEach(location => {
const nextTokens = [];
let acc = 0;
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({ className: token.className, text: p1 });
}
if (p2.length) {
const newClassName = token.className.indexOf(rootClassName) === -1
? `${token.className} ${rootClassName}`
: token.className;
nextTokens.push({ className: newClassName, text: p2 });
}
if (p3.length) {
nextTokens.push({ className: token.className, text: p3 });
}
acc += token.text.length;
});
tokens = nextTokens.slice();
});
return tokens;
};
export const generateHTML = (tokens: Tokens): string => {
return tokens
.map(token => `<span class="${token.className}">${escapeHtml(token.text)}</span>`)
.join('');
};
|
