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

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

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

pub(crate) fn generate_set_bits_function_tokens(
    vis: Visibility,
    fields: &[BitfieldField],
    bitfield_type: &syn::Type,
    ignored_fields_struct: bool,
) -> TokenStream {
    let documentation = "Sets the writable bits of the bitfield.";
    let setting_fields_from_bits_tokens = generate_setting_fields_from_bits_tokens(
        bitfield_type,
        fields,
        Some(quote! { Self }),
        false,
        ignored_fields_struct,
        false,
    );

    quote! {
        #[doc = #documentation]
        #vis fn set_bits(&mut self, bits: #bitfield_type) {
            let mut this = self;
            #setting_fields_from_bits_tokens
        }
    }
}

pub(crate) fn generate_set_bits_with_defaults_function_tokens(
    vis: Visibility,
    fields: &[BitfieldField],
    bitfield_type: &syn::Type,
    ignored_fields_struct: bool,
) -> TokenStream {
    let documentation = "Sets the writable bits of the bitfield while respecting defaults.";
    let setting_fields_from_bits_tokens = generate_setting_fields_from_bits_tokens(
        bitfield_type,
        fields,
        Some(quote! { Self }),
        true,
        ignored_fields_struct,
        false,
    );

    quote! {
        #[doc = #documentation]
        #vis fn set_bits_with_defaults(&mut self, bits: #bitfield_type) {
            let mut this = self;
            #setting_fields_from_bits_tokens
        }
    }
}

pub(crate) fn generate_clear_bits_function_tokens(
    vis: Visibility,
    fields: &[BitfieldField],
    bitfield_type: &syn::Type,
    ignored_fields_struct: bool,
) -> TokenStream {
    let documentation = "Clears the writable bits of the bitfield.";
    let setting_fields_to_zero_tokens =
        generate_setting_fields_to_zero_tokens(bitfield_type, fields, None, ignored_fields_struct);

    quote! {
        #[doc = #documentation]
        #vis fn clear_bits(&mut self) {
            let this = self;
            #setting_fields_to_zero_tokens
        }
    }
}

pub(crate) fn generate_clear_bits_preserve_defaults_function_tokens(
    vis: Visibility,
    fields: &[BitfieldField],
    bitfield_type: &syn::Type,
    ignored_fields_struct: bool,
) -> TokenStream {
    let documentation = "Clears the writable bits of the bitfield.";
    let setting_fields_from_bits_tokens = generate_setting_fields_from_bits_tokens(
        bitfield_type,
        fields,
        Some(quote! { Self }),
        true,
        ignored_fields_struct,
        false,
    );

    quote! {
        #[doc = #documentation]
        #vis fn clear_bits_with_defaults(&mut self) {
            let this = self;
            let bits = 0;
            #setting_fields_from_bits_tokens
        }
    }
}