Updates .h disclaimer with more info. Regenerates headers.

moveit · Nov 28, 2024 · 04f375f · 04f375f
1 parent a10a31a
commit 04f375f
Show file tree

Hide file tree

Showing 376 changed files with 4,143 additions and 1,128 deletions.
diff --git a/moveit/scripts/create_deprecated_headers.py b/moveit/scripts/create_deprecated_headers.py
@@ -38,6 +38,21 @@
 from pathlib import Path
 
 
+DISCLAIMER = """
+/*********************************************************************
+ * All MoveIt 2 headers have been updated to use the .hpp extension.
+ *
+ * .h headers are now autogenerated via {},
+ * and will import the corresponding .hpp with a deprecation warning.
+ *
+ * imports via .h files may be removed in future releases, so please
+ * modify your imports to use the corresponding .hpp imports.
+ *
+ * See https://github.com/moveit/moveit2/pull/3113 for extra details.
+ *********************************************************************/
+"""
+
+
 class NoIncludeGuard(Exception):
     ERROR = "No include guard found in {}.hpp. Unable to generate pretext."
 
@@ -86,13 +101,13 @@ class DeprecatedHeader:
     def __init__(self, hpp: HppFile):
         self.hpp = hpp
         self.path = hpp.path.with_suffix(".h")
-        self.prefix = f"/* This file was autogenerated by {Path(__file__).name} */"
         self.warn = '#pragma message(".h header is obsolete. Please use the .hpp header instead.")'
         self.contents = self.contents()
 
     def contents(self) -> str:
-        items = [self.prefix, self.hpp.pretext, self.warn, self.hpp.include]
-        return "\n\n".join(items) + "\n"
+        disclaimer = DISCLAIMER.format(Path(__file__).name).rstrip("\n")
+        items = [disclaimer, self.hpp.pretext, self.warn, self.hpp.include]
+        return "\n".join(items) + "\n"
 
 
 class HeaderSummary:

diff --git a/...ction/include/moveit/collision_detection/allvalid/collision_detector_allocator_allvalid.h b/...ction/include/moveit/collision_detection/allvalid/collision_detector_allocator_allvalid.h
@@ -1,5 +1,15 @@
-/* This file was autogenerated by create_deprecated_headers.py */
 
+/*********************************************************************
+ * All MoveIt 2 headers have been updated to use the .hpp extension.
+ *
+ * .h headers are now autogenerated via create_deprecated_headers.py,
+ * and will import the corresponding .hpp with a deprecation warning.
+ *
+ * imports via .h files may be removed in future releases, so please
+ * modify your imports to use the corresponding .hpp imports.
+ *
+ * See https://github.com/moveit/moveit2/pull/3113 for extra details.
+ *********************************************************************/
 /*********************************************************************
  * Software License Agreement (BSD License)
  *
@@ -37,7 +47,5 @@
 /* Author: Acorn Pooley, Ioan Sucan */
 
 #pragma once
-
 #pragma message(".h header is obsolete. Please use the .hpp header instead.")
-
 #include <moveit/collision_detection/allvalid/collision_detector_allocator_allvalid.hpp>
diff --git a/.../collision_detection/include/moveit/collision_detection/allvalid/collision_env_allvalid.h b/.../collision_detection/include/moveit/collision_detection/allvalid/collision_env_allvalid.h
@@ -1,5 +1,15 @@
-/* This file was autogenerated by create_deprecated_headers.py */
 
+/*********************************************************************
+ * All MoveIt 2 headers have been updated to use the .hpp extension.
+ *
+ * .h headers are now autogenerated via create_deprecated_headers.py,
+ * and will import the corresponding .hpp with a deprecation warning.
+ *
+ * imports via .h files may be removed in future releases, so please
+ * modify your imports to use the corresponding .hpp imports.
+ *
+ * See https://github.com/moveit/moveit2/pull/3113 for extra details.
+ *********************************************************************/
 /*********************************************************************
  * Software License Agreement (BSD License)
  *
@@ -37,7 +47,5 @@
 /* Author: Ioan Sucan, Jia Pan, Jens Petit */
 
 #pragma once
-
 #pragma message(".h header is obsolete. Please use the .hpp header instead.")
-
 #include <moveit/collision_detection/allvalid/collision_env_allvalid.hpp>
