Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Macros from IGN to GZ #737

Closed
Tracked by #698
methylDragon opened this issue Jun 6, 2022 · 0 comments
Closed
Tracked by #698

Macros from IGN to GZ #737

methylDragon opened this issue Jun 6, 2022 · 0 comments
Labels
ign to gz Renaming Ignition to Gazebo.

Comments

@methylDragon
Copy link
Contributor

methylDragon commented Jun 6, 2022 •
edited
Loading

Macros prefixed with IGN or IGNITION to start with GZ. Don't use GAZEBO, always GZ for consistency.
Also, use IGNITION_GAZEBO -> GZ_SIM!!!

Warnings

  • Some of these are based off the env_var_migration branch, so the environment variable migrations should be merged first
  • These need to be merged in topological order!

Notes

  • This list might not be exhaustive... but I'll try to catch them all.

  • How do we emit deprecation warnings...

    • Maybe place the tick-tocks in the redirection headers only and rely on the overarching deprecation warning rather than macro-specific ones?

  • The config.hh macros (_MAJOR_VERSION, _MINOR_VERSION, etc.) are not mentioned here, since they're really repetitive, and are already tick-tocked

  • Test-local and src local macros will be hard-tocked

  • Macro tick-tocks will occur in the ignition redirection headers, on a best effort basis

  • SuppressWarning.hh files that state that they're deprecated will not have their macros tick-tocked

Macros to Migrate

(The ticks here mean that I've migrated the macros locally. I won't be pushing them until the entire stack is done, because some macros require cross-repo changes.)

PRs:

