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


-- | A data type with elements separated by values
--   
--   A data type with elements separated by values
@package separated
@version 0.1.2

module Data.Separated.SeparatedCons

-- | Prepend a value to a separated-like structure.
class (f ~ SeparatedConsF g, g ~ SeparatedConsG f) => SeparatedCons f g where type SeparatedConsF g :: * -> * -> * type SeparatedConsG f :: * -> * -> * where {
    type family SeparatedConsF g :: * -> * -> *;
    type family SeparatedConsG f :: * -> * -> *;
}
(+:) :: SeparatedCons f g => a -> f b a -> g a b

module Data.Separated.Separated
data Separated a b

-- | The isomorphism to a list of pairs of element and separator values.
--   
--   <pre>
--   &gt;&gt;&gt; separated # empty
--   []
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; separated # ('x' +: 6 +: empty)
--   [('x',6)]
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; [] ^. separated
--   []
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; [(6, [])] ^. separated
--   [6,[]]
--   </pre>
separated :: Iso [(a, b)] [(c, d)] (Separated a b) (Separated c d)
data Separated1 b a

-- | The isomorphism to element values interspersed with a separator.
--   
--   <pre>
--   &gt;&gt;&gt; separated1 # (single 6)
--   (6,[])
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; separated1 # (5 +: 'x' +: single 6)
--   (5,['x',6])
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; (6, empty) ^. separated1
--   [6]
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; (5, 'x' +- 6) ^. separated1
--   [5,'x',6]
--   </pre>
separated1 :: Iso (a, Separated s a) (b, Separated t b) (Separated1 a s) (Separated1 b t)

-- | A lens on the first element value.
--   
--   <pre>
--   &gt;&gt;&gt; single 7 ^. separated1Head
--   7
--   </pre>
--   
--   <pre>
--   single x ^. separated1Head == (x :: Int)
--   </pre>
separated1Head :: Lens (Separated1 a t) (Separated1 a t) a a

-- | A lens on the tail.
--   
--   <pre>
--   (d +: e +: single x) ^. separated1Tail == e +: x +: empty
--   </pre>
separated1Tail :: Lens (Separated1 a s) (Separated1 a t) (Separated s a) (Separated t a)
empty :: Separated s a

-- | One element and one separator.
--   
--   <pre>
--   &gt;&gt;&gt; 7 +- "abc"
--   [7,"abc"]
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; 7 +: "abc" +: 8 +- "def"
--   [7,"abc",8,"def"]
--   </pre>
(+-) :: s -> a -> Separated s a
infixl 9 +-

-- | Zero element values interspersed with one element.
--   
--   <pre>
--   &gt;&gt;&gt; single 4
--   [4]
--   </pre>
--   
--   <pre>
--   single x ^. separated1Tail == empty
--   </pre>
single :: a -> Separated1 a s

-- | The isomorphism that shuffles the elements and separators one
--   position.
--   
--   <pre>
--   &gt;&gt;&gt; shift # ([], 6)
--   [6]
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; shift # ([(5, 'x')], 6)
--   [5,'x',6]
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; single 6 ^. shift
--   ([],6)
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; (5 +: 'x' +: single 6) ^. shift
--   ([(5,'x')],6)
--   </pre>
shift :: Iso (Separated1 a s) (Separated1 b t) ([(a, s)], a) ([(b, t)], b)

-- | Append two lists of separated values to produce a list of pairs of
--   separator and element values.
--   
--   <pre>
--   &gt;&gt;&gt; single 7 .++. single 'a'
--   [7,'a']
--   </pre>
--   
--   <tt>a</tt> +: single 7 .++. single <tt>b</tt>
--   [<tt>a</tt>,7,<tt>b</tt>]
--   
--   <pre>
--   a +: (b :: Separated Int Int) == a +: b --  (a +: (b .++. c)) == ((a +: b) .++ c)
--   </pre>
(.++.) :: Separated1 s a -> Separated1 a s -> Separated s a
infixr 5 .++.

-- | Append element values interspersed with a separator to a list of pairs
--   of separator and element values.
--   
--   <pre>
--   &gt;&gt;&gt; empty ++. single 7
--   [7]
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; empty ++. 6 +: 'x' +: single 7
--   [6,'x',7]
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; 'w' +: empty ++. 6 +: 'x' +: single 7
--   ['w',6,'x',7]
--   </pre>
(++.) :: Separated s a -> Separated1 s a -> Separated1 s a
infixr 5 ++.

