View Source Igniter.Code.Function (igniter v0.5.2)

Utilities for working with functions.

Summary

Functions

append_argument(zipper, value)

Appends an argument to a function call, leaving the zipper at the function call's node.

argument_equals?(zipper, index, term)

Checks if the provided function call (in a Zipper) has an argument that equals term at index.

argument_matches_pattern?(zipper, index, pattern)

Returns true if the argument at the provided index exists and matches the provided pattern

argument_matches_predicate?(zipper, index, func)

Returns true if the argument at the given index matches the provided predicate

function(zipper, atom, arity)
function?(zipper, name \\ :any, arity \\ :any)

Returns true if the value is a function literal.

function_call?(zipper)

Returns true if the node is a function call

function_call?(zipper, name, arity \\ :any)

Returns true if the node is a function call of the given name

get_local_function_call(zipper)

Gets the name and arity of a local function call.

get_local_function_call_name(zipper)

Gets the name of a local function call.

move_to_def(zipper)
move_to_def(zipper, fun, arity)
move_to_defp(zipper, fun, arity)
move_to_function_call(zipper, name, arity, predicate \\ fn _ -> true end)

Moves to a function call by the given name and arity, matching the given predicate, in the current or lower scope

move_to_function_call_in_current_scope(zipper, name, arity, predicate \\ fn _ -> true end)

Moves to a function call by the given name and arity, matching the given predicate, in the current scope

move_to_nth_argument(zipper, index)

Moves to the nth argument of a function call.

update_nth_argument(zipper, index, func)

Updates the nth argument of a function call, leaving the zipper at the function call's node.

Functions

append_argument(zipper, value)

@spec append_argument(Sourceror.Zipper.t(), any()) ::
  {:ok, Sourceror.Zipper.t()} | :error

Appends an argument to a function call, leaving the zipper at the function call's node.

argument_equals?(zipper, index, term)

@spec argument_equals?(Sourceror.Zipper.t(), integer(), any()) :: boolean()

Checks if the provided function call (in a Zipper) has an argument that equals term at index.

argument_matches_pattern?(zipper, index, pattern)

(macro)

Returns true if the argument at the provided index exists and matches the provided pattern

Note: to check for argument equality, use argument_equals?/3 instead.

argument_matches_predicate?(zipper, index, func)

@spec argument_matches_predicate?(
  Sourceror.Zipper.t(),
  non_neg_integer(),
  (Sourceror.Zipper.t() ->
     boolean())
) :: boolean()

Returns true if the argument at the given index matches the provided predicate

function(zipper, atom, arity)

function?(zipper, name \\ :any, arity \\ :any)

@spec function?(
  Sourceror.Zipper.t(),
  name :: :any | :any_named | {module(), atom()} | :anonymous,
  arity :: :any | non_neg_integer() | [non_neg_integer()]
) :: boolean()

Returns true if the value is a function literal.

Examples:

  • fn x -> x end
  • &(&1 + &2)
  • &SomeMod.fun/2

To refine the check, you can use name and arity.

Names

  • :any - matches any function literal, named or not
  • :any_named - matches any named function literal
  • :anonymous - matches any anonymous function literal
  • {module, name} - matches a function literal with the given module and name

function_call?(zipper)

@spec function_call?(Sourceror.Zipper.t()) :: boolean()

Returns true if the node is a function call

function_call?(zipper, name, arity \\ :any)

@spec function_call?(
  Sourceror.Zipper.t(),
  atom() | {module(), atom()},
  arity :: integer() | :any | [integer()]
) :: boolean()

Returns true if the node is a function call of the given name

If an atom is provided, it only matches functions in the form of function(name).

If an {module, atom} is provided, it matches functions called on the given module, taking into account any imports or aliases.

get_local_function_call(zipper)

@spec get_local_function_call(Sourceror.Zipper.t()) ::
  {:ok, {atom(), non_neg_integer()}} | :error

Gets the name and arity of a local function call.

Returns :error if the node is not a function call or cannot be determined.

get_local_function_call_name(zipper)

@spec get_local_function_call_name(Sourceror.Zipper.t()) :: {:ok, atom()} | :error

Gets the name of a local function call.

Returns :error if the node is not a function call or cannot be determined.

move_to_def(zipper)

@spec move_to_def(Sourceror.Zipper.t()) :: {:ok, Sourceror.Zipper.t()} | :error

move_to_def(zipper, fun, arity)

@spec move_to_def(
  Sourceror.Zipper.t(),
  fun :: atom(),
  arity :: integer() | [integer()]
) ::
  {:ok, Sourceror.Zipper.t()} | :error

move_to_defp(zipper, fun, arity)

@spec move_to_defp(
  Sourceror.Zipper.t(),
  fun :: atom(),
  arity :: integer() | [integer()]
) ::
  {:ok, Sourceror.Zipper.t()} | :error

move_to_function_call(zipper, name, arity, predicate \\ fn _ -> true end)

Moves to a function call by the given name and arity, matching the given predicate, in the current or lower scope

move_to_function_call_in_current_scope(zipper, name, arity, predicate \\ fn _ -> true end)

Moves to a function call by the given name and arity, matching the given predicate, in the current scope

move_to_nth_argument(zipper, index)

@spec move_to_nth_argument(
  Sourceror.Zipper.t(),
  non_neg_integer()
) :: {:ok, Sourceror.Zipper.t()} | :error

Moves to the nth argument of a function call.

update_nth_argument(zipper, index, func)

@spec update_nth_argument(
  Sourceror.Zipper.t(),
  non_neg_integer(),
  (Sourceror.Zipper.t() -> {:ok, Sourceror.Zipper.t()} | :error)
) :: {:ok, Sourceror.Zipper.t()} | :error

Updates the nth argument of a function call, leaving the zipper at the function call's node.