sway-types/src/span.rs - master - githubmirror/sway

sway-types/src/span.rs
384 строки10 KB
Igor Rončević
Compile runtime backtracing to ASM and compile-time to ABI JSON (#7387)
09 окт 2025, 11:45
09 окт 2025, 11:451da5e66
use crate::SourceId;
use lazy_static::lazy_static;
use serde::{Deserialize, Serialize};
use std::{
    cmp,
    fmt::{self, Display},
    hash::Hash,
    sync::Arc,
};

lazy_static! {
    static ref DUMMY_SPAN: Span = Span::new(
        Source {
            text: Arc::from(""),
            line_starts: Arc::new(vec![])
        },
        0,
        0,
        None
    )
    .unwrap();
}

// remote="Self" is a serde pattern for post-deserialization code.
// See https://github.com/serde-rs/serde/issues/1118#issuecomment-1320706758
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(transparent, remote = "Self")]
pub struct Source {
    pub text: Arc<str>,
    #[serde(skip)]
    pub line_starts: Arc<Vec<usize>>,
}

impl serde::Serialize for Source {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        Self::serialize(self, serializer)
    }
}

impl<'de> serde::Deserialize<'de> for Source {
    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        let mut src = Self::deserialize(deserializer)?;
        src.line_starts = Self::calc_line_starts(&src.text);
        Ok(src)
    }
}

impl Source {
    fn calc_line_starts(text: &str) -> Arc<Vec<usize>> {
        let mut lines_starts = Vec::with_capacity(text.len() / 80);
        lines_starts.push(0);
        for (idx, c) in text.char_indices() {
            if c == '\n' {
                lines_starts.push(idx + c.len_utf8())
            }
        }
        Arc::new(lines_starts)
    }

    pub fn new(text: &str) -> Self {
        Self {
            text: Arc::from(text),
            line_starts: Self::calc_line_starts(text),
        }
    }

    /// Both lines and columns start at index 0
    pub fn line_col_zero_index(&self, position: usize) -> LineCol {
        if position > self.text.len() || self.text.is_empty() {
            LineCol { line: 0, col: 0 }
        } else {
            let (line, line_start) = match self.line_starts.binary_search(&position) {
                Ok(line) => (line, self.line_starts.get(line)),
                Err(0) => (0, None),
                Err(line) => (line - 1, self.line_starts.get(line - 1)),
            };
            line_start.map_or(LineCol { line: 0, col: 0 }, |line_start| LineCol {
                line,
                col: position - line_start,
            })
        }
    }

    /// Both lines and columns start at index 1
    pub fn line_col_one_index(&self, position: usize) -> LineCol {
        let LineCol { line, col } = self.line_col_zero_index(position);
        LineCol {
            line: line + 1,
            col: col + 1,
        }
    }
}

impl From<&str> for Source {
    fn from(value: &str) -> Self {
        Self::new(value)
    }
}

/// Represents a span of the source code in a specific file.
#[derive(Clone, Serialize, Deserialize)]
pub struct Span {
    /// The original source code.
    src: Source,
    /// The byte position in the string of the start of the span.
    start: usize,
    /// The byte position in the string of the end of the span.
    end: usize,
    /// The source ID of the file from which this span originated.
    source_id: Option<SourceId>,
}

impl PartialOrd for Span {
    fn partial_cmp(&self, other: &Self) -> Option<cmp::Ordering> {
        if !Arc::ptr_eq(&self.src.text, &other.src.text) {
            None
        } else {
            match self.start.partial_cmp(&other.start) {
                Some(core::cmp::Ordering::Equal) => self.end.partial_cmp(&other.end),
                ord => ord,
            }
        }
    }
}

impl Hash for Span {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        self.start.hash(state);
        self.end.hash(state);
        self.source_id.hash(state);
    }
}

impl PartialEq for Span {
    fn eq(&self, other: &Self) -> bool {
        self.start == other.start && self.end == other.end && self.source_id == other.source_id
    }
}

impl Eq for Span {}

impl From<Span> for std::ops::Range<usize> {
    fn from(value: Span) -> Self {
        Self {
            start: value.start,
            end: value.end,
        }
    }
}

impl Span {
    pub fn dummy() -> Span {
        DUMMY_SPAN.clone()
    }

    pub fn new(src: Source, start: usize, end: usize, source: Option<SourceId>) -> Option<Span> {
        let _ = src.text.get(start..end)?;
        Some(Span {
            src,
            start,
            end,
            source_id: source,
        })
    }

    /// Creates an empty [Span], means a span whose [Span::start] and [Span::end] are the same.
    /// The resulting empty [Span] will point to the start of the provided `span` and
    /// be in the same file.
    pub fn empty_at_start(span: &Span) -> Span {
        Span::new(
            span.src().clone(),
            span.start(),
            span.start(),
            span.source_id().copied(),
        )
        .expect("the existing `span` is a valid `Span`")
    }

    /// Creates an empty [Span], means a span whose [Span::start] and [Span::end] are the same.
    /// The resulting empty [Span] will point to the end of the provided `span` and
    /// be in the same file.
    pub fn empty_at_end(span: &Span) -> Span {
        Span::new(
            span.src().clone(),
            span.end(),
            span.end(),
            span.source_id().copied(),
        )
        .expect("the existing `span` is a valid `Span`")
    }

