Feature: topic keys (#3)

* Refs #20156: Add is_key_ field to identify member as key Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #20156: Add has_any_member_with_annotation() method for a struct Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #20310: Define v2 ABI identifier Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #20310: Update Message introspection with a new static key_members_array in the parent messagemembers Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #20310: Review suggestions Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #20310: NITs Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> --------- Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
eProsima · Mar 6, 2024 · 28a73d3 · 28a73d3
1 parent 995917e
commit 28a73d3
Show file tree

Hide file tree

Showing 9 changed files with 66 additions and 4 deletions.
diff --git a/rosidl_parser/rosidl_parser/definition.py b/rosidl_parser/rosidl_parser/definition.py
@@ -508,6 +508,15 @@ def __init__(self, namespaced_type: NamespacedType, members=None):
         self.namespaced_type = namespaced_type
         self.members = members or []
 
+    def has_any_member_with_annotation(self, name: str):
+        """
+        Returns whether any member has a particular annotation.
+
+        :param name: the annotation name
+        """
+        has_any = [member.name for member in self.members if member.has_annotation(name)]
+        return bool(has_any)
+
 
 class Include:
     """An include statement."""

diff --git a/rosidl_typesupport_introspection_c/include/rosidl_typesupport_introspection_c/identifier.h b/rosidl_typesupport_introspection_c/include/rosidl_typesupport_introspection_c/identifier.h
@@ -26,6 +26,10 @@ extern "C"
 ROSIDL_TYPESUPPORT_INTROSPECTION_C_PUBLIC
 extern const char * rosidl_typesupport_introspection_c__identifier;
 
+/// String identifying the typesupport introspection implementation in use.
+ROSIDL_TYPESUPPORT_INTROSPECTION_C_PUBLIC
+extern const char * rosidl_typesupport_introspection_c__identifier_v2;
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/...upport_introspection_c/include/rosidl_typesupport_introspection_c/message_introspection.h b/...upport_introspection_c/include/rosidl_typesupport_introspection_c/message_introspection.h
@@ -96,6 +96,8 @@ typedef struct rosidl_typesupport_introspection_c__MessageMembers_s
   void (* init_function)(void *, enum rosidl_runtime_c__message_initialization);
   /// The function used to clean up the interface's in-memory representation
   void (* fini_function)(void *);
+  /// A pointer to the array that indicates whether each field is annotated as @key
+  const bool * key_members_array_;
 } rosidl_typesupport_introspection_c__MessageMembers;
 
 #endif  // ROSIDL_TYPESUPPORT_INTROSPECTION_C__MESSAGE_INTROSPECTION_H_
diff --git a/rosidl_typesupport_introspection_c/resource/msg__type_support.c.em b/rosidl_typesupport_introspection_c/resource/msg__type_support.c.em
@@ -201,6 +201,23 @@ bool @(function_prefix)__resize_function__@(message.structure.namespaced_type.na
 @[    end if]@
 @[  end if]@
 @[end for]@
+
+static bool @(function_prefix)__@(message.structure.namespaced_type.name)_key_members_array[@(len(message.structure.members))] = {
+@{
+for index, member in enumerate(message.structure.members):
+  if member.has_annotation('key'):
+    if index < len(message.structure.members) - 1:
+        print('  true,')
+    else:
+        print('  true')
+  else:
+    if index < len(message.structure.members) - 1:
+        print('  false,')
+    else:
+        print('  false')
+}@
+};
+
 static rosidl_typesupport_introspection_c__MessageMember @(function_prefix)__@(message.structure.namespaced_type.name)_message_member_array[@(len(message.structure.members))] = {
 @{
 for index, member in enumerate(message.structure.members):
@@ -278,7 +295,8 @@ static const rosidl_typesupport_introspection_c__MessageMembers @(function_prefi
   sizeof(@('__'.join([package_name] + list(interface_path.parents[0].parts) + [message.structure.namespaced_type.name]))),
   @(function_prefix)__@(message.structure.namespaced_type.name)_message_member_array,  // message members
   @(function_prefix)__@(message.structure.namespaced_type.name)_init_function,  // function to initialize message memory (memory has to be allocated)
-  @(function_prefix)__@(message.structure.namespaced_type.name)_fini_function  // function to terminate message instance (will not free memory)
+  @(function_prefix)__@(message.structure.namespaced_type.name)_fini_function,  // function to terminate message instance (will not free memory)
+  @(function_prefix)__@(message.structure.namespaced_type.name)_key_members_array // mapping to each field to know whether it is keyed or not
 };
 
 // this is not const since it must be initialized on first access
@@ -308,7 +326,7 @@ if isinstance(type_, AbstractNestedType):
 @[end for]@
   if (!@(function_prefix)__@(message.structure.namespaced_type.name)_message_type_support_handle.typesupport_identifier) {
     @(function_prefix)__@(message.structure.namespaced_type.name)_message_type_support_handle.typesupport_identifier =
-      rosidl_typesupport_introspection_c__identifier;
+      rosidl_typesupport_introspection_c__identifier_v2;
   }
   return &@(function_prefix)__@(message.structure.namespaced_type.name)_message_type_support_handle;
 }

diff --git a/rosidl_typesupport_introspection_c/src/identifier.c b/rosidl_typesupport_introspection_c/src/identifier.c
@@ -15,3 +15,4 @@
 #include "rosidl_typesupport_introspection_c/identifier.h"
 
 const char * rosidl_typesupport_introspection_c__identifier = "rosidl_typesupport_introspection_c";
+const char * rosidl_typesupport_introspection_c__identifier_v2 = "rosidl_typesupport_introspection_c_v2";
diff --git a/...typesupport_introspection_cpp/include/rosidl_typesupport_introspection_cpp/identifier.hpp b/...typesupport_introspection_cpp/include/rosidl_typesupport_introspection_cpp/identifier.hpp
@@ -24,6 +24,10 @@ namespace rosidl_typesupport_introspection_cpp
 ROSIDL_TYPESUPPORT_INTROSPECTION_CPP_IMPORT
 extern const char * typesupport_identifier;
 
+/// String identifying the typesupport introspection implementation in use.
+ROSIDL_TYPESUPPORT_INTROSPECTION_CPP_IMPORT
+extern const char * typesupport_identifier_v2;
+
 }  // namespace rosidl_typesupport_introspection_cpp
 
 #endif  // ROSIDL_TYPESUPPORT_INTROSPECTION_CPP__IDENTIFIER_HPP_
diff --git a/..._introspection_cpp/include/rosidl_typesupport_introspection_cpp/message_introspection.hpp b/..._introspection_cpp/include/rosidl_typesupport_introspection_cpp/message_introspection.hpp
@@ -103,6 +103,8 @@ typedef struct ROSIDL_TYPESUPPORT_INTROSPECTION_CPP_PUBLIC MessageMembers_s
   void (* init_function)(void *, rosidl_runtime_cpp::MessageInitialization);
   /// The function used to clean up the interface's in-memory representation
   void (* fini_function)(void *);
+  /// A pointer to the array that indicates whether each field is annotated as @key
+  const bool * key_members_array_;
 } MessageMembers;
 
 }  // namespace rosidl_typesupport_introspection_cpp