Hidden because it's really long
  • cmake (skip, cmake utilities are deprecated)
    • IGN_UTILS_TEST_DISABLED_ON_WIN32
    • IGN_UTILS_TEST_DISABLED_ON_MAC
    • IGN_UTILS_TEST_DISABLED_ONLY_ON_LINUX
    • SuppressWarning.hh
      • IGN_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR
      • IGN_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR
      • IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
      • IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
  • utils ign -> gz Macro Migration : gz-utils gazebosim/gz-utils#64
    • IGN_UTILS_TEST_DISABLED_ON_WIN32
    • IGN_UTILS_TEST_DISABLED_ON_MAC
    • IGN_UTILS_TEST_DISABLED_ONLY_ON_LINUX
    • IGN_UTILS_IMPL_PTR_FWD
    • IGN_UTILS_UNIQUE_IMPL_PTR_FWD
    • IGN_UTILS_IMPL_PTR
    • IGN_UTILS_UNIQUE_IMPL_PTR
    • SuppressWarning.hh
      • IGN_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR, IGN_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR
      • IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING, IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
      • IGN_UTILS_WARN_IGNORE__DEPRECATED_DECLARATION, IGN_UTILS_WARN_RESUME__DEPRECATED_DECLARATION
  • math ign -> gz Macro Migration : gz-math gazebosim/gz-math#437
    • IGN_RTOD, IGN_DTOR
    • IGN_NORMALIZE
    • IGN_PI, IGN_PI_2, IGN_PI_4
    • IGN_SQRT2
    • IGN_FP_VOLATILE
    • IGN_SPHERE_VOLUME, IGN_CYLINDER_VOLUME, IGN_BOX_VOLUME, IGN_BOX_VOLUME_V
  • tools
  • plugin ign -> gz Macro Migration : gz-plugin gazebosim/gz-plugin#87
    • IGN_PLUGIN_REGISTER_MORE_TRANS_UNITS
    • IGNITION_ADD_PLUGIN
    • IGNITION_ADD_PLUGIN_ALIAS
    • IGNITION_ADD_FACTORY
    • IGNITION_ADD_FACTORY_ALIAS
    • Test/Test-specific
      • IGN_CREATE_INTERFACE
      • IGNITION_UNITTEST_SPECIALIZED_PLUGIN_ACCESS
  • msgs (skip, msgs utilities are deprecated), but upstream macro usage needs to be migrated: ign -> gz Upstream Macro Migration : gz-msgs gazebosim/gz-msgs#260
    • SuppressWarning.hh
      • IGN_MSGS_WARN_IGNORE__DELETE_NON_VIRTUAL_DESTRUCTOR, IGN_MSGS_WARN_RESUME__DELETE_NON_VIRTUAL_DESTRUCTOR
      • IGN_MSGS_WARN_IGNORE__DLL_INTERFACE_MISSING, IGN_MSGS_WARN_RESUME__DLL_INTERFACE_MISSING
  • common ign -> gz Macro Migration : gz-common gazebosim/gz-common#366
    • IGN_ENUM
    • SuppressWarning.hh (skip, common utilities are deprecated)
      • IGN_COMMON_WARN_IGNORE__DELETE_NON_VIRTUAL_DESTRUCTOR
      • IGN_COMMON_WARN_RESUME__DELETE_NON_VIRTUAL_DESTRUCTOR
      • IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      • IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
    • IGN_HOMEDIR
    • IGN_NANO_TO_SEC, IGN_SEC_TO_NANO, IGN_MS_TO_NANO, IGN_US_TO_NANO
    • IGN_SPEED_OF_LIGHT
    • IGN_SLEEP_S, IGN_SLEEP_US, IGN_SLEEP_MS, IGN_SLEEP_NS
    • IGN_SYSTEM_TIME, IGN_SYSTEM_TIME_S, IGN_SYSTEM_TIME_US, IGN_SYSTEM_TIME_MS, IGN_SYSTEM_TIME_NS
    • IGN_ASSERT
    • IGNITION_COMMON_TINYOBJLOADER_IMPLEMENTATION (src local, hard-tocked)
    • PluginMacros.hh (skip, common plugins are deprecated)
      • IGN_COMMON_SPECIALIZE_INTERFACE
      • IGN_COMMON_BEGIN_ADDING_PLUGINS
      • IGN_COMMON_ADD_PLUGIN
      • IGN_COMMON_FINISH_ADDING_PLUGINS
      • IGN_COMMON_REGISTER_SINGLE_PLUGIN
    • Profiler.hh
      • IGN_PROFILER_ENABLE
      • IGN_PROFILE_THREAD_NAME
      • IGN_PROFILE_LOG_TEXT
      • IGN_PROFILE_BEGIN
      • IGN_PROFILE_END
      • IGN_PROFILE_L
      • IGN_PROFILE
      • IGN_PROFILE_VALID
    • Test/Test specific
      • IGN_CREATE_SPEC_INTERFACE
      • IGN_DUMMY_PLUGIN_PATH
      • IGNITION_UNITTEST_SPECIALIZED_PLUGIN_ACCESS
  • sdformat ign -> gz Upstream Macro Migration : sdformat gazebosim/sdformat#1040
  • transport ign -> gz Macro Migration : gz-transport gazebosim/gz-transport#319
    • IGN_ZMQ_POST_4_3_1
    • IGN_CPPZMQ_POST_4_7_0
    • ign_strcat, ign_strcpy, ign_sprintf, ign_strdup
  • rendering ign -> gz Macro Migration : gz-rendering gazebosim/gz-rendering#643
    • IGN_RENDERING_REGISTER_RENDER_PASS
    • IGN_VISIBILITY_ALL
    • IGN_VISIBILITY_SELECTION
    • IGN_VISIBILITY_GUI
    • IGN_VISIBILITY_SELECTABLE
  • physics ign -> gz Macro Migration : gz-physics gazebosim/gz-physics#353
    • IGN_PHYSICS_DECLARE_JOINT_TYPE, IGN_PHYSICS_DECLARE_SHAPE_TYPE
    • IGN_PHYSICS_OPERATEONSPECIFIEDDATA_TEMPLATES, IGN_PHYSICS_OPERATEONSPECIFIEDDATA_PREFIX
    • IGN_PHYSICS_MAKE_ALL_TYPE_COMBOS
    • IGN_PHYSICS_ADD_PLUGIN
    • IGN_PLUGIN_REGISTER_MORE_TRANS_UNITS -> GZ_**PHYSICS**_REGISTER_MORE_TRANS_UNITS
    • IGN_PHYSICS_REQUEST_FEATURES_MACRO
    • IGN_PHYSICS_CREATE_SELECTOR
    • IGNITION_PHYSICS_CONST_GET_ERROR (hard-tocked, inside detail header)
    • IGNITION_UNITTEST_EXPECTDATA_ACCESS (hard-tocked, inside test and detail headers)
    • IGNITION_PHYSICS_DEFINE_COORDINATE_SPACE (hard-tocked, inside detail header)
    • Test/Test-specific
      • IGN_PHYSICS_MOCK_MACRO_HELPER
      • IGN_PHYSICS_MOCK_MACRO
  • sensors ign -> gz Upstream Macro Migration : gz-sensors gazebosim/gz-sensors#232
  • gui (already migrated) ign -> gz Upstream Macro Migration : gz-gui gazebosim/gz-gui#413
    • IGN_GUI_PLUGIN_INSTALL_DIR
  • fuel-tools ign -> gz Macro Migration : gz-fuel-tools gazebosim/gz-fuel-tools#259
    • ign_strcat, ign_strcpy, ign_sprintf, ign_strdup
  • sim ign -> gz Macro Migration : gz-sim gazebosim/gz-sim#1520
    • IGN_GAZEBO_REGISTER_COMPONENT
    • IGN_GAZEBO_PLUGIN_INSTALL_DIR
    • IGN_GAZEBO_GUI_PLUGIN_INSTALL_DIR
    • IGN_GAZEBO_WORLD_INSTALL_DIR
  • launch ign -> gz Upstream Macro Migration : gz-launch gazebosim/gz-launch#166
@methylDragon methylDragon added the ign to gz Renaming Ignition to Gazebo. label Jun 6, 2022
This was referenced Jun 6, 2022
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
@chapulina chapulina mentioned this issue Jun 7, 2022
Open
69 tasks
@methylDragon methylDragon mentioned this issue Jun 18, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
ign to gz Renaming Ignition to Gazebo.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@methylDragon