add friendly_name method to rust java python [DEVINFRA-1045] (#1262)

swift-nav · Dec 11, 2022 · b4708cf · b4708cf
1 parent 711b048
commit b4708cf
Show file tree

Hide file tree

Showing 387 changed files with 4,608 additions and 3 deletions.
diff --git a/generator/sbpg/specs/yaml_schema.py b/generator/sbpg/specs/yaml_schema.py
@@ -49,6 +49,7 @@
                  Optional('fields'): bitfield}})
 definition = Schema({identifier:
                      {Optional('id'): sbp_identifier,
+                      Optional('friendly_name'): description,
                       Optional('short_desc'): description,
                       Optional('desc'): description,
                       Optional('replaced_by'): [identifier],

diff --git a/generator/sbpg/syntax.py b/generator/sbpg/syntax.py
@@ -73,7 +73,8 @@ def __repr__(self):
 class Definition(object):
   def __init__(self, identifier=None,
                sbp_id=None, short_desc=None, desc=None, type_id=None,
-               fields=None, public=False, embedded_type=False):
+               fields=None, public=False, embedded_type=False,
+               friendly_name=""):
     self.identifier = identifier
     self.sbp_id = sbp_id
     self.short_desc = short_desc
@@ -83,6 +84,7 @@ def __init__(self, identifier=None,
     self.fields = fields or []
     self.public = public
     self.static = True
+    self.friendly_name = friendly_name or get_friendly_name(identifier)
 
   @property
   def max_type_len(self):
@@ -215,6 +217,27 @@ def __repr__(self):
 ##############################################################################
 #
 
+def get_friendly_name(identifier):
+    shorten_keyword = {
+        "TRACKING": "TRK",
+        "MEASUREMENT": "MEAS",
+        "INDEX": "IDX",
+        "NETWORK": "NET",
+        "EPHEMERIS": "EPH",
+        "_": " "
+    }
+    f_name = identifier
+    if f_name.endswith("_GNSS"):
+        f_name = f_name[:-5] + " GNSS-only"
+
+    # replace MSG_
+    if f_name.startswith("MSG_"):
+        f_name = f_name[4:]
+
+    for key, item in shorten_keyword.items():
+        f_name = f_name.replace(key, item)
+    return f_name
+
 def is_message(obj):
   return isinstance(obj, Definition) and getattr(obj, 'sbp_id', None)
 

diff --git a/generator/sbpg/targets/resources/MessageTest.java.j2 b/generator/sbpg/targets/resources/MessageTest.java.j2
@@ -76,6 +76,8 @@ public class (((s.suite_name)))Test {
         Number value;
         Number expected;
         ((*- for f in t.fieldskeys *))(((compare_value( (((f))), (((t.fields[f]))) ))))((*- endfor *))
+
+        org.junit.Assert.assertNotEquals("", msg.getFriendlyName());
     }
     ((*- endfor *))
 }
diff --git a/generator/sbpg/targets/resources/rust/sbp_messages_mod.rs b/generator/sbpg/targets/resources/rust/sbp_messages_mod.rs
@@ -33,7 +33,7 @@ mod lib {
     pub use crate::time;
     pub use crate::wire_format::{PayloadParseError, WireFormat};
 
-    pub use super::{ConcreteMessage, Sbp, SbpMessage, TryFromSbpError};
+    pub use super::{ConcreteMessage, FriendlyName, Sbp, SbpMessage, TryFromSbpError};
 
     pub use bytes::{Buf, BufMut};
 
@@ -85,6 +85,10 @@ pub trait SbpMessage: WireFormat + Clone + Sized {
     fn gps_time(&self) -> Option<Result<crate::time::MessageTime, crate::time::GpsTimeError>> {
         None
     }
+    /// Get friendly name associated with the message.
+    fn friendly_name(&self) -> &'static str {
+        ""
+    }
 }
 
 /// Implemented by messages who's message name and type are known at compile time.
@@ -96,6 +100,11 @@ pub trait ConcreteMessage: SbpMessage + TryFrom<Sbp, Error = TryFromSbpError> {
     const MESSAGE_NAME: &'static str;
 }
 
+/// Friendly name representation of Sbp message
+pub trait FriendlyName {
+    fn friendly_name() -> &'static str;
+}
+
 /// The error returned when using [TryFrom] to convert [Sbp] to the wrong message type.
 #[derive(Debug, Clone)]
 pub struct TryFromSbpError(pub Sbp);
@@ -264,6 +273,19 @@ impl SbpMessage for Sbp {
             },
         }
     }
