can-dbc 9.0.0

A parser for the DBC format. The DBC format is used to exchange CAN network data.
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
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
use std::str;

use can_dbc_pest::{DbcParser, Parser as _, Rule};

use crate::ast::{
    AttributeDefault, AttributeDefinition, AttributeValueForObject, Baudrate, Comment,
    EnvironmentVariable, EnvironmentVariableData, ExtendedMultiplex, Message, MessageId,
    MessageTransmitter, MultiplexIndicator, Node, Signal, SignalExtendedValueType,
    SignalExtendedValueTypeList, SignalGroups, SignalType, SignalTypeRef, Symbol, ValDescription,
    ValueDescription, ValueTable, Version,
};
use crate::parser::{collect_all, DbcError, DbcResult};
use crate::{AttributeValue, AttributeValueForObjectType, AttributeValueForRelation};

#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Dbc {
    /// Version generated by DB editor
    pub version: Version,
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub new_symbols: Vec<Symbol>,
    /// Baud rate of network
    pub bit_timing: Option<Vec<Baudrate>>,
    /// CAN network nodes
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub nodes: Vec<Node>,
    /// Global value table
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub value_tables: Vec<ValueTable>,
    /// CAN message (frame) details including signal details
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub messages: Vec<Message>,
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub message_transmitters: Vec<MessageTransmitter>,
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub environment_variables: Vec<EnvironmentVariable>,
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub environment_variable_data: Vec<EnvironmentVariableData>,
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub signal_types: Vec<SignalType>,
    /// Object comments
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub comments: Vec<Comment>,
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub attribute_definitions: Vec<AttributeDefinition>,
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub relation_attribute_definitions: Vec<AttributeDefinition>,
    // undefined
    // sigtype_attr_list: SigtypeAttrList,
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub attribute_defaults: Vec<AttributeDefault>,
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub relation_attribute_defaults: Vec<AttributeDefault>,
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub relation_attribute_values: Vec<AttributeValueForRelation>,
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub attribute_values_database: Vec<AttributeValueForDatabase>,
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub attribute_values_node: Vec<AttributeValueForNode>,
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub attribute_values_message: Vec<AttributeValueForMessage>,
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub attribute_values_signal: Vec<AttributeValueForSignal>,
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub attribute_values_env: Vec<AttributeValueForEnvVariable>,
    /// Encoding for signal raw values
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub value_descriptions: Vec<ValueDescription>,
    // obsolete + undefined
    // category_definitions: Vec<CategoryDefinition>,
    // obsolete + undefined
    //categories: Vec<Category>,
    // obsolete + undefined
    //filter: Vec<Filter>,
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub signal_type_refs: Vec<SignalTypeRef>,
    /// Signal groups define a group of signals within a message
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub signal_groups: Vec<SignalGroups>,
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub signal_extended_value_type_list: Vec<SignalExtendedValueTypeList>,
    /// Extended multiplex attributes
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
    pub extended_multiplex: Vec<ExtendedMultiplex>,
}

#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct AttributeValueForDatabase {
    pub name: String,
    pub value: AttributeValue,
}

#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct AttributeValueForNode {
    pub name: String,
    pub node_name: String,
    pub value: AttributeValue,
}

#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct AttributeValueForMessage {
    pub name: String,
    pub message_id: MessageId,
    pub value: AttributeValue,
}

#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct AttributeValueForSignal {
    pub name: String,
    pub message_id: MessageId,
    pub signal_name: String,
    pub value: AttributeValue,
}

#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct AttributeValueForEnvVariable {
    pub name: String,
    pub variable_name: String,
    pub value: AttributeValue,
}

impl Dbc {
    #[must_use]
    pub fn signal_by_name(&self, message_id: MessageId, signal_name: &str) -> Option<&Signal> {
        let message = self
            .messages
            .iter()
            .find(|message| message.id == message_id);

        if let Some(message) = message {
            return message
                .signals
                .iter()
                .find(|signal| signal.name == *signal_name);
        }
        None
    }

