Generate messages in downstream builds by mjcarroll · Pull Request #338 · gazebosim/gz-msgs

mjcarroll · 2023-05-11T19:56:53Z

This is a rework of how message generation works. Instead of generating source/headers from proto files as part of building the gz-msgs package, it will instead install scripts and cmake helper functions to allow downstream packages to generate messages as part of their builds.

An example of a downstream package utilizing this: https://github.com/mjcarroll/mjcarroll-custom-msgs

This is a placeholder PR (keeping in draft) so that I can clean my changes up and get feedback.

Signed-off-by: Michael Carroll <mjcarroll@intrinsic.ai>

* Split into MessageFactory, which is a non-static variant, should help with any potential ODR issues down the road * Refactor Factory to just be wrapper around a message factory singleton * Remove filesystem.hh * General cleanups Signed-off-by: Michael Carroll <mjcarroll@intrinsic.ai>

Signed-off-by: Michael Carroll <mjcarroll@intrinsic.ai>

…carroll/split_factory

Signed-off-by: Michael Carroll <mjcarroll@intrinsic.ai>

ahcorde

I know is still on draft but I made some generic comments

ahcorde · 2023-05-11T21:31:54Z

cmake/gz_msgs_factory.cmake

+#   OUTPUT_CPP_HH_VAR   - A CMake variable name containing a list that the C++ header path should be appended to
+#   OUTPUT_CPP_CC_VAR   - A Cmake variable name containing a list that the C++ source path should be appended to
+# Multi value arguments
+#   INPUT_PROTOS - Passed to protoc --proto_path


indent comment

ahcorde · 2023-05-11T21:32:17Z

cmake/gz_msgs_factory.cmake

