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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
use can_dbc::{
    ByteOrder, Message, MessageId, MultiplexIndicator, Signal, SignalExtendedValueType,
    ValueDescription, ValueType, DBC,
};
use proc_macro2::Literal;

use heck::{CamelCase, ShoutySnakeCase, SnakeCase};
use log::warn;
use proc_macro2::TokenStream;
use quote::{format_ident, quote};
use socketcan::{EFF_MASK, SFF_MASK};

/// Character that is prefixed before type names that are
/// are not starting with an alphabetic char.
const PREFIX_CHAR: char = 'X';

/// Character that is used to replace invalid characters
/// in type names.
const REPLACEMENT_CHAR: char = 'X';

/// Suffix that is append to the raw signal function
const RAW_FN_SUFFIX: &str = "raw_value";

type Result<T> = std::result::Result<T, std::fmt::Error>;

#[derive(Debug)]
pub struct DbccOpt {
    /// Should tokio SocketCan BCM streams be generated.
    /// This requires the `tokio-socketcan-bcm` crate.
    pub with_tokio: bool,
}

pub trait TypeName: ToOwned {
    fn to_type_name(&self) -> Self::Owned;
}

impl TypeName for str {
    fn to_type_name(&self) -> String {
        let mut out = String::with_capacity(self.len() + 1);
        let mut chars = self.chars();
        if let Some(first) = chars.next() {
            if !first.is_alphabetic() && first != '_' {
                warn!("string: {} is prefixed with `{}`", self, PREFIX_CHAR);
                out.push(PREFIX_CHAR);
            }
            out.push(first);
        }

        for chr in chars {
            if chr.is_digit(10) || chr.is_alphabetic() || chr == '_' {
                out.push(chr);
            } else {
                warn!(
                    "`{}` character in string: {} is replaced by `{}`",
                    chr, self, REPLACEMENT_CHAR
                );
                out.push(REPLACEMENT_CHAR);
            }
        }

        out
    }
}