    /// Lookup a message comment
    #[must_use]
    pub fn message_comment(&self, message_id: MessageId) -> Option<&str> {
        self.comments.iter().find_map(|x| match x {
            Comment::Message {
                id: ref x_message_id,
                ref comment,
            } => {
                if *x_message_id == message_id {
                    Some(comment.as_str())
                } else {
                    None
                }
            }
            _ => None,
        })
    }

    /// Lookup a signal comment
    #[must_use]
    pub fn signal_comment(&self, message_id: MessageId, signal_name: &str) -> Option<&str> {
        self.comments.iter().find_map(|x| match x {
            Comment::Signal {
                message_id: ref x_message_id,
                name: ref x_signal_name,
                comment,
            } => {
                if *x_message_id == message_id && x_signal_name == signal_name {
                    Some(comment.as_str())
                } else {
                    None
                }
            }
            _ => None,
        })
    }

    /// Lookup value descriptions for signal
    #[must_use]
    pub fn value_descriptions_for_signal(
        &self,
        message_id: MessageId,
        signal_name: &str,
    ) -> Option<&[ValDescription]> {
        self.value_descriptions.iter().find_map(|x| match x {
            ValueDescription::Signal {
                message_id: ref x_message_id,
                name: ref x_signal_name,
                ref value_descriptions,
            } => {
                if *x_message_id == message_id && x_signal_name == signal_name {
                    Some(value_descriptions.as_slice())
                } else {
                    None
                }
            }
            ValueDescription::EnvironmentVariable { .. } => None,
        })
    }

    /// Lookup the extended value for a given signal
    #[must_use]
    pub fn extended_value_type_for_signal(
        &self,
        message_id: MessageId,
        signal_name: &str,
    ) -> Option<&SignalExtendedValueType> {
        self.signal_extended_value_type_list.iter().find_map(|x| {
            let SignalExtendedValueTypeList {
                message_id: ref x_message_id,
                signal_name: ref x_signal_name,
                ref signal_extended_value_type,
            } = x;
            if *x_message_id == message_id && x_signal_name == signal_name {
                Some(signal_extended_value_type)
            } else {
                None
            }
        })
    }

    /// Lookup the message multiplexer switch signal for a given message
    /// This does not work for extended multiplexed messages, if multiple multiplexors are defined for a message an Error is returned.
    pub fn message_multiplexor_switch(&self, message_id: MessageId) -> DbcResult<Option<&Signal>> {
        let message = self
            .messages
            .iter()
            .find(|message| message.id == message_id);

        if let Some(message) = message {
            if self
                .extended_multiplex
                .iter()
                .any(|ext_mp| ext_mp.message_id == message_id)
            {
                Err(DbcError::MultipleMultiplexors)
            } else {
                Ok(message
                    .signals
                    .iter()
                    .find(|signal| signal.multiplexer_indicator == MultiplexIndicator::Multiplexor))
            }
        } else {
            Ok(None)
        }
    }
}

impl<'a> TryFrom<&'a str> for Dbc {
    type Error = DbcError;

    fn try_from(dbc_in: &'a str) -> Result<Self, Self::Error> {
        dbc(dbc_in)
    }
}

