Saving work on <ref> field in commsdsl2wireshark.

Author: arobenko

app/commsdsl2wireshark/src/WiresharkField.cpp

@@ -132,17 +132,7 @@ bool WiresharkField::wiresharkPrepare()
 
 std::string WiresharkField::wiresharkDissectName(const WiresharkField* refField) const
 {
-    const auto* genField = &m_genField;
-    if (refField != nullptr) {
-        genField = &(refField->wiresharkGenField());
-    }
-
-    if (!genField->genIsReferenced()) {
-        return strings::genEmptyString();
-    }
-
-    auto& wiresharkGenerator = WiresharkGenerator::wiresharkCast(genField->genGenerator());
-    return wiresharkGenerator.wiresharkDissectNameFor(*genField);
+    return wiresharkDissectNameImpl(refField);
 }
 
 std::string WiresharkField::wiresharkDissectCode(const WiresharkField* refField) const
@@ -153,6 +143,7 @@ std::string WiresharkField::wiresharkDissectCode(const WiresharkField* refField)
     }
 
     if (!genField->genIsReferenced()) {
+        genField->genGenerator().genLogger().genDebug("Field " + genField->genName() + " is not really referenced, skipping dissect code generation");
         return strings::genEmptyString();
     }
 
@@ -199,19 +190,39 @@ std::string WiresharkField::wiresharkDissectCode(const WiresharkField* refField)
 }
 
 std::string WiresharkField::wiresharkFieldObjName(const WiresharkField* refField) const
+{
+    return wiresharkFieldObjNameImpl(refField);
+}
+
+std::string WiresharkField::wiresharkFieldRegistration(const WiresharkField* refField) const
+{
+    return wiresharkFieldRegistrationImpl(refField);
+}
+
+std::string WiresharkField::wiresharkDissectNameImpl(const WiresharkField* refField) const
 {
     const auto* genField = &m_genField;
     if (refField != nullptr) {
         genField = &(refField->wiresharkGenField());
     }
+
+    if (!genField->genIsReferenced()) {
+        return strings::genEmptyString();
+    }
+
     auto& wiresharkGenerator = WiresharkGenerator::wiresharkCast(genField->genGenerator());
-    auto scope = comms::genScopeFor(*genField, wiresharkGenerator, false);
-    return Wireshark::wiresharkProtocolObjName(wiresharkGenerator) + '_' + util::genStrReplace(scope, "::", "_");
+    return wiresharkGenerator.wiresharkDissectNameFor(*genField);
 }
 
-std::string WiresharkField::wiresharkFieldRegistration(const WiresharkField* refField) const
+std::string WiresharkField::wiresharkFieldObjNameImpl(const WiresharkField* refField) const
 {
-    return wiresharkFieldRegistrationImpl(refField);
+    const auto* genField = &m_genField;
+    if (refField != nullptr) {
+        genField = &(refField->wiresharkGenField());
+    }
+    auto& wiresharkGenerator = WiresharkGenerator::wiresharkCast(genField->genGenerator());
+    auto scope = comms::genScopeFor(*genField, wiresharkGenerator, false);
+    return Wireshark::wiresharkProtocolObjName(wiresharkGenerator) + '_' + util::genStrReplace(scope, "::", "_");
 }
 
 std::string WiresharkField::wiresharkFieldRegistrationImpl([[maybe_unused]] const WiresharkField* refField) const
@@ -236,6 +247,11 @@ std::string WiresharkField::wiresharkFieldRefName(const WiresharkField* refField
     return Wireshark::wiresharkProtocolObjName(wiresharkGenerator) + '.' + util::genStrReplace(scope, "::", ".");
 }
 