fn to_enum_name(message_id: &MessageId, signal_name: &str) -> TokenStream {
    let enum_name = format_ident!("{}{}", &signal_name.to_camel_case(), message_id.0);
    quote! { #enum_name }
}

pub fn signal_enum(dbc: &DBC, val_desc: &ValueDescription) -> TokenStream {
    if let ValueDescription::Signal {
        ref message_id,
        ref signal_name,
        ref value_descriptions,
    } = val_desc
    {
        let enum_name = to_enum_name(message_id, signal_name);

        let enum_variants = value_descriptions.iter().map(|desc| {
            let name = format_ident!("{}", &desc.b().to_camel_case().to_type_name());
            quote! {
                #name
            }
        });

        let signal_enum_impl_from =
            signal_enum_impl_from(&dbc, val_desc).unwrap_or_else(|| quote!());

        let xvalue = if let Some(signal) = dbc.signal_by_name(*message_id, signal_name) {
            let decoded_type = signal_decoded_type(dbc, *message_id, signal);
            quote! { XValue(#decoded_type) }
        } else {
            quote! { XValue(u64) }
        };

        quote! {
            #[allow(dead_code)]
            #[derive(Debug, Clone, Copy, PartialEq)]
            #[repr(u64)]
            pub enum #enum_name {
                #(#enum_variants),*,
                #xvalue,
            }

            #signal_enum_impl_from
        }
    } else {
        quote!()
    }
}

pub fn signal_enum_impl_from(dbc: &DBC, val_desc: &ValueDescription) -> Option<TokenStream> {
    if let ValueDescription::Signal {
        ref message_id,
        ref signal_name,
        ref value_descriptions,
    } = val_desc
    {
        let enum_name = to_enum_name(message_id, signal_name);

        let signal = dbc
            .signal_by_name(*message_id, signal_name)
            .expect(&format!("Value description missing signal {:#?}", val_desc));
        let signal_type = signal_decoded_type(dbc, *message_id, signal);

        let value_descriptions = value_descriptions.iter().map(|value_description| {
            let match_left = Literal::u64_unsuffixed(*value_description.a() as u64);
            let match_right =
                format_ident!("{}", value_description.b().to_camel_case().to_type_name());
            quote! {
                #match_left => Self::#match_right
            }
        });

        Some(quote! {
            impl From<#signal_type> for #enum_name {
                #[allow(dead_code)]
                fn from(val: #signal_type) -> Self {
                    match val as u64 {
                        #(#value_descriptions),*,
                        _ => Self::XValue(val),
                    }
                }
            }
        })
    } else {
        None
    }
}

pub fn signal_fn_raw(dbc: &DBC, signal: &Signal, message_id: MessageId) -> Result<TokenStream> {
    let fn_name_raw = format_ident!("{}_{}", signal.name().to_snake_case(), RAW_FN_SUFFIX);

    let signal_decoded_type = signal_decoded_type(dbc, message_id, signal);

    let default_signal_comment = format!("Read {} signal from can frame", signal.name());
    let signal_comment = dbc
        .signal_comment(message_id, signal.name())
        .unwrap_or(&default_signal_comment);

    let signal_unit = if !signal.unit().is_empty() {
        format!("\nUnit: {}", signal.unit())
    } else {
        String::default()
    };

    let doc_msg = format!("{}{}", signal_comment, signal_unit);

    // Multiplexed signals are only available when the multiplexer switch value matches
    // the multiplexed indicator value defined in the DBC.
    let multiplexor_switch_fn = if let MultiplexIndicator::MultiplexedSignal(switch_value) =
        signal.multiplexer_indicator()
    {
        let multiplexor_switch = dbc.message_multiplexor_switch(message_id).expect(&format!(
            "Multiplexed signal missing multiplex signal switch in message: {:#?}",
            signal
        ));

        let multiplexor_switch_fn = format_ident!(
            "{}_{}",
            multiplexor_switch.name().to_snake_case(),
            RAW_FN_SUFFIX
        );

        let switch_value = Literal::u64_unsuffixed(*switch_value);
        quote! {
            if self.#multiplexor_switch_fn() != #switch_value {
                return None;
            }
        }
    } else {
        quote!()
    };

    let read_byte_order = match signal.byte_order() {
        ByteOrder::LittleEndian => quote! {
            let frame_payload: u64 = LE::read_u64(&self.frame_payload);
        },
        ByteOrder::BigEndian => quote! {
            let  frame_payload: u64 = BE::read_u64(&self.frame_payload);
        },
    };

    let bit_msk_const = 2u64.saturating_pow(*signal.signal_size() as u32) - 1;
    let signal_shift = shift_amount(
        *signal.byte_order(),
        *signal.start_bit(),
        *signal.signal_size(),
    );

    let calc = calc_raw(signal, &signal_decoded_type, signal_shift, bit_msk_const)?;

    let wrapped_calc = wrap_multiplex_indicator_value(signal, calc);
    let ret_type = wrap_multiplex_indicator_type(signal, signal_decoded_type);

    Ok(quote! {
        #[doc = #doc_msg]
        #[allow(dead_code)]
        pub fn #fn_name_raw(&self) -> #ret_type {
            #multiplexor_switch_fn
            #read_byte_order
            #wrapped_calc
        }

    })
}