#[allow(clippy::too_many_lines)] // FIXME: refactor
pub(crate) fn dbc(buffer: &str) -> DbcResult<Dbc> {
    let mut version = Version::default();
    let mut new_symbols = vec![];
    let mut bit_timing = None;
    let mut nodes = vec![];
    let mut value_tables = vec![];
    let mut messages: Vec<Message> = vec![];
    let mut message_transmitters = vec![];
    let mut environment_variables = vec![];
    let mut environment_variable_data = vec![];
    let mut comments = vec![];
    let mut attribute_definitions = vec![];
    let mut relation_attribute_definitions = vec![];
    let mut attribute_defaults = vec![];
    let mut relation_attribute_defaults = vec![];
    let mut attribute_values_database = vec![];
    let mut attribute_values_node = vec![];
    let mut attribute_values_message = vec![];
    let mut attribute_values_signal = vec![];
    let mut attribute_values_env = vec![];
    let mut relation_attribute_values = vec![];
    let mut value_descriptions = vec![];
    let mut signal_groups = vec![];
    let mut signal_extended_value_type_list = vec![];
    let mut extended_multiplex = vec![];

    for pair in DbcParser::parse(Rule::file, buffer)? {
        if !matches!(pair.as_rule(), Rule::file) {
            return Err(DbcError::ExpectedRule(Rule::file, pair.as_rule()));
        }
        for pairs in pair.into_inner() {
            match pairs.as_rule() {
                Rule::version => version = pairs.try_into()?,
                Rule::new_symbols => {
                    let symbols: Vec<Symbol> = collect_all::<Symbol>(&mut pairs.into_inner())?;
                    new_symbols.extend(symbols);
                }
                Rule::bit_timing => {
                    let _inner_pairs = pairs.into_inner();
                    // For now, just return empty vec since bit-timing parsing is not implemented
                    bit_timing = Some(vec![]);
                }
                Rule::nodes => nodes = collect_all::<Node>(&mut pairs.into_inner())?,
                Rule::message => messages.push(pairs.try_into()?),
                Rule::comment => comments.push(pairs.try_into()?),
                Rule::attr_def => attribute_definitions.push(pairs.try_into()?),
                Rule::ba_def_rel => relation_attribute_definitions.push(pairs.try_into()?),
                Rule::ba_rel => relation_attribute_values.push(pairs.try_into()?),
                Rule::attr_value => {
                    let attr_value: AttributeValueForObject = pairs.try_into()?;
                    match attr_value.value {
                        AttributeValueForObjectType::Raw(attribute_value) => {
                            attribute_values_database.push(AttributeValueForDatabase {
                                name: attr_value.name,
                                value: attribute_value,
                            });
                        }
                        AttributeValueForObjectType::NetworkNode(node_name, attribute_value) => {
                            attribute_values_node.push(AttributeValueForNode {
                                name: attr_value.name,
                                node_name,
                                value: attribute_value,
                            });
                        }
                        AttributeValueForObjectType::MessageDefinition(
                            message_id,
                            attribute_value,
                        ) => {
                            if let Some(value) = attribute_value {
                                attribute_values_message.push(AttributeValueForMessage {
                                    name: attr_value.name,
                                    message_id,
                                    value,
                                });
                            }
                        }
                        AttributeValueForObjectType::Signal(
                            message_id,
                            signal_name,
                            attribute_value,
                        ) => {
                            attribute_values_signal.push(AttributeValueForSignal {
                                name: attr_value.name,
                                message_id,
                                signal_name,
                                value: attribute_value,
                            });
                        }
                        AttributeValueForObjectType::EnvVariable(
                            variable_name,
                            attribute_value,
                        ) => {
                            attribute_values_env.push(AttributeValueForEnvVariable {
                                name: attr_value.name,
                                variable_name,
                                value: attribute_value,
                            });
                        }
                    }
                }
                Rule::value_table => value_tables.push(pairs.try_into()?),
                Rule::value_table_def => value_descriptions.push(pairs.try_into()?),
                Rule::signal_group => signal_groups.push(pairs.try_into()?),
                Rule::signal_value_type => {
                    signal_extended_value_type_list.push(pairs.try_into()?);
                }
                Rule::message_transmitter => message_transmitters.push(pairs.try_into()?),
                Rule::ba_def_def => attribute_defaults.push(pairs.try_into()?),
                Rule::ba_def_def_rel => relation_attribute_defaults.push(pairs.try_into()?),
                Rule::sg_mul_val => extended_multiplex.push(pairs.try_into()?),
                Rule::environment_variable => {
                    environment_variables.push(pairs.try_into()?);
                }
                Rule::env_var_data => environment_variable_data.push(pairs.try_into()?),
                Rule::EOI => {
                    // ignore
                }
                other => panic!("Unexpected rule in DBC file: {other:?}"),
            }
        }
    }

    Ok(Dbc {
        version,
        new_symbols,
        bit_timing,
        nodes,
        value_tables,
        messages,
        message_transmitters,
        environment_variables,
        environment_variable_data,
        signal_types: vec![], // TODO
        comments,
        attribute_definitions,
        relation_attribute_definitions,
        attribute_defaults,
        relation_attribute_defaults,
        relation_attribute_values,
        attribute_values_database,
        attribute_values_node,
        attribute_values_message,
        attribute_values_signal,
        attribute_values_env,
        value_descriptions,
        signal_type_refs: vec![], // TODO
        signal_groups,
        signal_extended_value_type_list,
        extended_multiplex,
    })
}