basicTypes/UniqSupply.hs

    {-
    (c) The University of Glasgow 2006
    (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
    -}

    {-# LANGUAGE CPP, UnboxedTuples #-}

    module UniqSupply (
            -- * Main data type
            UniqSupply, -- Abstractly

            -- ** Operations on supplies
            uniqFromSupply, uniqsFromSupply, -- basic ops
            takeUniqFromSupply,

            mkSplitUniqSupply,
            splitUniqSupply, listSplitUniqSupply,
            splitUniqSupply3, splitUniqSupply4,

            -- * Unique supply monad and its abstraction
            UniqSM, MonadUnique(..), liftUs,

            -- ** Operations on the monad
            initUs, initUs_,
            lazyThenUs, lazyMapUs,
            getUniqueSupplyM3,

            -- * Set supply strategy
            initUniqSupply
      ) where

    import Unique

    import GHC.IO

    import MonadUtils
    import Control.Monad
    import Data.Bits
    import Data.Char

    #include "Unique.h"

    {-
    ************************************************************************
    *                                                                      *
    \subsection{Splittable Unique supply: @UniqSupply@}
    *                                                                      *
    ************************************************************************
    -}

    -- | Unique Supply
    --
    -- A value of type 'UniqSupply' is unique, and it can
    -- supply /one/ distinct 'Unique'.  Also, from the supply, one can
    -- also manufacture an arbitrary number of further 'UniqueSupply' values,
    -- which will be distinct from the first and from all others.
    data UniqSupply
      = MkSplitUniqSupply {-# UNPACK #-} !Int -- make the Unique with this
                       UniqSupply UniqSupply
                                    -- when split => these two supplies

    mkSplitUniqSupply :: Char -> IO UniqSupply
    -- ^ Create a unique supply out of thin air. The character given must
    -- be distinct from those of all calls to this function in the compiler
    -- for the values generated to be truly unique.

    splitUniqSupply :: UniqSupply -> (UniqSupply, UniqSupply)
    -- ^ Build two 'UniqSupply' from a single one, each of which
    -- can supply its own 'Unique'.
    listSplitUniqSupply :: UniqSupply -> [UniqSupply]
    -- ^ Create an infinite list of 'UniqSupply' from a single one
    uniqFromSupply  :: UniqSupply -> Unique
    -- ^ Obtain the 'Unique' from this particular 'UniqSupply'
    uniqsFromSupply :: UniqSupply -> [Unique] -- Infinite
    -- ^ Obtain an infinite list of 'Unique' that can be generated by constant splitting of the supply
    takeUniqFromSupply :: UniqSupply -> (Unique, UniqSupply)
    -- ^ Obtain the 'Unique' from this particular 'UniqSupply', and a new supply

    mkSplitUniqSupply c
      = case ord c `shiftL` uNIQUE_BITS of
         mask -> let
            -- here comes THE MAGIC:

            -- This is one of the most hammered bits in the whole compiler
            mk_supply
              -- NB: Use unsafeInterleaveIO for thread-safety.
              = unsafeInterleaveIO (
                    genSym      >>= \ u ->
                    mk_supply   >>= \ s1 ->
                    mk_supply   >>= \ s2 ->
                    return (MkSplitUniqSupply (mask .|. u) s1 s2)
                )
           in
           mk_supply

    foreign import ccall unsafe "genSym" genSym :: IO Int
    foreign import ccall unsafe "initGenSym" initUniqSupply :: Int -> Int -> IO ()

    splitUniqSupply (MkSplitUniqSupply _ s1 s2) = (s1, s2)
    listSplitUniqSupply  (MkSplitUniqSupply _ s1 s2) = s1 : listSplitUniqSupply s2

    uniqFromSupply  (MkSplitUniqSupply n _ _)  = mkUniqueGrimily n
    uniqsFromSupply (MkSplitUniqSupply n _ s2) = mkUniqueGrimily n : uniqsFromSupply s2
    takeUniqFromSupply (MkSplitUniqSupply n s1 _) = (mkUniqueGrimily n, s1)

    -- | Build three 'UniqSupply' from a single one,
    -- each of which can supply its own unique
    splitUniqSupply3 :: UniqSupply -> (UniqSupply, UniqSupply, UniqSupply)
    splitUniqSupply3 us = (us1, us2, us3)
      where
        (us1, us') = splitUniqSupply us
        (us2, us3) = splitUniqSupply us'

    -- | Build four 'UniqSupply' from a single one,
    -- each of which can supply its own unique
    splitUniqSupply4 :: UniqSupply -> (UniqSupply, UniqSupply, UniqSupply, UniqSupply)
    splitUniqSupply4 us = (us1, us2, us3, us4)
      where
        (us1, us2, us') = splitUniqSupply3 us
        (us3, us4)      = splitUniqSupply us'

    {-
    ************************************************************************
    *                                                                      *
    \subsubsection[UniqSupply-monad]{@UniqSupply@ monad: @UniqSM@}
    *                                                                      *
    ************************************************************************
    -}

    -- | A monad which just gives the ability to obtain 'Unique's
    newtype UniqSM result = USM { unUSM :: UniqSupply -> (# result, UniqSupply #) }

    instance Monad UniqSM where
      (>>=) = thenUs
      (>>)  = (*>)

    instance Functor UniqSM where
        fmap f (USM x) = USM (\us -> case x us of
                                     (# r, us' #) -> (# f r, us' #))

    instance Applicative UniqSM where
        pure = returnUs
        (USM f) <*> (USM x) = USM $ \us -> case f us of
                                (# ff, us' #)  -> case x us' of
                                  (# xx, us'' #) -> (# ff xx, us'' #)
        (*>) = thenUs_

    -- | Run the 'UniqSM' action, returning the final 'UniqSupply'
    initUs :: UniqSupply -> UniqSM a -> (a, UniqSupply)
    initUs init_us m = case unUSM m init_us of { (# r, us #) -> (r,us) }

    -- | Run the 'UniqSM' action, discarding the final 'UniqSupply'
    initUs_ :: UniqSupply -> UniqSM a -> a
    initUs_ init_us m = case unUSM m init_us of { (# r, _ #) -> r }

    {-# INLINE thenUs #-}
    {-# INLINE lazyThenUs #-}
    {-# INLINE returnUs #-}
    {-# INLINE splitUniqSupply #-}

    -- @thenUs@ is where we split the @UniqSupply@.

    liftUSM :: UniqSM a -> UniqSupply -> (a, UniqSupply)
    liftUSM (USM m) us = case m us of (# a, us' #) -> (a, us')

    instance MonadFix UniqSM where
        mfix m = USM (\us -> let (r,us') = liftUSM (m r) us in (# r,us' #))

    thenUs :: UniqSM a -> (a -> UniqSM b) -> UniqSM b
    thenUs (USM expr) cont
      = USM (\us -> case (expr us) of
                       (# result, us' #) -> unUSM (cont result) us')

    lazyThenUs :: UniqSM a -> (a -> UniqSM b) -> UniqSM b
    lazyThenUs expr cont
      = USM (\us -> let (result, us') = liftUSM expr us in unUSM (cont result) us')

    thenUs_ :: UniqSM a -> UniqSM b -> UniqSM b
    thenUs_ (USM expr) (USM cont)
      = USM (\us -> case (expr us) of { (# _, us' #) -> cont us' })

    returnUs :: a -> UniqSM a
    returnUs result = USM (\us -> (# result, us #))

    getUs :: UniqSM UniqSupply
    getUs = USM (\us -> case splitUniqSupply us of (us1,us2) -> (# us1, us2 #))

    -- | A monad for generating unique identifiers
    class Monad m => MonadUnique m where
        -- | Get a new UniqueSupply
        getUniqueSupplyM :: m UniqSupply
        -- | Get a new unique identifier
        getUniqueM  :: m Unique
        -- | Get an infinite list of new unique identifiers
        getUniquesM :: m [Unique]

        -- This default definition of getUniqueM, while correct, is not as
        -- efficient as it could be since it needlessly generates and throws away
        -- an extra Unique. For your instances consider providing an explicit
        -- definition for 'getUniqueM' which uses 'takeUniqFromSupply' directly.
        getUniqueM  = liftM uniqFromSupply  getUniqueSupplyM
        getUniquesM = liftM uniqsFromSupply getUniqueSupplyM

    instance MonadUnique UniqSM where
        getUniqueSupplyM = getUs
        getUniqueM  = getUniqueUs
        getUniquesM = getUniquesUs

    getUniqueSupplyM3 :: MonadUnique m => m (UniqSupply, UniqSupply, UniqSupply)
    getUniqueSupplyM3 = liftM3 (,,) getUniqueSupplyM getUniqueSupplyM getUniqueSupplyM

    liftUs :: MonadUnique m => UniqSM a -> m a
    liftUs m = getUniqueSupplyM >>= return . flip initUs_ m

    getUniqueUs :: UniqSM Unique
    getUniqueUs = USM (\us -> case takeUniqFromSupply us of
                              (u,us') -> (# u, us' #))

    getUniquesUs :: UniqSM [Unique]
    getUniquesUs = USM (\us -> case splitUniqSupply us of
                               (us1,us2) -> (# uniqsFromSupply us1, us2 #))

    -- {-# SPECIALIZE mapM          :: (a -> UniqSM b) -> [a] -> UniqSM [b] #-}
    -- {-# SPECIALIZE mapAndUnzipM  :: (a -> UniqSM (b,c))   -> [a] -> UniqSM ([b],[c]) #-}
    -- {-# SPECIALIZE mapAndUnzip3M :: (a -> UniqSM (b,c,d)) -> [a] -> UniqSM ([b],[c],[d]) #-}

    lazyMapUs :: (a -> UniqSM b) -> [a] -> UniqSM [b]
    lazyMapUs _ []     = returnUs []
    lazyMapUs f (x:xs)
      = f x             `lazyThenUs` \ r  ->
        lazyMapUs f xs  `lazyThenUs` \ rs ->
        returnUs (r:rs)