move_syn/

lib.rs

#![cfg_attr(nightly, feature(doc_cfg))]

//! Move syntax parsing using [`unsynn`](::unsynn).

use std::borrow::Cow;
use std::collections::HashMap;

pub use unsynn;
use unsynn::*;

mod functions;
#[cfg(test)]
mod tests;
mod vis;

pub use self::functions::Function;
pub use self::vis::Visibility;

/// Process raw Move code so that it can be used as input to Rust's tokenizer.
///
/// Move's and Rust's tokens are very similar, with the exception of raw identifiers for which Move
/// uses the syntax "`ident`".
///
/// This function the backticks around identifiers, if found. Thus, we can re-use Rust's tokenizer
/// afterwards, implemented by the [`proc_macro2`] crate. This is relevant because
/// [`unsynn!`]-generated types requires Rust's [`TokenStream`] as input for parsing.
pub fn sanitize_for_tokenizer(content: &str) -> String {
    let regex = raw_ident_regex();
    let mut lines = content.lines().map(|line| {
        // Ignore commented or doc lines
        if !line.trim_start().starts_with("//") {
            regex.replace(line, "$1")
        } else {
            Cow::Borrowed(line)
        }
    });
    lines.next().map_or_else(String::new, |line| {
        let mut sanitized = String::with_capacity(content.len());
        sanitized.push_str(&line);
        for line in lines {
            sanitized.push('\n');
            sanitized.push_str(&line);
        }
        sanitized
    })
}

fn raw_ident_regex() -> regex::Regex {
    regex::Regex::new("`([[:alnum:]_]+)`").expect("Valid regex")
}

pub mod kw {
    //! Move keywords.
    use unsynn::*;

    unsynn! {
        pub keyword Struct = "struct";
        pub keyword Phantom = "phantom";
        pub keyword Public = "public";
        pub keyword Has = "has";
        pub keyword Copy = "copy";
        pub keyword Drop = "drop";
        pub keyword Key = "key";
        pub keyword Store = "store";
        pub keyword Module = "module";
        pub keyword Package = "package";
        pub keyword Friend = "friend";
        pub keyword Use = "use";
        pub keyword Fun = "fun";
        pub keyword As = "as";
        pub keyword Const = "const";
        pub keyword Mut = "mut";
        pub keyword Entry = "entry";
        pub keyword Native = "native";
        pub keyword Macro = "macro";
        pub keyword Vector = "vector";
        pub keyword Enum = "enum";
    }
}

