ruff_diagnostics 0.0.10

This is an internal component crate of Ruff
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

use ruff_text_size::{Ranged, TextSize};

use crate::Edit;

/// Lightweight sourcemap marker representing the source and destination
/// position for an [`Edit`].
#[derive(Debug, PartialEq, Eq)]
pub struct SourceMarker {
    /// Position of the marker in the original source.
    source: TextSize,
    /// Position of the marker in the transformed code.
    dest: TextSize,
}

impl SourceMarker {
    pub fn new(source: TextSize, dest: TextSize) -> Self {
        Self { source, dest }
    }

    pub const fn source(&self) -> TextSize {
        self.source
    }

    pub const fn dest(&self) -> TextSize {
        self.dest
    }
}

/// A collection of [`SourceMarker`].
///
/// Sourcemaps are used to map positions in the original source to positions in
/// the transformed code. Here, only the boundaries of edits are tracked instead
/// of every single character.
///
/// This mapping maintains the invariant that markers are in source order.
#[derive(Default, PartialEq, Eq)]
pub struct SourceMap(Vec<SourceMarker>);

impl SourceMap {
    /// Returns a slice of all the markers in the sourcemap in source order.
    pub fn markers(&self) -> &[SourceMarker] {
        &self.0
    }

    /// Push the start marker for an [`Edit`].
    ///
    /// The `output_length` is the length of the transformed string before the
    /// edit is applied.
    ///
    /// ## Panics
    ///
    /// If the start of `edit` is less than previous markers.
    pub fn push_start_marker(&mut self, edit: &Edit, output_length: TextSize) {
        self.push_marker(edit.start(), output_length);
    }

    /// Push the end marker for an [`Edit`].
    ///
    /// The `output_length` is the length of the transformed string after the
    /// edit has been applied.
    ///
    /// ## Panics
    ///
    /// If `edit` falls before previous markers.
    pub fn push_end_marker(&mut self, edit: &Edit, output_length: TextSize) {
        if edit.is_insertion() {
            self.push_marker(edit.start(), output_length);
        } else {
            // Deletion or replacement
            self.push_marker(edit.end(), output_length);
        }
    }

    /// Push a new marker to the sourcemap.
    ///
    /// ## Panics
    ///
    /// If `offset` is less than previous markers.
    pub fn push_marker(&mut self, offset: TextSize, output_length: TextSize) {
        assert!(
            self.0.last().is_none_or(|last| offset >= last.source),
            "Markers must be pushed in source order",
        );

        self.0.push(SourceMarker {
            source: offset,
            dest: output_length,
        });
    }
}