Merge branch 'main' into naming

Author: nyurik

.pre-commit-config.yaml

@@ -3,7 +3,7 @@
 exclude: |
   (?x)^(
       .+\.(dbc|DBC)
-    | .*/docs/diagram\.svg
+    | docs/diagram\.svg
   )$
 
 repos:

Cargo.toml

@@ -11,11 +11,16 @@ edition = "2021"
 rust-version = "1.74"
 
 [features]
-default = ["with-serde"]
-with-serde = ["dep:serde"]
+default = ["with-serde", "encodings"]
+# Support decoding from all standard encodings, e.g. cp1251 commonly used for dbc
+encodings = ["dep:encoding_rs"]
+serde = ["dep:serde"]
+# This feature is deprecated per clippy::redundant_feature_names.  Use `serde` instead.
+with-serde = ["serde"]
 
 [dependencies]
 derive-getters = "0.5"
+encoding_rs = { version = "0.8", optional = true }
 nom = { version = "8.0", features = ["alloc"] }
 serde = { version = "1.0", features = ["derive"], optional = true }
 
@@ -31,18 +36,12 @@ unused_qualifications = "warn"
 [lints.clippy]
 cargo = { level = "warn", priority = -1 }
 pedantic = { level = "warn", priority = -1 }
+# Verified allows
+ref_option = "allow"  # required by derive-getters
+redundant_feature_names = "allow"  # remove once with-serde feature is removed
+needless_doctest_main = "allow" # README code block contains main function
 # TODO: fix these if it makes sense
-doc_markdown = "allow"     # 36
 must_use_candidate = "allow"     # 12
 missing_errors_doc = "allow"      # 8
 similar_names = "allow"      # 4
-redundant_feature_names = "allow"      # 4
 needless_pass_by_value = "allow"      # 4
-cargo_common_metadata = "allow"      # 4
-upper_case_acronyms = "allow"      # 2
-trivially_copy_pass_by_ref = "allow"      # 2
-ref_option = "allow"      # 2
-match_wildcard_for_single_variants = "allow"      # 2
-cast_possible_truncation = "allow"      # 2
-match_same_arms = "allow"      # 1
-items_after_test_module = "allow"      # 1

README.md

@@ -10,111 +10,97 @@
 
 A CAN-dbc format parser written with Rust's [nom](https://github.com/Geal/nom) parser combinator library. CAN databases are used to exchange details about a CAN network, e.g. what messages are being send over the CAN bus and what data do they contain.
 