unsynn! {
    pub enum File {
        /// A Move file in the 2024 recommended format.
        ModuleLabel(LabeledModule),
        /// A Move file in the legacy style.
        Legacy(Vec<Module>),
    }

    /// A single module defined with a top-level [label].
    ///
    /// [label]: https://move-book.com/guides/code-quality-checklist#using-module-label
    pub struct LabeledModule {
        attrs: Vec<Attribute>,
        keyword: kw::Module,
        named_address: Ident,
        path_sep: PathSep,
        ident: Ident,
        semicolon: Semicolon,
        contents: Vec<Item>,
    }

    /// A Move module declaration.
    pub struct Module {
        pub attrs: Vec<Attribute>,
        keyword: kw::Module,
        pub named_address: Ident,
        path_sep: PathSep,
        pub ident: Ident,
        contents: BraceGroupContaining<Vec<Item>>,
    }

    /// A Move language item.
    pub struct Item {
        pub attrs: Vec<Attribute>,
        vis: Option<Vis>,
        pub kind: ItemKind,
    }

    // === Attributes ===

    /// An attribute like `#[test_only]`, `#[allow(...)]`, doc comment (`/// ...`), etc.
    #[derive(Clone)]
    pub struct Attribute {
        pound: Pound,
        contents: BracketGroupContaining<DelimitedVec<Meta, Comma, TrailingDelimiter::Optional>>,
    }

    /// Meta =
    ///     "for"
    ///     | <Identifier>
    ///     | <Identifier> "=" <AttributeValue>
    ///     | <Identifier> "(" Comma<Meta> ")"
    ///
    /// Based on
    /// https://github.com/MystenLabs/sui/blob/129788902da4afc54a10af4ae45971a57ef080be/external-crates/move/crates/move-compiler/src/parser/syntax.rs#L1154-L1158
    #[derive(Clone)]
    enum Meta {
        // NOTE: special case for doc strings
        Doc(Cons<DocKw, Assign, LiteralString>),
        For(ForKw),
        Other {
            ident: Ident,
            sub: Option<SubMeta>,
        }
    }

    keyword DocKw = "doc";
    keyword ForKw = "for";

    #[derive(Clone)]
    enum SubMeta {
        Eq(Cons<Assign, AttributeValue>),
        List(ParenthesisGroupContaining<DelimitedVec<Box<Meta>, Comma, TrailingDelimiter::Optional>>),
    }

    /// AttributeValue =
    ///     <Value>
    ///     | <NameAccessChain>
    ///
    /// Based on
    /// https://github.com/MystenLabs/sui/blob/129788902da4afc54a10af4ae45971a57ef080be/external-crates/move/crates/move-compiler/src/parser/syntax.rs#L1135-L1138
    #[derive(Clone)]
    enum AttributeValue {
        Lit(Literal),
        //      NameAccessChain =
        //          <LeadingNameAccess> <OptionalTypeArgs>
        //              ( "::" <Identifier> <OptionalTypeArgs> )^n
        NameAccessChain {
            // TODO: support NumericalAddress
            // LeadingNameAccess = <NumericalAddress> | <Identifier> | <SyntaxIdentifier>
            leading_name_access: Either<SyntaxIdent, Ident>,
            // NOTE: ignoring <OptionalTypeArgs> for now
            // https://github.com/MystenLabs/sui/blob/129788902da4afc54a10af4ae45971a57ef080be/external-crates/move/crates/move-compiler/src/parser/syntax.rs#L3168
            path: DelimitedVec<PathSep, Ident, TrailingDelimiter::Forbidden>,
        },
    }

    // === Visibility modifiers ===

    /// Move item visibility.
    ///
    /// `public`, `public(package)`, `public(friend)`
    #[derive(Clone)]
    struct Vis {
        public: kw::Public,
        modifier: Option<ParenthesisGroupContaining<VisibilityModifier>>,
    }

    /// Move item visibility modifier.
    ///
    /// Examples:
    /// - `public(package)`
    /// - `public(friend)`
    #[derive(Clone)]
    enum VisibilityModifier {
        Package(kw::Package),
        Friend(kw::Friend)
    }

    // === ===

    /// All Move item types.
    #[non_exhaustive]
    pub enum ItemKind {
        Struct(Struct),
        Enum(Enum),
        Import(Import),
        UseFun(UseFun),
        Const(Const),
        Function(Function),
        MacroFun(MacroFun),
        NativeFun(NativeFun)
    }

    /// Alias for a receiver method, like `use fun foo as Bar.bar;`
    pub struct UseFun {
        keyword: kw::Use,
        fun_kw: kw::Fun,
        // HACK: using `TypePath` since they overlap; should generalize it to `ItemPath` instead
        fun_path: ItemPath,
        as_kw: kw::As,
        ty: Ident,
        dot: Dot,
        method: Ident,
        semicolon: Semicolon,
    }

    // === Constants ===

    pub struct Const {
        /// `const`
        const_kw: kw::Const,
        /// `NAME`
        ident: Ident,
        /// `:`
        colon: Colon,
        /// Type
        ty: Type,
        /// `=`
        assign: Assign,
        /// Hack to parse anything until (but excluding) a `;`
        expr: Vec<Cons<Except<Semicolon>, TokenTree>>,
        /// `;`
        semicolon: Semicolon,
    }

    // === Imports ===

    pub struct Import {
        keyword: kw::Use,
        named_address: Ident,
        path_sep: PathSep,
        module: ImportModule,
        semicolon: Semicolon,
    }

    /// `module`, `module as alias`, `module::...`, `{module, ...}`
    enum ImportModule {
        One(ModuleOrItems),
        Many(BraceGroupContaining<CommaDelimitedVec<ModuleOrItems>>),
    }

    #[derive(Clone)]
    struct ModuleOrItems {
        ident: Ident,
        next: Option<AliasOrItems>,
    }

    #[derive(Clone)]
    enum AliasOrItems {
        Alias {
            as_kw: kw::As,
            alias: Ident,
        },
        Items {
            sep: PathSep,
            item: ImportItem,
        }
    }

    #[derive(Clone)]
    enum ImportItem {
        One(MaybeAliased),
        Many(BraceGroupContaining<CommaDelimitedVec<MaybeAliased>>)
    }

    #[derive(Clone)]
    struct MaybeAliased {
        ident: Ident,
        alias: Option<Cons<kw::As, Ident>>,
    }

    // === Structs ===

    /// A Move struct.
    #[derive(Clone)]
    pub struct Struct {
        keyword: kw::Struct,
        pub ident: Ident,
        pub generics: Option<Generics>,
        pub kind: StructKind,
    }

    /// The kinds of structs; either a braced or tuple one.
    #[derive(Clone)]
    pub enum StructKind {
        Braced(BracedStruct),
        Tuple(TupleStruct),
    }

    /// Braced structs have their abilities declared before their fields.
    #[derive(Clone)]
    pub struct BracedStruct {
        abilities: Option<Abilities>,
        pub fields: NamedFields,
    }

    /// Tuple structs have their abilities declared after their fields, with a trailing semicolon
    /// if so.
    #[derive(Clone)]
    pub struct TupleStruct {
        pub fields: PositionalFields,
        abilities: Option<Cons<Abilities, Semicolon>>
    }

    // === Enums ===

    #[derive(Clone)]
    pub struct Enum {
        keyword: kw::Enum,
        pub ident: Ident,
        pub generics: Option<Generics>,
        abilities: Option<Abilities>,
        content: BraceGroupContaining<CommaDelimitedVec<EnumVariant>>,
    }

    #[derive(Clone)]
    pub struct EnumVariant {
        pub attrs: Vec<Attribute>,
        pub ident: Ident,
        /// The fields of the enum variants. If none, it's a "unit" or "empty" variant.
        pub fields: Option<FieldsKind>
    }

    /// Kinds of fields for a Move enum.
    #[derive(Clone)]
    pub enum FieldsKind {
        Positional(PositionalFields),
        Named(NamedFields),
    }

    // === Datatype fields ===

    /// Parenthesis group containing comma-delimited unnamed fields.
    #[derive(Clone)]
    pub struct PositionalFields(ParenthesisGroupContaining<DelimitedVec<UnnamedField, Comma>>);

    /// Brace group containing comma-delimited named fields.
    #[derive(Clone)]
    pub struct NamedFields(BraceGroupContaining<DelimitedVec<NamedField, Comma>>);

    /// Named datatype field.
    #[derive(Clone)]
    pub struct NamedField {
        pub attrs: Vec<Attribute>,
        pub ident: Ident,
        colon: Colon,
        pub ty: Type,
    }

    /// Unnamed datatype field.
    #[derive(Clone)]
    pub struct UnnamedField {
        pub attrs: Vec<Attribute>,
        pub ty: Type,
    }

    // === Generics ===

    /// The generics of a datatype or function.
    ///
    /// # Example
    /// `<T, U: drop, V: key + store>`
    #[derive(Clone)]
    pub struct Generics {
        lt_token: Lt,
        type_args: DelimitedVec<Generic, Comma>,
        gt_token: Gt,
    }

    /// A generic type declaration.
    ///
    /// # Examples
    /// * `T`
    /// * `T: drop`
    /// * `T: key + store`
    /// * `phantom T`
    #[derive(Clone)]
    pub struct Generic {
        pub phantom: Option<kw::Phantom>,
        pub ident: Ident,
        bounds: Option<GenericBounds>
    }

    /// Captures the fact that:
    /// * `:` must be followed by an ability
    /// * additional abilities are preceeded by `+`
    #[derive(Clone)]
    struct GenericBounds {
        colon: Colon,
        abilities: Many<Ability, Plus, TrailingDelimiter::Forbidden>,
    }

    // === Abilities ===

    /// Abilities declaration for a datatype.
    ///
    /// Example: `has key, store`
    #[derive(Clone)]
    struct Abilities {
        has: kw::Has,
        keywords: Many<Ability, Comma, TrailingDelimiter::Forbidden>,
    }

    /// Ability keywords.
    #[derive(Clone)]
    pub enum Ability {
        Copy(kw::Copy),
        Drop(kw::Drop),
        Key(kw::Key),
        Store(kw::Store),
    }

    // === Functions ===

    pub struct NativeFun {
        native_kw: kw::Native,
        fun_kw: kw::Fun,
        ident: Ident,
        generics: Option<Generics>,
        args: ParenthesisGroup,
        ret: Option<Cons<Colon, Either<MaybeRefType, ParenthesisGroup>>>,
        semicolon: Semicolon
    }

    // === Macros ===

    pub struct MacroFun {
        macro_kw: kw::Macro,
        fun_kw: kw::Fun,
        ident: Ident,
        generics: Option<MacroGenerics>,
        args: ParenthesisGroup,
        ret: Option<Cons<Colon, Either<MacroReturn, ParenthesisGroup>>>,
        body: BraceGroup,
    }

    struct MacroGenerics {
        lt_token: Lt,
        type_args: DelimitedVec<MacroTypeArg, Comma>,
        gt_token: Gt,
    }

    /// `$T: drop + store`
    struct MacroTypeArg{
        name: SyntaxIdent,
        bounds: Option<GenericBounds>,
    }

    /// Either `_` or a 'concrete' type
    enum MacroReturn {
        Underscore(Underscore),
        Concrete(Cons<Option<Ref>, MacroReturnType>),
    }

    /// Return type for macro funs.
    ///
    /// - `$T`
    /// - `&mut $T`
    /// - `&String`
    /// - `Option<$T>`
    enum MacroReturnType {
        MacroTypeName(SyntaxIdent),
        Hybrid(HybridMacroType)
    }

    struct HybridMacroType {
        ident: Ident,
        type_args: Option<Cons<Lt, Many<Either<Type, SyntaxIdent, Box<HybridMacroType>>, Comma>, Gt>>
    }

    /// `$T`
    ///
    /// Name based on
    /// https://github.com/MystenLabs/sui/blob/129788902da4afc54a10af4ae45971a57ef080be/external-crates/move/crates/move-compiler/src/parser/syntax.rs#L675-L678
    #[derive(Clone)]
    struct SyntaxIdent {
        dollar: Dollar,
        ident: Ident,
    }

    // === Types ===

    /// Type of function arguments or returns.
    struct MaybeRefType {
        r#ref: Option<Ref>,
        r#type: Type,
    }

    /// The reference prefix
    struct Ref {
        and: And,
        r#mut: Option<kw::Mut>,
    }

    /// Non-reference type, used in datatype fields.
    #[derive(Clone)]
    pub struct Type {
        pub path: ItemPath,
        pub type_args: Option<TypeArgs>
    }

    /// Path to a type.
    #[derive(Clone)]
    pub enum ItemPath {
        /// Fully qualified,
        Full {
            named_address: Ident,
            sep0: PathSep,
            module: Ident,
            sep1: PathSep,
            item: Ident,
        },
        /// Module prefix only, if it was imported already.
        Module {
            module: Ident,
            sep: PathSep,
            item: Ident,
        },
        /// Only the type identifier.
        Ident(Ident),
    }

    /// Angle bracket group (`<...>`) containing comma-delimited types.
    #[derive(Clone)]
    pub struct TypeArgs {
        lt: Lt,
        args: Many<Box<Type>, Comma>,
        gt: Gt,
    }
}

