cairo-lang-filesystem 2.18.0

Virtual filesystem for the compiler.
Documentation 
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

use itertools::repeat_n;
use salsa::Database;

use crate::db::FilesGroup;
use crate::ids::SpanInFile;
use crate::span::{FileSummary, TextPosition, TextSpan, TextWidth};

#[cfg(test)]
#[path = "location_marks_test.rs"]
mod test;

/// Given a diagnostic location, returns a string with the location marks.
pub fn get_location_marks(
    db: &dyn Database,
    location: &SpanInFile<'_>,
    skip_middle_lines: bool,
) -> String {
    let span = &location.span;
    let summary = db.file_summary(location.file_id).expect("File missing from DB.");
    let TextPosition { line: first_line_idx, col: _ } = span
        .start
        .position_in_file(db, location.file_id)
        .expect("Failed to find location in file.");
    if span.end <= summary.last_offset {
        let TextPosition { line: last_line_idx, col: _ } = span
            .end
            .position_in_file(db, location.file_id)
            .expect("Failed to find location in file.");
        if first_line_idx != last_line_idx {
            return get_multiple_lines_location_marks(db, location, skip_middle_lines);
        }
    }
    get_single_line_location_marks(db, location)
}

/// Given a single line diagnostic location, returns a string with the location marks.
fn get_single_line_location_marks(db: &dyn Database, location: &SpanInFile<'_>) -> String {
    let content = db.file_content(location.file_id).expect("File missing from DB.");
    let summary = db.file_summary(location.file_id).expect("File missing from DB.");
    let span = &location.span;
    let TextPosition { line: first_line_idx, col } = span
        .start
        .position_in_file(db, location.file_id)
        .expect("Failed to find location in file.");
    let first_line_start = summary.line_offsets[first_line_idx];
    let first_line_end = match summary.line_offsets.get(first_line_idx + 1) {
        Some(offset) => offset.sub_width(TextWidth::from_char('\n')),
        None => summary.last_offset,
    };

    let first_line_span = TextSpan::new(first_line_start, first_line_end);
    let mut res = first_line_span.take(content).to_string();
    res.push('\n');
    res.extend(repeat_n(' ', col));
    let subspan_in_first_line = TextSpan::new(span.start, std::cmp::min(first_line_end, span.end));
    let marker_length = subspan_in_first_line.n_chars(content);
    // marker_length can be 0 if the span is empty.
    res.extend(repeat_n('^', std::cmp::max(marker_length, 1)));

    res
}

/// Given a multiple lines diagnostic location, returns a string with the location marks.
fn get_multiple_lines_location_marks(
    db: &dyn Database,
    location: &SpanInFile<'_>,
    skip_middle_lines: bool,
) -> String {
    let content = db.file_content(location.file_id).expect("File missing from DB.");
    let summary = db.file_summary(location.file_id).expect("File missing from DB.");

    let span = &location.span;
    let TextPosition { line: first_line_idx, col } = span
        .start
        .position_in_file(db, location.file_id)
        .expect("Failed to find location in file.");
    let mut res = get_line_content(summary, first_line_idx, content, true);
    res += " _";
    res.extend(repeat_n('_', col));
    res += "^\n";
    let TextPosition { line: last_line_idx, col: end_line_col } =
        span.end.position_in_file(db, location.file_id).expect("Failed to find location in file.");

    const LINES_TO_REPLACE_MIDDLE: usize = 3;
    if !skip_middle_lines || first_line_idx + LINES_TO_REPLACE_MIDDLE > last_line_idx {
        for row_index in first_line_idx + 1..=last_line_idx - 1 {
            res += &get_line_content(summary, row_index, content, false);
        }
    } else {
        res += "| ...\n";
    }

    res += &get_line_content(summary, last_line_idx, content, false);
    res += "|";
    res.extend(repeat_n('_', end_line_col));
    res.push('^');

    res
}

fn get_line_content(
    summary: &FileSummary,
    row_index: usize,
    content: &str,
    first_line: bool,
) -> String {
    let line_start = summary.line_offsets[row_index];
    let line_end = match summary.line_offsets.get(row_index + 1) {
        Some(offset) => offset.sub_width(TextWidth::from_char('\n')),
        None => summary.last_offset,
    };

    let line_span = TextSpan::new(line_start, line_end);
    format!("{}{}\n", if first_line { "  " } else { "| " }, line_span.take(content))
}