+  endforeach()
+
+
+  set(GENERATE_ARGS


Suggested change

endforeach()

set(GENERATE_ARGS

endforeach()

set(GENERATE_ARGS

ahcorde · 2023-05-11T21:32:40Z

cmake/gz_msgs_factory.cmake

+    DEPENDS
+      ${depends_index}


style

Suggested change

DEPENDS

${depends_index}

DEPENDS ${depends_index}

ahcorde · 2023-05-11T21:33:12Z

cmake/gz_msgs_factory.cmake

+#   PROTOC_EXEC         - Path to protoc
+#   INPUT_PROTO         - Path to the input .proto file
+#   OUTPUT_CPP_DIR      - Path where C++ files are saved
+#   OUTPUT_INCLUDES     - A CMake variable name containing a list that the C++ header path should be appended to


Suggested change

# OUTPUT_INCLUDES - A CMake variable name containing a list that the C++ header path should be appended to

# OUTPUT_INCLUDES - A CMake variable name containing a list that the C++ include path should be appended to

ahcorde · 2023-05-11T21:33:22Z

cmake/gz_msgs_protoc.cmake

+#   PROTOC_EXEC         - Path to protoc
+#   INPUT_PROTO         - Path to the input .proto file
+#   OUTPUT_CPP_DIR      - Path where C++ files are saved
+#   OUTPUT_INCLUDES     - A CMake variable name containing a list that the C++ header path should be appended to


Suggested change

# OUTPUT_INCLUDES - A CMake variable name containing a list that the C++ header path should be appended to

# OUTPUT_INCLUDES - A CMake variable name containing a list that the C++ include path should be appended to

ahcorde · 2023-05-11T21:39:22Z

core/src/DynamicFactory.hh

@@ -0,0 +1,87 @@
+/*
+ * Copyright (C) 2016 Open Source Robotics Foundation


Suggested change

* Copyright (C) 2016 Open Source Robotics Foundation

* Copyright (C) 2023 Open Source Robotics Foundation

ahcorde · 2023-05-11T21:39:44Z

core/src/Factory.cc

@@ -0,0 +1,61 @@
+/*
+ * Copyright (C) 2016 Open Source Robotics Foundation


Suggested change

* Copyright (C) 2016 Open Source Robotics Foundation

* Copyright (C) 2023 Open Source Robotics Foundation

ahcorde · 2023-05-11T21:39:53Z

core/src/MessageFactory.cc

@@ -0,0 +1,107 @@
+/*
+ * Copyright (C) 2016 Open Source Robotics Foundation


Suggested change

* Copyright (C) 2016 Open Source Robotics Foundation

* Copyright (C) 2023 Open Source Robotics Foundation

ahcorde · 2023-05-11T21:40:32Z

test/CMakeLists.txt

-add_subdirectory(integration)
-add_subdirectory(performance)
-add_subdirectory(regression)
+#add_subdirectory(gtest_vendor)


ahcorde · 2023-05-11T21:40:44Z

tools/gz_msgs_generate_factory.py

@@ -0,0 +1,165 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2022 Open Source Robotics Foundation


Suggested change

# Copyright (C) 2022 Open Source Robotics Foundation

# Copyright (C) 2023 Open Source Robotics Foundation

mjcarroll · 2023-05-18T13:10:54Z

@ahcorde I think I addressed most of this feedback in #339 where I also split the commits a bit more logically. I'm going to close this PR in favor of that one.

mjcarroll added 7 commits April 3, 2023 17:36

Remove ignition namespaced files for msgs10

5ddcd8e

Signed-off-by: Michael Carroll <mjcarroll@intrinsic.ai>

Merge branch 'main' into mjcarroll/split_factory

7467ace

Fix environment variable

b9ea260

Signed-off-by: Michael Carroll <mjcarroll@intrinsic.ai>

Merge remote-tracking branch 'origin/mjcarroll/split_factory' into mj…

64af2b5

…carroll/split_factory

@wip

de3daa3

Signed-off-by: Michael Carroll <mjcarroll@intrinsic.ai>

New message generation pipeline for gz-msgs

ce3c64e

Signed-off-by: Michael Carroll <mjcarroll@intrinsic.ai>

github-actions bot added the 🎵 harmonic Gazebo Harmonic label May 11, 2023

mjcarroll added 2 commits May 11, 2023 19:58

Merge branch 'main' into mjcarroll/rework-message-generation

168ea5b

Signed-off-by: Michael Carroll <mjcarroll@intrinsic.ai>

Restore Utility file

792f265

Signed-off-by: Michael Carroll <mjcarroll@intrinsic.ai>

mjcarroll mentioned this pull request May 11, 2023

Generate messages in downstream builds #339

Merged

5 tasks

ahcorde requested changes May 11, 2023

View reviewed changes

mjcarroll closed this May 18, 2023

mjcarroll deleted the mjcarroll/rework-message-generation branch June 22, 2023 18:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Generate messages in downstream builds#338

Generate messages in downstream builds#338
mjcarroll wants to merge 9 commits intomainfrom
mjcarroll/rework-message-generation

mjcarroll commented May 11, 2023

Uh oh!

ahcorde left a comment

Uh oh!

ahcorde May 11, 2023

Uh oh!

ahcorde May 11, 2023

Uh oh!

ahcorde May 11, 2023

Uh oh!

ahcorde May 11, 2023

Uh oh!

ahcorde May 11, 2023

Uh oh!

ahcorde May 11, 2023

Uh oh!

ahcorde May 11, 2023

Uh oh!

ahcorde May 11, 2023

Uh oh!

ahcorde May 11, 2023

Uh oh!

ahcorde May 11, 2023

Uh oh!

mjcarroll commented May 18, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	# OUTPUT_INCLUDES - A CMake variable name containing a list that the C++ header path should be appended to
	# OUTPUT_INCLUDES - A CMake variable name containing a list that the C++ include path should be appended to

		@@ -0,0 +1,87 @@
		/*
		* Copyright (C) 2016 Open Source Robotics Foundation

	* Copyright (C) 2016 Open Source Robotics Foundation
	* Copyright (C) 2023 Open Source Robotics Foundation

		@@ -0,0 +1,61 @@
		/*
		* Copyright (C) 2016 Open Source Robotics Foundation

		@@ -0,0 +1,107 @@
		/*
		* Copyright (C) 2016 Open Source Robotics Foundation

	# Copyright (C) 2022 Open Source Robotics Foundation
	# Copyright (C) 2023 Open Source Robotics Foundation

Conversation

mjcarroll commented May 11, 2023

Uh oh!

ahcorde left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mjcarroll commented May 18, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants