add capnp::generated_code macro

dwrensha · dwrensha · commit 2a083a7a83ec · 2025-07-25T11:16:20.000-04:00
diff --git a/benchmark/benchmark.rs b/benchmark/benchmark.rs
@@ -26,19 +26,15 @@ use capnp::{message, serialize, serialize_packed};
 
 pub mod common;
 
-pub mod carsales_capnp {
-    include!(concat!(env!("OUT_DIR"), "/carsales_capnp.rs"));
-}
+capnp::generated_code!(pub mod carsales_capnp, "carsales_capnp.rs");
+
 pub mod carsales;
 
-pub mod catrank_capnp {
-    include!(concat!(env!("OUT_DIR"), "/catrank_capnp.rs"));
-}
+capnp::generated_code!(pub mod catrank_capnp, "catrank_capnp.rs");
+
 pub mod catrank;
 
-pub mod eval_capnp {
-    include!(concat!(env!("OUT_DIR"), "/eval_capnp.rs"));
-}
+capnp::generated_code!(pub mod eval_capnp, "eval_capnp.rs");
 
 pub mod eval;
 
diff --git a/capnp-futures/test/test.rs b/capnp-futures/test/test.rs
@@ -19,9 +19,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
-pub mod addressbook_capnp {
-    include!(concat!(env!("OUT_DIR"), "/addressbook_capnp.rs"));
-}
+capnp::generated_code!(pub mod addressbook_capnp, "addressbook_capnp.rs");
 
 #[cfg(test)]
 mod tests {
diff --git a/capnp-rpc/README.md b/capnp-rpc/README.md
@@ -42,9 +42,7 @@ fn main() {
 and you can include the generated code in your project like this:
 
 ```rust
-pub mod foo_capnp {
-  include!(concat!(env!("OUT_DIR"), "/foo_capnp.rs"));
-}
+capnp::generated_code!(pub mod foo_capnp, "foo_capnp.rs");
 ```
 
 ## Calling methods on an RPC object
diff --git a/capnp-rpc/examples/calculator/main.rs b/capnp-rpc/examples/calculator/main.rs
@@ -19,9 +19,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
-pub mod calculator_capnp {
-    include!(concat!(env!("OUT_DIR"), "/calculator_capnp.rs"));
-}
+capnp::generated_code!(pub mod calculator_capnp, "calculator_capnp.rs");
 
 pub mod client;
 pub mod server;
diff --git a/capnp-rpc/examples/hello-world/main.rs b/capnp-rpc/examples/hello-world/main.rs
@@ -19,9 +19,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
-pub mod hello_world_capnp {
-    include!(concat!(env!("OUT_DIR"), "/hello_world_capnp.rs"));
-}
+capnp::generated_code!(pub mod hello_world_capnp, "hello_world_capnp.rs");
 
 pub mod client;
 pub mod server;
diff --git a/capnp-rpc/examples/pubsub/main.rs b/capnp-rpc/examples/pubsub/main.rs
@@ -19,9 +19,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
-pub mod pubsub_capnp {
-    include!(concat!(env!("OUT_DIR"), "/pubsub_capnp.rs"));
-}
+capnp::generated_code!(pub mod pubsub_capnp, "pubsub_capnp.rs");
 
 pub mod client;
 pub mod server;
diff --git a/capnp-rpc/examples/reconnect/main.rs b/capnp-rpc/examples/reconnect/main.rs
@@ -19,9 +19,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
-pub mod foo_capnp {
-    include!(concat!(env!("OUT_DIR"), "/foo_capnp.rs"));
-}
+capnp::generated_code!(pub mod foo_capnp, "foo_capnp.rs");
 
 pub mod client;
 pub mod server;
diff --git a/capnp-rpc/examples/streaming/main.rs b/capnp-rpc/examples/streaming/main.rs
@@ -1,6 +1,4 @@
-pub mod streaming_capnp {
-    include!(concat!(env!("OUT_DIR"), "/streaming_capnp.rs"));
-}
+capnp::generated_code!(pub mod streaming_capnp, "streaming_capnp.rs");
 
 pub mod client;
 pub mod server;
diff --git a/capnp-rpc/test/test.rs b/capnp-rpc/test/test.rs
@@ -29,9 +29,7 @@ use capnp_rpc::{rpc_twoparty_capnp, twoparty, RpcSystem};
 use futures::channel::oneshot;
 use futures::{Future, FutureExt, TryFutureExt};
 
-pub mod test_capnp {
-    include!(concat!(env!("OUT_DIR"), "/test_capnp.rs"));
-}
+capnp::generated_code!(pub mod test_capnp, "test_capnp.rs");
 
 pub mod impls;
 pub mod reconnect_test;
diff --git a/capnp/fuzz/fuzzers/test_all_types.rs b/capnp/fuzz/fuzzers/test_all_types.rs
@@ -1,8 +1,6 @@
 #![no_main]
 
-pub mod test_capnp {
-    include!(concat!(env!("OUT_DIR"), "/test_capnp.rs"));
-}
+capnp::generated_code!(pub mod test_capnp, "test_capnp.rs");
 
 use capnp::{message, serialize};
 use libfuzzer_sys::fuzz_target;
diff --git a/capnp/src/lib.rs b/capnp/src/lib.rs
@@ -64,6 +64,20 @@ pub mod text;
 pub mod text_list;
 pub mod traits;
 
+/// Macro for importing a Rust file generated by a `build.rs` file using
+/// `capnpc::CompilerCommand`.
+///
+/// Typically, a schema file named `foo.capnp` should have a `mod_name`
+/// of `foo_capnp` and a `file_name` of `"foo_capnp.rs"`.
+#[macro_export]
+macro_rules! generated_code {
+    ($vis:vis mod $mod_name:ident, $file_name:literal) => {
+        $vis mod $mod_name {
+            include!(concat!(env!("OUT_DIR"), "/", $file_name));
+        }
+    };
+}
+
 ///
 /// 8 bytes, aligned to an 8-byte boundary.
 ///
diff --git a/capnp/src/message.rs b/capnp/src/message.rs
@@ -46,9 +46,7 @@
 //! `crate::test_data::simple_struct::Owned` type into [TypedReader]/[TypedBuilder]
 //!
 //! ```ignore
-//! mod simple_struct_capnp {
-//!   include!(concat!(env!("OUT_DIR"), "/simple_struct_capnp.rs"));
-//! }
+//! capnp::generated_code!(mod simple_struct_capnp, "simple_struct_capnp.rs");
 //!
 //! use capnp::message::{self, TypedBuilder, TypedReader};
 //! use simple_struct_capnp::simple_struct;
diff --git a/capnpc/rust.capnp b/capnpc/rust.capnp
@@ -21,9 +21,7 @@ annotation parentModule @0xabee386cd1450364 (file) :Text;
 #
 #  pub mod foo {
 #    pub mod bar {
-#      pub mod baz_capnp {
-#        include!(concat!(env!("OUT_DIR"), "/baz_capnp.rs"));
-#      }
+#      capnp::generated_code!(pub mod baz_capnp, "baz_capnp.rs");
 #    }
 #  }
 
diff --git a/capnpc/src/lib.rs b/capnpc/src/lib.rs
@@ -52,13 +52,8 @@
 //! In your lib.rs:
 //!
 //! ```ignore
-//! mod foo_capnp {
-//!     include!(concat!(env!("OUT_DIR"), "/foo_capnp.rs"));
-//! }
-//!
-//! mod bar_capnp {
-//!     include!(concat!(env!("OUT_DIR"), "/bar_capnp.rs"));
-//! }
+//! capnp::generated_code!(mod foo_capnp, "foo_capnp.rs");
+//! capnp::generated_code!(mod bar_capnp, "bar_capnp.rs");
 //! ```
 //!
 //! This will be equivalent to executing the shell command
diff --git a/capnpc/test/test.rs b/capnpc/test/test.rs
@@ -23,60 +23,37 @@
 #![warn(elided_lifetimes_in_paths)]
 #![allow(clippy::bool_assert_comparison)]
 
-pub mod test_capnp {
-    include!(concat!(env!("OUT_DIR"), "/test_capnp.rs"));
-}
+capnp::generated_code!(pub mod test_capnp, "test_capnp.rs");
 
 pub mod foo {
     pub mod bar {
-        pub mod in_submodule_capnp {
-            include!(concat!(env!("OUT_DIR"), "/in_submodule_capnp.rs"));
-        }
+        capnp::generated_code!(pub mod in_submodule_capnp, "in_submodule_capnp.rs");
     }
 }
 
 pub mod baz {
-    pub mod in_other_submodule_capnp {
-        include!(concat!(env!("OUT_DIR"), "/in_other_submodule_capnp.rs"));
-    }
+    capnp::generated_code!(pub mod in_other_submodule_capnp, "in_other_submodule_capnp.rs");
 }
 
 pub mod test_default_parent_module {
     pub mod test_default_parent_module_inner {
         // In build.rs we specify this is the default parent module.
-        pub mod test_default_parent_module_capnp {
-            include!(concat!(
-                env!("OUT_DIR"),
-                "/test_default_parent_module_capnp.rs"
-            ));
-        }
+        capnp::generated_code!(pub mod test_default_parent_module_capnp,
+                               "test_default_parent_module_capnp.rs");
     }
 
     // Put this in somewhere other than the default parent module, to test whether the `parentModule`
     // annotation successfully overrides the default.
-    pub mod test_default_parent_module_override_capnp {
-        include!(concat!(
-            env!("OUT_DIR"),
-            "/test_default_parent_module_override_capnp.rs"
-        ));
-    }
+    capnp::generated_code!(pub mod test_default_parent_module_override_capnp,
+                           "test_default_parent_module_override_capnp.rs");
 }
 
-pub mod test_in_dir_capnp {
-    include!(concat!(env!("OUT_DIR"), "/schema/test_in_dir_capnp.rs"));
-}
+capnp::generated_code!(pub mod test_in_dir_capnp, "schema/test_in_dir_capnp.rs");
 
-pub mod test_in_src_prefix_dir_capnp {
-    // The src_prefix gets stripped away, so the generated code ends up directly in OUT_DIR.
-    include!(concat!(env!("OUT_DIR"), "/test_in_src_prefix_dir_capnp.rs"));
-}
+// The src_prefix gets stripped away, so the generated code ends up directly in OUT_DIR.
+capnp::generated_code!(pub mod test_in_src_prefix_dir_capnp, "test_in_src_prefix_dir_capnp.rs");
 
-pub mod test_output_path_capnp {
-    include!(concat!(
-        env!("OUT_DIR"),
-        "/inner-output-path/test_output_path_capnp.rs"
-    ));
-}
+capnp::generated_code!(pub mod test_output_path_capnp, "inner-output-path/test_output_path_capnp.rs");
 
 #[cfg(test)]
 mod test_util;
diff --git a/example/addressbook/addressbook.rs b/example/addressbook/addressbook.rs
@@ -19,9 +19,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
-pub mod addressbook_capnp {
-    include!(concat!(env!("OUT_DIR"), "/addressbook_capnp.rs"));
-}
+capnp::generated_code!(pub mod addressbook_capnp, "addressbook_capnp.rs");
 
 pub mod addressbook {
     use crate::addressbook_capnp::{address_book, person};
diff --git a/example/addressbook_send/addressbook_send.rs b/example/addressbook_send/addressbook_send.rs
@@ -19,9 +19,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
-pub mod addressbook_capnp {
-    include!(concat!(env!("OUT_DIR"), "/addressbook_capnp.rs"));
-}
+capnp::generated_code!(pub mod addressbook_capnp, "addressbook_capnp.rs");
 
 use capnp::message::{Builder, HeapAllocator, TypedReader};
 use std::sync::mpsc;
diff --git a/example/fill_random_values/fill_addressbook.rs b/example/fill_random_values/fill_addressbook.rs
@@ -1,13 +1,8 @@
 use capnp::dynamic_value;
 use fill_random_values::Filler;
 
-pub mod addressbook_capnp {
-    include!(concat!(env!("OUT_DIR"), "/addressbook_capnp.rs"));
-}
-
-pub mod fill_capnp {
-    include!(concat!(env!("OUT_DIR"), "/fill_capnp.rs"));
-}
+capnp::generated_code!(pub mod addressbook_capnp, "addressbook_capnp.rs");
+capnp::generated_code!(pub mod fill_capnp, "fill_capnp.rs");
 
 pub fn main() {
     let mut message = ::capnp::message::Builder::new_default();
diff --git a/example/fill_random_values/fill_shapes.rs b/example/fill_random_values/fill_shapes.rs
@@ -1,13 +1,8 @@
 use capnp::dynamic_value;
 use fill_random_values::Filler;
 
-pub mod shapes_capnp {
-    include!(concat!(env!("OUT_DIR"), "/shapes_capnp.rs"));
-}
-
-pub mod fill_capnp {
-    include!(concat!(env!("OUT_DIR"), "/fill_capnp.rs"));
-}
+capnp::generated_code!(pub mod shapes_capnp, "shapes_capnp.rs");
+capnp::generated_code!(pub mod fill_capnp, "fill_capnp.rs");
 
 #[derive(Clone, Copy, Debug)]
 struct Viewport {
diff --git a/example/fill_random_values/src/lib.rs b/example/fill_random_values/src/lib.rs
@@ -5,9 +5,7 @@ use capnp::introspect::TypeVariant;
 use capnp::schema;
 use capnp::{dynamic_struct, dynamic_value};
 
-pub mod fill_capnp {
-    include!(concat!(env!("OUT_DIR"), "/fill_capnp.rs"));
-}
+capnp::generated_code!(pub mod fill_capnp, "fill_capnp.rs");
 
 pub struct Filler<R: Rng> {
     rng: R,