impl File {
    pub fn into_modules(self) -> impl Iterator<Item = Module> {
        match self {
            Self::ModuleLabel(labeled) => std::iter::once(labeled.into_module()).boxed(),
            Self::Legacy(modules) => modules.into_iter().boxed(),
        }
    }
}

impl LabeledModule {
    pub fn into_module(self) -> Module {
        Module {
            attrs: self.attrs,
            keyword: self.keyword,
            named_address: self.named_address,
            path_sep: self.path_sep,
            ident: self.ident,
            contents: BraceGroupContaining {
                content: self.contents,
            },
        }
    }
}

impl Module {
    /// Add `sui` implicit imports as explicit `use` statements to the module.
    ///
    /// [Reference](https://move-book.com/programmability/sui-framework#implicit-imports)
    pub fn with_implicit_sui_imports(&mut self) -> &mut Self {
        // Build the map of implicit imports keyed by the identifiers they export.
        let implicit_imports: HashMap<_, _> = [
            "use sui::object;",
            "use sui::object::ID;",
            "use sui::object::UID;",
            "use sui::tx_context;",
            "use sui::tx_context::TxContext;",
            "use sui::transfer;",
        ]
        .into_iter()
        .map(|text| {
            text.to_token_iter()
                .parse_all::<Import>()
                .expect("Valid imports")
        })
        .map(|import| {
            let ident = import
                .imported_idents()
                .next()
                .expect("Each import exposes exactly one ident");
            (ident.clone(), import)
        })
        .collect();

        self.add_implicit_imports(implicit_imports)
    }

