#proc-macro #macro-rules #pattern-matching #procedural

proc-macro-rules

Emulate macro-rules pattern matching in procedural macros

5 unstable releases

0.4.0 Nov 7, 2023
0.2.1 Jan 6, 2019
0.2.0 Jan 6, 2019
0.1.1 Jan 5, 2019
0.1.0 Jan 5, 2019

#95 in Procedural macros

Download history 22022/week @ 2024-10-30 13272/week @ 2024-11-06 48490/week @ 2024-11-13 30664/week @ 2024-11-20 26434/week @ 2024-11-27 37124/week @ 2024-12-04 45846/week @ 2024-12-11 16635/week @ 2024-12-18 5170/week @ 2024-12-25 18250/week @ 2025-01-01 38989/week @ 2025-01-08 37382/week @ 2025-01-15 27123/week @ 2025-01-22 33100/week @ 2025-01-29 38004/week @ 2025-02-05 29551/week @ 2025-02-12

134,683 downloads per month
Used in 87 crates (via deno_ops)

Apache-2.0/MIT

19KB
359 lines

proc-macro-rules

macro_rules-style syntax matching for procedural macros.

This crate is work-in-progress, incomplete, and probably buggy!

Example:

rules!(tokens => {
    ($finish:ident ($($found:ident)*) # [ $($inner:tt)* ] $($rest:tt)*) => {
        for f in found {
            do_something(finish, f, inner, rest[0]);
        }
    }
    (foo $($bar:expr)?) => {
        match bar {
            Some(e) => foo_with_expr(e),
            None => foo_no_expr(),
        }
    }
});

Using proc-macro-rules

Add proc-macro-rules = "0.3.0" (or proc-macro-rules = "0.2.1" for versions between 1.31 and 1.56) to your Cargo.toml.

Import the rules macro with use proc_macro_rules::rules, then use with rules!(tokens => { branches }); where tokens is an expression which evaluates to a TokenStream (such as the argument in the definition of a procedural macro).

Each branch in branches should have the form ( pattern ) => { body } where pattern is a macro-rules-style pattern (using all the same syntax for meta-variables, AST nodes, repetition, etc.) and body is rust code executed when the pattern is matched. Within body, any meta-variables in the pattern are bound to variables of an appropriate type from either the proc_macro2 or syn crates. Where a meta-variable is inside a repetition or option clause, it will be wrapped in a Vec or Option, respectively.

For example, in the first branch in the above example ident has type syn::Ident and inner has type Vec<proc_macro2::TokenTree>.

Building and testing

Use cargo build to build, cargo test --all to test.

Contributing

Contributions are very welcome! It would be great to know things which are missing or incorrect (in general we should have the same behaviour as macro_rules, so anything different is incorrect). Issues, code, docs, tests, and corrections are all welcome.

Dependencies

~245–710KB
~16K SLoC