Crystal Programming. Введение на основе проекта в создание эффективных, безопасных и читаемых веб-приложений и приложений CLI - Джордж Дитрих

class="p1"># Returns the number at index 1.

def number_1

3

end

Поскольку макрос становится все более и более сложным, это может быть невероятно полезно для обеспечения того, чтобы он генерировал то, что должно быть.

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

macro def_macros(*numbers)

  {% for num, idx in numbers %}

    macro def_num_{{idx}}_methods(n)

      def num_{{n}}

        {{n}}

      end

      def num_{{n}}_index

        {{idx}}

      end

    end

    def_num_{{idx}}_methods({{num}})

  {% end %}

end

def_macros 2, 1

pp num_1_index # => 1

pp num_2_index # => 0

В конце макросы расширяются и определяют четыре метода. Ключевым моментом, на который следует обратить внимание в этом примере, является использование {{. Обратная косая черта экранирует выражение синтаксиса макроса, поэтому оно не оценивается внешним макросом, что означает, что оно расширяется только внутренним макросом. На переменные макроса из внешнего макроса по-прежнему можно ссылаться во внутреннем макросе, используя переменную во внутреннем макросе, не экранируя выражение.

Необходимость экранирования каждого выражения синтаксиса макроса внутри внутреннего макроса может быть довольно утомительной и подверженной ошибкам. К счастью, для упрощения этого можно использовать дословный вызов. Внутренний макрос, показанный в предыдущем примере, также можно записать следующим образом:

macro def_num_{{idx}}_methods(n)

  {% verbatim do %}

    def num_{{n}}

      {{n}}

    end

    def num_{{n}}_index

      {{idx}}

    end

  {% end %}

end

Однако если вы запустите это, вы увидите, что оно не компилируется. Единственным недостатком дословного перевода является то, что он не поддерживает интерполяцию переменных. Другими словами, это означает, что код внутри блока verbatim не может использовать переменные, определенные вне него, например idx.

Чтобы иметь возможность доступа к этой переменной, нам нужно определить другую экранированную макропеременную за пределами блока verbatim внутри внутреннего макроса, для которого установлено расширенное значение переменной idx внешнего макроса. Проще говоря, нам нужно добавить {% idx = {{idx}} %} над строкой {% verbatim do %}. В конечном итоге это приводит к расширению {% idx = 1 %} внутри внутреннего макроса в случае второго значения.

Поскольку макросы расширяются до кода Crystal, код, сгенерированный макросом, может создать конфликт с кодом, определенным в расширении макроса. Наиболее распространенной проблемой является переопределение локальных переменных. Решением этой проблемы является использование новых переменных как средства создания уникальных переменных.

Свежие переменные

Если макрос использует локальную переменную, предполагается, что эта локальная переменная уже определена. Эта функция позволяет макросу использовать предопределенные переменные в контексте раскрытия макроса, что может помочь уменьшить дублирование. Однако это также позволяет легко случайно переопределить локальную переменную, определенную в макросе, как показано в этом примере:

macro update_x

  x = 1

end

x = 0

update_x

puts x

Макрос update_x расширяется до выражения x = 1, которое переопределяет исходную переменную x, в результате чего эта программа печатает значение 1. Чтобы позволить макросу определять переменные, которые не будут конфликтовать, необходимо использовать новые переменные, например:

macro dont_update_x

  %x = 1

  puts %x

end

x = 0

dont_update_x

puts x

В отличие от предыдущего примера, здесь будет выведено значение 1, за которым следует значение 0, тем самым показывая, что расширенный макрос не изменил локальную переменную x. Новые переменные определяются путем добавления символа % к имени переменной. Новые переменные также могут быть созданы относительно другого значения макроса времени компиляции. Это может быть особенно полезно в циклах, где для каждой итерации цикла должна определяться новая переменная с тем же именем, например:

macro fresh_vars_sample(*names)

  {% for name, index in names %}

    %name{index} = {{index}}

  {% end %}

  {{debug}}

end

fresh_vars_sample a, b, c

Предыдущая программа будет перебирать каждый из аргументов, переданных макросу, и определит новую переменную для каждого элемента, используя индекс элемента в качестве значения переменной. На основе результатов отладки этот макрос расширяется до следующего:

__temp_24 = 0

__temp_25 = 1

__temp_26 = 2

Для каждой итерации цикла определяется одна переменная. Компилятор Crystal отслеживает все новые переменные и присваивает каждой из них номер, чтобы гарантировать, что они не конфликтуют друг с другом.

Макросы определения, не являющиеся макросами

Весь код макроса, который мы написали/рассмотрели до сих пор, был представлен в контексте определения макроса . Хотя это одно из наиболее распространенных мест для просмотра кода макроса, макросы также могут использоваться вне определения макроса. Это может быть полезно для условного определения кода на основе некоторого внешнего значения, такого как переменная среды, флаг времени компиляции или значение константы. Это можно увидеть в следующем примере:

{% if flag? :release %}

  puts "Release mode!"

{% else %}

  puts "Non-release mode!"

{% end %}

Метод flag? — это специальный метод макроса, который позволяет нам проверять наличие либо предоставленных пользователем, либо встроенных флагов времени компиляции. Одним из основных вариантов использования этого метода является определение кода, специфичного для конкретной ОС и/или архитектуры. Компилятор Crystal включает в себя несколько встроенных флагов, которые можно использовать для этого, например {% if flag?(:linux) && flag?(:x86_64) %}, которые будут выполняться только в том случае, если система, компилирующая программу, использует 64-битная ОС Linux.

Пользовательские флаги можно определить с помощью опций --define или -D. Например, если вы хотите проверить наличие flag? :foo, флаг можно определить, выполнив crystal run -Dfoo main.cr. Флаги времени компиляции либо присутствуют, либо нет; они не могут включать значение. Однако переменные окружающей среды могут стать хорошей заменой, если требуется большая гибкость.

Переменные среды можно прочитать во время компиляции с помощью метода макроса env. Хорошим вариантом использования этого является возможность встраивания в двоичный файл информации о времени сборки, такой как эпоха сборки, время сборки и т. д. В этом примере во время