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
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
use core::{cmp::Ordering, convert::TryInto, fmt, ops::Range};

use proc_macro2::TokenStream;
use quote::quote;
use syn::{
    parse::{Parse, ParseStream},
    parse_macro_input,
    punctuated::Punctuated,
    Token,
};

#[proc_macro]
pub fn bitstruct(tokens: proc_macro::TokenStream) -> proc_macro::TokenStream {
    let input = parse_macro_input!(tokens as BitStructInput);
    expand_bitstruct(input)
        .unwrap_or_else(|err| err.to_compile_error())
        .into()
}

fn expand_bitstruct(input: BitStructInput) -> syn::Result<TokenStream> {
    let attrs = &input.attrs;
    let vis = &input.vis;
    let name = &input.name;
    let raw_vis = &input.raw_vis;
    let raw = &input.raw.as_type();
    let fields = input
        .fields
        .iter()
        .map(|field| expand_field_methods(&input, field))
        .collect::<syn::Result<Vec<TokenStream>>>()?;
    Ok(quote! {
        #(#attrs)*
        #vis struct #name(#raw_vis #raw);
        impl #name {
            #(#fields)*
        }
    })
}

fn expand_field_methods(input: &BitStructInput, field: &FieldDef) -> syn::Result<TokenStream> {
    // Extract any bitstruct specific field attributes.
    let bitstruct_field_attrs = field
        .attrs
        .iter()
        .find_map(|attr| {
            let bitstruct: syn::Path = syn::parse_quote! {bitstruct};
            match attr.parse_meta().ok()? {
                syn::Meta::List(meta_list) if meta_list.path == bitstruct => Some(meta_list.nested),
                _ => None,
            }
        })
        .unwrap_or_default();

    let getter_method = expand_field_getter(input, field);
    let setter_methods = {
        let omit_setter = bitstruct_field_attrs.iter().any(|nested_meta| {
            let omit_setter: syn::NestedMeta = syn::parse_quote! {omit_setter};
            nested_meta == &omit_setter
        });

        if omit_setter {
            quote! {}
        } else {
            expand_field_setter(input, field)
        }
    };

    Ok(quote! {
        #getter_method
        #setter_methods
    })
}

