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, helpers::rust_doc::is_rust_fence, SymbolKind};
   8 use syntax::{
   9     ast::{self, AstNode, IsString},
  10     AstToken, NodeOrToken, SyntaxNode, SyntaxToken, TextRange, TextSize,
  11 };
  12
  13 use crate::{
  14     doc_links::{doc_attributes, extract_definitions_from_docs, 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
  82 /// Injection of syntax highlighting of doctests.
  83 pub(super) fn doc_comment(
  84     hl: &mut Highlights,
  85     sema: &Semantics<RootDatabase>,
  86     node: InFile<&SyntaxNode>,
  87 ) {
  88     let (attributes, def) = match doc_attributes(sema, node.value) {
  89         Some(it) => it,
  90         None => return,
  91     };
  92
  93     let mut inj = Injector::default();
  94     inj.add_unmapped("fn doctest() {\n");
  95
  96     let attrs_source_map = attributes.source_map(sema.db);
  97
  98     let mut is_codeblock = false;
  99     let mut is_doctest = false;
 100
 101     // Replace the original, line-spanning comment ranges by new, only comment-prefix
 102     // spanning comment ranges.
 103     let mut new_comments = Vec::new();
 104     let mut string;
 105
 106     if let Some((docs, doc_mapping)) = attributes.docs_with_rangemap(sema.db) {
 107         extract_definitions_from_docs(&docs)
 108             .into_iter()
 109             .filter_map(|(range, link, ns)| {
 110                 doc_mapping.map(range).filter(|mapping| mapping.file_id == node.file_id).and_then(
 111                     |InFile { value: mapped_range, .. }| {
 112                         Some(mapped_range).zip(resolve_doc_path_for_def(sema.db, def, &link, ns))
 113                     },
 114                 )
 115             })
 116             .for_each(|(range, def)| {
 117                 hl.add(HlRange {
 118                     range,
 119                     highlight: module_def_to_hl_tag(def)
 120                         | HlMod::Documentation
 121                         | HlMod::Injected
 122                         | HlMod::IntraDocLink,
 123                     binding_hash: None,
 124                 })
 125             });
 126     }
 127
 128     for attr in attributes.by_key("doc").attrs() {
 129         let InFile { file_id, value: src } = attrs_source_map.source_of(attr);
 130         if file_id != node.file_id {
 131             continue;
 132         }
 133         let (line, range, prefix) = match &src {
 134             Either::Left(it) => {
 135                 string = match find_doc_string_in_attr(attr, it) {
 136                     Some(it) => it,
 137                     None => continue,
 138                 };
 139                 let text_range = string.syntax().text_range();
 140                 let text_range = TextRange::new(
 141                     text_range.start() + TextSize::from(1),
 142                     text_range.end() - TextSize::from(1),
 143                 );
 144                 let text = string.text();
 145                 (&text[1..text.len() - 1], text_range, "")
 146             }
 147             Either::Right(comment) => {
 148                 (comment.text(), comment.syntax().text_range(), comment.prefix())
 149             }
 150         };
 151
 152         let mut pos = TextSize::from(prefix.len() as u32);
 153         let mut range_start = range.start();
 154         for line in line.split('\n') {
 155             let line_len = TextSize::from(line.len() as u32);
 156             let prev_range_start = {
 157                 let next_range_start = range_start + line_len + TextSize::from(1);
 158                 mem::replace(&mut range_start, next_range_start)
 159             };
 160             // only first line has the prefix so take it away for future iterations
 161             let mut pos = mem::take(&mut pos);
 162
 163             match line.find(RUSTDOC_FENCE) {
 164                 Some(idx) => {
 165                     is_codeblock = !is_codeblock;
 166                     // Check whether code is rust by inspecting fence guards
 167                     let guards = &line[idx + RUSTDOC_FENCE.len()..];
 168                     let is_rust = is_rust_fence(guards);
 169                     is_doctest = is_codeblock && is_rust;
 170                     continue;
 171                 }
 172                 None if !is_doctest => continue,
 173                 None => (),
 174             }
 175
 176             // whitespace after comment is ignored
 177             if let Some(ws) = line[pos.into()..].chars().next().filter(|c| c.is_whitespace()) {
 178                 pos += TextSize::of(ws);
 179             }
 180             // lines marked with `#` should be ignored in output, we skip the `#` char
 181             if line[pos.into()..].starts_with('#') {
 182                 pos += TextSize::of('#');
 183             }
 184
 185             new_comments.push(TextRange::at(prev_range_start, pos));
 186             inj.add(&line[pos.into()..], TextRange::new(pos, line_len) + prev_range_start);
 187             inj.add_unmapped("\n");
 188         }
 189     }
 190
 191     if new_comments.is_empty() {
 192         return; // no need to run an analysis on an empty file
 193     }
 194
 195     inj.add_unmapped("\n}");
 196
 197     let (analysis, tmp_file_id) = Analysis::from_single_file(inj.text().to_string());
 198
 199     for HlRange { range, highlight, binding_hash } in
 200         analysis.with_db(|db| super::highlight(db, tmp_file_id, None, true)).unwrap()
 201     {
 202         for range in inj.map_range_up(range) {
 203             hl.add(HlRange { range, highlight: highlight | HlMod::Injected, binding_hash });
 204         }
 205     }
 206
 207     for range in new_comments {
 208         hl.add(HlRange {
 209             range,
 210             highlight: HlTag::Comment | HlMod::Documentation,
 211             binding_hash: None,
 212         });
 213     }
 214 }
 215
 216 fn find_doc_string_in_attr(attr: &hir::Attr, it: &ast::Attr) -> Option<ast::String> {
 217     match it.expr() {
 218         // #[doc = lit]
 219         Some(ast::Expr::Literal(lit)) => match lit.kind() {
 220             ast::LiteralKind::String(it) => Some(it),
 221             _ => None,
 222         },
 223         // #[cfg_attr(..., doc = "", ...)]
 224         None => {
 225             // We gotta hunt the string token manually here
 226             let text = attr.string_value()?;
 227             // FIXME: We just pick the first string literal that has the same text as the doc attribute
 228             // This means technically we might highlight the wrong one
 229             it.syntax()
 230                 .descendants_with_tokens()
 231                 .filter_map(NodeOrToken::into_token)
 232                 .filter_map(ast::String::cast)
 233                 .find(|string| {
 234                     string.text().get(1..string.text().len() - 1).map_or(false, |it| it == text)
 235                 })
 236         }
 237         _ => None,
 238     }
 239 }
 240
 241 fn module_def_to_hl_tag(def: hir::ModuleDef) -> HlTag {
 242     let symbol = match def {
 243         hir::ModuleDef::Module(_) => SymbolKind::Module,
 244         hir::ModuleDef::Function(_) => SymbolKind::Function,
 245         hir::ModuleDef::Adt(hir::Adt::Struct(_)) => SymbolKind::Struct,
 246         hir::ModuleDef::Adt(hir::Adt::Enum(_)) => SymbolKind::Enum,
 247         hir::ModuleDef::Adt(hir::Adt::Union(_)) => SymbolKind::Union,
 248         hir::ModuleDef::Variant(_) => SymbolKind::Variant,
 249         hir::ModuleDef::Const(_) => SymbolKind::Const,
 250         hir::ModuleDef::Static(_) => SymbolKind::Static,
 251         hir::ModuleDef::Trait(_) => SymbolKind::Trait,
 252         hir::ModuleDef::TypeAlias(_) => SymbolKind::TypeAlias,
 253         hir::ModuleDef::BuiltinType(_) => return HlTag::BuiltinType,
 254     };
 255     HlTag::Symbol(symbol)
 256 }