关于rust宏-过程宏(补充)

一、 rust编译过程

rust编译过程

从上面的编译过程图，可以看到声明宏和 过程宏被编译到AST中过程是不同的：

• 声明宏：通过macro_rule 定义的宏最终只是被解析为TokenStream;
• 过程宏: 定义的过程宏首先被解析为proc_macro::TokenStream，接着再被解析为proc_macro2::TokenStream,再使用Syn库解析为AST(这里的不同于编译生成的AST)，最后再通过Quote解析为TokenStream,最终会被扩展到编译过程TokenStream中，进而再被编译AST;

二、过程宏

1、样例

属性过程宏样例

此处定义一个属性过程宏的样例
2、定义过程宏

• 准备工作
  主要是Cargo.toml文件中

[lib]
proc-macro=true # 开启过程宏

# 引入如下三个crate的原因 参考上面编译过程图：在生成最终的TokenStream前，需要依赖这三个crate
[dependencies]
proc-macro2 = "1.0.34"
syn = {version="1.0.82", feature="full"}
quote ="1.0.10"

• 项目结构
  过程宏需要定义在一个单独的crate中，主要是因为过程宏是一段在编译crate前，对其代码进行加工的代码，而这段是需要在编译后执行的。若是将定义过程宏和使用过程宏放到同一个crate中，就会陷入编译“死锁”：
  1、要编译的代码需要运行过程宏进行展开，否则代码是不完整的，无法编译crate；
  2、不能编译crate，那么在crate中的过程宏就无法执行，就不能展开被过程宏“修饰”的代码

• 定义过程宏

use proc_macro::TokenStream;

/// 定义一个属性过程宏
/// ？？？输入参数：TokenStream 输出参数: TokenStream【解释见`项目结构`】
/// 不做任何加工，直接输出item
#[proc_macro_attribute]
pub fn my_first_attr_proc_macro(attr: TokenStream, item: TokenStream) -> TokenStream {
    eprintln!("===输出attr");
    eprintln!(" {:#?}", attr);
    eprintln!("===输出item");
    eprintln!("{:#?}", item);
    item
}

• 使用过程宏
  1、Cargo.toml文件引入过程宏crate

[dependencies]
produceral_macro={path= "../procedural_macro_demos/procedural_macro" } # 本地路径引用

2、使用过程宏
通过#[crate_name::proc_macro_func("过程宏名字-任意")]
类似 #[produceral_macro::my_first_attr_proc_macro("my_first_procedural_macro")]

#[produceral_macro::my_first_attr_proc_macro("my_first_procedural_macro")]
fn add(a: u64, b: u64) -> () {
    eprintln!("a={:?}, b={:?}, a+b={:?}", a, b , (a+b));
}

rust过程宏本质就是一个编译环节的“过滤器”或者说是一个“中间件”，接收一段用户编写的源代码，再做一通“转换”操作，然后返回给编译器一段经过修改的代码。

目前过程宏代码的调试，最好通过print来进行

最终生成的TokenStream是没有任何语义信息的，是通过树形结构的数据组织，表达了用户源代码各个语言元素的类型及其相互之间的关系；每个语言元素都有一个span属性，记录该元素在用户源代码中的位置。同时不同类型的节点有各自独有的属性。
而Rust过程宏就是自己能够手动修改输入变量中的值，比如样例中的attr,item,换句话说等价于加工原始输入代码，最后将加工后的代码返回给编译器即可.

三、proc-macro2\syn\quote三个包在过程宏中的应用

使用syn、quote等crate模拟过程宏“修改”源代码，并将结果以TokenStream给到编译器：

#[proc_macro_attribute]
pub fn my_first_attr_proc_macro_parse(attr: TokenStream, input: TokenStream) -> TokenStream {
    eprintln!("===attr: {:#?}", attr);
    eprintln!("===item: {:#?}", input);
    // 通过syn来解析输入的TokenStream
    let input_fn = syn::parse_macro_input!(input as syn::ItemFn);
    // 获取该token对应的类型：ident
    let name = input_fn.sig.ident.clone();
    //  输出TokenStream给到编译器
    TokenStream::from(quote! { // 使用quote库来构建编译器需要的TokenStream
        fn #name () {
            #input_fn

            for i in 0..3 {
                println!("loop time {}", i);

                let r = std::panic::catch_unwind(|| {
                    #name();
                });

                if r.is_ok() {
                    return;
                }
                if i == 2 {
                    std::panic::resume_unwind(r.unwrap_err());
                }
            }
        }
    })
}

测试代码

#[procedural_macro::my_first_attr_proc_macro_parse]
fn test_proc_macro() {
    assert_eq!(1,1);  // 运行正常
    assert_eq!(1,22);  // 触发panic
}

四、编译过程宏代码

#输出未进行宏扩展的ast树
$ cargo rustc -- -Z ast-json-noexpand=yes
#输出宏扩展后的ast树
$ cargo rustc -- -Z ast-json=yes 
#输出hir格式的中间描述
$ cargo rustc -- -Z unpretty=hir 
#输出hir格式并带有类型信息的中间描述
$ cargo rustc -- -Z unpretty=hir,typed 
#输出hir格式并带有完整树结构的中间描述
$ cargo rustc -- -Z unpretty=hir-tree
#输出mir格式的中间描述
$ cargo rustc -- -Z unpretty=mir

#### 代码编译中间代码 ####
#输出llvm ir格式的中间描述
$ rustc --emit llvm-ir lrfrc.rs
#输出汇编格式的中间描述
$ rustc --emit asm lrfrc.rs
#分析中间汇编输出
$ rustc -C opt-level=3 --emit=obj lrfrc.rs
$ size -A lrfrc.o
$ objdump -d lrfrc.o