//! This crate provides primitives for tracking the information about a call site. use base_db::FilePosition; use either::Either; use hir::{HasAttrs, HirDisplay, Semantics, Type}; use stdx::format_to; use syntax::{ algo, ast::{self, ArgListOwner, NameOwner}, match_ast, AstNode, Direction, SyntaxNode, SyntaxToken, TextRange, TextSize, }; use crate::RootDatabase; /// Contains information about a call site. Specifically the /// `FunctionSignature`and current parameter. #[derive(Debug)] pub struct CallInfo { pub doc: Option, pub signature: String, pub active_parameter: Option, parameters: Vec, } impl CallInfo { pub fn parameter_labels(&self) -> impl Iterator + '_ { self.parameters.iter().map(move |&it| &self.signature[it]) } pub fn parameter_ranges(&self) -> &[TextRange] { &self.parameters } fn push_param(&mut self, param: &str) { if !self.signature.ends_with('(') { self.signature.push_str(", "); } let start = TextSize::of(&self.signature); self.signature.push_str(param); let end = TextSize::of(&self.signature); self.parameters.push(TextRange::new(start, end)) } } /// Computes parameter information for the given call expression. pub fn call_info(db: &RootDatabase, position: FilePosition) -> Option { let sema = Semantics::new(db); let file = sema.parse(position.file_id); let file = file.syntax(); let token = file .token_at_offset(position.offset) .left_biased() // if the cursor is sandwiched between two space tokens and the call is unclosed // this prevents us from leaving the CallExpression .and_then(|tok| algo::skip_trivia_token(tok, Direction::Prev))?; let token = sema.descend_into_macros(token); let (callable, active_parameter) = call_info_impl(&sema, token)?; let mut res = CallInfo { doc: None, signature: String::new(), parameters: vec![], active_parameter }; match callable.kind() { hir::CallableKind::Function(func) => { res.doc = func.docs(db).map(|it| it.into()); format_to!(res.signature, "fn {}", func.name(db)); } hir::CallableKind::TupleStruct(strukt) => { res.doc = strukt.docs(db).map(|it| it.into()); format_to!(res.signature, "struct {}", strukt.name(db)); } hir::CallableKind::TupleEnumVariant(variant) => { res.doc = variant.docs(db).map(|it| it.into()); format_to!( res.signature, "enum {}::{}", variant.parent_enum(db).name(db), variant.name(db) ); } hir::CallableKind::Closure => (), } res.signature.push('('); { if let Some(self_param) = callable.receiver_param(db) { format_to!(res.signature, "{}", self_param) } let mut buf = String::new(); for (pat, ty) in callable.params(db) { buf.clear(); if let Some(pat) = pat { match pat { Either::Left(_self) => format_to!(buf, "self: "), Either::Right(pat) => format_to!(buf, "{}: ", pat), } } format_to!(buf, "{}", ty.display(db)); res.push_param(&buf); } } res.signature.push(')'); match callable.kind() { hir::CallableKind::Function(_) | hir::CallableKind::Closure => { let ret_type = callable.return_type(); if !ret_type.is_unit() { format_to!(res.signature, " -> {}", ret_type.display(db)); } } hir::CallableKind::TupleStruct(_) | hir::CallableKind::TupleEnumVariant(_) => {} } Some(res) } fn call_info_impl( sema: &Semantics, token: SyntaxToken, ) -> Option<(hir::Callable, Option)> { // Find the calling expression and it's NameRef let calling_node = FnCallNode::with_node(&token.parent()?)?; let callable = match &calling_node { FnCallNode::CallExpr(call) => sema.type_of_expr(&call.expr()?)?.as_callable(sema.db)?, FnCallNode::MethodCallExpr(call) => sema.resolve_method_call_as_callable(call)?, }; let active_param = if let Some(arg_list) = calling_node.arg_list() { // Number of arguments specified at the call site let num_args_at_callsite = arg_list.args().count(); let arg_list_range = arg_list.syntax().text_range(); if !arg_list_range.contains_inclusive(token.text_range().start()) { cov_mark::hit!(call_info_bad_offset); return None; } let param = std::cmp::min( num_args_at_callsite, arg_list .args() .take_while(|arg| arg.syntax().text_range().end() <= token.text_range().start()) .count(), ); Some(param) } else { None }; Some((callable, active_param)) } #[derive(Debug)] pub struct ActiveParameter { pub ty: Type, pub pat: Either, } impl ActiveParameter { pub fn at(db: &RootDatabase, position: FilePosition) -> Option { let sema = Semantics::new(db); let file = sema.parse(position.file_id); let file = file.syntax(); let token = file.token_at_offset(position.offset).next()?; let token = sema.descend_into_macros(token); Self::at_token(&sema, token) } pub fn at_token(sema: &Semantics, token: SyntaxToken) -> Option { let (signature, active_parameter) = call_info_impl(sema, token)?; let idx = active_parameter?; let mut params = signature.params(sema.db); if !(idx < params.len()) { cov_mark::hit!(too_many_arguments); return None; } let (pat, ty) = params.swap_remove(idx); pat.map(|pat| ActiveParameter { ty, pat }) } pub fn ident(&self) -> Option { self.pat.as_ref().right().and_then(|param| match param { ast::Pat::IdentPat(ident) => ident.name(), _ => None, }) } } #[derive(Debug)] pub enum FnCallNode { CallExpr(ast::CallExpr), MethodCallExpr(ast::MethodCallExpr), } impl FnCallNode { fn with_node(syntax: &SyntaxNode) -> Option { syntax.ancestors().find_map(|node| { match_ast! { match node { ast::CallExpr(it) => Some(FnCallNode::CallExpr(it)), ast::MethodCallExpr(it) => { let arg_list = it.arg_list()?; if !arg_list.syntax().text_range().contains_range(syntax.text_range()) { return None; } Some(FnCallNode::MethodCallExpr(it)) }, _ => None, } } }) } pub fn with_node_exact(node: &SyntaxNode) -> Option { match_ast! { match node { ast::CallExpr(it) => Some(FnCallNode::CallExpr(it)), ast::MethodCallExpr(it) => Some(FnCallNode::MethodCallExpr(it)), _ => None, } } } pub fn name_ref(&self) -> Option { match self { FnCallNode::CallExpr(call_expr) => Some(match call_expr.expr()? { ast::Expr::PathExpr(path_expr) => path_expr.path()?.segment()?.name_ref()?, _ => return None, }), FnCallNode::MethodCallExpr(call_expr) => { call_expr.syntax().children().find_map(ast::NameRef::cast) } } } fn arg_list(&self) -> Option { match self { FnCallNode::CallExpr(expr) => expr.arg_list(), FnCallNode::MethodCallExpr(expr) => expr.arg_list(), } } } #[cfg(test)] mod tests;