rsbinder_aidl/

error.rs

// Copyright 2022 Jeff Kim <hiking90@gmail.com>
// SPDX-License-Identifier: Apache-2.0

// Struct fields are used via trait implementation methods generated by miette's
// #[derive(Diagnostic)], but rustc lint analysis cannot track proc-macro-generated
// code, so warnings would be raised without this allow.
#![allow(unused_assignments)]

use miette::{Diagnostic, NamedSource, SourceSpan};
use thiserror::Error;

/// Top-level error type for the AIDL compiler
#[derive(Error, Debug, Diagnostic)]
pub enum AidlError {
    #[error(transparent)]
    #[diagnostic(transparent)]
    Parse(Box<ParseError>),

    #[error(transparent)]
    #[diagnostic(transparent)]
    Semantic(Box<SemanticError>),

    #[error(transparent)]
    #[diagnostic(transparent)]
    Resolution(Box<ResolutionError>),

    #[error(transparent)]
    Io(#[from] std::io::Error),

    /// Aggregates multiple errors when processing several AIDL files
    #[error("{} error(s) occurred during AIDL compilation", errors.len())]
    #[diagnostic(code(aidl::multiple_errors))]
    Multiple {
        #[related]
        errors: Vec<AidlError>,
    },
}

impl From<ParseError> for AidlError {
    fn from(e: ParseError) -> Self {
        AidlError::Parse(Box::new(e))
    }
}

impl From<SemanticError> for AidlError {
    fn from(e: SemanticError) -> Self {
        AidlError::Semantic(Box::new(e))
    }
}

impl From<ResolutionError> for AidlError {
    fn from(e: ResolutionError) -> Self {
        AidlError::Resolution(Box::new(e))
    }
}

impl AidlError {
    /// Collects errors, flattening any nested Multiple variants.
    pub fn collect(errors: Vec<AidlError>) -> Option<AidlError> {
        let flat: Vec<AidlError> = errors
            .into_iter()
            .flat_map(|e| match e {
                AidlError::Multiple { errors } => errors,
                other => vec![other],
            })
            .collect();
        match flat.len() {
            0 => None,
            1 => flat.into_iter().next(),
            _ => Some(AidlError::Multiple { errors: flat }),
        }
    }
}

/// Parse error (wraps a pest parser error)
#[allow(unused)]
#[derive(Error, Debug, Diagnostic)]
#[error("AIDL syntax error")]
#[diagnostic(code(aidl::parse_error))]
pub struct ParseError {
    #[source_code]
    pub src: NamedSource<String>,
    #[label("{message}")]
    pub span: SourceSpan,
    pub message: String,
    #[help]
    pub help: Option<String>,
}

/// Semantic errors (type validation, transaction codes, etc.)
#[allow(unused)]
#[derive(Error, Debug, Diagnostic)]
pub enum SemanticError {
    #[error("Interface '{interface}': transaction code {code} conflict between '{method1}' and '{method2}'")]
    #[diagnostic(
        code(aidl::duplicate_transaction_code),
        help("use unique positive integer values for each method's transaction code")
    )]
    DuplicateTransactionCode {
        interface: String,
        method1: String,
        method2: String,
        code: i64,
        #[source_code]
        src: NamedSource<String>,
        #[label("method '{method1}' uses code {code}")]
        span: SourceSpan,
        #[related]
        related: Vec<DuplicateCodeRelated>,
    },

    #[error("Interface '{interface}': mixed explicit/implicit transaction IDs")]
    #[diagnostic(
        code(aidl::mixed_transaction_ids),
        help("either all methods must have explicitly assigned transaction IDs or none of them should")
    )]
    MixedTransactionIds {
        interface: String,
        #[source_code]
        src: NamedSource<String>,
        #[label("defined in this interface")]
        span: SourceSpan,
    },

    /// Code path unreachable with the current AIDL grammar.
    /// The pest grammar's INTVALUE rule does not allow a minus sign, so this
    /// variant is only covered by unit tests that construct MethodDecl directly.
    #[error("Interface '{interface}': method '{method}' has negative transaction code {code}")]
    #[diagnostic(
        code(aidl::negative_transaction_code),
        help("transaction codes must be non-negative integers within u32 range")
    )]
    NegativeTransactionCode {
        interface: String,
        method: String,
        code: i64,
        #[source_code]
        src: NamedSource<String>,
        #[label("negative code here")]
        span: SourceSpan,
    },

    #[error("Interface '{interface}': method '{method}' has transaction code {code} exceeding u32 range")]
    #[diagnostic(
        code(aidl::transaction_code_overflow),
        help("transaction codes must fit within u32 (0..=4294967295)")
    )]
    TransactionCodeOverflow {
        interface: String,
        method: String,
        code: i64,
        #[source_code]
        src: NamedSource<String>,
        #[label("overflowing code here")]
        span: SourceSpan,
    },

    #[error("unsupported type: {type_name}")]
    #[diagnostic(code(aidl::unsupported_type))]
    UnsupportedType {
        type_name: String,
        #[help]
        help: Option<String>,
        #[source_code]
        src: NamedSource<String>,
        #[label("this type is not supported")]
        span: SourceSpan,
    },

    #[error("invalid operation: {message}")]
    #[diagnostic(code(aidl::invalid_operation))]
    InvalidOperation {
        message: String,
        #[source_code]
        src: NamedSource<String>,
        #[label("here")]
        span: SourceSpan,
    },
}

