-- This Source Code Form is subject to the terms of the Mozilla Public
-- License, v. 2.0. If a copy of the MPL was not distributed with this
-- file, You can obtain one at https://mozilla.org/MPL/2.0/.

{- |
Copyright   :  (c) 2023-2024 Sayo Koyoneda
               (c) 2023 Casper Bach Poulsen and Cas van der Rest
License     :  MPL-2.0 (see the file LICENSE)
Maintainer  :  ymdfield@outlook.jp
Stability   :  experimental
Portability :  portable
-}
module Data.Effect where

import Data.Effect.HFunctor (HFunctor, hfmap)
import Data.Kind (Type)

-- | The kind of first-order effects.
type EffectF = Type -> Type

-- | The kind of higher-order effects.
type EffectH = (Type -> Type) -> Type -> Type

{- | Lift first-order effects to higher-order effects.

     Come from [heft-lang\/POPL2023\/haskell\/src\/Elab.hs]
    (https://github.com/heft-lang/POPL2023/blob/74afe1d5ce0b491cffe40cc5c73a2a5ee6a94d9c/haskell/src/Elab.hs#L9-L10).
-}
newtype LiftFOE (ins :: EffectF) (f :: Type -> Type) a = LiftFOE {forall (ins :: EffectF) (f :: EffectF) a. LiftFOE ins f a -> ins a
unliftFOE :: ins a}
    deriving stock ((forall a b. (a -> b) -> LiftFOE ins f a -> LiftFOE ins f b)
-> (forall a b. a -> LiftFOE ins f b -> LiftFOE ins f a)
-> Functor (LiftFOE ins f)
forall a b. a -> LiftFOE ins f b -> LiftFOE ins f a
forall a b. (a -> b) -> LiftFOE ins f a -> LiftFOE ins f b
forall (f :: EffectF).
(forall a b. (a -> b) -> f a -> f b)
-> (forall a b. a -> f b -> f a) -> Functor f
forall (ins :: EffectF) (f :: EffectF) a b.
Functor ins =>
a -> LiftFOE ins f b -> LiftFOE ins f a
forall (ins :: EffectF) (f :: EffectF) a b.
Functor ins =>
(a -> b) -> LiftFOE ins f a -> LiftFOE ins f b
$cfmap :: forall (ins :: EffectF) (f :: EffectF) a b.
Functor ins =>
(a -> b) -> LiftFOE ins f a -> LiftFOE ins f b
fmap :: forall a b. (a -> b) -> LiftFOE ins f a -> LiftFOE ins f b
$c<$ :: forall (ins :: EffectF) (f :: EffectF) a b.
Functor ins =>
a -> LiftFOE ins f b -> LiftFOE ins f a
<$ :: forall a b. a -> LiftFOE ins f b -> LiftFOE ins f a
Functor, (forall m. Monoid m => LiftFOE ins f m -> m)
-> (forall m a. Monoid m => (a -> m) -> LiftFOE ins f a -> m)
-> (forall m a. Monoid m => (a -> m) -> LiftFOE ins f a -> m)
-> (forall a b. (a -> b -> b) -> b -> LiftFOE ins f a -> b)
-> (forall a b. (a -> b -> b) -> b -> LiftFOE ins f a -> b)
-> (forall b a. (b -> a -> b) -> b -> LiftFOE ins f a -> b)
-> (forall b a. (b -> a -> b) -> b -> LiftFOE ins f a -> b)
-> (forall a. (a -> a -> a) -> LiftFOE ins f a -> a)
-> (forall a. (a -> a -> a) -> LiftFOE ins f a -> a)
-> (forall a. LiftFOE ins f a -> [a])
-> (forall a. LiftFOE ins f a -> Bool)
-> (forall a. LiftFOE ins f a -> Int)
-> (forall a. Eq a => a -> LiftFOE ins f a -> Bool)
-> (forall a. Ord a => LiftFOE ins f a -> a)
-> (forall a. Ord a => LiftFOE ins f a -> a)
-> (forall a. Num a => LiftFOE ins f a -> a)
-> (forall a. Num a => LiftFOE ins f a -> a)
-> Foldable (LiftFOE ins f)
forall a. Eq a => a -> LiftFOE ins f a -> Bool
forall a. Num a => LiftFOE ins f a -> a
forall a. Ord a => LiftFOE ins f a -> a
forall m. Monoid m => LiftFOE ins f m -> m
forall a. LiftFOE ins f a -> Bool
forall a. LiftFOE ins f a -> Int
forall a. LiftFOE ins f a -> [a]
forall a. (a -> a -> a) -> LiftFOE ins f a -> a
forall m a. Monoid m => (a -> m) -> LiftFOE ins f a -> m
forall b a. (b -> a -> b) -> b -> LiftFOE ins f a -> b
forall a b. (a -> b -> b) -> b -> LiftFOE ins f a -> b
forall (t :: EffectF).
(forall m. Monoid m => t m -> m)
-> (forall m a. Monoid m => (a -> m) -> t a -> m)
-> (forall m a. Monoid m => (a -> m) -> t a -> m)
-> (forall a b. (a -> b -> b) -> b -> t a -> b)
-> (forall a b. (a -> b -> b) -> b -> t a -> b)
-> (forall b a. (b -> a -> b) -> b -> t a -> b)
-> (forall b a. (b -> a -> b) -> b -> t a -> b)
-> (forall a. (a -> a -> a) -> t a -> a)
-> (forall a. (a -> a -> a) -> t a -> a)
-> (forall a. t a -> [a])
-> (forall a. t a -> Bool)
-> (forall a. t a -> Int)
-> (forall a. Eq a => a -> t a -> Bool)
-> (forall a. Ord a => t a -> a)
-> (forall a. Ord a => t a -> a)
-> (forall a. Num a => t a -> a)
-> (forall a. Num a => t a -> a)
-> Foldable t
forall (ins :: EffectF) (f :: EffectF) a.
(Foldable ins, Eq a) =>
a -> LiftFOE ins f a -> Bool
forall (ins :: EffectF) (f :: EffectF) a.
(Foldable ins, Num a) =>
LiftFOE ins f a -> a
forall (ins :: EffectF) (f :: EffectF) a.
(Foldable ins, Ord a) =>
LiftFOE ins f a -> a
forall (ins :: EffectF) (f :: EffectF) m.
(Foldable ins, Monoid m) =>
LiftFOE ins f m -> m
forall (ins :: EffectF) (f :: EffectF) a.
Foldable ins =>
LiftFOE ins f a -> Bool
forall (ins :: EffectF) (f :: EffectF) a.
Foldable ins =>
LiftFOE ins f a -> Int
forall (ins :: EffectF) (f :: EffectF) a.
Foldable ins =>
LiftFOE ins f a -> [a]
forall (ins :: EffectF) (f :: EffectF) a.
Foldable ins =>
(a -> a -> a) -> LiftFOE ins f a -> a
forall (ins :: EffectF) (f :: EffectF) m a.
(Foldable ins, Monoid m) =>
(a -> m) -> LiftFOE ins f a -> m
forall (ins :: EffectF) (f :: EffectF) b a.
Foldable ins =>
(b -> a -> b) -> b -> LiftFOE ins f a -> b
forall (ins :: EffectF) (f :: EffectF) a b.
Foldable ins =>
(a -> b -> b) -> b -> LiftFOE ins f a -> b
$cfold :: forall (ins :: EffectF) (f :: EffectF) m.
(Foldable ins, Monoid m) =>
LiftFOE ins f m -> m
fold :: forall m. Monoid m => LiftFOE ins f m -> m
$cfoldMap :: forall (ins :: EffectF) (f :: EffectF) m a.
(Foldable ins, Monoid m) =>
(a -> m) -> LiftFOE ins f a -> m
foldMap :: forall m a. Monoid m => (a -> m) -> LiftFOE ins f a -> m
$cfoldMap' :: forall (ins :: EffectF) (f :: EffectF) m a.
(Foldable ins, Monoid m) =>
(a -> m) -> LiftFOE ins f a -> m
foldMap' :: forall m a. Monoid m => (a -> m) -> LiftFOE ins f a -> m
$cfoldr :: forall (ins :: EffectF) (f :: EffectF) a b.
Foldable ins =>
(a -> b -> b) -> b -> LiftFOE ins f a -> b
foldr :: forall a b. (a -> b -> b) -> b -> LiftFOE ins f a -> b
$cfoldr' :: forall (ins :: EffectF) (f :: EffectF) a b.
Foldable ins =>
(a -> b -> b) -> b -> LiftFOE ins f a -> b
foldr' :: forall a b. (a -> b -> b) -> b -> LiftFOE ins f a -> b
$cfoldl :: forall (ins :: EffectF) (f :: EffectF) b a.
Foldable ins =>
(b -> a -> b) -> b -> LiftFOE ins f a -> b
foldl :: forall b a. (b -> a -> b) -> b -> LiftFOE ins f a -> b
$cfoldl' :: forall (ins :: EffectF) (f :: EffectF) b a.
Foldable ins =>
(b -> a -> b) -> b -> LiftFOE ins f a -> b
foldl' :: forall b a. (b -> a -> b) -> b -> LiftFOE ins f a -> b
$cfoldr1 :: forall (ins :: EffectF) (f :: EffectF) a.
Foldable ins =>
(a -> a -> a) -> LiftFOE ins f a -> a
foldr1 :: forall a. (a -> a -> a) -> LiftFOE ins f a -> a
$cfoldl1 :: forall (ins :: EffectF) (f :: EffectF) a.
Foldable ins =>
(a -> a -> a) -> LiftFOE ins f a -> a
foldl1 :: forall a. (a -> a -> a) -> LiftFOE ins f a -> a
$ctoList :: forall (ins :: EffectF) (f :: EffectF) a.
Foldable ins =>
LiftFOE ins f a -> [a]
toList :: forall a. LiftFOE ins f a -> [a]
$cnull :: forall (ins :: EffectF) (f :: EffectF) a.
Foldable ins =>
LiftFOE ins f a -> Bool
null :: forall a. LiftFOE ins f a -> Bool
$clength :: forall (ins :: EffectF) (f :: EffectF) a.
Foldable ins =>
LiftFOE ins f a -> Int
length :: forall a. LiftFOE ins f a -> Int
$celem :: forall (ins :: EffectF) (f :: EffectF) a.
(Foldable ins, Eq a) =>
a -> LiftFOE ins f a -> Bool
elem :: forall a. Eq a => a -> LiftFOE ins f a -> Bool
$cmaximum :: forall (ins :: EffectF) (f :: EffectF) a.
(Foldable ins, Ord a) =>
LiftFOE ins f a -> a
maximum :: forall a. Ord a => LiftFOE ins f a -> a
$cminimum :: forall (ins :: EffectF) (f :: EffectF) a.
(Foldable ins, Ord a) =>
LiftFOE ins f a -> a
minimum :: forall a. Ord a => LiftFOE ins f a -> a
$csum :: forall (ins :: EffectF) (f :: EffectF) a.
(Foldable ins, Num a) =>
LiftFOE ins f a -> a
sum :: forall a. Num a => LiftFOE ins f a -> a
$cproduct :: forall (ins :: EffectF) (f :: EffectF) a.
(Foldable ins, Num a) =>
LiftFOE ins f a -> a
product :: forall a. Num a => LiftFOE ins f a -> a
Foldable, Functor (LiftFOE ins f)
Foldable (LiftFOE ins f)
(Functor (LiftFOE ins f), Foldable (LiftFOE ins f)) =>
(forall (f :: EffectF) a b.
 Applicative f =>
 (a -> f b) -> LiftFOE ins f a -> f (LiftFOE ins f b))
-> (forall (f :: EffectF) a.
    Applicative f =>
    LiftFOE ins f (f a) -> f (LiftFOE ins f a))
-> (forall (m :: EffectF) a b.
    Monad m =>
    (a -> m b) -> LiftFOE ins f a -> m (LiftFOE ins f b))
-> (forall (m :: EffectF) a.
    Monad m =>
    LiftFOE ins f (m a) -> m (LiftFOE ins f a))
-> Traversable (LiftFOE ins f)
forall (t :: EffectF).
(Functor t, Foldable t) =>
(forall (f :: EffectF) a b.
 Applicative f =>
 (a -> f b) -> t a -> f (t b))
-> (forall (f :: EffectF) a. Applicative f => t (f a) -> f (t a))
-> (forall (m :: EffectF) a b.
    Monad m =>
    (a -> m b) -> t a -> m (t b))
-> (forall (m :: EffectF) a. Monad m => t (m a) -> m (t a))
-> Traversable t
forall (m :: EffectF) a.
Monad m =>
LiftFOE ins f (m a) -> m (LiftFOE ins f a)
forall (f :: EffectF) a.
Applicative f =>
LiftFOE ins f (f a) -> f (LiftFOE ins f a)
forall (m :: EffectF) a b.
Monad m =>
(a -> m b) -> LiftFOE ins f a -> m (LiftFOE ins f b)
forall (f :: EffectF) a b.
Applicative f =>
(a -> f b) -> LiftFOE ins f a -> f (LiftFOE ins f b)
forall (ins :: EffectF) (f :: EffectF).
Traversable ins =>
Functor (LiftFOE ins f)
forall (ins :: EffectF) (f :: EffectF).
Traversable ins =>
Foldable (LiftFOE ins f)
forall (ins :: EffectF) (f :: EffectF) (m :: EffectF) a.
(Traversable ins, Monad m) =>
LiftFOE ins f (m a) -> m (LiftFOE ins f a)
forall (ins :: EffectF) (f :: EffectF) (f :: EffectF) a.
(Traversable ins, Applicative f) =>
LiftFOE ins f (f a) -> f (LiftFOE ins f a)
forall (ins :: EffectF) (f :: EffectF) (m :: EffectF) a b.
(Traversable ins, Monad m) =>
(a -> m b) -> LiftFOE ins f a -> m (LiftFOE ins f b)
forall (ins :: EffectF) (f :: EffectF) (f :: EffectF) a b.
(Traversable ins, Applicative f) =>
(a -> f b) -> LiftFOE ins f a -> f (LiftFOE ins f b)
$ctraverse :: forall (ins :: EffectF) (f :: EffectF) (f :: EffectF) a b.
(Traversable ins, Applicative f) =>
(a -> f b) -> LiftFOE ins f a -> f (LiftFOE ins f b)
traverse :: forall (f :: EffectF) a b.
Applicative f =>
(a -> f b) -> LiftFOE ins f a -> f (LiftFOE ins f b)
$csequenceA :: forall (ins :: EffectF) (f :: EffectF) (f :: EffectF) a.
(Traversable ins, Applicative f) =>
LiftFOE ins f (f a) -> f (LiftFOE ins f a)
sequenceA :: forall (f :: EffectF) a.
Applicative f =>
LiftFOE ins f (f a) -> f (LiftFOE ins f a)
$cmapM :: forall (ins :: EffectF) (f :: EffectF) (m :: EffectF) a b.
(Traversable ins, Monad m) =>
(a -> m b) -> LiftFOE ins f a -> m (LiftFOE ins f b)
mapM :: forall (m :: EffectF) a b.
Monad m =>
(a -> m b) -> LiftFOE ins f a -> m (LiftFOE ins f b)
$csequence :: forall (ins :: EffectF) (f :: EffectF) (m :: EffectF) a.
(Traversable ins, Monad m) =>
LiftFOE ins f (m a) -> m (LiftFOE ins f a)
sequence :: forall (m :: EffectF) a.
Monad m =>
LiftFOE ins f (m a) -> m (LiftFOE ins f a)
Traversable)

instance HFunctor (LiftFOE ins) where
    hfmap :: forall (f :: EffectF) (g :: EffectF).
(f :-> g) -> LiftFOE ins f :-> LiftFOE ins g
hfmap f :-> g
_ (LiftFOE ins i
e) = ins i -> LiftFOE ins g i
forall (ins :: EffectF) (f :: EffectF) a. ins a -> LiftFOE ins f a
LiftFOE ins i
e
    {-# INLINE hfmap #-}

-- | A first-order effect with no operations.
data Nop :: EffectF

-- | A higher-order effect with no operations.
type LNop = LiftFOE Nop