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
//! Custom derive support for the `Message` trait

use crate::{
    digest,
    field::{self, WireType},
};
use darling::{FromField, FromVariant};
use proc_macro2::TokenStream;
use quote::{quote, ToTokens};
use syn::{DataEnum, DataStruct, Field, Ident};
use synstructure::Structure;

/// Custom derive for `Message`
pub(crate) fn derive(s: Structure<'_>) -> TokenStream {
    match &s.ast().data {
        syn::Data::Enum(data) => DeriveEnum::derive(s, data),
        syn::Data::Struct(data) => DeriveStruct::derive(s, data),
        other => panic!("can't derive `Message` on: {:?}", other),
    }
}

/// Derive `Message` on an enum
struct DeriveEnum {
    /// Body of `Message::decode()` in-progress for an enum
    decode_body: TokenStream,

    /// Body of `Message::encode()` in-progress for an enum
    encode_body: TokenStream,

    /// Body of `Message::encoded_len()` in-progress for an enum
    encoded_len_body: TokenStream,
}

impl DeriveEnum {
    /// Derive `Message` on an enum
    // TODO(tarcieri): higher-level abstractions/implementation?
    pub fn derive(s: Structure<'_>, data: &DataEnum) -> TokenStream {
        assert_eq!(
            s.variants().len(),
            data.variants.len(),
            "enum variant count mismatch"
        );

        let mut state = Self {
            decode_body: TokenStream::new(),
            encode_body: TokenStream::new(),
            encoded_len_body: TokenStream::new(),
        };

        for (variant_info, variant) in s.variants().iter().zip(&data.variants) {
            let attrs = field::Attrs::from_variant(variant).unwrap_or_else(|e| {
                panic!("error parsing field attributes: {}", e);
            });

            state.derive_decode_match_arm(&variant.ident, &attrs);

            variant_info
                .each(|bi| encode_field(&bi.binding, &attrs))
                .to_tokens(&mut state.encode_body);

            variant_info
                .each(|bi| encoded_len_for_field(&bi.binding, &attrs))
                .to_tokens(&mut state.encoded_len_body)
        }

        state.finish(s)
    }

    /// Derive a match arm of an enum `decode` method
    fn derive_decode_match_arm(&mut self, name: &Ident, attrs: &field::Attrs) {
        let tag = attrs.tag();
        let wire_type = attrs.wire_type();

        let decode_variant = if wire_type.is_ref_type() {
            let ty = wire_type.rust_type().unwrap();
            quote! {
                let field: #ty = decoder.decode_ref(#tag, &mut input)?;
                field
                    .try_into()
                    .map(Self::#name)
                    .map_err(|_| veriform::field::WireType::Bytes.decoding_error())
            }
        } else if wire_type.is_sequence() {
            todo!();
        } else {
            quote! {
                decoder.decode(#tag, &mut input).map(Self::#name)
            }
        };

        let match_arm = quote! {
            #tag => { #decode_variant }
        };

        match_arm.to_tokens(&mut self.decode_body);
    }

    /// Finish deriving an enum
    fn finish(self, s: Structure<'_>) -> TokenStream {
        let decode_body = self.decode_body;
        let encode_body = self.encode_body;
        let encoded_len_body = self.encoded_len_body;

        s.gen_impl(quote! {
            gen impl Message for @Self {
                fn decode<D>(
                    decoder: &mut veriform::decoder::Decoder<D>,
                    mut input: &[u8]
                ) -> Result<Self, veriform::Error>
                where
                    D: veriform::digest::Digest,
                {
                    #[allow(unused_imports)]
                    use core::convert::TryInto;
                    #[allow(unused_imports)]
                    use veriform::decoder::{Decode, DecodeRef};

                    let msg = match veriform::derive_helpers::decode_tag(input)? {
                        #decode_body
                        tag => Err(veriform::derive_helpers::unknown_tag(tag))
                    }?;

                    veriform::derive_helpers::check_input_consumed(input)?;
                    Ok(msg)
                }

                fn encode<'a>(
                    &self,
                    buffer: &'a mut [u8]
                ) -> Result<&'a [u8], veriform::Error> {
                    let mut encoder = veriform::Encoder::new(buffer);

                    match self {
                        #encode_body
                    }

                    Ok(encoder.finish())
                }

                fn encoded_len(&self) -> usize {
                    match self {
                        #encoded_len_body
                    }
                }
            }
        })
    }
}

