data-effects 0.1.2.0 → 0.2.0.0

raw patch · 22 files changed

+113/−141 lines, 22 filesdep ~basedep ~data-defaultdep ~data-effects-corePVP ok

version bump matches the API change (PVP)

Dependency ranges changed: base, data-default, data-effects-core, data-effects-th, lens, tasty, time

API changes (from Hackage documentation)

Files

• ChangeLog.md +6/−0
• README.md +9/−6
• data-effects.cabal +15/−14
• src/Data/Effect/Accum.hs +1/−1
• src/Data/Effect/Concurrent/Thread.hs +1/−1
• src/Data/Effect/Concurrent/Timer.hs +1/−1
• src/Data/Effect/Coroutine.hs +7/−7
• src/Data/Effect/Except.hs +1/−1
• src/Data/Effect/Fresh.hs +1/−1
• src/Data/Effect/Input.hs +1/−1
• src/Data/Effect/KVStore.hs +1/−1
• src/Data/Effect/NonDet.hs +1/−1
• src/Data/Effect/Output.hs +1/−1
• src/Data/Effect/Provider.hs +35/−29
• src/Data/Effect/Provider/Implicit.hs +0/−45
• src/Data/Effect/Reader.hs +1/−1
• src/Data/Effect/Resource.hs +1/−1
• src/Data/Effect/ShiftReset.hs +22/−21
• src/Data/Effect/State.hs +1/−1
• src/Data/Effect/Unlift.hs +3/−3
• src/Data/Effect/Writer.hs +1/−1
• src/Prelude.hs +3/−3

@@ -3,3 +3,9 @@ ## 0.1.1.0 -- 2024-09-01 * Added 'Timer' effects. * Added convenience functions for error handling with the Except effect.++## 0.2.0.0 -- 2024-10-10+* Support for the core version upgrade to 0.2.+    * Support for GHC 9.8.2.+* Changed Shift/Reset and Provider effects to unlift form, making all effects HFunctor.+* Renamed the 'Coroutine' constructor (incorrect) of the 'Status' type in coroutines to 'Continue'.

@@ -13,10 +13,13 @@ ## Your contributions are welcome! Please see [CONTRIBUTING.md](https://github.com/sayo-hs/data-effects/blob/ef706ef3fa547de01ce6bb5636af911354e53b58/CONTRIBUTING.md). -## Credits-Parts of this project have been adapted or inspired by the following resources:+## Acknowledgements, citations, and related work+The following is a non-exhaustive list of people and works that have had a significant impact, directly or indirectly, on its design and implementation: -* **[compdata](https://github.com/pa-ba/compdata)**-    * **Copyright** (c) 2010--2011 Patrick Bahr, Tom Hvitved-    * **License**: BSD-3-Clause-    * **Modifications**: Used TemplateHaskell code to derive instances of the `HFunctor` type class.+- Casper Bach Poulsen and Cas van der Rest — [Hefty Algebras: Modular Elaboration of Higher-Order Algebraic Effects][casper:hefty]+- Patrick Bahr and Tom Hvitved — [`compdata`: Compositional Data Types][gh:compdata]+- Michael Szvetits — [`effet`][gh:effet]++[casper:hefty]: https://dl.acm.org/doi/10.1145/3571255+[gh:compdata]: https://github.com/pa-ba/compdata+[gh:effet]: https://github.com/typedbyte/effet