    /// Add `iota` implicit imports as explicit `use` statements to the module.
    ///
    /// Adapted from the `sui` equivalents.
    pub fn with_implicit_iota_imports(&mut self) -> &mut Self {
        // Build the map of implicit imports keyed by the identifiers they export.
        let implicit_imports: HashMap<_, _> = [
            "use iota::object;",
            "use iota::object::ID;",
            "use iota::object::UID;",
            "use iota::tx_context;",
            "use iota::tx_context::TxContext;",
            "use iota::transfer;",
        ]
        .into_iter()
        .map(|text| {
            text.to_token_iter()
                .parse_all::<Import>()
                .expect("Valid imports")
        })
        .map(|import| {
            let ident = import
                .imported_idents()
                .next()
                .expect("Each import exposes exactly one ident");
            (ident.clone(), import)
        })
        .collect();

        self.add_implicit_imports(implicit_imports)
    }

    /// Resolve all datatype field types to their fully-qualified paths.
    pub fn fully_qualify_datatype_field_types(&mut self) -> &mut Self {
        // Collect all imported types and their paths
        let imports: HashMap<_, _> = self
            .items()
            .filter_map(|item| match &item.kind {
                ItemKind::Import(import) => Some(import),
                _ => None,
            })
            .flat_map(|import| import.flatten())
            .collect();

        // Resolve datatype fields' types
        for item in &mut self.contents.content {
            match &mut item.kind {
                ItemKind::Enum(e) => {
                    let generics = &e.generics();
                    e.map_types(|ty| ty.resolve(&imports, generics));
                }
                ItemKind::Struct(s) => {
                    let generics = &s.generics();
                    s.map_types(|ty| ty.resolve(&imports, generics));
                }
                _ => (),
            }
        }

        self
    }

