aboutsummaryrefslogtreecommitdiff
path: root/crates/ra_ide/src/syntax_highlighting.rs
blob: 657c7b21a568817663d2886358016b260c683620 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
//! FIXME: write short doc here

use rustc_hash::{FxHashMap, FxHashSet};

use hir::{InFile, Name};
use ra_db::SourceDatabase;
use ra_prof::profile;
use ra_syntax::{ast, AstNode, Direction, SyntaxElement, SyntaxKind, SyntaxKind::*, TextRange, T};

use crate::{
    db::RootDatabase,
    references::{
        classify_name, classify_name_ref,
        NameKind::{self, *},
    },
    FileId,
};

pub mod tags {
    pub(crate) const FIELD: &'static str = "field";
    pub(crate) const FUNCTION: &'static str = "function";
    pub(crate) const MODULE: &'static str = "module";
    pub(crate) const TYPE: &'static str = "type";
    pub(crate) const CONSTANT: &'static str = "constant";
    pub(crate) const MACRO: &'static str = "macro";
    pub(crate) const VARIABLE: &'static str = "variable";
    pub(crate) const VARIABLE_MUT: &'static str = "variable.mut";
    pub(crate) const TEXT: &'static str = "text";

    pub(crate) const TYPE_BUILTIN: &'static str = "type.builtin";
    pub(crate) const TYPE_SELF: &'static str = "type.self";
    pub(crate) const TYPE_PARAM: &'static str = "type.param";
    pub(crate) const TYPE_LIFETIME: &'static str = "type.lifetime";

    pub(crate) const LITERAL_BYTE: &'static str = "literal.byte";
    pub(crate) const LITERAL_NUMERIC: &'static str = "literal.numeric";
    pub(crate) const LITERAL_CHAR: &'static str = "literal.char";
    pub(crate) const LITERAL_COMMENT: &'static str = "comment";
    pub(crate) const LITERAL_STRING: &'static str = "string";
    pub(crate) const LITERAL_ATTRIBUTE: &'static str = "attribute";

    pub(crate) const KEYWORD_UNSAFE: &'static str = "keyword.unsafe";
    pub(crate) const KEYWORD_CONTROL: &'static str = "keyword.control";
    pub(crate) const KEYWORD: &'static str = "keyword";
}

#[derive(Debug)]
pub struct HighlightedRange {
    pub range: TextRange,
    pub tag: &'static str,
    pub binding_hash: Option<u64>,
}

fn is_control_keyword(kind: SyntaxKind) -> bool {
    match kind {
        T![for]
        | T![loop]
        | T![while]
        | T![continue]
        | T![break]
        | T![if]
        | T![else]
        | T![match]
        | T![return] => true,
        _ => false,
    }
}