    pub fn from_string(source: String) -> Span {
        let len = source.len();
        Span::new(Source::new(&source), 0, len, None).unwrap()
    }

    pub fn src(&self) -> &Source {
        &self.src
    }

    pub fn source_id(&self) -> Option<&SourceId> {
        self.source_id.as_ref()
    }

    pub fn start(&self) -> usize {
        self.start
    }

    pub fn end(&self) -> usize {
        self.end
    }

    /// Both lines and columns start at index 1
    pub fn start_line_col_one_index(&self) -> LineCol {
        self.src.line_col_one_index(self.start)
    }

    /// Both lines and columns start at index 1
    pub fn end_line_col_one_index(&self) -> LineCol {
        self.src.line_col_one_index(self.end)
    }

    /// Returns an empty [Span] that points to the start of `self`.
    pub fn start_span(&self) -> Span {
        Self::empty_at_start(self)
    }

    /// Returns an empty [Span] that points to the end of `self`.
    pub fn end_span(&self) -> Span {
        Self::empty_at_end(self)
    }

    pub fn str(self) -> String {
        self.as_str().to_owned()
    }

    pub fn as_str(&self) -> &str {
        &self.src.text[self.start..self.end]
    }

    pub fn input(&self) -> &str {
        &self.src.text
    }

    pub fn trim(self) -> Span {
        let start_delta = self.as_str().len() - self.as_str().trim_start().len();
        let end_delta = self.as_str().len() - self.as_str().trim_end().len();
        Span {
            src: self.src,
            start: self.start + start_delta,
            end: self.end - end_delta,
            source_id: self.source_id,
        }
    }

    /// Creates a new span that points to very next char of the current span.
    ///
    /// ```ignore
    /// let
    ///    ^ <- span returned
    /// ^^^  <- original span
    /// ```
    pub fn next_char_utf8(&self) -> Option<Span> {
        let char = self.src.text[self.end..].chars().next()?;
        Some(Span {
            src: self.src.clone(),
            source_id: self.source_id,
            start: self.end,
            end: self.end + char.len_utf8(),
        })
    }

    /// This panics if the spans are not from the same file. This should
    /// only be used on spans that are actually next to each other.
    pub fn join(s1: Span, s2: &Span) -> Span {
        assert!(
            Arc::ptr_eq(&s1.src.text, &s2.src.text) && s1.source_id == s2.source_id,
            "Spans from different files cannot be joined.",
        );

        Span {
            src: s1.src,
            start: cmp::min(s1.start, s2.start),
            end: cmp::max(s1.end, s2.end),
            source_id: s1.source_id,
        }
    }

    pub fn join_all(spans: impl IntoIterator<Item = Span>) -> Span {
        spans
            .into_iter()
            .reduce(|s1: Span, s2: Span| Span::join(s1, &s2))
            .unwrap_or_else(Span::dummy)
    }

    /// Returns the line and column start and end using index 1.
    pub fn line_col_one_index(&self) -> LineColRange {
        LineColRange {
            start: self.start_line_col_one_index(),
            end: self.end_line_col_one_index(),
        }
    }

    pub fn is_dummy(&self) -> bool {
        self.eq(&DUMMY_SPAN)
    }

    pub fn is_empty(&self) -> bool {
        self.start == self.end
    }

    /// Returns true if `self` contains `other`.
    pub fn contains(&self, other: &Span) -> bool {
        Arc::ptr_eq(&self.src.text, &other.src.text)
            && self.source_id == other.source_id
            && self.start <= other.start
            && self.end >= other.end
    }

    /// Returns a subset of this span until the first occurrence of the passed text.
    pub fn subset_first_of(&self, needle: &str) -> Option<Span> {
        let text = &self.src().text;
        let needle_offset = text[self.start..].find(needle)?;
        Span::new(
            self.src().clone(),
            self.start,
            self.start + needle_offset,
            self.source_id().cloned(),
        )
    }
}

impl fmt::Debug for Span {
    #[cfg(not(feature = "no-span-debug"))]
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        fmt.debug_struct("Span")
            .field("src (ptr)", &self.src.text.as_ptr())
            .field("source_id", &self.source_id)
            .field("start", &self.start)
            .field("end", &self.end)
            .field("as_str()", &self.as_str())
            .finish()
    }
    #[cfg(feature = "no-span-debug")]
    fn fmt(&self, _fmt: &mut fmt::Formatter) -> fmt::Result {
        Ok(())
    }
}

pub trait Spanned {
    fn span(&self) -> Span;
}

impl<T: Spanned> Spanned for Box<T> {
    fn span(&self) -> Span {
        (**self).span()
    }
}

#[derive(Clone, Copy, Debug, Default, Serialize, Deserialize, PartialEq, Eq, Hash)]
pub struct LineCol {
    pub line: usize,
    pub col: usize,
}

pub struct LineColRange {
    pub start: LineCol,
    pub end: LineCol,
}

impl Display for LineColRange {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_fmt(format_args!("({}, {})", self.start, self.end))
    }
}

impl Display for LineCol {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_fmt(format_args!("line {}:{}", self.line, self.col))
    }
}