crates/ide/src/syntax_highlighting/inject.rs

   1 //! "Recursive" Syntax highlighting for code in doctests and fixtures.
   2
   3 use std::mem;
   4
   5 use either::Either;
   6 use hir::{InFile, Semantics};
   7 use ide_db::{call_info::ActiveParameter, SymbolKind};
   8 use syntax::{
   9     ast::{self, AstNode},
  10     AstToken, NodeOrToken, SyntaxNode, SyntaxToken, TextRange, TextSize,
  11 };
  12
  13 use crate::{
  14     doc_links::{doc_attributes, extract_definitions_from_markdown, resolve_doc_path_for_def},
  15     Analysis, HlMod, HlRange, HlTag, RootDatabase,
  16 };
  17
  18 use super::{highlights::Highlights, injector::Injector};
  19
  20 pub(super) fn ra_fixture(
  21     hl: &mut Highlights,
  22     sema: &Semantics<RootDatabase>,
  23     literal: ast::String,
  24     expanded: SyntaxToken,
  25 ) -> Option<()> {
  26     let active_parameter = ActiveParameter::at_token(&sema, expanded)?;
  27     if !active_parameter.ident().map_or(false, |name| name.text().starts_with("ra_fixture")) {
  28         return None;
  29     }
  30     let value = literal.value()?;
  31
  32     if let Some(range) = literal.open_quote_text_range() {
  33         hl.add(HlRange { range, highlight: HlTag::StringLiteral.into(), binding_hash: None })
  34     }
  35
  36     let mut inj = Injector::default();
  37
  38     let mut text = &*value;
  39     let mut offset: TextSize = 0.into();
  40
  41     while !text.is_empty() {
  42         let marker = "$0";
  43         let idx = text.find(marker).unwrap_or(text.len());
  44         let (chunk, next) = text.split_at(idx);
  45         inj.add(chunk, TextRange::at(offset, TextSize::of(chunk)));
  46
  47         text = next;
  48         offset += TextSize::of(chunk);
  49
  50         if let Some(next) = text.strip_prefix(marker) {
  51             if let Some(range) = literal.map_range_up(TextRange::at(offset, TextSize::of(marker))) {
  52                 hl.add(HlRange { range, highlight: HlTag::Keyword.into(), binding_hash: None });
  53             }
  54
  55             text = next;
  56
  57             let marker_len = TextSize::of(marker);
  58             offset += marker_len;
  59         }
  60     }
  61
  62     let (analysis, tmp_file_id) = Analysis::from_single_file(inj.text().to_string());
  63
  64     for mut hl_range in analysis.highlight(tmp_file_id).unwrap() {
  65         for range in inj.map_range_up(hl_range.range) {
  66             if let Some(range) = literal.map_range_up(range) {
  67                 hl_range.range = range;
  68                 hl.add(hl_range);
  69             }
  70         }
  71     }
  72
  73     if let Some(range) = literal.close_quote_text_range() {
  74         hl.add(HlRange { range, highlight: HlTag::StringLiteral.into(), binding_hash: None })
  75     }
  76
  77     Some(())
  78 }
  79
  80 const RUSTDOC_FENCE: &'static str = "```";
  81 const RUSTDOC_FENCE_TOKENS: &[&'static str] = &[
  82     "",
  83     "rust",
  84     "should_panic",
  85     "ignore",
  86     "no_run",
  87     "compile_fail",
  88     "edition2015",
  89     "edition2018",
  90     "edition2021",
  91 ];
  92
  93 fn is_rustdoc_fence_token(token: &str) -> bool {
  94     if RUSTDOC_FENCE_TOKENS.contains(&token) {
  95         return true;
  96     }
  97     token.starts_with('E') && token.len() == 5 && token[1..].parse::<u32>().is_ok()
  98 }
  99
 100 /// Injection of syntax highlighting of doctests.
 101 pub(super) fn doc_comment(
 102     hl: &mut Highlights,
 103     sema: &Semantics<RootDatabase>,
 104     node: InFile<&SyntaxNode>,
 105 ) {
 106     let (attributes, def) = match doc_attributes(sema, node.value) {
 107         Some(it) => it,
 108         None => return,
 109     };
 110
 111     let mut inj = Injector::default();
 112     inj.add_unmapped("fn doctest() {\n");
 113
 114     let attrs_source_map = attributes.source_map(sema.db);
 115
 116     let mut is_codeblock = false;
 117     let mut is_doctest = false;
 118
 119     // Replace the original, line-spanning comment ranges by new, only comment-prefix
 120     // spanning comment ranges.
 121     let mut new_comments = Vec::new();
 122     let mut string;
 123
 124     if let Some((docs, doc_mapping)) = attributes.docs_with_rangemap(sema.db) {
 125         extract_definitions_from_markdown(docs.as_str())
 126             .into_iter()
 127             .filter_map(|(range, link, ns)| {
 128                 let def = resolve_doc_path_for_def(sema.db, def, &link, ns)?;
 129                 let InFile { file_id, value: range } = doc_mapping.map(range)?;
 130                 (file_id == node.file_id).then(|| (range, def))
 131             })
 132             .for_each(|(range, def)| {
 133                 hl.add(HlRange {
 134                     range,
 135                     highlight: module_def_to_hl_tag(def)
 136                         | HlMod::Documentation
 137                         | HlMod::Injected
 138                         | HlMod::IntraDocLink,
 139                     binding_hash: None,
 140                 })
 141             });
 142     }
 143
 144     for attr in attributes.by_key("doc").attrs() {
 145         let InFile { file_id, value: src } = attrs_source_map.source_of(&attr);
 146         if file_id != node.file_id {
 147             continue;
 148         }
 149         let (line, range, prefix) = match &src {
 150             Either::Left(it) => {
 151                 string = match find_doc_string_in_attr(attr, it) {
 152                     Some(it) => it,
 153                     None => continue,
 154                 };
 155                 let text_range = string.syntax().text_range();
 156                 let text_range = TextRange::new(
 157                     text_range.start() + TextSize::from(1),
 158                     text_range.end() - TextSize::from(1),
 159                 );
 160                 let text = string.text();
 161                 (&text[1..text.len() - 1], text_range, "")
 162             }
 163             Either::Right(comment) => {
 164                 (comment.text(), comment.syntax().text_range(), comment.prefix())
 165             }
 166         };
 167
 168         let mut pos = TextSize::from(prefix.len() as u32);
 169         let mut range_start = range.start();
 170         for line in line.split('\n') {
 171             let line_len = TextSize::from(line.len() as u32);
 172             let prev_range_start = {
 173                 let next_range_start = range_start + line_len + TextSize::from(1);
 174                 mem::replace(&mut range_start, next_range_start)
 175             };
 176             // only first line has the prefix so take it away for future iterations
 177             let mut pos = mem::take(&mut pos);
 178
 179             match line.find(RUSTDOC_FENCE) {
 180                 Some(idx) => {
 181                     is_codeblock = !is_codeblock;
 182                     // Check whether code is rust by inspecting fence guards
 183                     let guards = &line[idx + RUSTDOC_FENCE.len()..];
 184                     let is_rust = guards.split(',').all(|sub| is_rustdoc_fence_token(sub.trim()));
 185                     is_doctest = is_codeblock && is_rust;
 186                     continue;
 187                 }
 188                 None if !is_doctest => continue,
 189                 None => (),
 190             }
 191
 192             // whitespace after comment is ignored
 193             if let Some(ws) = line[pos.into()..].chars().next().filter(|c| c.is_whitespace()) {
 194                 pos += TextSize::of(ws);
 195             }
 196             // lines marked with `#` should be ignored in output, we skip the `#` char
 197             if line[pos.into()..].starts_with('#') {
 198                 pos += TextSize::of('#');
 199             }
 200
 201             new_comments.push(TextRange::at(prev_range_start, pos));
 202             inj.add(&line[pos.into()..], TextRange::new(pos, line_len) + prev_range_start);
 203             inj.add_unmapped("\n");
 204         }
 205     }
 206
 207     if new_comments.is_empty() {
 208         return; // no need to run an analysis on an empty file
 209     }
 210
 211     inj.add_unmapped("\n}");
 212
 213     let (analysis, tmp_file_id) = Analysis::from_single_file(inj.text().to_string());
 214
 215     for HlRange { range, highlight, binding_hash } in
 216         analysis.with_db(|db| super::highlight(db, tmp_file_id, None, true)).unwrap()
 217     {
 218         for range in inj.map_range_up(range) {
 219             hl.add(HlRange { range, highlight: highlight | HlMod::Injected, binding_hash });
 220         }
 221     }
 222
 223     for range in new_comments {
 224         hl.add(HlRange {
 225             range,
 226             highlight: HlTag::Comment | HlMod::Documentation,
 227             binding_hash: None,
 228         });
 229     }
 230 }
 231
 232 fn find_doc_string_in_attr(attr: &hir::Attr, it: &ast::Attr) -> Option<ast::String> {
 233     match it.expr() {
 234         // #[doc = lit]
 235         Some(ast::Expr::Literal(lit)) => match lit.kind() {
 236             ast::LiteralKind::String(it) => Some(it),
 237             _ => None,
 238         },
 239         // #[cfg_attr(..., doc = "", ...)]
 240         None => {
 241             // We gotta hunt the string token manually here
 242             let text = attr.string_value()?;
 243             // FIXME: We just pick the first string literal that has the same text as the doc attribute
 244             // This means technically we might highlight the wrong one
 245             it.syntax()
 246                 .descendants_with_tokens()
 247                 .filter_map(NodeOrToken::into_token)
 248                 .filter_map(ast::String::cast)
 249                 .find(|string| {
 250                     string.text().get(1..string.text().len() - 1).map_or(false, |it| it == text)
 251                 })
 252         }
 253         _ => return None,
 254     }
 255 }
 256
 257 fn module_def_to_hl_tag(def: hir::ModuleDef) -> HlTag {
 258     let symbol = match def {
 259         hir::ModuleDef::Module(_) => SymbolKind::Module,
 260         hir::ModuleDef::Function(_) => SymbolKind::Function,
 261         hir::ModuleDef::Adt(hir::Adt::Struct(_)) => SymbolKind::Struct,
 262         hir::ModuleDef::Adt(hir::Adt::Enum(_)) => SymbolKind::Enum,
 263         hir::ModuleDef::Adt(hir::Adt::Union(_)) => SymbolKind::Union,
 264         hir::ModuleDef::Variant(_) => SymbolKind::Variant,
 265         hir::ModuleDef::Const(_) => SymbolKind::Const,
 266         hir::ModuleDef::Static(_) => SymbolKind::Static,
 267         hir::ModuleDef::Trait(_) => SymbolKind::Trait,
 268         hir::ModuleDef::TypeAlias(_) => SymbolKind::TypeAlias,
 269         hir::ModuleDef::BuiltinType(_) => return HlTag::BuiltinType,
 270     };
 271     HlTag::Symbol(symbol)
 272 }