pub(crate) fn highlight(db: &RootDatabase, file_id: FileId) -> Vec<HighlightedRange> {
    let _p = profile("highlight");
    let parse = db.parse(file_id);
    let root = parse.tree().syntax().clone();

    fn calc_binding_hash(file_id: FileId, name: &Name, shadow_count: u32) -> u64 {
        fn hash<T: std::hash::Hash + std::fmt::Debug>(x: T) -> u64 {
            use std::{collections::hash_map::DefaultHasher, hash::Hasher};

            let mut hasher = DefaultHasher::new();
            x.hash(&mut hasher);
            hasher.finish()
        }

        hash((file_id, name, shadow_count))
    }

    // Visited nodes to handle highlighting priorities
    // FIXME: retain only ranges here
    let mut highlighted: FxHashSet<SyntaxElement> = FxHashSet::default();
    let mut bindings_shadow_count: FxHashMap<Name, u32> = FxHashMap::default();

    let mut res = Vec::new();
    for node in root.descendants_with_tokens() {
        if highlighted.contains(&node) {
            continue;
        }
        let mut binding_hash = None;
        let tag = match node.kind() {
            FN_DEF => {
                bindings_shadow_count.clear();
                continue;
            }
            COMMENT => tags::LITERAL_COMMENT,
            STRING | RAW_STRING | RAW_BYTE_STRING | BYTE_STRING => tags::LITERAL_STRING,
            ATTR => tags::LITERAL_ATTRIBUTE,
            // Special-case field init shorthand
            NAME_REF if node.parent().and_then(ast::RecordField::cast).is_some() => tags::FIELD,
            NAME_REF if node.ancestors().any(|it| it.kind() == ATTR) => continue,
            NAME_REF => {
                let name_ref = node.as_node().cloned().and_then(ast::NameRef::cast).unwrap();
                let name_kind =
                    classify_name_ref(db, InFile::new(file_id.into(), &name_ref)).map(|d| d.kind);

                if let Some(Local(local)) = &name_kind {
                    if let Some(name) = local.name(db) {
                        let shadow_count = bindings_shadow_count.entry(name.clone()).or_default();
                        binding_hash = Some(calc_binding_hash(file_id, &name, *shadow_count))
                    }
                };

                name_kind.map_or(tags::TEXT, |it| highlight_name(db, it))
            }
            NAME => {
                let name = node.as_node().cloned().and_then(ast::Name::cast).unwrap();
                let name_kind =
                    classify_name(db, InFile::new(file_id.into(), &name)).map(|d| d.kind);

                if let Some(Local(local)) = &name_kind {
                    if let Some(name) = local.name(db) {
                        let shadow_count = bindings_shadow_count.entry(name.clone()).or_default();
                        *shadow_count += 1;
                        binding_hash = Some(calc_binding_hash(file_id, &name, *shadow_count))
                    }
                };

                match name_kind {
                    Some(name_kind) => highlight_name(db, name_kind),
                    None => name.syntax().parent().map_or(tags::FUNCTION, |x| match x.kind() {
                        STRUCT_DEF | ENUM_DEF | TRAIT_DEF | TYPE_ALIAS_DEF => tags::TYPE,
                        TYPE_PARAM => tags::TYPE_PARAM,
                        RECORD_FIELD_DEF => tags::FIELD,
                        _ => tags::FUNCTION,
                    }),
                }
            }
            INT_NUMBER | FLOAT_NUMBER => tags::LITERAL_NUMERIC,
            BYTE => tags::LITERAL_BYTE,
            CHAR => tags::LITERAL_CHAR,
            LIFETIME => tags::TYPE_LIFETIME,
            T![unsafe] => tags::KEYWORD_UNSAFE,
            k if is_control_keyword(k) => tags::KEYWORD_CONTROL,
            k if k.is_keyword() => tags::KEYWORD,
            _ => {
                if let Some(macro_call) = node.as_node().cloned().and_then(ast::MacroCall::cast) {
                    if let Some(path) = macro_call.path() {
                        if let Some(segment) = path.segment() {
                            if let Some(name_ref) = segment.name_ref() {
                                highlighted.insert(name_ref.syntax().clone().into());
                                let range_start = name_ref.syntax().text_range().start();
                                let mut range_end = name_ref.syntax().text_range().end();
                                for sibling in path.syntax().siblings_with_tokens(Direction::Next) {
                                    match sibling.kind() {
                                        T![!] | IDENT => range_end = sibling.text_range().end(),
                                        _ => (),
                                    }
                                }
                                res.push(HighlightedRange {
                                    range: TextRange::from_to(range_start, range_end),
                                    tag: tags::MACRO,
                                    binding_hash: None,
                                })
                            }
                        }
                    }
                }
                continue;
            }
        };
        res.push(HighlightedRange { range: node.text_range(), tag, binding_hash })
    }
    res
}

pub(crate) fn highlight_as_html(db: &RootDatabase, file_id: FileId, rainbow: bool) -> String {
    let parse = db.parse(file_id);

    fn rainbowify(seed: u64) -> String {
        use rand::prelude::*;
        let mut rng = SmallRng::seed_from_u64(seed);
        format!(
            "hsl({h},{s}%,{l}%)",
            h = rng.gen_range::<u16, _, _>(0, 361),
            s = rng.gen_range::<u16, _, _>(42, 99),
            l = rng.gen_range::<u16, _, _>(40, 91),
        )
    }

    let mut ranges = highlight(db, file_id);
    ranges.sort_by_key(|it| it.range.start());
    // quick non-optimal heuristic to intersect token ranges and highlighted ranges
    let mut frontier = 0;
    let mut could_intersect: Vec<&HighlightedRange> = Vec::new();

    let mut buf = String::new();
    buf.push_str(&STYLE);
    buf.push_str("<pre><code>");
    let tokens = parse.tree().syntax().descendants_with_tokens().filter_map(|it| it.into_token());
    for token in tokens {
        could_intersect.retain(|it| token.text_range().start() <= it.range.end());
        while let Some(r) = ranges.get(frontier) {
            if r.range.start() <= token.text_range().end() {
                could_intersect.push(r);
                frontier += 1;
            } else {
                break;
            }
        }
        let text = html_escape(&token.text());
        let ranges = could_intersect
            .iter()
            .filter(|it| token.text_range().is_subrange(&it.range))
            .collect::<Vec<_>>();
        if ranges.is_empty() {
            buf.push_str(&text);
        } else {
            let classes = ranges.iter().map(|x| x.tag).collect::<Vec<_>>().join(" ");
            let binding_hash = ranges.first().and_then(|x| x.binding_hash);
            let color = match (rainbow, binding_hash) {
                (true, Some(hash)) => format!(
                    " data-binding-hash=\"{}\" style=\"color: {};\"",
                    hash,
                    rainbowify(hash)
                ),
                _ => "".into(),
            };
            buf.push_str(&format!("<span class=\"{}\"{}>{}</span>", classes, color, text));
        }
    }
    buf.push_str("</code></pre>");
    buf
}

