gazebosim/sdformat

Changes to sdf::ParamPrivate should not break ABI

Aperta

#773 aperta il 6 dic 2021

Vedi su GitHubGuida contributor
 (0 commenti) (1 reazione) (0 assegnatari)C++ (122 fork)auto 404
enhancementhelp wanted

Metriche repository

Star
 (216 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Analizza l'uso corrente di sdf::ParamPrivate nei template di funzione di sdf::Param. Progetta funzioni di accesso per incapsulare l'accesso a dataPtr. Quindi sposta la definizione di sdf::ParamPrivate in Param.cc e aggiorna gli include di conseguenza.
Tech stack
cpp
Dominio
backend
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
C++Pimpl idiom
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40