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
//! Macros to `derive` the `modbus-mapping` traits

use proc_macro::TokenStream;
use quote::quote;

mod config;
mod entry;
mod mapping;
mod utils;

/// Derive macro to implement `modbus_mapping::core::InputRegisterMap`
#[proc_macro_derive(InputRegisterMap, attributes(modbus))]
pub fn derive_input_register_map(input: TokenStream) -> TokenStream {
    let ast = syn::parse_macro_input!(input as syn::DeriveInput);

    let name = &ast.ident;

    let block_config = config::Config::new(&ast);

    let mapping = mapping::Mapping::new(&ast);
    let block_mappings = mapping.split_into_block_mappings(&block_config);

    let mut blocks = Vec::new();
    for mapping in block_mappings {
        let field_name = mapping.field_name_vec();
        let field_ty = mapping.field_ty_vec();
        let x = mapping.x_vec();
        let addr = mapping.addr_vec();
        let ty = mapping.ty_vec();
        let cnt = mapping.cnt_vec();
        let from_words = mapping.fn_from_words_vec();

        let (start, end) = mapping.register_range();
        let len = end - start;

        let block = quote! {
            // Read
            let words = client.read_input_registers(#start, #len).await?;
            #(
                // Decode
                let #field_name: #ty = modbus_mapping::codec::Decode::#from_words(&words[(#addr - #start) as usize..(#addr - #start + #cnt) as usize]).unwrap();
                // Convert and scale
                #[allow(clippy::unnecessary_cast)]
                let #field_name: #field_ty = (#field_name as #field_ty) * (#x as #field_ty);
                // Set
                self.#field_name = #field_name;

            )*

        };
        blocks.push(block);
    }

    let tokens = quote! {
        #[async_trait::async_trait]
        impl modbus_mapping::core::InputRegisterMap for #name {
            async fn update_from_input_registers(&mut self, client: &mut dyn tokio_modbus::client::Reader) -> Result<(), std::io::Error>{
                #(#blocks)*
                Ok(())
            }
        }

    };

    tokens.into()
}

/// Derive macro to implement `modbus_mapping::core::HoldingRegisterMap`
#[proc_macro_derive(HoldingRegisterMap, attributes(modbus))]
pub fn derive_holding_register_map(input: TokenStream) -> TokenStream {
    let ast = syn::parse_macro_input!(input as syn::DeriveInput);

    let name = &ast.ident;

    let block_config = config::Config::new(&ast);

    let mapping = mapping::Mapping::new(&ast);
    let block_mappings = mapping.clone().split_into_block_mappings(&block_config);

    let mut read_blocks = Vec::new();
    for mapping in block_mappings {
        let field_name = mapping.field_name_vec();
        let field_ty = mapping.field_ty_vec();
        let x = mapping.x_vec();
        let addr = mapping.addr_vec();
        let ty = mapping.ty_vec();
        let cnt = mapping.cnt_vec();
        let from_words = mapping.fn_from_words_vec();

        let (start, end) = mapping.register_range();
        let len = end - start;

        let block = quote! {
            // Read
            let words = client.read_holding_registers(#start, #len).await?;
            #(
                // Decode
                let #field_name: #ty = modbus_mapping::codec::Decode::#from_words(&words[(#addr - #start) as usize..(#addr - #start + #cnt) as usize]).unwrap();
                // Convert and scale
                #[allow(clippy::unnecessary_cast)]
                let #field_name: #field_ty = (#field_name as #field_ty) * (#x as #field_ty);
                // Set
                self.#field_name = #field_name;

            )*

        };
        read_blocks.push(block);
    }

    let mut write_blocks = Vec::new();
    let mut method_blocks = write_blocks.clone();
    for entry in mapping.0 {
        let field_name = entry.field_name_ident();
        let field_ty = entry.field_ty_ident();
        let x = &entry.x;
        let addr = &entry.addr;
        let ty = entry.ty_ident();
        let to_words = entry.fn_to_words();

        let mut block = quote! {
            // Convert and rescale
            #[allow(clippy::unnecessary_cast)]
            let #field_name: #ty = (self.#field_name / (#x as #field_ty)) as #ty;
            // Encode
            let field_words: Vec<modbus_mapping::codec::Word> = modbus_mapping::codec::Encode::#to_words(#field_name);
        };
        if entry.ty.word_size() == 1 {
            block.extend(quote! {
                client.write_single_register(#addr, field_words.first().unwrap().clone()).await?;
            })
        } else {
            block.extend(quote! {
                // Set (use splice alternatively)
                client.write_multiple_registers(#addr, &field_words).await?;
            })
        }

        write_blocks.push(block.clone());

        let method = entry.write_method_ident();
        let block = quote! {
            pub async fn #method(&self, client: &mut dyn tokio_modbus::client::Writer) -> Result<(), std::io::Error> {
                #block
                Ok(())
            }
        };
        method_blocks.push(block.clone());
    }

    let tokens = quote! {
        #[async_trait::async_trait]
        impl modbus_mapping::core::HoldingRegisterMap for #name {
            async fn update_from_holding_registers(&mut self, client: &mut dyn tokio_modbus::client::Reader) -> Result<(), std::io::Error>{
                #(#read_blocks)*
                Ok(())
            }

            async fn write_to_registers(&self, client: &mut dyn tokio_modbus::client::Writer) -> Result<(), std::io::Error> {
                #(#write_blocks)*;
                Ok(())
            }
        }

        impl #name {
            #(#method_blocks)*
        }

    };

    tokens.into()
}