+
+    fn friendly_name(&self) -> &'static str {
+        match self {
+            ((*- for m in msgs *))
+            Sbp::(((m.msg_name)))(msg) => {
+                msg.friendly_name()
+            },
+            ((*- endfor -*))
+            Sbp::Unknown(msg) => {
+                msg.friendly_name()
+            },
+        }
+    }
 }
 
 impl WireFormat for Sbp {

diff --git a/generator/sbpg/targets/resources/rust/sbp_messages_template.rs b/generator/sbpg/targets/resources/rust/sbp_messages_template.rs
@@ -140,6 +140,12 @@ impl SbpMessage for (((m.msg_name))) {
     (((m.gps_time_fn)))
 }
 
+impl FriendlyName for (((m.msg_name))) {
+    fn friendly_name() -> &'static str {
+        "(((m.friendly_name)))"
+    }
+}
+
 impl TryFrom<Sbp> for (((m.msg_name))) {
     type Error = TryFromSbpError;
     fn try_from(msg: Sbp) -> Result<Self, Self::Error> {

diff --git a/generator/sbpg/targets/resources/sbp_construct_template.py.j2 b/generator/sbpg/targets/resources/sbp_construct_template.py.j2
@@ -196,6 +196,12 @@ class ((( m.identifier | classnameify )))(SBP):
     self.payload = ((( m.identifier | classnameify )))._parser.build(c)
     return self.pack()
 
+  def friendly_name(self):
+    """Produces friendly human-readable name for this message
+
+    """
+    return "(((m.friendly_name)))"
+
   def into_buffer(self, buf, offset):
     """Produce a framed/packed SBP message into the provided buffer and offset.
 

diff --git a/generator/sbpg/targets/resources/sbp_java.java.j2 b/generator/sbpg/targets/resources/sbp_java.java.j2
@@ -87,6 +87,11 @@ public class (((m.identifier | classnameify))) extends SBPMessage {
         ((*- endfor *)) ((*- endif *))
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "(((m.friendly_name)))";
+    }
 }
 ((*- endif *))
 ((*- if not m.is_real_message *))

diff --git a/generator/sbpg/targets/rust.py b/generator/sbpg/targets/rust.py
@@ -370,6 +370,7 @@ def __init__(self, msg, package, package_specs):
             if len(field.bitfield) > 0:
                 self.has_bitfield = True
         self.gps_time_fn = gps_time_fn(self)
+        self.friendly_name = msg.friendly_name
 
 
 class PackageItem(object):

diff --git a/java/src/com/swiftnav/sbp/SBPMessage.java b/java/src/com/swiftnav/sbp/SBPMessage.java
@@ -91,6 +91,10 @@ protected void build(Builder builder) {
         assert false : "Subclass must override build()";
     }
 
+    public String getFriendlyName() {
+        return "";
+    }
+
     /** There is no exposed access to this class outside of libsbp. */
     @SuppressWarnings("unchecked")
     public class Parser {

diff --git a/java/src/com/swiftnav/sbp/acquisition/MsgAcqResult.java b/java/src/com/swiftnav/sbp/acquisition/MsgAcqResult.java
@@ -85,4 +85,9 @@ public JSONObject toJSON() {
         obj.put("sid", sid.toJSON());
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "ACQ RESULT";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/acquisition/MsgAcqResultDepA.java b/java/src/com/swiftnav/sbp/acquisition/MsgAcqResultDepA.java
@@ -86,4 +86,9 @@ public JSONObject toJSON() {
         obj.put("prn", prn);
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "ACQ RESULT DEP A";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/acquisition/MsgAcqResultDepB.java b/java/src/com/swiftnav/sbp/acquisition/MsgAcqResultDepB.java
@@ -86,4 +86,9 @@ public JSONObject toJSON() {
         obj.put("sid", sid.toJSON());
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "ACQ RESULT DEP B";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/acquisition/MsgAcqResultDepC.java b/java/src/com/swiftnav/sbp/acquisition/MsgAcqResultDepC.java
@@ -83,4 +83,9 @@ public JSONObject toJSON() {
         obj.put("sid", sid.toJSON());
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "ACQ RESULT DEP C";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/acquisition/MsgAcqSvProfile.java b/java/src/com/swiftnav/sbp/acquisition/MsgAcqSvProfile.java
@@ -67,4 +67,9 @@ public JSONObject toJSON() {
         obj.put("acq_sv_profile", SBPStruct.toJSONArray(acq_sv_profile));
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "ACQ SV PROFILE";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/acquisition/MsgAcqSvProfileDep.java b/java/src/com/swiftnav/sbp/acquisition/MsgAcqSvProfileDep.java
@@ -66,4 +66,9 @@ public JSONObject toJSON() {
         obj.put("acq_sv_profile", SBPStruct.toJSONArray(acq_sv_profile));
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "ACQ SV PROFILE DEP";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/bootload/MsgBootloaderHandshakeDepA.java b/java/src/com/swiftnav/sbp/bootload/MsgBootloaderHandshakeDepA.java
@@ -66,4 +66,9 @@ public JSONObject toJSON() {
         obj.put("handshake", new JSONArray(handshake));
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "BOOTLOADER HANDSHAKE DEP A";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/bootload/MsgBootloaderHandshakeReq.java b/java/src/com/swiftnav/sbp/bootload/MsgBootloaderHandshakeReq.java
@@ -61,4 +61,9 @@ public JSONObject toJSON() {
         JSONObject obj = super.toJSON();
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "BOOTLOADER HANDSHAKE REQ";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/bootload/MsgBootloaderHandshakeResp.java b/java/src/com/swiftnav/sbp/bootload/MsgBootloaderHandshakeResp.java
@@ -73,4 +73,9 @@ public JSONObject toJSON() {
         obj.put("version", version);
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "BOOTLOADER HANDSHAKE RESP";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/bootload/MsgBootloaderJumpToApp.java b/java/src/com/swiftnav/sbp/bootload/MsgBootloaderJumpToApp.java
@@ -64,4 +64,9 @@ public JSONObject toJSON() {
         obj.put("jump", jump);
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "BOOTLOADER JUMP TO APP";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/bootload/MsgNapDeviceDnaReq.java b/java/src/com/swiftnav/sbp/bootload/MsgNapDeviceDnaReq.java
@@ -62,4 +62,9 @@ public JSONObject toJSON() {
         JSONObject obj = super.toJSON();
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "NAP DEVICE DNA REQ";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/bootload/MsgNapDeviceDnaResp.java b/java/src/com/swiftnav/sbp/bootload/MsgNapDeviceDnaResp.java
@@ -68,4 +68,9 @@ public JSONObject toJSON() {
         obj.put("dna", new JSONArray(dna));
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "NAP DEVICE DNA RESP";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/ext_events/MsgExtEvent.java b/java/src/com/swiftnav/sbp/ext_events/MsgExtEvent.java
@@ -89,4 +89,9 @@ public JSONObject toJSON() {
         obj.put("pin", pin);
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "EXT EVENT";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/file_io/MsgFileioConfigReq.java b/java/src/com/swiftnav/sbp/file_io/MsgFileioConfigReq.java
@@ -66,4 +66,9 @@ public JSONObject toJSON() {
         obj.put("sequence", sequence);
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "FILEIO CONFIG REQ";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/file_io/MsgFileioConfigResp.java b/java/src/com/swiftnav/sbp/file_io/MsgFileioConfigResp.java
@@ -84,4 +84,9 @@ public JSONObject toJSON() {
         obj.put("fileio_version", fileio_version);
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "FILEIO CONFIG RESP";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/file_io/MsgFileioReadDirReq.java b/java/src/com/swiftnav/sbp/file_io/MsgFileioReadDirReq.java
@@ -82,4 +82,9 @@ public JSONObject toJSON() {
         obj.put("dirname", dirname);
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "FILEIO READ DIR REQ";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/file_io/MsgFileioReadDirResp.java b/java/src/com/swiftnav/sbp/file_io/MsgFileioReadDirResp.java
@@ -74,4 +74,9 @@ public JSONObject toJSON() {
         obj.put("contents", new JSONArray(contents));
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "FILEIO READ DIR RESP";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/file_io/MsgFileioReadReq.java b/java/src/com/swiftnav/sbp/file_io/MsgFileioReadReq.java
@@ -87,4 +87,9 @@ public JSONObject toJSON() {
         obj.put("filename", filename);
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "FILEIO READ REQ";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/file_io/MsgFileioReadResp.java b/java/src/com/swiftnav/sbp/file_io/MsgFileioReadResp.java
@@ -73,4 +73,9 @@ public JSONObject toJSON() {
         obj.put("contents", new JSONArray(contents));
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "FILEIO READ RESP";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/file_io/MsgFileioRemove.java b/java/src/com/swiftnav/sbp/file_io/MsgFileioRemove.java
@@ -66,4 +66,9 @@ public JSONObject toJSON() {
         obj.put("filename", filename);
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "FILEIO REMOVE";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/file_io/MsgFileioWriteReq.java b/java/src/com/swiftnav/sbp/file_io/MsgFileioWriteReq.java
@@ -87,4 +87,9 @@ public JSONObject toJSON() {
         obj.put("data", new JSONArray(data));
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "FILEIO WRITE REQ";
+    }
 }
diff --git a/java/src/com/swiftnav/sbp/file_io/MsgFileioWriteResp.java b/java/src/com/swiftnav/sbp/file_io/MsgFileioWriteResp.java
@@ -66,4 +66,9 @@ public JSONObject toJSON() {
         obj.put("sequence", sequence);
         return obj;
     }
+
+    @Override
+    public String getFriendlyName() {
+        return "FILEIO WRITE RESP";
+    }
 }