-- | Append a list of pairs of separator and element values to element
--   values interspersed with a separator.
--   
--   <pre>
--   &gt;&gt;&gt; single 7 .++ empty
--   [7]
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; single 6 .++ 'x' +: 7 +: empty
--   [6,'x',7]
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; 'w' +: single 6 .++ 'x' +: 7 +: empty
--   ['w',6,'x',7]
--   </pre>
(.++) :: Separated1 a s -> Separated s a -> Separated1 a s
infixr 5 .++

-- | <pre>
--   &gt;&gt;&gt; parse (separatedBy (char ',') digit) "test" ""
--   Right []
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; isLeft (parse (separatedBy (char ',') digit) "test" ",")
--   True
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; parse (separatedBy (char ',') digit) "test" ",1"
--   Right [',','1']
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; isLeft (parse (separatedBy (char ',') digit) "test" ",1,")
--   True
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; parse (separatedBy (char ',') digit) "test" ",1,2,3,4,5"
--   Right [',','1',',','2',',','3',',','4',',','5']
--   </pre>
separatedBy :: Alternative f => f a -> f b -> f (Separated a b)

-- | <pre>
--   &gt;&gt;&gt; isLeft (parse (separatedBy1 (char ',') digit) "test" "")
--   True
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; parse (separatedBy1 (char ',') digit) "test" ","
--   Right [',']
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; isLeft (parse (separatedBy1 (char ',') digit) "test" ",1")
--   True
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; parse (separatedBy1 (char ',') digit) "test" ",1,"
--   Right [',','1',',']
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; parse (separatedBy1 (char ',') digit) "test" ",1,2,3,4,5,"
--   Right [',','1',',','2',',','3',',','4',',','5',',']
--   </pre>
separatedBy1 :: Alternative f => f b -> f a -> f (Separated1 b a)
instance (GHC.Classes.Ord a, GHC.Classes.Ord b) => GHC.Classes.Ord (Data.Separated.Separated.Separated1 b a)
instance (GHC.Classes.Eq a, GHC.Classes.Eq b) => GHC.Classes.Eq (Data.Separated.Separated.Separated1 b a)
instance Data.Separated.Separated.Separated a0 b0 ~ t0 => Control.Lens.Wrapped.Rewrapped (Data.Separated.Separated.Separated a1 b1) t0
instance Control.Lens.Wrapped.Wrapped (Data.Separated.Separated.Separated a0 b0)
instance Control.Lens.Iso.Swapped Data.Separated.Separated.Separated
instance Data.Bifunctor.Bifunctor Data.Separated.Separated.Separated
instance Data.Bifoldable.Bifoldable Data.Separated.Separated.Separated
instance Data.Bitraversable.Bitraversable Data.Separated.Separated.Separated
instance GHC.Base.Functor (Data.Separated.Separated.Separated a)
instance Data.Semigroup.Semigroup a => Data.Functor.Bind.Class.Apply (Data.Separated.Separated.Separated a)
instance (Data.Semigroup.Semigroup a, GHC.Base.Monoid a) => GHC.Base.Applicative (Data.Separated.Separated.Separated a)
instance (GHC.Show.Show a, GHC.Show.Show b) => GHC.Show.Show (Data.Separated.Separated.Separated a b)
instance Data.Semigroup.Semigroup (Data.Separated.Separated.Separated a b)
instance GHC.Base.Monoid (Data.Separated.Separated.Separated a b)
instance Data.Separated.SeparatedCons.SeparatedCons Data.Separated.Separated.Separated1 Data.Separated.Separated.Separated
instance Data.Bifunctor.Bifunctor Data.Separated.Separated.Separated1
instance GHC.Base.Functor (Data.Separated.Separated.Separated1 b)
instance Data.Semigroup.Semigroup b => Data.Functor.Bind.Class.Apply (Data.Separated.Separated.Separated1 b)
instance (GHC.Show.Show b, GHC.Show.Show a) => GHC.Show.Show (Data.Separated.Separated.Separated1 b a)
instance (Data.Semigroup.Semigroup b, GHC.Base.Monoid b) => GHC.Base.Applicative (Data.Separated.Separated.Separated1 b)
instance Data.Separated.SeparatedCons.SeparatedCons Data.Separated.Separated.Separated Data.Separated.Separated.Separated1
instance (GHC.Classes.Ord b, GHC.Classes.Ord a) => GHC.Classes.Ord (Data.Separated.Separated.Separated a b)
instance (GHC.Classes.Eq b, GHC.Classes.Eq a) => GHC.Classes.Eq (Data.Separated.Separated.Separated a b)

module Data.Separated