#[proc_macro_attribute]
pub fn modbus_doc(_attr: TokenStream, item: TokenStream) -> TokenStream {
    let mut ast = syn::parse_macro_input!(item as syn::DeriveInput);
    match &mut ast.data {
        syn::Data::Struct(ref mut struct_data) => {
            match &mut struct_data.fields {
                syn::Fields::Named(fields_named) => {
                    for field in &mut fields_named.named {
                        if field
                            .attrs
                            .iter()
                            .any(|attr| attr.path().is_ident("modbus"))
                        {
                            let entry: entry::Entry = field.clone().into();
                            let doc = format!("address - `{}`, data type - `{:?}` (`{}` registers), word order - `{:?}`, scale factor - `{}`, unit - `{}`.", entry.addr, entry.ty, entry.ty.word_size(), entry.ord, entry.x, entry.unit);
                            let doc: syn::Attribute = syn::parse_quote!(#[doc = #doc]);
                            field.attrs.push(doc);
                        }
                    }
                }
                _ => panic!("`modbus_doc` has to be applied to structs with named fields"),
            }

            quote! {
                #ast
            }
            .into()
        }
        _ => panic!("`modbus_doc` has to be applied with structs"),
    }
}

/// Derive macro to implement `modbus_mapping::core::InputRegisterModel`
#[proc_macro_derive(InputRegisterModel, attributes(modbus))]
pub fn derive_input_register_model(input: TokenStream) -> TokenStream {
    let ast = syn::parse_macro_input!(input as syn::DeriveInput);

    let name = &ast.ident;

    let mapping = mapping::Mapping::new(&ast);
    // panic!("{:#?}", mapping);

    let field_name = mapping.field_name_vec();
    let field_ty = mapping.field_ty_vec();
    let x = mapping.x_vec();
    let addr = mapping.addr_vec();
    let ty = mapping.ty_vec();
    let to_words = mapping.fn_to_words_vec();

    let tokens = quote! {
        impl modbus_mapping::simulator::InputRegisterModel for #name {
            fn new_registers(&self) -> modbus_mapping::simulator::Registers {
                let mut registers = modbus_mapping::simulator::Registers::default();

                #(
                    // Divide by scale factor
                    #[allow(clippy::unnecessary_cast)]
                    let #field_name: #ty = (&self.#field_name / (#x as #field_ty)) as #ty;
                    registers.insert(#addr, modbus_mapping::codec::Encode::#to_words(#field_name));
                )*

                registers
            }

            fn update_registers(
                &self,
                registers: &mut modbus_mapping::simulator::Registers,
            ) -> Result<(), std::io::Error> {
                #(
                    // Divide by scale factor
                    #[allow(clippy::unnecessary_cast)]
                    let #field_name: #ty = (self.#field_name / (#x as #field_ty)) as #ty;
                    registers.write(#addr, &modbus_mapping::codec::Encode::#to_words(#field_name))?;
                )*
                Ok(())
            }
        }
    };

    tokens.into()
}

/// Derive macro to implement `modbus_mapping::core::HoldingRegisterModel`
#[proc_macro_derive(HoldingRegisterModel, attributes(modbus))]
pub fn derive_holding_register_model(input: TokenStream) -> TokenStream {
    let ast = syn::parse_macro_input!(input as syn::DeriveInput);

    let name = &ast.ident;

    let mapping = mapping::Mapping::new(&ast);
    // panic!("{:#?}", mapping);

    let field_name = mapping.field_name_vec();
    let field_ty = mapping.field_ty_vec();
    let x = mapping.x_vec();
    let addr = mapping.addr_vec();
    let cnt = mapping.cnt_vec();
    let ty = mapping.ty_vec();
    let to_words = mapping.fn_to_words_vec();
    let from_words = mapping.fn_from_words_vec();

    let tokens = quote! {
        impl modbus_mapping::simulator::HoldingRegisterModel for #name {
            fn new_registers(&self) -> modbus_mapping::simulator::Registers {
                let mut registers = modbus_mapping::simulator::Registers::default();

                #(
                    // Divide by scale factor
                    #[allow(clippy::unnecessary_cast)]
                    let #field_name: #ty = (&self.#field_name / (#x as #field_ty)) as #ty;
                    registers.insert(#addr, modbus_mapping::codec::Encode::#to_words(#field_name));
                )*

                registers
            }

            fn update_registers(
                &self,
                registers: &mut modbus_mapping::simulator::Registers,
            ) -> Result<(), std::io::Error> {
                #(
                    // Divide by scale factor
                    #[allow(clippy::unnecessary_cast)]
                    let #field_name: #ty = (self.#field_name / (#x as #field_ty)) as #ty;
                    registers.write(#addr, &modbus_mapping::codec::Encode::#to_words(#field_name))?;

                )*
                Ok(())
            }

            fn update_self(&mut self, registers: &modbus_mapping::simulator::Registers) -> Result<(), std::io::Error> {
                #(
                    // Read
                    let words = registers.read(#addr, #cnt)?;
                    // Decode
                    let #field_name: #ty = modbus_mapping::codec::Decode::#from_words(&words).unwrap();
                    // Convert and scale
                    #[allow(clippy::unnecessary_cast)]
                    let #field_name: #field_ty = (#field_name as #field_ty) * (#x as #field_ty);
                    // Set
                    self.#field_name = #field_name;
                )*

                Ok(())
            }
        }

    };

    tokens.into()
}