sval_derive_macros 2.19.0

/*!
Index allocation and quoting for struct fields and enum variants.

An `IndexAllocator` tracks the next numeric index as fields are iterated.
It starts in implicit mode (indexes carry the `VALUE_OFFSET` tag).
If any field uses an explicit index (from a `#[sval(index)]` attribute or discriminant), all subsequent implicit indexes switch to explicit mode to maintain consistency.

Like labels, indexes can come from three sources: an explicit string literal (`#[sval(index = 1)]`), a path to a label variable (`#[sval(index = MY_INDEX)]`), or the field/variant order within its container as a fallback.

`Index::Implicit` indexes are emitted with `.with_tag(&sval::tags::VALUE_OFFSET)`, signaling they are zero-based offsets.
`Index::Explicit` indexes are emitted as-is.
*/

pub(crate) struct IndexAllocator {
    next_const_index: isize,
    explicit: bool,
}

impl IndexAllocator {
    pub(crate) fn new() -> Self {
        IndexAllocator {
            next_const_index: 0,
            explicit: false,
        }
    }

    pub(crate) fn const_index_of(explicit: IndexValue) -> Index {
        match explicit {
            IndexValue::Const(explicit) => Index::Explicit(quote!(#explicit)),
            IndexValue::Ident(explicit) => Index::Explicit(explicit),
        }
    }

    pub(crate) fn next_const_index(&mut self, explicit: Option<IndexValue>) -> Index {
        if let Some(explicit) = explicit {
            self.explicit = true;

            let index = match explicit {
                IndexValue::Const(explicit) => explicit,
                // If we can't compute an index from the value then
                // just increment the one we've got
                _ => self.next_const_index,
            };

            self.next_const_index = index + 1;

            Self::const_index_of(explicit)
        } else {
            let index = self.next_const_index;
            self.next_const_index += 1;

            if self.explicit {
                Index::Explicit(quote!(#index))
            } else {
                Index::Implicit(quote!(#index))
            }
        }
    }

    pub(crate) fn next_computed_index(
        &mut self,
        ident: &syn::Ident,
        explicit: Option<IndexValue>,
    ) -> Index {
        match self.next_const_index(explicit) {
            Index::Implicit(_) => Index::Implicit(quote!({
                let index = #ident;
                #ident += 1;
                index
            })),
            Index::Explicit(index) => Index::Explicit(index),
        }
    }
}

#[derive(Debug, Clone)]
pub(crate) enum IndexValue {
    Const(isize),
    Ident(proc_macro2::TokenStream),
}

#[derive(Debug, Clone)]
pub(crate) enum Index {
    Implicit(proc_macro2::TokenStream),
    Explicit(proc_macro2::TokenStream),
}

pub(crate) fn quote_index(index: Index) -> proc_macro2::TokenStream {
    match index {
        Index::Explicit(index) => quote!(&sval::Index::from(#index)),
        Index::Implicit(index) => {
            quote!(&sval::Index::from(#index).with_tag(&sval::tags::VALUE_OFFSET))
        }
    }
}

pub(crate) fn quote_optional_index(index: Option<Index>) -> proc_macro2::TokenStream {
    match index {
        Some(index) => {
            let index = quote_index(index);
            quote!(sval::__private::option::Option::Some(#index))
        }
        None => quote!(sval::__private::option::Option::None),
    }
}