Tick-tock Export Headers #249
Conversation
methylDragon
force-pushed
the
ch3/export-tick-tock
branch
2 times, most recently
from
62e26f8
to
5f72b77
Compare
|
Should I just make every |
methylDragon
force-pushed
the
ch3/export-tick-tock
branch
3 times, most recently
from
815e592
to
d0c212a
Compare
I decided to do that. 20748d4 Note that this means every |
methylDragon
force-pushed
the
ch3/export-tick-tock
branch
2 times, most recently
from
f0a0d22
to
20748d4
Compare
| #ifndef IGN_DEPRECATED | ||
| // TODO(CH3): Remove on ticktock | ||
| // NOTE(CH3): This has no docstring since we'll make GZ_DEPRECATED the default | ||
| #define IGN_DEPRECATED(version) GZ_DEPRECATED_ALL_VERSIONS |
There was a problem hiding this comment.
do we want to define IGNITION_ versions of _VISIBLE and _HIDDEN as well?
if so, we should create an ign_export_base variable to use when configuring this file
There was a problem hiding this comment.
They're defined in here already, using the _ign_export_base variable! 👀
There was a problem hiding this comment.
Created and populated here: https://github.com/ignitionrobotics/ign-cmake/pull/249/files#diff-955d1f97e2360702839ba9277cc71b9797e65d417d5cb88f383fec0e53ad5124R1447 right above the configure call
There was a problem hiding this comment.
thanks; I could have done a better job reading the pull request changes before making comments like that. I was a little confused on first glance to see all the Doxygen for the redirection macros; I think we could remove them. See my suggested changes in ee17946
There was a problem hiding this comment.
Changes incorporated!
Signed-off-by: methylDragon <[email protected]>
Signed-off-by: methylDragon <[email protected]>
Signed-off-by: methylDragon <[email protected]>
Signed-off-by: Steve Peters <[email protected]>
methylDragon
force-pushed
the
ch3/export-tick-tock
branch
from
64bad56
to
fb53df0
Compare
Signed-off-by: methylDragon <[email protected]>
This is related to: gazebo-tooling/release-tools#711
Description
ign-cmakedynamically configures anExport.hhfile in the public headers of a package. ThisExport.hhfile actually wraps and comments on a lower level dynamically generateddetail/Export.hhfile that is generated using GenerateExportHeader.The fact we're using an external CMake library to generate the
detail/Export.hhmakes it hard to ticktock the lower-level CMake macros.So instead, this PR definesIGNITION_prefixed export headers in the configuredExport.hhif a target is prefixed withgzthat allow downstream users to use theIGNITION_prefixed versions of the export macros, while leaving those indetail/Export.hhalone (except forIGN_DEPRECATED_ALL_VERSIONS, which doesn't seem to be used anywhere (at least in the core libraries.)If the library target isignitionprefixed, then no extra macros generate.This PR replaces all
IGNITION_/IGN_prefixed macros withGZ_prefixed versions inExport.hhanddetail/Export.hh. And provisionsIGNITION_prefixed and theIGN_DEPRECATEDmacros in the publicExport.hhalongside theGZ_ones, so you can use both!This means that
detail/Export.hhdefined macros aren't tick-tocked though! But since they're ostensibly private, it shouldn't be an issue.Notes
This does nothing new at the moment, but once we start using GZ prefixed macro names, everything will be 🌞 🌈 because of this.