//! Various extension methods to ast Nodes, which are hard to code-generate. //! Extensions for various expressions live in a sibling `expr_extensions` module. use std::fmt; use itertools::Itertools; use ra_parser::SyntaxKind; use crate::{ ast::{self, support, AstNode, AttrInput, NameOwner, SyntaxNode}, SmolStr, SyntaxElement, SyntaxToken, T, }; impl ast::Name { pub fn text(&self) -> &SmolStr { text_of_first_token(self.syntax()) } } impl ast::NameRef { pub fn text(&self) -> &SmolStr { text_of_first_token(self.syntax()) } pub fn as_tuple_field(&self) -> Option { self.text().parse().ok() } } fn text_of_first_token(node: &SyntaxNode) -> &SmolStr { node.green().children().next().and_then(|it| it.into_token()).unwrap().text() } #[derive(Debug, Clone, PartialEq, Eq)] pub enum AttrKind { Inner, Outer, } impl ast::Attr { pub fn as_simple_atom(&self) -> Option { match self.input() { None => self.simple_name(), Some(_) => None, } } pub fn as_simple_call(&self) -> Option<(SmolStr, ast::TokenTree)> { match self.input() { Some(AttrInput::TokenTree(tt)) => Some((self.simple_name()?, tt)), _ => None, } } pub fn as_simple_key_value(&self) -> Option<(SmolStr, SmolStr)> { match self.input() { Some(AttrInput::Literal(lit)) => { let key = self.simple_name()?; // FIXME: escape? raw string? let value = lit.syntax().first_token()?.text().trim_matches('"').into(); Some((key, value)) } _ => None, } } pub fn simple_name(&self) -> Option { let path = self.path()?; match (path.segment(), path.qualifier()) { (Some(segment), None) => Some(segment.syntax().first_token()?.text().clone()), _ => None, } } pub fn kind(&self) -> AttrKind { let first_token = self.syntax().first_token(); let first_token_kind = first_token.as_ref().map(SyntaxToken::kind); let second_token_kind = first_token.and_then(|token| token.next_token()).as_ref().map(SyntaxToken::kind); match (first_token_kind, second_token_kind) { (Some(SyntaxKind::POUND), Some(T![!])) => AttrKind::Inner, _ => AttrKind::Outer, } } } #[derive(Debug, Clone, PartialEq, Eq)] pub enum PathSegmentKind { Name(ast::NameRef), Type { type_ref: Option, trait_ref: Option }, SelfKw, SuperKw, CrateKw, } impl ast::PathSegment { pub fn parent_path(&self) -> ast::Path { self.syntax() .parent() .and_then(ast::Path::cast) .expect("segments are always nested in paths") } pub fn kind(&self) -> Option { let res = if let Some(name_ref) = self.name_ref() { PathSegmentKind::Name(name_ref) } else { match self.syntax().first_child_or_token()?.kind() { T![self] => PathSegmentKind::SelfKw, T![super] => PathSegmentKind::SuperKw, T![crate] => PathSegmentKind::CrateKw, T![<] => { // or // T is any TypeRef, Trait has to be a PathType let mut type_refs = self.syntax().children().filter(|node| ast::TypeRef::can_cast(node.kind())); let type_ref = type_refs.next().and_then(ast::TypeRef::cast); let trait_ref = type_refs.next().and_then(ast::PathType::cast); PathSegmentKind::Type { type_ref, trait_ref } } _ => return None, } }; Some(res) } } impl ast::Path { pub fn parent_path(&self) -> Option { self.syntax().parent().and_then(ast::Path::cast) } } impl ast::UseTreeList { pub fn parent_use_tree(&self) -> ast::UseTree { self.syntax() .parent() .and_then(ast::UseTree::cast) .expect("UseTreeLists are always nested in UseTrees") } } impl ast::ImplDef { pub fn target_type(&self) -> Option { match self.target() { (Some(t), None) | (_, Some(t)) => Some(t), _ => None, } } pub fn target_trait(&self) -> Option { match self.target() { (Some(t), Some(_)) => Some(t), _ => None, } } fn target(&self) -> (Option, Option) { let mut types = support::children(self.syntax()); let first = types.next(); let second = types.next(); (first, second) } } #[derive(Debug, Clone, PartialEq, Eq)] pub enum StructKind { Record(ast::RecordFieldDefList), Tuple(ast::TupleFieldDefList), Unit, } impl StructKind { fn from_node(node: &N) -> StructKind { if let Some(nfdl) = support::child::(node.syntax()) { StructKind::Record(nfdl) } else if let Some(pfl) = support::child::(node.syntax()) { StructKind::Tuple(pfl) } else { StructKind::Unit } } } impl ast::StructDef { pub fn kind(&self) -> StructKind { StructKind::from_node(self) } } impl ast::RecordField { pub fn for_field_name(field_name: &ast::NameRef) -> Option { let candidate = field_name.syntax().parent().and_then(ast::RecordField::cast).or_else(|| { field_name.syntax().ancestors().nth(4).and_then(ast::RecordField::cast) })?; if candidate.field_name().as_ref() == Some(field_name) { Some(candidate) } else { None } } /// Deals with field init shorthand pub fn field_name(&self) -> Option { if let Some(name_ref) = self.name_ref() { return Some(name_ref); } if let Some(ast::Expr::PathExpr(expr)) = self.expr() { let path = expr.path()?; let segment = path.segment()?; let name_ref = segment.name_ref()?; if path.qualifier().is_none() { return Some(name_ref); } } None } } pub enum NameOrNameRef { Name(ast::Name), NameRef(ast::NameRef), } impl fmt::Display for NameOrNameRef { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self { NameOrNameRef::Name(it) => fmt::Display::fmt(it, f), NameOrNameRef::NameRef(it) => fmt::Display::fmt(it, f), } } } impl ast::RecordFieldPat { /// Deals with field init shorthand pub fn field_name(&self) -> Option { if let Some(name_ref) = self.name_ref() { return Some(NameOrNameRef::NameRef(name_ref)); } if let Some(ast::Pat::BindPat(pat)) = self.pat() { let name = pat.name()?; return Some(NameOrNameRef::Name(name)); } None } } impl ast::EnumVariant { pub fn parent_enum(&self) -> ast::EnumDef { self.syntax() .parent() .and_then(|it| it.parent()) .and_then(ast::EnumDef::cast) .expect("EnumVariants are always nested in Enums") } pub fn kind(&self) -> StructKind { StructKind::from_node(self) } } #[derive(Debug, Clone, PartialEq, Eq)] pub enum FieldKind { Name(ast::NameRef), Index(SyntaxToken), } impl ast::FieldExpr { pub fn index_token(&self) -> Option { self.syntax .children_with_tokens() // FIXME: Accepting floats here to reject them in validation later .find(|c| c.kind() == SyntaxKind::INT_NUMBER || c.kind() == SyntaxKind::FLOAT_NUMBER) .as_ref() .and_then(SyntaxElement::as_token) .cloned() } pub fn field_access(&self) -> Option { if let Some(nr) = self.name_ref() { Some(FieldKind::Name(nr)) } else if let Some(tok) = self.index_token() { Some(FieldKind::Index(tok)) } else { None } } } pub struct SlicePatComponents { pub prefix: Vec, pub slice: Option, pub suffix: Vec, } impl ast::SlicePat { pub fn components(&self) -> SlicePatComponents { let mut args = self.args().peekable(); let prefix = args .peeking_take_while(|p| match p { ast::Pat::DotDotPat(_) => false, ast::Pat::BindPat(bp) => match bp.pat() { Some(ast::Pat::DotDotPat(_)) => false, _ => true, }, ast::Pat::RefPat(rp) => match rp.pat() { Some(ast::Pat::DotDotPat(_)) => false, Some(ast::Pat::BindPat(bp)) => match bp.pat() { Some(ast::Pat::DotDotPat(_)) => false, _ => true, }, _ => true, }, _ => true, }) .collect(); let slice = args.next(); let suffix = args.collect(); SlicePatComponents { prefix, slice, suffix } } } #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] pub enum SelfParamKind { /// self Owned, /// &self Ref, /// &mut self MutRef, } impl ast::SelfParam { pub fn kind(&self) -> SelfParamKind { if self.amp_token().is_some() { if self.mut_token().is_some() { SelfParamKind::MutRef } else { SelfParamKind::Ref } } else { SelfParamKind::Owned } } } #[derive(Clone, Debug, PartialEq, Eq, Hash)] pub enum TypeBoundKind { /// Trait PathType(ast::PathType), /// for<'a> ... ForType(ast::ForType), /// 'a Lifetime(SyntaxToken), } impl ast::TypeBound { pub fn kind(&self) -> TypeBoundKind { if let Some(path_type) = support::children(self.syntax()).next() { TypeBoundKind::PathType(path_type) } else if let Some(for_type) = support::children(self.syntax()).next() { TypeBoundKind::ForType(for_type) } else if let Some(lifetime) = self.lifetime_token() { TypeBoundKind::Lifetime(lifetime) } else { unreachable!() } } pub fn const_question_token(&self) -> Option { self.syntax() .children_with_tokens() .filter_map(|it| it.into_token()) .take_while(|it| it.kind() != T![const]) .find(|it| it.kind() == T![?]) } pub fn question_token(&self) -> Option { if self.const_token().is_some() { self.syntax() .children_with_tokens() .filter_map(|it| it.into_token()) .skip_while(|it| it.kind() != T![const]) .find(|it| it.kind() == T![?]) } else { support::token(&self.syntax, T![?]) } } } pub enum VisibilityKind { In(ast::Path), PubCrate, PubSuper, PubSelf, Pub, } impl ast::Visibility { pub fn kind(&self) -> VisibilityKind { if let Some(path) = support::children(self.syntax()).next() { VisibilityKind::In(path) } else if self.crate_token().is_some() { VisibilityKind::PubCrate } else if self.super_token().is_some() { VisibilityKind::PubSuper } else if self.self_token().is_some() { VisibilityKind::PubSelf } else { VisibilityKind::Pub } } } impl ast::MacroCall { pub fn is_macro_rules(&self) -> Option { let name_ref = self.path()?.segment()?.name_ref()?; if name_ref.text() == "macro_rules" { self.name() } else { None } } pub fn is_bang(&self) -> bool { self.is_macro_rules().is_none() } } impl ast::LifetimeParam { pub fn lifetime_bounds(&self) -> impl Iterator { self.syntax() .children_with_tokens() .filter_map(|it| it.into_token()) .skip_while(|x| x.kind() != T![:]) .filter(|it| it.kind() == T![lifetime]) } } impl ast::RangePat { pub fn start(&self) -> Option { self.syntax() .children_with_tokens() .take_while(|it| !(it.kind() == T![..] || it.kind() == T![..=])) .filter_map(|it| it.into_node()) .find_map(ast::Pat::cast) } pub fn end(&self) -> Option { self.syntax() .children_with_tokens() .skip_while(|it| !(it.kind() == T![..] || it.kind() == T![..=])) .filter_map(|it| it.into_node()) .find_map(ast::Pat::cast) } } impl ast::TokenTree { pub fn left_delimiter_token(&self) -> Option { self.syntax() .first_child_or_token()? .into_token() .filter(|it| matches!(it.kind(), T!['{'] | T!['('] | T!['['])) } pub fn right_delimiter_token(&self) -> Option { self.syntax() .last_child_or_token()? .into_token() .filter(|it| matches!(it.kind(), T!['}'] | T![')'] | T![']'])) } } impl ast::DocCommentsOwner for ast::SourceFile {} impl ast::DocCommentsOwner for ast::Fn {} impl ast::DocCommentsOwner for ast::StructDef {} impl ast::DocCommentsOwner for ast::UnionDef {} impl ast::DocCommentsOwner for ast::RecordFieldDef {} impl ast::DocCommentsOwner for ast::TupleFieldDef {} impl ast::DocCommentsOwner for ast::EnumDef {} impl ast::DocCommentsOwner for ast::EnumVariant {} impl ast::DocCommentsOwner for ast::TraitDef {} impl ast::DocCommentsOwner for ast::Module {} impl ast::DocCommentsOwner for ast::StaticDef {} impl ast::DocCommentsOwner for ast::ConstDef {} impl ast::DocCommentsOwner for ast::TypeAliasDef {} impl ast::DocCommentsOwner for ast::ImplDef {} impl ast::DocCommentsOwner for ast::MacroCall {}