packr-derive 0.12.6

//! Derive macros for pack-abi Value conversion.
//!
//! This crate provides `#[derive(GraphValue)]` which generates implementations
//! of `From<T> for Value` and `TryFrom<Value> for T`.
//!
//! # Example
//!
//! ```ignore
//! use packr_abi::{GraphValue, Value};
//!
//! #[derive(GraphValue)]
//! struct Point {
//!     x: i64,
//!     y: i64,
//! }
//!
//! let point = Point { x: 10, y: 20 };
//! let value: Value = point.into();
//! let back: Point = value.try_into().unwrap();
//! ```
//!
//! # Crate Path
//!
//! By default, the macro expects `packr_abi` to be in scope. For `no_std` guests
//! using `packr_guest`, specify the crate path:
//!
//! ```ignore
//! use packr_guest::GraphValue;
//!
//! #[derive(GraphValue)]
//! #[graph(crate = "packr_guest::composite_abi")]
//! struct MyState {
//!     count: i32,
//! }
//! ```

use proc_macro::TokenStream;
use quote::{format_ident, quote};
use syn::{parse_macro_input, Attribute, Data, DeriveInput, Fields, Meta};

/// Extract the crate path from `#[graph(crate = "...")]` attribute.
/// Defaults to `packr_abi` if not specified.
fn get_crate_path(attrs: &[Attribute]) -> proc_macro2::TokenStream {
    for attr in attrs {
        if attr.path().is_ident("graph") {
            if let Meta::List(list) = &attr.meta {
                let tokens = list.tokens.to_string();
                // The `graph(...)` list can carry multiple comma-separated args
                // (e.g. `crate = "...", forward_compatible`), so scan each part
                // for `crate = "..."` rather than assuming it is the whole list —
                // otherwise a trailing arg would leave the string not ending in a
                // quote and silently fall through to the default crate.
                for part in tokens.split(',') {
                    let part = part.trim();
                    if let Some(rest) = part.strip_prefix("crate") {
                        let rest = rest.trim();
                        if let Some(rest) = rest.strip_prefix('=') {
                            let rest = rest.trim();
                            if rest.len() >= 2 && rest.starts_with('"') && rest.ends_with('"') {
                                let path_str = &rest[1..rest.len() - 1];
                                // Convert string path to token stream
                                let path: syn::Path =
                                    syn::parse_str(path_str).expect("Invalid crate path");
                                return quote! { #path };
                            }
                        }
                    }
                }
            }
        }
    }
    // Default to packr_abi
    quote! { packr_abi }
}

/// Derive macro for converting between Rust types and `Value`.
///
/// # Structs
///
/// Structs are converted to `Value::Record` with field names as keys.
///
/// ```ignore
/// #[derive(GraphValue)]
/// struct Person {
///     name: String,
///     age: i64,
/// }
/// ```
///
/// # Enums
///
/// Enums are converted to `Value::Variant` with the variant index as tag.
///
/// ```ignore
/// #[derive(GraphValue)]
/// enum Shape {
///     Circle(f64),           // tag 0, payload = radius
///     Rectangle(f64, f64),   // tag 1, payload = tuple(width, height)
///     Point,                 // tag 2, no payload
/// }
/// ```
///
/// # Attributes
///
/// - `#[graph(crate = "path")]` - Specify the crate path (default: `packr_abi`)
/// - `#[graph(rename = "name")]` - Use a different name for field/variant
/// - `#[graph(tag = N)]` - Use explicit tag number for variant
/// - `#[graph(forward_compatible)]` - Tolerant decode for schema evolution on a
///   STRUCT: a missing field defaults and an extra field is ignored, so appending
///   a field is decode-safe both ways (old build reads new data; new build reads
///   old data — no rollback data loss, no hand-written pad-missing migration).
///   Default (absent) is a strict field-count decode. Named structs match fields
///   by name (add/remove/reorder tolerated); tuple structs are positional, so only
///   APPENDING a trailing field is safe. Encode is unchanged (wire-compatible).
#[proc_macro_derive(GraphValue, attributes(graph))]
pub fn derive_graph_value(input: TokenStream) -> TokenStream {
    let input = parse_macro_input!(input as DeriveInput);
    let crate_path = get_crate_path(&input.attrs);

    let expanded = match &input.data {
        Data::Struct(data) => derive_struct(&input, data, &crate_path),
        Data::Enum(data) => derive_enum(&input, data, &crate_path),
        Data::Union(_) => {
            return syn::Error::new_spanned(&input, "GraphValue cannot be derived for unions")
                .to_compile_error()
                .into();
        }
    };

    expanded.into()
}

/// Whether `#[graph(forward_compatible)]` is present. It opts a struct into a
/// schema-evolution-tolerant decode: a MISSING field defaults instead of erroring,
/// and EXTRA fields are ignored, so appending a field stays decode-safe in BOTH
/// directions (an old build reads new data; a new build reads old data). Default
/// (attr absent) keeps the strict field-count decode so genuine field-count bugs
/// still fail loud. For NAMED structs fields are matched by NAME, so add/remove/
/// reorder are all tolerated; for TUPLE structs decode is POSITIONAL, so only
/// APPENDING a trailing field is safe (never mid-insert or reorder).
fn has_forward_compatible(attrs: &[Attribute]) -> bool {
    for attr in attrs {
        if attr.path().is_ident("graph") {
            if let Meta::List(list) = &attr.meta {
                let tokens = list.tokens.to_string();
                if tokens.split(',').any(|t| t.trim() == "forward_compatible") {
                    return true;
                }
            }
        }
    }
    false
}

fn derive_struct(
    input: &DeriveInput,
    data: &syn::DataStruct,
    krate: &proc_macro2::TokenStream,
) -> proc_macro2::TokenStream {
    let name = &input.ident;
    let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();
    let forward_compatible = has_forward_compatible(&input.attrs);

    match &data.fields {
        Fields::Named(fields) => {
            // Generate TryFrom<Value> for T
            let field_from_value: Vec<_> = fields.named.iter().map(|f| {
                let field_name = f.ident.as_ref().unwrap();
                let field_name_str = get_rename(&f.attrs).unwrap_or_else(|| field_name.to_string());
                let field_type = &f.ty;
                if forward_compatible {
                    // A missing field defaults instead of erroring (extra fields are
                    // simply never looked up, since decode is by name).
                    quote! {
                        #field_name: match fields.iter()
                            .find(|(name, _)| name == #field_name_str)
                            .map(|(_, v)| v.clone())
                        {
                            #krate::__private::Some(field_value) =>
                                <#field_type as #krate::__private::TryFrom<#krate::Value>>::try_from(field_value)
                                    .map_err(|e| #krate::ConversionError::FieldError(
                                        #krate::__private::String::from(#field_name_str),
                                        #krate::__private::Box::new(e)
                                    ))?,
                            #krate::__private::None =>
                                <#field_type as ::core::default::Default>::default(),
                        }
                    }
                } else {
                    quote! {
                        #field_name: {
                            let field_value = fields.iter()
                                .find(|(name, _)| name == #field_name_str)
                                .map(|(_, v)| v.clone())
                                .ok_or_else(|| #krate::ConversionError::MissingField(
                                    #krate::__private::String::from(#field_name_str)
                                ))?;
                            <#field_type as #krate::__private::TryFrom<#krate::Value>>::try_from(field_value)
                                .map_err(|e| #krate::ConversionError::FieldError(
                                    #krate::__private::String::from(#field_name_str),
                                    #krate::__private::Box::new(e)
                                ))?
                        }
                    }
                }
            }).collect();

            let field_count = fields.named.len();

            // Generate field accessors for From impl
            let field_accessors: Vec<_> = fields
                .named
                .iter()
                .map(|f| {
                    let field_name = f.ident.as_ref().unwrap();
                    let field_name_str =
                        get_rename(&f.attrs).unwrap_or_else(|| field_name.to_string());
                    quote! {
                        (
                            #krate::__private::String::from(#field_name_str),
                            #krate::Value::from(value.#field_name)
                        )
                    }
                })
                .collect();

            let type_name_str = name.to_string();

            // A forward-compatible record does not check the field count: extra
            // fields are ignored and missing ones default (above), which is what
            // makes appending a field decode-safe both ways.
            let count_check = if forward_compatible {
                quote! {}
            } else {
                quote! {
                    if fields.len() != #field_count {
                        return #krate::__private::Err(#krate::ConversionError::WrongFieldCount {
                            expected: #field_count,
                            got: fields.len(),
                        });
                    }
                }
            };

            quote! {
                impl #impl_generics #krate::__private::From<#name #ty_generics> for #krate::Value #where_clause {
                    fn from(value: #name #ty_generics) -> #krate::Value {
                        #krate::Value::Record {
                            type_name: #krate::__private::String::from(#type_name_str),
                            fields: #krate::__private::vec![
                                #(#field_accessors),*
                            ],
                        }
                    }
                }

                impl #impl_generics #krate::__private::TryFrom<#krate::Value> for #name #ty_generics #where_clause {
                    type Error = #krate::ConversionError;

                    fn try_from(value: #krate::Value) -> #krate::__private::Result<Self, Self::Error> {
                        match value {
                            #krate::Value::Record { fields, .. } => {
                                #count_check
                                #krate::__private::Ok(Self {
                                    #(#field_from_value),*
                                })
                            }
                            other => #krate::__private::Err(#krate::ConversionError::ExpectedRecord(
                                #krate::__private::format!("{:?}", other)
                            )),
                        }
                    }
                }

                impl #impl_generics #krate::KnownValueType for #name #ty_generics #where_clause {
                    fn known_value_type() -> #krate::ValueType {
                        #krate::ValueType::Record(
                            #krate::__private::String::from(#type_name_str)
                        )
                    }
                }
            }
        }
        Fields::Unnamed(fields) => {
            // Tuple struct -> Value::Tuple
            let field_indices: Vec<_> = (0..fields.unnamed.len()).map(syn::Index::from).collect();

            let field_from_value: Vec<_> = fields.unnamed.iter().enumerate().map(|(i, f)| {
                let field_type = &f.ty;
                if forward_compatible {
                    // Decode is positional: a missing trailing index defaults, an
                    // extra trailing element is ignored (below). Only APPENDING a
                    // trailing field is safe for a tuple struct.
                    quote! {
                        match fields.get(#i).cloned() {
                            #krate::__private::Some(field_value) =>
                                <#field_type as #krate::__private::TryFrom<#krate::Value>>::try_from(field_value)
                                    .map_err(|e| #krate::ConversionError::IndexError(#i, #krate::__private::Box::new(e)))?,
                            #krate::__private::None =>
                                <#field_type as ::core::default::Default>::default(),
                        }
                    }
                } else {
                    quote! {
                        <#field_type as #krate::__private::TryFrom<#krate::Value>>::try_from(
                            fields.get(#i).cloned().ok_or_else(|| #krate::ConversionError::MissingIndex(#i))?
                        ).map_err(|e| #krate::ConversionError::IndexError(#i, #krate::__private::Box::new(e)))?
                    }
                }
            }).collect();

            let field_count = fields.unnamed.len();
            let field_types: Vec<_> = fields.unnamed.iter().map(|f| &f.ty).collect();

            let count_check = if forward_compatible {
                quote! {}
            } else {
                quote! {
                    if fields.len() != #field_count {
                        return #krate::__private::Err(#krate::ConversionError::WrongFieldCount {
                            expected: #field_count,
                            got: fields.len(),
                        });
                    }
                }
            };

            quote! {
                impl #impl_generics #krate::__private::From<#name #ty_generics> for #krate::Value #where_clause {
                    fn from(value: #name #ty_generics) -> #krate::Value {
                        #krate::Value::Tuple(#krate::__private::vec![
                            #(#krate::Value::from(value.#field_indices)),*
                        ])
                    }
                }

                impl #impl_generics #krate::__private::TryFrom<#krate::Value> for #name #ty_generics #where_clause {
                    type Error = #krate::ConversionError;

                    fn try_from(value: #krate::Value) -> #krate::__private::Result<Self, Self::Error> {
                        match value {
                            #krate::Value::Tuple(fields) => {
                                #count_check
                                #krate::__private::Ok(Self(
                                    #(#field_from_value),*
                                ))
                            }
                            other => #krate::__private::Err(#krate::ConversionError::ExpectedTuple(
                                #krate::__private::format!("{:?}", other)
                            )),
                        }
                    }
                }

                impl #impl_generics #krate::KnownValueType for #name #ty_generics #where_clause {
                    fn known_value_type() -> #krate::ValueType {
                        #krate::ValueType::Tuple(#krate::__private::vec![
                            #(<#field_types as #krate::KnownValueType>::known_value_type()),*
                        ])
                    }
                }
            }
        }
        Fields::Unit => {
            // Unit struct -> Value::Tuple([])
            quote! {
                impl #impl_generics #krate::__private::From<#name #ty_generics> for #krate::Value #where_clause {
                    fn from(_: #name #ty_generics) -> #krate::Value {
                        #krate::Value::Tuple(#krate::__private::vec![])
                    }
                }

                impl #impl_generics #krate::__private::TryFrom<#krate::Value> for #name #ty_generics #where_clause {
                    type Error = #krate::ConversionError;

                    fn try_from(value: #krate::Value) -> #krate::__private::Result<Self, Self::Error> {
                        match value {
                            #krate::Value::Tuple(fields) if fields.is_empty() => {
                                #krate::__private::Ok(Self)
                            }
                            #krate::Value::Tuple(fields) => {
                                #krate::__private::Err(#krate::ConversionError::WrongFieldCount {
                                    expected: 0,
                                    got: fields.len(),
                                })
                            }
                            other => #krate::__private::Err(#krate::ConversionError::ExpectedTuple(
                                #krate::__private::format!("{:?}", other)
                            )),
                        }
                    }
                }

                impl #impl_generics #krate::KnownValueType for #name #ty_generics #where_clause {
                    fn known_value_type() -> #krate::ValueType {
                        #krate::ValueType::Tuple(#krate::__private::vec![])
                    }
                }
            }
        }
    }
}