/// Auxiliary diagnostic for marking the second conflicting location in
/// DuplicateTransactionCode.
///
/// Note: because `{method}` is interpolated inside `#[label]`, the `method`
/// field must be declared before `span` for the miette derive macro to work
/// correctly (miette 7.x constraint).
#[allow(unused)]
#[derive(Error, Debug, Diagnostic)]
#[error("conflicting method defined here")]
pub struct DuplicateCodeRelated {
    pub method: String,
    #[source_code]
    pub src: NamedSource<String>,
    #[label("method '{method}' also uses this code")]
    pub span: SourceSpan,
}

/// Name resolution errors (imports, namespaces)
#[allow(unused)]
#[derive(Error, Debug, Diagnostic)]
pub enum ResolutionError {
    #[error("import '{import}' not found")]
    #[diagnostic(
        code(aidl::import_not_found),
        help("check that the imported type exists in the include paths")
    )]
    ImportNotFound {
        import: String,
        #[source_code]
        src: NamedSource<String>,
        #[label("imported here")]
        span: SourceSpan,
    },

    #[error("unknown type '{name}'")]
    #[diagnostic(
        code(aidl::unknown_type),
        help("verify that the type is defined and imported correctly")
    )]
    UnknownType {
        name: String,
        #[source_code]
        src: NamedSource<String>,
        #[label("referenced here")]
        span: SourceSpan,
    },
}

/// Lightweight error type used to propagate arithmetic errors from const_expr.rs.
/// Carries only a message without source location; the caller (parser/generator)
/// attaches source context and converts it into SemanticError::InvalidOperation.
#[derive(Error, Debug)]
#[error("{message}")]
pub struct ConstExprError {
    pub message: String,
}

impl ConstExprError {
    pub fn new(message: impl Into<String>) -> Self {
        Self {
            message: message.into(),
        }
    }
}

/// Converts a pest error into a miette ParseError.
///
/// Generic over the Rule type so this utility does not depend on the
/// concrete Rule type defined in parser.rs.
pub fn pest_error_to_diagnostic<R: pest::RuleType>(
    err: pest::error::Error<R>,
    filename: &str,
    source: &str,
) -> ParseError {
    let (offset, length) = match err.location {
        pest::error::InputLocation::Pos(pos) => {
            // Guard against exceeding the source range when the error is at EOF
            let len = if pos >= source.len() { 0 } else { 1 };
            (pos, len)
        }
        pest::error::InputLocation::Span((start, end)) => (start, end - start),
    };

    let message = match &err.variant {
        pest::error::ErrorVariant::ParsingError {
            positives,
            negatives,
        } => format_pest_expectations(positives, negatives),
        pest::error::ErrorVariant::CustomError { message } => message.clone(),
    };

    ParseError {
        src: NamedSource::new(filename, source.to_string()),
        span: SourceSpan::new(offset.into(), length),
        message,
        help: None,
    }
}

