View Source Styler.Zipper (Styler v1.2.1)

Implements a Zipper for the Elixir AST based on Gérard Huet Functional pearl: the zipper paper and Clojure's clojure.zip API.

A zipper is a data structure that represents a location in a tree from the perspective of the current node, also called focus. It is represented by a 2-tuple where the first element is the focus and the second element is the metadata/context. The metadata is nil when the focus is the topmost node

Summary

Types

command()

path()

t()

tree()

zipper()

Functions

any?(zipper, fun)

Traverses zipper, returning true when fun.(Zipper.node(zipper)) is truthy, or false otherwise

append_child(arg, child)

Inserts the item as the rightmost child of the node at this zipper, without moving.

children(arg)

Returns a list of children of the node.

down(zipper)

Returns the zipper of the leftmost child of the node at this zipper, or nil if no there's no children.

find(zipper, direction \\ :next, predicate)

Returns a zipper to the node that satisfies the predicate function, or nil if none is found.

insert_child(arg, child)

Inserts the item as the leftmost child of the node at this zipper, without moving.

insert_left(arg, child)

Inserts the item as the left sibling of the node at this zipper, without moving. Raises an ArgumentError when attempting to insert a sibling at the top level.

insert_right(arg, child)

Inserts the item as the right sibling of the node at this zipper, without moving. Raises an ArgumentError when attempting to insert a sibling at the top level.

insert_siblings(arg, siblings)

Inserts many siblings to the right.

left(arg1)

Returns the zipper of the left sibling of the node at this zipper, or nil.

leftmost(zipper)

Returns the leftmost sibling of the node at this zipper, or itself.

next(zipper)

Returns the following zipper in depth-first pre-order.

node(arg)

Returns the node at the zipper.

prepend_siblings(arg, siblings)

Inserts many siblings to the left.

prev(zipper)

Returns the previous zipper in depth-first pre-order. Returns nil if the tree is already at the top.

remove(arg)

Removes the node at the zipper, returning the zipper that would have preceded it in a depth-first walk.

replace(arg, tree)

Replaces the current node in the zipper with a new node.

replace_children(arg, children)

Returns the zipper with the current children of the node replaced with children

right(arg1)

Returns the zipper of the right sibling of the node at this zipper, or nil.

rightmost(zipper)

Returns the rightmost sibling of the node at this zipper, or itself.

root(zipper)

Walks the zipper all the way up and returns the root node.

skip(zipper, direction \\ :next)

Returns the zipper of the right sibling of the node at this zipper, or the next zipper when no right sibling is available.

top(zipper)

Walks the zipper all the way up and returns the top zipper.

traverse(zipper, fun)

Traverses the tree in depth-first pre-order calling the given function for each node.

traverse(zipper, acc, fun)

Traverses the tree in depth-first pre-order calling the given function for each node with an accumulator.

traverse_while(zipper, fun)

Traverses the tree in depth-first pre-order calling the given function for each node.

traverse_while(zipper, acc, fun)

Traverses the tree in depth-first pre-order calling the given function for each node with an accumulator.

up(arg)

Returns the zipper of the parent of the node at this zipper, or nil if at the top.

update(arg, fun)

Replaces the current node in the zipper with the result of applying fun to the node.

zip(term)

Creates a zipper from a tree node.

Types

command()

@type command() :: :cont | :skip | :halt

path()

@opaque path()

t()

@type t() :: zipper()

tree()

@type tree() :: Macro.t()

zipper()

@type zipper() :: {tree(), path() | nil}

Functions

any?(zipper, fun)

@spec any?(zipper(), (tree() -> term())) :: boolean()

Traverses zipper, returning true when fun.(Zipper.node(zipper)) is truthy, or false otherwise

append_child(arg, child)

Inserts the item as the rightmost child of the node at this zipper, without moving.

children(arg)

@spec children(zipper()) :: [tree()]

Returns a list of children of the node.

down(zipper)

@spec down(zipper()) :: zipper() | nil

Returns the zipper of the leftmost child of the node at this zipper, or nil if no there's no children.

find(zipper, direction \\ :next, predicate)

@spec find(zipper(), direction :: :prev | :next, predicate :: (tree() -> any())) ::
  zipper() | nil

Returns a zipper to the node that satisfies the predicate function, or nil if none is found.

The optional second parameters specifies the direction, defaults to :next.

insert_child(arg, child)

Inserts the item as the leftmost child of the node at this zipper, without moving.

insert_left(arg, child)

@spec insert_left(zipper(), tree()) :: zipper()

Inserts the item as the left sibling of the node at this zipper, without moving. Raises an ArgumentError when attempting to insert a sibling at the top level.

