Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

MessageId Standard vs Extended enum #13

Merged
merged 2 commits into from
Feb 8, 2024
Merged

MessageId Standard vs Extended enum #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
04cf4f5
MessageId Standard vs Extended enum
erzoe Jan 9, 2024
5d20fa8
changed check extended id vs standard id
erzoe Feb 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@
fn lookup_signal_comment() {
let dbc_content = DBC::try_from(SAMPLE_DBC).expect("Failed to parse DBC");
let comment = dbc_content
.signal_comment(MessageId(1840), "Signal_4")
.signal_comment(MessageId::Standard(1840), "Signal_4")
.expect("Signal comment missing");
assert_eq!(
"asaklfjlsdfjlsdfgls\nHH?=(%)/&KKDKFSDKFKDFKSDFKSDFNKCnvsdcvsvxkcv",
Expand All @@ -164,31 +164,31 @@
#[test]
fn lookup_signal_comment_none_when_missing() {
let dbc_content = DBC::try_from(SAMPLE_DBC).expect("Failed to parse DBC");
let comment = dbc_content.signal_comment(MessageId(1840), "Signal_2");
let comment = dbc_content.signal_comment(MessageId::Standard(1840), "Signal_2");
assert_eq!(None, comment);
}

#[test]
fn lookup_message_comment() {
let dbc_content = DBC::try_from(SAMPLE_DBC).expect("Failed to parse DBC");
let comment = dbc_content
.message_comment(MessageId(1840))
.message_comment(MessageId::Standard(1840))
.expect("Message comment missing");
assert_eq!("Some Message comment", comment);
}

#[test]
fn lookup_message_comment_none_when_missing() {
let dbc_content = DBC::try_from(SAMPLE_DBC).expect("Failed to parse DBC");
let comment = dbc_content.message_comment(MessageId(2000));
let comment = dbc_content.message_comment(MessageId::Standard(2000));
assert_eq!(None, comment);
}

#[test]
fn lookup_value_descriptions_for_signal() {
let dbc_content = DBC::try_from(SAMPLE_DBC).expect("Failed to parse DBC");
let val_descriptions = dbc_content
.value_descriptions_for_signal(MessageId(2000), "Signal_3")
.value_descriptions_for_signal(MessageId::Standard(2000), "Signal_3")
.expect("Message comment missing");

let exp = vec![ValDescription {
Expand All @@ -202,15 +202,15 @@
fn lookup_value_descriptions_for_signal_none_when_missing() {
let dbc_content = DBC::try_from(SAMPLE_DBC).expect("Failed to parse DBC");
let val_descriptions =
dbc_content.value_descriptions_for_signal(MessageId(2000), "Signal_2");
dbc_content.value_descriptions_for_signal(MessageId::Standard(2000), "Signal_2");
assert_eq!(None, val_descriptions);
}

#[test]
fn lookup_extended_value_type_for_signal() {
let dbc_content = DBC::try_from(SAMPLE_DBC).expect("Failed to parse DBC");
let extended_value_type =
dbc_content.extended_value_type_for_signal(MessageId(2000), "Signal_8");
dbc_content.extended_value_type_for_signal(MessageId::Standard(2000), "Signal_8");
assert_eq!(
extended_value_type,
Some(&SignalExtendedValueType::IEEEfloat32Bit)
Expand All @@ -221,28 +221,28 @@
fn lookup_extended_value_type_for_signal_none_when_missing() {
let dbc_content = DBC::try_from(SAMPLE_DBC).expect("Failed to parse DBC");
let extended_value_type =
dbc_content.extended_value_type_for_signal(MessageId(2000), "Signal_1");
dbc_content.extended_value_type_for_signal(MessageId::Standard(2000), "Signal_1");
assert_eq!(extended_value_type, None);
}

#[test]
fn lookup_signal_by_name() {
let dbc_content = DBC::try_from(SAMPLE_DBC).expect("Failed to parse DBC");
let signal = dbc_content.signal_by_name(MessageId(2000), "Signal_8");
let signal = dbc_content.signal_by_name(MessageId::Standard(2000), "Signal_8");
assert!(signal.is_some());
}

#[test]
fn lookup_signal_by_name_none_when_missing() {
let dbc_content = DBC::try_from(SAMPLE_DBC).expect("Failed to parse DBC");
let signal = dbc_content.signal_by_name(MessageId(2000), "Signal_25");
let signal = dbc_content.signal_by_name(MessageId::Standard(2000), "Signal_25");
assert_eq!(signal, None);
}

#[test]
fn lookup_multiplex_indicator_switch() {
let dbc_content = DBC::try_from(SAMPLE_DBC).expect("Failed to parse DBC");
let multiplexor_switch = dbc_content.message_multiplexor_switch(MessageId(3040));
let multiplexor_switch = dbc_content.message_multiplexor_switch(MessageId::Standard(3040));
assert!(multiplexor_switch.is_ok());
assert!(multiplexor_switch.as_ref().unwrap().is_some());
assert_eq!(multiplexor_switch.unwrap().unwrap().name(), "Switch");
Expand All @@ -251,7 +251,7 @@
#[test]
fn lookup_multiplex_indicator_switch_none_when_missing() {
let dbc_content = DBC::try_from(SAMPLE_DBC).expect("Failed to parse DBC");
let multiplexor_switch = dbc_content.message_multiplexor_switch(MessageId(1840));
let multiplexor_switch = dbc_content.message_multiplexor_switch(MessageId::Standard(1840));
assert!(multiplexor_switch.unwrap().is_none());
}
}
Expand Down Expand Up @@ -298,7 +298,10 @@
/// Must be unique in DBC file.
#[derive(Copy, Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize))]
pub struct MessageId(pub u32);
pub enum MessageId {
Standard(u16),
Extended(u32),
}

#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize))]
Expand Down Expand Up @@ -651,14 +654,14 @@

impl DBC {
/// Read a DBC from a buffer
pub fn from_slice(buffer: &[u8]) -> Result<DBC, Error> {

Check failure on line 657 in src/lib.rs

View workflow job for this annotation

GitHub Actions / Clippy 

the `Err`-variant returned from this function is very large
let dbc_in = std::str::from_utf8(buffer).unwrap();
Self::try_from(dbc_in)
}

#[allow(clippy::should_implement_trait)]
#[deprecated(since = "4.0.0", note = "please use `DBC::try_from` instead")]
pub fn from_str(dbc_in: &str) -> Result<DBC, Error> {

Check failure on line 664 in src/lib.rs

View workflow job for this annotation

GitHub Actions / Clippy 

the `Err`-variant returned from this function is very large
let (remaining, dbc) = parser::dbc(dbc_in).map_err(Error::Nom)?;
if !remaining.is_empty() {
return Err(Error::Incomplete(dbc, remaining));
Expand Down Expand Up @@ -775,7 +778,7 @@
pub fn message_multiplexor_switch(
&self,
message_id: MessageId,
) -> Result<Option<&Signal>, Error> {

Check failure on line 781 in src/lib.rs

View workflow job for this annotation

GitHub Actions / Clippy 

the `Err`-variant returned from this function is very large
let message = self
.messages
.iter()
Expand Down
31 changes: 19 additions & 12 deletions src/parser.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@
#[test]
fn signal_comment_test() {
let def1 = "CM_ SG_ 193 KLU_R_X \"This is a signal comment test\";\n";
let message_id = MessageId(193);
let message_id = MessageId::Standard(193);
let comment1 = Comment::Signal {
message_id,
signal_name: "KLU_R_X".to_string(),
Expand All @@ -137,7 +137,7 @@
#[test]
fn message_definition_comment_test() {
let def1 = "CM_ BO_ 34544 \"Some Message comment\";\n";
let message_id = MessageId(34544);
let message_id = MessageId::Standard(34544);
let comment1 = Comment::Message {
message_id,
comment: "Some Message comment".to_string(),
Expand Down Expand Up @@ -172,7 +172,7 @@
#[test]
fn value_description_for_signal_test() {
let def1 = "VAL_ 837 UF_HZ_OI 255 \"NOP\";\n";
let message_id = MessageId(837);
let message_id = MessageId::Standard(837);
let signal_name = "UF_HZ_OI".to_string();
let val_descriptions = vec![ValDescription {
a: 255.0,
Expand Down Expand Up @@ -243,7 +243,7 @@
fn message_definition_attribute_value_test() {
let def = "BA_ \"AttrName\" BO_ 298 13;\n";
let attribute_value = AttributeValuedForObjectType::MessageDefinitionAttributeValue(
MessageId(298),
MessageId::Standard(298),
Some(AttributeValue::AttributeValueF64(13.0)),
);
let attr_val_exp = AttributeValueForObject {
Expand All @@ -258,7 +258,7 @@
fn signal_attribute_value_test() {
let def = "BA_ \"AttrName\" SG_ 198 SGName 13;\n";
let attribute_value = AttributeValuedForObjectType::SignalAttributeValue(
MessageId(198),
MessageId::Standard(198),
"SGName".to_string(),
AttributeValue::AttributeValueF64(13.0),
);
Expand Down Expand Up @@ -377,7 +377,7 @@
let def = "SIG_GROUP_ 23 X_3290 1 : A_b XY_Z;\n";

let exp = SignalGroups {
message_id: MessageId(23),
message_id: MessageId::Standard(23),
signal_group_name: "X_3290".to_string(),
repetitions: 1,
signal_names: vec!["A_b".to_string(), "XY_Z".to_string()],
Expand Down Expand Up @@ -442,7 +442,7 @@
fn message_transmitters_test() {
let def = "BO_TX_BU_ 12345 : XZY,ABC;\n";
let exp = MessageTransmitter {
message_id: MessageId(12345),
message_id: MessageId::Standard(12345),
transmitter: vec![
Transmitter::NodeName("XZY".to_string()),
Transmitter::NodeName("ABC".to_string()),
Expand Down Expand Up @@ -502,7 +502,7 @@
// simple mapping
let def = "SG_MUL_VAL_ 2147483650 muxed_A_1 MUX_A 1-1;\n";
let exp = ExtendedMultiplex {
message_id: MessageId(2147483650),
message_id: MessageId::Extended(2),
signal_name: "muxed_A_1".to_string(),
multiplexor_signal_name: "MUX_A".to_string(),
mappings: vec![ExtendedMultiplexMapping {
Expand All @@ -516,7 +516,7 @@
// range mapping
let def = "SG_MUL_VAL_ 2147483650 muxed_A_1 MUX_A 1568-2568;\n";
let exp = ExtendedMultiplex {
message_id: MessageId(2147483650),
message_id: MessageId::Extended(2),
signal_name: "muxed_A_1".to_string(),
multiplexor_signal_name: "MUX_A".to_string(),
mappings: vec![ExtendedMultiplexMapping {
Expand All @@ -530,7 +530,7 @@
// multiple mappings
let def = "SG_MUL_VAL_ 2147483650 muxed_B_5 MUX_B 5-5, 16-24;\n";
let exp = ExtendedMultiplex {
message_id: MessageId(2147483650),
message_id: MessageId::Extended(2),
signal_name: "muxed_B_5".to_string(),
multiplexor_signal_name: "MUX_B".to_string(),
mappings: vec![
Expand All @@ -552,7 +552,7 @@
fn sig_val_type_test() {
let def = "SIG_VALTYPE_ 2000 Signal_8 : 1;\n";
let exp = SignalExtendedValueTypeList {
message_id: MessageId(2000),
message_id: MessageId::Standard(2000),
signal_name: "Signal_8".to_string(),
signal_extended_value_type: SignalExtendedValueType::IEEEfloat32Bit,
};
Expand All @@ -567,7 +567,7 @@
}

fn is_c_string_char(chr: char) -> bool {
chr.is_digit(10) || chr.is_alphabetic() || chr == '_'

Check failure on line 570 in src/parser.rs

View workflow job for this annotation

GitHub Actions / Clippy 

use of `char::is_digit` with literal radix of 10
}

fn is_c_ident_head(chr: char) -> bool {
Expand Down Expand Up @@ -669,7 +669,7 @@

fn char_string(s: &str) -> IResult<&str, &str> {
let (s, _) = quote(s)?;
let (s, char_string_value) = take_till(|c| is_quote(c as char))(s)?;

Check failure on line 672 in src/parser.rs

View workflow job for this annotation

GitHub Actions / Clippy 

casting to the same type is unnecessary (`char` -> `char`)
let (s, _) = quote(s)?;
Ok((s, char_string_value))
}
Expand All @@ -687,7 +687,14 @@
}

fn message_id(s: &str) -> IResult<&str, MessageId> {
map(complete::u32, MessageId)(s)
let (s, parsed_value) = complete::u32(s)?;

if parsed_value & (1 << 31) != 0 {
let extended_value = parsed_value & u32::from(u16::MAX);
Ok((s, MessageId::Extended(extended_value & 0x1FFFFFFF)))
} else {
Ok((s, MessageId::Standard(parsed_value as u16)))
}
}

fn signed(s: &str) -> IResult<&str, ValueType> {
Expand Down Expand Up @@ -1278,7 +1285,7 @@
fn attribute_definition_node(s: &str) -> IResult<&str, AttributeDefinition> {
let (s, _) = tag("BU_")(s)?;
let (s, _) = ms1(s)?;
let (s, node) = take_till(|c| is_semi_colon(c as char))(s)?;

Check failure on line 1288 in src/parser.rs

View workflow job for this annotation

GitHub Actions / Clippy 

casting to the same type is unnecessary (`char` -> `char`)
Ok((s, AttributeDefinition::Node(node.to_string())))
}

Expand All @@ -1286,7 +1293,7 @@
fn attribute_definition_signal(s: &str) -> IResult<&str, AttributeDefinition> {
let (s, _) = tag("SG_")(s)?;
let (s, _) = ms1(s)?;
let (s, signal) = take_till(|c| is_semi_colon(c as char))(s)?;

Check failure on line 1296 in src/parser.rs

View workflow job for this annotation

GitHub Actions / Clippy 

casting to the same type is unnecessary (`char` -> `char`)
Ok((s, AttributeDefinition::Signal(signal.to_string())))
}

Expand All @@ -1294,7 +1301,7 @@
fn attribute_definition_environment_variable(s: &str) -> IResult<&str, AttributeDefinition> {
let (s, _) = tag("EV_")(s)?;
let (s, _) = ms1(s)?;
let (s, env_var) = take_till(|c| is_semi_colon(c as char))(s)?;

Check failure on line 1304 in src/parser.rs

View workflow job for this annotation

GitHub Actions / Clippy 

casting to the same type is unnecessary (`char` -> `char`)
Ok((
s,
AttributeDefinition::EnvironmentVariable(env_var.to_string()),
Expand All @@ -1305,13 +1312,13 @@
fn attribute_definition_message(s: &str) -> IResult<&str, AttributeDefinition> {
let (s, _) = tag("BO_")(s)?;
let (s, _) = ms1(s)?;
let (s, message) = take_till(|c| is_semi_colon(c as char))(s)?;

Check failure on line 1315 in src/parser.rs

View workflow job for this annotation

GitHub Actions / Clippy 

casting to the same type is unnecessary (`char` -> `char`)
Ok((s, AttributeDefinition::Message(message.to_string())))
}

// TODO add properties
fn attribute_definition_plain(s: &str) -> IResult<&str, AttributeDefinition> {
let (s, plain) = take_till(|c| is_semi_colon(c as char))(s)?;

Check failure on line 1321 in src/parser.rs

View workflow job for this annotation

GitHub Actions / Clippy 

casting to the same type is unnecessary (`char` -> `char`)
Ok((s, AttributeDefinition::Plain(plain.to_string())))
}

Expand Down
Loading