Merge pull request #9 from andresv/prepend-x-to-enums-that-start-with-numeric

Prepend X to enum fields that start with a numeric

Author: Pascal Hertleif

README.md

@@ -1,5 +1,41 @@
-# CAN DBC code-gen for embedded Rust
+# CAN DBC code generator for Rust
 
-Experimental code generator.
-Use with caution.
-Breaking changes will happen when you least expect it.
+Generates Rust messages from a `dbc` file.
+
+⚠️ This is experimental - use with caution. Breaking changes will happen when you least expect it. ⚠️
+
+# Usage
+
+Generate `messages.rs` from `example.dbc`.
+```bash
+cargo run -- testing/dbc-examples/example.dbc dir/where/messages_rs/file/is/written
+```
+
+# Development
+
+```bash
+# generate messages.rs
+cargo run -- testing/dbc-examples/example.dbc testing/can-messages/src
+
+# build all binaries
+cargo build --all
+
+# run all tests
+cargo test --all
+
+# format before commiting anything
+cargo fmt --all
+```
+
+## Generate .kdc from .dbc
+
+Use [canmatrix](https://github.com/ebroecker/canmatrix) if you need to generate a new `.kcd` file from a `.dbc`.
+
+```bash
+# https://canmatrix.readthedocs.io/en/latest/installation.html
+pip install canmatrix
+pip install git+https://github.com/ebroecker/canmatrix#egg=canmatrix[kcd]
+
+# generate .kcd
+canconvert testing/dbc-examples/example.dbc testing/dbc-examples/example.kcd
+```

src/main.rs

@@ -534,5 +534,9 @@ fn enum_name(msg: &Message, signal: &Signal) -> String {
 }
 
 fn enum_variant_name(x: &str) -> String {
-    x.to_camel_case()
+    if !x.starts_with(|c: char| c.is_ascii_alphabetic()) {
+        format!("X{}", x.to_camel_case())
+    } else {
+        x.to_camel_case()
+    }
 }

testing/can-messages/src/messages.rs

@@ -376,8 +376,14 @@ impl Bar {
     /// - Unit: "boolean"
     /// - Receivers: Dolor
     #[inline(always)]
-    pub fn five(&self) -> bool {
-        self.five_raw()
+    pub fn five(&self) -> BarFive {
+        match self.five_raw() {
+            false => BarFive::X0off,
+            true => BarFive::X1on,
+            false => BarFive::X2oner,
+            false => BarFive::X3onest,
+            x => BarFive::Other(x),
+        }
     }
 
     /// Get raw value of Five
@@ -440,6 +446,16 @@ pub enum BarFour {
     Onest,
     Other(u8),
 }
+/// Defined values for Five
+#[derive(Clone, Copy, PartialEq)]
+#[cfg_attr(feature = "debug", derive(Debug))]
+pub enum BarFive {
+    X0off,
+    X1on,
+    X2oner,
+    X3onest,
+    Other(bool),
+}
 
 /// This is just to make testing easier
 fn main() {}

testing/dbc-examples/example.dbc

@@ -5,7 +5,7 @@ NS_ :
 
 BS_:
 
-BU_: Lorem Ipsum Dolor 
+BU_: Lorem Ipsum Dolor
 
 
 BO_ 256 Foo: 4 Lorem
@@ -29,3 +29,4 @@ BO_ 512 Bar: 8 Ipsum
 
 VAL_ 512 Three 0 "OFF" 1 "ON" 2 "ONER" 3 "ONEST";
 VAL_ 512 Four 0 "Off" 1 "On" 2 "Oner" 3 "Onest";
+VAL_ 512 Five 0 "0Off" 1 "1On" 2 "2Oner" 3 "3Onest";

testing/dbc-examples/example.kcd

@@ -3,7 +3,7 @@
   <Node name="Lorem" id="1"/>
   <Node name="Ipsum" id="2"/>
   <Node name="Dolor" id="3"/>
-  <Bus name="Example">
+  <Bus name="testing/dbc-examples/example">
     <Message id="0x100" name="Foo" length="4">
       <Notes></Notes>
       <Producer>
@@ -38,6 +38,12 @@
           <NodeRef id="3"/>
         </Consumer>
         <Value max="7"/>
+        <LabelSet>
+          <Label name="OFF" value="0"/>
+          <Label name="ON" value="1"/>
+          <Label name="ONER" value="2"/>
+          <Label name="ONEST" value="3"/>
+        </LabelSet>
       </Signal>
       <Signal name="Four" offset="13" length="2" endianess="big">
         <Consumer>
@@ -51,6 +57,18 @@
           <Label name="Onest" value="3"/>
         </LabelSet>
       </Signal>
+      <Signal name="Five" offset="25" endianess="big">
+        <Consumer>
+          <NodeRef id="3"/>
+        </Consumer>
+        <Value unit="boolean"/>
+        <LabelSet>
+          <Label name="0Off" value="0"/>
+          <Label name="1On" value="1"/>
+          <Label name="2Oner" value="2"/>
+          <Label name="3Onest" value="3"/>
+        </LabelSet>
+      </Signal>
     </Message>
   </Bus>
 </NetworkDefinition>