# derive.rs - source
Source of the Rust file `/home/runner/.cargo/registry/src/github.com-1ecc6299db9ec823/syn-1.0.64/src/derive.rs`.
Keywords: rust, rustlang, rust-lang

      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274

    use super::*;
    use crate::punctuated::Punctuated;

    ast_struct! {
        /// Data structure sent to a `proc_macro_derive` macro.
        ///
        /// *This type is available only if Syn is built with the `"derive"` feature.*
        #[cfg_attr(doc_cfg, doc(cfg(feature = "derive")))]
        pub struct DeriveInput {
            /// Attributes tagged on the whole struct or enum.
            pub attrs: Vec<Attribute>,

            /// Visibility of the struct or enum.
            pub vis: Visibility,

            /// Name of the struct or enum.
            pub ident: Ident,

            /// Generics required to complete the definition.
            pub generics: Generics,

            /// Data within the struct or enum.
            pub data: Data,
        }
    }

    ast_enum_of_structs! {
        /// The storage of a struct, enum or union data structure.
        ///
        /// *This type is available only if Syn is built with the `"derive"` feature.*
        ///
        /// # Syntax tree enum
        ///
        /// This type is a [syntax tree enum].
        ///
        /// [syntax tree enum]: Expr#syntax-tree-enums
        #[cfg_attr(doc_cfg, doc(cfg(feature = "derive")))]
        pub enum Data {
            /// A struct input to a `proc_macro_derive` macro.
            Struct(DataStruct),

            /// An enum input to a `proc_macro_derive` macro.
            Enum(DataEnum),

            /// An untagged union input to a `proc_macro_derive` macro.
            Union(DataUnion),
        }

        do_not_generate_to_tokens
    }

    ast_struct! {
        /// A struct input to a `proc_macro_derive` macro.
        ///
        /// *This type is available only if Syn is built with the `"derive"`
        /// feature.*
        #[cfg_attr(doc_cfg, doc(cfg(feature = "derive")))]
        pub struct DataStruct {
            pub struct_token: Token![struct],
            pub fields: Fields,
            pub semi_token: Option<Token![;]>,
        }
    }

    ast_struct! {
        /// An enum input to a `proc_macro_derive` macro.
        ///
        /// *This type is available only if Syn is built with the `"derive"`
        /// feature.*
        #[cfg_attr(doc_cfg, doc(cfg(feature = "derive")))]
        pub struct DataEnum {
            pub enum_token: Token![enum],
            pub brace_token: token::Brace,
            pub variants: Punctuated<Variant, Token![,]>,
        }
    }

    ast_struct! {
        /// An untagged union input to a `proc_macro_derive` macro.
        ///
        /// *This type is available only if Syn is built with the `"derive"`
        /// feature.*
        #[cfg_attr(doc_cfg, doc(cfg(feature = "derive")))]
        pub struct DataUnion {
            pub union_token: Token![union],
            pub fields: FieldsNamed,
        }
    }

    #[cfg(feature = "parsing")]
    pub mod parsing {
        use super::*;
        use crate::parse::{Parse, ParseStream, Result};

        #[cfg_attr(doc_cfg, doc(cfg(feature = "parsing")))]
        impl Parse for DeriveInput {
            fn parse(input: ParseStream) -> Result<Self> {
                let attrs = input.call(Attribute::parse_outer)?;
                let vis = input.parse::<Visibility>()?;

                let lookahead = input.lookahead1();
                if lookahead.peek(Token![struct]) {
                    let struct_token = input.parse::<Token![struct]>()?;
                    let ident = input.parse::<Ident>()?;
                    let generics = input.parse::<Generics>()?;
                    let (where_clause, fields, semi) = data_struct(input)?;
                    Ok(DeriveInput {
                        attrs,
                        vis,
                        ident,
                        generics: Generics {
                            where_clause,
                            ..generics
                        },
                        data: Data::Struct(DataStruct {
                            struct_token,
                            fields,
                            semi_token: semi,
                        }),
                    })
                } else if lookahead.peek(Token![enum]) {
                    let enum_token = input.parse::<Token![enum]>()?;
                    let ident = input.parse::<Ident>()?;
                    let generics = input.parse::<Generics>()?;
                    let (where_clause, brace, variants) = data_enum(input)?;
                    Ok(DeriveInput {
                        attrs,
                        vis,
                        ident,
                        generics: Generics {
                            where_clause,
                            ..generics
                        },
                        data: Data::Enum(DataEnum {
                            enum_token,
                            brace_token: brace,
                            variants,
                        }),
                    })
                } else if lookahead.peek(Token![union]) {
                    let union_token = input.parse::<Token![union]>()?;
                    let ident = input.parse::<Ident>()?;
                    let generics = input.parse::<Generics>()?;
                    let (where_clause, fields) = data_union(input)?;
                    Ok(DeriveInput {
                        attrs,
                        vis,
                        ident,
                        generics: Generics {
                            where_clause,
                            ..generics
                        },
                        data: Data::Union(DataUnion {
                            union_token,
                            fields,
                        }),
                    })
                } else {
                    Err(lookahead.error())
                }
            }
        }

        pub fn data_struct(
            input: ParseStream,
        ) -> Result<(Option<WhereClause>, Fields, Option<Token![;]>)> {
            let mut lookahead = input.lookahead1();
            let mut where_clause = None;
            if lookahead.peek(Token![where]) {
                where_clause = Some(input.parse()?);
                lookahead = input.lookahead1();
            }

            if where_clause.is_none() && lookahead.peek(token::Paren) {
                let fields = input.parse()?;

                lookahead = input.lookahead1();
                if lookahead.peek(Token![where]) {
                    where_clause = Some(input.parse()?);
                    lookahead = input.lookahead1();
                }

                if lookahead.peek(Token![;]) {
                    let semi = input.parse()?;
                    Ok((where_clause, Fields::Unnamed(fields), Some(semi)))
                } else {
                    Err(lookahead.error())
                }
            } else if lookahead.peek(token::Brace) {
                let fields = input.parse()?;
                Ok((where_clause, Fields::Named(fields), None))
            } else if lookahead.peek(Token![;]) {
                let semi = input.parse()?;
                Ok((where_clause, Fields::Unit, Some(semi)))
            } else {
                Err(lookahead.error())
            }
        }

        pub fn data_enum(
            input: ParseStream,
        ) -> Result<(
            Option<WhereClause>,
            token::Brace,
            Punctuated<Variant, Token![,]>,
        )> {
            let where_clause = input.parse()?;

            let content;
            let brace = braced!(content in input);
            let variants = content.parse_terminated(Variant::parse)?;

            Ok((where_clause, brace, variants))
        }

        pub fn data_union(input: ParseStream) -> Result<(Option<WhereClause>, FieldsNamed)> {
            let where_clause = input.parse()?;
            let fields = input.parse()?;
            Ok((where_clause, fields))
        }
    }

    #[cfg(feature = "printing")]
    mod printing {
        use super::*;
        use crate::attr::FilterAttrs;
        use crate::print::TokensOrDefault;
        use proc_macro2::TokenStream;
        use quote::ToTokens;

        #[cfg_attr(doc_cfg, doc(cfg(feature = "printing")))]
        impl ToTokens for DeriveInput {
            fn to_tokens(&self, tokens: &mut TokenStream) {
                for attr in self.attrs.outer() {
                    attr.to_tokens(tokens);
                }
                self.vis.to_tokens(tokens);
                match &self.data {
                    Data::Struct(d) => d.struct_token.to_tokens(tokens),
                    Data::Enum(d) => d.enum_token.to_tokens(tokens),
                    Data::Union(d) => d.union_token.to_tokens(tokens),
                }
                self.ident.to_tokens(tokens);
                self.generics.to_tokens(tokens);
                match &self.data {
                    Data::Struct(data) => match &data.fields {
                        Fields::Named(fields) => {
                            self.generics.where_clause.to_tokens(tokens);
                            fields.to_tokens(tokens);
                        }
                        Fields::Unnamed(fields) => {
                            fields.to_tokens(tokens);
                            self.generics.where_clause.to_tokens(tokens);
                            TokensOrDefault(&data.semi_token).to_tokens(tokens);
                        }
                        Fields::Unit => {
                            self.generics.where_clause.to_tokens(tokens);
                            TokensOrDefault(&data.semi_token).to_tokens(tokens);
                        }
                    },
                    Data::Enum(data) => {
                        self.generics.where_clause.to_tokens(tokens);
                        data.brace_token.surround(tokens, |tokens| {
                            data.variants.to_tokens(tokens);
                        });
                    }
                    Data::Union(data) => {
                        self.generics.where_clause.to_tokens(tokens);
                        data.fields.to_tokens(tokens);
                    }
                }
            }
        }
    }