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 (по умолчанию), внутри условия или внутри оператора соответствия
aliases — список кортежей из двух элементов, где первый элемент — алиас, а второй — фактическое имя
requires — список требуемых модулей
functions — список функций, импортированных из каждого модуля
macros — список макросов, импортированных из каждого модуля
macro_aliases — список псевдонимов, определённых внутри текущего макроса
context_modules — список модулей, определённых в текущем контексте
vars — список всех определённых переменных в формате {var, context}
export_vars — список всех переменных, которые должны быть экспортированы в конструкцию (может быть nil)
lexical_tracker — PID лексического трекера, который отвечает за хранение информации о пользователе

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

Функции

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

Типы

aliases()

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

context()

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

context_modules()

context_modules() :: [module()]

export_vars()

export_vars() :: vars() | nil

file()

file() :: binary()

functions()

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

lexical_tracker()

lexical_tracker() :: pid()

line()

line() :: non_neg_integer()

local()

local() :: atom() | nil

macro_aliases()

macro_aliases() :: [{module(), {integer(), 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: aliases(), context_modules: context_modules(), vars: vars(), export_vars: export_vars(), lexical_tracker: lexical_tracker()}

vars()

vars() :: [{atom(), atom() | non_neg_integer()}]

Функции

in_guard?(env)

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

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

in_match?(env)

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

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

location(env)

location(t()) :: Keyword.t()

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

stacktrace(env)

stacktrace(t()) :: list()

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