about summary refs log tree commit diff
path: root/src
diff options
context:
space:
mode:
authorGuillaume Gomez <guillaume.gomez@huawei.com>2022-01-03 16:43:30 +0100
committerGuillaume Gomez <guillaume.gomez@huawei.com>2022-04-18 20:59:08 +0200
commitbbcf1762ddd06a895b0bb235fa0718901dc73184 (patch)
tree34bf1963c7a769830bac04949f9cf8445b50df71 /src
parentf5833e759ecd55c03afeb918263cb35fabc91177 (diff)
downloadrust-bbcf1762ddd06a895b0bb235fa0718901dc73184.tar.gz
rust-bbcf1762ddd06a895b0bb235fa0718901dc73184.zip
Improve naming of "val" field
Diffstat (limited to 'src')
-rw-r--r--src/librustdoc/html/static/js/externs.js2
-rw-r--r--src/librustdoc/html/static/js/search.js62
-rw-r--r--src/test/rustdoc-js-std/parser-errors.js6
-rw-r--r--src/test/rustdoc-js-std/parser-filter.js6
-rw-r--r--src/test/rustdoc-js-std/parser-generics.js4
-rw-r--r--src/test/rustdoc-js-std/parser-in_args.js4
-rw-r--r--src/test/rustdoc-js-std/parser-invalid.js8
-rw-r--r--src/test/rustdoc-js-std/parser-literal.js2
-rw-r--r--src/test/rustdoc-js-std/parser-paths.js8
-rw-r--r--src/test/rustdoc-js-std/parser-quote.js8
-rw-r--r--src/test/rustdoc-js-std/parser-returned.js4
-rw-r--r--src/tools/rustdoc-js/tester.js2
12 files changed, 58 insertions, 58 deletions
diff --git a/src/librustdoc/html/static/js/externs.js b/src/librustdoc/html/static/js/externs.js
index 026b4f911c3..15665b1f31a 100644
--- a/src/librustdoc/html/static/js/externs.js
+++ b/src/librustdoc/html/static/js/externs.js
@@ -21,7 +21,7 @@ var QueryElement;
 /**
  * @typedef {{
  *     original: string,
- *     val: string,
+ *     userQuery: string,
  *     length: number,
  *     pos: number,
  *     typeFilter: number,
diff --git a/src/librustdoc/html/static/js/search.js b/src/librustdoc/html/static/js/search.js
index 443b7e366d4..55d957db333 100644
--- a/src/librustdoc/html/static/js/search.js
+++ b/src/librustdoc/html/static/js/search.js
@@ -163,7 +163,7 @@ window.initSearch = function(rawSearchIndex) {
      * @param  {string} val     - The user query
      * @return {ParsedQuery}    - The parsed query
      */