diff --git a/moveit_core/collision_detection/include/moveit/collision_detection/collision_common.h b/moveit_core/collision_detection/include/moveit/collision_detection/collision_common.h
@@ -1,5 +1,15 @@
-/* This file was autogenerated by create_deprecated_headers.py */
 
+/*********************************************************************
+ * All MoveIt 2 headers have been updated to use the .hpp extension.
+ *
+ * .h headers are now autogenerated via create_deprecated_headers.py,
+ * and will import the corresponding .hpp with a deprecation warning.
+ *
+ * imports via .h files may be removed in future releases, so please
+ * modify your imports to use the corresponding .hpp imports.
+ *
+ * See https://github.com/moveit/moveit2/pull/3113 for extra details.
+ *********************************************************************/
 /*********************************************************************
  * Software License Agreement (BSD License)
  *
@@ -37,7 +47,5 @@
 /* Author: Ioan Sucan */
 
 #pragma once
-
 #pragma message(".h header is obsolete. Please use the .hpp header instead.")
-
 #include <moveit/collision_detection/collision_common.hpp>
diff --git a/...ore/collision_detection/include/moveit/collision_detection/collision_detector_allocator.h b/...ore/collision_detection/include/moveit/collision_detection/collision_detector_allocator.h
@@ -1,5 +1,15 @@
-/* This file was autogenerated by create_deprecated_headers.py */
 
+/*********************************************************************
+ * All MoveIt 2 headers have been updated to use the .hpp extension.
+ *
+ * .h headers are now autogenerated via create_deprecated_headers.py,
+ * and will import the corresponding .hpp with a deprecation warning.
+ *
+ * imports via .h files may be removed in future releases, so please
+ * modify your imports to use the corresponding .hpp imports.
+ *
+ * See https://github.com/moveit/moveit2/pull/3113 for extra details.
+ *********************************************************************/
 /*********************************************************************
  * Software License Agreement (BSD License)
  *
@@ -37,7 +47,5 @@
 /* Author: Acorn Pooley, Ioan Sucan */
 
 #pragma once
-
 #pragma message(".h header is obsolete. Please use the .hpp header instead.")
-
 #include <moveit/collision_detection/collision_detector_allocator.hpp>
diff --git a/moveit_core/collision_detection/include/moveit/collision_detection/collision_env.h b/moveit_core/collision_detection/include/moveit/collision_detection/collision_env.h
@@ -1,5 +1,15 @@
-/* This file was autogenerated by create_deprecated_headers.py */
 
+/*********************************************************************
+ * All MoveIt 2 headers have been updated to use the .hpp extension.
+ *
+ * .h headers are now autogenerated via create_deprecated_headers.py,
+ * and will import the corresponding .hpp with a deprecation warning.
+ *
+ * imports via .h files may be removed in future releases, so please
+ * modify your imports to use the corresponding .hpp imports.
+ *
+ * See https://github.com/moveit/moveit2/pull/3113 for extra details.
+ *********************************************************************/
 /*********************************************************************
  * Software License Agreement (BSD License)
  *
@@ -37,7 +47,5 @@
 /* Author: Ioan Sucan, Jens Petit */
 
 #pragma once
-
 #pragma message(".h header is obsolete. Please use the .hpp header instead.")
-
 #include <moveit/collision_detection/collision_env.hpp>
diff --git a/moveit_core/collision_detection/include/moveit/collision_detection/collision_matrix.h b/moveit_core/collision_detection/include/moveit/collision_detection/collision_matrix.h
@@ -1,5 +1,15 @@
-/* This file was autogenerated by create_deprecated_headers.py */
 
+/*********************************************************************
+ * All MoveIt 2 headers have been updated to use the .hpp extension.
+ *
+ * .h headers are now autogenerated via create_deprecated_headers.py,
+ * and will import the corresponding .hpp with a deprecation warning.
+ *
+ * imports via .h files may be removed in future releases, so please
+ * modify your imports to use the corresponding .hpp imports.
+ *
+ * See https://github.com/moveit/moveit2/pull/3113 for extra details.
+ *********************************************************************/
 /*********************************************************************
  * Software License Agreement (BSD License)
  *
@@ -37,7 +47,5 @@
 /* Author: Ioan Sucan, E. Gil Jones */
 
 #pragma once
-
 #pragma message(".h header is obsolete. Please use the .hpp header instead.")
-
 #include <moveit/collision_detection/collision_matrix.hpp>
