ign -> gz Namespace migration (narrow) : gz-common

Migration.md

@@ -12,6 +12,9 @@ release will remove the deprecated code.
 1. `Submesh::MaterialIndex` is deprecated. `SubMesh::GetMaterialIndex` should
    be used instead, which properly handles submeshes having no material index
    applied to them.
+2. The `ignition` namespace is deprecated and will be removed in future versions.  Use `gz` instead.
+3. Header files under `ignition/...` are deprecated and will be removed in future versions.
+   Use `gz/...` instead.
 
 ### Additions
 
@@ -97,4 +100,3 @@ release will remove the deprecated code.
 1. **ignition-cmake**
     + Ignition-math now has a build dependency on ignition-cmake, which
       allows cmake scripts to be shared across all the ignition packages.
-

av/include/gz/common/AudioDecoder.hh

@@ -23,7 +23,7 @@
 #include <gz/common/av/Export.hh>
 #include <gz/utils/ImplPtr.hh>
 
-namespace ignition
+namespace gz
 {
   namespace common
   {

av/include/gz/common/HWEncoder.hh

@@ -27,7 +27,7 @@
 
 /// This is an internal-use only class encapsulating HW video encoding. All
 /// symbols defined here are hidden from the public API.
-namespace ignition::common
+namespace gz::common
 {
   /// \brief Representation of a GPU video encoder and its configuration.
   /// \note This class is intentionally hidden as it provides highly customized

av/include/gz/common/HWVideo.hh

@@ -18,7 +18,7 @@
 
 #include <gz/common/EnumIface.hh>
 
-namespace ignition::common
+namespace gz::common
 {
   enum class IGNITION_COMMON_AV_VISIBLE HWEncoderType
   {

av/include/gz/common/Video.hh

@@ -28,7 +28,7 @@ struct AVFrame;
 struct AVPicture;
 struct SwsContext;
 
-namespace ignition
+namespace gz
 {
   namespace common
   {

av/include/gz/common/VideoEncoder.hh

@@ -34,7 +34,7 @@
 #define VIDEO_ENCODER_FPS_DEFAULT 25
 #define VIDEO_ENCODER_FORMAT_DEFAULT "mp4"
 
-namespace ignition
+namespace gz
 {
   namespace common
   {

av/include/gz/common/av/Util.hh

@@ -18,7 +18,7 @@
 #ifndef GZ_COMMON_AV_UTIL_HH_
 #define GZ_COMMON_AV_UTIL_HH_
 
-namespace ignition
+namespace gz
 {
   namespace common
   {

av/include/gz/common/ffmpeg_inc.hh

@@ -51,7 +51,7 @@ extern "C" {
 
 #include <gz/common/av/Export.hh>
 
-namespace ignition
+namespace gz
 {
   namespace common
   {

av/include/ignition/common/AudioDecoder.hh

@@ -16,3 +16,4 @@
 */
 
 #include <gz/common/AudioDecoder.hh>
+#include <ignition/common/config.hh>

av/include/ignition/common/HWEncoder.hh

@@ -16,3 +16,4 @@
  */
 
 #include <gz/common/HWEncoder.hh>
+#include <ignition/common/config.hh>

av/include/ignition/common/HWVideo.hh

@@ -16,3 +16,4 @@
  */
 
 #include <gz/common/HWVideo.hh>
+#include <ignition/common/config.hh>

av/include/ignition/common/Video.hh

@@ -16,3 +16,4 @@
  */
 
 #include <gz/common/Video.hh>
+#include <ignition/common/config.hh>

av/include/ignition/common/VideoEncoder.hh

@@ -16,3 +16,4 @@
  */
 
 #include <gz/common/VideoEncoder.hh>
+#include <ignition/common/config.hh>

av/include/ignition/common/av.hh

@@ -16,3 +16,4 @@
  */
 
 #include <gz/common/av.hh>
+#include <ignition/common/config.hh>

av/include/ignition/common/av/Export.hh

@@ -16,3 +16,4 @@
  */
 
 #include <gz/common/av/Export.hh>
+#include <ignition/common/config.hh>

av/include/ignition/common/av/Util.hh

@@ -16,3 +16,4 @@
  */
 
 #include <gz/common/av/Util.hh>
+#include <ignition/common/config.hh>

av/include/ignition/common/av/detail/Export.hh

@@ -16,3 +16,4 @@
  */
 
 #include <gz/common/av/detail/Export.hh>
+#include <ignition/common/config.hh>

av/include/ignition/common/ffmpeg_inc.hh

@@ -16,3 +16,4 @@
  */
 
 #include <gz/common/ffmpeg_inc.hh>
+#include <ignition/common/config.hh>

av/src/AudioDecoder.cc

@@ -23,10 +23,10 @@
 #define AUDIO_INBUF_SIZE (20480 * 2)
 #define AUDIO_REFILL_THRESH 4096
 
-using namespace ignition;
+using namespace gz;
 using namespace common;
 
-class ignition::common::AudioDecoder::Implementation
+class gz::common::AudioDecoder::Implementation
 {
   /// \brief Destructor
   public: ~Implementation();
@@ -48,7 +48,7 @@ class ignition::common::AudioDecoder::Implementation
 };
 
 /////////////////////////////////////////////////
-ignition::common::AudioDecoder::Implementation::~Implementation()
+gz::common::AudioDecoder::Implementation::~Implementation()
 {
   // Close the codec
   if (this->codecCtx)
@@ -61,9 +61,9 @@ ignition::common::AudioDecoder::Implementation::~Implementation()
 
 /////////////////////////////////////////////////
 AudioDecoder::AudioDecoder()
-  : dataPtr(ignition::utils::MakeUniqueImpl<Implementation>())
+  : dataPtr(gz::utils::MakeUniqueImpl<Implementation>())
 {
-  ignition::common::load();
+  gz::common::load();
 }
 
 /////////////////////////////////////////////////

av/src/AudioDecoder_TEST.cc

@@ -20,7 +20,7 @@
 #include <ignition/utils/ExtraTestMacros.hh>
 #include <ignition/common/testing/TestPaths.hh>
 
-using namespace ignition;
+using namespace gz;
 
 /////////////////////////////////////////////////
 TEST(AudioDecoder, FileNotSet)

av/src/HWEncoder.cc

@@ -25,11 +25,11 @@
 #include "ignition/common/StringUtils.hh"
 #include "ignition/common/Console.hh"
 
-using namespace ignition;
+using namespace gz;
 using namespace common;
 using namespace std;
 
-class ignition::common::HWEncoder::Implementation
+class gz::common::HWEncoder::Implementation
 {
   /// \brief Device reference for HW-accelerated encoding.
   public: AVBufferRef* hwDevice = nullptr;
@@ -679,7 +679,7 @@ AVFrame* HWEncoder::GetFrameForEncoder(AVFrame* _inFrame)
 HWEncoder::HWEncoder(const FlagSet<HWEncoderType> _allowedHwEncoders,
                      const std::string& _hwAccelDevice,
                      std::optional<bool> _useHwSurface)
-  : dataPtr(ignition::utils::MakeUniqueImpl<Implementation>())
+  : dataPtr(gz::utils::MakeUniqueImpl<Implementation>())
 {
   this->dataPtr->initHwEncoders = _allowedHwEncoders;
   this->dataPtr->initHwDevice = _hwAccelDevice;

av/src/Util.cc

@@ -67,7 +67,7 @@ void logCallback(void *_ptr, int _level, const char *_fmt, va_list _args)
 }
 
 /////////////////////////////////////////////////
-void ignition::common::load()
+void gz::common::load()
 {
   static bool first = true;
   if (first)

av/src/Video.cc

@@ -20,11 +20,11 @@
 #include "ignition/common/Video.hh"
 #include "ignition/common/av/Util.hh"
 
-using namespace ignition;
+using namespace gz;
 using namespace common;
 
 // Private data structure for the Video class
-class ignition::common::Video::Implementation
+class gz::common::Video::Implementation
 {
   /// \brief libav Format I/O context
   public: AVFormatContext *formatCtx = nullptr;
@@ -61,10 +61,10 @@ class ignition::common::Video::Implementation
 
 /////////////////////////////////////////////////
 Video::Video()
-  : dataPtr(ignition::utils::MakeUniqueImpl<Implementation>())
+  : dataPtr(gz::utils::MakeUniqueImpl<Implementation>())
 {
   // Make sure libav is loaded.
-  ignition::common::load();
+  gz::common::load();
 }
 
 /////////////////////////////////////////////////

av/src/VideoEncoder.cc

@@ -28,13 +28,13 @@
 #include "ignition/common/HWEncoder.hh"
 #endif
 
-using namespace ignition;
+using namespace gz;
 using namespace common;
 using namespace std;
 
 // Private data class
 // hidden visibility specifier has to be explicitly set to silent a gcc warning
-class IGNITION_COMMON_AV_HIDDEN ignition::common::VideoEncoder::Implementation
+class IGNITION_COMMON_AV_HIDDEN gz::common::VideoEncoder::Implementation
 {
   /// \brief Name of the file which stores the video while it is being
   ///        recorded.
@@ -144,10 +144,10 @@ AVFrame* VideoEncoder::Implementation::GetFrameForEncoder(AVFrame* _inFrame)
 
 /////////////////////////////////////////////////
 VideoEncoder::VideoEncoder()
-  : dataPtr(ignition::utils::MakeUniqueImpl<Implementation>())
+  : dataPtr(gz::utils::MakeUniqueImpl<Implementation>())
 {
   // Make sure libav is loaded.
-  ignition::common::load();
+  gz::common::load();
 }
 
 /////////////////////////////////////////////////

av/src/VideoEncoder_TEST.cc

@@ -21,7 +21,7 @@
 #include "ignition/common/testing/AutoLogFixture.hh"
 #include "ignition/common/testing/TestPaths.hh"
 
-using namespace ignition;
+using namespace gz;
 using namespace common;
 
 class VideoEncoderTest : public common::testing::AutoLogFixture
@@ -34,7 +34,7 @@ class VideoEncoderTest : public common::testing::AutoLogFixture
     ASSERT_TRUE(tempDir->Valid()) << tempDir->Path();
   }
 
-  public: std::shared_ptr<ignition::common::TempDirectory> tempDir;
+  public: std::shared_ptr<gz::common::TempDirectory> tempDir;
 };
 
 /////////////////////////////////////////////////

av/src/ffmpeg_inc.cc

@@ -16,7 +16,7 @@
 */
 #include "ignition/common/ffmpeg_inc.hh"
 
-using namespace ignition;
+using namespace gz;
 
 //////////////////////////////////////////////////
 AVFrame *common::AVFrameAlloc(void)

events/include/gz/common/Event.hh

@@ -29,7 +29,7 @@
 #include <gz/common/events/Export.hh>
 #include <gz/common/events/Types.hh>
 
-namespace ignition
+namespace gz
 {
   namespace common
   {

events/include/gz/common/KeyEvent.hh

@@ -23,7 +23,7 @@
 #include <gz/common/events/Export.hh>
 #include <gz/utils/SuppressWarning.hh>
 
-namespace ignition
+namespace gz
 {
   namespace common
   {

events/include/gz/common/MouseEvent.hh

@@ -23,7 +23,7 @@
 #include <gz/common/events/Export.hh>
 #include <gz/utils/SuppressWarning.hh>
 
-namespace ignition
+namespace gz
 {
   namespace common
   {
@@ -81,11 +81,11 @@ namespace ignition
 
       /// \brief Get mouse pointer position on the screen.
       /// \return Mouse pointer position on the screen.
-      public: ignition::math::Vector2i Pos() const;
+      public: gz::math::Vector2i Pos() const;
 
       /// \brief Set mouse pointer position on the screen.
       /// \param[in] _pos Mouse pointer position on the screen.
-      public: void SetPos(const ignition::math::Vector2i &_pos);
+      public: void SetPos(const gz::math::Vector2i &_pos);
 
       /// \brief Set mouse pointer position on the screen.
       /// \param[in] _x Mouse pointer X position on the screen.
@@ -94,11 +94,11 @@ namespace ignition
 
       /// \brief Get the previous position.
       /// \return The previous mouse position.
-      public: ignition::math::Vector2i PrevPos() const;
+      public: gz::math::Vector2i PrevPos() const;
 
       /// \brief Set the previous position.
       /// \param[in] _pos Previous mouse pointer position on the screen.
-      public: void SetPrevPos(const ignition::math::Vector2i &_pos);
+      public: void SetPrevPos(const gz::math::Vector2i &_pos);
 
       /// \brief Set the previous position.
       /// \param[in] _x Previous mouse pointer X position on the screen.
@@ -107,11 +107,11 @@ namespace ignition
 
       /// \brief Get the position of button press.
       /// \return Screen position of a button press.
-      public: ignition::math::Vector2i PressPos() const;
+      public: gz::math::Vector2i PressPos() const;
 
       /// \brief Set the position of button press.
       /// \param[in] _pos Mouse pointer position on the screen.
-      public: void SetPressPos(const ignition::math::Vector2i &_pos);
+      public: void SetPressPos(const gz::math::Vector2i &_pos);
 
       /// \brief Set the position of button press.
       /// \param[in] _x Mouse pointer X position on the screen.
@@ -120,11 +120,11 @@ namespace ignition
 
       /// \brief Get the scroll position.
       /// \return The scroll position.
-      public: ignition::math::Vector2i Scroll() const;
+      public: gz::math::Vector2i Scroll() const;
 
       /// \brief Set the scroll position.
       /// \param[in] _scroll Scroll position.
-      public: void SetScroll(const ignition::math::Vector2i &_scroll);
+      public: void SetScroll(const gz::math::Vector2i &_scroll);
 
       /// \brief Set the scroll position.
       /// \param[in] _x Scroll X position.

events/include/gz/common/events/Types.hh

@@ -21,7 +21,7 @@
 #include <memory>
 
 // This header contains forward declarations for some event types
-namespace ignition
+namespace gz
 {
   namespace common
   {

events/include/ignition/common/Event.hh

@@ -16,3 +16,4 @@
  */
 
 #include <gz/common/Event.hh>
+#include <ignition/common/config.hh>

events/include/ignition/common/KeyEvent.hh

@@ -16,3 +16,4 @@
  */
 
 #include <gz/common/KeyEvent.hh>
+#include <ignition/common/config.hh>

events/include/ignition/common/MouseEvent.hh

@@ -16,3 +16,4 @@
  */
 
 #include <gz/common/MouseEvent.hh>
+#include <ignition/common/config.hh>

events/include/ignition/common/events.hh

@@ -16,3 +16,4 @@
  */
 
 #include <gz/common/events.hh>
+#include <ignition/common/config.hh>