    pub fn items(&self) -> impl Iterator<Item = &Item> {
        self.contents.content.iter()
    }

    #[cfg(test)]
    pub fn into_items(self) -> impl Iterator<Item = Item> {
        self.contents.content.into_iter()
    }

    fn add_implicit_imports(&mut self, mut implicit_imports: HashMap<Ident, Import>) -> &mut Self {
        // Filter out any that were shadowed by existing imports
        for item in self.items() {
            let ItemKind::Import(import) = &item.kind else {
                continue;
            };
            for ident in import.imported_idents() {
                implicit_imports.remove(ident);
            }
        }

        // Add the remaining implicit imports to the list of module items
        for (_, import) in implicit_imports {
            self.contents.content.push(Item {
                attrs: vec![],
                vis: None,
                kind: ItemKind::Import(import),
            })
        }
        self
    }
}

impl Import {
    /// List of idents (or aliases) brought into scope by this import and their paths
    /// (`named_address::module(::item)?`).
    pub fn flatten(&self) -> impl Iterator<Item = (Ident, FlatImport)> + '_ {
        let named_address = self.named_address.clone();
        match &self.module {
            // use named_address::module...
            ImportModule::One(module_or_items) => module_or_items.flatten(named_address),
            // use named_address::{...}
            ImportModule::Many(BraceGroupContaining { content: ms }) => ms
                .iter()
                .flat_map(move |Delimited { value, .. }| value.flatten(named_address.clone()))
                .boxed(),
        }
    }

    /// The list of item idents brought into scope by this import.
    fn imported_idents(&self) -> impl Iterator<Item = &Ident> {
        match &self.module {
            ImportModule::One(module_or_items) => module_or_items.available_idents(),
            ImportModule::Many(BraceGroupContaining { content: ms }) => ms
                .iter()
                .flat_map(|delimited| delimited.value.available_idents())
                .boxed(),
        }
    }
}