/// Derive `Message` on a struct
// TODO(tarcieri): make sure tags are in the right order and digest is the last field
struct DeriveStruct {
    /// Body of `Message::decode()` in-progress for a struct
    decode_body: TokenStream,

    /// Instantiation of the struct at the end of `Message::decode()`
    inst_body: TokenStream,

    /// Body of `Message::encode()` in-progress for a struct
    encode_body: TokenStream,

    /// Body of `Message::encoded_len()` in-progress for a struct
    encoded_len_body: TokenStream,
}

impl DeriveStruct {
    pub fn derive(s: Structure<'_>, data: &DataStruct) -> TokenStream {
        assert_eq!(s.variants().len(), 1, "expected one variant");

        let mut state = Self {
            decode_body: TokenStream::new(),
            inst_body: TokenStream::new(),
            encode_body: TokenStream::new(),
            encoded_len_body: quote!(0),
        };

        let variant = &s.variants()[0];
        let bindings = &variant.bindings();

        if bindings.len() != data.fields.len() {
            panic!(
                "unexpected number of bindings ({} vs {})",
                bindings.len(),
                data.fields.len()
            );
        }

        for (binding_info, field) in bindings.iter().zip(&data.fields) {
            for attr in &field.attrs {
                let attr_segments = &attr.path.segments;

                // ignore namespaced attributes
                if attr_segments.len() != 1 {
                    continue;
                }

                let attr_name = &attr_segments[0].ident.to_string();

                match attr_name.as_ref() {
                    "field" => state.derive_field(field, &binding_info.binding),
                    "digest" => state.derive_digest(field),
                    _ => (), // ignore other attributes
                }
            }
        }

        state.finish(&s, variant.pat())
    }

