Auto-generate packet dataclasses with Jinja (#1374)

2026-06-19 00:41:41 +00:00 · 2024-08-31 13:44:19 -04:00
parent c19d54c633
commit 169595e56e
140 changed files with 4445 additions and 2097 deletions
--- a/photon-serde/templates/Message.java.jinja
+++ b/photon-serde/templates/Message.java.jinja
@@ -0,0 +1,103 @@
+/*
+ * Copyright (C) Photon Vision.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+// THIS FILE WAS AUTO-GENERATED BY ./photon-serde/generate_messages.py. DO NOT MODIFY
+
+package org.photonvision.struct;
+
+import org.photonvision.common.dataflow.structures.Packet;
+import org.photonvision.common.dataflow.structures.PacketSerde;
+import org.photonvision.utils.PacketUtils;
+
+// Assume that the base class lives here and we can import it
+import org.photonvision.targeting.*;
+
+
+/**
+ * Auto-generated serialization/deserialization helper for {{name}}
+ */
+public class {{ name }}Serde implements PacketSerde<{{name}}> {
+    // Message definition md5sum. See photon_packet.adoc for details
+    public static final String MESSAGE_VERSION = "{{ message_hash }}";
+    public static final String MESSAGE_FORMAT = "{{ message_fmt }}";
+
+    public final String getTypeString() { return MESSAGE_FORMAT; }
+    public final String getInterfaceUUID() { return MESSAGE_VERSION; }
+
+    @Override
+    public int getMaxByteSize() {
+        // TODO Auto-generated method stub
+        throw new UnsupportedOperationException("Unimplemented method 'getMaxByteSize'");
+    }
+
+    @Override
+    public void pack(Packet packet, {{ name }} value) {
+{%- for field in fields -%}
+    {%- if field.type | is_shimmed %}
+        // field is shimmed!
+        {{ get_message_by_name(field.type).java_encode_shim }}(packet, value.{{ field.name }});
+    {%- elif field.optional == True %}
+        // {{ field.name }} is optional! it better not be a VLA too
+        packet.encodeOptional(value.{{ field.name }});
+    {%- elif field.vla == True and field.type | is_intrinsic %}
+        // {{ field.name }} is a intrinsic VLA!
+        packet.encode(value.{{ field.name }});
+    {%- elif field.vla == True %}
+        // {{ field.name }} is a custom VLA!
+        packet.encodeList(value.{{ field.name }});
+    {%- elif field.type | is_intrinsic %}
+        // field {{ field.name }} is of intrinsic type {{ field.type }}
+        packet.encode(({{ type_map[field.type].java_type }}) value.{{ field.name }});
+    {%- else %}
+        // field {{ field.name }} is of non-intrinsic type {{ field.type }}
+        {{ field.type }}.photonStruct.pack(packet, value.{{ field.name }});
+    {%- endif %}
+    {%- if not loop.last %}
+    {% endif -%}
+{% endfor%}
+    }
+
+    @Override
+    public {{ name }} unpack(Packet packet) {
+        var ret = new {{ name }}();
+{% for field in fields -%}
+    {%- if field.type | is_shimmed %}
+        // field is shimmed!
+        ret.{{ field.name }} = {{ get_message_by_name(field.type).java_decode_shim }}(packet);
+    {%- elif field.optional == True %}
+        // {{ field.name }} is optional! it better not be a VLA too
+        ret.{{ field.name }} = packet.decodeOptional({{ field.type }}.photonStruct);
+    {%- elif field.vla == True and not field.type | is_intrinsic %}
+        // {{ field.name }} is a custom VLA!
+        ret.{{ field.name }} = packet.decodeList({{ field.type }}.photonStruct);
+    {%- elif field.vla == True and field.type | is_intrinsic %}
+        // {{ field.name }} is a custom VLA!
+        ret.{{ field.name }} = packet.decode{{ type_map[field.type].java_type.title() }}List();
+    {%- elif field.type | is_intrinsic %}
+        // {{ field.name }} is of intrinsic type {{ field.type }}
+        ret.{{field.name}} = packet.{{ type_map[field.type].java_decode_method }}();
+    {%- else %}
+        // {{ field.name }} is of non-intrinsic type {{ field.type }}
+        ret.{{field.name}} = {{ field.type }}.photonStruct.unpack(packet);
+    {%- endif %}
+    {%- if not loop.last %}
+    {% endif -%}
+{% endfor%}
+
+        return ret;
+    }
+}