insert_right(arg, child)

@spec insert_right(zipper(), tree()) :: zipper()

Inserts the item as the right sibling of the node at this zipper, without moving. Raises an ArgumentError when attempting to insert a sibling at the top level.

insert_siblings(arg, siblings)

@spec insert_siblings(zipper(), [tree()]) :: zipper()

Inserts many siblings to the right.

Equivalent to

Enum.reduce(siblings, zipper, &Zipper.insert_right(&2, &1))

left(arg1)

@spec left(zipper()) :: zipper() | nil

Returns the zipper of the left sibling of the node at this zipper, or nil.

leftmost(zipper)

@spec leftmost(zipper()) :: zipper()

Returns the leftmost sibling of the node at this zipper, or itself.

next(zipper)

@spec next(zipper()) :: zipper() | nil

Returns the following zipper in depth-first pre-order.

node(arg)

@spec node(zipper()) :: tree()

Returns the node at the zipper.

prepend_siblings(arg, siblings)

@spec prepend_siblings(zipper(), [tree()]) :: zipper()

Inserts many siblings to the left.

Equivalent to

Enum.reduce(siblings, zipper, &Zipper.insert_left(&2, &1))

prev(zipper)

@spec prev(zipper()) :: zipper() | nil

Returns the previous zipper in depth-first pre-order. Returns nil if the tree is already at the top.

remove(arg)

@spec remove(zipper()) :: zipper()

Removes the node at the zipper, returning the zipper that would have preceded it in a depth-first walk.

replace(arg, tree)

@spec replace(zipper(), tree()) :: zipper()

Replaces the current node in the zipper with a new node.

replace_children(arg, children)

@spec replace_children(zipper(), [tree()]) :: zipper()

Returns the zipper with the current children of the node replaced with children

right(arg1)

@spec right(zipper()) :: zipper() | nil

Returns the zipper of the right sibling of the node at this zipper, or nil.

rightmost(zipper)

@spec rightmost(zipper()) :: zipper()

Returns the rightmost sibling of the node at this zipper, or itself.

root(zipper)

@spec root(zipper()) :: tree()

Walks the zipper all the way up and returns the root node.

skip(zipper, direction \\ :next)

@spec skip(zipper(), direction :: :next | :prev) :: zipper() | nil

Returns the zipper of the right sibling of the node at this zipper, or the next zipper when no right sibling is available.

This allows to skip subtrees while traversing the siblings of a node.

The optional second parameters specifies the direction, defaults to :next.

If no right/left sibling is available, this function returns the same value as next/1/prev/1.

The function skip/1 behaves like the :skip in traverse_while/2 and traverse_while/3.

top(zipper)

@spec top(zipper()) :: zipper()

Walks the zipper all the way up and returns the top zipper.

traverse(zipper, fun)

@spec traverse(zipper(), (zipper() -> zipper())) :: zipper()

Traverses the tree in depth-first pre-order calling the given function for each node.

If the zipper is not at the top, just the subtree will be traversed.

The function must return a zipper.

traverse(zipper, acc, fun)

@spec traverse(zipper(), term(), (zipper(), term() -> {zipper(), term()})) ::
  {zipper(), term()}

Traverses the tree in depth-first pre-order calling the given function for each node with an accumulator.

If the zipper is not at the top, just the subtree will be traversed.

traverse_while(zipper, fun)

@spec traverse_while(zipper(), (zipper() -> {command(), zipper()})) :: zipper()

Traverses the tree in depth-first pre-order calling the given function for each node.

The traversing will continue if the function returns {:cont, zipper}, skipped for {:skip, zipper} and halted for {:halt, zipper}

If the zipper is not at the top, just the subtree will be traversed.

The function must return a zipper.

traverse_while(zipper, acc, fun)

@spec traverse_while(
  zipper(),
  term(),
  (zipper(), term() -> {command(), zipper(), term()})
) ::
  {zipper(), term()}

Traverses the tree in depth-first pre-order calling the given function for each node with an accumulator.

The traversing will continue if the function returns {:cont, zipper, acc}, skipped for {:skip, zipper, acc} and halted for {:halt, zipper, acc}

If the zipper is not at the top, just the subtree will be traversed.

up(arg)

@spec up(zipper()) :: zipper() | nil

Returns the zipper of the parent of the node at this zipper, or nil if at the top.

update(arg, fun)

@spec update(zipper(), (tree() -> tree())) :: zipper()

Replaces the current node in the zipper with the result of applying fun to the node.

zip(term)

@spec zip(tree()) :: zipper()

Creates a zipper from a tree node.