Макросы в Rust

Макросы Rust — мощный инструмент для генерации кода во время компиляции, позволяющий создавать пользовательские расширения синтаксиса при написании кода.

Макрос — это техника метапрограммирования в коде, позволяющая генерировать код во время компиляции. Макросы помогают упростить код, повысить его читаемость и удобство сопровождения, а также позволяют разработчикам выполнять некоторые операции генерации кода во время компиляции.

В Rust существует два типа макросов: декларативные макросы и процедурные макросы.

В этой статье в основном рассматриваются декларативные макросы.

Определение макроса

В Rust используйте ключевое словоmacro_rules!для определения декларативных макросов.

macro_rules! my_macro {
    // 模式匹配和展开
    ($arg:expr) => {
        // 生成的代码
        // 使用 $arg 来代替匹配到的表达式
    };
}

Декларативные макросы используют ключевое словоmacro_rules!для определения, и они называются"macro_rules"макросами. Этот тип определения макросов основан на сопоставлении с образцом; он может сопоставлять структуру кода и генерировать соответствующий код на основе сопоставленного образца. Такие макросы можно использовать для упрощения распространённых шаблонов кода без введения новых синтаксических конструкций.

Вот пример простого определения макроса:

Пример

// Определение макроса
macro_rules! greet {
    // Сопоставление с образцом
    ($name:expr) => {
        // Раскрытие макроса
        println!("Hello, {}!", $name);
    };
}

fn main() {
    // Вызов макроса
    greet!("World");
}

Объяснение

  • Сопоставление с образцом:Макросы используют сопоставление с образцом для сопоставления фрагментов кода, переданных макросу. Шаблон — это левая часть правила макроса, используемая для захвата различных структур кода.
  • Правила:Правила макросов — это набор$управляемых шаблонов и соответствующего кода раскрытия, при этом правила разделяются точками с запятой.
  • Раскрытие макроса:Когда макрос вызывается, совпавший шаблон заменяется соответствующим кодом раскрытия, который является правой частью правила макроса.

Пример

Ниже приведён более сложный пример, демонстрирующий, как использовать макрос для создания простогоvec!макроса, чтобы упростить создание Vec:

Пример

// Определение макроса
macro_rules! vec {
    // Базовый случай: пусто
    () => {
        Vec::new()
    };
   
    // Рекурсивный случай: с элементами
    ($($element:expr),+ $(,)?) => {
        {
            let mut temp_vec = Vec::new();
            $(
                temp_vec.push($element);
            )+
            temp_vec
        }
    };
}

fn main() {
    // Вызов макроса
    let my_vec = vec![1, 2, 3];
    println!("{:?}", my_vec); // Вывод: [1, 2, 3]

    let empty_vec = vec![];
    println!("{:?}", empty_vec); // Вывод: []
}

В этом примере,vec!макрос использует сопоставление с образцом и$($element:expr),+ $(,)?)такой синтаксис, чтобы захватывать элементы, переданные макросу, и создавать из них Vec.

Обратите внимание, что $(,)?)используется для обработки завершающих запятых, что позволяет корректно работать в различных сценариях использования.


Процедурные макросы

Процедурные макросы — это более гибкий и мощный тип макросов, который позволяет манипулировать абстрактным синтаксическим деревом (AST) с помощью пользовательской генерации кода во время компиляции. По своей функциональности процедурные макросы ближе к функциям, но их сложнее писать и использовать.

Типы процедурных макросов:

  • Derive-макросы: используются для автоматической реализации трейтов (таких какCopy、Debug) макросы.
  • Атрибутные макросы: используются для присоединения дополнительных метаданных к объявлениям, таким как#[derive(Debug)]。

Реализация процедурных макросов обычно требует использования функциональности, предоставляемой библиотекой proc_macro, такой как TokenStream и TokenTree, для более непосредственной работы с исходным кодом.

Другие расширения