Fixes to <variant> read functionality when member has non-trivial read.

Fix to #34 github issue.

Author: arobenko

app/commsdsl2comms/src/CommsField.cpp

@@ -401,6 +401,11 @@ bool CommsField::commsHasCustomValue() const
     return m_customCode.m_hasValue;
 }
 
+bool CommsField::commsHasCustomRead() const
+{
+    return (m_customCode.m_hasRead) || (!commsDefReadFuncBodyImpl().empty());
+}
+
 bool CommsField::commsHasCustomValid() const
 {
     return (m_customCode.m_hasValid) || (!commsDefValidFuncBodyImpl().empty());

app/commsdsl2comms/src/CommsField.h

@@ -91,6 +91,7 @@ class CommsField
     std::string commsBareMetalDefaultOptions() const;
 
     bool commsHasCustomValue() const;
+    bool commsHasCustomRead() const;
     bool commsHasCustomValid() const;
     bool commsHasCustomLength(bool deepCheck = true) const;
     const CommsField* commsFindSibling(const std::string& name) const;

app/commsdsl2comms/src/CommsVariantField.cpp

@@ -360,22 +360,32 @@ std::string CommsVariantField::commsDefReadFuncBodyImpl() const
             static const std::string Templ =
                 "case #^#VAL#$#:\n"
                 "    {\n"
+                "        #^#ADJUST_ITER#$#\n"
+                "        #^#ADJUST_LEN#$#\n"
                 "        auto& field_#^#BUNDLE_NAME#$# = initField_#^#BUNDLE_NAME#$#();\n"
                 "        COMMS_ASSERT(field_#^#BUNDLE_NAME#$#.field_#^#KEY_NAME#$#().getValue() == commonKeyField.getValue());\n"
                 "        #^#VERSION_ASSIGN#$#\n"
-                "        return field_#^#BUNDLE_NAME#$#.template readFrom<1>(iter, len);\n"
+                "        return field_#^#BUNDLE_NAME#$#.#^#READ#$#(iter, len);\n"
                 "    }";
 
             util::GenReplacementMap repl = {
                 {"VAL", std::move(valStr)},
                 {"BUNDLE_NAME", bundleAccName},
                 {"KEY_NAME", keyAccName},
+                {"READ", "template readFrom<1>"},
             };
 
             if (m->commsIsVersionDependent()) {
                 auto assignStr = "field_" + bundleAccName + ".setVersion(Base::getVersion());";
                 repl["VERSION_ASSIGN"] = std::move(assignStr);
             }
+
+            if (m->commsHasCustomRead()) {
+                repl["ADJUST_ITER"] = "iter = origIter;";
+                repl["ADJUST_LEN"] = "len += consumedLen;";
+                repl["READ"] = "read";
+            }
+
             cases.push_back(util::genProcessTemplate(Templ, repl));
             continue;
         }
@@ -385,20 +395,29 @@ std::string CommsVariantField::commsDefReadFuncBodyImpl() const
 
         static const std::string Templ =
             "default:\n"
+            "    #^#ADJUST_ITER#$#\n"
+            "    #^#ADJUST_LEN#$#\n"
             "    initField_#^#BUNDLE_NAME#$#().field_#^#KEY_NAME#$#().setValue(commonKeyField.getValue());\n"
             "    #^#VERSION_ASSIGN#$#\n"
-            "    return accessField_#^#BUNDLE_NAME#$#().template readFrom<1>(iter, len);";
+            "    return accessField_#^#BUNDLE_NAME#$#().#^#READ#$#(iter, len);";
 
         util::GenReplacementMap repl = {
             {"BUNDLE_NAME", bundleAccName},
             {"KEY_NAME", keyAccName},
+            {"READ", "template readFrom<1>"},
         };
 
         if (m->commsIsVersionDependent()) {
             auto assignStr = "field_" + bundleAccName + ".setVersion(Base::getVersion());";
             repl["VERSION_ASSIGN"] = std::move(assignStr);
         }
 
+        if (m->commsHasCustomRead()) {
+            repl["ADJUST_ITER"] = "iter = origIter;";
+            repl["ADJUST_LEN"] = "len += consumedLen;";
+            repl["READ"] = "read";
+        }
+
         cases.push_back(util::genProcessTemplate(Templ, repl));
         hasDefault = true;
     }

app/commsdsl2comms/test/test28/Schema.xml

@@ -15,6 +15,19 @@
                 <int name="type" type="uint8" defaultValidValue="1" failOnInvalid="true" fixedValue="true" />
                 <int name="val" type="uint8" />
             </bundle>
+            <bundle name="P3">
+                <int name="type" type="uint8" defaultValidValue="2" failOnInvalid="true" fixedValue="true" />
+                <set name="flags" length="1">
+                    <bit name="V1Present" idx="0" />
+                    <bit name="V2Present" idx="1" />
+                </set>
+                <optional name="v1" cond="$flags.V1Present" defaultMode="missing">
+                    <int name="ActV1" type="uint8" />
+                </optional>
+                <optional name="v2" cond="$flags.V2Present" defaultMode="missing">
+                    <int name="ActV2" type="uint8" />
+                </optional>
+            </bundle>
         </variant>
 
         <variant name="Variant2" reuse="Variant1" defaultMember="P1" />
@@ -602,6 +615,10 @@
         <ref field="Variant3" name="F1" />
     </message>
 
+    <message name="Msg3" id="MsgId.M3">
+        <ref field="Variant1" name="F1" />
+    </message>
+
     <frame name="Frame">
         <id name="ID" field="MsgId" />
         <payload name="Data" />

app/commsdsl2comms/test/test28/test28Test.th

@@ -12,6 +12,7 @@ public:
     void test1();
     void test2();
     void test3();
+    void test4();
 
     using Interface =
         test28::Message<
@@ -65,3 +66,27 @@ void TestSuite::test3()
     msg.field_variant1().selectField(1U);
     TS_ASSERT_EQUALS(msg.field_variant1().currentField(), 1U);
 }
+
+void TestSuite::test4()
+{
+    static const std::uint8_t Buf1[] =
+    {
+        3, 2, 0x3, 1, 2
+    };
+    static const std::size_t Buf1Size = std::extent<decltype(Buf1)>::value;
+
+    Frame::MsgPtr msgPtr;
+    Frame frame;
+
+    auto readIter = comms::readIteratorFor<Interface>(&Buf1[0]);
+    auto es = frame.read(msgPtr, readIter, Buf1Size);
+    TS_ASSERT_EQUALS(es, comms::ErrorStatus::Success);
+    TS_ASSERT(msgPtr);
+    TS_ASSERT_EQUALS(msgPtr->getId(), test28::MsgId_M3);
+    auto* msg = static_cast<const Msg3*>(msgPtr.get());
+    TS_ASSERT_EQUALS(msg->field_f1().currentField(), 2U);
+    TS_ASSERT(msg->field_f1().accessField_p3().field_v1().doesExist());
+    TS_ASSERT_EQUALS(msg->field_f1().accessField_p3().field_v1().field().value(), 1);
+    TS_ASSERT(msg->field_f1().accessField_p3().field_v2().doesExist());
+    TS_ASSERT_EQUALS(msg->field_f1().accessField_p3().field_v2().field().value(), 2);
+}