fn highlight_name(db: &RootDatabase, name_kind: NameKind) -> &'static str {
    match name_kind {
        Macro(_) => tags::MACRO,
        Field(_) => tags::FIELD,
        AssocItem(hir::AssocItem::Function(_)) => tags::FUNCTION,
        AssocItem(hir::AssocItem::Const(_)) => tags::CONSTANT,
        AssocItem(hir::AssocItem::TypeAlias(_)) => tags::TYPE,
        Def(hir::ModuleDef::Module(_)) => tags::MODULE,
        Def(hir::ModuleDef::Function(_)) => tags::FUNCTION,
        Def(hir::ModuleDef::Adt(_)) => tags::TYPE,
        Def(hir::ModuleDef::EnumVariant(_)) => tags::CONSTANT,
        Def(hir::ModuleDef::Const(_)) => tags::CONSTANT,
        Def(hir::ModuleDef::Static(_)) => tags::CONSTANT,
        Def(hir::ModuleDef::Trait(_)) => tags::TYPE,
        Def(hir::ModuleDef::TypeAlias(_)) => tags::TYPE,
        Def(hir::ModuleDef::BuiltinType(_)) => tags::TYPE_BUILTIN,
        SelfType(_) => tags::TYPE_SELF,
        TypeParam(_) => tags::TYPE_PARAM,
        Local(local) => {
            if local.is_mut(db) {
                tags::VARIABLE_MUT
            } else if local.ty(db).is_mutable_reference() {
                tags::VARIABLE_MUT
            } else {
                tags::VARIABLE
            }
        }
    }
}

//FIXME: like, real html escaping
fn html_escape(text: &str) -> String {
    text.replace("<", "&lt;").replace(">", "&gt;")
}

const STYLE: &str = "
<style>
body                { margin: 0; }
pre                 { color: #DCDCCC; background: #3F3F3F; font-size: 22px; padding: 0.4em; }

.comment            { color: #7F9F7F; }
.string             { color: #CC9393; }
.field              { color: #94BFF3; }
.function           { color: #93E0E3; }
.parameter          { color: #94BFF3; }
.text               { color: #DCDCCC; }
.type               { color: #7CB8BB; }
.type\\.builtin     { color: #8CD0D3; }
.type\\.param       { color: #20999D; }
.attribute          { color: #94BFF3; }
.literal            { color: #BFEBBF; }
.literal\\.numeric  { color: #6A8759; }
.macro              { color: #94BFF3; }
.variable           { color: #DCDCCC; }
.variable\\.mut     { color: #DCDCCC; text-decoration: underline; }

.keyword            { color: #F0DFAF; }
.keyword\\.unsafe   { color: #DFAF8F; }
.keyword\\.control  { color: #F0DFAF; font-weight: bold; }
</style>
";

#[cfg(test)]
mod tests {
    use crate::mock_analysis::single_file;
    use test_utils::{assert_eq_text, project_dir, read_text};

    #[test]
    fn test_highlighting() {
        let (analysis, file_id) = single_file(
            r#"
#[derive(Clone, Debug)]
struct Foo {
    pub x: i32,
    pub y: i32,
}

fn foo<T>() -> T {
    unimplemented!();
    foo::<i32>();
}

// comment
fn main() {
    println!("Hello, {}!", 92);

    let mut vec = Vec::new();
    if true {
        let x = 92;
        vec.push(Foo { x, y: 1 });
    }
    unsafe { vec.set_len(0); }

    let mut x = 42;
    let y = &mut x;
    let z = &y;

    y;
}

enum E<X> {
    V(X)
}

impl<X> E<X> {
    fn new<T>() -> E<T> {}
}
"#
            .trim(),
        );
        let dst_file = project_dir().join("crates/ra_ide/src/snapshots/highlighting.html");
        let actual_html = &analysis.highlight_as_html(file_id, false).unwrap();
        let expected_html = &read_text(&dst_file);
        std::fs::write(dst_file, &actual_html).unwrap();
        assert_eq_text!(expected_html, actual_html);
    }

    #[test]
    fn test_rainbow_highlighting() {
        let (analysis, file_id) = single_file(
            r#"
fn main() {
    let hello = "hello";
    let x = hello.to_string();
    let y = hello.to_string();

    let x = "other color please!";
    let y = x.to_string();
}

fn bar() {
    let mut hello = "hello";
}
"#
            .trim(),
        );
        let dst_file = project_dir().join("crates/ra_ide/src/snapshots/rainbow_highlighting.html");
        let actual_html = &analysis.highlight_as_html(file_id, true).unwrap();
        let expected_html = &read_text(&dst_file);
        std::fs::write(dst_file, &actual_html).unwrap();
        assert_eq_text!(expected_html, actual_html);
    }
}