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
|
/*
* SonarQube
* Copyright (C) 2009-2016 SonarSource SA
* mailto:contact 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 _ from 'underscore';
/**
* Intersect two ranges
* @param {number} s1 Start position of the first range
* @param {number} e1 End position of the first range
* @param {number} s2 Start position of the second range
* @param {number} e2 End position of the second range
* @returns {{from: number, to: number}}
*/
function intersect (s1, e1, s2, e2) {
return { from: Math.max(s1, s2), to: Math.min(e1, e2) };
}
/**
* Get the substring of a string
* @param {string} str A string
* @param {number} from "From" offset
* @param {number} to "To" offset
* @param {number} acc Global offset to eliminate
* @returns {string}
*/
function part (str, from, to, acc) {
// 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);
}
/**
* Split a code html into tokens
* @param {string} code
* @param {string} rootClassName
* @returns {Array}
*/
function splitByTokens (code, rootClassName = '') {
const container = document.createElement('div');
let tokens = [];
container.innerHTML = code;
[].forEach.call(container.childNodes, function (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;
}
/**
* Highlight issue locations in the list of tokens
* @param {Array} tokens
* @param {Array} issueLocations
* @param {string} className
* @returns {Array}
*/
function highlightIssueLocations (tokens, issueLocations, className) {
issueLocations.forEach(function (location) {
const nextTokens = [];
let acc = 0;
tokens.forEach(function (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(className) === -1 ?
[token.className, className].join(' ') : 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;
}
/**
* Generate an html string from the list of tokens
* @param {Array} tokens
* @returns {string}
*/
function generateHTML (tokens) {
return tokens.map(function (token) {
return `<span class="${token.className}">${_.escape(token.text)}</span>`;
}).join('');
}
/**
* Take the initial source code, split by tokens,
* highlight issues and generate result html
* @param {string} code
* @param {Array} issueLocations
* @param {string} [optionalClassName]
* @returns {string}
*/
function doTheStuff (code, issueLocations, optionalClassName) {
const _code = code || ' ';
const _issueLocations = issueLocations || [];
const _className = optionalClassName ? optionalClassName : 'source-line-code-issue';
return generateHTML(highlightIssueLocations(splitByTokens(_code), _issueLocations, _className));
}
export default doTheStuff;
|
