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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
use quote::quote;
use syn::{parenthesized, Token, parse_quote, DeriveInput, Data, Generics, GenericParam, TypeParamBound, DataEnum, DataStruct, DataUnion, Type};
use proc_macro2::{TokenStream, Ident, Span};
use syn::parse::{self, Parse, ParseStream};
use syn::spanned::Spanned;
use indexmap::IndexMap;
use crate::has_repr_c;

#[derive(Debug)]
#[non_exhaustive]
pub struct DeriveFieldOptions {
    /// Treat this array field as opaque and unsized.
    ///
    /// For example,
    /// ````ignore
    /// struct PyTuple {
    ///     ob_refcnt: usize,
    ///     ob_size: usize,
    ///     #[reflect(opaque_array)]
    ///     ob_items: [PyObject; 1]
    /// }
    /// ````
    /// The final field will have type `PyObject` instead of `[PyObject; 1]`.
    /// The actual size won't really be known at compile time,
    /// so it's up to the user to ensure no attempts are made at stack allocation
    ///
    /// The array must be in trailing position
    pub opaque_array: bool,
    /// Assume the field has the same underlying representation as the specified type.
    ///
    /// Useful if the type is known to be FFI-safe,
    /// but the field's type doesn't actually implement `StaticReflect`
    pub assume_repr: Option<syn::Type>
}
impl DeriveFieldOptions {
    pub fn parse_attrs(attrs: &[syn::Attribute]) -> Result<DeriveFieldOptions, syn::Error> {
        for attr in attrs {
            if attr.path.is_ident("reflect") || attr.path.is_ident("static_reflect") {
                return syn::parse2(attr.tokens.clone())
            }
        }
        Ok(DeriveFieldOptions::default())
    }
}
impl Default for DeriveFieldOptions {
    fn default() -> DeriveFieldOptions {
        DeriveFieldOptions {
            // Most fields are not trailing arrays
            opaque_array: false,
            // This is unsafe
            assume_repr: None
        }
    }
}

impl Parse for DeriveFieldOptions {
    fn parse(bracketed_input: ParseStream) -> parse::Result<Self> {
        let mut args = DeriveFieldOptions::default();
        let input;
        parenthesized!(input in bracketed_input);
        let start_span = input.span();
        while !input.is_empty() {
            if input.peek(syn::Ident) {
                let ident = input.parse::<Ident>()?;
                match &*ident.to_string() {
                    "opaque_array" => {
                        args.opaque_array = true;
                    },
                    "assume_repr" => {
                        input.parse::<Token![=]>()?;
                        let type_str = input.parse::<syn::LitStr>()?;
                        let desired_type = syn::parse_str::<Type>(&type_str.value())
                            .map_err(|cause| syn::Error::new(
                                type_str.span(),
                                format_args!("Invalid type: {}", cause)
                            ))?;
                        args.assume_repr = Some(desired_type);
                    }
                    _ => {
                        return Err(input.error(format_args!("Invalid flag: {}", ident)))
                    }
                }
            } else {
                return Err(input.error("Unexpected token"))
            }
        }
        if args.assume_repr.is_some() && args.opaque_array {
            return Err(syn::Error::new(
                start_span, "opaque_array is incompatible with assume_repr",
            ))
        }
        Ok(args)
    }
}