fn expand_field_getter(input: &BitStructInput, field: &FieldDef) -> TokenStream {
    // Only pass through the non-bitstruct field attributes.
    let pass_thru_attrs = field.attrs.iter().filter(|&attr| {
        let bitstruct: syn::Path = syn::parse_quote! {bitstruct};
        attr.path != bitstruct
    });

    let target_ty = field.target.as_type();
    let mask = hexlit(input.raw, field.bits.get_mask());
    let start_bit = hexlit(input.raw, field.bits.0.start.into());
    let mask_and_shift: syn::Expr = syn::parse_quote! {
        ((self.0 & #mask) >> #start_bit)
    };
    let cast = from_raw(mask_and_shift, input.raw, &field.target, &field.bits);

    let field_vis = &field.vis;
    let field_name = &field.name;
    let maybe_const_fn = if let Target::Convert(_) = field.target {
        quote! {fn}
    } else {
        quote! {const fn}
    };
    quote! {
        #(#pass_thru_attrs)*
        #field_vis #maybe_const_fn #field_name(&self) -> #target_ty {
            #cast
        }
    }
}

fn from_raw(raw_expr: syn::Expr, raw: RawDef, target: &Target, bitrange: &BitRange) -> syn::Expr {
    match target {
        Target::Int(raw_def) => {
            let target_ty = raw_def.as_type();
            syn::parse_quote! {
                #raw_expr as #target_ty
            }
        }
        Target::Bool => {
            syn::parse_quote! {
                #raw_expr != 0
            }
        }
        Target::Convert(ty) => {
            let bitlen = bitrange.0.end - bitrange.0.start;
            let smallest_target = Target::smallest_target(bitlen);
            let smallest_target_expr = from_raw(raw_expr, raw, &smallest_target, bitrange);
            let smallest_target_ty = smallest_target.as_type();
            syn::parse_quote! {
                <Self as ::bitstruct::FromRaw<#smallest_target_ty, #ty>>::from_raw(#smallest_target_expr)
            }
        }
    }
}

fn expand_field_setter(input: &BitStructInput, field: &FieldDef) -> TokenStream {
    // Only pass through the non-bitstruct field attributes.
    let pass_thru_attrs = field
        .attrs
        .iter()
        .filter(|&attr| {
            let bitstruct: syn::Path = syn::parse_quote! {bitstruct};
            attr.path != bitstruct
        })
        .collect::<Vec<_>>();

    let target_ty = field.target.as_type();
    let mask = field.bits.get_mask();
    let neg_mask = hexlit(input.raw, !mask);
    let mask = hexlit(input.raw, mask);
    let start_bit = hexlit(input.raw, field.bits.0.start.into());

    let field_vis = &field.vis;
    let field_name = &field.name;
    let with_method = quote::format_ident!("with_{}", field_name);
    let set_method = quote::format_ident!("set_{}", field_name);
    let cast = into_raw(
        syn::parse_quote! {value},
        &field.target,
        input.raw,
        &field.bits,
    );
    let maybe_const_fn = if let Target::Convert(_) = field.target {
        quote! {fn}
    } else {
        quote! {const fn}
    };
    quote! {
        #[must_use]
        #(#pass_thru_attrs)*
        #field_vis #maybe_const_fn #with_method(mut self, value: #target_ty) -> Self {
            self.0 = (self.0 & #neg_mask) | ((#cast << #start_bit) & #mask);
            self
        }

        #(#pass_thru_attrs)*
        #field_vis fn #set_method(&mut self, value: #target_ty) {
            self.0 = (self.0 & #neg_mask) | ((#cast << #start_bit) & #mask);
        }
    }
}

fn into_raw(
    target_expr: syn::Expr,
    target: &Target,
    raw: RawDef,
    bitrange: &BitRange,
) -> syn::Expr {
    match target {
        Target::Int(_) | Target::Bool => {
            let raw = raw.as_type();
            syn::parse_quote! {
                (#target_expr as #raw)
            }
        }
        Target::Convert(ty) => {
            let bitlen = bitrange.0.end - bitrange.0.start;
            let smallest_target = Target::smallest_target(bitlen);
            let smallest_target_ty = smallest_target.as_type();
            let smallest_target_expr = syn::parse_quote! {
                <Self as ::bitstruct::IntoRaw<#smallest_target_ty, #ty>>::into_raw(#target_expr)
            };
            into_raw(smallest_target_expr, &smallest_target, raw, bitrange)
        }
    }
}

/// Helper methods on ParseStream that attempt to parse an item but only advance the cursor on success.
trait TryParse {
    fn try_parse<T: Parse>(&self) -> syn::Result<T>;
    fn try_call<T>(&self, function: fn(_: ParseStream<'_>) -> syn::Result<T>) -> syn::Result<T>;
}

impl TryParse for ParseStream<'_> {
    fn try_parse<T: Parse>(&self) -> syn::Result<T> {
        use syn::parse::discouraged::Speculative;
        let fork = self.fork();
        match fork.parse::<T>() {
            Ok(value) => {
                self.advance_to(&fork);
                Ok(value)
            }
            err => err,
        }
    }

    fn try_call<T>(&self, function: fn(_: ParseStream<'_>) -> syn::Result<T>) -> syn::Result<T> {
        use syn::parse::discouraged::Speculative;
        let fork = self.fork();
        match fork.call(function) {
            Ok(value) => {
                self.advance_to(&fork);
                Ok(value)
            }
            err => err,
        }
    }
}

#[derive(Debug)]
struct BitStructInput {
    attrs: Vec<syn::Attribute>,
    vis: syn::Visibility,
    name: syn::Ident,
    raw_vis: syn::Visibility,
    raw: RawDef,
    fields: Punctuated<FieldDef, Token![;]>,
}

impl Parse for BitStructInput {
    fn parse(input: ParseStream) -> syn::Result<Self> {
        let attrs = input.call(syn::Attribute::parse_outer)?;
        let vis = input.parse()?;
        input.parse::<Token![struct]>()?;
        let name = input.parse()?;
        let within_parens;
        syn::parenthesized!(within_parens in input);
        let raw_vis = within_parens.parse()?;
        let raw: RawDef = within_parens.parse()?;
        let within_braces;
        syn::braced!(within_braces in input);
        let fields: Punctuated<FieldDef, _> = Punctuated::parse_terminated(&within_braces)?;
        for field in fields.iter() {
            if field.bits.0.end > raw.bit_len() {
                return Err(syn::Error::new(
                    field.name.span(),
                    format!(
                        "field `{}` specifies a bitrange beyond `{}` range",
                        field.name,
                        raw.as_str()
                    ),
                ));
            }
        }
        Ok(BitStructInput {
            attrs,
            vis,
            name,
            raw_vis,
            raw,
            fields,
        })
    }
}

#[derive(Debug, Copy, Clone, Eq, PartialEq)]
enum RawDef {
    U8,
    U16,
    U32,
    U64,
    U128,
}

impl RawDef {
    fn as_str(self) -> &'static str {
        match self {
            RawDef::U8 => "u8",
            RawDef::U16 => "u16",
            RawDef::U32 => "u32",
            RawDef::U64 => "u64",
            RawDef::U128 => "u128",
        }
    }

    fn as_type(self) -> syn::Type {
        syn::parse_str(self.as_str()).unwrap()
    }

    fn bit_len(self) -> u8 {
        match self {
            RawDef::U8 => 8,
            RawDef::U16 => 16,
            RawDef::U32 => 32,
            RawDef::U64 => 64,
            RawDef::U128 => 128,
        }
    }
}

impl Parse for RawDef {
    fn parse(input: ParseStream) -> syn::Result<Self> {
        let ident: syn::Ident = input.parse()?;
        if ident == "u8" {
            Ok(RawDef::U8)
        } else if ident == "u16" {
            Ok(RawDef::U16)
        } else if ident == "u32" {
            Ok(RawDef::U32)
        } else if ident == "u64" {
            Ok(RawDef::U64)
        } else if ident == "u128" {
            Ok(RawDef::U128)
        } else {
            Err(input.error(format!(
                "`{}` is not supported; needs to be one of u8,u16,u32,u64,u128",
                ident
            )))
        }
    }
}

#[derive(Debug)]
struct FieldDef {
    attrs: Vec<syn::Attribute>,
    vis: syn::Visibility,
    name: syn::Ident,
    target: Target,
    bits: BitRange,
}

impl Parse for FieldDef {
    fn parse(input: ParseStream) -> syn::Result<Self> {
        let attrs = input.call(syn::Attribute::parse_outer)?;
        let vis = input.parse()?;
        let name = input.parse()?;
        input.parse::<Token![:]>()?;
        let target: Target = input.parse()?;
        input.parse::<Token![=]>()?;
        let bits: BitRange = input.parse()?;
        if target.bit_len() < bits.bit_len() {
            return Err(input.error(format!(
                "target `{}` can only represent {} bits; {} specified",
                target,
                target.bit_len(),
                bits.bit_len(),
            )));
        }
        Ok(FieldDef {
            attrs,
            vis,
            name,
            target,
            bits,
        })
    }
}

#[derive(Debug, Eq, PartialEq)]
enum Target {
    /// Basic integer type: u8,u16,u32,u64,u128
    Int(RawDef),
    /// bool
    Bool,
    /// A type that will be converted to/from using bitstruct::{FromRaw, IntoRaw}
    Convert(syn::Type),
}

impl Target {
    fn smallest_target(bitlen: u8) -> Target {
        match bitlen {
            x if x == 1 => Target::Bool,
            x if x <= 8 => Target::Int(RawDef::U8),
            x if x <= 16 => Target::Int(RawDef::U16),
            x if x <= 32 => Target::Int(RawDef::U32),
            x if x <= 64 => Target::Int(RawDef::U64),
            x if x <= 128 => Target::Int(RawDef::U128),
            _ => unreachable!("invalid bitlen"),
        }
    }

    fn bit_len(&self) -> u8 {
        match self {
            Target::Int(raw) => raw.bit_len(),
            Target::Bool => 1,
            Target::Convert(_) => u8::MAX,
        }
    }

    fn as_type(&self) -> syn::Type {
        match self {
            Target::Int(raw) => raw.as_type(),
            Target::Bool => syn::parse_quote! {bool},
            Target::Convert(ty) => ty.clone().into(),
        }
    }
}

impl fmt::Display for Target {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Target::Int(rawdef) => write!(f, "{}", rawdef.as_str()),
            Target::Bool => write!(f, "bool"),
            Target::Convert(ty) => write!(f, "{:?}", ty),
        }
    }
}

mod kw {
    syn::custom_keyword!(bool);
}

impl Parse for Target {
    fn parse(input: ParseStream) -> syn::Result<Self> {
        input
            .try_parse::<RawDef>()
            .map(|raw_def| Target::Int(raw_def))
            .or_else(|_| input.try_parse::<kw::bool>().map(|_| Target::Bool))
            .or_else(|_| input.try_parse::<syn::Type>().map(|ty| Target::Convert(ty)))
    }
}

#[derive(Debug, Eq, PartialEq)]
struct BitRange(Range<u8>);

impl BitRange {
    fn bit_len(&self) -> u8 {
        self.0.len().try_into().unwrap()
    }

    fn get_mask(&self) -> u128 {
        let mut mask = !0u128;
        mask <<= 128 - self.0.end;
        mask >>= 128 - self.0.end;
        mask >>= self.0.start;
        mask <<= self.0.start;
        mask
    }
}

impl Parse for BitRange {
    fn parse(input: ParseStream) -> syn::Result<Self> {
        fn parse_end_range(input: ParseStream) -> syn::Result<u8> {
            let range_limits: syn::RangeLimits = input.parse()?;
            let end_bit: u8 = input.parse::<syn::LitInt>()?.base10_parse()?;
            Ok(match range_limits {
                syn::RangeLimits::HalfOpen(_) => end_bit,
                syn::RangeLimits::Closed(_) => end_bit + 1,
            })
        }

        let start_bit: u8 = input.parse::<syn::LitInt>()?.base10_parse()?;
        let range = match input.try_call(parse_end_range) {
            Ok(end_bit) => start_bit..end_bit,
            Err(_) => start_bit..start_bit + 1,
        };
        match range.start.cmp(&range.end) {
            Ordering::Less => {}
            Ordering::Equal => return Err(input.error("empty bit range specified")),
            Ordering::Greater => {
                return Err(input
                    .error("least significant bit must be specified before most significant bit"))
            }
        };
        Ok(BitRange(range))
    }
}

fn hexlit(typ: RawDef, value: u128) -> syn::LitInt {
    let num_hex_chars = typ.bit_len() as usize / 4;
    syn::LitInt::new(
        &format!(
            "0x{value:0width$x}{suffix:}",
            value = value,
            suffix = typ.as_str(),
            width = num_hex_chars
        ),
        proc_macro2::Span::call_site(),
    )
}

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn parse_bitstruct_input() {
        let bitstruct: BitStructInput = syn::parse2(quote! {
            #[derive(Clone,Copy)]
            pub(crate) struct Foo(pub u16) {
                #[inline]
                pub f1: u8 = 0 .. 8;
                pub f2: u8 = 8 .. 12;
            }
        })
        .unwrap();
        assert_eq!(bitstruct.name, quote::format_ident!("Foo"));
        assert_eq!(bitstruct.fields.len(), 2);
        assert_eq!(bitstruct.fields[0].attrs.len(), 1);
        assert_eq!(bitstruct.fields[1].attrs.len(), 0);
    }

    #[test]
    fn parse_field_def() {
        let field_def: FieldDef = syn::parse2(quote! {
            pub field1: u8 = 3 .. 5
        })
        .unwrap();
        assert_eq!(field_def.name, quote::format_ident!("field1"));
        assert_eq!(field_def.target, Target::Int(RawDef::U8));
        assert_eq!(field_def.bits, BitRange(3..5));

        let field_def: FieldDef = syn::parse2(quote! {
            pub field1: bool = 3
        })
        .unwrap();
        assert_eq!(field_def.name, quote::format_ident!("field1"));
        assert_eq!(field_def.target, Target::Bool);
        assert_eq!(field_def.bits, BitRange(3..4));
    }

    #[test]
    fn parse_target() {
        assert_eq!(
            Target::Int(RawDef::U8),
            syn::parse2::<Target>(quote! {u8}).unwrap(),
        );
        assert_eq!(
            Target::Int(RawDef::U16),
            syn::parse2::<Target>(quote! {u16}).unwrap(),
        );
        assert_eq!(
            Target::Int(RawDef::U128),
            syn::parse2::<Target>(quote! {u128}).unwrap(),
        );
        assert_eq!(Target::Bool, syn::parse2::<Target>(quote! {bool}).unwrap(),);
        assert_eq!(
            Target::Convert(syn::parse_quote! {MyEnum}),
            syn::parse2::<Target>(quote! {MyEnum}).unwrap(),
        );
        assert_eq!(
            Target::Convert(syn::parse_quote! {Vec<u32>}),
            syn::parse2::<Target>(quote! {Vec<u32>}).unwrap(),
        );
    }

    #[test]
    fn parse_bitrange() {
        assert_eq!(
            BitRange(0..10),
            syn::parse2::<BitRange>(quote! {0..10}).unwrap()
        );
        assert_eq!(
            BitRange(0..12),
            syn::parse2::<BitRange>(quote! {0..=11}).unwrap()
        );
        assert_eq!(
            BitRange(14..15),
            syn::parse2::<BitRange>(quote! {14}).unwrap()
        );
    }
}