-# 1. Example
+## Usage example
 
 Read dbc file and generate Rust structs based on the messages/signals defined in the dbc.
 
 ```rust,no_run
-use can_dbc::DBC;
+use std::fs;
+use can_dbc::Dbc;
 use codegen::Scope;
 
-use std::fs::File;
-use std::io;
-use std::io::prelude::*;
-
-fn main() -> io::Result<()> {
-    let mut f = File::open("./examples/sample.dbc")?;
-    let mut buffer = Vec::new();
-    f.read_to_end(&mut buffer)?;
-
-    let dbc = can_dbc::DBC::from_slice(&buffer).expect("Failed to parse dbc file");
+fn main() {
+    let data = fs::read_to_string("./examples/sample.dbc").expect("Unable to read input file");
+    let dbc = Dbc::try_from(data.as_str()).expect("Failed to parse dbc file");
 
     let mut scope = Scope::new();
-    for message in dbc.messages() {
-        for signal in message.signals() {
-
-            let mut scope = Scope::new();
-            let message_struct = scope.new_struct(message.name());
-            for signal in message.signals() {
-                message_struct.field(signal.name().to_lowercase().as_str(), "f64");
-            }
+    for msg in dbc.messages() {
+        let msg_struct = scope.new_struct(msg.name());
+        for signal in msg.signals() {
+            msg_struct.field(signal.name().to_lowercase().as_str(), "f64");
         }
     }
 
     println!("{}", scope.to_string());
-    Ok(())
 }
 ```
 
 For a proper implementation for reading or writing CAN frames according to the DBC, I recommend you take a look at [dbc-codegen](https://github.com/technocreatives/dbc-codegen).
 
-# 2. Example
+## Running Parser Example
 
 The file parser simply parses a dbc input file and prints the parsed content.
 
 ```bash
-cargo test && ./target/debug/examples/file_parser -i examples/sample.dbc
-```
-
-# Installation
-can-dbc is available on crates.io and can be included in your Cargo enabled project like this:
-
-```toml
-[dependencies]
-can-dbc = "3.0"
+cargo run --example file_parser -- --input examples/sample.dbc
 ```
 
 # Structure
 
 ![Diagram](./docs/diagram.svg)
 
-
-# Implemented DBC parts
-
-- [x] version
-- [x] new_symbols
-- [x] bit_timing *(deprecated but mandatory)*
-- [x] nodes
-- [x] value_tables
-- [x] messages
-- [x] message_transmitters
-- [x] environment_variables
-- [x] environment_variables_data
-- [x] signal_types
-- [x] comments
-- [x] attribute_definitions
-- [ ] sigtype_attr_list *(format missing documentation)*
-- [x] attribute_defaults
-- [x] attribute_values
-- [x] value_descriptions
-- [ ] category_definitions *(deprecated)*
-- [ ] categories *(deprecated)*
-- [ ] filter *(deprecated)*
-- [x] signal_type_refs
-- [x] signal_groups
-- [x] signal_extended_value_type_list
-
-# Deviating from standard
+## Implemented DBC parts
+
+- [x] `version`
+- [x] `new_symbols`
+- [x] `bit_timing` *(deprecated but mandatory)*
+- [x] `nodes`
+- [x] `value_tables`
+- [x] `messages`
+- [x] `message_transmitters`
+- [x] `environment_variables`
+- [x] `environment_variables_data`
+- [x] `signal_types`
+- [x] `comments`
+- [x] `attribute_definitions`
+- [ ] `sigtype_attr_list` *(format missing documentation)*
+- [x] `attribute_defaults`
+- [x] `attribute_values`
+- [x] `value_descriptions`
+- [ ] `category_definitions` *(deprecated)*
+- [ ] `categories` *(deprecated)*
+- [ ] `filter` *(deprecated)*
+- [x] `signal_type_refs`
+- [x] `signal_groups`
+- [x] `signal_extended_value_type_list`
+
+### Deviating from standard
 - multispace between parsers instead of single space allowing e.g. (two spaces) `SIG_GROUP  13`.
 - `VAL_` suffix may be ` ;` or `;`
 
-# Alternatives
+## Alternatives
 - [canparse](https://github.com/jmagnuson/canparse)
 
-# Credits
+## Credits
 Test dbcs files were copied from the [cantools](https://github.com/eerimoq/cantools) project.
 
-# License Checks
-
-This project uses [cargo-deny](https://github.com/EmbarkStudios/cargo-deny) for checking the licenses of dependencies. To run the check locally run the following:
-
-```bash
-cargo install cargo-deny
-cargo deny check
-```
-
-# Development
+## Development
 * This project is easier to develop with [just](https://just.systems/man/en/), a modern alternative to `make`.
 * To get a list of available commands, run `just`.
 * To run tests, use `just test`.
 * This project uses [insta](https://insta.rs) for snapshot testing. To update the snapshots run `just bless`
+
+## License
+
+Licensed under either of
+
+* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>)
+* MIT license ([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/licenses/MIT>)
+  at your option.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally
+submitted for inclusion in the work by you, as defined in the
+Apache-2.0 license, shall be dual-licensed as above, without any
+additional terms or conditions.

deny.toml

@@ -7,6 +7,7 @@
 # [possible values: any SPDX 3.11 short identifier (+ optional exception)].
 allow = [
     "Apache-2.0",
+    "BSD-3-Clause",
     "MIT",
     "Unicode-3.0",
 ]

examples/file_parser.rs

@@ -1,44 +1,48 @@
+use std::borrow::Cow;
 use std::convert::TryFrom;
-use std::fs::File;
-use std::io;
-use std::io::prelude::*;
+use std::fs;
+use std::str::from_utf8;
 
+use can_dbc::encodings::Encoding;
+use can_dbc::{Dbc, Error};
 use clap::Parser;
 
 #[derive(Parser)]
 #[command(about, version)]
 struct Args {
+    /// Input file encoding. If not specified, UTF-8 is assumed.
+    #[arg(short, long, default_value = "utf-8")]
+    encoding: Option<String>,
+
     /// DBC file path
-    #[arg(
-        short,
-        long,
-        default_value = "./examples/sample.dbc",
-        value_name = "FILE"
-    )]
+    #[arg(default_value = "./examples/sample.dbc", value_name = "FILE")]
     input: String,
 }
 
-fn main() -> io::Result<()> {
+fn main() {
     let args = Args::parse();
     let path = &args.input;
 
-    let mut f = File::open(path)?;
-    let mut buffer = Vec::new();
-    f.read_to_end(&mut buffer)?;
-    let dbc_in = std::str::from_utf8(&buffer).unwrap();
+    let data = fs::read(path).expect("Unable to read input file");
+
+    let data = if let Some(enc) = &args.encoding {
+        let enc = Encoding::for_label(enc.as_bytes()).expect("Unknown encoding");
+        enc.decode_without_bom_handling_and_without_replacement(&data)
+            .expect("Unable to decode using specified encoding")
+    } else {
+        let data = from_utf8(&data).expect("Input file is not valid UTF-8. Consider specifying the encoding with the --encoding option.");
+        Cow::Borrowed(data)
+    };
 
-    match can_dbc::DBC::try_from(dbc_in) {
-        Ok(dbc_content) => println!("DBC Content{dbc_content:#?}"),
+    match Dbc::try_from(data.as_ref()) {
+        Ok(dbc_content) => println!("{dbc_content:#?}"),
         Err(e) => {
             match e {
-                can_dbc::Error::Nom(nom::Err::Error(e) | nom::Err::Failure(e)) => eprintln!("{e:?}"),
-                can_dbc::Error::Nom(nom::Err::Incomplete(needed)) => eprintln!("Nom incomplete needed: {needed:#?}"),
-                can_dbc::Error::Incomplete(dbc, remaining) => eprintln!("Not all data in buffer was read {dbc:#?}, remaining unparsed (length: {}): {remaining}\n...(truncated)", remaining.len()),
-                can_dbc::Error::MultipleMultiplexors => eprintln!("Multiple multiplexors defined"),
-                can_dbc::Error::InvalidContent(e) => eprintln!("Invalid content: {e:?}"),
+                Error::Nom(nom::Err::Error(e) | nom::Err::Failure(e)) => eprintln!("{e:?}"),
+                Error::Nom(nom::Err::Incomplete(needed)) => eprintln!("Nom incomplete needed: {needed:#?}"),
+                Error::Incomplete(dbc, remaining) => eprintln!("Not all data in buffer was read {dbc:#?}, remaining unparsed (length: {}): {remaining}\n...(truncated)", remaining.len()),
+                Error::MultipleMultiplexors => eprintln!("Multiple multiplexors defined"),
             }
         }
     }
-
-    Ok(())
 }

justfile

@@ -14,7 +14,7 @@ ci_mode := if env('CI', '') != '' {'1'} else {''}
 binstall_args := if env('CI', '') != '' {'--no-confirm --no-track --disable-telemetry'} else {''}
 export RUSTFLAGS := env('RUSTFLAGS', if ci_mode == '1' {'-D warnings'} else {''})
 export RUSTDOCFLAGS := env('RUSTDOCFLAGS', if ci_mode == '1' {'-D warnings'} else {''})
-export RUST_BACKTRACE := env('RUST_BACKTRACE', if ci_mode == '1' {'1'} else {''})
+export RUST_BACKTRACE := env('RUST_BACKTRACE', if ci_mode == '1' {'1'} else {'0'})
 
 @_default:
     {{just_executable()}} --list