crates/ide_db/src/helpers.rs

   1 //! A module with ide helpers for high-level ide features.
   2 pub mod import_assets;
   3 pub mod insert_use;
   4 pub mod merge_imports;
   5 pub mod rust_doc;
   6 pub mod generated_lints;
   7
   8 use std::collections::VecDeque;
   9
  10 use base_db::FileId;
  11 use either::Either;
  12 use hir::{Crate, Enum, ItemInNs, MacroDef, Module, ModuleDef, Name, ScopeDef, Semantics, Trait};
  13 use syntax::{
  14     ast::{self, make, LoopBodyOwner},
  15     AstNode, SyntaxKind, SyntaxToken, TokenAtOffset, WalkEvent,
  16 };
  17
  18 use crate::RootDatabase;
  19
  20 pub fn item_name(db: &RootDatabase, item: ItemInNs) -> Option<Name> {
  21     match item {
  22         ItemInNs::Types(module_def_id) => ModuleDef::from(module_def_id).name(db),
  23         ItemInNs::Values(module_def_id) => ModuleDef::from(module_def_id).name(db),
  24         ItemInNs::Macros(macro_def_id) => MacroDef::from(macro_def_id).name(db),
  25     }
  26 }
  27
  28 /// Picks the token with the highest rank returned by the passed in function.
  29 pub fn pick_best_token(
  30     tokens: TokenAtOffset<SyntaxToken>,
  31     f: impl Fn(SyntaxKind) -> usize,
  32 ) -> Option<SyntaxToken> {
  33     tokens.max_by_key(move |t| f(t.kind()))
  34 }
  35
  36 /// Converts the mod path struct into its ast representation.
  37 pub fn mod_path_to_ast(path: &hir::ModPath) -> ast::Path {
  38     let _p = profile::span("mod_path_to_ast");
  39
  40     let mut segments = Vec::new();
  41     let mut is_abs = false;
  42     match path.kind {
  43         hir::PathKind::Plain => {}
  44         hir::PathKind::Super(0) => segments.push(make::path_segment_self()),
  45         hir::PathKind::Super(n) => segments.extend((0..n).map(|_| make::path_segment_super())),
  46         hir::PathKind::DollarCrate(_) | hir::PathKind::Crate => {
  47             segments.push(make::path_segment_crate())
  48         }
  49         hir::PathKind::Abs => is_abs = true,
  50     }
  51
  52     segments.extend(
  53         path.segments()
  54             .iter()
  55             .map(|segment| make::path_segment(make::name_ref(&segment.to_string()))),
  56     );
  57     make::path_from_segments(segments, is_abs)
  58 }
  59
  60 /// Iterates all `ModuleDef`s and `Impl` blocks of the given file.
  61 pub fn visit_file_defs(
  62     sema: &Semantics<RootDatabase>,
  63     file_id: FileId,
  64     cb: &mut dyn FnMut(Either<hir::ModuleDef, hir::Impl>),
  65 ) {
  66     let db = sema.db;
  67     let module = match sema.to_module_def(file_id) {
  68         Some(it) => it,
  69         None => return,
  70     };
  71     let mut defs: VecDeque<_> = module.declarations(db).into();
  72     while let Some(def) = defs.pop_front() {
  73         if let ModuleDef::Module(submodule) = def {
  74             if let hir::ModuleSource::Module(_) = submodule.definition_source(db).value {
  75                 defs.extend(submodule.declarations(db));
  76                 submodule.impl_defs(db).into_iter().for_each(|impl_| cb(Either::Right(impl_)));
  77             }
  78         }
  79         cb(Either::Left(def));
  80     }
  81     module.impl_defs(db).into_iter().for_each(|impl_| cb(Either::Right(impl_)));
  82 }
  83
  84 /// Helps with finding well-know things inside the standard library. This is
  85 /// somewhat similar to the known paths infra inside hir, but it different; We
  86 /// want to make sure that IDE specific paths don't become interesting inside
  87 /// the compiler itself as well.
  88 ///
  89 /// Note that, by default, rust-analyzer tests **do not** include core or std
  90 /// libraries. If you are writing tests for functionality using [`FamousDefs`],
  91 /// you'd want to include [minicore](test_utils::MiniCore) declaration at the
  92 /// start of your tests:
  93 ///
  94 /// ```
  95 /// //- minicore: iterator, ord, derive
  96 /// ```
  97 pub struct FamousDefs<'a, 'b>(pub &'a Semantics<'b, RootDatabase>, pub Option<Crate>);
  98
  99 #[allow(non_snake_case)]
 100 impl FamousDefs<'_, '_> {
 101     pub fn std(&self) -> Option<Crate> {
 102         self.find_crate("std")
 103     }
 104
 105     pub fn core(&self) -> Option<Crate> {
 106         self.find_crate("core")
 107     }
 108
 109     pub fn core_cmp_Ord(&self) -> Option<Trait> {
 110         self.find_trait("core:cmp:Ord")
 111     }
 112
 113     pub fn core_convert_From(&self) -> Option<Trait> {
 114         self.find_trait("core:convert:From")
 115     }
 116
 117     pub fn core_convert_Into(&self) -> Option<Trait> {
 118         self.find_trait("core:convert:Into")
 119     }
 120
 121     pub fn core_option_Option(&self) -> Option<Enum> {
 122         self.find_enum("core:option:Option")
 123     }
 124
 125     pub fn core_result_Result(&self) -> Option<Enum> {
 126         self.find_enum("core:result:Result")
 127     }
 128
 129     pub fn core_default_Default(&self) -> Option<Trait> {
 130         self.find_trait("core:default:Default")
 131     }
 132
 133     pub fn core_iter_Iterator(&self) -> Option<Trait> {
 134         self.find_trait("core:iter:traits:iterator:Iterator")
 135     }
 136
 137     pub fn core_iter(&self) -> Option<Module> {
 138         self.find_module("core:iter")
 139     }
 140
 141     pub fn core_ops_Deref(&self) -> Option<Trait> {
 142         self.find_trait("core:ops:Deref")
 143     }
 144
 145     fn find_trait(&self, path: &str) -> Option<Trait> {
 146         match self.find_def(path)? {
 147             hir::ScopeDef::ModuleDef(hir::ModuleDef::Trait(it)) => Some(it),
 148             _ => None,
 149         }
 150     }
 151
 152     fn find_enum(&self, path: &str) -> Option<Enum> {
 153         match self.find_def(path)? {
 154             hir::ScopeDef::ModuleDef(hir::ModuleDef::Adt(hir::Adt::Enum(it))) => Some(it),
 155             _ => None,
 156         }
 157     }
 158
 159     fn find_module(&self, path: &str) -> Option<Module> {
 160         match self.find_def(path)? {
 161             hir::ScopeDef::ModuleDef(hir::ModuleDef::Module(it)) => Some(it),
 162             _ => None,
 163         }
 164     }
 165
 166     fn find_crate(&self, name: &str) -> Option<Crate> {
 167         let krate = self.1?;
 168         let db = self.0.db;
 169         let res =
 170             krate.dependencies(db).into_iter().find(|dep| dep.name.to_string() == name)?.krate;
 171         Some(res)
 172     }
 173
 174     fn find_def(&self, path: &str) -> Option<ScopeDef> {
 175         let db = self.0.db;
 176         let mut path = path.split(':');
 177         let trait_ = path.next_back()?;
 178         let std_crate = path.next()?;
 179         let std_crate = self.find_crate(std_crate)?;
 180         let mut module = std_crate.root_module(db);
 181         for segment in path {
 182             module = module.children(db).find_map(|child| {
 183                 let name = child.name(db)?;
 184                 if name.to_string() == segment {
 185                     Some(child)
 186                 } else {
 187                     None
 188                 }
 189             })?;
 190         }
 191         let def =
 192             module.scope(db, None).into_iter().find(|(name, _def)| name.to_string() == trait_)?.1;
 193         Some(def)
 194     }
 195 }
 196
 197 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
 198 pub struct SnippetCap {
 199     _private: (),
 200 }
 201
 202 impl SnippetCap {
 203     pub const fn new(allow_snippets: bool) -> Option<SnippetCap> {
 204         if allow_snippets {
 205             Some(SnippetCap { _private: () })
 206         } else {
 207             None
 208         }
 209     }
 210 }
 211
 212 /// Calls `cb` on each expression inside `expr` that is at "tail position".
 213 /// Does not walk into `break` or `return` expressions.
 214 pub fn for_each_tail_expr(expr: &ast::Expr, cb: &mut dyn FnMut(&ast::Expr)) {
 215     match expr {
 216         ast::Expr::BlockExpr(b) => {
 217             if let Some(e) = b.tail_expr() {
 218                 for_each_tail_expr(&e, cb);
 219             }
 220         }
 221         ast::Expr::EffectExpr(e) => match e.effect() {
 222             ast::Effect::Label(label) => {
 223                 for_each_break_expr(Some(label), e.block_expr(), &mut |b| {
 224                     cb(&ast::Expr::BreakExpr(b))
 225                 });
 226                 if let Some(b) = e.block_expr() {
 227                     for_each_tail_expr(&ast::Expr::BlockExpr(b), cb);
 228                 }
 229             }
 230             ast::Effect::Unsafe(_) => {
 231                 if let Some(e) = e.block_expr().and_then(|b| b.tail_expr()) {
 232                     for_each_tail_expr(&e, cb);
 233                 }
 234             }
 235             ast::Effect::Async(_) | ast::Effect::Try(_) | ast::Effect::Const(_) => cb(expr),
 236         },
 237         ast::Expr::IfExpr(if_) => {
 238             if_.blocks().for_each(|block| for_each_tail_expr(&ast::Expr::BlockExpr(block), cb))
 239         }
 240         ast::Expr::LoopExpr(l) => {
 241             for_each_break_expr(l.label(), l.loop_body(), &mut |b| cb(&ast::Expr::BreakExpr(b)))
 242         }
 243         ast::Expr::MatchExpr(m) => {
 244             if let Some(arms) = m.match_arm_list() {
 245                 arms.arms().filter_map(|arm| arm.expr()).for_each(|e| for_each_tail_expr(&e, cb));
 246             }
 247         }
 248         ast::Expr::ArrayExpr(_)
 249         | ast::Expr::AwaitExpr(_)
 250         | ast::Expr::BinExpr(_)
 251         | ast::Expr::BoxExpr(_)
 252         | ast::Expr::BreakExpr(_)
 253         | ast::Expr::CallExpr(_)
 254         | ast::Expr::CastExpr(_)
 255         | ast::Expr::ClosureExpr(_)
 256         | ast::Expr::ContinueExpr(_)
 257         | ast::Expr::FieldExpr(_)
 258         | ast::Expr::ForExpr(_)
 259         | ast::Expr::IndexExpr(_)
 260         | ast::Expr::Literal(_)
 261         | ast::Expr::MacroCall(_)
 262         | ast::Expr::MacroStmts(_)
 263         | ast::Expr::MethodCallExpr(_)
 264         | ast::Expr::ParenExpr(_)
 265         | ast::Expr::PathExpr(_)
 266         | ast::Expr::PrefixExpr(_)
 267         | ast::Expr::RangeExpr(_)
 268         | ast::Expr::RecordExpr(_)
 269         | ast::Expr::RefExpr(_)
 270         | ast::Expr::ReturnExpr(_)
 271         | ast::Expr::TryExpr(_)
 272         | ast::Expr::TupleExpr(_)
 273         | ast::Expr::WhileExpr(_)
 274         | ast::Expr::YieldExpr(_) => cb(expr),
 275     }
 276 }
 277
 278 /// Calls `cb` on each break expr inside of `body` that is applicable for the given label.
 279 pub fn for_each_break_expr(
 280     label: Option<ast::Label>,
 281     body: Option<ast::BlockExpr>,
 282     cb: &mut dyn FnMut(ast::BreakExpr),
 283 ) {
 284     let label = label.and_then(|lbl| lbl.lifetime());
 285     let mut depth = 0;
 286     if let Some(b) = body {
 287         let preorder = &mut b.syntax().preorder();
 288         let ev_as_expr = |ev| match ev {
 289             WalkEvent::Enter(it) => Some(WalkEvent::Enter(ast::Expr::cast(it)?)),
 290             WalkEvent::Leave(it) => Some(WalkEvent::Leave(ast::Expr::cast(it)?)),
 291         };
 292         let eq_label = |lt: Option<ast::Lifetime>| {
 293             lt.zip(label.as_ref()).map_or(false, |(lt, lbl)| lt.text() == lbl.text())
 294         };
 295         while let Some(node) = preorder.find_map(ev_as_expr) {
 296             match node {
 297                 WalkEvent::Enter(expr) => match expr {
 298                     ast::Expr::LoopExpr(_) | ast::Expr::WhileExpr(_) | ast::Expr::ForExpr(_) => {
 299                         depth += 1
 300                     }
 301                     ast::Expr::EffectExpr(e) if e.label().is_some() => depth += 1,
 302                     ast::Expr::BreakExpr(b)
 303                         if (depth == 0 && b.lifetime().is_none()) || eq_label(b.lifetime()) =>
 304                     {
 305                         cb(b);
 306                     }
 307                     _ => (),
 308                 },
 309                 WalkEvent::Leave(expr) => match expr {
 310                     ast::Expr::LoopExpr(_) | ast::Expr::WhileExpr(_) | ast::Expr::ForExpr(_) => {
 311                         depth -= 1
 312                     }
 313                     ast::Expr::EffectExpr(e) if e.label().is_some() => depth -= 1,
 314                     _ => (),
 315                 },
 316             }
 317         }
 318     }
 319 }