compiler/basicTypes/NameEnv.lhs

   1 %
   2 % (c) The University of Glasgow 2006
   3 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   4 %
   5 \section[NameEnv]{@NameEnv@: name environments}
   6
   7 \begin{code}
   8 module NameEnv (
   9         NameEnv, mkNameEnv,
  10         emptyNameEnv, unitNameEnv, nameEnvElts, nameEnvUniqueElts,
  11         extendNameEnv_C, extendNameEnv_Acc, extendNameEnv,
  12         extendNameEnvList, extendNameEnvList_C,
  13         foldNameEnv, filterNameEnv,
  14         plusNameEnv, plusNameEnv_C,
  15         lookupNameEnv, lookupNameEnv_NF, delFromNameEnv, delListFromNameEnv,
  16         elemNameEnv, mapNameEnv
  17     ) where
  18
  19 #include "HsVersions.h"
  20
  21 import Name
  22 import Unique
  23 import LazyUniqFM
  24 import Maybes
  25 import Outputable
  26 \end{code}
  27
  28 %************************************************************************
  29 %*                                                                      *
  30 \subsection{Name environment}
  31 %*                                                                      *
  32 %************************************************************************
  33
  34 \begin{code}
  35 newtype NameEnv a = A (UniqFM a)        -- Domain is Name
  36
  37 emptyNameEnv       :: NameEnv a
  38 mkNameEnv          :: [(Name,a)] -> NameEnv a
  39 nameEnvElts        :: NameEnv a -> [a]
  40 nameEnvUniqueElts  :: NameEnv a -> [(Unique, a)]
  41 extendNameEnv_C    :: (a->a->a) -> NameEnv a -> Name -> a -> NameEnv a
  42 extendNameEnv_Acc  :: (a->b->b) -> (a->b) -> NameEnv b -> Name -> a -> NameEnv b
  43 extendNameEnv      :: NameEnv a -> Name -> a -> NameEnv a
  44 plusNameEnv        :: NameEnv a -> NameEnv a -> NameEnv a
  45 plusNameEnv_C      :: (a->a->a) -> NameEnv a -> NameEnv a -> NameEnv a
  46 extendNameEnvList  :: NameEnv a -> [(Name,a)] -> NameEnv a
  47 extendNameEnvList_C :: (a->a->a) -> NameEnv a -> [(Name,a)] -> NameEnv a
  48 delFromNameEnv     :: NameEnv a -> Name -> NameEnv a
  49 delListFromNameEnv :: NameEnv a -> [Name] -> NameEnv a
  50 elemNameEnv        :: Name -> NameEnv a -> Bool
  51 unitNameEnv        :: Name -> a -> NameEnv a
  52 lookupNameEnv      :: NameEnv a -> Name -> Maybe a
  53 lookupNameEnv_NF   :: NameEnv a -> Name -> a
  54 foldNameEnv        :: (a -> b -> b) -> b -> NameEnv a -> b
  55 filterNameEnv      :: (elt -> Bool) -> NameEnv elt -> NameEnv elt
  56 mapNameEnv         :: (elt1 -> elt2) -> NameEnv elt1 -> NameEnv elt2
  57
  58 nameEnvElts (A x) = eltsUFM x
  59 emptyNameEnv     = A emptyUFM
  60 unitNameEnv x y = A $ unitUFM x y
  61 extendNameEnv (A x) y z = A $ addToUFM x y z
  62 extendNameEnvList (A x) l = A $ addListToUFM x l
  63 lookupNameEnv (A x) y = lookupUFM x y
  64 mkNameEnv     l    = A $ listToUFM l
  65 elemNameEnv x (A y)      = elemUFM x y
  66 foldNameEnv a b (A c)    = foldUFM a b c
  67 plusNameEnv (A x) (A y)  = A $ plusUFM x y
  68 plusNameEnv_C f (A x) (A y)      = A $ plusUFM_C f x y
  69 extendNameEnv_C f (A x) y z   = A $ addToUFM_C f x y z
  70 mapNameEnv f (A x)       = A $ mapUFM f x
  71 nameEnvUniqueElts (A x)  = ufmToList x
  72 extendNameEnv_Acc x y (A z) a b  = A $ addToUFM_Acc x y z a b
  73 extendNameEnvList_C x (A y) z = A $ addListToUFM_C x y z
  74 delFromNameEnv (A x) y    = A $ delFromUFM x y
  75 delListFromNameEnv (A x) y  = A $ delListFromUFM x y
  76 filterNameEnv x (A y)       = A $ filterUFM x y
  77
  78 lookupNameEnv_NF env n = expectJust "lookupNameEnv_NF" (lookupNameEnv env n)
  79
  80 instance Outputable a => Outputable (NameEnv a) where
  81     ppr (A x) = ppr x
  82 \end{code}
  83