impl ModuleOrItems {
    /// Flat canonical imports (`named_address::module(::item)?`).
    fn flatten(&self, named_address: Ident) -> Box<dyn Iterator<Item = (Ident, FlatImport)> + '_> {
        let module = self.ident.clone();

        let Some(next) = &self.next else {
            // module;
            return std::iter::once((
                module.clone(),
                FlatImport::Module {
                    named_address,
                    module,
                },
            ))
            .boxed();
        };

        match next {
            // module as alias;
            AliasOrItems::Alias { alias, .. } => std::iter::once((
                alias.clone(),
                FlatImport::Module {
                    named_address,
                    module,
                },
            ))
            .boxed(),

            // module::item( as alias)?;
            AliasOrItems::Items {
                item: ImportItem::One(maybe_aliased),
                ..
            } => std::iter::once(maybe_aliased.flat_import(named_address, module)).boxed(),

            // module::{(item( as alias)?),+};
            AliasOrItems::Items {
                item: ImportItem::Many(BraceGroupContaining { content: items }),
                ..
            } => items
                .iter()
                .map(move |Delimited { value, .. }| {
                    value.flat_import(named_address.clone(), module.clone())
                })
                .boxed(),
        }
    }

    /// Identifiers this import makes available in scope.
    fn available_idents(&self) -> Box<dyn Iterator<Item = &Ident> + '_> {
        let Some(next) = &self.next else {
            return std::iter::once(&self.ident).boxed();
        };

        match next {
            AliasOrItems::Alias { alias, .. } => std::iter::once(alias).boxed(),

            AliasOrItems::Items {
                item: ImportItem::One(item),
                ..
            } => std::iter::once(item.available_ident(&self.ident)).boxed(),

            AliasOrItems::Items {
                item: ImportItem::Many(BraceGroupContaining { content: items }),
                ..
            } => items
                .iter()
                .map(|delimited| delimited.value.available_ident(&self.ident))
                .boxed(),
        }
    }
}

impl MaybeAliased {
    /// Special handling for `Self` imports.
    fn flat_import(&self, named_address: Ident, module: Ident) -> (Ident, FlatImport) {
        if self.ident == "Self" {
            (
                self.alias().unwrap_or(&module).clone(),
                FlatImport::Module {
                    named_address,
                    module,
                },
            )
        } else {
            (
                self.alias().unwrap_or(&self.ident).clone(),
                FlatImport::Item {
                    named_address,
                    module,
                    r#type: self.ident.clone(),
                },
            )
        }
    }

    fn available_ident<'a>(&'a self, module: &'a Ident) -> &'a Ident {
        if self.ident == "Self" {
            self.alias().unwrap_or(module)
        } else {
            self.alias().unwrap_or(&self.ident)
        }
    }

    /// The identifier alias that's available in scope, if any.
    fn alias(&self) -> Option<&Ident> {
        self.alias.as_ref().map(|cons| &cons.second)
    }
}

impl Attribute {
    /// Whether this is a `#[doc = "..."]`.
    pub fn is_doc(&self) -> bool {
        matches!(
            &self.contents.content[..],
            [Delimited {
                value: Meta::Doc(_),
                ..
            }]
        )
    }

    /// Everything inside the bracket group, `#[...]`.
    pub const fn contents(&self) -> &impl ToTokens {
        &self.contents.content
    }

    pub fn metas(&self) -> impl Iterator<Item = &dyn ToTokens> + '_ {
        self.contents
            .content
            .iter()
            .map(|delimited| &delimited.value as _)
    }

    /// Contents of parameterized attributes as `#[ext(<external_attribute>)]`
    pub fn external_attributes(&self) -> impl Iterator<Item = &dyn ToTokens> + '_ {
        self.contents.content.iter().filter_map(|d| match &d.value {
            Meta::Other {
                ident,
                sub: Some(SubMeta::List(inner)),
            } if ident == "ext" => Some(&inner.content as _),
            _ => None,
        })
    }
}

impl ItemKind {
    /// Whether this item is a datatype (enum/struct) declaration.
    pub const fn is_datatype(&self) -> bool {
        matches!(self, Self::Enum(_) | Self::Struct(_))
    }
}

