bacon 3.23.0

background rust compiler
Documentation
use {
    crate::*,
    lazy_regex::regex_captures,
    serde::{
        Deserialize,
        Serialize,
    },
    std::path::PathBuf,
};

/// A report line
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct Line {
    /// the index among items
    /// (all lines having the same index belong to the same error, warning, or test item,
    /// or just the same unclassified soup)
    pub item_idx: usize,

    pub line_type: LineType,

    pub content: TLine,
}

impl Line {
    /// If the line is a title, get its message
    pub fn title_message(&self) -> Option<&str> {
        let title = match self.line_type {
            LineType::Title(_) => {
                if let Some(content) = self.content.if_unstyled() {
                    Some(content)
                } else {
                    self.content
                        .strings
                        .get(1)
                        .map(|ts| ts.raw.as_str())
                        .map(|s| s.trim_start_matches(|c: char| c.is_whitespace() || c == ':'))
                }
            }
            _ => None,
        };
        title
    }

    pub fn matches(
        &self,
        summary: bool,
    ) -> bool {
        !summary || self.line_type.is_summary()
    }

    /// Return the location as given by the command
    ///
    /// It's usually relative and may contain the line and column
    pub fn location(&self) -> Option<&str> {
        match self.line_type {
            LineType::Location => {
                // the location part is a string at end like src/truc:15:3
                // or src/truc
                self.content
                    .strings
                    .last()
                    .and_then(|ts| regex_captures!(r"(\S+)$", ts.raw.as_str()))
                    .map(|(_, path)| path)
            }
            _ => None,
        }
    }

    /// Try to guess the kind of diagnostic (eg "unused_variable")
    ///
    /// Might be moved to the Analyzer trait in the future to support
    ///  tools expressing their diagnostics in a different way.
    pub fn diag_type(&self) -> Option<&str> {
        match self.line_type {
            LineType::Title(_) => {
                // first string is usually something like "warning"
                let second = self.content.strings.get(1)?;
                let (_, dt) = regex_captures!(r#"^:?\s*([^:]+)"#, second.raw.as_str(),)?;
                Some(dt.trim_end())
            }
            LineType::Normal => {
                // quite ad-hoc detection for cargo, might be removed
                let third = self.content.strings.get(2)?;
                if third.raw == "note" {
                    let fourth = self.content.strings.get(3)?;
                    let (_, dt) =
                        regex_captures!(r"^[` :]*#\[warn\((\w+)\)\]", fourth.raw.as_str(),)?;
                    return Some(dt.trim_end());
                }
                None
            }
            _ => None,
        }
    }

    /// Return the absolute path to the error/warning/test location
    pub fn location_path(
        &self,
        mission: &Mission,
    ) -> Option<PathBuf> {
        let location_path = self.location()?;
        let mut location_path = PathBuf::from(location_path);
        if !location_path.is_absolute() {
            location_path = mission.package_directory.join(location_path);
        }
        Some(location_path)
    }

    pub fn is_continuation(&self) -> bool {
        matches!(self.line_type, LineType::Continuation { .. })
    }
}

impl From<CommandOutputLine> for Line {
    fn from(col: CommandOutputLine) -> Self {
        Line {
            item_idx: 0,
            content: col.content,
            line_type: LineType::Raw(col.origin),
        }
    }
}