fn derive_enum(
    input: &DeriveInput,
    data: &syn::DataEnum,
    krate: &proc_macro2::TokenStream,
) -> proc_macro2::TokenStream {
    let name = &input.ident;
    let type_name_str = name.to_string();
    let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();

    // Generate match arms for From<T> for Value
    let to_value_arms: Vec<_> = data
        .variants
        .iter()
        .enumerate()
        .map(|(default_tag, variant)| {
            let variant_name = &variant.ident;
            let case_name_str = variant_name.to_string();
            let tag = get_tag(&variant.attrs).unwrap_or(default_tag);

            match &variant.fields {
                Fields::Named(fields) => {
                    let field_names: Vec<_> = fields
                        .named
                        .iter()
                        .map(|f| f.ident.as_ref().unwrap())
                        .collect();
                    // For named fields, we wrap in a Record as the single payload element
                    let field_to_value: Vec<_> = fields
                        .named
                        .iter()
                        .map(|f| {
                            let field_name = f.ident.as_ref().unwrap();
                            let field_name_str =
                                get_rename(&f.attrs).unwrap_or_else(|| field_name.to_string());
                            quote! {
                                (
                                    #krate::__private::String::from(#field_name_str),
                                    #krate::Value::from(#field_name)
                                )
                            }
                        })
                        .collect();

                    quote! {
                        #name::#variant_name { #(#field_names),* } => {
                            #krate::Value::Variant {
                                type_name: #krate::__private::String::from(#type_name_str),
                                case_name: #krate::__private::String::from(#case_name_str),
                                tag: #tag,
                                payload: #krate::__private::vec![
                                    #krate::Value::Record {
                                        type_name: #krate::__private::String::from(#case_name_str),
                                        fields: #krate::__private::vec![#(#field_to_value),*],
                                    }
                                ],
                            }
                        }
                    }
                }
                Fields::Unnamed(fields) => {
                    let field_names: Vec<_> = (0..fields.unnamed.len())
                        .map(|i| format_ident!("f{}", i))
                        .collect();

                    // Payload is a vec of all the field values
                    quote! {
                        #name::#variant_name(#(#field_names),*) => {
                            #krate::Value::Variant {
                                type_name: #krate::__private::String::from(#type_name_str),
                                case_name: #krate::__private::String::from(#case_name_str),
                                tag: #tag,
                                payload: #krate::__private::vec![
                                    #(#krate::Value::from(#field_names)),*
                                ],
                            }
                        }
                    }
                }
                Fields::Unit => {
                    quote! {
                        #name::#variant_name => {
                            #krate::Value::Variant {
                                type_name: #krate::__private::String::from(#type_name_str),
                                case_name: #krate::__private::String::from(#case_name_str),
                                tag: #tag,
                                payload: #krate::__private::vec![],
                            }
                        }
                    }
                }
            }
        })
        .collect();

    // Generate match arms for TryFrom<Value> for T
    let from_value_arms: Vec<_> = data.variants.iter().enumerate().map(|(default_tag, variant)| {
        let variant_name = &variant.ident;
        let tag = get_tag(&variant.attrs).unwrap_or(default_tag);

        match &variant.fields {
            Fields::Named(fields) => {
                let field_from_value: Vec<_> = fields.named.iter().map(|f| {
                    let field_name = f.ident.as_ref().unwrap();
                    let field_name_str = get_rename(&f.attrs).unwrap_or_else(|| field_name.to_string());
                    let field_type = &f.ty;
                    quote! {
                        #field_name: {
                            let field_value = record_fields.iter()
                                .find(|(name, _)| name == #field_name_str)
                                .map(|(_, v)| v.clone())
                                .ok_or_else(|| #krate::ConversionError::MissingField(
                                    #krate::__private::String::from(#field_name_str)
                                ))?;
                            <#field_type as #krate::__private::TryFrom<#krate::Value>>::try_from(field_value)
                                .map_err(|e| #krate::ConversionError::FieldError(
                                    #krate::__private::String::from(#field_name_str),
                                    #krate::__private::Box::new(e)
                                ))?
                        }
                    }
                }).collect();

                quote! {
                    #tag => {
                        // For named fields, payload should contain a single Record
                        if payload.len() != 1 {
                            return #krate::__private::Err(#krate::ConversionError::WrongFieldCount {
                                expected: 1,
                                got: payload.len(),
                            });
                        }
                        match &payload[0] {
                            #krate::Value::Record { fields: record_fields, .. } => {
                                #krate::__private::Ok(#name::#variant_name {
                                    #(#field_from_value),*
                                })
                            }
                            other => #krate::__private::Err(#krate::ConversionError::ExpectedRecord(
                                #krate::__private::format!("{:?}", other)
                            )),
                        }
                    }
                }
            }
            Fields::Unnamed(fields) => {
                let field_count = fields.unnamed.len();
                let field_conversions: Vec<_> = fields.unnamed.iter().enumerate().map(|(i, f)| {
                    let field_type = &f.ty;
                    quote! {
                        <#field_type as #krate::__private::TryFrom<#krate::Value>>::try_from(
                            payload.get(#i).cloned().ok_or_else(|| #krate::ConversionError::MissingIndex(#i))?
                        ).map_err(|e| #krate::ConversionError::IndexError(#i, #krate::__private::Box::new(e)))?
                    }
                }).collect();

                quote! {
                    #tag => {
                        if payload.len() != #field_count {
                            return #krate::__private::Err(#krate::ConversionError::WrongFieldCount {
                                expected: #field_count,
                                got: payload.len(),
                            });
                        }
                        #krate::__private::Ok(#name::#variant_name(
                            #(#field_conversions),*
                        ))
                    }
                }
            }
            Fields::Unit => {
                quote! {
                    #tag => {
                        if !payload.is_empty() {
                            return #krate::__private::Err(#krate::ConversionError::UnexpectedPayload);
                        }
                        #krate::__private::Ok(#name::#variant_name)
                    }
                }
            }
        }
    }).collect();

    let variant_count = data.variants.len();

    quote! {
        impl #impl_generics #krate::__private::From<#name #ty_generics> for #krate::Value #where_clause {
            fn from(value: #name #ty_generics) -> #krate::Value {
                match value {
                    #(#to_value_arms),*
                }
            }
        }

        impl #impl_generics #krate::__private::TryFrom<#krate::Value> for #name #ty_generics #where_clause {
            type Error = #krate::ConversionError;

            fn try_from(value: #krate::Value) -> #krate::__private::Result<Self, Self::Error> {
                match value {
                    #krate::Value::Variant { tag, payload, .. } => {
                        match tag {
                            #(#from_value_arms),*
                            other => #krate::__private::Err(#krate::ConversionError::UnknownTag {
                                tag: other,
                                max: #variant_count,
                            }),
                        }
                    }
                    other => #krate::__private::Err(#krate::ConversionError::ExpectedVariant(
                        #krate::__private::format!("{:?}", other)
                    )),
                }
            }
        }

        impl #impl_generics #krate::KnownValueType for #name #ty_generics #where_clause {
            fn known_value_type() -> #krate::ValueType {
                #krate::ValueType::Variant(#krate::__private::String::from(#type_name_str))
            }
        }
    }
}

