fix: handle escaped chars in doc comments

Author: roife

crates/hir-def/src/attr.rs

@@ -5,7 +5,7 @@ pub mod builtin;
 #[cfg(test)]
 mod tests;
 
-use std::{hash::Hash, ops, slice::IterasSliceIter};
+use std::{borrow::Cow,hash::Hash, ops, slice::IterasSliceIter};
 
 use base_db::CrateId;
 use cfg::{CfgExpr,CfgOptions};
@@ -573,6 +573,10 @@ impl<'attr> AttrQuery<'attr> {
 self.attrs().find_map(|attr| attr.string_value())
 }
 
+pubfnstring_value_unescape(self) -> Option<Cow<'attr,str>>{
+self.attrs().find_map(|attr| attr.string_value_unescape())
+}
+
 pubfnexists(self) -> bool{
 self.attrs().next().is_some()
 }

crates/hir-def/src/nameres/collector.rs

@@ -1917,7 +1917,7 @@ impl ModCollector<'_, '_> {
 }
 
 fncollect_module(&mutself,module_id:FileItemTreeId<Mod>,attrs:&Attrs){
-let path_attr = attrs.by_key("path").string_value();
+let path_attr = attrs.by_key("path").string_value_unescape();
 let is_macro_use = attrs.by_key("macro_use").exists();
 let module = &self.item_tree[module_id];
 match&module.kind{
@@ -1931,7 +1931,8 @@ impl ModCollector<'_, '_> {
  module_id,
 );
 
-letSome(mod_dir) = self.mod_dir.descend_into_definition(&module.name, path_attr)
+letSome(mod_dir) =
+self.mod_dir.descend_into_definition(&module.name, path_attr.as_deref())
 else{
 return;
 };
@@ -1952,8 +1953,12 @@ impl ModCollector<'_, '_> {
 ModKind::Outline => {
 let ast_id = AstId::new(self.file_id(), module.ast_id);
 let db = self.def_collector.db;
-matchself.mod_dir.resolve_declaration(db,self.file_id(),&module.name, path_attr)
-{
+matchself.mod_dir.resolve_declaration(
+ db,
+self.file_id(),
+&module.name,
+ path_attr.as_deref(),
+){
 Ok((file_id, is_mod_rs, mod_dir)) => {
 let item_tree = db.file_item_tree(file_id.into());
 let krate = self.def_collector.def_map.krate;

crates/hir-expand/src/attrs.rs

@@ -1,5 +1,5 @@
 //! A higher level attributes based on TokenTree, with also some shortcuts.
-use std::{fmt, ops};
+use std::{borrow::Cow,fmt, ops};
 
 use base_db::CrateId;
 use cfg::CfgExpr;
@@ -297,6 +297,20 @@ impl Attr {
 }
 }
 
+pubfnstring_value_unescape(&self) -> Option<Cow<'_,str>>{
+matchself.input.as_deref()? {
+AttrInput::Literal(it) => match it.text.strip_prefix('r'){
+Some(it) => {
+ it.trim_matches('#').strip_prefix('"')?.strip_suffix('"').map(Cow::Borrowed)
+}
+None => {
+ it.text.strip_prefix('"')?.strip_suffix('"').and_then(unescape).map(Cow::Owned)
+}
+},
+ _ => None,
+}
+}
+
 /// #[path(ident)]
 pubfnsingle_ident_value(&self) -> Option<&tt::Ident>{
 matchself.input.as_deref()? {
@@ -346,6 +360,39 @@ impl Attr {
 }
 }
 
+fnunescape(s:&str) -> Option<String>{
+letmut res = String::with_capacity(s.len());
+letmut chars = s.chars();
+
+whileletSome(c) = chars.next(){
+if c == '\\'{
+match chars.next()? {
+'n' => res.push('\n'),
+'r' => res.push('\r'),
+'t' => res.push('\t'),
+'\\' => res.push('\\'),
+'\'' => res.push('\''),
+'"' => res.push('"'),
+'0' => res.push('\0'),
+'x' => {
+let hex = chars.by_ref().take(2).collect::<String>();
+let c = u8::from_str_radix(&hex,16).ok()?;
+ res.push(c aschar);
+}
+'u' => {
+let hex = chars.by_ref().take(4).collect::<String>();
+let c = u32::from_str_radix(&hex,16).ok()?;
+ res.push(char::from_u32(c)?);
+}
+ _ => returnNone,
+}
+}else{
+ res.push(c);
+}
+}
+Some(res)
+}
+
 pubfncollect_attrs(
 owner:&dyn ast::HasAttrs,
 ) -> implIterator<Item = (AttrId,Either<ast::Attr, ast::Comment>)>{

crates/ide-db/src/documentation.rs

@@ -91,8 +91,10 @@ pub fn docs_with_rangemap(
 db:&dynDefDatabase,
 attrs:&AttrsWithOwner,
 ) -> Option<(Documentation,DocsRangeMap)>{
-let docs =
- attrs.by_key("doc").attrs().filter_map(|attr| attr.string_value().map(|s| (s, attr.id)));
+let docs = attrs
+.by_key("doc")
+.attrs()
+.filter_map(|attr| attr.string_value_unescape().map(|s| (s, attr.id)));
 let indent = doc_indent(attrs);
 letmut buf = String::new();
 letmut mapping = Vec::new();
@@ -132,7 +134,7 @@ pub fn docs_with_rangemap(
 }
 
 pubfndocs_from_attrs(attrs:&hir::Attrs) -> Option<String>{
-let docs = attrs.by_key("doc").attrs().filter_map(|attr| attr.string_value());
+let docs = attrs.by_key("doc").attrs().filter_map(|attr| attr.string_value_unescape());
 let indent = doc_indent(attrs);
 letmut buf = String::new();
 for doc in docs {
@@ -270,10 +272,9 @@ fn doc_indent(attrs: &hir::Attrs) -> usize {
  attrs
 .by_key("doc")
 .attrs()
-.filter_map(|attr| attr.string_value())
+.filter_map(|attr| attr.string_value())// no need to use unescape version here
 .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())
+.filter_map(|line| line.chars().position(|c| !c.is_whitespace()))
 .min()
 .unwrap_or(0)
 }