Elixir v1.6.4 Macro.Env View Source
A struct that holds compile time environment information.
The current environment can be accessed at any time as
__ENV__/0
. Inside macros, the caller environment can be
accessed as __CALLER__/0
.
An instance of Macro.Env
must not be modified by hand. If you need to
create a custom environment to pass to Code.eval_quoted/3
, use the
following trick:
def make_custom_env do
import SomeModule, only: [some_function: 2]
alias A.B.C
__ENV__
end
You may then call make_custom_env()
to get a struct with the desired
imports and aliases included.
It contains the following fields:
module
- the current module namefile
- the current file name as a binaryline
- the current line as an integerfunction
- a tuple as{atom, integer}
, where the first element is the function name and the second its arity; returnsnil
if not inside a functioncontext
- the context of the environment; it can benil
(default context), inside a guard or inside a matchaliases
- a list of two-element tuples, where the first element is the aliased name and the second one the actual namerequires
- the list of required modulesfunctions
- a list of functions imported from each modulemacros
- a list of macros imported from each modulemacro_aliases
- a list of aliases defined inside the current macrocontext_modules
- a list of modules defined in the current contextlexical_tracker
- PID of the lexical tracker which is responsible for keeping user infovars
- a list keeping all defined variables as{var, context}
The following fields are private and must not be accessed or relied on:
export_vars
- a list keeping all variables to be exported in a construct (may benil
)match_vars
- controls how “new” variables are handled. Inside a match it is a list with all variables in a match. Outside of a match is either:warn
or:apply
prematch_vars
- a list of variables defined before a match (isnil
when not inside a match)
Link to this section Summary
Functions
Returns whether the compilation environment is currently inside a guard
Returns whether the compilation environment is currently inside a match clause
Returns a keyword list containing the file and line information as keys
Returns the environment stacktrace
Returns a Macro.Env
in the match context
Link to this section Types
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() }
Link to this section Functions
Returns whether the compilation environment is currently inside a guard.
Returns whether the compilation environment is currently inside a match clause.
Returns a keyword list containing the file and line information as keys.
Returns the environment stacktrace.
Returns a Macro.Env
in the match context.