    /// Derive handling for a particular `#[field(...)]`
    fn derive_field(&mut self, field: &Field, binding: &Ident) {
        let name = parse_field_name(field);

        let attrs = field::Attrs::from_field(field).unwrap_or_else(|e| {
            panic!("error parsing field attributes: {}", e);
        });

        self.derive_decode_field(name, &attrs);

        let inst_field = quote!(#name,);
        inst_field.to_tokens(&mut self.inst_body);

        let enc_field = encode_field(binding, &attrs);
        let enc_field_with_semicolon = quote!(#enc_field;);
        enc_field_with_semicolon.to_tokens(&mut self.encode_body);

        let enc_field_len = encoded_len_for_field(binding, &attrs);
        let enc_field_len_with_plus = quote!(+ #enc_field_len);
        enc_field_len_with_plus.to_tokens(&mut self.encoded_len_body);
    }

    /// Derive a match arm of an struct `decode` method
    fn derive_decode_field(&mut self, name: &Ident, attrs: &field::Attrs) {
        let tag = attrs.tag();
        let wire_type = attrs.wire_type();

        match wire_type.rust_type() {
            Some(ty) => {
                if wire_type.is_ref_type() {
                    quote! { let #name: #ty = decoder.decode_ref(#tag, &mut input)?; }
                } else {
                    quote! { let #name: #ty = decoder.decode(#tag, &mut input)?; }
                }
            }
            None => {
                if wire_type.is_message() {
                    quote! { let #name = decoder.decode(#tag, &mut input)?; }
                } else if wire_type.is_sequence() {
                    // TODO(tarcieri): hoist more of this into a `derive_helper` function?
                    quote! {
                        let #name = veriform::derive_helpers::decode_message_seq(
                            decoder,
                            #tag,
                            &mut input
                        )?;
                    }
                } else {
                    unreachable!();
                }
            }
        }
        .to_tokens(&mut self.decode_body);
    }

    /// Derive handling for a `#[digest(...)]` member of a struct
    fn derive_digest(&mut self, field: &Field) {
        let name = parse_field_name(field);

        let attrs = digest::Attrs::from_field(field).unwrap_or_else(|e| {
            panic!("error parsing digest attributes: {}", e);
        });

        // TODO(tarcieri): support additional algorithms?
        match attrs.alg() {
            digest::Algorithm::Sha256 => self.derive_sha256_digest(&name),
        }
    }

    /// Derive computing a SHA-256 digest of a message
    fn derive_sha256_digest(&mut self, name: &Ident) {
        let fill_digest = quote! {
            let mut #name = veriform::Sha256Digest::default();
            decoder.fill_digest(&mut #name)?;
        };

        fill_digest.to_tokens(&mut self.decode_body);

        let inst_field = quote!(#name: Some(#name),);
        inst_field.to_tokens(&mut self.inst_body);
    }

    /// Finish deriving a struct
    fn finish(self, s: &Structure<'_>, pattern: TokenStream) -> TokenStream {
        let decode_body = self.decode_body;
        let inst_body = self.inst_body;
        let encode_body = self.encode_body;
        let encoded_len_body = self.encoded_len_body;

        s.gen_impl(quote! {
            gen impl Message for @Self {
                fn decode<D>(
                    decoder: &mut veriform::decoder::Decoder<D>,
                    mut input: &[u8]
                ) -> Result<Self, veriform::Error>
                where
                    D: veriform::digest::Digest,
                {
                    #[allow(unused_imports)]
                    use veriform::decoder::{Decode, DecodeRef};

                    #decode_body

                    Ok(Self { #inst_body })
                }

                fn encode<'a>(
                    &self,
                    buffer: &'a mut [u8]
                ) -> Result<&'a [u8], veriform::Error> {
                    let mut encoder = veriform::Encoder::new(buffer);

                    match self {
                        #pattern => { #encode_body }
                    }

                    Ok(encoder.finish())
                }

                fn encoded_len(&self) -> usize {
                    match self {
                        #pattern => { #encoded_len_body }
                    }
                }
            }
        })
    }
}

/// Parse the name of a field
fn parse_field_name(field: &Field) -> &Ident {
    field
        .ident
        .as_ref()
        .unwrap_or_else(|| panic!("no name on struct field (e.g. tuple structs unsupported)"))
}

/// Encode a field of a message
fn encode_field(binding: &Ident, attrs: &field::Attrs) -> TokenStream {
    let tag = attrs.tag();
    let critical = attrs.is_critical();

    match attrs.wire_type() {
        WireType::Bool => todo!(),
        WireType::UInt64 => quote! { encoder.uint64(#tag, #critical, *#binding)? },
        WireType::SInt64 => quote! { encoder.sint64(#tag, #critical, *#binding)? },
        WireType::Bytes => quote! { encoder.bytes(#tag, #critical, #binding)? },
        WireType::String => quote! { encoder.string(#tag, #critical, #binding)? },
        WireType::Message => quote! { encoder.message(#tag, #critical, #binding)? },
        WireType::Sequence => quote! {
            // TODO(tarcieri): support other types of sequences besides messages
            veriform::derive_helpers::encode_message_seq(&mut encoder, #tag, #critical, #binding)?;
        },
    }
}

/// Compute the encoded length of a field
fn encoded_len_for_field(binding: &Ident, attrs: &field::Attrs) -> TokenStream {
    let tag = attrs.tag();

    match attrs.wire_type() {
        WireType::Bool => todo!(),
        WireType::UInt64 => quote! { veriform::field::length::uint64(#tag, *#binding) },
        WireType::SInt64 => quote! { veriform::field::length::sint64(#tag, *#binding) },
        WireType::Bytes => quote! { veriform::field::length::bytes(#tag, #binding) },
        WireType::String => quote! { veriform::field::length::string(#tag, #binding) },
        WireType::Message => quote! { veriform::field::length::message(#tag, #binding) },
        WireType::Sequence => quote! {
            // TODO(tarcieri): support other types of sequences besides messages
            veriform::field::length::message_seq(
                #tag,
                #binding.iter().map(|elem| elem as &dyn veriform::Message)
            )
        },
    }
}