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(Unique)
  23 import UniqFM
  24 import Maybes
  25 \end{code}
  26
  27 %************************************************************************
  28 %*                                                                      *
  29 \subsection{Name environment}
  30 %*                                                                      *
  31 %************************************************************************
  32
  33 \begin{code}
  34 type NameEnv a = UniqFM a       -- Domain is Name
  35
  36 emptyNameEnv       :: NameEnv a
  37 mkNameEnv          :: [(Name,a)] -> NameEnv a
  38 nameEnvElts        :: NameEnv a -> [a]
  39 nameEnvUniqueElts  :: NameEnv a -> [(Unique, a)]
  40 extendNameEnv_C    :: (a->a->a) -> NameEnv a -> Name -> a -> NameEnv a
  41 extendNameEnv_Acc  :: (a->b->b) -> (a->b) -> NameEnv b -> Name -> a -> NameEnv b
  42 extendNameEnv      :: NameEnv a -> Name -> a -> NameEnv a
  43 plusNameEnv        :: NameEnv a -> NameEnv a -> NameEnv a
  44 plusNameEnv_C      :: (a->a->a) -> NameEnv a -> NameEnv a -> NameEnv a
  45 extendNameEnvList  :: NameEnv a -> [(Name,a)] -> NameEnv a
  46 extendNameEnvList_C :: (a->a->a) -> NameEnv a -> [(Name,a)] -> NameEnv a
  47 delFromNameEnv     :: NameEnv a -> Name -> NameEnv a
  48 delListFromNameEnv :: NameEnv a -> [Name] -> NameEnv a
  49 elemNameEnv        :: Name -> NameEnv a -> Bool
  50 unitNameEnv        :: Name -> a -> NameEnv a
  51 lookupNameEnv      :: NameEnv a -> Name -> Maybe a
  52 lookupNameEnv_NF   :: NameEnv a -> Name -> a
  53 foldNameEnv        :: (a -> b -> b) -> b -> NameEnv a -> b
  54 filterNameEnv      :: (elt -> Bool) -> NameEnv elt -> NameEnv elt
  55 mapNameEnv         :: (elt1 -> elt2) -> NameEnv elt1 -> NameEnv elt2
  56
  57 emptyNameEnv        = emptyUFM
  58 foldNameEnv         = foldUFM
  59 mkNameEnv           = listToUFM
  60 nameEnvElts         = eltsUFM
  61 nameEnvUniqueElts   = ufmToList
  62 extendNameEnv_C     = addToUFM_C
  63 extendNameEnv_Acc   = addToUFM_Acc
  64 extendNameEnv       = addToUFM
  65 plusNameEnv         = plusUFM
  66 plusNameEnv_C       = plusUFM_C
  67 extendNameEnvList   = addListToUFM
  68 extendNameEnvList_C = addListToUFM_C
  69 delFromNameEnv      = delFromUFM
  70 delListFromNameEnv  = delListFromUFM
  71 elemNameEnv         = elemUFM
  72 unitNameEnv         = unitUFM
  73 filterNameEnv       = filterUFM
  74 mapNameEnv          = mapUFM
  75
  76 lookupNameEnv          = lookupUFM
  77 lookupNameEnv_NF env n = expectJust "lookupNameEnv_NF" (lookupUFM env n)
  78 \end{code}
  79