-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/

-- | A zipper-like comonad which works as a list, tracking a position.
--   
--   A PointedList tracks the position in a non-empty list which works
--   similarly to a zipper. A current item is always required, and
--   therefore the list may never be empty. A circular PointedList wraps
--   around to the other end when progressing past the actual edge.
@package pointedlist
@version 0.6.1

-- | An implementation of a zipper-like non-empty list structure that
--   tracks an index position in the list (the focus).
module Data.List.PointedList

-- | The implementation of the pointed list structure which tracks the
--   current position in the list structure.
data PointedList a
PointedList :: [a] -> a -> [a] -> PointedList a
[_reversedPrefix] :: PointedList a -> [a]
[_focus] :: PointedList a -> a
[_suffix] :: PointedList a -> [a]

-- | Lens compatible with Control.Lens.
reversedPrefix :: Functor f => ([a] -> f [a]) -> PointedList a -> f (PointedList a)

-- | Lens compatible with Control.Lens.
focus :: Functor f => (a -> f a) -> PointedList a -> f (PointedList a)

-- | Lens compatible with Control.Lens.
suffix :: Functor f => ([a] -> f [a]) -> PointedList a -> f (PointedList a)

-- | Lens compatible with Control.Lens. Internally reversing the prefix
--   list.
prefix :: Functor f => ([a] -> f [a]) -> PointedList a -> f (PointedList a)

-- | Create a PointedList with a single element.
singleton :: a -> PointedList a

-- | Possibly create a Just PointedList if the
--   provided list has at least one element; otherwise, return Nothing.
--   
--   The provided list's head will be the focus of the list, and the rest
--   of list will follow on the right side.
fromList :: [a] -> Maybe (PointedList a)

-- | Possibly create a Just PointedList if the
--   provided list has at least one element; otherwise, return Nothing.
--   
--   The provided list's last element will be the focus of the list,
--   following the rest of the list in order, to the left.
fromListEnd :: [a] -> Maybe (PointedList a)

-- | Replace the focus of the list, retaining the prefix and suffix.
replace :: a -> PointedList a -> PointedList a

-- | Possibly move the focus to the next element in the list.
next :: PointedList a -> Maybe (PointedList a)

-- | Attempt to move the focus to the next element, or error if
--   there are no more elements.
tryNext :: PointedList a -> PointedList a

-- | Possibly move the focus to the previous element in the list.
previous :: PointedList a -> Maybe (PointedList a)

-- | Attempt to move the focus to the previous element, or error if
--   there are no more elements.
tryPrevious :: PointedList a -> PointedList a

-- | An alias for insertRight.
insert :: a -> PointedList a -> PointedList a

-- | Insert an element to the left of the focus, then move the focus to the
--   new element.
insertLeft :: a -> PointedList a -> PointedList a

-- | Insert an element to the right of the focus, then move the focus to
--   the new element.
insertRight :: a -> PointedList a -> PointedList a

-- | An alias of deleteRight.
delete :: PointedList a -> Maybe (PointedList a)

-- | Possibly delete the element at the focus, then move the element on the
--   left to the focus. If no element is on the left, focus on the element
--   to the right. If the deletion will cause the list to be empty, return
--   Nothing.
deleteLeft :: PointedList a -> Maybe (PointedList a)

-- | Possibly delete the element at the focus, then move the element on the
--   right to the focus. If no element is on the right, focus on the
--   element to the left. If the deletion will cause the list to be empty,
--   return Nothing.
deleteRight :: PointedList a -> Maybe (PointedList a)

-- | Delete all elements in the list except the focus.
deleteOthers :: PointedList a -> PointedList a

-- | The length of the list.
length :: PointedList a -> Int

-- | Whether the focus is the first element.
atStart :: PointedList a -> Bool

-- | Whether the focus is the last element.
atEnd :: PointedList a -> Bool

-- | Create a PointedList of variations of the provided
--   PointedList, in which each element is focused, with the
--   provided PointedList as the focus of the sets.
positions :: PointedList a -> PointedList (PointedList a)

-- | Map over the PointedLists created via positions, such
--   that f is called with each element of the list focused in the
--   provided PointedList. An example makes this easier to
--   understand:
--   
--   
--   contextMap atStart (fromJust $ fromList [1..5])
--   
contextMap :: (PointedList a -> b) -> PointedList a -> PointedList b

-- | Create a PointedList a of (a, Bool),
--   in which the boolean values specify whether the current element has
--   the focus. That is, all of the booleans will be False, except
--   the focused element.
withFocus :: PointedList a -> PointedList (a, Bool)

-- | Move the focus to the specified index. The first element is at index
--   0.
moveTo :: Int -> PointedList a -> Maybe (PointedList a)

-- | Move the focus by n, relative to the current index. Negative
--   values move the focus backwards, positive values more forwards through
--   the list.
moveN :: Int -> PointedList a -> Maybe (PointedList a)

