* [PATCH v1 1/3] rust: macros: add `quote!` macro
@ 2023-03-13 1:23 y86-dev
2023-03-13 15:30 ` Boqun Feng
0 siblings, 1 reply; 3+ messages in thread
From: y86-dev @ 2023-03-13 1:23 UTC (permalink / raw)
To: ojeda, alex.gaynor, wedsonaf, boqun.feng, Gary Guo, bjorn3_gh
Cc: rust-for-linux, linux-kernel, patches
From: Gary Guo <gary@garyguo.net>
Add the `quote!` macro for creating `TokenStream`s directly via the
given Rust tokens. It also supports repetitions using iterators.
It will be used by the pin-init API proc-macros to generate code.
Signed-off-by: Gary Guo <gary@garyguo.net>
Signed-off-by: Benno Lossin <y86-dev@protonmail.com>
---
rust/macros/lib.rs | 2 +
rust/macros/quote.rs | 125 +++++++++++++++++++++++++++++++++++++++++++
2 files changed, 127 insertions(+)
create mode 100644 rust/macros/quote.rs
diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs
index c1d385e345b9..82b520f024dd 100644
--- a/rust/macros/lib.rs
+++ b/rust/macros/lib.rs
@@ -2,6 +2,8 @@
//! Crate for all kernel procedural macros.
+#[macro_use]
+mod quote;
mod concat_idents;
mod helpers;
mod module;
diff --git a/rust/macros/quote.rs b/rust/macros/quote.rs
new file mode 100644
index 000000000000..55b663d665ec
--- /dev/null
+++ b/rust/macros/quote.rs
@@ -0,0 +1,125 @@
+use proc_macro::{TokenStream, TokenTree};
+
+pub(crate) trait ToTokens {
+ fn to_tokens(&self, tokens: &mut TokenStream);
+}
+
+impl<T: ToTokens> ToTokens for Option<T> {
+ fn to_tokens(&self, tokens: &mut TokenStream) {
+ if let Some(v) = self {
+ v.to_tokens(tokens);
+ }
+ }
+}
+
+impl ToTokens for proc_macro::Group {
+ fn to_tokens(&self, tokens: &mut TokenStream) {
+ tokens.extend([TokenTree::from(self.clone())]);
+ }
+}
+
+impl ToTokens for TokenTree {
+ fn to_tokens(&self, tokens: &mut TokenStream) {
+ tokens.extend([self.clone()]);
+ }
+}
+
+impl ToTokens for TokenStream {
+ fn to_tokens(&self, tokens: &mut TokenStream) {
+ tokens.extend(self.clone());
+ }
+}
+
+macro_rules! quote_spanned {
+ ($span:expr => $($tt:tt)*) => {{
+ let mut tokens = Vec::new();
+ let span = $span;
+ quote_spanned!(@proc tokens span $($tt)*);
+ proc_macro::TokenStream::from_iter(tokens)
+ }};
+ (@proc $v:ident $span:ident) => {};
+ (@proc $v:ident $span:ident #$id:ident $($tt:tt)*) => {
+ let mut ts = proc_macro::TokenStream::new();
+ crate::quote::ToTokens::to_tokens(&$id, &mut ts);
+ $v.extend(ts.into_iter());
+ quote_spanned!(@proc $v $span $($tt)*);
+ };
+ (@proc $v:ident $span:ident #(#$id:ident)* $($tt:tt)*) => {
+ for token in $id {
+ let mut ts = proc_macro::TokenStream::new();
+ crate::quote::ToTokens::to_tokens(&token, &mut ts);
+ $v.extend(ts.into_iter());
+ }
+ quote_spanned!(@proc $v $span $($tt)*);
+ };
+ (@proc $v:ident $span:ident ( $($inner:tt)* ) $($tt:tt)*) => {
+ let mut tokens = Vec::new();
+ quote_spanned!(@proc tokens $span $($inner)*);
+ $v.push(proc_macro::TokenTree::Group(proc_macro::Group::new(
+ proc_macro::Delimiter::Parenthesis,
+ proc_macro::TokenStream::from_iter(tokens)
+ )));
+ quote_spanned!(@proc $v $span $($tt)*);
+ };
+ (@proc $v:ident $span:ident [ $($inner:tt)* ] $($tt:tt)*) => {
+ let mut tokens = Vec::new();
+ quote_spanned!(@proc tokens $span $($inner)*);
+ $v.push(proc_macro::TokenTree::Group(proc_macro::Group::new(
+ proc_macro::Delimiter::Bracket,
+ proc_macro::TokenStream::from_iter(tokens)
+ )));
+ quote_spanned!(@proc $v $span $($tt)*);
+ };
+ (@proc $v:ident $span:ident { $($inner:tt)* } $($tt:tt)*) => {
+ let mut tokens = Vec::new();
+ quote_spanned!(@proc tokens $span $($inner)*);
+ $v.push(proc_macro::TokenTree::Group(proc_macro::Group::new(
+ proc_macro::Delimiter::Brace,
+ proc_macro::TokenStream::from_iter(tokens)
+ )));
+ quote_spanned!(@proc $v $span $($tt)*);
+ };
+ (@proc $v:ident $span:ident :: $($tt:tt)*) => {
+ $v.push(
+ proc_macro::TokenTree::Punct(proc_macro::Punct::new(':', proc_macro::Spacing::Joint))
+ );
+ $v.push(
+ proc_macro::TokenTree::Punct(proc_macro::Punct::new(':', proc_macro::Spacing::Alone))
+ );
+ quote_spanned!(@proc $v $span $($tt)*);
+ };
+ (@proc $v:ident $span:ident : $($tt:tt)*) => {
+ $v.push(
+ proc_macro::TokenTree::Punct(proc_macro::Punct::new(':', proc_macro::Spacing::Alone))
+ );
+ quote_spanned!(@proc $v $span $($tt)*);
+ };
+ (@proc $v:ident $span:ident , $($tt:tt)*) => {
+ $v.push(
+ proc_macro::TokenTree::Punct(proc_macro::Punct::new(',', proc_macro::Spacing::Alone))
+ );
+ quote_spanned!(@proc $v $span $($tt)*);
+ };
+ (@proc $v:ident $span:ident @ $($tt:tt)*) => {
+ $v.push(
+ proc_macro::TokenTree::Punct(proc_macro::Punct::new('@', proc_macro::Spacing::Alone))
+ );
+ quote_spanned!(@proc $v $span $($tt)*);
+ };
+ (@proc $v:ident $span:ident ! $($tt:tt)*) => {
+ $v.push(
+ proc_macro::TokenTree::Punct(proc_macro::Punct::new('!', proc_macro::Spacing::Alone))
+ );
+ quote_spanned!(@proc $v $span $($tt)*);
+ };
+ (@proc $v:ident $span:ident $id:ident $($tt:tt)*) => {
+ $v.push(proc_macro::TokenTree::Ident(proc_macro::Ident::new(stringify!($id), $span)));
+ quote_spanned!(@proc $v $span $($tt)*);
+ };
+}
+
+macro_rules! quote {
+ ($($tt:tt)*) => {
+ quote_spanned!(proc_macro::Span::mixed_site() => $($tt)*)
+ }
+}
--
2.39.2
^ permalink raw reply related [flat|nested] 3+ messages in thread* Re: [PATCH v1 1/3] rust: macros: add `quote!` macro
2023-03-13 1:23 [PATCH v1 1/3] rust: macros: add `quote!` macro y86-dev
@ 2023-03-13 15:30 ` Boqun Feng
2023-03-16 9:33 ` y86-dev
0 siblings, 1 reply; 3+ messages in thread
From: Boqun Feng @ 2023-03-13 15:30 UTC (permalink / raw)
To: y86-dev
Cc: ojeda, alex.gaynor, wedsonaf, Gary Guo, bjorn3_gh,
rust-for-linux, linux-kernel, patches
On Mon, Mar 13, 2023 at 01:23:18AM +0000, y86-dev wrote:
> From: Gary Guo <gary@garyguo.net>
>
> Add the `quote!` macro for creating `TokenStream`s directly via the
> given Rust tokens. It also supports repetitions using iterators.
>
> It will be used by the pin-init API proc-macros to generate code.
>
> Signed-off-by: Gary Guo <gary@garyguo.net>
> Signed-off-by: Benno Lossin <y86-dev@protonmail.com>
Not sure whether I missed any sutble details, but the macros look
straight-forward. One thing could be improved is having a doc describing
what `quote!` does, a link to the quote crate will do the trick.
Anyway, the code looks good to me.
Acked-by: Boqun Feng <boqun.feng@gmail.com>
Regards,
Boqun
> ---
> rust/macros/lib.rs | 2 +
> rust/macros/quote.rs | 125 +++++++++++++++++++++++++++++++++++++++++++
> 2 files changed, 127 insertions(+)
> create mode 100644 rust/macros/quote.rs
>
> diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs
> index c1d385e345b9..82b520f024dd 100644
> --- a/rust/macros/lib.rs
> +++ b/rust/macros/lib.rs
> @@ -2,6 +2,8 @@
>
> //! Crate for all kernel procedural macros.
>
> +#[macro_use]
> +mod quote;
> mod concat_idents;
> mod helpers;
> mod module;
> diff --git a/rust/macros/quote.rs b/rust/macros/quote.rs
> new file mode 100644
> index 000000000000..55b663d665ec
> --- /dev/null
> +++ b/rust/macros/quote.rs
> @@ -0,0 +1,125 @@
> +use proc_macro::{TokenStream, TokenTree};
> +
> +pub(crate) trait ToTokens {
> + fn to_tokens(&self, tokens: &mut TokenStream);
> +}
> +
> +impl<T: ToTokens> ToTokens for Option<T> {
> + fn to_tokens(&self, tokens: &mut TokenStream) {
> + if let Some(v) = self {
> + v.to_tokens(tokens);
> + }
> + }
> +}
> +
> +impl ToTokens for proc_macro::Group {
> + fn to_tokens(&self, tokens: &mut TokenStream) {
> + tokens.extend([TokenTree::from(self.clone())]);
> + }
> +}
> +
> +impl ToTokens for TokenTree {
> + fn to_tokens(&self, tokens: &mut TokenStream) {
> + tokens.extend([self.clone()]);
> + }
> +}
> +
> +impl ToTokens for TokenStream {
> + fn to_tokens(&self, tokens: &mut TokenStream) {
> + tokens.extend(self.clone());
> + }
> +}
> +
> +macro_rules! quote_spanned {
> + ($span:expr => $($tt:tt)*) => {{
> + let mut tokens = Vec::new();
> + let span = $span;
> + quote_spanned!(@proc tokens span $($tt)*);
> + proc_macro::TokenStream::from_iter(tokens)
> + }};
> + (@proc $v:ident $span:ident) => {};
> + (@proc $v:ident $span:ident #$id:ident $($tt:tt)*) => {
> + let mut ts = proc_macro::TokenStream::new();
> + crate::quote::ToTokens::to_tokens(&$id, &mut ts);
> + $v.extend(ts.into_iter());
> + quote_spanned!(@proc $v $span $($tt)*);
> + };
> + (@proc $v:ident $span:ident #(#$id:ident)* $($tt:tt)*) => {
> + for token in $id {
> + let mut ts = proc_macro::TokenStream::new();
> + crate::quote::ToTokens::to_tokens(&token, &mut ts);
> + $v.extend(ts.into_iter());
> + }
> + quote_spanned!(@proc $v $span $($tt)*);
> + };
> + (@proc $v:ident $span:ident ( $($inner:tt)* ) $($tt:tt)*) => {
> + let mut tokens = Vec::new();
> + quote_spanned!(@proc tokens $span $($inner)*);
> + $v.push(proc_macro::TokenTree::Group(proc_macro::Group::new(
> + proc_macro::Delimiter::Parenthesis,
> + proc_macro::TokenStream::from_iter(tokens)
> + )));
> + quote_spanned!(@proc $v $span $($tt)*);
> + };
> + (@proc $v:ident $span:ident [ $($inner:tt)* ] $($tt:tt)*) => {
> + let mut tokens = Vec::new();
> + quote_spanned!(@proc tokens $span $($inner)*);
> + $v.push(proc_macro::TokenTree::Group(proc_macro::Group::new(
> + proc_macro::Delimiter::Bracket,
> + proc_macro::TokenStream::from_iter(tokens)
> + )));
> + quote_spanned!(@proc $v $span $($tt)*);
> + };
> + (@proc $v:ident $span:ident { $($inner:tt)* } $($tt:tt)*) => {
> + let mut tokens = Vec::new();
> + quote_spanned!(@proc tokens $span $($inner)*);
> + $v.push(proc_macro::TokenTree::Group(proc_macro::Group::new(
> + proc_macro::Delimiter::Brace,
> + proc_macro::TokenStream::from_iter(tokens)
> + )));
> + quote_spanned!(@proc $v $span $($tt)*);
> + };
> + (@proc $v:ident $span:ident :: $($tt:tt)*) => {
> + $v.push(
> + proc_macro::TokenTree::Punct(proc_macro::Punct::new(':', proc_macro::Spacing::Joint))
> + );
> + $v.push(
> + proc_macro::TokenTree::Punct(proc_macro::Punct::new(':', proc_macro::Spacing::Alone))
> + );
> + quote_spanned!(@proc $v $span $($tt)*);
> + };
> + (@proc $v:ident $span:ident : $($tt:tt)*) => {
> + $v.push(
> + proc_macro::TokenTree::Punct(proc_macro::Punct::new(':', proc_macro::Spacing::Alone))
> + );
> + quote_spanned!(@proc $v $span $($tt)*);
> + };
> + (@proc $v:ident $span:ident , $($tt:tt)*) => {
> + $v.push(
> + proc_macro::TokenTree::Punct(proc_macro::Punct::new(',', proc_macro::Spacing::Alone))
> + );
> + quote_spanned!(@proc $v $span $($tt)*);
> + };
> + (@proc $v:ident $span:ident @ $($tt:tt)*) => {
> + $v.push(
> + proc_macro::TokenTree::Punct(proc_macro::Punct::new('@', proc_macro::Spacing::Alone))
> + );
> + quote_spanned!(@proc $v $span $($tt)*);
> + };
> + (@proc $v:ident $span:ident ! $($tt:tt)*) => {
> + $v.push(
> + proc_macro::TokenTree::Punct(proc_macro::Punct::new('!', proc_macro::Spacing::Alone))
> + );
> + quote_spanned!(@proc $v $span $($tt)*);
> + };
> + (@proc $v:ident $span:ident $id:ident $($tt:tt)*) => {
> + $v.push(proc_macro::TokenTree::Ident(proc_macro::Ident::new(stringify!($id), $span)));
> + quote_spanned!(@proc $v $span $($tt)*);
> + };
> +}
> +
> +macro_rules! quote {
> + ($($tt:tt)*) => {
> + quote_spanned!(proc_macro::Span::mixed_site() => $($tt)*)
> + }
> +}
> --
> 2.39.2
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH v1 1/3] rust: macros: add `quote!` macro
2023-03-13 15:30 ` Boqun Feng
@ 2023-03-16 9:33 ` y86-dev
0 siblings, 0 replies; 3+ messages in thread
From: y86-dev @ 2023-03-16 9:33 UTC (permalink / raw)
To: Boqun Feng
Cc: ojeda, alex.gaynor, wedsonaf, Gary Guo, bjorn3_gh,
rust-for-linux, linux-kernel, patches
On Monday, March 13th, 2023 at 16:30, Boqun Feng <boqun.feng@gmail.com> wrote:
> On Mon, Mar 13, 2023 at 01:23:18AM +0000, y86-dev wrote:
>
> > From: Gary Guo gary@garyguo.net
> >
> > Add the `quote!` macro for creating `TokenStream`s directly via the
> > given Rust tokens. It also supports repetitions using iterators.
> >
> > It will be used by the pin-init API proc-macros to generate code.
> >
> > Signed-off-by: Gary Guo gary@garyguo.net
> > Signed-off-by: Benno Lossin y86-dev@protonmail.com
>
>
> Not sure whether I missed any sutble details, but the macros look
> straight-forward. One thing could be improved is having a doc describing
> what `quote!` does, a link to the quote crate will do the trick.
>
> Anyway, the code looks good to me.
>
> Acked-by: Boqun Feng boqun.feng@gmail.com
>
>
> Regards,
> Boqun
Sure, will put it in v2!
Regards,
Benno
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2023-03-16 9:34 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-03-13 1:23 [PATCH v1 1/3] rust: macros: add `quote!` macro y86-dev
2023-03-13 15:30 ` Boqun Feng
2023-03-16 9:33 ` y86-dev
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).