/// Extract `#[graph(rename = "...")]` attribute
fn get_rename(attrs: &[Attribute]) -> Option<String> {
    for attr in attrs {
        if attr.path().is_ident("graph") {
            if let Meta::List(list) = &attr.meta {
                let tokens = list.tokens.to_string();
                // Parse rename = "..."
                if let Some(rest) = tokens.strip_prefix("rename") {
                    let rest = rest.trim();
                    if let Some(rest) = rest.strip_prefix('=') {
                        let rest = rest.trim();
                        if rest.starts_with('"') && rest.ends_with('"') {
                            return Some(rest[1..rest.len() - 1].to_string());
                        }
                    }
                }
            }
        }
    }
    None
}

/// Extract `#[graph(tag = N)]` attribute
fn get_tag(attrs: &[Attribute]) -> Option<usize> {
    for attr in attrs {
        if attr.path().is_ident("graph") {
            if let Meta::List(list) = &attr.meta {
                let tokens = list.tokens.to_string();
                // Parse tag = N
                if let Some(rest) = tokens.strip_prefix("tag") {
                    let rest = rest.trim();
                    if let Some(rest) = rest.strip_prefix('=') {
                        let rest = rest.trim();
                        return rest.parse().ok();
                    }
                }
            }
        }
    }
    None
}

