Merge pull request OpenDDS#3766 from jwillemsen/jwi-ddsxtypesextended

mitza-oci · web-flow · commit 78332f891b2a · 2022-10-10T16:27:28.000-05:00
Test and fix for problem with appendable types and additional written fields
diff --git a/dds/idl/marshal_generator.cpp b/dds/idl/marshal_generator.cpp
@@ -2777,6 +2777,11 @@ namespace {
       be_global->impl_ <<
         "  const Encoding& encoding = strm.encoding();\n"
         "  ACE_UNUSED_ARG(encoding);\n";
+      if (is_appendable) {
+        be_global->impl_ <<
+          "  bool reached_end_of_struct = false;\n"
+          "  ACE_UNUSED_ARG(reached_end_of_struct);\n";
+      }
       marshal_generator::generate_dheader_code(
         "    if (!strm.read_delimiter(total_size)) {\n"
         "      return false;\n"
@@ -2805,16 +2810,14 @@ namespace {
         * to read a non-existent member id.
         */
         be_global->impl_ <<
-          "      if (encoding.xcdr_version() == Encoding::XCDR_VERSION_2 &&\n"
-          "            strm.rpos() >= end_of_struct) {\n"
+          "      if (encoding.xcdr_version() == Encoding::XCDR_VERSION_2 && strm.rpos() >= end_of_struct) {\n"
           "        return true;\n"
           "      }\n"
           "      bool must_understand = false;\n"
           "      if (!strm.read_parameter_id(member_id, field_size, must_understand)) {\n"
           "        return false;\n"
           "      }\n"
-          "      if (encoding.xcdr_version() == Encoding::XCDR_VERSION_1 &&\n"
-          "            member_id == Serializer::pid_list_end) {\n"
+          "      if (encoding.xcdr_version() == Encoding::XCDR_VERSION_1 && member_id == Serializer::pid_list_end) {\n"
           "        return true;\n"
           "      }\n"
           "      const size_t end_of_field = strm.rpos() + field_size;\n"
@@ -2930,14 +2933,9 @@ namespace {
         if (expr.size() && exten != extensibilitykind_appendable) {
           expr += "\n    && ";
         }
-        // TODO (sonndinh): Integrate with try-construct for when the stream
-        // ends before some fields on the reader side get their values.
         if (is_appendable) {
           expr +=
-            "  if (encoding.xcdr_version() == Encoding::XCDR_VERSION_2 &&\n"
-            "      strm.rpos() >= end_of_struct) {\n"
-            "    return true;\n"
-            "  }\n";
+            "  reached_end_of_struct |= (encoding.xcdr_version() == Encoding::XCDR_VERSION_2 && strm.rpos() >= end_of_struct);\n";
         }
         const string field_name = field->local_name()->get_string();
         const string cond = rtpsCustom.getConditional(field_name);
@@ -2956,23 +2954,35 @@ namespace {
             expr += prefix + "(!(" + cond + ") || ";
           }
         } else if (is_appendable) {
-          expr += "  if (!";
+          AST_Type* const type = field->field_type();
+          string stru_field_name = "stru" + value_access + "." + field_name;
+          if (use_cxx11) {
+            stru_field_name += "()";
+          }
+          expr +=
+            "  if (reached_end_of_struct) {\n" +
+            type_to_default("    ", type, stru_field_name, type->anonymous()) +
+            "  } else {\n"
+            "    if (!";
         }
         expr += generate_field_stream(
           indent, field, ">> stru" + value_access, wrap_nested_key_only, intro);
         if (is_appendable) {
           expr += ") {\n"
-            "    return false;\n"
+            "      return false;\n"
+            "    }\n";
+          if (cond.empty()) {
+            expr +=
             "  }\n";
+          }
         } else if (!cond.empty()) {
           expr += ")";
         }
       }
       intro.join(be_global->impl_, indent);
       if (is_appendable) {
         expr +=
-          "  if (encoding.xcdr_version() == Encoding::XCDR_VERSION_2 &&\n"
-          "      strm.rpos() < end_of_struct) {\n"
+          "  if (encoding.xcdr_version() == Encoding::XCDR_VERSION_2 && strm.rpos() < end_of_struct) {\n"
           "    strm.skip(end_of_struct - strm.rpos());\n"
           "  }\n"
           "  return true;\n";
diff --git a/tests/DCPS/XTypes/Publisher.cpp b/tests/DCPS/XTypes/Publisher.cpp
@@ -92,6 +92,23 @@ void write_additional_prefix_field_struct(const DataWriter_var& dw)
   }
 }
 
+void write_base_appendable_struct(const DataWriter_var& dw)
+{
+  BaseAppendableStructDataWriter_var typed_dw = BaseAppendableStructDataWriter::_narrow(dw);
+
+  BaseAppendableStruct bas;
+  bas.key_field = key_value;
+
+  const ReturnCode_t ret = typed_dw->write(bas, HANDLE_NIL);
+  if (ret != RETCODE_OK) {
+    ACE_ERROR((LM_ERROR, "ERROR: write_base_appendable_struct returned %C\n",
+               OpenDDS::DCPS::retcode_to_string(ret)));
+  }
+  if (verbose) {
+    ACE_DEBUG((LM_DEBUG, "writer: BaseAppendableStruct\n"));
+  }
+}
+
 void write_additional_postfix_field_struct(const DataWriter_var& dw)
 {
   AdditionalPostfixFieldStructDataWriter_var typed_dw = AdditionalPostfixFieldStructDataWriter::_narrow(dw);
@@ -307,6 +324,9 @@ int ACE_TMAIN(int argc, ACE_TCHAR* argv[])
   } else if (type == "ModifiedFinalStruct") {
     ModifiedFinalStructTypeSupport_var ts = new ModifiedFinalStructTypeSupportImpl;
     failed = !get_topic(ts, dp, topic_name, topic, registered_type_name);
+  } else if (type == "BaseAppendableStruct") {
+    BaseAppendableStructTypeSupport_var ts = new BaseAppendableStructTypeSupportImpl;
+    failed = !get_topic(ts, dp, topic_name, topic, registered_type_name);
   } else if (type == "AppendableStructNoXTypes") {
     AppendableStructNoXTypesTypeSupport_var ts = new AppendableStructNoXTypesTypeSupportImpl;
     failed = !get_topic(ts, dp, topic_name, topic, registered_type_name);
@@ -484,6 +504,8 @@ int ACE_TMAIN(int argc, ACE_TCHAR* argv[])
       write_final_struct(dw);
     } else if (type == "ModifiedFinalStruct") {
       write_modified_final_struct(dw);
+    } else if (type == "BaseAppendableStruct") {
+      write_base_appendable_struct(dw);
     } else if (type == "AppendableStructNoXTypes") {
       write_appendable_struct_no_xtypes(dw);
     } else if (type == "AdditionalPrefixFieldStruct") {
diff --git a/tests/DCPS/XTypes/Publisher.idl b/tests/DCPS/XTypes/Publisher.idl
@@ -15,6 +15,12 @@ struct ModifiedFinalStruct {
 };
 
 // Appendable structures
+@topic
+@appendable
+struct BaseAppendableStruct {
+  @key long key_field;
+};
+
 @topic
 @appendable
 struct AdditionalPostfixFieldStruct {
diff --git a/tests/DCPS/XTypes/Subscriber.cpp b/tests/DCPS/XTypes/Subscriber.cpp
@@ -22,8 +22,8 @@ template<typename T1, typename T2>
 ReturnCode_t read_tryconstruct_struct(const DataReader_var& dr, const T1& pdr, T2& data,
                                       const std::string& expected_value)
 {
-  ReturnCode_t ret = RETCODE_OK;
-  if ((ret = read_i(dr, pdr, data)) == RETCODE_OK) {
+  ReturnCode_t ret = read_i(dr, pdr, data);
+  if (ret == RETCODE_OK) {
     if (data.length() != 1) {
       ACE_ERROR((LM_ERROR, "ERROR: reader: unexpected data length: %d\n", data.length()));
       ret = RETCODE_ERROR;
@@ -45,8 +45,8 @@ ReturnCode_t read_tryconstruct_struct(const DataReader_var& dr, const T1& pdr, T
 template<typename T1, typename T2>
 ReturnCode_t read_struct(const DataReader_var& dr, const T1& pdr, T2& data)
 {
-  ReturnCode_t ret = RETCODE_OK;
-  if ((ret = read_i(dr, pdr, data)) == RETCODE_OK) {
+  ReturnCode_t ret = read_i(dr, pdr, data);
+  if (ret == RETCODE_OK) {
     if (data.length() != 1) {
       ACE_ERROR((LM_ERROR, "reader: unexpected data length: %d\n", data.length()));
       ret = RETCODE_ERROR;
@@ -64,11 +64,36 @@ ReturnCode_t read_struct(const DataReader_var& dr, const T1& pdr, T2& data)
   return ret;
 }
 
+template<typename T1, typename T2>
+ReturnCode_t read_extended_struct(const DataReader_var& dr, const T1& pdr, T2& data)
+{
+  ReturnCode_t ret = read_i(dr, pdr, data);
+  if (ret == RETCODE_OK) {
+    if (data.length() != 1) {
+      ACE_ERROR((LM_ERROR, "reader: unexpected data length: %d\n", data.length()));
+      ret = RETCODE_ERROR;
+    } else if (data[0].key_field != key_value) {
+      ACE_ERROR((LM_ERROR, "reader: expected key value: %d, received: %d\n", key_value, data[0].key_field));
+      ret = RETCODE_ERROR;
+    } else if (data[0].additional_field != 0) {
+      ACE_ERROR((LM_ERROR, "reader: expected additional_field: %d, received: %d\n", 0, data[0].additional_field));
+      ret = RETCODE_ERROR;
+    } else if (verbose) {
+      ACE_DEBUG((LM_DEBUG, "reader: %d additional_field: %d\n", data[0].key_field, data[0].additional_field));
+    }
+  } else {
+    ACE_ERROR((LM_ERROR, "ERROR: Reader: read_i returned %C\n",
+               OpenDDS::DCPS::retcode_to_string(ret)));
+  }
+
+  return ret;
+}
+
 template<typename T1, typename T2>
 ReturnCode_t read_union(const DataReader_var& dr, const T1& pdr, T2& data)
 {
-  ReturnCode_t ret = RETCODE_OK;
-  if ((ret = read_i(dr, pdr, data)) == RETCODE_OK) {
+  ReturnCode_t ret = read_i(dr, pdr, data);
+  if (ret == RETCODE_OK) {
     if (data.length() != 1) {
       ACE_ERROR((LM_ERROR, "reader: unexpected data length: %d\n", data.length()));
       ret = RETCODE_ERROR;
@@ -128,6 +153,13 @@ ReturnCode_t read_appendable_struct(const DataReader_var& dr)
   return read_struct(dr, pdr, data);
 }
 
+ReturnCode_t read_extended_appendable_struct(const DataReader_var& dr)
+{
+  ExtendedAppendableStructDataReader_var pdr = ExtendedAppendableStructDataReader::_narrow(dr);
+  ::ExtendedAppendableStructSeq data;
+  return read_extended_struct(dr, pdr, data);
+}
+
 ReturnCode_t read_appendable_struct_no_xtypes(const DataReader_var& dr)
 {
   AppendableStructNoXTypesDataReader_var pdr = AppendableStructNoXTypesDataReader::_narrow(dr);
@@ -250,6 +282,9 @@ int ACE_TMAIN(int argc, ACE_TCHAR* argv[])
   } else if (type == "AppendableStruct") {
     AppendableStructTypeSupport_var ts = new AppendableStructTypeSupportImpl;
     failed = !get_topic(ts, dp, topic_name, topic, registered_type_name);
+  } else if (type == "ExtendedAppendableStruct") {
+    ExtendedAppendableStructTypeSupport_var ts = new ExtendedAppendableStructTypeSupportImpl;
+    failed = !get_topic(ts, dp, topic_name, topic, registered_type_name);
   } else if (type == "AppendableStructNoXTypes") {
     AppendableStructNoXTypesTypeSupport_var ts = new AppendableStructNoXTypesTypeSupportImpl;
     failed = !get_topic(ts, dp, topic_name, topic, registered_type_name);
@@ -402,6 +437,8 @@ int ACE_TMAIN(int argc, ACE_TCHAR* argv[])
       failed = (read_plain_cdr_struct(dr) != RETCODE_OK);
     } else if (type == "AppendableStruct") {
       failed = (read_appendable_struct(dr) != RETCODE_OK);
+    } else if (type == "ExtendedAppendableStruct") {
+      failed = (read_extended_appendable_struct(dr) != RETCODE_OK);
     } else if (type == "AppendableStructNoXTypes") {
       failed = (read_appendable_struct_no_xtypes(dr) != RETCODE_OK);
     } else if (type == "FinalStructSub") {
diff --git a/tests/DCPS/XTypes/Subscriber.idl b/tests/DCPS/XTypes/Subscriber.idl
@@ -14,6 +14,14 @@ struct AppendableStruct {
   @key long key_field;
 };
 
+@topic
+@appendable
+struct ExtendedAppendableStruct {
+  @key long key_field;
+  long additional_field;
+};
+
+
 // Mutable structures
 @topic
 @mutable
diff --git a/tests/DCPS/XTypes/run_test.pl b/tests/DCPS/XTypes/run_test.pl
@@ -120,6 +120,11 @@
       expect_inconsistent_topic => 0, topic => "AppendableStructT", key_val => 4,
       r_ini => "rtps_disc.ini", w_ini => "rtps_disc.ini",
     },
+    "ExtendedAppendableMatch" => {
+      reader_type => "ExtendedAppendableStruct", writer_type => "BaseAppendableStruct",
+      expect_inconsistent_topic => 0, topic => "AppendableStructT", key_val => 4,
+      r_ini => "rtps_disc.ini", w_ini => "rtps_disc.ini",
+    },
     "AppendableNoMatch" => {
       reader_type => "AppendableStruct", writer_type => "AdditionalPrefixFieldStruct",
       expect_inconsistent_topic => 1, topic => "AppendableStructT_NoMatch", key_val => 5,