/// Formats expected/unexpected token information from a pest parse error into a human-readable message.
fn format_pest_expectations<R: std::fmt::Debug>(positives: &[R], negatives: &[R]) -> String {
    let mut parts = Vec::new();

    if !positives.is_empty() {
        let pos_str: Vec<String> = positives.iter().map(|r| format!("{r:?}")).collect();
        parts.push(format!("expected {}", pos_str.join(", ")));
    }

    if !negatives.is_empty() {
        let neg_str: Vec<String> = negatives.iter().map(|r| format!("{r:?}")).collect();
        parts.push(format!("unexpected {}", neg_str.join(", ")));
    }

    if parts.is_empty() {
        "syntax error".to_string()
    } else {
        parts.join("; ")
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn span(offset: usize, len: usize) -> SourceSpan {
        SourceSpan::new(offset.into(), len)
    }

    // 1.1a: ParseError Display trait
    #[test]
    fn test_parse_error_display() {
        let err = ParseError {
            src: NamedSource::new("test.aidl", "parcelable Foo {}".to_string()),
            span: span(0, 1),
            message: "unexpected token".to_string(),
            help: None,
        };
        let display = format!("{err}");
        assert!(display.contains("AIDL syntax error"), "Got: {display}");
    }

    // 1.1b: ParseError diagnostic code
    #[test]
    fn test_parse_error_diagnostic_code() {
        use miette::Diagnostic;
        let err = ParseError {
            src: NamedSource::new("test.aidl", "parcelable Foo {}".to_string()),
            span: span(0, 1),
            message: "test error".to_string(),
            help: None,
        };
        let code = err.code().expect("ParseError must have a diagnostic code");
        assert_eq!(code.to_string(), "aidl::parse_error");
    }

    // 1.1c: ParseError source span
    #[test]
    fn test_parse_error_source_span() {
        use miette::Diagnostic;
        let err = ParseError {
            src: NamedSource::new("test.aidl", "parcelable Foo {}".to_string()),
            span: span(10, 3),
            message: "test error".to_string(),
            help: None,
        };
        let labels: Vec<_> = err.labels().expect("must have labels").collect();
        assert_eq!(labels.len(), 1);
        let label_span = labels[0].inner();
        assert_eq!(label_span.offset(), 10);
        assert_eq!(label_span.len(), 3);
    }

    // 1.1d: SemanticError variants Display
    #[test]
    fn test_semantic_error_variants_display() {
        let err = SemanticError::MixedTransactionIds {
            interface: "IFoo".to_string(),
            src: NamedSource::new("test.aidl", "interface IFoo {}".to_string()),
            span: span(0, 4),
        };
        let display = format!("{err}");
        assert!(
            display.contains("IFoo"),
            "Display should contain interface name, got: {display}"
        );
        assert!(
            display.contains("mixed"),
            "Display should contain 'mixed', got: {display}"
        );
    }

    // 1.1e: ResolutionError::ImportNotFound Display
    #[test]
    fn test_resolution_error_display() {
        let err = ResolutionError::ImportNotFound {
            import: "foo.bar.Baz".to_string(),
            src: NamedSource::new("test.aidl", "import foo.bar.Baz;".to_string()),
            span: span(0, 18),
        };
        let display = format!("{err}");
        assert!(display.contains("foo.bar.Baz"), "Got: {display}");
        assert!(display.contains("not found"), "Got: {display}");
    }

    // 1.1f: AidlError From<ParseError> conversion
    #[test]
    fn test_aidl_error_from_parse_error() {
        let parse_err = ParseError {
            src: NamedSource::new("test.aidl", "bad".to_string()),
            span: span(0, 3),
            message: "syntax error".to_string(),
            help: None,
        };
        let aidl_err: AidlError = parse_err.into();
        assert!(matches!(aidl_err, AidlError::Parse(_)));
    }

    // 1.1g: AidlError → Box<dyn Error> conversion (API compatibility)
    #[test]
    fn test_aidl_error_into_box_dyn_error() {
        use std::error::Error;
        let parse_err = ParseError {
            src: NamedSource::new("test.aidl", "bad".to_string()),
            span: span(0, 3),
            message: "syntax error".to_string(),
            help: None,
        };
        let aidl_err: AidlError = parse_err.into();
        let _box_err: Box<dyn Error> = aidl_err.into();
    }

    // 1.1h: pest Pos location → SourceSpan conversion
    #[test]
    fn test_pest_error_to_diagnostic_pos() {
        use miette::Diagnostic;
        // Pos(42): source is long enough, so length == 1
        let source = "a".repeat(100);
        let err = ParseError {
            src: NamedSource::new("test.aidl", source.clone()),
            span: span(42, 1),
            message: "test".to_string(),
            help: None,
        };
        let labels: Vec<_> = err.labels().expect("must have labels").collect();
        assert_eq!(labels[0].inner().offset(), 42);
        assert_eq!(labels[0].inner().len(), 1);
    }

    // 1.1i: pest Span location → SourceSpan conversion
    #[test]
    fn test_pest_error_to_diagnostic_span() {
        use miette::Diagnostic;
        let err = ParseError {
            src: NamedSource::new("test.aidl", "0123456789abcdefghij".to_string()),
            span: span(10, 10),
            message: "test".to_string(),
            help: None,
        };
        let labels: Vec<_> = err.labels().expect("must have labels").collect();
        assert_eq!(labels[0].inner().offset(), 10);
        assert_eq!(labels[0].inner().len(), 10);
    }

    // 1.1j: pest EOF location → SourceSpan conversion (guards against out-of-range)
    #[test]
    fn test_pest_error_to_diagnostic_eof() {
        let source = "abc";
        // EOF: pos >= source.len() → length = 0
        let (offset, length) = {
            let pos = source.len();
            let len = if pos >= source.len() { 0 } else { 1 };
            (pos, len)
        };
        let err = ParseError {
            src: NamedSource::new("test.aidl", source.to_string()),
            span: span(offset, length),
            message: "unexpected EOF".to_string(),
            help: None,
        };
        use miette::Diagnostic;
        let labels: Vec<_> = err.labels().expect("must have labels").collect();
        assert_eq!(labels[0].inner().offset(), 3);
        assert_eq!(labels[0].inner().len(), 0);
    }

    // 1.1k: AidlError::collect() — flattens nested Multiple variants
    #[test]
    fn test_aidl_error_collect_flatten() {
        let make_parse_err = |msg: &str| {
            AidlError::Parse(Box::new(ParseError {
                src: NamedSource::new("test.aidl", msg.to_string()),
                span: span(0, 1),
                message: msg.to_string(),
                help: None,
            }))
        };

        let a = make_parse_err("error A");
        let b = make_parse_err("error B");
        let c = make_parse_err("error C");

        // Multiple{[A, B]} + C → Multiple{[A, B, C]}
        let nested = AidlError::Multiple { errors: vec![a, b] };
        let result = AidlError::collect(vec![nested, c]);

        match result {
            Some(AidlError::Multiple { errors }) => {
                assert_eq!(errors.len(), 3, "Expected 3 flattened errors");
            }
            other => panic!("Expected Multiple, got: {other:?}"),
        }
    }

    // 1.1l: AidlError::collect() — single error is not wrapped in Multiple
    #[test]
    fn test_aidl_error_collect_single() {
        let err = AidlError::Parse(Box::new(ParseError {
            src: NamedSource::new("test.aidl", "bad".to_string()),
            span: span(0, 3),
            message: "syntax error".to_string(),
            help: None,
        }));
        let result = AidlError::collect(vec![err]);
        assert!(
            matches!(result, Some(AidlError::Parse(_))),
            "Single error should not be wrapped in Multiple"
        );
    }

    // 1.1m: AidlError::collect() — empty collection returns None
    #[test]
    fn test_aidl_error_collect_empty() {
        let result = AidlError::collect(vec![]);
        assert!(result.is_none(), "Empty collection should return None");
    }
}