Repository: rust-analyzer/rust-analyzer
Pull request #11616 (2022-03-03 21:59:51)

fix: Fix semantic highlighting breaking for lifetimes in macros
bors r+


Patch:
diff --git a/crates/ide/src/syntax_highlighting.rs b/crates/ide/src/syntax_highlighting.rs
index 1b2fc9c635..776a0f8295 100644
--- a/crates/ide/src/syntax_highlighting.rs
+++ b/crates/ide/src/syntax_highlighting.rs
@@ -206,6 +206,7 @@ fn traverse(
 
     let mut current_macro_call: Option<ast::MacroCall> = None;
     let mut current_attr_call = None;
+    let mut current_derive_call = None;
     let mut current_macro: Option<ast::Macro> = None;
     let mut macro_highlighter = MacroHighlighter::default();
     let mut inside_attribute = false;
@@ -249,7 +250,7 @@ fn traverse(
                     };
                     match adt {
                         Some(adt) if sema.is_derive_annotated(&adt) => {
-                            current_attr_call = Some(adt.into());
+                            current_derive_call = Some(ast::Item::from(adt));
                         }
                         _ => (),
                     }
@@ -273,7 +274,10 @@ fn traverse(
                     macro_highlighter = MacroHighlighter::default();
                 }
                 Some(item) if current_attr_call.as_ref().map_or(false, |it| *it == item) => {
-                    current_attr_call = None
+                    current_attr_call = None;
+                }
+                Some(item) if current_derive_call.as_ref().map_or(false, |it| *it == item) => {
+                    current_derive_call = None;
                 }
                 None if ast::Attr::can_cast(node.kind()) => inside_attribute = false,
                 _ => (),
@@ -301,17 +305,19 @@ fn traverse(
         // as calling `descend_into_macros_single` gets rather expensive if done for every single token
         // additionally, do not descend into comments, descending maps down to doc attributes which get
         // tagged as string literals.
-        let descend_token = (current_macro_call.is_some() || current_attr_call.is_some())
+        let descend_token = (current_macro_call.is_some()
+            || current_attr_call.is_some()
+            || current_derive_call.is_some())
             && element.kind() != COMMENT;
         let element_to_highlight = if descend_token {
             let token = match &element {
                 NodeOrToken::Node(_) => continue,
                 NodeOrToken::Token(tok) => tok.clone(),
             };
-            let in_mcall_outside_tt = current_macro_call.is_some()
+            let in_mcall_outside_tt = current_attr_call.is_none()
                 && token.parent().as_ref().map(SyntaxNode::kind) != Some(TOKEN_TREE);
             let token = match in_mcall_outside_tt {
-                // not in the macros token tree, don't attempt to descend
+                // not in the macros/derives token tree, don't attempt to descend
                 true => token,
                 false => sema.descend_into_macros_single(token),
             };
@@ -323,6 +329,7 @@ fn traverse(
                         (T![ident], NAME | NAME_REF) => parent.into(),
                         (T![self] | T![super] | T![crate], NAME_REF) => parent.into(),
                         (INT_NUMBER, NAME_REF) => parent.into(),
+                        (LIFETIME_IDENT, LIFETIME) => parent.into(),
                         _ => token.into(),
                     }
                 }


Test patch:
diff --git a/crates/ide/src/syntax_highlighting/test_data/highlight_lifetimes.html b/crates/ide/src/syntax_highlighting/test_data/highlight_lifetimes.html
new file mode 100644
index 0000000000..9e36b56d28
--- /dev/null
+++ b/crates/ide/src/syntax_highlighting/test_data/highlight_lifetimes.html
@@ -0,0 +1,54 @@
+
+<style>
+body                { margin: 0; }
+pre                 { color: #DCDCCC; background: #3F3F3F; font-size: 22px; padding: 0.4em; }
+
+.lifetime           { color: #DFAF8F; font-style: italic; }
+.label              { color: #DFAF8F; font-style: italic; }
+.comment            { color: #7F9F7F; }
+.documentation      { color: #629755; }
+.intra_doc_link     { font-style: italic; }
+.injected           { opacity: 0.65 ; }
+.struct, .enum      { color: #7CB8BB; }
+.enum_variant       { color: #BDE0F3; }
+.string_literal     { color: #CC9393; }
+.field              { color: #94BFF3; }
+.function           { color: #93E0E3; }
+.function.unsafe    { color: #BC8383; }
+.trait.unsafe       { color: #BC8383; }
+.operator.unsafe    { color: #BC8383; }
+.mutable.unsafe     { color: #BC8383; text-decoration: underline; }
+.keyword.unsafe     { color: #BC8383; font-weight: bold; }
+.parameter          { color: #94BFF3; }
+.text               { color: #DCDCCC; }
+.type               { color: #7CB8BB; }
+.builtin_type       { color: #8CD0D3; }
+.type_param         { color: #DFAF8F; }
+.attribute          { color: #94BFF3; }
+.numeric_literal    { color: #BFEBBF; }
+.bool_literal       { color: #BFE6EB; }
+.macro              { color: #94BFF3; }
+.derive             { color: #94BFF3; font-style: italic; }
+.module             { color: #AFD8AF; }
+.value_param        { color: #DCDCCC; }
+.variable           { color: #DCDCCC; }
+.format_specifier   { color: #CC696B; }
+.mutable            { text-decoration: underline; }
+.escape_sequence    { color: #94BFF3; }
+.keyword            { color: #F0DFAF; font-weight: bold; }
+.control            { font-style: italic; }
+.reference          { font-style: italic; font-weight: bold; }
+
+.unresolved_reference { color: #FC5555; text-decoration: wavy underline; }
+</style>
+<pre><code>
+<span class="attribute_bracket attribute">#</span><span class="attribute_bracket attribute">[</span><span class="attribute attribute default_library library">derive</span><span class="parenthesis attribute">(</span><span class="parenthesis attribute">)</span><span class="attribute_bracket attribute">]</span>
+<span class="keyword">struct</span> <span class="struct declaration">Foo</span><span class="angle">&lt;</span><span class="lifetime declaration">'a</span><span class="comma">,</span> <span class="lifetime declaration">'b</span><span class="comma">,</span> <span class="lifetime declaration">'c</span><span class="angle">&gt;</span> <span class="keyword">where</span> <span class="lifetime">'a</span><span class="colon">:</span> <span class="lifetime">'a</span><span class="comma">,</span> <span class="lifetime">'static</span><span class="colon">:</span> <span class="lifetime">'static</span> <span class="brace">{</span>
+    <span class="field declaration">field</span><span class="colon">:</span> <span class="operator">&</span><span class="lifetime">'a</span> <span class="parenthesis">(</span><span class="parenthesis">)</span><span class="comma">,</span>
+    <span class="field declaration">field2</span><span class="colon">:</span> <span class="operator">&</span><span class="lifetime">'static</span> <span class="parenthesis">(</span><span class="parenthesis">)</span><span class="comma">,</span>
+<span class="brace">}</span>
+<span class="keyword">impl</span><span class="angle">&lt;</span><span class="lifetime declaration">'a</span><span class="angle">&gt;</span> <span class="struct">Foo</span><span class="angle">&lt;</span><span class="lifetime">'_</span><span class="comma">,</span> <span class="lifetime">'a</span><span class="comma">,</span> <span class="lifetime">'static</span><span class="angle">&gt;</span>
+<span class="keyword">where</span>
+    <span class="lifetime">'a</span><span class="colon">:</span> <span class="lifetime">'a</span><span class="comma">,</span>
+    <span class="lifetime">'static</span><span class="colon">:</span> <span class="lifetime">'static</span>
+<span class="brace">{</span><span class="brace">}</span></code></pre>
\ No newline at end of file
diff --git a/crates/ide/src/syntax_highlighting/tests.rs b/crates/ide/src/syntax_highlighting/tests.rs
index ec50fde356..27686ab944 100644
--- a/crates/ide/src/syntax_highlighting/tests.rs
+++ b/crates/ide/src/syntax_highlighting/tests.rs
@@ -312,6 +312,28 @@ macro_rules! die {
     );
 }
 
+#[test]
+fn test_lifetime_highlighting() {
+    check_highlighting(
+        r#"
+//- minicore: derive
+
+#[derive()]
+struct Foo<'a, 'b, 'c> where 'a: 'a, 'static: 'static {
+    field: &'a (),
+    field2: &'static (),
+}
+impl<'a> Foo<'_, 'a, 'static>
+where
+    'a: 'a,
+    'static: 'static
+{}
+"#,
+        expect_file!["./test_data/highlight_lifetimes.html"],
+        false,
+    );
+}
+
 #[test]
 fn test_string_highlighting() {
     // The format string detection is based on macro-expansion,