impl Struct {
    pub fn abilities(&self) -> impl Iterator<Item = &Ability> {
        use StructKind as K;
        match &self.kind {
            K::Braced(braced) => braced
                .abilities
                .iter()
                .flat_map(|a| a.keywords.iter())
                .map(|d| &d.value)
                .boxed(),
            K::Tuple(tuple) => tuple
                .abilities
                .iter()
                .flat_map(|a| a.first.keywords.iter())
                .map(|d| &d.value)
                .boxed(),
        }
    }
}

impl BracedStruct {
    pub fn fields(&self) -> impl Iterator<Item = &NamedField> + Clone + '_ {
        self.fields.fields()
    }

    /// Whether this struct has no fields.
    pub fn is_empty(&self) -> bool {
        self.fields.is_empty()
    }
}

impl TupleStruct {
    pub fn fields(&self) -> impl Iterator<Item = &UnnamedField> + Clone + '_ {
        self.fields.fields()
    }

    /// Whether this struct has no fields.
    pub fn is_empty(&self) -> bool {
        self.fields.is_empty()
    }
}

impl Enum {
    pub fn abilities(&self) -> impl Iterator<Item = &Ability> {
        self.abilities
            .iter()
            .flat_map(|a| a.keywords.iter())
            .map(|d| &d.value)
    }

    pub fn variants(&self) -> impl Iterator<Item = &EnumVariant> {
        self.content
            .content
            .iter()
            .map(|Delimited { value, .. }| value)
    }
}

impl NamedFields {
    pub fn fields(&self) -> impl Iterator<Item = &NamedField> + Clone + '_ {
        self.0.content.iter().map(|d| &d.value)
    }

    pub fn is_empty(&self) -> bool {
        self.0.content.is_empty()
    }
}

impl PositionalFields {
    pub fn new() -> Self {
        Self(ParenthesisGroupContaining {
            content: std::iter::empty::<UnnamedField>()
                .collect::<DelimitedVec<_, _, TrailingDelimiter::Mandatory>>()
                .into(),
        })
    }

    pub fn fields(&self) -> impl Iterator<Item = &UnnamedField> + Clone + '_ {
        self.0.content.iter().map(|d| &d.value)
    }

    pub fn is_empty(&self) -> bool {
        self.0.content.is_empty()
    }
}

impl Default for PositionalFields {
    fn default() -> Self {
        Self::new()
    }
}

impl Type {
    /// Resolve the types' path to a fully-qualified declaration, recursively.
    fn resolve(&mut self, imports: &HashMap<Ident, FlatImport>, generics: &[Ident]) {
        use ItemPath as P;
        // First, resolve the type arguments
        self.map_types(|ty| ty.resolve(imports, generics));

        // Then resolve its own path
        // HACK: We trust the Move code is valid, so the expected import should always be found,
        // hence we don't error/panic if it isn't
        let resolved = match &self.path {
            P::Module {
                module,
                item: r#type,
                ..
            } => {
                let Some(FlatImport::Module {
                    named_address,
                    module,
                }) = imports.get(module)
                else {
                    return;
                };
                P::Full {
                    named_address: named_address.clone(),
                    sep0: PathSep::default(),
                    module: module.clone(),
                    sep1: PathSep::default(),
                    item: r#type.clone(),
                }
            }
            P::Ident(ident) if !generics.contains(ident) => {
                let Some(FlatImport::Item {
                    named_address,
                    module,
                    r#type,
                }) = imports.get(ident)
                else {
                    return;
                };
                P::Full {
                    named_address: named_address.clone(),
                    sep0: PathSep::default(),
                    module: module.clone(),
                    sep1: PathSep::default(),
                    item: r#type.clone(),
                }
            }
            // Already fully-qualified types or idents shadowed by generics should be left alone
            _ => return,
        };
        self.path = resolved;
    }
}

impl TypeArgs {
    /// Guaranteed to be non-empty.
    pub fn types(&self) -> impl Iterator<Item = &Type> {
        self.args.iter().map(|args| &*args.value)
    }
}

impl Generics {
    pub fn generics(&self) -> impl Iterator<Item = &Generic> + '_ {
        self.type_args.iter().map(|d| &d.value)
    }
}

// === Non-lang items ===

