Skip to content
This repository was archived by the owner on May 28, 2025. It is now read-only.

Commit bbcf176

Browse files
GuillaumeGomezGuillaumeGomez
committed
Improve naming of "val" field
1 parent f5833e7 commit bbcf176

File tree

12 files changed

+58
-58
lines changed

12 files changed

+58
-58
lines changed

‎src/librustdoc/html/static/js/externs.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ var QueryElement;
2121
/**
2222
* @typedef {{
2323
* original: string,
24-
* val: string,
24+
* userQuery: string,
2525
* length: number,
2626
* pos: number,
2727
* typeFilter: number,

‎src/librustdoc/html/static/js/search.js

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ window.initSearch = function(rawSearchIndex) {
163163
* @param {string} val - The user query
164164
* @return {ParsedQuery} - The parsed query
165165
*/
166-
function parseQuery(val) {
166+
function parseQuery(userQuery) {
167167
function isWhitespace(c) {
168168
return " \t\n\r".indexOf(c) !== -1;
169169
}
@@ -182,8 +182,8 @@ window.initSearch = function(rawSearchIndex) {
182182
throw new Error("Cannot use literal search when there is more than one element");
183183
}
184184
query.pos += 1;
185-
while (query.pos < query.length && query.val[query.pos] !== "\"") {
186-
if (query.val[query.pos] === "\\") {
185+
while (query.pos < query.length && query.userQuery[query.pos] !== "\"") {
186+
if (query.userQuery[query.pos] === "\\") {
187187
// We ignore the next coming character.
188188
query.pos += 1;
189189
}
@@ -198,7 +198,7 @@ window.initSearch = function(rawSearchIndex) {
198198
}
199199
function skipWhitespaces(query) {
200200
while (query.pos < query.length) {
201-
var c = query.val[query.pos];
201+
var c = query.userQuery[query.pos];
202202
if (!isWhitespace(c)) {
203203
break;
204204
}
@@ -207,7 +207,7 @@ window.initSearch = function(rawSearchIndex) {
207207
}
208208
function skipStopCharacters(query) {
209209
while (query.pos < query.length) {
210-
var c = query.val[query.pos];
210+
var c = query.userQuery[query.pos];
211211
if (!isStopCharacter(c)) {
212212
break;
213213
}
@@ -216,11 +216,11 @@ window.initSearch = function(rawSearchIndex) {
216216
}
217217
function isPathStart(query) {
218218
var pos = query.pos;
219-
return pos + 1 < query.length && query.val[pos] === ':' && query.val[pos + 1] === ':';
219+
return pos + 1 < query.length && query.userQuery[pos] === ':' && query.userQuery[pos + 1] === ':';
220220
}
221221
function isReturnArrow(query) {
222222
var pos = query.pos;
223-
return pos + 1 < query.length && query.val[pos] === '-' && query.val[pos + 1] === '>';
223+
return pos + 1 < query.length && query.userQuery[pos] === '-' && query.userQuery[pos + 1] === '>';
224224
}
225225
function removeEmptyStringsFromArray(x) {
226226
for (var i = 0, len = x.length; i < len; ++i) {
@@ -230,19 +230,19 @@ window.initSearch = function(rawSearchIndex) {
230230
}
231231
}
232232
}
233-
function createQueryElement(query, elems, val, generics) {
233+
function createQueryElement(query, elems, name, generics) {
234234
removeEmptyStringsFromArray(generics);
235-
if (val === '*' || (val.length === 0 && generics.length === 0)) {
235+
if (name === '*' || (name.length === 0 && generics.length === 0)) {
236236
return;
237237
}
238-
var paths = val.split("::");
238+
var paths = name.split("::");
239239
removeEmptyStringsFromArray(paths);
240240
// In case we only have something like `<p>`, there is no name but it remains valid.
241241
if (paths.length === 0) {
242242
paths = [""];
243243
}
244244
elems.push({
245-
name: val,
245+
name: name,
246246
fullPath: paths,
247247
pathWithoutLast: paths.slice(0, paths.length - 1),
248248
pathLast: paths[paths.length - 1],
@@ -257,14 +257,14 @@ window.initSearch = function(rawSearchIndex) {
257257
var start = query.pos;
258258
var end = start;
259259
// We handle the strings on their own mostly to make code easier to follow.
260-
if (query.val[query.pos] === "\"") {
260+
if (query.userQuery[query.pos] === "\"") {
261261
start += 1;
262262
getStringElem(query, isInGenerics);
263263
end = query.pos - 1;
264264
skipWhitespaces(query);
265265
} else {
266266
while (query.pos < query.length) {
267-
var c = query.val[query.pos];
267+
var c = query.userQuery[query.pos];
268268
if (isStopCharacter(c) || isSpecialStartCharacter(c)) {
269269
break;
270270
}
@@ -281,17 +281,17 @@ window.initSearch = function(rawSearchIndex) {
281281
skipWhitespaces(query);
282282
}
283283
}
284-
if (query.pos < query.length && query.val[query.pos] === "<") {
284+
if (query.pos < query.length && query.userQuery[query.pos] === "<") {
285285
getItemsBefore(query, generics, ">");
286286
}
287287
if (start >= end && generics.length === 0) {
288288
return;
289289
}
290-
createQueryElement(query, elems, query.val.slice(start, end), generics);
290+
createQueryElement(query, elems, query.userQuery.slice(start, end), generics);
291291
}
292292
function getItemsBefore(query, elems, limit) {
293293
while (query.pos < query.length) {
294-
var c = query.val[query.pos];
294+
var c = query.userQuery[query.pos];
295295
if (c === limit) {
296296
break;
297297
} else if (isSpecialStartCharacter(c) || c === ":") {
@@ -307,7 +307,7 @@ window.initSearch = function(rawSearchIndex) {
307307
var c, before;
308308

309309
while (query.pos < query.length) {
310-
c = query.val[query.pos];
310+
c = query.userQuery[query.pos];
311311
if (isStopCharacter(c)) {
312312
if (c === ",") {
313313
query.pos += 1;
@@ -331,14 +331,14 @@ window.initSearch = function(rawSearchIndex) {
331331
getNextElem(query, query.elems, false);
332332
if (query.elems.length === before) {
333333
// Nothing was added, let's check it's not because of a solo ":"!
334-
if (query.pos >= query.length || query.val[query.pos] !== ":") {
334+
if (query.pos >= query.length || query.userQuery[query.pos] !== ":") {
335335
break;
336336
}
337337
query.pos += 1;
338338
}
339339
}
340340
while (query.pos < query.length) {
341-
c = query.val[query.pos];
341+
c = query.userQuery[query.pos];
342342
if (query.args.length === 0 && c === "(") {
343343
if (query.elemName === null && query.elems.length === 1) {
344344
query.elemName = query.elems.pop();
@@ -364,11 +364,11 @@ window.initSearch = function(rawSearchIndex) {
364364
return NO_TYPE_FILTER;
365365
}
366366

367-
val = val.trim();
367+
userQuery = userQuery.trim();
368368
var query = {
369-
original: val,
370-
val: val.toLowerCase(),
371-
length: val.length,
369+
original: userQuery,
370+
userQuery: userQuery.toLowerCase(),
371+
length: userQuery.length,
372372
pos: 0,
373373
typeFilter: null,
374374
elems: [],
@@ -386,7 +386,7 @@ window.initSearch = function(rawSearchIndex) {
386386
literalSearch: false,
387387
error: null,
388388
};
389-
query.id = val;
389+
query.id = userQuery;
390390
try {
391391
parseInput(query);
392392
} catch (err) {
@@ -405,9 +405,9 @@ window.initSearch = function(rawSearchIndex) {
405405
if (query.elemName !== null) {
406406
query.foundElems += 1;
407407
}
408-
if (query.foundElems === 0 && val.length !== 0) {
408+
if (query.foundElems === 0 && userQuery.length !== 0) {
409409
// In this case, we'll simply keep whatever was entered by the user...
410-
createQueryElement(query, query.elems, val, []);
410+
createQueryElement(query, query.elems, userQuery, []);
411411
query.foundElems += 1;
412412
}
413413
if (query.typeFilter !== null) {
@@ -422,8 +422,8 @@ window.initSearch = function(rawSearchIndex) {
422422
query.elemName = null;
423423
}
424424
if (query.elemName !== null || query.elems.length === 1) {
425-
val = query.elemName || query.elems[0];
426-
query.nameSplit = typeof val.path === "undefined" ? null : val.path;
425+
userQuery = query.elemName || query.elems[0];
426+
query.nameSplit = typeof userQuery.path === "undefined" ? null : userQuery.path;
427427
}
428428
return query;
429429
}
@@ -493,7 +493,7 @@ window.initSearch = function(rawSearchIndex) {
493493

494494
function sortResults(results, isType) {
495495
var nameSplit = queryInfo.nameSplit;
496-
var query = queryInfo.val;
496+
var query = queryInfo.userQuery;
497497
var ar = [];
498498
for (var entry in results) {
499499
if (hasOwnPropertyRustdoc(results, entry)) {
@@ -1344,7 +1344,7 @@ window.initSearch = function(rawSearchIndex) {
13441344
output.className = "search-failed" + extraClass;
13451345
output.innerHTML = "No results :(<br/>" +
13461346
"Try on <a href=\"https://duckduckgo.com/?q=" +
1347-
encodeURIComponent("rust " + query.val) +
1347+
encodeURIComponent("rust " + query.userQuery) +
13481348
"\">DuckDuckGo</a>?<br/><br/>" +
13491349
"Or try looking in one of these:<ul><li>The <a " +
13501350
"href=\"https://doc.rust-lang.org/reference/index.html\">Rust Reference</a> " +
@@ -1424,7 +1424,7 @@ window.initSearch = function(rawSearchIndex) {
14241424
}
14251425

14261426
var output = `<div id="search-settings">` +
1427-
`<h1 class="search-results-title">Results for ${escape(results.query.val)}$` +
1427+
`<h1 class="search-results-title">Results for ${escape(results.query.userQuery)}` +
14281428
`${typeFilter}</h1> in ${crates} </div>` +
14291429
`<div id="titles">` +
14301430
makeTabHeader(0, "In Names", ret_others[1]) +

‎src/test/rustdoc-js-std/parser-errors.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ const PARSED = [
1111
original: "<\"P\">",
1212
returned: [],
1313
typeFilter: null,
14-
val: "<\"p\">",
14+
userQuery: "<\"p\">",
1515
error: "`\"` cannot be used in generics",
1616
},
1717
{
@@ -24,7 +24,7 @@ const PARSED = [
2424
original: "\"P\" \"P\"",
2525
returned: [],
2626
typeFilter: null,
27-
val: "\"p\" \"p\"",
27+
userQuery: "\"p\" \"p\"",
2828
error: "Cannot have more than one literal search element",
2929
},
3030
{
@@ -37,7 +37,7 @@ const PARSED = [
3737
original: "P \"P\"",
3838
returned: [],
3939
typeFilter: null,
40-
val: "p \"p\"",
40+
userQuery: "p \"p\"",
4141
error: "Cannot use literal search when there is more than one element",
4242
},
4343
];

‎src/test/rustdoc-js-std/parser-filter.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ const PARSED = [
1717
original: "fn:foo",
1818
returned: [],
1919
typeFilter: 5,
20-
val: "fn:foo",
20+
userQuery: "fn:foo",
2121
error: null,
2222
},
2323
{
@@ -36,7 +36,7 @@ const PARSED = [
3636
original: "enum : foo",
3737
returned: [],
3838
typeFilter: 4,
39-
val: "enum : foo",
39+
userQuery: "enum : foo",
4040
error: null,
4141
},
4242
{
@@ -55,7 +55,7 @@ const PARSED = [
5555
original: "macro<f>:foo",
5656
returned: [],
5757
typeFilter: 14,
58-
val: "macro<f>:foo",
58+
userQuery: "macro<f>:foo",
5959
error: null,
6060
},
6161
];

‎src/test/rustdoc-js-std/parser-generics.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ const PARSED = [
2525
original: "<P>",
2626
returned: [],
2727
typeFilter: -1,
28-
val: "<p>",
28+
userQuery: "<p>",
2929
error: null,
3030
},
3131
{
@@ -75,7 +75,7 @@ const PARSED = [
7575
original: 'A<B<C<D>, E>',
7676
returned: [],
7777
typeFilter: -1,
78-
val: 'a<b<c<d>, e>',
78+
userQuery: 'a<b<c<d>, e>',
7979
error: null,
8080
}
8181
];

‎src/test/rustdoc-js-std/parser-in_args.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ const PARSED = [
1717
original: "(whatever)",
1818
returned: [],
1919
typeFilter: -1,
20-
val: "(whatever)",
20+
userQuery: "(whatever)",
2121
error: null,
2222
},
2323
{
@@ -44,7 +44,7 @@ const PARSED = [
4444
original: "(<P>)",
4545
returned: [],
4646
typeFilter: -1,
47-
val: "(<p>)",
47+
userQuery: "(<p>)",
4848
error: null,
4949
},
5050
];

‎src/test/rustdoc-js-std/parser-invalid.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ const PARSED = [
3737
},
3838
],
3939
typeFilter: -1,
40-
val: "-> <p> (p2)",
40+
userQuery: "-> <p> (p2)",
4141
error: null,
4242
},
4343
{
@@ -65,7 +65,7 @@ const PARSED = [
6565
original: "(p -> p2",
6666
returned: [],
6767
typeFilter: -1,
68-
val: "(p -> p2",
68+
userQuery: "(p -> p2",
6969
error: null,
7070
},
7171
{
@@ -86,7 +86,7 @@ const PARSED = [
8686
original: "a b",
8787
returned: [],
8888
typeFilter: -1,
89-
val: "a b",
89+
userQuery: "a b",
9090
error: null,
9191
},
9292
{
@@ -122,7 +122,7 @@ const PARSED = [
122122
original: "a,b(c)",
123123
returned: [],
124124
typeFilter: -1,
125-
val: "a,b(c)",
125+
userQuery: "a,b(c)",
126126
error: null,
127127
},
128128
];

‎src/test/rustdoc-js-std/parser-literal.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ const PARSED = [
2525
original: "\"R\"<P>",
2626
returned: [],
2727
typeFilter: -1,
28-
val: "\"r\"<p>",
28+
userQuery: "\"r\"<p>",
2929
error: null,
3030
}
3131
];

‎src/test/rustdoc-js-std/parser-paths.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ const PARSED = [
1717
original: "A::B",
1818
returned: [],
1919
typeFilter: -1,
20-
val: "a::b",
20+
userQuery: "a::b",
2121
error: null,
2222
},
2323
{
@@ -36,7 +36,7 @@ const PARSED = [
3636
original: '::A::B',
3737
returned: [],
3838
typeFilter: -1,
39-
val: '::a::b',
39+
userQuery: '::a::b',
4040
error: null,
4141
},
4242
{
@@ -64,7 +64,7 @@ const PARSED = [
6464
original: 'A::B::,C',
6565
returned: [],
6666
typeFilter: -1,
67-
val: 'a::b::,c',
67+
userQuery: 'a::b::,c',
6868
error: null,
6969
},
7070
{
@@ -100,7 +100,7 @@ const PARSED = [
100100
original: 'A::B::<f>,C',
101101
returned: [],
102102
typeFilter: -1,
103-
val: 'a::b::<f>,c',
103+
userQuery: 'a::b::<f>,c',
104104
error: null,
105105
},
106106
];

0 commit comments

Comments
 (0)