8

在编写声明式 ( macro_rules!) 宏时，我们会自动获得宏卫生。在此示例中，我声明了一个f在宏中命名的变量，并传入一个标识符，该标识符f成为局部变量：

macro_rules! decl_example {
    ($tname:ident, $mname:ident, ($($fstr:tt),*)) => {
        impl std::fmt::Display for $tname {
            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                let Self { $mname } = self;
                write!(f, $($fstr),*)
            }
        }
    }
}

struct Foo {
    f: String,
}

decl_example!(Foo, f, ("I am a Foo: {}", f));

fn main() {
    let f = Foo {
        f: "with a member named `f`".into(),
    };
    println!("{}", f);
}

此代码可以编译，但如果您查看部分扩展的代码，您会发现存在明显的冲突：

impl std::fmt::Display for Foo {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let Self { f } = self;
        write!(f, "I am a Foo: {}", f)
    }
}

我正在编写这个声明性宏的等效项作为过程宏，但不知道如何避免用户提供的标识符和我的宏创建的标识符之间的潜在名称冲突。据我所知，生成的代码没有卫生的概念，只是一个字符串：

src/main.rs

use my_derive::MyDerive;

#[derive(MyDerive)]
#[my_derive(f)]
struct Foo {
    f: String,
}

fn main() {
    let f = Foo {
        f: "with a member named `f`".into(),
    };
    println!("{}", f);
}

货运.toml

[package]
name = "example"
version = "0.1.0"
edition = "2018"

[dependencies]
my_derive = { path = "my_derive" }

my_derive/src/lib.rs

extern crate proc_macro;

use proc_macro::TokenStream;
use quote::quote;
use syn::{parse_macro_input, DeriveInput, Meta, NestedMeta};

#[proc_macro_derive(MyDerive, attributes(my_derive))]
pub fn my_macro(input: TokenStream) -> TokenStream {
    let input = parse_macro_input!(input as DeriveInput);

    let name = input.ident;

    let attr = input.attrs.into_iter().filter(|a| a.path.is_ident("my_derive")).next().expect("No name passed");
    let meta = attr.parse_meta().expect("Unknown attribute format");
    let meta = match meta {
        Meta::List(ml) => ml,
        _ => panic!("Invalid attribute format"),
    };
    let meta = meta.nested.first().expect("Must have one path");
    let meta = match meta {
        NestedMeta::Meta(Meta::Path(p)) => p,
        _ => panic!("Invalid nested attribute format"),
    };
    let field_name = meta.get_ident().expect("Not an ident");

    let expanded = quote! {
        impl std::fmt::Display for #name {
            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                let Self { #field_name } = self;
                write!(f, "I am a Foo: {}", #field_name)
            }
        }
    };

    TokenStream::from(expanded)
}

my_derive/Cargo.toml

[package]
name = "my_derive"
version = "0.1.0"
edition = "2018"

[lib]
proc-macro = true

[dependencies]
syn = "1.0.13"
quote = "1.0.2"
proc-macro2 = "1.0.7"

对于 Rust 1.40，这会产生编译器错误：

error[E0599]: no method named `write_fmt` found for type `&std::string::String` in the current scope
 --> src/main.rs:3:10
  |
3 | #[derive(MyDerive)]
  |          ^^^^^^^^ method not found in `&std::string::String`
  |
  = help: items from traits can only be used if the trait is in scope
  = note: this error originates in a macro outside of the current crate (in Nightly builds, run with -Z external-macro-backtrace for more info)
help: the following trait is implemented but not in scope; perhaps add a `use` for it:
  |
1 | use std::fmt::Write;
  |

有哪些技术可以从我无法控制的标识符中命名我的标识符？

4

2 回答 2

7

摘要：你还不能在稳定的 Rust 上使用带有 proc 宏的卫生标识符。最好的办法是使用一个特别难看的名字，例如__your_crate_your_name.

您正在使用创建标识符（特别是f）quote!。这当然很方便，但它只是编译器提供的实际 proc 宏 API 的助手。因此，让我们看一下该 API，看看我们如何创建标识符！最后我们需要一个TokenStream, 因为那是我们的 proc 宏返回的。我们如何构造这样的令牌流？

我们可以从字符串中解析它，例如"let f = 3;".parse::<TokenStream>(). 但这基本上是一个早期的解决方案，现在不鼓励。无论如何，以这种方式创建的所有标识符都以不卫生的方式表现，因此这不会解决您的问题。

第二种方法（quote!在后台使用）是TokenStream通过创建一堆TokenTrees来手动创建。一种TokenTree是Ident（标识符）。我们可以创建一个Identvia new：

fn new(string: &str, span: Span) -> Ident

string参数是不言自明的，但参数span是有趣的部分！ASpan存储源代码中某物的位置，通常用于错误报告（rustc例如，为了指向拼写错误的变量名）。但是在 Rust 编译器中，span 携带的不仅仅是位置信息：那种卫生！我们可以看到两个构造函数Span：

  • fn call_site() -> Span：创建一个具有呼叫站点卫生的跨度。这就是你所说的“不卫生”，相当于“复制粘贴”。如果两个标识符具有相同的字符串，它们将相互冲突或相互影响。

  • fn def_site() -> Span: 这就是你所追求的。技术上称为定义站点卫​​生，这就是您所说的“卫生”。您定义的标识符和用户的标识符存在于不同的宇宙中，永远不会发生冲突。正如您在文档中看到的，此方法仍然不稳定，因此只能在夜间编译器上使用。无赖！

没有真正好的解决方法。显而易见的是使用一个非常难看的名字，比如__your_crate_some_variable. 为了让您更轻松，您可以创建一次该标识符并在其中使用它quote!（这里稍微更好的解决方案）：

let ugly_name = quote! { __your_crate_some_variable };
quote! {
    let #ugly_name = 3;
    println!("{}", #ugly_name);
}

有时您甚至可以搜索可能与您的用户发生冲突的所有用户标识符，然后简单地通过算法选择一个不会发生冲突的标识符。这实际上是我们所做的auto_impl，带有一个后备超级丑陋的名字。这主要是为了改进生成的文档中包含超级丑陋的名称。

除此之外，恐怕你真的什么也做不了。

于 2020-01-06T21:10:22.880 回答
5

你可以感谢一个 UUID：

fn generate_unique_ident(prefix: &str) -> Ident {
    let uuid = uuid::Uuid::new_v4();
    let ident = format!("{}_{}", prefix, uuid).replace('-', "_");

    Ident::new(&ident, Span::call_site())
}
于 2020-01-06T20:56:50.870 回答