Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Add crate filtering
  • Loading branch information
GuillaumeGomez committed Nov 28, 2018
1 parent b76ee83 commit dd717de
Show file tree
Hide file tree
Showing 6 changed files with 131 additions and 26 deletions.
15 changes: 10 additions & 5 deletions src/librustdoc/html/layout.rs
Expand Up @@ -81,11 +81,16 @@ pub fn render<T: fmt::Display, S: fmt::Display>(
<nav class=\"sub\">\
<form class=\"search-form js-only\">\
<div class=\"search-container\">\
<input class=\"search-input\" name=\"search\" \
autocomplete=\"off\" \
spellcheck=\"false\" \
placeholder=\"Click or press ‘S’ to search, ‘?’ for more options…\" \
type=\"search\">\
<div>\
<select id=\"crate-search\">\
<option value=\"All crates\">All crates</option>\
</select>\
<input class=\"search-input\" name=\"search\" \
autocomplete=\"off\" \
spellcheck=\"false\" \
placeholder=\"Click or press ‘S’ to search, ‘?’ for more options…\" \
type=\"search\">\
</div>\
<a id=\"settings-menu\" href=\"{root_path}settings.html\">\
<img src=\"{root_path}wheel{suffix}.svg\" width=\"18\" alt=\"Change settings\">\
</a>\
Expand Down
2 changes: 1 addition & 1 deletion src/librustdoc/html/render.rs
Expand Up @@ -983,7 +983,7 @@ themePicker.onblur = handleThemeButtonsBlur;
&[(minifier::js::Keyword::Null, "N")]),
&dst);
}
try_err!(writeln!(&mut w, "initSearch(searchIndex);"), &dst);
try_err!(writeln!(&mut w, "initSearch(searchIndex);addSearchOptions(searchIndex);"), &dst);

