diff --git a/ChangeLog.md b/ChangeLog.md new file mode 100644 --- /dev/null +++ b/ChangeLog.md @@ -0,0 +1,5 @@ +# Revision history for data-effects-core + +## 0.1.0.0 -- 2023-09-18 + +* Initial public release. 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-core.cabal b/data-effects-core.cabal new file mode 100644 --- /dev/null +++ b/data-effects-core.cabal @@ -0,0 +1,102 @@ +cabal-version: 2.4 +name: data-effects-core +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: + This library provides core definitions of [data-effects](https://hackage.haskell.org/package/data-effects). + +-- 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-2024 Yamada Ryo, + 2023 Casper Bach Poulsen and Cas van der Rest + +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-core + +library + exposed-modules: + Data.Effect + Data.Effect.Tag + Data.Effect.Key + Data.Effect.HFunctor + Data.Effect.HFunctor.HCont + Control.Effect + Control.Effect.Tag + Control.Effect.Key + + -- Modules included in this executable, other than Main. + -- other-modules: + + -- LANGUAGE extensions used by modules in this package. + -- other-extensions: + build-depends: + base ^>= 4.16.4.0, + compdata ^>= 0.13.1, + mtl ^>= 2.2.2, + + hs-source-dirs: src + ghc-options: -Wall + default-language: GHC2021 + + default-extensions: + LambdaCase, + DerivingStrategies, + DataKinds, + TypeFamilies, + BlockArguments, + FunctionalDependencies, + RecordWildCards, + DefaultSignatures + + +test-suite test + main-is: Driver.hs + hs-source-dirs: test + build-depends: + data-effects-core, + 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/Control/Effect.hs b/src/Control/Effect.hs new file mode 100644 --- /dev/null +++ b/src/Control/Effect.hs @@ -0,0 +1,44 @@ +-- 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 +License : MPL-2.0 (see the file LICENSE) +Maintainer : ymdfield@outlook.jp +Stability : experimental +Portability : portable +-} +module Control.Effect where + +import Data.Effect (InsClass, LiftIns (unliftIns), SigClass) +import Data.Kind (Type) + +-- | A type class that represents the ability to send an /instruction/ @ins@ to carrier @f@. +class SendIns (ins :: InsClass) f where + -- | Send an /instruction/ @ins@ to carrier @f@. + sendIns :: ins a -> f a + +-- | The operator version of `SendIns`. +type (<:) = SendIns + +infix 2 <: + +-- | A type class that represents the ability to send a /signature/ @sig@ to carrier @f@. +class SendSig (sig :: SigClass) f where + -- | Send a /signature/ @sig@ to carrier @f@. + sendSig :: sig f a -> f a + +-- | The operator version of `SendSig`. +type (<<:) = SendSig + +infix 2 <<: + +instance SendIns ins f => SendSig (LiftIns ins) f where + sendSig = sendIns . unliftIns + {-# INLINE sendSig #-} + +-- | A natural transformation. +type f ~> g = forall (x :: Type). f x -> g x + +infixr 2 ~> diff --git a/src/Control/Effect/Key.hs b/src/Control/Effect/Key.hs new file mode 100644 --- /dev/null +++ b/src/Control/Effect/Key.hs @@ -0,0 +1,66 @@ +{-# 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-2024 Yamada Ryo +License : MPL-2.0 (see the file LICENSE) +Maintainer : ymdfield@outlook.jp +Stability : experimental +Portability : portable +-} +module Control.Effect.Key where + +import Control.Applicative (Alternative) +import Control.Effect (SendIns (sendIns), SendSig (sendSig)) +import Control.Monad (MonadPlus) +import Control.Monad.Except (MonadError) +import Control.Monad.Fix (MonadFix) +import Control.Monad.IO.Class (MonadIO) +import Control.Monad.RWS (MonadRWS) +import Control.Monad.Reader (MonadReader) +import Control.Monad.State (MonadState) +import Control.Monad.Writer (MonadWriter) +import Data.Coerce (coerce) +import Data.Effect (InsClass, SigClass) +import Data.Effect.HFunctor (HFunctor, hfmap) +import Data.Kind (Type) + +class SendInsBy key (ins :: InsClass) f | key f -> ins where + sendInsBy :: ins a -> f a + +class SendSigBy key (sig :: SigClass) f | key f -> sig where + sendSigBy :: sig f a -> f a + +-- | A wrapper data type to represent sending an effect to the carrier @f@ with the specified key. +newtype ByKey key (f :: Type -> Type) a = ByKey {runByKey :: f a} + deriving newtype + ( Functor + , Applicative + , Alternative + , Monad + , MonadPlus + , MonadFix + , MonadIO + , MonadFail + , MonadReader r + , MonadWriter w + , MonadState s + , MonadRWS r w s + , MonadError e + ) + +-- | Send all effects within the scope, keyed, to carrier @f@. +key :: forall key f a. ByKey key f a -> f a +key = runByKey +{-# INLINE key #-} + +instance SendInsBy key ins f => SendIns ins (ByKey key f) where + sendIns = ByKey . sendInsBy @key + {-# INLINE sendIns #-} + +instance (SendSigBy key sig f, HFunctor sig) => SendSig sig (ByKey key f) where + sendSig = ByKey . sendSigBy @key . hfmap coerce + {-# INLINE sendSig #-} diff --git a/src/Control/Effect/Tag.hs b/src/Control/Effect/Tag.hs new file mode 100644 --- /dev/null +++ b/src/Control/Effect/Tag.hs @@ -0,0 +1,70 @@ +{-# LANGUAGE PatternSynonyms #-} +{-# LANGUAGE UndecidableInstances #-} + +-- 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 +License : MPL-2.0 (see the file LICENSE) +Maintainer : ymdfield@outlook.jp +Stability : experimental +Portability : portable +-} +module Control.Effect.Tag where + +import Control.Applicative (Alternative) +import Control.Effect (SendIns (sendIns), SendSig (sendSig)) +import Control.Effect.Key (SendInsBy, SendSigBy, sendInsBy, sendSigBy) +import Control.Monad (MonadPlus) +import Control.Monad.Except (MonadError) +import Control.Monad.Fix (MonadFix) +import Control.Monad.IO.Class (MonadIO) +import Control.Monad.RWS (MonadRWS) +import Control.Monad.Reader (MonadReader) +import Control.Monad.State (MonadState) +import Control.Monad.Writer (MonadWriter) +import Data.Coerce (coerce) +import Data.Effect.HFunctor (HFunctor, hfmap) +import Data.Effect.Tag (pattern T, pattern TH, type (#), type (##)) +import Data.Kind (Type) + +-- | A wrapper data type to represent sending an effect to the carrier @f@ with the specified tag. +newtype ViaTag tag (f :: Type -> Type) a = ViaTag {runViaTag :: f a} + deriving newtype + ( Functor + , Applicative + , Alternative + , Monad + , MonadPlus + , MonadFix + , MonadIO + , MonadFail + , MonadReader r + , MonadWriter w + , MonadState s + , MonadRWS r w s + , MonadError e + ) + +-- | Send all effects within the scope, tagged, to carrier @f@. +tag :: forall tag f a. ViaTag tag f a -> f a +tag = runViaTag +{-# INLINE tag #-} + +instance SendIns (ins # tag) f => SendIns ins (ViaTag tag f) where + sendIns = ViaTag . sendIns . T @tag + {-# INLINE sendIns #-} + +instance (SendSig (sig ## tag) f, HFunctor sig) => SendSig sig (ViaTag tag f) where + sendSig = ViaTag . sendSig . TH @tag . hfmap coerce + {-# INLINE sendSig #-} + +instance SendInsBy key (ins # tag) f => SendInsBy key ins (ViaTag tag f) where + sendInsBy = ViaTag . sendInsBy @key . T @tag + {-# INLINE sendInsBy #-} + +instance (SendSigBy key (sig ## tag) f, HFunctor sig) => SendSigBy key sig (ViaTag tag f) where + sendSigBy = ViaTag . sendSigBy @key . TH @tag . hfmap coerce + {-# INLINE sendSigBy #-} diff --git a/src/Data/Effect.hs b/src/Data/Effect.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect.hs @@ -0,0 +1,40 @@ +-- 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 {unliftIns :: ins a} + deriving stock (Functor, Foldable, Traversable) + +instance HFunctor (LiftIns ins) where + hfmap _ (LiftIns e) = LiftIns e + {-# INLINE hfmap #-} + +-- | An /instruction class/ with no effects. +data Nop :: InsClass + +-- | A /signature class/ with no effects. +type LNop = LiftIns Nop diff --git a/src/Data/Effect/HFunctor.hs b/src/Data/Effect/HFunctor.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/HFunctor.hs @@ -0,0 +1,46 @@ +-- 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 re-exports the `HFunctor` type class and related definitions from the `compdata` +package. For more details, please refer to the + [`compdata` documentation](https://hackage.haskell.org/package/compdata-0.13.0/docs/Data-Comp-Multi-HFunctor.html). +-} +module Data.Effect.HFunctor ( + HFunctor (..), + RemA (..), + DistAnn (..), + (:&:) (..), + (:=:), + (:<:), + Subsume (..), + Elem, + (:+:) (..), + caseH, + inj, + proj, + spl, +) where + +import Data.Comp.Multi.HFunctor (HFunctor (hfmap)) +import Data.Comp.Multi.Ops ( + DistAnn (injectA, projectA), + Elem, + RemA (remA), + Subsume (..), + caseH, + inj, + proj, + spl, + type (:&:) ((:&:)), + type (:+:) (Inl, Inr), + type (:<:), + type (:=:), + ) diff --git a/src/Data/Effect/HFunctor/HCont.hs b/src/Data/Effect/HFunctor/HCont.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/HFunctor/HCont.hs @@ -0,0 +1,29 @@ +{-# LANGUAGE QuantifiedConstraints #-} + +-- 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.HFunctor.HCont where + +import Control.Effect (type (~>)) +import Data.Effect.HFunctor (HFunctor, hfmap) +import Data.Kind (Type) + +-- | This represents that the effect @ff@ is finally interpreted as the base carrier @b@. +newtype HCont ff b f (a :: Type) = HCont {unHCont :: (f ~> b) -> ff b a} + deriving stock (Functor) + +type (~~>) = HCont +infixr 8 ~~> + +instance HFunctor (HCont ff g) where + hfmap phi (HCont f) = HCont \k -> f $ k . phi + {-# INLINE hfmap #-} diff --git a/src/Data/Effect/Key.hs b/src/Data/Effect/Key.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/Key.hs @@ -0,0 +1,48 @@ +{-# LANGUAGE PatternSynonyms #-} + +-- 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 +License : MPL-2.0 (see the file LICENSE) +Maintainer : ymdfield@outlook.jp +Stability : experimental +Portability : portable +-} +module Data.Effect.Key where + +import Data.Comp.Multi.HFunctor (HFunctor) +import Data.Effect (InsClass, SigClass) + +-- | Keyed /instruction class/. +newtype Key key (ins :: InsClass) a = Key {unKey :: ins a} + deriving stock (Functor, Foldable, Traversable) + +-- | Keyed /instruction class/. +type (#>) = Key + +infixr 7 #> + +-- | Keyed /instruction class/. +pattern K :: forall key ins a. ins a -> Key key ins a +pattern K e = Key e + +{-# COMPLETE K #-} + +-- | Keyed /signature class/. +newtype KeyH key (sig :: SigClass) f a = KeyH {unKeyH :: sig f a} + deriving stock (Functor, Foldable, Traversable) + deriving newtype (HFunctor) + +-- | Keyed /signature class/. +type (##>) = KeyH + +infixr 7 ##> + +-- | Keyed /signature class/. +pattern KH :: forall key sig f a. sig f a -> KeyH key sig f a +pattern KH e = KeyH e + +{-# COMPLETE KH #-} diff --git a/src/Data/Effect/Tag.hs b/src/Data/Effect/Tag.hs new file mode 100644 --- /dev/null +++ b/src/Data/Effect/Tag.hs @@ -0,0 +1,48 @@ +{-# LANGUAGE PatternSynonyms #-} + +-- 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 +License : MPL-2.0 (see the file LICENSE) +Maintainer : ymdfield@outlook.jp +Stability : experimental +Portability : portable +-} +module Data.Effect.Tag where + +import Data.Comp.Multi.HFunctor (HFunctor) +import Data.Effect (InsClass, SigClass) + +-- | Tagged /instruction class/. +newtype Tag (ins :: InsClass) tag a = Tag {unTag :: ins a} + deriving stock (Functor, Foldable, Traversable) + +-- | Tagged /instruction class/. +type (#) = Tag + +infixl 8 # + +-- | Tagged /instruction class/. +pattern T :: forall tag ins a. ins a -> Tag ins tag a +pattern T e = Tag e + +{-# COMPLETE T #-} + +-- | Tagged /signature class/. +newtype TagH (sig :: SigClass) tag f a = TagH {unTagH :: sig f a} + deriving stock (Functor, Foldable, Traversable) + deriving newtype (HFunctor) + +-- | Tagged /signature class/. +type (##) = TagH + +infixl 8 ## + +-- | Tagged /signature class/. +pattern TH :: forall tag sig f a. sig f a -> TagH sig tag f a +pattern TH e = TagH e + +{-# COMPLETE TH #-} 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/.