ign -> gz Header Migration : ign-cmake

CMakeLists.txt

@@ -20,7 +20,9 @@ include(IgnCMake)
 
 #--------------------------------------
 # Set up the project
-ign_configure_project(VERSION_SUFFIX pre1)
+ign_configure_project(
+  REPLACE_IGNITION_INCLUDE_PATH gz/utils
+  VERSION_SUFFIX pre1)
 
 #--------------------------------------
 # Set project-specific options

include/CMakeLists.txt

@@ -0,0 +1,2 @@
+add_subdirectory(gz)
+install(DIRECTORY ignition DESTINATION ${IGN_INCLUDE_INSTALL_DIR_FULL})

include/gz/utilities/ExtraTestMacros.hh

@@ -0,0 +1,49 @@
+/*
+ * Copyright (C) 2020 Open Source Robotics Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+#ifndef GZ_UTILITIES_EXTRATESTMACROS_HH
+#define GZ_UTILITIES_EXTRATESTMACROS_HH
+
+#include <gz/utilities/detail/ExtraTestMacros.hh>
+
+#pragma message("ign-cmake (utilities) ExtraTestMacros is deprecated, use ign-utils")
+
+/// \brief Restrict the execution of the test for the Windows platform.
+/// The test will be compiled on Windows too but will never be run as
+/// part of the test suite. The macro uses the Disabled_ prefix provided
+/// by googletest. See
+/// https://chromium.googlesource.com/external/github.com/google/googletest/+/HEAD/googletest/docs/advanced.md
+#define IGN_UTILS_TEST_DISABLED_ON_WIN32(TestName) \
+  DETAIL_IGN_UTILS_TEST_DISABLED_ON_WIN32(TestName)
+
+/// \brief Restrict the execution of the test for the Mac platform.
+/// The test will be compiled on Windows too but will never be run as
+/// part of the test suite. The macro uses the Disabled_ prefix provided
+/// by googletest. See
+/// https://chromium.googlesource.com/external/github.com/google/googletest/+/HEAD/googletest/docs/advanced.md
+#define IGN_UTILS_TEST_DISABLED_ON_MAC(TestName) \
+  DETAIL_IGN_UTILS_TEST_DISABLED_ON_MAC(TestName)
+
+/// \brief Restrict the execution of the test to just the Linux platform
+/// Other platforms will get the test compiled but it won't be run
+/// as part of the test suite execution.
+/// The macro uses the Disabled_ prefix provided by googletest. See
+/// https://chromium.googlesource.com/external/github.com/google/googletest/+/HEAD/googletest/docs/advanced.md
+#define IGN_UTILS_TEST_ENABLED_ONLY_ON_LINUX(TestName) \
+  DETAIL_IGN_UTILS_TEST_ENABLED_ONLY_ON_LINUX(TestName)
+
+#endif

include/gz/utilities/SuppressWarning.hh

@@ -0,0 +1,73 @@
+/*
+ * Copyright (C) 2018 Open Source Robotics Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+#ifndef GZ_UTILITIES_SUPPRESSWARNING_HH_
+#define GZ_UTILITIES_SUPPRESSWARNING_HH_
+
+#include <gz/utilities/detail/SuppressWarning.hh>
+
+#pragma message("ign-cmake (utilities) SuppressWarning is deprecated, use ign-utils")
+
+// This header contains cross-platform macros for suppressing warnings. Please
+// only use these macros responsibly when you are certain that the compiler is
+// producing a warning that is not applicable to the specific instance. Do not
+// use these macros to ignore legitimate warnings, even if you may find them
+// irritating.
+
+/*
+ * Usage example:
+ *
+ * SomeClass *ptr = CreatePtr();
+ * IGN_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR
+ * delete ptr;
+ * IGN_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR
+ *
+ */
+
+// Be sure to call the IGN_UTILS_WARN_RESUME__XXXXX macro at the end of the
+// block of code where the warning suppression is needed. Otherwise, you might
+// inadvertently suppress legitimate warnings.
+
+// ---- List of available suppressions ----
+
+/// \brief Compilers might warn about deleting a pointer to a class that has
+/// virtual functions without a virtual destructor or a `final` declaration,
+/// because the pointer might secretly be pointing to a more derived class type.
+/// We want to suppress this warning when we know for certain (via the design
+/// of our implementation) that the pointer is definitely not pointing to a more
+/// derived type.
+#define IGN_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR \
+  DETAIL_IGN_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR
+
+#define IGN_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR \
+  DETAIL_IGN_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR
+
+/// \brief Microsoft Visual Studio does not automatically export the interface
+/// information for member variables that belong to interface classes of a DLL.
+/// Instead it issues this warning. When the member variable is private, we
+/// choose to suppress the warning instead of needlessly adding the class
+/// information to the DLL interface.
+#define IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING \
+  DETAIL_IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
+
+#define IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING \
+  DETAIL_IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
+
+// TODO(anyone): Add more warning types as they become relevant.
+// Do not add warning types to suppress unless they are genuinely necessary.
+
+#endif