#[cfg(test)]
mod tests {
    use super::{get_crate_path, has_forward_compatible};

    // The COMBINED form must parse the crate correctly (not silently fall back to
    // the default packr_abi — the bug the comma-split fix addresses) AND detect the
    // forward_compatible flag.
    #[test]
    fn combined_crate_and_forward_compatible() {
        let attr: syn::Attribute =
            syn::parse_quote!(#[graph(crate = "foo::bar", forward_compatible)]);
        let attrs = [attr];
        assert_eq!(
            get_crate_path(&attrs).to_string(),
            quote::quote!(foo::bar).to_string(),
            "combined form must parse the crate path, not default to packr_abi"
        );
        assert!(has_forward_compatible(&attrs));
    }

    #[test]
    fn crate_only_parses_and_no_flag() {
        let attrs = [syn::parse_quote!(#[graph(crate = "foo::bar")])];
        assert_eq!(
            get_crate_path(&attrs).to_string(),
            quote::quote!(foo::bar).to_string()
        );
        assert!(!has_forward_compatible(&attrs));
    }

    #[test]
    fn flag_only_defaults_crate() {
        let attrs = [syn::parse_quote!(#[graph(forward_compatible)])];
        assert_eq!(
            get_crate_path(&attrs).to_string(),
            quote::quote!(packr_abi).to_string()
        );
        assert!(has_forward_compatible(&attrs));
    }
}