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 - список модулей, определённых в текущем контексте
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(), {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(),
  unused_vars: unused_vars(),
  current_vars: current_vars(),
  prematch_vars: prematch_vars(),
  lexical_tracker: lexical_tracker(),
  contextual_vars: contextual_vars()
}

var()

var() :: {atom(), atom() | non_neg_integer()}

Функции

has_var?(env, var) (since 1.7.0)

has_var?(t(), var()) :: 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) (since 1.7.0)

vars(t()) :: [var()]

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

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