pub fn signal_fn_enum(signal: &Signal, enum_type: TokenStream) -> Result<TokenStream> {
    let fn_name = format_ident!("{}", &signal.name().to_snake_case());
    let fn_name_raw = format_ident!("{}_{}", signal.name().to_snake_case(), RAW_FN_SUFFIX);

    let ret = wrap_multiplex_indicator_type(signal, enum_type.clone());

    // Multiplexed signals are only available when th
    // the multiplexed indicator value defined in the DBC.
    let from = match signal.multiplexer_indicator() {
        MultiplexIndicator::MultiplexedSignal(_) => {
            quote! { self.#fn_name_raw().map(#enum_type::from) }
        }
        _ => quote! { #enum_type::from(self.#fn_name_raw()) },
    };

    Ok(quote! {
        #[allow(dead_code)]
        pub fn #fn_name(&self) -> #ret {
            #from
        }
    })
}

fn calc_raw(
    signal: &Signal,
    signal_decoded_type: &TokenStream,
    signal_shift: u64,
    bit_msk_const: u64,
) -> Result<TokenStream> {
    let boolean_signal =
        *signal.signal_size() == 1 && *signal.factor() == 1.0 && *signal.offset() == 0.0;
    let bit_msk_const = Literal::u64_unsuffixed(bit_msk_const);
    // No shift required if start_bit == 0
    let shift = if signal_shift != 0 {
        let signal_shift = Literal::u64_unsuffixed(signal_shift);
        quote! {
            (frame_payload >> #signal_shift)
        }
    } else {
        quote! {
            frame_payload
        }
    };

    let cast = if !boolean_signal {
        quote! { as #signal_decoded_type }
    } else {
        quote!()
    };

    let factor = if *signal.factor() != 1.0 {
        let signal_factor = Literal::f64_unsuffixed(*signal.factor());
        quote! { * #signal_factor }
    } else {
        quote!()
    };

    let offset = if *signal.offset() != 0.0 {
        let offset = Literal::f64_unsuffixed(*signal.offset());
        quote! { + #offset }
    } else {
        quote!()
    };

    // boolean signal
    if boolean_signal {
        Ok(quote! {
            ((#shift & #bit_msk_const) #cast #factor #offset) == 1
        })
    } else {
        Ok(quote! {
            (#shift & #bit_msk_const) #cast #factor #offset
        })
    }
}

/// This wraps multiplex indicators in  Option types.
/// Multiplexed signals are only available when the multiplexer switch value matches
/// the multiplexed indicator value defined in the DBC.
fn wrap_multiplex_indicator_type(signal: &Signal, signal_type: TokenStream) -> TokenStream {
    match signal.multiplexer_indicator() {
        MultiplexIndicator::MultiplexedSignal(_) => quote! { Option<#signal_type> },
        _ => signal_type,
    }
}

/// This wraps multiplex indicators in  Option types.
/// Multiplexed signals are only available when the multiplexer switch value matches
/// the multiplexed indicator value defined in the DBC.
fn wrap_multiplex_indicator_value(signal: &Signal, signal_value: TokenStream) -> TokenStream {
    match signal.multiplexer_indicator() {
        MultiplexIndicator::MultiplexedSignal(_) => quote! { Some(#signal_value) },
        _ => signal_value,
    }
}

fn signal_decoded_type(dbc: &DBC, message_id: MessageId, signal: &Signal) -> TokenStream {
    if let Some(extended_value_type) = dbc.extended_value_type_for_signal(message_id, signal.name())
    {
        match extended_value_type {
            SignalExtendedValueType::IEEEfloat32Bit => {
                return quote! { f32 };
            }
            SignalExtendedValueType::IEEEdouble64bit => {
                return quote! { f64 };
            }
            SignalExtendedValueType::SignedOrUnsignedInteger => (), // Handled below, also part of the Signal itself
        }
    }

    if !(*signal.offset() == 0.0 && *signal.factor() == 1.0) {
        return quote! { f64 };
    }

    match (signal.value_type(), signal.signal_size()) {
        (_, signal_size) if *signal_size == 1 => quote! { bool },
        (ValueType::Signed, signal_size) if *signal_size > 1 && *signal_size <= 8 => quote! { i8 },
        (ValueType::Unsigned, signal_size) if *signal_size > 1 && *signal_size <= 8 => {
            quote! { u8 }
        }
        (ValueType::Signed, signal_size) if *signal_size > 8 && *signal_size <= 16 => {
            quote! { i16 }
        }
        (ValueType::Unsigned, signal_size) if *signal_size > 8 && *signal_size <= 16 => {
            quote! { u16 }
        }
        (ValueType::Signed, signal_size) if *signal_size > 16 && *signal_size <= 32 => {
            quote! { i32 }
        }
        (ValueType::Unsigned, signal_size) if *signal_size > 16 && *signal_size <= 32 => {
            quote! { u32 }
        }
        (ValueType::Signed, _) => quote!(i64),
        (ValueType::Unsigned, _) => quote!(u64),
    }
}

fn shift_amount(byte_order: ByteOrder, start_bit: u64, signal_size: u64) -> u64 {
    match byte_order {
        ByteOrder::LittleEndian => start_bit,
        ByteOrder::BigEndian => 64 - signal_size - ((start_bit / 8) * 8 + (7 - (start_bit % 8))),
    }
}

fn message_const(message: &Message) -> TokenStream {
    // let varname = syn::Ident::new(&concatenated, ident.span());
    let message_name = format_ident!(
        "MESSAGE_ID_{}",
        message.message_name().to_shouty_snake_case()
    );
    let message_id = message.message_id().0;
    quote! {
        #[allow(dead_code)]
        pub const #message_name: u32 = #message_id;

    }
}

fn message_struct(opt: &DbccOpt, dbc: &DBC, message: &Message) -> Result<TokenStream> {
    let struct_name = format_ident!("{}", &message.message_name().to_camel_case());

    let doc_msg = if let Some(message_comment) = dbc.message_comment(*message.message_id()) {
        message_comment
    } else {
        ""
    };

    let message_impl = message_impl(opt, dbc, message)?;

    Ok(quote! {
      #[doc = #doc_msg]
      #[allow(dead_code)]
      #[derive(Clone, Debug)]
      pub struct #struct_name {
        frame_payload: Vec<u8>,
      }

      #message_impl
    })
}

fn message_impl(opt: &DbccOpt, dbc: &DBC, message: &Message) -> Result<TokenStream> {
    let struct_name = format_ident!("{}", &message.message_name().to_camel_case());

    let message_stream = if opt.with_tokio {
        message_stream(message)
    } else {
        quote!()
    };

    let signal_fns = message.signals().iter().map(|signal| {
        let signal_fn_raw = signal_fn_raw(dbc, signal, *message.message_id()).unwrap();

        // Check if this signal can be turned into an enum
        let enum_type = dbc
            .value_descriptions_for_signal(*message.message_id(), signal.name())
            .map(|_| to_enum_name(message.message_id(), signal.name()));
        let signal_fn_enum = if let Some(enum_type) = enum_type {
            signal_fn_enum(signal, enum_type).unwrap()
        } else {
            quote!()
        };

        quote! {
            #signal_fn_raw

            #signal_fn_enum
        }
    });

    let message_id = match message.message_id().0 & EFF_MASK {
        0..=SFF_MASK => {
            let sff_id = (message.message_id().0 & SFF_MASK) as u16;
            quote! {
                /// CAN Frame Identifier
                #[allow(dead_code)]
                pub const ID: u16 = #sff_id;
            }
        }
        SFF_MASK..=EFF_MASK => {
            let eff_id = message.message_id().0 & EFF_MASK;
            quote! {
                /// CAN Frame Identifier
                #[allow(dead_code)]
                pub const ID: u32 = #eff_id;
            }
        }
        _ => unreachable!(),
    };

    Ok(quote! {
        impl #struct_name {

            #message_id

            #[allow(dead_code)]
            pub fn new(mut frame_payload: Vec<u8>) -> #struct_name {
                frame_payload.resize(8, 0);
                #struct_name {
                    frame_payload
                }
            }

            #[doc = "Raw frame body data"]
            pub fn data(&self) -> &[u8] {
                &self.frame_payload
            }

            #message_stream

            #(#signal_fns)*
        }
    })
}

/// Generate message stream using socketcan's Broadcast Manager filters via socketcan-tokio.
fn message_stream(message: &Message) -> TokenStream {
    let message_id = match message.message_id().0 & EFF_MASK {
        0..=SFF_MASK => {
            quote! {
                let message_id = CANMessageId::SFF(Self::ID);
            }
        }

        SFF_MASK..=EFF_MASK => {
            quote! {
                let message_id = CANMessageId::EFF(Self::ID);
            }
        }
        _ => unreachable!(),
    };

    let message_name = format_ident!("{}", message.message_name().to_camel_case());

    quote! {
        #[allow(dead_code)]
        pub fn stream(can_interface: &str, ival1: &std::time::Duration, ival2: &std::time::Duration) -> std::io::Result<impl Stream<Item = Result<Self, std::io::Error>>> {
            let socket = BCMSocket::open_nb(&can_interface)?;
            #message_id

            let frame_stream = socket.filter_id_incoming_frames(message_id, ival1.clone(), ival2.clone())?;
            let f = frame_stream.map(|frame| frame.map(|frame| #message_name::new(frame.data().to_vec())));
            Ok(f)
        }
    }
}

/// Genérate code for reading CAN signals
///
/// Example:
/// ```
/// use blake2::{Blake2b, Digest};
/// use dbcc::{can_code_gen, DbccOpt};
/// use generic_array::GenericArray;
/// use typenum::U64;
///
/// use std::fs;
/// use std::io::{self, prelude::*};
/// use std::path::{Path, PathBuf};
///
/// fn dbc_file_hash(dbc_path: &Path) -> io::Result<GenericArray<u8, U64>> {
///     let mut file = fs::File::open(&dbc_path)?;
///     let mut hasher = Blake2b::new();
///     let _n = io::copy(&mut file, &mut hasher)?;
///     Ok(hasher.result())
/// }
///
/// fn main() -> io::Result<()> {
///    let file_path_buf = PathBuf::from("./examples/j1939.dbc");
///    let file_path = file_path_buf.as_path();
///    let file_name = file_path.file_name().and_then(|f| f.to_str()).unwrap_or_else(|| "N/A");
///    let file_hash = dbc_file_hash(file_path)?;
///    let file_hash = format!("Blake2b: {:X}", file_hash);
///    let mut f = fs::File::open("./examples/j1939.dbc").expect("Failed to open input file");
///    let mut buffer = Vec::new();
///    f.read_to_end(&mut buffer).expect("Failed to read file");
///    let dbc_content = can_dbc::DBC::from_slice(&buffer).expect("Failed to parse DBC file");
///    let opt = DbccOpt { with_tokio: true };
///    let code = can_code_gen(&opt, &dbc_content, file_name, &file_hash).expect("Failed to generate rust code");
///    println!("{}", code.to_string());
///    Ok(())
/// }
///```
pub fn can_code_gen(
    opt: &DbccOpt,
    dbc: &DBC,
    file_name: &str,
    file_hash: &str,
) -> Result<TokenStream> {
    let imports = quote! {
        use byteorder::{ByteOrder, LE, BE};
    };

    let tokio_imports = if opt.with_tokio {
        quote! {

            use tokio_socketcan_bcm::{CANMessageId, BCMSocket};
            use futures::stream::Stream;
            use futures_util::stream::StreamExt;
        }
    } else {
        quote!()
    };

    let message_constants = dbc.messages().iter().map(message_const);

    let signal_enums = dbc
        .value_descriptions()
        .iter()
        .map(|vd| signal_enum(&dbc, vd));

    let message_structs = dbc
        .messages()
        .iter()
        .map(|message| message_struct(opt, &dbc, message).unwrap());

    let doc_msg = format!(
        "Generated based on\nFile Name: {}\nDBC Version: {}\n{}",
        file_name,
        dbc.version().0,
        file_hash
    );

    Ok(quote! {

        #[doc = #doc_msg]

        #imports

        #tokio_imports

        #(#message_constants)*

        #(#signal_enums)*

        #(#message_structs)*
    })
}