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
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at <http://mozilla.org/MPL/2.0/>. */
function _isInvalidTarget(target) {
if (!target || !target.innerText) {
return true;
}
const tokenText = target.innerText.trim();
// exclude syntax where the expression would be a syntax error
const invalidToken =
tokenText === "" || tokenText.match(/^[(){}\|&%,.;=<>\+-/\*\s](?=)/);
if (invalidToken) {
return true;
}
// exclude tokens for which it does not make sense to show a preview:
// - literal
// - primitives
// - operators
// - tags
const INVALID_TARGET_CLASSES = [
"cm-atom",
"cm-number",
"cm-operator",
"cm-string",
"cm-tag",
// also exclude editor element (defined in Editor component)
"editor-mount",
];
if (
target.className === "" ||
INVALID_TARGET_CLASSES.some(cls => target.classList.contains(cls))
) {
return true;
}
// We need to exclude keywords, but since codeMirror tags "this" as a keyword, we need
// to check the tokenText as well.
// This seems to be the only case that we want to exclude (see devtools/client/shared/sourceeditor/codemirror/mode/javascript/javascript.js#24-41)
if (target.classList.contains("cm-keyword") && tokenText !== "this") {
return true;
}
// exclude codemirror elements that are not tokens
if (
// exclude inline preview
target.closest(".CodeMirror-widget") ||
// exclude in-line "empty" space, as well as the gutter
target.matches(".CodeMirror-line, .CodeMirror-gutter-elt") ||
// exclude items that are not in a line
!target.closest(".CodeMirror-line") ||
target.getBoundingClientRect().top == 0
) {
return true;
}
// exclude popup
if (target.closest(".popover")) {
return true;
}
return false;
}
function _dispatch(codeMirror, eventName, data) {
codeMirror.constructor.signal(codeMirror, eventName, data);
}
function _invalidLeaveTarget(target) {
if (!target || target.closest(".popover")) {
return true;
}
return false;
}
/**
* Wraps the codemirror mouse events to generate token events
* @param {*} codeMirror
* @returns
*/
export function onMouseOver(codeMirror) {
let prevTokenPos = null;
function onMouseLeave(event) {
if (_invalidLeaveTarget(event.relatedTarget)) {
addMouseLeave(event.target);
return;
}
prevTokenPos = null;
_dispatch(codeMirror, "tokenleave", event);
}
function addMouseLeave(target) {
target.addEventListener("mouseleave", onMouseLeave, {
capture: true,
once: true,
});
}
return enterEvent => {
const { target } = enterEvent;
if (_isInvalidTarget(target)) {
return;
}
const tokenPos = getTokenLocation(codeMirror, target);
if (
prevTokenPos?.line !== tokenPos?.line ||
prevTokenPos?.column !== tokenPos?.column
) {
addMouseLeave(target);
_dispatch(codeMirror, "tokenenter", {
event: enterEvent,
target,
tokenPos,
});
prevTokenPos = tokenPos;
}
};
}
/**
* Gets the end position of a token at a specific line/column
*
* @param {*} codeMirror
* @param {Number} line
* @param {Number} column
* @returns {Number}
*/
export function getTokenEnd(codeMirror, line, column) {
const token = codeMirror.getTokenAt({
line,
ch: column + 1,
});
const tokenString = token.string;
return tokenString === "{" || tokenString === "[" ? null : token.end;
}
/**
* Given the dom element related to the token, this gets its line and column.
*
* @param {*} codeMirror
* @param {*} tokenEl
* @returns {Object} An object of the form { line, column }
*/
export function getTokenLocation(codeMirror, tokenEl) {
// Get the quad (and not the bounding rect), as the span could wrap on multiple lines
// and the middle of the bounding rect may not be over the token:
// +───────────────────────+
// │ myLongVariableNa│
// │me + │
// +───────────────────────+
const { p1, p2, p3 } = tokenEl.getBoxQuads()[0];
const left = p1.x + (p2.x - p1.x) / 2;
const top = p1.y + (p3.y - p1.y) / 2;
const { line, ch } = codeMirror.coordsChar(
{
left,
top,
},
// Use the "window" context where the coordinates are relative to the top-left corner
// of the currently visible (scrolled) window.
// This enables codemirror also correctly handle wrappped lines in the editor.
"window"
);
return {
line: line + 1,
column: ch,
};
}
|
