gazebosim/sdformat

Changes to sdf::ParamPrivate should not break ABI

Aberta

#773 aberto em 6 de dez. de 2021

Ver no GitHubGuia do colaborador
 (0 comentário) (1 reação) (0 responsável)C++ (122 forks)auto 404
enhancementhelp wanted

Métricas do repositório

Stars
 (216 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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.

Guia do colaborador

Direção de pesquisa
Analise o uso atual de sdf::ParamPrivate nos templates de função de sdf::Param. Projete funções de acesso para encapsular o acesso a dataPtr. Em seguida, mova a definição de sdf::ParamPrivate para Param.cc e atualize os includes adequadamente.
Pilha de tecnologia
cpp
Domain
backend
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
C++Pimpl idiom
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40