pub fn derive_static_reflect(input: &DeriveInput) -> Result<TokenStream, syn::Error> {
    let name = &input.ident;
    if !has_repr_c(&input) {
        return Err(syn::Error::new(
            name.span(),
            "StaticReflect requires repr(C)"
        ))
    }

    let generics = add_type_bounds(&input.generics, &[parse_quote!(::reflect::StaticReflect)]);
    let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();

    let mut extra_defs = Vec::new();
    let static_type = match input.data {
        Data::Struct(ref data) => {
            handle_type(
                StructHandler::new(data, name),
                &name,
                quote!(#impl_generics),
                quote!(#ty_generics),
                quote!(#where_clause),
                &mut extra_defs
            )?
        },
        Data::Enum(ref data) => enum_static_type(data, &name)?,
        Data::Union(ref data) => {
            handle_type(
                UnionTypeHandler { data, name },
                &name,
                quote!(#impl_generics),
                quote!(#ty_generics),
                quote!(#where_clause),
                &mut extra_defs
            )?
        },
    };

    let r = quote! {
        #(#extra_defs)*
        unsafe impl #impl_generics static_reflect::StaticReflect for #name #ty_generics #where_clause {
            const TYPE_INFO: static_reflect::types::TypeInfo<'static> = {
                /*
                 * NOTE: All our fields are assumed to implement `StaticReflect`,
                 * because there is no other way they could show up
                 * in the generated `TypeInfo`.
                 */
                #static_type
            };
        }
    };
    crate::utils::debug_derive("StaticReflect", &input.ident, &r);
    Ok(r)
}
fn handle_type<'a, T: TypeHandler<'a>>(
    mut target: T,
    name: &Ident,
    impl_generics: TokenStream,
    ty_generics: TokenStream,
    where_clause: TokenStream,
    extra_defs: &mut Vec<TokenStream>
) ->  Result<TokenStream, syn::Error> {
    let mut field_info: IndexMap<Ident, TokenStream> = IndexMap::new();
    let mut field_associated_types = Vec::new();
    let mut field_defs = Vec::new();
    target.handle_fields(|field| {
        let field_name = field.name;
        let field_type = &field.static_type;
        field_info.insert(field_name.clone(), field.static_def.clone());
        field_associated_types.push(quote!(type #field_name = #field_type;));
        let field_def_type = T::field_def_type(Some(quote!(#field_type)));
        field_defs.push(quote!(pub #field_name: #field_def_type,));
    })?;
    let field_info_struct_name = Ident::new(
        &format!("_FieldInfo{}", name),
        name.span()
    );
    let field_info_trait_name = Ident::new(
        &format!("_FieldTrait{}", name),
        name.span()
    );
    let field_names = field_info.keys().collect::<Vec<_>>();
    extra_defs.push(quote!(
        #[allow(missing_docs)]
        #[doc(hidden)]
        pub struct #field_info_struct_name {
            #(#field_defs)*
        }
        #[allow(non_camel_case_types)]
        #[doc(hidden)]
        trait #field_info_trait_name {
            #(type #field_names;)*
        }
        #[allow(non_camel_case_types)]
        impl #impl_generics #field_info_trait_name for #name #ty_generics #where_clause {
            #(#field_associated_types)*
        }
    ));
    let field_inits = field_info.iter()
        .map(|(name, def)| quote!(#name: #def,))
        .collect::<Vec<TokenStream>>();
    extra_defs.push(quote!(
        unsafe impl #impl_generics static_reflect::FieldReflect for #name #ty_generics #where_clause {
            type NamedFieldInfo = #field_info_struct_name;
            const NAMED_FIELD_INFO: Self::NamedFieldInfo = #field_info_struct_name {
                #(#field_inits)*
            };
        }
    ));
    let field_names = field_info.keys().collect::<Vec<_>>();
    let field_def_type_name = T::field_def_type(None);
    let type_def_type = T::type_def_type();
    let header = quote! {
        use static_reflect::{StaticReflect, FieldReflect};
        use static_reflect::types::TypeInfo;
        use #field_def_type_name;
        use #type_def_type;
        const _FIELDS: &'static [#field_def_type_name<'static>] = &[#(<#name as FieldReflect>::NAMED_FIELD_INFO.#field_names.erase()),*];
    };
    let static_def = target.create_static_def(header);
    let into_type = T::def_into_type(quote!(_DEF));
    Ok(quote!({
        const _DEF: &'static #type_def_type<'static> = &#static_def;
        #into_type
    }))
}
fn enum_static_type(data: &DataEnum, name: &Ident) -> Result<TokenStream, syn::Error> {
    if data.variants.iter().all(|var| var.fields.is_empty()) {
        // C-style enum
        // TODO: Strict typing
        // TODO: Should we always assume that we're unsigned?
        Ok(quote!(static_reflect::types::TypeInfo::integer(std::mem::size_of::<#name>(), false)))
    } else {
        Err(syn::Error::new(
            Span::call_site(),
            "Complex enums are currently unsupported"
        ))
    }
}
trait TypeHandler<'a> {
    fn field_def_type(field_type: Option<TokenStream>) -> TokenStream;
    fn type_def_type() -> TokenStream;
    fn def_into_type(def_ref: TokenStream) -> TokenStream;
    fn handle_fields<F: FnMut(FieldInfo<'a>)>(&mut self, handler: F) -> syn::Result<()>;
    fn create_static_def(self, header: TokenStream) -> TokenStream;
}
struct FieldInfo<'a> {
    name: &'a Ident,
    static_type: Type,
    static_def: TokenStream
}
struct StructHandler<'a> {
    name: &'a Ident,
    data: &'a DataStruct,
    current_offset: TokenStream
}
impl<'a> StructHandler<'a> {
    fn new(data: &'a DataStruct, name: &'a Ident) -> Self {
        StructHandler {
            name, data, current_offset: quote!(0)
        }
    }
}
impl<'a> TypeHandler<'a> for StructHandler<'a> {

    fn field_def_type(field_type: Option<TokenStream>) -> TokenStream {
        match field_type {
            Some(inner) => quote!(static_reflect::types::FieldDef<'static, #inner>),
            None => quote!(static_reflect::types::FieldDef)
        }
    }

    fn type_def_type() -> TokenStream {
        quote!(static_reflect::types::StructureDef)
    }

    fn def_into_type(def_ref: TokenStream) -> TokenStream {
        quote!(static_reflect::types::TypeInfo::Structure(#def_ref))
    }

    fn handle_fields<F: FnMut(FieldInfo<'a>)>(&mut self, mut handler: F) -> syn::Result<()> {
        /*
         * NOTE: Layout algorithim for repr(C) given in reference
         * https://doc.rust-lang.org/reference/type-layout.html#reprc-structs
         * We have to use recursion to compute offsets :(
         */
        let mut current_offset = self.current_offset.clone();
        for (index, field) in self.data.fields.iter().enumerate() {
            let DeriveFieldOptions { opaque_array, assume_repr } =
                DeriveFieldOptions::parse_attrs(&field.attrs)?;
            let field_name = field.ident.as_ref().expect("Need named fields");
            let mut field_type = field.ty.clone();
            let original_type = field_type.clone();
            if opaque_array {
                if index + 1 != self.data.fields.len() {
                    return Err(syn::Error::new(
                        field.span(),
                        "Opaque array must be last field"
                    ));
                }
                match field_type.clone() {
                    Type::Array(array) => {
                        field_type = *array.elem;
                    },
                    _ => {
                        return Err(syn::Error::new(
                            field.span(),
                            "Type must be an array to be marked 'opaque_array'"
                        ))
                    }
                }
            }
            if let Some(assumed_type) = assume_repr {
                field_type = assumed_type;
            }
            /*
             * If the current offset is not a multiple of the field's alignment,
             * add the necessary padding bytes.
             */
            current_offset = quote!({
                let old_offset = #current_offset;
                /*
                 * NOTE: Must use #original_type instead of #field_type
                 * There is a chance an option like #[opaque_array] changed the size
                 */
                let rem = old_offset % std::mem::align_of::<#original_type>();
                old_offset + (if rem == 0 { 0 } else { std::mem::align_of::<#original_type>() - rem })
            });
            let static_def = quote!(::static_reflect::types::FieldDef {
                name: stringify!(#field_name),
                value_type: ::static_reflect::types::TypeId::<#field_type>::get(),
                offset: #current_offset,
                index: #index
            });
            handler(FieldInfo {
                name: field_name, static_type: field_type, static_def
            });
            // NOTE: Must use size_of<#original_type> (See above)
            current_offset = quote!((#current_offset) + std::mem::size_of::<#original_type>());
        }
        self.current_offset = current_offset;
        Ok(())
    }

    fn create_static_def(self, header: TokenStream) -> TokenStream {
        let name = self.name;
        let current_offset = &self.current_offset;
        quote!({
            use std::mem::{size_of, align_of};
            #header
            let def = StructureDef {
                name: stringify!(#name),
                fields: _FIELDS,
                size: size_of::<#name>(),
                alignment: align_of::<#name>(),
            };
            let current_offset = #current_offset;
            let expected_size = current_offset + current_offset % align_of::<#name>();
            // In the case of zero-fields, default to alignment of `()`
            let mut expected_alignment = align_of::<()>();
            {
                // NOTE: Can't use for-loop since iterators aren't const
                let mut index = 0;
                while index < def.fields.len() {
                    let alignment = def.fields[index].value_type.type_ref().alignment();
                    if alignment > expected_alignment {
                        expected_alignment = alignment;
                    }
                    index += 1;
                }
            }
            if def.size != expected_size {
                panic!("Mismatched size");
            }
            if def.alignment != expected_alignment {
                panic!("Mismatched alignments")
            }
            def
        })
    }
}
struct UnionTypeHandler<'a> {
    data: &'a DataUnion,
    name: &'a Ident
}
impl<'a> TypeHandler<'a> for UnionTypeHandler<'a> {
    fn field_def_type(field_type: Option<TokenStream>) -> TokenStream {
        match field_type {
            None => quote!(static_reflect::types::UnionFieldDef),
            Some(inner) => quote!(static_reflect::types::UnionFieldDef<'static, #inner>),
        }
    }

    fn type_def_type() -> TokenStream {
        quote!(static_reflect::types::UnionDef)
    }

    fn def_into_type(def_ref: TokenStream) -> TokenStream {
        quote!(static_reflect::types::TypeInfo::Union(#def_ref))
    }

    fn handle_fields<F: FnMut(FieldInfo<'a>)>(&mut self, mut handler: F) -> syn::Result<()> {
        /*
         * NOTE: Layout algorithim for repr(C) given in reference
         * https://doc.rust-lang.org/reference/type-layout.html#reprc-unions
         *
         * Unions are pretty simple since they're just glorified `mem::transmute`
         */
        for (index, field) in self.data.fields.named.iter().enumerate() {
            let DeriveFieldOptions { opaque_array, assume_repr } =
                DeriveFieldOptions::parse_attrs(&field.attrs)?;
            if opaque_array {
                return Err(syn::Error::new(
                    field.span(),
                    "opaque_array is not supported on unions"
                ));
            }
            let field_name = field.ident.as_ref().expect("Need named fields");
            let mut field_type = field.ty.clone();
            if let Some(assumed_type) = assume_repr {
                field_type = assumed_type;
            }
            let static_def = quote!(::static_reflect::types::UnionFieldDef {
                name: stringify!(#field_name),
                value_type: ::static_reflect::types::TypeId::<#field_type>::get(),
                index: #index
            });
            handler(FieldInfo {
                name: field_name,
                static_type: field_type,
                static_def
            });
        }
        Ok(())
    }

    fn create_static_def(self, header: TokenStream) -> TokenStream {
        let name = self.name;
        quote!({
            use std::mem::{size_of, align_of};
            #header
            let def = UnionDef {
                name: stringify!(#name),
                fields: _FIELDS,
                size: size_of::<#name>(),
                alignment: align_of::<#name>(),
            };
            // In the case of zero-fields, default to alignment and size of `()`
            let mut expected_alignment = align_of::<()>();
            let mut expected_size = size_of::<()>();
            {
                // NOTE: Can't use for-loop since iterators aren't const
                let mut index = 0;
                while index < def.fields.len() {
                    let alignment = def.fields[index].value_type.type_ref().alignment();
                    let size = def.fields[index].value_type.type_ref().size();
                    if alignment > expected_alignment {
                        expected_alignment = alignment;
                    }
                    if size > expected_size {
                        expected_size = size;
                    }
                    index += 1;
                }
            }
            {
                // Round expected size up to next multiple of alignment
                let rem = expected_size % expected_alignment;
                if rem != 0 {
                    expected_size += expected_alignment - rem;
                }
            }
            if def.size != expected_size {
                panic!("Mismatched size");
            }
            if def.alignment != expected_alignment {
                panic!("Mismatched alignments")
            }
            def
        })
    }
}

fn add_type_bounds(generics: &Generics, bounds: &[TypeParamBound]) -> Generics {
    let mut generics = generics.clone();
    for param in &mut generics.params {
        if let GenericParam::Type(ref mut type_param) = *param {
            type_param.bounds.extend(bounds.iter().cloned());
        }
    }
    generics
}