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 import Outputable
  33 \end{code}
  34
  35 %************************************************************************
  36 %*                                                                      *
  37 \subsection{Name environment}
  38 %*                                                                      *
  39 %************************************************************************
  40
  41 \begin{code}
  42 newtype NameEnv a = A (UniqFM a)        -- Domain is Name
  43
  44 emptyNameEnv       :: NameEnv a
  45 mkNameEnv          :: [(Name,a)] -> NameEnv a
  46 nameEnvElts        :: NameEnv a -> [a]
  47 nameEnvUniqueElts  :: NameEnv a -> [(Unique, a)]
  48 extendNameEnv_C    :: (a->a->a) -> NameEnv a -> Name -> a -> NameEnv a
  49 extendNameEnv_Acc  :: (a->b->b) -> (a->b) -> NameEnv b -> Name -> a -> NameEnv b
  50 extendNameEnv      :: NameEnv a -> Name -> a -> NameEnv a
  51 plusNameEnv        :: NameEnv a -> NameEnv a -> NameEnv a
  52 plusNameEnv_C      :: (a->a->a) -> NameEnv a -> NameEnv a -> NameEnv a
  53 extendNameEnvList  :: NameEnv a -> [(Name,a)] -> NameEnv a
  54 extendNameEnvList_C :: (a->a->a) -> NameEnv a -> [(Name,a)] -> NameEnv a
  55 delFromNameEnv     :: NameEnv a -> Name -> NameEnv a
  56 delListFromNameEnv :: NameEnv a -> [Name] -> NameEnv a
  57 elemNameEnv        :: Name -> NameEnv a -> Bool
  58 unitNameEnv        :: Name -> a -> NameEnv a
  59 lookupNameEnv      :: NameEnv a -> Name -> Maybe a
  60 lookupNameEnv_NF   :: NameEnv a -> Name -> a
  61 foldNameEnv        :: (a -> b -> b) -> b -> NameEnv a -> b
  62 filterNameEnv      :: (elt -> Bool) -> NameEnv elt -> NameEnv elt
  63 mapNameEnv         :: (elt1 -> elt2) -> NameEnv elt1 -> NameEnv elt2
  64
  65 nameEnvElts (A x) = eltsUFM x
  66 emptyNameEnv     = A emptyUFM
  67 unitNameEnv x y = A $ unitUFM x y
  68 extendNameEnv (A x) y z = A $ addToUFM x y z
  69 extendNameEnvList (A x) l = A $ addListToUFM x l
  70 lookupNameEnv (A x) y = lookupUFM x y
  71 mkNameEnv     l    = A $ listToUFM l
  72 elemNameEnv x (A y)      = elemUFM x y
  73 foldNameEnv a b (A c)    = foldUFM a b c
  74 occEnvElts (A x)         = eltsUFM x
  75 plusNameEnv (A x) (A y)  = A $ plusUFM x y
  76 plusNameEnv_C f (A x) (A y)      = A $ plusUFM_C f x y
  77 extendNameEnv_C f (A x) y z   = A $ addToUFM_C f x y z
  78 mapNameEnv f (A x)       = A $ mapUFM f x
  79 mkNameEnv_C comb l = A $ addListToUFM_C comb emptyUFM l
  80 nameEnvUniqueElts (A x)  = ufmToList x
  81 extendNameEnv_Acc x y (A z) a b  = A $ addToUFM_Acc x y z a b
  82 extendNameEnvList_C x (A y) z = A $ addListToUFM_C x y z
  83 delFromNameEnv (A x) y    = A $ delFromUFM x y
  84 delListFromNameEnv (A x) y  = A $ delListFromUFM x y
  85 filterNameEnv x (A y)       = A $ filterUFM x y
  86
  87 lookupNameEnv_NF env n = expectJust "lookupNameEnv_NF" (lookupNameEnv env n)
  88
  89 instance Outputable a => Outputable (NameEnv a) where
  90     ppr (A x) = ppr x
  91 \end{code}
  92