From 9df78ec4a4e41ca94b25f292aba90e266f104f02 Mon Sep 17 00:00:00 2001 From: Lukas Wirth Date: Mon, 29 Mar 2021 21:23:45 +0200 Subject: Properly resolve intra doc links in hover and goto_definition --- crates/ide/src/doc_links.rs | 68 +++++++++++++++++++++++++-------------------- 1 file changed, 38 insertions(+), 30 deletions(-) (limited to 'crates/ide/src/doc_links.rs') diff --git a/crates/ide/src/doc_links.rs b/crates/ide/src/doc_links.rs index 99276168f..69442278b 100644 --- a/crates/ide/src/doc_links.rs +++ b/crates/ide/src/doc_links.rs @@ -26,12 +26,7 @@ pub(crate) type DocumentationLink = String; /// Rewrite documentation links in markdown to point to an online host (e.g. docs.rs) pub(crate) fn rewrite_links(db: &RootDatabase, markdown: &str, definition: &Definition) -> String { - let mut cb = |link: BrokenLink| { - Some(( - /*url*/ link.reference.to_owned().into(), - /*title*/ link.reference.to_owned().into(), - )) - }; + let mut cb = broken_link_clone_cb; let doc = Parser::new_with_broken_link_callback(markdown, Options::empty(), Some(&mut cb)); let doc = map_links(doc, |target, title: &str| { @@ -124,24 +119,24 @@ pub(crate) fn external_docs( pub(crate) fn extract_definitions_from_markdown( markdown: &str, ) -> Vec<(Range, String, Option)> { - let mut res = vec![]; - let mut cb = |link: BrokenLink| { - // 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 - Some(( - /*url*/ link.reference.to_owned().into(), - /*title*/ link.reference.to_owned().into(), - )) - }; - let doc = Parser::new_with_broken_link_callback(markdown, Options::empty(), Some(&mut cb)); - for (event, range) in doc.into_offset_iter() { - 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); - res.push((range, link.to_string(), ns)); - } - } - res + 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 @@ -149,20 +144,24 @@ pub(crate) fn extract_definitions_from_markdown( 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()?; + 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 def_links = extract_definitions_from_markdown(doc_comment); - let (range, def_link, ns) = - def_links.into_iter().find_map(|(Range { start, end }, def_link, ns)| { + 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)) - })?; - Some((range, def_link, ns)) + }); + res } /// Turns a syntax node into it's [`Definition`] if it can hold docs. @@ -220,6 +219,15 @@ pub(crate) fn resolve_doc_path_for_def( } } +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 + Some(( + /*url*/ link.reference.to_owned().into(), + /*title*/ link.reference.to_owned().into(), + )) +} + // FIXME: // BUG: For Option::Some // Returns https://doc.rust-lang.org/nightly/core/prelude/v1/enum.Option.html#variant.Some -- cgit v1.2.3 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 ++++++++++++++++---------------------------- 1 file changed, 43 insertions(+), 74 deletions(-) (limited to 'crates/ide/src/doc_links.rs') 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 -- cgit v1.2.3 From 8d786dc4c3ce26dbb3432023c7461bd879993bfd Mon Sep 17 00:00:00 2001 From: Lukas Wirth Date: Tue, 30 Mar 2021 22:26:03 +0200 Subject: Replace Range usage with TextRange --- crates/ide/src/doc_links.rs | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) (limited to 'crates/ide/src/doc_links.rs') diff --git a/crates/ide/src/doc_links.rs b/crates/ide/src/doc_links.rs index 9a9a41113..2edd551cb 100644 --- a/crates/ide/src/doc_links.rs +++ b/crates/ide/src/doc_links.rs @@ -1,6 +1,9 @@ //! Extracts, resolves and rewrites links and intra-doc links in markdown documentation. -use std::{convert::TryFrom, iter::once, ops::Range}; +use std::{ + convert::{TryFrom, TryInto}, + iter::once, +}; use itertools::Itertools; use pulldown_cmark::{BrokenLink, CowStr, Event, InlineStr, LinkType, Options, Parser, Tag}; @@ -15,7 +18,9 @@ use ide_db::{ defs::{Definition, NameClass, NameRefClass}, RootDatabase, }; -use syntax::{ast, match_ast, AstNode, SyntaxKind::*, SyntaxNode, SyntaxToken, TokenAtOffset, T}; +use syntax::{ + ast, match_ast, AstNode, SyntaxKind::*, SyntaxNode, SyntaxToken, TextRange, TokenAtOffset, T, +}; use crate::{FilePosition, Semantics}; @@ -115,7 +120,7 @@ pub(crate) fn external_docs( /// Extracts all links from a given markdown text. pub(crate) fn extract_definitions_from_markdown( markdown: &str, -) -> Vec<(Range, String, Option)> { +) -> Vec<(TextRange, String, Option)> { Parser::new_with_broken_link_callback( markdown, Options::empty(), @@ -126,7 +131,11 @@ pub(crate) fn extract_definitions_from_markdown( 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)) + Some(( + TextRange::new(range.start.try_into().ok()?, range.end.try_into().ok()?), + link.to_string(), + ns, + )) } else { None } -- cgit v1.2.3