From bb56b7a75cfae8297535d55fbddbee9875cbc756 Mon Sep 17 00:00:00 2001 From: Lukas Wirth Date: Tue, 30 Mar 2021 18:27:16 +0200 Subject: Use new new docs string source mapping in goto_def and hover --- crates/ide/src/doc_links.rs | 117 ++++++++++----------------- crates/ide/src/goto_definition.rs | 19 +++-- crates/ide/src/hover.rs | 21 +++-- crates/ide/src/syntax_highlighting/inject.rs | 35 +------- 4 files changed, 73 insertions(+), 119 deletions(-) diff --git a/crates/ide/src/doc_links.rs b/crates/ide/src/doc_links.rs index 69442278b..9a9a41113 100644 --- a/crates/ide/src/doc_links.rs +++ b/crates/ide/src/doc_links.rs @@ -15,10 +15,7 @@ use ide_db::{ defs::{Definition, NameClass, NameRefClass}, RootDatabase, }; -use syntax::{ - ast, match_ast, AstNode, AstToken, SyntaxKind::*, SyntaxNode, SyntaxToken, TextRange, TextSize, - TokenAtOffset, T, -}; +use syntax::{ast, match_ast, AstNode, SyntaxKind::*, SyntaxNode, SyntaxToken, TokenAtOffset, T}; use crate::{FilePosition, Semantics}; @@ -119,77 +116,22 @@ pub(crate) fn external_docs( pub(crate) fn extract_definitions_from_markdown( markdown: &str, ) -> Vec<(Range, String, Option)> { - extract_definitions_from_markdown_(markdown, &mut broken_link_clone_cb).collect() -} - -fn extract_definitions_from_markdown_<'a>( - markdown: &'a str, - cb: &'a mut dyn FnMut(BrokenLink<'_>) -> Option<(CowStr<'a>, CowStr<'a>)>, -) -> impl Iterator, String, Option)> + 'a { - Parser::new_with_broken_link_callback(markdown, Options::empty(), Some(cb)) - .into_offset_iter() - .filter_map(|(event, range)| { - if let Event::Start(Tag::Link(_, target, title)) = event { - let link = if target.is_empty() { title } else { target }; - let (link, ns) = parse_intra_doc_link(&link); - Some((range, link.to_string(), ns)) - } else { - None - } - }) -} - -/// Extracts a link from a comment at the given position returning the spanning range, link and -/// optionally it's namespace. -pub(crate) fn extract_positioned_link_from_comment( - position: TextSize, - comment: &ast::Comment, - docs: hir::Documentation, -) -> Option<(TextRange, String, Option)> { - let doc_comment = comment.doc_comment()?.to_string() + "\n" + docs.as_str(); - let comment_start = - comment.syntax().text_range().start() + TextSize::from(comment.prefix().len() as u32); - let len = comment.syntax().text_range().len().into(); - let mut cb = broken_link_clone_cb; - // because pulldown_cmarks lifetimes are wrong we gotta dance around a few temporaries here - let res = extract_definitions_from_markdown_(&doc_comment, &mut cb) - .take_while(|&(Range { end, .. }, ..)| end < len) - .find_map(|(Range { start, end }, def_link, ns)| { - let range = TextRange::at( - comment_start + TextSize::from(start as u32), - TextSize::from((end - start) as u32), - ); - range.contains(position).then(|| (range, def_link, ns)) - }); - res -} - -/// Turns a syntax node into it's [`Definition`] if it can hold docs. -pub(crate) fn doc_owner_to_def( - sema: &Semantics, - item: &SyntaxNode, -) -> Option { - let res: hir::ModuleDef = match_ast! { - match item { - ast::SourceFile(_it) => sema.scope(item).module()?.into(), - ast::Fn(it) => sema.to_def(&it)?.into(), - ast::Struct(it) => sema.to_def(&it)?.into(), - ast::Enum(it) => sema.to_def(&it)?.into(), - ast::Union(it) => sema.to_def(&it)?.into(), - ast::Trait(it) => sema.to_def(&it)?.into(), - ast::Const(it) => sema.to_def(&it)?.into(), - ast::Static(it) => sema.to_def(&it)?.into(), - ast::TypeAlias(it) => sema.to_def(&it)?.into(), - ast::Variant(it) => sema.to_def(&it)?.into(), - ast::Trait(it) => sema.to_def(&it)?.into(), - ast::Impl(it) => return sema.to_def(&it).map(Definition::SelfType), - ast::Macro(it) => return sema.to_def(&it).map(Definition::Macro), - ast::TupleField(it) => return sema.to_def(&it).map(Definition::Field), - ast::RecordField(it) => return sema.to_def(&it).map(Definition::Field), - _ => return None, + Parser::new_with_broken_link_callback( + markdown, + Options::empty(), + Some(&mut broken_link_clone_cb), + ) + .into_offset_iter() + .filter_map(|(event, range)| { + if let Event::Start(Tag::Link(_, target, title)) = event { + let link = if target.is_empty() { title } else { target }; + let (link, ns) = parse_intra_doc_link(&link); + Some((range, link.to_string(), ns)) + } else { + None } - }; - Some(Definition::ModuleDef(res)) + }) + .collect() } pub(crate) fn resolve_doc_path_for_def( @@ -219,6 +161,33 @@ pub(crate) fn resolve_doc_path_for_def( } } +pub(crate) fn doc_attributes( + sema: &Semantics, + node: &SyntaxNode, +) -> Option<(hir::AttrsWithOwner, Definition)> { + match_ast! { + match node { + ast::SourceFile(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::Module(def)))), + ast::Module(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::Module(def)))), + ast::Fn(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::Function(def)))), + ast::Struct(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::Adt(hir::Adt::Struct(def))))), + ast::Union(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::Adt(hir::Adt::Union(def))))), + ast::Enum(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::Adt(hir::Adt::Enum(def))))), + ast::Variant(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::Variant(def)))), + ast::Trait(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::Trait(def)))), + ast::Static(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::Static(def)))), + ast::Const(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::Const(def)))), + ast::TypeAlias(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::TypeAlias(def)))), + ast::Impl(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::SelfType(def))), + ast::RecordField(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::Field(def))), + ast::TupleField(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::Field(def))), + ast::Macro(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::Macro(def))), + // ast::Use(it) => sema.to_def(&it).map(|def| (Box::new(it) as _, def.attrs(sema.db))), + _ => return None + } + } +} + fn broken_link_clone_cb<'a, 'b>(link: BrokenLink<'a>) -> Option<(CowStr<'b>, CowStr<'b>)> { // These allocations are actually unnecessary but the lifetimes on BrokenLinkCallback are wrong // this is fixed in the repo but not on the crates.io release yet diff --git a/crates/ide/src/goto_definition.rs b/crates/ide/src/goto_definition.rs index 1951c599f..780bdd40d 100644 --- a/crates/ide/src/goto_definition.rs +++ b/crates/ide/src/goto_definition.rs @@ -1,5 +1,5 @@ use either::Either; -use hir::Semantics; +use hir::{InFile, Semantics}; use ide_db::{ defs::{NameClass, NameRefClass}, RootDatabase, @@ -8,7 +8,7 @@ use syntax::{ast, match_ast, AstNode, AstToken, SyntaxKind::*, SyntaxToken, Toke use crate::{ display::TryToNav, - doc_links::{doc_owner_to_def, extract_positioned_link_from_comment, resolve_doc_path_for_def}, + doc_links::{doc_attributes, extract_definitions_from_markdown, resolve_doc_path_for_def}, FilePosition, NavigationTarget, RangeInfo, }; @@ -30,11 +30,16 @@ pub(crate) fn goto_definition( let original_token = pick_best(file.token_at_offset(position.offset))?; let token = sema.descend_into_macros(original_token.clone()); let parent = token.parent()?; - if let Some(comment) = ast::Comment::cast(token) { - let docs = doc_owner_to_def(&sema, &parent)?.docs(db)?; - - let (_, link, ns) = extract_positioned_link_from_comment(position.offset, &comment, docs)?; - let def = doc_owner_to_def(&sema, &parent)?; + if let Some(_) = ast::Comment::cast(token) { + let (attributes, def) = doc_attributes(&sema, &parent)?; + + let (docs, doc_mapping) = attributes.docs_with_rangemap(db)?; + let (_, link, ns) = + extract_definitions_from_markdown(docs.as_str()).into_iter().find(|(range, ..)| { + doc_mapping.map(range.clone()).map_or(false, |InFile { file_id, value: range }| { + file_id == position.file_id.into() && range.contains(position.offset) + }) + })?; let nav = resolve_doc_path_for_def(db, def, &link, ns)?.try_to_nav(db)?; return Some(RangeInfo::new(original_token.text_range(), vec![nav])); } diff --git a/crates/ide/src/hover.rs b/crates/ide/src/hover.rs index 5a497e92d..1e66219e4 100644 --- a/crates/ide/src/hover.rs +++ b/crates/ide/src/hover.rs @@ -1,6 +1,6 @@ use either::Either; use hir::{ - AsAssocItem, AssocItemContainer, GenericParam, HasAttrs, HasSource, HirDisplay, Module, + AsAssocItem, AssocItemContainer, GenericParam, HasAttrs, HasSource, HirDisplay, InFile, Module, ModuleDef, Semantics, }; use ide_db::{ @@ -16,8 +16,8 @@ use syntax::{ast, match_ast, AstNode, AstToken, SyntaxKind::*, SyntaxToken, Toke use crate::{ display::{macro_label, TryToNav}, doc_links::{ - doc_owner_to_def, extract_positioned_link_from_comment, remove_links, - resolve_doc_path_for_def, rewrite_links, + doc_attributes, extract_definitions_from_markdown, remove_links, resolve_doc_path_for_def, + rewrite_links, }, markdown_remove::remove_markdown, markup::Markup, @@ -114,11 +114,18 @@ pub(crate) fn hover( ), _ => ast::Comment::cast(token.clone()) - .and_then(|comment| { - let def = doc_owner_to_def(&sema, &node)?; - let docs = def.docs(db)?; + .and_then(|_| { + let (attributes, def) = doc_attributes(&sema, &node)?; + let (docs, doc_mapping) = attributes.docs_with_rangemap(db)?; let (idl_range, link, ns) = - extract_positioned_link_from_comment(position.offset, &comment, docs)?; + extract_definitions_from_markdown(docs.as_str()).into_iter().find_map(|(range, link, ns)| { + let InFile { file_id, value: range } = doc_mapping.map(range.clone())?; + if file_id == position.file_id.into() && range.contains(position.offset) { + Some((range, link, ns)) + } else { + None + } + })?; range = Some(idl_range); resolve_doc_path_for_def(db, def, &link, ns) }) diff --git a/crates/ide/src/syntax_highlighting/inject.rs b/crates/ide/src/syntax_highlighting/inject.rs index 504783f31..04fafd244 100644 --- a/crates/ide/src/syntax_highlighting/inject.rs +++ b/crates/ide/src/syntax_highlighting/inject.rs @@ -3,15 +3,15 @@ use std::mem; use either::Either; -use hir::{HasAttrs, InFile, Semantics}; -use ide_db::{call_info::ActiveParameter, defs::Definition, SymbolKind}; +use hir::{InFile, Semantics}; +use ide_db::{call_info::ActiveParameter, SymbolKind}; use syntax::{ ast::{self, AstNode}, - match_ast, AstToken, NodeOrToken, SyntaxNode, SyntaxToken, TextRange, TextSize, + AstToken, NodeOrToken, SyntaxNode, SyntaxToken, TextRange, TextSize, }; use crate::{ - doc_links::{extract_definitions_from_markdown, resolve_doc_path_for_def}, + doc_links::{doc_attributes, extract_definitions_from_markdown, resolve_doc_path_for_def}, Analysis, HlMod, HlRange, HlTag, RootDatabase, }; @@ -90,33 +90,6 @@ const RUSTDOC_FENCE_TOKENS: &[&'static str] = &[ "edition2021", ]; -fn doc_attributes<'node>( - sema: &Semantics, - node: &'node SyntaxNode, -) -> Option<(hir::AttrsWithOwner, Definition)> { - match_ast! { - match node { - ast::SourceFile(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::Module(def)))), - ast::Module(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::Module(def)))), - ast::Fn(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::Function(def)))), - ast::Struct(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::Adt(hir::Adt::Struct(def))))), - ast::Union(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::Adt(hir::Adt::Union(def))))), - ast::Enum(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::Adt(hir::Adt::Enum(def))))), - ast::Variant(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::Variant(def)))), - ast::Trait(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::Trait(def)))), - ast::Static(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::Static(def)))), - ast::Const(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::Const(def)))), - ast::TypeAlias(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::ModuleDef(hir::ModuleDef::TypeAlias(def)))), - ast::Impl(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::SelfType(def))), - ast::RecordField(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::Field(def))), - ast::TupleField(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::Field(def))), - ast::Macro(it) => sema.to_def(&it).map(|def| (def.attrs(sema.db), Definition::Macro(def))), - // ast::Use(it) => sema.to_def(&it).map(|def| (Box::new(it) as _, def.attrs(sema.db))), - _ => return None - } - } -} - /// Injection of syntax highlighting of doctests. pub(super) fn doc_comment( hl: &mut Highlights, -- cgit v1.2.3