diff --git a/Changelog.md b/Changelog.md new file mode 100644 --- /dev/null +++ b/Changelog.md @@ -0,0 +1,5 @@ +# 0.2 +- Update for latest ghcs while keeping compatibility with GHCs up to 7.0.4 + +# 0.1 +- Initial release diff --git a/Control/Monad/Interleave.hs b/Control/Monad/Interleave.hs deleted file mode 100644 --- a/Control/Monad/Interleave.hs +++ /dev/null @@ -1,35 +0,0 @@ ------------------------------------------------------------------------------ --- | --- Module : Control.Monad.Interleave --- Copyright : Copyright (c) , Patrick Perry --- License : BSD3 --- Maintainer : Patrick Perry --- Stability : experimental --- --- Monads with an unsaveInterleaveIO-like operation. --- - -module Control.Monad.Interleave ( - MonadInterleave(..), - ) where - -import Control.Monad.ST -import qualified Control.Monad.ST.Lazy as Lazy -import System.IO.Unsafe - --- | Monads that have an operation like 'unsafeInterleaveIO'. -class Monad m => MonadInterleave m where - -- | Get the baton from the monad without doing any computation. - unsafeInterleave :: m a -> m a - -instance MonadInterleave IO where - unsafeInterleave = unsafeInterleaveIO - {-# INLINE unsafeInterleave #-} - -instance MonadInterleave (ST s) where - unsafeInterleave = unsafeInterleaveST - {-# INLINE unsafeInterleave #-} - -instance MonadInterleave (Lazy.ST s) where - unsafeInterleave = Lazy.unsafeInterleaveST - {-# INLINE unsafeInterleave #-} diff --git a/LICENSE b/LICENSE --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,5 @@ Copyright (c) Patrick Perry 2009 +Copyright (c) Sergey Vinokurov 2022 All rights reserved. diff --git a/Readme.md b/Readme.md new file mode 100644 --- /dev/null +++ b/Readme.md @@ -0,0 +1,3 @@ +# Synopsis + +MTL-style abstraction over `unsafeInterleaveIO`. diff --git a/Setup.lhs b/Setup.lhs deleted file mode 100644 --- a/Setup.lhs +++ /dev/null @@ -1,6 +0,0 @@ -#!/usr/bin/env runhaskell -> import Distribution.Simple -> import System.Cmd -> -> main = defaultMain -> diff --git a/monad-interleave.cabal b/monad-interleave.cabal --- a/monad-interleave.cabal +++ b/monad-interleave.cabal @@ -1,21 +1,100 @@ -name: monad-interleave -version: 0.1 -homepage: http://github.com/patperry/monad-interleave -synopsis: Monads with an unsaveInterleaveIO-like operation. +cabal-version: 2.2 +name: + monad-interleave +version: + 0.2 +synopsis: + Monads with an unsaveInterleaveIO-like operation. description: - A type class for monads that have an \"unsafeInterleave\" operation. - Instances are provided for IO and both strict and lazy ST. -category: Monads -license: BSD3 -license-file: LICENSE -copyright: (c) 2009. Patrick Perry -author: Patrick Perry -maintainer: Patrick Perry -cabal-version: >= 1.2.0 -build-type: Custom -tested-with: GHC ==6.10.1 + A type class for monads that have an \"unsafeInterleave\" operation. + Instances are provided for IO and both strict and lazy ST. +category: + Monads +license: + BSD-3-Clause +license-file: + LICENSE +copyright: + (c) 2009. Patrick Perry + (c) 2022. Sergey Vinokurov +author: + Patrick Perry +maintainer: + Sergey Vinokurov -library - exposed-modules: Control.Monad.Interleave - build-depends: base - ghc-options: -Wall +build-type: + Simple + +tested-with: + GHC == 7.0.4, + GHC == 7.2.2, + GHC == 7.4.2, + GHC == 7.6.3, + GHC == 7.8.4, + GHC == 7.10.3, + GHC == 8.0.2, + GHC == 8.2.2, + GHC == 8.4.4, + GHC == 8.6.5, + GHC == 8.8.4, + GHC == 8.10.7, + GHC == 9.0.2, + GHC == 9.2.4, + GHC == 9.4.2, + GHC == 9.4.2, + GHC == 9.4.2 + +extra-source-files: + Readme.md + Changelog.md + +homepage: + https://github.com/sergv/monad-interleave +bug-reports: + https://github.com/sergv/monad-interleave/issues + +source-repository head + type: git + location: https://github.com/sergv/monad-interleave.git + +common ghc-options + default-language: + Haskell2010 + + if impl(ghc < 8.0) + ghc-options: + -Wall + + if impl(ghc >= 8.0) + ghc-options: + -Weverything + -Wno-all-missed-specialisations + -Wno-implicit-prelude + -Wno-missed-specialisations + -Wno-missing-import-lists + -Wno-missing-local-signatures + -Wno-missing-safe-haskell-mode + -Wno-safe + -Wno-type-defaults + -Wno-unsafe + + if impl(ghc >= 8.8) + ghc-options: + -Wno-missing-deriving-strategies + + if impl(ghc >= 8.10) + ghc-options: + -Wno-prepositive-qualified-module + + if impl(ghc >= 9.2) + ghc-options: + -Wno-missing-kind-signatures + +library name + import: ghc-options + exposed-modules: + Control.Monad.Interleave + hs-source-dirs: + src + build-depends: + , base >= 4 && <5 diff --git a/src/Control/Monad/Interleave.hs b/src/Control/Monad/Interleave.hs new file mode 100644 --- /dev/null +++ b/src/Control/Monad/Interleave.hs @@ -0,0 +1,43 @@ +----------------------------------------------------------------------------- +-- | +-- Module : Control.Monad.Interleave +-- Copyright : Copyright (c) Patrick Perry , Sergey Vinokurov +-- License : BSD3 +-- Maintainer : Sergey Vinokurov +-- +-- Monads with an unsaveInterleaveIO-like operation. + +{-# LANGUAGE CPP #-} + +module Control.Monad.Interleave + ( MonadInterleave(..) + ) where + +import qualified Control.Monad.ST as Strict (ST) +import qualified Control.Monad.ST.Lazy as Lazy (ST) +import System.IO.Unsafe + +#if MIN_VERSION_base(4, 4, 0) +import qualified Control.Monad.ST.Lazy.Unsafe as Lazy (unsafeInterleaveST) +import qualified Control.Monad.ST.Unsafe as Strict (unsafeInterleaveST) +#else +import qualified Control.Monad.ST as Strict (unsafeInterleaveST) +import qualified Control.Monad.ST.Lazy as Lazy (unsafeInterleaveST) +#endif + +-- | Monads that have an operation like 'unsafeInterleaveIO'. +class Monad m => MonadInterleave m where + -- | Get the baton from the monad without doing any computation. + unsafeInterleave :: m a -> m a + +instance MonadInterleave IO where + {-# INLINE unsafeInterleave #-} + unsafeInterleave = unsafeInterleaveIO + +instance MonadInterleave (Strict.ST s) where + {-# INLINE unsafeInterleave #-} + unsafeInterleave = Strict.unsafeInterleaveST + +instance MonadInterleave (Lazy.ST s) where + {-# INLINE unsafeInterleave #-} + unsafeInterleave = Lazy.unsafeInterleaveST