Skip to content

Allow deprecating fields of interfaces #145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
InvincibleRMC wants to merge 2 commits into
base: rolling
Choose a base branch
from
+45 −2
Open

Allow deprecating fields of interfaces #145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4f1825
Add DISABLE_DEPRECATED_PUSH/POP
InvincibleRMC Mar 18, 2026
7f40162
Add C support
InvincibleRMC Mar 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions rosidl_typesupport_fastrtps_c/resource/msg__type_support_c.cpp.em
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,10 @@ def generate_member_for_cdr_serialize(member, suffix):
from rosidl_parser.definition import NamespacedType
strlist = []
strlist.append('// Field name: %s' % (member.name))

if (member.has_annotation('deprecated')):
strlist.append('DISABLE_DEPRECATED_PUSH')

strlist.append('{')

type_ = member.type
Expand Down Expand Up @@ -301,6 +305,9 @@ def generate_member_for_cdr_serialize(member, suffix):
strlist.append(' &ros_message->%s, cdr);' % (member.name))
strlist.append('}')

if (member.has_annotation('deprecated')):
strlist.append('DISABLE_DEPRECATED_POP')

return strlist
}@

Expand All @@ -325,6 +332,9 @@ bool cdr_deserialize_@('__'.join([package_name] + list(interface_path.parents[0]
{
@[for member in message.structure.members]@
// Field name: @(member.name)
@[ if member.has_annotation('deprecated')]@
DISABLE_DEPRECATED_PUSH
@[end if]@
{
@{
type_ = member.type
Expand Down Expand Up @@ -460,6 +470,9 @@ else:
cdr_deserialize_@('__'.join(member.type.namespaced_name()))(cdr, &ros_message->@(member.name));
@[ end if]@
}
@[ if member.has_annotation('deprecated')]@
DISABLE_DEPRECATED_POP
@[end if]@

@[end for]@
return true;
Expand All @@ -485,6 +498,10 @@ def generate_member_for_get_serialized_size(member, suffix):
from rosidl_parser.definition import NamespacedType
strlist = []
strlist.append('// Field name: %s' % (member.name))

if (member.has_annotation('deprecated')):
strlist.append('DISABLE_DEPRECATED_PUSH')

if isinstance(member.type, AbstractNestedType):
strlist.append('{')
if isinstance(member.type, Array):
Expand Down Expand Up @@ -530,6 +547,10 @@ def generate_member_for_get_serialized_size(member, suffix):
else:
strlist.append('current_alignment += get_serialized_size%s_%s(' % (suffix, ('__'.join(member.type.namespaced_name()))))
strlist.append(' &(ros_message->%s), current_alignment);' % (member.name))

if (member.has_annotation('deprecated')):
strlist.append('DISABLE_DEPRECATED_POP')

return strlist
}@

Expand Down
26 changes: 24 additions & 2 deletions rosidl_typesupport_fastrtps_cpp/resource/msg__type_support.cpp.em
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,11 @@ def generate_member_for_cdr_serialize(member, suffix):
from rosidl_parser.definition import NamespacedType
strlist = []
strlist.append('// Member: %s' % (member.name))

if member.has_annotation('deprecated'):
strlist.append('// *INDENT-OFF*')
strlist.append('DISABLE_DEPRECATED_PUSH')

if isinstance(member.type, AbstractNestedType):
strlist.append('{')
if isinstance(member.type, Array):
Expand Down Expand Up @@ -181,6 +186,11 @@ def generate_member_for_cdr_serialize(member, suffix):
strlist.append('%s::typesupport_fastrtps_cpp::cdr_serialize%s(' % (('::'.join(member.type.namespaces)), suffix))
strlist.append(' ros_message.%s,' % (member.name))
strlist.append(' cdr);')

if member.has_annotation('deprecated'):
strlist.append('DISABLE_DEPRECATED_POP')
strlist.append('// *INDENT-ON*')

return strlist
}@

Expand All @@ -207,6 +217,10 @@ cdr_deserialize(
{
@[for member in message.structure.members]@
// Member: @(member.name)
@[ if member.has_annotation('deprecated')]@
// *INDENT-OFF*
DISABLE_DEPRECATED_PUSH
@[ end if]
@[ if isinstance(member.type, AbstractNestedType)]@
{
@[ if isinstance(member.type, Array)]@
Expand Down Expand Up @@ -302,7 +316,10 @@ cdr_deserialize(
@('::'.join(member.type.namespaces))::typesupport_fastrtps_cpp::cdr_deserialize(
cdr, ros_message.@(member.name));
@[ end if]@

@[ if member.has_annotation('deprecated')]@
DISABLE_DEPRECATED_POP
// *INDENT-ON*
@[ end if]
@[end for]@
return true;
} // NOLINT(readability/fn_size)
Expand All @@ -327,6 +344,9 @@ def generate_member_for_get_serialized_size(member, suffix):
strlist = []
strlist.append('// Member: %s' % (member.name))

if member.has_annotation('deprecated'):
strlist.append('DISABLE_DEPRECATED_PUSH')

if isinstance(member.type, AbstractNestedType):
strlist.append('{')
if isinstance(member.type, Array):
Expand Down Expand Up @@ -376,6 +396,9 @@ def generate_member_for_get_serialized_size(member, suffix):
strlist.append(' %s::typesupport_fastrtps_cpp::get_serialized_size%s(' % (('::'.join(member.type.namespaces)), suffix))
strlist.append(' ros_message.%s, current_alignment);' % (member.name))

if member.has_annotation('deprecated'):
strlist.append('DISABLE_DEPRECATED_POP')

return strlist;
}@

Expand Down Expand Up @@ -421,7 +444,6 @@ def generate_member_for_max_serialized_size(member, suffix):
strlist = []
strlist.append('// Member: %s' % (member.name))
strlist.append('{')

if isinstance(member.type, AbstractNestedType):
if isinstance(member.type, Array):
strlist.append(' size_t array_size = %d;' % (member.type.size))
Expand Down