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 - список всех определённых переменных в виде {var, context}

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

• export_vars - список всех переменных, которые нужно экспортировать в конструкцию (может быть nil)
• match_vars - управляет тем, как обрабатываются новые переменные. Внутри `match` это список всех переменных в `match`. Вне `match` это либо :warn, либо :apply
• prematch_vars - список переменных, определённых до `match` (равен nil когда не внутри `match`)

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

Типы

aliases()

context()

context_modules()

export_vars()

file()

functions()

lexical_tracker()

line()

local()

macro_aliases()

macros()

match_vars()

name_arity()

prematch_vars()

requires()

t()

vars()

Функции

in_guard?(env)

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

in_match?(env)

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

location(env)

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

stacktrace(env)

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

to_match(env)

Возвращает Macro.Env в контексте `match`

Типы

aliases()

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

context()

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

context_modules()

context_modules() :: [module()]

export_vars() (непрозрачный)

export_vars()

file()

file() :: binary()

functions()

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

lexical_tracker()

lexical_tracker() :: pid() | nil

line()

line() :: non_neg_integer()

local()

local() :: atom() | nil

macro_aliases()

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

macros()

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

match_vars() (непрозрачный)

match_vars()

name_arity()

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

prematch_vars() (непрозрачный)

prematch_vars()

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(),
  match_vars: match_vars(),
  prematch_vars: prematch_vars(),
  lexical_tracker: lexical_tracker()
}

vars()

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

Функции

in_guard?(env)

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

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

in_match?(env)

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

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

location(env)

location(t()) :: keyword()

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

stacktrace(env)

stacktrace(t()) :: list()

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

to_match(env)

to_match(t()) :: t()

Возвращает Macro.Env в контексте `match`.