Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[H-01] Retaining other macros #29

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

[H-01] Retaining other macros #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ff978d3
retaing other macros
ozgunozerk Feb 3, 2025
cbb26eb
filter out the current macro
ozgunozerk Feb 4, 2025
62a8ecd
reuse the duplicated code across macros
ozgunozerk Feb 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

36 changes: 34 additions & 2 deletions contracts/utils/pausable-macros/src/helper.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,38 @@
use syn::{FnArg, ItemFn, PatType, Type};
use proc_macro::TokenStream;
use quote::quote;
use syn::{parse_macro_input, FnArg, ItemFn, PatType, Type};

pub fn check_env_arg(input_fn: &ItemFn) -> (syn::Ident, bool) {
pub fn generate_pause_check(item: TokenStream, check_fn: &str, macro_name: &str) -> TokenStream {
let input_fn = parse_macro_input!(item as ItemFn);
let (env_ident, is_ref) = check_env_arg(&input_fn);

let fn_vis = &input_fn.vis;
let fn_sig = &input_fn.sig;
let fn_block = &input_fn.block;
// Filter out the current macro from attributes
let fn_attrs: Vec<_> =
input_fn.attrs.iter().filter(|attr| !attr.path().is_ident(macro_name)).collect();

let env_arg = if is_ref {
quote! { #env_ident }
} else {
quote! { &#env_ident }
};

let check_ident = syn::Ident::new(check_fn, proc_macro2::Span::call_site());
let output = quote! {
#(#fn_attrs)* // retain other macros
#fn_vis #fn_sig {
openzeppelin_pausable::#check_ident(#env_arg);

#fn_block
}
};

output.into()
}

fn check_env_arg(input_fn: &ItemFn) -> (syn::Ident, bool) {
// Get the first argument
let first_arg = input_fn.sig.inputs.first().unwrap_or_else(|| {
panic!("function '{}' must have at least one argument", input_fn.sig.ident)
Expand Down
50 changes: 3 additions & 47 deletions contracts/utils/pausable-macros/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
use proc_macro::TokenStream;
use quote::quote;
use syn::{parse_macro_input, ItemFn};

use crate::helper::check_env_arg;
use crate::helper::generate_pause_check;

mod helper;

Expand All @@ -28,28 +26,7 @@ mod helper;
/// ```
#[proc_macro_attribute]
pub fn when_not_paused(_attr: TokenStream, item: TokenStream) -> TokenStream {
let input_fn = parse_macro_input!(item as ItemFn);
let (env_ident, is_ref) = check_env_arg(&input_fn);

let fn_vis = &input_fn.vis;
let fn_sig = &input_fn.sig;
let fn_block = &input_fn.block;

let env_arg = if is_ref {
quote! { #env_ident }
} else {
quote! { &#env_ident }
};

let output = quote! {
#fn_vis #fn_sig {
openzeppelin_pausable::when_not_paused(#env_arg);

#fn_block
}
};

output.into()
generate_pause_check(item, "when_not_paused", "when_not_paused")
}

/// Adds a pause check at the beginning of the function that ensures the
Expand All @@ -74,26 +51,5 @@ pub fn when_not_paused(_attr: TokenStream, item: TokenStream) -> TokenStream {
/// ```
#[proc_macro_attribute]
pub fn when_paused(_attr: TokenStream, item: TokenStream) -> TokenStream {
let input_fn = parse_macro_input!(item as ItemFn);
let (env_ident, is_ref) = check_env_arg(&input_fn);

let fn_vis = &input_fn.vis;
let fn_sig = &input_fn.sig;
let fn_block = &input_fn.block;

let env_arg = if is_ref {
quote! { #env_ident }
} else {
quote! { &#env_ident }
};

let output = quote! {
#fn_vis #fn_sig {
openzeppelin_pausable::when_paused(#env_arg);

#fn_block
}
};

output.into()
generate_pause_check(item, "when_paused", "when_paused")
}