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

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

use crate::generation::common::{
    generate_setting_fields_default_values_tokens, generate_setting_fields_to_zero_tokens,
};
use crate::parsing::bitfield_field::BitfieldField;

/// Generates the `new` function for the bitfield.
///
/// Output:
///
/// ```ignore
/// fn new() -> Self { ... }
/// ```
pub(crate) fn generate_new_function_tokens(
    vis: Visibility,
    fields: &[BitfieldField],
    ignored_fields: &[BitfieldField],
    bitfield_type: &syn::Type,
) -> TokenStream {
    let setting_fields_default_values_tokens = generate_setting_fields_default_values_tokens(
        bitfield_type,
        fields,
        None,
        !ignored_fields.is_empty(),
    );
    let documentation = "Creates a new bitfield instance.";

    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 = #documentation]
        #vis #const_ident_tokens fn new() -> Self {
            let mut this = #initialize_struct_tokens;
            #setting_fields_default_values_tokens
            this
        }
    }
}

/// Generates the `new` function for the bitfield without setting default
/// values.
///
/// Output:
///
/// ```ignore
/// fn new_without_defaults() -> Self { ... }
/// ```
pub(crate) fn generate_new_without_defaults_function_tokens(
    vis: Visibility,
    fields: &[BitfieldField],
    ignored_fields: &[BitfieldField],
    bitfield_type: &syn::Type,
) -> TokenStream {
    let setting_fields_to_zero_tokens = generate_setting_fields_to_zero_tokens(
        bitfield_type,
        fields,
        None,
        !ignored_fields.is_empty(),
    );
    let documentation = "Creates a new bitfield instance without setting any default values.";

    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 = #documentation]
        #vis #const_ident_tokens fn new_without_defaults() -> Self {
            let mut this = #initialize_struct_tokens;
            #setting_fields_to_zero_tokens
            this
        }
    }
}