@@ -1,6 +1,6 @@ cabal-version:      2.4 name:               data-effects-version:            0.1.2.0+version:            0.2.0.0  -- A short (one-line) description of the package. synopsis: A basic framework for effect systems based on effects represented by GADTs.@@ -19,25 +19,27 @@ -- The license under which the package is released. license:            MPL-2.0 license-file:       LICENSE-author:             Yamada Ryo <ymdfield@outlook.jp>-maintainer:         Yamada Ryo <ymdfield@outlook.jp>+author:             Sayo Koyoneda <ymdfield@outlook.jp>+maintainer:         Sayo Koyoneda <ymdfield@outlook.jp>  -- A copyright notice.-copyright: 2023 Yamada Ryo+copyright: 2023-2024 Sayo Koyoneda category: Control, Effect -extra-source-files:+extra-doc-files:     ChangeLog.md     NOTICE     README.md  tested-with:+    GHC == 9.8.2+    GHC == 9.4.1     GHC == 9.2.8  source-repository head     type: git     location: https://github.com/sayo-hs/data-effects-    tag: v0.1.0+    tag: v0.2.0     subdir: data-effects  library@@ -51,8 +53,6 @@         Data.Effect.Coroutine         Data.Effect.Input         Data.Effect.Output-        Data.Effect.Provider-        Data.Effect.Provider.Implicit         Data.Effect.Fix         Data.Effect.Fail         Data.Effect.Cont@@ -62,6 +62,7 @@         Data.Effect.Concurrent.Thread         Data.Effect.Concurrent.Timer         Data.Effect.Unlift+        Data.Effect.Provider         Data.Effect.ShiftReset         Data.Effect.KVStore @@ -85,14 +86,14 @@     -- LANGUAGE extensions used by modules in this package.     -- other-extensions:     build-depends:-        base                        ^>= 4.16.4.0,-        data-effects-core           ^>= 0.1,-        data-effects-th             ^>= 0.1.2,+        base                        >= 4.16.4 && < 4.21,+        data-effects-core           ^>= 0.2,+        data-effects-th             ^>= 0.2,         these                       ^>= 1.2,         data-default                ^>= 0.7.1,         text                        >= 2.0 && < 2.2,-        lens                        ^>= 5.2.3,-        time                        ^>= 1.11.1,+        lens                        >= 5.2.3 && < 5.4,+        time                        >= 1.11.1 && < 1.15,      hs-source-dirs:   src     ghc-options:      -Wall@@ -117,7 +118,7 @@     build-depends:         data-effects,         base,-        tasty                         ^>= 1.4,+        tasty                         >= 1.4 && < 1.6,         tasty-hunit                   ^>= 0.10,      type: exitcode-stdio-1.0

@@ -5,7 +5,7 @@ -- file, You can obtain one at https://mozilla.org/MPL/2.0/.  {- |-Copyright   :  (c) 2023 Yamada Ryo+Copyright   :  (c) 2023 Sayo Koyoneda License     :  MPL-2.0 (see the file LICENSE) Maintainer  :  ymdfield@outlook.jp Stability   :  experimental

@@ -5,7 +5,7 @@ -- file, You can obtain one at https://mozilla.org/MPL/2.0/.  {- |-Copyright   :  (c) 2023 Yamada Ryo+Copyright   :  (c) 2023 Sayo Koyoneda License     :  MPL-2.0 (see the file LICENSE) Maintainer  :  ymdfield@outlook.jp Stability   :  experimental

@@ -5,7 +5,7 @@ -- file, You can obtain one at https://mozilla.org/MPL/2.0/.  {- |-Copyright   :  (c) 2024 Yamada Ryo+Copyright   :  (c) 2024 Sayo Koyoneda License     :  MPL-2.0 (see the file LICENSE) Maintainer  :  ymdfield@outlook.jp Stability   :  experimental