diff --git a/rosidl_typesupport_introspection_cpp/resource/msg__type_support.cpp.em b/rosidl_typesupport_introspection_cpp/resource/msg__type_support.cpp.em
@@ -167,6 +167,23 @@ void resize_function__@(message.structure.namespaced_type.name)__@(member.name)(
 @[    end if]@
 @[  end if]@
 @[end for]@
+
+static const bool @(message.structure.namespaced_type.name)_key_members_array[@(len(message.structure.members))] = {
+@{
+for index, member in enumerate(message.structure.members):
+  if member.has_annotation('key'):
+    if index < len(message.structure.members) - 1:
+        print('  true,')
+    else:
+        print('  true')
+  else:
+    if index < len(message.structure.members) - 1:
+        print('  false,')
+    else:
+        print('  false')
+}@
+};
+
 static const ::rosidl_typesupport_introspection_cpp::MessageMember @(message.structure.namespaced_type.name)_message_member_array[@(len(message.structure.members))] = {
 @{
 for index, member in enumerate(message.structure.members):
@@ -244,11 +261,12 @@ static const ::rosidl_typesupport_introspection_cpp::MessageMembers @(message.st
   sizeof(@('::'.join([package_name] + list(interface_path.parents[0].parts) + [message.structure.namespaced_type.name]))),
   @(message.structure.namespaced_type.name)_message_member_array,  // message members
   @(message.structure.namespaced_type.name)_init_function,  // function to initialize message memory (memory has to be allocated)
-  @(message.structure.namespaced_type.name)_fini_function  // function to terminate message instance (will not free memory)
+  @(message.structure.namespaced_type.name)_fini_function,  // function to terminate message instance (will not free memory)
+  @(message.structure.namespaced_type.name)_key_members_array // mapping to each field to know whether it is keyed or not
 };
 
 static const rosidl_message_type_support_t @(message.structure.namespaced_type.name)_message_type_support_handle = {
-  ::rosidl_typesupport_introspection_cpp::typesupport_identifier,
+  ::rosidl_typesupport_introspection_cpp::typesupport_identifier_v2,
   &@(message.structure.namespaced_type.name)_message_members,
   get_message_typesupport_handle_function,
   &@(idl_structure_type_to_c_typename(message.structure.namespaced_type))__@(GET_HASH_FUNC),

diff --git a/rosidl_typesupport_introspection_cpp/src/identifier.cpp b/rosidl_typesupport_introspection_cpp/src/identifier.cpp
@@ -20,4 +20,8 @@ namespace rosidl_typesupport_introspection_cpp
 ROSIDL_TYPESUPPORT_INTROSPECTION_CPP_EXPORT
 const char * typesupport_identifier = "rosidl_typesupport_introspection_cpp";
 
+
+ROSIDL_TYPESUPPORT_INTROSPECTION_CPP_EXPORT
+const char * typesupport_identifier_v2 = "rosidl_typesupport_introspection_cpp_v2";
+
 }  // namespace rosidl_typesupport_introspection_cpp