rust/crates/hir_def/src/import_map.rs

964 lines
28 KiB
Rust
Raw Normal View History

2020-05-20 16:51:20 -05:00
//! A map of all publicly exported items in a crate.
use std::{cmp::Ordering, fmt, hash::BuildHasherDefault, sync::Arc};
2020-06-05 06:15:16 -05:00
2020-08-13 09:25:38 -05:00
use base_db::CrateId;
2020-06-09 10:32:42 -05:00
use fst::{self, Streamer};
use hir_expand::name::Name;
use indexmap::{map::Entry, IndexMap};
use itertools::Itertools;
use rustc_hash::{FxHashMap, FxHashSet, FxHasher};
use smallvec::SmallVec;
2020-08-12 11:26:51 -05:00
use syntax::SmolStr;
2020-06-05 06:15:16 -05:00
2020-05-20 16:51:20 -05:00
use crate::{
db::DefDatabase, item_scope::ItemInNs, visibility::Visibility, AssocItemId, ModuleDefId,
ModuleId, TraitId,
2020-05-20 16:51:20 -05:00
};
type FxIndexMap<K, V> = IndexMap<K, V, BuildHasherDefault<FxHasher>>;
/// Item import details stored in the `ImportMap`.
#[derive(Debug, Clone, Eq, PartialEq)]
pub struct ImportInfo {
/// A path that can be used to import the item, relative to the crate's root.
pub path: ImportPath,
/// The module containing this item.
pub container: ModuleId,
}
#[derive(Debug, Clone, Eq, PartialEq)]
pub struct ImportPath {
pub segments: Vec<Name>,
}
impl fmt::Display for ImportPath {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Display::fmt(&self.segments.iter().format("::"), f)
}
}
impl ImportPath {
fn len(&self) -> usize {
self.segments.len()
}
}
2020-05-20 16:51:20 -05:00
/// A map from publicly exported items to the path needed to import/name them from a downstream
/// crate.
///
/// Reexports of items are taken into account, ie. if something is exported under multiple
/// names, the one with the shortest import path will be used.
///
/// Note that all paths are relative to the containing crate's root, so the crate name still needs
/// to be prepended to the `ModPath` before the path is valid.
#[derive(Default)]
2020-05-20 16:51:20 -05:00
pub struct ImportMap {
map: FxIndexMap<ItemInNs, ImportInfo>,
2020-06-09 10:32:42 -05:00
/// List of keys stored in `map`, sorted lexicographically by their `ModPath`. Indexed by the
/// values returned by running `fst`.
///
/// Since a path can refer to multiple items due to namespacing, we store all items with the
/// same path right after each other. This allows us to find all items after the FST gives us
/// the index of the first one.
importables: Vec<ItemInNs>,
fst: fst::Map<Vec<u8>>,
/// Maps names of associated items to the item's ID. Only includes items whose defining trait is
/// exported.
2020-07-02 08:42:37 -05:00
assoc_map: FxHashMap<SmolStr, SmallVec<[AssocItemId; 1]>>,
2020-05-20 16:51:20 -05:00
}
impl ImportMap {
pub fn import_map_query(db: &dyn DefDatabase, krate: CrateId) -> Arc<Self> {
2020-08-12 09:32:36 -05:00
let _p = profile::span("import_map_query");
2020-05-20 16:51:20 -05:00
let def_map = db.crate_def_map(krate);
let mut import_map = Self::default();
2020-05-20 16:51:20 -05:00
// We look only into modules that are public(ly reexported), starting with the crate root.
let empty = ImportPath { segments: vec![] };
2020-05-20 16:51:20 -05:00
let root = ModuleId { krate, local_id: def_map.root };
let mut worklist = vec![(root, empty)];
while let Some((module, mod_path)) = worklist.pop() {
let ext_def_map;
let mod_data = if module.krate == krate {
&def_map[module.local_id]
} else {
// The crate might reexport a module defined in another crate.
ext_def_map = db.crate_def_map(module.krate);
&ext_def_map[module.local_id]
};
let visible_items = mod_data.scope.entries().filter_map(|(name, per_ns)| {
let per_ns = per_ns.filter_visibility(|vis| vis == Visibility::Public);
if per_ns.is_none() {
None
} else {
Some((name, per_ns))
}
});
for (name, per_ns) in visible_items {
let mk_path = || {
let mut path = mod_path.clone();
path.segments.push(name.clone());
path
};
for item in per_ns.iter_items() {
let path = mk_path();
match import_map.map.entry(item) {
2020-05-20 16:51:20 -05:00
Entry::Vacant(entry) => {
entry.insert(ImportInfo { path, container: module });
2020-05-20 16:51:20 -05:00
}
Entry::Occupied(mut entry) => {
// If the new path is shorter, prefer that one.
if path.len() < entry.get().path.len() {
*entry.get_mut() = ImportInfo { path, container: module };
2020-05-20 16:51:20 -05:00
} else {
continue;
}
}
}
// If we've just added a path to a module, descend into it. We might traverse
// modules multiple times, but only if the new path to it is shorter than the
// first (else we `continue` above).
2020-05-20 16:51:20 -05:00
if let Some(ModuleDefId::ModuleId(mod_id)) = item.as_module_def_id() {
worklist.push((mod_id, mk_path()));
}
// If we've added a path to a trait, add the trait's methods to the method map.
if let Some(ModuleDefId::TraitId(tr)) = item.as_module_def_id() {
import_map.collect_trait_methods(db, tr);
}
2020-05-20 16:51:20 -05:00
}
}
}
let mut importables = import_map.map.iter().collect::<Vec<_>>();
2020-06-09 10:32:42 -05:00
importables.sort_by(cmp);
// Build the FST, taking care not to insert duplicate values.
let mut builder = fst::MapBuilder::memory();
let mut last_batch_start = 0;
for idx in 0..importables.len() {
if let Some(next_item) = importables.get(idx + 1) {
if cmp(&importables[last_batch_start], next_item) == Ordering::Equal {
continue;
}
}
let start = last_batch_start;
last_batch_start = idx + 1;
2020-12-28 06:24:13 -06:00
let key = fst_path(&importables[start].1.path);
2020-06-09 10:32:42 -05:00
builder.insert(key, start as u64).unwrap();
}
import_map.fst = fst::Map::new(builder.into_inner().unwrap()).unwrap();
import_map.importables = importables.iter().map(|(item, _)| **item).collect();
2020-06-09 10:32:42 -05:00
Arc::new(import_map)
2020-05-20 16:51:20 -05:00
}
/// Returns the `ModPath` needed to import/mention `item`, relative to this crate's root.
pub fn path_of(&self, item: ItemInNs) -> Option<&ImportPath> {
self.import_info_for(item).map(|it| &it.path)
}
pub fn import_info_for(&self, item: ItemInNs) -> Option<&ImportInfo> {
2020-05-20 16:51:20 -05:00
self.map.get(&item)
}
fn collect_trait_methods(&mut self, db: &dyn DefDatabase, tr: TraitId) {
let data = db.trait_data(tr);
for (name, item) in data.items.iter() {
2020-07-02 08:42:37 -05:00
self.assoc_map.entry(name.to_string().into()).or_default().push(*item);
}
}
2020-05-20 16:51:20 -05:00
}
2020-06-09 10:32:42 -05:00
impl PartialEq for ImportMap {
fn eq(&self, other: &Self) -> bool {
2020-06-10 04:52:00 -05:00
// `fst` and `importables` are built from `map`, so we don't need to compare them.
self.map == other.map
2020-06-09 10:32:42 -05:00
}
}
impl Eq for ImportMap {}
2020-06-05 06:36:19 -05:00
impl fmt::Debug for ImportMap {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let mut importable_paths: Vec<_> = self
.map
.iter()
.map(|(item, info)| {
2020-06-05 06:36:19 -05:00
let ns = match item {
ItemInNs::Types(_) => "t",
ItemInNs::Values(_) => "v",
ItemInNs::Macros(_) => "m",
};
format!("- {} ({})", info.path, ns)
2020-06-05 06:36:19 -05:00
})
.collect();
importable_paths.sort();
f.write_str(&importable_paths.join("\n"))
}
}
2020-12-28 06:24:13 -06:00
fn fst_path(path: &ImportPath) -> String {
let mut s = path.to_string();
2020-06-10 04:52:00 -05:00
s.make_ascii_lowercase();
s
2020-06-09 10:32:42 -05:00
}
fn cmp((_, lhs): &(&ItemInNs, &ImportInfo), (_, rhs): &(&ItemInNs, &ImportInfo)) -> Ordering {
2020-12-28 06:24:13 -06:00
let lhs_str = fst_path(&lhs.path);
let rhs_str = fst_path(&rhs.path);
2020-06-10 04:52:00 -05:00
lhs_str.cmp(&rhs_str)
2020-06-09 10:32:42 -05:00
}
#[derive(Debug, Eq, PartialEq, Hash)]
pub enum ImportKind {
Module,
Function,
Adt,
EnumVariant,
Const,
Static,
Trait,
TypeAlias,
BuiltinType,
}
2020-12-28 06:54:31 -06:00
/// A way to match import map contents against the search query.
2020-12-28 06:24:13 -06:00
#[derive(Debug)]
pub enum SearchMode {
2020-12-28 06:54:31 -06:00
/// Import map entry should strictly match the query string.
2020-12-28 06:24:13 -06:00
Equals,
2020-12-28 06:54:31 -06:00
/// Import map entry should contain the query string.
2020-12-28 06:24:13 -06:00
Contains,
2020-12-28 06:54:31 -06:00
/// Import map entry should contain all letters from the query string,
/// in the same order, but not necessary adjacent.
2020-12-28 06:24:13 -06:00
Fuzzy,
}
2020-06-09 10:32:42 -05:00
#[derive(Debug)]
pub struct Query {
query: String,
lowercased: String,
2020-12-28 03:41:08 -06:00
name_only: bool,
2020-12-28 06:24:13 -06:00
search_mode: SearchMode,
case_sensitive: bool,
2020-06-10 05:30:33 -05:00
limit: usize,
exclude_import_kinds: FxHashSet<ImportKind>,
2020-06-09 10:32:42 -05:00
}
impl Query {
2020-12-29 06:35:49 -06:00
pub fn new(query: String) -> Self {
let lowercased = query.to_lowercase();
Self {
2020-12-29 06:35:49 -06:00
query,
lowercased,
2020-12-28 03:41:08 -06:00
name_only: false,
2020-12-28 06:24:13 -06:00
search_mode: SearchMode::Contains,
case_sensitive: false,
limit: usize::max_value(),
exclude_import_kinds: FxHashSet::default(),
}
2020-06-09 10:32:42 -05:00
}
2020-12-28 06:54:31 -06:00
/// Matches entries' names only, ignoring the rest of
/// the qualifier.
/// Example: for `std::marker::PhantomData`, the name is `PhantomData`.
2020-12-28 03:41:08 -06:00
pub fn name_only(self) -> Self {
Self { name_only: true, ..self }
}
2020-12-28 06:54:31 -06:00
/// Specifies the way to search for the entries using the query.
2020-12-28 06:24:13 -06:00
pub fn search_mode(self, search_mode: SearchMode) -> Self {
Self { search_mode, ..self }
2020-06-09 10:32:42 -05:00
}
2020-06-10 05:30:33 -05:00
/// Limits the returned number of items to `limit`.
pub fn limit(self, limit: usize) -> Self {
Self { limit, ..self }
}
/// Respect casing of the query string when matching.
pub fn case_sensitive(self) -> Self {
Self { case_sensitive: true, ..self }
}
/// Do not include imports of the specified kind in the search results.
pub fn exclude_import_kind(mut self, import_kind: ImportKind) -> Self {
self.exclude_import_kinds.insert(import_kind);
self
}
2020-06-09 10:32:42 -05:00
}
2020-12-28 03:41:08 -06:00
fn contains_query(query: &Query, input_path: &ImportPath, enforce_lowercase: bool) -> bool {
let mut input = if query.name_only {
input_path.segments.last().unwrap().to_string()
} else {
input_path.to_string()
};
if enforce_lowercase || !query.case_sensitive {
input.make_ascii_lowercase();
}
let query_string =
if !enforce_lowercase && query.case_sensitive { &query.query } else { &query.lowercased };
2020-12-28 06:24:13 -06:00
match query.search_mode {
SearchMode::Equals => &input == query_string,
SearchMode::Contains => input.contains(query_string),
SearchMode::Fuzzy => {
let mut unchecked_query_chars = query_string.chars();
let mut mismatching_query_char = unchecked_query_chars.next();
for input_char in input.chars() {
match mismatching_query_char {
None => return true,
Some(matching_query_char) if matching_query_char == input_char => {
mismatching_query_char = unchecked_query_chars.next();
}
_ => (),
}
}
mismatching_query_char.is_none()
2020-12-28 03:41:08 -06:00
}
}
}
2020-06-09 10:32:42 -05:00
/// Searches dependencies of `krate` for an importable path matching `query`.
///
2020-06-10 04:52:00 -05:00
/// This returns a list of items that could be imported from dependencies of `krate`.
2020-06-09 10:32:42 -05:00
pub fn search_dependencies<'a>(
db: &'a dyn DefDatabase,
krate: CrateId,
query: Query,
) -> Vec<ItemInNs> {
2020-08-12 09:32:36 -05:00
let _p = profile::span("search_dependencies").detail(|| format!("{:?}", query));
2020-06-09 10:32:42 -05:00
let graph = db.crate_graph();
let import_maps: Vec<_> =
graph[krate].dependencies.iter().map(|dep| db.import_map(dep.crate_id)).collect();
let automaton = fst::automaton::Subsequence::new(&query.lowercased);
2020-06-09 10:32:42 -05:00
let mut op = fst::map::OpBuilder::new();
for map in &import_maps {
op = op.add(map.fst.search(&automaton));
}
let mut stream = op.union();
let mut res = Vec::new();
while let Some((_, indexed_values)) = stream.next() {
for indexed_value in indexed_values {
let import_map = &import_maps[indexed_value.index];
let importables = &import_map.importables[indexed_value.value as usize..];
// Path shared by the importable items in this group.
2020-12-28 03:41:08 -06:00
let common_importables_path = &import_map.map[&importables[0]].path;
if !contains_query(&query, common_importables_path, true) {
continue;
2020-06-09 10:32:42 -05:00
}
2020-12-28 06:24:13 -06:00
let common_importables_path_fst = fst_path(common_importables_path);
2020-06-09 10:32:42 -05:00
// Add the items from this `ModPath` group. Those are all subsequent items in
// `importables` whose paths match `path`.
let iter = importables
.iter()
.copied()
.take_while(|item| {
2020-12-28 06:24:13 -06:00
common_importables_path_fst == fst_path(&import_map.map[item].path)
})
.filter(|&item| match item_import_kind(item) {
Some(import_kind) => !query.exclude_import_kinds.contains(&import_kind),
None => true,
2020-12-28 03:41:08 -06:00
})
2020-12-28 06:54:31 -06:00
.filter(|item| {
!query.case_sensitive // we've already checked the common importables path case-insensitively
|| contains_query(&query, &import_map.map[item].path, false)
});
2020-12-28 03:41:08 -06:00
res.extend(iter);
2020-06-10 05:30:33 -05:00
if res.len() >= query.limit {
res.truncate(query.limit);
return res;
}
2020-06-09 10:32:42 -05:00
}
}
// Add all exported associated items whose names match the query (exactly).
for map in &import_maps {
2020-07-02 08:42:37 -05:00
if let Some(v) = map.assoc_map.get(&*query.query) {
res.extend(v.iter().map(|&assoc| {
ItemInNs::Types(match assoc {
AssocItemId::FunctionId(it) => it.into(),
AssocItemId::ConstId(it) => it.into(),
AssocItemId::TypeAliasId(it) => it.into(),
})
}));
}
}
2020-06-09 10:32:42 -05:00
res
}
fn item_import_kind(item: ItemInNs) -> Option<ImportKind> {
Some(match item.as_module_def_id()? {
ModuleDefId::ModuleId(_) => ImportKind::Module,
ModuleDefId::FunctionId(_) => ImportKind::Function,
ModuleDefId::AdtId(_) => ImportKind::Adt,
ModuleDefId::EnumVariantId(_) => ImportKind::EnumVariant,
ModuleDefId::ConstId(_) => ImportKind::Const,
ModuleDefId::StaticId(_) => ImportKind::Static,
ModuleDefId::TraitId(_) => ImportKind::Trait,
ModuleDefId::TypeAliasId(_) => ImportKind::TypeAlias,
ModuleDefId::BuiltinType(_) => ImportKind::BuiltinType,
})
}
2020-05-20 16:51:20 -05:00
#[cfg(test)]
mod tests {
2020-08-13 09:25:38 -05:00
use base_db::{fixture::WithFixture, SourceDatabase, Upcast};
2020-08-21 06:19:31 -05:00
use expect_test::{expect, Expect};
2020-05-20 16:51:20 -05:00
2020-12-28 08:13:37 -06:00
use crate::{data::FunctionData, test_db::TestDB, AssocContainerId, Lookup};
2020-05-20 16:51:20 -05:00
2020-07-17 08:54:40 -05:00
use super::*;
2020-05-20 16:51:20 -05:00
2020-10-02 13:38:22 -05:00
fn check_search(ra_fixture: &str, crate_name: &str, query: Query, expect: Expect) {
2020-06-09 10:32:42 -05:00
let db = TestDB::with_files(ra_fixture);
let crate_graph = db.crate_graph();
let krate = crate_graph
.iter()
.find(|krate| {
crate_graph[*krate].display_name.as_ref().map(|n| n.to_string())
2020-10-02 13:38:22 -05:00
== Some(crate_name.to_string())
2020-06-09 10:32:42 -05:00
})
.unwrap();
2020-07-17 08:54:40 -05:00
let actual = search_dependencies(db.upcast(), krate, query)
2020-06-09 10:32:42 -05:00
.into_iter()
.filter_map(|item| {
let mark = match item {
2020-12-28 08:13:37 -06:00
ItemInNs::Types(ModuleDefId::FunctionId(_))
| ItemInNs::Values(ModuleDefId::FunctionId(_)) => "f",
2020-06-09 10:32:42 -05:00
ItemInNs::Types(_) => "t",
ItemInNs::Values(_) => "v",
ItemInNs::Macros(_) => "m",
};
item.krate(db.upcast()).map(|krate| {
let map = db.import_map(krate);
2020-12-28 08:13:37 -06:00
let path = match assoc_to_trait(&db, item) {
Some(trait_) => {
let mut full_path = map.path_of(trait_).unwrap().to_string();
if let ItemInNs::Types(ModuleDefId::FunctionId(function_id))
| ItemInNs::Values(ModuleDefId::FunctionId(function_id)) = item
{
full_path += &format!(
"::{}",
FunctionData::fn_data_query(&db, function_id).name
);
}
full_path
}
None => map.path_of(item).unwrap().to_string(),
};
2020-06-09 10:32:42 -05:00
format!(
2020-07-17 08:54:40 -05:00
"{}::{} ({})\n",
crate_graph[krate].display_name.as_ref().unwrap(),
2020-06-09 10:32:42 -05:00
path,
mark
)
})
})
2020-07-17 08:54:40 -05:00
.collect::<String>();
expect.assert_eq(&actual)
2020-06-09 10:32:42 -05:00
}
2020-12-28 08:13:37 -06:00
fn assoc_to_trait(db: &dyn DefDatabase, item: ItemInNs) -> Option<ItemInNs> {
2020-07-02 06:34:08 -05:00
let assoc: AssocItemId = match item {
ItemInNs::Types(it) | ItemInNs::Values(it) => match it {
ModuleDefId::TypeAliasId(it) => it.into(),
ModuleDefId::FunctionId(it) => it.into(),
ModuleDefId::ConstId(it) => it.into(),
2020-12-28 08:13:37 -06:00
_ => return None,
2020-07-02 06:34:08 -05:00
},
2020-12-28 08:13:37 -06:00
_ => return None,
2020-07-02 06:34:08 -05:00
};
let container = match assoc {
AssocItemId::FunctionId(it) => it.lookup(db).container,
AssocItemId::ConstId(it) => it.lookup(db).container,
AssocItemId::TypeAliasId(it) => it.lookup(db).container,
};
match container {
2020-12-28 08:13:37 -06:00
AssocContainerId::TraitId(it) => Some(ItemInNs::Types(it.into())),
_ => None,
2020-07-02 06:34:08 -05:00
}
}
2020-07-17 08:54:40 -05:00
fn check(ra_fixture: &str, expect: Expect) {
let db = TestDB::with_files(ra_fixture);
let crate_graph = db.crate_graph();
let actual = crate_graph
.iter()
.filter_map(|krate| {
let cdata = &crate_graph[krate];
let name = cdata.display_name.as_ref()?;
2020-07-17 08:54:40 -05:00
let map = db.import_map(krate);
Some(format!("{}:\n{:?}\n", name, map))
})
.collect::<String>();
expect.assert_eq(&actual)
}
2020-05-20 16:51:20 -05:00
#[test]
fn smoke() {
2020-07-17 08:54:40 -05:00
check(
2020-05-20 16:51:20 -05:00
r"
//- /main.rs crate:main deps:lib
mod private {
pub use lib::Pub;
pub struct InPrivateModule;
}
pub mod publ1 {
use lib::Pub;
}
pub mod real_pub {
pub use lib::Pub;
}
pub mod real_pu2 { // same path length as above
pub use lib::Pub;
}
//- /lib.rs crate:lib
pub struct Pub {}
pub struct Pub2; // t + v
struct Priv;
",
2020-07-17 08:54:40 -05:00
expect![[r#"
main:
- publ1 (t)
- real_pu2 (t)
- real_pub (t)
- real_pub::Pub (t)
lib:
- Pub (t)
- Pub2 (t)
- Pub2 (v)
"#]],
2020-05-20 16:51:20 -05:00
);
}
#[test]
fn prefers_shortest_path() {
2020-07-17 08:54:40 -05:00
check(
2020-05-20 16:51:20 -05:00
r"
//- /main.rs crate:main
pub mod sub {
pub mod subsub {
pub struct Def {}
}
pub use super::sub::subsub::Def;
}
",
2020-07-17 08:54:40 -05:00
expect![[r#"
main:
- sub (t)
- sub::Def (t)
- sub::subsub (t)
"#]],
2020-05-20 16:51:20 -05:00
);
}
#[test]
fn type_reexport_cross_crate() {
// Reexports need to be visible from a crate, even if the original crate exports the item
// at a shorter path.
2020-07-17 08:54:40 -05:00
check(
2020-05-20 16:51:20 -05:00
r"
//- /main.rs crate:main deps:lib
pub mod m {
pub use lib::S;
}
//- /lib.rs crate:lib
pub struct S;
",
2020-07-17 08:54:40 -05:00
expect![[r#"
main:
- m (t)
- m::S (t)
- m::S (v)
lib:
- S (t)
- S (v)
"#]],
2020-05-20 16:51:20 -05:00
);
}
#[test]
fn macro_reexport() {
2020-07-17 08:54:40 -05:00
check(
2020-05-20 16:51:20 -05:00
r"
//- /main.rs crate:main deps:lib
pub mod m {
pub use lib::pub_macro;
}
//- /lib.rs crate:lib
#[macro_export]
macro_rules! pub_macro {
() => {};
}
",
2020-07-17 08:54:40 -05:00
expect![[r#"
main:
- m (t)
- m::pub_macro (m)
lib:
- pub_macro (m)
"#]],
2020-05-20 16:51:20 -05:00
);
}
#[test]
fn module_reexport() {
// Reexporting modules from a dependency adds all contents to the import map.
2020-07-17 08:54:40 -05:00
check(
2020-05-20 16:51:20 -05:00
r"
//- /main.rs crate:main deps:lib
pub use lib::module as reexported_module;
//- /lib.rs crate:lib
pub mod module {
pub struct S;
}
",
2020-07-17 08:54:40 -05:00
expect![[r#"
main:
- reexported_module (t)
- reexported_module::S (t)
- reexported_module::S (v)
lib:
- module (t)
- module::S (t)
- module::S (v)
"#]],
2020-05-20 16:51:20 -05:00
);
}
#[test]
fn cyclic_module_reexport() {
2020-06-05 06:04:35 -05:00
// A cyclic reexport does not hang.
2020-07-17 08:54:40 -05:00
check(
2020-05-20 16:51:20 -05:00
r"
//- /lib.rs crate:lib
pub mod module {
pub struct S;
pub use super::sub::*;
}
pub mod sub {
pub use super::module;
}
",
2020-07-17 08:54:40 -05:00
expect![[r#"
lib:
- module (t)
- module::S (t)
- module::S (v)
- sub (t)
"#]],
2020-05-20 16:51:20 -05:00
);
}
#[test]
fn private_macro() {
2020-07-17 08:54:40 -05:00
check(
2020-05-20 16:51:20 -05:00
r"
//- /lib.rs crate:lib
macro_rules! private_macro {
() => {};
}
",
2020-07-17 08:54:40 -05:00
expect![[r#"
lib:
2020-05-20 16:51:20 -05:00
2020-07-17 08:54:40 -05:00
"#]],
);
2020-05-20 16:51:20 -05:00
}
2020-06-09 10:32:42 -05:00
#[test]
fn namespacing() {
2020-07-17 08:54:40 -05:00
check(
2020-06-09 10:32:42 -05:00
r"
//- /lib.rs crate:lib
pub struct Thing; // t + v
#[macro_export]
macro_rules! Thing { // m
() => {};
}
",
2020-07-17 08:54:40 -05:00
expect![[r#"
lib:
- Thing (m)
- Thing (t)
- Thing (v)
"#]],
2020-06-09 10:32:42 -05:00
);
2020-07-17 08:54:40 -05:00
check(
2020-06-09 10:32:42 -05:00
r"
//- /lib.rs crate:lib
pub mod Thing {} // t
#[macro_export]
macro_rules! Thing { // m
() => {};
}
",
2020-07-17 08:54:40 -05:00
expect![[r#"
lib:
- Thing (m)
- Thing (t)
"#]],
2020-06-09 10:32:42 -05:00
);
}
#[test]
2020-12-28 07:22:03 -06:00
fn search_mode() {
2020-06-09 10:32:42 -05:00
let ra_fixture = r#"
//- /main.rs crate:main deps:dep
//- /dep.rs crate:dep deps:tdep
use tdep::fmt as fmt_dep;
pub mod fmt {
pub trait Display {
fn fmt();
}
}
#[macro_export]
macro_rules! Fmt {
() => {};
}
pub struct Fmt;
pub fn format() {}
pub fn no() {}
//- /tdep.rs crate:tdep
pub mod fmt {
pub struct NotImportableFromMain;
}
"#;
2020-07-17 08:54:40 -05:00
check_search(
ra_fixture,
"main",
2020-12-29 06:35:49 -06:00
Query::new("fmt".to_string()).search_mode(SearchMode::Fuzzy),
2020-07-17 08:54:40 -05:00
expect![[r#"
dep::fmt (t)
dep::Fmt (t)
dep::Fmt (v)
dep::Fmt (m)
dep::fmt::Display (t)
2020-12-28 08:13:37 -06:00
dep::format (f)
dep::fmt::Display::fmt (f)
2020-07-17 08:54:40 -05:00
"#]],
);
check_search(
ra_fixture,
"main",
2020-12-29 06:35:49 -06:00
Query::new("fmt".to_string()).search_mode(SearchMode::Equals),
2020-12-28 07:22:03 -06:00
expect![[r#"
dep::fmt (t)
dep::Fmt (t)
dep::Fmt (v)
dep::Fmt (m)
2020-12-28 08:13:37 -06:00
dep::fmt::Display::fmt (f)
2020-12-28 07:22:03 -06:00
"#]],
);
check_search(
ra_fixture,
"main",
2020-12-29 06:35:49 -06:00
Query::new("fmt".to_string()).search_mode(SearchMode::Contains),
2020-12-28 07:22:03 -06:00
expect![[r#"
dep::fmt (t)
dep::Fmt (t)
dep::Fmt (v)
dep::Fmt (m)
dep::fmt::Display (t)
2020-12-28 08:13:37 -06:00
dep::fmt::Display::fmt (f)
2020-12-28 07:22:03 -06:00
"#]],
);
}
#[test]
fn name_only() {
let ra_fixture = r#"
//- /main.rs crate:main deps:dep
//- /dep.rs crate:dep deps:tdep
use tdep::fmt as fmt_dep;
pub mod fmt {
pub trait Display {
fn fmt();
}
}
#[macro_export]
macro_rules! Fmt {
() => {};
}
pub struct Fmt;
pub fn format() {}
pub fn no() {}
//- /tdep.rs crate:tdep
pub mod fmt {
pub struct NotImportableFromMain;
}
"#;
check_search(
ra_fixture,
"main",
2020-12-29 06:35:49 -06:00
Query::new("fmt".to_string()),
2020-12-28 07:22:03 -06:00
expect![[r#"
dep::fmt (t)
dep::Fmt (t)
dep::Fmt (v)
dep::Fmt (m)
dep::fmt::Display (t)
2020-12-28 08:13:37 -06:00
dep::fmt::Display::fmt (f)
2020-12-28 07:22:03 -06:00
"#]],
);
check_search(
ra_fixture,
"main",
2020-12-29 06:35:49 -06:00
Query::new("fmt".to_string()).name_only(),
2020-07-17 08:54:40 -05:00
expect![[r#"
dep::fmt (t)
dep::Fmt (t)
dep::Fmt (v)
dep::Fmt (m)
2020-12-28 08:13:37 -06:00
dep::fmt::Display::fmt (f)
2020-07-17 08:54:40 -05:00
"#]],
);
2020-06-09 10:32:42 -05:00
}
2020-06-10 05:30:33 -05:00
#[test]
fn search_casing() {
let ra_fixture = r#"
//- /main.rs crate:main deps:dep
//- /dep.rs crate:dep
pub struct fmt;
pub struct FMT;
"#;
2020-07-17 08:54:40 -05:00
check_search(
ra_fixture,
"main",
2020-12-29 06:35:49 -06:00
Query::new("FMT".to_string()),
2020-07-17 08:54:40 -05:00
expect![[r#"
dep::fmt (t)
dep::fmt (v)
dep::FMT (t)
dep::FMT (v)
"#]],
);
2020-07-17 08:54:40 -05:00
check_search(
ra_fixture,
"main",
2020-12-29 06:35:49 -06:00
Query::new("FMT".to_string()).case_sensitive(),
2020-07-17 08:54:40 -05:00
expect![[r#"
dep::FMT (t)
dep::FMT (v)
"#]],
);
}
2020-06-10 05:30:33 -05:00
#[test]
fn search_limit() {
2020-07-17 08:54:40 -05:00
check_search(
2020-06-10 05:30:33 -05:00
r#"
//- /main.rs crate:main deps:dep
//- /dep.rs crate:dep
pub mod fmt {
pub trait Display {
fn fmt();
}
}
#[macro_export]
macro_rules! Fmt {
() => {};
}
pub struct Fmt;
pub fn format() {}
pub fn no() {}
"#,
"main",
2020-12-29 06:35:49 -06:00
Query::new("".to_string()).limit(2),
2020-07-17 08:54:40 -05:00
expect![[r#"
dep::fmt (t)
dep::Fmt (t)
"#]],
2020-06-10 05:30:33 -05:00
);
}
#[test]
fn search_exclusions() {
let ra_fixture = r#"
//- /main.rs crate:main deps:dep
//- /dep.rs crate:dep
pub struct fmt;
pub struct FMT;
"#;
check_search(
ra_fixture,
"main",
2020-12-29 06:35:49 -06:00
Query::new("FMT".to_string()),
expect![[r#"
dep::fmt (t)
dep::fmt (v)
dep::FMT (t)
dep::FMT (v)
"#]],
);
check_search(
ra_fixture,
"main",
2020-12-29 06:35:49 -06:00
Query::new("FMT".to_string()).exclude_import_kind(ImportKind::Adt),
expect![[r#""#]],
);
}
2020-05-20 16:51:20 -05:00
}