Як використовувати макрос у файлах модулів?

У мене є два модулі в окремих файлах в одному ящику, де ящик macro_rulesвключений. Я хочу використовувати макроси, визначені в одному модулі, в іншому модулі.

// macros.rs
#[macro_export] // or not? is ineffectual for this, afaik
macro_rules! my_macro(...)

// something.rs
use macros;
// use macros::my_macro; <-- unresolved import (for obvious reasons)
my_macro!() // <-- how?

На даний момент я потрапив до помилки компілятора " macro undefined: 'my_macro'" ... що має сенс; макросистема запускається перед модульною системою. Як я можу обійти це?

Макроси в одному ящику

#[macro_use]
mod foo {
    macro_rules! bar {
        () => ()
    }
}

bar!();    // works

Якщо ви хочете використовувати макрос у тому самому ящику, модуль, який визначається вашим макросом, потребує атрибута #[macro_use].

Макроси можна використовувати лише після їх визначення. Це означає, що це не працює:

bar!();  // ERROR: cannot find macro `bar!` in this scope

#[macro_use]
mod foo {
    macro_rules! bar {
        () => ()
    }
}

Макроси в ящиках

Щоб використовувати ваш macro_rules!макрос з інших ящиків, самому макросу потрібен атрибут #[macro_export]. Ящик для імпорту може потім імпортувати макрос через use crate_name::macro_name;.

Ящик util

#[macro_export]
macro_rules! foo {
    () => ()
}

Ящик user

use util::foo;

foo!();

Зверніть увагу, що макроси завжди живуть на верхньому рівні ящика; так що навіть якщо fooце буде всередині a mod bar {}, userящик все одно повинен писати, use util::foo;а ні use util::bar::foo; .

До Rust 2018 вам потрібно було імпортувати макрос з інших ящиків, додавши атрибут #[macro_use]до extern crate util;оператора. Це імпортувало б усі макроси з util. Як варіант, #[macro_use(cat, dog)]може використовуватися лише для імпорту макросів catта dog. Цей синтаксис більше не повинен бути необхідним.

Детальніша інформація доступна у розділі Мова програмування іржі про макроси .

Ця відповідь застаріла станом на Rust 1.1.0-стабільна.

Вам потрібно додати #![macro_escape]у верхній частині macros.rsта включити його, використовуючи, mod macros;як зазначено в Посібнику з макросів .

$ cat macros.rs
#![macro_escape]

#[macro_export]
macro_rules! my_macro {
    () => { println!("hi"); }
}

$ cat something.rs
#![feature(macro_rules)]
mod macros;

fn main() {
    my_macro!();
}

$ rustc something.rs
$ ./something
hi

Для подальшого використання,

$ rustc -v
rustc 0.13.0-dev (2790505c1 2014-11-03 14:17:26 +0000)

Додавання #![macro_use]у верхній частині файлу, що містить макроси, призведе до того, що всі макроси будуть витягнуті до main.rs.

Наприклад, припустимо, що цей файл називається node.rs:

#![macro_use]

macro_rules! test {
    () => { println!("Nuts"); }
}

macro_rules! best {
    () => { println!("Run"); }
}

pub fn fun_times() {
    println!("Is it really?");
}

Ваш main.rs виглядатиме приблизно так:

mod node;  //We're using node.rs
mod toad;  //Also using toad.rs

fn main() {
    test!();
    best!();
    toad::a_thing();
}

Нарешті, припустимо, у вас є файл під назвою toad.rs, який також вимагає таких макросів:

use node; //Notice this is 'use' not 'mod'

pub fn a_thing() {
  test!();

  node::fun_times();
}

Зверніть увагу, що після витягування файлів у main.rs with mod, інші ваші файли отримують до них доступ за допомогою useключового слова.

Я зіткнувся з тією ж проблемою в Rust 1.44.1, і це рішення працює для пізніших версій (відомо, що працює для Rust 1.7).

Скажімо, у вас новий проект як:

src/
    main.rs
    memory.rs
    chunk.rs

У main.rs вам потрібно зазначити , що ви імпортуєте макроси з джерела, інакше це не допоможе вам.

#[macro_use]
mod memory;
mod chunk;

fn main() {
    println!("Hello, world!");
}

Отже, в memory.rs ви можете визначити макроси, і вам не потрібні анотації:

macro_rules! grow_capacity {
    ( $x:expr ) => {
        {
            if $x < 8 { 8 } else { $x * 2 }
        }
    };
}

Нарешті, ви можете використовувати його в chunk.rs , і вам не потрібно включати сюди макрос, оскільки це робиться в main.rs:

grow_capacity!(8);

Upvoted відповідь викликав замішання у мене з цим документом на прикладі , було б корисно теж.