-- | Move the focus to the specified element, if it is present.
--   
--   Patch with much faster algorithm provided by Runar Bjarnason for
--   version 0.3.2. Improved again by Runar Bjarnason for version 0.3.3 to
--   support infinite lists on both sides of the focus.
find :: Eq a => a -> PointedList a -> Maybe (PointedList a)

-- | The index of the focus, leftmost is 0.
index :: PointedList a -> Int
instance Data.Binary.Class.Binary a => Data.Binary.Class.Binary (Data.List.PointedList.PointedList a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Data.List.PointedList.PointedList a)
instance GHC.Internal.Data.Foldable.Foldable Data.List.PointedList.PointedList
instance GHC.Internal.Base.Functor Data.List.PointedList.PointedList
instance GHC.Internal.Show.Show a => GHC.Internal.Show.Show (Data.List.PointedList.PointedList a)
instance GHC.Internal.Data.Traversable.Traversable Data.List.PointedList.PointedList

module Data.List.PointedList.Circular

-- | The index of the focus, leftmost is 0.
index :: PointedList a -> Int

-- | Possibly create a Just PointedList if the
--   provided list has at least one element; otherwise, return Nothing.
--   
--   The provided list's head will be the focus of the list, and the rest
--   of list will follow on the right side.
fromList :: [a] -> Maybe (PointedList a)

-- | The length of the list.
length :: PointedList a -> Int

-- | Move the focus to the specified element, if it is present.
--   
--   Patch with much faster algorithm provided by Runar Bjarnason for
--   version 0.3.2. Improved again by Runar Bjarnason for version 0.3.3 to
--   support infinite lists on both sides of the focus.
find :: Eq a => a -> PointedList a -> Maybe (PointedList a)

-- | An alias for insertRight.
insert :: a -> PointedList a -> PointedList a

-- | Create a PointedList with a single element.
singleton :: a -> PointedList a

-- | The implementation of the pointed list structure which tracks the
--   current position in the list structure.
data PointedList a
PointedList :: [a] -> a -> [a] -> PointedList a
[_reversedPrefix] :: PointedList a -> [a]
[_focus] :: PointedList a -> a
[_suffix] :: PointedList a -> [a]

-- | Lens compatible with Control.Lens.
focus :: Functor f => (a -> f a) -> PointedList a -> f (PointedList a)

-- | Possibly create a Just PointedList if the
--   provided list has at least one element; otherwise, return Nothing.
--   
--   The provided list's last element will be the focus of the list,
--   following the rest of the list in order, to the left.
fromListEnd :: [a] -> Maybe (PointedList a)

-- | Replace the focus of the list, retaining the prefix and suffix.
replace :: a -> PointedList a -> PointedList a

-- | Insert an element to the left of the focus, then move the focus to the
--   new element.
insertLeft :: a -> PointedList a -> PointedList a

-- | Insert an element to the right of the focus, then move the focus to
--   the new element.
insertRight :: a -> PointedList a -> PointedList a

-- | Delete all elements in the list except the focus.
deleteOthers :: PointedList a -> PointedList a

-- | Create a PointedList of variations of the provided
--   PointedList, in which each element is focused, with the
--   provided PointedList as the focus of the sets.
positions :: PointedList a -> PointedList (PointedList a)

-- | Map over the PointedLists created via positions, such
--   that f is called with each element of the list focused in the
--   provided PointedList. An example makes this easier to
--   understand:
--   
--   
--   contextMap atStart (fromJust $ fromList [1..5])
--   
contextMap :: (PointedList a -> b) -> PointedList a -> PointedList b

-- | Create a PointedList a of (a, Bool),
--   in which the boolean values specify whether the current element has
--   the focus. That is, all of the booleans will be False, except
--   the focused element.
withFocus :: PointedList a -> PointedList (a, Bool)

-- | Move the focus to the next element in the list. If the last element is
--   currently focused, loop to the first element.
next :: PointedList a -> PointedList a

-- | Move the focus to the previous element in the list. If the first
--   element is currently focused, loop to the last element.
previous :: PointedList a -> PointedList a

-- | An alias of deleteRight.
delete :: PointedList a -> Maybe (PointedList a)

-- | Possibly delete the element at the focus, then move the element on the
--   left to the focus. If no element is on the left, focus on the element
--   to the right. If the deletion will cause the list to be empty, return
--   Nothing.
deleteLeft :: PointedList a -> Maybe (PointedList a)

-- | Possibly delete the element at the focus, then move the element on the
--   right to the focus. If no element is on the right, focus on the
--   element to the left. If the deletion will cause the list to be empty,
--   return Nothing.
deleteRight :: PointedList a -> Maybe (PointedList a)

-- | Move
moveN :: Int -> PointedList a -> PointedList a