+bool WiresharkField::wiresharkIsBitfieldMember() const
+{
+    return wiresharkParentBitfieldInternal(*this) != nullptr;
+}
+
 std::string WiresharkField::wiresharkForcedIntegralFieldMask(const WiresharkField* refField) const
 {
     if (refField == nullptr) {
@@ -342,6 +358,14 @@ std::string WiresharkField::wiresharkFieldNameVarNameStr(const WiresharkField* r
     return wiresharkFieldObjName(refField) + strings::genNameSuffixStr();
 }
 
+bool WiresharkField::wiresharkHasOverrideCode() const
+{
+    return
+        m_customCode.m_hasRead ||
+        m_customCode.m_hasValid ||
+        m_customCode.m_hasName;
+}
+
 bool WiresharkField::wiresharkCopyCodeFromInternal()
 {
     auto obj = m_genField.genParseObj();

app/commsdsl2wireshark/src/WiresharkField.h

@@ -56,17 +56,21 @@ class WiresharkField
     std::string wiresharkFieldRegistration(const WiresharkField* refField) const;
 
 protected:
+    virtual std::string wiresharkDissectNameImpl(const WiresharkField* refField) const;
+    virtual std::string wiresharkFieldObjNameImpl(const WiresharkField* refField) const;
     virtual std::string wiresharkFieldRegistrationImpl(const WiresharkField* refField) const;
     virtual std::string wiresharkMembersDissectCodeImpl(const WiresharkField* refField) const;
 
     std::string wiresharkFieldRefName(const WiresharkField* refField) const;
+    bool wiresharkIsBitfieldMember() const;
     std::string wiresharkForcedIntegralFieldMask(const WiresharkField* refField) const;
     std::string wiresharkForcedIntegralFieldType(const WiresharkField* refField) const;
     unsigned wiresharkForcedMaskShift(const WiresharkField* refField) const;
     unsigned wiresharkForcedBitLength(const WiresharkField* refField) const;
     std::string wiresharkFieldDescriptionStr(const WiresharkField* refField) const;
     std::string wiresharkFieldDisplayNameStr(const WiresharkField* refField) const;
     std::string wiresharkFieldNameVarNameStr(const WiresharkField* refField) const;
+    bool wiresharkHasOverrideCode() const;
 
 private:
     using WiresharkCustomCodeFunc = std::string (WiresharkField::*)(bool& hasCode) const;

app/commsdsl2wireshark/src/WiresharkRefField.cpp

@@ -17,11 +17,34 @@
 
 #include "WiresharkGenerator.h"
 
+#include "commsdsl/gen/strings.h"
+
 #include <cassert>
+#include <functional>
+#include <tuple>
+
+namespace strings = commsdsl::gen::strings;
 
 namespace commsdsl2wireshark
 {
 
+namespace
+{
+
+[[nodiscard]] auto wiresharkParseObjAsTupleInternal(const WiresharkRefField::ParseField& parseObj)
+{
+    return
+        std::make_tuple(
+            std::cref(parseObj.parseName()),
+            std::cref(parseObj.parseDisplayName()),
+            std::cref(parseObj.parseDescription()),
+            parseObj.parseSemanticType(),
+            parseObj.parseIsPseudo(),
+            parseObj.parseIsFailOnInvalid());
+}
+
+} // namespace
+
 WiresharkRefField::WiresharkRefField(WiresharkGenerator& generator, ParseField parseObj, GenElem* parent) :
     GenBase(generator, parseObj, parent),
     WiresharkBase(static_cast<GenBase&>(*this))
@@ -38,18 +61,61 @@ bool WiresharkRefField::genPrepareImpl()
     m_wiresharkField = WiresharkField::wiresharkCast(genReferencedField());
     assert(m_wiresharkField != nullptr);
 
-    // TODO: copy vs alias
+    m_alias = wiresharkIsAliasInternal();
+
+    if (!m_alias) {
+        genGenerator().genLogger().genDebug(m_wiresharkField->wiresharkGenField().genParseObj().parseExternalRef() + " field is not really referenced by " + genName());
+        m_wiresharkField->wiresharkGenField().genSetReferenced(false);
+    }
     return true;
 }
 
+std::string WiresharkRefField::wiresharkDissectNameImpl(const WiresharkField* refField) const
+{
+    if (!m_alias) {
+        return WiresharkBase::wiresharkDissectNameImpl(refField);
+    }
+
+    assert(m_wiresharkField != nullptr);
+    return m_wiresharkField->wiresharkDissectName(refField);
+}
+
+std::string WiresharkRefField::wiresharkFieldObjNameImpl(const WiresharkField* refField) const
+{
+    if (!m_alias) {
+        return WiresharkBase::wiresharkFieldObjNameImpl(refField);
+    }
+
+    assert(m_wiresharkField != nullptr);
+    return m_wiresharkField->wiresharkFieldObjName(refField);
+}
+
 std::string WiresharkRefField::wiresharkFieldRegistrationImpl(const WiresharkField* refField) const
 {
+    assert(m_wiresharkField != nullptr);
+    if (m_alias) {
+        genGenerator().genLogger().genDebug(genName() + " field is full alias to " + m_wiresharkField->wiresharkGenField().genParseObj().parseExternalRef() + ", not generating registration");
+        return strings::genEmptyString();
+    }
+
     if (refField == nullptr) {
         refField = this;
     }
 
-    assert(m_wiresharkField != nullptr);
     return m_wiresharkField->wiresharkFieldRegistration(refField);
 }
 
+bool WiresharkRefField::wiresharkIsAliasInternal() const
+{
+    if (wiresharkIsBitfieldMember() ||
+        wiresharkHasOverrideCode()) {
+        return false;
+    }
+
+    assert(m_wiresharkField != nullptr);
+    auto& thisObj = wiresharkGenField().genParseObj();
+    auto& refObj = m_wiresharkField->wiresharkGenField().genParseObj();
+    return wiresharkParseObjAsTupleInternal(thisObj) == wiresharkParseObjAsTupleInternal(refObj);
+}
+
 } // namespace commsdsl2wireshark

app/commsdsl2wireshark/src/WiresharkRefField.h

@@ -37,10 +37,15 @@ class WiresharkRefField final : public commsdsl::gen::GenRefField, public Wiresh
 protected:
     virtual bool genPrepareImpl() override;
 
+    virtual std::string wiresharkDissectNameImpl(const WiresharkField* refField) const override;
+    virtual std::string wiresharkFieldObjNameImpl(const WiresharkField* refField) const override;
     virtual std::string wiresharkFieldRegistrationImpl(const WiresharkField* refField) const override;
 
 private:
-    const WiresharkField* m_wiresharkField = nullptr;
+    bool wiresharkIsAliasInternal() const;
+
+    WiresharkField* m_wiresharkField = nullptr;
+    bool m_alias = false;
 };
 
 } // namespace commsdsl2wireshark