-    function parseQuery(val) {
+    function parseQuery(userQuery) {
         function isWhitespace(c) {
             return " \t\n\r".indexOf(c) !== -1;
         }
@@ -182,8 +182,8 @@ window.initSearch = function(rawSearchIndex) {
                 throw new Error("Cannot use literal search when there is more than one element");
             }
             query.pos += 1;
-            while (query.pos < query.length && query.val[query.pos] !== "\"") {
-                if (query.val[query.pos] === "\\") {
+            while (query.pos < query.length && query.userQuery[query.pos] !== "\"") {
+                if (query.userQuery[query.pos] === "\\") {
                     // We ignore the next coming character.
                     query.pos += 1;
                 }
@@ -198,7 +198,7 @@ window.initSearch = function(rawSearchIndex) {
         }
         function skipWhitespaces(query) {
             while (query.pos < query.length) {
-                var c = query.val[query.pos];
+                var c = query.userQuery[query.pos];
                 if (!isWhitespace(c)) {
                     break;
                 }
@@ -207,7 +207,7 @@ window.initSearch = function(rawSearchIndex) {
         }
         function skipStopCharacters(query) {
             while (query.pos < query.length) {
-                var c = query.val[query.pos];
+                var c = query.userQuery[query.pos];
                 if (!isStopCharacter(c)) {
                     break;
                 }
@@ -216,11 +216,11 @@ window.initSearch = function(rawSearchIndex) {
         }
         function isPathStart(query) {
             var pos = query.pos;
-            return pos + 1 < query.length && query.val[pos] === ':' && query.val[pos + 1] === ':';
+            return pos + 1 < query.length && query.userQuery[pos] === ':' && query.userQuery[pos + 1] === ':';
         }
         function isReturnArrow(query) {
             var pos = query.pos;
-            return pos + 1 < query.length && query.val[pos] === '-' && query.val[pos + 1] === '>';
+            return pos + 1 < query.length && query.userQuery[pos] === '-' && query.userQuery[pos + 1] === '>';
         }
         function removeEmptyStringsFromArray(x) {
             for (var i = 0, len = x.length; i < len; ++i) {
@@ -230,19 +230,19 @@ window.initSearch = function(rawSearchIndex) {
                 }
             }
         }
-        function createQueryElement(query, elems, val, generics) {
+        function createQueryElement(query, elems, name, generics) {
             removeEmptyStringsFromArray(generics);
-            if (val === '*' || (val.length === 0 && generics.length === 0)) {
+            if (name === '*' || (name.length === 0 && generics.length === 0)) {
                 return;
             }
-            var paths = val.split("::");
+            var paths = name.split("::");
             removeEmptyStringsFromArray(paths);
             // In case we only have something like `<p>`, there is no name but it remains valid.
             if (paths.length === 0) {
                 paths = [""];
             }
             elems.push({
-                name: val,
+                name: name,
                 fullPath: paths,
                 pathWithoutLast: paths.slice(0, paths.length - 1),
                 pathLast: paths[paths.length - 1],
@@ -257,14 +257,14 @@ window.initSearch = function(rawSearchIndex) {
             var start = query.pos;
             var end = start;
             // We handle the strings on their own mostly to make code easier to follow.
-            if (query.val[query.pos] === "\"") {
+            if (query.userQuery[query.pos] === "\"") {
                 start += 1;
                 getStringElem(query, isInGenerics);
                 end = query.pos - 1;
                 skipWhitespaces(query);
             } else {
                 while (query.pos < query.length) {
-                    var c = query.val[query.pos];
+                    var c = query.userQuery[query.pos];
                     if (isStopCharacter(c) || isSpecialStartCharacter(c)) {
                         break;
                     }
@@ -281,17 +281,17 @@ window.initSearch = function(rawSearchIndex) {
                     skipWhitespaces(query);
                 }
             }
-            if (query.pos < query.length && query.val[query.pos] === "<") {
+            if (query.pos < query.length && query.userQuery[query.pos] === "<") {
                 getItemsBefore(query, generics, ">");
             }
             if (start >= end && generics.length === 0) {
                 return;
             }
-            createQueryElement(query, elems, query.val.slice(start, end), generics);
+            createQueryElement(query, elems, query.userQuery.slice(start, end), generics);
         }
         function getItemsBefore(query, elems, limit) {
             while (query.pos < query.length) {
-                var c = query.val[query.pos];
+                var c = query.userQuery[query.pos];
                 if (c === limit) {
                     break;
                 } else if (isSpecialStartCharacter(c) || c === ":") {
@@ -307,7 +307,7 @@ window.initSearch = function(rawSearchIndex) {
             var c, before;
 
             while (query.pos < query.length) {
-                c = query.val[query.pos];
+                c = query.userQuery[query.pos];
                 if (isStopCharacter(c)) {
                     if (c === ",") {
                         query.pos += 1;
@@ -331,14 +331,14 @@ window.initSearch = function(rawSearchIndex) {
                 getNextElem(query, query.elems, false);
                 if (query.elems.length === before) {
                     // Nothing was added, let's check it's not because of a solo ":"!
-                    if (query.pos >= query.length || query.val[query.pos] !== ":") {
+                    if (query.pos >= query.length || query.userQuery[query.pos] !== ":") {
                         break;
                     }
                     query.pos += 1;
                 }
             }
             while (query.pos < query.length) {
-                c = query.val[query.pos];
+                c = query.userQuery[query.pos];
                 if (query.args.length === 0 && c === "(") {
                     if (query.elemName === null && query.elems.length === 1) {
                         query.elemName = query.elems.pop();
@@ -364,11 +364,11 @@ window.initSearch = function(rawSearchIndex) {
             return NO_TYPE_FILTER;
         }
 
-        val = val.trim();
+        userQuery = userQuery.trim();
         var query = {
-            original: val,
-            val: val.toLowerCase(),
-            length: val.length,
+            original: userQuery,
+            userQuery: userQuery.toLowerCase(),
+            length: userQuery.length,
             pos: 0,
             typeFilter: null,
             elems: [],
@@ -386,7 +386,7 @@ window.initSearch = function(rawSearchIndex) {
             literalSearch: false,
             error: null,
         };
-        query.id = val;
+        query.id = userQuery;
         try {
             parseInput(query);
         } catch (err) {
@@ -405,9 +405,9 @@ window.initSearch = function(rawSearchIndex) {
         if (query.elemName !== null) {
             query.foundElems += 1;
         }
-        if (query.foundElems === 0 && val.length !== 0) {
+        if (query.foundElems === 0 && userQuery.length !== 0) {
             // In this case, we'll simply keep whatever was entered by the user...
-            createQueryElement(query, query.elems, val, []);
+            createQueryElement(query, query.elems, userQuery, []);
             query.foundElems += 1;
         }
         if (query.typeFilter !== null) {
@@ -422,8 +422,8 @@ window.initSearch = function(rawSearchIndex) {
             query.elemName = null;
         }
         if (query.elemName !== null || query.elems.length === 1) {
-            val = query.elemName || query.elems[0];
-            query.nameSplit = typeof val.path === "undefined" ? null : val.path;
+            userQuery = query.elemName || query.elems[0];
+            query.nameSplit = typeof userQuery.path === "undefined" ? null : userQuery.path;
         }
         return query;
     }
@@ -493,7 +493,7 @@ window.initSearch = function(rawSearchIndex) {
 
         function sortResults(results, isType) {
             var nameSplit = queryInfo.nameSplit;
-            var query = queryInfo.val;
+            var query = queryInfo.userQuery;
             var ar = [];
             for (var entry in results) {
                 if (hasOwnPropertyRustdoc(results, entry)) {
@@ -1344,7 +1344,7 @@ window.initSearch = function(rawSearchIndex) {
             output.className = "search-failed" + extraClass;
             output.innerHTML = "No results :(<br/>" +
                 "Try on <a href=\"https://duckduckgo.com/?q=" +
-                encodeURIComponent("rust " + query.val) +
+                encodeURIComponent("rust " + query.userQuery) +
                 "\">DuckDuckGo</a>?<br/><br/>" +
                 "Or try looking in one of these:<ul><li>The <a " +
                 "href=\"https://doc.rust-lang.org/reference/index.html\">Rust Reference</a> " +
@@ -1424,7 +1424,7 @@ window.initSearch = function(rawSearchIndex) {
         }
 
         var output = `<div id="search-settings">` +
-            `<h1 class="search-results-title">Results for ${escape(results.query.val)}$` +
+            `<h1 class="search-results-title">Results for ${escape(results.query.userQuery)}` +
             `${typeFilter}</h1> in ${crates} </div>` +
             `<div id="titles">` +
             makeTabHeader(0, "In Names", ret_others[1]) +
diff --git a/src/test/rustdoc-js-std/parser-errors.js b/src/test/rustdoc-js-std/parser-errors.js
index 98be691e0e7..b789fd05d7c 100644
--- a/src/test/rustdoc-js-std/parser-errors.js
+++ b/src/test/rustdoc-js-std/parser-errors.js
@@ -11,7 +11,7 @@ const PARSED = [
         original: "<\"P\">",
         returned: [],
         typeFilter: null,
-        val: "<\"p\">",
+        userQuery: "<\"p\">",
         error: "`\"` cannot be used in generics",
     },
     {
@@ -24,7 +24,7 @@ const PARSED = [
         original: "\"P\" \"P\"",
         returned: [],
         typeFilter: null,
-        val: "\"p\" \"p\"",
+        userQuery: "\"p\" \"p\"",
         error: "Cannot have more than one literal search element",
     },
     {
@@ -37,7 +37,7 @@ const PARSED = [
         original: "P \"P\"",
         returned: [],
         typeFilter: null,
-        val: "p \"p\"",
+        userQuery: "p \"p\"",
         error: "Cannot use literal search when there is more than one element",
     },
 ];
diff --git a/src/test/rustdoc-js-std/parser-filter.js b/src/test/rustdoc-js-std/parser-filter.js
index ba119af816a..60eb8aa92b2 100644
--- a/src/test/rustdoc-js-std/parser-filter.js
+++ b/src/test/rustdoc-js-std/parser-filter.js
@@ -17,7 +17,7 @@ const PARSED = [
         original: "fn:foo",
         returned: [],
         typeFilter: 5,
-        val: "fn:foo",
+        userQuery: "fn:foo",
         error: null,
     },
     {
@@ -36,7 +36,7 @@ const PARSED = [
         original: "enum : foo",
         returned: [],
         typeFilter: 4,
-        val: "enum : foo",
+        userQuery: "enum : foo",
         error: null,
     },
     {
@@ -55,7 +55,7 @@ const PARSED = [
         original: "macro<f>:foo",
         returned: [],
         typeFilter: 14,
-        val: "macro<f>:foo",
+        userQuery: "macro<f>:foo",
         error: null,
     },
 ];
diff --git a/src/test/rustdoc-js-std/parser-generics.js b/src/test/rustdoc-js-std/parser-generics.js
index 4ad65d0d644..d21adf767de 100644
--- a/src/test/rustdoc-js-std/parser-generics.js
+++ b/src/test/rustdoc-js-std/parser-generics.js
@@ -25,7 +25,7 @@ const PARSED = [
         original: "<P>",
         returned: [],
         typeFilter: -1,
-        val: "<p>",
+        userQuery: "<p>",
         error: null,
     },
     {
@@ -75,7 +75,7 @@ const PARSED = [
         original: 'A<B<C<D>, E>',
         returned: [],
         typeFilter: -1,
-        val: 'a<b<c<d>, e>',
+        userQuery: 'a<b<c<d>, e>',
         error: null,
     }
 ];
diff --git a/src/test/rustdoc-js-std/parser-in_args.js b/src/test/rustdoc-js-std/parser-in_args.js
index 6542319458f..88761771d9d 100644
--- a/src/test/rustdoc-js-std/parser-in_args.js
+++ b/src/test/rustdoc-js-std/parser-in_args.js
@@ -17,7 +17,7 @@ const PARSED = [
         original: "(whatever)",
         returned: [],
         typeFilter: -1,
-        val: "(whatever)",
+        userQuery: "(whatever)",
         error: null,
     },
     {
@@ -44,7 +44,7 @@ const PARSED = [
         original: "(<P>)",
         returned: [],
         typeFilter: -1,
-        val: "(<p>)",
+        userQuery: "(<p>)",
         error: null,
     },
 ];
diff --git a/src/test/rustdoc-js-std/parser-invalid.js b/src/test/rustdoc-js-std/parser-invalid.js
index a94792b0694..b5d96e9f507 100644
--- a/src/test/rustdoc-js-std/parser-invalid.js
+++ b/src/test/rustdoc-js-std/parser-invalid.js
@@ -37,7 +37,7 @@ const PARSED = [
             },
         ],
         typeFilter: -1,
-        val: "-> <p> (p2)",
+        userQuery: "-> <p> (p2)",
         error: null,
     },
     {
@@ -65,7 +65,7 @@ const PARSED = [
         original: "(p -> p2",
         returned: [],
         typeFilter: -1,
-        val: "(p -> p2",
+        userQuery: "(p -> p2",
         error: null,
     },
     {
@@ -86,7 +86,7 @@ const PARSED = [
         original: "a b",
         returned: [],
         typeFilter: -1,
-        val: "a b",
+        userQuery: "a b",
         error: null,
     },
     {
@@ -122,7 +122,7 @@ const PARSED = [
         original: "a,b(c)",
         returned: [],
         typeFilter: -1,
-        val: "a,b(c)",
+        userQuery: "a,b(c)",
         error: null,
     },
 ];
diff --git a/src/test/rustdoc-js-std/parser-literal.js b/src/test/rustdoc-js-std/parser-literal.js
index 0624930f14a..1a70bafbf5e 100644
--- a/src/test/rustdoc-js-std/parser-literal.js
+++ b/src/test/rustdoc-js-std/parser-literal.js
@@ -25,7 +25,7 @@ const PARSED = [
         original: "\"R\"<P>",
         returned: [],
         typeFilter: -1,
-        val: "\"r\"<p>",
+        userQuery: "\"r\"<p>",
         error: null,
     }
 ];
diff --git a/src/test/rustdoc-js-std/parser-paths.js b/src/test/rustdoc-js-std/parser-paths.js
index 9422eada9bc..980a396ba7f 100644
--- a/src/test/rustdoc-js-std/parser-paths.js
+++ b/src/test/rustdoc-js-std/parser-paths.js
@@ -17,7 +17,7 @@ const PARSED = [
         original: "A::B",
         returned: [],
         typeFilter: -1,
-        val: "a::b",
+        userQuery: "a::b",
         error: null,
     },
     {
@@ -36,7 +36,7 @@ const PARSED = [
         original: '::A::B',
         returned: [],
         typeFilter: -1,
-        val: '::a::b',
+        userQuery: '::a::b',
         error: null,
     },
     {
@@ -64,7 +64,7 @@ const PARSED = [
         original: 'A::B::,C',
         returned: [],
         typeFilter: -1,
-        val: 'a::b::,c',
+        userQuery: 'a::b::,c',
         error: null,
     },
     {
@@ -100,7 +100,7 @@ const PARSED = [
         original: 'A::B::<f>,C',
         returned: [],
         typeFilter: -1,
-        val: 'a::b::<f>,c',
+        userQuery: 'a::b::<f>,c',
         error: null,
     },
 ];
diff --git a/src/test/rustdoc-js-std/parser-quote.js b/src/test/rustdoc-js-std/parser-quote.js
index de7b004159f..aa1b8d3dc64 100644
--- a/src/test/rustdoc-js-std/parser-quote.js
+++ b/src/test/rustdoc-js-std/parser-quote.js
@@ -17,7 +17,7 @@ const PARSED = [
             generics: [],
         }],
         typeFilter: -1,
-        val: "-> \"p\"",
+        userQuery: "-> \"p\"",
         error: null,
     },
     // This one checks that if quotes are used on the type filter, they're
@@ -38,7 +38,7 @@ const PARSED = [
         original: "\"const\": \"p\"",
         returned: [],
         typeFilter: 17,
-        val: "\"const\": \"p\"",
+        userQuery: "\"const\": \"p\"",
         error: null,
     },
     {
@@ -57,7 +57,7 @@ const PARSED = [
         original: "(\"p\")",
         returned: [],
         typeFilter: -1,
-        val: "(\"p\")",
+        userQuery: "(\"p\")",
         error: null,
     },
     // This test checks that a literal item can still have generics.
@@ -83,7 +83,7 @@ const PARSED = [
         original: "\"p\"<p>",
         returned: [],
         typeFilter: -1,
-        val: "\"p\"<p>",
+        userQuery: "\"p\"<p>",
         error: null,
     },
 ];
diff --git a/src/test/rustdoc-js-std/parser-returned.js b/src/test/rustdoc-js-std/parser-returned.js
index 92b378f1393..ceecda67050 100644
--- a/src/test/rustdoc-js-std/parser-returned.js
+++ b/src/test/rustdoc-js-std/parser-returned.js
@@ -25,7 +25,7 @@ const PARSED = [
             ],
         }],
         typeFilter: -1,
-        val: "-> <p>",
+        userQuery: "-> <p>",
         error: null,
     },
     {
@@ -44,7 +44,7 @@ const PARSED = [
             generics: [],
         }],
         typeFilter: -1,
-        val: "-> p",
+        userQuery: "-> p",
         error: null,
     },
 ];
diff --git a/src/tools/rustdoc-js/tester.js b/src/tools/rustdoc-js/tester.js
index 207ddc944de..5b051523cea 100644
--- a/src/tools/rustdoc-js/tester.js
+++ b/src/tools/rustdoc-js/tester.js
@@ -296,7 +296,7 @@ function checkFieldNeededFields(fullPath, expected, error_text, queryName, posit
             "original",
             "returned",
             "typeFilter",
-            "val",
+            "userQuery",
             "error",
         ];
     } else if (fullPath.endsWith("elems") || fullPath.endsWith("generics")) {