diff --git a/...it_core/collision_detection/include/moveit/collision_detection/collision_octomap_filter.h b/...it_core/collision_detection/include/moveit/collision_detection/collision_octomap_filter.h
@@ -1,5 +1,15 @@
-/* This file was autogenerated by create_deprecated_headers.py */
 
+/*********************************************************************
+ * All MoveIt 2 headers have been updated to use the .hpp extension.
+ *
+ * .h headers are now autogenerated via create_deprecated_headers.py,
+ * and will import the corresponding .hpp with a deprecation warning.
+ *
+ * imports via .h files may be removed in future releases, so please
+ * modify your imports to use the corresponding .hpp imports.
+ *
+ * See https://github.com/moveit/moveit2/pull/3113 for extra details.
+ *********************************************************************/
 /*********************************************************************
  * Software License Agreement (BSD License)
  *
@@ -37,7 +47,5 @@
 /* Author: Adam Leeper */
 
 #pragma once
-
 #pragma message(".h header is obsolete. Please use the .hpp header instead.")
-
 #include <moveit/collision_detection/collision_octomap_filter.hpp>
diff --git a/moveit_core/collision_detection/include/moveit/collision_detection/collision_plugin.h b/moveit_core/collision_detection/include/moveit/collision_detection/collision_plugin.h
@@ -1,5 +1,15 @@
-/* This file was autogenerated by create_deprecated_headers.py */
 
+/*********************************************************************
+ * All MoveIt 2 headers have been updated to use the .hpp extension.
+ *
+ * .h headers are now autogenerated via create_deprecated_headers.py,
+ * and will import the corresponding .hpp with a deprecation warning.
+ *
+ * imports via .h files may be removed in future releases, so please
+ * modify your imports to use the corresponding .hpp imports.
+ *
+ * See https://github.com/moveit/moveit2/pull/3113 for extra details.
+ *********************************************************************/
 /*********************************************************************
  * Software License Agreement (BSD License)
  *
@@ -35,7 +45,5 @@
  *********************************************************************/
 
 #pragma once
-
 #pragma message(".h header is obsolete. Please use the .hpp header instead.")
-
 #include <moveit/collision_detection/collision_plugin.hpp>
diff --git a/moveit_core/collision_detection/include/moveit/collision_detection/collision_plugin_cache.h b/moveit_core/collision_detection/include/moveit/collision_detection/collision_plugin_cache.h
@@ -1,5 +1,15 @@
-/* This file was autogenerated by create_deprecated_headers.py */
 
+/*********************************************************************
+ * All MoveIt 2 headers have been updated to use the .hpp extension.
+ *
+ * .h headers are now autogenerated via create_deprecated_headers.py,
+ * and will import the corresponding .hpp with a deprecation warning.
+ *
+ * imports via .h files may be removed in future releases, so please
+ * modify your imports to use the corresponding .hpp imports.
+ *
+ * See https://github.com/moveit/moveit2/pull/3113 for extra details.
+ *********************************************************************/
 /*********************************************************************
  * Software License Agreement (BSD License)
  *
@@ -35,7 +45,5 @@
  *********************************************************************/
 
 #pragma once
-
 #pragma message(".h header is obsolete. Please use the .hpp header instead.")
-
 #include <moveit/collision_detection/collision_plugin_cache.hpp>
diff --git a/moveit_core/collision_detection/include/moveit/collision_detection/collision_tools.h b/moveit_core/collision_detection/include/moveit/collision_detection/collision_tools.h
@@ -1,5 +1,15 @@
-/* This file was autogenerated by create_deprecated_headers.py */
 
+/*********************************************************************
+ * All MoveIt 2 headers have been updated to use the .hpp extension.
+ *
+ * .h headers are now autogenerated via create_deprecated_headers.py,
+ * and will import the corresponding .hpp with a deprecation warning.
+ *
+ * imports via .h files may be removed in future releases, so please
+ * modify your imports to use the corresponding .hpp imports.
+ *
+ * See https://github.com/moveit/moveit2/pull/3113 for extra details.
+ *********************************************************************/
 /*********************************************************************
  * Software License Agreement (BSD License)
  *
@@ -37,7 +47,5 @@
 /* Author: Ioan Sucan */
 
 #pragma once
-
 #pragma message(".h header is obsolete. Please use the .hpp header instead.")
-
 #include <moveit/collision_detection/collision_tools.hpp>