include/gz/utilities/detail/ExtraTestMacros.hh

@@ -0,0 +1,62 @@
+/*
+ * Copyright (C) 2020 Open Source Robotics Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+#ifndef GZ_UTILITIES_DETAIL_EXTRATESTMACROS_HH
+#define GZ_UTILITIES_DETAIL_EXTRATESTMACROS_HH
+
+#include <gz/utilities/SuppressWarning.hh>
+
+#define DETAIL_IGN_UTILS_ADD_DISABLED_PREFIX(x) DISABLED_##x
+
+#if defined _WIN32
+
+  #define DETAIL_IGN_UTILS_TEST_DISABLED_ON_WIN32(TestName) \
+      DETAIL_IGN_UTILS_ADD_DISABLED_PREFIX(TestName)
+
+#else
+
+  #define DETAIL_IGN_UTILS_TEST_DISABLED_ON_WIN32(TestName) \
+      TestName
+
+#endif
+
+#if defined __APPLE__
+
+  #define DETAIL_IGN_UTILS_TEST_DISABLED_ON_MAC(TestName) \
+      DETAIL_IGN_UTILS_ADD_DISABLED_PREFIX(TestName)
+
+#else
+
+  #define DETAIL_IGN_UTILS_TEST_DISABLED_ON_MAC(TestName) \
+      TestName
+
+#endif
+
+#if defined __linux__
+
+  #define DETAIL_IGN_UTILS_TEST_ENABLED_ONLY_ON_LINUX(TestName) \
+      TestName
+
+#else
+
+  #define DETAIL_IGN_UTILS_TEST_ENABLED_ONLY_ON_LINUX(TestName) \
+      DETAIL_IGN_UTILS_ADD_DISABLED_PREFIX(TestName)
+
+#endif
+
+
+#endif

include/gz/utilities/detail/SuppressWarning.hh

@@ -0,0 +1,157 @@
+/*
+ * Copyright (C) 2017 Open Source Robotics Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+
+#ifndef GZ_UTILITIES_DETAIL_SUPPRESSWARNING_HH_
+#define GZ_UTILITIES_DETAIL_SUPPRESSWARNING_HH_
+
+#include <gz/utilities/SuppressWarning.hh>
+
+#define DETAIL_IGN_UTILS_STRINGIFY(x) #x
+
+/* cppcheck-suppress */
+
+// BEGIN / FINISH Macros
+
+#if defined __clang__
+
+  #define DETAIL_IGN_UTILS_BEGIN_WARN_SUP_PUSH \
+    _Pragma("clang diagnostic push")
+
+
+  #define DETAIL_IGN_UTILS_WARN_SUP_HELPER_2(w) \
+    DETAIL_IGN_UTILS_STRINGIFY(clang diagnostic ignored w)
+
+
+  #define DETAIL_IGN_UTILS_WARN_SUP_HELPER(w) \
+    _Pragma(DETAIL_IGN_UTILS_WARN_SUP_HELPER_2(w))
+
+
+  #define DETAIL_IGN_UTILS_WARN_RESUME \
+    _Pragma("clang diagnostic pop")
+
+
+#elif defined __GNUC__
+
+  // NOTE: clang will define both __clang__ and __GNUC__, and it seems that
+  // clang will gladly accept GCC pragmas. Even so, if we want the pragmas to
+  // target the "correct" compiler, we should check if __clang__ is defined
+  // before checking whether __GNUC__ is defined.
+
+  #define DETAIL_IGN_UTILS_BEGIN_WARN_SUP_PUSH \
+    _Pragma("GCC diagnostic push")
+
+
+  #define DETAIL_IGN_UTILS_WARN_SUP_HELPER_2(w) \
+    DETAIL_IGN_UTILS_STRINGIFY(GCC diagnostic ignored w)
+
+
+  #define DETAIL_IGN_UTILS_WARN_SUP_HELPER(w) \
+    _Pragma(DETAIL_IGN_UTILS_WARN_SUP_HELPER_2(w))
+
+
+  #define DETAIL_IGN_UTILS_WARN_RESUME \
+    _Pragma("GCC diagnostic pop")
+
+
+#elif defined _MSC_VER
+
+
+  #define DETAIL_IGN_UTILS_BEGIN_WARN_SUP_PUSH \
+    __pragma(warning(push))
+
+
+  #define DETAIL_IGN_UTILS_WARN_SUP_HELPER(w) \
+    __pragma(warning(disable: w))
+
+
+  #define DETAIL_IGN_UTILS_WARN_RESUME \
+    __pragma(warning(pop))
+
+
+#else
+
+  // Make these into no-ops if we don't know the type of compiler
+
+  #define DETAIL_IGN_UTILS_BEGIN_WARN_SUP_PUSH
+
+
+  #define DETAIL_IGN_UTILS_WARN_SUP_HELPER(w)
+
+
+  #define DETAIL_IGN_UTILS_WARN_RESUME
+
+
+#endif
+
+
+#define DETAIL_IGN_UTILS_BEGIN_WARNING_SUPPRESSION(warning_token) \
+  DETAIL_IGN_UTILS_BEGIN_WARN_SUP_PUSH \
+  DETAIL_IGN_UTILS_WARN_SUP_HELPER(warning_token)
+
+
+
+// Warning Tokens
+#if defined __GNUC__ || defined __clang__
+
+  #define DETAIL_IGN_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR \
+    DETAIL_IGN_UTILS_BEGIN_WARNING_SUPPRESSION("-Wdelete-non-virtual-dtor")
+
+  #define DETAIL_IGN_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR \
+    DETAIL_IGN_UTILS_WARN_RESUME
+
+
+  // There is no analogous warning for this in GCC or Clang so we just make
+  // blank macros for this warning type.
+  #define DETAIL_IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
+  #define DETAIL_IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
+
+
+#elif defined _MSC_VER
+
+  #define DETAIL_IGN_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR \
+    DETAIL_IGN_UTILS_BEGIN_WARNING_SUPPRESSION(4265) \
+    DETAIL_IGN_UTILS_BEGIN_WARNING_SUPPRESSION(5205)
+
+  #define DETAIL_IGN_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR \
+    DETAIL_IGN_UTILS_WARN_RESUME
+
+
+  #define DETAIL_IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING \
+    DETAIL_IGN_UTILS_BEGIN_WARNING_SUPPRESSION(4251)
+
+  #define DETAIL_IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING \
+    DETAIL_IGN_UTILS_WARN_RESUME
+
+
+#else
+
+  // If the compiler is unknown, we simply leave these macros blank to avoid
+  // compilation errors.
+
+  #define DETAIL_IGN_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR
+  #define DETAIL_IGN_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR
+
+
+  #define DETAIL_IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
+  #define DETAIL_IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
+
+
+#endif
+
+
+#endif

