{-# LANGUAGE CPP #-}
{-# LANGUAGE TypeOperators #-}

#if __GLASGOW_HASKELL__ >= 702
{-# LANGUAGE Trustworthy #-}
#endif
-----------------------------------------------------------------------------
-- |
-- Copyright   :  (C) 2011-2015 Edward Kmett
-- License     :  BSD-style (see the file LICENSE)
--
-- Maintainer  :  Edward Kmett <ekmett@gmail.com>
-- Stability   :  provisional
-- Portability :  portable
--
----------------------------------------------------------------------------
module Data.Functor.Plus
  ( Plus(..)
  , module Data.Functor.Alt
  ) where

import Control.Applicative hiding (some, many)
import Control.Applicative.Backwards
import Control.Applicative.Lift
import Control.Arrow
-- import Control.Exception
import Control.Monad
import Control.Monad.Trans.Identity
-- import Control.Monad.Trans.Cont
import Control.Monad.Trans.Error
import Control.Monad.Trans.Except
import Control.Monad.Trans.List
import Control.Monad.Trans.Maybe
import Control.Monad.Trans.Reader
import qualified Control.Monad.Trans.RWS.Strict as Strict
import qualified Control.Monad.Trans.State.Strict as Strict
import qualified Control.Monad.Trans.Writer.Strict as Strict
import qualified Control.Monad.Trans.RWS.Lazy as Lazy
import qualified Control.Monad.Trans.State.Lazy as Lazy
import qualified Control.Monad.Trans.Writer.Lazy as Lazy
import Data.Functor.Apply
import Data.Functor.Alt
import Data.Functor.Bind
import Data.Functor.Compose
import Data.Functor.Product
import Data.Functor.Reverse
import qualified Data.Monoid as Monoid
import Data.Semigroup hiding (Product)
import Prelude hiding (id, (.))

#ifdef MIN_VERSION_containers
import qualified Data.IntMap as IntMap
import Data.IntMap (IntMap)
import Data.Sequence (Seq)
import qualified Data.Map as Map
import Data.Map (Map)
#endif

#if defined(MIN_VERSION_tagged) || (MIN_VERSION_base(4,7,0))
import Data.Proxy
#endif

#ifdef MIN_VERSION_unordered_containers
import Data.Hashable
import Data.HashMap.Lazy (HashMap)
import qualified Data.HashMap.Lazy as HashMap
#endif

#ifdef MIN_VERSION_generic_deriving
import Generics.Deriving.Base
#else
import GHC.Generics
#endif

-- | Laws:
--
-- > zero <!> m = m
-- > m <!> zero = m
--
-- If extended to an 'Alternative' then 'zero' should equal 'empty'.

class Alt f => Plus f where
  zero :: f a

instance Plus Proxy where
  zero :: Proxy a
zero = Proxy a
forall k (t :: k). Proxy t
Proxy

instance Plus U1 where
  zero :: U1 a
zero = U1 a
forall k (p :: k). U1 p
U1

instance (Plus f, Plus g) => Plus (f :*: g) where
  zero :: (:*:) f g a
zero = f a
forall (f :: * -> *) a. Plus f => f a
zero f a -> g a -> (:*:) f g a
forall k (f :: k -> *) (g :: k -> *) (p :: k).
f p -> g p -> (:*:) f g p
:*: g a
forall (f :: * -> *) a. Plus f => f a
zero

instance Plus f => Plus (M1 i c f) where
  zero :: M1 i c f a
zero = f a -> M1 i c f a
forall k i (c :: Meta) (f :: k -> *) (p :: k). f p -> M1 i c f p
M1 f a
forall (f :: * -> *) a. Plus f => f a
zero

instance Plus f => Plus (Rec1 f) where
  zero :: Rec1 f a
zero = f a -> Rec1 f a
forall k (f :: k -> *) (p :: k). f p -> Rec1 f p
Rec1 f a
forall (f :: * -> *) a. Plus f => f a
zero

instance Plus IO where
  zero :: IO a
zero = [Char] -> IO a
forall a. HasCallStack => [Char] -> a
error [Char]
"zero"

instance Plus [] where
  zero :: [a]
zero = []

instance Plus Maybe where
  zero :: Maybe a
zero = Maybe a
forall a. Maybe a
Nothing

instance Plus Option where
  zero :: Option a
zero = Option a
forall (f :: * -> *) a. Alternative f => f a
empty

instance MonadPlus m => Plus (WrappedMonad m) where
  zero :: WrappedMonad m a
zero = WrappedMonad m a
forall (f :: * -> *) a. Alternative f => f a
empty

instance ArrowPlus a => Plus (WrappedArrow a b) where
  zero :: WrappedArrow a b a
zero = WrappedArrow a b a
forall (f :: * -> *) a. Alternative f => f a
empty

#ifdef MIN_VERSION_containers
instance Ord k => Plus (Map k) where
  zero :: Map k a
zero = Map k a
forall k a. Map k a
Map.empty

instance Plus IntMap where
  zero :: IntMap a
zero = IntMap a
forall a. IntMap a
IntMap.empty

instance Plus Seq where
  zero :: Seq a
zero = Seq a
forall a. Monoid a => a
mempty
#endif

#ifdef MIN_VERSION_unordered_containers
instance (Hashable k, Eq k) => Plus (HashMap k) where
  zero :: HashMap k a
zero = HashMap k a
forall k v. HashMap k v
HashMap.empty
#endif

instance Alternative f => Plus (WrappedApplicative f) where
  zero :: WrappedApplicative f a
zero = WrappedApplicative f a
forall (f :: * -> *) a. Alternative f => f a
empty

instance Plus f => Plus (IdentityT f) where
  zero :: IdentityT f a
zero = f a -> IdentityT f a
forall k (f :: k -> *) (a :: k). f a -> IdentityT f a
IdentityT f a
forall (f :: * -> *) a. Plus f => f a
zero

instance Plus f => Plus (ReaderT e f) where
  zero :: ReaderT e f a
zero = (e -> f a) -> ReaderT e f a
forall r (m :: * -> *) a. (r -> m a) -> ReaderT r m a
ReaderT ((e -> f a) -> ReaderT e f a) -> (e -> f a) -> ReaderT e f a
forall a b. (a -> b) -> a -> b
$ \e
_ -> f a
forall (f :: * -> *) a. Plus f => f a
zero

instance (Bind f, Monad f) => Plus (MaybeT f) where
  zero :: MaybeT f a
zero = f (Maybe a) -> MaybeT f a
forall (m :: * -> *) a. m (Maybe a) -> MaybeT m a
MaybeT (f (Maybe a) -> MaybeT f a) -> f (Maybe a) -> MaybeT f a
forall a b. (a -> b) -> a -> b
$ Maybe a -> f (Maybe a)
forall (m :: * -> *) a. Monad m => a -> m a
return Maybe a
forall (f :: * -> *) a. Plus f => f a
zero

instance (Bind f, Monad f, Error e) => Plus (ErrorT e f) where
  zero :: ErrorT e f a
zero = f (Either e a) -> ErrorT e f a
forall e (m :: * -> *) a. m (Either e a) -> ErrorT e m a
ErrorT (f (Either e a) -> ErrorT e f a) -> f (Either e a) -> ErrorT e f a
forall a b. (a -> b) -> a -> b
$ Either e a -> f (Either e a)
forall (m :: * -> *) a. Monad m => a -> m a
return (Either e a -> f (Either e a)) -> Either e a -> f (Either e a)
forall a b. (a -> b) -> a -> b
$ e -> Either e a
forall a b. a -> Either a b
Left e
forall a. Error a => a
noMsg

instance (Bind f, Monad f, Semigroup e, Monoid e) => Plus (ExceptT e f) where
  zero :: ExceptT e f a
zero = f (Either e a) -> ExceptT e f a
forall e (m :: * -> *) a. m (Either e a) -> ExceptT e m a
ExceptT (f (Either e a) -> ExceptT e f a)
-> f (Either e a) -> ExceptT e f a
forall a b. (a -> b) -> a -> b
$ Either e a -> f (Either e a)
forall (m :: * -> *) a. Monad m => a -> m a
return (Either e a -> f (Either e a)) -> Either e a -> f (Either e a)
forall a b. (a -> b) -> a -> b
$ e -> Either e a
forall a b. a -> Either a b
Left e
forall a. Monoid a => a
mempty

instance (Apply f, Applicative f) => Plus (ListT f) where
  zero :: ListT f a
zero = f [a] -> ListT f a
forall (m :: * -> *) a. m [a] -> ListT m a
ListT (f [a] -> ListT f a) -> f [a] -> ListT f a
forall a b. (a -> b) -> a -> b
$ [a] -> f [a]
forall (f :: * -> *) a. Applicative f => a -> f a
pure []

instance Plus f => Plus (Strict.StateT e f) where
  zero :: StateT e f a
zero = (e -> f (a, e)) -> StateT e f a
forall s (m :: * -> *) a. (s -> m (a, s)) -> StateT s m a
Strict.StateT ((e -> f (a, e)) -> StateT e f a)
-> (e -> f (a, e)) -> StateT e f a
forall a b. (a -> b) -> a -> b
$ \e
_ -> f (a, e)
forall (f :: * -> *) a. Plus f => f a
zero

instance Plus f => Plus (Lazy.StateT e f) where
  zero :: StateT e f a
zero = (e -> f (a, e)) -> StateT e f a
forall s (m :: * -> *) a. (s -> m (a, s)) -> StateT s m a
Lazy.StateT ((e -> f (a, e)) -> StateT e f a)
-> (e -> f (a, e)) -> StateT e f a
forall a b. (a -> b) -> a -> b
$ \e
_ -> f (a, e)
forall (f :: * -> *) a. Plus f => f a
zero

instance Plus f => Plus (Strict.WriterT w f) where
  zero :: WriterT w f a
zero = f (a, w) -> WriterT w f a
forall w (m :: * -> *) a. m (a, w) -> WriterT w m a
Strict.WriterT f (a, w)
forall (f :: * -> *) a. Plus f => f a
zero

instance Plus f => Plus (Lazy.WriterT w f) where
  zero :: WriterT w f a
zero = f (a, w) -> WriterT w f a
forall w (m :: * -> *) a. m (a, w) -> WriterT w m a
Lazy.WriterT f (a, w)
forall (f :: * -> *) a. Plus f => f a
zero

instance Plus f => Plus (Strict.RWST r w s f) where
  zero :: RWST r w s f a
zero = (r -> s -> f (a, s, w)) -> RWST r w s f a
forall r w s (m :: * -> *) a.
(r -> s -> m (a, s, w)) -> RWST r w s m a
Strict.RWST ((r -> s -> f (a, s, w)) -> RWST r w s f a)
-> (r -> s -> f (a, s, w)) -> RWST r w s f a
forall a b. (a -> b) -> a -> b
$ \r
_ s
_ -> f (a, s, w)
forall (f :: * -> *) a. Plus f => f a
zero

instance Plus f => Plus (Lazy.RWST r w s f) where
  zero :: RWST r w s f a
zero = (r -> s -> f (a, s, w)) -> RWST r w s f a
forall r w s (m :: * -> *) a.
(r -> s -> m (a, s, w)) -> RWST r w s m a
Lazy.RWST ((r -> s -> f (a, s, w)) -> RWST r w s f a)
-> (r -> s -> f (a, s, w)) -> RWST r w s f a
forall a b. (a -> b) -> a -> b
$ \r
_ s
_ -> f (a, s, w)
forall (f :: * -> *) a. Plus f => f a
zero

instance Plus f => Plus (Backwards f) where
  zero :: Backwards f a
zero = f a -> Backwards f a
forall k (f :: k -> *) (a :: k). f a -> Backwards f a
Backwards f a
forall (f :: * -> *) a. Plus f => f a
zero

instance (Plus f, Functor g) => Plus (Compose f g) where
  zero :: Compose f g a
zero = f (g a) -> Compose f g a
forall k k1 (f :: k -> *) (g :: k1 -> k) (a :: k1).
f (g a) -> Compose f g a
Compose f (g a)
forall (f :: * -> *) a. Plus f => f a
zero

instance Plus f => Plus (Lift f) where
  zero :: Lift f a
zero = f a -> Lift f a
forall (f :: * -> *) a. f a -> Lift f a
Other f a
forall (f :: * -> *) a. Plus f => f a
zero

instance (Plus f, Plus g) => Plus (Product f g) where
  zero :: Product f g a
zero = f a -> g a -> Product f g a
forall k (f :: k -> *) (g :: k -> *) (a :: k).
f a -> g a -> Product f g a
Pair f a
forall (f :: * -> *) a. Plus f => f a
zero g a
forall (f :: * -> *) a. Plus f => f a
zero

instance Plus f => Plus (Reverse f) where
  zero :: Reverse f a
zero = f a -> Reverse f a
forall k (f :: k -> *) (a :: k). f a -> Reverse f a
Reverse f a
forall (f :: * -> *) a. Plus f => f a
zero

instance Plus Monoid.First where
  zero :: First a
zero = Maybe a -> First a
forall a. Maybe a -> First a
Monoid.First Maybe a
forall a. Maybe a
Nothing

instance Plus Monoid.Last where
  zero :: Last a
zero = Maybe a -> Last a
forall a. Maybe a -> Last a
Monoid.Last Maybe a
forall a. Maybe a
Nothing