@spec aggregate_module_funs(Hologram.Compiler.IR.ModuleDefinition.t()) :: [
  {{atom(), non_neg_integer()},
   {:public | :private, [Hologram.Compiler.IR.FunctionClause.t()]}}
]

Aggregates function clauses from a module definition.

Returns

A list, where each item is in the format: {{function_name, arity}, {visibility, [clause_1, clause_2, ...]}}

Example

iex> module_def = %ModuleDefinition{...}
iex> aggregate_module_funs(module_def)
[
  {{:my_function_1, 3}, {:public, [%IR.FunctionClause{...}, %IR.FunctionClause{...}]}},
  {{:my_function_2, 1}, {:private, [%IR.FunctionClause{...}]}}
]

@spec for_code(binary(), Hologram.Compiler.Context.t()) :: t()

Returns Hologram IR for the given Elixir source code.

Examples

iex> for_code("my_fun(1, 2)")
%IR.LocalFunctionCall{function: :my_fun, args: [%IR.IntegerType{value: 1}, %IR.IntegerType{value: 2}]}

@spec for_module(module(), charlist() | nil) :: t()

Returns Hologram IR of the given module. Specifying the module's BEAM path makes the call faster.

Examples

iex> for_module(MyModule)
%IR.ModuleDefinition{module: MyModule, body: %IR.Block{expressions: [...]}}

@spec for_term(any()) :: {:ok, t()} | {:error, String.t()}

Returns Hologram IR for the given Elixir term. If the term can be represented in IR then its value is returned in the shape of {:ok, ir}. If the term can't be represented in IR then an error message is returned in the shape of {:error, message}.

Examples

iex> my_var = 123
iex> for_term(my_var)
{:ok, %IR.IntegerType{value: 123}}

@spec for_term!(any()) :: t()

Returns Hologram IR for the given Elixir term, erroring out if the term can't be represented in IR.

Examples

iex> my_var = 123
iex> for_term!(my_var)
%IR.IntegerType{value: 123}