From 9a327311e4a9b9102528751e052c63266c00c6bd Mon Sep 17 00:00:00 2001 From: Lukas Wirth Date: Tue, 30 Mar 2021 17:20:43 +0200 Subject: Implement basic Documentation source to syntax range mapping --- crates/hir_def/src/attr.rs | 109 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 107 insertions(+), 2 deletions(-) (limited to 'crates/hir_def') diff --git a/crates/hir_def/src/attr.rs b/crates/hir_def/src/attr.rs index 52a2bce9b..7791402c9 100644 --- a/crates/hir_def/src/attr.rs +++ b/crates/hir_def/src/attr.rs @@ -1,6 +1,10 @@ //! A higher level attributes based on TokenTree, with also some shortcuts. -use std::{ops, sync::Arc}; +use std::{ + cmp::Ordering, + ops::{self, Range}, + sync::Arc, +}; use base_db::CrateId; use cfg::{CfgExpr, CfgOptions}; @@ -12,7 +16,7 @@ use mbe::ast_to_token_tree; use smallvec::{smallvec, SmallVec}; use syntax::{ ast::{self, AstNode, AttrsOwner}, - match_ast, AstToken, SmolStr, SyntaxNode, + match_ast, AstToken, SmolStr, SyntaxNode, TextRange, TextSize, }; use tt::Subtree; @@ -451,6 +455,54 @@ impl AttrsWithOwner { .collect(), } } + + pub fn docs_with_rangemap( + &self, + db: &dyn DefDatabase, + ) -> Option<(Documentation, DocsRangeMap)> { + // FIXME: code duplication in `docs` above + let docs = self.by_key("doc").attrs().flat_map(|attr| match attr.input.as_ref()? { + AttrInput::Literal(s) => Some((s, attr.index)), + AttrInput::TokenTree(_) => None, + }); + let indent = docs + .clone() + .flat_map(|(s, _)| s.lines()) + .filter(|line| !line.chars().all(|c| c.is_whitespace())) + .map(|line| line.chars().take_while(|c| c.is_whitespace()).count()) + .min() + .unwrap_or(0); + let mut buf = String::new(); + let mut mapping = Vec::new(); + for (doc, idx) in docs { + // str::lines doesn't yield anything for the empty string + if !doc.is_empty() { + for line in doc.split('\n') { + let line = line.trim_end(); + let (offset, line) = match line.char_indices().nth(indent) { + Some((offset, _)) => (offset, &line[offset..]), + None => (0, line), + }; + let buf_offset = buf.len(); + buf.push_str(line); + mapping.push(( + Range { start: buf_offset, end: buf.len() }, + idx, + Range { start: offset, end: line.len() }, + )); + buf.push('\n'); + } + } else { + buf.push('\n'); + } + } + buf.pop(); + if buf.is_empty() { + None + } else { + Some((Documentation(buf), DocsRangeMap { mapping, source: self.source_map(db).attrs })) + } + } } fn inner_attributes( @@ -507,6 +559,59 @@ impl AttrSourceMap { } } +/// A struct to map text ranges from [`Documentation`] back to TextRanges in the syntax tree. +pub struct DocsRangeMap { + source: Vec>>, + // (docstring-line-range, attr_index, attr-string-range) + // a mapping from the text range of a line of the [`Documentation`] to the attribute index and + // the original (untrimmed) syntax doc line + mapping: Vec<(Range, u32, Range)>, +} + +impl DocsRangeMap { + pub fn map(&self, range: Range) -> Option> { + let found = self + .mapping + .binary_search_by(|(probe, ..)| { + if probe.contains(&range.start) { + Ordering::Equal + } else { + probe.start.cmp(&range.end) + } + }) + .ok()?; + let (line_docs_range, idx, original_line_src_range) = self.mapping[found].clone(); + if range.end > line_docs_range.end { + return None; + } + + let relative_range = Range { + start: range.start - line_docs_range.start, + end: range.end - line_docs_range.start, + }; + let range_len = TextSize::from((range.end - range.start) as u32); + + let &InFile { file_id, value: ref source } = &self.source[idx as usize]; + match source { + Either::Left(_) => None, // FIXME, figure out a nice way to handle doc attributes here + // as well as for whats done in syntax highlight doc injection + Either::Right(comment) => { + let text_range = comment.syntax().text_range(); + let range = TextRange::at( + text_range.start() + + TextSize::from( + (comment.prefix().len() + + original_line_src_range.start + + relative_range.start) as u32, + ), + text_range.len().min(range_len), + ); + Some(InFile { file_id, value: range }) + } + } + } +} + #[derive(Debug, Clone, PartialEq, Eq)] pub struct Attr { index: u32, -- 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/hir_def/src/attr.rs | 42 ++++++++++++++---------------------------- 1 file changed, 14 insertions(+), 28 deletions(-) (limited to 'crates/hir_def') diff --git a/crates/hir_def/src/attr.rs b/crates/hir_def/src/attr.rs index 7791402c9..74bb6de35 100644 --- a/crates/hir_def/src/attr.rs +++ b/crates/hir_def/src/attr.rs @@ -1,8 +1,8 @@ //! A higher level attributes based on TokenTree, with also some shortcuts. use std::{ - cmp::Ordering, - ops::{self, Range}, + convert::{TryFrom, TryInto}, + ops, sync::Arc, }; @@ -479,6 +479,7 @@ impl AttrsWithOwner { if !doc.is_empty() { for line in doc.split('\n') { let line = line.trim_end(); + let line_len = line.len(); let (offset, line) = match line.char_indices().nth(indent) { Some((offset, _)) => (offset, &line[offset..]), None => (0, line), @@ -486,9 +487,9 @@ impl AttrsWithOwner { let buf_offset = buf.len(); buf.push_str(line); mapping.push(( - Range { start: buf_offset, end: buf.len() }, + TextRange::new(buf_offset.try_into().ok()?, buf.len().try_into().ok()?), idx, - Range { start: offset, end: line.len() }, + TextRange::new(offset.try_into().ok()?, line_len.try_into().ok()?), )); buf.push('\n'); } @@ -565,31 +566,18 @@ pub struct DocsRangeMap { // (docstring-line-range, attr_index, attr-string-range) // a mapping from the text range of a line of the [`Documentation`] to the attribute index and // the original (untrimmed) syntax doc line - mapping: Vec<(Range, u32, Range)>, + mapping: Vec<(TextRange, u32, TextRange)>, } impl DocsRangeMap { - pub fn map(&self, range: Range) -> Option> { - let found = self - .mapping - .binary_search_by(|(probe, ..)| { - if probe.contains(&range.start) { - Ordering::Equal - } else { - probe.start.cmp(&range.end) - } - }) - .ok()?; + pub fn map(&self, range: TextRange) -> Option> { + let found = self.mapping.binary_search_by(|(probe, ..)| probe.ordering(range)).ok()?; let (line_docs_range, idx, original_line_src_range) = self.mapping[found].clone(); - if range.end > line_docs_range.end { + if !line_docs_range.contains_range(range) { return None; } - let relative_range = Range { - start: range.start - line_docs_range.start, - end: range.end - line_docs_range.start, - }; - let range_len = TextSize::from((range.end - range.start) as u32); + let relative_range = range - line_docs_range.start(); let &InFile { file_id, value: ref source } = &self.source[idx as usize]; match source { @@ -599,12 +587,10 @@ impl DocsRangeMap { let text_range = comment.syntax().text_range(); let range = TextRange::at( text_range.start() - + TextSize::from( - (comment.prefix().len() - + original_line_src_range.start - + relative_range.start) as u32, - ), - text_range.len().min(range_len), + + TextSize::try_from(comment.prefix().len()).ok()? + + original_line_src_range.start() + + relative_range.start(), + text_range.len().min(range.len()), ); Some(InFile { file_id, value: range }) } -- cgit v1.2.3