@@ -6,7 +6,7 @@  {- | Copyright   : (c) 2016 Allele Dev; 2017 Ixperta Solutions s.r.o.; 2017 Alexis King-              (c) 2023-2024 Yamada Ryo+              (c) 2023-2024 Sayo Koyoneda License     :  MPL-2.0 (see the file LICENSE) Maintainer  :  ymdfield@outlook.jp Stability   :  experimental@@ -25,21 +25,21 @@  makeEffectF [''Yield] -yield_ :: Yield a () <: f => a -> f ()+yield_ :: (Yield a () <: f) => a -> f () yield_ = yield {-# INLINE yield_ #-}  data Status f a b r     = Done r-    | Coroutine a (b -> f (Status f a b r))+    | Continue a (b -> f (Status f a b r))     deriving (Functor) -continueStatus :: Monad m => (x -> m (Status m a b r)) -> Status m a b x -> m (Status m a b r)+continueStatus :: (Monad m) => (x -> m (Status m a b r)) -> Status m a b x -> m (Status m a b r) continueStatus kk = \case     Done x -> kk x-    Coroutine a k -> pure . Coroutine a $ k >=> continueStatus kk+    Continue a k -> pure . Continue a $ k >=> continueStatus kk -loopStatus :: Monad m => (a -> m b) -> Status m a b r -> m r+loopStatus :: (Monad m) => (a -> m b) -> Status m a b r -> m r loopStatus f = \case     Done r -> pure r-    Coroutine a k -> f a >>= k >>= loopStatus f+    Continue a k -> f a >>= k >>= loopStatus f

@@ -5,7 +5,7 @@ -- file, You can obtain one at https://mozilla.org/MPL/2.0/.  {- |-Copyright   :  (c) 2023 Yamada Ryo+Copyright   :  (c) 2023 Sayo Koyoneda License     :  MPL-2.0 (see the file LICENSE) Maintainer  :  ymdfield@outlook.jp Stability   :  experimental

@@ -5,7 +5,7 @@ -- file, You can obtain one at https://mozilla.org/MPL/2.0/.  {- |-Copyright   :  (c) 2023 Yamada Ryo+Copyright   :  (c) 2023 Sayo Koyoneda License     :  MPL-2.0 (see the file LICENSE) Maintainer  :  ymdfield@outlook.jp Stability   :  experimental

@@ -5,7 +5,7 @@ -- file, You can obtain one at https://mozilla.org/MPL/2.0/.  {- |-Copyright   :  (c) 2023 Yamada Ryo+Copyright   :  (c) 2023 Sayo Koyoneda License     :  MPL-2.0 (see the file LICENSE) Maintainer  :  ymdfield@outlook.jp Stability   :  experimental

@@ -5,7 +5,7 @@ -- file, You can obtain one at https://mozilla.org/MPL/2.0/.  {- |-Copyright   :  (c) 2024 Yamada Ryo+Copyright   :  (c) 2024 Sayo Koyoneda License     :  MPL-2.0 (see the file LICENSE) Maintainer  :  ymdfield@outlook.jp Stability   :  experimental

@@ -5,7 +5,7 @@ -- file, You can obtain one at https://mozilla.org/MPL/2.0/.  {- |-Copyright   : (c) 2024 Yamada Ryo+Copyright   : (c) 2024 Sayo Koyoneda License     :  MPL-2.0 (see the file LICENSE) Maintainer  :  ymdfield@outlook.jp Stability   :  experimental

@@ -5,7 +5,7 @@ -- file, You can obtain one at https://mozilla.org/MPL/2.0/.  {- |-Copyright   :  (c) 2023 Yamada Ryo+Copyright   :  (c) 2023 Sayo Koyoneda License     :  MPL-2.0 (see the file LICENSE) Maintainer  :  ymdfield@outlook.jp Stability   :  experimental

@@ -5,46 +5,52 @@ -- file, You can obtain one at https://mozilla.org/MPL/2.0/.  {- |-Copyright   :  (c) 2023 Yamada Ryo+Copyright   :  (c) 2023-2024 Sayo Koyoneda License     :  MPL-2.0 (see the file LICENSE) Maintainer  :  ymdfield@outlook.jp Stability   :  experimental Portability :  portable -This module provides the `Provider` effect, comes-from [@Effectful.Provider@](https://hackage.haskell.org/package/effectful-core-2.3.0.0/docs/Effectful-Provider.html)+This module provides the `Provider` effect, like [@Effectful.Provider@](https://hackage.haskell.org/package/effectful-core-2.3.0.0/docs/Effectful-Provider.html) in the @effectful@ package. -} module Data.Effect.Provider where -data Provider' c i ctx e (f :: Type -> Type) (a :: Type) where-    Provide ::-        i ->-        (forall g. (c g, e g) => (forall x. f x -> g x) -> g a) ->-        Provider' c i ctx e f (ctx a)+import Data.Effect.Key (type (##>))+import Data.Functor.Identity (Identity, runIdentity) -makeKeyedEffect [] [''Provider']+data Provider' ctx i b (f :: Type -> Type) (a :: Type) where+    Provide+        :: i+        -> ((forall x. f x -> b x) -> b a)+        -> Provider' ctx i b f (ctx a)+makeEffectH [''Provider'] -type MonadProvider' = Provider' Monad-type ApplicativeProvider' = Provider' Applicative+data ProviderKey ctx i -type MonadProvider i ctx e = Provider Monad i ctx e-type ApplicativeProvider i ctx e = Provider Applicative i ctx e+type Provider ctx i b = ProviderKey ctx i ##> Provider' ctx i b+type Provider_ i b = ProviderKey Identity i ##> Provider' Identity i b -mprovide ::-    forall e i ctx f a.-    SendSigBy ProviderKey (MonadProvider' i ctx e) f =>-    i ->-    (forall g. (Monad g, e g) => f ~> g -> g a) ->-    f (ctx a)-mprovide = provide-{-# INLINE mprovide #-}+infix 2 .! -aprovide ::-    forall e i ctx f a.-    SendSigBy ProviderKey (ApplicativeProvider' i ctx e) f =>-    i ->-    (forall h. (Applicative h, e h) => f ~> h -> h a) ->-    f (ctx a)-aprovide = provide-{-# INLINE aprovide #-}+(.!)+    :: forall i f a b+     . ( SendHOEBy (ProviderKey Identity i) (Provider' Identity i b) f+       , Functor f+       )+    => i+    -> ((f ~> b) -> b a)+    -> f a+i .! f = runIdentity <$> provide'' @(ProviderKey Identity i) i f+{-# INLINE (.!) #-}++infix 2 ..!++(..!)+    :: forall ctx i f a b+     . (SendHOEBy (ProviderKey ctx i) (Provider' ctx i b) f)+    => i+    -> ((f ~> b) -> b a)+    -> f (ctx a)+i ..! f = provide'' @(ProviderKey ctx i) i f+{-# INLINE (..!) #-}

@@ -1,45 +0,0 @@-{-# LANGUAGE AllowAmbiguousTypes #-}-{-# HLINT ignore "Use const" #-}-{-# OPTIONS_GHC -Wno-unrecognised-pragmas #-}---- 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 Yamada Ryo-License     :  MPL-2.0 (see the file LICENSE)-Maintainer  :  ymdfield@outlook.jp-Stability   :  experimental-Portability :  portable--}-module Data.Effect.Provider.Implicit where--data ImplicitProvider' c i e (f :: Type -> Type) (a :: Type) where-    WithImplicit ::-        i ->-        (forall g. (c g, e g) => (forall x. f x -> g x) -> g a) ->-        ImplicitProvider' c i e f a--makeKeyedEffect [] [''ImplicitProvider']--type MonadImplicitProvider i e = ImplicitProvider Monad i e-type ApplicativeImplicitProvider i e = ImplicitProvider Applicative i e--(.!) ::-    forall c e i f a.-    SendSigBy ImplicitProviderKey (ImplicitProvider' c i e) f =>-    i ->-    (forall g. (c g, e g) => g a) ->-    f a-i .! m = withImplicit i \_ -> m-{-# INLINE (.!) #-}--(..!) ::-    forall c e i f a.-    SendSigBy ImplicitProviderKey (ImplicitProvider' c i e) f =>-    i ->-    (forall g. (c g, e g) => f ~> g -> g a) ->-    f a-i ..! f = withImplicit i f-{-# INLINE (..!) #-}

@@ -5,7 +5,7 @@ -- file, You can obtain one at https://mozilla.org/MPL/2.0/.  {- |-Copyright   :  (c) 2023 Yamada Ryo+Copyright   :  (c) 2023 Sayo Koyoneda License     :  MPL-2.0 (see the file LICENSE) Maintainer  :  ymdfield@outlook.jp Stability   :  experimental

@@ -10,7 +10,7 @@  {- | Copyright   :  (c) 2019-2023 The Polysemy Lounge-               (c) 2023 Yamada Ryo+               (c) 2023 Sayo Koyoneda License     :  MPL-2.0 (see the file LICENSE) Maintainer  :  ymdfield@outlook.jp Stability   :  experimental

@@ -6,37 +6,38 @@  module Data.Effect.ShiftReset where -import Control.Monad (void, (>=>))-import Data.Effect.Key.TH qualified as Keyed-import Data.Effect.TH (noExtTemplate)-import Data.Effect.TH.Internal (noDeriveHFunctor)+import Control.Monad ((>=>))+import Data.Functor (void) -data Shift' (r :: Type) m a where-    Shift :: forall r m a. ((a -> m r) -> m r) -> Shift' r m a+data Shift' (r :: Type) b m a where+    Shift :: forall r b m a. ((a -> b r) -> (forall x. m x -> b x) -> b r) -> Shift' r b m a -makeEffect'-    (def & noDeriveHFunctor & Keyed.changeNormalSenderFnNameFormat)-    Keyed.genEffectKey-    []-    [''Shift']+makeKeyedEffect [] [''Shift'] -callCC :: forall r m a. (SendSigBy ShiftKey (Shift' r) m, Monad m) => ((a -> m r) -> m a) -> m a-callCC f = shift \k -> f (k >=> exit) >>= k+callCC+    :: forall r b m a+     . (SendHOEBy ShiftKey (Shift' r b) m, Monad m, Monad b)+    => ((a -> b r) -> m a)+    -> m a+callCC f = shift \k run -> run (f $ k >=> run . exit) >>= k -exit :: (SendSigBy ShiftKey (Shift' r) f, Applicative f) => r -> f a-exit r = shift \_ -> pure r+exit :: (SendHOEBy ShiftKey (Shift' r b) m, Applicative b) => r -> m a+exit r = shift \_ _ -> pure r {-# INLINE exit #-} -getCC :: (SendSigBy ShiftKey (Shift' r) m, Monad m) => m (m r)+getCC+    :: forall r b m+     . (SendHOEBy ShiftKey (Shift' r b) m, Monad m, Monad b)+    => m (b r) getCC = callCC \exit' -> let a = exit' a in pure a -data Shift_ m a where-    Shift_ :: (forall (r :: Type). (a -> m r) -> m r) -> Shift_ m a+data Shift_' b m a where+    Shift_' :: (forall (r :: Type). (a -> b r) -> (forall x. m x -> b x) -> b r) -> Shift_' b m a -makeEffect' (def & noDeriveHFunctor) noExtTemplate [] [''Shift_]+makeKeyedEffect [] [''Shift_'] -getCC_ :: (Shift_ <<: m, Monad m) => m (m ())-getCC_ = shift_ \k -> let k' = k $ void k' in k'+getCC_ :: (SendHOEBy Shift_Key (Shift_' b) m, Functor b) => m (b ())+getCC_ = shift_' \k _ -> let k' = k $ void k' in k'  data Reset m (a :: Type) where     Reset :: m a -> Reset m a

@@ -5,7 +5,7 @@ -- file, You can obtain one at https://mozilla.org/MPL/2.0/.  {- |-Copyright   :  (c) 2023 Yamada Ryo+Copyright   :  (c) 2023 Sayo Koyoneda License     :  MPL-2.0 (see the file LICENSE) Maintainer  :  ymdfield@outlook.jp Stability   :  experimental

@@ -19,14 +19,14 @@ pattern WithRunInIO f = WithRunInBase f {-# COMPLETE WithRunInIO #-} -withRunInIO :: UnliftIO <<: f => (f ~> IO -> IO a) -> f a+withRunInIO :: (UnliftIO <<: f) => (f ~> IO -> IO a) -> f a withRunInIO = withRunInBase {-# INLINE withRunInIO #-} -withRunInIO' :: forall tag f a. UnliftIO ## tag <<: f => (f ~> IO -> IO a) -> f a+withRunInIO' :: forall tag f a. (UnliftIO ## tag <<: f) => (f ~> IO -> IO a) -> f a withRunInIO' = withRunInBase' @tag {-# INLINE withRunInIO' #-} -withRunInIO'' :: forall key f a. SendSigBy key UnliftIO f => (f ~> IO -> IO a) -> f a+withRunInIO'' :: forall key f a. (SendHOEBy key UnliftIO f) => (f ~> IO -> IO a) -> f a withRunInIO'' = withRunInBase'' @key {-# INLINE withRunInIO'' #-}

@@ -5,7 +5,7 @@ -- file, You can obtain one at https://mozilla.org/MPL/2.0/.  {- |-Copyright   :  (c) 2023 Yamada Ryo+Copyright   :  (c) 2023 Sayo Koyoneda License     :  MPL-2.0 (see the file LICENSE) Maintainer  :  ymdfield@outlook.jp Stability   :  experimental

@@ -16,10 +16,10 @@ ) where  import Control.Effect (type (<:), type (<<:), type (~>))-import Control.Effect.Key (SendInsBy, SendSigBy)+import Control.Effect.Key (SendFOEBy, SendHOEBy) import Data.Default (Default (def))-import Data.Effect.Key.TH (makeKeyedEffect)-import Data.Effect.TH (makeEffect, makeEffect', makeEffectF, makeEffectH)+import Data.Effect.Key.TH (makeKeyedEffect, makeKeyedEffect_)+import Data.Effect.TH (makeEffect, makeEffect', makeEffectF, makeEffectH, makeEffectH_) import Data.Function ((&)) import Data.Kind (Type)