sysml-v2-parser 0.22.0

//! Parse error types for SysML v2 parser.
//!
//! All line and column values are **1-based**. Use [`ParseError::to_lsp_range`] for
//! 0-based (line, character) ranges as used by the Language Server Protocol.

/// Severity of a parse diagnostic (for language server integration).
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DiagnosticSeverity {
    Error,
    Warning,
}

/// High-level diagnostic taxonomy for parser/evaluator reporting.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DiagnosticCategory {
    ParseError,
    UnsupportedGrammarForm,
    UnresolvedSymbol,
}

/// Error returned when parsing fails.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ParseError {
    /// Human-readable description of the error.
    pub message: String,
    /// Optional byte offset in the input where the error occurred.
    pub offset: Option<usize>,
    /// Optional line number (1-based).
    pub line: Option<u32>,
    /// Optional column (1-based).
    pub column: Option<usize>,
    /// Optional length of the error span in bytes (for LSP range end).
    pub length: Option<usize>,
    /// Severity (defaults to Error when not set).
    pub severity: Option<DiagnosticSeverity>,
    /// Optional code for quick fixes or documentation (e.g. "expected_keyword").
    pub code: Option<String>,
    /// What was expected at this position (e.g. "';' or '}'", "'package' or 'namespace'").
    pub expected: Option<String>,
    /// Snippet of what was found at the error position (for display).
    pub found: Option<String>,
    /// Short hint on how to fix the error.
    pub suggestion: Option<String>,
    /// High-level diagnostic category used by clients to classify failures.
    pub category: Option<DiagnosticCategory>,
    /// When true, this diagnostic is likely a consequence of an earlier error in the same body.
    pub is_cascade: Option<bool>,
}

impl ParseError {
    pub fn new(message: impl Into<String>) -> Self {
        Self {
            message: message.into(),
            offset: None,
            line: None,
            column: None,
            length: None,
            severity: None,
            code: None,
            expected: None,
            found: None,
            suggestion: None,
            category: None,
            is_cascade: None,
        }
    }

    pub fn with_offset(mut self, offset: usize) -> Self {
        self.offset = Some(offset);
        self
    }

    /// Set offset, line, and column for error location.
    pub fn with_location(mut self, offset: usize, line: u32, column: usize) -> Self {
        self.offset = Some(offset);
        self.line = Some(line);
        self.column = Some(column);
        self
    }

    pub fn with_length(mut self, length: usize) -> Self {
        self.length = Some(length);
        self
    }

    pub fn with_severity(mut self, severity: DiagnosticSeverity) -> Self {
        self.severity = Some(severity);
        self
    }

    pub fn with_code(mut self, code: impl Into<String>) -> Self {
        self.code = Some(code.into());
        self
    }

    pub fn with_expected(mut self, expected: impl Into<String>) -> Self {
        self.expected = Some(expected.into());
        self
    }

    pub fn with_found(mut self, found: impl Into<String>) -> Self {
        self.found = Some(found.into());
        self
    }

    pub fn with_suggestion(mut self, suggestion: impl Into<String>) -> Self {
        self.suggestion = Some(suggestion.into());
        self
    }

    pub fn with_category(mut self, category: DiagnosticCategory) -> Self {
        self.category = Some(category);
        self
    }

    pub fn with_is_cascade(mut self, is_cascade: bool) -> Self {
        self.is_cascade = Some(is_cascade);
        self
    }

    /// LSP uses 0-based line and 0-based character. Returns (start_line, start_character, end_line, end_character).
    /// Returns `None` if position is unknown.
    pub fn to_lsp_range(&self) -> Option<(u32, u32, u32, u32)> {
        let (line, column) = (self.line?, self.column?);
        let len = self.length.unwrap_or(1);
        let start_line = line.saturating_sub(1);
        let start_char = column.saturating_sub(1);
        let end_line = start_line;
        let end_char = start_char.saturating_add(len);
        Some((start_line, start_char as u32, end_line, end_char as u32))
    }
}

impl std::fmt::Display for ParseError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let base = self
            .expected
            .as_deref()
            .map(|e| format!("expected {e}"))
            .unwrap_or_else(|| self.message.clone());
        let mut msg = base;
        if let Some(ref found) = self.found {
            if !msg.contains("(found ") {
                msg.push_str(&format!(" (found '{found}')"));
            }
        }
        if let Some(ref suggestion) = self.suggestion {
            msg.push_str(&format!(" {suggestion}"));
        }
        match (self.offset, self.line, self.column) {
            (Some(_), Some(line), Some(col)) => write!(f, "{msg} at line {line}, column {col}"),
            (Some(off), _, _) => write!(f, "{msg} at offset {off}"),
            _ => write!(f, "{msg}"),
        }
    }
}

impl std::error::Error for ParseError {}