#[cfg_attr(test, derive(derive_more::Display))]
pub enum FlatImport {
    #[cfg_attr(test, display("{named_address}::{module}"))]
    Module { named_address: Ident, module: Ident },
    #[cfg_attr(test, display("{named_address}::{module}::{type}"))]
    Item {
        named_address: Ident,
        module: Ident,
        r#type: Ident,
    },
}

// === Misc helpers ===

/// Box an iterator, necessary when returning different types that implement [`Iterator`].
trait IteratorBoxed<'a>: Iterator + 'a {
    fn boxed(self) -> Box<dyn Iterator<Item = Self::Item> + 'a>
    where
        Self: Sized,
    {
        Box::new(self)
    }
}

impl<'a, T> IteratorBoxed<'a> for T where T: Iterator + 'a {}

/// An enum or struct.
trait Datatype {
    fn generics(&self) -> Vec<Ident>;
}

impl Datatype for Enum {
    fn generics(&self) -> Vec<Ident> {
        self.generics
            .iter()
            .flat_map(|generics| generics.generics())
            .map(|generic| generic.ident.clone())
            .collect()
    }
}

impl Datatype for Struct {
    fn generics(&self) -> Vec<Ident> {
        self.generics
            .iter()
            .flat_map(|generics| generics.generics())
            .map(|generic| generic.ident.clone())
            .collect()
    }
}

/// Something that has inner types, e.g., fields, type arguments.
trait Typed {
    /// Field types. Used to resolve into fully-qualified paths.
    fn map_types(&mut self, f: impl FnMut(&mut Type));
}

impl Typed for Enum {
    fn map_types(&mut self, mut f: impl FnMut(&mut Type)) {
        mutate_delimited_vec(&mut self.content.content, |variant| {
            variant.map_types(&mut f)
        });
    }
}

impl Typed for EnumVariant {
    fn map_types(&mut self, f: impl FnMut(&mut Type)) {
        let Some(fields) = &mut self.fields else {
            return;
        };
        fields.map_types(f);
    }
}

impl Typed for Struct {
    fn map_types(&mut self, f: impl FnMut(&mut Type)) {
        match &mut self.kind {
            StructKind::Braced(braced_struct) => braced_struct.fields.map_types(f),
            StructKind::Tuple(tuple_struct) => tuple_struct.fields.map_types(f),
        }
    }
}

impl Typed for FieldsKind {
    fn map_types(&mut self, f: impl FnMut(&mut Type)) {
        match self {
            Self::Named(named) => named.map_types(f),
            Self::Positional(positional) => positional.map_types(f),
        }
    }
}

impl Typed for NamedFields {
    fn map_types(&mut self, mut f: impl FnMut(&mut Type)) {
        mutate_delimited_vec(&mut self.0.content, |field| f(&mut field.ty));
    }
}

impl Typed for PositionalFields {
    fn map_types(&mut self, mut f: impl FnMut(&mut Type)) {
        mutate_delimited_vec(&mut self.0.content, |field| f(&mut field.ty));
    }
}

impl Typed for Type {
    fn map_types(&mut self, mut f: impl FnMut(&mut Self)) {
        if let Some(args) = &mut self.type_args {
            mutate_delimited_vec(&mut args.args, |t| f(&mut *t))
        }
    }
}

// HACK: circumvent the fact that `DelimitedVec` doesn't have a `DerefMut` implementation.
// WARN: this changes `P` to be `Forbidden`
fn mutate_delimited_vec<T, D: Default, const MIN: usize, const MAX: usize>(
    dvec: &mut DelimitedVec<T, D, TrailingDelimiter::Optional, MIN, MAX>,
    mut f: impl FnMut(&mut T),
) {
    type ForbiddenDelimited<T, D, const MIN: usize, const MAX: usize> =
        DelimitedVec<T, D, TrailingDelimiter::Forbidden, MIN, MAX>;

    let temp: ForbiddenDelimited<T, D, MIN, MAX> = std::iter::empty::<T>().collect();
    let mut swapped = std::mem::replace(dvec, temp.into());
    swapped = swapped
        .into_iter()
        .map(|mut d| {
            f(&mut d.value);
            d.value
        })
        .collect::<ForbiddenDelimited<T, D, MIN, MAX>>()
        .into();
    *dvec = swapped;
}