-- 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 Yamada Ryo
               (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)

-- | A kind of /signature class/ (a datatype of higher-order effect).
type SigClass = (Type -> Type) -> Type -> Type

-- | A kind of /instruction class/ (a datatype of first-order effect).
type InsClass = Type -> Type

{- | Lift an /instruction class/ to a /signature class/.

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

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

-- | An /instruction class/ with no effects.
data Nop :: InsClass

-- | A /signature class/ with no effects.
type LNop = LiftIns Nop