gazebosim/sdformat

Changes to sdf::ParamPrivate should not break ABI

Ouverte

#773 ouverte le 6 déc. 2021

Voir sur GitHubGuide contributeur
 (0 commentaire) (1 réaction) (0 personne assignée)C++ (122 forks)auto 404
enhancementhelp wanted

Métriques du dépôt

Stars
 (216 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur

Direction de recherche
Analysez l'utilisation actuelle de sdf::ParamPrivate dans les modèles de fonction de sdf::Param. Concevez des fonctions d'accès pour encapsuler l'accès à dataPtr. Déplacez ensuite la définition de sdf::ParamPrivate vers Param.cc et mettez à jour les inclusions en conséquence.
Stack technique
cpp
Domaine
backend
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C++Pimpl idiom
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40