rustdoc-search: pass original names through AST

Author: notriddle

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

@@ -276,7 +276,7 @@ function getFilteredNextElem(query, parserState, elems, isInGenerics) {
 // The type filter doesn't count as an element since it's a modifier.
 consttypeFilterElem=elems.pop();
 checkExtraTypeFilterCharacters(start,parserState);
-parserState.typeFilter=typeFilterElem.name;
+parserState.typeFilter=typeFilterElem.normalizedPathLast;
 parserState.pos+=1;
 parserState.totalElems-=1;
 query.literalSearch=false;
@@ -686,7 +686,7 @@ function createQueryElement(query, parserState, name, generics, isInGenerics) {
 }elseif(quadcolon!==null){
 throw["Unexpected ",quadcolon[0]];
 }
-constpathSegments=path.split(/(?:::\s*)|(?:\s+(?:::\s*)?)/);
+constpathSegments=path.split(/(?:::\s*)|(?:\s+(?:::\s*)?)/).map(x=>x.toLowerCase());
 // In case we only have something like `<p>`, there is no name.
 if(pathSegments.length===0
 ||(pathSegments.length===1&&pathSegments[0]==="")){
@@ -726,7 +726,10 @@ function createQueryElement(query, parserState, name, generics, isInGenerics) {
 if(gen.name!==null){
 gen.bindingName.generics.unshift(gen);
 }
-bindings.set(gen.bindingName.name,gen.bindingName.generics);
+bindings.set(
+gen.bindingName.name.toLowerCase().replace(/_/g,""),
+gen.bindingName.generics,
+);
 returnfalse;
 }
 returntrue;
@@ -1786,8 +1789,7 @@ class DocSearch {
  */
 functionnewParsedQuery(userQuery){
 return{
-original: userQuery,
-userQuery: userQuery.toLowerCase(),
+ userQuery,
 elems: [],
 returned: [],
 // Total number of "top" elements (does not include generics).
@@ -1909,7 +1911,7 @@ class DocSearch {
 genericsElems: 0,
 typeFilter: null,
 isInBinding: null,
-userQuery: userQuery.toLowerCase(),
+ userQuery,
 };
 letquery=newParsedQuery(userQuery);
 
@@ -2097,7 +2099,7 @@ class DocSearch {
  */
 constsortResults=async(results,isType,preferredCrate)=>{
 constuserQuery=parsedQuery.userQuery;
-constcasedUserQuery=parsedQuery.original;
+constnormalizedUserQuery=parsedQuery.userQuery.toLowerCase();
 constresult_list=[];
 for(constresultofresults.values()){
 result.item=this.searchIndex[result.id];
@@ -2109,15 +2111,15 @@ class DocSearch {
 leta,b;
 
 // sort by exact case-sensitive match
-a=(aaa.item.name!==casedUserQuery);
-b=(bbb.item.name!==casedUserQuery);
+a=(aaa.item.name!==userQuery);
+b=(bbb.item.name!==userQuery);
 if(a!==b){
 returna-b;
 }
 
 // sort by exact match with regard to the last word (mismatch goes later)
-a=(aaa.word!==userQuery);
-b=(bbb.word!==userQuery);
+a=(aaa.word!==normalizedUserQuery);
+b=(bbb.word!==normalizedUserQuery);
 if(a!==b){
 returna-b;
 }
@@ -3163,21 +3165,25 @@ class DocSearch {
 if((elem.id===null&&parsedQuery.totalElems>1&&elem.typeFilter===-1
 &&elem.generics.length===0&&elem.bindings.size===0)
 ||elem.typeFilter===TY_GENERIC){
-if(genericSymbols.has(elem.name)){
-elem.id=genericSymbols.get(elem.name);
+if(genericSymbols.has(elem.normalizedPathLast)){
+elem.id=genericSymbols.get(elem.normalizedPathLast);
 }else{
 elem.id=-(genericSymbols.size+1);
-genericSymbols.set(elem.name,elem.id);
+genericSymbols.set(elem.normalizedPathLast,elem.id);
 }
-if(elem.typeFilter===-1&&elem.name.length>=3){
+if(elem.typeFilter===-1&&elem.normalizedPathLast.length>=3){
 // Silly heuristic to catch if the user probably meant
 // to not write a generic parameter. We don't use it,
 // just bring it up.
-constmaxPartDistance=Math.floor(elem.name.length/3);
+constmaxPartDistance=Math.floor(elem.normalizedPathLast.length/3);
 letmatchDist=maxPartDistance+1;
 letmatchName="";
 for(constnameofthis.typeNameIdMap.keys()){
-constdist=editDistance(name,elem.name,maxPartDistance);
+constdist=editDistance(
+name,
+elem.normalizedPathLast,
+maxPartDistance,
+);
 if(dist<=matchDist&&dist<=maxPartDistance){
 if(dist===matchDist&&matchName>name){
 continue;
@@ -3289,7 +3295,7 @@ class DocSearch {
 sorted_returned,
 sorted_others,
 parsedQuery);
-awaithandleAliases(ret,parsedQuery.original.replace(/"/g,""),
+awaithandleAliases(ret,parsedQuery.userQuery.replace(/"/g,""),
 filterCrates,currentCrate);
 awaitPromise.all([ret.others,ret.returned,ret.in_args].map(asynclist=>{
 constdescs=awaitPromise.all(list.map(result=>{
@@ -3709,11 +3715,11 @@ async function search(forced) {
 }
 
 // Update document title to maintain a meaningful browser history
-searchState.title="\""+query.original+"\" Search - Rust";
+searchState.title="\""+query.userQuery+"\" Search - Rust";
 
 // Because searching is incremental by character, only the most
 // recent search query is added to the browser history.
-updateSearchHistory(buildUrl(query.original,filterCrates));
+updateSearchHistory(buildUrl(query.userQuery,filterCrates));
 
 awaitshowResults(
 awaitdocSearch.execQuery(query,filterCrates,window.currentCrate),

src/tools/rustdoc-js/tester.js

@@ -84,7 +84,6 @@ function checkNeededFields(fullPath, expected, error_text, queryName, position)
 if(fullPath.length===0){
 fieldsToCheck=[
 "foundElems",
-"original",
 "returned",
 "userQuery",
 "error",

tests/rustdoc-gui/search-corrections.goml

@@ -24,7 +24,7 @@ assert-css: (".search-corrections", {
 })
 assert-text: (
  ".search-corrections",
- "Type \"notablestructwithlongnamr\" not found. Showing results for closest type name \"notablestructwithlongname\" instead."
+ "Type \"NotableStructWithLongNamr\" not found. Showing results for closest type name \"notablestructwithlongname\" instead."
 )
 
 // Corrections do get shown on the "In Return Type" tab.
@@ -35,7 +35,7 @@ assert-css: (".search-corrections", {
 })
 assert-text: (
  ".search-corrections",
- "Type \"notablestructwithlongnamr\" not found. Showing results for closest type name \"notablestructwithlongname\" instead."
+ "Type \"NotableStructWithLongNamr\" not found. Showing results for closest type name \"notablestructwithlongname\" instead."
 )
 
 // Now, explicit return values
@@ -52,7 +52,7 @@ assert-css: (".search-corrections", {
 })
 assert-text: (
  ".search-corrections",
- "Type \"notablestructwithlongnamr\" not found. Showing results for closest type name \"notablestructwithlongname\" instead."
+ "Type \"NotableStructWithLongNamr\" not found. Showing results for closest type name \"notablestructwithlongname\" instead."
 )
 
 // Now, generic correction
@@ -69,7 +69,7 @@ assert-css: (".search-corrections", {
 })
 assert-text: (
  ".search-corrections",
- "Type \"notablestructwithlongnamr\" not found and used as generic parameter. Consider searching for \"notablestructwithlongname\" instead."
+ "Type \"NotableStructWithLongNamr\" not found and used as generic parameter. Consider searching for \"notablestructwithlongname\" instead."
 )
 
 // Now, generic correction plus error
@@ -86,7 +86,7 @@ assert-css: (".search-corrections", {
 })
 assert-text: (
  ".search-corrections",
- "Type \"notablestructwithlongnamr\" not found and used as generic parameter. Consider searching for \"notablestructwithlongname\" instead."
+ "Type \"NotableStructWithLongNamr\" not found and used as generic parameter. Consider searching for \"notablestructwithlongname\" instead."
 )
 
 go-to: "file://" + |DOC_PATH| + "/test_docs/index.html"
@@ -102,5 +102,5 @@ assert-css: (".error", {
 })
 assert-text: (
  ".error",
- "Query parser error: \"Generic type parameter notablestructwithlongnamr does not accept generic parameters\"."
+ "Query parser error: \"Generic type parameter NotableStructWithLongNamr does not accept generic parameters\"."
 )

tests/rustdoc-js-std/parser-bindings.js

@@ -3,20 +3,22 @@ const PARSED = [
 query: 'A<B=C>',
 elems: [
 {
-name: "a",
+name: "A",
 fullPath: ["a"],
 pathWithoutLast: [],
 pathLast: "a",
+normalizedPathLast: "a",
 generics: [],
 bindings: [
 [
 'b',
 [
 {
-name: "c",
+name: "C",
 fullPath: ["c"],
 pathWithoutLast: [],
 pathLast: "c",
+normalizedPathLast: "c",
 generics: [],
 typeFilter: -1,
 },
@@ -27,16 +29,15 @@ const PARSED = [
 },
 ],
 foundElems: 1,
-original: 'A<B=C>',
+userQuery: 'A<B=C>',
 returned: [],
-userQuery: 'a<b=c>',
 error: null,
 },
 {
 query: 'A<B = C>',
 elems: [
 {
-name: "a",
+name: "A",
 fullPath: ["a"],
 pathWithoutLast: [],
 pathLast: "a",
@@ -45,7 +46,7 @@ const PARSED = [
 [
 'b',
 [{
-name: "c",
+name: "C",
 fullPath: ["c"],
 pathWithoutLast: [],
 pathLast: "c",
@@ -58,16 +59,15 @@ const PARSED = [
 },
 ],
 foundElems: 1,
-original: 'A<B = C>',
+userQuery: 'A<B = C>',
 returned: [],
-userQuery: 'a<b = c>',
 error: null,
 },
 {
 query: 'A<B=!>',
 elems: [
 {
-name: "a",
+name: "A",
 fullPath: ["a"],
 pathWithoutLast: [],
 pathLast: "a",
@@ -89,16 +89,15 @@ const PARSED = [
 },
 ],
 foundElems: 1,
-original: 'A<B=!>',
+userQuery: 'A<B=!>',
 returned: [],
-userQuery: 'a<b=!>',
 error: null,
 },
 {
 query: 'A<B=[]>',
 elems: [
 {
-name: "a",
+name: "A",
 fullPath: ["a"],
 pathWithoutLast: [],
 pathLast: "a",
@@ -120,16 +119,15 @@ const PARSED = [
 },
 ],
 foundElems: 1,
-original: 'A<B=[]>',
+userQuery: 'A<B=[]>',
 returned: [],
-userQuery: 'a<b=[]>',
 error: null,
 },
 {
 query: 'A<B=[!]>',
 elems: [
 {
-name: "a",
+name: "A",
 fullPath: ["a"],
 pathWithoutLast: [],
 pathLast: "a",
@@ -160,52 +158,47 @@ const PARSED = [
 },
 ],
 foundElems: 1,
-original: 'A<B=[!]>',
+userQuery: 'A<B=[!]>',
 returned: [],
-userQuery: 'a<b=[!]>',
 error: null,
 },
 {
 query: 'A<B=C=>',
 elems: [],
 foundElems: 0,
-original: 'A<B=C=>',
+userQuery: 'A<B=C=>',
 returned: [],
-userQuery: 'a<b=c=>',
 error: "Cannot write `=` twice in a binding",
 },
 {
 query: 'A<B=>',
 elems: [],
 foundElems: 0,
-original: 'A<B=>',
+userQuery: 'A<B=>',
 returned: [],
-userQuery: 'a<b=>',
 error: "Unexpected `>` after `=`",
 },
 {
 query: 'B=C',
 elems: [],
 foundElems: 0,
-original: 'B=C',
+userQuery: 'B=C',
 returned: [],
-userQuery: 'b=c',
 error: "Type parameter `=` must be within generics list",
 },
 {
 query: '[B=C]',
 elems: [],
 foundElems: 0,
-original: '[B=C]',
+userQuery: '[B=C]',
 returned: [],
-userQuery: '[b=c]',
 error: "Type parameter `=` cannot be within slice `[]`",
 },
 {
 query: 'A<B<X>=C>',
 elems: [
 {
-name: "a",
+name: "A",
 fullPath: ["a"],
 pathWithoutLast: [],
 pathLast: "a",
@@ -215,15 +208,15 @@ const PARSED = [
 'b',
 [
 {
-name: "c",
+name: "C",
 fullPath: ["c"],
 pathWithoutLast: [],
 pathLast: "c",
 generics: [],
 typeFilter: -1,
 },
 {
-name: "x",
+name: "X",
 fullPath: ["x"],
 pathWithoutLast: [],
 pathLast: "x",
@@ -237,9 +230,8 @@ const PARSED = [
 },
 ],
 foundElems: 1,
-original: 'A<B<X>=C>',
+userQuery: 'A<B<X>=C>',
 returned: [],
-userQuery: 'a<b<x>=c>',
 error: null,
 },
 ];