if options.enable_index_page {
if let Some(index_page) = options.index_page.clone() {
Expand Down
99 changes: 83 additions & 16 deletions src/librustdoc/html/static/main.js
Expand Up @@ -254,12 +254,14 @@
//
// So I guess you could say things are getting pretty interoperable.
function getVirtualKey(ev) {
if ("key" in ev && typeof ev.key != "undefined")
if ("key" in ev && typeof ev.key != "undefined") {
return ev.key;
}

var c = ev.charCode || ev.keyCode;
if (c == 27)
if (c == 27) {
return "Escape";
}
return String.fromCharCode(c);
}

Expand Down Expand Up @@ -467,12 +469,13 @@

/**
* Executes the query and builds an index of results
* @param {[Object]} query [The user query]
* @param {[type]} searchWords [The list of search words to query
* against]
* @return {[type]} [A search index of results]
* @param {[Object]} query [The user query]
* @param {[type]} searchWords [The list of search words to query
* against]
* @param {[type]} filterCrates [Crate to search in if defined]
* @return {[type]} [A search index of results]
*/
function execQuery(query, searchWords) {
function execQuery(query, searchWords, filterCrates) {
function itemTypeFromName(typename) {
for (var i = 0; i < itemTypes.length; ++i) {
if (itemTypes[i] === typename) {
Expand Down Expand Up @@ -848,6 +851,9 @@
{
val = extractGenerics(val.substr(1, val.length - 2));
for (var i = 0; i < nSearchWords; ++i) {
if (filterCrates !== undefined && searchIndex[i].crate !== filterCrates) {
continue;
}
var in_args = findArg(searchIndex[i], val, true);
var returned = checkReturned(searchIndex[i], val, true);
var ty = searchIndex[i];
Expand Down Expand Up @@ -902,6 +908,9 @@
var output = extractGenerics(parts[1]);

for (var i = 0; i < nSearchWords; ++i) {
if (filterCrates !== undefined && searchIndex[i].crate !== filterCrates) {
continue;
}
var type = searchIndex[i].type;
var ty = searchIndex[i];
if (!type) {
Expand Down Expand Up @@ -973,11 +982,11 @@
var contains = paths.slice(0, paths.length > 1 ? paths.length - 1 : 1);

for (j = 0; j < nSearchWords; ++j) {
var lev_distance;
var ty = searchIndex[j];
if (!ty) {
if (!ty || (filterCrates !== undefined && ty.crate !== filterCrates)) {
continue;
}
var lev_distance;
var lev_add = 0;
if (paths.length > 1) {
var lev = checkPath(contains, paths[paths.length - 1], ty);
Expand Down Expand Up @@ -1353,7 +1362,7 @@
return '<div>' + text + ' <div class="count">(' + nbElems + ')</div></div>';
}

function showResults(results) {
function showResults(results, filterCrates) {
if (results['others'].length === 1 &&
getCurrentValue('rustdoc-go-to-only-result') === "true") {
var elem = document.createElement('a');
Expand All @@ -1371,8 +1380,13 @@
var ret_in_args = addTab(results['in_args'], query, false);
var ret_returned = addTab(results['returned'], query, false);

var filter = "";
if (filterCrates !== undefined) {
filter = " (in <b>" + filterCrates + "</b> crate)";
}

var output = '<h1>Results for ' + escape(query.query) +
(query.type ? ' (type: ' + escape(query.type) + ')' : '') + '</h1>' +
(query.type ? ' (type: ' + escape(query.type) + ')' : '') + filter + '</h1>' +
'<div id="titles">' +
makeTabHeader(0, "In Names", ret_others[1]) +
makeTabHeader(1, "In Parameters", ret_in_args[1]) +
Expand Down Expand Up @@ -1401,7 +1415,7 @@
printTab(currentTab);
}

function execSearch(query, searchWords) {
function execSearch(query, searchWords, filterCrates) {
var queries = query.raw.split(",");
var results = {
'in_args': [],
Expand All @@ -1412,7 +1426,7 @@
for (var i = 0; i < queries.length; ++i) {
var query = queries[i].trim();
if (query.length !== 0) {
var tmp = execQuery(getQuery(query), searchWords);
var tmp = execQuery(getQuery(query), searchWords, filterCrates);

results['in_args'].push(tmp['in_args']);
results['returned'].push(tmp['returned']);
Expand Down Expand Up @@ -1474,15 +1488,27 @@
}
}

function search(e) {
function getFilterCrates() {
var elem = document.getElementById("crate-search");

if (elem && elem.value !== "All crates" && rawSearchIndex.hasOwnProperty(elem.value)) {
return elem.value;
}
return undefined;
}

function search(e, forced) {
var params = getQueryStringParams();
var query = getQuery(search_input.value.trim());

if (e) {
e.preventDefault();
}

if (query.query.length === 0 || query.id === currentResults) {
if (query.query.length === 0) {
return;
}
if (forced !== true && query.id === currentResults) {
if (query.query.length > 0) {
putBackSearch(search_input);
}
Expand All @@ -1502,7 +1528,8 @@
}
}

showResults(execSearch(query, index));
var filterCrates = getFilterCrates();
showResults(execSearch(query, index, filterCrates), filterCrates);
}

function buildIndex(rawSearchIndex) {
Expand Down Expand Up @@ -1602,6 +1629,13 @@
};
search_input.onpaste = search_input.onchange;

var selectCrate = document.getElementById('crate-search');
if (selectCrate) {
selectCrate.onchange = function() {
search(undefined, true);
};
}

// Push and pop states are used to add search results to the browser
// history.
if (browserSupportsHistoryApi()) {
Expand Down Expand Up @@ -2350,6 +2384,39 @@
if (window.location.hash && window.location.hash.length > 0) {
expandSection(window.location.hash.replace(/^#/, ''));
}

function addSearchOptions(crates) {
var elem = document.getElementById('crate-search');

if (!elem) {
return;
}
var crates_text = [];
for (var crate in crates) {
if (crates.hasOwnProperty(crate)) {
crates_text.push(crate);
}
}
crates_text.sort(function(a, b) {
var lower_a = a.toLowerCase();
var lower_b = b.toLowerCase();

if (lower_a < lower_b) {
return -1;
} else if (lower_a > lower_b) {
return 1;
}
return 0;
});
for (var i = 0; i < crates_text.length; ++i) {
var option = document.createElement("option");
option.value = crates_text[i];
option.innerText = crates_text[i];
elem.appendChild(option);
}
}

window.addSearchOptions = addSearchOptions;
}());

// Sets the focus on the search bar at the top of the page
Expand Down
24 changes: 22 additions & 2 deletions src/librustdoc/html/static/rustdoc.css
Expand Up @@ -614,27 +614,47 @@ a {
.search-container {
position: relative;
}
.search-container > div {
display: inline-flex;
width: calc(100% - 34px);
}
#crate-search {
margin-top: 5px;
padding: 6px;
padding-right: 12px;
border: 0;
border-right: 0;
border-radius: 4px 0 0 4px;
outline: none;
cursor: pointer;
border-right: 1px solid;
-moz-appearance: none;
-webkit-appearance: none;
/* Removes default arrow from firefox */
text-indent: 0.01px;
text-overflow: "";
}
.search-container > .top-button {
position: absolute;
right: 0;
top: 10px;
}
.search-input {
width: calc(100% - 34px);
/* Override Normalize.css: we have margins and do
not want to overflow - the `moz` attribute is necessary
until Firefox 29, too early to drop at this point */
-moz-box-sizing: border-box !important;
box-sizing: border-box !important;
outline: none;
border: none;
border-radius: 1px;
border-radius: 0 1px 1px 0;
margin-top: 5px;
padding: 10px 16px;
font-size: 17px;
transition: border-color 300ms ease;
transition: border-radius 300ms ease-in-out;
transition: box-shadow 300ms ease-in-out;
width: 100%;
}

.search-input:focus {
Expand Down
8 changes: 7 additions & 1 deletion src/librustdoc/html/static/themes/dark.css
Expand Up @@ -182,9 +182,15 @@ a.test-arrow {
color: #999;
}

#crate-search {
color: #111;
background-color: #f0f0f0;
border-color: #000;
}

.search-input {
color: #111;
box-shadow: 0 0 0 1px #000, 0 0 0 2px transparent;
box-shadow: 1px 0 0 1px #000, 0 0 0 2px transparent;
background-color: #f0f0f0;
}

Expand Down
9 changes: 8 additions & 1 deletion src/librustdoc/html/static/themes/light.css
Expand Up @@ -182,9 +182,16 @@ a.test-arrow {
color: #999;
}

#crate-search {
color: #555;
background-color: white;
border-color: #e0e0e0;
box-shadow: 0px 0 0 1px #e0e0e0, 0 0 0 2px transparent;
}

.search-input {
color: #555;
box-shadow: 0 0 0 1px #e0e0e0, 0 0 0 2px transparent;
box-shadow: 1px 0 0 1px #e0e0e0, 0 0 0 2px transparent;
background-color: white;
}

Expand Down

0 comments on commit dd717de

Please sign in to comment.