Macro.Env

Структура, хранящая информацию об окружении во время компиляции.

Текущее окружение можно получить в любой момент как __ENV__/0. Внутри макросов окружение вызывающего макроса можно получить как __CALLER__/0.

Экземпляр Macro.Env не должен изменяться вручную. Если вам нужно создать пользовательское окружение для передачи в Code.eval_quoted/3, используйте следующий трюк:

def make_custom_env do
  import SomeModule, only: [some_function: 2]
  alias A.B.C
  __ENV__
end

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

Она содержит следующие поля:

module - имя текущего модуля
file - имя текущего файла в виде бинарного значения
line - текущая строка в виде целого числа
function - кортеж, как {atom, integer}, где первый элемент - имя функции, а второй - её арность; возвращает nil если не внутри функции
context - контекст окружения; он может быть nil (по умолчанию), :guard (внутри условия) или :match (внутри совпадения)
aliases - список кортежей из двух элементов, где первый - алиас, а второй - фактическое имя
requires - список необходимых модулей
functions - список функций, импортированных из каждого модуля
macros - список макросов, импортированных из каждого модуля
macro_aliases - список псевдонимов, определённых внутри текущего макроса
context_modules - список модулей, определённых в текущем контексте
lexical_tracker - PID лексического трекера, отвечающего за сохранение информации пользователя

Следующие поля относятся к обработке переменных и не должны использоваться. Чтобы получить список всех переменных, см. vars/1:

current_vars
unused_vars
prematch_vars
contextual_vars

Следующие поля устарели и не должны использоваться:

vars - список всех определённых переменных в виде {var, context}

Краткое описание

Функции

has_var?(env, var): Проверяет, принадлежит ли переменная окружению.
in_guard?(env): Возвращает значение, указывающее, находится ли окружение компиляции в данный момент внутри условия.
in_match?(env): Возвращает значение, указывающее, находится ли окружение компиляции в данный момент внутри условия совпадения.
location(env): Возвращает список ключевых слов, содержащий информацию о файле и строке в качестве ключей.
stacktrace(env): Возвращает трассировку стека окружения.
to_match(env): Возвращает Macro.Env в контексте совпадения.
vars(env): Возвращает список переменных в текущем окружении.

Типы

aliases()

Характеристики

aliases() :: [{module(), module()}]

context()

Характеристики

context() :: :match | :guard | nil

context_modules()

Характеристики

context_modules() :: [module()]

file()

Характеристики

file() :: binary()

functions()

Характеристики

functions() :: [{module(), [name_arity()]}]

lexical_tracker()

Характеристики

lexical_tracker() :: pid() | nil

line()

Характеристики

line() :: non_neg_integer()

macro_aliases()

Характеристики

macro_aliases() :: [{module(), {term(), module()}}]

macros()

Характеристики

macros() :: [{module(), [name_arity()]}]

name_arity()

Характеристики

name_arity() :: {atom(), arity()}

requires()

Характеристики

requires() :: [module()]

t()

Характеристики

t() :: %Macro.Env{
  module: atom(),
  file: file(),
  line: line(),
  function: name_arity() | nil,
  context: context(),
  requires: requires(),
  aliases: aliases(),
  functions: functions(),
  macros: macros(),
  macro_aliases: macro_aliases(),
  context_modules: context_modules(),
  vars: vars(),
  unused_vars: unused_vars(),
  current_vars: current_vars(),
  prematch_vars: prematch_vars(),
  lexical_tracker: lexical_tracker(),
  contextual_vars: contextual_vars()
}

variable()

Характеристики

variable() :: {atom(), atom() | term()}

Функции

has_var?(env, var)

Характеристики

has_var?(t(), variable()) :: boolean()

Проверяет, принадлежит ли переменная окружению.

in_guard?(env)

Характеристики

in_guard?(t()) :: boolean()

Возвращает значение, указывающее, находится ли окружение компиляции в данный момент внутри условия.

in_match?(env)

Характеристики

in_match?(t()) :: boolean()

Возвращает значение, указывающее, находится ли окружение компиляции в данный момент внутри условия совпадения.

location(env)

Характеристики

location(t()) :: keyword()

Возвращает список ключевых слов, содержащий информацию о файле и строке в качестве ключей.

stacktrace(env)

Характеристики

stacktrace(t()) :: list()

Возвращает трассировку стека окружения.

to_match(env)

Характеристики

to_match(t()) :: t()

Возвращает Macro.Env в контексте совпадения.

vars(env)

Характеристики

vars(t()) :: [variable()]

Возвращает список переменных в текущем окружении.

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