Skip to content

Commit

Permalink
Merge pull request #309 from gazebosim/2-to-3-20220830
Browse files Browse the repository at this point in the history
2 to 3 20220830
  • Loading branch information
scpeters authored Aug 31, 2022
2 parents a5c59af + af4e06b commit 2363991
Show file tree
Hide file tree
Showing 8 changed files with 135 additions and 13 deletions.
11 changes: 11 additions & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
## Gazebo CMake 2.x

### Gazebo CMake 2.15.0 (2022-08-29)

1. ign -> gz: add `gz/*` header files
* [Pull request #303](https://github.com/gazebosim/gz-cmake/pull/303)

1. Backport `GZ_SANITIZER` variable
* [Pull request #294](https://github.com/gazebosim/gz-cmake/pull/294)

1. Update doxygen file
* [Pull request #276](https://github.com/gazebosim/gz-cmake/pull/276)

### Gazebo CMake 2.14.0 (2022-07-25)

1. Add code coverage ignore file
Expand Down
7 changes: 0 additions & 7 deletions cmake/upload_doc.sh.in
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,6 @@
echo "Usage: sh upload_doc.sh [y/n]"
echo " Optional [y/n] argument indicates whether to upload the docs to S3 automatically."

# Check if the node was configured to use s3cmd
# This is done by running s3cmd --configure
if [ ! -f "${HOME}/.s3cfg" ]; then
echo "No $HOME/.s3cfg file found. Please config the software first in your system"
exit 1
fi

# Make documentation if not build
if [ ! -f "@CMAKE_BINARY_DIR@/doxygen/html/index.html" ]; then
make doc
Expand Down
47 changes: 47 additions & 0 deletions include/gz/utilities/ExtraTestMacros.hh
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
/*
* 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>

/// \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
71 changes: 71 additions & 0 deletions include/gz/utilities/SuppressWarning.hh
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
/*
* 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>

// 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
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
*
*/

#ifndef IGNITION_UTILITIES_DETAIL_EXTRATESTMACROS_HH
#define IGNITION_UTILITIES_DETAIL_EXTRATESTMACROS_HH
#ifndef GZ_UTILITIES_DETAIL_EXTRATESTMACROS_HH
#define GZ_UTILITIES_DETAIL_EXTRATESTMACROS_HH

#include <ignition/utilities/SuppressWarning.hh>
#include <gz/utilities/SuppressWarning.hh>

#define DETAIL_GZ_UTILS_ADD_DISABLED_PREFIX(x) DISABLED_##x

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
#ifndef GZ_UTILITIES_DETAIL_SUPPRESSWARNING_HH_
#define GZ_UTILITIES_DETAIL_SUPPRESSWARNING_HH_

#include <ignition/utilities/SuppressWarning.hh>
#include <gz/utilities/SuppressWarning.hh>

#define DETAIL_GZ_UTILS_STRINGIFY(x) #x

Expand Down
2 changes: 1 addition & 1 deletion include/ignition/utilities/ExtraTestMacros.hh
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
#ifndef IGNITION_UTILITIES_EXTRATESTMACROS_HH
#define IGNITION_UTILITIES_EXTRATESTMACROS_HH

#include <ignition/utilities/detail/ExtraTestMacros.hh>
#include <gz/utilities/detail/ExtraTestMacros.hh>

#pragma message("gz-cmake (utilities) ExtraTestMacros is deprecated, use gz-utils")

Expand Down
2 changes: 1 addition & 1 deletion include/ignition/utilities/SuppressWarning.hh
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
#ifndef GZ_UTILITIES_SUPPRESSWARNING_HH_
#define GZ_UTILITIES_SUPPRESSWARNING_HH_

#include <ignition/utilities/detail/SuppressWarning.hh>
#include <gz/utilities/detail/SuppressWarning.hh>

#pragma message("gz-cmake (utilities) SuppressWarning is deprecated, use gz-utils")

Expand Down

0 comments on commit 2363991

Please sign in to comment.