gazebosim/sdformat

Changes to sdf::ParamPrivate should not break ABI

Open

#773 opened on Dec 6, 2021

View on GitHub
 (0 comments) (1 reaction) (0 assignees)C++ (122 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (216 stars)
PR merge metrics
 (PR metrics pending)

Description

Desired behavior

Per the Pimpl idiom, one would expect changes to the sdf::ParamPrivate class to not break ABI, but since the class is in a public header (Param.h) and since it's members are used in function templates of sdf::Param, any changes made to sdf::ParamPrivate could break ABI.

This is similar to https://github.com/ignitionrobotics/sdformat/issues/607

Alternatives considered

n/a

Implementation suggestion

Provide accessor functions in sdf::Param so that the function templates do not need direct access to dataPtr. Then we can move sdf::ParamPrivate to Param.cc. This would be a breaking change, so it will have to target the main branch.

Contributor guide

Research direction
Analyze current usage of sdf::ParamPrivate in sdf::Param function templates. Design accessor functions to encapsulate dataPtr access. Then move sdf::ParamPrivate definition to Param.cc and update includes accordingly.
Tech stack
cpp
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++Pimpl idiom
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40