include/ignition/utilities/ExtraTestMacros.hh

@@ -15,35 +15,4 @@
  *
  */
 
-#ifndef IGNITION_UTILITIES_EXTRATESTMACROS_HH
-#define IGNITION_UTILITIES_EXTRATESTMACROS_HH
-
-#include <ignition/utilities/detail/ExtraTestMacros.hh>
-
-#pragma message("ign-cmake (utilities) ExtraTestMacros is deprecated, use ign-utils")
-
-/// \brief Restrict the execution of the test for the Windows platform.
-/// The test will be compiled on Windows too but will never be run as
-/// part of the test suite. The macro uses the Disabled_ prefix provided
-/// by googletest. See
-/// https://chromium.googlesource.com/external/github.com/google/googletest/+/HEAD/googletest/docs/advanced.md
-#define IGN_UTILS_TEST_DISABLED_ON_WIN32(TestName) \
-  DETAIL_IGN_UTILS_TEST_DISABLED_ON_WIN32(TestName)
-
-/// \brief Restrict the execution of the test for the Mac platform.
-/// The test will be compiled on Windows too but will never be run as
-/// part of the test suite. The macro uses the Disabled_ prefix provided
-/// by googletest. See
-/// https://chromium.googlesource.com/external/github.com/google/googletest/+/HEAD/googletest/docs/advanced.md
-#define IGN_UTILS_TEST_DISABLED_ON_MAC(TestName) \
-  DETAIL_IGN_UTILS_TEST_DISABLED_ON_MAC(TestName)
-
-/// \brief Restrict the execution of the test to just the Linux platform
-/// Other platforms will get the test compiled but it won't be run
-/// as part of the test suite execution.
-/// The macro uses the Disabled_ prefix provided by googletest. See
-/// https://chromium.googlesource.com/external/github.com/google/googletest/+/HEAD/googletest/docs/advanced.md
-#define IGN_UTILS_TEST_ENABLED_ONLY_ON_LINUX(TestName) \
-  DETAIL_IGN_UTILS_TEST_ENABLED_ONLY_ON_LINUX(TestName)
-
-#endif
+#include <gz/utilities/ExtraTestMacros.hh>