1 //! "Recursive" Syntax highlighting for code in doctests and fixtures.
6 use hir::{InFile, Semantics};
7 use ide_db::{call_info::ActiveParameter, helpers::rust_doc::is_rust_fence, SymbolKind};
9 ast::{self, AstNode, IsString},
10 AstToken, NodeOrToken, SyntaxNode, SyntaxToken, TextRange, TextSize,
14 doc_links::{doc_attributes, extract_definitions_from_docs, resolve_doc_path_for_def},
15 Analysis, HlMod, HlRange, HlTag, RootDatabase,
18 use super::{highlights::Highlights, injector::Injector};
20 pub(super) fn ra_fixture(
22 sema: &Semantics<RootDatabase>,
24 expanded: SyntaxToken,
26 let active_parameter = ActiveParameter::at_token(sema, expanded)?;
27 if !active_parameter.ident().map_or(false, |name| name.text().starts_with("ra_fixture")) {
30 let value = literal.value()?;
32 if let Some(range) = literal.open_quote_text_range() {
33 hl.add(HlRange { range, highlight: HlTag::StringLiteral.into(), binding_hash: None })
36 let mut inj = Injector::default();
38 let mut text = &*value;
39 let mut offset: TextSize = 0.into();
41 while !text.is_empty() {
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)));
48 offset += TextSize::of(chunk);
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 });
57 let marker_len = TextSize::of(marker);
62 let (analysis, tmp_file_id) = Analysis::from_single_file(inj.text().to_string());
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;
73 if let Some(range) = literal.close_quote_text_range() {
74 hl.add(HlRange { range, highlight: HlTag::StringLiteral.into(), binding_hash: None })
80 const RUSTDOC_FENCE: &'static str = "```";
82 /// Injection of syntax highlighting of doctests.
83 pub(super) fn doc_comment(
85 sema: &Semantics<RootDatabase>,
86 node: InFile<&SyntaxNode>,
88 let (attributes, def) = match doc_attributes(sema, node.value) {
93 let mut inj = Injector::default();
94 inj.add_unmapped("fn doctest() {\n");
96 let attrs_source_map = attributes.source_map(sema.db);
98 let mut is_codeblock = false;
99 let mut is_doctest = false;
101 // Replace the original, line-spanning comment ranges by new, only comment-prefix
102 // spanning comment ranges.
103 let mut new_comments = Vec::new();
106 if let Some((docs, doc_mapping)) = attributes.docs_with_rangemap(sema.db) {
107 extract_definitions_from_docs(&docs)
109 .filter_map(|(range, link, ns)| {
110 let def = resolve_doc_path_for_def(sema.db, def, &link, ns)?;
111 let InFile { file_id, value: range } = doc_mapping.map(range)?;
112 (file_id == node.file_id).then(|| (range, def))
114 .for_each(|(range, def)| {
117 highlight: module_def_to_hl_tag(def)
118 | HlMod::Documentation
120 | HlMod::IntraDocLink,
126 for attr in attributes.by_key("doc").attrs() {
127 let InFile { file_id, value: src } = attrs_source_map.source_of(attr);
128 if file_id != node.file_id {
131 let (line, range, prefix) = match &src {
132 Either::Left(it) => {
133 string = match find_doc_string_in_attr(attr, it) {
137 let text_range = string.syntax().text_range();
138 let text_range = TextRange::new(
139 text_range.start() + TextSize::from(1),
140 text_range.end() - TextSize::from(1),
142 let text = string.text();
143 (&text[1..text.len() - 1], text_range, "")
145 Either::Right(comment) => {
146 (comment.text(), comment.syntax().text_range(), comment.prefix())
150 let mut pos = TextSize::from(prefix.len() as u32);
151 let mut range_start = range.start();
152 for line in line.split('\n') {
153 let line_len = TextSize::from(line.len() as u32);
154 let prev_range_start = {
155 let next_range_start = range_start + line_len + TextSize::from(1);
156 mem::replace(&mut range_start, next_range_start)
158 // only first line has the prefix so take it away for future iterations
159 let mut pos = mem::take(&mut pos);
161 match line.find(RUSTDOC_FENCE) {
163 is_codeblock = !is_codeblock;
164 // Check whether code is rust by inspecting fence guards
165 let guards = &line[idx + RUSTDOC_FENCE.len()..];
166 let is_rust = is_rust_fence(guards);
167 is_doctest = is_codeblock && is_rust;
170 None if !is_doctest => continue,
174 // whitespace after comment is ignored
175 if let Some(ws) = line[pos.into()..].chars().next().filter(|c| c.is_whitespace()) {
176 pos += TextSize::of(ws);
178 // lines marked with `#` should be ignored in output, we skip the `#` char
179 if line[pos.into()..].starts_with('#') {
180 pos += TextSize::of('#');
183 new_comments.push(TextRange::at(prev_range_start, pos));
184 inj.add(&line[pos.into()..], TextRange::new(pos, line_len) + prev_range_start);
185 inj.add_unmapped("\n");
189 if new_comments.is_empty() {
190 return; // no need to run an analysis on an empty file
193 inj.add_unmapped("\n}");
195 let (analysis, tmp_file_id) = Analysis::from_single_file(inj.text().to_string());
197 for HlRange { range, highlight, binding_hash } in
198 analysis.with_db(|db| super::highlight(db, tmp_file_id, None, true)).unwrap()
200 for range in inj.map_range_up(range) {
201 hl.add(HlRange { range, highlight: highlight | HlMod::Injected, binding_hash });
205 for range in new_comments {
208 highlight: HlTag::Comment | HlMod::Documentation,
214 fn find_doc_string_in_attr(attr: &hir::Attr, it: &ast::Attr) -> Option<ast::String> {
217 Some(ast::Expr::Literal(lit)) => match lit.kind() {
218 ast::LiteralKind::String(it) => Some(it),
221 // #[cfg_attr(..., doc = "", ...)]
223 // We gotta hunt the string token manually here
224 let text = attr.string_value()?;
225 // FIXME: We just pick the first string literal that has the same text as the doc attribute
226 // This means technically we might highlight the wrong one
228 .descendants_with_tokens()
229 .filter_map(NodeOrToken::into_token)
230 .filter_map(ast::String::cast)
232 string.text().get(1..string.text().len() - 1).map_or(false, |it| it == text)
239 fn module_def_to_hl_tag(def: hir::ModuleDef) -> HlTag {
240 let symbol = match def {
241 hir::ModuleDef::Module(_) => SymbolKind::Module,
242 hir::ModuleDef::Function(_) => SymbolKind::Function,
243 hir::ModuleDef::Adt(hir::Adt::Struct(_)) => SymbolKind::Struct,
244 hir::ModuleDef::Adt(hir::Adt::Enum(_)) => SymbolKind::Enum,
245 hir::ModuleDef::Adt(hir::Adt::Union(_)) => SymbolKind::Union,
246 hir::ModuleDef::Variant(_) => SymbolKind::Variant,
247 hir::ModuleDef::Const(_) => SymbolKind::Const,
248 hir::ModuleDef::Static(_) => SymbolKind::Static,
249 hir::ModuleDef::Trait(_) => SymbolKind::Trait,
250 hir::ModuleDef::TypeAlias(_) => SymbolKind::TypeAlias,
251 hir::ModuleDef::BuiltinType(_) => return HlTag::BuiltinType,
253 HlTag::Symbol(symbol)