Macro.Env

Introduction #

A struct that holds compile time environment information.

The current environment can be accessed at any time as __ENV__. Inside macros, the caller environment can be accessed as __CALLER__. It contains the following fields:

  • module - the current module name
  • file - the current file name as a binary
  • line - the current line as an integer
  • function - a tuple as {atom, integer}, where the first element is the function name and the seconds its arity; returns nil if not inside a function
  • context - the context of the environment; it can be nil (default context), inside a guard or inside an assign
  • aliases - a list of two item tuples, where the first item is the aliased name and the second the actual name
  • requires - the list of required modules
  • functions - a list of functions imported from each module
  • macros - a list of macros imported from each module
  • macro_aliases - a list of aliases defined inside the current macro
  • context_modules - a list of modules defined in the current context
  • vars - a list keeping all defined variables as {var, context}
  • export_vars - a list keeping all variables to be exported in a construct (may be nil)
  • lexical_tracker - PID of the lexical tracker which is responsible to keep user info
  • local - the module to expand local functions to
Source

Types #

name_arity :: {atom, arity}

file :: binary

line :: non_neg_integer

aliases :: [{module, module}]

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

context :: :match | :guard | nil

requires :: [module]

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

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

context_modules :: [module]

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

export_vars :: vars | nil

lexical_tracker :: pid

local :: atom | nil

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, local: local}

Functions #

in_guard?(arg1)

(function)

Returns whether the compilation environment is currently inside a guard.

in_match?(arg1)

(function)

Returns whether the compilation environment is currently inside a match clause.

location(arg1)

(function)

Returns a keyword list containing the file and line information as keys.

stacktrace(env)

(function)

Returns the environment stacktrace.