Merge branch 'ign-utils1' into scpeters/actions_v3

CMakeLists.txt

@@ -15,7 +15,10 @@ find_package(ignition-cmake2 2.14.0 REQUIRED)
 # Configure the project
 #============================================================================
 set(c++standard 17)
-ign_configure_project(VERSION_SUFFIX)
+ign_configure_project(
+ REPLACE_IGNITION_INCLUDE_PATH gz/utils
+ VERSION_SUFFIX
+)
 
 #============================================================================
 # Set project-specific options

CODE_OF_CONDUCT.md

@@ -56,7 +56,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [https://ignitionrobotics.org/support](https://ignitionrobotics.org/support). All
+reported by contacting the project team at [https://gazebosim.org/support](https://gazebosim.org/support). All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

CONTRIBUTING.md

@@ -1 +1 @@
-See the [Ignition Robotics contributing guide](https://ignitionrobotics.org/docs/all/contributing).
+See the [Gazebo contributing guide](https://gazebosim.org/docs/all/contributing).

Migration.md

@@ -5,12 +5,12 @@ Deprecated code produces compile-time warnings. These warning serve as
 notification to users that their code should be upgraded. The next major
 release will remove the deprecated code.
 
-## Ignition Utils 1.2 to 1.3
+## Gazebo Utils 1.2 to 1.3
 
 Recommended migration:
 Utils 1.3.0 introduces the `ExtraTestMacros.hh` headers that are also in ign-cmake.
 This is an effort to remove all headers from ign-cmake and locate them in ign-utils.
 To update, replace all instances of `ignition/utilities/ExtraTestMacros.hh` with `ignition/utils/ExtraTestMacros.hh`
 In the future, `ignition/utilities/ExtraTestMacros.hh` will be removed from ign-cmake.
 
-## Ignition Utils 0.X to 1.X
+## Gazebo Utils 0.X to 1.X

README.md

@@ -1,21 +1,20 @@
-# Ignition Utils : Classes and functions for robot applications
+# Gazebo Utils : Classes and functions for robot applications
 
 **Maintainer:** addisu AT openrobotics DOT org
 
-[![GitHub open issues](https://img.shields.io/github/issues-raw/ignitionrobotics/ign-utils.svg)](https:/ignitionrobotics/ign-utils/issues)
-[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/ignitionrobotics/ign-utils.svg)](https:/ignitionrobotics/ign-utils/pulls)
+[![GitHub open issues](https://img.shields.io/github/issues-raw/gazebosim/gz-utils.svg)](https:/gazebosim/gz-utils/issues)
+[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/gazebosim/gz-utils.svg)](https:/gazebosim/gz-utils/pulls)
 [![Discourse topics](https://img.shields.io/discourse/https/community.gazebosim.org/topics.svg)](https://community.gazebosim.org)
 [![Hex.pm](https://img.shields.io/hexpm/l/plug.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 
 Build | Status
 -- | --
-Test coverage | [![codecov](https://codecov.io/gh/ignitionrobotics/ign-utils/branch/main/graph/badge.svg)](https://codecov.io/gh/ignitionrobotics/ign-utils)
+Test coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-utils/branch/main/graph/badge.svg)](https://codecov.io/gh/gazebosim/gz-utils)
 Ubuntu Bionic | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_utils-ci-main-bionic-amd64)](https://build.osrfoundation.org/job/ignition_utils-ci-main-bionic-amd64)
 Homebrew | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_utils-ci-main-homebrew-amd64)](https://build.osrfoundation.org/job/ignition_utils-ci-main-homebrew-amd64)
 Windows | [![Build Status](https://build.osrfoundation.org/job/ign_utils-ci-win/badge/icon)](https://build.osrfoundation.org/job/ign_utils-ci-win/)
 
-Ignition Utils, a component of [Ignition
-Robotics](https://ignitionrobotics.org), provides general purpose
+Gazebo Utils, a component of [Gazebo](https://gazebosim.org), provides general purpose
 classes and functions designed for robotic applications.
 
 # Table of Contents
@@ -42,23 +41,23 @@ classes and functions designed for robotic applications.
 
 # Features
 
-Ignition Utils provides a wide range of functionality, including:
+Gazebo Utils provides a wide range of functionality, including:
 
 * A helper class to implement the PIMPL pattern
 * A command line parsing utility (vendored [CLI11](https:/CLIUtils/CLI11/))
 * Macros to suppress warnings
 
 # Install
 
-See the [installation tutorial](https://ignitionrobotics.org/api/utils/0.1/install.html).
+See the [installation tutorial](https://gazebosim.org/api/utils/0.1/install.html).
 
 # Usage
 
-Please refer to the [examples directory](https:/ignitionrobotics/ign-utils/blob/main/examples/).
+Please refer to the [examples directory](https:/gazebosim/gz-utils/blob/main/examples/).
 
 # Documentation
 
-API and tutorials can be found at [https://ignitionrobotics.org/libs/utils](https://ignitionrobotics.org/libs/utils).
+API and tutorials can be found at [https://gazebosim.org/libs/utils](https://gazebosim.org/libs/utils).
 
 You can also generate the documentation from a clone of this repository by following these steps.
 
@@ -71,13 +70,13 @@ You can also generate the documentation from a clone of this repository by follo
 2. Clone the repository
 
  ```
- git clone https:/ignitionrobotics/ign-utils
+ git clone https:/gazebosim/gz-utils
  ```
 
 3. Configure and build the documentation.
 
  ```
- cd ign-utils; mkdir build; cd build; cmake ../; make doc
+ cd gz-utils; mkdir build; cd build; cmake ../; make doc
  ```
 
 4. View the documentation by running the following command from the build directory.
@@ -90,7 +89,7 @@ You can also generate the documentation from a clone of this repository by follo
 
 Follow these steps to run tests and static code analysis in your clone of this repository.
 
-1. Follow the [source install instruction](https://ignitionrobotics.org/libs/utils#source-install).
+1. Follow the [source install instruction](https://gazebosim.org/libs/utils#source-install).
 
 2. Run tests.
 
@@ -109,9 +108,9 @@ Follow these steps to run tests and static code analysis in your clone of this r
 Refer to the following table for information about important directories and files in this repository.
 
 ```
-ign-utils
+gz-utils
 ├── examples Example programs.
-├── include/ignition/utils Header files.
+├── include/gz/utils  Header files.
 ├── src Source files and unit tests.
 ├── test
 │ ├── integration Integration tests.
@@ -124,27 +123,27 @@ ign-utils
 # Contributing
 
 Please see
-[CONTRIBUTING.md](https://ignitionrobotics.org/docs/all/contributing).
+[CONTRIBUTING.md](https://gazebosim.org/docs/all/contributing).
 
 # Code of Conduct
 
 Please see
-[CODE_OF_CONDUCT.md](https:/ignitionrobotics/ign-utils/blob/main/CODE_OF_CONDUCT.md)
+[CODE_OF_CONDUCT.md](https:/gazebosim/gz-utils/blob/main/CODE_OF_CONDUCT.md)
 
 # Versioning
 
 This library uses [Semantic Versioning](https://semver.org/).
 Additionally, this library is part of the
-[Ignition project](https://ignitionrobotics.org) which periodically
+[Gazebo project](https://gazebosim.org) which periodically
 releases a versioned set of compatible and complimentary libraries. See the
-[Ignition website](https://ignitionrobotics.org) for version and
+[Gazebo website](https://gazebosim.org) for version and
 release information.
 
 # License
 
 This library is licensed under
 [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0).
 See also the
-[LICENSE](https:/ignitionrobotics/ign-utils/blob/main/LICENSE)
+[LICENSE](https:/gazebosim/gz-utils/blob/main/LICENSE)
 file.
 

api.md.in

@@ -1,6 +1,6 @@
-## Ignition @IGN_DESIGNATION_CAP@
+## Gazebo @IGN_DESIGNATION_CAP@
 
-Ignition @IGN_DESIGNATION_CAP@ is a component in Ignition Robotics, a set of
+Gazebo @IGN_DESIGNATION_CAP@ is a component in Gazebo Robotics, a set of
 libraries designed to rapidly develop robot and simulation applications.
 This library defines a general set of utilities with an eye toward simulation
 and robotics.

cli/README.md

@@ -1,4 +1,4 @@
-Ignition CLI component
+Gazebo CLI component
 
 Vendored from https:/CLIUtils/CLI11/
 

cli/include/CMakeLists.txt

@@ -4,15 +4,16 @@
 # target_include_directories(@tgt@ INTERFACE "$<BUILD_INTERFACE:@incl_dirs>")
 # that for the usual include directories are handled by ign_add_component
 if(IGN_UTILS_VENDOR_CLI11)
- add_subdirectory(vendored-cli/ignition/utils)
- target_include_directories(${ign_utils_cli_target_name} 
+ add_subdirectory(vendored-cli)
+ target_include_directories(${ign_utils_cli_target_name}
  INTERFACE
  "$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/cli/include/vendored-cli>")
 else()
- add_subdirectory(external-cli/ignition/utils)
- target_include_directories(${ign_utils_cli_target_name} 
- INTERFACE 
+ add_subdirectory(external-cli)
+ target_include_directories(${ign_utils_cli_target_name}
+ INTERFACE
  "$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/cli/include/external-cli>")
 endif()
 
-add_subdirectory(ignition/utils)
+add_subdirectory(gz/utils)
+install(DIRECTORY ignition DESTINATION ${IGN_INCLUDE_INSTALL_DIR_FULL})

cli/include/external-cli/CMakeLists.txt

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

cli/include/external-cli/gz/utils/cli/App.hpp

@@ -0,0 +1,18 @@
+/*
+ * Copyright (C) 2021 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.
+ *
+ */
+
+#include <CLI/App.hpp>

cli/include/external-cli/gz/utils/cli/CLI.hpp

@@ -0,0 +1,18 @@
+/*
+ * Copyright (C) 2021 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.
+ *
+ */
+
+#include <CLI/CLI.hpp>

cli/include/external-cli/gz/utils/cli/Config.hpp

@@ -0,0 +1,18 @@
+/*
+ * Copyright (C) 2021 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.
+ *
+ */
+
+#include <CLI/Config.hpp>

cli/include/external-cli/gz/utils/cli/ConfigFwd.hpp

@@ -0,0 +1,18 @@
+/*
+ * Copyright (C) 2021 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.
+ *
+ */
+
+#include <CLI/ConfigFwd.hpp>

cli/include/external-cli/gz/utils/cli/Error.hpp

@@ -0,0 +1,18 @@
+/*
+ * Copyright (C) 2021 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.
+ *
+ */
+
+#include <CLI/Error.hpp>

cli/include/external-cli/gz/utils/cli/Formatter.hpp

@@ -0,0 +1,18 @@
+/*
+ * Copyright (C) 2021 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.
+ *
+ */
+
+#include <CLI/Formatter.hpp>

cli/include/external-cli/gz/utils/cli/FormatterFwd.hpp

@@ -0,0 +1,18 @@
+/*
+ * Copyright (C) 2021 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.
+ *
+ */
+
+#include <CLI/FormatterFwd.hpp>

cli/include/external-cli/gz/utils/cli/Macros.hpp

@@ -0,0 +1,18 @@
+/*
+ * Copyright (C) 2021 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.
+ *
+ */
+
+#include <CLI/Macros.hpp>

cli/include/external-cli/gz/utils/cli/Option.hpp

@@ -0,0 +1,18 @@
+/*
+ * Copyright (C) 2021 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.
+ *
+ */
+
+#include <CLI/Option.hpp>

cli/include/external-cli/gz/utils/cli/Split.hpp

@@ -0,0 +1,18 @@
+/*
+ * Copyright (C) 2021 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.
+ *
+ */
+
+#include <CLI/Split.hpp>