diff --git a/ChangeLog.md b/ChangeLog.md new file mode 100644 --- /dev/null +++ b/ChangeLog.md @@ -0,0 +1,1 @@ +# Revision history for data-effects diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + 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/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/NOTICE b/NOTICE new file mode 100644 --- /dev/null +++ b/NOTICE @@ -0,0 +1,7 @@ +NOTICE +====== + +Unless explicitly stated otherwise, all Source Code Forms +(recursively, including under subdirectories) contained in the directory +where this NOTICE file is located are subject to the terms of the +Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# data-effects + +[![Hackage](https://img.shields.io/hackage/v/data-effects.svg?logo=haskell&label=data-effects)](https://hackage.haskell.org/package/data-effects) +[![Hackage](https://img.shields.io/hackage/v/data-effects-core.svg?logo=haskell&label=data-effects-core)](https://hackage.haskell.org/package/data-effects-core) +[![Hackage](https://img.shields.io/hackage/v/data-effects-th.svg?logo=haskell&label=data-effects-th)](https://hackage.haskell.org/package/data-effects-th) + +A basic framework for a Haskell effect system library based on GADTs-based effect representations +with a style that separates first-order effects and higher-order effects. + +This library set was created by being separated from +the [Heftia](https://github.com/sayo-hs/heftia) extensible effects library. + +## Your contributions are welcome! +Please see [CONTRIBUTING.md](CONTRIBUTING.md). + +## Credits +Parts of this project have been adapted or inspired by the following resources: + +* **[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. diff --git a/data-effects.cabal b/data-effects.cabal new file mode 100644 --- /dev/null +++ b/data-effects.cabal @@ -0,0 +1,134 @@ +cabal-version: 2.4 +name: data-effects +version: 0.1.0.0 + +-- A short (one-line) description of the package. +synopsis: A basic framework for effect systems based on effects represented by GADTs. + +-- A longer description of the package. +description: + A basic framework for a Haskell effect system library based on GADTs-based effect representations + with a style that separates first-order effects and higher-order effects. + . + This library set was created by being separated from + the [Heftia](https://hackage.haskell.org/package/heftia) extensible effects library. + +-- A URL where users can report bugs. +bug-reports: https://github.com/sayo-hs/data-effects + +-- The license under which the package is released. +license: MPL-2.0 +license-file: LICENSE +author: Yamada Ryo +maintainer: Yamada Ryo + +-- A copyright notice. +copyright: 2023 Yamada Ryo +category: Control, Effect + +extra-source-files: + ChangeLog.md + NOTICE + README.md + +tested-with: + GHC == 9.2.8 + +source-repository head + type: git + location: https://github.com/sayo-hs/data-effects + tag: v0.1.0 + subdir: data-effects + +library + exposed-modules: + Data.Effect.Reader + Data.Effect.Writer + Data.Effect.State + Data.Effect.Except + Data.Effect.Accum + Data.Effect.NonDet + 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 + Data.Effect.Chronicle + Data.Effect.Resource + Data.Effect.Fresh + Data.Effect.Concurrent.Thread + Data.Effect.Unlift + Data.Effect.ShiftReset + Data.Effect.KVStore + + reexported-modules: + Data.Effect, + Data.Effect.TH, + Data.Effect.Tag, + Data.Effect.Key, + Data.Effect.Key.TH, + Data.Effect.HFunctor, + Data.Effect.HFunctor.HCont, + Data.Effect.HFunctor.TH, + Control.Effect, + Control.Effect.Tag, + Control.Effect.Key, + + -- Modules included in this executable, other than Main. + other-modules: + Prelude + + -- 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, + these ^>= 1.2, + data-default ^>= 0.7.1, + + hs-source-dirs: src + ghc-options: -Wall + default-language: GHC2021 + + default-extensions: + LambdaCase, + DerivingStrategies, + DataKinds, + TypeFamilies, + BlockArguments, + FunctionalDependencies, + RecordWildCards, + DefaultSignatures, + PatternSynonyms, + TemplateHaskell, + PartialTypeSignatures + +test-suite test + main-is: Driver.hs + hs-source-dirs: test + build-depends: + data-effects, + base, + tasty ^>= 1.4, + tasty-hunit ^>= 0.10, + + type: exitcode-stdio-1.0 + + build-tool-depends: + tasty-discover:tasty-discover + + default-language: GHC2021 + + default-extensions: + LambdaCase, + DerivingStrategies, + DataKinds, + TypeFamilies, + BlockArguments, + FunctionalDependencies, + RecordWildCards, + DefaultSignatures diff --git a/src/Data/Effect/Accum.hs b/src/Data/Effect/Accum.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/Accum.hs @@ -0,0 +1,20 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +-- 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.Accum where + +data Accum w a where + Add :: w -> Accum f () + Look :: Accum w w + +makeEffectF [''Accum] diff --git a/src/Data/Effect/Chronicle.hs b/src/Data/Effect/Chronicle.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/Chronicle.hs @@ -0,0 +1,27 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +-- 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/. + +module Data.Effect.Chronicle where + +import Data.Functor (($>)) +import Data.These (These (That, These, This)) + +data ChronicleF c a where + Dictate :: c -> ChronicleF c () + Confess :: c -> ChronicleF c a + +data ChronicleH c f a where + Memento :: f a -> ChronicleH c f (Either c a) + Absolve :: a -> f a -> ChronicleH c f a + Condemn :: f a -> ChronicleH c f a + +makeEffect [''ChronicleF] [''ChronicleH] + +chronicle :: (ChronicleF c <: f, Applicative f) => These c a -> f a +chronicle = \case + This c -> confess c + That x -> pure x + These c x -> dictate c $> x diff --git a/src/Data/Effect/Concurrent/Thread.hs b/src/Data/Effect/Concurrent/Thread.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/Concurrent/Thread.hs @@ -0,0 +1,19 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +-- 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.Concurrent.Thread where + +data Thread' tid f (a :: Type) where + ForkThread :: f () -> Thread' tid f tid + +makeKeyedEffect [] [''Thread'] diff --git a/src/Data/Effect/Cont.hs b/src/Data/Effect/Cont.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/Cont.hs @@ -0,0 +1,15 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +-- 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/. + +module Data.Effect.Cont where + +import Data.Effect.TH (noExtTemplate) +import Data.Effect.TH.Internal (noDeriveHFunctor) + +data CallCC m a where + CallCC :: (forall r. (a -> m r) -> m a) -> CallCC m a + +makeEffect' (def & noDeriveHFunctor) noExtTemplate [] [''CallCC] diff --git a/src/Data/Effect/Coroutine.hs b/src/Data/Effect/Coroutine.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/Coroutine.hs @@ -0,0 +1,45 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +-- 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) 2016 Allele Dev; 2017 Ixperta Solutions s.r.o.; 2017 Alexis King + (c) 2023-2024 Yamada Ryo +License : MPL-2.0 (see the file LICENSE) +Maintainer : ymdfield@outlook.jp +Stability : experimental +Portability : portable + +This module provides the t`Coroutine` effect, comes +from [@Control.Monad.Freer.Coroutine@](https://hackage.haskell.org/package/freer-simple-1.2.1.2/docs/Control-Monad-Freer-Coroutine.html) +in the @freer-simple@ package (The continuation part @(b -> c)@ has been removed. If necessary, please manually compose the t`Data.Functor.Coyoneda.Coyoneda`) . +-} +module Data.Effect.Coroutine where + +import Control.Monad ((>=>)) + +data Yield a b (c :: Type) where + Yield :: a -> Yield a b b + +makeEffectF [''Yield] + +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)) + deriving (Functor) + +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 + +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 diff --git a/src/Data/Effect/Except.hs b/src/Data/Effect/Except.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/Except.hs @@ -0,0 +1,22 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +-- 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.Except where + +data Throw e (a :: Type) where + Throw :: e -> Throw e a + +data Catch e f (a :: Type) where + Catch :: f a -> (e -> f a) -> Catch e f a + +makeEffect [''Throw] [''Catch] diff --git a/src/Data/Effect/Fail.hs b/src/Data/Effect/Fail.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/Fail.hs @@ -0,0 +1,12 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +-- 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/. + +module Data.Effect.Fail where + +data Fail (a :: Type) where + Fail :: String -> Fail a + +makeEffectF [''Fail] diff --git a/src/Data/Effect/Fix.hs b/src/Data/Effect/Fix.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/Fix.hs @@ -0,0 +1,12 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +-- 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/. + +module Data.Effect.Fix where + +data Fix f a where + Mfix :: (a -> f a) -> Fix f a + +makeEffectH [''Fix] diff --git a/src/Data/Effect/Fresh.hs b/src/Data/Effect/Fresh.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/Fresh.hs @@ -0,0 +1,19 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +-- 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.Fresh where + +data Fresh i (a :: Type) where + Fresh :: Fresh i i + +makeEffectF [''Fresh] diff --git a/src/Data/Effect/Input.hs b/src/Data/Effect/Input.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/Input.hs @@ -0,0 +1,26 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +-- 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 + +This module provides the t`Input` effect, comes +from [@Polysemy.Input@](https://hackage.haskell.org/package/polysemy-1.9.1.1/docs/Polysemy-Input.html) +in the @polysemy@ package. +-} +module Data.Effect.Input where + +data Input i (a :: Type) where + Input :: Input i i + +makeEffectF [''Input] + +inputs :: (Input i <: f, Functor f) => (i -> a) -> f a +inputs f = f <$> input diff --git a/src/Data/Effect/KVStore.hs b/src/Data/Effect/KVStore.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/KVStore.hs @@ -0,0 +1,48 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +-- 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) 2024 Yamada Ryo +License : MPL-2.0 (see the file LICENSE) +Maintainer : ymdfield@outlook.jp +Stability : experimental +Portability : portable + +This module provides the t`KVStore` effect, comes +from [@Polysemy.KVStore@](https://hackage.haskell.org/package/polysemy-kvstore-0.1.3.0/docs/Polysemy-KVStore.html) +in the @polysemy-kvstore@ package. +-} +module Data.Effect.KVStore where + +import Data.Effect.Except (Throw, throw) +import Data.Maybe (isJust) + +data KVStore k v a where + LookupKV :: k -> KVStore k v (Maybe v) + UpdateKV :: k -> Maybe v -> KVStore k v () + +makeEffectF [''KVStore] + +lookupOrThrowKV :: (KVStore k v <: m, Throw e <: m, Monad m) => (k -> e) -> k -> m v +lookupOrThrowKV err k = + lookupKV k >>= maybe (throw $ err k) pure + +existsKV :: forall v k f. (KVStore k v <: f, Functor f) => k -> f Bool +existsKV = fmap isJust . lookupKV @k @v +{-# INLINE existsKV #-} + +writeKV :: KVStore k v <: f => k -> v -> f () +writeKV k v = updateKV k (Just v) +{-# INLINE writeKV #-} + +deleteKV :: forall v k f. KVStore k v <: f => k -> f () +deleteKV k = updateKV @k @v k Nothing +{-# INLINE deleteKV #-} + +modifyKV :: (KVStore k v <: m, Monad m) => v -> (v -> v) -> k -> m () +modifyKV vDefault f k = do + v <- lookupKV k + updateKV k (Just $ maybe vDefault f v) diff --git a/src/Data/Effect/NonDet.hs b/src/Data/Effect/NonDet.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/NonDet.hs @@ -0,0 +1,29 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +-- 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) 2024 Yamada Ryo +License : MPL-2.0 (see the file LICENSE) +Maintainer : ymdfield@outlook.jp +Stability : experimental +Portability : portable +-} +module Data.Effect.NonDet where + +data Empty (a :: Type) where + Empty :: Empty a + +makeEffectF [''Empty] + +data Choose (a :: Type) where + Choose :: Choose Bool + +makeEffectF [''Choose] + +data ChooseH f (a :: Type) where + ChooseH :: f a -> f a -> ChooseH f a + +makeEffectH [''ChooseH] diff --git a/src/Data/Effect/Output.hs b/src/Data/Effect/Output.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/Output.hs @@ -0,0 +1,23 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +-- 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 + +This module provides the t`Output` effect, comes +from [@Polysemy.Output@](https://hackage.haskell.org/package/polysemy-1.9.1.1/docs/Polysemy-Output.html) +in the @polysemy@ package. +-} +module Data.Effect.Output where + +data Output o a where + Output :: o -> Output o () + +makeEffectF [''Output] diff --git a/src/Data/Effect/Provider.hs b/src/Data/Effect/Provider.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/Provider.hs @@ -0,0 +1,50 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +-- 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 + +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) +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) + +makeKeyedEffect [] [''Provider'] + +type MonadProvider' = Provider' Monad +type ApplicativeProvider' = Provider' Applicative + +type MonadProvider i ctx e = Provider Monad i ctx e +type ApplicativeProvider i ctx e = Provider Applicative i ctx e + +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 #-} + +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 #-} diff --git a/src/Data/Effect/Provider/Implicit.hs b/src/Data/Effect/Provider/Implicit.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/Provider/Implicit.hs @@ -0,0 +1,45 @@ +{-# 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 (..!) #-} diff --git a/src/Data/Effect/Reader.hs b/src/Data/Effect/Reader.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/Reader.hs @@ -0,0 +1,25 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +-- 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.Reader where + +data Ask r (a :: Type) where + Ask :: Ask r r + +data Local r f (a :: Type) where + Local :: (r -> r) -> f a -> Local r f a + +makeEffect [''Ask] [''Local] + +asks :: (Ask r <: f, Functor f) => (r -> a) -> f a +asks f = f <$> ask diff --git a/src/Data/Effect/Resource.hs b/src/Data/Effect/Resource.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/Resource.hs @@ -0,0 +1,56 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +-- 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/. + +-- The code and documentation before modification is BSD3 licensed, +-- (c) 2019-2023 The Polysemy Lounge: [Polysemy.Resource] +-- (https://hackage.haskell.org/package/polysemy-1.9.1.2/docs/Polysemy-Resource.html). + +{- | +Copyright : (c) 2019-2023 The Polysemy Lounge + (c) 2023 Yamada Ryo +License : MPL-2.0 (see the file LICENSE) +Maintainer : ymdfield@outlook.jp +Stability : experimental +Portability : portable + +An effect capable of providing [bracket] +(https://hackage.haskell.org/package/base-4.16.4.0/docs/Control-Exception.html#v:bracket) semantics. +-} +module Data.Effect.Resource where + +import Data.Functor (void) + +{- | +An effect capable of providing [bracket] +(https://hackage.haskell.org/package/base-4.16.4.0/docs/Control-Exception.html#v:bracket) semantics. +-} +data Resource f a where + -- | Allocate a resource, use it, and clean it up afterwards. + Bracket :: f a -> (a -> f ()) -> (a -> f b) -> Resource f b + -- | Allocate a resource, use it, and clean it up afterwards if an error occurred. + BracketOnExcept :: f a -> (a -> f ()) -> (a -> f b) -> Resource f b + +makeEffectH [''Resource] + +bracket_ :: (Resource <<: f, Functor f) => f a -> f b -> f c -> f c +bracket_ acquire release thing = + bracket acquire (const $ void release) (const thing) + +bracketOnExcept_ :: (Resource <<: f, Functor f) => f a -> f b -> f c -> f c +bracketOnExcept_ acquire onExc thing = + bracketOnExcept acquire (const $ void onExc) (const thing) + +finally :: (Resource <<: f, Applicative f) => f a -> f () -> f a +finally thing release = bracket (pure ()) (const release) (const thing) + +finally_ :: (Resource <<: f, Applicative f) => f a -> f b -> f a +finally_ thing release = finally thing (void release) + +onException :: (Resource <<: f, Applicative f) => f a -> f () -> f a +onException thing onExc = bracketOnExcept (pure ()) (const onExc) (const thing) + +onException_ :: (Resource <<: f, Applicative f) => f a -> f b -> f a +onException_ thing onExc = onException thing (void onExc) diff --git a/src/Data/Effect/ShiftReset.hs b/src/Data/Effect/ShiftReset.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/ShiftReset.hs @@ -0,0 +1,44 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +-- 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/. + +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) + +data Shift' (r :: Type) m a where + Shift :: forall r m a. ((a -> m r) -> m r) -> Shift' r m a + +makeEffect' + (def & noDeriveHFunctor & Keyed.changeNormalSenderFnNameFormat) + Keyed.genEffectKey + [] + [''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 + +exit :: (SendSigBy ShiftKey (Shift' r) f, Applicative f) => r -> f a +exit r = shift \_ -> pure r +{-# INLINE exit #-} + +getCC :: (SendSigBy ShiftKey (Shift' r) m, Monad m) => m (m 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 + +makeEffect' (def & noDeriveHFunctor) noExtTemplate [] [''Shift_] + +getCC_ :: (Shift_ <<: m, Monad m) => m (m ()) +getCC_ = shift_ \k -> let k' = k $ void k' in k' + +data Reset m (a :: Type) where + Reset :: m a -> Reset m a + +makeEffectH [''Reset] diff --git a/src/Data/Effect/State.hs b/src/Data/Effect/State.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/State.hs @@ -0,0 +1,26 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +-- 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.State where + +data State s a where + Get :: State s s + Put :: s -> State s () + +makeEffectF [''State] + +gets :: (State s <: f, Functor f) => (s -> a) -> f a +gets f = f <$> get + +modify :: (State s <: m, Monad m) => (s -> s) -> m () +modify f = put . f =<< get diff --git a/src/Data/Effect/Unlift.hs b/src/Data/Effect/Unlift.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/Unlift.hs @@ -0,0 +1,32 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +-- 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/. + +module Data.Effect.Unlift where + +import Data.Effect.Tag (type (##)) + +data UnliftBase b f (a :: Type) where + WithRunInBase :: ((forall x. f x -> b x) -> b a) -> UnliftBase b f a + +makeEffectH [''UnliftBase] + +type UnliftIO = UnliftBase IO + +pattern WithRunInIO :: (f ~> IO -> IO a) -> UnliftIO f a +pattern WithRunInIO f = WithRunInBase f +{-# COMPLETE WithRunInIO #-} + +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' = withRunInBase' @tag +{-# INLINE withRunInIO' #-} + +withRunInIO'' :: forall key f a. SendSigBy key UnliftIO f => (f ~> IO -> IO a) -> f a +withRunInIO'' = withRunInBase'' @key +{-# INLINE withRunInIO'' #-} diff --git a/src/Data/Effect/Writer.hs b/src/Data/Effect/Writer.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/Writer.hs @@ -0,0 +1,29 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +-- 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.Writer where + +data Tell w a where + Tell :: w -> Tell w () + +data WriterH w f a where + Listen :: f a -> WriterH w f (w, a) + Censor :: (w -> w) -> f a -> WriterH w f a + +makeEffect [''Tell] [''WriterH] + +pass :: (Tell w <: m, WriterH w <<: m, Monad m) => m (w -> w, a) -> m a +pass m = do + (w, (f, a)) <- listen m + tell $ f w + pure a diff --git a/src/Prelude.hs b/src/Prelude.hs new file mode 100644 --- /dev/null +++ b/src/Prelude.hs @@ -0,0 +1,26 @@ +{-# LANGUAGE PackageImports #-} + +-- 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/. + +module Prelude ( + module Prelude, + module Control.Effect, + module Control.Effect.Key, + module Data.Effect.TH, + module Data.Effect.Key.TH, + Type, + def, + (&), +) where + +import Control.Effect (type (<:), type (<<:), type (~>)) +import Control.Effect.Key (SendInsBy, SendSigBy) +import Data.Default (Default (def)) +import Data.Effect.Key.TH (makeKeyedEffect) +import Data.Effect.TH (makeEffect, makeEffect', makeEffectF, makeEffectH) +import Data.Function ((&)) +import Data.Kind (Type) + +import "base" Prelude diff --git a/test/Driver.hs b/test/Driver.hs new file mode 100644 --- /dev/null +++ b/test/Driver.hs @@ -0,0 +1,5 @@ +{-# OPTIONS_GHC -F -pgmF tasty-discover #-} + +-- 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/.