diff --git a/moveit_core/collision_detection/include/moveit/collision_detection/occupancy_map.h b/moveit_core/collision_detection/include/moveit/collision_detection/occupancy_map.h
@@ -1,5 +1,15 @@
-/* This file was autogenerated by create_deprecated_headers.py */
 
+/*********************************************************************
+ * All MoveIt 2 headers have been updated to use the .hpp extension.
+ *
+ * .h headers are now autogenerated via create_deprecated_headers.py,
+ * and will import the corresponding .hpp with a deprecation warning.
+ *
+ * imports via .h files may be removed in future releases, so please
+ * modify your imports to use the corresponding .hpp imports.
+ *
+ * See https://github.com/moveit/moveit2/pull/3113 for extra details.
+ *********************************************************************/
 /*********************************************************************
  * Software License Agreement (BSD License)
  *
@@ -37,7 +47,5 @@
 /* Author: Ioan Sucan, Jon Binney */
 
 #pragma once
-
 #pragma message(".h header is obsolete. Please use the .hpp header instead.")
-
 #include <moveit/collision_detection/occupancy_map.hpp>
diff --git a/...core/collision_detection/include/moveit/collision_detection/test_collision_common_panda.h b/...core/collision_detection/include/moveit/collision_detection/test_collision_common_panda.h
@@ -1,5 +1,15 @@
-/* This file was autogenerated by create_deprecated_headers.py */
 
+/*********************************************************************
+ * All MoveIt 2 headers have been updated to use the .hpp extension.
+ *
+ * .h headers are now autogenerated via create_deprecated_headers.py,
+ * and will import the corresponding .hpp with a deprecation warning.
+ *
+ * imports via .h files may be removed in future releases, so please
+ * modify your imports to use the corresponding .hpp imports.
+ *
+ * See https://github.com/moveit/moveit2/pull/3113 for extra details.
+ *********************************************************************/
 /*********************************************************************
  * Software License Agreement (BSD License)
  *
@@ -37,7 +47,5 @@
 /* Author: Jens Petit */
 
 #pragma once
-
 #pragma message(".h header is obsolete. Please use the .hpp header instead.")
-
 #include <moveit/collision_detection/test_collision_common_panda.hpp>
diff --git a/...t_core/collision_detection/include/moveit/collision_detection/test_collision_common_pr2.h b/...t_core/collision_detection/include/moveit/collision_detection/test_collision_common_pr2.h
@@ -1,5 +1,15 @@
-/* This file was autogenerated by create_deprecated_headers.py */
 
+/*********************************************************************
+ * All MoveIt 2 headers have been updated to use the .hpp extension.
+ *
+ * .h headers are now autogenerated via create_deprecated_headers.py,
+ * and will import the corresponding .hpp with a deprecation warning.
+ *
+ * imports via .h files may be removed in future releases, so please
+ * modify your imports to use the corresponding .hpp imports.
+ *
+ * See https://github.com/moveit/moveit2/pull/3113 for extra details.
+ *********************************************************************/
 /*********************************************************************
  * Software License Agreement (BSD License)
  *
@@ -37,7 +47,5 @@
 /* Author: E. Gil Jones */
 
 #pragma once
-
 #pragma message(".h header is obsolete. Please use the .hpp header instead.")
-
 #include <moveit/collision_detection/test_collision_common_pr2.hpp>
diff --git a/moveit_core/collision_detection/include/moveit/collision_detection/world.h b/moveit_core/collision_detection/include/moveit/collision_detection/world.h
@@ -1,5 +1,15 @@
-/* This file was autogenerated by create_deprecated_headers.py */
 
+/*********************************************************************
+ * All MoveIt 2 headers have been updated to use the .hpp extension.
+ *
+ * .h headers are now autogenerated via create_deprecated_headers.py,
+ * and will import the corresponding .hpp with a deprecation warning.
+ *
+ * imports via .h files may be removed in future releases, so please
+ * modify your imports to use the corresponding .hpp imports.
+ *
+ * See https://github.com/moveit/moveit2/pull/3113 for extra details.
+ *********************************************************************/
 /*********************************************************************
  * Software License Agreement (BSD License)
  *
@@ -37,7 +47,5 @@
 /* Author: Ioan Sucan, Acorn Pooley, Sachin Chitta */
 
 #pragma once
-
 #pragma message(".h header is obsolete. Please use the .hpp header instead.")
-
 #include <moveit/collision_detection/world.hpp>