bitfields-impl 1.0.3

Macro for generating flexible bitfields. Useful for low-level code (embedded or emulators).
Documentation 
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

use proc_macro2::TokenStream;
use quote::quote;
use syn::Visibility;

use crate::generation::common::generate_setting_fields_from_bits_tokens;
use crate::parsing::bitfield_attribute::{BitfieldAttribute, Endian};
use crate::parsing::bitfield_field::BitfieldField;

/// Generates the `from_bits` function for the bitfield.
pub(crate) fn generate_from_bits_function_tokens(
    vis: Visibility,
    fields: &[BitfieldField],
    ignored_fields: &[BitfieldField],
    bitfield_type: &syn::Type,
    bitfield_attribute: &BitfieldAttribute,
) -> TokenStream {
    let setting_fields_from_bits_tokens = generate_setting_fields_from_bits_tokens(
        bitfield_type,
        fields,
        Some(quote! { Self }),
        false,
        !ignored_fields.is_empty(),
        true,
    );

    let swap_bits_endian_tokens = (bitfield_attribute.from_endian == Endian::Little).then(|| {
        quote! {
            let bits = bits.swap_bytes();
        }
    });

    let ignored_fields_defaults = ignored_fields.iter().map(|field| {
        let field_name = &field.name;
        let field_ty = &field.ty;
        quote! {
            #field_name: <#field_ty>::default(),
        }
    });

    let initialize_struct_tokens = if !ignored_fields.is_empty() {
        quote! {
            Self {
                val: 0,
                #( #ignored_fields_defaults )*
            }
        }
    } else {
        quote! {
            Self(0)
        }
    };

    let const_ident_tokens = ignored_fields.is_empty().then(|| quote! { const });

    quote! {
        #[doc = "Creates a new bitfield instance from the given bits."]
        #vis #const_ident_tokens fn from_bits(bits: #bitfield_type) -> Self {
            #swap_bits_endian_tokens
            let mut this = #initialize_struct_tokens;
            #setting_fields_from_bits_tokens
            this
        }
    }
}

/// Generates the `from_bits_with_defaults` function for the bitfield.
pub(crate) fn generate_from_bits_with_defaults_function_tokens(
    vis: Visibility,
    fields: &[BitfieldField],
    bitfield_type: &syn::Type,
    bitfield_attribute: &BitfieldAttribute,
    ignored_fields_struct: bool,
) -> TokenStream {
    let setting_fields_from_bits_tokens = generate_setting_fields_from_bits_tokens(
        bitfield_type,
        fields,
        Some(quote! { Self }),
        true,
        ignored_fields_struct,
        true,
    );

    let swap_bits_endian_tokens = (bitfield_attribute.from_endian == Endian::Little).then(|| {
        quote! {
            let bits = bits.swap_bytes();
        }
    });

    let const_ident_tokens = (!ignored_fields_struct).then(|| quote! { const });

    quote! {
        #[doc = "Creates a new bitfield instance from the given bits while respecting field default values."]
        #vis #const_ident_tokens fn from_bits_with_defaults(bits: #bitfield_type) -> Self {
            #swap_bits_endian_tokens
            let mut this = Self::from_bits(bits);
            #setting_fields_from_bits_tokens
            this
        }
    }
}

pub(crate) fn generate_into_bits_function_tokens(
    vis: Visibility,
    bitfield_attribute: &BitfieldAttribute,
    ignored_fields_struct: bool,
) -> TokenStream {
    let struct_val_ident = if ignored_fields_struct {
        quote! { self.val }
    } else {
        quote! { self.0 }
    };

    let into_bits_impl = match bitfield_attribute.into_endian {
        Endian::Big => {
            quote! {
                 #struct_val_ident
            }
        }
        Endian::Little => {
            quote! {
                 #struct_val_ident.swap_bytes()
            }
        }
    };

    let bitfield_type = &bitfield_attribute.ty;

    quote! {
        #[doc = "Returns the bits of the bitfield."]
        #vis const fn into_bits(self) -> #bitfield_type {
            #into_bits_impl
        }
    }
}