bitfields-impl 2.0.5

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

use proc_macro2::TokenStream;
use quote::quote;

use crate::generating::bitfield::feature::{Feature, FeaturePosition};
use crate::generating::bitfield::features::common::generator_helper::{
    generate_new_function_implementation_tokens, get_function_modifier_tokens,
};
use crate::parsing::bitfields::bitfield::Bitfield;
use crate::parsing::common::to_tokens::ToTokens;

/// Generator for new initialization functions.
///
/// Examples:
///
/// ```rust,ignore
/// pub const fn new() { ... }
/// pub const fn new_without_defaults() { ... }
/// ```
pub struct NewFunctionsFeature;

impl Feature for NewFunctionsFeature {
    fn generate_feature(&self, bitfield: &Bitfield) -> TokenStream {
        Self::generate_new_functions_tokens(bitfield)
    }

    fn enabled(&self, bitfield: &Bitfield) -> bool {
        bitfield.arguments().generate_new()
    }

    fn feature_position(&self) -> FeaturePosition {
        FeaturePosition::Inside
    }

    fn order_priority(&self) -> u32 {
        1
    }
}

impl NewFunctionsFeature {
    /// Generates new functions tokens.
    fn generate_new_functions_tokens(bitfield: &Bitfield) -> TokenStream {
        let new_function_feature_tokens = Self::generate_new_function_feature_tokens(bitfield);
        let new_without_defaults_function_feature_tokens =
            Self::generate_new_without_defaults_function_feature_tokens(bitfield);

        quote! {
            #new_function_feature_tokens
            #new_without_defaults_function_feature_tokens
        }
    }

    /// Generate `new` function tokens.
    fn generate_new_function_feature_tokens(bitfield: &Bitfield) -> TokenStream {
        let visibility_tokens = bitfield.visibility().to_tokens();
        let function_modifier_tokens = get_function_modifier_tokens(bitfield);
        let function_implementation = generate_new_function_implementation_tokens(
            bitfield, /* generate_setting_defaults= */ true, /* builder_caller= */ false,
            /* existing_bitfield= */ false,
        );

        quote! {
            #[doc = "Creates a new bitfield instance."]
            #visibility_tokens #function_modifier_tokens fn new() -> Self {
                #function_implementation
                this
            }
        }
    }

    /// Generates `new_without_defaults` function tokens.
    fn generate_new_without_defaults_function_feature_tokens(bitfield: &Bitfield) -> TokenStream {
        let visibility_tokens = bitfield.visibility().to_tokens();
        let function_modifier_tokens = get_function_modifier_tokens(bitfield);
        let function_implementation = generate_new_function_implementation_tokens(
            bitfield, /* generate_setting_defaults= */ false,
            /* builder_caller= */ false, /* existing_bitfield= */ false,
        );

        quote! {
            #[doc = "Creates a new bitfield instance without respecting \
                     default values."]
            #visibility_tokens #function_modifier_tokens fn new_without_defaults() -> Self {
                #function_implementation
                this
            }
        }
    }
}