Auto merge of #49757 - GuillaumeGomez:never-search, r=QuietMisdreavus
Add specific never search Fixes #49529. r? @QuietMisdreavus
This commit is contained in:
commit
bbdd1cf744
22 changed files with 293 additions and 11 deletions
|
|
@ -19,7 +19,7 @@ use clean;
|
|||
/// discriminants. JavaScript then is used to decode them into the original value.
|
||||
/// Consequently, every change to this type should be synchronized to
|
||||
/// the `itemTypes` mapping table in `static/main.js`.
|
||||
#[derive(Copy, PartialEq, Clone)]
|
||||
#[derive(Copy, PartialEq, Clone, Debug)]
|
||||
pub enum ItemType {
|
||||
Module = 0,
|
||||
ExternCrate = 1,
|
||||
|
|
|
|||
|
|
@ -145,6 +145,7 @@ pub fn render<T: fmt::Display, S: fmt::Display>(
|
|||
</script>\
|
||||
<script src=\"{root_path}main{suffix}.js\"></script>\
|
||||
<script defer src=\"{root_path}search-index.js\"></script>\
|
||||
<script defer src=\"{root_path}aliases.js\"></script>\
|
||||
</body>\
|
||||
</html>",
|
||||
css_extension = if css_file_extension {
|
||||
|
|
|
|||
|
|
@ -329,6 +329,10 @@ pub struct Cache {
|
|||
// yet when its implementation methods are being indexed. Caches such methods
|
||||
// and their parent id here and indexes them at the end of crate parsing.
|
||||
orphan_impl_items: Vec<(DefId, clean::Item)>,
|
||||
|
||||
/// Aliases added through `#[doc(alias = "...")]`. Since a few items can have the same alias,
|
||||
/// we need the alias element to have an array of items.
|
||||
aliases: FxHashMap<String, Vec<IndexItem>>,
|
||||
}
|
||||
|
||||
/// Temporary storage for data obtained during `RustdocVisitor::clean()`.
|
||||
|
|
@ -369,6 +373,7 @@ struct Sidebar<'a> { cx: &'a Context, item: &'a clean::Item, }
|
|||
|
||||
/// Struct representing one entry in the JS search index. These are all emitted
|
||||
/// by hand to a large JS file at the end of cache-creation.
|
||||
#[derive(Debug)]
|
||||
struct IndexItem {
|
||||
ty: ItemType,
|
||||
name: String,
|
||||
|
|
@ -396,6 +401,7 @@ impl ToJson for IndexItem {
|
|||
}
|
||||
|
||||
/// A type used for the search index.
|
||||
#[derive(Debug)]
|
||||
struct Type {
|
||||
name: Option<String>,
|
||||
generics: Option<Vec<String>>,
|
||||
|
|
@ -418,9 +424,10 @@ impl ToJson for Type {
|
|||
}
|
||||
|
||||
/// Full type of functions/methods in the search index.
|
||||
#[derive(Debug)]
|
||||
struct IndexItemFunctionType {
|
||||
inputs: Vec<Type>,
|
||||
output: Option<Type>
|
||||
output: Option<Type>,
|
||||
}
|
||||
|
||||
impl ToJson for IndexItemFunctionType {
|
||||
|
|
@ -609,6 +616,7 @@ pub fn run(mut krate: clean::Crate,
|
|||
owned_box_did,
|
||||
masked_crates: mem::replace(&mut krate.masked_crates, FxHashSet()),
|
||||
typarams: external_typarams,
|
||||
aliases: FxHashMap(),
|
||||
};
|
||||
|
||||
// Cache where all our extern crates are located
|
||||
|
|
@ -847,8 +855,7 @@ themePicker.onclick = function() {{
|
|||
write(cx.dst.join("COPYRIGHT.txt"),
|
||||
include_bytes!("static/COPYRIGHT.txt"))?;
|
||||
|
||||
fn collect(path: &Path, krate: &str,
|
||||
key: &str) -> io::Result<Vec<String>> {
|
||||
fn collect(path: &Path, krate: &str, key: &str) -> io::Result<Vec<String>> {
|
||||
let mut ret = Vec::new();
|
||||
if path.exists() {
|
||||
for line in BufReader::new(File::open(path)?).lines() {
|
||||
|
|
@ -865,6 +872,40 @@ themePicker.onclick = function() {{
|
|||
Ok(ret)
|
||||
}
|
||||
|
||||
fn show_item(item: &IndexItem, krate: &str) -> String {
|
||||
format!("{{'crate':'{}','ty':{},'name':'{}','path':'{}'{}}}",
|
||||
krate, item.ty as usize, item.name, item.path,
|
||||
if let Some(p) = item.parent_idx {
|
||||
format!(",'parent':{}", p)
|
||||
} else {
|
||||
String::new()
|
||||
})
|
||||
}
|
||||
|
||||
let dst = cx.dst.join("aliases.js");
|
||||
{
|
||||
let mut all_aliases = try_err!(collect(&dst, &krate.name, "ALIASES"), &dst);
|
||||
let mut w = try_err!(File::create(&dst), &dst);
|
||||
let mut output = String::with_capacity(100);
|
||||
for (alias, items) in &cache.aliases {
|
||||
if items.is_empty() {
|
||||
continue
|
||||
}
|
||||
output.push_str(&format!("\"{}\":[{}],",
|
||||
alias,
|
||||
items.iter()
|
||||
.map(|v| show_item(v, &krate.name))
|
||||
.collect::<Vec<_>>()
|
||||
.join(",")));
|
||||
}
|
||||
all_aliases.push(format!("ALIASES['{}'] = {{{}}};", krate.name, output));
|
||||
all_aliases.sort();
|
||||
try_err!(writeln!(&mut w, "var ALIASES = {{}};"), &dst);
|
||||
for aliases in &all_aliases {
|
||||
try_err!(writeln!(&mut w, "{}", aliases), &dst);
|
||||
}
|
||||
}
|
||||
|
||||
// Update the search index
|
||||
let dst = cx.dst.join("search-index.js");
|
||||
let mut all_indexes = try_err!(collect(&dst, &krate.name, "searchIndex"), &dst);
|
||||
|
|
@ -1251,13 +1292,13 @@ impl DocFolder for Cache {
|
|||
// `public_items` map, so we can skip inserting into the
|
||||
// paths map if there was already an entry present and we're
|
||||
// not a public item.
|
||||
if
|
||||
!self.paths.contains_key(&item.def_id) ||
|
||||
self.access_levels.is_public(item.def_id)
|
||||
if !self.paths.contains_key(&item.def_id) ||
|
||||
self.access_levels.is_public(item.def_id)
|
||||
{
|
||||
self.paths.insert(item.def_id,
|
||||
(self.stack.clone(), item.type_()));
|
||||
}
|
||||
self.add_aliases(&item);
|
||||
}
|
||||
// Link variants to their parent enum because pages aren't emitted
|
||||
// for each variant.
|
||||
|
|
@ -1268,6 +1309,7 @@ impl DocFolder for Cache {
|
|||
}
|
||||
|
||||
clean::PrimitiveItem(..) if item.visibility.is_some() => {
|
||||
self.add_aliases(&item);
|
||||
self.paths.insert(item.def_id, (self.stack.clone(),
|
||||
item.type_()));
|
||||
}
|
||||
|
|
@ -1372,6 +1414,36 @@ impl<'a> Cache {
|
|||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn add_aliases(&mut self, item: &clean::Item) {
|
||||
if item.def_id.index == CRATE_DEF_INDEX {
|
||||
return
|
||||
}
|
||||
if let Some(ref item_name) = item.name {
|
||||
let path = self.paths.get(&item.def_id)
|
||||
.map(|p| p.0.join("::").to_string())
|
||||
.unwrap_or("std".to_owned());
|
||||
for alias in item.attrs.lists("doc")
|
||||
.filter(|a| a.check_name("alias"))
|
||||
.filter_map(|a| a.value_str()
|
||||
.map(|s| s.to_string().replace("\"", "")))
|
||||
.filter(|v| !v.is_empty())
|
||||
.collect::<FxHashSet<_>>()
|
||||
.into_iter() {
|
||||
self.aliases.entry(alias)
|
||||
.or_insert(Vec::with_capacity(1))
|
||||
.push(IndexItem {
|
||||
ty: item.type_(),
|
||||
name: item_name.to_string(),
|
||||
path: path.clone(),
|
||||
desc: String::new(),
|
||||
parent: None,
|
||||
parent_idx: None,
|
||||
search_type: get_index_search_type(&item),
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Eq, PartialEq, Hash)]
|
||||
|
|
|
|||
|
|
@ -1012,11 +1012,21 @@
|
|||
}
|
||||
}
|
||||
|
||||
return {
|
||||
var ret = {
|
||||
'in_args': sortResults(results_in_args, true),
|
||||
'returned': sortResults(results_returned, true),
|
||||
'others': sortResults(results),
|
||||
};
|
||||
if (ALIASES[window.currentCrate][query.raw]) {
|
||||
var aliases = ALIASES[window.currentCrate][query.raw];
|
||||
for (var i = 0; i < aliases.length; ++i) {
|
||||
ret['others'].unshift(aliases[i]);
|
||||
if (ret['others'].length > MAX_RESULTS) {
|
||||
ret['others'].pop();
|
||||
}
|
||||
}
|
||||
}
|
||||
return ret;
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -1197,11 +1207,13 @@
|
|||
array.forEach(function(item) {
|
||||
var name, type, href, displayPath;
|
||||
|
||||
if (shown.indexOf(item) !== -1) {
|
||||
var id_ty = item.ty + item.path + item.name;
|
||||
if (shown.indexOf(id_ty) !== -1) {
|
||||
return;
|
||||
}
|
||||
|
||||
shown.push(item);
|
||||
console.log(item);
|
||||
shown.push(id_ty);
|
||||
name = item.name;
|
||||
type = itemTypes[item.ty];
|
||||
|
||||
|
|
@ -1369,7 +1381,7 @@
|
|||
|
||||
function search(e) {
|
||||
var params = getQueryStringParams();
|
||||
var query = getQuery(document.getElementsByClassName('search-input')[0].value);
|
||||
var query = getQuery(document.getElementsByClassName('search-input')[0].value.trim());
|
||||
|
||||
if (e) {
|
||||
e.preventDefault();
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue