Example package using macro (again proving dependency hygiene

Author: carter

Cargo.lock

@@ -2,6 +2,7 @@
 
 members = [
     "example_package",
+    "example_package_macro",
     "roslibrust",
     "roslibrust_codegen",
     "roslibrust_codegen_macro",

Cargo.toml

@@ -1,4 +1,5 @@
 # Example RosLibRust Package
+
 The point of this package is provide a good example of how to integrate roslibrust into a package using a build.rs file.
 
 This package also serves as a testbed for maintainers of roslibrust to refine build.rs integration.

example_package/README.md

@@ -0,0 +1,11 @@
+[package]
+name = "example_package_macro"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+# The code generated by roslibrust_codegen has dependendencies
+# We need to depend on the crate at build time so that the generate code has access to these dependencies
+roslibrust_codegen = { path = "../roslibrust_codegen" }
+# This crate contains the actual macro we will invoke
+roslibrust_codegen_macro = { path = "../roslibrust_codegen_macro" }

example_package_macro/Cargo.toml

@@ -0,0 +1,5 @@
+# Example RosLibRust Package
+
+The point of this package is provide a good example of how to integrate roslibrust into a package using the proc macro.
+
+This package also serves as a testbed for maintainers of roslibrust to refine proc macro integration.

example_package_macro/README.md

@@ -0,0 +1,20 @@
+roslibrust_codegen_macro::find_and_generate_ros_messages!(
+    "assets/ros1_test_msgs",
+    "assets/ros1_common_interfaces"
+);
+
+// Example of 'use' pointing to code created by the include! macro
+mod submodule {
+    #[allow(unused_imports)]
+    use crate::std_msgs::Header;
+}
+
+// Our actual "main" here doesn't do much, just shows the generate types
+// are here and real.
+fn main() {
+    // Note: within our assets there is a folder named ros1_test_msgs which contains a ros package
+    // The ros package in its package.xml refers to the name of that package as test_msgs
+    // The module that is generated will use the name in package.xml and not the directory
+    let data = test_msgs::Constants::TEST_STR;
+    println!("Hello World! {data}");
+}