lib/include/commsdsl/gen/GenBitfieldField.h

@@ -44,7 +44,7 @@ class COMMSDSL_API GenBitfieldField : public GenField
 
 protected:
     virtual bool genPrepareImpl() override;
-    virtual void genSetReferencedImpl() override;
+    virtual void genSetReferencedImpl(bool referenced) override;
     virtual GenFieldRefInfo genProcessInnerRefImpl(const std::string& refStr) const override final;
 
     ParseBitfieldField genBitfieldFieldParseObj() const;

lib/include/commsdsl/gen/GenBundleField.h

@@ -44,7 +44,7 @@ class COMMSDSL_API GenBundleField : public GenField
 
 protected:
     virtual bool genPrepareImpl() override;
-    virtual void genSetReferencedImpl() override;
+    virtual void genSetReferencedImpl(bool referenced) override;
     virtual GenFieldRefInfo genProcessInnerRefImpl(const std::string& refStr) const override final;
 
     ParseBundleField genBundleFieldParseObj() const;

lib/include/commsdsl/gen/GenDataField.h

@@ -48,7 +48,7 @@ class COMMSDSL_API GenDataField : public GenField
 
 protected:
     virtual bool genPrepareImpl() override;
-    virtual void genSetReferencedImpl() override;
+    virtual void genSetReferencedImpl(bool referenced) override;
 
     ParseDataField genDataFieldParseObj() const;
 

lib/include/commsdsl/gen/GenField.h

@@ -73,9 +73,9 @@ class COMMSDSL_API GenField : public GenElem
     const GenGenerator& genGenerator() const;
 
     bool genIsReferenced() const;
-    void genSetReferenced();
+    void genSetReferenced(bool referenced = true);
 
-    static void genSetFieldReferencedIfExists(GenField* field);
+    static void genSetFieldReferencedIfExists(GenField* field, bool referenced = true);
 
     std::string genTemplateScopeOfComms(const std::string& protOptionsStr) const;
 
@@ -90,7 +90,7 @@ class COMMSDSL_API GenField : public GenElem
     virtual GenType genElemTypeImpl() const override final;
     virtual bool genPrepareImpl();
     virtual bool genWriteImpl() const;
-    virtual void genSetReferencedImpl();
+    virtual void genSetReferencedImpl(bool referenced);
     virtual GenFieldRefInfo genProcessInnerRefImpl(const std::string& refStr) const;
 
 private:

lib/include/commsdsl/gen/GenListField.h

@@ -71,7 +71,7 @@ class COMMSDSL_API GenListField : public GenField
 
 protected:
     virtual bool genPrepareImpl() override;
-    virtual void genSetReferencedImpl() override;
+    virtual void genSetReferencedImpl(bool referenced) override;
 
     ParseListField genListFieldParseObj() const;
 

lib/include/commsdsl/gen/GenMessage.h

@@ -51,7 +51,7 @@ class COMMSDSL_API GenMessage : public GenElem
     bool genPrepare();
     bool genWrite() const;
     bool genIsReferenced() const;
-    void genSetReferenced(bool value);
+    void genSetReferenced(bool value = true);
 
     ParseMessage genParseObj() const;