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 {-# OPTIONS -w #-}
   9 -- The above warning supression flag is a temporary kludge.
  10 -- While working on this module you are encouraged to remove it and fix
  11 -- any warnings in the module. See
  12 --     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
  13 -- for details
  14
  15 module NameEnv (
  16         NameEnv, mkNameEnv,
  17         emptyNameEnv, unitNameEnv, nameEnvElts, nameEnvUniqueElts,
  18         extendNameEnv_C, extendNameEnv_Acc, extendNameEnv,
  19         extendNameEnvList, extendNameEnvList_C,
  20         foldNameEnv, filterNameEnv,
  21         plusNameEnv, plusNameEnv_C,
  22         lookupNameEnv, lookupNameEnv_NF, delFromNameEnv, delListFromNameEnv,
  23         elemNameEnv, mapNameEnv
  24     ) where
  25
  26 #include "HsVersions.h"
  27
  28 import Name
  29 import Unique(Unique)
  30 import UniqFM
  31 import Maybes
  32 \end{code}
  33
  34 %************************************************************************
  35 %*                                                                      *
  36 \subsection{Name environment}
  37 %*                                                                      *
  38 %************************************************************************
  39
  40 \begin{code}
  41 type NameEnv a = UniqFM a       -- Domain is Name
  42
  43 emptyNameEnv       :: NameEnv a
  44 mkNameEnv          :: [(Name,a)] -> NameEnv a
  45 nameEnvElts        :: NameEnv a -> [a]
  46 nameEnvUniqueElts  :: NameEnv a -> [(Unique, a)]
  47 extendNameEnv_C    :: (a->a->a) -> NameEnv a -> Name -> a -> NameEnv a
  48 extendNameEnv_Acc  :: (a->b->b) -> (a->b) -> NameEnv b -> Name -> a -> NameEnv b
  49 extendNameEnv      :: NameEnv a -> Name -> a -> NameEnv a
  50 plusNameEnv        :: NameEnv a -> NameEnv a -> NameEnv a
  51 plusNameEnv_C      :: (a->a->a) -> NameEnv a -> NameEnv a -> NameEnv a
  52 extendNameEnvList  :: NameEnv a -> [(Name,a)] -> NameEnv a
  53 extendNameEnvList_C :: (a->a->a) -> NameEnv a -> [(Name,a)] -> NameEnv a
  54 delFromNameEnv     :: NameEnv a -> Name -> NameEnv a
  55 delListFromNameEnv :: NameEnv a -> [Name] -> NameEnv a
  56 elemNameEnv        :: Name -> NameEnv a -> Bool
  57 unitNameEnv        :: Name -> a -> NameEnv a
  58 lookupNameEnv      :: NameEnv a -> Name -> Maybe a
  59 lookupNameEnv_NF   :: NameEnv a -> Name -> a
  60 foldNameEnv        :: (a -> b -> b) -> b -> NameEnv a -> b
  61 filterNameEnv      :: (elt -> Bool) -> NameEnv elt -> NameEnv elt
  62 mapNameEnv         :: (elt1 -> elt2) -> NameEnv elt1 -> NameEnv elt2
  63
  64 emptyNameEnv        = emptyUFM
  65 foldNameEnv         = foldUFM
  66 mkNameEnv           = listToUFM
  67 nameEnvElts         = eltsUFM
  68 nameEnvUniqueElts   = ufmToList
  69 extendNameEnv_C     = addToUFM_C
  70 extendNameEnv_Acc   = addToUFM_Acc
  71 extendNameEnv       = addToUFM
  72 plusNameEnv         = plusUFM
  73 plusNameEnv_C       = plusUFM_C
  74 extendNameEnvList   = addListToUFM
  75 extendNameEnvList_C = addListToUFM_C
  76 delFromNameEnv      = delFromUFM
  77 delListFromNameEnv  = delListFromUFM
  78 elemNameEnv         = elemUFM
  79 unitNameEnv         = unitUFM
  80 filterNameEnv       = filterUFM
  81 mapNameEnv          = mapUFM
  82
  83 lookupNameEnv          = lookupUFM
  84 lookupNameEnv_NF env n = expectJust "lookupNameEnv_NF" (lookupUFM env n)
  85 \end{code}
  86